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