png.h 111.1 KB
Newer Older
1

A
Andreas Dilger 已提交
2
/* png.h - header file for PNG reference library
3
 *
4
 * libpng version 1.5.6rc01 - October 26, 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.6rc01 - October 26, 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-11          15    10501  15.so.15.1[.0]
148 149
 *    1.5.1rc01-02            15    10501  15.so.15.1[.0]
 *    1.5.1                   15    10501  15.so.15.1[.0]
150
 *    1.5.2beta01-03          15    10502  15.so.15.2[.0]
151
 *    1.5.2rc01-03            15    10502  15.so.15.2[.0]
152
 *    1.5.2                   15    10502  15.so.15.2[.0]
153
 *    1.5.3beta01-10          15    10503  15.so.15.3[.0]
154
 *    1.5.3rc01-02            15    10503  15.so.15.3[.0]
155 156
 *    1.5.3beta11             15    10503  15.so.15.3[.0]
 *    1.5.3 [omitted]
157
 *    1.5.4beta01-08          15    10504  15.so.15.4[.0]
158
 *    1.5.4rc01               15    10504  15.so.15.4[.0]
159
 *    1.5.4                   15    10504  15.so.15.4[.0]
160 161
 *    1.5.5beta01-08          15    10505  15.so.15.5[.0]
 *    1.5.5rc01               15    10505  15.so.15.5[.0]
162
 *    1.5.5                   15    10505  15.so.15.5[.0]
163 164
 *    1.5.6beta01-07          15    10506  15.so.15.6[.0]
 *    1.5.6rc01               15    10506  15.so.15.6[.0]
165
 *
166 167 168 169 170 171 172 173 174
 *   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".
175
 *
176 177 178
 *   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.
179
 *
180 181
 *   DLLNUM will change each time there are forward or backward changes
 *   in binary compatibility (e.g., when a new feature is added).
182
 *
183 184 185
 * 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/
186 187 188
 */

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

281
/*
282 283
 * A "png_get_copyright" function is available, for convenient use in "about"
 * boxes and the like:
284
 *
285
 *     printf("%s", png_get_copyright(NULL));
286
 *
287
 * Also, the PNG logo (in PNG format, of course) is supplied in the
288
 * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
289 290 291
 */

/*
292 293 294 295 296 297 298 299 300 301 302 303
 * 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.
 */

304 305 306 307
/*
 * Y2K compliance in libpng:
 * =========================
 *
308
 *    October 26, 2011
309 310 311 312 313
 *
 *    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
314
 *    upward through 1.5.6rc01 are Y2K compliant.  It is my belief that
G
[devel]  
Glenn Randers-Pehrson 已提交
315
 *    earlier versions were also Y2K compliant.
316
 *
317 318
 *    Libpng only has two year fields.  One is a 2-byte unsigned integer
 *    that will hold years up to 65535.  The other holds the date in text
319 320 321 322 323
 *    format, and will hold years up to 9999.
 *
 *    The integer is
 *        "png_uint_16 year" in png_time_struct.
 *
324 325
 *    The string is
 *        "png_char time_buffer" in png_struct
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
 *
 *    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
343
 *    instead of "year - 1900" into the png_convert_from_struct_tm() function,
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
 *    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
 */

359 360
#ifndef PNG_H
#define PNG_H
G
Guy Schalnat 已提交
361

362
/* This is not the place to learn how to use libpng. The file libpng-manual.txt
A
Andreas Dilger 已提交
363 364 365 366
 * 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 已提交
367

368
/* Version information for png.h - this should match the version in png.c */
369
#define PNG_LIBPNG_VER_STRING "1.5.6rc01"
370
#define PNG_HEADER_VERSION_STRING \
371
     " libpng version 1.5.6rc01 - October 26, 2011\n"
372

373 374
#define PNG_LIBPNG_VER_SONUM   15
#define PNG_LIBPNG_VER_DLLNUM  15
375 376 377

/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */
#define PNG_LIBPNG_VER_MAJOR   1
378
#define PNG_LIBPNG_VER_MINOR   5
379
#define PNG_LIBPNG_VER_RELEASE 6
380
/* This should match the numeric part of the final component of
381 382
 * PNG_LIBPNG_VER_STRING, omitting any leading zero:
 */
383

384
#define PNG_LIBPNG_VER_BUILD  01
385

386
/* Release Status */
387 388 389 390
#define PNG_LIBPNG_BUILD_ALPHA    1
#define PNG_LIBPNG_BUILD_BETA     2
#define PNG_LIBPNG_BUILD_RC       3
#define PNG_LIBPNG_BUILD_STABLE   4
391
#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7
392

393 394 395 396 397 398 399
/* 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 */
400

401
#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_BETA
402

403 404 405 406
/* 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
407 408
 * version 1.0.1 it's    xxyyzz, where x=major, y=minor, z=release
 */
409
#define PNG_LIBPNG_VER 10506 /* 1.5.6 */
410

411 412 413 414
/* Library configuration: these options cannot be changed after
 * the library has been built.
 */
#ifndef PNGLCONF_H
415 416 417
    /* If pnglibconf.h is missing, you can
     * copy scripts/pnglibconf.h.prebuilt to pnglibconf.h
     */
418
#   include "pnglibconf.h"
419 420
#endif

421
#ifndef PNG_VERSION_INFO_ONLY
422 423 424 425 426 427 428 429
#  ifndef PNG_BUILDING_SYMBOL_TABLE
  /*
   *   Standard header files (not needed for the version info or while
   *   building symbol table -- see scripts/pnglibconf.dfa)
   */
#    ifdef PNG_SETJMP_SUPPORTED
#      include <setjmp.h>
#    endif
430

431 432 433 434 435 436 437 438
    /* 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
#  endif
G
Guy Schalnat 已提交
439

440 441 442
/* Machine specific configuration. */
#  include "pngconf.h"
#endif
G
Guy Schalnat 已提交
443

444
/*
445 446 447
 * Added at libpng-1.2.8
 *
 * Ref MSDN: Private as priority over Special
448 449
 * VS_FF_PRIVATEBUILD File *was not* built using standard release
 * procedures. If this value is given, the StringFileInfo block must
450
 * contain a PrivateBuild string.
451 452 453 454
 *
 * 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
455
 * StringFileInfo block must contain a SpecialBuild string.
456 457
 */

