png.h 110.5 KB
Newer Older
1

A
Andreas Dilger 已提交
2
/* png.h - header file for PNG reference library
3
 *
4
 * libpng version 1.5.6beta05 - October 5, 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.6beta05 - October 5, 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
 *    1.5.6beta01-05          15    10506  15.so.15.6[.0]
164
 *
165 166 167 168 169 170 171 172 173
 *   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".
174
 *
175 176 177
 *   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.
178
 *
179 180
 *   DLLNUM will change each time there are forward or backward changes
 *   in binary compatibility (e.g., when a new feature is added).
181
 *
182 183 184
 * 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/
185 186 187
 */

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

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

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

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

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

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

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

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

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

383
#define PNG_LIBPNG_VER_BUILD  05
384

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

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

400
#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_BETA
401

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

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

420
#ifndef PNG_VERSION_INFO_ONLY
421 422 423 424 425 426 427 428
#  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
429

430 431 432 433 434 435 436 437
    /* 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 已提交
438

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

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

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

#ifndef PNG_VERSION_INFO_ONLY

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

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

481 482 483
/* This file is arranged in several sections:
 *
 * 1. Any configuration options that can be specified by for the application
484
 *    code when it is built.  (Build time configuration is in pnglibconf.h)
485 486 487 488 489 490 491 492
 * 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
493
 * See pnglibconf.h for build time configuration
494 495 496
 *
 * Run time configuration allows the application to choose between
 * implementations of certain arithmetic APIs.  The default is set
497
 * at build time and recorded in pnglibconf.h, but it is safe to
498 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
 * 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
 */
526 527 528 529

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

692 693 694 695
/* 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.
 */
696
typedef struct png_info_def png_info;
A
Andreas Dilger 已提交
697
typedef png_info FAR * png_infop;
698
typedef PNG_CONST png_info FAR * png_const_infop;
A
Andreas Dilger 已提交
699
typedef png_info FAR * FAR * png_infopp;
G
Guy Schalnat 已提交
700

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

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

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

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

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

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

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

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

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

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

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

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

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

819 820 821 822 823 824 825 826
/* 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;

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

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

/* 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.)
 */
857
typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,
858
    png_uint_32, int));
859
#endif
G
Guy Schalnat 已提交
860

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

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

875
#ifdef PNG_SETJMP_SUPPORTED
876 877 878 879 880 881 882
/* 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 已提交
883 884 885
 * 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!
886
 */
887
PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)), typedef);
888
#endif
889 890

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1138 1139
#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
/* How the alpha channel is interpreted - this affects how the color channels of
1140 1141
 * a PNG file are returned when an alpha channel, or tRNS chunk in a palette
 * file, is present.
1142
 *
1143 1144 1145 1146 1147
 * 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
1148
 * channel is a linear measure of the contribution of the pixel to the
1149 1150 1151 1152
 * 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.
1153 1154 1155 1156 1157
 *
 * 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
1158 1159
 * 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
1160 1161
 * gamma encoding is used.  In addition all non-transparent pixel values,
 * including completely opaque ones, must be gamma encoded to produce the final
1162
 * image.  This is the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' mode (the
1163 1164 1165 1166 1167 1168 1169 1170
 * 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
1171
 * isolated, therefore typically the accuracy loss in storing 8-bit linear
1172
 * values is acceptable.  (This is not true if the alpha channel is used to
1173 1174
 * 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
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
 * 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
1185
 * with an enumerated 'mode' value and the gamma of the required output:
1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
 */
#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));
1198
#endif
1199

1200
#if defined(PNG_READ_GAMMA_SUPPORTED) || defined(PNG_READ_ALPHA_MODE_SUPPORTED)
1201 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
/* 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!
 *
1254 1255 1256 1257 1258 1259 1260
 * 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.
 *
1261 1262 1263 1264
 * 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.
 */
