png.h 93.1 KB
Newer Older
1

A
Andreas Dilger 已提交
2
/* png.h - header file for PNG reference library
3
 *
4
 * libpng version 1.5.1beta11 - January 28, 2011
5
 * Copyright (c) 1998-2011 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.1beta11 - January 28, 2011: 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.4.4                   14    10404  14.so.14.4[.0]
144
 *    1.5.0beta01-58          15    10500  15.so.15.0[.0]
145
 *    1.5.0rc01-07            15    10500  15.so.15.0[.0]
146
 *    1.5.0                   15    10500  15.so.15.0[.0]
147
 *    1.5.1beta01-10          15    10501  15.so.15.1[.0]
148
 *    1.5.1rc01               15    10501  15.so.15.1[.0]
149
 *
150 151 152 153 154 155 156 157 158
 *   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".
159
 *
160 161 162
 *   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.
163
 *
164 165
 *   DLLNUM will change each time there are forward or backward changes
 *   in binary compatibility (e.g., when a new feature is added).
166
 *
167 168 169
 * See libpng-manual.txt or libpng.3 for more information.  The PNG
 * specification is available as a W3C Recommendation and as an ISO
 * Specification, <http://www.w3.org/TR/2003/REC-PNG-20031110/
170 171 172
 */

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

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

/*
276 277 278 279 280 281 282 283 284 285 286 287
 * 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.
 */

288 289 290 291
/*
 * Y2K compliance in libpng:
 * =========================
 *
292
 *    January 28, 2011
293 294 295 296 297
 *
 *    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
298
 *    upward through 1.5.1beta11 are Y2K compliant.  It is my belief that
G
[devel]  
Glenn Randers-Pehrson 已提交
299
 *    earlier versions were also Y2K compliant.
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
 *
 *    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
328
 *    instead of "year - 1900" into the png_convert_from_struct_tm() function, 
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
 *    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
 */

344 345
#ifndef PNG_H
#define PNG_H
G
Guy Schalnat 已提交
346

347
/* This is not the place to learn how to use libpng. The file libpng-manual.txt
A
Andreas Dilger 已提交
348 349 350 351
 * 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 已提交
352

353
/* Version information for png.h - this should match the version in png.c */
354
#define PNG_LIBPNG_VER_STRING "1.5.1beta11"
355
#define PNG_HEADER_VERSION_STRING \
356
     " libpng version 1.5.1beta11 - January 28, 2011\n"
357

358 359
#define PNG_LIBPNG_VER_SONUM   15
#define PNG_LIBPNG_VER_DLLNUM  15
360 361 362

/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */
#define PNG_LIBPNG_VER_MAJOR   1
363
#define PNG_LIBPNG_VER_MINOR   5
364
#define PNG_LIBPNG_VER_RELEASE 1
365
/* This should match the numeric part of the final component of
366 367
 * PNG_LIBPNG_VER_STRING, omitting any leading zero:
 */
368

369
#define PNG_LIBPNG_VER_BUILD  11
370

371
/* Release Status */
372 373 374 375
#define PNG_LIBPNG_BUILD_ALPHA    1
#define PNG_LIBPNG_BUILD_BETA     2
#define PNG_LIBPNG_BUILD_RC       3
#define PNG_LIBPNG_BUILD_STABLE   4
376
#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7
377

378 379 380 381 382 383 384
/* 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 */
385

386
#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_BETA
387

388 389 390 391
/* 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
392 393
 * version 1.0.1 it's    xxyyzz, where x=major, y=minor, z=release
 */
394
#define PNG_LIBPNG_VER 10501 /* 1.5.1 */
395

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

406
#ifndef PNG_VERSION_INFO_ONLY
407 408 409 410 411
/* Standard header files (not needed for the version info) */
#  ifdef PNG_SETJMP_SUPPORTED
#    include <setjmp.h>
#  endif

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

420 421 422
/* Machine specific configuration. */
#  include "pngconf.h"
#endif
G
Guy Schalnat 已提交
423

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

438
#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
439
#  define PNG_LIBPNG_BUILD_TYPE \
440
       (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
441
#else
442
#  ifdef PNG_LIBPNG_SPECIALBUILD
443
#    define PNG_LIBPNG_BUILD_TYPE \
444
         (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
445
#  else
446
#    define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
447 448 449 450 451
#  endif
#endif

#ifndef PNG_VERSION_INFO_ONLY

452 453 454 455 456
/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

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

462 463 464
/* This file is arranged in several sections:
 *
 * 1. Any configuration options that can be specified by for the application
465
 *    code when it is built.  (Build time configuration is in pnglibconf.h)
466 467 468 469 470 471 472 473
 * 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
474
 * See pnglibconf.h for build time configuration
475 476 477
 *
 * Run time configuration allows the application to choose between
 * implementations of certain arithmetic APIs.  The default is set
478
 * at build time and recorded in pnglibconf.h, but it is safe to
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
 * 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
 */
507 508 509 510

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

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

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

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

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

567 568 569 570 571
/*  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.
 */

572
typedef struct png_sPLT_struct
573
{
574 575 576 577
   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 */
578 579
} png_sPLT_t;
typedef png_sPLT_t FAR * png_sPLT_tp;
580
typedef PNG_CONST png_sPLT_t FAR * png_const_sPLT_tp;
581
typedef png_sPLT_t FAR * FAR * png_sPLT_tpp;
582 583

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

/* 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
620 621 622
#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 已提交
623 624

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

643
#if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED) || \
644
    defined(PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
645 646 647 648 649 650 651 652 653 654 655
/* 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;

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

665
typedef struct png_info_def png_info;
A
Andreas Dilger 已提交
666
typedef png_info FAR * png_infop;
667
typedef PNG_CONST png_info FAR * png_const_infop;
A
Andreas Dilger 已提交
668
typedef png_info FAR * FAR * png_infopp;
G
Guy Schalnat 已提交
669

670
/* Maximum positive integer used in PNG is (2^31)-1 */
671
#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
672 673
#define PNG_UINT_32_MAX ((png_uint_32)(-1))
#define PNG_SIZE_MAX ((png_size_t)(-1))
674

G
[devel]  
Glenn Randers-Pehrson 已提交
675 676 677 678 679 680
/* These are constants for fixed point values encoded in the
 * PNG specification manner (x100000)
 */
#define PNG_FP_1    100000
#define PNG_FP_HALF  50000

A
Andreas Dilger 已提交
681
/* These describe the color_type field in png_info. */
G
Guy Schalnat 已提交
682
/* color type masks */
A
Andreas Dilger 已提交
683 684 685
#define PNG_COLOR_MASK_PALETTE    1
#define PNG_COLOR_MASK_COLOR      2
#define PNG_COLOR_MASK_ALPHA      4
G
Guy Schalnat 已提交
686 687

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

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

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

723 724 725 726 727 728
/* 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 已提交
729 730 731 732 733
/* 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 */

734
/* These are for the sRGB chunk.  These values should NOT be changed. */
735 736 737 738
#define PNG_sRGB_INTENT_PERCEPTUAL 0
#define PNG_sRGB_INTENT_RELATIVE   1
#define PNG_sRGB_INTENT_SATURATION 2
#define PNG_sRGB_INTENT_ABSOLUTE   3
739
#define PNG_sRGB_INTENT_LAST       4 /* Not a valid value */
740

741 742
/* This is for text chunks */
#define PNG_KEYWORD_MAX_LENGTH     79
743

744
/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
745
#define PNG_MAX_PALETTE_LENGTH    256
746

A
Andreas Dilger 已提交
747 748 749 750 751
/* 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 已提交
752 753 754 755 756 757 758 759 760 761
#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 已提交
762
#define PNG_INFO_pCAL 0x0400
763
#define PNG_INFO_sRGB 0x0800   /* GR-P, 0.96a */
764 765 766
#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 */
767
#define PNG_INFO_IDAT 0x8000L  /* ESR, 1.0.6 */
G
Guy Schalnat 已提交
768

A
Andreas Dilger 已提交
769 770 771 772
/* 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 已提交
773 774
typedef struct png_row_info_struct
{
775 776 777 778 779
   png_uint_32 width;    /* width of row */
   png_size_t rowbytes;  /* number of bytes in row */
   png_byte color_type;  /* color type of row */
   png_byte bit_depth;   /* bit depth of row */
   png_byte channels;    /* number of channels (1, 2, 3, or 4) */
G
Guy Schalnat 已提交
780
   png_byte pixel_depth; /* bits per pixel (depth * channels) */
G
Guy Schalnat 已提交
781 782
} png_row_info;

A
Andreas Dilger 已提交
783 784
typedef png_row_info FAR * png_row_infop;
typedef png_row_info FAR * FAR * png_row_infopp;
G
Guy Schalnat 已提交
785

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

798 799 800 801 802 803 804
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), );
805

