png.h 90.5 KB
Newer Older
1

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

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

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

/*
273 274 275 276 277 278 279 280 281 282 283 284
 * 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.
 */

285 286 287 288
/*
 * Y2K compliance in libpng:
 * =========================
 *
289
 *    December 27, 2010
290 291 292 293 294
 *
 *    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
295
 *    upward through 1.5.0rc02 are Y2K compliant.  It is my belief that
G
[devel]  
Glenn Randers-Pehrson 已提交
296
 *    earlier versions were also Y2K compliant.
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
 *
 *    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
325
 *    instead of "year - 1900" into the png_convert_from_struct_tm() function, 
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
 *    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
 */

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

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

350
/* Version information for png.h - this should match the version in png.c */
351
#define PNG_LIBPNG_VER_STRING "1.5.0rc02"
352
#define PNG_HEADER_VERSION_STRING \
353
     " libpng version 1.5.0rc02 - December 27, 2010\n"
354

355 356
#define PNG_LIBPNG_VER_SONUM   15
#define PNG_LIBPNG_VER_DLLNUM  15
357 358 359

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

366
#define PNG_LIBPNG_VER_BUILD  02
367

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

375 376 377 378 379 380 381
/* 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 */
382

383
#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_BETA
384

385 386 387 388
/* 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
389 390
 * version 1.0.1 it's    xxyyzz, where x=major, y=minor, z=release
 */
391
#define PNG_LIBPNG_VER 10500 /* 1.5.0 */
392

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

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

G
[devel]  
Glenn Randers-Pehrson 已提交
409 410 411 412 413 414 415
/* 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 已提交
416

417 418 419
/* Machine specific configuration. */
#  include "pngconf.h"
#endif
G
Guy Schalnat 已提交
420

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

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

#ifndef PNG_VERSION_INFO_ONLY

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

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

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

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

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

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

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

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

564 565 566 567 568
/*  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.
 */

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

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

/* 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
617 618 619
#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 已提交
620 621

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

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

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

662
typedef struct png_info_def png_info;
A
Andreas Dilger 已提交
663 664
typedef png_info FAR * png_infop;
typedef png_info FAR * FAR * png_infopp;
G
Guy Schalnat 已提交
665

666
/* Maximum positive integer used in PNG is (2^31)-1 */
667
#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
668 669
#define PNG_UINT_32_MAX ((png_uint_32)(-1))
#define PNG_SIZE_MAX ((png_size_t)(-1))
670

G
[devel]  
Glenn Randers-Pehrson 已提交
671 672 673 674 675 676
/* 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 已提交
677
/* These describe the color_type field in png_info. */
G
Guy Schalnat 已提交
678
/* color type masks */
A
Andreas Dilger 已提交
679 680 681
#define PNG_COLOR_MASK_PALETTE    1
#define PNG_COLOR_MASK_COLOR      2
#define PNG_COLOR_MASK_ALPHA      4
G
Guy Schalnat 已提交
682 683

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

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

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

719 720 721 722 723 724
/* 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 已提交
725 726 727 728 729
/* 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 */

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

737 738
/* This is for text chunks */
#define PNG_KEYWORD_MAX_LENGTH     79
739

740
/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
741
#define PNG_MAX_PALETTE_LENGTH    256
742

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

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

A
Andreas Dilger 已提交
779 780
typedef png_row_info FAR * png_row_infop;
typedef png_row_info FAR * FAR * png_row_infopp;
G
Guy Schalnat 已提交
781

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

793 794 795 796 797 798 799
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), );
800

G
Guy Schalnat 已提交
801
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
802 803
typedef PNG_CALLBACK(void, *png_progressive_info_ptr, 
    (png_structp, png_infop), );
804 805 806 807
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), );
808
#endif
G
Guy Schalnat 已提交
809

810
#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
811
    defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
812 813
typedef PNG_CALLBACK(void, *png_user_transform_ptr,
    (png_structp, png_row_infop, png_bytep), );
814
#endif
815

816
#ifdef PNG_USER_CHUNKS_SUPPORTED
817 818
typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp, 
    png_unknown_chunkp), );
819
#endif
820
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
821
typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp), );
822
#endif
823

824 825 826
#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
827 828 829
 * 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 已提交
830 831 832 833 834 835 836 837 838 839 840
 *
 * 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!
841
 */
842
typedef PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)), 
843
   PNG_PTR_NORETURN);
844
#endif
845 846

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

866
/* Flags for MNG supported features */
867 868
#define PNG_FLAG_MNG_EMPTY_PLTE     0x01
#define PNG_FLAG_MNG_FILTER_64      0x04
869
#define PNG_ALL_MNG_FEATURES        0x05
870

871
/* NOTE: prior to 1.5 these functions had no 'API' style declaration, 
872 873 874 875 876
 * 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.
 */
877 878 879
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), );
880

A
Andreas Dilger 已提交
881
typedef png_struct FAR * FAR * png_structpp;
G
Guy Schalnat 已提交
882

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

912
/* Returns the version number of the library */
913
PNG_EXPORT(1, png_uint_32, png_access_version_number, (void));
914

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

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

928 929 930
/* Simple signature checking function.  This is the same as calling
 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
 */
931
#define png_check_sig(sig, n) !png_sig_cmp((sig), 0, (n))
932

A
Andreas Dilger 已提交
933
/* Allocate and initialize png_ptr struct for reading, and any other memory. */
934 935 936
PNG_EXPORTA(4, png_structp, png_create_read_struct,
    (png_const_charp user_png_ver, png_voidp error_ptr,
    png_error_ptr error_fn, png_error_ptr warn_fn), 
937
    PNG_ALLOCATED);
A
Andreas Dilger 已提交
938

939
/* Allocate and initialize png_ptr struct for writing, and any other memory */
940 941 942
PNG_EXPORTA(5, png_structp, png_create_write_struct,
    (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
    png_error_ptr warn_fn), 
943
    PNG_ALLOCATED);
G
Guy Schalnat 已提交
944

945 946
PNG_EXPORT(6, png_size_t, png_get_compression_buffer_size,
    (png_structp png_ptr));
947

948
PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structp png_ptr, 
949
    png_size_t size));
950

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

978
#ifdef PNG_READ_SUPPORTED
979
/* Reset the compression stream */
980
PNG_EXPORT(10, int, png_reset_zstream, (png_structp png_ptr));
981
#endif
982

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