458
#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
459
#  define PNG_LIBPNG_BUILD_TYPE \
460
       (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
461
#else
462
#  ifdef PNG_LIBPNG_SPECIALBUILD
463
#    define PNG_LIBPNG_BUILD_TYPE \
464
         (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
465
#  else
466
#    define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
467 468 469 470 471
#  endif
#endif

#ifndef PNG_VERSION_INFO_ONLY

472 473 474 475 476
/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

A
Andreas Dilger 已提交
477 478 479
/* Version information for C files, stored in png.c.  This had better match
 * the version above.
 */
480
#define png_libpng_ver png_get_header_ver(NULL)
A
Andreas Dilger 已提交
481

482 483 484
/* This file is arranged in several sections:
 *
 * 1. Any configuration options that can be specified by for the application
485
 *    code when it is built.  (Build time configuration is in pnglibconf.h)
486 487 488 489 490 491 492 493
 * 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
494
 * See pnglibconf.h for build time configuration
495 496 497
 *
 * Run time configuration allows the application to choose between
 * implementations of certain arithmetic APIs.  The default is set
498
 * at build time and recorded in pnglibconf.h, but it is safe to
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
 * 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
 */
527 528 529 530

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

A
Andreas Dilger 已提交
533 534 535 536
/* 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 已提交
537 538
typedef struct png_color_struct
{
G
Guy Schalnat 已提交
539
   png_byte red;
G
Guy Schalnat 已提交
540 541 542
   png_byte green;
   png_byte blue;
} png_color;
A
Andreas Dilger 已提交
543
typedef png_color FAR * png_colorp;
544
typedef PNG_CONST png_color FAR * png_const_colorp;
A
Andreas Dilger 已提交
545
typedef png_color FAR * FAR * png_colorpp;
G
Guy Schalnat 已提交
546 547 548

typedef struct png_color_16_struct
{
A
Andreas Dilger 已提交
549 550
   png_byte index;    /* used for palette files */
   png_uint_16 red;   /* for use in red green blue files */
G
Guy Schalnat 已提交
551 552
   png_uint_16 green;
   png_uint_16 blue;
A
Andreas Dilger 已提交
553
   png_uint_16 gray;  /* for use in grayscale files */
G
Guy Schalnat 已提交
554
} png_color_16;
A
Andreas Dilger 已提交
555
typedef png_color_16 FAR * png_color_16p;
556
typedef PNG_CONST png_color_16 FAR * png_const_color_16p;
A
Andreas Dilger 已提交
557
typedef png_color_16 FAR * FAR * png_color_16pp;
G
Guy Schalnat 已提交
558 559 560

typedef struct png_color_8_struct
{
A
Andreas Dilger 已提交
561
   png_byte red;   /* for use in red green blue files */
G
Guy Schalnat 已提交
562 563
   png_byte green;
   png_byte blue;
A
Andreas Dilger 已提交
564
   png_byte gray;  /* for use in grayscale files */
G
Guy Schalnat 已提交
565 566
   png_byte alpha; /* for alpha channel files */
} png_color_8;
A
Andreas Dilger 已提交
567
typedef png_color_8 FAR * png_color_8p;
568
typedef PNG_CONST png_color_8 FAR * png_const_color_8p;
A
Andreas Dilger 已提交
569
typedef png_color_8 FAR * FAR * png_color_8pp;
G
Guy Schalnat 已提交
570

571 572 573 574
/*
 * The following two structures are used for the in-core representation
 * of sPLT chunks.
 */
575
typedef struct png_sPLT_entry_struct
576 577 578 579 580 581
{
   png_uint_16 red;
   png_uint_16 green;
   png_uint_16 blue;
   png_uint_16 alpha;
   png_uint_16 frequency;
582 583
} png_sPLT_entry;
typedef png_sPLT_entry FAR * png_sPLT_entryp;
584
typedef PNG_CONST png_sPLT_entry FAR * png_const_sPLT_entryp;
585
typedef png_sPLT_entry FAR * FAR * png_sPLT_entrypp;
586

587 588 589 590 591
/*  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.
 */

592
typedef struct png_sPLT_struct
593
{
594 595 596 597
   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 */
598 599
} png_sPLT_t;
typedef png_sPLT_t FAR * png_sPLT_tp;
600
typedef PNG_CONST png_sPLT_t FAR * png_const_sPLT_tp;
601
typedef png_sPLT_t FAR * FAR * png_sPLT_tpp;
602 603

#ifdef PNG_TEXT_SUPPORTED
604
/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,
605
 * and whether that contents is compressed or not.  The "key" field
606 607
 * 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.
608
 * However, the structure returned by png_get_text() will always contain
609
 * regular zero-terminated C strings (possibly empty), never NULL pointers,
610 611
 * so they can be safely used in printf() and other string-handling functions.
 */
G
Guy Schalnat 已提交
612 613
typedef struct png_text_struct
{
614 615 616 617 618
   int  compression;       /* compression value:
                             -1: tEXt, none
                              0: zTXt, deflate
                              1: iTXt, none
                              2: iTXt, deflate  */
A
Andreas Dilger 已提交
619
   png_charp key;          /* keyword, 1-79 character description of "text" */
620 621
   png_charp text;         /* comment, may be an empty string (ie "")
                              or a NULL pointer */
622 623
   png_size_t text_length; /* length of the text string */
   png_size_t itxt_length; /* length of the itxt string */
624 625
   png_charp lang;         /* language code, 0-79 characters
                              or a NULL pointer */
626
   png_charp lang_key;     /* keyword translated UTF-8 string, 0 or more
627
                              chars or a NULL pointer */
G
Guy Schalnat 已提交
628
} png_text;
A
Andreas Dilger 已提交
629
typedef png_text FAR * png_textp;
630
typedef PNG_CONST png_text FAR * png_const_textp;
A
Andreas Dilger 已提交
631
typedef png_text FAR * FAR * png_textpp;
632
#endif
A
Andreas Dilger 已提交
633 634 635 636 637 638 639

/* 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
640 641 642
#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 已提交
643 644

/* png_time is a way to hold the time in an machine independent way.
645 646 647
 * 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
648
 * note - PNG has always been Year 2000 compliant!
649
 */
G
Guy Schalnat 已提交
650 651 652
typedef struct png_time_struct
{
   png_uint_16 year; /* full year, as in, 1995 */
A
Andreas Dilger 已提交
653 654 655 656 657
   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 已提交
658
} png_time;
A
Andreas Dilger 已提交
659
typedef png_time FAR * png_timep;
660
typedef PNG_CONST png_time FAR * png_const_timep;
A
Andreas Dilger 已提交
661 662
typedef png_time FAR * FAR * png_timepp;

663
#if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED) || \
664
    defined(PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
665 666 667 668 669 670 671 672 673 674 675
/* 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;

676
    /* libpng-using applications should NOT directly modify this byte. */
677 678
    png_byte location; /* mode of operation at read time */
}
679 680


681 682
png_unknown_chunk;
typedef png_unknown_chunk FAR * png_unknown_chunkp;
683
typedef PNG_CONST png_unknown_chunk FAR * png_const_unknown_chunkp;
684 685 686
typedef png_unknown_chunk FAR * FAR * png_unknown_chunkpp;
#endif

687
/* Values for the unknown chunk location byte */
688

689 690 691
#define PNG_HAVE_IHDR  0x01
#define PNG_HAVE_PLTE  0x02
#define PNG_AFTER_IDAT 0x08
692

693 694 695 696
/* The complete definition of png_info has, as of libpng-1.5.0,
 * been moved into a separate header file that is not accessible to
 * applications.  Read libpng-manual.txt or libpng.3 for more info.
 */
697
typedef struct png_info_def png_info;
A
Andreas Dilger 已提交
698
typedef png_info FAR * png_infop;
699
typedef PNG_CONST png_info FAR * png_const_infop;
A
Andreas Dilger 已提交
700
typedef png_info FAR * FAR * png_infopp;
G
Guy Schalnat 已提交
701

702
/* Maximum positive integer used in PNG is (2^31)-1 */
703
#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
704 705
#define PNG_UINT_32_MAX ((png_uint_32)(-1))
#define PNG_SIZE_MAX ((png_size_t)(-1))
706

G
[devel]  
Glenn Randers-Pehrson 已提交
707 708 709 710 711
/* These are constants for fixed point values encoded in the
 * PNG specification manner (x100000)
 */
#define PNG_FP_1    100000
#define PNG_FP_HALF  50000
712 713
#define PNG_FP_MAX  ((png_fixed_point)0x7fffffffL)
#define PNG_FP_MIN  (-PNG_FP_MAX)
G
[devel]  
Glenn Randers-Pehrson 已提交
714

A
Andreas Dilger 已提交
715
/* These describe the color_type field in png_info. */
G
Guy Schalnat 已提交
716
/* color type masks */
A
Andreas Dilger 已提交
717 718 719
#define PNG_COLOR_MASK_PALETTE    1
#define PNG_COLOR_MASK_COLOR      2
#define PNG_COLOR_MASK_ALPHA      4
G
Guy Schalnat 已提交
720 721

/* color types.  Note that not all combinations are legal */
G
Guy Schalnat 已提交
722
#define PNG_COLOR_TYPE_GRAY 0
A
Andreas Dilger 已提交
723 724 725
#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 已提交
726
#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
727 728 729
/* aliases */
#define PNG_COLOR_TYPE_RGBA  PNG_COLOR_TYPE_RGB_ALPHA
#define PNG_COLOR_TYPE_GA  PNG_COLOR_TYPE_GRAY_ALPHA
G
Guy Schalnat 已提交
730

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

735
/* This is for filter type. PNG 1.0-1.2 only define the single type. */
A
Andreas Dilger 已提交
736
#define PNG_FILTER_TYPE_BASE      0 /* Single row per-byte filtering */
737
#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
A
Andreas Dilger 已提交
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
#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 */

757 758 759 760 761 762
/* 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 已提交
763 764 765 766 767
/* 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 */

768
/* These are for the sRGB chunk.  These values should NOT be changed. */
769 770 771 772
#define PNG_sRGB_INTENT_PERCEPTUAL 0
#define PNG_sRGB_INTENT_RELATIVE   1
#define PNG_sRGB_INTENT_SATURATION 2
#define PNG_sRGB_INTENT_ABSOLUTE   3
773
#define PNG_sRGB_INTENT_LAST       4 /* Not a valid value */
774

775 776
/* This is for text chunks */
#define PNG_KEYWORD_MAX_LENGTH     79
777

778
/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
779
#define PNG_MAX_PALETTE_LENGTH    256
780

A
Andreas Dilger 已提交
781 782 783 784 785
/* 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 已提交
786 787 788 789 790 791 792 793 794 795
#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 已提交
796
#define PNG_INFO_pCAL 0x0400
797
#define PNG_INFO_sRGB 0x0800   /* GR-P, 0.96a */
798 799 800
#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 */
801
#define PNG_INFO_IDAT 0x8000   /* ESR, 1.0.6 */
G
Guy Schalnat 已提交
802

A
Andreas Dilger 已提交
803 804 805 806
/* 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 已提交
807 808
typedef struct png_row_info_struct
{
809 810 811 812 813
   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 已提交
814
   png_byte pixel_depth; /* bits per pixel (depth * channels) */
G
Guy Schalnat 已提交
815 816
} png_row_info;

A
Andreas Dilger 已提交
817 818
typedef png_row_info FAR * png_row_infop;
typedef png_row_info FAR * FAR * png_row_infopp;
G
Guy Schalnat 已提交
819

820 821 822 823 824 825 826 827
/* The complete definition of png_struct has, as of libpng-1.5.0,
 * been moved into a separate header file that is not accessible to
 * applications.  Read libpng-manual.txt or libpng.3 for more info.
 */
typedef struct png_struct_def png_struct;
typedef PNG_CONST png_struct FAR * png_const_structp;
typedef png_struct FAR * png_structp;

828 829 830 831
/* 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
832
 * user read/write data functions.  Note that the 'write' function must not
833
 * modify the buffer it is passed. The 'read' function, on the other hand, is
834
 * expected to return the read data in the buffer.
G
Guy Schalnat 已提交
835
 */
836 837 838 839 840 841 842
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));
843

G
Guy Schalnat 已提交
844
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
845 846
typedef PNG_CALLBACK(void, *png_progressive_info_ptr, (png_structp, png_infop));
typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop));
847 848 849 850 851 852 853 854 855 856 857

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

862
#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
863
    defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
864
typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
865
    png_bytep));
866
#endif
867

868
#ifdef PNG_USER_CHUNKS_SUPPORTED
869
typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
870
    png_unknown_chunkp));
871
#endif
872
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
873
typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp));
874
#endif
875

876
#ifdef PNG_SETJMP_SUPPORTED
877 878 879 880 881 882 883
/* This must match the function definition in <setjmp.h>, and the application
 * must include this before png.h to obtain the definition of jmp_buf.  The
 * function is required to be PNG_NORETURN, but this is not checked.  If the
 * function does return the application will crash via an abort() or similar
 * system level call.
 *
 * If you get a warning here while building the library you may need to make
G
[devel]  
Glenn Randers-Pehrson 已提交
884 885 886
 * 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!
887
 */
888
PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)), typedef);
889
#endif
890 891

/* Transform masks for the high-level interface */
892 893
#define PNG_TRANSFORM_IDENTITY       0x0000    /* read and write */
#define PNG_TRANSFORM_STRIP_16       0x0001    /* read only */
894 895
#define PNG_TRANSFORM_STRIP_ALPHA    0x0002    /* read only */
#define PNG_TRANSFORM_PACKING        0x0004    /* read and write */
896 897
#define PNG_TRANSFORM_PACKSWAP       0x0008    /* read and write */
#define PNG_TRANSFORM_EXPAND         0x0010    /* read only */
898
#define PNG_TRANSFORM_INVERT_MONO    0x0020    /* read and write */
899 900 901
#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 */
902
#define PNG_TRANSFORM_SWAP_ENDIAN    0x0200    /* read and write */
903
#define PNG_TRANSFORM_INVERT_ALPHA   0x0400    /* read and write */
904
#define PNG_TRANSFORM_STRIP_FILLER   0x0800    /* write only */
905
/* Added to libpng-1.2.34 */
906
#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
907 908 909
#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
/* Added to libpng-1.4.0 */
#define PNG_TRANSFORM_GRAY_TO_RGB   0x2000      /* read only */
910
/* Added to libpng-1.5.4 */
911
#define PNG_TRANSFORM_EXPAND_16     0x4000      /* read only */
912
#define PNG_TRANSFORM_SCALE_16      0x8000      /* read only */
913

914
/* Flags for MNG supported features */
915 916
#define PNG_FLAG_MNG_EMPTY_PLTE     0x01
#define PNG_FLAG_MNG_FILTER_64      0x04
917
#define PNG_ALL_MNG_FEATURES        0x05
918

919
/* NOTE: prior to 1.5 these functions had no 'API' style declaration,
920 921 922 923 924
 * 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.
 */
925
typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,
926 927
    png_alloc_size_t));
typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp));
928

A
Andreas Dilger 已提交
929
typedef png_struct FAR * FAR * png_structpp;
G
Guy Schalnat 已提交
930

931 932
/* Section 3: exported functions
 * Here are the function definitions most commonly used.  This is not
933
 * the place to find out how to use libpng.  See libpng-manual.txt for the
A
Andreas Dilger 已提交
934
 * full explanation, see example.c for the summary.  This just provides
935
 * a simple one line description of the use of each function.
G
[devel]  
Glenn Randers-Pehrson 已提交
936
 *
937 938
 * 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 已提交
939
 *
940
 *   PNG_EXPORT(ordinal, type, name, (args));
941 942 943 944 945
 *
 *       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
946
 *                   entries, and are removed by pngconf.h.
947 948 949 950
 *       type:       return type of the function
 *       name:       function name
 *       args:       function arguments, with types
 *
951 952 953
 * When we wish to append attributes to a function prototype we use
 * the PNG_EXPORTA() macro instead.
 *
954 955
 *   PNG_EXPORTA(ordinal, type, name, (args), attributes);
 *
956
 *       ordinal, type, name, and args: same as in PNG_EXPORT().
957
 *       attributes: function attributes
A
Andreas Dilger 已提交
958
 */
