png.h 85.3 KB
Newer Older
1

A
Andreas Dilger 已提交
2
/* png.h - header file for PNG reference library
3
 *
4
 * libpng version 1.5.0beta41 - August 11, 2010
5
 * Copyright (c) 1998-2010 Glenn Randers-Pehrson
6 7
 * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)
 * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
8
 *
9
 * This code is released under the libpng license (See LICENSE, below)
10
 *
11
 * Authors and maintainers:
12 13
 *   libpng versions 0.71, May 1995, through 0.88, January 1996: Guy Schalnat
 *   libpng versions 0.89c, June 1996, through 0.96, May 1997: Andreas Dilger
14
 *   libpng versions 0.97, January 1998, through 1.5.0beta41 - August 11, 2010: Glenn
15
 *   See also "Contributing Authors", below.
16
 *
17
 * Note about libpng version numbers:
18
 *
19 20 21 22 23
 *   Due to various miscommunications, unforeseen code incompatibilities
 *   and occasional factors outside the authors' control, version numbering
 *   on the library has not always been consistent and straightforward.
 *   The following table summarizes matters since version 0.89c, which was
 *   the first widely used release:
24
 *
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
 *    source                 png.h  png.h  shared-lib
 *    version                string   int  version
 *    -------                ------ -----  ----------
 *    0.89c "1.0 beta 3"     0.89      89  1.0.89
 *    0.90  "1.0 beta 4"     0.90      90  0.90  [should have been 2.0.90]
 *    0.95  "1.0 beta 5"     0.95      95  0.95  [should have been 2.0.95]
 *    0.96  "1.0 beta 6"     0.96      96  0.96  [should have been 2.0.96]
 *    0.97b "1.00.97 beta 7" 1.00.97   97  1.0.1 [should have been 2.0.97]
 *    0.97c                  0.97      97  2.0.97
 *    0.98                   0.98      98  2.0.98
 *    0.99                   0.99      98  2.0.99
 *    0.99a-m                0.99      99  2.0.99
 *    1.00                   1.00     100  2.1.0 [100 should be 10000]
 *    1.0.0      (from here on, the   100  2.1.0 [100 should be 10000]
 *    1.0.1       png.h string is   10001  2.1.0
 *    1.0.1a-e    identical to the  10002  from here on, the shared library
 *    1.0.2       source version)   10002  is 2.V where V is the source code
 *    1.0.2a-b                      10003  version, except as noted.
 *    1.0.3                         10003
 *    1.0.3a-d                      10004
 *    1.0.4                         10004
 *    1.0.4a-f                      10005
 *    1.0.5 (+ 2 patches)           10005
 *    1.0.5a-d                      10006
 *    1.0.5e-r                      10100 (not source compatible)
 *    1.0.5s-v                      10006 (not binary compatible)
 *    1.0.6 (+ 3 patches)           10006 (still binary incompatible)
 *    1.0.6d-f                      10007 (still binary incompatible)
 *    1.0.6g                        10007
 *    1.0.6h                        10007  10.6h (testing xy.z so-numbering)
 *    1.0.6i                        10007  10.6i
 *    1.0.6j                        10007  2.1.0.6j (incompatible with 1.0.0)
57 58 59 60 61 62 63 64 65 66 67
 *    1.0.7beta11-14        DLLNUM  10007  2.1.0.7beta11-14 (binary compatible)
 *    1.0.7beta15-18           1    10007  2.1.0.7beta15-18 (binary compatible)
 *    1.0.7rc1-2               1    10007  2.1.0.7rc1-2 (binary compatible)
 *    1.0.7                    1    10007  (still compatible)
 *    1.0.8beta1-4             1    10008  2.1.0.8beta1-4
 *    1.0.8rc1                 1    10008  2.1.0.8rc1
 *    1.0.8                    1    10008  2.1.0.8
 *    1.0.9beta1-6             1    10009  2.1.0.9beta1-6
 *    1.0.9rc1                 1    10009  2.1.0.9rc1
 *    1.0.9beta7-10            1    10009  2.1.0.9beta7-10
 *    1.0.9rc2                 1    10009  2.1.0.9rc2
68
 *    1.0.9                    1    10009  2.1.0.9
69
 *    1.0.10beta1              1    10010  2.1.0.10beta1
70
 *    1.0.10rc1                1    10010  2.1.0.10rc1
71
 *    1.0.10                   1    10010  2.1.0.10
72
 *    1.0.11beta1-3            1    10011  2.1.0.11beta1-3
73
 *    1.0.11rc1                1    10011  2.1.0.11rc1
74
 *    1.0.11                   1    10011  2.1.0.11
75 76 77 78
 *    1.0.12beta1-2            2    10012  2.1.0.12beta1-2
 *    1.0.12rc1                2    10012  2.1.0.12rc1
 *    1.0.12                   2    10012  2.1.0.12
 *    1.1.0a-f                 -    10100  2.1.1.0a-f (branch abandoned)
79
 *    1.2.0beta1-2             2    10200  2.1.2.0beta1-2
80 81 82
 *    1.2.0beta3-5             3    10200  3.1.2.0beta3-5
 *    1.2.0rc1                 3    10200  3.1.2.0rc1
 *    1.2.0                    3    10200  3.1.2.0
83
 *    1.2.1beta1-4             3    10201  3.1.2.1beta1-4
84 85
 *    1.2.1rc1-2               3    10201  3.1.2.1rc1-2
 *    1.2.1                    3    10201  3.1.2.1
86
 *    1.2.2beta1-6            12    10202  12.so.0.1.2.2beta1-6
87 88 89
 *    1.0.13beta1             10    10013  10.so.0.1.0.13beta1
 *    1.0.13rc1               10    10013  10.so.0.1.0.13rc1
 *    1.2.2rc1                12    10202  12.so.0.1.2.2rc1
90 91
 *    1.0.13                  10    10013  10.so.0.1.0.13
 *    1.2.2                   12    10202  12.so.0.1.2.2
92 93
 *    1.2.3rc1-6              12    10203  12.so.0.1.2.3rc1-6
 *    1.2.3                   12    10203  12.so.0.1.2.3
94
 *    1.2.4beta1-3            13    10204  12.so.0.1.2.4beta1-3
95 96
 *    1.0.14rc1               13    10014  10.so.0.1.0.14rc1
 *    1.2.4rc1                13    10204  12.so.0.1.2.4rc1
97 98
 *    1.0.14                  10    10014  10.so.0.1.0.14
 *    1.2.4                   13    10204  12.so.0.1.2.4
99
 *    1.2.5beta1-2            13    10205  12.so.0.1.2.5beta1-2
100
 *    1.0.15rc1-3             10    10015  10.so.0.1.0.15rc1-3
101 102 103
 *    1.2.5rc1-3              13    10205  12.so.0.1.2.5rc1-3
 *    1.0.15                  10    10015  10.so.0.1.0.15
 *    1.2.5                   13    10205  12.so.0.1.2.5
104
 *    1.2.6beta1-4            13    10206  12.so.0.1.2.6beta1-4
105 106
 *    1.0.16                  10    10016  10.so.0.1.0.16
 *    1.2.6                   13    10206  12.so.0.1.2.6
107
 *    1.2.7beta1-2            13    10207  12.so.0.1.2.7beta1-2
108 109
 *    1.0.17rc1               10    10017  12.so.0.1.0.17rc1
 *    1.2.7rc1                13    10207  12.so.0.1.2.7rc1
110 111
 *    1.0.17                  10    10017  12.so.0.1.0.17
 *    1.2.7                   13    10207  12.so.0.1.2.7
112
 *    1.2.8beta1-5            13    10208  12.so.0.1.2.8beta1-5
113 114
 *    1.0.18rc1-5             10    10018  12.so.0.1.0.18rc1-5
 *    1.2.8rc1-5              13    10208  12.so.0.1.2.8rc1-5
115 116
 *    1.0.18                  10    10018  12.so.0.1.0.18
 *    1.2.8                   13    10208  12.so.0.1.2.8
117
 *    1.2.9beta1-3            13    10209  12.so.0.1.2.9beta1-3
118
 *    1.2.9beta4-11           13    10209  12.so.0.9[.0]
119
 *    1.2.9rc1                13    10209  12.so.0.9[.0]
120
 *    1.2.9                   13    10209  12.so.0.9[.0]
121
 *    1.2.10beta1-7           13    10210  12.so.0.10[.0]
122
 *    1.2.10rc1-2             13    10210  12.so.0.10[.0]
123
 *    1.2.10                  13    10210  12.so.0.10[.0]
124
 *    1.4.0beta1-5            14    10400  14.so.0.0[.0]
125
 *    1.2.11beta1-4           13    10211  12.so.0.11[.0]
126
 *    1.4.0beta7-8            14    10400  14.so.0.0[.0]
127 128
 *    1.2.11                  13    10211  12.so.0.11[.0]
 *    1.2.12                  13    10212  12.so.0.12[.0]
129
 *    1.4.0beta9-14           14    10400  14.so.0.0[.0]
130
 *    1.2.13                  13    10213  12.so.0.13[.0]
131
 *    1.4.0beta15-36          14    10400  14.so.0.0[.0]
132
 *    1.4.0beta37-87          14    10400  14.so.14.0[.0]
133
 *    1.4.0rc01               14    10400  14.so.14.0[.0]
134
 *    1.4.0beta88-109         14    10400  14.so.14.0[.0]
135
 *    1.4.0rc02-08            14    10400  14.so.14.0[.0]
136
 *    1.4.0                   14    10400  14.so.14.0[.0]
137 138
 *    1.4.1beta01-03          14    10401  14.so.14.1[.0]
 *    1.4.1rc01               14    10401  14.so.14.1[.0]
139
 *    1.4.1beta04-12          14    10401  14.so.14.1[.0]
140
 *    1.4.1                   14    10401  14.so.14.1[.0]
141 142
 *    1.4.2                   14    10402  14.so.14.2[.0]
 *    1.4.3                   14    10403  14.so.14.3[.0]
143
 *    1.5.0beta01-40          15    10500  15.so.15.0[.0]
144
 *
145 146 147 148 149 150 151 152 153
 *   Henceforth the source version will match the shared-library major
 *   and minor numbers; the shared-library major version number will be
 *   used for changes in backward compatibility, as it is intended.  The
 *   PNG_LIBPNG_VER macro, which is not used within libpng but is available
 *   for applications, is an unsigned integer of the form xyyzz corresponding
 *   to the source version x.y.z (leading zeros in y and z).  Beta versions
 *   were given the previous public release number plus a letter, until
 *   version 1.0.6j; from then on they were given the upcoming public
 *   release number plus "betaNN" or "rcN".
154
 *
155 156 157
 *   Binary incompatibility exists only when applications make direct access
 *   to the info_ptr or png_ptr members through png.h, and the compiled
 *   application is loaded with a different version of the library.
158
 *
159 160
 *   DLLNUM will change each time there are forward or backward changes
 *   in binary compatibility (e.g., when a new feature is added).
161
 *
162
 * See libpng.txt or libpng.3 for more information.  The PNG specification
163 164
 * is available as a W3C Recommendation and as an ISO Specification,
 * <http://www.w3.org/TR/2003/REC-PNG-20031110/
165 166 167
 */