G
Guy Schalnat 已提交
806
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
807 808
typedef PNG_CALLBACK(void, *png_progressive_info_ptr, 
    (png_structp, png_infop), );
809 810 811 812
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), );
813
#endif
G
Guy Schalnat 已提交
814

815
#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
816
    defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
817 818
typedef PNG_CALLBACK(void, *png_user_transform_ptr,
    (png_structp, png_row_infop, png_bytep), );
819
#endif
820

821
#ifdef PNG_USER_CHUNKS_SUPPORTED
822 823
typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp, 
    png_unknown_chunkp), );
824
#endif
825
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
826
typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp), );
827
#endif
828

829 830 831
#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
832 833 834
 * of jmp_buf.  The function is required to be PNG_NORETURN.  (Note that
 * PNG_PTR_NORETURN is used here because current versions of the Microsoft
 * C compiler do not support the PNG_NORETURN attribute on a pointer.)
G
[devel]  
Glenn Randers-Pehrson 已提交
835 836 837 838 839 840 841 842 843 844 845
 *
 * If you get a type warning from the compiler when linking against this line
 * then your compiler has 'longjmp' that does not match the requirements of the
 * compiler that built libpng.  You will have to write a wrapper function for
 * your compiler's longjmp and call png_set_longjmp_fn directly (not via the
 * png_jmpbuf macro.)
 *
 * If you get a warning here while building the library you will need to make
 * changes to ensure that pnglibconf.h records the calling convention used by
 * your compiler.  This may be very difficult - try using a different compiler
 * to build the library!
846
 */
847
typedef PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)), 
848
   PNG_PTR_NORETURN);
849
#endif
850 851

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

871
/* Flags for MNG supported features */
872 873
#define PNG_FLAG_MNG_EMPTY_PLTE     0x01
#define PNG_FLAG_MNG_FILTER_64      0x04
874
#define PNG_ALL_MNG_FEATURES        0x05
875

876
/* NOTE: prior to 1.5 these functions had no 'API' style declaration, 
877 878 879 880 881
 * 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.
 */
882 883 884
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), );
885

A
Andreas Dilger 已提交
886
typedef png_struct FAR * FAR * png_structpp;
G
Guy Schalnat 已提交
887

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

917
/* Returns the version number of the library */
918
PNG_EXPORT(1, png_uint_32, png_access_version_number, (void));
919

A
Andreas Dilger 已提交
920
/* Tell lib we have already handled the first <num_bytes> magic bytes.
A
Andreas Dilger 已提交
921 922
 * Handling more than 8 bytes from the beginning of the file is an error.
 */
923
PNG_EXPORT(2, void, png_set_sig_bytes, (png_structp png_ptr, int num_bytes));
A
Andreas Dilger 已提交
924 925 926 927 928 929

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

933 934 935
/* Simple signature checking function.  This is the same as calling
 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
 */
936
#define png_check_sig(sig, n) !png_sig_cmp((sig), 0, (n))
937

A
Andreas Dilger 已提交
938
/* Allocate and initialize png_ptr struct for reading, and any other memory. */
939 940 941
PNG_EXPORTA(4, 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), 
942
    PNG_ALLOCATED);
A
Andreas Dilger 已提交
943

944
/* Allocate and initialize png_ptr struct for writing, and any other memory */
945 946 947
PNG_EXPORTA(5, 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), 
948
    PNG_ALLOCATED);
G
Guy Schalnat 已提交
949

950
PNG_EXPORT(6, png_size_t, png_get_compression_buffer_size,
951
    (png_const_structp png_ptr));
952

953
PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structp png_ptr, 
954
    png_size_t size));
955

956 957 958 959 960 961 962 963 964 965 966
/* 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.
 */
967
PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structp png_ptr, 
968
    png_longjmp_ptr longjmp_fn, size_t jmp_buf_size));
969
#  define png_jmpbuf(png_ptr) \
970
      (*png_set_longjmp_fn((png_ptr), longjmp, sizeof (jmp_buf)))
971 972
#else
#  define png_jmpbuf(png_ptr) \
973
      (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
974
#endif
975 976 977 978 979
/* 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.
 */
980 981
PNG_EXPORTA(9, void, png_longjmp, (png_structp png_ptr, int val),
    PNG_NORETURN);
982

983
#ifdef PNG_READ_SUPPORTED
984
/* Reset the compression stream */
985
PNG_EXPORT(10, int, png_reset_zstream, (png_structp png_ptr));
986
#endif
987

988
/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
989
#ifdef PNG_USER_MEM_SUPPORTED
990 991 992 993 994 995 996 997 998 999
PNG_EXPORTA(11, png_structp, png_create_read_struct_2,
    (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
    png_error_ptr warn_fn, 
    png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn), 
    PNG_ALLOCATED);
PNG_EXPORTA(12, png_structp, png_create_write_struct_2,
    (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
    png_error_ptr warn_fn, 
    png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn), 
    PNG_ALLOCATED);
1000 1001
#endif

1002
/* Write the PNG file signature. */
1003
PNG_EXPORT(13, void, png_write_sig, (png_structp png_ptr));
1004

1005
/* Write a PNG chunk - size, type, (optional) data, CRC. */
1006 1007
PNG_EXPORT(14, void, png_write_chunk, (png_structp png_ptr, png_const_bytep
    chunk_name, png_const_bytep data, png_size_t length));
1008 1009

/* Write the start of a PNG chunk - length and chunk name. */
1010 1011
PNG_EXPORT(15, void, png_write_chunk_start, (png_structp png_ptr, 
    png_const_bytep chunk_name, png_uint_32 length));
1012 1013

/* Write the data of a PNG chunk started with png_write_chunk_start(). */
1014 1015
PNG_EXPORT(16, void, png_write_chunk_data, (png_structp png_ptr,
    png_const_bytep data, png_size_t length));
1016 1017

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

A
Andreas Dilger 已提交
1020
/* Allocate and initialize the info structure */
1021 1022
PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_structp png_ptr), 
    PNG_ALLOCATED);
G
Guy Schalnat 已提交
1023

1024 1025
PNG_EXPORT(19, void, png_info_init_3, (png_infopp info_ptr, 
    png_size_t png_info_struct_size));
G
Guy Schalnat 已提交
1026

A
Andreas Dilger 已提交
1027
/* Writes all the PNG information before the image. */
1028 1029 1030 1031
PNG_EXPORT(20, void, png_write_info_before_PLTE,
    (png_structp png_ptr, png_infop info_ptr));
PNG_EXPORT(21, void, png_write_info,
    (png_structp png_ptr, png_infop info_ptr));
G
Guy Schalnat 已提交
1032

1033
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1034
/* Read the information before the actual image data. */
1035 1036
PNG_EXPORT(22, void, png_read_info,
    (png_structp png_ptr, png_infop info_ptr));
1037
#endif
G
Guy Schalnat 已提交
1038

1039
#ifdef PNG_TIME_RFC1123_SUPPORTED
1040 1041 1042
PNG_EXPORT(23, png_const_charp, png_convert_to_rfc1123,
    (png_structp png_ptr, 
    png_const_timep ptime));
1043
#endif
1044

1045
#ifdef PNG_CONVERT_tIME_SUPPORTED
1046
/* Convert from a struct tm to png_time */
1047 1048
PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime, 
    PNG_CONST struct tm FAR * ttime));
G
Guy Schalnat 已提交
1049

1050
/* Convert from time_t to png_time.  Uses gmtime() */
1051 1052
PNG_EXPORT(25, void, png_convert_from_time_t,
    (png_timep ptime, time_t ttime));
1053
#endif /* PNG_CONVERT_tIME_SUPPORTED */
G
Guy Schalnat 已提交
1054

