png.h 140.1 KB
Newer Older
1

A
Andreas Dilger 已提交
2
/* png.h - header file for PNG reference library
3
 *
4
 * libpng version 1.6.30beta04, May 22, 2017
5
 *
6
 * Copyright (c) 1998-2002,2004,2006-2017 Glenn Randers-Pehrson
7 8
 * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)
 * (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.30beta04, May 22, 2017:
16
 *     Glenn Randers-Pehrson.
17
 *   See also "Contributing Authors", below.
18 19 20
 */

/*
21 22
 * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
 *
23 24
 * If you modify libpng you may insert additional notices immediately following
 * this sentence.
25
 *
26 27
 * This code is released under the libpng license.
 *
28
 * libpng versions 1.0.7, July 1, 2000 through 1.6.30beta04, May 22, 2017 are
29
 * Copyright (c) 2000-2002, 2004, 2006-2017 Glenn Randers-Pehrson, are
30 31 32
 * derived from libpng-1.0.6, and are distributed according to the same
 * disclaimer and license as libpng-1.0.6 with the following individuals
 * added to the list of Contributing Authors:
33
 *
34
 *    Simon-Pierre Cadieux
35
 *    Eric S. Raymond
36 37
 *    Mans Rullgard
 *    Cosmin Truta
38
 *    Gilles Vollant
39
 *    James Yu
40
 *    Mandar Sahastrabuddhe
41
 *    Google Inc.
42
 *    Vadim Barkov
43
 *
44 45 46 47 48 49 50 51 52
 * and with the following additions to the disclaimer:
 *
 *    There is no warranty against interference with your enjoyment of the
 *    library or against infringement.  There is no warranty that our
 *    efforts or the library will fulfill any of your particular purposes
 *    or needs.  This library is provided with all faults, and the entire
 *    risk of satisfactory quality, performance, accuracy, and effort is with
 *    the user.
 *
53 54
 * Some files in the "contrib" directory and some configure-generated
 * files that are distributed with libpng have other copyright owners and
55 56
 * are released under other open source licenses.
 *
57
 * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
58 59 60 61
 * Copyright (c) 1998-2000 Glenn Randers-Pehrson, are derived from
 * libpng-0.96, and are distributed according to the same disclaimer and
 * license as libpng-0.96, with the following individuals added to the list
 * of Contributing Authors:
62 63 64 65 66 67
 *
 *    Tom Lane
 *    Glenn Randers-Pehrson
 *    Willem van Schaik
 *
 * libpng versions 0.89, June 1996, through 0.96, May 1997, are
68 69 70 71
 * Copyright (c) 1996-1997 Andreas Dilger, are derived from libpng-0.88,
 * and are distributed according to the same disclaimer and license as
 * libpng-0.88, with the following individuals added to the list of
 * Contributing Authors:
72
 *
73 74
 *    John Bowler
 *    Kevin Bracey
75
 *    Sam Bushell
76 77
 *    Magnus Holmgren
 *    Greg Roelofs
78 79
 *    Tom Tanner
 *
80 81 82
 * Some files in the "scripts" directory have other copyright owners
 * but are released under this license.
 *
83
 * libpng versions 0.5, May 1995, through 0.88, January 1996, are
84
 * Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc.
85 86 87 88 89 90
 *
 * For the purposes of this copyright and license, "Contributing Authors"
 * is defined as the following set of individuals:
 *
 *    Andreas Dilger
 *    Dave Martindale
91 92 93 94 95
 *    Guy Eric Schalnat
 *    Paul Schmidt
 *    Tim Wegner
 *
 * The PNG Reference Library is supplied "AS IS".  The Contributing Authors
96
 * and Group 42, Inc. disclaim all warranties, expressed or implied,
97 98
 * including, without limitation, the warranties of merchantability and of
 * fitness for any purpose.  The Contributing Authors and Group 42, Inc.
99
 * assume no liability for direct, indirect, incidental, special, exemplary,
100 101 102 103 104 105
 * or consequential damages, which may result from the use of the PNG
 * Reference Library, even if advised of the possibility of such damage.
 *
 * Permission is hereby granted to use, copy, modify, and distribute this
 * source code, or portions hereof, for any purpose, without fee, subject
 * to the following restrictions:
106
 *
107
 *   1. The origin of this source code must not be misrepresented.
108
 *
109 110
 *   2. Altered versions must be plainly marked as such and must not
 *      be misrepresented as being the original source.
111
 *
112 113
 *   3. This Copyright notice may not be removed or altered from any
 *      source or altered source distribution.
114 115 116 117 118 119
 *
 * The Contributing Authors and Group 42, Inc. specifically permit, without
 * fee, and encourage the use of this source code as a component to
 * supporting the PNG file format in commercial products.  If you use this
 * source code in a product, acknowledgment is not required but would be
 * appreciated.
120 121
 *
 * END OF COPYRIGHT NOTICE, DISCLAIMER, and LICENSE.
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
 *
 * TRADEMARK:
 *
 * The name "libpng" has not been registered by the Copyright owner
 * as a trademark in any jurisdiction.  However, because libpng has
 * been distributed and maintained world-wide, continually since 1995,
 * the Copyright owner claims "common-law trademark protection" in any
 * jurisdiction where common-law trademark is recognized.
 *
 * OSI CERTIFICATION:
 *
 * Libpng is OSI Certified Open Source Software.  OSI Certified Open Source is
 * a certification mark of the Open Source Initiative. OSI has not addressed
 * the additional disclaimers inserted at version 1.0.7.
 *
 * EXPORT CONTROL:
 *
 * The Copyright owner believes that the Export Control Classification
 * Number (ECCN) for libpng is EAR99, which means not subject to export
 * controls or International Traffic in Arms Regulations (ITAR) because
 * it is open source, publicly available software, that does not contain
 * any encryption software.  See the EAR, paragraphs 734.3(b)(3) and
 * 734.7(b).
145
 */
G
Guy Schalnat 已提交
146

147
/*
148 149
 * A "png_get_copyright" function is available, for convenient use in "about"
 * boxes and the like:
150
 *
151
 *    printf("%s", png_get_copyright(NULL));
152
 *
153
 * Also, the PNG logo (in PNG format, of course) is supplied in the
154
 * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
155 156
 */

157 158 159 160 161 162 163 164
/*
 * The contributing authors would like to thank all those who helped
 * with testing, bug fixes, and patience.  This wouldn't have been
 * possible without all of you.
 *
 * Thanks to Frank J. T. Wojcik for helping with the documentation.
 */

165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
/* Note about libpng version numbers:
 *
 *    Due to various miscommunications, unforeseen code incompatibilities
 *    and occasional factors outside the authors' control, version numbering
 *    on the library has not always been consistent and straightforward.
 *    The following table summarizes matters since version 0.89c, which was
 *    the first widely used release:
 *
 *    source                 png.h  png.h  shared-lib
 *    version                string   int  version
 *    -------                ------ -----  ----------
 *    0.89c "1.0 beta 3"     0.89      89  1.0.89
 *    0.90  "1.0 beta 4"     0.90      90  0.90  [should have been 2.0.90]
 *    0.95  "1.0 beta 5"     0.95      95  0.95  [should have been 2.0.95]
 *    0.96  "1.0 beta 6"     0.96      96  0.96  [should have been 2.0.96]
 *    0.97b "1.00.97 beta 7" 1.00.97   97  1.0.1 [should have been 2.0.97]
 *    0.97c                  0.97      97  2.0.97
 *    0.98                   0.98      98  2.0.98
 *    0.99                   0.99      98  2.0.99
 *    0.99a-m                0.99      99  2.0.99
 *    1.00                   1.00     100  2.1.0 [100 should be 10000]
 *    1.0.0      (from here on, the   100  2.1.0 [100 should be 10000]
 *    1.0.1       png.h string is   10001  2.1.0
 *    1.0.1a-e    identical to the  10002  from here on, the shared library
 *    1.0.2       source version)   10002  is 2.V where V is the source code
 *    1.0.2a-b                      10003  version, except as noted.
 *    1.0.3                         10003
 *    1.0.3a-d                      10004
 *    1.0.4                         10004
 *    1.0.4a-f                      10005
 *    1.0.5 (+ 2 patches)           10005
 *    1.0.5a-d                      10006
 *    1.0.5e-r                      10100 (not source compatible)
 *    1.0.5s-v                      10006 (not binary compatible)
 *    1.0.6 (+ 3 patches)           10006 (still binary incompatible)
 *    1.0.6d-f                      10007 (still binary incompatible)
 *    1.0.6g                        10007
 *    1.0.6h                        10007  10.6h (testing xy.z so-numbering)
 *    1.0.6i                        10007  10.6i
 *    1.0.6j                        10007  2.1.0.6j (incompatible with 1.0.0)
 *    1.0.7beta11-14        DLLNUM  10007  2.1.0.7beta11-14 (binary compatible)
 *    1.0.7beta15-18           1    10007  2.1.0.7beta15-18 (binary compatible)
 *    1.0.7rc1-2               1    10007  2.1.0.7rc1-2 (binary compatible)
 *    1.0.7                    1    10007  (still compatible)
 *    ...
 *    1.0.19                  10    10019  10.so.0.19[.0]
 *    ...
212
 *    1.2.57                  13    10257  12.so.0.57[.0]
213
 *    ...
214
 *    1.5.28                  15    10527  15.so.15.28[.0]
215
 *    ...
216
 *    1.6.30                  16    10630  16.so.16.30[.0]
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
 *
 *    Henceforth the source version will match the shared-library major
 *    and minor numbers; the shared-library major version number will be
 *    used for changes in backward compatibility, as it is intended.  The
 *    PNG_LIBPNG_VER macro, which is not used within libpng but is available
 *    for applications, is an unsigned integer of the form xyyzz corresponding
 *    to the source version x.y.z (leading zeros in y and z).  Beta versions
 *    were given the previous public release number plus a letter, until
 *    version 1.0.6j; from then on they were given the upcoming public
 *    release number plus "betaNN" or "rcNN".
 *
 *    Binary incompatibility exists only when applications make direct access
 *    to the info_ptr or png_ptr members through png.h, and the compiled
 *    application is loaded with a different version of the library.
 *
 *    DLLNUM will change each time there are forward or backward changes
 *    in binary compatibility (e.g., when a new feature is added).
 *
 * See libpng.txt or libpng.3 for more information.  The PNG specification
 * is available as a W3C Recommendation and as an ISO Specification,
V
Viktor Szakats 已提交
237
 * <https://www.w3.org/TR/2003/REC-PNG-20031110/
238 239
 */

240 241 242 243
/*
 * Y2K compliance in libpng:
 * =========================
 *
244
 *    May 22, 2017
245 246 247 248 249
 *
 *    Since the PNG Development group is an ad-hoc body, we can't make
 *    an official declaration.
 *
 *    This is your unofficial assurance that libpng from version 0.71 and
250
 *    upward through 1.6.30beta04 are Y2K compliant.  It is my belief that
G
[devel]  
Glenn Randers-Pehrson 已提交
251
 *    earlier versions were also Y2K compliant.
252
 *
253
 *    Libpng only has two year fields.  One is a 2-byte unsigned integer
254 255
 *    that will hold years up to 65535.  The other, which is deprecated,
 *    holds the date in text format, and will hold years up to 9999.
256 257 258 259
 *
 *    The integer is
 *        "png_uint_16 year" in png_time_struct.
 *
260
 *    The string is
261 262
 *        "char time_buffer[29]" in png_struct.  This is no longer used
 *    in libpng-1.6.x and will be removed from libpng-1.7.0.
263 264
 *
 *    There are seven time-related functions:
265 266 267
 *        png.c: png_convert_to_rfc_1123_buffer() in png.c
 *          (formerly png_convert_to_rfc_1123() prior to libpng-1.5.x and
 *          png_convert_to_rfc_1152() in error prior to libpng-0.98)
268 269 270 271 272 273 274 275 276 277
 *        png_convert_from_struct_tm() in pngwrite.c, called in pngwrite.c
 *        png_convert_from_time_t() in pngwrite.c
 *        png_get_tIME() in pngget.c
 *        png_handle_tIME() in pngrutil.c, called in pngread.c
 *        png_set_tIME() in pngset.c
 *        png_write_tIME() in pngwutil.c, called in pngwrite.c
 *
 *    All handle dates properly in a Y2K environment.  The
 *    png_convert_from_time_t() function calls gmtime() to convert from system
 *    clock time, which returns (year - 1900), which we properly convert to
278 279
 *    the full 4-digit year.  There is a possibility that libpng applications
 *    are not passing 4-digit years into the png_convert_to_rfc_1123_buffer()
280
 *    function, or that they are incorrectly passing only a 2-digit year
281
 *    instead of "year - 1900" into the png_convert_from_struct_tm() function,
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
 *    but this is not under our control.  The libpng documentation has always
 *    stated that it works with 4-digit years, and the APIs have been
 *    documented as such.
 *
 *    The tIME chunk itself is also Y2K compliant.  It uses a 2-byte unsigned
 *    integer to hold the year, and can hold years as large as 65535.
 *
 *    zlib, upon which libpng depends, is also Y2K compliant.  It contains
 *    no date-related code.
 *
 *       Glenn Randers-Pehrson
 *       libpng maintainer
 *       PNG Development Group
 */

297 298
#ifndef PNG_H
#define PNG_H
G
Guy Schalnat 已提交
299

300
/* This is not the place to learn how to use libpng. The file libpng-manual.txt
A
Andreas Dilger 已提交
301 302
 * describes how to use libpng, and the file example.c summarizes it
 * with some code on which to build.  This file is useful for looking
303 304 305
 * at the actual function definitions and structure components.  If that
 * file has been stripped from your copy of libpng, you can find it at
 * <http://www.libpng.org/pub/png/libpng-manual.txt>
306 307 308
 *
 * If you just need to read a PNG file and don't want to read the documentation
 * skip to the end of this file and read the section entitled 'simplified API'.
A
Andreas Dilger 已提交
309
 */
G
Guy Schalnat 已提交
310

311
/* Version information for png.h - this should match the version in png.c */
312 313
#define PNG_LIBPNG_VER_STRING "1.6.30beta04"
#define PNG_HEADER_VERSION_STRING " libpng version 1.6.30beta04 - May 22, 2017\n"
314

315 316
#define PNG_LIBPNG_VER_SONUM   16
#define PNG_LIBPNG_VER_DLLNUM  16
317 318 319

/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */
#define PNG_LIBPNG_VER_MAJOR   1
320
#define PNG_LIBPNG_VER_MINOR   6
321
#define PNG_LIBPNG_VER_RELEASE 30
322

323
/* This should match the numeric part of the final component of
324 325
 * PNG_LIBPNG_VER_STRING, omitting any leading zero:
 */
326

327
#define PNG_LIBPNG_VER_BUILD  04
328

329
/* Release Status */
330 331 332 333
#define PNG_LIBPNG_BUILD_ALPHA    1
#define PNG_LIBPNG_BUILD_BETA     2
#define PNG_LIBPNG_BUILD_RC       3
#define PNG_LIBPNG_BUILD_STABLE   4
334
#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7
335

336 337 338 339 340 341 342
/* Release-Specific Flags */
#define PNG_LIBPNG_BUILD_PATCH    8 /* Can be OR'ed with
                                       PNG_LIBPNG_BUILD_STABLE only */
#define PNG_LIBPNG_BUILD_PRIVATE 16 /* Cannot be OR'ed with
                                       PNG_LIBPNG_BUILD_SPECIAL */
#define PNG_LIBPNG_BUILD_SPECIAL 32 /* Cannot be OR'ed with
                                       PNG_LIBPNG_BUILD_PRIVATE */
343

344
#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_BETA
345

346 347 348 349
/* Careful here.  At one time, Guy wanted to use 082, but that would be octal.
 * We must not include leading zeros.
 * Versions 0.7 through 1.0.0 were in the range 0 to 100 here (only
 * version 1.0.0 was mis-numbered 100 instead of 10000).  From
350 351
 * version 1.0.1 it's    xxyyzz, where x=major, y=minor, z=release
 */
352
#define PNG_LIBPNG_VER 10630 /* 1.6.30 */
353

354 355 356 357
/* Library configuration: these options cannot be changed after
 * the library has been built.
 */
#ifndef PNGLCONF_H
358 359 360
/* If pnglibconf.h is missing, you can
 * copy scripts/pnglibconf.h.prebuilt to pnglibconf.h
 */
361
#   include "pnglibconf.h"
362 363
#endif

364
#ifndef PNG_VERSION_INFO_ONLY
365
/* Machine specific configuration. */
366 367
#  include "pngconf.h"
#endif
G
Guy Schalnat 已提交
368

369
/*
370 371 372
 * Added at libpng-1.2.8
 *
 * Ref MSDN: Private as priority over Special
373 374
 * VS_FF_PRIVATEBUILD File *was not* built using standard release
 * procedures. If this value is given, the StringFileInfo block must
375
 * contain a PrivateBuild string.
376 377 378 379
 *
 * VS_FF_SPECIALBUILD File *was* built by the original company using
 * standard release procedures but is a variation of the standard
 * file of the same version number. If this value is given, the
380
 * StringFileInfo block must contain a SpecialBuild string.
381 382
 */

