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