blob: 3ac3ee952ec80555215875745971e6cdba7843b6 [file] [log] [blame]
Chris Craikb50c2172013-07-29 15:28:30 -07001
The Android Open Source Project893912b2009-03-03 19:30:05 -08002/* png.h - header file for PNG reference library
3 *
Matt Sarett9ea75692016-01-08 13:00:42 -05004 * libpng version 1.6.20, December 3, 2015
5 *
6 * Copyright (c) 1998-2015 Glenn Randers-Pehrson
The Android Open Source Project893912b2009-03-03 19:30:05 -08007 * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)
8 * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
9 *
Patrick Scotta0bb96c2009-07-22 11:50:02 -040010 * This code is released under the libpng license (See LICENSE, below)
11 *
The Android Open Source Project893912b2009-03-03 19:30:05 -080012 * Authors and maintainers:
Chris Craikb50c2172013-07-29 15:28:30 -070013 * libpng versions 0.71, May 1995, through 0.88, January 1996: Guy Schalnat
Matt Sarett9ea75692016-01-08 13:00:42 -050014 * libpng versions 0.89, June 1996, through 0.96, May 1997: Andreas Dilger
15 * libpng versions 0.97, January 1998, through 1.6.20, December 3, 2015:
16 * Glenn Randers-Pehrson.
Chris Craikb50c2172013-07-29 15:28:30 -070017 * See also "Contributing Authors", below.
Matt Sarett9ea75692016-01-08 13:00:42 -050018 */
19
20/*
21 * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE:
The Android Open Source Project893912b2009-03-03 19:30:05 -080022 *
Matt Sarett9ea75692016-01-08 13:00:42 -050023 * If you modify libpng you may insert additional notices immediately following
24 * this sentence.
The Android Open Source Project893912b2009-03-03 19:30:05 -080025 *
Matt Sarett9ea75692016-01-08 13:00:42 -050026 * This code is released under the libpng license.
27 *
28 * libpng versions 1.0.7, July 1, 2000, through 1.6.20, December 3, 2015, are
29 * Copyright (c) 2000-2002, 2004, 2006-2015 Glenn Randers-Pehrson, are
30 * derived from libpng-1.0.6, and are distributed according to the same
31 * disclaimer and license as libpng-1.0.6 with the following individuals
32 * added to the list of Contributing Authors:
33 *
34 * Simon-Pierre Cadieux
35 * Eric S. Raymond
36 * Mans Rullgard
37 * Cosmin Truta
38 * Gilles Vollant
39 * James Yu
40 *
41 * and with the following additions to the disclaimer:
42 *
43 * There is no warranty against interference with your enjoyment of the
44 * library or against infringement. There is no warranty that our
45 * efforts or the library will fulfill any of your particular purposes
46 * or needs. This library is provided with all faults, and the entire
47 * risk of satisfactory quality, performance, accuracy, and effort is with
48 * the user.
49 *
50 * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
51 * Copyright (c) 1998-2000 Glenn Randers-Pehrson, are derived from
52 * libpng-0.96, and are distributed according to the same disclaimer and
53 * license as libpng-0.96, with the following individuals added to the list
54 * of Contributing Authors:
55 *
56 * Tom Lane
57 * Glenn Randers-Pehrson
58 * Willem van Schaik
59 *
60 * libpng versions 0.89, June 1996, through 0.96, May 1997, are
61 * Copyright (c) 1996-1997 Andreas Dilger, are derived from libpng-0.88,
62 * and are distributed according to the same disclaimer and license as
63 * libpng-0.88, with the following individuals added to the list of
64 * Contributing Authors:
65 *
66 * John Bowler
67 * Kevin Bracey
68 * Sam Bushell
69 * Magnus Holmgren
70 * Greg Roelofs
71 * Tom Tanner
72 *
73 * libpng versions 0.5, May 1995, through 0.88, January 1996, are
74 * Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc.
75 *
76 * For the purposes of this copyright and license, "Contributing Authors"
77 * is defined as the following set of individuals:
78 *
79 * Andreas Dilger
80 * Dave Martindale
81 * Guy Eric Schalnat
82 * Paul Schmidt
83 * Tim Wegner
84 *
85 * The PNG Reference Library is supplied "AS IS". The Contributing Authors
86 * and Group 42, Inc. disclaim all warranties, expressed or implied,
87 * including, without limitation, the warranties of merchantability and of
88 * fitness for any purpose. The Contributing Authors and Group 42, Inc.
89 * assume no liability for direct, indirect, incidental, special, exemplary,
90 * or consequential damages, which may result from the use of the PNG
91 * Reference Library, even if advised of the possibility of such damage.
92 *
93 * Permission is hereby granted to use, copy, modify, and distribute this
94 * source code, or portions hereof, for any purpose, without fee, subject
95 * to the following restrictions:
96 *
97 * 1. The origin of this source code must not be misrepresented.
98 *
99 * 2. Altered versions must be plainly marked as such and must not
100 * be misrepresented as being the original source.
101 *
102 * 3. This Copyright notice may not be removed or altered from any
103 * source or altered source distribution.
104 *
105 * The Contributing Authors and Group 42, Inc. specifically permit, without
106 * fee, and encourage the use of this source code as a component to
107 * supporting the PNG file format in commercial products. If you use this
108 * source code in a product, acknowledgment is not required but would be
109 * appreciated.
110 *
111 * END OF COPYRIGHT NOTICE, DISCLAIMER, and LICENSE.
112 */
113
114/*
115 * A "png_get_copyright" function is available, for convenient use in "about"
116 * boxes and the like:
117 *
118 * printf("%s", png_get_copyright(NULL));
119 *
120 * Also, the PNG logo (in PNG format, of course) is supplied in the
121 * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
122 */
123
124/*
125 * Libpng is OSI Certified Open Source Software. OSI Certified Open Source is
126 * a certification mark of the Open Source Initiative. OSI has not addressed
127 * the additional disclaimers inserted at version 1.0.7.
128 */
129
130/*
131 * The contributing authors would like to thank all those who helped
132 * with testing, bug fixes, and patience. This wouldn't have been
133 * possible without all of you.
134 *
135 * Thanks to Frank J. T. Wojcik for helping with the documentation.
136 */
137
138/* Note about libpng version numbers:
139 *
140 * Due to various miscommunications, unforeseen code incompatibilities
141 * and occasional factors outside the authors' control, version numbering
142 * on the library has not always been consistent and straightforward.
143 * The following table summarizes matters since version 0.89c, which was
144 * the first widely used release:
The Android Open Source Project893912b2009-03-03 19:30:05 -0800145 *
146 * source png.h png.h shared-lib
147 * version string int version
148 * ------- ------ ----- ----------
149 * 0.89c "1.0 beta 3" 0.89 89 1.0.89
150 * 0.90 "1.0 beta 4" 0.90 90 0.90 [should have been 2.0.90]
151 * 0.95 "1.0 beta 5" 0.95 95 0.95 [should have been 2.0.95]
152 * 0.96 "1.0 beta 6" 0.96 96 0.96 [should have been 2.0.96]
153 * 0.97b "1.00.97 beta 7" 1.00.97 97 1.0.1 [should have been 2.0.97]
154 * 0.97c 0.97 97 2.0.97
155 * 0.98 0.98 98 2.0.98
156 * 0.99 0.99 98 2.0.99
157 * 0.99a-m 0.99 99 2.0.99
158 * 1.00 1.00 100 2.1.0 [100 should be 10000]
159 * 1.0.0 (from here on, the 100 2.1.0 [100 should be 10000]
160 * 1.0.1 png.h string is 10001 2.1.0
161 * 1.0.1a-e identical to the 10002 from here on, the shared library
162 * 1.0.2 source version) 10002 is 2.V where V is the source code
163 * 1.0.2a-b 10003 version, except as noted.
164 * 1.0.3 10003
165 * 1.0.3a-d 10004
166 * 1.0.4 10004
167 * 1.0.4a-f 10005
168 * 1.0.5 (+ 2 patches) 10005
169 * 1.0.5a-d 10006
170 * 1.0.5e-r 10100 (not source compatible)
171 * 1.0.5s-v 10006 (not binary compatible)
172 * 1.0.6 (+ 3 patches) 10006 (still binary incompatible)
173 * 1.0.6d-f 10007 (still binary incompatible)
174 * 1.0.6g 10007
175 * 1.0.6h 10007 10.6h (testing xy.z so-numbering)
176 * 1.0.6i 10007 10.6i
177 * 1.0.6j 10007 2.1.0.6j (incompatible with 1.0.0)
178 * 1.0.7beta11-14 DLLNUM 10007 2.1.0.7beta11-14 (binary compatible)
179 * 1.0.7beta15-18 1 10007 2.1.0.7beta15-18 (binary compatible)
180 * 1.0.7rc1-2 1 10007 2.1.0.7rc1-2 (binary compatible)
181 * 1.0.7 1 10007 (still compatible)
Matt Sarett9ea75692016-01-08 13:00:42 -0500182 * ...
183 * 1.0.19 10 10019 10.so.0.19[.0]
184 * ...
185 * 1.2.53 13 10253 12.so.0.53[.0]
186 * ...
187 * 1.5.23 15 10523 15.so.15.23[.0]
188 * ...
189 * 1.6.20 16 10620 16.so.16.20[.0]
The Android Open Source Project893912b2009-03-03 19:30:05 -0800190 *
Matt Sarett9ea75692016-01-08 13:00:42 -0500191 * Henceforth the source version will match the shared-library major
192 * and minor numbers; the shared-library major version number will be
193 * used for changes in backward compatibility, as it is intended. The
194 * PNG_LIBPNG_VER macro, which is not used within libpng but is available
195 * for applications, is an unsigned integer of the form xyyzz corresponding
196 * to the source version x.y.z (leading zeros in y and z). Beta versions
197 * were given the previous public release number plus a letter, until
198 * version 1.0.6j; from then on they were given the upcoming public
199 * release number plus "betaNN" or "rcNN".
The Android Open Source Project893912b2009-03-03 19:30:05 -0800200 *
Matt Sarett9ea75692016-01-08 13:00:42 -0500201 * Binary incompatibility exists only when applications make direct access
202 * to the info_ptr or png_ptr members through png.h, and the compiled
203 * application is loaded with a different version of the library.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800204 *
Matt Sarett9ea75692016-01-08 13:00:42 -0500205 * DLLNUM will change each time there are forward or backward changes
206 * in binary compatibility (e.g., when a new feature is added).
The Android Open Source Project893912b2009-03-03 19:30:05 -0800207 *
Matt Sarett9ea75692016-01-08 13:00:42 -0500208 * See libpng.txt or libpng.3 for more information. The PNG specification
209 * is available as a W3C Recommendation and as an ISO Specification,
210 * <http://www.w3.org/TR/2003/REC-PNG-20031110/
The Android Open Source Project893912b2009-03-03 19:30:05 -0800211 */
212
213/*
214 * Y2K compliance in libpng:
215 * =========================
216 *
Matt Sarett9ea75692016-01-08 13:00:42 -0500217 * December 3, 2015
The Android Open Source Project893912b2009-03-03 19:30:05 -0800218 *
219 * Since the PNG Development group is an ad-hoc body, we can't make
220 * an official declaration.
221 *
222 * This is your unofficial assurance that libpng from version 0.71 and
Matt Sarett9ea75692016-01-08 13:00:42 -0500223 * upward through 1.6.20 are Y2K compliant. It is my belief that
Chris Craikb50c2172013-07-29 15:28:30 -0700224 * earlier versions were also Y2K compliant.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800225 *
Chris Craikb50c2172013-07-29 15:28:30 -0700226 * Libpng only has two year fields. One is a 2-byte unsigned integer
227 * that will hold years up to 65535. The other, which is deprecated,
228 * holds the date in text format, and will hold years up to 9999.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800229 *
230 * The integer is
231 * "png_uint_16 year" in png_time_struct.
232 *
Chris Craikb50c2172013-07-29 15:28:30 -0700233 * The string is
234 * "char time_buffer[29]" in png_struct. This is no longer used
235 * in libpng-1.6.x and will be removed from libpng-1.7.0.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800236 *
237 * There are seven time-related functions:
Chris Craikb50c2172013-07-29 15:28:30 -0700238 * png.c: png_convert_to_rfc_1123_buffer() in png.c
239 * (formerly png_convert_to_rfc_1123() prior to libpng-1.5.x and
240 * png_convert_to_rfc_1152() in error prior to libpng-0.98)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800241 * png_convert_from_struct_tm() in pngwrite.c, called in pngwrite.c
242 * png_convert_from_time_t() in pngwrite.c
243 * png_get_tIME() in pngget.c
244 * png_handle_tIME() in pngrutil.c, called in pngread.c
245 * png_set_tIME() in pngset.c
246 * png_write_tIME() in pngwutil.c, called in pngwrite.c
247 *
248 * All handle dates properly in a Y2K environment. The
249 * png_convert_from_time_t() function calls gmtime() to convert from system
250 * clock time, which returns (year - 1900), which we properly convert to
Chris Craikb50c2172013-07-29 15:28:30 -0700251 * the full 4-digit year. There is a possibility that libpng applications
252 * are not passing 4-digit years into the png_convert_to_rfc_1123_buffer()
The Android Open Source Project893912b2009-03-03 19:30:05 -0800253 * function, or that they are incorrectly passing only a 2-digit year
254 * instead of "year - 1900" into the png_convert_from_struct_tm() function,
255 * but this is not under our control. The libpng documentation has always
256 * stated that it works with 4-digit years, and the APIs have been
257 * documented as such.
258 *
259 * The tIME chunk itself is also Y2K compliant. It uses a 2-byte unsigned
260 * integer to hold the year, and can hold years as large as 65535.
261 *
262 * zlib, upon which libpng depends, is also Y2K compliant. It contains
263 * no date-related code.
264 *
265 * Glenn Randers-Pehrson
266 * libpng maintainer
267 * PNG Development Group
268 */
269
270#ifndef PNG_H
271#define PNG_H
272
Chris Craikb50c2172013-07-29 15:28:30 -0700273/* This is not the place to learn how to use libpng. The file libpng-manual.txt
The Android Open Source Project893912b2009-03-03 19:30:05 -0800274 * describes how to use libpng, and the file example.c summarizes it
275 * with some code on which to build. This file is useful for looking
Matt Sarett9ea75692016-01-08 13:00:42 -0500276 * at the actual function definitions and structure components. If that
277 * file has been stripped from your copy of libpng, you can find it at
278 * <http://www.libpng.org/pub/png/libpng-manual.txt>
Chris Craikb50c2172013-07-29 15:28:30 -0700279 *
280 * If you just need to read a PNG file and don't want to read the documentation
281 * skip to the end of this file and read the section entitled 'simplified API'.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800282 */
283
284/* Version information for png.h - this should match the version in png.c */
Matt Sarett9ea75692016-01-08 13:00:42 -0500285#define PNG_LIBPNG_VER_STRING "1.6.20"
The Android Open Source Project893912b2009-03-03 19:30:05 -0800286#define PNG_HEADER_VERSION_STRING \
Matt Sarett9ea75692016-01-08 13:00:42 -0500287 " libpng version 1.6.20 - December 3, 2015\n"
The Android Open Source Project893912b2009-03-03 19:30:05 -0800288
Chris Craikb50c2172013-07-29 15:28:30 -0700289#define PNG_LIBPNG_VER_SONUM 16
290#define PNG_LIBPNG_VER_DLLNUM 16
The Android Open Source Project893912b2009-03-03 19:30:05 -0800291
292/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */
293#define PNG_LIBPNG_VER_MAJOR 1
Chris Craikb50c2172013-07-29 15:28:30 -0700294#define PNG_LIBPNG_VER_MINOR 6
Matt Sarett9ea75692016-01-08 13:00:42 -0500295#define PNG_LIBPNG_VER_RELEASE 20
Chris Craikb50c2172013-07-29 15:28:30 -0700296
The Android Open Source Project893912b2009-03-03 19:30:05 -0800297/* This should match the numeric part of the final component of
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400298 * PNG_LIBPNG_VER_STRING, omitting any leading zero:
299 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800300
301#define PNG_LIBPNG_VER_BUILD 0
302
303/* Release Status */
304#define PNG_LIBPNG_BUILD_ALPHA 1
305#define PNG_LIBPNG_BUILD_BETA 2
306#define PNG_LIBPNG_BUILD_RC 3
307#define PNG_LIBPNG_BUILD_STABLE 4
308#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400309
The Android Open Source Project893912b2009-03-03 19:30:05 -0800310/* Release-Specific Flags */
311#define PNG_LIBPNG_BUILD_PATCH 8 /* Can be OR'ed with
312 PNG_LIBPNG_BUILD_STABLE only */
313#define PNG_LIBPNG_BUILD_PRIVATE 16 /* Cannot be OR'ed with
314 PNG_LIBPNG_BUILD_SPECIAL */
315#define PNG_LIBPNG_BUILD_SPECIAL 32 /* Cannot be OR'ed with
316 PNG_LIBPNG_BUILD_PRIVATE */
317
318#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_STABLE
319
320/* Careful here. At one time, Guy wanted to use 082, but that would be octal.
321 * We must not include leading zeros.
322 * Versions 0.7 through 1.0.0 were in the range 0 to 100 here (only
323 * version 1.0.0 was mis-numbered 100 instead of 10000). From
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400324 * version 1.0.1 it's xxyyzz, where x=major, y=minor, z=release
325 */
Matt Sarett9ea75692016-01-08 13:00:42 -0500326#define PNG_LIBPNG_VER 10620 /* 1.6.20 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800327
Chris Craikb50c2172013-07-29 15:28:30 -0700328/* Library configuration: these options cannot be changed after
329 * the library has been built.
330 */
331#ifndef PNGLCONF_H
332 /* If pnglibconf.h is missing, you can
333 * copy scripts/pnglibconf.h.prebuilt to pnglibconf.h
334 */
335# include "pnglibconf.h"
The Android Open Source Project893912b2009-03-03 19:30:05 -0800336#endif
337
Chris Craikb50c2172013-07-29 15:28:30 -0700338#ifndef PNG_VERSION_INFO_ONLY
339 /* Machine specific configuration. */
340# include "pngconf.h"
341#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -0800342
343/*
Chris Craikb50c2172013-07-29 15:28:30 -0700344 * Added at libpng-1.2.8
345 *
346 * Ref MSDN: Private as priority over Special
The Android Open Source Project893912b2009-03-03 19:30:05 -0800347 * VS_FF_PRIVATEBUILD File *was not* built using standard release
348 * procedures. If this value is given, the StringFileInfo block must
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400349 * contain a PrivateBuild string.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800350 *
351 * VS_FF_SPECIALBUILD File *was* built by the original company using
352 * standard release procedures but is a variation of the standard
353 * file of the same version number. If this value is given, the
Patrick Scotta0bb96c2009-07-22 11:50:02 -0400354 * StringFileInfo block must contain a SpecialBuild string.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800355 */
356
Chris Craikb50c2172013-07-29 15:28:30 -0700357#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800358# define PNG_LIBPNG_BUILD_TYPE \
Chris Craikb50c2172013-07-29 15:28:30 -0700359 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800360#else
Patrick Scott5f6bd842010-06-28 16:55:16 -0400361# ifdef PNG_LIBPNG_SPECIALBUILD
The Android Open Source Project893912b2009-03-03 19:30:05 -0800362# define PNG_LIBPNG_BUILD_TYPE \
Chris Craikb50c2172013-07-29 15:28:30 -0700363 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800364# else
365# define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
366# endif
367#endif
368
369#ifndef PNG_VERSION_INFO_ONLY
370
371/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
372#ifdef __cplusplus
373extern "C" {
374#endif /* __cplusplus */
375
The Android Open Source Project893912b2009-03-03 19:30:05 -0800376/* Version information for C files, stored in png.c. This had better match
377 * the version above.
378 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800379#define png_libpng_ver png_get_header_ver(NULL)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800380
Chris Craikb50c2172013-07-29 15:28:30 -0700381/* This file is arranged in several sections:
382 *
Matt Sarett9ea75692016-01-08 13:00:42 -0500383 * 1. [omitted]
384 * 2. Any configuration options that can be specified by for the application
Chris Craikb50c2172013-07-29 15:28:30 -0700385 * code when it is built. (Build time configuration is in pnglibconf.h)
Matt Sarett9ea75692016-01-08 13:00:42 -0500386 * 3. Type definitions (base types are defined in pngconf.h), structure
Chris Craikb50c2172013-07-29 15:28:30 -0700387 * definitions.
Matt Sarett9ea75692016-01-08 13:00:42 -0500388 * 4. Exported library functions.
389 * 5. Simplified API.
390 * 6. Implementation options.
Chris Craikb50c2172013-07-29 15:28:30 -0700391 *
392 * The library source code has additional files (principally pngpriv.h) that
393 * allow configuration of the library.
394 */
Matt Sarett9ea75692016-01-08 13:00:42 -0500395
396/* Section 1: [omitted] */
397
398/* Section 2: run time configuration
Chris Craikb50c2172013-07-29 15:28:30 -0700399 * See pnglibconf.h for build time configuration
400 *
401 * Run time configuration allows the application to choose between
402 * implementations of certain arithmetic APIs. The default is set
403 * at build time and recorded in pnglibconf.h, but it is safe to
404 * override these (and only these) settings. Note that this won't
405 * change what the library does, only application code, and the
406 * settings can (and probably should) be made on a per-file basis
407 * by setting the #defines before including png.h
408 *
409 * Use macros to read integers from PNG data or use the exported
410 * functions?
411 * PNG_USE_READ_MACROS: use the macros (see below) Note that
412 * the macros evaluate their argument multiple times.
413 * PNG_NO_USE_READ_MACROS: call the relevant library function.
414 *
415 * Use the alternative algorithm for compositing alpha samples that
416 * does not use division?
417 * PNG_READ_COMPOSITE_NODIV_SUPPORTED: use the 'no division'
418 * algorithm.
419 * PNG_NO_READ_COMPOSITE_NODIV: use the 'division' algorithm.
420 *
421 * How to handle benign errors if PNG_ALLOW_BENIGN_ERRORS is
422 * false?
423 * PNG_ALLOW_BENIGN_ERRORS: map calls to the benign error
424 * APIs to png_warning.
425 * Otherwise the calls are mapped to png_error.
426 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800427
Matt Sarett9ea75692016-01-08 13:00:42 -0500428/* Section 3: type definitions, including structures and compile time
Chris Craikb50c2172013-07-29 15:28:30 -0700429 * constants.
430 * See pngconf.h for base types that vary by machine/system
431 */
432
433/* This triggers a compiler error in png.c, if png.c and png.h
434 * do not agree upon the version number.
435 */
Matt Sarett9ea75692016-01-08 13:00:42 -0500436typedef char* png_libpng_version_1_6_20;
Chris Craikb50c2172013-07-29 15:28:30 -0700437
438/* Basic control structions. Read libpng-manual.txt or libpng.3 for more info.
439 *
440 * png_struct is the cache of information used while reading or writing a single
441 * PNG file. One of these is always required, although the simplified API
442 * (below) hides the creation and destruction of it.
443 */
444typedef struct png_struct_def png_struct;
445typedef const png_struct * png_const_structp;
446typedef png_struct * png_structp;
447typedef png_struct * * png_structpp;
448
449/* png_info contains information read from or to be written to a PNG file. One
450 * or more of these must exist while reading or creating a PNG file. The
451 * information is not used by libpng during read but is used to control what
452 * gets written when a PNG file is created. "png_get_" function calls read
453 * information during read and "png_set_" functions calls write information
454 * when creating a PNG.
455 * been moved into a separate header file that is not accessible to
456 * applications. Read libpng-manual.txt or libpng.3 for more info.
457 */
458typedef struct png_info_def png_info;
459typedef png_info * png_infop;
460typedef const png_info * png_const_infop;
461typedef png_info * * png_infopp;
462
463/* Types with names ending 'p' are pointer types. The corresponding types with
464 * names ending 'rp' are identical pointer types except that the pointer is
465 * marked 'restrict', which means that it is the only pointer to the object
466 * passed to the function. Applications should not use the 'restrict' types;
467 * it is always valid to pass 'p' to a pointer with a function argument of the
468 * corresponding 'rp' type. Different compilers have different rules with
469 * regard to type matching in the presence of 'restrict'. For backward
470 * compatibility libpng callbacks never have 'restrict' in their parameters and,
471 * consequentially, writing portable application code is extremely difficult if
472 * an attempt is made to use 'restrict'.
473 */
474typedef png_struct * PNG_RESTRICT png_structrp;
475typedef const png_struct * PNG_RESTRICT png_const_structrp;
476typedef png_info * PNG_RESTRICT png_inforp;
477typedef const png_info * PNG_RESTRICT png_const_inforp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800478
479/* Three color definitions. The order of the red, green, and blue, (and the
480 * exact size) is not important, although the size of the fields need to
481 * be png_byte or png_uint_16 (as defined below).
482 */
483typedef struct png_color_struct
484{
485 png_byte red;
486 png_byte green;
487 png_byte blue;
488} png_color;
Chris Craikb50c2172013-07-29 15:28:30 -0700489typedef png_color * png_colorp;
490typedef const png_color * png_const_colorp;
491typedef png_color * * png_colorpp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800492
493typedef struct png_color_16_struct
494{
495 png_byte index; /* used for palette files */
496 png_uint_16 red; /* for use in red green blue files */
497 png_uint_16 green;
498 png_uint_16 blue;
499 png_uint_16 gray; /* for use in grayscale files */
500} png_color_16;
Chris Craikb50c2172013-07-29 15:28:30 -0700501typedef png_color_16 * png_color_16p;
502typedef const png_color_16 * png_const_color_16p;
503typedef png_color_16 * * png_color_16pp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800504
505typedef struct png_color_8_struct
506{
507 png_byte red; /* for use in red green blue files */
508 png_byte green;
509 png_byte blue;
510 png_byte gray; /* for use in grayscale files */
511 png_byte alpha; /* for alpha channel files */
512} png_color_8;
Chris Craikb50c2172013-07-29 15:28:30 -0700513typedef png_color_8 * png_color_8p;
514typedef const png_color_8 * png_const_color_8p;
515typedef png_color_8 * * png_color_8pp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800516
517/*
518 * The following two structures are used for the in-core representation
519 * of sPLT chunks.
520 */
521typedef struct png_sPLT_entry_struct
522{
523 png_uint_16 red;
524 png_uint_16 green;
525 png_uint_16 blue;
526 png_uint_16 alpha;
527 png_uint_16 frequency;
528} png_sPLT_entry;
Chris Craikb50c2172013-07-29 15:28:30 -0700529typedef png_sPLT_entry * png_sPLT_entryp;
530typedef const png_sPLT_entry * png_const_sPLT_entryp;
531typedef png_sPLT_entry * * png_sPLT_entrypp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800532
533/* When the depth of the sPLT palette is 8 bits, the color and alpha samples
534 * occupy the LSB of their respective members, and the MSB of each member
535 * is zero-filled. The frequency member always occupies the full 16 bits.
536 */
537
538typedef struct png_sPLT_struct
539{
540 png_charp name; /* palette name */
541 png_byte depth; /* depth of palette samples */
542 png_sPLT_entryp entries; /* palette entries */
543 png_int_32 nentries; /* number of palette entries */
544} png_sPLT_t;
Chris Craikb50c2172013-07-29 15:28:30 -0700545typedef png_sPLT_t * png_sPLT_tp;
546typedef const png_sPLT_t * png_const_sPLT_tp;
547typedef png_sPLT_t * * png_sPLT_tpp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800548
549#ifdef PNG_TEXT_SUPPORTED
550/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,
551 * and whether that contents is compressed or not. The "key" field
Chris Craikb50c2172013-07-29 15:28:30 -0700552 * points to a regular zero-terminated C string. The "text" fields can be a
553 * regular C string, an empty string, or a NULL pointer.
554 * However, the structure returned by png_get_text() will always contain
555 * the "text" field as a regular zero-terminated C string (possibly
556 * empty), never a NULL pointer, so it can be safely used in printf() and
557 * other string-handling functions. Note that the "itxt_length", "lang", and
558 * "lang_key" members of the structure only exist when the library is built
559 * with iTXt chunk support. Prior to libpng-1.4.0 the library was built by
560 * default without iTXt support. Also note that when iTXt *is* supported,
561 * the "lang" and "lang_key" fields contain NULL pointers when the
562 * "compression" field contains * PNG_TEXT_COMPRESSION_NONE or
563 * PNG_TEXT_COMPRESSION_zTXt. Note that the "compression value" is not the
564 * same as what appears in the PNG tEXt/zTXt/iTXt chunk's "compression flag"
565 * which is always 0 or 1, or its "compression method" which is always 0.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800566 */
567typedef struct png_text_struct
568{
569 int compression; /* compression value:
570 -1: tEXt, none
571 0: zTXt, deflate
572 1: iTXt, none
573 2: iTXt, deflate */
574 png_charp key; /* keyword, 1-79 character description of "text" */
575 png_charp text; /* comment, may be an empty string (ie "")
576 or a NULL pointer */
577 png_size_t text_length; /* length of the text string */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800578 png_size_t itxt_length; /* length of the itxt string */
579 png_charp lang; /* language code, 0-79 characters
580 or a NULL pointer */
581 png_charp lang_key; /* keyword translated UTF-8 string, 0 or more
582 chars or a NULL pointer */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800583} png_text;
Chris Craikb50c2172013-07-29 15:28:30 -0700584typedef png_text * png_textp;
585typedef const png_text * png_const_textp;
586typedef png_text * * png_textpp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800587#endif
588
589/* Supported compression types for text in PNG files (tEXt, and zTXt).
Chris Craikb50c2172013-07-29 15:28:30 -0700590 * The values of the PNG_TEXT_COMPRESSION_ defines should NOT be changed. */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800591#define PNG_TEXT_COMPRESSION_NONE_WR -3
592#define PNG_TEXT_COMPRESSION_zTXt_WR -2
593#define PNG_TEXT_COMPRESSION_NONE -1
594#define PNG_TEXT_COMPRESSION_zTXt 0
595#define PNG_ITXT_COMPRESSION_NONE 1
596#define PNG_ITXT_COMPRESSION_zTXt 2
597#define PNG_TEXT_COMPRESSION_LAST 3 /* Not a valid value */
598
599/* png_time is a way to hold the time in an machine independent way.
600 * Two conversions are provided, both from time_t and struct tm. There
601 * is no portable way to convert to either of these structures, as far
602 * as I know. If you know of a portable way, send it to me. As a side
603 * note - PNG has always been Year 2000 compliant!
604 */
605typedef struct png_time_struct
606{
607 png_uint_16 year; /* full year, as in, 1995 */
608 png_byte month; /* month of year, 1 - 12 */
609 png_byte day; /* day of month, 1 - 31 */
610 png_byte hour; /* hour of day, 0 - 23 */
611 png_byte minute; /* minute of hour, 0 - 59 */
612 png_byte second; /* second of minute, 0 - 60 (for leap seconds) */
613} png_time;
Chris Craikb50c2172013-07-29 15:28:30 -0700614typedef png_time * png_timep;
615typedef const png_time * png_const_timep;
616typedef png_time * * png_timepp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800617
Sireesh Tripurarib478e662014-05-09 15:15:10 +0530618#if defined(PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED) ||\
619 defined(PNG_USER_CHUNKS_SUPPORTED)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800620/* png_unknown_chunk is a structure to hold queued chunks for which there is
621 * no specific support. The idea is that we can use this to queue
622 * up private chunks for output even though the library doesn't actually
623 * know about their semantics.
Chris Craikb50c2172013-07-29 15:28:30 -0700624 *
625 * The data in the structure is set by libpng on read and used on write.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800626 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800627typedef struct png_unknown_chunk_t
628{
Chris Craikb50c2172013-07-29 15:28:30 -0700629 png_byte name[5]; /* Textual chunk name with '\0' terminator */
630 png_byte *data; /* Data, should not be modified on read! */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800631 png_size_t size;
632
Chris Craikb50c2172013-07-29 15:28:30 -0700633 /* On write 'location' must be set using the flag values listed below.
634 * Notice that on read it is set by libpng however the values stored have
635 * more bits set than are listed below. Always treat the value as a
636 * bitmask. On write set only one bit - setting multiple bits may cause the
637 * chunk to be written in multiple places.
638 */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800639 png_byte location; /* mode of operation at read time */
640}
641png_unknown_chunk;
Chris Craikb50c2172013-07-29 15:28:30 -0700642
643typedef png_unknown_chunk * png_unknown_chunkp;
644typedef const png_unknown_chunk * png_const_unknown_chunkp;
645typedef png_unknown_chunk * * png_unknown_chunkpp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800646#endif
647
Chris Craikb50c2172013-07-29 15:28:30 -0700648/* Flag values for the unknown chunk location byte. */
649#define PNG_HAVE_IHDR 0x01
650#define PNG_HAVE_PLTE 0x02
651#define PNG_AFTER_IDAT 0x08
The Android Open Source Project893912b2009-03-03 19:30:05 -0800652
653/* Maximum positive integer used in PNG is (2^31)-1 */
654#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
655#define PNG_UINT_32_MAX ((png_uint_32)(-1))
656#define PNG_SIZE_MAX ((png_size_t)(-1))
Chris Craikb50c2172013-07-29 15:28:30 -0700657
658/* These are constants for fixed point values encoded in the
659 * PNG specification manner (x100000)
660 */
661#define PNG_FP_1 100000
662#define PNG_FP_HALF 50000
663#define PNG_FP_MAX ((png_fixed_point)0x7fffffffL)
664#define PNG_FP_MIN (-PNG_FP_MAX)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800665
666/* These describe the color_type field in png_info. */
667/* color type masks */
668#define PNG_COLOR_MASK_PALETTE 1
669#define PNG_COLOR_MASK_COLOR 2
670#define PNG_COLOR_MASK_ALPHA 4
671
672/* color types. Note that not all combinations are legal */
673#define PNG_COLOR_TYPE_GRAY 0
674#define PNG_COLOR_TYPE_PALETTE (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE)
675#define PNG_COLOR_TYPE_RGB (PNG_COLOR_MASK_COLOR)
676#define PNG_COLOR_TYPE_RGB_ALPHA (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA)
677#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
678/* aliases */
679#define PNG_COLOR_TYPE_RGBA PNG_COLOR_TYPE_RGB_ALPHA
680#define PNG_COLOR_TYPE_GA PNG_COLOR_TYPE_GRAY_ALPHA
681
682/* This is for compression type. PNG 1.0-1.2 only define the single type. */
683#define PNG_COMPRESSION_TYPE_BASE 0 /* Deflate method 8, 32K window */
684#define PNG_COMPRESSION_TYPE_DEFAULT PNG_COMPRESSION_TYPE_BASE
685
686/* This is for filter type. PNG 1.0-1.2 only define the single type. */
687#define PNG_FILTER_TYPE_BASE 0 /* Single row per-byte filtering */
688#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
689#define PNG_FILTER_TYPE_DEFAULT PNG_FILTER_TYPE_BASE
690
691/* These are for the interlacing type. These values should NOT be changed. */
692#define PNG_INTERLACE_NONE 0 /* Non-interlaced image */
693#define PNG_INTERLACE_ADAM7 1 /* Adam7 interlacing */
694#define PNG_INTERLACE_LAST 2 /* Not a valid value */
695
696/* These are for the oFFs chunk. These values should NOT be changed. */
697#define PNG_OFFSET_PIXEL 0 /* Offset in pixels */
698#define PNG_OFFSET_MICROMETER 1 /* Offset in micrometers (1/10^6 meter) */
699#define PNG_OFFSET_LAST 2 /* Not a valid value */
700
701/* These are for the pCAL chunk. These values should NOT be changed. */
702#define PNG_EQUATION_LINEAR 0 /* Linear transformation */
703#define PNG_EQUATION_BASE_E 1 /* Exponential base e transform */
704#define PNG_EQUATION_ARBITRARY 2 /* Arbitrary base exponential transform */
705#define PNG_EQUATION_HYPERBOLIC 3 /* Hyperbolic sine transformation */
706#define PNG_EQUATION_LAST 4 /* Not a valid value */
707
708/* These are for the sCAL chunk. These values should NOT be changed. */
709#define PNG_SCALE_UNKNOWN 0 /* unknown unit (image scale) */
710#define PNG_SCALE_METER 1 /* meters per pixel */
711#define PNG_SCALE_RADIAN 2 /* radians per pixel */
712#define PNG_SCALE_LAST 3 /* Not a valid value */
713
714/* These are for the pHYs chunk. These values should NOT be changed. */
715#define PNG_RESOLUTION_UNKNOWN 0 /* pixels/unknown unit (aspect ratio) */
716#define PNG_RESOLUTION_METER 1 /* pixels/meter */
717#define PNG_RESOLUTION_LAST 2 /* Not a valid value */
718
719/* These are for the sRGB chunk. These values should NOT be changed. */
720#define PNG_sRGB_INTENT_PERCEPTUAL 0
721#define PNG_sRGB_INTENT_RELATIVE 1
722#define PNG_sRGB_INTENT_SATURATION 2
723#define PNG_sRGB_INTENT_ABSOLUTE 3
724#define PNG_sRGB_INTENT_LAST 4 /* Not a valid value */
725
726/* This is for text chunks */
727#define PNG_KEYWORD_MAX_LENGTH 79
728
729/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
730#define PNG_MAX_PALETTE_LENGTH 256
731
732/* These determine if an ancillary chunk's data has been successfully read
733 * from the PNG header, or if the application has filled in the corresponding
734 * data in the info_struct to be written into the output file. The values
735 * of the PNG_INFO_<chunk> defines should NOT be changed.
736 */
737#define PNG_INFO_gAMA 0x0001
738#define PNG_INFO_sBIT 0x0002
739#define PNG_INFO_cHRM 0x0004
740#define PNG_INFO_PLTE 0x0008
741#define PNG_INFO_tRNS 0x0010
742#define PNG_INFO_bKGD 0x0020
743#define PNG_INFO_hIST 0x0040
744#define PNG_INFO_pHYs 0x0080
745#define PNG_INFO_oFFs 0x0100
746#define PNG_INFO_tIME 0x0200
747#define PNG_INFO_pCAL 0x0400
748#define PNG_INFO_sRGB 0x0800 /* GR-P, 0.96a */
749#define PNG_INFO_iCCP 0x1000 /* ESR, 1.0.6 */
750#define PNG_INFO_sPLT 0x2000 /* ESR, 1.0.6 */
751#define PNG_INFO_sCAL 0x4000 /* ESR, 1.0.6 */
Matt Sarett9ea75692016-01-08 13:00:42 -0500752#if INT_MAX >= 0x8000 /* else this might break */
Chris Craikb50c2172013-07-29 15:28:30 -0700753#define PNG_INFO_IDAT 0x8000 /* ESR, 1.0.6 */
Matt Sarett9ea75692016-01-08 13:00:42 -0500754#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -0800755
756/* This is used for the transformation routines, as some of them
757 * change these values for the row. It also should enable using
758 * the routines for other purposes.
759 */
760typedef struct png_row_info_struct
761{
Chris Craikb50c2172013-07-29 15:28:30 -0700762 png_uint_32 width; /* width of row */
763 png_size_t rowbytes; /* number of bytes in row */
764 png_byte color_type; /* color type of row */
765 png_byte bit_depth; /* bit depth of row */
766 png_byte channels; /* number of channels (1, 2, 3, or 4) */
The Android Open Source Project893912b2009-03-03 19:30:05 -0800767 png_byte pixel_depth; /* bits per pixel (depth * channels) */
768} png_row_info;
769
Chris Craikb50c2172013-07-29 15:28:30 -0700770typedef png_row_info * png_row_infop;
771typedef png_row_info * * png_row_infopp;
The Android Open Source Project893912b2009-03-03 19:30:05 -0800772
773/* These are the function types for the I/O functions and for the functions
774 * that allow the user to override the default I/O functions with his or her
775 * own. The png_error_ptr type should match that of user-supplied warning
776 * and error functions, while the png_rw_ptr type should match that of the
Chris Craikb50c2172013-07-29 15:28:30 -0700777 * user read/write data functions. Note that the 'write' function must not
778 * modify the buffer it is passed. The 'read' function, on the other hand, is
779 * expected to return the read data in the buffer.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800780 */
Chris Craikb50c2172013-07-29 15:28:30 -0700781typedef PNG_CALLBACK(void, *png_error_ptr, (png_structp, png_const_charp));
782typedef PNG_CALLBACK(void, *png_rw_ptr, (png_structp, png_bytep, png_size_t));
783typedef PNG_CALLBACK(void, *png_flush_ptr, (png_structp));
784typedef PNG_CALLBACK(void, *png_read_status_ptr, (png_structp, png_uint_32,
785 int));
786typedef PNG_CALLBACK(void, *png_write_status_ptr, (png_structp, png_uint_32,
787 int));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800788
Sireesh Tripurarib0277d02014-05-09 15:39:12 +0530789#ifdef PNG_INDEX_SUPPORTED
790typedef PNG_CALLBACK(void, *png_seek_ptr, (png_structp, png_uint_32));
791#endif
792
The Android Open Source Project893912b2009-03-03 19:30:05 -0800793#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -0700794typedef PNG_CALLBACK(void, *png_progressive_info_ptr, (png_structp, png_infop));
795typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop));
796
797/* The following callback receives png_uint_32 row_number, int pass for the
798 * png_bytep data of the row. When transforming an interlaced image the
799 * row number is the row number within the sub-image of the interlace pass, so
800 * the value will increase to the height of the sub-image (not the full image)
801 * then reset to 0 for the next pass.
802 *
803 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
804 * find the output pixel (x,y) given an interlaced sub-image pixel
805 * (row,col,pass). (See below for these macros.)
806 */
807typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,
808 png_uint_32, int));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800809#endif
810
811#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
Chris Craikb50c2172013-07-29 15:28:30 -0700812 defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
813typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
814 png_bytep));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800815#endif
816
Patrick Scott5f6bd842010-06-28 16:55:16 -0400817#ifdef PNG_USER_CHUNKS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -0700818typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
819 png_unknown_chunkp));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800820#endif
Patrick Scott5f6bd842010-06-28 16:55:16 -0400821#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -0700822/* not used anywhere */
823/* typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp)); */
824#endif
825
826#ifdef PNG_SETJMP_SUPPORTED
827/* This must match the function definition in <setjmp.h>, and the application
828 * must include this before png.h to obtain the definition of jmp_buf. The
829 * function is required to be PNG_NORETURN, but this is not checked. If the
830 * function does return the application will crash via an abort() or similar
831 * system level call.
832 *
833 * If you get a warning here while building the library you may need to make
834 * changes to ensure that pnglibconf.h records the calling convention used by
835 * your compiler. This may be very difficult - try using a different compiler
836 * to build the library!
837 */
838PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)), typedef);
The Android Open Source Project893912b2009-03-03 19:30:05 -0800839#endif
840
841/* Transform masks for the high-level interface */
842#define PNG_TRANSFORM_IDENTITY 0x0000 /* read and write */
843#define PNG_TRANSFORM_STRIP_16 0x0001 /* read only */
844#define PNG_TRANSFORM_STRIP_ALPHA 0x0002 /* read only */
845#define PNG_TRANSFORM_PACKING 0x0004 /* read and write */
846#define PNG_TRANSFORM_PACKSWAP 0x0008 /* read and write */
847#define PNG_TRANSFORM_EXPAND 0x0010 /* read only */
848#define PNG_TRANSFORM_INVERT_MONO 0x0020 /* read and write */
849#define PNG_TRANSFORM_SHIFT 0x0040 /* read and write */
850#define PNG_TRANSFORM_BGR 0x0080 /* read and write */
851#define PNG_TRANSFORM_SWAP_ALPHA 0x0100 /* read and write */
852#define PNG_TRANSFORM_SWAP_ENDIAN 0x0200 /* read and write */
853#define PNG_TRANSFORM_INVERT_ALPHA 0x0400 /* read and write */
Chris Craikb50c2172013-07-29 15:28:30 -0700854#define PNG_TRANSFORM_STRIP_FILLER 0x0800 /* write only */
The Android Open Source Project4215dd12009-03-09 11:52:12 -0700855/* Added to libpng-1.2.34 */
Chris Craikb50c2172013-07-29 15:28:30 -0700856#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
857#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
858/* Added to libpng-1.4.0 */
Patrick Scott5f6bd842010-06-28 16:55:16 -0400859#define PNG_TRANSFORM_GRAY_TO_RGB 0x2000 /* read only */
Chris Craikb50c2172013-07-29 15:28:30 -0700860/* Added to libpng-1.5.4 */
861#define PNG_TRANSFORM_EXPAND_16 0x4000 /* read only */
Matt Sarett9ea75692016-01-08 13:00:42 -0500862#if INT_MAX >= 0x8000 /* else this might break */
Chris Craikb50c2172013-07-29 15:28:30 -0700863#define PNG_TRANSFORM_SCALE_16 0x8000 /* read only */
Matt Sarett9ea75692016-01-08 13:00:42 -0500864#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -0800865
866/* Flags for MNG supported features */
867#define PNG_FLAG_MNG_EMPTY_PLTE 0x01
868#define PNG_FLAG_MNG_FILTER_64 0x04
869#define PNG_ALL_MNG_FEATURES 0x05
870
Chris Craikb50c2172013-07-29 15:28:30 -0700871/* NOTE: prior to 1.5 these functions had no 'API' style declaration,
872 * this allowed the zlib default functions to be used on Windows
873 * platforms. In 1.5 the zlib default malloc (which just calls malloc and
874 * ignores the first argument) should be completely compatible with the
875 * following.
The Android Open Source Project893912b2009-03-03 19:30:05 -0800876 */
Chris Craikb50c2172013-07-29 15:28:30 -0700877typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,
878 png_alloc_size_t));
879typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800880
Matt Sarett9ea75692016-01-08 13:00:42 -0500881/* Section 4: exported functions
Chris Craikb50c2172013-07-29 15:28:30 -0700882 * Here are the function definitions most commonly used. This is not
883 * the place to find out how to use libpng. See libpng-manual.txt for the
The Android Open Source Project893912b2009-03-03 19:30:05 -0800884 * full explanation, see example.c for the summary. This just provides
885 * a simple one line description of the use of each function.
Chris Craikb50c2172013-07-29 15:28:30 -0700886 *
887 * The PNG_EXPORT() and PNG_EXPORTA() macros used below are defined in
888 * pngconf.h and in the *.dfn files in the scripts directory.
889 *
890 * PNG_EXPORT(ordinal, type, name, (args));
891 *
892 * ordinal: ordinal that is used while building
893 * *.def files. The ordinal value is only
894 * relevant when preprocessing png.h with
895 * the *.dfn files for building symbol table
896 * entries, and are removed by pngconf.h.
897 * type: return type of the function
898 * name: function name
899 * args: function arguments, with types
900 *
901 * When we wish to append attributes to a function prototype we use
902 * the PNG_EXPORTA() macro instead.
903 *
904 * PNG_EXPORTA(ordinal, type, name, (args), attributes);
905 *
906 * ordinal, type, name, and args: same as in PNG_EXPORT().
907 * attributes: function attributes
The Android Open Source Project893912b2009-03-03 19:30:05 -0800908 */
909
910/* Returns the version number of the library */
Chris Craikb50c2172013-07-29 15:28:30 -0700911PNG_EXPORT(1, png_uint_32, png_access_version_number, (void));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800912
913/* Tell lib we have already handled the first <num_bytes> magic bytes.
914 * Handling more than 8 bytes from the beginning of the file is an error.
915 */
Chris Craikb50c2172013-07-29 15:28:30 -0700916PNG_EXPORT(2, void, png_set_sig_bytes, (png_structrp png_ptr, int num_bytes));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800917
918/* Check sig[start] through sig[start + num_to_check - 1] to see if it's a
919 * PNG file. Returns zero if the supplied bytes match the 8-byte PNG
920 * signature, and non-zero otherwise. Having num_to_check == 0 or
921 * start > 7 will always fail (ie return non-zero).
922 */
Chris Craikb50c2172013-07-29 15:28:30 -0700923PNG_EXPORT(3, int, png_sig_cmp, (png_const_bytep sig, png_size_t start,
924 png_size_t num_to_check));
The Android Open Source Project893912b2009-03-03 19:30:05 -0800925
926/* Simple signature checking function. This is the same as calling
927 * png_check_sig(sig, n) := !png_sig_cmp(sig, 0, n).
928 */
Chris Craikb50c2172013-07-29 15:28:30 -0700929#define png_check_sig(sig, n) !png_sig_cmp((sig), 0, (n))
The Android Open Source Project893912b2009-03-03 19:30:05 -0800930
931/* Allocate and initialize png_ptr struct for reading, and any other memory. */
Chris Craikb50c2172013-07-29 15:28:30 -0700932PNG_EXPORTA(4, png_structp, png_create_read_struct,
933 (png_const_charp user_png_ver, png_voidp error_ptr,
934 png_error_ptr error_fn, png_error_ptr warn_fn),
935 PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -0800936
937/* Allocate and initialize png_ptr struct for writing, and any other memory */
Chris Craikb50c2172013-07-29 15:28:30 -0700938PNG_EXPORTA(5, png_structp, png_create_write_struct,
939 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
940 png_error_ptr warn_fn),
941 PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -0800942
Chris Craikb50c2172013-07-29 15:28:30 -0700943PNG_EXPORT(6, png_size_t, png_get_compression_buffer_size,
944 (png_const_structrp png_ptr));
945
946PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structrp png_ptr,
947 png_size_t size));
948
949/* Moved from pngconf.h in 1.4.0 and modified to ensure setjmp/longjmp
950 * match up.
951 */
952#ifdef PNG_SETJMP_SUPPORTED
953/* This function returns the jmp_buf built in to *png_ptr. It must be
954 * supplied with an appropriate 'longjmp' function to use on that jmp_buf
955 * unless the default error function is overridden in which case NULL is
956 * acceptable. The size of the jmp_buf is checked against the actual size
957 * allocated by the library - the call will return NULL on a mismatch
958 * indicating an ABI mismatch.
959 */
960PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structrp png_ptr,
961 png_longjmp_ptr longjmp_fn, size_t jmp_buf_size));
962# define png_jmpbuf(png_ptr) \
963 (*png_set_longjmp_fn((png_ptr), longjmp, (sizeof (jmp_buf))))
964#else
965# define png_jmpbuf(png_ptr) \
966 (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
The Android Open Source Project893912b2009-03-03 19:30:05 -0800967#endif
Chris Craikb50c2172013-07-29 15:28:30 -0700968/* This function should be used by libpng applications in place of
969 * longjmp(png_ptr->jmpbuf, val). If longjmp_fn() has been set, it
970 * will use it; otherwise it will call PNG_ABORT(). This function was
971 * added in libpng-1.5.0.
972 */
973PNG_EXPORTA(9, void, png_longjmp, (png_const_structrp png_ptr, int val),
974 PNG_NORETURN);
The Android Open Source Project893912b2009-03-03 19:30:05 -0800975
Chris Craikb50c2172013-07-29 15:28:30 -0700976#ifdef PNG_READ_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -0800977/* Reset the compression stream */
Chris Craikb50c2172013-07-29 15:28:30 -0700978PNG_EXPORTA(10, int, png_reset_zstream, (png_structrp png_ptr), PNG_DEPRECATED);
979#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -0800980
981/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
982#ifdef PNG_USER_MEM_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -0700983PNG_EXPORTA(11, png_structp, png_create_read_struct_2,
984 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
985 png_error_ptr warn_fn,
986 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
987 PNG_ALLOCATED);
988PNG_EXPORTA(12, png_structp, png_create_write_struct_2,
989 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
990 png_error_ptr warn_fn,
991 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
992 PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -0800993#endif
994
Chris Craikb50c2172013-07-29 15:28:30 -0700995/* Write the PNG file signature. */
996PNG_EXPORT(13, void, png_write_sig, (png_structrp png_ptr));
997
The Android Open Source Project893912b2009-03-03 19:30:05 -0800998/* Write a PNG chunk - size, type, (optional) data, CRC. */
Chris Craikb50c2172013-07-29 15:28:30 -0700999PNG_EXPORT(14, void, png_write_chunk, (png_structrp png_ptr, png_const_bytep
1000 chunk_name, png_const_bytep data, png_size_t length));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001001
1002/* Write the start of a PNG chunk - length and chunk name. */
Chris Craikb50c2172013-07-29 15:28:30 -07001003PNG_EXPORT(15, void, png_write_chunk_start, (png_structrp png_ptr,
1004 png_const_bytep chunk_name, png_uint_32 length));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001005
1006/* Write the data of a PNG chunk started with png_write_chunk_start(). */
Chris Craikb50c2172013-07-29 15:28:30 -07001007PNG_EXPORT(16, void, png_write_chunk_data, (png_structrp png_ptr,
1008 png_const_bytep data, png_size_t length));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001009
1010/* Finish a chunk started with png_write_chunk_start() (includes CRC). */
Chris Craikb50c2172013-07-29 15:28:30 -07001011PNG_EXPORT(17, void, png_write_chunk_end, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001012
1013/* Allocate and initialize the info structure */
Chris Craikb50c2172013-07-29 15:28:30 -07001014PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_const_structrp png_ptr),
1015 PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001016
Chris Craikb50c2172013-07-29 15:28:30 -07001017/* DEPRECATED: this function allowed init structures to be created using the
1018 * default allocation method (typically malloc). Use is deprecated in 1.6.0 and
1019 * the API will be removed in the future.
1020 */
1021PNG_EXPORTA(19, void, png_info_init_3, (png_infopp info_ptr,
1022 png_size_t png_info_struct_size), PNG_DEPRECATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001023
1024/* Writes all the PNG information before the image. */
Chris Craikb50c2172013-07-29 15:28:30 -07001025PNG_EXPORT(20, void, png_write_info_before_PLTE,
1026 (png_structrp png_ptr, png_const_inforp info_ptr));
1027PNG_EXPORT(21, void, png_write_info,
1028 (png_structrp png_ptr, png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001029
Patrick Scott5f6bd842010-06-28 16:55:16 -04001030#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001031/* Read the information before the actual image data. */
Chris Craikb50c2172013-07-29 15:28:30 -07001032PNG_EXPORT(22, void, png_read_info,
1033 (png_structrp png_ptr, png_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001034#endif
1035
Patrick Scott5f6bd842010-06-28 16:55:16 -04001036#ifdef PNG_TIME_RFC1123_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001037 /* Convert to a US string format: there is no localization support in this
1038 * routine. The original implementation used a 29 character buffer in
1039 * png_struct, this will be removed in future versions.
1040 */
1041#if PNG_LIBPNG_VER < 10700
1042/* To do: remove this from libpng17 (and from libpng17/png.c and pngstruct.h) */
1043PNG_EXPORTA(23, png_const_charp, png_convert_to_rfc1123, (png_structrp png_ptr,
1044 png_const_timep ptime),PNG_DEPRECATED);
1045#endif
1046PNG_EXPORT(241, int, png_convert_to_rfc1123_buffer, (char out[29],
1047 png_const_timep ptime));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001048#endif
1049
Patrick Scott5f6bd842010-06-28 16:55:16 -04001050#ifdef PNG_CONVERT_tIME_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001051/* Convert from a struct tm to png_time */
Chris Craikb50c2172013-07-29 15:28:30 -07001052PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime,
1053 const struct tm * ttime));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001054
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001055/* Convert from time_t to png_time. Uses gmtime() */
Chris Craikb50c2172013-07-29 15:28:30 -07001056PNG_EXPORT(25, void, png_convert_from_time_t, (png_timep ptime, time_t ttime));
Matt Sarett9ea75692016-01-08 13:00:42 -05001057#endif /* CONVERT_tIME */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001058
Patrick Scott5f6bd842010-06-28 16:55:16 -04001059#ifdef PNG_READ_EXPAND_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001060/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
Chris Craikb50c2172013-07-29 15:28:30 -07001061PNG_EXPORT(26, void, png_set_expand, (png_structrp png_ptr));
1062PNG_EXPORT(27, void, png_set_expand_gray_1_2_4_to_8, (png_structrp png_ptr));
1063PNG_EXPORT(28, void, png_set_palette_to_rgb, (png_structrp png_ptr));
1064PNG_EXPORT(29, void, png_set_tRNS_to_alpha, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001065#endif
Chris Craikb50c2172013-07-29 15:28:30 -07001066
1067#ifdef PNG_READ_EXPAND_16_SUPPORTED
1068/* Expand to 16-bit channels, forces conversion of palette to RGB and expansion
1069 * of a tRNS chunk if present.
1070 */
1071PNG_EXPORT(221, void, png_set_expand_16, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001072#endif
1073
1074#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
1075/* Use blue, green, red order for pixels. */
Chris Craikb50c2172013-07-29 15:28:30 -07001076PNG_EXPORT(30, void, png_set_bgr, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001077#endif
1078
Patrick Scott5f6bd842010-06-28 16:55:16 -04001079#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001080/* Expand the grayscale to 24-bit RGB if necessary. */
Chris Craikb50c2172013-07-29 15:28:30 -07001081PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001082#endif
1083
Patrick Scott5f6bd842010-06-28 16:55:16 -04001084#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001085/* Reduce RGB to grayscale. */
Chris Craikb50c2172013-07-29 15:28:30 -07001086#define PNG_ERROR_ACTION_NONE 1
1087#define PNG_ERROR_ACTION_WARN 2
1088#define PNG_ERROR_ACTION_ERROR 3
1089#define PNG_RGB_TO_GRAY_DEFAULT (-1)/*for red/green coefficients*/
1090
1091PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structrp png_ptr,
1092 int error_action, double red, double green))
1093PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structrp png_ptr,
1094 int error_action, png_fixed_point red, png_fixed_point green))
1095
1096PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structrp
1097 png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001098#endif
1099
Chris Craikb50c2172013-07-29 15:28:30 -07001100#ifdef PNG_BUILD_GRAYSCALE_PALETTE_SUPPORTED
1101PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth,
1102 png_colorp palette));
1103#endif
1104
1105#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301106/* How the alpha channel is interpreted - this affects how the color channels
1107 * of a PNG file are returned to the calling application when an alpha channel,
1108 * or a tRNS chunk in a palette file, is present.
Chris Craikb50c2172013-07-29 15:28:30 -07001109 *
1110 * This has no effect on the way pixels are written into a PNG output
1111 * datastream. The color samples in a PNG datastream are never premultiplied
1112 * with the alpha samples.
1113 *
1114 * The default is to return data according to the PNG specification: the alpha
1115 * channel is a linear measure of the contribution of the pixel to the
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301116 * corresponding composited pixel, and the color channels are unassociated
1117 * (not premultiplied). The gamma encoded color channels must be scaled
1118 * according to the contribution and to do this it is necessary to undo
Chris Craikb50c2172013-07-29 15:28:30 -07001119 * the encoding, scale the color values, perform the composition and reencode
1120 * the values. This is the 'PNG' mode.
1121 *
1122 * The alternative is to 'associate' the alpha with the color information by
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301123 * storing color channel values that have been scaled by the alpha.
1124 * image. These are the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' modes
1125 * (the latter being the two common names for associated alpha color channels).
Chris Craikb50c2172013-07-29 15:28:30 -07001126 *
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301127 * For the 'OPTIMIZED' mode, a pixel is treated as opaque only if the alpha
1128 * value is equal to the maximum value.
Chris Craikb50c2172013-07-29 15:28:30 -07001129 *
1130 * The final choice is to gamma encode the alpha channel as well. This is
1131 * broken because, in practice, no implementation that uses this choice
1132 * correctly undoes the encoding before handling alpha composition. Use this
1133 * choice only if other serious errors in the software or hardware you use
1134 * mandate it; the typical serious error is for dark halos to appear around
1135 * opaque areas of the composited PNG image because of arithmetic overflow.
1136 *
1137 * The API function png_set_alpha_mode specifies which of these choices to use
1138 * with an enumerated 'mode' value and the gamma of the required output:
1139 */
1140#define PNG_ALPHA_PNG 0 /* according to the PNG standard */
1141#define PNG_ALPHA_STANDARD 1 /* according to Porter/Duff */
1142#define PNG_ALPHA_ASSOCIATED 1 /* as above; this is the normal practice */
1143#define PNG_ALPHA_PREMULTIPLIED 1 /* as above */
1144#define PNG_ALPHA_OPTIMIZED 2 /* 'PNG' for opaque pixels, else 'STANDARD' */
1145#define PNG_ALPHA_BROKEN 3 /* the alpha channel is gamma encoded */
1146
1147PNG_FP_EXPORT(227, void, png_set_alpha_mode, (png_structrp png_ptr, int mode,
1148 double output_gamma))
1149PNG_FIXED_EXPORT(228, void, png_set_alpha_mode_fixed, (png_structrp png_ptr,
1150 int mode, png_fixed_point output_gamma))
1151#endif
1152
1153#if defined(PNG_GAMMA_SUPPORTED) || defined(PNG_READ_ALPHA_MODE_SUPPORTED)
1154/* The output_gamma value is a screen gamma in libpng terminology: it expresses
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301155 * how to decode the output values, not how they are encoded.
Chris Craikb50c2172013-07-29 15:28:30 -07001156 */
1157#define PNG_DEFAULT_sRGB -1 /* sRGB gamma and color space */
1158#define PNG_GAMMA_MAC_18 -2 /* Old Mac '1.8' gamma and color space */
1159#define PNG_GAMMA_sRGB 220000 /* Television standards--matches sRGB gamma */
1160#define PNG_GAMMA_LINEAR PNG_FP_1 /* Linear */
1161#endif
1162
1163/* The following are examples of calls to png_set_alpha_mode to achieve the
1164 * required overall gamma correction and, where necessary, alpha
1165 * premultiplication.
1166 *
1167 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1168 * This is the default libpng handling of the alpha channel - it is not
1169 * pre-multiplied into the color components. In addition the call states
1170 * that the output is for a sRGB system and causes all PNG files without gAMA
1171 * chunks to be assumed to be encoded using sRGB.
1172 *
1173 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1174 * In this case the output is assumed to be something like an sRGB conformant
1175 * display preceeded by a power-law lookup table of power 1.45. This is how
1176 * early Mac systems behaved.
1177 *
1178 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);
1179 * This is the classic Jim Blinn approach and will work in academic
1180 * environments where everything is done by the book. It has the shortcoming
1181 * of assuming that input PNG data with no gamma information is linear - this
1182 * is unlikely to be correct unless the PNG files where generated locally.
1183 * Most of the time the output precision will be so low as to show
1184 * significant banding in dark areas of the image.
1185 *
1186 * png_set_expand_16(pp);
1187 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB);
1188 * This is a somewhat more realistic Jim Blinn inspired approach. PNG files
1189 * are assumed to have the sRGB encoding if not marked with a gamma value and
1190 * the output is always 16 bits per component. This permits accurate scaling
1191 * and processing of the data. If you know that your input PNG files were
1192 * generated locally you might need to replace PNG_DEFAULT_sRGB with the
1193 * correct value for your system.
1194 *
1195 * png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB);
1196 * If you just need to composite the PNG image onto an existing background
1197 * and if you control the code that does this you can use the optimization
1198 * setting. In this case you just copy completely opaque pixels to the
1199 * output. For pixels that are not completely transparent (you just skip
1200 * those) you do the composition math using png_composite or png_composite_16
1201 * below then encode the resultant 8-bit or 16-bit values to match the output
1202 * encoding.
1203 *
1204 * Other cases
1205 * If neither the PNG nor the standard linear encoding work for you because
1206 * of the software or hardware you use then you have a big problem. The PNG
1207 * case will probably result in halos around the image. The linear encoding
1208 * will probably result in a washed out, too bright, image (it's actually too
1209 * contrasty.) Try the ALPHA_OPTIMIZED mode above - this will probably
1210 * substantially reduce the halos. Alternatively try:
1211 *
1212 * png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB);
1213 * This option will also reduce the halos, but there will be slight dark
1214 * halos round the opaque parts of the image where the background is light.
1215 * In the OPTIMIZED mode the halos will be light halos where the background
1216 * is dark. Take your pick - the halos are unavoidable unless you can get
1217 * your hardware/software fixed! (The OPTIMIZED approach is slightly
1218 * faster.)
1219 *
1220 * When the default gamma of PNG files doesn't match the output gamma.
1221 * If you have PNG files with no gamma information png_set_alpha_mode allows
1222 * you to provide a default gamma, but it also sets the ouput gamma to the
1223 * matching value. If you know your PNG files have a gamma that doesn't
1224 * match the output you can take advantage of the fact that
1225 * png_set_alpha_mode always sets the output gamma but only sets the PNG
1226 * default if it is not already set:
1227 *
1228 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1229 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1230 * The first call sets both the default and the output gamma values, the
1231 * second call overrides the output gamma without changing the default. This
1232 * is easier than achieving the same effect with png_set_gamma. You must use
1233 * PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will
1234 * fire if more than one call to png_set_alpha_mode and png_set_background is
1235 * made in the same read operation, however multiple calls with PNG_ALPHA_PNG
1236 * are ignored.
1237 */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001238
Patrick Scott5f6bd842010-06-28 16:55:16 -04001239#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001240PNG_EXPORT(36, void, png_set_strip_alpha, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001241#endif
1242
1243#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
1244 defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
Chris Craikb50c2172013-07-29 15:28:30 -07001245PNG_EXPORT(37, void, png_set_swap_alpha, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001246#endif
1247
1248#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
1249 defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
Chris Craikb50c2172013-07-29 15:28:30 -07001250PNG_EXPORT(38, void, png_set_invert_alpha, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001251#endif
1252
1253#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
Matt Sarett9ea75692016-01-08 13:00:42 -05001254/* Add a filler byte to 8-bit or 16-bit Gray or 24-bit or 48-bit RGB images. */
Chris Craikb50c2172013-07-29 15:28:30 -07001255PNG_EXPORT(39, void, png_set_filler, (png_structrp png_ptr, png_uint_32 filler,
1256 int flags));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001257/* The values of the PNG_FILLER_ defines should NOT be changed */
Chris Craikb50c2172013-07-29 15:28:30 -07001258# define PNG_FILLER_BEFORE 0
1259# define PNG_FILLER_AFTER 1
Matt Sarett9ea75692016-01-08 13:00:42 -05001260/* Add an alpha byte to 8-bit or 16-bit Gray or 24-bit or 48-bit RGB images. */
Chris Craikb50c2172013-07-29 15:28:30 -07001261PNG_EXPORT(40, void, png_set_add_alpha, (png_structrp png_ptr,
1262 png_uint_32 filler, int flags));
Matt Sarett9ea75692016-01-08 13:00:42 -05001263#endif /* READ_FILLER || WRITE_FILLER */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001264
1265#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
1266/* Swap bytes in 16-bit depth files. */
Chris Craikb50c2172013-07-29 15:28:30 -07001267PNG_EXPORT(41, void, png_set_swap, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001268#endif
1269
1270#if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED)
1271/* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */
Chris Craikb50c2172013-07-29 15:28:30 -07001272PNG_EXPORT(42, void, png_set_packing, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001273#endif
1274
Chris Craikb50c2172013-07-29 15:28:30 -07001275#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
1276 defined(PNG_WRITE_PACKSWAP_SUPPORTED)
The Android Open Source Project893912b2009-03-03 19:30:05 -08001277/* Swap packing order of pixels in bytes. */
Chris Craikb50c2172013-07-29 15:28:30 -07001278PNG_EXPORT(43, void, png_set_packswap, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001279#endif
1280
1281#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
1282/* Converts files to legal bit depths. */
Chris Craikb50c2172013-07-29 15:28:30 -07001283PNG_EXPORT(44, void, png_set_shift, (png_structrp png_ptr, png_const_color_8p
1284 true_bits));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001285#endif
1286
1287#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
1288 defined(PNG_WRITE_INTERLACING_SUPPORTED)
Chris Craikb50c2172013-07-29 15:28:30 -07001289/* Have the code handle the interlacing. Returns the number of passes.
1290 * MUST be called before png_read_update_info or png_start_read_image,
1291 * otherwise it will not have the desired effect. Note that it is still
1292 * necessary to call png_read_row or png_read_rows png_get_image_height
1293 * times for each pass.
1294*/
1295PNG_EXPORT(45, int, png_set_interlace_handling, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001296#endif
1297
1298#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
1299/* Invert monochrome files */
Chris Craikb50c2172013-07-29 15:28:30 -07001300PNG_EXPORT(46, void, png_set_invert_mono, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001301#endif
1302
Patrick Scott5f6bd842010-06-28 16:55:16 -04001303#ifdef PNG_READ_BACKGROUND_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001304/* Handle alpha and tRNS by replacing with a background color. Prior to
1305 * libpng-1.5.4 this API must not be called before the PNG file header has been
1306 * read. Doing so will result in unexpected behavior and possible warnings or
1307 * errors if the PNG file contains a bKGD chunk.
1308 */
1309PNG_FP_EXPORT(47, void, png_set_background, (png_structrp png_ptr,
1310 png_const_color_16p background_color, int background_gamma_code,
1311 int need_expand, double background_gamma))
1312PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structrp png_ptr,
1313 png_const_color_16p background_color, int background_gamma_code,
1314 int need_expand, png_fixed_point background_gamma))
The Android Open Source Project893912b2009-03-03 19:30:05 -08001315#endif
Chris Craikb50c2172013-07-29 15:28:30 -07001316#ifdef PNG_READ_BACKGROUND_SUPPORTED
1317# define PNG_BACKGROUND_GAMMA_UNKNOWN 0
1318# define PNG_BACKGROUND_GAMMA_SCREEN 1
1319# define PNG_BACKGROUND_GAMMA_FILE 2
1320# define PNG_BACKGROUND_GAMMA_UNIQUE 3
The Android Open Source Project893912b2009-03-03 19:30:05 -08001321#endif
1322
Chris Craikb50c2172013-07-29 15:28:30 -07001323#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
1324/* Scale a 16-bit depth file down to 8-bit, accurately. */
1325PNG_EXPORT(229, void, png_set_scale_16, (png_structrp png_ptr));
1326#endif
1327
1328#ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED
1329#define PNG_READ_16_TO_8 SUPPORTED /* Name prior to 1.5.4 */
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001330/* Strip the second byte of information from a 16-bit depth file. */
Chris Craikb50c2172013-07-29 15:28:30 -07001331PNG_EXPORT(48, void, png_set_strip_16, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001332#endif
1333
Chris Craikb50c2172013-07-29 15:28:30 -07001334#ifdef PNG_READ_QUANTIZE_SUPPORTED
1335/* Turn on quantizing, and reduce the palette to the number of colors
1336 * available.
1337 */
1338PNG_EXPORT(49, void, png_set_quantize, (png_structrp png_ptr,
1339 png_colorp palette, int num_palette, int maximum_colors,
1340 png_const_uint_16p histogram, int full_quantize));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001341#endif
1342
Patrick Scott5f6bd842010-06-28 16:55:16 -04001343#ifdef PNG_READ_GAMMA_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001344/* The threshold on gamma processing is configurable but hard-wired into the
1345 * library. The following is the floating point variant.
1346 */
1347#define PNG_GAMMA_THRESHOLD (PNG_GAMMA_THRESHOLD_FIXED*.00001)
The Android Open Source Project893912b2009-03-03 19:30:05 -08001348
Chris Craikb50c2172013-07-29 15:28:30 -07001349/* Handle gamma correction. Screen_gamma=(display_exponent).
1350 * NOTE: this API simply sets the screen and file gamma values. It will
1351 * therefore override the value for gamma in a PNG file if it is called after
1352 * the file header has been read - use with care - call before reading the PNG
1353 * file for best results!
1354 *
1355 * These routines accept the same gamma values as png_set_alpha_mode (described
1356 * above). The PNG_GAMMA_ defines and PNG_DEFAULT_sRGB can be passed to either
1357 * API (floating point or fixed.) Notice, however, that the 'file_gamma' value
1358 * is the inverse of a 'screen gamma' value.
1359 */
1360PNG_FP_EXPORT(50, void, png_set_gamma, (png_structrp png_ptr,
1361 double screen_gamma, double override_file_gamma))
1362PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structrp png_ptr,
1363 png_fixed_point screen_gamma, png_fixed_point override_file_gamma))
The Android Open Source Project893912b2009-03-03 19:30:05 -08001364#endif
1365
Patrick Scott5f6bd842010-06-28 16:55:16 -04001366#ifdef PNG_WRITE_FLUSH_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001367/* Set how many lines between output flushes - 0 for no flushing */
Chris Craikb50c2172013-07-29 15:28:30 -07001368PNG_EXPORT(51, void, png_set_flush, (png_structrp png_ptr, int nrows));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001369/* Flush the current PNG output buffer */
Chris Craikb50c2172013-07-29 15:28:30 -07001370PNG_EXPORT(52, void, png_write_flush, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001371#endif
1372
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001373/* Optional update palette with requested transformations */
Chris Craikb50c2172013-07-29 15:28:30 -07001374PNG_EXPORT(53, void, png_start_read_image, (png_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001375
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001376/* Optional call to update the users info structure */
Chris Craikb50c2172013-07-29 15:28:30 -07001377PNG_EXPORT(54, void, png_read_update_info, (png_structrp png_ptr,
1378 png_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001379
Chris Craikb50c2172013-07-29 15:28:30 -07001380#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001381/* Read one or more rows of image data. */
Chris Craikb50c2172013-07-29 15:28:30 -07001382PNG_EXPORT(55, void, png_read_rows, (png_structrp png_ptr, png_bytepp row,
1383 png_bytepp display_row, png_uint_32 num_rows));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001384#endif
1385
Chris Craikb50c2172013-07-29 15:28:30 -07001386#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001387/* Read a row of data. */
Chris Craikb50c2172013-07-29 15:28:30 -07001388PNG_EXPORT(56, void, png_read_row, (png_structrp png_ptr, png_bytep row,
1389 png_bytep display_row));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001390#endif
1391
Chris Craikb50c2172013-07-29 15:28:30 -07001392#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001393/* Read the whole image into memory at once. */
Chris Craikb50c2172013-07-29 15:28:30 -07001394PNG_EXPORT(57, void, png_read_image, (png_structrp png_ptr, png_bytepp image));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001395#endif
1396
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001397/* Write a row of image data */
Chris Craikb50c2172013-07-29 15:28:30 -07001398PNG_EXPORT(58, void, png_write_row, (png_structrp png_ptr,
1399 png_const_bytep row));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001400
Chris Craikb50c2172013-07-29 15:28:30 -07001401/* Write a few rows of image data: (*row) is not written; however, the type
1402 * is declared as writeable to maintain compatibility with previous versions
1403 * of libpng and to allow the 'display_row' array from read_rows to be passed
1404 * unchanged to write_rows.
1405 */
1406PNG_EXPORT(59, void, png_write_rows, (png_structrp png_ptr, png_bytepp row,
1407 png_uint_32 num_rows));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001408
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001409/* Write the image data */
Chris Craikb50c2172013-07-29 15:28:30 -07001410PNG_EXPORT(60, void, png_write_image, (png_structrp png_ptr, png_bytepp image));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001411
Chris Craikb50c2172013-07-29 15:28:30 -07001412/* Write the end of the PNG file. */
1413PNG_EXPORT(61, void, png_write_end, (png_structrp png_ptr,
1414 png_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001415
Chris Craikb50c2172013-07-29 15:28:30 -07001416#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001417/* Read the end of the PNG file. */
Chris Craikb50c2172013-07-29 15:28:30 -07001418PNG_EXPORT(62, void, png_read_end, (png_structrp png_ptr, png_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001419#endif
1420
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001421/* Free any memory associated with the png_info_struct */
Chris Craikb50c2172013-07-29 15:28:30 -07001422PNG_EXPORT(63, void, png_destroy_info_struct, (png_const_structrp png_ptr,
1423 png_infopp info_ptr_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001424
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001425/* Free any memory associated with the png_struct and the png_info_structs */
Chris Craikb50c2172013-07-29 15:28:30 -07001426PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr,
1427 png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001428
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001429/* Free any memory associated with the png_struct and the png_info_structs */
Chris Craikb50c2172013-07-29 15:28:30 -07001430PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr,
1431 png_infopp info_ptr_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001432
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001433/* Set the libpng method of handling chunk CRC errors */
Chris Craikb50c2172013-07-29 15:28:30 -07001434PNG_EXPORT(66, void, png_set_crc_action, (png_structrp png_ptr, int crit_action,
1435 int ancil_action));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001436
Chris Craikb50c2172013-07-29 15:28:30 -07001437/* Values for png_set_crc_action() say how to handle CRC errors in
The Android Open Source Project893912b2009-03-03 19:30:05 -08001438 * ancillary and critical chunks, and whether to use the data contained
1439 * therein. Note that it is impossible to "discard" data in a critical
1440 * chunk. For versions prior to 0.90, the action was always error/quit,
1441 * whereas in version 0.90 and later, the action for CRC errors in ancillary
1442 * chunks is warn/discard. These values should NOT be changed.
1443 *
1444 * value action:critical action:ancillary
1445 */
1446#define PNG_CRC_DEFAULT 0 /* error/quit warn/discard data */
1447#define PNG_CRC_ERROR_QUIT 1 /* error/quit error/quit */
1448#define PNG_CRC_WARN_DISCARD 2 /* (INVALID) warn/discard data */
1449#define PNG_CRC_WARN_USE 3 /* warn/use data warn/use data */
1450#define PNG_CRC_QUIET_USE 4 /* quiet/use data quiet/use data */
1451#define PNG_CRC_NO_CHANGE 5 /* use current value use current value */
1452
Matt Sarett9ea75692016-01-08 13:00:42 -05001453#ifdef PNG_WRITE_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001454/* These functions give the user control over the scan-line filtering in
1455 * libpng and the compression methods used by zlib. These functions are
1456 * mainly useful for testing, as the defaults should work with most users.
1457 * Those users who are tight on memory or want faster performance at the
1458 * expense of compression can modify them. See the compression library
1459 * header file (zlib.h) for an explination of the compression functions.
1460 */
1461
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001462/* Set the filtering method(s) used by libpng. Currently, the only valid
The Android Open Source Project893912b2009-03-03 19:30:05 -08001463 * value for "method" is 0.
1464 */
Chris Craikb50c2172013-07-29 15:28:30 -07001465PNG_EXPORT(67, void, png_set_filter, (png_structrp png_ptr, int method,
1466 int filters));
Matt Sarett9ea75692016-01-08 13:00:42 -05001467#endif /* WRITE */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001468
1469/* Flags for png_set_filter() to say which filters to use. The flags
1470 * are chosen so that they don't conflict with real filter types
1471 * below, in case they are supplied instead of the #defined constants.
1472 * These values should NOT be changed.
1473 */
1474#define PNG_NO_FILTERS 0x00
1475#define PNG_FILTER_NONE 0x08
1476#define PNG_FILTER_SUB 0x10
1477#define PNG_FILTER_UP 0x20
1478#define PNG_FILTER_AVG 0x40
1479#define PNG_FILTER_PAETH 0x80
1480#define PNG_ALL_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP | \
1481 PNG_FILTER_AVG | PNG_FILTER_PAETH)
1482
1483/* Filter values (not flags) - used in pngwrite.c, pngwutil.c for now.
1484 * These defines should NOT be changed.
1485 */
1486#define PNG_FILTER_VALUE_NONE 0
1487#define PNG_FILTER_VALUE_SUB 1
1488#define PNG_FILTER_VALUE_UP 2
1489#define PNG_FILTER_VALUE_AVG 3
1490#define PNG_FILTER_VALUE_PAETH 4
1491#define PNG_FILTER_VALUE_LAST 5
1492
Matt Sarett9ea75692016-01-08 13:00:42 -05001493#ifdef PNG_WRITE_SUPPORTED
1494#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* DEPRECATED */
Chris Craikb50c2172013-07-29 15:28:30 -07001495PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structrp png_ptr,
1496 int heuristic_method, int num_weights, png_const_doublep filter_weights,
1497 png_const_doublep filter_costs))
1498PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed,
1499 (png_structrp png_ptr, int heuristic_method, int num_weights,
1500 png_const_fixed_point_p filter_weights,
1501 png_const_fixed_point_p filter_costs))
Matt Sarett9ea75692016-01-08 13:00:42 -05001502#endif /* WRITE_WEIGHTED_FILTER */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001503
Matt Sarett9ea75692016-01-08 13:00:42 -05001504/* The following are no longer used and will be removed from libpng-1.7: */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001505#define PNG_FILTER_HEURISTIC_DEFAULT 0 /* Currently "UNWEIGHTED" */
1506#define PNG_FILTER_HEURISTIC_UNWEIGHTED 1 /* Used by libpng < 0.95 */
1507#define PNG_FILTER_HEURISTIC_WEIGHTED 2 /* Experimental feature */
1508#define PNG_FILTER_HEURISTIC_LAST 3 /* Not a valid value */
1509
1510/* Set the library compression level. Currently, valid values range from
1511 * 0 - 9, corresponding directly to the zlib compression levels 0 - 9
1512 * (0 - no compression, 9 - "maximal" compression). Note that tests have
1513 * shown that zlib compression levels 3-6 usually perform as well as level 9
1514 * for PNG images, and do considerably fewer caclulations. In the future,
1515 * these values may not correspond directly to the zlib compression levels.
1516 */
Matt Sarett9ea75692016-01-08 13:00:42 -05001517#ifdef PNG_WRITE_CUSTOMIZE_COMPRESSION_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001518PNG_EXPORT(69, void, png_set_compression_level, (png_structrp png_ptr,
1519 int level));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001520
Chris Craikb50c2172013-07-29 15:28:30 -07001521PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structrp png_ptr,
1522 int mem_level));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001523
Chris Craikb50c2172013-07-29 15:28:30 -07001524PNG_EXPORT(71, void, png_set_compression_strategy, (png_structrp png_ptr,
1525 int strategy));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001526
Chris Craikb50c2172013-07-29 15:28:30 -07001527/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1528 * smaller value of window_bits if it can do so safely.
1529 */
1530PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structrp png_ptr,
1531 int window_bits));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001532
Chris Craikb50c2172013-07-29 15:28:30 -07001533PNG_EXPORT(73, void, png_set_compression_method, (png_structrp png_ptr,
1534 int method));
Matt Sarett9ea75692016-01-08 13:00:42 -05001535#endif /* WRITE_CUSTOMIZE_COMPRESSION */
Chris Craikb50c2172013-07-29 15:28:30 -07001536
1537#ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED
1538/* Also set zlib parameters for compressing non-IDAT chunks */
1539PNG_EXPORT(222, void, png_set_text_compression_level, (png_structrp png_ptr,
1540 int level));
1541
1542PNG_EXPORT(223, void, png_set_text_compression_mem_level, (png_structrp png_ptr,
1543 int mem_level));
1544
1545PNG_EXPORT(224, void, png_set_text_compression_strategy, (png_structrp png_ptr,
1546 int strategy));
1547
1548/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1549 * smaller value of window_bits if it can do so safely.
1550 */
1551PNG_EXPORT(225, void, png_set_text_compression_window_bits,
1552 (png_structrp png_ptr, int window_bits));
1553
1554PNG_EXPORT(226, void, png_set_text_compression_method, (png_structrp png_ptr,
1555 int method));
Matt Sarett9ea75692016-01-08 13:00:42 -05001556#endif /* WRITE_CUSTOMIZE_ZTXT_COMPRESSION */
1557#endif /* WRITE */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001558
1559/* These next functions are called for input/output, memory, and error
1560 * handling. They are in the file pngrio.c, pngwio.c, and pngerror.c,
1561 * and call standard C I/O routines such as fread(), fwrite(), and
1562 * fprintf(). These functions can be made to use other I/O routines
1563 * at run time for those applications that need to handle I/O in a
Chris Craikb50c2172013-07-29 15:28:30 -07001564 * different manner by calling png_set_???_fn(). See libpng-manual.txt for
The Android Open Source Project893912b2009-03-03 19:30:05 -08001565 * more information.
1566 */
1567
Patrick Scott5f6bd842010-06-28 16:55:16 -04001568#ifdef PNG_STDIO_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001569/* Initialize the input/output for the PNG file to the default functions. */
Chris Craikb50c2172013-07-29 15:28:30 -07001570PNG_EXPORT(74, void, png_init_io, (png_structrp png_ptr, png_FILE_p fp));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001571#endif
1572
1573/* Replace the (error and abort), and warning functions with user
1574 * supplied functions. If no messages are to be printed you must still
1575 * write and use replacement functions. The replacement error_fn should
1576 * still do a longjmp to the last setjmp location if you are using this
1577 * method of error handling. If error_fn or warning_fn is NULL, the
1578 * default function will be used.
1579 */
1580
Chris Craikb50c2172013-07-29 15:28:30 -07001581PNG_EXPORT(75, void, png_set_error_fn, (png_structrp png_ptr,
1582 png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warning_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001583
1584/* Return the user pointer associated with the error functions */
Chris Craikb50c2172013-07-29 15:28:30 -07001585PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001586
1587/* Replace the default data output functions with a user supplied one(s).
1588 * If buffered output is not used, then output_flush_fn can be set to NULL.
1589 * If PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile time
1590 * output_flush_fn will be ignored (and thus can be NULL).
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001591 * It is probably a mistake to use NULL for output_flush_fn if
1592 * write_data_fn is not also NULL unless you have built libpng with
1593 * PNG_WRITE_FLUSH_SUPPORTED undefined, because in this case libpng's
1594 * default flush function, which uses the standard *FILE structure, will
1595 * be used.
The Android Open Source Project893912b2009-03-03 19:30:05 -08001596 */
Chris Craikb50c2172013-07-29 15:28:30 -07001597PNG_EXPORT(77, void, png_set_write_fn, (png_structrp png_ptr, png_voidp io_ptr,
1598 png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001599
1600/* Replace the default data input function with a user supplied one. */
Chris Craikb50c2172013-07-29 15:28:30 -07001601PNG_EXPORT(78, void, png_set_read_fn, (png_structrp png_ptr, png_voidp io_ptr,
1602 png_rw_ptr read_data_fn));
Joseph Wen4ce0ee12010-08-20 10:42:22 +08001603
The Android Open Source Project893912b2009-03-03 19:30:05 -08001604/* Return the user pointer associated with the I/O functions */
Chris Craikb50c2172013-07-29 15:28:30 -07001605PNG_EXPORT(79, png_voidp, png_get_io_ptr, (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001606
Chris Craikb50c2172013-07-29 15:28:30 -07001607PNG_EXPORT(80, void, png_set_read_status_fn, (png_structrp png_ptr,
1608 png_read_status_ptr read_row_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001609
Chris Craikb50c2172013-07-29 15:28:30 -07001610PNG_EXPORT(81, void, png_set_write_status_fn, (png_structrp png_ptr,
1611 png_write_status_ptr write_row_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001612
1613#ifdef PNG_USER_MEM_SUPPORTED
1614/* Replace the default memory allocation functions with user supplied one(s). */
Chris Craikb50c2172013-07-29 15:28:30 -07001615PNG_EXPORT(82, void, png_set_mem_fn, (png_structrp png_ptr, png_voidp mem_ptr,
1616 png_malloc_ptr malloc_fn, png_free_ptr free_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001617/* Return the user pointer associated with the memory functions */
Chris Craikb50c2172013-07-29 15:28:30 -07001618PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001619#endif
1620
Chris Craikb50c2172013-07-29 15:28:30 -07001621#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
1622PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structrp png_ptr,
1623 png_user_transform_ptr read_user_transform_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001624#endif
1625
Chris Craikb50c2172013-07-29 15:28:30 -07001626#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
1627PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structrp png_ptr,
1628 png_user_transform_ptr write_user_transform_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001629#endif
1630
Chris Craikb50c2172013-07-29 15:28:30 -07001631#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED
1632PNG_EXPORT(86, void, png_set_user_transform_info, (png_structrp png_ptr,
1633 png_voidp user_transform_ptr, int user_transform_depth,
1634 int user_transform_channels));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001635/* Return the user pointer associated with the user transform functions */
Chris Craikb50c2172013-07-29 15:28:30 -07001636PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr,
1637 (png_const_structrp png_ptr));
1638#endif
1639
1640#ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED
1641/* Return information about the row currently being processed. Note that these
1642 * APIs do not fail but will return unexpected results if called outside a user
1643 * transform callback. Also note that when transforming an interlaced image the
1644 * row number is the row number within the sub-image of the interlace pass, so
1645 * the value will increase to the height of the sub-image (not the full image)
1646 * then reset to 0 for the next pass.
1647 *
1648 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
1649 * find the output pixel (x,y) given an interlaced sub-image pixel
1650 * (row,col,pass). (See below for these macros.)
1651 */
1652PNG_EXPORT(217, png_uint_32, png_get_current_row_number, (png_const_structrp));
1653PNG_EXPORT(218, png_byte, png_get_current_pass_number, (png_const_structrp));
1654#endif
1655
1656#ifdef PNG_READ_USER_CHUNKS_SUPPORTED
1657/* This callback is called only for *unknown* chunks. If
1658 * PNG_HANDLE_AS_UNKNOWN_SUPPORTED is set then it is possible to set known
1659 * chunks to be treated as unknown, however in this case the callback must do
1660 * any processing required by the chunk (e.g. by calling the appropriate
1661 * png_set_ APIs.)
1662 *
1663 * There is no write support - on write, by default, all the chunks in the
1664 * 'unknown' list are written in the specified position.
1665 *
1666 * The integer return from the callback function is interpreted thus:
1667 *
Matt Sarett9ea75692016-01-08 13:00:42 -05001668 * negative: An error occurred; png_chunk_error will be called.
Chris Craikb50c2172013-07-29 15:28:30 -07001669 * zero: The chunk was not handled, the chunk will be saved. A critical
1670 * chunk will cause an error at this point unless it is to be saved.
1671 * positive: The chunk was handled, libpng will ignore/discard it.
1672 *
1673 * See "INTERACTION WTIH USER CHUNK CALLBACKS" below for important notes about
1674 * how this behavior will change in libpng 1.7
1675 */
1676PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structrp png_ptr,
1677 png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001678#endif
1679
1680#ifdef PNG_USER_CHUNKS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001681PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001682#endif
1683
1684#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
1685/* Sets the function callbacks for the push reader, and a pointer to a
1686 * user-defined structure available to the callback functions.
1687 */
Chris Craikb50c2172013-07-29 15:28:30 -07001688PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structrp png_ptr,
1689 png_voidp progressive_ptr, png_progressive_info_ptr info_fn,
1690 png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001691
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001692/* Returns the user pointer associated with the push read functions */
Chris Craikb50c2172013-07-29 15:28:30 -07001693PNG_EXPORT(91, png_voidp, png_get_progressive_ptr,
1694 (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001695
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001696/* Function to be called when data becomes available */
Chris Craikb50c2172013-07-29 15:28:30 -07001697PNG_EXPORT(92, void, png_process_data, (png_structrp png_ptr,
1698 png_inforp info_ptr, png_bytep buffer, png_size_t buffer_size));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001699
Chris Craikb50c2172013-07-29 15:28:30 -07001700/* A function which may be called *only* within png_process_data to stop the
1701 * processing of any more data. The function returns the number of bytes
1702 * remaining, excluding any that libpng has cached internally. A subsequent
1703 * call to png_process_data must supply these bytes again. If the argument
1704 * 'save' is set to true the routine will first save all the pending data and
1705 * will always return 0.
The Android Open Source Project893912b2009-03-03 19:30:05 -08001706 */
Chris Craikb50c2172013-07-29 15:28:30 -07001707PNG_EXPORT(219, png_size_t, png_process_data_pause, (png_structrp, int save));
1708
1709/* A function which may be called *only* outside (after) a call to
1710 * png_process_data. It returns the number of bytes of data to skip in the
1711 * input. Normally it will return 0, but if it returns a non-zero value the
1712 * application must skip than number of bytes of input data and pass the
1713 * following data to the next call to png_process_data.
1714 */
1715PNG_EXPORT(220, png_uint_32, png_process_data_skip, (png_structrp));
1716
Chris Craikb50c2172013-07-29 15:28:30 -07001717/* Function that combines rows. 'new_row' is a flag that should come from
1718 * the callback and be non-NULL if anything needs to be done; the library
1719 * stores its own version of the new data internally and ignores the passed
1720 * in value.
1721 */
1722PNG_EXPORT(93, void, png_progressive_combine_row, (png_const_structrp png_ptr,
1723 png_bytep old_row, png_const_bytep new_row));
Matt Sarett9ea75692016-01-08 13:00:42 -05001724#endif /* PROGRESSIVE_READ */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001725
Chris Craikb50c2172013-07-29 15:28:30 -07001726PNG_EXPORTA(94, png_voidp, png_malloc, (png_const_structrp png_ptr,
1727 png_alloc_size_t size), PNG_ALLOCATED);
1728/* Added at libpng version 1.4.0 */
1729PNG_EXPORTA(95, png_voidp, png_calloc, (png_const_structrp png_ptr,
1730 png_alloc_size_t size), PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001731
The Android Open Source Project893912b2009-03-03 19:30:05 -08001732/* Added at libpng version 1.2.4 */
Chris Craikb50c2172013-07-29 15:28:30 -07001733PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_const_structrp png_ptr,
1734 png_alloc_size_t size), PNG_ALLOCATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001735
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001736/* Frees a pointer allocated by png_malloc() */
Chris Craikb50c2172013-07-29 15:28:30 -07001737PNG_EXPORT(97, void, png_free, (png_const_structrp png_ptr, png_voidp ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001738
1739/* Free data that was allocated internally */
Chris Craikb50c2172013-07-29 15:28:30 -07001740PNG_EXPORT(98, void, png_free_data, (png_const_structrp png_ptr,
1741 png_inforp info_ptr, png_uint_32 free_me, int num));
1742
The Android Open Source Project893912b2009-03-03 19:30:05 -08001743/* Reassign responsibility for freeing existing data, whether allocated
Chris Craikb50c2172013-07-29 15:28:30 -07001744 * by libpng or by the application; this works on the png_info structure passed
1745 * in, it does not change the state for other png_info structures.
1746 *
1747 * It is unlikely that this function works correctly as of 1.6.0 and using it
1748 * may result either in memory leaks or double free of allocated data.
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001749 */
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301750PNG_EXPORT(99, void, png_data_freer, (png_const_structrp png_ptr,
1751 png_inforp info_ptr, int freer, png_uint_32 mask));
John Reck90bf0d22013-08-14 10:37:42 -07001752
Sireesh Tripurarib0277d02014-05-09 15:39:12 +05301753#ifdef PNG_INDEX_SUPPORTED
1754/* Build image index for partial image decoding. */
1755PNG_EXPORT(300, void, png_build_index, (png_structp png_ptr));
1756PNG_EXPORT(301, void, png_configure_decoder,
1757 (png_structp png_ptr, int *row_offset, int pass));
1758/* Set the data seek function with a user supplied one.
1759 * REQUIRED by partial image decode.
1760 */
1761PNG_EXPORT(302, void, png_set_seek_fn, (png_structp png_ptr,
1762 png_seek_ptr seek_data_fn));
1763/* Update the decoder status to the given pass */
1764PNG_EXPORT(303, void, png_set_interlaced_pass, (png_structp png_ptr, int pass));
1765#endif
1766
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001767/* Assignments for png_data_freer */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001768#define PNG_DESTROY_WILL_FREE_DATA 1
1769#define PNG_SET_WILL_FREE_DATA 1
1770#define PNG_USER_WILL_FREE_DATA 2
1771/* Flags for png_ptr->free_me and info_ptr->free_me */
1772#define PNG_FREE_HIST 0x0008
1773#define PNG_FREE_ICCP 0x0010
1774#define PNG_FREE_SPLT 0x0020
1775#define PNG_FREE_ROWS 0x0040
1776#define PNG_FREE_PCAL 0x0080
1777#define PNG_FREE_SCAL 0x0100
Chris Craikb50c2172013-07-29 15:28:30 -07001778#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED
1779# define PNG_FREE_UNKN 0x0200
1780#endif
1781/* PNG_FREE_LIST 0x0400 removed in 1.6.0 because it is ignored */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001782#define PNG_FREE_PLTE 0x1000
1783#define PNG_FREE_TRNS 0x2000
1784#define PNG_FREE_TEXT 0x4000
1785#define PNG_FREE_ALL 0x7fff
1786#define PNG_FREE_MUL 0x4220 /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
1787
1788#ifdef PNG_USER_MEM_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001789PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_const_structrp png_ptr,
1790 png_alloc_size_t size), PNG_ALLOCATED PNG_DEPRECATED);
1791PNG_EXPORTA(101, void, png_free_default, (png_const_structrp png_ptr,
1792 png_voidp ptr), PNG_DEPRECATED);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001793#endif
1794
Chris Craikb50c2172013-07-29 15:28:30 -07001795#ifdef PNG_ERROR_TEXT_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001796/* Fatal error in PNG image of libpng - can't continue */
Chris Craikb50c2172013-07-29 15:28:30 -07001797PNG_EXPORTA(102, void, png_error, (png_const_structrp png_ptr,
1798 png_const_charp error_message), PNG_NORETURN);
The Android Open Source Project893912b2009-03-03 19:30:05 -08001799
1800/* The same, but the chunk name is prepended to the error string. */
Chris Craikb50c2172013-07-29 15:28:30 -07001801PNG_EXPORTA(103, void, png_chunk_error, (png_const_structrp png_ptr,
1802 png_const_charp error_message), PNG_NORETURN);
1803
The Android Open Source Project893912b2009-03-03 19:30:05 -08001804#else
1805/* Fatal error in PNG image of libpng - can't continue */
Chris Craikb50c2172013-07-29 15:28:30 -07001806PNG_EXPORTA(104, void, png_err, (png_const_structrp png_ptr), PNG_NORETURN);
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301807# define png_error(s1,s2) png_err(s1)
1808# define png_chunk_error(s1,s2) png_err(s1)
The Android Open Source Project893912b2009-03-03 19:30:05 -08001809#endif
1810
Chris Craikb50c2172013-07-29 15:28:30 -07001811#ifdef PNG_WARNINGS_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001812/* Non-fatal error in libpng. Can continue, but may have a problem. */
Chris Craikb50c2172013-07-29 15:28:30 -07001813PNG_EXPORT(105, void, png_warning, (png_const_structrp png_ptr,
1814 png_const_charp warning_message));
1815
1816/* Non-fatal error in libpng, chunk name is prepended to message. */
1817PNG_EXPORT(106, void, png_chunk_warning, (png_const_structrp png_ptr,
1818 png_const_charp warning_message));
Sireesh Tripurarib478e662014-05-09 15:15:10 +05301819#else
1820# define png_warning(s1,s2) ((void)(s1))
1821# define png_chunk_warning(s1,s2) ((void)(s1))
Chris Craikb50c2172013-07-29 15:28:30 -07001822#endif
1823
1824#ifdef PNG_BENIGN_ERRORS_SUPPORTED
1825/* Benign error in libpng. Can continue, but may have a problem.
1826 * User can choose whether to handle as a fatal error or as a warning. */
1827PNG_EXPORT(107, void, png_benign_error, (png_const_structrp png_ptr,
1828 png_const_charp warning_message));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001829
1830#ifdef PNG_READ_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001831/* Same, chunk name is prepended to message (only during read) */
1832PNG_EXPORT(108, void, png_chunk_benign_error, (png_const_structrp png_ptr,
1833 png_const_charp warning_message));
1834#endif
1835
1836PNG_EXPORT(109, void, png_set_benign_errors,
1837 (png_structrp png_ptr, int allowed));
1838#else
1839# ifdef PNG_ALLOW_BENIGN_ERRORS
1840# define png_benign_error png_warning
1841# define png_chunk_benign_error png_chunk_warning
1842# else
1843# define png_benign_error png_error
1844# define png_chunk_benign_error png_chunk_error
1845# endif
1846#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08001847
1848/* The png_set_<chunk> functions are for storing values in the png_info_struct.
1849 * Similarly, the png_get_<chunk> calls are used to read values from the
1850 * png_info_struct, either storing the parameters in the passed variables, or
1851 * setting pointers into the png_info_struct where the data is stored. The
1852 * png_get_<chunk> functions return a non-zero value if the data was available
1853 * in info_ptr, or return zero and do not change any of the parameters if the
1854 * data was not available.
1855 *
1856 * These functions should be used instead of directly accessing png_info
1857 * to avoid problems with future changes in the size and internal layout of
1858 * png_info_struct.
1859 */
1860/* Returns "flag" if chunk data is valid in info_ptr. */
Chris Craikb50c2172013-07-29 15:28:30 -07001861PNG_EXPORT(110, png_uint_32, png_get_valid, (png_const_structrp png_ptr,
1862 png_const_inforp info_ptr, png_uint_32 flag));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001863
1864/* Returns number of bytes needed to hold a transformed row. */
Chris Craikb50c2172013-07-29 15:28:30 -07001865PNG_EXPORT(111, png_size_t, png_get_rowbytes, (png_const_structrp png_ptr,
1866 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001867
Patrick Scott5f6bd842010-06-28 16:55:16 -04001868#ifdef PNG_INFO_IMAGE_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001869/* Returns row_pointers, which is an array of pointers to scanlines that was
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001870 * returned from png_read_png().
1871 */
Chris Craikb50c2172013-07-29 15:28:30 -07001872PNG_EXPORT(112, png_bytepp, png_get_rows, (png_const_structrp png_ptr,
1873 png_const_inforp info_ptr));
1874
The Android Open Source Project893912b2009-03-03 19:30:05 -08001875/* Set row_pointers, which is an array of pointers to scanlines for use
Patrick Scotta0bb96c2009-07-22 11:50:02 -04001876 * by png_write_png().
1877 */
Chris Craikb50c2172013-07-29 15:28:30 -07001878PNG_EXPORT(113, void, png_set_rows, (png_const_structrp png_ptr,
1879 png_inforp info_ptr, png_bytepp row_pointers));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001880#endif
1881
1882/* Returns number of color channels in image. */
Chris Craikb50c2172013-07-29 15:28:30 -07001883PNG_EXPORT(114, png_byte, png_get_channels, (png_const_structrp png_ptr,
1884 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001885
1886#ifdef PNG_EASY_ACCESS_SUPPORTED
1887/* Returns image width in pixels. */
Chris Craikb50c2172013-07-29 15:28:30 -07001888PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structrp png_ptr,
1889 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001890
1891/* Returns image height in pixels. */
Chris Craikb50c2172013-07-29 15:28:30 -07001892PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structrp png_ptr,
1893 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001894
1895/* Returns image bit_depth. */
Chris Craikb50c2172013-07-29 15:28:30 -07001896PNG_EXPORT(117, png_byte, png_get_bit_depth, (png_const_structrp png_ptr,
1897 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001898
1899/* Returns image color_type. */
Chris Craikb50c2172013-07-29 15:28:30 -07001900PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structrp png_ptr,
1901 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001902
1903/* Returns image filter_type. */
Chris Craikb50c2172013-07-29 15:28:30 -07001904PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structrp png_ptr,
1905 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001906
1907/* Returns image interlace_type. */
Chris Craikb50c2172013-07-29 15:28:30 -07001908PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structrp png_ptr,
1909 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001910
1911/* Returns image compression_type. */
Chris Craikb50c2172013-07-29 15:28:30 -07001912PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structrp png_ptr,
1913 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001914
1915/* Returns image resolution in pixels per meter, from pHYs chunk data. */
Chris Craikb50c2172013-07-29 15:28:30 -07001916PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter,
1917 (png_const_structrp png_ptr, png_const_inforp info_ptr));
1918PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter,
1919 (png_const_structrp png_ptr, png_const_inforp info_ptr));
1920PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter,
1921 (png_const_structrp png_ptr, png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001922
1923/* Returns pixel aspect ratio, computed from pHYs chunk data. */
Chris Craikb50c2172013-07-29 15:28:30 -07001924PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio,
1925 (png_const_structrp png_ptr, png_const_inforp info_ptr))
1926PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed,
1927 (png_const_structrp png_ptr, png_const_inforp info_ptr))
The Android Open Source Project893912b2009-03-03 19:30:05 -08001928
1929/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
Chris Craikb50c2172013-07-29 15:28:30 -07001930PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels,
1931 (png_const_structrp png_ptr, png_const_inforp info_ptr));
1932PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels,
1933 (png_const_structrp png_ptr, png_const_inforp info_ptr));
1934PNG_EXPORT(128, png_int_32, png_get_x_offset_microns,
1935 (png_const_structrp png_ptr, png_const_inforp info_ptr));
1936PNG_EXPORT(129, png_int_32, png_get_y_offset_microns,
1937 (png_const_structrp png_ptr, png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001938
Matt Sarett9ea75692016-01-08 13:00:42 -05001939#endif /* EASY_ACCESS */
The Android Open Source Project893912b2009-03-03 19:30:05 -08001940
Chris Craikb50c2172013-07-29 15:28:30 -07001941#ifdef PNG_READ_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08001942/* Returns pointer to signature string read from PNG header */
Chris Craikb50c2172013-07-29 15:28:30 -07001943PNG_EXPORT(130, png_const_bytep, png_get_signature, (png_const_structrp png_ptr,
1944 png_const_inforp info_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001945#endif
1946
Patrick Scott5f6bd842010-06-28 16:55:16 -04001947#ifdef PNG_bKGD_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001948PNG_EXPORT(131, png_uint_32, png_get_bKGD, (png_const_structrp png_ptr,
1949 png_inforp info_ptr, png_color_16p *background));
1950#endif
1951
1952#ifdef PNG_bKGD_SUPPORTED
1953PNG_EXPORT(132, void, png_set_bKGD, (png_const_structrp png_ptr,
1954 png_inforp info_ptr, png_const_color_16p background));
The Android Open Source Project893912b2009-03-03 19:30:05 -08001955#endif
1956
Patrick Scott5f6bd842010-06-28 16:55:16 -04001957#ifdef PNG_cHRM_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001958PNG_FP_EXPORT(133, png_uint_32, png_get_cHRM, (png_const_structrp png_ptr,
1959 png_const_inforp info_ptr, double *white_x, double *white_y, double *red_x,
1960 double *red_y, double *green_x, double *green_y, double *blue_x,
1961 double *blue_y))
1962PNG_FP_EXPORT(230, png_uint_32, png_get_cHRM_XYZ, (png_const_structrp png_ptr,
1963 png_const_inforp info_ptr, double *red_X, double *red_Y, double *red_Z,
1964 double *green_X, double *green_Y, double *green_Z, double *blue_X,
1965 double *blue_Y, double *blue_Z))
1966PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed,
1967 (png_const_structrp png_ptr, png_const_inforp info_ptr,
1968 png_fixed_point *int_white_x, png_fixed_point *int_white_y,
1969 png_fixed_point *int_red_x, png_fixed_point *int_red_y,
1970 png_fixed_point *int_green_x, png_fixed_point *int_green_y,
1971 png_fixed_point *int_blue_x, png_fixed_point *int_blue_y))
1972PNG_FIXED_EXPORT(231, png_uint_32, png_get_cHRM_XYZ_fixed,
1973 (png_const_structrp png_ptr, png_const_inforp info_ptr,
1974 png_fixed_point *int_red_X, png_fixed_point *int_red_Y,
1975 png_fixed_point *int_red_Z, png_fixed_point *int_green_X,
1976 png_fixed_point *int_green_Y, png_fixed_point *int_green_Z,
1977 png_fixed_point *int_blue_X, png_fixed_point *int_blue_Y,
1978 png_fixed_point *int_blue_Z))
The Android Open Source Project893912b2009-03-03 19:30:05 -08001979#endif
1980
Patrick Scott5f6bd842010-06-28 16:55:16 -04001981#ifdef PNG_cHRM_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07001982PNG_FP_EXPORT(135, void, png_set_cHRM, (png_const_structrp png_ptr,
1983 png_inforp info_ptr,
1984 double white_x, double white_y, double red_x, double red_y, double green_x,
1985 double green_y, double blue_x, double blue_y))
1986PNG_FP_EXPORT(232, void, png_set_cHRM_XYZ, (png_const_structrp png_ptr,
1987 png_inforp info_ptr, double red_X, double red_Y, double red_Z,
1988 double green_X, double green_Y, double green_Z, double blue_X,
1989 double blue_Y, double blue_Z))
1990PNG_FIXED_EXPORT(136, void, png_set_cHRM_fixed, (png_const_structrp png_ptr,
1991 png_inforp info_ptr, png_fixed_point int_white_x,
1992 png_fixed_point int_white_y, png_fixed_point int_red_x,
1993 png_fixed_point int_red_y, png_fixed_point int_green_x,
1994 png_fixed_point int_green_y, png_fixed_point int_blue_x,
1995 png_fixed_point int_blue_y))
1996PNG_FIXED_EXPORT(233, void, png_set_cHRM_XYZ_fixed, (png_const_structrp png_ptr,
1997 png_inforp info_ptr, png_fixed_point int_red_X, png_fixed_point int_red_Y,
1998 png_fixed_point int_red_Z, png_fixed_point int_green_X,
1999 png_fixed_point int_green_Y, png_fixed_point int_green_Z,
2000 png_fixed_point int_blue_X, png_fixed_point int_blue_Y,
2001 png_fixed_point int_blue_Z))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002002#endif
2003
Patrick Scott5f6bd842010-06-28 16:55:16 -04002004#ifdef PNG_gAMA_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002005PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA, (png_const_structrp png_ptr,
2006 png_const_inforp info_ptr, double *file_gamma))
2007PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed,
2008 (png_const_structrp png_ptr, png_const_inforp info_ptr,
2009 png_fixed_point *int_file_gamma))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002010#endif
2011
Patrick Scott5f6bd842010-06-28 16:55:16 -04002012#ifdef PNG_gAMA_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002013PNG_FP_EXPORT(139, void, png_set_gAMA, (png_const_structrp png_ptr,
2014 png_inforp info_ptr, double file_gamma))
2015PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_const_structrp png_ptr,
2016 png_inforp info_ptr, png_fixed_point int_file_gamma))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002017#endif
2018
Patrick Scott5f6bd842010-06-28 16:55:16 -04002019#ifdef PNG_hIST_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002020PNG_EXPORT(141, png_uint_32, png_get_hIST, (png_const_structrp png_ptr,
2021 png_inforp info_ptr, png_uint_16p *hist));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002022#endif
2023
Patrick Scott5f6bd842010-06-28 16:55:16 -04002024#ifdef PNG_hIST_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002025PNG_EXPORT(142, void, png_set_hIST, (png_const_structrp png_ptr,
2026 png_inforp info_ptr, png_const_uint_16p hist));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002027#endif
2028
Chris Craikb50c2172013-07-29 15:28:30 -07002029PNG_EXPORT(143, png_uint_32, png_get_IHDR, (png_const_structrp png_ptr,
2030 png_const_inforp info_ptr, png_uint_32 *width, png_uint_32 *height,
2031 int *bit_depth, int *color_type, int *interlace_method,
2032 int *compression_method, int *filter_method));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002033
Chris Craikb50c2172013-07-29 15:28:30 -07002034PNG_EXPORT(144, void, png_set_IHDR, (png_const_structrp png_ptr,
2035 png_inforp info_ptr, png_uint_32 width, png_uint_32 height, int bit_depth,
2036 int color_type, int interlace_method, int compression_method,
2037 int filter_method));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002038
Patrick Scott5f6bd842010-06-28 16:55:16 -04002039#ifdef PNG_oFFs_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002040PNG_EXPORT(145, png_uint_32, png_get_oFFs, (png_const_structrp png_ptr,
2041 png_const_inforp info_ptr, png_int_32 *offset_x, png_int_32 *offset_y,
The Android Open Source Project893912b2009-03-03 19:30:05 -08002042 int *unit_type));
2043#endif
2044
Patrick Scott5f6bd842010-06-28 16:55:16 -04002045#ifdef PNG_oFFs_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002046PNG_EXPORT(146, void, png_set_oFFs, (png_const_structrp png_ptr,
2047 png_inforp info_ptr, png_int_32 offset_x, png_int_32 offset_y,
2048 int unit_type));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002049#endif
2050
Patrick Scott5f6bd842010-06-28 16:55:16 -04002051#ifdef PNG_pCAL_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002052PNG_EXPORT(147, png_uint_32, png_get_pCAL, (png_const_structrp png_ptr,
2053 png_inforp info_ptr, png_charp *purpose, png_int_32 *X0,
2054 png_int_32 *X1, int *type, int *nparams, png_charp *units,
2055 png_charpp *params));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002056#endif
2057
Patrick Scott5f6bd842010-06-28 16:55:16 -04002058#ifdef PNG_pCAL_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002059PNG_EXPORT(148, void, png_set_pCAL, (png_const_structrp png_ptr,
2060 png_inforp info_ptr, png_const_charp purpose, png_int_32 X0, png_int_32 X1,
2061 int type, int nparams, png_const_charp units, png_charpp params));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002062#endif
2063
Patrick Scott5f6bd842010-06-28 16:55:16 -04002064#ifdef PNG_pHYs_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002065PNG_EXPORT(149, png_uint_32, png_get_pHYs, (png_const_structrp png_ptr,
2066 png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
2067 int *unit_type));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002068#endif
2069
Patrick Scott5f6bd842010-06-28 16:55:16 -04002070#ifdef PNG_pHYs_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002071PNG_EXPORT(150, void, png_set_pHYs, (png_const_structrp png_ptr,
2072 png_inforp info_ptr, png_uint_32 res_x, png_uint_32 res_y, int unit_type));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002073#endif
2074
Chris Craikb50c2172013-07-29 15:28:30 -07002075PNG_EXPORT(151, png_uint_32, png_get_PLTE, (png_const_structrp png_ptr,
2076 png_inforp info_ptr, png_colorp *palette, int *num_palette));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002077
Chris Craikb50c2172013-07-29 15:28:30 -07002078PNG_EXPORT(152, void, png_set_PLTE, (png_structrp png_ptr,
2079 png_inforp info_ptr, png_const_colorp palette, int num_palette));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002080
Patrick Scott5f6bd842010-06-28 16:55:16 -04002081#ifdef PNG_sBIT_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002082PNG_EXPORT(153, png_uint_32, png_get_sBIT, (png_const_structrp png_ptr,
2083 png_inforp info_ptr, png_color_8p *sig_bit));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002084#endif
2085
Patrick Scott5f6bd842010-06-28 16:55:16 -04002086#ifdef PNG_sBIT_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002087PNG_EXPORT(154, void, png_set_sBIT, (png_const_structrp png_ptr,
2088 png_inforp info_ptr, png_const_color_8p sig_bit));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002089#endif
2090
Patrick Scott5f6bd842010-06-28 16:55:16 -04002091#ifdef PNG_sRGB_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002092PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structrp png_ptr,
2093 png_const_inforp info_ptr, int *file_srgb_intent));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002094#endif
2095
Patrick Scott5f6bd842010-06-28 16:55:16 -04002096#ifdef PNG_sRGB_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002097PNG_EXPORT(156, void, png_set_sRGB, (png_const_structrp png_ptr,
2098 png_inforp info_ptr, int srgb_intent));
2099PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_const_structrp png_ptr,
2100 png_inforp info_ptr, int srgb_intent));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002101#endif
2102
Patrick Scott5f6bd842010-06-28 16:55:16 -04002103#ifdef PNG_iCCP_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002104PNG_EXPORT(158, png_uint_32, png_get_iCCP, (png_const_structrp png_ptr,
2105 png_inforp info_ptr, png_charpp name, int *compression_type,
2106 png_bytepp profile, png_uint_32 *proflen));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002107#endif
2108
Patrick Scott5f6bd842010-06-28 16:55:16 -04002109#ifdef PNG_iCCP_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002110PNG_EXPORT(159, void, png_set_iCCP, (png_const_structrp png_ptr,
2111 png_inforp info_ptr, png_const_charp name, int compression_type,
2112 png_const_bytep profile, png_uint_32 proflen));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002113#endif
2114
Patrick Scott5f6bd842010-06-28 16:55:16 -04002115#ifdef PNG_sPLT_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002116PNG_EXPORT(160, int, png_get_sPLT, (png_const_structrp png_ptr,
2117 png_inforp info_ptr, png_sPLT_tpp entries));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002118#endif
2119
Patrick Scott5f6bd842010-06-28 16:55:16 -04002120#ifdef PNG_sPLT_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002121PNG_EXPORT(161, void, png_set_sPLT, (png_const_structrp png_ptr,
2122 png_inforp info_ptr, png_const_sPLT_tp entries, int nentries));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002123#endif
2124
Patrick Scott5f6bd842010-06-28 16:55:16 -04002125#ifdef PNG_TEXT_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08002126/* png_get_text also returns the number of text chunks in *num_text */
Chris Craikb50c2172013-07-29 15:28:30 -07002127PNG_EXPORT(162, int, png_get_text, (png_const_structrp png_ptr,
2128 png_inforp info_ptr, png_textp *text_ptr, int *num_text));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002129#endif
2130
Chris Craikb50c2172013-07-29 15:28:30 -07002131/* Note while png_set_text() will accept a structure whose text,
2132 * language, and translated keywords are NULL pointers, the structure
2133 * returned by png_get_text will always contain regular
2134 * zero-terminated C strings. They might be empty strings but
2135 * they will never be NULL pointers.
The Android Open Source Project893912b2009-03-03 19:30:05 -08002136 */
2137
Patrick Scott5f6bd842010-06-28 16:55:16 -04002138#ifdef PNG_TEXT_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002139PNG_EXPORT(163, void, png_set_text, (png_const_structrp png_ptr,
2140 png_inforp info_ptr, png_const_textp text_ptr, int num_text));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002141#endif
2142
Patrick Scott5f6bd842010-06-28 16:55:16 -04002143#ifdef PNG_tIME_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002144PNG_EXPORT(164, png_uint_32, png_get_tIME, (png_const_structrp png_ptr,
2145 png_inforp info_ptr, png_timep *mod_time));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002146#endif
2147
Patrick Scott5f6bd842010-06-28 16:55:16 -04002148#ifdef PNG_tIME_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002149PNG_EXPORT(165, void, png_set_tIME, (png_const_structrp png_ptr,
2150 png_inforp info_ptr, png_const_timep mod_time));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002151#endif
2152
Patrick Scott5f6bd842010-06-28 16:55:16 -04002153#ifdef PNG_tRNS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002154PNG_EXPORT(166, png_uint_32, png_get_tRNS, (png_const_structrp png_ptr,
2155 png_inforp info_ptr, png_bytep *trans_alpha, int *num_trans,
2156 png_color_16p *trans_color));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002157#endif
2158
Patrick Scott5f6bd842010-06-28 16:55:16 -04002159#ifdef PNG_tRNS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002160PNG_EXPORT(167, void, png_set_tRNS, (png_structrp png_ptr,
2161 png_inforp info_ptr, png_const_bytep trans_alpha, int num_trans,
2162 png_const_color_16p trans_color));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002163#endif
2164
Patrick Scott5f6bd842010-06-28 16:55:16 -04002165#ifdef PNG_sCAL_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002166PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL, (png_const_structrp png_ptr,
2167 png_const_inforp info_ptr, int *unit, double *width, double *height))
2168#if defined(PNG_FLOATING_ARITHMETIC_SUPPORTED) || \
2169 defined(PNG_FLOATING_POINT_SUPPORTED)
2170/* NOTE: this API is currently implemented using floating point arithmetic,
2171 * consequently it can only be used on systems with floating point support.
2172 * In any case the range of values supported by png_fixed_point is small and it
2173 * is highly recommended that png_get_sCAL_s be used instead.
2174 */
2175PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed,
2176 (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,
2177 png_fixed_point *width, png_fixed_point *height))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002178#endif
Chris Craikb50c2172013-07-29 15:28:30 -07002179PNG_EXPORT(169, png_uint_32, png_get_sCAL_s,
2180 (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,
2181 png_charpp swidth, png_charpp sheight));
2182
2183PNG_FP_EXPORT(170, void, png_set_sCAL, (png_const_structrp png_ptr,
2184 png_inforp info_ptr, int unit, double width, double height))
2185PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_const_structrp png_ptr,
2186 png_inforp info_ptr, int unit, png_fixed_point width,
2187 png_fixed_point height))
2188PNG_EXPORT(171, void, png_set_sCAL_s, (png_const_structrp png_ptr,
2189 png_inforp info_ptr, int unit,
2190 png_const_charp swidth, png_const_charp sheight));
Matt Sarett9ea75692016-01-08 13:00:42 -05002191#endif /* sCAL */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002192
Chris Craikb50c2172013-07-29 15:28:30 -07002193#ifdef PNG_SET_UNKNOWN_CHUNKS_SUPPORTED
2194/* Provide the default handling for all unknown chunks or, optionally, for
2195 * specific unknown chunks.
2196 *
2197 * NOTE: prior to 1.6.0 the handling specified for particular chunks on read was
2198 * ignored and the default was used, the per-chunk setting only had an effect on
2199 * write. If you wish to have chunk-specific handling on read in code that must
2200 * work on earlier versions you must use a user chunk callback to specify the
2201 * desired handling (keep or discard.)
2202 *
2203 * The 'keep' parameter is a PNG_HANDLE_CHUNK_ value as listed below. The
2204 * parameter is interpreted as follows:
2205 *
2206 * READ:
2207 * PNG_HANDLE_CHUNK_AS_DEFAULT:
2208 * Known chunks: do normal libpng processing, do not keep the chunk (but
2209 * see the comments below about PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
2210 * Unknown chunks: for a specific chunk use the global default, when used
2211 * as the default discard the chunk data.
2212 * PNG_HANDLE_CHUNK_NEVER:
2213 * Discard the chunk data.
2214 * PNG_HANDLE_CHUNK_IF_SAFE:
2215 * Keep the chunk data if the chunk is not critical else raise a chunk
2216 * error.
2217 * PNG_HANDLE_CHUNK_ALWAYS:
2218 * Keep the chunk data.
2219 *
2220 * If the chunk data is saved it can be retrieved using png_get_unknown_chunks,
2221 * below. Notice that specifying "AS_DEFAULT" as a global default is equivalent
2222 * to specifying "NEVER", however when "AS_DEFAULT" is used for specific chunks
2223 * it simply resets the behavior to the libpng default.
2224 *
2225 * INTERACTION WTIH USER CHUNK CALLBACKS:
2226 * The per-chunk handling is always used when there is a png_user_chunk_ptr
2227 * callback and the callback returns 0; the chunk is then always stored *unless*
2228 * it is critical and the per-chunk setting is other than ALWAYS. Notice that
2229 * the global default is *not* used in this case. (In effect the per-chunk
2230 * value is incremented to at least IF_SAFE.)
2231 *
2232 * IMPORTANT NOTE: this behavior will change in libpng 1.7 - the global and
2233 * per-chunk defaults will be honored. If you want to preserve the current
2234 * behavior when your callback returns 0 you must set PNG_HANDLE_CHUNK_IF_SAFE
2235 * as the default - if you don't do this libpng 1.6 will issue a warning.
2236 *
2237 * If you want unhandled unknown chunks to be discarded in libpng 1.6 and
2238 * earlier simply return '1' (handled).
2239 *
2240 * PNG_HANDLE_AS_UNKNOWN_SUPPORTED:
2241 * If this is *not* set known chunks will always be handled by libpng and
2242 * will never be stored in the unknown chunk list. Known chunks listed to
2243 * png_set_keep_unknown_chunks will have no effect. If it is set then known
2244 * chunks listed with a keep other than AS_DEFAULT will *never* be processed
2245 * by libpng, in addition critical chunks must either be processed by the
2246 * callback or saved.
2247 *
2248 * The IHDR and IEND chunks must not be listed. Because this turns off the
2249 * default handling for chunks that would otherwise be recognized the
2250 * behavior of libpng transformations may well become incorrect!
2251 *
2252 * WRITE:
2253 * When writing chunks the options only apply to the chunks specified by
2254 * png_set_unknown_chunks (below), libpng will *always* write known chunks
2255 * required by png_set_ calls and will always write the core critical chunks
2256 * (as required for PLTE).
2257 *
2258 * Each chunk in the png_set_unknown_chunks list is looked up in the
2259 * png_set_keep_unknown_chunks list to find the keep setting, this is then
2260 * interpreted as follows:
2261 *
2262 * PNG_HANDLE_CHUNK_AS_DEFAULT:
2263 * Write safe-to-copy chunks and write other chunks if the global
2264 * default is set to _ALWAYS, otherwise don't write this chunk.
2265 * PNG_HANDLE_CHUNK_NEVER:
2266 * Do not write the chunk.
2267 * PNG_HANDLE_CHUNK_IF_SAFE:
2268 * Write the chunk if it is safe-to-copy, otherwise do not write it.
2269 * PNG_HANDLE_CHUNK_ALWAYS:
2270 * Write the chunk.
2271 *
2272 * Note that the default behavior is effectively the opposite of the read case -
2273 * in read unknown chunks are not stored by default, in write they are written
2274 * by default. Also the behavior of PNG_HANDLE_CHUNK_IF_SAFE is very different
2275 * - on write the safe-to-copy bit is checked, on read the critical bit is
2276 * checked and on read if the chunk is critical an error will be raised.
2277 *
2278 * num_chunks:
2279 * ===========
2280 * If num_chunks is positive, then the "keep" parameter specifies the manner
2281 * for handling only those chunks appearing in the chunk_list array,
2282 * otherwise the chunk list array is ignored.
2283 *
2284 * If num_chunks is 0 the "keep" parameter specifies the default behavior for
2285 * unknown chunks, as described above.
2286 *
2287 * If num_chunks is negative, then the "keep" parameter specifies the manner
2288 * for handling all unknown chunks plus all chunks recognized by libpng
2289 * except for the IHDR, PLTE, tRNS, IDAT, and IEND chunks (which continue to
2290 * be processed by libpng.
2291 */
2292PNG_EXPORT(172, void, png_set_keep_unknown_chunks, (png_structrp png_ptr,
2293 int keep, png_const_bytep chunk_list, int num_chunks));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002294
Chris Craikb50c2172013-07-29 15:28:30 -07002295/* The "keep" PNG_HANDLE_CHUNK_ parameter for the specified chunk is returned;
2296 * the result is therefore true (non-zero) if special handling is required,
2297 * false for the default handling.
2298 */
2299PNG_EXPORT(173, int, png_handle_as_unknown, (png_const_structrp png_ptr,
2300 png_const_bytep chunk_name));
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002301#endif
Chris Craikb50c2172013-07-29 15:28:30 -07002302
2303#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED
2304PNG_EXPORT(174, void, png_set_unknown_chunks, (png_const_structrp png_ptr,
2305 png_inforp info_ptr, png_const_unknown_chunkp unknowns,
2306 int num_unknowns));
2307 /* NOTE: prior to 1.6.0 this routine set the 'location' field of the added
2308 * unknowns to the location currently stored in the png_struct. This is
2309 * invariably the wrong value on write. To fix this call the following API
2310 * for each chunk in the list with the correct location. If you know your
2311 * code won't be compiled on earlier versions you can rely on
2312 * png_set_unknown_chunks(write-ptr, png_get_unknown_chunks(read-ptr)) doing
2313 * the correct thing.
2314 */
2315
2316PNG_EXPORT(175, void, png_set_unknown_chunk_location,
2317 (png_const_structrp png_ptr, png_inforp info_ptr, int chunk, int location));
2318
2319PNG_EXPORT(176, int, png_get_unknown_chunks, (png_const_structrp png_ptr,
2320 png_inforp info_ptr, png_unknown_chunkpp entries));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002321#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08002322
2323/* Png_free_data() will turn off the "valid" flag for anything it frees.
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002324 * If you need to turn it off for a chunk that your application has freed,
2325 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
2326 */
Chris Craikb50c2172013-07-29 15:28:30 -07002327PNG_EXPORT(177, void, png_set_invalid, (png_const_structrp png_ptr,
2328 png_inforp info_ptr, int mask));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002329
Patrick Scott5f6bd842010-06-28 16:55:16 -04002330#ifdef PNG_INFO_IMAGE_SUPPORTED
The Android Open Source Project893912b2009-03-03 19:30:05 -08002331/* The "params" pointer is currently not used and is for future expansion. */
Sireesh Tripurarib478e662014-05-09 15:15:10 +05302332#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002333PNG_EXPORT(178, void, png_read_png, (png_structrp png_ptr, png_inforp info_ptr,
2334 int transforms, png_voidp params));
Sireesh Tripurarib478e662014-05-09 15:15:10 +05302335#endif
2336#ifdef PNG_WRITE_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002337PNG_EXPORT(179, void, png_write_png, (png_structrp png_ptr, png_inforp info_ptr,
2338 int transforms, png_voidp params));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002339#endif
Sireesh Tripurarib478e662014-05-09 15:15:10 +05302340#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08002341
Chris Craikb50c2172013-07-29 15:28:30 -07002342PNG_EXPORT(180, png_const_charp, png_get_copyright,
2343 (png_const_structrp png_ptr));
2344PNG_EXPORT(181, png_const_charp, png_get_header_ver,
2345 (png_const_structrp png_ptr));
2346PNG_EXPORT(182, png_const_charp, png_get_header_version,
2347 (png_const_structrp png_ptr));
2348PNG_EXPORT(183, png_const_charp, png_get_libpng_ver,
2349 (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002350
2351#ifdef PNG_MNG_FEATURES_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002352PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structrp png_ptr,
2353 png_uint_32 mng_features_permitted));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002354#endif
2355
2356/* For use in png_set_keep_unknown, added to version 1.2.6 */
2357#define PNG_HANDLE_CHUNK_AS_DEFAULT 0
2358#define PNG_HANDLE_CHUNK_NEVER 1
2359#define PNG_HANDLE_CHUNK_IF_SAFE 2
2360#define PNG_HANDLE_CHUNK_ALWAYS 3
Chris Craikb50c2172013-07-29 15:28:30 -07002361#define PNG_HANDLE_CHUNK_LAST 4
The Android Open Source Project893912b2009-03-03 19:30:05 -08002362
2363/* Strip the prepended error numbers ("#nnn ") from error and warning
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002364 * messages before passing them to the error or warning handler.
2365 */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002366#ifdef PNG_ERROR_NUMBERS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002367PNG_EXPORT(185, void, png_set_strip_error_numbers, (png_structrp png_ptr,
2368 png_uint_32 strip_mode));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002369#endif
2370
Chris Craikb50c2172013-07-29 15:28:30 -07002371/* Added in libpng-1.2.6 */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002372#ifdef PNG_SET_USER_LIMITS_SUPPORTED
Chris Craikb50c2172013-07-29 15:28:30 -07002373PNG_EXPORT(186, void, png_set_user_limits, (png_structrp png_ptr,
2374 png_uint_32 user_width_max, png_uint_32 user_height_max));
2375PNG_EXPORT(187, png_uint_32, png_get_user_width_max,
2376 (png_const_structrp png_ptr));
2377PNG_EXPORT(188, png_uint_32, png_get_user_height_max,
2378 (png_const_structrp png_ptr));
2379/* Added in libpng-1.4.0 */
2380PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structrp png_ptr,
2381 png_uint_32 user_chunk_cache_max));
2382PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max,
2383 (png_const_structrp png_ptr));
2384/* Added in libpng-1.4.1 */
2385PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structrp png_ptr,
2386 png_alloc_size_t user_chunk_cache_max));
2387PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max,
2388 (png_const_structrp png_ptr));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002389#endif
Chris Craikb50c2172013-07-29 15:28:30 -07002390
2391#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
2392PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch,
2393 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2394
2395PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch,
2396 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2397
2398PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch,
2399 (png_const_structrp png_ptr, png_const_inforp info_ptr));
2400
2401PNG_FP_EXPORT(196, float, png_get_x_offset_inches,
2402 (png_const_structrp png_ptr, png_const_inforp info_ptr))
2403#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2404PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed,
2405 (png_const_structrp png_ptr, png_const_inforp info_ptr))
2406#endif
2407
2408PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_const_structrp png_ptr,
2409 png_const_inforp info_ptr))
2410#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2411PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed,
2412 (png_const_structrp png_ptr, png_const_inforp info_ptr))
2413#endif
2414
2415# ifdef PNG_pHYs_SUPPORTED
2416PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structrp png_ptr,
2417 png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
2418 int *unit_type));
Matt Sarett9ea75692016-01-08 13:00:42 -05002419# endif /* pHYs */
2420#endif /* INCH_CONVERSIONS */
Chris Craikb50c2172013-07-29 15:28:30 -07002421
2422/* Added in libpng-1.4.0 */
2423#ifdef PNG_IO_STATE_SUPPORTED
2424PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_const_structrp png_ptr));
2425
2426/* Removed from libpng 1.6; use png_get_io_chunk_type. */
2427PNG_REMOVED(200, png_const_bytep, png_get_io_chunk_name, (png_structrp png_ptr),
2428 PNG_DEPRECATED)
2429
2430PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type,
2431 (png_const_structrp png_ptr));
2432
2433/* The flags returned by png_get_io_state() are the following: */
2434# define PNG_IO_NONE 0x0000 /* no I/O at this moment */
2435# define PNG_IO_READING 0x0001 /* currently reading */
2436# define PNG_IO_WRITING 0x0002 /* currently writing */
2437# define PNG_IO_SIGNATURE 0x0010 /* currently at the file signature */
2438# define PNG_IO_CHUNK_HDR 0x0020 /* currently at the chunk header */
2439# define PNG_IO_CHUNK_DATA 0x0040 /* currently at the chunk data */
2440# define PNG_IO_CHUNK_CRC 0x0080 /* currently at the chunk crc */
2441# define PNG_IO_MASK_OP 0x000f /* current operation: reading/writing */
2442# define PNG_IO_MASK_LOC 0x00f0 /* current location: sig/hdr/data/crc */
Matt Sarett9ea75692016-01-08 13:00:42 -05002443#endif /* IO_STATE */
Chris Craikb50c2172013-07-29 15:28:30 -07002444
2445/* Interlace support. The following macros are always defined so that if
2446 * libpng interlace handling is turned off the macros may be used to handle
2447 * interlaced images within the application.
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002448 */
Chris Craikb50c2172013-07-29 15:28:30 -07002449#define PNG_INTERLACE_ADAM7_PASSES 7
2450
2451/* Two macros to return the first row and first column of the original,
2452 * full, image which appears in a given pass. 'pass' is in the range 0
2453 * to 6 and the result is in the range 0 to 7.
2454 */
2455#define PNG_PASS_START_ROW(pass) (((1&~(pass))<<(3-((pass)>>1)))&7)
2456#define PNG_PASS_START_COL(pass) (((1& (pass))<<(3-(((pass)+1)>>1)))&7)
2457
2458/* A macro to return the offset between pixels in the output row for a pair of
2459 * pixels in the input - effectively the inverse of the 'COL_SHIFT' macro that
2460 * follows. Note that ROW_OFFSET is the offset from one row to the next whereas
2461 * COL_OFFSET is from one column to the next, within a row.
2462 */
2463#define PNG_PASS_ROW_OFFSET(pass) ((pass)>2?(8>>(((pass)-1)>>1)):8)
2464#define PNG_PASS_COL_OFFSET(pass) (1<<((7-(pass))>>1))
2465
2466/* Two macros to help evaluate the number of rows or columns in each
2467 * pass. This is expressed as a shift - effectively log2 of the number or
2468 * rows or columns in each 8x8 tile of the original image.
2469 */
2470#define PNG_PASS_ROW_SHIFT(pass) ((pass)>2?(8-(pass))>>1:3)
2471#define PNG_PASS_COL_SHIFT(pass) ((pass)>1?(7-(pass))>>1:3)
2472
2473/* Hence two macros to determine the number of rows or columns in a given
2474 * pass of an image given its height or width. In fact these macros may
2475 * return non-zero even though the sub-image is empty, because the other
2476 * dimension may be empty for a small image.
2477 */
2478#define PNG_PASS_ROWS(height, pass) (((height)+(((1<<PNG_PASS_ROW_SHIFT(pass))\
2479 -1)-PNG_PASS_START_ROW(pass)))>>PNG_PASS_ROW_SHIFT(pass))
2480#define PNG_PASS_COLS(width, pass) (((width)+(((1<<PNG_PASS_COL_SHIFT(pass))\
2481 -1)-PNG_PASS_START_COL(pass)))>>PNG_PASS_COL_SHIFT(pass))
2482
2483/* For the reader row callbacks (both progressive and sequential) it is
2484 * necessary to find the row in the output image given a row in an interlaced
2485 * image, so two more macros:
2486 */
2487#define PNG_ROW_FROM_PASS_ROW(y_in, pass) \
2488 (((y_in)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass))
2489#define PNG_COL_FROM_PASS_COL(x_in, pass) \
2490 (((x_in)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass))
2491
2492/* Two macros which return a boolean (0 or 1) saying whether the given row
2493 * or column is in a particular pass. These use a common utility macro that
2494 * returns a mask for a given pass - the offset 'off' selects the row or
2495 * column version. The mask has the appropriate bit set for each column in
2496 * the tile.
2497 */
2498#define PNG_PASS_MASK(pass,off) ( \
2499 ((0x110145AF>>(((7-(off))-(pass))<<2)) & 0xF) | \
2500 ((0x01145AF0>>(((7-(off))-(pass))<<2)) & 0xF0))
2501
2502#define PNG_ROW_IN_INTERLACE_PASS(y, pass) \
2503 ((PNG_PASS_MASK(pass,0) >> ((y)&7)) & 1)
2504#define PNG_COL_IN_INTERLACE_PASS(x, pass) \
2505 ((PNG_PASS_MASK(pass,1) >> ((x)&7)) & 1)
The Android Open Source Project893912b2009-03-03 19:30:05 -08002506
2507#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
2508/* With these routines we avoid an integer divide, which will be slower on
2509 * most machines. However, it does take more operations than the corresponding
2510 * divide method, so it may be slower on a few RISC systems. There are two
2511 * shifts (by 8 or 16 bits) and an addition, versus a single integer divide.
2512 *
2513 * Note that the rounding factors are NOT supposed to be the same! 128 and
2514 * 32768 are correct for the NODIV code; 127 and 32767 are correct for the
2515 * standard method.
2516 *
2517 * [Optimized code by Greg Roelofs and Mark Adler...blame us for bugs. :-) ]
2518 */
2519
Chris Craikb50c2172013-07-29 15:28:30 -07002520 /* fg and bg should be in `gamma 1.0' space; alpha is the opacity */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002521
Chris Craikb50c2172013-07-29 15:28:30 -07002522# define png_composite(composite, fg, alpha, bg) \
2523 { png_uint_16 temp = (png_uint_16)((png_uint_16)(fg) \
2524 * (png_uint_16)(alpha) \
2525 + (png_uint_16)(bg)*(png_uint_16)(255 \
2526 - (png_uint_16)(alpha)) + 128); \
Matt Sarett9ea75692016-01-08 13:00:42 -05002527 (composite) = (png_byte)(((temp + (temp >> 8)) >> 8) & 0xff); }
The Android Open Source Project893912b2009-03-03 19:30:05 -08002528
Chris Craikb50c2172013-07-29 15:28:30 -07002529# define png_composite_16(composite, fg, alpha, bg) \
2530 { png_uint_32 temp = (png_uint_32)((png_uint_32)(fg) \
2531 * (png_uint_32)(alpha) \
2532 + (png_uint_32)(bg)*(65535 \
2533 - (png_uint_32)(alpha)) + 32768); \
Matt Sarett9ea75692016-01-08 13:00:42 -05002534 (composite) = (png_uint_16)(0xffff & ((temp + (temp >> 16)) >> 16)); }
The Android Open Source Project893912b2009-03-03 19:30:05 -08002535
Patrick Scotta0bb96c2009-07-22 11:50:02 -04002536#else /* Standard method using integer division */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002537
Matt Sarett9ea75692016-01-08 13:00:42 -05002538# define png_composite(composite, fg, alpha, bg) \
2539 (composite) = \
2540 (png_byte)(0xff & (((png_uint_16)(fg) * (png_uint_16)(alpha) + \
2541 (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \
2542 127) / 255))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002543
2544# define png_composite_16(composite, fg, alpha, bg) \
Matt Sarett9ea75692016-01-08 13:00:42 -05002545 (composite) = \
2546 (png_uint_16)(0xffff & (((png_uint_32)(fg) * (png_uint_32)(alpha) + \
2547 (png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) + \
2548 32767) / 65535))
2549#endif /* READ_COMPOSITE_NODIV */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002550
Chris Craikb50c2172013-07-29 15:28:30 -07002551#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
2552PNG_EXPORT(201, png_uint_32, png_get_uint_32, (png_const_bytep buf));
2553PNG_EXPORT(202, png_uint_16, png_get_uint_16, (png_const_bytep buf));
2554PNG_EXPORT(203, png_int_32, png_get_int_32, (png_const_bytep buf));
2555#endif
2556
2557PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_const_structrp png_ptr,
2558 png_const_bytep buf));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002559/* No png_get_int_16 -- may be added if there's a real need for it. */
2560
Chris Craikb50c2172013-07-29 15:28:30 -07002561/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
2562#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2563PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i));
2564#endif
2565#ifdef PNG_SAVE_INT_32_SUPPORTED
2566PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i));
2567#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08002568
2569/* Place a 16-bit number into a buffer in PNG byte order.
2570 * The parameter is declared unsigned int, not png_uint_16,
2571 * just to avoid potential problems on pre-ANSI C compilers.
2572 */
Chris Craikb50c2172013-07-29 15:28:30 -07002573#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2574PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i));
The Android Open Source Project893912b2009-03-03 19:30:05 -08002575/* No png_save_int_16 -- may be added if there's a real need for it. */
Chris Craikb50c2172013-07-29 15:28:30 -07002576#endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08002577
Chris Craikb50c2172013-07-29 15:28:30 -07002578#ifdef PNG_USE_READ_MACROS
2579/* Inline macros to do direct reads of bytes from the input buffer.
2580 * The png_get_int_32() routine assumes we are using two's complement
2581 * format for negative values, which is almost certainly true.
The Android Open Source Project893912b2009-03-03 19:30:05 -08002582 */
Chris Craikb50c2172013-07-29 15:28:30 -07002583# define PNG_get_uint_32(buf) \
2584 (((png_uint_32)(*(buf)) << 24) + \
2585 ((png_uint_32)(*((buf) + 1)) << 16) + \
2586 ((png_uint_32)(*((buf) + 2)) << 8) + \
2587 ((png_uint_32)(*((buf) + 3))))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002588
Chris Craikb50c2172013-07-29 15:28:30 -07002589 /* From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
2590 * function) incorrectly returned a value of type png_uint_32.
2591 */
2592# define PNG_get_uint_16(buf) \
2593 ((png_uint_16) \
2594 (((unsigned int)(*(buf)) << 8) + \
2595 ((unsigned int)(*((buf) + 1)))))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002596
Chris Craikb50c2172013-07-29 15:28:30 -07002597# define PNG_get_int_32(buf) \
2598 ((png_int_32)((*(buf) & 0x80) \
Matt Sarett9ea75692016-01-08 13:00:42 -05002599 ? -((png_int_32)(((png_get_uint_32(buf)^0xffffffffU)+1U)&0x7fffffffU)) \
Chris Craikb50c2172013-07-29 15:28:30 -07002600 : (png_int_32)png_get_uint_32(buf)))
The Android Open Source Project893912b2009-03-03 19:30:05 -08002601
Chris Craikb50c2172013-07-29 15:28:30 -07002602 /* If PNG_PREFIX is defined the same thing as below happens in pnglibconf.h,
2603 * but defining a macro name prefixed with PNG_PREFIX.
2604 */
2605# ifndef PNG_PREFIX
2606# define png_get_uint_32(buf) PNG_get_uint_32(buf)
2607# define png_get_uint_16(buf) PNG_get_uint_16(buf)
2608# define png_get_int_32(buf) PNG_get_int_32(buf)
2609# endif
The Android Open Source Project893912b2009-03-03 19:30:05 -08002610#else
Chris Craikb50c2172013-07-29 15:28:30 -07002611# ifdef PNG_PREFIX
2612 /* No macros; revert to the (redefined) function */
2613# define PNG_get_uint_32 (png_get_uint_32)
2614# define PNG_get_uint_16 (png_get_uint_16)
2615# define PNG_get_int_32 (png_get_int_32)
The Android Open Source Project893912b2009-03-03 19:30:05 -08002616# endif
2617#endif
2618
Matt Sarett9ea75692016-01-08 13:00:42 -05002619#ifdef PNG_CHECK_FOR_INVALID_INDEX_SUPPORTED
2620PNG_EXPORT(242, void, png_set_check_for_invalid_index,
2621 (png_structrp png_ptr, int allowed));
2622# ifdef PNG_GET_PALETTE_MAX_SUPPORTED
2623PNG_EXPORT(243, int, png_get_palette_max, (png_const_structp png_ptr,
2624 png_const_infop info_ptr));
2625# endif
2626#endif /* CHECK_FOR_INVALID_INDEX */
2627
Chris Craikb50c2172013-07-29 15:28:30 -07002628/*******************************************************************************
Matt Sarett9ea75692016-01-08 13:00:42 -05002629 * Section 5: SIMPLIFIED API
Chris Craikb50c2172013-07-29 15:28:30 -07002630 *******************************************************************************
2631 *
2632 * Please read the documentation in libpng-manual.txt (TODO: write said
2633 * documentation) if you don't understand what follows.
2634 *
2635 * The simplified API hides the details of both libpng and the PNG file format
2636 * itself. It allows PNG files to be read into a very limited number of
2637 * in-memory bitmap formats or to be written from the same formats. If these
2638 * formats do not accomodate your needs then you can, and should, use the more
2639 * sophisticated APIs above - these support a wide variety of in-memory formats
2640 * and a wide variety of sophisticated transformations to those formats as well
2641 * as a wide variety of APIs to manipulate ancillary information.
2642 *
2643 * To read a PNG file using the simplified API:
2644 *
Matt Sarett9ea75692016-01-08 13:00:42 -05002645 * 1) Declare a 'png_image' structure (see below) on the stack, set the
2646 * version field to PNG_IMAGE_VERSION and the 'opaque' pointer to NULL
2647 * (this is REQUIRED, your program may crash if you don't do it.)
Chris Craikb50c2172013-07-29 15:28:30 -07002648 * 2) Call the appropriate png_image_begin_read... function.
2649 * 3) Set the png_image 'format' member to the required sample format.
2650 * 4) Allocate a buffer for the image and, if required, the color-map.
2651 * 5) Call png_image_finish_read to read the image and, if required, the
2652 * color-map into your buffers.
2653 *
2654 * There are no restrictions on the format of the PNG input itself; all valid
2655 * color types, bit depths, and interlace methods are acceptable, and the
2656 * input image is transformed as necessary to the requested in-memory format
2657 * during the png_image_finish_read() step. The only caveat is that if you
2658 * request a color-mapped image from a PNG that is full-color or makes
2659 * complex use of an alpha channel the transformation is extremely lossy and the
2660 * result may look terrible.
2661 *
2662 * To write a PNG file using the simplified API:
2663 *
2664 * 1) Declare a 'png_image' structure on the stack and memset() it to all zero.
2665 * 2) Initialize the members of the structure that describe the image, setting
2666 * the 'format' member to the format of the image samples.
2667 * 3) Call the appropriate png_image_write... function with a pointer to the
2668 * image and, if necessary, the color-map to write the PNG data.
2669 *
2670 * png_image is a structure that describes the in-memory format of an image
2671 * when it is being read or defines the in-memory format of an image that you
2672 * need to write:
2673 */
Matt Sarett9ea75692016-01-08 13:00:42 -05002674#if defined(PNG_SIMPLIFIED_READ_SUPPORTED) || \
2675 defined(PNG_SIMPLIFIED_WRITE_SUPPORTED)
2676
Chris Craikb50c2172013-07-29 15:28:30 -07002677#define PNG_IMAGE_VERSION 1
The Android Open Source Project893912b2009-03-03 19:30:05 -08002678
Chris Craikb50c2172013-07-29 15:28:30 -07002679typedef struct png_control *png_controlp;
2680typedef struct
2681{
2682 png_controlp opaque; /* Initialize to NULL, free with png_image_free */
2683 png_uint_32 version; /* Set to PNG_IMAGE_VERSION */
2684 png_uint_32 width; /* Image width in pixels (columns) */
2685 png_uint_32 height; /* Image height in pixels (rows) */
2686 png_uint_32 format; /* Image format as defined below */
2687 png_uint_32 flags; /* A bit mask containing informational flags */
2688 png_uint_32 colormap_entries;
2689 /* Number of entries in the color-map */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002690
Chris Craikb50c2172013-07-29 15:28:30 -07002691 /* In the event of an error or warning the following field will be set to a
2692 * non-zero value and the 'message' field will contain a '\0' terminated
2693 * string with the libpng error or warning message. If both warnings and
2694 * an error were encountered, only the error is recorded. If there
2695 * are multiple warnings, only the first one is recorded.
2696 *
2697 * The upper 30 bits of this value are reserved, the low two bits contain
2698 * a value as follows:
2699 */
2700# define PNG_IMAGE_WARNING 1
2701# define PNG_IMAGE_ERROR 2
2702 /*
Matt Sarett9ea75692016-01-08 13:00:42 -05002703 * The result is a two-bit code such that a value more than 1 indicates
Chris Craikb50c2172013-07-29 15:28:30 -07002704 * a failure in the API just called:
2705 *
2706 * 0 - no warning or error
2707 * 1 - warning
2708 * 2 - error
2709 * 3 - error preceded by warning
2710 */
2711# define PNG_IMAGE_FAILED(png_cntrl) ((((png_cntrl).warning_or_error)&0x03)>1)
The Android Open Source Project893912b2009-03-03 19:30:05 -08002712
Chris Craikb50c2172013-07-29 15:28:30 -07002713 png_uint_32 warning_or_error;
The Android Open Source Project893912b2009-03-03 19:30:05 -08002714
Chris Craikb50c2172013-07-29 15:28:30 -07002715 char message[64];
2716} png_image, *png_imagep;
The Android Open Source Project893912b2009-03-03 19:30:05 -08002717
Chris Craikb50c2172013-07-29 15:28:30 -07002718/* The samples of the image have one to four channels whose components have
2719 * original values in the range 0 to 1.0:
2720 *
2721 * 1: A single gray or luminance channel (G).
2722 * 2: A gray/luminance channel and an alpha channel (GA).
2723 * 3: Three red, green, blue color channels (RGB).
2724 * 4: Three color channels and an alpha channel (RGBA).
2725 *
2726 * The components are encoded in one of two ways:
2727 *
2728 * a) As a small integer, value 0..255, contained in a single byte. For the
2729 * alpha channel the original value is simply value/255. For the color or
2730 * luminance channels the value is encoded according to the sRGB specification
2731 * and matches the 8-bit format expected by typical display devices.
2732 *
2733 * The color/gray channels are not scaled (pre-multiplied) by the alpha
2734 * channel and are suitable for passing to color management software.
2735 *
2736 * b) As a value in the range 0..65535, contained in a 2-byte integer. All
2737 * channels can be converted to the original value by dividing by 65535; all
2738 * channels are linear. Color channels use the RGB encoding (RGB end-points) of
2739 * the sRGB specification. This encoding is identified by the
2740 * PNG_FORMAT_FLAG_LINEAR flag below.
2741 *
2742 * When the simplified API needs to convert between sRGB and linear colorspaces,
2743 * the actual sRGB transfer curve defined in the sRGB specification (see the
2744 * article at http://en.wikipedia.org/wiki/SRGB) is used, not the gamma=1/2.2
2745 * approximation used elsewhere in libpng.
2746 *
2747 * When an alpha channel is present it is expected to denote pixel coverage
2748 * of the color or luminance channels and is returned as an associated alpha
2749 * channel: the color/gray channels are scaled (pre-multiplied) by the alpha
2750 * value.
2751 *
2752 * The samples are either contained directly in the image data, between 1 and 8
2753 * bytes per pixel according to the encoding, or are held in a color-map indexed
2754 * by bytes in the image data. In the case of a color-map the color-map entries
2755 * are individual samples, encoded as above, and the image data has one byte per
2756 * pixel to select the relevant sample from the color-map.
The Android Open Source Project893912b2009-03-03 19:30:05 -08002757 */
2758
Chris Craikb50c2172013-07-29 15:28:30 -07002759/* PNG_FORMAT_*
2760 *
2761 * #defines to be used in png_image::format. Each #define identifies a
2762 * particular layout of sample data and, if present, alpha values. There are
2763 * separate defines for each of the two component encodings.
2764 *
2765 * A format is built up using single bit flag values. All combinations are
2766 * valid. Formats can be built up from the flag values or you can use one of
2767 * the predefined values below. When testing formats always use the FORMAT_FLAG
2768 * macros to test for individual features - future versions of the library may
2769 * add new flags.
2770 *
2771 * When reading or writing color-mapped images the format should be set to the
2772 * format of the entries in the color-map then png_image_{read,write}_colormap
2773 * called to read or write the color-map and set the format correctly for the
2774 * image data. Do not set the PNG_FORMAT_FLAG_COLORMAP bit directly!
2775 *
Matt Sarett9ea75692016-01-08 13:00:42 -05002776 * NOTE: libpng can be built with particular features disabled. If you see
Chris Craikb50c2172013-07-29 15:28:30 -07002777 * compiler errors because the definition of one of the following flags has been
2778 * compiled out it is because libpng does not have the required support. It is
2779 * possible, however, for the libpng configuration to enable the format on just
2780 * read or just write; in that case you may see an error at run time. You can
2781 * guard against this by checking for the definition of the appropriate
2782 * "_SUPPORTED" macro, one of:
2783 *
2784 * PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED
2785 */
2786#define PNG_FORMAT_FLAG_ALPHA 0x01U /* format with an alpha channel */
2787#define PNG_FORMAT_FLAG_COLOR 0x02U /* color format: otherwise grayscale */
Matt Sarett9ea75692016-01-08 13:00:42 -05002788#define PNG_FORMAT_FLAG_LINEAR 0x04U /* 2-byte channels else 1-byte */
Chris Craikb50c2172013-07-29 15:28:30 -07002789#define PNG_FORMAT_FLAG_COLORMAP 0x08U /* image data is color-mapped */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002790
Chris Craikb50c2172013-07-29 15:28:30 -07002791#ifdef PNG_FORMAT_BGR_SUPPORTED
2792# define PNG_FORMAT_FLAG_BGR 0x10U /* BGR colors, else order is RGB */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002793#endif
2794
Chris Craikb50c2172013-07-29 15:28:30 -07002795#ifdef PNG_FORMAT_AFIRST_SUPPORTED
2796# define PNG_FORMAT_FLAG_AFIRST 0x20U /* alpha channel comes first */
The Android Open Source Project893912b2009-03-03 19:30:05 -08002797#endif
2798
Chris Craikb50c2172013-07-29 15:28:30 -07002799/* Commonly used formats have predefined macros.
2800 *
2801 * First the single byte (sRGB) formats:
2802 */
2803#define PNG_FORMAT_GRAY 0
2804#define PNG_FORMAT_GA PNG_FORMAT_FLAG_ALPHA
2805#define PNG_FORMAT_AG (PNG_FORMAT_GA|PNG_FORMAT_FLAG_AFIRST)
2806#define PNG_FORMAT_RGB PNG_FORMAT_FLAG_COLOR
2807#define PNG_FORMAT_BGR (PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_BGR)
2808#define PNG_FORMAT_RGBA (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_ALPHA)
2809#define PNG_FORMAT_ARGB (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_AFIRST)
2810#define PNG_FORMAT_BGRA (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_ALPHA)
2811#define PNG_FORMAT_ABGR (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_AFIRST)
2812
2813/* Then the linear 2-byte formats. When naming these "Y" is used to
2814 * indicate a luminance (gray) channel.
2815 */
2816#define PNG_FORMAT_LINEAR_Y PNG_FORMAT_FLAG_LINEAR
2817#define PNG_FORMAT_LINEAR_Y_ALPHA (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_ALPHA)
2818#define PNG_FORMAT_LINEAR_RGB (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR)
2819#define PNG_FORMAT_LINEAR_RGB_ALPHA \
2820 (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA)
2821
2822/* With color-mapped formats the image data is one byte for each pixel, the byte
2823 * is an index into the color-map which is formatted as above. To obtain a
2824 * color-mapped format it is sufficient just to add the PNG_FOMAT_FLAG_COLORMAP
2825 * to one of the above definitions, or you can use one of the definitions below.
2826 */
2827#define PNG_FORMAT_RGB_COLORMAP (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_COLORMAP)
2828#define PNG_FORMAT_BGR_COLORMAP (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_COLORMAP)
2829#define PNG_FORMAT_RGBA_COLORMAP (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_COLORMAP)
2830#define PNG_FORMAT_ARGB_COLORMAP (PNG_FORMAT_ARGB|PNG_FORMAT_FLAG_COLORMAP)
2831#define PNG_FORMAT_BGRA_COLORMAP (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_COLORMAP)
2832#define PNG_FORMAT_ABGR_COLORMAP (PNG_FORMAT_ABGR|PNG_FORMAT_FLAG_COLORMAP)
2833
2834/* PNG_IMAGE macros
2835 *
2836 * These are convenience macros to derive information from a png_image
2837 * structure. The PNG_IMAGE_SAMPLE_ macros return values appropriate to the
2838 * actual image sample values - either the entries in the color-map or the
2839 * pixels in the image. The PNG_IMAGE_PIXEL_ macros return corresponding values
2840 * for the pixels and will always return 1 for color-mapped formats. The
2841 * remaining macros return information about the rows in the image and the
2842 * complete image.
2843 *
2844 * NOTE: All the macros that take a png_image::format parameter are compile time
2845 * constants if the format parameter is, itself, a constant. Therefore these
2846 * macros can be used in array declarations and case labels where required.
2847 * Similarly the macros are also pre-processor constants (sizeof is not used) so
2848 * they can be used in #if tests.
2849 *
2850 * First the information about the samples.
2851 */
2852#define PNG_IMAGE_SAMPLE_CHANNELS(fmt)\
2853 (((fmt)&(PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA))+1)
2854 /* Return the total number of channels in a given format: 1..4 */
2855
2856#define PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt)\
2857 ((((fmt) & PNG_FORMAT_FLAG_LINEAR) >> 2)+1)
2858 /* Return the size in bytes of a single component of a pixel or color-map
2859 * entry (as appropriate) in the image: 1 or 2.
2860 */
2861
2862#define PNG_IMAGE_SAMPLE_SIZE(fmt)\
2863 (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt))
2864 /* This is the size of the sample data for one sample. If the image is
2865 * color-mapped it is the size of one color-map entry (and image pixels are
2866 * one byte in size), otherwise it is the size of one image pixel.
2867 */
2868
2869#define PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)\
2870 (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * 256)
2871 /* The maximum size of the color-map required by the format expressed in a
2872 * count of components. This can be used to compile-time allocate a
2873 * color-map:
2874 *
2875 * png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)];
2876 *
2877 * png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)];
2878 *
2879 * Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the
2880 * information from one of the png_image_begin_read_ APIs and dynamically
2881 * allocate the required memory.
2882 */
2883
2884/* Corresponding information about the pixels */
2885#define PNG_IMAGE_PIXEL_(test,fmt)\
2886 (((fmt)&PNG_FORMAT_FLAG_COLORMAP)?1:test(fmt))
2887
2888#define PNG_IMAGE_PIXEL_CHANNELS(fmt)\
2889 PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_CHANNELS,fmt)
2890 /* The number of separate channels (components) in a pixel; 1 for a
2891 * color-mapped image.
2892 */
2893
2894#define PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)\
2895 PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_COMPONENT_SIZE,fmt)
2896 /* The size, in bytes, of each component in a pixel; 1 for a color-mapped
2897 * image.
2898 */
2899
2900#define PNG_IMAGE_PIXEL_SIZE(fmt) PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_SIZE,fmt)
2901 /* The size, in bytes, of a complete pixel; 1 for a color-mapped image. */
2902
2903/* Information about the whole row, or whole image */
2904#define PNG_IMAGE_ROW_STRIDE(image)\
2905 (PNG_IMAGE_PIXEL_CHANNELS((image).format) * (image).width)
2906 /* Return the total number of components in a single row of the image; this
2907 * is the minimum 'row stride', the minimum count of components between each
2908 * row. For a color-mapped image this is the minimum number of bytes in a
2909 * row.
2910 */
2911
2912#define PNG_IMAGE_BUFFER_SIZE(image, row_stride)\
2913 (PNG_IMAGE_PIXEL_COMPONENT_SIZE((image).format)*(image).height*(row_stride))
2914 /* Return the size, in bytes, of an image buffer given a png_image and a row
2915 * stride - the number of components to leave space for in each row.
2916 */
2917
2918#define PNG_IMAGE_SIZE(image)\
2919 PNG_IMAGE_BUFFER_SIZE(image, PNG_IMAGE_ROW_STRIDE(image))
2920 /* Return the size, in bytes, of the image in memory given just a png_image;
2921 * the row stride is the minimum stride required for the image.
2922 */
2923
2924#define PNG_IMAGE_COLORMAP_SIZE(image)\
2925 (PNG_IMAGE_SAMPLE_SIZE((image).format) * (image).colormap_entries)
2926 /* Return the size, in bytes, of the color-map of this image. If the image
2927 * format is not a color-map format this will return a size sufficient for
2928 * 256 entries in the given format; check PNG_FORMAT_FLAG_COLORMAP if
2929 * you don't want to allocate a color-map in this case.
2930 */
2931
2932/* PNG_IMAGE_FLAG_*
2933 *
2934 * Flags containing additional information about the image are held in the
2935 * 'flags' field of png_image.
2936 */
2937#define PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB 0x01
2938 /* This indicates the the RGB values of the in-memory bitmap do not
2939 * correspond to the red, green and blue end-points defined by sRGB.
2940 */
2941
2942#define PNG_IMAGE_FLAG_FAST 0x02
2943 /* On write emphasise speed over compression; the resultant PNG file will be
2944 * larger but will be produced significantly faster, particular for large
2945 * images. Do not use this option for images which will be distributed, only
2946 * used it when producing intermediate files that will be read back in
2947 * repeatedly. For a typical 24-bit image the option will double the read
2948 * speed at the cost of increasing the image size by 25%, however for many
2949 * more compressible images the PNG file can be 10 times larger with only a
2950 * slight speed gain.
2951 */
2952
2953#define PNG_IMAGE_FLAG_16BIT_sRGB 0x04
2954 /* On read if the image is a 16-bit per component image and there is no gAMA
2955 * or sRGB chunk assume that the components are sRGB encoded. Notice that
2956 * images output by the simplified API always have gamma information; setting
2957 * this flag only affects the interpretation of 16-bit images from an
2958 * external source. It is recommended that the application expose this flag
2959 * to the user; the user can normally easily recognize the difference between
2960 * linear and sRGB encoding. This flag has no effect on write - the data
2961 * passed to the write APIs must have the correct encoding (as defined
2962 * above.)
2963 *
2964 * If the flag is not set (the default) input 16-bit per component data is
2965 * assumed to be linear.
2966 *
2967 * NOTE: the flag can only be set after the png_image_begin_read_ call,
2968 * because that call initializes the 'flags' field.
2969 */
2970
2971#ifdef PNG_SIMPLIFIED_READ_SUPPORTED
2972/* READ APIs
2973 * ---------
2974 *
2975 * The png_image passed to the read APIs must have been initialized by setting
2976 * the png_controlp field 'opaque' to NULL (or, safer, memset the whole thing.)
2977 */
2978#ifdef PNG_STDIO_SUPPORTED
2979PNG_EXPORT(234, int, png_image_begin_read_from_file, (png_imagep image,
2980 const char *file_name));
2981 /* The named file is opened for read and the image header is filled in
2982 * from the PNG header in the file.
2983 */
2984
2985PNG_EXPORT(235, int, png_image_begin_read_from_stdio, (png_imagep image,
2986 FILE* file));
2987 /* The PNG header is read from the stdio FILE object. */
Matt Sarett9ea75692016-01-08 13:00:42 -05002988#endif /* STDIO */
Chris Craikb50c2172013-07-29 15:28:30 -07002989
2990PNG_EXPORT(236, int, png_image_begin_read_from_memory, (png_imagep image,
2991 png_const_voidp memory, png_size_t size));
2992 /* The PNG header is read from the given memory buffer. */
2993
2994PNG_EXPORT(237, int, png_image_finish_read, (png_imagep image,
2995 png_const_colorp background, void *buffer, png_int_32 row_stride,
2996 void *colormap));
2997 /* Finish reading the image into the supplied buffer and clean up the
2998 * png_image structure.
2999 *
3000 * row_stride is the step, in byte or 2-byte units as appropriate,
3001 * between adjacent rows. A positive stride indicates that the top-most row
3002 * is first in the buffer - the normal top-down arrangement. A negative
3003 * stride indicates that the bottom-most row is first in the buffer.
3004 *
3005 * background need only be supplied if an alpha channel must be removed from
3006 * a png_byte format and the removal is to be done by compositing on a solid
3007 * color; otherwise it may be NULL and any composition will be done directly
3008 * onto the buffer. The value is an sRGB color to use for the background,
3009 * for grayscale output the green channel is used.
3010 *
3011 * background must be supplied when an alpha channel must be removed from a
3012 * single byte color-mapped output format, in other words if:
3013 *
3014 * 1) The original format from png_image_begin_read_from_* had
3015 * PNG_FORMAT_FLAG_ALPHA set.
3016 * 2) The format set by the application does not.
3017 * 3) The format set by the application has PNG_FORMAT_FLAG_COLORMAP set and
3018 * PNG_FORMAT_FLAG_LINEAR *not* set.
3019 *
3020 * For linear output removing the alpha channel is always done by compositing
3021 * on black and background is ignored.
3022 *
3023 * colormap must be supplied when PNG_FORMAT_FLAG_COLORMAP is set. It must
3024 * be at least the size (in bytes) returned by PNG_IMAGE_COLORMAP_SIZE.
3025 * image->colormap_entries will be updated to the actual number of entries
3026 * written to the colormap; this may be less than the original value.
3027 */
3028
3029PNG_EXPORT(238, void, png_image_free, (png_imagep image));
3030 /* Free any data allocated by libpng in image->opaque, setting the pointer to
3031 * NULL. May be called at any time after the structure is initialized.
3032 */
Matt Sarett9ea75692016-01-08 13:00:42 -05003033#endif /* SIMPLIFIED_READ */
Chris Craikb50c2172013-07-29 15:28:30 -07003034
3035#ifdef PNG_SIMPLIFIED_WRITE_SUPPORTED
3036#ifdef PNG_STDIO_SUPPORTED
3037/* WRITE APIS
3038 * ----------
3039 * For write you must initialize a png_image structure to describe the image to
3040 * be written. To do this use memset to set the whole structure to 0 then
3041 * initialize fields describing your image.
3042 *
3043 * version: must be set to PNG_IMAGE_VERSION
3044 * opaque: must be initialized to NULL
3045 * width: image width in pixels
3046 * height: image height in rows
3047 * format: the format of the data (image and color-map) you wish to write
3048 * flags: set to 0 unless one of the defined flags applies; set
3049 * PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images where the RGB
3050 * values do not correspond to the colors in sRGB.
3051 * colormap_entries: set to the number of entries in the color-map (0 to 256)
3052 */
3053PNG_EXPORT(239, int, png_image_write_to_file, (png_imagep image,
3054 const char *file, int convert_to_8bit, const void *buffer,
3055 png_int_32 row_stride, const void *colormap));
3056 /* Write the image to the named file. */
3057
3058PNG_EXPORT(240, int, png_image_write_to_stdio, (png_imagep image, FILE *file,
3059 int convert_to_8_bit, const void *buffer, png_int_32 row_stride,
3060 const void *colormap));
3061 /* Write the image to the given (FILE*). */
3062
3063/* With both write APIs if image is in one of the linear formats with 16-bit
3064 * data then setting convert_to_8_bit will cause the output to be an 8-bit PNG
3065 * gamma encoded according to the sRGB specification, otherwise a 16-bit linear
3066 * encoded PNG file is written.
3067 *
3068 * With color-mapped data formats the colormap parameter point to a color-map
3069 * with at least image->colormap_entries encoded in the specified format. If
3070 * the format is linear the written PNG color-map will be converted to sRGB
3071 * regardless of the convert_to_8_bit flag.
3072 *
3073 * With all APIs row_stride is handled as in the read APIs - it is the spacing
3074 * from one row to the next in component sized units (1 or 2 bytes) and if
Matt Sarett9ea75692016-01-08 13:00:42 -05003075 * negative indicates a bottom-up row layout in the buffer. If row_stride is zero,
3076 * libpng will calculate it for you from the image width and number of channels.
Chris Craikb50c2172013-07-29 15:28:30 -07003077 *
Matt Sarett9ea75692016-01-08 13:00:42 -05003078 * Note that the write API does not support interlacing, sub-8-bit pixels, indexed
3079 * PNG (color_type 3) or most ancillary chunks.
Chris Craikb50c2172013-07-29 15:28:30 -07003080 */
Matt Sarett9ea75692016-01-08 13:00:42 -05003081#endif /* STDIO */
3082#endif /* SIMPLIFIED_WRITE */
Chris Craikb50c2172013-07-29 15:28:30 -07003083/*******************************************************************************
3084 * END OF SIMPLIFIED API
3085 ******************************************************************************/
Matt Sarett9ea75692016-01-08 13:00:42 -05003086#endif /* SIMPLIFIED_{READ|WRITE} */
Chris Craikb50c2172013-07-29 15:28:30 -07003087
3088/*******************************************************************************
Matt Sarett9ea75692016-01-08 13:00:42 -05003089 * Section 6: IMPLEMENTATION OPTIONS
Chris Craikb50c2172013-07-29 15:28:30 -07003090 *******************************************************************************
3091 *
3092 * Support for arbitrary implementation-specific optimizations. The API allows
3093 * particular options to be turned on or off. 'Option' is the number of the
3094 * option and 'onoff' is 0 (off) or non-0 (on). The value returned is given
3095 * by the PNG_OPTION_ defines below.
3096 *
3097 * HARDWARE: normally hardware capabilites, such as the Intel SSE instructions,
3098 * are detected at run time, however sometimes it may be impossible
3099 * to do this in user mode, in which case it is necessary to discover
3100 * the capabilities in an OS specific way. Such capabilities are
3101 * listed here when libpng has support for them and must be turned
3102 * ON by the application if present.
3103 *
3104 * SOFTWARE: sometimes software optimizations actually result in performance
3105 * decrease on some architectures or systems, or with some sets of
3106 * PNG images. 'Software' options allow such optimizations to be
3107 * selected at run time.
3108 */
3109#ifdef PNG_SET_OPTION_SUPPORTED
3110#ifdef PNG_ARM_NEON_API_SUPPORTED
3111# define PNG_ARM_NEON 0 /* HARDWARE: ARM Neon SIMD instructions supported */
3112#endif
3113#define PNG_MAXIMUM_INFLATE_WINDOW 2 /* SOFTWARE: force maximum window */
Matt Sarett9ea75692016-01-08 13:00:42 -05003114#define PNG_SKIP_sRGB_CHECK_PROFILE 4 /* SOFTWARE: Check ICC profile for sRGB */
3115#define PNG_OPTION_NEXT 6 /* Next option - numbers must be even */
Chris Craikb50c2172013-07-29 15:28:30 -07003116
3117/* Return values: NOTE: there are four values and 'off' is *not* zero */
3118#define PNG_OPTION_UNSET 0 /* Unset - defaults to off */
3119#define PNG_OPTION_INVALID 1 /* Option number out of range */
3120#define PNG_OPTION_OFF 2
3121#define PNG_OPTION_ON 3
3122
3123PNG_EXPORT(244, int, png_set_option, (png_structrp png_ptr, int option,
3124 int onoff));
Matt Sarett9ea75692016-01-08 13:00:42 -05003125#endif /* SET_OPTION */
The Android Open Source Project893912b2009-03-03 19:30:05 -08003126
Chris Craikb50c2172013-07-29 15:28:30 -07003127/*******************************************************************************
Matt Sarett9ea75692016-01-08 13:00:42 -05003128 * END OF HARDWARE AND SOFTWARE OPTIONS
Chris Craikb50c2172013-07-29 15:28:30 -07003129 ******************************************************************************/
3130
Matt Sarett9ea75692016-01-08 13:00:42 -05003131/* Maintainer: Put new public prototypes here ^, in libpng.3, in project
3132 * defs, and in scripts/symbols.def.
Chris Craikb50c2172013-07-29 15:28:30 -07003133 */
3134
3135/* The last ordinal number (this is the *last* one already used; the next
Matt Sarett9ea75692016-01-08 13:00:42 -05003136 * one to use is one more than this.)
Chris Craikb50c2172013-07-29 15:28:30 -07003137 */
3138#ifdef PNG_EXPORT_LAST_ORDINAL
3139 PNG_EXPORT_LAST_ORDINAL(244);
The Android Open Source Project893912b2009-03-03 19:30:05 -08003140#endif
3141
The Android Open Source Project893912b2009-03-03 19:30:05 -08003142#ifdef __cplusplus
3143}
3144#endif
3145
3146#endif /* PNG_VERSION_INFO_ONLY */
Patrick Scotta0bb96c2009-07-22 11:50:02 -04003147/* Do not put anything past this line */
The Android Open Source Project893912b2009-03-03 19:30:05 -08003148#endif /* PNG_H */