1265 1266
#define PNG_DEFAULT_sRGB -1       /* sRGB gamma and color space */
#define PNG_GAMMA_MAC_18 -2       /* Old Mac '1.8' gamma and color space */
1267
#define PNG_GAMMA_sRGB   220000   /* Television standards--matches sRGB gamma */
1268
#define PNG_GAMMA_LINEAR PNG_FP_1 /* Linear */
1269
#endif
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285

/* 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.
 *
1286
 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308
 *    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
1309
 *    below then encode the resultant 8-bit or 16-bit values to match the output
1310 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
 *    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.
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1459
/* Handle gamma correction. Screen_gamma=(display_exponent).
1460
 * NOTE: this API simply sets the screen and file gamma values. It will
1461
 * therefore override the value for gamma in a PNG file if it is called after
1462 1463 1464 1465 1466 1467 1468
 * 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.
1469
 */
1470
PNG_FP_EXPORT(50, void, png_set_gamma,
1471
    (png_structp png_ptr, double screen_gamma,
1472
    double override_file_gamma));
1473
PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structp png_ptr,
1474
    png_fixed_point screen_gamma, png_fixed_point override_file_gamma));
1475
#endif
G
Guy Schalnat 已提交
1476

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1603
#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */
A
Andreas Dilger 已提交
1604 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
/* 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.
 */
1632 1633
PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structp png_ptr,
    int heuristic_method, int num_weights, png_const_doublep filter_weights,
1634 1635
    png_const_doublep filter_costs));
PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed,
1636
    (png_structp png_ptr,
1637
    int heuristic_method, int num_weights, png_const_fixed_point_p
1638
    filter_weights, png_const_fixed_point_p filter_costs));
A
Andreas Dilger 已提交
1639 1640 1641 1642 1643 1644 1645 1646 1647 1648
#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 */

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

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

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

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

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

1676
#ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED
1677 1678 1679 1680 1681 1682 1683 1684 1685 1686
/* 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));

1687 1688 1689
/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
 * smaller value of window_bits if it can do so safely.
 */
1690 1691 1692 1693 1694
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));
1695
#endif /* PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED */
1696

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

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

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

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

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

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

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

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

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

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

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

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

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

1770
#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED
1771 1772
PNG_EXPORT(86, void, png_set_user_transform_info, (png_structp png_ptr,
    png_voidp user_transform_ptr, int user_transform_depth,
1773
    int user_transform_channels));
1774
/* Return the user pointer associated with the user transform functions */
1775
PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr,
1776 1777 1778 1779 1780 1781 1782
    (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
1783 1784 1785
 * 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.
1786
 *
1787 1788 1789
 * 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.)
1790 1791 1792
 */
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));
1793 1794
#endif

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

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

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

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

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

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

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

1851
/* Added at libpng version 1.2.4 */
1852
PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_structp png_ptr,
1853
    png_alloc_size_t size), PNG_ALLOCATED);
1854

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/* Returns image height in pixels. */
1985
PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structp png_ptr,
1986
    png_const_infop info_ptr));
1987 1988

/* Returns image bit_depth. */
1989
PNG_EXPORT(117, png_byte, png_get_bit_depth,
1990
    (png_const_structp png_ptr, png_const_infop info_ptr));
1991 1992

/* Returns image color_type. */
1993
PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structp png_ptr,
1994
    png_const_infop info_ptr));
1995 1996

/* Returns image filter_type. */
1997
PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structp png_ptr,
1998
    png_const_infop info_ptr));
1999 2000

/* Returns image interlace_type. */
2001
PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structp png_ptr,
2002
    png_const_infop info_ptr));
2003 2004

/* Returns image compression_type. */
2005
PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structp png_ptr,
2006
    png_const_infop info_ptr));
2007 2008

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

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

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

#endif /* PNG_EASY_ACCESS_SUPPORTED */

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

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

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

2049
#ifdef PNG_cHRM_SUPPORTED
2050 2051 2052
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,
2053
    double *blue_y));
