png.h 124.9 KB
Newer Older
1

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

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

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

/*
295 296 297 298 299 300 301 302 303 304 305 306
 * 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.
 */

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

362 363
#ifndef PNG_H
#define PNG_H
G
Guy Schalnat 已提交
364

365
/* This is not the place to learn how to use libpng. The file libpng-manual.txt
A
Andreas Dilger 已提交
366 367 368
 * 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.
369 370 371
 *
 * If you just need to read a PNG file and don't want to read the documentation
 * skip to the end of this file and read the section entitled 'simplified API'.
A
Andreas Dilger 已提交
372
 */
G
Guy Schalnat 已提交
373

374
/* Version information for png.h - this should match the version in png.c */
375
#define PNG_LIBPNG_VER_STRING "1.6.0alpha01"
376
#define PNG_HEADER_VERSION_STRING \
377
     " libpng version 1.6.0alpha01 - November 24, 2011\n"
378

379 380
#define PNG_LIBPNG_VER_SONUM   16
#define PNG_LIBPNG_VER_DLLNUM  16
381 382 383

/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */
#define PNG_LIBPNG_VER_MAJOR   1
384 385 386
#define PNG_LIBPNG_VER_MINOR   6
#define PNG_LIBPNG_VER_RELEASE 0

387
/* This should match the numeric part of the final component of
388 389
 * PNG_LIBPNG_VER_STRING, omitting any leading zero:
 */
390

391
#define PNG_LIBPNG_VER_BUILD  01
392

393
/* Release Status */
394 395 396 397
#define PNG_LIBPNG_BUILD_ALPHA    1
#define PNG_LIBPNG_BUILD_BETA     2
#define PNG_LIBPNG_BUILD_RC       3
#define PNG_LIBPNG_BUILD_STABLE   4
398
#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7
399

400 401 402 403 404 405 406
/* 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 */
407

408
#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_BETA
409

410 411 412 413
/* 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
414 415
 * version 1.0.1 it's    xxyyzz, where x=major, y=minor, z=release
 */
416
#define PNG_LIBPNG_VER 10600 /* 1.6.0 */
417

418 419 420 421
/* Library configuration: these options cannot be changed after
 * the library has been built.
 */
#ifndef PNGLCONF_H
422 423 424
    /* If pnglibconf.h is missing, you can
     * copy scripts/pnglibconf.h.prebuilt to pnglibconf.h
     */
425
#   include "pnglibconf.h"
426 427
#endif

428
#ifndef PNG_VERSION_INFO_ONLY
429 430 431 432 433 434 435 436
#  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
437

438 439 440 441 442 443 444 445
    /* 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 已提交
446

447 448 449
/* Machine specific configuration. */
#  include "pngconf.h"
#endif
G
Guy Schalnat 已提交
450

451
/*
452 453 454
 * Added at libpng-1.2.8
 *
 * Ref MSDN: Private as priority over Special
455 456
 * VS_FF_PRIVATEBUILD File *was not* built using standard release
 * procedures. If this value is given, the StringFileInfo block must
457
 * contain a PrivateBuild string.
458 459 460 461
 *
 * 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
462
 * StringFileInfo block must contain a SpecialBuild string.
463 464
 */

465
#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
466
#  define PNG_LIBPNG_BUILD_TYPE \
467
       (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
468
#else
469
#  ifdef PNG_LIBPNG_SPECIALBUILD
470
#    define PNG_LIBPNG_BUILD_TYPE \
471
         (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
472
#  else
473
#    define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
474 475 476 477 478
#  endif
#endif

#ifndef PNG_VERSION_INFO_ONLY

479 480 481 482 483
/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

A
Andreas Dilger 已提交
484 485 486
/* Version information for C files, stored in png.c.  This had better match
 * the version above.
 */
487
#define png_libpng_ver png_get_header_ver(NULL)
A
Andreas Dilger 已提交
488

489 490 491
/* This file is arranged in several sections:
 *
 * 1. Any configuration options that can be specified by for the application
492
 *    code when it is built.  (Build time configuration is in pnglibconf.h)
493 494 495
 * 2. Type definitions (base types are defined in pngconf.h), structure
 *    definitions.
 * 3. Exported library functions.
496
 * 4. Simplified API.
497 498 499 500 501
 *
 * The library source code has additional files (principally pngpriv.h) that
 * allow configuration of the library.
 */
/* Section 1: run time configuration
502
 * See pnglibconf.h for build time configuration
503 504 505
 *
 * Run time configuration allows the application to choose between
 * implementations of certain arithmetic APIs.  The default is set
506
 * at build time and recorded in pnglibconf.h, but it is safe to
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
 * 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
 */
535 536 537 538

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

A
Andreas Dilger 已提交
541 542 543 544
/* 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 已提交
545 546
typedef struct png_color_struct
{
G
Guy Schalnat 已提交
547
   png_byte red;
G
Guy Schalnat 已提交
548 549 550
   png_byte green;
   png_byte blue;
} png_color;
A
Andreas Dilger 已提交
551
typedef png_color FAR * png_colorp;
552
typedef PNG_CONST png_color FAR * png_const_colorp;
A
Andreas Dilger 已提交
553
typedef png_color FAR * FAR * png_colorpp;
G
Guy Schalnat 已提交
554 555 556

typedef struct png_color_16_struct
{
A
Andreas Dilger 已提交
557 558
   png_byte index;    /* used for palette files */
   png_uint_16 red;   /* for use in red green blue files */
G
Guy Schalnat 已提交
559 560
   png_uint_16 green;
   png_uint_16 blue;
A
Andreas Dilger 已提交
561
   png_uint_16 gray;  /* for use in grayscale files */
G
Guy Schalnat 已提交
562
} png_color_16;
A
Andreas Dilger 已提交
563
typedef png_color_16 FAR * png_color_16p;
564
typedef PNG_CONST png_color_16 FAR * png_const_color_16p;
A
Andreas Dilger 已提交
565
typedef png_color_16 FAR * FAR * png_color_16pp;
G
Guy Schalnat 已提交
566 567 568

typedef struct png_color_8_struct
{
A
Andreas Dilger 已提交
569
   png_byte red;   /* for use in red green blue files */
G
Guy Schalnat 已提交
570 571
   png_byte green;
   png_byte blue;
A
Andreas Dilger 已提交
572
   png_byte gray;  /* for use in grayscale files */
G
Guy Schalnat 已提交
573 574
   png_byte alpha; /* for alpha channel files */
} png_color_8;
A
Andreas Dilger 已提交
575
typedef png_color_8 FAR * png_color_8p;
576
typedef PNG_CONST png_color_8 FAR * png_const_color_8p;
A
Andreas Dilger 已提交
577
typedef png_color_8 FAR * FAR * png_color_8pp;
G
Guy Schalnat 已提交
578

579 580 581 582
/*
 * The following two structures are used for the in-core representation
 * of sPLT chunks.
 */
583
typedef struct png_sPLT_entry_struct
584 585 586 587 588 589
{
   png_uint_16 red;
   png_uint_16 green;
   png_uint_16 blue;
   png_uint_16 alpha;
   png_uint_16 frequency;
590 591
} png_sPLT_entry;
typedef png_sPLT_entry FAR * png_sPLT_entryp;
592
typedef PNG_CONST png_sPLT_entry FAR * png_const_sPLT_entryp;
593
typedef png_sPLT_entry FAR * FAR * png_sPLT_entrypp;
594

595 596 597 598 599
/*  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.
 */

600
typedef struct png_sPLT_struct
601
{
602 603 604 605
   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 */
606 607
} png_sPLT_t;
typedef png_sPLT_t FAR * png_sPLT_tp;
608
typedef PNG_CONST png_sPLT_t FAR * png_const_sPLT_tp;
609
typedef png_sPLT_t FAR * FAR * png_sPLT_tpp;
610 611

#ifdef PNG_TEXT_SUPPORTED
612
/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,
613
 * and whether that contents is compressed or not.  The "key" field
614 615
 * points to a regular zero-terminated C string.  The "text" fields can be a
 * regular C string, an empty string, or a NULL pointer.
616
 * However, the structure returned by png_get_text() will always contain
617 618 619 620 621 622 623 624
 * the "text" field as a regular zero-terminated C string (possibly
 * empty), never a NULL pointer, so it can be safely used in printf() and
 * other string-handling functions.  Note that the "itxt_length", "lang", and
 * "lang_key" members of the structure only exist when the library is built
 * with iTXt chunk support.  Prior to libpng-1.4.0 the library was built by
 * default without iTXt support. Also note that when iTXt *is* supported,
 * the "lang" and "lang_key" fields contain NULL pointers when the
 * "compression" field contains * PNG_TEXT_COMPRESSION_NONE or
625 626 627
 * PNG_TEXT_COMPRESSION_zTXt. Note that the "compression value" is not the
 * same as what appears in the PNG tEXt/zTXt/iTXt chunk's "compression flag"
 * which is always 0 or 1, or its "compression method" which is always 0.
628
 */
G
Guy Schalnat 已提交
629 630
typedef struct png_text_struct
{
631 632 633 634 635
   int  compression;       /* compression value:
                             -1: tEXt, none
                              0: zTXt, deflate
                              1: iTXt, none
                              2: iTXt, deflate  */
A
Andreas Dilger 已提交
636
   png_charp key;          /* keyword, 1-79 character description of "text" */
637 638
   png_charp text;         /* comment, may be an empty string (ie "")
                              or a NULL pointer */
639 640
   png_size_t text_length; /* length of the text string */
   png_size_t itxt_length; /* length of the itxt string */
641 642
   png_charp lang;         /* language code, 0-79 characters
                              or a NULL pointer */
643
   png_charp lang_key;     /* keyword translated UTF-8 string, 0 or more
644
                              chars or a NULL pointer */
G
Guy Schalnat 已提交
645
} png_text;
A
Andreas Dilger 已提交
646
typedef png_text FAR * png_textp;
647
typedef PNG_CONST png_text FAR * png_const_textp;
A
Andreas Dilger 已提交
648
typedef png_text FAR * FAR * png_textpp;
649
#endif
A
Andreas Dilger 已提交
650 651 652 653 654 655 656

/* 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
657 658 659
#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 已提交
660 661

/* png_time is a way to hold the time in an machine independent way.
662 663 664
 * 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
665
 * note - PNG has always been Year 2000 compliant!
666
 */
G
Guy Schalnat 已提交
667 668 669
typedef struct png_time_struct
{
   png_uint_16 year; /* full year, as in, 1995 */
A
Andreas Dilger 已提交
670 671 672 673 674
   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 已提交
675
} png_time;
A
Andreas Dilger 已提交
676
typedef png_time FAR * png_timep;
677
typedef PNG_CONST png_time FAR * png_const_timep;
A
Andreas Dilger 已提交
678 679
typedef png_time FAR * FAR * png_timepp;

680
#if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED) || \
681
    defined(PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
682 683 684 685 686 687 688 689 690 691 692
/* 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;

693
    /* libpng-using applications should NOT directly modify this byte. */
694 695
    png_byte location; /* mode of operation at read time */
}
696 697


698 699
png_unknown_chunk;
typedef png_unknown_chunk FAR * png_unknown_chunkp;
700
typedef PNG_CONST png_unknown_chunk FAR * png_const_unknown_chunkp;
701 702 703
typedef png_unknown_chunk FAR * FAR * png_unknown_chunkpp;
#endif

704
/* Values for the unknown chunk location byte */
705

706 707 708
#define PNG_HAVE_IHDR  0x01
#define PNG_HAVE_PLTE  0x02
#define PNG_AFTER_IDAT 0x08
709

710 711 712 713
/* 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.
 */
714
typedef struct png_info_def png_info;
A
Andreas Dilger 已提交
715
typedef png_info FAR * png_infop;
716
typedef PNG_CONST png_info FAR * png_const_infop;
A
Andreas Dilger 已提交
717
typedef png_info FAR * FAR * png_infopp;
G
Guy Schalnat 已提交
718

719
/* Maximum positive integer used in PNG is (2^31)-1 */
720
#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
721 722
#define PNG_UINT_32_MAX ((png_uint_32)(-1))
#define PNG_SIZE_MAX ((png_size_t)(-1))
723

G
[devel]  
Glenn Randers-Pehrson 已提交
724 725 726 727 728
/* These are constants for fixed point values encoded in the
 * PNG specification manner (x100000)
 */
#define PNG_FP_1    100000
#define PNG_FP_HALF  50000
729 730
#define PNG_FP_MAX  ((png_fixed_point)0x7fffffffL)
#define PNG_FP_MIN  (-PNG_FP_MAX)
G
[devel]  
Glenn Randers-Pehrson 已提交
731

A
Andreas Dilger 已提交
732
/* These describe the color_type field in png_info. */
G
Guy Schalnat 已提交
733
/* color type masks */
A
Andreas Dilger 已提交
734 735 736
#define PNG_COLOR_MASK_PALETTE    1
#define PNG_COLOR_MASK_COLOR      2
#define PNG_COLOR_MASK_ALPHA      4
G
Guy Schalnat 已提交
737 738

/* color types.  Note that not all combinations are legal */
G
Guy Schalnat 已提交
739
#define PNG_COLOR_TYPE_GRAY 0
A
Andreas Dilger 已提交
740 741 742
#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 已提交
743
#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
744 745 746
/* aliases */
#define PNG_COLOR_TYPE_RGBA  PNG_COLOR_TYPE_RGB_ALPHA
#define PNG_COLOR_TYPE_GA  PNG_COLOR_TYPE_GRAY_ALPHA
G
Guy Schalnat 已提交
747

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

752
/* This is for filter type. PNG 1.0-1.2 only define the single type. */
A
Andreas Dilger 已提交
753
#define PNG_FILTER_TYPE_BASE      0 /* Single row per-byte filtering */
754
#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
A
Andreas Dilger 已提交
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
#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 */

774 775 776 777 778 779
/* 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 已提交
780 781 782 783 784
/* 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 */

785
/* These are for the sRGB chunk.  These values should NOT be changed. */
786 787 788 789
#define PNG_sRGB_INTENT_PERCEPTUAL 0
#define PNG_sRGB_INTENT_RELATIVE   1
#define PNG_sRGB_INTENT_SATURATION 2
#define PNG_sRGB_INTENT_ABSOLUTE   3
790
#define PNG_sRGB_INTENT_LAST       4 /* Not a valid value */
791

792 793
/* This is for text chunks */
#define PNG_KEYWORD_MAX_LENGTH     79
794

795
/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
796
#define PNG_MAX_PALETTE_LENGTH    256
797

A
Andreas Dilger 已提交
798 799 800 801 802
/* 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 已提交
803 804 805 806 807 808 809 810 811 812
#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 已提交
813
#define PNG_INFO_pCAL 0x0400
814
#define PNG_INFO_sRGB 0x0800   /* GR-P, 0.96a */
815 816 817
#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 */
818
#define PNG_INFO_IDAT 0x8000   /* ESR, 1.0.6 */
G
Guy Schalnat 已提交
819

A
Andreas Dilger 已提交
820 821 822 823
/* 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 已提交
824 825
typedef struct png_row_info_struct
{
826 827 828 829 830
   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 已提交
831
   png_byte pixel_depth; /* bits per pixel (depth * channels) */
G
Guy Schalnat 已提交
832 833
} png_row_info;