997
/* Write the PNG file signature. */
998
PNG_EXPORT(13, void, png_write_sig, (png_structp png_ptr));
999

1000
/* Write a PNG chunk - size, type, (optional) data, CRC. */
1001 1002
PNG_EXPORT(14, void, png_write_chunk, (png_structp png_ptr, png_const_bytep
    chunk_name, png_const_bytep data, png_size_t length));
1003 1004

/* Write the start of a PNG chunk - length and chunk name. */
1005 1006
PNG_EXPORT(15, void, png_write_chunk_start, (png_structp png_ptr, 
    png_const_bytep chunk_name, png_uint_32 length));
1007 1008

/* Write the data of a PNG chunk started with png_write_chunk_start(). */
1009 1010
PNG_EXPORT(16, void, png_write_chunk_data, (png_structp png_ptr,
    png_const_bytep data, png_size_t length));
1011 1012

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

A
Andreas Dilger 已提交
1015
/* Allocate and initialize the info structure */
1016 1017
PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_structp png_ptr), 
    PNG_ALLOCATED);
G
Guy Schalnat 已提交
1018

1019 1020
PNG_EXPORT(19, void, png_info_init_3, (png_infopp info_ptr, 
    png_size_t png_info_struct_size));
G
Guy Schalnat 已提交
1021

A
Andreas Dilger 已提交
1022
/* Writes all the PNG information before the image. */
1023 1024 1025 1026
PNG_EXPORT(20, void, png_write_info_before_PLTE,
    (png_structp png_ptr, png_infop info_ptr));
PNG_EXPORT(21, void, png_write_info,
    (png_structp png_ptr, png_infop info_ptr));
G
Guy Schalnat 已提交
1027

1028
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1029
/* Read the information before the actual image data. */
1030 1031
PNG_EXPORT(22, void, png_read_info,
    (png_structp png_ptr, png_infop info_ptr));
1032
#endif
G
Guy Schalnat 已提交
1033

1034
#ifdef PNG_TIME_RFC1123_SUPPORTED
1035 1036 1037
PNG_EXPORT(23, png_const_charp, png_convert_to_rfc1123,
    (png_structp png_ptr, 
    png_const_timep ptime));
1038
#endif
1039

1040
#ifdef PNG_CONVERT_tIME_SUPPORTED
1041
/* Convert from a struct tm to png_time */
1042 1043
PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime, 
    PNG_CONST struct tm FAR * ttime));
G
Guy Schalnat 已提交
1044

1045
/* Convert from time_t to png_time.  Uses gmtime() */
1046 1047
PNG_EXPORT(25, void, png_convert_from_time_t,
    (png_timep ptime, time_t ttime));
1048
#endif /* PNG_CONVERT_tIME_SUPPORTED */
G
Guy Schalnat 已提交
1049

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

G
Guy Schalnat 已提交
1058
#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
G
Guy Schalnat 已提交
1059
/* Use blue, green, red order for pixels. */
1060
PNG_EXPORT(30, void, png_set_bgr, (png_structp png_ptr));
1061
#endif
G
Guy Schalnat 已提交
1062

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

1067
/* Reduce RGB to grayscale. */
1068 1069 1070 1071
PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structp png_ptr,
    int error_action, double red, double green));
PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structp png_ptr, 
    int error_action, png_fixed_point red, png_fixed_point green));
1072

1073
PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_structp png_ptr));
1074
#endif
A
Andreas Dilger 已提交
1075

1076 1077
PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth, 
    png_colorp palette));
A
Andreas Dilger 已提交
1078

1079
#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
1080
PNG_EXPORT(36, void, png_set_strip_alpha, (png_structp png_ptr));
1081
#endif
G
Guy Schalnat 已提交
1082

A
Andreas Dilger 已提交
1083 1084
#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
1085
PNG_EXPORT(37, void, png_set_swap_alpha, (png_structp png_ptr));
1086
#endif
G
Guy Schalnat 已提交
1087

1088 1089
#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
    defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
1090
PNG_EXPORT(38, void, png_set_invert_alpha, (png_structp png_ptr));
1091
#endif
1092

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

G
Guy Schalnat 已提交
1106
#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
1107
/* Swap bytes in 16-bit depth files. */
1108
PNG_EXPORT(41, void, png_set_swap, (png_structp png_ptr));
1109
#endif
G
Guy Schalnat 已提交
1110

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

1116 1117
#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
    defined(PNG_WRITE_PACKSWAP_SUPPORTED)
A
Andreas Dilger 已提交
1118
/* Swap packing order of pixels in bytes. */
1119
PNG_EXPORT(43, void, png_set_packswap, (png_structp png_ptr));
1120
#endif
G
Guy Schalnat 已提交
1121

G
Guy Schalnat 已提交
1122
#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
G
Guy Schalnat 已提交
1123
/* Converts files to legal bit depths. */
1124 1125
PNG_EXPORT(44, void, png_set_shift, (png_structp png_ptr, png_const_color_8p
    true_bits));
1126
#endif
G
Guy Schalnat 已提交
1127

G
Guy Schalnat 已提交
1128 1129
#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
    defined(PNG_WRITE_INTERLACING_SUPPORTED)
G
[devel]  
Glenn Randers-Pehrson 已提交
1130
/* Have the code handle the interlacing.  Returns the number of passes.
1131 1132 1133 1134 1135
 * 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.
*/
1136
PNG_EXPORT(45, int, png_set_interlace_handling, (png_structp png_ptr));
1137
#endif
G
Guy Schalnat 已提交
1138

G
Guy Schalnat 已提交
1139
#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
1140
/* Invert monochrome files */
1141
PNG_EXPORT(46, void, png_set_invert_mono, (png_structp png_ptr));
1142
#endif
G
Guy Schalnat 已提交
1143

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

1160
#ifdef PNG_READ_16_TO_8_SUPPORTED
1161
/* Strip the second byte of information from a 16-bit depth file. */
1162
PNG_EXPORT(48, void, png_set_strip_16, (png_structp png_ptr));
1163
#endif
G
Guy Schalnat 已提交
1164

1165 1166
#ifdef PNG_READ_QUANTIZE_SUPPORTED
/* Turn on quantizing, and reduce the palette to the number of colors
1167 1168
 * available.
 */
1169 1170 1171 1172
PNG_EXPORT(49, void, png_set_quantize,
    (png_structp png_ptr, png_colorp palette, 
    int num_palette, int maximum_colors, png_const_uint_16p histogram, 
    int full_quantize));