383
#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
384
#  define PNG_LIBPNG_BUILD_TYPE \
385
       (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
386
#else
387
#  ifdef PNG_LIBPNG_SPECIALBUILD
388
#    define PNG_LIBPNG_BUILD_TYPE \
389
         (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
390
#  else
391
#    define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
392 393 394 395 396
#  endif
#endif

#ifndef PNG_VERSION_INFO_ONLY

397 398 399 400 401
/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

A
Andreas Dilger 已提交
402 403 404
/* Version information for C files, stored in png.c.  This had better match
 * the version above.
 */
405
#define png_libpng_ver png_get_header_ver(NULL)
A
Andreas Dilger 已提交
406

407 408
/* This file is arranged in several sections:
 *
409 410
 * 1. [omitted]
 * 2. Any configuration options that can be specified by for the application
411
 *    code when it is built.  (Build time configuration is in pnglibconf.h)
412
 * 3. Type definitions (base types are defined in pngconf.h), structure
413
 *    definitions.
414 415 416
 * 4. Exported library functions.
 * 5. Simplified API.
 * 6. Implementation options.
417 418 419 420
 *
 * The library source code has additional files (principally pngpriv.h) that
 * allow configuration of the library.
 */
421 422 423 424

/* Section 1: [omitted] */

/* Section 2: run time configuration
425
 * See pnglibconf.h for build time configuration
426 427 428
 *
 * Run time configuration allows the application to choose between
 * implementations of certain arithmetic APIs.  The default is set
429
 * at build time and recorded in pnglibconf.h, but it is safe to
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
 * override these (and only these) settings.  Note that this won't
 * change what the library does, only application code, and the
 * settings can (and probably should) be made on a per-file basis
 * by setting the #defines before including png.h
 *
 * Use macros to read integers from PNG data or use the exported
 * functions?
 *   PNG_USE_READ_MACROS: use the macros (see below)  Note that
 *     the macros evaluate their argument multiple times.
 *   PNG_NO_USE_READ_MACROS: call the relevant library function.
 *
 * Use the alternative algorithm for compositing alpha samples that
 * does not use division?
 *   PNG_READ_COMPOSITE_NODIV_SUPPORTED: use the 'no division'
 *      algorithm.
 *   PNG_NO_READ_COMPOSITE_NODIV: use the 'division' algorithm.
 *
 * How to handle benign errors if PNG_ALLOW_BENIGN_ERRORS is
 * false?
 *   PNG_ALLOW_BENIGN_ERRORS: map calls to the benign error
 *      APIs to png_warning.
 * Otherwise the calls are mapped to png_error.
 */

454
/* Section 3: type definitions, including structures and compile time
455 456 457
 * constants.
 * See pngconf.h for base types that vary by machine/system
 */
458 459 460 461

/* This triggers a compiler error in png.c, if png.c and png.h
 * do not agree upon the version number.
 */
462
typedef char* png_libpng_version_1_6_30beta04;
463

464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
/* Basic control structions.  Read libpng-manual.txt or libpng.3 for more info.
 *
 * png_struct is the cache of information used while reading or writing a single
 * PNG file.  One of these is always required, although the simplified API
 * (below) hides the creation and destruction of it.
 */
typedef struct png_struct_def png_struct;
typedef const png_struct * png_const_structp;
typedef png_struct * png_structp;
typedef png_struct * * png_structpp;

/* png_info contains information read from or to be written to a PNG file.  One
 * or more of these must exist while reading or creating a PNG file.  The
 * information is not used by libpng during read but is used to control what
 * gets written when a PNG file is created.  "png_get_" function calls read
 * information during read and "png_set_" functions calls write information
 * when creating a PNG.
 * been moved into a separate header file that is not accessible to
 * applications.  Read libpng-manual.txt or libpng.3 for more info.
 */
typedef struct png_info_def png_info;
typedef png_info * png_infop;
typedef const png_info * png_const_infop;
typedef png_info * * png_infopp;

/* Types with names ending 'p' are pointer types.  The corresponding types with
 * names ending 'rp' are identical pointer types except that the pointer is
 * marked 'restrict', which means that it is the only pointer to the object
 * passed to the function.  Applications should not use the 'restrict' types;
 * it is always valid to pass 'p' to a pointer with a function argument of the
 * corresponding 'rp' type.  Different compilers have different rules with
 * regard to type matching in the presence of 'restrict'.  For backward
 * compatibility libpng callbacks never have 'restrict' in their parameters and,
 * consequentially, writing portable application code is extremely difficult if
 * an attempt is made to use 'restrict'.
 */
typedef png_struct * PNG_RESTRICT png_structrp;
typedef const png_struct * PNG_RESTRICT png_const_structrp;
typedef png_info * PNG_RESTRICT png_inforp;
typedef const png_info * PNG_RESTRICT png_const_inforp;

A
Andreas Dilger 已提交
505 506 507 508
/* Three color definitions.  The order of the red, green, and blue, (and the
 * exact size) is not important, although the size of the fields need to
 * be png_byte or png_uint_16 (as defined below).
 */
G
Guy Schalnat 已提交
509 510
typedef struct png_color_struct
{
G
Guy Schalnat 已提交
511
   png_byte red;
G
Guy Schalnat 已提交
512 513 514
   png_byte green;
   png_byte blue;
} png_color;
515 516 517
typedef png_color * png_colorp;
typedef const png_color * png_const_colorp;
typedef png_color * * png_colorpp;
G
Guy Schalnat 已提交
518 519 520

typedef struct png_color_16_struct
{
A
Andreas Dilger 已提交
521 522
   png_byte index;    /* used for palette files */
   png_uint_16 red;   /* for use in red green blue files */
G
Guy Schalnat 已提交
523 524
   png_uint_16 green;
   png_uint_16 blue;
A
Andreas Dilger 已提交
525
   png_uint_16 gray;  /* for use in grayscale files */
G
Guy Schalnat 已提交
526
} png_color_16;
527 528 529
typedef png_color_16 * png_color_16p;
typedef const png_color_16 * png_const_color_16p;
typedef png_color_16 * * png_color_16pp;
G
Guy Schalnat 已提交
530 531 532

typedef struct png_color_8_struct
{
A
Andreas Dilger 已提交
533
   png_byte red;   /* for use in red green blue files */
G
Guy Schalnat 已提交
534 535
   png_byte green;
   png_byte blue;
A
Andreas Dilger 已提交
536
   png_byte gray;  /* for use in grayscale files */
G
Guy Schalnat 已提交
537 538
   png_byte alpha; /* for alpha channel files */
} png_color_8;
539 540 541
typedef png_color_8 * png_color_8p;
typedef const png_color_8 * png_const_color_8p;
typedef png_color_8 * * png_color_8pp;
G
Guy Schalnat 已提交
542

543 544 545 546
/*
 * The following two structures are used for the in-core representation
 * of sPLT chunks.
 */
547
typedef struct png_sPLT_entry_struct
548 549 550 551 552 553
{
   png_uint_16 red;
   png_uint_16 green;
   png_uint_16 blue;
   png_uint_16 alpha;
   png_uint_16 frequency;
554
} png_sPLT_entry;
555 556 557
typedef png_sPLT_entry * png_sPLT_entryp;
typedef const png_sPLT_entry * png_const_sPLT_entryp;
typedef png_sPLT_entry * * png_sPLT_entrypp;
558

559 560 561 562 563
/*  When the depth of the sPLT palette is 8 bits, the color and alpha samples
 *  occupy the LSB of their respective members, and the MSB of each member
 *  is zero-filled.  The frequency member always occupies the full 16 bits.
 */

564
typedef struct png_sPLT_struct
565
{
566 567 568 569
   png_charp name;           /* palette name */
   png_byte depth;           /* depth of palette samples */
   png_sPLT_entryp entries;  /* palette entries */
   png_int_32 nentries;      /* number of palette entries */
570
} png_sPLT_t;
571 572 573
typedef png_sPLT_t * png_sPLT_tp;
typedef const png_sPLT_t * png_const_sPLT_tp;
typedef png_sPLT_t * * png_sPLT_tpp;
574 575

#ifdef PNG_TEXT_SUPPORTED
576
/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,
577
 * and whether that contents is compressed or not.  The "key" field
578 579
 * points to a regular zero-terminated C string.  The "text" fields can be a
 * regular C string, an empty string, or a NULL pointer.
580
 * However, the structure returned by png_get_text() will always contain
581 582 583 584 585 586 587 588
 * the "text" field as a regular zero-terminated C string (possibly
 * empty), never a NULL pointer, so it can be safely used in printf() and
 * other string-handling functions.  Note that the "itxt_length", "lang", and
 * "lang_key" members of the structure only exist when the library is built
 * with iTXt chunk support.  Prior to libpng-1.4.0 the library was built by
 * default without iTXt support. Also note that when iTXt *is* supported,
 * the "lang" and "lang_key" fields contain NULL pointers when the
 * "compression" field contains * PNG_TEXT_COMPRESSION_NONE or
589 590 591
 * PNG_TEXT_COMPRESSION_zTXt. Note that the "compression value" is not the
 * same as what appears in the PNG tEXt/zTXt/iTXt chunk's "compression flag"
 * which is always 0 or 1, or its "compression method" which is always 0.
592
 */
G
Guy Schalnat 已提交
593 594
typedef struct png_text_struct
{
595 596 597 598 599
   int  compression;       /* compression value:
                             -1: tEXt, none
                              0: zTXt, deflate
                              1: iTXt, none
                              2: iTXt, deflate  */
A
Andreas Dilger 已提交
600
   png_charp key;          /* keyword, 1-79 character description of "text" */
601 602
   png_charp text;         /* comment, may be an empty string (ie "")
                              or a NULL pointer */
603 604
   png_size_t text_length; /* length of the text string */
   png_size_t itxt_length; /* length of the itxt string */
605 606
   png_charp lang;         /* language code, 0-79 characters
                              or a NULL pointer */
607
   png_charp lang_key;     /* keyword translated UTF-8 string, 0 or more
608
                              chars or a NULL pointer */
G
Guy Schalnat 已提交
609
} png_text;
610 611 612
typedef png_text * png_textp;
typedef const png_text * png_const_textp;
typedef png_text * * png_textpp;
613
#endif
A
Andreas Dilger 已提交
614 615 616 617 618 619 620

/* Supported compression types for text in PNG files (tEXt, and zTXt).
 * The values of the PNG_TEXT_COMPRESSION_ defines should NOT be changed. */
#define PNG_TEXT_COMPRESSION_NONE_WR -3
#define PNG_TEXT_COMPRESSION_zTXt_WR -2
#define PNG_TEXT_COMPRESSION_NONE    -1
#define PNG_TEXT_COMPRESSION_zTXt     0
621 622 623
#define PNG_ITXT_COMPRESSION_NONE     1
#define PNG_ITXT_COMPRESSION_zTXt     2
#define PNG_TEXT_COMPRESSION_LAST     3  /* Not a valid value */
G
Guy Schalnat 已提交
624 625

/* png_time is a way to hold the time in an machine independent way.
626 627 628
 * Two conversions are provided, both from time_t and struct tm.  There
 * is no portable way to convert to either of these structures, as far
 * 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
 */
G
Guy Schalnat 已提交
631 632 633
typedef struct png_time_struct
{
   png_uint_16 year; /* full year, as in, 1995 */
A
Andreas Dilger 已提交
634 635 636 637 638
   png_byte month;   /* month of year, 1 - 12 */
   png_byte day;     /* day of month, 1 - 31 */
   png_byte hour;    /* hour of day, 0 - 23 */
   png_byte minute;  /* minute of hour, 0 - 59 */
   png_byte second;  /* second of minute, 0 - 60 (for leap seconds) */
G
Guy Schalnat 已提交
639
} png_time;
640 641 642
typedef png_time * png_timep;
typedef const png_time * png_const_timep;
typedef png_time * * png_timepp;
A
Andreas Dilger 已提交
643

644 645
#if defined(PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED) ||\
   defined(PNG_USER_CHUNKS_SUPPORTED)
646 647 648 649
/* png_unknown_chunk is a structure to hold queued chunks for which there is
 * no specific support.  The idea is that we can use this to queue
 * up private chunks for output even though the library doesn't actually
 * know about their semantics.
650 651
 *
 * The data in the structure is set by libpng on read and used on write.
652 653 654
 */
typedef struct png_unknown_chunk_t
{
655 656 657 658 659 660 661 662 663 664 665
   png_byte name[5]; /* Textual chunk name with '\0' terminator */
   png_byte *data;   /* Data, should not be modified on read! */
   png_size_t size;

   /* On write 'location' must be set using the flag values listed below.
    * Notice that on read it is set by libpng however the values stored have
    * more bits set than are listed below.  Always treat the value as a
    * bitmask.  On write set only one bit - setting multiple bits may cause the
    * chunk to be written in multiple places.
    */
   png_byte location; /* mode of operation at read time */
666 667
}
png_unknown_chunk;
668

669 670 671
typedef png_unknown_chunk * png_unknown_chunkp;
typedef const png_unknown_chunk * png_const_unknown_chunkp;
typedef png_unknown_chunk * * png_unknown_chunkpp;
672 673
#endif

674
/* Flag values for the unknown chunk location byte. */
675 676 677
#define PNG_HAVE_IHDR  0x01
#define PNG_HAVE_PLTE  0x02
#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 682
#define PNG_UINT_32_MAX ((png_uint_32)(-1))
#define PNG_SIZE_MAX ((png_size_t)(-1))
683

G
[devel]  
Glenn Randers-Pehrson 已提交
684 685 686 687 688
/* These are constants for fixed point values encoded in the
 * PNG specification manner (x100000)
 */
#define PNG_FP_1    100000
#define PNG_FP_HALF  50000
689 690
#define PNG_FP_MAX  ((png_fixed_point)0x7fffffffL)
#define PNG_FP_MIN  (-PNG_FP_MAX)
G
[devel]  
Glenn Randers-Pehrson 已提交
691

A
Andreas Dilger 已提交
692
/* These describe the color_type field in png_info. */
G
Guy Schalnat 已提交
693
/* color type masks */
A
Andreas Dilger 已提交
694 695 696
#define PNG_COLOR_MASK_PALETTE    1
#define PNG_COLOR_MASK_COLOR      2
#define PNG_COLOR_MASK_ALPHA      4
G
Guy Schalnat 已提交
697 698

/* color types.  Note that not all combinations are legal */
G
Guy Schalnat 已提交
699
#define PNG_COLOR_TYPE_GRAY 0
A
Andreas Dilger 已提交
700 701 702
#define PNG_COLOR_TYPE_PALETTE  (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE)
#define PNG_COLOR_TYPE_RGB        (PNG_COLOR_MASK_COLOR)
#define PNG_COLOR_TYPE_RGB_ALPHA  (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA)
G
Guy Schalnat 已提交
703
#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
704 705 706
/* aliases */
#define PNG_COLOR_TYPE_RGBA  PNG_COLOR_TYPE_RGB_ALPHA
#define PNG_COLOR_TYPE_GA  PNG_COLOR_TYPE_GRAY_ALPHA
G
Guy Schalnat 已提交
707

708
/* This is for compression type. PNG 1.0-1.2 only define the single type. */
A
Andreas Dilger 已提交
709 710 711
#define PNG_COMPRESSION_TYPE_BASE 0 /* Deflate method 8, 32K window */
#define PNG_COMPRESSION_TYPE_DEFAULT PNG_COMPRESSION_TYPE_BASE

712
/* This is for filter type. PNG 1.0-1.2 only define the single type. */
A
Andreas Dilger 已提交
713
#define PNG_FILTER_TYPE_BASE      0 /* Single row per-byte filtering */
714
#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
A
Andreas Dilger 已提交
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
#define PNG_FILTER_TYPE_DEFAULT   PNG_FILTER_TYPE_BASE

/* These are for the interlacing type.  These values should NOT be changed. */
#define PNG_INTERLACE_NONE        0 /* Non-interlaced image */
#define PNG_INTERLACE_ADAM7       1 /* Adam7 interlacing */
#define PNG_INTERLACE_LAST        2 /* Not a valid value */

/* These are for the oFFs chunk.  These values should NOT be changed. */
#define PNG_OFFSET_PIXEL          0 /* Offset in pixels */
#define PNG_OFFSET_MICROMETER     1 /* Offset in micrometers (1/10^6 meter) */
#define PNG_OFFSET_LAST           2 /* Not a valid value */

/* These are for the pCAL chunk.  These values should NOT be changed. */
#define PNG_EQUATION_LINEAR       0 /* Linear transformation */
#define PNG_EQUATION_BASE_E       1 /* Exponential base e transform */
#define PNG_EQUATION_ARBITRARY    2 /* Arbitrary base exponential transform */
#define PNG_EQUATION_HYPERBOLIC   3 /* Hyperbolic sine transformation */
#define PNG_EQUATION_LAST         4 /* Not a valid value */

734 735 736 737 738 739
/* These are for the sCAL chunk.  These values should NOT be changed. */
#define PNG_SCALE_UNKNOWN         0 /* unknown unit (image scale) */
#define PNG_SCALE_METER           1 /* meters per pixel */
#define PNG_SCALE_RADIAN          2 /* radians per pixel */
#define PNG_SCALE_LAST            3 /* Not a valid value */

A
Andreas Dilger 已提交
740 741 742 743 744
/* These are for the pHYs chunk.  These values should NOT be changed. */
#define PNG_RESOLUTION_UNKNOWN    0 /* pixels/unknown unit (aspect ratio) */
#define PNG_RESOLUTION_METER      1 /* pixels/meter */
#define PNG_RESOLUTION_LAST       2 /* Not a valid value */

745
/* These are for the sRGB chunk.  These values should NOT be changed. */
746 747 748 749
#define PNG_sRGB_INTENT_PERCEPTUAL 0
#define PNG_sRGB_INTENT_RELATIVE   1
#define PNG_sRGB_INTENT_SATURATION 2
#define PNG_sRGB_INTENT_ABSOLUTE   3
750
#define PNG_sRGB_INTENT_LAST       4 /* Not a valid value */
751

752 753
/* This is for text chunks */
#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

A
Andreas Dilger 已提交
758 759 760 761 762
/* These determine if an ancillary chunk's data has been successfully read
 * from the PNG header, or if the application has filled in the corresponding
 * data in the info_struct to be written into the output file.  The values
 * of the PNG_INFO_<chunk> defines should NOT be changed.
 */
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
#define PNG_INFO_gAMA 0x0001U
#define PNG_INFO_sBIT 0x0002U
#define PNG_INFO_cHRM 0x0004U
#define PNG_INFO_PLTE 0x0008U
#define PNG_INFO_tRNS 0x0010U
#define PNG_INFO_bKGD 0x0020U
#define PNG_INFO_hIST 0x0040U
#define PNG_INFO_pHYs 0x0080U
#define PNG_INFO_oFFs 0x0100U
#define PNG_INFO_tIME 0x0200U
#define PNG_INFO_pCAL 0x0400U
#define PNG_INFO_sRGB 0x0800U  /* GR-P, 0.96a */
#define PNG_INFO_iCCP 0x1000U  /* ESR, 1.0.6 */
#define PNG_INFO_sPLT 0x2000U  /* ESR, 1.0.6 */
#define PNG_INFO_sCAL 0x4000U  /* ESR, 1.0.6 */
#define PNG_INFO_IDAT 0x8000U  /* ESR, 1.0.6 */
G
Guy Schalnat 已提交
779

A
Andreas Dilger 已提交
780 781 782 783
/* This is used for the transformation routines, as some of them
 * change these values for the row.  It also should enable using
 * the routines for other purposes.
 */
G
Guy Schalnat 已提交
784 785
typedef struct png_row_info_struct
{
786 787 788 789 790
   png_uint_32 width;    /* width of row */
   png_size_t rowbytes;  /* number of bytes in row */
   png_byte color_type;  /* color type of row */
   png_byte bit_depth;   /* bit depth of row */
   png_byte channels;    /* number of channels (1, 2, 3, or 4) */
G
Guy Schalnat 已提交
791
   png_byte pixel_depth; /* bits per pixel (depth * channels) */
G
Guy Schalnat 已提交
792 793
} png_row_info;

794 795
typedef png_row_info * png_row_infop;
typedef png_row_info * * png_row_infopp;
G
Guy Schalnat 已提交
796

797 798 799 800
/* These are the function types for the I/O functions and for the functions
 * that allow the user to override the default I/O functions with his or her
 * own.  The png_error_ptr type should match that of user-supplied warning
 * and error functions, while the png_rw_ptr type should match that of the
801
 * user read/write data functions.  Note that the 'write' function must not
802
 * modify the buffer it is passed. The 'read' function, on the other hand, is
803
 * expected to return the read data in the buffer.
G
Guy Schalnat 已提交
804
 */
805 806 807 808 809 810 811
typedef PNG_CALLBACK(void, *png_error_ptr, (png_structp, png_const_charp));
typedef PNG_CALLBACK(void, *png_rw_ptr, (png_structp, png_bytep, png_size_t));
typedef PNG_CALLBACK(void, *png_flush_ptr, (png_structp));
typedef PNG_CALLBACK(void, *png_read_status_ptr, (png_structp, png_uint_32,
    int));
typedef PNG_CALLBACK(void, *png_write_status_ptr, (png_structp, png_uint_32,
    int));
812

G
Guy Schalnat 已提交
813
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
814 815
typedef PNG_CALLBACK(void, *png_progressive_info_ptr, (png_structp, png_infop));
typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop));
816 817 818 819 820 821 822 823 824 825 826

/* The following callback receives png_uint_32 row_number, int pass for the
 * png_bytep data of the row.  When transforming an interlaced image the
 * row number is the row number within the sub-image of the interlace pass, so
 * the value will increase to the height of the sub-image (not the full image)
 * then reset to 0 for the next pass.
 *
 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
 * find the output pixel (x,y) given an interlaced sub-image pixel
 * (row,col,pass).  (See below for these macros.)
 */
827
typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,
828
    png_uint_32, int));
829
#endif
G
Guy Schalnat 已提交
830

831
#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
832
    defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
833
typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
834
    png_bytep));
835
#endif
836

837
#ifdef PNG_USER_CHUNKS_SUPPORTED
838
typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
839
    png_unknown_chunkp));
840
#endif
841
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
842 843
/* not used anywhere */
/* typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp)); */
844
#endif
845

846
#ifdef PNG_SETJMP_SUPPORTED
847 848 849 850 851 852 853
/* This must match the function definition in <setjmp.h>, and the application
 * must include this before png.h to obtain the definition of jmp_buf.  The
 * function is required to be PNG_NORETURN, but this is not checked.  If the
 * function does return the application will crash via an abort() or similar
 * system level call.
 *
 * If you get a warning here while building the library you may need to make
G
[devel]  
Glenn Randers-Pehrson 已提交
854 855 856
 * changes to ensure that pnglibconf.h records the calling convention used by
 * your compiler.  This may be very difficult - try using a different compiler
 * to build the library!
857
 */
858
PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)), typedef);
859
#endif
860 861