1055
#ifdef PNG_READ_EXPAND_SUPPORTED
1056
/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
1057 1058 1059 1060
PNG_EXPORT(26, void, png_set_expand, (png_structp png_ptr));
PNG_EXPORT(27, void, png_set_expand_gray_1_2_4_to_8, (png_structp png_ptr));
PNG_EXPORT(28, void, png_set_palette_to_rgb, (png_structp png_ptr));
PNG_EXPORT(29, void, png_set_tRNS_to_alpha, (png_structp png_ptr));
1061
#endif
G
Guy Schalnat 已提交
1062

G
Guy Schalnat 已提交
1063
#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
G
Guy Schalnat 已提交
1064
/* Use blue, green, red order for pixels. */
1065
PNG_EXPORT(30, void, png_set_bgr, (png_structp png_ptr));
1066
#endif
G
Guy Schalnat 已提交
1067

1068
#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
1069
/* Expand the grayscale to 24-bit RGB if necessary. */
1070
PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structp png_ptr));
1071
#endif
G
Guy Schalnat 已提交
1072

1073
#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
1074
/* Reduce RGB to grayscale. */
1075 1076 1077 1078
PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structp png_ptr,
    int error_action, double red, double green));
PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structp png_ptr, 
    int error_action, png_fixed_point red, png_fixed_point green));
1079

1080
PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structp
1081
    png_ptr));
1082
#endif
A
Andreas Dilger 已提交
1083

1084 1085
PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth, 
    png_colorp palette));
A
Andreas Dilger 已提交
1086

1087
#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
1088
PNG_EXPORT(36, void, png_set_strip_alpha, (png_structp png_ptr));
1089
#endif
G
Guy Schalnat 已提交
1090

A
Andreas Dilger 已提交
1091 1092
#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
1093
PNG_EXPORT(37, void, png_set_swap_alpha, (png_structp png_ptr));
1094
#endif
G
Guy Schalnat 已提交
1095

1096 1097
#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
1098
PNG_EXPORT(38, void, png_set_invert_alpha, (png_structp png_ptr));
1099
#endif
1100

A
Andreas Dilger 已提交
1101
#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
1102
/* Add a filler byte to 8-bit Gray or 24-bit RGB images. */
1103 1104
PNG_EXPORT(39, void, png_set_filler, (png_structp png_ptr, png_uint_32 filler, 
    int flags));
A
Andreas Dilger 已提交
1105
/* The values of the PNG_FILLER_ defines should NOT be changed */
1106 1107
#  define PNG_FILLER_BEFORE 0
#  define PNG_FILLER_AFTER 1
1108
/* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */
1109 1110 1111
PNG_EXPORT(40, void, png_set_add_alpha,
    (png_structp png_ptr, png_uint_32 filler, 
    int flags));
A
Andreas Dilger 已提交
1112
#endif /* PNG_READ_FILLER_SUPPORTED || PNG_WRITE_FILLER_SUPPORTED */
G
Guy Schalnat 已提交
1113

G
Guy Schalnat 已提交
1114
#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
1115
/* Swap bytes in 16-bit depth files. */
1116
PNG_EXPORT(41, void, png_set_swap, (png_structp png_ptr));
1117
#endif
G
Guy Schalnat 已提交
1118

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

1124 1125
#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
    defined(PNG_WRITE_PACKSWAP_SUPPORTED)
A
Andreas Dilger 已提交
1126
/* Swap packing order of pixels in bytes. */
1127
PNG_EXPORT(43, void, png_set_packswap, (png_structp png_ptr));
1128
#endif
G
Guy Schalnat 已提交
1129

G
Guy Schalnat 已提交
1130
#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
G
Guy Schalnat 已提交
1131
/* Converts files to legal bit depths. */
1132 1133
PNG_EXPORT(44, void, png_set_shift, (png_structp png_ptr, png_const_color_8p
    true_bits));
1134
#endif
G
Guy Schalnat 已提交
1135

G
Guy Schalnat 已提交
1136 1137
#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
    defined(PNG_WRITE_INTERLACING_SUPPORTED)
G
[devel]  
Glenn Randers-Pehrson 已提交
1138
/* Have the code handle the interlacing.  Returns the number of passes.
1139 1140 1141 1142 1143
 * MUST be called before png_read_update_info or png_start_read_image,
 * otherwise it will not have the desired effect.  Note that it is still
 * necessary to call png_read_row or png_read_rows png_get_image_height
 * times for each pass.
*/
1144
PNG_EXPORT(45, int, png_set_interlace_handling, (png_structp png_ptr));
1145
#endif
G
Guy Schalnat 已提交
1146

G
Guy Schalnat 已提交
1147
#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
1148
/* Invert monochrome files */
1149
PNG_EXPORT(46, void, png_set_invert_mono, (png_structp png_ptr));
1150
#endif
G
Guy Schalnat 已提交
1151

1152
#ifdef PNG_READ_BACKGROUND_SUPPORTED
G
Guy Schalnat 已提交
1153
/* Handle alpha and tRNS by replacing with a background color. */
1154 1155 1156
PNG_FP_EXPORT(47, void, png_set_background, (png_structp png_ptr, 
    png_const_color_16p background_color, int background_gamma_code, 
    int need_expand, double background_gamma));
1157
PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structp png_ptr,
1158 1159
    png_const_color_16p background_color, int background_gamma_code, 
    int need_expand, png_fixed_point background_gamma));
G
[devel]  
Glenn Randers-Pehrson 已提交
1160 1161
#endif
#ifdef PNG_READ_BACKGROUND_SUPPORTED
1162 1163 1164 1165
#  define PNG_BACKGROUND_GAMMA_UNKNOWN 0
#  define PNG_BACKGROUND_GAMMA_SCREEN  1
#  define PNG_BACKGROUND_GAMMA_FILE    2
#  define PNG_BACKGROUND_GAMMA_UNIQUE  3
1166
#endif
G
Guy Schalnat 已提交
1167

1168
#ifdef PNG_READ_16_TO_8_SUPPORTED
1169
/* Strip the second byte of information from a 16-bit depth file. */
1170
PNG_EXPORT(48, void, png_set_strip_16, (png_structp png_ptr));
1171
#endif
G
Guy Schalnat 已提交
1172

1173 1174
#ifdef PNG_READ_QUANTIZE_SUPPORTED
/* Turn on quantizing, and reduce the palette to the number of colors
1175 1176
 * available.
 */
1177 1178 1179 1180
PNG_EXPORT(49, void, png_set_quantize,
    (png_structp png_ptr, png_colorp palette, 
    int num_palette, int maximum_colors, png_const_uint_16p histogram, 
    int full_quantize));
1181
#endif
G
Guy Schalnat 已提交
1182

1183
#ifdef PNG_READ_GAMMA_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1184 1185 1186 1187 1188
/* The threshold on gamma processing is configurable but hard-wired into the
 * library.  The following is the floating point variant.
 */
#define PNG_GAMMA_THRESHOLD (PNG_GAMMA_THRESHOLD_FIXED*.00001)

1189
/* Handle gamma correction. Screen_gamma=(display_exponent) */
1190 1191 1192 1193 1194
PNG_FP_EXPORT(50, void, png_set_gamma,
    (png_structp png_ptr, double screen_gamma, 
    double default_file_gamma));
PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structp png_ptr, 
    png_fixed_point screen_gamma, png_fixed_point default_file_gamma));
1195
#endif
G
Guy Schalnat 已提交
1196

1197
#ifdef PNG_WRITE_FLUSH_SUPPORTED
G
Guy Schalnat 已提交
1198
/* Set how many lines between output flushes - 0 for no flushing */
1199
PNG_EXPORT(51, void, png_set_flush, (png_structp png_ptr, int nrows));
G
Guy Schalnat 已提交
1200
/* Flush the current PNG output buffer */
1201
PNG_EXPORT(52, void, png_write_flush, (png_structp png_ptr));
1202
#endif
G
Guy Schalnat 已提交
1203

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

1207
/* Optional call to update the users info structure */
1208 1209
PNG_EXPORT(54, void, png_read_update_info,
    (png_structp png_ptr, png_infop info_ptr));
G
Guy Schalnat 已提交
1210

1211
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1212
/* Read one or more rows of image data. */
1213 1214
PNG_EXPORT(55, void, png_read_rows, (png_structp png_ptr, png_bytepp row, 
    png_bytepp display_row, png_uint_32 num_rows));
1215
#endif
G
Guy Schalnat 已提交
1216

1217
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1218
/* Read a row of data. */
1219 1220
PNG_EXPORT(56, void, png_read_row, (png_structp png_ptr, png_bytep row, 
    png_bytep display_row));
