Tue, 06 Jan 2015 21:39:09 +0100
Conditionally force memory storage according to privacy.thirdparty.isolate;
This solves Tor bug #9701, complying with disk avoidance documented in
https://www.torproject.org/projects/torbrowser/design/#disk-avoidance.
michael@0 | 1 | |
michael@0 | 2 | /* png.h - header file for PNG reference library |
michael@0 | 3 | * |
michael@0 | 4 | * libpng version 1.6.10 - March 6, 2014 |
michael@0 | 5 | * Copyright (c) 1998-2014 Glenn Randers-Pehrson |
michael@0 | 6 | * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger) |
michael@0 | 7 | * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.) |
michael@0 | 8 | * |
michael@0 | 9 | * This code is released under the libpng license (See LICENSE, below) |
michael@0 | 10 | * |
michael@0 | 11 | * Authors and maintainers: |
michael@0 | 12 | * libpng versions 0.71, May 1995, through 0.88, January 1996: Guy Schalnat |
michael@0 | 13 | * libpng versions 0.89c, June 1996, through 0.96, May 1997: Andreas Dilger |
michael@0 | 14 | * libpng versions 0.97, January 1998, through 1.6.10 - March 6, 2014: Glenn |
michael@0 | 15 | * See also "Contributing Authors", below. |
michael@0 | 16 | * |
michael@0 | 17 | * Note about libpng version numbers: |
michael@0 | 18 | * |
michael@0 | 19 | * Due to various miscommunications, unforeseen code incompatibilities |
michael@0 | 20 | * and occasional factors outside the authors' control, version numbering |
michael@0 | 21 | * on the library has not always been consistent and straightforward. |
michael@0 | 22 | * The following table summarizes matters since version 0.89c, which was |
michael@0 | 23 | * the first widely used release: |
michael@0 | 24 | * |
michael@0 | 25 | * source png.h png.h shared-lib |
michael@0 | 26 | * version string int version |
michael@0 | 27 | * ------- ------ ----- ---------- |
michael@0 | 28 | * 0.89c "1.0 beta 3" 0.89 89 1.0.89 |
michael@0 | 29 | * 0.90 "1.0 beta 4" 0.90 90 0.90 [should have been 2.0.90] |
michael@0 | 30 | * 0.95 "1.0 beta 5" 0.95 95 0.95 [should have been 2.0.95] |
michael@0 | 31 | * 0.96 "1.0 beta 6" 0.96 96 0.96 [should have been 2.0.96] |
michael@0 | 32 | * 0.97b "1.00.97 beta 7" 1.00.97 97 1.0.1 [should have been 2.0.97] |
michael@0 | 33 | * 0.97c 0.97 97 2.0.97 |
michael@0 | 34 | * 0.98 0.98 98 2.0.98 |
michael@0 | 35 | * 0.99 0.99 98 2.0.99 |
michael@0 | 36 | * 0.99a-m 0.99 99 2.0.99 |
michael@0 | 37 | * 1.00 1.00 100 2.1.0 [100 should be 10000] |
michael@0 | 38 | * 1.0.0 (from here on, the 100 2.1.0 [100 should be 10000] |
michael@0 | 39 | * 1.0.1 png.h string is 10001 2.1.0 |
michael@0 | 40 | * 1.0.1a-e identical to the 10002 from here on, the shared library |
michael@0 | 41 | * 1.0.2 source version) 10002 is 2.V where V is the source code |
michael@0 | 42 | * 1.0.2a-b 10003 version, except as noted. |
michael@0 | 43 | * 1.0.3 10003 |
michael@0 | 44 | * 1.0.3a-d 10004 |
michael@0 | 45 | * 1.0.4 10004 |
michael@0 | 46 | * 1.0.4a-f 10005 |
michael@0 | 47 | * 1.0.5 (+ 2 patches) 10005 |
michael@0 | 48 | * 1.0.5a-d 10006 |
michael@0 | 49 | * 1.0.5e-r 10100 (not source compatible) |
michael@0 | 50 | * 1.0.5s-v 10006 (not binary compatible) |
michael@0 | 51 | * 1.0.6 (+ 3 patches) 10006 (still binary incompatible) |
michael@0 | 52 | * 1.0.6d-f 10007 (still binary incompatible) |
michael@0 | 53 | * 1.0.6g 10007 |
michael@0 | 54 | * 1.0.6h 10007 10.6h (testing xy.z so-numbering) |
michael@0 | 55 | * 1.0.6i 10007 10.6i |
michael@0 | 56 | * 1.0.6j 10007 2.1.0.6j (incompatible with 1.0.0) |
michael@0 | 57 | * 1.0.7beta11-14 DLLNUM 10007 2.1.0.7beta11-14 (binary compatible) |
michael@0 | 58 | * 1.0.7beta15-18 1 10007 2.1.0.7beta15-18 (binary compatible) |
michael@0 | 59 | * 1.0.7rc1-2 1 10007 2.1.0.7rc1-2 (binary compatible) |
michael@0 | 60 | * 1.0.7 1 10007 (still compatible) |
michael@0 | 61 | * 1.0.8beta1-4 1 10008 2.1.0.8beta1-4 |
michael@0 | 62 | * 1.0.8rc1 1 10008 2.1.0.8rc1 |
michael@0 | 63 | * 1.0.8 1 10008 2.1.0.8 |
michael@0 | 64 | * 1.0.9beta1-6 1 10009 2.1.0.9beta1-6 |
michael@0 | 65 | * 1.0.9rc1 1 10009 2.1.0.9rc1 |
michael@0 | 66 | * 1.0.9beta7-10 1 10009 2.1.0.9beta7-10 |
michael@0 | 67 | * 1.0.9rc2 1 10009 2.1.0.9rc2 |
michael@0 | 68 | * 1.0.9 1 10009 2.1.0.9 |
michael@0 | 69 | * 1.0.10beta1 1 10010 2.1.0.10beta1 |
michael@0 | 70 | * 1.0.10rc1 1 10010 2.1.0.10rc1 |
michael@0 | 71 | * 1.0.10 1 10010 2.1.0.10 |
michael@0 | 72 | * 1.0.11beta1-3 1 10011 2.1.0.11beta1-3 |
michael@0 | 73 | * 1.0.11rc1 1 10011 2.1.0.11rc1 |
michael@0 | 74 | * 1.0.11 1 10011 2.1.0.11 |
michael@0 | 75 | * 1.0.12beta1-2 2 10012 2.1.0.12beta1-2 |
michael@0 | 76 | * 1.0.12rc1 2 10012 2.1.0.12rc1 |
michael@0 | 77 | * 1.0.12 2 10012 2.1.0.12 |
michael@0 | 78 | * 1.1.0a-f - 10100 2.1.1.0a-f (branch abandoned) |
michael@0 | 79 | * 1.2.0beta1-2 2 10200 2.1.2.0beta1-2 |
michael@0 | 80 | * 1.2.0beta3-5 3 10200 3.1.2.0beta3-5 |
michael@0 | 81 | * 1.2.0rc1 3 10200 3.1.2.0rc1 |
michael@0 | 82 | * 1.2.0 3 10200 3.1.2.0 |
michael@0 | 83 | * 1.2.1beta1-4 3 10201 3.1.2.1beta1-4 |
michael@0 | 84 | * 1.2.1rc1-2 3 10201 3.1.2.1rc1-2 |
michael@0 | 85 | * 1.2.1 3 10201 3.1.2.1 |
michael@0 | 86 | * 1.2.2beta1-6 12 10202 12.so.0.1.2.2beta1-6 |
michael@0 | 87 | * 1.0.13beta1 10 10013 10.so.0.1.0.13beta1 |
michael@0 | 88 | * 1.0.13rc1 10 10013 10.so.0.1.0.13rc1 |
michael@0 | 89 | * 1.2.2rc1 12 10202 12.so.0.1.2.2rc1 |
michael@0 | 90 | * 1.0.13 10 10013 10.so.0.1.0.13 |
michael@0 | 91 | * 1.2.2 12 10202 12.so.0.1.2.2 |
michael@0 | 92 | * 1.2.3rc1-6 12 10203 12.so.0.1.2.3rc1-6 |
michael@0 | 93 | * 1.2.3 12 10203 12.so.0.1.2.3 |
michael@0 | 94 | * 1.2.4beta1-3 13 10204 12.so.0.1.2.4beta1-3 |
michael@0 | 95 | * 1.0.14rc1 13 10014 10.so.0.1.0.14rc1 |
michael@0 | 96 | * 1.2.4rc1 13 10204 12.so.0.1.2.4rc1 |
michael@0 | 97 | * 1.0.14 10 10014 10.so.0.1.0.14 |
michael@0 | 98 | * 1.2.4 13 10204 12.so.0.1.2.4 |
michael@0 | 99 | * 1.2.5beta1-2 13 10205 12.so.0.1.2.5beta1-2 |
michael@0 | 100 | * 1.0.15rc1-3 10 10015 10.so.0.1.0.15rc1-3 |
michael@0 | 101 | * 1.2.5rc1-3 13 10205 12.so.0.1.2.5rc1-3 |
michael@0 | 102 | * 1.0.15 10 10015 10.so.0.1.0.15 |
michael@0 | 103 | * 1.2.5 13 10205 12.so.0.1.2.5 |
michael@0 | 104 | * 1.2.6beta1-4 13 10206 12.so.0.1.2.6beta1-4 |
michael@0 | 105 | * 1.0.16 10 10016 10.so.0.1.0.16 |
michael@0 | 106 | * 1.2.6 13 10206 12.so.0.1.2.6 |
michael@0 | 107 | * 1.2.7beta1-2 13 10207 12.so.0.1.2.7beta1-2 |
michael@0 | 108 | * 1.0.17rc1 10 10017 12.so.0.1.0.17rc1 |
michael@0 | 109 | * 1.2.7rc1 13 10207 12.so.0.1.2.7rc1 |
michael@0 | 110 | * 1.0.17 10 10017 12.so.0.1.0.17 |
michael@0 | 111 | * 1.2.7 13 10207 12.so.0.1.2.7 |
michael@0 | 112 | * 1.2.8beta1-5 13 10208 12.so.0.1.2.8beta1-5 |
michael@0 | 113 | * 1.0.18rc1-5 10 10018 12.so.0.1.0.18rc1-5 |
michael@0 | 114 | * 1.2.8rc1-5 13 10208 12.so.0.1.2.8rc1-5 |
michael@0 | 115 | * 1.0.18 10 10018 12.so.0.1.0.18 |
michael@0 | 116 | * 1.2.8 13 10208 12.so.0.1.2.8 |
michael@0 | 117 | * 1.2.9beta1-3 13 10209 12.so.0.1.2.9beta1-3 |
michael@0 | 118 | * 1.2.9beta4-11 13 10209 12.so.0.9[.0] |
michael@0 | 119 | * 1.2.9rc1 13 10209 12.so.0.9[.0] |
michael@0 | 120 | * 1.2.9 13 10209 12.so.0.9[.0] |
michael@0 | 121 | * 1.2.10beta1-7 13 10210 12.so.0.10[.0] |
michael@0 | 122 | * 1.2.10rc1-2 13 10210 12.so.0.10[.0] |
michael@0 | 123 | * 1.2.10 13 10210 12.so.0.10[.0] |
michael@0 | 124 | * 1.4.0beta1-5 14 10400 14.so.0.0[.0] |
michael@0 | 125 | * 1.2.11beta1-4 13 10211 12.so.0.11[.0] |
michael@0 | 126 | * 1.4.0beta7-8 14 10400 14.so.0.0[.0] |
michael@0 | 127 | * 1.2.11 13 10211 12.so.0.11[.0] |
michael@0 | 128 | * 1.2.12 13 10212 12.so.0.12[.0] |
michael@0 | 129 | * 1.4.0beta9-14 14 10400 14.so.0.0[.0] |
michael@0 | 130 | * 1.2.13 13 10213 12.so.0.13[.0] |
michael@0 | 131 | * 1.4.0beta15-36 14 10400 14.so.0.0[.0] |
michael@0 | 132 | * 1.4.0beta37-87 14 10400 14.so.14.0[.0] |
michael@0 | 133 | * 1.4.0rc01 14 10400 14.so.14.0[.0] |
michael@0 | 134 | * 1.4.0beta88-109 14 10400 14.so.14.0[.0] |
michael@0 | 135 | * 1.4.0rc02-08 14 10400 14.so.14.0[.0] |
michael@0 | 136 | * 1.4.0 14 10400 14.so.14.0[.0] |
michael@0 | 137 | * 1.4.1beta01-03 14 10401 14.so.14.1[.0] |
michael@0 | 138 | * 1.4.1rc01 14 10401 14.so.14.1[.0] |
michael@0 | 139 | * 1.4.1beta04-12 14 10401 14.so.14.1[.0] |
michael@0 | 140 | * 1.4.1 14 10401 14.so.14.1[.0] |
michael@0 | 141 | * 1.4.2 14 10402 14.so.14.2[.0] |
michael@0 | 142 | * 1.4.3 14 10403 14.so.14.3[.0] |
michael@0 | 143 | * 1.4.4 14 10404 14.so.14.4[.0] |
michael@0 | 144 | * 1.5.0beta01-58 15 10500 15.so.15.0[.0] |
michael@0 | 145 | * 1.5.0rc01-07 15 10500 15.so.15.0[.0] |
michael@0 | 146 | * 1.5.0 15 10500 15.so.15.0[.0] |
michael@0 | 147 | * 1.5.1beta01-11 15 10501 15.so.15.1[.0] |
michael@0 | 148 | * 1.5.1rc01-02 15 10501 15.so.15.1[.0] |
michael@0 | 149 | * 1.5.1 15 10501 15.so.15.1[.0] |
michael@0 | 150 | * 1.5.2beta01-03 15 10502 15.so.15.2[.0] |
michael@0 | 151 | * 1.5.2rc01-03 15 10502 15.so.15.2[.0] |
michael@0 | 152 | * 1.5.2 15 10502 15.so.15.2[.0] |
michael@0 | 153 | * 1.5.3beta01-10 15 10503 15.so.15.3[.0] |
michael@0 | 154 | * 1.5.3rc01-02 15 10503 15.so.15.3[.0] |
michael@0 | 155 | * 1.5.3beta11 15 10503 15.so.15.3[.0] |
michael@0 | 156 | * 1.5.3 [omitted] |
michael@0 | 157 | * 1.5.4beta01-08 15 10504 15.so.15.4[.0] |
michael@0 | 158 | * 1.5.4rc01 15 10504 15.so.15.4[.0] |
michael@0 | 159 | * 1.5.4 15 10504 15.so.15.4[.0] |
michael@0 | 160 | * 1.5.5beta01-08 15 10505 15.so.15.5[.0] |
michael@0 | 161 | * 1.5.5rc01 15 10505 15.so.15.5[.0] |
michael@0 | 162 | * 1.5.5 15 10505 15.so.15.5[.0] |
michael@0 | 163 | * 1.5.6beta01-07 15 10506 15.so.15.6[.0] |
michael@0 | 164 | * 1.5.6rc01-03 15 10506 15.so.15.6[.0] |
michael@0 | 165 | * 1.5.6 15 10506 15.so.15.6[.0] |
michael@0 | 166 | * 1.5.7beta01-05 15 10507 15.so.15.7[.0] |
michael@0 | 167 | * 1.5.7rc01-03 15 10507 15.so.15.7[.0] |
michael@0 | 168 | * 1.5.7 15 10507 15.so.15.7[.0] |
michael@0 | 169 | * 1.6.0beta01-40 16 10600 16.so.16.0[.0] |
michael@0 | 170 | * 1.6.0rc01-08 16 10600 16.so.16.0[.0] |
michael@0 | 171 | * 1.6.0 16 10600 16.so.16.0[.0] |
michael@0 | 172 | * 1.6.1beta01-09 16 10601 16.so.16.1[.0] |
michael@0 | 173 | * 1.6.1rc01 16 10601 16.so.16.1[.0] |
michael@0 | 174 | * 1.6.1 16 10601 16.so.16.1[.0] |
michael@0 | 175 | * 1.6.2beta01 16 10602 16.so.16.2[.0] |
michael@0 | 176 | * 1.6.2rc01-06 16 10602 16.so.16.2[.0] |
michael@0 | 177 | * 1.6.2 16 10602 16.so.16.2[.0] |
michael@0 | 178 | * 1.6.3beta01-11 16 10603 16.so.16.3[.0] |
michael@0 | 179 | * 1.6.3rc01 16 10603 16.so.16.3[.0] |
michael@0 | 180 | * 1.6.3 16 10603 16.so.16.3[.0] |
michael@0 | 181 | * 1.6.4beta01-02 16 10604 16.so.16.4[.0] |
michael@0 | 182 | * 1.6.4rc01 16 10604 16.so.16.4[.0] |
michael@0 | 183 | * 1.6.4 16 10604 16.so.16.4[.0] |
michael@0 | 184 | * 1.6.5 16 10605 16.so.16.5[.0] |
michael@0 | 185 | * 1.6.6 16 10606 16.so.16.6[.0] |
michael@0 | 186 | * 1.6.7beta01-04 16 10607 16.so.16.7[.0] |
michael@0 | 187 | * 1.6.7rc01-03 16 10607 16.so.16.7[.0] |
michael@0 | 188 | * 1.6.7 16 10607 16.so.16.7[.0] |
michael@0 | 189 | * 1.6.8beta01-02 16 10608 16.so.16.8[.0] |
michael@0 | 190 | * 1.6.8rc01-02 16 10608 16.so.16.8[.0] |
michael@0 | 191 | * 1.6.8 16 10608 16.so.16.8[.0] |
michael@0 | 192 | * 1.6.9beta01-04 16 10609 16.so.16.9[.0] |
michael@0 | 193 | * 1.6.9rc01-02 16 10609 16.so.16.9[.0] |
michael@0 | 194 | * 1.6.9 16 10609 16.so.16.9[.0] |
michael@0 | 195 | * 1.6.10beta01-03 16 10610 16.so.16.10[.0] |
michael@0 | 196 | * 1.6.10betarc01-04 16 10610 16.so.16.10[.0] |
michael@0 | 197 | * 1.6.10beta 16 10610 16.so.16.10[.0] |
michael@0 | 198 | * |
michael@0 | 199 | * Henceforth the source version will match the shared-library major |
michael@0 | 200 | * and minor numbers; the shared-library major version number will be |
michael@0 | 201 | * used for changes in backward compatibility, as it is intended. The |
michael@0 | 202 | * PNG_LIBPNG_VER macro, which is not used within libpng but is available |
michael@0 | 203 | * for applications, is an unsigned integer of the form xyyzz corresponding |
michael@0 | 204 | * to the source version x.y.z (leading zeros in y and z). Beta versions |
michael@0 | 205 | * were given the previous public release number plus a letter, until |
michael@0 | 206 | * version 1.0.6j; from then on they were given the upcoming public |
michael@0 | 207 | * release number plus "betaNN" or "rcNN". |
michael@0 | 208 | * |
michael@0 | 209 | * Binary incompatibility exists only when applications make direct access |
michael@0 | 210 | * to the info_ptr or png_ptr members through png.h, and the compiled |
michael@0 | 211 | * application is loaded with a different version of the library. |
michael@0 | 212 | * |
michael@0 | 213 | * DLLNUM will change each time there are forward or backward changes |
michael@0 | 214 | * in binary compatibility (e.g., when a new feature is added). |
michael@0 | 215 | * |
michael@0 | 216 | * See libpng-manual.txt or libpng.3 for more information. The PNG |
michael@0 | 217 | * specification is available as a W3C Recommendation and as an ISO |
michael@0 | 218 | * Specification, <http://www.w3.org/TR/2003/REC-PNG-20031110/ |
michael@0 | 219 | */ |
michael@0 | 220 | |
michael@0 | 221 | /* |
michael@0 | 222 | * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE: |
michael@0 | 223 | * |
michael@0 | 224 | * If you modify libpng you may insert additional notices immediately following |
michael@0 | 225 | * this sentence. |
michael@0 | 226 | * |
michael@0 | 227 | * This code is released under the libpng license. |
michael@0 | 228 | * |
michael@0 | 229 | * libpng versions 1.2.6, August 15, 2004, through 1.6.10, March 6, 2014, are |
michael@0 | 230 | * Copyright (c) 2004, 2006-2013 Glenn Randers-Pehrson, and are |
michael@0 | 231 | * distributed according to the same disclaimer and license as libpng-1.2.5 |
michael@0 | 232 | * with the following individual added to the list of Contributing Authors: |
michael@0 | 233 | * |
michael@0 | 234 | * Cosmin Truta |
michael@0 | 235 | * |
michael@0 | 236 | * libpng versions 1.0.7, July 1, 2000, through 1.2.5, October 3, 2002, are |
michael@0 | 237 | * Copyright (c) 2000-2002 Glenn Randers-Pehrson, and are |
michael@0 | 238 | * distributed according to the same disclaimer and license as libpng-1.0.6 |
michael@0 | 239 | * with the following individuals added to the list of Contributing Authors: |
michael@0 | 240 | * |
michael@0 | 241 | * Simon-Pierre Cadieux |
michael@0 | 242 | * Eric S. Raymond |
michael@0 | 243 | * Gilles Vollant |
michael@0 | 244 | * |
michael@0 | 245 | * and with the following additions to the disclaimer: |
michael@0 | 246 | * |
michael@0 | 247 | * There is no warranty against interference with your enjoyment of the |
michael@0 | 248 | * library or against infringement. There is no warranty that our |
michael@0 | 249 | * efforts or the library will fulfill any of your particular purposes |
michael@0 | 250 | * or needs. This library is provided with all faults, and the entire |
michael@0 | 251 | * risk of satisfactory quality, performance, accuracy, and effort is with |
michael@0 | 252 | * the user. |
michael@0 | 253 | * |
michael@0 | 254 | * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are |
michael@0 | 255 | * Copyright (c) 1998, 1999, 2000 Glenn Randers-Pehrson, and are |
michael@0 | 256 | * distributed according to the same disclaimer and license as libpng-0.96, |
michael@0 | 257 | * with the following individuals added to the list of Contributing Authors: |
michael@0 | 258 | * |
michael@0 | 259 | * Tom Lane |
michael@0 | 260 | * Glenn Randers-Pehrson |
michael@0 | 261 | * Willem van Schaik |
michael@0 | 262 | * |
michael@0 | 263 | * libpng versions 0.89, June 1996, through 0.96, May 1997, are |
michael@0 | 264 | * Copyright (c) 1996, 1997 Andreas Dilger |
michael@0 | 265 | * Distributed according to the same disclaimer and license as libpng-0.88, |
michael@0 | 266 | * with the following individuals added to the list of Contributing Authors: |
michael@0 | 267 | * |
michael@0 | 268 | * John Bowler |
michael@0 | 269 | * Kevin Bracey |
michael@0 | 270 | * Sam Bushell |
michael@0 | 271 | * Magnus Holmgren |
michael@0 | 272 | * Greg Roelofs |
michael@0 | 273 | * Tom Tanner |
michael@0 | 274 | * |
michael@0 | 275 | * libpng versions 0.5, May 1995, through 0.88, January 1996, are |
michael@0 | 276 | * Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc. |
michael@0 | 277 | * |
michael@0 | 278 | * For the purposes of this copyright and license, "Contributing Authors" |
michael@0 | 279 | * is defined as the following set of individuals: |
michael@0 | 280 | * |
michael@0 | 281 | * Andreas Dilger |
michael@0 | 282 | * Dave Martindale |
michael@0 | 283 | * Guy Eric Schalnat |
michael@0 | 284 | * Paul Schmidt |
michael@0 | 285 | * Tim Wegner |
michael@0 | 286 | * |
michael@0 | 287 | * The PNG Reference Library is supplied "AS IS". The Contributing Authors |
michael@0 | 288 | * and Group 42, Inc. disclaim all warranties, expressed or implied, |
michael@0 | 289 | * including, without limitation, the warranties of merchantability and of |
michael@0 | 290 | * fitness for any purpose. The Contributing Authors and Group 42, Inc. |
michael@0 | 291 | * assume no liability for direct, indirect, incidental, special, exemplary, |
michael@0 | 292 | * or consequential damages, which may result from the use of the PNG |
michael@0 | 293 | * Reference Library, even if advised of the possibility of such damage. |
michael@0 | 294 | * |
michael@0 | 295 | * Permission is hereby granted to use, copy, modify, and distribute this |
michael@0 | 296 | * source code, or portions hereof, for any purpose, without fee, subject |
michael@0 | 297 | * to the following restrictions: |
michael@0 | 298 | * |
michael@0 | 299 | * 1. The origin of this source code must not be misrepresented. |
michael@0 | 300 | * |
michael@0 | 301 | * 2. Altered versions must be plainly marked as such and must not |
michael@0 | 302 | * be misrepresented as being the original source. |
michael@0 | 303 | * |
michael@0 | 304 | * 3. This Copyright notice may not be removed or altered from |
michael@0 | 305 | * any source or altered source distribution. |
michael@0 | 306 | * |
michael@0 | 307 | * The Contributing Authors and Group 42, Inc. specifically permit, without |
michael@0 | 308 | * fee, and encourage the use of this source code as a component to |
michael@0 | 309 | * supporting the PNG file format in commercial products. If you use this |
michael@0 | 310 | * source code in a product, acknowledgment is not required but would be |
michael@0 | 311 | * appreciated. |
michael@0 | 312 | */ |
michael@0 | 313 | |
michael@0 | 314 | /* |
michael@0 | 315 | * A "png_get_copyright" function is available, for convenient use in "about" |
michael@0 | 316 | * boxes and the like: |
michael@0 | 317 | * |
michael@0 | 318 | * printf("%s", png_get_copyright(NULL)); |
michael@0 | 319 | * |
michael@0 | 320 | * Also, the PNG logo (in PNG format, of course) is supplied in the |
michael@0 | 321 | * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31). |
michael@0 | 322 | */ |
michael@0 | 323 | |
michael@0 | 324 | /* |
michael@0 | 325 | * Libpng is OSI Certified Open Source Software. OSI Certified is a |
michael@0 | 326 | * certification mark of the Open Source Initiative. |
michael@0 | 327 | */ |
michael@0 | 328 | |
michael@0 | 329 | /* |
michael@0 | 330 | * The contributing authors would like to thank all those who helped |
michael@0 | 331 | * with testing, bug fixes, and patience. This wouldn't have been |
michael@0 | 332 | * possible without all of you. |
michael@0 | 333 | * |
michael@0 | 334 | * Thanks to Frank J. T. Wojcik for helping with the documentation. |
michael@0 | 335 | */ |
michael@0 | 336 | |
michael@0 | 337 | /* |
michael@0 | 338 | * Y2K compliance in libpng: |
michael@0 | 339 | * ========================= |
michael@0 | 340 | * |
michael@0 | 341 | * March 6, 2014 |
michael@0 | 342 | * |
michael@0 | 343 | * Since the PNG Development group is an ad-hoc body, we can't make |
michael@0 | 344 | * an official declaration. |
michael@0 | 345 | * |
michael@0 | 346 | * This is your unofficial assurance that libpng from version 0.71 and |
michael@0 | 347 | * upward through 1.6.10 are Y2K compliant. It is my belief that |
michael@0 | 348 | * earlier versions were also Y2K compliant. |
michael@0 | 349 | * |
michael@0 | 350 | * Libpng only has two year fields. One is a 2-byte unsigned integer |
michael@0 | 351 | * that will hold years up to 65535. The other, which is deprecated, |
michael@0 | 352 | * holds the date in text format, and will hold years up to 9999. |
michael@0 | 353 | * |
michael@0 | 354 | * The integer is |
michael@0 | 355 | * "png_uint_16 year" in png_time_struct. |
michael@0 | 356 | * |
michael@0 | 357 | * The string is |
michael@0 | 358 | * "char time_buffer[29]" in png_struct. This is no longer used |
michael@0 | 359 | * in libpng-1.6.x and will be removed from libpng-1.7.0. |
michael@0 | 360 | * |
michael@0 | 361 | * There are seven time-related functions: |
michael@0 | 362 | * png.c: png_convert_to_rfc_1123_buffer() in png.c |
michael@0 | 363 | * (formerly png_convert_to_rfc_1123() prior to libpng-1.5.x and |
michael@0 | 364 | * png_convert_to_rfc_1152() in error prior to libpng-0.98) |
michael@0 | 365 | * png_convert_from_struct_tm() in pngwrite.c, called in pngwrite.c |
michael@0 | 366 | * png_convert_from_time_t() in pngwrite.c |
michael@0 | 367 | * png_get_tIME() in pngget.c |
michael@0 | 368 | * png_handle_tIME() in pngrutil.c, called in pngread.c |
michael@0 | 369 | * png_set_tIME() in pngset.c |
michael@0 | 370 | * png_write_tIME() in pngwutil.c, called in pngwrite.c |
michael@0 | 371 | * |
michael@0 | 372 | * All handle dates properly in a Y2K environment. The |
michael@0 | 373 | * png_convert_from_time_t() function calls gmtime() to convert from system |
michael@0 | 374 | * clock time, which returns (year - 1900), which we properly convert to |
michael@0 | 375 | * the full 4-digit year. There is a possibility that libpng applications |
michael@0 | 376 | * are not passing 4-digit years into the png_convert_to_rfc_1123_buffer() |
michael@0 | 377 | * function, or that they are incorrectly passing only a 2-digit year |
michael@0 | 378 | * instead of "year - 1900" into the png_convert_from_struct_tm() function, |
michael@0 | 379 | * but this is not under our control. The libpng documentation has always |
michael@0 | 380 | * stated that it works with 4-digit years, and the APIs have been |
michael@0 | 381 | * documented as such. |
michael@0 | 382 | * |
michael@0 | 383 | * The tIME chunk itself is also Y2K compliant. It uses a 2-byte unsigned |
michael@0 | 384 | * integer to hold the year, and can hold years as large as 65535. |
michael@0 | 385 | * |
michael@0 | 386 | * zlib, upon which libpng depends, is also Y2K compliant. It contains |
michael@0 | 387 | * no date-related code. |
michael@0 | 388 | * |
michael@0 | 389 | * Glenn Randers-Pehrson |
michael@0 | 390 | * libpng maintainer |
michael@0 | 391 | * PNG Development Group |
michael@0 | 392 | */ |
michael@0 | 393 | |
michael@0 | 394 | #ifndef PNG_H |
michael@0 | 395 | #define PNG_H |
michael@0 | 396 | |
michael@0 | 397 | /* This is not the place to learn how to use libpng. The file libpng-manual.txt |
michael@0 | 398 | * describes how to use libpng, and the file example.c summarizes it |
michael@0 | 399 | * with some code on which to build. This file is useful for looking |
michael@0 | 400 | * at the actual function definitions and structure components. |
michael@0 | 401 | * |
michael@0 | 402 | * If you just need to read a PNG file and don't want to read the documentation |
michael@0 | 403 | * skip to the end of this file and read the section entitled 'simplified API'. |
michael@0 | 404 | */ |
michael@0 | 405 | |
michael@0 | 406 | /* Version information for png.h - this should match the version in png.c */ |
michael@0 | 407 | #define PNG_LIBPNG_VER_STRING "1.6.10" |
michael@0 | 408 | #define PNG_HEADER_VERSION_STRING \ |
michael@0 | 409 | " libpng version 1.6.10 - March 6, 2014\n" |
michael@0 | 410 | |
michael@0 | 411 | #define PNG_LIBPNG_VER_SONUM 16 |
michael@0 | 412 | #define PNG_LIBPNG_VER_DLLNUM 16 |
michael@0 | 413 | |
michael@0 | 414 | /* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */ |
michael@0 | 415 | #define PNG_LIBPNG_VER_MAJOR 1 |
michael@0 | 416 | #define PNG_LIBPNG_VER_MINOR 6 |
michael@0 | 417 | #define PNG_LIBPNG_VER_RELEASE 10 |
michael@0 | 418 | |
michael@0 | 419 | /* This should match the numeric part of the final component of |
michael@0 | 420 | * PNG_LIBPNG_VER_STRING, omitting any leading zero: |
michael@0 | 421 | */ |
michael@0 | 422 | |
michael@0 | 423 | #define PNG_LIBPNG_VER_BUILD 0 |
michael@0 | 424 | |
michael@0 | 425 | /* Release Status */ |
michael@0 | 426 | #define PNG_LIBPNG_BUILD_ALPHA 1 |
michael@0 | 427 | #define PNG_LIBPNG_BUILD_BETA 2 |
michael@0 | 428 | #define PNG_LIBPNG_BUILD_RC 3 |
michael@0 | 429 | #define PNG_LIBPNG_BUILD_STABLE 4 |
michael@0 | 430 | #define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7 |
michael@0 | 431 | |
michael@0 | 432 | /* Release-Specific Flags */ |
michael@0 | 433 | #define PNG_LIBPNG_BUILD_PATCH 8 /* Can be OR'ed with |
michael@0 | 434 | PNG_LIBPNG_BUILD_STABLE only */ |
michael@0 | 435 | #define PNG_LIBPNG_BUILD_PRIVATE 16 /* Cannot be OR'ed with |
michael@0 | 436 | PNG_LIBPNG_BUILD_SPECIAL */ |
michael@0 | 437 | #define PNG_LIBPNG_BUILD_SPECIAL 32 /* Cannot be OR'ed with |
michael@0 | 438 | PNG_LIBPNG_BUILD_PRIVATE */ |
michael@0 | 439 | |
michael@0 | 440 | #define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_STABLE |
michael@0 | 441 | |
michael@0 | 442 | /* Careful here. At one time, Guy wanted to use 082, but that would be octal. |
michael@0 | 443 | * We must not include leading zeros. |
michael@0 | 444 | * Versions 0.7 through 1.0.0 were in the range 0 to 100 here (only |
michael@0 | 445 | * version 1.0.0 was mis-numbered 100 instead of 10000). From |
michael@0 | 446 | * version 1.0.1 it's xxyyzz, where x=major, y=minor, z=release |
michael@0 | 447 | */ |
michael@0 | 448 | #define PNG_LIBPNG_VER 10610 /* 1.6.10 */ |
michael@0 | 449 | |
michael@0 | 450 | /* Library configuration: these options cannot be changed after |
michael@0 | 451 | * the library has been built. |
michael@0 | 452 | */ |
michael@0 | 453 | |
michael@0 | 454 | #define PNG_APNG_SUPPORTED |
michael@0 | 455 | #define PNG_READ_APNG_SUPPORTED |
michael@0 | 456 | #define PNG_WRITE_APNG_SUPPORTED |
michael@0 | 457 | |
michael@0 | 458 | #ifndef PNG_VERSION_INFO_ONLY |
michael@0 | 459 | /* Machine specific configuration. */ |
michael@0 | 460 | # include "mozpngconf.h" |
michael@0 | 461 | # include "pngconf.h" |
michael@0 | 462 | #endif |
michael@0 | 463 | |
michael@0 | 464 | /* |
michael@0 | 465 | * Added at libpng-1.2.8 |
michael@0 | 466 | * |
michael@0 | 467 | * Ref MSDN: Private as priority over Special |
michael@0 | 468 | * VS_FF_PRIVATEBUILD File *was not* built using standard release |
michael@0 | 469 | * procedures. If this value is given, the StringFileInfo block must |
michael@0 | 470 | * contain a PrivateBuild string. |
michael@0 | 471 | * |
michael@0 | 472 | * VS_FF_SPECIALBUILD File *was* built by the original company using |
michael@0 | 473 | * standard release procedures but is a variation of the standard |
michael@0 | 474 | * file of the same version number. If this value is given, the |
michael@0 | 475 | * StringFileInfo block must contain a SpecialBuild string. |
michael@0 | 476 | */ |
michael@0 | 477 | |
michael@0 | 478 | #ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */ |
michael@0 | 479 | # define PNG_LIBPNG_BUILD_TYPE \ |
michael@0 | 480 | (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE) |
michael@0 | 481 | #else |
michael@0 | 482 | # ifdef PNG_LIBPNG_SPECIALBUILD |
michael@0 | 483 | # define PNG_LIBPNG_BUILD_TYPE \ |
michael@0 | 484 | (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL) |
michael@0 | 485 | # else |
michael@0 | 486 | # define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE) |
michael@0 | 487 | # endif |
michael@0 | 488 | #endif |
michael@0 | 489 | |
michael@0 | 490 | #ifndef PNG_VERSION_INFO_ONLY |
michael@0 | 491 | |
michael@0 | 492 | /* Inhibit C++ name-mangling for libpng functions but not for system calls. */ |
michael@0 | 493 | #ifdef __cplusplus |
michael@0 | 494 | extern "C" { |
michael@0 | 495 | #endif /* __cplusplus */ |
michael@0 | 496 | |
michael@0 | 497 | /* Version information for C files, stored in png.c. This had better match |
michael@0 | 498 | * the version above. |
michael@0 | 499 | */ |
michael@0 | 500 | #define png_libpng_ver png_get_header_ver(NULL) |
michael@0 | 501 | |
michael@0 | 502 | /* This file is arranged in several sections: |
michael@0 | 503 | * |
michael@0 | 504 | * 1. Any configuration options that can be specified by for the application |
michael@0 | 505 | * code when it is built. (Build time configuration is in pnglibconf.h) |
michael@0 | 506 | * 2. Type definitions (base types are defined in pngconf.h), structure |
michael@0 | 507 | * definitions. |
michael@0 | 508 | * 3. Exported library functions. |
michael@0 | 509 | * 4. Simplified API. |
michael@0 | 510 | * |
michael@0 | 511 | * The library source code has additional files (principally pngpriv.h) that |
michael@0 | 512 | * allow configuration of the library. |
michael@0 | 513 | */ |
michael@0 | 514 | /* Section 1: run time configuration |
michael@0 | 515 | * See pnglibconf.h for build time configuration |
michael@0 | 516 | * |
michael@0 | 517 | * Run time configuration allows the application to choose between |
michael@0 | 518 | * implementations of certain arithmetic APIs. The default is set |
michael@0 | 519 | * at build time and recorded in pnglibconf.h, but it is safe to |
michael@0 | 520 | * override these (and only these) settings. Note that this won't |
michael@0 | 521 | * change what the library does, only application code, and the |
michael@0 | 522 | * settings can (and probably should) be made on a per-file basis |
michael@0 | 523 | * by setting the #defines before including png.h |
michael@0 | 524 | * |
michael@0 | 525 | * Use macros to read integers from PNG data or use the exported |
michael@0 | 526 | * functions? |
michael@0 | 527 | * PNG_USE_READ_MACROS: use the macros (see below) Note that |
michael@0 | 528 | * the macros evaluate their argument multiple times. |
michael@0 | 529 | * PNG_NO_USE_READ_MACROS: call the relevant library function. |
michael@0 | 530 | * |
michael@0 | 531 | * Use the alternative algorithm for compositing alpha samples that |
michael@0 | 532 | * does not use division? |
michael@0 | 533 | * PNG_READ_COMPOSITE_NODIV_SUPPORTED: use the 'no division' |
michael@0 | 534 | * algorithm. |
michael@0 | 535 | * PNG_NO_READ_COMPOSITE_NODIV: use the 'division' algorithm. |
michael@0 | 536 | * |
michael@0 | 537 | * How to handle benign errors if PNG_ALLOW_BENIGN_ERRORS is |
michael@0 | 538 | * false? |
michael@0 | 539 | * PNG_ALLOW_BENIGN_ERRORS: map calls to the benign error |
michael@0 | 540 | * APIs to png_warning. |
michael@0 | 541 | * Otherwise the calls are mapped to png_error. |
michael@0 | 542 | */ |
michael@0 | 543 | |
michael@0 | 544 | /* Section 2: type definitions, including structures and compile time |
michael@0 | 545 | * constants. |
michael@0 | 546 | * See pngconf.h for base types that vary by machine/system |
michael@0 | 547 | */ |
michael@0 | 548 | |
michael@0 | 549 | #ifdef PNG_APNG_SUPPORTED |
michael@0 | 550 | /* dispose_op flags from inside fcTL */ |
michael@0 | 551 | #define PNG_DISPOSE_OP_NONE 0x00 |
michael@0 | 552 | #define PNG_DISPOSE_OP_BACKGROUND 0x01 |
michael@0 | 553 | #define PNG_DISPOSE_OP_PREVIOUS 0x02 |
michael@0 | 554 | |
michael@0 | 555 | /* blend_op flags from inside fcTL */ |
michael@0 | 556 | #define PNG_BLEND_OP_SOURCE 0x00 |
michael@0 | 557 | #define PNG_BLEND_OP_OVER 0x01 |
michael@0 | 558 | #endif /* PNG_APNG_SUPPORTED */ |
michael@0 | 559 | |
michael@0 | 560 | /* This triggers a compiler error in png.c, if png.c and png.h |
michael@0 | 561 | * do not agree upon the version number. |
michael@0 | 562 | */ |
michael@0 | 563 | typedef char* png_libpng_version_1_6_10; |
michael@0 | 564 | |
michael@0 | 565 | /* Basic control structions. Read libpng-manual.txt or libpng.3 for more info. |
michael@0 | 566 | * |
michael@0 | 567 | * png_struct is the cache of information used while reading or writing a single |
michael@0 | 568 | * PNG file. One of these is always required, although the simplified API |
michael@0 | 569 | * (below) hides the creation and destruction of it. |
michael@0 | 570 | */ |
michael@0 | 571 | typedef struct png_struct_def png_struct; |
michael@0 | 572 | typedef const png_struct * png_const_structp; |
michael@0 | 573 | typedef png_struct * png_structp; |
michael@0 | 574 | typedef png_struct * * png_structpp; |
michael@0 | 575 | |
michael@0 | 576 | /* png_info contains information read from or to be written to a PNG file. One |
michael@0 | 577 | * or more of these must exist while reading or creating a PNG file. The |
michael@0 | 578 | * information is not used by libpng during read but is used to control what |
michael@0 | 579 | * gets written when a PNG file is created. "png_get_" function calls read |
michael@0 | 580 | * information during read and "png_set_" functions calls write information |
michael@0 | 581 | * when creating a PNG. |
michael@0 | 582 | * been moved into a separate header file that is not accessible to |
michael@0 | 583 | * applications. Read libpng-manual.txt or libpng.3 for more info. |
michael@0 | 584 | */ |
michael@0 | 585 | typedef struct png_info_def png_info; |
michael@0 | 586 | typedef png_info * png_infop; |
michael@0 | 587 | typedef const png_info * png_const_infop; |
michael@0 | 588 | typedef png_info * * png_infopp; |
michael@0 | 589 | |
michael@0 | 590 | /* Types with names ending 'p' are pointer types. The corresponding types with |
michael@0 | 591 | * names ending 'rp' are identical pointer types except that the pointer is |
michael@0 | 592 | * marked 'restrict', which means that it is the only pointer to the object |
michael@0 | 593 | * passed to the function. Applications should not use the 'restrict' types; |
michael@0 | 594 | * it is always valid to pass 'p' to a pointer with a function argument of the |
michael@0 | 595 | * corresponding 'rp' type. Different compilers have different rules with |
michael@0 | 596 | * regard to type matching in the presence of 'restrict'. For backward |
michael@0 | 597 | * compatibility libpng callbacks never have 'restrict' in their parameters and, |
michael@0 | 598 | * consequentially, writing portable application code is extremely difficult if |
michael@0 | 599 | * an attempt is made to use 'restrict'. |
michael@0 | 600 | */ |
michael@0 | 601 | typedef png_struct * PNG_RESTRICT png_structrp; |
michael@0 | 602 | typedef const png_struct * PNG_RESTRICT png_const_structrp; |
michael@0 | 603 | typedef png_info * PNG_RESTRICT png_inforp; |
michael@0 | 604 | typedef const png_info * PNG_RESTRICT png_const_inforp; |
michael@0 | 605 | |
michael@0 | 606 | /* Three color definitions. The order of the red, green, and blue, (and the |
michael@0 | 607 | * exact size) is not important, although the size of the fields need to |
michael@0 | 608 | * be png_byte or png_uint_16 (as defined below). |
michael@0 | 609 | */ |
michael@0 | 610 | typedef struct png_color_struct |
michael@0 | 611 | { |
michael@0 | 612 | png_byte red; |
michael@0 | 613 | png_byte green; |
michael@0 | 614 | png_byte blue; |
michael@0 | 615 | } png_color; |
michael@0 | 616 | typedef png_color * png_colorp; |
michael@0 | 617 | typedef const png_color * png_const_colorp; |
michael@0 | 618 | typedef png_color * * png_colorpp; |
michael@0 | 619 | |
michael@0 | 620 | typedef struct png_color_16_struct |
michael@0 | 621 | { |
michael@0 | 622 | png_byte index; /* used for palette files */ |
michael@0 | 623 | png_uint_16 red; /* for use in red green blue files */ |
michael@0 | 624 | png_uint_16 green; |
michael@0 | 625 | png_uint_16 blue; |
michael@0 | 626 | png_uint_16 gray; /* for use in grayscale files */ |
michael@0 | 627 | } png_color_16; |
michael@0 | 628 | typedef png_color_16 * png_color_16p; |
michael@0 | 629 | typedef const png_color_16 * png_const_color_16p; |
michael@0 | 630 | typedef png_color_16 * * png_color_16pp; |
michael@0 | 631 | |
michael@0 | 632 | typedef struct png_color_8_struct |
michael@0 | 633 | { |
michael@0 | 634 | png_byte red; /* for use in red green blue files */ |
michael@0 | 635 | png_byte green; |
michael@0 | 636 | png_byte blue; |
michael@0 | 637 | png_byte gray; /* for use in grayscale files */ |
michael@0 | 638 | png_byte alpha; /* for alpha channel files */ |
michael@0 | 639 | } png_color_8; |
michael@0 | 640 | typedef png_color_8 * png_color_8p; |
michael@0 | 641 | typedef const png_color_8 * png_const_color_8p; |
michael@0 | 642 | typedef png_color_8 * * png_color_8pp; |
michael@0 | 643 | |
michael@0 | 644 | /* |
michael@0 | 645 | * The following two structures are used for the in-core representation |
michael@0 | 646 | * of sPLT chunks. |
michael@0 | 647 | */ |
michael@0 | 648 | typedef struct png_sPLT_entry_struct |
michael@0 | 649 | { |
michael@0 | 650 | png_uint_16 red; |
michael@0 | 651 | png_uint_16 green; |
michael@0 | 652 | png_uint_16 blue; |
michael@0 | 653 | png_uint_16 alpha; |
michael@0 | 654 | png_uint_16 frequency; |
michael@0 | 655 | } png_sPLT_entry; |
michael@0 | 656 | typedef png_sPLT_entry * png_sPLT_entryp; |
michael@0 | 657 | typedef const png_sPLT_entry * png_const_sPLT_entryp; |
michael@0 | 658 | typedef png_sPLT_entry * * png_sPLT_entrypp; |
michael@0 | 659 | |
michael@0 | 660 | /* When the depth of the sPLT palette is 8 bits, the color and alpha samples |
michael@0 | 661 | * occupy the LSB of their respective members, and the MSB of each member |
michael@0 | 662 | * is zero-filled. The frequency member always occupies the full 16 bits. |
michael@0 | 663 | */ |
michael@0 | 664 | |
michael@0 | 665 | typedef struct png_sPLT_struct |
michael@0 | 666 | { |
michael@0 | 667 | png_charp name; /* palette name */ |
michael@0 | 668 | png_byte depth; /* depth of palette samples */ |
michael@0 | 669 | png_sPLT_entryp entries; /* palette entries */ |
michael@0 | 670 | png_int_32 nentries; /* number of palette entries */ |
michael@0 | 671 | } png_sPLT_t; |
michael@0 | 672 | typedef png_sPLT_t * png_sPLT_tp; |
michael@0 | 673 | typedef const png_sPLT_t * png_const_sPLT_tp; |
michael@0 | 674 | typedef png_sPLT_t * * png_sPLT_tpp; |
michael@0 | 675 | |
michael@0 | 676 | #ifdef PNG_TEXT_SUPPORTED |
michael@0 | 677 | /* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file, |
michael@0 | 678 | * and whether that contents is compressed or not. The "key" field |
michael@0 | 679 | * points to a regular zero-terminated C string. The "text" fields can be a |
michael@0 | 680 | * regular C string, an empty string, or a NULL pointer. |
michael@0 | 681 | * However, the structure returned by png_get_text() will always contain |
michael@0 | 682 | * the "text" field as a regular zero-terminated C string (possibly |
michael@0 | 683 | * empty), never a NULL pointer, so it can be safely used in printf() and |
michael@0 | 684 | * other string-handling functions. Note that the "itxt_length", "lang", and |
michael@0 | 685 | * "lang_key" members of the structure only exist when the library is built |
michael@0 | 686 | * with iTXt chunk support. Prior to libpng-1.4.0 the library was built by |
michael@0 | 687 | * default without iTXt support. Also note that when iTXt *is* supported, |
michael@0 | 688 | * the "lang" and "lang_key" fields contain NULL pointers when the |
michael@0 | 689 | * "compression" field contains * PNG_TEXT_COMPRESSION_NONE or |
michael@0 | 690 | * PNG_TEXT_COMPRESSION_zTXt. Note that the "compression value" is not the |
michael@0 | 691 | * same as what appears in the PNG tEXt/zTXt/iTXt chunk's "compression flag" |
michael@0 | 692 | * which is always 0 or 1, or its "compression method" which is always 0. |
michael@0 | 693 | */ |
michael@0 | 694 | typedef struct png_text_struct |
michael@0 | 695 | { |
michael@0 | 696 | int compression; /* compression value: |
michael@0 | 697 | -1: tEXt, none |
michael@0 | 698 | 0: zTXt, deflate |
michael@0 | 699 | 1: iTXt, none |
michael@0 | 700 | 2: iTXt, deflate */ |
michael@0 | 701 | png_charp key; /* keyword, 1-79 character description of "text" */ |
michael@0 | 702 | png_charp text; /* comment, may be an empty string (ie "") |
michael@0 | 703 | or a NULL pointer */ |
michael@0 | 704 | png_size_t text_length; /* length of the text string */ |
michael@0 | 705 | png_size_t itxt_length; /* length of the itxt string */ |
michael@0 | 706 | png_charp lang; /* language code, 0-79 characters |
michael@0 | 707 | or a NULL pointer */ |
michael@0 | 708 | png_charp lang_key; /* keyword translated UTF-8 string, 0 or more |
michael@0 | 709 | chars or a NULL pointer */ |
michael@0 | 710 | } png_text; |
michael@0 | 711 | typedef png_text * png_textp; |
michael@0 | 712 | typedef const png_text * png_const_textp; |
michael@0 | 713 | typedef png_text * * png_textpp; |
michael@0 | 714 | #endif |
michael@0 | 715 | |
michael@0 | 716 | /* Supported compression types for text in PNG files (tEXt, and zTXt). |
michael@0 | 717 | * The values of the PNG_TEXT_COMPRESSION_ defines should NOT be changed. */ |
michael@0 | 718 | #define PNG_TEXT_COMPRESSION_NONE_WR -3 |
michael@0 | 719 | #define PNG_TEXT_COMPRESSION_zTXt_WR -2 |
michael@0 | 720 | #define PNG_TEXT_COMPRESSION_NONE -1 |
michael@0 | 721 | #define PNG_TEXT_COMPRESSION_zTXt 0 |
michael@0 | 722 | #define PNG_ITXT_COMPRESSION_NONE 1 |
michael@0 | 723 | #define PNG_ITXT_COMPRESSION_zTXt 2 |
michael@0 | 724 | #define PNG_TEXT_COMPRESSION_LAST 3 /* Not a valid value */ |
michael@0 | 725 | |
michael@0 | 726 | /* png_time is a way to hold the time in an machine independent way. |
michael@0 | 727 | * Two conversions are provided, both from time_t and struct tm. There |
michael@0 | 728 | * is no portable way to convert to either of these structures, as far |
michael@0 | 729 | * as I know. If you know of a portable way, send it to me. As a side |
michael@0 | 730 | * note - PNG has always been Year 2000 compliant! |
michael@0 | 731 | */ |
michael@0 | 732 | typedef struct png_time_struct |
michael@0 | 733 | { |
michael@0 | 734 | png_uint_16 year; /* full year, as in, 1995 */ |
michael@0 | 735 | png_byte month; /* month of year, 1 - 12 */ |
michael@0 | 736 | png_byte day; /* day of month, 1 - 31 */ |
michael@0 | 737 | png_byte hour; /* hour of day, 0 - 23 */ |
michael@0 | 738 | png_byte minute; /* minute of hour, 0 - 59 */ |
michael@0 | 739 | png_byte second; /* second of minute, 0 - 60 (for leap seconds) */ |
michael@0 | 740 | } png_time; |
michael@0 | 741 | typedef png_time * png_timep; |
michael@0 | 742 | typedef const png_time * png_const_timep; |
michael@0 | 743 | typedef png_time * * png_timepp; |
michael@0 | 744 | |
michael@0 | 745 | #if defined(PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED) ||\ |
michael@0 | 746 | defined(PNG_USER_CHUNKS_SUPPORTED) |
michael@0 | 747 | /* png_unknown_chunk is a structure to hold queued chunks for which there is |
michael@0 | 748 | * no specific support. The idea is that we can use this to queue |
michael@0 | 749 | * up private chunks for output even though the library doesn't actually |
michael@0 | 750 | * know about their semantics. |
michael@0 | 751 | * |
michael@0 | 752 | * The data in the structure is set by libpng on read and used on write. |
michael@0 | 753 | */ |
michael@0 | 754 | typedef struct png_unknown_chunk_t |
michael@0 | 755 | { |
michael@0 | 756 | png_byte name[5]; /* Textual chunk name with '\0' terminator */ |
michael@0 | 757 | png_byte *data; /* Data, should not be modified on read! */ |
michael@0 | 758 | png_size_t size; |
michael@0 | 759 | |
michael@0 | 760 | /* On write 'location' must be set using the flag values listed below. |
michael@0 | 761 | * Notice that on read it is set by libpng however the values stored have |
michael@0 | 762 | * more bits set than are listed below. Always treat the value as a |
michael@0 | 763 | * bitmask. On write set only one bit - setting multiple bits may cause the |
michael@0 | 764 | * chunk to be written in multiple places. |
michael@0 | 765 | */ |
michael@0 | 766 | png_byte location; /* mode of operation at read time */ |
michael@0 | 767 | } |
michael@0 | 768 | png_unknown_chunk; |
michael@0 | 769 | |
michael@0 | 770 | typedef png_unknown_chunk * png_unknown_chunkp; |
michael@0 | 771 | typedef const png_unknown_chunk * png_const_unknown_chunkp; |
michael@0 | 772 | typedef png_unknown_chunk * * png_unknown_chunkpp; |
michael@0 | 773 | #endif |
michael@0 | 774 | |
michael@0 | 775 | /* Flag values for the unknown chunk location byte. */ |
michael@0 | 776 | #define PNG_HAVE_IHDR 0x01 |
michael@0 | 777 | #define PNG_HAVE_PLTE 0x02 |
michael@0 | 778 | #define PNG_AFTER_IDAT 0x08 |
michael@0 | 779 | |
michael@0 | 780 | /* Maximum positive integer used in PNG is (2^31)-1 */ |
michael@0 | 781 | #define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL) |
michael@0 | 782 | #define PNG_UINT_32_MAX ((png_uint_32)(-1)) |
michael@0 | 783 | #define PNG_SIZE_MAX ((png_size_t)(-1)) |
michael@0 | 784 | |
michael@0 | 785 | /* These are constants for fixed point values encoded in the |
michael@0 | 786 | * PNG specification manner (x100000) |
michael@0 | 787 | */ |
michael@0 | 788 | #define PNG_FP_1 100000 |
michael@0 | 789 | #define PNG_FP_HALF 50000 |
michael@0 | 790 | #define PNG_FP_MAX ((png_fixed_point)0x7fffffffL) |
michael@0 | 791 | #define PNG_FP_MIN (-PNG_FP_MAX) |
michael@0 | 792 | |
michael@0 | 793 | /* These describe the color_type field in png_info. */ |
michael@0 | 794 | /* color type masks */ |
michael@0 | 795 | #define PNG_COLOR_MASK_PALETTE 1 |
michael@0 | 796 | #define PNG_COLOR_MASK_COLOR 2 |
michael@0 | 797 | #define PNG_COLOR_MASK_ALPHA 4 |
michael@0 | 798 | |
michael@0 | 799 | /* color types. Note that not all combinations are legal */ |
michael@0 | 800 | #define PNG_COLOR_TYPE_GRAY 0 |
michael@0 | 801 | #define PNG_COLOR_TYPE_PALETTE (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE) |
michael@0 | 802 | #define PNG_COLOR_TYPE_RGB (PNG_COLOR_MASK_COLOR) |
michael@0 | 803 | #define PNG_COLOR_TYPE_RGB_ALPHA (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA) |
michael@0 | 804 | #define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA) |
michael@0 | 805 | /* aliases */ |
michael@0 | 806 | #define PNG_COLOR_TYPE_RGBA PNG_COLOR_TYPE_RGB_ALPHA |
michael@0 | 807 | #define PNG_COLOR_TYPE_GA PNG_COLOR_TYPE_GRAY_ALPHA |
michael@0 | 808 | |
michael@0 | 809 | /* This is for compression type. PNG 1.0-1.2 only define the single type. */ |
michael@0 | 810 | #define PNG_COMPRESSION_TYPE_BASE 0 /* Deflate method 8, 32K window */ |
michael@0 | 811 | #define PNG_COMPRESSION_TYPE_DEFAULT PNG_COMPRESSION_TYPE_BASE |
michael@0 | 812 | |
michael@0 | 813 | /* This is for filter type. PNG 1.0-1.2 only define the single type. */ |
michael@0 | 814 | #define PNG_FILTER_TYPE_BASE 0 /* Single row per-byte filtering */ |
michael@0 | 815 | #define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */ |
michael@0 | 816 | #define PNG_FILTER_TYPE_DEFAULT PNG_FILTER_TYPE_BASE |
michael@0 | 817 | |
michael@0 | 818 | /* These are for the interlacing type. These values should NOT be changed. */ |
michael@0 | 819 | #define PNG_INTERLACE_NONE 0 /* Non-interlaced image */ |
michael@0 | 820 | #define PNG_INTERLACE_ADAM7 1 /* Adam7 interlacing */ |
michael@0 | 821 | #define PNG_INTERLACE_LAST 2 /* Not a valid value */ |
michael@0 | 822 | |
michael@0 | 823 | /* These are for the oFFs chunk. These values should NOT be changed. */ |
michael@0 | 824 | #define PNG_OFFSET_PIXEL 0 /* Offset in pixels */ |
michael@0 | 825 | #define PNG_OFFSET_MICROMETER 1 /* Offset in micrometers (1/10^6 meter) */ |
michael@0 | 826 | #define PNG_OFFSET_LAST 2 /* Not a valid value */ |
michael@0 | 827 | |
michael@0 | 828 | /* These are for the pCAL chunk. These values should NOT be changed. */ |
michael@0 | 829 | #define PNG_EQUATION_LINEAR 0 /* Linear transformation */ |
michael@0 | 830 | #define PNG_EQUATION_BASE_E 1 /* Exponential base e transform */ |
michael@0 | 831 | #define PNG_EQUATION_ARBITRARY 2 /* Arbitrary base exponential transform */ |
michael@0 | 832 | #define PNG_EQUATION_HYPERBOLIC 3 /* Hyperbolic sine transformation */ |
michael@0 | 833 | #define PNG_EQUATION_LAST 4 /* Not a valid value */ |
michael@0 | 834 | |
michael@0 | 835 | /* These are for the sCAL chunk. These values should NOT be changed. */ |
michael@0 | 836 | #define PNG_SCALE_UNKNOWN 0 /* unknown unit (image scale) */ |
michael@0 | 837 | #define PNG_SCALE_METER 1 /* meters per pixel */ |
michael@0 | 838 | #define PNG_SCALE_RADIAN 2 /* radians per pixel */ |
michael@0 | 839 | #define PNG_SCALE_LAST 3 /* Not a valid value */ |
michael@0 | 840 | |
michael@0 | 841 | /* These are for the pHYs chunk. These values should NOT be changed. */ |
michael@0 | 842 | #define PNG_RESOLUTION_UNKNOWN 0 /* pixels/unknown unit (aspect ratio) */ |
michael@0 | 843 | #define PNG_RESOLUTION_METER 1 /* pixels/meter */ |
michael@0 | 844 | #define PNG_RESOLUTION_LAST 2 /* Not a valid value */ |
michael@0 | 845 | |
michael@0 | 846 | /* These are for the sRGB chunk. These values should NOT be changed. */ |
michael@0 | 847 | #define PNG_sRGB_INTENT_PERCEPTUAL 0 |
michael@0 | 848 | #define PNG_sRGB_INTENT_RELATIVE 1 |
michael@0 | 849 | #define PNG_sRGB_INTENT_SATURATION 2 |
michael@0 | 850 | #define PNG_sRGB_INTENT_ABSOLUTE 3 |
michael@0 | 851 | #define PNG_sRGB_INTENT_LAST 4 /* Not a valid value */ |
michael@0 | 852 | |
michael@0 | 853 | /* This is for text chunks */ |
michael@0 | 854 | #define PNG_KEYWORD_MAX_LENGTH 79 |
michael@0 | 855 | |
michael@0 | 856 | /* Maximum number of entries in PLTE/sPLT/tRNS arrays */ |
michael@0 | 857 | #define PNG_MAX_PALETTE_LENGTH 256 |
michael@0 | 858 | |
michael@0 | 859 | /* These determine if an ancillary chunk's data has been successfully read |
michael@0 | 860 | * from the PNG header, or if the application has filled in the corresponding |
michael@0 | 861 | * data in the info_struct to be written into the output file. The values |
michael@0 | 862 | * of the PNG_INFO_<chunk> defines should NOT be changed. |
michael@0 | 863 | */ |
michael@0 | 864 | #define PNG_INFO_gAMA 0x0001 |
michael@0 | 865 | #define PNG_INFO_sBIT 0x0002 |
michael@0 | 866 | #define PNG_INFO_cHRM 0x0004 |
michael@0 | 867 | #define PNG_INFO_PLTE 0x0008 |
michael@0 | 868 | #define PNG_INFO_tRNS 0x0010 |
michael@0 | 869 | #define PNG_INFO_bKGD 0x0020 |
michael@0 | 870 | #define PNG_INFO_hIST 0x0040 |
michael@0 | 871 | #define PNG_INFO_pHYs 0x0080 |
michael@0 | 872 | #define PNG_INFO_oFFs 0x0100 |
michael@0 | 873 | #define PNG_INFO_tIME 0x0200 |
michael@0 | 874 | #define PNG_INFO_pCAL 0x0400 |
michael@0 | 875 | #define PNG_INFO_sRGB 0x0800 /* GR-P, 0.96a */ |
michael@0 | 876 | #define PNG_INFO_iCCP 0x1000 /* ESR, 1.0.6 */ |
michael@0 | 877 | #define PNG_INFO_sPLT 0x2000 /* ESR, 1.0.6 */ |
michael@0 | 878 | #define PNG_INFO_sCAL 0x4000 /* ESR, 1.0.6 */ |
michael@0 | 879 | #define PNG_INFO_IDAT 0x8000 /* ESR, 1.0.6 */ |
michael@0 | 880 | #ifdef PNG_APNG_SUPPORTED |
michael@0 | 881 | #define PNG_INFO_acTL 0x10000 |
michael@0 | 882 | #define PNG_INFO_fcTL 0x20000 |
michael@0 | 883 | #endif |
michael@0 | 884 | |
michael@0 | 885 | /* This is used for the transformation routines, as some of them |
michael@0 | 886 | * change these values for the row. It also should enable using |
michael@0 | 887 | * the routines for other purposes. |
michael@0 | 888 | */ |
michael@0 | 889 | typedef struct png_row_info_struct |
michael@0 | 890 | { |
michael@0 | 891 | png_uint_32 width; /* width of row */ |
michael@0 | 892 | png_size_t rowbytes; /* number of bytes in row */ |
michael@0 | 893 | png_byte color_type; /* color type of row */ |
michael@0 | 894 | png_byte bit_depth; /* bit depth of row */ |
michael@0 | 895 | png_byte channels; /* number of channels (1, 2, 3, or 4) */ |
michael@0 | 896 | png_byte pixel_depth; /* bits per pixel (depth * channels) */ |
michael@0 | 897 | } png_row_info; |
michael@0 | 898 | |
michael@0 | 899 | typedef png_row_info * png_row_infop; |
michael@0 | 900 | typedef png_row_info * * png_row_infopp; |
michael@0 | 901 | |
michael@0 | 902 | /* These are the function types for the I/O functions and for the functions |
michael@0 | 903 | * that allow the user to override the default I/O functions with his or her |
michael@0 | 904 | * own. The png_error_ptr type should match that of user-supplied warning |
michael@0 | 905 | * and error functions, while the png_rw_ptr type should match that of the |
michael@0 | 906 | * user read/write data functions. Note that the 'write' function must not |
michael@0 | 907 | * modify the buffer it is passed. The 'read' function, on the other hand, is |
michael@0 | 908 | * expected to return the read data in the buffer. |
michael@0 | 909 | */ |
michael@0 | 910 | typedef PNG_CALLBACK(void, *png_error_ptr, (png_structp, png_const_charp)); |
michael@0 | 911 | typedef PNG_CALLBACK(void, *png_rw_ptr, (png_structp, png_bytep, png_size_t)); |
michael@0 | 912 | typedef PNG_CALLBACK(void, *png_flush_ptr, (png_structp)); |
michael@0 | 913 | typedef PNG_CALLBACK(void, *png_read_status_ptr, (png_structp, png_uint_32, |
michael@0 | 914 | int)); |
michael@0 | 915 | typedef PNG_CALLBACK(void, *png_write_status_ptr, (png_structp, png_uint_32, |
michael@0 | 916 | int)); |
michael@0 | 917 | |
michael@0 | 918 | #ifdef PNG_PROGRESSIVE_READ_SUPPORTED |
michael@0 | 919 | typedef PNG_CALLBACK(void, *png_progressive_info_ptr, (png_structp, png_infop)); |
michael@0 | 920 | typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop)); |
michael@0 | 921 | #ifdef PNG_APNG_SUPPORTED |
michael@0 | 922 | typedef PNG_CALLBACK(void, *png_progressive_frame_ptr, (png_structp, |
michael@0 | 923 | png_uint_32)); |
michael@0 | 924 | #endif |
michael@0 | 925 | |
michael@0 | 926 | /* The following callback receives png_uint_32 row_number, int pass for the |
michael@0 | 927 | * png_bytep data of the row. When transforming an interlaced image the |
michael@0 | 928 | * row number is the row number within the sub-image of the interlace pass, so |
michael@0 | 929 | * the value will increase to the height of the sub-image (not the full image) |
michael@0 | 930 | * then reset to 0 for the next pass. |
michael@0 | 931 | * |
michael@0 | 932 | * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to |
michael@0 | 933 | * find the output pixel (x,y) given an interlaced sub-image pixel |
michael@0 | 934 | * (row,col,pass). (See below for these macros.) |
michael@0 | 935 | */ |
michael@0 | 936 | typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep, |
michael@0 | 937 | png_uint_32, int)); |
michael@0 | 938 | #endif |
michael@0 | 939 | |
michael@0 | 940 | #if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \ |
michael@0 | 941 | defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED) |
michael@0 | 942 | typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop, |
michael@0 | 943 | png_bytep)); |
michael@0 | 944 | #endif |
michael@0 | 945 | |
michael@0 | 946 | #ifdef PNG_USER_CHUNKS_SUPPORTED |
michael@0 | 947 | typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp, |
michael@0 | 948 | png_unknown_chunkp)); |
michael@0 | 949 | #endif |
michael@0 | 950 | #ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED |
michael@0 | 951 | /* not used anywhere */ |
michael@0 | 952 | /* typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp)); */ |
michael@0 | 953 | #endif |
michael@0 | 954 | |
michael@0 | 955 | #ifdef PNG_SETJMP_SUPPORTED |
michael@0 | 956 | /* This must match the function definition in <setjmp.h>, and the application |
michael@0 | 957 | * must include this before png.h to obtain the definition of jmp_buf. The |
michael@0 | 958 | * function is required to be PNG_NORETURN, but this is not checked. If the |
michael@0 | 959 | * function does return the application will crash via an abort() or similar |
michael@0 | 960 | * system level call. |
michael@0 | 961 | * |
michael@0 | 962 | * If you get a warning here while building the library you may need to make |
michael@0 | 963 | * changes to ensure that pnglibconf.h records the calling convention used by |
michael@0 | 964 | * your compiler. This may be very difficult - try using a different compiler |
michael@0 | 965 | * to build the library! |
michael@0 | 966 | */ |
michael@0 | 967 | PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)), typedef); |
michael@0 | 968 | #endif |
michael@0 | 969 | |
michael@0 | 970 | /* Transform masks for the high-level interface */ |
michael@0 | 971 | #define PNG_TRANSFORM_IDENTITY 0x0000 /* read and write */ |
michael@0 | 972 | #define PNG_TRANSFORM_STRIP_16 0x0001 /* read only */ |
michael@0 | 973 | #define PNG_TRANSFORM_STRIP_ALPHA 0x0002 /* read only */ |
michael@0 | 974 | #define PNG_TRANSFORM_PACKING 0x0004 /* read and write */ |
michael@0 | 975 | #define PNG_TRANSFORM_PACKSWAP 0x0008 /* read and write */ |
michael@0 | 976 | #define PNG_TRANSFORM_EXPAND 0x0010 /* read only */ |
michael@0 | 977 | #define PNG_TRANSFORM_INVERT_MONO 0x0020 /* read and write */ |
michael@0 | 978 | #define PNG_TRANSFORM_SHIFT 0x0040 /* read and write */ |
michael@0 | 979 | #define PNG_TRANSFORM_BGR 0x0080 /* read and write */ |
michael@0 | 980 | #define PNG_TRANSFORM_SWAP_ALPHA 0x0100 /* read and write */ |
michael@0 | 981 | #define PNG_TRANSFORM_SWAP_ENDIAN 0x0200 /* read and write */ |
michael@0 | 982 | #define PNG_TRANSFORM_INVERT_ALPHA 0x0400 /* read and write */ |
michael@0 | 983 | #define PNG_TRANSFORM_STRIP_FILLER 0x0800 /* write only */ |
michael@0 | 984 | /* Added to libpng-1.2.34 */ |
michael@0 | 985 | #define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER |
michael@0 | 986 | #define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */ |
michael@0 | 987 | /* Added to libpng-1.4.0 */ |
michael@0 | 988 | #define PNG_TRANSFORM_GRAY_TO_RGB 0x2000 /* read only */ |
michael@0 | 989 | /* Added to libpng-1.5.4 */ |
michael@0 | 990 | #define PNG_TRANSFORM_EXPAND_16 0x4000 /* read only */ |
michael@0 | 991 | #define PNG_TRANSFORM_SCALE_16 0x8000 /* read only */ |
michael@0 | 992 | |
michael@0 | 993 | /* Flags for MNG supported features */ |
michael@0 | 994 | #define PNG_FLAG_MNG_EMPTY_PLTE 0x01 |
michael@0 | 995 | #define PNG_FLAG_MNG_FILTER_64 0x04 |
michael@0 | 996 | #define PNG_ALL_MNG_FEATURES 0x05 |
michael@0 | 997 | |
michael@0 | 998 | /* NOTE: prior to 1.5 these functions had no 'API' style declaration, |
michael@0 | 999 | * this allowed the zlib default functions to be used on Windows |
michael@0 | 1000 | * platforms. In 1.5 the zlib default malloc (which just calls malloc and |
michael@0 | 1001 | * ignores the first argument) should be completely compatible with the |
michael@0 | 1002 | * following. |
michael@0 | 1003 | */ |
michael@0 | 1004 | typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp, |
michael@0 | 1005 | png_alloc_size_t)); |
michael@0 | 1006 | typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp)); |
michael@0 | 1007 | |
michael@0 | 1008 | /* Section 3: exported functions |
michael@0 | 1009 | * Here are the function definitions most commonly used. This is not |
michael@0 | 1010 | * the place to find out how to use libpng. See libpng-manual.txt for the |
michael@0 | 1011 | * full explanation, see example.c for the summary. This just provides |
michael@0 | 1012 | * a simple one line description of the use of each function. |
michael@0 | 1013 | * |
michael@0 | 1014 | * The PNG_EXPORT() and PNG_EXPORTA() macros used below are defined in |
michael@0 | 1015 | * pngconf.h and in the *.dfn files in the scripts directory. |
michael@0 | 1016 | * |
michael@0 | 1017 | * PNG_EXPORT(ordinal, type, name, (args)); |
michael@0 | 1018 | * |
michael@0 | 1019 | * ordinal: ordinal that is used while building |
michael@0 | 1020 | * *.def files. The ordinal value is only |
michael@0 | 1021 | * relevant when preprocessing png.h with |
michael@0 | 1022 | * the *.dfn files for building symbol table |
michael@0 | 1023 | * entries, and are removed by pngconf.h. |
michael@0 | 1024 | * type: return type of the function |
michael@0 | 1025 | * name: function name |
michael@0 | 1026 | * args: function arguments, with types |
michael@0 | 1027 | * |
michael@0 | 1028 | * When we wish to append attributes to a function prototype we use |
michael@0 | 1029 | * the PNG_EXPORTA() macro instead. |
michael@0 | 1030 | * |
michael@0 | 1031 | * PNG_EXPORTA(ordinal, type, name, (args), attributes); |
michael@0 | 1032 | * |
michael@0 | 1033 | * ordinal, type, name, and args: same as in PNG_EXPORT(). |
michael@0 | 1034 | * attributes: function attributes |
michael@0 | 1035 | */ |
michael@0 | 1036 | |
michael@0 | 1037 | /* Returns the version number of the library */ |
michael@0 | 1038 | PNG_EXPORT(1, png_uint_32, png_access_version_number, (void)); |
michael@0 | 1039 | |
michael@0 | 1040 | /* Tell lib we have already handled the first <num_bytes> magic bytes. |
michael@0 | 1041 | * Handling more than 8 bytes from the beginning of the file is an error. |
michael@0 | 1042 | */ |
michael@0 | 1043 | PNG_EXPORT(2, void, png_set_sig_bytes, (png_structrp png_ptr, int num_bytes)); |
michael@0 | 1044 | |
michael@0 | 1045 | /* Check sig[start] through sig[start + num_to_check - 1] to see if it's a |
michael@0 | 1046 | * PNG file. Returns zero if the supplied bytes match the 8-byte PNG |
michael@0 | 1047 | * signature, and non-zero otherwise. Having num_to_check == 0 or |
michael@0 | 1048 | * start > 7 will always fail (ie return non-zero). |
michael@0 | 1049 | */ |
michael@0 | 1050 | PNG_EXPORT(3, int, png_sig_cmp, (png_const_bytep sig, png_size_t start, |
michael@0 | 1051 | png_size_t num_to_check)); |
michael@0 | 1052 | |
michael@0 | 1053 | /* Simple signature checking function. This is the same as calling |
michael@0 | 1054 | * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n). |
michael@0 | 1055 | */ |
michael@0 | 1056 | #define png_check_sig(sig, n) !png_sig_cmp((sig), 0, (n)) |
michael@0 | 1057 | |
michael@0 | 1058 | /* Allocate and initialize png_ptr struct for reading, and any other memory. */ |
michael@0 | 1059 | PNG_EXPORTA(4, png_structp, png_create_read_struct, |
michael@0 | 1060 | (png_const_charp user_png_ver, png_voidp error_ptr, |
michael@0 | 1061 | png_error_ptr error_fn, png_error_ptr warn_fn), |
michael@0 | 1062 | PNG_ALLOCATED); |
michael@0 | 1063 | |
michael@0 | 1064 | /* Allocate and initialize png_ptr struct for writing, and any other memory */ |
michael@0 | 1065 | PNG_EXPORTA(5, png_structp, png_create_write_struct, |
michael@0 | 1066 | (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn, |
michael@0 | 1067 | png_error_ptr warn_fn), |
michael@0 | 1068 | PNG_ALLOCATED); |
michael@0 | 1069 | |
michael@0 | 1070 | PNG_EXPORT(6, png_size_t, png_get_compression_buffer_size, |
michael@0 | 1071 | (png_const_structrp png_ptr)); |
michael@0 | 1072 | |
michael@0 | 1073 | PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structrp png_ptr, |
michael@0 | 1074 | png_size_t size)); |
michael@0 | 1075 | |
michael@0 | 1076 | /* Moved from pngconf.h in 1.4.0 and modified to ensure setjmp/longjmp |
michael@0 | 1077 | * match up. |
michael@0 | 1078 | */ |
michael@0 | 1079 | #ifdef PNG_SETJMP_SUPPORTED |
michael@0 | 1080 | /* This function returns the jmp_buf built in to *png_ptr. It must be |
michael@0 | 1081 | * supplied with an appropriate 'longjmp' function to use on that jmp_buf |
michael@0 | 1082 | * unless the default error function is overridden in which case NULL is |
michael@0 | 1083 | * acceptable. The size of the jmp_buf is checked against the actual size |
michael@0 | 1084 | * allocated by the library - the call will return NULL on a mismatch |
michael@0 | 1085 | * indicating an ABI mismatch. |
michael@0 | 1086 | */ |
michael@0 | 1087 | PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structrp png_ptr, |
michael@0 | 1088 | png_longjmp_ptr longjmp_fn, size_t jmp_buf_size)); |
michael@0 | 1089 | # define png_jmpbuf(png_ptr) \ |
michael@0 | 1090 | (*png_set_longjmp_fn((png_ptr), longjmp, (sizeof (jmp_buf)))) |
michael@0 | 1091 | #else |
michael@0 | 1092 | # define png_jmpbuf(png_ptr) \ |
michael@0 | 1093 | (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP) |
michael@0 | 1094 | #endif |
michael@0 | 1095 | /* This function should be used by libpng applications in place of |
michael@0 | 1096 | * longjmp(png_ptr->jmpbuf, val). If longjmp_fn() has been set, it |
michael@0 | 1097 | * will use it; otherwise it will call PNG_ABORT(). This function was |
michael@0 | 1098 | * added in libpng-1.5.0. |
michael@0 | 1099 | */ |
michael@0 | 1100 | PNG_EXPORTA(9, void, png_longjmp, (png_const_structrp png_ptr, int val), |
michael@0 | 1101 | PNG_NORETURN); |
michael@0 | 1102 | |
michael@0 | 1103 | #ifdef PNG_READ_SUPPORTED |
michael@0 | 1104 | /* Reset the compression stream */ |
michael@0 | 1105 | PNG_EXPORTA(10, int, png_reset_zstream, (png_structrp png_ptr), PNG_DEPRECATED); |
michael@0 | 1106 | #endif |
michael@0 | 1107 | |
michael@0 | 1108 | /* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */ |
michael@0 | 1109 | #ifdef PNG_USER_MEM_SUPPORTED |
michael@0 | 1110 | PNG_EXPORTA(11, png_structp, png_create_read_struct_2, |
michael@0 | 1111 | (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn, |
michael@0 | 1112 | png_error_ptr warn_fn, |
michael@0 | 1113 | png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn), |
michael@0 | 1114 | PNG_ALLOCATED); |
michael@0 | 1115 | PNG_EXPORTA(12, png_structp, png_create_write_struct_2, |
michael@0 | 1116 | (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn, |
michael@0 | 1117 | png_error_ptr warn_fn, |
michael@0 | 1118 | png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn), |
michael@0 | 1119 | PNG_ALLOCATED); |
michael@0 | 1120 | #endif |
michael@0 | 1121 | |
michael@0 | 1122 | /* Write the PNG file signature. */ |
michael@0 | 1123 | PNG_EXPORT(13, void, png_write_sig, (png_structrp png_ptr)); |
michael@0 | 1124 | |
michael@0 | 1125 | /* Write a PNG chunk - size, type, (optional) data, CRC. */ |
michael@0 | 1126 | PNG_EXPORT(14, void, png_write_chunk, (png_structrp png_ptr, png_const_bytep |
michael@0 | 1127 | chunk_name, png_const_bytep data, png_size_t length)); |
michael@0 | 1128 | |
michael@0 | 1129 | /* Write the start of a PNG chunk - length and chunk name. */ |
michael@0 | 1130 | PNG_EXPORT(15, void, png_write_chunk_start, (png_structrp png_ptr, |
michael@0 | 1131 | png_const_bytep chunk_name, png_uint_32 length)); |
michael@0 | 1132 | |
michael@0 | 1133 | /* Write the data of a PNG chunk started with png_write_chunk_start(). */ |
michael@0 | 1134 | PNG_EXPORT(16, void, png_write_chunk_data, (png_structrp png_ptr, |
michael@0 | 1135 | png_const_bytep data, png_size_t length)); |
michael@0 | 1136 | |
michael@0 | 1137 | /* Finish a chunk started with png_write_chunk_start() (includes CRC). */ |
michael@0 | 1138 | PNG_EXPORT(17, void, png_write_chunk_end, (png_structrp png_ptr)); |
michael@0 | 1139 | |
michael@0 | 1140 | /* Allocate and initialize the info structure */ |
michael@0 | 1141 | PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_const_structrp png_ptr), |
michael@0 | 1142 | PNG_ALLOCATED); |
michael@0 | 1143 | |
michael@0 | 1144 | /* DEPRECATED: this function allowed init structures to be created using the |
michael@0 | 1145 | * default allocation method (typically malloc). Use is deprecated in 1.6.0 and |
michael@0 | 1146 | * the API will be removed in the future. |
michael@0 | 1147 | */ |
michael@0 | 1148 | PNG_EXPORTA(19, void, png_info_init_3, (png_infopp info_ptr, |
michael@0 | 1149 | png_size_t png_info_struct_size), PNG_DEPRECATED); |
michael@0 | 1150 | |
michael@0 | 1151 | /* Writes all the PNG information before the image. */ |
michael@0 | 1152 | PNG_EXPORT(20, void, png_write_info_before_PLTE, |
michael@0 | 1153 | (png_structrp png_ptr, png_const_inforp info_ptr)); |
michael@0 | 1154 | PNG_EXPORT(21, void, png_write_info, |
michael@0 | 1155 | (png_structrp png_ptr, png_const_inforp info_ptr)); |
michael@0 | 1156 | |
michael@0 | 1157 | #ifdef PNG_SEQUENTIAL_READ_SUPPORTED |
michael@0 | 1158 | /* Read the information before the actual image data. */ |
michael@0 | 1159 | PNG_EXPORT(22, void, png_read_info, |
michael@0 | 1160 | (png_structrp png_ptr, png_inforp info_ptr)); |
michael@0 | 1161 | #endif |
michael@0 | 1162 | |
michael@0 | 1163 | #ifdef PNG_TIME_RFC1123_SUPPORTED |
michael@0 | 1164 | /* Convert to a US string format: there is no localization support in this |
michael@0 | 1165 | * routine. The original implementation used a 29 character buffer in |
michael@0 | 1166 | * png_struct, this will be removed in future versions. |
michael@0 | 1167 | */ |
michael@0 | 1168 | #if PNG_LIBPNG_VER < 10700 |
michael@0 | 1169 | /* To do: remove this from libpng17 (and from libpng17/png.c and pngstruct.h) */ |
michael@0 | 1170 | PNG_EXPORTA(23, png_const_charp, png_convert_to_rfc1123, (png_structrp png_ptr, |
michael@0 | 1171 | png_const_timep ptime),PNG_DEPRECATED); |
michael@0 | 1172 | #endif |
michael@0 | 1173 | PNG_EXPORT(241, int, png_convert_to_rfc1123_buffer, (char out[29], |
michael@0 | 1174 | png_const_timep ptime)); |
michael@0 | 1175 | #endif |
michael@0 | 1176 | |
michael@0 | 1177 | #ifdef PNG_CONVERT_tIME_SUPPORTED |
michael@0 | 1178 | /* Convert from a struct tm to png_time */ |
michael@0 | 1179 | PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime, |
michael@0 | 1180 | const struct tm * ttime)); |
michael@0 | 1181 | |
michael@0 | 1182 | /* Convert from time_t to png_time. Uses gmtime() */ |
michael@0 | 1183 | PNG_EXPORT(25, void, png_convert_from_time_t, (png_timep ptime, time_t ttime)); |
michael@0 | 1184 | #endif /* PNG_CONVERT_tIME_SUPPORTED */ |
michael@0 | 1185 | |
michael@0 | 1186 | #ifdef PNG_READ_EXPAND_SUPPORTED |
michael@0 | 1187 | /* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */ |
michael@0 | 1188 | PNG_EXPORT(26, void, png_set_expand, (png_structrp png_ptr)); |
michael@0 | 1189 | PNG_EXPORT(27, void, png_set_expand_gray_1_2_4_to_8, (png_structrp png_ptr)); |
michael@0 | 1190 | PNG_EXPORT(28, void, png_set_palette_to_rgb, (png_structrp png_ptr)); |
michael@0 | 1191 | PNG_EXPORT(29, void, png_set_tRNS_to_alpha, (png_structrp png_ptr)); |
michael@0 | 1192 | #endif |
michael@0 | 1193 | |
michael@0 | 1194 | #ifdef PNG_READ_EXPAND_16_SUPPORTED |
michael@0 | 1195 | /* Expand to 16-bit channels, forces conversion of palette to RGB and expansion |
michael@0 | 1196 | * of a tRNS chunk if present. |
michael@0 | 1197 | */ |
michael@0 | 1198 | PNG_EXPORT(221, void, png_set_expand_16, (png_structrp png_ptr)); |
michael@0 | 1199 | #endif |
michael@0 | 1200 | |
michael@0 | 1201 | #if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED) |
michael@0 | 1202 | /* Use blue, green, red order for pixels. */ |
michael@0 | 1203 | PNG_EXPORT(30, void, png_set_bgr, (png_structrp png_ptr)); |
michael@0 | 1204 | #endif |
michael@0 | 1205 | |
michael@0 | 1206 | #ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED |
michael@0 | 1207 | /* Expand the grayscale to 24-bit RGB if necessary. */ |
michael@0 | 1208 | PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structrp png_ptr)); |
michael@0 | 1209 | #endif |
michael@0 | 1210 | |
michael@0 | 1211 | #ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED |
michael@0 | 1212 | /* Reduce RGB to grayscale. */ |
michael@0 | 1213 | #define PNG_ERROR_ACTION_NONE 1 |
michael@0 | 1214 | #define PNG_ERROR_ACTION_WARN 2 |
michael@0 | 1215 | #define PNG_ERROR_ACTION_ERROR 3 |
michael@0 | 1216 | #define PNG_RGB_TO_GRAY_DEFAULT (-1)/*for red/green coefficients*/ |
michael@0 | 1217 | |
michael@0 | 1218 | PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structrp png_ptr, |
michael@0 | 1219 | int error_action, double red, double green)) |
michael@0 | 1220 | PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structrp png_ptr, |
michael@0 | 1221 | int error_action, png_fixed_point red, png_fixed_point green)) |
michael@0 | 1222 | |
michael@0 | 1223 | PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structrp |
michael@0 | 1224 | png_ptr)); |
michael@0 | 1225 | #endif |
michael@0 | 1226 | |
michael@0 | 1227 | #ifdef PNG_BUILD_GRAYSCALE_PALETTE_SUPPORTED |
michael@0 | 1228 | PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth, |
michael@0 | 1229 | png_colorp palette)); |
michael@0 | 1230 | #endif |
michael@0 | 1231 | |
michael@0 | 1232 | #ifdef PNG_READ_ALPHA_MODE_SUPPORTED |
michael@0 | 1233 | /* How the alpha channel is interpreted - this affects how the color channels |
michael@0 | 1234 | * of a PNG file are returned to the calling application when an alpha channel, |
michael@0 | 1235 | * or a tRNS chunk in a palette file, is present. |
michael@0 | 1236 | * |
michael@0 | 1237 | * This has no effect on the way pixels are written into a PNG output |
michael@0 | 1238 | * datastream. The color samples in a PNG datastream are never premultiplied |
michael@0 | 1239 | * with the alpha samples. |
michael@0 | 1240 | * |
michael@0 | 1241 | * The default is to return data according to the PNG specification: the alpha |
michael@0 | 1242 | * channel is a linear measure of the contribution of the pixel to the |
michael@0 | 1243 | * corresponding composited pixel, and the color channels are unassociated |
michael@0 | 1244 | * (not premultiplied). The gamma encoded color channels must be scaled |
michael@0 | 1245 | * according to the contribution and to do this it is necessary to undo |
michael@0 | 1246 | * the encoding, scale the color values, perform the composition and reencode |
michael@0 | 1247 | * the values. This is the 'PNG' mode. |
michael@0 | 1248 | * |
michael@0 | 1249 | * The alternative is to 'associate' the alpha with the color information by |
michael@0 | 1250 | * storing color channel values that have been scaled by the alpha. |
michael@0 | 1251 | * image. These are the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' modes |
michael@0 | 1252 | * (the latter being the two common names for associated alpha color channels). |
michael@0 | 1253 | * |
michael@0 | 1254 | * For the 'OPTIMIZED' mode, a pixel is treated as opaque only if the alpha |
michael@0 | 1255 | * value is equal to the maximum value. |
michael@0 | 1256 | * |
michael@0 | 1257 | * The final choice is to gamma encode the alpha channel as well. This is |
michael@0 | 1258 | * broken because, in practice, no implementation that uses this choice |
michael@0 | 1259 | * correctly undoes the encoding before handling alpha composition. Use this |
michael@0 | 1260 | * choice only if other serious errors in the software or hardware you use |
michael@0 | 1261 | * mandate it; the typical serious error is for dark halos to appear around |
michael@0 | 1262 | * opaque areas of the composited PNG image because of arithmetic overflow. |
michael@0 | 1263 | * |
michael@0 | 1264 | * The API function png_set_alpha_mode specifies which of these choices to use |
michael@0 | 1265 | * with an enumerated 'mode' value and the gamma of the required output: |
michael@0 | 1266 | */ |
michael@0 | 1267 | #define PNG_ALPHA_PNG 0 /* according to the PNG standard */ |
michael@0 | 1268 | #define PNG_ALPHA_STANDARD 1 /* according to Porter/Duff */ |
michael@0 | 1269 | #define PNG_ALPHA_ASSOCIATED 1 /* as above; this is the normal practice */ |
michael@0 | 1270 | #define PNG_ALPHA_PREMULTIPLIED 1 /* as above */ |
michael@0 | 1271 | #define PNG_ALPHA_OPTIMIZED 2 /* 'PNG' for opaque pixels, else 'STANDARD' */ |
michael@0 | 1272 | #define PNG_ALPHA_BROKEN 3 /* the alpha channel is gamma encoded */ |
michael@0 | 1273 | |
michael@0 | 1274 | PNG_FP_EXPORT(227, void, png_set_alpha_mode, (png_structrp png_ptr, int mode, |
michael@0 | 1275 | double output_gamma)) |
michael@0 | 1276 | PNG_FIXED_EXPORT(228, void, png_set_alpha_mode_fixed, (png_structrp png_ptr, |
michael@0 | 1277 | int mode, png_fixed_point output_gamma)) |
michael@0 | 1278 | #endif |
michael@0 | 1279 | |
michael@0 | 1280 | #if defined(PNG_GAMMA_SUPPORTED) || defined(PNG_READ_ALPHA_MODE_SUPPORTED) |
michael@0 | 1281 | /* The output_gamma value is a screen gamma in libpng terminology: it expresses |
michael@0 | 1282 | * how to decode the output values, not how they are encoded. |
michael@0 | 1283 | */ |
michael@0 | 1284 | #define PNG_DEFAULT_sRGB -1 /* sRGB gamma and color space */ |
michael@0 | 1285 | #define PNG_GAMMA_MAC_18 -2 /* Old Mac '1.8' gamma and color space */ |
michael@0 | 1286 | #define PNG_GAMMA_sRGB 220000 /* Television standards--matches sRGB gamma */ |
michael@0 | 1287 | #define PNG_GAMMA_LINEAR PNG_FP_1 /* Linear */ |
michael@0 | 1288 | #endif |
michael@0 | 1289 | |
michael@0 | 1290 | /* The following are examples of calls to png_set_alpha_mode to achieve the |
michael@0 | 1291 | * required overall gamma correction and, where necessary, alpha |
michael@0 | 1292 | * premultiplication. |
michael@0 | 1293 | * |
michael@0 | 1294 | * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB); |
michael@0 | 1295 | * This is the default libpng handling of the alpha channel - it is not |
michael@0 | 1296 | * pre-multiplied into the color components. In addition the call states |
michael@0 | 1297 | * that the output is for a sRGB system and causes all PNG files without gAMA |
michael@0 | 1298 | * chunks to be assumed to be encoded using sRGB. |
michael@0 | 1299 | * |
michael@0 | 1300 | * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC); |
michael@0 | 1301 | * In this case the output is assumed to be something like an sRGB conformant |
michael@0 | 1302 | * display preceeded by a power-law lookup table of power 1.45. This is how |
michael@0 | 1303 | * early Mac systems behaved. |
michael@0 | 1304 | * |
michael@0 | 1305 | * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR); |
michael@0 | 1306 | * This is the classic Jim Blinn approach and will work in academic |
michael@0 | 1307 | * environments where everything is done by the book. It has the shortcoming |
michael@0 | 1308 | * of assuming that input PNG data with no gamma information is linear - this |
michael@0 | 1309 | * is unlikely to be correct unless the PNG files where generated locally. |
michael@0 | 1310 | * Most of the time the output precision will be so low as to show |
michael@0 | 1311 | * significant banding in dark areas of the image. |
michael@0 | 1312 | * |
michael@0 | 1313 | * png_set_expand_16(pp); |
michael@0 | 1314 | * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB); |
michael@0 | 1315 | * This is a somewhat more realistic Jim Blinn inspired approach. PNG files |
michael@0 | 1316 | * are assumed to have the sRGB encoding if not marked with a gamma value and |
michael@0 | 1317 | * the output is always 16 bits per component. This permits accurate scaling |
michael@0 | 1318 | * and processing of the data. If you know that your input PNG files were |
michael@0 | 1319 | * generated locally you might need to replace PNG_DEFAULT_sRGB with the |
michael@0 | 1320 | * correct value for your system. |
michael@0 | 1321 | * |
michael@0 | 1322 | * png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB); |
michael@0 | 1323 | * If you just need to composite the PNG image onto an existing background |
michael@0 | 1324 | * and if you control the code that does this you can use the optimization |
michael@0 | 1325 | * setting. In this case you just copy completely opaque pixels to the |
michael@0 | 1326 | * output. For pixels that are not completely transparent (you just skip |
michael@0 | 1327 | * those) you do the composition math using png_composite or png_composite_16 |
michael@0 | 1328 | * below then encode the resultant 8-bit or 16-bit values to match the output |
michael@0 | 1329 | * encoding. |
michael@0 | 1330 | * |
michael@0 | 1331 | * Other cases |
michael@0 | 1332 | * If neither the PNG nor the standard linear encoding work for you because |
michael@0 | 1333 | * of the software or hardware you use then you have a big problem. The PNG |
michael@0 | 1334 | * case will probably result in halos around the image. The linear encoding |
michael@0 | 1335 | * will probably result in a washed out, too bright, image (it's actually too |
michael@0 | 1336 | * contrasty.) Try the ALPHA_OPTIMIZED mode above - this will probably |
michael@0 | 1337 | * substantially reduce the halos. Alternatively try: |
michael@0 | 1338 | * |
michael@0 | 1339 | * png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB); |
michael@0 | 1340 | * This option will also reduce the halos, but there will be slight dark |
michael@0 | 1341 | * halos round the opaque parts of the image where the background is light. |
michael@0 | 1342 | * In the OPTIMIZED mode the halos will be light halos where the background |
michael@0 | 1343 | * is dark. Take your pick - the halos are unavoidable unless you can get |
michael@0 | 1344 | * your hardware/software fixed! (The OPTIMIZED approach is slightly |
michael@0 | 1345 | * faster.) |
michael@0 | 1346 | * |
michael@0 | 1347 | * When the default gamma of PNG files doesn't match the output gamma. |
michael@0 | 1348 | * If you have PNG files with no gamma information png_set_alpha_mode allows |
michael@0 | 1349 | * you to provide a default gamma, but it also sets the ouput gamma to the |
michael@0 | 1350 | * matching value. If you know your PNG files have a gamma that doesn't |
michael@0 | 1351 | * match the output you can take advantage of the fact that |
michael@0 | 1352 | * png_set_alpha_mode always sets the output gamma but only sets the PNG |
michael@0 | 1353 | * default if it is not already set: |
michael@0 | 1354 | * |
michael@0 | 1355 | * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB); |
michael@0 | 1356 | * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC); |
michael@0 | 1357 | * The first call sets both the default and the output gamma values, the |
michael@0 | 1358 | * second call overrides the output gamma without changing the default. This |
michael@0 | 1359 | * is easier than achieving the same effect with png_set_gamma. You must use |
michael@0 | 1360 | * PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will |
michael@0 | 1361 | * fire if more than one call to png_set_alpha_mode and png_set_background is |
michael@0 | 1362 | * made in the same read operation, however multiple calls with PNG_ALPHA_PNG |
michael@0 | 1363 | * are ignored. |
michael@0 | 1364 | */ |
michael@0 | 1365 | |
michael@0 | 1366 | #ifdef PNG_READ_STRIP_ALPHA_SUPPORTED |
michael@0 | 1367 | PNG_EXPORT(36, void, png_set_strip_alpha, (png_structrp png_ptr)); |
michael@0 | 1368 | #endif |
michael@0 | 1369 | |
michael@0 | 1370 | #if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \ |
michael@0 | 1371 | defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED) |
michael@0 | 1372 | PNG_EXPORT(37, void, png_set_swap_alpha, (png_structrp png_ptr)); |
michael@0 | 1373 | #endif |
michael@0 | 1374 | |
michael@0 | 1375 | #if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \ |
michael@0 | 1376 | defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED) |
michael@0 | 1377 | PNG_EXPORT(38, void, png_set_invert_alpha, (png_structrp png_ptr)); |
michael@0 | 1378 | #endif |
michael@0 | 1379 | |
michael@0 | 1380 | #if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED) |
michael@0 | 1381 | /* Add a filler byte to 8-bit Gray or 24-bit RGB images. */ |
michael@0 | 1382 | PNG_EXPORT(39, void, png_set_filler, (png_structrp png_ptr, png_uint_32 filler, |
michael@0 | 1383 | int flags)); |
michael@0 | 1384 | /* The values of the PNG_FILLER_ defines should NOT be changed */ |
michael@0 | 1385 | # define PNG_FILLER_BEFORE 0 |
michael@0 | 1386 | # define PNG_FILLER_AFTER 1 |
michael@0 | 1387 | /* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */ |
michael@0 | 1388 | PNG_EXPORT(40, void, png_set_add_alpha, (png_structrp png_ptr, |
michael@0 | 1389 | png_uint_32 filler, int flags)); |
michael@0 | 1390 | #endif /* PNG_READ_FILLER_SUPPORTED || PNG_WRITE_FILLER_SUPPORTED */ |
michael@0 | 1391 | |
michael@0 | 1392 | #if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED) |
michael@0 | 1393 | /* Swap bytes in 16-bit depth files. */ |
michael@0 | 1394 | PNG_EXPORT(41, void, png_set_swap, (png_structrp png_ptr)); |
michael@0 | 1395 | #endif |
michael@0 | 1396 | |
michael@0 | 1397 | #if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED) |
michael@0 | 1398 | /* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */ |
michael@0 | 1399 | PNG_EXPORT(42, void, png_set_packing, (png_structrp png_ptr)); |
michael@0 | 1400 | #endif |
michael@0 | 1401 | |
michael@0 | 1402 | #if defined(PNG_READ_PACKSWAP_SUPPORTED) || \ |
michael@0 | 1403 | defined(PNG_WRITE_PACKSWAP_SUPPORTED) |
michael@0 | 1404 | /* Swap packing order of pixels in bytes. */ |
michael@0 | 1405 | PNG_EXPORT(43, void, png_set_packswap, (png_structrp png_ptr)); |
michael@0 | 1406 | #endif |
michael@0 | 1407 | |
michael@0 | 1408 | #if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED) |
michael@0 | 1409 | /* Converts files to legal bit depths. */ |
michael@0 | 1410 | PNG_EXPORT(44, void, png_set_shift, (png_structrp png_ptr, png_const_color_8p |
michael@0 | 1411 | true_bits)); |
michael@0 | 1412 | #endif |
michael@0 | 1413 | |
michael@0 | 1414 | #if defined(PNG_READ_INTERLACING_SUPPORTED) || \ |
michael@0 | 1415 | defined(PNG_WRITE_INTERLACING_SUPPORTED) |
michael@0 | 1416 | /* Have the code handle the interlacing. Returns the number of passes. |
michael@0 | 1417 | * MUST be called before png_read_update_info or png_start_read_image, |
michael@0 | 1418 | * otherwise it will not have the desired effect. Note that it is still |
michael@0 | 1419 | * necessary to call png_read_row or png_read_rows png_get_image_height |
michael@0 | 1420 | * times for each pass. |
michael@0 | 1421 | */ |
michael@0 | 1422 | PNG_EXPORT(45, int, png_set_interlace_handling, (png_structrp png_ptr)); |
michael@0 | 1423 | #endif |
michael@0 | 1424 | |
michael@0 | 1425 | #if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED) |
michael@0 | 1426 | /* Invert monochrome files */ |
michael@0 | 1427 | PNG_EXPORT(46, void, png_set_invert_mono, (png_structrp png_ptr)); |
michael@0 | 1428 | #endif |
michael@0 | 1429 | |
michael@0 | 1430 | #ifdef PNG_READ_BACKGROUND_SUPPORTED |
michael@0 | 1431 | /* Handle alpha and tRNS by replacing with a background color. Prior to |
michael@0 | 1432 | * libpng-1.5.4 this API must not be called before the PNG file header has been |
michael@0 | 1433 | * read. Doing so will result in unexpected behavior and possible warnings or |
michael@0 | 1434 | * errors if the PNG file contains a bKGD chunk. |
michael@0 | 1435 | */ |
michael@0 | 1436 | PNG_FP_EXPORT(47, void, png_set_background, (png_structrp png_ptr, |
michael@0 | 1437 | png_const_color_16p background_color, int background_gamma_code, |
michael@0 | 1438 | int need_expand, double background_gamma)) |
michael@0 | 1439 | PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structrp png_ptr, |
michael@0 | 1440 | png_const_color_16p background_color, int background_gamma_code, |
michael@0 | 1441 | int need_expand, png_fixed_point background_gamma)) |
michael@0 | 1442 | #endif |
michael@0 | 1443 | #ifdef PNG_READ_BACKGROUND_SUPPORTED |
michael@0 | 1444 | # define PNG_BACKGROUND_GAMMA_UNKNOWN 0 |
michael@0 | 1445 | # define PNG_BACKGROUND_GAMMA_SCREEN 1 |
michael@0 | 1446 | # define PNG_BACKGROUND_GAMMA_FILE 2 |
michael@0 | 1447 | # define PNG_BACKGROUND_GAMMA_UNIQUE 3 |
michael@0 | 1448 | #endif |
michael@0 | 1449 | |
michael@0 | 1450 | #ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED |
michael@0 | 1451 | /* Scale a 16-bit depth file down to 8-bit, accurately. */ |
michael@0 | 1452 | PNG_EXPORT(229, void, png_set_scale_16, (png_structrp png_ptr)); |
michael@0 | 1453 | #endif |
michael@0 | 1454 | |
michael@0 | 1455 | #ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED |
michael@0 | 1456 | #define PNG_READ_16_TO_8 SUPPORTED /* Name prior to 1.5.4 */ |
michael@0 | 1457 | /* Strip the second byte of information from a 16-bit depth file. */ |
michael@0 | 1458 | PNG_EXPORT(48, void, png_set_strip_16, (png_structrp png_ptr)); |
michael@0 | 1459 | #endif |
michael@0 | 1460 | |
michael@0 | 1461 | #ifdef PNG_READ_QUANTIZE_SUPPORTED |
michael@0 | 1462 | /* Turn on quantizing, and reduce the palette to the number of colors |
michael@0 | 1463 | * available. |
michael@0 | 1464 | */ |
michael@0 | 1465 | PNG_EXPORT(49, void, png_set_quantize, (png_structrp png_ptr, |
michael@0 | 1466 | png_colorp palette, int num_palette, int maximum_colors, |
michael@0 | 1467 | png_const_uint_16p histogram, int full_quantize)); |
michael@0 | 1468 | #endif |
michael@0 | 1469 | |
michael@0 | 1470 | #ifdef PNG_READ_GAMMA_SUPPORTED |
michael@0 | 1471 | /* The threshold on gamma processing is configurable but hard-wired into the |
michael@0 | 1472 | * library. The following is the floating point variant. |
michael@0 | 1473 | */ |
michael@0 | 1474 | #define PNG_GAMMA_THRESHOLD (PNG_GAMMA_THRESHOLD_FIXED*.00001) |
michael@0 | 1475 | |
michael@0 | 1476 | /* Handle gamma correction. Screen_gamma=(display_exponent). |
michael@0 | 1477 | * NOTE: this API simply sets the screen and file gamma values. It will |
michael@0 | 1478 | * therefore override the value for gamma in a PNG file if it is called after |
michael@0 | 1479 | * the file header has been read - use with care - call before reading the PNG |
michael@0 | 1480 | * file for best results! |
michael@0 | 1481 | * |
michael@0 | 1482 | * These routines accept the same gamma values as png_set_alpha_mode (described |
michael@0 | 1483 | * above). The PNG_GAMMA_ defines and PNG_DEFAULT_sRGB can be passed to either |
michael@0 | 1484 | * API (floating point or fixed.) Notice, however, that the 'file_gamma' value |
michael@0 | 1485 | * is the inverse of a 'screen gamma' value. |
michael@0 | 1486 | */ |
michael@0 | 1487 | PNG_FP_EXPORT(50, void, png_set_gamma, (png_structrp png_ptr, |
michael@0 | 1488 | double screen_gamma, double override_file_gamma)) |
michael@0 | 1489 | PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structrp png_ptr, |
michael@0 | 1490 | png_fixed_point screen_gamma, png_fixed_point override_file_gamma)) |
michael@0 | 1491 | #endif |
michael@0 | 1492 | |
michael@0 | 1493 | #ifdef PNG_WRITE_FLUSH_SUPPORTED |
michael@0 | 1494 | /* Set how many lines between output flushes - 0 for no flushing */ |
michael@0 | 1495 | PNG_EXPORT(51, void, png_set_flush, (png_structrp png_ptr, int nrows)); |
michael@0 | 1496 | /* Flush the current PNG output buffer */ |
michael@0 | 1497 | PNG_EXPORT(52, void, png_write_flush, (png_structrp png_ptr)); |
michael@0 | 1498 | #endif |
michael@0 | 1499 | |
michael@0 | 1500 | /* Optional update palette with requested transformations */ |
michael@0 | 1501 | PNG_EXPORT(53, void, png_start_read_image, (png_structrp png_ptr)); |
michael@0 | 1502 | |
michael@0 | 1503 | /* Optional call to update the users info structure */ |
michael@0 | 1504 | PNG_EXPORT(54, void, png_read_update_info, (png_structrp png_ptr, |
michael@0 | 1505 | png_inforp info_ptr)); |
michael@0 | 1506 | |
michael@0 | 1507 | #ifdef PNG_SEQUENTIAL_READ_SUPPORTED |
michael@0 | 1508 | /* Read one or more rows of image data. */ |
michael@0 | 1509 | PNG_EXPORT(55, void, png_read_rows, (png_structrp png_ptr, png_bytepp row, |
michael@0 | 1510 | png_bytepp display_row, png_uint_32 num_rows)); |
michael@0 | 1511 | #endif |
michael@0 | 1512 | |
michael@0 | 1513 | #ifdef PNG_SEQUENTIAL_READ_SUPPORTED |
michael@0 | 1514 | /* Read a row of data. */ |
michael@0 | 1515 | PNG_EXPORT(56, void, png_read_row, (png_structrp png_ptr, png_bytep row, |
michael@0 | 1516 | png_bytep display_row)); |
michael@0 | 1517 | #endif |
michael@0 | 1518 | |
michael@0 | 1519 | #ifdef PNG_SEQUENTIAL_READ_SUPPORTED |
michael@0 | 1520 | /* Read the whole image into memory at once. */ |
michael@0 | 1521 | PNG_EXPORT(57, void, png_read_image, (png_structrp png_ptr, png_bytepp image)); |
michael@0 | 1522 | #endif |
michael@0 | 1523 | |
michael@0 | 1524 | /* Write a row of image data */ |
michael@0 | 1525 | PNG_EXPORT(58, void, png_write_row, (png_structrp png_ptr, |
michael@0 | 1526 | png_const_bytep row)); |
michael@0 | 1527 | |
michael@0 | 1528 | /* Write a few rows of image data: (*row) is not written; however, the type |
michael@0 | 1529 | * is declared as writeable to maintain compatibility with previous versions |
michael@0 | 1530 | * of libpng and to allow the 'display_row' array from read_rows to be passed |
michael@0 | 1531 | * unchanged to write_rows. |
michael@0 | 1532 | */ |
michael@0 | 1533 | PNG_EXPORT(59, void, png_write_rows, (png_structrp png_ptr, png_bytepp row, |
michael@0 | 1534 | png_uint_32 num_rows)); |
michael@0 | 1535 | |
michael@0 | 1536 | /* Write the image data */ |
michael@0 | 1537 | PNG_EXPORT(60, void, png_write_image, (png_structrp png_ptr, png_bytepp image)); |
michael@0 | 1538 | |
michael@0 | 1539 | /* Write the end of the PNG file. */ |
michael@0 | 1540 | PNG_EXPORT(61, void, png_write_end, (png_structrp png_ptr, |
michael@0 | 1541 | png_inforp info_ptr)); |
michael@0 | 1542 | |
michael@0 | 1543 | #ifdef PNG_SEQUENTIAL_READ_SUPPORTED |
michael@0 | 1544 | /* Read the end of the PNG file. */ |
michael@0 | 1545 | PNG_EXPORT(62, void, png_read_end, (png_structrp png_ptr, png_inforp info_ptr)); |
michael@0 | 1546 | #endif |
michael@0 | 1547 | |
michael@0 | 1548 | /* Free any memory associated with the png_info_struct */ |
michael@0 | 1549 | PNG_EXPORT(63, void, png_destroy_info_struct, (png_const_structrp png_ptr, |
michael@0 | 1550 | png_infopp info_ptr_ptr)); |
michael@0 | 1551 | |
michael@0 | 1552 | /* Free any memory associated with the png_struct and the png_info_structs */ |
michael@0 | 1553 | PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr, |
michael@0 | 1554 | png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr)); |
michael@0 | 1555 | |
michael@0 | 1556 | /* Free any memory associated with the png_struct and the png_info_structs */ |
michael@0 | 1557 | PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr, |
michael@0 | 1558 | png_infopp info_ptr_ptr)); |
michael@0 | 1559 | |
michael@0 | 1560 | /* Set the libpng method of handling chunk CRC errors */ |
michael@0 | 1561 | PNG_EXPORT(66, void, png_set_crc_action, (png_structrp png_ptr, int crit_action, |
michael@0 | 1562 | int ancil_action)); |
michael@0 | 1563 | |
michael@0 | 1564 | /* Values for png_set_crc_action() say how to handle CRC errors in |
michael@0 | 1565 | * ancillary and critical chunks, and whether to use the data contained |
michael@0 | 1566 | * therein. Note that it is impossible to "discard" data in a critical |
michael@0 | 1567 | * chunk. For versions prior to 0.90, the action was always error/quit, |
michael@0 | 1568 | * whereas in version 0.90 and later, the action for CRC errors in ancillary |
michael@0 | 1569 | * chunks is warn/discard. These values should NOT be changed. |
michael@0 | 1570 | * |
michael@0 | 1571 | * value action:critical action:ancillary |
michael@0 | 1572 | */ |
michael@0 | 1573 | #define PNG_CRC_DEFAULT 0 /* error/quit warn/discard data */ |
michael@0 | 1574 | #define PNG_CRC_ERROR_QUIT 1 /* error/quit error/quit */ |
michael@0 | 1575 | #define PNG_CRC_WARN_DISCARD 2 /* (INVALID) warn/discard data */ |
michael@0 | 1576 | #define PNG_CRC_WARN_USE 3 /* warn/use data warn/use data */ |
michael@0 | 1577 | #define PNG_CRC_QUIET_USE 4 /* quiet/use data quiet/use data */ |
michael@0 | 1578 | #define PNG_CRC_NO_CHANGE 5 /* use current value use current value */ |
michael@0 | 1579 | |
michael@0 | 1580 | /* These functions give the user control over the scan-line filtering in |
michael@0 | 1581 | * libpng and the compression methods used by zlib. These functions are |
michael@0 | 1582 | * mainly useful for testing, as the defaults should work with most users. |
michael@0 | 1583 | * Those users who are tight on memory or want faster performance at the |
michael@0 | 1584 | * expense of compression can modify them. See the compression library |
michael@0 | 1585 | * header file (zlib.h) for an explination of the compression functions. |
michael@0 | 1586 | */ |
michael@0 | 1587 | |
michael@0 | 1588 | /* Set the filtering method(s) used by libpng. Currently, the only valid |
michael@0 | 1589 | * value for "method" is 0. |
michael@0 | 1590 | */ |
michael@0 | 1591 | PNG_EXPORT(67, void, png_set_filter, (png_structrp png_ptr, int method, |
michael@0 | 1592 | int filters)); |
michael@0 | 1593 | |
michael@0 | 1594 | /* Flags for png_set_filter() to say which filters to use. The flags |
michael@0 | 1595 | * are chosen so that they don't conflict with real filter types |
michael@0 | 1596 | * below, in case they are supplied instead of the #defined constants. |
michael@0 | 1597 | * These values should NOT be changed. |
michael@0 | 1598 | */ |
michael@0 | 1599 | #define PNG_NO_FILTERS 0x00 |
michael@0 | 1600 | #define PNG_FILTER_NONE 0x08 |
michael@0 | 1601 | #define PNG_FILTER_SUB 0x10 |
michael@0 | 1602 | #define PNG_FILTER_UP 0x20 |
michael@0 | 1603 | #define PNG_FILTER_AVG 0x40 |
michael@0 | 1604 | #define PNG_FILTER_PAETH 0x80 |
michael@0 | 1605 | #define PNG_ALL_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP | \ |
michael@0 | 1606 | PNG_FILTER_AVG | PNG_FILTER_PAETH) |
michael@0 | 1607 | |
michael@0 | 1608 | /* Filter values (not flags) - used in pngwrite.c, pngwutil.c for now. |
michael@0 | 1609 | * These defines should NOT be changed. |
michael@0 | 1610 | */ |
michael@0 | 1611 | #define PNG_FILTER_VALUE_NONE 0 |
michael@0 | 1612 | #define PNG_FILTER_VALUE_SUB 1 |
michael@0 | 1613 | #define PNG_FILTER_VALUE_UP 2 |
michael@0 | 1614 | #define PNG_FILTER_VALUE_AVG 3 |
michael@0 | 1615 | #define PNG_FILTER_VALUE_PAETH 4 |
michael@0 | 1616 | #define PNG_FILTER_VALUE_LAST 5 |
michael@0 | 1617 | |
michael@0 | 1618 | #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */ |
michael@0 | 1619 | /* The "heuristic_method" is given by one of the PNG_FILTER_HEURISTIC_ |
michael@0 | 1620 | * defines, either the default (minimum-sum-of-absolute-differences), or |
michael@0 | 1621 | * the experimental method (weighted-minimum-sum-of-absolute-differences). |
michael@0 | 1622 | * |
michael@0 | 1623 | * Weights are factors >= 1.0, indicating how important it is to keep the |
michael@0 | 1624 | * filter type consistent between rows. Larger numbers mean the current |
michael@0 | 1625 | * filter is that many times as likely to be the same as the "num_weights" |
michael@0 | 1626 | * previous filters. This is cumulative for each previous row with a weight. |
michael@0 | 1627 | * There needs to be "num_weights" values in "filter_weights", or it can be |
michael@0 | 1628 | * NULL if the weights aren't being specified. Weights have no influence on |
michael@0 | 1629 | * the selection of the first row filter. Well chosen weights can (in theory) |
michael@0 | 1630 | * improve the compression for a given image. |
michael@0 | 1631 | * |
michael@0 | 1632 | * Costs are factors >= 1.0 indicating the relative decoding costs of a |
michael@0 | 1633 | * filter type. Higher costs indicate more decoding expense, and are |
michael@0 | 1634 | * therefore less likely to be selected over a filter with lower computational |
michael@0 | 1635 | * costs. There needs to be a value in "filter_costs" for each valid filter |
michael@0 | 1636 | * type (given by PNG_FILTER_VALUE_LAST), or it can be NULL if you aren't |
michael@0 | 1637 | * setting the costs. Costs try to improve the speed of decompression without |
michael@0 | 1638 | * unduly increasing the compressed image size. |
michael@0 | 1639 | * |
michael@0 | 1640 | * A negative weight or cost indicates the default value is to be used, and |
michael@0 | 1641 | * values in the range [0.0, 1.0) indicate the value is to remain unchanged. |
michael@0 | 1642 | * The default values for both weights and costs are currently 1.0, but may |
michael@0 | 1643 | * change if good general weighting/cost heuristics can be found. If both |
michael@0 | 1644 | * the weights and costs are set to 1.0, this degenerates the WEIGHTED method |
michael@0 | 1645 | * to the UNWEIGHTED method, but with added encoding time/computation. |
michael@0 | 1646 | */ |
michael@0 | 1647 | PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structrp png_ptr, |
michael@0 | 1648 | int heuristic_method, int num_weights, png_const_doublep filter_weights, |
michael@0 | 1649 | png_const_doublep filter_costs)) |
michael@0 | 1650 | PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed, |
michael@0 | 1651 | (png_structrp png_ptr, int heuristic_method, int num_weights, |
michael@0 | 1652 | png_const_fixed_point_p filter_weights, |
michael@0 | 1653 | png_const_fixed_point_p filter_costs)) |
michael@0 | 1654 | #endif /* PNG_WRITE_WEIGHTED_FILTER_SUPPORTED */ |
michael@0 | 1655 | |
michael@0 | 1656 | /* Heuristic used for row filter selection. These defines should NOT be |
michael@0 | 1657 | * changed. |
michael@0 | 1658 | */ |
michael@0 | 1659 | #define PNG_FILTER_HEURISTIC_DEFAULT 0 /* Currently "UNWEIGHTED" */ |
michael@0 | 1660 | #define PNG_FILTER_HEURISTIC_UNWEIGHTED 1 /* Used by libpng < 0.95 */ |
michael@0 | 1661 | #define PNG_FILTER_HEURISTIC_WEIGHTED 2 /* Experimental feature */ |
michael@0 | 1662 | #define PNG_FILTER_HEURISTIC_LAST 3 /* Not a valid value */ |
michael@0 | 1663 | |
michael@0 | 1664 | #ifdef PNG_WRITE_SUPPORTED |
michael@0 | 1665 | /* Set the library compression level. Currently, valid values range from |
michael@0 | 1666 | * 0 - 9, corresponding directly to the zlib compression levels 0 - 9 |
michael@0 | 1667 | * (0 - no compression, 9 - "maximal" compression). Note that tests have |
michael@0 | 1668 | * shown that zlib compression levels 3-6 usually perform as well as level 9 |
michael@0 | 1669 | * for PNG images, and do considerably fewer caclulations. In the future, |
michael@0 | 1670 | * these values may not correspond directly to the zlib compression levels. |
michael@0 | 1671 | */ |
michael@0 | 1672 | PNG_EXPORT(69, void, png_set_compression_level, (png_structrp png_ptr, |
michael@0 | 1673 | int level)); |
michael@0 | 1674 | |
michael@0 | 1675 | PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structrp png_ptr, |
michael@0 | 1676 | int mem_level)); |
michael@0 | 1677 | |
michael@0 | 1678 | PNG_EXPORT(71, void, png_set_compression_strategy, (png_structrp png_ptr, |
michael@0 | 1679 | int strategy)); |
michael@0 | 1680 | |
michael@0 | 1681 | /* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a |
michael@0 | 1682 | * smaller value of window_bits if it can do so safely. |
michael@0 | 1683 | */ |
michael@0 | 1684 | PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structrp png_ptr, |
michael@0 | 1685 | int window_bits)); |
michael@0 | 1686 | |
michael@0 | 1687 | PNG_EXPORT(73, void, png_set_compression_method, (png_structrp png_ptr, |
michael@0 | 1688 | int method)); |
michael@0 | 1689 | #endif |
michael@0 | 1690 | |
michael@0 | 1691 | #ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED |
michael@0 | 1692 | /* Also set zlib parameters for compressing non-IDAT chunks */ |
michael@0 | 1693 | PNG_EXPORT(222, void, png_set_text_compression_level, (png_structrp png_ptr, |
michael@0 | 1694 | int level)); |
michael@0 | 1695 | |
michael@0 | 1696 | PNG_EXPORT(223, void, png_set_text_compression_mem_level, (png_structrp png_ptr, |
michael@0 | 1697 | int mem_level)); |
michael@0 | 1698 | |
michael@0 | 1699 | PNG_EXPORT(224, void, png_set_text_compression_strategy, (png_structrp png_ptr, |
michael@0 | 1700 | int strategy)); |
michael@0 | 1701 | |
michael@0 | 1702 | /* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a |
michael@0 | 1703 | * smaller value of window_bits if it can do so safely. |
michael@0 | 1704 | */ |
michael@0 | 1705 | PNG_EXPORT(225, void, png_set_text_compression_window_bits, |
michael@0 | 1706 | (png_structrp png_ptr, int window_bits)); |
michael@0 | 1707 | |
michael@0 | 1708 | PNG_EXPORT(226, void, png_set_text_compression_method, (png_structrp png_ptr, |
michael@0 | 1709 | int method)); |
michael@0 | 1710 | #endif /* PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED */ |
michael@0 | 1711 | |
michael@0 | 1712 | /* These next functions are called for input/output, memory, and error |
michael@0 | 1713 | * handling. They are in the file pngrio.c, pngwio.c, and pngerror.c, |
michael@0 | 1714 | * and call standard C I/O routines such as fread(), fwrite(), and |
michael@0 | 1715 | * fprintf(). These functions can be made to use other I/O routines |
michael@0 | 1716 | * at run time for those applications that need to handle I/O in a |
michael@0 | 1717 | * different manner by calling png_set_???_fn(). See libpng-manual.txt for |
michael@0 | 1718 | * more information. |
michael@0 | 1719 | */ |
michael@0 | 1720 | |
michael@0 | 1721 | #ifdef PNG_STDIO_SUPPORTED |
michael@0 | 1722 | /* Initialize the input/output for the PNG file to the default functions. */ |
michael@0 | 1723 | PNG_EXPORT(74, void, png_init_io, (png_structrp png_ptr, png_FILE_p fp)); |
michael@0 | 1724 | #endif |
michael@0 | 1725 | |
michael@0 | 1726 | /* Replace the (error and abort), and warning functions with user |
michael@0 | 1727 | * supplied functions. If no messages are to be printed you must still |
michael@0 | 1728 | * write and use replacement functions. The replacement error_fn should |
michael@0 | 1729 | * still do a longjmp to the last setjmp location if you are using this |
michael@0 | 1730 | * method of error handling. If error_fn or warning_fn is NULL, the |
michael@0 | 1731 | * default function will be used. |
michael@0 | 1732 | */ |
michael@0 | 1733 | |
michael@0 | 1734 | PNG_EXPORT(75, void, png_set_error_fn, (png_structrp png_ptr, |
michael@0 | 1735 | png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warning_fn)); |
michael@0 | 1736 | |
michael@0 | 1737 | /* Return the user pointer associated with the error functions */ |
michael@0 | 1738 | PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structrp png_ptr)); |
michael@0 | 1739 | |
michael@0 | 1740 | /* Replace the default data output functions with a user supplied one(s). |
michael@0 | 1741 | * If buffered output is not used, then output_flush_fn can be set to NULL. |
michael@0 | 1742 | * If PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile time |
michael@0 | 1743 | * output_flush_fn will be ignored (and thus can be NULL). |
michael@0 | 1744 | * It is probably a mistake to use NULL for output_flush_fn if |
michael@0 | 1745 | * write_data_fn is not also NULL unless you have built libpng with |
michael@0 | 1746 | * PNG_WRITE_FLUSH_SUPPORTED undefined, because in this case libpng's |
michael@0 | 1747 | * default flush function, which uses the standard *FILE structure, will |
michael@0 | 1748 | * be used. |
michael@0 | 1749 | */ |
michael@0 | 1750 | PNG_EXPORT(77, void, png_set_write_fn, (png_structrp png_ptr, png_voidp io_ptr, |
michael@0 | 1751 | png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn)); |
michael@0 | 1752 | |
michael@0 | 1753 | /* Replace the default data input function with a user supplied one. */ |
michael@0 | 1754 | PNG_EXPORT(78, void, png_set_read_fn, (png_structrp png_ptr, png_voidp io_ptr, |
michael@0 | 1755 | png_rw_ptr read_data_fn)); |
michael@0 | 1756 | |
michael@0 | 1757 | /* Return the user pointer associated with the I/O functions */ |
michael@0 | 1758 | PNG_EXPORT(79, png_voidp, png_get_io_ptr, (png_const_structrp png_ptr)); |
michael@0 | 1759 | |
michael@0 | 1760 | PNG_EXPORT(80, void, png_set_read_status_fn, (png_structrp png_ptr, |
michael@0 | 1761 | png_read_status_ptr read_row_fn)); |
michael@0 | 1762 | |
michael@0 | 1763 | PNG_EXPORT(81, void, png_set_write_status_fn, (png_structrp png_ptr, |
michael@0 | 1764 | png_write_status_ptr write_row_fn)); |
michael@0 | 1765 | |
michael@0 | 1766 | #ifdef PNG_USER_MEM_SUPPORTED |
michael@0 | 1767 | /* Replace the default memory allocation functions with user supplied one(s). */ |
michael@0 | 1768 | PNG_EXPORT(82, void, png_set_mem_fn, (png_structrp png_ptr, png_voidp mem_ptr, |
michael@0 | 1769 | png_malloc_ptr malloc_fn, png_free_ptr free_fn)); |
michael@0 | 1770 | /* Return the user pointer associated with the memory functions */ |
michael@0 | 1771 | PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structrp png_ptr)); |
michael@0 | 1772 | #endif |
michael@0 | 1773 | |
michael@0 | 1774 | #ifdef PNG_READ_USER_TRANSFORM_SUPPORTED |
michael@0 | 1775 | PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structrp png_ptr, |
michael@0 | 1776 | png_user_transform_ptr read_user_transform_fn)); |
michael@0 | 1777 | #endif |
michael@0 | 1778 | |
michael@0 | 1779 | #ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED |
michael@0 | 1780 | PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structrp png_ptr, |
michael@0 | 1781 | png_user_transform_ptr write_user_transform_fn)); |
michael@0 | 1782 | #endif |
michael@0 | 1783 | |
michael@0 | 1784 | #ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED |
michael@0 | 1785 | PNG_EXPORT(86, void, png_set_user_transform_info, (png_structrp png_ptr, |
michael@0 | 1786 | png_voidp user_transform_ptr, int user_transform_depth, |
michael@0 | 1787 | int user_transform_channels)); |
michael@0 | 1788 | /* Return the user pointer associated with the user transform functions */ |
michael@0 | 1789 | PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr, |
michael@0 | 1790 | (png_const_structrp png_ptr)); |
michael@0 | 1791 | #endif |
michael@0 | 1792 | |
michael@0 | 1793 | #ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED |
michael@0 | 1794 | /* Return information about the row currently being processed. Note that these |
michael@0 | 1795 | * APIs do not fail but will return unexpected results if called outside a user |
michael@0 | 1796 | * transform callback. Also note that when transforming an interlaced image the |
michael@0 | 1797 | * row number is the row number within the sub-image of the interlace pass, so |
michael@0 | 1798 | * the value will increase to the height of the sub-image (not the full image) |
michael@0 | 1799 | * then reset to 0 for the next pass. |
michael@0 | 1800 | * |
michael@0 | 1801 | * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to |
michael@0 | 1802 | * find the output pixel (x,y) given an interlaced sub-image pixel |
michael@0 | 1803 | * (row,col,pass). (See below for these macros.) |
michael@0 | 1804 | */ |
michael@0 | 1805 | PNG_EXPORT(217, png_uint_32, png_get_current_row_number, (png_const_structrp)); |
michael@0 | 1806 | PNG_EXPORT(218, png_byte, png_get_current_pass_number, (png_const_structrp)); |
michael@0 | 1807 | #endif |
michael@0 | 1808 | |
michael@0 | 1809 | #ifdef PNG_READ_USER_CHUNKS_SUPPORTED |
michael@0 | 1810 | /* This callback is called only for *unknown* chunks. If |
michael@0 | 1811 | * PNG_HANDLE_AS_UNKNOWN_SUPPORTED is set then it is possible to set known |
michael@0 | 1812 | * chunks to be treated as unknown, however in this case the callback must do |
michael@0 | 1813 | * any processing required by the chunk (e.g. by calling the appropriate |
michael@0 | 1814 | * png_set_ APIs.) |
michael@0 | 1815 | * |
michael@0 | 1816 | * There is no write support - on write, by default, all the chunks in the |
michael@0 | 1817 | * 'unknown' list are written in the specified position. |
michael@0 | 1818 | * |
michael@0 | 1819 | * The integer return from the callback function is interpreted thus: |
michael@0 | 1820 | * |
michael@0 | 1821 | * negative: An error occured, png_chunk_error will be called. |
michael@0 | 1822 | * zero: The chunk was not handled, the chunk will be saved. A critical |
michael@0 | 1823 | * chunk will cause an error at this point unless it is to be saved. |
michael@0 | 1824 | * positive: The chunk was handled, libpng will ignore/discard it. |
michael@0 | 1825 | * |
michael@0 | 1826 | * See "INTERACTION WTIH USER CHUNK CALLBACKS" below for important notes about |
michael@0 | 1827 | * how this behavior will change in libpng 1.7 |
michael@0 | 1828 | */ |
michael@0 | 1829 | PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structrp png_ptr, |
michael@0 | 1830 | png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn)); |
michael@0 | 1831 | #endif |
michael@0 | 1832 | |
michael@0 | 1833 | #ifdef PNG_USER_CHUNKS_SUPPORTED |
michael@0 | 1834 | PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structrp png_ptr)); |
michael@0 | 1835 | #endif |
michael@0 | 1836 | |
michael@0 | 1837 | #ifdef PNG_PROGRESSIVE_READ_SUPPORTED |
michael@0 | 1838 | /* Sets the function callbacks for the push reader, and a pointer to a |
michael@0 | 1839 | * user-defined structure available to the callback functions. |
michael@0 | 1840 | */ |
michael@0 | 1841 | PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structrp png_ptr, |
michael@0 | 1842 | png_voidp progressive_ptr, png_progressive_info_ptr info_fn, |
michael@0 | 1843 | png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn)); |
michael@0 | 1844 | |
michael@0 | 1845 | /* Returns the user pointer associated with the push read functions */ |
michael@0 | 1846 | PNG_EXPORT(91, png_voidp, png_get_progressive_ptr, |
michael@0 | 1847 | (png_const_structrp png_ptr)); |
michael@0 | 1848 | |
michael@0 | 1849 | /* Function to be called when data becomes available */ |
michael@0 | 1850 | PNG_EXPORT(92, void, png_process_data, (png_structrp png_ptr, |
michael@0 | 1851 | png_inforp info_ptr, png_bytep buffer, png_size_t buffer_size)); |
michael@0 | 1852 | |
michael@0 | 1853 | /* A function which may be called *only* within png_process_data to stop the |
michael@0 | 1854 | * processing of any more data. The function returns the number of bytes |
michael@0 | 1855 | * remaining, excluding any that libpng has cached internally. A subsequent |
michael@0 | 1856 | * call to png_process_data must supply these bytes again. If the argument |
michael@0 | 1857 | * 'save' is set to true the routine will first save all the pending data and |
michael@0 | 1858 | * will always return 0. |
michael@0 | 1859 | */ |
michael@0 | 1860 | PNG_EXPORT(219, png_size_t, png_process_data_pause, (png_structrp, int save)); |
michael@0 | 1861 | |
michael@0 | 1862 | /* A function which may be called *only* outside (after) a call to |
michael@0 | 1863 | * png_process_data. It returns the number of bytes of data to skip in the |
michael@0 | 1864 | * input. Normally it will return 0, but if it returns a non-zero value the |
michael@0 | 1865 | * application must skip than number of bytes of input data and pass the |
michael@0 | 1866 | * following data to the next call to png_process_data. |
michael@0 | 1867 | */ |
michael@0 | 1868 | PNG_EXPORT(220, png_uint_32, png_process_data_skip, (png_structrp)); |
michael@0 | 1869 | |
michael@0 | 1870 | #ifdef PNG_READ_INTERLACING_SUPPORTED |
michael@0 | 1871 | /* Function that combines rows. 'new_row' is a flag that should come from |
michael@0 | 1872 | * the callback and be non-NULL if anything needs to be done; the library |
michael@0 | 1873 | * stores its own version of the new data internally and ignores the passed |
michael@0 | 1874 | * in value. |
michael@0 | 1875 | */ |
michael@0 | 1876 | PNG_EXPORT(93, void, png_progressive_combine_row, (png_const_structrp png_ptr, |
michael@0 | 1877 | png_bytep old_row, png_const_bytep new_row)); |
michael@0 | 1878 | #endif /* PNG_READ_INTERLACING_SUPPORTED */ |
michael@0 | 1879 | #endif /* PNG_PROGRESSIVE_READ_SUPPORTED */ |
michael@0 | 1880 | |
michael@0 | 1881 | PNG_EXPORTA(94, png_voidp, png_malloc, (png_const_structrp png_ptr, |
michael@0 | 1882 | png_alloc_size_t size), PNG_ALLOCATED); |
michael@0 | 1883 | /* Added at libpng version 1.4.0 */ |
michael@0 | 1884 | PNG_EXPORTA(95, png_voidp, png_calloc, (png_const_structrp png_ptr, |
michael@0 | 1885 | png_alloc_size_t size), PNG_ALLOCATED); |
michael@0 | 1886 | |
michael@0 | 1887 | /* Added at libpng version 1.2.4 */ |
michael@0 | 1888 | PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_const_structrp png_ptr, |
michael@0 | 1889 | png_alloc_size_t size), PNG_ALLOCATED); |
michael@0 | 1890 | |
michael@0 | 1891 | /* Frees a pointer allocated by png_malloc() */ |
michael@0 | 1892 | PNG_EXPORT(97, void, png_free, (png_const_structrp png_ptr, png_voidp ptr)); |
michael@0 | 1893 | |
michael@0 | 1894 | /* Free data that was allocated internally */ |
michael@0 | 1895 | PNG_EXPORT(98, void, png_free_data, (png_const_structrp png_ptr, |
michael@0 | 1896 | png_inforp info_ptr, png_uint_32 free_me, int num)); |
michael@0 | 1897 | |
michael@0 | 1898 | /* Reassign responsibility for freeing existing data, whether allocated |
michael@0 | 1899 | * by libpng or by the application; this works on the png_info structure passed |
michael@0 | 1900 | * in, it does not change the state for other png_info structures. |
michael@0 | 1901 | * |
michael@0 | 1902 | * It is unlikely that this function works correctly as of 1.6.0 and using it |
michael@0 | 1903 | * may result either in memory leaks or double free of allocated data. |
michael@0 | 1904 | */ |
michael@0 | 1905 | PNG_EXPORT(99, void, png_data_freer, (png_const_structrp png_ptr, |
michael@0 | 1906 | png_inforp info_ptr, int freer, png_uint_32 mask)); |
michael@0 | 1907 | |
michael@0 | 1908 | /* Assignments for png_data_freer */ |
michael@0 | 1909 | #define PNG_DESTROY_WILL_FREE_DATA 1 |
michael@0 | 1910 | #define PNG_SET_WILL_FREE_DATA 1 |
michael@0 | 1911 | #define PNG_USER_WILL_FREE_DATA 2 |
michael@0 | 1912 | /* Flags for png_ptr->free_me and info_ptr->free_me */ |
michael@0 | 1913 | #define PNG_FREE_HIST 0x0008 |
michael@0 | 1914 | #define PNG_FREE_ICCP 0x0010 |
michael@0 | 1915 | #define PNG_FREE_SPLT 0x0020 |
michael@0 | 1916 | #define PNG_FREE_ROWS 0x0040 |
michael@0 | 1917 | #define PNG_FREE_PCAL 0x0080 |
michael@0 | 1918 | #define PNG_FREE_SCAL 0x0100 |
michael@0 | 1919 | #ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED |
michael@0 | 1920 | # define PNG_FREE_UNKN 0x0200 |
michael@0 | 1921 | #endif |
michael@0 | 1922 | /* PNG_FREE_LIST 0x0400 removed in 1.6.0 because it is ignored */ |
michael@0 | 1923 | #define PNG_FREE_PLTE 0x1000 |
michael@0 | 1924 | #define PNG_FREE_TRNS 0x2000 |
michael@0 | 1925 | #define PNG_FREE_TEXT 0x4000 |
michael@0 | 1926 | #define PNG_FREE_ALL 0x7fff |
michael@0 | 1927 | #define PNG_FREE_MUL 0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */ |
michael@0 | 1928 | |
michael@0 | 1929 | #ifdef PNG_USER_MEM_SUPPORTED |
michael@0 | 1930 | PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_const_structrp png_ptr, |
michael@0 | 1931 | png_alloc_size_t size), PNG_ALLOCATED PNG_DEPRECATED); |
michael@0 | 1932 | PNG_EXPORTA(101, void, png_free_default, (png_const_structrp png_ptr, |
michael@0 | 1933 | png_voidp ptr), PNG_DEPRECATED); |
michael@0 | 1934 | #endif |
michael@0 | 1935 | |
michael@0 | 1936 | #ifdef PNG_ERROR_TEXT_SUPPORTED |
michael@0 | 1937 | /* Fatal error in PNG image of libpng - can't continue */ |
michael@0 | 1938 | PNG_EXPORTA(102, void, png_error, (png_const_structrp png_ptr, |
michael@0 | 1939 | png_const_charp error_message), PNG_NORETURN); |
michael@0 | 1940 | |
michael@0 | 1941 | /* The same, but the chunk name is prepended to the error string. */ |
michael@0 | 1942 | PNG_EXPORTA(103, void, png_chunk_error, (png_const_structrp png_ptr, |
michael@0 | 1943 | png_const_charp error_message), PNG_NORETURN); |
michael@0 | 1944 | |
michael@0 | 1945 | #else |
michael@0 | 1946 | /* Fatal error in PNG image of libpng - can't continue */ |
michael@0 | 1947 | PNG_EXPORTA(104, void, png_err, (png_const_structrp png_ptr), PNG_NORETURN); |
michael@0 | 1948 | # define png_error(s1,s2) png_err(s1) |
michael@0 | 1949 | # define png_chunk_error(s1,s2) png_err(s1) |
michael@0 | 1950 | #endif |
michael@0 | 1951 | |
michael@0 | 1952 | #ifdef PNG_WARNINGS_SUPPORTED |
michael@0 | 1953 | /* Non-fatal error in libpng. Can continue, but may have a problem. */ |
michael@0 | 1954 | PNG_EXPORT(105, void, png_warning, (png_const_structrp png_ptr, |
michael@0 | 1955 | png_const_charp warning_message)); |
michael@0 | 1956 | |
michael@0 | 1957 | /* Non-fatal error in libpng, chunk name is prepended to message. */ |
michael@0 | 1958 | PNG_EXPORT(106, void, png_chunk_warning, (png_const_structrp png_ptr, |
michael@0 | 1959 | png_const_charp warning_message)); |
michael@0 | 1960 | #else |
michael@0 | 1961 | # define png_warning(s1,s2) ((void)(s1)) |
michael@0 | 1962 | # define png_chunk_warning(s1,s2) ((void)(s1)) |
michael@0 | 1963 | #endif |
michael@0 | 1964 | |
michael@0 | 1965 | #ifdef PNG_BENIGN_ERRORS_SUPPORTED |
michael@0 | 1966 | /* Benign error in libpng. Can continue, but may have a problem. |
michael@0 | 1967 | * User can choose whether to handle as a fatal error or as a warning. */ |
michael@0 | 1968 | PNG_EXPORT(107, void, png_benign_error, (png_const_structrp png_ptr, |
michael@0 | 1969 | png_const_charp warning_message)); |
michael@0 | 1970 | |
michael@0 | 1971 | #ifdef PNG_READ_SUPPORTED |
michael@0 | 1972 | /* Same, chunk name is prepended to message (only during read) */ |
michael@0 | 1973 | PNG_EXPORT(108, void, png_chunk_benign_error, (png_const_structrp png_ptr, |
michael@0 | 1974 | png_const_charp warning_message)); |
michael@0 | 1975 | #endif |
michael@0 | 1976 | |
michael@0 | 1977 | PNG_EXPORT(109, void, png_set_benign_errors, |
michael@0 | 1978 | (png_structrp png_ptr, int allowed)); |
michael@0 | 1979 | #else |
michael@0 | 1980 | # ifdef PNG_ALLOW_BENIGN_ERRORS |
michael@0 | 1981 | # define png_benign_error png_warning |
michael@0 | 1982 | # define png_chunk_benign_error png_chunk_warning |
michael@0 | 1983 | # else |
michael@0 | 1984 | # define png_benign_error png_error |
michael@0 | 1985 | # define png_chunk_benign_error png_chunk_error |
michael@0 | 1986 | # endif |
michael@0 | 1987 | #endif |
michael@0 | 1988 | |
michael@0 | 1989 | /* The png_set_<chunk> functions are for storing values in the png_info_struct. |
michael@0 | 1990 | * Similarly, the png_get_<chunk> calls are used to read values from the |
michael@0 | 1991 | * png_info_struct, either storing the parameters in the passed variables, or |
michael@0 | 1992 | * setting pointers into the png_info_struct where the data is stored. The |
michael@0 | 1993 | * png_get_<chunk> functions return a non-zero value if the data was available |
michael@0 | 1994 | * in info_ptr, or return zero and do not change any of the parameters if the |
michael@0 | 1995 | * data was not available. |
michael@0 | 1996 | * |
michael@0 | 1997 | * These functions should be used instead of directly accessing png_info |
michael@0 | 1998 | * to avoid problems with future changes in the size and internal layout of |
michael@0 | 1999 | * png_info_struct. |
michael@0 | 2000 | */ |
michael@0 | 2001 | /* Returns "flag" if chunk data is valid in info_ptr. */ |
michael@0 | 2002 | PNG_EXPORT(110, png_uint_32, png_get_valid, (png_const_structrp png_ptr, |
michael@0 | 2003 | png_const_inforp info_ptr, png_uint_32 flag)); |
michael@0 | 2004 | |
michael@0 | 2005 | /* Returns number of bytes needed to hold a transformed row. */ |
michael@0 | 2006 | PNG_EXPORT(111, png_size_t, png_get_rowbytes, (png_const_structrp png_ptr, |
michael@0 | 2007 | png_const_inforp info_ptr)); |
michael@0 | 2008 | |
michael@0 | 2009 | #ifdef PNG_INFO_IMAGE_SUPPORTED |
michael@0 | 2010 | /* Returns row_pointers, which is an array of pointers to scanlines that was |
michael@0 | 2011 | * returned from png_read_png(). |
michael@0 | 2012 | */ |
michael@0 | 2013 | PNG_EXPORT(112, png_bytepp, png_get_rows, (png_const_structrp png_ptr, |
michael@0 | 2014 | png_const_inforp info_ptr)); |
michael@0 | 2015 | |
michael@0 | 2016 | /* Set row_pointers, which is an array of pointers to scanlines for use |
michael@0 | 2017 | * by png_write_png(). |
michael@0 | 2018 | */ |
michael@0 | 2019 | PNG_EXPORT(113, void, png_set_rows, (png_const_structrp png_ptr, |
michael@0 | 2020 | png_inforp info_ptr, png_bytepp row_pointers)); |
michael@0 | 2021 | #endif |
michael@0 | 2022 | |
michael@0 | 2023 | /* Returns number of color channels in image. */ |
michael@0 | 2024 | PNG_EXPORT(114, png_byte, png_get_channels, (png_const_structrp png_ptr, |
michael@0 | 2025 | png_const_inforp info_ptr)); |
michael@0 | 2026 | |
michael@0 | 2027 | #ifdef PNG_EASY_ACCESS_SUPPORTED |
michael@0 | 2028 | /* Returns image width in pixels. */ |
michael@0 | 2029 | PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structrp png_ptr, |
michael@0 | 2030 | png_const_inforp info_ptr)); |
michael@0 | 2031 | |
michael@0 | 2032 | /* Returns image height in pixels. */ |
michael@0 | 2033 | PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structrp png_ptr, |
michael@0 | 2034 | png_const_inforp info_ptr)); |
michael@0 | 2035 | |
michael@0 | 2036 | /* Returns image bit_depth. */ |
michael@0 | 2037 | PNG_EXPORT(117, png_byte, png_get_bit_depth, (png_const_structrp png_ptr, |
michael@0 | 2038 | png_const_inforp info_ptr)); |
michael@0 | 2039 | |
michael@0 | 2040 | /* Returns image color_type. */ |
michael@0 | 2041 | PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structrp png_ptr, |
michael@0 | 2042 | png_const_inforp info_ptr)); |
michael@0 | 2043 | |
michael@0 | 2044 | /* Returns image filter_type. */ |
michael@0 | 2045 | PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structrp png_ptr, |
michael@0 | 2046 | png_const_inforp info_ptr)); |
michael@0 | 2047 | |
michael@0 | 2048 | /* Returns image interlace_type. */ |
michael@0 | 2049 | PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structrp png_ptr, |
michael@0 | 2050 | png_const_inforp info_ptr)); |
michael@0 | 2051 | |
michael@0 | 2052 | /* Returns image compression_type. */ |
michael@0 | 2053 | PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structrp png_ptr, |
michael@0 | 2054 | png_const_inforp info_ptr)); |
michael@0 | 2055 | |
michael@0 | 2056 | /* Returns image resolution in pixels per meter, from pHYs chunk data. */ |
michael@0 | 2057 | PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter, |
michael@0 | 2058 | (png_const_structrp png_ptr, png_const_inforp info_ptr)); |
michael@0 | 2059 | PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter, |
michael@0 | 2060 | (png_const_structrp png_ptr, png_const_inforp info_ptr)); |
michael@0 | 2061 | PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter, |
michael@0 | 2062 | (png_const_structrp png_ptr, png_const_inforp info_ptr)); |
michael@0 | 2063 | |
michael@0 | 2064 | /* Returns pixel aspect ratio, computed from pHYs chunk data. */ |
michael@0 | 2065 | PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio, |
michael@0 | 2066 | (png_const_structrp png_ptr, png_const_inforp info_ptr)) |
michael@0 | 2067 | PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed, |
michael@0 | 2068 | (png_const_structrp png_ptr, png_const_inforp info_ptr)) |
michael@0 | 2069 | |
michael@0 | 2070 | /* Returns image x, y offset in pixels or microns, from oFFs chunk data. */ |
michael@0 | 2071 | PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels, |
michael@0 | 2072 | (png_const_structrp png_ptr, png_const_inforp info_ptr)); |
michael@0 | 2073 | PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels, |
michael@0 | 2074 | (png_const_structrp png_ptr, png_const_inforp info_ptr)); |
michael@0 | 2075 | PNG_EXPORT(128, png_int_32, png_get_x_offset_microns, |
michael@0 | 2076 | (png_const_structrp png_ptr, png_const_inforp info_ptr)); |
michael@0 | 2077 | PNG_EXPORT(129, png_int_32, png_get_y_offset_microns, |
michael@0 | 2078 | (png_const_structrp png_ptr, png_const_inforp info_ptr)); |
michael@0 | 2079 | |
michael@0 | 2080 | #endif /* PNG_EASY_ACCESS_SUPPORTED */ |
michael@0 | 2081 | |
michael@0 | 2082 | #ifdef PNG_READ_SUPPORTED |
michael@0 | 2083 | /* Returns pointer to signature string read from PNG header */ |
michael@0 | 2084 | PNG_EXPORT(130, png_const_bytep, png_get_signature, (png_const_structrp png_ptr, |
michael@0 | 2085 | png_const_inforp info_ptr)); |
michael@0 | 2086 | #endif |
michael@0 | 2087 | |
michael@0 | 2088 | #ifdef PNG_bKGD_SUPPORTED |
michael@0 | 2089 | PNG_EXPORT(131, png_uint_32, png_get_bKGD, (png_const_structrp png_ptr, |
michael@0 | 2090 | png_inforp info_ptr, png_color_16p *background)); |
michael@0 | 2091 | #endif |
michael@0 | 2092 | |
michael@0 | 2093 | #ifdef PNG_bKGD_SUPPORTED |
michael@0 | 2094 | PNG_EXPORT(132, void, png_set_bKGD, (png_const_structrp png_ptr, |
michael@0 | 2095 | png_inforp info_ptr, png_const_color_16p background)); |
michael@0 | 2096 | #endif |
michael@0 | 2097 | |
michael@0 | 2098 | #ifdef PNG_cHRM_SUPPORTED |
michael@0 | 2099 | PNG_FP_EXPORT(133, png_uint_32, png_get_cHRM, (png_const_structrp png_ptr, |
michael@0 | 2100 | png_const_inforp info_ptr, double *white_x, double *white_y, double *red_x, |
michael@0 | 2101 | double *red_y, double *green_x, double *green_y, double *blue_x, |
michael@0 | 2102 | double *blue_y)) |
michael@0 | 2103 | PNG_FP_EXPORT(230, png_uint_32, png_get_cHRM_XYZ, (png_const_structrp png_ptr, |
michael@0 | 2104 | png_const_inforp info_ptr, double *red_X, double *red_Y, double *red_Z, |
michael@0 | 2105 | double *green_X, double *green_Y, double *green_Z, double *blue_X, |
michael@0 | 2106 | double *blue_Y, double *blue_Z)) |
michael@0 | 2107 | PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed, |
michael@0 | 2108 | (png_const_structrp png_ptr, png_const_inforp info_ptr, |
michael@0 | 2109 | png_fixed_point *int_white_x, png_fixed_point *int_white_y, |
michael@0 | 2110 | png_fixed_point *int_red_x, png_fixed_point *int_red_y, |
michael@0 | 2111 | png_fixed_point *int_green_x, png_fixed_point *int_green_y, |
michael@0 | 2112 | png_fixed_point *int_blue_x, png_fixed_point *int_blue_y)) |
michael@0 | 2113 | PNG_FIXED_EXPORT(231, png_uint_32, png_get_cHRM_XYZ_fixed, |
michael@0 | 2114 | (png_const_structrp png_ptr, png_const_inforp info_ptr, |
michael@0 | 2115 | png_fixed_point *int_red_X, png_fixed_point *int_red_Y, |
michael@0 | 2116 | png_fixed_point *int_red_Z, png_fixed_point *int_green_X, |
michael@0 | 2117 | png_fixed_point *int_green_Y, png_fixed_point *int_green_Z, |
michael@0 | 2118 | png_fixed_point *int_blue_X, png_fixed_point *int_blue_Y, |
michael@0 | 2119 | png_fixed_point *int_blue_Z)) |
michael@0 | 2120 | #endif |
michael@0 | 2121 | |
michael@0 | 2122 | #ifdef PNG_cHRM_SUPPORTED |
michael@0 | 2123 | PNG_FP_EXPORT(135, void, png_set_cHRM, (png_const_structrp png_ptr, |
michael@0 | 2124 | png_inforp info_ptr, |
michael@0 | 2125 | double white_x, double white_y, double red_x, double red_y, double green_x, |
michael@0 | 2126 | double green_y, double blue_x, double blue_y)) |
michael@0 | 2127 | PNG_FP_EXPORT(232, void, png_set_cHRM_XYZ, (png_const_structrp png_ptr, |
michael@0 | 2128 | png_inforp info_ptr, double red_X, double red_Y, double red_Z, |
michael@0 | 2129 | double green_X, double green_Y, double green_Z, double blue_X, |
michael@0 | 2130 | double blue_Y, double blue_Z)) |
michael@0 | 2131 | PNG_FIXED_EXPORT(136, void, png_set_cHRM_fixed, (png_const_structrp png_ptr, |
michael@0 | 2132 | png_inforp info_ptr, png_fixed_point int_white_x, |
michael@0 | 2133 | png_fixed_point int_white_y, png_fixed_point int_red_x, |
michael@0 | 2134 | png_fixed_point int_red_y, png_fixed_point int_green_x, |
michael@0 | 2135 | png_fixed_point int_green_y, png_fixed_point int_blue_x, |
michael@0 | 2136 | png_fixed_point int_blue_y)) |
michael@0 | 2137 | PNG_FIXED_EXPORT(233, void, png_set_cHRM_XYZ_fixed, (png_const_structrp png_ptr, |
michael@0 | 2138 | png_inforp info_ptr, png_fixed_point int_red_X, png_fixed_point int_red_Y, |
michael@0 | 2139 | png_fixed_point int_red_Z, png_fixed_point int_green_X, |
michael@0 | 2140 | png_fixed_point int_green_Y, png_fixed_point int_green_Z, |
michael@0 | 2141 | png_fixed_point int_blue_X, png_fixed_point int_blue_Y, |
michael@0 | 2142 | png_fixed_point int_blue_Z)) |
michael@0 | 2143 | #endif |
michael@0 | 2144 | |
michael@0 | 2145 | #ifdef PNG_gAMA_SUPPORTED |
michael@0 | 2146 | PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA, (png_const_structrp png_ptr, |
michael@0 | 2147 | png_const_inforp info_ptr, double *file_gamma)) |
michael@0 | 2148 | PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed, |
michael@0 | 2149 | (png_const_structrp png_ptr, png_const_inforp info_ptr, |
michael@0 | 2150 | png_fixed_point *int_file_gamma)) |
michael@0 | 2151 | #endif |
michael@0 | 2152 | |
michael@0 | 2153 | #ifdef PNG_gAMA_SUPPORTED |
michael@0 | 2154 | PNG_FP_EXPORT(139, void, png_set_gAMA, (png_const_structrp png_ptr, |
michael@0 | 2155 | png_inforp info_ptr, double file_gamma)) |
michael@0 | 2156 | PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_const_structrp png_ptr, |
michael@0 | 2157 | png_inforp info_ptr, png_fixed_point int_file_gamma)) |
michael@0 | 2158 | #endif |
michael@0 | 2159 | |
michael@0 | 2160 | #ifdef PNG_hIST_SUPPORTED |
michael@0 | 2161 | PNG_EXPORT(141, png_uint_32, png_get_hIST, (png_const_structrp png_ptr, |
michael@0 | 2162 | png_inforp info_ptr, png_uint_16p *hist)); |
michael@0 | 2163 | #endif |
michael@0 | 2164 | |
michael@0 | 2165 | #ifdef PNG_hIST_SUPPORTED |
michael@0 | 2166 | PNG_EXPORT(142, void, png_set_hIST, (png_const_structrp png_ptr, |
michael@0 | 2167 | png_inforp info_ptr, png_const_uint_16p hist)); |
michael@0 | 2168 | #endif |
michael@0 | 2169 | |
michael@0 | 2170 | PNG_EXPORT(143, png_uint_32, png_get_IHDR, (png_const_structrp png_ptr, |
michael@0 | 2171 | png_const_inforp info_ptr, png_uint_32 *width, png_uint_32 *height, |
michael@0 | 2172 | int *bit_depth, int *color_type, int *interlace_method, |
michael@0 | 2173 | int *compression_method, int *filter_method)); |
michael@0 | 2174 | |
michael@0 | 2175 | PNG_EXPORT(144, void, png_set_IHDR, (png_const_structrp png_ptr, |
michael@0 | 2176 | png_inforp info_ptr, png_uint_32 width, png_uint_32 height, int bit_depth, |
michael@0 | 2177 | int color_type, int interlace_method, int compression_method, |
michael@0 | 2178 | int filter_method)); |
michael@0 | 2179 | |
michael@0 | 2180 | #ifdef PNG_oFFs_SUPPORTED |
michael@0 | 2181 | PNG_EXPORT(145, png_uint_32, png_get_oFFs, (png_const_structrp png_ptr, |
michael@0 | 2182 | png_const_inforp info_ptr, png_int_32 *offset_x, png_int_32 *offset_y, |
michael@0 | 2183 | int *unit_type)); |
michael@0 | 2184 | #endif |
michael@0 | 2185 | |
michael@0 | 2186 | #ifdef PNG_oFFs_SUPPORTED |
michael@0 | 2187 | PNG_EXPORT(146, void, png_set_oFFs, (png_const_structrp png_ptr, |
michael@0 | 2188 | png_inforp info_ptr, png_int_32 offset_x, png_int_32 offset_y, |
michael@0 | 2189 | int unit_type)); |
michael@0 | 2190 | #endif |
michael@0 | 2191 | |
michael@0 | 2192 | #ifdef PNG_pCAL_SUPPORTED |
michael@0 | 2193 | PNG_EXPORT(147, png_uint_32, png_get_pCAL, (png_const_structrp png_ptr, |
michael@0 | 2194 | png_inforp info_ptr, png_charp *purpose, png_int_32 *X0, |
michael@0 | 2195 | png_int_32 *X1, int *type, int *nparams, png_charp *units, |
michael@0 | 2196 | png_charpp *params)); |
michael@0 | 2197 | #endif |
michael@0 | 2198 | |
michael@0 | 2199 | #ifdef PNG_pCAL_SUPPORTED |
michael@0 | 2200 | PNG_EXPORT(148, void, png_set_pCAL, (png_const_structrp png_ptr, |
michael@0 | 2201 | png_inforp info_ptr, png_const_charp purpose, png_int_32 X0, png_int_32 X1, |
michael@0 | 2202 | int type, int nparams, png_const_charp units, png_charpp params)); |
michael@0 | 2203 | #endif |
michael@0 | 2204 | |
michael@0 | 2205 | #ifdef PNG_pHYs_SUPPORTED |
michael@0 | 2206 | PNG_EXPORT(149, png_uint_32, png_get_pHYs, (png_const_structrp png_ptr, |
michael@0 | 2207 | png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y, |
michael@0 | 2208 | int *unit_type)); |
michael@0 | 2209 | #endif |
michael@0 | 2210 | |
michael@0 | 2211 | #ifdef PNG_pHYs_SUPPORTED |
michael@0 | 2212 | PNG_EXPORT(150, void, png_set_pHYs, (png_const_structrp png_ptr, |
michael@0 | 2213 | png_inforp info_ptr, png_uint_32 res_x, png_uint_32 res_y, int unit_type)); |
michael@0 | 2214 | #endif |
michael@0 | 2215 | |
michael@0 | 2216 | PNG_EXPORT(151, png_uint_32, png_get_PLTE, (png_const_structrp png_ptr, |
michael@0 | 2217 | png_inforp info_ptr, png_colorp *palette, int *num_palette)); |
michael@0 | 2218 | |
michael@0 | 2219 | PNG_EXPORT(152, void, png_set_PLTE, (png_structrp png_ptr, |
michael@0 | 2220 | png_inforp info_ptr, png_const_colorp palette, int num_palette)); |
michael@0 | 2221 | |
michael@0 | 2222 | #ifdef PNG_sBIT_SUPPORTED |
michael@0 | 2223 | PNG_EXPORT(153, png_uint_32, png_get_sBIT, (png_const_structrp png_ptr, |
michael@0 | 2224 | png_inforp info_ptr, png_color_8p *sig_bit)); |
michael@0 | 2225 | #endif |
michael@0 | 2226 | |
michael@0 | 2227 | #ifdef PNG_sBIT_SUPPORTED |
michael@0 | 2228 | PNG_EXPORT(154, void, png_set_sBIT, (png_const_structrp png_ptr, |
michael@0 | 2229 | png_inforp info_ptr, png_const_color_8p sig_bit)); |
michael@0 | 2230 | #endif |
michael@0 | 2231 | |
michael@0 | 2232 | #ifdef PNG_sRGB_SUPPORTED |
michael@0 | 2233 | PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structrp png_ptr, |
michael@0 | 2234 | png_const_inforp info_ptr, int *file_srgb_intent)); |
michael@0 | 2235 | #endif |
michael@0 | 2236 | |
michael@0 | 2237 | #ifdef PNG_sRGB_SUPPORTED |
michael@0 | 2238 | PNG_EXPORT(156, void, png_set_sRGB, (png_const_structrp png_ptr, |
michael@0 | 2239 | png_inforp info_ptr, int srgb_intent)); |
michael@0 | 2240 | PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_const_structrp png_ptr, |
michael@0 | 2241 | png_inforp info_ptr, int srgb_intent)); |
michael@0 | 2242 | #endif |
michael@0 | 2243 | |
michael@0 | 2244 | #ifdef PNG_iCCP_SUPPORTED |
michael@0 | 2245 | PNG_EXPORT(158, png_uint_32, png_get_iCCP, (png_const_structrp png_ptr, |
michael@0 | 2246 | png_inforp info_ptr, png_charpp name, int *compression_type, |
michael@0 | 2247 | png_bytepp profile, png_uint_32 *proflen)); |
michael@0 | 2248 | #endif |
michael@0 | 2249 | |
michael@0 | 2250 | #ifdef PNG_iCCP_SUPPORTED |
michael@0 | 2251 | PNG_EXPORT(159, void, png_set_iCCP, (png_const_structrp png_ptr, |
michael@0 | 2252 | png_inforp info_ptr, png_const_charp name, int compression_type, |
michael@0 | 2253 | png_const_bytep profile, png_uint_32 proflen)); |
michael@0 | 2254 | #endif |
michael@0 | 2255 | |
michael@0 | 2256 | #ifdef PNG_sPLT_SUPPORTED |
michael@0 | 2257 | PNG_EXPORT(160, int, png_get_sPLT, (png_const_structrp png_ptr, |
michael@0 | 2258 | png_inforp info_ptr, png_sPLT_tpp entries)); |
michael@0 | 2259 | #endif |
michael@0 | 2260 | |
michael@0 | 2261 | #ifdef PNG_sPLT_SUPPORTED |
michael@0 | 2262 | PNG_EXPORT(161, void, png_set_sPLT, (png_const_structrp png_ptr, |
michael@0 | 2263 | png_inforp info_ptr, png_const_sPLT_tp entries, int nentries)); |
michael@0 | 2264 | #endif |
michael@0 | 2265 | |
michael@0 | 2266 | #ifdef PNG_TEXT_SUPPORTED |
michael@0 | 2267 | /* png_get_text also returns the number of text chunks in *num_text */ |
michael@0 | 2268 | PNG_EXPORT(162, int, png_get_text, (png_const_structrp png_ptr, |
michael@0 | 2269 | png_inforp info_ptr, png_textp *text_ptr, int *num_text)); |
michael@0 | 2270 | #endif |
michael@0 | 2271 | |
michael@0 | 2272 | /* Note while png_set_text() will accept a structure whose text, |
michael@0 | 2273 | * language, and translated keywords are NULL pointers, the structure |
michael@0 | 2274 | * returned by png_get_text will always contain regular |
michael@0 | 2275 | * zero-terminated C strings. They might be empty strings but |
michael@0 | 2276 | * they will never be NULL pointers. |
michael@0 | 2277 | */ |
michael@0 | 2278 | |
michael@0 | 2279 | #ifdef PNG_TEXT_SUPPORTED |
michael@0 | 2280 | PNG_EXPORT(163, void, png_set_text, (png_const_structrp png_ptr, |
michael@0 | 2281 | png_inforp info_ptr, png_const_textp text_ptr, int num_text)); |
michael@0 | 2282 | #endif |
michael@0 | 2283 | |
michael@0 | 2284 | #ifdef PNG_tIME_SUPPORTED |
michael@0 | 2285 | PNG_EXPORT(164, png_uint_32, png_get_tIME, (png_const_structrp png_ptr, |
michael@0 | 2286 | png_inforp info_ptr, png_timep *mod_time)); |
michael@0 | 2287 | #endif |
michael@0 | 2288 | |
michael@0 | 2289 | #ifdef PNG_tIME_SUPPORTED |
michael@0 | 2290 | PNG_EXPORT(165, void, png_set_tIME, (png_const_structrp png_ptr, |
michael@0 | 2291 | png_inforp info_ptr, png_const_timep mod_time)); |
michael@0 | 2292 | #endif |
michael@0 | 2293 | |
michael@0 | 2294 | #ifdef PNG_tRNS_SUPPORTED |
michael@0 | 2295 | PNG_EXPORT(166, png_uint_32, png_get_tRNS, (png_const_structrp png_ptr, |
michael@0 | 2296 | png_inforp info_ptr, png_bytep *trans_alpha, int *num_trans, |
michael@0 | 2297 | png_color_16p *trans_color)); |
michael@0 | 2298 | #endif |
michael@0 | 2299 | |
michael@0 | 2300 | #ifdef PNG_tRNS_SUPPORTED |
michael@0 | 2301 | PNG_EXPORT(167, void, png_set_tRNS, (png_structrp png_ptr, |
michael@0 | 2302 | png_inforp info_ptr, png_const_bytep trans_alpha, int num_trans, |
michael@0 | 2303 | png_const_color_16p trans_color)); |
michael@0 | 2304 | #endif |
michael@0 | 2305 | |
michael@0 | 2306 | #ifdef PNG_sCAL_SUPPORTED |
michael@0 | 2307 | PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL, (png_const_structrp png_ptr, |
michael@0 | 2308 | png_const_inforp info_ptr, int *unit, double *width, double *height)) |
michael@0 | 2309 | #if defined(PNG_FLOATING_ARITHMETIC_SUPPORTED) || \ |
michael@0 | 2310 | defined(PNG_FLOATING_POINT_SUPPORTED) |
michael@0 | 2311 | /* NOTE: this API is currently implemented using floating point arithmetic, |
michael@0 | 2312 | * consequently it can only be used on systems with floating point support. |
michael@0 | 2313 | * In any case the range of values supported by png_fixed_point is small and it |
michael@0 | 2314 | * is highly recommended that png_get_sCAL_s be used instead. |
michael@0 | 2315 | */ |
michael@0 | 2316 | PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed, |
michael@0 | 2317 | (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit, |
michael@0 | 2318 | png_fixed_point *width, png_fixed_point *height)) |
michael@0 | 2319 | #endif |
michael@0 | 2320 | PNG_EXPORT(169, png_uint_32, png_get_sCAL_s, |
michael@0 | 2321 | (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit, |
michael@0 | 2322 | png_charpp swidth, png_charpp sheight)); |
michael@0 | 2323 | |
michael@0 | 2324 | PNG_FP_EXPORT(170, void, png_set_sCAL, (png_const_structrp png_ptr, |
michael@0 | 2325 | png_inforp info_ptr, int unit, double width, double height)) |
michael@0 | 2326 | PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_const_structrp png_ptr, |
michael@0 | 2327 | png_inforp info_ptr, int unit, png_fixed_point width, |
michael@0 | 2328 | png_fixed_point height)) |
michael@0 | 2329 | PNG_EXPORT(171, void, png_set_sCAL_s, (png_const_structrp png_ptr, |
michael@0 | 2330 | png_inforp info_ptr, int unit, |
michael@0 | 2331 | png_const_charp swidth, png_const_charp sheight)); |
michael@0 | 2332 | #endif /* PNG_sCAL_SUPPORTED */ |
michael@0 | 2333 | |
michael@0 | 2334 | #ifdef PNG_SET_UNKNOWN_CHUNKS_SUPPORTED |
michael@0 | 2335 | /* Provide the default handling for all unknown chunks or, optionally, for |
michael@0 | 2336 | * specific unknown chunks. |
michael@0 | 2337 | * |
michael@0 | 2338 | * NOTE: prior to 1.6.0 the handling specified for particular chunks on read was |
michael@0 | 2339 | * ignored and the default was used, the per-chunk setting only had an effect on |
michael@0 | 2340 | * write. If you wish to have chunk-specific handling on read in code that must |
michael@0 | 2341 | * work on earlier versions you must use a user chunk callback to specify the |
michael@0 | 2342 | * desired handling (keep or discard.) |
michael@0 | 2343 | * |
michael@0 | 2344 | * The 'keep' parameter is a PNG_HANDLE_CHUNK_ value as listed below. The |
michael@0 | 2345 | * parameter is interpreted as follows: |
michael@0 | 2346 | * |
michael@0 | 2347 | * READ: |
michael@0 | 2348 | * PNG_HANDLE_CHUNK_AS_DEFAULT: |
michael@0 | 2349 | * Known chunks: do normal libpng processing, do not keep the chunk (but |
michael@0 | 2350 | * see the comments below about PNG_HANDLE_AS_UNKNOWN_SUPPORTED) |
michael@0 | 2351 | * Unknown chunks: for a specific chunk use the global default, when used |
michael@0 | 2352 | * as the default discard the chunk data. |
michael@0 | 2353 | * PNG_HANDLE_CHUNK_NEVER: |
michael@0 | 2354 | * Discard the chunk data. |
michael@0 | 2355 | * PNG_HANDLE_CHUNK_IF_SAFE: |
michael@0 | 2356 | * Keep the chunk data if the chunk is not critical else raise a chunk |
michael@0 | 2357 | * error. |
michael@0 | 2358 | * PNG_HANDLE_CHUNK_ALWAYS: |
michael@0 | 2359 | * Keep the chunk data. |
michael@0 | 2360 | * |
michael@0 | 2361 | * If the chunk data is saved it can be retrieved using png_get_unknown_chunks, |
michael@0 | 2362 | * below. Notice that specifying "AS_DEFAULT" as a global default is equivalent |
michael@0 | 2363 | * to specifying "NEVER", however when "AS_DEFAULT" is used for specific chunks |
michael@0 | 2364 | * it simply resets the behavior to the libpng default. |
michael@0 | 2365 | * |
michael@0 | 2366 | * INTERACTION WTIH USER CHUNK CALLBACKS: |
michael@0 | 2367 | * The per-chunk handling is always used when there is a png_user_chunk_ptr |
michael@0 | 2368 | * callback and the callback returns 0; the chunk is then always stored *unless* |
michael@0 | 2369 | * it is critical and the per-chunk setting is other than ALWAYS. Notice that |
michael@0 | 2370 | * the global default is *not* used in this case. (In effect the per-chunk |
michael@0 | 2371 | * value is incremented to at least IF_SAFE.) |
michael@0 | 2372 | * |
michael@0 | 2373 | * IMPORTANT NOTE: this behavior will change in libpng 1.7 - the global and |
michael@0 | 2374 | * per-chunk defaults will be honored. If you want to preserve the current |
michael@0 | 2375 | * behavior when your callback returns 0 you must set PNG_HANDLE_CHUNK_IF_SAFE |
michael@0 | 2376 | * as the default - if you don't do this libpng 1.6 will issue a warning. |
michael@0 | 2377 | * |
michael@0 | 2378 | * If you want unhandled unknown chunks to be discarded in libpng 1.6 and |
michael@0 | 2379 | * earlier simply return '1' (handled). |
michael@0 | 2380 | * |
michael@0 | 2381 | * PNG_HANDLE_AS_UNKNOWN_SUPPORTED: |
michael@0 | 2382 | * If this is *not* set known chunks will always be handled by libpng and |
michael@0 | 2383 | * will never be stored in the unknown chunk list. Known chunks listed to |
michael@0 | 2384 | * png_set_keep_unknown_chunks will have no effect. If it is set then known |
michael@0 | 2385 | * chunks listed with a keep other than AS_DEFAULT will *never* be processed |
michael@0 | 2386 | * by libpng, in addition critical chunks must either be processed by the |
michael@0 | 2387 | * callback or saved. |
michael@0 | 2388 | * |
michael@0 | 2389 | * The IHDR and IEND chunks must not be listed. Because this turns off the |
michael@0 | 2390 | * default handling for chunks that would otherwise be recognized the |
michael@0 | 2391 | * behavior of libpng transformations may well become incorrect! |
michael@0 | 2392 | * |
michael@0 | 2393 | * WRITE: |
michael@0 | 2394 | * When writing chunks the options only apply to the chunks specified by |
michael@0 | 2395 | * png_set_unknown_chunks (below), libpng will *always* write known chunks |
michael@0 | 2396 | * required by png_set_ calls and will always write the core critical chunks |
michael@0 | 2397 | * (as required for PLTE). |
michael@0 | 2398 | * |
michael@0 | 2399 | * Each chunk in the png_set_unknown_chunks list is looked up in the |
michael@0 | 2400 | * png_set_keep_unknown_chunks list to find the keep setting, this is then |
michael@0 | 2401 | * interpreted as follows: |
michael@0 | 2402 | * |
michael@0 | 2403 | * PNG_HANDLE_CHUNK_AS_DEFAULT: |
michael@0 | 2404 | * Write safe-to-copy chunks and write other chunks if the global |
michael@0 | 2405 | * default is set to _ALWAYS, otherwise don't write this chunk. |
michael@0 | 2406 | * PNG_HANDLE_CHUNK_NEVER: |
michael@0 | 2407 | * Do not write the chunk. |
michael@0 | 2408 | * PNG_HANDLE_CHUNK_IF_SAFE: |
michael@0 | 2409 | * Write the chunk if it is safe-to-copy, otherwise do not write it. |
michael@0 | 2410 | * PNG_HANDLE_CHUNK_ALWAYS: |
michael@0 | 2411 | * Write the chunk. |
michael@0 | 2412 | * |
michael@0 | 2413 | * Note that the default behavior is effectively the opposite of the read case - |
michael@0 | 2414 | * in read unknown chunks are not stored by default, in write they are written |
michael@0 | 2415 | * by default. Also the behavior of PNG_HANDLE_CHUNK_IF_SAFE is very different |
michael@0 | 2416 | * - on write the safe-to-copy bit is checked, on read the critical bit is |
michael@0 | 2417 | * checked and on read if the chunk is critical an error will be raised. |
michael@0 | 2418 | * |
michael@0 | 2419 | * num_chunks: |
michael@0 | 2420 | * =========== |
michael@0 | 2421 | * If num_chunks is positive, then the "keep" parameter specifies the manner |
michael@0 | 2422 | * for handling only those chunks appearing in the chunk_list array, |
michael@0 | 2423 | * otherwise the chunk list array is ignored. |
michael@0 | 2424 | * |
michael@0 | 2425 | * If num_chunks is 0 the "keep" parameter specifies the default behavior for |
michael@0 | 2426 | * unknown chunks, as described above. |
michael@0 | 2427 | * |
michael@0 | 2428 | * If num_chunks is negative, then the "keep" parameter specifies the manner |
michael@0 | 2429 | * for handling all unknown chunks plus all chunks recognized by libpng |
michael@0 | 2430 | * except for the IHDR, PLTE, tRNS, IDAT, and IEND chunks (which continue to |
michael@0 | 2431 | * be processed by libpng. |
michael@0 | 2432 | */ |
michael@0 | 2433 | PNG_EXPORT(172, void, png_set_keep_unknown_chunks, (png_structrp png_ptr, |
michael@0 | 2434 | int keep, png_const_bytep chunk_list, int num_chunks)); |
michael@0 | 2435 | |
michael@0 | 2436 | /* The "keep" PNG_HANDLE_CHUNK_ parameter for the specified chunk is returned; |
michael@0 | 2437 | * the result is therefore true (non-zero) if special handling is required, |
michael@0 | 2438 | * false for the default handling. |
michael@0 | 2439 | */ |
michael@0 | 2440 | PNG_EXPORT(173, int, png_handle_as_unknown, (png_const_structrp png_ptr, |
michael@0 | 2441 | png_const_bytep chunk_name)); |
michael@0 | 2442 | #endif |
michael@0 | 2443 | |
michael@0 | 2444 | #ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED |
michael@0 | 2445 | PNG_EXPORT(174, void, png_set_unknown_chunks, (png_const_structrp png_ptr, |
michael@0 | 2446 | png_inforp info_ptr, png_const_unknown_chunkp unknowns, |
michael@0 | 2447 | int num_unknowns)); |
michael@0 | 2448 | /* NOTE: prior to 1.6.0 this routine set the 'location' field of the added |
michael@0 | 2449 | * unknowns to the location currently stored in the png_struct. This is |
michael@0 | 2450 | * invariably the wrong value on write. To fix this call the following API |
michael@0 | 2451 | * for each chunk in the list with the correct location. If you know your |
michael@0 | 2452 | * code won't be compiled on earlier versions you can rely on |
michael@0 | 2453 | * png_set_unknown_chunks(write-ptr, png_get_unknown_chunks(read-ptr)) doing |
michael@0 | 2454 | * the correct thing. |
michael@0 | 2455 | */ |
michael@0 | 2456 | |
michael@0 | 2457 | PNG_EXPORT(175, void, png_set_unknown_chunk_location, |
michael@0 | 2458 | (png_const_structrp png_ptr, png_inforp info_ptr, int chunk, int location)); |
michael@0 | 2459 | |
michael@0 | 2460 | PNG_EXPORT(176, int, png_get_unknown_chunks, (png_const_structrp png_ptr, |
michael@0 | 2461 | png_inforp info_ptr, png_unknown_chunkpp entries)); |
michael@0 | 2462 | #endif |
michael@0 | 2463 | |
michael@0 | 2464 | /* Png_free_data() will turn off the "valid" flag for anything it frees. |
michael@0 | 2465 | * If you need to turn it off for a chunk that your application has freed, |
michael@0 | 2466 | * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK); |
michael@0 | 2467 | */ |
michael@0 | 2468 | PNG_EXPORT(177, void, png_set_invalid, (png_const_structrp png_ptr, |
michael@0 | 2469 | png_inforp info_ptr, int mask)); |
michael@0 | 2470 | |
michael@0 | 2471 | #ifdef PNG_INFO_IMAGE_SUPPORTED |
michael@0 | 2472 | /* The "params" pointer is currently not used and is for future expansion. */ |
michael@0 | 2473 | #ifdef PNG_SEQUENTIAL_READ_SUPPORTED |
michael@0 | 2474 | PNG_EXPORT(178, void, png_read_png, (png_structrp png_ptr, png_inforp info_ptr, |
michael@0 | 2475 | int transforms, png_voidp params)); |
michael@0 | 2476 | #endif |
michael@0 | 2477 | #ifdef PNG_WRITE_SUPPORTED |
michael@0 | 2478 | PNG_EXPORT(179, void, png_write_png, (png_structrp png_ptr, png_inforp info_ptr, |
michael@0 | 2479 | int transforms, png_voidp params)); |
michael@0 | 2480 | #endif |
michael@0 | 2481 | #endif |
michael@0 | 2482 | |
michael@0 | 2483 | PNG_EXPORT(180, png_const_charp, png_get_copyright, |
michael@0 | 2484 | (png_const_structrp png_ptr)); |
michael@0 | 2485 | PNG_EXPORT(181, png_const_charp, png_get_header_ver, |
michael@0 | 2486 | (png_const_structrp png_ptr)); |
michael@0 | 2487 | PNG_EXPORT(182, png_const_charp, png_get_header_version, |
michael@0 | 2488 | (png_const_structrp png_ptr)); |
michael@0 | 2489 | PNG_EXPORT(183, png_const_charp, png_get_libpng_ver, |
michael@0 | 2490 | (png_const_structrp png_ptr)); |
michael@0 | 2491 | |
michael@0 | 2492 | #ifdef PNG_MNG_FEATURES_SUPPORTED |
michael@0 | 2493 | PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structrp png_ptr, |
michael@0 | 2494 | png_uint_32 mng_features_permitted)); |
michael@0 | 2495 | #endif |
michael@0 | 2496 | |
michael@0 | 2497 | /* For use in png_set_keep_unknown, added to version 1.2.6 */ |
michael@0 | 2498 | #define PNG_HANDLE_CHUNK_AS_DEFAULT 0 |
michael@0 | 2499 | #define PNG_HANDLE_CHUNK_NEVER 1 |
michael@0 | 2500 | #define PNG_HANDLE_CHUNK_IF_SAFE 2 |
michael@0 | 2501 | #define PNG_HANDLE_CHUNK_ALWAYS 3 |
michael@0 | 2502 | #define PNG_HANDLE_CHUNK_LAST 4 |
michael@0 | 2503 | |
michael@0 | 2504 | /* Strip the prepended error numbers ("#nnn ") from error and warning |
michael@0 | 2505 | * messages before passing them to the error or warning handler. |
michael@0 | 2506 | */ |
michael@0 | 2507 | #ifdef PNG_ERROR_NUMBERS_SUPPORTED |
michael@0 | 2508 | PNG_EXPORT(185, void, png_set_strip_error_numbers, (png_structrp png_ptr, |
michael@0 | 2509 | png_uint_32 strip_mode)); |
michael@0 | 2510 | #endif |
michael@0 | 2511 | |
michael@0 | 2512 | /* Added in libpng-1.2.6 */ |
michael@0 | 2513 | #ifdef PNG_SET_USER_LIMITS_SUPPORTED |
michael@0 | 2514 | PNG_EXPORT(186, void, png_set_user_limits, (png_structrp png_ptr, |
michael@0 | 2515 | png_uint_32 user_width_max, png_uint_32 user_height_max)); |
michael@0 | 2516 | PNG_EXPORT(187, png_uint_32, png_get_user_width_max, |
michael@0 | 2517 | (png_const_structrp png_ptr)); |
michael@0 | 2518 | PNG_EXPORT(188, png_uint_32, png_get_user_height_max, |
michael@0 | 2519 | (png_const_structrp png_ptr)); |
michael@0 | 2520 | /* Added in libpng-1.4.0 */ |
michael@0 | 2521 | PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structrp png_ptr, |
michael@0 | 2522 | png_uint_32 user_chunk_cache_max)); |
michael@0 | 2523 | PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max, |
michael@0 | 2524 | (png_const_structrp png_ptr)); |
michael@0 | 2525 | /* Added in libpng-1.4.1 */ |
michael@0 | 2526 | PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structrp png_ptr, |
michael@0 | 2527 | png_alloc_size_t user_chunk_cache_max)); |
michael@0 | 2528 | PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max, |
michael@0 | 2529 | (png_const_structrp png_ptr)); |
michael@0 | 2530 | #endif |
michael@0 | 2531 | |
michael@0 | 2532 | #if defined(PNG_INCH_CONVERSIONS_SUPPORTED) |
michael@0 | 2533 | PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch, |
michael@0 | 2534 | (png_const_structrp png_ptr, png_const_inforp info_ptr)); |
michael@0 | 2535 | |
michael@0 | 2536 | PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch, |
michael@0 | 2537 | (png_const_structrp png_ptr, png_const_inforp info_ptr)); |
michael@0 | 2538 | |
michael@0 | 2539 | PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch, |
michael@0 | 2540 | (png_const_structrp png_ptr, png_const_inforp info_ptr)); |
michael@0 | 2541 | |
michael@0 | 2542 | PNG_FP_EXPORT(196, float, png_get_x_offset_inches, |
michael@0 | 2543 | (png_const_structrp png_ptr, png_const_inforp info_ptr)) |
michael@0 | 2544 | #ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */ |
michael@0 | 2545 | PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed, |
michael@0 | 2546 | (png_const_structrp png_ptr, png_const_inforp info_ptr)) |
michael@0 | 2547 | #endif |
michael@0 | 2548 | |
michael@0 | 2549 | PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_const_structrp png_ptr, |
michael@0 | 2550 | png_const_inforp info_ptr)) |
michael@0 | 2551 | #ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */ |
michael@0 | 2552 | PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed, |
michael@0 | 2553 | (png_const_structrp png_ptr, png_const_inforp info_ptr)) |
michael@0 | 2554 | #endif |
michael@0 | 2555 | |
michael@0 | 2556 | # ifdef PNG_pHYs_SUPPORTED |
michael@0 | 2557 | PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structrp png_ptr, |
michael@0 | 2558 | png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y, |
michael@0 | 2559 | int *unit_type)); |
michael@0 | 2560 | # endif /* PNG_pHYs_SUPPORTED */ |
michael@0 | 2561 | #endif /* PNG_INCH_CONVERSIONS_SUPPORTED */ |
michael@0 | 2562 | |
michael@0 | 2563 | /* Added in libpng-1.4.0 */ |
michael@0 | 2564 | #ifdef PNG_IO_STATE_SUPPORTED |
michael@0 | 2565 | PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_const_structrp png_ptr)); |
michael@0 | 2566 | |
michael@0 | 2567 | /* Removed from libpng 1.6; use png_get_io_chunk_type. */ |
michael@0 | 2568 | PNG_REMOVED(200, png_const_bytep, png_get_io_chunk_name, (png_structrp png_ptr), |
michael@0 | 2569 | PNG_DEPRECATED) |
michael@0 | 2570 | |
michael@0 | 2571 | PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type, |
michael@0 | 2572 | (png_const_structrp png_ptr)); |
michael@0 | 2573 | |
michael@0 | 2574 | /* The flags returned by png_get_io_state() are the following: */ |
michael@0 | 2575 | # define PNG_IO_NONE 0x0000 /* no I/O at this moment */ |
michael@0 | 2576 | # define PNG_IO_READING 0x0001 /* currently reading */ |
michael@0 | 2577 | # define PNG_IO_WRITING 0x0002 /* currently writing */ |
michael@0 | 2578 | # define PNG_IO_SIGNATURE 0x0010 /* currently at the file signature */ |
michael@0 | 2579 | # define PNG_IO_CHUNK_HDR 0x0020 /* currently at the chunk header */ |
michael@0 | 2580 | # define PNG_IO_CHUNK_DATA 0x0040 /* currently at the chunk data */ |
michael@0 | 2581 | # define PNG_IO_CHUNK_CRC 0x0080 /* currently at the chunk crc */ |
michael@0 | 2582 | # define PNG_IO_MASK_OP 0x000f /* current operation: reading/writing */ |
michael@0 | 2583 | # define PNG_IO_MASK_LOC 0x00f0 /* current location: sig/hdr/data/crc */ |
michael@0 | 2584 | #endif /* ?PNG_IO_STATE_SUPPORTED */ |
michael@0 | 2585 | |
michael@0 | 2586 | /* Interlace support. The following macros are always defined so that if |
michael@0 | 2587 | * libpng interlace handling is turned off the macros may be used to handle |
michael@0 | 2588 | * interlaced images within the application. |
michael@0 | 2589 | */ |
michael@0 | 2590 | #define PNG_INTERLACE_ADAM7_PASSES 7 |
michael@0 | 2591 | |
michael@0 | 2592 | /* Two macros to return the first row and first column of the original, |
michael@0 | 2593 | * full, image which appears in a given pass. 'pass' is in the range 0 |
michael@0 | 2594 | * to 6 and the result is in the range 0 to 7. |
michael@0 | 2595 | */ |
michael@0 | 2596 | #define PNG_PASS_START_ROW(pass) (((1&~(pass))<<(3-((pass)>>1)))&7) |
michael@0 | 2597 | #define PNG_PASS_START_COL(pass) (((1& (pass))<<(3-(((pass)+1)>>1)))&7) |
michael@0 | 2598 | |
michael@0 | 2599 | /* A macro to return the offset between pixels in the output row for a pair of |
michael@0 | 2600 | * pixels in the input - effectively the inverse of the 'COL_SHIFT' macro that |
michael@0 | 2601 | * follows. Note that ROW_OFFSET is the offset from one row to the next whereas |
michael@0 | 2602 | * COL_OFFSET is from one column to the next, within a row. |
michael@0 | 2603 | */ |
michael@0 | 2604 | #define PNG_PASS_ROW_OFFSET(pass) ((pass)>2?(8>>(((pass)-1)>>1)):8) |
michael@0 | 2605 | #define PNG_PASS_COL_OFFSET(pass) (1<<((7-(pass))>>1)) |
michael@0 | 2606 | |
michael@0 | 2607 | /* Two macros to help evaluate the number of rows or columns in each |
michael@0 | 2608 | * pass. This is expressed as a shift - effectively log2 of the number or |
michael@0 | 2609 | * rows or columns in each 8x8 tile of the original image. |
michael@0 | 2610 | */ |
michael@0 | 2611 | #define PNG_PASS_ROW_SHIFT(pass) ((pass)>2?(8-(pass))>>1:3) |
michael@0 | 2612 | #define PNG_PASS_COL_SHIFT(pass) ((pass)>1?(7-(pass))>>1:3) |
michael@0 | 2613 | |
michael@0 | 2614 | /* Hence two macros to determine the number of rows or columns in a given |
michael@0 | 2615 | * pass of an image given its height or width. In fact these macros may |
michael@0 | 2616 | * return non-zero even though the sub-image is empty, because the other |
michael@0 | 2617 | * dimension may be empty for a small image. |
michael@0 | 2618 | */ |
michael@0 | 2619 | #define PNG_PASS_ROWS(height, pass) (((height)+(((1<<PNG_PASS_ROW_SHIFT(pass))\ |
michael@0 | 2620 | -1)-PNG_PASS_START_ROW(pass)))>>PNG_PASS_ROW_SHIFT(pass)) |
michael@0 | 2621 | #define PNG_PASS_COLS(width, pass) (((width)+(((1<<PNG_PASS_COL_SHIFT(pass))\ |
michael@0 | 2622 | -1)-PNG_PASS_START_COL(pass)))>>PNG_PASS_COL_SHIFT(pass)) |
michael@0 | 2623 | |
michael@0 | 2624 | /* For the reader row callbacks (both progressive and sequential) it is |
michael@0 | 2625 | * necessary to find the row in the output image given a row in an interlaced |
michael@0 | 2626 | * image, so two more macros: |
michael@0 | 2627 | */ |
michael@0 | 2628 | #define PNG_ROW_FROM_PASS_ROW(y_in, pass) \ |
michael@0 | 2629 | (((y_in)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass)) |
michael@0 | 2630 | #define PNG_COL_FROM_PASS_COL(x_in, pass) \ |
michael@0 | 2631 | (((x_in)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass)) |
michael@0 | 2632 | |
michael@0 | 2633 | /* Two macros which return a boolean (0 or 1) saying whether the given row |
michael@0 | 2634 | * or column is in a particular pass. These use a common utility macro that |
michael@0 | 2635 | * returns a mask for a given pass - the offset 'off' selects the row or |
michael@0 | 2636 | * column version. The mask has the appropriate bit set for each column in |
michael@0 | 2637 | * the tile. |
michael@0 | 2638 | */ |
michael@0 | 2639 | #define PNG_PASS_MASK(pass,off) ( \ |
michael@0 | 2640 | ((0x110145AF>>(((7-(off))-(pass))<<2)) & 0xF) | \ |
michael@0 | 2641 | ((0x01145AF0>>(((7-(off))-(pass))<<2)) & 0xF0)) |
michael@0 | 2642 | |
michael@0 | 2643 | #define PNG_ROW_IN_INTERLACE_PASS(y, pass) \ |
michael@0 | 2644 | ((PNG_PASS_MASK(pass,0) >> ((y)&7)) & 1) |
michael@0 | 2645 | #define PNG_COL_IN_INTERLACE_PASS(x, pass) \ |
michael@0 | 2646 | ((PNG_PASS_MASK(pass,1) >> ((x)&7)) & 1) |
michael@0 | 2647 | |
michael@0 | 2648 | #ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED |
michael@0 | 2649 | /* With these routines we avoid an integer divide, which will be slower on |
michael@0 | 2650 | * most machines. However, it does take more operations than the corresponding |
michael@0 | 2651 | * divide method, so it may be slower on a few RISC systems. There are two |
michael@0 | 2652 | * shifts (by 8 or 16 bits) and an addition, versus a single integer divide. |
michael@0 | 2653 | * |
michael@0 | 2654 | * Note that the rounding factors are NOT supposed to be the same! 128 and |
michael@0 | 2655 | * 32768 are correct for the NODIV code; 127 and 32767 are correct for the |
michael@0 | 2656 | * standard method. |
michael@0 | 2657 | * |
michael@0 | 2658 | * [Optimized code by Greg Roelofs and Mark Adler...blame us for bugs. :-) ] |
michael@0 | 2659 | */ |
michael@0 | 2660 | |
michael@0 | 2661 | /* fg and bg should be in `gamma 1.0' space; alpha is the opacity */ |
michael@0 | 2662 | |
michael@0 | 2663 | # define png_composite(composite, fg, alpha, bg) \ |
michael@0 | 2664 | { png_uint_16 temp = (png_uint_16)((png_uint_16)(fg) \ |
michael@0 | 2665 | * (png_uint_16)(alpha) \ |
michael@0 | 2666 | + (png_uint_16)(bg)*(png_uint_16)(255 \ |
michael@0 | 2667 | - (png_uint_16)(alpha)) + 128); \ |
michael@0 | 2668 | (composite) = (png_byte)((temp + (temp >> 8)) >> 8); } |
michael@0 | 2669 | |
michael@0 | 2670 | # define png_composite_16(composite, fg, alpha, bg) \ |
michael@0 | 2671 | { png_uint_32 temp = (png_uint_32)((png_uint_32)(fg) \ |
michael@0 | 2672 | * (png_uint_32)(alpha) \ |
michael@0 | 2673 | + (png_uint_32)(bg)*(65535 \ |
michael@0 | 2674 | - (png_uint_32)(alpha)) + 32768); \ |
michael@0 | 2675 | (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); } |
michael@0 | 2676 | |
michael@0 | 2677 | #else /* Standard method using integer division */ |
michael@0 | 2678 | |
michael@0 | 2679 | # define png_composite(composite, fg, alpha, bg) \ |
michael@0 | 2680 | (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) + \ |
michael@0 | 2681 | (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \ |
michael@0 | 2682 | 127) / 255) |
michael@0 | 2683 | |
michael@0 | 2684 | # define png_composite_16(composite, fg, alpha, bg) \ |
michael@0 | 2685 | (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \ |
michael@0 | 2686 | (png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) + \ |
michael@0 | 2687 | 32767) / 65535) |
michael@0 | 2688 | #endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */ |
michael@0 | 2689 | |
michael@0 | 2690 | #ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED |
michael@0 | 2691 | PNG_EXPORT(201, png_uint_32, png_get_uint_32, (png_const_bytep buf)); |
michael@0 | 2692 | PNG_EXPORT(202, png_uint_16, png_get_uint_16, (png_const_bytep buf)); |
michael@0 | 2693 | PNG_EXPORT(203, png_int_32, png_get_int_32, (png_const_bytep buf)); |
michael@0 | 2694 | #endif |
michael@0 | 2695 | |
michael@0 | 2696 | PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_const_structrp png_ptr, |
michael@0 | 2697 | png_const_bytep buf)); |
michael@0 | 2698 | /* No png_get_int_16 -- may be added if there's a real need for it. */ |
michael@0 | 2699 | |
michael@0 | 2700 | /* Place a 32-bit number into a buffer in PNG byte order (big-endian). */ |
michael@0 | 2701 | #ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED |
michael@0 | 2702 | PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i)); |
michael@0 | 2703 | #endif |
michael@0 | 2704 | #ifdef PNG_SAVE_INT_32_SUPPORTED |
michael@0 | 2705 | PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i)); |
michael@0 | 2706 | #endif |
michael@0 | 2707 | |
michael@0 | 2708 | /* Place a 16-bit number into a buffer in PNG byte order. |
michael@0 | 2709 | * The parameter is declared unsigned int, not png_uint_16, |
michael@0 | 2710 | * just to avoid potential problems on pre-ANSI C compilers. |
michael@0 | 2711 | */ |
michael@0 | 2712 | #ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED |
michael@0 | 2713 | PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i)); |
michael@0 | 2714 | /* No png_save_int_16 -- may be added if there's a real need for it. */ |
michael@0 | 2715 | #endif |
michael@0 | 2716 | |
michael@0 | 2717 | #ifdef PNG_USE_READ_MACROS |
michael@0 | 2718 | /* Inline macros to do direct reads of bytes from the input buffer. |
michael@0 | 2719 | * The png_get_int_32() routine assumes we are using two's complement |
michael@0 | 2720 | * format for negative values, which is almost certainly true. |
michael@0 | 2721 | */ |
michael@0 | 2722 | # define PNG_get_uint_32(buf) \ |
michael@0 | 2723 | (((png_uint_32)(*(buf)) << 24) + \ |
michael@0 | 2724 | ((png_uint_32)(*((buf) + 1)) << 16) + \ |
michael@0 | 2725 | ((png_uint_32)(*((buf) + 2)) << 8) + \ |
michael@0 | 2726 | ((png_uint_32)(*((buf) + 3)))) |
michael@0 | 2727 | |
michael@0 | 2728 | /* From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the |
michael@0 | 2729 | * function) incorrectly returned a value of type png_uint_32. |
michael@0 | 2730 | */ |
michael@0 | 2731 | # define PNG_get_uint_16(buf) \ |
michael@0 | 2732 | ((png_uint_16) \ |
michael@0 | 2733 | (((unsigned int)(*(buf)) << 8) + \ |
michael@0 | 2734 | ((unsigned int)(*((buf) + 1))))) |
michael@0 | 2735 | |
michael@0 | 2736 | # define PNG_get_int_32(buf) \ |
michael@0 | 2737 | ((png_int_32)((*(buf) & 0x80) \ |
michael@0 | 2738 | ? -((png_int_32)((png_get_uint_32(buf) ^ 0xffffffffL) + 1)) \ |
michael@0 | 2739 | : (png_int_32)png_get_uint_32(buf))) |
michael@0 | 2740 | |
michael@0 | 2741 | /* If PNG_PREFIX is defined the same thing as below happens in pnglibconf.h, |
michael@0 | 2742 | * but defining a macro name prefixed with PNG_PREFIX. |
michael@0 | 2743 | */ |
michael@0 | 2744 | # ifndef PNG_PREFIX |
michael@0 | 2745 | # define png_get_uint_32(buf) PNG_get_uint_32(buf) |
michael@0 | 2746 | # define png_get_uint_16(buf) PNG_get_uint_16(buf) |
michael@0 | 2747 | # define png_get_int_32(buf) PNG_get_int_32(buf) |
michael@0 | 2748 | # endif |
michael@0 | 2749 | #else |
michael@0 | 2750 | # ifdef PNG_PREFIX |
michael@0 | 2751 | /* No macros; revert to the (redefined) function */ |
michael@0 | 2752 | # define PNG_get_uint_32 (png_get_uint_32) |
michael@0 | 2753 | # define PNG_get_uint_16 (png_get_uint_16) |
michael@0 | 2754 | # define PNG_get_int_32 (png_get_int_32) |
michael@0 | 2755 | # endif |
michael@0 | 2756 | #endif |
michael@0 | 2757 | |
michael@0 | 2758 | /******************************************************************************* |
michael@0 | 2759 | * SIMPLIFIED API |
michael@0 | 2760 | ******************************************************************************* |
michael@0 | 2761 | * |
michael@0 | 2762 | * Please read the documentation in libpng-manual.txt (TODO: write said |
michael@0 | 2763 | * documentation) if you don't understand what follows. |
michael@0 | 2764 | * |
michael@0 | 2765 | * The simplified API hides the details of both libpng and the PNG file format |
michael@0 | 2766 | * itself. It allows PNG files to be read into a very limited number of |
michael@0 | 2767 | * in-memory bitmap formats or to be written from the same formats. If these |
michael@0 | 2768 | * formats do not accomodate your needs then you can, and should, use the more |
michael@0 | 2769 | * sophisticated APIs above - these support a wide variety of in-memory formats |
michael@0 | 2770 | * and a wide variety of sophisticated transformations to those formats as well |
michael@0 | 2771 | * as a wide variety of APIs to manipulate ancillary information. |
michael@0 | 2772 | * |
michael@0 | 2773 | * To read a PNG file using the simplified API: |
michael@0 | 2774 | * |
michael@0 | 2775 | * 1) Declare a 'png_image' structure (see below) on the stack and set the |
michael@0 | 2776 | * version field to PNG_IMAGE_VERSION. |
michael@0 | 2777 | * 2) Call the appropriate png_image_begin_read... function. |
michael@0 | 2778 | * 3) Set the png_image 'format' member to the required sample format. |
michael@0 | 2779 | * 4) Allocate a buffer for the image and, if required, the color-map. |
michael@0 | 2780 | * 5) Call png_image_finish_read to read the image and, if required, the |
michael@0 | 2781 | * color-map into your buffers. |
michael@0 | 2782 | * |
michael@0 | 2783 | * There are no restrictions on the format of the PNG input itself; all valid |
michael@0 | 2784 | * color types, bit depths, and interlace methods are acceptable, and the |
michael@0 | 2785 | * input image is transformed as necessary to the requested in-memory format |
michael@0 | 2786 | * during the png_image_finish_read() step. The only caveat is that if you |
michael@0 | 2787 | * request a color-mapped image from a PNG that is full-color or makes |
michael@0 | 2788 | * complex use of an alpha channel the transformation is extremely lossy and the |
michael@0 | 2789 | * result may look terrible. |
michael@0 | 2790 | * |
michael@0 | 2791 | * To write a PNG file using the simplified API: |
michael@0 | 2792 | * |
michael@0 | 2793 | * 1) Declare a 'png_image' structure on the stack and memset() it to all zero. |
michael@0 | 2794 | * 2) Initialize the members of the structure that describe the image, setting |
michael@0 | 2795 | * the 'format' member to the format of the image samples. |
michael@0 | 2796 | * 3) Call the appropriate png_image_write... function with a pointer to the |
michael@0 | 2797 | * image and, if necessary, the color-map to write the PNG data. |
michael@0 | 2798 | * |
michael@0 | 2799 | * png_image is a structure that describes the in-memory format of an image |
michael@0 | 2800 | * when it is being read or defines the in-memory format of an image that you |
michael@0 | 2801 | * need to write: |
michael@0 | 2802 | */ |
michael@0 | 2803 | #define PNG_IMAGE_VERSION 1 |
michael@0 | 2804 | |
michael@0 | 2805 | typedef struct png_control *png_controlp; |
michael@0 | 2806 | typedef struct |
michael@0 | 2807 | { |
michael@0 | 2808 | png_controlp opaque; /* Initialize to NULL, free with png_image_free */ |
michael@0 | 2809 | png_uint_32 version; /* Set to PNG_IMAGE_VERSION */ |
michael@0 | 2810 | png_uint_32 width; /* Image width in pixels (columns) */ |
michael@0 | 2811 | png_uint_32 height; /* Image height in pixels (rows) */ |
michael@0 | 2812 | png_uint_32 format; /* Image format as defined below */ |
michael@0 | 2813 | png_uint_32 flags; /* A bit mask containing informational flags */ |
michael@0 | 2814 | png_uint_32 colormap_entries; |
michael@0 | 2815 | /* Number of entries in the color-map */ |
michael@0 | 2816 | |
michael@0 | 2817 | /* In the event of an error or warning the following field will be set to a |
michael@0 | 2818 | * non-zero value and the 'message' field will contain a '\0' terminated |
michael@0 | 2819 | * string with the libpng error or warning message. If both warnings and |
michael@0 | 2820 | * an error were encountered, only the error is recorded. If there |
michael@0 | 2821 | * are multiple warnings, only the first one is recorded. |
michael@0 | 2822 | * |
michael@0 | 2823 | * The upper 30 bits of this value are reserved, the low two bits contain |
michael@0 | 2824 | * a value as follows: |
michael@0 | 2825 | */ |
michael@0 | 2826 | # define PNG_IMAGE_WARNING 1 |
michael@0 | 2827 | # define PNG_IMAGE_ERROR 2 |
michael@0 | 2828 | /* |
michael@0 | 2829 | * The result is a two bit code such that a value more than 1 indicates |
michael@0 | 2830 | * a failure in the API just called: |
michael@0 | 2831 | * |
michael@0 | 2832 | * 0 - no warning or error |
michael@0 | 2833 | * 1 - warning |
michael@0 | 2834 | * 2 - error |
michael@0 | 2835 | * 3 - error preceded by warning |
michael@0 | 2836 | */ |
michael@0 | 2837 | # define PNG_IMAGE_FAILED(png_cntrl) ((((png_cntrl).warning_or_error)&0x03)>1) |
michael@0 | 2838 | |
michael@0 | 2839 | png_uint_32 warning_or_error; |
michael@0 | 2840 | |
michael@0 | 2841 | char message[64]; |
michael@0 | 2842 | } png_image, *png_imagep; |
michael@0 | 2843 | |
michael@0 | 2844 | /* The samples of the image have one to four channels whose components have |
michael@0 | 2845 | * original values in the range 0 to 1.0: |
michael@0 | 2846 | * |
michael@0 | 2847 | * 1: A single gray or luminance channel (G). |
michael@0 | 2848 | * 2: A gray/luminance channel and an alpha channel (GA). |
michael@0 | 2849 | * 3: Three red, green, blue color channels (RGB). |
michael@0 | 2850 | * 4: Three color channels and an alpha channel (RGBA). |
michael@0 | 2851 | * |
michael@0 | 2852 | * The components are encoded in one of two ways: |
michael@0 | 2853 | * |
michael@0 | 2854 | * a) As a small integer, value 0..255, contained in a single byte. For the |
michael@0 | 2855 | * alpha channel the original value is simply value/255. For the color or |
michael@0 | 2856 | * luminance channels the value is encoded according to the sRGB specification |
michael@0 | 2857 | * and matches the 8-bit format expected by typical display devices. |
michael@0 | 2858 | * |
michael@0 | 2859 | * The color/gray channels are not scaled (pre-multiplied) by the alpha |
michael@0 | 2860 | * channel and are suitable for passing to color management software. |
michael@0 | 2861 | * |
michael@0 | 2862 | * b) As a value in the range 0..65535, contained in a 2-byte integer. All |
michael@0 | 2863 | * channels can be converted to the original value by dividing by 65535; all |
michael@0 | 2864 | * channels are linear. Color channels use the RGB encoding (RGB end-points) of |
michael@0 | 2865 | * the sRGB specification. This encoding is identified by the |
michael@0 | 2866 | * PNG_FORMAT_FLAG_LINEAR flag below. |
michael@0 | 2867 | * |
michael@0 | 2868 | * When the simplified API needs to convert between sRGB and linear colorspaces, |
michael@0 | 2869 | * the actual sRGB transfer curve defined in the sRGB specification (see the |
michael@0 | 2870 | * article at http://en.wikipedia.org/wiki/SRGB) is used, not the gamma=1/2.2 |
michael@0 | 2871 | * approximation used elsewhere in libpng. |
michael@0 | 2872 | * |
michael@0 | 2873 | * When an alpha channel is present it is expected to denote pixel coverage |
michael@0 | 2874 | * of the color or luminance channels and is returned as an associated alpha |
michael@0 | 2875 | * channel: the color/gray channels are scaled (pre-multiplied) by the alpha |
michael@0 | 2876 | * value. |
michael@0 | 2877 | * |
michael@0 | 2878 | * The samples are either contained directly in the image data, between 1 and 8 |
michael@0 | 2879 | * bytes per pixel according to the encoding, or are held in a color-map indexed |
michael@0 | 2880 | * by bytes in the image data. In the case of a color-map the color-map entries |
michael@0 | 2881 | * are individual samples, encoded as above, and the image data has one byte per |
michael@0 | 2882 | * pixel to select the relevant sample from the color-map. |
michael@0 | 2883 | */ |
michael@0 | 2884 | |
michael@0 | 2885 | /* PNG_FORMAT_* |
michael@0 | 2886 | * |
michael@0 | 2887 | * #defines to be used in png_image::format. Each #define identifies a |
michael@0 | 2888 | * particular layout of sample data and, if present, alpha values. There are |
michael@0 | 2889 | * separate defines for each of the two component encodings. |
michael@0 | 2890 | * |
michael@0 | 2891 | * A format is built up using single bit flag values. All combinations are |
michael@0 | 2892 | * valid. Formats can be built up from the flag values or you can use one of |
michael@0 | 2893 | * the predefined values below. When testing formats always use the FORMAT_FLAG |
michael@0 | 2894 | * macros to test for individual features - future versions of the library may |
michael@0 | 2895 | * add new flags. |
michael@0 | 2896 | * |
michael@0 | 2897 | * When reading or writing color-mapped images the format should be set to the |
michael@0 | 2898 | * format of the entries in the color-map then png_image_{read,write}_colormap |
michael@0 | 2899 | * called to read or write the color-map and set the format correctly for the |
michael@0 | 2900 | * image data. Do not set the PNG_FORMAT_FLAG_COLORMAP bit directly! |
michael@0 | 2901 | * |
michael@0 | 2902 | * NOTE: libpng can be built with particular features disabled, if you see |
michael@0 | 2903 | * compiler errors because the definition of one of the following flags has been |
michael@0 | 2904 | * compiled out it is because libpng does not have the required support. It is |
michael@0 | 2905 | * possible, however, for the libpng configuration to enable the format on just |
michael@0 | 2906 | * read or just write; in that case you may see an error at run time. You can |
michael@0 | 2907 | * guard against this by checking for the definition of the appropriate |
michael@0 | 2908 | * "_SUPPORTED" macro, one of: |
michael@0 | 2909 | * |
michael@0 | 2910 | * PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED |
michael@0 | 2911 | */ |
michael@0 | 2912 | #define PNG_FORMAT_FLAG_ALPHA 0x01U /* format with an alpha channel */ |
michael@0 | 2913 | #define PNG_FORMAT_FLAG_COLOR 0x02U /* color format: otherwise grayscale */ |
michael@0 | 2914 | #define PNG_FORMAT_FLAG_LINEAR 0x04U /* 2 byte channels else 1 byte */ |
michael@0 | 2915 | #define PNG_FORMAT_FLAG_COLORMAP 0x08U /* image data is color-mapped */ |
michael@0 | 2916 | |
michael@0 | 2917 | #ifdef PNG_FORMAT_BGR_SUPPORTED |
michael@0 | 2918 | # define PNG_FORMAT_FLAG_BGR 0x10U /* BGR colors, else order is RGB */ |
michael@0 | 2919 | #endif |
michael@0 | 2920 | |
michael@0 | 2921 | #ifdef PNG_FORMAT_AFIRST_SUPPORTED |
michael@0 | 2922 | # define PNG_FORMAT_FLAG_AFIRST 0x20U /* alpha channel comes first */ |
michael@0 | 2923 | #endif |
michael@0 | 2924 | |
michael@0 | 2925 | /* Commonly used formats have predefined macros. |
michael@0 | 2926 | * |
michael@0 | 2927 | * First the single byte (sRGB) formats: |
michael@0 | 2928 | */ |
michael@0 | 2929 | #define PNG_FORMAT_GRAY 0 |
michael@0 | 2930 | #define PNG_FORMAT_GA PNG_FORMAT_FLAG_ALPHA |
michael@0 | 2931 | #define PNG_FORMAT_AG (PNG_FORMAT_GA|PNG_FORMAT_FLAG_AFIRST) |
michael@0 | 2932 | #define PNG_FORMAT_RGB PNG_FORMAT_FLAG_COLOR |
michael@0 | 2933 | #define PNG_FORMAT_BGR (PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_BGR) |
michael@0 | 2934 | #define PNG_FORMAT_RGBA (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_ALPHA) |
michael@0 | 2935 | #define PNG_FORMAT_ARGB (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_AFIRST) |
michael@0 | 2936 | #define PNG_FORMAT_BGRA (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_ALPHA) |
michael@0 | 2937 | #define PNG_FORMAT_ABGR (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_AFIRST) |
michael@0 | 2938 | |
michael@0 | 2939 | /* Then the linear 2-byte formats. When naming these "Y" is used to |
michael@0 | 2940 | * indicate a luminance (gray) channel. |
michael@0 | 2941 | */ |
michael@0 | 2942 | #define PNG_FORMAT_LINEAR_Y PNG_FORMAT_FLAG_LINEAR |
michael@0 | 2943 | #define PNG_FORMAT_LINEAR_Y_ALPHA (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_ALPHA) |
michael@0 | 2944 | #define PNG_FORMAT_LINEAR_RGB (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR) |
michael@0 | 2945 | #define PNG_FORMAT_LINEAR_RGB_ALPHA \ |
michael@0 | 2946 | (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA) |
michael@0 | 2947 | |
michael@0 | 2948 | /* With color-mapped formats the image data is one byte for each pixel, the byte |
michael@0 | 2949 | * is an index into the color-map which is formatted as above. To obtain a |
michael@0 | 2950 | * color-mapped format it is sufficient just to add the PNG_FOMAT_FLAG_COLORMAP |
michael@0 | 2951 | * to one of the above definitions, or you can use one of the definitions below. |
michael@0 | 2952 | */ |
michael@0 | 2953 | #define PNG_FORMAT_RGB_COLORMAP (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_COLORMAP) |
michael@0 | 2954 | #define PNG_FORMAT_BGR_COLORMAP (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_COLORMAP) |
michael@0 | 2955 | #define PNG_FORMAT_RGBA_COLORMAP (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_COLORMAP) |
michael@0 | 2956 | #define PNG_FORMAT_ARGB_COLORMAP (PNG_FORMAT_ARGB|PNG_FORMAT_FLAG_COLORMAP) |
michael@0 | 2957 | #define PNG_FORMAT_BGRA_COLORMAP (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_COLORMAP) |
michael@0 | 2958 | #define PNG_FORMAT_ABGR_COLORMAP (PNG_FORMAT_ABGR|PNG_FORMAT_FLAG_COLORMAP) |
michael@0 | 2959 | |
michael@0 | 2960 | /* PNG_IMAGE macros |
michael@0 | 2961 | * |
michael@0 | 2962 | * These are convenience macros to derive information from a png_image |
michael@0 | 2963 | * structure. The PNG_IMAGE_SAMPLE_ macros return values appropriate to the |
michael@0 | 2964 | * actual image sample values - either the entries in the color-map or the |
michael@0 | 2965 | * pixels in the image. The PNG_IMAGE_PIXEL_ macros return corresponding values |
michael@0 | 2966 | * for the pixels and will always return 1 for color-mapped formats. The |
michael@0 | 2967 | * remaining macros return information about the rows in the image and the |
michael@0 | 2968 | * complete image. |
michael@0 | 2969 | * |
michael@0 | 2970 | * NOTE: All the macros that take a png_image::format parameter are compile time |
michael@0 | 2971 | * constants if the format parameter is, itself, a constant. Therefore these |
michael@0 | 2972 | * macros can be used in array declarations and case labels where required. |
michael@0 | 2973 | * Similarly the macros are also pre-processor constants (sizeof is not used) so |
michael@0 | 2974 | * they can be used in #if tests. |
michael@0 | 2975 | * |
michael@0 | 2976 | * First the information about the samples. |
michael@0 | 2977 | */ |
michael@0 | 2978 | #define PNG_IMAGE_SAMPLE_CHANNELS(fmt)\ |
michael@0 | 2979 | (((fmt)&(PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA))+1) |
michael@0 | 2980 | /* Return the total number of channels in a given format: 1..4 */ |
michael@0 | 2981 | |
michael@0 | 2982 | #define PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt)\ |
michael@0 | 2983 | ((((fmt) & PNG_FORMAT_FLAG_LINEAR) >> 2)+1) |
michael@0 | 2984 | /* Return the size in bytes of a single component of a pixel or color-map |
michael@0 | 2985 | * entry (as appropriate) in the image: 1 or 2. |
michael@0 | 2986 | */ |
michael@0 | 2987 | |
michael@0 | 2988 | #define PNG_IMAGE_SAMPLE_SIZE(fmt)\ |
michael@0 | 2989 | (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt)) |
michael@0 | 2990 | /* This is the size of the sample data for one sample. If the image is |
michael@0 | 2991 | * color-mapped it is the size of one color-map entry (and image pixels are |
michael@0 | 2992 | * one byte in size), otherwise it is the size of one image pixel. |
michael@0 | 2993 | */ |
michael@0 | 2994 | |
michael@0 | 2995 | #define PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)\ |
michael@0 | 2996 | (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * 256) |
michael@0 | 2997 | /* The maximum size of the color-map required by the format expressed in a |
michael@0 | 2998 | * count of components. This can be used to compile-time allocate a |
michael@0 | 2999 | * color-map: |
michael@0 | 3000 | * |
michael@0 | 3001 | * png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)]; |
michael@0 | 3002 | * |
michael@0 | 3003 | * png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)]; |
michael@0 | 3004 | * |
michael@0 | 3005 | * Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the |
michael@0 | 3006 | * information from one of the png_image_begin_read_ APIs and dynamically |
michael@0 | 3007 | * allocate the required memory. |
michael@0 | 3008 | */ |
michael@0 | 3009 | |
michael@0 | 3010 | /* Corresponding information about the pixels */ |
michael@0 | 3011 | #define PNG_IMAGE_PIXEL_(test,fmt)\ |
michael@0 | 3012 | (((fmt)&PNG_FORMAT_FLAG_COLORMAP)?1:test(fmt)) |
michael@0 | 3013 | |
michael@0 | 3014 | #define PNG_IMAGE_PIXEL_CHANNELS(fmt)\ |
michael@0 | 3015 | PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_CHANNELS,fmt) |
michael@0 | 3016 | /* The number of separate channels (components) in a pixel; 1 for a |
michael@0 | 3017 | * color-mapped image. |
michael@0 | 3018 | */ |
michael@0 | 3019 | |
michael@0 | 3020 | #define PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)\ |
michael@0 | 3021 | PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_COMPONENT_SIZE,fmt) |
michael@0 | 3022 | /* The size, in bytes, of each component in a pixel; 1 for a color-mapped |
michael@0 | 3023 | * image. |
michael@0 | 3024 | */ |
michael@0 | 3025 | |
michael@0 | 3026 | #define PNG_IMAGE_PIXEL_SIZE(fmt) PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_SIZE,fmt) |
michael@0 | 3027 | /* The size, in bytes, of a complete pixel; 1 for a color-mapped image. */ |
michael@0 | 3028 | |
michael@0 | 3029 | /* Information about the whole row, or whole image */ |
michael@0 | 3030 | #define PNG_IMAGE_ROW_STRIDE(image)\ |
michael@0 | 3031 | (PNG_IMAGE_PIXEL_CHANNELS((image).format) * (image).width) |
michael@0 | 3032 | /* Return the total number of components in a single row of the image; this |
michael@0 | 3033 | * is the minimum 'row stride', the minimum count of components between each |
michael@0 | 3034 | * row. For a color-mapped image this is the minimum number of bytes in a |
michael@0 | 3035 | * row. |
michael@0 | 3036 | */ |
michael@0 | 3037 | |
michael@0 | 3038 | #define PNG_IMAGE_BUFFER_SIZE(image, row_stride)\ |
michael@0 | 3039 | (PNG_IMAGE_PIXEL_COMPONENT_SIZE((image).format)*(image).height*(row_stride)) |
michael@0 | 3040 | /* Return the size, in bytes, of an image buffer given a png_image and a row |
michael@0 | 3041 | * stride - the number of components to leave space for in each row. |
michael@0 | 3042 | */ |
michael@0 | 3043 | |
michael@0 | 3044 | #define PNG_IMAGE_SIZE(image)\ |
michael@0 | 3045 | PNG_IMAGE_BUFFER_SIZE(image, PNG_IMAGE_ROW_STRIDE(image)) |
michael@0 | 3046 | /* Return the size, in bytes, of the image in memory given just a png_image; |
michael@0 | 3047 | * the row stride is the minimum stride required for the image. |
michael@0 | 3048 | */ |
michael@0 | 3049 | |
michael@0 | 3050 | #define PNG_IMAGE_COLORMAP_SIZE(image)\ |
michael@0 | 3051 | (PNG_IMAGE_SAMPLE_SIZE((image).format) * (image).colormap_entries) |
michael@0 | 3052 | /* Return the size, in bytes, of the color-map of this image. If the image |
michael@0 | 3053 | * format is not a color-map format this will return a size sufficient for |
michael@0 | 3054 | * 256 entries in the given format; check PNG_FORMAT_FLAG_COLORMAP if |
michael@0 | 3055 | * you don't want to allocate a color-map in this case. |
michael@0 | 3056 | */ |
michael@0 | 3057 | |
michael@0 | 3058 | /* PNG_IMAGE_FLAG_* |
michael@0 | 3059 | * |
michael@0 | 3060 | * Flags containing additional information about the image are held in the |
michael@0 | 3061 | * 'flags' field of png_image. |
michael@0 | 3062 | */ |
michael@0 | 3063 | #define PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB 0x01 |
michael@0 | 3064 | /* This indicates the the RGB values of the in-memory bitmap do not |
michael@0 | 3065 | * correspond to the red, green and blue end-points defined by sRGB. |
michael@0 | 3066 | */ |
michael@0 | 3067 | |
michael@0 | 3068 | #define PNG_IMAGE_FLAG_FAST 0x02 |
michael@0 | 3069 | /* On write emphasise speed over compression; the resultant PNG file will be |
michael@0 | 3070 | * larger but will be produced significantly faster, particular for large |
michael@0 | 3071 | * images. Do not use this option for images which will be distributed, only |
michael@0 | 3072 | * used it when producing intermediate files that will be read back in |
michael@0 | 3073 | * repeatedly. For a typical 24-bit image the option will double the read |
michael@0 | 3074 | * speed at the cost of increasing the image size by 25%, however for many |
michael@0 | 3075 | * more compressible images the PNG file can be 10 times larger with only a |
michael@0 | 3076 | * slight speed gain. |
michael@0 | 3077 | */ |
michael@0 | 3078 | |
michael@0 | 3079 | #define PNG_IMAGE_FLAG_16BIT_sRGB 0x04 |
michael@0 | 3080 | /* On read if the image is a 16-bit per component image and there is no gAMA |
michael@0 | 3081 | * or sRGB chunk assume that the components are sRGB encoded. Notice that |
michael@0 | 3082 | * images output by the simplified API always have gamma information; setting |
michael@0 | 3083 | * this flag only affects the interpretation of 16-bit images from an |
michael@0 | 3084 | * external source. It is recommended that the application expose this flag |
michael@0 | 3085 | * to the user; the user can normally easily recognize the difference between |
michael@0 | 3086 | * linear and sRGB encoding. This flag has no effect on write - the data |
michael@0 | 3087 | * passed to the write APIs must have the correct encoding (as defined |
michael@0 | 3088 | * above.) |
michael@0 | 3089 | * |
michael@0 | 3090 | * If the flag is not set (the default) input 16-bit per component data is |
michael@0 | 3091 | * assumed to be linear. |
michael@0 | 3092 | * |
michael@0 | 3093 | * NOTE: the flag can only be set after the png_image_begin_read_ call, |
michael@0 | 3094 | * because that call initializes the 'flags' field. |
michael@0 | 3095 | */ |
michael@0 | 3096 | |
michael@0 | 3097 | #ifdef PNG_SIMPLIFIED_READ_SUPPORTED |
michael@0 | 3098 | /* READ APIs |
michael@0 | 3099 | * --------- |
michael@0 | 3100 | * |
michael@0 | 3101 | * The png_image passed to the read APIs must have been initialized by setting |
michael@0 | 3102 | * the png_controlp field 'opaque' to NULL (or, safer, memset the whole thing.) |
michael@0 | 3103 | */ |
michael@0 | 3104 | #ifdef PNG_STDIO_SUPPORTED |
michael@0 | 3105 | PNG_EXPORT(234, int, png_image_begin_read_from_file, (png_imagep image, |
michael@0 | 3106 | const char *file_name)); |
michael@0 | 3107 | /* The named file is opened for read and the image header is filled in |
michael@0 | 3108 | * from the PNG header in the file. |
michael@0 | 3109 | */ |
michael@0 | 3110 | |
michael@0 | 3111 | PNG_EXPORT(235, int, png_image_begin_read_from_stdio, (png_imagep image, |
michael@0 | 3112 | FILE* file)); |
michael@0 | 3113 | /* The PNG header is read from the stdio FILE object. */ |
michael@0 | 3114 | #endif /* PNG_STDIO_SUPPORTED */ |
michael@0 | 3115 | |
michael@0 | 3116 | PNG_EXPORT(236, int, png_image_begin_read_from_memory, (png_imagep image, |
michael@0 | 3117 | png_const_voidp memory, png_size_t size)); |
michael@0 | 3118 | /* The PNG header is read from the given memory buffer. */ |
michael@0 | 3119 | |
michael@0 | 3120 | PNG_EXPORT(237, int, png_image_finish_read, (png_imagep image, |
michael@0 | 3121 | png_const_colorp background, void *buffer, png_int_32 row_stride, |
michael@0 | 3122 | void *colormap)); |
michael@0 | 3123 | /* Finish reading the image into the supplied buffer and clean up the |
michael@0 | 3124 | * png_image structure. |
michael@0 | 3125 | * |
michael@0 | 3126 | * row_stride is the step, in byte or 2-byte units as appropriate, |
michael@0 | 3127 | * between adjacent rows. A positive stride indicates that the top-most row |
michael@0 | 3128 | * is first in the buffer - the normal top-down arrangement. A negative |
michael@0 | 3129 | * stride indicates that the bottom-most row is first in the buffer. |
michael@0 | 3130 | * |
michael@0 | 3131 | * background need only be supplied if an alpha channel must be removed from |
michael@0 | 3132 | * a png_byte format and the removal is to be done by compositing on a solid |
michael@0 | 3133 | * color; otherwise it may be NULL and any composition will be done directly |
michael@0 | 3134 | * onto the buffer. The value is an sRGB color to use for the background, |
michael@0 | 3135 | * for grayscale output the green channel is used. |
michael@0 | 3136 | * |
michael@0 | 3137 | * background must be supplied when an alpha channel must be removed from a |
michael@0 | 3138 | * single byte color-mapped output format, in other words if: |
michael@0 | 3139 | * |
michael@0 | 3140 | * 1) The original format from png_image_begin_read_from_* had |
michael@0 | 3141 | * PNG_FORMAT_FLAG_ALPHA set. |
michael@0 | 3142 | * 2) The format set by the application does not. |
michael@0 | 3143 | * 3) The format set by the application has PNG_FORMAT_FLAG_COLORMAP set and |
michael@0 | 3144 | * PNG_FORMAT_FLAG_LINEAR *not* set. |
michael@0 | 3145 | * |
michael@0 | 3146 | * For linear output removing the alpha channel is always done by compositing |
michael@0 | 3147 | * on black and background is ignored. |
michael@0 | 3148 | * |
michael@0 | 3149 | * colormap must be supplied when PNG_FORMAT_FLAG_COLORMAP is set. It must |
michael@0 | 3150 | * be at least the size (in bytes) returned by PNG_IMAGE_COLORMAP_SIZE. |
michael@0 | 3151 | * image->colormap_entries will be updated to the actual number of entries |
michael@0 | 3152 | * written to the colormap; this may be less than the original value. |
michael@0 | 3153 | */ |
michael@0 | 3154 | |
michael@0 | 3155 | PNG_EXPORT(238, void, png_image_free, (png_imagep image)); |
michael@0 | 3156 | /* Free any data allocated by libpng in image->opaque, setting the pointer to |
michael@0 | 3157 | * NULL. May be called at any time after the structure is initialized. |
michael@0 | 3158 | */ |
michael@0 | 3159 | #endif /* PNG_SIMPLIFIED_READ_SUPPORTED */ |
michael@0 | 3160 | |
michael@0 | 3161 | #ifdef PNG_SIMPLIFIED_WRITE_SUPPORTED |
michael@0 | 3162 | #ifdef PNG_STDIO_SUPPORTED |
michael@0 | 3163 | /* WRITE APIS |
michael@0 | 3164 | * ---------- |
michael@0 | 3165 | * For write you must initialize a png_image structure to describe the image to |
michael@0 | 3166 | * be written. To do this use memset to set the whole structure to 0 then |
michael@0 | 3167 | * initialize fields describing your image. |
michael@0 | 3168 | * |
michael@0 | 3169 | * version: must be set to PNG_IMAGE_VERSION |
michael@0 | 3170 | * opaque: must be initialized to NULL |
michael@0 | 3171 | * width: image width in pixels |
michael@0 | 3172 | * height: image height in rows |
michael@0 | 3173 | * format: the format of the data (image and color-map) you wish to write |
michael@0 | 3174 | * flags: set to 0 unless one of the defined flags applies; set |
michael@0 | 3175 | * PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images where the RGB |
michael@0 | 3176 | * values do not correspond to the colors in sRGB. |
michael@0 | 3177 | * colormap_entries: set to the number of entries in the color-map (0 to 256) |
michael@0 | 3178 | */ |
michael@0 | 3179 | PNG_EXPORT(239, int, png_image_write_to_file, (png_imagep image, |
michael@0 | 3180 | const char *file, int convert_to_8bit, const void *buffer, |
michael@0 | 3181 | png_int_32 row_stride, const void *colormap)); |
michael@0 | 3182 | /* Write the image to the named file. */ |
michael@0 | 3183 | |
michael@0 | 3184 | PNG_EXPORT(240, int, png_image_write_to_stdio, (png_imagep image, FILE *file, |
michael@0 | 3185 | int convert_to_8_bit, const void *buffer, png_int_32 row_stride, |
michael@0 | 3186 | const void *colormap)); |
michael@0 | 3187 | /* Write the image to the given (FILE*). */ |
michael@0 | 3188 | |
michael@0 | 3189 | /* With both write APIs if image is in one of the linear formats with 16-bit |
michael@0 | 3190 | * data then setting convert_to_8_bit will cause the output to be an 8-bit PNG |
michael@0 | 3191 | * gamma encoded according to the sRGB specification, otherwise a 16-bit linear |
michael@0 | 3192 | * encoded PNG file is written. |
michael@0 | 3193 | * |
michael@0 | 3194 | * With color-mapped data formats the colormap parameter point to a color-map |
michael@0 | 3195 | * with at least image->colormap_entries encoded in the specified format. If |
michael@0 | 3196 | * the format is linear the written PNG color-map will be converted to sRGB |
michael@0 | 3197 | * regardless of the convert_to_8_bit flag. |
michael@0 | 3198 | * |
michael@0 | 3199 | * With all APIs row_stride is handled as in the read APIs - it is the spacing |
michael@0 | 3200 | * from one row to the next in component sized units (1 or 2 bytes) and if |
michael@0 | 3201 | * negative indicates a bottom-up row layout in the buffer. |
michael@0 | 3202 | * |
michael@0 | 3203 | * Note that the write API does not support interlacing or sub-8-bit pixels. |
michael@0 | 3204 | */ |
michael@0 | 3205 | #endif /* PNG_STDIO_SUPPORTED */ |
michael@0 | 3206 | #endif /* PNG_SIMPLIFIED_WRITE_SUPPORTED */ |
michael@0 | 3207 | /******************************************************************************* |
michael@0 | 3208 | * END OF SIMPLIFIED API |
michael@0 | 3209 | ******************************************************************************/ |
michael@0 | 3210 | |
michael@0 | 3211 | #ifdef PNG_CHECK_FOR_INVALID_INDEX_SUPPORTED |
michael@0 | 3212 | PNG_EXPORT(242, void, png_set_check_for_invalid_index, |
michael@0 | 3213 | (png_structrp png_ptr, int allowed)); |
michael@0 | 3214 | # ifdef PNG_GET_PALETTE_MAX_SUPPORTED |
michael@0 | 3215 | PNG_EXPORT(243, int, png_get_palette_max, (png_const_structp png_ptr, |
michael@0 | 3216 | png_const_infop info_ptr)); |
michael@0 | 3217 | # endif |
michael@0 | 3218 | #endif /* CHECK_FOR_INVALID_INDEX */ |
michael@0 | 3219 | |
michael@0 | 3220 | /******************************************************************************* |
michael@0 | 3221 | * IMPLEMENTATION OPTIONS |
michael@0 | 3222 | ******************************************************************************* |
michael@0 | 3223 | * |
michael@0 | 3224 | * Support for arbitrary implementation-specific optimizations. The API allows |
michael@0 | 3225 | * particular options to be turned on or off. 'Option' is the number of the |
michael@0 | 3226 | * option and 'onoff' is 0 (off) or non-0 (on). The value returned is given |
michael@0 | 3227 | * by the PNG_OPTION_ defines below. |
michael@0 | 3228 | * |
michael@0 | 3229 | * HARDWARE: normally hardware capabilites, such as the Intel SSE instructions, |
michael@0 | 3230 | * are detected at run time, however sometimes it may be impossible |
michael@0 | 3231 | * to do this in user mode, in which case it is necessary to discover |
michael@0 | 3232 | * the capabilities in an OS specific way. Such capabilities are |
michael@0 | 3233 | * listed here when libpng has support for them and must be turned |
michael@0 | 3234 | * ON by the application if present. |
michael@0 | 3235 | * |
michael@0 | 3236 | * SOFTWARE: sometimes software optimizations actually result in performance |
michael@0 | 3237 | * decrease on some architectures or systems, or with some sets of |
michael@0 | 3238 | * PNG images. 'Software' options allow such optimizations to be |
michael@0 | 3239 | * selected at run time. |
michael@0 | 3240 | */ |
michael@0 | 3241 | #ifdef PNG_SET_OPTION_SUPPORTED |
michael@0 | 3242 | #ifdef PNG_ARM_NEON_API_SUPPORTED |
michael@0 | 3243 | # define PNG_ARM_NEON 0 /* HARDWARE: ARM Neon SIMD instructions supported */ |
michael@0 | 3244 | #endif |
michael@0 | 3245 | #define PNG_MAXIMUM_INFLATE_WINDOW 2 /* SOFTWARE: force maximum window */ |
michael@0 | 3246 | #define PNG_OPTION_NEXT 4 /* Next option - numbers must be even */ |
michael@0 | 3247 | |
michael@0 | 3248 | /* Return values: NOTE: there are four values and 'off' is *not* zero */ |
michael@0 | 3249 | #define PNG_OPTION_UNSET 0 /* Unset - defaults to off */ |
michael@0 | 3250 | #define PNG_OPTION_INVALID 1 /* Option number out of range */ |
michael@0 | 3251 | #define PNG_OPTION_OFF 2 |
michael@0 | 3252 | #define PNG_OPTION_ON 3 |
michael@0 | 3253 | |
michael@0 | 3254 | PNG_EXPORT(244, int, png_set_option, (png_structrp png_ptr, int option, |
michael@0 | 3255 | int onoff)); |
michael@0 | 3256 | #endif |
michael@0 | 3257 | |
michael@0 | 3258 | /******************************************************************************* |
michael@0 | 3259 | * END OF HARDWARE OPTIONS |
michael@0 | 3260 | ******************************************************************************/ |
michael@0 | 3261 | |
michael@0 | 3262 | #ifdef PNG_APNG_SUPPORTED |
michael@0 | 3263 | PNG_EXPORT(245, png_uint_32, png_get_acTL, (png_structp png_ptr, |
michael@0 | 3264 | png_infop info_ptr, png_uint_32 *num_frames, png_uint_32 *num_plays)); |
michael@0 | 3265 | |
michael@0 | 3266 | PNG_EXPORT(246, png_uint_32, png_set_acTL, (png_structp png_ptr, |
michael@0 | 3267 | png_infop info_ptr, png_uint_32 num_frames, png_uint_32 num_plays)); |
michael@0 | 3268 | |
michael@0 | 3269 | PNG_EXPORT(247, png_uint_32, png_get_num_frames, (png_structp png_ptr, |
michael@0 | 3270 | png_infop info_ptr)); |
michael@0 | 3271 | |
michael@0 | 3272 | PNG_EXPORT(248, png_uint_32, png_get_num_plays, (png_structp png_ptr, |
michael@0 | 3273 | png_infop info_ptr)); |
michael@0 | 3274 | |
michael@0 | 3275 | PNG_EXPORT(249, png_uint_32, png_get_next_frame_fcTL, |
michael@0 | 3276 | (png_structp png_ptr, png_infop info_ptr, png_uint_32 *width, |
michael@0 | 3277 | png_uint_32 *height, png_uint_32 *x_offset, png_uint_32 *y_offset, |
michael@0 | 3278 | png_uint_16 *delay_num, png_uint_16 *delay_den, png_byte *dispose_op, |
michael@0 | 3279 | png_byte *blend_op)); |
michael@0 | 3280 | |
michael@0 | 3281 | PNG_EXPORT(250, png_uint_32, png_set_next_frame_fcTL, |
michael@0 | 3282 | (png_structp png_ptr, png_infop info_ptr, png_uint_32 width, |
michael@0 | 3283 | png_uint_32 height, png_uint_32 x_offset, png_uint_32 y_offset, |
michael@0 | 3284 | png_uint_16 delay_num, png_uint_16 delay_den, png_byte dispose_op, |
michael@0 | 3285 | png_byte blend_op)); |
michael@0 | 3286 | |
michael@0 | 3287 | PNG_EXPORT(251, png_uint_32, png_get_next_frame_width, |
michael@0 | 3288 | (png_structp png_ptr, png_infop info_ptr)); |
michael@0 | 3289 | PNG_EXPORT(252, png_uint_32, png_get_next_frame_height, |
michael@0 | 3290 | (png_structp png_ptr, png_infop info_ptr)); |
michael@0 | 3291 | PNG_EXPORT(253, png_uint_32, png_get_next_frame_x_offset, |
michael@0 | 3292 | (png_structp png_ptr, png_infop info_ptr)); |
michael@0 | 3293 | PNG_EXPORT(254, png_uint_32, png_get_next_frame_y_offset, |
michael@0 | 3294 | (png_structp png_ptr, png_infop info_ptr)); |
michael@0 | 3295 | PNG_EXPORT(255, png_uint_16, png_get_next_frame_delay_num, |
michael@0 | 3296 | (png_structp png_ptr, png_infop info_ptr)); |
michael@0 | 3297 | PNG_EXPORT(256, png_uint_16, png_get_next_frame_delay_den, |
michael@0 | 3298 | (png_structp png_ptr, png_infop info_ptr)); |
michael@0 | 3299 | PNG_EXPORT(257, png_byte, png_get_next_frame_dispose_op, |
michael@0 | 3300 | (png_structp png_ptr, png_infop info_ptr)); |
michael@0 | 3301 | PNG_EXPORT(258, png_byte, png_get_next_frame_blend_op, |
michael@0 | 3302 | (png_structp png_ptr, png_infop info_ptr)); |
michael@0 | 3303 | PNG_EXPORT(259, png_byte, png_get_first_frame_is_hidden, |
michael@0 | 3304 | (png_structp png_ptr, png_infop info_ptr)); |
michael@0 | 3305 | PNG_EXPORT(260, png_uint_32, png_set_first_frame_is_hidden, |
michael@0 | 3306 | (png_structp png_ptr, png_infop info_ptr, png_byte is_hidden)); |
michael@0 | 3307 | |
michael@0 | 3308 | #ifdef PNG_READ_APNG_SUPPORTED |
michael@0 | 3309 | PNG_EXPORT(261, void, png_read_frame_head, (png_structp png_ptr, |
michael@0 | 3310 | png_infop info_ptr)); |
michael@0 | 3311 | #ifdef PNG_PROGRESSIVE_READ_SUPPORTED |
michael@0 | 3312 | PNG_EXPORT(262, void, png_set_progressive_frame_fn, (png_structp png_ptr, |
michael@0 | 3313 | png_progressive_frame_ptr frame_info_fn, |
michael@0 | 3314 | png_progressive_frame_ptr frame_end_fn)); |
michael@0 | 3315 | #endif /* PNG_PROGRESSIVE_READ_SUPPORTED */ |
michael@0 | 3316 | #endif /* PNG_READ_APNG_SUPPORTED */ |
michael@0 | 3317 | |
michael@0 | 3318 | #ifdef PNG_WRITE_APNG_SUPPORTED |
michael@0 | 3319 | PNG_EXPORT(263, void, png_write_frame_head, (png_structp png_ptr, |
michael@0 | 3320 | png_infop info_ptr, png_bytepp row_pointers, |
michael@0 | 3321 | png_uint_32 width, png_uint_32 height, |
michael@0 | 3322 | png_uint_32 x_offset, png_uint_32 y_offset, |
michael@0 | 3323 | png_uint_16 delay_num, png_uint_16 delay_den, png_byte dispose_op, |
michael@0 | 3324 | png_byte blend_op)); |
michael@0 | 3325 | |
michael@0 | 3326 | PNG_EXPORT(264, void, png_write_frame_tail, (png_structp png_ptr, |
michael@0 | 3327 | png_infop info_ptr)); |
michael@0 | 3328 | #endif /* PNG_WRITE_APNG_SUPPORTED */ |
michael@0 | 3329 | #endif /* PNG_APNG_SUPPORTED */ |
michael@0 | 3330 | |
michael@0 | 3331 | /* Maintainer: Put new public prototypes here ^, in libpng.3, and project |
michael@0 | 3332 | * defs, scripts/pnglibconf.h, and scripts/pnglibconf.h.prebuilt |
michael@0 | 3333 | */ |
michael@0 | 3334 | |
michael@0 | 3335 | /* The last ordinal number (this is the *last* one already used; the next |
michael@0 | 3336 | * one to use is one more than this.) Maintainer, remember to add an entry to |
michael@0 | 3337 | * scripts/symbols.def as well. |
michael@0 | 3338 | */ |
michael@0 | 3339 | #ifdef PNG_EXPORT_LAST_ORDINAL |
michael@0 | 3340 | #ifdef PNG_APNG_SUPPORTED |
michael@0 | 3341 | PNG_EXPORT_LAST_ORDINAL(264); |
michael@0 | 3342 | #else |
michael@0 | 3343 | PNG_EXPORT_LAST_ORDINAL(244); |
michael@0 | 3344 | #endif /* PNG_APNG_SUPPORTED */ |
michael@0 | 3345 | #endif |
michael@0 | 3346 | |
michael@0 | 3347 | #ifdef __cplusplus |
michael@0 | 3348 | } |
michael@0 | 3349 | #endif |
michael@0 | 3350 | |
michael@0 | 3351 | #endif /* PNG_VERSION_INFO_ONLY */ |
michael@0 | 3352 | /* Do not put anything past this line */ |
michael@0 | 3353 | #endif /* PNG_H */ |