png.h 84.3 KB
Newer Older
1

A
Andreas Dilger 已提交
2
/* png.h - header file for PNG reference library
3
 *
4
 * libpng version 1.5.0beta33 - June 29, 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.0beta33 - June 29, 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
 *    1.5.0beta01-33          15    10500  15.so.15.0[.0]
144
 *
145 146 147 148 149 150 151 152 153
 *   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".
154
 *
155 156 157
 *   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.
158
 *
159 160
 *   DLLNUM will change each time there are forward or backward changes
 *   in binary compatibility (e.g., when a new feature is added).
161
 *
162
 * See libpng.txt or libpng.3 for more information.  The PNG specification
163 164
 * is available as a W3C Recommendation and as an ISO Specification,
 * <http://www.w3.org/TR/2003/REC-PNG-20031110/
165 166 167
 */

/*
168 169
 * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
 *
170 171
 * If you modify libpng you may insert additional notices immediately following
 * this sentence.
172
 *
173 174
 * This code is released under the libpng license.
 *
175
 * libpng versions 1.2.6, August 15, 2004, through 1.5.0beta33, June 29, 2010, are
176
 * Copyright (c) 2004, 2006-2010 Glenn Randers-Pehrson, and are
177
 * distributed according to the same disclaimer and license as libpng-1.2.5
178
 * with the following individual added to the list of Contributing Authors:
179 180 181
 *
 *    Cosmin Truta
 *
182
 * libpng versions 1.0.7, July 1, 2000, through 1.2.5, October 3, 2002, are
183
 * Copyright (c) 2000-2002 Glenn Randers-Pehrson, and are
184
 * distributed according to the same disclaimer and license as libpng-1.0.6
185
 * with the following individuals added to the list of Contributing Authors:
186
 *
187 188 189 190
 *    Simon-Pierre Cadieux
 *    Eric S. Raymond
 *    Gilles Vollant
 *
191 192 193 194 195 196 197 198 199 200
 * 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
201 202
 * Copyright (c) 1998, 1999, 2000 Glenn Randers-Pehrson, and are
 * distributed according to the same disclaimer and license as libpng-0.96,
203 204 205 206 207 208 209 210 211 212
 * 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:
213
 *
214 215
 *    John Bowler
 *    Kevin Bracey
216
 *    Sam Bushell
217 218
 *    Magnus Holmgren
 *    Greg Roelofs
219 220 221 222 223 224 225 226 227 228
 *    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
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
 *    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:
244
 *
245
 *   1. The origin of this source code must not be misrepresented.
246
 *
247 248
 *   2. Altered versions must be plainly marked as such and must not
 *      be misrepresented as being the original source.
249
 *
250 251
 *   3. This Copyright notice may not be removed or altered from
 *      any source or altered source distribution.
252 253 254 255 256 257 258
 *
 * 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 已提交
259

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

/*
271 272 273 274 275 276 277 278 279 280 281 282
 * 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.
 */

283 284 285 286
/*
 * Y2K compliance in libpng:
 * =========================
 *
287
 *    June 29, 2010
288 289 290 291 292
 *
 *    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
293
 *    upward through 1.5.0beta33 are Y2K compliant.  It is my belief that earlier
294 295 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
 *    versions were also Y2K compliant.
 *
 *    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
 */

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

/* This is not the place to learn how to use libpng.  The file libpng.txt
A
Andreas Dilger 已提交
343 344 345 346
 * 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 已提交
347

348
/* Version information for png.h - this should match the version in png.c */
349
#define PNG_LIBPNG_VER_STRING "1.5.0beta33"
350
#define PNG_HEADER_VERSION_STRING \
351
     " libpng version 1.5.0beta33 - June 29, 2010\n"
352

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

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

364
#define PNG_LIBPNG_VER_BUILD  33
365

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

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

381
#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_BETA
382

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

391 392 393 394
/* Library configuration: these options cannot be changed after
 * the library has been built.
 */
#ifndef PNGLCONF_H
395
#   include "pnglibconf.h"
396 397
#endif

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

407
/* Include the compression library's header */
408
#  include "zlib.h"
G
Guy Schalnat 已提交
409

410 411 412
/* Machine specific configuration. */
#  include "pngconf.h"
#endif
G
Guy Schalnat 已提交
413

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

428
#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
429
#  define PNG_LIBPNG_BUILD_TYPE \
430
       (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
431
#else
432
#  ifdef PNG_LIBPNG_SPECIALBUILD
433
#    define PNG_LIBPNG_BUILD_TYPE \
434
         (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
435
#  else
436
#    define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
437 438 439 440 441
#  endif
#endif

#ifndef PNG_VERSION_INFO_ONLY

442 443 444 445 446
/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

A
Andreas Dilger 已提交
447 448 449
/* Version information for C files, stored in png.c.  This had better match
 * the version above.
 */
450
#define png_libpng_ver png_get_header_ver(NULL)
A
Andreas Dilger 已提交
451

452 453 454
/* This file is arranged in several sections:
 *
 * 1. Any configuration options that can be specified by for the application
455
 *    code when it is built.  (Build time configuration is in pnglibconf.h)
456 457 458 459 460 461 462 463
 * 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
464
 * See pnglibconf.h for build time configuration
465 466 467
 *
 * Run time configuration allows the application to choose between
 * implementations of certain arithmetic APIs.  The default is set
468
 * at build time and recorded in pnglibconf.h, but it is safe to
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
 * 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
 */
A
Andreas Dilger 已提交
497 498 499 500
/* 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 已提交
501 502
typedef struct png_color_struct
{
G
Guy Schalnat 已提交
503
   png_byte red;
G
Guy Schalnat 已提交
504 505 506
   png_byte green;
   png_byte blue;
} png_color;
A
Andreas Dilger 已提交
507 508
typedef png_color FAR * png_colorp;
typedef png_color FAR * FAR * png_colorpp;
G
Guy Schalnat 已提交
509 510 511

typedef struct png_color_16_struct
{
A
Andreas Dilger 已提交
512 513
   png_byte index;    /* used for palette files */
   png_uint_16 red;   /* for use in red green blue files */
G
Guy Schalnat 已提交
514 515
   png_uint_16 green;
   png_uint_16 blue;
A
Andreas Dilger 已提交
516
   png_uint_16 gray;  /* for use in grayscale files */
G
Guy Schalnat 已提交
517
} png_color_16;
A
Andreas Dilger 已提交
518 519
typedef png_color_16 FAR * png_color_16p;
typedef png_color_16 FAR * FAR * png_color_16pp;
G
Guy Schalnat 已提交
520 521 522

typedef struct png_color_8_struct
{
A
Andreas Dilger 已提交
523
   png_byte red;   /* for use in red green blue files */
G
Guy Schalnat 已提交
524 525
   png_byte green;
   png_byte blue;
A
Andreas Dilger 已提交
526
   png_byte gray;  /* for use in grayscale files */
G
Guy Schalnat 已提交
527 528
   png_byte alpha; /* for alpha channel files */
} png_color_8;
A
Andreas Dilger 已提交
529 530
typedef png_color_8 FAR * png_color_8p;
typedef png_color_8 FAR * FAR * png_color_8pp;
G
Guy Schalnat 已提交
531

532 533 534 535
/*
 * The following two structures are used for the in-core representation
 * of sPLT chunks.
 */
536
typedef struct png_sPLT_entry_struct
537 538 539 540 541 542
{
   png_uint_16 red;
   png_uint_16 green;
   png_uint_16 blue;
   png_uint_16 alpha;
   png_uint_16 frequency;
543 544 545
} png_sPLT_entry;
typedef png_sPLT_entry FAR * png_sPLT_entryp;
typedef png_sPLT_entry FAR * FAR * png_sPLT_entrypp;
546

547 548 549 550 551
/*  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.
 */

552
typedef struct png_sPLT_struct
553
{
554 555 556 557
   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 */
558 559 560
} png_sPLT_t;
typedef png_sPLT_t FAR * png_sPLT_tp;
typedef png_sPLT_t FAR * FAR * png_sPLT_tpp;
561 562

#ifdef PNG_TEXT_SUPPORTED
563 564
/* 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
565 566 567 568 569 570
 * 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 已提交
571 572
typedef struct png_text_struct
{
573 574 575 576 577
   int  compression;       /* compression value:
                             -1: tEXt, none
                              0: zTXt, deflate
                              1: iTXt, none
                              2: iTXt, deflate  */
A
Andreas Dilger 已提交
578
   png_charp key;          /* keyword, 1-79 character description of "text" */
579 580
   png_charp text;         /* comment, may be an empty string (ie "")
                              or a NULL pointer */
581 582
   png_size_t text_length; /* length of the text string */
   png_size_t itxt_length; /* length of the itxt string */
583 584
   png_charp lang;         /* language code, 0-79 characters
                              or a NULL pointer */
585
   png_charp lang_key;     /* keyword translated UTF-8 string, 0 or more
586
                              chars or a NULL pointer */
G
Guy Schalnat 已提交
587
} png_text;
A
Andreas Dilger 已提交
588 589
typedef png_text FAR * png_textp;
typedef png_text FAR * FAR * png_textpp;
590
#endif
A
Andreas Dilger 已提交
591 592 593 594 595 596 597