/* Transform masks for the high-level interface */
862 863
#define PNG_TRANSFORM_IDENTITY       0x0000    /* read and write */
#define PNG_TRANSFORM_STRIP_16       0x0001    /* read only */
864 865
#define PNG_TRANSFORM_STRIP_ALPHA    0x0002    /* read only */
#define PNG_TRANSFORM_PACKING        0x0004    /* read and write */
866 867
#define PNG_TRANSFORM_PACKSWAP       0x0008    /* read and write */
#define PNG_TRANSFORM_EXPAND         0x0010    /* read only */
868
#define PNG_TRANSFORM_INVERT_MONO    0x0020    /* read and write */
869 870 871
#define PNG_TRANSFORM_SHIFT          0x0040    /* read and write */
#define PNG_TRANSFORM_BGR            0x0080    /* read and write */
#define PNG_TRANSFORM_SWAP_ALPHA     0x0100    /* read and write */
872
#define PNG_TRANSFORM_SWAP_ENDIAN    0x0200    /* read and write */
873
#define PNG_TRANSFORM_INVERT_ALPHA   0x0400    /* read and write */
874
#define PNG_TRANSFORM_STRIP_FILLER   0x0800    /* write only */
875
/* Added to libpng-1.2.34 */
876
#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
877 878 879
#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
/* Added to libpng-1.4.0 */
#define PNG_TRANSFORM_GRAY_TO_RGB   0x2000      /* read only */
880
/* Added to libpng-1.5.4 */
881
#define PNG_TRANSFORM_EXPAND_16     0x4000      /* read only */
882
#if INT_MAX >= 0x8000 /* else this might break */
883
#define PNG_TRANSFORM_SCALE_16      0x8000      /* read only */
884
#endif
885

886
/* Flags for MNG supported features */
887 888
#define PNG_FLAG_MNG_EMPTY_PLTE     0x01
#define PNG_FLAG_MNG_FILTER_64      0x04
889
#define PNG_ALL_MNG_FEATURES        0x05
890

891
/* NOTE: prior to 1.5 these functions had no 'API' style declaration,
892 893 894 895 896
 * this allowed the zlib default functions to be used on Windows
 * platforms.  In 1.5 the zlib default malloc (which just calls malloc and
 * ignores the first argument) should be completely compatible with the
 * following.
 */
897
typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,
898 899
    png_alloc_size_t));
typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp));
900

901
/* Section 4: exported functions
902
 * Here are the function definitions most commonly used.  This is not
903
 * the place to find out how to use libpng.  See libpng-manual.txt for the
A
Andreas Dilger 已提交
904
 * full explanation, see example.c for the summary.  This just provides
905
 * a simple one line description of the use of each function.
G
[devel]  
Glenn Randers-Pehrson 已提交
906
 *
907 908
 * The PNG_EXPORT() and PNG_EXPORTA() macros used below are defined in
 * pngconf.h and in the *.dfn files in the scripts directory.
G
[devel]  
Glenn Randers-Pehrson 已提交
909
 *
910
 *   PNG_EXPORT(ordinal, type, name, (args));
911 912 913 914 915
 *
 *       ordinal:    ordinal that is used while building
 *                   *.def files. The ordinal value is only
 *                   relevant when preprocessing png.h with
 *                   the *.dfn files for building symbol table
916
 *                   entries, and are removed by pngconf.h.
917 918 919 920
 *       type:       return type of the function
 *       name:       function name
 *       args:       function arguments, with types
 *
921 922 923
 * When we wish to append attributes to a function prototype we use
 * the PNG_EXPORTA() macro instead.
 *
924 925
 *   PNG_EXPORTA(ordinal, type, name, (args), attributes);
 *
926
 *       ordinal, type, name, and args: same as in PNG_EXPORT().
927
 *       attributes: function attributes
A
Andreas Dilger 已提交
928
 */
G
Guy Schalnat 已提交
929

930
/* Returns the version number of the library */
931
PNG_EXPORT(1, png_uint_32, png_access_version_number, (void));
932

A
Andreas Dilger 已提交
933
/* Tell lib we have already handled the first <num_bytes> magic bytes.
A
Andreas Dilger 已提交
934 935
 * Handling more than 8 bytes from the beginning of the file is an error.
 */
936
PNG_EXPORT(2, void, png_set_sig_bytes, (png_structrp png_ptr, int num_bytes));
A
Andreas Dilger 已提交
937 938 939 940 941 942

/* Check sig[start] through sig[start + num_to_check - 1] to see if it's a
 * PNG file.  Returns zero if the supplied bytes match the 8-byte PNG
 * signature, and non-zero otherwise.  Having num_to_check == 0 or
 * start > 7 will always fail (ie return non-zero).
 */
943
PNG_EXPORT(3, int, png_sig_cmp, (png_const_bytep sig, png_size_t start,
944
    png_size_t num_to_check));
A
Andreas Dilger 已提交
945

946 947 948
/* Simple signature checking function.  This is the same as calling
 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
 */
949
#define png_check_sig(sig, n) !png_sig_cmp((sig), 0, (n))
950

A
Andreas Dilger 已提交
951
/* Allocate and initialize png_ptr struct for reading, and any other memory. */
952 953
PNG_EXPORTA(4, png_structp, png_create_read_struct,
    (png_const_charp user_png_ver, png_voidp error_ptr,
954
    png_error_ptr error_fn, png_error_ptr warn_fn),
955
    PNG_ALLOCATED);
A
Andreas Dilger 已提交
956

957
/* Allocate and initialize png_ptr struct for writing, and any other memory */
958 959
PNG_EXPORTA(5, png_structp, png_create_write_struct,
    (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
960
    png_error_ptr warn_fn),
961
    PNG_ALLOCATED);
G
Guy Schalnat 已提交
962

963
PNG_EXPORT(6, png_size_t, png_get_compression_buffer_size,
964
    (png_const_structrp png_ptr));
965

966
PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structrp png_ptr,
967
    png_size_t size));
968

969 970 971 972 973 974 975 976 977 978 979
/* Moved from pngconf.h in 1.4.0 and modified to ensure setjmp/longjmp
 * match up.
 */
#ifdef PNG_SETJMP_SUPPORTED
/* This function returns the jmp_buf built in to *png_ptr.  It must be
 * supplied with an appropriate 'longjmp' function to use on that jmp_buf
 * unless the default error function is overridden in which case NULL is
 * acceptable.  The size of the jmp_buf is checked against the actual size
 * allocated by the library - the call will return NULL on a mismatch
 * indicating an ABI mismatch.
 */
980
PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structrp png_ptr,
981
    png_longjmp_ptr longjmp_fn, size_t jmp_buf_size));
982
#  define png_jmpbuf(png_ptr) \
983
      (*png_set_longjmp_fn((png_ptr), longjmp, (sizeof (jmp_buf))))
984 985
#else
#  define png_jmpbuf(png_ptr) \
986
      (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
987
#endif
988 989 990 991 992
/* This function should be used by libpng applications in place of
 * longjmp(png_ptr->jmpbuf, val).  If longjmp_fn() has been set, it
 * will use it; otherwise it will call PNG_ABORT().  This function was
 * added in libpng-1.5.0.
 */
993
PNG_EXPORTA(9, void, png_longjmp, (png_const_structrp png_ptr, int val),
994
    PNG_NORETURN);
995

996
#ifdef PNG_READ_SUPPORTED
997
/* Reset the compression stream */
998
PNG_EXPORTA(10, int, png_reset_zstream, (png_structrp png_ptr), PNG_DEPRECATED);
999
#endif
1000

1001
/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
1002
#ifdef PNG_USER_MEM_SUPPORTED
1003 1004
PNG_EXPORTA(11, png_structp, png_create_read_struct_2,
    (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
1005 1006
    png_error_ptr warn_fn,
    png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
1007 1008 1009
    PNG_ALLOCATED);
PNG_EXPORTA(12, png_structp, png_create_write_struct_2,
    (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
1010 1011
    png_error_ptr warn_fn,
    png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
1012
    PNG_ALLOCATED);
1013 1014
#endif

1015
/* Write the PNG file signature. */
1016
PNG_EXPORT(13, void, png_write_sig, (png_structrp png_ptr));
1017

1018
/* Write a PNG chunk - size, type, (optional) data, CRC. */
1019
PNG_EXPORT(14, void, png_write_chunk, (png_structrp png_ptr, png_const_bytep
1020
    chunk_name, png_const_bytep data, png_size_t length));
1021 1022

/* Write the start of a PNG chunk - length and chunk name. */
1023
PNG_EXPORT(15, void, png_write_chunk_start, (png_structrp png_ptr,
1024
    png_const_bytep chunk_name, png_uint_32 length));
1025 1026

/* Write the data of a PNG chunk started with png_write_chunk_start(). */
1027
PNG_EXPORT(16, void, png_write_chunk_data, (png_structrp png_ptr,
1028
    png_const_bytep data, png_size_t length));
1029 1030

/* Finish a chunk started with png_write_chunk_start() (includes CRC). */
1031
PNG_EXPORT(17, void, png_write_chunk_end, (png_structrp png_ptr));
1032

A
Andreas Dilger 已提交
1033
/* Allocate and initialize the info structure */
1034
PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_const_structrp png_ptr),
1035
    PNG_ALLOCATED);
G
Guy Schalnat 已提交
1036

1037 1038 1039 1040
/* DEPRECATED: this function allowed init structures to be created using the
 * default allocation method (typically malloc).  Use is deprecated in 1.6.0 and
 * the API will be removed in the future.
 */
1041 1042
PNG_EXPORTA(19, void, png_info_init_3, (png_infopp info_ptr,
    png_size_t png_info_struct_size), PNG_DEPRECATED);
G
Guy Schalnat 已提交
1043

A
Andreas Dilger 已提交
1044
/* Writes all the PNG information before the image. */
1045
PNG_EXPORT(20, void, png_write_info_before_PLTE,
1046
    (png_structrp png_ptr, png_const_inforp info_ptr));
1047
PNG_EXPORT(21, void, png_write_info,
1048
    (png_structrp png_ptr, png_const_inforp info_ptr));
G
Guy Schalnat 已提交
1049

1050
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1051
/* Read the information before the actual image data. */
1052
PNG_EXPORT(22, void, png_read_info,
1053
    (png_structrp png_ptr, png_inforp info_ptr));
1054
#endif
G
Guy Schalnat 已提交
1055

1056
#ifdef PNG_TIME_RFC1123_SUPPORTED
1057 1058 1059 1060 1061
   /* Convert to a US string format: there is no localization support in this
    * routine.  The original implementation used a 29 character buffer in
    * png_struct, this will be removed in future versions.
    */
#if PNG_LIBPNG_VER < 10700
1062
/* To do: remove this from libpng17 (and from libpng17/png.c and pngstruct.h) */
1063
PNG_EXPORTA(23, png_const_charp, png_convert_to_rfc1123, (png_structrp png_ptr,
1064 1065 1066
    png_const_timep ptime),PNG_DEPRECATED);
#endif
PNG_EXPORT(241, int, png_convert_to_rfc1123_buffer, (char out[29],
1067
    png_const_timep ptime));
1068
#endif
1069

1070
#ifdef PNG_CONVERT_tIME_SUPPORTED
1071
/* Convert from a struct tm to png_time */
1072
PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime,
1073
    const struct tm * ttime));
G
Guy Schalnat 已提交
1074

1075
/* Convert from time_t to png_time.  Uses gmtime() */
1076
PNG_EXPORT(25, void, png_convert_from_time_t, (png_timep ptime, time_t ttime));
1077
#endif /* CONVERT_tIME */
G
Guy Schalnat 已提交
1078

1079
#ifdef PNG_READ_EXPAND_SUPPORTED
1080
/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
1081 1082 1083 1084
PNG_EXPORT(26, void, png_set_expand, (png_structrp png_ptr));
PNG_EXPORT(27, void, png_set_expand_gray_1_2_4_to_8, (png_structrp png_ptr));
PNG_EXPORT(28, void, png_set_palette_to_rgb, (png_structrp png_ptr));
PNG_EXPORT(29, void, png_set_tRNS_to_alpha, (png_structrp png_ptr));
1085
#endif
G
Guy Schalnat 已提交
1086

1087
#ifdef PNG_READ_EXPAND_16_SUPPORTED
1088
/* Expand to 16-bit channels, forces conversion of palette to RGB and expansion
1089 1090
 * of a tRNS chunk if present.
 */
1091
PNG_EXPORT(221, void, png_set_expand_16, (png_structrp png_ptr));
1092 1093
#endif

G
Guy Schalnat 已提交
1094
#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
G
Guy Schalnat 已提交
1095
/* Use blue, green, red order for pixels. */
1096
PNG_EXPORT(30, void, png_set_bgr, (png_structrp png_ptr));
1097
#endif
G
Guy Schalnat 已提交
1098

1099
#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
1100
/* Expand the grayscale to 24-bit RGB if necessary. */
1101
PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structrp png_ptr));
1102
#endif
G
Guy Schalnat 已提交
1103

1104
#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
1105
/* Reduce RGB to grayscale. */
1106 1107 1108 1109 1110
#define PNG_ERROR_ACTION_NONE  1
#define PNG_ERROR_ACTION_WARN  2
#define PNG_ERROR_ACTION_ERROR 3
#define PNG_RGB_TO_GRAY_DEFAULT (-1)/*for red/green coefficients*/

1111
PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structrp png_ptr,
1112
    int error_action, double red, double green))
1113
PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structrp png_ptr,
1114
    int error_action, png_fixed_point red, png_fixed_point green))
1115

1116
PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structrp
1117
    png_ptr));
1118
#endif
A
Andreas Dilger 已提交
1119

1120
#ifdef PNG_BUILD_GRAYSCALE_PALETTE_SUPPORTED
1121
PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth,
1122
    png_colorp palette));
1123
#endif
A
Andreas Dilger 已提交
1124

1125
#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
1126 1127 1128
/* How the alpha channel is interpreted - this affects how the color channels
 * of a PNG file are returned to the calling application when an alpha channel,
 * or a tRNS chunk in a palette file, is present.
1129
 *
1130 1131 1132 1133 1134
 * This has no effect on the way pixels are written into a PNG output
 * datastream. The color samples in a PNG datastream are never premultiplied
 * with the alpha samples.
 *
 * The default is to return data according to the PNG specification: the alpha
1135
 * channel is a linear measure of the contribution of the pixel to the
1136 1137 1138
 * corresponding composited pixel, and the color channels are unassociated
 * (not premultiplied).  The gamma encoded color channels must be scaled
 * according to the contribution and to do this it is necessary to undo
1139 1140
 * the encoding, scale the color values, perform the composition and reencode
 * the values.  This is the 'PNG' mode.
1141 1142
 *
 * The alternative is to 'associate' the alpha with the color information by
1143 1144 1145 1146 1147 1148
 * storing color channel values that have been scaled by the alpha.
 * image.  These are the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' modes
 * (the latter being the two common names for associated alpha color channels).
 *
 * For the 'OPTIMIZED' mode, a pixel is treated as opaque only if the alpha
 * value is equal to the maximum value.
1149 1150 1151 1152 1153 1154 1155 1156 1157
 *
 * The final choice is to gamma encode the alpha channel as well.  This is
 * broken because, in practice, no implementation that uses this choice
 * correctly undoes the encoding before handling alpha composition.  Use this
 * choice only if other serious errors in the software or hardware you use
 * mandate it; the typical serious error is for dark halos to appear around
 * opaque areas of the composited PNG image because of arithmetic overflow.
 *
 * The API function png_set_alpha_mode specifies which of these choices to use
1158
 * with an enumerated 'mode' value and the gamma of the required output:
1159 1160 1161 1162 1163 1164 1165 1166
 */
#define PNG_ALPHA_PNG           0 /* according to the PNG standard */
#define PNG_ALPHA_STANDARD      1 /* according to Porter/Duff */
#define PNG_ALPHA_ASSOCIATED    1 /* as above; this is the normal practice */
#define PNG_ALPHA_PREMULTIPLIED 1 /* as above */
#define PNG_ALPHA_OPTIMIZED     2 /* 'PNG' for opaque pixels, else 'STANDARD' */
#define PNG_ALPHA_BROKEN        3 /* the alpha channel is gamma encoded */

1167
PNG_FP_EXPORT(227, void, png_set_alpha_mode, (png_structrp png_ptr, int mode,
1168
    double output_gamma))
1169
PNG_FIXED_EXPORT(228, void, png_set_alpha_mode_fixed, (png_structrp png_ptr,
1170
    int mode, png_fixed_point output_gamma))
1171
#endif
1172

1173
#if defined(PNG_GAMMA_SUPPORTED) || defined(PNG_READ_ALPHA_MODE_SUPPORTED)
1174
/* The output_gamma value is a screen gamma in libpng terminology: it expresses
1175
 * how to decode the output values, not how they are encoded.
1176
 */
1177 1178
#define PNG_DEFAULT_sRGB -1       /* sRGB gamma and color space */
#define PNG_GAMMA_MAC_18 -2       /* Old Mac '1.8' gamma and color space */
1179
#define PNG_GAMMA_sRGB   220000   /* Television standards--matches sRGB gamma */
1180
#define PNG_GAMMA_LINEAR PNG_FP_1 /* Linear */
1181
#endif
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197

/* The following are examples of calls to png_set_alpha_mode to achieve the
 * required overall gamma correction and, where necessary, alpha
 * premultiplication.
 *
 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
 *    This is the default libpng handling of the alpha channel - it is not
 *    pre-multiplied into the color components.  In addition the call states
 *    that the output is for a sRGB system and causes all PNG files without gAMA
 *    chunks to be assumed to be encoded using sRGB.
 *
 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
 *    In this case the output is assumed to be something like an sRGB conformant
 *    display preceeded by a power-law lookup table of power 1.45.  This is how
 *    early Mac systems behaved.
 *
1198
 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
 *    This is the classic Jim Blinn approach and will work in academic
 *    environments where everything is done by the book.  It has the shortcoming
 *    of assuming that input PNG data with no gamma information is linear - this
 *    is unlikely to be correct unless the PNG files where generated locally.
 *    Most of the time the output precision will be so low as to show
 *    significant banding in dark areas of the image.
 *
 * png_set_expand_16(pp);
 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB);
 *    This is a somewhat more realistic Jim Blinn inspired approach.  PNG files
 *    are assumed to have the sRGB encoding if not marked with a gamma value and
 *    the output is always 16 bits per component.  This permits accurate scaling
 *    and processing of the data.  If you know that your input PNG files were
 *    generated locally you might need to replace PNG_DEFAULT_sRGB with the
 *    correct value for your system.
 *
 * png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB);
 *    If you just need to composite the PNG image onto an existing background
 *    and if you control the code that does this you can use the optimization
 *    setting.  In this case you just copy completely opaque pixels to the
 *    output.  For pixels that are not completely transparent (you just skip
 *    those) you do the composition math using png_composite or png_composite_16
1221
 *    below then encode the resultant 8-bit or 16-bit values to match the output
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
 *    encoding.
 *
 * Other cases
 *    If neither the PNG nor the standard linear encoding work for you because
 *    of the software or hardware you use then you have a big problem.  The PNG
 *    case will probably result in halos around the image.  The linear encoding
 *    will probably result in a washed out, too bright, image (it's actually too
 *    contrasty.)  Try the ALPHA_OPTIMIZED mode above - this will probably
 *    substantially reduce the halos.  Alternatively try:
 *
 * png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB);
 *    This option will also reduce the halos, but there will be slight dark
 *    halos round the opaque parts of the image where the background is light.
 *    In the OPTIMIZED mode the halos will be light halos where the background
 *    is dark.  Take your pick - the halos are unavoidable unless you can get
 *    your hardware/software fixed!  (The OPTIMIZED approach is slightly
 *    faster.)
 *
 * When the default gamma of PNG files doesn't match the output gamma.
 *    If you have PNG files with no gamma information png_set_alpha_mode allows
 *    you to provide a default gamma, but it also sets the ouput gamma to the
 *    matching value.  If you know your PNG files have a gamma that doesn't
 *    match the output you can take advantage of the fact that
 *    png_set_alpha_mode always sets the output gamma but only sets the PNG
 *    default if it is not already set:
 *
 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
 *    The first call sets both the default and the output gamma values, the
 *    second call overrides the output gamma without changing the default.  This
 *    is easier than achieving the same effect with png_set_gamma.  You must use
 *    PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will
 *    fire if more than one call to png_set_alpha_mode and png_set_background is
 *    made in the same read operation, however multiple calls with PNG_ALPHA_PNG
 *    are ignored.
 */