G
Guy Schalnat 已提交
959

960
/* Returns the version number of the library */
961
PNG_EXPORT(1, png_uint_32, png_access_version_number, (void));
962

A
Andreas Dilger 已提交
963
/* Tell lib we have already handled the first <num_bytes> magic bytes.
A
Andreas Dilger 已提交
964 965
 * Handling more than 8 bytes from the beginning of the file is an error.
 */
966
PNG_EXPORT(2, void, png_set_sig_bytes, (png_structp png_ptr, int num_bytes));
A
Andreas Dilger 已提交
967 968 969 970 971 972

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

976 977 978
/* Simple signature checking function.  This is the same as calling
 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
 */
979
#define png_check_sig(sig, n) !png_sig_cmp((sig), 0, (n))
980

A
Andreas Dilger 已提交
981
/* Allocate and initialize png_ptr struct for reading, and any other memory. */
982 983
PNG_EXPORTA(4, png_structp, png_create_read_struct,
    (png_const_charp user_png_ver, png_voidp error_ptr,
984
    png_error_ptr error_fn, png_error_ptr warn_fn),
985
    PNG_ALLOCATED);
A
Andreas Dilger 已提交
986

987
/* Allocate and initialize png_ptr struct for writing, and any other memory */
988 989
PNG_EXPORTA(5, png_structp, png_create_write_struct,
    (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
990
    png_error_ptr warn_fn),
991
    PNG_ALLOCATED);
G
Guy Schalnat 已提交
992

993
PNG_EXPORT(6, png_size_t, png_get_compression_buffer_size,
994
    (png_const_structp png_ptr));
995

996
PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structp png_ptr,
997
    png_size_t size));
998

999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
/* 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.
 */
1010
PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structp png_ptr,
1011
    png_longjmp_ptr longjmp_fn, size_t jmp_buf_size));
1012
#  define png_jmpbuf(png_ptr) \
1013
      (*png_set_longjmp_fn((png_ptr), longjmp, sizeof (jmp_buf)))
1014 1015
#else
#  define png_jmpbuf(png_ptr) \
1016
      (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
1017
#endif
1018 1019 1020 1021 1022
/* 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.
 */
1023 1024
PNG_EXPORTA(9, void, png_longjmp, (png_structp png_ptr, int val),
    PNG_NORETURN);
1025

1026
#ifdef PNG_READ_SUPPORTED
1027
/* Reset the compression stream */
1028
PNG_EXPORT(10, int, png_reset_zstream, (png_structp png_ptr));
1029
#endif
1030

1031
/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
1032
#ifdef PNG_USER_MEM_SUPPORTED
1033 1034
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,
1035 1036
    png_error_ptr warn_fn,
    png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
1037 1038 1039
    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,
1040 1041
    png_error_ptr warn_fn,
    png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
1042
    PNG_ALLOCATED);
1043 1044
#endif

1045
/* Write the PNG file signature. */
1046
PNG_EXPORT(13, void, png_write_sig, (png_structp png_ptr));
1047

1048
/* Write a PNG chunk - size, type, (optional) data, CRC. */
1049 1050
PNG_EXPORT(14, void, png_write_chunk, (png_structp png_ptr, png_const_bytep
    chunk_name, png_const_bytep data, png_size_t length));
1051 1052

/* Write the start of a PNG chunk - length and chunk name. */
1053
PNG_EXPORT(15, void, png_write_chunk_start, (png_structp png_ptr,
1054
    png_const_bytep chunk_name, png_uint_32 length));
1055 1056

/* Write the data of a PNG chunk started with png_write_chunk_start(). */
1057 1058
PNG_EXPORT(16, void, png_write_chunk_data, (png_structp png_ptr,
    png_const_bytep data, png_size_t length));
1059 1060

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

A
Andreas Dilger 已提交
1063
/* Allocate and initialize the info structure */
1064
PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_structp png_ptr),
1065
    PNG_ALLOCATED);
G
Guy Schalnat 已提交
1066

1067
PNG_EXPORT(19, void, png_info_init_3, (png_infopp info_ptr,
1068
    png_size_t png_info_struct_size));
G
Guy Schalnat 已提交
1069

A
Andreas Dilger 已提交
1070
/* Writes all the PNG information before the image. */
1071 1072 1073 1074
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 已提交
1075

1076
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1077
/* Read the information before the actual image data. */
1078 1079
PNG_EXPORT(22, void, png_read_info,
    (png_structp png_ptr, png_infop info_ptr));
1080
#endif
G
Guy Schalnat 已提交
1081

1082
#ifdef PNG_TIME_RFC1123_SUPPORTED
1083
PNG_EXPORT(23, png_const_charp, png_convert_to_rfc1123,
1084
    (png_structp png_ptr,
1085
    png_const_timep ptime));
1086
#endif
1087

1088
#ifdef PNG_CONVERT_tIME_SUPPORTED
1089
/* Convert from a struct tm to png_time */
1090
PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime,
1091
    PNG_CONST struct tm FAR * ttime));
G
Guy Schalnat 已提交
1092

1093
/* Convert from time_t to png_time.  Uses gmtime() */
1094 1095
PNG_EXPORT(25, void, png_convert_from_time_t,
    (png_timep ptime, time_t ttime));
1096
#endif /* PNG_CONVERT_tIME_SUPPORTED */
G
Guy Schalnat 已提交
1097

1098
#ifdef PNG_READ_EXPAND_SUPPORTED
1099
/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
1100 1101 1102 1103
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));
1104
#endif
G
Guy Schalnat 已提交
1105

1106
#ifdef PNG_READ_EXPAND_16_SUPPORTED
1107
/* Expand to 16-bit channels, forces conversion of palette to RGB and expansion
1108 1109 1110 1111 1112
 * of a tRNS chunk if present.
 */
PNG_EXPORT(221, void, png_set_expand_16, (png_structp png_ptr));
#endif

G
Guy Schalnat 已提交
1113
#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
G
Guy Schalnat 已提交
1114
/* Use blue, green, red order for pixels. */
1115
PNG_EXPORT(30, void, png_set_bgr, (png_structp png_ptr));
1116
#endif
G
Guy Schalnat 已提交
1117

1118
#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
1119
/* Expand the grayscale to 24-bit RGB if necessary. */
1120
PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structp png_ptr));
1121
#endif
G
Guy Schalnat 已提交
1122

1123
#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
1124
/* Reduce RGB to grayscale. */
1125 1126
PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structp png_ptr,
    int error_action, double red, double green));
1127
PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structp png_ptr,
1128
    int error_action, png_fixed_point red, png_fixed_point green));
1129

1130
PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structp
1131
    png_ptr));
1132
#endif
A
Andreas Dilger 已提交
1133

1134
#ifdef PNG_BUILD_GRAYSCALE_PALETTE_SUPPORTED
1135
PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth,
1136
    png_colorp palette));
1137
#endif
A
Andreas Dilger 已提交
1138

1139 1140
#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
/* How the alpha channel is interpreted - this affects how the color channels of
1141 1142
 * a PNG file are returned when an alpha channel, or tRNS chunk in a palette
 * file, is present.
1143
 *
1144 1145 1146 1147 1148
 * This has no effect on the way pixels are written into a PNG output
 * datastream. The color samples in a PNG datastream are never premultiplied
 * with the alpha samples.
 *
 * The default is to return data according to the PNG specification: the alpha
1149
 * channel is a linear measure of the contribution of the pixel to the
1150 1151 1152 1153
 * corresponding composited pixel.  The gamma encoded color channels must be
 * scaled according to the contribution and to do this it is necessary to undo
 * the encoding, scale the color values, perform the composition and reencode
 * the values.  This is the 'PNG' mode.
1154 1155 1156 1157 1158
 *
 * The alternative is to 'associate' the alpha with the color information by
 * storing color channel values that have been scaled by the alpha.  The
 * advantage is that the color channels can be resampled (the image can be
 * scaled) in this form.  The disadvantage is that normal practice is to store
1159 1160
 * linear, not (gamma) encoded, values and this requires 16-bit channels for
 * still images rather than the 8-bit channels that are just about sufficient if
1161 1162
 * gamma encoding is used.  In addition all non-transparent pixel values,
 * including completely opaque ones, must be gamma encoded to produce the final
1163
 * image.  This is the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' mode (the
1164 1165 1166 1167 1168 1169 1170 1171
 * latter being the two common names for associated alpha color channels.)
 *
 * Since it is not necessary to perform arithmetic on opaque color values so
 * long as they are not to be resampled and are in the final color space it is
 * possible to optimize the handling of alpha by storing the opaque pixels in
 * the PNG format (adjusted for the output color space) while storing partially
 * opaque pixels in the standard, linear, format.  The accuracy required for
 * standard alpha composition is relatively low, because the pixels are
1172
 * isolated, therefore typically the accuracy loss in storing 8-bit linear
1173
 * values is acceptable.  (This is not true if the alpha channel is used to
1174 1175
 * simulate transparency over large areas - use 16 bits or the PNG mode in
 * this case!)  This is the 'OPTIMIZED' mode.  For this mode a pixel is
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
 * treated as opaque only if the alpha value is equal to the maximum value.
 *
 * The final choice is to gamma encode the alpha channel as well.  This is
 * broken because, in practice, no implementation that uses this choice
 * correctly undoes the encoding before handling alpha composition.  Use this
 * choice only if other serious errors in the software or hardware you use
 * mandate it; the typical serious error is for dark halos to appear around
 * opaque areas of the composited PNG image because of arithmetic overflow.
 *
 * The API function png_set_alpha_mode specifies which of these choices to use
1186
 * with an enumerated 'mode' value and the gamma of the required output:
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
 */
#define PNG_ALPHA_PNG           0 /* according to the PNG standard */
#define PNG_ALPHA_STANDARD      1 /* according to Porter/Duff */
#define PNG_ALPHA_ASSOCIATED    1 /* as above; this is the normal practice */
#define PNG_ALPHA_PREMULTIPLIED 1 /* as above */
#define PNG_ALPHA_OPTIMIZED     2 /* 'PNG' for opaque pixels, else 'STANDARD' */
#define PNG_ALPHA_BROKEN        3 /* the alpha channel is gamma encoded */

PNG_FP_EXPORT(227, void, png_set_alpha_mode, (png_structp png_ptr, int mode,
    double output_gamma));
PNG_FIXED_EXPORT(228, void, png_set_alpha_mode_fixed, (png_structp png_ptr,
    int mode, png_fixed_point output_gamma));
1199
#endif
1200