/* 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
598 599 600
#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 已提交
601 602

/* png_time is a way to hold the time in an machine independent way.
603 604 605
 * 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
606
 * note - PNG has always been Year 2000 compliant!
607
 */
G
Guy Schalnat 已提交
608 609 610
typedef struct png_time_struct
{
   png_uint_16 year; /* full year, as in, 1995 */
A
Andreas Dilger 已提交
611 612 613 614 615
   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 已提交
616
} png_time;
A
Andreas Dilger 已提交
617 618 619
typedef png_time FAR * png_timep;
typedef png_time FAR * FAR * png_timepp;

620
#if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED) || \
621
    defined(PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
622 623 624 625 626 627 628 629 630 631 632
/* 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;

633
    /* libpng-using applications should NOT directly modify this byte. */
634 635 636 637 638 639 640
    png_byte location; /* mode of operation at read time */
}
png_unknown_chunk;
typedef png_unknown_chunk FAR * png_unknown_chunkp;
typedef png_unknown_chunk FAR * FAR * png_unknown_chunkpp;
#endif

641
typedef struct png_info_def png_info;
A
Andreas Dilger 已提交
642 643
typedef png_info FAR * png_infop;
typedef png_info FAR * FAR * png_infopp;
G
Guy Schalnat 已提交
644

645
/* Maximum positive integer used in PNG is (2^31)-1 */
646
#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
647 648
#define PNG_UINT_32_MAX ((png_uint_32)(-1))
#define PNG_SIZE_MAX ((png_size_t)(-1))
649

A
Andreas Dilger 已提交
650
/* These describe the color_type field in png_info. */
G
Guy Schalnat 已提交
651
/* color type masks */
A
Andreas Dilger 已提交
652 653 654
#define PNG_COLOR_MASK_PALETTE    1
#define PNG_COLOR_MASK_COLOR      2
#define PNG_COLOR_MASK_ALPHA      4
G
Guy Schalnat 已提交
655 656

/* color types.  Note that not all combinations are legal */
G
Guy Schalnat 已提交
657
#define PNG_COLOR_TYPE_GRAY 0
A
Andreas Dilger 已提交
658 659 660
#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 已提交
661
#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
662 663 664
/* aliases */
#define PNG_COLOR_TYPE_RGBA  PNG_COLOR_TYPE_RGB_ALPHA
#define PNG_COLOR_TYPE_GA  PNG_COLOR_TYPE_GRAY_ALPHA
G
Guy Schalnat 已提交
665

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

670
/* This is for filter type. PNG 1.0-1.2 only define the single type. */
A
Andreas Dilger 已提交
671
#define PNG_FILTER_TYPE_BASE      0 /* Single row per-byte filtering */
672
#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
A
Andreas Dilger 已提交
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
#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 */

692 693 694 695 696 697
/* 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 已提交
698 699 700 701 702
/* 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 */

703
/* These are for the sRGB chunk.  These values should NOT be changed. */
704 705 706 707
#define PNG_sRGB_INTENT_PERCEPTUAL 0
#define PNG_sRGB_INTENT_RELATIVE   1
#define PNG_sRGB_INTENT_SATURATION 2
#define PNG_sRGB_INTENT_ABSOLUTE   3
708
#define PNG_sRGB_INTENT_LAST       4 /* Not a valid value */
709

710 711
/* This is for text chunks */
#define PNG_KEYWORD_MAX_LENGTH     79
712

713
/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
714
#define PNG_MAX_PALETTE_LENGTH    256
715

A
Andreas Dilger 已提交
716 717 718 719 720
/* 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 已提交
721 722 723 724 725 726 727 728 729 730
#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 已提交
731
#define PNG_INFO_pCAL 0x0400
732
#define PNG_INFO_sRGB 0x0800   /* GR-P, 0.96a */
733 734 735
#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 */
736
#define PNG_INFO_IDAT 0x8000L  /* ESR, 1.0.6 */
G
Guy Schalnat 已提交
737

A
Andreas Dilger 已提交
738 739 740 741
/* 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 已提交
742 743
typedef struct png_row_info_struct
{
G
Guy Schalnat 已提交
744
   png_uint_32 width; /* width of row */
745
   png_size_t rowbytes; /* number of bytes in row */
G
Guy Schalnat 已提交
746 747 748 749
   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 已提交
750 751
} png_row_info;

A
Andreas Dilger 已提交
752 753
typedef png_row_info FAR * png_row_infop;
typedef png_row_info FAR * FAR * png_row_infopp;
G
Guy Schalnat 已提交
754

755 756 757 758 759
/* 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
 * user read/write data functions.
G
Guy Schalnat 已提交
760
 */
G
Guy Schalnat 已提交
761 762 763
typedef struct png_struct_def png_struct;
typedef png_struct FAR * png_structp;

764 765 766 767 768 769 770
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),);
771

G
Guy Schalnat 已提交
772
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
773 774 775 776 777
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),);
778
#endif
G
Guy Schalnat 已提交
779

780
#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
781
    defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
782 783
typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
    png_bytep),);
784
#endif
785

786
#ifdef PNG_USER_CHUNKS_SUPPORTED
787 788
typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
    png_unknown_chunkp),);
789
#endif
790
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
791
typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp),);
792
#endif
793 794 795
#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
796
 * of jmp_buf.  The function is required to be PNG_NORETURN.
797
 */
798
typedef void (PNGCAPI *png_longjmp_ptr) PNGARG((jmp_buf, int)) PNG_NORETURN;
799
#endif
800 801

/* Transform masks for the high-level interface */
802 803
#define PNG_TRANSFORM_IDENTITY       0x0000    /* read and write */
#define PNG_TRANSFORM_STRIP_16       0x0001    /* read only */
804 805
#define PNG_TRANSFORM_STRIP_ALPHA    0x0002    /* read only */
#define PNG_TRANSFORM_PACKING        0x0004    /* read and write */
806 807
#define PNG_TRANSFORM_PACKSWAP       0x0008    /* read and write */
#define PNG_TRANSFORM_EXPAND         0x0010    /* read only */
808
#define PNG_TRANSFORM_INVERT_MONO    0x0020    /* read and write */
809 810 811
#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 */
812
#define PNG_TRANSFORM_SWAP_ENDIAN    0x0200    /* read and write */
813
#define PNG_TRANSFORM_INVERT_ALPHA   0x0400    /* read and write */
814
#define PNG_TRANSFORM_STRIP_FILLER   0x0800    /* write only */
815
/* Added to libpng-1.2.34 */
816
#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
817 818 819
#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
/* Added to libpng-1.4.0 */
#define PNG_TRANSFORM_GRAY_TO_RGB   0x2000      /* read only */
820

821
/* Flags for MNG supported features */
822 823
#define PNG_FLAG_MNG_EMPTY_PLTE     0x01
#define PNG_FLAG_MNG_FILTER_64      0x04
824
#define PNG_ALL_MNG_FEATURES        0x05
825

826 827 828 829 830 831 832 833 834
/* 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),);
835

836 837
/* This triggers a compiler error in png.c, if png.c and png.h
 * do not agree upon the version number.
838
 */
839
typedef png_structp version_1_5_0beta33;
840

A
Andreas Dilger 已提交
841
typedef png_struct FAR * FAR * png_structpp;
G
Guy Schalnat 已提交
842

843 844
/* Section 3: exported functions
 * Here are the function definitions most commonly used.  This is not
A
Andreas Dilger 已提交
845 846
 * the place to find out how to use libpng.  See libpng.txt for the
 * full explanation, see example.c for the summary.  This just provides
847
 * a simple one line description of the use of each function.
A
Andreas Dilger 已提交
848
 */
G
Guy Schalnat 已提交
849

850
/* Returns the version number of the library */
851
extern PNG_EXPORT(png_uint_32,png_access_version_number,(void),,1);
852

A
Andreas Dilger 已提交
853
/* Tell lib we have already handled the first <num_bytes> magic bytes.
A
Andreas Dilger 已提交
854 855
 * Handling more than 8 bytes from the beginning of the file is an error.
 */
856 857
extern PNG_EXPORT(void,png_set_sig_bytes,(png_structp png_ptr,
    int num_bytes),,2);
A
Andreas Dilger 已提交
858 859 860 861 862 863

/* 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).
 */
864 865
extern PNG_EXPORT(int,png_sig_cmp,(png_bytep sig, png_size_t start,
    png_size_t num_to_check),,3);
A
Andreas Dilger 已提交
866

867 868 869 870 871
/* 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 已提交
872
/* Allocate and initialize png_ptr struct for reading, and any other memory. */
873 874 875
extern 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 已提交
876

877
/* Allocate and initialize png_ptr struct for writing, and any other memory */
878 879 880
extern 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 已提交
881

882 883
extern PNG_EXPORT(png_size_t,png_get_compression_buffer_size,(png_structp
    png_ptr),,6);
884

885 886
extern PNG_EXPORT(void,png_set_compression_buffer_size,(png_structp png_ptr,
    png_size_t size),,7);
887