1221
#endif
G
Guy Schalnat 已提交
1222

1223
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1224
/* Read the whole image into memory at once. */
1225
PNG_EXPORT(57, void, png_read_image, (png_structp png_ptr, png_bytepp image));
1226
#endif
G
Guy Schalnat 已提交
1227

1228
/* Write a row of image data */
1229 1230
PNG_EXPORT(58, void, png_write_row,
    (png_structp png_ptr, png_const_bytep row));
G
Guy Schalnat 已提交
1231

1232 1233 1234
/* Write a few rows of image data: (*row) is not written; however, the type
 * is declared as writeable to maintain compatibility with previous versions
 * of libpng and to allow the 'display_row' array from read_rows to be passed
1235 1236
 * unchanged to write_rows.
 */
1237 1238
PNG_EXPORT(59, void, png_write_rows, (png_structp png_ptr, png_bytepp row, 
    png_uint_32 num_rows));
G
Guy Schalnat 已提交
1239

1240
/* Write the image data */
1241 1242
PNG_EXPORT(60, void, png_write_image,
    (png_structp png_ptr, png_bytepp image));
G
Guy Schalnat 已提交
1243

1244
/* Write the end of the PNG file. */
1245 1246
PNG_EXPORT(61, void, png_write_end,
    (png_structp png_ptr, png_infop info_ptr));
G
Guy Schalnat 已提交
1247

1248
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1249
/* Read the end of the PNG file. */
1250
PNG_EXPORT(62, void, png_read_end, (png_structp png_ptr, png_infop info_ptr));
1251
#endif
G
Guy Schalnat 已提交
1252

1253
/* Free any memory associated with the png_info_struct */
1254 1255
PNG_EXPORT(63, void, png_destroy_info_struct, (png_structp png_ptr, 
    png_infopp info_ptr_ptr));
G
Guy Schalnat 已提交
1256

1257
/* Free any memory associated with the png_struct and the png_info_structs */
1258 1259
PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr, 
    png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr));
G
Guy Schalnat 已提交
1260

1261
/* Free any memory associated with the png_struct and the png_info_structs */
1262 1263
PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr, 
    png_infopp info_ptr_ptr));
G
Guy Schalnat 已提交
1264

1265
/* Set the libpng method of handling chunk CRC errors */
1266 1267
PNG_EXPORT(66, void, png_set_crc_action,
    (png_structp png_ptr, int crit_action, int ancil_action));
A
Andreas Dilger 已提交
1268

1269
/* Values for png_set_crc_action() say how to handle CRC errors in
A
Andreas Dilger 已提交
1270 1271
 * ancillary and critical chunks, and whether to use the data contained
 * therein.  Note that it is impossible to "discard" data in a critical
1272
 * chunk.  For versions prior to 0.90, the action was always error/quit, 
A
Andreas Dilger 已提交
1273 1274 1275 1276
 * 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 已提交
1277 1278 1279 1280 1281 1282 1283 1284
 */
#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 已提交
1285 1286 1287 1288 1289
/* 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
1290 1291
 * header file (zlib.h) for an explination of the compression functions.
 */
A
Andreas Dilger 已提交
1292

1293
/* Set the filtering method(s) used by libpng.  Currently, the only valid
1294 1295
 * value for "method" is 0.
 */
1296 1297
PNG_EXPORT(67, void, png_set_filter,
    (png_structp png_ptr, int method, int filters));
G
Guy Schalnat 已提交
1298

A
Andreas Dilger 已提交
1299
/* Flags for png_set_filter() to say which filters to use.  The flags
A
Andreas Dilger 已提交
1300 1301 1302
 * 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 已提交
1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
 */
#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 已提交
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
/* 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

1323
#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */
A
Andreas Dilger 已提交
1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351
/* 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.
 */
1352 1353 1354 1355 1356
PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structp png_ptr, 
    int heuristic_method, int num_weights, png_const_doublep filter_weights, 
    png_const_doublep filter_costs));
PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed,
    (png_structp png_ptr, 
1357
    int heuristic_method, int num_weights, png_const_fixed_point_p
1358
    filter_weights, png_const_fixed_point_p filter_costs));
A
Andreas Dilger 已提交
1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
#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
1373
 * for PNG images, and do considerably fewer caclulations.  In the future, 
A
Andreas Dilger 已提交
1374 1375
 * these values may not correspond directly to the zlib compression levels.
 */
1376 1377
PNG_EXPORT(69, void, png_set_compression_level,
    (png_structp png_ptr, int level));
G
Guy Schalnat 已提交
1378

1379 1380
PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structp png_ptr, 
    int mem_level));
G
Guy Schalnat 已提交
1381

1382 1383
PNG_EXPORT(71, void, png_set_compression_strategy, (png_structp png_ptr, 
    int strategy));
G
Guy Schalnat 已提交
1384

1385 1386
PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structp png_ptr, 
    int window_bits));
G
Guy Schalnat 已提交
1387

1388 1389
PNG_EXPORT(73, void, png_set_compression_method, (png_structp png_ptr,
    int method));
G
Guy Schalnat 已提交
1390

G
Guy Schalnat 已提交
1391
/* These next functions are called for input/output, memory, and error
1392
 * handling.  They are in the file pngrio.c, pngwio.c, and pngerror.c, 
A
Andreas Dilger 已提交
1393 1394 1395
 * 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
1396
 * different manner by calling png_set_???_fn().  See libpng-manual.txt for
A
Andreas Dilger 已提交
1397 1398
 * more information.
 */
G
Guy Schalnat 已提交
1399

1400
#ifdef PNG_STDIO_SUPPORTED
A
Andreas Dilger 已提交
1401
/* Initialize the input/output for the PNG file to the default functions. */
1402
PNG_EXPORT(74, void, png_init_io, (png_structp png_ptr, png_FILE_p fp));
1403
#endif
G
Guy Schalnat 已提交
1404

A
Andreas Dilger 已提交
1405
/* Replace the (error and abort), and warning functions with user
A
Andreas Dilger 已提交
1406 1407 1408 1409 1410 1411
 * 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.
 */
1412

1413 1414 1415
PNG_EXPORT(75, void, png_set_error_fn,
    (png_structp png_ptr, png_voidp error_ptr, 
    png_error_ptr error_fn, png_error_ptr warning_fn));
G
Guy Schalnat 已提交
1416

G
Guy Schalnat 已提交
1417
/* Return the user pointer associated with the error functions */
1418
PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structp png_ptr));
G
Guy Schalnat 已提交
1419 1420

/* Replace the default data output functions with a user supplied one(s).
A
Andreas Dilger 已提交
1421 1422 1423
 * 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).
1424 1425 1426 1427 1428
 * 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 已提交
1429
 */
1430 1431
PNG_EXPORT(77, 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));
G
Guy Schalnat 已提交
1432 1433

/* Replace the default data input function with a user supplied one. */
1434 1435
PNG_EXPORT(78, void, png_set_read_fn, (png_structp png_ptr, png_voidp io_ptr, 
    png_rw_ptr read_data_fn));
G
Guy Schalnat 已提交
1436 1437

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

1440 1441
PNG_EXPORT(80, void, png_set_read_status_fn, (png_structp png_ptr, 
    png_read_status_ptr read_row_fn));
1442

1443 1444
PNG_EXPORT(81, void, png_set_write_status_fn, (png_structp png_ptr, 
    png_write_status_ptr write_row_fn));
1445

1446 1447
#ifdef PNG_USER_MEM_SUPPORTED
/* Replace the default memory allocation functions with user supplied one(s). */
1448 1449
PNG_EXPORT(82, void, png_set_mem_fn, (png_structp png_ptr, png_voidp mem_ptr, 
    png_malloc_ptr malloc_fn, png_free_ptr free_fn));
1450
/* Return the user pointer associated with the memory functions */
1451
PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structp png_ptr));
1452
#endif
1453

1454
#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
1455 1456
PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structp png_ptr, 
    png_user_transform_ptr read_user_transform_fn));
1457 1458
#endif

1459
#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
1460 1461
PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structp png_ptr, 
    png_user_transform_ptr write_user_transform_fn));
1462 1463
#endif

1464
#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED
1465 1466 1467
PNG_EXPORT(86, void, png_set_user_transform_info, (png_structp png_ptr, 
    png_voidp user_transform_ptr, int user_transform_depth, 
    int user_transform_channels));
