png.h 86.8 KB
Newer Older
1

A
Andreas Dilger 已提交
2
/* png.h - header file for PNG reference library
3
 *
4
 * libpng version 1.5.0beta56 - November 21, 2010
5
 * Copyright (c) 1998-2010 Glenn Randers-Pehrson
6 7
 * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)
 * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
8
 *
9
 * This code is released under the libpng license (See LICENSE, below)
10
 *
11
 * Authors and maintainers:
12 13
 *   libpng versions 0.71, May 1995, through 0.88, January 1996: Guy Schalnat
 *   libpng versions 0.89c, June 1996, through 0.96, May 1997: Andreas Dilger
14
 *   libpng versions 0.97, January 1998, through 1.5.0beta56 - November 21, 2010: Glenn
15
 *   See also "Contributing Authors", below.
16
 *
17
 * Note about libpng version numbers:
18
 *
19 20 21 22 23
 *   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:
24
 *
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
 *    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)
57 58 59 60 61 62 63 64 65 66 67
 *    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.8beta1-4             1    10008  2.1.0.8beta1-4
 *    1.0.8rc1                 1    10008  2.1.0.8rc1
 *    1.0.8                    1    10008  2.1.0.8
 *    1.0.9beta1-6             1    10009  2.1.0.9beta1-6
 *    1.0.9rc1                 1    10009  2.1.0.9rc1
 *    1.0.9beta7-10            1    10009  2.1.0.9beta7-10
 *    1.0.9rc2                 1    10009  2.1.0.9rc2
68
 *    1.0.9                    1    10009  2.1.0.9
69
 *    1.0.10beta1              1    10010  2.1.0.10beta1
70
 *    1.0.10rc1                1    10010  2.1.0.10rc1
71
 *    1.0.10                   1    10010  2.1.0.10
72
 *    1.0.11beta1-3            1    10011  2.1.0.11beta1-3
73
 *    1.0.11rc1                1    10011  2.1.0.11rc1
74
 *    1.0.11                   1    10011  2.1.0.11
75 76 77 78
 *    1.0.12beta1-2            2    10012  2.1.0.12beta1-2
 *    1.0.12rc1                2    10012  2.1.0.12rc1
 *    1.0.12                   2    10012  2.1.0.12
 *    1.1.0a-f                 -    10100  2.1.1.0a-f (branch abandoned)
79
 *    1.2.0beta1-2             2    10200  2.1.2.0beta1-2
80 81 82
 *    1.2.0beta3-5             3    10200  3.1.2.0beta3-5
 *    1.2.0rc1                 3    10200  3.1.2.0rc1
 *    1.2.0                    3    10200  3.1.2.0
83
 *    1.2.1beta1-4             3    10201  3.1.2.1beta1-4
84 85
 *    1.2.1rc1-2               3    10201  3.1.2.1rc1-2
 *    1.2.1                    3    10201  3.1.2.1
86
 *    1.2.2beta1-6            12    10202  12.so.0.1.2.2beta1-6
87 88 89
 *    1.0.13beta1             10    10013  10.so.0.1.0.13beta1
 *    1.0.13rc1               10    10013  10.so.0.1.0.13rc1
 *    1.2.2rc1                12    10202  12.so.0.1.2.2rc1
90 91
 *    1.0.13                  10    10013  10.so.0.1.0.13
 *    1.2.2                   12    10202  12.so.0.1.2.2
92 93
 *    1.2.3rc1-6              12    10203  12.so.0.1.2.3rc1-6
 *    1.2.3                   12    10203  12.so.0.1.2.3
94
 *    1.2.4beta1-3            13    10204  12.so.0.1.2.4beta1-3
95 96
 *    1.0.14rc1               13    10014  10.so.0.1.0.14rc1
 *    1.2.4rc1                13    10204  12.so.0.1.2.4rc1
97 98
 *    1.0.14                  10    10014  10.so.0.1.0.14
 *    1.2.4                   13    10204  12.so.0.1.2.4
99
 *    1.2.5beta1-2            13    10205  12.so.0.1.2.5beta1-2
100
 *    1.0.15rc1-3             10    10015  10.so.0.1.0.15rc1-3
101 102 103
 *    1.2.5rc1-3              13    10205  12.so.0.1.2.5rc1-3
 *    1.0.15                  10    10015  10.so.0.1.0.15
 *    1.2.5                   13    10205  12.so.0.1.2.5
104
 *    1.2.6beta1-4            13    10206  12.so.0.1.2.6beta1-4
105 106
 *    1.0.16                  10    10016  10.so.0.1.0.16
 *    1.2.6                   13    10206  12.so.0.1.2.6
107
 *    1.2.7beta1-2            13    10207  12.so.0.1.2.7beta1-2
108 109
 *    1.0.17rc1               10    10017  12.so.0.1.0.17rc1
 *    1.2.7rc1                13    10207  12.so.0.1.2.7rc1
110 111
 *    1.0.17                  10    10017  12.so.0.1.0.17
 *    1.2.7                   13    10207  12.so.0.1.2.7
112
 *    1.2.8beta1-5            13    10208  12.so.0.1.2.8beta1-5
113 114
 *    1.0.18rc1-5             10    10018  12.so.0.1.0.18rc1-5
 *    1.2.8rc1-5              13    10208  12.so.0.1.2.8rc1-5
115 116
 *    1.0.18                  10    10018  12.so.0.1.0.18
 *    1.2.8                   13    10208  12.so.0.1.2.8
117
 *    1.2.9beta1-3            13    10209  12.so.0.1.2.9beta1-3
118
 *    1.2.9beta4-11           13    10209  12.so.0.9[.0]
119
 *    1.2.9rc1                13    10209  12.so.0.9[.0]
120
 *    1.2.9                   13    10209  12.so.0.9[.0]
121
 *    1.2.10beta1-7           13    10210  12.so.0.10[.0]
122
 *    1.2.10rc1-2             13    10210  12.so.0.10[.0]
123
 *    1.2.10                  13    10210  12.so.0.10[.0]
124
 *    1.4.0beta1-5            14    10400  14.so.0.0[.0]
125
 *    1.2.11beta1-4           13    10211  12.so.0.11[.0]
126
 *    1.4.0beta7-8            14    10400  14.so.0.0[.0]
127 128
 *    1.2.11                  13    10211  12.so.0.11[.0]
 *    1.2.12                  13    10212  12.so.0.12[.0]
129
 *    1.4.0beta9-14           14    10400  14.so.0.0[.0]
130
 *    1.2.13                  13    10213  12.so.0.13[.0]
131
 *    1.4.0beta15-36          14    10400  14.so.0.0[.0]
132
 *    1.4.0beta37-87          14    10400  14.so.14.0[.0]
133
 *    1.4.0rc01               14    10400  14.so.14.0[.0]
134
 *    1.4.0beta88-109         14    10400  14.so.14.0[.0]
135
 *    1.4.0rc02-08            14    10400  14.so.14.0[.0]
136
 *    1.4.0                   14    10400  14.so.14.0[.0]
137 138
 *    1.4.1beta01-03          14    10401  14.so.14.1[.0]
 *    1.4.1rc01               14    10401  14.so.14.1[.0]
139
 *    1.4.1beta04-12          14    10401  14.so.14.1[.0]
140
 *    1.4.1                   14    10401  14.so.14.1[.0]
141 142
 *    1.4.2                   14    10402  14.so.14.2[.0]
 *    1.4.3                   14    10403  14.so.14.3[.0]
143 144
 *    1.4.4                   14    10404  14.so.14.4[.0]
 *    1.5.0beta01-56          15    10500  15.so.15.0[.0]
145
 *
146 147 148 149 150 151 152 153 154
 *   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 "rcN".
155
 *
156 157 158
 *   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.
159
 *
160 161
 *   DLLNUM will change each time there are forward or backward changes
 *   in binary compatibility (e.g., when a new feature is added).
162
 *
163 164 165
 * See libpng-manual.txt or libpng.3 for more information.  The PNG
 * specification is available as a W3C Recommendation and as an ISO
 * Specification, <http://www.w3.org/TR/2003/REC-PNG-20031110/
166 167 168
 */

/*
169 170
 * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
 *
171 172
 * If you modify libpng you may insert additional notices immediately following
 * this sentence.
173
 *
174 175
 * This code is released under the libpng license.
 *
176
 * libpng versions 1.2.6, August 15, 2004, through 1.5.0beta56, November 21, 2010, are
177
 * Copyright (c) 2004, 2006-2010 Glenn Randers-Pehrson, and are
178
 * distributed according to the same disclaimer and license as libpng-1.2.5
179
 * with the following individual added to the list of Contributing Authors:
180 181 182
 *
 *    Cosmin Truta
 *
183
 * libpng versions 1.0.7, July 1, 2000, through 1.2.5, October 3, 2002, are
184
 * Copyright (c) 2000-2002 Glenn Randers-Pehrson, and are
185
 * distributed according to the same disclaimer and license as libpng-1.0.6
186
 * with the following individuals added to the list of Contributing Authors:
187
 *
188 189 190 191
 *    Simon-Pierre Cadieux
 *    Eric S. Raymond
 *    Gilles Vollant
 *
192 193 194 195 196 197 198 199 200 201
 * 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.
 *
 * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
202 203
 * Copyright (c) 1998, 1999, 2000 Glenn Randers-Pehrson, and are
 * distributed according to the same disclaimer and license as libpng-0.96,
204 205 206 207 208 209 210 211 212 213
 * with the following individuals added to the list of Contributing Authors:
 *
 *    Tom Lane
 *    Glenn Randers-Pehrson
 *    Willem van Schaik
 *
 * libpng versions 0.89, June 1996, through 0.96, May 1997, are
 * Copyright (c) 1996, 1997 Andreas Dilger
 * Distributed according to the same disclaimer and license as libpng-0.88,
 * with the following individuals added to the list of Contributing Authors:
214
 *
215 216
 *    John Bowler
 *    Kevin Bracey
217
 *    Sam Bushell
218 219
 *    Magnus Holmgren
 *    Greg Roelofs
220 221 222 223 224 225 226 227 228 229
 *    Tom Tanner
 *
 * libpng versions 0.5, May 1995, through 0.88, January 1996, are
 * Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.
 *
 * For the purposes of this copyright and license, "Contributing Authors"
 * is defined as the following set of individuals:
 *
 *    Andreas Dilger
 *    Dave Martindale
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
 *    Guy Eric Schalnat
 *    Paul Schmidt
 *    Tim Wegner
 *
 * The PNG Reference Library is supplied "AS IS".  The Contributing Authors
 * and Group 42, Inc. disclaim all warranties, expressed or implied,
 * including, without limitation, the warranties of merchantability and of
 * fitness for any purpose.  The Contributing Authors and Group 42, Inc.
 * assume no liability for direct, indirect, incidental, special, exemplary,
 * 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:
245
 *
246
 *   1. The origin of this source code must not be misrepresented.
247
 *
248 249
 *   2. Altered versions must be plainly marked as such and must not
 *      be misrepresented as being the original source.
250
 *
251 252
 *   3. This Copyright notice may not be removed or altered from
 *      any source or altered source distribution.
253 254 255 256 257 258 259
 *
 * 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.
 */
G
Guy Schalnat 已提交
260

261
/*
262 263
 * A "png_get_copyright" function is available, for convenient use in "about"
 * boxes and the like:
264
 *
265
 *     printf("%s",png_get_copyright(NULL));
266
 *
267
 * Also, the PNG logo (in PNG format, of course) is supplied in the
268
 * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
269 270 271
 */

/*
272 273 274 275 276 277 278 279 280 281 282 283
 * Libpng is OSI Certified Open Source Software.  OSI Certified is a
 * certification mark of the Open Source Initiative.
 */

/*
 * 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.
 */