888 889 890 891 892 893 894 895 896 897 898
/* 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.
 */
899 900
extern PNG_EXPORT(jmp_buf*, png_set_longjmp_fn, (png_structp png_ptr,
    png_longjmp_ptr longjmp_fn, size_t jmp_buf_size),,8);
901
#  define png_jmpbuf(png_ptr) \
902
      (*png_set_longjmp_fn((png_ptr), longjmp, sizeof (jmp_buf)))
903 904
#else
#  define png_jmpbuf(png_ptr) \
905
      (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
906
#endif
907 908 909 910 911
/* 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.
 */
912 913
extern PNG_EXPORT(void, png_longjmp, (png_structp png_ptr, int val),
    PNG_NORETURN,9);
914

915
#ifdef PNG_READ_SUPPORTED
916
/* Reset the compression stream */
917
extern PNG_EXPORT(int,png_reset_zstream,(png_structp png_ptr),,10);
918
#endif
919

920
/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
921
#ifdef PNG_USER_MEM_SUPPORTED
922 923
extern PNG_EXPORT(png_structp,png_create_read_struct_2,
    (png_const_charp user_png_ver, png_voidp error_ptr,
924
    png_error_ptr error_fn, png_error_ptr warn_fn, png_voidp mem_ptr,
925 926 927
    png_malloc_ptr malloc_fn, png_free_ptr free_fn),PNG_ALLOCATED,11);
extern PNG_EXPORT(png_structp,png_create_write_struct_2,
    (png_const_charp user_png_ver, png_voidp error_ptr,
928
    png_error_ptr error_fn, png_error_ptr warn_fn, png_voidp mem_ptr,
929
    png_malloc_ptr malloc_fn, png_free_ptr free_fn),PNG_ALLOCATED,12);
930 931
#endif

932
/* Write the PNG file signature. */
933
extern PNG_EXPORT(void,png_write_sig,(png_structp png_ptr),,13);
934

935
/* Write a PNG chunk - size, type, (optional) data, CRC. */
936 937
extern PNG_EXPORT(void,png_write_chunk,(png_structp png_ptr,
    png_bytep chunk_name, png_bytep data, png_size_t length),,14);
938 939

/* Write the start of a PNG chunk - length and chunk name. */
940 941
extern PNG_EXPORT(void,png_write_chunk_start,(png_structp png_ptr,
    png_bytep chunk_name, png_uint_32 length),,15);
942 943

/* Write the data of a PNG chunk started with png_write_chunk_start(). */
944 945
extern PNG_EXPORT(void,png_write_chunk_data,(png_structp png_ptr,
    png_bytep data, png_size_t length),,16);
946 947

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

A
Andreas Dilger 已提交
950
/* Allocate and initialize the info structure */
951 952
extern PNG_EXPORT(png_infop,png_create_info_struct,(png_structp png_ptr),
    PNG_ALLOCATED,18);
G
Guy Schalnat 已提交
953

954 955
extern PNG_EXPORT(void,png_info_init_3,(png_infopp info_ptr,
    png_size_t png_info_struct_size),,19);
G
Guy Schalnat 已提交
956

A
Andreas Dilger 已提交
957
/* Writes all the PNG information before the image. */
958 959 960 961
extern PNG_EXPORT(void,png_write_info_before_PLTE,(png_structp png_ptr,
    png_infop info_ptr),,20);
extern PNG_EXPORT(void,png_write_info,(png_structp png_ptr,
    png_infop info_ptr),,21);
G
Guy Schalnat 已提交
962

963
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
964
/* Read the information before the actual image data. */
965 966
extern PNG_EXPORT(void,png_read_info,(png_structp png_ptr,
    png_infop info_ptr),,22);
967
#endif
G
Guy Schalnat 已提交
968

969
#ifdef PNG_TIME_RFC1123_SUPPORTED
970 971
extern PNG_EXPORT(png_charp,png_convert_to_rfc1123,(png_structp png_ptr,
    png_timep ptime),,23);
972
#endif
973

974
#ifdef PNG_CONVERT_tIME_SUPPORTED
975
/* Convert from a struct tm to png_time */
976 977
extern PNG_EXPORT(void,png_convert_from_struct_tm,(png_timep ptime,
    struct tm FAR * ttime),,24);
G
Guy Schalnat 已提交
978

979
/* Convert from time_t to png_time.  Uses gmtime() */
980 981
extern PNG_EXPORT(void,png_convert_from_time_t,(png_timep ptime,
    time_t ttime),,25);
982
#endif /* PNG_CONVERT_tIME_SUPPORTED */
G
Guy Schalnat 已提交
983

984
#ifdef PNG_READ_EXPAND_SUPPORTED
985
/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
986 987 988 989 990
extern PNG_EXPORT(void,png_set_expand,(png_structp png_ptr),,26);
extern PNG_EXPORT(void,png_set_expand_gray_1_2_4_to_8,(png_structp png_ptr),,
    27);
extern PNG_EXPORT(void,png_set_palette_to_rgb,(png_structp png_ptr),,28);
extern PNG_EXPORT(void,png_set_tRNS_to_alpha,(png_structp png_ptr),,29);
991
#endif
G
Guy Schalnat 已提交
992

G
Guy Schalnat 已提交
993
#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
G
Guy Schalnat 已提交
994
/* Use blue, green, red order for pixels. */
995
extern PNG_EXPORT(void,png_set_bgr,(png_structp png_ptr),,30);
996
#endif
G
Guy Schalnat 已提交
997

998
#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
999
/* Expand the grayscale to 24-bit RGB if necessary. */
1000
extern PNG_EXPORT(void,png_set_gray_to_rgb,(png_structp png_ptr),,31);
G
Guy Schalnat 已提交
1001

1002
/* Reduce RGB to grayscale. */
1003
#  ifdef PNG_FLOATING_POINT_SUPPORTED
1004 1005
extern PNG_EXPORT(void,png_set_rgb_to_gray,(png_structp png_ptr,
    int error_action, double red, double green ),,32);
1006
#  endif
1007
#  ifdef PNG_FIXED_POINT_SUPPORTED
1008 1009
extern PNG_EXPORT(void,png_set_rgb_to_gray_fixed,(png_structp png_ptr,
    int error_action, png_fixed_point red, png_fixed_point green),,33);
1010 1011
#  endif

1012 1013
extern PNG_EXPORT(png_byte,png_get_rgb_to_gray_status,(png_structp png_ptr),,
    34);
1014
#endif
A
Andreas Dilger 已提交
1015

1016 1017
extern PNG_EXPORT(void,png_build_grayscale_palette,(int bit_depth,
    png_colorp palette),,35);
A
Andreas Dilger 已提交
1018

1019
#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
1020
extern PNG_EXPORT(void,png_set_strip_alpha,(png_structp png_ptr),,36);
1021
#endif
G
Guy Schalnat 已提交
1022

A
Andreas Dilger 已提交
1023 1024
#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
1025
extern PNG_EXPORT(void,png_set_swap_alpha,(png_structp png_ptr),,37);
1026
#endif
G
Guy Schalnat 已提交
1027

1028 1029
#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
1030
extern PNG_EXPORT(void,png_set_invert_alpha,(png_structp png_ptr),,38);
1031
#endif
1032

A
Andreas Dilger 已提交
1033
#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
1034
/* Add a filler byte to 8-bit Gray or 24-bit RGB images. */
1035 1036
extern PNG_EXPORT(void,png_set_filler,(png_structp png_ptr,
    png_uint_32 filler, int flags),,39);
A
Andreas Dilger 已提交
1037
/* The values of the PNG_FILLER_ defines should NOT be changed */
1038 1039
#  define PNG_FILLER_BEFORE 0
#  define PNG_FILLER_AFTER 1
1040
/* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */
1041 1042
extern PNG_EXPORT(void,png_set_add_alpha,(png_structp png_ptr,
    png_uint_32 filler, int flags),,40);
A
Andreas Dilger 已提交
1043
#endif /* PNG_READ_FILLER_SUPPORTED || PNG_WRITE_FILLER_SUPPORTED */
G
Guy Schalnat 已提交
1044

G
Guy Schalnat 已提交
1045
#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
1046
/* Swap bytes in 16-bit depth files. */
1047
extern PNG_EXPORT(void,png_set_swap,(png_structp png_ptr),,41);
1048
#endif
G
Guy Schalnat 已提交
1049

G
Guy Schalnat 已提交
1050
#if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED)
1051
/* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */
1052
extern PNG_EXPORT(void,png_set_packing,(png_structp png_ptr),,42);
1053
#endif
A
Andreas Dilger 已提交
1054

1055 1056
#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
    defined(PNG_WRITE_PACKSWAP_SUPPORTED)
A
Andreas Dilger 已提交
1057
/* Swap packing order of pixels in bytes. */
1058
extern PNG_EXPORT(void,png_set_packswap,(png_structp png_ptr),,43);
1059
#endif
G
Guy Schalnat 已提交
1060

G
Guy Schalnat 已提交
1061
#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
G
Guy Schalnat 已提交
1062
/* Converts files to legal bit depths. */
1063 1064
extern PNG_EXPORT(void,png_set_shift,(png_structp png_ptr,
    png_color_8p true_bits),,44);
1065
#endif
G
Guy Schalnat 已提交
1066

G
Guy Schalnat 已提交
1067 1068
#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
    defined(PNG_WRITE_INTERLACING_SUPPORTED)
G
Guy Schalnat 已提交
1069
/* Have the code handle the interlacing.  Returns the number of passes. */
1070
extern PNG_EXPORT(int,png_set_interlace_handling,(png_structp png_ptr),,45);
1071
#endif
G
Guy Schalnat 已提交
1072

G
Guy Schalnat 已提交
1073
#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
1074
/* Invert monochrome files */
1075
extern PNG_EXPORT(void,png_set_invert_mono,(png_structp png_ptr),,46);
1076
#endif
G
Guy Schalnat 已提交
1077

1078
#ifdef PNG_READ_BACKGROUND_SUPPORTED
G
Guy Schalnat 已提交
1079
/* Handle alpha and tRNS by replacing with a background color. */
1080
#  ifdef PNG_FLOATING_POINT_SUPPORTED
1081
extern PNG_EXPORT(void,png_set_background,(png_structp png_ptr,
1082
    png_color_16p background_color, int background_gamma_code,
1083
    int need_expand, double background_gamma),,47);
1084
#  endif
1085
/* TODO: png_set_background_fixed */
1086 1087 1088 1089
#  define PNG_BACKGROUND_GAMMA_UNKNOWN 0
#  define PNG_BACKGROUND_GAMMA_SCREEN  1
#  define PNG_BACKGROUND_GAMMA_FILE    2
#  define PNG_BACKGROUND_GAMMA_UNIQUE  3
1090
#endif
G
Guy Schalnat 已提交
1091

1092
#ifdef PNG_READ_16_TO_8_SUPPORTED
1093
/* Strip the second byte of information from a 16-bit depth file. */
1094
extern PNG_EXPORT(void,png_set_strip_16,(png_structp png_ptr),,48);
1095
#endif
G
Guy Schalnat 已提交
1096

1097 1098
#ifdef PNG_READ_QUANTIZE_SUPPORTED
/* Turn on quantizing, and reduce the palette to the number of colors
1099 1100
 * available.
 */
1101
extern PNG_EXPORT(void,png_set_quantize,(png_structp png_ptr,
1102
    png_colorp palette, int num_palette, int maximum_colors,
1103
    png_uint_16p histogram, int full_quantize),,49);
1104
#endif
G
Guy Schalnat 已提交
1105

1106
#ifdef PNG_READ_GAMMA_SUPPORTED
1107
/* Handle gamma correction. Screen_gamma=(display_exponent) */
1108
#  ifdef PNG_FLOATING_POINT_SUPPORTED
1109
extern PNG_EXPORT(void,png_set_gamma,(png_structp png_ptr,
1110
    double screen_gamma, double default_file_gamma),,50);
1111
#  endif
1112
/* TODO: png_set_gamma_fixed */
1113
#endif
G
Guy Schalnat 已提交
1114

1115

1116
#ifdef PNG_WRITE_FLUSH_SUPPORTED
G
Guy Schalnat 已提交
1117
/* Set how many lines between output flushes - 0 for no flushing */
1118
extern PNG_EXPORT(void,png_set_flush,(png_structp png_ptr, int nrows),,51);
G
Guy Schalnat 已提交
1119
/* Flush the current PNG output buffer */
1120
extern PNG_EXPORT(void,png_write_flush,(png_structp png_ptr),,52);
1121
#endif
G
Guy Schalnat 已提交
1122

1123
/* Optional update palette with requested transformations */
1124
extern PNG_EXPORT(void,png_start_read_image,(png_structp png_ptr),,53);
G
Guy Schalnat 已提交
1125

1126
/* Optional call to update the users info structure */
1127 1128
extern PNG_EXPORT(void,png_read_update_info,(png_structp png_ptr,
    png_infop info_ptr),,54);
G
Guy Schalnat 已提交
1129

1130
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1131
/* Read one or more rows of image data. */
1132 1133
extern PNG_EXPORT(void,png_read_rows,(png_structp png_ptr, png_bytepp row,
    png_bytepp display_row, png_uint_32 num_rows),,55);
1134
#endif
G
Guy Schalnat 已提交
1135

1136
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1137
/* Read a row of data. */
1138 1139
extern PNG_EXPORT(void,png_read_row,(png_structp png_ptr, png_bytep row,
    png_bytep display_row),,56);
1140
#endif
G
Guy Schalnat 已提交
1141

1142
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1143
/* Read the whole image into memory at once. */
1144 1145
extern PNG_EXPORT(void,png_read_image,(png_structp png_ptr,
    png_bytepp image),,57);
1146
#endif
G
Guy Schalnat 已提交
1147

1148
/* Write a row of image data */
1149
extern PNG_EXPORT(void,png_write_row,(png_structp png_ptr, png_bytep row),,58);
G
Guy Schalnat 已提交
1150

1151
/* Write a few rows of image data */
1152 1153
extern PNG_EXPORT(void,png_write_rows,(png_structp png_ptr,
    png_bytepp row, png_uint_32 num_rows),,59);
G
Guy Schalnat 已提交
1154

1155
/* Write the image data */
1156 1157
extern PNG_EXPORT(void,png_write_image,(png_structp png_ptr,
    png_bytepp image),,60);
G
Guy Schalnat 已提交
1158

1159
/* Write the end of the PNG file. */
1160 1161
extern PNG_EXPORT(void,png_write_end,(png_structp png_ptr,
    png_infop info_ptr),,61);
G
Guy Schalnat 已提交
1162

1163
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1164
/* Read the end of the PNG file. */
1165 1166
extern PNG_EXPORT(void,png_read_end,(png_structp png_ptr,
    png_infop info_ptr),,62);
1167
#endif
G
Guy Schalnat 已提交
1168

1169
/* Free any memory associated with the png_info_struct */
1170 1171
extern PNG_EXPORT(void,png_destroy_info_struct,(png_structp png_ptr,
    png_infopp info_ptr_ptr),,63);
G
Guy Schalnat 已提交
1172

1173
/* Free any memory associated with the png_struct and the png_info_structs */
1174 1175
extern PNG_EXPORT(void,png_destroy_read_struct,(png_structpp png_ptr_ptr,
    png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr),,64);
G
Guy Schalnat 已提交
1176

1177
/* Free any memory associated with the png_struct and the png_info_structs */
1178 1179
extern PNG_EXPORT(void,png_destroy_write_struct,(png_structpp png_ptr_ptr,
    png_infopp info_ptr_ptr),,65);
G
Guy Schalnat 已提交
1180

1181
/* Set the libpng method of handling chunk CRC errors */
1182 1183
extern PNG_EXPORT(void,png_set_crc_action,(png_structp png_ptr,
    int crit_action, int ancil_action),,66);
A
Andreas Dilger 已提交
1184 1185

/* Values for png_set_crc_action() to say how to handle CRC errors in
A
Andreas Dilger 已提交
1186 1187 1188 1189 1190 1191 1192
 * 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 已提交
1193 1194 1195 1196 1197 1198 1199 1200
 */
#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 已提交
1201 1202 1203 1204 1205
/* 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
1206 1207
 * header file (zlib.h) for an explination of the compression functions.
 */
A
Andreas Dilger 已提交
1208

1209
/* Set the filtering method(s) used by libpng.  Currently, the only valid
1210 1211
 * value for "method" is 0.
 */
1212 1213
extern PNG_EXPORT(void,png_set_filter,(png_structp png_ptr, int method,
    int filters),,67);
G
Guy Schalnat 已提交
1214

A
Andreas Dilger 已提交
1215
/* Flags for png_set_filter() to say which filters to use.  The flags
A
Andreas Dilger 已提交
1216 1217 1218
 * 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 已提交
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
 */
#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 已提交
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
/* 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

1239
#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */
A
Andreas Dilger 已提交
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
/* 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.
 */
1268
#  ifdef PNG_FLOATING_POINT_SUPPORTED
1269
extern PNG_EXPORT(void,png_set_filter_heuristics,(png_structp png_ptr,
1270
    int heuristic_method, int num_weights, png_doublep filter_weights,
1271
    png_doublep filter_costs),,68);
1272
#  endif
1273
/* TODO: png_set_filter_heuristics_fixed */
A
Andreas Dilger 已提交
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
#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.
 */
1291 1292
extern PNG_EXPORT(void,png_set_compression_level,(png_structp png_ptr,
    int level),,69);
G
Guy Schalnat 已提交
1293

1294 1295
extern PNG_EXPORT(void,png_set_compression_mem_level,(png_structp png_ptr,
    int mem_level),,70);
G
Guy Schalnat 已提交
1296

1297 1298
extern PNG_EXPORT(void,png_set_compression_strategy,(png_structp png_ptr,
    int strategy),,71);
G
Guy Schalnat 已提交
1299

1300 1301
extern PNG_EXPORT(void,png_set_compression_window_bits,(png_structp png_ptr,
    int window_bits),,72);
G
Guy Schalnat 已提交
1302

1303 1304
extern PNG_EXPORT(void,png_set_compression_method,(png_structp png_ptr,
    int method),,73);
G
Guy Schalnat 已提交
1305

G
Guy Schalnat 已提交
1306
/* These next functions are called for input/output, memory, and error
A
Andreas Dilger 已提交
1307 1308 1309 1310 1311 1312 1313
 * 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
 * different manner by calling png_set_???_fn().  See libpng.txt for
 * more information.
 */
G
Guy Schalnat 已提交
1314

1315
#ifdef PNG_STDIO_SUPPORTED
A
Andreas Dilger 已提交
1316
/* Initialize the input/output for the PNG file to the default functions. */
1317
extern PNG_EXPORT(void,png_init_io,(png_structp png_ptr, png_FILE_p fp),,74);
1318
#endif
G
Guy Schalnat 已提交
1319

A
Andreas Dilger 已提交
1320
/* Replace the (error and abort), and warning functions with user
A
Andreas Dilger 已提交
1321 1322 1323 1324 1325 1326
 * 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.
 */
1327

1328 1329 1330
extern 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 已提交
1331

G
Guy Schalnat 已提交
1332
/* Return the user pointer associated with the error functions */
1333
extern PNG_EXPORT(png_voidp,png_get_error_ptr,(png_structp png_ptr),,76);
G
Guy Schalnat 已提交
1334 1335

/* Replace the default data output functions with a user supplied one(s).
A
Andreas Dilger 已提交
1336 1337 1338
 * 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).
1339 1340 1341 1342 1343
 * 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 已提交
1344
 */
1345 1346 1347
extern 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 已提交
1348 1349

/* Replace the default data input function with a user supplied one. */
1350 1351
extern 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 已提交
1352 1353

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

1356 1357
extern PNG_EXPORT(void,png_set_read_status_fn,(png_structp png_ptr,
    png_read_status_ptr read_row_fn),,80);
1358

1359 1360
extern PNG_EXPORT(void,png_set_write_status_fn,(png_structp png_ptr,
    png_write_status_ptr write_row_fn),,81);
1361

1362 1363
#ifdef PNG_USER_MEM_SUPPORTED
/* Replace the default memory allocation functions with user supplied one(s). */
1364 1365
extern 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);
1366
/* Return the user pointer associated with the memory functions */
1367
extern PNG_EXPORT(png_voidp,png_get_mem_ptr,(png_structp png_ptr),,83);
1368
#endif
1369

