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