1468
/* Return the user pointer associated with the user transform functions */
1469
PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr,
1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
    (png_const_structp png_ptr));
#endif

#ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED
/* Return information about the row currently being processed.  Note that these
 * APIs do not fail but will return unexpected results if called outside a user
 * transform callback.  Also note that when transforming an interlaced image the
 * row number is still the row in the final, de-interlaced, image but the row
 * only contains the data of the current pass - consult png_row_info for the
 * actual width of the row!
 */
PNG_EXPORT(217, png_uint_32, png_get_current_row_number, (png_const_structp));
PNG_EXPORT(218, png_byte, png_get_current_pass_number, (png_const_structp));
1483 1484
#endif

1485
#ifdef PNG_USER_CHUNKS_SUPPORTED
1486 1487
PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structp png_ptr, 
    png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn));
1488
PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structp png_ptr));
1489 1490
#endif

G
Guy Schalnat 已提交
1491
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
A
Andreas Dilger 已提交
1492 1493 1494
/* Sets the function callbacks for the push reader, and a pointer to a
 * user-defined structure available to the callback functions.
 */
1495 1496 1497
PNG_EXPORT(90, 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));
G
Guy Schalnat 已提交
1498

1499
/* Returns the user pointer associated with the push read functions */
1500
PNG_EXPORT(91, png_voidp, png_get_progressive_ptr, (png_const_structp png_ptr));
A
Andreas Dilger 已提交
1501

1502
/* Function to be called when data becomes available */
1503 1504 1505
PNG_EXPORT(92, void, png_process_data,
    (png_structp png_ptr, png_infop info_ptr, 
    png_bytep buffer, png_size_t buffer_size));
A
Andreas Dilger 已提交
1506

1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523
/* A function which may be called *only* within png_process_data to stop the
 * processing of any more data.  The function returns the number of bytes
 * remaining, excluding any that libpng has cached internally.  A subsequent
 * call to png_process_data must supply these bytes again.  If the argument
 * 'save' is set to true the routine will first save all the pending data and
 * will always return 0.
 */
PNG_EXPORT(219, png_size_t, png_process_data_pause, (png_structp, int save));

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

1524 1525 1526 1527
/* Function that combines rows.  'new_row' is a flag that should come from
 * the callback and be non-NULL if anything needs to be done; the library
 * stores its own version of the new data internally and ignores the passed
 * in value.
A
Andreas Dilger 已提交
1528
 */
1529 1530
PNG_EXPORT(93, void, png_progressive_combine_row, (png_structp png_ptr, 
    png_bytep old_row, png_const_bytep new_row));
G
Guy Schalnat 已提交
1531
#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */
G
Guy Schalnat 已提交
1532

1533 1534 1535
PNG_EXPORTA(94, png_voidp, png_malloc,
    (png_structp png_ptr, png_alloc_size_t size), 
    PNG_ALLOCATED);
1536
/* Added at libpng version 1.4.0 */
1537 1538 1539
PNG_EXPORTA(95, png_voidp, png_calloc,
    (png_structp png_ptr, png_alloc_size_t size), 
    PNG_ALLOCATED);
G
Guy Schalnat 已提交
1540

1541
/* Added at libpng version 1.2.4 */
1542 1543
PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_structp png_ptr, 
    png_alloc_size_t size), PNG_ALLOCATED);
1544

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

1548
/* Free data that was allocated internally */
1549 1550 1551
PNG_EXPORT(98, void, png_free_data,
    (png_structp png_ptr, png_infop info_ptr, png_uint_32 free_me, int num));

1552 1553
/* Reassign responsibility for freeing existing data, whether allocated
 * by libpng or by the application */
1554 1555 1556
PNG_EXPORT(99, void, png_data_freer,
    (png_structp png_ptr, png_infop info_ptr, int freer, png_uint_32 mask));

1557
/* Assignments for png_data_freer */
1558 1559 1560 1561
#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 */
1562 1563 1564 1565
#define PNG_FREE_HIST 0x0008
#define PNG_FREE_ICCP 0x0010
#define PNG_FREE_SPLT 0x0020
#define PNG_FREE_ROWS 0x0040
1566 1567
#define PNG_FREE_PCAL 0x0080
#define PNG_FREE_SCAL 0x0100
1568 1569
#define PNG_FREE_UNKN 0x0200
#define PNG_FREE_LIST 0x0400
1570 1571 1572
#define PNG_FREE_PLTE 0x1000
#define PNG_FREE_TRNS 0x2000
#define PNG_FREE_TEXT 0x4000
1573
#define PNG_FREE_ALL  0x7fff
1574
#define PNG_FREE_MUL  0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
1575

1576
#ifdef PNG_USER_MEM_SUPPORTED
1577 1578 1579
PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_structp png_ptr, 
    png_alloc_size_t size), PNG_ALLOCATED);
PNG_EXPORT(101, void, png_free_default, (png_structp png_ptr, png_voidp ptr));
1580
#endif
1581

1582
#ifdef PNG_ERROR_TEXT_SUPPORTED
A
Andreas Dilger 已提交
1583
/* Fatal error in PNG image of libpng - can't continue */
1584 1585 1586
PNG_EXPORTA(102, void, png_error,
    (png_structp png_ptr, png_const_charp error_message), 
    PNG_NORETURN);
G
Guy Schalnat 已提交
1587

1588
/* The same, but the chunk name is prepended to the error string. */
1589 1590
PNG_EXPORTA(103, void, png_chunk_error, (png_structp png_ptr, 
    png_const_charp error_message), PNG_NORETURN);
1591

1592 1593
#else
/* Fatal error in PNG image of libpng - can't continue */
1594
PNG_EXPORTA(104, void, png_err, (png_structp png_ptr), PNG_NORETURN);
1595 1596
#endif

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

1601
/* Non-fatal error in libpng, chunk name is prepended to message. */
1602 1603
PNG_EXPORT(106, void, png_chunk_warning, (png_structp png_ptr, 
    png_const_charp warning_message));
1604

1605 1606 1607
#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. */
1608
#  undef png_benign_error
1609 1610
PNG_EXPORT(107, void, png_benign_error, (png_structp png_ptr, 
    png_const_charp warning_message));
1611 1612

/* Same, chunk name is prepended to message. */
1613
#  undef png_chunk_benign_error
1614 1615
PNG_EXPORT(108, void, png_chunk_benign_error, (png_structp png_ptr, 
    png_const_charp warning_message));
1616

1617 1618
PNG_EXPORT(109, void, png_set_benign_errors,
    (png_structp png_ptr, int allowed));
1619 1620 1621 1622 1623 1624 1625 1626
#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
1627 1628
#endif

A
Andreas Dilger 已提交
1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640
/* 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.
 */
1641
/* Returns "flag" if chunk data is valid in info_ptr. */
1642
PNG_EXPORT(110, png_uint_32, png_get_valid,
1643
    (png_const_structp png_ptr, png_const_infop info_ptr, 
1644
    png_uint_32 flag));
A
Andreas Dilger 已提交
1645

1646
/* Returns number of bytes needed to hold a transformed row. */
1647 1648
PNG_EXPORT(111, png_size_t, png_get_rowbytes, (png_const_structp png_ptr, 
    png_const_infop info_ptr));
A
Andreas Dilger 已提交
1649

1650
#ifdef PNG_INFO_IMAGE_SUPPORTED
1651
/* Returns row_pointers, which is an array of pointers to scanlines that was
1652 1653
 * returned from png_read_png().
 */
1654
PNG_EXPORT(112, png_bytepp, png_get_rows,
1655
    (png_const_structp png_ptr, png_const_infop info_ptr));
1656
/* Set row_pointers, which is an array of pointers to scanlines for use
1657 1658
 * by png_write_png().
 */
1659 1660
PNG_EXPORT(113, void, png_set_rows, (png_structp png_ptr,
    png_infop info_ptr, png_bytepp row_pointers));
1661 1662
#endif

1663
/* Returns number of color channels in image. */
1664
PNG_EXPORT(114, png_byte, png_get_channels,
1665
    (png_const_structp png_ptr, png_const_infop info_ptr));
A
Andreas Dilger 已提交
1666

1667 1668
#ifdef PNG_EASY_ACCESS_SUPPORTED
/* Returns image width in pixels. */
1669 1670
PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structp png_ptr, 
    png_const_infop info_ptr));
1671 1672

/* Returns image height in pixels. */
1673 1674
PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structp png_ptr, 
    png_const_infop info_ptr));