1370
#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
1371 1372
extern PNG_EXPORT(void,png_set_read_user_transform_fn,(png_structp png_ptr,
    png_user_transform_ptr read_user_transform_fn),,84);
1373 1374
#endif

1375
#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
1376 1377
extern PNG_EXPORT(void,png_set_write_user_transform_fn,(png_structp png_ptr,
    png_user_transform_ptr write_user_transform_fn),,85);
1378 1379
#endif

1380
#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
1381
    defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
1382 1383 1384
extern PNG_EXPORT(void,png_set_user_transform_info,(png_structp png_ptr,
    png_voidp user_transform_ptr, int user_transform_depth,
    int user_transform_channels),,86);
1385
/* Return the user pointer associated with the user transform functions */
1386 1387
extern PNG_EXPORT(png_voidp,png_get_user_transform_ptr,
    (png_structp png_ptr),,87);
1388 1389
#endif

1390
#ifdef PNG_USER_CHUNKS_SUPPORTED
1391 1392 1393
extern PNG_EXPORT(void,png_set_read_user_chunk_fn,(png_structp png_ptr,
    png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn),,88);
extern PNG_EXPORT(png_voidp,png_get_user_chunk_ptr,(png_structp png_ptr),,89);
1394 1395
#endif

G
Guy Schalnat 已提交
1396
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
A
Andreas Dilger 已提交
1397 1398 1399
/* Sets the function callbacks for the push reader, and a pointer to a
 * user-defined structure available to the callback functions.
 */
