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