1675 1676

/* Returns image bit_depth. */
1677
PNG_EXPORT(117, png_byte, png_get_bit_depth,
1678
    (png_const_structp png_ptr, png_const_infop info_ptr));
1679 1680

/* Returns image color_type. */
1681 1682
PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structp png_ptr, 
    png_const_infop info_ptr));
1683 1684

/* Returns image filter_type. */
1685 1686
PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structp png_ptr, 
    png_const_infop info_ptr));
1687 1688

/* Returns image interlace_type. */
1689 1690
PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structp png_ptr, 
    png_const_infop info_ptr));
1691 1692

/* Returns image compression_type. */
1693 1694
PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structp png_ptr, 
    png_const_infop info_ptr));
1695 1696

/* Returns image resolution in pixels per meter, from pHYs chunk data. */
1697
PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter,
1698
    (png_const_structp png_ptr, png_const_infop info_ptr));
1699
PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter,
1700
    (png_const_structp png_ptr, png_const_infop info_ptr));
1701
PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter,
1702
    (png_const_structp png_ptr, png_const_infop info_ptr));
1703 1704

/* Returns pixel aspect ratio, computed from pHYs chunk data.  */
1705
PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio,
1706
    (png_const_structp png_ptr, png_const_infop info_ptr));
1707
PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed, 
1708
    (png_const_structp png_ptr, png_const_infop info_ptr));
1709 1710

/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
1711
PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels,
1712
    (png_const_structp png_ptr, png_const_infop info_ptr));
1713
PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels,
1714
    (png_const_structp png_ptr, png_const_infop info_ptr));
1715
PNG_EXPORT(128, png_int_32, png_get_x_offset_microns,
1716
    (png_const_structp png_ptr, png_const_infop info_ptr));
1717
PNG_EXPORT(129, png_int_32, png_get_y_offset_microns,
1718
    (png_const_structp png_ptr, png_const_infop info_ptr));
1719 1720 1721

#endif /* PNG_EASY_ACCESS_SUPPORTED */

A
Andreas Dilger 已提交
1722
/* Returns pointer to signature string read from PNG header */
1723
PNG_EXPORT(130, png_const_bytep, png_get_signature,
1724
    (png_const_structp png_ptr, png_infop info_ptr));
A
Andreas Dilger 已提交
1725

1726
#ifdef PNG_bKGD_SUPPORTED
1727
PNG_EXPORT(131, png_uint_32, png_get_bKGD,
1728
    (png_const_structp png_ptr, png_infop info_ptr, 
1729
    png_color_16p *background));
1730
#endif
A
Andreas Dilger 已提交
1731

1732
#ifdef PNG_bKGD_SUPPORTED
1733 1734
PNG_EXPORT(132, void, png_set_bKGD, (png_structp png_ptr, png_infop info_ptr, 
    png_const_color_16p background));
1735
#endif
A
Andreas Dilger 已提交
1736

1737
#ifdef PNG_cHRM_SUPPORTED
1738 1739
PNG_FP_EXPORT(133, png_uint_32, png_get_cHRM, (png_const_structp png_ptr, 
   png_const_infop info_ptr, double *white_x, double *white_y, double *red_x, 
1740 1741
    double *red_y, double *green_x, double *green_y, double *blue_x, 
    double *blue_y));
G
[devel]  
Glenn Randers-Pehrson 已提交
1742
#ifdef PNG_FIXED_POINT_SUPPORTED /* Otherwise not implemented */
1743
PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed,
1744 1745
    (png_const_structp png_ptr, 
    png_const_infop info_ptr, png_fixed_point *int_white_x, 
1746 1747 1748 1749
    png_fixed_point *int_white_y, png_fixed_point *int_red_x, 
    png_fixed_point *int_red_y, png_fixed_point *int_green_x, 
    png_fixed_point *int_green_y, png_fixed_point *int_blue_x, 
    png_fixed_point *int_blue_y));
G
[devel]  
Glenn Randers-Pehrson 已提交
1750
#endif
1751
#endif
A
Andreas Dilger 已提交
1752

1753
#ifdef PNG_cHRM_SUPPORTED
1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
PNG_FP_EXPORT(135, void, png_set_cHRM,
    (png_structp png_ptr, png_infop info_ptr, 
    double white_x, double white_y, double red_x, double red_y, double green_x, 
    double green_y, double blue_x, double blue_y));
PNG_FIXED_EXPORT(136, void, png_set_cHRM_fixed, (png_structp png_ptr, 
    png_infop info_ptr, png_fixed_point int_white_x, 
    png_fixed_point int_white_y, png_fixed_point int_red_x, 
    png_fixed_point int_red_y, png_fixed_point int_green_x, 
    png_fixed_point int_green_y, png_fixed_point int_blue_x, 
    png_fixed_point int_blue_y));
1764
#endif
A
Andreas Dilger 已提交
1765

1766
#ifdef PNG_gAMA_SUPPORTED
1767
PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA,
1768
    (png_const_structp png_ptr, png_const_infop info_ptr, 
1769
    double *file_gamma));
1770
PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed,
1771
    (png_const_structp png_ptr, png_const_infop info_ptr,
1772
    png_fixed_point *int_file_gamma));
1773
#endif
G
Guy Schalnat 已提交
1774

1775
#ifdef PNG_gAMA_SUPPORTED
1776 1777
PNG_FP_EXPORT(139, void, png_set_gAMA, (png_structp png_ptr,
    png_infop info_ptr, double file_gamma));
1778 1779
PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_structp png_ptr, 
    png_infop info_ptr, png_fixed_point int_file_gamma));
1780
#endif
A
Andreas Dilger 已提交
1781

1782
#ifdef PNG_hIST_SUPPORTED
1783
PNG_EXPORT(141, png_uint_32, png_get_hIST,
1784
    (png_const_structp png_ptr, png_const_infop info_ptr, 
1785
    png_uint_16p *hist));
1786
#endif
A
Andreas Dilger 已提交
1787

1788
#ifdef PNG_hIST_SUPPORTED
1789 1790
PNG_EXPORT(142, void, png_set_hIST, (png_structp png_ptr,
    png_infop info_ptr, png_const_uint_16p hist));
1791
#endif
A
Andreas Dilger 已提交
1792

1793 1794 1795 1796
PNG_EXPORT(143, png_uint_32, png_get_IHDR,
    (png_structp png_ptr, png_infop info_ptr, 
    png_uint_32 *width, png_uint_32 *height, int *bit_depth, int *color_type, 
    int *interlace_method, int *compression_method, int *filter_method));
1797

1798 1799 1800 1801
PNG_EXPORT(144, void, png_set_IHDR,
    (png_structp png_ptr, png_infop info_ptr, 
    png_uint_32 width, png_uint_32 height, int bit_depth, int color_type, 
    int interlace_method, int compression_method, int filter_method));
A
Andreas Dilger 已提交
1802

1803
#ifdef PNG_oFFs_SUPPORTED
1804
PNG_EXPORT(145, png_uint_32, png_get_oFFs,
1805
    (png_const_structp png_ptr, png_const_infop info_ptr, 
1806
    png_int_32 *offset_x, png_int_32 *offset_y, int *unit_type));
1807
#endif
A
Andreas Dilger 已提交
1808

1809
#ifdef PNG_oFFs_SUPPORTED
1810 1811 1812
PNG_EXPORT(146, void, png_set_oFFs,
    (png_structp png_ptr, png_infop info_ptr, 
    png_int_32 offset_x, png_int_32 offset_y, int unit_type));
1813
#endif
A
Andreas Dilger 已提交
1814

1815
#ifdef PNG_pCAL_SUPPORTED
1816
PNG_EXPORT(147, png_uint_32, png_get_pCAL,
1817
    (png_const_structp png_ptr, png_const_infop info_ptr, 
1818 1819 1820
    png_charp *purpose, png_int_32 *X0, png_int_32 *X1, int *type,
    int *nparams, 
    png_charp *units, png_charpp *params));
1821
#endif
A
Andreas Dilger 已提交
1822

1823
#ifdef PNG_pCAL_SUPPORTED
1824 1825
PNG_EXPORT(148, void, png_set_pCAL, (png_structp png_ptr,
    png_infop info_ptr, 
1826 1827
    png_const_charp purpose, png_int_32 X0, png_int_32 X1, int type, 
    int nparams, png_const_charp units, png_charpp params));