1400 1401 1402
extern PNG_EXPORT(void,png_set_progressive_read_fn,(png_structp png_ptr,
    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 已提交
1403

1404
/* Returns the user pointer associated with the push read functions */
1405
extern PNG_EXPORT(png_voidp,png_get_progressive_ptr,(png_structp png_ptr),,91);
A
Andreas Dilger 已提交
1406

1407
/* Function to be called when data becomes available */
1408 1409
extern 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 已提交
1410

1411
/* Function that combines rows.  Not very much different than the
A
Andreas Dilger 已提交
1412 1413
 * png_combine_row() call.  Is this even used?????
 */
1414 1415
extern PNG_EXPORT(void,png_progressive_combine_row,(png_structp png_ptr,
    png_bytep old_row, png_bytep new_row),,93);
G
Guy Schalnat 已提交
1416
#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */
G
Guy Schalnat 已提交
1417

1418 1419
extern PNG_EXPORT(png_voidp,png_malloc,(png_structp png_ptr,
    png_alloc_size_t size),PNG_ALLOCATED,94);
1420
/* Added at libpng version 1.4.0 */
1421 1422
extern PNG_EXPORT(png_voidp,png_calloc,(png_structp png_ptr,
    png_alloc_size_t size),PNG_ALLOCATED,95);
G
Guy Schalnat 已提交
1423

1424
/* Added at libpng version 1.2.4 */
1425 1426
extern PNG_EXPORT(png_voidp,png_malloc_warn,(png_structp png_ptr,
    png_alloc_size_t size),PNG_ALLOCATED,96);
1427

1428
/* Frees a pointer allocated by png_malloc() */
1429
extern PNG_EXPORT(void,png_free,(png_structp png_ptr, png_voidp ptr),,97);
A
Andreas Dilger 已提交
1430

1431
/* Free data that was allocated internally */
1432 1433
extern PNG_EXPORT(void,png_free_data,(png_structp png_ptr, png_infop info_ptr,
    png_uint_32 free_me, int num),,98);
1434 1435
/* Reassign responsibility for freeing existing data, whether allocated
 * by libpng or by the application */
1436 1437
extern PNG_EXPORT(void,png_data_freer,(png_structp png_ptr, png_infop info_ptr,
    int freer, png_uint_32 mask),,99);
1438
/* Assignments for png_data_freer */
1439 1440 1441 1442
#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 */
1443 1444 1445 1446
#define PNG_FREE_HIST 0x0008
#define PNG_FREE_ICCP 0x0010
#define PNG_FREE_SPLT 0x0020
#define PNG_FREE_ROWS 0x0040
1447 1448
#define PNG_FREE_PCAL 0x0080
#define PNG_FREE_SCAL 0x0100
1449 1450
#define PNG_FREE_UNKN 0x0200
#define PNG_FREE_LIST 0x0400
1451 1452 1453
#define PNG_FREE_PLTE 0x1000
#define PNG_FREE_TRNS 0x2000
#define PNG_FREE_TEXT 0x4000
1454
#define PNG_FREE_ALL  0x7fff
1455
#define PNG_FREE_MUL  0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
1456

1457
#ifdef PNG_USER_MEM_SUPPORTED
1458 1459 1460 1461
extern PNG_EXPORT(png_voidp,png_malloc_default,(png_structp png_ptr,
    png_alloc_size_t size),PNG_ALLOCATED,100);
extern PNG_EXPORT(void,png_free_default,(png_structp png_ptr,
    png_voidp ptr),,101);
1462
#endif
1463

1464
#ifdef PNG_ERROR_TEXT_SUPPORTED
A
Andreas Dilger 已提交
1465
/* Fatal error in PNG image of libpng - can't continue */
1466 1467
extern PNG_EXPORT(void,png_error,(png_structp png_ptr,
    png_const_charp error_message),PNG_NORETURN,102);
G
Guy Schalnat 已提交
1468

1469
/* The same, but the chunk name is prepended to the error string. */
1470 1471
extern PNG_EXPORT(void,png_chunk_error,(png_structp png_ptr,
    png_const_charp error_message),PNG_NORETURN,103);
1472

1473 1474
#else
/* Fatal error in PNG image of libpng - can't continue */
1475
extern PNG_EXPORT(void,png_err,(png_structp png_ptr),PNG_NORETURN,104);
1476 1477
#endif

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

1482
/* Non-fatal error in libpng, chunk name is prepended to message. */
1483 1484
extern PNG_EXPORT(void,png_chunk_warning,(png_structp png_ptr,
    png_const_charp warning_message),,106);
1485

1486 1487 1488
#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. */
1489
#  undef png_benign_error
1490 1491
extern PNG_EXPORT(void,png_benign_error,(png_structp png_ptr,
    png_const_charp warning_message),,107);
1492 1493

/* Same, chunk name is prepended to message. */
1494
#  undef png_chunk_benign_error
1495 1496
extern PNG_EXPORT(void,png_chunk_benign_error,(png_structp png_ptr,
    png_const_charp warning_message),,108);
1497

1498 1499
extern PNG_EXPORT(void,png_set_benign_errors,(png_structp png_ptr,
    int allowed),,109);
1500 1501 1502 1503 1504 1505 1506 1507
#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
1508 1509
#endif

A
Andreas Dilger 已提交
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
/* 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.
 */
1522
/* Returns "flag" if chunk data is valid in info_ptr. */
1523 1524
extern PNG_EXPORT(png_uint_32,png_get_valid,(png_structp png_ptr,
    png_infop info_ptr, png_uint_32 flag),,110);
A
Andreas Dilger 已提交
1525

1526
/* Returns number of bytes needed to hold a transformed row. */
1527 1528
extern PNG_EXPORT(png_size_t,png_get_rowbytes,(png_structp png_ptr,
    png_infop info_ptr),,111);
A
Andreas Dilger 已提交
1529

1530
#ifdef PNG_INFO_IMAGE_SUPPORTED
1531
/* Returns row_pointers, which is an array of pointers to scanlines that was
1532 1533
 * returned from png_read_png().
 */
1534 1535
extern PNG_EXPORT(png_bytepp,png_get_rows,(png_structp png_ptr,
    png_infop info_ptr),,112);
1536
/* Set row_pointers, which is an array of pointers to scanlines for use
1537 1538
 * by png_write_png().
 */
1539 1540
extern PNG_EXPORT(void,png_set_rows,(png_structp png_ptr, png_infop info_ptr,
    png_bytepp row_pointers),,113);
1541 1542
#endif

1543
/* Returns number of color channels in image. */
1544 1545
extern PNG_EXPORT(png_byte,png_get_channels,(png_structp png_ptr,
    png_infop info_ptr),,114);
A
Andreas Dilger 已提交
1546

1547 1548
#ifdef PNG_EASY_ACCESS_SUPPORTED
/* Returns image width in pixels. */
1549 1550
extern PNG_EXPORT(png_uint_32, png_get_image_width,(png_structp png_ptr,
    png_infop info_ptr),,115);
1551 1552

/* Returns image height in pixels. */
1553 1554
extern PNG_EXPORT(png_uint_32, png_get_image_height,(png_structp png_ptr,
    png_infop info_ptr),,116);
1555 1556

/* Returns image bit_depth. */
1557 1558
extern PNG_EXPORT(png_byte, png_get_bit_depth,(png_structp png_ptr,
    png_infop info_ptr),,117);
1559 1560

/* Returns image color_type. */
1561 1562
extern PNG_EXPORT(png_byte, png_get_color_type,(png_structp png_ptr,
    png_infop info_ptr),,118);
1563 1564

/* Returns image filter_type. */
1565 1566
extern PNG_EXPORT(png_byte, png_get_filter_type,(png_structp png_ptr,
    png_infop info_ptr),,119);
1567 1568

/* Returns image interlace_type. */
1569 1570
extern PNG_EXPORT(png_byte, png_get_interlace_type,(png_structp png_ptr,
    png_infop info_ptr),,120);
1571 1572

/* Returns image compression_type. */
1573 1574
extern PNG_EXPORT(png_byte, png_get_compression_type,(png_structp png_ptr,
    png_infop info_ptr),,121);
1575 1576

/* Returns image resolution in pixels per meter, from pHYs chunk data. */
1577 1578 1579 1580 1581 1582
extern PNG_EXPORT(png_uint_32, png_get_pixels_per_meter,(png_structp png_ptr,
    png_infop info_ptr),,122);
extern PNG_EXPORT(png_uint_32, png_get_x_pixels_per_meter,
    (png_structp png_ptr, png_infop info_ptr),,123);
extern PNG_EXPORT(png_uint_32, png_get_y_pixels_per_meter,
    (png_structp png_ptr, png_infop info_ptr),,124);
1583 1584

/* Returns pixel aspect ratio, computed from pHYs chunk data.  */
1585
#  ifdef PNG_FLOATING_POINT_SUPPORTED
1586 1587
extern PNG_EXPORT(float, png_get_pixel_aspect_ratio,
    (png_structp png_ptr, png_infop info_ptr),,125);
1588
#  endif
1589
/* TODO: png_get_pixel_aspect_ratio_fixed */
1590 1591

/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
1592 1593 1594 1595 1596 1597 1598 1599
extern PNG_EXPORT(png_int_32, png_get_x_offset_pixels,
    (png_structp png_ptr, png_infop info_ptr),,126);
extern PNG_EXPORT(png_int_32, png_get_y_offset_pixels,
    (png_structp png_ptr, png_infop info_ptr),,127);
extern PNG_EXPORT(png_int_32, png_get_x_offset_microns,
    (png_structp png_ptr, png_infop info_ptr),,128);
extern PNG_EXPORT(png_int_32, png_get_y_offset_microns,
    (png_structp png_ptr, png_infop info_ptr),,129);
1600 1601 1602

#endif /* PNG_EASY_ACCESS_SUPPORTED */

A
Andreas Dilger 已提交
1603
/* Returns pointer to signature string read from PNG header */
1604 1605
extern PNG_EXPORT(png_bytep,png_get_signature,(png_structp png_ptr,
    png_infop info_ptr),,130);
A
Andreas Dilger 已提交
1606

1607
#ifdef PNG_bKGD_SUPPORTED
1608 1609
extern PNG_EXPORT(png_uint_32,png_get_bKGD,(png_structp png_ptr,
    png_infop info_ptr, png_color_16p *background),,131);
1610
#endif
A
Andreas Dilger 已提交
1611

1612
#ifdef PNG_bKGD_SUPPORTED
1613 1614
extern PNG_EXPORT(void,png_set_bKGD,(png_structp png_ptr,
    png_infop info_ptr, png_color_16p background),,132);
1615
#endif
A
Andreas Dilger 已提交
1616

1617
#ifdef PNG_cHRM_SUPPORTED
1618
#  ifdef PNG_FLOATING_POINT_SUPPORTED
1619 1620 1621 1622
extern PNG_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);
1623 1624
#  endif
#  ifdef PNG_FIXED_POINT_SUPPORTED
1625
extern PNG_EXPORT(png_uint_32,png_get_cHRM_fixed,(png_structp png_ptr,
1626 1627 1628 1629
    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,
1630
    png_fixed_point *int_blue_x, png_fixed_point *int_blue_y),,134);
1631
#  endif
1632
#endif
A
Andreas Dilger 已提交
1633

1634
#ifdef PNG_cHRM_SUPPORTED
1635
#  ifdef PNG_FLOATING_POINT_SUPPORTED
1636
extern PNG_EXPORT(void,png_set_cHRM,(png_structp png_ptr,
1637 1638
    png_infop info_ptr, double white_x, double white_y,
    double red_x, double red_y, double green_x, double green_y,
1639
    double blue_x, double blue_y),,135);
1640 1641
#  endif
#  ifdef PNG_FIXED_POINT_SUPPORTED
1642
extern PNG_EXPORT(void,png_set_cHRM_fixed,(png_structp png_ptr,
1643 1644 1645 1646
    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,
1647
    png_fixed_point int_blue_x, png_fixed_point int_blue_y),,136);
1648
#  endif
1649
#endif
A
Andreas Dilger 已提交
1650

1651
#ifdef PNG_gAMA_SUPPORTED
1652
#  ifdef PNG_FLOATING_POINT_SUPPORTED
1653 1654
extern PNG_EXPORT(png_uint_32,png_get_gAMA,(png_structp png_ptr,
    png_infop info_ptr, double *file_gamma),,137);
1655
#  endif
1656
#  ifdef PNG_FIXED_POINT_SUPPORTED
1657 1658
extern PNG_EXPORT(png_uint_32,png_get_gAMA_fixed,(png_structp png_ptr,
    png_infop info_ptr, png_fixed_point *int_file_gamma),,138);
1659
#  endif
1660
#endif
G
Guy Schalnat 已提交
1661

1662
#ifdef PNG_gAMA_SUPPORTED
1663
#  ifdef PNG_FLOATING_POINT_SUPPORTED
1664 1665
extern PNG_EXPORT(void,png_set_gAMA,(png_structp png_ptr,
    png_infop info_ptr, double file_gamma),,139);
1666
#  endif
1667
#  ifdef PNG_FIXED_POINT_SUPPORTED
1668 1669
extern PNG_EXPORT(void,png_set_gAMA_fixed,(png_structp png_ptr,
    png_infop info_ptr, png_fixed_point int_file_gamma),,140);
1670
#  endif
1671
#endif
A
Andreas Dilger 已提交
1672

1673
#ifdef PNG_hIST_SUPPORTED
1674 1675
extern PNG_EXPORT(png_uint_32,png_get_hIST,(png_structp png_ptr,
    png_infop info_ptr, png_uint_16p *hist),,141);
1676
#endif
A
Andreas Dilger 已提交
1677

1678
#ifdef PNG_hIST_SUPPORTED
1679 1680
extern PNG_EXPORT(void,png_set_hIST,(png_structp png_ptr,
    png_infop info_ptr, png_uint_16p hist),,142);
1681
#endif
A
Andreas Dilger 已提交
1682

1683
extern PNG_EXPORT(png_uint_32,png_get_IHDR,(png_structp png_ptr,
1684 1685
    png_infop info_ptr, png_uint_32 *width, png_uint_32 *height,
    int *bit_depth, int *color_type, int *interlace_method,
1686
    int *compression_method, int *filter_method),,143);
1687

1688
extern PNG_EXPORT(void,png_set_IHDR,(png_structp png_ptr,
1689 1690
    png_infop info_ptr, png_uint_32 width, png_uint_32 height, int bit_depth,
    int color_type, int interlace_method, int compression_method,
1691
    int filter_method),,144);
A
Andreas Dilger 已提交
1692

1693
#ifdef PNG_oFFs_SUPPORTED
1694
extern PNG_EXPORT(png_uint_32,png_get_oFFs,(png_structp png_ptr,
1695
    png_infop info_ptr, png_int_32 *offset_x, png_int_32 *offset_y,
1696
    int *unit_type),,145);
1697
#endif
A
Andreas Dilger 已提交
1698

1699
#ifdef PNG_oFFs_SUPPORTED
1700
extern PNG_EXPORT(void,png_set_oFFs,(png_structp png_ptr,
1701
    png_infop info_ptr, png_int_32 offset_x, png_int_32 offset_y,
1702
    int unit_type),,146);
1703
#endif
A
Andreas Dilger 已提交
1704

1705
#ifdef PNG_pCAL_SUPPORTED
1706
extern PNG_EXPORT(png_uint_32,png_get_pCAL,(png_structp png_ptr,
1707
    png_infop info_ptr, png_charp *purpose, png_int_32 *X0, png_int_32 *X1,
1708
    int *type, int *nparams, png_charp *units, png_charpp *params),,147);
1709
#endif
A
Andreas Dilger 已提交
1710

1711
#ifdef PNG_pCAL_SUPPORTED
1712
extern PNG_EXPORT(void,png_set_pCAL,(png_structp png_ptr,
1713
    png_infop info_ptr, png_charp purpose, png_int_32 X0, png_int_32 X1,
1714
    int type, int nparams, png_charp units, png_charpp params),,148);
1715 1716
#endif

1717
#ifdef PNG_pHYs_SUPPORTED
1718 1719 1720
extern 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);
1721
#endif
A
Andreas Dilger 已提交
1722