1201
#if defined(PNG_READ_GAMMA_SUPPORTED) || defined(PNG_READ_ALPHA_MODE_SUPPORTED)
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
/* The output_gamma value is a screen gamma in libpng terminology: it expresses
 * how to decode the output values, not how they are encoded.  The values used
 * correspond to the normal numbers used to describe the overall gamma of a
 * computer display system; for example 2.2 for an sRGB conformant system.  The
 * values are scaled by 100000 in the _fixed version of the API (so 220000 for
 * sRGB.)
 *
 * The inverse of the value is always used to provide a default for the PNG file
 * encoding if it has no gAMA chunk and if png_set_gamma() has not been called
 * to override the PNG gamma information.
 *
 * When the ALPHA_OPTIMIZED mode is selected the output gamma is used to encode
 * opaque pixels however pixels with lower alpha values are not encoded,
 * regardless of the output gamma setting.
 *
 * When the standard Porter Duff handling is requested with mode 1 the output
 * encoding is set to be linear and the output_gamma value is only relevant
 * as a default for input data that has no gamma information.  The linear output
 * encoding will be overridden if png_set_gamma() is called - the results may be
 * highly unexpected!
 *
 * The following numbers are derived from the sRGB standard and the research
 * behind it.  sRGB is defined to be approximated by a PNG gAMA chunk value of
 * 0.45455 (1/2.2) for PNG.  The value implicitly includes any viewing
 * correction required to take account of any differences in the color
 * environment of the original scene and the intended display environment; the
 * value expresses how to *decode* the image for display, not how the original
 * data was *encoded*.
 *
 * sRGB provides a peg for the PNG standard by defining a viewing environment.
 * sRGB itself, and earlier TV standards, actually use a more complex transform
 * (a linear portion then a gamma 2.4 power law) than PNG can express.  (PNG is
 * limited to simple power laws.)  By saying that an image for direct display on
 * an sRGB conformant system should be stored with a gAMA chunk value of 45455
 * (11.3.3.2 and 11.3.3.5 of the ISO PNG specification) the PNG specification
 * makes it possible to derive values for other display systems and
 * environments.
 *
 * The Mac value is deduced from the sRGB based on an assumption that the actual
 * extra viewing correction used in early Mac display systems was implemented as
 * a power 1.45 lookup table.
 *
 * Any system where a programmable lookup table is used or where the behavior of
 * the final display device characteristics can be changed requires system
 * specific code to obtain the current characteristic.  However this can be
 * difficult and most PNG gamma correction only requires an approximate value.
 *
 * By default, if png_set_alpha_mode() is not called, libpng assumes that all
 * values are unencoded, linear, values and that the output device also has a
 * linear characteristic.  This is only very rarely correct - it is invariably
 * better to call png_set_alpha_mode() with PNG_DEFAULT_sRGB than rely on the
 * default if you don't know what the right answer is!
 *
1255 1256 1257 1258 1259 1260 1261
 * The special value PNG_GAMMA_MAC_18 indicates an older Mac system (pre Mac OS
 * 10.6) which used a correction table to implement a somewhat lower gamma on an
 * otherwise sRGB system.
 *
 * Both these values are reserved (not simple gamma values) in order to allow
 * more precise correction internally in the future.
 *
1262 1263 1264 1265
 * NOTE: the following values can be passed to either the fixed or floating
 * point APIs, but the floating point API will also accept floating point
 * values.
 */
1266 1267
#define PNG_DEFAULT_sRGB -1       /* sRGB gamma and color space */
#define PNG_GAMMA_MAC_18 -2       /* Old Mac '1.8' gamma and color space */
1268
#define PNG_GAMMA_sRGB   220000   /* Television standards--matches sRGB gamma */
1269
#define PNG_GAMMA_LINEAR PNG_FP_1 /* Linear */
1270
#endif
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286

/* The following are examples of calls to png_set_alpha_mode to achieve the
 * required overall gamma correction and, where necessary, alpha
 * premultiplication.
 *
 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
 *    This is the default libpng handling of the alpha channel - it is not
 *    pre-multiplied into the color components.  In addition the call states
 *    that the output is for a sRGB system and causes all PNG files without gAMA
 *    chunks to be assumed to be encoded using sRGB.
 *
 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
 *    In this case the output is assumed to be something like an sRGB conformant
 *    display preceeded by a power-law lookup table of power 1.45.  This is how
 *    early Mac systems behaved.
 *
1287
 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
 *    This is the classic Jim Blinn approach and will work in academic
 *    environments where everything is done by the book.  It has the shortcoming
 *    of assuming that input PNG data with no gamma information is linear - this
 *    is unlikely to be correct unless the PNG files where generated locally.
 *    Most of the time the output precision will be so low as to show
 *    significant banding in dark areas of the image.
 *
 * png_set_expand_16(pp);
 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB);
 *    This is a somewhat more realistic Jim Blinn inspired approach.  PNG files
 *    are assumed to have the sRGB encoding if not marked with a gamma value and
 *    the output is always 16 bits per component.  This permits accurate scaling
 *    and processing of the data.  If you know that your input PNG files were
 *    generated locally you might need to replace PNG_DEFAULT_sRGB with the
 *    correct value for your system.
 *
 * png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB);
 *    If you just need to composite the PNG image onto an existing background
 *    and if you control the code that does this you can use the optimization
 *    setting.  In this case you just copy completely opaque pixels to the
 *    output.  For pixels that are not completely transparent (you just skip
 *    those) you do the composition math using png_composite or png_composite_16
1310
 *    below then encode the resultant 8-bit or 16-bit values to match the output
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347
 *    encoding.
 *
 * Other cases
 *    If neither the PNG nor the standard linear encoding work for you because
 *    of the software or hardware you use then you have a big problem.  The PNG
 *    case will probably result in halos around the image.  The linear encoding
 *    will probably result in a washed out, too bright, image (it's actually too
 *    contrasty.)  Try the ALPHA_OPTIMIZED mode above - this will probably
 *    substantially reduce the halos.  Alternatively try:
 *
 * png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB);
 *    This option will also reduce the halos, but there will be slight dark
 *    halos round the opaque parts of the image where the background is light.
 *    In the OPTIMIZED mode the halos will be light halos where the background
 *    is dark.  Take your pick - the halos are unavoidable unless you can get
 *    your hardware/software fixed!  (The OPTIMIZED approach is slightly
 *    faster.)
 *
 * When the default gamma of PNG files doesn't match the output gamma.
 *    If you have PNG files with no gamma information png_set_alpha_mode allows
 *    you to provide a default gamma, but it also sets the ouput gamma to the
 *    matching value.  If you know your PNG files have a gamma that doesn't
 *    match the output you can take advantage of the fact that
 *    png_set_alpha_mode always sets the output gamma but only sets the PNG
 *    default if it is not already set:
 *
 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
 *    The first call sets both the default and the output gamma values, the
 *    second call overrides the output gamma without changing the default.  This
 *    is easier than achieving the same effect with png_set_gamma.  You must use
 *    PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will
 *    fire if more than one call to png_set_alpha_mode and png_set_background is
 *    made in the same read operation, however multiple calls with PNG_ALPHA_PNG
 *    are ignored.
 */

1348
#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
1349
PNG_EXPORT(36, void, png_set_strip_alpha, (png_structp png_ptr));
1350
#endif
G
Guy Schalnat 已提交
1351

A
Andreas Dilger 已提交
1352 1353
#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
1354
PNG_EXPORT(37, void, png_set_swap_alpha, (png_structp png_ptr));
1355
#endif
G
Guy Schalnat 已提交
1356

1357 1358
#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
1359
PNG_EXPORT(38, void, png_set_invert_alpha, (png_structp png_ptr));
1360
#endif
1361

A
Andreas Dilger 已提交
1362
#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
1363
/* Add a filler byte to 8-bit Gray or 24-bit RGB images. */
1364
PNG_EXPORT(39, void, png_set_filler, (png_structp png_ptr, png_uint_32 filler,
1365
    int flags));
A
Andreas Dilger 已提交
1366
/* The values of the PNG_FILLER_ defines should NOT be changed */
1367 1368
#  define PNG_FILLER_BEFORE 0
#  define PNG_FILLER_AFTER 1
1369
/* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */
1370
PNG_EXPORT(40, void, png_set_add_alpha,
1371
    (png_structp png_ptr, png_uint_32 filler,
1372
    int flags));
A
Andreas Dilger 已提交
1373
#endif /* PNG_READ_FILLER_SUPPORTED || PNG_WRITE_FILLER_SUPPORTED */
G
Guy Schalnat 已提交
1374

G
Guy Schalnat 已提交
1375
#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
1376
/* Swap bytes in 16-bit depth files. */
1377
PNG_EXPORT(41, void, png_set_swap, (png_structp png_ptr));
1378
#endif
G
Guy Schalnat 已提交
1379

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

1385 1386
#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
    defined(PNG_WRITE_PACKSWAP_SUPPORTED)
A
Andreas Dilger 已提交
1387
/* Swap packing order of pixels in bytes. */
1388
PNG_EXPORT(43, void, png_set_packswap, (png_structp png_ptr));
1389
#endif
G
Guy Schalnat 已提交
1390

G
Guy Schalnat 已提交
1391
#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
G
Guy Schalnat 已提交
1392
/* Converts files to legal bit depths. */
1393 1394
PNG_EXPORT(44, void, png_set_shift, (png_structp png_ptr, png_const_color_8p
    true_bits));
1395
#endif
G
Guy Schalnat 已提交
1396

G
Guy Schalnat 已提交
1397 1398
#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
    defined(PNG_WRITE_INTERLACING_SUPPORTED)
G
[devel]  
Glenn Randers-Pehrson 已提交
1399
/* Have the code handle the interlacing.  Returns the number of passes.
1400 1401 1402 1403 1404
 * 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.
*/
1405
PNG_EXPORT(45, int, png_set_interlace_handling, (png_structp png_ptr));
1406
#endif
G
Guy Schalnat 已提交
1407

G
Guy Schalnat 已提交
1408
#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
1409
/* Invert monochrome files */
1410
PNG_EXPORT(46, void, png_set_invert_mono, (png_structp png_ptr));
1411
#endif
G
Guy Schalnat 已提交
1412

1413
#ifdef PNG_READ_BACKGROUND_SUPPORTED
1414
/* Handle alpha and tRNS by replacing with a background color.  Prior to
1415
 * libpng-1.5.4 this API must not be called before the PNG file header has been
1416
 * read.  Doing so will result in unexpected behavior and possible warnings or
1417
 * errors if the PNG file contains a bKGD chunk.
1418
 */
1419 1420
PNG_FP_EXPORT(47, void, png_set_background, (png_structp png_ptr,
    png_const_color_16p background_color, int background_gamma_code,
1421
    int need_expand, double background_gamma));
1422
PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structp png_ptr,
1423
    png_const_color_16p background_color, int background_gamma_code,
1424
    int need_expand, png_fixed_point background_gamma));
G
[devel]  
Glenn Randers-Pehrson 已提交
1425 1426
#endif
#ifdef PNG_READ_BACKGROUND_SUPPORTED
1427 1428 1429 1430
#  define PNG_BACKGROUND_GAMMA_UNKNOWN 0
#  define PNG_BACKGROUND_GAMMA_SCREEN  1
#  define PNG_BACKGROUND_GAMMA_FILE    2
#  define PNG_BACKGROUND_GAMMA_UNIQUE  3
1431
#endif
G
Guy Schalnat 已提交
1432

1433
#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
1434
/* Scale a 16-bit depth file down to 8-bit, accurately. */
1435
PNG_EXPORT(229, void, png_set_scale_16, (png_structp png_ptr));
1436
#endif
1437

1438 1439
#ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED
#define PNG_READ_16_TO_8 SUPPORTED /* Name prior to 1.5.4 */
1440
/* Strip the second byte of information from a 16-bit depth file. */
1441
PNG_EXPORT(48, void, png_set_strip_16, (png_structp png_ptr));
1442
#endif
G
Guy Schalnat 已提交
1443