284 285 286 287
/*
 * Y2K compliance in libpng:
 * =========================
 *
288
 *    November 21, 2010
289 290 291 292 293
 *
 *    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
294
 *    upward through 1.5.0beta56 are Y2K compliant.  It is my belief that
G
[devel]  
Glenn Randers-Pehrson 已提交
295
 *    earlier versions were also Y2K compliant.
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
 *
 *    Libpng only has three year fields.  One is a 2-byte unsigned integer
 *    that will hold years up to 65535.  The other two hold the date in text
 *    format, and will hold years up to 9999.
 *
 *    The integer is
 *        "png_uint_16 year" in png_time_struct.
 *
 *    The strings are
 *        "png_charp time_buffer" in png_struct and
 *        "near_time_buffer", which is a local character string in png.c.
 *
 *    There are seven time-related functions:
 *        png.c: png_convert_to_rfc_1123() in png.c
 *          (formerly png_convert_to_rfc_1152() in error)
 *        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
 *    the full 4-digit year.  There is a possibility that applications using
 *    libpng are not passing 4-digit years into the png_convert_to_rfc_1123()
 *    function, or that they are incorrectly passing only a 2-digit year
 *    instead of "year - 1900" into the png_convert_from_struct_tm() function,
 *    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
 */

340 341
#ifndef PNG_H
#define PNG_H
G
Guy Schalnat 已提交
342

343
/* This is not the place to learn how to use libpng. The file libpng-manual.txt
A
Andreas Dilger 已提交
344 345 346 347
 * 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
 * at the actual function definitions and structure components.
 */
G
Guy Schalnat 已提交
348

349
/* Version information for png.h - this should match the version in png.c */
350
#define PNG_LIBPNG_VER_STRING "1.5.0beta56"
351
#define PNG_HEADER_VERSION_STRING \
352
     " libpng version 1.5.0beta56 - November 21, 2010\n"
353

354 355
#define PNG_LIBPNG_VER_SONUM   15
#define PNG_LIBPNG_VER_DLLNUM  15
356 357 358

/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */
#define PNG_LIBPNG_VER_MAJOR   1
359
#define PNG_LIBPNG_VER_MINOR   5
360
#define PNG_LIBPNG_VER_RELEASE 0
361
/* This should match the numeric part of the final component of
362 363
 * PNG_LIBPNG_VER_STRING, omitting any leading zero:
 */
364

365
#define PNG_LIBPNG_VER_BUILD  56
366

367
/* Release Status */
368 369 370 371
#define PNG_LIBPNG_BUILD_ALPHA    1
#define PNG_LIBPNG_BUILD_BETA     2
#define PNG_LIBPNG_BUILD_RC       3
#define PNG_LIBPNG_BUILD_STABLE   4
372
#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7
373

374 375 376 377 378 379 380
/* 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 */
381

382
#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_BETA
383

384 385 386 387
/* 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
388 389
 * version 1.0.1 it's    xxyyzz, where x=major, y=minor, z=release
 */
390
#define PNG_LIBPNG_VER 10500 /* 1.5.0 */
391

392 393 394 395
/* Library configuration: these options cannot be changed after
 * the library has been built.
 */
#ifndef PNGLCONF_H
396 397 398
    /* If pnglibconf.h is missing, you can
     * copy scripts/pnglibconf.h.prebuilt to pnglibconf.h
     */
399
#   include "pnglibconf.h"
400 401
#endif

402
#ifndef PNG_VERSION_INFO_ONLY
403 404 405 406 407
/* Standard header files (not needed for the version info) */
#  ifdef PNG_SETJMP_SUPPORTED
#    include <setjmp.h>
#  endif

G
[devel]  
Glenn Randers-Pehrson 已提交
408 409 410 411 412 413 414
/* Need the time information for converting tIME chunks, it
 * defines struct tm:
 */
#ifdef PNG_CONVERT_tIME_SUPPORTED
   /* "time.h" functions are not supported on all operating systems */
#  include <time.h>
#endif
G
Guy Schalnat 已提交
415

416 417 418
/* Machine specific configuration. */
#  include "pngconf.h"
#endif
G
Guy Schalnat 已提交
419

420
/*
421 422 423
 * Added at libpng-1.2.8
 *
 * Ref MSDN: Private as priority over Special
424 425
 * VS_FF_PRIVATEBUILD File *was not* built using standard release
 * procedures. If this value is given, the StringFileInfo block must
426
 * contain a PrivateBuild string.
427 428 429 430
 *
 * 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
431
 * StringFileInfo block must contain a SpecialBuild string.
432 433
 */

434
#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
435
#  define PNG_LIBPNG_BUILD_TYPE \
436
       (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
437
#else
438
#  ifdef PNG_LIBPNG_SPECIALBUILD
439
#    define PNG_LIBPNG_BUILD_TYPE \
440
         (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
441
#  else
442
#    define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
443 444 445 446 447
#  endif
#endif

#ifndef PNG_VERSION_INFO_ONLY

448 449 450 451 452
/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

A
Andreas Dilger 已提交
453 454 455
/* Version information for C files, stored in png.c.  This had better match
 * the version above.
 */
456
#define png_libpng_ver png_get_header_ver(NULL)
A
Andreas Dilger 已提交
457

458 459 460
/* This file is arranged in several sections:
 *
 * 1. Any configuration options that can be specified by for the application
461
 *    code when it is built.  (Build time configuration is in pnglibconf.h)
462 463 464 465 466 467 468 469
 * 2. Type definitions (base types are defined in pngconf.h), structure
 *    definitions.
 * 3. Exported library functions.
 *
 * The library source code has additional files (principally pngpriv.h) that
 * allow configuration of the library.
 */
/* Section 1: run time configuration
470
 * See pnglibconf.h for build time configuration
471 472 473
 *
 * Run time configuration allows the application to choose between
 * implementations of certain arithmetic APIs.  The default is set
474
 * at build time and recorded in pnglibconf.h, but it is safe to
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
 * 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.
 */

/* Section 2: type definitions, including structures and compile time
 * constants.
 * See pngconf.h for base types that vary by machine/system
 */
503 504 505 506

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

A
Andreas Dilger 已提交
509 510 511 512
/* 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 已提交
513 514
typedef struct png_color_struct
{
G
Guy Schalnat 已提交
515
   png_byte red;
G
Guy Schalnat 已提交
516 517 518
   png_byte green;
   png_byte blue;
} png_color;
A
Andreas Dilger 已提交
519
typedef png_color FAR * png_colorp;
520
typedef PNG_CONST png_color FAR * png_const_colorp;
A
Andreas Dilger 已提交
521
typedef png_color FAR * FAR * png_colorpp;
G
Guy Schalnat 已提交
522 523 524

typedef struct png_color_16_struct
{
A
Andreas Dilger 已提交
525 526
   png_byte index;    /* used for palette files */
   png_uint_16 red;   /* for use in red green blue files */
G
Guy Schalnat 已提交
527 528
   png_uint_16 green;
   png_uint_16 blue;
A
Andreas Dilger 已提交
529
   png_uint_16 gray;  /* for use in grayscale files */
G
Guy Schalnat 已提交
530
} png_color_16;
A
Andreas Dilger 已提交
531
typedef png_color_16 FAR * png_color_16p;
532
typedef PNG_CONST png_color_16 FAR * png_const_color_16p;
A
Andreas Dilger 已提交
533
typedef png_color_16 FAR * FAR * png_color_16pp;
G
Guy Schalnat 已提交
534 535 536

typedef struct png_color_8_struct
{
A
Andreas Dilger 已提交
537
   png_byte red;   /* for use in red green blue files */
G
Guy Schalnat 已提交
538 539
   png_byte green;
   png_byte blue;
A
Andreas Dilger 已提交
540
   png_byte gray;  /* for use in grayscale files */
G
Guy Schalnat 已提交
541 542
   png_byte alpha; /* for alpha channel files */
} png_color_8;
A
Andreas Dilger 已提交
543
typedef png_color_8 FAR * png_color_8p;
544
typedef PNG_CONST png_color_8 FAR * png_const_color_8p;
A
Andreas Dilger 已提交
545
typedef png_color_8 FAR * FAR * png_color_8pp;
G
Guy Schalnat 已提交
546

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

563 564 565 566 567
/*  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.
 */

568
typedef struct png_sPLT_struct
569
{
570 571 572 573
   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 */
574 575
} png_sPLT_t;
typedef png_sPLT_t FAR * png_sPLT_tp;
576
typedef PNG_CONST png_sPLT_t FAR * png_const_sPLT_tp;
577
typedef png_sPLT_t FAR * FAR * png_sPLT_tpp;
578 579

#ifdef PNG_TEXT_SUPPORTED
580 581
/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,
 * and whether that contents is compressed or not.  The "key" field
582 583 584 585 586 587
 * points to a regular zero-terminated C string.  The "text", "lang", and
 * "lang_key" fields can be regular C strings, empty strings, or NULL pointers.
 * However, the * structure returned by png_get_text() will always contain
 * regular zero-terminated C strings (possibly empty), never NULL pointers,
 * so they can be safely used in printf() and other string-handling functions.
 */
G
Guy Schalnat 已提交
588 589
typedef struct png_text_struct
{
590 591 592 593 594
   int  compression;       /* compression value:
                             -1: tEXt, none
                              0: zTXt, deflate
                              1: iTXt, none
                              2: iTXt, deflate  */
A
Andreas Dilger 已提交
595
   png_charp key;          /* keyword, 1-79 character description of "text" */
596 597
   png_charp text;         /* comment, may be an empty string (ie "")
                              or a NULL pointer */
598 599
   png_size_t text_length; /* length of the text string */
   png_size_t itxt_length; /* length of the itxt string */
600 601
   png_charp lang;         /* language code, 0-79 characters
                              or a NULL pointer */
602
   png_charp lang_key;     /* keyword translated UTF-8 string, 0 or more
603
                              chars or a NULL pointer */
G
Guy Schalnat 已提交
604
} png_text;
A
Andreas Dilger 已提交
605
typedef png_text FAR * png_textp;
606
typedef PNG_CONST png_text FAR * png_const_textp;
A
Andreas Dilger 已提交
607
typedef png_text FAR * FAR * png_textpp;
608
#endif
A
Andreas Dilger 已提交
609 610 611 612 613 614 615

/* 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
616 617 618
#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 已提交
619 620

/* png_time is a way to hold the time in an machine independent way.
621 622 623
 * 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
624
 * note - PNG has always been Year 2000 compliant!
625
 */
G
Guy Schalnat 已提交
626 627 628
typedef struct png_time_struct
{
   png_uint_16 year; /* full year, as in, 1995 */
A
Andreas Dilger 已提交
629 630 631 632 633
   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 已提交
634
} png_time;
A
Andreas Dilger 已提交
635
typedef png_time FAR * png_timep;
636
typedef PNG_CONST png_time FAR * png_const_timep;
A
Andreas Dilger 已提交
637 638
typedef png_time FAR * FAR * png_timepp;

639
#if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED) || \
640
    defined(PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
641 642 643 644 645 646 647 648 649 650 651
/* 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.
 */
typedef struct png_unknown_chunk_t
{
    png_byte name[5];
    png_byte *data;
    png_size_t size;

652
    /* libpng-using applications should NOT directly modify this byte. */
653 654 655 656
    png_byte location; /* mode of operation at read time */
}
png_unknown_chunk;
typedef png_unknown_chunk FAR * png_unknown_chunkp;
657
typedef PNG_CONST png_unknown_chunk FAR * png_const_unknown_chunkp;
658 659 660
typedef png_unknown_chunk FAR * FAR * png_unknown_chunkpp;
#endif

661
typedef struct png_info_def png_info;
A
Andreas Dilger 已提交
662 663
typedef png_info FAR * png_infop;
typedef png_info FAR * FAR * png_infopp;
G
Guy Schalnat 已提交
664

665
/* Maximum positive integer used in PNG is (2^31)-1 */
666
#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
667 668
#define PNG_UINT_32_MAX ((png_uint_32)(-1))
#define PNG_SIZE_MAX ((png_size_t)(-1))
669

G
[devel]  
Glenn Randers-Pehrson 已提交
670 671 672 673 674 675
/* These are constants for fixed point values encoded in the
 * PNG specification manner (x100000)
 */
#define PNG_FP_1    100000
#define PNG_FP_HALF  50000

A
Andreas Dilger 已提交
676
/* These describe the color_type field in png_info. */
G
Guy Schalnat 已提交
677
/* color type masks */
A
Andreas Dilger 已提交
678 679 680
#define PNG_COLOR_MASK_PALETTE    1
#define PNG_COLOR_MASK_COLOR      2
#define PNG_COLOR_MASK_ALPHA      4
G
Guy Schalnat 已提交
681 682

/* color types.  Note that not all combinations are legal */
G
Guy Schalnat 已提交
683
#define PNG_COLOR_TYPE_GRAY 0
A
Andreas Dilger 已提交
684 685 686
#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 已提交
687
#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
688 689 690
/* aliases */
#define PNG_COLOR_TYPE_RGBA  PNG_COLOR_TYPE_RGB_ALPHA
#define PNG_COLOR_TYPE_GA  PNG_COLOR_TYPE_GRAY_ALPHA
G
Guy Schalnat 已提交
691

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

696
/* This is for filter type. PNG 1.0-1.2 only define the single type. */
A
Andreas Dilger 已提交
697
#define PNG_FILTER_TYPE_BASE      0 /* Single row per-byte filtering */
698
#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
A
Andreas Dilger 已提交
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
#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 */

718 719 720 721 722 723
/* 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 已提交
724 725 726 727 728
/* 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 */

729
/* These are for the sRGB chunk.  These values should NOT be changed. */
730 731 732 733
#define PNG_sRGB_INTENT_PERCEPTUAL 0
#define PNG_sRGB_INTENT_RELATIVE   1
#define PNG_sRGB_INTENT_SATURATION 2
#define PNG_sRGB_INTENT_ABSOLUTE   3
734
#define PNG_sRGB_INTENT_LAST       4 /* Not a valid value */
735

736 737
/* This is for text chunks */
#define PNG_KEYWORD_MAX_LENGTH     79
738

739
/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
740
#define PNG_MAX_PALETTE_LENGTH    256
741

A
Andreas Dilger 已提交
742 743 744 745 746
/* 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.
 */
G
Guy Schalnat 已提交
747 748 749 750 751 752 753 754 755 756
#define PNG_INFO_gAMA 0x0001
#define PNG_INFO_sBIT 0x0002
#define PNG_INFO_cHRM 0x0004
#define PNG_INFO_PLTE 0x0008
#define PNG_INFO_tRNS 0x0010
#define PNG_INFO_bKGD 0x0020
#define PNG_INFO_hIST 0x0040
#define PNG_INFO_pHYs 0x0080
#define PNG_INFO_oFFs 0x0100
#define PNG_INFO_tIME 0x0200
A
Andreas Dilger 已提交
757
#define PNG_INFO_pCAL 0x0400
758
#define PNG_INFO_sRGB 0x0800   /* GR-P, 0.96a */
759 760 761
#define PNG_INFO_iCCP 0x1000   /* ESR, 1.0.6 */
#define PNG_INFO_sPLT 0x2000   /* ESR, 1.0.6 */
#define PNG_INFO_sCAL 0x4000   /* ESR, 1.0.6 */
762
#define PNG_INFO_IDAT 0x8000L  /* ESR, 1.0.6 */
G
Guy Schalnat 已提交
763

A
Andreas Dilger 已提交
764 765 766 767
/* 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 已提交
768 769
typedef struct png_row_info_struct
{
G
Guy Schalnat 已提交
770
   png_uint_32 width; /* width of row */
771
   png_size_t rowbytes; /* number of bytes in row */
G
Guy Schalnat 已提交
772 773 774 775
   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) */
   png_byte pixel_depth; /* bits per pixel (depth * channels) */
G
Guy Schalnat 已提交
776 777
} png_row_info;