1259
#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
1260
PNG_EXPORT(36, void, png_set_strip_alpha, (png_structrp png_ptr));
1261
#endif
G
Guy Schalnat 已提交
1262

A
Andreas Dilger 已提交
1263 1264
#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
1265
PNG_EXPORT(37, void, png_set_swap_alpha, (png_structrp png_ptr));
1266
#endif
G
Guy Schalnat 已提交
1267

1268 1269
#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
1270
PNG_EXPORT(38, void, png_set_invert_alpha, (png_structrp png_ptr));
1271
#endif
1272

A
Andreas Dilger 已提交
1273
#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
1274
/* Add a filler byte to 8-bit or 16-bit Gray or 24-bit or 48-bit RGB images. */
1275
PNG_EXPORT(39, void, png_set_filler, (png_structrp png_ptr, png_uint_32 filler,
1276
    int flags));
A
Andreas Dilger 已提交
1277
/* The values of the PNG_FILLER_ defines should NOT be changed */
1278 1279
#  define PNG_FILLER_BEFORE 0
#  define PNG_FILLER_AFTER 1
1280
/* Add an alpha byte to 8-bit or 16-bit Gray or 24-bit or 48-bit RGB images. */
1281
PNG_EXPORT(40, void, png_set_add_alpha, (png_structrp png_ptr,
1282
    png_uint_32 filler, int flags));
1283
#endif /* READ_FILLER || WRITE_FILLER */
G
Guy Schalnat 已提交
1284

G
Guy Schalnat 已提交
1285
#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
1286
/* Swap bytes in 16-bit depth files. */
1287
PNG_EXPORT(41, void, png_set_swap, (png_structrp png_ptr));
1288
#endif
G
Guy Schalnat 已提交
1289

G
Guy Schalnat 已提交
1290
#if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED)
1291
/* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */
1292
PNG_EXPORT(42, void, png_set_packing, (png_structrp png_ptr));
1293
#endif
A
Andreas Dilger 已提交
1294

1295 1296
#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
    defined(PNG_WRITE_PACKSWAP_SUPPORTED)
A
Andreas Dilger 已提交
1297
/* Swap packing order of pixels in bytes. */
1298
PNG_EXPORT(43, void, png_set_packswap, (png_structrp png_ptr));
1299
#endif
G
Guy Schalnat 已提交
1300

G
Guy Schalnat 已提交
1301
#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
G
Guy Schalnat 已提交
1302
/* Converts files to legal bit depths. */
1303
PNG_EXPORT(44, void, png_set_shift, (png_structrp png_ptr, png_const_color_8p
1304
    true_bits));
1305
#endif
G
Guy Schalnat 已提交
1306

G
Guy Schalnat 已提交
1307 1308
#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
    defined(PNG_WRITE_INTERLACING_SUPPORTED)
G
[devel]  
Glenn Randers-Pehrson 已提交
1309
/* Have the code handle the interlacing.  Returns the number of passes.
1310 1311 1312 1313 1314
 * MUST be called before png_read_update_info or png_start_read_image,
 * otherwise it will not have the desired effect.  Note that it is still
 * necessary to call png_read_row or png_read_rows png_get_image_height
 * times for each pass.
*/
1315
PNG_EXPORT(45, int, png_set_interlace_handling, (png_structrp png_ptr));
1316
#endif
G
Guy Schalnat 已提交
1317

G
Guy Schalnat 已提交
1318
#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
1319
/* Invert monochrome files */
1320
PNG_EXPORT(46, void, png_set_invert_mono, (png_structrp png_ptr));
1321
#endif
G
Guy Schalnat 已提交
1322

1323
#ifdef PNG_READ_BACKGROUND_SUPPORTED
1324
/* Handle alpha and tRNS by replacing with a background color.  Prior to
1325
 * libpng-1.5.4 this API must not be called before the PNG file header has been
1326
 * read.  Doing so will result in unexpected behavior and possible warnings or
1327
 * errors if the PNG file contains a bKGD chunk.
1328
 */
1329
PNG_FP_EXPORT(47, void, png_set_background, (png_structrp png_ptr,
1330
    png_const_color_16p background_color, int background_gamma_code,
1331
    int need_expand, double background_gamma))
1332
PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structrp png_ptr,
1333
    png_const_color_16p background_color, int background_gamma_code,
1334
    int need_expand, png_fixed_point background_gamma))
G
[devel]  
Glenn Randers-Pehrson 已提交
1335 1336
#endif
#ifdef PNG_READ_BACKGROUND_SUPPORTED
1337 1338 1339 1340
#  define PNG_BACKGROUND_GAMMA_UNKNOWN 0
#  define PNG_BACKGROUND_GAMMA_SCREEN  1
#  define PNG_BACKGROUND_GAMMA_FILE    2
#  define PNG_BACKGROUND_GAMMA_UNIQUE  3
1341
#endif
G
Guy Schalnat 已提交
1342

1343
#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
1344
/* Scale a 16-bit depth file down to 8-bit, accurately. */
1345
PNG_EXPORT(229, void, png_set_scale_16, (png_structrp png_ptr));
1346
#endif
1347

1348
#ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED
1349
#define PNG_READ_16_TO_8_SUPPORTED /* Name prior to 1.5.4 */
1350
/* Strip the second byte of information from a 16-bit depth file. */
1351
PNG_EXPORT(48, void, png_set_strip_16, (png_structrp png_ptr));
1352
#endif
G
Guy Schalnat 已提交
1353

1354 1355
#ifdef PNG_READ_QUANTIZE_SUPPORTED
/* Turn on quantizing, and reduce the palette to the number of colors
1356 1357
 * available.
 */
1358 1359 1360
PNG_EXPORT(49, void, png_set_quantize, (png_structrp png_ptr,
    png_colorp palette, int num_palette, int maximum_colors,
    png_const_uint_16p histogram, int full_quantize));
1361
#endif
G
Guy Schalnat 已提交
1362

1363
#ifdef PNG_READ_GAMMA_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1364 1365 1366 1367 1368
/* The threshold on gamma processing is configurable but hard-wired into the
 * library.  The following is the floating point variant.
 */
#define PNG_GAMMA_THRESHOLD (PNG_GAMMA_THRESHOLD_FIXED*.00001)

1369
/* Handle gamma correction. Screen_gamma=(display_exponent).
1370
 * NOTE: this API simply sets the screen and file gamma values. It will
1371
 * therefore override the value for gamma in a PNG file if it is called after
1372 1373 1374 1375 1376 1377 1378
 * the file header has been read - use with care  - call before reading the PNG
 * file for best results!
 *
 * These routines accept the same gamma values as png_set_alpha_mode (described
 * above).  The PNG_GAMMA_ defines and PNG_DEFAULT_sRGB can be passed to either
 * API (floating point or fixed.)  Notice, however, that the 'file_gamma' value
 * is the inverse of a 'screen gamma' value.
1379
 */
1380
PNG_FP_EXPORT(50, void, png_set_gamma, (png_structrp png_ptr,
1381
    double screen_gamma, double override_file_gamma))
1382
PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structrp png_ptr,
1383
    png_fixed_point screen_gamma, png_fixed_point override_file_gamma))
1384
#endif
G
Guy Schalnat 已提交
1385

1386
#ifdef PNG_WRITE_FLUSH_SUPPORTED
G
Guy Schalnat 已提交
1387
/* Set how many lines between output flushes - 0 for no flushing */
1388
PNG_EXPORT(51, void, png_set_flush, (png_structrp png_ptr, int nrows));
G
Guy Schalnat 已提交
1389
/* Flush the current PNG output buffer */
1390
PNG_EXPORT(52, void, png_write_flush, (png_structrp png_ptr));
1391
#endif
G
Guy Schalnat 已提交
1392

1393
/* Optional update palette with requested transformations */
1394
PNG_EXPORT(53, void, png_start_read_image, (png_structrp png_ptr));
G
Guy Schalnat 已提交
1395

1396
/* Optional call to update the users info structure */
1397 1398
PNG_EXPORT(54, void, png_read_update_info, (png_structrp png_ptr,
    png_inforp info_ptr));
G
Guy Schalnat 已提交
1399

1400
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1401
/* Read one or more rows of image data. */
1402
PNG_EXPORT(55, void, png_read_rows, (png_structrp png_ptr, png_bytepp row,
1403
    png_bytepp display_row, png_uint_32 num_rows));
1404
#endif
G
Guy Schalnat 已提交
1405

1406
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1407
/* Read a row of data. */
1408
PNG_EXPORT(56, void, png_read_row, (png_structrp png_ptr, png_bytep row,
1409
    png_bytep display_row));
1410
#endif
G
Guy Schalnat 已提交
1411

1412
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1413
/* Read the whole image into memory at once. */
1414
PNG_EXPORT(57, void, png_read_image, (png_structrp png_ptr, png_bytepp image));
1415
#endif
G
Guy Schalnat 已提交
1416

1417
/* Write a row of image data */
1418 1419
PNG_EXPORT(58, void, png_write_row, (png_structrp png_ptr,
    png_const_bytep row));
G
Guy Schalnat 已提交
1420

1421 1422 1423
/* Write a few rows of image data: (*row) is not written; however, the type
 * is declared as writeable to maintain compatibility with previous versions
 * of libpng and to allow the 'display_row' array from read_rows to be passed
1424 1425
 * unchanged to write_rows.
 */
1426
PNG_EXPORT(59, void, png_write_rows, (png_structrp png_ptr, png_bytepp row,
1427
    png_uint_32 num_rows));
G
Guy Schalnat 已提交
1428

1429
/* Write the image data */
1430
PNG_EXPORT(60, void, png_write_image, (png_structrp png_ptr, png_bytepp image));
G
Guy Schalnat 已提交
1431

1432
/* Write the end of the PNG file. */
1433 1434
PNG_EXPORT(61, void, png_write_end, (png_structrp png_ptr,
    png_inforp info_ptr));
G
Guy Schalnat 已提交
1435

1436
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1437
/* Read the end of the PNG file. */
1438
PNG_EXPORT(62, void, png_read_end, (png_structrp png_ptr, png_inforp info_ptr));
1439
#endif
G
Guy Schalnat 已提交
1440

1441
/* Free any memory associated with the png_info_struct */
1442
PNG_EXPORT(63, void, png_destroy_info_struct, (png_const_structrp png_ptr,
1443
    png_infopp info_ptr_ptr));
G
Guy Schalnat 已提交
1444

1445
/* Free any memory associated with the png_struct and the png_info_structs */
1446
PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr,
1447
    png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr));
G
Guy Schalnat 已提交
1448

1449
/* Free any memory associated with the png_struct and the png_info_structs */
1450
PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr,
1451
    png_infopp info_ptr_ptr));
G
Guy Schalnat 已提交
1452

1453
/* Set the libpng method of handling chunk CRC errors */
1454
PNG_EXPORT(66, void, png_set_crc_action, (png_structrp png_ptr, int crit_action,
1455
    int ancil_action));
A
Andreas Dilger 已提交
1456

1457
/* Values for png_set_crc_action() say how to handle CRC errors in
A
Andreas Dilger 已提交
1458 1459
 * ancillary and critical chunks, and whether to use the data contained
 * therein.  Note that it is impossible to "discard" data in a critical
1460
 * chunk.  For versions prior to 0.90, the action was always error/quit,
A
Andreas Dilger 已提交
1461 1462 1463 1464
 * whereas in version 0.90 and later, the action for CRC errors in ancillary
 * chunks is warn/discard.  These values should NOT be changed.
 *
 *      value                       action:critical     action:ancillary
A
Andreas Dilger 已提交
1465 1466 1467 1468 1469 1470 1471 1472
 */
#define PNG_CRC_DEFAULT       0  /* error/quit          warn/discard data */
#define PNG_CRC_ERROR_QUIT    1  /* error/quit          error/quit        */
#define PNG_CRC_WARN_DISCARD  2  /* (INVALID)           warn/discard data */
#define PNG_CRC_WARN_USE      3  /* warn/use data       warn/use data     */
#define PNG_CRC_QUIET_USE     4  /* quiet/use data      quiet/use data    */
#define PNG_CRC_NO_CHANGE     5  /* use current value   use current value */

1473
#ifdef PNG_WRITE_SUPPORTED
A
Andreas Dilger 已提交
1474 1475 1476 1477 1478
/* These functions give the user control over the scan-line filtering in
 * libpng and the compression methods used by zlib.  These functions are
 * mainly useful for testing, as the defaults should work with most users.
 * Those users who are tight on memory or want faster performance at the
 * expense of compression can modify them.  See the compression library
1479 1480
 * header file (zlib.h) for an explination of the compression functions.
 */
A
Andreas Dilger 已提交
1481

1482
/* Set the filtering method(s) used by libpng.  Currently, the only valid
1483 1484
 * value for "method" is 0.
 */
1485
PNG_EXPORT(67, void, png_set_filter, (png_structrp png_ptr, int method,
1486
    int filters));
1487
#endif /* WRITE */
G
Guy Schalnat 已提交
1488

A
Andreas Dilger 已提交
1489
/* Flags for png_set_filter() to say which filters to use.  The flags
A
Andreas Dilger 已提交
1490 1491 1492
 * are chosen so that they don't conflict with real filter types
 * below, in case they are supplied instead of the #defined constants.
 * These values should NOT be changed.
A
Andreas Dilger 已提交
1493 1494 1495 1496 1497 1498 1499
 */
#define PNG_NO_FILTERS     0x00
#define PNG_FILTER_NONE    0x08
#define PNG_FILTER_SUB     0x10
#define PNG_FILTER_UP      0x20
#define PNG_FILTER_AVG     0x40
#define PNG_FILTER_PAETH   0x80
1500 1501
#define PNG_FAST_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP)
#define PNG_ALL_FILTERS (PNG_FAST_FILTERS | PNG_FILTER_AVG | PNG_FILTER_PAETH)
A
Andreas Dilger 已提交
1502

A
Andreas Dilger 已提交
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
/* Filter values (not flags) - used in pngwrite.c, pngwutil.c for now.
 * These defines should NOT be changed.
 */
#define PNG_FILTER_VALUE_NONE  0
#define PNG_FILTER_VALUE_SUB   1
#define PNG_FILTER_VALUE_UP    2
#define PNG_FILTER_VALUE_AVG   3
#define PNG_FILTER_VALUE_PAETH 4
#define PNG_FILTER_VALUE_LAST  5

1513
#ifdef PNG_WRITE_SUPPORTED
1514
#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* DEPRECATED */
1515
PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structrp png_ptr,
1516
    int heuristic_method, int num_weights, png_const_doublep filter_weights,
1517
    png_const_doublep filter_costs))
1518
PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed,
1519
    (png_structrp png_ptr, int heuristic_method, int num_weights,
1520
    png_const_fixed_point_p filter_weights,
1521
    png_const_fixed_point_p filter_costs))
1522
#endif /* WRITE_WEIGHTED_FILTER */
A
Andreas Dilger 已提交
1523

1524 1525 1526 1527 1528 1529
/* The following are no longer used and will be removed from libpng-1.7: */
#define PNG_FILTER_HEURISTIC_DEFAULT    0  /* Currently "UNWEIGHTED" */
#define PNG_FILTER_HEURISTIC_UNWEIGHTED 1  /* Used by libpng < 0.95 */
#define PNG_FILTER_HEURISTIC_WEIGHTED   2  /* Experimental feature */
#define PNG_FILTER_HEURISTIC_LAST       3  /* Not a valid value */

A
Andreas Dilger 已提交
1530 1531 1532 1533
/* Set the library compression level.  Currently, valid values range from
 * 0 - 9, corresponding directly to the zlib compression levels 0 - 9
 * (0 - no compression, 9 - "maximal" compression).  Note that tests have
 * shown that zlib compression levels 3-6 usually perform as well as level 9
1534
 * for PNG images, and do considerably fewer caclulations.  In the future,
A
Andreas Dilger 已提交
1535 1536
 * these values may not correspond directly to the zlib compression levels.
 */
1537
#ifdef PNG_WRITE_CUSTOMIZE_COMPRESSION_SUPPORTED
1538
PNG_EXPORT(69, void, png_set_compression_level, (png_structrp png_ptr,
1539
    int level));
G
Guy Schalnat 已提交
1540

1541
PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structrp png_ptr,
1542
    int mem_level));
G
Guy Schalnat 已提交
1543

1544
PNG_EXPORT(71, void, png_set_compression_strategy, (png_structrp png_ptr,
1545
    int strategy));
G
Guy Schalnat 已提交
1546

1547 1548 1549
/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
 * smaller value of window_bits if it can do so safely.
 */
1550
PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structrp png_ptr,
1551
    int window_bits));
G
Guy Schalnat 已提交
1552

1553
PNG_EXPORT(73, void, png_set_compression_method, (png_structrp png_ptr,
1554
    int method));
1555
#endif /* WRITE_CUSTOMIZE_COMPRESSION */
G
Guy Schalnat 已提交
1556

1557
#ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED
1558
/* Also set zlib parameters for compressing non-IDAT chunks */
1559
PNG_EXPORT(222, void, png_set_text_compression_level, (png_structrp png_ptr,
1560
    int level));
1561

1562
PNG_EXPORT(223, void, png_set_text_compression_mem_level, (png_structrp png_ptr,
1563 1564
    int mem_level));

1565
PNG_EXPORT(224, void, png_set_text_compression_strategy, (png_structrp png_ptr,
1566 1567
    int strategy));

1568 1569 1570
/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
 * smaller value of window_bits if it can do so safely.
 */
1571
PNG_EXPORT(225, void, png_set_text_compression_window_bits,
1572
    (png_structrp png_ptr, int window_bits));
1573

1574
PNG_EXPORT(226, void, png_set_text_compression_method, (png_structrp png_ptr,
1575
    int method));
1576
#endif /* WRITE_CUSTOMIZE_ZTXT_COMPRESSION */
1577
#endif /* WRITE */
1578

G
Guy Schalnat 已提交
1579
/* These next functions are called for input/output, memory, and error
1580
 * handling.  They are in the file pngrio.c, pngwio.c, and pngerror.c,
A
Andreas Dilger 已提交
1581 1582 1583
 * and call standard C I/O routines such as fread(), fwrite(), and
 * fprintf().  These functions can be made to use other I/O routines
 * at run time for those applications that need to handle I/O in a
1584
 * different manner by calling png_set_???_fn().  See libpng-manual.txt for
A
Andreas Dilger 已提交
1585 1586
 * more information.
 */
G
Guy Schalnat 已提交
1587

1588
#ifdef PNG_STDIO_SUPPORTED
A
Andreas Dilger 已提交
1589
/* Initialize the input/output for the PNG file to the default functions. */
1590
PNG_EXPORT(74, void, png_init_io, (png_structrp png_ptr, png_FILE_p fp));
1591
#endif
G
Guy Schalnat 已提交
1592

A
Andreas Dilger 已提交
1593
/* Replace the (error and abort), and warning functions with user
A
Andreas Dilger 已提交
1594 1595 1596 1597 1598 1599
 * supplied functions.  If no messages are to be printed you must still
 * write and use replacement functions. The replacement error_fn should
 * still do a longjmp to the last setjmp location if you are using this
 * method of error handling.  If error_fn or warning_fn is NULL, the
 * default function will be used.
 */
1600

1601
PNG_EXPORT(75, void, png_set_error_fn, (png_structrp png_ptr,
1602
    png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warning_fn));
G
Guy Schalnat 已提交
1603

G
Guy Schalnat 已提交
1604
/* Return the user pointer associated with the error functions */
1605
PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structrp png_ptr));
G
Guy Schalnat 已提交
1606 1607

/* Replace the default data output functions with a user supplied one(s).
A
Andreas Dilger 已提交
1608 1609 1610
 * If buffered output is not used, then output_flush_fn can be set to NULL.
 * If PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile time
 * output_flush_fn will be ignored (and thus can be NULL).
1611 1612 1613 1614 1615
 * It is probably a mistake to use NULL for output_flush_fn if
 * write_data_fn is not also NULL unless you have built libpng with
 * PNG_WRITE_FLUSH_SUPPORTED undefined, because in this case libpng's
 * default flush function, which uses the standard *FILE structure, will
 * be used.
A
Andreas Dilger 已提交
1616
 */