/*
168 169
 * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
 *
170 171
 * If you modify libpng you may insert additional notices immediately following
 * this sentence.
172
 *
173 174
 * This code is released under the libpng license.
 *
175
 * libpng versions 1.2.6, August 15, 2004, through 1.5.0beta41, August 11, 2010, are
176
 * Copyright (c) 2004, 2006-2010 Glenn Randers-Pehrson, and are
177
 * distributed according to the same disclaimer and license as libpng-1.2.5
178
 * with the following individual added to the list of Contributing Authors:
179 180 181
 *
 *    Cosmin Truta
 *
182
 * libpng versions 1.0.7, July 1, 2000, through 1.2.5, October 3, 2002, are
183
 * Copyright (c) 2000-2002 Glenn Randers-Pehrson, and are
184
 * distributed according to the same disclaimer and license as libpng-1.0.6
185
 * with the following individuals added to the list of Contributing Authors:
186
 *
187 188 189 190
 *    Simon-Pierre Cadieux
 *    Eric S. Raymond
 *    Gilles Vollant
 *
191 192 193 194 195 196 197 198 199 200
 * and with the following additions to the disclaimer:
 *
 *    There is no warranty against interference with your enjoyment of the
 *    library or against infringement.  There is no warranty that our
 *    efforts or the library will fulfill any of your particular purposes
 *    or needs.  This library is provided with all faults, and the entire
 *    risk of satisfactory quality, performance, accuracy, and effort is with
 *    the user.
 *
 * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
201 202
 * Copyright (c) 1998, 1999, 2000 Glenn Randers-Pehrson, and are
 * distributed according to the same disclaimer and license as libpng-0.96,
203 204 205 206 207 208 209 210 211 212
 * with the following individuals added to the list of Contributing Authors:
 *
 *    Tom Lane
 *    Glenn Randers-Pehrson
 *    Willem van Schaik
 *
 * libpng versions 0.89, June 1996, through 0.96, May 1997, are
 * Copyright (c) 1996, 1997 Andreas Dilger
 * Distributed according to the same disclaimer and license as libpng-0.88,
 * with the following individuals added to the list of Contributing Authors:
213
 *
214 215
 *    John Bowler
 *    Kevin Bracey
216
 *    Sam Bushell
217 218
 *    Magnus Holmgren
 *    Greg Roelofs
219 220 221 222 223 224 225 226 227 228
 *    Tom Tanner
 *
 * libpng versions 0.5, May 1995, through 0.88, January 1996, are
 * Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.
 *
 * For the purposes of this copyright and license, "Contributing Authors"
 * is defined as the following set of individuals:
 *
 *    Andreas Dilger
 *    Dave Martindale
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
 *    Guy Eric Schalnat
 *    Paul Schmidt
 *    Tim Wegner
 *
 * The PNG Reference Library is supplied "AS IS".  The Contributing Authors
 * and Group 42, Inc. disclaim all warranties, expressed or implied,
 * including, without limitation, the warranties of merchantability and of
 * fitness for any purpose.  The Contributing Authors and Group 42, Inc.
 * assume no liability for direct, indirect, incidental, special, exemplary,
 * or consequential damages, which may result from the use of the PNG
 * Reference Library, even if advised of the possibility of such damage.
 *
 * Permission is hereby granted to use, copy, modify, and distribute this
 * source code, or portions hereof, for any purpose, without fee, subject
 * to the following restrictions:
244
 *
245
 *   1. The origin of this source code must not be misrepresented.
246
 *
247 248
 *   2. Altered versions must be plainly marked as such and must not
 *      be misrepresented as being the original source.
249
 *
250 251
 *   3. This Copyright notice may not be removed or altered from
 *      any source or altered source distribution.
252 253 254 255 256 257 258
 *
 * The Contributing Authors and Group 42, Inc. specifically permit, without
 * fee, and encourage the use of this source code as a component to
 * supporting the PNG file format in commercial products.  If you use this
 * source code in a product, acknowledgment is not required but would be
 * appreciated.
 */
G
Guy Schalnat 已提交
259

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

/*
271 272 273 274 275 276 277 278 279 280 281 282
 * Libpng is OSI Certified Open Source Software.  OSI Certified is a
 * certification mark of the Open Source Initiative.
 */

/*
 * The contributing authors would like to thank all those who helped
 * with testing, bug fixes, and patience.  This wouldn't have been
 * possible without all of you.
 *
 * Thanks to Frank J. T. Wojcik for helping with the documentation.
 */

283 284 285 286
/*
 * Y2K compliance in libpng:
 * =========================
 *
287
 *    August 11, 2010
288 289 290 291 292
 *
 *    Since the PNG Development group is an ad-hoc body, we can't make
 *    an official declaration.
 *
 *    This is your unofficial assurance that libpng from version 0.71 and
293
 *    upward through 1.5.0beta41 are Y2K compliant.  It is my belief that
G
[devel]  
Glenn Randers-Pehrson 已提交
294
 *    earlier versions were also Y2K compliant.
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
 *
 *    Libpng only has three year fields.  One is a 2-byte unsigned integer
 *    that will hold years up to 65535.  The other two hold the date in text
 *    format, and will hold years up to 9999.
 *
 *    The integer is
 *        "png_uint_16 year" in png_time_struct.
 *
 *    The strings are
 *        "png_charp time_buffer" in png_struct and
 *        "near_time_buffer", which is a local character string in png.c.
 *
 *    There are seven time-related functions:
 *        png.c: png_convert_to_rfc_1123() in png.c
 *          (formerly png_convert_to_rfc_1152() in error)
 *        png_convert_from_struct_tm() in pngwrite.c, called in pngwrite.c
 *        png_convert_from_time_t() in pngwrite.c
 *        png_get_tIME() in pngget.c
 *        png_handle_tIME() in pngrutil.c, called in pngread.c
 *        png_set_tIME() in pngset.c
 *        png_write_tIME() in pngwutil.c, called in pngwrite.c
 *
 *    All handle dates properly in a Y2K environment.  The
 *    png_convert_from_time_t() function calls gmtime() to convert from system
 *    clock time, which returns (year - 1900), which we properly convert to
 *    the full 4-digit year.  There is a possibility that applications using
 *    libpng are not passing 4-digit years into the png_convert_to_rfc_1123()
 *    function, or that they are incorrectly passing only a 2-digit year
 *    instead of "year - 1900" into the png_convert_from_struct_tm() function,
 *    but this is not under our control.  The libpng documentation has always
 *    stated that it works with 4-digit years, and the APIs have been
 *    documented as such.
 *
 *    The tIME chunk itself is also Y2K compliant.  It uses a 2-byte unsigned
 *    integer to hold the year, and can hold years as large as 65535.
 *
 *    zlib, upon which libpng depends, is also Y2K compliant.  It contains
 *    no date-related code.
 *
 *       Glenn Randers-Pehrson
 *       libpng maintainer
 *       PNG Development Group
 */

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

/* This is not the place to learn how to use libpng.  The file libpng.txt
A
Andreas Dilger 已提交
343 344 345 346
 * describes how to use libpng, and the file example.c summarizes it
 * with some code on which to build.  This file is useful for looking
 * at the actual function definitions and structure components.
 */
G
Guy Schalnat 已提交
347

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

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

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

364
#define PNG_LIBPNG_VER_BUILD  41
365

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

373 374 375 376 377 378 379
/* Release-Specific Flags */
#define PNG_LIBPNG_BUILD_PATCH    8 /* Can be OR'ed with
                                       PNG_LIBPNG_BUILD_STABLE only */
#define PNG_LIBPNG_BUILD_PRIVATE 16 /* Cannot be OR'ed with
                                       PNG_LIBPNG_BUILD_SPECIAL */
#define PNG_LIBPNG_BUILD_SPECIAL 32 /* Cannot be OR'ed with
                                       PNG_LIBPNG_BUILD_PRIVATE */
380

381
#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_BETA
382

383 384 385 386
/* Careful here.  At one time, Guy wanted to use 082, but that would be octal.
 * We must not include leading zeros.
 * Versions 0.7 through 1.0.0 were in the range 0 to 100 here (only
 * version 1.0.0 was mis-numbered 100 instead of 10000).  From
387 388
 * version 1.0.1 it's    xxyyzz, where x=major, y=minor, z=release
 */
389
#define PNG_LIBPNG_VER 10500 /* 1.5.0 */
390

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

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

G
[devel]  
Glenn Randers-Pehrson 已提交
404 405 406 407 408 409 410
/* Need the time information for converting tIME chunks, it
 * defines struct tm:
 */
#ifdef PNG_CONVERT_tIME_SUPPORTED
   /* "time.h" functions are not supported on all operating systems */
#  include <time.h>
#endif
G
Guy Schalnat 已提交
411

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

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

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

#ifndef PNG_VERSION_INFO_ONLY

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

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

454 455 456
/* This file is arranged in several sections:
 *
 * 1. Any configuration options that can be specified by for the application
457
 *    code when it is built.  (Build time configuration is in pnglibconf.h)
458 459 460 461 462 463 464 465
 * 2. Type definitions (base types are defined in pngconf.h), structure
 *    definitions.
 * 3. Exported library functions.
 *
 * The library source code has additional files (principally pngpriv.h) that
 * allow configuration of the library.
 */
/* Section 1: run time configuration
466
 * See pnglibconf.h for build time configuration
467 468 469
 *
 * Run time configuration allows the application to choose between
 * implementations of certain arithmetic APIs.  The default is set
470
 * at build time and recorded in pnglibconf.h, but it is safe to
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
 * override these (and only these) settings.  Note that this won't
 * change what the library does, only application code, and the
 * settings can (and probably should) be made on a per-file basis
 * by setting the #defines before including png.h
 *
 * Use macros to read integers from PNG data or use the exported
 * functions?
 *   PNG_USE_READ_MACROS: use the macros (see below)  Note that
 *     the macros evaluate their argument multiple times.
 *   PNG_NO_USE_READ_MACROS: call the relevant library function.
 *
 * Use the alternative algorithm for compositing alpha samples that
 * does not use division?
 *   PNG_READ_COMPOSITE_NODIV_SUPPORTED: use the 'no division'
 *      algorithm.
 *   PNG_NO_READ_COMPOSITE_NODIV: use the 'division' algorithm.
 *
 * How to handle benign errors if PNG_ALLOW_BENIGN_ERRORS is
 * false?
 *   PNG_ALLOW_BENIGN_ERRORS: map calls to the benign error
 *      APIs to png_warning.
 * Otherwise the calls are mapped to png_error.
 */

/* Section 2: type definitions, including structures and compile time
 * constants.
 * See pngconf.h for base types that vary by machine/system
 */
A
Andreas Dilger 已提交
499 500 501 502
/* 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 已提交
503 504
typedef struct png_color_struct
{
G
Guy Schalnat 已提交
505
   png_byte red;
G
Guy Schalnat 已提交
506 507 508
   png_byte green;
   png_byte blue;
} png_color;
A
Andreas Dilger 已提交
509 510
typedef png_color FAR * png_colorp;
typedef png_color FAR * FAR * png_colorpp;
G
Guy Schalnat 已提交
511 512 513

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

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

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

549 550 551 552 553
/*  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.
 */

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

#ifdef PNG_TEXT_SUPPORTED
565 566
/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,
 * and whether that contents is compressed or not.  The "key" field
567 568 569 570 571 572
 * points to a regular zero-terminated C string.  The "text", "lang", and
 * "lang_key" fields can be regular C strings, empty strings, or NULL pointers.
 * However, the * structure returned by png_get_text() will always contain
 * regular zero-terminated C strings (possibly empty), never NULL pointers,
 * so they can be safely used in printf() and other string-handling functions.
 */