1444 1445
#ifdef PNG_READ_QUANTIZE_SUPPORTED
/* Turn on quantizing, and reduce the palette to the number of colors
1446 1447
 * available.
 */
1448
PNG_EXPORT(49, void, png_set_quantize,
1449 1450
    (png_structp png_ptr, png_colorp palette,
    int num_palette, int maximum_colors, png_const_uint_16p histogram,
1451
    int full_quantize));
1452
#endif
G
Guy Schalnat 已提交
1453

1454
#ifdef PNG_READ_GAMMA_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1455 1456 1457 1458 1459
/* 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)

1460
/* Handle gamma correction. Screen_gamma=(display_exponent).
1461
 * NOTE: this API simply sets the screen and file gamma values. It will
1462
 * therefore override the value for gamma in a PNG file if it is called after
1463 1464 1465 1466 1467 1468 1469
 * the file header has been read - use with care  - call before reading the PNG
 * file for best results!
 *
 * These routines accept the same gamma values as png_set_alpha_mode (described
 * above).  The PNG_GAMMA_ defines and PNG_DEFAULT_sRGB can be passed to either
 * API (floating point or fixed.)  Notice, however, that the 'file_gamma' value
 * is the inverse of a 'screen gamma' value.
1470
 */
1471
PNG_FP_EXPORT(50, void, png_set_gamma,
1472
    (png_structp png_ptr, double screen_gamma,
1473
    double override_file_gamma));
1474
PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structp png_ptr,
1475
    png_fixed_point screen_gamma, png_fixed_point override_file_gamma));
1476
#endif
G
Guy Schalnat 已提交
1477

1478
#ifdef PNG_WRITE_FLUSH_SUPPORTED
G
Guy Schalnat 已提交
1479
/* Set how many lines between output flushes - 0 for no flushing */
1480
PNG_EXPORT(51, void, png_set_flush, (png_structp png_ptr, int nrows));
G
Guy Schalnat 已提交
1481
/* Flush the current PNG output buffer */
1482
PNG_EXPORT(52, void, png_write_flush, (png_structp png_ptr));
1483
#endif
G
Guy Schalnat 已提交
1484

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

1488
/* Optional call to update the users info structure */
1489 1490
PNG_EXPORT(54, void, png_read_update_info,
    (png_structp png_ptr, png_infop info_ptr));
G
Guy Schalnat 已提交
1491

1492
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1493
/* Read one or more rows of image data. */
1494
PNG_EXPORT(55, void, png_read_rows, (png_structp png_ptr, png_bytepp row,
1495
    png_bytepp display_row, png_uint_32 num_rows));
1496
#endif
G
Guy Schalnat 已提交
1497

1498
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1499
/* Read a row of data. */
1500
PNG_EXPORT(56, void, png_read_row, (png_structp png_ptr, png_bytep row,
1501
    png_bytep display_row));
1502
#endif
G
Guy Schalnat 已提交
1503

1504
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1505
/* Read the whole image into memory at once. */
1506
PNG_EXPORT(57, void, png_read_image, (png_structp png_ptr, png_bytepp image));
1507
#endif
G
Guy Schalnat 已提交
1508

1509
/* Write a row of image data */
1510 1511
PNG_EXPORT(58, void, png_write_row,
    (png_structp png_ptr, png_const_bytep row));
G
Guy Schalnat 已提交
1512

1513 1514 1515
/* 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
1516 1517
 * unchanged to write_rows.
 */
1518
PNG_EXPORT(59, void, png_write_rows, (png_structp png_ptr, png_bytepp row,
1519
    png_uint_32 num_rows));
G
Guy Schalnat 已提交
1520

1521
/* Write the image data */
1522 1523
PNG_EXPORT(60, void, png_write_image,
    (png_structp png_ptr, png_bytepp image));
G
Guy Schalnat 已提交
1524

1525
/* Write the end of the PNG file. */
1526 1527
PNG_EXPORT(61, void, png_write_end,
    (png_structp png_ptr, png_infop info_ptr));
G
Guy Schalnat 已提交
1528

1529
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1530
/* Read the end of the PNG file. */
1531
PNG_EXPORT(62, void, png_read_end, (png_structp png_ptr, png_infop info_ptr));
1532
#endif
G
Guy Schalnat 已提交
1533

1534
/* Free any memory associated with the png_info_struct */
1535
PNG_EXPORT(63, void, png_destroy_info_struct, (png_structp png_ptr,
1536
    png_infopp info_ptr_ptr));
G
Guy Schalnat 已提交
1537

1538
/* Free any memory associated with the png_struct and the png_info_structs */
1539
PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr,
1540
    png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr));
G
Guy Schalnat 已提交
1541

1542
/* Free any memory associated with the png_struct and the png_info_structs */
1543
PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr,
1544
    png_infopp info_ptr_ptr));
G
Guy Schalnat 已提交
1545

1546
/* Set the libpng method of handling chunk CRC errors */
1547 1548
PNG_EXPORT(66, void, png_set_crc_action,
    (png_structp png_ptr, int crit_action, int ancil_action));
A
Andreas Dilger 已提交
1549

1550
/* Values for png_set_crc_action() say how to handle CRC errors in
A
Andreas Dilger 已提交
1551 1552
 * ancillary and critical chunks, and whether to use the data contained
 * therein.  Note that it is impossible to "discard" data in a critical
1553
 * chunk.  For versions prior to 0.90, the action was always error/quit,
A
Andreas Dilger 已提交
1554 1555 1556 1557
 * 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 已提交
1558 1559 1560 1561 1562 1563 1564 1565
 */
#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 已提交
1566 1567 1568 1569 1570
/* 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
1571 1572
 * header file (zlib.h) for an explination of the compression functions.
 */
A
Andreas Dilger 已提交
1573

1574
/* Set the filtering method(s) used by libpng.  Currently, the only valid
1575 1576
 * value for "method" is 0.
 */
1577 1578
PNG_EXPORT(67, void, png_set_filter,
    (png_structp png_ptr, int method, int filters));
G
Guy Schalnat 已提交
1579

A
Andreas Dilger 已提交
1580
/* Flags for png_set_filter() to say which filters to use.  The flags
A
Andreas Dilger 已提交
1581 1582 1583
 * 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 已提交
1584 1585 1586 1587 1588 1589 1590 1591 1592 1593
 */
#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 已提交
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
/* 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

1604
#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */
A
Andreas Dilger 已提交
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632
/* 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.
 */
1633 1634
PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structp png_ptr,
    int heuristic_method, int num_weights, png_const_doublep filter_weights,
1635 1636
    png_const_doublep filter_costs));
PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed,
1637
    (png_structp png_ptr,
1638
    int heuristic_method, int num_weights, png_const_fixed_point_p
1639
    filter_weights, png_const_fixed_point_p filter_costs));
A
Andreas Dilger 已提交
1640 1641 1642 1643 1644 1645 1646 1647 1648 1649
#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 */

1650
#ifdef PNG_WRITE_SUPPORTED
A
Andreas Dilger 已提交
1651 1652 1653 1654
/* 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
1655
 * for PNG images, and do considerably fewer caclulations.  In the future,
A
Andreas Dilger 已提交
1656 1657
 * these values may not correspond directly to the zlib compression levels.
 */
1658 1659
PNG_EXPORT(69, void, png_set_compression_level,
    (png_structp png_ptr, int level));
G
Guy Schalnat 已提交
1660

1661
PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structp png_ptr,
1662
    int mem_level));
G
Guy Schalnat 已提交
1663

1664
PNG_EXPORT(71, void, png_set_compression_strategy, (png_structp png_ptr,
1665
    int strategy));
G
Guy Schalnat 已提交
1666

1667 1668 1669
/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
 * smaller value of window_bits if it can do so safely.
 */
1670
PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structp png_ptr,
1671
    int window_bits));
G
Guy Schalnat 已提交
1672

1673 1674
PNG_EXPORT(73, void, png_set_compression_method, (png_structp png_ptr,
    int method));
1675
#endif
G
Guy Schalnat 已提交
1676

1677
#ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED
1678 1679 1680 1681 1682 1683 1684 1685 1686 1687
/* Also set zlib parameters for compressing non-IDAT chunks */
PNG_EXPORT(222, void, png_set_text_compression_level,
    (png_structp png_ptr, int level));

PNG_EXPORT(223, void, png_set_text_compression_mem_level, (png_structp png_ptr,
    int mem_level));

PNG_EXPORT(224, void, png_set_text_compression_strategy, (png_structp png_ptr,
    int strategy));

1688 1689 1690
/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
 * smaller value of window_bits if it can do so safely.
 */
1691 1692 1693 1694 1695
PNG_EXPORT(225, void, png_set_text_compression_window_bits, (png_structp
    png_ptr, int window_bits));

PNG_EXPORT(226, void, png_set_text_compression_method, (png_structp png_ptr,
    int method));
1696
#endif /* PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED */
1697

G
Guy Schalnat 已提交
1698
/* These next functions are called for input/output, memory, and error
1699
 * handling.  They are in the file pngrio.c, pngwio.c, and pngerror.c,
A
Andreas Dilger 已提交
1700 1701 1702
 * 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
1703
 * different manner by calling png_set_???_fn().  See libpng-manual.txt for
A
Andreas Dilger 已提交
1704 1705
 * more information.
 */
G
Guy Schalnat 已提交
1706

1707
#ifdef PNG_STDIO_SUPPORTED
A
Andreas Dilger 已提交
1708
/* Initialize the input/output for the PNG file to the default functions. */
1709
PNG_EXPORT(74, void, png_init_io, (png_structp png_ptr, png_FILE_p fp));
1710
#endif
G
Guy Schalnat 已提交
1711

A
Andreas Dilger 已提交
1712
/* Replace the (error and abort), and warning functions with user
A
Andreas Dilger 已提交
1713 1714 1715 1716 1717 1718
 * 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.
 */
1719

1720
PNG_EXPORT(75, void, png_set_error_fn,
1721
    (png_structp png_ptr, png_voidp error_ptr,
1722
    png_error_ptr error_fn, png_error_ptr warning_fn));
G
Guy Schalnat 已提交
1723

G
Guy Schalnat 已提交
1724
/* Return the user pointer associated with the error functions */
1725
PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structp png_ptr));
G
Guy Schalnat 已提交
1726 1727

/* Replace the default data output functions with a user supplied one(s).
A
Andreas Dilger 已提交
1728 1729 1730
 * 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).
1731 1732 1733 1734 1735
 * 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 已提交
1736
 */
1737
PNG_EXPORT(77, void, png_set_write_fn, (png_structp png_ptr, png_voidp io_ptr,
1738
    png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn));
G
Guy Schalnat 已提交
1739 1740

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

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

1747
PNG_EXPORT(80, void, png_set_read_status_fn, (png_structp png_ptr,
1748
    png_read_status_ptr read_row_fn));
1749

1750
PNG_EXPORT(81, void, png_set_write_status_fn, (png_structp png_ptr,
1751
    png_write_status_ptr write_row_fn));
1752

1753 1754
#ifdef PNG_USER_MEM_SUPPORTED
/* Replace the default memory allocation functions with user supplied one(s). */
1755
PNG_EXPORT(82, void, png_set_mem_fn, (png_structp png_ptr, png_voidp mem_ptr,
1756
    png_malloc_ptr malloc_fn, png_free_ptr free_fn));