A
Andreas Dilger 已提交
778 779
typedef png_row_info FAR * png_row_infop;
typedef png_row_info FAR * FAR * png_row_infopp;
G
Guy Schalnat 已提交
780

781 782 783 784
/* 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
785
 * user read/write data functions.  Note that the 'write' function must not
786
 * modify the buffer it is passed. The 'read' function, on the other hand, is
787
 * expected to return the read data in the buffer.
G
Guy Schalnat 已提交
788
 */
G
Guy Schalnat 已提交
789 790 791
typedef struct png_struct_def png_struct;
typedef png_struct FAR * png_structp;

792 793 794 795 796 797 798
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),);
799

G
Guy Schalnat 已提交
800
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
801 802 803 804 805
typedef PNG_CALLBACK(void, *png_progressive_info_ptr,
    (png_structp, png_infop),);
typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop),);
typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,
    png_uint_32, int),);
806
#endif
G
Guy Schalnat 已提交
807

808
#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
809
    defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
810 811
typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
    png_bytep),);
812
#endif
813

814
#ifdef PNG_USER_CHUNKS_SUPPORTED
815 816
typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
    png_unknown_chunkp),);
817
#endif
818
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
819
typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp),);
820
#endif
821 822 823
#ifdef PNG_SETJMP_SUPPORTED
/* This must match the function definition in <setjmp.h>, and the
 * application must include this before png.h to obtain the definition
824 825 826
 * of jmp_buf.  The function is required to be PNG_NORETURN.  (Note that
 * PNG_PTR_NORETURN is used here because current versions of the Microsoft
 * C compiler do not support the PNG_NORETURN attribute on a pointer.)
G
[devel]  
Glenn Randers-Pehrson 已提交
827 828 829 830 831 832 833 834 835 836 837
 *
 * If you get a type warning from the compiler when linking against this line
 * then your compiler has 'longjmp' that does not match the requirements of the
 * compiler that built libpng.  You will have to write a wrapper function for
 * your compiler's longjmp and call png_set_longjmp_fn directly (not via the
 * png_jmpbuf macro.)
 *
 * If you get a warning here while building the library you will need to make
 * 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!
838
 */
839 840
typedef PNG_FUNCTION(void,(PNGCAPI *png_longjmp_ptr),PNGARG((jmp_buf, int)),
   PNG_PTR_NORETURN);
841
#endif
842 843

/* Transform masks for the high-level interface */
844 845
#define PNG_TRANSFORM_IDENTITY       0x0000    /* read and write */
#define PNG_TRANSFORM_STRIP_16       0x0001    /* read only */
846 847
#define PNG_TRANSFORM_STRIP_ALPHA    0x0002    /* read only */
#define PNG_TRANSFORM_PACKING        0x0004    /* read and write */
848 849
#define PNG_TRANSFORM_PACKSWAP       0x0008    /* read and write */
#define PNG_TRANSFORM_EXPAND         0x0010    /* read only */
850
#define PNG_TRANSFORM_INVERT_MONO    0x0020    /* read and write */
851 852 853
#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 */
854
#define PNG_TRANSFORM_SWAP_ENDIAN    0x0200    /* read and write */
855
#define PNG_TRANSFORM_INVERT_ALPHA   0x0400    /* read and write */
856
#define PNG_TRANSFORM_STRIP_FILLER   0x0800    /* write only */
857
/* Added to libpng-1.2.34 */
858
#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
859 860 861
#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
/* Added to libpng-1.4.0 */
#define PNG_TRANSFORM_GRAY_TO_RGB   0x2000      /* read only */
862

863
/* Flags for MNG supported features */
864 865
#define PNG_FLAG_MNG_EMPTY_PLTE     0x01
#define PNG_FLAG_MNG_FILTER_64      0x04
866
#define PNG_ALL_MNG_FEATURES        0x05
867

868 869 870 871 872 873 874 875 876
/* NOTE: prior to 1.5 these functions had no 'API' style declaration,
 * 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.
 */
typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,
    png_alloc_size_t),);
typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp),);
877

A
Andreas Dilger 已提交
878
typedef png_struct FAR * FAR * png_structpp;
G
Guy Schalnat 已提交
879

880 881
/* Section 3: exported functions
 * Here are the function definitions most commonly used.  This is not
882
 * the place to find out how to use libpng.  See libpng-manual.txt for the
A
Andreas Dilger 已提交
883
 * full explanation, see example.c for the summary.  This just provides
884
 * a simple one line description of the use of each function.
A
Andreas Dilger 已提交
885
 */
G
Guy Schalnat 已提交
886

887
/* Returns the version number of the library */
888
PNG_EXPORT(png_uint_32,png_access_version_number,(void),,1);
889

A
Andreas Dilger 已提交
890
/* Tell lib we have already handled the first <num_bytes> magic bytes.
A
Andreas Dilger 已提交
891 892
 * Handling more than 8 bytes from the beginning of the file is an error.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
893
PNG_EXPORT(void,png_set_sig_bytes,(png_structp png_ptr, int num_bytes),,2);
A
Andreas Dilger 已提交
894 895 896 897 898 899

/* 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).
 */
900
PNG_EXPORT(int,png_sig_cmp,(png_const_bytep sig, png_size_t start,
901
    png_size_t num_to_check),,3);
A
Andreas Dilger 已提交
902

903 904 905 906 907
/* Simple signature checking function.  This is the same as calling
 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
 */
#define png_check_sig(sig,n) !png_sig_cmp((sig), 0, (n))

A
Andreas Dilger 已提交
908
/* Allocate and initialize png_ptr struct for reading, and any other memory. */
G
[devel]  
Glenn Randers-Pehrson 已提交
909 910 911
PNG_EXPORT(png_structp,png_create_read_struct,(png_const_charp user_png_ver,
    png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn),
    PNG_ALLOCATED,4);
A
Andreas Dilger 已提交
912

913
/* Allocate and initialize png_ptr struct for writing, and any other memory */
G
[devel]  
Glenn Randers-Pehrson 已提交
914 915 916
PNG_EXPORT(png_structp,png_create_write_struct,(png_const_charp user_png_ver,
    png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn),
    PNG_ALLOCATED,5);
G
Guy Schalnat 已提交
917

G
[devel]  
Glenn Randers-Pehrson 已提交
918
PNG_EXPORT(png_size_t,png_get_compression_buffer_size,(png_structp png_ptr),,6);
919

920
PNG_EXPORT(void,png_set_compression_buffer_size,(png_structp png_ptr,
921
    png_size_t size),,7);
922

923 924 925 926 927 928 929 930 931 932 933
/* 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.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
934
PNG_EXPORT(jmp_buf*,png_set_longjmp_fn,(png_structp png_ptr,
935
    png_longjmp_ptr longjmp_fn, size_t jmp_buf_size),,8);
936
#  define png_jmpbuf(png_ptr) \
937
      (*png_set_longjmp_fn((png_ptr), longjmp, sizeof (jmp_buf)))
938 939
#else
#  define png_jmpbuf(png_ptr) \
940
      (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
941
#endif
942 943 944 945 946
/* 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.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
947
PNG_EXPORT(void,png_longjmp,(png_structp png_ptr, int val),PNG_NORETURN,9);
948

949
#ifdef PNG_READ_SUPPORTED
950
/* Reset the compression stream */
951
PNG_EXPORT(int,png_reset_zstream,(png_structp png_ptr),,10);
952
#endif
953