G
Guy Schalnat 已提交
573 574
typedef struct png_text_struct
{
575 576 577 578 579
   int  compression;       /* compression value:
                             -1: tEXt, none
                              0: zTXt, deflate
                              1: iTXt, none
                              2: iTXt, deflate  */
A
Andreas Dilger 已提交
580
   png_charp key;          /* keyword, 1-79 character description of "text" */
581 582
   png_charp text;         /* comment, may be an empty string (ie "")
                              or a NULL pointer */
583 584
   png_size_t text_length; /* length of the text string */
   png_size_t itxt_length; /* length of the itxt string */
585 586
   png_charp lang;         /* language code, 0-79 characters
                              or a NULL pointer */
587
   png_charp lang_key;     /* keyword translated UTF-8 string, 0 or more
588
                              chars or a NULL pointer */
G
Guy Schalnat 已提交
589
} png_text;
A
Andreas Dilger 已提交
590 591
typedef png_text FAR * png_textp;
typedef png_text FAR * FAR * png_textpp;
592
#endif
A
Andreas Dilger 已提交
593 594 595 596 597 598 599

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

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

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

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

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

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

G
[devel]  
Glenn Randers-Pehrson 已提交
652 653 654 655 656 657
/* These are constants for fixed point values encoded in the
 * PNG specification manner (x100000)
 */
#define PNG_FP_1    100000
#define PNG_FP_HALF  50000

A
Andreas Dilger 已提交
658
/* These describe the color_type field in png_info. */
G
Guy Schalnat 已提交
659
/* color type masks */
A
Andreas Dilger 已提交
660 661 662
#define PNG_COLOR_MASK_PALETTE    1
#define PNG_COLOR_MASK_COLOR      2
#define PNG_COLOR_MASK_ALPHA      4
G
Guy Schalnat 已提交
663 664

/* color types.  Note that not all combinations are legal */
G
Guy Schalnat 已提交
665
#define PNG_COLOR_TYPE_GRAY 0
A
Andreas Dilger 已提交
666 667 668
#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 已提交
669
#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
670 671 672
/* aliases */
#define PNG_COLOR_TYPE_RGBA  PNG_COLOR_TYPE_RGB_ALPHA
#define PNG_COLOR_TYPE_GA  PNG_COLOR_TYPE_GRAY_ALPHA
G
Guy Schalnat 已提交
673

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

678
/* This is for filter type. PNG 1.0-1.2 only define the single type. */
A
Andreas Dilger 已提交
679
#define PNG_FILTER_TYPE_BASE      0 /* Single row per-byte filtering */
680
#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
A
Andreas Dilger 已提交
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
#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 */

700 701 702 703 704 705
/* 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 已提交
706 707 708 709 710
/* 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 */

711
/* These are for the sRGB chunk.  These values should NOT be changed. */
712 713 714 715
#define PNG_sRGB_INTENT_PERCEPTUAL 0
#define PNG_sRGB_INTENT_RELATIVE   1
#define PNG_sRGB_INTENT_SATURATION 2
#define PNG_sRGB_INTENT_ABSOLUTE   3
716
#define PNG_sRGB_INTENT_LAST       4 /* Not a valid value */
717

718 719
/* This is for text chunks */
#define PNG_KEYWORD_MAX_LENGTH     79
720

721
/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
722
#define PNG_MAX_PALETTE_LENGTH    256
723

A
Andreas Dilger 已提交
724 725 726 727 728
/* 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 已提交
729 730 731 732 733 734 735 736 737 738
#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 已提交
739
#define PNG_INFO_pCAL 0x0400
740
#define PNG_INFO_sRGB 0x0800   /* GR-P, 0.96a */
741 742 743
#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 */
744
#define PNG_INFO_IDAT 0x8000L  /* ESR, 1.0.6 */
G
Guy Schalnat 已提交
745

A
Andreas Dilger 已提交
746 747 748 749
/* 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 已提交
750 751
typedef struct png_row_info_struct
{
G
Guy Schalnat 已提交
752
   png_uint_32 width; /* width of row */
753
   png_size_t rowbytes; /* number of bytes in row */
G
Guy Schalnat 已提交
754 755 756 757
   png_byte color_type; /* color type of row */
   png_byte bit_depth; /* bit depth of row */
   png_byte channels; /* number of channels (1, 2, 3, or 4) */
   png_byte pixel_depth; /* bits per pixel (depth * channels) */
G
Guy Schalnat 已提交
758 759
} png_row_info;

A
Andreas Dilger 已提交
760 761
typedef png_row_info FAR * png_row_infop;
typedef png_row_info FAR * FAR * png_row_infopp;
G
Guy Schalnat 已提交
762

763 764 765 766 767
/* These are the function types for the I/O functions and for the functions
 * that allow the user to override the default I/O functions with his or her
 * own.  The png_error_ptr type should match that of user-supplied warning
 * and error functions, while the png_rw_ptr type should match that of the
 * user read/write data functions.
G
Guy Schalnat 已提交
768
 */
G
Guy Schalnat 已提交
769 770 771
typedef struct png_struct_def png_struct;
typedef png_struct FAR * png_structp;

772 773 774 775 776 777 778
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),);
779

G
Guy Schalnat 已提交
780
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
781 782 783 784 785
typedef PNG_CALLBACK(void, *png_progressive_info_ptr,
    (png_structp, png_infop),);
typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop),);
typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,
    png_uint_32, int),);
786
#endif
G
Guy Schalnat 已提交
787

788
#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
789
    defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
790 791
typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
    png_bytep),);
792
#endif
793

794
#ifdef PNG_USER_CHUNKS_SUPPORTED
795 796
typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
    png_unknown_chunkp),);
797
#endif
798
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
799
typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp),);
800
#endif
801 802 803
#ifdef PNG_SETJMP_SUPPORTED
/* This must match the function definition in <setjmp.h>, and the
 * application must include this before png.h to obtain the definition
804 805 806
 * of jmp_buf.  The function is required to be PNG_NORETURN.  (Note that
 * PNG_PTR_NORETURN is used here because current versions of the Microsoft
 * C compiler do not support the PNG_NORETURN attribute on a pointer.)
G
[devel]  
Glenn Randers-Pehrson 已提交
807 808 809 810 811 812 813 814 815 816 817
 *
 * If you get a type warning from the compiler when linking against this line
 * then your compiler has 'longjmp' that does not match the requirements of the
 * compiler that built libpng.  You will have to write a wrapper function for
 * your compiler's longjmp and call png_set_longjmp_fn directly (not via the
 * png_jmpbuf macro.)
 *
 * If you get a warning here while building the library you will need to make
 * changes to ensure that pnglibconf.h records the calling convention used by
 * your compiler.  This may be very difficult - try using a different compiler
 * to build the library!
818
 */
819 820
typedef PNG_FUNCTION(void,(PNGCAPI *png_longjmp_ptr),PNGARG((jmp_buf, int)),
   PNG_PTR_NORETURN);
821
#endif
822 823

/* Transform masks for the high-level interface */
824 825
#define PNG_TRANSFORM_IDENTITY       0x0000    /* read and write */
#define PNG_TRANSFORM_STRIP_16       0x0001    /* read only */
826 827
#define PNG_TRANSFORM_STRIP_ALPHA    0x0002    /* read only */
#define PNG_TRANSFORM_PACKING        0x0004    /* read and write */
828 829
#define PNG_TRANSFORM_PACKSWAP       0x0008    /* read and write */
#define PNG_TRANSFORM_EXPAND         0x0010    /* read only */
830
#define PNG_TRANSFORM_INVERT_MONO    0x0020    /* read and write */
831 832 833
#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 */
834
#define PNG_TRANSFORM_SWAP_ENDIAN    0x0200    /* read and write */
835
#define PNG_TRANSFORM_INVERT_ALPHA   0x0400    /* read and write */
836
#define PNG_TRANSFORM_STRIP_FILLER   0x0800    /* write only */
837
/* Added to libpng-1.2.34 */
838
#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
839 840 841
#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
/* Added to libpng-1.4.0 */
#define PNG_TRANSFORM_GRAY_TO_RGB   0x2000      /* read only */
842

843
/* Flags for MNG supported features */
844 845
#define PNG_FLAG_MNG_EMPTY_PLTE     0x01
#define PNG_FLAG_MNG_FILTER_64      0x04
846
#define PNG_ALL_MNG_FEATURES        0x05
847

848 849 850 851 852 853 854 855 856
/* NOTE: prior to 1.5 these functions had no 'API' style declaration,
 * this allowed the zlib default functions to be used on Windows
 * platforms.  In 1.5 the zlib default malloc (which just calls malloc and
 * ignores the first argument) should be completely compatible with the
 * following.
 */
typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,
    png_alloc_size_t),);
typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp),);
857

858 859
/* This triggers a compiler error in png.c, if png.c and png.h
 * do not agree upon the version number.
860
 */
861
typedef png_structp version_1_5_0beta41;
862

A
Andreas Dilger 已提交
863
typedef png_struct FAR * FAR * png_structpp;
G
Guy Schalnat 已提交
864

865 866
/* Section 3: exported functions
 * Here are the function definitions most commonly used.  This is not
A
Andreas Dilger 已提交
867 868
 * the place to find out how to use libpng.  See libpng.txt for the
 * full explanation, see example.c for the summary.  This just provides
869
 * a simple one line description of the use of each function.
A
Andreas Dilger 已提交
870
 */
G
Guy Schalnat 已提交
871

872
/* Returns the version number of the library */
873
PNG_EXPORT(png_uint_32,png_access_version_number,(void),,1);
874

A
Andreas Dilger 已提交
875
/* Tell lib we have already handled the first <num_bytes> magic bytes.
A
Andreas Dilger 已提交
876 877
 * Handling more than 8 bytes from the beginning of the file is an error.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
878
PNG_EXPORT(void,png_set_sig_bytes,(png_structp png_ptr, int num_bytes),,2);
A
Andreas Dilger 已提交
879 880 881 882 883 884

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

888 889 890 891 892
/* Simple signature checking function.  This is the same as calling
 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
 */
#define png_check_sig(sig,n) !png_sig_cmp((sig), 0, (n))

A
Andreas Dilger 已提交
893
/* Allocate and initialize png_ptr struct for reading, and any other memory. */
G
[devel]  
Glenn Randers-Pehrson 已提交
894 895 896
PNG_EXPORT(png_structp,png_create_read_struct,(png_const_charp user_png_ver,
    png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn),
    PNG_ALLOCATED,4);
A
Andreas Dilger 已提交
897

898
/* Allocate and initialize png_ptr struct for writing, and any other memory */
G
[devel]  
Glenn Randers-Pehrson 已提交
899 900 901
PNG_EXPORT(png_structp,png_create_write_struct,(png_const_charp user_png_ver,
    png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn),
    PNG_ALLOCATED,5);
G
Guy Schalnat 已提交
902

G
[devel]  
Glenn Randers-Pehrson 已提交
903
PNG_EXPORT(png_size_t,png_get_compression_buffer_size,(png_structp png_ptr),,6);
904

905
PNG_EXPORT(void,png_set_compression_buffer_size,(png_structp png_ptr,
906
    png_size_t size),,7);
907

908 909 910 911 912 913 914 915 916 917 918
/* 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.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
919
PNG_EXPORT(jmp_buf*,png_set_longjmp_fn,(png_structp png_ptr,
920
    png_longjmp_ptr longjmp_fn, size_t jmp_buf_size),,8);
921
#  define png_jmpbuf(png_ptr) \
922
      (*png_set_longjmp_fn((png_ptr), longjmp, sizeof (jmp_buf)))
923 924
#else
#  define png_jmpbuf(png_ptr) \
925
      (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
926
#endif
927 928 929 930 931
/* 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.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
932
PNG_EXPORT(void,png_longjmp,(png_structp png_ptr, int val),PNG_NORETURN,9);
933

934
#ifdef PNG_READ_SUPPORTED
935
/* Reset the compression stream */
936
PNG_EXPORT(int,png_reset_zstream,(png_structp png_ptr),,10);
937
#endif
938