A
Andreas Dilger 已提交
834 835
typedef png_row_info FAR * png_row_infop;
typedef png_row_info FAR * FAR * png_row_infopp;
G
Guy Schalnat 已提交
836

837 838 839 840 841 842 843 844
/* 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;

845 846 847 848
/* 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
849
 * user read/write data functions.  Note that the 'write' function must not
850
 * modify the buffer it is passed. The 'read' function, on the other hand, is
851
 * expected to return the read data in the buffer.
G
Guy Schalnat 已提交
852
 */
853 854 855 856 857 858 859
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));
860

G
Guy Schalnat 已提交
861
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
862 863
typedef PNG_CALLBACK(void, *png_progressive_info_ptr, (png_structp, png_infop));
typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop));
864 865 866 867 868 869 870 871 872 873 874

/* 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.)
 */
875
typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,
876
    png_uint_32, int));
877
#endif
G
Guy Schalnat 已提交
878

879
#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
880
    defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
881
typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
882
    png_bytep));
883
#endif
884

885
#ifdef PNG_USER_CHUNKS_SUPPORTED
886
typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
887
    png_unknown_chunkp));
888
#endif
889
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
890
typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp));
891
#endif
892

893
#ifdef PNG_SETJMP_SUPPORTED
894 895 896 897 898 899 900
/* 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 已提交
901 902 903
 * 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!
904
 */
905
PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)), typedef);
906
#endif
907 908

/* Transform masks for the high-level interface */
909 910
#define PNG_TRANSFORM_IDENTITY       0x0000    /* read and write */
#define PNG_TRANSFORM_STRIP_16       0x0001    /* read only */
911 912
#define PNG_TRANSFORM_STRIP_ALPHA    0x0002    /* read only */
#define PNG_TRANSFORM_PACKING        0x0004    /* read and write */
913 914
#define PNG_TRANSFORM_PACKSWAP       0x0008    /* read and write */
#define PNG_TRANSFORM_EXPAND         0x0010    /* read only */
915
#define PNG_TRANSFORM_INVERT_MONO    0x0020    /* read and write */
916 917 918
#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 */
919
#define PNG_TRANSFORM_SWAP_ENDIAN    0x0200    /* read and write */
920
#define PNG_TRANSFORM_INVERT_ALPHA   0x0400    /* read and write */
921
#define PNG_TRANSFORM_STRIP_FILLER   0x0800    /* write only */
922
/* Added to libpng-1.2.34 */
923
#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
924 925 926
#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
/* Added to libpng-1.4.0 */
#define PNG_TRANSFORM_GRAY_TO_RGB   0x2000      /* read only */
927
/* Added to libpng-1.5.4 */
928
#define PNG_TRANSFORM_EXPAND_16     0x4000      /* read only */
929
#define PNG_TRANSFORM_SCALE_16      0x8000      /* read only */
930

931
/* Flags for MNG supported features */
932 933
#define PNG_FLAG_MNG_EMPTY_PLTE     0x01
#define PNG_FLAG_MNG_FILTER_64      0x04
934
#define PNG_ALL_MNG_FEATURES        0x05
935

936
/* NOTE: prior to 1.5 these functions had no 'API' style declaration,
937 938 939 940 941
 * 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.
 */
942
typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,
943 944
    png_alloc_size_t));
typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp));
945

A
Andreas Dilger 已提交
946
typedef png_struct FAR * FAR * png_structpp;
G
Guy Schalnat 已提交
947

948 949
/* Section 3: exported functions
 * Here are the function definitions most commonly used.  This is not
950
 * the place to find out how to use libpng.  See libpng-manual.txt for the
A
Andreas Dilger 已提交
951
 * full explanation, see example.c for the summary.  This just provides
952
 * a simple one line description of the use of each function.
G
[devel]  
Glenn Randers-Pehrson 已提交
953
 *
954 955
 * 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 已提交
956
 *
957
 *   PNG_EXPORT(ordinal, type, name, (args));
958 959 960 961 962
 *
 *       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
963
 *                   entries, and are removed by pngconf.h.
964 965 966 967
 *       type:       return type of the function
 *       name:       function name
 *       args:       function arguments, with types
 *
968 969 970
 * When we wish to append attributes to a function prototype we use
 * the PNG_EXPORTA() macro instead.
 *
971 972
 *   PNG_EXPORTA(ordinal, type, name, (args), attributes);
 *
973
 *       ordinal, type, name, and args: same as in PNG_EXPORT().
974
 *       attributes: function attributes
A
Andreas Dilger 已提交
975
 */
G
Guy Schalnat 已提交
976

977
/* Returns the version number of the library */
978
PNG_EXPORT(1, png_uint_32, png_access_version_number, (void));
979

A
Andreas Dilger 已提交
980
/* Tell lib we have already handled the first <num_bytes> magic bytes.
A
Andreas Dilger 已提交
981 982
 * Handling more than 8 bytes from the beginning of the file is an error.
 */
983
PNG_EXPORT(2, void, png_set_sig_bytes, (png_structp png_ptr, int num_bytes));
A
Andreas Dilger 已提交
984 985 986 987 988 989

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

993 994 995
/* Simple signature checking function.  This is the same as calling
 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
 */
996
#define png_check_sig(sig, n) !png_sig_cmp((sig), 0, (n))
997

A
Andreas Dilger 已提交
998
/* Allocate and initialize png_ptr struct for reading, and any other memory. */
999 1000
PNG_EXPORTA(4, png_structp, png_create_read_struct,
    (png_const_charp user_png_ver, png_voidp error_ptr,
1001
    png_error_ptr error_fn, png_error_ptr warn_fn),
1002
    PNG_ALLOCATED);
A
Andreas Dilger 已提交
1003

1004
/* Allocate and initialize png_ptr struct for writing, and any other memory */
1005 1006
PNG_EXPORTA(5, png_structp, png_create_write_struct,
    (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
1007
    png_error_ptr warn_fn),
1008
    PNG_ALLOCATED);
G
Guy Schalnat 已提交
1009

1010
PNG_EXPORT(6, png_size_t, png_get_compression_buffer_size,
1011
    (png_const_structp png_ptr));
1012

1013
PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structp png_ptr,
1014
    png_size_t size));
1015

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
/* 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.
 */
1027
PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structp png_ptr,
1028
    png_longjmp_ptr longjmp_fn, size_t jmp_buf_size));
1029
#  define png_jmpbuf(png_ptr) \
1030
      (*png_set_longjmp_fn((png_ptr), longjmp, sizeof (jmp_buf)))
1031 1032
#else
#  define png_jmpbuf(png_ptr) \
1033
      (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
1034
#endif
1035 1036 1037 1038 1039
/* 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.
 */
1040 1041
PNG_EXPORTA(9, void, png_longjmp, (png_structp png_ptr, int val),
    PNG_NORETURN);
1042

1043
#ifdef PNG_READ_SUPPORTED
1044
/* Reset the compression stream */
1045
PNG_EXPORT(10, int, png_reset_zstream, (png_structp png_ptr));
1046
#endif
1047

1048
/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
1049
#ifdef PNG_USER_MEM_SUPPORTED
1050 1051
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,
1052 1053
    png_error_ptr warn_fn,
    png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
1054 1055 1056
    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,
1057 1058
    png_error_ptr warn_fn,
    png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
1059
    PNG_ALLOCATED);