1617
PNG_EXPORT(77, void, png_set_write_fn, (png_structrp png_ptr, png_voidp io_ptr,
1618
    png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn));
G
Guy Schalnat 已提交
1619 1620

/* Replace the default data input function with a user supplied one. */
1621
PNG_EXPORT(78, void, png_set_read_fn, (png_structrp png_ptr, png_voidp io_ptr,
1622
    png_rw_ptr read_data_fn));
G
Guy Schalnat 已提交
1623 1624

/* Return the user pointer associated with the I/O functions */
1625
PNG_EXPORT(79, png_voidp, png_get_io_ptr, (png_const_structrp png_ptr));
G
Guy Schalnat 已提交
1626

1627
PNG_EXPORT(80, void, png_set_read_status_fn, (png_structrp png_ptr,
1628
    png_read_status_ptr read_row_fn));
1629

1630
PNG_EXPORT(81, void, png_set_write_status_fn, (png_structrp png_ptr,
1631
    png_write_status_ptr write_row_fn));
1632

1633 1634
#ifdef PNG_USER_MEM_SUPPORTED
/* Replace the default memory allocation functions with user supplied one(s). */
1635
PNG_EXPORT(82, void, png_set_mem_fn, (png_structrp png_ptr, png_voidp mem_ptr,
1636
    png_malloc_ptr malloc_fn, png_free_ptr free_fn));
1637
/* Return the user pointer associated with the memory functions */
1638
PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structrp png_ptr));
1639
#endif
1640

1641
#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
1642
PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structrp png_ptr,
1643
    png_user_transform_ptr read_user_transform_fn));
1644 1645
#endif

1646
#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
1647
PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structrp png_ptr,
1648
    png_user_transform_ptr write_user_transform_fn));
1649 1650
#endif

1651
#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED
1652
PNG_EXPORT(86, void, png_set_user_transform_info, (png_structrp png_ptr,
1653
    png_voidp user_transform_ptr, int user_transform_depth,
1654
    int user_transform_channels));
1655
/* Return the user pointer associated with the user transform functions */
1656
PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr,
1657
    (png_const_structrp png_ptr));
1658 1659 1660 1661 1662 1663
#endif

#ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED
/* Return information about the row currently being processed.  Note that these
 * APIs do not fail but will return unexpected results if called outside a user
 * transform callback.  Also note that when transforming an interlaced image the
1664 1665 1666
 * row number is the row number within the sub-image of the interlace pass, so
 * the value will increase to the height of the sub-image (not the full image)
 * then reset to 0 for the next pass.
1667
 *
1668 1669 1670
 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
 * find the output pixel (x,y) given an interlaced sub-image pixel
 * (row,col,pass).  (See below for these macros.)
1671
 */
1672 1673
PNG_EXPORT(217, png_uint_32, png_get_current_row_number, (png_const_structrp));
PNG_EXPORT(218, png_byte, png_get_current_pass_number, (png_const_structrp));
1674 1675
#endif

1676
#ifdef PNG_READ_USER_CHUNKS_SUPPORTED
1677
/* This callback is called only for *unknown* chunks.  If
1678 1679 1680 1681 1682 1683 1684 1685 1686 1687
 * PNG_HANDLE_AS_UNKNOWN_SUPPORTED is set then it is possible to set known
 * chunks to be treated as unknown, however in this case the callback must do
 * any processing required by the chunk (e.g. by calling the appropriate
 * png_set_ APIs.)
 *
 * There is no write support - on write, by default, all the chunks in the
 * 'unknown' list are written in the specified position.
 *
 * The integer return from the callback function is interpreted thus:
 *
1688
 * negative: An error occurred; png_chunk_error will be called.
1689 1690
 *     zero: The chunk was not handled, the chunk will be saved. A critical
 *           chunk will cause an error at this point unless it is to be saved.
1691
 * positive: The chunk was handled, libpng will ignore/discard it.
1692 1693 1694
 *
 * See "INTERACTION WTIH USER CHUNK CALLBACKS" below for important notes about
 * how this behavior will change in libpng 1.7
1695
 */
1696
PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structrp png_ptr,
1697
    png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn));
1698 1699 1700
#endif

#ifdef PNG_USER_CHUNKS_SUPPORTED
1701
PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structrp png_ptr));
1702 1703
#endif

G
Guy Schalnat 已提交
1704
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
A
Andreas Dilger 已提交
1705 1706 1707
/* Sets the function callbacks for the push reader, and a pointer to a
 * user-defined structure available to the callback functions.
 */
1708
PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structrp png_ptr,
1709
    png_voidp progressive_ptr, png_progressive_info_ptr info_fn,
1710
    png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn));
G
Guy Schalnat 已提交
1711

1712
/* Returns the user pointer associated with the push read functions */
1713 1714
PNG_EXPORT(91, png_voidp, png_get_progressive_ptr,
    (png_const_structrp png_ptr));
A
Andreas Dilger 已提交
1715

1716
/* Function to be called when data becomes available */
1717 1718
PNG_EXPORT(92, void, png_process_data, (png_structrp png_ptr,
    png_inforp info_ptr, png_bytep buffer, png_size_t buffer_size));
A
Andreas Dilger 已提交
1719

1720 1721 1722 1723 1724 1725 1726
/* A function which may be called *only* within png_process_data to stop the
 * processing of any more data.  The function returns the number of bytes
 * remaining, excluding any that libpng has cached internally.  A subsequent
 * call to png_process_data must supply these bytes again.  If the argument
 * 'save' is set to true the routine will first save all the pending data and
 * will always return 0.
 */
1727
PNG_EXPORT(219, png_size_t, png_process_data_pause, (png_structrp, int save));
1728 1729 1730 1731 1732 1733 1734

/* A function which may be called *only* outside (after) a call to
 * png_process_data.  It returns the number of bytes of data to skip in the
 * input.  Normally it will return 0, but if it returns a non-zero value the
 * application must skip than number of bytes of input data and pass the
 * following data to the next call to png_process_data.
 */
1735
PNG_EXPORT(220, png_uint_32, png_process_data_skip, (png_structrp));
1736

1737 1738 1739 1740
/* Function that combines rows.  'new_row' is a flag that should come from
 * the callback and be non-NULL if anything needs to be done; the library
 * stores its own version of the new data internally and ignores the passed
 * in value.
A
Andreas Dilger 已提交
1741
 */
1742
PNG_EXPORT(93, void, png_progressive_combine_row, (png_const_structrp png_ptr,
1743
    png_bytep old_row, png_const_bytep new_row));
1744
#endif /* PROGRESSIVE_READ */
G
Guy Schalnat 已提交
1745

1746
PNG_EXPORTA(94, png_voidp, png_malloc, (png_const_structrp png_ptr,
1747
    png_alloc_size_t size), PNG_ALLOCATED);
1748
/* Added at libpng version 1.4.0 */
1749
PNG_EXPORTA(95, png_voidp, png_calloc, (png_const_structrp png_ptr,
1750
    png_alloc_size_t size), PNG_ALLOCATED);
G
Guy Schalnat 已提交
1751

1752
/* Added at libpng version 1.2.4 */
1753
PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_const_structrp png_ptr,
1754
    png_alloc_size_t size), PNG_ALLOCATED);
1755

1756
/* Frees a pointer allocated by png_malloc() */
1757
PNG_EXPORT(97, void, png_free, (png_const_structrp png_ptr, png_voidp ptr));
A
Andreas Dilger 已提交
1758

1759
/* Free data that was allocated internally */
1760 1761
PNG_EXPORT(98, void, png_free_data, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_uint_32 free_me, int num));
1762

1763
/* Reassign responsibility for freeing existing data, whether allocated
1764 1765
 * by libpng or by the application; this works on the png_info structure passed
 * in, it does not change the state for other png_info structures.
1766 1767 1768
 *
 * It is unlikely that this function works correctly as of 1.6.0 and using it
 * may result either in memory leaks or double free of allocated data.
1769
 */
1770 1771
PNG_EXPORT(99, void, png_data_freer, (png_const_structrp png_ptr,
    png_inforp info_ptr, int freer, png_uint_32 mask));
1772

1773
/* Assignments for png_data_freer */
1774 1775 1776 1777
#define PNG_DESTROY_WILL_FREE_DATA 1
#define PNG_SET_WILL_FREE_DATA 1
#define PNG_USER_WILL_FREE_DATA 2
/* Flags for png_ptr->free_me and info_ptr->free_me */
1778 1779 1780 1781 1782 1783
#define PNG_FREE_HIST 0x0008U
#define PNG_FREE_ICCP 0x0010U
#define PNG_FREE_SPLT 0x0020U
#define PNG_FREE_ROWS 0x0040U
#define PNG_FREE_PCAL 0x0080U
#define PNG_FREE_SCAL 0x0100U
1784
#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED
1785
#  define PNG_FREE_UNKN 0x0200U
1786
#endif
1787 1788 1789 1790 1791 1792
/*      PNG_FREE_LIST 0x0400U   removed in 1.6.0 because it is ignored */
#define PNG_FREE_PLTE 0x1000U
#define PNG_FREE_TRNS 0x2000U
#define PNG_FREE_TEXT 0x4000U
#define PNG_FREE_ALL  0x7fffU
#define PNG_FREE_MUL  0x4220U /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
1793

1794
#ifdef PNG_USER_MEM_SUPPORTED
1795
PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_const_structrp png_ptr,
1796
    png_alloc_size_t size), PNG_ALLOCATED PNG_DEPRECATED);
1797
PNG_EXPORTA(101, void, png_free_default, (png_const_structrp png_ptr,
1798
    png_voidp ptr), PNG_DEPRECATED);
1799
#endif
1800

1801
#ifdef PNG_ERROR_TEXT_SUPPORTED
A
Andreas Dilger 已提交
1802
/* Fatal error in PNG image of libpng - can't continue */
1803
PNG_EXPORTA(102, void, png_error, (png_const_structrp png_ptr,
1804
    png_const_charp error_message), PNG_NORETURN);
G
Guy Schalnat 已提交
1805

1806
/* The same, but the chunk name is prepended to the error string. */
1807
PNG_EXPORTA(103, void, png_chunk_error, (png_const_structrp png_ptr,
1808
    png_const_charp error_message), PNG_NORETURN);
1809

1810 1811
#else
/* Fatal error in PNG image of libpng - can't continue */
1812
PNG_EXPORTA(104, void, png_err, (png_const_structrp png_ptr), PNG_NORETURN);
1813 1814
#  define png_error(s1,s2) png_err(s1)
#  define png_chunk_error(s1,s2) png_err(s1)
1815 1816
#endif

1817
#ifdef PNG_WARNINGS_SUPPORTED
G
Guy Schalnat 已提交
1818
/* Non-fatal error in libpng.  Can continue, but may have a problem. */
1819
PNG_EXPORT(105, void, png_warning, (png_const_structrp png_ptr,
1820
    png_const_charp warning_message));
A
Andreas Dilger 已提交
1821

1822
/* Non-fatal error in libpng, chunk name is prepended to message. */
1823
PNG_EXPORT(106, void, png_chunk_warning, (png_const_structrp png_ptr,
1824
    png_const_charp warning_message));
1825 1826 1827
#else
#  define png_warning(s1,s2) ((void)(s1))
#  define png_chunk_warning(s1,s2) ((void)(s1))
1828
#endif
1829

1830 1831 1832
#ifdef PNG_BENIGN_ERRORS_SUPPORTED
/* Benign error in libpng.  Can continue, but may have a problem.
 * User can choose whether to handle as a fatal error or as a warning. */
1833
PNG_EXPORT(107, void, png_benign_error, (png_const_structrp png_ptr,
1834
    png_const_charp warning_message));
1835

1836 1837
#ifdef PNG_READ_SUPPORTED
/* Same, chunk name is prepended to message (only during read) */
1838
PNG_EXPORT(108, void, png_chunk_benign_error, (png_const_structrp png_ptr,
1839
    png_const_charp warning_message));
1840
#endif
1841

1842
PNG_EXPORT(109, void, png_set_benign_errors,
1843
    (png_structrp png_ptr, int allowed));
1844 1845 1846 1847 1848 1849 1850 1851
#else
#  ifdef PNG_ALLOW_BENIGN_ERRORS
#    define png_benign_error png_warning
#    define png_chunk_benign_error png_chunk_warning
#  else
#    define png_benign_error png_error
#    define png_chunk_benign_error png_chunk_error
#  endif
1852 1853
#endif

A
Andreas Dilger 已提交
1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865
/* The png_set_<chunk> functions are for storing values in the png_info_struct.
 * Similarly, the png_get_<chunk> calls are used to read values from the
 * png_info_struct, either storing the parameters in the passed variables, or
 * setting pointers into the png_info_struct where the data is stored.  The
 * png_get_<chunk> functions return a non-zero value if the data was available
 * in info_ptr, or return zero and do not change any of the parameters if the
 * data was not available.
 *
 * These functions should be used instead of directly accessing png_info
 * to avoid problems with future changes in the size and internal layout of
 * png_info_struct.
 */
1866
/* Returns "flag" if chunk data is valid in info_ptr. */
1867 1868
PNG_EXPORT(110, png_uint_32, png_get_valid, (png_const_structrp png_ptr,
    png_const_inforp info_ptr, png_uint_32 flag));
A
Andreas Dilger 已提交
1869

1870
/* Returns number of bytes needed to hold a transformed row. */
1871 1872
PNG_EXPORT(111, png_size_t, png_get_rowbytes, (png_const_structrp png_ptr,
    png_const_inforp info_ptr));
A
Andreas Dilger 已提交
1873

1874
#ifdef PNG_INFO_IMAGE_SUPPORTED
1875
/* Returns row_pointers, which is an array of pointers to scanlines that was
1876 1877
 * returned from png_read_png().
 */
1878 1879
PNG_EXPORT(112, png_bytepp, png_get_rows, (png_const_structrp png_ptr,
    png_const_inforp info_ptr));
1880

1881
/* Set row_pointers, which is an array of pointers to scanlines for use
1882 1883
 * by png_write_png().
 */
1884 1885
PNG_EXPORT(113, void, png_set_rows, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_bytepp row_pointers));
1886 1887
#endif

1888
/* Returns number of color channels in image. */
1889 1890
PNG_EXPORT(114, png_byte, png_get_channels, (png_const_structrp png_ptr,
    png_const_inforp info_ptr));
A
Andreas Dilger 已提交
1891

1892 1893
#ifdef PNG_EASY_ACCESS_SUPPORTED
/* Returns image width in pixels. */
1894 1895
PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structrp png_ptr,
    png_const_inforp info_ptr));
1896 1897

/* Returns image height in pixels. */
1898 1899
PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structrp png_ptr,
    png_const_inforp info_ptr));
1900 1901

/* Returns image bit_depth. */
1902 1903
PNG_EXPORT(117, png_byte, png_get_bit_depth, (png_const_structrp png_ptr,
    png_const_inforp info_ptr));
1904 1905

/* Returns image color_type. */
1906 1907
PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structrp png_ptr,
    png_const_inforp info_ptr));
1908 1909

/* Returns image filter_type. */
1910 1911
PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structrp png_ptr,
    png_const_inforp info_ptr));
1912 1913

/* Returns image interlace_type. */
1914 1915
PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structrp png_ptr,
    png_const_inforp info_ptr));
1916 1917

/* Returns image compression_type. */
1918 1919
PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structrp png_ptr,
    png_const_inforp info_ptr));
1920 1921

/* Returns image resolution in pixels per meter, from pHYs chunk data. */
1922
PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter,
1923
    (png_const_structrp png_ptr, png_const_inforp info_ptr));
1924
PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter,
1925
    (png_const_structrp png_ptr, png_const_inforp info_ptr));
1926
PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter,
1927
    (png_const_structrp png_ptr, png_const_inforp info_ptr));
1928 1929

/* Returns pixel aspect ratio, computed from pHYs chunk data.  */
1930
PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio,
1931
    (png_const_structrp png_ptr, png_const_inforp info_ptr))
1932
PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed,
1933
    (png_const_structrp png_ptr, png_const_inforp info_ptr))
1934 1935

/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
1936 1937 1938 1939
PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels,
    (png_const_structrp png_ptr, png_const_inforp info_ptr));
PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels,
    (png_const_structrp png_ptr, png_const_inforp info_ptr));
1940
PNG_EXPORT(128, png_int_32, png_get_x_offset_microns,
1941
    (png_const_structrp png_ptr, png_const_inforp info_ptr));
1942
PNG_EXPORT(129, png_int_32, png_get_y_offset_microns,
1943
    (png_const_structrp png_ptr, png_const_inforp info_ptr));
1944

1945
#endif /* EASY_ACCESS */
1946

1947
#ifdef PNG_READ_SUPPORTED
A
Andreas Dilger 已提交
1948
/* Returns pointer to signature string read from PNG header */
1949
PNG_EXPORT(130, png_const_bytep, png_get_signature, (png_const_structrp png_ptr,
1950
    png_const_inforp info_ptr));
1951
#endif
A
Andreas Dilger 已提交
1952

1953
#ifdef PNG_bKGD_SUPPORTED
1954 1955
PNG_EXPORT(131, png_uint_32, png_get_bKGD, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_color_16p *background));
1956
#endif
A
Andreas Dilger 已提交
1957

1958
#ifdef PNG_bKGD_SUPPORTED
1959 1960
PNG_EXPORT(132, void, png_set_bKGD, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_const_color_16p background));
1961
#endif
A
Andreas Dilger 已提交
1962

1963
#ifdef PNG_cHRM_SUPPORTED
1964
PNG_FP_EXPORT(133, png_uint_32, png_get_cHRM, (png_const_structrp png_ptr,
1965
    png_const_inforp info_ptr, double *white_x, double *white_y, double *red_x,
1966
    double *red_y, double *green_x, double *green_y, double *blue_x,
1967
    double *blue_y))
1968 1969
PNG_FP_EXPORT(230, png_uint_32, png_get_cHRM_XYZ, (png_const_structrp png_ptr,
    png_const_inforp info_ptr, double *red_X, double *red_Y, double *red_Z,
1970
    double *green_X, double *green_Y, double *green_Z, double *blue_X,
1971
    double *blue_Y, double *blue_Z))
1972
PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed,
1973
    (png_const_structrp png_ptr, png_const_inforp info_ptr,
1974 1975 1976
    png_fixed_point *int_white_x, png_fixed_point *int_white_y,
    png_fixed_point *int_red_x, png_fixed_point *int_red_y,
    png_fixed_point *int_green_x, png_fixed_point *int_green_y,
1977
    png_fixed_point *int_blue_x, png_fixed_point *int_blue_y))
1978
PNG_FIXED_EXPORT(231, png_uint_32, png_get_cHRM_XYZ_fixed,
1979
    (png_const_structrp png_ptr, png_const_inforp info_ptr,
1980 1981 1982 1983
    png_fixed_point *int_red_X, png_fixed_point *int_red_Y,
    png_fixed_point *int_red_Z, png_fixed_point *int_green_X,
    png_fixed_point *int_green_Y, png_fixed_point *int_green_Z,
    png_fixed_point *int_blue_X, png_fixed_point *int_blue_Y,
1984
    png_fixed_point *int_blue_Z))
1985
#endif
A
Andreas Dilger 已提交
1986

1987
#ifdef PNG_cHRM_SUPPORTED
1988 1989
PNG_FP_EXPORT(135, void, png_set_cHRM, (png_const_structrp png_ptr,
    png_inforp info_ptr,
1990
    double white_x, double white_y, double red_x, double red_y, double green_x,
1991
    double green_y, double blue_x, double blue_y))
1992
PNG_FP_EXPORT(232, void, png_set_cHRM_XYZ, (png_const_structrp png_ptr,
1993
    png_inforp info_ptr, double red_X, double red_Y, double red_Z,
1994
    double green_X, double green_Y, double green_Z, double blue_X,
1995
    double blue_Y, double blue_Z))