1757
/* Return the user pointer associated with the memory functions */
1758
PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structp png_ptr));
1759
#endif
1760

1761
#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
1762
PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structp png_ptr,
1763
    png_user_transform_ptr read_user_transform_fn));
1764 1765
#endif

1766
#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
1767
PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structp png_ptr,
1768
    png_user_transform_ptr write_user_transform_fn));
1769 1770
#endif

1771
#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED
1772 1773
PNG_EXPORT(86, void, png_set_user_transform_info, (png_structp png_ptr,
    png_voidp user_transform_ptr, int user_transform_depth,
1774
    int user_transform_channels));
1775
/* Return the user pointer associated with the user transform functions */
1776
PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr,
1777 1778 1779 1780 1781 1782 1783
    (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
1784 1785 1786
 * row number is the row number within the sub-image of the interlace pass, so
 * the value will increase to the height of the sub-image (not the full image)
 * then reset to 0 for the next pass.
1787
 *
1788 1789 1790
 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
 * find the output pixel (x,y) given an interlaced sub-image pixel
 * (row,col,pass).  (See below for these macros.)
1791 1792 1793
 */
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));
1794 1795
#endif

1796
#ifdef PNG_USER_CHUNKS_SUPPORTED
1797
PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structp png_ptr,
1798
    png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn));
1799
PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structp png_ptr));
1800 1801
#endif

G
Guy Schalnat 已提交
1802
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
A
Andreas Dilger 已提交
1803 1804 1805
/* Sets the function callbacks for the push reader, and a pointer to a
 * user-defined structure available to the callback functions.
 */
1806 1807
PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structp png_ptr,
    png_voidp progressive_ptr, png_progressive_info_ptr info_fn,
1808
    png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn));
G
Guy Schalnat 已提交
1809

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

1813
/* Function to be called when data becomes available */
1814
PNG_EXPORT(92, void, png_process_data,
1815
    (png_structp png_ptr, png_infop info_ptr,
1816
    png_bytep buffer, png_size_t buffer_size));
A
Andreas Dilger 已提交
1817

1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834
/* 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));

1835
#ifdef PNG_READ_INTERLACING_SUPPORTED
1836 1837 1838 1839
/* 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 已提交
1840
 */
1841
PNG_EXPORT(93, void, png_progressive_combine_row, (png_structp png_ptr,
1842
    png_bytep old_row, png_const_bytep new_row));
1843
#endif /* PNG_READ_INTERLACING_SUPPORTED */
G
Guy Schalnat 已提交
1844
#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */
G
Guy Schalnat 已提交
1845

1846
PNG_EXPORTA(94, png_voidp, png_malloc,
1847
    (png_structp png_ptr, png_alloc_size_t size),
1848
    PNG_ALLOCATED);
1849
/* Added at libpng version 1.4.0 */
1850
PNG_EXPORTA(95, png_voidp, png_calloc,
1851
    (png_structp png_ptr, png_alloc_size_t size),
1852
    PNG_ALLOCATED);
G
Guy Schalnat 已提交
1853

1854
/* Added at libpng version 1.2.4 */
1855
PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_structp png_ptr,
1856
    png_alloc_size_t size), PNG_ALLOCATED);
1857

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

1861
/* Free data that was allocated internally */
1862 1863 1864
PNG_EXPORT(98, void, png_free_data,
    (png_structp png_ptr, png_infop info_ptr, png_uint_32 free_me, int num));

1865 1866
/* Reassign responsibility for freeing existing data, whether allocated
 * by libpng or by the application */
1867 1868 1869
PNG_EXPORT(99, void, png_data_freer,
    (png_structp png_ptr, png_infop info_ptr, int freer, png_uint_32 mask));

1870
/* Assignments for png_data_freer */
1871 1872 1873 1874
#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 */
1875 1876 1877 1878
#define PNG_FREE_HIST 0x0008
#define PNG_FREE_ICCP 0x0010
#define PNG_FREE_SPLT 0x0020
#define PNG_FREE_ROWS 0x0040
1879 1880
#define PNG_FREE_PCAL 0x0080
#define PNG_FREE_SCAL 0x0100
1881 1882
#define PNG_FREE_UNKN 0x0200
#define PNG_FREE_LIST 0x0400
1883 1884 1885
#define PNG_FREE_PLTE 0x1000
#define PNG_FREE_TRNS 0x2000
#define PNG_FREE_TEXT 0x4000
1886
#define PNG_FREE_ALL  0x7fff
1887
#define PNG_FREE_MUL  0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
1888

1889
#ifdef PNG_USER_MEM_SUPPORTED
1890
PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_structp png_ptr,
1891 1892
    png_alloc_size_t size), PNG_ALLOCATED);
PNG_EXPORT(101, void, png_free_default, (png_structp png_ptr, png_voidp ptr));
1893
#endif
1894

1895
#ifdef PNG_ERROR_TEXT_SUPPORTED
A
Andreas Dilger 已提交
1896
/* Fatal error in PNG image of libpng - can't continue */
1897
PNG_EXPORTA(102, void, png_error,
1898
    (png_structp png_ptr, png_const_charp error_message),
1899
    PNG_NORETURN);
G
Guy Schalnat 已提交
1900

1901
/* The same, but the chunk name is prepended to the error string. */
1902
PNG_EXPORTA(103, void, png_chunk_error, (png_structp png_ptr,
1903
    png_const_charp error_message), PNG_NORETURN);
1904

1905 1906
#else
/* Fatal error in PNG image of libpng - can't continue */
1907
PNG_EXPORTA(104, void, png_err, (png_structp png_ptr), PNG_NORETURN);
1908 1909
#endif

1910
#ifdef PNG_WARNINGS_SUPPORTED
G
Guy Schalnat 已提交
1911
/* Non-fatal error in libpng.  Can continue, but may have a problem. */
1912
PNG_EXPORT(105, void, png_warning, (png_structp png_ptr,
1913
    png_const_charp warning_message));
A
Andreas Dilger 已提交
1914

1915
/* Non-fatal error in libpng, chunk name is prepended to message. */
1916
PNG_EXPORT(106, void, png_chunk_warning, (png_structp png_ptr,
1917
    png_const_charp warning_message));
1918
#endif
1919

1920 1921 1922
#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. */
1923
#  undef png_benign_error
1924
PNG_EXPORT(107, void, png_benign_error, (png_structp png_ptr,
1925
    png_const_charp warning_message));
1926 1927

/* Same, chunk name is prepended to message. */
1928
#  undef png_chunk_benign_error
1929
PNG_EXPORT(108, void, png_chunk_benign_error, (png_structp png_ptr,
1930
    png_const_charp warning_message));
1931

1932 1933
PNG_EXPORT(109, void, png_set_benign_errors,
    (png_structp png_ptr, int allowed));
1934 1935 1936 1937 1938 1939 1940 1941
#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
1942 1943
#endif

A
Andreas Dilger 已提交
1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955
/* 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.
 */
1956
/* Returns "flag" if chunk data is valid in info_ptr. */
1957
PNG_EXPORT(110, png_uint_32, png_get_valid,
1958
    (png_const_structp png_ptr, png_const_infop info_ptr,
1959
    png_uint_32 flag));
A
Andreas Dilger 已提交
1960

1961
/* Returns number of bytes needed to hold a transformed row. */
1962
PNG_EXPORT(111, png_size_t, png_get_rowbytes, (png_const_structp png_ptr,
1963
    png_const_infop info_ptr));
A
Andreas Dilger 已提交
1964

1965
#ifdef PNG_INFO_IMAGE_SUPPORTED
1966
/* Returns row_pointers, which is an array of pointers to scanlines that was
1967 1968
 * returned from png_read_png().
 */
1969
PNG_EXPORT(112, png_bytepp, png_get_rows,
1970
    (png_const_structp png_ptr, png_const_infop info_ptr));
1971
/* Set row_pointers, which is an array of pointers to scanlines for use
1972 1973
 * by png_write_png().
 */
1974 1975
PNG_EXPORT(113, void, png_set_rows, (png_structp png_ptr,
    png_infop info_ptr, png_bytepp row_pointers));
1976 1977
#endif

1978
/* Returns number of color channels in image. */
1979
PNG_EXPORT(114, png_byte, png_get_channels,
1980
    (png_const_structp png_ptr, png_const_infop info_ptr));
A
Andreas Dilger 已提交
1981

1982 1983
#ifdef PNG_EASY_ACCESS_SUPPORTED
/* Returns image width in pixels. */
1984
PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structp png_ptr,
1985
    png_const_infop info_ptr));
1986 1987

/* Returns image height in pixels. */
1988
PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structp png_ptr,
1989
    png_const_infop info_ptr));
1990 1991

/* Returns image bit_depth. */
1992
PNG_EXPORT(117, png_byte, png_get_bit_depth,
1993
    (png_const_structp png_ptr, png_const_infop info_ptr));
1994 1995

/* Returns image color_type. */
1996
PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structp png_ptr,
1997
    png_const_infop info_ptr));
1998 1999

/* Returns image filter_type. */
2000
PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structp png_ptr,
2001
    png_const_infop info_ptr));
2002 2003

/* Returns image interlace_type. */
2004
PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structp png_ptr,
2005
    png_const_infop info_ptr));
2006 2007

/* Returns image compression_type. */
2008
PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structp png_ptr,
2009
    png_const_infop info_ptr));
2010 2011

/* Returns image resolution in pixels per meter, from pHYs chunk data. */
2012
PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter,
2013
    (png_const_structp png_ptr, png_const_infop info_ptr));
2014
PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter,
2015
    (png_const_structp png_ptr, png_const_infop info_ptr));
2016
PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter,
2017
    (png_const_structp png_ptr, png_const_infop info_ptr));
2018 2019

/* Returns pixel aspect ratio, computed from pHYs chunk data.  */
2020
PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio,
2021
    (png_const_structp png_ptr, png_const_infop info_ptr));
2022
PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed,
2023
    (png_const_structp png_ptr, png_const_infop info_ptr));
2024 2025

/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
2026
PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels,
2027
    (png_const_structp png_ptr, png_const_infop info_ptr));
2028
PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels,
2029
    (png_const_structp png_ptr, png_const_infop info_ptr));
2030
PNG_EXPORT(128, png_int_32, png_get_x_offset_microns,
2031
    (png_const_structp png_ptr, png_const_infop info_ptr));
2032
PNG_EXPORT(129, png_int_32, png_get_y_offset_microns,
2033
    (png_const_structp png_ptr, png_const_infop info_ptr));
2034 2035 2036

#endif /* PNG_EASY_ACCESS_SUPPORTED */

A
Andreas Dilger 已提交
2037
/* Returns pointer to signature string read from PNG header */
2038
PNG_EXPORT(130, png_const_bytep, png_get_signature,
2039
    (png_const_structp png_ptr, png_infop info_ptr));
A
Andreas Dilger 已提交
2040

2041
#ifdef PNG_bKGD_SUPPORTED
2042
PNG_EXPORT(131, png_uint_32, png_get_bKGD,
2043
    (png_const_structp png_ptr, png_infop info_ptr,
2044
    png_color_16p *background));
2045
#endif
A
Andreas Dilger 已提交
2046

2047
#ifdef PNG_bKGD_SUPPORTED
2048
PNG_EXPORT(132, void, png_set_bKGD, (png_structp png_ptr, png_infop info_ptr,
2049
    png_const_color_16p background));