1828 1829
#endif

1830
#ifdef PNG_pHYs_SUPPORTED
1831
PNG_EXPORT(149, png_uint_32, png_get_pHYs,
1832
    (png_const_structp png_ptr, png_const_infop info_ptr, 
1833
    png_uint_32 *res_x, png_uint_32 *res_y, int *unit_type));
1834
#endif
A
Andreas Dilger 已提交
1835

1836
#ifdef PNG_pHYs_SUPPORTED
1837 1838 1839
PNG_EXPORT(150, 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));
1840
#endif
A
Andreas Dilger 已提交
1841

1842
PNG_EXPORT(151, png_uint_32, png_get_PLTE,
1843
    (png_const_structp png_ptr, png_const_infop info_ptr, 
1844
    png_colorp *palette, int *num_palette));
A
Andreas Dilger 已提交
1845

1846 1847 1848
PNG_EXPORT(152, void, png_set_PLTE,
    (png_structp png_ptr, png_infop info_ptr, 
    png_const_colorp palette, int num_palette));
A
Andreas Dilger 已提交
1849

1850
#ifdef PNG_sBIT_SUPPORTED
1851
PNG_EXPORT(153, png_uint_32, png_get_sBIT,
1852
    (png_const_structp png_ptr, png_infop info_ptr, 
1853
    png_color_8p *sig_bit));
1854
#endif
A
Andreas Dilger 已提交
1855

1856
#ifdef PNG_sBIT_SUPPORTED
1857 1858
PNG_EXPORT(154, void, png_set_sBIT,
    (png_structp png_ptr, png_infop info_ptr, png_const_color_8p sig_bit));
1859
#endif
A
Andreas Dilger 已提交
1860

1861
#ifdef PNG_sRGB_SUPPORTED
1862
PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structp png_ptr,
1863
    png_const_infop info_ptr, int *file_srgb_intent));
1864
#endif
1865

1866
#ifdef PNG_sRGB_SUPPORTED
1867
PNG_EXPORT(156, void, png_set_sRGB,
1868
    (png_structp png_ptr, png_infop info_ptr, int srgb_intent));
1869
PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_structp png_ptr, 
1870
    png_infop info_ptr, int srgb_intent));
1871 1872
#endif

1873
#ifdef PNG_iCCP_SUPPORTED
1874
PNG_EXPORT(158, png_uint_32, png_get_iCCP,
1875
    (png_const_structp png_ptr, png_const_infop info_ptr, 
1876 1877
    png_charpp name, int *compression_type, png_bytepp profile, 
    png_uint_32 *proflen));
1878 1879
#endif

1880
#ifdef PNG_iCCP_SUPPORTED
1881 1882 1883 1884
PNG_EXPORT(159, void, png_set_iCCP,
    (png_structp png_ptr, png_infop info_ptr, 
    png_const_charp name, int compression_type, png_const_bytep profile, 
    png_uint_32 proflen));
1885 1886
#endif

1887
#ifdef PNG_sPLT_SUPPORTED
1888
PNG_EXPORT(160, png_uint_32, png_get_sPLT,
1889
    (png_const_structp png_ptr, png_const_infop info_ptr, 
1890
    png_sPLT_tpp entries));
1891 1892
#endif

1893
#ifdef PNG_sPLT_SUPPORTED
1894 1895 1896
PNG_EXPORT(161, void, png_set_sPLT,
    (png_structp png_ptr, png_infop info_ptr, 
    png_const_sPLT_tp entries, int nentries));
1897 1898
#endif

1899
#ifdef PNG_TEXT_SUPPORTED
1900
/* png_get_text also returns the number of text chunks in *num_text */
1901
PNG_EXPORT(162, png_uint_32, png_get_text,
1902
    (png_const_structp png_ptr, png_const_infop info_ptr, 
1903
    png_textp *text_ptr, int *num_text));
1904
#endif
A
Andreas Dilger 已提交
1905

1906
/* Note while png_set_text() will accept a structure whose text, 
1907 1908 1909 1910
 * 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.
1911 1912
 */

1913
#ifdef PNG_TEXT_SUPPORTED
1914 1915 1916
PNG_EXPORT(163, void, png_set_text,
    (png_structp png_ptr, png_infop info_ptr, 
    png_const_textp text_ptr, int num_text));
1917
#endif
A
Andreas Dilger 已提交
1918

1919
#ifdef PNG_tIME_SUPPORTED
1920
PNG_EXPORT(164, png_uint_32, png_get_tIME,
1921
    (png_const_structp png_ptr, png_infop info_ptr, png_timep *mod_time));
1922
#endif
A
Andreas Dilger 已提交
1923

1924
#ifdef PNG_tIME_SUPPORTED
1925 1926
PNG_EXPORT(165, void, png_set_tIME,
    (png_structp png_ptr, png_infop info_ptr, png_const_timep mod_time));
1927
#endif
A
Andreas Dilger 已提交
1928

1929
#ifdef PNG_tRNS_SUPPORTED
1930
PNG_EXPORT(166, png_uint_32, png_get_tRNS,
1931
    (png_const_structp png_ptr, png_infop info_ptr, 
1932
    png_bytep *trans_alpha, int *num_trans, png_color_16p *trans_color));
1933 1934
#endif

1935
#ifdef PNG_tRNS_SUPPORTED
1936 1937 1938 1939
PNG_EXPORT(167, void, png_set_tRNS,
    (png_structp png_ptr, png_infop info_ptr, 
    png_const_bytep trans_alpha, int num_trans, 
    png_const_color_16p trans_color));
1940 1941
#endif

1942
#ifdef PNG_sCAL_SUPPORTED
1943
PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL,
1944
    (png_const_structp png_ptr, png_const_infop info_ptr, 
1945
    int *unit, double *width, double *height));
1946
#ifdef PNG_FLOATING_ARITHMETIC_SUPPORTED
1947
/* NOTE: this API is currently implemented using floating point arithmetic, 
1948 1949 1950 1951
 * consequently it can only be used on systems with floating point support.
 * In any case the range of values supported by png_fixed_point is small and it
 * is highly recommended that png_get_sCAL_s be used instead.
 */
1952
PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed,
1953
    (png_structp png_ptr, png_const_infop info_ptr, int *unit,
1954
    png_fixed_point *width, 
1955 1956 1957
    png_fixed_point *height));
#endif
PNG_EXPORT(169, png_uint_32, png_get_sCAL_s,
1958
    (png_const_structp png_ptr, png_const_infop info_ptr,
1959
    int *unit, png_charpp swidth, png_charpp sheight));
1960 1961 1962 1963 1964 1965 1966 1967 1968 1969

PNG_FP_EXPORT(170, void, png_set_sCAL,
    (png_structp png_ptr, png_infop info_ptr, 
    int unit, double width, double height));
PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_structp png_ptr, 
   png_infop info_ptr, int unit, png_fixed_point width, 
   png_fixed_point height));
PNG_EXPORT(171, void, png_set_sCAL_s,
    (png_structp png_ptr, png_infop info_ptr, 
    int unit, png_const_charp swidth, png_const_charp sheight));
1970
#endif /* PNG_sCAL_SUPPORTED */
1971

1972 1973
#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
/* Provide a list of chunks and how they are to be handled, if the built-in
1974 1975 1976
   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.
1977
      keep = 0: follow default behaviour
1978 1979 1980 1981
           = 1: do not keep
           = 2: keep only if safe-to-copy
           = 3: keep even if unsafe-to-copy
*/
1982 1983 1984 1985 1986
PNG_EXPORT(172, void, png_set_keep_unknown_chunks,
    (png_structp png_ptr, int keep, 
    png_const_bytep chunk_list, int num_chunks));
PNG_EXPORT(173, int, png_handle_as_unknown, (png_structp png_ptr, 
    png_const_bytep chunk_name));
1987
#endif
1988
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
1989
PNG_EXPORT(174, void, png_set_unknown_chunks, (png_structp png_ptr, 
1990 1991 1992 1993
    png_infop info_ptr, png_const_unknown_chunkp unknowns,
    int num_unknowns));
PNG_EXPORT(175, void, png_set_unknown_chunk_location,
    (png_structp png_ptr, png_infop info_ptr, int chunk, int location));
1994 1995
PNG_EXPORT(176, int, png_get_unknown_chunks, (png_const_structp png_ptr, 
    png_const_infop info_ptr, png_unknown_chunkpp entries));