1060 1061
#endif

1062
/* Write the PNG file signature. */
1063
PNG_EXPORT(13, void, png_write_sig, (png_structp png_ptr));
1064

1065
/* Write a PNG chunk - size, type, (optional) data, CRC. */
1066 1067
PNG_EXPORT(14, void, png_write_chunk, (png_structp png_ptr, png_const_bytep
    chunk_name, png_const_bytep data, png_size_t length));
1068 1069

/* Write the start of a PNG chunk - length and chunk name. */
1070
PNG_EXPORT(15, void, png_write_chunk_start, (png_structp png_ptr,
1071
    png_const_bytep chunk_name, png_uint_32 length));
1072 1073

/* Write the data of a PNG chunk started with png_write_chunk_start(). */
1074 1075
PNG_EXPORT(16, void, png_write_chunk_data, (png_structp png_ptr,
    png_const_bytep data, png_size_t length));
1076 1077

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

A
Andreas Dilger 已提交
1080
/* Allocate and initialize the info structure */
1081
PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_structp png_ptr),
1082
    PNG_ALLOCATED);
G
Guy Schalnat 已提交
1083

1084
PNG_EXPORT(19, void, png_info_init_3, (png_infopp info_ptr,
1085
    png_size_t png_info_struct_size));
G
Guy Schalnat 已提交
1086

A
Andreas Dilger 已提交
1087
/* Writes all the PNG information before the image. */
1088 1089 1090 1091
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 已提交
1092

1093
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1094
/* Read the information before the actual image data. */
1095 1096
PNG_EXPORT(22, void, png_read_info,
    (png_structp png_ptr, png_infop info_ptr));
1097
#endif
G
Guy Schalnat 已提交
1098

1099
#ifdef PNG_TIME_RFC1123_SUPPORTED
1100
PNG_EXPORT(23, png_const_charp, png_convert_to_rfc1123,
1101
    (png_structp png_ptr,
1102
    png_const_timep ptime));
1103
#endif
1104

1105
#ifdef PNG_CONVERT_tIME_SUPPORTED
1106
/* Convert from a struct tm to png_time */
1107
PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime,
1108
    PNG_CONST struct tm FAR * ttime));
G
Guy Schalnat 已提交
1109

1110
/* Convert from time_t to png_time.  Uses gmtime() */
1111 1112
PNG_EXPORT(25, void, png_convert_from_time_t,
    (png_timep ptime, time_t ttime));
1113
#endif /* PNG_CONVERT_tIME_SUPPORTED */
G
Guy Schalnat 已提交
1114

1115
#ifdef PNG_READ_EXPAND_SUPPORTED
1116
/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
1117 1118 1119 1120
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));
1121
#endif
G
Guy Schalnat 已提交
1122

1123
#ifdef PNG_READ_EXPAND_16_SUPPORTED
1124
/* Expand to 16-bit channels, forces conversion of palette to RGB and expansion
1125 1126 1127 1128 1129
 * of a tRNS chunk if present.
 */
PNG_EXPORT(221, void, png_set_expand_16, (png_structp png_ptr));
#endif

G
Guy Schalnat 已提交
1130
#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
G
Guy Schalnat 已提交
1131
/* Use blue, green, red order for pixels. */
1132
PNG_EXPORT(30, void, png_set_bgr, (png_structp png_ptr));
1133
#endif
G
Guy Schalnat 已提交
1134

1135
#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
1136
/* Expand the grayscale to 24-bit RGB if necessary. */
1137
PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structp png_ptr));
1138
#endif
G
Guy Schalnat 已提交
1139

1140
#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
1141
/* Reduce RGB to grayscale. */
1142 1143 1144 1145 1146
#define PNG_ERROR_ACTION_NONE  1
#define PNG_ERROR_ACTION_WARN  2
#define PNG_ERROR_ACTION_ERROR 3
#define PNG_RGB_TO_GRAY_DEFAULT (-1)/*for red/green coefficients*/

1147 1148
PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structp png_ptr,
    int error_action, double red, double green));
1149
PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structp png_ptr,
1150
    int error_action, png_fixed_point red, png_fixed_point green));
1151

1152
PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structp
1153
    png_ptr));
1154
#endif
A
Andreas Dilger 已提交
1155

1156
#ifdef PNG_BUILD_GRAYSCALE_PALETTE_SUPPORTED
1157
PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth,
1158
    png_colorp palette));
1159
#endif
A
Andreas Dilger 已提交
1160

1161 1162
#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
/* How the alpha channel is interpreted - this affects how the color channels of
1163 1164
 * a PNG file are returned when an alpha channel, or tRNS chunk in a palette
 * file, is present.
1165
 *
1166 1167 1168 1169 1170
 * 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
1171
 * channel is a linear measure of the contribution of the pixel to the
1172 1173 1174 1175
 * 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.
1176 1177 1178 1179 1180
 *
 * 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
1181 1182
 * 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
1183 1184
 * gamma encoding is used.  In addition all non-transparent pixel values,
 * including completely opaque ones, must be gamma encoded to produce the final
1185
 * image.  This is the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' mode (the
1186 1187 1188 1189 1190 1191 1192 1193
 * 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
1194
 * isolated, therefore typically the accuracy loss in storing 8-bit linear
1195
 * values is acceptable.  (This is not true if the alpha channel is used to
1196 1197
 * 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
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
 * 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
1208
 * with an enumerated 'mode' value and the gamma of the required output:
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
 */
#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));
1221
#endif
1222

1223
#if defined(PNG_READ_GAMMA_SUPPORTED) || defined(PNG_READ_ALPHA_MODE_SUPPORTED)
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
/* 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!
 *
1277 1278 1279 1280 1281 1282 1283
 * 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.
 *
1284 1285 1286 1287
 * 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.
 */
1288 1289
#define PNG_DEFAULT_sRGB -1       /* sRGB gamma and color space */
#define PNG_GAMMA_MAC_18 -2       /* Old Mac '1.8' gamma and color space */
1290
#define PNG_GAMMA_sRGB   220000   /* Television standards--matches sRGB gamma */
1291
#define PNG_GAMMA_LINEAR PNG_FP_1 /* Linear */
1292
#endif
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308

/* 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.
 *
1309
 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
 *    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
1332
 *    below then encode the resultant 8-bit or 16-bit values to match the output
1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
 *    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.
 */

1370
#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
1371
PNG_EXPORT(36, void, png_set_strip_alpha, (png_structp png_ptr));
1372
#endif
G
Guy Schalnat 已提交
1373

A
Andreas Dilger 已提交
1374 1375
#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
1376
PNG_EXPORT(37, void, png_set_swap_alpha, (png_structp png_ptr));
1377
#endif
G
Guy Schalnat 已提交
1378

1379 1380
#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
1381
PNG_EXPORT(38, void, png_set_invert_alpha, (png_structp png_ptr));
1382
#endif
1383

A
Andreas Dilger 已提交
1384
#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
1385
/* Add a filler byte to 8-bit Gray or 24-bit RGB images. */
1386
PNG_EXPORT(39, void, png_set_filler, (png_structp png_ptr, png_uint_32 filler,
1387
    int flags));
A
Andreas Dilger 已提交
1388
/* The values of the PNG_FILLER_ defines should NOT be changed */
1389 1390
#  define PNG_FILLER_BEFORE 0
#  define PNG_FILLER_AFTER 1
1391
/* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */
1392
PNG_EXPORT(40, void, png_set_add_alpha,
1393
    (png_structp png_ptr, png_uint_32 filler,
1394
    int flags));
A
Andreas Dilger 已提交
1395
#endif /* PNG_READ_FILLER_SUPPORTED || PNG_WRITE_FILLER_SUPPORTED */
G
Guy Schalnat 已提交
1396

G
Guy Schalnat 已提交
1397
#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
1398
/* Swap bytes in 16-bit depth files. */
1399
PNG_EXPORT(41, void, png_set_swap, (png_structp png_ptr));
1400
#endif
G
Guy Schalnat 已提交
1401

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

1407 1408
#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
    defined(PNG_WRITE_PACKSWAP_SUPPORTED)
A
Andreas Dilger 已提交
1409
/* Swap packing order of pixels in bytes. */
1410
PNG_EXPORT(43, void, png_set_packswap, (png_structp png_ptr));
1411
#endif
G
Guy Schalnat 已提交
1412

G
Guy Schalnat 已提交
1413
#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
G
Guy Schalnat 已提交
1414
/* Converts files to legal bit depths. */
1415 1416
PNG_EXPORT(44, void, png_set_shift, (png_structp png_ptr, png_const_color_8p
    true_bits));
1417
#endif
G
Guy Schalnat 已提交
1418

G
Guy Schalnat 已提交
1419 1420
#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
    defined(PNG_WRITE_INTERLACING_SUPPORTED)
G
[devel]  
Glenn Randers-Pehrson 已提交
1421
/* Have the code handle the interlacing.  Returns the number of passes.
1422 1423 1424 1425 1426
 * 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.
*/
1427
PNG_EXPORT(45, int, png_set_interlace_handling, (png_structp png_ptr));
1428
#endif
G
Guy Schalnat 已提交
1429

G
Guy Schalnat 已提交
1430
#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
1431
/* Invert monochrome files */
1432
PNG_EXPORT(46, void, png_set_invert_mono, (png_structp png_ptr));
1433
#endif
G
Guy Schalnat 已提交
1434

1435
#ifdef PNG_READ_BACKGROUND_SUPPORTED
1436
/* Handle alpha and tRNS by replacing with a background color.  Prior to
1437
 * libpng-1.5.4 this API must not be called before the PNG file header has been
1438
 * read.  Doing so will result in unexpected behavior and possible warnings or
1439
 * errors if the PNG file contains a bKGD chunk.
1440
 */
1441 1442
PNG_FP_EXPORT(47, void, png_set_background, (png_structp png_ptr,
    png_const_color_16p background_color, int background_gamma_code,
1443
    int need_expand, double background_gamma));
1444
PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structp png_ptr,
1445
    png_const_color_16p background_color, int background_gamma_code,
1446
    int need_expand, png_fixed_point background_gamma));
G
[devel]  
Glenn Randers-Pehrson 已提交
1447 1448
#endif
#ifdef PNG_READ_BACKGROUND_SUPPORTED
1449 1450 1451 1452
#  define PNG_BACKGROUND_GAMMA_UNKNOWN 0
#  define PNG_BACKGROUND_GAMMA_SCREEN  1
#  define PNG_BACKGROUND_GAMMA_FILE    2
#  define PNG_BACKGROUND_GAMMA_UNIQUE  3
1453
#endif
G
Guy Schalnat 已提交
1454

1455
#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
1456
/* Scale a 16-bit depth file down to 8-bit, accurately. */
1457
PNG_EXPORT(229, void, png_set_scale_16, (png_structp png_ptr));
1458
#endif
1459

1460 1461
#ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED
#define PNG_READ_16_TO_8 SUPPORTED /* Name prior to 1.5.4 */
1462
/* Strip the second byte of information from a 16-bit depth file. */
1463
PNG_EXPORT(48, void, png_set_strip_16, (png_structp png_ptr));
1464
#endif
G
Guy Schalnat 已提交
1465

1466 1467
#ifdef PNG_READ_QUANTIZE_SUPPORTED
/* Turn on quantizing, and reduce the palette to the number of colors
1468 1469
 * available.
 */
1470
PNG_EXPORT(49, void, png_set_quantize,
1471 1472
    (png_structp png_ptr, png_colorp palette,
    int num_palette, int maximum_colors, png_const_uint_16p histogram,
1473
    int full_quantize));
1474
#endif
G
Guy Schalnat 已提交
1475

1476
#ifdef PNG_READ_GAMMA_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1477 1478 1479 1480 1481
/* 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)

1482
/* Handle gamma correction. Screen_gamma=(display_exponent).
1483
 * NOTE: this API simply sets the screen and file gamma values. It will
1484
 * therefore override the value for gamma in a PNG file if it is called after
1485 1486 1487 1488 1489 1490 1491
 * 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.
1492
 */
1493
PNG_FP_EXPORT(50, void, png_set_gamma,
1494
    (png_structp png_ptr, double screen_gamma,
1495
    double override_file_gamma));
1496
PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structp png_ptr,
1497
    png_fixed_point screen_gamma, png_fixed_point override_file_gamma));
1498
#endif
G
Guy Schalnat 已提交
1499

1500
#ifdef PNG_WRITE_FLUSH_SUPPORTED
G
Guy Schalnat 已提交
1501
/* Set how many lines between output flushes - 0 for no flushing */
1502
PNG_EXPORT(51, void, png_set_flush, (png_structp png_ptr, int nrows));
G
Guy Schalnat 已提交
1503
/* Flush the current PNG output buffer */
1504
PNG_EXPORT(52, void, png_write_flush, (png_structp png_ptr));
1505
#endif
G
Guy Schalnat 已提交
1506

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

1510
/* Optional call to update the users info structure */
1511 1512
PNG_EXPORT(54, void, png_read_update_info,
    (png_structp png_ptr, png_infop info_ptr));
G
Guy Schalnat 已提交
1513

1514
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1515
/* Read one or more rows of image data. */
1516
PNG_EXPORT(55, void, png_read_rows, (png_structp png_ptr, png_bytepp row,
1517
    png_bytepp display_row, png_uint_32 num_rows));
1518
#endif
G
Guy Schalnat 已提交
1519

1520
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1521
/* Read a row of data. */
1522
PNG_EXPORT(56, void, png_read_row, (png_structp png_ptr, png_bytep row,
1523
    png_bytep display_row));
1524
#endif
G
Guy Schalnat 已提交
1525

1526
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1527
/* Read the whole image into memory at once. */
1528
PNG_EXPORT(57, void, png_read_image, (png_structp png_ptr, png_bytepp image));
1529
#endif
G
Guy Schalnat 已提交
1530

1531
/* Write a row of image data */
1532 1533
PNG_EXPORT(58, void, png_write_row,
    (png_structp png_ptr, png_const_bytep row));
G
Guy Schalnat 已提交
1534

1535 1536 1537
/* 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
1538 1539
 * unchanged to write_rows.
 */
1540
PNG_EXPORT(59, void, png_write_rows, (png_structp png_ptr, png_bytepp row,
1541
    png_uint_32 num_rows));
G
Guy Schalnat 已提交
1542

1543
/* Write the image data */
1544 1545
PNG_EXPORT(60, void, png_write_image,
    (png_structp png_ptr, png_bytepp image));
G
Guy Schalnat 已提交
1546

1547
/* Write the end of the PNG file. */
1548 1549
PNG_EXPORT(61, void, png_write_end,
    (png_structp png_ptr, png_infop info_ptr));
G
Guy Schalnat 已提交
1550

1551
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1552
/* Read the end of the PNG file. */
1553
PNG_EXPORT(62, void, png_read_end, (png_structp png_ptr, png_infop info_ptr));
1554
#endif
G
Guy Schalnat 已提交
1555

1556
/* Free any memory associated with the png_info_struct */
1557
PNG_EXPORT(63, void, png_destroy_info_struct, (png_structp png_ptr,
1558
    png_infopp info_ptr_ptr));
G
Guy Schalnat 已提交
1559

1560
/* Free any memory associated with the png_struct and the png_info_structs */
1561
PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr,
1562
    png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr));
G
Guy Schalnat 已提交
1563

1564
/* Free any memory associated with the png_struct and the png_info_structs */
1565
PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr,
1566
    png_infopp info_ptr_ptr));
G
Guy Schalnat 已提交
1567

1568
/* Set the libpng method of handling chunk CRC errors */
1569 1570
PNG_EXPORT(66, void, png_set_crc_action,
    (png_structp png_ptr, int crit_action, int ancil_action));
A
Andreas Dilger 已提交
1571

1572
/* Values for png_set_crc_action() say how to handle CRC errors in
A
Andreas Dilger 已提交
1573 1574
 * ancillary and critical chunks, and whether to use the data contained
 * therein.  Note that it is impossible to "discard" data in a critical
1575
 * chunk.  For versions prior to 0.90, the action was always error/quit,
A
Andreas Dilger 已提交
1576 1577 1578 1579
 * 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 已提交
1580 1581 1582 1583 1584 1585 1586 1587
 */
#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 已提交
1588 1589 1590 1591 1592
/* 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
1593 1594
 * header file (zlib.h) for an explination of the compression functions.
 */
A
Andreas Dilger 已提交
1595

1596
/* Set the filtering method(s) used by libpng.  Currently, the only valid
1597 1598
 * value for "method" is 0.
 */
1599 1600
PNG_EXPORT(67, void, png_set_filter,
    (png_structp png_ptr, int method, int filters));
G
Guy Schalnat 已提交
1601

A
Andreas Dilger 已提交
1602
/* Flags for png_set_filter() to say which filters to use.  The flags
A
Andreas Dilger 已提交
1603 1604 1605
 * 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 已提交
1606 1607 1608 1609 1610 1611 1612 1613 1614 1615
 */
#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 已提交
1616 1617 1618 1619 1620 1621 1622 1623 1624 1625
/* 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

1626
#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */
A
Andreas Dilger 已提交
1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654
/* 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.
 */
1655 1656
PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structp png_ptr,
    int heuristic_method, int num_weights, png_const_doublep filter_weights,
1657 1658
    png_const_doublep filter_costs));
PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed,
1659
    (png_structp png_ptr,
1660
    int heuristic_method, int num_weights, png_const_fixed_point_p
1661
    filter_weights, png_const_fixed_point_p filter_costs));
A
Andreas Dilger 已提交
1662 1663 1664 1665 1666 1667 1668 1669 1670 1671
#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 */

1672
#ifdef PNG_WRITE_SUPPORTED
A
Andreas Dilger 已提交
1673 1674 1675 1676
/* 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
1677
 * for PNG images, and do considerably fewer caclulations.  In the future,
A
Andreas Dilger 已提交
1678 1679
 * these values may not correspond directly to the zlib compression levels.
 */
1680 1681
PNG_EXPORT(69, void, png_set_compression_level,
    (png_structp png_ptr, int level));
G
Guy Schalnat 已提交
1682

1683
PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structp png_ptr,
1684
    int mem_level));
G
Guy Schalnat 已提交
1685

1686
PNG_EXPORT(71, void, png_set_compression_strategy, (png_structp png_ptr,
1687
    int strategy));
G
Guy Schalnat 已提交
1688

1689 1690 1691
/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
 * smaller value of window_bits if it can do so safely.
 */
1692
PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structp png_ptr,
1693
    int window_bits));
G
Guy Schalnat 已提交
1694

1695 1696
PNG_EXPORT(73, void, png_set_compression_method, (png_structp png_ptr,
    int method));
1697
#endif
G
Guy Schalnat 已提交
1698

1699
#ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED
1700 1701 1702 1703 1704 1705 1706 1707 1708 1709
/* 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));

1710 1711 1712
/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
 * smaller value of window_bits if it can do so safely.
 */
1713 1714 1715 1716 1717
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));
1718
#endif /* PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED */
1719

G
Guy Schalnat 已提交
1720
/* These next functions are called for input/output, memory, and error
1721
 * handling.  They are in the file pngrio.c, pngwio.c, and pngerror.c,
A
Andreas Dilger 已提交
1722 1723 1724
 * 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
1725
 * different manner by calling png_set_???_fn().  See libpng-manual.txt for
A
Andreas Dilger 已提交
1726 1727
 * more information.
 */
G
Guy Schalnat 已提交
1728

1729
#ifdef PNG_STDIO_SUPPORTED
A
Andreas Dilger 已提交
1730
/* Initialize the input/output for the PNG file to the default functions. */
1731
PNG_EXPORT(74, void, png_init_io, (png_structp png_ptr, png_FILE_p fp));
1732
#endif
G
Guy Schalnat 已提交
1733

A
Andreas Dilger 已提交
1734
/* Replace the (error and abort), and warning functions with user
A
Andreas Dilger 已提交
1735 1736 1737 1738 1739 1740
 * 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.
 */
1741

1742
PNG_EXPORT(75, void, png_set_error_fn,
1743
    (png_structp png_ptr, png_voidp error_ptr,
1744
    png_error_ptr error_fn, png_error_ptr warning_fn));
G
Guy Schalnat 已提交
1745

G
Guy Schalnat 已提交
1746
/* Return the user pointer associated with the error functions */
1747
PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structp png_ptr));
G
Guy Schalnat 已提交
1748 1749

/* Replace the default data output functions with a user supplied one(s).
A
Andreas Dilger 已提交
1750 1751 1752
 * 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).
1753 1754 1755 1756 1757
 * 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 已提交
1758
 */
1759
PNG_EXPORT(77, void, png_set_write_fn, (png_structp png_ptr, png_voidp io_ptr,
1760
    png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn));
G
Guy Schalnat 已提交
1761 1762

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

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

1769
PNG_EXPORT(80, void, png_set_read_status_fn, (png_structp png_ptr,
1770
    png_read_status_ptr read_row_fn));
1771

1772
PNG_EXPORT(81, void, png_set_write_status_fn, (png_structp png_ptr,
1773
    png_write_status_ptr write_row_fn));
1774

1775 1776
#ifdef PNG_USER_MEM_SUPPORTED
/* Replace the default memory allocation functions with user supplied one(s). */
1777
PNG_EXPORT(82, void, png_set_mem_fn, (png_structp png_ptr, png_voidp mem_ptr,
1778
    png_malloc_ptr malloc_fn, png_free_ptr free_fn));
1779
/* Return the user pointer associated with the memory functions */
1780
PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structp png_ptr));
1781
#endif
1782

1783
#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
1784
PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structp png_ptr,
1785
    png_user_transform_ptr read_user_transform_fn));
1786 1787
#endif

1788
#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
1789
PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structp png_ptr,
1790
    png_user_transform_ptr write_user_transform_fn));
1791 1792
#endif

1793
#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED
1794 1795
PNG_EXPORT(86, void, png_set_user_transform_info, (png_structp png_ptr,
    png_voidp user_transform_ptr, int user_transform_depth,
1796
    int user_transform_channels));
1797
/* Return the user pointer associated with the user transform functions */
1798
PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr,
1799 1800 1801 1802 1803 1804 1805
    (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
1806 1807 1808
 * 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.
1809
 *
1810 1811 1812
 * 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.)
1813 1814 1815
 */
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));
1816 1817
#endif

1818
#ifdef PNG_USER_CHUNKS_SUPPORTED
1819
PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structp png_ptr,
1820
    png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn));
1821
PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structp png_ptr));
1822 1823
#endif

G
Guy Schalnat 已提交
1824
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
A
Andreas Dilger 已提交
1825 1826 1827
/* Sets the function callbacks for the push reader, and a pointer to a
 * user-defined structure available to the callback functions.
 */
1828 1829
PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structp png_ptr,
    png_voidp progressive_ptr, png_progressive_info_ptr info_fn,
1830
    png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn));
G
Guy Schalnat 已提交
1831

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

1835
/* Function to be called when data becomes available */
1836
PNG_EXPORT(92, void, png_process_data,
1837
    (png_structp png_ptr, png_infop info_ptr,
1838
    png_bytep buffer, png_size_t buffer_size));
A
Andreas Dilger 已提交
1839

1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856
/* 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));

1857
#ifdef PNG_READ_INTERLACING_SUPPORTED
1858 1859 1860 1861
/* 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 已提交
1862
 */
1863
PNG_EXPORT(93, void, png_progressive_combine_row, (png_structp png_ptr,
1864
    png_bytep old_row, png_const_bytep new_row));
1865
#endif /* PNG_READ_INTERLACING_SUPPORTED */
G
Guy Schalnat 已提交
1866
#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */
G
Guy Schalnat 已提交
1867

1868
PNG_EXPORTA(94, png_voidp, png_malloc,
1869
    (png_structp png_ptr, png_alloc_size_t size),
1870
    PNG_ALLOCATED);
1871
/* Added at libpng version 1.4.0 */
1872
PNG_EXPORTA(95, png_voidp, png_calloc,
1873
    (png_structp png_ptr, png_alloc_size_t size),
1874
    PNG_ALLOCATED);
G
Guy Schalnat 已提交
1875

1876
/* Added at libpng version 1.2.4 */
1877
PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_structp png_ptr,
1878
    png_alloc_size_t size), PNG_ALLOCATED);
1879

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

1883
/* Free data that was allocated internally */
1884 1885 1886
PNG_EXPORT(98, void, png_free_data,
    (png_structp png_ptr, png_infop info_ptr, png_uint_32 free_me, int num));

1887 1888
/* Reassign responsibility for freeing existing data, whether allocated
 * by libpng or by the application */
1889 1890 1891
PNG_EXPORT(99, void, png_data_freer,
    (png_structp png_ptr, png_infop info_ptr, int freer, png_uint_32 mask));

1892
/* Assignments for png_data_freer */
1893 1894 1895 1896
#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 */
1897 1898 1899 1900
#define PNG_FREE_HIST 0x0008
#define PNG_FREE_ICCP 0x0010
#define PNG_FREE_SPLT 0x0020
#define PNG_FREE_ROWS 0x0040
1901 1902
#define PNG_FREE_PCAL 0x0080
#define PNG_FREE_SCAL 0x0100
1903 1904
#define PNG_FREE_UNKN 0x0200
#define PNG_FREE_LIST 0x0400
1905 1906 1907
#define PNG_FREE_PLTE 0x1000
#define PNG_FREE_TRNS 0x2000
#define PNG_FREE_TEXT 0x4000
1908
#define PNG_FREE_ALL  0x7fff
1909
#define PNG_FREE_MUL  0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
1910

1911
#ifdef PNG_USER_MEM_SUPPORTED
1912
PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_structp png_ptr,
1913 1914
    png_alloc_size_t size), PNG_ALLOCATED);
PNG_EXPORT(101, void, png_free_default, (png_structp png_ptr, png_voidp ptr));
1915
#endif
1916

1917
#ifdef PNG_ERROR_TEXT_SUPPORTED
A
Andreas Dilger 已提交
1918
/* Fatal error in PNG image of libpng - can't continue */
1919
PNG_EXPORTA(102, void, png_error,
1920
    (png_structp png_ptr, png_const_charp error_message),
1921
    PNG_NORETURN);
G
Guy Schalnat 已提交
1922

1923
/* The same, but the chunk name is prepended to the error string. */
1924
PNG_EXPORTA(103, void, png_chunk_error, (png_structp png_ptr,
1925
    png_const_charp error_message), PNG_NORETURN);
1926

1927 1928
#else
/* Fatal error in PNG image of libpng - can't continue */
1929
PNG_EXPORTA(104, void, png_err, (png_structp png_ptr), PNG_NORETURN);
1930 1931
#endif

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

1937
/* Non-fatal error in libpng, chunk name is prepended to message. */
1938
PNG_EXPORT(106, void, png_chunk_warning, (png_structp png_ptr,
1939
    png_const_charp warning_message));
1940
#endif
1941

1942 1943 1944
#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. */
1945
#  undef png_benign_error
1946
PNG_EXPORT(107, void, png_benign_error, (png_structp png_ptr,
1947
    png_const_charp warning_message));
1948 1949

/* Same, chunk name is prepended to message. */
1950
#  undef png_chunk_benign_error
1951
PNG_EXPORT(108, void, png_chunk_benign_error, (png_structp png_ptr,
1952
    png_const_charp warning_message));
1953

1954 1955
PNG_EXPORT(109, void, png_set_benign_errors,
    (png_structp png_ptr, int allowed));
1956 1957 1958 1959 1960 1961 1962 1963
#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
1964 1965
#endif

A
Andreas Dilger 已提交
1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
/* 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.
 */
1978
/* Returns "flag" if chunk data is valid in info_ptr. */
1979
PNG_EXPORT(110, png_uint_32, png_get_valid,
1980
    (png_const_structp png_ptr, png_const_infop info_ptr,
1981
    png_uint_32 flag));
A
Andreas Dilger 已提交
1982

1983
/* Returns number of bytes needed to hold a transformed row. */
1984
PNG_EXPORT(111, png_size_t, png_get_rowbytes, (png_const_structp png_ptr,
1985
    png_const_infop info_ptr));
A
Andreas Dilger 已提交
1986

1987
#ifdef PNG_INFO_IMAGE_SUPPORTED
1988
/* Returns row_pointers, which is an array of pointers to scanlines that was
1989 1990
 * returned from png_read_png().
 */
1991
PNG_EXPORT(112, png_bytepp, png_get_rows,
1992
    (png_const_structp png_ptr, png_const_infop info_ptr));
1993
/* Set row_pointers, which is an array of pointers to scanlines for use
1994 1995
 * by png_write_png().
 */
1996 1997
PNG_EXPORT(113, void, png_set_rows, (png_structp png_ptr,
    png_infop info_ptr, png_bytepp row_pointers));
1998 1999
#endif

2000
/* Returns number of color channels in image. */
2001
PNG_EXPORT(114, png_byte, png_get_channels,
2002
    (png_const_structp png_ptr, png_const_infop info_ptr));
A
Andreas Dilger 已提交
2003

2004 2005
#ifdef PNG_EASY_ACCESS_SUPPORTED
/* Returns image width in pixels. */
2006
PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structp png_ptr,
2007
    png_const_infop info_ptr));
2008 2009

/* Returns image height in pixels. */
2010
PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structp png_ptr,
2011
    png_const_infop info_ptr));
2012 2013

/* Returns image bit_depth. */
2014
PNG_EXPORT(117, png_byte, png_get_bit_depth,
2015
    (png_const_structp png_ptr, png_const_infop info_ptr));
2016 2017

/* Returns image color_type. */
2018
PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structp png_ptr,
2019
    png_const_infop info_ptr));
2020 2021

/* Returns image filter_type. */
2022
PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structp png_ptr,
2023
    png_const_infop info_ptr));
2024 2025

/* Returns image interlace_type. */
2026
PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structp png_ptr,
2027
    png_const_infop info_ptr));
2028 2029

/* Returns image compression_type. */
2030
PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structp png_ptr,
2031
    png_const_infop info_ptr));
2032 2033

/* Returns image resolution in pixels per meter, from pHYs chunk data. */
2034
PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter,
2035
    (png_const_structp png_ptr, png_const_infop info_ptr));
2036
PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter,
2037
    (png_const_structp png_ptr, png_const_infop info_ptr));
2038
PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter,
2039
    (png_const_structp png_ptr, png_const_infop info_ptr));
2040 2041

/* Returns pixel aspect ratio, computed from pHYs chunk data.  */
2042
PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio,
2043
    (png_const_structp png_ptr, png_const_infop info_ptr));
2044
PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed,
2045
    (png_const_structp png_ptr, png_const_infop info_ptr));
2046 2047

/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
2048
PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels,
2049
    (png_const_structp png_ptr, png_const_infop info_ptr));
2050
PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels,
2051
    (png_const_structp png_ptr, png_const_infop info_ptr));
2052
PNG_EXPORT(128, png_int_32, png_get_x_offset_microns,
2053
    (png_const_structp png_ptr, png_const_infop info_ptr));
2054
PNG_EXPORT(129, png_int_32, png_get_y_offset_microns,
2055
    (png_const_structp png_ptr, png_const_infop info_ptr));
2056 2057 2058

#endif /* PNG_EASY_ACCESS_SUPPORTED */

A
Andreas Dilger 已提交
2059
/* Returns pointer to signature string read from PNG header */
2060
PNG_EXPORT(130, png_const_bytep, png_get_signature,
2061
    (png_const_structp png_ptr, png_infop info_ptr));
A
Andreas Dilger 已提交
2062

2063
#ifdef PNG_bKGD_SUPPORTED
2064
PNG_EXPORT(131, png_uint_32, png_get_bKGD,
2065
    (png_const_structp png_ptr, png_infop info_ptr,
2066
    png_color_16p *background));
2067
#endif
A
Andreas Dilger 已提交
2068

2069
#ifdef PNG_bKGD_SUPPORTED
2070
PNG_EXPORT(132, void, png_set_bKGD, (png_structp png_ptr, png_infop info_ptr,
2071
    png_const_color_16p background));
2072
#endif
A
Andreas Dilger 已提交
2073

2074
#ifdef PNG_cHRM_SUPPORTED
2075 2076 2077
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,
2078
    double *blue_y));
2079 2080 2081 2082
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 已提交
2083
#ifdef PNG_FIXED_POINT_SUPPORTED /* Otherwise not implemented */
2084
PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed,
2085 2086 2087 2088 2089
    (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,
2090
    png_fixed_point *int_blue_y));
G
[devel]  
Glenn Randers-Pehrson 已提交
2091
#endif
2092 2093 2094 2095 2096 2097 2098
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));
2099
#endif
A
Andreas Dilger 已提交
2100

2101
#ifdef PNG_cHRM_SUPPORTED
2102
PNG_FP_EXPORT(135, void, png_set_cHRM,
2103 2104
    (png_structp png_ptr, png_infop info_ptr,
    double white_x, double white_y, double red_x, double red_y, double green_x,
2105
    double green_y, double blue_x, double blue_y));
2106 2107 2108 2109
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));
2110 2111 2112 2113 2114
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,
2115
    png_fixed_point int_blue_y));
2116 2117 2118 2119 2120 2121
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));
2122
#endif
A
Andreas Dilger 已提交
2123

2124
#ifdef PNG_gAMA_SUPPORTED
2125
PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA,
2126
    (png_const_structp png_ptr, png_const_infop info_ptr,
2127
    double *file_gamma));
2128
PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed,
2129
    (png_const_structp png_ptr, png_const_infop info_ptr,
2130
    png_fixed_point *int_file_gamma));
2131
#endif
G
Guy Schalnat 已提交
2132

2133
#ifdef PNG_gAMA_SUPPORTED
2134 2135
PNG_FP_EXPORT(139, void, png_set_gAMA, (png_structp png_ptr,
    png_infop info_ptr, double file_gamma));
2136
PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_structp png_ptr,
2137
    png_infop info_ptr, png_fixed_point int_file_gamma));
2138
#endif
A
Andreas Dilger 已提交
2139

2140
#ifdef PNG_hIST_SUPPORTED
2141
PNG_EXPORT(141, png_uint_32, png_get_hIST,
2142
    (png_const_structp png_ptr, png_const_infop info_ptr,
2143
    png_uint_16p *hist));
2144
#endif
A
Andreas Dilger 已提交
2145

2146
#ifdef PNG_hIST_SUPPORTED
2147 2148
PNG_EXPORT(142, void, png_set_hIST, (png_structp png_ptr,
    png_infop info_ptr, png_const_uint_16p hist));
2149
#endif
A
Andreas Dilger 已提交
2150

2151
PNG_EXPORT(143, png_uint_32, png_get_IHDR,
2152 2153
    (png_structp png_ptr, png_infop info_ptr,
    png_uint_32 *width, png_uint_32 *height, int *bit_depth, int *color_type,
2154
    int *interlace_method, int *compression_method, int *filter_method));
2155

2156
PNG_EXPORT(144, void, png_set_IHDR,
2157 2158
    (png_structp png_ptr, png_infop info_ptr,
    png_uint_32 width, png_uint_32 height, int bit_depth, int color_type,
2159
    int interlace_method, int compression_method, int filter_method));
A
Andreas Dilger 已提交
2160

2161
#ifdef PNG_oFFs_SUPPORTED
2162
PNG_EXPORT(145, png_uint_32, png_get_oFFs,
2163
    (png_const_structp png_ptr, png_const_infop info_ptr,
2164
    png_int_32 *offset_x, png_int_32 *offset_y, int *unit_type));
2165
#endif
A
Andreas Dilger 已提交
2166

2167
#ifdef PNG_oFFs_SUPPORTED
2168
PNG_EXPORT(146, void, png_set_oFFs,
2169
    (png_structp png_ptr, png_infop info_ptr,
2170
    png_int_32 offset_x, png_int_32 offset_y, int unit_type));
2171
#endif
A
Andreas Dilger 已提交
2172

2173
#ifdef PNG_pCAL_SUPPORTED
2174
PNG_EXPORT(147, png_uint_32, png_get_pCAL,
2175
    (png_const_structp png_ptr, png_const_infop info_ptr,
2176
    png_charp *purpose, png_int_32 *X0, png_int_32 *X1, int *type,
2177
    int *nparams,
2178
    png_charp *units, png_charpp *params));
2179
#endif
A
Andreas Dilger 已提交
2180

2181
#ifdef PNG_pCAL_SUPPORTED
2182
PNG_EXPORT(148, void, png_set_pCAL, (png_structp png_ptr,
2183 2184
    png_infop info_ptr,
    png_const_charp purpose, png_int_32 X0, png_int_32 X1, int type,
2185
    int nparams, png_const_charp units, png_charpp params));
2186 2187
#endif

2188
#ifdef PNG_pHYs_SUPPORTED
2189
PNG_EXPORT(149, png_uint_32, png_get_pHYs,
2190
    (png_const_structp png_ptr, png_const_infop info_ptr,
2191
    png_uint_32 *res_x, png_uint_32 *res_y, int *unit_type));
2192
#endif
A
Andreas Dilger 已提交
2193

2194
#ifdef PNG_pHYs_SUPPORTED
2195
PNG_EXPORT(150, void, png_set_pHYs,
2196
    (png_structp png_ptr, png_infop info_ptr,
2197
    png_uint_32 res_x, png_uint_32 res_y, int unit_type));
2198
#endif
A
Andreas Dilger 已提交
2199

2200
PNG_EXPORT(151, png_uint_32, png_get_PLTE,
2201
    (png_const_structp png_ptr, png_const_infop info_ptr,
2202
    png_colorp *palette, int *num_palette));
A
Andreas Dilger 已提交
2203

2204
PNG_EXPORT(152, void, png_set_PLTE,
2205
    (png_structp png_ptr, png_infop info_ptr,
2206
    png_const_colorp palette, int num_palette));
A
Andreas Dilger 已提交
2207

2208
#ifdef PNG_sBIT_SUPPORTED
2209
PNG_EXPORT(153, png_uint_32, png_get_sBIT,
2210
    (png_const_structp png_ptr, png_infop info_ptr,
2211
    png_color_8p *sig_bit));
2212
#endif
A
Andreas Dilger 已提交
2213

2214
#ifdef PNG_sBIT_SUPPORTED
2215 2216
PNG_EXPORT(154, void, png_set_sBIT,
    (png_structp png_ptr, png_infop info_ptr, png_const_color_8p sig_bit));
2217
#endif
A
Andreas Dilger 已提交
2218

2219
#ifdef PNG_sRGB_SUPPORTED
2220
PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structp png_ptr,
2221
    png_const_infop info_ptr, int *file_srgb_intent));
2222
#endif
2223

2224
#ifdef PNG_sRGB_SUPPORTED
2225
PNG_EXPORT(156, void, png_set_sRGB,
2226
    (png_structp png_ptr, png_infop info_ptr, int srgb_intent));
2227
PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_structp png_ptr,
2228
    png_infop info_ptr, int srgb_intent));
2229 2230
#endif

2231
#ifdef PNG_iCCP_SUPPORTED
2232
PNG_EXPORT(158, png_uint_32, png_get_iCCP,
2233 2234
    (png_const_structp png_ptr, png_const_infop info_ptr,
    png_charpp name, int *compression_type, png_bytepp profile,
2235
    png_uint_32 *proflen));
2236 2237
#endif

2238
#ifdef PNG_iCCP_SUPPORTED
2239
PNG_EXPORT(159, void, png_set_iCCP,
2240 2241
    (png_structp png_ptr, png_infop info_ptr,
    png_const_charp name, int compression_type, png_const_bytep profile,
2242
    png_uint_32 proflen));
2243 2244
#endif

2245
#ifdef PNG_sPLT_SUPPORTED
2246
PNG_EXPORT(160, png_uint_32, png_get_sPLT,
2247
    (png_const_structp png_ptr, png_const_infop info_ptr,
2248
    png_sPLT_tpp entries));
2249 2250
#endif

2251
#ifdef PNG_sPLT_SUPPORTED
2252
PNG_EXPORT(161, void, png_set_sPLT,
2253
    (png_structp png_ptr, png_infop info_ptr,
2254
    png_const_sPLT_tp entries, int nentries));
2255 2256
#endif

2257
#ifdef PNG_TEXT_SUPPORTED
2258
/* png_get_text also returns the number of text chunks in *num_text */
2259
PNG_EXPORT(162, png_uint_32, png_get_text,
2260
    (png_const_structp png_ptr, png_const_infop info_ptr,
2261
    png_textp *text_ptr, int *num_text));
2262
#endif
A
Andreas Dilger 已提交
2263

2264
/* Note while png_set_text() will accept a structure whose text,
2265 2266 2267 2268
 * 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.
2269 2270
 */

2271
#ifdef PNG_TEXT_SUPPORTED
2272
PNG_EXPORT(163, void, png_set_text,
2273
    (png_structp png_ptr, png_infop info_ptr,
2274
    png_const_textp text_ptr, int num_text));
2275
#endif
A
Andreas Dilger 已提交
2276

2277
#ifdef PNG_tIME_SUPPORTED
2278
PNG_EXPORT(164, png_uint_32, png_get_tIME,
2279
    (png_const_structp png_ptr, png_infop info_ptr, png_timep *mod_time));
2280
#endif
A
Andreas Dilger 已提交
2281

2282
#ifdef PNG_tIME_SUPPORTED
2283 2284
PNG_EXPORT(165, void, png_set_tIME,
    (png_structp png_ptr, png_infop info_ptr, png_const_timep mod_time));
2285
#endif
A
Andreas Dilger 已提交
2286

2287
#ifdef PNG_tRNS_SUPPORTED
2288
PNG_EXPORT(166, png_uint_32, png_get_tRNS,
2289
    (png_const_structp png_ptr, png_infop info_ptr,
2290
    png_bytep *trans_alpha, int *num_trans, png_color_16p *trans_color));
2291 2292
#endif

2293
#ifdef PNG_tRNS_SUPPORTED
2294
PNG_EXPORT(167, void, png_set_tRNS,
2295 2296
    (png_structp png_ptr, png_infop info_ptr,
    png_const_bytep trans_alpha, int num_trans,
2297
    png_const_color_16p trans_color));
2298 2299
#endif

2300
#ifdef PNG_sCAL_SUPPORTED
2301
PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL,
2302
    (png_const_structp png_ptr, png_const_infop info_ptr,
2303
    int *unit, double *width, double *height));
2304
#ifdef PNG_FLOATING_ARITHMETIC_SUPPORTED
2305
/* NOTE: this API is currently implemented using floating point arithmetic,
2306 2307 2308 2309
 * 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.
 */
2310
PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed,
2311
    (png_structp png_ptr, png_const_infop info_ptr, int *unit,
2312
    png_fixed_point *width,
2313 2314 2315
    png_fixed_point *height));
#endif
PNG_EXPORT(169, png_uint_32, png_get_sCAL_s,
2316
    (png_const_structp png_ptr, png_const_infop info_ptr,
2317
    int *unit, png_charpp swidth, png_charpp sheight));
2318 2319

PNG_FP_EXPORT(170, void, png_set_sCAL,
2320
    (png_structp png_ptr, png_infop info_ptr,
2321
    int unit, double width, double height));
2322 2323
PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_structp png_ptr,
   png_infop info_ptr, int unit, png_fixed_point width,
2324 2325
   png_fixed_point height));
PNG_EXPORT(171, void, png_set_sCAL_s,
2326
    (png_structp png_ptr, png_infop info_ptr,
2327
    int unit, png_const_charp swidth, png_const_charp sheight));
2328
#endif /* PNG_sCAL_SUPPORTED */
2329

2330 2331
#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
/* Provide a list of chunks and how they are to be handled, if the built-in
2332 2333
   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
2334 2335 2336 2337 2338 2339 2340
   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
2341
*/
2342
PNG_EXPORT(172, void, png_set_keep_unknown_chunks,
2343
    (png_structp png_ptr, int keep,
2344
    png_const_bytep chunk_list, int num_chunks));
2345 2346 2347 2348

/* The handling code is returned; the result is therefore true (non-zero) if
 * special handling is required, false for the default handling.
 */
2349
PNG_EXPORT(173, int, png_handle_as_unknown, (png_structp png_ptr,
2350
    png_const_bytep chunk_name));
2351
#endif
2352
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
2353
PNG_EXPORT(174, void, png_set_unknown_chunks, (png_structp png_ptr,
2354 2355 2356 2357
    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));
2358
PNG_EXPORT(176, int, png_get_unknown_chunks, (png_const_structp png_ptr,
2359
    png_const_infop info_ptr, png_unknown_chunkpp entries));
2360 2361
#endif

2362
/* Png_free_data() will turn off the "valid" flag for anything it frees.
2363
 * If you need to turn it off for a chunk that your application has freed,
2364 2365
 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
 */
2366 2367
PNG_EXPORT(177, void, png_set_invalid,
    (png_structp png_ptr, png_infop info_ptr, int mask));
2368

2369
#ifdef PNG_INFO_IMAGE_SUPPORTED
2370
/* The "params" pointer is currently not used and is for future expansion. */
2371
PNG_EXPORT(178, void, png_read_png, (png_structp png_ptr, png_infop info_ptr,
2372
    int transforms, png_voidp params));
2373
PNG_EXPORT(179, void, png_write_png, (png_structp png_ptr, png_infop info_ptr,
2374
    int transforms, png_voidp params));
2375 2376
#endif

2377
PNG_EXPORT(180, png_const_charp, png_get_copyright,
2378
    (png_const_structp png_ptr));
2379
PNG_EXPORT(181, png_const_charp, png_get_header_ver,
2380
    (png_const_structp png_ptr));
2381
PNG_EXPORT(182, png_const_charp, png_get_header_version,
2382
    (png_const_structp png_ptr));
2383
PNG_EXPORT(183, png_const_charp, png_get_libpng_ver,
2384
    (png_const_structp png_ptr));
2385

2386
#ifdef PNG_MNG_FEATURES_SUPPORTED
2387
PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structp png_ptr,
2388
    png_uint_32 mng_features_permitted));
2389 2390
#endif

2391 2392 2393 2394 2395 2396
/* 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

2397
/* Strip the prepended error numbers ("#nnn ") from error and warning
2398 2399
 * messages before passing them to the error or warning handler.
 */
2400
#ifdef PNG_ERROR_NUMBERS_SUPPORTED
2401
PNG_EXPORT(185, void, png_set_strip_error_numbers,
2402
    (png_structp png_ptr,
2403
    png_uint_32 strip_mode));
2404
#endif
2405

2406
/* Added in libpng-1.2.6 */
2407
#ifdef PNG_SET_USER_LIMITS_SUPPORTED
2408
PNG_EXPORT(186, void, png_set_user_limits, (png_structp png_ptr,
2409
    png_uint_32 user_width_max, png_uint_32 user_height_max));
2410
PNG_EXPORT(187, png_uint_32, png_get_user_width_max,
2411
    (png_const_structp png_ptr));
2412
PNG_EXPORT(188, png_uint_32, png_get_user_height_max,
2413
    (png_const_structp png_ptr));
2414
/* Added in libpng-1.4.0 */
2415
PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structp png_ptr,
2416
    png_uint_32 user_chunk_cache_max));
2417
PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max,
2418
    (png_const_structp png_ptr));
2419
/* Added in libpng-1.4.1 */
2420
PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structp png_ptr,
2421 2422
    png_alloc_size_t user_chunk_cache_max));
PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max,
2423
    (png_const_structp png_ptr));
2424 2425
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
2426
#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
2427
PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch,
2428
    (png_const_structp png_ptr, png_const_infop info_ptr));
2429

2430
PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch,
2431
    (png_const_structp png_ptr, png_const_infop info_ptr));
2432

2433
PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch,
2434
    (png_const_structp png_ptr, png_const_infop info_ptr));
2435

2436
PNG_FP_EXPORT(196, float, png_get_x_offset_inches,
2437
    (png_const_structp png_ptr, png_const_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2438
#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2439
PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed,
2440
    (png_structp png_ptr, png_const_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2441
#endif
2442

2443
PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_const_structp png_ptr,
2444
    png_const_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2445
#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2446
PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed,
2447
    (png_structp png_ptr, png_const_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2448
#endif
2449

2450
#  ifdef PNG_pHYs_SUPPORTED
2451
PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structp png_ptr,
2452
    png_const_infop info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
2453
    int *unit_type));
2454
#  endif /* PNG_pHYs_SUPPORTED */
G
[devel]  
Glenn Randers-Pehrson 已提交
2455
#endif  /* PNG_INCH_CONVERSIONS_SUPPORTED */
2456

2457 2458
/* Added in libpng-1.4.0 */
#ifdef PNG_IO_STATE_SUPPORTED
2459
PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_structp png_ptr));
2460

2461 2462
PNG_EXPORTA(200, png_const_bytep, png_get_io_chunk_name,
    (png_structp png_ptr), PNG_DEPRECATED);
2463
PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type,
2464
    (png_const_structp png_ptr));
2465 2466

/* The flags returned by png_get_io_state() are the following: */
2467 2468 2469 2470 2471 2472 2473 2474 2475
#  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 */
2476 2477
#endif /* ?PNG_IO_STATE_SUPPORTED */

2478 2479 2480 2481 2482 2483 2484 2485 2486 2487
/* 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.
 */
2488 2489 2490 2491 2492 2493 2494 2495 2496 2497
#define PNG_PASS_START_ROW(pass) (((1&~(pass))<<(3-((pass)>>1)))&7)
#define PNG_PASS_START_COL(pass) (((1& (pass))<<(3-(((pass)+1)>>1)))&7)

/* A macro to return the offset between pixels in the output row for a pair of
 * pixels in the input - effectively the inverse of the 'COL_SHIFT' macro that
 * follows.  Note that ROW_OFFSET is the offset from one row to the next whereas
 * COL_OFFSET is from one column to the next, within a row.
 */
#define PNG_PASS_ROW_OFFSET(pass) ((pass)>2?(8>>(((pass)-1)>>1)):8)
#define PNG_PASS_COL_OFFSET(pass) (1<<((7-(pass))>>1))
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515

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

2516 2517 2518
/* 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:
2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531
 */
#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) ( \
2532 2533
   ((0x110145AF>>(((7-(off))-(pass))<<2)) & 0xF) | \
   ((0x01145AF0>>(((7-(off))-(pass))<<2)) & 0xF0))
2534 2535 2536 2537 2538 2539

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

2540
#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
2541 2542 2543
/* 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
2544 2545 2546 2547 2548 2549 2550 2551 2552
 * 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. :-) ]
 */

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

2555 2556 2557 2558
#  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          \
2559
           - (png_uint_16)(alpha)) + 128);                \
2560
       (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
2561

2562 2563 2564
#  define png_composite_16(composite, fg, alpha, bg)       \
     { png_uint_32 temp = (png_uint_32)((png_uint_32)(fg)  \
           * (png_uint_32)(alpha)                          \
2565 2566
           + (png_uint_32)(bg)*(65535                      \
           - (png_uint_32)(alpha)) + 32768);               \
2567 2568
       (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }

2569
#else  /* Standard method using integer division */
2570

2571 2572
#  define png_composite(composite, fg, alpha, bg)                          \
     (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) +  \
2573
     (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) +       \
2574
     127) / 255)
2575 2576

#  define png_composite_16(composite, fg, alpha, bg)                         \
2577
     (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \
2578 2579
     (png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) +         \
     32767) / 65535)
2580 2581
#endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */

2582
#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
2583 2584 2585
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));
2586 2587
#endif

2588
PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_structp png_ptr,
2589
    png_const_bytep buf));
2590 2591
/* No png_get_int_16 -- may be added if there's a real need for it. */

2592
/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
2593
#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2594
PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i));
2595
#endif
2596
#ifdef PNG_SAVE_INT_32_SUPPORTED
2597
PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i));
2598
#endif
2599 2600

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

2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633
#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

2634 2635
/*******************************************************************************
 *  SIMPLIFIED API
2636 2637
 *******************************************************************************
 *
2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657
 * Please read the documentation in libpng-manual.txt if you don't understand
 * what follows.
 *
 * The simplified API hides the details of both libpng and the PNG file format
 * itself.  It allows PNG files to be read into a very limited number of
 * in-memory bitmap formats or to be written from the same formats.  If these
 * formats do not accomodate your needs then you can, and should, use the more
 * sophisticated APIs above - these support a wide variety of in-memory formats
 * and a wide variety of sophisticated transformations to those formats as well
 * as a wide variety of APIs to manipulate ancilliary information.
 *
 * To read a PNG file using the simplified API:
 *
 * 1) Declare a 'png_image' structure (see below) on the stack and memset() it
 * to all zero.
 * 2) Call the appropriate png_image_begin_read... function.
 * 3) Set the png_image 'format' member to the required format and allocate a
 * buffer for the image.
 * 4) Call png_image_finish_read to read the image into your buffer.
 *
2658 2659 2660 2661 2662
 * There are no restrictions on the format of the PNG input itself; all valid
 * color types, bit depths, and interlace methods are acceptable, and the
 * input image is transformed as necessary to the requested in-memory format
 * during the png_image_finish_read() step.
 *
2663 2664 2665 2666 2667 2668 2669 2670
 * To write a PNG file using the simplified API:
 *
 * 1) Declare a 'png_image' structure on the stack and memset() it to all zero.
 * 2) Initialize the members of the structure that describe the image, setting
 * the 'format' member to the format of the image in memory.
 * 3) Call the appropriate png_image_write... function with a pointer to the
 * image to write the PNG data.
 *
2671
 * png_image is a structure that describes the in-memory format of an image
2672 2673
 * when it is being read or define the in-memory format of an image that you
 * need to write:
2674
 *
2675
 */
2676

2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687
typedef struct png_control *png_controlp;
typedef struct
{
   png_uint_32  width;  /* Image width in pixels (columns) */
   png_uint_32  height; /* Image height in pixels (rows) */
   png_uint_32  format; /* Image format as defined below */
   png_uint_32  flags;  /* A bit mask containing informational flags */
   png_controlp opaque; /* Initialize to NULL, free with png_image_free */

   /* In the event of an error or warning the following field will be set to a
    * non-zero value and the 'message' field will contain a '\0' terminated
2688 2689 2690 2691 2692 2693 2694 2695
    * string with the libpng error or warning message.  If both warnings and
    * an error were encountered, only the error is recorded.  If there
    * are multiple warnings, only the first one is recorded.
    *
    * As of libpng-1.5.7 the values are
    *    0 - no warning or error
    *    1 - error
    *    2 - warning
2696 2697 2698 2699 2700
    */
   png_uint_32  warning_or_error;
   char         message[64];
} png_image, *png_imagep;

2701 2702
/* The pixels (samples) of the image have one to four channels whose components
 * have original values in the range 0 to 1.0:
2703 2704 2705 2706 2707 2708 2709 2710 2711
 *
 * 1: A single gray or luminance channel (G).
 * 2: A gray/luminance channel and an alpha channel (GA).
 * 3: Three red, green, blue color channels (RGB).
 * 4: Three color channels and an alpha channel (RGBA).
 *
 * The channels are encoded in one of two ways:
 *
 * a) As a small integer, value 0..255, contained in a (png_byte).  For the
2712
 * alpha channel the original value is simply value/255.  For the color or
2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726
 * luminance channels the value is encoded according to the sRGB specification
 * and matches the 8-bit format expected by typical display devices.
 *
 *    The color/gray channels are not scaled (pre-multiplied) by the alpha
 * channel and are suitable for passing to color management software.
 *
 * b) As a value in the range 0..65535, contained in a (png_uint_16).  All
 * channels can be converted to the original value by dividing by 65535; all
 * channels are linear.  Color channels use the RGB encoding (RGB end-points) of
 * the sRGB specification.  This encoding is identified by the
 * PNG_FORMAT_FLAG_LINEAR flag below.
 *
 *    When an alpha channel is present it is expected to denote pixel coverage
 * of the color or luminance channels and is returned as an associated alpha
2727 2728
 * channel: the color/gray channels are scaled (pre-multiplied) by the alpha
 * value.
2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744
 */

/* PNG_FORMAT_*
 *
 * #defines to be used in png_image::format.  Each #define identifies a
 * particular layout of channel data and, if present, alpha values.  There are
 * separate defines for each of the two channel encodings.
 *
 * A format is built up using single bit flag values.  Not all combinations are
 * valid: use the bit flag values below for testing a format returned by the
 * read APIs, but set formats from the derived values.
 *
 * NOTE: libpng can be built with particular features disabled, if you see
 * compiler errors because the definition of one of the following flags has been
 * compiled out it is because libpng does not have the required support.  It is
 * possible, however, for the libpng configuration to enable the format on just
2745 2746
 * read or just write; in that case you may see an error at run time.  You can
 * guard against this by checking for the definition of:
2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762
 *
 *    PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED
 */
#define PNG_FORMAT_FLAG_ALPHA    0x01 /* format with an alpha channel */
#define PNG_FORMAT_FLAG_COLOR    0x02 /* color format: otherwise grayscale */
#define PNG_FORMAT_FLAG_LINEAR   0x04 /* png_uint_16 channels else png_byte */

#ifdef PNG_FORMAT_BGR_SUPPORTED
#  define PNG_FORMAT_FLAG_BGR    0x08 /* BGR colors, else order is RGB */
#endif

#ifdef PNG_FORMAT_AFIRST_SUPPORTED
#  define PNG_FORMAT_FLAG_AFIRST 0x10 /* alpha channel comes first */
#endif

/* Supported formats are as follows.  Future versions of libpng may support more
2763
 * formats; for compatibility with older versions simply check if the format
2764 2765 2766 2767 2768 2769 2770
 * macro is defined using #ifdef.  These defines describe the in-memory layout
 * of the components of the pixels of the image.
 *
 * First the single byte formats:
 */
#define PNG_FORMAT_GRAY 0
#define PNG_FORMAT_GA   PNG_FORMAT_FLAG_ALPHA
2771
#define PNG_FORMAT_AG   (PNG_FORMAT_GA|PNG_FORMAT_FLAG_AFIRST)
2772 2773 2774 2775 2776 2777 2778 2779
#define PNG_FORMAT_RGB  PNG_FORMAT_FLAG_COLOR
#define PNG_FORMAT_BGR  (PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_BGR)
#define PNG_FORMAT_RGBA (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_ALPHA)
#define PNG_FORMAT_ARGB (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_AFIRST)
#define PNG_FORMAT_BGRA (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_ALPHA)
#define PNG_FORMAT_ABGR (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_AFIRST)

/* Then the linear (png_uint_16) formats.  When naming these "Y" is used to
2780 2781
 * indicate a luminance (gray) channel.  The component order within the pixel
 * is always the same - there is no provision for swapping the order of the
2782 2783
 * components in the linear format.
 */
2784 2785 2786 2787 2788
#define PNG_FORMAT_LINEAR_Y PNG_FORMAT_FLAG_LINEAR
#define PNG_FORMAT_LINEAR_Y_ALPHA (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_ALPHA)
#define PNG_FORMAT_LINEAR_RGB (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR)
#define PNG_FORMAT_LINEAR_RGB_ALPHA \
   (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA)
2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809

/* PNG_IMAGE macros
 *
 * These are convenience macros to derive information from a png_image structure
 */
#define PNG_IMAGE_CHANNELS(fmt)\
   (1+((fmt)&(PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA)))
   /* Return the total number of channels in a given format: 1..4 */

#define PNG_IMAGE_COMPONENT_SIZE(fmt)\
   (((fmt) & PNG_FORMAT_FLAG_LINEAR) ? sizeof (png_uint_16) : sizeof (png_byte))
   /* Return the size in bytes of a single component of a pixel in the image. */

#define PNG_IMAGE_PIXEL_SIZE(fmt)\
   (PNG_IMAGE_CHANNELS(fmt) * PNG_IMAGE_COMPONENT_SIZE(fmt))
   /* Return the size in bytes of a single pixel in the image. */
   
#define PNG_IMAGE_ROW_STRIDE(image)\
   (PNG_IMAGE_CHANNELS((image).format) * (image).width)
   /* Return the total number of components in a single row of the image; this
    * is the minimum 'row stride', the minimum count of components between each
2810 2811
    * row.
    */
2812 2813 2814 2815

#define PNG_IMAGE_BUFFER_SIZE(image, row_stride)\
   (PNG_IMAGE_COMPONENT_SIZE((image).format) * (image).height * (row_stride))
   /* Return the size, in bytes, of an image buffer given a png_image and a row
2816 2817
    * stride - the number of components to leave space for in each row.
    */
2818

2819 2820 2821 2822 2823 2824
#define PNG_IMAGE_SIZE(image)\
   PNG_IMAGE_BUFFER_SIZE(image, PNG_IMAGE_ROW_STRIDE(image))
   /* Return the size, in bytes, of the image in memory given just a png_image;
    * the row stride is the minimum stride required for the image.
    */

2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844
/* PNG_IMAGE_FLAG_*
 *
 * Flags containing additional information about the image are held in the
 * 'flags' field of png_image.
 */
#define PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB 1
   /* This indicates the the RGB values of the in-memory bitmap do not
    * correspond to the red, green and blue end-points defined by sRGB.
    */

#ifdef PNG_SIMPLIFIED_READ_SUPPORTED
/* READ APIs
 * ---------
 *
 * The png_image passed to the read APIs must have been initialized by setting
 * the png_controlp field 'opaque' to NULL (or, better, memset the whole thing.)
 */
#ifdef PNG_STDIO_SUPPORTED
PNG_EXPORT(234, int, png_image_begin_read_from_file, (png_imagep image,
   const char *file_name));
2845 2846
   /* The named file is opened for read and the image header is filled in
    * from the PNG header in the file.
2847
    */
2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862

PNG_EXPORT(235, int, png_image_begin_read_from_stdio, (png_imagep image,
   FILE* file));
   /* The PNG header is read from the stdio FILE object. */
#endif /* PNG_STDIO_SUPPORTED */

PNG_EXPORT(236, int, png_image_begin_read_from_memory, (png_imagep image,
   png_const_voidp memory, png_size_t size));
   /* The PNG header is read from the given memory buffer. */

PNG_EXPORT(237, int, png_image_finish_read, (png_imagep image,
   png_colorp background, void *buffer, png_int_32 row_stride));
   /* Finish reading the image into the supplied buffer and clean up the
    * png_image structure.
    *
2863
    * row_stride is the step, in png_byte or png_uint_16 units as appropriate,
2864 2865 2866 2867 2868 2869 2870 2871 2872 2873
    * between adjacent rows.  A positive stride indicates that the top-most row
    * is first in the buffer - the normal top-down arrangement.  A negative
    * stride indicates that the bottom-most row is first in the buffer.
    *
    * background need only be supplied if an alpha channel must be removed from
    * a png_byte format and the removal is to be done by compositing on a solid
    * color; otherwise it may be NULL and any composition will be done directly
    * onto the buffer.  The value is an sRGB color to use for the background,
    * for grayscale output the green channel is used.
    *
2874
    * For linear output removing the alpha channel is always done by compositing
2875 2876 2877 2878 2879
    * on black.
    */

PNG_EXPORT(238, void, png_image_free, (png_imagep image));
   /* Free any data allocated by libpng in image->opaque, setting the pointer to
2880 2881
    * NULL.  May be called at any time after the structure is initialized.
    */
2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914
#endif /* PNG_SIMPLIFIED_READ_SUPPORTED */

#ifdef PNG_SIMPLIFIED_WRITE_SUPPORTED
/* WRITE APIS
 * ----------
 * For write you must initialize a png_image structure to describe the image to
 * be written:
 *
 * opaque: must be initialized to NULL
 * width: image width in pixels
 * height: image height in rows
 * format: the format of the data you wish to write
 * flags: set to 0 unless one of the defined flags applies; set
 *    PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images where the RGB
 *    values do not correspond to the colors in sRGB.
 */
PNG_EXPORT(239, int, png_image_write_to_file, (png_imagep image,
   const char *file, int convert_to_8bit, const void *buffer,
   png_int_32 row_stride));
   /* Write the image to the named file. */

PNG_EXPORT(240, int, png_image_write_to_stdio, (png_imagep image, FILE *file,
   int convert_to_8_bit, const void *buffer, png_int_32 row_stride));
   /* Write the image to the given (FILE*). */

/* With all write APIs if image is in one of the linear formats with
 * (png_uint_16) data then setting convert_to_8_bit will cause the output to be
 * a (png_byte) PNG gamma encoded according to the sRGB specification, otherwise
 * a 16-bit linear encoded PNG file is written.
 *
 * With all APIs row_stride is handled as in the read APIs - it is the spacing
 * from one row to the next in component sized units (float) and if negative
 * indicates a bottom-up row layout in the buffer.
2915 2916 2917
 *
 * Note that the write API does not support interlacing, sub-8-bit pixels,
 * and indexed (paletted) images.
2918 2919 2920 2921 2922 2923
 */
#endif /* PNG_SIMPLIFIED_WRITE_SUPPORTED */
/*******************************************************************************
 *  END OF SIMPLIFIED API
 ******************************************************************************/

G
[devel]  
Glenn Randers-Pehrson 已提交
2924 2925 2926 2927
/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
 * defs
 */

2928
/* The last ordinal number (this is the *last* one already used; the next
2929 2930
 * one to use is one more than this.)  Maintainer, remember to add an entry to
 * scripts/symbols.def as well.
2931 2932
 */
#ifdef PNG_EXPORT_LAST_ORDINAL
2933
  PNG_EXPORT_LAST_ORDINAL(240);
2934 2935
#endif

A
Andreas Dilger 已提交
2936 2937 2938 2939
#ifdef __cplusplus
}
#endif

2940
#endif /* PNG_VERSION_INFO_ONLY */
2941
/* Do not put anything past this line */
2942
#endif /* PNG_H */