2050
#endif
A
Andreas Dilger 已提交
2051

2052
#ifdef PNG_cHRM_SUPPORTED
2053 2054 2055
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,
    double *red_y, double *green_x, double *green_y, double *blue_x,
2056
    double *blue_y));
2057 2058 2059 2060
PNG_FP_EXPORT(230, png_uint_32, png_get_cHRM_XYZ, (png_structp png_ptr,
    png_const_infop info_ptr, double *red_X, double *red_Y, double *red_Z,
    double *green_X, double *green_Y, double *green_Z, double *blue_X,
    double *blue_Y, double *blue_Z));
G
[devel]  
Glenn Randers-Pehrson 已提交
2061
#ifdef PNG_FIXED_POINT_SUPPORTED /* Otherwise not implemented */
2062
PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed,
2063 2064 2065 2066 2067
    (png_const_structp png_ptr,
    png_const_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,
2068
    png_fixed_point *int_blue_y));
G
[devel]  
Glenn Randers-Pehrson 已提交
2069
#endif
2070 2071 2072 2073 2074 2075 2076
PNG_FIXED_EXPORT(231, png_uint_32, png_get_cHRM_XYZ_fixed,
    (png_structp png_ptr, png_const_infop info_ptr,
    png_fixed_point *int_red_X, png_fixed_point *int_red_Y,
    png_fixed_point *int_red_Z, png_fixed_point *int_green_X,
    png_fixed_point *int_green_Y, png_fixed_point *int_green_Z,
    png_fixed_point *int_blue_X, png_fixed_point *int_blue_Y,
    png_fixed_point *int_blue_Z));
2077
#endif
A
Andreas Dilger 已提交
2078

2079
#ifdef PNG_cHRM_SUPPORTED
2080
PNG_FP_EXPORT(135, void, png_set_cHRM,
2081 2082
    (png_structp png_ptr, png_infop info_ptr,
    double white_x, double white_y, double red_x, double red_y, double green_x,
2083
    double green_y, double blue_x, double blue_y));
2084 2085 2086 2087
PNG_FP_EXPORT(232, void, png_set_cHRM_XYZ, (png_structp png_ptr,
    png_infop info_ptr, double red_X, double red_Y, double red_Z,
    double green_X, double green_Y, double green_Z, double blue_X,
    double blue_Y, double blue_Z));
2088 2089 2090 2091 2092
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,
2093
    png_fixed_point int_blue_y));
2094 2095 2096 2097 2098 2099
PNG_FIXED_EXPORT(233, void, png_set_cHRM_XYZ_fixed, (png_structp png_ptr,
    png_infop info_ptr, png_fixed_point int_red_X, png_fixed_point int_red_Y,
    png_fixed_point int_red_Z, png_fixed_point int_green_X,
    png_fixed_point int_green_Y, png_fixed_point int_green_Z,
    png_fixed_point int_blue_X, png_fixed_point int_blue_Y,
    png_fixed_point int_blue_Z));
2100
#endif
A
Andreas Dilger 已提交
2101

2102
#ifdef PNG_gAMA_SUPPORTED
2103
PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA,
2104
    (png_const_structp png_ptr, png_const_infop info_ptr,
2105
    double *file_gamma));
2106
PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed,
2107
    (png_const_structp png_ptr, png_const_infop info_ptr,
2108
    png_fixed_point *int_file_gamma));
2109
#endif
G
Guy Schalnat 已提交
2110

2111
#ifdef PNG_gAMA_SUPPORTED
2112 2113
PNG_FP_EXPORT(139, void, png_set_gAMA, (png_structp png_ptr,
    png_infop info_ptr, double file_gamma));
2114
PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_structp png_ptr,
2115
    png_infop info_ptr, png_fixed_point int_file_gamma));
2116
#endif
A
Andreas Dilger 已提交
2117

2118
#ifdef PNG_hIST_SUPPORTED
2119
PNG_EXPORT(141, png_uint_32, png_get_hIST,
2120
    (png_const_structp png_ptr, png_const_infop info_ptr,
2121
    png_uint_16p *hist));
2122
#endif
A
Andreas Dilger 已提交
2123

2124
#ifdef PNG_hIST_SUPPORTED
2125 2126
PNG_EXPORT(142, void, png_set_hIST, (png_structp png_ptr,
    png_infop info_ptr, png_const_uint_16p hist));
2127
#endif
A
Andreas Dilger 已提交
2128

2129
PNG_EXPORT(143, png_uint_32, png_get_IHDR,
2130 2131
    (png_structp png_ptr, png_infop info_ptr,
    png_uint_32 *width, png_uint_32 *height, int *bit_depth, int *color_type,
2132
    int *interlace_method, int *compression_method, int *filter_method));
2133

2134
PNG_EXPORT(144, void, png_set_IHDR,
2135 2136
    (png_structp png_ptr, png_infop info_ptr,
    png_uint_32 width, png_uint_32 height, int bit_depth, int color_type,
2137
    int interlace_method, int compression_method, int filter_method));
A
Andreas Dilger 已提交
2138

2139
#ifdef PNG_oFFs_SUPPORTED
2140
PNG_EXPORT(145, png_uint_32, png_get_oFFs,
2141
    (png_const_structp png_ptr, png_const_infop info_ptr,
2142
    png_int_32 *offset_x, png_int_32 *offset_y, int *unit_type));
2143
#endif
A
Andreas Dilger 已提交
2144

2145
#ifdef PNG_oFFs_SUPPORTED
2146
PNG_EXPORT(146, void, png_set_oFFs,
2147
    (png_structp png_ptr, png_infop info_ptr,
2148
    png_int_32 offset_x, png_int_32 offset_y, int unit_type));
2149
#endif
A
Andreas Dilger 已提交
2150

2151
#ifdef PNG_pCAL_SUPPORTED
2152
PNG_EXPORT(147, png_uint_32, png_get_pCAL,
2153
    (png_const_structp png_ptr, png_const_infop info_ptr,
2154
    png_charp *purpose, png_int_32 *X0, png_int_32 *X1, int *type,
2155
    int *nparams,
2156
    png_charp *units, png_charpp *params));
2157
#endif
A
Andreas Dilger 已提交
2158

2159
#ifdef PNG_pCAL_SUPPORTED
2160
PNG_EXPORT(148, void, png_set_pCAL, (png_structp png_ptr,
2161 2162
    png_infop info_ptr,
    png_const_charp purpose, png_int_32 X0, png_int_32 X1, int type,
2163
    int nparams, png_const_charp units, png_charpp params));
2164 2165
#endif

2166
#ifdef PNG_pHYs_SUPPORTED
2167
PNG_EXPORT(149, png_uint_32, png_get_pHYs,
2168
    (png_const_structp png_ptr, png_const_infop info_ptr,
2169
    png_uint_32 *res_x, png_uint_32 *res_y, int *unit_type));
2170
#endif
A
Andreas Dilger 已提交
2171

2172
#ifdef PNG_pHYs_SUPPORTED
2173
PNG_EXPORT(150, void, png_set_pHYs,
2174
    (png_structp png_ptr, png_infop info_ptr,
2175
    png_uint_32 res_x, png_uint_32 res_y, int unit_type));
2176
#endif
A
Andreas Dilger 已提交
2177

2178
PNG_EXPORT(151, png_uint_32, png_get_PLTE,
2179
    (png_const_structp png_ptr, png_const_infop info_ptr,
2180
    png_colorp *palette, int *num_palette));
A
Andreas Dilger 已提交
2181

2182
PNG_EXPORT(152, void, png_set_PLTE,
2183
    (png_structp png_ptr, png_infop info_ptr,
2184
    png_const_colorp palette, int num_palette));
A
Andreas Dilger 已提交
2185

2186
#ifdef PNG_sBIT_SUPPORTED
2187
PNG_EXPORT(153, png_uint_32, png_get_sBIT,
2188
    (png_const_structp png_ptr, png_infop info_ptr,
2189
    png_color_8p *sig_bit));
2190
#endif
A
Andreas Dilger 已提交
2191

2192
#ifdef PNG_sBIT_SUPPORTED
2193 2194
PNG_EXPORT(154, void, png_set_sBIT,
    (png_structp png_ptr, png_infop info_ptr, png_const_color_8p sig_bit));
2195
#endif
A
Andreas Dilger 已提交
2196

2197
#ifdef PNG_sRGB_SUPPORTED
2198
PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structp png_ptr,
2199
    png_const_infop info_ptr, int *file_srgb_intent));
2200
#endif
2201

2202
#ifdef PNG_sRGB_SUPPORTED
2203
PNG_EXPORT(156, void, png_set_sRGB,
2204
    (png_structp png_ptr, png_infop info_ptr, int srgb_intent));
2205
PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_structp png_ptr,
2206
    png_infop info_ptr, int srgb_intent));
2207 2208
#endif

2209
#ifdef PNG_iCCP_SUPPORTED
2210
PNG_EXPORT(158, png_uint_32, png_get_iCCP,
2211 2212
    (png_const_structp png_ptr, png_const_infop info_ptr,
    png_charpp name, int *compression_type, png_bytepp profile,
2213
    png_uint_32 *proflen));
2214 2215
#endif

2216
#ifdef PNG_iCCP_SUPPORTED
2217
PNG_EXPORT(159, void, png_set_iCCP,
2218 2219
    (png_structp png_ptr, png_infop info_ptr,
    png_const_charp name, int compression_type, png_const_bytep profile,
2220
    png_uint_32 proflen));
2221 2222
#endif

2223
#ifdef PNG_sPLT_SUPPORTED
2224
PNG_EXPORT(160, png_uint_32, png_get_sPLT,
2225
    (png_const_structp png_ptr, png_const_infop info_ptr,
2226
    png_sPLT_tpp entries));
2227 2228
#endif

2229
#ifdef PNG_sPLT_SUPPORTED
2230
PNG_EXPORT(161, void, png_set_sPLT,
2231
    (png_structp png_ptr, png_infop info_ptr,
2232
    png_const_sPLT_tp entries, int nentries));
2233 2234
#endif

2235
#ifdef PNG_TEXT_SUPPORTED
2236
/* png_get_text also returns the number of text chunks in *num_text */
2237
PNG_EXPORT(162, png_uint_32, png_get_text,
2238
    (png_const_structp png_ptr, png_const_infop info_ptr,
2239
    png_textp *text_ptr, int *num_text));
2240
#endif
A
Andreas Dilger 已提交
2241

2242
/* Note while png_set_text() will accept a structure whose text,
2243 2244 2245 2246
 * 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.
2247 2248
 */

2249
#ifdef PNG_TEXT_SUPPORTED
2250
PNG_EXPORT(163, void, png_set_text,
2251
    (png_structp png_ptr, png_infop info_ptr,
2252
    png_const_textp text_ptr, int num_text));
2253
#endif
A
Andreas Dilger 已提交
2254

2255
#ifdef PNG_tIME_SUPPORTED
2256
PNG_EXPORT(164, png_uint_32, png_get_tIME,
2257
    (png_const_structp png_ptr, png_infop info_ptr, png_timep *mod_time));
2258
#endif
A
Andreas Dilger 已提交
2259

