blob: ef94f1f63640e93e9bef5f665654fed73e8cfa5a [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-Pehrson71d23c42014-03-06 19:52:04 -06004 * libpng version 1.6.11beta01 - March 7, 2014
Glenn Randers-Pehrson9eec1592014-02-09 12:49:39 -06005 * Copyright (c) 1998-2014 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-Pehrson71d23c42014-03-06 19:52:04 -060014 * libpng versions 0.97, January 1998, through 1.6.11beta01 - March 7, 2014: 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-Pehrson847e9ef2013-07-17 19:03:02 -0500180 * 1.6.3 16 10603 16.so.16.3[.0]
Glenn Randers-Pehrsond42dc542013-09-05 15:11:27 -0500181 * 1.6.4beta01-02 16 10604 16.so.16.4[.0]
182 * 1.6.4rc01 16 10604 16.so.16.4[.0]
Glenn Randers-Pehrson209d3eb2013-09-11 21:28:37 -0500183 * 1.6.4 16 10604 16.so.16.4[.0]
Glenn Randers-Pehrson53ae7dc2013-09-14 07:18:49 -0500184 * 1.6.5 16 10605 16.so.16.5[.0]
Glenn Randers-Pehrson39145942013-09-16 10:33:47 -0500185 * 1.6.6 16 10606 16.so.16.6[.0]
Glenn Randers-Pehrsond2d09e52013-11-02 15:41:20 -0500186 * 1.6.7beta01-04 16 10607 16.so.16.7[.0]
Glenn Randers-Pehrsonf2b89612013-11-14 12:56:50 -0600187 * 1.6.7rc01-03 16 10607 16.so.16.7[.0]
Glenn Randers-Pehrson6a3805c2013-11-14 13:16:21 -0600188 * 1.6.7 16 10607 16.so.16.7[.0]
Glenn Randers-Pehrsonb6f0a642013-12-11 22:49:52 -0600189 * 1.6.8beta01-02 16 10608 16.so.16.8[.0]
Glenn Randers-Pehrsonbe3977d2013-12-19 09:04:52 -0600190 * 1.6.8rc01-02 16 10608 16.so.16.8[.0]
191 * 1.6.8 16 10608 16.so.16.8[.0]
Glenn Randers-Pehrsonbb6e0a22014-01-10 08:19:20 -0600192 * 1.6.9beta01-04 16 10609 16.so.16.9[.0]
Glenn Randers-Pehrson8c120782014-01-30 14:56:45 -0600193 * 1.6.9rc01-02 16 10609 16.so.16.9[.0]
Glenn Randers-Pehrson3e753eb2014-02-05 22:28:57 -0600194 * 1.6.9 16 10609 16.so.16.9[.0]
Glenn Randers-Pehrson53c60fa2014-02-27 08:31:40 -0600195 * 1.6.10beta01-03 16 10610 16.so.16.10[.0]
Glenn Randers-Pehrson71d23c42014-03-06 19:52:04 -0600196 * 1.6.10rc01-03 16 10610 16.so.16.10[.0]
197 * 1.6.10 16 10610 16.so.16.10[.0]
198 * 1.6.11beta01 16 10611 16.so.16.11[.0]
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600199 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600200 * Henceforth the source version will match the shared-library major
201 * and minor numbers; the shared-library major version number will be
202 * used for changes in backward compatibility, as it is intended. The
203 * PNG_LIBPNG_VER macro, which is not used within libpng but is available
204 * for applications, is an unsigned integer of the form xyyzz corresponding
205 * to the source version x.y.z (leading zeros in y and z). Beta versions
206 * were given the previous public release number plus a letter, until
207 * version 1.0.6j; from then on they were given the upcoming public
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600208 * release number plus "betaNN" or "rcNN".
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600209 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600210 * Binary incompatibility exists only when applications make direct access
211 * to the info_ptr or png_ptr members through png.h, and the compiled
212 * application is loaded with a different version of the library.
Glenn Randers-Pehrson326320e2000-04-24 07:43:17 -0500213 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600214 * DLLNUM will change each time there are forward or backward changes
215 * in binary compatibility (e.g., when a new feature is added).
Glenn Randers-Pehrsonbe9de0f2001-01-22 08:52:16 -0600216 *
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500217 * See libpng-manual.txt or libpng.3 for more information. The PNG
218 * specification is available as a W3C Recommendation and as an ISO
219 * Specification, <http://www.w3.org/TR/2003/REC-PNG-20031110/
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600220 */
221
222/*
Glenn Randers-Pehrson68ea2432000-04-01 21:10:05 -0600223 * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
224 *
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500225 * If you modify libpng you may insert additional notices immediately following
226 * this sentence.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600227 *
Glenn Randers-Pehrsonbfbf8652009-06-26 21:46:52 -0500228 * This code is released under the libpng license.
229 *
Glenn Randers-Pehrson71d23c42014-03-06 19:52:04 -0600230 * libpng versions 1.2.6, August 15, 2004, through 1.6.11beta01, March 7, 2014, are
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600231 * Copyright (c) 2004, 2006-2013 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500232 * distributed according to the same disclaimer and license as libpng-1.2.5
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500233 * with the following individual added to the list of Contributing Authors:
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500234 *
235 * Cosmin Truta
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500236 *
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500237 * libpng versions 1.0.7, July 1, 2000, through 1.2.5, October 3, 2002, are
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500238 * Copyright (c) 2000-2002 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrson32fc5ce2000-07-24 06:34:14 -0500239 * distributed according to the same disclaimer and license as libpng-1.0.6
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500240 * with the following individuals added to the list of Contributing Authors:
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500241 *
242 * Simon-Pierre Cadieux
243 * Eric S. Raymond
244 * Gilles Vollant
245 *
Glenn Randers-Pehrson3d5a5202000-07-01 15:37:28 -0500246 * and with the following additions to the disclaimer:
247 *
248 * There is no warranty against interference with your enjoyment of the
249 * library or against infringement. There is no warranty that our
250 * efforts or the library will fulfill any of your particular purposes
251 * or needs. This library is provided with all faults, and the entire
252 * risk of satisfactory quality, performance, accuracy, and effort is with
253 * the user.
254 *
255 * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500256 * Copyright (c) 1998, 1999, 2000 Glenn Randers-Pehrson, and are
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600257 * distributed according to the same disclaimer and license as libpng-0.96,
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500258 * with the following individuals added to the list of Contributing Authors:
259 *
260 * Tom Lane
261 * Glenn Randers-Pehrson
262 * Willem van Schaik
263 *
264 * libpng versions 0.89, June 1996, through 0.96, May 1997, are
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600265 * Copyright (c) 1996, 1997 Andreas Dilger
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600266 * Distributed according to the same disclaimer and license as libpng-0.88,
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500267 * with the following individuals added to the list of Contributing Authors:
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600268 *
269 * John Bowler
270 * Kevin Bracey
271 * Sam Bushell
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600272 * Magnus Holmgren
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600273 * Greg Roelofs
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500274 * Tom Tanner
275 *
276 * libpng versions 0.5, May 1995, through 0.88, January 1996, are
277 * Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.
278 *
279 * For the purposes of this copyright and license, "Contributing Authors"
280 * is defined as the following set of individuals:
281 *
282 * Andreas Dilger
283 * Dave Martindale
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600284 * Guy Eric Schalnat
285 * Paul Schmidt
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600286 * Tim Wegner
287 *
288 * The PNG Reference Library is supplied "AS IS". The Contributing Authors
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600289 * and Group 42, Inc. disclaim all warranties, expressed or implied,
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600290 * including, without limitation, the warranties of merchantability and of
291 * fitness for any purpose. The Contributing Authors and Group 42, Inc.
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600292 * assume no liability for direct, indirect, incidental, special, exemplary,
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600293 * or consequential damages, which may result from the use of the PNG
294 * Reference Library, even if advised of the possibility of such damage.
295 *
296 * Permission is hereby granted to use, copy, modify, and distribute this
297 * source code, or portions hereof, for any purpose, without fee, subject
298 * to the following restrictions:
299 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600300 * 1. The origin of this source code must not be misrepresented.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600301 *
Glenn Randers-Pehrson53c07f52010-06-18 18:55:55 -0500302 * 2. Altered versions must be plainly marked as such and must not
303 * be misrepresented as being the original source.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600304 *
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600305 * 3. This Copyright notice may not be removed or altered from
306 * any source or altered source distribution.
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600307 *
308 * The Contributing Authors and Group 42, Inc. specifically permit, without
309 * fee, and encourage the use of this source code as a component to
310 * supporting the PNG file format in commercial products. If you use this
311 * source code in a product, acknowledgment is not required but would be
312 * appreciated.
313 */
314
315/*
316 * A "png_get_copyright" function is available, for convenient use in "about"
317 * boxes and the like:
318 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600319 * printf("%s", png_get_copyright(NULL));
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600320 *
321 * Also, the PNG logo (in PNG format, of course) is supplied in the
Glenn Randers-Pehrsona4d54bd2000-07-14 08:15:12 -0500322 * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600323 */
324
325/*
326 * Libpng is OSI Certified Open Source Software. OSI Certified is a
327 * certification mark of the Open Source Initiative.
328 */
329
330/*
331 * The contributing authors would like to thank all those who helped
332 * with testing, bug fixes, and patience. This wouldn't have been
333 * possible without all of you.
334 *
335 * Thanks to Frank J. T. Wojcik for helping with the documentation.
336 */
337
338/*
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600339 * Y2K compliance in libpng:
340 * =========================
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600341 *
Glenn Randers-Pehrson71d23c42014-03-06 19:52:04 -0600342 * March 7, 2014
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600343 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600344 * Since the PNG Development group is an ad-hoc body, we can't make
345 * an official declaration.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600346 *
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500347 * This is your unofficial assurance that libpng from version 0.71 and
Glenn Randers-Pehrson71d23c42014-03-06 19:52:04 -0600348 * upward through 1.6.11beta01 are Y2K compliant. It is my belief that
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500349 * earlier versions were also Y2K compliant.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600350 *
John Bowler88b77cc2011-05-05 06:49:55 -0500351 * Libpng only has two year fields. One is a 2-byte unsigned integer
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600352 * that will hold years up to 65535. The other, which is deprecated,
353 * holds the date in text format, and will hold years up to 9999.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600354 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600355 * The integer is
356 * "png_uint_16 year" in png_time_struct.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600357 *
John Bowler88b77cc2011-05-05 06:49:55 -0500358 * The string is
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600359 * "char time_buffer[29]" in png_struct. This is no longer used
360 * in libpng-1.6.x and will be removed from libpng-1.7.0.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600361 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600362 * There are seven time-related functions:
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600363 * png.c: png_convert_to_rfc_1123_buffer() in png.c
364 * (formerly png_convert_to_rfc_1123() prior to libpng-1.5.x and
365 * png_convert_to_rfc_1152() in error prior to libpng-0.98)
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600366 * png_convert_from_struct_tm() in pngwrite.c, called in pngwrite.c
367 * png_convert_from_time_t() in pngwrite.c
368 * png_get_tIME() in pngget.c
369 * png_handle_tIME() in pngrutil.c, called in pngread.c
370 * png_set_tIME() in pngset.c
371 * png_write_tIME() in pngwutil.c, called in pngwrite.c
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600372 *
373 * All handle dates properly in a Y2K environment. The
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600374 * png_convert_from_time_t() function calls gmtime() to convert from system
375 * clock time, which returns (year - 1900), which we properly convert to
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600376 * the full 4-digit year. There is a possibility that libpng applications
377 * are not passing 4-digit years into the png_convert_to_rfc_1123_buffer()
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500378 * function, or that they are incorrectly passing only a 2-digit year
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600379 * instead of "year - 1900" into the png_convert_from_struct_tm() function,
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500380 * but this is not under our control. The libpng documentation has always
381 * stated that it works with 4-digit years, and the APIs have been
382 * documented as such.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600383 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600384 * The tIME chunk itself is also Y2K compliant. It uses a 2-byte unsigned
385 * integer to hold the year, and can hold years as large as 65535.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600386 *
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500387 * zlib, upon which libpng depends, is also Y2K compliant. It contains
388 * no date-related code.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600389 *
Glenn Randers-Pehrson87544ac1999-01-13 22:06:39 -0600390 * Glenn Randers-Pehrson
391 * libpng maintainer
392 * PNG Development Group
Glenn Randers-Pehrsonbcfd15d1999-10-01 14:22:25 -0500393 */
394
Glenn Randers-Pehrson13944802000-06-24 07:42:42 -0500395#ifndef PNG_H
396#define PNG_H
Guy Schalnat0d580581995-07-20 02:43:20 -0500397
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500398/* This is not the place to learn how to use libpng. The file libpng-manual.txt
Andreas Dilger47a0c421997-05-16 02:46:07 -0500399 * describes how to use libpng, and the file example.c summarizes it
400 * with some code on which to build. This file is useful for looking
401 * at the actual function definitions and structure components.
John Bowler7875d532011-11-07 22:33:49 -0600402 *
403 * If you just need to read a PNG file and don't want to read the documentation
404 * skip to the end of this file and read the section entitled 'simplified API'.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500405 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500406
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500407/* Version information for png.h - this should match the version in png.c */
Glenn Randers-Pehrson71d23c42014-03-06 19:52:04 -0600408#define PNG_LIBPNG_VER_STRING "1.6.11beta01"
Glenn Randers-Pehrson5b5dcf82004-07-17 22:45:44 -0500409#define PNG_HEADER_VERSION_STRING \
Glenn Randers-Pehrson71d23c42014-03-06 19:52:04 -0600410 " libpng version 1.6.11beta01 - March 7, 2014\n"
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500411
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -0600412#define PNG_LIBPNG_VER_SONUM 16
413#define PNG_LIBPNG_VER_DLLNUM 16
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500414
415/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */
416#define PNG_LIBPNG_VER_MAJOR 1
Glenn Randers-Pehrson87fadd52011-11-24 14:35:13 -0600417#define PNG_LIBPNG_VER_MINOR 6
Glenn Randers-Pehrson71d23c42014-03-06 19:52:04 -0600418#define PNG_LIBPNG_VER_RELEASE 11
Glenn Randers-Pehrson87fadd52011-11-24 14:35:13 -0600419
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500420/* This should match the numeric part of the final component of
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500421 * PNG_LIBPNG_VER_STRING, omitting any leading zero:
422 */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600423
Glenn Randers-Pehrson71d23c42014-03-06 19:52:04 -0600424#define PNG_LIBPNG_VER_BUILD 01
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600425
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600426/* Release Status */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600427#define PNG_LIBPNG_BUILD_ALPHA 1
428#define PNG_LIBPNG_BUILD_BETA 2
429#define PNG_LIBPNG_BUILD_RC 3
430#define PNG_LIBPNG_BUILD_STABLE 4
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600431#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500432
Glenn Randers-Pehrson40936072004-11-20 11:18:40 -0600433/* Release-Specific Flags */
434#define PNG_LIBPNG_BUILD_PATCH 8 /* Can be OR'ed with
435 PNG_LIBPNG_BUILD_STABLE only */
436#define PNG_LIBPNG_BUILD_PRIVATE 16 /* Cannot be OR'ed with
437 PNG_LIBPNG_BUILD_SPECIAL */
438#define PNG_LIBPNG_BUILD_SPECIAL 32 /* Cannot be OR'ed with
439 PNG_LIBPNG_BUILD_PRIVATE */
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500440
Glenn Randers-Pehrson71d23c42014-03-06 19:52:04 -0600441#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_BETA
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600442
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500443/* Careful here. At one time, Guy wanted to use 082, but that would be octal.
444 * We must not include leading zeros.
445 * Versions 0.7 through 1.0.0 were in the range 0 to 100 here (only
446 * version 1.0.0 was mis-numbered 100 instead of 10000). From
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500447 * version 1.0.1 it's xxyyzz, where x=major, y=minor, z=release
448 */
Glenn Randers-Pehrson71d23c42014-03-06 19:52:04 -0600449#define PNG_LIBPNG_VER 10611 /* 1.6.11 */
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -0500450
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500451/* Library configuration: these options cannot be changed after
452 * the library has been built.
453 */
454#ifndef PNGLCONF_H
Glenn Randers-Pehrson8c667862010-08-24 16:16:35 -0500455 /* If pnglibconf.h is missing, you can
456 * copy scripts/pnglibconf.h.prebuilt to pnglibconf.h
457 */
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500458# include "pnglibconf.h"
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600459#endif
Guy Schalnat0d580581995-07-20 02:43:20 -0500460
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500461#ifndef PNG_VERSION_INFO_ONLY
John Bowlerbaeb6d12011-11-26 18:21:02 -0600462 /* Machine specific configuration. */
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500463# include "pngconf.h"
464#endif
Guy Schalnat0d580581995-07-20 02:43:20 -0500465
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600466/*
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -0500467 * Added at libpng-1.2.8
468 *
469 * Ref MSDN: Private as priority over Special
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600470 * VS_FF_PRIVATEBUILD File *was not* built using standard release
471 * procedures. If this value is given, the StringFileInfo block must
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500472 * contain a PrivateBuild string.
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600473 *
474 * VS_FF_SPECIALBUILD File *was* built by the original company using
475 * standard release procedures but is a variation of the standard
476 * file of the same version number. If this value is given, the
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500477 * StringFileInfo block must contain a SpecialBuild string.
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600478 */
479
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500480#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600481# define PNG_LIBPNG_BUILD_TYPE \
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600482 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600483#else
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500484# ifdef PNG_LIBPNG_SPECIALBUILD
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600485# define PNG_LIBPNG_BUILD_TYPE \
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600486 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600487# else
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600488# define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600489# endif
490#endif
491
492#ifndef PNG_VERSION_INFO_ONLY
493
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500494/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
495#ifdef __cplusplus
496extern "C" {
497#endif /* __cplusplus */
498
Andreas Dilger47a0c421997-05-16 02:46:07 -0500499/* Version information for C files, stored in png.c. This had better match
500 * the version above.
501 */
Glenn Randers-Pehrson4c8f7262010-03-16 19:30:01 -0500502#define png_libpng_ver png_get_header_ver(NULL)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500503
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500504/* This file is arranged in several sections:
505 *
506 * 1. Any configuration options that can be specified by for the application
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500507 * code when it is built. (Build time configuration is in pnglibconf.h)
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500508 * 2. Type definitions (base types are defined in pngconf.h), structure
509 * definitions.
510 * 3. Exported library functions.
John Bowler7875d532011-11-07 22:33:49 -0600511 * 4. Simplified API.
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500512 *
513 * The library source code has additional files (principally pngpriv.h) that
514 * allow configuration of the library.
515 */
516/* Section 1: run time configuration
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500517 * See pnglibconf.h for build time configuration
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500518 *
519 * Run time configuration allows the application to choose between
520 * implementations of certain arithmetic APIs. The default is set
Glenn Randers-Pehrson98b4f002010-04-16 22:30:26 -0500521 * at build time and recorded in pnglibconf.h, but it is safe to
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500522 * override these (and only these) settings. Note that this won't
523 * change what the library does, only application code, and the
524 * settings can (and probably should) be made on a per-file basis
525 * by setting the #defines before including png.h
526 *
527 * Use macros to read integers from PNG data or use the exported
528 * functions?
529 * PNG_USE_READ_MACROS: use the macros (see below) Note that
530 * the macros evaluate their argument multiple times.
531 * PNG_NO_USE_READ_MACROS: call the relevant library function.
532 *
533 * Use the alternative algorithm for compositing alpha samples that
534 * does not use division?
535 * PNG_READ_COMPOSITE_NODIV_SUPPORTED: use the 'no division'
536 * algorithm.
537 * PNG_NO_READ_COMPOSITE_NODIV: use the 'division' algorithm.
538 *
539 * How to handle benign errors if PNG_ALLOW_BENIGN_ERRORS is
540 * false?
541 * PNG_ALLOW_BENIGN_ERRORS: map calls to the benign error
542 * APIs to png_warning.
543 * Otherwise the calls are mapped to png_error.
544 */
545
546/* Section 2: type definitions, including structures and compile time
547 * constants.
548 * See pngconf.h for base types that vary by machine/system
549 */
Glenn Randers-Pehrson88910f52010-10-16 20:38:45 -0500550
551/* This triggers a compiler error in png.c, if png.c and png.h
552 * do not agree upon the version number.
553 */
Glenn Randers-Pehrson71d23c42014-03-06 19:52:04 -0600554typedef char* png_libpng_version_1_6_11beta01;
Glenn Randers-Pehrson88910f52010-10-16 20:38:45 -0500555
John Bowler5d567862011-12-24 09:12:00 -0600556/* Basic control structions. Read libpng-manual.txt or libpng.3 for more info.
557 *
558 * png_struct is the cache of information used while reading or writing a single
559 * PNG file. One of these is always required, although the simplified API
560 * (below) hides the creation and destruction of it.
561 */
562typedef struct png_struct_def png_struct;
563typedef const png_struct * png_const_structp;
564typedef png_struct * png_structp;
565typedef png_struct * * png_structpp;
566
567/* png_info contains information read from or to be written to a PNG file. One
568 * or more of these must exist while reading or creating a PNG file. The
569 * information is not used by libpng during read but is used to control what
570 * gets written when a PNG file is created. "png_get_" function calls read
571 * information during read and "png_set_" functions calls write information
572 * when creating a PNG.
573 * been moved into a separate header file that is not accessible to
574 * applications. Read libpng-manual.txt or libpng.3 for more info.
575 */
576typedef struct png_info_def png_info;
577typedef png_info * png_infop;
578typedef const png_info * png_const_infop;
579typedef png_info * * png_infopp;
580
581/* Types with names ending 'p' are pointer types. The corresponding types with
582 * names ending 'rp' are identical pointer types except that the pointer is
583 * marked 'restrict', which means that it is the only pointer to the object
584 * passed to the function. Applications should not use the 'restrict' types;
585 * it is always valid to pass 'p' to a pointer with a function argument of the
586 * corresponding 'rp' type. Different compilers have different rules with
587 * regard to type matching in the presence of 'restrict'. For backward
588 * compatibility libpng callbacks never have 'restrict' in their parameters and,
589 * consequentially, writing portable application code is extremely difficult if
590 * an attempt is made to use 'restrict'.
591 */
592typedef png_struct * PNG_RESTRICT png_structrp;
593typedef const png_struct * PNG_RESTRICT png_const_structrp;
594typedef png_info * PNG_RESTRICT png_inforp;
595typedef const png_info * PNG_RESTRICT png_const_inforp;
596
Andreas Dilger47a0c421997-05-16 02:46:07 -0500597/* Three color definitions. The order of the red, green, and blue, (and the
598 * exact size) is not important, although the size of the fields need to
599 * be png_byte or png_uint_16 (as defined below).
600 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500601typedef struct png_color_struct
602{
Guy Schalnat4ee97b01996-01-16 01:51:56 -0600603 png_byte red;
Guy Schalnat0d580581995-07-20 02:43:20 -0500604 png_byte green;
605 png_byte blue;
606} png_color;
John Bowlerbaeb6d12011-11-26 18:21:02 -0600607typedef png_color * png_colorp;
608typedef const png_color * png_const_colorp;
609typedef png_color * * png_colorpp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500610
611typedef struct png_color_16_struct
612{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500613 png_byte index; /* used for palette files */
614 png_uint_16 red; /* for use in red green blue files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500615 png_uint_16 green;
616 png_uint_16 blue;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500617 png_uint_16 gray; /* for use in grayscale files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500618} png_color_16;
John Bowlerbaeb6d12011-11-26 18:21:02 -0600619typedef png_color_16 * png_color_16p;
620typedef const png_color_16 * png_const_color_16p;
621typedef png_color_16 * * png_color_16pp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500622
623typedef struct png_color_8_struct
624{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500625 png_byte red; /* for use in red green blue files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500626 png_byte green;
627 png_byte blue;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500628 png_byte gray; /* for use in grayscale files */
Guy Schalnat0d580581995-07-20 02:43:20 -0500629 png_byte alpha; /* for alpha channel files */
630} png_color_8;
John Bowlerbaeb6d12011-11-26 18:21:02 -0600631typedef png_color_8 * png_color_8p;
632typedef const png_color_8 * png_const_color_8p;
633typedef png_color_8 * * png_color_8pp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500634
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600635/*
636 * The following two structures are used for the in-core representation
637 * of sPLT chunks.
638 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600639typedef struct png_sPLT_entry_struct
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600640{
641 png_uint_16 red;
642 png_uint_16 green;
643 png_uint_16 blue;
644 png_uint_16 alpha;
645 png_uint_16 frequency;
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600646} png_sPLT_entry;
John Bowlerbaeb6d12011-11-26 18:21:02 -0600647typedef png_sPLT_entry * png_sPLT_entryp;
648typedef const png_sPLT_entry * png_const_sPLT_entryp;
649typedef png_sPLT_entry * * png_sPLT_entrypp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600650
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500651/* When the depth of the sPLT palette is 8 bits, the color and alpha samples
652 * occupy the LSB of their respective members, and the MSB of each member
653 * is zero-filled. The frequency member always occupies the full 16 bits.
654 */
655
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600656typedef struct png_sPLT_struct
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600657{
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500658 png_charp name; /* palette name */
659 png_byte depth; /* depth of palette samples */
660 png_sPLT_entryp entries; /* palette entries */
661 png_int_32 nentries; /* number of palette entries */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600662} png_sPLT_t;
John Bowlerbaeb6d12011-11-26 18:21:02 -0600663typedef png_sPLT_t * png_sPLT_tp;
664typedef const png_sPLT_t * png_const_sPLT_tp;
665typedef png_sPLT_t * * png_sPLT_tpp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600666
667#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600668/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600669 * and whether that contents is compressed or not. The "key" field
Glenn Randers-Pehrson680da022011-11-21 17:05:41 -0600670 * points to a regular zero-terminated C string. The "text" fields can be a
671 * regular C string, an empty string, or a NULL pointer.
Glenn Randers-Pehrson140504b2011-06-15 08:10:13 -0500672 * However, the structure returned by png_get_text() will always contain
Glenn Randers-Pehrson680da022011-11-21 17:05:41 -0600673 * the "text" field as a regular zero-terminated C string (possibly
674 * empty), never a NULL pointer, so it can be safely used in printf() and
675 * other string-handling functions. Note that the "itxt_length", "lang", and
676 * "lang_key" members of the structure only exist when the library is built
677 * with iTXt chunk support. Prior to libpng-1.4.0 the library was built by
678 * default without iTXt support. Also note that when iTXt *is* supported,
679 * the "lang" and "lang_key" fields contain NULL pointers when the
680 * "compression" field contains * PNG_TEXT_COMPRESSION_NONE or
Glenn Randers-Pehrson12fb29f2011-11-22 11:53:49 -0600681 * PNG_TEXT_COMPRESSION_zTXt. Note that the "compression value" is not the
682 * same as what appears in the PNG tEXt/zTXt/iTXt chunk's "compression flag"
683 * which is always 0 or 1, or its "compression method" which is always 0.
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500684 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500685typedef struct png_text_struct
686{
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500687 int compression; /* compression value:
688 -1: tEXt, none
689 0: zTXt, deflate
690 1: iTXt, none
691 2: iTXt, deflate */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500692 png_charp key; /* keyword, 1-79 character description of "text" */
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500693 png_charp text; /* comment, may be an empty string (ie "")
694 or a NULL pointer */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600695 png_size_t text_length; /* length of the text string */
696 png_size_t itxt_length; /* length of the itxt string */
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500697 png_charp lang; /* language code, 0-79 characters
698 or a NULL pointer */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600699 png_charp lang_key; /* keyword translated UTF-8 string, 0 or more
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -0500700 chars or a NULL pointer */
Guy Schalnat0d580581995-07-20 02:43:20 -0500701} png_text;
John Bowlerbaeb6d12011-11-26 18:21:02 -0600702typedef png_text * png_textp;
703typedef const png_text * png_const_textp;
704typedef png_text * * png_textpp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600705#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -0500706
707/* Supported compression types for text in PNG files (tEXt, and zTXt).
708 * The values of the PNG_TEXT_COMPRESSION_ defines should NOT be changed. */
709#define PNG_TEXT_COMPRESSION_NONE_WR -3
710#define PNG_TEXT_COMPRESSION_zTXt_WR -2
711#define PNG_TEXT_COMPRESSION_NONE -1
712#define PNG_TEXT_COMPRESSION_zTXt 0
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600713#define PNG_ITXT_COMPRESSION_NONE 1
714#define PNG_ITXT_COMPRESSION_zTXt 2
715#define PNG_TEXT_COMPRESSION_LAST 3 /* Not a valid value */
Guy Schalnat0d580581995-07-20 02:43:20 -0500716
717/* png_time is a way to hold the time in an machine independent way.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600718 * Two conversions are provided, both from time_t and struct tm. There
719 * is no portable way to convert to either of these structures, as far
720 * 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 -0600721 * note - PNG has always been Year 2000 compliant!
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600722 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500723typedef struct png_time_struct
724{
725 png_uint_16 year; /* full year, as in, 1995 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500726 png_byte month; /* month of year, 1 - 12 */
727 png_byte day; /* day of month, 1 - 31 */
728 png_byte hour; /* hour of day, 0 - 23 */
729 png_byte minute; /* minute of hour, 0 - 59 */
730 png_byte second; /* second of minute, 0 - 60 (for leap seconds) */
Guy Schalnat0d580581995-07-20 02:43:20 -0500731} png_time;
John Bowlerbaeb6d12011-11-26 18:21:02 -0600732typedef png_time * png_timep;
733typedef const png_time * png_const_timep;
734typedef png_time * * png_timepp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500735
Glenn Randers-Pehrsonb3721752013-09-30 13:56:44 -0500736#if defined(PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED) ||\
737 defined(PNG_USER_CHUNKS_SUPPORTED)
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600738/* png_unknown_chunk is a structure to hold queued chunks for which there is
739 * no specific support. The idea is that we can use this to queue
740 * up private chunks for output even though the library doesn't actually
741 * know about their semantics.
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600742 *
743 * The data in the structure is set by libpng on read and used on write.
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600744 */
745typedef struct png_unknown_chunk_t
746{
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600747 png_byte name[5]; /* Textual chunk name with '\0' terminator */
748 png_byte *data; /* Data, should not be modified on read! */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600749 png_size_t size;
750
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600751 /* On write 'location' must be set using the flag values listed below.
752 * Notice that on read it is set by libpng however the values stored have
753 * more bits set than are listed below. Always treat the value as a
754 * bitmask. On write set only one bit - setting multiple bits may cause the
755 * chunk to be written in multiple places.
756 */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600757 png_byte location; /* mode of operation at read time */
758}
759png_unknown_chunk;
John Bowler40b26032011-12-22 08:09:15 -0600760
John Bowlerbaeb6d12011-11-26 18:21:02 -0600761typedef png_unknown_chunk * png_unknown_chunkp;
762typedef const png_unknown_chunk * png_const_unknown_chunkp;
763typedef png_unknown_chunk * * png_unknown_chunkpp;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600764#endif
765
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600766/* Flag values for the unknown chunk location byte. */
Glenn Randers-Pehrsonfd73d042011-06-13 13:25:21 -0500767#define PNG_HAVE_IHDR 0x01
768#define PNG_HAVE_PLTE 0x02
769#define PNG_AFTER_IDAT 0x08
Glenn Randers-Pehrson2d3fc1c2011-05-10 23:48:00 -0500770
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500771/* Maximum positive integer used in PNG is (2^31)-1 */
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500772#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
Glenn Randers-Pehrson78067772004-11-02 21:49:39 -0600773#define PNG_UINT_32_MAX ((png_uint_32)(-1))
774#define PNG_SIZE_MAX ((png_size_t)(-1))
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500775
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500776/* These are constants for fixed point values encoded in the
777 * PNG specification manner (x100000)
778 */
779#define PNG_FP_1 100000
780#define PNG_FP_HALF 50000
John Bowlerd273ad22011-05-07 21:00:28 -0500781#define PNG_FP_MAX ((png_fixed_point)0x7fffffffL)
782#define PNG_FP_MIN (-PNG_FP_MAX)
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500783
Andreas Dilger47a0c421997-05-16 02:46:07 -0500784/* These describe the color_type field in png_info. */
Guy Schalnat0d580581995-07-20 02:43:20 -0500785/* color type masks */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500786#define PNG_COLOR_MASK_PALETTE 1
787#define PNG_COLOR_MASK_COLOR 2
788#define PNG_COLOR_MASK_ALPHA 4
Guy Schalnat0d580581995-07-20 02:43:20 -0500789
790/* color types. Note that not all combinations are legal */
Guy Schalnate5a37791996-06-05 15:50:50 -0500791#define PNG_COLOR_TYPE_GRAY 0
Andreas Dilger47a0c421997-05-16 02:46:07 -0500792#define PNG_COLOR_TYPE_PALETTE (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE)
793#define PNG_COLOR_TYPE_RGB (PNG_COLOR_MASK_COLOR)
794#define PNG_COLOR_TYPE_RGB_ALPHA (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA)
Guy Schalnat0d580581995-07-20 02:43:20 -0500795#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600796/* aliases */
797#define PNG_COLOR_TYPE_RGBA PNG_COLOR_TYPE_RGB_ALPHA
798#define PNG_COLOR_TYPE_GA PNG_COLOR_TYPE_GRAY_ALPHA
Guy Schalnat0d580581995-07-20 02:43:20 -0500799
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500800/* This is for compression type. PNG 1.0-1.2 only define the single type. */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500801#define PNG_COMPRESSION_TYPE_BASE 0 /* Deflate method 8, 32K window */
802#define PNG_COMPRESSION_TYPE_DEFAULT PNG_COMPRESSION_TYPE_BASE
803
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500804/* This is for filter type. PNG 1.0-1.2 only define the single type. */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500805#define PNG_FILTER_TYPE_BASE 0 /* Single row per-byte filtering */
Glenn Randers-Pehrson2ad31ae2000-12-15 08:54:42 -0600806#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500807#define PNG_FILTER_TYPE_DEFAULT PNG_FILTER_TYPE_BASE
808
809/* These are for the interlacing type. These values should NOT be changed. */
810#define PNG_INTERLACE_NONE 0 /* Non-interlaced image */
811#define PNG_INTERLACE_ADAM7 1 /* Adam7 interlacing */
812#define PNG_INTERLACE_LAST 2 /* Not a valid value */
813
814/* These are for the oFFs chunk. These values should NOT be changed. */
815#define PNG_OFFSET_PIXEL 0 /* Offset in pixels */
816#define PNG_OFFSET_MICROMETER 1 /* Offset in micrometers (1/10^6 meter) */
817#define PNG_OFFSET_LAST 2 /* Not a valid value */
818
819/* These are for the pCAL chunk. These values should NOT be changed. */
820#define PNG_EQUATION_LINEAR 0 /* Linear transformation */
821#define PNG_EQUATION_BASE_E 1 /* Exponential base e transform */
822#define PNG_EQUATION_ARBITRARY 2 /* Arbitrary base exponential transform */
823#define PNG_EQUATION_HYPERBOLIC 3 /* Hyperbolic sine transformation */
824#define PNG_EQUATION_LAST 4 /* Not a valid value */
825
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600826/* These are for the sCAL chunk. These values should NOT be changed. */
827#define PNG_SCALE_UNKNOWN 0 /* unknown unit (image scale) */
828#define PNG_SCALE_METER 1 /* meters per pixel */
829#define PNG_SCALE_RADIAN 2 /* radians per pixel */
830#define PNG_SCALE_LAST 3 /* Not a valid value */
831
Andreas Dilger47a0c421997-05-16 02:46:07 -0500832/* These are for the pHYs chunk. These values should NOT be changed. */
833#define PNG_RESOLUTION_UNKNOWN 0 /* pixels/unknown unit (aspect ratio) */
834#define PNG_RESOLUTION_METER 1 /* pixels/meter */
835#define PNG_RESOLUTION_LAST 2 /* Not a valid value */
836
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600837/* These are for the sRGB chunk. These values should NOT be changed. */
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600838#define PNG_sRGB_INTENT_PERCEPTUAL 0
839#define PNG_sRGB_INTENT_RELATIVE 1
840#define PNG_sRGB_INTENT_SATURATION 2
841#define PNG_sRGB_INTENT_ABSOLUTE 3
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600842#define PNG_sRGB_INTENT_LAST 4 /* Not a valid value */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600843
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600844/* This is for text chunks */
845#define PNG_KEYWORD_MAX_LENGTH 79
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600846
Glenn Randers-Pehrson76e5fd62000-12-28 07:50:05 -0600847/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
Glenn Randers-Pehrsond1e8c862002-06-20 06:54:34 -0500848#define PNG_MAX_PALETTE_LENGTH 256
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600849
Andreas Dilger47a0c421997-05-16 02:46:07 -0500850/* These determine if an ancillary chunk's data has been successfully read
851 * from the PNG header, or if the application has filled in the corresponding
852 * data in the info_struct to be written into the output file. The values
853 * of the PNG_INFO_<chunk> defines should NOT be changed.
854 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500855#define PNG_INFO_gAMA 0x0001
856#define PNG_INFO_sBIT 0x0002
857#define PNG_INFO_cHRM 0x0004
858#define PNG_INFO_PLTE 0x0008
859#define PNG_INFO_tRNS 0x0010
860#define PNG_INFO_bKGD 0x0020
861#define PNG_INFO_hIST 0x0040
862#define PNG_INFO_pHYs 0x0080
863#define PNG_INFO_oFFs 0x0100
864#define PNG_INFO_tIME 0x0200
Andreas Dilger47a0c421997-05-16 02:46:07 -0500865#define PNG_INFO_pCAL 0x0400
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600866#define PNG_INFO_sRGB 0x0800 /* GR-P, 0.96a */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600867#define PNG_INFO_iCCP 0x1000 /* ESR, 1.0.6 */
868#define PNG_INFO_sPLT 0x2000 /* ESR, 1.0.6 */
869#define PNG_INFO_sCAL 0x4000 /* ESR, 1.0.6 */
John Bowlerf3f7e142011-09-09 07:32:37 -0500870#define PNG_INFO_IDAT 0x8000 /* ESR, 1.0.6 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500871
Andreas Dilger47a0c421997-05-16 02:46:07 -0500872/* This is used for the transformation routines, as some of them
873 * change these values for the row. It also should enable using
874 * the routines for other purposes.
875 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500876typedef struct png_row_info_struct
877{
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -0600878 png_uint_32 width; /* width of row */
879 png_size_t rowbytes; /* number of bytes in row */
880 png_byte color_type; /* color type of row */
881 png_byte bit_depth; /* bit depth of row */
882 png_byte channels; /* number of channels (1, 2, 3, or 4) */
Guy Schalnat4ee97b01996-01-16 01:51:56 -0600883 png_byte pixel_depth; /* bits per pixel (depth * channels) */
Guy Schalnat0d580581995-07-20 02:43:20 -0500884} png_row_info;
885
John Bowlerbaeb6d12011-11-26 18:21:02 -0600886typedef png_row_info * png_row_infop;
887typedef png_row_info * * png_row_infopp;
Guy Schalnat0f716451995-11-28 11:22:13 -0600888
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500889/* These are the function types for the I/O functions and for the functions
890 * that allow the user to override the default I/O functions with his or her
891 * own. The png_error_ptr type should match that of user-supplied warning
892 * and error functions, while the png_rw_ptr type should match that of the
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500893 * user read/write data functions. Note that the 'write' function must not
Glenn Randers-Pehrsonea2f7e02010-08-18 08:14:54 -0500894 * modify the buffer it is passed. The 'read' function, on the other hand, is
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -0500895 * expected to return the read data in the buffer.
Guy Schalnat0f716451995-11-28 11:22:13 -0600896 */
John Bowler9c693602011-02-12 08:58:21 -0600897typedef PNG_CALLBACK(void, *png_error_ptr, (png_structp, png_const_charp));
898typedef PNG_CALLBACK(void, *png_rw_ptr, (png_structp, png_bytep, png_size_t));
899typedef PNG_CALLBACK(void, *png_flush_ptr, (png_structp));
900typedef PNG_CALLBACK(void, *png_read_status_ptr, (png_structp, png_uint_32,
901 int));
902typedef PNG_CALLBACK(void, *png_write_status_ptr, (png_structp, png_uint_32,
903 int));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600904
Guy Schalnat69b14481996-01-10 02:56:49 -0600905#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
John Bowler9c693602011-02-12 08:58:21 -0600906typedef PNG_CALLBACK(void, *png_progressive_info_ptr, (png_structp, png_infop));
907typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop));
John Bowler9616ad92011-02-16 06:13:46 -0600908
909/* The following callback receives png_uint_32 row_number, int pass for the
910 * png_bytep data of the row. When transforming an interlaced image the
911 * row number is the row number within the sub-image of the interlace pass, so
912 * the value will increase to the height of the sub-image (not the full image)
913 * then reset to 0 for the next pass.
914 *
915 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
916 * find the output pixel (x,y) given an interlaced sub-image pixel
917 * (row,col,pass). (See below for these macros.)
918 */
John Bowler9c693602011-02-12 08:58:21 -0600919typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600920 png_uint_32, int));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600921#endif
Guy Schalnat6d764711995-12-19 03:22:19 -0600922
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600923#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -0500924 defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
John Bowler9c693602011-02-12 08:58:21 -0600925typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600926 png_bytep));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600927#endif
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600928
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500929#ifdef PNG_USER_CHUNKS_SUPPORTED
John Bowler9c693602011-02-12 08:58:21 -0600930typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600931 png_unknown_chunkp));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600932#endif
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -0500933#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600934/* not used anywhere */
935/* typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp)); */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600936#endif
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -0600937
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600938#ifdef PNG_SETJMP_SUPPORTED
John Bowlerb302c472011-04-15 06:37:34 -0500939/* This must match the function definition in <setjmp.h>, and the application
940 * must include this before png.h to obtain the definition of jmp_buf. The
941 * function is required to be PNG_NORETURN, but this is not checked. If the
942 * function does return the application will crash via an abort() or similar
943 * system level call.
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500944 *
John Bowlerb302c472011-04-15 06:37:34 -0500945 * If you get a warning here while building the library you may need to make
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -0500946 * changes to ensure that pnglibconf.h records the calling convention used by
947 * your compiler. This may be very difficult - try using a different compiler
948 * to build the library!
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600949 */
John Bowlerb302c472011-04-15 06:37:34 -0500950PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)), typedef);
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -0600951#endif
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600952
953/* Transform masks for the high-level interface */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600954#define PNG_TRANSFORM_IDENTITY 0x0000 /* read and write */
955#define PNG_TRANSFORM_STRIP_16 0x0001 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600956#define PNG_TRANSFORM_STRIP_ALPHA 0x0002 /* read only */
957#define PNG_TRANSFORM_PACKING 0x0004 /* read and write */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600958#define PNG_TRANSFORM_PACKSWAP 0x0008 /* read and write */
959#define PNG_TRANSFORM_EXPAND 0x0010 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600960#define PNG_TRANSFORM_INVERT_MONO 0x0020 /* read and write */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600961#define PNG_TRANSFORM_SHIFT 0x0040 /* read and write */
962#define PNG_TRANSFORM_BGR 0x0080 /* read and write */
963#define PNG_TRANSFORM_SWAP_ALPHA 0x0100 /* read and write */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600964#define PNG_TRANSFORM_SWAP_ENDIAN 0x0200 /* read and write */
Glenn Randers-Pehrsondb66d442000-06-23 21:38:16 -0500965#define PNG_TRANSFORM_INVERT_ALPHA 0x0400 /* read and write */
Glenn Randers-Pehrson99708d52009-06-29 17:30:00 -0500966#define PNG_TRANSFORM_STRIP_FILLER 0x0800 /* write only */
Glenn Randers-Pehrson1eb14e92008-12-10 07:14:45 -0600967/* Added to libpng-1.2.34 */
Glenn Randers-Pehrson0ffb71a2009-02-28 06:08:20 -0600968#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
Glenn Randers-Pehrson99708d52009-06-29 17:30:00 -0500969#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
970/* Added to libpng-1.4.0 */
971#define PNG_TRANSFORM_GRAY_TO_RGB 0x2000 /* read only */
Glenn Randers-Pehrsonef217b72011-06-15 12:58:27 -0500972/* Added to libpng-1.5.4 */
John Bowlera9b34192011-05-08 19:46:51 -0500973#define PNG_TRANSFORM_EXPAND_16 0x4000 /* read only */
Glenn Randers-Pehrsonab63dd02011-06-17 20:04:17 -0500974#define PNG_TRANSFORM_SCALE_16 0x8000 /* read only */
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600975
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600976/* Flags for MNG supported features */
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600977#define PNG_FLAG_MNG_EMPTY_PLTE 0x01
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600978#define PNG_FLAG_MNG_FILTER_64 0x04
Glenn Randers-Pehrson408b4212000-12-18 09:33:57 -0600979#define PNG_ALL_MNG_FEATURES 0x05
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600980
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600981/* NOTE: prior to 1.5 these functions had no 'API' style declaration,
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -0600982 * this allowed the zlib default functions to be used on Windows
983 * platforms. In 1.5 the zlib default malloc (which just calls malloc and
984 * ignores the first argument) should be completely compatible with the
985 * following.
986 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -0600987typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,
John Bowler9c693602011-02-12 08:58:21 -0600988 png_alloc_size_t));
989typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp));
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500990
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -0500991/* Section 3: exported functions
992 * Here are the function definitions most commonly used. This is not
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -0500993 * the place to find out how to use libpng. See libpng-manual.txt for the
Andreas Dilger47a0c421997-05-16 02:46:07 -0500994 * full explanation, see example.c for the summary. This just provides
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600995 * a simple one line description of the use of each function.
Glenn Randers-Pehrsona4517252010-12-06 08:54:55 -0600996 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -0600997 * The PNG_EXPORT() and PNG_EXPORTA() macros used below are defined in
998 * pngconf.h and in the *.dfn files in the scripts directory.
Glenn Randers-Pehrsona4517252010-12-06 08:54:55 -0600999 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001000 * PNG_EXPORT(ordinal, type, name, (args));
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001001 *
1002 * ordinal: ordinal that is used while building
1003 * *.def files. The ordinal value is only
1004 * relevant when preprocessing png.h with
1005 * the *.dfn files for building symbol table
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001006 * entries, and are removed by pngconf.h.
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001007 * type: return type of the function
1008 * name: function name
1009 * args: function arguments, with types
1010 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001011 * When we wish to append attributes to a function prototype we use
1012 * the PNG_EXPORTA() macro instead.
1013 *
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001014 * PNG_EXPORTA(ordinal, type, name, (args), attributes);
1015 *
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001016 * ordinal, type, name, and args: same as in PNG_EXPORT().
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001017 * attributes: function attributes
Andreas Dilger47a0c421997-05-16 02:46:07 -05001018 */
Guy Schalnat0d580581995-07-20 02:43:20 -05001019
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001020/* Returns the version number of the library */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001021PNG_EXPORT(1, png_uint_32, png_access_version_number, (void));
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001022
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001023/* Tell lib we have already handled the first <num_bytes> magic bytes.
Andreas Dilger47a0c421997-05-16 02:46:07 -05001024 * Handling more than 8 bytes from the beginning of the file is an error.
1025 */
John Bowler5d567862011-12-24 09:12:00 -06001026PNG_EXPORT(2, void, png_set_sig_bytes, (png_structrp png_ptr, int num_bytes));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001027
Andreas Dilger47a0c421997-05-16 02:46:07 -05001028/* Check sig[start] through sig[start + num_to_check - 1] to see if it's a
1029 * PNG file. Returns zero if the supplied bytes match the 8-byte PNG
1030 * signature, and non-zero otherwise. Having num_to_check == 0 or
1031 * start > 7 will always fail (ie return non-zero).
1032 */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001033PNG_EXPORT(3, int, png_sig_cmp, (png_const_bytep sig, png_size_t start,
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001034 png_size_t num_to_check));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001035
Glenn Randers-Pehrson3e42a992010-03-31 22:16:07 -05001036/* Simple signature checking function. This is the same as calling
1037 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
1038 */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001039#define png_check_sig(sig, n) !png_sig_cmp((sig), 0, (n))
Glenn Randers-Pehrson3e42a992010-03-31 22:16:07 -05001040
Andreas Dilger47a0c421997-05-16 02:46:07 -05001041/* Allocate and initialize png_ptr struct for reading, and any other memory. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001042PNG_EXPORTA(4, png_structp, png_create_read_struct,
1043 (png_const_charp user_png_ver, png_voidp error_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001044 png_error_ptr error_fn, png_error_ptr warn_fn),
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001045 PNG_ALLOCATED);
Guy Schalnat0d580581995-07-20 02:43:20 -05001046
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001047/* Allocate and initialize png_ptr struct for writing, and any other memory */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001048PNG_EXPORTA(5, png_structp, png_create_write_struct,
1049 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001050 png_error_ptr warn_fn),
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001051 PNG_ALLOCATED);
Guy Schalnate5a37791996-06-05 15:50:50 -05001052
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001053PNG_EXPORT(6, png_size_t, png_get_compression_buffer_size,
John Bowler5d567862011-12-24 09:12:00 -06001054 (png_const_structrp png_ptr));
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -05001055
John Bowler5d567862011-12-24 09:12:00 -06001056PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structrp png_ptr,
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001057 png_size_t size));
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -05001058
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001059/* Moved from pngconf.h in 1.4.0 and modified to ensure setjmp/longjmp
1060 * match up.
1061 */
1062#ifdef PNG_SETJMP_SUPPORTED
1063/* This function returns the jmp_buf built in to *png_ptr. It must be
1064 * supplied with an appropriate 'longjmp' function to use on that jmp_buf
1065 * unless the default error function is overridden in which case NULL is
1066 * acceptable. The size of the jmp_buf is checked against the actual size
1067 * allocated by the library - the call will return NULL on a mismatch
1068 * indicating an ABI mismatch.
1069 */
John Bowler5d567862011-12-24 09:12:00 -06001070PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structrp png_ptr,
Glenn Randers-Pehrson27df3a42010-12-06 12:38:42 -06001071 png_longjmp_ptr longjmp_fn, size_t jmp_buf_size));
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001072# define png_jmpbuf(png_ptr) \
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001073 (*png_set_longjmp_fn((png_ptr), longjmp, (sizeof (jmp_buf))))
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001074#else
1075# define png_jmpbuf(png_ptr) \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06001076 (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001077#endif
Glenn Randers-Pehrsonf98726a2010-02-19 09:54:53 -06001078/* This function should be used by libpng applications in place of
1079 * longjmp(png_ptr->jmpbuf, val). If longjmp_fn() has been set, it
1080 * will use it; otherwise it will call PNG_ABORT(). This function was
1081 * added in libpng-1.5.0.
1082 */
John Bowler5d567862011-12-24 09:12:00 -06001083PNG_EXPORTA(9, void, png_longjmp, (png_const_structrp png_ptr, int val),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001084 PNG_NORETURN);
Glenn Randers-Pehrsonf4ea2242009-11-20 21:38:24 -06001085
Glenn Randers-Pehrson2b8bef12010-04-29 11:50:24 -05001086#ifdef PNG_READ_SUPPORTED
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -05001087/* Reset the compression stream */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001088PNG_EXPORTA(10, int, png_reset_zstream, (png_structrp png_ptr), PNG_DEPRECATED);
Glenn Randers-Pehrson2b8bef12010-04-29 11:50:24 -05001089#endif
Glenn Randers-Pehrson228bd392000-04-23 23:14:02 -05001090
Glenn Randers-Pehrson8b6a8892001-05-18 04:54:50 -05001091/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001092#ifdef PNG_USER_MEM_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001093PNG_EXPORTA(11, png_structp, png_create_read_struct_2,
1094 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001095 png_error_ptr warn_fn,
1096 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001097 PNG_ALLOCATED);
1098PNG_EXPORTA(12, png_structp, png_create_write_struct_2,
1099 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001100 png_error_ptr warn_fn,
1101 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001102 PNG_ALLOCATED);
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001103#endif
1104
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001105/* Write the PNG file signature. */
John Bowler5d567862011-12-24 09:12:00 -06001106PNG_EXPORT(13, void, png_write_sig, (png_structrp png_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001107
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001108/* Write a PNG chunk - size, type, (optional) data, CRC. */
John Bowler5d567862011-12-24 09:12:00 -06001109PNG_EXPORT(14, void, png_write_chunk, (png_structrp png_ptr, png_const_bytep
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001110 chunk_name, png_const_bytep data, png_size_t length));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001111
1112/* Write the start of a PNG chunk - length and chunk name. */
John Bowler5d567862011-12-24 09:12:00 -06001113PNG_EXPORT(15, void, png_write_chunk_start, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001114 png_const_bytep chunk_name, png_uint_32 length));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001115
1116/* Write the data of a PNG chunk started with png_write_chunk_start(). */
John Bowler5d567862011-12-24 09:12:00 -06001117PNG_EXPORT(16, void, png_write_chunk_data, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001118 png_const_bytep data, png_size_t length));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001119
1120/* Finish a chunk started with png_write_chunk_start() (includes CRC). */
John Bowler5d567862011-12-24 09:12:00 -06001121PNG_EXPORT(17, void, png_write_chunk_end, (png_structrp png_ptr));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -06001122
Andreas Dilger47a0c421997-05-16 02:46:07 -05001123/* Allocate and initialize the info structure */
John Bowler5d567862011-12-24 09:12:00 -06001124PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_const_structrp png_ptr),
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001125 PNG_ALLOCATED);
Guy Schalnat0d580581995-07-20 02:43:20 -05001126
John Bowler40b26032011-12-22 08:09:15 -06001127/* DEPRECATED: this function allowed init structures to be created using the
1128 * default allocation method (typically malloc). Use is deprecated in 1.6.0 and
1129 * the API will be removed in the future.
1130 */
John Bowlerd332c672011-12-21 17:36:12 -06001131PNG_EXPORTA(19, void, png_info_init_3, (png_infopp info_ptr,
1132 png_size_t png_info_struct_size), PNG_DEPRECATED);
Guy Schalnat0d580581995-07-20 02:43:20 -05001133
Andreas Dilger47a0c421997-05-16 02:46:07 -05001134/* Writes all the PNG information before the image. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001135PNG_EXPORT(20, void, png_write_info_before_PLTE,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001136 (png_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001137PNG_EXPORT(21, void, png_write_info,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001138 (png_structrp png_ptr, png_const_inforp info_ptr));
Guy Schalnat0d580581995-07-20 02:43:20 -05001139
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001140#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001141/* Read the information before the actual image data. */
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001142PNG_EXPORT(22, void, png_read_info,
John Bowler5d567862011-12-24 09:12:00 -06001143 (png_structrp png_ptr, png_inforp info_ptr));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001144#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001145
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001146#ifdef PNG_TIME_RFC1123_SUPPORTED
John Bowler40b26032011-12-22 08:09:15 -06001147 /* Convert to a US string format: there is no localization support in this
1148 * routine. The original implementation used a 29 character buffer in
1149 * png_struct, this will be removed in future versions.
1150 */
1151#if PNG_LIBPNG_VER < 10700
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001152/* To do: remove this from libpng17 (and from libpng17/png.c and pngstruct.h) */
John Bowler5d567862011-12-24 09:12:00 -06001153PNG_EXPORTA(23, png_const_charp, png_convert_to_rfc1123, (png_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001154 png_const_timep ptime),PNG_DEPRECATED);
1155#endif
1156PNG_EXPORT(241, int, png_convert_to_rfc1123_buffer, (char out[29],
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001157 png_const_timep ptime));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001158#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001159
Glenn Randers-Pehrson0cb46e22009-11-02 11:24:33 -06001160#ifdef PNG_CONVERT_tIME_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001161/* Convert from a struct tm to png_time */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001162PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime,
John Bowlerbaeb6d12011-11-26 18:21:02 -06001163 const struct tm * ttime));
Guy Schalnat0d580581995-07-20 02:43:20 -05001164
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001165/* Convert from time_t to png_time. Uses gmtime() */
John Bowler40b26032011-12-22 08:09:15 -06001166PNG_EXPORT(25, void, png_convert_from_time_t, (png_timep ptime, time_t ttime));
Glenn Randers-Pehrson0cb46e22009-11-02 11:24:33 -06001167#endif /* PNG_CONVERT_tIME_SUPPORTED */
Guy Schalnat0d580581995-07-20 02:43:20 -05001168
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001169#ifdef PNG_READ_EXPAND_SUPPORTED
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001170/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
John Bowler5d567862011-12-24 09:12:00 -06001171PNG_EXPORT(26, void, png_set_expand, (png_structrp png_ptr));
1172PNG_EXPORT(27, void, png_set_expand_gray_1_2_4_to_8, (png_structrp png_ptr));
1173PNG_EXPORT(28, void, png_set_palette_to_rgb, (png_structrp png_ptr));
1174PNG_EXPORT(29, void, png_set_tRNS_to_alpha, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001175#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001176
John Bowler4d562962011-02-12 09:01:20 -06001177#ifdef PNG_READ_EXPAND_16_SUPPORTED
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001178/* Expand to 16-bit channels, forces conversion of palette to RGB and expansion
John Bowler4d562962011-02-12 09:01:20 -06001179 * of a tRNS chunk if present.
1180 */
John Bowler5d567862011-12-24 09:12:00 -06001181PNG_EXPORT(221, void, png_set_expand_16, (png_structrp png_ptr));
John Bowler4d562962011-02-12 09:01:20 -06001182#endif
1183
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001184#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
Guy Schalnat0d580581995-07-20 02:43:20 -05001185/* Use blue, green, red order for pixels. */
John Bowler5d567862011-12-24 09:12:00 -06001186PNG_EXPORT(30, void, png_set_bgr, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001187#endif
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001188
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001189#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001190/* Expand the grayscale to 24-bit RGB if necessary. */
John Bowler5d567862011-12-24 09:12:00 -06001191PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structrp png_ptr));
John Bowlerf21a0d02011-01-23 23:55:19 -06001192#endif
Guy Schalnat69b14481996-01-10 02:56:49 -06001193
John Bowlerf21a0d02011-01-23 23:55:19 -06001194#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001195/* Reduce RGB to grayscale. */
John Bowler7875d532011-11-07 22:33:49 -06001196#define PNG_ERROR_ACTION_NONE 1
1197#define PNG_ERROR_ACTION_WARN 2
1198#define PNG_ERROR_ACTION_ERROR 3
1199#define PNG_RGB_TO_GRAY_DEFAULT (-1)/*for red/green coefficients*/
1200
John Bowler5d567862011-12-24 09:12:00 -06001201PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001202 int error_action, double red, double green))
John Bowler5d567862011-12-24 09:12:00 -06001203PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001204 int error_action, png_fixed_point red, png_fixed_point green))
Glenn Randers-Pehrsona272d8f2010-06-25 21:45:31 -05001205
John Bowler5d567862011-12-24 09:12:00 -06001206PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structrp
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001207 png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001208#endif
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001209
John Bowler4a12f4a2011-04-17 18:34:22 -05001210#ifdef PNG_BUILD_GRAYSCALE_PALETTE_SUPPORTED
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001211PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001212 png_colorp palette));
John Bowler4a12f4a2011-04-17 18:34:22 -05001213#endif
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001214
John Bowlerd273ad22011-05-07 21:00:28 -05001215#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
Glenn Randers-Pehrson9e065342014-02-24 19:07:04 -06001216/* How the alpha channel is interpreted - this affects how the color channels
1217 * of a PNG file are returned to the calling application when an alpha channel,
1218 * or a tRNS chunk in a palette file, is present.
John Bowlerd273ad22011-05-07 21:00:28 -05001219 *
Glenn Randers-Pehrson44e26d42011-05-08 22:56:42 -05001220 * This has no effect on the way pixels are written into a PNG output
1221 * datastream. The color samples in a PNG datastream are never premultiplied
1222 * with the alpha samples.
1223 *
1224 * The default is to return data according to the PNG specification: the alpha
John Bowlerd273ad22011-05-07 21:00:28 -05001225 * channel is a linear measure of the contribution of the pixel to the
Glenn Randers-Pehrson9e065342014-02-24 19:07:04 -06001226 * corresponding composited pixel, and the color channels are unassociated
1227 * (not premultiplied). The gamma encoded color channels must be scaled
1228 * according to the contribution and to do this it is necessary to undo
Glenn Randers-Pehrson44e26d42011-05-08 22:56:42 -05001229 * the encoding, scale the color values, perform the composition and reencode
1230 * the values. This is the 'PNG' mode.
John Bowlerd273ad22011-05-07 21:00:28 -05001231 *
1232 * The alternative is to 'associate' the alpha with the color information by
Glenn Randers-Pehrson9e065342014-02-24 19:07:04 -06001233 * storing color channel values that have been scaled by the alpha.
1234 * image. These are the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' modes
1235 * (the latter being the two common names for associated alpha color channels).
John Bowlerd273ad22011-05-07 21:00:28 -05001236 *
Glenn Randers-Pehrson9e065342014-02-24 19:07:04 -06001237 * For the 'OPTIMIZED' mode, a pixel is treated as opaque only if the alpha
1238 * value is equal to the maximum value.
John Bowlerd273ad22011-05-07 21:00:28 -05001239 *
1240 * The final choice is to gamma encode the alpha channel as well. This is
1241 * broken because, in practice, no implementation that uses this choice
1242 * correctly undoes the encoding before handling alpha composition. Use this
1243 * choice only if other serious errors in the software or hardware you use
1244 * mandate it; the typical serious error is for dark halos to appear around
1245 * opaque areas of the composited PNG image because of arithmetic overflow.
1246 *
1247 * The API function png_set_alpha_mode specifies which of these choices to use
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001248 * with an enumerated 'mode' value and the gamma of the required output:
John Bowlerd273ad22011-05-07 21:00:28 -05001249 */
1250#define PNG_ALPHA_PNG 0 /* according to the PNG standard */
1251#define PNG_ALPHA_STANDARD 1 /* according to Porter/Duff */
1252#define PNG_ALPHA_ASSOCIATED 1 /* as above; this is the normal practice */
1253#define PNG_ALPHA_PREMULTIPLIED 1 /* as above */
1254#define PNG_ALPHA_OPTIMIZED 2 /* 'PNG' for opaque pixels, else 'STANDARD' */
1255#define PNG_ALPHA_BROKEN 3 /* the alpha channel is gamma encoded */
1256
John Bowler5d567862011-12-24 09:12:00 -06001257PNG_FP_EXPORT(227, void, png_set_alpha_mode, (png_structrp png_ptr, int mode,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001258 double output_gamma))
John Bowler5d567862011-12-24 09:12:00 -06001259PNG_FIXED_EXPORT(228, void, png_set_alpha_mode_fixed, (png_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001260 int mode, png_fixed_point output_gamma))
John Bowlerf70c7d02011-05-10 22:54:37 -05001261#endif
John Bowlerd273ad22011-05-07 21:00:28 -05001262
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001263#if defined(PNG_GAMMA_SUPPORTED) || defined(PNG_READ_ALPHA_MODE_SUPPORTED)
John Bowlerd273ad22011-05-07 21:00:28 -05001264/* The output_gamma value is a screen gamma in libpng terminology: it expresses
Glenn Randers-Pehrson9e065342014-02-24 19:07:04 -06001265 * how to decode the output values, not how they are encoded.
John Bowlerd273ad22011-05-07 21:00:28 -05001266 */
John Bowlerf70c7d02011-05-10 22:54:37 -05001267#define PNG_DEFAULT_sRGB -1 /* sRGB gamma and color space */
1268#define PNG_GAMMA_MAC_18 -2 /* Old Mac '1.8' gamma and color space */
Glenn Randers-Pehrsonc7822512011-05-07 21:23:43 -05001269#define PNG_GAMMA_sRGB 220000 /* Television standards--matches sRGB gamma */
John Bowlerd273ad22011-05-07 21:00:28 -05001270#define PNG_GAMMA_LINEAR PNG_FP_1 /* Linear */
John Bowlerf70c7d02011-05-10 22:54:37 -05001271#endif
John Bowlerd273ad22011-05-07 21:00:28 -05001272
1273/* The following are examples of calls to png_set_alpha_mode to achieve the
1274 * required overall gamma correction and, where necessary, alpha
1275 * premultiplication.
1276 *
1277 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1278 * This is the default libpng handling of the alpha channel - it is not
1279 * pre-multiplied into the color components. In addition the call states
1280 * that the output is for a sRGB system and causes all PNG files without gAMA
1281 * chunks to be assumed to be encoded using sRGB.
1282 *
1283 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1284 * In this case the output is assumed to be something like an sRGB conformant
1285 * display preceeded by a power-law lookup table of power 1.45. This is how
1286 * early Mac systems behaved.
1287 *
Glenn Randers-Pehrsonc7822512011-05-07 21:23:43 -05001288 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);
John Bowlerd273ad22011-05-07 21:00:28 -05001289 * This is the classic Jim Blinn approach and will work in academic
1290 * environments where everything is done by the book. It has the shortcoming
1291 * of assuming that input PNG data with no gamma information is linear - this
1292 * is unlikely to be correct unless the PNG files where generated locally.
1293 * Most of the time the output precision will be so low as to show
1294 * significant banding in dark areas of the image.
1295 *
1296 * png_set_expand_16(pp);
1297 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB);
1298 * This is a somewhat more realistic Jim Blinn inspired approach. PNG files
1299 * are assumed to have the sRGB encoding if not marked with a gamma value and
1300 * the output is always 16 bits per component. This permits accurate scaling
1301 * and processing of the data. If you know that your input PNG files were
1302 * generated locally you might need to replace PNG_DEFAULT_sRGB with the
1303 * correct value for your system.
1304 *
1305 * png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB);
1306 * If you just need to composite the PNG image onto an existing background
1307 * and if you control the code that does this you can use the optimization
1308 * setting. In this case you just copy completely opaque pixels to the
1309 * output. For pixels that are not completely transparent (you just skip
1310 * those) you do the composition math using png_composite or png_composite_16
Glenn Randers-Pehrsond768d102011-05-08 23:26:19 -05001311 * below then encode the resultant 8-bit or 16-bit values to match the output
John Bowlerd273ad22011-05-07 21:00:28 -05001312 * encoding.
1313 *
1314 * Other cases
1315 * If neither the PNG nor the standard linear encoding work for you because
1316 * of the software or hardware you use then you have a big problem. The PNG
1317 * case will probably result in halos around the image. The linear encoding
1318 * will probably result in a washed out, too bright, image (it's actually too
1319 * contrasty.) Try the ALPHA_OPTIMIZED mode above - this will probably
1320 * substantially reduce the halos. Alternatively try:
1321 *
1322 * png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB);
1323 * This option will also reduce the halos, but there will be slight dark
1324 * halos round the opaque parts of the image where the background is light.
1325 * In the OPTIMIZED mode the halos will be light halos where the background
1326 * is dark. Take your pick - the halos are unavoidable unless you can get
1327 * your hardware/software fixed! (The OPTIMIZED approach is slightly
1328 * faster.)
1329 *
1330 * When the default gamma of PNG files doesn't match the output gamma.
1331 * If you have PNG files with no gamma information png_set_alpha_mode allows
1332 * you to provide a default gamma, but it also sets the ouput gamma to the
1333 * matching value. If you know your PNG files have a gamma that doesn't
1334 * match the output you can take advantage of the fact that
1335 * png_set_alpha_mode always sets the output gamma but only sets the PNG
1336 * default if it is not already set:
1337 *
1338 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1339 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1340 * The first call sets both the default and the output gamma values, the
1341 * second call overrides the output gamma without changing the default. This
1342 * is easier than achieving the same effect with png_set_gamma. You must use
1343 * PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will
1344 * fire if more than one call to png_set_alpha_mode and png_set_background is
1345 * made in the same read operation, however multiple calls with PNG_ALPHA_PNG
1346 * are ignored.
1347 */
John Bowlerd273ad22011-05-07 21:00:28 -05001348
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001349#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06001350PNG_EXPORT(36, void, png_set_strip_alpha, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001351#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001352
1353#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
1354 defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
John Bowler5d567862011-12-24 09:12:00 -06001355PNG_EXPORT(37, void, png_set_swap_alpha, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001356#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001357
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -06001358#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
1359 defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
John Bowler5d567862011-12-24 09:12:00 -06001360PNG_EXPORT(38, void, png_set_invert_alpha, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001361#endif
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -06001362
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001363#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -05001364/* Add a filler byte to 8-bit Gray or 24-bit RGB images. */
John Bowler5d567862011-12-24 09:12:00 -06001365PNG_EXPORT(39, void, png_set_filler, (png_structrp png_ptr, png_uint_32 filler,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001366 int flags));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001367/* The values of the PNG_FILLER_ defines should NOT be changed */
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06001368# define PNG_FILLER_BEFORE 0
1369# define PNG_FILLER_AFTER 1
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -05001370/* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */
John Bowler5d567862011-12-24 09:12:00 -06001371PNG_EXPORT(40, void, png_set_add_alpha, (png_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001372 png_uint_32 filler, int flags));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001373#endif /* PNG_READ_FILLER_SUPPORTED || PNG_WRITE_FILLER_SUPPORTED */
Guy Schalnat0d580581995-07-20 02:43:20 -05001374
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001375#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001376/* Swap bytes in 16-bit depth files. */
John Bowler5d567862011-12-24 09:12:00 -06001377PNG_EXPORT(41, void, png_set_swap, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001378#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001379
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001380#if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED)
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001381/* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */
John Bowler5d567862011-12-24 09:12:00 -06001382PNG_EXPORT(42, void, png_set_packing, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001383#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05001384
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06001385#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
1386 defined(PNG_WRITE_PACKSWAP_SUPPORTED)
Andreas Dilger47a0c421997-05-16 02:46:07 -05001387/* Swap packing order of pixels in bytes. */
John Bowler5d567862011-12-24 09:12:00 -06001388PNG_EXPORT(43, void, png_set_packswap, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001389#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001390
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001391#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
Guy Schalnat0d580581995-07-20 02:43:20 -05001392/* Converts files to legal bit depths. */
John Bowler5d567862011-12-24 09:12:00 -06001393PNG_EXPORT(44, void, png_set_shift, (png_structrp png_ptr, png_const_color_8p
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001394 true_bits));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001395#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001396
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001397#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
1398 defined(PNG_WRITE_INTERLACING_SUPPORTED)
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001399/* Have the code handle the interlacing. Returns the number of passes.
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001400 * MUST be called before png_read_update_info or png_start_read_image,
1401 * otherwise it will not have the desired effect. Note that it is still
1402 * necessary to call png_read_row or png_read_rows png_get_image_height
1403 * times for each pass.
1404*/
John Bowler5d567862011-12-24 09:12:00 -06001405PNG_EXPORT(45, int, png_set_interlace_handling, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001406#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001407
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001408#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -05001409/* Invert monochrome files */
John Bowler5d567862011-12-24 09:12:00 -06001410PNG_EXPORT(46, void, png_set_invert_mono, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001411#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001412
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001413#ifdef PNG_READ_BACKGROUND_SUPPORTED
John Bowlercb0b2962011-05-12 21:48:29 -05001414/* Handle alpha and tRNS by replacing with a background color. Prior to
Glenn Randers-Pehrsonef217b72011-06-15 12:58:27 -05001415 * libpng-1.5.4 this API must not be called before the PNG file header has been
John Bowlercb0b2962011-05-12 21:48:29 -05001416 * read. Doing so will result in unexpected behavior and possible warnings or
Glenn Randers-Pehrson1591a4c2011-05-16 09:07:26 -05001417 * errors if the PNG file contains a bKGD chunk.
John Bowlercb0b2962011-05-12 21:48:29 -05001418 */
John Bowler5d567862011-12-24 09:12:00 -06001419PNG_FP_EXPORT(47, void, png_set_background, (png_structrp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001420 png_const_color_16p background_color, int background_gamma_code,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001421 int need_expand, double background_gamma))
John Bowler5d567862011-12-24 09:12:00 -06001422PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structrp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001423 png_const_color_16p background_color, int background_gamma_code,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001424 int need_expand, png_fixed_point background_gamma))
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001425#endif
1426#ifdef PNG_READ_BACKGROUND_SUPPORTED
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06001427# define PNG_BACKGROUND_GAMMA_UNKNOWN 0
1428# define PNG_BACKGROUND_GAMMA_SCREEN 1
1429# define PNG_BACKGROUND_GAMMA_FILE 2
1430# define PNG_BACKGROUND_GAMMA_UNIQUE 3
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001431#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001432
John Bowler8d261262011-06-18 13:37:11 -05001433#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
Glenn Randers-Pehrson413138a2011-06-13 22:07:37 -05001434/* Scale a 16-bit depth file down to 8-bit, accurately. */
John Bowler5d567862011-12-24 09:12:00 -06001435PNG_EXPORT(229, void, png_set_scale_16, (png_structrp png_ptr));
John Bowler8d261262011-06-18 13:37:11 -05001436#endif
Glenn Randers-Pehrsonab63dd02011-06-17 20:04:17 -05001437
John Bowler8d261262011-06-18 13:37:11 -05001438#ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED
1439#define PNG_READ_16_TO_8 SUPPORTED /* Name prior to 1.5.4 */
Glenn Randers-Pehrson413138a2011-06-13 22:07:37 -05001440/* Strip the second byte of information from a 16-bit depth file. */
John Bowler5d567862011-12-24 09:12:00 -06001441PNG_EXPORT(48, void, png_set_strip_16, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001442#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001443
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -05001444#ifdef PNG_READ_QUANTIZE_SUPPORTED
1445/* Turn on quantizing, and reduce the palette to the number of colors
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06001446 * available.
1447 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001448PNG_EXPORT(49, void, png_set_quantize, (png_structrp png_ptr,
1449 png_colorp palette, int num_palette, int maximum_colors,
1450 png_const_uint_16p histogram, int full_quantize));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001451#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001452
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001453#ifdef PNG_READ_GAMMA_SUPPORTED
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05001454/* The threshold on gamma processing is configurable but hard-wired into the
1455 * library. The following is the floating point variant.
1456 */
1457#define PNG_GAMMA_THRESHOLD (PNG_GAMMA_THRESHOLD_FIXED*.00001)
1458
John Bowlerd273ad22011-05-07 21:00:28 -05001459/* Handle gamma correction. Screen_gamma=(display_exponent).
Glenn Randers-Pehrsonc7822512011-05-07 21:23:43 -05001460 * NOTE: this API simply sets the screen and file gamma values. It will
John Bowlerd273ad22011-05-07 21:00:28 -05001461 * therefore override the value for gamma in a PNG file if it is called after
John Bowlerf70c7d02011-05-10 22:54:37 -05001462 * the file header has been read - use with care - call before reading the PNG
1463 * file for best results!
1464 *
1465 * These routines accept the same gamma values as png_set_alpha_mode (described
1466 * above). The PNG_GAMMA_ defines and PNG_DEFAULT_sRGB can be passed to either
1467 * API (floating point or fixed.) Notice, however, that the 'file_gamma' value
1468 * is the inverse of a 'screen gamma' value.
John Bowlerd273ad22011-05-07 21:00:28 -05001469 */
John Bowler5d567862011-12-24 09:12:00 -06001470PNG_FP_EXPORT(50, void, png_set_gamma, (png_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001471 double screen_gamma, double override_file_gamma))
John Bowler5d567862011-12-24 09:12:00 -06001472PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001473 png_fixed_point screen_gamma, png_fixed_point override_file_gamma))
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001474#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001475
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001476#ifdef PNG_WRITE_FLUSH_SUPPORTED
Guy Schalnat0f716451995-11-28 11:22:13 -06001477/* Set how many lines between output flushes - 0 for no flushing */
John Bowler5d567862011-12-24 09:12:00 -06001478PNG_EXPORT(51, void, png_set_flush, (png_structrp png_ptr, int nrows));
Guy Schalnat0f716451995-11-28 11:22:13 -06001479/* Flush the current PNG output buffer */
John Bowler5d567862011-12-24 09:12:00 -06001480PNG_EXPORT(52, void, png_write_flush, (png_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001481#endif
Guy Schalnat0f716451995-11-28 11:22:13 -06001482
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001483/* Optional update palette with requested transformations */
John Bowler5d567862011-12-24 09:12:00 -06001484PNG_EXPORT(53, void, png_start_read_image, (png_structrp png_ptr));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001485
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001486/* Optional call to update the users info structure */
John Bowler5d567862011-12-24 09:12:00 -06001487PNG_EXPORT(54, void, png_read_update_info, (png_structrp png_ptr,
1488 png_inforp info_ptr));
Guy Schalnat0d580581995-07-20 02:43:20 -05001489
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001490#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001491/* Read one or more rows of image data. */
John Bowler5d567862011-12-24 09:12:00 -06001492PNG_EXPORT(55, void, png_read_rows, (png_structrp png_ptr, png_bytepp row,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001493 png_bytepp display_row, png_uint_32 num_rows));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001494#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001495
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001496#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001497/* Read a row of data. */
John Bowler5d567862011-12-24 09:12:00 -06001498PNG_EXPORT(56, void, png_read_row, (png_structrp png_ptr, png_bytep row,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001499 png_bytep display_row));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001500#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001501
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001502#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001503/* Read the whole image into memory at once. */
John Bowler5d567862011-12-24 09:12:00 -06001504PNG_EXPORT(57, void, png_read_image, (png_structrp png_ptr, png_bytepp image));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001505#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001506
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001507/* Write a row of image data */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001508PNG_EXPORT(58, void, png_write_row, (png_structrp png_ptr,
1509 png_const_bytep row));
Guy Schalnat0d580581995-07-20 02:43:20 -05001510
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001511/* Write a few rows of image data: (*row) is not written; however, the type
1512 * is declared as writeable to maintain compatibility with previous versions
1513 * of libpng and to allow the 'display_row' array from read_rows to be passed
Glenn Randers-Pehrsone600c512010-08-18 07:25:46 -05001514 * unchanged to write_rows.
1515 */
John Bowler5d567862011-12-24 09:12:00 -06001516PNG_EXPORT(59, void, png_write_rows, (png_structrp png_ptr, png_bytepp row,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001517 png_uint_32 num_rows));
Guy Schalnat0d580581995-07-20 02:43:20 -05001518
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001519/* Write the image data */
John Bowler5d567862011-12-24 09:12:00 -06001520PNG_EXPORT(60, void, png_write_image, (png_structrp png_ptr, png_bytepp image));
Guy Schalnat0d580581995-07-20 02:43:20 -05001521
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001522/* Write the end of the PNG file. */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001523PNG_EXPORT(61, void, png_write_end, (png_structrp png_ptr,
1524 png_inforp info_ptr));
Guy Schalnat0d580581995-07-20 02:43:20 -05001525
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001526#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001527/* Read the end of the PNG file. */
John Bowler5d567862011-12-24 09:12:00 -06001528PNG_EXPORT(62, void, png_read_end, (png_structrp png_ptr, png_inforp info_ptr));
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -05001529#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001530
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001531/* Free any memory associated with the png_info_struct */
John Bowler5d567862011-12-24 09:12:00 -06001532PNG_EXPORT(63, void, png_destroy_info_struct, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001533 png_infopp info_ptr_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001534
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001535/* Free any memory associated with the png_struct and the png_info_structs */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001536PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001537 png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001538
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001539/* Free any memory associated with the png_struct and the png_info_structs */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001540PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001541 png_infopp info_ptr_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001542
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001543/* Set the libpng method of handling chunk CRC errors */
John Bowler5d567862011-12-24 09:12:00 -06001544PNG_EXPORT(66, void, png_set_crc_action, (png_structrp png_ptr, int crit_action,
John Bowler40b26032011-12-22 08:09:15 -06001545 int ancil_action));
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001546
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001547/* Values for png_set_crc_action() say how to handle CRC errors in
Andreas Dilger47a0c421997-05-16 02:46:07 -05001548 * ancillary and critical chunks, and whether to use the data contained
1549 * therein. Note that it is impossible to "discard" data in a critical
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001550 * chunk. For versions prior to 0.90, the action was always error/quit,
Andreas Dilger47a0c421997-05-16 02:46:07 -05001551 * whereas in version 0.90 and later, the action for CRC errors in ancillary
1552 * chunks is warn/discard. These values should NOT be changed.
1553 *
1554 * value action:critical action:ancillary
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001555 */
1556#define PNG_CRC_DEFAULT 0 /* error/quit warn/discard data */
1557#define PNG_CRC_ERROR_QUIT 1 /* error/quit error/quit */
1558#define PNG_CRC_WARN_DISCARD 2 /* (INVALID) warn/discard data */
1559#define PNG_CRC_WARN_USE 3 /* warn/use data warn/use data */
1560#define PNG_CRC_QUIET_USE 4 /* quiet/use data quiet/use data */
1561#define PNG_CRC_NO_CHANGE 5 /* use current value use current value */
1562
Andreas Dilger47a0c421997-05-16 02:46:07 -05001563/* These functions give the user control over the scan-line filtering in
1564 * libpng and the compression methods used by zlib. These functions are
1565 * mainly useful for testing, as the defaults should work with most users.
1566 * Those users who are tight on memory or want faster performance at the
1567 * expense of compression can modify them. See the compression library
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001568 * header file (zlib.h) for an explination of the compression functions.
1569 */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001570
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001571/* Set the filtering method(s) used by libpng. Currently, the only valid
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06001572 * value for "method" is 0.
1573 */
John Bowler5d567862011-12-24 09:12:00 -06001574PNG_EXPORT(67, void, png_set_filter, (png_structrp png_ptr, int method,
John Bowler40b26032011-12-22 08:09:15 -06001575 int filters));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001576
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001577/* Flags for png_set_filter() to say which filters to use. The flags
Andreas Dilger47a0c421997-05-16 02:46:07 -05001578 * are chosen so that they don't conflict with real filter types
1579 * below, in case they are supplied instead of the #defined constants.
1580 * These values should NOT be changed.
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001581 */
1582#define PNG_NO_FILTERS 0x00
1583#define PNG_FILTER_NONE 0x08
1584#define PNG_FILTER_SUB 0x10
1585#define PNG_FILTER_UP 0x20
1586#define PNG_FILTER_AVG 0x40
1587#define PNG_FILTER_PAETH 0x80
1588#define PNG_ALL_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP | \
1589 PNG_FILTER_AVG | PNG_FILTER_PAETH)
1590
Andreas Dilger47a0c421997-05-16 02:46:07 -05001591/* Filter values (not flags) - used in pngwrite.c, pngwutil.c for now.
1592 * These defines should NOT be changed.
1593 */
1594#define PNG_FILTER_VALUE_NONE 0
1595#define PNG_FILTER_VALUE_SUB 1
1596#define PNG_FILTER_VALUE_UP 2
1597#define PNG_FILTER_VALUE_AVG 3
1598#define PNG_FILTER_VALUE_PAETH 4
1599#define PNG_FILTER_VALUE_LAST 5
1600
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001601#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */
Andreas Dilger47a0c421997-05-16 02:46:07 -05001602/* The "heuristic_method" is given by one of the PNG_FILTER_HEURISTIC_
1603 * defines, either the default (minimum-sum-of-absolute-differences), or
1604 * the experimental method (weighted-minimum-sum-of-absolute-differences).
1605 *
1606 * Weights are factors >= 1.0, indicating how important it is to keep the
1607 * filter type consistent between rows. Larger numbers mean the current
1608 * filter is that many times as likely to be the same as the "num_weights"
1609 * previous filters. This is cumulative for each previous row with a weight.
1610 * There needs to be "num_weights" values in "filter_weights", or it can be
1611 * NULL if the weights aren't being specified. Weights have no influence on
1612 * the selection of the first row filter. Well chosen weights can (in theory)
1613 * improve the compression for a given image.
1614 *
1615 * Costs are factors >= 1.0 indicating the relative decoding costs of a
1616 * filter type. Higher costs indicate more decoding expense, and are
1617 * therefore less likely to be selected over a filter with lower computational
1618 * costs. There needs to be a value in "filter_costs" for each valid filter
1619 * type (given by PNG_FILTER_VALUE_LAST), or it can be NULL if you aren't
1620 * setting the costs. Costs try to improve the speed of decompression without
1621 * unduly increasing the compressed image size.
1622 *
1623 * A negative weight or cost indicates the default value is to be used, and
1624 * values in the range [0.0, 1.0) indicate the value is to remain unchanged.
1625 * The default values for both weights and costs are currently 1.0, but may
1626 * change if good general weighting/cost heuristics can be found. If both
1627 * the weights and costs are set to 1.0, this degenerates the WEIGHTED method
1628 * to the UNWEIGHTED method, but with added encoding time/computation.
1629 */
John Bowler5d567862011-12-24 09:12:00 -06001630PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structrp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001631 int heuristic_method, int num_weights, png_const_doublep filter_weights,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001632 png_const_doublep filter_costs))
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001633PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed,
John Bowler5d567862011-12-24 09:12:00 -06001634 (png_structrp png_ptr, int heuristic_method, int num_weights,
John Bowler40b26032011-12-22 08:09:15 -06001635 png_const_fixed_point_p filter_weights,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001636 png_const_fixed_point_p filter_costs))
Andreas Dilger47a0c421997-05-16 02:46:07 -05001637#endif /* PNG_WRITE_WEIGHTED_FILTER_SUPPORTED */
1638
1639/* Heuristic used for row filter selection. These defines should NOT be
1640 * changed.
1641 */
1642#define PNG_FILTER_HEURISTIC_DEFAULT 0 /* Currently "UNWEIGHTED" */
1643#define PNG_FILTER_HEURISTIC_UNWEIGHTED 1 /* Used by libpng < 0.95 */
1644#define PNG_FILTER_HEURISTIC_WEIGHTED 2 /* Experimental feature */
1645#define PNG_FILTER_HEURISTIC_LAST 3 /* Not a valid value */
1646
John Bowlerc5bef942011-05-05 17:35:39 -05001647#ifdef PNG_WRITE_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001648/* Set the library compression level. Currently, valid values range from
1649 * 0 - 9, corresponding directly to the zlib compression levels 0 - 9
1650 * (0 - no compression, 9 - "maximal" compression). Note that tests have
1651 * shown that zlib compression levels 3-6 usually perform as well as level 9
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001652 * for PNG images, and do considerably fewer caclulations. In the future,
Andreas Dilger47a0c421997-05-16 02:46:07 -05001653 * these values may not correspond directly to the zlib compression levels.
1654 */
John Bowler5d567862011-12-24 09:12:00 -06001655PNG_EXPORT(69, void, png_set_compression_level, (png_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001656 int level));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001657
John Bowler5d567862011-12-24 09:12:00 -06001658PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001659 int mem_level));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001660
John Bowler5d567862011-12-24 09:12:00 -06001661PNG_EXPORT(71, void, png_set_compression_strategy, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001662 int strategy));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001663
Glenn Randers-Pehrsonaf855e42011-05-07 10:52:49 -05001664/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1665 * smaller value of window_bits if it can do so safely.
1666 */
John Bowler5d567862011-12-24 09:12:00 -06001667PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001668 int window_bits));
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001669
John Bowler5d567862011-12-24 09:12:00 -06001670PNG_EXPORT(73, void, png_set_compression_method, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001671 int method));
John Bowlerc5bef942011-05-05 17:35:39 -05001672#endif
Guy Schalnat0d580581995-07-20 02:43:20 -05001673
John Bowlerb2bee332011-06-10 23:24:58 -05001674#ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001675/* Also set zlib parameters for compressing non-IDAT chunks */
John Bowler5d567862011-12-24 09:12:00 -06001676PNG_EXPORT(222, void, png_set_text_compression_level, (png_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001677 int level));
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001678
John Bowler5d567862011-12-24 09:12:00 -06001679PNG_EXPORT(223, void, png_set_text_compression_mem_level, (png_structrp png_ptr,
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001680 int mem_level));
1681
John Bowler5d567862011-12-24 09:12:00 -06001682PNG_EXPORT(224, void, png_set_text_compression_strategy, (png_structrp png_ptr,
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001683 int strategy));
1684
Glenn Randers-Pehrsonaf855e42011-05-07 10:52:49 -05001685/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1686 * smaller value of window_bits if it can do so safely.
1687 */
John Bowler40b26032011-12-22 08:09:15 -06001688PNG_EXPORT(225, void, png_set_text_compression_window_bits,
John Bowler5d567862011-12-24 09:12:00 -06001689 (png_structrp png_ptr, int window_bits));
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001690
John Bowler5d567862011-12-24 09:12:00 -06001691PNG_EXPORT(226, void, png_set_text_compression_method, (png_structrp png_ptr,
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001692 int method));
John Bowlerb2bee332011-06-10 23:24:58 -05001693#endif /* PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED */
Glenn Randers-Pehrson6b3d50b2011-03-31 20:14:29 -05001694
Guy Schalnate5a37791996-06-05 15:50:50 -05001695/* These next functions are called for input/output, memory, and error
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001696 * handling. They are in the file pngrio.c, pngwio.c, and pngerror.c,
Andreas Dilger47a0c421997-05-16 02:46:07 -05001697 * and call standard C I/O routines such as fread(), fwrite(), and
1698 * fprintf(). These functions can be made to use other I/O routines
1699 * at run time for those applications that need to handle I/O in a
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -05001700 * different manner by calling png_set_???_fn(). See libpng-manual.txt for
Andreas Dilger47a0c421997-05-16 02:46:07 -05001701 * more information.
1702 */
Guy Schalnat0d580581995-07-20 02:43:20 -05001703
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -05001704#ifdef PNG_STDIO_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001705/* Initialize the input/output for the PNG file to the default functions. */
John Bowler5d567862011-12-24 09:12:00 -06001706PNG_EXPORT(74, void, png_init_io, (png_structrp png_ptr, png_FILE_p fp));
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001707#endif
Guy Schalnat6d764711995-12-19 03:22:19 -06001708
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06001709/* Replace the (error and abort), and warning functions with user
Andreas Dilger47a0c421997-05-16 02:46:07 -05001710 * supplied functions. If no messages are to be printed you must still
1711 * write and use replacement functions. The replacement error_fn should
1712 * still do a longjmp to the last setjmp location if you are using this
1713 * method of error handling. If error_fn or warning_fn is NULL, the
1714 * default function will be used.
1715 */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06001716
John Bowler5d567862011-12-24 09:12:00 -06001717PNG_EXPORT(75, void, png_set_error_fn, (png_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001718 png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warning_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001719
Guy Schalnate5a37791996-06-05 15:50:50 -05001720/* Return the user pointer associated with the error functions */
John Bowler5d567862011-12-24 09:12:00 -06001721PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structrp png_ptr));
Guy Schalnat6d764711995-12-19 03:22:19 -06001722
1723/* Replace the default data output functions with a user supplied one(s).
Andreas Dilger47a0c421997-05-16 02:46:07 -05001724 * If buffered output is not used, then output_flush_fn can be set to NULL.
1725 * If PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile time
1726 * output_flush_fn will be ignored (and thus can be NULL).
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -05001727 * It is probably a mistake to use NULL for output_flush_fn if
1728 * write_data_fn is not also NULL unless you have built libpng with
1729 * PNG_WRITE_FLUSH_SUPPORTED undefined, because in this case libpng's
1730 * default flush function, which uses the standard *FILE structure, will
1731 * be used.
Andreas Dilger47a0c421997-05-16 02:46:07 -05001732 */
John Bowler5d567862011-12-24 09:12:00 -06001733PNG_EXPORT(77, void, png_set_write_fn, (png_structrp png_ptr, png_voidp io_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001734 png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001735
1736/* Replace the default data input function with a user supplied one. */
John Bowler5d567862011-12-24 09:12:00 -06001737PNG_EXPORT(78, void, png_set_read_fn, (png_structrp png_ptr, png_voidp io_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001738 png_rw_ptr read_data_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001739
1740/* Return the user pointer associated with the I/O functions */
John Bowler5d567862011-12-24 09:12:00 -06001741PNG_EXPORT(79, png_voidp, png_get_io_ptr, (png_const_structrp png_ptr));
Guy Schalnat6d764711995-12-19 03:22:19 -06001742
John Bowler5d567862011-12-24 09:12:00 -06001743PNG_EXPORT(80, void, png_set_read_status_fn, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001744 png_read_status_ptr read_row_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001745
John Bowler5d567862011-12-24 09:12:00 -06001746PNG_EXPORT(81, void, png_set_write_status_fn, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001747 png_write_status_ptr write_row_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001748
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001749#ifdef PNG_USER_MEM_SUPPORTED
1750/* Replace the default memory allocation functions with user supplied one(s). */
John Bowler5d567862011-12-24 09:12:00 -06001751PNG_EXPORT(82, void, png_set_mem_fn, (png_structrp png_ptr, png_voidp mem_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001752 png_malloc_ptr malloc_fn, png_free_ptr free_fn));
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001753/* Return the user pointer associated with the memory functions */
John Bowler5d567862011-12-24 09:12:00 -06001754PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structrp png_ptr));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001755#endif
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001756
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -05001757#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06001758PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001759 png_user_transform_ptr read_user_transform_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001760#endif
1761
Glenn Randers-Pehrson33188ac2009-06-16 14:12:35 -05001762#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06001763PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001764 png_user_transform_ptr write_user_transform_fn));
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001765#endif
1766
John Bowler0a5c9c02011-01-22 17:36:34 -06001767#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06001768PNG_EXPORT(86, void, png_set_user_transform_info, (png_structrp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001769 png_voidp user_transform_ptr, int user_transform_depth,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001770 int user_transform_channels));
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001771/* Return the user pointer associated with the user transform functions */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06001772PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr,
John Bowler5d567862011-12-24 09:12:00 -06001773 (png_const_structrp png_ptr));
John Bowler0a5c9c02011-01-22 17:36:34 -06001774#endif
1775
1776#ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED
1777/* Return information about the row currently being processed. Note that these
1778 * APIs do not fail but will return unexpected results if called outside a user
1779 * transform callback. Also note that when transforming an interlaced image the
John Bowler9616ad92011-02-16 06:13:46 -06001780 * row number is the row number within the sub-image of the interlace pass, so
1781 * the value will increase to the height of the sub-image (not the full image)
1782 * then reset to 0 for the next pass.
John Bowler5432c012011-02-12 08:59:17 -06001783 *
John Bowler9616ad92011-02-16 06:13:46 -06001784 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
1785 * find the output pixel (x,y) given an interlaced sub-image pixel
1786 * (row,col,pass). (See below for these macros.)
John Bowler0a5c9c02011-01-22 17:36:34 -06001787 */
John Bowler5d567862011-12-24 09:12:00 -06001788PNG_EXPORT(217, png_uint_32, png_get_current_row_number, (png_const_structrp));
1789PNG_EXPORT(218, png_byte, png_get_current_pass_number, (png_const_structrp));
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -05001790#endif
1791
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001792#ifdef PNG_READ_USER_CHUNKS_SUPPORTED
John Bowlere15b5372013-03-02 17:59:43 -06001793/* This callback is called only for *unknown* chunks. If
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001794 * PNG_HANDLE_AS_UNKNOWN_SUPPORTED is set then it is possible to set known
1795 * chunks to be treated as unknown, however in this case the callback must do
1796 * any processing required by the chunk (e.g. by calling the appropriate
1797 * png_set_ APIs.)
1798 *
1799 * There is no write support - on write, by default, all the chunks in the
1800 * 'unknown' list are written in the specified position.
1801 *
1802 * The integer return from the callback function is interpreted thus:
1803 *
1804 * negative: An error occured, png_chunk_error will be called.
John Bowlere15b5372013-03-02 17:59:43 -06001805 * zero: The chunk was not handled, the chunk will be saved. A critical
1806 * chunk will cause an error at this point unless it is to be saved.
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001807 * positive: The chunk was handled, libpng will ignore/discard it.
John Bowlere15b5372013-03-02 17:59:43 -06001808 *
1809 * See "INTERACTION WTIH USER CHUNK CALLBACKS" below for important notes about
1810 * how this behavior will change in libpng 1.7
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001811 */
John Bowler5d567862011-12-24 09:12:00 -06001812PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001813 png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn));
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001814#endif
1815
1816#ifdef PNG_USER_CHUNKS_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06001817PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structrp png_ptr));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001818#endif
1819
Guy Schalnat4ee97b01996-01-16 01:51:56 -06001820#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001821/* Sets the function callbacks for the push reader, and a pointer to a
1822 * user-defined structure available to the callback functions.
1823 */
John Bowler5d567862011-12-24 09:12:00 -06001824PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structrp png_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06001825 png_voidp progressive_ptr, png_progressive_info_ptr info_fn,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001826 png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn));
Guy Schalnat6d764711995-12-19 03:22:19 -06001827
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001828/* Returns the user pointer associated with the push read functions */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001829PNG_EXPORT(91, png_voidp, png_get_progressive_ptr,
1830 (png_const_structrp png_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001831
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001832/* Function to be called when data becomes available */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001833PNG_EXPORT(92, void, png_process_data, (png_structrp png_ptr,
1834 png_inforp info_ptr, png_bytep buffer, png_size_t buffer_size));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001835
John Bowler0a5c9c02011-01-22 17:36:34 -06001836/* A function which may be called *only* within png_process_data to stop the
1837 * processing of any more data. The function returns the number of bytes
1838 * remaining, excluding any that libpng has cached internally. A subsequent
1839 * call to png_process_data must supply these bytes again. If the argument
1840 * 'save' is set to true the routine will first save all the pending data and
1841 * will always return 0.
1842 */
John Bowler5d567862011-12-24 09:12:00 -06001843PNG_EXPORT(219, png_size_t, png_process_data_pause, (png_structrp, int save));
John Bowler0a5c9c02011-01-22 17:36:34 -06001844
1845/* A function which may be called *only* outside (after) a call to
1846 * png_process_data. It returns the number of bytes of data to skip in the
1847 * input. Normally it will return 0, but if it returns a non-zero value the
1848 * application must skip than number of bytes of input data and pass the
1849 * following data to the next call to png_process_data.
1850 */
John Bowler5d567862011-12-24 09:12:00 -06001851PNG_EXPORT(220, png_uint_32, png_process_data_skip, (png_structrp));
John Bowler0a5c9c02011-01-22 17:36:34 -06001852
Glenn Randers-Pehrson4daae302011-10-06 21:37:47 -05001853#ifdef PNG_READ_INTERLACING_SUPPORTED
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06001854/* Function that combines rows. 'new_row' is a flag that should come from
1855 * the callback and be non-NULL if anything needs to be done; the library
1856 * stores its own version of the new data internally and ignores the passed
1857 * in value.
Andreas Dilger47a0c421997-05-16 02:46:07 -05001858 */
John Bowler5d567862011-12-24 09:12:00 -06001859PNG_EXPORT(93, void, png_progressive_combine_row, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001860 png_bytep old_row, png_const_bytep new_row));
Glenn Randers-Pehrson4daae302011-10-06 21:37:47 -05001861#endif /* PNG_READ_INTERLACING_SUPPORTED */
Guy Schalnat4ee97b01996-01-16 01:51:56 -06001862#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */
Guy Schalnat6d764711995-12-19 03:22:19 -06001863
John Bowler5d567862011-12-24 09:12:00 -06001864PNG_EXPORTA(94, png_voidp, png_malloc, (png_const_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001865 png_alloc_size_t size), PNG_ALLOCATED);
Glenn Randers-Pehrson0ffb71a2009-02-28 06:08:20 -06001866/* Added at libpng version 1.4.0 */
John Bowler5d567862011-12-24 09:12:00 -06001867PNG_EXPORTA(95, png_voidp, png_calloc, (png_const_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001868 png_alloc_size_t size), PNG_ALLOCATED);
Guy Schalnat0d580581995-07-20 02:43:20 -05001869
Glenn Randers-Pehrson07748d12002-05-25 11:12:10 -05001870/* Added at libpng version 1.2.4 */
John Bowler5d567862011-12-24 09:12:00 -06001871PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001872 png_alloc_size_t size), PNG_ALLOCATED);
Glenn Randers-Pehrson07748d12002-05-25 11:12:10 -05001873
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05001874/* Frees a pointer allocated by png_malloc() */
John Bowler5d567862011-12-24 09:12:00 -06001875PNG_EXPORT(97, void, png_free, (png_const_structrp png_ptr, png_voidp ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -05001876
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001877/* Free data that was allocated internally */
John Bowler5d567862011-12-24 09:12:00 -06001878PNG_EXPORT(98, void, png_free_data, (png_const_structrp png_ptr,
1879 png_inforp info_ptr, png_uint_32 free_me, int num));
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001880
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001881/* Reassign responsibility for freeing existing data, whether allocated
John Bowler40b26032011-12-22 08:09:15 -06001882 * by libpng or by the application; this works on the png_info structure passed
1883 * in, it does not change the state for other png_info structures.
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001884 *
1885 * It is unlikely that this function works correctly as of 1.6.0 and using it
1886 * may result either in memory leaks or double free of allocated data.
John Bowler40b26032011-12-22 08:09:15 -06001887 */
Glenn Randers-Pehrson6e8ba0f2014-03-03 20:17:01 -06001888PNG_EXPORT(99, void, png_data_freer, (png_const_structrp png_ptr,
1889 png_inforp info_ptr, int freer, png_uint_32 mask));
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001890
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001891/* Assignments for png_data_freer */
Glenn Randers-Pehrson38e6e772000-04-09 19:06:13 -05001892#define PNG_DESTROY_WILL_FREE_DATA 1
1893#define PNG_SET_WILL_FREE_DATA 1
1894#define PNG_USER_WILL_FREE_DATA 2
1895/* Flags for png_ptr->free_me and info_ptr->free_me */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001896#define PNG_FREE_HIST 0x0008
1897#define PNG_FREE_ICCP 0x0010
1898#define PNG_FREE_SPLT 0x0020
1899#define PNG_FREE_ROWS 0x0040
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001900#define PNG_FREE_PCAL 0x0080
1901#define PNG_FREE_SCAL 0x0100
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001902#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED
1903# define PNG_FREE_UNKN 0x0200
1904#endif
1905/* PNG_FREE_LIST 0x0400 removed in 1.6.0 because it is ignored */
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -05001906#define PNG_FREE_PLTE 0x1000
1907#define PNG_FREE_TRNS 0x2000
1908#define PNG_FREE_TEXT 0x4000
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05001909#define PNG_FREE_ALL 0x7fff
Glenn Randers-Pehrsonec61c232000-05-16 06:17:36 -05001910#define PNG_FREE_MUL 0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001911
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001912#ifdef PNG_USER_MEM_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06001913PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_const_structrp png_ptr,
John Bowlerd332c672011-12-21 17:36:12 -06001914 png_alloc_size_t size), PNG_ALLOCATED PNG_DEPRECATED);
John Bowler5d567862011-12-24 09:12:00 -06001915PNG_EXPORTA(101, void, png_free_default, (png_const_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001916 png_voidp ptr), PNG_DEPRECATED);
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06001917#endif
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -05001918
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001919#ifdef PNG_ERROR_TEXT_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05001920/* Fatal error in PNG image of libpng - can't continue */
John Bowler5d567862011-12-24 09:12:00 -06001921PNG_EXPORTA(102, void, png_error, (png_const_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06001922 png_const_charp error_message), PNG_NORETURN);
Guy Schalnat0d580581995-07-20 02:43:20 -05001923
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001924/* The same, but the chunk name is prepended to the error string. */
John Bowler5d567862011-12-24 09:12:00 -06001925PNG_EXPORTA(103, void, png_chunk_error, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001926 png_const_charp error_message), PNG_NORETURN);
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001927
Glenn Randers-Pehrsonfd107532009-11-10 05:59:22 -06001928#else
1929/* Fatal error in PNG image of libpng - can't continue */
John Bowler5d567862011-12-24 09:12:00 -06001930PNG_EXPORTA(104, void, png_err, (png_const_structrp png_ptr), PNG_NORETURN);
Glenn Randers-Pehrson103b0412014-02-16 08:34:41 -06001931# define png_error(s1,s2) png_err(s1)
1932# define png_chunk_error(s1,s2) png_err(s1)
Glenn Randers-Pehrsonfd107532009-11-10 05:59:22 -06001933#endif
1934
John Bowler88b77cc2011-05-05 06:49:55 -05001935#ifdef PNG_WARNINGS_SUPPORTED
Guy Schalnat6d764711995-12-19 03:22:19 -06001936/* Non-fatal error in libpng. Can continue, but may have a problem. */
John Bowler5d567862011-12-24 09:12:00 -06001937PNG_EXPORT(105, void, png_warning, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001938 png_const_charp warning_message));
Guy Schalnat0d580581995-07-20 02:43:20 -05001939
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001940/* Non-fatal error in libpng, chunk name is prepended to message. */
John Bowler5d567862011-12-24 09:12:00 -06001941PNG_EXPORT(106, void, png_chunk_warning, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001942 png_const_charp warning_message));
Glenn Randers-Pehrson103b0412014-02-16 08:34:41 -06001943#else
1944# define png_warning(s1,s2) ((void)(s1))
1945# define png_chunk_warning(s1,s2) ((void)(s1))
John Bowler88b77cc2011-05-05 06:49:55 -05001946#endif
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -06001947
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001948#ifdef PNG_BENIGN_ERRORS_SUPPORTED
1949/* Benign error in libpng. Can continue, but may have a problem.
1950 * User can choose whether to handle as a fatal error or as a warning. */
John Bowler5d567862011-12-24 09:12:00 -06001951PNG_EXPORT(107, void, png_benign_error, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001952 png_const_charp warning_message));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001953
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001954#ifdef PNG_READ_SUPPORTED
1955/* Same, chunk name is prepended to message (only during read) */
John Bowler5d567862011-12-24 09:12:00 -06001956PNG_EXPORT(108, void, png_chunk_benign_error, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001957 png_const_charp warning_message));
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06001958#endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001959
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06001960PNG_EXPORT(109, void, png_set_benign_errors,
John Bowler5d567862011-12-24 09:12:00 -06001961 (png_structrp png_ptr, int allowed));
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05001962#else
1963# ifdef PNG_ALLOW_BENIGN_ERRORS
1964# define png_benign_error png_warning
1965# define png_chunk_benign_error png_chunk_warning
1966# else
1967# define png_benign_error png_error
1968# define png_chunk_benign_error png_chunk_error
1969# endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05001970#endif
1971
Andreas Dilger47a0c421997-05-16 02:46:07 -05001972/* The png_set_<chunk> functions are for storing values in the png_info_struct.
1973 * Similarly, the png_get_<chunk> calls are used to read values from the
1974 * png_info_struct, either storing the parameters in the passed variables, or
1975 * setting pointers into the png_info_struct where the data is stored. The
1976 * png_get_<chunk> functions return a non-zero value if the data was available
1977 * in info_ptr, or return zero and do not change any of the parameters if the
1978 * data was not available.
1979 *
1980 * These functions should be used instead of directly accessing png_info
1981 * to avoid problems with future changes in the size and internal layout of
1982 * png_info_struct.
1983 */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001984/* Returns "flag" if chunk data is valid in info_ptr. */
John Bowler5d567862011-12-24 09:12:00 -06001985PNG_EXPORT(110, png_uint_32, png_get_valid, (png_const_structrp png_ptr,
1986 png_const_inforp info_ptr, png_uint_32 flag));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001987
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06001988/* Returns number of bytes needed to hold a transformed row. */
John Bowler5d567862011-12-24 09:12:00 -06001989PNG_EXPORT(111, png_size_t, png_get_rowbytes, (png_const_structrp png_ptr,
1990 png_const_inforp info_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05001991
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05001992#ifdef PNG_INFO_IMAGE_SUPPORTED
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001993/* Returns row_pointers, which is an array of pointers to scanlines that was
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05001994 * returned from png_read_png().
1995 */
John Bowler5d567862011-12-24 09:12:00 -06001996PNG_EXPORT(112, png_bytepp, png_get_rows, (png_const_structrp png_ptr,
1997 png_const_inforp info_ptr));
John Bowler40b26032011-12-22 08:09:15 -06001998
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001999/* Set row_pointers, which is an array of pointers to scanlines for use
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002000 * by png_write_png().
2001 */
John Bowler4f67e402011-12-28 08:43:37 -06002002PNG_EXPORT(113, void, png_set_rows, (png_const_structrp png_ptr,
2003 png_inforp info_ptr, png_bytepp row_pointers));
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06002004#endif
2005
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002006/* Returns number of color channels in image. */
John Bowler5d567862011-12-24 09:12:00 -06002007PNG_EXPORT(114, png_byte, png_get_channels, (png_const_structrp png_ptr,
2008 png_const_inforp info_ptr));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002009
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002010#ifdef PNG_EASY_ACCESS_SUPPORTED
2011/* Returns image width in pixels. */
John Bowler5d567862011-12-24 09:12:00 -06002012PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structrp png_ptr,
2013 png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002014
2015/* Returns image height in pixels. */
John Bowler5d567862011-12-24 09:12:00 -06002016PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structrp png_ptr,
2017 png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002018
2019/* Returns image bit_depth. */
John Bowler5d567862011-12-24 09:12:00 -06002020PNG_EXPORT(117, png_byte, png_get_bit_depth, (png_const_structrp png_ptr,
2021 png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002022
2023/* Returns image color_type. */
John Bowler5d567862011-12-24 09:12:00 -06002024PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structrp png_ptr,
2025 png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002026
2027/* Returns image filter_type. */
John Bowler5d567862011-12-24 09:12:00 -06002028PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structrp png_ptr,
2029 png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002030
2031/* Returns image interlace_type. */
John Bowler5d567862011-12-24 09:12:00 -06002032PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structrp png_ptr,
2033 png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002034
2035/* Returns image compression_type. */
John Bowler5d567862011-12-24 09:12:00 -06002036PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structrp png_ptr,
2037 png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002038
2039/* Returns image resolution in pixels per meter, from pHYs chunk data. */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002040PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter,
John Bowler5d567862011-12-24 09:12:00 -06002041 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002042PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter,
John Bowler5d567862011-12-24 09:12:00 -06002043 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002044PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter,
John Bowler5d567862011-12-24 09:12:00 -06002045 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002046
2047/* Returns pixel aspect ratio, computed from pHYs chunk data. */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002048PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002049 (png_const_structrp png_ptr, png_const_inforp info_ptr))
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002050PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002051 (png_const_structrp png_ptr, png_const_inforp info_ptr))
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002052
2053/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002054PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels,
2055 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2056PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels,
2057 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002058PNG_EXPORT(128, png_int_32, png_get_x_offset_microns,
John Bowler5d567862011-12-24 09:12:00 -06002059 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002060PNG_EXPORT(129, png_int_32, png_get_y_offset_microns,
John Bowler5d567862011-12-24 09:12:00 -06002061 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -06002062
2063#endif /* PNG_EASY_ACCESS_SUPPORTED */
2064
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002065#ifdef PNG_READ_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -05002066/* Returns pointer to signature string read from PNG header */
John Bowler5d567862011-12-24 09:12:00 -06002067PNG_EXPORT(130, png_const_bytep, png_get_signature, (png_const_structrp png_ptr,
John Bowler4f67e402011-12-28 08:43:37 -06002068 png_const_inforp info_ptr));
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002069#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002070
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002071#ifdef PNG_bKGD_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002072PNG_EXPORT(131, png_uint_32, png_get_bKGD, (png_const_structrp png_ptr,
2073 png_inforp info_ptr, png_color_16p *background));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002074#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002075
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002076#ifdef PNG_bKGD_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002077PNG_EXPORT(132, void, png_set_bKGD, (png_const_structrp png_ptr,
2078 png_inforp info_ptr, png_const_color_16p background));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002079#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002080
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002081#ifdef PNG_cHRM_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002082PNG_FP_EXPORT(133, png_uint_32, png_get_cHRM, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002083 png_const_inforp info_ptr, double *white_x, double *white_y, double *red_x,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002084 double *red_y, double *green_x, double *green_y, double *blue_x,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002085 double *blue_y))
John Bowler5d567862011-12-24 09:12:00 -06002086PNG_FP_EXPORT(230, png_uint_32, png_get_cHRM_XYZ, (png_const_structrp png_ptr,
2087 png_const_inforp info_ptr, double *red_X, double *red_Y, double *red_Z,
John Bowler736f40f2011-08-25 16:19:44 -05002088 double *green_X, double *green_Y, double *green_Z, double *blue_X,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002089 double *blue_Y, double *blue_Z))
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002090PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed,
John Bowler5d567862011-12-24 09:12:00 -06002091 (png_const_structrp png_ptr, png_const_inforp info_ptr,
John Bowler40b26032011-12-22 08:09:15 -06002092 png_fixed_point *int_white_x, png_fixed_point *int_white_y,
2093 png_fixed_point *int_red_x, png_fixed_point *int_red_y,
2094 png_fixed_point *int_green_x, png_fixed_point *int_green_y,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002095 png_fixed_point *int_blue_x, png_fixed_point *int_blue_y))
John Bowler736f40f2011-08-25 16:19:44 -05002096PNG_FIXED_EXPORT(231, png_uint_32, png_get_cHRM_XYZ_fixed,
John Bowler5d567862011-12-24 09:12:00 -06002097 (png_const_structrp png_ptr, png_const_inforp info_ptr,
John Bowler736f40f2011-08-25 16:19:44 -05002098 png_fixed_point *int_red_X, png_fixed_point *int_red_Y,
2099 png_fixed_point *int_red_Z, png_fixed_point *int_green_X,
2100 png_fixed_point *int_green_Y, png_fixed_point *int_green_Z,
2101 png_fixed_point *int_blue_X, png_fixed_point *int_blue_Y,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002102 png_fixed_point *int_blue_Z))
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002103#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002104
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002105#ifdef PNG_cHRM_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002106PNG_FP_EXPORT(135, void, png_set_cHRM, (png_const_structrp png_ptr,
2107 png_inforp info_ptr,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002108 double white_x, double white_y, double red_x, double red_y, double green_x,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002109 double green_y, double blue_x, double blue_y))
John Bowler4f67e402011-12-28 08:43:37 -06002110PNG_FP_EXPORT(232, void, png_set_cHRM_XYZ, (png_const_structrp png_ptr,
John Bowler5d567862011-12-24 09:12:00 -06002111 png_inforp info_ptr, double red_X, double red_Y, double red_Z,
John Bowler736f40f2011-08-25 16:19:44 -05002112 double green_X, double green_Y, double green_Z, double blue_X,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002113 double blue_Y, double blue_Z))
John Bowler4f67e402011-12-28 08:43:37 -06002114PNG_FIXED_EXPORT(136, void, png_set_cHRM_fixed, (png_const_structrp png_ptr,
John Bowler5d567862011-12-24 09:12:00 -06002115 png_inforp info_ptr, png_fixed_point int_white_x,
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002116 png_fixed_point int_white_y, png_fixed_point int_red_x,
2117 png_fixed_point int_red_y, png_fixed_point int_green_x,
2118 png_fixed_point int_green_y, png_fixed_point int_blue_x,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002119 png_fixed_point int_blue_y))
John Bowler4f67e402011-12-28 08:43:37 -06002120PNG_FIXED_EXPORT(233, void, png_set_cHRM_XYZ_fixed, (png_const_structrp png_ptr,
John Bowler5d567862011-12-24 09:12:00 -06002121 png_inforp info_ptr, png_fixed_point int_red_X, png_fixed_point int_red_Y,
John Bowler736f40f2011-08-25 16:19:44 -05002122 png_fixed_point int_red_Z, png_fixed_point int_green_X,
2123 png_fixed_point int_green_Y, png_fixed_point int_green_Z,
2124 png_fixed_point int_blue_X, png_fixed_point int_blue_Y,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002125 png_fixed_point int_blue_Z))
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002126#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002127
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002128#ifdef PNG_gAMA_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002129PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002130 png_const_inforp info_ptr, double *file_gamma))
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002131PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed,
John Bowler5d567862011-12-24 09:12:00 -06002132 (png_const_structrp png_ptr, png_const_inforp info_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002133 png_fixed_point *int_file_gamma))
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002134#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002135
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002136#ifdef PNG_gAMA_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002137PNG_FP_EXPORT(139, void, png_set_gAMA, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002138 png_inforp info_ptr, double file_gamma))
John Bowler4f67e402011-12-28 08:43:37 -06002139PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002140 png_inforp info_ptr, png_fixed_point int_file_gamma))
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002141#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002142
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002143#ifdef PNG_hIST_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002144PNG_EXPORT(141, png_uint_32, png_get_hIST, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002145 png_inforp info_ptr, png_uint_16p *hist));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002146#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002147
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002148#ifdef PNG_hIST_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002149PNG_EXPORT(142, void, png_set_hIST, (png_const_structrp png_ptr,
2150 png_inforp info_ptr, png_const_uint_16p hist));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002151#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002152
John Bowler5d567862011-12-24 09:12:00 -06002153PNG_EXPORT(143, png_uint_32, png_get_IHDR, (png_const_structrp png_ptr,
John Bowler4f67e402011-12-28 08:43:37 -06002154 png_const_inforp info_ptr, png_uint_32 *width, png_uint_32 *height,
John Bowler40b26032011-12-22 08:09:15 -06002155 int *bit_depth, int *color_type, int *interlace_method,
2156 int *compression_method, int *filter_method));
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002157
John Bowler4f67e402011-12-28 08:43:37 -06002158PNG_EXPORT(144, void, png_set_IHDR, (png_const_structrp png_ptr,
2159 png_inforp info_ptr, png_uint_32 width, png_uint_32 height, int bit_depth,
2160 int color_type, int interlace_method, int compression_method,
2161 int filter_method));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002162
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002163#ifdef PNG_oFFs_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002164PNG_EXPORT(145, png_uint_32, png_get_oFFs, (png_const_structrp png_ptr,
2165 png_const_inforp info_ptr, png_int_32 *offset_x, png_int_32 *offset_y,
John Bowler40b26032011-12-22 08:09:15 -06002166 int *unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002167#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002168
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002169#ifdef PNG_oFFs_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002170PNG_EXPORT(146, void, png_set_oFFs, (png_const_structrp png_ptr,
2171 png_inforp info_ptr, png_int_32 offset_x, png_int_32 offset_y,
2172 int unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002173#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002174
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002175#ifdef PNG_pCAL_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002176PNG_EXPORT(147, png_uint_32, png_get_pCAL, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002177 png_inforp info_ptr, png_charp *purpose, png_int_32 *X0,
John Bowler40b26032011-12-22 08:09:15 -06002178 png_int_32 *X1, int *type, int *nparams, png_charp *units,
2179 png_charpp *params));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002180#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002181
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002182#ifdef PNG_pCAL_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002183PNG_EXPORT(148, void, png_set_pCAL, (png_const_structrp png_ptr,
2184 png_inforp info_ptr, png_const_charp purpose, png_int_32 X0, png_int_32 X1,
2185 int type, int nparams, png_const_charp units, png_charpp params));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002186#endif
2187
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002188#ifdef PNG_pHYs_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002189PNG_EXPORT(149, png_uint_32, png_get_pHYs, (png_const_structrp png_ptr,
2190 png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
John Bowler40b26032011-12-22 08:09:15 -06002191 int *unit_type));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002192#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002193
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002194#ifdef PNG_pHYs_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002195PNG_EXPORT(150, void, png_set_pHYs, (png_const_structrp png_ptr,
2196 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 -06002197#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002198
John Bowler5d567862011-12-24 09:12:00 -06002199PNG_EXPORT(151, png_uint_32, png_get_PLTE, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002200 png_inforp info_ptr, png_colorp *palette, int *num_palette));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002201
John Bowler4f67e402011-12-28 08:43:37 -06002202PNG_EXPORT(152, void, png_set_PLTE, (png_structrp png_ptr,
2203 png_inforp info_ptr, png_const_colorp palette, int num_palette));
Andreas Dilger47a0c421997-05-16 02:46:07 -05002204
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002205#ifdef PNG_sBIT_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002206PNG_EXPORT(153, png_uint_32, png_get_sBIT, (png_const_structrp png_ptr,
2207 png_inforp info_ptr, png_color_8p *sig_bit));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002208#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002209
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002210#ifdef PNG_sBIT_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002211PNG_EXPORT(154, void, png_set_sBIT, (png_const_structrp png_ptr,
2212 png_inforp info_ptr, png_const_color_8p sig_bit));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002213#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002214
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002215#ifdef PNG_sRGB_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002216PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structrp png_ptr,
2217 png_const_inforp info_ptr, int *file_srgb_intent));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002218#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06002219
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002220#ifdef PNG_sRGB_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002221PNG_EXPORT(156, void, png_set_sRGB, (png_const_structrp png_ptr,
2222 png_inforp info_ptr, int srgb_intent));
2223PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_const_structrp png_ptr,
John Bowler5d567862011-12-24 09:12:00 -06002224 png_inforp info_ptr, int srgb_intent));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002225#endif
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06002226
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002227#ifdef PNG_iCCP_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002228PNG_EXPORT(158, png_uint_32, png_get_iCCP, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002229 png_inforp info_ptr, png_charpp name, int *compression_type,
John Bowler40b26032011-12-22 08:09:15 -06002230 png_bytepp profile, png_uint_32 *proflen));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002231#endif
2232
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002233#ifdef PNG_iCCP_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002234PNG_EXPORT(159, void, png_set_iCCP, (png_const_structrp png_ptr,
2235 png_inforp info_ptr, png_const_charp name, int compression_type,
2236 png_const_bytep profile, png_uint_32 proflen));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002237#endif
2238
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002239#ifdef PNG_sPLT_SUPPORTED
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002240PNG_EXPORT(160, int, png_get_sPLT, (png_const_structrp png_ptr,
2241 png_inforp info_ptr, png_sPLT_tpp entries));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002242#endif
2243
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002244#ifdef PNG_sPLT_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002245PNG_EXPORT(161, void, png_set_sPLT, (png_const_structrp png_ptr,
2246 png_inforp info_ptr, png_const_sPLT_tp entries, int nentries));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002247#endif
2248
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002249#ifdef PNG_TEXT_SUPPORTED
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002250/* png_get_text also returns the number of text chunks in *num_text */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002251PNG_EXPORT(162, int, png_get_text, (png_const_structrp png_ptr,
2252 png_inforp info_ptr, png_textp *text_ptr, int *num_text));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002253#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002254
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002255/* Note while png_set_text() will accept a structure whose text,
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002256 * language, and translated keywords are NULL pointers, the structure
2257 * returned by png_get_text will always contain regular
2258 * zero-terminated C strings. They might be empty strings but
2259 * they will never be NULL pointers.
Glenn Randers-Pehrson4accabb2000-04-14 14:20:47 -05002260 */
2261
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002262#ifdef PNG_TEXT_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002263PNG_EXPORT(163, void, png_set_text, (png_const_structrp png_ptr,
2264 png_inforp info_ptr, png_const_textp text_ptr, int num_text));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002265#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002266
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002267#ifdef PNG_tIME_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002268PNG_EXPORT(164, png_uint_32, png_get_tIME, (png_const_structrp png_ptr,
2269 png_inforp info_ptr, png_timep *mod_time));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002270#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002271
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002272#ifdef PNG_tIME_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002273PNG_EXPORT(165, void, png_set_tIME, (png_const_structrp png_ptr,
2274 png_inforp info_ptr, png_const_timep mod_time));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002275#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002276
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002277#ifdef PNG_tRNS_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002278PNG_EXPORT(166, png_uint_32, png_get_tRNS, (png_const_structrp png_ptr,
2279 png_inforp info_ptr, png_bytep *trans_alpha, int *num_trans,
John Bowler40b26032011-12-22 08:09:15 -06002280 png_color_16p *trans_color));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002281#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002282
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002283#ifdef PNG_tRNS_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002284PNG_EXPORT(167, void, png_set_tRNS, (png_structrp png_ptr,
2285 png_inforp info_ptr, png_const_bytep trans_alpha, int num_trans,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002286 png_const_color_16p trans_color));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002287#endif
2288
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002289#ifdef PNG_sCAL_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002290PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002291 png_const_inforp info_ptr, int *unit, double *width, double *height))
2292#if defined(PNG_FLOATING_ARITHMETIC_SUPPORTED) || \
2293 defined(PNG_FLOATING_POINT_SUPPORTED)
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002294/* NOTE: this API is currently implemented using floating point arithmetic,
Glenn Randers-Pehrson48dc6eb2010-07-31 07:09:58 -05002295 * consequently it can only be used on systems with floating point support.
2296 * In any case the range of values supported by png_fixed_point is small and it
2297 * is highly recommended that png_get_sCAL_s be used instead.
2298 */
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002299PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed,
John Bowler5d567862011-12-24 09:12:00 -06002300 (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002301 png_fixed_point *width, png_fixed_point *height))
Glenn Randers-Pehrson48dc6eb2010-07-31 07:09:58 -05002302#endif
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002303PNG_EXPORT(169, png_uint_32, png_get_sCAL_s,
John Bowler5d567862011-12-24 09:12:00 -06002304 (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,
John Bowler40b26032011-12-22 08:09:15 -06002305 png_charpp swidth, png_charpp sheight));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002306
John Bowler4f67e402011-12-28 08:43:37 -06002307PNG_FP_EXPORT(170, void, png_set_sCAL, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002308 png_inforp info_ptr, int unit, double width, double height))
John Bowler4f67e402011-12-28 08:43:37 -06002309PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_const_structrp png_ptr,
John Bowler5d567862011-12-24 09:12:00 -06002310 png_inforp info_ptr, int unit, png_fixed_point width,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002311 png_fixed_point height))
John Bowler4f67e402011-12-28 08:43:37 -06002312PNG_EXPORT(171, void, png_set_sCAL_s, (png_const_structrp png_ptr,
2313 png_inforp info_ptr, int unit,
2314 png_const_charp swidth, png_const_charp sheight));
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002315#endif /* PNG_sCAL_SUPPORTED */
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002316
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002317#ifdef PNG_SET_UNKNOWN_CHUNKS_SUPPORTED
2318/* Provide the default handling for all unknown chunks or, optionally, for
2319 * specific unknown chunks.
2320 *
2321 * NOTE: prior to 1.6.0 the handling specified for particular chunks on read was
2322 * ignored and the default was used, the per-chunk setting only had an effect on
2323 * write. If you wish to have chunk-specific handling on read in code that must
2324 * work on earlier versions you must use a user chunk callback to specify the
2325 * desired handling (keep or discard.)
2326 *
2327 * The 'keep' parameter is a PNG_HANDLE_CHUNK_ value as listed below. The
2328 * parameter is interpreted as follows:
2329 *
2330 * READ:
2331 * PNG_HANDLE_CHUNK_AS_DEFAULT:
2332 * Known chunks: do normal libpng processing, do not keep the chunk (but
2333 * see the comments below about PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
2334 * Unknown chunks: for a specific chunk use the global default, when used
2335 * as the default discard the chunk data.
2336 * PNG_HANDLE_CHUNK_NEVER:
2337 * Discard the chunk data.
2338 * PNG_HANDLE_CHUNK_IF_SAFE:
2339 * Keep the chunk data if the chunk is not critical else raise a chunk
2340 * error.
2341 * PNG_HANDLE_CHUNK_ALWAYS:
2342 * Keep the chunk data.
2343 *
2344 * If the chunk data is saved it can be retrieved using png_get_unknown_chunks,
2345 * below. Notice that specifying "AS_DEFAULT" as a global default is equivalent
2346 * to specifying "NEVER", however when "AS_DEFAULT" is used for specific chunks
2347 * it simply resets the behavior to the libpng default.
2348 *
John Bowlere15b5372013-03-02 17:59:43 -06002349 * INTERACTION WTIH USER CHUNK CALLBACKS:
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002350 * The per-chunk handling is always used when there is a png_user_chunk_ptr
2351 * callback and the callback returns 0; the chunk is then always stored *unless*
2352 * it is critical and the per-chunk setting is other than ALWAYS. Notice that
2353 * the global default is *not* used in this case. (In effect the per-chunk
2354 * value is incremented to at least IF_SAFE.)
2355 *
John Bowlere15b5372013-03-02 17:59:43 -06002356 * IMPORTANT NOTE: this behavior will change in libpng 1.7 - the global and
2357 * per-chunk defaults will be honored. If you want to preserve the current
2358 * behavior when your callback returns 0 you must set PNG_HANDLE_CHUNK_IF_SAFE
2359 * as the default - if you don't do this libpng 1.6 will issue a warning.
2360 *
2361 * If you want unhandled unknown chunks to be discarded in libpng 1.6 and
2362 * earlier simply return '1' (handled).
2363 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002364 * PNG_HANDLE_AS_UNKNOWN_SUPPORTED:
2365 * If this is *not* set known chunks will always be handled by libpng and
2366 * will never be stored in the unknown chunk list. Known chunks listed to
2367 * png_set_keep_unknown_chunks will have no effect. If it is set then known
2368 * chunks listed with a keep other than AS_DEFAULT will *never* be processed
2369 * by libpng, in addition critical chunks must either be processed by the
2370 * callback or saved.
2371 *
2372 * The IHDR and IEND chunks must not be listed. Because this turns off the
2373 * default handling for chunks that would otherwise be recognized the
2374 * behavior of libpng transformations may well become incorrect!
2375 *
2376 * WRITE:
2377 * When writing chunks the options only apply to the chunks specified by
2378 * png_set_unknown_chunks (below), libpng will *always* write known chunks
2379 * required by png_set_ calls and will always write the core critical chunks
2380 * (as required for PLTE).
2381 *
2382 * Each chunk in the png_set_unknown_chunks list is looked up in the
2383 * png_set_keep_unknown_chunks list to find the keep setting, this is then
2384 * interpreted as follows:
2385 *
2386 * PNG_HANDLE_CHUNK_AS_DEFAULT:
2387 * Write safe-to-copy chunks and write other chunks if the global
2388 * default is set to _ALWAYS, otherwise don't write this chunk.
2389 * PNG_HANDLE_CHUNK_NEVER:
2390 * Do not write the chunk.
2391 * PNG_HANDLE_CHUNK_IF_SAFE:
2392 * Write the chunk if it is safe-to-copy, otherwise do not write it.
2393 * PNG_HANDLE_CHUNK_ALWAYS:
2394 * Write the chunk.
2395 *
2396 * Note that the default behavior is effectively the opposite of the read case -
2397 * in read unknown chunks are not stored by default, in write they are written
2398 * by default. Also the behavior of PNG_HANDLE_CHUNK_IF_SAFE is very different
2399 * - on write the safe-to-copy bit is checked, on read the critical bit is
2400 * checked and on read if the chunk is critical an error will be raised.
2401 *
2402 * num_chunks:
2403 * ===========
2404 * If num_chunks is positive, then the "keep" parameter specifies the manner
2405 * for handling only those chunks appearing in the chunk_list array,
2406 * otherwise the chunk list array is ignored.
2407 *
2408 * If num_chunks is 0 the "keep" parameter specifies the default behavior for
2409 * unknown chunks, as described above.
2410 *
2411 * If num_chunks is negative, then the "keep" parameter specifies the manner
2412 * for handling all unknown chunks plus all chunks recognized by libpng
2413 * except for the IHDR, PLTE, tRNS, IDAT, and IEND chunks (which continue to
2414 * be processed by libpng.
2415 */
John Bowler5d567862011-12-24 09:12:00 -06002416PNG_EXPORT(172, void, png_set_keep_unknown_chunks, (png_structrp png_ptr,
John Bowler40b26032011-12-22 08:09:15 -06002417 int keep, png_const_bytep chunk_list, int num_chunks));
Glenn Randers-Pehrsonbb5cb142011-09-22 12:41:58 -05002418
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002419/* The "keep" PNG_HANDLE_CHUNK_ parameter for the specified chunk is returned;
2420 * the result is therefore true (non-zero) if special handling is required,
2421 * false for the default handling.
Glenn Randers-Pehrsonbb5cb142011-09-22 12:41:58 -05002422 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002423PNG_EXPORT(173, int, png_handle_as_unknown, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002424 png_const_bytep chunk_name));
Glenn Randers-Pehrson7824a702009-06-13 10:05:05 -05002425#endif
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002426
2427#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED
John Bowler4f67e402011-12-28 08:43:37 -06002428PNG_EXPORT(174, void, png_set_unknown_chunks, (png_const_structrp png_ptr,
John Bowler5d567862011-12-24 09:12:00 -06002429 png_inforp info_ptr, png_const_unknown_chunkp unknowns,
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002430 int num_unknowns));
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002431 /* NOTE: prior to 1.6.0 this routine set the 'location' field of the added
2432 * unknowns to the location currently stored in the png_struct. This is
2433 * invariably the wrong value on write. To fix this call the following API
2434 * for each chunk in the list with the correct location. If you know your
2435 * code won't be compiled on earlier versions you can rely on
2436 * png_set_unknown_chunks(write-ptr, png_get_unknown_chunks(read-ptr)) doing
2437 * the correct thing.
2438 */
2439
John Bowler4f67e402011-12-28 08:43:37 -06002440PNG_EXPORT(175, void, png_set_unknown_chunk_location,
2441 (png_const_structrp png_ptr, png_inforp info_ptr, int chunk, int location));
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002442
John Bowler5d567862011-12-24 09:12:00 -06002443PNG_EXPORT(176, int, png_get_unknown_chunks, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002444 png_inforp info_ptr, png_unknown_chunkpp entries));
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06002445#endif
2446
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -05002447/* Png_free_data() will turn off the "valid" flag for anything it frees.
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002448 * If you need to turn it off for a chunk that your application has freed,
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002449 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
2450 */
John Bowler5d567862011-12-24 09:12:00 -06002451PNG_EXPORT(177, void, png_set_invalid, (png_const_structrp png_ptr,
2452 png_inforp info_ptr, int mask));
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002453
Glenn Randers-Pehrson4e6b5e92009-09-23 10:24:53 -05002454#ifdef PNG_INFO_IMAGE_SUPPORTED
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -05002455/* The "params" pointer is currently not used and is for future expansion. */
John Bowler414d7b52014-02-06 11:32:57 -06002456#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002457PNG_EXPORT(178, void, png_read_png, (png_structrp png_ptr, png_inforp info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002458 int transforms, png_voidp params));
John Bowler414d7b52014-02-06 11:32:57 -06002459#endif
2460#ifdef PNG_WRITE_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002461PNG_EXPORT(179, void, png_write_png, (png_structrp png_ptr, png_inforp info_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002462 int transforms, png_voidp params));
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -06002463#endif
John Bowler414d7b52014-02-06 11:32:57 -06002464#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -05002465
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002466PNG_EXPORT(180, png_const_charp, png_get_copyright,
John Bowler5d567862011-12-24 09:12:00 -06002467 (png_const_structrp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002468PNG_EXPORT(181, png_const_charp, png_get_header_ver,
John Bowler5d567862011-12-24 09:12:00 -06002469 (png_const_structrp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002470PNG_EXPORT(182, png_const_charp, png_get_header_version,
John Bowler5d567862011-12-24 09:12:00 -06002471 (png_const_structrp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002472PNG_EXPORT(183, png_const_charp, png_get_libpng_ver,
John Bowler5d567862011-12-24 09:12:00 -06002473 (png_const_structrp png_ptr));
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -06002474
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -06002475#ifdef PNG_MNG_FEATURES_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002476PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002477 png_uint_32 mng_features_permitted));
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -06002478#endif
2479
Glenn Randers-Pehrson8f3dd832004-08-10 09:43:42 -05002480/* For use in png_set_keep_unknown, added to version 1.2.6 */
2481#define PNG_HANDLE_CHUNK_AS_DEFAULT 0
2482#define PNG_HANDLE_CHUNK_NEVER 1
2483#define PNG_HANDLE_CHUNK_IF_SAFE 2
2484#define PNG_HANDLE_CHUNK_ALWAYS 3
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002485#define PNG_HANDLE_CHUNK_LAST 4
Glenn Randers-Pehrson8f3dd832004-08-10 09:43:42 -05002486
Glenn Randers-Pehrsone68f5a32001-05-14 09:20:53 -05002487/* Strip the prepended error numbers ("#nnn ") from error and warning
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002488 * messages before passing them to the error or warning handler.
2489 */
Glenn Randers-Pehrsone68f5a32001-05-14 09:20:53 -05002490#ifdef PNG_ERROR_NUMBERS_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002491PNG_EXPORT(185, void, png_set_strip_error_numbers, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002492 png_uint_32 strip_mode));
Glenn Randers-Pehrsonbe9de0f2001-01-22 08:52:16 -06002493#endif
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05002494
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002495/* Added in libpng-1.2.6 */
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05002496#ifdef PNG_SET_USER_LIMITS_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002497PNG_EXPORT(186, void, png_set_user_limits, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002498 png_uint_32 user_width_max, png_uint_32 user_height_max));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002499PNG_EXPORT(187, png_uint_32, png_get_user_width_max,
John Bowler5d567862011-12-24 09:12:00 -06002500 (png_const_structrp png_ptr));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002501PNG_EXPORT(188, png_uint_32, png_get_user_height_max,
John Bowler5d567862011-12-24 09:12:00 -06002502 (png_const_structrp png_ptr));
Glenn Randers-Pehrson800d1e92008-08-20 17:25:21 -05002503/* Added in libpng-1.4.0 */
John Bowler5d567862011-12-24 09:12:00 -06002504PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002505 png_uint_32 user_chunk_cache_max));
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002506PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max,
John Bowler5d567862011-12-24 09:12:00 -06002507 (png_const_structrp png_ptr));
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06002508/* Added in libpng-1.4.1 */
John Bowler5d567862011-12-24 09:12:00 -06002509PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002510 png_alloc_size_t user_chunk_cache_max));
2511PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max,
John Bowler5d567862011-12-24 09:12:00 -06002512 (png_const_structrp png_ptr));
Glenn Randers-Pehrson272489d2004-08-04 06:34:52 -05002513#endif
2514
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002515#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002516PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch,
John Bowler5d567862011-12-24 09:12:00 -06002517 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002518
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002519PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch,
John Bowler5d567862011-12-24 09:12:00 -06002520 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002521
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002522PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch,
John Bowler5d567862011-12-24 09:12:00 -06002523 (png_const_structrp png_ptr, png_const_inforp info_ptr));
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002524
Glenn Randers-Pehrsonb86b4922011-01-21 23:12:51 -06002525PNG_FP_EXPORT(196, float, png_get_x_offset_inches,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002526 (png_const_structrp png_ptr, png_const_inforp info_ptr))
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002527#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002528PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002529 (png_const_structrp png_ptr, png_const_inforp info_ptr))
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002530#endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002531
John Bowler5d567862011-12-24 09:12:00 -06002532PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_const_structrp png_ptr,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002533 png_const_inforp info_ptr))
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002534#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002535PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002536 (png_const_structrp png_ptr, png_const_inforp info_ptr))
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002537#endif
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002538
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06002539# ifdef PNG_pHYs_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002540PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structrp png_ptr,
2541 png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002542 int *unit_type));
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06002543# endif /* PNG_pHYs_SUPPORTED */
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05002544#endif /* PNG_INCH_CONVERSIONS_SUPPORTED */
Glenn Randers-Pehrson6bc53be2006-06-16 07:52:03 -05002545
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002546/* Added in libpng-1.4.0 */
2547#ifdef PNG_IO_STATE_SUPPORTED
John Bowler5d567862011-12-24 09:12:00 -06002548PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_const_structrp png_ptr));
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002549
John Bowler40b26032011-12-22 08:09:15 -06002550/* Removed from libpng 1.6; use png_get_io_chunk_type. */
John Bowler5d567862011-12-24 09:12:00 -06002551PNG_REMOVED(200, png_const_bytep, png_get_io_chunk_name, (png_structrp png_ptr),
John Bowler40b26032011-12-22 08:09:15 -06002552 PNG_DEPRECATED)
2553
Glenn Randers-Pehrsoncf7cce62011-01-22 12:42:43 -06002554PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type,
John Bowler5d567862011-12-24 09:12:00 -06002555 (png_const_structrp png_ptr));
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002556
2557/* The flags returned by png_get_io_state() are the following: */
Glenn Randers-Pehrsond4df36c2010-03-06 10:45:55 -06002558# define PNG_IO_NONE 0x0000 /* no I/O at this moment */
2559# define PNG_IO_READING 0x0001 /* currently reading */
2560# define PNG_IO_WRITING 0x0002 /* currently writing */
2561# define PNG_IO_SIGNATURE 0x0010 /* currently at the file signature */
2562# define PNG_IO_CHUNK_HDR 0x0020 /* currently at the chunk header */
2563# define PNG_IO_CHUNK_DATA 0x0040 /* currently at the chunk data */
2564# define PNG_IO_CHUNK_CRC 0x0080 /* currently at the chunk crc */
2565# define PNG_IO_MASK_OP 0x000f /* current operation: reading/writing */
2566# define PNG_IO_MASK_LOC 0x00f0 /* current location: sig/hdr/data/crc */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -05002567#endif /* ?PNG_IO_STATE_SUPPORTED */
2568
John Bowler660c6e42010-12-19 06:22:23 -06002569/* Interlace support. The following macros are always defined so that if
2570 * libpng interlace handling is turned off the macros may be used to handle
2571 * interlaced images within the application.
2572 */
2573#define PNG_INTERLACE_ADAM7_PASSES 7
2574
2575/* Two macros to return the first row and first column of the original,
2576 * full, image which appears in a given pass. 'pass' is in the range 0
2577 * to 6 and the result is in the range 0 to 7.
2578 */
John Bowler4e68aa72011-10-11 16:01:33 -05002579#define PNG_PASS_START_ROW(pass) (((1&~(pass))<<(3-((pass)>>1)))&7)
2580#define PNG_PASS_START_COL(pass) (((1& (pass))<<(3-(((pass)+1)>>1)))&7)
2581
2582/* A macro to return the offset between pixels in the output row for a pair of
2583 * pixels in the input - effectively the inverse of the 'COL_SHIFT' macro that
2584 * follows. Note that ROW_OFFSET is the offset from one row to the next whereas
2585 * COL_OFFSET is from one column to the next, within a row.
2586 */
2587#define PNG_PASS_ROW_OFFSET(pass) ((pass)>2?(8>>(((pass)-1)>>1)):8)
2588#define PNG_PASS_COL_OFFSET(pass) (1<<((7-(pass))>>1))
John Bowler660c6e42010-12-19 06:22:23 -06002589
2590/* Two macros to help evaluate the number of rows or columns in each
2591 * pass. This is expressed as a shift - effectively log2 of the number or
2592 * rows or columns in each 8x8 tile of the original image.
2593 */
2594#define PNG_PASS_ROW_SHIFT(pass) ((pass)>2?(8-(pass))>>1:3)
2595#define PNG_PASS_COL_SHIFT(pass) ((pass)>1?(7-(pass))>>1:3)
2596
2597/* Hence two macros to determine the number of rows or columns in a given
2598 * pass of an image given its height or width. In fact these macros may
2599 * return non-zero even though the sub-image is empty, because the other
2600 * dimension may be empty for a small image.
2601 */
2602#define PNG_PASS_ROWS(height, pass) (((height)+(((1<<PNG_PASS_ROW_SHIFT(pass))\
2603 -1)-PNG_PASS_START_ROW(pass)))>>PNG_PASS_ROW_SHIFT(pass))
2604#define PNG_PASS_COLS(width, pass) (((width)+(((1<<PNG_PASS_COL_SHIFT(pass))\
2605 -1)-PNG_PASS_START_COL(pass)))>>PNG_PASS_COL_SHIFT(pass))
2606
John Bowler9616ad92011-02-16 06:13:46 -06002607/* For the reader row callbacks (both progressive and sequential) it is
2608 * necessary to find the row in the output image given a row in an interlaced
2609 * image, so two more macros:
John Bowler660c6e42010-12-19 06:22:23 -06002610 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002611#define PNG_ROW_FROM_PASS_ROW(y_in, pass) \
2612 (((y_in)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass))
2613#define PNG_COL_FROM_PASS_COL(x_in, pass) \
2614 (((x_in)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass))
John Bowler660c6e42010-12-19 06:22:23 -06002615
2616/* Two macros which return a boolean (0 or 1) saying whether the given row
2617 * or column is in a particular pass. These use a common utility macro that
2618 * returns a mask for a given pass - the offset 'off' selects the row or
2619 * column version. The mask has the appropriate bit set for each column in
2620 * the tile.
2621 */
2622#define PNG_PASS_MASK(pass,off) ( \
John Bowler4e68aa72011-10-11 16:01:33 -05002623 ((0x110145AF>>(((7-(off))-(pass))<<2)) & 0xF) | \
2624 ((0x01145AF0>>(((7-(off))-(pass))<<2)) & 0xF0))
John Bowler660c6e42010-12-19 06:22:23 -06002625
2626#define PNG_ROW_IN_INTERLACE_PASS(y, pass) \
2627 ((PNG_PASS_MASK(pass,0) >> ((y)&7)) & 1)
2628#define PNG_COL_IN_INTERLACE_PASS(x, pass) \
2629 ((PNG_PASS_MASK(pass,1) >> ((x)&7)) & 1)
2630
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002631#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -05002632/* With these routines we avoid an integer divide, which will be slower on
2633 * most machines. However, it does take more operations than the corresponding
2634 * divide method, so it may be slower on a few RISC systems. There are two
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002635 * shifts (by 8 or 16 bits) and an addition, versus a single integer divide.
2636 *
2637 * Note that the rounding factors are NOT supposed to be the same! 128 and
2638 * 32768 are correct for the NODIV code; 127 and 32767 are correct for the
2639 * standard method.
2640 *
2641 * [Optimized code by Greg Roelofs and Mark Adler...blame us for bugs. :-) ]
2642 */
2643
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06002644 /* fg and bg should be in `gamma 1.0' space; alpha is the opacity */
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002645
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06002646# define png_composite(composite, fg, alpha, bg) \
2647 { png_uint_16 temp = (png_uint_16)((png_uint_16)(fg) \
2648 * (png_uint_16)(alpha) \
2649 + (png_uint_16)(bg)*(png_uint_16)(255 \
John Bowler75156122011-09-09 17:21:44 -05002650 - (png_uint_16)(alpha)) + 128); \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002651 (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002652
Glenn Randers-Pehrsone3f3c4e2010-02-07 18:08:50 -06002653# define png_composite_16(composite, fg, alpha, bg) \
2654 { png_uint_32 temp = (png_uint_32)((png_uint_32)(fg) \
2655 * (png_uint_32)(alpha) \
John Bowler75156122011-09-09 17:21:44 -05002656 + (png_uint_32)(bg)*(65535 \
2657 - (png_uint_32)(alpha)) + 32768); \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002658 (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }
2659
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002660#else /* Standard method using integer division */
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002661
Glenn Randers-Pehrsoneae8e362010-03-12 17:36:53 -06002662# define png_composite(composite, fg, alpha, bg) \
2663 (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) + \
Glenn Randers-Pehrsone8b1aa02010-03-06 11:39:29 -06002664 (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \
John Bowler75156122011-09-09 17:21:44 -05002665 127) / 255)
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -06002666
2667# define png_composite_16(composite, fg, alpha, bg) \
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002668 (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \
John Bowler75156122011-09-09 17:21:44 -05002669 (png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) + \
2670 32767) / 65535)
Glenn Randers-Pehrson1d963611998-05-02 12:52:25 -05002671#endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */
2672
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002673#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002674PNG_EXPORT(201, png_uint_32, png_get_uint_32, (png_const_bytep buf));
2675PNG_EXPORT(202, png_uint_16, png_get_uint_16, (png_const_bytep buf));
2676PNG_EXPORT(203, png_int_32, png_get_int_32, (png_const_bytep buf));
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002677#endif
2678
John Bowler5d567862011-12-24 09:12:00 -06002679PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_const_structrp png_ptr,
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002680 png_const_bytep buf));
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002681/* No png_get_int_16 -- may be added if there's a real need for it. */
2682
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05002683/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002684#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002685PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i));
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002686#endif
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05002687#ifdef PNG_SAVE_INT_32_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002688PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i));
Glenn Randers-Pehrson862cb202010-04-16 22:12:51 -05002689#endif
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002690
2691/* Place a 16-bit number into a buffer in PNG byte order.
Glenn Randers-Pehrsonc36bb792011-02-12 09:49:07 -06002692 * The parameter is declared unsigned int, not png_uint_16,
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002693 * just to avoid potential problems on pre-ANSI C compilers.
2694 */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002695#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
Glenn Randers-Pehrson23d39702010-12-06 18:28:02 -06002696PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i));
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002697/* No png_save_int_16 -- may be added if there's a real need for it. */
Glenn Randers-Pehrsonc3d73f42010-04-24 09:18:57 -05002698#endif
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06002699
John Bowlerf21a0d02011-01-23 23:55:19 -06002700#ifdef PNG_USE_READ_MACROS
2701/* Inline macros to do direct reads of bytes from the input buffer.
2702 * The png_get_int_32() routine assumes we are using two's complement
2703 * format for negative values, which is almost certainly true.
2704 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002705# define PNG_get_uint_32(buf) \
John Bowlerf21a0d02011-01-23 23:55:19 -06002706 (((png_uint_32)(*(buf)) << 24) + \
2707 ((png_uint_32)(*((buf) + 1)) << 16) + \
2708 ((png_uint_32)(*((buf) + 2)) << 8) + \
2709 ((png_uint_32)(*((buf) + 3))))
2710
2711 /* From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
2712 * function) incorrectly returned a value of type png_uint_32.
2713 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002714# define PNG_get_uint_16(buf) \
John Bowlerf21a0d02011-01-23 23:55:19 -06002715 ((png_uint_16) \
2716 (((unsigned int)(*(buf)) << 8) + \
2717 ((unsigned int)(*((buf) + 1)))))
2718
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002719# define PNG_get_int_32(buf) \
John Bowlerf21a0d02011-01-23 23:55:19 -06002720 ((png_int_32)((*(buf) & 0x80) \
2721 ? -((png_int_32)((png_get_uint_32(buf) ^ 0xffffffffL) + 1)) \
2722 : (png_int_32)png_get_uint_32(buf)))
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002723
2724 /* If PNG_PREFIX is defined the same thing as below happens in pnglibconf.h,
2725 * but defining a macro name prefixed with PNG_PREFIX.
2726 */
2727# ifndef PNG_PREFIX
2728# define png_get_uint_32(buf) PNG_get_uint_32(buf)
2729# define png_get_uint_16(buf) PNG_get_uint_16(buf)
2730# define png_get_int_32(buf) PNG_get_int_32(buf)
2731# endif
2732#else
2733# ifdef PNG_PREFIX
2734 /* No macros; revert to the (redefined) function */
2735# define PNG_get_uint_32 (png_get_uint_32)
2736# define PNG_get_uint_16 (png_get_uint_16)
2737# define PNG_get_int_32 (png_get_int_32)
2738# endif
John Bowlerf21a0d02011-01-23 23:55:19 -06002739#endif
2740
John Bowler7875d532011-11-07 22:33:49 -06002741/*******************************************************************************
2742 * SIMPLIFIED API
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002743 *******************************************************************************
2744 *
Glenn Randers-Pehrson5a956a72011-12-22 14:23:37 -06002745 * Please read the documentation in libpng-manual.txt (TODO: write said
2746 * documentation) if you don't understand what follows.
John Bowler7875d532011-11-07 22:33:49 -06002747 *
2748 * The simplified API hides the details of both libpng and the PNG file format
2749 * itself. It allows PNG files to be read into a very limited number of
2750 * in-memory bitmap formats or to be written from the same formats. If these
2751 * formats do not accomodate your needs then you can, and should, use the more
2752 * sophisticated APIs above - these support a wide variety of in-memory formats
2753 * and a wide variety of sophisticated transformations to those formats as well
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002754 * as a wide variety of APIs to manipulate ancillary information.
John Bowler7875d532011-11-07 22:33:49 -06002755 *
2756 * To read a PNG file using the simplified API:
2757 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002758 * 1) Declare a 'png_image' structure (see below) on the stack and set the
2759 * version field to PNG_IMAGE_VERSION.
John Bowler7875d532011-11-07 22:33:49 -06002760 * 2) Call the appropriate png_image_begin_read... function.
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002761 * 3) Set the png_image 'format' member to the required sample format.
2762 * 4) Allocate a buffer for the image and, if required, the color-map.
2763 * 5) Call png_image_finish_read to read the image and, if required, the
2764 * color-map into your buffers.
John Bowler7875d532011-11-07 22:33:49 -06002765 *
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002766 * There are no restrictions on the format of the PNG input itself; all valid
2767 * color types, bit depths, and interlace methods are acceptable, and the
2768 * input image is transformed as necessary to the requested in-memory format
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002769 * during the png_image_finish_read() step. The only caveat is that if you
2770 * request a color-mapped image from a PNG that is full-color or makes
2771 * complex use of an alpha channel the transformation is extremely lossy and the
2772 * result may look terrible.
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002773 *
John Bowler7875d532011-11-07 22:33:49 -06002774 * To write a PNG file using the simplified API:
2775 *
2776 * 1) Declare a 'png_image' structure on the stack and memset() it to all zero.
2777 * 2) Initialize the members of the structure that describe the image, setting
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002778 * the 'format' member to the format of the image samples.
John Bowler5bc90382012-01-23 22:43:22 -06002779 * 3) Call the appropriate png_image_write... function with a pointer to the
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002780 * image and, if necessary, the color-map to write the PNG data.
John Bowler7875d532011-11-07 22:33:49 -06002781 *
Glenn Randers-Pehrsonefc4b692011-11-07 23:31:34 -06002782 * png_image is a structure that describes the in-memory format of an image
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002783 * when it is being read or defines the in-memory format of an image that you
John Bowler7875d532011-11-07 22:33:49 -06002784 * need to write:
2785 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002786#define PNG_IMAGE_VERSION 1
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002787
John Bowler7875d532011-11-07 22:33:49 -06002788typedef struct png_control *png_controlp;
2789typedef struct
2790{
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002791 png_controlp opaque; /* Initialize to NULL, free with png_image_free */
2792 png_uint_32 version; /* Set to PNG_IMAGE_VERSION */
2793 png_uint_32 width; /* Image width in pixels (columns) */
2794 png_uint_32 height; /* Image height in pixels (rows) */
2795 png_uint_32 format; /* Image format as defined below */
2796 png_uint_32 flags; /* A bit mask containing informational flags */
2797 png_uint_32 colormap_entries;
2798 /* Number of entries in the color-map */
John Bowler04336ba2012-01-16 07:48:36 -06002799
John Bowler7875d532011-11-07 22:33:49 -06002800 /* In the event of an error or warning the following field will be set to a
2801 * non-zero value and the 'message' field will contain a '\0' terminated
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002802 * string with the libpng error or warning message. If both warnings and
2803 * an error were encountered, only the error is recorded. If there
2804 * are multiple warnings, only the first one is recorded.
2805 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002806 * The upper 30 bits of this value are reserved, the low two bits contain
2807 * a value as follows:
John Bowler04336ba2012-01-16 07:48:36 -06002808 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002809# define PNG_IMAGE_WARNING 1
2810# define PNG_IMAGE_ERROR 2
2811 /*
2812 * The result is a two bit code such that a value more than 1 indicates
2813 * a failure in the API just called:
2814 *
2815 * 0 - no warning or error
2816 * 1 - warning
2817 * 2 - error
2818 * 3 - error preceded by warning
2819 */
2820# define PNG_IMAGE_FAILED(png_cntrl) ((((png_cntrl).warning_or_error)&0x03)>1)
2821
John Bowler7875d532011-11-07 22:33:49 -06002822 png_uint_32 warning_or_error;
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002823
John Bowler7875d532011-11-07 22:33:49 -06002824 char message[64];
2825} png_image, *png_imagep;
2826
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002827/* The samples of the image have one to four channels whose components have
2828 * original values in the range 0 to 1.0:
John Bowler7875d532011-11-07 22:33:49 -06002829 *
2830 * 1: A single gray or luminance channel (G).
2831 * 2: A gray/luminance channel and an alpha channel (GA).
2832 * 3: Three red, green, blue color channels (RGB).
2833 * 4: Three color channels and an alpha channel (RGBA).
2834 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002835 * The components are encoded in one of two ways:
John Bowler7875d532011-11-07 22:33:49 -06002836 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002837 * a) As a small integer, value 0..255, contained in a single byte. For the
John Bowlerdd819152011-11-08 14:29:45 -06002838 * alpha channel the original value is simply value/255. For the color or
John Bowler7875d532011-11-07 22:33:49 -06002839 * luminance channels the value is encoded according to the sRGB specification
2840 * and matches the 8-bit format expected by typical display devices.
2841 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002842 * The color/gray channels are not scaled (pre-multiplied) by the alpha
John Bowler7875d532011-11-07 22:33:49 -06002843 * channel and are suitable for passing to color management software.
2844 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002845 * b) As a value in the range 0..65535, contained in a 2-byte integer. All
John Bowler7875d532011-11-07 22:33:49 -06002846 * channels can be converted to the original value by dividing by 65535; all
2847 * channels are linear. Color channels use the RGB encoding (RGB end-points) of
2848 * the sRGB specification. This encoding is identified by the
2849 * PNG_FORMAT_FLAG_LINEAR flag below.
2850 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002851 * When the simplified API needs to convert between sRGB and linear colorspaces,
2852 * the actual sRGB transfer curve defined in the sRGB specification (see the
2853 * article at http://en.wikipedia.org/wiki/SRGB) is used, not the gamma=1/2.2
2854 * approximation used elsewhere in libpng.
2855 *
2856 * When an alpha channel is present it is expected to denote pixel coverage
John Bowler7875d532011-11-07 22:33:49 -06002857 * of the color or luminance channels and is returned as an associated alpha
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002858 * channel: the color/gray channels are scaled (pre-multiplied) by the alpha
2859 * value.
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002860 *
2861 * The samples are either contained directly in the image data, between 1 and 8
2862 * bytes per pixel according to the encoding, or are held in a color-map indexed
2863 * by bytes in the image data. In the case of a color-map the color-map entries
2864 * are individual samples, encoded as above, and the image data has one byte per
2865 * pixel to select the relevant sample from the color-map.
John Bowler7875d532011-11-07 22:33:49 -06002866 */
2867
2868/* PNG_FORMAT_*
2869 *
2870 * #defines to be used in png_image::format. Each #define identifies a
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002871 * particular layout of sample data and, if present, alpha values. There are
2872 * separate defines for each of the two component encodings.
John Bowler7875d532011-11-07 22:33:49 -06002873 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002874 * A format is built up using single bit flag values. All combinations are
2875 * valid. Formats can be built up from the flag values or you can use one of
2876 * the predefined values below. When testing formats always use the FORMAT_FLAG
2877 * macros to test for individual features - future versions of the library may
2878 * add new flags.
2879 *
2880 * When reading or writing color-mapped images the format should be set to the
2881 * format of the entries in the color-map then png_image_{read,write}_colormap
2882 * called to read or write the color-map and set the format correctly for the
2883 * image data. Do not set the PNG_FORMAT_FLAG_COLORMAP bit directly!
John Bowler04336ba2012-01-16 07:48:36 -06002884 *
John Bowler7875d532011-11-07 22:33:49 -06002885 * NOTE: libpng can be built with particular features disabled, if you see
2886 * compiler errors because the definition of one of the following flags has been
2887 * compiled out it is because libpng does not have the required support. It is
2888 * possible, however, for the libpng configuration to enable the format on just
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06002889 * 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 -06002890 * guard against this by checking for the definition of the appropriate
2891 * "_SUPPORTED" macro, one of:
John Bowler7875d532011-11-07 22:33:49 -06002892 *
2893 * PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED
2894 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002895#define PNG_FORMAT_FLAG_ALPHA 0x01U /* format with an alpha channel */
2896#define PNG_FORMAT_FLAG_COLOR 0x02U /* color format: otherwise grayscale */
2897#define PNG_FORMAT_FLAG_LINEAR 0x04U /* 2 byte channels else 1 byte */
2898#define PNG_FORMAT_FLAG_COLORMAP 0x08U /* image data is color-mapped */
John Bowler7875d532011-11-07 22:33:49 -06002899
2900#ifdef PNG_FORMAT_BGR_SUPPORTED
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002901# define PNG_FORMAT_FLAG_BGR 0x10U /* BGR colors, else order is RGB */
John Bowler7875d532011-11-07 22:33:49 -06002902#endif
2903
2904#ifdef PNG_FORMAT_AFIRST_SUPPORTED
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002905# define PNG_FORMAT_FLAG_AFIRST 0x20U /* alpha channel comes first */
John Bowler7875d532011-11-07 22:33:49 -06002906#endif
2907
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002908/* Commonly used formats have predefined macros.
John Bowler7875d532011-11-07 22:33:49 -06002909 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002910 * First the single byte (sRGB) formats:
John Bowler7875d532011-11-07 22:33:49 -06002911 */
2912#define PNG_FORMAT_GRAY 0
2913#define PNG_FORMAT_GA PNG_FORMAT_FLAG_ALPHA
John Bowlerdd819152011-11-08 14:29:45 -06002914#define PNG_FORMAT_AG (PNG_FORMAT_GA|PNG_FORMAT_FLAG_AFIRST)
John Bowler7875d532011-11-07 22:33:49 -06002915#define PNG_FORMAT_RGB PNG_FORMAT_FLAG_COLOR
2916#define PNG_FORMAT_BGR (PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_BGR)
2917#define PNG_FORMAT_RGBA (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_ALPHA)
2918#define PNG_FORMAT_ARGB (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_AFIRST)
2919#define PNG_FORMAT_BGRA (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_ALPHA)
2920#define PNG_FORMAT_ABGR (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_AFIRST)
2921
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002922/* Then the linear 2-byte formats. When naming these "Y" is used to
2923 * indicate a luminance (gray) channel.
John Bowler7875d532011-11-07 22:33:49 -06002924 */
John Bowlerdd819152011-11-08 14:29:45 -06002925#define PNG_FORMAT_LINEAR_Y PNG_FORMAT_FLAG_LINEAR
2926#define PNG_FORMAT_LINEAR_Y_ALPHA (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_ALPHA)
2927#define PNG_FORMAT_LINEAR_RGB (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR)
2928#define PNG_FORMAT_LINEAR_RGB_ALPHA \
2929 (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA)
John Bowler7875d532011-11-07 22:33:49 -06002930
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002931/* With color-mapped formats the image data is one byte for each pixel, the byte
2932 * is an index into the color-map which is formatted as above. To obtain a
2933 * color-mapped format it is sufficient just to add the PNG_FOMAT_FLAG_COLORMAP
2934 * to one of the above definitions, or you can use one of the definitions below.
2935 */
2936#define PNG_FORMAT_RGB_COLORMAP (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_COLORMAP)
2937#define PNG_FORMAT_BGR_COLORMAP (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_COLORMAP)
2938#define PNG_FORMAT_RGBA_COLORMAP (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_COLORMAP)
2939#define PNG_FORMAT_ARGB_COLORMAP (PNG_FORMAT_ARGB|PNG_FORMAT_FLAG_COLORMAP)
2940#define PNG_FORMAT_BGRA_COLORMAP (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_COLORMAP)
2941#define PNG_FORMAT_ABGR_COLORMAP (PNG_FORMAT_ABGR|PNG_FORMAT_FLAG_COLORMAP)
2942
John Bowler7875d532011-11-07 22:33:49 -06002943/* PNG_IMAGE macros
2944 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002945 * These are convenience macros to derive information from a png_image
2946 * structure. The PNG_IMAGE_SAMPLE_ macros return values appropriate to the
2947 * actual image sample values - either the entries in the color-map or the
2948 * pixels in the image. The PNG_IMAGE_PIXEL_ macros return corresponding values
2949 * for the pixels and will always return 1 for color-mapped formats. The
2950 * remaining macros return information about the rows in the image and the
2951 * complete image.
2952 *
2953 * NOTE: All the macros that take a png_image::format parameter are compile time
2954 * constants if the format parameter is, itself, a constant. Therefore these
2955 * macros can be used in array declarations and case labels where required.
2956 * Similarly the macros are also pre-processor constants (sizeof is not used) so
2957 * they can be used in #if tests.
2958 *
2959 * First the information about the samples.
John Bowler7875d532011-11-07 22:33:49 -06002960 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002961#define PNG_IMAGE_SAMPLE_CHANNELS(fmt)\
2962 (((fmt)&(PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA))+1)
John Bowler7875d532011-11-07 22:33:49 -06002963 /* Return the total number of channels in a given format: 1..4 */
2964
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002965#define PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt)\
2966 ((((fmt) & PNG_FORMAT_FLAG_LINEAR) >> 2)+1)
2967 /* Return the size in bytes of a single component of a pixel or color-map
2968 * entry (as appropriate) in the image: 1 or 2.
2969 */
John Bowler7875d532011-11-07 22:33:49 -06002970
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06002971#define PNG_IMAGE_SAMPLE_SIZE(fmt)\
2972 (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt))
2973 /* This is the size of the sample data for one sample. If the image is
2974 * color-mapped it is the size of one color-map entry (and image pixels are
2975 * one byte in size), otherwise it is the size of one image pixel.
2976 */
2977
2978#define PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)\
2979 (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * 256)
2980 /* The maximum size of the color-map required by the format expressed in a
2981 * count of components. This can be used to compile-time allocate a
2982 * color-map:
2983 *
2984 * png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)];
2985 *
2986 * png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)];
2987 *
2988 * Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the
2989 * information from one of the png_image_begin_read_ APIs and dynamically
2990 * allocate the required memory.
2991 */
2992
2993/* Corresponding information about the pixels */
2994#define PNG_IMAGE_PIXEL_(test,fmt)\
2995 (((fmt)&PNG_FORMAT_FLAG_COLORMAP)?1:test(fmt))
2996
2997#define PNG_IMAGE_PIXEL_CHANNELS(fmt)\
2998 PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_CHANNELS,fmt)
2999 /* The number of separate channels (components) in a pixel; 1 for a
3000 * color-mapped image.
3001 */
3002
3003#define PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)\
3004 PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_COMPONENT_SIZE,fmt)
3005 /* The size, in bytes, of each component in a pixel; 1 for a color-mapped
3006 * image.
3007 */
3008
3009#define PNG_IMAGE_PIXEL_SIZE(fmt) PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_SIZE,fmt)
3010 /* The size, in bytes, of a complete pixel; 1 for a color-mapped image. */
3011
3012/* Information about the whole row, or whole image */
John Bowler7875d532011-11-07 22:33:49 -06003013#define PNG_IMAGE_ROW_STRIDE(image)\
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003014 (PNG_IMAGE_PIXEL_CHANNELS((image).format) * (image).width)
John Bowler7875d532011-11-07 22:33:49 -06003015 /* Return the total number of components in a single row of the image; this
3016 * is the minimum 'row stride', the minimum count of components between each
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003017 * row. For a color-mapped image this is the minimum number of bytes in a
Glenn Randers-Pehrsone0a6c062011-11-07 23:50:05 -06003018 * row.
3019 */
John Bowler7875d532011-11-07 22:33:49 -06003020
3021#define PNG_IMAGE_BUFFER_SIZE(image, row_stride)\
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003022 (PNG_IMAGE_PIXEL_COMPONENT_SIZE((image).format)*(image).height*(row_stride))
John Bowler7875d532011-11-07 22:33:49 -06003023 /* Return the size, in bytes, of an image buffer given a png_image and a row
Glenn Randers-Pehrsone0a6c062011-11-07 23:50:05 -06003024 * stride - the number of components to leave space for in each row.
3025 */
John Bowler7875d532011-11-07 22:33:49 -06003026
John Bowler3706d732011-11-21 10:28:06 -06003027#define PNG_IMAGE_SIZE(image)\
3028 PNG_IMAGE_BUFFER_SIZE(image, PNG_IMAGE_ROW_STRIDE(image))
3029 /* Return the size, in bytes, of the image in memory given just a png_image;
3030 * the row stride is the minimum stride required for the image.
3031 */
3032
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003033#define PNG_IMAGE_COLORMAP_SIZE(image)\
3034 (PNG_IMAGE_SAMPLE_SIZE((image).format) * (image).colormap_entries)
3035 /* Return the size, in bytes, of the color-map of this image. If the image
3036 * format is not a color-map format this will return a size sufficient for
3037 * 256 entries in the given format; check PNG_FORMAT_FLAG_COLORMAP if
3038 * you don't want to allocate a color-map in this case.
3039 */
3040
John Bowler7875d532011-11-07 22:33:49 -06003041/* PNG_IMAGE_FLAG_*
3042 *
3043 * Flags containing additional information about the image are held in the
3044 * 'flags' field of png_image.
3045 */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003046#define PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB 0x01
John Bowler7875d532011-11-07 22:33:49 -06003047 /* This indicates the the RGB values of the in-memory bitmap do not
3048 * correspond to the red, green and blue end-points defined by sRGB.
3049 */
3050
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003051#define PNG_IMAGE_FLAG_FAST 0x02
3052 /* On write emphasise speed over compression; the resultant PNG file will be
3053 * larger but will be produced significantly faster, particular for large
3054 * images. Do not use this option for images which will be distributed, only
3055 * used it when producing intermediate files that will be read back in
3056 * repeatedly. For a typical 24-bit image the option will double the read
3057 * speed at the cost of increasing the image size by 25%, however for many
3058 * more compressible images the PNG file can be 10 times larger with only a
3059 * slight speed gain.
3060 */
3061
John Bowler59ae3892013-03-06 22:15:25 -06003062#define PNG_IMAGE_FLAG_16BIT_sRGB 0x04
3063 /* On read if the image is a 16-bit per component image and there is no gAMA
3064 * or sRGB chunk assume that the components are sRGB encoded. Notice that
3065 * images output by the simplified API always have gamma information; setting
3066 * this flag only affects the interpretation of 16-bit images from an
3067 * external source. It is recommended that the application expose this flag
3068 * to the user; the user can normally easily recognize the difference between
3069 * linear and sRGB encoding. This flag has no effect on write - the data
3070 * passed to the write APIs must have the correct encoding (as defined
3071 * above.)
3072 *
3073 * If the flag is not set (the default) input 16-bit per component data is
3074 * assumed to be linear.
3075 *
3076 * NOTE: the flag can only be set after the png_image_begin_read_ call,
3077 * because that call initializes the 'flags' field.
3078 */
3079
John Bowler7875d532011-11-07 22:33:49 -06003080#ifdef PNG_SIMPLIFIED_READ_SUPPORTED
3081/* READ APIs
3082 * ---------
3083 *
3084 * The png_image passed to the read APIs must have been initialized by setting
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003085 * the png_controlp field 'opaque' to NULL (or, safer, memset the whole thing.)
John Bowler7875d532011-11-07 22:33:49 -06003086 */
3087#ifdef PNG_STDIO_SUPPORTED
3088PNG_EXPORT(234, int, png_image_begin_read_from_file, (png_imagep image,
3089 const char *file_name));
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06003090 /* The named file is opened for read and the image header is filled in
3091 * from the PNG header in the file.
Glenn Randers-Pehrsone0a6c062011-11-07 23:50:05 -06003092 */
John Bowler7875d532011-11-07 22:33:49 -06003093
3094PNG_EXPORT(235, int, png_image_begin_read_from_stdio, (png_imagep image,
3095 FILE* file));
3096 /* The PNG header is read from the stdio FILE object. */
3097#endif /* PNG_STDIO_SUPPORTED */
3098
3099PNG_EXPORT(236, int, png_image_begin_read_from_memory, (png_imagep image,
3100 png_const_voidp memory, png_size_t size));
3101 /* The PNG header is read from the given memory buffer. */
3102
3103PNG_EXPORT(237, int, png_image_finish_read, (png_imagep image,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003104 png_const_colorp background, void *buffer, png_int_32 row_stride,
3105 void *colormap));
John Bowler7875d532011-11-07 22:33:49 -06003106 /* Finish reading the image into the supplied buffer and clean up the
3107 * png_image structure.
3108 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003109 * row_stride is the step, in byte or 2-byte units as appropriate,
John Bowler7875d532011-11-07 22:33:49 -06003110 * between adjacent rows. A positive stride indicates that the top-most row
3111 * is first in the buffer - the normal top-down arrangement. A negative
3112 * stride indicates that the bottom-most row is first in the buffer.
3113 *
3114 * background need only be supplied if an alpha channel must be removed from
3115 * a png_byte format and the removal is to be done by compositing on a solid
3116 * color; otherwise it may be NULL and any composition will be done directly
3117 * onto the buffer. The value is an sRGB color to use for the background,
3118 * for grayscale output the green channel is used.
3119 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003120 * background must be supplied when an alpha channel must be removed from a
3121 * single byte color-mapped output format, in other words if:
3122 *
3123 * 1) The original format from png_image_begin_read_from_* had
3124 * PNG_FORMAT_FLAG_ALPHA set.
3125 * 2) The format set by the application does not.
3126 * 3) The format set by the application has PNG_FORMAT_FLAG_COLORMAP set and
3127 * PNG_FORMAT_FLAG_LINEAR *not* set.
3128 *
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06003129 * For linear output removing the alpha channel is always done by compositing
John Bowler59ae3892013-03-06 22:15:25 -06003130 * on black and background is ignored.
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003131 *
3132 * colormap must be supplied when PNG_FORMAT_FLAG_COLORMAP is set. It must
3133 * be at least the size (in bytes) returned by PNG_IMAGE_COLORMAP_SIZE.
3134 * image->colormap_entries will be updated to the actual number of entries
3135 * written to the colormap; this may be less than the original value.
John Bowler7875d532011-11-07 22:33:49 -06003136 */
3137
3138PNG_EXPORT(238, void, png_image_free, (png_imagep image));
3139 /* Free any data allocated by libpng in image->opaque, setting the pointer to
Glenn Randers-Pehrsone0a6c062011-11-07 23:50:05 -06003140 * NULL. May be called at any time after the structure is initialized.
3141 */
John Bowler7875d532011-11-07 22:33:49 -06003142#endif /* PNG_SIMPLIFIED_READ_SUPPORTED */
3143
3144#ifdef PNG_SIMPLIFIED_WRITE_SUPPORTED
Glenn Randers-Pehrson4a431822013-06-05 23:41:49 -05003145#ifdef PNG_STDIO_SUPPORTED
John Bowler7875d532011-11-07 22:33:49 -06003146/* WRITE APIS
3147 * ----------
3148 * For write you must initialize a png_image structure to describe the image to
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003149 * be written. To do this use memset to set the whole structure to 0 then
3150 * initialize fields describing your image.
John Bowler7875d532011-11-07 22:33:49 -06003151 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003152 * version: must be set to PNG_IMAGE_VERSION
John Bowler7875d532011-11-07 22:33:49 -06003153 * opaque: must be initialized to NULL
3154 * width: image width in pixels
3155 * height: image height in rows
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003156 * format: the format of the data (image and color-map) you wish to write
John Bowler7875d532011-11-07 22:33:49 -06003157 * flags: set to 0 unless one of the defined flags applies; set
3158 * PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images where the RGB
3159 * values do not correspond to the colors in sRGB.
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003160 * colormap_entries: set to the number of entries in the color-map (0 to 256)
John Bowler7875d532011-11-07 22:33:49 -06003161 */
3162PNG_EXPORT(239, int, png_image_write_to_file, (png_imagep image,
3163 const char *file, int convert_to_8bit, const void *buffer,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003164 png_int_32 row_stride, const void *colormap));
John Bowler7875d532011-11-07 22:33:49 -06003165 /* Write the image to the named file. */
3166
3167PNG_EXPORT(240, int, png_image_write_to_stdio, (png_imagep image, FILE *file,
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003168 int convert_to_8_bit, const void *buffer, png_int_32 row_stride,
3169 const void *colormap));
John Bowler7875d532011-11-07 22:33:49 -06003170 /* Write the image to the given (FILE*). */
3171
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003172/* With both write APIs if image is in one of the linear formats with 16-bit
3173 * data then setting convert_to_8_bit will cause the output to be an 8-bit PNG
3174 * gamma encoded according to the sRGB specification, otherwise a 16-bit linear
3175 * encoded PNG file is written.
3176 *
3177 * With color-mapped data formats the colormap parameter point to a color-map
3178 * with at least image->colormap_entries encoded in the specified format. If
3179 * the format is linear the written PNG color-map will be converted to sRGB
3180 * regardless of the convert_to_8_bit flag.
John Bowler7875d532011-11-07 22:33:49 -06003181 *
3182 * With all APIs row_stride is handled as in the read APIs - it is the spacing
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003183 * from one row to the next in component sized units (1 or 2 bytes) and if
3184 * negative indicates a bottom-up row layout in the buffer.
Glenn Randers-Pehrson84b0da92011-11-10 06:32:19 -06003185 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003186 * Note that the write API does not support interlacing or sub-8-bit pixels.
John Bowler7875d532011-11-07 22:33:49 -06003187 */
Glenn Randers-Pehrson4a431822013-06-05 23:41:49 -05003188#endif /* PNG_STDIO_SUPPORTED */
John Bowler7875d532011-11-07 22:33:49 -06003189#endif /* PNG_SIMPLIFIED_WRITE_SUPPORTED */
3190/*******************************************************************************
3191 * END OF SIMPLIFIED API
3192 ******************************************************************************/
3193
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003194#ifdef PNG_CHECK_FOR_INVALID_INDEX_SUPPORTED
3195PNG_EXPORT(242, void, png_set_check_for_invalid_index,
3196 (png_structrp png_ptr, int allowed));
3197# ifdef PNG_GET_PALETTE_MAX_SUPPORTED
3198PNG_EXPORT(243, int, png_get_palette_max, (png_const_structp png_ptr,
3199 png_const_infop info_ptr));
3200# endif
3201#endif /* CHECK_FOR_INVALID_INDEX */
3202
John Bowlerf3728102013-03-04 16:26:31 -06003203/*******************************************************************************
3204 * IMPLEMENTATION OPTIONS
3205 *******************************************************************************
3206 *
3207 * Support for arbitrary implementation-specific optimizations. The API allows
3208 * particular options to be turned on or off. 'Option' is the number of the
3209 * option and 'onoff' is 0 (off) or non-0 (on). The value returned is given
3210 * by the PNG_OPTION_ defines below.
3211 *
3212 * HARDWARE: normally hardware capabilites, such as the Intel SSE instructions,
3213 * are detected at run time, however sometimes it may be impossible
3214 * to do this in user mode, in which case it is necessary to discover
3215 * the capabilities in an OS specific way. Such capabilities are
3216 * listed here when libpng has support for them and must be turned
3217 * ON by the application if present.
3218 *
3219 * SOFTWARE: sometimes software optimizations actually result in performance
3220 * decrease on some architectures or systems, or with some sets of
3221 * PNG images. 'Software' options allow such optimizations to be
3222 * selected at run time.
3223 */
3224#ifdef PNG_SET_OPTION_SUPPORTED
3225#ifdef PNG_ARM_NEON_API_SUPPORTED
3226# define PNG_ARM_NEON 0 /* HARDWARE: ARM Neon SIMD instructions supported */
3227#endif
John Bowler0c7ac062013-05-07 21:59:05 -05003228#define PNG_MAXIMUM_INFLATE_WINDOW 2 /* SOFTWARE: force maximum window */
3229#define PNG_OPTION_NEXT 4 /* Next option - numbers must be even */
John Bowlerf3728102013-03-04 16:26:31 -06003230
3231/* Return values: NOTE: there are four values and 'off' is *not* zero */
3232#define PNG_OPTION_UNSET 0 /* Unset - defaults to off */
3233#define PNG_OPTION_INVALID 1 /* Option number out of range */
3234#define PNG_OPTION_OFF 2
3235#define PNG_OPTION_ON 3
3236
3237PNG_EXPORT(244, int, png_set_option, (png_structrp png_ptr, int option,
3238 int onoff));
3239#endif
3240
3241/*******************************************************************************
3242 * END OF HARDWARE OPTIONS
3243 ******************************************************************************/
3244
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05003245/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -06003246 * defs, scripts/pnglibconf.h, and scripts/pnglibconf.h.prebuilt
Glenn Randers-Pehrson31aee0d2010-07-29 17:39:14 -05003247 */
3248
Glenn Randers-Pehrson9f044c12010-12-07 14:59:43 -06003249/* The last ordinal number (this is the *last* one already used; the next
John Bowler71a10f22011-01-22 17:03:33 -06003250 * one to use is one more than this.) Maintainer, remember to add an entry to
3251 * scripts/symbols.def as well.
Glenn Randers-Pehrsonc551c0d2010-03-16 07:52:34 -05003252 */
3253#ifdef PNG_EXPORT_LAST_ORDINAL
John Bowlerf3728102013-03-04 16:26:31 -06003254 PNG_EXPORT_LAST_ORDINAL(244);
Glenn Randers-Pehrsonc551c0d2010-03-16 07:52:34 -05003255#endif
3256
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06003257#ifdef __cplusplus
3258}
3259#endif
3260
Glenn Randers-Pehrson1ef65b62000-05-12 06:19:53 -05003261#endif /* PNG_VERSION_INFO_ONLY */
Glenn Randers-Pehrson6c7a09a2009-06-15 21:57:39 -05003262/* Do not put anything past this line */
Glenn Randers-Pehrson13944802000-06-24 07:42:42 -05003263#endif /* PNG_H */