1996
PNG_FIXED_EXPORT(136, void, png_set_cHRM_fixed, (png_const_structrp png_ptr,
1997
    png_inforp info_ptr, png_fixed_point int_white_x,
1998 1999 2000
    png_fixed_point int_white_y, png_fixed_point int_red_x,
    png_fixed_point int_red_y, png_fixed_point int_green_x,
    png_fixed_point int_green_y, png_fixed_point int_blue_x,
2001
    png_fixed_point int_blue_y))
2002
PNG_FIXED_EXPORT(233, void, png_set_cHRM_XYZ_fixed, (png_const_structrp png_ptr,
2003
    png_inforp info_ptr, png_fixed_point int_red_X, png_fixed_point int_red_Y,
2004 2005 2006
    png_fixed_point int_red_Z, png_fixed_point int_green_X,
    png_fixed_point int_green_Y, png_fixed_point int_green_Z,
    png_fixed_point int_blue_X, png_fixed_point int_blue_Y,
2007
    png_fixed_point int_blue_Z))
2008
#endif
A
Andreas Dilger 已提交
2009

2010
#ifdef PNG_gAMA_SUPPORTED
2011
PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA, (png_const_structrp png_ptr,
2012
    png_const_inforp info_ptr, double *file_gamma))
2013
PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed,
2014
    (png_const_structrp png_ptr, png_const_inforp info_ptr,
2015
    png_fixed_point *int_file_gamma))
2016
#endif
G
Guy Schalnat 已提交
2017

2018
#ifdef PNG_gAMA_SUPPORTED
2019
PNG_FP_EXPORT(139, void, png_set_gAMA, (png_const_structrp png_ptr,
2020
    png_inforp info_ptr, double file_gamma))
2021
PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_const_structrp png_ptr,
2022
    png_inforp info_ptr, png_fixed_point int_file_gamma))
2023
#endif
A
Andreas Dilger 已提交
2024

2025
#ifdef PNG_hIST_SUPPORTED
2026
PNG_EXPORT(141, png_uint_32, png_get_hIST, (png_const_structrp png_ptr,
2027
    png_inforp info_ptr, png_uint_16p *hist));
2028
#endif
A
Andreas Dilger 已提交
2029

2030
#ifdef PNG_hIST_SUPPORTED
2031 2032
PNG_EXPORT(142, void, png_set_hIST, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_const_uint_16p hist));
2033
#endif
A
Andreas Dilger 已提交
2034

2035
PNG_EXPORT(143, png_uint_32, png_get_IHDR, (png_const_structrp png_ptr,
2036
    png_const_inforp info_ptr, png_uint_32 *width, png_uint_32 *height,
2037 2038
    int *bit_depth, int *color_type, int *interlace_method,
    int *compression_method, int *filter_method));
2039

2040 2041 2042 2043
PNG_EXPORT(144, void, png_set_IHDR, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_uint_32 width, png_uint_32 height, int bit_depth,
    int color_type, int interlace_method, int compression_method,
    int filter_method));
A
Andreas Dilger 已提交
2044

2045
#ifdef PNG_oFFs_SUPPORTED
2046 2047
PNG_EXPORT(145, png_uint_32, png_get_oFFs, (png_const_structrp png_ptr,
   png_const_inforp info_ptr, png_int_32 *offset_x, png_int_32 *offset_y,
2048
   int *unit_type));
2049
#endif
A
Andreas Dilger 已提交
2050

2051
#ifdef PNG_oFFs_SUPPORTED
2052 2053 2054
PNG_EXPORT(146, void, png_set_oFFs, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_int_32 offset_x, png_int_32 offset_y,
    int unit_type));
2055
#endif
A
Andreas Dilger 已提交
2056

2057
#ifdef PNG_pCAL_SUPPORTED
2058
PNG_EXPORT(147, png_uint_32, png_get_pCAL, (png_const_structrp png_ptr,
2059
    png_inforp info_ptr, png_charp *purpose, png_int_32 *X0,
2060 2061
    png_int_32 *X1, int *type, int *nparams, png_charp *units,
    png_charpp *params));
2062
#endif
A
Andreas Dilger 已提交
2063

2064
#ifdef PNG_pCAL_SUPPORTED
2065 2066 2067
PNG_EXPORT(148, void, png_set_pCAL, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_const_charp purpose, png_int_32 X0, png_int_32 X1,
    int type, int nparams, png_const_charp units, png_charpp params));
2068 2069
#endif

2070
#ifdef PNG_pHYs_SUPPORTED
2071 2072
PNG_EXPORT(149, png_uint_32, png_get_pHYs, (png_const_structrp png_ptr,
    png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
2073
    int *unit_type));
2074
#endif
A
Andreas Dilger 已提交
2075

2076
#ifdef PNG_pHYs_SUPPORTED
2077 2078
PNG_EXPORT(150, void, png_set_pHYs, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_uint_32 res_x, png_uint_32 res_y, int unit_type));
2079
#endif
A
Andreas Dilger 已提交
2080

2081
PNG_EXPORT(151, png_uint_32, png_get_PLTE, (png_const_structrp png_ptr,
2082
   png_inforp info_ptr, png_colorp *palette, int *num_palette));
A
Andreas Dilger 已提交
2083

2084 2085
PNG_EXPORT(152, void, png_set_PLTE, (png_structrp png_ptr,
    png_inforp info_ptr, png_const_colorp palette, int num_palette));
A
Andreas Dilger 已提交
2086

2087
#ifdef PNG_sBIT_SUPPORTED
2088 2089
PNG_EXPORT(153, png_uint_32, png_get_sBIT, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_color_8p *sig_bit));
2090
#endif
A
Andreas Dilger 已提交
2091

2092
#ifdef PNG_sBIT_SUPPORTED
2093 2094
PNG_EXPORT(154, void, png_set_sBIT, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_const_color_8p sig_bit));
2095
#endif
A
Andreas Dilger 已提交
2096

2097
#ifdef PNG_sRGB_SUPPORTED
2098 2099
PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structrp png_ptr,
    png_const_inforp info_ptr, int *file_srgb_intent));
2100
#endif
2101

2102
#ifdef PNG_sRGB_SUPPORTED
2103 2104 2105
PNG_EXPORT(156, void, png_set_sRGB, (png_const_structrp png_ptr,
    png_inforp info_ptr, int srgb_intent));
PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_const_structrp png_ptr,
2106
    png_inforp info_ptr, int srgb_intent));
2107 2108
#endif

2109
#ifdef PNG_iCCP_SUPPORTED
2110
PNG_EXPORT(158, png_uint_32, png_get_iCCP, (png_const_structrp png_ptr,
2111
    png_inforp info_ptr, png_charpp name, int *compression_type,
2112
    png_bytepp profile, png_uint_32 *proflen));
2113 2114
#endif

2115
#ifdef PNG_iCCP_SUPPORTED
2116 2117 2118
PNG_EXPORT(159, void, png_set_iCCP, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_const_charp name, int compression_type,
    png_const_bytep profile, png_uint_32 proflen));
2119 2120
#endif

2121
#ifdef PNG_sPLT_SUPPORTED
2122 2123
PNG_EXPORT(160, int, png_get_sPLT, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_sPLT_tpp entries));
2124 2125
#endif

2126
#ifdef PNG_sPLT_SUPPORTED
2127 2128
PNG_EXPORT(161, void, png_set_sPLT, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_const_sPLT_tp entries, int nentries));
2129 2130
#endif

2131
#ifdef PNG_TEXT_SUPPORTED
2132
/* png_get_text also returns the number of text chunks in *num_text */
2133 2134
PNG_EXPORT(162, int, png_get_text, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_textp *text_ptr, int *num_text));
2135
#endif
A
Andreas Dilger 已提交
2136

2137
/* Note while png_set_text() will accept a structure whose text,
2138 2139 2140 2141
 * language, and  translated keywords are NULL pointers, the structure
 * returned by png_get_text will always contain regular
 * zero-terminated C strings.  They might be empty strings but
 * they will never be NULL pointers.
2142 2143
 */

2144
#ifdef PNG_TEXT_SUPPORTED
2145 2146
PNG_EXPORT(163, void, png_set_text, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_const_textp text_ptr, int num_text));
2147
#endif
A
Andreas Dilger 已提交
2148

2149
#ifdef PNG_tIME_SUPPORTED
2150 2151
PNG_EXPORT(164, png_uint_32, png_get_tIME, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_timep *mod_time));
2152
#endif
A
Andreas Dilger 已提交
2153

2154
#ifdef PNG_tIME_SUPPORTED
2155 2156
PNG_EXPORT(165, void, png_set_tIME, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_const_timep mod_time));
2157
#endif
A
Andreas Dilger 已提交
2158

2159
#ifdef PNG_tRNS_SUPPORTED
2160 2161
PNG_EXPORT(166, png_uint_32, png_get_tRNS, (png_const_structrp png_ptr,
    png_inforp info_ptr, png_bytep *trans_alpha, int *num_trans,
2162
    png_color_16p *trans_color));
2163 2164
#endif

2165
#ifdef PNG_tRNS_SUPPORTED
2166 2167
PNG_EXPORT(167, void, png_set_tRNS, (png_structrp png_ptr,
    png_inforp info_ptr, png_const_bytep trans_alpha, int num_trans,
2168
    png_const_color_16p trans_color));
2169 2170
#endif

2171
#ifdef PNG_sCAL_SUPPORTED
2172
PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL, (png_const_structrp png_ptr,
2173 2174 2175
    png_const_inforp info_ptr, int *unit, double *width, double *height))
#if defined(PNG_FLOATING_ARITHMETIC_SUPPORTED) || \
   defined(PNG_FLOATING_POINT_SUPPORTED)
2176
/* NOTE: this API is currently implemented using floating point arithmetic,
2177 2178 2179 2180
 * consequently it can only be used on systems with floating point support.
 * In any case the range of values supported by png_fixed_point is small and it
 * is highly recommended that png_get_sCAL_s be used instead.
 */
2181
PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed,
2182
    (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,
2183
    png_fixed_point *width, png_fixed_point *height))
2184 2185
#endif
PNG_EXPORT(169, png_uint_32, png_get_sCAL_s,
2186
    (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,
2187
    png_charpp swidth, png_charpp sheight));
2188

2189
PNG_FP_EXPORT(170, void, png_set_sCAL, (png_const_structrp png_ptr,
2190
    png_inforp info_ptr, int unit, double width, double height))
2191
PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_const_structrp png_ptr,
2192
   png_inforp info_ptr, int unit, png_fixed_point width,
2193
   png_fixed_point height))
2194 2195 2196
PNG_EXPORT(171, void, png_set_sCAL_s, (png_const_structrp png_ptr,
    png_inforp info_ptr, int unit,
    png_const_charp swidth, png_const_charp sheight));
2197
#endif /* sCAL */
2198

2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230
#ifdef PNG_SET_UNKNOWN_CHUNKS_SUPPORTED
/* Provide the default handling for all unknown chunks or, optionally, for
 * specific unknown chunks.
 *
 * NOTE: prior to 1.6.0 the handling specified for particular chunks on read was
 * ignored and the default was used, the per-chunk setting only had an effect on
 * write.  If you wish to have chunk-specific handling on read in code that must
 * work on earlier versions you must use a user chunk callback to specify the
 * desired handling (keep or discard.)
 *
 * The 'keep' parameter is a PNG_HANDLE_CHUNK_ value as listed below.  The
 * parameter is interpreted as follows:
 *
 * READ:
 *    PNG_HANDLE_CHUNK_AS_DEFAULT:
 *       Known chunks: do normal libpng processing, do not keep the chunk (but
 *          see the comments below about PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
 *       Unknown chunks: for a specific chunk use the global default, when used
 *          as the default discard the chunk data.
 *    PNG_HANDLE_CHUNK_NEVER:
 *       Discard the chunk data.
 *    PNG_HANDLE_CHUNK_IF_SAFE:
 *       Keep the chunk data if the chunk is not critical else raise a chunk
 *       error.
 *    PNG_HANDLE_CHUNK_ALWAYS:
 *       Keep the chunk data.
 *
 * If the chunk data is saved it can be retrieved using png_get_unknown_chunks,
 * below.  Notice that specifying "AS_DEFAULT" as a global default is equivalent
 * to specifying "NEVER", however when "AS_DEFAULT" is used for specific chunks
 * it simply resets the behavior to the libpng default.
 *
2231
 * INTERACTION WTIH USER CHUNK CALLBACKS:
2232 2233 2234 2235 2236 2237
 * The per-chunk handling is always used when there is a png_user_chunk_ptr
 * callback and the callback returns 0; the chunk is then always stored *unless*
 * it is critical and the per-chunk setting is other than ALWAYS.  Notice that
 * the global default is *not* used in this case.  (In effect the per-chunk
 * value is incremented to at least IF_SAFE.)
 *
2238 2239 2240 2241 2242 2243 2244 2245
 * IMPORTANT NOTE: this behavior will change in libpng 1.7 - the global and
 * per-chunk defaults will be honored.  If you want to preserve the current
 * behavior when your callback returns 0 you must set PNG_HANDLE_CHUNK_IF_SAFE
 * as the default - if you don't do this libpng 1.6 will issue a warning.
 *
 * If you want unhandled unknown chunks to be discarded in libpng 1.6 and
 * earlier simply return '1' (handled).
 *
2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297
 * PNG_HANDLE_AS_UNKNOWN_SUPPORTED:
 *    If this is *not* set known chunks will always be handled by libpng and
 *    will never be stored in the unknown chunk list.  Known chunks listed to
 *    png_set_keep_unknown_chunks will have no effect.  If it is set then known
 *    chunks listed with a keep other than AS_DEFAULT will *never* be processed
 *    by libpng, in addition critical chunks must either be processed by the
 *    callback or saved.
 *
 *    The IHDR and IEND chunks must not be listed.  Because this turns off the
 *    default handling for chunks that would otherwise be recognized the
 *    behavior of libpng transformations may well become incorrect!
 *
 * WRITE:
 *    When writing chunks the options only apply to the chunks specified by
 *    png_set_unknown_chunks (below), libpng will *always* write known chunks
 *    required by png_set_ calls and will always write the core critical chunks
 *    (as required for PLTE).
 *
 *    Each chunk in the png_set_unknown_chunks list is looked up in the
 *    png_set_keep_unknown_chunks list to find the keep setting, this is then
 *    interpreted as follows:
 *
 *    PNG_HANDLE_CHUNK_AS_DEFAULT:
 *       Write safe-to-copy chunks and write other chunks if the global
 *       default is set to _ALWAYS, otherwise don't write this chunk.
 *    PNG_HANDLE_CHUNK_NEVER:
 *       Do not write the chunk.
 *    PNG_HANDLE_CHUNK_IF_SAFE:
 *       Write the chunk if it is safe-to-copy, otherwise do not write it.
 *    PNG_HANDLE_CHUNK_ALWAYS:
 *       Write the chunk.
 *
 * Note that the default behavior is effectively the opposite of the read case -
 * in read unknown chunks are not stored by default, in write they are written
 * by default.  Also the behavior of PNG_HANDLE_CHUNK_IF_SAFE is very different
 * - on write the safe-to-copy bit is checked, on read the critical bit is
 * checked and on read if the chunk is critical an error will be raised.
 *
 * num_chunks:
 * ===========
 *    If num_chunks is positive, then the "keep" parameter specifies the manner
 *    for handling only those chunks appearing in the chunk_list array,
 *    otherwise the chunk list array is ignored.
 *
 *    If num_chunks is 0 the "keep" parameter specifies the default behavior for
 *    unknown chunks, as described above.
 *
 *    If num_chunks is negative, then the "keep" parameter specifies the manner
 *    for handling all unknown chunks plus all chunks recognized by libpng
 *    except for the IHDR, PLTE, tRNS, IDAT, and IEND chunks (which continue to
 *    be processed by libpng.
 */
J
John Bowler 已提交
2298
#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
2299
PNG_EXPORT(172, void, png_set_keep_unknown_chunks, (png_structrp png_ptr,
2300
    int keep, png_const_bytep chunk_list, int num_chunks));
J
John Bowler 已提交
2301
#endif /* HANDLE_AS_UNKNOWN */
2302

2303 2304 2305
/* The "keep" PNG_HANDLE_CHUNK_ parameter for the specified chunk is returned;
 * the result is therefore true (non-zero) if special handling is required,
 * 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));
J
John Bowler 已提交
2309
#endif /* SET_UNKNOWN_CHUNKS */
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 2316 2317 2318 2319 2320 2321 2322 2323
   /* NOTE: prior to 1.6.0 this routine set the 'location' field of the added
    * unknowns to the location currently stored in the png_struct.  This is
    * invariably the wrong value on write.  To fix this call the following API
    * for each chunk in the list with the correct location.  If you know your
    * code won't be compiled on earlier versions you can rely on
    * png_set_unknown_chunks(write-ptr, png_get_unknown_chunks(read-ptr)) doing
    * the correct thing.
    */

2324 2325
PNG_EXPORT(175, void, png_set_unknown_chunk_location,
    (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 2330
#endif

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 2334
 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
 */
2335 2336
PNG_EXPORT(177, void, png_set_invalid, (png_const_structrp png_ptr,
    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 2344
#endif
#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 2363
#endif

2364 2365 2366 2367 2368
/* For use in png_set_keep_unknown, added to version 1.2.6 */
#define PNG_HANDLE_CHUNK_AS_DEFAULT   0
#define PNG_HANDLE_CHUNK_NEVER        1
#define PNG_HANDLE_CHUNK_IF_SAFE      2
#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 2373
 * messages before passing them to the error or warning handler.
 */
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 2395
    png_alloc_size_t user_chunk_cache_max));
PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max,
2396
    (png_const_structrp png_ptr));
2397 2398
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
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))
G
[devel]  
Glenn Randers-Pehrson 已提交
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))
G
[devel]  
Glenn Randers-Pehrson 已提交
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))
G
[devel]  
Glenn Randers-Pehrson 已提交
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))
G
[devel]  
Glenn Randers-Pehrson 已提交
2421
#endif
2422

2423
#  ifdef PNG_pHYs_SUPPORTED
2424 2425
PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structrp png_ptr,
    png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
2426
    int *unit_type));
2427 2428
#  endif /* pHYs */
#endif  /* INCH_CONVERSIONS */
2429

2430 2431
/* Added in libpng-1.4.0 */
#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 2443 2444 2445 2446 2447 2448 2449 2450
#  define PNG_IO_NONE        0x0000   /* no I/O at this moment */
#  define PNG_IO_READING     0x0001   /* currently reading */
#  define PNG_IO_WRITING     0x0002   /* currently writing */
#  define PNG_IO_SIGNATURE   0x0010   /* currently at the file signature */
#  define PNG_IO_CHUNK_HDR   0x0020   /* currently at the chunk header */
#  define PNG_IO_CHUNK_DATA  0x0040   /* currently at the chunk data */
#  define PNG_IO_CHUNK_CRC   0x0080   /* currently at the chunk crc */
#  define PNG_IO_MASK_OP     0x000f   /* current operation: reading/writing */
#  define PNG_IO_MASK_LOC    0x00f0   /* current location: sig/hdr/data/crc */
2451
#endif /* IO_STATE */
2452

2453 2454 2455 2456 2457 2458 2459 2460 2461 2462
/* Interlace support.  The following macros are always defined so that if
 * libpng interlace handling is turned off the macros may be used to handle
 * interlaced images within the application.
 */
#define PNG_INTERLACE_ADAM7_PASSES 7

/* Two macros to return the first row and first column of the original,
 * full, image which appears in a given pass.  'pass' is in the range 0
 * to 6 and the result is in the range 0 to 7.
 */
2463 2464 2465 2466 2467 2468 2469 2470 2471 2472
#define PNG_PASS_START_ROW(pass) (((1&~(pass))<<(3-((pass)>>1)))&7)
#define PNG_PASS_START_COL(pass) (((1& (pass))<<(3-(((pass)+1)>>1)))&7)

/* A macro to return the offset between pixels in the output row for a pair of
 * pixels in the input - effectively the inverse of the 'COL_SHIFT' macro that
 * follows.  Note that ROW_OFFSET is the offset from one row to the next whereas
 * COL_OFFSET is from one column to the next, within a row.
 */