1173
#endif
G
Guy Schalnat 已提交
1174

1175
#ifdef PNG_READ_GAMMA_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1176 1177 1178 1179 1180
/* 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)

1181
/* Handle gamma correction. Screen_gamma=(display_exponent) */
1182 1183 1184 1185 1186
PNG_FP_EXPORT(50, void, png_set_gamma,
    (png_structp png_ptr, double screen_gamma, 
    double default_file_gamma));
PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structp png_ptr, 
    png_fixed_point screen_gamma, png_fixed_point default_file_gamma));
1187
#endif
G
Guy Schalnat 已提交
1188

1189
#ifdef PNG_WRITE_FLUSH_SUPPORTED
G
Guy Schalnat 已提交
1190
/* Set how many lines between output flushes - 0 for no flushing */
1191
PNG_EXPORT(51, void, png_set_flush, (png_structp png_ptr, int nrows));
G
Guy Schalnat 已提交
1192
/* Flush the current PNG output buffer */
1193
PNG_EXPORT(52, void, png_write_flush, (png_structp png_ptr));
1194
#endif
G
Guy Schalnat 已提交
1195

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

1199
/* Optional call to update the users info structure */
1200 1201
PNG_EXPORT(54, void, png_read_update_info,
    (png_structp png_ptr, png_infop info_ptr));
G
Guy Schalnat 已提交
1202

1203
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1204
/* Read one or more rows of image data. */
1205 1206
PNG_EXPORT(55, void, png_read_rows, (png_structp png_ptr, png_bytepp row, 
    png_bytepp display_row, png_uint_32 num_rows));
1207
#endif
G
Guy Schalnat 已提交
1208

1209
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1210
/* Read a row of data. */
1211 1212
PNG_EXPORT(56, void, png_read_row, (png_structp png_ptr, png_bytep row, 
    png_bytep display_row));
1213
#endif
G
Guy Schalnat 已提交
1214

1215
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1216
/* Read the whole image into memory at once. */
1217
PNG_EXPORT(57, void, png_read_image, (png_structp png_ptr, png_bytepp image));
1218
#endif
G
Guy Schalnat 已提交
1219

1220
/* Write a row of image data */
1221 1222
PNG_EXPORT(58, void, png_write_row,
    (png_structp png_ptr, png_const_bytep row));
G
Guy Schalnat 已提交
1223

1224 1225 1226
/* Write a few rows of image data: (*row) is not written; however, the type
 * is declared as writeable to maintain compatibility with previous versions
 * of libpng and to allow the 'display_row' array from read_rows to be passed
1227 1228
 * unchanged to write_rows.
 */
1229 1230
PNG_EXPORT(59, void, png_write_rows, (png_structp png_ptr, png_bytepp row, 
    png_uint_32 num_rows));
G
Guy Schalnat 已提交
1231

1232
/* Write the image data */
1233 1234
PNG_EXPORT(60, void, png_write_image,
    (png_structp png_ptr, png_bytepp image));
G
Guy Schalnat 已提交
1235

1236
/* Write the end of the PNG file. */
1237 1238
PNG_EXPORT(61, void, png_write_end,
    (png_structp png_ptr, png_infop info_ptr));
G
Guy Schalnat 已提交
1239

1240
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1241
/* Read the end of the PNG file. */
1242
PNG_EXPORT(62, void, png_read_end, (png_structp png_ptr, png_infop info_ptr));
1243
#endif
G
Guy Schalnat 已提交
1244

1245
/* Free any memory associated with the png_info_struct */
1246 1247
PNG_EXPORT(63, void, png_destroy_info_struct, (png_structp png_ptr, 
    png_infopp info_ptr_ptr));
G
Guy Schalnat 已提交
1248

1249
/* Free any memory associated with the png_struct and the png_info_structs */
1250 1251
PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr, 
    png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr));
G
Guy Schalnat 已提交
1252

1253
/* Free any memory associated with the png_struct and the png_info_structs */
1254 1255
PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr, 
    png_infopp info_ptr_ptr));
G
Guy Schalnat 已提交
1256

1257
/* Set the libpng method of handling chunk CRC errors */
1258 1259
PNG_EXPORT(66, void, png_set_crc_action,
    (png_structp png_ptr, int crit_action, int ancil_action));
A
Andreas Dilger 已提交
1260

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

1285
/* Set the filtering method(s) used by libpng.  Currently, the only valid
1286 1287
 * value for "method" is 0.
 */
1288 1289
PNG_EXPORT(67, void, png_set_filter,
    (png_structp png_ptr, int method, int filters));
G
Guy Schalnat 已提交
1290

A
Andreas Dilger 已提交
1291
/* Flags for png_set_filter() to say which filters to use.  The flags
A
Andreas Dilger 已提交
1292 1293 1294
 * 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 已提交
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
 */
#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 已提交
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
/* 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

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

1371 1372
PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structp png_ptr, 
    int mem_level));
G
Guy Schalnat 已提交
1373

1374 1375
PNG_EXPORT(71, void, png_set_compression_strategy, (png_structp png_ptr, 
    int strategy));
G
Guy Schalnat 已提交
1376

1377 1378
PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structp png_ptr, 
    int window_bits));
G
Guy Schalnat 已提交
1379

1380 1381
PNG_EXPORT(73, void, png_set_compression_method, (png_structp png_ptr,
    int method));
G
Guy Schalnat 已提交
1382

G
Guy Schalnat 已提交
1383
/* These next functions are called for input/output, memory, and error
1384
 * handling.  They are in the file pngrio.c, pngwio.c, and pngerror.c, 
A
Andreas Dilger 已提交
1385 1386 1387
 * 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
1388
 * different manner by calling png_set_???_fn().  See libpng-manual.txt for
A
Andreas Dilger 已提交
1389 1390
 * more information.
 */
G
Guy Schalnat 已提交
1391

1392
#ifdef PNG_STDIO_SUPPORTED
A
Andreas Dilger 已提交
1393
/* Initialize the input/output for the PNG file to the default functions. */
1394
PNG_EXPORT(74, void, png_init_io, (png_structp png_ptr, png_FILE_p fp));
1395
#endif
G
Guy Schalnat 已提交
1396

A
Andreas Dilger 已提交
1397
/* Replace the (error and abort), and warning functions with user
A
Andreas Dilger 已提交
1398 1399 1400 1401 1402 1403
 * 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.
 */