1723
#ifdef PNG_pHYs_SUPPORTED
1724 1725 1726
extern 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);
1727
#endif
A
Andreas Dilger 已提交
1728

1729 1730
extern 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 已提交
1731

1732 1733
extern PNG_EXPORT(void,png_set_PLTE,(png_structp png_ptr,
    png_infop info_ptr, png_colorp palette, int num_palette),,152);
A
Andreas Dilger 已提交
1734

1735
#ifdef PNG_sBIT_SUPPORTED
1736 1737
extern PNG_EXPORT(png_uint_32,png_get_sBIT,(png_structp png_ptr,
    png_infop info_ptr, png_color_8p *sig_bit),,153);
1738
#endif
A
Andreas Dilger 已提交
1739

1740
#ifdef PNG_sBIT_SUPPORTED
1741 1742
extern PNG_EXPORT(void,png_set_sBIT,(png_structp png_ptr,
    png_infop info_ptr, png_color_8p sig_bit),,154);
1743
#endif
A
Andreas Dilger 已提交
1744

1745
#ifdef PNG_sRGB_SUPPORTED
1746 1747
extern PNG_EXPORT(png_uint_32,png_get_sRGB,(png_structp png_ptr,
    png_infop info_ptr, int *intent),,155);
1748
#endif
1749