2054 2055 2056 2057
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 已提交
2058
#ifdef PNG_FIXED_POINT_SUPPORTED /* Otherwise not implemented */
2059
PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed,
2060 2061 2062 2063 2064
    (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,
2065
    png_fixed_point *int_blue_y));
G
[devel]  
Glenn Randers-Pehrson 已提交
2066
#endif
2067 2068 2069 2070 2071 2072 2073
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));
2074
#endif
A
Andreas Dilger 已提交
2075

2076
#ifdef PNG_cHRM_SUPPORTED
2077
PNG_FP_EXPORT(135, void, png_set_cHRM,
2078 2079
    (png_structp png_ptr, png_infop info_ptr,
    double white_x, double white_y, double red_x, double red_y, double green_x,
2080
    double green_y, double blue_x, double blue_y));
2081 2082 2083 2084
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));
2085 2086 2087 2088 2089
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,
2090
    png_fixed_point int_blue_y));
2091 2092 2093 2094 2095 2096
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));
2097
#endif
A
Andreas Dilger 已提交
2098

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

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

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

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

2126
PNG_EXPORT(143, png_uint_32, png_get_IHDR,
2127 2128
    (png_structp png_ptr, png_infop info_ptr,
    png_uint_32 *width, png_uint_32 *height, int *bit_depth, int *color_type,
2129
    int *interlace_method, int *compression_method, int *filter_method));
2130

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

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

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

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

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

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

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

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

2179
PNG_EXPORT(152, void, png_set_PLTE,
2180
    (png_structp png_ptr, png_infop info_ptr,
2181
    png_const_colorp palette, int num_palette));
A
Andreas Dilger 已提交
2182

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

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

2194
#ifdef PNG_sRGB_SUPPORTED
2195
PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structp png_ptr,
2196
    png_const_infop info_ptr, int *file_srgb_intent));
2197
#endif
2198

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

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

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

2220
#ifdef PNG_sPLT_SUPPORTED
2221
PNG_EXPORT(160, png_uint_32, png_get_sPLT,
2222
    (png_const_structp png_ptr, png_const_infop info_ptr,
2223
    png_sPLT_tpp entries));
2224 2225
#endif

2226
#ifdef PNG_sPLT_SUPPORTED
2227
PNG_EXPORT(161, void, png_set_sPLT,
2228
    (png_structp png_ptr, png_infop info_ptr,
2229
    png_const_sPLT_tp entries, int nentries));
2230 2231
#endif

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

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

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

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

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

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

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

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

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

2305 2306
#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
/* Provide a list of chunks and how they are to be handled, if the built-in
2307 2308
   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
2309 2310 2311 2312 2313 2314 2315
   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
2316
*/
2317
PNG_EXPORT(172, void, png_set_keep_unknown_chunks,
2318
    (png_structp png_ptr, int keep,
2319
    png_const_bytep chunk_list, int num_chunks));
2320 2321 2322 2323

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

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

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

2352
PNG_EXPORT(180, png_const_charp, png_get_copyright,
2353
    (png_const_structp png_ptr));
2354
PNG_EXPORT(181, png_const_charp, png_get_header_ver,
2355
    (png_const_structp png_ptr));
2356
PNG_EXPORT(182, png_const_charp, png_get_header_version,
2357
    (png_const_structp png_ptr));
2358
PNG_EXPORT(183, png_const_charp, png_get_libpng_ver,
2359
    (png_const_structp png_ptr));
2360

2361
#ifdef PNG_MNG_FEATURES_SUPPORTED
2362
PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structp png_ptr,
2363
    png_uint_32 mng_features_permitted));
2364 2365
#endif

2366 2367 2368 2369 2370 2371
/* 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

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

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

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

2405
PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch,
2406
    (png_const_structp png_ptr, png_const_infop info_ptr));
2407

2408
PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch,
2409
    (png_const_structp png_ptr, png_const_infop info_ptr));
2410

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

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

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

2432 2433
/* Added in libpng-1.4.0 */
#ifdef PNG_IO_STATE_SUPPORTED
2434
PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_structp png_ptr));
2435