1404

1405 1406 1407
PNG_EXPORT(75, void, png_set_error_fn,
    (png_structp png_ptr, png_voidp error_ptr, 
    png_error_ptr error_fn, png_error_ptr warning_fn));
G
Guy Schalnat 已提交
1408

G
Guy Schalnat 已提交
1409
/* Return the user pointer associated with the error functions */
1410
PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_structp png_ptr));
G
Guy Schalnat 已提交
1411 1412

/* Replace the default data output functions with a user supplied one(s).
A
Andreas Dilger 已提交
1413 1414 1415
 * 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).
1416 1417 1418 1419 1420
 * 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 已提交
1421
 */
1422 1423
PNG_EXPORT(77, void, png_set_write_fn, (png_structp png_ptr, png_voidp io_ptr, 
    png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn));
G
Guy Schalnat 已提交
1424 1425

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

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

1432 1433
PNG_EXPORT(80, void, png_set_read_status_fn, (png_structp png_ptr, 
    png_read_status_ptr read_row_fn));
1434

1435 1436
PNG_EXPORT(81, void, png_set_write_status_fn, (png_structp png_ptr, 
    png_write_status_ptr write_row_fn));
1437

1438 1439
#ifdef PNG_USER_MEM_SUPPORTED
/* Replace the default memory allocation functions with user supplied one(s). */
1440 1441
PNG_EXPORT(82, void, png_set_mem_fn, (png_structp png_ptr, png_voidp mem_ptr, 
    png_malloc_ptr malloc_fn, png_free_ptr free_fn));
1442
/* Return the user pointer associated with the memory functions */
1443
PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_structp png_ptr));
1444
#endif
1445

1446
#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
1447 1448
PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structp png_ptr, 
    png_user_transform_ptr read_user_transform_fn));
1449 1450
#endif

1451
#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
1452 1453
PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structp png_ptr, 
    png_user_transform_ptr write_user_transform_fn));
1454 1455
#endif

1456
#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
1457
    defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
1458 1459 1460
PNG_EXPORT(86, void, png_set_user_transform_info, (png_structp png_ptr, 
    png_voidp user_transform_ptr, int user_transform_depth, 
    int user_transform_channels));
1461
/* Return the user pointer associated with the user transform functions */
1462
PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr, (png_structp png_ptr));
1463 1464
#endif

1465
#ifdef PNG_USER_CHUNKS_SUPPORTED
1466 1467 1468
PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structp png_ptr, 
    png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn));
PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_structp png_ptr));
1469 1470
#endif

G
Guy Schalnat 已提交
1471
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
A
Andreas Dilger 已提交
1472 1473 1474
/* Sets the function callbacks for the push reader, and a pointer to a
 * user-defined structure available to the callback functions.
 */
1475 1476 1477
PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structp png_ptr, 
    png_voidp progressive_ptr, png_progressive_info_ptr info_fn, 
    png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn));
G
Guy Schalnat 已提交
1478

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

1482
/* Function to be called when data becomes available */
1483 1484 1485
PNG_EXPORT(92, void, png_process_data,
    (png_structp png_ptr, png_infop info_ptr, 
    png_bytep buffer, png_size_t buffer_size));
A
Andreas Dilger 已提交
1486

1487 1488 1489 1490
/* Function that combines rows.  'new_row' is a flag that should come from
 * the callback and be non-NULL if anything needs to be done; the library
 * stores its own version of the new data internally and ignores the passed
 * in value.
A
Andreas Dilger 已提交
1491
 */
1492 1493
PNG_EXPORT(93, void, png_progressive_combine_row, (png_structp png_ptr, 
    png_bytep old_row, png_const_bytep new_row));
G
Guy Schalnat 已提交
1494
#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */
G
Guy Schalnat 已提交
1495

1496 1497 1498
PNG_EXPORTA(94, png_voidp, png_malloc,
    (png_structp png_ptr, png_alloc_size_t size), 
    PNG_ALLOCATED);
1499
/* Added at libpng version 1.4.0 */
1500 1501 1502
PNG_EXPORTA(95, png_voidp, png_calloc,
    (png_structp png_ptr, png_alloc_size_t size), 
    PNG_ALLOCATED);
G
Guy Schalnat 已提交
1503

1504
/* Added at libpng version 1.2.4 */
1505 1506
PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_structp png_ptr, 
    png_alloc_size_t size), PNG_ALLOCATED);
1507

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

1511
/* Free data that was allocated internally */
1512 1513 1514
PNG_EXPORT(98, void, png_free_data,
    (png_structp png_ptr, png_infop info_ptr, png_uint_32 free_me, int num));

1515 1516
/* Reassign responsibility for freeing existing data, whether allocated
 * by libpng or by the application */
1517 1518 1519
PNG_EXPORT(99, void, png_data_freer,
    (png_structp png_ptr, png_infop info_ptr, int freer, png_uint_32 mask));

1520
/* Assignments for png_data_freer */
1521 1522 1523 1524
#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 */
1525 1526 1527 1528
#define PNG_FREE_HIST 0x0008
#define PNG_FREE_ICCP 0x0010
#define PNG_FREE_SPLT 0x0020
#define PNG_FREE_ROWS 0x0040
1529 1530
#define PNG_FREE_PCAL 0x0080
#define PNG_FREE_SCAL 0x0100
1531 1532
#define PNG_FREE_UNKN 0x0200
#define PNG_FREE_LIST 0x0400
1533 1534 1535
#define PNG_FREE_PLTE 0x1000
#define PNG_FREE_TRNS 0x2000
#define PNG_FREE_TEXT 0x4000
1536
#define PNG_FREE_ALL  0x7fff
1537
#define PNG_FREE_MUL  0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
1538

1539
#ifdef PNG_USER_MEM_SUPPORTED
1540 1541 1542
PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_structp png_ptr, 
    png_alloc_size_t size), PNG_ALLOCATED);
PNG_EXPORT(101, void, png_free_default, (png_structp png_ptr, png_voidp ptr));
1543
#endif
1544

1545
#ifdef PNG_ERROR_TEXT_SUPPORTED
A
Andreas Dilger 已提交
1546
/* Fatal error in PNG image of libpng - can't continue */
1547 1548 1549
PNG_EXPORTA(102, void, png_error,
    (png_structp png_ptr, png_const_charp error_message), 
    PNG_NORETURN);
G
Guy Schalnat 已提交
1550

1551
/* The same, but the chunk name is prepended to the error string. */
1552 1553
PNG_EXPORTA(103, void, png_chunk_error, (png_structp png_ptr, 
    png_const_charp error_message), PNG_NORETURN);
1554

1555 1556
#else
/* Fatal error in PNG image of libpng - can't continue */
1557
PNG_EXPORTA(104, void, png_err, (png_structp png_ptr), PNG_NORETURN);
1558 1559
#endif

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

1564
/* Non-fatal error in libpng, chunk name is prepended to message. */
1565 1566
PNG_EXPORT(106, void, png_chunk_warning, (png_structp png_ptr, 
    png_const_charp warning_message));
1567

1568 1569 1570
#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. */
1571
#  undef png_benign_error
1572 1573
PNG_EXPORT(107, void, png_benign_error, (png_structp png_ptr, 
    png_const_charp warning_message));
1574 1575

/* Same, chunk name is prepended to message. */
1576
#  undef png_chunk_benign_error
1577 1578
PNG_EXPORT(108, void, png_chunk_benign_error, (png_structp png_ptr, 
    png_const_charp warning_message));
1579

1580 1581
PNG_EXPORT(109, void, png_set_benign_errors,
    (png_structp png_ptr, int allowed));
1582 1583 1584 1585 1586 1587 1588 1589
#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
1590 1591
#endif

A
Andreas Dilger 已提交
1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
/* 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.
 */
1604
/* Returns "flag" if chunk data is valid in info_ptr. */
1605 1606 1607
PNG_EXPORT(110, png_uint_32, png_get_valid,
    (png_structp png_ptr, png_infop info_ptr, 
    png_uint_32 flag));
A
Andreas Dilger 已提交
1608

1609
/* Returns number of bytes needed to hold a transformed row. */
1610 1611
PNG_EXPORT(111, png_size_t, png_get_rowbytes, (png_structp png_ptr, 
    png_infop info_ptr));
A
Andreas Dilger 已提交
1612

1613
#ifdef PNG_INFO_IMAGE_SUPPORTED
1614
/* Returns row_pointers, which is an array of pointers to scanlines that was
1615 1616
 * returned from png_read_png().
 */
1617 1618
PNG_EXPORT(112, png_bytepp, png_get_rows,
    (png_structp png_ptr, png_infop info_ptr));
1619
/* Set row_pointers, which is an array of pointers to scanlines for use
1620 1621
 * by png_write_png().
 */
1622 1623
PNG_EXPORT(113, void, png_set_rows, (png_structp png_ptr, png_infop info_ptr, 
    png_bytepp row_pointers));
1624 1625
#endif

1626
/* Returns number of color channels in image. */
1627 1628
PNG_EXPORT(114, png_byte, png_get_channels,
    (png_structp png_ptr, png_infop info_ptr));
A
Andreas Dilger 已提交
1629

1630 1631
#ifdef PNG_EASY_ACCESS_SUPPORTED
/* Returns image width in pixels. */
1632 1633
PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_structp png_ptr, 
    png_infop info_ptr));
1634 1635

/* Returns image height in pixels. */
1636 1637
PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_structp png_ptr, 
    png_infop info_ptr));
1638 1639

/* Returns image bit_depth. */
1640 1641
PNG_EXPORT(117, png_byte, png_get_bit_depth,
    (png_structp png_ptr, png_infop info_ptr));
1642 1643

/* Returns image color_type. */
1644 1645
PNG_EXPORT(118, png_byte, png_get_color_type, (png_structp png_ptr, 
    png_infop info_ptr));
1646 1647

/* Returns image filter_type. */
1648 1649
PNG_EXPORT(119, png_byte, png_get_filter_type, (png_structp png_ptr, 
    png_infop info_ptr));
1650 1651

/* Returns image interlace_type. */
1652 1653
PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_structp png_ptr, 
    png_infop info_ptr));
1654 1655

/* Returns image compression_type. */
1656 1657
PNG_EXPORT(121, png_byte, png_get_compression_type, (png_structp png_ptr, 
    png_infop info_ptr));
1658 1659

/* Returns image resolution in pixels per meter, from pHYs chunk data. */
1660 1661 1662 1663 1664 1665
PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter, (png_structp png_ptr, 
    png_infop info_ptr));
PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter, (png_structp png_ptr, 
    png_infop info_ptr));
PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter, (png_structp png_ptr, 
    png_infop info_ptr));
1666 1667

/* Returns pixel aspect ratio, computed from pHYs chunk data.  */
1668 1669 1670 1671
PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio, (png_structp png_ptr, 
    png_infop info_ptr));
PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed, 
    (png_structp png_ptr, png_infop info_ptr));
1672 1673

/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
1674 1675 1676 1677 1678 1679 1680 1681
PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels, (png_structp png_ptr, 
    png_infop info_ptr));
PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels, (png_structp png_ptr, 
    png_infop info_ptr));
PNG_EXPORT(128, png_int_32, png_get_x_offset_microns, (png_structp png_ptr, 
    png_infop info_ptr));
PNG_EXPORT(129, png_int_32, png_get_y_offset_microns, (png_structp png_ptr, 
    png_infop info_ptr));
1682 1683 1684

#endif /* PNG_EASY_ACCESS_SUPPORTED */

A
Andreas Dilger 已提交
1685
/* Returns pointer to signature string read from PNG header */
1686 1687
PNG_EXPORT(130, png_const_bytep, png_get_signature, (png_structp png_ptr, 
    png_infop info_ptr));
A
Andreas Dilger 已提交
1688

1689
#ifdef PNG_bKGD_SUPPORTED
1690 1691 1692
PNG_EXPORT(131, png_uint_32, png_get_bKGD,
    (png_structp png_ptr, png_infop info_ptr, 
    png_color_16p *background));
1693
#endif
A
Andreas Dilger 已提交
1694

1695
#ifdef PNG_bKGD_SUPPORTED
1696 1697
PNG_EXPORT(132, void, png_set_bKGD, (png_structp png_ptr, png_infop info_ptr, 
    png_const_color_16p background));
1698
#endif
A
Andreas Dilger 已提交
1699