954
/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
955
#ifdef PNG_USER_MEM_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
956 957 958 959 960 961 962 963
PNG_EXPORT(png_structp,png_create_read_struct_2,(png_const_charp user_png_ver,
    png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn,
    png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
    PNG_ALLOCATED,11);
PNG_EXPORT(png_structp,png_create_write_struct_2,(png_const_charp user_png_ver,
    png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn,
    png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
    PNG_ALLOCATED,12);
964 965
#endif

966
/* Write the PNG file signature. */
967
PNG_EXPORT(void,png_write_sig,(png_structp png_ptr),,13);
968

969
/* Write a PNG chunk - size, type, (optional) data, CRC. */
970 971
PNG_EXPORT(void,png_write_chunk,(png_structp png_ptr, png_const_bytep
    chunk_name, png_const_bytep data, png_size_t length),,14);
972 973

/* Write the start of a PNG chunk - length and chunk name. */
974
PNG_EXPORT(void,png_write_chunk_start,(png_structp png_ptr,
975
    png_const_bytep chunk_name, png_uint_32 length),,15);
976 977

/* Write the data of a PNG chunk started with png_write_chunk_start(). */
978
PNG_EXPORT(void,png_write_chunk_data,(png_structp png_ptr, png_const_bytep data,
G
[devel]  
Glenn Randers-Pehrson 已提交
979
    png_size_t length),,16);
980 981

/* Finish a chunk started with png_write_chunk_start() (includes CRC). */
982
PNG_EXPORT(void,png_write_chunk_end,(png_structp png_ptr),,17);
983

A
Andreas Dilger 已提交
984
/* Allocate and initialize the info structure */
985
PNG_EXPORT(png_infop,png_create_info_struct,(png_structp png_ptr),
986
    PNG_ALLOCATED,18);
G
Guy Schalnat 已提交
987

988
PNG_EXPORT(void,png_info_init_3,(png_infopp info_ptr,
989
    png_size_t png_info_struct_size),,19);
G
Guy Schalnat 已提交
990

A
Andreas Dilger 已提交
991
/* Writes all the PNG information before the image. */
992
PNG_EXPORT(void,png_write_info_before_PLTE,(png_structp png_ptr,
993
    png_infop info_ptr),,20);
G
[devel]  
Glenn Randers-Pehrson 已提交
994
PNG_EXPORT(void,png_write_info,(png_structp png_ptr, png_infop info_ptr),,21);
G
Guy Schalnat 已提交
995

996
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
997
/* Read the information before the actual image data. */
G
[devel]  
Glenn Randers-Pehrson 已提交
998
PNG_EXPORT(void,png_read_info,(png_structp png_ptr, png_infop info_ptr),,22);
999
#endif
G
Guy Schalnat 已提交
1000

1001
#ifdef PNG_TIME_RFC1123_SUPPORTED
1002 1003
PNG_EXPORT(png_const_charp,png_convert_to_rfc1123,(png_structp png_ptr,
    png_const_timep ptime),,23);
1004
#endif
1005

1006
#ifdef PNG_CONVERT_tIME_SUPPORTED
1007
/* Convert from a struct tm to png_time */
1008
PNG_EXPORT(void,png_convert_from_struct_tm,(png_timep ptime,
1009
    PNG_CONST struct tm FAR * ttime),,24);
G
Guy Schalnat 已提交
1010

1011
/* Convert from time_t to png_time.  Uses gmtime() */
G
[devel]  
Glenn Randers-Pehrson 已提交
1012
PNG_EXPORT(void,png_convert_from_time_t,(png_timep ptime, time_t ttime),,25);
1013
#endif /* PNG_CONVERT_tIME_SUPPORTED */
G
Guy Schalnat 已提交
1014

1015
#ifdef PNG_READ_EXPAND_SUPPORTED
1016
/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
1017
PNG_EXPORT(void,png_set_expand,(png_structp png_ptr),,26);
G
[devel]  
Glenn Randers-Pehrson 已提交
1018
PNG_EXPORT(void,png_set_expand_gray_1_2_4_to_8,(png_structp png_ptr),,27);
1019 1020
PNG_EXPORT(void,png_set_palette_to_rgb,(png_structp png_ptr),,28);
PNG_EXPORT(void,png_set_tRNS_to_alpha,(png_structp png_ptr),,29);
1021
#endif
G
Guy Schalnat 已提交
1022

G
Guy Schalnat 已提交
1023
#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
G
Guy Schalnat 已提交
1024
/* Use blue, green, red order for pixels. */
1025
PNG_EXPORT(void,png_set_bgr,(png_structp png_ptr),,30);
1026
#endif
G
Guy Schalnat 已提交
1027

1028
#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
1029
/* Expand the grayscale to 24-bit RGB if necessary. */
1030
PNG_EXPORT(void,png_set_gray_to_rgb,(png_structp png_ptr),,31);
G
Guy Schalnat 已提交
1031

1032
/* Reduce RGB to grayscale. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1033 1034 1035
PNG_FP_EXPORT(void,png_set_rgb_to_gray,(png_structp png_ptr, int error_action,
    double red, double green ),,32);
PNG_FIXED_EXPORT(void,png_set_rgb_to_gray_fixed,(png_structp png_ptr,
1036
    int error_action, png_fixed_point red, png_fixed_point green),,33);
1037

G
[devel]  
Glenn Randers-Pehrson 已提交
1038
PNG_EXPORT(png_byte,png_get_rgb_to_gray_status,(png_structp png_ptr),,34);
1039
#endif
A
Andreas Dilger 已提交
1040

1041
PNG_EXPORT(void,png_build_grayscale_palette,(int bit_depth,
1042
    png_colorp palette),,35);
A
Andreas Dilger 已提交
1043

1044
#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
1045
PNG_EXPORT(void,png_set_strip_alpha,(png_structp png_ptr),,36);
1046
#endif
G
Guy Schalnat 已提交
1047

A
Andreas Dilger 已提交
1048 1049
#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
1050
PNG_EXPORT(void,png_set_swap_alpha,(png_structp png_ptr),,37);
1051
#endif
G
Guy Schalnat 已提交
1052

1053 1054
#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
1055
PNG_EXPORT(void,png_set_invert_alpha,(png_structp png_ptr),,38);
1056
#endif
1057

A
Andreas Dilger 已提交
1058
#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
1059
/* Add a filler byte to 8-bit Gray or 24-bit RGB images. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1060 1061
PNG_EXPORT(void,png_set_filler,(png_structp png_ptr, png_uint_32 filler,
    int flags),,39);
A
Andreas Dilger 已提交
1062
/* The values of the PNG_FILLER_ defines should NOT be changed */
1063 1064
#  define PNG_FILLER_BEFORE 0
#  define PNG_FILLER_AFTER 1
1065
/* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1066 1067
PNG_EXPORT(void,png_set_add_alpha,(png_structp png_ptr, png_uint_32 filler,
    int flags),,40);
A
Andreas Dilger 已提交
1068
#endif /* PNG_READ_FILLER_SUPPORTED || PNG_WRITE_FILLER_SUPPORTED */
G
Guy Schalnat 已提交
1069

G
Guy Schalnat 已提交
1070
#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
1071
/* Swap bytes in 16-bit depth files. */
1072
PNG_EXPORT(void,png_set_swap,(png_structp png_ptr),,41);
1073
#endif
G
Guy Schalnat 已提交
1074

G
Guy Schalnat 已提交
1075
#if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED)
1076
/* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */
1077
PNG_EXPORT(void,png_set_packing,(png_structp png_ptr),,42);
1078
#endif
A
Andreas Dilger 已提交
1079

1080 1081
#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
    defined(PNG_WRITE_PACKSWAP_SUPPORTED)
A
Andreas Dilger 已提交
1082
/* Swap packing order of pixels in bytes. */
1083
PNG_EXPORT(void,png_set_packswap,(png_structp png_ptr),,43);
1084
#endif
G
Guy Schalnat 已提交
1085

G
Guy Schalnat 已提交
1086
#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
G
Guy Schalnat 已提交
1087
/* Converts files to legal bit depths. */
1088 1089
PNG_EXPORT(void,png_set_shift,(png_structp png_ptr, png_const_color_8p
    true_bits),,44);
1090
#endif
G
Guy Schalnat 已提交
1091

G
Guy Schalnat 已提交
1092 1093
#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
    defined(PNG_WRITE_INTERLACING_SUPPORTED)
G
[devel]  
Glenn Randers-Pehrson 已提交
1094 1095 1096 1097 1098
/* Have the code handle the interlacing.  Returns the number of passes.
 * 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.
 */
1099
PNG_EXPORT(int,png_set_interlace_handling,(png_structp png_ptr),,45);
1100
#endif
G
Guy Schalnat 已提交
1101

G
[devel]  
Glenn Randers-Pehrson 已提交
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
/* Alternatively call this to get the number of rows in the current pass.  Call
 * this after png_read_update_info or png_start_read_image; if you call it
 * before it will just return the image height (which is also what it returns
 * for a non-interlaced image!).
 *
 * NOTE: you need to call these to find out how many times to call png_read_row
 * if you handle your own de-interlacing.
 */
PNG_EXPORT(int,png_get_num_passes,(png_structp png_ptr),,215);
PNG_EXPORT(png_uint_32,png_get_num_rows,(png_structp png_ptr),,216);
1113
PNG_EXPORT(png_uint_32,png_get_num_cols,(png_structp png_ptr),,218);
G
[devel]  
Glenn Randers-Pehrson 已提交
1114 1115
#endif

G
Guy Schalnat 已提交
1116
#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
1117
/* Invert monochrome files */
1118
PNG_EXPORT(void,png_set_invert_mono,(png_structp png_ptr),,46);
1119
#endif
G
Guy Schalnat 已提交
1120

1121
#ifdef PNG_READ_BACKGROUND_SUPPORTED
G
Guy Schalnat 已提交
1122
/* Handle alpha and tRNS by replacing with a background color. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1123
PNG_FP_EXPORT(void,png_set_background,(png_structp png_ptr,
1124 1125
    png_const_color_16p background_color, int background_gamma_code,
    int need_expand, double background_gamma),,47);
G
[devel]  
Glenn Randers-Pehrson 已提交
1126
PNG_FIXED_EXPORT(void,png_set_background_fixed,(png_structp png_ptr,
1127 1128
    png_const_color_16p background_color, int background_gamma_code,
    int need_expand, png_fixed_point background_gamma),,217);
G
[devel]  
Glenn Randers-Pehrson 已提交
1129 1130
#endif
#ifdef PNG_READ_BACKGROUND_SUPPORTED
1131 1132 1133 1134
#  define PNG_BACKGROUND_GAMMA_UNKNOWN 0
#  define PNG_BACKGROUND_GAMMA_SCREEN  1
#  define PNG_BACKGROUND_GAMMA_FILE    2
#  define PNG_BACKGROUND_GAMMA_UNIQUE  3
1135
#endif
G
Guy Schalnat 已提交
1136

1137
#ifdef PNG_READ_16_TO_8_SUPPORTED
1138
/* Strip the second byte of information from a 16-bit depth file. */
1139
PNG_EXPORT(void,png_set_strip_16,(png_structp png_ptr),,48);
1140
#endif
G
Guy Schalnat 已提交
1141

1142 1143
#ifdef PNG_READ_QUANTIZE_SUPPORTED
/* Turn on quantizing, and reduce the palette to the number of colors
1144 1145
 * available.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1146
PNG_EXPORT(void,png_set_quantize,(png_structp png_ptr, png_colorp palette,
1147
    int num_palette, int maximum_colors, png_const_uint_16p histogram,
G
[devel]  
Glenn Randers-Pehrson 已提交
1148
    int full_quantize),,49);
1149
#endif
G
Guy Schalnat 已提交
1150

1151
#ifdef PNG_READ_GAMMA_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1152 1153 1154 1155 1156
/* 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)

1157
/* Handle gamma correction. Screen_gamma=(display_exponent) */
G
[devel]  
Glenn Randers-Pehrson 已提交
1158 1159 1160 1161
PNG_FP_EXPORT(void,png_set_gamma,(png_structp png_ptr, double screen_gamma,
    double default_file_gamma),,50);
PNG_FIXED_EXPORT(void,png_set_gamma_fixed,(png_structp png_ptr,
    png_fixed_point screen_gamma, png_fixed_point default_file_gamma),,208);
1162
#endif
G
Guy Schalnat 已提交
1163

1164

1165
#ifdef PNG_WRITE_FLUSH_SUPPORTED
G
Guy Schalnat 已提交
1166
/* Set how many lines between output flushes - 0 for no flushing */
1167
PNG_EXPORT(void,png_set_flush,(png_structp png_ptr, int nrows),,51);
G
Guy Schalnat 已提交
1168
/* Flush the current PNG output buffer */
1169
PNG_EXPORT(void,png_write_flush,(png_structp png_ptr),,52);
1170
#endif
G
Guy Schalnat 已提交
1171

1172
/* Optional update palette with requested transformations */
1173
PNG_EXPORT(void,png_start_read_image,(png_structp png_ptr),,53);
G
Guy Schalnat 已提交
1174

1175
/* Optional call to update the users info structure */
G
[devel]  
Glenn Randers-Pehrson 已提交
1176 1177
PNG_EXPORT(void,png_read_update_info,(png_structp png_ptr, png_infop info_ptr),,
    54);
G
Guy Schalnat 已提交
1178

1179
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1180
/* Read one or more rows of image data. */
1181
PNG_EXPORT(void,png_read_rows,(png_structp png_ptr, png_bytepp row,
1182
    png_bytepp display_row, png_uint_32 num_rows),,55);
1183
#endif
G
Guy Schalnat 已提交
1184

1185
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1186
/* Read a row of data. */
1187
PNG_EXPORT(void,png_read_row,(png_structp png_ptr, png_bytep row,
1188
    png_bytep display_row),,56);
1189
#endif
G
Guy Schalnat 已提交
1190

1191
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1192
/* Read the whole image into memory at once. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1193
PNG_EXPORT(void,png_read_image,(png_structp png_ptr, png_bytepp image),,57);
1194
#endif
G
Guy Schalnat 已提交
1195

1196
/* Write a row of image data */
1197
PNG_EXPORT(void,png_write_row,(png_structp png_ptr, png_const_bytep row),,58);
G
Guy Schalnat 已提交
1198

1199
/* Write a few rows of image data: (*row) is not written; however, the type is
1200 1201 1202 1203
 * declared as writeable to maintain compatibility with previous versions of
 * libpng and to allow the 'display_row' array from read_rows to be passed
 * unchanged to write_rows.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1204 1205
PNG_EXPORT(void,png_write_rows,(png_structp png_ptr, png_bytepp row,
    png_uint_32 num_rows),,59);
G
Guy Schalnat 已提交
1206

1207
/* Write the image data */
G
[devel]  
Glenn Randers-Pehrson 已提交
1208
PNG_EXPORT(void,png_write_image,(png_structp png_ptr, png_bytepp image),,60);
G
Guy Schalnat 已提交
1209

1210
/* Write the end of the PNG file. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1211
PNG_EXPORT(void,png_write_end,(png_structp png_ptr, png_infop info_ptr),,61);
G
Guy Schalnat 已提交
1212

1213
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1214
/* Read the end of the PNG file. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1215
PNG_EXPORT(void,png_read_end,(png_structp png_ptr, png_infop info_ptr),,62);
1216
#endif
G
Guy Schalnat 已提交
1217

1218
/* Free any memory associated with the png_info_struct */
1219
PNG_EXPORT(void,png_destroy_info_struct,(png_structp png_ptr,
1220
    png_infopp info_ptr_ptr),,63);
G
Guy Schalnat 已提交
1221

1222
/* Free any memory associated with the png_struct and the png_info_structs */
1223
PNG_EXPORT(void,png_destroy_read_struct,(png_structpp png_ptr_ptr,
1224
    png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr),,64);
G
Guy Schalnat 已提交
1225

1226
/* Free any memory associated with the png_struct and the png_info_structs */
1227
PNG_EXPORT(void,png_destroy_write_struct,(png_structpp png_ptr_ptr,
1228
    png_infopp info_ptr_ptr),,65);
G
Guy Schalnat 已提交
1229

1230
/* Set the libpng method of handling chunk CRC errors */
G
[devel]  
Glenn Randers-Pehrson 已提交
1231 1232
PNG_EXPORT(void,png_set_crc_action,(png_structp png_ptr, int crit_action,
    int ancil_action),,66);
A
Andreas Dilger 已提交
1233 1234

/* Values for png_set_crc_action() to say how to handle CRC errors in
A
Andreas Dilger 已提交
1235 1236 1237 1238 1239 1240 1241
 * ancillary and critical chunks, and whether to use the data contained
 * therein.  Note that it is impossible to "discard" data in a critical
 * chunk.  For versions prior to 0.90, the action was always error/quit,
 * 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 已提交
1242 1243 1244 1245 1246 1247 1248 1249
 */
#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 */

A
Andreas Dilger 已提交
1250 1251 1252 1253 1254
/* 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
1255 1256
 * header file (zlib.h) for an explination of the compression functions.
 */
A
Andreas Dilger 已提交
1257

1258
/* Set the filtering method(s) used by libpng.  Currently, the only valid
1259 1260
 * value for "method" is 0.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1261 1262
PNG_EXPORT(void,png_set_filter,(png_structp png_ptr, int method, int filters),,
    67);
G
Guy Schalnat 已提交
1263

A
Andreas Dilger 已提交
1264
/* Flags for png_set_filter() to say which filters to use.  The flags
A
Andreas Dilger 已提交
1265 1266 1267
 * 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 已提交
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277
 */
#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
#define PNG_ALL_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP | \
                         PNG_FILTER_AVG | PNG_FILTER_PAETH)

A
Andreas Dilger 已提交
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
/* 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

1288
#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */
A
Andreas Dilger 已提交
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
/* The "heuristic_method" is given by one of the PNG_FILTER_HEURISTIC_
 * defines, either the default (minimum-sum-of-absolute-differences), or
 * the experimental method (weighted-minimum-sum-of-absolute-differences).
 *
 * Weights are factors >= 1.0, indicating how important it is to keep the
 * filter type consistent between rows.  Larger numbers mean the current
 * filter is that many times as likely to be the same as the "num_weights"
 * previous filters.  This is cumulative for each previous row with a weight.
 * There needs to be "num_weights" values in "filter_weights", or it can be
 * NULL if the weights aren't being specified.  Weights have no influence on
 * the selection of the first row filter.  Well chosen weights can (in theory)
 * improve the compression for a given image.
 *
 * Costs are factors >= 1.0 indicating the relative decoding costs of a
 * filter type.  Higher costs indicate more decoding expense, and are
 * therefore less likely to be selected over a filter with lower computational
 * costs.  There needs to be a value in "filter_costs" for each valid filter
 * type (given by PNG_FILTER_VALUE_LAST), or it can be NULL if you aren't
 * setting the costs.  Costs try to improve the speed of decompression without
 * unduly increasing the compressed image size.
 *
 * A negative weight or cost indicates the default value is to be used, and
 * values in the range [0.0, 1.0) indicate the value is to remain unchanged.
 * The default values for both weights and costs are currently 1.0, but may
 * change if good general weighting/cost heuristics can be found.  If both
 * the weights and costs are set to 1.0, this degenerates the WEIGHTED method
 * to the UNWEIGHTED method, but with added encoding time/computation.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1317
PNG_FP_EXPORT(void,png_set_filter_heuristics,(png_structp png_ptr,
1318 1319
    int heuristic_method, int num_weights, png_const_doublep filter_weights,
    png_const_doublep filter_costs),,68);
G
[devel]  
Glenn Randers-Pehrson 已提交
1320
PNG_FIXED_EXPORT(void,png_set_filter_heuristics_fixed,(png_structp png_ptr,
1321 1322
    int heuristic_method, int num_weights, png_const_fixed_point_p
    filter_weights, png_const_fixed_point_p filter_costs),,209);
A
Andreas Dilger 已提交
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339
#endif /*  PNG_WRITE_WEIGHTED_FILTER_SUPPORTED */

/* Heuristic used for row filter selection.  These defines should NOT be
 * changed.
 */
#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 */

/* 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
 * for PNG images, and do considerably fewer caclulations.  In the future,
 * these values may not correspond directly to the zlib compression levels.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1340
PNG_EXPORT(void,png_set_compression_level,(png_structp png_ptr, int level),,69);
G
Guy Schalnat 已提交
1341

1342
PNG_EXPORT(void,png_set_compression_mem_level,(png_structp png_ptr,
1343
    int mem_level),,70);
G
Guy Schalnat 已提交
1344

1345
PNG_EXPORT(void,png_set_compression_strategy,(png_structp png_ptr,
1346
    int strategy),,71);
G
Guy Schalnat 已提交
1347

1348
PNG_EXPORT(void,png_set_compression_window_bits,(png_structp png_ptr,
1349
    int window_bits),,72);
G
Guy Schalnat 已提交
1350

G
[devel]  
Glenn Randers-Pehrson 已提交
1351 1352
PNG_EXPORT(void,png_set_compression_method,(png_structp png_ptr, int method),,
    73);
G
Guy Schalnat 已提交
1353

G
Guy Schalnat 已提交
1354
/* These next functions are called for input/output, memory, and error
A
Andreas Dilger 已提交
1355 1356 1357 1358
 * handling.  They are in the file pngrio.c, pngwio.c, and pngerror.c,
 * 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
1359
 * different manner by calling png_set_???_fn().  See libpng-manual.txt for
A
Andreas Dilger 已提交
1360 1361
 * more information.
 */
G
Guy Schalnat 已提交
1362

1363
#ifdef PNG_STDIO_SUPPORTED
A
Andreas Dilger 已提交
1364
/* Initialize the input/output for the PNG file to the default functions. */
1365
PNG_EXPORT(void,png_init_io,(png_structp png_ptr, png_FILE_p fp),,74);
1366
#endif
G
Guy Schalnat 已提交
1367

A
Andreas Dilger 已提交
1368
/* Replace the (error and abort), and warning functions with user
A
Andreas Dilger 已提交
1369 1370 1371 1372 1373 1374
 * 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.
 */
1375

G
[devel]  
Glenn Randers-Pehrson 已提交
1376 1377
PNG_EXPORT(void,png_set_error_fn,(png_structp png_ptr, png_voidp error_ptr,
    png_error_ptr error_fn, png_error_ptr warning_fn),,75);
G
Guy Schalnat 已提交
1378

G
Guy Schalnat 已提交
1379
/* Return the user pointer associated with the error functions */
1380
PNG_EXPORT(png_voidp,png_get_error_ptr,(png_structp png_ptr),,76);
G
Guy Schalnat 已提交
1381 1382

/* Replace the default data output functions with a user supplied one(s).
A
Andreas Dilger 已提交
1383 1384 1385
 * 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).
1386 1387 1388 1389 1390
 * 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 已提交
1391
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1392 1393
PNG_EXPORT(void,png_set_write_fn,(png_structp png_ptr, png_voidp io_ptr,
    png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn),,77);
G
Guy Schalnat 已提交
1394 1395

/* Replace the default data input function with a user supplied one. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1396 1397
PNG_EXPORT(void,png_set_read_fn,(png_structp png_ptr, png_voidp io_ptr,
    png_rw_ptr read_data_fn),,78);
G
Guy Schalnat 已提交
1398 1399

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

1402
PNG_EXPORT(void,png_set_read_status_fn,(png_structp png_ptr,
1403
    png_read_status_ptr read_row_fn),,80);
1404

1405
PNG_EXPORT(void,png_set_write_status_fn,(png_structp png_ptr,
1406
    png_write_status_ptr write_row_fn),,81);
1407

1408 1409
#ifdef PNG_USER_MEM_SUPPORTED
/* Replace the default memory allocation functions with user supplied one(s). */
G
[devel]  
Glenn Randers-Pehrson 已提交
1410 1411
PNG_EXPORT(void,png_set_mem_fn,(png_structp png_ptr, png_voidp mem_ptr,
    png_malloc_ptr malloc_fn, png_free_ptr free_fn),,82);
1412
/* Return the user pointer associated with the memory functions */
1413
PNG_EXPORT(png_voidp,png_get_mem_ptr,(png_structp png_ptr),,83);
1414
#endif
1415

1416
#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
1417
PNG_EXPORT(void,png_set_read_user_transform_fn,(png_structp png_ptr,
1418
    png_user_transform_ptr read_user_transform_fn),,84);
1419 1420
#endif

1421
#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
1422
PNG_EXPORT(void,png_set_write_user_transform_fn,(png_structp png_ptr,
1423
    png_user_transform_ptr write_user_transform_fn),,85);
1424 1425
#endif

1426
#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
1427
    defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
1428
PNG_EXPORT(void,png_set_user_transform_info,(png_structp png_ptr,
1429 1430
    png_voidp user_transform_ptr, int user_transform_depth,
    int user_transform_channels),,86);
1431
/* Return the user pointer associated with the user transform functions */
G
[devel]  
Glenn Randers-Pehrson 已提交
1432
PNG_EXPORT(png_voidp,png_get_user_transform_ptr,(png_structp png_ptr),,87);
1433 1434
#endif

1435
#ifdef PNG_USER_CHUNKS_SUPPORTED
1436
PNG_EXPORT(void,png_set_read_user_chunk_fn,(png_structp png_ptr,
1437
    png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn),,88);
1438
PNG_EXPORT(png_voidp,png_get_user_chunk_ptr,(png_structp png_ptr),,89);
1439 1440
#endif

G
Guy Schalnat 已提交
1441
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
A
Andreas Dilger 已提交
1442 1443 1444
/* Sets the function callbacks for the push reader, and a pointer to a
 * user-defined structure available to the callback functions.
 */
1445
PNG_EXPORT(void,png_set_progressive_read_fn,(png_structp png_ptr,
1446 1447
    png_voidp progressive_ptr, png_progressive_info_ptr info_fn,
    png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn),,90);
G
Guy Schalnat 已提交
1448

1449
/* Returns the user pointer associated with the push read functions */
1450
PNG_EXPORT(png_voidp,png_get_progressive_ptr,(png_structp png_ptr),,91);
A
Andreas Dilger 已提交
1451

1452
/* Function to be called when data becomes available */
G
[devel]  
Glenn Randers-Pehrson 已提交
1453 1454
PNG_EXPORT(void,png_process_data,(png_structp png_ptr, png_infop info_ptr,
    png_bytep buffer, png_size_t buffer_size),,92);
A
Andreas Dilger 已提交
1455

1456
/* Function that combines rows.  'new_row' is a flag that should come from the
1457
 * callback and be non-NULL if anything needs to be done; the library stores its
1458
 * own version of the new data internally and ignores the passed in value.
A
Andreas Dilger 已提交
1459
 */
1460
PNG_EXPORT(void,png_progressive_combine_row,(png_structp png_ptr,
1461
    png_bytep old_row, png_const_bytep new_row),,93);
G
Guy Schalnat 已提交
1462
#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */
G
Guy Schalnat 已提交
1463

G
[devel]  
Glenn Randers-Pehrson 已提交
1464 1465
PNG_EXPORT(png_voidp,png_malloc,(png_structp png_ptr, png_alloc_size_t size),
    PNG_ALLOCATED,94);
1466
/* Added at libpng version 1.4.0 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1467 1468
PNG_EXPORT(png_voidp,png_calloc,(png_structp png_ptr, png_alloc_size_t size),
    PNG_ALLOCATED,95);
G
Guy Schalnat 已提交
1469

1470
/* Added at libpng version 1.2.4 */
1471
PNG_EXPORT(png_voidp,png_malloc_warn,(png_structp png_ptr,
1472
    png_alloc_size_t size),PNG_ALLOCATED,96);
1473

1474
/* Frees a pointer allocated by png_malloc() */
1475
PNG_EXPORT(void,png_free,(png_structp png_ptr, png_voidp ptr),,97);
A
Andreas Dilger 已提交
1476

1477
/* Free data that was allocated internally */
1478
PNG_EXPORT(void,png_free_data,(png_structp png_ptr, png_infop info_ptr,
1479
    png_uint_32 free_me, int num),,98);
1480 1481
/* Reassign responsibility for freeing existing data, whether allocated
 * by libpng or by the application */
1482
PNG_EXPORT(void,png_data_freer,(png_structp png_ptr, png_infop info_ptr,
1483
    int freer, png_uint_32 mask),,99);
1484
/* Assignments for png_data_freer */
1485 1486 1487 1488
#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 */
1489 1490 1491 1492
#define PNG_FREE_HIST 0x0008
#define PNG_FREE_ICCP 0x0010
#define PNG_FREE_SPLT 0x0020
#define PNG_FREE_ROWS 0x0040
1493 1494
#define PNG_FREE_PCAL 0x0080
#define PNG_FREE_SCAL 0x0100
1495 1496
#define PNG_FREE_UNKN 0x0200
#define PNG_FREE_LIST 0x0400
1497 1498 1499
#define PNG_FREE_PLTE 0x1000
#define PNG_FREE_TRNS 0x2000
#define PNG_FREE_TEXT 0x4000
1500
#define PNG_FREE_ALL  0x7fff
1501
#define PNG_FREE_MUL  0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
1502

1503
#ifdef PNG_USER_MEM_SUPPORTED
1504
PNG_EXPORT(png_voidp,png_malloc_default,(png_structp png_ptr,
1505
    png_alloc_size_t size),PNG_ALLOCATED,100);
G
[devel]  
Glenn Randers-Pehrson 已提交
1506
PNG_EXPORT(void,png_free_default,(png_structp png_ptr, png_voidp ptr),,101);
1507
#endif
1508

1509
#ifdef PNG_ERROR_TEXT_SUPPORTED
A
Andreas Dilger 已提交
1510
/* Fatal error in PNG image of libpng - can't continue */
G
[devel]  
Glenn Randers-Pehrson 已提交
1511 1512
PNG_EXPORT(void,png_error,(png_structp png_ptr, png_const_charp error_message),
    PNG_NORETURN,102);
G
Guy Schalnat 已提交
1513

1514
/* The same, but the chunk name is prepended to the error string. */
1515
PNG_EXPORT(void,png_chunk_error,(png_structp png_ptr,
1516
    png_const_charp error_message),PNG_NORETURN,103);
1517

1518 1519
#else
/* Fatal error in PNG image of libpng - can't continue */
1520
PNG_EXPORT(void,png_err,(png_structp png_ptr),PNG_NORETURN,104);
1521 1522
#endif

G
Guy Schalnat 已提交
1523
/* Non-fatal error in libpng.  Can continue, but may have a problem. */
1524
PNG_EXPORT(void,png_warning,(png_structp png_ptr,
1525
    png_const_charp warning_message),,105);
A
Andreas Dilger 已提交
1526

1527
/* Non-fatal error in libpng, chunk name is prepended to message. */
1528
PNG_EXPORT(void,png_chunk_warning,(png_structp png_ptr,
1529
    png_const_charp warning_message),,106);
1530

1531 1532 1533
#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. */
1534
#  undef png_benign_error
1535
PNG_EXPORT(void,png_benign_error,(png_structp png_ptr,
1536
    png_const_charp warning_message),,107);
1537 1538

/* Same, chunk name is prepended to message. */
1539
#  undef png_chunk_benign_error
1540
PNG_EXPORT(void,png_chunk_benign_error,(png_structp png_ptr,
1541
    png_const_charp warning_message),,108);
1542

G
[devel]  
Glenn Randers-Pehrson 已提交
1543
PNG_EXPORT(void,png_set_benign_errors,(png_structp png_ptr, int allowed),,109);
1544 1545 1546 1547 1548 1549 1550 1551
#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
1552 1553
#endif

A
Andreas Dilger 已提交
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565
/* 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.
 */
1566
/* Returns "flag" if chunk data is valid in info_ptr. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1567 1568
PNG_EXPORT(png_uint_32,png_get_valid,(png_structp png_ptr, png_infop info_ptr,
    png_uint_32 flag),,110);
A
Andreas Dilger 已提交
1569

1570
/* Returns number of bytes needed to hold a transformed row. */
1571
PNG_EXPORT(png_size_t,png_get_rowbytes,(png_structp png_ptr,
1572
    png_infop info_ptr),,111);
A
Andreas Dilger 已提交
1573

1574
#ifdef PNG_INFO_IMAGE_SUPPORTED
1575
/* Returns row_pointers, which is an array of pointers to scanlines that was
1576 1577
 * returned from png_read_png().
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1578 1579
PNG_EXPORT(png_bytepp,png_get_rows,(png_structp png_ptr, png_infop info_ptr),,
    112);
1580
/* Set row_pointers, which is an array of pointers to scanlines for use
1581 1582
 * by png_write_png().
 */
1583
PNG_EXPORT(void,png_set_rows,(png_structp png_ptr, png_infop info_ptr,
1584
    png_bytepp row_pointers),,113);
1585 1586
#endif

1587
/* Returns number of color channels in image. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1588 1589
PNG_EXPORT(png_byte,png_get_channels,(png_structp png_ptr, png_infop info_ptr),,
    114);
A
Andreas Dilger 已提交
1590

1591 1592
#ifdef PNG_EASY_ACCESS_SUPPORTED
/* Returns image width in pixels. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1593
PNG_EXPORT(png_uint_32,png_get_image_width,(png_structp png_ptr,
1594
    png_infop info_ptr),,115);
1595 1596

/* Returns image height in pixels. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1597
PNG_EXPORT(png_uint_32,png_get_image_height,(png_structp png_ptr,
1598
    png_infop info_ptr),,116);
1599 1600

/* Returns image bit_depth. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1601 1602
PNG_EXPORT(png_byte,png_get_bit_depth,(png_structp png_ptr, png_infop info_ptr),
    ,117);
1603 1604

/* Returns image color_type. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1605
PNG_EXPORT(png_byte,png_get_color_type,(png_structp png_ptr,
1606
    png_infop info_ptr),,118);
1607 1608

/* Returns image filter_type. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1609
PNG_EXPORT(png_byte,png_get_filter_type,(png_structp png_ptr,
1610
    png_infop info_ptr),,119);
1611 1612

/* Returns image interlace_type. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1613
PNG_EXPORT(png_byte,png_get_interlace_type,(png_structp png_ptr,
1614
    png_infop info_ptr),,120);
1615 1616

/* Returns image compression_type. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1617
PNG_EXPORT(png_byte,png_get_compression_type,(png_structp png_ptr,
1618
    png_infop info_ptr),,121);
1619 1620

/* Returns image resolution in pixels per meter, from pHYs chunk data. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1621
PNG_EXPORT(png_uint_32,png_get_pixels_per_meter,(png_structp png_ptr,
1622
    png_infop info_ptr),,122);
G
[devel]  
Glenn Randers-Pehrson 已提交
1623 1624 1625 1626
PNG_EXPORT(png_uint_32,png_get_x_pixels_per_meter,(png_structp png_ptr,
    png_infop info_ptr),,123);
PNG_EXPORT(png_uint_32,png_get_y_pixels_per_meter,(png_structp png_ptr,
    png_infop info_ptr),,124);
1627 1628

/* Returns pixel aspect ratio, computed from pHYs chunk data.  */
G
[devel]  
Glenn Randers-Pehrson 已提交
1629 1630 1631 1632
PNG_FP_EXPORT(float,png_get_pixel_aspect_ratio,(png_structp png_ptr,
    png_infop info_ptr),,125);
PNG_FIXED_EXPORT(png_fixed_point,png_get_pixel_aspect_ratio_fixed,
    (png_structp png_ptr, png_infop info_ptr),,210);
1633 1634

/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1635 1636 1637 1638 1639 1640 1641 1642
PNG_EXPORT(png_int_32,png_get_x_offset_pixels,(png_structp png_ptr,
    png_infop info_ptr),,126);
PNG_EXPORT(png_int_32,png_get_y_offset_pixels,(png_structp png_ptr,
    png_infop info_ptr),,127);
PNG_EXPORT(png_int_32,png_get_x_offset_microns,(png_structp png_ptr,
    png_infop info_ptr),,128);
PNG_EXPORT(png_int_32, png_get_y_offset_microns,(png_structp png_ptr,
    png_infop info_ptr),,129);
1643 1644 1645

#endif /* PNG_EASY_ACCESS_SUPPORTED */

A
Andreas Dilger 已提交
1646
/* Returns pointer to signature string read from PNG header */
1647
PNG_EXPORT(png_const_bytep,png_get_signature,(png_structp png_ptr,
1648
    png_infop info_ptr),,130);
A
Andreas Dilger 已提交
1649

1650
#ifdef PNG_bKGD_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1651 1652
PNG_EXPORT(png_uint_32,png_get_bKGD,(png_structp png_ptr, png_infop info_ptr,
    png_color_16p *background),,131);
1653
#endif
A
Andreas Dilger 已提交
1654

1655
#ifdef PNG_bKGD_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1656
PNG_EXPORT(void,png_set_bKGD,(png_structp png_ptr, png_infop info_ptr,
1657
    png_const_color_16p background),,132);
1658
#endif
A
Andreas Dilger 已提交
1659

1660
#ifdef PNG_cHRM_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672
PNG_FP_EXPORT(png_uint_32,png_get_cHRM,(png_structp png_ptr,
    png_infop info_ptr, double *white_x, double *white_y, double *red_x,
    double *red_y, double *green_x, double *green_y, double *blue_x,
    double *blue_y),,133);
#ifdef PNG_FIXED_POINT_SUPPORTED /* Otherwise not implemented */
PNG_FIXED_EXPORT(png_uint_32,png_get_cHRM_fixed,(png_structp png_ptr,
    png_infop info_ptr, 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, png_fixed_point *int_blue_x,
    png_fixed_point *int_blue_y),,134);
#endif
1673
#endif
A
Andreas Dilger 已提交
1674

1675
#ifdef PNG_cHRM_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1676 1677 1678 1679 1680 1681 1682 1683 1684
PNG_FP_EXPORT(void,png_set_cHRM,(png_structp png_ptr, png_infop info_ptr,
    double white_x, double white_y, double red_x, double red_y, double green_x,
    double green_y, double blue_x, double blue_y),,135);
PNG_FIXED_EXPORT(void,png_set_cHRM_fixed,(png_structp png_ptr,
    png_infop info_ptr, 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, png_fixed_point int_blue_x,
    png_fixed_point int_blue_y),,136);
1685
#endif
A
Andreas Dilger 已提交
1686

1687
#ifdef PNG_gAMA_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1688 1689 1690
PNG_FP_EXPORT(png_uint_32,png_get_gAMA,(png_structp png_ptr, png_infop info_ptr,
    double *file_gamma),,137);
PNG_FIXED_EXPORT(png_uint_32,png_get_gAMA_fixed,(png_structp png_ptr,
1691
    png_infop info_ptr, png_fixed_point *int_file_gamma),,138);
1692
#endif
G
Guy Schalnat 已提交
1693

1694
#ifdef PNG_gAMA_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1695 1696 1697
PNG_FP_EXPORT(void,png_set_gAMA,(png_structp png_ptr, png_infop info_ptr,
    double file_gamma),,139);
PNG_FIXED_EXPORT(void,png_set_gAMA_fixed,(png_structp png_ptr,
1698
    png_infop info_ptr, png_fixed_point int_file_gamma),,140);
1699
#endif
A
Andreas Dilger 已提交
1700

1701
#ifdef PNG_hIST_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1702 1703
PNG_EXPORT(png_uint_32,png_get_hIST,(png_structp png_ptr, png_infop info_ptr,
    png_uint_16p *hist),,141);
1704
#endif
A
Andreas Dilger 已提交
1705

1706
#ifdef PNG_hIST_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1707
PNG_EXPORT(void,png_set_hIST,(png_structp png_ptr, png_infop info_ptr,
1708
    png_const_uint_16p hist),,142);
1709
#endif
A
Andreas Dilger 已提交
1710

G
[devel]  
Glenn Randers-Pehrson 已提交
1711 1712 1713
PNG_EXPORT(png_uint_32,png_get_IHDR,(png_structp png_ptr, png_infop 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),,143);
1714

G
[devel]  
Glenn Randers-Pehrson 已提交
1715 1716 1717
PNG_EXPORT(void,png_set_IHDR,(png_structp png_ptr, png_infop 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),,144);
A
Andreas Dilger 已提交
1718

1719
#ifdef PNG_oFFs_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1720 1721
PNG_EXPORT(png_uint_32,png_get_oFFs,(png_structp png_ptr, png_infop info_ptr,
    png_int_32 *offset_x, png_int_32 *offset_y, int *unit_type),,145);
1722
#endif
A
Andreas Dilger 已提交
1723

1724
#ifdef PNG_oFFs_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1725 1726
PNG_EXPORT(void,png_set_oFFs,(png_structp png_ptr, png_infop info_ptr,
    png_int_32 offset_x, png_int_32 offset_y, int unit_type),,146);
1727
#endif
A
Andreas Dilger 已提交
1728

1729
#ifdef PNG_pCAL_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1730 1731 1732
PNG_EXPORT(png_uint_32,png_get_pCAL,(png_structp png_ptr, png_infop info_ptr,
    png_charp *purpose, png_int_32 *X0, png_int_32 *X1, int *type, int *nparams,
    png_charp *units, png_charpp *params),,147);
1733
#endif
A
Andreas Dilger 已提交
1734

1735
#ifdef PNG_pCAL_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1736
PNG_EXPORT(void,png_set_pCAL,(png_structp png_ptr, png_infop info_ptr,
1737 1738
    png_const_charp purpose, png_int_32 X0, png_int_32 X1, int type,
    int nparams, png_const_charp units, png_charpp params),,148);
1739 1740
#endif

1741
#ifdef PNG_pHYs_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1742 1743
PNG_EXPORT(png_uint_32,png_get_pHYs,(png_structp png_ptr, png_infop info_ptr,
    png_uint_32 *res_x, png_uint_32 *res_y, int *unit_type),,149);
1744
#endif
A
Andreas Dilger 已提交
1745

1746
#ifdef PNG_pHYs_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1747 1748
PNG_EXPORT(void,png_set_pHYs,(png_structp png_ptr, png_infop info_ptr,
    png_uint_32 res_x, png_uint_32 res_y, int unit_type),,150);
1749
#endif
A
Andreas Dilger 已提交
1750

G
[devel]  
Glenn Randers-Pehrson 已提交
1751 1752
PNG_EXPORT(png_uint_32,png_get_PLTE,(png_structp png_ptr, png_infop info_ptr,
    png_colorp *palette, int *num_palette),,151);
A
Andreas Dilger 已提交
1753

G
[devel]  
Glenn Randers-Pehrson 已提交
1754
PNG_EXPORT(void,png_set_PLTE,(png_structp png_ptr, png_infop info_ptr,
1755
    png_const_colorp palette, int num_palette),,152);
A
Andreas Dilger 已提交
1756

1757
#ifdef PNG_sBIT_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1758 1759
PNG_EXPORT(png_uint_32,png_get_sBIT,(png_structp png_ptr, png_infop info_ptr,
    png_color_8p *sig_bit),,153);
1760
#endif
A
Andreas Dilger 已提交
1761

1762
#ifdef PNG_sBIT_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1763
PNG_EXPORT(void,png_set_sBIT,(png_structp png_ptr, png_infop info_ptr,
1764
    png_const_color_8p sig_bit),,154);
1765
#endif
A
Andreas Dilger 已提交
1766

1767
#ifdef PNG_sRGB_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1768 1769
PNG_EXPORT(png_uint_32,png_get_sRGB,(png_structp png_ptr, png_infop info_ptr,
    int *intent),,155);
1770
#endif
1771

1772
#ifdef PNG_sRGB_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1773 1774
PNG_EXPORT(void,png_set_sRGB,(png_structp png_ptr, png_infop info_ptr,
    int intent),,156);
1775
PNG_EXPORT(void,png_set_sRGB_gAMA_and_cHRM,(png_structp png_ptr,
1776
    png_infop info_ptr, int intent),,157);
1777 1778
#endif

1779
#ifdef PNG_iCCP_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1780 1781 1782
PNG_EXPORT(png_uint_32,png_get_iCCP,(png_structp png_ptr, png_infop info_ptr,
    png_charpp name, int *compression_type, png_bytepp profile,
    png_uint_32 *proflen),,158);
1783 1784
#endif

1785
#ifdef PNG_iCCP_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1786
PNG_EXPORT(void,png_set_iCCP,(png_structp png_ptr, png_infop info_ptr,
1787
    png_const_charp name, int compression_type, png_const_bytep profile,
G
[devel]  
Glenn Randers-Pehrson 已提交
1788
    png_uint_32 proflen),,159);
1789 1790
#endif

1791
#ifdef PNG_sPLT_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1792 1793
PNG_EXPORT(png_uint_32,png_get_sPLT,(png_structp png_ptr, png_infop info_ptr,
    png_sPLT_tpp entries),,160);
1794 1795
#endif

1796
#ifdef PNG_sPLT_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1797
PNG_EXPORT(void,png_set_sPLT,(png_structp png_ptr, png_infop info_ptr,
1798
    png_const_sPLT_tp entries, int nentries),,161);
1799 1800
#endif

1801
#ifdef PNG_TEXT_SUPPORTED
1802
/* png_get_text also returns the number of text chunks in *num_text */
G
[devel]  
Glenn Randers-Pehrson 已提交
1803 1804
PNG_EXPORT(png_uint_32,png_get_text,(png_structp png_ptr, png_infop info_ptr,
    png_textp *text_ptr, int *num_text),,162);
1805
#endif
A
Andreas Dilger 已提交
1806

1807 1808 1809 1810 1811
/* Note while png_set_text() will accept a structure whose text,
 * 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.
1812 1813
 */

1814
#ifdef PNG_TEXT_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1815
PNG_EXPORT(void,png_set_text,(png_structp png_ptr, png_infop info_ptr,
1816
    png_const_textp text_ptr, int num_text),,163);
1817
#endif
A
Andreas Dilger 已提交
1818

1819
#ifdef PNG_tIME_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1820 1821
PNG_EXPORT(png_uint_32,png_get_tIME,(png_structp png_ptr, png_infop info_ptr,
    png_timep *mod_time),,164);
1822
#endif
A
Andreas Dilger 已提交
1823

1824
#ifdef PNG_tIME_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1825
PNG_EXPORT(void,png_set_tIME,(png_structp png_ptr, png_infop info_ptr,
1826
    png_const_timep mod_time),,165);
1827
#endif
A
Andreas Dilger 已提交
1828

1829
#ifdef PNG_tRNS_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1830 1831
PNG_EXPORT(png_uint_32,png_get_tRNS,(png_structp png_ptr, png_infop info_ptr,
    png_bytep *trans_alpha, int *num_trans, png_color_16p *trans_color),,166);
1832 1833
#endif

1834
#ifdef PNG_tRNS_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1835
PNG_EXPORT(void,png_set_tRNS,(png_structp png_ptr, png_infop info_ptr,
1836 1837
    png_const_bytep trans_alpha, int num_trans,
    png_const_color_16p trans_color),,167);
1838 1839
#endif

1840
#ifdef PNG_sCAL_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1841 1842
PNG_FP_EXPORT(png_uint_32,png_get_sCAL,(png_structp png_ptr, png_infop info_ptr,
    int *unit, double *width, double *height),,168);
1843 1844 1845 1846 1847 1848
#ifdef PNG_FLOATING_ARITHMETIC_SUPPORTED
/* NOTE: this API is currently implemented using floating point arithmetic,
 * 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.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1849 1850 1851
PNG_FIXED_EXPORT(png_uint_32,png_get_sCAL_fixed,(png_structp png_ptr,
    png_infop info_ptr, int *unit, png_fixed_point *width,
    png_fixed_point *height),,214);
1852
#endif
1853
PNG_EXPORT(png_uint_32,png_get_sCAL_s,(png_structp png_ptr,
G
[devel]  
Glenn Randers-Pehrson 已提交
1854 1855 1856 1857 1858 1859
    png_infop info_ptr, int *unit, png_charpp swidth, png_charpp sheight),,169);

PNG_FP_EXPORT(void,png_set_sCAL,(png_structp png_ptr, png_infop info_ptr,
    int unit, double width, double height),,170);
PNG_FIXED_EXPORT(void,png_set_sCAL_fixed,(png_structp png_ptr,
   png_infop info_ptr, int unit, png_fixed_point width,
1860
   png_fixed_point height),,213);
G
[devel]  
Glenn Randers-Pehrson 已提交
1861
PNG_EXPORT(void,png_set_sCAL_s,(png_structp png_ptr, png_infop info_ptr,
1862
    int unit, png_const_charp swidth, png_const_charp sheight),,171);
1863
#endif /* PNG_sCAL_SUPPORTED */
1864

1865 1866
#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
/* Provide a list of chunks and how they are to be handled, if the built-in
1867 1868 1869
   handling or default unknown chunk handling is not desired.  Any chunks not
   listed will be handled in the default manner.  The IHDR and IEND chunks
   must not be listed.
1870
      keep = 0: follow default behaviour
1871 1872 1873 1874
           = 1: do not keep
           = 2: keep only if safe-to-copy
           = 3: keep even if unsafe-to-copy
*/
G
[devel]  
Glenn Randers-Pehrson 已提交
1875
PNG_EXPORT(void, png_set_keep_unknown_chunks,(png_structp png_ptr, int keep,
1876
    png_const_bytep chunk_list, int num_chunks),,172);
1877
PNG_EXPORT(int,png_handle_as_unknown,(png_structp png_ptr,
G
[devel]  
Glenn Randers-Pehrson 已提交
1878
    png_const_bytep chunk_name),,173);
1879
#endif
1880
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
1881
PNG_EXPORT(void, png_set_unknown_chunks,(png_structp png_ptr,
1882 1883
    png_infop info_ptr, png_const_unknown_chunkp unknowns, int num_unknowns),,
    174);
G
[devel]  
Glenn Randers-Pehrson 已提交
1884 1885
PNG_EXPORT(void, png_set_unknown_chunk_location, (png_structp png_ptr,
    png_infop info_ptr, int chunk, int location),,175);
1886
PNG_EXPORT(int,png_get_unknown_chunks,(png_structp png_ptr,
1887
    png_infop info_ptr, png_unknown_chunkpp entries),,176);
1888 1889
#endif

1890
/* Png_free_data() will turn off the "valid" flag for anything it frees.
1891 1892 1893
 * If you need to turn it off for a chunk that your application has freed,
 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1894 1895
PNG_EXPORT(void, png_set_invalid,(png_structp png_ptr, png_infop info_ptr,
    int mask),,177);
1896

1897
#ifdef PNG_INFO_IMAGE_SUPPORTED
1898
/* The "params" pointer is currently not used and is for future expansion. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1899 1900 1901 1902
PNG_EXPORT(void, png_read_png,(png_structp png_ptr, png_infop info_ptr,
    int transforms, png_voidp params),,178);
PNG_EXPORT(void, png_write_png,(png_structp png_ptr, png_infop info_ptr,
    int transforms, png_voidp params),,179);
1903 1904
#endif

1905 1906 1907 1908
PNG_EXPORT(png_const_charp,png_get_copyright,(png_structp png_ptr),,180);
PNG_EXPORT(png_const_charp,png_get_header_ver,(png_structp png_ptr),,181);
PNG_EXPORT(png_const_charp,png_get_header_version,(png_structp png_ptr),,182);
PNG_EXPORT(png_const_charp,png_get_libpng_ver,(png_structp png_ptr),,183);
1909

1910
#ifdef PNG_MNG_FEATURES_SUPPORTED
1911
PNG_EXPORT(png_uint_32,png_permit_mng_features,(png_structp png_ptr,
1912
    png_uint_32 mng_features_permitted),,184);
1913 1914
#endif

1915 1916 1917 1918 1919 1920
/* 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

1921
/* Strip the prepended error numbers ("#nnn ") from error and warning
1922 1923
 * messages before passing them to the error or warning handler.
 */
1924
#ifdef PNG_ERROR_NUMBERS_SUPPORTED
1925
PNG_EXPORT(void,png_set_strip_error_numbers,(png_structp png_ptr,
1926
    png_uint_32 strip_mode),,185);
1927
#endif
1928

1929
/* Added in libpng-1.2.6 */
1930
#ifdef PNG_SET_USER_LIMITS_SUPPORTED
1931
PNG_EXPORT(void,png_set_user_limits,(png_structp png_ptr,
1932
    png_uint_32 user_width_max, png_uint_32 user_height_max),,186);
G
[devel]  
Glenn Randers-Pehrson 已提交
1933 1934
PNG_EXPORT(png_uint_32,png_get_user_width_max,(png_structp png_ptr),,187);
PNG_EXPORT(png_uint_32,png_get_user_height_max,(png_structp png_ptr),,188);
1935
/* Added in libpng-1.4.0 */
1936
PNG_EXPORT(void,png_set_chunk_cache_max,(png_structp png_ptr,
1937
    png_uint_32 user_chunk_cache_max),,189);
G
[devel]  
Glenn Randers-Pehrson 已提交
1938
PNG_EXPORT(png_uint_32,png_get_chunk_cache_max,(png_structp png_ptr),,190);
1939
/* Added in libpng-1.4.1 */
1940
PNG_EXPORT(void,png_set_chunk_malloc_max,(png_structp png_ptr,
1941
    png_alloc_size_t user_chunk_cache_max),,191);
G
[devel]  
Glenn Randers-Pehrson 已提交
1942 1943
PNG_EXPORT(png_alloc_size_t,png_get_chunk_malloc_max,(png_structp png_ptr),,
    192);
1944 1945
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
1946
#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
1947 1948
PNG_EXPORT(png_uint_32,png_get_pixels_per_inch,(png_structp png_ptr,
    png_infop info_ptr),,193);
1949

1950 1951
PNG_EXPORT(png_uint_32,png_get_x_pixels_per_inch,(png_structp png_ptr,
    png_infop info_ptr),,194);
1952

1953 1954
PNG_EXPORT(png_uint_32,png_get_y_pixels_per_inch,(png_structp png_ptr,
    png_infop info_ptr),,195);
1955

G
[devel]  
Glenn Randers-Pehrson 已提交
1956
PNG_FP_EXPORT(float,png_get_x_offset_inches,(png_structp png_ptr,
1957
    png_infop info_ptr),,196);
G
[devel]  
Glenn Randers-Pehrson 已提交
1958 1959 1960 1961
#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
PNG_FIXED_EXPORT(png_fixed_point,png_get_x_offset_inches_fixed,
    (png_structp png_ptr, png_infop info_ptr),,211);
#endif
1962

G
[devel]  
Glenn Randers-Pehrson 已提交
1963
PNG_FP_EXPORT(float,png_get_y_offset_inches,(png_structp png_ptr,
1964
    png_infop info_ptr),,197);
G
[devel]  
Glenn Randers-Pehrson 已提交
1965 1966 1967 1968
#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
PNG_FIXED_EXPORT(png_fixed_point,png_get_y_offset_inches_fixed,
    (png_structp png_ptr, png_infop info_ptr),,212);
#endif
1969

1970
#  ifdef PNG_pHYs_SUPPORTED
1971
PNG_EXPORT(png_uint_32,png_get_pHYs_dpi,(png_structp png_ptr,
G
[devel]  
Glenn Randers-Pehrson 已提交
1972 1973
    png_infop info_ptr, png_uint_32 *res_x, png_uint_32 *res_y, int *unit_type),
    ,198);
1974
#  endif /* PNG_pHYs_SUPPORTED */
G
[devel]  
Glenn Randers-Pehrson 已提交
1975
#endif  /* PNG_INCH_CONVERSIONS_SUPPORTED */
1976

1977 1978
/* Added in libpng-1.4.0 */
#ifdef PNG_IO_STATE_SUPPORTED
1979
PNG_EXPORT(png_uint_32,png_get_io_state,(png_structp png_ptr),,199);
1980

1981
PNG_EXPORT(png_const_bytep,png_get_io_chunk_name,(png_structp png_ptr),,200);
1982 1983

/* The flags returned by png_get_io_state() are the following: */
1984 1985 1986 1987 1988 1989 1990 1991 1992
#  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 */
1993 1994
#endif /* ?PNG_IO_STATE_SUPPORTED */

1995
#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
1996 1997 1998
/* 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
1999 2000 2001 2002 2003 2004 2005 2006 2007
 * 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. :-) ]
 */

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

2010 2011 2012 2013 2014
#  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)) + (png_uint_16)128);   \
2015
       (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
2016

2017 2018 2019 2020 2021
#  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)*(png_uint_32)(65535L        \
           - (png_uint_32)(alpha)) + (png_uint_32)32768L); \
