blob: 1f5444057f95fc3f8b41c8f7f541fc0ed8579bc9 [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-Pehrson87fadd52011-11-24 14:35:13 -06004 * libpng version 1.6.0alpha01 - November 24, 2011
Glenn Randers-Pehrson64b863c2011-01-04 09:57:06 -06005 * Copyright (c) 1998-2011 Glenn Randers-Pehrson
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -05006 * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)
7 * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -06008 *
Glenn Randers-Pehrsonbfbf8652009-06-26 21:46:52 -05009 * This code is released under the libpng license (See LICENSE, below)
Glenn Randers-Pehrson3e61d792009-06-24 09:31:28 -050010 *
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -050011 * Authors and maintainers:
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -060012 * libpng versions 0.71, May 1995, through 0.88, January 1996: Guy Schalnat
13 * libpng versions 0.89c, June 1996, through 0.96, May 1997: Andreas Dilger
Glenn Randers-Pehrson87fadd52011-11-24 14:35:13 -060014 * libpng versions 0.97, January 1998, through 1.6.0alpha01 - November 24, 2011: Glenn
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -060015 * See also "Contributing Authors", below.
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -050016 *
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060017 * Note about libpng version numbers:
18 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -060019 * Due to various miscommunications, unforeseen code incompatibilities
20 * and occasional factors outside the authors' control, version numbering
21 * on the library has not always been consistent and straightforward.
22 * The following table summarizes matters since version 0.89c, which was
23 * the first widely used release:
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060024 *
Glenn Randers-Pehrson75294572000-05-06 14:09:57 -050025 * source png.h png.h shared-lib
26 * version string int version
27 * ------- ------ ----- ----------
28 * 0.89c "1.0 beta 3" 0.89 89 1.0.89
29 * 0.90 "1.0 beta 4" 0.90 90 0.90 [should have been 2.0.90]
30 * 0.95 "1.0 beta 5" 0.95 95 0.95 [should have been 2.0.95]
31 * 0.96 "1.0 beta 6" 0.96 96 0.96 [should have been 2.0.96]
32 * 0.97b "1.00.97 beta 7" 1.00.97 97 1.0.1 [should have been 2.0.97]
33 * 0.97c 0.97 97 2.0.97
34 * 0.98 0.98 98 2.0.98
35 * 0.99 0.99 98 2.0.99
36 * 0.99a-m 0.99 99 2.0.99
37 * 1.00 1.00 100 2.1.0 [100 should be 10000]
38 * 1.0.0 (from here on, the 100 2.1.0 [100 should be 10000]
39 * 1.0.1 png.h string is 10001 2.1.0
40 * 1.0.1a-e identical to the 10002 from here on, the shared library
41 * 1.0.2 source version) 10002 is 2.V where V is the source code
42 * 1.0.2a-b 10003 version, except as noted.
43 * 1.0.3 10003
44 * 1.0.3a-d 10004
45 * 1.0.4 10004
46 * 1.0.4a-f 10005
47 * 1.0.5 (+ 2 patches) 10005
48 * 1.0.5a-d 10006
49 * 1.0.5e-r 10100 (not source compatible)
50 * 1.0.5s-v 10006 (not binary compatible)
51 * 1.0.6 (+ 3 patches) 10006 (still binary incompatible)
52 * 1.0.6d-f 10007 (still binary incompatible)
53 * 1.0.6g 10007
54 * 1.0.6h 10007 10.6h (testing xy.z so-numbering)
55 * 1.0.6i 10007 10.6i
56 * 1.0.6j 10007 2.1.0.6j (incompatible with 1.0.0)
Glenn Randers-Pehrsonbe9de0f2001-01-22 08:52:16 -060057 * 1.0.7beta11-14 DLLNUM 10007 2.1.0.7beta11-14 (binary compatible)
58 * 1.0.7beta15-18 1 10007 2.1.0.7beta15-18 (binary compatible)
59 * 1.0.7rc1-2 1 10007 2.1.0.7rc1-2 (binary compatible)
60 * 1.0.7 1 10007 (still compatible)
61 * 1.0.8beta1-4 1 10008 2.1.0.8beta1-4
62 * 1.0.8rc1 1 10008 2.1.0.8rc1
63 * 1.0.8 1 10008 2.1.0.8
64 * 1.0.9beta1-6 1 10009 2.1.0.9beta1-6
65 * 1.0.9rc1 1 10009 2.1.0.9rc1
66 * 1.0.9beta7-10 1 10009 2.1.0.9beta7-10
67 * 1.0.9rc2 1 10009 2.1.0.9rc2
Glenn Randers-Pehrsond4e81092001-01-31 05:56:52 -060068 * 1.0.9 1 10009 2.1.0.9
Glenn Randers-Pehrson19095602001-03-14 07:08:39 -060069 * 1.0.10beta1 1 10010 2.1.0.10beta1
Glenn Randers-Pehrsone1644472001-03-23 05:06:56 -060070 * 1.0.10rc1 1 10010 2.1.0.10rc1
Glenn Randers-Pehrson13cfbac2001-03-30 06:42:28 -060071 * 1.0.10 1 10010 2.1.0.10
Glenn Randers-Pehrsone1eff582001-04-14 20:15:41 -050072 * 1.0.11beta1-3 1 10011 2.1.0.11beta1-3
Glenn Randers-Pehrson82ae3832001-04-20 10:32:10 -050073 * 1.0.11rc1 1 10011 2.1.0.11rc1
Glenn Randers-Pehrson32835392001-04-27 08:29:32 -050074 * 1.0.11 1 10011 2.1.0.11
Glenn Randers-Pehrsonb1828932001-06-23 08:03:17 -050075 * 1.0.12beta1-2 2 10012 2.1.0.12beta1-2
76 * 1.0.12rc1 2 10012 2.1.0.12rc1
77 * 1.0.12 2 10012 2.1.0.12
78 * 1.1.0a-f - 10100 2.1.1.0a-f (branch abandoned)
Glenn Randers-Pehrson8b6a8892001-05-18 04:54:50 -050079 * 1.2.0beta1-2 2 10200 2.1.2.0beta1-2
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -050080 * 1.2.0beta3-5 3 10200 3.1.2.0beta3-5
81 * 1.2.0rc1 3 10200 3.1.2.0rc1
82 * 1.2.0 3 10200 3.1.2.0
Glenn Randers-Pehrson5cded0b2001-11-07 07:10:08 -060083 * 1.2.1beta1-4 3 10201 3.1.2.1beta1-4
Glenn Randers-Pehrsondb3b88d2001-12-04 06:30:43 -060084 * 1.2.1rc1-2 3 10201 3.1.2.1rc1-2
85 * 1.2.1 3 10201 3.1.2.1
Glenn Randers-Pehrson25228ab2002-03-31 07:33:55 -060086 * 1.2.2beta1-6 12 10202 12.so.0.1.2.2beta1-6
Glenn Randers-Pehrsonfcbd7872002-04-07 16:35:38 -050087 * 1.0.13beta1 10 10013 10.so.0.1.0.13beta1
88 * 1.0.13rc1 10 10013 10.so.0.1.0.13rc1
89 * 1.2.2rc1 12 10202 12.so.0.1.2.2rc1
Glenn Randers-Pehrson4fb046a2002-04-15 09:25:51 -050090 * 1.0.13 10 10013 10.so.0.1.0.13
91 * 1.2.2 12 10202 12.so.0.1.2.2
Glenn Randers-Pehrson22f28962002-05-13 18:17:09 -050092 * 1.2.3rc1-6 12 10203 12.so.0.1.2.3rc1-6
93 * 1.2.3 12 10203 12.so.0.1.2.3
Glenn Randers-Pehrsond020e9d2002-06-28 09:34:00 -050094 * 1.2.4beta1-3 13 10204 12.so.0.1.2.4beta1-3
Glenn Randers-Pehrson2ae022d2002-07-01 22:23:46 -050095 * 1.0.14rc1 13 10014 10.so.0.1.0.14rc1
96 * 1.2.4rc1 13 10204 12.so.0.1.2.4rc1
Glenn Randers-Pehrson484a8a12002-07-07 19:15:20 -050097 * 1.0.14 10 10014 10.so.0.1.0.14
98 * 1.2.4 13 10204 12.so.0.1.2.4
Glenn Randers-Pehrson51d92502002-08-23 23:07:42 -050099 * 1.2.5beta1-2 13 10205 12.so.0.1.2.5beta1-2
Glenn Randers-Pehrson5ff38d32002-09-17 23:38:46 -0500100 * 1.0.15rc1-3 10 10015 10.so.0.1.0.15rc1-3
Glenn Randers-Pehrson0cc2f952002-10-03 06:32:37 -0500101 * 1.2.5rc1-3 13 10205 12.so.0.1.2.5rc1-3
102 * 1.0.15 10 10015 10.so.0.1.0.15
103 * 1.2.5 13 10205 12.so.0.1.2.5
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500104 * 1.2.6beta1-4 13 10206 12.so.0.1.2.6beta1-4
Glenn Randers-Pehrson37f116a2004-08-15 07:15:39 -0500105 * 1.0.16 10 10016 10.so.0.1.0.16
106 * 1.2.6 13 10206 12.so.0.1.2.6
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -0500107 * 1.2.7beta1-2 13 10207 12.so.0.1.2.7beta1-2
Glenn Randers-Pehrson5b779162004-09-04 13:25:08 -0500108 * 1.0.17rc1 10 10017 12.so.0.1.0.17rc1
109 * 1.2.7rc1 13 10207 12.so.0.1.2.7rc1
Glenn Randers-Pehrson250dfe12004-09-11 21:19:54 -0500110 * 1.0.17 10 10017 12.so.0.1.0.17
111 * 1.2.7 13 10207 12.so.0.1.2.7
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600112 * 1.2.8beta1-5 13 10208 12.so.0.1.2.8beta1-5
Glenn Randers-Pehrson584b96e2004-11-29 15:08:00 -0600113 * 1.0.18rc1-5 10 10018 12.so.0.1.0.18rc1-5
114 * 1.2.8rc1-5 13 10208 12.so.0.1.2.8rc1-5
Glenn Randers-Pehrson917648e2004-12-02 18:14:51 -0600115 * 1.0.18 10 10018 12.so.0.1.0.18
116 * 1.2.8 13 10208 12.so.0.1.2.8
Glenn Randers-Pehrsone6474622006-03-04 16:50:47 -0600117 * 1.2.9beta1-3 13 10209 12.so.0.1.2.9beta1-3
Glenn Randers-Pehrson4deeb792006-03-22 16:21:59 -0600118 * 1.2.9beta4-11 13 10209 12.so.0.9[.0]
Glenn Randers-Pehrson3a512032006-03-31 05:29:33 -0600119 * 1.2.9rc1 13 10209 12.so.0.9[.0]
Glenn Randers-Pehrsona7d0c942006-04-14 06:22:52 -0500120 * 1.2.9 13 10209 12.so.0.9[.0]
Glenn Randers-Pehrsond60b8fa2006-04-20 21:31:14 -0500121 * 1.2.10beta1-7 13 10210 12.so.0.10[.0]
Glenn Randers-Pehrson17218292006-04-20 07:20:46 -0500122 * 1.2.10rc1-2 13 10210 12.so.0.10[.0]
Glenn Randers-Pehrson86dc9812006-05-10 07:27:44 -0500123 * 1.2.10 13 10210 12.so.0.10[.0]
Glenn Randers-Pehrson73b064c2006-05-15 06:44:21 -0500124 * 1.4.0beta1-5 14 10400 14.so.0.0[.0]
Glenn Randers-Pehrson7824a702009-06-13 10:05:05 -0500125 * 1.2.11beta1-4 13 10211 12.so.0.11[.0]
Glenn Randers-Pehrson3424ee72006-07-12 13:33:47 -0500126 * 1.4.0beta7-8 14 10400 14.so.0.0[.0]
Glenn Randers-Pehrson7aa18342009-06-05 17:24:17 -0500127 * 1.2.11 13 10211 12.so.0.11[.0]
128 * 1.2.12 13 10212 12.so.0.12[.0]
Glenn Randers-Pehrson701dbaa2006-11-17 09:36:54 -0600129 * 1.4.0beta9-14 14 10400 14.so.0.0[.0]
Glenn Randers-Pehrson7aa18342009-06-05 17:24:17 -0500130 * 1.2.13 13 10213 12.so.0.13[.0]
Glenn Randers-Pehrson97a9b482008-10-25 20:03:28 -0500131 * 1.4.0beta15-36 14 10400 14.so.0.0[.0]
Glenn Randers-Pehrsonfa028102009-10-10 06:15:21 -0500132 * 1.4.0beta37-87 14 10400 14.so.14.0[.0]
Glenn Randers-Pehrson733da8c2009-10-30 00:00:15 -0500133 * 1.4.0rc01 14 10400 14.so.14.0[.0]
Glenn Randers-Pehrson62ca98e2009-12-20 15:14:57 -0600134 * 1.4.0beta88-109 14 10400 14.so.14.0[.0]
Glenn Randers-Pehrson67a83db2010-01-01 18:26:18 -0600135 * 1.4.0rc02-08 14 10400 14.so.14.0[.0]
Glenn Randers-Pehrson75202242009-12-25 14:25:29 -0600136 * 1.4.0 14 10400 14.so.14.0[.0]
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -0600137 * 1.4.1beta01-03 14 10401 14.so.14.1[.0]
138 * 1.4.1rc01 14 10401 14.so.14.1[.0]
Glenn Randers-Pehrson7a5be532010-02-14 07:16:19 -0600139 * 1.4.1beta04-12 14 10401 14.so.14.1[.0]
Glenn Randers-Pehrsonaaf377c2010-03-08 11:20:30 -0600140 * 1.4.1 14 10401 14.so.14.1[.0]
Glenn Randers-Pehrson5b3d5542010-06-18 21:55:53 -0500141 * 1.4.2 14 10402 14.so.14.2[.0]
142 * 1.4.3 14 10403 14.so.14.3[.0]
Glenn Randers-Pehrson2776d5e2010-11-21 15:18:02 -0600143 * 1.4.4 14 10404 14.so.14.4[.0]
Glenn Randers-Pehrsonfd20a5a2010-12-27 08:53:08 -0600144 * 1.5.0beta01-58 15 10500 15.so.15.0[.0]
Glenn Randers-Pehrson64b863c2011-01-04 09:57:06 -0600145 * 1.5.0rc01-07 15 10500 15.so.15.0[.0]
Glenn Randers-Pehrsonf5ea1b72011-01-06 06:42:51 -0600146 * 1.5.0 15 10500 15.so.15.0[.0]
Glenn Randers-Pehrsonef123cc2011-01-28 15:20:34 -0600147 * 1.5.1beta01-11 15 10501 15.so.15.1[.0]
Glenn Randers-Pehrson3d3aae12011-02-02 22:58:27 -0600148 * 1.5.1rc01-02 15 10501 15.so.15.1[.0]
149 * 1.5.1 15 10501 15.so.15.1[.0]
Glenn Randers-Pehrsonf3dd1cc2011-03-18 22:02:20 -0500150 * 1.5.2beta01-03 15 10502 15.so.15.2[.0]
Glenn Randers-Pehrson77fd0832011-03-24 08:59:48 -0500151 * 1.5.2rc01-03 15 10502 15.so.15.2[.0]
Glenn Randers-Pehrsondcc35052011-03-31 11:23:49 -0500152 * 1.5.2 15 10502 15.so.15.2[.0]
Glenn Randers-Pehrson36edbb52011-06-03 07:15:04 -0500153 * 1.5.3beta01-10 15 10503 15.so.15.3[.0]
Glenn Randers-Pehrsonfb278732011-06-10 20:43:39 -0500154 * 1.5.3rc01-02 15 10503 15.so.15.3[.0]
Glenn Randers-Pehrson413138a2011-06-13 22:07:37 -0500155 * 1.5.3beta11 15 10503 15.so.15.3[.0]
156 * 1.5.3 [omitted]
Glenn Randers-Pehrson9daf91e2011-06-22 23:10:36 -0500157 * 1.5.4beta01-08 15 10504 15.so.15.4[.0]
Glenn Randers-Pehrson78bb9da2011-06-30 18:59:45 -0500158 * 1.5.4rc01 15 10504 15.so.15.4[.0]
Glenn Randers-Pehrsond404b6d2011-07-07 06:24:57 -0500159 * 1.5.4 15 10504 15.so.15.4[.0]
Glenn Randers-Pehrson3c2ae602011-09-09 06:02:09 -0500160 * 1.5.5beta01-08 15 10505 15.so.15.5[.0]
161 * 1.5.5rc01 15 10505 15.so.15.5[.0]
Glenn Randers-Pehrson3e2263a2011-09-22 08:40:32 -0500162 * 1.5.5 15 10505 15.so.15.5[.0]
Glenn Randers-Pehrson93254f62011-10-26 08:36:21 -0500163 * 1.5.6beta01-07 15 10506 15.so.15.6[.0]
Glenn Randers-Pehrsonbc6726b2011-11-02 22:43:00 -0500164 * 1.5.6rc01-03 15 10506 15.so.15.6[.0]
165 * 1.5.6 15 10506 15.so.15.6[.0]
Glenn Randers-Pehrson36251d32011-11-17 21:14:34 -0600166 * 1.5.7beta01-05 15 10507 15.so.15.7[.0]
Glenn Randers-Pehrson15ea1fa2011-11-23 15:28:01 -0600167 * 1.6.0alpha01 16 10600 16.so.16.0[.0]
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600168 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600169 * Henceforth the source version will match the shared-library major
170 * and minor numbers; the shared-library major version number will be
171 * used for changes in backward compatibility, as it is intended. The
172 * PNG_LIBPNG_VER macro, which is not used within libpng but is available
173 * for applications, is an unsigned integer of the form xyyzz corresponding
174 * to the source version x.y.z (leading zeros in y and z). Beta versions
175 * were given the previous public release number plus a letter, until
176 * version 1.0.6j; from then on they were given the upcoming public
177 * release number plus "betaNN" or "rcN".
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600178 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600179 * Binary incompatibility exists only when applications make direct access
180 * to the info_ptr or png_ptr members through png.h, and the compiled
181 * application is loaded with a different version of the library.
Glenn Randers-Pehrson326320e2000-04-24 07:43:17 -0500182 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600183 * DLLNUM will change each time there are forward or backward changes
184 * in binary compatibility (e.g., when a new feature is added).
Glenn Randers-Pehrsonbe9de0f2001-01-22 08:52:16 -0600185 *
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500186 * See libpng-manual.txt or libpng.3 for more information. The PNG
187 * specification is available as a W3C Recommendation and as an ISO
188 * Specification, <http://www.w3.org/TR/2003/REC-PNG-20031110/
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600189 */
190
191/*
Glenn Randers-Pehrson68ea2432000-04-01 21:10:05 -0600192 * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
193 *
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500194 * If you modify libpng you may insert additional notices immediately following
195 * this sentence.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600196 *
Glenn Randers-Pehrsonbfbf8652009-06-26 21:46:52 -0500197 * This code is released under the libpng license.
198 *
Glenn Randers-Pehrson87fadd52011-11-24 14:35:13 -0600199 * libpng versions 1.2.6, August 15, 2004, through 1.6.0alpha01, November 24, 2011, are
Glenn Randers-Pehrson64b863c2011-01-04 09:57:06 -0600200 * Copyright (c) 2004, 2006-2011 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500201 * distributed according to the same disclaimer and license as libpng-1.2.5
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500202 * with the following individual added to the list of Contributing Authors:
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500203 *
204 * Cosmin Truta
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500205 *
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500206 * libpng versions 1.0.7, July 1, 2000, through 1.2.5, October 3, 2002, are
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500207 * Copyright (c) 2000-2002 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrson32fc5ce2000-07-24 06:34:14 -0500208 * distributed according to the same disclaimer and license as libpng-1.0.6
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500209 * with the following individuals added to the list of Contributing Authors:
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500210 *
211 * Simon-Pierre Cadieux
212 * Eric S. Raymond
213 * Gilles Vollant
214 *
Glenn Randers-Pehrson3d5a5202000-07-01 15:37:28 -0500215 * and with the following additions to the disclaimer:
216 *
217 * There is no warranty against interference with your enjoyment of the
218 * library or against infringement. There is no warranty that our
219 * efforts or the library will fulfill any of your particular purposes
220 * or needs. This library is provided with all faults, and the entire
221 * risk of satisfactory quality, performance, accuracy, and effort is with
222 * the user.
223 *
224 * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500225 * Copyright (c) 1998, 1999, 2000 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600226 * distributed according to the same disclaimer and license as libpng-0.96,
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500227 * with the following individuals added to the list of Contributing Authors:
228 *
229 * Tom Lane
230 * Glenn Randers-Pehrson
231 * Willem van Schaik
232 *
233 * libpng versions 0.89, June 1996, through 0.96, May 1997, are
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600234 * Copyright (c) 1996, 1997 Andreas Dilger
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600235 * Distributed according to the same disclaimer and license as libpng-0.88,
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500236 * with the following individuals added to the list of Contributing Authors:
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600237 *
238 * John Bowler
239 * Kevin Bracey
240 * Sam Bushell
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600241 * Magnus Holmgren
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600242 * Greg Roelofs
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500243 * Tom Tanner
244 *
245 * libpng versions 0.5, May 1995, through 0.88, January 1996, are
246 * Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.
247 *
248 * For the purposes of this copyright and license, "Contributing Authors"
249 * is defined as the following set of individuals:
250 *
251 * Andreas Dilger
252 * Dave Martindale
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600253 * Guy Eric Schalnat
254 * Paul Schmidt
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600255 * Tim Wegner
256 *
257 * The PNG Reference Library is supplied "AS IS". The Contributing Authors
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600258 * and Group 42, Inc. disclaim all warranties, expressed or implied,
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600259 * including, without limitation, the warranties of merchantability and of
260 * fitness for any purpose. The Contributing Authors and Group 42, Inc.
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600261 * assume no liability for direct, indirect, incidental, special, exemplary,
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600262 * or consequential damages, which may result from the use of the PNG
263 * Reference Library, even if advised of the possibility of such damage.
264 *
265 * Permission is hereby granted to use, copy, modify, and distribute this
266 * source code, or portions hereof, for any purpose, without fee, subject
267 * to the following restrictions:
268 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600269 * 1. The origin of this source code must not be misrepresented.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600270 *
Glenn Randers-Pehrson53c07f52010-06-18 18:55:55 -0500271 * 2. Altered versions must be plainly marked as such and must not
272 * be misrepresented as being the original source.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600273 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600274 * 3. This Copyright notice may not be removed or altered from
275 * any source or altered source distribution.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600276 *
277 * The Contributing Authors and Group 42, Inc. specifically permit, without
278 * fee, and encourage the use of this source code as a component to
279 * supporting the PNG file format in commercial products. If you use this
280 * source code in a product, acknowledgment is not required but would be
281 * appreciated.
282 */
283
284/*
285 * A "png_get_copyright" function is available, for convenient use in "about"
286 * boxes and the like:
287 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600288 * printf("%s", png_get_copyright(NULL));
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600289 *
290 * Also, the PNG logo (in PNG format, of course) is supplied in the
Glenn Randers-Pehrsona4d54bd2000-07-14 08:15:12 -0500291 * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600292 */
293
294/*
295 * Libpng is OSI Certified Open Source Software. OSI Certified is a
296 * certification mark of the Open Source Initiative.
297 */
298
299/*
300 * The contributing authors would like to thank all those who helped
301 * with testing, bug fixes, and patience. This wouldn't have been
302 * possible without all of you.
303 *
304 * Thanks to Frank J. T. Wojcik for helping with the documentation.
305 */
306
307/*
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600308 * Y2K compliance in libpng:
309 * =========================
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600310 *
Glenn Randers-Pehrson87fadd52011-11-24 14:35:13 -0600311 * November 24, 2011
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600312 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600313 * Since the PNG Development group is an ad-hoc body, we can't make
314 * an official declaration.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600315 *
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500316 * This is your unofficial assurance that libpng from version 0.71 and
Glenn Randers-Pehrson15ea1fa2011-11-23 15:28:01 -0600317 * upward through 1.6.0alpha01 are Y2K compliant. It is my belief that
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500318 * earlier versions were also Y2K compliant.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600319 *
John Bowler88b77cc2011-05-05 06:49:55 -0500320 * Libpng only has two year fields. One is a 2-byte unsigned integer
321 * that will hold years up to 65535. The other holds the date in text
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600322 * format, and will hold years up to 9999.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600323 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600324 * The integer is
325 * "png_uint_16 year" in png_time_struct.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600326 *
John Bowler88b77cc2011-05-05 06:49:55 -0500327 * The string is
328 * "png_char time_buffer" in png_struct
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600329 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600330 * There are seven time-related functions:
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600331 * png.c: png_convert_to_rfc_1123() in png.c
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600332 * (formerly png_convert_to_rfc_1152() in error)
333 * png_convert_from_struct_tm() in pngwrite.c, called in pngwrite.c
334 * png_convert_from_time_t() in pngwrite.c
335 * png_get_tIME() in pngget.c
336 * png_handle_tIME() in pngrutil.c, called in pngread.c
337 * png_set_tIME() in pngset.c
338 * png_write_tIME() in pngwutil.c, called in pngwrite.c
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600339 *
340 * All handle dates properly in a Y2K environment. The
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600341 * png_convert_from_time_t() function calls gmtime() to convert from system
342 * clock time, which returns (year - 1900), which we properly convert to
343 * the full 4-digit year. There is a possibility that applications using
344 * libpng are not passing 4-digit years into the png_convert_to_rfc_1123()
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500345 * function, or that they are incorrectly passing only a 2-digit year
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600346 * instead of "year - 1900" into the png_convert_from_struct_tm() function,
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500347 * but this is not under our control. The libpng documentation has always
348 * stated that it works with 4-digit years, and the APIs have been
349 * documented as such.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600350 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600351 * The tIME chunk itself is also Y2K compliant. It uses a 2-byte unsigned
352 * integer to hold the year, and can hold years as large as 65535.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600353 *
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500354 * zlib, upon which libpng depends, is also Y2K compliant. It contains
355 * no date-related code.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600356 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600357 * Glenn Randers-Pehrson
358 * libpng maintainer
359 * PNG Development Group
Glenn Randers-Pehrsonbcfd15d1999-10-01 14:22:25 -0500360 */
361
Glenn Randers-Pehrson13944802000-06-24 07:42:42 -0500362#ifndef PNG_H
363#define PNG_H
Guy Schalnat0d580581995-07-20 02:43:20 -0500364
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500365/* This is not the place to learn how to use libpng. The file libpng-manual.txt
Andreas Dilger47a0c421997-05-16 02:46:07 -0500366 * describes how to use libpng, and the file example.c summarizes it
367 * with some code on which to build. This file is useful for looking
368 * at the actual function definitions and structure components.
John Bowler7875d532011-11-07 22:33:49 -0600369 *
370 * If you just need to read a PNG file and don't want to read the documentation
371 * skip to the end of this file and read the section entitled 'simplified API'.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500372 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500373
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500374/* Version information for png.h - this should match the version in png.c */
Glenn Randers-Pehrson15ea1fa2011-11-23 15:28:01 -0600375#define PNG_LIBPNG_VER_STRING "1.6.0alpha01"
Glenn Randers-Pehrson5b5dcf82004-07-17 22:45:44 -0500376#define PNG_HEADER_VERSION_STRING \
Glenn Randers-Pehrson87fadd52011-11-24 14:35:13 -0600377 " libpng version 1.6.0alpha01 - November 24, 2011\n"
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500378
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -0600379#define PNG_LIBPNG_VER_SONUM 16
380#define PNG_LIBPNG_VER_DLLNUM 16
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500381
382/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */
383#define PNG_LIBPNG_VER_MAJOR 1
Glenn Randers-Pehrson87fadd52011-11-24 14:35:13 -0600384#define PNG_LIBPNG_VER_MINOR 6
385#define PNG_LIBPNG_VER_RELEASE 0
386
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500387/* This should match the numeric part of the final component of
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500388 * PNG_LIBPNG_VER_STRING, omitting any leading zero:
389 */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600390
Glenn Randers-Pehrson87fadd52011-11-24 14:35:13 -0600391#define PNG_LIBPNG_VER_BUILD 01
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600392
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600393/* Release Status */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600394#define PNG_LIBPNG_BUILD_ALPHA 1
395#define PNG_LIBPNG_BUILD_BETA 2
396#define PNG_LIBPNG_BUILD_RC 3
397#define PNG_LIBPNG_BUILD_STABLE 4
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600398#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500399
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600400/* Release-Specific Flags */
401#define PNG_LIBPNG_BUILD_PATCH 8 /* Can be OR'ed with
402 PNG_LIBPNG_BUILD_STABLE only */
403#define PNG_LIBPNG_BUILD_PRIVATE 16 /* Cannot be OR'ed with
404 PNG_LIBPNG_BUILD_SPECIAL */
405#define PNG_LIBPNG_BUILD_SPECIAL 32 /* Cannot be OR'ed with
406 PNG_LIBPNG_BUILD_PRIVATE */
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500407
Glenn Randers-Pehrson17218292006-04-20 07:20:46 -0500408#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_BETA
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600409
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500410/* Careful here. At one time, Guy wanted to use 082, but that would be octal.
411 * We must not include leading zeros.
412 * Versions 0.7 through 1.0.0 were in the range 0 to 100 here (only
413 * version 1.0.0 was mis-numbered 100 instead of 10000). From
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500414 * version 1.0.1 it's xxyyzz, where x=major, y=minor, z=release
415 */
Glenn Randers-Pehrson87fadd52011-11-24 14:35:13 -0600416#define PNG_LIBPNG_VER 10600 /* 1.6.0 */
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500417
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500418/* Library configuration: these options cannot be changed after
419 * the library has been built.
420 */
421#ifndef PNGLCONF_H
Glenn Randers-Pehrson8c667862010-08-24 16:16:35 -0500422 /* If pnglibconf.h is missing, you can
423 * copy scripts/pnglibconf.h.prebuilt to pnglibconf.h
424 */
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500425# include "pnglibconf.h"
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600426#endif
Guy Schalnat0d580581995-07-20 02:43:20 -0500427
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500428#ifndef PNG_VERSION_INFO_ONLY
Glenn Randers-Pehrson80de04e2011-03-24 23:06:26 -0500429# ifndef PNG_BUILDING_SYMBOL_TABLE
430 /*
431 * Standard header files (not needed for the version info or while
432 * building symbol table -- see scripts/pnglibconf.dfa)
433 */
434# ifdef PNG_SETJMP_SUPPORTED
435# include <setjmp.h>
436# endif
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500437
Glenn Randers-Pehrson80de04e2011-03-24 23:06:26 -0500438 /* Need the time information for converting tIME chunks, it
439 * defines struct tm:
440 */
441# ifdef PNG_CONVERT_tIME_SUPPORTED
442 /* "time.h" functions are not supported on all operating systems */
443# include <time.h>
444# endif
445# endif
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500446
447/* Machine specific configuration. */
448# include "pngconf.h"
449#endif
Guy Schalnat0d580581995-07-20 02:43:20 -0500450
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600451/*
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500452 * Added at libpng-1.2.8
453 *
454 * Ref MSDN: Private as priority over Special
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600455 * VS_FF_PRIVATEBUILD File *was not* built using standard release
456 * procedures. If this value is given, the StringFileInfo block must
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500457 * contain a PrivateBuild string.
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600458 *
459 * VS_FF_SPECIALBUILD File *was* built by the original company using
460 * standard release procedures but is a variation of the standard
461 * file of the same version number. If this value is given, the
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500462 * StringFileInfo block must contain a SpecialBuild string.
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600463 */
464
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500465#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600466# define PNG_LIBPNG_BUILD_TYPE \
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600467 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600468#else
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500469# ifdef PNG_LIBPNG_SPECIALBUILD
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600470# define PNG_LIBPNG_BUILD_TYPE \
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600471 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600472# else
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600473# define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600474# endif
475#endif
476
477#ifndef PNG_VERSION_INFO_ONLY
478
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500479/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
480#ifdef __cplusplus
481extern "C" {
482#endif /* __cplusplus */
483
Andreas Dilger47a0c421997-05-16 02:46:07 -0500484/* Version information for C files, stored in png.c. This had better match
485 * the version above.
486 */
Glenn Randers-Pehrson4c8f7262010-03-16 19:30:01 -0500487#define png_libpng_ver png_get_header_ver(NULL)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500488
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500489/* This file is arranged in several sections:
490 *
491 * 1. Any configuration options that can be specified by for the application
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500492 * code when it is built. (Build time configuration is in pnglibconf.h)
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500493 * 2. Type definitions (base types are defined in pngconf.h), structure
494 * definitions.
495 * 3. Exported library functions.
John Bowler7875d532011-11-07 22:33:49 -0600496 * 4. Simplified API.
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500497 *
498 * The library source code has additional files (principally pngpriv.h) that
499 * allow configuration of the library.
500 */
501/* Section 1: run time configuration
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500502 * See pnglibconf.h for build time configuration
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500503 *
504 * Run time configuration allows the application to choose between
505 * implementations of certain arithmetic APIs. The default is set
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500506 * at build time and recorded in pnglibconf.h, but it is safe to
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500507 * override these (and only these) settings. Note that this won't
508 * change what the library does, only application code, and the
509 * settings can (and probably should) be made on a per-file basis
510 * by setting the #defines before including png.h
511 *
512 * Use macros to read integers from PNG data or use the exported
513 * functions?
514 * PNG_USE_READ_MACROS: use the macros (see below) Note that
515 * the macros evaluate their argument multiple times.
516 * PNG_NO_USE_READ_MACROS: call the relevant library function.
517 *
518 * Use the alternative algorithm for compositing alpha samples that
519 * does not use division?
520 * PNG_READ_COMPOSITE_NODIV_SUPPORTED: use the 'no division'
521 * algorithm.
522 * PNG_NO_READ_COMPOSITE_NODIV: use the 'division' algorithm.
523 *
524 * How to handle benign errors if PNG_ALLOW_BENIGN_ERRORS is
525 * false?
526 * PNG_ALLOW_BENIGN_ERRORS: map calls to the benign error
527 * APIs to png_warning.
528 * Otherwise the calls are mapped to png_error.
529 */
530
531/* Section 2: type definitions, including structures and compile time
532 * constants.
533 * See pngconf.h for base types that vary by machine/system
534 */
Glenn Randers-Pehrson88910f52010-10-16 20:38:45 -0500535
536/* This triggers a compiler error in png.c, if png.c and png.h
537 * do not agree upon the version number.
538 */
Glenn Randers-Pehrson15ea1fa2011-11-23 15:28:01 -0600539typedef char* png_libpng_version_1_6_0alpha01;
Glenn Randers-Pehrson88910f52010-10-16 20:38:45 -0500540
Andreas Dilger47a0c421997-05-16 02:46:07 -0500541/* Three color definitions. The order of the red, green, and blue, (and the
542 * exact size) is not important, although the size of the fields need to
543 * be png_byte or png_uint_16 (as defined below).
544 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500545typedef struct png_color_struct
546{
Guy Schalnat4ee97b01996-01-16 01:51:56 -0600547 png_byte red;
Guy Schalnat0d580581995-07-20 02:43:20 -0500548 png_byte green;
549 png_byte blue;
550} png_color;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500551typedef png_color FAR * png_colorp;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500552typedef PNG_CONST png_color FAR * png_const_colorp;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500553typedef png_color FAR * FAR * png_colorpp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500554
555typedef struct png_color_16_struct
556{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500557 png_byte index; /* used for palette files */
558 png_uint_16 red; /* for use in red green blue files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500559 png_uint_16 green;
560 png_uint_16 blue;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500561 png_uint_16 gray; /* for use in grayscale files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500562} png_color_16;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500563typedef png_color_16 FAR * png_color_16p;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500564typedef PNG_CONST png_color_16 FAR * png_const_color_16p;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500565typedef png_color_16 FAR * FAR * png_color_16pp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500566
567typedef struct png_color_8_struct
568{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500569 png_byte red; /* for use in red green blue files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500570 png_byte green;
571 png_byte blue;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500572 png_byte gray; /* for use in grayscale files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500573 png_byte alpha; /* for alpha channel files */
574} png_color_8;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500575typedef png_color_8 FAR * png_color_8p;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500576typedef PNG_CONST png_color_8 FAR * png_const_color_8p;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500577typedef png_color_8 FAR * FAR * png_color_8pp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500578
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600579/*
580 * The following two structures are used for the in-core representation
581 * of sPLT chunks.
582 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600583typedef struct png_sPLT_entry_struct
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600584{
585 png_uint_16 red;
586 png_uint_16 green;
587 png_uint_16 blue;
588 png_uint_16 alpha;
589 png_uint_16 frequency;
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600590} png_sPLT_entry;
591typedef png_sPLT_entry FAR * png_sPLT_entryp;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500592typedef PNG_CONST png_sPLT_entry FAR * png_const_sPLT_entryp;
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600593typedef png_sPLT_entry FAR * FAR * png_sPLT_entrypp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600594
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500595/* When the depth of the sPLT palette is 8 bits, the color and alpha samples
596 * occupy the LSB of their respective members, and the MSB of each member
597 * is zero-filled. The frequency member always occupies the full 16 bits.
598 */
599
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600600typedef struct png_sPLT_struct
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600601{
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500602 png_charp name; /* palette name */
603 png_byte depth; /* depth of palette samples */
604 png_sPLT_entryp entries; /* palette entries */
605 png_int_32 nentries; /* number of palette entries */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600606} png_sPLT_t;
607typedef png_sPLT_t FAR * png_sPLT_tp;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500608typedef PNG_CONST png_sPLT_t FAR * png_const_sPLT_tp;
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600609typedef png_sPLT_t FAR * FAR * png_sPLT_tpp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600610
611#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600612/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600613 * and whether that contents is compressed or not. The "key" field
Glenn Randers-Pehrson680da022011-11-21 17:05:41 -0600614 * points to a regular zero-terminated C string. The "text" fields can be a
615 * regular C string, an empty string, or a NULL pointer.
Glenn Randers-Pehrson140504b2011-06-15 08:10:13 -0500616 * However, the structure returned by png_get_text() will always contain
Glenn Randers-Pehrson680da022011-11-21 17:05:41 -0600617 * the "text" field as a regular zero-terminated C string (possibly
618 * empty), never a NULL pointer, so it can be safely used in printf() and
619 * other string-handling functions. Note that the "itxt_length", "lang", and
620 * "lang_key" members of the structure only exist when the library is built
621 * with iTXt chunk support. Prior to libpng-1.4.0 the library was built by
622 * default without iTXt support. Also note that when iTXt *is* supported,
623 * the "lang" and "lang_key" fields contain NULL pointers when the
624 * "compression" field contains * PNG_TEXT_COMPRESSION_NONE or
Glenn Randers-Pehrson12fb29f2011-11-22 11:53:49 -0600625 * PNG_TEXT_COMPRESSION_zTXt. Note that the "compression value" is not the
626 * same as what appears in the PNG tEXt/zTXt/iTXt chunk's "compression flag"
627 * which is always 0 or 1, or its "compression method" which is always 0.
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500628 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500629typedef struct png_text_struct
630{
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500631 int compression; /* compression value:
632 -1: tEXt, none
633 0: zTXt, deflate
634 1: iTXt, none
635 2: iTXt, deflate */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500636 png_charp key; /* keyword, 1-79 character description of "text" */
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500637 png_charp text; /* comment, may be an empty string (ie "")
638 or a NULL pointer */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600639 png_size_t text_length; /* length of the text string */
640 png_size_t itxt_length; /* length of the itxt string */
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500641 png_charp lang; /* language code, 0-79 characters
642 or a NULL pointer */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600643 png_charp lang_key; /* keyword translated UTF-8 string, 0 or more
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500644 chars or a NULL pointer */
Guy Schalnat0d580581995-07-20 02:43:20 -0500645} png_text;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500646typedef png_text FAR * png_textp;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500647typedef PNG_CONST png_text FAR * png_const_textp;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500648typedef png_text FAR * FAR * png_textpp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600649#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -0500650
651/* Supported compression types for text in PNG files (tEXt, and zTXt).
652 * The values of the PNG_TEXT_COMPRESSION_ defines should NOT be changed. */
653#define PNG_TEXT_COMPRESSION_NONE_WR -3
654#define PNG_TEXT_COMPRESSION_zTXt_WR -2
655#define PNG_TEXT_COMPRESSION_NONE -1
656#define PNG_TEXT_COMPRESSION_zTXt 0
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600657#define PNG_ITXT_COMPRESSION_NONE 1
658#define PNG_ITXT_COMPRESSION_zTXt 2
659#define PNG_TEXT_COMPRESSION_LAST 3 /* Not a valid value */
Guy Schalnat0d580581995-07-20 02:43:20 -0500660
661/* png_time is a way to hold the time in an machine independent way.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600662 * Two conversions are provided, both from time_t and struct tm. There
663 * is no portable way to convert to either of these structures, as far
664 * 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 -0600665 * note - PNG has always been Year 2000 compliant!
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600666 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500667typedef struct png_time_struct
668{
669 png_uint_16 year; /* full year, as in, 1995 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500670 png_byte month; /* month of year, 1 - 12 */
671 png_byte day; /* day of month, 1 - 31 */
672 png_byte hour; /* hour of day, 0 - 23 */
673 png_byte minute; /* minute of hour, 0 - 59 */
674 png_byte second; /* second of minute, 0 - 60 (for leap seconds) */
Guy Schalnat0d580581995-07-20 02:43:20 -0500675} png_time;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500676typedef png_time FAR * png_timep;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500677typedef PNG_CONST png_time FAR * png_const_timep;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500678typedef png_time FAR * FAR * png_timepp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500679
Glenn Randers-Pehrson38674ec2009-06-16 13:33:01 -0500680#if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED) || \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -0600681 defined(PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600682/* png_unknown_chunk is a structure to hold queued chunks for which there is
683 * no specific support. The idea is that we can use this to queue
684 * up private chunks for output even though the library doesn't actually
685 * know about their semantics.
686 */
687typedef struct png_unknown_chunk_t
688{
689 png_byte name[5];
690 png_byte *data;
691 png_size_t size;
692
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600693 /* libpng-using applications should NOT directly modify this byte. */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600694 png_byte location; /* mode of operation at read time */
695}
Glenn Randers-Pehrson2d3fc1c2011-05-10 23:48:00 -0500696
Glenn Randers-Pehrson2d3fc1c2011-05-10 23:48:00 -0500697
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600698png_unknown_chunk;
699typedef png_unknown_chunk FAR * png_unknown_chunkp;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500700typedef PNG_CONST png_unknown_chunk FAR * png_const_unknown_chunkp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600701typedef png_unknown_chunk FAR * FAR * png_unknown_chunkpp;
702#endif
703
Glenn Randers-Pehrsonfd73d042011-06-13 13:25:21 -0500704/* Values for the unknown chunk location byte */
Glenn Randers-Pehrson2d3fc1c2011-05-10 23:48:00 -0500705
Glenn Randers-Pehrsonfd73d042011-06-13 13:25:21 -0500706#define PNG_HAVE_IHDR 0x01
707#define PNG_HAVE_PLTE 0x02
708#define PNG_AFTER_IDAT 0x08
Glenn Randers-Pehrson2d3fc1c2011-05-10 23:48:00 -0500709
Glenn Randers-Pehrson1384c042011-04-28 23:22:18 -0500710/* The complete definition of png_info has, as of libpng-1.5.0,
711 * been moved into a separate header file that is not accessible to
712 * applications. Read libpng-manual.txt or libpng.3 for more info.
713 */
Glenn Randers-Pehrsonf0cdbe72010-02-08 23:18:15 -0600714typedef struct png_info_def png_info;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500715typedef png_info FAR * png_infop;
John Bowler0a5c9c02011-01-22 17:36:34 -0600716typedef PNG_CONST png_info FAR * png_const_infop;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500717typedef png_info FAR * FAR * png_infopp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500718
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500719/* Maximum positive integer used in PNG is (2^31)-1 */
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500720#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
Glenn Randers-Pehrson78067772004-11-02 21:49:39 -0600721#define PNG_UINT_32_MAX ((png_uint_32)(-1))
722#define PNG_SIZE_MAX ((png_size_t)(-1))
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500723
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500724/* These are constants for fixed point values encoded in the
725 * PNG specification manner (x100000)
726 */
727#define PNG_FP_1 100000
728#define PNG_FP_HALF 50000
John Bowlerd273ad22011-05-07 21:00:28 -0500729#define PNG_FP_MAX ((png_fixed_point)0x7fffffffL)
730#define PNG_FP_MIN (-PNG_FP_MAX)
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500731
Andreas Dilger47a0c421997-05-16 02:46:07 -0500732/* These describe the color_type field in png_info. */
Guy Schalnat0d580581995-07-20 02:43:20 -0500733/* color type masks */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500734#define PNG_COLOR_MASK_PALETTE 1
735#define PNG_COLOR_MASK_COLOR 2
736#define PNG_COLOR_MASK_ALPHA 4
Guy Schalnat0d580581995-07-20 02:43:20 -0500737
738/* color types. Note that not all combinations are legal */
Guy Schalnate5a37791996-06-05 15:50:50 -0500739#define PNG_COLOR_TYPE_GRAY 0
Andreas Dilger47a0c421997-05-16 02:46:07 -0500740#define PNG_COLOR_TYPE_PALETTE (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE)
741#define PNG_COLOR_TYPE_RGB (PNG_COLOR_MASK_COLOR)
742#define PNG_COLOR_TYPE_RGB_ALPHA (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA)
Guy Schalnat0d580581995-07-20 02:43:20 -0500743#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600744/* aliases */
745#define PNG_COLOR_TYPE_RGBA PNG_COLOR_TYPE_RGB_ALPHA
746#define PNG_COLOR_TYPE_GA PNG_COLOR_TYPE_GRAY_ALPHA
Guy Schalnat0d580581995-07-20 02:43:20 -0500747
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500748/* This is for compression type. PNG 1.0-1.2 only define the single type. */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500749#define PNG_COMPRESSION_TYPE_BASE 0 /* Deflate method 8, 32K window */
750#define PNG_COMPRESSION_TYPE_DEFAULT PNG_COMPRESSION_TYPE_BASE
751
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500752/* This is for filter type. PNG 1.0-1.2 only define the single type. */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500753#define PNG_FILTER_TYPE_BASE 0 /* Single row per-byte filtering */
Glenn Randers-Pehrson2ad31ae2000-12-15 08:54:42 -0600754#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500755#define PNG_FILTER_TYPE_DEFAULT PNG_FILTER_TYPE_BASE
756
757/* These are for the interlacing type. These values should NOT be changed. */
758#define PNG_INTERLACE_NONE 0 /* Non-interlaced image */
759#define PNG_INTERLACE_ADAM7 1 /* Adam7 interlacing */
760#define PNG_INTERLACE_LAST 2 /* Not a valid value */
761
762/* These are for the oFFs chunk. These values should NOT be changed. */
763#define PNG_OFFSET_PIXEL 0 /* Offset in pixels */
764#define PNG_OFFSET_MICROMETER 1 /* Offset in micrometers (1/10^6 meter) */
765#define PNG_OFFSET_LAST 2 /* Not a valid value */
766
767/* These are for the pCAL chunk. These values should NOT be changed. */
768#define PNG_EQUATION_LINEAR 0 /* Linear transformation */
769#define PNG_EQUATION_BASE_E 1 /* Exponential base e transform */
770#define PNG_EQUATION_ARBITRARY 2 /* Arbitrary base exponential transform */
771#define PNG_EQUATION_HYPERBOLIC 3 /* Hyperbolic sine transformation */
772#define PNG_EQUATION_LAST 4 /* Not a valid value */
773
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600774/* These are for the sCAL chunk. These values should NOT be changed. */
775#define PNG_SCALE_UNKNOWN 0 /* unknown unit (image scale) */
776#define PNG_SCALE_METER 1 /* meters per pixel */
777#define PNG_SCALE_RADIAN 2 /* radians per pixel */
778#define PNG_SCALE_LAST 3 /* Not a valid value */
779
Andreas Dilger47a0c421997-05-16 02:46:07 -0500780/* These are for the pHYs chunk. These values should NOT be changed. */
781#define PNG_RESOLUTION_UNKNOWN 0 /* pixels/unknown unit (aspect ratio) */
782#define PNG_RESOLUTION_METER 1 /* pixels/meter */
783#define PNG_RESOLUTION_LAST 2 /* Not a valid value */
784
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600785/* These are for the sRGB chunk. These values should NOT be changed. */
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600786#define PNG_sRGB_INTENT_PERCEPTUAL 0
787#define PNG_sRGB_INTENT_RELATIVE 1
788#define PNG_sRGB_INTENT_SATURATION 2
789#define PNG_sRGB_INTENT_ABSOLUTE 3
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600790#define PNG_sRGB_INTENT_LAST 4 /* Not a valid value */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600791
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600792/* This is for text chunks */
793#define PNG_KEYWORD_MAX_LENGTH 79
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600794
Glenn Randers-Pehrson76e5fd62000-12-28 07:50:05 -0600795/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
Glenn Randers-Pehrsond1e8c862002-06-20 06:54:34 -0500796#define PNG_MAX_PALETTE_LENGTH 256
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600797
Andreas Dilger47a0c421997-05-16 02:46:07 -0500798/* These determine if an ancillary chunk's data has been successfully read
799 * from the PNG header, or if the application has filled in the corresponding
800 * data in the info_struct to be written into the output file. The values
801 * of the PNG_INFO_<chunk> defines should NOT be changed.
802 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500803#define PNG_INFO_gAMA 0x0001
804#define PNG_INFO_sBIT 0x0002
805#define PNG_INFO_cHRM 0x0004
806#define PNG_INFO_PLTE 0x0008
807#define PNG_INFO_tRNS 0x0010
808#define PNG_INFO_bKGD 0x0020
809#define PNG_INFO_hIST 0x0040
810#define PNG_INFO_pHYs 0x0080
811#define PNG_INFO_oFFs 0x0100
812#define PNG_INFO_tIME 0x0200
Andreas Dilger47a0c421997-05-16 02:46:07 -0500813#define PNG_INFO_pCAL 0x0400
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600814#define PNG_INFO_sRGB 0x0800 /* GR-P, 0.96a */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600815#define PNG_INFO_iCCP 0x1000 /* ESR, 1.0.6 */
816#define PNG_INFO_sPLT 0x2000 /* ESR, 1.0.6 */
817#define PNG_INFO_sCAL 0x4000 /* ESR, 1.0.6 */
John Bowlerf3f7e142011-09-09 07:32:37 -0500818#define PNG_INFO_IDAT 0x8000 /* ESR, 1.0.6 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500819
Andreas Dilger47a0c421997-05-16 02:46:07 -0500820/* This is used for the transformation routines, as some of them
821 * change these values for the row. It also should enable using
822 * the routines for other purposes.
823 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500824typedef struct png_row_info_struct
825{
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -0600826 png_uint_32 width; /* width of row */
827 png_size_t rowbytes; /* number of bytes in row */
828 png_byte color_type; /* color type of row */
829 png_byte bit_depth; /* bit depth of row */
830 png_byte channels; /* number of channels (1, 2, 3, or 4) */
Guy Schalnat4ee97b01996-01-16 01:51:56 -0600831 png_byte pixel_depth; /* bits per pixel (depth * channels) */
Guy Schalnat0d580581995-07-20 02:43:20 -0500832} png_row_info;
833
Andreas Dilger47a0c421997-05-16 02:46:07 -0500834typedef png_row_info FAR * png_row_infop;
835typedef png_row_info FAR * FAR * png_row_infopp;
Guy Schalnat0f716451995-11-28 11:22:13 -0600836
Glenn Randers-Pehrson1384c042011-04-28 23:22:18 -0500837/* The complete definition of png_struct has, as of libpng-1.5.0,
838 * been moved into a separate header file that is not accessible to
839 * applications. Read libpng-manual.txt or libpng.3 for more info.
840 */
841typedef struct png_struct_def png_struct;
842typedef PNG_CONST png_struct FAR * png_const_structp;
843typedef png_struct FAR * png_structp;
844
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500845/* These are the function types for the I/O functions and for the functions
846 * that allow the user to override the default I/O functions with his or her
847 * own. The png_error_ptr type should match that of user-supplied warning
848 * and error functions, while the png_rw_ptr type should match that of the
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500849 * user read/write data functions. Note that the 'write' function must not
Glenn Randers-Pehrsonea2f7e02010-08-18 08:14:54 -0500850 * modify the buffer it is passed. The 'read' function, on the other hand, is
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500851 * expected to return the read data in the buffer.
Guy Schalnat0f716451995-11-28 11:22:13 -0600852 */
John Bowler9c693602011-02-12 08:58:21 -0600853typedef PNG_CALLBACK(void, *png_error_ptr, (png_structp, png_const_charp));
854typedef PNG_CALLBACK(void, *png_rw_ptr, (png_structp, png_bytep, png_size_t));
855typedef PNG_CALLBACK(void, *png_flush_ptr, (png_structp));
856typedef PNG_CALLBACK(void, *png_read_status_ptr, (png_structp, png_uint_32,
857 int));
858typedef PNG_CALLBACK(void, *png_write_status_ptr, (png_structp, png_uint_32,
859 int));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600860
Guy Schalnat69b14481996-01-10 02:56:49 -0600861#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
John Bowler9c693602011-02-12 08:58:21 -0600862typedef PNG_CALLBACK(void, *png_progressive_info_ptr, (png_structp, png_infop));
863typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop));
John Bowler9616ad92011-02-16 06:13:46 -0600864
865/* The following callback receives png_uint_32 row_number, int pass for the
866 * png_bytep data of the row. When transforming an interlaced image the
867 * row number is the row number within the sub-image of the interlace pass, so
868 * the value will increase to the height of the sub-image (not the full image)
869 * then reset to 0 for the next pass.
870 *
871 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
872 * find the output pixel (x,y) given an interlaced sub-image pixel
873 * (row,col,pass). (See below for these macros.)
874 */
John Bowler9c693602011-02-12 08:58:21 -0600875typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600876 png_uint_32, int));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600877#endif
Guy Schalnat6d764711995-12-19 03:22:19 -0600878
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600879#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -0500880 defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
John Bowler9c693602011-02-12 08:58:21 -0600881typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600882 png_bytep));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600883#endif
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600884
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500885#ifdef PNG_USER_CHUNKS_SUPPORTED
John Bowler9c693602011-02-12 08:58:21 -0600886typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600887 png_unknown_chunkp));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600888#endif
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500889#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
John Bowler9c693602011-02-12 08:58:21 -0600890typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600891#endif
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -0600892
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600893#ifdef PNG_SETJMP_SUPPORTED
John Bowlerb302c472011-04-15 06:37:34 -0500894/* This must match the function definition in <setjmp.h>, and the application
895 * must include this before png.h to obtain the definition of jmp_buf. The
896 * function is required to be PNG_NORETURN, but this is not checked. If the
897 * function does return the application will crash via an abort() or similar
898 * system level call.
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500899 *
John Bowlerb302c472011-04-15 06:37:34 -0500900 * If you get a warning here while building the library you may need to make
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500901 * changes to ensure that pnglibconf.h records the calling convention used by
902 * your compiler. This may be very difficult - try using a different compiler
903 * to build the library!
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600904 */
John Bowlerb302c472011-04-15 06:37:34 -0500905PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)), typedef);
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600906#endif
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600907
908/* Transform masks for the high-level interface */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600909#define PNG_TRANSFORM_IDENTITY 0x0000 /* read and write */
910#define PNG_TRANSFORM_STRIP_16 0x0001 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600911#define PNG_TRANSFORM_STRIP_ALPHA 0x0002 /* read only */
912#define PNG_TRANSFORM_PACKING 0x0004 /* read and write */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600913#define PNG_TRANSFORM_PACKSWAP 0x0008 /* read and write */
914#define PNG_TRANSFORM_EXPAND 0x0010 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600915#define PNG_TRANSFORM_INVERT_MONO 0x0020 /* read and write */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600916#define PNG_TRANSFORM_SHIFT 0x0040 /* read and write */
917#define PNG_TRANSFORM_BGR 0x0080 /* read and write */
918#define PNG_TRANSFORM_SWAP_ALPHA 0x0100 /* read and write */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600919#define PNG_TRANSFORM_SWAP_ENDIAN 0x0200 /* read and write */
Glenn Randers-Pehrsondb66d442000-06-23 21:38:16 -0500920#define PNG_TRANSFORM_INVERT_ALPHA 0x0400 /* read and write */
Glenn Randers-Pehrson99708d52009-06-29 17:30:00 -0500921#define PNG_TRANSFORM_STRIP_FILLER 0x0800 /* write only */
Glenn Randers-Pehrson1eb14e92008-12-10 07:14:45 -0600922/* Added to libpng-1.2.34 */
Glenn Randers-Pehrson0ffb71a2009-02-28 06:08:20 -0600923#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
Glenn Randers-Pehrson99708d52009-06-29 17:30:00 -0500924#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
925/* Added to libpng-1.4.0 */
926#define PNG_TRANSFORM_GRAY_TO_RGB 0x2000 /* read only */
Glenn Randers-Pehrsonef217b72011-06-15 12:58:27 -0500927/* Added to libpng-1.5.4 */
John Bowlera9b34192011-05-08 19:46:51 -0500928#define PNG_TRANSFORM_EXPAND_16 0x4000 /* read only */
Glenn Randers-Pehrsonab63dd02011-06-17 20:04:17 -0500929#define PNG_TRANSFORM_SCALE_16 0x8000 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600930
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600931/* Flags for MNG supported features */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600932#define PNG_FLAG_MNG_EMPTY_PLTE 0x01
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600933#define PNG_FLAG_MNG_FILTER_64 0x04
Glenn Randers-Pehrson408b4212000-12-18 09:33:57 -0600934#define PNG_ALL_MNG_FEATURES 0x05
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600935
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600936/* NOTE: prior to 1.5 these functions had no 'API' style declaration,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600937 * this allowed the zlib default functions to be used on Windows
938 * platforms. In 1.5 the zlib default malloc (which just calls malloc and
939 * ignores the first argument) should be completely compatible with the
940 * following.
941 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600942typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,
John Bowler9c693602011-02-12 08:58:21 -0600943 png_alloc_size_t));
944typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp));
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500945
Andreas Dilger47a0c421997-05-16 02:46:07 -0500946typedef png_struct FAR * FAR * png_structpp;
Guy Schalnat6d764711995-12-19 03:22:19 -0600947
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500948/* Section 3: exported functions
949 * Here are the function definitions most commonly used. This is not
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500950 * the place to find out how to use libpng. See libpng-manual.txt for the
Andreas Dilger47a0c421997-05-16 02:46:07 -0500951 * full explanation, see example.c for the summary. This just provides
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600952 * a simple one line description of the use of each function.
Glenn Randers-Pehrsona4517252010-12-06 08:54:55 -0600953 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600954 * The PNG_EXPORT() and PNG_EXPORTA() macros used below are defined in
955 * pngconf.h and in the *.dfn files in the scripts directory.
Glenn Randers-Pehrsona4517252010-12-06 08:54:55 -0600956 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600957 * PNG_EXPORT(ordinal, type, name, (args));
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600958 *
959 * ordinal: ordinal that is used while building
960 * *.def files. The ordinal value is only
961 * relevant when preprocessing png.h with
962 * the *.dfn files for building symbol table
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600963 * entries, and are removed by pngconf.h.
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600964 * type: return type of the function
965 * name: function name
966 * args: function arguments, with types
967 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600968 * When we wish to append attributes to a function prototype we use
969 * the PNG_EXPORTA() macro instead.
970 *
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600971 * PNG_EXPORTA(ordinal, type, name, (args), attributes);
972 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600973 * ordinal, type, name, and args: same as in PNG_EXPORT().
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600974 * attributes: function attributes
Andreas Dilger47a0c421997-05-16 02:46:07 -0500975 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500976
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500977/* Returns the version number of the library */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600978PNG_EXPORT(1, png_uint_32, png_access_version_number, (void));
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500979
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600980/* Tell lib we have already handled the first <num_bytes> magic bytes.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500981 * Handling more than 8 bytes from the beginning of the file is an error.
982 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600983PNG_EXPORT(2, void, png_set_sig_bytes, (png_structp png_ptr, int num_bytes));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600984
Andreas Dilger47a0c421997-05-16 02:46:07 -0500985/* Check sig[start] through sig[start + num_to_check - 1] to see if it's a
986 * PNG file. Returns zero if the supplied bytes match the 8-byte PNG
987 * signature, and non-zero otherwise. Having num_to_check == 0 or
988 * start > 7 will always fail (ie return non-zero).
989 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600990PNG_EXPORT(3, int, png_sig_cmp, (png_const_bytep sig, png_size_t start,
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600991 png_size_t num_to_check));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600992
Glenn Randers-Pehrson3e42a992010-03-31 22:16:07 -0500993/* Simple signature checking function. This is the same as calling
994 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
995 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600996#define png_check_sig(sig, n) !png_sig_cmp((sig), 0, (n))
Glenn Randers-Pehrson3e42a992010-03-31 22:16:07 -0500997
Andreas Dilger47a0c421997-05-16 02:46:07 -0500998/* Allocate and initialize png_ptr struct for reading, and any other memory. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600999PNG_EXPORTA(4, png_structp, png_create_read_struct,
1000 (png_const_charp user_png_ver, png_voidp error_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001001 png_error_ptr error_fn, png_error_ptr warn_fn),
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001002 PNG_ALLOCATED);
Guy Schalnat0d580581995-07-20 02:43:20 -05001003
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001004/* Allocate and initialize png_ptr struct for writing, and any other memory */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001005PNG_EXPORTA(5, png_structp, png_create_write_struct,
1006 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001007 png_error_ptr warn_fn),
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001008 PNG_ALLOCATED);
Guy Schalnate5a37791996-06-05 15:50:50 -05001009
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001010PNG_EXPORT(6, png_size_t, png_get_compression_buffer_size,
John Bowler0a5c9c02011-01-22 17:36:34 -06001011 (png_const_structp png_ptr));
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -05001012
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001013PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structp png_ptr,
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001014 png_size_t size));
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -05001015
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001016/* Moved from pngconf.h in 1.4.0 and modified to ensure setjmp/longjmp
1017 * match up.
1018 */
1019#ifdef PNG_SETJMP_SUPPORTED
1020/* This function returns the jmp_buf built in to *png_ptr. It must be
1021 * supplied with an appropriate 'longjmp' function to use on that jmp_buf
1022 * unless the default error function is overridden in which case NULL is
1023 * acceptable. The size of the jmp_buf is checked against the actual size
1024 * allocated by the library - the call will return NULL on a mismatch
1025 * indicating an ABI mismatch.
1026 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001027PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structp png_ptr,
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001028 png_longjmp_ptr longjmp_fn, size_t jmp_buf_size));
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001029# define png_jmpbuf(png_ptr) \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06001030 (*png_set_longjmp_fn((png_ptr), longjmp, sizeof (jmp_buf)))
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001031#else
1032# define png_jmpbuf(png_ptr) \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06001033 (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001034#endif
Glenn Randers-Pehrsonf98726a2010-02-19 09:54:53 -06001035/* This function should be used by libpng applications in place of
1036 * longjmp(png_ptr->jmpbuf, val). If longjmp_fn() has been set, it
1037 * will use it; otherwise it will call PNG_ABORT(). This function was
1038 * added in libpng-1.5.0.
1039 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001040PNG_EXPORTA(9, void, png_longjmp, (png_structp png_ptr, int val),
1041 PNG_NORETURN);
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001042
Glenn Randers-Pehrson2b8bef12010-04-29 11:50:24 -05001043#ifdef PNG_READ_SUPPORTED
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -05001044/* Reset the compression stream */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001045PNG_EXPORT(10, int, png_reset_zstream, (png_structp png_ptr));
Glenn Randers-Pehrson2b8bef12010-04-29 11:50:24 -05001046#endif
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -05001047
Glenn Randers-Pehrson8b6a8892001-05-18 04:54:50 -05001048/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001049#ifdef PNG_USER_MEM_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001050PNG_EXPORTA(11, png_structp, png_create_read_struct_2,
1051 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001052 png_error_ptr warn_fn,
1053 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001054 PNG_ALLOCATED);
1055PNG_EXPORTA(12, png_structp, png_create_write_struct_2,
1056 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001057 png_error_ptr warn_fn,
1058 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001059 PNG_ALLOCATED);
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001060#endif
1061
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001062/* Write the PNG file signature. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001063PNG_EXPORT(13, void, png_write_sig, (png_structp png_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001064
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001065/* Write a PNG chunk - size, type, (optional) data, CRC. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001066PNG_EXPORT(14, void, png_write_chunk, (png_structp png_ptr, png_const_bytep
1067 chunk_name, png_const_bytep data, png_size_t length));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001068
1069/* Write the start of a PNG chunk - length and chunk name. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001070PNG_EXPORT(15, void, png_write_chunk_start, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001071 png_const_bytep chunk_name, png_uint_32 length));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001072
1073/* Write the data of a PNG chunk started with png_write_chunk_start(). */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001074PNG_EXPORT(16, void, png_write_chunk_data, (png_structp png_ptr,
1075 png_const_bytep data, png_size_t length));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001076
1077/* Finish a chunk started with png_write_chunk_start() (includes CRC). */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001078PNG_EXPORT(17, void, png_write_chunk_end, (png_structp png_ptr));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001079
Andreas Dilger47a0c421997-05-16 02:46:07 -05001080/* Allocate and initialize the info structure */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001081PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_structp png_ptr),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001082 PNG_ALLOCATED);
Guy Schalnat0d580581995-07-20 02:43:20 -05001083
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001084PNG_EXPORT(19, void, png_info_init_3, (png_infopp info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001085 png_size_t png_info_struct_size));
Guy Schalnat0d580581995-07-20 02:43:20 -05001086
Andreas Dilger47a0c421997-05-16 02:46:07 -05001087/* Writes all the PNG information before the image. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001088PNG_EXPORT(20, void, png_write_info_before_PLTE,
1089 (png_structp png_ptr, png_infop info_ptr));
1090PNG_EXPORT(21, void, png_write_info,
1091 (png_structp png_ptr, png_infop info_ptr));
Guy Schalnat0d580581995-07-20 02:43:20 -05001092
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001093#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001094/* Read the information before the actual image data. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001095PNG_EXPORT(22, void, png_read_info,
1096 (png_structp png_ptr, png_infop info_ptr));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001097#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001098
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001099#ifdef PNG_TIME_RFC1123_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001100PNG_EXPORT(23, png_const_charp, png_convert_to_rfc1123,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001101 (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001102 png_const_timep ptime));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001103#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001104
Glenn Randers-Pehrson0cb46e22009-11-02 11:24:33 -06001105#ifdef PNG_CONVERT_tIME_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001106/* Convert from a struct tm to png_time */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001107PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001108 PNG_CONST struct tm FAR * ttime));
Guy Schalnat0d580581995-07-20 02:43:20 -05001109
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001110/* Convert from time_t to png_time. Uses gmtime() */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001111PNG_EXPORT(25, void, png_convert_from_time_t,
1112 (png_timep ptime, time_t ttime));
Glenn Randers-Pehrson0cb46e22009-11-02 11:24:33 -06001113#endif /* PNG_CONVERT_tIME_SUPPORTED */
Guy Schalnat0d580581995-07-20 02:43:20 -05001114
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001115#ifdef PNG_READ_EXPAND_SUPPORTED
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001116/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001117PNG_EXPORT(26, void, png_set_expand, (png_structp png_ptr));
1118PNG_EXPORT(27, void, png_set_expand_gray_1_2_4_to_8, (png_structp png_ptr));
1119PNG_EXPORT(28, void, png_set_palette_to_rgb, (png_structp png_ptr));
1120PNG_EXPORT(29, void, png_set_tRNS_to_alpha, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001121#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001122
John Bowler4d562962011-02-12 09:01:20 -06001123#ifdef PNG_READ_EXPAND_16_SUPPORTED
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001124/* Expand to 16-bit channels, forces conversion of palette to RGB and expansion
John Bowler4d562962011-02-12 09:01:20 -06001125 * of a tRNS chunk if present.
1126 */
1127PNG_EXPORT(221, void, png_set_expand_16, (png_structp png_ptr));
1128#endif
1129
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001130#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
Guy Schalnat0d580581995-07-20 02:43:20 -05001131/* Use blue, green, red order for pixels. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001132PNG_EXPORT(30, void, png_set_bgr, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001133#endif
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001134
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001135#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001136/* Expand the grayscale to 24-bit RGB if necessary. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001137PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structp png_ptr));
John Bowlerf21a0d02011-01-23 23:55:19 -06001138#endif
Guy Schalnat69b14481996-01-10 02:56:49 -06001139
John Bowlerf21a0d02011-01-23 23:55:19 -06001140#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001141/* Reduce RGB to grayscale. */
John Bowler7875d532011-11-07 22:33:49 -06001142#define PNG_ERROR_ACTION_NONE 1
1143#define PNG_ERROR_ACTION_WARN 2
1144#define PNG_ERROR_ACTION_ERROR 3
1145#define PNG_RGB_TO_GRAY_DEFAULT (-1)/*for red/green coefficients*/
1146
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001147PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structp png_ptr,
1148 int error_action, double red, double green));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001149PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001150 int error_action, png_fixed_point red, png_fixed_point green));
Glenn Randers-Pehrsona272d8f2010-06-25 21:45:31 -05001151
John Bowler0a5c9c02011-01-22 17:36:34 -06001152PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structp
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001153 png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001154#endif
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001155
John Bowler4a12f4a2011-04-17 18:34:22 -05001156#ifdef PNG_BUILD_GRAYSCALE_PALETTE_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001157PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001158 png_colorp palette));
John Bowler4a12f4a2011-04-17 18:34:22 -05001159#endif
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001160
John Bowlerd273ad22011-05-07 21:00:28 -05001161#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
1162/* How the alpha channel is interpreted - this affects how the color channels of
Glenn Randers-Pehrson44e26d42011-05-08 22:56:42 -05001163 * a PNG file are returned when an alpha channel, or tRNS chunk in a palette
1164 * file, is present.
John Bowlerd273ad22011-05-07 21:00:28 -05001165 *
Glenn Randers-Pehrson44e26d42011-05-08 22:56:42 -05001166 * This has no effect on the way pixels are written into a PNG output
1167 * datastream. The color samples in a PNG datastream are never premultiplied
1168 * with the alpha samples.
1169 *
1170 * The default is to return data according to the PNG specification: the alpha
John Bowlerd273ad22011-05-07 21:00:28 -05001171 * channel is a linear measure of the contribution of the pixel to the
Glenn Randers-Pehrson44e26d42011-05-08 22:56:42 -05001172 * corresponding composited pixel. The gamma encoded color channels must be
1173 * scaled according to the contribution and to do this it is necessary to undo
1174 * the encoding, scale the color values, perform the composition and reencode
1175 * the values. This is the 'PNG' mode.
John Bowlerd273ad22011-05-07 21:00:28 -05001176 *
1177 * The alternative is to 'associate' the alpha with the color information by
1178 * storing color channel values that have been scaled by the alpha. The
1179 * advantage is that the color channels can be resampled (the image can be
1180 * scaled) in this form. The disadvantage is that normal practice is to store
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001181 * linear, not (gamma) encoded, values and this requires 16-bit channels for
1182 * still images rather than the 8-bit channels that are just about sufficient if
John Bowlerd273ad22011-05-07 21:00:28 -05001183 * gamma encoding is used. In addition all non-transparent pixel values,
1184 * including completely opaque ones, must be gamma encoded to produce the final
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001185 * image. This is the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' mode (the
John Bowlerd273ad22011-05-07 21:00:28 -05001186 * latter being the two common names for associated alpha color channels.)
1187 *
1188 * Since it is not necessary to perform arithmetic on opaque color values so
1189 * long as they are not to be resampled and are in the final color space it is
1190 * possible to optimize the handling of alpha by storing the opaque pixels in
1191 * the PNG format (adjusted for the output color space) while storing partially
1192 * opaque pixels in the standard, linear, format. The accuracy required for
1193 * standard alpha composition is relatively low, because the pixels are
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001194 * isolated, therefore typically the accuracy loss in storing 8-bit linear
John Bowlerd273ad22011-05-07 21:00:28 -05001195 * values is acceptable. (This is not true if the alpha channel is used to
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001196 * simulate transparency over large areas - use 16 bits or the PNG mode in
1197 * this case!) This is the 'OPTIMIZED' mode. For this mode a pixel is
John Bowlerd273ad22011-05-07 21:00:28 -05001198 * treated as opaque only if the alpha value is equal to the maximum value.
1199 *
1200 * The final choice is to gamma encode the alpha channel as well. This is
1201 * broken because, in practice, no implementation that uses this choice
1202 * correctly undoes the encoding before handling alpha composition. Use this
1203 * choice only if other serious errors in the software or hardware you use
1204 * mandate it; the typical serious error is for dark halos to appear around
1205 * opaque areas of the composited PNG image because of arithmetic overflow.
1206 *
1207 * The API function png_set_alpha_mode specifies which of these choices to use
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001208 * with an enumerated 'mode' value and the gamma of the required output:
John Bowlerd273ad22011-05-07 21:00:28 -05001209 */
1210#define PNG_ALPHA_PNG 0 /* according to the PNG standard */
1211#define PNG_ALPHA_STANDARD 1 /* according to Porter/Duff */
1212#define PNG_ALPHA_ASSOCIATED 1 /* as above; this is the normal practice */
1213#define PNG_ALPHA_PREMULTIPLIED 1 /* as above */
1214#define PNG_ALPHA_OPTIMIZED 2 /* 'PNG' for opaque pixels, else 'STANDARD' */
1215#define PNG_ALPHA_BROKEN 3 /* the alpha channel is gamma encoded */
1216
1217PNG_FP_EXPORT(227, void, png_set_alpha_mode, (png_structp png_ptr, int mode,
1218 double output_gamma));
1219PNG_FIXED_EXPORT(228, void, png_set_alpha_mode_fixed, (png_structp png_ptr,
1220 int mode, png_fixed_point output_gamma));
John Bowlerf70c7d02011-05-10 22:54:37 -05001221#endif
John Bowlerd273ad22011-05-07 21:00:28 -05001222
John Bowlerf70c7d02011-05-10 22:54:37 -05001223#if defined(PNG_READ_GAMMA_SUPPORTED) || defined(PNG_READ_ALPHA_MODE_SUPPORTED)
John Bowlerd273ad22011-05-07 21:00:28 -05001224/* The output_gamma value is a screen gamma in libpng terminology: it expresses
1225 * how to decode the output values, not how they are encoded. The values used
1226 * correspond to the normal numbers used to describe the overall gamma of a
1227 * computer display system; for example 2.2 for an sRGB conformant system. The
1228 * values are scaled by 100000 in the _fixed version of the API (so 220000 for
1229 * sRGB.)
1230 *
1231 * The inverse of the value is always used to provide a default for the PNG file
1232 * encoding if it has no gAMA chunk and if png_set_gamma() has not been called
1233 * to override the PNG gamma information.
1234 *
1235 * When the ALPHA_OPTIMIZED mode is selected the output gamma is used to encode
1236 * opaque pixels however pixels with lower alpha values are not encoded,
1237 * regardless of the output gamma setting.
1238 *
1239 * When the standard Porter Duff handling is requested with mode 1 the output
1240 * encoding is set to be linear and the output_gamma value is only relevant
1241 * as a default for input data that has no gamma information. The linear output
1242 * encoding will be overridden if png_set_gamma() is called - the results may be
1243 * highly unexpected!
1244 *
1245 * The following numbers are derived from the sRGB standard and the research
1246 * behind it. sRGB is defined to be approximated by a PNG gAMA chunk value of
1247 * 0.45455 (1/2.2) for PNG. The value implicitly includes any viewing
1248 * correction required to take account of any differences in the color
1249 * environment of the original scene and the intended display environment; the
1250 * value expresses how to *decode* the image for display, not how the original
1251 * data was *encoded*.
1252 *
1253 * sRGB provides a peg for the PNG standard by defining a viewing environment.
1254 * sRGB itself, and earlier TV standards, actually use a more complex transform
1255 * (a linear portion then a gamma 2.4 power law) than PNG can express. (PNG is
1256 * limited to simple power laws.) By saying that an image for direct display on
1257 * an sRGB conformant system should be stored with a gAMA chunk value of 45455
1258 * (11.3.3.2 and 11.3.3.5 of the ISO PNG specification) the PNG specification
1259 * makes it possible to derive values for other display systems and
1260 * environments.
1261 *
1262 * The Mac value is deduced from the sRGB based on an assumption that the actual
1263 * extra viewing correction used in early Mac display systems was implemented as
1264 * a power 1.45 lookup table.
1265 *
1266 * Any system where a programmable lookup table is used or where the behavior of
1267 * the final display device characteristics can be changed requires system
1268 * specific code to obtain the current characteristic. However this can be
1269 * difficult and most PNG gamma correction only requires an approximate value.
1270 *
1271 * By default, if png_set_alpha_mode() is not called, libpng assumes that all
1272 * values are unencoded, linear, values and that the output device also has a
1273 * linear characteristic. This is only very rarely correct - it is invariably
1274 * better to call png_set_alpha_mode() with PNG_DEFAULT_sRGB than rely on the
1275 * default if you don't know what the right answer is!
1276 *
John Bowlerf70c7d02011-05-10 22:54:37 -05001277 * The special value PNG_GAMMA_MAC_18 indicates an older Mac system (pre Mac OS
1278 * 10.6) which used a correction table to implement a somewhat lower gamma on an
1279 * otherwise sRGB system.
1280 *
1281 * Both these values are reserved (not simple gamma values) in order to allow
1282 * more precise correction internally in the future.
1283 *
John Bowlerd273ad22011-05-07 21:00:28 -05001284 * NOTE: the following values can be passed to either the fixed or floating
1285 * point APIs, but the floating point API will also accept floating point
1286 * values.
1287 */
John Bowlerf70c7d02011-05-10 22:54:37 -05001288#define PNG_DEFAULT_sRGB -1 /* sRGB gamma and color space */
1289#define PNG_GAMMA_MAC_18 -2 /* Old Mac '1.8' gamma and color space */
Glenn Randers-Pehrsonc7822512011-05-07 21:23:43 -05001290#define PNG_GAMMA_sRGB 220000 /* Television standards--matches sRGB gamma */
John Bowlerd273ad22011-05-07 21:00:28 -05001291#define PNG_GAMMA_LINEAR PNG_FP_1 /* Linear */
John Bowlerf70c7d02011-05-10 22:54:37 -05001292#endif
John Bowlerd273ad22011-05-07 21:00:28 -05001293
1294/* The following are examples of calls to png_set_alpha_mode to achieve the
1295 * required overall gamma correction and, where necessary, alpha
1296 * premultiplication.
1297 *
1298 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1299 * This is the default libpng handling of the alpha channel - it is not
1300 * pre-multiplied into the color components. In addition the call states
1301 * that the output is for a sRGB system and causes all PNG files without gAMA
1302 * chunks to be assumed to be encoded using sRGB.
1303 *
1304 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1305 * In this case the output is assumed to be something like an sRGB conformant
1306 * display preceeded by a power-law lookup table of power 1.45. This is how
1307 * early Mac systems behaved.
1308 *
Glenn Randers-Pehrsonc7822512011-05-07 21:23:43 -05001309 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);
John Bowlerd273ad22011-05-07 21:00:28 -05001310 * This is the classic Jim Blinn approach and will work in academic
1311 * environments where everything is done by the book. It has the shortcoming
1312 * of assuming that input PNG data with no gamma information is linear - this
1313 * is unlikely to be correct unless the PNG files where generated locally.
1314 * Most of the time the output precision will be so low as to show
1315 * significant banding in dark areas of the image.
1316 *
1317 * png_set_expand_16(pp);
1318 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB);
1319 * This is a somewhat more realistic Jim Blinn inspired approach. PNG files
1320 * are assumed to have the sRGB encoding if not marked with a gamma value and
1321 * the output is always 16 bits per component. This permits accurate scaling
1322 * and processing of the data. If you know that your input PNG files were
1323 * generated locally you might need to replace PNG_DEFAULT_sRGB with the
1324 * correct value for your system.
1325 *
1326 * png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB);
1327 * If you just need to composite the PNG image onto an existing background
1328 * and if you control the code that does this you can use the optimization
1329 * setting. In this case you just copy completely opaque pixels to the
1330 * output. For pixels that are not completely transparent (you just skip
1331 * those) you do the composition math using png_composite or png_composite_16
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001332 * below then encode the resultant 8-bit or 16-bit values to match the output
John Bowlerd273ad22011-05-07 21:00:28 -05001333 * encoding.
1334 *
1335 * Other cases
1336 * If neither the PNG nor the standard linear encoding work for you because
1337 * of the software or hardware you use then you have a big problem. The PNG
1338 * case will probably result in halos around the image. The linear encoding
1339 * will probably result in a washed out, too bright, image (it's actually too
1340 * contrasty.) Try the ALPHA_OPTIMIZED mode above - this will probably
1341 * substantially reduce the halos. Alternatively try:
1342 *
1343 * png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB);
1344 * This option will also reduce the halos, but there will be slight dark
1345 * halos round the opaque parts of the image where the background is light.
1346 * In the OPTIMIZED mode the halos will be light halos where the background
1347 * is dark. Take your pick - the halos are unavoidable unless you can get
1348 * your hardware/software fixed! (The OPTIMIZED approach is slightly
1349 * faster.)
1350 *
1351 * When the default gamma of PNG files doesn't match the output gamma.
1352 * If you have PNG files with no gamma information png_set_alpha_mode allows
1353 * you to provide a default gamma, but it also sets the ouput gamma to the
1354 * matching value. If you know your PNG files have a gamma that doesn't
1355 * match the output you can take advantage of the fact that
1356 * png_set_alpha_mode always sets the output gamma but only sets the PNG
1357 * default if it is not already set:
1358 *
1359 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1360 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1361 * The first call sets both the default and the output gamma values, the
1362 * second call overrides the output gamma without changing the default. This
1363 * is easier than achieving the same effect with png_set_gamma. You must use
1364 * PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will
1365 * fire if more than one call to png_set_alpha_mode and png_set_background is
1366 * made in the same read operation, however multiple calls with PNG_ALPHA_PNG
1367 * are ignored.
1368 */
John Bowlerd273ad22011-05-07 21:00:28 -05001369
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001370#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001371PNG_EXPORT(36, void, png_set_strip_alpha, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001372#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001373
1374#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
1375 defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001376PNG_EXPORT(37, void, png_set_swap_alpha, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001377#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001378
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -06001379#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
1380 defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001381PNG_EXPORT(38, void, png_set_invert_alpha, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001382#endif
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -06001383
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001384#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -05001385/* Add a filler byte to 8-bit Gray or 24-bit RGB images. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001386PNG_EXPORT(39, void, png_set_filler, (png_structp png_ptr, png_uint_32 filler,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001387 int flags));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001388/* The values of the PNG_FILLER_ defines should NOT be changed */
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06001389# define PNG_FILLER_BEFORE 0
1390# define PNG_FILLER_AFTER 1
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -05001391/* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001392PNG_EXPORT(40, void, png_set_add_alpha,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001393 (png_structp png_ptr, png_uint_32 filler,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001394 int flags));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001395#endif /* PNG_READ_FILLER_SUPPORTED || PNG_WRITE_FILLER_SUPPORTED */
Guy Schalnat0d580581995-07-20 02:43:20 -05001396
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001397#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001398/* Swap bytes in 16-bit depth files. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001399PNG_EXPORT(41, void, png_set_swap, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001400#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001401
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001402#if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED)
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001403/* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001404PNG_EXPORT(42, void, png_set_packing, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001405#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001406
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06001407#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
1408 defined(PNG_WRITE_PACKSWAP_SUPPORTED)
Andreas Dilger47a0c421997-05-16 02:46:07 -05001409/* Swap packing order of pixels in bytes. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001410PNG_EXPORT(43, void, png_set_packswap, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001411#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001412
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001413#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
Guy Schalnat0d580581995-07-20 02:43:20 -05001414/* Converts files to legal bit depths. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001415PNG_EXPORT(44, void, png_set_shift, (png_structp png_ptr, png_const_color_8p
1416 true_bits));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001417#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001418
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001419#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
1420 defined(PNG_WRITE_INTERLACING_SUPPORTED)
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001421/* Have the code handle the interlacing. Returns the number of passes.
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001422 * MUST be called before png_read_update_info or png_start_read_image,
1423 * otherwise it will not have the desired effect. Note that it is still
1424 * necessary to call png_read_row or png_read_rows png_get_image_height
1425 * times for each pass.
1426*/
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001427PNG_EXPORT(45, int, png_set_interlace_handling, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001428#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001429
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001430#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -05001431/* Invert monochrome files */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001432PNG_EXPORT(46, void, png_set_invert_mono, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001433#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001434
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001435#ifdef PNG_READ_BACKGROUND_SUPPORTED
John Bowlercb0b2962011-05-12 21:48:29 -05001436/* Handle alpha and tRNS by replacing with a background color. Prior to
Glenn Randers-Pehrsonef217b72011-06-15 12:58:27 -05001437 * libpng-1.5.4 this API must not be called before the PNG file header has been
John Bowlercb0b2962011-05-12 21:48:29 -05001438 * read. Doing so will result in unexpected behavior and possible warnings or
Glenn Randers-Pehrson1591a4c2011-05-16 09:07:26 -05001439 * errors if the PNG file contains a bKGD chunk.
John Bowlercb0b2962011-05-12 21:48:29 -05001440 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001441PNG_FP_EXPORT(47, void, png_set_background, (png_structp png_ptr,
1442 png_const_color_16p background_color, int background_gamma_code,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001443 int need_expand, double background_gamma));
John Bowler660c6e42010-12-19 06:22:23 -06001444PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001445 png_const_color_16p background_color, int background_gamma_code,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001446 int need_expand, png_fixed_point background_gamma));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001447#endif
1448#ifdef PNG_READ_BACKGROUND_SUPPORTED
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06001449# define PNG_BACKGROUND_GAMMA_UNKNOWN 0
1450# define PNG_BACKGROUND_GAMMA_SCREEN 1
1451# define PNG_BACKGROUND_GAMMA_FILE 2
1452# define PNG_BACKGROUND_GAMMA_UNIQUE 3
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001453#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001454
John Bowler8d261262011-06-18 13:37:11 -05001455#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
Glenn Randers-Pehrson413138a2011-06-13 22:07:37 -05001456/* Scale a 16-bit depth file down to 8-bit, accurately. */
Glenn Randers-Pehrson6da2f2d2011-06-17 23:07:16 -05001457PNG_EXPORT(229, void, png_set_scale_16, (png_structp png_ptr));
John Bowler8d261262011-06-18 13:37:11 -05001458#endif
Glenn Randers-Pehrsonab63dd02011-06-17 20:04:17 -05001459
John Bowler8d261262011-06-18 13:37:11 -05001460#ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED
1461#define PNG_READ_16_TO_8 SUPPORTED /* Name prior to 1.5.4 */
Glenn Randers-Pehrson413138a2011-06-13 22:07:37 -05001462/* Strip the second byte of information from a 16-bit depth file. */
Glenn Randers-Pehrson6da2f2d2011-06-17 23:07:16 -05001463PNG_EXPORT(48, void, png_set_strip_16, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001464#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001465
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -05001466#ifdef PNG_READ_QUANTIZE_SUPPORTED
1467/* Turn on quantizing, and reduce the palette to the number of colors
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06001468 * available.
1469 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001470PNG_EXPORT(49, void, png_set_quantize,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001471 (png_structp png_ptr, png_colorp palette,
1472 int num_palette, int maximum_colors, png_const_uint_16p histogram,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001473 int full_quantize));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001474#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001475
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001476#ifdef PNG_READ_GAMMA_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001477/* The threshold on gamma processing is configurable but hard-wired into the
1478 * library. The following is the floating point variant.
1479 */
1480#define PNG_GAMMA_THRESHOLD (PNG_GAMMA_THRESHOLD_FIXED*.00001)
1481
John Bowlerd273ad22011-05-07 21:00:28 -05001482/* Handle gamma correction. Screen_gamma=(display_exponent).
Glenn Randers-Pehrsonc7822512011-05-07 21:23:43 -05001483 * NOTE: this API simply sets the screen and file gamma values. It will
John Bowlerd273ad22011-05-07 21:00:28 -05001484 * therefore override the value for gamma in a PNG file if it is called after
John Bowlerf70c7d02011-05-10 22:54:37 -05001485 * the file header has been read - use with care - call before reading the PNG
1486 * file for best results!
1487 *
1488 * These routines accept the same gamma values as png_set_alpha_mode (described
1489 * above). The PNG_GAMMA_ defines and PNG_DEFAULT_sRGB can be passed to either
1490 * API (floating point or fixed.) Notice, however, that the 'file_gamma' value
1491 * is the inverse of a 'screen gamma' value.
John Bowlerd273ad22011-05-07 21:00:28 -05001492 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001493PNG_FP_EXPORT(50, void, png_set_gamma,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001494 (png_structp png_ptr, double screen_gamma,
John Bowlerd273ad22011-05-07 21:00:28 -05001495 double override_file_gamma));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001496PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structp png_ptr,
John Bowlerd273ad22011-05-07 21:00:28 -05001497 png_fixed_point screen_gamma, png_fixed_point override_file_gamma));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001498#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001499
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001500#ifdef PNG_WRITE_FLUSH_SUPPORTED
Guy Schalnat0f716451995-11-28 11:22:13 -06001501/* Set how many lines between output flushes - 0 for no flushing */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001502PNG_EXPORT(51, void, png_set_flush, (png_structp png_ptr, int nrows));
Guy Schalnat0f716451995-11-28 11:22:13 -06001503/* Flush the current PNG output buffer */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001504PNG_EXPORT(52, void, png_write_flush, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001505#endif
Guy Schalnat0f716451995-11-28 11:22:13 -06001506
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001507/* Optional update palette with requested transformations */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001508PNG_EXPORT(53, void, png_start_read_image, (png_structp png_ptr));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001509
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001510/* Optional call to update the users info structure */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001511PNG_EXPORT(54, void, png_read_update_info,
1512 (png_structp png_ptr, png_infop info_ptr));
Guy Schalnat0d580581995-07-20 02:43:20 -05001513
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001514#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001515/* Read one or more rows of image data. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001516PNG_EXPORT(55, void, png_read_rows, (png_structp png_ptr, png_bytepp row,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001517 png_bytepp display_row, png_uint_32 num_rows));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001518#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001519
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001520#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001521/* Read a row of data. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001522PNG_EXPORT(56, void, png_read_row, (png_structp png_ptr, png_bytep row,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001523 png_bytep display_row));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001524#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001525
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001526#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001527/* Read the whole image into memory at once. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001528PNG_EXPORT(57, void, png_read_image, (png_structp png_ptr, png_bytepp image));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001529#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001530
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001531/* Write a row of image data */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001532PNG_EXPORT(58, void, png_write_row,
1533 (png_structp png_ptr, png_const_bytep row));
Guy Schalnat0d580581995-07-20 02:43:20 -05001534
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001535/* Write a few rows of image data: (*row) is not written; however, the type
1536 * is declared as writeable to maintain compatibility with previous versions
1537 * of libpng and to allow the 'display_row' array from read_rows to be passed
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -05001538 * unchanged to write_rows.
1539 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001540PNG_EXPORT(59, void, png_write_rows, (png_structp png_ptr, png_bytepp row,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001541 png_uint_32 num_rows));
Guy Schalnat0d580581995-07-20 02:43:20 -05001542
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001543/* Write the image data */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001544PNG_EXPORT(60, void, png_write_image,
1545 (png_structp png_ptr, png_bytepp image));
Guy Schalnat0d580581995-07-20 02:43:20 -05001546
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001547/* Write the end of the PNG file. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001548PNG_EXPORT(61, void, png_write_end,
1549 (png_structp png_ptr, png_infop info_ptr));
Guy Schalnat0d580581995-07-20 02:43:20 -05001550
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001551#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001552/* Read the end of the PNG file. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001553PNG_EXPORT(62, void, png_read_end, (png_structp png_ptr, png_infop info_ptr));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001554#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001555
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001556/* Free any memory associated with the png_info_struct */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001557PNG_EXPORT(63, void, png_destroy_info_struct, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001558 png_infopp info_ptr_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001559
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001560/* Free any memory associated with the png_struct and the png_info_structs */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001561PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001562 png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001563
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001564/* Free any memory associated with the png_struct and the png_info_structs */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001565PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001566 png_infopp info_ptr_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001567
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001568/* Set the libpng method of handling chunk CRC errors */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001569PNG_EXPORT(66, void, png_set_crc_action,
1570 (png_structp png_ptr, int crit_action, int ancil_action));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001571
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001572/* Values for png_set_crc_action() say how to handle CRC errors in
Andreas Dilger47a0c421997-05-16 02:46:07 -05001573 * ancillary and critical chunks, and whether to use the data contained
1574 * therein. Note that it is impossible to "discard" data in a critical
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001575 * chunk. For versions prior to 0.90, the action was always error/quit,
Andreas Dilger47a0c421997-05-16 02:46:07 -05001576 * whereas in version 0.90 and later, the action for CRC errors in ancillary
1577 * chunks is warn/discard. These values should NOT be changed.
1578 *
1579 * value action:critical action:ancillary
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001580 */
1581#define PNG_CRC_DEFAULT 0 /* error/quit warn/discard data */
1582#define PNG_CRC_ERROR_QUIT 1 /* error/quit error/quit */
1583#define PNG_CRC_WARN_DISCARD 2 /* (INVALID) warn/discard data */
1584#define PNG_CRC_WARN_USE 3 /* warn/use data warn/use data */
1585#define PNG_CRC_QUIET_USE 4 /* quiet/use data quiet/use data */
1586#define PNG_CRC_NO_CHANGE 5 /* use current value use current value */
1587
Andreas Dilger47a0c421997-05-16 02:46:07 -05001588/* These functions give the user control over the scan-line filtering in
1589 * libpng and the compression methods used by zlib. These functions are
1590 * mainly useful for testing, as the defaults should work with most users.
1591 * Those users who are tight on memory or want faster performance at the
1592 * expense of compression can modify them. See the compression library
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001593 * header file (zlib.h) for an explination of the compression functions.
1594 */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001595
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001596/* Set the filtering method(s) used by libpng. Currently, the only valid
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001597 * value for "method" is 0.
1598 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001599PNG_EXPORT(67, void, png_set_filter,
1600 (png_structp png_ptr, int method, int filters));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001601
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001602/* Flags for png_set_filter() to say which filters to use. The flags
Andreas Dilger47a0c421997-05-16 02:46:07 -05001603 * are chosen so that they don't conflict with real filter types
1604 * below, in case they are supplied instead of the #defined constants.
1605 * These values should NOT be changed.
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001606 */
1607#define PNG_NO_FILTERS 0x00
1608#define PNG_FILTER_NONE 0x08
1609#define PNG_FILTER_SUB 0x10
1610#define PNG_FILTER_UP 0x20
1611#define PNG_FILTER_AVG 0x40
1612#define PNG_FILTER_PAETH 0x80
1613#define PNG_ALL_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP | \
1614 PNG_FILTER_AVG | PNG_FILTER_PAETH)
1615
Andreas Dilger47a0c421997-05-16 02:46:07 -05001616/* Filter values (not flags) - used in pngwrite.c, pngwutil.c for now.
1617 * These defines should NOT be changed.
1618 */
1619#define PNG_FILTER_VALUE_NONE 0
1620#define PNG_FILTER_VALUE_SUB 1
1621#define PNG_FILTER_VALUE_UP 2
1622#define PNG_FILTER_VALUE_AVG 3
1623#define PNG_FILTER_VALUE_PAETH 4
1624#define PNG_FILTER_VALUE_LAST 5
1625
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001626#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */
Andreas Dilger47a0c421997-05-16 02:46:07 -05001627/* The "heuristic_method" is given by one of the PNG_FILTER_HEURISTIC_
1628 * defines, either the default (minimum-sum-of-absolute-differences), or
1629 * the experimental method (weighted-minimum-sum-of-absolute-differences).
1630 *
1631 * Weights are factors >= 1.0, indicating how important it is to keep the
1632 * filter type consistent between rows. Larger numbers mean the current
1633 * filter is that many times as likely to be the same as the "num_weights"
1634 * previous filters. This is cumulative for each previous row with a weight.
1635 * There needs to be "num_weights" values in "filter_weights", or it can be
1636 * NULL if the weights aren't being specified. Weights have no influence on
1637 * the selection of the first row filter. Well chosen weights can (in theory)
1638 * improve the compression for a given image.
1639 *
1640 * Costs are factors >= 1.0 indicating the relative decoding costs of a
1641 * filter type. Higher costs indicate more decoding expense, and are
1642 * therefore less likely to be selected over a filter with lower computational
1643 * costs. There needs to be a value in "filter_costs" for each valid filter
1644 * type (given by PNG_FILTER_VALUE_LAST), or it can be NULL if you aren't
1645 * setting the costs. Costs try to improve the speed of decompression without
1646 * unduly increasing the compressed image size.
1647 *
1648 * A negative weight or cost indicates the default value is to be used, and
1649 * values in the range [0.0, 1.0) indicate the value is to remain unchanged.
1650 * The default values for both weights and costs are currently 1.0, but may
1651 * change if good general weighting/cost heuristics can be found. If both
1652 * the weights and costs are set to 1.0, this degenerates the WEIGHTED method
1653 * to the UNWEIGHTED method, but with added encoding time/computation.
1654 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001655PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structp png_ptr,
1656 int heuristic_method, int num_weights, png_const_doublep filter_weights,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001657 png_const_doublep filter_costs));
1658PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001659 (png_structp png_ptr,
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -05001660 int heuristic_method, int num_weights, png_const_fixed_point_p
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001661 filter_weights, png_const_fixed_point_p filter_costs));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001662#endif /* PNG_WRITE_WEIGHTED_FILTER_SUPPORTED */
1663
1664/* Heuristic used for row filter selection. These defines should NOT be
1665 * changed.
1666 */
1667#define PNG_FILTER_HEURISTIC_DEFAULT 0 /* Currently "UNWEIGHTED" */
1668#define PNG_FILTER_HEURISTIC_UNWEIGHTED 1 /* Used by libpng < 0.95 */
1669#define PNG_FILTER_HEURISTIC_WEIGHTED 2 /* Experimental feature */
1670#define PNG_FILTER_HEURISTIC_LAST 3 /* Not a valid value */
1671
John Bowlerc5bef942011-05-05 17:35:39 -05001672#ifdef PNG_WRITE_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001673/* Set the library compression level. Currently, valid values range from
1674 * 0 - 9, corresponding directly to the zlib compression levels 0 - 9
1675 * (0 - no compression, 9 - "maximal" compression). Note that tests have
1676 * shown that zlib compression levels 3-6 usually perform as well as level 9
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001677 * for PNG images, and do considerably fewer caclulations. In the future,
Andreas Dilger47a0c421997-05-16 02:46:07 -05001678 * these values may not correspond directly to the zlib compression levels.
1679 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001680PNG_EXPORT(69, void, png_set_compression_level,
1681 (png_structp png_ptr, int level));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001682
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001683PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001684 int mem_level));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001685
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001686PNG_EXPORT(71, void, png_set_compression_strategy, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001687 int strategy));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001688
Glenn Randers-Pehrsonaf855e42011-05-07 10:52:49 -05001689/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1690 * smaller value of window_bits if it can do so safely.
1691 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001692PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001693 int window_bits));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001694
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001695PNG_EXPORT(73, void, png_set_compression_method, (png_structp png_ptr,
1696 int method));
John Bowlerc5bef942011-05-05 17:35:39 -05001697#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001698
John Bowlerb2bee332011-06-10 23:24:58 -05001699#ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001700/* Also set zlib parameters for compressing non-IDAT chunks */
1701PNG_EXPORT(222, void, png_set_text_compression_level,
1702 (png_structp png_ptr, int level));
1703
1704PNG_EXPORT(223, void, png_set_text_compression_mem_level, (png_structp png_ptr,
1705 int mem_level));
1706
1707PNG_EXPORT(224, void, png_set_text_compression_strategy, (png_structp png_ptr,
1708 int strategy));
1709
Glenn Randers-Pehrsonaf855e42011-05-07 10:52:49 -05001710/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1711 * smaller value of window_bits if it can do so safely.
1712 */
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001713PNG_EXPORT(225, void, png_set_text_compression_window_bits, (png_structp
1714 png_ptr, int window_bits));
1715
1716PNG_EXPORT(226, void, png_set_text_compression_method, (png_structp png_ptr,
1717 int method));
John Bowlerb2bee332011-06-10 23:24:58 -05001718#endif /* PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED */
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001719
Guy Schalnate5a37791996-06-05 15:50:50 -05001720/* These next functions are called for input/output, memory, and error
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001721 * handling. They are in the file pngrio.c, pngwio.c, and pngerror.c,
Andreas Dilger47a0c421997-05-16 02:46:07 -05001722 * and call standard C I/O routines such as fread(), fwrite(), and
1723 * fprintf(). These functions can be made to use other I/O routines
1724 * at run time for those applications that need to handle I/O in a
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -05001725 * different manner by calling png_set_???_fn(). See libpng-manual.txt for
Andreas Dilger47a0c421997-05-16 02:46:07 -05001726 * more information.
1727 */
Guy Schalnat0d580581995-07-20 02:43:20 -05001728
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001729#ifdef PNG_STDIO_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001730/* Initialize the input/output for the PNG file to the default functions. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001731PNG_EXPORT(74, void, png_init_io, (png_structp png_ptr, png_FILE_p fp));
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001732#endif
Guy Schalnat6d764711995-12-19 03:22:19 -06001733
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001734/* Replace the (error and abort), and warning functions with user
Andreas Dilger47a0c421997-05-16 02:46:07 -05001735 * supplied functions. If no messages are to be printed you must still
1736 * write and use replacement functions. The replacement error_fn should
1737 * still do a longjmp to the last setjmp location if you are using this
1738 * method of error handling. If error_fn or warning_fn is NULL, the
1739 * default function will be used.
1740 */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001741
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001742PNG_EXPORT(75, void, png_set_error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001743 (png_structp png_ptr, png_voidp error_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001744 png_error_ptr error_fn, png_error_ptr warning_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001745
Guy Schalnate5a37791996-06-05 15:50:50 -05001746/* Return the user pointer associated with the error functions */
John Bowler0a5c9c02011-01-22 17:36:34 -06001747PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structp png_ptr));
Guy Schalnat6d764711995-12-19 03:22:19 -06001748
1749/* Replace the default data output functions with a user supplied one(s).
Andreas Dilger47a0c421997-05-16 02:46:07 -05001750 * If buffered output is not used, then output_flush_fn can be set to NULL.
1751 * If PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile time
1752 * output_flush_fn will be ignored (and thus can be NULL).
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -05001753 * It is probably a mistake to use NULL for output_flush_fn if
1754 * write_data_fn is not also NULL unless you have built libpng with
1755 * PNG_WRITE_FLUSH_SUPPORTED undefined, because in this case libpng's
1756 * default flush function, which uses the standard *FILE structure, will
1757 * be used.
Andreas Dilger47a0c421997-05-16 02:46:07 -05001758 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001759PNG_EXPORT(77, void, png_set_write_fn, (png_structp png_ptr, png_voidp io_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001760 png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001761
1762/* Replace the default data input function with a user supplied one. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001763PNG_EXPORT(78, void, png_set_read_fn, (png_structp png_ptr, png_voidp io_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001764 png_rw_ptr read_data_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001765
1766/* Return the user pointer associated with the I/O functions */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001767PNG_EXPORT(79, png_voidp, png_get_io_ptr, (png_structp png_ptr));
Guy Schalnat6d764711995-12-19 03:22:19 -06001768
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001769PNG_EXPORT(80, void, png_set_read_status_fn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001770 png_read_status_ptr read_row_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001771
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001772PNG_EXPORT(81, void, png_set_write_status_fn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001773 png_write_status_ptr write_row_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001774
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001775#ifdef PNG_USER_MEM_SUPPORTED
1776/* Replace the default memory allocation functions with user supplied one(s). */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001777PNG_EXPORT(82, void, png_set_mem_fn, (png_structp png_ptr, png_voidp mem_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001778 png_malloc_ptr malloc_fn, png_free_ptr free_fn));
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001779/* Return the user pointer associated with the memory functions */
John Bowler0a5c9c02011-01-22 17:36:34 -06001780PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001781#endif
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001782
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -05001783#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001784PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001785 png_user_transform_ptr read_user_transform_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001786#endif
1787
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -05001788#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001789PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001790 png_user_transform_ptr write_user_transform_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001791#endif
1792
John Bowler0a5c9c02011-01-22 17:36:34 -06001793#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001794PNG_EXPORT(86, void, png_set_user_transform_info, (png_structp png_ptr,
1795 png_voidp user_transform_ptr, int user_transform_depth,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001796 int user_transform_channels));
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001797/* Return the user pointer associated with the user transform functions */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001798PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001799 (png_const_structp png_ptr));
1800#endif
1801
1802#ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED
1803/* Return information about the row currently being processed. Note that these
1804 * APIs do not fail but will return unexpected results if called outside a user
1805 * transform callback. Also note that when transforming an interlaced image the
John Bowler9616ad92011-02-16 06:13:46 -06001806 * row number is the row number within the sub-image of the interlace pass, so
1807 * the value will increase to the height of the sub-image (not the full image)
1808 * then reset to 0 for the next pass.
John Bowler5432c012011-02-12 08:59:17 -06001809 *
John Bowler9616ad92011-02-16 06:13:46 -06001810 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
1811 * find the output pixel (x,y) given an interlaced sub-image pixel
1812 * (row,col,pass). (See below for these macros.)
John Bowler0a5c9c02011-01-22 17:36:34 -06001813 */
1814PNG_EXPORT(217, png_uint_32, png_get_current_row_number, (png_const_structp));
1815PNG_EXPORT(218, png_byte, png_get_current_pass_number, (png_const_structp));
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001816#endif
1817
Glenn Randers-Pehrson19095602001-03-14 07:08:39 -06001818#ifdef PNG_USER_CHUNKS_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001819PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001820 png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn));
John Bowler0a5c9c02011-01-22 17:36:34 -06001821PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structp png_ptr));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001822#endif
1823
Guy Schalnat4ee97b01996-01-16 01:51:56 -06001824#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001825/* Sets the function callbacks for the push reader, and a pointer to a
1826 * user-defined structure available to the callback functions.
1827 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001828PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structp png_ptr,
1829 png_voidp progressive_ptr, png_progressive_info_ptr info_fn,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001830 png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001831
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001832/* Returns the user pointer associated with the push read functions */
John Bowler0a5c9c02011-01-22 17:36:34 -06001833PNG_EXPORT(91, png_voidp, png_get_progressive_ptr, (png_const_structp png_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001834
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001835/* Function to be called when data becomes available */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001836PNG_EXPORT(92, void, png_process_data,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001837 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001838 png_bytep buffer, png_size_t buffer_size));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001839
John Bowler0a5c9c02011-01-22 17:36:34 -06001840/* A function which may be called *only* within png_process_data to stop the
1841 * processing of any more data. The function returns the number of bytes
1842 * remaining, excluding any that libpng has cached internally. A subsequent
1843 * call to png_process_data must supply these bytes again. If the argument
1844 * 'save' is set to true the routine will first save all the pending data and
1845 * will always return 0.
1846 */
1847PNG_EXPORT(219, png_size_t, png_process_data_pause, (png_structp, int save));
1848
1849/* A function which may be called *only* outside (after) a call to
1850 * png_process_data. It returns the number of bytes of data to skip in the
1851 * input. Normally it will return 0, but if it returns a non-zero value the
1852 * application must skip than number of bytes of input data and pass the
1853 * following data to the next call to png_process_data.
1854 */
1855PNG_EXPORT(220, png_uint_32, png_process_data_skip, (png_structp));
1856
Glenn Randers-Pehrson4daae302011-10-06 21:37:47 -05001857#ifdef PNG_READ_INTERLACING_SUPPORTED
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001858/* Function that combines rows. 'new_row' is a flag that should come from
1859 * the callback and be non-NULL if anything needs to be done; the library
1860 * stores its own version of the new data internally and ignores the passed
1861 * in value.
Andreas Dilger47a0c421997-05-16 02:46:07 -05001862 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001863PNG_EXPORT(93, void, png_progressive_combine_row, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001864 png_bytep old_row, png_const_bytep new_row));
Glenn Randers-Pehrson4daae302011-10-06 21:37:47 -05001865#endif /* PNG_READ_INTERLACING_SUPPORTED */
Guy Schalnat4ee97b01996-01-16 01:51:56 -06001866#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */
Guy Schalnat6d764711995-12-19 03:22:19 -06001867
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001868PNG_EXPORTA(94, png_voidp, png_malloc,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001869 (png_structp png_ptr, png_alloc_size_t size),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001870 PNG_ALLOCATED);
Glenn Randers-Pehrson0ffb71a2009-02-28 06:08:20 -06001871/* Added at libpng version 1.4.0 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001872PNG_EXPORTA(95, png_voidp, png_calloc,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001873 (png_structp png_ptr, png_alloc_size_t size),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001874 PNG_ALLOCATED);
Guy Schalnat0d580581995-07-20 02:43:20 -05001875
Glenn Randers-Pehrson07748d12002-05-25 11:12:10 -05001876/* Added at libpng version 1.2.4 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001877PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001878 png_alloc_size_t size), PNG_ALLOCATED);
Glenn Randers-Pehrson07748d12002-05-25 11:12:10 -05001879
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05001880/* Frees a pointer allocated by png_malloc() */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001881PNG_EXPORT(97, void, png_free, (png_structp png_ptr, png_voidp ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001882
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001883/* Free data that was allocated internally */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001884PNG_EXPORT(98, void, png_free_data,
1885 (png_structp png_ptr, png_infop info_ptr, png_uint_32 free_me, int num));
1886
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001887/* Reassign responsibility for freeing existing data, whether allocated
1888 * by libpng or by the application */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001889PNG_EXPORT(99, void, png_data_freer,
1890 (png_structp png_ptr, png_infop info_ptr, int freer, png_uint_32 mask));
1891
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001892/* Assignments for png_data_freer */
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001893#define PNG_DESTROY_WILL_FREE_DATA 1
1894#define PNG_SET_WILL_FREE_DATA 1
1895#define PNG_USER_WILL_FREE_DATA 2
1896/* Flags for png_ptr->free_me and info_ptr->free_me */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001897#define PNG_FREE_HIST 0x0008
1898#define PNG_FREE_ICCP 0x0010
1899#define PNG_FREE_SPLT 0x0020
1900#define PNG_FREE_ROWS 0x0040
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001901#define PNG_FREE_PCAL 0x0080
1902#define PNG_FREE_SCAL 0x0100
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001903#define PNG_FREE_UNKN 0x0200
1904#define PNG_FREE_LIST 0x0400
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -05001905#define PNG_FREE_PLTE 0x1000
1906#define PNG_FREE_TRNS 0x2000
1907#define PNG_FREE_TEXT 0x4000
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001908#define PNG_FREE_ALL 0x7fff
Glenn Randers-Pehrsonec61c232000-05-16 06:17:36 -05001909#define PNG_FREE_MUL 0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001910
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001911#ifdef PNG_USER_MEM_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001912PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001913 png_alloc_size_t size), PNG_ALLOCATED);
1914PNG_EXPORT(101, void, png_free_default, (png_structp png_ptr, png_voidp ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001915#endif
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001916
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001917#ifdef PNG_ERROR_TEXT_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001918/* Fatal error in PNG image of libpng - can't continue */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001919PNG_EXPORTA(102, void, png_error,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001920 (png_structp png_ptr, png_const_charp error_message),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001921 PNG_NORETURN);
Guy Schalnat0d580581995-07-20 02:43:20 -05001922
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001923/* The same, but the chunk name is prepended to the error string. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001924PNG_EXPORTA(103, void, png_chunk_error, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001925 png_const_charp error_message), PNG_NORETURN);
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001926
Glenn Randers-Pehrsonfd107532009-11-10 05:59:22 -06001927#else
1928/* Fatal error in PNG image of libpng - can't continue */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001929PNG_EXPORTA(104, void, png_err, (png_structp png_ptr), PNG_NORETURN);
Glenn Randers-Pehrsonfd107532009-11-10 05:59:22 -06001930#endif
1931
John Bowler88b77cc2011-05-05 06:49:55 -05001932#ifdef PNG_WARNINGS_SUPPORTED
Guy Schalnat6d764711995-12-19 03:22:19 -06001933/* Non-fatal error in libpng. Can continue, but may have a problem. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001934PNG_EXPORT(105, void, png_warning, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001935 png_const_charp warning_message));
Guy Schalnat0d580581995-07-20 02:43:20 -05001936
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001937/* Non-fatal error in libpng, chunk name is prepended to message. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001938PNG_EXPORT(106, void, png_chunk_warning, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001939 png_const_charp warning_message));
John Bowler88b77cc2011-05-05 06:49:55 -05001940#endif
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001941
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001942#ifdef PNG_BENIGN_ERRORS_SUPPORTED
1943/* Benign error in libpng. Can continue, but may have a problem.
1944 * User can choose whether to handle as a fatal error or as a warning. */
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001945# undef png_benign_error
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001946PNG_EXPORT(107, void, png_benign_error, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001947 png_const_charp warning_message));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001948
1949/* Same, chunk name is prepended to message. */
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001950# undef png_chunk_benign_error
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001951PNG_EXPORT(108, void, png_chunk_benign_error, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001952 png_const_charp warning_message));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001953
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001954PNG_EXPORT(109, void, png_set_benign_errors,
1955 (png_structp png_ptr, int allowed));
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001956#else
1957# ifdef PNG_ALLOW_BENIGN_ERRORS
1958# define png_benign_error png_warning
1959# define png_chunk_benign_error png_chunk_warning
1960# else
1961# define png_benign_error png_error
1962# define png_chunk_benign_error png_chunk_error
1963# endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001964#endif
1965
Andreas Dilger47a0c421997-05-16 02:46:07 -05001966/* The png_set_<chunk> functions are for storing values in the png_info_struct.
1967 * Similarly, the png_get_<chunk> calls are used to read values from the
1968 * png_info_struct, either storing the parameters in the passed variables, or
1969 * setting pointers into the png_info_struct where the data is stored. The
1970 * png_get_<chunk> functions return a non-zero value if the data was available
1971 * in info_ptr, or return zero and do not change any of the parameters if the
1972 * data was not available.
1973 *
1974 * These functions should be used instead of directly accessing png_info
1975 * to avoid problems with future changes in the size and internal layout of
1976 * png_info_struct.
1977 */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001978/* Returns "flag" if chunk data is valid in info_ptr. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001979PNG_EXPORT(110, png_uint_32, png_get_valid,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001980 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001981 png_uint_32 flag));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001982
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001983/* Returns number of bytes needed to hold a transformed row. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001984PNG_EXPORT(111, png_size_t, png_get_rowbytes, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001985 png_const_infop info_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001986
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001987#ifdef PNG_INFO_IMAGE_SUPPORTED
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001988/* Returns row_pointers, which is an array of pointers to scanlines that was
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001989 * returned from png_read_png().
1990 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001991PNG_EXPORT(112, png_bytepp, png_get_rows,
John Bowler0a5c9c02011-01-22 17:36:34 -06001992 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001993/* Set row_pointers, which is an array of pointers to scanlines for use
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001994 * by png_write_png().
1995 */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001996PNG_EXPORT(113, void, png_set_rows, (png_structp png_ptr,
1997 png_infop info_ptr, png_bytepp row_pointers));
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001998#endif
1999
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002000/* Returns number of color channels in image. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002001PNG_EXPORT(114, png_byte, png_get_channels,
John Bowler0a5c9c02011-01-22 17:36:34 -06002002 (png_const_structp png_ptr, png_const_infop info_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002003
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002004#ifdef PNG_EASY_ACCESS_SUPPORTED
2005/* Returns image width in pixels. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002006PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002007 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002008
2009/* Returns image height in pixels. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002010PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002011 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002012
2013/* Returns image bit_depth. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002014PNG_EXPORT(117, png_byte, png_get_bit_depth,
John Bowler0a5c9c02011-01-22 17:36:34 -06002015 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002016
2017/* Returns image color_type. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002018PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002019 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002020
2021/* Returns image filter_type. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002022PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002023 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002024
2025/* Returns image interlace_type. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002026PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002027 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002028
2029/* Returns image compression_type. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002030PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002031 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002032
2033/* Returns image resolution in pixels per meter, from pHYs chunk data. */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002034PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter,
John Bowler0a5c9c02011-01-22 17:36:34 -06002035 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002036PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter,
John Bowler0a5c9c02011-01-22 17:36:34 -06002037 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002038PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter,
John Bowler0a5c9c02011-01-22 17:36:34 -06002039 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002040
2041/* Returns pixel aspect ratio, computed from pHYs chunk data. */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002042PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio,
John Bowler0a5c9c02011-01-22 17:36:34 -06002043 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002044PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed,
John Bowler0a5c9c02011-01-22 17:36:34 -06002045 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002046
2047/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002048PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels,
John Bowler0a5c9c02011-01-22 17:36:34 -06002049 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002050PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels,
John Bowler0a5c9c02011-01-22 17:36:34 -06002051 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002052PNG_EXPORT(128, png_int_32, png_get_x_offset_microns,
John Bowler0a5c9c02011-01-22 17:36:34 -06002053 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002054PNG_EXPORT(129, png_int_32, png_get_y_offset_microns,
John Bowler0a5c9c02011-01-22 17:36:34 -06002055 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002056
2057#endif /* PNG_EASY_ACCESS_SUPPORTED */
2058
Andreas Dilger47a0c421997-05-16 02:46:07 -05002059/* Returns pointer to signature string read from PNG header */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002060PNG_EXPORT(130, png_const_bytep, png_get_signature,
John Bowler0a5c9c02011-01-22 17:36:34 -06002061 (png_const_structp png_ptr, png_infop info_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002062
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002063#ifdef PNG_bKGD_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002064PNG_EXPORT(131, png_uint_32, png_get_bKGD,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002065 (png_const_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002066 png_color_16p *background));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002067#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002068
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002069#ifdef PNG_bKGD_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002070PNG_EXPORT(132, void, png_set_bKGD, (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002071 png_const_color_16p background));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002072#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002073
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002074#ifdef PNG_cHRM_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002075PNG_FP_EXPORT(133, png_uint_32, png_get_cHRM, (png_const_structp png_ptr,
2076 png_const_infop info_ptr, double *white_x, double *white_y, double *red_x,
2077 double *red_y, double *green_x, double *green_y, double *blue_x,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002078 double *blue_y));
John Bowler736f40f2011-08-25 16:19:44 -05002079PNG_FP_EXPORT(230, png_uint_32, png_get_cHRM_XYZ, (png_structp png_ptr,
2080 png_const_infop info_ptr, double *red_X, double *red_Y, double *red_Z,
2081 double *green_X, double *green_Y, double *green_Z, double *blue_X,
2082 double *blue_Y, double *blue_Z));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002083#ifdef PNG_FIXED_POINT_SUPPORTED /* Otherwise not implemented */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002084PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002085 (png_const_structp png_ptr,
2086 png_const_infop info_ptr, png_fixed_point *int_white_x,
2087 png_fixed_point *int_white_y, png_fixed_point *int_red_x,
2088 png_fixed_point *int_red_y, png_fixed_point *int_green_x,
2089 png_fixed_point *int_green_y, png_fixed_point *int_blue_x,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002090 png_fixed_point *int_blue_y));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002091#endif
John Bowler736f40f2011-08-25 16:19:44 -05002092PNG_FIXED_EXPORT(231, png_uint_32, png_get_cHRM_XYZ_fixed,
2093 (png_structp png_ptr, png_const_infop info_ptr,
2094 png_fixed_point *int_red_X, png_fixed_point *int_red_Y,
2095 png_fixed_point *int_red_Z, png_fixed_point *int_green_X,
2096 png_fixed_point *int_green_Y, png_fixed_point *int_green_Z,
2097 png_fixed_point *int_blue_X, png_fixed_point *int_blue_Y,
2098 png_fixed_point *int_blue_Z));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002099#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002100
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002101#ifdef PNG_cHRM_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002102PNG_FP_EXPORT(135, void, png_set_cHRM,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002103 (png_structp png_ptr, png_infop info_ptr,
2104 double white_x, double white_y, double red_x, double red_y, double green_x,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002105 double green_y, double blue_x, double blue_y));
John Bowler736f40f2011-08-25 16:19:44 -05002106PNG_FP_EXPORT(232, void, png_set_cHRM_XYZ, (png_structp png_ptr,
2107 png_infop info_ptr, double red_X, double red_Y, double red_Z,
2108 double green_X, double green_Y, double green_Z, double blue_X,
2109 double blue_Y, double blue_Z));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002110PNG_FIXED_EXPORT(136, void, png_set_cHRM_fixed, (png_structp png_ptr,
2111 png_infop info_ptr, png_fixed_point int_white_x,
2112 png_fixed_point int_white_y, png_fixed_point int_red_x,
2113 png_fixed_point int_red_y, png_fixed_point int_green_x,
2114 png_fixed_point int_green_y, png_fixed_point int_blue_x,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002115 png_fixed_point int_blue_y));
John Bowler736f40f2011-08-25 16:19:44 -05002116PNG_FIXED_EXPORT(233, void, png_set_cHRM_XYZ_fixed, (png_structp png_ptr,
2117 png_infop info_ptr, png_fixed_point int_red_X, png_fixed_point int_red_Y,
2118 png_fixed_point int_red_Z, png_fixed_point int_green_X,
2119 png_fixed_point int_green_Y, png_fixed_point int_green_Z,
2120 png_fixed_point int_blue_X, png_fixed_point int_blue_Y,
2121 png_fixed_point int_blue_Z));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002122#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002123
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002124#ifdef PNG_gAMA_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002125PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002126 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002127 double *file_gamma));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002128PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed,
John Bowler0a5c9c02011-01-22 17:36:34 -06002129 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002130 png_fixed_point *int_file_gamma));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002131#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002132
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002133#ifdef PNG_gAMA_SUPPORTED
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002134PNG_FP_EXPORT(139, void, png_set_gAMA, (png_structp png_ptr,
2135 png_infop info_ptr, double file_gamma));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002136PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002137 png_infop info_ptr, png_fixed_point int_file_gamma));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002138#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002139
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002140#ifdef PNG_hIST_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002141PNG_EXPORT(141, png_uint_32, png_get_hIST,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002142 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002143 png_uint_16p *hist));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002144#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002145
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002146#ifdef PNG_hIST_SUPPORTED
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002147PNG_EXPORT(142, void, png_set_hIST, (png_structp png_ptr,
2148 png_infop info_ptr, png_const_uint_16p hist));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002149#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002150
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002151PNG_EXPORT(143, png_uint_32, png_get_IHDR,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002152 (png_structp png_ptr, png_infop info_ptr,
2153 png_uint_32 *width, png_uint_32 *height, int *bit_depth, int *color_type,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002154 int *interlace_method, int *compression_method, int *filter_method));
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002155
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002156PNG_EXPORT(144, void, png_set_IHDR,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002157 (png_structp png_ptr, png_infop info_ptr,
2158 png_uint_32 width, png_uint_32 height, int bit_depth, int color_type,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002159 int interlace_method, int compression_method, int filter_method));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002160
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002161#ifdef PNG_oFFs_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002162PNG_EXPORT(145, png_uint_32, png_get_oFFs,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002163 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002164 png_int_32 *offset_x, png_int_32 *offset_y, int *unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002165#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002166
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002167#ifdef PNG_oFFs_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002168PNG_EXPORT(146, void, png_set_oFFs,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002169 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002170 png_int_32 offset_x, png_int_32 offset_y, int unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002171#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002172
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002173#ifdef PNG_pCAL_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002174PNG_EXPORT(147, png_uint_32, png_get_pCAL,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002175 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002176 png_charp *purpose, png_int_32 *X0, png_int_32 *X1, int *type,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002177 int *nparams,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002178 png_charp *units, png_charpp *params));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002179#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002180
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002181#ifdef PNG_pCAL_SUPPORTED
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002182PNG_EXPORT(148, void, png_set_pCAL, (png_structp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002183 png_infop info_ptr,
2184 png_const_charp purpose, png_int_32 X0, png_int_32 X1, int type,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002185 int nparams, png_const_charp units, png_charpp params));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002186#endif
2187
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002188#ifdef PNG_pHYs_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002189PNG_EXPORT(149, png_uint_32, png_get_pHYs,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002190 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002191 png_uint_32 *res_x, png_uint_32 *res_y, int *unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002192#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002193
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002194#ifdef PNG_pHYs_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002195PNG_EXPORT(150, void, png_set_pHYs,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002196 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002197 png_uint_32 res_x, png_uint_32 res_y, int unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002198#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002199
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002200PNG_EXPORT(151, png_uint_32, png_get_PLTE,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002201 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002202 png_colorp *palette, int *num_palette));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002203
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002204PNG_EXPORT(152, void, png_set_PLTE,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002205 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002206 png_const_colorp palette, int num_palette));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002207
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002208#ifdef PNG_sBIT_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002209PNG_EXPORT(153, png_uint_32, png_get_sBIT,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002210 (png_const_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002211 png_color_8p *sig_bit));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002212#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002213
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002214#ifdef PNG_sBIT_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002215PNG_EXPORT(154, void, png_set_sBIT,
2216 (png_structp png_ptr, png_infop info_ptr, png_const_color_8p sig_bit));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002217#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002218
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002219#ifdef PNG_sRGB_SUPPORTED
John Bowler0a5c9c02011-01-22 17:36:34 -06002220PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structp png_ptr,
Glenn Randers-Pehrson8d0bc0f2011-01-25 22:15:58 -06002221 png_const_infop info_ptr, int *file_srgb_intent));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002222#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06002223
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002224#ifdef PNG_sRGB_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002225PNG_EXPORT(156, void, png_set_sRGB,
Glenn Randers-Pehrson8d0bc0f2011-01-25 22:15:58 -06002226 (png_structp png_ptr, png_infop info_ptr, int srgb_intent));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002227PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_structp png_ptr,
Glenn Randers-Pehrson8d0bc0f2011-01-25 22:15:58 -06002228 png_infop info_ptr, int srgb_intent));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002229#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06002230
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002231#ifdef PNG_iCCP_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002232PNG_EXPORT(158, png_uint_32, png_get_iCCP,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002233 (png_const_structp png_ptr, png_const_infop info_ptr,
2234 png_charpp name, int *compression_type, png_bytepp profile,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002235 png_uint_32 *proflen));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002236#endif
2237
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002238#ifdef PNG_iCCP_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002239PNG_EXPORT(159, void, png_set_iCCP,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002240 (png_structp png_ptr, png_infop info_ptr,
2241 png_const_charp name, int compression_type, png_const_bytep profile,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002242 png_uint_32 proflen));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002243#endif
2244
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002245#ifdef PNG_sPLT_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002246PNG_EXPORT(160, png_uint_32, png_get_sPLT,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002247 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002248 png_sPLT_tpp entries));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002249#endif
2250
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002251#ifdef PNG_sPLT_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002252PNG_EXPORT(161, void, png_set_sPLT,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002253 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002254 png_const_sPLT_tp entries, int nentries));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002255#endif
2256
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002257#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002258/* png_get_text also returns the number of text chunks in *num_text */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002259PNG_EXPORT(162, png_uint_32, png_get_text,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002260 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002261 png_textp *text_ptr, int *num_text));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002262#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002263
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002264/* Note while png_set_text() will accept a structure whose text,
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002265 * language, and translated keywords are NULL pointers, the structure
2266 * returned by png_get_text will always contain regular
2267 * zero-terminated C strings. They might be empty strings but
2268 * they will never be NULL pointers.
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -05002269 */
2270
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002271#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002272PNG_EXPORT(163, void, png_set_text,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002273 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002274 png_const_textp text_ptr, int num_text));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002275#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002276
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002277#ifdef PNG_tIME_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002278PNG_EXPORT(164, png_uint_32, png_get_tIME,
John Bowler0a5c9c02011-01-22 17:36:34 -06002279 (png_const_structp png_ptr, png_infop info_ptr, png_timep *mod_time));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002280#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002281
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002282#ifdef PNG_tIME_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002283PNG_EXPORT(165, void, png_set_tIME,
2284 (png_structp png_ptr, png_infop info_ptr, png_const_timep mod_time));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002285#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002286
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002287#ifdef PNG_tRNS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002288PNG_EXPORT(166, png_uint_32, png_get_tRNS,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002289 (png_const_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002290 png_bytep *trans_alpha, int *num_trans, png_color_16p *trans_color));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002291#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002292
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002293#ifdef PNG_tRNS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002294PNG_EXPORT(167, void, png_set_tRNS,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002295 (png_structp png_ptr, png_infop info_ptr,
2296 png_const_bytep trans_alpha, int num_trans,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002297 png_const_color_16p trans_color));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002298#endif
2299
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002300#ifdef PNG_sCAL_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002301PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002302 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002303 int *unit, double *width, double *height));
Glenn Randers-Pehrson48dc6eb2010-07-31 07:09:58 -05002304#ifdef PNG_FLOATING_ARITHMETIC_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002305/* NOTE: this API is currently implemented using floating point arithmetic,
Glenn Randers-Pehrson48dc6eb2010-07-31 07:09:58 -05002306 * consequently it can only be used on systems with floating point support.
2307 * In any case the range of values supported by png_fixed_point is small and it
2308 * is highly recommended that png_get_sCAL_s be used instead.
2309 */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002310PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed,
John Bowler0a5c9c02011-01-22 17:36:34 -06002311 (png_structp png_ptr, png_const_infop info_ptr, int *unit,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002312 png_fixed_point *width,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002313 png_fixed_point *height));
Glenn Randers-Pehrson48dc6eb2010-07-31 07:09:58 -05002314#endif
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002315PNG_EXPORT(169, png_uint_32, png_get_sCAL_s,
John Bowler0a5c9c02011-01-22 17:36:34 -06002316 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002317 int *unit, png_charpp swidth, png_charpp sheight));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002318
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002319PNG_FP_EXPORT(170, void, png_set_sCAL,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002320 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002321 int unit, double width, double height));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002322PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_structp png_ptr,
2323 png_infop info_ptr, int unit, png_fixed_point width,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002324 png_fixed_point height));
2325PNG_EXPORT(171, void, png_set_sCAL_s,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002326 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002327 int unit, png_const_charp swidth, png_const_charp sheight));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002328#endif /* PNG_sCAL_SUPPORTED */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002329
Glenn Randers-Pehrson7824a702009-06-13 10:05:05 -05002330#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
2331/* Provide a list of chunks and how they are to be handled, if the built-in
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002332 handling or default unknown chunk handling is not desired. Any chunks not
2333 listed will be handled in the default manner. The IHDR and IEND chunks
Glenn Randers-Pehrsonbb5cb142011-09-22 12:41:58 -05002334 must not be listed. Because this turns off the default handling for chunks
2335 that would otherwise be recognized the behavior of libpng transformations may
2336 well become incorrect!
2337 keep = 0: PNG_HANDLE_CHUNK_AS_DEFAULT: follow default behavior
2338 = 1: PNG_HANDLE_CHUNK_NEVER: do not keep
2339 = 2: PNG_HANDLE_CHUNK_IF_SAFE: keep only if safe-to-copy
2340 = 3: PNG_HANDLE_CHUNK_ALWAYS: keep even if unsafe-to-copy
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002341*/
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002342PNG_EXPORT(172, void, png_set_keep_unknown_chunks,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002343 (png_structp png_ptr, int keep,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002344 png_const_bytep chunk_list, int num_chunks));
Glenn Randers-Pehrsonbb5cb142011-09-22 12:41:58 -05002345
2346/* The handling code is returned; the result is therefore true (non-zero) if
2347 * special handling is required, false for the default handling.
2348 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002349PNG_EXPORT(173, int, png_handle_as_unknown, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002350 png_const_bytep chunk_name));
Glenn Randers-Pehrson7824a702009-06-13 10:05:05 -05002351#endif
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002352#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002353PNG_EXPORT(174, void, png_set_unknown_chunks, (png_structp png_ptr,
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002354 png_infop info_ptr, png_const_unknown_chunkp unknowns,
2355 int num_unknowns));
2356PNG_EXPORT(175, void, png_set_unknown_chunk_location,
2357 (png_structp png_ptr, png_infop info_ptr, int chunk, int location));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002358PNG_EXPORT(176, int, png_get_unknown_chunks, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002359 png_const_infop info_ptr, png_unknown_chunkpp entries));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002360#endif
2361
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -05002362/* Png_free_data() will turn off the "valid" flag for anything it frees.
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002363 * If you need to turn it off for a chunk that your application has freed,
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002364 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
2365 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002366PNG_EXPORT(177, void, png_set_invalid,
2367 (png_structp png_ptr, png_infop info_ptr, int mask));
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -05002368
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002369#ifdef PNG_INFO_IMAGE_SUPPORTED
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -05002370/* The "params" pointer is currently not used and is for future expansion. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002371PNG_EXPORT(178, void, png_read_png, (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002372 int transforms, png_voidp params));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002373PNG_EXPORT(179, void, png_write_png, (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002374 int transforms, png_voidp params));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002375#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002376
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002377PNG_EXPORT(180, png_const_charp, png_get_copyright,
John Bowler0a5c9c02011-01-22 17:36:34 -06002378 (png_const_structp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002379PNG_EXPORT(181, png_const_charp, png_get_header_ver,
John Bowler0a5c9c02011-01-22 17:36:34 -06002380 (png_const_structp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002381PNG_EXPORT(182, png_const_charp, png_get_header_version,
John Bowler0a5c9c02011-01-22 17:36:34 -06002382 (png_const_structp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002383PNG_EXPORT(183, png_const_charp, png_get_libpng_ver,
John Bowler0a5c9c02011-01-22 17:36:34 -06002384 (png_const_structp png_ptr));
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -06002385
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -06002386#ifdef PNG_MNG_FEATURES_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002387PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002388 png_uint_32 mng_features_permitted));
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -06002389#endif
2390
Glenn Randers-Pehrson8f3dd832004-08-10 09:43:42 -05002391/* For use in png_set_keep_unknown, added to version 1.2.6 */
2392#define PNG_HANDLE_CHUNK_AS_DEFAULT 0
2393#define PNG_HANDLE_CHUNK_NEVER 1
2394#define PNG_HANDLE_CHUNK_IF_SAFE 2
2395#define PNG_HANDLE_CHUNK_ALWAYS 3
2396
Glenn Randers-Pehrsone68f5a32001-05-14 09:20:53 -05002397/* Strip the prepended error numbers ("#nnn ") from error and warning
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002398 * messages before passing them to the error or warning handler.
2399 */
Glenn Randers-Pehrsone68f5a32001-05-14 09:20:53 -05002400#ifdef PNG_ERROR_NUMBERS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002401PNG_EXPORT(185, void, png_set_strip_error_numbers,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002402 (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002403 png_uint_32 strip_mode));
Glenn Randers-Pehrsonbe9de0f2001-01-22 08:52:16 -06002404#endif
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05002405
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002406/* Added in libpng-1.2.6 */
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05002407#ifdef PNG_SET_USER_LIMITS_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002408PNG_EXPORT(186, void, png_set_user_limits, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002409 png_uint_32 user_width_max, png_uint_32 user_height_max));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002410PNG_EXPORT(187, png_uint_32, png_get_user_width_max,
John Bowler0a5c9c02011-01-22 17:36:34 -06002411 (png_const_structp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002412PNG_EXPORT(188, png_uint_32, png_get_user_height_max,
John Bowler0a5c9c02011-01-22 17:36:34 -06002413 (png_const_structp png_ptr));
Glenn Randers-Pehrson800d1e92008-08-20 17:25:21 -05002414/* Added in libpng-1.4.0 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002415PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002416 png_uint_32 user_chunk_cache_max));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002417PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max,
John Bowler0a5c9c02011-01-22 17:36:34 -06002418 (png_const_structp png_ptr));
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06002419/* Added in libpng-1.4.1 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002420PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002421 png_alloc_size_t user_chunk_cache_max));
2422PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max,
John Bowler0a5c9c02011-01-22 17:36:34 -06002423 (png_const_structp png_ptr));
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05002424#endif
2425
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002426#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002427PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch,
John Bowler0a5c9c02011-01-22 17:36:34 -06002428 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002429
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002430PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch,
John Bowler0a5c9c02011-01-22 17:36:34 -06002431 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002432
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002433PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch,
John Bowler0a5c9c02011-01-22 17:36:34 -06002434 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002435
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002436PNG_FP_EXPORT(196, float, png_get_x_offset_inches,
John Bowler0a5c9c02011-01-22 17:36:34 -06002437 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002438#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002439PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed,
John Bowler0a5c9c02011-01-22 17:36:34 -06002440 (png_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002441#endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002442
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002443PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002444 png_const_infop info_ptr));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002445#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002446PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed,
John Bowler0a5c9c02011-01-22 17:36:34 -06002447 (png_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002448#endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002449
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06002450# ifdef PNG_pHYs_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002451PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002452 png_const_infop info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002453 int *unit_type));
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06002454# endif /* PNG_pHYs_SUPPORTED */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002455#endif /* PNG_INCH_CONVERSIONS_SUPPORTED */
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002456
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002457/* Added in libpng-1.4.0 */
2458#ifdef PNG_IO_STATE_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002459PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_structp png_ptr));
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002460
Glenn Randers-Pehrsona63dbed2011-01-22 08:51:19 -06002461PNG_EXPORTA(200, png_const_bytep, png_get_io_chunk_name,
2462 (png_structp png_ptr), PNG_DEPRECATED);
Glenn Randers-Pehrsoncf7cce62011-01-22 12:42:43 -06002463PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type,
John Bowler0a5c9c02011-01-22 17:36:34 -06002464 (png_const_structp png_ptr));
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002465
2466/* The flags returned by png_get_io_state() are the following: */
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06002467# define PNG_IO_NONE 0x0000 /* no I/O at this moment */
2468# define PNG_IO_READING 0x0001 /* currently reading */
2469# define PNG_IO_WRITING 0x0002 /* currently writing */
2470# define PNG_IO_SIGNATURE 0x0010 /* currently at the file signature */
2471# define PNG_IO_CHUNK_HDR 0x0020 /* currently at the chunk header */
2472# define PNG_IO_CHUNK_DATA 0x0040 /* currently at the chunk data */
2473# define PNG_IO_CHUNK_CRC 0x0080 /* currently at the chunk crc */
2474# define PNG_IO_MASK_OP 0x000f /* current operation: reading/writing */
2475# define PNG_IO_MASK_LOC 0x00f0 /* current location: sig/hdr/data/crc */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002476#endif /* ?PNG_IO_STATE_SUPPORTED */
2477
John Bowler660c6e42010-12-19 06:22:23 -06002478/* Interlace support. The following macros are always defined so that if
2479 * libpng interlace handling is turned off the macros may be used to handle
2480 * interlaced images within the application.
2481 */
2482#define PNG_INTERLACE_ADAM7_PASSES 7
2483
2484/* Two macros to return the first row and first column of the original,
2485 * full, image which appears in a given pass. 'pass' is in the range 0
2486 * to 6 and the result is in the range 0 to 7.
2487 */
John Bowler4e68aa72011-10-11 16:01:33 -05002488#define PNG_PASS_START_ROW(pass) (((1&~(pass))<<(3-((pass)>>1)))&7)
2489#define PNG_PASS_START_COL(pass) (((1& (pass))<<(3-(((pass)+1)>>1)))&7)
2490
2491/* A macro to return the offset between pixels in the output row for a pair of
2492 * pixels in the input - effectively the inverse of the 'COL_SHIFT' macro that
2493 * follows. Note that ROW_OFFSET is the offset from one row to the next whereas
2494 * COL_OFFSET is from one column to the next, within a row.
2495 */
2496#define PNG_PASS_ROW_OFFSET(pass) ((pass)>2?(8>>(((pass)-1)>>1)):8)
2497#define PNG_PASS_COL_OFFSET(pass) (1<<((7-(pass))>>1))
John Bowler660c6e42010-12-19 06:22:23 -06002498
2499/* Two macros to help evaluate the number of rows or columns in each
2500 * pass. This is expressed as a shift - effectively log2 of the number or
2501 * rows or columns in each 8x8 tile of the original image.
2502 */
2503#define PNG_PASS_ROW_SHIFT(pass) ((pass)>2?(8-(pass))>>1:3)
2504#define PNG_PASS_COL_SHIFT(pass) ((pass)>1?(7-(pass))>>1:3)
2505
2506/* Hence two macros to determine the number of rows or columns in a given
2507 * pass of an image given its height or width. In fact these macros may
2508 * return non-zero even though the sub-image is empty, because the other
2509 * dimension may be empty for a small image.
2510 */
2511#define PNG_PASS_ROWS(height, pass) (((height)+(((1<<PNG_PASS_ROW_SHIFT(pass))\
2512 -1)-PNG_PASS_START_ROW(pass)))>>PNG_PASS_ROW_SHIFT(pass))
2513#define PNG_PASS_COLS(width, pass) (((width)+(((1<<PNG_PASS_COL_SHIFT(pass))\
2514 -1)-PNG_PASS_START_COL(pass)))>>PNG_PASS_COL_SHIFT(pass))
2515
John Bowler9616ad92011-02-16 06:13:46 -06002516/* For the reader row callbacks (both progressive and sequential) it is
2517 * necessary to find the row in the output image given a row in an interlaced
2518 * image, so two more macros:
John Bowler660c6e42010-12-19 06:22:23 -06002519 */
2520#define PNG_ROW_FROM_PASS_ROW(yIn, pass) \
2521 (((yIn)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass))
2522#define PNG_COL_FROM_PASS_COL(xIn, pass) \
2523 (((xIn)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass))
2524
2525/* Two macros which return a boolean (0 or 1) saying whether the given row
2526 * or column is in a particular pass. These use a common utility macro that
2527 * returns a mask for a given pass - the offset 'off' selects the row or
2528 * column version. The mask has the appropriate bit set for each column in
2529 * the tile.
2530 */
2531#define PNG_PASS_MASK(pass,off) ( \
John Bowler4e68aa72011-10-11 16:01:33 -05002532 ((0x110145AF>>(((7-(off))-(pass))<<2)) & 0xF) | \
2533 ((0x01145AF0>>(((7-(off))-(pass))<<2)) & 0xF0))
John Bowler660c6e42010-12-19 06:22:23 -06002534
2535#define PNG_ROW_IN_INTERLACE_PASS(y, pass) \
2536 ((PNG_PASS_MASK(pass,0) >> ((y)&7)) & 1)
2537#define PNG_COL_IN_INTERLACE_PASS(x, pass) \
2538 ((PNG_PASS_MASK(pass,1) >> ((x)&7)) & 1)
2539
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002540#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -05002541/* With these routines we avoid an integer divide, which will be slower on
2542 * most machines. However, it does take more operations than the corresponding
2543 * divide method, so it may be slower on a few RISC systems. There are two
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002544 * shifts (by 8 or 16 bits) and an addition, versus a single integer divide.
2545 *
2546 * Note that the rounding factors are NOT supposed to be the same! 128 and
2547 * 32768 are correct for the NODIV code; 127 and 32767 are correct for the
2548 * standard method.
2549 *
2550 * [Optimized code by Greg Roelofs and Mark Adler...blame us for bugs. :-) ]
2551 */
2552
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06002553 /* fg and bg should be in `gamma 1.0' space; alpha is the opacity */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002554
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06002555# define png_composite(composite, fg, alpha, bg) \
2556 { png_uint_16 temp = (png_uint_16)((png_uint_16)(fg) \
2557 * (png_uint_16)(alpha) \
2558 + (png_uint_16)(bg)*(png_uint_16)(255 \
John Bowler75156122011-09-09 17:21:44 -05002559 - (png_uint_16)(alpha)) + 128); \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002560 (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002561
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06002562# define png_composite_16(composite, fg, alpha, bg) \
2563 { png_uint_32 temp = (png_uint_32)((png_uint_32)(fg) \
2564 * (png_uint_32)(alpha) \
John Bowler75156122011-09-09 17:21:44 -05002565 + (png_uint_32)(bg)*(65535 \
2566 - (png_uint_32)(alpha)) + 32768); \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002567 (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }
2568
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002569#else /* Standard method using integer division */
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002570
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06002571# define png_composite(composite, fg, alpha, bg) \
2572 (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) + \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06002573 (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \
John Bowler75156122011-09-09 17:21:44 -05002574 127) / 255)
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002575
2576# define png_composite_16(composite, fg, alpha, bg) \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002577 (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \
John Bowler75156122011-09-09 17:21:44 -05002578 (png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) + \
2579 32767) / 65535)
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002580#endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */
2581
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002582#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002583PNG_EXPORT(201, png_uint_32, png_get_uint_32, (png_const_bytep buf));
2584PNG_EXPORT(202, png_uint_16, png_get_uint_16, (png_const_bytep buf));
2585PNG_EXPORT(203, png_int_32, png_get_int_32, (png_const_bytep buf));
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002586#endif
2587
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002588PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002589 png_const_bytep buf));
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002590/* No png_get_int_16 -- may be added if there's a real need for it. */
2591
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002592/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002593#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002594PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i));
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002595#endif
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05002596#ifdef PNG_SAVE_INT_32_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002597PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i));
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05002598#endif
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002599
2600/* Place a 16-bit number into a buffer in PNG byte order.
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002601 * The parameter is declared unsigned int, not png_uint_16,
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002602 * just to avoid potential problems on pre-ANSI C compilers.
2603 */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002604#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002605PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i));
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002606/* No png_save_int_16 -- may be added if there's a real need for it. */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002607#endif
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002608
John Bowlerf21a0d02011-01-23 23:55:19 -06002609#ifdef PNG_USE_READ_MACROS
2610/* Inline macros to do direct reads of bytes from the input buffer.
2611 * The png_get_int_32() routine assumes we are using two's complement
2612 * format for negative values, which is almost certainly true.
2613 */
2614# define png_get_uint_32(buf) \
2615 (((png_uint_32)(*(buf)) << 24) + \
2616 ((png_uint_32)(*((buf) + 1)) << 16) + \
2617 ((png_uint_32)(*((buf) + 2)) << 8) + \
2618 ((png_uint_32)(*((buf) + 3))))
2619
2620 /* From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
2621 * function) incorrectly returned a value of type png_uint_32.
2622 */
2623# define png_get_uint_16(buf) \
2624 ((png_uint_16) \
2625 (((unsigned int)(*(buf)) << 8) + \
2626 ((unsigned int)(*((buf) + 1)))))
2627
2628# define png_get_int_32(buf) \
2629 ((png_int_32)((*(buf) & 0x80) \
2630 ? -((png_int_32)((png_get_uint_32(buf) ^ 0xffffffffL) + 1)) \
2631 : (png_int_32)png_get_uint_32(buf)))
2632#endif
2633
John Bowler7875d532011-11-07 22:33:49 -06002634/*******************************************************************************
2635 * SIMPLIFIED API
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002636 *******************************************************************************
2637 *
John Bowler7875d532011-11-07 22:33:49 -06002638 * Please read the documentation in libpng-manual.txt if you don't understand
2639 * what follows.
2640 *
2641 * The simplified API hides the details of both libpng and the PNG file format
2642 * itself. It allows PNG files to be read into a very limited number of
2643 * in-memory bitmap formats or to be written from the same formats. If these
2644 * formats do not accomodate your needs then you can, and should, use the more
2645 * sophisticated APIs above - these support a wide variety of in-memory formats
2646 * and a wide variety of sophisticated transformations to those formats as well
2647 * as a wide variety of APIs to manipulate ancilliary information.
2648 *
2649 * To read a PNG file using the simplified API:
2650 *
2651 * 1) Declare a 'png_image' structure (see below) on the stack and memset() it
2652 * to all zero.
2653 * 2) Call the appropriate png_image_begin_read... function.
2654 * 3) Set the png_image 'format' member to the required format and allocate a
2655 * buffer for the image.
2656 * 4) Call png_image_finish_read to read the image into your buffer.
2657 *
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002658 * There are no restrictions on the format of the PNG input itself; all valid
2659 * color types, bit depths, and interlace methods are acceptable, and the
2660 * input image is transformed as necessary to the requested in-memory format
2661 * during the png_image_finish_read() step.
2662 *
John Bowler7875d532011-11-07 22:33:49 -06002663 * To write a PNG file using the simplified API:
2664 *
2665 * 1) Declare a 'png_image' structure on the stack and memset() it to all zero.
2666 * 2) Initialize the members of the structure that describe the image, setting
2667 * the 'format' member to the format of the image in memory.
2668 * 3) Call the appropriate png_image_write... function with a pointer to the
2669 * image to write the PNG data.
2670 *
Glenn Randers-Pehrsonefc4b692011-11-07 23:31:34 -06002671 * png_image is a structure that describes the in-memory format of an image
John Bowler7875d532011-11-07 22:33:49 -06002672 * when it is being read or define the in-memory format of an image that you
2673 * need to write:
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002674 *
John Bowler7875d532011-11-07 22:33:49 -06002675 */
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002676
John Bowler7875d532011-11-07 22:33:49 -06002677typedef struct png_control *png_controlp;
2678typedef struct
2679{
2680 png_uint_32 width; /* Image width in pixels (columns) */
2681 png_uint_32 height; /* Image height in pixels (rows) */
2682 png_uint_32 format; /* Image format as defined below */
2683 png_uint_32 flags; /* A bit mask containing informational flags */
2684 png_controlp opaque; /* Initialize to NULL, free with png_image_free */
2685
2686 /* In the event of an error or warning the following field will be set to a
2687 * non-zero value and the 'message' field will contain a '\0' terminated
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002688 * string with the libpng error or warning message. If both warnings and
2689 * an error were encountered, only the error is recorded. If there
2690 * are multiple warnings, only the first one is recorded.
2691 *
2692 * As of libpng-1.5.7 the values are
2693 * 0 - no warning or error
2694 * 1 - error
2695 * 2 - warning
John Bowler7875d532011-11-07 22:33:49 -06002696 */
2697 png_uint_32 warning_or_error;
2698 char message[64];
2699} png_image, *png_imagep;
2700
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002701/* The pixels (samples) of the image have one to four channels whose components
2702 * have original values in the range 0 to 1.0:
John Bowler7875d532011-11-07 22:33:49 -06002703 *
2704 * 1: A single gray or luminance channel (G).
2705 * 2: A gray/luminance channel and an alpha channel (GA).
2706 * 3: Three red, green, blue color channels (RGB).
2707 * 4: Three color channels and an alpha channel (RGBA).
2708 *
2709 * The channels are encoded in one of two ways:
2710 *
2711 * a) As a small integer, value 0..255, contained in a (png_byte). For the
John Bowlerdd819152011-11-08 14:29:45 -06002712 * alpha channel the original value is simply value/255. For the color or
John Bowler7875d532011-11-07 22:33:49 -06002713 * luminance channels the value is encoded according to the sRGB specification
2714 * and matches the 8-bit format expected by typical display devices.
2715 *
2716 * The color/gray channels are not scaled (pre-multiplied) by the alpha
2717 * channel and are suitable for passing to color management software.
2718 *
2719 * b) As a value in the range 0..65535, contained in a (png_uint_16). All
2720 * channels can be converted to the original value by dividing by 65535; all
2721 * channels are linear. Color channels use the RGB encoding (RGB end-points) of
2722 * the sRGB specification. This encoding is identified by the
2723 * PNG_FORMAT_FLAG_LINEAR flag below.
2724 *
2725 * When an alpha channel is present it is expected to denote pixel coverage
2726 * of the color or luminance channels and is returned as an associated alpha
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002727 * channel: the color/gray channels are scaled (pre-multiplied) by the alpha
2728 * value.
John Bowler7875d532011-11-07 22:33:49 -06002729 */
2730
2731/* PNG_FORMAT_*
2732 *
2733 * #defines to be used in png_image::format. Each #define identifies a
2734 * particular layout of channel data and, if present, alpha values. There are
2735 * separate defines for each of the two channel encodings.
2736 *
2737 * A format is built up using single bit flag values. Not all combinations are
2738 * valid: use the bit flag values below for testing a format returned by the
2739 * read APIs, but set formats from the derived values.
2740 *
2741 * NOTE: libpng can be built with particular features disabled, if you see
2742 * compiler errors because the definition of one of the following flags has been
2743 * compiled out it is because libpng does not have the required support. It is
2744 * possible, however, for the libpng configuration to enable the format on just
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002745 * read or just write; in that case you may see an error at run time. You can
2746 * guard against this by checking for the definition of:
John Bowler7875d532011-11-07 22:33:49 -06002747 *
2748 * PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED
2749 */
2750#define PNG_FORMAT_FLAG_ALPHA 0x01 /* format with an alpha channel */
2751#define PNG_FORMAT_FLAG_COLOR 0x02 /* color format: otherwise grayscale */
2752#define PNG_FORMAT_FLAG_LINEAR 0x04 /* png_uint_16 channels else png_byte */
2753
2754#ifdef PNG_FORMAT_BGR_SUPPORTED
2755# define PNG_FORMAT_FLAG_BGR 0x08 /* BGR colors, else order is RGB */
2756#endif
2757
2758#ifdef PNG_FORMAT_AFIRST_SUPPORTED
2759# define PNG_FORMAT_FLAG_AFIRST 0x10 /* alpha channel comes first */
2760#endif
2761
2762/* Supported formats are as follows. Future versions of libpng may support more
Glenn Randers-Pehrsonefc4b692011-11-07 23:31:34 -06002763 * formats; for compatibility with older versions simply check if the format
John Bowler7875d532011-11-07 22:33:49 -06002764 * macro is defined using #ifdef. These defines describe the in-memory layout
2765 * of the components of the pixels of the image.
2766 *
2767 * First the single byte formats:
2768 */
2769#define PNG_FORMAT_GRAY 0
2770#define PNG_FORMAT_GA PNG_FORMAT_FLAG_ALPHA
John Bowlerdd819152011-11-08 14:29:45 -06002771#define PNG_FORMAT_AG (PNG_FORMAT_GA|PNG_FORMAT_FLAG_AFIRST)
John Bowler7875d532011-11-07 22:33:49 -06002772#define PNG_FORMAT_RGB PNG_FORMAT_FLAG_COLOR
2773#define PNG_FORMAT_BGR (PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_BGR)
2774#define PNG_FORMAT_RGBA (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_ALPHA)
2775#define PNG_FORMAT_ARGB (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_AFIRST)
2776#define PNG_FORMAT_BGRA (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_ALPHA)
2777#define PNG_FORMAT_ABGR (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_AFIRST)
2778
2779/* Then the linear (png_uint_16) formats. When naming these "Y" is used to
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002780 * indicate a luminance (gray) channel. The component order within the pixel
2781 * is always the same - there is no provision for swapping the order of the
John Bowler7875d532011-11-07 22:33:49 -06002782 * components in the linear format.
2783 */
John Bowlerdd819152011-11-08 14:29:45 -06002784#define PNG_FORMAT_LINEAR_Y PNG_FORMAT_FLAG_LINEAR
2785#define PNG_FORMAT_LINEAR_Y_ALPHA (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_ALPHA)
2786#define PNG_FORMAT_LINEAR_RGB (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR)
2787#define PNG_FORMAT_LINEAR_RGB_ALPHA \
2788 (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA)
John Bowler7875d532011-11-07 22:33:49 -06002789
2790/* PNG_IMAGE macros
2791 *
2792 * These are convenience macros to derive information from a png_image structure
2793 */
2794#define PNG_IMAGE_CHANNELS(fmt)\
2795 (1+((fmt)&(PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA)))
2796 /* Return the total number of channels in a given format: 1..4 */
2797
2798#define PNG_IMAGE_COMPONENT_SIZE(fmt)\
2799 (((fmt) & PNG_FORMAT_FLAG_LINEAR) ? sizeof (png_uint_16) : sizeof (png_byte))
2800 /* Return the size in bytes of a single component of a pixel in the image. */
2801
2802#define PNG_IMAGE_PIXEL_SIZE(fmt)\
2803 (PNG_IMAGE_CHANNELS(fmt) * PNG_IMAGE_COMPONENT_SIZE(fmt))
2804 /* Return the size in bytes of a single pixel in the image. */
2805
2806#define PNG_IMAGE_ROW_STRIDE(image)\
2807 (PNG_IMAGE_CHANNELS((image).format) * (image).width)
2808 /* Return the total number of components in a single row of the image; this
2809 * is the minimum 'row stride', the minimum count of components between each
Glenn Randers-Pehrsone0a6c062011-11-07 23:50:05 -06002810 * row.
2811 */
John Bowler7875d532011-11-07 22:33:49 -06002812
2813#define PNG_IMAGE_BUFFER_SIZE(image, row_stride)\
2814 (PNG_IMAGE_COMPONENT_SIZE((image).format) * (image).height * (row_stride))
2815 /* Return the size, in bytes, of an image buffer given a png_image and a row
Glenn Randers-Pehrsone0a6c062011-11-07 23:50:05 -06002816 * stride - the number of components to leave space for in each row.
2817 */
John Bowler7875d532011-11-07 22:33:49 -06002818
John Bowler3706d732011-11-21 10:28:06 -06002819#define PNG_IMAGE_SIZE(image)\
2820 PNG_IMAGE_BUFFER_SIZE(image, PNG_IMAGE_ROW_STRIDE(image))
2821 /* Return the size, in bytes, of the image in memory given just a png_image;
2822 * the row stride is the minimum stride required for the image.
2823 */
2824
John Bowler7875d532011-11-07 22:33:49 -06002825/* PNG_IMAGE_FLAG_*
2826 *
2827 * Flags containing additional information about the image are held in the
2828 * 'flags' field of png_image.
2829 */
2830#define PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB 1
2831 /* This indicates the the RGB values of the in-memory bitmap do not
2832 * correspond to the red, green and blue end-points defined by sRGB.
2833 */
2834
2835#ifdef PNG_SIMPLIFIED_READ_SUPPORTED
2836/* READ APIs
2837 * ---------
2838 *
2839 * The png_image passed to the read APIs must have been initialized by setting
2840 * the png_controlp field 'opaque' to NULL (or, better, memset the whole thing.)
2841 */
2842#ifdef PNG_STDIO_SUPPORTED
2843PNG_EXPORT(234, int, png_image_begin_read_from_file, (png_imagep image,
2844 const char *file_name));
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002845 /* The named file is opened for read and the image header is filled in
2846 * from the PNG header in the file.
Glenn Randers-Pehrsone0a6c062011-11-07 23:50:05 -06002847 */
John Bowler7875d532011-11-07 22:33:49 -06002848
2849PNG_EXPORT(235, int, png_image_begin_read_from_stdio, (png_imagep image,
2850 FILE* file));
2851 /* The PNG header is read from the stdio FILE object. */
2852#endif /* PNG_STDIO_SUPPORTED */
2853
2854PNG_EXPORT(236, int, png_image_begin_read_from_memory, (png_imagep image,
2855 png_const_voidp memory, png_size_t size));
2856 /* The PNG header is read from the given memory buffer. */
2857
2858PNG_EXPORT(237, int, png_image_finish_read, (png_imagep image,
2859 png_colorp background, void *buffer, png_int_32 row_stride));
2860 /* Finish reading the image into the supplied buffer and clean up the
2861 * png_image structure.
2862 *
John Bowlerdd819152011-11-08 14:29:45 -06002863 * row_stride is the step, in png_byte or png_uint_16 units as appropriate,
John Bowler7875d532011-11-07 22:33:49 -06002864 * between adjacent rows. A positive stride indicates that the top-most row
2865 * is first in the buffer - the normal top-down arrangement. A negative
2866 * stride indicates that the bottom-most row is first in the buffer.
2867 *
2868 * background need only be supplied if an alpha channel must be removed from
2869 * a png_byte format and the removal is to be done by compositing on a solid
2870 * color; otherwise it may be NULL and any composition will be done directly
2871 * onto the buffer. The value is an sRGB color to use for the background,
2872 * for grayscale output the green channel is used.
2873 *
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002874 * For linear output removing the alpha channel is always done by compositing
John Bowler7875d532011-11-07 22:33:49 -06002875 * on black.
2876 */
2877
2878PNG_EXPORT(238, void, png_image_free, (png_imagep image));
2879 /* Free any data allocated by libpng in image->opaque, setting the pointer to
Glenn Randers-Pehrsone0a6c062011-11-07 23:50:05 -06002880 * NULL. May be called at any time after the structure is initialized.
2881 */
John Bowler7875d532011-11-07 22:33:49 -06002882#endif /* PNG_SIMPLIFIED_READ_SUPPORTED */
2883
2884#ifdef PNG_SIMPLIFIED_WRITE_SUPPORTED
2885/* WRITE APIS
2886 * ----------
2887 * For write you must initialize a png_image structure to describe the image to
2888 * be written:
2889 *
2890 * opaque: must be initialized to NULL
2891 * width: image width in pixels
2892 * height: image height in rows
2893 * format: the format of the data you wish to write
2894 * flags: set to 0 unless one of the defined flags applies; set
2895 * PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images where the RGB
2896 * values do not correspond to the colors in sRGB.
2897 */
2898PNG_EXPORT(239, int, png_image_write_to_file, (png_imagep image,
2899 const char *file, int convert_to_8bit, const void *buffer,
2900 png_int_32 row_stride));
2901 /* Write the image to the named file. */
2902
2903PNG_EXPORT(240, int, png_image_write_to_stdio, (png_imagep image, FILE *file,
2904 int convert_to_8_bit, const void *buffer, png_int_32 row_stride));
2905 /* Write the image to the given (FILE*). */
2906
2907/* With all write APIs if image is in one of the linear formats with
2908 * (png_uint_16) data then setting convert_to_8_bit will cause the output to be
2909 * a (png_byte) PNG gamma encoded according to the sRGB specification, otherwise
2910 * a 16-bit linear encoded PNG file is written.
2911 *
2912 * With all APIs row_stride is handled as in the read APIs - it is the spacing
2913 * from one row to the next in component sized units (float) and if negative
2914 * indicates a bottom-up row layout in the buffer.
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002915 *
2916 * Note that the write API does not support interlacing, sub-8-bit pixels,
2917 * and indexed (paletted) images.
John Bowler7875d532011-11-07 22:33:49 -06002918 */
2919#endif /* PNG_SIMPLIFIED_WRITE_SUPPORTED */
2920/*******************************************************************************
2921 * END OF SIMPLIFIED API
2922 ******************************************************************************/
2923
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002924/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
2925 * defs
2926 */
2927
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06002928/* The last ordinal number (this is the *last* one already used; the next
John Bowler71a10f22011-01-22 17:03:33 -06002929 * one to use is one more than this.) Maintainer, remember to add an entry to
2930 * scripts/symbols.def as well.
Glenn Randers-Pehrsonc551c0d2010-03-16 07:52:34 -05002931 */
2932#ifdef PNG_EXPORT_LAST_ORDINAL
John Bowler7875d532011-11-07 22:33:49 -06002933 PNG_EXPORT_LAST_ORDINAL(240);
Glenn Randers-Pehrsonc551c0d2010-03-16 07:52:34 -05002934#endif
2935
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06002936#ifdef __cplusplus
2937}
2938#endif
2939
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05002940#endif /* PNG_VERSION_INFO_ONLY */
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002941/* Do not put anything past this line */
Glenn Randers-Pehrson13944802000-06-24 07:42:42 -05002942#endif /* PNG_H */