1700
#ifdef PNG_cHRM_SUPPORTED
1701 1702 1703 1704
PNG_FP_EXPORT(133, 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));
G
[devel]  
Glenn Randers-Pehrson 已提交
1705
#ifdef PNG_FIXED_POINT_SUPPORTED /* Otherwise not implemented */
1706 1707 1708 1709 1710 1711
PNG_FIXED_EXPORT(134, 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));
G
[devel]  
Glenn Randers-Pehrson 已提交
1712
#endif
1713
#endif
A
Andreas Dilger 已提交
1714

1715
#ifdef PNG_cHRM_SUPPORTED
1716 1717 1718 1719 1720 1721 1722 1723 1724 1725
PNG_FP_EXPORT(135, void, png_set_cHRM,
    (png_structp png_ptr, png_infop info_ptr, 
    double white_x, double white_y, double red_x, double red_y, double green_x, 
    double green_y, double blue_x, double blue_y));
PNG_FIXED_EXPORT(136, void, png_set_cHRM_fixed, (png_structp png_ptr, 
    png_infop info_ptr, png_fixed_point int_white_x, 
    png_fixed_point int_white_y, png_fixed_point int_red_x, 
    png_fixed_point int_red_y, png_fixed_point int_green_x, 
    png_fixed_point int_green_y, png_fixed_point int_blue_x, 
    png_fixed_point int_blue_y));
1726
#endif
A
Andreas Dilger 已提交
1727

1728
#ifdef PNG_gAMA_SUPPORTED
1729 1730 1731 1732 1733
PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA,
    (png_structp png_ptr, png_infop info_ptr, 
    double *file_gamma));
PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed, (png_structp png_ptr, 
    png_infop info_ptr, png_fixed_point *int_file_gamma));
1734
#endif
G
Guy Schalnat 已提交
1735

1736
#ifdef PNG_gAMA_SUPPORTED
1737 1738 1739 1740
PNG_FP_EXPORT(139, void, png_set_gAMA, (png_structp png_ptr, png_infop info_ptr, 
    double file_gamma));
PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_structp png_ptr, 
    png_infop info_ptr, png_fixed_point int_file_gamma));
1741
#endif
A
Andreas Dilger 已提交
1742

1743
#ifdef PNG_hIST_SUPPORTED
1744 1745 1746
PNG_EXPORT(141, png_uint_32, png_get_hIST,
    (png_structp png_ptr, png_infop info_ptr, 
    png_uint_16p *hist));
1747
#endif
A
Andreas Dilger 已提交
1748

1749
#ifdef PNG_hIST_SUPPORTED
1750 1751
PNG_EXPORT(142, void, png_set_hIST, (png_structp png_ptr, png_infop info_ptr, 
    png_const_uint_16p hist));
1752
#endif
A
Andreas Dilger 已提交
1753

1754 1755 1756 1757
PNG_EXPORT(143, png_uint_32, png_get_IHDR,
    (png_structp png_ptr, png_infop info_ptr, 
    png_uint_32 *width, png_uint_32 *height, int *bit_depth, int *color_type, 
    int *interlace_method, int *compression_method, int *filter_method));
1758

1759 1760 1761 1762
PNG_EXPORT(144, void, png_set_IHDR,
    (png_structp png_ptr, png_infop info_ptr, 
    png_uint_32 width, png_uint_32 height, int bit_depth, int color_type, 
    int interlace_method, int compression_method, int filter_method));
A
Andreas Dilger 已提交
1763

1764
#ifdef PNG_oFFs_SUPPORTED
1765 1766 1767
PNG_EXPORT(145, 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));
1768
#endif
A
Andreas Dilger 已提交
1769

1770
#ifdef PNG_oFFs_SUPPORTED
1771 1772 1773
PNG_EXPORT(146, void, png_set_oFFs,
    (png_structp png_ptr, png_infop info_ptr, 
    png_int_32 offset_x, png_int_32 offset_y, int unit_type));
1774
#endif
A
Andreas Dilger 已提交
1775

1776
#ifdef PNG_pCAL_SUPPORTED
1777 1778 1779 1780 1781
PNG_EXPORT(147, 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));
1782
#endif
A
Andreas Dilger 已提交
1783

1784
#ifdef PNG_pCAL_SUPPORTED
1785 1786 1787
PNG_EXPORT(148, void, png_set_pCAL, (png_structp png_ptr, png_infop info_ptr, 
    png_const_charp purpose, png_int_32 X0, png_int_32 X1, int type, 
    int nparams, png_const_charp units, png_charpp params));
1788 1789
#endif

1790
#ifdef PNG_pHYs_SUPPORTED
1791 1792 1793
PNG_EXPORT(149, 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));
1794
#endif
A
Andreas Dilger 已提交
1795

1796
#ifdef PNG_pHYs_SUPPORTED
1797 1798 1799
PNG_EXPORT(150, void, png_set_pHYs,
    (png_structp png_ptr, png_infop info_ptr, 
    png_uint_32 res_x, png_uint_32 res_y, int unit_type));
1800
#endif
A
Andreas Dilger 已提交
1801

1802 1803 1804
PNG_EXPORT(151, png_uint_32, png_get_PLTE,
    (png_structp png_ptr, png_infop info_ptr, 
    png_colorp *palette, int *num_palette));
A
Andreas Dilger 已提交
1805

1806 1807 1808
PNG_EXPORT(152, void, png_set_PLTE,
    (png_structp png_ptr, png_infop info_ptr, 
    png_const_colorp palette, int num_palette));
A
Andreas Dilger 已提交
1809

1810
#ifdef PNG_sBIT_SUPPORTED
1811 1812 1813
PNG_EXPORT(153, png_uint_32, png_get_sBIT,
    (png_structp png_ptr, png_infop info_ptr, 
    png_color_8p *sig_bit));
1814
#endif
A
Andreas Dilger 已提交
1815

1816
#ifdef PNG_sBIT_SUPPORTED
1817 1818
PNG_EXPORT(154, void, png_set_sBIT,
    (png_structp png_ptr, png_infop info_ptr, png_const_color_8p sig_bit));
1819
#endif
A
Andreas Dilger 已提交
1820

1821
#ifdef PNG_sRGB_SUPPORTED
1822 1823
PNG_EXPORT(155, png_uint_32, png_get_sRGB,
    (png_structp png_ptr, png_infop info_ptr, int *intent));
1824
#endif
1825

1826
#ifdef PNG_sRGB_SUPPORTED
1827 1828 1829 1830
PNG_EXPORT(156, void, png_set_sRGB,
    (png_structp png_ptr, png_infop info_ptr, int intent));
PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_structp png_ptr, 
    png_infop info_ptr, int intent));
1831 1832
#endif

1833
#ifdef PNG_iCCP_SUPPORTED
1834 1835 1836 1837
PNG_EXPORT(158, 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));
1838 1839
#endif

1840
#ifdef PNG_iCCP_SUPPORTED
1841 1842 1843 1844
PNG_EXPORT(159, void, png_set_iCCP,
    (png_structp png_ptr, png_infop info_ptr, 
    png_const_charp name, int compression_type, png_const_bytep profile, 
    png_uint_32 proflen));
1845 1846
#endif

1847
#ifdef PNG_sPLT_SUPPORTED
1848 1849 1850
PNG_EXPORT(160, png_uint_32, png_get_sPLT,
    (png_structp png_ptr, png_infop info_ptr, 
    png_sPLT_tpp entries));
1851 1852
#endif

1853
#ifdef PNG_sPLT_SUPPORTED
1854 1855 1856
PNG_EXPORT(161, void, png_set_sPLT,
    (png_structp png_ptr, png_infop info_ptr, 
    png_const_sPLT_tp entries, int nentries));
1857 1858
#endif

1859
#ifdef PNG_TEXT_SUPPORTED
1860
/* png_get_text also returns the number of text chunks in *num_text */
1861 1862 1863
PNG_EXPORT(162, png_uint_32, png_get_text,
    (png_structp png_ptr, png_infop info_ptr, 
    png_textp *text_ptr, int *num_text));
1864
#endif
A
Andreas Dilger 已提交
1865

1866
/* Note while png_set_text() will accept a structure whose text, 
1867 1868 1869 1870
 * 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.
1871 1872
 */

1873
#ifdef PNG_TEXT_SUPPORTED
1874 1875 1876
PNG_EXPORT(163, void, png_set_text,
    (png_structp png_ptr, png_infop info_ptr, 
    png_const_textp text_ptr, int num_text));
1877
#endif
A
Andreas Dilger 已提交
1878

1879
#ifdef PNG_tIME_SUPPORTED
1880 1881
PNG_EXPORT(164, png_uint_32, png_get_tIME,
    (png_structp png_ptr, png_infop info_ptr, png_timep *mod_time));
1882
#endif
A
Andreas Dilger 已提交
1883

1884
#ifdef PNG_tIME_SUPPORTED
1885 1886
PNG_EXPORT(165, void, png_set_tIME,
    (png_structp png_ptr, png_infop info_ptr, png_const_timep mod_time));
1887
#endif
A
Andreas Dilger 已提交
1888

1889
#ifdef PNG_tRNS_SUPPORTED
1890 1891 1892
PNG_EXPORT(166, 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));
1893 1894
#endif

1895
#ifdef PNG_tRNS_SUPPORTED
1896 1897 1898 1899
PNG_EXPORT(167, void, png_set_tRNS,
    (png_structp png_ptr, png_infop info_ptr, 
    png_const_bytep trans_alpha, int num_trans, 
    png_const_color_16p trans_color));
1900 1901
#endif

1902
#ifdef PNG_sCAL_SUPPORTED
1903 1904 1905
PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL,
    (png_structp png_ptr, png_infop info_ptr, 
    int *unit, double *width, double *height));
1906
#ifdef PNG_FLOATING_ARITHMETIC_SUPPORTED
1907
/* NOTE: this API is currently implemented using floating point arithmetic, 
1908 1909 1910 1911
 * 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.
 */
1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928
PNG_FIXED_EXPORT(214, 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));
#endif
PNG_EXPORT(169, png_uint_32, png_get_sCAL_s,
    (png_structp png_ptr, 
    png_infop info_ptr, int *unit, png_charpp swidth, png_charpp sheight));

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

1931 1932
#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
/* Provide a list of chunks and how they are to be handled, if the built-in
1933 1934 1935
   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.
1936
      keep = 0: follow default behaviour
1937 1938 1939 1940
           = 1: do not keep
           = 2: keep only if safe-to-copy
           = 3: keep even if unsafe-to-copy
*/
1941 1942 1943 1944 1945
PNG_EXPORT(172, void, png_set_keep_unknown_chunks,
    (png_structp png_ptr, int keep, 
    png_const_bytep chunk_list, int num_chunks));
PNG_EXPORT(173, int, png_handle_as_unknown, (png_structp png_ptr, 
    png_const_bytep chunk_name));
1946
#endif
1947
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
1948 1949 1950 1951 1952 1953
PNG_EXPORT(174, void, png_set_unknown_chunks, (png_structp png_ptr, 
    png_infop info_ptr, png_const_unknown_chunkp unknowns, int num_unknowns));
PNG_EXPORT(175, void, png_set_unknown_chunk_location, (png_structp png_ptr, 
    png_infop info_ptr, int chunk, int location));
PNG_EXPORT(176, int, png_get_unknown_chunks, (png_structp png_ptr, 
    png_infop info_ptr, png_unknown_chunkpp entries));
1954 1955
#endif

1956
/* Png_free_data() will turn off the "valid" flag for anything it frees.
1957
 * If you need to turn it off for a chunk that your application has freed, 
1958 1959
 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
 */
1960 1961
PNG_EXPORT(177, void, png_set_invalid,
    (png_structp png_ptr, png_infop info_ptr, int mask));
1962

1963
#ifdef PNG_INFO_IMAGE_SUPPORTED
1964
/* The "params" pointer is currently not used and is for future expansion. */
1965 1966 1967 1968
PNG_EXPORT(178, void, png_read_png, (png_structp png_ptr, png_infop info_ptr, 
    int transforms, png_voidp params));
PNG_EXPORT(179, void, png_write_png, (png_structp png_ptr, png_infop info_ptr, 
    int transforms, png_voidp params));
1969 1970
#endif

1971 1972 1973 1974
PNG_EXPORT(180, png_const_charp, png_get_copyright, (png_structp png_ptr));
PNG_EXPORT(181, png_const_charp, png_get_header_ver, (png_structp png_ptr));
PNG_EXPORT(182, png_const_charp, png_get_header_version, (png_structp png_ptr));
PNG_EXPORT(183, png_const_charp, png_get_libpng_ver, (png_structp png_ptr));
1975

1976
#ifdef PNG_MNG_FEATURES_SUPPORTED
1977 1978
PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structp png_ptr, 
    png_uint_32 mng_features_permitted));