939
/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
940
#ifdef PNG_USER_MEM_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
941 942 943 944 945 946 947 948
PNG_EXPORT(png_structp,png_create_read_struct_2,(png_const_charp user_png_ver,
    png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn,
    png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
    PNG_ALLOCATED,11);
PNG_EXPORT(png_structp,png_create_write_struct_2,(png_const_charp user_png_ver,
    png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn,
    png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
    PNG_ALLOCATED,12);
949 950
#endif

951
/* Write the PNG file signature. */
952
PNG_EXPORT(void,png_write_sig,(png_structp png_ptr),,13);
953

954
/* Write a PNG chunk - size, type, (optional) data, CRC. */
G
[devel]  
Glenn Randers-Pehrson 已提交
955 956
PNG_EXPORT(void,png_write_chunk,(png_structp png_ptr, png_bytep chunk_name,
    png_bytep data, png_size_t length),,14);
957 958

/* Write the start of a PNG chunk - length and chunk name. */
959
PNG_EXPORT(void,png_write_chunk_start,(png_structp png_ptr,
960
    png_bytep chunk_name, png_uint_32 length),,15);
961 962

/* Write the data of a PNG chunk started with png_write_chunk_start(). */
G
[devel]  
Glenn Randers-Pehrson 已提交
963 964
PNG_EXPORT(void,png_write_chunk_data,(png_structp png_ptr, png_bytep data,
    png_size_t length),,16);
965 966

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

A
Andreas Dilger 已提交
969
/* Allocate and initialize the info structure */
970
PNG_EXPORT(png_infop,png_create_info_struct,(png_structp png_ptr),
971
    PNG_ALLOCATED,18);
G
Guy Schalnat 已提交
972

973
PNG_EXPORT(void,png_info_init_3,(png_infopp info_ptr,
974
    png_size_t png_info_struct_size),,19);
G
Guy Schalnat 已提交
975

A
Andreas Dilger 已提交
976
/* Writes all the PNG information before the image. */
977
PNG_EXPORT(void,png_write_info_before_PLTE,(png_structp png_ptr,
978
    png_infop info_ptr),,20);
G
[devel]  
Glenn Randers-Pehrson 已提交
979
PNG_EXPORT(void,png_write_info,(png_structp png_ptr, png_infop info_ptr),,21);
G
Guy Schalnat 已提交
980

981
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
982
/* Read the information before the actual image data. */
G
[devel]  
Glenn Randers-Pehrson 已提交
983
PNG_EXPORT(void,png_read_info,(png_structp png_ptr, png_infop info_ptr),,22);
984
#endif
G
Guy Schalnat 已提交
985

986
#ifdef PNG_TIME_RFC1123_SUPPORTED
987
PNG_EXPORT(png_charp,png_convert_to_rfc1123,(png_structp png_ptr,
988
    png_timep ptime),,23);
989
#endif
990

991
#ifdef PNG_CONVERT_tIME_SUPPORTED
992
/* Convert from a struct tm to png_time */
993
PNG_EXPORT(void,png_convert_from_struct_tm,(png_timep ptime,
994
    struct tm FAR * ttime),,24);
G
Guy Schalnat 已提交
995

996
/* Convert from time_t to png_time.  Uses gmtime() */
G
[devel]  
Glenn Randers-Pehrson 已提交
997
PNG_EXPORT(void,png_convert_from_time_t,(png_timep ptime, time_t ttime),,25);
998
#endif /* PNG_CONVERT_tIME_SUPPORTED */
G
Guy Schalnat 已提交
999

1000
#ifdef PNG_READ_EXPAND_SUPPORTED
1001
/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
1002
PNG_EXPORT(void,png_set_expand,(png_structp png_ptr),,26);
G
[devel]  
Glenn Randers-Pehrson 已提交
1003
PNG_EXPORT(void,png_set_expand_gray_1_2_4_to_8,(png_structp png_ptr),,27);
1004 1005
PNG_EXPORT(void,png_set_palette_to_rgb,(png_structp png_ptr),,28);
PNG_EXPORT(void,png_set_tRNS_to_alpha,(png_structp png_ptr),,29);
1006
#endif
G
Guy Schalnat 已提交
1007

G
Guy Schalnat 已提交
1008
#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
G
Guy Schalnat 已提交
1009
/* Use blue, green, red order for pixels. */
1010
PNG_EXPORT(void,png_set_bgr,(png_structp png_ptr),,30);
1011
#endif
G
Guy Schalnat 已提交
1012

1013
#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
1014
/* Expand the grayscale to 24-bit RGB if necessary. */
1015
PNG_EXPORT(void,png_set_gray_to_rgb,(png_structp png_ptr),,31);
G
Guy Schalnat 已提交
1016

1017
/* Reduce RGB to grayscale. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1018 1019 1020
PNG_FP_EXPORT(void,png_set_rgb_to_gray,(png_structp png_ptr, int error_action,
    double red, double green ),,32);
PNG_FIXED_EXPORT(void,png_set_rgb_to_gray_fixed,(png_structp png_ptr,
1021
    int error_action, png_fixed_point red, png_fixed_point green),,33);
1022

G
[devel]  
Glenn Randers-Pehrson 已提交
1023
PNG_EXPORT(png_byte,png_get_rgb_to_gray_status,(png_structp png_ptr),,34);
1024
#endif
A
Andreas Dilger 已提交
1025

1026
PNG_EXPORT(void,png_build_grayscale_palette,(int bit_depth,
1027
    png_colorp palette),,35);
A
Andreas Dilger 已提交
1028

1029
#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
1030
PNG_EXPORT(void,png_set_strip_alpha,(png_structp png_ptr),,36);
1031
#endif
G
Guy Schalnat 已提交
1032

A
Andreas Dilger 已提交
1033 1034
#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
1035
PNG_EXPORT(void,png_set_swap_alpha,(png_structp png_ptr),,37);
1036
#endif
G
Guy Schalnat 已提交
1037

1038 1039
#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
1040
PNG_EXPORT(void,png_set_invert_alpha,(png_structp png_ptr),,38);
1041
#endif
1042

A
Andreas Dilger 已提交
1043
#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
1044
/* Add a filler byte to 8-bit Gray or 24-bit RGB images. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1045 1046
PNG_EXPORT(void,png_set_filler,(png_structp png_ptr, png_uint_32 filler,
    int flags),,39);
A
Andreas Dilger 已提交
1047
/* The values of the PNG_FILLER_ defines should NOT be changed */
1048 1049
#  define PNG_FILLER_BEFORE 0
#  define PNG_FILLER_AFTER 1
1050
/* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1051 1052
PNG_EXPORT(void,png_set_add_alpha,(png_structp png_ptr, png_uint_32 filler,
    int flags),,40);
A
Andreas Dilger 已提交
1053
#endif /* PNG_READ_FILLER_SUPPORTED || PNG_WRITE_FILLER_SUPPORTED */
G
Guy Schalnat 已提交
1054

G
Guy Schalnat 已提交
1055
#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
1056
/* Swap bytes in 16-bit depth files. */
1057
PNG_EXPORT(void,png_set_swap,(png_structp png_ptr),,41);
1058
#endif
G
Guy Schalnat 已提交
1059

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

1065 1066
#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
    defined(PNG_WRITE_PACKSWAP_SUPPORTED)
A
Andreas Dilger 已提交
1067
/* Swap packing order of pixels in bytes. */
1068
PNG_EXPORT(void,png_set_packswap,(png_structp png_ptr),,43);
1069
#endif
G
Guy Schalnat 已提交
1070

G
Guy Schalnat 已提交
1071
#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
G
Guy Schalnat 已提交
1072
/* Converts files to legal bit depths. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1073 1074
PNG_EXPORT(void,png_set_shift,(png_structp png_ptr, png_color_8p true_bits),,
    44);
1075
#endif
G
Guy Schalnat 已提交
1076

G
Guy Schalnat 已提交
1077 1078
#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
    defined(PNG_WRITE_INTERLACING_SUPPORTED)
G
[devel]  
Glenn Randers-Pehrson 已提交
1079 1080 1081 1082 1083
/* Have the code handle the interlacing.  Returns the number of passes.
 * 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.
 */
1084
PNG_EXPORT(int,png_set_interlace_handling,(png_structp png_ptr),,45);
1085
#endif
G
Guy Schalnat 已提交
1086

G
[devel]  
Glenn Randers-Pehrson 已提交
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
/* Alternatively call this to get the number of rows in the current pass.  Call
 * this after png_read_update_info or png_start_read_image; if you call it
 * before it will just return the image height (which is also what it returns
 * for a non-interlaced image!).
 *
 * NOTE: you need to call these to find out how many times to call png_read_row
 * if you handle your own de-interlacing.
 */
PNG_EXPORT(int,png_get_num_passes,(png_structp png_ptr),,215);
PNG_EXPORT(png_uint_32,png_get_num_rows,(png_structp png_ptr),,216);
1098
PNG_EXPORT(png_uint_32,png_get_num_cols,(png_structp png_ptr),,218);
G
[devel]  
Glenn Randers-Pehrson 已提交
1099 1100
#endif

G
Guy Schalnat 已提交
1101
#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
1102
/* Invert monochrome files */
1103
PNG_EXPORT(void,png_set_invert_mono,(png_structp png_ptr),,46);
1104
#endif
G
Guy Schalnat 已提交
1105

1106
#ifdef PNG_READ_BACKGROUND_SUPPORTED
G
Guy Schalnat 已提交
1107
/* Handle alpha and tRNS by replacing with a background color. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1108 1109 1110 1111 1112 1113 1114 1115
PNG_FP_EXPORT(void,png_set_background,(png_structp png_ptr,
    png_color_16p background_color, int background_gamma_code, int need_expand,
    double background_gamma),,47);
PNG_FIXED_EXPORT(void,png_set_background_fixed,(png_structp png_ptr,
    png_color_16p background_color, int background_gamma_code, int need_expand,
    png_fixed_point background_gamma),,217);
#endif
#ifdef PNG_READ_BACKGROUND_SUPPORTED
1116 1117 1118 1119
#  define PNG_BACKGROUND_GAMMA_UNKNOWN 0
#  define PNG_BACKGROUND_GAMMA_SCREEN  1
#  define PNG_BACKGROUND_GAMMA_FILE    2
#  define PNG_BACKGROUND_GAMMA_UNIQUE  3
1120
#endif
G
Guy Schalnat 已提交
1121

1122
#ifdef PNG_READ_16_TO_8_SUPPORTED
1123
/* Strip the second byte of information from a 16-bit depth file. */
1124
PNG_EXPORT(void,png_set_strip_16,(png_structp png_ptr),,48);
1125
#endif
G
Guy Schalnat 已提交
1126

1127 1128
#ifdef PNG_READ_QUANTIZE_SUPPORTED
/* Turn on quantizing, and reduce the palette to the number of colors
1129 1130
 * available.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1131 1132 1133
PNG_EXPORT(void,png_set_quantize,(png_structp png_ptr, png_colorp palette,
    int num_palette, int maximum_colors, png_uint_16p histogram,
    int full_quantize),,49);
1134
#endif
G
Guy Schalnat 已提交
1135

1136
#ifdef PNG_READ_GAMMA_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1137 1138 1139 1140 1141
/* 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)

1142
/* Handle gamma correction. Screen_gamma=(display_exponent) */
G
[devel]  
Glenn Randers-Pehrson 已提交
1143 1144 1145 1146
PNG_FP_EXPORT(void,png_set_gamma,(png_structp png_ptr, double screen_gamma,
    double default_file_gamma),,50);
PNG_FIXED_EXPORT(void,png_set_gamma_fixed,(png_structp png_ptr,
    png_fixed_point screen_gamma, png_fixed_point default_file_gamma),,208);
1147
#endif
G
Guy Schalnat 已提交
1148

1149

1150
#ifdef PNG_WRITE_FLUSH_SUPPORTED
G
Guy Schalnat 已提交
1151
/* Set how many lines between output flushes - 0 for no flushing */
1152
PNG_EXPORT(void,png_set_flush,(png_structp png_ptr, int nrows),,51);
G
Guy Schalnat 已提交
1153
/* Flush the current PNG output buffer */
1154
PNG_EXPORT(void,png_write_flush,(png_structp png_ptr),,52);
1155
#endif
G
Guy Schalnat 已提交
1156

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

1160
/* Optional call to update the users info structure */
G
[devel]  
Glenn Randers-Pehrson 已提交
1161 1162
PNG_EXPORT(void,png_read_update_info,(png_structp png_ptr, png_infop info_ptr),,
    54);
G
Guy Schalnat 已提交
1163

1164
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1165
/* Read one or more rows of image data. */
1166
PNG_EXPORT(void,png_read_rows,(png_structp png_ptr, png_bytepp row,
1167
    png_bytepp display_row, png_uint_32 num_rows),,55);
1168
#endif
G
Guy Schalnat 已提交
1169

1170
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1171
/* Read a row of data. */
1172
PNG_EXPORT(void,png_read_row,(png_structp png_ptr, png_bytep row,
1173
    png_bytep display_row),,56);
1174
#endif
G
Guy Schalnat 已提交
1175

1176
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1177
/* Read the whole image into memory at once. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1178
PNG_EXPORT(void,png_read_image,(png_structp png_ptr, png_bytepp image),,57);
1179
#endif
G
Guy Schalnat 已提交
1180

1181
/* Write a row of image data */
1182
PNG_EXPORT(void,png_write_row,(png_structp png_ptr, png_bytep row),,58);
G
Guy Schalnat 已提交
1183

1184
/* Write a few rows of image data */
G
[devel]  
Glenn Randers-Pehrson 已提交
1185 1186
PNG_EXPORT(void,png_write_rows,(png_structp png_ptr, png_bytepp row,
    png_uint_32 num_rows),,59);
G
Guy Schalnat 已提交
1187

1188
/* Write the image data */
G
[devel]  
Glenn Randers-Pehrson 已提交
1189
PNG_EXPORT(void,png_write_image,(png_structp png_ptr, png_bytepp image),,60);
G
Guy Schalnat 已提交
1190

1191
/* Write the end of the PNG file. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1192
PNG_EXPORT(void,png_write_end,(png_structp png_ptr, png_infop info_ptr),,61);
G
Guy Schalnat 已提交
1193

1194
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1195
/* Read the end of the PNG file. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1196
PNG_EXPORT(void,png_read_end,(png_structp png_ptr, png_infop info_ptr),,62);
1197
#endif
G
Guy Schalnat 已提交
1198

1199
/* Free any memory associated with the png_info_struct */
1200
PNG_EXPORT(void,png_destroy_info_struct,(png_structp png_ptr,
1201
    png_infopp info_ptr_ptr),,63);
G
Guy Schalnat 已提交
1202

1203
/* Free any memory associated with the png_struct and the png_info_structs */
1204
PNG_EXPORT(void,png_destroy_read_struct,(png_structpp png_ptr_ptr,
1205
    png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr),,64);
G
Guy Schalnat 已提交
1206

1207
/* Free any memory associated with the png_struct and the png_info_structs */
1208
PNG_EXPORT(void,png_destroy_write_struct,(png_structpp png_ptr_ptr,
1209
    png_infopp info_ptr_ptr),,65);
G
Guy Schalnat 已提交
1210

1211
/* Set the libpng method of handling chunk CRC errors */
G
[devel]  
Glenn Randers-Pehrson 已提交
1212 1213
PNG_EXPORT(void,png_set_crc_action,(png_structp png_ptr, int crit_action,
    int ancil_action),,66);
A
Andreas Dilger 已提交
1214 1215

/* Values for png_set_crc_action() to say how to handle CRC errors in
A
Andreas Dilger 已提交
1216 1217 1218 1219 1220 1221 1222
 * ancillary and critical chunks, and whether to use the data contained
 * therein.  Note that it is impossible to "discard" data in a critical
 * chunk.  For versions prior to 0.90, the action was always error/quit,
 * whereas in version 0.90 and later, the action for CRC errors in ancillary
 * chunks is warn/discard.  These values should NOT be changed.
 *
 *      value                       action:critical     action:ancillary
A
Andreas Dilger 已提交
1223 1224 1225 1226 1227 1228 1229 1230
 */
#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 已提交
1231 1232 1233 1234 1235
/* 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
1236 1237
 * header file (zlib.h) for an explination of the compression functions.
 */
A
Andreas Dilger 已提交
1238

1239
/* Set the filtering method(s) used by libpng.  Currently, the only valid
1240 1241
 * value for "method" is 0.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1242 1243
PNG_EXPORT(void,png_set_filter,(png_structp png_ptr, int method, int filters),,
    67);
G
Guy Schalnat 已提交
1244

A
Andreas Dilger 已提交
1245
/* Flags for png_set_filter() to say which filters to use.  The flags
A
Andreas Dilger 已提交
1246 1247 1248
 * 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 已提交
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
 */
#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 已提交
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
/* 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

1269
#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */
A
Andreas Dilger 已提交
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
/* 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.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1298
PNG_FP_EXPORT(void,png_set_filter_heuristics,(png_structp png_ptr,
1299
    int heuristic_method, int num_weights, png_doublep filter_weights,
1300
    png_doublep filter_costs),,68);
G
[devel]  
Glenn Randers-Pehrson 已提交
1301 1302 1303
PNG_FIXED_EXPORT(void,png_set_filter_heuristics_fixed,(png_structp png_ptr,
    int heuristic_method, int num_weights, png_fixed_point_p filter_weights,
    png_fixed_point_p filter_costs),,209);
A
Andreas Dilger 已提交
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
#endif /*  PNG_WRITE_WEIGHTED_FILTER_SUPPORTED */

/* Heuristic used for row filter selection.  These defines should NOT be
 * changed.
 */
#define PNG_FILTER_HEURISTIC_DEFAULT    0  /* Currently "UNWEIGHTED" */
#define PNG_FILTER_HEURISTIC_UNWEIGHTED 1  /* Used by libpng < 0.95 */
#define PNG_FILTER_HEURISTIC_WEIGHTED   2  /* Experimental feature */
#define PNG_FILTER_HEURISTIC_LAST       3  /* Not a valid value */

/* Set the library compression level.  Currently, valid values range from
 * 0 - 9, corresponding directly to the zlib compression levels 0 - 9
 * (0 - no compression, 9 - "maximal" compression).  Note that tests have
 * shown that zlib compression levels 3-6 usually perform as well as level 9
 * for PNG images, and do considerably fewer caclulations.  In the future,
 * these values may not correspond directly to the zlib compression levels.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1321
PNG_EXPORT(void,png_set_compression_level,(png_structp png_ptr, int level),,69);
G
Guy Schalnat 已提交
1322

1323
PNG_EXPORT(void,png_set_compression_mem_level,(png_structp png_ptr,
1324
    int mem_level),,70);
G
Guy Schalnat 已提交
1325

1326
PNG_EXPORT(void,png_set_compression_strategy,(png_structp png_ptr,
1327
    int strategy),,71);
G
Guy Schalnat 已提交
1328

1329
PNG_EXPORT(void,png_set_compression_window_bits,(png_structp png_ptr,
1330
    int window_bits),,72);
G
Guy Schalnat 已提交
1331

G
[devel]  
Glenn Randers-Pehrson 已提交
1332 1333
PNG_EXPORT(void,png_set_compression_method,(png_structp png_ptr, int method),,
    73);
G
Guy Schalnat 已提交
1334

G
Guy Schalnat 已提交
1335
/* These next functions are called for input/output, memory, and error
A
Andreas Dilger 已提交
1336 1337 1338 1339 1340 1341 1342
 * handling.  They are in the file pngrio.c, pngwio.c, and pngerror.c,
 * and call standard C I/O routines such as fread(), fwrite(), and
 * fprintf().  These functions can be made to use other I/O routines
 * at run time for those applications that need to handle I/O in a
 * different manner by calling png_set_???_fn().  See libpng.txt for
 * more information.
 */
G
Guy Schalnat 已提交
1343

1344
#ifdef PNG_STDIO_SUPPORTED
A
Andreas Dilger 已提交
1345
/* Initialize the input/output for the PNG file to the default functions. */
1346
PNG_EXPORT(void,png_init_io,(png_structp png_ptr, png_FILE_p fp),,74);
1347
#endif
G
Guy Schalnat 已提交
1348

A
Andreas Dilger 已提交
1349
/* Replace the (error and abort), and warning functions with user
A
Andreas Dilger 已提交
1350 1351 1352 1353 1354 1355
 * 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.
 */
1356

G
[devel]  
Glenn Randers-Pehrson 已提交
1357 1358
PNG_EXPORT(void,png_set_error_fn,(png_structp png_ptr, png_voidp error_ptr,
    png_error_ptr error_fn, png_error_ptr warning_fn),,75);
G
Guy Schalnat 已提交
1359

G
Guy Schalnat 已提交
1360
/* Return the user pointer associated with the error functions */
1361
PNG_EXPORT(png_voidp,png_get_error_ptr,(png_structp png_ptr),,76);
G
Guy Schalnat 已提交
1362 1363

/* Replace the default data output functions with a user supplied one(s).
A
Andreas Dilger 已提交
1364 1365 1366
 * 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).
1367 1368 1369 1370 1371
 * 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 已提交
1372
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1373 1374
PNG_EXPORT(void,png_set_write_fn,(png_structp png_ptr, png_voidp io_ptr,
    png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn),,77);
G
Guy Schalnat 已提交
1375 1376

/* Replace the default data input function with a user supplied one. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1377 1378
PNG_EXPORT(void,png_set_read_fn,(png_structp png_ptr, png_voidp io_ptr,
    png_rw_ptr read_data_fn),,78);
G
Guy Schalnat 已提交
1379 1380

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

1383
PNG_EXPORT(void,png_set_read_status_fn,(png_structp png_ptr,
1384
    png_read_status_ptr read_row_fn),,80);
1385

1386
PNG_EXPORT(void,png_set_write_status_fn,(png_structp png_ptr,
1387
    png_write_status_ptr write_row_fn),,81);
1388

1389 1390
#ifdef PNG_USER_MEM_SUPPORTED
/* Replace the default memory allocation functions with user supplied one(s). */
G
[devel]  
Glenn Randers-Pehrson 已提交
1391 1392
PNG_EXPORT(void,png_set_mem_fn,(png_structp png_ptr, png_voidp mem_ptr,
    png_malloc_ptr malloc_fn, png_free_ptr free_fn),,82);
1393
/* Return the user pointer associated with the memory functions */
1394
PNG_EXPORT(png_voidp,png_get_mem_ptr,(png_structp png_ptr),,83);
1395
#endif
1396

1397
#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
1398
PNG_EXPORT(void,png_set_read_user_transform_fn,(png_structp png_ptr,
1399
    png_user_transform_ptr read_user_transform_fn),,84);
1400 1401
#endif

1402
#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
1403
PNG_EXPORT(void,png_set_write_user_transform_fn,(png_structp png_ptr,
1404
    png_user_transform_ptr write_user_transform_fn),,85);
1405 1406
#endif

1407
#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
1408
    defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
1409
PNG_EXPORT(void,png_set_user_transform_info,(png_structp png_ptr,
1410 1411
    png_voidp user_transform_ptr, int user_transform_depth,
    int user_transform_channels),,86);
1412
/* Return the user pointer associated with the user transform functions */
G
[devel]  
Glenn Randers-Pehrson 已提交
1413
PNG_EXPORT(png_voidp,png_get_user_transform_ptr,(png_structp png_ptr),,87);
1414 1415
#endif

1416
#ifdef PNG_USER_CHUNKS_SUPPORTED
1417
PNG_EXPORT(void,png_set_read_user_chunk_fn,(png_structp png_ptr,
1418
    png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn),,88);
1419
PNG_EXPORT(png_voidp,png_get_user_chunk_ptr,(png_structp png_ptr),,89);
1420 1421
#endif

G
Guy Schalnat 已提交
1422
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
A
Andreas Dilger 已提交
1423 1424 1425
/* Sets the function callbacks for the push reader, and a pointer to a
 * user-defined structure available to the callback functions.
 */
1426
PNG_EXPORT(void,png_set_progressive_read_fn,(png_structp png_ptr,
1427 1428
    png_voidp progressive_ptr, png_progressive_info_ptr info_fn,
    png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn),,90);
G
Guy Schalnat 已提交
1429

1430
/* Returns the user pointer associated with the push read functions */
1431
PNG_EXPORT(png_voidp,png_get_progressive_ptr,(png_structp png_ptr),,91);
A
Andreas Dilger 已提交
1432

1433
/* Function to be called when data becomes available */
G
[devel]  
Glenn Randers-Pehrson 已提交
1434 1435
PNG_EXPORT(void,png_process_data,(png_structp png_ptr, png_infop info_ptr,
    png_bytep buffer, png_size_t buffer_size),,92);
A
Andreas Dilger 已提交
1436

1437
/* Function that combines rows.  Not very much different than the
A
Andreas Dilger 已提交
1438 1439
 * png_combine_row() call.  Is this even used?????
 */
1440
PNG_EXPORT(void,png_progressive_combine_row,(png_structp png_ptr,
1441
    png_bytep old_row, png_bytep new_row),,93);
G
Guy Schalnat 已提交
1442
#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */
G
Guy Schalnat 已提交
1443

G
[devel]  
Glenn Randers-Pehrson 已提交
1444 1445
PNG_EXPORT(png_voidp,png_malloc,(png_structp png_ptr, png_alloc_size_t size),
    PNG_ALLOCATED,94);
1446
/* Added at libpng version 1.4.0 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1447 1448
PNG_EXPORT(png_voidp,png_calloc,(png_structp png_ptr, png_alloc_size_t size),
    PNG_ALLOCATED,95);
G
Guy Schalnat 已提交
1449

1450
/* Added at libpng version 1.2.4 */
1451
PNG_EXPORT(png_voidp,png_malloc_warn,(png_structp png_ptr,
1452
    png_alloc_size_t size),PNG_ALLOCATED,96);
1453

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

1457
/* Free data that was allocated internally */
1458
PNG_EXPORT(void,png_free_data,(png_structp png_ptr, png_infop info_ptr,
1459
    png_uint_32 free_me, int num),,98);
1460 1461
/* Reassign responsibility for freeing existing data, whether allocated
 * by libpng or by the application */
1462
PNG_EXPORT(void,png_data_freer,(png_structp png_ptr, png_infop info_ptr,
1463
    int freer, png_uint_32 mask),,99);
1464
/* Assignments for png_data_freer */
1465 1466 1467 1468
#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 */
1469 1470 1471 1472
#define PNG_FREE_HIST 0x0008
#define PNG_FREE_ICCP 0x0010
#define PNG_FREE_SPLT 0x0020
#define PNG_FREE_ROWS 0x0040
1473 1474
#define PNG_FREE_PCAL 0x0080
#define PNG_FREE_SCAL 0x0100
1475 1476
#define PNG_FREE_UNKN 0x0200
#define PNG_FREE_LIST 0x0400
1477 1478 1479
#define PNG_FREE_PLTE 0x1000
#define PNG_FREE_TRNS 0x2000
#define PNG_FREE_TEXT 0x4000
1480
#define PNG_FREE_ALL  0x7fff
1481
#define PNG_FREE_MUL  0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
1482

1483
#ifdef PNG_USER_MEM_SUPPORTED
1484
PNG_EXPORT(png_voidp,png_malloc_default,(png_structp png_ptr,
1485
    png_alloc_size_t size),PNG_ALLOCATED,100);
G
[devel]  
Glenn Randers-Pehrson 已提交
1486
PNG_EXPORT(void,png_free_default,(png_structp png_ptr, png_voidp ptr),,101);
1487
#endif
1488

1489
#ifdef PNG_ERROR_TEXT_SUPPORTED
A
Andreas Dilger 已提交
1490
/* Fatal error in PNG image of libpng - can't continue */
G
[devel]  
Glenn Randers-Pehrson 已提交
1491 1492
PNG_EXPORT(void,png_error,(png_structp png_ptr, png_const_charp error_message),
    PNG_NORETURN,102);
G
Guy Schalnat 已提交
1493

1494
/* The same, but the chunk name is prepended to the error string. */
1495
PNG_EXPORT(void,png_chunk_error,(png_structp png_ptr,
1496
    png_const_charp error_message),PNG_NORETURN,103);
1497

1498 1499
#else
/* Fatal error in PNG image of libpng - can't continue */
1500
PNG_EXPORT(void,png_err,(png_structp png_ptr),PNG_NORETURN,104);
1501 1502
#endif

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

1507
/* Non-fatal error in libpng, chunk name is prepended to message. */
1508
PNG_EXPORT(void,png_chunk_warning,(png_structp png_ptr,
1509
    png_const_charp warning_message),,106);
1510

1511 1512 1513
#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. */
1514
#  undef png_benign_error
1515
PNG_EXPORT(void,png_benign_error,(png_structp png_ptr,
1516
    png_const_charp warning_message),,107);
1517 1518

/* Same, chunk name is prepended to message. */
1519
#  undef png_chunk_benign_error
1520
PNG_EXPORT(void,png_chunk_benign_error,(png_structp png_ptr,
1521
    png_const_charp warning_message),,108);
1522

G
[devel]  
Glenn Randers-Pehrson 已提交
1523
PNG_EXPORT(void,png_set_benign_errors,(png_structp png_ptr, int allowed),,109);
1524 1525 1526 1527 1528 1529 1530 1531
#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
1532 1533
#endif

A
Andreas Dilger 已提交
1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545
/* 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.
 */
1546
/* Returns "flag" if chunk data is valid in info_ptr. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1547 1548
PNG_EXPORT(png_uint_32,png_get_valid,(png_structp png_ptr, png_infop info_ptr,
    png_uint_32 flag),,110);
A
Andreas Dilger 已提交
1549

1550
/* Returns number of bytes needed to hold a transformed row. */
1551
PNG_EXPORT(png_size_t,png_get_rowbytes,(png_structp png_ptr,
1552
    png_infop info_ptr),,111);
A
Andreas Dilger 已提交
1553

1554
#ifdef PNG_INFO_IMAGE_SUPPORTED
1555
/* Returns row_pointers, which is an array of pointers to scanlines that was
1556 1557
 * returned from png_read_png().
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1558 1559
PNG_EXPORT(png_bytepp,png_get_rows,(png_structp png_ptr, png_infop info_ptr),,
    112);
1560
/* Set row_pointers, which is an array of pointers to scanlines for use
1561 1562
 * by png_write_png().
 */
1563
PNG_EXPORT(void,png_set_rows,(png_structp png_ptr, png_infop info_ptr,
1564
    png_bytepp row_pointers),,113);
1565 1566
#endif

1567
/* Returns number of color channels in image. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1568 1569
PNG_EXPORT(png_byte,png_get_channels,(png_structp png_ptr, png_infop info_ptr),,
    114);
A
Andreas Dilger 已提交
1570

1571 1572
#ifdef PNG_EASY_ACCESS_SUPPORTED
/* Returns image width in pixels. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1573
PNG_EXPORT(png_uint_32,png_get_image_width,(png_structp png_ptr,
1574
    png_infop info_ptr),,115);
1575 1576

/* Returns image height in pixels. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1577
PNG_EXPORT(png_uint_32,png_get_image_height,(png_structp png_ptr,
1578
    png_infop info_ptr),,116);
1579 1580

/* Returns image bit_depth. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1581 1582
PNG_EXPORT(png_byte,png_get_bit_depth,(png_structp png_ptr, png_infop info_ptr),
    ,117);
1583 1584

/* Returns image color_type. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1585
PNG_EXPORT(png_byte,png_get_color_type,(png_structp png_ptr,
1586
    png_infop info_ptr),,118);
1587 1588

/* Returns image filter_type. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1589
PNG_EXPORT(png_byte,png_get_filter_type,(png_structp png_ptr,
1590
    png_infop info_ptr),,119);
1591 1592

/* Returns image interlace_type. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1593
PNG_EXPORT(png_byte,png_get_interlace_type,(png_structp png_ptr,
1594
    png_infop info_ptr),,120);
1595 1596

/* Returns image compression_type. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1597
PNG_EXPORT(png_byte,png_get_compression_type,(png_structp png_ptr,
1598
    png_infop info_ptr),,121);
1599 1600

/* Returns image resolution in pixels per meter, from pHYs chunk data. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1601
PNG_EXPORT(png_uint_32,png_get_pixels_per_meter,(png_structp png_ptr,
1602
    png_infop info_ptr),,122);
G
[devel]  
Glenn Randers-Pehrson 已提交
1603 1604 1605 1606
PNG_EXPORT(png_uint_32,png_get_x_pixels_per_meter,(png_structp png_ptr,
    png_infop info_ptr),,123);
PNG_EXPORT(png_uint_32,png_get_y_pixels_per_meter,(png_structp png_ptr,
    png_infop info_ptr),,124);
1607 1608

/* Returns pixel aspect ratio, computed from pHYs chunk data.  */
G
[devel]  
Glenn Randers-Pehrson 已提交
1609 1610 1611 1612
PNG_FP_EXPORT(float,png_get_pixel_aspect_ratio,(png_structp png_ptr,
    png_infop info_ptr),,125);
PNG_FIXED_EXPORT(png_fixed_point,png_get_pixel_aspect_ratio_fixed,
    (png_structp png_ptr, png_infop info_ptr),,210);
1613 1614

/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1615 1616 1617 1618 1619 1620 1621 1622
PNG_EXPORT(png_int_32,png_get_x_offset_pixels,(png_structp png_ptr,
    png_infop info_ptr),,126);
PNG_EXPORT(png_int_32,png_get_y_offset_pixels,(png_structp png_ptr,
    png_infop info_ptr),,127);
PNG_EXPORT(png_int_32,png_get_x_offset_microns,(png_structp png_ptr,
    png_infop info_ptr),,128);
PNG_EXPORT(png_int_32, png_get_y_offset_microns,(png_structp png_ptr,
    png_infop info_ptr),,129);
1623 1624 1625

#endif /* PNG_EASY_ACCESS_SUPPORTED */

A
Andreas Dilger 已提交
1626
/* Returns pointer to signature string read from PNG header */
1627
PNG_EXPORT(png_bytep,png_get_signature,(png_structp png_ptr,
1628
    png_infop info_ptr),,130);
A
Andreas Dilger 已提交
1629

1630
#ifdef PNG_bKGD_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1631 1632
PNG_EXPORT(png_uint_32,png_get_bKGD,(png_structp png_ptr, png_infop info_ptr,
    png_color_16p *background),,131);
1633
#endif
A
Andreas Dilger 已提交
1634

1635
#ifdef PNG_bKGD_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1636 1637
PNG_EXPORT(void,png_set_bKGD,(png_structp png_ptr, png_infop info_ptr,
    png_color_16p background),,132);
1638
#endif
A
Andreas Dilger 已提交
1639

1640
#ifdef PNG_cHRM_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
PNG_FP_EXPORT(png_uint_32,png_get_cHRM,(png_structp png_ptr,
    png_infop info_ptr, double *white_x, double *white_y, double *red_x,
    double *red_y, double *green_x, double *green_y, double *blue_x,
    double *blue_y),,133);
#ifdef PNG_FIXED_POINT_SUPPORTED /* Otherwise not implemented */
PNG_FIXED_EXPORT(png_uint_32,png_get_cHRM_fixed,(png_structp png_ptr,
    png_infop info_ptr, png_fixed_point *int_white_x,
    png_fixed_point *int_white_y, png_fixed_point *int_red_x,
    png_fixed_point *int_red_y, png_fixed_point *int_green_x,
    png_fixed_point *int_green_y, png_fixed_point *int_blue_x,
    png_fixed_point *int_blue_y),,134);
#endif
1653
#endif
A
Andreas Dilger 已提交
1654

1655
#ifdef PNG_cHRM_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1656 1657 1658 1659 1660 1661 1662 1663 1664
PNG_FP_EXPORT(void,png_set_cHRM,(png_structp png_ptr, png_infop info_ptr,
    double white_x, double white_y, double red_x, double red_y, double green_x,
    double green_y, double blue_x, double blue_y),,135);
PNG_FIXED_EXPORT(void,png_set_cHRM_fixed,(png_structp png_ptr,
    png_infop info_ptr, png_fixed_point int_white_x,
    png_fixed_point int_white_y, png_fixed_point int_red_x,
    png_fixed_point int_red_y, png_fixed_point int_green_x,
    png_fixed_point int_green_y, png_fixed_point int_blue_x,
    png_fixed_point int_blue_y),,136);
1665
#endif
A
Andreas Dilger 已提交
1666

1667
#ifdef PNG_gAMA_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1668 1669 1670
PNG_FP_EXPORT(png_uint_32,png_get_gAMA,(png_structp png_ptr, png_infop info_ptr,
    double *file_gamma),,137);
PNG_FIXED_EXPORT(png_uint_32,png_get_gAMA_fixed,(png_structp png_ptr,
1671
    png_infop info_ptr, png_fixed_point *int_file_gamma),,138);
1672
#endif
G
Guy Schalnat 已提交
1673

1674
#ifdef PNG_gAMA_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1675 1676 1677
PNG_FP_EXPORT(void,png_set_gAMA,(png_structp png_ptr, png_infop info_ptr,
    double file_gamma),,139);
PNG_FIXED_EXPORT(void,png_set_gAMA_fixed,(png_structp png_ptr,
1678
    png_infop info_ptr, png_fixed_point int_file_gamma),,140);
1679
#endif
A
Andreas Dilger 已提交
1680

1681
#ifdef PNG_hIST_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1682 1683
PNG_EXPORT(png_uint_32,png_get_hIST,(png_structp png_ptr, png_infop info_ptr,
    png_uint_16p *hist),,141);
1684
#endif
A
Andreas Dilger 已提交
1685

1686
#ifdef PNG_hIST_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1687 1688
PNG_EXPORT(void,png_set_hIST,(png_structp png_ptr, png_infop info_ptr,
    png_uint_16p hist),,142);
1689
#endif
A
Andreas Dilger 已提交
1690

G
[devel]  
Glenn Randers-Pehrson 已提交
1691 1692 1693
PNG_EXPORT(png_uint_32,png_get_IHDR,(png_structp png_ptr, png_infop info_ptr,
    png_uint_32 *width, png_uint_32 *height, int *bit_depth, int *color_type,
    int *interlace_method, int *compression_method, int *filter_method),,143);
1694

G
[devel]  
Glenn Randers-Pehrson 已提交
1695 1696 1697
PNG_EXPORT(void,png_set_IHDR,(png_structp png_ptr, png_infop info_ptr,
    png_uint_32 width, png_uint_32 height, int bit_depth, int color_type,
    int interlace_method, int compression_method, int filter_method),,144);
A
Andreas Dilger 已提交
1698

1699
#ifdef PNG_oFFs_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1700 1701
PNG_EXPORT(png_uint_32,png_get_oFFs,(png_structp png_ptr, png_infop info_ptr,
    png_int_32 *offset_x, png_int_32 *offset_y, int *unit_type),,145);
1702
#endif
A
Andreas Dilger 已提交
1703

1704
#ifdef PNG_oFFs_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1705 1706
PNG_EXPORT(void,png_set_oFFs,(png_structp png_ptr, png_infop info_ptr,
    png_int_32 offset_x, png_int_32 offset_y, int unit_type),,146);
1707
#endif
A
Andreas Dilger 已提交
1708

1709
#ifdef PNG_pCAL_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1710 1711 1712
PNG_EXPORT(png_uint_32,png_get_pCAL,(png_structp png_ptr, png_infop info_ptr,
    png_charp *purpose, png_int_32 *X0, png_int_32 *X1, int *type, int *nparams,
    png_charp *units, png_charpp *params),,147);
1713
#endif
A
Andreas Dilger 已提交
1714

1715
#ifdef PNG_pCAL_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1716 1717 1718
PNG_EXPORT(void,png_set_pCAL,(png_structp png_ptr, png_infop info_ptr,
    png_charp purpose, png_int_32 X0, png_int_32 X1, int type, int nparams,
    png_charp units, png_charpp params),,148);
1719 1720
#endif

1721
#ifdef PNG_pHYs_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1722 1723
PNG_EXPORT(png_uint_32,png_get_pHYs,(png_structp png_ptr, png_infop info_ptr,
    png_uint_32 *res_x, png_uint_32 *res_y, int *unit_type),,149);
1724
#endif
A
Andreas Dilger 已提交
1725

1726
#ifdef PNG_pHYs_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1727 1728
PNG_EXPORT(void,png_set_pHYs,(png_structp png_ptr, png_infop info_ptr,
    png_uint_32 res_x, png_uint_32 res_y, int unit_type),,150);
1729
#endif
A
Andreas Dilger 已提交
1730

G
[devel]  
Glenn Randers-Pehrson 已提交
1731 1732
PNG_EXPORT(png_uint_32,png_get_PLTE,(png_structp png_ptr, png_infop info_ptr,
    png_colorp *palette, int *num_palette),,151);
A
Andreas Dilger 已提交
1733

G
[devel]  
Glenn Randers-Pehrson 已提交
1734 1735
PNG_EXPORT(void,png_set_PLTE,(png_structp png_ptr, png_infop info_ptr,
    png_colorp palette, int num_palette),,152);
A
Andreas Dilger 已提交
1736

1737
#ifdef PNG_sBIT_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1738 1739
PNG_EXPORT(png_uint_32,png_get_sBIT,(png_structp png_ptr, png_infop info_ptr,
    png_color_8p *sig_bit),,153);
1740
#endif
A
Andreas Dilger 已提交
1741

1742
#ifdef PNG_sBIT_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1743 1744
PNG_EXPORT(void,png_set_sBIT,(png_structp png_ptr, png_infop info_ptr,
    png_color_8p sig_bit),,154);
1745
#endif
A
Andreas Dilger 已提交
1746

1747
#ifdef PNG_sRGB_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1748 1749
PNG_EXPORT(png_uint_32,png_get_sRGB,(png_structp png_ptr, png_infop info_ptr,
    int *intent),,155);
1750
#endif
1751

1752
#ifdef PNG_sRGB_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1753 1754
PNG_EXPORT(void,png_set_sRGB,(png_structp png_ptr, png_infop info_ptr,
    int intent),,156);
1755
PNG_EXPORT(void,png_set_sRGB_gAMA_and_cHRM,(png_structp png_ptr,
1756
    png_infop info_ptr, int intent),,157);
1757 1758
#endif

1759
#ifdef PNG_iCCP_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1760 1761 1762
PNG_EXPORT(png_uint_32,png_get_iCCP,(png_structp png_ptr, png_infop info_ptr,
    png_charpp name, int *compression_type, png_bytepp profile,
    png_uint_32 *proflen),,158);
1763 1764
#endif

1765
#ifdef PNG_iCCP_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1766 1767 1768
PNG_EXPORT(void,png_set_iCCP,(png_structp png_ptr, png_infop info_ptr,
    png_charp name, int compression_type, png_bytep profile,
    png_uint_32 proflen),,159);
1769 1770
#endif

1771
#ifdef PNG_sPLT_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1772 1773
PNG_EXPORT(png_uint_32,png_get_sPLT,(png_structp png_ptr, png_infop info_ptr,
    png_sPLT_tpp entries),,160);
1774 1775
#endif

1776
#ifdef PNG_sPLT_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1777 1778
PNG_EXPORT(void,png_set_sPLT,(png_structp png_ptr, png_infop info_ptr,
    png_sPLT_tp entries, int nentries),,161);
1779 1780
#endif

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

1787 1788 1789 1790 1791
/* Note while png_set_text() will accept a structure whose text,
 * language, and  translated keywords are NULL pointers, the structure
 * returned by png_get_text will always contain regular
 * zero-terminated C strings.  They might be empty strings but
 * they will never be NULL pointers.
1792 1793
 */

1794
#ifdef PNG_TEXT_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1795 1796
PNG_EXPORT(void,png_set_text,(png_structp png_ptr, png_infop info_ptr,
    png_textp text_ptr, int num_text),,163);
1797
#endif
A
Andreas Dilger 已提交
1798

1799
#ifdef PNG_tIME_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1800 1801
PNG_EXPORT(png_uint_32,png_get_tIME,(png_structp png_ptr, png_infop info_ptr,
    png_timep *mod_time),,164);
1802
#endif
A
Andreas Dilger 已提交
1803

1804
#ifdef PNG_tIME_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1805 1806
PNG_EXPORT(void,png_set_tIME,(png_structp png_ptr, png_infop info_ptr,
    png_timep mod_time),,165);
1807
#endif
A
Andreas Dilger 已提交
1808

1809
#ifdef PNG_tRNS_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1810 1811
PNG_EXPORT(png_uint_32,png_get_tRNS,(png_structp png_ptr, png_infop info_ptr,
    png_bytep *trans_alpha, int *num_trans, png_color_16p *trans_color),,166);
1812 1813
#endif

1814
#ifdef PNG_tRNS_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1815 1816
PNG_EXPORT(void,png_set_tRNS,(png_structp png_ptr, png_infop info_ptr,
    png_bytep trans_alpha, int num_trans, png_color_16p trans_color),,167);
1817 1818
#endif

1819
#ifdef PNG_sCAL_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1820 1821
PNG_FP_EXPORT(png_uint_32,png_get_sCAL,(png_structp png_ptr, png_infop info_ptr,
    int *unit, double *width, double *height),,168);
1822 1823 1824 1825 1826 1827
#ifdef PNG_FLOATING_ARITHMETIC_SUPPORTED
/* NOTE: this API is currently implemented using floating point arithmetic,
 * 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.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1828 1829 1830
PNG_FIXED_EXPORT(png_uint_32,png_get_sCAL_fixed,(png_structp png_ptr,
    png_infop info_ptr, int *unit, png_fixed_point *width,
    png_fixed_point *height),,214);
1831
#endif
1832
PNG_EXPORT(png_uint_32,png_get_sCAL_s,(png_structp png_ptr,
G
[devel]  
Glenn Randers-Pehrson 已提交
1833 1834 1835 1836 1837 1838
    png_infop info_ptr, int *unit, png_charpp swidth, png_charpp sheight),,169);

PNG_FP_EXPORT(void,png_set_sCAL,(png_structp png_ptr, png_infop info_ptr,
    int unit, double width, double height),,170);
PNG_FIXED_EXPORT(void,png_set_sCAL_fixed,(png_structp png_ptr,
   png_infop info_ptr, int unit, png_fixed_point width,
1839
   png_fixed_point height),,213);
G
[devel]  
Glenn Randers-Pehrson 已提交
1840 1841
PNG_EXPORT(void,png_set_sCAL_s,(png_structp png_ptr, png_infop info_ptr,
    int unit, png_charp swidth, png_charp sheight),,171);
1842
#endif /* PNG_sCAL_SUPPORTED */
1843

1844 1845
#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
/* Provide a list of chunks and how they are to be handled, if the built-in
1846 1847 1848
   handling or default unknown chunk handling is not desired.  Any chunks not
   listed will be handled in the default manner.  The IHDR and IEND chunks
   must not be listed.
1849
      keep = 0: follow default behaviour
1850 1851 1852 1853
           = 1: do not keep
           = 2: keep only if safe-to-copy
           = 3: keep even if unsafe-to-copy
*/
G
[devel]  
Glenn Randers-Pehrson 已提交
1854 1855
PNG_EXPORT(void, png_set_keep_unknown_chunks,(png_structp png_ptr, int keep,
    png_bytep chunk_list, int num_chunks),,172);
1856
PNG_EXPORT(int,png_handle_as_unknown,(png_structp png_ptr,
G
[devel]  
Glenn Randers-Pehrson 已提交
1857
    png_const_bytep chunk_name),,173);
1858
#endif
1859
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
1860
PNG_EXPORT(void, png_set_unknown_chunks,(png_structp png_ptr,
G
[devel]  
Glenn Randers-Pehrson 已提交
1861 1862 1863
    png_infop info_ptr, png_unknown_chunkp unknowns, int num_unknowns),,174);
PNG_EXPORT(void, png_set_unknown_chunk_location, (png_structp png_ptr,
    png_infop info_ptr, int chunk, int location),,175);
1864
PNG_EXPORT(png_uint_32,png_get_unknown_chunks,(png_structp png_ptr,
1865
    png_infop info_ptr, png_unknown_chunkpp entries),,176);
1866 1867
#endif

1868
/* Png_free_data() will turn off the "valid" flag for anything it frees.
1869 1870 1871
 * If you need to turn it off for a chunk that your application has freed,
 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1872 1873
PNG_EXPORT(void, png_set_invalid,(png_structp png_ptr, png_infop info_ptr,
    int mask),,177);
1874

1875
#ifdef PNG_INFO_IMAGE_SUPPORTED
1876
/* The "params" pointer is currently not used and is for future expansion. */
G
[devel]  
Glenn Randers-Pehrson 已提交
1877 1878 1879 1880
PNG_EXPORT(void, png_read_png,(png_structp png_ptr, png_infop info_ptr,
    int transforms, png_voidp params),,178);
PNG_EXPORT(void, png_write_png,(png_structp png_ptr, png_infop info_ptr,
    int transforms, png_voidp params),,179);
1881 1882
#endif

1883 1884 1885 1886
PNG_EXPORT(png_charp,png_get_copyright,(png_structp png_ptr),,180);
PNG_EXPORT(png_charp,png_get_header_ver,(png_structp png_ptr),,181);
PNG_EXPORT(png_charp,png_get_header_version,(png_structp png_ptr),,182);
PNG_EXPORT(png_charp,png_get_libpng_ver,(png_structp png_ptr),,183);
1887

1888
#ifdef PNG_MNG_FEATURES_SUPPORTED
1889
PNG_EXPORT(png_uint_32,png_permit_mng_features,(png_structp png_ptr,
1890
    png_uint_32 mng_features_permitted),,184);
1891 1892
#endif

1893 1894 1895 1896 1897 1898
/* 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

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

1907
/* Added in libpng-1.2.6 */
1908
#ifdef PNG_SET_USER_LIMITS_SUPPORTED
1909
PNG_EXPORT(void,png_set_user_limits,(png_structp png_ptr,
1910
    png_uint_32 user_width_max, png_uint_32 user_height_max),,186);
G
[devel]  
Glenn Randers-Pehrson 已提交
1911 1912
PNG_EXPORT(png_uint_32,png_get_user_width_max,(png_structp png_ptr),,187);
PNG_EXPORT(png_uint_32,png_get_user_height_max,(png_structp png_ptr),,188);
1913
/* Added in libpng-1.4.0 */
1914
PNG_EXPORT(void,png_set_chunk_cache_max,(png_structp png_ptr,
1915
    png_uint_32 user_chunk_cache_max),,189);
G
[devel]  
Glenn Randers-Pehrson 已提交
1916
PNG_EXPORT(png_uint_32,png_get_chunk_cache_max,(png_structp png_ptr),,190);
1917
/* Added in libpng-1.4.1 */
1918
PNG_EXPORT(void,png_set_chunk_malloc_max,(png_structp png_ptr,
1919
    png_alloc_size_t user_chunk_cache_max),,191);
G
[devel]  
Glenn Randers-Pehrson 已提交
1920 1921
PNG_EXPORT(png_alloc_size_t,png_get_chunk_malloc_max,(png_structp png_ptr),,
    192);
1922 1923
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
1924
#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
1925 1926
PNG_EXPORT(png_uint_32,png_get_pixels_per_inch,(png_structp png_ptr,
    png_infop info_ptr),,193);
1927

1928 1929
PNG_EXPORT(png_uint_32,png_get_x_pixels_per_inch,(png_structp png_ptr,
    png_infop info_ptr),,194);
1930

1931 1932
PNG_EXPORT(png_uint_32,png_get_y_pixels_per_inch,(png_structp png_ptr,
    png_infop info_ptr),,195);
1933

G
[devel]  
Glenn Randers-Pehrson 已提交
1934
PNG_FP_EXPORT(float,png_get_x_offset_inches,(png_structp png_ptr,
1935
    png_infop info_ptr),,196);
G
[devel]  
Glenn Randers-Pehrson 已提交
1936 1937 1938 1939
#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
PNG_FIXED_EXPORT(png_fixed_point,png_get_x_offset_inches_fixed,
    (png_structp png_ptr, png_infop info_ptr),,211);
#endif
1940

G
[devel]  
Glenn Randers-Pehrson 已提交
1941
PNG_FP_EXPORT(float,png_get_y_offset_inches,(png_structp png_ptr,
1942
    png_infop info_ptr),,197);
G
[devel]  
Glenn Randers-Pehrson 已提交
1943 1944 1945 1946
#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
PNG_FIXED_EXPORT(png_fixed_point,png_get_y_offset_inches_fixed,
    (png_structp png_ptr, png_infop info_ptr),,212);
#endif
1947

1948
#  ifdef PNG_pHYs_SUPPORTED
1949
PNG_EXPORT(png_uint_32,png_get_pHYs_dpi,(png_structp png_ptr,
G
[devel]  
Glenn Randers-Pehrson 已提交
1950 1951
    png_infop info_ptr, png_uint_32 *res_x, png_uint_32 *res_y, int *unit_type),
    ,198);
1952
#  endif /* PNG_pHYs_SUPPORTED */
G
[devel]  
Glenn Randers-Pehrson 已提交
1953
#endif  /* PNG_INCH_CONVERSIONS_SUPPORTED */
1954

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

1959
PNG_EXPORT(png_bytep,png_get_io_chunk_name,(png_structp png_ptr),,200);
1960 1961

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

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

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

1988 1989 1990 1991 1992
#  define png_composite(composite, fg, alpha, bg)         \
     { png_uint_16 temp = (png_uint_16)((png_uint_16)(fg) \
           * (png_uint_16)(alpha)                         \
           + (png_uint_16)(bg)*(png_uint_16)(255          \
           - (png_uint_16)(alpha)) + (png_uint_16)128);   \
1993
       (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
1994

1995 1996 1997 1998 1999
#  define png_composite_16(composite, fg, alpha, bg)       \
     { png_uint_32 temp = (png_uint_32)((png_uint_32)(fg)  \
           * (png_uint_32)(alpha)                          \
           + (png_uint_32)(bg)*(png_uint_32)(65535L        \
           - (png_uint_32)(alpha)) + (png_uint_32)32768L); \
2000 2001
       (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }

2002
#else  /* Standard method using integer division */
2003

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

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

2015 2016 2017 2018
#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.
2019
 */
2020 2021 2022 2023 2024 2025 2026 2027
#  define png_get_uint_32(buf) \
     (((png_uint_32)(*(buf)) << 24) + \
      ((png_uint_32)(*((buf) + 1)) << 16) + \
      ((png_uint_32)(*((buf) + 2)) << 8) + \
      ((png_uint_32)(*((buf) + 3))))
#  define png_get_uint_16(buf) \
     (((png_uint_32)(*(buf)) << 8) + \
      ((png_uint_32)(*((buf) + 1))))
G
[devel]  
Glenn Randers-Pehrson 已提交
2028 2029
#  define png_get_int_32(buf) \
     ((png_int_32)((*(buf) & 0x80) \
2030 2031
      ? -((png_int_32)((png_get_uint_32(buf) ^ 0xffffffff)+1)) \
      : (png_int_32)png_get_uint_32(buf)))
2032
#endif
2033 2034

#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
2035 2036 2037
PNG_EXPORT(png_uint_32,png_get_uint_32,(png_bytep buf),,201);
PNG_EXPORT(png_uint_16,png_get_uint_16,(png_bytep buf),,202);
PNG_EXPORT(png_int_32,png_get_int_32,(png_bytep buf),,203);
2038 2039
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
2040 2041
PNG_EXPORT(png_uint_32,png_get_uint_31,(png_structp png_ptr, png_bytep buf),,
    204);
2042 2043
/* No png_get_int_16 -- may be added if there's a real need for it. */

2044
/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
2045
#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2046
PNG_EXPORT(void,png_save_uint_32,(png_bytep buf, png_uint_32 i),,205);
2047
#endif
2048
#ifdef PNG_SAVE_INT_32_SUPPORTED
2049
PNG_EXPORT(void,png_save_int_32,(png_bytep buf, png_int_32 i),,206);
2050
#endif
2051 2052 2053 2054 2055

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

G
[devel]  
Glenn Randers-Pehrson 已提交
2061 2062 2063 2064
/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
 * defs
 */

2065 2066 2067 2068
/* The last ordinal number (this is the *last* one, the next one to
 * use is one more than this.)
 */
#ifdef PNG_EXPORT_LAST_ORDINAL
2069
  PNG_EXPORT_LAST_ORDINAL(218);
2070 2071
#endif

A
Andreas Dilger 已提交
2072 2073 2074 2075
#ifdef __cplusplus
}
#endif

2076
#endif /* PNG_VERSION_INFO_ONLY */
2077
/* Do not put anything past this line */
2078
#endif /* PNG_H */