1750
#ifdef PNG_sRGB_SUPPORTED
1751 1752 1753 1754
extern PNG_EXPORT(void,png_set_sRGB,(png_structp png_ptr,
    png_infop info_ptr, int intent),,156);
extern PNG_EXPORT(void,png_set_sRGB_gAMA_and_cHRM,(png_structp png_ptr,
    png_infop info_ptr, int intent),,157);
1755 1756
#endif

1757
#ifdef PNG_iCCP_SUPPORTED
1758
extern PNG_EXPORT(png_uint_32,png_get_iCCP,(png_structp png_ptr,
1759
    png_infop info_ptr, png_charpp name, int *compression_type,
1760
    png_charpp profile, png_uint_32 *proflen),,158);
1761
    /* Note to maintainer: profile should be png_bytepp */
1762 1763
#endif

1764
#ifdef PNG_iCCP_SUPPORTED
1765
extern PNG_EXPORT(void,png_set_iCCP,(png_structp png_ptr,
1766
    png_infop info_ptr, png_charp name, int compression_type,
1767
    png_charp profile, png_uint_32 proflen),,159);
1768
    /* Note to maintainer: profile should be png_bytep */
1769 1770
#endif

1771
#ifdef PNG_sPLT_SUPPORTED
1772 1773
extern PNG_EXPORT(png_uint_32,png_get_sPLT,(png_structp png_ptr,
    png_infop info_ptr, png_sPLT_tpp entries),,160);
1774 1775
#endif

1776
#ifdef PNG_sPLT_SUPPORTED
1777 1778
extern PNG_EXPORT(void,png_set_sPLT,(png_structp png_ptr,
    png_infop info_ptr, png_sPLT_tp entries, int nentries),,161);
1779 1780
#endif

1781
#ifdef PNG_TEXT_SUPPORTED
1782
/* png_get_text also returns the number of text chunks in *num_text */
1783 1784
extern PNG_EXPORT(png_uint_32,png_get_text,(png_structp png_ptr,
    png_infop info_ptr, png_textp *text_ptr, int *num_text),,162);
1785
#endif
A
Andreas Dilger 已提交
1786

1787 1788 1789 1790 1791
/* 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.
1792 1793
 */

1794
#ifdef PNG_TEXT_SUPPORTED
1795 1796
extern PNG_EXPORT(void,png_set_text,(png_structp png_ptr,
    png_infop info_ptr, png_textp text_ptr, int num_text),,163);
1797
#endif
A
Andreas Dilger 已提交
1798

1799
#ifdef PNG_tIME_SUPPORTED
1800 1801
extern PNG_EXPORT(png_uint_32,png_get_tIME,(png_structp png_ptr,
    png_infop info_ptr, png_timep *mod_time),,164);
1802
#endif
A
Andreas Dilger 已提交
1803

1804
#ifdef PNG_tIME_SUPPORTED
1805 1806
extern PNG_EXPORT(void,png_set_tIME,(png_structp png_ptr,
    png_infop info_ptr, png_timep mod_time),,165);
1807
#endif
A
Andreas Dilger 已提交
1808

1809
#ifdef PNG_tRNS_SUPPORTED
1810 1811 1812
extern 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);
1813 1814
#endif

1815
#ifdef PNG_tRNS_SUPPORTED
1816 1817 1818
extern PNG_EXPORT(void,png_set_tRNS,(png_structp png_ptr,
    png_infop info_ptr, png_bytep trans_alpha, int num_trans,
    png_color_16p trans_color),,167);
1819 1820
#endif

1821
#ifdef PNG_sCAL_SUPPORTED
1822
#  ifdef PNG_FLOATING_POINT_SUPPORTED
1823 1824
extern PNG_EXPORT(png_uint_32,png_get_sCAL,(png_structp png_ptr,
    png_infop info_ptr, int *unit, double *width, double *height),,168);
1825 1826
#  endif
#  ifdef PNG_FIXED_POINT_SUPPORTED
1827 1828 1829
extern PNG_EXPORT(png_uint_32,png_get_sCAL_s,(png_structp png_ptr,
    png_infop info_ptr, int *unit, png_charpp swidth,
    png_charpp sheight),,169);
1830
#  endif
1831
#endif /* PNG_sCAL_SUPPORTED */
1832

1833
#ifdef PNG_sCAL_SUPPORTED
1834
#  ifdef PNG_FLOATING_POINT_SUPPORTED
1835 1836
extern PNG_EXPORT(void,png_set_sCAL,(png_structp png_ptr,
    png_infop info_ptr, int unit, double width, double height),,170);
1837 1838
#  endif
#  ifdef PNG_FIXED_POINT_SUPPORTED
1839 1840 1841
extern PNG_EXPORT(void,png_set_sCAL_s,(png_structp png_ptr,
    png_infop info_ptr, int unit, png_charp swidth,
    png_charp sheight),,171);
1842
#  endif
1843
#endif /* PNG_sCAL_SUPPORTED || PNG_WRITE_sCAL_SUPPORTED */
1844

1845 1846
#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
/* Provide a list of chunks and how they are to be handled, if the built-in
1847 1848 1849
   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.
1850
      keep = 0: follow default behaviour
1851 1852 1853 1854
           = 1: do not keep
           = 2: keep only if safe-to-copy
           = 3: keep even if unsafe-to-copy
*/
1855 1856
extern PNG_EXPORT(void, png_set_keep_unknown_chunks,(png_structp png_ptr,
    int keep, png_bytep chunk_list, int num_chunks),,172);
1857
extern PNG_EXPORT(int,png_handle_as_unknown,(png_structp png_ptr,
1858
    png_bytep chunk_name),,173);
1859
#endif
1860
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
1861 1862 1863 1864 1865 1866 1867 1868
extern PNG_EXPORT(void, png_set_unknown_chunks,(png_structp png_ptr,
    png_infop info_ptr, png_unknown_chunkp unknowns,
    int num_unknowns),,174);