2022 2023
       (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }

2024
#else  /* Standard method using integer division */
2025

2026 2027
#  define png_composite(composite, fg, alpha, bg)                          \
     (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) +  \
2028 2029
     (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) +       \
     (png_uint_16)127) / 255)
2030 2031

#  define png_composite_16(composite, fg, alpha, bg)                         \
2032
     (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \
2033
     (png_uint_32)(bg)*(png_uint_32)(65535L - (png_uint_32)(alpha)) +        \
2034
     (png_uint_32)32767) / (png_uint_32)65535L)
2035 2036
#endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */

2037 2038 2039 2040
#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.
2041
 */
2042 2043 2044 2045 2046 2047
#  define png_get_uint_32(buf) \
     (((png_uint_32)(*(buf)) << 24) + \
      ((png_uint_32)(*((buf) + 1)) << 16) + \
      ((png_uint_32)(*((buf) + 2)) << 8) + \
      ((png_uint_32)(*((buf) + 3))))
#  define png_get_uint_16(buf) \
2048 2049 2050
     ((png_uint_16) \
      (((unsigned int)(*(buf)) << 8) + \
       ((unsigned int)(*((buf) + 1)))))
G
[devel]  
Glenn Randers-Pehrson 已提交
2051 2052
#  define png_get_int_32(buf) \
     ((png_int_32)((*(buf) & 0x80) \
2053
      ? -((png_int_32)((png_get_uint_32(buf) ^ 0xffffffffL) + 1)) \
2054
      : (png_int_32)png_get_uint_32(buf)))
