VirtualBox

source: vbox/trunk/src/libs/libpng-1.6.45/png.h@ 107935

Last change on this file since 107935 was 107813, checked in by vboxsync, 3 weeks ago

libpng-1.6.45: Applied and adjusted our libpng changes to 1.6.45. bugref:8515

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette