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