extern PNG_EXPORT(void, png_set_unknown_chunk_location,
    (png_structp png_ptr, png_infop info_ptr, int chunk,
    int location),,175);
extern PNG_EXPORT(png_uint_32,png_get_unknown_chunks,(png_structp png_ptr,
    png_infop info_ptr, png_unknown_chunkpp entries),,176);
1869 1870
#endif

1871
/* Png_free_data() will turn off the "valid" flag for anything it frees.
1872 1873 1874
 * 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);
 */
1875 1876
extern PNG_EXPORT(void, png_set_invalid,(png_structp png_ptr,
    png_infop info_ptr, int mask),,177);
1877

1878
#ifdef PNG_INFO_IMAGE_SUPPORTED
1879
/* The "params" pointer is currently not used and is for future expansion. */
1880 1881 1882 1883 1884 1885 1886 1887 1888 1889
extern PNG_EXPORT(void, png_read_png,(png_structp png_ptr,
    png_infop info_ptr, int transforms, png_voidp params),,178);
extern PNG_EXPORT(void, png_write_png,(png_structp png_ptr,
    png_infop info_ptr, int transforms, png_voidp params),,179);
#endif

extern PNG_EXPORT(png_charp,png_get_copyright,(png_structp png_ptr),,180);
extern PNG_EXPORT(png_charp,png_get_header_ver,(png_structp png_ptr),,181);
extern PNG_EXPORT(png_charp,png_get_header_version,(png_structp png_ptr),,182);
extern PNG_EXPORT(png_charp,png_get_libpng_ver,(png_structp png_ptr),,183);
1890

1891
#ifdef PNG_MNG_FEATURES_SUPPORTED
1892 1893
extern PNG_EXPORT(png_uint_32,png_permit_mng_features,(png_structp png_ptr,
    png_uint_32 mng_features_permitted),,184);
1894 1895
#endif

1896 1897 1898 1899 1900 1901
/* 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

1902
/* Strip the prepended error numbers ("#nnn ") from error and warning
1903 1904
 * messages before passing them to the error or warning handler.
 */
1905
#ifdef PNG_ERROR_NUMBERS_SUPPORTED
1906 1907
extern PNG_EXPORT(void,png_set_strip_error_numbers,(png_structp png_ptr,
    png_uint_32 strip_mode),,185);
1908
#endif
1909

1910
/* Added in libpng-1.2.6 */
1911
#ifdef PNG_SET_USER_LIMITS_SUPPORTED
1912 1913 1914 1915 1916 1917
extern PNG_EXPORT(void,png_set_user_limits,(png_structp png_ptr,
    png_uint_32 user_width_max, png_uint_32 user_height_max),,186);
extern PNG_EXPORT(png_uint_32,png_get_user_width_max,
    (png_structp png_ptr),,187);
extern PNG_EXPORT(png_uint_32,png_get_user_height_max,
    (png_structp png_ptr),,188);
1918
/* Added in libpng-1.4.0 */
1919 1920 1921 1922
extern PNG_EXPORT(void,png_set_chunk_cache_max,(png_structp png_ptr,
    png_uint_32 user_chunk_cache_max),,189);
extern PNG_EXPORT(png_uint_32,png_get_chunk_cache_max,
    (png_structp png_ptr),,190);
1923
/* Added in libpng-1.4.1 */
1924 1925 1926 1927
extern PNG_EXPORT(void,png_set_chunk_malloc_max,(png_structp png_ptr,
    png_alloc_size_t user_chunk_cache_max),,191);
extern PNG_EXPORT(png_alloc_size_t,png_get_chunk_malloc_max,
    (png_structp png_ptr),,192);
1928 1929
#endif

1930
#if defined(PNG_INCH_CONVERSIONS_SUPPORTED) && defined(PNG_FLOATING_POINT_SUPPORTED)
1931 1932
PNG_EXPORT(png_uint_32,png_get_pixels_per_inch,(png_structp png_ptr,
    png_infop info_ptr),,193);
1933

1934 1935
PNG_EXPORT(png_uint_32,png_get_x_pixels_per_inch,(png_structp png_ptr,
    png_infop info_ptr),,194);
1936

1937 1938
PNG_EXPORT(png_uint_32,png_get_y_pixels_per_inch,(png_structp png_ptr,
    png_infop info_ptr),,195);
1939

1940 1941
PNG_EXPORT(float,png_get_x_offset_inches,(png_structp png_ptr,
    png_infop info_ptr),,196);
1942

1943 1944
PNG_EXPORT(float,png_get_y_offset_inches,(png_structp png_ptr,
    png_infop info_ptr),,197);
1945

1946
#  ifdef PNG_pHYs_SUPPORTED
1947 1948 1949
PNG_EXPORT(png_uint_32,png_get_pHYs_dpi,(png_structp png_ptr,
    png_infop info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
    int *unit_type),,198);
1950
#  endif /* PNG_pHYs_SUPPORTED */
1951
#endif  /* PNG_INCH_CONVERSIONS_SUPPORTED && PNG_FLOATING_POINT_SUPPORTED */
1952

1953 1954
/* Added in libpng-1.4.0 */
#ifdef PNG_IO_STATE_SUPPORTED
1955
extern PNG_EXPORT(png_uint_32,png_get_io_state,(png_structp png_ptr),,199);
1956

1957
extern PNG_EXPORT(png_bytep,png_get_io_chunk_name,(png_structp png_ptr),,200);
1958 1959

/* The flags returned by png_get_io_state() are the following: */
1960 1961 1962 1963 1964 1965 1966 1967 1968
#  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 */
1969 1970
#endif /* ?PNG_IO_STATE_SUPPORTED */

1971 1972 1973
/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
 * defs
 */
1974

1975
#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
1976 1977 1978
/* 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
1979 1980 1981 1982 1983 1984 1985 1986 1987
 * 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. :-) ]
 */

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

1990 1991 1992 1993 1994
#  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);   \
1995
       (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
1996

1997 1998 1999 2000 2001
#  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); \
2002 2003
       (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }

2004
#else  /* Standard method using integer division */
2005

2006 2007
#  define png_composite(composite, fg, alpha, bg)                          \
     (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) +  \
2008 2009
     (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) +       \
     (png_uint_16)127) / 255)
2010 2011

#  define png_composite_16(composite, fg, alpha, bg)                         \
2012
     (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \
2013
     (png_uint_32)(bg)*(png_uint_32)(65535L - (png_uint_32)(alpha)) +        \
2014
     (png_uint_32)32767) / (png_uint_32)65535L)
2015 2016
#endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */

2017 2018 2019 2020
#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.
2021
 */
2022 2023 2024 2025 2026 2027 2028 2029
#  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) \
     (((png_uint_32)(*(buf)) << 8) + \
      ((png_uint_32)(*((buf) + 1))))
2030 2031
#  ifdef PNG_GET_INT_32_SUPPORTED
#    define png_get_int_32(buf) \
2032 2033 2034 2035
     (((png_int_32)(*(buf)) << 24) + \
      ((png_int_32)(*((buf) + 1)) << 16) + \
      ((png_int_32)(*((buf) + 2)) << 8) + \
      ((png_int_32)(*((buf) + 3))))
2036
#  endif
2037
#endif
2038 2039

#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
2040 2041
extern PNG_EXPORT(png_uint_32,png_get_uint_32,(png_bytep buf),,201);
extern PNG_EXPORT(png_uint_16,png_get_uint_16,(png_bytep buf),,202);
2042 2043
#endif
#ifdef PNG_GET_INT_32_SUPPORTED
2044
extern PNG_EXPORT(png_int_32,png_get_int_32,(png_bytep buf),,203);
2045 2046
#endif

2047 2048
extern PNG_EXPORT(png_uint_32,png_get_uint_31,(png_structp png_ptr,
    png_bytep buf),,204);
2049 2050
/* No png_get_int_16 -- may be added if there's a real need for it. */

2051
/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
2052
#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2053
extern PNG_EXPORT(void,png_save_uint_32,(png_bytep buf, png_uint_32 i),,205);
2054
#endif
2055
#ifdef PNG_SAVE_INT_32_SUPPORTED
2056
extern PNG_EXPORT(void,png_save_int_32,(png_bytep buf, png_int_32 i),,206);
2057
#endif
2058 2059 2060 2061 2062

/* 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.
 */
2063
#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2064
extern PNG_EXPORT(void,png_save_uint_16,(png_bytep buf, unsigned int i),,207);
2065
/* No png_save_int_16 -- may be added if there's a real need for it. */
2066
#endif
2067

2068 2069 2070 2071 2072 2073 2074
/* The last ordinal number (this is the *last* one, the next one to
 * use is one more than this.)
 */
#ifdef PNG_EXPORT_LAST_ORDINAL
  PNG_EXPORT_LAST_ORDINAL(207);
#endif

A
Andreas Dilger 已提交
2075 2076 2077 2078
#ifdef __cplusplus
}
#endif

2079
#endif /* PNG_VERSION_INFO_ONLY */
2080
/* Do not put anything past this line */
2081
#endif /* PNG_H */