2436 2437
PNG_EXPORTA(200, png_const_bytep, png_get_io_chunk_name,
    (png_structp png_ptr), PNG_DEPRECATED);
2438
PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type,
2439
    (png_const_structp png_ptr));
2440 2441

/* The flags returned by png_get_io_state() are the following: */
2442 2443 2444 2445 2446 2447 2448 2449 2450
#  define PNG_IO_NONE        0x0000   /* no I/O at this moment */
#  define PNG_IO_READING     0x0001   /* currently reading */
#  define PNG_IO_WRITING     0x0002   /* currently writing */
#  define PNG_IO_SIGNATURE   0x0010   /* currently at the file signature */
#  define PNG_IO_CHUNK_HDR   0x0020   /* currently at the chunk header */
#  define PNG_IO_CHUNK_DATA  0x0040   /* currently at the chunk data */
#  define PNG_IO_CHUNK_CRC   0x0080   /* currently at the chunk crc */
#  define PNG_IO_MASK_OP     0x000f   /* current operation: reading/writing */
#  define PNG_IO_MASK_LOC    0x00f0   /* current location: sig/hdr/data/crc */
2451 2452
#endif /* ?PNG_IO_STATE_SUPPORTED */

2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482
/* Interlace support.  The following macros are always defined so that if
 * libpng interlace handling is turned off the macros may be used to handle
 * interlaced images within the application.
 */
#define PNG_INTERLACE_ADAM7_PASSES 7

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

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

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

2483 2484 2485
/* 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:
2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506
 */
#define PNG_ROW_FROM_PASS_ROW(yIn, pass) \
   (((yIn)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass))
#define PNG_COL_FROM_PASS_COL(xIn, pass) \
   (((xIn)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass))

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

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

2507
#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
2508 2509 2510
/* 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
2511 2512 2513 2514 2515 2516 2517 2518 2519
 * 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. :-) ]
 */

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

2522 2523 2524 2525
#  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          \
2526
           - (png_uint_16)(alpha)) + 128);                \
2527
       (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
2528

2529 2530 2531
#  define png_composite_16(composite, fg, alpha, bg)       \
     { png_uint_32 temp = (png_uint_32)((png_uint_32)(fg)  \
           * (png_uint_32)(alpha)                          \
2532 2533
           + (png_uint_32)(bg)*(65535                      \
           - (png_uint_32)(alpha)) + 32768);               \
2534 2535
       (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }

2536
#else  /* Standard method using integer division */
2537

2538 2539
#  define png_composite(composite, fg, alpha, bg)                          \
     (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) +  \
2540
     (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) +       \
2541
     127) / 255)
2542 2543

#  define png_composite_16(composite, fg, alpha, bg)                         \
2544
     (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \
2545 2546
     (png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) +         \
     32767) / 65535)
2547 2548
#endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */

2549
#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
2550 2551 2552
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));
2553 2554
#endif

2555
PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_structp png_ptr,
2556
    png_const_bytep buf));
2557 2558
/* No png_get_int_16 -- may be added if there's a real need for it. */

2559
/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
2560
#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2561
PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i));
2562
#endif
2563
#ifdef PNG_SAVE_INT_32_SUPPORTED
2564
PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i));
2565
#endif
2566 2567

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

2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600
#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 已提交
2601 2602 2603 2604
/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
 * defs
 */

2605
/* The last ordinal number (this is the *last* one already used; the next
2606 2607
 * one to use is one more than this.)  Maintainer, remember to add an entry to
 * scripts/symbols.def as well.
2608 2609
 */
#ifdef PNG_EXPORT_LAST_ORDINAL
2610
  PNG_EXPORT_LAST_ORDINAL(233);
2611 2612
#endif

A
Andreas Dilger 已提交
2613 2614 2615 2616
#ifdef __cplusplus
}
#endif

2617
#endif /* PNG_VERSION_INFO_ONLY */
2618
/* Do not put anything past this line */
2619
#endif /* PNG_H */