1979 1980
#endif

1981 1982 1983 1984 1985 1986
/* 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

1987
/* Strip the prepended error numbers ("#nnn ") from error and warning
1988 1989
 * messages before passing them to the error or warning handler.
 */
1990
#ifdef PNG_ERROR_NUMBERS_SUPPORTED
1991 1992 1993
PNG_EXPORT(185, void, png_set_strip_error_numbers,
    (png_structp png_ptr, 
    png_uint_32 strip_mode));
1994
#endif
1995

1996
/* Added in libpng-1.2.6 */
1997
#ifdef PNG_SET_USER_LIMITS_SUPPORTED
1998 1999 2000 2001
PNG_EXPORT(186, void, png_set_user_limits, (png_structp png_ptr, 
    png_uint_32 user_width_max, png_uint_32 user_height_max));
PNG_EXPORT(187, png_uint_32, png_get_user_width_max, (png_structp png_ptr));
PNG_EXPORT(188, png_uint_32, png_get_user_height_max, (png_structp png_ptr));
2002
/* Added in libpng-1.4.0 */
2003 2004 2005
PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structp png_ptr, 
    png_uint_32 user_chunk_cache_max));
PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max, (png_structp png_ptr));
2006
/* Added in libpng-1.4.1 */
2007 2008 2009 2010
PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structp png_ptr, 
    png_alloc_size_t user_chunk_cache_max));
PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max,
    (png_structp png_ptr));
2011 2012
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
2013
#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
2014 2015
PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch, (png_structp png_ptr, 
    png_infop info_ptr));
2016

2017 2018
PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch, (png_structp png_ptr, 
    png_infop info_ptr));
2019

2020 2021
PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch, (png_structp png_ptr, 
    png_infop info_ptr));
2022

2023 2024
PNG_FP_EXPORT(196, float, png_get_x_offset_inches, (png_structp png_ptr, 
    png_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2025
#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2026 2027
PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed, 
    (png_structp png_ptr, png_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2028
#endif
2029

2030 2031
PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_structp png_ptr, 
    png_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2032
#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2033 2034
PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed, 
    (png_structp png_ptr, png_infop info_ptr));
G
[devel]  
Glenn Randers-Pehrson 已提交
2035
#endif
2036

2037
#  ifdef PNG_pHYs_SUPPORTED
2038 2039 2040
PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_structp png_ptr, 
    png_infop info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
    int *unit_type));
2041
#  endif /* PNG_pHYs_SUPPORTED */
G
[devel]  
Glenn Randers-Pehrson 已提交
2042
#endif  /* PNG_INCH_CONVERSIONS_SUPPORTED */
2043

2044 2045
/* Added in libpng-1.4.0 */
#ifdef PNG_IO_STATE_SUPPORTED
2046
PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_structp png_ptr));
2047

2048
PNG_EXPORT(200, png_const_bytep, png_get_io_chunk_name, (png_structp png_ptr));
2049 2050

/* The flags returned by png_get_io_state() are the following: */
2051 2052 2053 2054 2055 2056 2057 2058 2059
#  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 */
2060 2061
#endif /* ?PNG_IO_STATE_SUPPORTED */

2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114
/* Interlace support.  The following macros are always defined so that if
 * libpng interlace handling is turned off the macros may be used to handle
 * interlaced images within the application.
 */
#define PNG_INTERLACE_ADAM7_PASSES 7

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

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

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

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

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

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

2115
#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
2116 2117 2118
/* 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
2119 2120 2121 2122 2123 2124 2125 2126 2127
 * 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. :-) ]
 */

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

2130 2131 2132 2133 2134
#  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);   \
2135
       (composite) = (png_byte)((temp + (temp >> 8)) >> 8); }
2136

2137 2138 2139 2140 2141
#  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); \
2142 2143
       (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); }

2144
#else  /* Standard method using integer division */
2145

2146 2147
#  define png_composite(composite, fg, alpha, bg)                          \
     (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) +  \
2148 2149
     (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) +       \
     (png_uint_16)127) / 255)
2150 2151

#  define png_composite_16(composite, fg, alpha, bg)                         \
2152
     (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \
2153
     (png_uint_32)(bg)*(png_uint_32)(65535L - (png_uint_32)(alpha)) +        \
2154
     (png_uint_32)32767) / (png_uint_32)65535L)
2155 2156
#endif /* PNG_READ_COMPOSITE_NODIV_SUPPORTED */

2157 2158 2159 2160
#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.
2161
 */
2162 2163 2164 2165 2166
#  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))))
2167 2168 2169 2170

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

G
[devel]  
Glenn Randers-Pehrson 已提交
2176 2177
#  define png_get_int_32(buf) \
     ((png_int_32)((*(buf) & 0x80) \
2178
      ? -((png_int_32)((png_get_uint_32(buf) ^ 0xffffffffL) + 1)) \
2179
      : (png_int_32)png_get_uint_32(buf)))
2180
#endif
2181 2182

#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
2183 2184 2185
PNG_EXPORT(201, png_uint_32, png_get_uint_32, (png_const_bytep buf));
PNG_EXPORT(202, png_uint_16, png_get_uint_16, (png_const_bytep buf));
PNG_EXPORT(203, png_int_32, png_get_int_32, (png_const_bytep buf));
2186 2187
#endif

2188 2189
PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_structp png_ptr, 
    png_const_bytep buf));
2190 2191
/* No png_get_int_16 -- may be added if there's a real need for it. */

2192
/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
2193
#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2194
PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i));
2195
#endif
2196
#ifdef PNG_SAVE_INT_32_SUPPORTED
2197
PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i));
2198
#endif
2199 2200

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

G
[devel]  
Glenn Randers-Pehrson 已提交
2209 2210 2211 2212
/* Maintainer: Put new public prototypes here ^, in libpng.3, and project
 * defs
 */

2213 2214
/* The last ordinal number (this is the *last* one already used; the next
 * one to use is one more than this.)
2215 2216
 */
#ifdef PNG_EXPORT_LAST_ORDINAL
2217
  PNG_EXPORT_LAST_ORDINAL(215);
2218 2219
#endif

A
Andreas Dilger 已提交
2220 2221 2222 2223
#ifdef __cplusplus
}
#endif

2224
#endif /* PNG_VERSION_INFO_ONLY */
2225
/* Do not put anything past this line */
2226
#endif /* PNG_H */