blob: cddb6926dfeefa08c3a73fe966c735b16d99cdc1 [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-Pehrson33d8c2a2010-07-30 14:50:04 -05004 * libpng version 1.5.0beta38 - July 30, 2010
Glenn Randers-Pehrsone69b55d2010-01-01 10:29:06 -06005 * Copyright (c) 1998-2010 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-Pehrson33d8c2a2010-07-30 14:50:04 -050014 * libpng versions 0.97, January 1998, through 1.5.0beta38 - July 30, 2010: 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-Pehrson33d8c2a2010-07-30 14:50:04 -0500143 * 1.5.0beta01-38 15 10500 15.so.15.0[.0]
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600144 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600145 * Henceforth the source version will match the shared-library major
146 * and minor numbers; the shared-library major version number will be
147 * used for changes in backward compatibility, as it is intended. The
148 * PNG_LIBPNG_VER macro, which is not used within libpng but is available
149 * for applications, is an unsigned integer of the form xyyzz corresponding
150 * to the source version x.y.z (leading zeros in y and z). Beta versions
151 * were given the previous public release number plus a letter, until
152 * version 1.0.6j; from then on they were given the upcoming public
153 * release number plus "betaNN" or "rcN".
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600154 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600155 * Binary incompatibility exists only when applications make direct access
156 * to the info_ptr or png_ptr members through png.h, and the compiled
157 * application is loaded with a different version of the library.
Glenn Randers-Pehrson326320e2000-04-24 07:43:17 -0500158 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600159 * DLLNUM will change each time there are forward or backward changes
160 * in binary compatibility (e.g., when a new feature is added).
Glenn Randers-Pehrsonbe9de0f2001-01-22 08:52:16 -0600161 *
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600162 * See libpng.txt or libpng.3 for more information. The PNG specification
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500163 * is available as a W3C Recommendation and as an ISO Specification,
164 * <http://www.w3.org/TR/2003/REC-PNG-20031110/
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600165 */
166
167/*
Glenn Randers-Pehrson68ea2432000-04-01 21:10:05 -0600168 * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
169 *
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500170 * If you modify libpng you may insert additional notices immediately following
171 * this sentence.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600172 *
Glenn Randers-Pehrsonbfbf8652009-06-26 21:46:52 -0500173 * This code is released under the libpng license.
174 *
Glenn Randers-Pehrson33d8c2a2010-07-30 14:50:04 -0500175 * libpng versions 1.2.6, August 15, 2004, through 1.5.0beta38, July 30, 2010, are
Glenn Randers-Pehrsone69b55d2010-01-01 10:29:06 -0600176 * Copyright (c) 2004, 2006-2010 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500177 * distributed according to the same disclaimer and license as libpng-1.2.5
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500178 * with the following individual added to the list of Contributing Authors:
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500179 *
180 * Cosmin Truta
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500181 *
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500182 * libpng versions 1.0.7, July 1, 2000, through 1.2.5, October 3, 2002, are
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500183 * Copyright (c) 2000-2002 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrson32fc5ce2000-07-24 06:34:14 -0500184 * distributed according to the same disclaimer and license as libpng-1.0.6
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500185 * with the following individuals added to the list of Contributing Authors:
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500186 *
187 * Simon-Pierre Cadieux
188 * Eric S. Raymond
189 * Gilles Vollant
190 *
Glenn Randers-Pehrson3d5a5202000-07-01 15:37:28 -0500191 * and with the following additions to the disclaimer:
192 *
193 * There is no warranty against interference with your enjoyment of the
194 * library or against infringement. There is no warranty that our
195 * efforts or the library will fulfill any of your particular purposes
196 * or needs. This library is provided with all faults, and the entire
197 * risk of satisfactory quality, performance, accuracy, and effort is with
198 * the user.
199 *
200 * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500201 * Copyright (c) 1998, 1999, 2000 Glenn Randers-Pehrson, and are
202 * distributed according to the same disclaimer and license as libpng-0.96,
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500203 * with the following individuals added to the list of Contributing Authors:
204 *
205 * Tom Lane
206 * Glenn Randers-Pehrson
207 * Willem van Schaik
208 *
209 * libpng versions 0.89, June 1996, through 0.96, May 1997, are
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600210 * Copyright (c) 1996, 1997 Andreas Dilger
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500211 * Distributed according to the same disclaimer and license as libpng-0.88,
212 * with the following individuals added to the list of Contributing Authors:
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600213 *
214 * John Bowler
215 * Kevin Bracey
216 * Sam Bushell
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600217 * Magnus Holmgren
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600218 * Greg Roelofs
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500219 * Tom Tanner
220 *
221 * libpng versions 0.5, May 1995, through 0.88, January 1996, are
222 * Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.
223 *
224 * For the purposes of this copyright and license, "Contributing Authors"
225 * is defined as the following set of individuals:
226 *
227 * Andreas Dilger
228 * Dave Martindale
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600229 * Guy Eric Schalnat
230 * Paul Schmidt
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600231 * Tim Wegner
232 *
233 * The PNG Reference Library is supplied "AS IS". The Contributing Authors
234 * and Group 42, Inc. disclaim all warranties, expressed or implied,
235 * including, without limitation, the warranties of merchantability and of
236 * fitness for any purpose. The Contributing Authors and Group 42, Inc.
237 * assume no liability for direct, indirect, incidental, special, exemplary,
238 * or consequential damages, which may result from the use of the PNG
239 * Reference Library, even if advised of the possibility of such damage.
240 *
241 * Permission is hereby granted to use, copy, modify, and distribute this
242 * source code, or portions hereof, for any purpose, without fee, subject
243 * to the following restrictions:
244 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600245 * 1. The origin of this source code must not be misrepresented.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600246 *
Glenn Randers-Pehrson53c07f52010-06-18 18:55:55 -0500247 * 2. Altered versions must be plainly marked as such and must not
248 * be misrepresented as being the original source.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600249 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600250 * 3. This Copyright notice may not be removed or altered from
251 * any source or altered source distribution.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600252 *
253 * The Contributing Authors and Group 42, Inc. specifically permit, without
254 * fee, and encourage the use of this source code as a component to
255 * supporting the PNG file format in commercial products. If you use this
256 * source code in a product, acknowledgment is not required but would be
257 * appreciated.
258 */
259
260/*
261 * A "png_get_copyright" function is available, for convenient use in "about"
262 * boxes and the like:
263 *
Glenn Randers-Pehrsone0784c72008-08-09 07:11:44 -0500264 * printf("%s",png_get_copyright(NULL));
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600265 *
266 * Also, the PNG logo (in PNG format, of course) is supplied in the
Glenn Randers-Pehrsona4d54bd2000-07-14 08:15:12 -0500267 * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600268 */
269
270/*
271 * Libpng is OSI Certified Open Source Software. OSI Certified is a
272 * certification mark of the Open Source Initiative.
273 */
274
275/*
276 * The contributing authors would like to thank all those who helped
277 * with testing, bug fixes, and patience. This wouldn't have been
278 * possible without all of you.
279 *
280 * Thanks to Frank J. T. Wojcik for helping with the documentation.
281 */
282
283/*
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600284 * Y2K compliance in libpng:
285 * =========================
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600286 *
Glenn Randers-Pehrson2be8b642010-07-29 19:09:18 -0500287 * July 30, 2010
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600288 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600289 * Since the PNG Development group is an ad-hoc body, we can't make
290 * an official declaration.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600291 *
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500292 * This is your unofficial assurance that libpng from version 0.71 and
Glenn Randers-Pehrson33d8c2a2010-07-30 14:50:04 -0500293 * upward through 1.5.0beta38 are Y2K compliant. It is my belief that
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500294 * earlier versions were also Y2K compliant.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600295 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600296 * Libpng only has three year fields. One is a 2-byte unsigned integer
297 * that will hold years up to 65535. The other two hold the date in text
298 * format, and will hold years up to 9999.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600299 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600300 * The integer is
301 * "png_uint_16 year" in png_time_struct.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600302 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600303 * The strings are
304 * "png_charp time_buffer" in png_struct and
305 * "near_time_buffer", which is a local character string in png.c.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600306 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600307 * There are seven time-related functions:
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600308 * png.c: png_convert_to_rfc_1123() in png.c
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600309 * (formerly png_convert_to_rfc_1152() in error)
310 * png_convert_from_struct_tm() in pngwrite.c, called in pngwrite.c
311 * png_convert_from_time_t() in pngwrite.c
312 * png_get_tIME() in pngget.c
313 * png_handle_tIME() in pngrutil.c, called in pngread.c
314 * png_set_tIME() in pngset.c
315 * png_write_tIME() in pngwutil.c, called in pngwrite.c
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600316 *
317 * All handle dates properly in a Y2K environment. The
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600318 * png_convert_from_time_t() function calls gmtime() to convert from system
319 * clock time, which returns (year - 1900), which we properly convert to
320 * the full 4-digit year. There is a possibility that applications using
321 * libpng are not passing 4-digit years into the png_convert_to_rfc_1123()
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500322 * function, or that they are incorrectly passing only a 2-digit year
323 * instead of "year - 1900" into the png_convert_from_struct_tm() function,
324 * but this is not under our control. The libpng documentation has always
325 * stated that it works with 4-digit years, and the APIs have been
326 * documented as such.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600327 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600328 * The tIME chunk itself is also Y2K compliant. It uses a 2-byte unsigned
329 * integer to hold the year, and can hold years as large as 65535.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600330 *
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500331 * zlib, upon which libpng depends, is also Y2K compliant. It contains
332 * no date-related code.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600333 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600334 * Glenn Randers-Pehrson
335 * libpng maintainer
336 * PNG Development Group
Glenn Randers-Pehrsonbcfd15d1999-10-01 14:22:25 -0500337 */
338
Glenn Randers-Pehrson13944802000-06-24 07:42:42 -0500339#ifndef PNG_H
340#define PNG_H
Guy Schalnat0d580581995-07-20 02:43:20 -0500341
342/* This is not the place to learn how to use libpng. The file libpng.txt
Andreas Dilger47a0c421997-05-16 02:46:07 -0500343 * describes how to use libpng, and the file example.c summarizes it
344 * with some code on which to build. This file is useful for looking
345 * at the actual function definitions and structure components.
346 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500347
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500348/* Version information for png.h - this should match the version in png.c */
Glenn Randers-Pehrson33d8c2a2010-07-30 14:50:04 -0500349#define PNG_LIBPNG_VER_STRING "1.5.0beta38"
Glenn Randers-Pehrson5b5dcf82004-07-17 22:45:44 -0500350#define PNG_HEADER_VERSION_STRING \
Glenn Randers-Pehrson33d8c2a2010-07-30 14:50:04 -0500351 " libpng version 1.5.0beta38 - July 30, 2010\n"
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500352
Glenn Randers-Pehrsonf1eb9182010-02-08 15:36:41 -0600353#define PNG_LIBPNG_VER_SONUM 15
354#define PNG_LIBPNG_VER_DLLNUM 15
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500355
356/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */
357#define PNG_LIBPNG_VER_MAJOR 1
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -0600358#define PNG_LIBPNG_VER_MINOR 5
Glenn Randers-Pehrson17218292006-04-20 07:20:46 -0500359#define PNG_LIBPNG_VER_RELEASE 0
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500360/* This should match the numeric part of the final component of
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500361 * PNG_LIBPNG_VER_STRING, omitting any leading zero:
362 */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600363
Glenn Randers-Pehrson33d8c2a2010-07-30 14:50:04 -0500364#define PNG_LIBPNG_VER_BUILD 38
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600365
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600366/* Release Status */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600367#define PNG_LIBPNG_BUILD_ALPHA 1
368#define PNG_LIBPNG_BUILD_BETA 2
369#define PNG_LIBPNG_BUILD_RC 3
370#define PNG_LIBPNG_BUILD_STABLE 4
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600371#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500372
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600373/* Release-Specific Flags */
374#define PNG_LIBPNG_BUILD_PATCH 8 /* Can be OR'ed with
375 PNG_LIBPNG_BUILD_STABLE only */
376#define PNG_LIBPNG_BUILD_PRIVATE 16 /* Cannot be OR'ed with
377 PNG_LIBPNG_BUILD_SPECIAL */
378#define PNG_LIBPNG_BUILD_SPECIAL 32 /* Cannot be OR'ed with
379 PNG_LIBPNG_BUILD_PRIVATE */
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500380
Glenn Randers-Pehrson17218292006-04-20 07:20:46 -0500381#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_BETA
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600382
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500383/* Careful here. At one time, Guy wanted to use 082, but that would be octal.
384 * We must not include leading zeros.
385 * Versions 0.7 through 1.0.0 were in the range 0 to 100 here (only
386 * version 1.0.0 was mis-numbered 100 instead of 10000). From
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500387 * version 1.0.1 it's xxyyzz, where x=major, y=minor, z=release
388 */
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -0600389#define PNG_LIBPNG_VER 10500 /* 1.5.0 */
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500390
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500391/* Library configuration: these options cannot be changed after
392 * the library has been built.
393 */
394#ifndef PNGLCONF_H
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500395# include "pnglibconf.h"
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600396#endif
Guy Schalnat0d580581995-07-20 02:43:20 -0500397
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500398#ifndef PNG_VERSION_INFO_ONLY
399/* Standard header files (not needed for the version info) */
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500400# ifdef PNG_SETJMP_SUPPORTED
401# include <setjmp.h>
402# endif
403
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500404/* Need the time information for converting tIME chunks, it
405 * defines struct tm:
406 */
407#ifdef PNG_CONVERT_tIME_SUPPORTED
408 /* "time.h" functions are not supported on all operating systems */
409# include <time.h>
410#endif
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500411
412/* Machine specific configuration. */
413# include "pngconf.h"
414#endif
Guy Schalnat0d580581995-07-20 02:43:20 -0500415
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600416/*
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500417 * Added at libpng-1.2.8
418 *
419 * Ref MSDN: Private as priority over Special
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600420 * VS_FF_PRIVATEBUILD File *was not* built using standard release
421 * procedures. If this value is given, the StringFileInfo block must
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500422 * contain a PrivateBuild string.
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600423 *
424 * VS_FF_SPECIALBUILD File *was* built by the original company using
425 * standard release procedures but is a variation of the standard
426 * file of the same version number. If this value is given, the
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500427 * StringFileInfo block must contain a SpecialBuild string.
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600428 */
429
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500430#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600431# define PNG_LIBPNG_BUILD_TYPE \
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600432 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600433#else
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500434# ifdef PNG_LIBPNG_SPECIALBUILD
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600435# define PNG_LIBPNG_BUILD_TYPE \
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600436 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600437# else
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600438# define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600439# endif
440#endif
441
442#ifndef PNG_VERSION_INFO_ONLY
443
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500444/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
445#ifdef __cplusplus
446extern "C" {
447#endif /* __cplusplus */
448
Andreas Dilger47a0c421997-05-16 02:46:07 -0500449/* Version information for C files, stored in png.c. This had better match
450 * the version above.
451 */
Glenn Randers-Pehrson4c8f7262010-03-16 19:30:01 -0500452#define png_libpng_ver png_get_header_ver(NULL)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500453
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500454/* This file is arranged in several sections:
455 *
456 * 1. Any configuration options that can be specified by for the application
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500457 * code when it is built. (Build time configuration is in pnglibconf.h)
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500458 * 2. Type definitions (base types are defined in pngconf.h), structure
459 * definitions.
460 * 3. Exported library functions.
461 *
462 * The library source code has additional files (principally pngpriv.h) that
463 * allow configuration of the library.
464 */
465/* Section 1: run time configuration
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500466 * See pnglibconf.h for build time configuration
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500467 *
468 * Run time configuration allows the application to choose between
469 * implementations of certain arithmetic APIs. The default is set
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500470 * at build time and recorded in pnglibconf.h, but it is safe to
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500471 * override these (and only these) settings. Note that this won't
472 * change what the library does, only application code, and the
473 * settings can (and probably should) be made on a per-file basis
474 * by setting the #defines before including png.h
475 *
476 * Use macros to read integers from PNG data or use the exported
477 * functions?
478 * PNG_USE_READ_MACROS: use the macros (see below) Note that
479 * the macros evaluate their argument multiple times.
480 * PNG_NO_USE_READ_MACROS: call the relevant library function.
481 *
482 * Use the alternative algorithm for compositing alpha samples that
483 * does not use division?
484 * PNG_READ_COMPOSITE_NODIV_SUPPORTED: use the 'no division'
485 * algorithm.
486 * PNG_NO_READ_COMPOSITE_NODIV: use the 'division' algorithm.
487 *
488 * How to handle benign errors if PNG_ALLOW_BENIGN_ERRORS is
489 * false?
490 * PNG_ALLOW_BENIGN_ERRORS: map calls to the benign error
491 * APIs to png_warning.
492 * Otherwise the calls are mapped to png_error.
493 */
494
495/* Section 2: type definitions, including structures and compile time
496 * constants.
497 * See pngconf.h for base types that vary by machine/system
498 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500499/* Three color definitions. The order of the red, green, and blue, (and the
500 * exact size) is not important, although the size of the fields need to
501 * be png_byte or png_uint_16 (as defined below).
502 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500503typedef struct png_color_struct
504{
Guy Schalnat4ee97b01996-01-16 01:51:56 -0600505 png_byte red;
Guy Schalnat0d580581995-07-20 02:43:20 -0500506 png_byte green;
507 png_byte blue;
508} png_color;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500509typedef png_color FAR * png_colorp;
510typedef png_color FAR * FAR * png_colorpp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500511
512typedef struct png_color_16_struct
513{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500514 png_byte index; /* used for palette files */
515 png_uint_16 red; /* for use in red green blue files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500516 png_uint_16 green;
517 png_uint_16 blue;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500518 png_uint_16 gray; /* for use in grayscale files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500519} png_color_16;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500520typedef png_color_16 FAR * png_color_16p;
521typedef png_color_16 FAR * FAR * png_color_16pp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500522
523typedef struct png_color_8_struct
524{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500525 png_byte red; /* for use in red green blue files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500526 png_byte green;
527 png_byte blue;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500528 png_byte gray; /* for use in grayscale files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500529 png_byte alpha; /* for alpha channel files */
530} png_color_8;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500531typedef png_color_8 FAR * png_color_8p;
532typedef png_color_8 FAR * FAR * png_color_8pp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500533
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600534/*
535 * The following two structures are used for the in-core representation
536 * of sPLT chunks.
537 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600538typedef struct png_sPLT_entry_struct
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600539{
540 png_uint_16 red;
541 png_uint_16 green;
542 png_uint_16 blue;
543 png_uint_16 alpha;
544 png_uint_16 frequency;
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600545} png_sPLT_entry;
546typedef png_sPLT_entry FAR * png_sPLT_entryp;
547typedef png_sPLT_entry FAR * FAR * png_sPLT_entrypp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600548
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500549/* When the depth of the sPLT palette is 8 bits, the color and alpha samples
550 * occupy the LSB of their respective members, and the MSB of each member
551 * is zero-filled. The frequency member always occupies the full 16 bits.
552 */
553
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600554typedef struct png_sPLT_struct
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600555{
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500556 png_charp name; /* palette name */
557 png_byte depth; /* depth of palette samples */
558 png_sPLT_entryp entries; /* palette entries */
559 png_int_32 nentries; /* number of palette entries */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600560} png_sPLT_t;
561typedef png_sPLT_t FAR * png_sPLT_tp;
562typedef png_sPLT_t FAR * FAR * png_sPLT_tpp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600563
564#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600565/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,
566 * and whether that contents is compressed or not. The "key" field
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500567 * points to a regular zero-terminated C string. The "text", "lang", and
568 * "lang_key" fields can be regular C strings, empty strings, or NULL pointers.
569 * However, the * structure returned by png_get_text() will always contain
570 * regular zero-terminated C strings (possibly empty), never NULL pointers,
571 * so they can be safely used in printf() and other string-handling functions.
572 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500573typedef struct png_text_struct
574{
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500575 int compression; /* compression value:
576 -1: tEXt, none
577 0: zTXt, deflate
578 1: iTXt, none
579 2: iTXt, deflate */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500580 png_charp key; /* keyword, 1-79 character description of "text" */
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500581 png_charp text; /* comment, may be an empty string (ie "")
582 or a NULL pointer */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600583 png_size_t text_length; /* length of the text string */
584 png_size_t itxt_length; /* length of the itxt string */
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500585 png_charp lang; /* language code, 0-79 characters
586 or a NULL pointer */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600587 png_charp lang_key; /* keyword translated UTF-8 string, 0 or more
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500588 chars or a NULL pointer */
Guy Schalnat0d580581995-07-20 02:43:20 -0500589} png_text;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500590typedef png_text FAR * png_textp;
591typedef png_text FAR * FAR * png_textpp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600592#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -0500593
594/* Supported compression types for text in PNG files (tEXt, and zTXt).
595 * The values of the PNG_TEXT_COMPRESSION_ defines should NOT be changed. */
596#define PNG_TEXT_COMPRESSION_NONE_WR -3
597#define PNG_TEXT_COMPRESSION_zTXt_WR -2
598#define PNG_TEXT_COMPRESSION_NONE -1
599#define PNG_TEXT_COMPRESSION_zTXt 0
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600600#define PNG_ITXT_COMPRESSION_NONE 1
601#define PNG_ITXT_COMPRESSION_zTXt 2
602#define PNG_TEXT_COMPRESSION_LAST 3 /* Not a valid value */
Guy Schalnat0d580581995-07-20 02:43:20 -0500603
604/* png_time is a way to hold the time in an machine independent way.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600605 * Two conversions are provided, both from time_t and struct tm. There
606 * is no portable way to convert to either of these structures, as far
607 * 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 -0600608 * note - PNG has always been Year 2000 compliant!
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600609 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500610typedef struct png_time_struct
611{
612 png_uint_16 year; /* full year, as in, 1995 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500613 png_byte month; /* month of year, 1 - 12 */
614 png_byte day; /* day of month, 1 - 31 */
615 png_byte hour; /* hour of day, 0 - 23 */
616 png_byte minute; /* minute of hour, 0 - 59 */
617 png_byte second; /* second of minute, 0 - 60 (for leap seconds) */
Guy Schalnat0d580581995-07-20 02:43:20 -0500618} png_time;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500619typedef png_time FAR * png_timep;
620typedef png_time FAR * FAR * png_timepp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500621
Glenn Randers-Pehrson38674ec2009-06-16 13:33:01 -0500622#if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED) || \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -0600623 defined(PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600624/* png_unknown_chunk is a structure to hold queued chunks for which there is
625 * no specific support. The idea is that we can use this to queue
626 * up private chunks for output even though the library doesn't actually
627 * know about their semantics.
628 */
629typedef struct png_unknown_chunk_t
630{
631 png_byte name[5];
632 png_byte *data;
633 png_size_t size;
634
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600635 /* libpng-using applications should NOT directly modify this byte. */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600636 png_byte location; /* mode of operation at read time */
637}
638png_unknown_chunk;
639typedef png_unknown_chunk FAR * png_unknown_chunkp;
640typedef png_unknown_chunk FAR * FAR * png_unknown_chunkpp;
641#endif
642
Glenn Randers-Pehrsonf0cdbe72010-02-08 23:18:15 -0600643typedef struct png_info_def png_info;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500644typedef png_info FAR * png_infop;
645typedef png_info FAR * FAR * png_infopp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500646
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500647/* Maximum positive integer used in PNG is (2^31)-1 */
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500648#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
Glenn Randers-Pehrson78067772004-11-02 21:49:39 -0600649#define PNG_UINT_32_MAX ((png_uint_32)(-1))
650#define PNG_SIZE_MAX ((png_size_t)(-1))
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500651
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500652/* These are constants for fixed point values encoded in the
653 * PNG specification manner (x100000)
654 */
655#define PNG_FP_1 100000
656#define PNG_FP_HALF 50000
657
Andreas Dilger47a0c421997-05-16 02:46:07 -0500658/* These describe the color_type field in png_info. */
Guy Schalnat0d580581995-07-20 02:43:20 -0500659/* color type masks */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500660#define PNG_COLOR_MASK_PALETTE 1
661#define PNG_COLOR_MASK_COLOR 2
662#define PNG_COLOR_MASK_ALPHA 4
Guy Schalnat0d580581995-07-20 02:43:20 -0500663
664/* color types. Note that not all combinations are legal */
Guy Schalnate5a37791996-06-05 15:50:50 -0500665#define PNG_COLOR_TYPE_GRAY 0
Andreas Dilger47a0c421997-05-16 02:46:07 -0500666#define PNG_COLOR_TYPE_PALETTE (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE)
667#define PNG_COLOR_TYPE_RGB (PNG_COLOR_MASK_COLOR)
668#define PNG_COLOR_TYPE_RGB_ALPHA (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA)
Guy Schalnat0d580581995-07-20 02:43:20 -0500669#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600670/* aliases */
671#define PNG_COLOR_TYPE_RGBA PNG_COLOR_TYPE_RGB_ALPHA
672#define PNG_COLOR_TYPE_GA PNG_COLOR_TYPE_GRAY_ALPHA
Guy Schalnat0d580581995-07-20 02:43:20 -0500673
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500674/* This is for compression type. PNG 1.0-1.2 only define the single type. */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500675#define PNG_COMPRESSION_TYPE_BASE 0 /* Deflate method 8, 32K window */
676#define PNG_COMPRESSION_TYPE_DEFAULT PNG_COMPRESSION_TYPE_BASE
677
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500678/* This is for filter type. PNG 1.0-1.2 only define the single type. */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500679#define PNG_FILTER_TYPE_BASE 0 /* Single row per-byte filtering */
Glenn Randers-Pehrson2ad31ae2000-12-15 08:54:42 -0600680#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500681#define PNG_FILTER_TYPE_DEFAULT PNG_FILTER_TYPE_BASE
682
683/* These are for the interlacing type. These values should NOT be changed. */
684#define PNG_INTERLACE_NONE 0 /* Non-interlaced image */
685#define PNG_INTERLACE_ADAM7 1 /* Adam7 interlacing */
686#define PNG_INTERLACE_LAST 2 /* Not a valid value */
687
688/* These are for the oFFs chunk. These values should NOT be changed. */
689#define PNG_OFFSET_PIXEL 0 /* Offset in pixels */
690#define PNG_OFFSET_MICROMETER 1 /* Offset in micrometers (1/10^6 meter) */
691#define PNG_OFFSET_LAST 2 /* Not a valid value */
692
693/* These are for the pCAL chunk. These values should NOT be changed. */
694#define PNG_EQUATION_LINEAR 0 /* Linear transformation */
695#define PNG_EQUATION_BASE_E 1 /* Exponential base e transform */
696#define PNG_EQUATION_ARBITRARY 2 /* Arbitrary base exponential transform */
697#define PNG_EQUATION_HYPERBOLIC 3 /* Hyperbolic sine transformation */
698#define PNG_EQUATION_LAST 4 /* Not a valid value */
699
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600700/* These are for the sCAL chunk. These values should NOT be changed. */
701#define PNG_SCALE_UNKNOWN 0 /* unknown unit (image scale) */
702#define PNG_SCALE_METER 1 /* meters per pixel */
703#define PNG_SCALE_RADIAN 2 /* radians per pixel */
704#define PNG_SCALE_LAST 3 /* Not a valid value */
705
Andreas Dilger47a0c421997-05-16 02:46:07 -0500706/* These are for the pHYs chunk. These values should NOT be changed. */
707#define PNG_RESOLUTION_UNKNOWN 0 /* pixels/unknown unit (aspect ratio) */
708#define PNG_RESOLUTION_METER 1 /* pixels/meter */
709#define PNG_RESOLUTION_LAST 2 /* Not a valid value */
710
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600711/* These are for the sRGB chunk. These values should NOT be changed. */
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600712#define PNG_sRGB_INTENT_PERCEPTUAL 0
713#define PNG_sRGB_INTENT_RELATIVE 1
714#define PNG_sRGB_INTENT_SATURATION 2
715#define PNG_sRGB_INTENT_ABSOLUTE 3
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600716#define PNG_sRGB_INTENT_LAST 4 /* Not a valid value */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600717
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600718/* This is for text chunks */
719#define PNG_KEYWORD_MAX_LENGTH 79
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600720
Glenn Randers-Pehrson76e5fd62000-12-28 07:50:05 -0600721/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
Glenn Randers-Pehrsond1e8c862002-06-20 06:54:34 -0500722#define PNG_MAX_PALETTE_LENGTH 256
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600723
Andreas Dilger47a0c421997-05-16 02:46:07 -0500724/* These determine if an ancillary chunk's data has been successfully read
725 * from the PNG header, or if the application has filled in the corresponding
726 * data in the info_struct to be written into the output file. The values
727 * of the PNG_INFO_<chunk> defines should NOT be changed.
728 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500729#define PNG_INFO_gAMA 0x0001
730#define PNG_INFO_sBIT 0x0002
731#define PNG_INFO_cHRM 0x0004
732#define PNG_INFO_PLTE 0x0008
733#define PNG_INFO_tRNS 0x0010
734#define PNG_INFO_bKGD 0x0020
735#define PNG_INFO_hIST 0x0040
736#define PNG_INFO_pHYs 0x0080
737#define PNG_INFO_oFFs 0x0100
738#define PNG_INFO_tIME 0x0200
Andreas Dilger47a0c421997-05-16 02:46:07 -0500739#define PNG_INFO_pCAL 0x0400
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600740#define PNG_INFO_sRGB 0x0800 /* GR-P, 0.96a */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600741#define PNG_INFO_iCCP 0x1000 /* ESR, 1.0.6 */
742#define PNG_INFO_sPLT 0x2000 /* ESR, 1.0.6 */
743#define PNG_INFO_sCAL 0x4000 /* ESR, 1.0.6 */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600744#define PNG_INFO_IDAT 0x8000L /* ESR, 1.0.6 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500745
Andreas Dilger47a0c421997-05-16 02:46:07 -0500746/* This is used for the transformation routines, as some of them
747 * change these values for the row. It also should enable using
748 * the routines for other purposes.
749 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500750typedef struct png_row_info_struct
751{
Guy Schalnat4ee97b01996-01-16 01:51:56 -0600752 png_uint_32 width; /* width of row */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500753 png_size_t rowbytes; /* number of bytes in row */
Guy Schalnat4ee97b01996-01-16 01:51:56 -0600754 png_byte color_type; /* color type of row */
755 png_byte bit_depth; /* bit depth of row */
756 png_byte channels; /* number of channels (1, 2, 3, or 4) */
757 png_byte pixel_depth; /* bits per pixel (depth * channels) */
Guy Schalnat0d580581995-07-20 02:43:20 -0500758} png_row_info;
759
Andreas Dilger47a0c421997-05-16 02:46:07 -0500760typedef png_row_info FAR * png_row_infop;
761typedef png_row_info FAR * FAR * png_row_infopp;
Guy Schalnat0f716451995-11-28 11:22:13 -0600762
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500763/* These are the function types for the I/O functions and for the functions
764 * that allow the user to override the default I/O functions with his or her
765 * own. The png_error_ptr type should match that of user-supplied warning
766 * and error functions, while the png_rw_ptr type should match that of the
767 * user read/write data functions.
Guy Schalnat0f716451995-11-28 11:22:13 -0600768 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600769typedef struct png_struct_def png_struct;
770typedef png_struct FAR * png_structp;
Guy Schalnat0f716451995-11-28 11:22:13 -0600771
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600772typedef PNG_CALLBACK(void, *png_error_ptr, (png_structp, png_const_charp),);
773typedef PNG_CALLBACK(void, *png_rw_ptr, (png_structp, png_bytep, png_size_t),);
774typedef PNG_CALLBACK(void, *png_flush_ptr, (png_structp),);
775typedef PNG_CALLBACK(void, *png_read_status_ptr, (png_structp, png_uint_32,
776 int),);
777typedef PNG_CALLBACK(void, *png_write_status_ptr, (png_structp, png_uint_32,
778 int),);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600779
Guy Schalnat69b14481996-01-10 02:56:49 -0600780#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600781typedef PNG_CALLBACK(void, *png_progressive_info_ptr,
782 (png_structp, png_infop),);
783typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop),);
784typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,
785 png_uint_32, int),);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600786#endif
Guy Schalnat6d764711995-12-19 03:22:19 -0600787
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600788#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -0500789 defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600790typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
791 png_bytep),);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600792#endif
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600793
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500794#ifdef PNG_USER_CHUNKS_SUPPORTED
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600795typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
796 png_unknown_chunkp),);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600797#endif
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500798#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600799typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp),);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600800#endif
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600801#ifdef PNG_SETJMP_SUPPORTED
802/* This must match the function definition in <setjmp.h>, and the
803 * application must include this before png.h to obtain the definition
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600804 * of jmp_buf. The function is required to be PNG_NORETURN.
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500805 *
806 * If you get a type warning from the compiler when linking against this line
807 * then your compiler has 'longjmp' that does not match the requirements of the
808 * compiler that built libpng. You will have to write a wrapper function for
809 * your compiler's longjmp and call png_set_longjmp_fn directly (not via the
810 * png_jmpbuf macro.)
811 *
812 * If you get a warning here while building the library you will need to make
813 * changes to ensure that pnglibconf.h records the calling convention used by
814 * your compiler. This may be very difficult - try using a different compiler
815 * to build the library!
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600816 */
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600817typedef void (PNGCAPI *png_longjmp_ptr) PNGARG((jmp_buf, int)) PNG_NORETURN;
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600818#endif
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600819
820/* Transform masks for the high-level interface */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600821#define PNG_TRANSFORM_IDENTITY 0x0000 /* read and write */
822#define PNG_TRANSFORM_STRIP_16 0x0001 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600823#define PNG_TRANSFORM_STRIP_ALPHA 0x0002 /* read only */
824#define PNG_TRANSFORM_PACKING 0x0004 /* read and write */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600825#define PNG_TRANSFORM_PACKSWAP 0x0008 /* read and write */
826#define PNG_TRANSFORM_EXPAND 0x0010 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600827#define PNG_TRANSFORM_INVERT_MONO 0x0020 /* read and write */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600828#define PNG_TRANSFORM_SHIFT 0x0040 /* read and write */
829#define PNG_TRANSFORM_BGR 0x0080 /* read and write */
830#define PNG_TRANSFORM_SWAP_ALPHA 0x0100 /* read and write */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600831#define PNG_TRANSFORM_SWAP_ENDIAN 0x0200 /* read and write */
Glenn Randers-Pehrsondb66d442000-06-23 21:38:16 -0500832#define PNG_TRANSFORM_INVERT_ALPHA 0x0400 /* read and write */
Glenn Randers-Pehrson99708d52009-06-29 17:30:00 -0500833#define PNG_TRANSFORM_STRIP_FILLER 0x0800 /* write only */
Glenn Randers-Pehrson1eb14e92008-12-10 07:14:45 -0600834/* Added to libpng-1.2.34 */
Glenn Randers-Pehrson0ffb71a2009-02-28 06:08:20 -0600835#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
Glenn Randers-Pehrson99708d52009-06-29 17:30:00 -0500836#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
837/* Added to libpng-1.4.0 */
838#define PNG_TRANSFORM_GRAY_TO_RGB 0x2000 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600839
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600840/* Flags for MNG supported features */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600841#define PNG_FLAG_MNG_EMPTY_PLTE 0x01
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600842#define PNG_FLAG_MNG_FILTER_64 0x04
Glenn Randers-Pehrson408b4212000-12-18 09:33:57 -0600843#define PNG_ALL_MNG_FEATURES 0x05
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600844
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600845/* NOTE: prior to 1.5 these functions had no 'API' style declaration,
846 * this allowed the zlib default functions to be used on Windows
847 * platforms. In 1.5 the zlib default malloc (which just calls malloc and
848 * ignores the first argument) should be completely compatible with the
849 * following.
850 */
851typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,
852 png_alloc_size_t),);
853typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp),);
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500854
Glenn Randers-Pehrson5b5dcf82004-07-17 22:45:44 -0500855/* This triggers a compiler error in png.c, if png.c and png.h
856 * do not agree upon the version number.
Glenn Randers-Pehrsonbcfd15d1999-10-01 14:22:25 -0500857 */
Glenn Randers-Pehrson33d8c2a2010-07-30 14:50:04 -0500858typedef png_structp version_1_5_0beta38;
Glenn Randers-Pehrsonbcfd15d1999-10-01 14:22:25 -0500859
Andreas Dilger47a0c421997-05-16 02:46:07 -0500860typedef png_struct FAR * FAR * png_structpp;
Guy Schalnat6d764711995-12-19 03:22:19 -0600861
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500862/* Section 3: exported functions
863 * Here are the function definitions most commonly used. This is not
Andreas Dilger47a0c421997-05-16 02:46:07 -0500864 * the place to find out how to use libpng. See libpng.txt for the
865 * full explanation, see example.c for the summary. This just provides
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600866 * a simple one line description of the use of each function.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500867 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500868
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500869/* Returns the version number of the library */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -0500870PNG_EXPORT(png_uint_32,png_access_version_number,(void),,1);
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500871
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600872/* Tell lib we have already handled the first <num_bytes> magic bytes.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500873 * Handling more than 8 bytes from the beginning of the file is an error.
874 */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500875PNG_EXPORT(void,png_set_sig_bytes,(png_structp png_ptr, int num_bytes),,2);
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600876
Andreas Dilger47a0c421997-05-16 02:46:07 -0500877/* Check sig[start] through sig[start + num_to_check - 1] to see if it's a
878 * PNG file. Returns zero if the supplied bytes match the 8-byte PNG
879 * signature, and non-zero otherwise. Having num_to_check == 0 or
880 * start > 7 will always fail (ie return non-zero).
881 */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -0500882PNG_EXPORT(int,png_sig_cmp,(png_bytep sig, png_size_t start,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600883 png_size_t num_to_check),,3);
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600884
Glenn Randers-Pehrson3e42a992010-03-31 22:16:07 -0500885/* Simple signature checking function. This is the same as calling
886 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
887 */
888#define png_check_sig(sig,n) !png_sig_cmp((sig), 0, (n))
889
Andreas Dilger47a0c421997-05-16 02:46:07 -0500890/* Allocate and initialize png_ptr struct for reading, and any other memory. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500891PNG_EXPORT(png_structp,png_create_read_struct,(png_const_charp user_png_ver,
892 png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn),
893 PNG_ALLOCATED,4);
Guy Schalnat0d580581995-07-20 02:43:20 -0500894
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500895/* Allocate and initialize png_ptr struct for writing, and any other memory */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500896PNG_EXPORT(png_structp,png_create_write_struct,(png_const_charp user_png_ver,
897 png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn),
898 PNG_ALLOCATED,5);
Guy Schalnate5a37791996-06-05 15:50:50 -0500899
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500900PNG_EXPORT(png_size_t,png_get_compression_buffer_size,(png_structp png_ptr),,6);
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -0500901
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -0500902PNG_EXPORT(void,png_set_compression_buffer_size,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600903 png_size_t size),,7);
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -0500904
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600905/* Moved from pngconf.h in 1.4.0 and modified to ensure setjmp/longjmp
906 * match up.
907 */
908#ifdef PNG_SETJMP_SUPPORTED
909/* This function returns the jmp_buf built in to *png_ptr. It must be
910 * supplied with an appropriate 'longjmp' function to use on that jmp_buf
911 * unless the default error function is overridden in which case NULL is
912 * acceptable. The size of the jmp_buf is checked against the actual size
913 * allocated by the library - the call will return NULL on a mismatch
914 * indicating an ABI mismatch.
915 */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500916PNG_EXPORT(jmp_buf*,png_set_longjmp_fn,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600917 png_longjmp_ptr longjmp_fn, size_t jmp_buf_size),,8);
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600918# define png_jmpbuf(png_ptr) \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -0600919 (*png_set_longjmp_fn((png_ptr), longjmp, sizeof (jmp_buf)))
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600920#else
921# define png_jmpbuf(png_ptr) \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -0600922 (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600923#endif
Glenn Randers-Pehrsonf98726a2010-02-19 09:54:53 -0600924/* This function should be used by libpng applications in place of
925 * longjmp(png_ptr->jmpbuf, val). If longjmp_fn() has been set, it
926 * will use it; otherwise it will call PNG_ABORT(). This function was
927 * added in libpng-1.5.0.
928 */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500929PNG_EXPORT(void,png_longjmp,(png_structp png_ptr, int val),PNG_NORETURN,9);
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600930
Glenn Randers-Pehrson2b8bef12010-04-29 11:50:24 -0500931#ifdef PNG_READ_SUPPORTED
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -0500932/* Reset the compression stream */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -0500933PNG_EXPORT(int,png_reset_zstream,(png_structp png_ptr),,10);
Glenn Randers-Pehrson2b8bef12010-04-29 11:50:24 -0500934#endif
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -0500935
Glenn Randers-Pehrson8b6a8892001-05-18 04:54:50 -0500936/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500937#ifdef PNG_USER_MEM_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500938PNG_EXPORT(png_structp,png_create_read_struct_2,(png_const_charp user_png_ver,
939 png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn,
940 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
941 PNG_ALLOCATED,11);
942PNG_EXPORT(png_structp,png_create_write_struct_2,(png_const_charp user_png_ver,
943 png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn,
944 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
945 PNG_ALLOCATED,12);
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500946#endif
947
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -0500948/* Write the PNG file signature. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -0500949PNG_EXPORT(void,png_write_sig,(png_structp png_ptr),,13);
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -0500950
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600951/* Write a PNG chunk - size, type, (optional) data, CRC. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500952PNG_EXPORT(void,png_write_chunk,(png_structp png_ptr, png_bytep chunk_name,
953 png_bytep data, png_size_t length),,14);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600954
955/* Write the start of a PNG chunk - length and chunk name. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -0500956PNG_EXPORT(void,png_write_chunk_start,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600957 png_bytep chunk_name, png_uint_32 length),,15);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600958
959/* Write the data of a PNG chunk started with png_write_chunk_start(). */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500960PNG_EXPORT(void,png_write_chunk_data,(png_structp png_ptr, png_bytep data,
961 png_size_t length),,16);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600962
963/* Finish a chunk started with png_write_chunk_start() (includes CRC). */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -0500964PNG_EXPORT(void,png_write_chunk_end,(png_structp png_ptr),,17);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600965
Andreas Dilger47a0c421997-05-16 02:46:07 -0500966/* Allocate and initialize the info structure */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -0500967PNG_EXPORT(png_infop,png_create_info_struct,(png_structp png_ptr),
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600968 PNG_ALLOCATED,18);
Guy Schalnat0d580581995-07-20 02:43:20 -0500969
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -0500970PNG_EXPORT(void,png_info_init_3,(png_infopp info_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600971 png_size_t png_info_struct_size),,19);
Guy Schalnat0d580581995-07-20 02:43:20 -0500972
Andreas Dilger47a0c421997-05-16 02:46:07 -0500973/* Writes all the PNG information before the image. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -0500974PNG_EXPORT(void,png_write_info_before_PLTE,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600975 png_infop info_ptr),,20);
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500976PNG_EXPORT(void,png_write_info,(png_structp png_ptr, png_infop info_ptr),,21);
Guy Schalnat0d580581995-07-20 02:43:20 -0500977
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -0500978#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500979/* Read the information before the actual image data. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500980PNG_EXPORT(void,png_read_info,(png_structp png_ptr, png_infop info_ptr),,22);
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500981#endif
Guy Schalnat0d580581995-07-20 02:43:20 -0500982
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500983#ifdef PNG_TIME_RFC1123_SUPPORTED
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -0500984PNG_EXPORT(png_charp,png_convert_to_rfc1123,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600985 png_timep ptime),,23);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600986#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600987
Glenn Randers-Pehrson0cb46e22009-11-02 11:24:33 -0600988#ifdef PNG_CONVERT_tIME_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500989/* Convert from a struct tm to png_time */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -0500990PNG_EXPORT(void,png_convert_from_struct_tm,(png_timep ptime,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600991 struct tm FAR * ttime),,24);
Guy Schalnat0d580581995-07-20 02:43:20 -0500992
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500993/* Convert from time_t to png_time. Uses gmtime() */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500994PNG_EXPORT(void,png_convert_from_time_t,(png_timep ptime, time_t ttime),,25);
Glenn Randers-Pehrson0cb46e22009-11-02 11:24:33 -0600995#endif /* PNG_CONVERT_tIME_SUPPORTED */
Guy Schalnat0d580581995-07-20 02:43:20 -0500996
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500997#ifdef PNG_READ_EXPAND_SUPPORTED
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500998/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -0500999PNG_EXPORT(void,png_set_expand,(png_structp png_ptr),,26);
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001000PNG_EXPORT(void,png_set_expand_gray_1_2_4_to_8,(png_structp png_ptr),,27);
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001001PNG_EXPORT(void,png_set_palette_to_rgb,(png_structp png_ptr),,28);
1002PNG_EXPORT(void,png_set_tRNS_to_alpha,(png_structp png_ptr),,29);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001003#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001004
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001005#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
Guy Schalnat0d580581995-07-20 02:43:20 -05001006/* Use blue, green, red order for pixels. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001007PNG_EXPORT(void,png_set_bgr,(png_structp png_ptr),,30);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001008#endif
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001009
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001010#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001011/* Expand the grayscale to 24-bit RGB if necessary. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001012PNG_EXPORT(void,png_set_gray_to_rgb,(png_structp png_ptr),,31);
Guy Schalnat69b14481996-01-10 02:56:49 -06001013
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001014/* Reduce RGB to grayscale. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001015PNG_FP_EXPORT(void,png_set_rgb_to_gray,(png_structp png_ptr, int error_action,
1016 double red, double green ),,32);
1017PNG_FIXED_EXPORT(void,png_set_rgb_to_gray_fixed,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001018 int error_action, png_fixed_point red, png_fixed_point green),,33);
Glenn Randers-Pehrsona272d8f2010-06-25 21:45:31 -05001019
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001020PNG_EXPORT(png_byte,png_get_rgb_to_gray_status,(png_structp png_ptr),,34);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001021#endif
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001022
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001023PNG_EXPORT(void,png_build_grayscale_palette,(int bit_depth,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001024 png_colorp palette),,35);
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001025
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001026#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001027PNG_EXPORT(void,png_set_strip_alpha,(png_structp png_ptr),,36);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001028#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001029
1030#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
1031 defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001032PNG_EXPORT(void,png_set_swap_alpha,(png_structp png_ptr),,37);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001033#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001034
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -06001035#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
1036 defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001037PNG_EXPORT(void,png_set_invert_alpha,(png_structp png_ptr),,38);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001038#endif
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -06001039
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001040#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -05001041/* Add a filler byte to 8-bit Gray or 24-bit RGB images. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001042PNG_EXPORT(void,png_set_filler,(png_structp png_ptr, png_uint_32 filler,
1043 int flags),,39);
Andreas Dilger47a0c421997-05-16 02:46:07 -05001044/* The values of the PNG_FILLER_ defines should NOT be changed */
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06001045# define PNG_FILLER_BEFORE 0
1046# define PNG_FILLER_AFTER 1
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -05001047/* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001048PNG_EXPORT(void,png_set_add_alpha,(png_structp png_ptr, png_uint_32 filler,
1049 int flags),,40);
Andreas Dilger47a0c421997-05-16 02:46:07 -05001050#endif /* PNG_READ_FILLER_SUPPORTED || PNG_WRITE_FILLER_SUPPORTED */
Guy Schalnat0d580581995-07-20 02:43:20 -05001051
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001052#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001053/* Swap bytes in 16-bit depth files. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001054PNG_EXPORT(void,png_set_swap,(png_structp png_ptr),,41);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001055#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001056
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001057#if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED)
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001058/* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001059PNG_EXPORT(void,png_set_packing,(png_structp png_ptr),,42);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001060#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001061
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06001062#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
1063 defined(PNG_WRITE_PACKSWAP_SUPPORTED)
Andreas Dilger47a0c421997-05-16 02:46:07 -05001064/* Swap packing order of pixels in bytes. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001065PNG_EXPORT(void,png_set_packswap,(png_structp png_ptr),,43);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001066#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001067
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001068#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
Guy Schalnat0d580581995-07-20 02:43:20 -05001069/* Converts files to legal bit depths. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001070PNG_EXPORT(void,png_set_shift,(png_structp png_ptr, png_color_8p true_bits),,
1071 44);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001072#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001073
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001074#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
1075 defined(PNG_WRITE_INTERLACING_SUPPORTED)
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001076/* Have the code handle the interlacing. Returns the number of passes.
1077 * MUST be called before png_read_update_info or png_start_read_image, otherwise
1078 * it will not have the desired effect. Note that it is still necessary to call
1079 * png_read_row or png_read_rows png_get_image_height times for each pass.
1080 */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001081PNG_EXPORT(int,png_set_interlace_handling,(png_structp png_ptr),,45);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001082#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001083
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001084#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1085/* Alternatively call this to get the number of rows in the current pass. Call
1086 * this after png_read_update_info or png_start_read_image; if you call it
1087 * before it will just return the image height (which is also what it returns
1088 * for a non-interlaced image!).
1089 *
1090 * NOTE: you need to call these to find out how many times to call png_read_row
1091 * if you handle your own de-interlacing.
1092 */
1093PNG_EXPORT(int,png_get_num_passes,(png_structp png_ptr),,215);
1094PNG_EXPORT(png_uint_32,png_get_num_rows,(png_structp png_ptr),,216);
Glenn Randers-Pehrson2be8b642010-07-29 19:09:18 -05001095PNG_EXPORT(png_uint_32,png_get_num_cols,(png_structp png_ptr),,218);
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001096#endif
1097
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001098#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -05001099/* Invert monochrome files */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001100PNG_EXPORT(void,png_set_invert_mono,(png_structp png_ptr),,46);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001101#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001102
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001103#ifdef PNG_READ_BACKGROUND_SUPPORTED
Guy Schalnat0d580581995-07-20 02:43:20 -05001104/* Handle alpha and tRNS by replacing with a background color. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001105PNG_FP_EXPORT(void,png_set_background,(png_structp png_ptr,
1106 png_color_16p background_color, int background_gamma_code, int need_expand,
1107 double background_gamma),,47);
1108PNG_FIXED_EXPORT(void,png_set_background_fixed,(png_structp png_ptr,
1109 png_color_16p background_color, int background_gamma_code, int need_expand,
1110 png_fixed_point background_gamma),,217);
1111#endif
1112#ifdef PNG_READ_BACKGROUND_SUPPORTED
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06001113# define PNG_BACKGROUND_GAMMA_UNKNOWN 0
1114# define PNG_BACKGROUND_GAMMA_SCREEN 1
1115# define PNG_BACKGROUND_GAMMA_FILE 2
1116# define PNG_BACKGROUND_GAMMA_UNIQUE 3
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001117#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001118
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001119#ifdef PNG_READ_16_TO_8_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001120/* Strip the second byte of information from a 16-bit depth file. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001121PNG_EXPORT(void,png_set_strip_16,(png_structp png_ptr),,48);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001122#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001123
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -05001124#ifdef PNG_READ_QUANTIZE_SUPPORTED
1125/* Turn on quantizing, and reduce the palette to the number of colors
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06001126 * available.
1127 */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001128PNG_EXPORT(void,png_set_quantize,(png_structp png_ptr, png_colorp palette,
1129 int num_palette, int maximum_colors, png_uint_16p histogram,
1130 int full_quantize),,49);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001131#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001132
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001133#ifdef PNG_READ_GAMMA_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001134/* The threshold on gamma processing is configurable but hard-wired into the
1135 * library. The following is the floating point variant.
1136 */
1137#define PNG_GAMMA_THRESHOLD (PNG_GAMMA_THRESHOLD_FIXED*.00001)
1138
Glenn Randers-Pehrsonbcfd15d1999-10-01 14:22:25 -05001139/* Handle gamma correction. Screen_gamma=(display_exponent) */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001140PNG_FP_EXPORT(void,png_set_gamma,(png_structp png_ptr, double screen_gamma,
1141 double default_file_gamma),,50);
1142PNG_FIXED_EXPORT(void,png_set_gamma_fixed,(png_structp png_ptr,
1143 png_fixed_point screen_gamma, png_fixed_point default_file_gamma),,208);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001144#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001145
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001146
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001147#ifdef PNG_WRITE_FLUSH_SUPPORTED
Guy Schalnat0f716451995-11-28 11:22:13 -06001148/* Set how many lines between output flushes - 0 for no flushing */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001149PNG_EXPORT(void,png_set_flush,(png_structp png_ptr, int nrows),,51);
Guy Schalnat0f716451995-11-28 11:22:13 -06001150/* Flush the current PNG output buffer */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001151PNG_EXPORT(void,png_write_flush,(png_structp png_ptr),,52);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001152#endif
Guy Schalnat0f716451995-11-28 11:22:13 -06001153
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001154/* Optional update palette with requested transformations */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001155PNG_EXPORT(void,png_start_read_image,(png_structp png_ptr),,53);
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001156
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001157/* Optional call to update the users info structure */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001158PNG_EXPORT(void,png_read_update_info,(png_structp png_ptr, png_infop info_ptr),,
1159 54);
Guy Schalnat0d580581995-07-20 02:43:20 -05001160
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001161#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001162/* Read one or more rows of image data. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001163PNG_EXPORT(void,png_read_rows,(png_structp png_ptr, png_bytepp row,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001164 png_bytepp display_row, png_uint_32 num_rows),,55);
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001165#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001166
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001167#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001168/* Read a row of data. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001169PNG_EXPORT(void,png_read_row,(png_structp png_ptr, png_bytep row,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001170 png_bytep display_row),,56);
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001171#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001172
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001173#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001174/* Read the whole image into memory at once. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001175PNG_EXPORT(void,png_read_image,(png_structp png_ptr, png_bytepp image),,57);
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001176#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001177
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001178/* Write a row of image data */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001179PNG_EXPORT(void,png_write_row,(png_structp png_ptr, png_bytep row),,58);
Guy Schalnat0d580581995-07-20 02:43:20 -05001180
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001181/* Write a few rows of image data */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001182PNG_EXPORT(void,png_write_rows,(png_structp png_ptr, png_bytepp row,
1183 png_uint_32 num_rows),,59);
Guy Schalnat0d580581995-07-20 02:43:20 -05001184
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001185/* Write the image data */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001186PNG_EXPORT(void,png_write_image,(png_structp png_ptr, png_bytepp image),,60);
Guy Schalnat0d580581995-07-20 02:43:20 -05001187
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001188/* Write the end of the PNG file. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001189PNG_EXPORT(void,png_write_end,(png_structp png_ptr, png_infop info_ptr),,61);
Guy Schalnat0d580581995-07-20 02:43:20 -05001190
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001191#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001192/* Read the end of the PNG file. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001193PNG_EXPORT(void,png_read_end,(png_structp png_ptr, png_infop info_ptr),,62);
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001194#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001195
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001196/* Free any memory associated with the png_info_struct */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001197PNG_EXPORT(void,png_destroy_info_struct,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001198 png_infopp info_ptr_ptr),,63);
Guy Schalnate5a37791996-06-05 15:50:50 -05001199
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001200/* Free any memory associated with the png_struct and the png_info_structs */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001201PNG_EXPORT(void,png_destroy_read_struct,(png_structpp png_ptr_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001202 png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr),,64);
Guy Schalnate5a37791996-06-05 15:50:50 -05001203
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001204/* Free any memory associated with the png_struct and the png_info_structs */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001205PNG_EXPORT(void,png_destroy_write_struct,(png_structpp png_ptr_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001206 png_infopp info_ptr_ptr),,65);
Guy Schalnate5a37791996-06-05 15:50:50 -05001207
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001208/* Set the libpng method of handling chunk CRC errors */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001209PNG_EXPORT(void,png_set_crc_action,(png_structp png_ptr, int crit_action,
1210 int ancil_action),,66);
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001211
1212/* Values for png_set_crc_action() to say how to handle CRC errors in
Andreas Dilger47a0c421997-05-16 02:46:07 -05001213 * ancillary and critical chunks, and whether to use the data contained
1214 * therein. Note that it is impossible to "discard" data in a critical
1215 * chunk. For versions prior to 0.90, the action was always error/quit,
1216 * whereas in version 0.90 and later, the action for CRC errors in ancillary
1217 * chunks is warn/discard. These values should NOT be changed.
1218 *
1219 * value action:critical action:ancillary
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001220 */
1221#define PNG_CRC_DEFAULT 0 /* error/quit warn/discard data */
1222#define PNG_CRC_ERROR_QUIT 1 /* error/quit error/quit */
1223#define PNG_CRC_WARN_DISCARD 2 /* (INVALID) warn/discard data */
1224#define PNG_CRC_WARN_USE 3 /* warn/use data warn/use data */
1225#define PNG_CRC_QUIET_USE 4 /* quiet/use data quiet/use data */
1226#define PNG_CRC_NO_CHANGE 5 /* use current value use current value */
1227
Andreas Dilger47a0c421997-05-16 02:46:07 -05001228/* These functions give the user control over the scan-line filtering in
1229 * libpng and the compression methods used by zlib. These functions are
1230 * mainly useful for testing, as the defaults should work with most users.
1231 * Those users who are tight on memory or want faster performance at the
1232 * expense of compression can modify them. See the compression library
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001233 * header file (zlib.h) for an explination of the compression functions.
1234 */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001235
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001236/* Set the filtering method(s) used by libpng. Currently, the only valid
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001237 * value for "method" is 0.
1238 */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001239PNG_EXPORT(void,png_set_filter,(png_structp png_ptr, int method, int filters),,
1240 67);
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001241
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001242/* Flags for png_set_filter() to say which filters to use. The flags
Andreas Dilger47a0c421997-05-16 02:46:07 -05001243 * are chosen so that they don't conflict with real filter types
1244 * below, in case they are supplied instead of the #defined constants.
1245 * These values should NOT be changed.
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001246 */
1247#define PNG_NO_FILTERS 0x00
1248#define PNG_FILTER_NONE 0x08
1249#define PNG_FILTER_SUB 0x10
1250#define PNG_FILTER_UP 0x20
1251#define PNG_FILTER_AVG 0x40
1252#define PNG_FILTER_PAETH 0x80
1253#define PNG_ALL_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP | \
1254 PNG_FILTER_AVG | PNG_FILTER_PAETH)
1255
Andreas Dilger47a0c421997-05-16 02:46:07 -05001256/* Filter values (not flags) - used in pngwrite.c, pngwutil.c for now.
1257 * These defines should NOT be changed.
1258 */
1259#define PNG_FILTER_VALUE_NONE 0
1260#define PNG_FILTER_VALUE_SUB 1
1261#define PNG_FILTER_VALUE_UP 2
1262#define PNG_FILTER_VALUE_AVG 3
1263#define PNG_FILTER_VALUE_PAETH 4
1264#define PNG_FILTER_VALUE_LAST 5
1265
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001266#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */
Andreas Dilger47a0c421997-05-16 02:46:07 -05001267/* The "heuristic_method" is given by one of the PNG_FILTER_HEURISTIC_
1268 * defines, either the default (minimum-sum-of-absolute-differences), or
1269 * the experimental method (weighted-minimum-sum-of-absolute-differences).
1270 *
1271 * Weights are factors >= 1.0, indicating how important it is to keep the
1272 * filter type consistent between rows. Larger numbers mean the current
1273 * filter is that many times as likely to be the same as the "num_weights"
1274 * previous filters. This is cumulative for each previous row with a weight.
1275 * There needs to be "num_weights" values in "filter_weights", or it can be
1276 * NULL if the weights aren't being specified. Weights have no influence on
1277 * the selection of the first row filter. Well chosen weights can (in theory)
1278 * improve the compression for a given image.
1279 *
1280 * Costs are factors >= 1.0 indicating the relative decoding costs of a
1281 * filter type. Higher costs indicate more decoding expense, and are
1282 * therefore less likely to be selected over a filter with lower computational
1283 * costs. There needs to be a value in "filter_costs" for each valid filter
1284 * type (given by PNG_FILTER_VALUE_LAST), or it can be NULL if you aren't
1285 * setting the costs. Costs try to improve the speed of decompression without
1286 * unduly increasing the compressed image size.
1287 *
1288 * A negative weight or cost indicates the default value is to be used, and
1289 * values in the range [0.0, 1.0) indicate the value is to remain unchanged.
1290 * The default values for both weights and costs are currently 1.0, but may
1291 * change if good general weighting/cost heuristics can be found. If both
1292 * the weights and costs are set to 1.0, this degenerates the WEIGHTED method
1293 * to the UNWEIGHTED method, but with added encoding time/computation.
1294 */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001295PNG_FP_EXPORT(void,png_set_filter_heuristics,(png_structp png_ptr,
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06001296 int heuristic_method, int num_weights, png_doublep filter_weights,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001297 png_doublep filter_costs),,68);
Glenn Randers-Pehrson1e7d7d32010-07-30 07:36:50 -05001298#if 0 /* TO DO */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001299PNG_FIXED_EXPORT(void,png_set_filter_heuristics_fixed,(png_structp png_ptr,
1300 int heuristic_method, int num_weights, png_fixed_point_p filter_weights,
1301 png_fixed_point_p filter_costs),,209);
Glenn Randers-Pehrson1e7d7d32010-07-30 07:36:50 -05001302#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001303#endif /* PNG_WRITE_WEIGHTED_FILTER_SUPPORTED */
1304
1305/* Heuristic used for row filter selection. These defines should NOT be
1306 * changed.
1307 */
1308#define PNG_FILTER_HEURISTIC_DEFAULT 0 /* Currently "UNWEIGHTED" */
1309#define PNG_FILTER_HEURISTIC_UNWEIGHTED 1 /* Used by libpng < 0.95 */
1310#define PNG_FILTER_HEURISTIC_WEIGHTED 2 /* Experimental feature */
1311#define PNG_FILTER_HEURISTIC_LAST 3 /* Not a valid value */
1312
1313/* Set the library compression level. Currently, valid values range from
1314 * 0 - 9, corresponding directly to the zlib compression levels 0 - 9
1315 * (0 - no compression, 9 - "maximal" compression). Note that tests have
1316 * shown that zlib compression levels 3-6 usually perform as well as level 9
1317 * for PNG images, and do considerably fewer caclulations. In the future,
1318 * these values may not correspond directly to the zlib compression levels.
1319 */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001320PNG_EXPORT(void,png_set_compression_level,(png_structp png_ptr, int level),,69);
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001321
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001322PNG_EXPORT(void,png_set_compression_mem_level,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001323 int mem_level),,70);
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001324
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001325PNG_EXPORT(void,png_set_compression_strategy,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001326 int strategy),,71);
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001327
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001328PNG_EXPORT(void,png_set_compression_window_bits,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001329 int window_bits),,72);
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001330
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001331PNG_EXPORT(void,png_set_compression_method,(png_structp png_ptr, int method),,
1332 73);
Guy Schalnat0d580581995-07-20 02:43:20 -05001333
Guy Schalnate5a37791996-06-05 15:50:50 -05001334/* These next functions are called for input/output, memory, and error
Andreas Dilger47a0c421997-05-16 02:46:07 -05001335 * handling. They are in the file pngrio.c, pngwio.c, and pngerror.c,
1336 * and call standard C I/O routines such as fread(), fwrite(), and
1337 * fprintf(). These functions can be made to use other I/O routines
1338 * at run time for those applications that need to handle I/O in a
1339 * different manner by calling png_set_???_fn(). See libpng.txt for
1340 * more information.
1341 */
Guy Schalnat0d580581995-07-20 02:43:20 -05001342
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001343#ifdef PNG_STDIO_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001344/* Initialize the input/output for the PNG file to the default functions. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001345PNG_EXPORT(void,png_init_io,(png_structp png_ptr, png_FILE_p fp),,74);
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001346#endif
Guy Schalnat6d764711995-12-19 03:22:19 -06001347
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001348/* Replace the (error and abort), and warning functions with user
Andreas Dilger47a0c421997-05-16 02:46:07 -05001349 * supplied functions. If no messages are to be printed you must still
1350 * write and use replacement functions. The replacement error_fn should
1351 * still do a longjmp to the last setjmp location if you are using this
1352 * method of error handling. If error_fn or warning_fn is NULL, the
1353 * default function will be used.
1354 */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001355
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001356PNG_EXPORT(void,png_set_error_fn,(png_structp png_ptr, png_voidp error_ptr,
1357 png_error_ptr error_fn, png_error_ptr warning_fn),,75);
Guy Schalnat6d764711995-12-19 03:22:19 -06001358
Guy Schalnate5a37791996-06-05 15:50:50 -05001359/* Return the user pointer associated with the error functions */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001360PNG_EXPORT(png_voidp,png_get_error_ptr,(png_structp png_ptr),,76);
Guy Schalnat6d764711995-12-19 03:22:19 -06001361
1362/* Replace the default data output functions with a user supplied one(s).
Andreas Dilger47a0c421997-05-16 02:46:07 -05001363 * If buffered output is not used, then output_flush_fn can be set to NULL.
1364 * If PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile time
1365 * output_flush_fn will be ignored (and thus can be NULL).
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -05001366 * It is probably a mistake to use NULL for output_flush_fn if
1367 * write_data_fn is not also NULL unless you have built libpng with
1368 * PNG_WRITE_FLUSH_SUPPORTED undefined, because in this case libpng's
1369 * default flush function, which uses the standard *FILE structure, will
1370 * be used.
Andreas Dilger47a0c421997-05-16 02:46:07 -05001371 */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001372PNG_EXPORT(void,png_set_write_fn,(png_structp png_ptr, png_voidp io_ptr,
1373 png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn),,77);
Guy Schalnat6d764711995-12-19 03:22:19 -06001374
1375/* Replace the default data input function with a user supplied one. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001376PNG_EXPORT(void,png_set_read_fn,(png_structp png_ptr, png_voidp io_ptr,
1377 png_rw_ptr read_data_fn),,78);
Guy Schalnat6d764711995-12-19 03:22:19 -06001378
1379/* Return the user pointer associated with the I/O functions */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001380PNG_EXPORT(png_voidp,png_get_io_ptr,(png_structp png_ptr),,79);
Guy Schalnat6d764711995-12-19 03:22:19 -06001381
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001382PNG_EXPORT(void,png_set_read_status_fn,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001383 png_read_status_ptr read_row_fn),,80);
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001384
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001385PNG_EXPORT(void,png_set_write_status_fn,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001386 png_write_status_ptr write_row_fn),,81);
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001387
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001388#ifdef PNG_USER_MEM_SUPPORTED
1389/* Replace the default memory allocation functions with user supplied one(s). */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001390PNG_EXPORT(void,png_set_mem_fn,(png_structp png_ptr, png_voidp mem_ptr,
1391 png_malloc_ptr malloc_fn, png_free_ptr free_fn),,82);
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001392/* Return the user pointer associated with the memory functions */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001393PNG_EXPORT(png_voidp,png_get_mem_ptr,(png_structp png_ptr),,83);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001394#endif
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001395
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -05001396#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001397PNG_EXPORT(void,png_set_read_user_transform_fn,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001398 png_user_transform_ptr read_user_transform_fn),,84);
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001399#endif
1400
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -05001401#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001402PNG_EXPORT(void,png_set_write_user_transform_fn,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001403 png_user_transform_ptr write_user_transform_fn),,85);
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001404#endif
1405
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001406#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -05001407 defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001408PNG_EXPORT(void,png_set_user_transform_info,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001409 png_voidp user_transform_ptr, int user_transform_depth,
1410 int user_transform_channels),,86);
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001411/* Return the user pointer associated with the user transform functions */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001412PNG_EXPORT(png_voidp,png_get_user_transform_ptr,(png_structp png_ptr),,87);
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001413#endif
1414
Glenn Randers-Pehrson19095602001-03-14 07:08:39 -06001415#ifdef PNG_USER_CHUNKS_SUPPORTED
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001416PNG_EXPORT(void,png_set_read_user_chunk_fn,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001417 png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn),,88);
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001418PNG_EXPORT(png_voidp,png_get_user_chunk_ptr,(png_structp png_ptr),,89);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001419#endif
1420
Guy Schalnat4ee97b01996-01-16 01:51:56 -06001421#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001422/* Sets the function callbacks for the push reader, and a pointer to a
1423 * user-defined structure available to the callback functions.
1424 */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001425PNG_EXPORT(void,png_set_progressive_read_fn,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001426 png_voidp progressive_ptr, png_progressive_info_ptr info_fn,
1427 png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn),,90);
Guy Schalnat6d764711995-12-19 03:22:19 -06001428
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001429/* Returns the user pointer associated with the push read functions */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001430PNG_EXPORT(png_voidp,png_get_progressive_ptr,(png_structp png_ptr),,91);
Andreas Dilger47a0c421997-05-16 02:46:07 -05001431
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001432/* Function to be called when data becomes available */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001433PNG_EXPORT(void,png_process_data,(png_structp png_ptr, png_infop info_ptr,
1434 png_bytep buffer, png_size_t buffer_size),,92);
Andreas Dilger47a0c421997-05-16 02:46:07 -05001435
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001436/* Function that combines rows. Not very much different than the
Andreas Dilger47a0c421997-05-16 02:46:07 -05001437 * png_combine_row() call. Is this even used?????
1438 */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001439PNG_EXPORT(void,png_progressive_combine_row,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001440 png_bytep old_row, png_bytep new_row),,93);
Guy Schalnat4ee97b01996-01-16 01:51:56 -06001441#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */
Guy Schalnat6d764711995-12-19 03:22:19 -06001442
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001443PNG_EXPORT(png_voidp,png_malloc,(png_structp png_ptr, png_alloc_size_t size),
1444 PNG_ALLOCATED,94);
Glenn Randers-Pehrson0ffb71a2009-02-28 06:08:20 -06001445/* Added at libpng version 1.4.0 */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001446PNG_EXPORT(png_voidp,png_calloc,(png_structp png_ptr, png_alloc_size_t size),
1447 PNG_ALLOCATED,95);
Guy Schalnat0d580581995-07-20 02:43:20 -05001448
Glenn Randers-Pehrson07748d12002-05-25 11:12:10 -05001449/* Added at libpng version 1.2.4 */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001450PNG_EXPORT(png_voidp,png_malloc_warn,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001451 png_alloc_size_t size),PNG_ALLOCATED,96);
Glenn Randers-Pehrson07748d12002-05-25 11:12:10 -05001452
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05001453/* Frees a pointer allocated by png_malloc() */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001454PNG_EXPORT(void,png_free,(png_structp png_ptr, png_voidp ptr),,97);
Guy Schalnate5a37791996-06-05 15:50:50 -05001455
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001456/* Free data that was allocated internally */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001457PNG_EXPORT(void,png_free_data,(png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001458 png_uint_32 free_me, int num),,98);
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001459/* Reassign responsibility for freeing existing data, whether allocated
1460 * by libpng or by the application */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001461PNG_EXPORT(void,png_data_freer,(png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001462 int freer, png_uint_32 mask),,99);
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001463/* Assignments for png_data_freer */
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001464#define PNG_DESTROY_WILL_FREE_DATA 1
1465#define PNG_SET_WILL_FREE_DATA 1
1466#define PNG_USER_WILL_FREE_DATA 2
1467/* Flags for png_ptr->free_me and info_ptr->free_me */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001468#define PNG_FREE_HIST 0x0008
1469#define PNG_FREE_ICCP 0x0010
1470#define PNG_FREE_SPLT 0x0020
1471#define PNG_FREE_ROWS 0x0040
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001472#define PNG_FREE_PCAL 0x0080
1473#define PNG_FREE_SCAL 0x0100
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001474#define PNG_FREE_UNKN 0x0200
1475#define PNG_FREE_LIST 0x0400
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -05001476#define PNG_FREE_PLTE 0x1000
1477#define PNG_FREE_TRNS 0x2000
1478#define PNG_FREE_TEXT 0x4000
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001479#define PNG_FREE_ALL 0x7fff
Glenn Randers-Pehrsonec61c232000-05-16 06:17:36 -05001480#define PNG_FREE_MUL 0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001481
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001482#ifdef PNG_USER_MEM_SUPPORTED
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001483PNG_EXPORT(png_voidp,png_malloc_default,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001484 png_alloc_size_t size),PNG_ALLOCATED,100);
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001485PNG_EXPORT(void,png_free_default,(png_structp png_ptr, png_voidp ptr),,101);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001486#endif
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001487
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001488#ifdef PNG_ERROR_TEXT_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001489/* Fatal error in PNG image of libpng - can't continue */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001490PNG_EXPORT(void,png_error,(png_structp png_ptr, png_const_charp error_message),
1491 PNG_NORETURN,102);
Guy Schalnat0d580581995-07-20 02:43:20 -05001492
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001493/* The same, but the chunk name is prepended to the error string. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001494PNG_EXPORT(void,png_chunk_error,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001495 png_const_charp error_message),PNG_NORETURN,103);
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001496
Glenn Randers-Pehrsonfd107532009-11-10 05:59:22 -06001497#else
1498/* Fatal error in PNG image of libpng - can't continue */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001499PNG_EXPORT(void,png_err,(png_structp png_ptr),PNG_NORETURN,104);
Glenn Randers-Pehrsonfd107532009-11-10 05:59:22 -06001500#endif
1501
Guy Schalnat6d764711995-12-19 03:22:19 -06001502/* Non-fatal error in libpng. Can continue, but may have a problem. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001503PNG_EXPORT(void,png_warning,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001504 png_const_charp warning_message),,105);
Guy Schalnat0d580581995-07-20 02:43:20 -05001505
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001506/* Non-fatal error in libpng, chunk name is prepended to message. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001507PNG_EXPORT(void,png_chunk_warning,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001508 png_const_charp warning_message),,106);
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001509
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001510#ifdef PNG_BENIGN_ERRORS_SUPPORTED
1511/* Benign error in libpng. Can continue, but may have a problem.
1512 * User can choose whether to handle as a fatal error or as a warning. */
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001513# undef png_benign_error
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001514PNG_EXPORT(void,png_benign_error,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001515 png_const_charp warning_message),,107);
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001516
1517/* Same, chunk name is prepended to message. */
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001518# undef png_chunk_benign_error
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001519PNG_EXPORT(void,png_chunk_benign_error,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001520 png_const_charp warning_message),,108);
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001521
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001522PNG_EXPORT(void,png_set_benign_errors,(png_structp png_ptr, int allowed),,109);
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001523#else
1524# ifdef PNG_ALLOW_BENIGN_ERRORS
1525# define png_benign_error png_warning
1526# define png_chunk_benign_error png_chunk_warning
1527# else
1528# define png_benign_error png_error
1529# define png_chunk_benign_error png_chunk_error
1530# endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001531#endif
1532
Andreas Dilger47a0c421997-05-16 02:46:07 -05001533/* The png_set_<chunk> functions are for storing values in the png_info_struct.
1534 * Similarly, the png_get_<chunk> calls are used to read values from the
1535 * png_info_struct, either storing the parameters in the passed variables, or
1536 * setting pointers into the png_info_struct where the data is stored. The
1537 * png_get_<chunk> functions return a non-zero value if the data was available
1538 * in info_ptr, or return zero and do not change any of the parameters if the
1539 * data was not available.
1540 *
1541 * These functions should be used instead of directly accessing png_info
1542 * to avoid problems with future changes in the size and internal layout of
1543 * png_info_struct.
1544 */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001545/* Returns "flag" if chunk data is valid in info_ptr. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001546PNG_EXPORT(png_uint_32,png_get_valid,(png_structp png_ptr, png_infop info_ptr,
1547 png_uint_32 flag),,110);
Andreas Dilger47a0c421997-05-16 02:46:07 -05001548
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001549/* Returns number of bytes needed to hold a transformed row. */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001550PNG_EXPORT(png_size_t,png_get_rowbytes,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001551 png_infop info_ptr),,111);
Andreas Dilger47a0c421997-05-16 02:46:07 -05001552
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001553#ifdef PNG_INFO_IMAGE_SUPPORTED
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001554/* Returns row_pointers, which is an array of pointers to scanlines that was
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001555 * returned from png_read_png().
1556 */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001557PNG_EXPORT(png_bytepp,png_get_rows,(png_structp png_ptr, png_infop info_ptr),,
1558 112);
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001559/* Set row_pointers, which is an array of pointers to scanlines for use
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001560 * by png_write_png().
1561 */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001562PNG_EXPORT(void,png_set_rows,(png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001563 png_bytepp row_pointers),,113);
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001564#endif
1565
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001566/* Returns number of color channels in image. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001567PNG_EXPORT(png_byte,png_get_channels,(png_structp png_ptr, png_infop info_ptr),,
1568 114);
Andreas Dilger47a0c421997-05-16 02:46:07 -05001569
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001570#ifdef PNG_EASY_ACCESS_SUPPORTED
1571/* Returns image width in pixels. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001572PNG_EXPORT(png_uint_32,png_get_image_width,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001573 png_infop info_ptr),,115);
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001574
1575/* Returns image height in pixels. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001576PNG_EXPORT(png_uint_32,png_get_image_height,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001577 png_infop info_ptr),,116);
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001578
1579/* Returns image bit_depth. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001580PNG_EXPORT(png_byte,png_get_bit_depth,(png_structp png_ptr, png_infop info_ptr),
1581 ,117);
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001582
1583/* Returns image color_type. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001584PNG_EXPORT(png_byte,png_get_color_type,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001585 png_infop info_ptr),,118);
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001586
1587/* Returns image filter_type. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001588PNG_EXPORT(png_byte,png_get_filter_type,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001589 png_infop info_ptr),,119);
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001590
1591/* Returns image interlace_type. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001592PNG_EXPORT(png_byte,png_get_interlace_type,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001593 png_infop info_ptr),,120);
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001594
1595/* Returns image compression_type. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001596PNG_EXPORT(png_byte,png_get_compression_type,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001597 png_infop info_ptr),,121);
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001598
1599/* Returns image resolution in pixels per meter, from pHYs chunk data. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001600PNG_EXPORT(png_uint_32,png_get_pixels_per_meter,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001601 png_infop info_ptr),,122);
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001602PNG_EXPORT(png_uint_32,png_get_x_pixels_per_meter,(png_structp png_ptr,
1603 png_infop info_ptr),,123);
1604PNG_EXPORT(png_uint_32,png_get_y_pixels_per_meter,(png_structp png_ptr,
1605 png_infop info_ptr),,124);
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001606
1607/* Returns pixel aspect ratio, computed from pHYs chunk data. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001608PNG_FP_EXPORT(float,png_get_pixel_aspect_ratio,(png_structp png_ptr,
1609 png_infop info_ptr),,125);
Glenn Randers-Pehrson1e7d7d32010-07-30 07:36:50 -05001610#if 0 /* TO DO */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001611PNG_FIXED_EXPORT(png_fixed_point,png_get_pixel_aspect_ratio_fixed,
1612 (png_structp png_ptr, png_infop info_ptr),,210);
Glenn Randers-Pehrson1e7d7d32010-07-30 07:36:50 -05001613#endif
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001614
1615/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001616PNG_EXPORT(png_int_32,png_get_x_offset_pixels,(png_structp png_ptr,
1617 png_infop info_ptr),,126);
1618PNG_EXPORT(png_int_32,png_get_y_offset_pixels,(png_structp png_ptr,
1619 png_infop info_ptr),,127);
1620PNG_EXPORT(png_int_32,png_get_x_offset_microns,(png_structp png_ptr,
1621 png_infop info_ptr),,128);
1622PNG_EXPORT(png_int_32, png_get_y_offset_microns,(png_structp png_ptr,
1623 png_infop info_ptr),,129);
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001624
1625#endif /* PNG_EASY_ACCESS_SUPPORTED */
1626
Andreas Dilger47a0c421997-05-16 02:46:07 -05001627/* Returns pointer to signature string read from PNG header */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001628PNG_EXPORT(png_bytep,png_get_signature,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001629 png_infop info_ptr),,130);
Andreas Dilger47a0c421997-05-16 02:46:07 -05001630
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001631#ifdef PNG_bKGD_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001632PNG_EXPORT(png_uint_32,png_get_bKGD,(png_structp png_ptr, png_infop info_ptr,
1633 png_color_16p *background),,131);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001634#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001635
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001636#ifdef PNG_bKGD_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001637PNG_EXPORT(void,png_set_bKGD,(png_structp png_ptr, png_infop info_ptr,
1638 png_color_16p background),,132);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001639#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001640
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001641#ifdef PNG_cHRM_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001642PNG_FP_EXPORT(png_uint_32,png_get_cHRM,(png_structp png_ptr,
1643 png_infop info_ptr, double *white_x, double *white_y, double *red_x,
1644 double *red_y, double *green_x, double *green_y, double *blue_x,
1645 double *blue_y),,133);
1646#ifdef PNG_FIXED_POINT_SUPPORTED /* Otherwise not implemented */
1647PNG_FIXED_EXPORT(png_uint_32,png_get_cHRM_fixed,(png_structp png_ptr,
1648 png_infop info_ptr, png_fixed_point *int_white_x,
1649 png_fixed_point *int_white_y, png_fixed_point *int_red_x,
1650 png_fixed_point *int_red_y, png_fixed_point *int_green_x,
1651 png_fixed_point *int_green_y, png_fixed_point *int_blue_x,
1652 png_fixed_point *int_blue_y),,134);
1653#endif
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001654#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001655
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001656#ifdef PNG_cHRM_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001657PNG_FP_EXPORT(void,png_set_cHRM,(png_structp png_ptr, png_infop info_ptr,
1658 double white_x, double white_y, double red_x, double red_y, double green_x,
1659 double green_y, double blue_x, double blue_y),,135);
1660PNG_FIXED_EXPORT(void,png_set_cHRM_fixed,(png_structp png_ptr,
1661 png_infop info_ptr, png_fixed_point int_white_x,
1662 png_fixed_point int_white_y, png_fixed_point int_red_x,
1663 png_fixed_point int_red_y, png_fixed_point int_green_x,
1664 png_fixed_point int_green_y, png_fixed_point int_blue_x,
1665 png_fixed_point int_blue_y),,136);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001666#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001667
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001668#ifdef PNG_gAMA_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001669PNG_FP_EXPORT(png_uint_32,png_get_gAMA,(png_structp png_ptr, png_infop info_ptr,
1670 double *file_gamma),,137);
1671PNG_FIXED_EXPORT(png_uint_32,png_get_gAMA_fixed,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001672 png_infop info_ptr, png_fixed_point *int_file_gamma),,138);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001673#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001674
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001675#ifdef PNG_gAMA_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001676PNG_FP_EXPORT(void,png_set_gAMA,(png_structp png_ptr, png_infop info_ptr,
1677 double file_gamma),,139);
1678PNG_FIXED_EXPORT(void,png_set_gAMA_fixed,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001679 png_infop info_ptr, png_fixed_point int_file_gamma),,140);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001680#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001681
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001682#ifdef PNG_hIST_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001683PNG_EXPORT(png_uint_32,png_get_hIST,(png_structp png_ptr, png_infop info_ptr,
1684 png_uint_16p *hist),,141);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001685#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001686
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001687#ifdef PNG_hIST_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001688PNG_EXPORT(void,png_set_hIST,(png_structp png_ptr, png_infop info_ptr,
1689 png_uint_16p hist),,142);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001690#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001691
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001692PNG_EXPORT(png_uint_32,png_get_IHDR,(png_structp png_ptr, png_infop info_ptr,
1693 png_uint_32 *width, png_uint_32 *height, int *bit_depth, int *color_type,
1694 int *interlace_method, int *compression_method, int *filter_method),,143);
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001695
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001696PNG_EXPORT(void,png_set_IHDR,(png_structp png_ptr, png_infop info_ptr,
1697 png_uint_32 width, png_uint_32 height, int bit_depth, int color_type,
1698 int interlace_method, int compression_method, int filter_method),,144);
Andreas Dilger47a0c421997-05-16 02:46:07 -05001699
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001700#ifdef PNG_oFFs_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001701PNG_EXPORT(png_uint_32,png_get_oFFs,(png_structp png_ptr, png_infop info_ptr,
1702 png_int_32 *offset_x, png_int_32 *offset_y, int *unit_type),,145);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001703#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001704
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001705#ifdef PNG_oFFs_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001706PNG_EXPORT(void,png_set_oFFs,(png_structp png_ptr, png_infop info_ptr,
1707 png_int_32 offset_x, png_int_32 offset_y, int unit_type),,146);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001708#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001709
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001710#ifdef PNG_pCAL_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001711PNG_EXPORT(png_uint_32,png_get_pCAL,(png_structp png_ptr, png_infop info_ptr,
1712 png_charp *purpose, png_int_32 *X0, png_int_32 *X1, int *type, int *nparams,
1713 png_charp *units, png_charpp *params),,147);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001714#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001715
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001716#ifdef PNG_pCAL_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001717PNG_EXPORT(void,png_set_pCAL,(png_structp png_ptr, png_infop info_ptr,
1718 png_charp purpose, png_int_32 X0, png_int_32 X1, int type, int nparams,
1719 png_charp units, png_charpp params),,148);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001720#endif
1721
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001722#ifdef PNG_pHYs_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001723PNG_EXPORT(png_uint_32,png_get_pHYs,(png_structp png_ptr, png_infop info_ptr,
1724 png_uint_32 *res_x, png_uint_32 *res_y, int *unit_type),,149);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001725#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001726
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001727#ifdef PNG_pHYs_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001728PNG_EXPORT(void,png_set_pHYs,(png_structp png_ptr, png_infop info_ptr,
1729 png_uint_32 res_x, png_uint_32 res_y, int unit_type),,150);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001730#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001731
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001732PNG_EXPORT(png_uint_32,png_get_PLTE,(png_structp png_ptr, png_infop info_ptr,
1733 png_colorp *palette, int *num_palette),,151);
Andreas Dilger47a0c421997-05-16 02:46:07 -05001734
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001735PNG_EXPORT(void,png_set_PLTE,(png_structp png_ptr, png_infop info_ptr,
1736 png_colorp palette, int num_palette),,152);
Andreas Dilger47a0c421997-05-16 02:46:07 -05001737
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001738#ifdef PNG_sBIT_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001739PNG_EXPORT(png_uint_32,png_get_sBIT,(png_structp png_ptr, png_infop info_ptr,
1740 png_color_8p *sig_bit),,153);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001741#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001742
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001743#ifdef PNG_sBIT_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001744PNG_EXPORT(void,png_set_sBIT,(png_structp png_ptr, png_infop info_ptr,
1745 png_color_8p sig_bit),,154);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001746#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001747
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001748#ifdef PNG_sRGB_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001749PNG_EXPORT(png_uint_32,png_get_sRGB,(png_structp png_ptr, png_infop info_ptr,
1750 int *intent),,155);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001751#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001752
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001753#ifdef PNG_sRGB_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001754PNG_EXPORT(void,png_set_sRGB,(png_structp png_ptr, png_infop info_ptr,
1755 int intent),,156);
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001756PNG_EXPORT(void,png_set_sRGB_gAMA_and_cHRM,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001757 png_infop info_ptr, int intent),,157);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001758#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001759
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001760#ifdef PNG_iCCP_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001761PNG_EXPORT(png_uint_32,png_get_iCCP,(png_structp png_ptr, png_infop info_ptr,
1762 png_charpp name, int *compression_type, png_bytepp profile,
1763 png_uint_32 *proflen),,158);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001764#endif
1765
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001766#ifdef PNG_iCCP_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001767PNG_EXPORT(void,png_set_iCCP,(png_structp png_ptr, png_infop info_ptr,
1768 png_charp name, int compression_type, png_bytep profile,
1769 png_uint_32 proflen),,159);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001770#endif
1771
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001772#ifdef PNG_sPLT_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001773PNG_EXPORT(png_uint_32,png_get_sPLT,(png_structp png_ptr, png_infop info_ptr,
1774 png_sPLT_tpp entries),,160);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001775#endif
1776
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001777#ifdef PNG_sPLT_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001778PNG_EXPORT(void,png_set_sPLT,(png_structp png_ptr, png_infop info_ptr,
1779 png_sPLT_tp entries, int nentries),,161);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001780#endif
1781
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001782#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001783/* png_get_text also returns the number of text chunks in *num_text */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001784PNG_EXPORT(png_uint_32,png_get_text,(png_structp png_ptr, png_infop info_ptr,
1785 png_textp *text_ptr, int *num_text),,162);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001786#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001787
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001788/* Note while png_set_text() will accept a structure whose text,
1789 * language, and translated keywords are NULL pointers, the structure
1790 * returned by png_get_text will always contain regular
1791 * zero-terminated C strings. They might be empty strings but
1792 * they will never be NULL pointers.
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -05001793 */
1794
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001795#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001796PNG_EXPORT(void,png_set_text,(png_structp png_ptr, png_infop info_ptr,
1797 png_textp text_ptr, int num_text),,163);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001798#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001799
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001800#ifdef PNG_tIME_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001801PNG_EXPORT(png_uint_32,png_get_tIME,(png_structp png_ptr, png_infop info_ptr,
1802 png_timep *mod_time),,164);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001803#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001804
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001805#ifdef PNG_tIME_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001806PNG_EXPORT(void,png_set_tIME,(png_structp png_ptr, png_infop info_ptr,
1807 png_timep mod_time),,165);
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_tRNS_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001811PNG_EXPORT(png_uint_32,png_get_tRNS,(png_structp png_ptr, png_infop info_ptr,
1812 png_bytep *trans_alpha, int *num_trans, png_color_16p *trans_color),,166);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001813#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001814
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001815#ifdef PNG_tRNS_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001816PNG_EXPORT(void,png_set_tRNS,(png_structp png_ptr, png_infop info_ptr,
1817 png_bytep trans_alpha, int num_trans, png_color_16p trans_color),,167);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001818#endif
1819
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001820#ifdef PNG_sCAL_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001821PNG_FP_EXPORT(png_uint_32,png_get_sCAL,(png_structp png_ptr, png_infop info_ptr,
1822 int *unit, double *width, double *height),,168);
1823PNG_FIXED_EXPORT(png_uint_32,png_get_sCAL_fixed,(png_structp png_ptr,
1824 png_infop info_ptr, int *unit, png_fixed_point *width,
1825 png_fixed_point *height),,214);
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001826PNG_EXPORT(png_uint_32,png_get_sCAL_s,(png_structp png_ptr,
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001827 png_infop info_ptr, int *unit, png_charpp swidth, png_charpp sheight),,169);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001828
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001829PNG_FP_EXPORT(void,png_set_sCAL,(png_structp png_ptr, png_infop info_ptr,
1830 int unit, double width, double height),,170);
Glenn Randers-Pehrson1e7d7d32010-07-30 07:36:50 -05001831#if 0 /* TO DO */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001832PNG_FIXED_EXPORT(void,png_set_sCAL_fixed,(png_structp png_ptr,
1833 png_infop info_ptr, int unit, png_fixed_point width,
1834 png_fixed_point height), ,213);
Glenn Randers-Pehrson1e7d7d32010-07-30 07:36:50 -05001835#endif
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001836PNG_EXPORT(void,png_set_sCAL_s,(png_structp png_ptr, png_infop info_ptr,
1837 int unit, png_charp swidth, png_charp sheight),,171);
1838#endif /* PNG_sCAL_SUPPORTED */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001839
Glenn Randers-Pehrson7824a702009-06-13 10:05:05 -05001840#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
1841/* Provide a list of chunks and how they are to be handled, if the built-in
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001842 handling or default unknown chunk handling is not desired. Any chunks not
1843 listed will be handled in the default manner. The IHDR and IEND chunks
1844 must not be listed.
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -05001845 keep = 0: follow default behaviour
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001846 = 1: do not keep
1847 = 2: keep only if safe-to-copy
1848 = 3: keep even if unsafe-to-copy
1849*/
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001850PNG_EXPORT(void, png_set_keep_unknown_chunks,(png_structp png_ptr, int keep,
1851 png_bytep chunk_list, int num_chunks),,172);
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001852PNG_EXPORT(int,png_handle_as_unknown,(png_structp png_ptr,
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001853 png_const_bytep chunk_name),,173);
Glenn Randers-Pehrson7824a702009-06-13 10:05:05 -05001854#endif
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001855#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001856PNG_EXPORT(void, png_set_unknown_chunks,(png_structp png_ptr,
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001857 png_infop info_ptr, png_unknown_chunkp unknowns, int num_unknowns),,174);
1858PNG_EXPORT(void, png_set_unknown_chunk_location, (png_structp png_ptr,
1859 png_infop info_ptr, int chunk, int location),,175);
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001860PNG_EXPORT(png_uint_32,png_get_unknown_chunks,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001861 png_infop info_ptr, png_unknown_chunkpp entries),,176);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001862#endif
1863
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -05001864/* Png_free_data() will turn off the "valid" flag for anything it frees.
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001865 * If you need to turn it off for a chunk that your application has freed,
1866 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
1867 */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001868PNG_EXPORT(void, png_set_invalid,(png_structp png_ptr, png_infop info_ptr,
1869 int mask),,177);
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -05001870
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001871#ifdef PNG_INFO_IMAGE_SUPPORTED
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -05001872/* The "params" pointer is currently not used and is for future expansion. */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001873PNG_EXPORT(void, png_read_png,(png_structp png_ptr, png_infop info_ptr,
1874 int transforms, png_voidp params),,178);
1875PNG_EXPORT(void, png_write_png,(png_structp png_ptr, png_infop info_ptr,
1876 int transforms, png_voidp params),,179);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001877#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001878
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001879PNG_EXPORT(png_charp,png_get_copyright,(png_structp png_ptr),,180);
1880PNG_EXPORT(png_charp,png_get_header_ver,(png_structp png_ptr),,181);
1881PNG_EXPORT(png_charp,png_get_header_version,(png_structp png_ptr),,182);
1882PNG_EXPORT(png_charp,png_get_libpng_ver,(png_structp png_ptr),,183);
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -06001883
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -06001884#ifdef PNG_MNG_FEATURES_SUPPORTED
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001885PNG_EXPORT(png_uint_32,png_permit_mng_features,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001886 png_uint_32 mng_features_permitted),,184);
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -06001887#endif
1888
Glenn Randers-Pehrson8f3dd832004-08-10 09:43:42 -05001889/* For use in png_set_keep_unknown, added to version 1.2.6 */
1890#define PNG_HANDLE_CHUNK_AS_DEFAULT 0
1891#define PNG_HANDLE_CHUNK_NEVER 1
1892#define PNG_HANDLE_CHUNK_IF_SAFE 2
1893#define PNG_HANDLE_CHUNK_ALWAYS 3
1894
Glenn Randers-Pehrsone68f5a32001-05-14 09:20:53 -05001895/* Strip the prepended error numbers ("#nnn ") from error and warning
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001896 * messages before passing them to the error or warning handler.
1897 */
Glenn Randers-Pehrsone68f5a32001-05-14 09:20:53 -05001898#ifdef PNG_ERROR_NUMBERS_SUPPORTED
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001899PNG_EXPORT(void,png_set_strip_error_numbers,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001900 png_uint_32 strip_mode),,185);
Glenn Randers-Pehrsonbe9de0f2001-01-22 08:52:16 -06001901#endif
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05001902
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05001903/* Added in libpng-1.2.6 */
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05001904#ifdef PNG_SET_USER_LIMITS_SUPPORTED
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001905PNG_EXPORT(void,png_set_user_limits,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001906 png_uint_32 user_width_max, png_uint_32 user_height_max),,186);
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001907PNG_EXPORT(png_uint_32,png_get_user_width_max,(png_structp png_ptr),,187);
1908PNG_EXPORT(png_uint_32,png_get_user_height_max,(png_structp png_ptr),,188);
Glenn Randers-Pehrson800d1e92008-08-20 17:25:21 -05001909/* Added in libpng-1.4.0 */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001910PNG_EXPORT(void,png_set_chunk_cache_max,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001911 png_uint_32 user_chunk_cache_max),,189);
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001912PNG_EXPORT(png_uint_32,png_get_chunk_cache_max,(png_structp png_ptr),,190);
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06001913/* Added in libpng-1.4.1 */
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001914PNG_EXPORT(void,png_set_chunk_malloc_max,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001915 png_alloc_size_t user_chunk_cache_max),,191);
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001916PNG_EXPORT(png_alloc_size_t,png_get_chunk_malloc_max,(png_structp png_ptr),,
1917 192);
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05001918#endif
1919
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001920#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001921PNG_EXPORT(png_uint_32,png_get_pixels_per_inch,(png_structp png_ptr,
1922 png_infop info_ptr),,193);
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001923
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001924PNG_EXPORT(png_uint_32,png_get_x_pixels_per_inch,(png_structp png_ptr,
1925 png_infop info_ptr),,194);
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001926
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001927PNG_EXPORT(png_uint_32,png_get_y_pixels_per_inch,(png_structp png_ptr,
1928 png_infop info_ptr),,195);
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001929
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001930PNG_FP_EXPORT(float,png_get_x_offset_inches,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001931 png_infop info_ptr),,196);
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001932#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
1933PNG_FIXED_EXPORT(png_fixed_point,png_get_x_offset_inches_fixed,
1934 (png_structp png_ptr, png_infop info_ptr),,211);
1935#endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001936
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001937PNG_FP_EXPORT(float,png_get_y_offset_inches,(png_structp png_ptr,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001938 png_infop info_ptr),,197);
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001939#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
1940PNG_FIXED_EXPORT(png_fixed_point,png_get_y_offset_inches_fixed,
1941 (png_structp png_ptr, png_infop info_ptr),,212);
1942#endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001943
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06001944# ifdef PNG_pHYs_SUPPORTED
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001945PNG_EXPORT(png_uint_32,png_get_pHYs_dpi,(png_structp png_ptr,
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001946 png_infop info_ptr, png_uint_32 *res_x, png_uint_32 *res_y, int *unit_type),
1947 ,198);
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06001948# endif /* PNG_pHYs_SUPPORTED */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001949#endif /* PNG_INCH_CONVERSIONS_SUPPORTED */
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001950
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05001951/* Added in libpng-1.4.0 */
1952#ifdef PNG_IO_STATE_SUPPORTED
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001953PNG_EXPORT(png_uint_32,png_get_io_state,(png_structp png_ptr),,199);
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05001954
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05001955PNG_EXPORT(png_bytep,png_get_io_chunk_name,(png_structp png_ptr),,200);
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05001956
1957/* The flags returned by png_get_io_state() are the following: */
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06001958# define PNG_IO_NONE 0x0000 /* no I/O at this moment */
1959# define PNG_IO_READING 0x0001 /* currently reading */
1960# define PNG_IO_WRITING 0x0002 /* currently writing */
1961# define PNG_IO_SIGNATURE 0x0010 /* currently at the file signature */
1962# define PNG_IO_CHUNK_HDR 0x0020 /* currently at the chunk header */
1963# define PNG_IO_CHUNK_DATA 0x0040 /* currently at the chunk data */
1964# define PNG_IO_CHUNK_CRC 0x0080 /* currently at the chunk crc */
1965# define PNG_IO_MASK_OP 0x000f /* current operation: reading/writing */
1966# define PNG_IO_MASK_LOC 0x00f0 /* current location: sig/hdr/data/crc */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05001967#endif /* ?PNG_IO_STATE_SUPPORTED */
1968
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05001969#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -05001970/* With these routines we avoid an integer divide, which will be slower on
1971 * most machines. However, it does take more operations than the corresponding
1972 * divide method, so it may be slower on a few RISC systems. There are two
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05001973 * shifts (by 8 or 16 bits) and an addition, versus a single integer divide.
1974 *
1975 * Note that the rounding factors are NOT supposed to be the same! 128 and
1976 * 32768 are correct for the NODIV code; 127 and 32767 are correct for the
1977 * standard method.
1978 *
1979 * [Optimized code by Greg Roelofs and Mark Adler...blame us for bugs. :-) ]
1980 */
1981
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06001982 /* fg and bg should be in `gamma 1.0' space; alpha is the opacity */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001983
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06001984# define png_composite(composite, fg, alpha, bg) \
1985 { png_uint_16 temp = (png_uint_16)((png_uint_16)(fg) \
1986 * (png_uint_16)(alpha) \
1987 + (png_uint_16)(bg)*(png_uint_16)(255 \
1988 - (png_uint_16)(alpha)) + (png_uint_16)128); \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05001989 (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001990
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06001991# define png_composite_16(composite, fg, alpha, bg) \
1992 { png_uint_32 temp = (png_uint_32)((png_uint_32)(fg) \
1993 * (png_uint_32)(alpha) \
1994 + (png_uint_32)(bg)*(png_uint_32)(65535L \
1995 - (png_uint_32)(alpha)) + (png_uint_32)32768L); \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05001996 (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }
1997
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001998#else /* Standard method using integer division */
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05001999
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06002000# define png_composite(composite, fg, alpha, bg) \
2001 (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) + \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06002002 (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \
2003 (png_uint_16)127) / 255)
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002004
2005# define png_composite_16(composite, fg, alpha, bg) \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002006 (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06002007 (png_uint_32)(bg)*(png_uint_32)(65535L - (png_uint_32)(alpha)) + \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06002008 (png_uint_32)32767) / (png_uint_32)65535L)
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002009#endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */
2010
Glenn Randers-Pehrsoneb580912008-07-30 14:47:09 -05002011#ifdef PNG_USE_READ_MACROS
2012/* Inline macros to do direct reads of bytes from the input buffer.
2013 * The png_get_int_32() routine assumes we are using two's complement
2014 * format for negative values, which is almost certainly true.
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002015 */
Glenn Randers-Pehrsoneb580912008-07-30 14:47:09 -05002016# define png_get_uint_32(buf) \
2017 (((png_uint_32)(*(buf)) << 24) + \
2018 ((png_uint_32)(*((buf) + 1)) << 16) + \
2019 ((png_uint_32)(*((buf) + 2)) << 8) + \
2020 ((png_uint_32)(*((buf) + 3))))
2021# define png_get_uint_16(buf) \
2022 (((png_uint_32)(*(buf)) << 8) + \
2023 ((png_uint_32)(*((buf) + 1))))
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002024# define png_get_int_32(buf) \
2025 ((png_int_32)((*(buf) & 0x80) \
Glenn Randers-Pehrsondd807572010-07-30 14:35:50 -05002026 ? -((png_int_32)((png_get_uint_32(buf) ^ 0xffffffff)+1)) \
2027 : (png_int_32)png_get_uint_32(buf)))
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05002028#endif
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002029
2030#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05002031PNG_EXPORT(png_uint_32,png_get_uint_32,(png_bytep buf),,201);
2032PNG_EXPORT(png_uint_16,png_get_uint_16,(png_bytep buf),,202);
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05002033PNG_EXPORT(png_int_32,png_get_int_32,(png_bytep buf),,203);
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002034#endif
2035
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002036PNG_EXPORT(png_uint_32,png_get_uint_31,(png_structp png_ptr, png_bytep buf),,
2037 204);
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002038/* No png_get_int_16 -- may be added if there's a real need for it. */
2039
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002040/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002041#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05002042PNG_EXPORT(void,png_save_uint_32,(png_bytep buf, png_uint_32 i),,205);
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002043#endif
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05002044#ifdef PNG_SAVE_INT_32_SUPPORTED
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05002045PNG_EXPORT(void,png_save_int_32,(png_bytep buf, png_int_32 i),,206);
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05002046#endif
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002047
2048/* Place a 16-bit number into a buffer in PNG byte order.
2049 * The parameter is declared unsigned int, not png_uint_16,
2050 * just to avoid potential problems on pre-ANSI C compilers.
2051 */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002052#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrsonaa4e3592010-07-06 07:40:47 -05002053PNG_EXPORT(void,png_save_uint_16,(png_bytep buf, unsigned int i),,207);
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002054/* No png_save_int_16 -- may be added if there's a real need for it. */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002055#endif
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002056
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002057/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
2058 * defs
2059 */
2060
Glenn Randers-Pehrsonc551c0d2010-03-16 07:52:34 -05002061/* The last ordinal number (this is the *last* one, the next one to
2062 * use is one more than this.)
2063 */
2064#ifdef PNG_EXPORT_LAST_ORDINAL
Glenn Randers-Pehrson2be8b642010-07-29 19:09:18 -05002065 PNG_EXPORT_LAST_ORDINAL(218);
Glenn Randers-Pehrsonc551c0d2010-03-16 07:52:34 -05002066#endif
2067
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06002068#ifdef __cplusplus
2069}
2070#endif
2071
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05002072#endif /* PNG_VERSION_INFO_ONLY */
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002073/* Do not put anything past this line */
Glenn Randers-Pehrson13944802000-06-24 07:42:42 -05002074#endif /* PNG_H */