#define PNG_PASS_ROW_OFFSET(pass) ((pass)>2?(8>>(((pass)-1)>>1)):8)
#define PNG_PASS_COL_OFFSET(pass) (1<<((7-(pass))>>1))
2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490

/* Two macros to help evaluate the number of rows or columns in each
 * pass.  This is expressed as a shift - effectively log2 of the number or
 * rows or columns in each 8x8 tile of the original image.
 */
#define PNG_PASS_ROW_SHIFT(pass) ((pass)>2?(8-(pass))>>1:3)
#define PNG_PASS_COL_SHIFT(pass) ((pass)>1?(7-(pass))>>1:3)

/* Hence two macros to determine the number of rows or columns in a given
 * pass of an image given its height or width.  In fact these macros may
 * return non-zero even though the sub-image is empty, because the other
 * dimension may be empty for a small image.
 */
#define PNG_PASS_ROWS(height, pass) (((height)+(((1<<PNG_PASS_ROW_SHIFT(pass))\
   -1)-PNG_PASS_START_ROW(pass)))>>PNG_PASS_ROW_SHIFT(pass))
#define PNG_PASS_COLS(width, pass) (((width)+(((1<<PNG_PASS_COL_SHIFT(pass))\
   -1)-PNG_PASS_START_COL(pass)))>>PNG_PASS_COL_SHIFT(pass))

2491 2492 2493
/* For the reader row callbacks (both progressive and sequential) it is
 * necessary to find the row in the output image given a row in an interlaced
 * image, so two more macros:
2494
 */
2495 2496 2497 2498
#define PNG_ROW_FROM_PASS_ROW(y_in, pass) \
   (((y_in)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass))
#define PNG_COL_FROM_PASS_COL(x_in, pass) \
   (((x_in)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass))
2499 2500 2501 2502 2503 2504 2505 2506

/* Two macros which return a boolean (0 or 1) saying whether the given row
 * or column is in a particular pass.  These use a common utility macro that
 * returns a mask for a given pass - the offset 'off' selects the row or
 * column version.  The mask has the appropriate bit set for each column in
 * the tile.
 */
#define PNG_PASS_MASK(pass,off) ( \
2507 2508
   ((0x110145AF>>(((7-(off))-(pass))<<2)) & 0xF) | \
   ((0x01145AF0>>(((7-(off))-(pass))<<2)) & 0xF0))
2509 2510 2511 2512 2513 2514

#define PNG_ROW_IN_INTERLACE_PASS(y, pass) \
   ((PNG_PASS_MASK(pass,0) >> ((y)&7)) & 1)
#define PNG_COL_IN_INTERLACE_PASS(x, pass) \
   ((PNG_PASS_MASK(pass,1) >> ((x)&7)) & 1)

2515
#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
2516 2517 2518
/* With these routines we avoid an integer divide, which will be slower on
 * most machines.  However, it does take more operations than the corresponding
 * divide method, so it may be slower on a few RISC systems.  There are two
2519 2520 2521 2522 2523 2524 2525 2526 2527
 * shifts (by 8 or 16 bits) and an addition, versus a single integer divide.
 *
 * Note that the rounding factors are NOT supposed to be the same!  128 and
 * 32768 are correct for the NODIV code; 127 and 32767 are correct for the
 * standard method.
 *
 * [Optimized code by Greg Roelofs and Mark Adler...blame us for bugs. :-) ]
 */

2528
 /* fg and bg should be in `gamma 1.0' space; alpha is the opacity */
2529

2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546
#  define png_composite(composite, fg, alpha, bg)        \
   {                                                     \
      png_uint_16 temp = (png_uint_16)((png_uint_16)(fg) \
          * (png_uint_16)(alpha)                         \
          + (png_uint_16)(bg)*(png_uint_16)(255          \
          - (png_uint_16)(alpha)) + 128);                \
      (composite) = (png_byte)(((temp + (temp >> 8)) >> 8) & 0xff); \
   }

#  define png_composite_16(composite, fg, alpha, bg)     \
   {                                                     \
      png_uint_32 temp = (png_uint_32)((png_uint_32)(fg) \
          * (png_uint_32)(alpha)                         \
          + (png_uint_32)(bg)*(65535                     \
          - (png_uint_32)(alpha)) + 32768);              \
      (composite) = (png_uint_16)(0xffff & ((temp + (temp >> 16)) >> 16)); \
   }
2547

2548
#else  /* Standard method using integer division */
2549

2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560
#  define png_composite(composite, fg, alpha, bg)                      \
   (composite) =                                                       \
       (png_byte)(0xff & (((png_uint_16)(fg) * (png_uint_16)(alpha) +  \
       (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \
       127) / 255))

#  define png_composite_16(composite, fg, alpha, bg)                       \
   (composite) =                                                           \
       (png_uint_16)(0xffff & (((png_uint_32)(fg) * (png_uint_32)(alpha) + \
       (png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) +     \
       32767) / 65535))
2561
#endif /* READ_COMPOSITE_NODIV */
2562

2563
#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
2564 2565 2566
PNG_EXPORT(201, png_uint_32, png_get_uint_32, (png_const_bytep buf));
PNG_EXPORT(202, png_uint_16, png_get_uint_16, (png_const_bytep buf));
PNG_EXPORT(203, png_int_32, png_get_int_32, (png_const_bytep buf));
2567 2568
#endif

2569
PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_const_structrp png_ptr,
2570
    png_const_bytep buf));
2571 2572
/* No png_get_int_16 -- may be added if there's a real need for it. */

2573
/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
2574
#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2575
PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i));
2576
#endif
2577
#ifdef PNG_SAVE_INT_32_SUPPORTED
2578
PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i));
2579
#endif
2580 2581

/* Place a 16-bit number into a buffer in PNG byte order.
2582
 * The parameter is declared unsigned int, not png_uint_16,
2583 2584
 * just to avoid potential problems on pre-ANSI C compilers.
 */
2585
#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2586
PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i));
2587
/* No png_save_int_16 -- may be added if there's a real need for it. */
2588
#endif
2589

2590 2591 2592 2593 2594
#ifdef PNG_USE_READ_MACROS
/* Inline macros to do direct reads of bytes from the input buffer.
 * The png_get_int_32() routine assumes we are using two's complement
 * format for negative values, which is almost certainly true.
 */
2595
#  define PNG_get_uint_32(buf) \
2596 2597 2598 2599
   (((png_uint_32)(*(buf)) << 24) + \
    ((png_uint_32)(*((buf) + 1)) << 16) + \
    ((png_uint_32)(*((buf) + 2)) << 8) + \
    ((png_uint_32)(*((buf) + 3))))
2600 2601 2602 2603

   /* From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
    * function) incorrectly returned a value of type png_uint_32.
    */
2604
#  define PNG_get_uint_16(buf) \
2605 2606 2607
   ((png_uint_16) \
    (((unsigned int)(*(buf)) << 8) + \
    ((unsigned int)(*((buf) + 1)))))
2608

2609
#  define PNG_get_int_32(buf) \
2610 2611 2612
   ((png_int_32)((*(buf) & 0x80) \
    ? -((png_int_32)(((png_get_uint_32(buf)^0xffffffffU)+1U)&0x7fffffffU)) \
    : (png_int_32)png_get_uint_32(buf)))
2613

2614 2615 2616
/* If PNG_PREFIX is defined the same thing as below happens in pnglibconf.h,
 * but defining a macro name prefixed with PNG_PREFIX.
 */
2617
#  ifndef PNG_PREFIX
2618 2619 2620
#    define png_get_uint_32(buf) PNG_get_uint_32(buf)
#    define png_get_uint_16(buf) PNG_get_uint_16(buf)
#    define png_get_int_32(buf)  PNG_get_int_32(buf)
2621 2622 2623
#  endif
#else
#  ifdef PNG_PREFIX
2624 2625 2626 2627
   /* No macros; revert to the (redefined) function */
#    define PNG_get_uint_32 (png_get_uint_32)
#    define PNG_get_uint_16 (png_get_uint_16)
#    define PNG_get_int_32  (png_get_int_32)
2628
#  endif
2629 2630
#endif

2631 2632 2633 2634 2635 2636 2637 2638 2639
#ifdef PNG_CHECK_FOR_INVALID_INDEX_SUPPORTED
PNG_EXPORT(242, void, png_set_check_for_invalid_index,
    (png_structrp png_ptr, int allowed));
#  ifdef PNG_GET_PALETTE_MAX_SUPPORTED
PNG_EXPORT(243, int, png_get_palette_max, (png_const_structp png_ptr,
    png_const_infop info_ptr));
#  endif
#endif /* CHECK_FOR_INVALID_INDEX */

2640
/*******************************************************************************
2641
 * Section 5: SIMPLIFIED API
2642 2643
 *******************************************************************************
 *
2644 2645
 * Please read the documentation in libpng-manual.txt (TODO: write said
 * documentation) if you don't understand what follows.
2646 2647 2648 2649 2650 2651 2652
 *
 * The simplified API hides the details of both libpng and the PNG file format
 * itself.  It allows PNG files to be read into a very limited number of
 * in-memory bitmap formats or to be written from the same formats.  If these
 * formats do not accomodate your needs then you can, and should, use the more
 * sophisticated APIs above - these support a wide variety of in-memory formats
 * and a wide variety of sophisticated transformations to those formats as well
2653
 * as a wide variety of APIs to manipulate ancillary information.
2654 2655 2656
 *
 * To read a PNG file using the simplified API:
 *
2657 2658 2659
 * 1) Declare a 'png_image' structure (see below) on the stack, set the
 *    version field to PNG_IMAGE_VERSION and the 'opaque' pointer to NULL
 *    (this is REQUIRED, your program may crash if you don't do it.)
2660
 * 2) Call the appropriate png_image_begin_read... function.
2661 2662 2663 2664
 * 3) Set the png_image 'format' member to the required sample format.
 * 4) Allocate a buffer for the image and, if required, the color-map.
 * 5) Call png_image_finish_read to read the image and, if required, the
 *    color-map into your buffers.
2665
 *
2666 2667 2668
 * There are no restrictions on the format of the PNG input itself; all valid
 * color types, bit depths, and interlace methods are acceptable, and the
 * input image is transformed as necessary to the requested in-memory format
2669 2670 2671 2672
 * during the png_image_finish_read() step.  The only caveat is that if you
 * request a color-mapped image from a PNG that is full-color or makes
 * complex use of an alpha channel the transformation is extremely lossy and the
 * result may look terrible.
2673
 *
2674 2675 2676 2677
 * To write a PNG file using the simplified API:
 *
 * 1) Declare a 'png_image' structure on the stack and memset() it to all zero.
 * 2) Initialize the members of the structure that describe the image, setting
2678
 *    the 'format' member to the format of the image samples.
2679
 * 3) Call the appropriate png_image_write... function with a pointer to the
2680
 *    image and, if necessary, the color-map to write the PNG data.
2681
 *
2682
 * png_image is a structure that describes the in-memory format of an image
2683
 * when it is being read or defines the in-memory format of an image that you
2684 2685
 * need to write:
 */
2686 2687 2688
#if defined(PNG_SIMPLIFIED_READ_SUPPORTED) || \
    defined(PNG_SIMPLIFIED_WRITE_SUPPORTED)

2689
#define PNG_IMAGE_VERSION 1
2690

2691 2692 2693
typedef struct png_control *png_controlp;
typedef struct
{
2694 2695 2696 2697 2698 2699 2700 2701
   png_controlp opaque;    /* Initialize to NULL, free with png_image_free */
   png_uint_32  version;   /* Set to PNG_IMAGE_VERSION */
   png_uint_32  width;     /* Image width in pixels (columns) */
   png_uint_32  height;    /* Image height in pixels (rows) */
   png_uint_32  format;    /* Image format as defined below */
   png_uint_32  flags;     /* A bit mask containing informational flags */
   png_uint_32  colormap_entries;
                           /* Number of entries in the color-map */
2702

2703 2704
   /* In the event of an error or warning the following field will be set to a
    * non-zero value and the 'message' field will contain a '\0' terminated
2705 2706 2707 2708
    * string with the libpng error or warning message.  If both warnings and
    * an error were encountered, only the error is recorded.  If there
    * are multiple warnings, only the first one is recorded.
    *
2709 2710 2711 2712 2713 2714
    * The upper 30 bits of this value are reserved, the low two bits contain
    * a value as follows:
    */
#  define PNG_IMAGE_WARNING 1
#  define PNG_IMAGE_ERROR 2
   /*
2715
    * The result is a two-bit code such that a value more than 1 indicates
2716 2717
    * a failure in the API just called:
    *
2718
    *    0 - no warning or error
2719 2720 2721
    *    1 - warning
    *    2 - error
    *    3 - error preceded by warning
2722
    */
2723 2724
#  define PNG_IMAGE_FAILED(png_cntrl) ((((png_cntrl).warning_or_error)&0x03)>1)

2725
   png_uint_32  warning_or_error;
2726

2727 2728 2729
   char         message[64];
} png_image, *png_imagep;

2730 2731
/* The samples of the image have one to four channels whose components have
 * original values in the range 0 to 1.0:
2732 2733 2734 2735 2736 2737
 *
 * 1: A single gray or luminance channel (G).
 * 2: A gray/luminance channel and an alpha channel (GA).
 * 3: Three red, green, blue color channels (RGB).
 * 4: Three color channels and an alpha channel (RGBA).
 *
2738
 * The components are encoded in one of two ways:
2739
 *
2740
 * a) As a small integer, value 0..255, contained in a single byte.  For the
2741
 * alpha channel the original value is simply value/255.  For the color or
2742 2743 2744
 * luminance channels the value is encoded according to the sRGB specification
 * and matches the 8-bit format expected by typical display devices.
 *
2745
 * The color/gray channels are not scaled (pre-multiplied) by the alpha
2746 2747
 * channel and are suitable for passing to color management software.
 *
2748
 * b) As a value in the range 0..65535, contained in a 2-byte integer.  All
2749 2750 2751 2752 2753
 * channels can be converted to the original value by dividing by 65535; all
 * channels are linear.  Color channels use the RGB encoding (RGB end-points) of
 * the sRGB specification.  This encoding is identified by the
 * PNG_FORMAT_FLAG_LINEAR flag below.
 *
2754 2755
 * When the simplified API needs to convert between sRGB and linear colorspaces,
 * the actual sRGB transfer curve defined in the sRGB specification (see the
V
Viktor Szakats 已提交
2756
 * article at https://en.wikipedia.org/wiki/SRGB) is used, not the gamma=1/2.2
2757 2758 2759
 * approximation used elsewhere in libpng.
 *
 * When an alpha channel is present it is expected to denote pixel coverage
2760
 * of the color or luminance channels and is returned as an associated alpha
2761 2762
 * channel: the color/gray channels are scaled (pre-multiplied) by the alpha
 * value.
2763 2764 2765 2766 2767 2768
 *
 * The samples are either contained directly in the image data, between 1 and 8
 * bytes per pixel according to the encoding, or are held in a color-map indexed
 * by bytes in the image data.  In the case of a color-map the color-map entries
 * are individual samples, encoded as above, and the image data has one byte per
 * pixel to select the relevant sample from the color-map.
2769 2770 2771 2772 2773
 */

/* PNG_FORMAT_*
 *
 * #defines to be used in png_image::format.  Each #define identifies a
2774 2775
 * particular layout of sample data and, if present, alpha values.  There are
 * separate defines for each of the two component encodings.
2776
 *
2777 2778 2779 2780 2781 2782 2783 2784 2785 2786
 * A format is built up using single bit flag values.  All combinations are
 * valid.  Formats can be built up from the flag values or you can use one of
 * the predefined values below.  When testing formats always use the FORMAT_FLAG
 * macros to test for individual features - future versions of the library may
 * add new flags.
 *
 * When reading or writing color-mapped images the format should be set to the
 * format of the entries in the color-map then png_image_{read,write}_colormap
 * called to read or write the color-map and set the format correctly for the
 * image data.  Do not set the PNG_FORMAT_FLAG_COLORMAP bit directly!
2787
 *
2788
 * NOTE: libpng can be built with particular features disabled. If you see
2789 2790 2791
 * compiler errors because the definition of one of the following flags has been
 * compiled out it is because libpng does not have the required support.  It is
 * possible, however, for the libpng configuration to enable the format on just
2792
 * read or just write; in that case you may see an error at run time.  You can
2793 2794
 * guard against this by checking for the definition of the appropriate
 * "_SUPPORTED" macro, one of:
2795 2796 2797
 *
 *    PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED
 */
2798 2799
#define PNG_FORMAT_FLAG_ALPHA    0x01U /* format with an alpha channel */
#define PNG_FORMAT_FLAG_COLOR    0x02U /* color format: otherwise grayscale */
2800
#define PNG_FORMAT_FLAG_LINEAR   0x04U /* 2-byte channels else 1-byte */
2801
#define PNG_FORMAT_FLAG_COLORMAP 0x08U /* image data is color-mapped */
2802 2803

#ifdef PNG_FORMAT_BGR_SUPPORTED
2804
#  define PNG_FORMAT_FLAG_BGR    0x10U /* BGR colors, else order is RGB */
2805 2806 2807
#endif

#ifdef PNG_FORMAT_AFIRST_SUPPORTED
2808
#  define PNG_FORMAT_FLAG_AFIRST 0x20U /* alpha channel comes first */
2809 2810
#endif

2811
/* Commonly used formats have predefined macros.
2812
 *
2813
 * First the single byte (sRGB) formats:
2814 2815 2816
 */
#define PNG_FORMAT_GRAY 0
#define PNG_FORMAT_GA   PNG_FORMAT_FLAG_ALPHA
2817
#define PNG_FORMAT_AG   (PNG_FORMAT_GA|PNG_FORMAT_FLAG_AFIRST)
2818 2819 2820 2821 2822 2823 2824
#define PNG_FORMAT_RGB  PNG_FORMAT_FLAG_COLOR
#define PNG_FORMAT_BGR  (PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_BGR)
#define PNG_FORMAT_RGBA (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_ALPHA)
#define PNG_FORMAT_ARGB (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_AFIRST)
#define PNG_FORMAT_BGRA (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_ALPHA)
#define PNG_FORMAT_ABGR (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_AFIRST)

2825 2826
/* Then the linear 2-byte formats.  When naming these "Y" is used to
 * indicate a luminance (gray) channel.
2827
 */
2828 2829 2830 2831 2832
#define PNG_FORMAT_LINEAR_Y PNG_FORMAT_FLAG_LINEAR
#define PNG_FORMAT_LINEAR_Y_ALPHA (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_ALPHA)
#define PNG_FORMAT_LINEAR_RGB (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR)
#define PNG_FORMAT_LINEAR_RGB_ALPHA \
   (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA)
2833

2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845
/* With color-mapped formats the image data is one byte for each pixel, the byte
 * is an index into the color-map which is formatted as above.  To obtain a
 * color-mapped format it is sufficient just to add the PNG_FOMAT_FLAG_COLORMAP
 * to one of the above definitions, or you can use one of the definitions below.
 */
#define PNG_FORMAT_RGB_COLORMAP  (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_COLORMAP)
#define PNG_FORMAT_BGR_COLORMAP  (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_COLORMAP)
#define PNG_FORMAT_RGBA_COLORMAP (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_COLORMAP)
#define PNG_FORMAT_ARGB_COLORMAP (PNG_FORMAT_ARGB|PNG_FORMAT_FLAG_COLORMAP)
#define PNG_FORMAT_BGRA_COLORMAP (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_COLORMAP)
#define PNG_FORMAT_ABGR_COLORMAP (PNG_FORMAT_ABGR|PNG_FORMAT_FLAG_COLORMAP)

2846 2847
/* PNG_IMAGE macros
 *
2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862
 * These are convenience macros to derive information from a png_image
 * structure.  The PNG_IMAGE_SAMPLE_ macros return values appropriate to the
 * actual image sample values - either the entries in the color-map or the
 * pixels in the image.  The PNG_IMAGE_PIXEL_ macros return corresponding values
 * for the pixels and will always return 1 for color-mapped formats.  The
 * remaining macros return information about the rows in the image and the
 * complete image.
 *
 * NOTE: All the macros that take a png_image::format parameter are compile time
 * constants if the format parameter is, itself, a constant.  Therefore these
 * macros can be used in array declarations and case labels where required.
 * Similarly the macros are also pre-processor constants (sizeof is not used) so
 * they can be used in #if tests.
 *
 * First the information about the samples.
2863
 */
