blob: 64ce1ae43323a160ce620ed47892176517e587cd [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-Pehrsona7428d42011-06-17 19:07:04 -05004 * libpng version 1.5.4beta05 - June 18, 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-Pehrsona7428d42011-06-17 19:07:04 -050014 * libpng versions 0.97, January 1998, through 1.5.4beta05 - June 18, 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-Pehrson3fb7c072011-06-16 09:24:02 -0500157 * 1.5.4beta01-05 15 10504 15.so.15.4[.0]
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600158 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600159 * Henceforth the source version will match the shared-library major
160 * and minor numbers; the shared-library major version number will be
161 * used for changes in backward compatibility, as it is intended. The
162 * PNG_LIBPNG_VER macro, which is not used within libpng but is available
163 * for applications, is an unsigned integer of the form xyyzz corresponding
164 * to the source version x.y.z (leading zeros in y and z). Beta versions
165 * were given the previous public release number plus a letter, until
166 * version 1.0.6j; from then on they were given the upcoming public
167 * release number plus "betaNN" or "rcN".
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600168 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600169 * Binary incompatibility exists only when applications make direct access
170 * to the info_ptr or png_ptr members through png.h, and the compiled
171 * application is loaded with a different version of the library.
Glenn Randers-Pehrson326320e2000-04-24 07:43:17 -0500172 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600173 * DLLNUM will change each time there are forward or backward changes
174 * in binary compatibility (e.g., when a new feature is added).
Glenn Randers-Pehrsonbe9de0f2001-01-22 08:52:16 -0600175 *
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500176 * See libpng-manual.txt or libpng.3 for more information. The PNG
177 * specification is available as a W3C Recommendation and as an ISO
178 * Specification, <http://www.w3.org/TR/2003/REC-PNG-20031110/
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600179 */
180
181/*
Glenn Randers-Pehrson68ea2432000-04-01 21:10:05 -0600182 * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
183 *
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500184 * If you modify libpng you may insert additional notices immediately following
185 * this sentence.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600186 *
Glenn Randers-Pehrsonbfbf8652009-06-26 21:46:52 -0500187 * This code is released under the libpng license.
188 *
Glenn Randers-Pehrsona7428d42011-06-17 19:07:04 -0500189 * libpng versions 1.2.6, August 15, 2004, through 1.5.4beta05, June 18, 2011, are
Glenn Randers-Pehrson64b863c2011-01-04 09:57:06 -0600190 * Copyright (c) 2004, 2006-2011 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500191 * distributed according to the same disclaimer and license as libpng-1.2.5
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500192 * with the following individual added to the list of Contributing Authors:
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500193 *
194 * Cosmin Truta
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500195 *
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500196 * libpng versions 1.0.7, July 1, 2000, through 1.2.5, October 3, 2002, are
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500197 * Copyright (c) 2000-2002 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrson32fc5ce2000-07-24 06:34:14 -0500198 * distributed according to the same disclaimer and license as libpng-1.0.6
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500199 * with the following individuals added to the list of Contributing Authors:
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500200 *
201 * Simon-Pierre Cadieux
202 * Eric S. Raymond
203 * Gilles Vollant
204 *
Glenn Randers-Pehrson3d5a5202000-07-01 15:37:28 -0500205 * and with the following additions to the disclaimer:
206 *
207 * There is no warranty against interference with your enjoyment of the
208 * library or against infringement. There is no warranty that our
209 * efforts or the library will fulfill any of your particular purposes
210 * or needs. This library is provided with all faults, and the entire
211 * risk of satisfactory quality, performance, accuracy, and effort is with
212 * the user.
213 *
214 * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500215 * Copyright (c) 1998, 1999, 2000 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600216 * distributed according to the same disclaimer and license as libpng-0.96,
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500217 * with the following individuals added to the list of Contributing Authors:
218 *
219 * Tom Lane
220 * Glenn Randers-Pehrson
221 * Willem van Schaik
222 *
223 * libpng versions 0.89, June 1996, through 0.96, May 1997, are
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600224 * Copyright (c) 1996, 1997 Andreas Dilger
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600225 * Distributed according to the same disclaimer and license as libpng-0.88,
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500226 * with the following individuals added to the list of Contributing Authors:
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600227 *
228 * John Bowler
229 * Kevin Bracey
230 * Sam Bushell
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600231 * Magnus Holmgren
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600232 * Greg Roelofs
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500233 * Tom Tanner
234 *
235 * libpng versions 0.5, May 1995, through 0.88, January 1996, are
236 * Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.
237 *
238 * For the purposes of this copyright and license, "Contributing Authors"
239 * is defined as the following set of individuals:
240 *
241 * Andreas Dilger
242 * Dave Martindale
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600243 * Guy Eric Schalnat
244 * Paul Schmidt
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600245 * Tim Wegner
246 *
247 * The PNG Reference Library is supplied "AS IS". The Contributing Authors
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600248 * and Group 42, Inc. disclaim all warranties, expressed or implied,
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600249 * including, without limitation, the warranties of merchantability and of
250 * fitness for any purpose. The Contributing Authors and Group 42, Inc.
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600251 * assume no liability for direct, indirect, incidental, special, exemplary,
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600252 * or consequential damages, which may result from the use of the PNG
253 * Reference Library, even if advised of the possibility of such damage.
254 *
255 * Permission is hereby granted to use, copy, modify, and distribute this
256 * source code, or portions hereof, for any purpose, without fee, subject
257 * to the following restrictions:
258 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600259 * 1. The origin of this source code must not be misrepresented.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600260 *
Glenn Randers-Pehrson53c07f52010-06-18 18:55:55 -0500261 * 2. Altered versions must be plainly marked as such and must not
262 * be misrepresented as being the original source.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600263 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600264 * 3. This Copyright notice may not be removed or altered from
265 * any source or altered source distribution.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600266 *
267 * The Contributing Authors and Group 42, Inc. specifically permit, without
268 * fee, and encourage the use of this source code as a component to
269 * supporting the PNG file format in commercial products. If you use this
270 * source code in a product, acknowledgment is not required but would be
271 * appreciated.
272 */
273
274/*
275 * A "png_get_copyright" function is available, for convenient use in "about"
276 * boxes and the like:
277 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600278 * printf("%s", png_get_copyright(NULL));
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600279 *
280 * Also, the PNG logo (in PNG format, of course) is supplied in the
Glenn Randers-Pehrsona4d54bd2000-07-14 08:15:12 -0500281 * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600282 */
283
284/*
285 * Libpng is OSI Certified Open Source Software. OSI Certified is a
286 * certification mark of the Open Source Initiative.
287 */
288
289/*
290 * The contributing authors would like to thank all those who helped
291 * with testing, bug fixes, and patience. This wouldn't have been
292 * possible without all of you.
293 *
294 * Thanks to Frank J. T. Wojcik for helping with the documentation.
295 */
296
297/*
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600298 * Y2K compliance in libpng:
299 * =========================
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600300 *
Glenn Randers-Pehrsona7428d42011-06-17 19:07:04 -0500301 * June 18, 2011
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600302 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600303 * Since the PNG Development group is an ad-hoc body, we can't make
304 * an official declaration.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600305 *
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500306 * This is your unofficial assurance that libpng from version 0.71 and
Glenn Randers-Pehrson3fb7c072011-06-16 09:24:02 -0500307 * upward through 1.5.4beta05 are Y2K compliant. It is my belief that
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500308 * earlier versions were also Y2K compliant.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600309 *
John Bowler88b77cc2011-05-05 06:49:55 -0500310 * Libpng only has two year fields. One is a 2-byte unsigned integer
311 * that will hold years up to 65535. The other holds the date in text
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600312 * format, and will hold years up to 9999.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600313 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600314 * The integer is
315 * "png_uint_16 year" in png_time_struct.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600316 *
John Bowler88b77cc2011-05-05 06:49:55 -0500317 * The string is
318 * "png_char time_buffer" in png_struct
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600319 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600320 * There are seven time-related functions:
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600321 * png.c: png_convert_to_rfc_1123() in png.c
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600322 * (formerly png_convert_to_rfc_1152() in error)
323 * png_convert_from_struct_tm() in pngwrite.c, called in pngwrite.c
324 * png_convert_from_time_t() in pngwrite.c
325 * png_get_tIME() in pngget.c
326 * png_handle_tIME() in pngrutil.c, called in pngread.c
327 * png_set_tIME() in pngset.c
328 * png_write_tIME() in pngwutil.c, called in pngwrite.c
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600329 *
330 * All handle dates properly in a Y2K environment. The
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600331 * png_convert_from_time_t() function calls gmtime() to convert from system
332 * clock time, which returns (year - 1900), which we properly convert to
333 * the full 4-digit year. There is a possibility that applications using
334 * libpng are not passing 4-digit years into the png_convert_to_rfc_1123()
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500335 * function, or that they are incorrectly passing only a 2-digit year
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600336 * instead of "year - 1900" into the png_convert_from_struct_tm() function,
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500337 * but this is not under our control. The libpng documentation has always
338 * stated that it works with 4-digit years, and the APIs have been
339 * documented as such.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600340 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600341 * The tIME chunk itself is also Y2K compliant. It uses a 2-byte unsigned
342 * integer to hold the year, and can hold years as large as 65535.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600343 *
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500344 * zlib, upon which libpng depends, is also Y2K compliant. It contains
345 * no date-related code.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600346 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600347 * Glenn Randers-Pehrson
348 * libpng maintainer
349 * PNG Development Group
Glenn Randers-Pehrsonbcfd15d1999-10-01 14:22:25 -0500350 */
351
Glenn Randers-Pehrson13944802000-06-24 07:42:42 -0500352#ifndef PNG_H
353#define PNG_H
Guy Schalnat0d580581995-07-20 02:43:20 -0500354
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500355/* This is not the place to learn how to use libpng. The file libpng-manual.txt
Andreas Dilger47a0c421997-05-16 02:46:07 -0500356 * describes how to use libpng, and the file example.c summarizes it
357 * with some code on which to build. This file is useful for looking
358 * at the actual function definitions and structure components.
359 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500360
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500361/* Version information for png.h - this should match the version in png.c */
Glenn Randers-Pehrson3fb7c072011-06-16 09:24:02 -0500362#define PNG_LIBPNG_VER_STRING "1.5.4beta05"
Glenn Randers-Pehrson5b5dcf82004-07-17 22:45:44 -0500363#define PNG_HEADER_VERSION_STRING \
Glenn Randers-Pehrsona7428d42011-06-17 19:07:04 -0500364 " libpng version 1.5.4beta05 - June 18, 2011\n"
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500365
Glenn Randers-Pehrsonf1eb9182010-02-08 15:36:41 -0600366#define PNG_LIBPNG_VER_SONUM 15
367#define PNG_LIBPNG_VER_DLLNUM 15
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500368
369/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */
370#define PNG_LIBPNG_VER_MAJOR 1
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -0600371#define PNG_LIBPNG_VER_MINOR 5
Glenn Randers-Pehrson97039ba2011-06-13 20:07:27 -0500372#define PNG_LIBPNG_VER_RELEASE 4
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500373/* This should match the numeric part of the final component of
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500374 * PNG_LIBPNG_VER_STRING, omitting any leading zero:
375 */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600376
Glenn Randers-Pehrson3fb7c072011-06-16 09:24:02 -0500377#define PNG_LIBPNG_VER_BUILD 05
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600378
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600379/* Release Status */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600380#define PNG_LIBPNG_BUILD_ALPHA 1
381#define PNG_LIBPNG_BUILD_BETA 2
382#define PNG_LIBPNG_BUILD_RC 3
383#define PNG_LIBPNG_BUILD_STABLE 4
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600384#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500385
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600386/* Release-Specific Flags */
387#define PNG_LIBPNG_BUILD_PATCH 8 /* Can be OR'ed with
388 PNG_LIBPNG_BUILD_STABLE only */
389#define PNG_LIBPNG_BUILD_PRIVATE 16 /* Cannot be OR'ed with
390 PNG_LIBPNG_BUILD_SPECIAL */
391#define PNG_LIBPNG_BUILD_SPECIAL 32 /* Cannot be OR'ed with
392 PNG_LIBPNG_BUILD_PRIVATE */
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500393
Glenn Randers-Pehrson17218292006-04-20 07:20:46 -0500394#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_BETA
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600395
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500396/* Careful here. At one time, Guy wanted to use 082, but that would be octal.
397 * We must not include leading zeros.
398 * Versions 0.7 through 1.0.0 were in the range 0 to 100 here (only
399 * version 1.0.0 was mis-numbered 100 instead of 10000). From
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500400 * version 1.0.1 it's xxyyzz, where x=major, y=minor, z=release
401 */
Glenn Randers-Pehrson97039ba2011-06-13 20:07:27 -0500402#define PNG_LIBPNG_VER 10504 /* 1.5.4 */
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500403
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500404/* Library configuration: these options cannot be changed after
405 * the library has been built.
406 */
407#ifndef PNGLCONF_H
Glenn Randers-Pehrson8c667862010-08-24 16:16:35 -0500408 /* If pnglibconf.h is missing, you can
409 * copy scripts/pnglibconf.h.prebuilt to pnglibconf.h
410 */
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500411# include "pnglibconf.h"
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600412#endif
Guy Schalnat0d580581995-07-20 02:43:20 -0500413
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500414#ifndef PNG_VERSION_INFO_ONLY
Glenn Randers-Pehrson80de04e2011-03-24 23:06:26 -0500415# ifndef PNG_BUILDING_SYMBOL_TABLE
416 /*
417 * Standard header files (not needed for the version info or while
418 * building symbol table -- see scripts/pnglibconf.dfa)
419 */
420# ifdef PNG_SETJMP_SUPPORTED
421# include <setjmp.h>
422# endif
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500423
Glenn Randers-Pehrson80de04e2011-03-24 23:06:26 -0500424 /* Need the time information for converting tIME chunks, it
425 * defines struct tm:
426 */
427# ifdef PNG_CONVERT_tIME_SUPPORTED
428 /* "time.h" functions are not supported on all operating systems */
429# include <time.h>
430# endif
431# endif
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500432
433/* Machine specific configuration. */
434# include "pngconf.h"
435#endif
Guy Schalnat0d580581995-07-20 02:43:20 -0500436
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600437/*
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500438 * Added at libpng-1.2.8
439 *
440 * Ref MSDN: Private as priority over Special
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600441 * VS_FF_PRIVATEBUILD File *was not* built using standard release
442 * procedures. If this value is given, the StringFileInfo block must
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500443 * contain a PrivateBuild string.
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600444 *
445 * VS_FF_SPECIALBUILD File *was* built by the original company using
446 * standard release procedures but is a variation of the standard
447 * file of the same version number. If this value is given, the
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500448 * StringFileInfo block must contain a SpecialBuild string.
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600449 */
450
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500451#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600452# define PNG_LIBPNG_BUILD_TYPE \
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600453 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600454#else
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500455# ifdef PNG_LIBPNG_SPECIALBUILD
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600456# define PNG_LIBPNG_BUILD_TYPE \
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600457 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600458# else
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600459# define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600460# endif
461#endif
462
463#ifndef PNG_VERSION_INFO_ONLY
464
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500465/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
466#ifdef __cplusplus
467extern "C" {
468#endif /* __cplusplus */
469
Andreas Dilger47a0c421997-05-16 02:46:07 -0500470/* Version information for C files, stored in png.c. This had better match
471 * the version above.
472 */
Glenn Randers-Pehrson4c8f7262010-03-16 19:30:01 -0500473#define png_libpng_ver png_get_header_ver(NULL)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500474
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500475/* This file is arranged in several sections:
476 *
477 * 1. Any configuration options that can be specified by for the application
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500478 * code when it is built. (Build time configuration is in pnglibconf.h)
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500479 * 2. Type definitions (base types are defined in pngconf.h), structure
480 * definitions.
481 * 3. Exported library functions.
482 *
483 * The library source code has additional files (principally pngpriv.h) that
484 * allow configuration of the library.
485 */
486/* Section 1: run time configuration
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500487 * See pnglibconf.h for build time configuration
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500488 *
489 * Run time configuration allows the application to choose between
490 * implementations of certain arithmetic APIs. The default is set
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500491 * at build time and recorded in pnglibconf.h, but it is safe to
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500492 * override these (and only these) settings. Note that this won't
493 * change what the library does, only application code, and the
494 * settings can (and probably should) be made on a per-file basis
495 * by setting the #defines before including png.h
496 *
497 * Use macros to read integers from PNG data or use the exported
498 * functions?
499 * PNG_USE_READ_MACROS: use the macros (see below) Note that
500 * the macros evaluate their argument multiple times.
501 * PNG_NO_USE_READ_MACROS: call the relevant library function.
502 *
503 * Use the alternative algorithm for compositing alpha samples that
504 * does not use division?
505 * PNG_READ_COMPOSITE_NODIV_SUPPORTED: use the 'no division'
506 * algorithm.
507 * PNG_NO_READ_COMPOSITE_NODIV: use the 'division' algorithm.
508 *
509 * How to handle benign errors if PNG_ALLOW_BENIGN_ERRORS is
510 * false?
511 * PNG_ALLOW_BENIGN_ERRORS: map calls to the benign error
512 * APIs to png_warning.
513 * Otherwise the calls are mapped to png_error.
514 */
515
516/* Section 2: type definitions, including structures and compile time
517 * constants.
518 * See pngconf.h for base types that vary by machine/system
519 */
Glenn Randers-Pehrson88910f52010-10-16 20:38:45 -0500520
521/* This triggers a compiler error in png.c, if png.c and png.h
522 * do not agree upon the version number.
523 */
Glenn Randers-Pehrson3fb7c072011-06-16 09:24:02 -0500524typedef char* png_libpng_version_1_5_4beta05;
Glenn Randers-Pehrson88910f52010-10-16 20:38:45 -0500525
Andreas Dilger47a0c421997-05-16 02:46:07 -0500526/* Three color definitions. The order of the red, green, and blue, (and the
527 * exact size) is not important, although the size of the fields need to
528 * be png_byte or png_uint_16 (as defined below).
529 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500530typedef struct png_color_struct
531{
Guy Schalnat4ee97b01996-01-16 01:51:56 -0600532 png_byte red;
Guy Schalnat0d580581995-07-20 02:43:20 -0500533 png_byte green;
534 png_byte blue;
535} png_color;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500536typedef png_color FAR * png_colorp;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500537typedef PNG_CONST png_color FAR * png_const_colorp;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500538typedef png_color FAR * FAR * png_colorpp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500539
540typedef struct png_color_16_struct
541{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500542 png_byte index; /* used for palette files */
543 png_uint_16 red; /* for use in red green blue files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500544 png_uint_16 green;
545 png_uint_16 blue;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500546 png_uint_16 gray; /* for use in grayscale files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500547} png_color_16;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500548typedef png_color_16 FAR * png_color_16p;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500549typedef PNG_CONST png_color_16 FAR * png_const_color_16p;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500550typedef png_color_16 FAR * FAR * png_color_16pp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500551
552typedef struct png_color_8_struct
553{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500554 png_byte red; /* for use in red green blue files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500555 png_byte green;
556 png_byte blue;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500557 png_byte gray; /* for use in grayscale files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500558 png_byte alpha; /* for alpha channel files */
559} png_color_8;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500560typedef png_color_8 FAR * png_color_8p;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500561typedef PNG_CONST png_color_8 FAR * png_const_color_8p;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500562typedef png_color_8 FAR * FAR * png_color_8pp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500563
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600564/*
565 * The following two structures are used for the in-core representation
566 * of sPLT chunks.
567 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600568typedef struct png_sPLT_entry_struct
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600569{
570 png_uint_16 red;
571 png_uint_16 green;
572 png_uint_16 blue;
573 png_uint_16 alpha;
574 png_uint_16 frequency;
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600575} png_sPLT_entry;
576typedef png_sPLT_entry FAR * png_sPLT_entryp;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500577typedef PNG_CONST png_sPLT_entry FAR * png_const_sPLT_entryp;
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600578typedef png_sPLT_entry FAR * FAR * png_sPLT_entrypp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600579
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500580/* When the depth of the sPLT palette is 8 bits, the color and alpha samples
581 * occupy the LSB of their respective members, and the MSB of each member
582 * is zero-filled. The frequency member always occupies the full 16 bits.
583 */
584
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600585typedef struct png_sPLT_struct
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600586{
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500587 png_charp name; /* palette name */
588 png_byte depth; /* depth of palette samples */
589 png_sPLT_entryp entries; /* palette entries */
590 png_int_32 nentries; /* number of palette entries */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600591} png_sPLT_t;
592typedef png_sPLT_t FAR * png_sPLT_tp;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500593typedef PNG_CONST png_sPLT_t FAR * png_const_sPLT_tp;
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600594typedef png_sPLT_t FAR * FAR * png_sPLT_tpp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600595
596#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600597/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600598 * and whether that contents is compressed or not. The "key" field
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500599 * points to a regular zero-terminated C string. The "text", "lang", and
600 * "lang_key" fields can be regular C strings, empty strings, or NULL pointers.
Glenn Randers-Pehrson140504b2011-06-15 08:10:13 -0500601 * However, the structure returned by png_get_text() will always contain
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600602 * regular zero-terminated C strings (possibly empty), never NULL pointers,
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500603 * so they can be safely used in printf() and other string-handling functions.
604 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500605typedef struct png_text_struct
606{
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500607 int compression; /* compression value:
608 -1: tEXt, none
609 0: zTXt, deflate
610 1: iTXt, none
611 2: iTXt, deflate */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500612 png_charp key; /* keyword, 1-79 character description of "text" */
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500613 png_charp text; /* comment, may be an empty string (ie "")
614 or a NULL pointer */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600615 png_size_t text_length; /* length of the text string */
616 png_size_t itxt_length; /* length of the itxt string */
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500617 png_charp lang; /* language code, 0-79 characters
618 or a NULL pointer */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600619 png_charp lang_key; /* keyword translated UTF-8 string, 0 or more
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500620 chars or a NULL pointer */
Guy Schalnat0d580581995-07-20 02:43:20 -0500621} png_text;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500622typedef png_text FAR * png_textp;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500623typedef PNG_CONST png_text FAR * png_const_textp;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500624typedef png_text FAR * FAR * png_textpp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600625#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -0500626
627/* Supported compression types for text in PNG files (tEXt, and zTXt).
628 * The values of the PNG_TEXT_COMPRESSION_ defines should NOT be changed. */
629#define PNG_TEXT_COMPRESSION_NONE_WR -3
630#define PNG_TEXT_COMPRESSION_zTXt_WR -2
631#define PNG_TEXT_COMPRESSION_NONE -1
632#define PNG_TEXT_COMPRESSION_zTXt 0
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600633#define PNG_ITXT_COMPRESSION_NONE 1
634#define PNG_ITXT_COMPRESSION_zTXt 2
635#define PNG_TEXT_COMPRESSION_LAST 3 /* Not a valid value */
Guy Schalnat0d580581995-07-20 02:43:20 -0500636
637/* png_time is a way to hold the time in an machine independent way.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600638 * Two conversions are provided, both from time_t and struct tm. There
639 * is no portable way to convert to either of these structures, as far
640 * 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 -0600641 * note - PNG has always been Year 2000 compliant!
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600642 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500643typedef struct png_time_struct
644{
645 png_uint_16 year; /* full year, as in, 1995 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500646 png_byte month; /* month of year, 1 - 12 */
647 png_byte day; /* day of month, 1 - 31 */
648 png_byte hour; /* hour of day, 0 - 23 */
649 png_byte minute; /* minute of hour, 0 - 59 */
650 png_byte second; /* second of minute, 0 - 60 (for leap seconds) */
Guy Schalnat0d580581995-07-20 02:43:20 -0500651} png_time;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500652typedef png_time FAR * png_timep;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500653typedef PNG_CONST png_time FAR * png_const_timep;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500654typedef png_time FAR * FAR * png_timepp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500655
Glenn Randers-Pehrson38674ec2009-06-16 13:33:01 -0500656#if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED) || \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -0600657 defined(PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600658/* png_unknown_chunk is a structure to hold queued chunks for which there is
659 * no specific support. The idea is that we can use this to queue
660 * up private chunks for output even though the library doesn't actually
661 * know about their semantics.
662 */
663typedef struct png_unknown_chunk_t
664{
665 png_byte name[5];
666 png_byte *data;
667 png_size_t size;
668
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600669 /* libpng-using applications should NOT directly modify this byte. */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600670 png_byte location; /* mode of operation at read time */
671}
Glenn Randers-Pehrson2d3fc1c2011-05-10 23:48:00 -0500672
Glenn Randers-Pehrson2d3fc1c2011-05-10 23:48:00 -0500673
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600674png_unknown_chunk;
675typedef png_unknown_chunk FAR * png_unknown_chunkp;
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500676typedef PNG_CONST png_unknown_chunk FAR * png_const_unknown_chunkp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600677typedef png_unknown_chunk FAR * FAR * png_unknown_chunkpp;
678#endif
679
Glenn Randers-Pehrsonfd73d042011-06-13 13:25:21 -0500680/* Values for the unknown chunk location byte */
Glenn Randers-Pehrson2d3fc1c2011-05-10 23:48:00 -0500681
Glenn Randers-Pehrsonfd73d042011-06-13 13:25:21 -0500682#define PNG_HAVE_IHDR 0x01
683#define PNG_HAVE_PLTE 0x02
684#define PNG_AFTER_IDAT 0x08
Glenn Randers-Pehrson2d3fc1c2011-05-10 23:48:00 -0500685
Glenn Randers-Pehrson1384c042011-04-28 23:22:18 -0500686/* The complete definition of png_info has, as of libpng-1.5.0,
687 * been moved into a separate header file that is not accessible to
688 * applications. Read libpng-manual.txt or libpng.3 for more info.
689 */
Glenn Randers-Pehrsonf0cdbe72010-02-08 23:18:15 -0600690typedef struct png_info_def png_info;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500691typedef png_info FAR * png_infop;
John Bowler0a5c9c02011-01-22 17:36:34 -0600692typedef PNG_CONST png_info FAR * png_const_infop;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500693typedef png_info FAR * FAR * png_infopp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500694
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500695/* Maximum positive integer used in PNG is (2^31)-1 */
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500696#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
Glenn Randers-Pehrson78067772004-11-02 21:49:39 -0600697#define PNG_UINT_32_MAX ((png_uint_32)(-1))
698#define PNG_SIZE_MAX ((png_size_t)(-1))
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500699
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500700/* These are constants for fixed point values encoded in the
701 * PNG specification manner (x100000)
702 */
703#define PNG_FP_1 100000
704#define PNG_FP_HALF 50000
John Bowlerd273ad22011-05-07 21:00:28 -0500705#define PNG_FP_MAX ((png_fixed_point)0x7fffffffL)
706#define PNG_FP_MIN (-PNG_FP_MAX)
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500707
Andreas Dilger47a0c421997-05-16 02:46:07 -0500708/* These describe the color_type field in png_info. */
Guy Schalnat0d580581995-07-20 02:43:20 -0500709/* color type masks */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500710#define PNG_COLOR_MASK_PALETTE 1
711#define PNG_COLOR_MASK_COLOR 2
712#define PNG_COLOR_MASK_ALPHA 4
Guy Schalnat0d580581995-07-20 02:43:20 -0500713
714/* color types. Note that not all combinations are legal */
Guy Schalnate5a37791996-06-05 15:50:50 -0500715#define PNG_COLOR_TYPE_GRAY 0
Andreas Dilger47a0c421997-05-16 02:46:07 -0500716#define PNG_COLOR_TYPE_PALETTE (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE)
717#define PNG_COLOR_TYPE_RGB (PNG_COLOR_MASK_COLOR)
718#define PNG_COLOR_TYPE_RGB_ALPHA (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA)
Guy Schalnat0d580581995-07-20 02:43:20 -0500719#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600720/* aliases */
721#define PNG_COLOR_TYPE_RGBA PNG_COLOR_TYPE_RGB_ALPHA
722#define PNG_COLOR_TYPE_GA PNG_COLOR_TYPE_GRAY_ALPHA
Guy Schalnat0d580581995-07-20 02:43:20 -0500723
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500724/* This is for compression type. PNG 1.0-1.2 only define the single type. */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500725#define PNG_COMPRESSION_TYPE_BASE 0 /* Deflate method 8, 32K window */
726#define PNG_COMPRESSION_TYPE_DEFAULT PNG_COMPRESSION_TYPE_BASE
727
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500728/* This is for filter type. PNG 1.0-1.2 only define the single type. */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500729#define PNG_FILTER_TYPE_BASE 0 /* Single row per-byte filtering */
Glenn Randers-Pehrson2ad31ae2000-12-15 08:54:42 -0600730#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500731#define PNG_FILTER_TYPE_DEFAULT PNG_FILTER_TYPE_BASE
732
733/* These are for the interlacing type. These values should NOT be changed. */
734#define PNG_INTERLACE_NONE 0 /* Non-interlaced image */
735#define PNG_INTERLACE_ADAM7 1 /* Adam7 interlacing */
736#define PNG_INTERLACE_LAST 2 /* Not a valid value */
737
738/* These are for the oFFs chunk. These values should NOT be changed. */
739#define PNG_OFFSET_PIXEL 0 /* Offset in pixels */
740#define PNG_OFFSET_MICROMETER 1 /* Offset in micrometers (1/10^6 meter) */
741#define PNG_OFFSET_LAST 2 /* Not a valid value */
742
743/* These are for the pCAL chunk. These values should NOT be changed. */
744#define PNG_EQUATION_LINEAR 0 /* Linear transformation */
745#define PNG_EQUATION_BASE_E 1 /* Exponential base e transform */
746#define PNG_EQUATION_ARBITRARY 2 /* Arbitrary base exponential transform */
747#define PNG_EQUATION_HYPERBOLIC 3 /* Hyperbolic sine transformation */
748#define PNG_EQUATION_LAST 4 /* Not a valid value */
749
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600750/* These are for the sCAL chunk. These values should NOT be changed. */
751#define PNG_SCALE_UNKNOWN 0 /* unknown unit (image scale) */
752#define PNG_SCALE_METER 1 /* meters per pixel */
753#define PNG_SCALE_RADIAN 2 /* radians per pixel */
754#define PNG_SCALE_LAST 3 /* Not a valid value */
755
Andreas Dilger47a0c421997-05-16 02:46:07 -0500756/* These are for the pHYs chunk. These values should NOT be changed. */
757#define PNG_RESOLUTION_UNKNOWN 0 /* pixels/unknown unit (aspect ratio) */
758#define PNG_RESOLUTION_METER 1 /* pixels/meter */
759#define PNG_RESOLUTION_LAST 2 /* Not a valid value */
760
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600761/* These are for the sRGB chunk. These values should NOT be changed. */
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600762#define PNG_sRGB_INTENT_PERCEPTUAL 0
763#define PNG_sRGB_INTENT_RELATIVE 1
764#define PNG_sRGB_INTENT_SATURATION 2
765#define PNG_sRGB_INTENT_ABSOLUTE 3
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600766#define PNG_sRGB_INTENT_LAST 4 /* Not a valid value */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600767
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600768/* This is for text chunks */
769#define PNG_KEYWORD_MAX_LENGTH 79
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600770
Glenn Randers-Pehrson76e5fd62000-12-28 07:50:05 -0600771/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
Glenn Randers-Pehrsond1e8c862002-06-20 06:54:34 -0500772#define PNG_MAX_PALETTE_LENGTH 256
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600773
Andreas Dilger47a0c421997-05-16 02:46:07 -0500774/* These determine if an ancillary chunk's data has been successfully read
775 * from the PNG header, or if the application has filled in the corresponding
776 * data in the info_struct to be written into the output file. The values
777 * of the PNG_INFO_<chunk> defines should NOT be changed.
778 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500779#define PNG_INFO_gAMA 0x0001
780#define PNG_INFO_sBIT 0x0002
781#define PNG_INFO_cHRM 0x0004
782#define PNG_INFO_PLTE 0x0008
783#define PNG_INFO_tRNS 0x0010
784#define PNG_INFO_bKGD 0x0020
785#define PNG_INFO_hIST 0x0040
786#define PNG_INFO_pHYs 0x0080
787#define PNG_INFO_oFFs 0x0100
788#define PNG_INFO_tIME 0x0200
Andreas Dilger47a0c421997-05-16 02:46:07 -0500789#define PNG_INFO_pCAL 0x0400
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600790#define PNG_INFO_sRGB 0x0800 /* GR-P, 0.96a */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600791#define PNG_INFO_iCCP 0x1000 /* ESR, 1.0.6 */
792#define PNG_INFO_sPLT 0x2000 /* ESR, 1.0.6 */
793#define PNG_INFO_sCAL 0x4000 /* ESR, 1.0.6 */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600794#define PNG_INFO_IDAT 0x8000L /* ESR, 1.0.6 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500795
Andreas Dilger47a0c421997-05-16 02:46:07 -0500796/* This is used for the transformation routines, as some of them
797 * change these values for the row. It also should enable using
798 * the routines for other purposes.
799 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500800typedef struct png_row_info_struct
801{
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -0600802 png_uint_32 width; /* width of row */
803 png_size_t rowbytes; /* number of bytes in row */
804 png_byte color_type; /* color type of row */
805 png_byte bit_depth; /* bit depth of row */
806 png_byte channels; /* number of channels (1, 2, 3, or 4) */
Guy Schalnat4ee97b01996-01-16 01:51:56 -0600807 png_byte pixel_depth; /* bits per pixel (depth * channels) */
Guy Schalnat0d580581995-07-20 02:43:20 -0500808} png_row_info;
809
Andreas Dilger47a0c421997-05-16 02:46:07 -0500810typedef png_row_info FAR * png_row_infop;
811typedef png_row_info FAR * FAR * png_row_infopp;
Guy Schalnat0f716451995-11-28 11:22:13 -0600812
Glenn Randers-Pehrson1384c042011-04-28 23:22:18 -0500813/* The complete definition of png_struct has, as of libpng-1.5.0,
814 * been moved into a separate header file that is not accessible to
815 * applications. Read libpng-manual.txt or libpng.3 for more info.
816 */
817typedef struct png_struct_def png_struct;
818typedef PNG_CONST png_struct FAR * png_const_structp;
819typedef png_struct FAR * png_structp;
820
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500821/* These are the function types for the I/O functions and for the functions
822 * that allow the user to override the default I/O functions with his or her
823 * own. The png_error_ptr type should match that of user-supplied warning
824 * and error functions, while the png_rw_ptr type should match that of the
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500825 * user read/write data functions. Note that the 'write' function must not
Glenn Randers-Pehrsonea2f7e02010-08-18 08:14:54 -0500826 * modify the buffer it is passed. The 'read' function, on the other hand, is
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500827 * expected to return the read data in the buffer.
Guy Schalnat0f716451995-11-28 11:22:13 -0600828 */
John Bowler9c693602011-02-12 08:58:21 -0600829typedef PNG_CALLBACK(void, *png_error_ptr, (png_structp, png_const_charp));
830typedef PNG_CALLBACK(void, *png_rw_ptr, (png_structp, png_bytep, png_size_t));
831typedef PNG_CALLBACK(void, *png_flush_ptr, (png_structp));
832typedef PNG_CALLBACK(void, *png_read_status_ptr, (png_structp, png_uint_32,
833 int));
834typedef PNG_CALLBACK(void, *png_write_status_ptr, (png_structp, png_uint_32,
835 int));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600836
Guy Schalnat69b14481996-01-10 02:56:49 -0600837#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
John Bowler9c693602011-02-12 08:58:21 -0600838typedef PNG_CALLBACK(void, *png_progressive_info_ptr, (png_structp, png_infop));
839typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop));
John Bowler9616ad92011-02-16 06:13:46 -0600840
841/* The following callback receives png_uint_32 row_number, int pass for the
842 * png_bytep data of the row. When transforming an interlaced image the
843 * row number is the row number within the sub-image of the interlace pass, so
844 * the value will increase to the height of the sub-image (not the full image)
845 * then reset to 0 for the next pass.
846 *
847 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
848 * find the output pixel (x,y) given an interlaced sub-image pixel
849 * (row,col,pass). (See below for these macros.)
850 */
John Bowler9c693602011-02-12 08:58:21 -0600851typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600852 png_uint_32, int));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600853#endif
Guy Schalnat6d764711995-12-19 03:22:19 -0600854
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600855#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -0500856 defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
John Bowler9c693602011-02-12 08:58:21 -0600857typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600858 png_bytep));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600859#endif
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600860
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500861#ifdef PNG_USER_CHUNKS_SUPPORTED
John Bowler9c693602011-02-12 08:58:21 -0600862typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600863 png_unknown_chunkp));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600864#endif
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500865#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
John Bowler9c693602011-02-12 08:58:21 -0600866typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600867#endif
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -0600868
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600869#ifdef PNG_SETJMP_SUPPORTED
John Bowlerb302c472011-04-15 06:37:34 -0500870/* This must match the function definition in <setjmp.h>, and the application
871 * must include this before png.h to obtain the definition of jmp_buf. The
872 * function is required to be PNG_NORETURN, but this is not checked. If the
873 * function does return the application will crash via an abort() or similar
874 * system level call.
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500875 *
John Bowlerb302c472011-04-15 06:37:34 -0500876 * If you get a warning here while building the library you may need to make
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500877 * changes to ensure that pnglibconf.h records the calling convention used by
878 * your compiler. This may be very difficult - try using a different compiler
879 * to build the library!
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600880 */
John Bowlerb302c472011-04-15 06:37:34 -0500881PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)), typedef);
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600882#endif
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600883
884/* Transform masks for the high-level interface */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600885#define PNG_TRANSFORM_IDENTITY 0x0000 /* read and write */
886#define PNG_TRANSFORM_STRIP_16 0x0001 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600887#define PNG_TRANSFORM_STRIP_ALPHA 0x0002 /* read only */
888#define PNG_TRANSFORM_PACKING 0x0004 /* read and write */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600889#define PNG_TRANSFORM_PACKSWAP 0x0008 /* read and write */
890#define PNG_TRANSFORM_EXPAND 0x0010 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600891#define PNG_TRANSFORM_INVERT_MONO 0x0020 /* read and write */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600892#define PNG_TRANSFORM_SHIFT 0x0040 /* read and write */
893#define PNG_TRANSFORM_BGR 0x0080 /* read and write */
894#define PNG_TRANSFORM_SWAP_ALPHA 0x0100 /* read and write */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600895#define PNG_TRANSFORM_SWAP_ENDIAN 0x0200 /* read and write */
Glenn Randers-Pehrsondb66d442000-06-23 21:38:16 -0500896#define PNG_TRANSFORM_INVERT_ALPHA 0x0400 /* read and write */
Glenn Randers-Pehrson99708d52009-06-29 17:30:00 -0500897#define PNG_TRANSFORM_STRIP_FILLER 0x0800 /* write only */
Glenn Randers-Pehrson1eb14e92008-12-10 07:14:45 -0600898/* Added to libpng-1.2.34 */
Glenn Randers-Pehrson0ffb71a2009-02-28 06:08:20 -0600899#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
Glenn Randers-Pehrson99708d52009-06-29 17:30:00 -0500900#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
901/* Added to libpng-1.4.0 */
902#define PNG_TRANSFORM_GRAY_TO_RGB 0x2000 /* read only */
Glenn Randers-Pehrsonef217b72011-06-15 12:58:27 -0500903/* Added to libpng-1.5.4 */
John Bowlera9b34192011-05-08 19:46:51 -0500904#define PNG_TRANSFORM_EXPAND_16 0x4000 /* read only */
Glenn Randers-Pehrsonab63dd02011-06-17 20:04:17 -0500905#define PNG_TRANSFORM_SCALE_16 0x8000 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600906
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600907/* Flags for MNG supported features */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600908#define PNG_FLAG_MNG_EMPTY_PLTE 0x01
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600909#define PNG_FLAG_MNG_FILTER_64 0x04
Glenn Randers-Pehrson408b4212000-12-18 09:33:57 -0600910#define PNG_ALL_MNG_FEATURES 0x05
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600911
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600912/* NOTE: prior to 1.5 these functions had no 'API' style declaration,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600913 * this allowed the zlib default functions to be used on Windows
914 * platforms. In 1.5 the zlib default malloc (which just calls malloc and
915 * ignores the first argument) should be completely compatible with the
916 * following.
917 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600918typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,
John Bowler9c693602011-02-12 08:58:21 -0600919 png_alloc_size_t));
920typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp));
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500921
Andreas Dilger47a0c421997-05-16 02:46:07 -0500922typedef png_struct FAR * FAR * png_structpp;
Guy Schalnat6d764711995-12-19 03:22:19 -0600923
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500924/* Section 3: exported functions
925 * Here are the function definitions most commonly used. This is not
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500926 * the place to find out how to use libpng. See libpng-manual.txt for the
Andreas Dilger47a0c421997-05-16 02:46:07 -0500927 * full explanation, see example.c for the summary. This just provides
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600928 * a simple one line description of the use of each function.
Glenn Randers-Pehrsona4517252010-12-06 08:54:55 -0600929 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600930 * The PNG_EXPORT() and PNG_EXPORTA() macros used below are defined in
931 * pngconf.h and in the *.dfn files in the scripts directory.
Glenn Randers-Pehrsona4517252010-12-06 08:54:55 -0600932 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600933 * PNG_EXPORT(ordinal, type, name, (args));
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600934 *
935 * ordinal: ordinal that is used while building
936 * *.def files. The ordinal value is only
937 * relevant when preprocessing png.h with
938 * the *.dfn files for building symbol table
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600939 * entries, and are removed by pngconf.h.
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600940 * type: return type of the function
941 * name: function name
942 * args: function arguments, with types
943 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600944 * When we wish to append attributes to a function prototype we use
945 * the PNG_EXPORTA() macro instead.
946 *
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600947 * PNG_EXPORTA(ordinal, type, name, (args), attributes);
948 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600949 * ordinal, type, name, and args: same as in PNG_EXPORT().
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600950 * attributes: function attributes
Andreas Dilger47a0c421997-05-16 02:46:07 -0500951 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500952
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500953/* Returns the version number of the library */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600954PNG_EXPORT(1, png_uint_32, png_access_version_number, (void));
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500955
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600956/* Tell lib we have already handled the first <num_bytes> magic bytes.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500957 * Handling more than 8 bytes from the beginning of the file is an error.
958 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600959PNG_EXPORT(2, void, png_set_sig_bytes, (png_structp png_ptr, int num_bytes));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600960
Andreas Dilger47a0c421997-05-16 02:46:07 -0500961/* Check sig[start] through sig[start + num_to_check - 1] to see if it's a
962 * PNG file. Returns zero if the supplied bytes match the 8-byte PNG
963 * signature, and non-zero otherwise. Having num_to_check == 0 or
964 * start > 7 will always fail (ie return non-zero).
965 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600966PNG_EXPORT(3, int, png_sig_cmp, (png_const_bytep sig, png_size_t start,
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600967 png_size_t num_to_check));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600968
Glenn Randers-Pehrson3e42a992010-03-31 22:16:07 -0500969/* Simple signature checking function. This is the same as calling
970 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
971 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600972#define png_check_sig(sig, n) !png_sig_cmp((sig), 0, (n))
Glenn Randers-Pehrson3e42a992010-03-31 22:16:07 -0500973
Andreas Dilger47a0c421997-05-16 02:46:07 -0500974/* Allocate and initialize png_ptr struct for reading, and any other memory. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600975PNG_EXPORTA(4, png_structp, png_create_read_struct,
976 (png_const_charp user_png_ver, png_voidp error_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600977 png_error_ptr error_fn, png_error_ptr warn_fn),
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600978 PNG_ALLOCATED);
Guy Schalnat0d580581995-07-20 02:43:20 -0500979
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500980/* Allocate and initialize png_ptr struct for writing, and any other memory */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600981PNG_EXPORTA(5, png_structp, png_create_write_struct,
982 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600983 png_error_ptr warn_fn),
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600984 PNG_ALLOCATED);
Guy Schalnate5a37791996-06-05 15:50:50 -0500985
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600986PNG_EXPORT(6, png_size_t, png_get_compression_buffer_size,
John Bowler0a5c9c02011-01-22 17:36:34 -0600987 (png_const_structp png_ptr));
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -0500988
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600989PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structp png_ptr,
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600990 png_size_t size));
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -0500991
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600992/* Moved from pngconf.h in 1.4.0 and modified to ensure setjmp/longjmp
993 * match up.
994 */
995#ifdef PNG_SETJMP_SUPPORTED
996/* This function returns the jmp_buf built in to *png_ptr. It must be
997 * supplied with an appropriate 'longjmp' function to use on that jmp_buf
998 * unless the default error function is overridden in which case NULL is
999 * acceptable. The size of the jmp_buf is checked against the actual size
1000 * allocated by the library - the call will return NULL on a mismatch
1001 * indicating an ABI mismatch.
1002 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001003PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structp png_ptr,
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001004 png_longjmp_ptr longjmp_fn, size_t jmp_buf_size));
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001005# define png_jmpbuf(png_ptr) \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06001006 (*png_set_longjmp_fn((png_ptr), longjmp, sizeof (jmp_buf)))
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001007#else
1008# define png_jmpbuf(png_ptr) \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06001009 (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001010#endif
Glenn Randers-Pehrsonf98726a2010-02-19 09:54:53 -06001011/* This function should be used by libpng applications in place of
1012 * longjmp(png_ptr->jmpbuf, val). If longjmp_fn() has been set, it
1013 * will use it; otherwise it will call PNG_ABORT(). This function was
1014 * added in libpng-1.5.0.
1015 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001016PNG_EXPORTA(9, void, png_longjmp, (png_structp png_ptr, int val),
1017 PNG_NORETURN);
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001018
Glenn Randers-Pehrson2b8bef12010-04-29 11:50:24 -05001019#ifdef PNG_READ_SUPPORTED
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -05001020/* Reset the compression stream */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001021PNG_EXPORT(10, int, png_reset_zstream, (png_structp png_ptr));
Glenn Randers-Pehrson2b8bef12010-04-29 11:50:24 -05001022#endif
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -05001023
Glenn Randers-Pehrson8b6a8892001-05-18 04:54:50 -05001024/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001025#ifdef PNG_USER_MEM_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001026PNG_EXPORTA(11, png_structp, png_create_read_struct_2,
1027 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001028 png_error_ptr warn_fn,
1029 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001030 PNG_ALLOCATED);
1031PNG_EXPORTA(12, png_structp, png_create_write_struct_2,
1032 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001033 png_error_ptr warn_fn,
1034 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001035 PNG_ALLOCATED);
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001036#endif
1037
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001038/* Write the PNG file signature. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001039PNG_EXPORT(13, void, png_write_sig, (png_structp png_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001040
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001041/* Write a PNG chunk - size, type, (optional) data, CRC. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001042PNG_EXPORT(14, void, png_write_chunk, (png_structp png_ptr, png_const_bytep
1043 chunk_name, png_const_bytep data, png_size_t length));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001044
1045/* Write the start of a PNG chunk - length and chunk name. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001046PNG_EXPORT(15, void, png_write_chunk_start, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001047 png_const_bytep chunk_name, png_uint_32 length));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001048
1049/* Write the data of a PNG chunk started with png_write_chunk_start(). */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001050PNG_EXPORT(16, void, png_write_chunk_data, (png_structp png_ptr,
1051 png_const_bytep data, png_size_t length));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001052
1053/* Finish a chunk started with png_write_chunk_start() (includes CRC). */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001054PNG_EXPORT(17, void, png_write_chunk_end, (png_structp png_ptr));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001055
Andreas Dilger47a0c421997-05-16 02:46:07 -05001056/* Allocate and initialize the info structure */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001057PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_structp png_ptr),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001058 PNG_ALLOCATED);
Guy Schalnat0d580581995-07-20 02:43:20 -05001059
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001060PNG_EXPORT(19, void, png_info_init_3, (png_infopp info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001061 png_size_t png_info_struct_size));
Guy Schalnat0d580581995-07-20 02:43:20 -05001062
Andreas Dilger47a0c421997-05-16 02:46:07 -05001063/* Writes all the PNG information before the image. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001064PNG_EXPORT(20, void, png_write_info_before_PLTE,
1065 (png_structp png_ptr, png_infop info_ptr));
1066PNG_EXPORT(21, void, png_write_info,
1067 (png_structp png_ptr, png_infop info_ptr));
Guy Schalnat0d580581995-07-20 02:43:20 -05001068
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001069#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001070/* Read the information before the actual image data. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001071PNG_EXPORT(22, void, png_read_info,
1072 (png_structp png_ptr, png_infop info_ptr));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001073#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001074
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001075#ifdef PNG_TIME_RFC1123_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001076PNG_EXPORT(23, png_const_charp, png_convert_to_rfc1123,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001077 (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001078 png_const_timep ptime));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001079#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001080
Glenn Randers-Pehrson0cb46e22009-11-02 11:24:33 -06001081#ifdef PNG_CONVERT_tIME_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001082/* Convert from a struct tm to png_time */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001083PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001084 PNG_CONST struct tm FAR * ttime));
Guy Schalnat0d580581995-07-20 02:43:20 -05001085
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001086/* Convert from time_t to png_time. Uses gmtime() */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001087PNG_EXPORT(25, void, png_convert_from_time_t,
1088 (png_timep ptime, time_t ttime));
Glenn Randers-Pehrson0cb46e22009-11-02 11:24:33 -06001089#endif /* PNG_CONVERT_tIME_SUPPORTED */
Guy Schalnat0d580581995-07-20 02:43:20 -05001090
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001091#ifdef PNG_READ_EXPAND_SUPPORTED
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001092/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001093PNG_EXPORT(26, void, png_set_expand, (png_structp png_ptr));
1094PNG_EXPORT(27, void, png_set_expand_gray_1_2_4_to_8, (png_structp png_ptr));
1095PNG_EXPORT(28, void, png_set_palette_to_rgb, (png_structp png_ptr));
1096PNG_EXPORT(29, void, png_set_tRNS_to_alpha, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001097#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001098
John Bowler4d562962011-02-12 09:01:20 -06001099#ifdef PNG_READ_EXPAND_16_SUPPORTED
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001100/* Expand to 16-bit channels, forces conversion of palette to RGB and expansion
John Bowler4d562962011-02-12 09:01:20 -06001101 * of a tRNS chunk if present.
1102 */
1103PNG_EXPORT(221, void, png_set_expand_16, (png_structp png_ptr));
1104#endif
1105
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001106#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
Guy Schalnat0d580581995-07-20 02:43:20 -05001107/* Use blue, green, red order for pixels. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001108PNG_EXPORT(30, void, png_set_bgr, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001109#endif
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001110
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001111#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001112/* Expand the grayscale to 24-bit RGB if necessary. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001113PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structp png_ptr));
John Bowlerf21a0d02011-01-23 23:55:19 -06001114#endif
Guy Schalnat69b14481996-01-10 02:56:49 -06001115
John Bowlerf21a0d02011-01-23 23:55:19 -06001116#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001117/* Reduce RGB to grayscale. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001118PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structp png_ptr,
1119 int error_action, double red, double green));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001120PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001121 int error_action, png_fixed_point red, png_fixed_point green));
Glenn Randers-Pehrsona272d8f2010-06-25 21:45:31 -05001122
John Bowler0a5c9c02011-01-22 17:36:34 -06001123PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structp
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001124 png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001125#endif
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001126
John Bowler4a12f4a2011-04-17 18:34:22 -05001127#ifdef PNG_BUILD_GRAYSCALE_PALETTE_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001128PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001129 png_colorp palette));
John Bowler4a12f4a2011-04-17 18:34:22 -05001130#endif
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001131
John Bowlerd273ad22011-05-07 21:00:28 -05001132#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
1133/* How the alpha channel is interpreted - this affects how the color channels of
Glenn Randers-Pehrson44e26d42011-05-08 22:56:42 -05001134 * a PNG file are returned when an alpha channel, or tRNS chunk in a palette
1135 * file, is present.
John Bowlerd273ad22011-05-07 21:00:28 -05001136 *
Glenn Randers-Pehrson44e26d42011-05-08 22:56:42 -05001137 * This has no effect on the way pixels are written into a PNG output
1138 * datastream. The color samples in a PNG datastream are never premultiplied
1139 * with the alpha samples.
1140 *
1141 * The default is to return data according to the PNG specification: the alpha
John Bowlerd273ad22011-05-07 21:00:28 -05001142 * channel is a linear measure of the contribution of the pixel to the
Glenn Randers-Pehrson44e26d42011-05-08 22:56:42 -05001143 * corresponding composited pixel. The gamma encoded color channels must be
1144 * scaled according to the contribution and to do this it is necessary to undo
1145 * the encoding, scale the color values, perform the composition and reencode
1146 * the values. This is the 'PNG' mode.
John Bowlerd273ad22011-05-07 21:00:28 -05001147 *
1148 * The alternative is to 'associate' the alpha with the color information by
1149 * storing color channel values that have been scaled by the alpha. The
1150 * advantage is that the color channels can be resampled (the image can be
1151 * scaled) in this form. The disadvantage is that normal practice is to store
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001152 * linear, not (gamma) encoded, values and this requires 16-bit channels for
1153 * still images rather than the 8-bit channels that are just about sufficient if
John Bowlerd273ad22011-05-07 21:00:28 -05001154 * gamma encoding is used. In addition all non-transparent pixel values,
1155 * including completely opaque ones, must be gamma encoded to produce the final
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001156 * image. This is the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' mode (the
John Bowlerd273ad22011-05-07 21:00:28 -05001157 * latter being the two common names for associated alpha color channels.)
1158 *
1159 * Since it is not necessary to perform arithmetic on opaque color values so
1160 * long as they are not to be resampled and are in the final color space it is
1161 * possible to optimize the handling of alpha by storing the opaque pixels in
1162 * the PNG format (adjusted for the output color space) while storing partially
1163 * opaque pixels in the standard, linear, format. The accuracy required for
1164 * standard alpha composition is relatively low, because the pixels are
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001165 * isolated, therefore typically the accuracy loss in storing 8-bit linear
John Bowlerd273ad22011-05-07 21:00:28 -05001166 * values is acceptable. (This is not true if the alpha channel is used to
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001167 * simulate transparency over large areas - use 16 bits or the PNG mode in
1168 * this case!) This is the 'OPTIMIZED' mode. For this mode a pixel is
John Bowlerd273ad22011-05-07 21:00:28 -05001169 * treated as opaque only if the alpha value is equal to the maximum value.
1170 *
1171 * The final choice is to gamma encode the alpha channel as well. This is
1172 * broken because, in practice, no implementation that uses this choice
1173 * correctly undoes the encoding before handling alpha composition. Use this
1174 * choice only if other serious errors in the software or hardware you use
1175 * mandate it; the typical serious error is for dark halos to appear around
1176 * opaque areas of the composited PNG image because of arithmetic overflow.
1177 *
1178 * The API function png_set_alpha_mode specifies which of these choices to use
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001179 * with an enumerated 'mode' value and the gamma of the required output:
John Bowlerd273ad22011-05-07 21:00:28 -05001180 */
1181#define PNG_ALPHA_PNG 0 /* according to the PNG standard */
1182#define PNG_ALPHA_STANDARD 1 /* according to Porter/Duff */
1183#define PNG_ALPHA_ASSOCIATED 1 /* as above; this is the normal practice */
1184#define PNG_ALPHA_PREMULTIPLIED 1 /* as above */
1185#define PNG_ALPHA_OPTIMIZED 2 /* 'PNG' for opaque pixels, else 'STANDARD' */
1186#define PNG_ALPHA_BROKEN 3 /* the alpha channel is gamma encoded */
1187
1188PNG_FP_EXPORT(227, void, png_set_alpha_mode, (png_structp png_ptr, int mode,
1189 double output_gamma));
1190PNG_FIXED_EXPORT(228, void, png_set_alpha_mode_fixed, (png_structp png_ptr,
1191 int mode, png_fixed_point output_gamma));
John Bowlerf70c7d02011-05-10 22:54:37 -05001192#endif
John Bowlerd273ad22011-05-07 21:00:28 -05001193
John Bowlerf70c7d02011-05-10 22:54:37 -05001194#if defined(PNG_READ_GAMMA_SUPPORTED) || defined(PNG_READ_ALPHA_MODE_SUPPORTED)
John Bowlerd273ad22011-05-07 21:00:28 -05001195/* The output_gamma value is a screen gamma in libpng terminology: it expresses
1196 * how to decode the output values, not how they are encoded. The values used
1197 * correspond to the normal numbers used to describe the overall gamma of a
1198 * computer display system; for example 2.2 for an sRGB conformant system. The
1199 * values are scaled by 100000 in the _fixed version of the API (so 220000 for
1200 * sRGB.)
1201 *
1202 * The inverse of the value is always used to provide a default for the PNG file
1203 * encoding if it has no gAMA chunk and if png_set_gamma() has not been called
1204 * to override the PNG gamma information.
1205 *
1206 * When the ALPHA_OPTIMIZED mode is selected the output gamma is used to encode
1207 * opaque pixels however pixels with lower alpha values are not encoded,
1208 * regardless of the output gamma setting.
1209 *
1210 * When the standard Porter Duff handling is requested with mode 1 the output
1211 * encoding is set to be linear and the output_gamma value is only relevant
1212 * as a default for input data that has no gamma information. The linear output
1213 * encoding will be overridden if png_set_gamma() is called - the results may be
1214 * highly unexpected!
1215 *
1216 * The following numbers are derived from the sRGB standard and the research
1217 * behind it. sRGB is defined to be approximated by a PNG gAMA chunk value of
1218 * 0.45455 (1/2.2) for PNG. The value implicitly includes any viewing
1219 * correction required to take account of any differences in the color
1220 * environment of the original scene and the intended display environment; the
1221 * value expresses how to *decode* the image for display, not how the original
1222 * data was *encoded*.
1223 *
1224 * sRGB provides a peg for the PNG standard by defining a viewing environment.
1225 * sRGB itself, and earlier TV standards, actually use a more complex transform
1226 * (a linear portion then a gamma 2.4 power law) than PNG can express. (PNG is
1227 * limited to simple power laws.) By saying that an image for direct display on
1228 * an sRGB conformant system should be stored with a gAMA chunk value of 45455
1229 * (11.3.3.2 and 11.3.3.5 of the ISO PNG specification) the PNG specification
1230 * makes it possible to derive values for other display systems and
1231 * environments.
1232 *
1233 * The Mac value is deduced from the sRGB based on an assumption that the actual
1234 * extra viewing correction used in early Mac display systems was implemented as
1235 * a power 1.45 lookup table.
1236 *
1237 * Any system where a programmable lookup table is used or where the behavior of
1238 * the final display device characteristics can be changed requires system
1239 * specific code to obtain the current characteristic. However this can be
1240 * difficult and most PNG gamma correction only requires an approximate value.
1241 *
1242 * By default, if png_set_alpha_mode() is not called, libpng assumes that all
1243 * values are unencoded, linear, values and that the output device also has a
1244 * linear characteristic. This is only very rarely correct - it is invariably
1245 * better to call png_set_alpha_mode() with PNG_DEFAULT_sRGB than rely on the
1246 * default if you don't know what the right answer is!
1247 *
John Bowlerf70c7d02011-05-10 22:54:37 -05001248 * The special value PNG_GAMMA_MAC_18 indicates an older Mac system (pre Mac OS
1249 * 10.6) which used a correction table to implement a somewhat lower gamma on an
1250 * otherwise sRGB system.
1251 *
1252 * Both these values are reserved (not simple gamma values) in order to allow
1253 * more precise correction internally in the future.
1254 *
John Bowlerd273ad22011-05-07 21:00:28 -05001255 * NOTE: the following values can be passed to either the fixed or floating
1256 * point APIs, but the floating point API will also accept floating point
1257 * values.
1258 */
John Bowlerf70c7d02011-05-10 22:54:37 -05001259#define PNG_DEFAULT_sRGB -1 /* sRGB gamma and color space */
1260#define PNG_GAMMA_MAC_18 -2 /* Old Mac '1.8' gamma and color space */
Glenn Randers-Pehrsonc7822512011-05-07 21:23:43 -05001261#define PNG_GAMMA_sRGB 220000 /* Television standards--matches sRGB gamma */
John Bowlerd273ad22011-05-07 21:00:28 -05001262#define PNG_GAMMA_LINEAR PNG_FP_1 /* Linear */
John Bowlerf70c7d02011-05-10 22:54:37 -05001263#endif
John Bowlerd273ad22011-05-07 21:00:28 -05001264
1265/* The following are examples of calls to png_set_alpha_mode to achieve the
1266 * required overall gamma correction and, where necessary, alpha
1267 * premultiplication.
1268 *
1269 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1270 * This is the default libpng handling of the alpha channel - it is not
1271 * pre-multiplied into the color components. In addition the call states
1272 * that the output is for a sRGB system and causes all PNG files without gAMA
1273 * chunks to be assumed to be encoded using sRGB.
1274 *
1275 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1276 * In this case the output is assumed to be something like an sRGB conformant
1277 * display preceeded by a power-law lookup table of power 1.45. This is how
1278 * early Mac systems behaved.
1279 *
Glenn Randers-Pehrsonc7822512011-05-07 21:23:43 -05001280 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);
John Bowlerd273ad22011-05-07 21:00:28 -05001281 * This is the classic Jim Blinn approach and will work in academic
1282 * environments where everything is done by the book. It has the shortcoming
1283 * of assuming that input PNG data with no gamma information is linear - this
1284 * is unlikely to be correct unless the PNG files where generated locally.
1285 * Most of the time the output precision will be so low as to show
1286 * significant banding in dark areas of the image.
1287 *
1288 * png_set_expand_16(pp);
1289 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB);
1290 * This is a somewhat more realistic Jim Blinn inspired approach. PNG files
1291 * are assumed to have the sRGB encoding if not marked with a gamma value and
1292 * the output is always 16 bits per component. This permits accurate scaling
1293 * and processing of the data. If you know that your input PNG files were
1294 * generated locally you might need to replace PNG_DEFAULT_sRGB with the
1295 * correct value for your system.
1296 *
1297 * png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB);
1298 * If you just need to composite the PNG image onto an existing background
1299 * and if you control the code that does this you can use the optimization
1300 * setting. In this case you just copy completely opaque pixels to the
1301 * output. For pixels that are not completely transparent (you just skip
1302 * those) you do the composition math using png_composite or png_composite_16
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001303 * below then encode the resultant 8-bit or 16-bit values to match the output
John Bowlerd273ad22011-05-07 21:00:28 -05001304 * encoding.
1305 *
1306 * Other cases
1307 * If neither the PNG nor the standard linear encoding work for you because
1308 * of the software or hardware you use then you have a big problem. The PNG
1309 * case will probably result in halos around the image. The linear encoding
1310 * will probably result in a washed out, too bright, image (it's actually too
1311 * contrasty.) Try the ALPHA_OPTIMIZED mode above - this will probably
1312 * substantially reduce the halos. Alternatively try:
1313 *
1314 * png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB);
1315 * This option will also reduce the halos, but there will be slight dark
1316 * halos round the opaque parts of the image where the background is light.
1317 * In the OPTIMIZED mode the halos will be light halos where the background
1318 * is dark. Take your pick - the halos are unavoidable unless you can get
1319 * your hardware/software fixed! (The OPTIMIZED approach is slightly
1320 * faster.)
1321 *
1322 * When the default gamma of PNG files doesn't match the output gamma.
1323 * If you have PNG files with no gamma information png_set_alpha_mode allows
1324 * you to provide a default gamma, but it also sets the ouput gamma to the
1325 * matching value. If you know your PNG files have a gamma that doesn't
1326 * match the output you can take advantage of the fact that
1327 * png_set_alpha_mode always sets the output gamma but only sets the PNG
1328 * default if it is not already set:
1329 *
1330 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1331 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1332 * The first call sets both the default and the output gamma values, the
1333 * second call overrides the output gamma without changing the default. This
1334 * is easier than achieving the same effect with png_set_gamma. You must use
1335 * PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will
1336 * fire if more than one call to png_set_alpha_mode and png_set_background is
1337 * made in the same read operation, however multiple calls with PNG_ALPHA_PNG
1338 * are ignored.
1339 */
John Bowlerd273ad22011-05-07 21:00:28 -05001340
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001341#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001342PNG_EXPORT(36, void, png_set_strip_alpha, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001343#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001344
1345#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
1346 defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001347PNG_EXPORT(37, void, png_set_swap_alpha, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001348#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001349
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -06001350#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
1351 defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001352PNG_EXPORT(38, void, png_set_invert_alpha, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001353#endif
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -06001354
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001355#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -05001356/* Add a filler byte to 8-bit Gray or 24-bit RGB images. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001357PNG_EXPORT(39, void, png_set_filler, (png_structp png_ptr, png_uint_32 filler,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001358 int flags));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001359/* The values of the PNG_FILLER_ defines should NOT be changed */
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06001360# define PNG_FILLER_BEFORE 0
1361# define PNG_FILLER_AFTER 1
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -05001362/* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001363PNG_EXPORT(40, void, png_set_add_alpha,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001364 (png_structp png_ptr, png_uint_32 filler,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001365 int flags));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001366#endif /* PNG_READ_FILLER_SUPPORTED || PNG_WRITE_FILLER_SUPPORTED */
Guy Schalnat0d580581995-07-20 02:43:20 -05001367
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001368#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001369/* Swap bytes in 16-bit depth files. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001370PNG_EXPORT(41, void, png_set_swap, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001371#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001372
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001373#if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED)
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001374/* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001375PNG_EXPORT(42, void, png_set_packing, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001376#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001377
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06001378#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
1379 defined(PNG_WRITE_PACKSWAP_SUPPORTED)
Andreas Dilger47a0c421997-05-16 02:46:07 -05001380/* Swap packing order of pixels in bytes. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001381PNG_EXPORT(43, void, png_set_packswap, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001382#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001383
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001384#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
Guy Schalnat0d580581995-07-20 02:43:20 -05001385/* Converts files to legal bit depths. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001386PNG_EXPORT(44, void, png_set_shift, (png_structp png_ptr, png_const_color_8p
1387 true_bits));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001388#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001389
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001390#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
1391 defined(PNG_WRITE_INTERLACING_SUPPORTED)
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001392/* Have the code handle the interlacing. Returns the number of passes.
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001393 * MUST be called before png_read_update_info or png_start_read_image,
1394 * otherwise it will not have the desired effect. Note that it is still
1395 * necessary to call png_read_row or png_read_rows png_get_image_height
1396 * times for each pass.
1397*/
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001398PNG_EXPORT(45, int, png_set_interlace_handling, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001399#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001400
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001401#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -05001402/* Invert monochrome files */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001403PNG_EXPORT(46, void, png_set_invert_mono, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001404#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001405
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001406#ifdef PNG_READ_BACKGROUND_SUPPORTED
John Bowlercb0b2962011-05-12 21:48:29 -05001407/* Handle alpha and tRNS by replacing with a background color. Prior to
Glenn Randers-Pehrsonef217b72011-06-15 12:58:27 -05001408 * libpng-1.5.4 this API must not be called before the PNG file header has been
John Bowlercb0b2962011-05-12 21:48:29 -05001409 * read. Doing so will result in unexpected behavior and possible warnings or
Glenn Randers-Pehrson1591a4c2011-05-16 09:07:26 -05001410 * errors if the PNG file contains a bKGD chunk.
John Bowlercb0b2962011-05-12 21:48:29 -05001411 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001412PNG_FP_EXPORT(47, void, png_set_background, (png_structp png_ptr,
1413 png_const_color_16p background_color, int background_gamma_code,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001414 int need_expand, double background_gamma));
John Bowler660c6e42010-12-19 06:22:23 -06001415PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001416 png_const_color_16p background_color, int background_gamma_code,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001417 int need_expand, png_fixed_point background_gamma));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001418#endif
1419#ifdef PNG_READ_BACKGROUND_SUPPORTED
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06001420# define PNG_BACKGROUND_GAMMA_UNKNOWN 0
1421# define PNG_BACKGROUND_GAMMA_SCREEN 1
1422# define PNG_BACKGROUND_GAMMA_FILE 2
1423# define PNG_BACKGROUND_GAMMA_UNIQUE 3
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001424#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001425
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001426#ifdef PNG_READ_16_TO_8_SUPPORTED
Glenn Randers-Pehrson5f0b9272011-06-16 09:05:40 -05001427# ifdef PNG_READ_16_TO_8_ACCURATE_SCALE_SUPPORTED
Glenn Randers-Pehrson413138a2011-06-13 22:07:37 -05001428/* Scale a 16-bit depth file down to 8-bit, accurately. */
Glenn Randers-Pehrsona7428d42011-06-17 19:07:04 -05001429PNG_EXPORT(48, void, png_set_scale_16, (png_structp png_ptr));
Glenn Randers-Pehrson5f0b9272011-06-16 09:05:40 -05001430# endif
Glenn Randers-Pehrsonab63dd02011-06-17 20:04:17 -05001431
1432# ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED
Glenn Randers-Pehrson413138a2011-06-13 22:07:37 -05001433/* Strip the second byte of information from a 16-bit depth file. */
Glenn Randers-Pehrsonab63dd02011-06-17 20:04:17 -05001434PNG_EXPORT(229, void, png_set_strip_16, (png_structp png_ptr));
Glenn Randers-Pehrson2232baa2011-06-14 06:59:46 -05001435# endif
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001436#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001437
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -05001438#ifdef PNG_READ_QUANTIZE_SUPPORTED
1439/* Turn on quantizing, and reduce the palette to the number of colors
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06001440 * available.
1441 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001442PNG_EXPORT(49, void, png_set_quantize,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001443 (png_structp png_ptr, png_colorp palette,
1444 int num_palette, int maximum_colors, png_const_uint_16p histogram,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001445 int full_quantize));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001446#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001447
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001448#ifdef PNG_READ_GAMMA_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001449/* The threshold on gamma processing is configurable but hard-wired into the
1450 * library. The following is the floating point variant.
1451 */
1452#define PNG_GAMMA_THRESHOLD (PNG_GAMMA_THRESHOLD_FIXED*.00001)
1453
John Bowlerd273ad22011-05-07 21:00:28 -05001454/* Handle gamma correction. Screen_gamma=(display_exponent).
Glenn Randers-Pehrsonc7822512011-05-07 21:23:43 -05001455 * NOTE: this API simply sets the screen and file gamma values. It will
John Bowlerd273ad22011-05-07 21:00:28 -05001456 * therefore override the value for gamma in a PNG file if it is called after
John Bowlerf70c7d02011-05-10 22:54:37 -05001457 * the file header has been read - use with care - call before reading the PNG
1458 * file for best results!
1459 *
1460 * These routines accept the same gamma values as png_set_alpha_mode (described
1461 * above). The PNG_GAMMA_ defines and PNG_DEFAULT_sRGB can be passed to either
1462 * API (floating point or fixed.) Notice, however, that the 'file_gamma' value
1463 * is the inverse of a 'screen gamma' value.
John Bowlerd273ad22011-05-07 21:00:28 -05001464 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001465PNG_FP_EXPORT(50, void, png_set_gamma,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001466 (png_structp png_ptr, double screen_gamma,
John Bowlerd273ad22011-05-07 21:00:28 -05001467 double override_file_gamma));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001468PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structp png_ptr,
John Bowlerd273ad22011-05-07 21:00:28 -05001469 png_fixed_point screen_gamma, png_fixed_point override_file_gamma));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001470#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001471
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001472#ifdef PNG_WRITE_FLUSH_SUPPORTED
Guy Schalnat0f716451995-11-28 11:22:13 -06001473/* Set how many lines between output flushes - 0 for no flushing */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001474PNG_EXPORT(51, void, png_set_flush, (png_structp png_ptr, int nrows));
Guy Schalnat0f716451995-11-28 11:22:13 -06001475/* Flush the current PNG output buffer */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001476PNG_EXPORT(52, void, png_write_flush, (png_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001477#endif
Guy Schalnat0f716451995-11-28 11:22:13 -06001478
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001479/* Optional update palette with requested transformations */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001480PNG_EXPORT(53, void, png_start_read_image, (png_structp png_ptr));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001481
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001482/* Optional call to update the users info structure */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001483PNG_EXPORT(54, void, png_read_update_info,
1484 (png_structp png_ptr, png_infop info_ptr));
Guy Schalnat0d580581995-07-20 02:43:20 -05001485
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001486#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001487/* Read one or more rows of image data. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001488PNG_EXPORT(55, void, png_read_rows, (png_structp png_ptr, png_bytepp row,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001489 png_bytepp display_row, png_uint_32 num_rows));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001490#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001491
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001492#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001493/* Read a row of data. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001494PNG_EXPORT(56, void, png_read_row, (png_structp png_ptr, png_bytep row,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001495 png_bytep display_row));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001496#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001497
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001498#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001499/* Read the whole image into memory at once. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001500PNG_EXPORT(57, void, png_read_image, (png_structp png_ptr, png_bytepp image));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001501#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001502
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001503/* Write a row of image data */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001504PNG_EXPORT(58, void, png_write_row,
1505 (png_structp png_ptr, png_const_bytep row));
Guy Schalnat0d580581995-07-20 02:43:20 -05001506
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001507/* Write a few rows of image data: (*row) is not written; however, the type
1508 * is declared as writeable to maintain compatibility with previous versions
1509 * of libpng and to allow the 'display_row' array from read_rows to be passed
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -05001510 * unchanged to write_rows.
1511 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001512PNG_EXPORT(59, void, png_write_rows, (png_structp png_ptr, png_bytepp row,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001513 png_uint_32 num_rows));
Guy Schalnat0d580581995-07-20 02:43:20 -05001514
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001515/* Write the image data */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001516PNG_EXPORT(60, void, png_write_image,
1517 (png_structp png_ptr, png_bytepp image));
Guy Schalnat0d580581995-07-20 02:43:20 -05001518
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001519/* Write the end of the PNG file. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001520PNG_EXPORT(61, void, png_write_end,
1521 (png_structp png_ptr, png_infop info_ptr));
Guy Schalnat0d580581995-07-20 02:43:20 -05001522
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001523#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001524/* Read the end of the PNG file. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001525PNG_EXPORT(62, void, png_read_end, (png_structp png_ptr, png_infop info_ptr));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001526#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001527
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001528/* Free any memory associated with the png_info_struct */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001529PNG_EXPORT(63, void, png_destroy_info_struct, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001530 png_infopp info_ptr_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001531
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001532/* Free any memory associated with the png_struct and the png_info_structs */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001533PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001534 png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001535
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001536/* Free any memory associated with the png_struct and the png_info_structs */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001537PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001538 png_infopp info_ptr_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001539
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001540/* Set the libpng method of handling chunk CRC errors */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001541PNG_EXPORT(66, void, png_set_crc_action,
1542 (png_structp png_ptr, int crit_action, int ancil_action));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001543
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001544/* Values for png_set_crc_action() say how to handle CRC errors in
Andreas Dilger47a0c421997-05-16 02:46:07 -05001545 * ancillary and critical chunks, and whether to use the data contained
1546 * therein. Note that it is impossible to "discard" data in a critical
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001547 * chunk. For versions prior to 0.90, the action was always error/quit,
Andreas Dilger47a0c421997-05-16 02:46:07 -05001548 * whereas in version 0.90 and later, the action for CRC errors in ancillary
1549 * chunks is warn/discard. These values should NOT be changed.
1550 *
1551 * value action:critical action:ancillary
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001552 */
1553#define PNG_CRC_DEFAULT 0 /* error/quit warn/discard data */
1554#define PNG_CRC_ERROR_QUIT 1 /* error/quit error/quit */
1555#define PNG_CRC_WARN_DISCARD 2 /* (INVALID) warn/discard data */
1556#define PNG_CRC_WARN_USE 3 /* warn/use data warn/use data */
1557#define PNG_CRC_QUIET_USE 4 /* quiet/use data quiet/use data */
1558#define PNG_CRC_NO_CHANGE 5 /* use current value use current value */
1559
Andreas Dilger47a0c421997-05-16 02:46:07 -05001560/* These functions give the user control over the scan-line filtering in
1561 * libpng and the compression methods used by zlib. These functions are
1562 * mainly useful for testing, as the defaults should work with most users.
1563 * Those users who are tight on memory or want faster performance at the
1564 * expense of compression can modify them. See the compression library
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001565 * header file (zlib.h) for an explination of the compression functions.
1566 */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001567
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001568/* Set the filtering method(s) used by libpng. Currently, the only valid
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001569 * value for "method" is 0.
1570 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001571PNG_EXPORT(67, void, png_set_filter,
1572 (png_structp png_ptr, int method, int filters));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001573
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001574/* Flags for png_set_filter() to say which filters to use. The flags
Andreas Dilger47a0c421997-05-16 02:46:07 -05001575 * are chosen so that they don't conflict with real filter types
1576 * below, in case they are supplied instead of the #defined constants.
1577 * These values should NOT be changed.
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001578 */
1579#define PNG_NO_FILTERS 0x00
1580#define PNG_FILTER_NONE 0x08
1581#define PNG_FILTER_SUB 0x10
1582#define PNG_FILTER_UP 0x20
1583#define PNG_FILTER_AVG 0x40
1584#define PNG_FILTER_PAETH 0x80
1585#define PNG_ALL_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP | \
1586 PNG_FILTER_AVG | PNG_FILTER_PAETH)
1587
Andreas Dilger47a0c421997-05-16 02:46:07 -05001588/* Filter values (not flags) - used in pngwrite.c, pngwutil.c for now.
1589 * These defines should NOT be changed.
1590 */
1591#define PNG_FILTER_VALUE_NONE 0
1592#define PNG_FILTER_VALUE_SUB 1
1593#define PNG_FILTER_VALUE_UP 2
1594#define PNG_FILTER_VALUE_AVG 3
1595#define PNG_FILTER_VALUE_PAETH 4
1596#define PNG_FILTER_VALUE_LAST 5
1597
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001598#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */
Andreas Dilger47a0c421997-05-16 02:46:07 -05001599/* The "heuristic_method" is given by one of the PNG_FILTER_HEURISTIC_
1600 * defines, either the default (minimum-sum-of-absolute-differences), or
1601 * the experimental method (weighted-minimum-sum-of-absolute-differences).
1602 *
1603 * Weights are factors >= 1.0, indicating how important it is to keep the
1604 * filter type consistent between rows. Larger numbers mean the current
1605 * filter is that many times as likely to be the same as the "num_weights"
1606 * previous filters. This is cumulative for each previous row with a weight.
1607 * There needs to be "num_weights" values in "filter_weights", or it can be
1608 * NULL if the weights aren't being specified. Weights have no influence on
1609 * the selection of the first row filter. Well chosen weights can (in theory)
1610 * improve the compression for a given image.
1611 *
1612 * Costs are factors >= 1.0 indicating the relative decoding costs of a
1613 * filter type. Higher costs indicate more decoding expense, and are
1614 * therefore less likely to be selected over a filter with lower computational
1615 * costs. There needs to be a value in "filter_costs" for each valid filter
1616 * type (given by PNG_FILTER_VALUE_LAST), or it can be NULL if you aren't
1617 * setting the costs. Costs try to improve the speed of decompression without
1618 * unduly increasing the compressed image size.
1619 *
1620 * A negative weight or cost indicates the default value is to be used, and
1621 * values in the range [0.0, 1.0) indicate the value is to remain unchanged.
1622 * The default values for both weights and costs are currently 1.0, but may
1623 * change if good general weighting/cost heuristics can be found. If both
1624 * the weights and costs are set to 1.0, this degenerates the WEIGHTED method
1625 * to the UNWEIGHTED method, but with added encoding time/computation.
1626 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001627PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structp png_ptr,
1628 int heuristic_method, int num_weights, png_const_doublep filter_weights,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001629 png_const_doublep filter_costs));
1630PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001631 (png_structp png_ptr,
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -05001632 int heuristic_method, int num_weights, png_const_fixed_point_p
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001633 filter_weights, png_const_fixed_point_p filter_costs));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001634#endif /* PNG_WRITE_WEIGHTED_FILTER_SUPPORTED */
1635
1636/* Heuristic used for row filter selection. These defines should NOT be
1637 * changed.
1638 */
1639#define PNG_FILTER_HEURISTIC_DEFAULT 0 /* Currently "UNWEIGHTED" */
1640#define PNG_FILTER_HEURISTIC_UNWEIGHTED 1 /* Used by libpng < 0.95 */
1641#define PNG_FILTER_HEURISTIC_WEIGHTED 2 /* Experimental feature */
1642#define PNG_FILTER_HEURISTIC_LAST 3 /* Not a valid value */
1643
John Bowlerc5bef942011-05-05 17:35:39 -05001644#ifdef PNG_WRITE_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001645/* Set the library compression level. Currently, valid values range from
1646 * 0 - 9, corresponding directly to the zlib compression levels 0 - 9
1647 * (0 - no compression, 9 - "maximal" compression). Note that tests have
1648 * shown that zlib compression levels 3-6 usually perform as well as level 9
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001649 * for PNG images, and do considerably fewer caclulations. In the future,
Andreas Dilger47a0c421997-05-16 02:46:07 -05001650 * these values may not correspond directly to the zlib compression levels.
1651 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001652PNG_EXPORT(69, void, png_set_compression_level,
1653 (png_structp png_ptr, int level));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001654
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001655PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001656 int mem_level));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001657
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001658PNG_EXPORT(71, void, png_set_compression_strategy, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001659 int strategy));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001660
Glenn Randers-Pehrsonaf855e42011-05-07 10:52:49 -05001661/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1662 * smaller value of window_bits if it can do so safely.
1663 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001664PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001665 int window_bits));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001666
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001667PNG_EXPORT(73, void, png_set_compression_method, (png_structp png_ptr,
1668 int method));
John Bowlerc5bef942011-05-05 17:35:39 -05001669#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001670
John Bowlerb2bee332011-06-10 23:24:58 -05001671#ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001672/* Also set zlib parameters for compressing non-IDAT chunks */
1673PNG_EXPORT(222, void, png_set_text_compression_level,
1674 (png_structp png_ptr, int level));
1675
1676PNG_EXPORT(223, void, png_set_text_compression_mem_level, (png_structp png_ptr,
1677 int mem_level));
1678
1679PNG_EXPORT(224, void, png_set_text_compression_strategy, (png_structp png_ptr,
1680 int strategy));
1681
Glenn Randers-Pehrsonaf855e42011-05-07 10:52:49 -05001682/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1683 * smaller value of window_bits if it can do so safely.
1684 */
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001685PNG_EXPORT(225, void, png_set_text_compression_window_bits, (png_structp
1686 png_ptr, int window_bits));
1687
1688PNG_EXPORT(226, void, png_set_text_compression_method, (png_structp png_ptr,
1689 int method));
John Bowlerb2bee332011-06-10 23:24:58 -05001690#endif /* PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED */
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001691
Guy Schalnate5a37791996-06-05 15:50:50 -05001692/* These next functions are called for input/output, memory, and error
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001693 * handling. They are in the file pngrio.c, pngwio.c, and pngerror.c,
Andreas Dilger47a0c421997-05-16 02:46:07 -05001694 * and call standard C I/O routines such as fread(), fwrite(), and
1695 * fprintf(). These functions can be made to use other I/O routines
1696 * at run time for those applications that need to handle I/O in a
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -05001697 * different manner by calling png_set_???_fn(). See libpng-manual.txt for
Andreas Dilger47a0c421997-05-16 02:46:07 -05001698 * more information.
1699 */
Guy Schalnat0d580581995-07-20 02:43:20 -05001700
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001701#ifdef PNG_STDIO_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001702/* Initialize the input/output for the PNG file to the default functions. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001703PNG_EXPORT(74, void, png_init_io, (png_structp png_ptr, png_FILE_p fp));
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001704#endif
Guy Schalnat6d764711995-12-19 03:22:19 -06001705
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001706/* Replace the (error and abort), and warning functions with user
Andreas Dilger47a0c421997-05-16 02:46:07 -05001707 * supplied functions. If no messages are to be printed you must still
1708 * write and use replacement functions. The replacement error_fn should
1709 * still do a longjmp to the last setjmp location if you are using this
1710 * method of error handling. If error_fn or warning_fn is NULL, the
1711 * default function will be used.
1712 */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001713
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001714PNG_EXPORT(75, void, png_set_error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001715 (png_structp png_ptr, png_voidp error_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001716 png_error_ptr error_fn, png_error_ptr warning_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001717
Guy Schalnate5a37791996-06-05 15:50:50 -05001718/* Return the user pointer associated with the error functions */
John Bowler0a5c9c02011-01-22 17:36:34 -06001719PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structp png_ptr));
Guy Schalnat6d764711995-12-19 03:22:19 -06001720
1721/* Replace the default data output functions with a user supplied one(s).
Andreas Dilger47a0c421997-05-16 02:46:07 -05001722 * If buffered output is not used, then output_flush_fn can be set to NULL.
1723 * If PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile time
1724 * output_flush_fn will be ignored (and thus can be NULL).
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -05001725 * It is probably a mistake to use NULL for output_flush_fn if
1726 * write_data_fn is not also NULL unless you have built libpng with
1727 * PNG_WRITE_FLUSH_SUPPORTED undefined, because in this case libpng's
1728 * default flush function, which uses the standard *FILE structure, will
1729 * be used.
Andreas Dilger47a0c421997-05-16 02:46:07 -05001730 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001731PNG_EXPORT(77, void, png_set_write_fn, (png_structp png_ptr, png_voidp io_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001732 png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001733
1734/* Replace the default data input function with a user supplied one. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001735PNG_EXPORT(78, void, png_set_read_fn, (png_structp png_ptr, png_voidp io_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001736 png_rw_ptr read_data_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001737
1738/* Return the user pointer associated with the I/O functions */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001739PNG_EXPORT(79, png_voidp, png_get_io_ptr, (png_structp png_ptr));
Guy Schalnat6d764711995-12-19 03:22:19 -06001740
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001741PNG_EXPORT(80, void, png_set_read_status_fn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001742 png_read_status_ptr read_row_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001743
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001744PNG_EXPORT(81, void, png_set_write_status_fn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001745 png_write_status_ptr write_row_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001746
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001747#ifdef PNG_USER_MEM_SUPPORTED
1748/* Replace the default memory allocation functions with user supplied one(s). */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001749PNG_EXPORT(82, void, png_set_mem_fn, (png_structp png_ptr, png_voidp mem_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001750 png_malloc_ptr malloc_fn, png_free_ptr free_fn));
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001751/* Return the user pointer associated with the memory functions */
John Bowler0a5c9c02011-01-22 17:36:34 -06001752PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001753#endif
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001754
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -05001755#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001756PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001757 png_user_transform_ptr read_user_transform_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001758#endif
1759
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -05001760#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001761PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001762 png_user_transform_ptr write_user_transform_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001763#endif
1764
John Bowler0a5c9c02011-01-22 17:36:34 -06001765#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001766PNG_EXPORT(86, void, png_set_user_transform_info, (png_structp png_ptr,
1767 png_voidp user_transform_ptr, int user_transform_depth,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001768 int user_transform_channels));
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001769/* Return the user pointer associated with the user transform functions */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001770PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001771 (png_const_structp png_ptr));
1772#endif
1773
1774#ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED
1775/* Return information about the row currently being processed. Note that these
1776 * APIs do not fail but will return unexpected results if called outside a user
1777 * transform callback. Also note that when transforming an interlaced image the
John Bowler9616ad92011-02-16 06:13:46 -06001778 * row number is the row number within the sub-image of the interlace pass, so
1779 * the value will increase to the height of the sub-image (not the full image)
1780 * then reset to 0 for the next pass.
John Bowler5432c012011-02-12 08:59:17 -06001781 *
John Bowler9616ad92011-02-16 06:13:46 -06001782 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
1783 * find the output pixel (x,y) given an interlaced sub-image pixel
1784 * (row,col,pass). (See below for these macros.)
John Bowler0a5c9c02011-01-22 17:36:34 -06001785 */
1786PNG_EXPORT(217, png_uint_32, png_get_current_row_number, (png_const_structp));
1787PNG_EXPORT(218, png_byte, png_get_current_pass_number, (png_const_structp));
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001788#endif
1789
Glenn Randers-Pehrson19095602001-03-14 07:08:39 -06001790#ifdef PNG_USER_CHUNKS_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001791PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001792 png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn));
John Bowler0a5c9c02011-01-22 17:36:34 -06001793PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structp png_ptr));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001794#endif
1795
Guy Schalnat4ee97b01996-01-16 01:51:56 -06001796#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001797/* Sets the function callbacks for the push reader, and a pointer to a
1798 * user-defined structure available to the callback functions.
1799 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001800PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structp png_ptr,
1801 png_voidp progressive_ptr, png_progressive_info_ptr info_fn,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001802 png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001803
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001804/* Returns the user pointer associated with the push read functions */
John Bowler0a5c9c02011-01-22 17:36:34 -06001805PNG_EXPORT(91, png_voidp, png_get_progressive_ptr, (png_const_structp png_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001806
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001807/* Function to be called when data becomes available */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001808PNG_EXPORT(92, void, png_process_data,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001809 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001810 png_bytep buffer, png_size_t buffer_size));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001811
John Bowler0a5c9c02011-01-22 17:36:34 -06001812/* A function which may be called *only* within png_process_data to stop the
1813 * processing of any more data. The function returns the number of bytes
1814 * remaining, excluding any that libpng has cached internally. A subsequent
1815 * call to png_process_data must supply these bytes again. If the argument
1816 * 'save' is set to true the routine will first save all the pending data and
1817 * will always return 0.
1818 */
1819PNG_EXPORT(219, png_size_t, png_process_data_pause, (png_structp, int save));
1820
1821/* A function which may be called *only* outside (after) a call to
1822 * png_process_data. It returns the number of bytes of data to skip in the
1823 * input. Normally it will return 0, but if it returns a non-zero value the
1824 * application must skip than number of bytes of input data and pass the
1825 * following data to the next call to png_process_data.
1826 */
1827PNG_EXPORT(220, png_uint_32, png_process_data_skip, (png_structp));
1828
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001829/* Function that combines rows. 'new_row' is a flag that should come from
1830 * the callback and be non-NULL if anything needs to be done; the library
1831 * stores its own version of the new data internally and ignores the passed
1832 * in value.
Andreas Dilger47a0c421997-05-16 02:46:07 -05001833 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001834PNG_EXPORT(93, void, png_progressive_combine_row, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001835 png_bytep old_row, png_const_bytep new_row));
Guy Schalnat4ee97b01996-01-16 01:51:56 -06001836#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */
Guy Schalnat6d764711995-12-19 03:22:19 -06001837
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001838PNG_EXPORTA(94, png_voidp, png_malloc,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001839 (png_structp png_ptr, png_alloc_size_t size),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001840 PNG_ALLOCATED);
Glenn Randers-Pehrson0ffb71a2009-02-28 06:08:20 -06001841/* Added at libpng version 1.4.0 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001842PNG_EXPORTA(95, png_voidp, png_calloc,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001843 (png_structp png_ptr, png_alloc_size_t size),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001844 PNG_ALLOCATED);
Guy Schalnat0d580581995-07-20 02:43:20 -05001845
Glenn Randers-Pehrson07748d12002-05-25 11:12:10 -05001846/* Added at libpng version 1.2.4 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001847PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001848 png_alloc_size_t size), PNG_ALLOCATED);
Glenn Randers-Pehrson07748d12002-05-25 11:12:10 -05001849
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05001850/* Frees a pointer allocated by png_malloc() */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001851PNG_EXPORT(97, void, png_free, (png_structp png_ptr, png_voidp ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001852
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001853/* Free data that was allocated internally */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001854PNG_EXPORT(98, void, png_free_data,
1855 (png_structp png_ptr, png_infop info_ptr, png_uint_32 free_me, int num));
1856
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001857/* Reassign responsibility for freeing existing data, whether allocated
1858 * by libpng or by the application */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001859PNG_EXPORT(99, void, png_data_freer,
1860 (png_structp png_ptr, png_infop info_ptr, int freer, png_uint_32 mask));
1861
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001862/* Assignments for png_data_freer */
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001863#define PNG_DESTROY_WILL_FREE_DATA 1
1864#define PNG_SET_WILL_FREE_DATA 1
1865#define PNG_USER_WILL_FREE_DATA 2
1866/* Flags for png_ptr->free_me and info_ptr->free_me */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001867#define PNG_FREE_HIST 0x0008
1868#define PNG_FREE_ICCP 0x0010
1869#define PNG_FREE_SPLT 0x0020
1870#define PNG_FREE_ROWS 0x0040
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001871#define PNG_FREE_PCAL 0x0080
1872#define PNG_FREE_SCAL 0x0100
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001873#define PNG_FREE_UNKN 0x0200
1874#define PNG_FREE_LIST 0x0400
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -05001875#define PNG_FREE_PLTE 0x1000
1876#define PNG_FREE_TRNS 0x2000
1877#define PNG_FREE_TEXT 0x4000
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001878#define PNG_FREE_ALL 0x7fff
Glenn Randers-Pehrsonec61c232000-05-16 06:17:36 -05001879#define PNG_FREE_MUL 0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001880
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001881#ifdef PNG_USER_MEM_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001882PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001883 png_alloc_size_t size), PNG_ALLOCATED);
1884PNG_EXPORT(101, void, png_free_default, (png_structp png_ptr, png_voidp ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001885#endif
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001886
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001887#ifdef PNG_ERROR_TEXT_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001888/* Fatal error in PNG image of libpng - can't continue */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001889PNG_EXPORTA(102, void, png_error,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001890 (png_structp png_ptr, png_const_charp error_message),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001891 PNG_NORETURN);
Guy Schalnat0d580581995-07-20 02:43:20 -05001892
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001893/* The same, but the chunk name is prepended to the error string. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001894PNG_EXPORTA(103, void, png_chunk_error, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001895 png_const_charp error_message), PNG_NORETURN);
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001896
Glenn Randers-Pehrsonfd107532009-11-10 05:59:22 -06001897#else
1898/* Fatal error in PNG image of libpng - can't continue */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001899PNG_EXPORTA(104, void, png_err, (png_structp png_ptr), PNG_NORETURN);
Glenn Randers-Pehrsonfd107532009-11-10 05:59:22 -06001900#endif
1901
John Bowler88b77cc2011-05-05 06:49:55 -05001902#ifdef PNG_WARNINGS_SUPPORTED
Guy Schalnat6d764711995-12-19 03:22:19 -06001903/* Non-fatal error in libpng. Can continue, but may have a problem. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001904PNG_EXPORT(105, void, png_warning, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001905 png_const_charp warning_message));
Guy Schalnat0d580581995-07-20 02:43:20 -05001906
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001907/* Non-fatal error in libpng, chunk name is prepended to message. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001908PNG_EXPORT(106, void, png_chunk_warning, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001909 png_const_charp warning_message));
John Bowler88b77cc2011-05-05 06:49:55 -05001910#endif
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001911
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001912#ifdef PNG_BENIGN_ERRORS_SUPPORTED
1913/* Benign error in libpng. Can continue, but may have a problem.
1914 * User can choose whether to handle as a fatal error or as a warning. */
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001915# undef png_benign_error
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001916PNG_EXPORT(107, void, png_benign_error, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001917 png_const_charp warning_message));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001918
1919/* Same, chunk name is prepended to message. */
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001920# undef png_chunk_benign_error
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001921PNG_EXPORT(108, void, png_chunk_benign_error, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001922 png_const_charp warning_message));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001923
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001924PNG_EXPORT(109, void, png_set_benign_errors,
1925 (png_structp png_ptr, int allowed));
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001926#else
1927# ifdef PNG_ALLOW_BENIGN_ERRORS
1928# define png_benign_error png_warning
1929# define png_chunk_benign_error png_chunk_warning
1930# else
1931# define png_benign_error png_error
1932# define png_chunk_benign_error png_chunk_error
1933# endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001934#endif
1935
Andreas Dilger47a0c421997-05-16 02:46:07 -05001936/* The png_set_<chunk> functions are for storing values in the png_info_struct.
1937 * Similarly, the png_get_<chunk> calls are used to read values from the
1938 * png_info_struct, either storing the parameters in the passed variables, or
1939 * setting pointers into the png_info_struct where the data is stored. The
1940 * png_get_<chunk> functions return a non-zero value if the data was available
1941 * in info_ptr, or return zero and do not change any of the parameters if the
1942 * data was not available.
1943 *
1944 * These functions should be used instead of directly accessing png_info
1945 * to avoid problems with future changes in the size and internal layout of
1946 * png_info_struct.
1947 */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001948/* Returns "flag" if chunk data is valid in info_ptr. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001949PNG_EXPORT(110, png_uint_32, png_get_valid,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001950 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001951 png_uint_32 flag));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001952
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001953/* Returns number of bytes needed to hold a transformed row. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001954PNG_EXPORT(111, png_size_t, png_get_rowbytes, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001955 png_const_infop info_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001956
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001957#ifdef PNG_INFO_IMAGE_SUPPORTED
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001958/* Returns row_pointers, which is an array of pointers to scanlines that was
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001959 * returned from png_read_png().
1960 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001961PNG_EXPORT(112, png_bytepp, png_get_rows,
John Bowler0a5c9c02011-01-22 17:36:34 -06001962 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001963/* Set row_pointers, which is an array of pointers to scanlines for use
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001964 * by png_write_png().
1965 */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001966PNG_EXPORT(113, void, png_set_rows, (png_structp png_ptr,
1967 png_infop info_ptr, png_bytepp row_pointers));
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001968#endif
1969
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001970/* Returns number of color channels in image. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001971PNG_EXPORT(114, png_byte, png_get_channels,
John Bowler0a5c9c02011-01-22 17:36:34 -06001972 (png_const_structp png_ptr, png_const_infop info_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001973
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001974#ifdef PNG_EASY_ACCESS_SUPPORTED
1975/* Returns image width in pixels. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001976PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001977 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001978
1979/* Returns image height in pixels. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001980PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001981 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001982
1983/* Returns image bit_depth. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001984PNG_EXPORT(117, png_byte, png_get_bit_depth,
John Bowler0a5c9c02011-01-22 17:36:34 -06001985 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001986
1987/* Returns image color_type. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001988PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001989 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001990
1991/* Returns image filter_type. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001992PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001993 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001994
1995/* Returns image interlace_type. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001996PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06001997 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001998
1999/* Returns image compression_type. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002000PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002001 png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002002
2003/* Returns image resolution in pixels per meter, from pHYs chunk data. */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002004PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter,
John Bowler0a5c9c02011-01-22 17:36:34 -06002005 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002006PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter,
John Bowler0a5c9c02011-01-22 17:36:34 -06002007 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002008PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter,
John Bowler0a5c9c02011-01-22 17:36:34 -06002009 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002010
2011/* Returns pixel aspect ratio, computed from pHYs chunk data. */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002012PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio,
John Bowler0a5c9c02011-01-22 17:36:34 -06002013 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002014PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed,
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 x, y offset in pixels or microns, from oFFs chunk data. */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002018PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels,
John Bowler0a5c9c02011-01-22 17:36:34 -06002019 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002020PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels,
John Bowler0a5c9c02011-01-22 17:36:34 -06002021 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002022PNG_EXPORT(128, png_int_32, png_get_x_offset_microns,
John Bowler0a5c9c02011-01-22 17:36:34 -06002023 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002024PNG_EXPORT(129, png_int_32, png_get_y_offset_microns,
John Bowler0a5c9c02011-01-22 17:36:34 -06002025 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002026
2027#endif /* PNG_EASY_ACCESS_SUPPORTED */
2028
Andreas Dilger47a0c421997-05-16 02:46:07 -05002029/* Returns pointer to signature string read from PNG header */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002030PNG_EXPORT(130, png_const_bytep, png_get_signature,
John Bowler0a5c9c02011-01-22 17:36:34 -06002031 (png_const_structp png_ptr, png_infop info_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002032
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002033#ifdef PNG_bKGD_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002034PNG_EXPORT(131, png_uint_32, png_get_bKGD,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002035 (png_const_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002036 png_color_16p *background));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002037#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002038
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002039#ifdef PNG_bKGD_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002040PNG_EXPORT(132, void, png_set_bKGD, (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002041 png_const_color_16p background));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002042#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002043
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002044#ifdef PNG_cHRM_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002045PNG_FP_EXPORT(133, png_uint_32, png_get_cHRM, (png_const_structp png_ptr,
2046 png_const_infop info_ptr, double *white_x, double *white_y, double *red_x,
2047 double *red_y, double *green_x, double *green_y, double *blue_x,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002048 double *blue_y));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002049#ifdef PNG_FIXED_POINT_SUPPORTED /* Otherwise not implemented */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002050PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002051 (png_const_structp png_ptr,
2052 png_const_infop info_ptr, png_fixed_point *int_white_x,
2053 png_fixed_point *int_white_y, png_fixed_point *int_red_x,
2054 png_fixed_point *int_red_y, png_fixed_point *int_green_x,
2055 png_fixed_point *int_green_y, png_fixed_point *int_blue_x,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002056 png_fixed_point *int_blue_y));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002057#endif
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002058#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002059
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002060#ifdef PNG_cHRM_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002061PNG_FP_EXPORT(135, void, png_set_cHRM,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002062 (png_structp png_ptr, png_infop info_ptr,
2063 double white_x, double white_y, double red_x, double red_y, double green_x,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002064 double green_y, double blue_x, double blue_y));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002065PNG_FIXED_EXPORT(136, void, png_set_cHRM_fixed, (png_structp png_ptr,
2066 png_infop info_ptr, png_fixed_point int_white_x,
2067 png_fixed_point int_white_y, png_fixed_point int_red_x,
2068 png_fixed_point int_red_y, png_fixed_point int_green_x,
2069 png_fixed_point int_green_y, png_fixed_point int_blue_x,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002070 png_fixed_point int_blue_y));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002071#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002072
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002073#ifdef PNG_gAMA_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002074PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002075 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002076 double *file_gamma));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002077PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed,
John Bowler0a5c9c02011-01-22 17:36:34 -06002078 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002079 png_fixed_point *int_file_gamma));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002080#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002081
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002082#ifdef PNG_gAMA_SUPPORTED
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002083PNG_FP_EXPORT(139, void, png_set_gAMA, (png_structp png_ptr,
2084 png_infop info_ptr, double file_gamma));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002085PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002086 png_infop info_ptr, png_fixed_point int_file_gamma));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002087#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002088
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002089#ifdef PNG_hIST_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002090PNG_EXPORT(141, png_uint_32, png_get_hIST,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002091 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002092 png_uint_16p *hist));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002093#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002094
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002095#ifdef PNG_hIST_SUPPORTED
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002096PNG_EXPORT(142, void, png_set_hIST, (png_structp png_ptr,
2097 png_infop info_ptr, png_const_uint_16p hist));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002098#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002099
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002100PNG_EXPORT(143, png_uint_32, png_get_IHDR,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002101 (png_structp png_ptr, png_infop info_ptr,
2102 png_uint_32 *width, png_uint_32 *height, int *bit_depth, int *color_type,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002103 int *interlace_method, int *compression_method, int *filter_method));
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002104
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002105PNG_EXPORT(144, void, png_set_IHDR,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002106 (png_structp png_ptr, png_infop info_ptr,
2107 png_uint_32 width, png_uint_32 height, int bit_depth, int color_type,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002108 int interlace_method, int compression_method, int filter_method));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002109
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002110#ifdef PNG_oFFs_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002111PNG_EXPORT(145, png_uint_32, png_get_oFFs,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002112 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002113 png_int_32 *offset_x, png_int_32 *offset_y, int *unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002114#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002115
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002116#ifdef PNG_oFFs_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002117PNG_EXPORT(146, void, png_set_oFFs,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002118 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002119 png_int_32 offset_x, png_int_32 offset_y, int unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002120#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002121
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002122#ifdef PNG_pCAL_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002123PNG_EXPORT(147, png_uint_32, png_get_pCAL,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002124 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002125 png_charp *purpose, png_int_32 *X0, png_int_32 *X1, int *type,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002126 int *nparams,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002127 png_charp *units, png_charpp *params));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002128#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002129
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002130#ifdef PNG_pCAL_SUPPORTED
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002131PNG_EXPORT(148, void, png_set_pCAL, (png_structp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002132 png_infop info_ptr,
2133 png_const_charp purpose, png_int_32 X0, png_int_32 X1, int type,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002134 int nparams, png_const_charp units, png_charpp params));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002135#endif
2136
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002137#ifdef PNG_pHYs_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002138PNG_EXPORT(149, png_uint_32, png_get_pHYs,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002139 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002140 png_uint_32 *res_x, png_uint_32 *res_y, int *unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002141#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002142
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002143#ifdef PNG_pHYs_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002144PNG_EXPORT(150, void, png_set_pHYs,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002145 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002146 png_uint_32 res_x, png_uint_32 res_y, int unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002147#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002148
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002149PNG_EXPORT(151, png_uint_32, png_get_PLTE,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002150 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002151 png_colorp *palette, int *num_palette));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002152
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002153PNG_EXPORT(152, void, png_set_PLTE,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002154 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002155 png_const_colorp palette, int num_palette));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002156
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002157#ifdef PNG_sBIT_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002158PNG_EXPORT(153, png_uint_32, png_get_sBIT,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002159 (png_const_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002160 png_color_8p *sig_bit));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002161#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002162
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002163#ifdef PNG_sBIT_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002164PNG_EXPORT(154, void, png_set_sBIT,
2165 (png_structp png_ptr, png_infop info_ptr, png_const_color_8p sig_bit));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002166#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002167
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002168#ifdef PNG_sRGB_SUPPORTED
John Bowler0a5c9c02011-01-22 17:36:34 -06002169PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structp png_ptr,
Glenn Randers-Pehrson8d0bc0f2011-01-25 22:15:58 -06002170 png_const_infop info_ptr, int *file_srgb_intent));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002171#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06002172
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002173#ifdef PNG_sRGB_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002174PNG_EXPORT(156, void, png_set_sRGB,
Glenn Randers-Pehrson8d0bc0f2011-01-25 22:15:58 -06002175 (png_structp png_ptr, png_infop info_ptr, int srgb_intent));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002176PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_structp png_ptr,
Glenn Randers-Pehrson8d0bc0f2011-01-25 22:15:58 -06002177 png_infop info_ptr, int srgb_intent));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002178#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06002179
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002180#ifdef PNG_iCCP_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002181PNG_EXPORT(158, png_uint_32, png_get_iCCP,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002182 (png_const_structp png_ptr, png_const_infop info_ptr,
2183 png_charpp name, int *compression_type, png_bytepp profile,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002184 png_uint_32 *proflen));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002185#endif
2186
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002187#ifdef PNG_iCCP_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002188PNG_EXPORT(159, void, png_set_iCCP,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002189 (png_structp png_ptr, png_infop info_ptr,
2190 png_const_charp name, int compression_type, png_const_bytep profile,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002191 png_uint_32 proflen));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002192#endif
2193
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002194#ifdef PNG_sPLT_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002195PNG_EXPORT(160, png_uint_32, png_get_sPLT,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002196 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002197 png_sPLT_tpp entries));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002198#endif
2199
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002200#ifdef PNG_sPLT_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002201PNG_EXPORT(161, void, png_set_sPLT,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002202 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002203 png_const_sPLT_tp entries, int nentries));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002204#endif
2205
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002206#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002207/* png_get_text also returns the number of text chunks in *num_text */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002208PNG_EXPORT(162, png_uint_32, png_get_text,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002209 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002210 png_textp *text_ptr, int *num_text));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002211#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002212
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002213/* Note while png_set_text() will accept a structure whose text,
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002214 * language, and translated keywords are NULL pointers, the structure
2215 * returned by png_get_text will always contain regular
2216 * zero-terminated C strings. They might be empty strings but
2217 * they will never be NULL pointers.
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -05002218 */
2219
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002220#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002221PNG_EXPORT(163, void, png_set_text,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002222 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002223 png_const_textp text_ptr, int num_text));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002224#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002225
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002226#ifdef PNG_tIME_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002227PNG_EXPORT(164, png_uint_32, png_get_tIME,
John Bowler0a5c9c02011-01-22 17:36:34 -06002228 (png_const_structp png_ptr, png_infop info_ptr, png_timep *mod_time));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002229#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002230
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002231#ifdef PNG_tIME_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002232PNG_EXPORT(165, void, png_set_tIME,
2233 (png_structp png_ptr, png_infop info_ptr, png_const_timep mod_time));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002234#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002235
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002236#ifdef PNG_tRNS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002237PNG_EXPORT(166, png_uint_32, png_get_tRNS,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002238 (png_const_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002239 png_bytep *trans_alpha, int *num_trans, png_color_16p *trans_color));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002240#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002241
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002242#ifdef PNG_tRNS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002243PNG_EXPORT(167, void, png_set_tRNS,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002244 (png_structp png_ptr, png_infop info_ptr,
2245 png_const_bytep trans_alpha, int num_trans,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002246 png_const_color_16p trans_color));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002247#endif
2248
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002249#ifdef PNG_sCAL_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002250PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002251 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002252 int *unit, double *width, double *height));
Glenn Randers-Pehrson48dc6eb2010-07-31 07:09:58 -05002253#ifdef PNG_FLOATING_ARITHMETIC_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002254/* NOTE: this API is currently implemented using floating point arithmetic,
Glenn Randers-Pehrson48dc6eb2010-07-31 07:09:58 -05002255 * consequently it can only be used on systems with floating point support.
2256 * In any case the range of values supported by png_fixed_point is small and it
2257 * is highly recommended that png_get_sCAL_s be used instead.
2258 */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002259PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed,
John Bowler0a5c9c02011-01-22 17:36:34 -06002260 (png_structp png_ptr, png_const_infop info_ptr, int *unit,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002261 png_fixed_point *width,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002262 png_fixed_point *height));
Glenn Randers-Pehrson48dc6eb2010-07-31 07:09:58 -05002263#endif
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002264PNG_EXPORT(169, png_uint_32, png_get_sCAL_s,
John Bowler0a5c9c02011-01-22 17:36:34 -06002265 (png_const_structp png_ptr, png_const_infop info_ptr,
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002266 int *unit, png_charpp swidth, png_charpp sheight));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002267
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002268PNG_FP_EXPORT(170, void, png_set_sCAL,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002269 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002270 int unit, double width, double height));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002271PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_structp png_ptr,
2272 png_infop info_ptr, int unit, png_fixed_point width,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002273 png_fixed_point height));
2274PNG_EXPORT(171, void, png_set_sCAL_s,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002275 (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002276 int unit, png_const_charp swidth, png_const_charp sheight));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002277#endif /* PNG_sCAL_SUPPORTED */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002278
Glenn Randers-Pehrson7824a702009-06-13 10:05:05 -05002279#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
2280/* Provide a list of chunks and how they are to be handled, if the built-in
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002281 handling or default unknown chunk handling is not desired. Any chunks not
2282 listed will be handled in the default manner. The IHDR and IEND chunks
2283 must not be listed.
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -05002284 keep = 0: follow default behaviour
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002285 = 1: do not keep
2286 = 2: keep only if safe-to-copy
2287 = 3: keep even if unsafe-to-copy
2288*/
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002289PNG_EXPORT(172, void, png_set_keep_unknown_chunks,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002290 (png_structp png_ptr, int keep,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002291 png_const_bytep chunk_list, int num_chunks));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002292PNG_EXPORT(173, int, png_handle_as_unknown, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002293 png_const_bytep chunk_name));
Glenn Randers-Pehrson7824a702009-06-13 10:05:05 -05002294#endif
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002295#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002296PNG_EXPORT(174, void, png_set_unknown_chunks, (png_structp png_ptr,
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002297 png_infop info_ptr, png_const_unknown_chunkp unknowns,
2298 int num_unknowns));
2299PNG_EXPORT(175, void, png_set_unknown_chunk_location,
2300 (png_structp png_ptr, png_infop info_ptr, int chunk, int location));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002301PNG_EXPORT(176, int, png_get_unknown_chunks, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002302 png_const_infop info_ptr, png_unknown_chunkpp entries));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002303#endif
2304
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -05002305/* Png_free_data() will turn off the "valid" flag for anything it frees.
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002306 * If you need to turn it off for a chunk that your application has freed,
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002307 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
2308 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002309PNG_EXPORT(177, void, png_set_invalid,
2310 (png_structp png_ptr, png_infop info_ptr, int mask));
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -05002311
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002312#ifdef PNG_INFO_IMAGE_SUPPORTED
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -05002313/* The "params" pointer is currently not used and is for future expansion. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002314PNG_EXPORT(178, void, png_read_png, (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002315 int transforms, png_voidp params));
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002316PNG_EXPORT(179, void, png_write_png, (png_structp png_ptr, png_infop info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002317 int transforms, png_voidp params));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002318#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002319
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002320PNG_EXPORT(180, png_const_charp, png_get_copyright,
John Bowler0a5c9c02011-01-22 17:36:34 -06002321 (png_const_structp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002322PNG_EXPORT(181, png_const_charp, png_get_header_ver,
John Bowler0a5c9c02011-01-22 17:36:34 -06002323 (png_const_structp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002324PNG_EXPORT(182, png_const_charp, png_get_header_version,
John Bowler0a5c9c02011-01-22 17:36:34 -06002325 (png_const_structp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002326PNG_EXPORT(183, png_const_charp, png_get_libpng_ver,
John Bowler0a5c9c02011-01-22 17:36:34 -06002327 (png_const_structp png_ptr));
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -06002328
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -06002329#ifdef PNG_MNG_FEATURES_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002330PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002331 png_uint_32 mng_features_permitted));
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -06002332#endif
2333
Glenn Randers-Pehrson8f3dd832004-08-10 09:43:42 -05002334/* For use in png_set_keep_unknown, added to version 1.2.6 */
2335#define PNG_HANDLE_CHUNK_AS_DEFAULT 0
2336#define PNG_HANDLE_CHUNK_NEVER 1
2337#define PNG_HANDLE_CHUNK_IF_SAFE 2
2338#define PNG_HANDLE_CHUNK_ALWAYS 3
2339
Glenn Randers-Pehrsone68f5a32001-05-14 09:20:53 -05002340/* Strip the prepended error numbers ("#nnn ") from error and warning
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002341 * messages before passing them to the error or warning handler.
2342 */
Glenn Randers-Pehrsone68f5a32001-05-14 09:20:53 -05002343#ifdef PNG_ERROR_NUMBERS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002344PNG_EXPORT(185, void, png_set_strip_error_numbers,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002345 (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002346 png_uint_32 strip_mode));
Glenn Randers-Pehrsonbe9de0f2001-01-22 08:52:16 -06002347#endif
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05002348
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002349/* Added in libpng-1.2.6 */
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05002350#ifdef PNG_SET_USER_LIMITS_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002351PNG_EXPORT(186, void, png_set_user_limits, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002352 png_uint_32 user_width_max, png_uint_32 user_height_max));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002353PNG_EXPORT(187, png_uint_32, png_get_user_width_max,
John Bowler0a5c9c02011-01-22 17:36:34 -06002354 (png_const_structp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002355PNG_EXPORT(188, png_uint_32, png_get_user_height_max,
John Bowler0a5c9c02011-01-22 17:36:34 -06002356 (png_const_structp png_ptr));
Glenn Randers-Pehrson800d1e92008-08-20 17:25:21 -05002357/* Added in libpng-1.4.0 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002358PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002359 png_uint_32 user_chunk_cache_max));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002360PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max,
John Bowler0a5c9c02011-01-22 17:36:34 -06002361 (png_const_structp png_ptr));
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06002362/* Added in libpng-1.4.1 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002363PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002364 png_alloc_size_t user_chunk_cache_max));
2365PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max,
John Bowler0a5c9c02011-01-22 17:36:34 -06002366 (png_const_structp png_ptr));
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05002367#endif
2368
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002369#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002370PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch,
John Bowler0a5c9c02011-01-22 17:36:34 -06002371 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002372
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002373PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch,
John Bowler0a5c9c02011-01-22 17:36:34 -06002374 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002375
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002376PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch,
John Bowler0a5c9c02011-01-22 17:36:34 -06002377 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002378
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002379PNG_FP_EXPORT(196, float, png_get_x_offset_inches,
John Bowler0a5c9c02011-01-22 17:36:34 -06002380 (png_const_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002381#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002382PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed,
John Bowler0a5c9c02011-01-22 17:36:34 -06002383 (png_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002384#endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002385
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002386PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002387 png_const_infop info_ptr));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002388#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002389PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed,
John Bowler0a5c9c02011-01-22 17:36:34 -06002390 (png_structp png_ptr, png_const_infop info_ptr));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002391#endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002392
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06002393# ifdef PNG_pHYs_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002394PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structp png_ptr,
John Bowler0a5c9c02011-01-22 17:36:34 -06002395 png_const_infop info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002396 int *unit_type));
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06002397# endif /* PNG_pHYs_SUPPORTED */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002398#endif /* PNG_INCH_CONVERSIONS_SUPPORTED */
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002399
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002400/* Added in libpng-1.4.0 */
2401#ifdef PNG_IO_STATE_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002402PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_structp png_ptr));
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002403
Glenn Randers-Pehrsona63dbed2011-01-22 08:51:19 -06002404PNG_EXPORTA(200, png_const_bytep, png_get_io_chunk_name,
2405 (png_structp png_ptr), PNG_DEPRECATED);
Glenn Randers-Pehrsoncf7cce62011-01-22 12:42:43 -06002406PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type,
John Bowler0a5c9c02011-01-22 17:36:34 -06002407 (png_const_structp png_ptr));
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002408
2409/* The flags returned by png_get_io_state() are the following: */
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06002410# define PNG_IO_NONE 0x0000 /* no I/O at this moment */
2411# define PNG_IO_READING 0x0001 /* currently reading */
2412# define PNG_IO_WRITING 0x0002 /* currently writing */
2413# define PNG_IO_SIGNATURE 0x0010 /* currently at the file signature */
2414# define PNG_IO_CHUNK_HDR 0x0020 /* currently at the chunk header */
2415# define PNG_IO_CHUNK_DATA 0x0040 /* currently at the chunk data */
2416# define PNG_IO_CHUNK_CRC 0x0080 /* currently at the chunk crc */
2417# define PNG_IO_MASK_OP 0x000f /* current operation: reading/writing */
2418# define PNG_IO_MASK_LOC 0x00f0 /* current location: sig/hdr/data/crc */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002419#endif /* ?PNG_IO_STATE_SUPPORTED */
2420
John Bowler660c6e42010-12-19 06:22:23 -06002421/* Interlace support. The following macros are always defined so that if
2422 * libpng interlace handling is turned off the macros may be used to handle
2423 * interlaced images within the application.
2424 */
2425#define PNG_INTERLACE_ADAM7_PASSES 7
2426
2427/* Two macros to return the first row and first column of the original,
2428 * full, image which appears in a given pass. 'pass' is in the range 0
2429 * to 6 and the result is in the range 0 to 7.
2430 */
2431#define PNG_PASS_START_ROW(pass) (((1U&~(pass))<<(3-((pass)>>1)))&7)
2432#define PNG_PASS_START_COL(pass) (((1U& (pass))<<(3-(((pass)+1)>>1)))&7)
2433
2434/* Two macros to help evaluate the number of rows or columns in each
2435 * pass. This is expressed as a shift - effectively log2 of the number or
2436 * rows or columns in each 8x8 tile of the original image.
2437 */
2438#define PNG_PASS_ROW_SHIFT(pass) ((pass)>2?(8-(pass))>>1:3)
2439#define PNG_PASS_COL_SHIFT(pass) ((pass)>1?(7-(pass))>>1:3)
2440
2441/* Hence two macros to determine the number of rows or columns in a given
2442 * pass of an image given its height or width. In fact these macros may
2443 * return non-zero even though the sub-image is empty, because the other
2444 * dimension may be empty for a small image.
2445 */
2446#define PNG_PASS_ROWS(height, pass) (((height)+(((1<<PNG_PASS_ROW_SHIFT(pass))\
2447 -1)-PNG_PASS_START_ROW(pass)))>>PNG_PASS_ROW_SHIFT(pass))
2448#define PNG_PASS_COLS(width, pass) (((width)+(((1<<PNG_PASS_COL_SHIFT(pass))\
2449 -1)-PNG_PASS_START_COL(pass)))>>PNG_PASS_COL_SHIFT(pass))
2450
John Bowler9616ad92011-02-16 06:13:46 -06002451/* For the reader row callbacks (both progressive and sequential) it is
2452 * necessary to find the row in the output image given a row in an interlaced
2453 * image, so two more macros:
John Bowler660c6e42010-12-19 06:22:23 -06002454 */
2455#define PNG_ROW_FROM_PASS_ROW(yIn, pass) \
2456 (((yIn)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass))
2457#define PNG_COL_FROM_PASS_COL(xIn, pass) \
2458 (((xIn)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass))
2459
2460/* Two macros which return a boolean (0 or 1) saying whether the given row
2461 * or column is in a particular pass. These use a common utility macro that
2462 * returns a mask for a given pass - the offset 'off' selects the row or
2463 * column version. The mask has the appropriate bit set for each column in
2464 * the tile.
2465 */
2466#define PNG_PASS_MASK(pass,off) ( \
2467 ((0x110145AFU>>(((7-(off))-(pass))<<2)) & 0xFU) | \
2468 ((0x01145AF0U>>(((7-(off))-(pass))<<2)) & 0xF0U))
2469
2470#define PNG_ROW_IN_INTERLACE_PASS(y, pass) \
2471 ((PNG_PASS_MASK(pass,0) >> ((y)&7)) & 1)
2472#define PNG_COL_IN_INTERLACE_PASS(x, pass) \
2473 ((PNG_PASS_MASK(pass,1) >> ((x)&7)) & 1)
2474
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002475#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -05002476/* With these routines we avoid an integer divide, which will be slower on
2477 * most machines. However, it does take more operations than the corresponding
2478 * divide method, so it may be slower on a few RISC systems. There are two
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002479 * shifts (by 8 or 16 bits) and an addition, versus a single integer divide.
2480 *
2481 * Note that the rounding factors are NOT supposed to be the same! 128 and
2482 * 32768 are correct for the NODIV code; 127 and 32767 are correct for the
2483 * standard method.
2484 *
2485 * [Optimized code by Greg Roelofs and Mark Adler...blame us for bugs. :-) ]
2486 */
2487
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06002488 /* fg and bg should be in `gamma 1.0' space; alpha is the opacity */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002489
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06002490# define png_composite(composite, fg, alpha, bg) \
2491 { png_uint_16 temp = (png_uint_16)((png_uint_16)(fg) \
2492 * (png_uint_16)(alpha) \
2493 + (png_uint_16)(bg)*(png_uint_16)(255 \
2494 - (png_uint_16)(alpha)) + (png_uint_16)128); \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002495 (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002496
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06002497# define png_composite_16(composite, fg, alpha, bg) \
2498 { png_uint_32 temp = (png_uint_32)((png_uint_32)(fg) \
2499 * (png_uint_32)(alpha) \
2500 + (png_uint_32)(bg)*(png_uint_32)(65535L \
2501 - (png_uint_32)(alpha)) + (png_uint_32)32768L); \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002502 (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }
2503
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002504#else /* Standard method using integer division */
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002505
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06002506# define png_composite(composite, fg, alpha, bg) \
2507 (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) + \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06002508 (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \
2509 (png_uint_16)127) / 255)
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002510
2511# define png_composite_16(composite, fg, alpha, bg) \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002512 (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06002513 (png_uint_32)(bg)*(png_uint_32)(65535L - (png_uint_32)(alpha)) + \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06002514 (png_uint_32)32767) / (png_uint_32)65535L)
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002515#endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */
2516
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002517#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002518PNG_EXPORT(201, png_uint_32, png_get_uint_32, (png_const_bytep buf));
2519PNG_EXPORT(202, png_uint_16, png_get_uint_16, (png_const_bytep buf));
2520PNG_EXPORT(203, png_int_32, png_get_int_32, (png_const_bytep buf));
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002521#endif
2522
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002523PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_structp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002524 png_const_bytep buf));
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002525/* No png_get_int_16 -- may be added if there's a real need for it. */
2526
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002527/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002528#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002529PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i));
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002530#endif
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05002531#ifdef PNG_SAVE_INT_32_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002532PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i));
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05002533#endif
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002534
2535/* Place a 16-bit number into a buffer in PNG byte order.
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002536 * The parameter is declared unsigned int, not png_uint_16,
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002537 * just to avoid potential problems on pre-ANSI C compilers.
2538 */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002539#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002540PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i));
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002541/* No png_save_int_16 -- may be added if there's a real need for it. */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002542#endif
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002543
John Bowlerf21a0d02011-01-23 23:55:19 -06002544#ifdef PNG_USE_READ_MACROS
2545/* Inline macros to do direct reads of bytes from the input buffer.
2546 * The png_get_int_32() routine assumes we are using two's complement
2547 * format for negative values, which is almost certainly true.
2548 */
2549# define png_get_uint_32(buf) \
2550 (((png_uint_32)(*(buf)) << 24) + \
2551 ((png_uint_32)(*((buf) + 1)) << 16) + \
2552 ((png_uint_32)(*((buf) + 2)) << 8) + \
2553 ((png_uint_32)(*((buf) + 3))))
2554
2555 /* From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
2556 * function) incorrectly returned a value of type png_uint_32.
2557 */
2558# define png_get_uint_16(buf) \
2559 ((png_uint_16) \
2560 (((unsigned int)(*(buf)) << 8) + \
2561 ((unsigned int)(*((buf) + 1)))))
2562
2563# define png_get_int_32(buf) \
2564 ((png_int_32)((*(buf) & 0x80) \
2565 ? -((png_int_32)((png_get_uint_32(buf) ^ 0xffffffffL) + 1)) \
2566 : (png_int_32)png_get_uint_32(buf)))
2567#endif
2568
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002569/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
2570 * defs
2571 */
2572
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06002573/* The last ordinal number (this is the *last* one already used; the next
John Bowler71a10f22011-01-22 17:03:33 -06002574 * one to use is one more than this.) Maintainer, remember to add an entry to
2575 * scripts/symbols.def as well.
Glenn Randers-Pehrsonc551c0d2010-03-16 07:52:34 -05002576 */
2577#ifdef PNG_EXPORT_LAST_ORDINAL
Glenn Randers-Pehrson413138a2011-06-13 22:07:37 -05002578 PNG_EXPORT_LAST_ORDINAL(229);
Glenn Randers-Pehrsonc551c0d2010-03-16 07:52:34 -05002579#endif
2580
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06002581#ifdef __cplusplus
2582}
2583#endif
2584
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05002585#endif /* PNG_VERSION_INFO_ONLY */
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002586/* Do not put anything past this line */
Glenn Randers-Pehrson13944802000-06-24 07:42:42 -05002587#endif /* PNG_H */