blob: 5abdb450cf0649c4a91b02e06f58f94b395ce0e8 [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-Pehrsonb23afad2013-07-10 19:30:59 -05004 * libpng version 1.6.3rc01 - July 11, 2013
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06005 * Copyright (c) 1998-2013 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-Pehrsonb23afad2013-07-10 19:30:59 -050014 * libpng versions 0.97, January 1998, through 1.6.3rc01 - July 11, 2013: Glenn
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -060015 * See also "Contributing Authors", below.
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -050016 *
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060017 * Note about libpng version numbers:
18 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -060019 * Due to various miscommunications, unforeseen code incompatibilities
20 * and occasional factors outside the authors' control, version numbering
21 * on the library has not always been consistent and straightforward.
22 * The following table summarizes matters since version 0.89c, which was
23 * the first widely used release:
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060024 *
Glenn Randers-Pehrson75294572000-05-06 14:09:57 -050025 * source png.h png.h shared-lib
26 * version string int version
27 * ------- ------ ----- ----------
28 * 0.89c "1.0 beta 3" 0.89 89 1.0.89
29 * 0.90 "1.0 beta 4" 0.90 90 0.90 [should have been 2.0.90]
30 * 0.95 "1.0 beta 5" 0.95 95 0.95 [should have been 2.0.95]
31 * 0.96 "1.0 beta 6" 0.96 96 0.96 [should have been 2.0.96]
32 * 0.97b "1.00.97 beta 7" 1.00.97 97 1.0.1 [should have been 2.0.97]
33 * 0.97c 0.97 97 2.0.97
34 * 0.98 0.98 98 2.0.98
35 * 0.99 0.99 98 2.0.99
36 * 0.99a-m 0.99 99 2.0.99
37 * 1.00 1.00 100 2.1.0 [100 should be 10000]
38 * 1.0.0 (from here on, the 100 2.1.0 [100 should be 10000]
39 * 1.0.1 png.h string is 10001 2.1.0
40 * 1.0.1a-e identical to the 10002 from here on, the shared library
41 * 1.0.2 source version) 10002 is 2.V where V is the source code
42 * 1.0.2a-b 10003 version, except as noted.
43 * 1.0.3 10003
44 * 1.0.3a-d 10004
45 * 1.0.4 10004
46 * 1.0.4a-f 10005
47 * 1.0.5 (+ 2 patches) 10005
48 * 1.0.5a-d 10006
49 * 1.0.5e-r 10100 (not source compatible)
50 * 1.0.5s-v 10006 (not binary compatible)
51 * 1.0.6 (+ 3 patches) 10006 (still binary incompatible)
52 * 1.0.6d-f 10007 (still binary incompatible)
53 * 1.0.6g 10007
54 * 1.0.6h 10007 10.6h (testing xy.z so-numbering)
55 * 1.0.6i 10007 10.6i
56 * 1.0.6j 10007 2.1.0.6j (incompatible with 1.0.0)
Glenn Randers-Pehrsonbe9de0f2001-01-22 08:52:16 -060057 * 1.0.7beta11-14 DLLNUM 10007 2.1.0.7beta11-14 (binary compatible)
58 * 1.0.7beta15-18 1 10007 2.1.0.7beta15-18 (binary compatible)
59 * 1.0.7rc1-2 1 10007 2.1.0.7rc1-2 (binary compatible)
60 * 1.0.7 1 10007 (still compatible)
61 * 1.0.8beta1-4 1 10008 2.1.0.8beta1-4
62 * 1.0.8rc1 1 10008 2.1.0.8rc1
63 * 1.0.8 1 10008 2.1.0.8
64 * 1.0.9beta1-6 1 10009 2.1.0.9beta1-6
65 * 1.0.9rc1 1 10009 2.1.0.9rc1
66 * 1.0.9beta7-10 1 10009 2.1.0.9beta7-10
67 * 1.0.9rc2 1 10009 2.1.0.9rc2
Glenn Randers-Pehrsond4e81092001-01-31 05:56:52 -060068 * 1.0.9 1 10009 2.1.0.9
Glenn Randers-Pehrson19095602001-03-14 07:08:39 -060069 * 1.0.10beta1 1 10010 2.1.0.10beta1
Glenn Randers-Pehrsone1644472001-03-23 05:06:56 -060070 * 1.0.10rc1 1 10010 2.1.0.10rc1
Glenn Randers-Pehrson13cfbac2001-03-30 06:42:28 -060071 * 1.0.10 1 10010 2.1.0.10
Glenn Randers-Pehrsone1eff582001-04-14 20:15:41 -050072 * 1.0.11beta1-3 1 10011 2.1.0.11beta1-3
Glenn Randers-Pehrson82ae3832001-04-20 10:32:10 -050073 * 1.0.11rc1 1 10011 2.1.0.11rc1
Glenn Randers-Pehrson32835392001-04-27 08:29:32 -050074 * 1.0.11 1 10011 2.1.0.11
Glenn Randers-Pehrsonb1828932001-06-23 08:03:17 -050075 * 1.0.12beta1-2 2 10012 2.1.0.12beta1-2
76 * 1.0.12rc1 2 10012 2.1.0.12rc1
77 * 1.0.12 2 10012 2.1.0.12
78 * 1.1.0a-f - 10100 2.1.1.0a-f (branch abandoned)
Glenn Randers-Pehrson8b6a8892001-05-18 04:54:50 -050079 * 1.2.0beta1-2 2 10200 2.1.2.0beta1-2
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -050080 * 1.2.0beta3-5 3 10200 3.1.2.0beta3-5
81 * 1.2.0rc1 3 10200 3.1.2.0rc1
82 * 1.2.0 3 10200 3.1.2.0
Glenn Randers-Pehrson5cded0b2001-11-07 07:10:08 -060083 * 1.2.1beta1-4 3 10201 3.1.2.1beta1-4
Glenn Randers-Pehrsondb3b88d2001-12-04 06:30:43 -060084 * 1.2.1rc1-2 3 10201 3.1.2.1rc1-2
85 * 1.2.1 3 10201 3.1.2.1
Glenn Randers-Pehrson25228ab2002-03-31 07:33:55 -060086 * 1.2.2beta1-6 12 10202 12.so.0.1.2.2beta1-6
Glenn Randers-Pehrsonfcbd7872002-04-07 16:35:38 -050087 * 1.0.13beta1 10 10013 10.so.0.1.0.13beta1
88 * 1.0.13rc1 10 10013 10.so.0.1.0.13rc1
89 * 1.2.2rc1 12 10202 12.so.0.1.2.2rc1
Glenn Randers-Pehrson4fb046a2002-04-15 09:25:51 -050090 * 1.0.13 10 10013 10.so.0.1.0.13
91 * 1.2.2 12 10202 12.so.0.1.2.2
Glenn Randers-Pehrson22f28962002-05-13 18:17:09 -050092 * 1.2.3rc1-6 12 10203 12.so.0.1.2.3rc1-6
93 * 1.2.3 12 10203 12.so.0.1.2.3
Glenn Randers-Pehrsond020e9d2002-06-28 09:34:00 -050094 * 1.2.4beta1-3 13 10204 12.so.0.1.2.4beta1-3
Glenn Randers-Pehrson2ae022d2002-07-01 22:23:46 -050095 * 1.0.14rc1 13 10014 10.so.0.1.0.14rc1
96 * 1.2.4rc1 13 10204 12.so.0.1.2.4rc1
Glenn Randers-Pehrson484a8a12002-07-07 19:15:20 -050097 * 1.0.14 10 10014 10.so.0.1.0.14
98 * 1.2.4 13 10204 12.so.0.1.2.4
Glenn Randers-Pehrson51d92502002-08-23 23:07:42 -050099 * 1.2.5beta1-2 13 10205 12.so.0.1.2.5beta1-2
Glenn Randers-Pehrson5ff38d32002-09-17 23:38:46 -0500100 * 1.0.15rc1-3 10 10015 10.so.0.1.0.15rc1-3
Glenn Randers-Pehrson0cc2f952002-10-03 06:32:37 -0500101 * 1.2.5rc1-3 13 10205 12.so.0.1.2.5rc1-3
102 * 1.0.15 10 10015 10.so.0.1.0.15
103 * 1.2.5 13 10205 12.so.0.1.2.5
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500104 * 1.2.6beta1-4 13 10206 12.so.0.1.2.6beta1-4
Glenn Randers-Pehrson37f116a2004-08-15 07:15:39 -0500105 * 1.0.16 10 10016 10.so.0.1.0.16
106 * 1.2.6 13 10206 12.so.0.1.2.6
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -0500107 * 1.2.7beta1-2 13 10207 12.so.0.1.2.7beta1-2
Glenn Randers-Pehrson5b779162004-09-04 13:25:08 -0500108 * 1.0.17rc1 10 10017 12.so.0.1.0.17rc1
109 * 1.2.7rc1 13 10207 12.so.0.1.2.7rc1
Glenn Randers-Pehrson250dfe12004-09-11 21:19:54 -0500110 * 1.0.17 10 10017 12.so.0.1.0.17
111 * 1.2.7 13 10207 12.so.0.1.2.7
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600112 * 1.2.8beta1-5 13 10208 12.so.0.1.2.8beta1-5
Glenn Randers-Pehrson584b96e2004-11-29 15:08:00 -0600113 * 1.0.18rc1-5 10 10018 12.so.0.1.0.18rc1-5
114 * 1.2.8rc1-5 13 10208 12.so.0.1.2.8rc1-5
Glenn Randers-Pehrson917648e2004-12-02 18:14:51 -0600115 * 1.0.18 10 10018 12.so.0.1.0.18
116 * 1.2.8 13 10208 12.so.0.1.2.8
Glenn Randers-Pehrsone6474622006-03-04 16:50:47 -0600117 * 1.2.9beta1-3 13 10209 12.so.0.1.2.9beta1-3
Glenn Randers-Pehrson4deeb792006-03-22 16:21:59 -0600118 * 1.2.9beta4-11 13 10209 12.so.0.9[.0]
Glenn Randers-Pehrson3a512032006-03-31 05:29:33 -0600119 * 1.2.9rc1 13 10209 12.so.0.9[.0]
Glenn Randers-Pehrsona7d0c942006-04-14 06:22:52 -0500120 * 1.2.9 13 10209 12.so.0.9[.0]
Glenn Randers-Pehrsond60b8fa2006-04-20 21:31:14 -0500121 * 1.2.10beta1-7 13 10210 12.so.0.10[.0]
Glenn Randers-Pehrson17218292006-04-20 07:20:46 -0500122 * 1.2.10rc1-2 13 10210 12.so.0.10[.0]
Glenn Randers-Pehrson86dc9812006-05-10 07:27:44 -0500123 * 1.2.10 13 10210 12.so.0.10[.0]
Glenn Randers-Pehrson73b064c2006-05-15 06:44:21 -0500124 * 1.4.0beta1-5 14 10400 14.so.0.0[.0]
Glenn Randers-Pehrson7824a702009-06-13 10:05:05 -0500125 * 1.2.11beta1-4 13 10211 12.so.0.11[.0]
Glenn Randers-Pehrson3424ee72006-07-12 13:33:47 -0500126 * 1.4.0beta7-8 14 10400 14.so.0.0[.0]
Glenn Randers-Pehrson7aa18342009-06-05 17:24:17 -0500127 * 1.2.11 13 10211 12.so.0.11[.0]
128 * 1.2.12 13 10212 12.so.0.12[.0]
Glenn Randers-Pehrson701dbaa2006-11-17 09:36:54 -0600129 * 1.4.0beta9-14 14 10400 14.so.0.0[.0]
Glenn Randers-Pehrson7aa18342009-06-05 17:24:17 -0500130 * 1.2.13 13 10213 12.so.0.13[.0]
Glenn Randers-Pehrson97a9b482008-10-25 20:03:28 -0500131 * 1.4.0beta15-36 14 10400 14.so.0.0[.0]
Glenn Randers-Pehrsonfa028102009-10-10 06:15:21 -0500132 * 1.4.0beta37-87 14 10400 14.so.14.0[.0]
Glenn Randers-Pehrson733da8c2009-10-30 00:00:15 -0500133 * 1.4.0rc01 14 10400 14.so.14.0[.0]
Glenn Randers-Pehrson62ca98e2009-12-20 15:14:57 -0600134 * 1.4.0beta88-109 14 10400 14.so.14.0[.0]
Glenn Randers-Pehrson67a83db2010-01-01 18:26:18 -0600135 * 1.4.0rc02-08 14 10400 14.so.14.0[.0]
Glenn Randers-Pehrson75202242009-12-25 14:25:29 -0600136 * 1.4.0 14 10400 14.so.14.0[.0]
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -0600137 * 1.4.1beta01-03 14 10401 14.so.14.1[.0]
138 * 1.4.1rc01 14 10401 14.so.14.1[.0]
Glenn Randers-Pehrson7a5be532010-02-14 07:16:19 -0600139 * 1.4.1beta04-12 14 10401 14.so.14.1[.0]
Glenn Randers-Pehrsonaaf377c2010-03-08 11:20:30 -0600140 * 1.4.1 14 10401 14.so.14.1[.0]
Glenn Randers-Pehrson5b3d5542010-06-18 21:55:53 -0500141 * 1.4.2 14 10402 14.so.14.2[.0]
142 * 1.4.3 14 10403 14.so.14.3[.0]
Glenn Randers-Pehrson2776d5e2010-11-21 15:18:02 -0600143 * 1.4.4 14 10404 14.so.14.4[.0]
Glenn Randers-Pehrsonfd20a5a2010-12-27 08:53:08 -0600144 * 1.5.0beta01-58 15 10500 15.so.15.0[.0]
Glenn Randers-Pehrson64b863c2011-01-04 09:57:06 -0600145 * 1.5.0rc01-07 15 10500 15.so.15.0[.0]
Glenn Randers-Pehrsonf5ea1b72011-01-06 06:42:51 -0600146 * 1.5.0 15 10500 15.so.15.0[.0]
Glenn Randers-Pehrsonef123cc2011-01-28 15:20:34 -0600147 * 1.5.1beta01-11 15 10501 15.so.15.1[.0]
Glenn Randers-Pehrson3d3aae12011-02-02 22:58:27 -0600148 * 1.5.1rc01-02 15 10501 15.so.15.1[.0]
149 * 1.5.1 15 10501 15.so.15.1[.0]
Glenn Randers-Pehrsonf3dd1cc2011-03-18 22:02:20 -0500150 * 1.5.2beta01-03 15 10502 15.so.15.2[.0]
Glenn Randers-Pehrson77fd0832011-03-24 08:59:48 -0500151 * 1.5.2rc01-03 15 10502 15.so.15.2[.0]
Glenn Randers-Pehrsondcc35052011-03-31 11:23:49 -0500152 * 1.5.2 15 10502 15.so.15.2[.0]
Glenn Randers-Pehrson36edbb52011-06-03 07:15:04 -0500153 * 1.5.3beta01-10 15 10503 15.so.15.3[.0]
Glenn Randers-Pehrsonfb278732011-06-10 20:43:39 -0500154 * 1.5.3rc01-02 15 10503 15.so.15.3[.0]
Glenn Randers-Pehrson413138a2011-06-13 22:07:37 -0500155 * 1.5.3beta11 15 10503 15.so.15.3[.0]
156 * 1.5.3 [omitted]
Glenn Randers-Pehrson9daf91e2011-06-22 23:10:36 -0500157 * 1.5.4beta01-08 15 10504 15.so.15.4[.0]
Glenn Randers-Pehrson78bb9da2011-06-30 18:59:45 -0500158 * 1.5.4rc01 15 10504 15.so.15.4[.0]
Glenn Randers-Pehrsond404b6d2011-07-07 06:24:57 -0500159 * 1.5.4 15 10504 15.so.15.4[.0]
Glenn Randers-Pehrson3c2ae602011-09-09 06:02:09 -0500160 * 1.5.5beta01-08 15 10505 15.so.15.5[.0]
161 * 1.5.5rc01 15 10505 15.so.15.5[.0]
Glenn Randers-Pehrson3e2263a2011-09-22 08:40:32 -0500162 * 1.5.5 15 10505 15.so.15.5[.0]
Glenn Randers-Pehrson93254f62011-10-26 08:36:21 -0500163 * 1.5.6beta01-07 15 10506 15.so.15.6[.0]
Glenn Randers-Pehrsonbc6726b2011-11-02 22:43:00 -0500164 * 1.5.6rc01-03 15 10506 15.so.15.6[.0]
165 * 1.5.6 15 10506 15.so.15.6[.0]
Glenn Randers-Pehrson36251d32011-11-17 21:14:34 -0600166 * 1.5.7beta01-05 15 10507 15.so.15.7[.0]
Glenn Randers-Pehrsonb74fb4e2011-12-21 08:37:46 -0600167 * 1.5.7rc01-03 15 10507 15.so.15.7[.0]
168 * 1.5.7 15 10507 15.so.15.7[.0]
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600169 * 1.6.0beta01-40 16 10600 16.so.16.0[.0]
170 * 1.6.0rc01-08 16 10600 16.so.16.0[.0]
171 * 1.6.0 16 10600 16.so.16.0[.0]
Glenn Randers-Pehrson3a83aa32013-03-29 06:56:45 -0500172 * 1.6.1beta01-09 16 10601 16.so.16.1[.0]
Glenn Randers-Pehrson4e6e2162013-03-21 07:27:01 -0500173 * 1.6.1rc01 16 10601 16.so.16.1[.0]
Glenn Randers-Pehrson50878052013-03-27 20:31:36 -0500174 * 1.6.1 16 10601 16.so.16.1[.0]
Glenn Randers-Pehrson0794df42013-04-18 06:23:26 -0500175 * 1.6.2beta01 16 10602 16.so.16.2[.0]
Glenn Randers-Pehrson0ee34652013-04-23 22:17:03 -0500176 * 1.6.2rc01-06 16 10602 16.so.16.2[.0]
Glenn Randers-Pehrson809355b2013-04-25 07:24:46 -0500177 * 1.6.2 16 10602 16.so.16.2[.0]
Glenn Randers-Pehrsonb23afad2013-07-10 19:30:59 -0500178 * 1.6.3beta01-11 16 10603 16.so.16.3[.0]
179 * 1.6.3rc01 16 10603 16.so.16.3[.0]
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600180 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600181 * Henceforth the source version will match the shared-library major
182 * and minor numbers; the shared-library major version number will be
183 * used for changes in backward compatibility, as it is intended. The
184 * PNG_LIBPNG_VER macro, which is not used within libpng but is available
185 * for applications, is an unsigned integer of the form xyyzz corresponding
186 * to the source version x.y.z (leading zeros in y and z). Beta versions
187 * were given the previous public release number plus a letter, until
188 * version 1.0.6j; from then on they were given the upcoming public
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600189 * release number plus "betaNN" or "rcNN".
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600190 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600191 * Binary incompatibility exists only when applications make direct access
192 * to the info_ptr or png_ptr members through png.h, and the compiled
193 * application is loaded with a different version of the library.
Glenn Randers-Pehrson326320e2000-04-24 07:43:17 -0500194 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600195 * DLLNUM will change each time there are forward or backward changes
196 * in binary compatibility (e.g., when a new feature is added).
Glenn Randers-Pehrsonbe9de0f2001-01-22 08:52:16 -0600197 *
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500198 * See libpng-manual.txt or libpng.3 for more information. The PNG
199 * specification is available as a W3C Recommendation and as an ISO
200 * Specification, <http://www.w3.org/TR/2003/REC-PNG-20031110/
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600201 */
202
203/*
Glenn Randers-Pehrson68ea2432000-04-01 21:10:05 -0600204 * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
205 *
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500206 * If you modify libpng you may insert additional notices immediately following
207 * this sentence.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600208 *
Glenn Randers-Pehrsonbfbf8652009-06-26 21:46:52 -0500209 * This code is released under the libpng license.
210 *
Glenn Randers-Pehrsonb23afad2013-07-10 19:30:59 -0500211 * libpng versions 1.2.6, August 15, 2004, through 1.6.3rc01, July 11, 2013, are
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600212 * Copyright (c) 2004, 2006-2013 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500213 * distributed according to the same disclaimer and license as libpng-1.2.5
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500214 * with the following individual added to the list of Contributing Authors:
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500215 *
216 * Cosmin Truta
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500217 *
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500218 * libpng versions 1.0.7, July 1, 2000, through 1.2.5, October 3, 2002, are
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500219 * Copyright (c) 2000-2002 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrson32fc5ce2000-07-24 06:34:14 -0500220 * distributed according to the same disclaimer and license as libpng-1.0.6
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500221 * with the following individuals added to the list of Contributing Authors:
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500222 *
223 * Simon-Pierre Cadieux
224 * Eric S. Raymond
225 * Gilles Vollant
226 *
Glenn Randers-Pehrson3d5a5202000-07-01 15:37:28 -0500227 * and with the following additions to the disclaimer:
228 *
229 * There is no warranty against interference with your enjoyment of the
230 * library or against infringement. There is no warranty that our
231 * efforts or the library will fulfill any of your particular purposes
232 * or needs. This library is provided with all faults, and the entire
233 * risk of satisfactory quality, performance, accuracy, and effort is with
234 * the user.
235 *
236 * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500237 * Copyright (c) 1998, 1999, 2000 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600238 * distributed according to the same disclaimer and license as libpng-0.96,
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500239 * with the following individuals added to the list of Contributing Authors:
240 *
241 * Tom Lane
242 * Glenn Randers-Pehrson
243 * Willem van Schaik
244 *
245 * libpng versions 0.89, June 1996, through 0.96, May 1997, are
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600246 * Copyright (c) 1996, 1997 Andreas Dilger
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600247 * Distributed according to the same disclaimer and license as libpng-0.88,
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500248 * with the following individuals added to the list of Contributing Authors:
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600249 *
250 * John Bowler
251 * Kevin Bracey
252 * Sam Bushell
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600253 * Magnus Holmgren
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600254 * Greg Roelofs
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500255 * Tom Tanner
256 *
257 * libpng versions 0.5, May 1995, through 0.88, January 1996, are
258 * Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.
259 *
260 * For the purposes of this copyright and license, "Contributing Authors"
261 * is defined as the following set of individuals:
262 *
263 * Andreas Dilger
264 * Dave Martindale
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600265 * Guy Eric Schalnat
266 * Paul Schmidt
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600267 * Tim Wegner
268 *
269 * The PNG Reference Library is supplied "AS IS". The Contributing Authors
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600270 * and Group 42, Inc. disclaim all warranties, expressed or implied,
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600271 * including, without limitation, the warranties of merchantability and of
272 * fitness for any purpose. The Contributing Authors and Group 42, Inc.
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600273 * assume no liability for direct, indirect, incidental, special, exemplary,
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600274 * or consequential damages, which may result from the use of the PNG
275 * Reference Library, even if advised of the possibility of such damage.
276 *
277 * Permission is hereby granted to use, copy, modify, and distribute this
278 * source code, or portions hereof, for any purpose, without fee, subject
279 * to the following restrictions:
280 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600281 * 1. The origin of this source code must not be misrepresented.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600282 *
Glenn Randers-Pehrson53c07f52010-06-18 18:55:55 -0500283 * 2. Altered versions must be plainly marked as such and must not
284 * be misrepresented as being the original source.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600285 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600286 * 3. This Copyright notice may not be removed or altered from
287 * any source or altered source distribution.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600288 *
289 * The Contributing Authors and Group 42, Inc. specifically permit, without
290 * fee, and encourage the use of this source code as a component to
291 * supporting the PNG file format in commercial products. If you use this
292 * source code in a product, acknowledgment is not required but would be
293 * appreciated.
294 */
295
296/*
297 * A "png_get_copyright" function is available, for convenient use in "about"
298 * boxes and the like:
299 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600300 * printf("%s", png_get_copyright(NULL));
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600301 *
302 * Also, the PNG logo (in PNG format, of course) is supplied in the
Glenn Randers-Pehrsona4d54bd2000-07-14 08:15:12 -0500303 * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600304 */
305
306/*
307 * Libpng is OSI Certified Open Source Software. OSI Certified is a
308 * certification mark of the Open Source Initiative.
309 */
310
311/*
312 * The contributing authors would like to thank all those who helped
313 * with testing, bug fixes, and patience. This wouldn't have been
314 * possible without all of you.
315 *
316 * Thanks to Frank J. T. Wojcik for helping with the documentation.
317 */
318
319/*
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600320 * Y2K compliance in libpng:
321 * =========================
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600322 *
Glenn Randers-Pehrsonb23afad2013-07-10 19:30:59 -0500323 * July 11, 2013
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600324 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600325 * Since the PNG Development group is an ad-hoc body, we can't make
326 * an official declaration.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600327 *
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500328 * This is your unofficial assurance that libpng from version 0.71 and
Glenn Randers-Pehrsonb23afad2013-07-10 19:30:59 -0500329 * upward through 1.6.3rc01 are Y2K compliant. It is my belief that
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500330 * earlier versions were also Y2K compliant.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600331 *
John Bowler88b77cc2011-05-05 06:49:55 -0500332 * Libpng only has two year fields. One is a 2-byte unsigned integer
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600333 * that will hold years up to 65535. The other, which is deprecated,
334 * holds the date in text format, and will hold years up to 9999.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600335 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600336 * The integer is
337 * "png_uint_16 year" in png_time_struct.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600338 *
John Bowler88b77cc2011-05-05 06:49:55 -0500339 * The string is
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600340 * "char time_buffer[29]" in png_struct. This is no longer used
341 * in libpng-1.6.x and will be removed from libpng-1.7.0.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600342 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600343 * There are seven time-related functions:
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600344 * png.c: png_convert_to_rfc_1123_buffer() in png.c
345 * (formerly png_convert_to_rfc_1123() prior to libpng-1.5.x and
346 * png_convert_to_rfc_1152() in error prior to libpng-0.98)
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600347 * png_convert_from_struct_tm() in pngwrite.c, called in pngwrite.c
348 * png_convert_from_time_t() in pngwrite.c
349 * png_get_tIME() in pngget.c
350 * png_handle_tIME() in pngrutil.c, called in pngread.c
351 * png_set_tIME() in pngset.c
352 * png_write_tIME() in pngwutil.c, called in pngwrite.c
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600353 *
354 * All handle dates properly in a Y2K environment. The
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600355 * png_convert_from_time_t() function calls gmtime() to convert from system
356 * clock time, which returns (year - 1900), which we properly convert to
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600357 * the full 4-digit year. There is a possibility that libpng applications
358 * are not passing 4-digit years into the png_convert_to_rfc_1123_buffer()
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500359 * function, or that they are incorrectly passing only a 2-digit year
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600360 * instead of "year - 1900" into the png_convert_from_struct_tm() function,
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500361 * but this is not under our control. The libpng documentation has always
362 * stated that it works with 4-digit years, and the APIs have been
363 * documented as such.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600364 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600365 * The tIME chunk itself is also Y2K compliant. It uses a 2-byte unsigned
366 * integer to hold the year, and can hold years as large as 65535.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600367 *
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500368 * zlib, upon which libpng depends, is also Y2K compliant. It contains
369 * no date-related code.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600370 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600371 * Glenn Randers-Pehrson
372 * libpng maintainer
373 * PNG Development Group
Glenn Randers-Pehrsonbcfd15d1999-10-01 14:22:25 -0500374 */
375
Glenn Randers-Pehrson13944802000-06-24 07:42:42 -0500376#ifndef PNG_H
377#define PNG_H
Guy Schalnat0d580581995-07-20 02:43:20 -0500378
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500379/* This is not the place to learn how to use libpng. The file libpng-manual.txt
Andreas Dilger47a0c421997-05-16 02:46:07 -0500380 * describes how to use libpng, and the file example.c summarizes it
381 * with some code on which to build. This file is useful for looking
382 * at the actual function definitions and structure components.
John Bowler7875d532011-11-07 22:33:49 -0600383 *
384 * If you just need to read a PNG file and don't want to read the documentation
385 * skip to the end of this file and read the section entitled 'simplified API'.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500386 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500387
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500388/* Version information for png.h - this should match the version in png.c */
Glenn Randers-Pehrsonb23afad2013-07-10 19:30:59 -0500389#define PNG_LIBPNG_VER_STRING "1.6.3rc01"
Glenn Randers-Pehrson5b5dcf82004-07-17 22:45:44 -0500390#define PNG_HEADER_VERSION_STRING \
Glenn Randers-Pehrsonb23afad2013-07-10 19:30:59 -0500391 " libpng version 1.6.3rc01 - July 11, 2013\n"
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500392
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -0600393#define PNG_LIBPNG_VER_SONUM 16
394#define PNG_LIBPNG_VER_DLLNUM 16
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500395
396/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */
397#define PNG_LIBPNG_VER_MAJOR 1
Glenn Randers-Pehrson87fadd52011-11-24 14:35:13 -0600398#define PNG_LIBPNG_VER_MINOR 6
Glenn Randers-Pehrson3f677d12013-04-25 09:12:51 -0500399#define PNG_LIBPNG_VER_RELEASE 3
Glenn Randers-Pehrson87fadd52011-11-24 14:35:13 -0600400
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500401/* This should match the numeric part of the final component of
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500402 * PNG_LIBPNG_VER_STRING, omitting any leading zero:
403 */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600404
Glenn Randers-Pehrsonb23afad2013-07-10 19:30:59 -0500405#define PNG_LIBPNG_VER_BUILD 01
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600406
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600407/* Release Status */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600408#define PNG_LIBPNG_BUILD_ALPHA 1
409#define PNG_LIBPNG_BUILD_BETA 2
410#define PNG_LIBPNG_BUILD_RC 3
411#define PNG_LIBPNG_BUILD_STABLE 4
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600412#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500413
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600414/* Release-Specific Flags */
415#define PNG_LIBPNG_BUILD_PATCH 8 /* Can be OR'ed with
416 PNG_LIBPNG_BUILD_STABLE only */
417#define PNG_LIBPNG_BUILD_PRIVATE 16 /* Cannot be OR'ed with
418 PNG_LIBPNG_BUILD_SPECIAL */
419#define PNG_LIBPNG_BUILD_SPECIAL 32 /* Cannot be OR'ed with
420 PNG_LIBPNG_BUILD_PRIVATE */
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500421
Glenn Randers-Pehrsonb23afad2013-07-10 19:30:59 -0500422#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_RC
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600423
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500424/* Careful here. At one time, Guy wanted to use 082, but that would be octal.
425 * We must not include leading zeros.
426 * Versions 0.7 through 1.0.0 were in the range 0 to 100 here (only
427 * version 1.0.0 was mis-numbered 100 instead of 10000). From
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500428 * version 1.0.1 it's xxyyzz, where x=major, y=minor, z=release
429 */
Glenn Randers-Pehrson3f677d12013-04-25 09:12:51 -0500430#define PNG_LIBPNG_VER 10603 /* 1.6.3 */
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500431
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500432/* Library configuration: these options cannot be changed after
433 * the library has been built.
434 */
435#ifndef PNGLCONF_H
Glenn Randers-Pehrson8c667862010-08-24 16:16:35 -0500436 /* If pnglibconf.h is missing, you can
437 * copy scripts/pnglibconf.h.prebuilt to pnglibconf.h
438 */
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500439# include "pnglibconf.h"
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600440#endif
Guy Schalnat0d580581995-07-20 02:43:20 -0500441
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500442#ifndef PNG_VERSION_INFO_ONLY
John Bowlerbaeb6d12011-11-26 18:21:02 -0600443 /* Machine specific configuration. */
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500444# include "pngconf.h"
445#endif
Guy Schalnat0d580581995-07-20 02:43:20 -0500446
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600447/*
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500448 * Added at libpng-1.2.8
449 *
450 * Ref MSDN: Private as priority over Special
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600451 * VS_FF_PRIVATEBUILD File *was not* built using standard release
452 * procedures. If this value is given, the StringFileInfo block must
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500453 * contain a PrivateBuild string.
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600454 *
455 * VS_FF_SPECIALBUILD File *was* built by the original company using
456 * standard release procedures but is a variation of the standard
457 * file of the same version number. If this value is given, the
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500458 * StringFileInfo block must contain a SpecialBuild string.
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600459 */
460
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500461#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600462# define PNG_LIBPNG_BUILD_TYPE \
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600463 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600464#else
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500465# ifdef PNG_LIBPNG_SPECIALBUILD
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600466# define PNG_LIBPNG_BUILD_TYPE \
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600467 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600468# else
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600469# define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600470# endif
471#endif
472
473#ifndef PNG_VERSION_INFO_ONLY
474
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500475/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
476#ifdef __cplusplus
477extern "C" {
478#endif /* __cplusplus */
479
Andreas Dilger47a0c421997-05-16 02:46:07 -0500480/* Version information for C files, stored in png.c. This had better match
481 * the version above.
482 */
Glenn Randers-Pehrson4c8f7262010-03-16 19:30:01 -0500483#define png_libpng_ver png_get_header_ver(NULL)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500484
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500485/* This file is arranged in several sections:
486 *
487 * 1. Any configuration options that can be specified by for the application
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500488 * code when it is built. (Build time configuration is in pnglibconf.h)
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500489 * 2. Type definitions (base types are defined in pngconf.h), structure
490 * definitions.
491 * 3. Exported library functions.
John Bowler7875d532011-11-07 22:33:49 -0600492 * 4. Simplified API.
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500493 *
494 * The library source code has additional files (principally pngpriv.h) that
495 * allow configuration of the library.
496 */
497/* Section 1: run time configuration
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500498 * See pnglibconf.h for build time configuration
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500499 *
500 * Run time configuration allows the application to choose between
501 * implementations of certain arithmetic APIs. The default is set
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500502 * at build time and recorded in pnglibconf.h, but it is safe to
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500503 * override these (and only these) settings. Note that this won't
504 * change what the library does, only application code, and the
505 * settings can (and probably should) be made on a per-file basis
506 * by setting the #defines before including png.h
507 *
508 * Use macros to read integers from PNG data or use the exported
509 * functions?
510 * PNG_USE_READ_MACROS: use the macros (see below) Note that
511 * the macros evaluate their argument multiple times.
512 * PNG_NO_USE_READ_MACROS: call the relevant library function.
513 *
514 * Use the alternative algorithm for compositing alpha samples that
515 * does not use division?
516 * PNG_READ_COMPOSITE_NODIV_SUPPORTED: use the 'no division'
517 * algorithm.
518 * PNG_NO_READ_COMPOSITE_NODIV: use the 'division' algorithm.
519 *
520 * How to handle benign errors if PNG_ALLOW_BENIGN_ERRORS is
521 * false?
522 * PNG_ALLOW_BENIGN_ERRORS: map calls to the benign error
523 * APIs to png_warning.
524 * Otherwise the calls are mapped to png_error.
525 */
526
527/* Section 2: type definitions, including structures and compile time
528 * constants.
529 * See pngconf.h for base types that vary by machine/system
530 */
Glenn Randers-Pehrson88910f52010-10-16 20:38:45 -0500531
532/* This triggers a compiler error in png.c, if png.c and png.h
533 * do not agree upon the version number.
534 */
Glenn Randers-Pehrsonb23afad2013-07-10 19:30:59 -0500535typedef char* png_libpng_version_1_6_3rc01;
Glenn Randers-Pehrson88910f52010-10-16 20:38:45 -0500536
John Bowler5d567862011-12-24 09:12:00 -0600537/* Basic control structions. Read libpng-manual.txt or libpng.3 for more info.
538 *
539 * png_struct is the cache of information used while reading or writing a single
540 * PNG file. One of these is always required, although the simplified API
541 * (below) hides the creation and destruction of it.
542 */
543typedef struct png_struct_def png_struct;
544typedef const png_struct * png_const_structp;
545typedef png_struct * png_structp;
546typedef png_struct * * png_structpp;
547
548/* png_info contains information read from or to be written to a PNG file. One
549 * or more of these must exist while reading or creating a PNG file. The
550 * information is not used by libpng during read but is used to control what
551 * gets written when a PNG file is created. "png_get_" function calls read
552 * information during read and "png_set_" functions calls write information
553 * when creating a PNG.
554 * been moved into a separate header file that is not accessible to
555 * applications. Read libpng-manual.txt or libpng.3 for more info.
556 */
557typedef struct png_info_def png_info;
558typedef png_info * png_infop;
559typedef const png_info * png_const_infop;
560typedef png_info * * png_infopp;
561
562/* Types with names ending 'p' are pointer types. The corresponding types with
563 * names ending 'rp' are identical pointer types except that the pointer is
564 * marked 'restrict', which means that it is the only pointer to the object
565 * passed to the function. Applications should not use the 'restrict' types;
566 * it is always valid to pass 'p' to a pointer with a function argument of the
567 * corresponding 'rp' type. Different compilers have different rules with
568 * regard to type matching in the presence of 'restrict'. For backward
569 * compatibility libpng callbacks never have 'restrict' in their parameters and,
570 * consequentially, writing portable application code is extremely difficult if
571 * an attempt is made to use 'restrict'.
572 */
573typedef png_struct * PNG_RESTRICT png_structrp;
574typedef const png_struct * PNG_RESTRICT png_const_structrp;
575typedef png_info * PNG_RESTRICT png_inforp;
576typedef const png_info * PNG_RESTRICT png_const_inforp;
577
Andreas Dilger47a0c421997-05-16 02:46:07 -0500578/* Three color definitions. The order of the red, green, and blue, (and the
579 * exact size) is not important, although the size of the fields need to
580 * be png_byte or png_uint_16 (as defined below).
581 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500582typedef struct png_color_struct
583{
Guy Schalnat4ee97b01996-01-16 01:51:56 -0600584 png_byte red;
Guy Schalnat0d580581995-07-20 02:43:20 -0500585 png_byte green;
586 png_byte blue;
587} png_color;
John Bowlerbaeb6d12011-11-26 18:21:02 -0600588typedef png_color * png_colorp;
589typedef const png_color * png_const_colorp;
590typedef png_color * * png_colorpp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500591
592typedef struct png_color_16_struct
593{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500594 png_byte index; /* used for palette files */
595 png_uint_16 red; /* for use in red green blue files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500596 png_uint_16 green;
597 png_uint_16 blue;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500598 png_uint_16 gray; /* for use in grayscale files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500599} png_color_16;
John Bowlerbaeb6d12011-11-26 18:21:02 -0600600typedef png_color_16 * png_color_16p;
601typedef const png_color_16 * png_const_color_16p;
602typedef png_color_16 * * png_color_16pp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500603
604typedef struct png_color_8_struct
605{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500606 png_byte red; /* for use in red green blue files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500607 png_byte green;
608 png_byte blue;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500609 png_byte gray; /* for use in grayscale files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500610 png_byte alpha; /* for alpha channel files */
611} png_color_8;
John Bowlerbaeb6d12011-11-26 18:21:02 -0600612typedef png_color_8 * png_color_8p;
613typedef const png_color_8 * png_const_color_8p;
614typedef png_color_8 * * png_color_8pp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500615
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600616/*
617 * The following two structures are used for the in-core representation
618 * of sPLT chunks.
619 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600620typedef struct png_sPLT_entry_struct
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600621{
622 png_uint_16 red;
623 png_uint_16 green;
624 png_uint_16 blue;
625 png_uint_16 alpha;
626 png_uint_16 frequency;
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600627} png_sPLT_entry;
John Bowlerbaeb6d12011-11-26 18:21:02 -0600628typedef png_sPLT_entry * png_sPLT_entryp;
629typedef const png_sPLT_entry * png_const_sPLT_entryp;
630typedef png_sPLT_entry * * png_sPLT_entrypp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600631
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500632/* When the depth of the sPLT palette is 8 bits, the color and alpha samples
633 * occupy the LSB of their respective members, and the MSB of each member
634 * is zero-filled. The frequency member always occupies the full 16 bits.
635 */
636
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600637typedef struct png_sPLT_struct
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600638{
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500639 png_charp name; /* palette name */
640 png_byte depth; /* depth of palette samples */
641 png_sPLT_entryp entries; /* palette entries */
642 png_int_32 nentries; /* number of palette entries */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600643} png_sPLT_t;
John Bowlerbaeb6d12011-11-26 18:21:02 -0600644typedef png_sPLT_t * png_sPLT_tp;
645typedef const png_sPLT_t * png_const_sPLT_tp;
646typedef png_sPLT_t * * png_sPLT_tpp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600647
648#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600649/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600650 * and whether that contents is compressed or not. The "key" field
Glenn Randers-Pehrson680da022011-11-21 17:05:41 -0600651 * points to a regular zero-terminated C string. The "text" fields can be a
652 * regular C string, an empty string, or a NULL pointer.
Glenn Randers-Pehrson140504b2011-06-15 08:10:13 -0500653 * However, the structure returned by png_get_text() will always contain
Glenn Randers-Pehrson680da022011-11-21 17:05:41 -0600654 * the "text" field as a regular zero-terminated C string (possibly
655 * empty), never a NULL pointer, so it can be safely used in printf() and
656 * other string-handling functions. Note that the "itxt_length", "lang", and
657 * "lang_key" members of the structure only exist when the library is built
658 * with iTXt chunk support. Prior to libpng-1.4.0 the library was built by
659 * default without iTXt support. Also note that when iTXt *is* supported,
660 * the "lang" and "lang_key" fields contain NULL pointers when the
661 * "compression" field contains * PNG_TEXT_COMPRESSION_NONE or
Glenn Randers-Pehrson12fb29f2011-11-22 11:53:49 -0600662 * PNG_TEXT_COMPRESSION_zTXt. Note that the "compression value" is not the
663 * same as what appears in the PNG tEXt/zTXt/iTXt chunk's "compression flag"
664 * which is always 0 or 1, or its "compression method" which is always 0.
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500665 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500666typedef struct png_text_struct
667{
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500668 int compression; /* compression value:
669 -1: tEXt, none
670 0: zTXt, deflate
671 1: iTXt, none
672 2: iTXt, deflate */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500673 png_charp key; /* keyword, 1-79 character description of "text" */
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500674 png_charp text; /* comment, may be an empty string (ie "")
675 or a NULL pointer */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600676 png_size_t text_length; /* length of the text string */
677 png_size_t itxt_length; /* length of the itxt string */
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500678 png_charp lang; /* language code, 0-79 characters
679 or a NULL pointer */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600680 png_charp lang_key; /* keyword translated UTF-8 string, 0 or more
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500681 chars or a NULL pointer */
Guy Schalnat0d580581995-07-20 02:43:20 -0500682} png_text;
John Bowlerbaeb6d12011-11-26 18:21:02 -0600683typedef png_text * png_textp;
684typedef const png_text * png_const_textp;
685typedef png_text * * png_textpp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600686#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -0500687
688/* Supported compression types for text in PNG files (tEXt, and zTXt).
689 * The values of the PNG_TEXT_COMPRESSION_ defines should NOT be changed. */
690#define PNG_TEXT_COMPRESSION_NONE_WR -3
691#define PNG_TEXT_COMPRESSION_zTXt_WR -2
692#define PNG_TEXT_COMPRESSION_NONE -1
693#define PNG_TEXT_COMPRESSION_zTXt 0
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600694#define PNG_ITXT_COMPRESSION_NONE 1
695#define PNG_ITXT_COMPRESSION_zTXt 2
696#define PNG_TEXT_COMPRESSION_LAST 3 /* Not a valid value */
Guy Schalnat0d580581995-07-20 02:43:20 -0500697
698/* png_time is a way to hold the time in an machine independent way.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600699 * Two conversions are provided, both from time_t and struct tm. There
700 * is no portable way to convert to either of these structures, as far
701 * 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 -0600702 * note - PNG has always been Year 2000 compliant!
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600703 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500704typedef struct png_time_struct
705{
706 png_uint_16 year; /* full year, as in, 1995 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500707 png_byte month; /* month of year, 1 - 12 */
708 png_byte day; /* day of month, 1 - 31 */
709 png_byte hour; /* hour of day, 0 - 23 */
710 png_byte minute; /* minute of hour, 0 - 59 */
711 png_byte second; /* second of minute, 0 - 60 (for leap seconds) */
Guy Schalnat0d580581995-07-20 02:43:20 -0500712} png_time;
John Bowlerbaeb6d12011-11-26 18:21:02 -0600713typedef png_time * png_timep;
714typedef const png_time * png_const_timep;
715typedef png_time * * png_timepp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500716
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600717#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600718/* png_unknown_chunk is a structure to hold queued chunks for which there is
719 * no specific support. The idea is that we can use this to queue
720 * up private chunks for output even though the library doesn't actually
721 * know about their semantics.
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600722 *
723 * The data in the structure is set by libpng on read and used on write.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600724 */
725typedef struct png_unknown_chunk_t
726{
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600727 png_byte name[5]; /* Textual chunk name with '\0' terminator */
728 png_byte *data; /* Data, should not be modified on read! */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600729 png_size_t size;
730
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600731 /* On write 'location' must be set using the flag values listed below.
732 * Notice that on read it is set by libpng however the values stored have
733 * more bits set than are listed below. Always treat the value as a
734 * bitmask. On write set only one bit - setting multiple bits may cause the
735 * chunk to be written in multiple places.
736 */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600737 png_byte location; /* mode of operation at read time */
738}
739png_unknown_chunk;
John Bowler40b26032011-12-22 08:09:15 -0600740
John Bowlerbaeb6d12011-11-26 18:21:02 -0600741typedef png_unknown_chunk * png_unknown_chunkp;
742typedef const png_unknown_chunk * png_const_unknown_chunkp;
743typedef png_unknown_chunk * * png_unknown_chunkpp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600744#endif
745
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600746/* Flag values for the unknown chunk location byte. */
Glenn Randers-Pehrsonfd73d042011-06-13 13:25:21 -0500747#define PNG_HAVE_IHDR 0x01
748#define PNG_HAVE_PLTE 0x02
749#define PNG_AFTER_IDAT 0x08
Glenn Randers-Pehrson2d3fc1c2011-05-10 23:48:00 -0500750
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500751/* Maximum positive integer used in PNG is (2^31)-1 */
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500752#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
Glenn Randers-Pehrson78067772004-11-02 21:49:39 -0600753#define PNG_UINT_32_MAX ((png_uint_32)(-1))
754#define PNG_SIZE_MAX ((png_size_t)(-1))
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500755
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500756/* These are constants for fixed point values encoded in the
757 * PNG specification manner (x100000)
758 */
759#define PNG_FP_1 100000
760#define PNG_FP_HALF 50000
John Bowlerd273ad22011-05-07 21:00:28 -0500761#define PNG_FP_MAX ((png_fixed_point)0x7fffffffL)
762#define PNG_FP_MIN (-PNG_FP_MAX)
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500763
Andreas Dilger47a0c421997-05-16 02:46:07 -0500764/* These describe the color_type field in png_info. */
Guy Schalnat0d580581995-07-20 02:43:20 -0500765/* color type masks */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500766#define PNG_COLOR_MASK_PALETTE 1
767#define PNG_COLOR_MASK_COLOR 2
768#define PNG_COLOR_MASK_ALPHA 4
Guy Schalnat0d580581995-07-20 02:43:20 -0500769
770/* color types. Note that not all combinations are legal */
Guy Schalnate5a37791996-06-05 15:50:50 -0500771#define PNG_COLOR_TYPE_GRAY 0
Andreas Dilger47a0c421997-05-16 02:46:07 -0500772#define PNG_COLOR_TYPE_PALETTE (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE)
773#define PNG_COLOR_TYPE_RGB (PNG_COLOR_MASK_COLOR)
774#define PNG_COLOR_TYPE_RGB_ALPHA (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA)
Guy Schalnat0d580581995-07-20 02:43:20 -0500775#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600776/* aliases */
777#define PNG_COLOR_TYPE_RGBA PNG_COLOR_TYPE_RGB_ALPHA
778#define PNG_COLOR_TYPE_GA PNG_COLOR_TYPE_GRAY_ALPHA
Guy Schalnat0d580581995-07-20 02:43:20 -0500779
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500780/* This is for compression type. PNG 1.0-1.2 only define the single type. */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500781#define PNG_COMPRESSION_TYPE_BASE 0 /* Deflate method 8, 32K window */
782#define PNG_COMPRESSION_TYPE_DEFAULT PNG_COMPRESSION_TYPE_BASE
783
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500784/* This is for filter type. PNG 1.0-1.2 only define the single type. */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500785#define PNG_FILTER_TYPE_BASE 0 /* Single row per-byte filtering */
Glenn Randers-Pehrson2ad31ae2000-12-15 08:54:42 -0600786#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500787#define PNG_FILTER_TYPE_DEFAULT PNG_FILTER_TYPE_BASE
788
789/* These are for the interlacing type. These values should NOT be changed. */
790#define PNG_INTERLACE_NONE 0 /* Non-interlaced image */
791#define PNG_INTERLACE_ADAM7 1 /* Adam7 interlacing */
792#define PNG_INTERLACE_LAST 2 /* Not a valid value */
793
794/* These are for the oFFs chunk. These values should NOT be changed. */
795#define PNG_OFFSET_PIXEL 0 /* Offset in pixels */
796#define PNG_OFFSET_MICROMETER 1 /* Offset in micrometers (1/10^6 meter) */
797#define PNG_OFFSET_LAST 2 /* Not a valid value */
798
799/* These are for the pCAL chunk. These values should NOT be changed. */
800#define PNG_EQUATION_LINEAR 0 /* Linear transformation */
801#define PNG_EQUATION_BASE_E 1 /* Exponential base e transform */
802#define PNG_EQUATION_ARBITRARY 2 /* Arbitrary base exponential transform */
803#define PNG_EQUATION_HYPERBOLIC 3 /* Hyperbolic sine transformation */
804#define PNG_EQUATION_LAST 4 /* Not a valid value */
805
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600806/* These are for the sCAL chunk. These values should NOT be changed. */
807#define PNG_SCALE_UNKNOWN 0 /* unknown unit (image scale) */
808#define PNG_SCALE_METER 1 /* meters per pixel */
809#define PNG_SCALE_RADIAN 2 /* radians per pixel */
810#define PNG_SCALE_LAST 3 /* Not a valid value */
811
Andreas Dilger47a0c421997-05-16 02:46:07 -0500812/* These are for the pHYs chunk. These values should NOT be changed. */
813#define PNG_RESOLUTION_UNKNOWN 0 /* pixels/unknown unit (aspect ratio) */
814#define PNG_RESOLUTION_METER 1 /* pixels/meter */
815#define PNG_RESOLUTION_LAST 2 /* Not a valid value */
816
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600817/* These are for the sRGB chunk. These values should NOT be changed. */
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600818#define PNG_sRGB_INTENT_PERCEPTUAL 0
819#define PNG_sRGB_INTENT_RELATIVE 1
820#define PNG_sRGB_INTENT_SATURATION 2
821#define PNG_sRGB_INTENT_ABSOLUTE 3
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600822#define PNG_sRGB_INTENT_LAST 4 /* Not a valid value */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600823
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600824/* This is for text chunks */
825#define PNG_KEYWORD_MAX_LENGTH 79
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600826
Glenn Randers-Pehrson76e5fd62000-12-28 07:50:05 -0600827/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
Glenn Randers-Pehrsond1e8c862002-06-20 06:54:34 -0500828#define PNG_MAX_PALETTE_LENGTH 256
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600829
Andreas Dilger47a0c421997-05-16 02:46:07 -0500830/* These determine if an ancillary chunk's data has been successfully read
831 * from the PNG header, or if the application has filled in the corresponding
832 * data in the info_struct to be written into the output file. The values
833 * of the PNG_INFO_<chunk> defines should NOT be changed.
834 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500835#define PNG_INFO_gAMA 0x0001
836#define PNG_INFO_sBIT 0x0002
837#define PNG_INFO_cHRM 0x0004
838#define PNG_INFO_PLTE 0x0008
839#define PNG_INFO_tRNS 0x0010
840#define PNG_INFO_bKGD 0x0020
841#define PNG_INFO_hIST 0x0040
842#define PNG_INFO_pHYs 0x0080
843#define PNG_INFO_oFFs 0x0100
844#define PNG_INFO_tIME 0x0200
Andreas Dilger47a0c421997-05-16 02:46:07 -0500845#define PNG_INFO_pCAL 0x0400
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600846#define PNG_INFO_sRGB 0x0800 /* GR-P, 0.96a */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600847#define PNG_INFO_iCCP 0x1000 /* ESR, 1.0.6 */
848#define PNG_INFO_sPLT 0x2000 /* ESR, 1.0.6 */
849#define PNG_INFO_sCAL 0x4000 /* ESR, 1.0.6 */
John Bowlerf3f7e142011-09-09 07:32:37 -0500850#define PNG_INFO_IDAT 0x8000 /* ESR, 1.0.6 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500851
Andreas Dilger47a0c421997-05-16 02:46:07 -0500852/* This is used for the transformation routines, as some of them
853 * change these values for the row. It also should enable using
854 * the routines for other purposes.
855 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500856typedef struct png_row_info_struct
857{
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -0600858 png_uint_32 width; /* width of row */
859 png_size_t rowbytes; /* number of bytes in row */
860 png_byte color_type; /* color type of row */
861 png_byte bit_depth; /* bit depth of row */
862 png_byte channels; /* number of channels (1, 2, 3, or 4) */
Guy Schalnat4ee97b01996-01-16 01:51:56 -0600863 png_byte pixel_depth; /* bits per pixel (depth * channels) */
Guy Schalnat0d580581995-07-20 02:43:20 -0500864} png_row_info;
865
John Bowlerbaeb6d12011-11-26 18:21:02 -0600866typedef png_row_info * png_row_infop;
867typedef png_row_info * * png_row_infopp;
Guy Schalnat0f716451995-11-28 11:22:13 -0600868
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500869/* These are the function types for the I/O functions and for the functions
870 * that allow the user to override the default I/O functions with his or her
871 * own. The png_error_ptr type should match that of user-supplied warning
872 * and error functions, while the png_rw_ptr type should match that of the
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500873 * user read/write data functions. Note that the 'write' function must not
Glenn Randers-Pehrsonea2f7e02010-08-18 08:14:54 -0500874 * modify the buffer it is passed. The 'read' function, on the other hand, is
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500875 * expected to return the read data in the buffer.
Guy Schalnat0f716451995-11-28 11:22:13 -0600876 */
John Bowler9c693602011-02-12 08:58:21 -0600877typedef PNG_CALLBACK(void, *png_error_ptr, (png_structp, png_const_charp));
878typedef PNG_CALLBACK(void, *png_rw_ptr, (png_structp, png_bytep, png_size_t));
879typedef PNG_CALLBACK(void, *png_flush_ptr, (png_structp));
880typedef PNG_CALLBACK(void, *png_read_status_ptr, (png_structp, png_uint_32,
881 int));
882typedef PNG_CALLBACK(void, *png_write_status_ptr, (png_structp, png_uint_32,
883 int));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600884
Guy Schalnat69b14481996-01-10 02:56:49 -0600885#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
John Bowler9c693602011-02-12 08:58:21 -0600886typedef PNG_CALLBACK(void, *png_progressive_info_ptr, (png_structp, png_infop));
887typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop));
John Bowler9616ad92011-02-16 06:13:46 -0600888
889/* The following callback receives png_uint_32 row_number, int pass for the
890 * png_bytep data of the row. When transforming an interlaced image the
891 * row number is the row number within the sub-image of the interlace pass, so
892 * the value will increase to the height of the sub-image (not the full image)
893 * then reset to 0 for the next pass.
894 *
895 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
896 * find the output pixel (x,y) given an interlaced sub-image pixel
897 * (row,col,pass). (See below for these macros.)
898 */
John Bowler9c693602011-02-12 08:58:21 -0600899typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600900 png_uint_32, int));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600901#endif
Guy Schalnat6d764711995-12-19 03:22:19 -0600902
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600903#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -0500904 defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
John Bowler9c693602011-02-12 08:58:21 -0600905typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600906 png_bytep));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600907#endif
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600908
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500909#ifdef PNG_USER_CHUNKS_SUPPORTED
John Bowler9c693602011-02-12 08:58:21 -0600910typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600911 png_unknown_chunkp));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600912#endif
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500913#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600914/* not used anywhere */
915/* typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp)); */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600916#endif
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -0600917
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600918#ifdef PNG_SETJMP_SUPPORTED
John Bowlerb302c472011-04-15 06:37:34 -0500919/* This must match the function definition in <setjmp.h>, and the application
920 * must include this before png.h to obtain the definition of jmp_buf. The
921 * function is required to be PNG_NORETURN, but this is not checked. If the
922 * function does return the application will crash via an abort() or similar
923 * system level call.
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500924 *
John Bowlerb302c472011-04-15 06:37:34 -0500925 * If you get a warning here while building the library you may need to make
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500926 * changes to ensure that pnglibconf.h records the calling convention used by
927 * your compiler. This may be very difficult - try using a different compiler
928 * to build the library!
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600929 */
John Bowlerb302c472011-04-15 06:37:34 -0500930PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)), typedef);
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600931#endif
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600932
933/* Transform masks for the high-level interface */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600934#define PNG_TRANSFORM_IDENTITY 0x0000 /* read and write */
935#define PNG_TRANSFORM_STRIP_16 0x0001 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600936#define PNG_TRANSFORM_STRIP_ALPHA 0x0002 /* read only */
937#define PNG_TRANSFORM_PACKING 0x0004 /* read and write */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600938#define PNG_TRANSFORM_PACKSWAP 0x0008 /* read and write */
939#define PNG_TRANSFORM_EXPAND 0x0010 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600940#define PNG_TRANSFORM_INVERT_MONO 0x0020 /* read and write */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600941#define PNG_TRANSFORM_SHIFT 0x0040 /* read and write */
942#define PNG_TRANSFORM_BGR 0x0080 /* read and write */
943#define PNG_TRANSFORM_SWAP_ALPHA 0x0100 /* read and write */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600944#define PNG_TRANSFORM_SWAP_ENDIAN 0x0200 /* read and write */
Glenn Randers-Pehrsondb66d442000-06-23 21:38:16 -0500945#define PNG_TRANSFORM_INVERT_ALPHA 0x0400 /* read and write */
Glenn Randers-Pehrson99708d52009-06-29 17:30:00 -0500946#define PNG_TRANSFORM_STRIP_FILLER 0x0800 /* write only */
Glenn Randers-Pehrson1eb14e92008-12-10 07:14:45 -0600947/* Added to libpng-1.2.34 */
Glenn Randers-Pehrson0ffb71a2009-02-28 06:08:20 -0600948#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
Glenn Randers-Pehrson99708d52009-06-29 17:30:00 -0500949#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
950/* Added to libpng-1.4.0 */
951#define PNG_TRANSFORM_GRAY_TO_RGB 0x2000 /* read only */
Glenn Randers-Pehrsonef217b72011-06-15 12:58:27 -0500952/* Added to libpng-1.5.4 */
John Bowlera9b34192011-05-08 19:46:51 -0500953#define PNG_TRANSFORM_EXPAND_16 0x4000 /* read only */
Glenn Randers-Pehrsonab63dd02011-06-17 20:04:17 -0500954#define PNG_TRANSFORM_SCALE_16 0x8000 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600955
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600956/* Flags for MNG supported features */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600957#define PNG_FLAG_MNG_EMPTY_PLTE 0x01
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600958#define PNG_FLAG_MNG_FILTER_64 0x04
Glenn Randers-Pehrson408b4212000-12-18 09:33:57 -0600959#define PNG_ALL_MNG_FEATURES 0x05
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600960
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600961/* NOTE: prior to 1.5 these functions had no 'API' style declaration,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600962 * this allowed the zlib default functions to be used on Windows
963 * platforms. In 1.5 the zlib default malloc (which just calls malloc and
964 * ignores the first argument) should be completely compatible with the
965 * following.
966 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600967typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,
John Bowler9c693602011-02-12 08:58:21 -0600968 png_alloc_size_t));
969typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp));
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500970
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500971/* Section 3: exported functions
972 * Here are the function definitions most commonly used. This is not
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500973 * the place to find out how to use libpng. See libpng-manual.txt for the
Andreas Dilger47a0c421997-05-16 02:46:07 -0500974 * full explanation, see example.c for the summary. This just provides
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600975 * a simple one line description of the use of each function.
Glenn Randers-Pehrsona4517252010-12-06 08:54:55 -0600976 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600977 * The PNG_EXPORT() and PNG_EXPORTA() macros used below are defined in
978 * pngconf.h and in the *.dfn files in the scripts directory.
Glenn Randers-Pehrsona4517252010-12-06 08:54:55 -0600979 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600980 * PNG_EXPORT(ordinal, type, name, (args));
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600981 *
982 * ordinal: ordinal that is used while building
983 * *.def files. The ordinal value is only
984 * relevant when preprocessing png.h with
985 * the *.dfn files for building symbol table
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600986 * entries, and are removed by pngconf.h.
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600987 * type: return type of the function
988 * name: function name
989 * args: function arguments, with types
990 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600991 * When we wish to append attributes to a function prototype we use
992 * the PNG_EXPORTA() macro instead.
993 *
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600994 * PNG_EXPORTA(ordinal, type, name, (args), attributes);
995 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600996 * ordinal, type, name, and args: same as in PNG_EXPORT().
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -0600997 * attributes: function attributes
Andreas Dilger47a0c421997-05-16 02:46:07 -0500998 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500999
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001000/* Returns the version number of the library */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001001PNG_EXPORT(1, png_uint_32, png_access_version_number, (void));
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001002
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001003/* Tell lib we have already handled the first <num_bytes> magic bytes.
Andreas Dilger47a0c421997-05-16 02:46:07 -05001004 * Handling more than 8 bytes from the beginning of the file is an error.
1005 */
John Bowler5d567862011-12-24 09:12:00 -06001006PNG_EXPORT(2, void, png_set_sig_bytes, (png_structrp png_ptr, int num_bytes));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001007
Andreas Dilger47a0c421997-05-16 02:46:07 -05001008/* Check sig[start] through sig[start + num_to_check - 1] to see if it's a
1009 * PNG file. Returns zero if the supplied bytes match the 8-byte PNG
1010 * signature, and non-zero otherwise. Having num_to_check == 0 or
1011 * start > 7 will always fail (ie return non-zero).
1012 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001013PNG_EXPORT(3, int, png_sig_cmp, (png_const_bytep sig, png_size_t start,
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001014 png_size_t num_to_check));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001015
Glenn Randers-Pehrson3e42a992010-03-31 22:16:07 -05001016/* Simple signature checking function. This is the same as calling
1017 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
1018 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001019#define png_check_sig(sig, n) !png_sig_cmp((sig), 0, (n))
Glenn Randers-Pehrson3e42a992010-03-31 22:16:07 -05001020
Andreas Dilger47a0c421997-05-16 02:46:07 -05001021/* Allocate and initialize png_ptr struct for reading, and any other memory. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001022PNG_EXPORTA(4, png_structp, png_create_read_struct,
1023 (png_const_charp user_png_ver, png_voidp error_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001024 png_error_ptr error_fn, png_error_ptr warn_fn),
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001025 PNG_ALLOCATED);
Guy Schalnat0d580581995-07-20 02:43:20 -05001026
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001027/* Allocate and initialize png_ptr struct for writing, and any other memory */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001028PNG_EXPORTA(5, png_structp, png_create_write_struct,
1029 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001030 png_error_ptr warn_fn),
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001031 PNG_ALLOCATED);
Guy Schalnate5a37791996-06-05 15:50:50 -05001032
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001033PNG_EXPORT(6, png_size_t, png_get_compression_buffer_size,
John Bowler5d567862011-12-24 09:12:00 -06001034 (png_const_structrp png_ptr));
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -05001035
John Bowler5d567862011-12-24 09:12:00 -06001036PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structrp png_ptr,
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001037 png_size_t size));
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -05001038
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001039/* Moved from pngconf.h in 1.4.0 and modified to ensure setjmp/longjmp
1040 * match up.
1041 */
1042#ifdef PNG_SETJMP_SUPPORTED
1043/* This function returns the jmp_buf built in to *png_ptr. It must be
1044 * supplied with an appropriate 'longjmp' function to use on that jmp_buf
1045 * unless the default error function is overridden in which case NULL is
1046 * acceptable. The size of the jmp_buf is checked against the actual size
1047 * allocated by the library - the call will return NULL on a mismatch
1048 * indicating an ABI mismatch.
1049 */
John Bowler5d567862011-12-24 09:12:00 -06001050PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structrp png_ptr,
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001051 png_longjmp_ptr longjmp_fn, size_t jmp_buf_size));
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001052# define png_jmpbuf(png_ptr) \
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001053 (*png_set_longjmp_fn((png_ptr), longjmp, (sizeof (jmp_buf))))
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001054#else
1055# define png_jmpbuf(png_ptr) \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06001056 (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001057#endif
Glenn Randers-Pehrsonf98726a2010-02-19 09:54:53 -06001058/* This function should be used by libpng applications in place of
1059 * longjmp(png_ptr->jmpbuf, val). If longjmp_fn() has been set, it
1060 * will use it; otherwise it will call PNG_ABORT(). This function was
1061 * added in libpng-1.5.0.
1062 */
John Bowler5d567862011-12-24 09:12:00 -06001063PNG_EXPORTA(9, void, png_longjmp, (png_const_structrp png_ptr, int val),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001064 PNG_NORETURN);
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001065
Glenn Randers-Pehrson2b8bef12010-04-29 11:50:24 -05001066#ifdef PNG_READ_SUPPORTED
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -05001067/* Reset the compression stream */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001068PNG_EXPORTA(10, int, png_reset_zstream, (png_structrp png_ptr), PNG_DEPRECATED);
Glenn Randers-Pehrson2b8bef12010-04-29 11:50:24 -05001069#endif
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -05001070
Glenn Randers-Pehrson8b6a8892001-05-18 04:54:50 -05001071/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001072#ifdef PNG_USER_MEM_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001073PNG_EXPORTA(11, png_structp, png_create_read_struct_2,
1074 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001075 png_error_ptr warn_fn,
1076 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001077 PNG_ALLOCATED);
1078PNG_EXPORTA(12, png_structp, png_create_write_struct_2,
1079 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001080 png_error_ptr warn_fn,
1081 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001082 PNG_ALLOCATED);
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001083#endif
1084
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001085/* Write the PNG file signature. */
John Bowler5d567862011-12-24 09:12:00 -06001086PNG_EXPORT(13, void, png_write_sig, (png_structrp png_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001087
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001088/* Write a PNG chunk - size, type, (optional) data, CRC. */
John Bowler5d567862011-12-24 09:12:00 -06001089PNG_EXPORT(14, void, png_write_chunk, (png_structrp png_ptr, png_const_bytep
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001090 chunk_name, png_const_bytep data, png_size_t length));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001091
1092/* Write the start of a PNG chunk - length and chunk name. */
John Bowler5d567862011-12-24 09:12:00 -06001093PNG_EXPORT(15, void, png_write_chunk_start, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001094 png_const_bytep chunk_name, png_uint_32 length));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001095
1096/* Write the data of a PNG chunk started with png_write_chunk_start(). */
John Bowler5d567862011-12-24 09:12:00 -06001097PNG_EXPORT(16, void, png_write_chunk_data, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001098 png_const_bytep data, png_size_t length));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001099
1100/* Finish a chunk started with png_write_chunk_start() (includes CRC). */
John Bowler5d567862011-12-24 09:12:00 -06001101PNG_EXPORT(17, void, png_write_chunk_end, (png_structrp png_ptr));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001102
Andreas Dilger47a0c421997-05-16 02:46:07 -05001103/* Allocate and initialize the info structure */
John Bowler5d567862011-12-24 09:12:00 -06001104PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_const_structrp png_ptr),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001105 PNG_ALLOCATED);
Guy Schalnat0d580581995-07-20 02:43:20 -05001106
John Bowler40b26032011-12-22 08:09:15 -06001107/* DEPRECATED: this function allowed init structures to be created using the
1108 * default allocation method (typically malloc). Use is deprecated in 1.6.0 and
1109 * the API will be removed in the future.
1110 */
John Bowlerd332c672011-12-21 17:36:12 -06001111PNG_EXPORTA(19, void, png_info_init_3, (png_infopp info_ptr,
1112 png_size_t png_info_struct_size), PNG_DEPRECATED);
Guy Schalnat0d580581995-07-20 02:43:20 -05001113
Andreas Dilger47a0c421997-05-16 02:46:07 -05001114/* Writes all the PNG information before the image. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001115PNG_EXPORT(20, void, png_write_info_before_PLTE,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001116 (png_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001117PNG_EXPORT(21, void, png_write_info,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001118 (png_structrp png_ptr, png_const_inforp info_ptr));
Guy Schalnat0d580581995-07-20 02:43:20 -05001119
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001120#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001121/* Read the information before the actual image data. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001122PNG_EXPORT(22, void, png_read_info,
John Bowler5d567862011-12-24 09:12:00 -06001123 (png_structrp png_ptr, png_inforp info_ptr));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001124#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001125
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001126#ifdef PNG_TIME_RFC1123_SUPPORTED
John Bowler40b26032011-12-22 08:09:15 -06001127 /* Convert to a US string format: there is no localization support in this
1128 * routine. The original implementation used a 29 character buffer in
1129 * png_struct, this will be removed in future versions.
1130 */
1131#if PNG_LIBPNG_VER < 10700
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001132/* To do: remove this from libpng17 (and from libpng17/png.c and pngstruct.h) */
John Bowler5d567862011-12-24 09:12:00 -06001133PNG_EXPORTA(23, png_const_charp, png_convert_to_rfc1123, (png_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001134 png_const_timep ptime),PNG_DEPRECATED);
1135#endif
1136PNG_EXPORT(241, int, png_convert_to_rfc1123_buffer, (char out[29],
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001137 png_const_timep ptime));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001138#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001139
Glenn Randers-Pehrson0cb46e22009-11-02 11:24:33 -06001140#ifdef PNG_CONVERT_tIME_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001141/* Convert from a struct tm to png_time */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001142PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime,
John Bowlerbaeb6d12011-11-26 18:21:02 -06001143 const struct tm * ttime));
Guy Schalnat0d580581995-07-20 02:43:20 -05001144
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001145/* Convert from time_t to png_time. Uses gmtime() */
John Bowler40b26032011-12-22 08:09:15 -06001146PNG_EXPORT(25, void, png_convert_from_time_t, (png_timep ptime, time_t ttime));
Glenn Randers-Pehrson0cb46e22009-11-02 11:24:33 -06001147#endif /* PNG_CONVERT_tIME_SUPPORTED */
Guy Schalnat0d580581995-07-20 02:43:20 -05001148
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001149#ifdef PNG_READ_EXPAND_SUPPORTED
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001150/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
John Bowler5d567862011-12-24 09:12:00 -06001151PNG_EXPORT(26, void, png_set_expand, (png_structrp png_ptr));
1152PNG_EXPORT(27, void, png_set_expand_gray_1_2_4_to_8, (png_structrp png_ptr));
1153PNG_EXPORT(28, void, png_set_palette_to_rgb, (png_structrp png_ptr));
1154PNG_EXPORT(29, void, png_set_tRNS_to_alpha, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001155#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001156
John Bowler4d562962011-02-12 09:01:20 -06001157#ifdef PNG_READ_EXPAND_16_SUPPORTED
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001158/* Expand to 16-bit channels, forces conversion of palette to RGB and expansion
John Bowler4d562962011-02-12 09:01:20 -06001159 * of a tRNS chunk if present.
1160 */
John Bowler5d567862011-12-24 09:12:00 -06001161PNG_EXPORT(221, void, png_set_expand_16, (png_structrp png_ptr));
John Bowler4d562962011-02-12 09:01:20 -06001162#endif
1163
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001164#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
Guy Schalnat0d580581995-07-20 02:43:20 -05001165/* Use blue, green, red order for pixels. */
John Bowler5d567862011-12-24 09:12:00 -06001166PNG_EXPORT(30, void, png_set_bgr, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001167#endif
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001168
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001169#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001170/* Expand the grayscale to 24-bit RGB if necessary. */
John Bowler5d567862011-12-24 09:12:00 -06001171PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structrp png_ptr));
John Bowlerf21a0d02011-01-23 23:55:19 -06001172#endif
Guy Schalnat69b14481996-01-10 02:56:49 -06001173
John Bowlerf21a0d02011-01-23 23:55:19 -06001174#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001175/* Reduce RGB to grayscale. */
John Bowler7875d532011-11-07 22:33:49 -06001176#define PNG_ERROR_ACTION_NONE 1
1177#define PNG_ERROR_ACTION_WARN 2
1178#define PNG_ERROR_ACTION_ERROR 3
1179#define PNG_RGB_TO_GRAY_DEFAULT (-1)/*for red/green coefficients*/
1180
John Bowler5d567862011-12-24 09:12:00 -06001181PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001182 int error_action, double red, double green))
John Bowler5d567862011-12-24 09:12:00 -06001183PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001184 int error_action, png_fixed_point red, png_fixed_point green))
Glenn Randers-Pehrsona272d8f2010-06-25 21:45:31 -05001185
John Bowler5d567862011-12-24 09:12:00 -06001186PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structrp
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001187 png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001188#endif
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001189
John Bowler4a12f4a2011-04-17 18:34:22 -05001190#ifdef PNG_BUILD_GRAYSCALE_PALETTE_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001191PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001192 png_colorp palette));
John Bowler4a12f4a2011-04-17 18:34:22 -05001193#endif
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001194
John Bowlerd273ad22011-05-07 21:00:28 -05001195#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
1196/* How the alpha channel is interpreted - this affects how the color channels of
Glenn Randers-Pehrson44e26d42011-05-08 22:56:42 -05001197 * a PNG file are returned when an alpha channel, or tRNS chunk in a palette
1198 * file, is present.
John Bowlerd273ad22011-05-07 21:00:28 -05001199 *
Glenn Randers-Pehrson44e26d42011-05-08 22:56:42 -05001200 * This has no effect on the way pixels are written into a PNG output
1201 * datastream. The color samples in a PNG datastream are never premultiplied
1202 * with the alpha samples.
1203 *
1204 * The default is to return data according to the PNG specification: the alpha
John Bowlerd273ad22011-05-07 21:00:28 -05001205 * channel is a linear measure of the contribution of the pixel to the
Glenn Randers-Pehrson44e26d42011-05-08 22:56:42 -05001206 * corresponding composited pixel. The gamma encoded color channels must be
1207 * scaled according to the contribution and to do this it is necessary to undo
1208 * the encoding, scale the color values, perform the composition and reencode
1209 * the values. This is the 'PNG' mode.
John Bowlerd273ad22011-05-07 21:00:28 -05001210 *
1211 * The alternative is to 'associate' the alpha with the color information by
1212 * storing color channel values that have been scaled by the alpha. The
1213 * advantage is that the color channels can be resampled (the image can be
1214 * scaled) in this form. The disadvantage is that normal practice is to store
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001215 * linear, not (gamma) encoded, values and this requires 16-bit channels for
1216 * still images rather than the 8-bit channels that are just about sufficient if
John Bowlerd273ad22011-05-07 21:00:28 -05001217 * gamma encoding is used. In addition all non-transparent pixel values,
1218 * including completely opaque ones, must be gamma encoded to produce the final
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001219 * image. This is the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' mode (the
John Bowlerd273ad22011-05-07 21:00:28 -05001220 * latter being the two common names for associated alpha color channels.)
1221 *
1222 * Since it is not necessary to perform arithmetic on opaque color values so
1223 * long as they are not to be resampled and are in the final color space it is
1224 * possible to optimize the handling of alpha by storing the opaque pixels in
1225 * the PNG format (adjusted for the output color space) while storing partially
1226 * opaque pixels in the standard, linear, format. The accuracy required for
1227 * standard alpha composition is relatively low, because the pixels are
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001228 * isolated, therefore typically the accuracy loss in storing 8-bit linear
John Bowlerd273ad22011-05-07 21:00:28 -05001229 * values is acceptable. (This is not true if the alpha channel is used to
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001230 * simulate transparency over large areas - use 16 bits or the PNG mode in
1231 * this case!) This is the 'OPTIMIZED' mode. For this mode a pixel is
John Bowlerd273ad22011-05-07 21:00:28 -05001232 * treated as opaque only if the alpha value is equal to the maximum value.
1233 *
1234 * The final choice is to gamma encode the alpha channel as well. This is
1235 * broken because, in practice, no implementation that uses this choice
1236 * correctly undoes the encoding before handling alpha composition. Use this
1237 * choice only if other serious errors in the software or hardware you use
1238 * mandate it; the typical serious error is for dark halos to appear around
1239 * opaque areas of the composited PNG image because of arithmetic overflow.
1240 *
1241 * The API function png_set_alpha_mode specifies which of these choices to use
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001242 * with an enumerated 'mode' value and the gamma of the required output:
John Bowlerd273ad22011-05-07 21:00:28 -05001243 */
1244#define PNG_ALPHA_PNG 0 /* according to the PNG standard */
1245#define PNG_ALPHA_STANDARD 1 /* according to Porter/Duff */
1246#define PNG_ALPHA_ASSOCIATED 1 /* as above; this is the normal practice */
1247#define PNG_ALPHA_PREMULTIPLIED 1 /* as above */
1248#define PNG_ALPHA_OPTIMIZED 2 /* 'PNG' for opaque pixels, else 'STANDARD' */
1249#define PNG_ALPHA_BROKEN 3 /* the alpha channel is gamma encoded */
1250
John Bowler5d567862011-12-24 09:12:00 -06001251PNG_FP_EXPORT(227, void, png_set_alpha_mode, (png_structrp png_ptr, int mode,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001252 double output_gamma))
John Bowler5d567862011-12-24 09:12:00 -06001253PNG_FIXED_EXPORT(228, void, png_set_alpha_mode_fixed, (png_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001254 int mode, png_fixed_point output_gamma))
John Bowlerf70c7d02011-05-10 22:54:37 -05001255#endif
John Bowlerd273ad22011-05-07 21:00:28 -05001256
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001257#if defined(PNG_GAMMA_SUPPORTED) || defined(PNG_READ_ALPHA_MODE_SUPPORTED)
John Bowlerd273ad22011-05-07 21:00:28 -05001258/* The output_gamma value is a screen gamma in libpng terminology: it expresses
1259 * how to decode the output values, not how they are encoded. The values used
1260 * correspond to the normal numbers used to describe the overall gamma of a
1261 * computer display system; for example 2.2 for an sRGB conformant system. The
1262 * values are scaled by 100000 in the _fixed version of the API (so 220000 for
1263 * sRGB.)
1264 *
1265 * The inverse of the value is always used to provide a default for the PNG file
1266 * encoding if it has no gAMA chunk and if png_set_gamma() has not been called
1267 * to override the PNG gamma information.
1268 *
1269 * When the ALPHA_OPTIMIZED mode is selected the output gamma is used to encode
1270 * opaque pixels however pixels with lower alpha values are not encoded,
1271 * regardless of the output gamma setting.
1272 *
1273 * When the standard Porter Duff handling is requested with mode 1 the output
1274 * encoding is set to be linear and the output_gamma value is only relevant
1275 * as a default for input data that has no gamma information. The linear output
1276 * encoding will be overridden if png_set_gamma() is called - the results may be
1277 * highly unexpected!
1278 *
1279 * The following numbers are derived from the sRGB standard and the research
1280 * behind it. sRGB is defined to be approximated by a PNG gAMA chunk value of
1281 * 0.45455 (1/2.2) for PNG. The value implicitly includes any viewing
1282 * correction required to take account of any differences in the color
1283 * environment of the original scene and the intended display environment; the
1284 * value expresses how to *decode* the image for display, not how the original
1285 * data was *encoded*.
1286 *
1287 * sRGB provides a peg for the PNG standard by defining a viewing environment.
1288 * sRGB itself, and earlier TV standards, actually use a more complex transform
1289 * (a linear portion then a gamma 2.4 power law) than PNG can express. (PNG is
1290 * limited to simple power laws.) By saying that an image for direct display on
1291 * an sRGB conformant system should be stored with a gAMA chunk value of 45455
1292 * (11.3.3.2 and 11.3.3.5 of the ISO PNG specification) the PNG specification
1293 * makes it possible to derive values for other display systems and
1294 * environments.
1295 *
1296 * The Mac value is deduced from the sRGB based on an assumption that the actual
1297 * extra viewing correction used in early Mac display systems was implemented as
1298 * a power 1.45 lookup table.
1299 *
1300 * Any system where a programmable lookup table is used or where the behavior of
1301 * the final display device characteristics can be changed requires system
1302 * specific code to obtain the current characteristic. However this can be
1303 * difficult and most PNG gamma correction only requires an approximate value.
1304 *
1305 * By default, if png_set_alpha_mode() is not called, libpng assumes that all
1306 * values are unencoded, linear, values and that the output device also has a
1307 * linear characteristic. This is only very rarely correct - it is invariably
1308 * better to call png_set_alpha_mode() with PNG_DEFAULT_sRGB than rely on the
1309 * default if you don't know what the right answer is!
1310 *
John Bowlerf70c7d02011-05-10 22:54:37 -05001311 * The special value PNG_GAMMA_MAC_18 indicates an older Mac system (pre Mac OS
1312 * 10.6) which used a correction table to implement a somewhat lower gamma on an
1313 * otherwise sRGB system.
1314 *
1315 * Both these values are reserved (not simple gamma values) in order to allow
1316 * more precise correction internally in the future.
1317 *
John Bowlerd273ad22011-05-07 21:00:28 -05001318 * NOTE: the following values can be passed to either the fixed or floating
1319 * point APIs, but the floating point API will also accept floating point
1320 * values.
1321 */
John Bowlerf70c7d02011-05-10 22:54:37 -05001322#define PNG_DEFAULT_sRGB -1 /* sRGB gamma and color space */
1323#define PNG_GAMMA_MAC_18 -2 /* Old Mac '1.8' gamma and color space */
Glenn Randers-Pehrsonc7822512011-05-07 21:23:43 -05001324#define PNG_GAMMA_sRGB 220000 /* Television standards--matches sRGB gamma */
John Bowlerd273ad22011-05-07 21:00:28 -05001325#define PNG_GAMMA_LINEAR PNG_FP_1 /* Linear */
John Bowlerf70c7d02011-05-10 22:54:37 -05001326#endif
John Bowlerd273ad22011-05-07 21:00:28 -05001327
1328/* The following are examples of calls to png_set_alpha_mode to achieve the
1329 * required overall gamma correction and, where necessary, alpha
1330 * premultiplication.
1331 *
1332 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1333 * This is the default libpng handling of the alpha channel - it is not
1334 * pre-multiplied into the color components. In addition the call states
1335 * that the output is for a sRGB system and causes all PNG files without gAMA
1336 * chunks to be assumed to be encoded using sRGB.
1337 *
1338 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1339 * In this case the output is assumed to be something like an sRGB conformant
1340 * display preceeded by a power-law lookup table of power 1.45. This is how
1341 * early Mac systems behaved.
1342 *
Glenn Randers-Pehrsonc7822512011-05-07 21:23:43 -05001343 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);
John Bowlerd273ad22011-05-07 21:00:28 -05001344 * This is the classic Jim Blinn approach and will work in academic
1345 * environments where everything is done by the book. It has the shortcoming
1346 * of assuming that input PNG data with no gamma information is linear - this
1347 * is unlikely to be correct unless the PNG files where generated locally.
1348 * Most of the time the output precision will be so low as to show
1349 * significant banding in dark areas of the image.
1350 *
1351 * png_set_expand_16(pp);
1352 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB);
1353 * This is a somewhat more realistic Jim Blinn inspired approach. PNG files
1354 * are assumed to have the sRGB encoding if not marked with a gamma value and
1355 * the output is always 16 bits per component. This permits accurate scaling
1356 * and processing of the data. If you know that your input PNG files were
1357 * generated locally you might need to replace PNG_DEFAULT_sRGB with the
1358 * correct value for your system.
1359 *
1360 * png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB);
1361 * If you just need to composite the PNG image onto an existing background
1362 * and if you control the code that does this you can use the optimization
1363 * setting. In this case you just copy completely opaque pixels to the
1364 * output. For pixels that are not completely transparent (you just skip
1365 * those) you do the composition math using png_composite or png_composite_16
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001366 * below then encode the resultant 8-bit or 16-bit values to match the output
John Bowlerd273ad22011-05-07 21:00:28 -05001367 * encoding.
1368 *
1369 * Other cases
1370 * If neither the PNG nor the standard linear encoding work for you because
1371 * of the software or hardware you use then you have a big problem. The PNG
1372 * case will probably result in halos around the image. The linear encoding
1373 * will probably result in a washed out, too bright, image (it's actually too
1374 * contrasty.) Try the ALPHA_OPTIMIZED mode above - this will probably
1375 * substantially reduce the halos. Alternatively try:
1376 *
1377 * png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB);
1378 * This option will also reduce the halos, but there will be slight dark
1379 * halos round the opaque parts of the image where the background is light.
1380 * In the OPTIMIZED mode the halos will be light halos where the background
1381 * is dark. Take your pick - the halos are unavoidable unless you can get
1382 * your hardware/software fixed! (The OPTIMIZED approach is slightly
1383 * faster.)
1384 *
1385 * When the default gamma of PNG files doesn't match the output gamma.
1386 * If you have PNG files with no gamma information png_set_alpha_mode allows
1387 * you to provide a default gamma, but it also sets the ouput gamma to the
1388 * matching value. If you know your PNG files have a gamma that doesn't
1389 * match the output you can take advantage of the fact that
1390 * png_set_alpha_mode always sets the output gamma but only sets the PNG
1391 * default if it is not already set:
1392 *
1393 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1394 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1395 * The first call sets both the default and the output gamma values, the
1396 * second call overrides the output gamma without changing the default. This
1397 * is easier than achieving the same effect with png_set_gamma. You must use
1398 * PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will
1399 * fire if more than one call to png_set_alpha_mode and png_set_background is
1400 * made in the same read operation, however multiple calls with PNG_ALPHA_PNG
1401 * are ignored.
1402 */
John Bowlerd273ad22011-05-07 21:00:28 -05001403
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001404#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06001405PNG_EXPORT(36, void, png_set_strip_alpha, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001406#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001407
1408#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
1409 defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
John Bowler5d567862011-12-24 09:12:00 -06001410PNG_EXPORT(37, void, png_set_swap_alpha, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001411#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001412
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -06001413#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
1414 defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
John Bowler5d567862011-12-24 09:12:00 -06001415PNG_EXPORT(38, void, png_set_invert_alpha, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001416#endif
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -06001417
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001418#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -05001419/* Add a filler byte to 8-bit Gray or 24-bit RGB images. */
John Bowler5d567862011-12-24 09:12:00 -06001420PNG_EXPORT(39, void, png_set_filler, (png_structrp png_ptr, png_uint_32 filler,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001421 int flags));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001422/* The values of the PNG_FILLER_ defines should NOT be changed */
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06001423# define PNG_FILLER_BEFORE 0
1424# define PNG_FILLER_AFTER 1
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -05001425/* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */
John Bowler5d567862011-12-24 09:12:00 -06001426PNG_EXPORT(40, void, png_set_add_alpha, (png_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001427 png_uint_32 filler, int flags));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001428#endif /* PNG_READ_FILLER_SUPPORTED || PNG_WRITE_FILLER_SUPPORTED */
Guy Schalnat0d580581995-07-20 02:43:20 -05001429
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001430#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001431/* Swap bytes in 16-bit depth files. */
John Bowler5d567862011-12-24 09:12:00 -06001432PNG_EXPORT(41, void, png_set_swap, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001433#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001434
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001435#if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED)
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001436/* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */
John Bowler5d567862011-12-24 09:12:00 -06001437PNG_EXPORT(42, void, png_set_packing, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001438#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001439
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06001440#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
1441 defined(PNG_WRITE_PACKSWAP_SUPPORTED)
Andreas Dilger47a0c421997-05-16 02:46:07 -05001442/* Swap packing order of pixels in bytes. */
John Bowler5d567862011-12-24 09:12:00 -06001443PNG_EXPORT(43, void, png_set_packswap, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001444#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001445
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001446#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
Guy Schalnat0d580581995-07-20 02:43:20 -05001447/* Converts files to legal bit depths. */
John Bowler5d567862011-12-24 09:12:00 -06001448PNG_EXPORT(44, void, png_set_shift, (png_structrp png_ptr, png_const_color_8p
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001449 true_bits));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001450#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001451
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001452#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
1453 defined(PNG_WRITE_INTERLACING_SUPPORTED)
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001454/* Have the code handle the interlacing. Returns the number of passes.
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001455 * MUST be called before png_read_update_info or png_start_read_image,
1456 * otherwise it will not have the desired effect. Note that it is still
1457 * necessary to call png_read_row or png_read_rows png_get_image_height
1458 * times for each pass.
1459*/
John Bowler5d567862011-12-24 09:12:00 -06001460PNG_EXPORT(45, int, png_set_interlace_handling, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001461#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001462
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001463#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -05001464/* Invert monochrome files */
John Bowler5d567862011-12-24 09:12:00 -06001465PNG_EXPORT(46, void, png_set_invert_mono, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001466#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001467
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001468#ifdef PNG_READ_BACKGROUND_SUPPORTED
John Bowlercb0b2962011-05-12 21:48:29 -05001469/* Handle alpha and tRNS by replacing with a background color. Prior to
Glenn Randers-Pehrsonef217b72011-06-15 12:58:27 -05001470 * libpng-1.5.4 this API must not be called before the PNG file header has been
John Bowlercb0b2962011-05-12 21:48:29 -05001471 * read. Doing so will result in unexpected behavior and possible warnings or
Glenn Randers-Pehrson1591a4c2011-05-16 09:07:26 -05001472 * errors if the PNG file contains a bKGD chunk.
John Bowlercb0b2962011-05-12 21:48:29 -05001473 */
John Bowler5d567862011-12-24 09:12:00 -06001474PNG_FP_EXPORT(47, void, png_set_background, (png_structrp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001475 png_const_color_16p background_color, int background_gamma_code,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001476 int need_expand, double background_gamma))
John Bowler5d567862011-12-24 09:12:00 -06001477PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structrp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001478 png_const_color_16p background_color, int background_gamma_code,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001479 int need_expand, png_fixed_point background_gamma))
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001480#endif
1481#ifdef PNG_READ_BACKGROUND_SUPPORTED
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06001482# define PNG_BACKGROUND_GAMMA_UNKNOWN 0
1483# define PNG_BACKGROUND_GAMMA_SCREEN 1
1484# define PNG_BACKGROUND_GAMMA_FILE 2
1485# define PNG_BACKGROUND_GAMMA_UNIQUE 3
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001486#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001487
John Bowler8d261262011-06-18 13:37:11 -05001488#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
Glenn Randers-Pehrson413138a2011-06-13 22:07:37 -05001489/* Scale a 16-bit depth file down to 8-bit, accurately. */
John Bowler5d567862011-12-24 09:12:00 -06001490PNG_EXPORT(229, void, png_set_scale_16, (png_structrp png_ptr));
John Bowler8d261262011-06-18 13:37:11 -05001491#endif
Glenn Randers-Pehrsonab63dd02011-06-17 20:04:17 -05001492
John Bowler8d261262011-06-18 13:37:11 -05001493#ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED
1494#define PNG_READ_16_TO_8 SUPPORTED /* Name prior to 1.5.4 */
Glenn Randers-Pehrson413138a2011-06-13 22:07:37 -05001495/* Strip the second byte of information from a 16-bit depth file. */
John Bowler5d567862011-12-24 09:12:00 -06001496PNG_EXPORT(48, void, png_set_strip_16, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001497#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001498
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -05001499#ifdef PNG_READ_QUANTIZE_SUPPORTED
1500/* Turn on quantizing, and reduce the palette to the number of colors
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06001501 * available.
1502 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001503PNG_EXPORT(49, void, png_set_quantize, (png_structrp png_ptr,
1504 png_colorp palette, int num_palette, int maximum_colors,
1505 png_const_uint_16p histogram, int full_quantize));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001506#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001507
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001508#ifdef PNG_READ_GAMMA_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001509/* The threshold on gamma processing is configurable but hard-wired into the
1510 * library. The following is the floating point variant.
1511 */
1512#define PNG_GAMMA_THRESHOLD (PNG_GAMMA_THRESHOLD_FIXED*.00001)
1513
John Bowlerd273ad22011-05-07 21:00:28 -05001514/* Handle gamma correction. Screen_gamma=(display_exponent).
Glenn Randers-Pehrsonc7822512011-05-07 21:23:43 -05001515 * NOTE: this API simply sets the screen and file gamma values. It will
John Bowlerd273ad22011-05-07 21:00:28 -05001516 * therefore override the value for gamma in a PNG file if it is called after
John Bowlerf70c7d02011-05-10 22:54:37 -05001517 * the file header has been read - use with care - call before reading the PNG
1518 * file for best results!
1519 *
1520 * These routines accept the same gamma values as png_set_alpha_mode (described
1521 * above). The PNG_GAMMA_ defines and PNG_DEFAULT_sRGB can be passed to either
1522 * API (floating point or fixed.) Notice, however, that the 'file_gamma' value
1523 * is the inverse of a 'screen gamma' value.
John Bowlerd273ad22011-05-07 21:00:28 -05001524 */
John Bowler5d567862011-12-24 09:12:00 -06001525PNG_FP_EXPORT(50, void, png_set_gamma, (png_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001526 double screen_gamma, double override_file_gamma))
John Bowler5d567862011-12-24 09:12:00 -06001527PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001528 png_fixed_point screen_gamma, png_fixed_point override_file_gamma))
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001529#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001530
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001531#ifdef PNG_WRITE_FLUSH_SUPPORTED
Guy Schalnat0f716451995-11-28 11:22:13 -06001532/* Set how many lines between output flushes - 0 for no flushing */
John Bowler5d567862011-12-24 09:12:00 -06001533PNG_EXPORT(51, void, png_set_flush, (png_structrp png_ptr, int nrows));
Guy Schalnat0f716451995-11-28 11:22:13 -06001534/* Flush the current PNG output buffer */
John Bowler5d567862011-12-24 09:12:00 -06001535PNG_EXPORT(52, void, png_write_flush, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001536#endif
Guy Schalnat0f716451995-11-28 11:22:13 -06001537
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001538/* Optional update palette with requested transformations */
John Bowler5d567862011-12-24 09:12:00 -06001539PNG_EXPORT(53, void, png_start_read_image, (png_structrp png_ptr));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001540
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001541/* Optional call to update the users info structure */
John Bowler5d567862011-12-24 09:12:00 -06001542PNG_EXPORT(54, void, png_read_update_info, (png_structrp png_ptr,
1543 png_inforp info_ptr));
Guy Schalnat0d580581995-07-20 02:43:20 -05001544
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001545#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001546/* Read one or more rows of image data. */
John Bowler5d567862011-12-24 09:12:00 -06001547PNG_EXPORT(55, void, png_read_rows, (png_structrp png_ptr, png_bytepp row,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001548 png_bytepp display_row, png_uint_32 num_rows));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001549#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001550
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001551#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001552/* Read a row of data. */
John Bowler5d567862011-12-24 09:12:00 -06001553PNG_EXPORT(56, void, png_read_row, (png_structrp png_ptr, png_bytep row,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001554 png_bytep display_row));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001555#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001556
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001557#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001558/* Read the whole image into memory at once. */
John Bowler5d567862011-12-24 09:12:00 -06001559PNG_EXPORT(57, void, png_read_image, (png_structrp png_ptr, png_bytepp image));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001560#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001561
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001562/* Write a row of image data */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001563PNG_EXPORT(58, void, png_write_row, (png_structrp png_ptr,
1564 png_const_bytep row));
Guy Schalnat0d580581995-07-20 02:43:20 -05001565
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001566/* Write a few rows of image data: (*row) is not written; however, the type
1567 * is declared as writeable to maintain compatibility with previous versions
1568 * of libpng and to allow the 'display_row' array from read_rows to be passed
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -05001569 * unchanged to write_rows.
1570 */
John Bowler5d567862011-12-24 09:12:00 -06001571PNG_EXPORT(59, void, png_write_rows, (png_structrp png_ptr, png_bytepp row,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001572 png_uint_32 num_rows));
Guy Schalnat0d580581995-07-20 02:43:20 -05001573
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001574/* Write the image data */
John Bowler5d567862011-12-24 09:12:00 -06001575PNG_EXPORT(60, void, png_write_image, (png_structrp png_ptr, png_bytepp image));
Guy Schalnat0d580581995-07-20 02:43:20 -05001576
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001577/* Write the end of the PNG file. */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001578PNG_EXPORT(61, void, png_write_end, (png_structrp png_ptr,
1579 png_inforp info_ptr));
Guy Schalnat0d580581995-07-20 02:43:20 -05001580
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001581#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001582/* Read the end of the PNG file. */
John Bowler5d567862011-12-24 09:12:00 -06001583PNG_EXPORT(62, void, png_read_end, (png_structrp png_ptr, png_inforp info_ptr));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001584#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001585
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001586/* Free any memory associated with the png_info_struct */
John Bowler5d567862011-12-24 09:12:00 -06001587PNG_EXPORT(63, void, png_destroy_info_struct, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001588 png_infopp info_ptr_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001589
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001590/* Free any memory associated with the png_struct and the png_info_structs */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001591PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001592 png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001593
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001594/* Free any memory associated with the png_struct and the png_info_structs */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001595PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001596 png_infopp info_ptr_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001597
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001598/* Set the libpng method of handling chunk CRC errors */
John Bowler5d567862011-12-24 09:12:00 -06001599PNG_EXPORT(66, void, png_set_crc_action, (png_structrp png_ptr, int crit_action,
John Bowler40b26032011-12-22 08:09:15 -06001600 int ancil_action));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001601
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001602/* Values for png_set_crc_action() say how to handle CRC errors in
Andreas Dilger47a0c421997-05-16 02:46:07 -05001603 * ancillary and critical chunks, and whether to use the data contained
1604 * therein. Note that it is impossible to "discard" data in a critical
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001605 * chunk. For versions prior to 0.90, the action was always error/quit,
Andreas Dilger47a0c421997-05-16 02:46:07 -05001606 * whereas in version 0.90 and later, the action for CRC errors in ancillary
1607 * chunks is warn/discard. These values should NOT be changed.
1608 *
1609 * value action:critical action:ancillary
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001610 */
1611#define PNG_CRC_DEFAULT 0 /* error/quit warn/discard data */
1612#define PNG_CRC_ERROR_QUIT 1 /* error/quit error/quit */
1613#define PNG_CRC_WARN_DISCARD 2 /* (INVALID) warn/discard data */
1614#define PNG_CRC_WARN_USE 3 /* warn/use data warn/use data */
1615#define PNG_CRC_QUIET_USE 4 /* quiet/use data quiet/use data */
1616#define PNG_CRC_NO_CHANGE 5 /* use current value use current value */
1617
Andreas Dilger47a0c421997-05-16 02:46:07 -05001618/* These functions give the user control over the scan-line filtering in
1619 * libpng and the compression methods used by zlib. These functions are
1620 * mainly useful for testing, as the defaults should work with most users.
1621 * Those users who are tight on memory or want faster performance at the
1622 * expense of compression can modify them. See the compression library
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001623 * header file (zlib.h) for an explination of the compression functions.
1624 */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001625
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001626/* Set the filtering method(s) used by libpng. Currently, the only valid
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001627 * value for "method" is 0.
1628 */
John Bowler5d567862011-12-24 09:12:00 -06001629PNG_EXPORT(67, void, png_set_filter, (png_structrp png_ptr, int method,
John Bowler40b26032011-12-22 08:09:15 -06001630 int filters));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001631
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001632/* Flags for png_set_filter() to say which filters to use. The flags
Andreas Dilger47a0c421997-05-16 02:46:07 -05001633 * are chosen so that they don't conflict with real filter types
1634 * below, in case they are supplied instead of the #defined constants.
1635 * These values should NOT be changed.
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001636 */
1637#define PNG_NO_FILTERS 0x00
1638#define PNG_FILTER_NONE 0x08
1639#define PNG_FILTER_SUB 0x10
1640#define PNG_FILTER_UP 0x20
1641#define PNG_FILTER_AVG 0x40
1642#define PNG_FILTER_PAETH 0x80
1643#define PNG_ALL_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP | \
1644 PNG_FILTER_AVG | PNG_FILTER_PAETH)
1645
Andreas Dilger47a0c421997-05-16 02:46:07 -05001646/* Filter values (not flags) - used in pngwrite.c, pngwutil.c for now.
1647 * These defines should NOT be changed.
1648 */
1649#define PNG_FILTER_VALUE_NONE 0
1650#define PNG_FILTER_VALUE_SUB 1
1651#define PNG_FILTER_VALUE_UP 2
1652#define PNG_FILTER_VALUE_AVG 3
1653#define PNG_FILTER_VALUE_PAETH 4
1654#define PNG_FILTER_VALUE_LAST 5
1655
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001656#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */
Andreas Dilger47a0c421997-05-16 02:46:07 -05001657/* The "heuristic_method" is given by one of the PNG_FILTER_HEURISTIC_
1658 * defines, either the default (minimum-sum-of-absolute-differences), or
1659 * the experimental method (weighted-minimum-sum-of-absolute-differences).
1660 *
1661 * Weights are factors >= 1.0, indicating how important it is to keep the
1662 * filter type consistent between rows. Larger numbers mean the current
1663 * filter is that many times as likely to be the same as the "num_weights"
1664 * previous filters. This is cumulative for each previous row with a weight.
1665 * There needs to be "num_weights" values in "filter_weights", or it can be
1666 * NULL if the weights aren't being specified. Weights have no influence on
1667 * the selection of the first row filter. Well chosen weights can (in theory)
1668 * improve the compression for a given image.
1669 *
1670 * Costs are factors >= 1.0 indicating the relative decoding costs of a
1671 * filter type. Higher costs indicate more decoding expense, and are
1672 * therefore less likely to be selected over a filter with lower computational
1673 * costs. There needs to be a value in "filter_costs" for each valid filter
1674 * type (given by PNG_FILTER_VALUE_LAST), or it can be NULL if you aren't
1675 * setting the costs. Costs try to improve the speed of decompression without
1676 * unduly increasing the compressed image size.
1677 *
1678 * A negative weight or cost indicates the default value is to be used, and
1679 * values in the range [0.0, 1.0) indicate the value is to remain unchanged.
1680 * The default values for both weights and costs are currently 1.0, but may
1681 * change if good general weighting/cost heuristics can be found. If both
1682 * the weights and costs are set to 1.0, this degenerates the WEIGHTED method
1683 * to the UNWEIGHTED method, but with added encoding time/computation.
1684 */
John Bowler5d567862011-12-24 09:12:00 -06001685PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structrp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001686 int heuristic_method, int num_weights, png_const_doublep filter_weights,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001687 png_const_doublep filter_costs))
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001688PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed,
John Bowler5d567862011-12-24 09:12:00 -06001689 (png_structrp png_ptr, int heuristic_method, int num_weights,
John Bowler40b26032011-12-22 08:09:15 -06001690 png_const_fixed_point_p filter_weights,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001691 png_const_fixed_point_p filter_costs))
Andreas Dilger47a0c421997-05-16 02:46:07 -05001692#endif /* PNG_WRITE_WEIGHTED_FILTER_SUPPORTED */
1693
1694/* Heuristic used for row filter selection. These defines should NOT be
1695 * changed.
1696 */
1697#define PNG_FILTER_HEURISTIC_DEFAULT 0 /* Currently "UNWEIGHTED" */
1698#define PNG_FILTER_HEURISTIC_UNWEIGHTED 1 /* Used by libpng < 0.95 */
1699#define PNG_FILTER_HEURISTIC_WEIGHTED 2 /* Experimental feature */
1700#define PNG_FILTER_HEURISTIC_LAST 3 /* Not a valid value */
1701
John Bowlerc5bef942011-05-05 17:35:39 -05001702#ifdef PNG_WRITE_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001703/* Set the library compression level. Currently, valid values range from
1704 * 0 - 9, corresponding directly to the zlib compression levels 0 - 9
1705 * (0 - no compression, 9 - "maximal" compression). Note that tests have
1706 * shown that zlib compression levels 3-6 usually perform as well as level 9
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001707 * for PNG images, and do considerably fewer caclulations. In the future,
Andreas Dilger47a0c421997-05-16 02:46:07 -05001708 * these values may not correspond directly to the zlib compression levels.
1709 */
John Bowler5d567862011-12-24 09:12:00 -06001710PNG_EXPORT(69, void, png_set_compression_level, (png_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001711 int level));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001712
John Bowler5d567862011-12-24 09:12:00 -06001713PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001714 int mem_level));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001715
John Bowler5d567862011-12-24 09:12:00 -06001716PNG_EXPORT(71, void, png_set_compression_strategy, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001717 int strategy));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001718
Glenn Randers-Pehrsonaf855e42011-05-07 10:52:49 -05001719/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1720 * smaller value of window_bits if it can do so safely.
1721 */
John Bowler5d567862011-12-24 09:12:00 -06001722PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001723 int window_bits));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001724
John Bowler5d567862011-12-24 09:12:00 -06001725PNG_EXPORT(73, void, png_set_compression_method, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001726 int method));
John Bowlerc5bef942011-05-05 17:35:39 -05001727#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001728
John Bowlerb2bee332011-06-10 23:24:58 -05001729#ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001730/* Also set zlib parameters for compressing non-IDAT chunks */
John Bowler5d567862011-12-24 09:12:00 -06001731PNG_EXPORT(222, void, png_set_text_compression_level, (png_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001732 int level));
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001733
John Bowler5d567862011-12-24 09:12:00 -06001734PNG_EXPORT(223, void, png_set_text_compression_mem_level, (png_structrp png_ptr,
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001735 int mem_level));
1736
John Bowler5d567862011-12-24 09:12:00 -06001737PNG_EXPORT(224, void, png_set_text_compression_strategy, (png_structrp png_ptr,
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001738 int strategy));
1739
Glenn Randers-Pehrsonaf855e42011-05-07 10:52:49 -05001740/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1741 * smaller value of window_bits if it can do so safely.
1742 */
John Bowler40b26032011-12-22 08:09:15 -06001743PNG_EXPORT(225, void, png_set_text_compression_window_bits,
John Bowler5d567862011-12-24 09:12:00 -06001744 (png_structrp png_ptr, int window_bits));
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001745
John Bowler5d567862011-12-24 09:12:00 -06001746PNG_EXPORT(226, void, png_set_text_compression_method, (png_structrp png_ptr,
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001747 int method));
John Bowlerb2bee332011-06-10 23:24:58 -05001748#endif /* PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED */
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001749
Guy Schalnate5a37791996-06-05 15:50:50 -05001750/* These next functions are called for input/output, memory, and error
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001751 * handling. They are in the file pngrio.c, pngwio.c, and pngerror.c,
Andreas Dilger47a0c421997-05-16 02:46:07 -05001752 * and call standard C I/O routines such as fread(), fwrite(), and
1753 * fprintf(). These functions can be made to use other I/O routines
1754 * at run time for those applications that need to handle I/O in a
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -05001755 * different manner by calling png_set_???_fn(). See libpng-manual.txt for
Andreas Dilger47a0c421997-05-16 02:46:07 -05001756 * more information.
1757 */
Guy Schalnat0d580581995-07-20 02:43:20 -05001758
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001759#ifdef PNG_STDIO_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001760/* Initialize the input/output for the PNG file to the default functions. */
John Bowler5d567862011-12-24 09:12:00 -06001761PNG_EXPORT(74, void, png_init_io, (png_structrp png_ptr, png_FILE_p fp));
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001762#endif
Guy Schalnat6d764711995-12-19 03:22:19 -06001763
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001764/* Replace the (error and abort), and warning functions with user
Andreas Dilger47a0c421997-05-16 02:46:07 -05001765 * supplied functions. If no messages are to be printed you must still
1766 * write and use replacement functions. The replacement error_fn should
1767 * still do a longjmp to the last setjmp location if you are using this
1768 * method of error handling. If error_fn or warning_fn is NULL, the
1769 * default function will be used.
1770 */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001771
John Bowler5d567862011-12-24 09:12:00 -06001772PNG_EXPORT(75, void, png_set_error_fn, (png_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001773 png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warning_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001774
Guy Schalnate5a37791996-06-05 15:50:50 -05001775/* Return the user pointer associated with the error functions */
John Bowler5d567862011-12-24 09:12:00 -06001776PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structrp png_ptr));
Guy Schalnat6d764711995-12-19 03:22:19 -06001777
1778/* Replace the default data output functions with a user supplied one(s).
Andreas Dilger47a0c421997-05-16 02:46:07 -05001779 * If buffered output is not used, then output_flush_fn can be set to NULL.
1780 * If PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile time
1781 * output_flush_fn will be ignored (and thus can be NULL).
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -05001782 * It is probably a mistake to use NULL for output_flush_fn if
1783 * write_data_fn is not also NULL unless you have built libpng with
1784 * PNG_WRITE_FLUSH_SUPPORTED undefined, because in this case libpng's
1785 * default flush function, which uses the standard *FILE structure, will
1786 * be used.
Andreas Dilger47a0c421997-05-16 02:46:07 -05001787 */
John Bowler5d567862011-12-24 09:12:00 -06001788PNG_EXPORT(77, void, png_set_write_fn, (png_structrp png_ptr, png_voidp io_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001789 png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001790
1791/* Replace the default data input function with a user supplied one. */
John Bowler5d567862011-12-24 09:12:00 -06001792PNG_EXPORT(78, void, png_set_read_fn, (png_structrp png_ptr, png_voidp io_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001793 png_rw_ptr read_data_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001794
1795/* Return the user pointer associated with the I/O functions */
John Bowler5d567862011-12-24 09:12:00 -06001796PNG_EXPORT(79, png_voidp, png_get_io_ptr, (png_const_structrp png_ptr));
Guy Schalnat6d764711995-12-19 03:22:19 -06001797
John Bowler5d567862011-12-24 09:12:00 -06001798PNG_EXPORT(80, void, png_set_read_status_fn, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001799 png_read_status_ptr read_row_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001800
John Bowler5d567862011-12-24 09:12:00 -06001801PNG_EXPORT(81, void, png_set_write_status_fn, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001802 png_write_status_ptr write_row_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001803
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001804#ifdef PNG_USER_MEM_SUPPORTED
1805/* Replace the default memory allocation functions with user supplied one(s). */
John Bowler5d567862011-12-24 09:12:00 -06001806PNG_EXPORT(82, void, png_set_mem_fn, (png_structrp png_ptr, png_voidp mem_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001807 png_malloc_ptr malloc_fn, png_free_ptr free_fn));
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001808/* Return the user pointer associated with the memory functions */
John Bowler5d567862011-12-24 09:12:00 -06001809PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001810#endif
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001811
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -05001812#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06001813PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001814 png_user_transform_ptr read_user_transform_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001815#endif
1816
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -05001817#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06001818PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001819 png_user_transform_ptr write_user_transform_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001820#endif
1821
John Bowler0a5c9c02011-01-22 17:36:34 -06001822#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06001823PNG_EXPORT(86, void, png_set_user_transform_info, (png_structrp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001824 png_voidp user_transform_ptr, int user_transform_depth,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001825 int user_transform_channels));
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001826/* Return the user pointer associated with the user transform functions */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001827PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr,
John Bowler5d567862011-12-24 09:12:00 -06001828 (png_const_structrp png_ptr));
John Bowler0a5c9c02011-01-22 17:36:34 -06001829#endif
1830
1831#ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED
1832/* Return information about the row currently being processed. Note that these
1833 * APIs do not fail but will return unexpected results if called outside a user
1834 * transform callback. Also note that when transforming an interlaced image the
John Bowler9616ad92011-02-16 06:13:46 -06001835 * row number is the row number within the sub-image of the interlace pass, so
1836 * the value will increase to the height of the sub-image (not the full image)
1837 * then reset to 0 for the next pass.
John Bowler5432c012011-02-12 08:59:17 -06001838 *
John Bowler9616ad92011-02-16 06:13:46 -06001839 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
1840 * find the output pixel (x,y) given an interlaced sub-image pixel
1841 * (row,col,pass). (See below for these macros.)
John Bowler0a5c9c02011-01-22 17:36:34 -06001842 */
John Bowler5d567862011-12-24 09:12:00 -06001843PNG_EXPORT(217, png_uint_32, png_get_current_row_number, (png_const_structrp));
1844PNG_EXPORT(218, png_byte, png_get_current_pass_number, (png_const_structrp));
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001845#endif
1846
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001847#ifdef PNG_READ_USER_CHUNKS_SUPPORTED
John Bowlere15b5372013-03-02 17:59:43 -06001848/* This callback is called only for *unknown* chunks. If
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001849 * PNG_HANDLE_AS_UNKNOWN_SUPPORTED is set then it is possible to set known
1850 * chunks to be treated as unknown, however in this case the callback must do
1851 * any processing required by the chunk (e.g. by calling the appropriate
1852 * png_set_ APIs.)
1853 *
1854 * There is no write support - on write, by default, all the chunks in the
1855 * 'unknown' list are written in the specified position.
1856 *
1857 * The integer return from the callback function is interpreted thus:
1858 *
1859 * negative: An error occured, png_chunk_error will be called.
John Bowlere15b5372013-03-02 17:59:43 -06001860 * zero: The chunk was not handled, the chunk will be saved. A critical
1861 * chunk will cause an error at this point unless it is to be saved.
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001862 * positive: The chunk was handled, libpng will ignore/discard it.
John Bowlere15b5372013-03-02 17:59:43 -06001863 *
1864 * See "INTERACTION WTIH USER CHUNK CALLBACKS" below for important notes about
1865 * how this behavior will change in libpng 1.7
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001866 */
John Bowler5d567862011-12-24 09:12:00 -06001867PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001868 png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn));
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001869#endif
1870
1871#ifdef PNG_USER_CHUNKS_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06001872PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structrp png_ptr));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001873#endif
1874
Guy Schalnat4ee97b01996-01-16 01:51:56 -06001875#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001876/* Sets the function callbacks for the push reader, and a pointer to a
1877 * user-defined structure available to the callback functions.
1878 */
John Bowler5d567862011-12-24 09:12:00 -06001879PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structrp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001880 png_voidp progressive_ptr, png_progressive_info_ptr info_fn,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001881 png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001882
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001883/* Returns the user pointer associated with the push read functions */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001884PNG_EXPORT(91, png_voidp, png_get_progressive_ptr,
1885 (png_const_structrp png_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001886
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001887/* Function to be called when data becomes available */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001888PNG_EXPORT(92, void, png_process_data, (png_structrp png_ptr,
1889 png_inforp info_ptr, png_bytep buffer, png_size_t buffer_size));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001890
John Bowler0a5c9c02011-01-22 17:36:34 -06001891/* A function which may be called *only* within png_process_data to stop the
1892 * processing of any more data. The function returns the number of bytes
1893 * remaining, excluding any that libpng has cached internally. A subsequent
1894 * call to png_process_data must supply these bytes again. If the argument
1895 * 'save' is set to true the routine will first save all the pending data and
1896 * will always return 0.
1897 */
John Bowler5d567862011-12-24 09:12:00 -06001898PNG_EXPORT(219, png_size_t, png_process_data_pause, (png_structrp, int save));
John Bowler0a5c9c02011-01-22 17:36:34 -06001899
1900/* A function which may be called *only* outside (after) a call to
1901 * png_process_data. It returns the number of bytes of data to skip in the
1902 * input. Normally it will return 0, but if it returns a non-zero value the
1903 * application must skip than number of bytes of input data and pass the
1904 * following data to the next call to png_process_data.
1905 */
John Bowler5d567862011-12-24 09:12:00 -06001906PNG_EXPORT(220, png_uint_32, png_process_data_skip, (png_structrp));
John Bowler0a5c9c02011-01-22 17:36:34 -06001907
Glenn Randers-Pehrson4daae302011-10-06 21:37:47 -05001908#ifdef PNG_READ_INTERLACING_SUPPORTED
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001909/* Function that combines rows. 'new_row' is a flag that should come from
1910 * the callback and be non-NULL if anything needs to be done; the library
1911 * stores its own version of the new data internally and ignores the passed
1912 * in value.
Andreas Dilger47a0c421997-05-16 02:46:07 -05001913 */
John Bowler5d567862011-12-24 09:12:00 -06001914PNG_EXPORT(93, void, png_progressive_combine_row, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001915 png_bytep old_row, png_const_bytep new_row));
Glenn Randers-Pehrson4daae302011-10-06 21:37:47 -05001916#endif /* PNG_READ_INTERLACING_SUPPORTED */
Guy Schalnat4ee97b01996-01-16 01:51:56 -06001917#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */
Guy Schalnat6d764711995-12-19 03:22:19 -06001918
John Bowler5d567862011-12-24 09:12:00 -06001919PNG_EXPORTA(94, png_voidp, png_malloc, (png_const_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001920 png_alloc_size_t size), PNG_ALLOCATED);
Glenn Randers-Pehrson0ffb71a2009-02-28 06:08:20 -06001921/* Added at libpng version 1.4.0 */
John Bowler5d567862011-12-24 09:12:00 -06001922PNG_EXPORTA(95, png_voidp, png_calloc, (png_const_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001923 png_alloc_size_t size), PNG_ALLOCATED);
Guy Schalnat0d580581995-07-20 02:43:20 -05001924
Glenn Randers-Pehrson07748d12002-05-25 11:12:10 -05001925/* Added at libpng version 1.2.4 */
John Bowler5d567862011-12-24 09:12:00 -06001926PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001927 png_alloc_size_t size), PNG_ALLOCATED);
Glenn Randers-Pehrson07748d12002-05-25 11:12:10 -05001928
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05001929/* Frees a pointer allocated by png_malloc() */
John Bowler5d567862011-12-24 09:12:00 -06001930PNG_EXPORT(97, void, png_free, (png_const_structrp png_ptr, png_voidp ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001931
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001932/* Free data that was allocated internally */
John Bowler5d567862011-12-24 09:12:00 -06001933PNG_EXPORT(98, void, png_free_data, (png_const_structrp png_ptr,
1934 png_inforp info_ptr, png_uint_32 free_me, int num));
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001935
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001936/* Reassign responsibility for freeing existing data, whether allocated
John Bowler40b26032011-12-22 08:09:15 -06001937 * by libpng or by the application; this works on the png_info structure passed
1938 * in, it does not change the state for other png_info structures.
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001939 *
1940 * It is unlikely that this function works correctly as of 1.6.0 and using it
1941 * may result either in memory leaks or double free of allocated data.
John Bowler40b26032011-12-22 08:09:15 -06001942 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001943PNG_EXPORTA(99, void, png_data_freer, (png_const_structrp png_ptr,
1944 png_inforp info_ptr, int freer, png_uint_32 mask), PNG_DEPRECATED);
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001945
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001946/* Assignments for png_data_freer */
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001947#define PNG_DESTROY_WILL_FREE_DATA 1
1948#define PNG_SET_WILL_FREE_DATA 1
1949#define PNG_USER_WILL_FREE_DATA 2
1950/* Flags for png_ptr->free_me and info_ptr->free_me */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001951#define PNG_FREE_HIST 0x0008
1952#define PNG_FREE_ICCP 0x0010
1953#define PNG_FREE_SPLT 0x0020
1954#define PNG_FREE_ROWS 0x0040
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001955#define PNG_FREE_PCAL 0x0080
1956#define PNG_FREE_SCAL 0x0100
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001957#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED
1958# define PNG_FREE_UNKN 0x0200
1959#endif
1960/* PNG_FREE_LIST 0x0400 removed in 1.6.0 because it is ignored */
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -05001961#define PNG_FREE_PLTE 0x1000
1962#define PNG_FREE_TRNS 0x2000
1963#define PNG_FREE_TEXT 0x4000
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001964#define PNG_FREE_ALL 0x7fff
Glenn Randers-Pehrsonec61c232000-05-16 06:17:36 -05001965#define PNG_FREE_MUL 0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001966
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001967#ifdef PNG_USER_MEM_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06001968PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_const_structrp png_ptr,
John Bowlerd332c672011-12-21 17:36:12 -06001969 png_alloc_size_t size), PNG_ALLOCATED PNG_DEPRECATED);
John Bowler5d567862011-12-24 09:12:00 -06001970PNG_EXPORTA(101, void, png_free_default, (png_const_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001971 png_voidp ptr), PNG_DEPRECATED);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001972#endif
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001973
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001974#ifdef PNG_ERROR_TEXT_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001975/* Fatal error in PNG image of libpng - can't continue */
John Bowler5d567862011-12-24 09:12:00 -06001976PNG_EXPORTA(102, void, png_error, (png_const_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001977 png_const_charp error_message), PNG_NORETURN);
Guy Schalnat0d580581995-07-20 02:43:20 -05001978
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001979/* The same, but the chunk name is prepended to the error string. */
John Bowler5d567862011-12-24 09:12:00 -06001980PNG_EXPORTA(103, void, png_chunk_error, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001981 png_const_charp error_message), PNG_NORETURN);
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001982
Glenn Randers-Pehrsonfd107532009-11-10 05:59:22 -06001983#else
1984/* Fatal error in PNG image of libpng - can't continue */
John Bowler5d567862011-12-24 09:12:00 -06001985PNG_EXPORTA(104, void, png_err, (png_const_structrp png_ptr), PNG_NORETURN);
Glenn Randers-Pehrsonfd107532009-11-10 05:59:22 -06001986#endif
1987
John Bowler88b77cc2011-05-05 06:49:55 -05001988#ifdef PNG_WARNINGS_SUPPORTED
Guy Schalnat6d764711995-12-19 03:22:19 -06001989/* Non-fatal error in libpng. Can continue, but may have a problem. */
John Bowler5d567862011-12-24 09:12:00 -06001990PNG_EXPORT(105, void, png_warning, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001991 png_const_charp warning_message));
Guy Schalnat0d580581995-07-20 02:43:20 -05001992
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001993/* Non-fatal error in libpng, chunk name is prepended to message. */
John Bowler5d567862011-12-24 09:12:00 -06001994PNG_EXPORT(106, void, png_chunk_warning, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001995 png_const_charp warning_message));
John Bowler88b77cc2011-05-05 06:49:55 -05001996#endif
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001997
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001998#ifdef PNG_BENIGN_ERRORS_SUPPORTED
1999/* Benign error in libpng. Can continue, but may have a problem.
2000 * User can choose whether to handle as a fatal error or as a warning. */
John Bowler5d567862011-12-24 09:12:00 -06002001PNG_EXPORT(107, void, png_benign_error, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002002 png_const_charp warning_message));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002003
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002004#ifdef PNG_READ_SUPPORTED
2005/* Same, chunk name is prepended to message (only during read) */
John Bowler5d567862011-12-24 09:12:00 -06002006PNG_EXPORT(108, void, png_chunk_benign_error, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002007 png_const_charp warning_message));
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002008#endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002009
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002010PNG_EXPORT(109, void, png_set_benign_errors,
John Bowler5d567862011-12-24 09:12:00 -06002011 (png_structrp png_ptr, int allowed));
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05002012#else
2013# ifdef PNG_ALLOW_BENIGN_ERRORS
2014# define png_benign_error png_warning
2015# define png_chunk_benign_error png_chunk_warning
2016# else
2017# define png_benign_error png_error
2018# define png_chunk_benign_error png_chunk_error
2019# endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002020#endif
2021
Andreas Dilger47a0c421997-05-16 02:46:07 -05002022/* The png_set_<chunk> functions are for storing values in the png_info_struct.
2023 * Similarly, the png_get_<chunk> calls are used to read values from the
2024 * png_info_struct, either storing the parameters in the passed variables, or
2025 * setting pointers into the png_info_struct where the data is stored. The
2026 * png_get_<chunk> functions return a non-zero value if the data was available
2027 * in info_ptr, or return zero and do not change any of the parameters if the
2028 * data was not available.
2029 *
2030 * These functions should be used instead of directly accessing png_info
2031 * to avoid problems with future changes in the size and internal layout of
2032 * png_info_struct.
2033 */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002034/* Returns "flag" if chunk data is valid in info_ptr. */
John Bowler5d567862011-12-24 09:12:00 -06002035PNG_EXPORT(110, png_uint_32, png_get_valid, (png_const_structrp png_ptr,
2036 png_const_inforp info_ptr, png_uint_32 flag));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002037
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002038/* Returns number of bytes needed to hold a transformed row. */
John Bowler5d567862011-12-24 09:12:00 -06002039PNG_EXPORT(111, png_size_t, png_get_rowbytes, (png_const_structrp png_ptr,
2040 png_const_inforp info_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002041
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002042#ifdef PNG_INFO_IMAGE_SUPPORTED
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06002043/* Returns row_pointers, which is an array of pointers to scanlines that was
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002044 * returned from png_read_png().
2045 */
John Bowler5d567862011-12-24 09:12:00 -06002046PNG_EXPORT(112, png_bytepp, png_get_rows, (png_const_structrp png_ptr,
2047 png_const_inforp info_ptr));
John Bowler40b26032011-12-22 08:09:15 -06002048
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06002049/* Set row_pointers, which is an array of pointers to scanlines for use
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002050 * by png_write_png().
2051 */
John Bowler4f67e402011-12-28 08:43:37 -06002052PNG_EXPORT(113, void, png_set_rows, (png_const_structrp png_ptr,
2053 png_inforp info_ptr, png_bytepp row_pointers));
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06002054#endif
2055
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002056/* Returns number of color channels in image. */
John Bowler5d567862011-12-24 09:12:00 -06002057PNG_EXPORT(114, png_byte, png_get_channels, (png_const_structrp png_ptr,
2058 png_const_inforp info_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002059
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002060#ifdef PNG_EASY_ACCESS_SUPPORTED
2061/* Returns image width in pixels. */
John Bowler5d567862011-12-24 09:12:00 -06002062PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structrp png_ptr,
2063 png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002064
2065/* Returns image height in pixels. */
John Bowler5d567862011-12-24 09:12:00 -06002066PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structrp png_ptr,
2067 png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002068
2069/* Returns image bit_depth. */
John Bowler5d567862011-12-24 09:12:00 -06002070PNG_EXPORT(117, png_byte, png_get_bit_depth, (png_const_structrp png_ptr,
2071 png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002072
2073/* Returns image color_type. */
John Bowler5d567862011-12-24 09:12:00 -06002074PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structrp png_ptr,
2075 png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002076
2077/* Returns image filter_type. */
John Bowler5d567862011-12-24 09:12:00 -06002078PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structrp png_ptr,
2079 png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002080
2081/* Returns image interlace_type. */
John Bowler5d567862011-12-24 09:12:00 -06002082PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structrp png_ptr,
2083 png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002084
2085/* Returns image compression_type. */
John Bowler5d567862011-12-24 09:12:00 -06002086PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structrp png_ptr,
2087 png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002088
2089/* Returns image resolution in pixels per meter, from pHYs chunk data. */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002090PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter,
John Bowler5d567862011-12-24 09:12:00 -06002091 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002092PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter,
John Bowler5d567862011-12-24 09:12:00 -06002093 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002094PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter,
John Bowler5d567862011-12-24 09:12:00 -06002095 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002096
2097/* Returns pixel aspect ratio, computed from pHYs chunk data. */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002098PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002099 (png_const_structrp png_ptr, png_const_inforp info_ptr))
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002100PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002101 (png_const_structrp png_ptr, png_const_inforp info_ptr))
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002102
2103/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002104PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels,
2105 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2106PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels,
2107 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002108PNG_EXPORT(128, png_int_32, png_get_x_offset_microns,
John Bowler5d567862011-12-24 09:12:00 -06002109 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002110PNG_EXPORT(129, png_int_32, png_get_y_offset_microns,
John Bowler5d567862011-12-24 09:12:00 -06002111 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002112
2113#endif /* PNG_EASY_ACCESS_SUPPORTED */
2114
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002115#ifdef PNG_READ_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05002116/* Returns pointer to signature string read from PNG header */
John Bowler5d567862011-12-24 09:12:00 -06002117PNG_EXPORT(130, png_const_bytep, png_get_signature, (png_const_structrp png_ptr,
John Bowler4f67e402011-12-28 08:43:37 -06002118 png_const_inforp info_ptr));
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002119#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002120
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002121#ifdef PNG_bKGD_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002122PNG_EXPORT(131, png_uint_32, png_get_bKGD, (png_const_structrp png_ptr,
2123 png_inforp info_ptr, png_color_16p *background));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002124#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002125
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002126#ifdef PNG_bKGD_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002127PNG_EXPORT(132, void, png_set_bKGD, (png_const_structrp png_ptr,
2128 png_inforp info_ptr, png_const_color_16p background));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002129#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002130
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002131#ifdef PNG_cHRM_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002132PNG_FP_EXPORT(133, png_uint_32, png_get_cHRM, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002133 png_const_inforp info_ptr, double *white_x, double *white_y, double *red_x,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002134 double *red_y, double *green_x, double *green_y, double *blue_x,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002135 double *blue_y))
John Bowler5d567862011-12-24 09:12:00 -06002136PNG_FP_EXPORT(230, png_uint_32, png_get_cHRM_XYZ, (png_const_structrp png_ptr,
2137 png_const_inforp info_ptr, double *red_X, double *red_Y, double *red_Z,
John Bowler736f40f2011-08-25 16:19:44 -05002138 double *green_X, double *green_Y, double *green_Z, double *blue_X,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002139 double *blue_Y, double *blue_Z))
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002140PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed,
John Bowler5d567862011-12-24 09:12:00 -06002141 (png_const_structrp png_ptr, png_const_inforp info_ptr,
John Bowler40b26032011-12-22 08:09:15 -06002142 png_fixed_point *int_white_x, png_fixed_point *int_white_y,
2143 png_fixed_point *int_red_x, png_fixed_point *int_red_y,
2144 png_fixed_point *int_green_x, png_fixed_point *int_green_y,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002145 png_fixed_point *int_blue_x, png_fixed_point *int_blue_y))
John Bowler736f40f2011-08-25 16:19:44 -05002146PNG_FIXED_EXPORT(231, png_uint_32, png_get_cHRM_XYZ_fixed,
John Bowler5d567862011-12-24 09:12:00 -06002147 (png_const_structrp png_ptr, png_const_inforp info_ptr,
John Bowler736f40f2011-08-25 16:19:44 -05002148 png_fixed_point *int_red_X, png_fixed_point *int_red_Y,
2149 png_fixed_point *int_red_Z, png_fixed_point *int_green_X,
2150 png_fixed_point *int_green_Y, png_fixed_point *int_green_Z,
2151 png_fixed_point *int_blue_X, png_fixed_point *int_blue_Y,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002152 png_fixed_point *int_blue_Z))
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002153#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002154
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002155#ifdef PNG_cHRM_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002156PNG_FP_EXPORT(135, void, png_set_cHRM, (png_const_structrp png_ptr,
2157 png_inforp info_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002158 double white_x, double white_y, double red_x, double red_y, double green_x,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002159 double green_y, double blue_x, double blue_y))
John Bowler4f67e402011-12-28 08:43:37 -06002160PNG_FP_EXPORT(232, void, png_set_cHRM_XYZ, (png_const_structrp png_ptr,
John Bowler5d567862011-12-24 09:12:00 -06002161 png_inforp info_ptr, double red_X, double red_Y, double red_Z,
John Bowler736f40f2011-08-25 16:19:44 -05002162 double green_X, double green_Y, double green_Z, double blue_X,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002163 double blue_Y, double blue_Z))
John Bowler4f67e402011-12-28 08:43:37 -06002164PNG_FIXED_EXPORT(136, void, png_set_cHRM_fixed, (png_const_structrp png_ptr,
John Bowler5d567862011-12-24 09:12:00 -06002165 png_inforp info_ptr, png_fixed_point int_white_x,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002166 png_fixed_point int_white_y, png_fixed_point int_red_x,
2167 png_fixed_point int_red_y, png_fixed_point int_green_x,
2168 png_fixed_point int_green_y, png_fixed_point int_blue_x,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002169 png_fixed_point int_blue_y))
John Bowler4f67e402011-12-28 08:43:37 -06002170PNG_FIXED_EXPORT(233, void, png_set_cHRM_XYZ_fixed, (png_const_structrp png_ptr,
John Bowler5d567862011-12-24 09:12:00 -06002171 png_inforp info_ptr, png_fixed_point int_red_X, png_fixed_point int_red_Y,
John Bowler736f40f2011-08-25 16:19:44 -05002172 png_fixed_point int_red_Z, png_fixed_point int_green_X,
2173 png_fixed_point int_green_Y, png_fixed_point int_green_Z,
2174 png_fixed_point int_blue_X, png_fixed_point int_blue_Y,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002175 png_fixed_point int_blue_Z))
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002176#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002177
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002178#ifdef PNG_gAMA_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002179PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002180 png_const_inforp info_ptr, double *file_gamma))
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002181PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed,
John Bowler5d567862011-12-24 09:12:00 -06002182 (png_const_structrp png_ptr, png_const_inforp info_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002183 png_fixed_point *int_file_gamma))
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002184#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002185
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002186#ifdef PNG_gAMA_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002187PNG_FP_EXPORT(139, void, png_set_gAMA, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002188 png_inforp info_ptr, double file_gamma))
John Bowler4f67e402011-12-28 08:43:37 -06002189PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002190 png_inforp info_ptr, png_fixed_point int_file_gamma))
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002191#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002192
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002193#ifdef PNG_hIST_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002194PNG_EXPORT(141, png_uint_32, png_get_hIST, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002195 png_inforp info_ptr, png_uint_16p *hist));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002196#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002197
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002198#ifdef PNG_hIST_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002199PNG_EXPORT(142, void, png_set_hIST, (png_const_structrp png_ptr,
2200 png_inforp info_ptr, png_const_uint_16p hist));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002201#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002202
John Bowler5d567862011-12-24 09:12:00 -06002203PNG_EXPORT(143, png_uint_32, png_get_IHDR, (png_const_structrp png_ptr,
John Bowler4f67e402011-12-28 08:43:37 -06002204 png_const_inforp info_ptr, png_uint_32 *width, png_uint_32 *height,
John Bowler40b26032011-12-22 08:09:15 -06002205 int *bit_depth, int *color_type, int *interlace_method,
2206 int *compression_method, int *filter_method));
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002207
John Bowler4f67e402011-12-28 08:43:37 -06002208PNG_EXPORT(144, void, png_set_IHDR, (png_const_structrp png_ptr,
2209 png_inforp info_ptr, png_uint_32 width, png_uint_32 height, int bit_depth,
2210 int color_type, int interlace_method, int compression_method,
2211 int filter_method));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002212
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002213#ifdef PNG_oFFs_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002214PNG_EXPORT(145, png_uint_32, png_get_oFFs, (png_const_structrp png_ptr,
2215 png_const_inforp info_ptr, png_int_32 *offset_x, png_int_32 *offset_y,
John Bowler40b26032011-12-22 08:09:15 -06002216 int *unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002217#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002218
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002219#ifdef PNG_oFFs_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002220PNG_EXPORT(146, void, png_set_oFFs, (png_const_structrp png_ptr,
2221 png_inforp info_ptr, png_int_32 offset_x, png_int_32 offset_y,
2222 int unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002223#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002224
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002225#ifdef PNG_pCAL_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002226PNG_EXPORT(147, png_uint_32, png_get_pCAL, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002227 png_inforp info_ptr, png_charp *purpose, png_int_32 *X0,
John Bowler40b26032011-12-22 08:09:15 -06002228 png_int_32 *X1, int *type, int *nparams, png_charp *units,
2229 png_charpp *params));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002230#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002231
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002232#ifdef PNG_pCAL_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002233PNG_EXPORT(148, void, png_set_pCAL, (png_const_structrp png_ptr,
2234 png_inforp info_ptr, png_const_charp purpose, png_int_32 X0, png_int_32 X1,
2235 int type, int nparams, png_const_charp units, png_charpp params));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002236#endif
2237
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002238#ifdef PNG_pHYs_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002239PNG_EXPORT(149, png_uint_32, png_get_pHYs, (png_const_structrp png_ptr,
2240 png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
John Bowler40b26032011-12-22 08:09:15 -06002241 int *unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002242#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002243
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002244#ifdef PNG_pHYs_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002245PNG_EXPORT(150, void, png_set_pHYs, (png_const_structrp png_ptr,
2246 png_inforp info_ptr, png_uint_32 res_x, png_uint_32 res_y, int unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002247#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002248
John Bowler5d567862011-12-24 09:12:00 -06002249PNG_EXPORT(151, png_uint_32, png_get_PLTE, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002250 png_inforp info_ptr, png_colorp *palette, int *num_palette));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002251
John Bowler4f67e402011-12-28 08:43:37 -06002252PNG_EXPORT(152, void, png_set_PLTE, (png_structrp png_ptr,
2253 png_inforp info_ptr, png_const_colorp palette, int num_palette));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002254
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002255#ifdef PNG_sBIT_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002256PNG_EXPORT(153, png_uint_32, png_get_sBIT, (png_const_structrp png_ptr,
2257 png_inforp info_ptr, png_color_8p *sig_bit));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002258#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002259
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002260#ifdef PNG_sBIT_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002261PNG_EXPORT(154, void, png_set_sBIT, (png_const_structrp png_ptr,
2262 png_inforp info_ptr, png_const_color_8p sig_bit));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002263#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002264
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002265#ifdef PNG_sRGB_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002266PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structrp png_ptr,
2267 png_const_inforp info_ptr, int *file_srgb_intent));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002268#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06002269
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002270#ifdef PNG_sRGB_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002271PNG_EXPORT(156, void, png_set_sRGB, (png_const_structrp png_ptr,
2272 png_inforp info_ptr, int srgb_intent));
2273PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_const_structrp png_ptr,
John Bowler5d567862011-12-24 09:12:00 -06002274 png_inforp info_ptr, int srgb_intent));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002275#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06002276
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002277#ifdef PNG_iCCP_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002278PNG_EXPORT(158, png_uint_32, png_get_iCCP, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002279 png_inforp info_ptr, png_charpp name, int *compression_type,
John Bowler40b26032011-12-22 08:09:15 -06002280 png_bytepp profile, png_uint_32 *proflen));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002281#endif
2282
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002283#ifdef PNG_iCCP_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002284PNG_EXPORT(159, void, png_set_iCCP, (png_const_structrp png_ptr,
2285 png_inforp info_ptr, png_const_charp name, int compression_type,
2286 png_const_bytep profile, png_uint_32 proflen));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002287#endif
2288
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002289#ifdef PNG_sPLT_SUPPORTED
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002290PNG_EXPORT(160, int, png_get_sPLT, (png_const_structrp png_ptr,
2291 png_inforp info_ptr, png_sPLT_tpp entries));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002292#endif
2293
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002294#ifdef PNG_sPLT_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002295PNG_EXPORT(161, void, png_set_sPLT, (png_const_structrp png_ptr,
2296 png_inforp info_ptr, png_const_sPLT_tp entries, int nentries));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002297#endif
2298
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002299#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002300/* png_get_text also returns the number of text chunks in *num_text */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002301PNG_EXPORT(162, int, png_get_text, (png_const_structrp png_ptr,
2302 png_inforp info_ptr, png_textp *text_ptr, int *num_text));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002303#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002304
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002305/* Note while png_set_text() will accept a structure whose text,
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002306 * language, and translated keywords are NULL pointers, the structure
2307 * returned by png_get_text will always contain regular
2308 * zero-terminated C strings. They might be empty strings but
2309 * they will never be NULL pointers.
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -05002310 */
2311
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002312#ifdef PNG_TEXT_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002313PNG_EXPORT(163, void, png_set_text, (png_const_structrp png_ptr,
2314 png_inforp info_ptr, png_const_textp text_ptr, int num_text));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002315#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002316
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002317#ifdef PNG_tIME_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002318PNG_EXPORT(164, png_uint_32, png_get_tIME, (png_const_structrp png_ptr,
2319 png_inforp info_ptr, png_timep *mod_time));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002320#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002321
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002322#ifdef PNG_tIME_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002323PNG_EXPORT(165, void, png_set_tIME, (png_const_structrp png_ptr,
2324 png_inforp info_ptr, png_const_timep mod_time));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002325#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002326
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002327#ifdef PNG_tRNS_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002328PNG_EXPORT(166, png_uint_32, png_get_tRNS, (png_const_structrp png_ptr,
2329 png_inforp info_ptr, png_bytep *trans_alpha, int *num_trans,
John Bowler40b26032011-12-22 08:09:15 -06002330 png_color_16p *trans_color));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002331#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002332
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002333#ifdef PNG_tRNS_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002334PNG_EXPORT(167, void, png_set_tRNS, (png_structrp png_ptr,
2335 png_inforp info_ptr, png_const_bytep trans_alpha, int num_trans,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002336 png_const_color_16p trans_color));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002337#endif
2338
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002339#ifdef PNG_sCAL_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002340PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002341 png_const_inforp info_ptr, int *unit, double *width, double *height))
2342#if defined(PNG_FLOATING_ARITHMETIC_SUPPORTED) || \
2343 defined(PNG_FLOATING_POINT_SUPPORTED)
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002344/* NOTE: this API is currently implemented using floating point arithmetic,
Glenn Randers-Pehrson48dc6eb2010-07-31 07:09:58 -05002345 * consequently it can only be used on systems with floating point support.
2346 * In any case the range of values supported by png_fixed_point is small and it
2347 * is highly recommended that png_get_sCAL_s be used instead.
2348 */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002349PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed,
John Bowler5d567862011-12-24 09:12:00 -06002350 (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002351 png_fixed_point *width, png_fixed_point *height))
Glenn Randers-Pehrson48dc6eb2010-07-31 07:09:58 -05002352#endif
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002353PNG_EXPORT(169, png_uint_32, png_get_sCAL_s,
John Bowler5d567862011-12-24 09:12:00 -06002354 (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,
John Bowler40b26032011-12-22 08:09:15 -06002355 png_charpp swidth, png_charpp sheight));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002356
John Bowler4f67e402011-12-28 08:43:37 -06002357PNG_FP_EXPORT(170, void, png_set_sCAL, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002358 png_inforp info_ptr, int unit, double width, double height))
John Bowler4f67e402011-12-28 08:43:37 -06002359PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_const_structrp png_ptr,
John Bowler5d567862011-12-24 09:12:00 -06002360 png_inforp info_ptr, int unit, png_fixed_point width,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002361 png_fixed_point height))
John Bowler4f67e402011-12-28 08:43:37 -06002362PNG_EXPORT(171, void, png_set_sCAL_s, (png_const_structrp png_ptr,
2363 png_inforp info_ptr, int unit,
2364 png_const_charp swidth, png_const_charp sheight));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002365#endif /* PNG_sCAL_SUPPORTED */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002366
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002367#ifdef PNG_SET_UNKNOWN_CHUNKS_SUPPORTED
2368/* Provide the default handling for all unknown chunks or, optionally, for
2369 * specific unknown chunks.
2370 *
2371 * NOTE: prior to 1.6.0 the handling specified for particular chunks on read was
2372 * ignored and the default was used, the per-chunk setting only had an effect on
2373 * write. If you wish to have chunk-specific handling on read in code that must
2374 * work on earlier versions you must use a user chunk callback to specify the
2375 * desired handling (keep or discard.)
2376 *
2377 * The 'keep' parameter is a PNG_HANDLE_CHUNK_ value as listed below. The
2378 * parameter is interpreted as follows:
2379 *
2380 * READ:
2381 * PNG_HANDLE_CHUNK_AS_DEFAULT:
2382 * Known chunks: do normal libpng processing, do not keep the chunk (but
2383 * see the comments below about PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
2384 * Unknown chunks: for a specific chunk use the global default, when used
2385 * as the default discard the chunk data.
2386 * PNG_HANDLE_CHUNK_NEVER:
2387 * Discard the chunk data.
2388 * PNG_HANDLE_CHUNK_IF_SAFE:
2389 * Keep the chunk data if the chunk is not critical else raise a chunk
2390 * error.
2391 * PNG_HANDLE_CHUNK_ALWAYS:
2392 * Keep the chunk data.
2393 *
2394 * If the chunk data is saved it can be retrieved using png_get_unknown_chunks,
2395 * below. Notice that specifying "AS_DEFAULT" as a global default is equivalent
2396 * to specifying "NEVER", however when "AS_DEFAULT" is used for specific chunks
2397 * it simply resets the behavior to the libpng default.
2398 *
John Bowlere15b5372013-03-02 17:59:43 -06002399 * INTERACTION WTIH USER CHUNK CALLBACKS:
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002400 * The per-chunk handling is always used when there is a png_user_chunk_ptr
2401 * callback and the callback returns 0; the chunk is then always stored *unless*
2402 * it is critical and the per-chunk setting is other than ALWAYS. Notice that
2403 * the global default is *not* used in this case. (In effect the per-chunk
2404 * value is incremented to at least IF_SAFE.)
2405 *
John Bowlere15b5372013-03-02 17:59:43 -06002406 * IMPORTANT NOTE: this behavior will change in libpng 1.7 - the global and
2407 * per-chunk defaults will be honored. If you want to preserve the current
2408 * behavior when your callback returns 0 you must set PNG_HANDLE_CHUNK_IF_SAFE
2409 * as the default - if you don't do this libpng 1.6 will issue a warning.
2410 *
2411 * If you want unhandled unknown chunks to be discarded in libpng 1.6 and
2412 * earlier simply return '1' (handled).
2413 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002414 * PNG_HANDLE_AS_UNKNOWN_SUPPORTED:
2415 * If this is *not* set known chunks will always be handled by libpng and
2416 * will never be stored in the unknown chunk list. Known chunks listed to
2417 * png_set_keep_unknown_chunks will have no effect. If it is set then known
2418 * chunks listed with a keep other than AS_DEFAULT will *never* be processed
2419 * by libpng, in addition critical chunks must either be processed by the
2420 * callback or saved.
2421 *
2422 * The IHDR and IEND chunks must not be listed. Because this turns off the
2423 * default handling for chunks that would otherwise be recognized the
2424 * behavior of libpng transformations may well become incorrect!
2425 *
2426 * WRITE:
2427 * When writing chunks the options only apply to the chunks specified by
2428 * png_set_unknown_chunks (below), libpng will *always* write known chunks
2429 * required by png_set_ calls and will always write the core critical chunks
2430 * (as required for PLTE).
2431 *
2432 * Each chunk in the png_set_unknown_chunks list is looked up in the
2433 * png_set_keep_unknown_chunks list to find the keep setting, this is then
2434 * interpreted as follows:
2435 *
2436 * PNG_HANDLE_CHUNK_AS_DEFAULT:
2437 * Write safe-to-copy chunks and write other chunks if the global
2438 * default is set to _ALWAYS, otherwise don't write this chunk.
2439 * PNG_HANDLE_CHUNK_NEVER:
2440 * Do not write the chunk.
2441 * PNG_HANDLE_CHUNK_IF_SAFE:
2442 * Write the chunk if it is safe-to-copy, otherwise do not write it.
2443 * PNG_HANDLE_CHUNK_ALWAYS:
2444 * Write the chunk.
2445 *
2446 * Note that the default behavior is effectively the opposite of the read case -
2447 * in read unknown chunks are not stored by default, in write they are written
2448 * by default. Also the behavior of PNG_HANDLE_CHUNK_IF_SAFE is very different
2449 * - on write the safe-to-copy bit is checked, on read the critical bit is
2450 * checked and on read if the chunk is critical an error will be raised.
2451 *
2452 * num_chunks:
2453 * ===========
2454 * If num_chunks is positive, then the "keep" parameter specifies the manner
2455 * for handling only those chunks appearing in the chunk_list array,
2456 * otherwise the chunk list array is ignored.
2457 *
2458 * If num_chunks is 0 the "keep" parameter specifies the default behavior for
2459 * unknown chunks, as described above.
2460 *
2461 * If num_chunks is negative, then the "keep" parameter specifies the manner
2462 * for handling all unknown chunks plus all chunks recognized by libpng
2463 * except for the IHDR, PLTE, tRNS, IDAT, and IEND chunks (which continue to
2464 * be processed by libpng.
2465 */
John Bowler5d567862011-12-24 09:12:00 -06002466PNG_EXPORT(172, void, png_set_keep_unknown_chunks, (png_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06002467 int keep, png_const_bytep chunk_list, int num_chunks));
Glenn Randers-Pehrsonbb5cb142011-09-22 12:41:58 -05002468
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002469/* The "keep" PNG_HANDLE_CHUNK_ parameter for the specified chunk is returned;
2470 * the result is therefore true (non-zero) if special handling is required,
2471 * false for the default handling.
Glenn Randers-Pehrsonbb5cb142011-09-22 12:41:58 -05002472 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002473PNG_EXPORT(173, int, png_handle_as_unknown, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002474 png_const_bytep chunk_name));
Glenn Randers-Pehrson7824a702009-06-13 10:05:05 -05002475#endif
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002476
2477#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002478PNG_EXPORT(174, void, png_set_unknown_chunks, (png_const_structrp png_ptr,
John Bowler5d567862011-12-24 09:12:00 -06002479 png_inforp info_ptr, png_const_unknown_chunkp unknowns,
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002480 int num_unknowns));
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002481 /* NOTE: prior to 1.6.0 this routine set the 'location' field of the added
2482 * unknowns to the location currently stored in the png_struct. This is
2483 * invariably the wrong value on write. To fix this call the following API
2484 * for each chunk in the list with the correct location. If you know your
2485 * code won't be compiled on earlier versions you can rely on
2486 * png_set_unknown_chunks(write-ptr, png_get_unknown_chunks(read-ptr)) doing
2487 * the correct thing.
2488 */
2489
John Bowler4f67e402011-12-28 08:43:37 -06002490PNG_EXPORT(175, void, png_set_unknown_chunk_location,
2491 (png_const_structrp png_ptr, png_inforp info_ptr, int chunk, int location));
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002492
John Bowler5d567862011-12-24 09:12:00 -06002493PNG_EXPORT(176, int, png_get_unknown_chunks, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002494 png_inforp info_ptr, png_unknown_chunkpp entries));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002495#endif
2496
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -05002497/* Png_free_data() will turn off the "valid" flag for anything it frees.
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002498 * If you need to turn it off for a chunk that your application has freed,
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002499 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
2500 */
John Bowler5d567862011-12-24 09:12:00 -06002501PNG_EXPORT(177, void, png_set_invalid, (png_const_structrp png_ptr,
2502 png_inforp info_ptr, int mask));
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002503
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002504#ifdef PNG_INFO_IMAGE_SUPPORTED
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -05002505/* The "params" pointer is currently not used and is for future expansion. */
John Bowler5d567862011-12-24 09:12:00 -06002506PNG_EXPORT(178, void, png_read_png, (png_structrp png_ptr, png_inforp info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002507 int transforms, png_voidp params));
John Bowler5d567862011-12-24 09:12:00 -06002508PNG_EXPORT(179, void, png_write_png, (png_structrp png_ptr, png_inforp info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002509 int transforms, png_voidp params));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002510#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002511
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002512PNG_EXPORT(180, png_const_charp, png_get_copyright,
John Bowler5d567862011-12-24 09:12:00 -06002513 (png_const_structrp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002514PNG_EXPORT(181, png_const_charp, png_get_header_ver,
John Bowler5d567862011-12-24 09:12:00 -06002515 (png_const_structrp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002516PNG_EXPORT(182, png_const_charp, png_get_header_version,
John Bowler5d567862011-12-24 09:12:00 -06002517 (png_const_structrp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002518PNG_EXPORT(183, png_const_charp, png_get_libpng_ver,
John Bowler5d567862011-12-24 09:12:00 -06002519 (png_const_structrp png_ptr));
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -06002520
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -06002521#ifdef PNG_MNG_FEATURES_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002522PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002523 png_uint_32 mng_features_permitted));
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -06002524#endif
2525
Glenn Randers-Pehrson8f3dd832004-08-10 09:43:42 -05002526/* For use in png_set_keep_unknown, added to version 1.2.6 */
2527#define PNG_HANDLE_CHUNK_AS_DEFAULT 0
2528#define PNG_HANDLE_CHUNK_NEVER 1
2529#define PNG_HANDLE_CHUNK_IF_SAFE 2
2530#define PNG_HANDLE_CHUNK_ALWAYS 3
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002531#define PNG_HANDLE_CHUNK_LAST 4
Glenn Randers-Pehrson8f3dd832004-08-10 09:43:42 -05002532
Glenn Randers-Pehrsone68f5a32001-05-14 09:20:53 -05002533/* Strip the prepended error numbers ("#nnn ") from error and warning
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002534 * messages before passing them to the error or warning handler.
2535 */
Glenn Randers-Pehrsone68f5a32001-05-14 09:20:53 -05002536#ifdef PNG_ERROR_NUMBERS_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002537PNG_EXPORT(185, void, png_set_strip_error_numbers, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002538 png_uint_32 strip_mode));
Glenn Randers-Pehrsonbe9de0f2001-01-22 08:52:16 -06002539#endif
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05002540
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002541/* Added in libpng-1.2.6 */
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05002542#ifdef PNG_SET_USER_LIMITS_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002543PNG_EXPORT(186, void, png_set_user_limits, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002544 png_uint_32 user_width_max, png_uint_32 user_height_max));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002545PNG_EXPORT(187, png_uint_32, png_get_user_width_max,
John Bowler5d567862011-12-24 09:12:00 -06002546 (png_const_structrp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002547PNG_EXPORT(188, png_uint_32, png_get_user_height_max,
John Bowler5d567862011-12-24 09:12:00 -06002548 (png_const_structrp png_ptr));
Glenn Randers-Pehrson800d1e92008-08-20 17:25:21 -05002549/* Added in libpng-1.4.0 */
John Bowler5d567862011-12-24 09:12:00 -06002550PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002551 png_uint_32 user_chunk_cache_max));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002552PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max,
John Bowler5d567862011-12-24 09:12:00 -06002553 (png_const_structrp png_ptr));
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06002554/* Added in libpng-1.4.1 */
John Bowler5d567862011-12-24 09:12:00 -06002555PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002556 png_alloc_size_t user_chunk_cache_max));
2557PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max,
John Bowler5d567862011-12-24 09:12:00 -06002558 (png_const_structrp png_ptr));
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05002559#endif
2560
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002561#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002562PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch,
John Bowler5d567862011-12-24 09:12:00 -06002563 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002564
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002565PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch,
John Bowler5d567862011-12-24 09:12:00 -06002566 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002567
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002568PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch,
John Bowler5d567862011-12-24 09:12:00 -06002569 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002570
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002571PNG_FP_EXPORT(196, float, png_get_x_offset_inches,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002572 (png_const_structrp png_ptr, png_const_inforp info_ptr))
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002573#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002574PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002575 (png_const_structrp png_ptr, png_const_inforp info_ptr))
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002576#endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002577
John Bowler5d567862011-12-24 09:12:00 -06002578PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002579 png_const_inforp info_ptr))
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002580#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002581PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002582 (png_const_structrp png_ptr, png_const_inforp info_ptr))
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002583#endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002584
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06002585# ifdef PNG_pHYs_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002586PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structrp png_ptr,
2587 png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002588 int *unit_type));
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06002589# endif /* PNG_pHYs_SUPPORTED */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002590#endif /* PNG_INCH_CONVERSIONS_SUPPORTED */
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002591
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002592/* Added in libpng-1.4.0 */
2593#ifdef PNG_IO_STATE_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002594PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_const_structrp png_ptr));
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002595
John Bowler40b26032011-12-22 08:09:15 -06002596/* Removed from libpng 1.6; use png_get_io_chunk_type. */
John Bowler5d567862011-12-24 09:12:00 -06002597PNG_REMOVED(200, png_const_bytep, png_get_io_chunk_name, (png_structrp png_ptr),
John Bowler40b26032011-12-22 08:09:15 -06002598 PNG_DEPRECATED)
2599
Glenn Randers-Pehrsoncf7cce62011-01-22 12:42:43 -06002600PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type,
John Bowler5d567862011-12-24 09:12:00 -06002601 (png_const_structrp png_ptr));
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002602
2603/* The flags returned by png_get_io_state() are the following: */
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06002604# define PNG_IO_NONE 0x0000 /* no I/O at this moment */
2605# define PNG_IO_READING 0x0001 /* currently reading */
2606# define PNG_IO_WRITING 0x0002 /* currently writing */
2607# define PNG_IO_SIGNATURE 0x0010 /* currently at the file signature */
2608# define PNG_IO_CHUNK_HDR 0x0020 /* currently at the chunk header */
2609# define PNG_IO_CHUNK_DATA 0x0040 /* currently at the chunk data */
2610# define PNG_IO_CHUNK_CRC 0x0080 /* currently at the chunk crc */
2611# define PNG_IO_MASK_OP 0x000f /* current operation: reading/writing */
2612# define PNG_IO_MASK_LOC 0x00f0 /* current location: sig/hdr/data/crc */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002613#endif /* ?PNG_IO_STATE_SUPPORTED */
2614
John Bowler660c6e42010-12-19 06:22:23 -06002615/* Interlace support. The following macros are always defined so that if
2616 * libpng interlace handling is turned off the macros may be used to handle
2617 * interlaced images within the application.
2618 */
2619#define PNG_INTERLACE_ADAM7_PASSES 7
2620
2621/* Two macros to return the first row and first column of the original,
2622 * full, image which appears in a given pass. 'pass' is in the range 0
2623 * to 6 and the result is in the range 0 to 7.
2624 */
John Bowler4e68aa72011-10-11 16:01:33 -05002625#define PNG_PASS_START_ROW(pass) (((1&~(pass))<<(3-((pass)>>1)))&7)
2626#define PNG_PASS_START_COL(pass) (((1& (pass))<<(3-(((pass)+1)>>1)))&7)
2627
2628/* A macro to return the offset between pixels in the output row for a pair of
2629 * pixels in the input - effectively the inverse of the 'COL_SHIFT' macro that
2630 * follows. Note that ROW_OFFSET is the offset from one row to the next whereas
2631 * COL_OFFSET is from one column to the next, within a row.
2632 */
2633#define PNG_PASS_ROW_OFFSET(pass) ((pass)>2?(8>>(((pass)-1)>>1)):8)
2634#define PNG_PASS_COL_OFFSET(pass) (1<<((7-(pass))>>1))
John Bowler660c6e42010-12-19 06:22:23 -06002635
2636/* Two macros to help evaluate the number of rows or columns in each
2637 * pass. This is expressed as a shift - effectively log2 of the number or
2638 * rows or columns in each 8x8 tile of the original image.
2639 */
2640#define PNG_PASS_ROW_SHIFT(pass) ((pass)>2?(8-(pass))>>1:3)
2641#define PNG_PASS_COL_SHIFT(pass) ((pass)>1?(7-(pass))>>1:3)
2642
2643/* Hence two macros to determine the number of rows or columns in a given
2644 * pass of an image given its height or width. In fact these macros may
2645 * return non-zero even though the sub-image is empty, because the other
2646 * dimension may be empty for a small image.
2647 */
2648#define PNG_PASS_ROWS(height, pass) (((height)+(((1<<PNG_PASS_ROW_SHIFT(pass))\
2649 -1)-PNG_PASS_START_ROW(pass)))>>PNG_PASS_ROW_SHIFT(pass))
2650#define PNG_PASS_COLS(width, pass) (((width)+(((1<<PNG_PASS_COL_SHIFT(pass))\
2651 -1)-PNG_PASS_START_COL(pass)))>>PNG_PASS_COL_SHIFT(pass))
2652
John Bowler9616ad92011-02-16 06:13:46 -06002653/* For the reader row callbacks (both progressive and sequential) it is
2654 * necessary to find the row in the output image given a row in an interlaced
2655 * image, so two more macros:
John Bowler660c6e42010-12-19 06:22:23 -06002656 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002657#define PNG_ROW_FROM_PASS_ROW(y_in, pass) \
2658 (((y_in)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass))
2659#define PNG_COL_FROM_PASS_COL(x_in, pass) \
2660 (((x_in)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass))
John Bowler660c6e42010-12-19 06:22:23 -06002661
2662/* Two macros which return a boolean (0 or 1) saying whether the given row
2663 * or column is in a particular pass. These use a common utility macro that
2664 * returns a mask for a given pass - the offset 'off' selects the row or
2665 * column version. The mask has the appropriate bit set for each column in
2666 * the tile.
2667 */
2668#define PNG_PASS_MASK(pass,off) ( \
John Bowler4e68aa72011-10-11 16:01:33 -05002669 ((0x110145AF>>(((7-(off))-(pass))<<2)) & 0xF) | \
2670 ((0x01145AF0>>(((7-(off))-(pass))<<2)) & 0xF0))
John Bowler660c6e42010-12-19 06:22:23 -06002671
2672#define PNG_ROW_IN_INTERLACE_PASS(y, pass) \
2673 ((PNG_PASS_MASK(pass,0) >> ((y)&7)) & 1)
2674#define PNG_COL_IN_INTERLACE_PASS(x, pass) \
2675 ((PNG_PASS_MASK(pass,1) >> ((x)&7)) & 1)
2676
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002677#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -05002678/* With these routines we avoid an integer divide, which will be slower on
2679 * most machines. However, it does take more operations than the corresponding
2680 * divide method, so it may be slower on a few RISC systems. There are two
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002681 * shifts (by 8 or 16 bits) and an addition, versus a single integer divide.
2682 *
2683 * Note that the rounding factors are NOT supposed to be the same! 128 and
2684 * 32768 are correct for the NODIV code; 127 and 32767 are correct for the
2685 * standard method.
2686 *
2687 * [Optimized code by Greg Roelofs and Mark Adler...blame us for bugs. :-) ]
2688 */
2689
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06002690 /* fg and bg should be in `gamma 1.0' space; alpha is the opacity */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002691
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06002692# define png_composite(composite, fg, alpha, bg) \
2693 { png_uint_16 temp = (png_uint_16)((png_uint_16)(fg) \
2694 * (png_uint_16)(alpha) \
2695 + (png_uint_16)(bg)*(png_uint_16)(255 \
John Bowler75156122011-09-09 17:21:44 -05002696 - (png_uint_16)(alpha)) + 128); \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002697 (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002698
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06002699# define png_composite_16(composite, fg, alpha, bg) \
2700 { png_uint_32 temp = (png_uint_32)((png_uint_32)(fg) \
2701 * (png_uint_32)(alpha) \
John Bowler75156122011-09-09 17:21:44 -05002702 + (png_uint_32)(bg)*(65535 \
2703 - (png_uint_32)(alpha)) + 32768); \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002704 (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }
2705
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002706#else /* Standard method using integer division */
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002707
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06002708# define png_composite(composite, fg, alpha, bg) \
2709 (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) + \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06002710 (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \
John Bowler75156122011-09-09 17:21:44 -05002711 127) / 255)
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002712
2713# define png_composite_16(composite, fg, alpha, bg) \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002714 (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \
John Bowler75156122011-09-09 17:21:44 -05002715 (png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) + \
2716 32767) / 65535)
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002717#endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */
2718
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002719#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002720PNG_EXPORT(201, png_uint_32, png_get_uint_32, (png_const_bytep buf));
2721PNG_EXPORT(202, png_uint_16, png_get_uint_16, (png_const_bytep buf));
2722PNG_EXPORT(203, png_int_32, png_get_int_32, (png_const_bytep buf));
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002723#endif
2724
John Bowler5d567862011-12-24 09:12:00 -06002725PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002726 png_const_bytep buf));
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002727/* No png_get_int_16 -- may be added if there's a real need for it. */
2728
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002729/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002730#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002731PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i));
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002732#endif
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05002733#ifdef PNG_SAVE_INT_32_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002734PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i));
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05002735#endif
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002736
2737/* Place a 16-bit number into a buffer in PNG byte order.
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002738 * The parameter is declared unsigned int, not png_uint_16,
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002739 * just to avoid potential problems on pre-ANSI C compilers.
2740 */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002741#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002742PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i));
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002743/* No png_save_int_16 -- may be added if there's a real need for it. */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002744#endif
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002745
John Bowlerf21a0d02011-01-23 23:55:19 -06002746#ifdef PNG_USE_READ_MACROS
2747/* Inline macros to do direct reads of bytes from the input buffer.
2748 * The png_get_int_32() routine assumes we are using two's complement
2749 * format for negative values, which is almost certainly true.
2750 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002751# define PNG_get_uint_32(buf) \
John Bowlerf21a0d02011-01-23 23:55:19 -06002752 (((png_uint_32)(*(buf)) << 24) + \
2753 ((png_uint_32)(*((buf) + 1)) << 16) + \
2754 ((png_uint_32)(*((buf) + 2)) << 8) + \
2755 ((png_uint_32)(*((buf) + 3))))
2756
2757 /* From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
2758 * function) incorrectly returned a value of type png_uint_32.
2759 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002760# define PNG_get_uint_16(buf) \
John Bowlerf21a0d02011-01-23 23:55:19 -06002761 ((png_uint_16) \
2762 (((unsigned int)(*(buf)) << 8) + \
2763 ((unsigned int)(*((buf) + 1)))))
2764
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002765# define PNG_get_int_32(buf) \
John Bowlerf21a0d02011-01-23 23:55:19 -06002766 ((png_int_32)((*(buf) & 0x80) \
2767 ? -((png_int_32)((png_get_uint_32(buf) ^ 0xffffffffL) + 1)) \
2768 : (png_int_32)png_get_uint_32(buf)))
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002769
2770 /* If PNG_PREFIX is defined the same thing as below happens in pnglibconf.h,
2771 * but defining a macro name prefixed with PNG_PREFIX.
2772 */
2773# ifndef PNG_PREFIX
2774# define png_get_uint_32(buf) PNG_get_uint_32(buf)
2775# define png_get_uint_16(buf) PNG_get_uint_16(buf)
2776# define png_get_int_32(buf) PNG_get_int_32(buf)
2777# endif
2778#else
2779# ifdef PNG_PREFIX
2780 /* No macros; revert to the (redefined) function */
2781# define PNG_get_uint_32 (png_get_uint_32)
2782# define PNG_get_uint_16 (png_get_uint_16)
2783# define PNG_get_int_32 (png_get_int_32)
2784# endif
John Bowlerf21a0d02011-01-23 23:55:19 -06002785#endif
2786
John Bowler7875d532011-11-07 22:33:49 -06002787/*******************************************************************************
2788 * SIMPLIFIED API
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002789 *******************************************************************************
2790 *
Glenn Randers-Pehrson5a956a72011-12-22 14:23:37 -06002791 * Please read the documentation in libpng-manual.txt (TODO: write said
2792 * documentation) if you don't understand what follows.
John Bowler7875d532011-11-07 22:33:49 -06002793 *
2794 * The simplified API hides the details of both libpng and the PNG file format
2795 * itself. It allows PNG files to be read into a very limited number of
2796 * in-memory bitmap formats or to be written from the same formats. If these
2797 * formats do not accomodate your needs then you can, and should, use the more
2798 * sophisticated APIs above - these support a wide variety of in-memory formats
2799 * and a wide variety of sophisticated transformations to those formats as well
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002800 * as a wide variety of APIs to manipulate ancillary information.
John Bowler7875d532011-11-07 22:33:49 -06002801 *
2802 * To read a PNG file using the simplified API:
2803 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002804 * 1) Declare a 'png_image' structure (see below) on the stack and set the
2805 * version field to PNG_IMAGE_VERSION.
John Bowler7875d532011-11-07 22:33:49 -06002806 * 2) Call the appropriate png_image_begin_read... function.
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002807 * 3) Set the png_image 'format' member to the required sample format.
2808 * 4) Allocate a buffer for the image and, if required, the color-map.
2809 * 5) Call png_image_finish_read to read the image and, if required, the
2810 * color-map into your buffers.
John Bowler7875d532011-11-07 22:33:49 -06002811 *
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002812 * There are no restrictions on the format of the PNG input itself; all valid
2813 * color types, bit depths, and interlace methods are acceptable, and the
2814 * input image is transformed as necessary to the requested in-memory format
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002815 * during the png_image_finish_read() step. The only caveat is that if you
2816 * request a color-mapped image from a PNG that is full-color or makes
2817 * complex use of an alpha channel the transformation is extremely lossy and the
2818 * result may look terrible.
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002819 *
John Bowler7875d532011-11-07 22:33:49 -06002820 * To write a PNG file using the simplified API:
2821 *
2822 * 1) Declare a 'png_image' structure on the stack and memset() it to all zero.
2823 * 2) Initialize the members of the structure that describe the image, setting
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002824 * the 'format' member to the format of the image samples.
John Bowler5bc90382012-01-23 22:43:22 -06002825 * 3) Call the appropriate png_image_write... function with a pointer to the
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002826 * image and, if necessary, the color-map to write the PNG data.
John Bowler7875d532011-11-07 22:33:49 -06002827 *
Glenn Randers-Pehrsonefc4b692011-11-07 23:31:34 -06002828 * png_image is a structure that describes the in-memory format of an image
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002829 * when it is being read or defines the in-memory format of an image that you
John Bowler7875d532011-11-07 22:33:49 -06002830 * need to write:
2831 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002832#define PNG_IMAGE_VERSION 1
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002833
John Bowler7875d532011-11-07 22:33:49 -06002834typedef struct png_control *png_controlp;
2835typedef struct
2836{
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002837 png_controlp opaque; /* Initialize to NULL, free with png_image_free */
2838 png_uint_32 version; /* Set to PNG_IMAGE_VERSION */
2839 png_uint_32 width; /* Image width in pixels (columns) */
2840 png_uint_32 height; /* Image height in pixels (rows) */
2841 png_uint_32 format; /* Image format as defined below */
2842 png_uint_32 flags; /* A bit mask containing informational flags */
2843 png_uint_32 colormap_entries;
2844 /* Number of entries in the color-map */
John Bowler04336ba2012-01-16 07:48:36 -06002845
John Bowler7875d532011-11-07 22:33:49 -06002846 /* In the event of an error or warning the following field will be set to a
2847 * non-zero value and the 'message' field will contain a '\0' terminated
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002848 * string with the libpng error or warning message. If both warnings and
2849 * an error were encountered, only the error is recorded. If there
2850 * are multiple warnings, only the first one is recorded.
2851 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002852 * The upper 30 bits of this value are reserved, the low two bits contain
2853 * a value as follows:
John Bowler04336ba2012-01-16 07:48:36 -06002854 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002855# define PNG_IMAGE_WARNING 1
2856# define PNG_IMAGE_ERROR 2
2857 /*
2858 * The result is a two bit code such that a value more than 1 indicates
2859 * a failure in the API just called:
2860 *
2861 * 0 - no warning or error
2862 * 1 - warning
2863 * 2 - error
2864 * 3 - error preceded by warning
2865 */
2866# define PNG_IMAGE_FAILED(png_cntrl) ((((png_cntrl).warning_or_error)&0x03)>1)
2867
John Bowler7875d532011-11-07 22:33:49 -06002868 png_uint_32 warning_or_error;
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002869
John Bowler7875d532011-11-07 22:33:49 -06002870 char message[64];
2871} png_image, *png_imagep;
2872
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002873/* The samples of the image have one to four channels whose components have
2874 * original values in the range 0 to 1.0:
John Bowler7875d532011-11-07 22:33:49 -06002875 *
2876 * 1: A single gray or luminance channel (G).
2877 * 2: A gray/luminance channel and an alpha channel (GA).
2878 * 3: Three red, green, blue color channels (RGB).
2879 * 4: Three color channels and an alpha channel (RGBA).
2880 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002881 * The components are encoded in one of two ways:
John Bowler7875d532011-11-07 22:33:49 -06002882 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002883 * a) As a small integer, value 0..255, contained in a single byte. For the
John Bowlerdd819152011-11-08 14:29:45 -06002884 * alpha channel the original value is simply value/255. For the color or
John Bowler7875d532011-11-07 22:33:49 -06002885 * luminance channels the value is encoded according to the sRGB specification
2886 * and matches the 8-bit format expected by typical display devices.
2887 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002888 * The color/gray channels are not scaled (pre-multiplied) by the alpha
John Bowler7875d532011-11-07 22:33:49 -06002889 * channel and are suitable for passing to color management software.
2890 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002891 * b) As a value in the range 0..65535, contained in a 2-byte integer. All
John Bowler7875d532011-11-07 22:33:49 -06002892 * channels can be converted to the original value by dividing by 65535; all
2893 * channels are linear. Color channels use the RGB encoding (RGB end-points) of
2894 * the sRGB specification. This encoding is identified by the
2895 * PNG_FORMAT_FLAG_LINEAR flag below.
2896 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002897 * When the simplified API needs to convert between sRGB and linear colorspaces,
2898 * the actual sRGB transfer curve defined in the sRGB specification (see the
2899 * article at http://en.wikipedia.org/wiki/SRGB) is used, not the gamma=1/2.2
2900 * approximation used elsewhere in libpng.
2901 *
2902 * When an alpha channel is present it is expected to denote pixel coverage
John Bowler7875d532011-11-07 22:33:49 -06002903 * of the color or luminance channels and is returned as an associated alpha
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002904 * channel: the color/gray channels are scaled (pre-multiplied) by the alpha
2905 * value.
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002906 *
2907 * The samples are either contained directly in the image data, between 1 and 8
2908 * bytes per pixel according to the encoding, or are held in a color-map indexed
2909 * by bytes in the image data. In the case of a color-map the color-map entries
2910 * are individual samples, encoded as above, and the image data has one byte per
2911 * pixel to select the relevant sample from the color-map.
John Bowler7875d532011-11-07 22:33:49 -06002912 */
2913
2914/* PNG_FORMAT_*
2915 *
2916 * #defines to be used in png_image::format. Each #define identifies a
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002917 * particular layout of sample data and, if present, alpha values. There are
2918 * separate defines for each of the two component encodings.
John Bowler7875d532011-11-07 22:33:49 -06002919 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002920 * A format is built up using single bit flag values. All combinations are
2921 * valid. Formats can be built up from the flag values or you can use one of
2922 * the predefined values below. When testing formats always use the FORMAT_FLAG
2923 * macros to test for individual features - future versions of the library may
2924 * add new flags.
2925 *
2926 * When reading or writing color-mapped images the format should be set to the
2927 * format of the entries in the color-map then png_image_{read,write}_colormap
2928 * called to read or write the color-map and set the format correctly for the
2929 * image data. Do not set the PNG_FORMAT_FLAG_COLORMAP bit directly!
John Bowler04336ba2012-01-16 07:48:36 -06002930 *
John Bowler7875d532011-11-07 22:33:49 -06002931 * NOTE: libpng can be built with particular features disabled, if you see
2932 * compiler errors because the definition of one of the following flags has been
2933 * compiled out it is because libpng does not have the required support. It is
2934 * possible, however, for the libpng configuration to enable the format on just
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002935 * read or just write; in that case you may see an error at run time. You can
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002936 * guard against this by checking for the definition of the appropriate
2937 * "_SUPPORTED" macro, one of:
John Bowler7875d532011-11-07 22:33:49 -06002938 *
2939 * PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED
2940 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002941#define PNG_FORMAT_FLAG_ALPHA 0x01U /* format with an alpha channel */
2942#define PNG_FORMAT_FLAG_COLOR 0x02U /* color format: otherwise grayscale */
2943#define PNG_FORMAT_FLAG_LINEAR 0x04U /* 2 byte channels else 1 byte */
2944#define PNG_FORMAT_FLAG_COLORMAP 0x08U /* image data is color-mapped */
John Bowler7875d532011-11-07 22:33:49 -06002945
2946#ifdef PNG_FORMAT_BGR_SUPPORTED
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002947# define PNG_FORMAT_FLAG_BGR 0x10U /* BGR colors, else order is RGB */
John Bowler7875d532011-11-07 22:33:49 -06002948#endif
2949
2950#ifdef PNG_FORMAT_AFIRST_SUPPORTED
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002951# define PNG_FORMAT_FLAG_AFIRST 0x20U /* alpha channel comes first */
John Bowler7875d532011-11-07 22:33:49 -06002952#endif
2953
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002954/* Commonly used formats have predefined macros.
John Bowler7875d532011-11-07 22:33:49 -06002955 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002956 * First the single byte (sRGB) formats:
John Bowler7875d532011-11-07 22:33:49 -06002957 */
2958#define PNG_FORMAT_GRAY 0
2959#define PNG_FORMAT_GA PNG_FORMAT_FLAG_ALPHA
John Bowlerdd819152011-11-08 14:29:45 -06002960#define PNG_FORMAT_AG (PNG_FORMAT_GA|PNG_FORMAT_FLAG_AFIRST)
John Bowler7875d532011-11-07 22:33:49 -06002961#define PNG_FORMAT_RGB PNG_FORMAT_FLAG_COLOR
2962#define PNG_FORMAT_BGR (PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_BGR)
2963#define PNG_FORMAT_RGBA (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_ALPHA)
2964#define PNG_FORMAT_ARGB (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_AFIRST)
2965#define PNG_FORMAT_BGRA (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_ALPHA)
2966#define PNG_FORMAT_ABGR (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_AFIRST)
2967
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002968/* Then the linear 2-byte formats. When naming these "Y" is used to
2969 * indicate a luminance (gray) channel.
John Bowler7875d532011-11-07 22:33:49 -06002970 */
John Bowlerdd819152011-11-08 14:29:45 -06002971#define PNG_FORMAT_LINEAR_Y PNG_FORMAT_FLAG_LINEAR
2972#define PNG_FORMAT_LINEAR_Y_ALPHA (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_ALPHA)
2973#define PNG_FORMAT_LINEAR_RGB (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR)
2974#define PNG_FORMAT_LINEAR_RGB_ALPHA \
2975 (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA)
John Bowler7875d532011-11-07 22:33:49 -06002976
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002977/* With color-mapped formats the image data is one byte for each pixel, the byte
2978 * is an index into the color-map which is formatted as above. To obtain a
2979 * color-mapped format it is sufficient just to add the PNG_FOMAT_FLAG_COLORMAP
2980 * to one of the above definitions, or you can use one of the definitions below.
2981 */
2982#define PNG_FORMAT_RGB_COLORMAP (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_COLORMAP)
2983#define PNG_FORMAT_BGR_COLORMAP (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_COLORMAP)
2984#define PNG_FORMAT_RGBA_COLORMAP (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_COLORMAP)
2985#define PNG_FORMAT_ARGB_COLORMAP (PNG_FORMAT_ARGB|PNG_FORMAT_FLAG_COLORMAP)
2986#define PNG_FORMAT_BGRA_COLORMAP (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_COLORMAP)
2987#define PNG_FORMAT_ABGR_COLORMAP (PNG_FORMAT_ABGR|PNG_FORMAT_FLAG_COLORMAP)
2988
John Bowler7875d532011-11-07 22:33:49 -06002989/* PNG_IMAGE macros
2990 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002991 * These are convenience macros to derive information from a png_image
2992 * structure. The PNG_IMAGE_SAMPLE_ macros return values appropriate to the
2993 * actual image sample values - either the entries in the color-map or the
2994 * pixels in the image. The PNG_IMAGE_PIXEL_ macros return corresponding values
2995 * for the pixels and will always return 1 for color-mapped formats. The
2996 * remaining macros return information about the rows in the image and the
2997 * complete image.
2998 *
2999 * NOTE: All the macros that take a png_image::format parameter are compile time
3000 * constants if the format parameter is, itself, a constant. Therefore these
3001 * macros can be used in array declarations and case labels where required.
3002 * Similarly the macros are also pre-processor constants (sizeof is not used) so
3003 * they can be used in #if tests.
3004 *
3005 * First the information about the samples.
John Bowler7875d532011-11-07 22:33:49 -06003006 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003007#define PNG_IMAGE_SAMPLE_CHANNELS(fmt)\
3008 (((fmt)&(PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA))+1)
John Bowler7875d532011-11-07 22:33:49 -06003009 /* Return the total number of channels in a given format: 1..4 */
3010
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003011#define PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt)\
3012 ((((fmt) & PNG_FORMAT_FLAG_LINEAR) >> 2)+1)
3013 /* Return the size in bytes of a single component of a pixel or color-map
3014 * entry (as appropriate) in the image: 1 or 2.
3015 */
John Bowler7875d532011-11-07 22:33:49 -06003016
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003017#define PNG_IMAGE_SAMPLE_SIZE(fmt)\
3018 (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt))
3019 /* This is the size of the sample data for one sample. If the image is
3020 * color-mapped it is the size of one color-map entry (and image pixels are
3021 * one byte in size), otherwise it is the size of one image pixel.
3022 */
3023
3024#define PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)\
3025 (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * 256)
3026 /* The maximum size of the color-map required by the format expressed in a
3027 * count of components. This can be used to compile-time allocate a
3028 * color-map:
3029 *
3030 * png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)];
3031 *
3032 * png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)];
3033 *
3034 * Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the
3035 * information from one of the png_image_begin_read_ APIs and dynamically
3036 * allocate the required memory.
3037 */
3038
3039/* Corresponding information about the pixels */
3040#define PNG_IMAGE_PIXEL_(test,fmt)\
3041 (((fmt)&PNG_FORMAT_FLAG_COLORMAP)?1:test(fmt))
3042
3043#define PNG_IMAGE_PIXEL_CHANNELS(fmt)\
3044 PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_CHANNELS,fmt)
3045 /* The number of separate channels (components) in a pixel; 1 for a
3046 * color-mapped image.
3047 */
3048
3049#define PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)\
3050 PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_COMPONENT_SIZE,fmt)
3051 /* The size, in bytes, of each component in a pixel; 1 for a color-mapped
3052 * image.
3053 */
3054
3055#define PNG_IMAGE_PIXEL_SIZE(fmt) PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_SIZE,fmt)
3056 /* The size, in bytes, of a complete pixel; 1 for a color-mapped image. */
3057
3058/* Information about the whole row, or whole image */
John Bowler7875d532011-11-07 22:33:49 -06003059#define PNG_IMAGE_ROW_STRIDE(image)\
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003060 (PNG_IMAGE_PIXEL_CHANNELS((image).format) * (image).width)
John Bowler7875d532011-11-07 22:33:49 -06003061 /* Return the total number of components in a single row of the image; this
3062 * is the minimum 'row stride', the minimum count of components between each
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003063 * row. For a color-mapped image this is the minimum number of bytes in a
Glenn Randers-Pehrsone0a6c062011-11-07 23:50:05 -06003064 * row.
3065 */
John Bowler7875d532011-11-07 22:33:49 -06003066
3067#define PNG_IMAGE_BUFFER_SIZE(image, row_stride)\
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003068 (PNG_IMAGE_PIXEL_COMPONENT_SIZE((image).format)*(image).height*(row_stride))
John Bowler7875d532011-11-07 22:33:49 -06003069 /* Return the size, in bytes, of an image buffer given a png_image and a row
Glenn Randers-Pehrsone0a6c062011-11-07 23:50:05 -06003070 * stride - the number of components to leave space for in each row.
3071 */
John Bowler7875d532011-11-07 22:33:49 -06003072
John Bowler3706d732011-11-21 10:28:06 -06003073#define PNG_IMAGE_SIZE(image)\
3074 PNG_IMAGE_BUFFER_SIZE(image, PNG_IMAGE_ROW_STRIDE(image))
3075 /* Return the size, in bytes, of the image in memory given just a png_image;
3076 * the row stride is the minimum stride required for the image.
3077 */
3078
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003079#define PNG_IMAGE_COLORMAP_SIZE(image)\
3080 (PNG_IMAGE_SAMPLE_SIZE((image).format) * (image).colormap_entries)
3081 /* Return the size, in bytes, of the color-map of this image. If the image
3082 * format is not a color-map format this will return a size sufficient for
3083 * 256 entries in the given format; check PNG_FORMAT_FLAG_COLORMAP if
3084 * you don't want to allocate a color-map in this case.
3085 */
3086
John Bowler7875d532011-11-07 22:33:49 -06003087/* PNG_IMAGE_FLAG_*
3088 *
3089 * Flags containing additional information about the image are held in the
3090 * 'flags' field of png_image.
3091 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003092#define PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB 0x01
John Bowler7875d532011-11-07 22:33:49 -06003093 /* This indicates the the RGB values of the in-memory bitmap do not
3094 * correspond to the red, green and blue end-points defined by sRGB.
3095 */
3096
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003097#define PNG_IMAGE_FLAG_FAST 0x02
3098 /* On write emphasise speed over compression; the resultant PNG file will be
3099 * larger but will be produced significantly faster, particular for large
3100 * images. Do not use this option for images which will be distributed, only
3101 * used it when producing intermediate files that will be read back in
3102 * repeatedly. For a typical 24-bit image the option will double the read
3103 * speed at the cost of increasing the image size by 25%, however for many
3104 * more compressible images the PNG file can be 10 times larger with only a
3105 * slight speed gain.
3106 */
3107
John Bowler59ae3892013-03-06 22:15:25 -06003108#define PNG_IMAGE_FLAG_16BIT_sRGB 0x04
3109 /* On read if the image is a 16-bit per component image and there is no gAMA
3110 * or sRGB chunk assume that the components are sRGB encoded. Notice that
3111 * images output by the simplified API always have gamma information; setting
3112 * this flag only affects the interpretation of 16-bit images from an
3113 * external source. It is recommended that the application expose this flag
3114 * to the user; the user can normally easily recognize the difference between
3115 * linear and sRGB encoding. This flag has no effect on write - the data
3116 * passed to the write APIs must have the correct encoding (as defined
3117 * above.)
3118 *
3119 * If the flag is not set (the default) input 16-bit per component data is
3120 * assumed to be linear.
3121 *
3122 * NOTE: the flag can only be set after the png_image_begin_read_ call,
3123 * because that call initializes the 'flags' field.
3124 */
3125
John Bowler7875d532011-11-07 22:33:49 -06003126#ifdef PNG_SIMPLIFIED_READ_SUPPORTED
3127/* READ APIs
3128 * ---------
3129 *
3130 * The png_image passed to the read APIs must have been initialized by setting
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003131 * the png_controlp field 'opaque' to NULL (or, safer, memset the whole thing.)
John Bowler7875d532011-11-07 22:33:49 -06003132 */
3133#ifdef PNG_STDIO_SUPPORTED
3134PNG_EXPORT(234, int, png_image_begin_read_from_file, (png_imagep image,
3135 const char *file_name));
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06003136 /* The named file is opened for read and the image header is filled in
3137 * from the PNG header in the file.
Glenn Randers-Pehrsone0a6c062011-11-07 23:50:05 -06003138 */
John Bowler7875d532011-11-07 22:33:49 -06003139
3140PNG_EXPORT(235, int, png_image_begin_read_from_stdio, (png_imagep image,
3141 FILE* file));
3142 /* The PNG header is read from the stdio FILE object. */
3143#endif /* PNG_STDIO_SUPPORTED */
3144
3145PNG_EXPORT(236, int, png_image_begin_read_from_memory, (png_imagep image,
3146 png_const_voidp memory, png_size_t size));
3147 /* The PNG header is read from the given memory buffer. */
3148
3149PNG_EXPORT(237, int, png_image_finish_read, (png_imagep image,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003150 png_const_colorp background, void *buffer, png_int_32 row_stride,
3151 void *colormap));
John Bowler7875d532011-11-07 22:33:49 -06003152 /* Finish reading the image into the supplied buffer and clean up the
3153 * png_image structure.
3154 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003155 * row_stride is the step, in byte or 2-byte units as appropriate,
John Bowler7875d532011-11-07 22:33:49 -06003156 * between adjacent rows. A positive stride indicates that the top-most row
3157 * is first in the buffer - the normal top-down arrangement. A negative
3158 * stride indicates that the bottom-most row is first in the buffer.
3159 *
3160 * background need only be supplied if an alpha channel must be removed from
3161 * a png_byte format and the removal is to be done by compositing on a solid
3162 * color; otherwise it may be NULL and any composition will be done directly
3163 * onto the buffer. The value is an sRGB color to use for the background,
3164 * for grayscale output the green channel is used.
3165 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003166 * background must be supplied when an alpha channel must be removed from a
3167 * single byte color-mapped output format, in other words if:
3168 *
3169 * 1) The original format from png_image_begin_read_from_* had
3170 * PNG_FORMAT_FLAG_ALPHA set.
3171 * 2) The format set by the application does not.
3172 * 3) The format set by the application has PNG_FORMAT_FLAG_COLORMAP set and
3173 * PNG_FORMAT_FLAG_LINEAR *not* set.
3174 *
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06003175 * For linear output removing the alpha channel is always done by compositing
John Bowler59ae3892013-03-06 22:15:25 -06003176 * on black and background is ignored.
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003177 *
3178 * colormap must be supplied when PNG_FORMAT_FLAG_COLORMAP is set. It must
3179 * be at least the size (in bytes) returned by PNG_IMAGE_COLORMAP_SIZE.
3180 * image->colormap_entries will be updated to the actual number of entries
3181 * written to the colormap; this may be less than the original value.
John Bowler7875d532011-11-07 22:33:49 -06003182 */
3183
3184PNG_EXPORT(238, void, png_image_free, (png_imagep image));
3185 /* Free any data allocated by libpng in image->opaque, setting the pointer to
Glenn Randers-Pehrsone0a6c062011-11-07 23:50:05 -06003186 * NULL. May be called at any time after the structure is initialized.
3187 */
John Bowler7875d532011-11-07 22:33:49 -06003188#endif /* PNG_SIMPLIFIED_READ_SUPPORTED */
3189
3190#ifdef PNG_SIMPLIFIED_WRITE_SUPPORTED
Glenn Randers-Pehrson4a431822013-06-05 23:41:49 -05003191#ifdef PNG_STDIO_SUPPORTED
John Bowler7875d532011-11-07 22:33:49 -06003192/* WRITE APIS
3193 * ----------
3194 * For write you must initialize a png_image structure to describe the image to
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003195 * be written. To do this use memset to set the whole structure to 0 then
3196 * initialize fields describing your image.
John Bowler7875d532011-11-07 22:33:49 -06003197 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003198 * version: must be set to PNG_IMAGE_VERSION
John Bowler7875d532011-11-07 22:33:49 -06003199 * opaque: must be initialized to NULL
3200 * width: image width in pixels
3201 * height: image height in rows
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003202 * format: the format of the data (image and color-map) you wish to write
John Bowler7875d532011-11-07 22:33:49 -06003203 * flags: set to 0 unless one of the defined flags applies; set
3204 * PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images where the RGB
3205 * values do not correspond to the colors in sRGB.
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003206 * colormap_entries: set to the number of entries in the color-map (0 to 256)
John Bowler7875d532011-11-07 22:33:49 -06003207 */
3208PNG_EXPORT(239, int, png_image_write_to_file, (png_imagep image,
3209 const char *file, int convert_to_8bit, const void *buffer,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003210 png_int_32 row_stride, const void *colormap));
John Bowler7875d532011-11-07 22:33:49 -06003211 /* Write the image to the named file. */
3212
3213PNG_EXPORT(240, int, png_image_write_to_stdio, (png_imagep image, FILE *file,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003214 int convert_to_8_bit, const void *buffer, png_int_32 row_stride,
3215 const void *colormap));
John Bowler7875d532011-11-07 22:33:49 -06003216 /* Write the image to the given (FILE*). */
3217
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003218/* With both write APIs if image is in one of the linear formats with 16-bit
3219 * data then setting convert_to_8_bit will cause the output to be an 8-bit PNG
3220 * gamma encoded according to the sRGB specification, otherwise a 16-bit linear
3221 * encoded PNG file is written.
3222 *
3223 * With color-mapped data formats the colormap parameter point to a color-map
3224 * with at least image->colormap_entries encoded in the specified format. If
3225 * the format is linear the written PNG color-map will be converted to sRGB
3226 * regardless of the convert_to_8_bit flag.
John Bowler7875d532011-11-07 22:33:49 -06003227 *
3228 * With all APIs row_stride is handled as in the read APIs - it is the spacing
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003229 * from one row to the next in component sized units (1 or 2 bytes) and if
3230 * negative indicates a bottom-up row layout in the buffer.
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06003231 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003232 * Note that the write API does not support interlacing or sub-8-bit pixels.
John Bowler7875d532011-11-07 22:33:49 -06003233 */
Glenn Randers-Pehrson4a431822013-06-05 23:41:49 -05003234#endif /* PNG_STDIO_SUPPORTED */
John Bowler7875d532011-11-07 22:33:49 -06003235#endif /* PNG_SIMPLIFIED_WRITE_SUPPORTED */
3236/*******************************************************************************
3237 * END OF SIMPLIFIED API
3238 ******************************************************************************/
3239
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003240#ifdef PNG_CHECK_FOR_INVALID_INDEX_SUPPORTED
3241PNG_EXPORT(242, void, png_set_check_for_invalid_index,
3242 (png_structrp png_ptr, int allowed));
3243# ifdef PNG_GET_PALETTE_MAX_SUPPORTED
3244PNG_EXPORT(243, int, png_get_palette_max, (png_const_structp png_ptr,
3245 png_const_infop info_ptr));
3246# endif
3247#endif /* CHECK_FOR_INVALID_INDEX */
3248
John Bowlerf3728102013-03-04 16:26:31 -06003249/*******************************************************************************
3250 * IMPLEMENTATION OPTIONS
3251 *******************************************************************************
3252 *
3253 * Support for arbitrary implementation-specific optimizations. The API allows
3254 * particular options to be turned on or off. 'Option' is the number of the
3255 * option and 'onoff' is 0 (off) or non-0 (on). The value returned is given
3256 * by the PNG_OPTION_ defines below.
3257 *
3258 * HARDWARE: normally hardware capabilites, such as the Intel SSE instructions,
3259 * are detected at run time, however sometimes it may be impossible
3260 * to do this in user mode, in which case it is necessary to discover
3261 * the capabilities in an OS specific way. Such capabilities are
3262 * listed here when libpng has support for them and must be turned
3263 * ON by the application if present.
3264 *
3265 * SOFTWARE: sometimes software optimizations actually result in performance
3266 * decrease on some architectures or systems, or with some sets of
3267 * PNG images. 'Software' options allow such optimizations to be
3268 * selected at run time.
3269 */
3270#ifdef PNG_SET_OPTION_SUPPORTED
3271#ifdef PNG_ARM_NEON_API_SUPPORTED
3272# define PNG_ARM_NEON 0 /* HARDWARE: ARM Neon SIMD instructions supported */
3273#endif
John Bowler0c7ac062013-05-07 21:59:05 -05003274#define PNG_MAXIMUM_INFLATE_WINDOW 2 /* SOFTWARE: force maximum window */
3275#define PNG_OPTION_NEXT 4 /* Next option - numbers must be even */
John Bowlerf3728102013-03-04 16:26:31 -06003276
3277/* Return values: NOTE: there are four values and 'off' is *not* zero */
3278#define PNG_OPTION_UNSET 0 /* Unset - defaults to off */
3279#define PNG_OPTION_INVALID 1 /* Option number out of range */
3280#define PNG_OPTION_OFF 2
3281#define PNG_OPTION_ON 3
3282
3283PNG_EXPORT(244, int, png_set_option, (png_structrp png_ptr, int option,
3284 int onoff));
3285#endif
3286
3287/*******************************************************************************
3288 * END OF HARDWARE OPTIONS
3289 ******************************************************************************/
3290
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05003291/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003292 * defs, scripts/pnglibconf.h, and scripts/pnglibconf.h.prebuilt
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05003293 */
3294
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06003295/* The last ordinal number (this is the *last* one already used; the next
John Bowler71a10f22011-01-22 17:03:33 -06003296 * one to use is one more than this.) Maintainer, remember to add an entry to
3297 * scripts/symbols.def as well.
Glenn Randers-Pehrsonc551c0d2010-03-16 07:52:34 -05003298 */
3299#ifdef PNG_EXPORT_LAST_ORDINAL
John Bowlerf3728102013-03-04 16:26:31 -06003300 PNG_EXPORT_LAST_ORDINAL(244);
Glenn Randers-Pehrsonc551c0d2010-03-16 07:52:34 -05003301#endif
3302
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06003303#ifdef __cplusplus
3304}
3305#endif
3306
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05003307#endif /* PNG_VERSION_INFO_ONLY */
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05003308/* Do not put anything past this line */
Glenn Randers-Pehrson13944802000-06-24 07:42:42 -05003309#endif /* PNG_H */