2260
#ifdef PNG_tIME_SUPPORTED
2261 2262
PNG_EXPORT(165, void, png_set_tIME,
    (png_structp png_ptr, png_infop info_ptr, png_const_timep mod_time));
2263
#endif
A
Andreas Dilger 已提交
2264

2265
#ifdef PNG_tRNS_SUPPORTED
2266
PNG_EXPORT(166, png_uint_32, png_get_tRNS,
2267
    (png_const_structp png_ptr, png_infop info_ptr,
2268
    png_bytep *trans_alpha, int *num_trans, png_color_16p *trans_color));
2269 2270
#endif

2271
#ifdef PNG_tRNS_SUPPORTED
2272
PNG_EXPORT(167, void, png_set_tRNS,
2273 2274
    (png_structp png_ptr, png_infop info_ptr,
    png_const_bytep trans_alpha, int num_trans,
2275
    png_const_color_16p trans_color));
2276 2277
#endif

2278
#ifdef PNG_sCAL_SUPPORTED
2279
PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL,
2280
    (png_const_structp png_ptr, png_const_infop info_ptr,
2281
    int *unit, double *width, double *height));
2282
#ifdef PNG_FLOATING_ARITHMETIC_SUPPORTED
2283
/* NOTE: this API is currently implemented using floating point arithmetic,
2284 2285 2286 2287
 * 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.
 */
2288
PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed,
2289
    (png_structp png_ptr, png_const_infop info_ptr, int *unit,
2290
    png_fixed_point *width,
2291 2292 2293
    png_fixed_point *height));
#endif
PNG_EXPORT(169, png_uint_32, png_get_sCAL_s,
2294
    (png_const_structp png_ptr, png_const_infop info_ptr,
2295
    int *unit, png_charpp swidth, png_charpp sheight));
2296 2297

PNG_FP_EXPORT(170, void, png_set_sCAL,
2298
    (png_structp png_ptr, png_infop info_ptr,
2299
    int unit, double width, double height));
2300 2301
PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_structp png_ptr,
   png_infop info_ptr, int unit, png_fixed_point width,
2302 2303
   png_fixed_point height));
PNG_EXPORT(171, void, png_set_sCAL_s,
2304
    (png_structp png_ptr, png_infop info_ptr,
2305
    int unit, png_const_charp swidth, png_const_charp sheight));
2306
#endif /* PNG_sCAL_SUPPORTED */
2307

2308 2309
#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
/* Provide a list of chunks and how they are to be handled, if the built-in
2310 2311
   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
2312 2313 2314 2315 2316 2317 2318
   must not be listed.  Because this turns off the default handling for chunks
   that would otherwise be recognized the behavior of libpng transformations may
   well become incorrect!
      keep = 0: PNG_HANDLE_CHUNK_AS_DEFAULT: follow default behavior
           = 1: PNG_HANDLE_CHUNK_NEVER:      do not keep
           = 2: PNG_HANDLE_CHUNK_IF_SAFE:    keep only if safe-to-copy
           = 3: PNG_HANDLE_CHUNK_ALWAYS:     keep even if unsafe-to-copy
2319
*/
2320
PNG_EXPORT(172, void, png_set_keep_unknown_chunks,
2321
    (png_structp png_ptr, int keep,
2322
    png_const_bytep chunk_list, int num_chunks));
2323 2324 2325 2326

/* The handling code is returned; the result is therefore true (non-zero) if
 * special handling is required, false for the default handling.
 */
2327
PNG_EXPORT(173, int, png_handle_as_unknown, (png_structp png_ptr,
2328
    png_const_bytep chunk_name));
2329
#endif
2330
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
2331
PNG_EXPORT(174, void, png_set_unknown_chunks, (png_structp png_ptr,
2332 2333 2334 2335
    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));
2336
PNG_EXPORT(176, int, png_get_unknown_chunks, (png_const_structp png_ptr,
2337
    png_const_infop info_ptr, png_unknown_chunkpp entries));
2338 2339
#endif

2340
/* Png_free_data() will turn off the "valid" flag for anything it frees.
2341
 * If you need to turn it off for a chunk that your application has freed,
2342 2343
 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
 */
2344 2345
PNG_EXPORT(177, void, png_set_invalid,
    (png_structp png_ptr, png_infop info_ptr, int mask));
2346

2347
#ifdef PNG_INFO_IMAGE_SUPPORTED
2348
/* The "params" pointer is currently not used and is for future expansion. */
2349
PNG_EXPORT(178, void, png_read_png, (png_structp png_ptr, png_infop info_ptr,
2350
    int transforms, png_voidp params));
2351
PNG_EXPORT(179, void, png_write_png, (png_structp png_ptr, png_infop info_ptr,
2352
    int transforms, png_voidp params));
2353 2354
#endif

2355
PNG_EXPORT(180, png_const_charp, png_get_copyright,
2356
    (png_const_structp png_ptr));
2357
PNG_EXPORT(181, png_const_charp, png_get_header_ver,
2358
    (png_const_structp png_ptr));
2359
PNG_EXPORT(182, png_const_charp, png_get_header_version,
2360
    (png_const_structp png_ptr));
2361
PNG_EXPORT(183, png_const_charp, png_get_libpng_ver,
2362
    (png_const_structp png_ptr));
2363

2364
#ifdef PNG_MNG_FEATURES_SUPPORTED
2365
PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structp png_ptr,
2366
    png_uint_32 mng_features_permitted));
2367 2368
#endif

2369 2370 2371 2372 2373 2374
/* 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

2375
/* Strip the prepended error numbers ("#nnn ") from error and warning
2376 2377
 * messages before passing them to the error or warning handler.
 */
2378
#ifdef PNG_ERROR_NUMBERS_SUPPORTED
2379
PNG_EXPORT(185, void, png_set_strip_error_numbers,
2380
    (png_structp png_ptr,
2381
    png_uint_32 strip_mode));
2382
#endif
2383

2384
/* Added in libpng-1.2.6 */
2385
#ifdef PNG_SET_USER_LIMITS_SUPPORTED
2386
PNG_EXPORT(186, void, png_set_user_limits, (png_structp png_ptr,
2387
    png_uint_32 user_width_max, png_uint_32 user_height_max));
2388
PNG_EXPORT(187, png_uint_32, png_get_user_width_max,
2389
    (png_const_structp png_ptr));
2390
PNG_EXPORT(188, png_uint_32, png_get_user_height_max,
2391
    (png_const_structp png_ptr));
2392
/* Added in libpng-1.4.0 */
2393
PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structp png_ptr,
2394
    png_uint_32 user_chunk_cache_max));
2395
PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max,
2396
    (png_const_structp png_ptr));
2397
/* Added in libpng-1.4.1 */
2398
PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structp png_ptr,
2399 2400
    png_alloc_size_t user_chunk_cache_max));
PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max,
2401
    (png_const_structp png_ptr));
2402 2403
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
2404
#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
2405
PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch,
2406
    (png_const_structp png_ptr, png_const_infop info_ptr));
2407

2408
PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch,
2409
    (png_const_structp png_ptr, png_const_infop info_ptr));
2410

2411
PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch,
2412
    (png_const_structp png_ptr, png_const_infop info_ptr));
2413

2414
PNG_FP_EXPORT(196, float, png_get_x_offset_inches,
2415
    (png_const_structp png_ptr, png_const_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2416
#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2417
PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed,
2418
    (png_structp png_ptr, png_const_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2419
#endif
2420

2421
PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_const_structp png_ptr,
2422
    png_const_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2423
#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2424
PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed,
2425
    (png_structp png_ptr, png_const_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2426
#endif
2427

2428
#  ifdef PNG_pHYs_SUPPORTED
2429
PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structp png_ptr,
2430
    png_const_infop info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
2431
    int *unit_type));
2432
#  endif /* PNG_pHYs_SUPPORTED */
G
[devel]  
Glenn Randers-Pehrson 已提交
2433
#endif  /* PNG_INCH_CONVERSIONS_SUPPORTED */
2434

2435 2436
/* Added in libpng-1.4.0 */
#ifdef PNG_IO_STATE_SUPPORTED
2437
PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_structp png_ptr));
2438

2439 2440
PNG_EXPORTA(200, png_const_bytep, png_get_io_chunk_name,
    (png_structp png_ptr), PNG_DEPRECATED);
2441
PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type,
2442
    (png_const_structp png_ptr));
2443 2444

/* The flags returned by png_get_io_state() are the following: */
2445 2446 2447 2448 2449 2450 2451 2452 2453
#  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 */
2454 2455
#endif /* ?PNG_IO_STATE_SUPPORTED */

2456 2457 2458 2459 2460 2461 2462 2463 2464 2465
/* 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.
 */
2466 2467 2468 2469 2470 2471 2472 2473 2474 2475
#define PNG_PASS_START_ROW(pass) (((1&~(pass))<<(3-((pass)>>1)))&7)
#define PNG_PASS_START_COL(pass) (((1& (pass))<<(3-(((pass)+1)>>1)))&7)

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

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

2494 2495 2496
/* For the reader row callbacks (both progressive and sequential) it is
 * necessary to find the row in the output image given a row in an interlaced
 * image, so two more macros:
2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509
 */
#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) ( \
2510 2511
   ((0x110145AF>>(((7-(off))-(pass))<<2)) & 0xF) | \
   ((0x01145AF0>>(((7-(off))-(pass))<<2)) & 0xF0))
2512 2513 2514 2515 2516 2517

#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)

2518
#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
2519 2520 2521
/* 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
2522 2523 2524 2525 2526 2527 2528 2529 2530
 * 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. :-) ]
 */

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

2533 2534 2535 2536
#  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          \
2537
           - (png_uint_16)(alpha)) + 128);                \
2538
       (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
2539

2540 2541 2542
#  define png_composite_16(composite, fg, alpha, bg)       \
     { png_uint_32 temp = (png_uint_32)((png_uint_32)(fg)  \
           * (png_uint_32)(alpha)                          \
2543 2544
           + (png_uint_32)(bg)*(65535                      \
           - (png_uint_32)(alpha)) + 32768);               \
2545 2546
       (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }

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

2549 2550
#  define png_composite(composite, fg, alpha, bg)                          \
     (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) +  \
2551
     (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) +       \
2552
     127) / 255)
2553 2554

#  define png_composite_16(composite, fg, alpha, bg)                         \
2555
     (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \
2556 2557
     (png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) +         \
     32767) / 65535)
2558 2559
#endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */

2560
#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
2561 2562 2563
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));
2564 2565
#endif

2566
PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_structp png_ptr,
2567
    png_const_bytep buf));
2568 2569
/* No png_get_int_16 -- may be added if there's a real need for it. */

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

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

2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611
#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 已提交
2612 2613 2614 2615
/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
 * defs
 */

2616
/* The last ordinal number (this is the *last* one already used; the next
2617 2618
 * one to use is one more than this.)  Maintainer, remember to add an entry to
 * scripts/symbols.def as well.
2619 2620
 */
#ifdef PNG_EXPORT_LAST_ORDINAL
2621
  PNG_EXPORT_LAST_ORDINAL(233);
2622 2623
#endif

A
Andreas Dilger 已提交
2624 2625 2626 2627
#ifdef __cplusplus
}
#endif

2628
#endif /* PNG_VERSION_INFO_ONLY */
2629
/* Do not put anything past this line */
2630
#endif /* PNG_H */