1996 1997
#endif

1998
/* Png_free_data() will turn off the "valid" flag for anything it frees.
1999
 * If you need to turn it off for a chunk that your application has freed, 
2000 2001
 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
 */
2002 2003
PNG_EXPORT(177, void, png_set_invalid,
    (png_structp png_ptr, png_infop info_ptr, int mask));
2004

2005
#ifdef PNG_INFO_IMAGE_SUPPORTED
2006
/* The "params" pointer is currently not used and is for future expansion. */
2007 2008 2009 2010
PNG_EXPORT(178, void, png_read_png, (png_structp png_ptr, png_infop info_ptr, 
    int transforms, png_voidp params));
PNG_EXPORT(179, void, png_write_png, (png_structp png_ptr, png_infop info_ptr, 
    int transforms, png_voidp params));
2011 2012
#endif

2013
PNG_EXPORT(180, png_const_charp, png_get_copyright,
2014
    (png_const_structp png_ptr));
2015
PNG_EXPORT(181, png_const_charp, png_get_header_ver,
2016
    (png_const_structp png_ptr));
2017
PNG_EXPORT(182, png_const_charp, png_get_header_version,
2018
    (png_const_structp png_ptr));
2019
PNG_EXPORT(183, png_const_charp, png_get_libpng_ver,
2020
    (png_const_structp png_ptr));
2021

2022
#ifdef PNG_MNG_FEATURES_SUPPORTED
2023 2024
PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structp png_ptr, 
    png_uint_32 mng_features_permitted));
2025 2026
#endif

2027 2028 2029 2030 2031 2032
/* 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

2033
/* Strip the prepended error numbers ("#nnn ") from error and warning
2034 2035
 * messages before passing them to the error or warning handler.
 */
2036
#ifdef PNG_ERROR_NUMBERS_SUPPORTED
2037 2038 2039
PNG_EXPORT(185, void, png_set_strip_error_numbers,
    (png_structp png_ptr, 
    png_uint_32 strip_mode));
2040
#endif
2041

2042
/* Added in libpng-1.2.6 */
2043
#ifdef PNG_SET_USER_LIMITS_SUPPORTED
2044 2045
PNG_EXPORT(186, void, png_set_user_limits, (png_structp png_ptr, 
    png_uint_32 user_width_max, png_uint_32 user_height_max));
2046
PNG_EXPORT(187, png_uint_32, png_get_user_width_max,
2047
    (png_const_structp png_ptr));
2048
PNG_EXPORT(188, png_uint_32, png_get_user_height_max,
2049
    (png_const_structp png_ptr));
2050
/* Added in libpng-1.4.0 */
2051 2052
PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structp png_ptr, 
    png_uint_32 user_chunk_cache_max));
2053
PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max,
2054
    (png_const_structp png_ptr));
2055
/* Added in libpng-1.4.1 */
2056 2057 2058
PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structp png_ptr, 
    png_alloc_size_t user_chunk_cache_max));
PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max,
2059
    (png_const_structp png_ptr));
2060 2061
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
2062
#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
2063
PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch,
2064
    (png_const_structp png_ptr, png_const_infop info_ptr));
2065

2066
PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch,
2067
    (png_const_structp png_ptr, png_const_infop info_ptr));
2068

2069
PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch,
2070
    (png_const_structp png_ptr, png_const_infop info_ptr));
2071

2072
PNG_FP_EXPORT(196, float, png_get_x_offset_inches,
2073
    (png_const_structp png_ptr, png_const_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2074
#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2075
PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed, 
2076
    (png_structp png_ptr, png_const_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2077
#endif
2078

2079 2080
PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_const_structp png_ptr, 
    png_const_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2081
#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2082
PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed, 
2083
    (png_structp png_ptr, png_const_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2084
#endif
2085

2086
#  ifdef PNG_pHYs_SUPPORTED
2087 2088
PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structp png_ptr, 
    png_const_infop info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
2089
    int *unit_type));
2090
#  endif /* PNG_pHYs_SUPPORTED */
G
[devel]  
Glenn Randers-Pehrson 已提交
2091
#endif  /* PNG_INCH_CONVERSIONS_SUPPORTED */
2092

2093 2094
/* Added in libpng-1.4.0 */
#ifdef PNG_IO_STATE_SUPPORTED
2095
PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_structp png_ptr));
2096

2097 2098
PNG_EXPORTA(200, png_const_bytep, png_get_io_chunk_name,
    (png_structp png_ptr), PNG_DEPRECATED);
2099
PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type,
2100
    (png_const_structp png_ptr));
2101 2102

/* The flags returned by png_get_io_state() are the following: */
2103 2104 2105 2106 2107 2108 2109 2110 2111
#  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 */
2112 2113
#endif /* ?PNG_IO_STATE_SUPPORTED */

2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166
/* Interlace support.  The following macros are always defined so that if
 * libpng interlace handling is turned off the macros may be used to handle
 * interlaced images within the application.
 */
#define PNG_INTERLACE_ADAM7_PASSES 7

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

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

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

/* For the progressive reader it is necessary to find the row in the output
 * image given a row in an interlaced image, so two more macros:
 */
#define PNG_ROW_FROM_PASS_ROW(yIn, pass) \
   (((yIn)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass))
#define PNG_COL_FROM_PASS_COL(xIn, pass) \
   (((xIn)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass))

/* Two macros which return a boolean (0 or 1) saying whether the given row
 * or column is in a particular pass.  These use a common utility macro that
 * returns a mask for a given pass - the offset 'off' selects the row or
 * column version.  The mask has the appropriate bit set for each column in
 * the tile.
 */
#define PNG_PASS_MASK(pass,off) ( \
   ((0x110145AFU>>(((7-(off))-(pass))<<2)) & 0xFU) | \
   ((0x01145AF0U>>(((7-(off))-(pass))<<2)) & 0xF0U))

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

2167
#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
2168 2169 2170
/* 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
2171 2172 2173 2174 2175 2176 2177 2178 2179
 * 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. :-) ]
 */

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

2182 2183 2184 2185 2186
#  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);   \
2187
       (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
2188

2189 2190 2191 2192 2193
#  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); \
2194 2195
       (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }

2196
#else  /* Standard method using integer division */
2197

2198 2199
#  define png_composite(composite, fg, alpha, bg)                          \
     (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) +  \
2200 2201
     (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) +       \
     (png_uint_16)127) / 255)
2202 2203

#  define png_composite_16(composite, fg, alpha, bg)                         \
2204
     (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \
2205
     (png_uint_32)(bg)*(png_uint_32)(65535L - (png_uint_32)(alpha)) +        \
2206
     (png_uint_32)32767) / (png_uint_32)65535L)
2207 2208
#endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */

2209
#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
2210 2211 2212
PNG_EXPORT(201, png_uint_32, png_get_uint_32, (png_const_bytep buf));
PNG_EXPORT(202, png_uint_16, png_get_uint_16, (png_const_bytep buf));
PNG_EXPORT(203, png_int_32, png_get_int_32, (png_const_bytep buf));
2213 2214
#endif

2215 2216
PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_structp png_ptr, 
    png_const_bytep buf));
2217 2218
/* No png_get_int_16 -- may be added if there's a real need for it. */

2219
/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
2220
#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2221
PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i));
2222
#endif
2223
#ifdef PNG_SAVE_INT_32_SUPPORTED
2224
PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i));
2225
#endif
2226 2227

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

2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260
#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.
 */
#  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))))

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

#  define png_get_int_32(buf) \
     ((png_int_32)((*(buf) & 0x80) \
      ? -((png_int_32)((png_get_uint_32(buf) ^ 0xffffffffL) + 1)) \
      : (png_int_32)png_get_uint_32(buf)))
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
2261 2262 2263 2264
/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
 * defs
 */

2265
/* The last ordinal number (this is the *last* one already used; the next
2266 2267
 * one to use is one more than this.)  Maintainer, remember to add an entry to
 * scripts/symbols.def as well.
2268 2269
 */
#ifdef PNG_EXPORT_LAST_ORDINAL
2270
  PNG_EXPORT_LAST_ORDINAL(220);
2271 2272
#endif

A
Andreas Dilger 已提交
2273 2274 2275 2276
#ifdef __cplusplus
}
#endif

2277
#endif /* PNG_VERSION_INFO_ONLY */
2278
/* Do not put anything past this line */
2279
#endif /* PNG_H */