2055
#endif
2056 2057

#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
2058 2059 2060
PNG_EXPORT(png_uint_32,png_get_uint_32,(png_const_bytep buf),,201);
PNG_EXPORT(png_uint_16,png_get_uint_16,(png_const_bytep buf),,202);
PNG_EXPORT(png_int_32,png_get_int_32,(png_const_bytep buf),,203);
2061 2062
#endif

2063 2064
PNG_EXPORT(png_uint_32,png_get_uint_31,(png_structp png_ptr,
    png_const_bytep buf),,204);
2065 2066
/* No png_get_int_16 -- may be added if there's a real need for it. */

2067
/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
2068
#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2069
PNG_EXPORT(void,png_save_uint_32,(png_bytep buf, png_uint_32 i),,205);
2070
#endif
2071
#ifdef PNG_SAVE_INT_32_SUPPORTED
2072
PNG_EXPORT(void,png_save_int_32,(png_bytep buf, png_int_32 i),,206);
2073
#endif
2074 2075 2076 2077 2078

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

G
[devel]  
Glenn Randers-Pehrson 已提交
2084 2085 2086 2087
/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
 * defs
 */

2088 2089 2090 2091
/* The last ordinal number (this is the *last* one, the next one to
 * use is one more than this.)
 */
#ifdef PNG_EXPORT_LAST_ORDINAL
2092
  PNG_EXPORT_LAST_ORDINAL(218);
2093 2094
#endif

A
Andreas Dilger 已提交
2095 2096 2097 2098
#ifdef __cplusplus
}
#endif

2099
#endif /* PNG_VERSION_INFO_ONLY */
2100
/* Do not put anything past this line */
2101
#endif /* PNG_H */