2864 2865
#define PNG_IMAGE_SAMPLE_CHANNELS(fmt)\
   (((fmt)&(PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA))+1)
2866 2867
   /* Return the total number of channels in a given format: 1..4 */

2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879
#define PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt)\
   ((((fmt) & PNG_FORMAT_FLAG_LINEAR) >> 2)+1)
   /* Return the size in bytes of a single component of a pixel or color-map
    * entry (as appropriate) in the image: 1 or 2.
    */

#define PNG_IMAGE_SAMPLE_SIZE(fmt)\
   (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt))
   /* This is the size of the sample data for one sample.  If the image is
    * color-mapped it is the size of one color-map entry (and image pixels are
    * one byte in size), otherwise it is the size of one image pixel.
    */
2880

2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915
#define PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)\
   (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * 256)
   /* The maximum size of the color-map required by the format expressed in a
    * count of components.  This can be used to compile-time allocate a
    * color-map:
    *
    * png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)];
    *
    * png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)];
    *
    * Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the
    * information from one of the png_image_begin_read_ APIs and dynamically
    * allocate the required memory.
    */

/* Corresponding information about the pixels */
#define PNG_IMAGE_PIXEL_(test,fmt)\
   (((fmt)&PNG_FORMAT_FLAG_COLORMAP)?1:test(fmt))

#define PNG_IMAGE_PIXEL_CHANNELS(fmt)\
   PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_CHANNELS,fmt)
   /* The number of separate channels (components) in a pixel; 1 for a
    * color-mapped image.
    */

#define PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)\
   PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_COMPONENT_SIZE,fmt)
   /* The size, in bytes, of each component in a pixel; 1 for a color-mapped
    * image.
    */

#define PNG_IMAGE_PIXEL_SIZE(fmt) PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_SIZE,fmt)
   /* The size, in bytes, of a complete pixel; 1 for a color-mapped image. */

/* Information about the whole row, or whole image */
2916
#define PNG_IMAGE_ROW_STRIDE(image)\
2917
   (PNG_IMAGE_PIXEL_CHANNELS((image).format) * (image).width)
2918 2919
   /* Return the total number of components in a single row of the image; this
    * is the minimum 'row stride', the minimum count of components between each
2920
    * row.  For a color-mapped image this is the minimum number of bytes in a
2921
    * row.
2922 2923 2924 2925
    *
    * WARNING: this macro overflows for some images with more than one component
    * and very large image widths.  libpng will refuse to process an image where
    * this macro would overflow.
2926
    */
2927 2928

#define PNG_IMAGE_BUFFER_SIZE(image, row_stride)\
2929
   (PNG_IMAGE_PIXEL_COMPONENT_SIZE((image).format)*(image).height*(row_stride))
2930
   /* Return the size, in bytes, of an image buffer given a png_image and a row
2931
    * stride - the number of components to leave space for in each row.
2932 2933 2934
    *
    * WARNING: this macro overflows a 32-bit integer for some large PNG images,
    * libpng will refuse to process an image where such an overflow would occur.
2935
    */
2936

2937 2938 2939 2940 2941 2942
#define PNG_IMAGE_SIZE(image)\
   PNG_IMAGE_BUFFER_SIZE(image, PNG_IMAGE_ROW_STRIDE(image))
   /* Return the size, in bytes, of the image in memory given just a png_image;
    * the row stride is the minimum stride required for the image.
    */

2943 2944 2945 2946 2947 2948 2949 2950
#define PNG_IMAGE_COLORMAP_SIZE(image)\
   (PNG_IMAGE_SAMPLE_SIZE((image).format) * (image).colormap_entries)
   /* Return the size, in bytes, of the color-map of this image.  If the image
    * format is not a color-map format this will return a size sufficient for
    * 256 entries in the given format; check PNG_FORMAT_FLAG_COLORMAP if
    * you don't want to allocate a color-map in this case.
    */

2951 2952 2953 2954 2955
/* PNG_IMAGE_FLAG_*
 *
 * Flags containing additional information about the image are held in the
 * 'flags' field of png_image.
 */
2956
#define PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB 0x01
2957 2958 2959 2960
   /* This indicates the the RGB values of the in-memory bitmap do not
    * correspond to the red, green and blue end-points defined by sRGB.
    */

2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971
#define PNG_IMAGE_FLAG_FAST 0x02
   /* On write emphasise speed over compression; the resultant PNG file will be
    * larger but will be produced significantly faster, particular for large
    * images.  Do not use this option for images which will be distributed, only
    * used it when producing intermediate files that will be read back in
    * repeatedly.  For a typical 24-bit image the option will double the read
    * speed at the cost of increasing the image size by 25%, however for many
    * more compressible images the PNG file can be 10 times larger with only a
    * slight speed gain.
    */

2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989
#define PNG_IMAGE_FLAG_16BIT_sRGB 0x04
   /* On read if the image is a 16-bit per component image and there is no gAMA
    * or sRGB chunk assume that the components are sRGB encoded.  Notice that
    * images output by the simplified API always have gamma information; setting
    * this flag only affects the interpretation of 16-bit images from an
    * external source.  It is recommended that the application expose this flag
    * to the user; the user can normally easily recognize the difference between
    * linear and sRGB encoding.  This flag has no effect on write - the data
    * passed to the write APIs must have the correct encoding (as defined
    * above.)
    *
    * If the flag is not set (the default) input 16-bit per component data is
    * assumed to be linear.
    *
    * NOTE: the flag can only be set after the png_image_begin_read_ call,
    * because that call initializes the 'flags' field.
    */

2990 2991 2992 2993 2994
#ifdef PNG_SIMPLIFIED_READ_SUPPORTED
/* READ APIs
 * ---------
 *
 * The png_image passed to the read APIs must have been initialized by setting
2995
 * the png_controlp field 'opaque' to NULL (or, safer, memset the whole thing.)
2996 2997 2998 2999
 */
#ifdef PNG_STDIO_SUPPORTED
PNG_EXPORT(234, int, png_image_begin_read_from_file, (png_imagep image,
   const char *file_name));
3000 3001
   /* The named file is opened for read and the image header is filled in
    * from the PNG header in the file.
3002
    */
3003 3004 3005 3006

PNG_EXPORT(235, int, png_image_begin_read_from_stdio, (png_imagep image,
   FILE* file));
   /* The PNG header is read from the stdio FILE object. */
3007
#endif /* STDIO */
3008 3009 3010 3011 3012 3013

PNG_EXPORT(236, int, png_image_begin_read_from_memory, (png_imagep image,
   png_const_voidp memory, png_size_t size));
   /* The PNG header is read from the given memory buffer. */

PNG_EXPORT(237, int, png_image_finish_read, (png_imagep image,
3014 3015
   png_const_colorp background, void *buffer, png_int_32 row_stride,
   void *colormap));
3016 3017 3018
   /* Finish reading the image into the supplied buffer and clean up the
    * png_image structure.
    *
3019
    * row_stride is the step, in byte or 2-byte units as appropriate,
3020 3021 3022 3023 3024 3025 3026 3027 3028 3029
    * between adjacent rows.  A positive stride indicates that the top-most row
    * is first in the buffer - the normal top-down arrangement.  A negative
    * stride indicates that the bottom-most row is first in the buffer.
    *
    * background need only be supplied if an alpha channel must be removed from
    * a png_byte format and the removal is to be done by compositing on a solid
    * color; otherwise it may be NULL and any composition will be done directly
    * onto the buffer.  The value is an sRGB color to use for the background,
    * for grayscale output the green channel is used.
    *
3030 3031 3032 3033 3034 3035 3036 3037 3038
    * background must be supplied when an alpha channel must be removed from a
    * single byte color-mapped output format, in other words if:
    *
    * 1) The original format from png_image_begin_read_from_* had
    *    PNG_FORMAT_FLAG_ALPHA set.
    * 2) The format set by the application does not.
    * 3) The format set by the application has PNG_FORMAT_FLAG_COLORMAP set and
    *    PNG_FORMAT_FLAG_LINEAR *not* set.
    *
3039
    * For linear output removing the alpha channel is always done by compositing
3040
    * on black and background is ignored.
3041 3042 3043 3044 3045
    *
    * colormap must be supplied when PNG_FORMAT_FLAG_COLORMAP is set.  It must
    * be at least the size (in bytes) returned by PNG_IMAGE_COLORMAP_SIZE.
    * image->colormap_entries will be updated to the actual number of entries
    * written to the colormap; this may be less than the original value.
3046 3047 3048 3049
    */

PNG_EXPORT(238, void, png_image_free, (png_imagep image));
   /* Free any data allocated by libpng in image->opaque, setting the pointer to
3050 3051
    * NULL.  May be called at any time after the structure is initialized.
    */
3052
#endif /* SIMPLIFIED_READ */
3053 3054 3055 3056 3057

#ifdef PNG_SIMPLIFIED_WRITE_SUPPORTED
/* WRITE APIS
 * ----------
 * For write you must initialize a png_image structure to describe the image to
3058 3059
 * be written.  To do this use memset to set the whole structure to 0 then
 * initialize fields describing your image.
3060
 *
3061
 * version: must be set to PNG_IMAGE_VERSION
3062 3063 3064
 * opaque: must be initialized to NULL
 * width: image width in pixels
 * height: image height in rows
3065
 * format: the format of the data (image and color-map) you wish to write
3066 3067 3068
 * flags: set to 0 unless one of the defined flags applies; set
 *    PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images where the RGB
 *    values do not correspond to the colors in sRGB.
3069
 * colormap_entries: set to the number of entries in the color-map (0 to 256)
3070
 */
3071
#ifdef PNG_SIMPLIFIED_WRITE_STDIO_SUPPORTED
3072 3073
PNG_EXPORT(239, int, png_image_write_to_file, (png_imagep image,
   const char *file, int convert_to_8bit, const void *buffer,
3074
   png_int_32 row_stride, const void *colormap));
3075 3076 3077
   /* Write the image to the named file. */

PNG_EXPORT(240, int, png_image_write_to_stdio, (png_imagep image, FILE *file,
3078 3079
   int convert_to_8_bit, const void *buffer, png_int_32 row_stride,
   const void *colormap));
3080
   /* Write the image to the given (FILE*). */
3081
#endif /* SIMPLIFIED_WRITE_STDIO */
3082

3083
/* With all write APIs if image is in one of the linear formats with 16-bit
3084 3085 3086 3087 3088 3089 3090 3091
 * data then setting convert_to_8_bit will cause the output to be an 8-bit PNG
 * gamma encoded according to the sRGB specification, otherwise a 16-bit linear
 * encoded PNG file is written.
 *
 * With color-mapped data formats the colormap parameter point to a color-map
 * with at least image->colormap_entries encoded in the specified format.  If
 * the format is linear the written PNG color-map will be converted to sRGB
 * regardless of the convert_to_8_bit flag.
3092 3093
 *
 * With all APIs row_stride is handled as in the read APIs - it is the spacing
3094
 * from one row to the next in component sized units (1 or 2 bytes) and if
3095 3096 3097
 * negative indicates a bottom-up row layout in the buffer.  If row_stride is
 * zero, libpng will calculate it for you from the image width and number of
 * channels.
3098
 *
3099
 * Note that the write API does not support interlacing, sub-8-bit pixels or
3100
 * most ancillary chunks.  If you need to write text chunks (e.g. for copyright
3101
 * notices) you need to use one of the other APIs.
3102
 */
3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135

PNG_EXPORT(245, int, png_image_write_to_memory, (png_imagep image, void *memory,
   png_alloc_size_t * PNG_RESTRICT memory_bytes, int convert_to_8_bit,
   const void *buffer, png_int_32 row_stride, const void *colormap));
   /* Write the image to the given memory buffer.  The function both writes the
    * whole PNG data stream to *memory and updates *memory_bytes with the count
    * of bytes written.
    *
    * 'memory' may be NULL.  In this case *memory_bytes is not read however on
    * success the number of bytes which would have been written will still be
    * stored in *memory_bytes.  On failure *memory_bytes will contain 0.
    *
    * If 'memory' is not NULL it must point to memory[*memory_bytes] of
    * writeable memory.
    *
    * If the function returns success memory[*memory_bytes] (if 'memory' is not
    * NULL) contains the written PNG data.  *memory_bytes will always be less
    * than or equal to the original value.
    *
    * If the function returns false and *memory_bytes was not changed an error
    * occured during write.  If *memory_bytes was changed, or is not 0 if
    * 'memory' was NULL, the write would have succeeded but for the memory
    * buffer being too small.  *memory_bytes contains the required number of
    * bytes and will be bigger that the original value.
    */

#define png_image_write_get_memory_size(image, size, convert_to_8_bit, buffer,\
   row_stride, colormap)\
   png_image_write_to_memory(&(image), 0, &(size), convert_to_8_bit, buffer,\
         row_stride, colormap)
   /* Return the amount of memory in 'size' required to compress this image.
    * The png_image structure 'image' must be filled in as in the above
    * function and must not be changed before the actual write call, the buffer
3136
    * and all other parameters must also be identical to that in the final
3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161
    * write call.  The 'size' variable need not be initialized.
    *
    * NOTE: the macro returns true/false, if false is returned 'size' will be
    * set to zero and the write failed and probably will fail if tried again.
    */

/* You can pre-allocate the buffer by making sure it is of sufficient size
 * regardless of the amount of compression achieved.  The buffer size will
 * always be bigger than the original image and it will never be filled.  The
 * following macros are provided to assist in allocating the buffer.
 */
#define PNG_IMAGE_DATA_SIZE(image) (PNG_IMAGE_SIZE(image)+(image).height)
   /* The number of uncompressed bytes in the PNG byte encoding of the image;
    * uncompressing the PNG IDAT data will give this number of bytes.
    *
    * NOTE: while PNG_IMAGE_SIZE cannot overflow for an image in memory this
    * macro can because of the extra bytes used in the PNG byte encoding.  You
    * need to avoid this macro if your image size approaches 2^30 in width or
    * height.  The same goes for the remainder of these macros; they all produce
    * bigger numbers than the actual in-memory image size.
    */
#ifndef PNG_ZLIB_MAX_SIZE
#  define PNG_ZLIB_MAX_SIZE(b) ((b)+(((b)+7U)>>3)+(((b)+63U)>>6)+11U)
   /* An upper bound on the number of compressed bytes given 'b' uncompressed
    * bytes.  This is based on deflateBounds() in zlib; different
3162
    * implementations of zlib compression may conceivably produce more data so
3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174
    * if your zlib implementation is not zlib itself redefine this macro
    * appropriately.
    */
#endif

#define PNG_IMAGE_COMPRESSED_SIZE_MAX(image)\
   PNG_ZLIB_MAX_SIZE((png_alloc_size_t)PNG_IMAGE_DATA_SIZE(image))
   /* An upper bound on the size of the data in the PNG IDAT chunks. */

#define PNG_IMAGE_PNG_SIZE_MAX_(image, image_size)\
   ((8U/*sig*/+25U/*IHDR*/+16U/*gAMA*/+44U/*cHRM*/+12U/*IEND*/+\
    (((image).format&PNG_FORMAT_FLAG_COLORMAP)?/*colormap: PLTE, tRNS*/\
3175 3176 3177
    12U+3U*(image).colormap_entries/*PLTE data*/+\
    (((image).format&PNG_FORMAT_FLAG_ALPHA)?\
    12U/*tRNS*/+(image).colormap_entries:0U):0U)+\
3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191
    12U)+(12U*((image_size)/PNG_ZBUF_SIZE))/*IDAT*/+(image_size))
   /* A helper for the following macro; if your compiler cannot handle the
    * following macro use this one with the result of
    * PNG_IMAGE_COMPRESSED_SIZE_MAX(image) as the second argument (most
    * compilers should handle this just fine.)
    */

#define PNG_IMAGE_PNG_SIZE_MAX(image)\
   PNG_IMAGE_PNG_SIZE_MAX_(image, PNG_IMAGE_COMPRESSED_SIZE_MAX(image))
   /* An upper bound on the total length of the PNG data stream for 'image'.
    * The result is of type png_alloc_size_t, on 32-bit systems this may
    * overflow even though PNG_IMAGE_DATA_SIZE does not overflow; the write will
    * run out of buffer space but return a corrected size which should work.
    */
3192
#endif /* SIMPLIFIED_WRITE */
3193 3194 3195
/*******************************************************************************
 *  END OF SIMPLIFIED API
 ******************************************************************************/
3196
#endif /* SIMPLIFIED_{READ|WRITE} */
3197

3198
/*******************************************************************************
3199
 * Section 6: IMPLEMENTATION OPTIONS
3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222
 *******************************************************************************
 *
 * Support for arbitrary implementation-specific optimizations.  The API allows
 * particular options to be turned on or off.  'Option' is the number of the
 * option and 'onoff' is 0 (off) or non-0 (on).  The value returned is given
 * by the PNG_OPTION_ defines below.
 *
 * HARDWARE: normally hardware capabilites, such as the Intel SSE instructions,
 *           are detected at run time, however sometimes it may be impossible
 *           to do this in user mode, in which case it is necessary to discover
 *           the capabilities in an OS specific way.  Such capabilities are
 *           listed here when libpng has support for them and must be turned
 *           ON by the application if present.
 *
 * SOFTWARE: sometimes software optimizations actually result in performance
 *           decrease on some architectures or systems, or with some sets of
 *           PNG images.  'Software' options allow such optimizations to be
 *           selected at run time.
 */
#ifdef PNG_SET_OPTION_SUPPORTED
#ifdef PNG_ARM_NEON_API_SUPPORTED
#  define PNG_ARM_NEON   0 /* HARDWARE: ARM Neon SIMD instructions supported */
#endif
3223
#define PNG_MAXIMUM_INFLATE_WINDOW 2 /* SOFTWARE: force maximum window */
3224
#define PNG_SKIP_sRGB_CHECK_PROFILE 4 /* SOFTWARE: Check ICC profile for sRGB */
3225 3226 3227
#ifdef PNG_MIPS_MSA_API_SUPPORTED
#  define PNG_MIPS_MSA   6 /* HARDWARE: MIPS Msa SIMD instructions supported */
#endif
3228
#define PNG_IGNORE_ADLER32 8
3229 3230 3231 3232
#ifdef PNG_POWERPC_VSX_API_SUPPORTED
#  define PNG_POWERPC_VSX   10 /* HARDWARE: PowerPC VSX SIMD instructions supported */
#endif
#define PNG_OPTION_NEXT  12 /* Next option - numbers must be even */
3233 3234 3235 3236 3237 3238 3239 3240 3241

/* Return values: NOTE: there are four values and 'off' is *not* zero */
#define PNG_OPTION_UNSET   0 /* Unset - defaults to off */
#define PNG_OPTION_INVALID 1 /* Option number out of range */
#define PNG_OPTION_OFF     2
#define PNG_OPTION_ON      3

PNG_EXPORT(244, int, png_set_option, (png_structrp png_ptr, int option,
   int onoff));
3242
#endif /* SET_OPTION */
3243 3244

/*******************************************************************************
3245
 *  END OF HARDWARE AND SOFTWARE OPTIONS
3246 3247
 ******************************************************************************/

3248 3249
/* Maintainer: Put new public prototypes here ^, in libpng.3, in project
 * defs, and in scripts/symbols.def.
G
[devel]  
Glenn Randers-Pehrson 已提交
3250 3251
 */

3252
/* The last ordinal number (this is the *last* one already used; the next
3253
 * one to use is one more than this.)
3254 3255
 */
#ifdef PNG_EXPORT_LAST_ORDINAL
3256
  PNG_EXPORT_LAST_ORDINAL(245);
3257 3258
#endif

A
Andreas Dilger 已提交
3259 3260 3261 3262
#ifdef __cplusplus
}
#endif

3263
#endif /* PNG_VERSION_INFO_ONLY */
3264
/* Do not put anything past this line */
3265
#endif /* PNG_H */