/* png.h - header file for PNG reference library1*2* libpng version 1.6.483*4* Copyright (c) 2018-2025 Cosmin Truta5* Copyright (c) 1998-2002,2004,2006-2018 Glenn Randers-Pehrson6* Copyright (c) 1996-1997 Andreas Dilger7* Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc.8*9* This code is released under the libpng license. (See LICENSE, below.)10*11* Authors and maintainers:12* libpng versions 0.71, May 1995, through 0.88, January 1996: Guy Schalnat13* libpng versions 0.89, June 1996, through 0.96, May 1997: Andreas Dilger14* libpng versions 0.97, January 1998, through 1.6.35, July 2018:15* Glenn Randers-Pehrson16* libpng versions 1.6.36, December 2018, through 1.6.48, April 2025:17* Cosmin Truta18* See also "Contributing Authors", below.19*/2021/*22* COPYRIGHT NOTICE, DISCLAIMER, and LICENSE23* =========================================24*25* PNG Reference Library License version 226* ---------------------------------------27*28* * Copyright (c) 1995-2025 The PNG Reference Library Authors.29* * Copyright (c) 2018-2025 Cosmin Truta.30* * Copyright (c) 2000-2002, 2004, 2006-2018 Glenn Randers-Pehrson.31* * Copyright (c) 1996-1997 Andreas Dilger.32* * Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc.33*34* The software is supplied "as is", without warranty of any kind,35* express or implied, including, without limitation, the warranties36* of merchantability, fitness for a particular purpose, title, and37* non-infringement. In no event shall the Copyright owners, or38* anyone distributing the software, be liable for any damages or39* other liability, whether in contract, tort or otherwise, arising40* from, out of, or in connection with the software, or the use or41* other dealings in the software, even if advised of the possibility42* of such damage.43*44* Permission is hereby granted to use, copy, modify, and distribute45* this software, or portions hereof, for any purpose, without fee,46* subject to the following restrictions:47*48* 1. The origin of this software must not be misrepresented; you49* must not claim that you wrote the original software. If you50* use this software in a product, an acknowledgment in the product51* documentation would be appreciated, but is not required.52*53* 2. Altered source versions must be plainly marked as such, and must54* not be misrepresented as being the original software.55*56* 3. This Copyright notice may not be removed or altered from any57* source or altered source distribution.58*59*60* PNG Reference Library License version 1 (for libpng 0.5 through 1.6.35)61* -----------------------------------------------------------------------62*63* libpng versions 1.0.7, July 1, 2000, through 1.6.35, July 15, 2018 are64* Copyright (c) 2000-2002, 2004, 2006-2018 Glenn Randers-Pehrson, are65* derived from libpng-1.0.6, and are distributed according to the same66* disclaimer and license as libpng-1.0.6 with the following individuals67* added to the list of Contributing Authors:68*69* Simon-Pierre Cadieux70* Eric S. Raymond71* Mans Rullgard72* Cosmin Truta73* Gilles Vollant74* James Yu75* Mandar Sahastrabuddhe76* Google Inc.77* Vadim Barkov78*79* and with the following additions to the disclaimer:80*81* There is no warranty against interference with your enjoyment of82* the library or against infringement. There is no warranty that our83* efforts or the library will fulfill any of your particular purposes84* or needs. This library is provided with all faults, and the entire85* risk of satisfactory quality, performance, accuracy, and effort is86* with the user.87*88* Some files in the "contrib" directory and some configure-generated89* files that are distributed with libpng have other copyright owners, and90* are released under other open source licenses.91*92* libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are93* Copyright (c) 1998-2000 Glenn Randers-Pehrson, are derived from94* libpng-0.96, and are distributed according to the same disclaimer and95* license as libpng-0.96, with the following individuals added to the96* list of Contributing Authors:97*98* Tom Lane99* Glenn Randers-Pehrson100* Willem van Schaik101*102* libpng versions 0.89, June 1996, through 0.96, May 1997, are103* Copyright (c) 1996-1997 Andreas Dilger, are derived from libpng-0.88,104* and are distributed according to the same disclaimer and license as105* libpng-0.88, with the following individuals added to the list of106* Contributing Authors:107*108* John Bowler109* Kevin Bracey110* Sam Bushell111* Magnus Holmgren112* Greg Roelofs113* Tom Tanner114*115* Some files in the "scripts" directory have other copyright owners,116* but are released under this license.117*118* libpng versions 0.5, May 1995, through 0.88, January 1996, are119* Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc.120*121* For the purposes of this copyright and license, "Contributing Authors"122* is defined as the following set of individuals:123*124* Andreas Dilger125* Dave Martindale126* Guy Eric Schalnat127* Paul Schmidt128* Tim Wegner129*130* The PNG Reference Library is supplied "AS IS". The Contributing131* Authors and Group 42, Inc. disclaim all warranties, expressed or132* implied, including, without limitation, the warranties of133* merchantability and of fitness for any purpose. The Contributing134* Authors and Group 42, Inc. assume no liability for direct, indirect,135* incidental, special, exemplary, or consequential damages, which may136* result from the use of the PNG Reference Library, even if advised of137* the possibility of such damage.138*139* Permission is hereby granted to use, copy, modify, and distribute this140* source code, or portions hereof, for any purpose, without fee, subject141* to the following restrictions:142*143* 1. The origin of this source code must not be misrepresented.144*145* 2. Altered versions must be plainly marked as such and must not146* be misrepresented as being the original source.147*148* 3. This Copyright notice may not be removed or altered from any149* source or altered source distribution.150*151* The Contributing Authors and Group 42, Inc. specifically permit,152* without fee, and encourage the use of this source code as a component153* to supporting the PNG file format in commercial products. If you use154* this source code in a product, acknowledgment is not required but would155* be appreciated.156*157* END OF COPYRIGHT NOTICE, DISCLAIMER, and LICENSE.158*159* TRADEMARK160* =========161*162* The name "libpng" has not been registered by the Copyright owners163* as a trademark in any jurisdiction. However, because libpng has164* been distributed and maintained world-wide, continually since 1995,165* the Copyright owners claim "common-law trademark protection" in any166* jurisdiction where common-law trademark is recognized.167*/168169/*170* A "png_get_copyright" function is available, for convenient use in "about"171* boxes and the like:172*173* printf("%s", png_get_copyright(NULL));174*175* Also, the PNG logo (in PNG format, of course) is supplied in the176* files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).177*/178179/*180* The contributing authors would like to thank all those who helped181* with testing, bug fixes, and patience. This wouldn't have been182* possible without all of you.183*184* Thanks to Frank J. T. Wojcik for helping with the documentation.185*/186187/* Note about libpng version numbers:188*189* Due to various miscommunications, unforeseen code incompatibilities190* and occasional factors outside the authors' control, version numbering191* on the library has not always been consistent and straightforward.192* The following table summarizes matters since version 0.89c, which was193* the first widely used release:194*195* source png.h png.h shared-lib196* version string int version197* ------- ------ ----- ----------198* 0.89c "1.0 beta 3" 0.89 89 1.0.89199* 0.90 "1.0 beta 4" 0.90 90 0.90 [should have been 2.0.90]200* 0.95 "1.0 beta 5" 0.95 95 0.95 [should have been 2.0.95]201* 0.96 "1.0 beta 6" 0.96 96 0.96 [should have been 2.0.96]202* 0.97b "1.00.97 beta 7" 1.00.97 97 1.0.1 [should have been 2.0.97]203* 0.97c 0.97 97 2.0.97204* 0.98 0.98 98 2.0.98205* 0.99 0.99 98 2.0.99206* 0.99a-m 0.99 99 2.0.99207* 1.00 1.00 100 2.1.0 [100 should be 10000]208* 1.0.0 (from here on, the 100 2.1.0 [100 should be 10000]209* 1.0.1 png.h string is 10001 2.1.0210* 1.0.1a-e identical to the 10002 from here on, the shared library211* 1.0.2 source version) 10002 is 2.V where V is the source code212* 1.0.2a-b 10003 version, except as noted.213* 1.0.3 10003214* 1.0.3a-d 10004215* 1.0.4 10004216* 1.0.4a-f 10005217* 1.0.5 (+ 2 patches) 10005218* 1.0.5a-d 10006219* 1.0.5e-r 10100 (not source compatible)220* 1.0.5s-v 10006 (not binary compatible)221* 1.0.6 (+ 3 patches) 10006 (still binary incompatible)222* 1.0.6d-f 10007 (still binary incompatible)223* 1.0.6g 10007224* 1.0.6h 10007 10.6h (testing xy.z so-numbering)225* 1.0.6i 10007 10.6i226* 1.0.6j 10007 2.1.0.6j (incompatible with 1.0.0)227* 1.0.7beta11-14 DLLNUM 10007 2.1.0.7beta11-14 (binary compatible)228* 1.0.7beta15-18 1 10007 2.1.0.7beta15-18 (binary compatible)229* 1.0.7rc1-2 1 10007 2.1.0.7rc1-2 (binary compatible)230* 1.0.7 1 10007 (still compatible)231* ...232* 1.0.69 10 10069 10.so.0.69[.0]233* ...234* 1.2.59 13 10259 12.so.0.59[.0]235* ...236* 1.4.20 14 10420 14.so.0.20[.0]237* ...238* 1.5.30 15 10530 15.so.15.30[.0]239* ...240* 1.6.48 16 10648 16.so.16.48[.0]241*242* Henceforth the source version will match the shared-library major and243* minor numbers; the shared-library major version number will be used for244* changes in backward compatibility, as it is intended.245* The PNG_LIBPNG_VER macro, which is not used within libpng but is246* available for applications, is an unsigned integer of the form XYYZZ247* corresponding to the source version X.Y.Z (leading zeros in Y and Z).248* Beta versions were given the previous public release number plus a249* letter, until version 1.0.6j; from then on they were given the upcoming250* public release number plus "betaNN" or "rcNN".251*252* Binary incompatibility exists only when applications make direct access253* to the info_ptr or png_ptr members through png.h, and the compiled254* application is loaded with a different version of the library.255*256* See libpng.txt or libpng.3 for more information. The PNG specification257* is available as a W3C Recommendation and as an ISO/IEC Standard; see258* <https://www.w3.org/TR/2003/REC-PNG-20031110/>259*/260261#ifndef PNG_H262#define PNG_H263264/* This is not the place to learn how to use libpng. The file libpng-manual.txt265* describes how to use libpng, and the file example.c summarizes it266* with some code on which to build. This file is useful for looking267* at the actual function definitions and structure components. If that268* file has been stripped from your copy of libpng, you can find it at269* <http://www.libpng.org/pub/png/libpng-manual.txt>270*271* If you just need to read a PNG file and don't want to read the documentation272* skip to the end of this file and read the section entitled 'simplified API'.273*/274275/* Version information for png.h - this should match the version in png.c */276#define PNG_LIBPNG_VER_STRING "1.6.48"277#define PNG_HEADER_VERSION_STRING " libpng version " PNG_LIBPNG_VER_STRING "\n"278279/* The versions of shared library builds should stay in sync, going forward */280#define PNG_LIBPNG_VER_SHAREDLIB 16281#define PNG_LIBPNG_VER_SONUM PNG_LIBPNG_VER_SHAREDLIB /* [Deprecated] */282#define PNG_LIBPNG_VER_DLLNUM PNG_LIBPNG_VER_SHAREDLIB /* [Deprecated] */283284/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */285#define PNG_LIBPNG_VER_MAJOR 1286#define PNG_LIBPNG_VER_MINOR 6287#define PNG_LIBPNG_VER_RELEASE 48288289/* This should be zero for a public release, or non-zero for a290* development version.291*/292#define PNG_LIBPNG_VER_BUILD 0293294/* Release Status */295#define PNG_LIBPNG_BUILD_ALPHA 1296#define PNG_LIBPNG_BUILD_BETA 2297#define PNG_LIBPNG_BUILD_RC 3298#define PNG_LIBPNG_BUILD_STABLE 4299#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7300301/* Release-Specific Flags */302#define PNG_LIBPNG_BUILD_PATCH 8 /* Can be OR'ed with303PNG_LIBPNG_BUILD_STABLE only */304#define PNG_LIBPNG_BUILD_PRIVATE 16 /* Cannot be OR'ed with305PNG_LIBPNG_BUILD_SPECIAL */306#define PNG_LIBPNG_BUILD_SPECIAL 32 /* Cannot be OR'ed with307PNG_LIBPNG_BUILD_PRIVATE */308309#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_STABLE310311/* Careful here. At one time, Guy wanted to use 082, but that312* would be octal. We must not include leading zeros.313* Versions 0.7 through 1.0.0 were in the range 0 to 100 here314* (only version 1.0.0 was mis-numbered 100 instead of 10000).315* From version 1.0.1 it is:316* XXYYZZ, where XX=major, YY=minor, ZZ=release317*/318#define PNG_LIBPNG_VER 10648 /* 1.6.48 */319320/* Library configuration: these options cannot be changed after321* the library has been built.322*/323#ifndef PNGLCONF_H324/* If pnglibconf.h is missing, you can325* copy scripts/pnglibconf.h.prebuilt to pnglibconf.h326*/327# include "pnglibconf.h"328#endif329330#ifndef PNG_VERSION_INFO_ONLY331/* Machine specific configuration. */332# include "pngconf.h"333#endif334335/*336* Added at libpng-1.2.8337*338* Ref MSDN: Private as priority over Special339* VS_FF_PRIVATEBUILD File *was not* built using standard release340* procedures. If this value is given, the StringFileInfo block must341* contain a PrivateBuild string.342*343* VS_FF_SPECIALBUILD File *was* built by the original company using344* standard release procedures but is a variation of the standard345* file of the same version number. If this value is given, the346* StringFileInfo block must contain a SpecialBuild string.347*/348349#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */350# define PNG_LIBPNG_BUILD_TYPE \351(PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)352#else353# ifdef PNG_LIBPNG_SPECIALBUILD354# define PNG_LIBPNG_BUILD_TYPE \355(PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)356# else357# define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)358# endif359#endif360361#ifndef PNG_VERSION_INFO_ONLY362363/* Inhibit C++ name-mangling for libpng functions but not for system calls. */364#ifdef __cplusplus365extern "C" {366#endif /* __cplusplus */367368/* Version information for C files, stored in png.c. This had better match369* the version above.370*/371#define png_libpng_ver png_get_header_ver(NULL)372373/* This file is arranged in several sections:374*375* 1. [omitted]376* 2. Any configuration options that can be specified by for the application377* code when it is built. (Build time configuration is in pnglibconf.h)378* 3. Type definitions (base types are defined in pngconf.h), structure379* definitions.380* 4. Exported library functions.381* 5. Simplified API.382* 6. Implementation options.383*384* The library source code has additional files (principally pngpriv.h) that385* allow configuration of the library.386*/387388/* Section 1: [omitted] */389390/* Section 2: run time configuration391* See pnglibconf.h for build time configuration392*393* Run time configuration allows the application to choose between394* implementations of certain arithmetic APIs. The default is set395* at build time and recorded in pnglibconf.h, but it is safe to396* override these (and only these) settings. Note that this won't397* change what the library does, only application code, and the398* settings can (and probably should) be made on a per-file basis399* by setting the #defines before including png.h400*401* Use macros to read integers from PNG data or use the exported402* functions?403* PNG_USE_READ_MACROS: use the macros (see below) Note that404* the macros evaluate their argument multiple times.405* PNG_NO_USE_READ_MACROS: call the relevant library function.406*407* Use the alternative algorithm for compositing alpha samples that408* does not use division?409* PNG_READ_COMPOSITE_NODIV_SUPPORTED: use the 'no division'410* algorithm.411* PNG_NO_READ_COMPOSITE_NODIV: use the 'division' algorithm.412*413* How to handle benign errors if PNG_ALLOW_BENIGN_ERRORS is414* false?415* PNG_ALLOW_BENIGN_ERRORS: map calls to the benign error416* APIs to png_warning.417* Otherwise the calls are mapped to png_error.418*/419420/* Section 3: type definitions, including structures and compile time421* constants.422* See pngconf.h for base types that vary by machine/system423*/424425/* This triggers a compiler error in png.c, if png.c and png.h426* do not agree upon the version number.427*/428typedef char* png_libpng_version_1_6_48;429430/* Basic control structions. Read libpng-manual.txt or libpng.3 for more info.431*432* png_struct is the cache of information used while reading or writing a single433* PNG file. One of these is always required, although the simplified API434* (below) hides the creation and destruction of it.435*/436typedef struct png_struct_def png_struct;437typedef const png_struct * png_const_structp;438typedef png_struct * png_structp;439typedef png_struct * * png_structpp;440441/* png_info contains information read from or to be written to a PNG file. One442* or more of these must exist while reading or creating a PNG file. The443* information is not used by libpng during read but is used to control what444* gets written when a PNG file is created. "png_get_" function calls read445* information during read and "png_set_" functions calls write information446* when creating a PNG.447* been moved into a separate header file that is not accessible to448* applications. Read libpng-manual.txt or libpng.3 for more info.449*/450typedef struct png_info_def png_info;451typedef png_info * png_infop;452typedef const png_info * png_const_infop;453typedef png_info * * png_infopp;454455/* Types with names ending 'p' are pointer types. The corresponding types with456* names ending 'rp' are identical pointer types except that the pointer is457* marked 'restrict', which means that it is the only pointer to the object458* passed to the function. Applications should not use the 'restrict' types;459* it is always valid to pass 'p' to a pointer with a function argument of the460* corresponding 'rp' type. Different compilers have different rules with461* regard to type matching in the presence of 'restrict'. For backward462* compatibility libpng callbacks never have 'restrict' in their parameters and,463* consequentially, writing portable application code is extremely difficult if464* an attempt is made to use 'restrict'.465*/466typedef png_struct * PNG_RESTRICT png_structrp;467typedef const png_struct * PNG_RESTRICT png_const_structrp;468typedef png_info * PNG_RESTRICT png_inforp;469typedef const png_info * PNG_RESTRICT png_const_inforp;470471/* Three color definitions. The order of the red, green, and blue, (and the472* exact size) is not important, although the size of the fields need to473* be png_byte or png_uint_16 (as defined below).474*/475typedef struct png_color_struct476{477png_byte red;478png_byte green;479png_byte blue;480} png_color;481typedef png_color * png_colorp;482typedef const png_color * png_const_colorp;483typedef png_color * * png_colorpp;484485typedef struct png_color_16_struct486{487png_byte index; /* used for palette files */488png_uint_16 red; /* for use in red green blue files */489png_uint_16 green;490png_uint_16 blue;491png_uint_16 gray; /* for use in grayscale files */492} png_color_16;493typedef png_color_16 * png_color_16p;494typedef const png_color_16 * png_const_color_16p;495typedef png_color_16 * * png_color_16pp;496497typedef struct png_color_8_struct498{499png_byte red; /* for use in red green blue files */500png_byte green;501png_byte blue;502png_byte gray; /* for use in grayscale files */503png_byte alpha; /* for alpha channel files */504} png_color_8;505typedef png_color_8 * png_color_8p;506typedef const png_color_8 * png_const_color_8p;507typedef png_color_8 * * png_color_8pp;508509/*510* The following two structures are used for the in-core representation511* of sPLT chunks.512*/513typedef struct png_sPLT_entry_struct514{515png_uint_16 red;516png_uint_16 green;517png_uint_16 blue;518png_uint_16 alpha;519png_uint_16 frequency;520} png_sPLT_entry;521typedef png_sPLT_entry * png_sPLT_entryp;522typedef const png_sPLT_entry * png_const_sPLT_entryp;523typedef png_sPLT_entry * * png_sPLT_entrypp;524525/* When the depth of the sPLT palette is 8 bits, the color and alpha samples526* occupy the LSB of their respective members, and the MSB of each member527* is zero-filled. The frequency member always occupies the full 16 bits.528*/529530typedef struct png_sPLT_struct531{532png_charp name; /* palette name */533png_byte depth; /* depth of palette samples */534png_sPLT_entryp entries; /* palette entries */535png_int_32 nentries; /* number of palette entries */536} png_sPLT_t;537typedef png_sPLT_t * png_sPLT_tp;538typedef const png_sPLT_t * png_const_sPLT_tp;539typedef png_sPLT_t * * png_sPLT_tpp;540541#ifdef PNG_TEXT_SUPPORTED542/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,543* and whether that contents is compressed or not. The "key" field544* points to a regular zero-terminated C string. The "text" fields can be a545* regular C string, an empty string, or a NULL pointer.546* However, the structure returned by png_get_text() will always contain547* the "text" field as a regular zero-terminated C string (possibly548* empty), never a NULL pointer, so it can be safely used in printf() and549* other string-handling functions. Note that the "itxt_length", "lang", and550* "lang_key" members of the structure only exist when the library is built551* with iTXt chunk support. Prior to libpng-1.4.0 the library was built by552* default without iTXt support. Also note that when iTXt *is* supported,553* the "lang" and "lang_key" fields contain NULL pointers when the554* "compression" field contains * PNG_TEXT_COMPRESSION_NONE or555* PNG_TEXT_COMPRESSION_zTXt. Note that the "compression value" is not the556* same as what appears in the PNG tEXt/zTXt/iTXt chunk's "compression flag"557* which is always 0 or 1, or its "compression method" which is always 0.558*/559typedef struct png_text_struct560{561int compression; /* compression value:562-1: tEXt, none5630: zTXt, deflate5641: iTXt, none5652: iTXt, deflate */566png_charp key; /* keyword, 1-79 character description of "text" */567png_charp text; /* comment, may be an empty string (ie "")568or a NULL pointer */569size_t text_length; /* length of the text string */570size_t itxt_length; /* length of the itxt string */571png_charp lang; /* language code, 0-79 characters572or a NULL pointer */573png_charp lang_key; /* keyword translated UTF-8 string, 0 or more574chars or a NULL pointer */575} png_text;576typedef png_text * png_textp;577typedef const png_text * png_const_textp;578typedef png_text * * png_textpp;579#endif580581/* Supported compression types for text in PNG files (tEXt, and zTXt).582* The values of the PNG_TEXT_COMPRESSION_ defines should NOT be changed. */583#define PNG_TEXT_COMPRESSION_NONE_WR -3584#define PNG_TEXT_COMPRESSION_zTXt_WR -2585#define PNG_TEXT_COMPRESSION_NONE -1586#define PNG_TEXT_COMPRESSION_zTXt 0587#define PNG_ITXT_COMPRESSION_NONE 1588#define PNG_ITXT_COMPRESSION_zTXt 2589#define PNG_TEXT_COMPRESSION_LAST 3 /* Not a valid value */590591/* png_time is a way to hold the time in an machine independent way.592* Two conversions are provided, both from time_t and struct tm. There593* is no portable way to convert to either of these structures, as far594* as I know. If you know of a portable way, send it to me. As a side595* note - PNG has always been Year 2000 compliant!596*/597typedef struct png_time_struct598{599png_uint_16 year; /* full year, as in, 1995 */600png_byte month; /* month of year, 1 - 12 */601png_byte day; /* day of month, 1 - 31 */602png_byte hour; /* hour of day, 0 - 23 */603png_byte minute; /* minute of hour, 0 - 59 */604png_byte second; /* second of minute, 0 - 60 (for leap seconds) */605} png_time;606typedef png_time * png_timep;607typedef const png_time * png_const_timep;608typedef png_time * * png_timepp;609610#if defined(PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED) ||\611defined(PNG_USER_CHUNKS_SUPPORTED)612/* png_unknown_chunk is a structure to hold queued chunks for which there is613* no specific support. The idea is that we can use this to queue614* up private chunks for output even though the library doesn't actually615* know about their semantics.616*617* The data in the structure is set by libpng on read and used on write.618*/619typedef struct png_unknown_chunk_t620{621png_byte name[5]; /* Textual chunk name with '\0' terminator */622png_byte *data; /* Data, should not be modified on read! */623size_t size;624625/* On write 'location' must be set using the flag values listed below.626* Notice that on read it is set by libpng however the values stored have627* more bits set than are listed below. Always treat the value as a628* bitmask. On write set only one bit - setting multiple bits may cause the629* chunk to be written in multiple places.630*/631png_byte location; /* mode of operation at read time */632}633png_unknown_chunk;634635typedef png_unknown_chunk * png_unknown_chunkp;636typedef const png_unknown_chunk * png_const_unknown_chunkp;637typedef png_unknown_chunk * * png_unknown_chunkpp;638#endif639640/* Flag values for the unknown chunk location byte. */641#define PNG_HAVE_IHDR 0x01642#define PNG_HAVE_PLTE 0x02643#define PNG_AFTER_IDAT 0x08644645/* Maximum positive integer used in PNG is (2^31)-1 */646#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)647#define PNG_UINT_32_MAX ((png_uint_32)(-1))648#define PNG_SIZE_MAX ((size_t)(-1))649650/* These are constants for fixed point values encoded in the651* PNG specification manner (x100000)652*/653#define PNG_FP_1 100000654#define PNG_FP_HALF 50000655#define PNG_FP_MAX ((png_fixed_point)0x7fffffffL)656#define PNG_FP_MIN (-PNG_FP_MAX)657658/* These describe the color_type field in png_info. */659/* color type masks */660#define PNG_COLOR_MASK_PALETTE 1661#define PNG_COLOR_MASK_COLOR 2662#define PNG_COLOR_MASK_ALPHA 4663664/* color types. Note that not all combinations are legal */665#define PNG_COLOR_TYPE_GRAY 0666#define PNG_COLOR_TYPE_PALETTE (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE)667#define PNG_COLOR_TYPE_RGB (PNG_COLOR_MASK_COLOR)668#define PNG_COLOR_TYPE_RGB_ALPHA (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA)669#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)670/* aliases */671#define PNG_COLOR_TYPE_RGBA PNG_COLOR_TYPE_RGB_ALPHA672#define PNG_COLOR_TYPE_GA PNG_COLOR_TYPE_GRAY_ALPHA673674/* This is for compression type. PNG 1.0-1.2 only define the single type. */675#define PNG_COMPRESSION_TYPE_BASE 0 /* Deflate method 8, 32K window */676#define PNG_COMPRESSION_TYPE_DEFAULT PNG_COMPRESSION_TYPE_BASE677678/* This is for filter type. PNG 1.0-1.2 only define the single type. */679#define PNG_FILTER_TYPE_BASE 0 /* Single row per-byte filtering */680#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */681#define PNG_FILTER_TYPE_DEFAULT PNG_FILTER_TYPE_BASE682683/* These are for the interlacing type. These values should NOT be changed. */684#define PNG_INTERLACE_NONE 0 /* Non-interlaced image */685#define PNG_INTERLACE_ADAM7 1 /* Adam7 interlacing */686#define PNG_INTERLACE_LAST 2 /* Not a valid value */687688/* These are for the oFFs chunk. These values should NOT be changed. */689#define PNG_OFFSET_PIXEL 0 /* Offset in pixels */690#define PNG_OFFSET_MICROMETER 1 /* Offset in micrometers (1/10^6 meter) */691#define PNG_OFFSET_LAST 2 /* Not a valid value */692693/* These are for the pCAL chunk. These values should NOT be changed. */694#define PNG_EQUATION_LINEAR 0 /* Linear transformation */695#define PNG_EQUATION_BASE_E 1 /* Exponential base e transform */696#define PNG_EQUATION_ARBITRARY 2 /* Arbitrary base exponential transform */697#define PNG_EQUATION_HYPERBOLIC 3 /* Hyperbolic sine transformation */698#define PNG_EQUATION_LAST 4 /* Not a valid value */699700/* These are for the sCAL chunk. These values should NOT be changed. */701#define PNG_SCALE_UNKNOWN 0 /* unknown unit (image scale) */702#define PNG_SCALE_METER 1 /* meters per pixel */703#define PNG_SCALE_RADIAN 2 /* radians per pixel */704#define PNG_SCALE_LAST 3 /* Not a valid value */705706/* These are for the pHYs chunk. These values should NOT be changed. */707#define PNG_RESOLUTION_UNKNOWN 0 /* pixels/unknown unit (aspect ratio) */708#define PNG_RESOLUTION_METER 1 /* pixels/meter */709#define PNG_RESOLUTION_LAST 2 /* Not a valid value */710711/* These are for the sRGB chunk. These values should NOT be changed. */712#define PNG_sRGB_INTENT_PERCEPTUAL 0713#define PNG_sRGB_INTENT_RELATIVE 1714#define PNG_sRGB_INTENT_SATURATION 2715#define PNG_sRGB_INTENT_ABSOLUTE 3716#define PNG_sRGB_INTENT_LAST 4 /* Not a valid value */717718/* This is for text chunks */719#define PNG_KEYWORD_MAX_LENGTH 79720721/* Maximum number of entries in PLTE/sPLT/tRNS arrays */722#define PNG_MAX_PALETTE_LENGTH 256723724/* These determine if an ancillary chunk's data has been successfully read725* from the PNG header, or if the application has filled in the corresponding726* data in the info_struct to be written into the output file. The values727* of the PNG_INFO_<chunk> defines should NOT be changed.728*/729#define PNG_INFO_gAMA 0x0001U730#define PNG_INFO_sBIT 0x0002U731#define PNG_INFO_cHRM 0x0004U732#define PNG_INFO_PLTE 0x0008U733#define PNG_INFO_tRNS 0x0010U734#define PNG_INFO_bKGD 0x0020U735#define PNG_INFO_hIST 0x0040U736#define PNG_INFO_pHYs 0x0080U737#define PNG_INFO_oFFs 0x0100U738#define PNG_INFO_tIME 0x0200U739#define PNG_INFO_pCAL 0x0400U740#define PNG_INFO_sRGB 0x0800U /* GR-P, 0.96a */741#define PNG_INFO_iCCP 0x1000U /* ESR, 1.0.6 */742#define PNG_INFO_sPLT 0x2000U /* ESR, 1.0.6 */743#define PNG_INFO_sCAL 0x4000U /* ESR, 1.0.6 */744#define PNG_INFO_IDAT 0x8000U /* ESR, 1.0.6 */745#define PNG_INFO_eXIf 0x10000U /* GR-P, 1.6.31 */746#define PNG_INFO_cICP 0x20000U /* PNGv3: 1.6.45 */747#define PNG_INFO_cLLI 0x40000U /* PNGv3: 1.6.45 */748#define PNG_INFO_mDCV 0x80000U /* PNGv3: 1.6.45 */749/* APNG: these chunks are stored as unknown, these flags are never set750* however they are provided as a convenience for implementors of APNG and751* avoids any merge conflicts.752*753* Private chunks: these chunk names violate the chunk name recommendations754* because the chunk definitions have no signature and because the private755* chunks with these names have been reserved. Private definitions should756* avoid them.757*/758#define PNG_INFO_acTL 0x100000U /* PNGv3: 1.6.45: unknown */759#define PNG_INFO_fcTL 0x200000U /* PNGv3: 1.6.45: unknown */760#define PNG_INFO_fdAT 0x400000U /* PNGv3: 1.6.45: unknown */761762/* This is used for the transformation routines, as some of them763* change these values for the row. It also should enable using764* the routines for other purposes.765*/766typedef struct png_row_info_struct767{768png_uint_32 width; /* width of row */769size_t rowbytes; /* number of bytes in row */770png_byte color_type; /* color type of row */771png_byte bit_depth; /* bit depth of row */772png_byte channels; /* number of channels (1, 2, 3, or 4) */773png_byte pixel_depth; /* bits per pixel (depth * channels) */774} png_row_info;775776typedef png_row_info * png_row_infop;777typedef png_row_info * * png_row_infopp;778779/* These are the function types for the I/O functions and for the functions780* that allow the user to override the default I/O functions with his or her781* own. The png_error_ptr type should match that of user-supplied warning782* and error functions, while the png_rw_ptr type should match that of the783* user read/write data functions. Note that the 'write' function must not784* modify the buffer it is passed. The 'read' function, on the other hand, is785* expected to return the read data in the buffer.786*/787typedef PNG_CALLBACK(void, *png_error_ptr, (png_structp, png_const_charp));788typedef PNG_CALLBACK(void, *png_rw_ptr, (png_structp, png_bytep, size_t));789typedef PNG_CALLBACK(void, *png_flush_ptr, (png_structp));790typedef PNG_CALLBACK(void, *png_read_status_ptr, (png_structp, png_uint_32,791int));792typedef PNG_CALLBACK(void, *png_write_status_ptr, (png_structp, png_uint_32,793int));794795#ifdef PNG_PROGRESSIVE_READ_SUPPORTED796typedef PNG_CALLBACK(void, *png_progressive_info_ptr, (png_structp, png_infop));797typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop));798799/* The following callback receives png_uint_32 row_number, int pass for the800* png_bytep data of the row. When transforming an interlaced image the801* row number is the row number within the sub-image of the interlace pass, so802* the value will increase to the height of the sub-image (not the full image)803* then reset to 0 for the next pass.804*805* Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to806* find the output pixel (x,y) given an interlaced sub-image pixel807* (row,col,pass). (See below for these macros.)808*/809typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,810png_uint_32, int));811#endif812813#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \814defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)815typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,816png_bytep));817#endif818819#ifdef PNG_USER_CHUNKS_SUPPORTED820typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,821png_unknown_chunkp));822#endif823#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED824/* not used anywhere */825/* typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp)); */826#endif827828#ifdef PNG_SETJMP_SUPPORTED829/* This must match the function definition in <setjmp.h>, and the application830* must include this before png.h to obtain the definition of jmp_buf. The831* function is required to be PNG_NORETURN, but this is not checked. If the832* function does return the application will crash via an abort() or similar833* system level call.834*835* If you get a warning here while building the library you may need to make836* changes to ensure that pnglibconf.h records the calling convention used by837* your compiler. This may be very difficult - try using a different compiler838* to build the library!839*/840PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), (jmp_buf, int), typedef);841#endif842843/* Transform masks for the high-level interface */844#define PNG_TRANSFORM_IDENTITY 0x0000 /* read and write */845#define PNG_TRANSFORM_STRIP_16 0x0001 /* read only */846#define PNG_TRANSFORM_STRIP_ALPHA 0x0002 /* read only */847#define PNG_TRANSFORM_PACKING 0x0004 /* read and write */848#define PNG_TRANSFORM_PACKSWAP 0x0008 /* read and write */849#define PNG_TRANSFORM_EXPAND 0x0010 /* read only */850#define PNG_TRANSFORM_INVERT_MONO 0x0020 /* read and write */851#define PNG_TRANSFORM_SHIFT 0x0040 /* read and write */852#define PNG_TRANSFORM_BGR 0x0080 /* read and write */853#define PNG_TRANSFORM_SWAP_ALPHA 0x0100 /* read and write */854#define PNG_TRANSFORM_SWAP_ENDIAN 0x0200 /* read and write */855#define PNG_TRANSFORM_INVERT_ALPHA 0x0400 /* read and write */856#define PNG_TRANSFORM_STRIP_FILLER 0x0800 /* write only */857/* Added to libpng-1.2.34 */858#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER859#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */860/* Added to libpng-1.4.0 */861#define PNG_TRANSFORM_GRAY_TO_RGB 0x2000 /* read only */862/* Added to libpng-1.5.4 */863#define PNG_TRANSFORM_EXPAND_16 0x4000 /* read only */864#if ~0U > 0xffffU /* or else this might break on a 16-bit machine */865#define PNG_TRANSFORM_SCALE_16 0x8000 /* read only */866#endif867868/* Flags for MNG supported features */869#define PNG_FLAG_MNG_EMPTY_PLTE 0x01870#define PNG_FLAG_MNG_FILTER_64 0x04871#define PNG_ALL_MNG_FEATURES 0x05872873/* NOTE: prior to 1.5 these functions had no 'API' style declaration,874* this allowed the zlib default functions to be used on Windows875* platforms. In 1.5 the zlib default malloc (which just calls malloc and876* ignores the first argument) should be completely compatible with the877* following.878*/879typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,880png_alloc_size_t));881typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp));882883/* Section 4: exported functions884* Here are the function definitions most commonly used. This is not885* the place to find out how to use libpng. See libpng-manual.txt for the886* full explanation, see example.c for the summary. This just provides887* a simple one line description of the use of each function.888*889* The PNG_EXPORT() and PNG_EXPORTA() macros used below are defined in890* pngconf.h and in the *.dfn files in the scripts directory.891*892* PNG_EXPORT(ordinal, type, name, (args));893*894* ordinal: ordinal that is used while building895* *.def files. The ordinal value is only896* relevant when preprocessing png.h with897* the *.dfn files for building symbol table898* entries, and are removed by pngconf.h.899* type: return type of the function900* name: function name901* args: function arguments, with types902*903* When we wish to append attributes to a function prototype we use904* the PNG_EXPORTA() macro instead.905*906* PNG_EXPORTA(ordinal, type, name, (args), attributes);907*908* ordinal, type, name, and args: same as in PNG_EXPORT().909* attributes: function attributes910*/911912/* Returns the version number of the library */913PNG_EXPORT(1, png_uint_32, png_access_version_number, (void));914915/* Tell lib we have already handled the first <num_bytes> magic bytes.916* Handling more than 8 bytes from the beginning of the file is an error.917*/918PNG_EXPORT(2, void, png_set_sig_bytes, (png_structrp png_ptr, int num_bytes));919920/* Check sig[start] through sig[start + num_to_check - 1] to see if it's a921* PNG file. Returns zero if the supplied bytes match the 8-byte PNG922* signature, and non-zero otherwise. Having num_to_check == 0 or923* start > 7 will always fail (i.e. return non-zero).924*/925PNG_EXPORT(3, int, png_sig_cmp, (png_const_bytep sig, size_t start,926size_t num_to_check));927928/* Simple signature checking function. This is the same as calling929* png_check_sig(sig, n) := (png_sig_cmp(sig, 0, n) == 0).930*/931#define png_check_sig(sig, n) (png_sig_cmp((sig), 0, (n)) == 0) /* DEPRECATED */932933/* Allocate and initialize png_ptr struct for reading, and any other memory. */934PNG_EXPORTA(4, png_structp, png_create_read_struct,935(png_const_charp user_png_ver, png_voidp error_ptr,936png_error_ptr error_fn, png_error_ptr warn_fn),937PNG_ALLOCATED);938939/* Allocate and initialize png_ptr struct for writing, and any other memory */940PNG_EXPORTA(5, png_structp, png_create_write_struct,941(png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,942png_error_ptr warn_fn),943PNG_ALLOCATED);944945PNG_EXPORT(6, size_t, png_get_compression_buffer_size,946(png_const_structrp png_ptr));947948PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structrp png_ptr,949size_t size));950951/* Moved from pngconf.h in 1.4.0 and modified to ensure setjmp/longjmp952* match up.953*/954#ifdef PNG_SETJMP_SUPPORTED955/* This function returns the jmp_buf built in to *png_ptr. It must be956* supplied with an appropriate 'longjmp' function to use on that jmp_buf957* unless the default error function is overridden in which case NULL is958* acceptable. The size of the jmp_buf is checked against the actual size959* allocated by the library - the call will return NULL on a mismatch960* indicating an ABI mismatch.961*/962PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structrp png_ptr,963png_longjmp_ptr longjmp_fn, size_t jmp_buf_size));964# define png_jmpbuf(png_ptr) \965(*png_set_longjmp_fn((png_ptr), longjmp, (sizeof (jmp_buf))))966#else967# define png_jmpbuf(png_ptr) \968(LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)969#endif970/* This function should be used by libpng applications in place of971* longjmp(png_ptr->jmpbuf, val). If longjmp_fn() has been set, it972* will use it; otherwise it will call PNG_ABORT(). This function was973* added in libpng-1.5.0.974*/975PNG_EXPORTA(9, void, png_longjmp, (png_const_structrp png_ptr, int val),976PNG_NORETURN);977978#ifdef PNG_READ_SUPPORTED979/* Reset the compression stream */980PNG_EXPORTA(10, int, png_reset_zstream, (png_structrp png_ptr), PNG_DEPRECATED);981#endif982983/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */984#ifdef PNG_USER_MEM_SUPPORTED985PNG_EXPORTA(11, png_structp, png_create_read_struct_2,986(png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,987png_error_ptr warn_fn,988png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),989PNG_ALLOCATED);990PNG_EXPORTA(12, png_structp, png_create_write_struct_2,991(png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,992png_error_ptr warn_fn,993png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),994PNG_ALLOCATED);995#endif996997/* Write the PNG file signature. */998PNG_EXPORT(13, void, png_write_sig, (png_structrp png_ptr));9991000/* Write a PNG chunk - size, type, (optional) data, CRC. */1001PNG_EXPORT(14, void, png_write_chunk, (png_structrp png_ptr, png_const_bytep1002chunk_name, png_const_bytep data, size_t length));10031004/* Write the start of a PNG chunk - length and chunk name. */1005PNG_EXPORT(15, void, png_write_chunk_start, (png_structrp png_ptr,1006png_const_bytep chunk_name, png_uint_32 length));10071008/* Write the data of a PNG chunk started with png_write_chunk_start(). */1009PNG_EXPORT(16, void, png_write_chunk_data, (png_structrp png_ptr,1010png_const_bytep data, size_t length));10111012/* Finish a chunk started with png_write_chunk_start() (includes CRC). */1013PNG_EXPORT(17, void, png_write_chunk_end, (png_structrp png_ptr));10141015/* Allocate and initialize the info structure */1016PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_const_structrp png_ptr),1017PNG_ALLOCATED);10181019/* DEPRECATED: this function allowed init structures to be created using the1020* default allocation method (typically malloc). Use is deprecated in 1.6.0 and1021* the API will be removed in the future.1022*/1023PNG_EXPORTA(19, void, png_info_init_3, (png_infopp info_ptr,1024size_t png_info_struct_size), PNG_DEPRECATED);10251026/* Writes all the PNG information before the image. */1027PNG_EXPORT(20, void, png_write_info_before_PLTE,1028(png_structrp png_ptr, png_const_inforp info_ptr));1029PNG_EXPORT(21, void, png_write_info,1030(png_structrp png_ptr, png_const_inforp info_ptr));10311032#ifdef PNG_SEQUENTIAL_READ_SUPPORTED1033/* Read the information before the actual image data. */1034PNG_EXPORT(22, void, png_read_info,1035(png_structrp png_ptr, png_inforp info_ptr));1036#endif10371038#ifdef PNG_TIME_RFC1123_SUPPORTED1039/* Convert to a US string format: there is no localization support in this1040* routine. The original implementation used a 29 character buffer in1041* png_struct, this will be removed in future versions.1042*/1043#if PNG_LIBPNG_VER < 107001044/* To do: remove this from libpng17 (and from libpng17/png.c and pngstruct.h) */1045PNG_EXPORTA(23, png_const_charp, png_convert_to_rfc1123, (png_structrp png_ptr,1046png_const_timep ptime),PNG_DEPRECATED);1047#endif1048PNG_EXPORT(241, int, png_convert_to_rfc1123_buffer, (char out[29],1049png_const_timep ptime));1050#endif10511052#ifdef PNG_CONVERT_tIME_SUPPORTED1053/* Convert from a struct tm to png_time */1054PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime,1055const struct tm * ttime));10561057/* Convert from time_t to png_time. Uses gmtime() */1058PNG_EXPORT(25, void, png_convert_from_time_t, (png_timep ptime, time_t ttime));1059#endif /* CONVERT_tIME */10601061#ifdef PNG_READ_EXPAND_SUPPORTED1062/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */1063PNG_EXPORT(26, void, png_set_expand, (png_structrp png_ptr));1064PNG_EXPORT(27, void, png_set_expand_gray_1_2_4_to_8, (png_structrp png_ptr));1065PNG_EXPORT(28, void, png_set_palette_to_rgb, (png_structrp png_ptr));1066PNG_EXPORT(29, void, png_set_tRNS_to_alpha, (png_structrp png_ptr));1067#endif10681069#ifdef PNG_READ_EXPAND_16_SUPPORTED1070/* Expand to 16-bit channels, forces conversion of palette to RGB and expansion1071* of a tRNS chunk if present.1072*/1073PNG_EXPORT(221, void, png_set_expand_16, (png_structrp png_ptr));1074#endif10751076#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)1077/* Use blue, green, red order for pixels. */1078PNG_EXPORT(30, void, png_set_bgr, (png_structrp png_ptr));1079#endif10801081#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED1082/* Expand the grayscale to 24-bit RGB if necessary. */1083PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structrp png_ptr));1084#endif10851086#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED1087/* Reduce RGB to grayscale. */1088#define PNG_ERROR_ACTION_NONE 11089#define PNG_ERROR_ACTION_WARN 21090#define PNG_ERROR_ACTION_ERROR 31091#define PNG_RGB_TO_GRAY_DEFAULT (-1)/*for red/green coefficients*/10921093PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structrp png_ptr,1094int error_action, double red, double green))1095PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structrp png_ptr,1096int error_action, png_fixed_point red, png_fixed_point green))10971098PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structrp1099png_ptr));1100#endif11011102#ifdef PNG_BUILD_GRAYSCALE_PALETTE_SUPPORTED1103PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth,1104png_colorp palette));1105#endif11061107#ifdef PNG_READ_ALPHA_MODE_SUPPORTED1108/* How the alpha channel is interpreted - this affects how the color channels1109* of a PNG file are returned to the calling application when an alpha channel,1110* or a tRNS chunk in a palette file, is present.1111*1112* This has no effect on the way pixels are written into a PNG output1113* datastream. The color samples in a PNG datastream are never premultiplied1114* with the alpha samples.1115*1116* The default is to return data according to the PNG specification: the alpha1117* channel is a linear measure of the contribution of the pixel to the1118* corresponding composited pixel, and the color channels are unassociated1119* (not premultiplied). The gamma encoded color channels must be scaled1120* according to the contribution and to do this it is necessary to undo1121* the encoding, scale the color values, perform the composition and re-encode1122* the values. This is the 'PNG' mode.1123*1124* The alternative is to 'associate' the alpha with the color information by1125* storing color channel values that have been scaled by the alpha.1126* image. These are the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' modes1127* (the latter being the two common names for associated alpha color channels).1128*1129* For the 'OPTIMIZED' mode, a pixel is treated as opaque only if the alpha1130* value is equal to the maximum value.1131*1132* The final choice is to gamma encode the alpha channel as well. This is1133* broken because, in practice, no implementation that uses this choice1134* correctly undoes the encoding before handling alpha composition. Use this1135* choice only if other serious errors in the software or hardware you use1136* mandate it; the typical serious error is for dark halos to appear around1137* opaque areas of the composited PNG image because of arithmetic overflow.1138*1139* The API function png_set_alpha_mode specifies which of these choices to use1140* with an enumerated 'mode' value and the gamma of the required output:1141*/1142#define PNG_ALPHA_PNG 0 /* according to the PNG standard */1143#define PNG_ALPHA_STANDARD 1 /* according to Porter/Duff */1144#define PNG_ALPHA_ASSOCIATED 1 /* as above; this is the normal practice */1145#define PNG_ALPHA_PREMULTIPLIED 1 /* as above */1146#define PNG_ALPHA_OPTIMIZED 2 /* 'PNG' for opaque pixels, else 'STANDARD' */1147#define PNG_ALPHA_BROKEN 3 /* the alpha channel is gamma encoded */11481149PNG_FP_EXPORT(227, void, png_set_alpha_mode, (png_structrp png_ptr, int mode,1150double output_gamma))1151PNG_FIXED_EXPORT(228, void, png_set_alpha_mode_fixed, (png_structrp png_ptr,1152int mode, png_fixed_point output_gamma))1153#endif11541155#if defined(PNG_GAMMA_SUPPORTED) || defined(PNG_READ_ALPHA_MODE_SUPPORTED)1156/* The output_gamma value is a screen gamma in libpng terminology: it expresses1157* how to decode the output values, not how they are encoded.1158*/1159#define PNG_DEFAULT_sRGB -1 /* sRGB gamma and color space */1160#define PNG_GAMMA_MAC_18 -2 /* Old Mac '1.8' gamma and color space */1161#define PNG_GAMMA_sRGB 220000 /* Television standards--matches sRGB gamma */1162#define PNG_GAMMA_LINEAR PNG_FP_1 /* Linear */1163#endif11641165/* The following are examples of calls to png_set_alpha_mode to achieve the1166* required overall gamma correction and, where necessary, alpha1167* premultiplication.1168*1169* png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);1170* This is the default libpng handling of the alpha channel - it is not1171* pre-multiplied into the color components. In addition the call states1172* that the output is for a sRGB system and causes all PNG files without gAMA1173* chunks to be assumed to be encoded using sRGB.1174*1175* png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);1176* In this case the output is assumed to be something like an sRGB conformant1177* display preceded by a power-law lookup table of power 1.45. This is how1178* early Mac systems behaved.1179*1180* png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);1181* This is the classic Jim Blinn approach and will work in academic1182* environments where everything is done by the book. It has the shortcoming1183* of assuming that input PNG data with no gamma information is linear - this1184* is unlikely to be correct unless the PNG files where generated locally.1185* Most of the time the output precision will be so low as to show1186* significant banding in dark areas of the image.1187*1188* png_set_expand_16(pp);1189* png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB);1190* This is a somewhat more realistic Jim Blinn inspired approach. PNG files1191* are assumed to have the sRGB encoding if not marked with a gamma value and1192* the output is always 16 bits per component. This permits accurate scaling1193* and processing of the data. If you know that your input PNG files were1194* generated locally you might need to replace PNG_DEFAULT_sRGB with the1195* correct value for your system.1196*1197* png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB);1198* If you just need to composite the PNG image onto an existing background1199* and if you control the code that does this you can use the optimization1200* setting. In this case you just copy completely opaque pixels to the1201* output. For pixels that are not completely transparent (you just skip1202* those) you do the composition math using png_composite or png_composite_161203* below then encode the resultant 8-bit or 16-bit values to match the output1204* encoding.1205*1206* Other cases1207* If neither the PNG nor the standard linear encoding work for you because1208* of the software or hardware you use then you have a big problem. The PNG1209* case will probably result in halos around the image. The linear encoding1210* will probably result in a washed out, too bright, image (it's actually too1211* contrasty.) Try the ALPHA_OPTIMIZED mode above - this will probably1212* substantially reduce the halos. Alternatively try:1213*1214* png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB);1215* This option will also reduce the halos, but there will be slight dark1216* halos round the opaque parts of the image where the background is light.1217* In the OPTIMIZED mode the halos will be light halos where the background1218* is dark. Take your pick - the halos are unavoidable unless you can get1219* your hardware/software fixed! (The OPTIMIZED approach is slightly1220* faster.)1221*1222* When the default gamma of PNG files doesn't match the output gamma.1223* If you have PNG files with no gamma information png_set_alpha_mode allows1224* you to provide a default gamma, but it also sets the output gamma to the1225* matching value. If you know your PNG files have a gamma that doesn't1226* match the output you can take advantage of the fact that1227* png_set_alpha_mode always sets the output gamma but only sets the PNG1228* default if it is not already set:1229*1230* png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);1231* png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);1232* The first call sets both the default and the output gamma values, the1233* second call overrides the output gamma without changing the default. This1234* is easier than achieving the same effect with png_set_gamma. You must use1235* PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will1236* fire if more than one call to png_set_alpha_mode and png_set_background is1237* made in the same read operation, however multiple calls with PNG_ALPHA_PNG1238* are ignored.1239*/12401241#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED1242PNG_EXPORT(36, void, png_set_strip_alpha, (png_structrp png_ptr));1243#endif12441245#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \1246defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)1247PNG_EXPORT(37, void, png_set_swap_alpha, (png_structrp png_ptr));1248#endif12491250#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \1251defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)1252PNG_EXPORT(38, void, png_set_invert_alpha, (png_structrp png_ptr));1253#endif12541255#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)1256/* Add a filler byte to 8-bit or 16-bit Gray or 24-bit or 48-bit RGB images. */1257PNG_EXPORT(39, void, png_set_filler, (png_structrp png_ptr, png_uint_32 filler,1258int flags));1259/* The values of the PNG_FILLER_ defines should NOT be changed */1260# define PNG_FILLER_BEFORE 01261# define PNG_FILLER_AFTER 11262/* Add an alpha byte to 8-bit or 16-bit Gray or 24-bit or 48-bit RGB images. */1263PNG_EXPORT(40, void, png_set_add_alpha, (png_structrp png_ptr,1264png_uint_32 filler, int flags));1265#endif /* READ_FILLER || WRITE_FILLER */12661267#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)1268/* Swap bytes in 16-bit depth files. */1269PNG_EXPORT(41, void, png_set_swap, (png_structrp png_ptr));1270#endif12711272#if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED)1273/* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */1274PNG_EXPORT(42, void, png_set_packing, (png_structrp png_ptr));1275#endif12761277#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \1278defined(PNG_WRITE_PACKSWAP_SUPPORTED)1279/* Swap packing order of pixels in bytes. */1280PNG_EXPORT(43, void, png_set_packswap, (png_structrp png_ptr));1281#endif12821283#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)1284/* Converts files to legal bit depths. */1285PNG_EXPORT(44, void, png_set_shift, (png_structrp png_ptr, png_const_color_8p1286true_bits));1287#endif12881289#if defined(PNG_READ_INTERLACING_SUPPORTED) || \1290defined(PNG_WRITE_INTERLACING_SUPPORTED)1291/* Have the code handle the interlacing. Returns the number of passes.1292* MUST be called before png_read_update_info or png_start_read_image,1293* otherwise it will not have the desired effect. Note that it is still1294* necessary to call png_read_row or png_read_rows png_get_image_height1295* times for each pass.1296*/1297PNG_EXPORT(45, int, png_set_interlace_handling, (png_structrp png_ptr));1298#endif12991300#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)1301/* Invert monochrome files */1302PNG_EXPORT(46, void, png_set_invert_mono, (png_structrp png_ptr));1303#endif13041305#ifdef PNG_READ_BACKGROUND_SUPPORTED1306/* Handle alpha and tRNS by replacing with a background color. Prior to1307* libpng-1.5.4 this API must not be called before the PNG file header has been1308* read. Doing so will result in unexpected behavior and possible warnings or1309* errors if the PNG file contains a bKGD chunk.1310*/1311PNG_FP_EXPORT(47, void, png_set_background, (png_structrp png_ptr,1312png_const_color_16p background_color, int background_gamma_code,1313int need_expand, double background_gamma))1314PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structrp png_ptr,1315png_const_color_16p background_color, int background_gamma_code,1316int need_expand, png_fixed_point background_gamma))1317#endif1318#ifdef PNG_READ_BACKGROUND_SUPPORTED1319# define PNG_BACKGROUND_GAMMA_UNKNOWN 01320# define PNG_BACKGROUND_GAMMA_SCREEN 11321# define PNG_BACKGROUND_GAMMA_FILE 21322# define PNG_BACKGROUND_GAMMA_UNIQUE 31323#endif13241325#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED1326/* Scale a 16-bit depth file down to 8-bit, accurately. */1327PNG_EXPORT(229, void, png_set_scale_16, (png_structrp png_ptr));1328#endif13291330#ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED1331#define PNG_READ_16_TO_8_SUPPORTED /* Name prior to 1.5.4 */1332/* Strip the second byte of information from a 16-bit depth file. */1333PNG_EXPORT(48, void, png_set_strip_16, (png_structrp png_ptr));1334#endif13351336#ifdef PNG_READ_QUANTIZE_SUPPORTED1337/* Turn on quantizing, and reduce the palette to the number of colors1338* available.1339*/1340PNG_EXPORT(49, void, png_set_quantize, (png_structrp png_ptr,1341png_colorp palette, int num_palette, int maximum_colors,1342png_const_uint_16p histogram, int full_quantize));1343#endif13441345#ifdef PNG_READ_GAMMA_SUPPORTED1346/* The threshold on gamma processing is configurable but hard-wired into the1347* library. The following is the floating point variant.1348*/1349#define PNG_GAMMA_THRESHOLD (PNG_GAMMA_THRESHOLD_FIXED*.00001)13501351/* Handle gamma correction. Screen_gamma=(display_exponent).1352* NOTE: this API simply sets the screen and file gamma values. It will1353* therefore override the value for gamma in a PNG file if it is called after1354* the file header has been read - use with care - call before reading the PNG1355* file for best results!1356*1357* These routines accept the same gamma values as png_set_alpha_mode (described1358* above). The PNG_GAMMA_ defines and PNG_DEFAULT_sRGB can be passed to either1359* API (floating point or fixed.) Notice, however, that the 'file_gamma' value1360* is the inverse of a 'screen gamma' value.1361*/1362PNG_FP_EXPORT(50, void, png_set_gamma, (png_structrp png_ptr,1363double screen_gamma, double override_file_gamma))1364PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structrp png_ptr,1365png_fixed_point screen_gamma, png_fixed_point override_file_gamma))1366#endif13671368#ifdef PNG_WRITE_FLUSH_SUPPORTED1369/* Set how many lines between output flushes - 0 for no flushing */1370PNG_EXPORT(51, void, png_set_flush, (png_structrp png_ptr, int nrows));1371/* Flush the current PNG output buffer */1372PNG_EXPORT(52, void, png_write_flush, (png_structrp png_ptr));1373#endif13741375/* Optional update palette with requested transformations */1376PNG_EXPORT(53, void, png_start_read_image, (png_structrp png_ptr));13771378/* Optional call to update the users info structure */1379PNG_EXPORT(54, void, png_read_update_info, (png_structrp png_ptr,1380png_inforp info_ptr));13811382#ifdef PNG_SEQUENTIAL_READ_SUPPORTED1383/* Read one or more rows of image data. */1384PNG_EXPORT(55, void, png_read_rows, (png_structrp png_ptr, png_bytepp row,1385png_bytepp display_row, png_uint_32 num_rows));1386#endif13871388#ifdef PNG_SEQUENTIAL_READ_SUPPORTED1389/* Read a row of data. */1390PNG_EXPORT(56, void, png_read_row, (png_structrp png_ptr, png_bytep row,1391png_bytep display_row));1392#endif13931394#ifdef PNG_SEQUENTIAL_READ_SUPPORTED1395/* Read the whole image into memory at once. */1396PNG_EXPORT(57, void, png_read_image, (png_structrp png_ptr, png_bytepp image));1397#endif13981399/* Write a row of image data */1400PNG_EXPORT(58, void, png_write_row, (png_structrp png_ptr,1401png_const_bytep row));14021403/* Write a few rows of image data: (*row) is not written; however, the type1404* is declared as writeable to maintain compatibility with previous versions1405* of libpng and to allow the 'display_row' array from read_rows to be passed1406* unchanged to write_rows.1407*/1408PNG_EXPORT(59, void, png_write_rows, (png_structrp png_ptr, png_bytepp row,1409png_uint_32 num_rows));14101411/* Write the image data */1412PNG_EXPORT(60, void, png_write_image, (png_structrp png_ptr, png_bytepp image));14131414/* Write the end of the PNG file. */1415PNG_EXPORT(61, void, png_write_end, (png_structrp png_ptr,1416png_inforp info_ptr));14171418#ifdef PNG_SEQUENTIAL_READ_SUPPORTED1419/* Read the end of the PNG file. */1420PNG_EXPORT(62, void, png_read_end, (png_structrp png_ptr, png_inforp info_ptr));1421#endif14221423/* Free any memory associated with the png_info_struct */1424PNG_EXPORT(63, void, png_destroy_info_struct, (png_const_structrp png_ptr,1425png_infopp info_ptr_ptr));14261427/* Free any memory associated with the png_struct and the png_info_structs */1428PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr,1429png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr));14301431/* Free any memory associated with the png_struct and the png_info_structs */1432PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr,1433png_infopp info_ptr_ptr));14341435/* Set the libpng method of handling chunk CRC errors */1436PNG_EXPORT(66, void, png_set_crc_action, (png_structrp png_ptr, int crit_action,1437int ancil_action));14381439/* Values for png_set_crc_action() say how to handle CRC errors in1440* ancillary and critical chunks, and whether to use the data contained1441* therein. Note that it is impossible to "discard" data in a critical1442* chunk. For versions prior to 0.90, the action was always error/quit,1443* whereas in version 0.90 and later, the action for CRC errors in ancillary1444* chunks is warn/discard. These values should NOT be changed.1445*1446* value action:critical action:ancillary1447*/1448#define PNG_CRC_DEFAULT 0 /* error/quit warn/discard data */1449#define PNG_CRC_ERROR_QUIT 1 /* error/quit error/quit */1450#define PNG_CRC_WARN_DISCARD 2 /* (INVALID) warn/discard data */1451#define PNG_CRC_WARN_USE 3 /* warn/use data warn/use data */1452#define PNG_CRC_QUIET_USE 4 /* quiet/use data quiet/use data */1453#define PNG_CRC_NO_CHANGE 5 /* use current value use current value */14541455#ifdef PNG_WRITE_SUPPORTED1456/* These functions give the user control over the scan-line filtering in1457* libpng and the compression methods used by zlib. These functions are1458* mainly useful for testing, as the defaults should work with most users.1459* Those users who are tight on memory or want faster performance at the1460* expense of compression can modify them. See the compression library1461* header file (zlib.h) for an explanation of the compression functions.1462*/14631464/* Set the filtering method(s) used by libpng. Currently, the only valid1465* value for "method" is 0.1466*/1467PNG_EXPORT(67, void, png_set_filter, (png_structrp png_ptr, int method,1468int filters));1469#endif /* WRITE */14701471/* Flags for png_set_filter() to say which filters to use. The flags1472* are chosen so that they don't conflict with real filter types1473* below, in case they are supplied instead of the #defined constants.1474* These values should NOT be changed.1475*/1476#define PNG_NO_FILTERS 0x001477#define PNG_FILTER_NONE 0x081478#define PNG_FILTER_SUB 0x101479#define PNG_FILTER_UP 0x201480#define PNG_FILTER_AVG 0x401481#define PNG_FILTER_PAETH 0x801482#define PNG_FAST_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP)1483#define PNG_ALL_FILTERS (PNG_FAST_FILTERS | PNG_FILTER_AVG | PNG_FILTER_PAETH)14841485/* Filter values (not flags) - used in pngwrite.c, pngwutil.c for now.1486* These defines should NOT be changed.1487*/1488#define PNG_FILTER_VALUE_NONE 01489#define PNG_FILTER_VALUE_SUB 11490#define PNG_FILTER_VALUE_UP 21491#define PNG_FILTER_VALUE_AVG 31492#define PNG_FILTER_VALUE_PAETH 41493#define PNG_FILTER_VALUE_LAST 514941495#ifdef PNG_WRITE_SUPPORTED1496#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* DEPRECATED */1497PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structrp png_ptr,1498int heuristic_method, int num_weights, png_const_doublep filter_weights,1499png_const_doublep filter_costs))1500PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed,1501(png_structrp png_ptr, int heuristic_method, int num_weights,1502png_const_fixed_point_p filter_weights,1503png_const_fixed_point_p filter_costs))1504#endif /* WRITE_WEIGHTED_FILTER */15051506/* The following are no longer used and will be removed from libpng-1.7: */1507#define PNG_FILTER_HEURISTIC_DEFAULT 0 /* Currently "UNWEIGHTED" */1508#define PNG_FILTER_HEURISTIC_UNWEIGHTED 1 /* Used by libpng < 0.95 */1509#define PNG_FILTER_HEURISTIC_WEIGHTED 2 /* Experimental feature */1510#define PNG_FILTER_HEURISTIC_LAST 3 /* Not a valid value */15111512/* Set the library compression level. Currently, valid values range from1513* 0 - 9, corresponding directly to the zlib compression levels 0 - 91514* (0 - no compression, 9 - "maximal" compression). Note that tests have1515* shown that zlib compression levels 3-6 usually perform as well as level 91516* for PNG images, and do considerably fewer calculations. In the future,1517* these values may not correspond directly to the zlib compression levels.1518*/1519#ifdef PNG_WRITE_CUSTOMIZE_COMPRESSION_SUPPORTED1520PNG_EXPORT(69, void, png_set_compression_level, (png_structrp png_ptr,1521int level));15221523PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structrp png_ptr,1524int mem_level));15251526PNG_EXPORT(71, void, png_set_compression_strategy, (png_structrp png_ptr,1527int strategy));15281529/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a1530* smaller value of window_bits if it can do so safely.1531*/1532PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structrp png_ptr,1533int window_bits));15341535PNG_EXPORT(73, void, png_set_compression_method, (png_structrp png_ptr,1536int method));1537#endif /* WRITE_CUSTOMIZE_COMPRESSION */15381539#ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED1540/* Also set zlib parameters for compressing non-IDAT chunks */1541PNG_EXPORT(222, void, png_set_text_compression_level, (png_structrp png_ptr,1542int level));15431544PNG_EXPORT(223, void, png_set_text_compression_mem_level, (png_structrp png_ptr,1545int mem_level));15461547PNG_EXPORT(224, void, png_set_text_compression_strategy, (png_structrp png_ptr,1548int strategy));15491550/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a1551* smaller value of window_bits if it can do so safely.1552*/1553PNG_EXPORT(225, void, png_set_text_compression_window_bits,1554(png_structrp png_ptr, int window_bits));15551556PNG_EXPORT(226, void, png_set_text_compression_method, (png_structrp png_ptr,1557int method));1558#endif /* WRITE_CUSTOMIZE_ZTXT_COMPRESSION */1559#endif /* WRITE */15601561/* These next functions are called for input/output, memory, and error1562* handling. They are in the file pngrio.c, pngwio.c, and pngerror.c,1563* and call standard C I/O routines such as fread(), fwrite(), and1564* fprintf(). These functions can be made to use other I/O routines1565* at run time for those applications that need to handle I/O in a1566* different manner by calling png_set_???_fn(). See libpng-manual.txt for1567* more information.1568*/15691570#ifdef PNG_STDIO_SUPPORTED1571/* Initialize the input/output for the PNG file to the default functions. */1572PNG_EXPORT(74, void, png_init_io, (png_structrp png_ptr, FILE *fp));1573#endif15741575/* Replace the (error and abort), and warning functions with user1576* supplied functions. If no messages are to be printed you must still1577* write and use replacement functions. The replacement error_fn should1578* still do a longjmp to the last setjmp location if you are using this1579* method of error handling. If error_fn or warning_fn is NULL, the1580* default function will be used.1581*/15821583PNG_EXPORT(75, void, png_set_error_fn, (png_structrp png_ptr,1584png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warning_fn));15851586/* Return the user pointer associated with the error functions */1587PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structrp png_ptr));15881589/* Replace the default data output functions with a user supplied one(s).1590* If buffered output is not used, then output_flush_fn can be set to NULL.1591* If PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile time1592* output_flush_fn will be ignored (and thus can be NULL).1593* It is probably a mistake to use NULL for output_flush_fn if1594* write_data_fn is not also NULL unless you have built libpng with1595* PNG_WRITE_FLUSH_SUPPORTED undefined, because in this case libpng's1596* default flush function, which uses the standard *FILE structure, will1597* be used.1598*/1599PNG_EXPORT(77, void, png_set_write_fn, (png_structrp png_ptr, png_voidp io_ptr,1600png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn));16011602/* Replace the default data input function with a user supplied one. */1603PNG_EXPORT(78, void, png_set_read_fn, (png_structrp png_ptr, png_voidp io_ptr,1604png_rw_ptr read_data_fn));16051606/* Return the user pointer associated with the I/O functions */1607PNG_EXPORT(79, png_voidp, png_get_io_ptr, (png_const_structrp png_ptr));16081609PNG_EXPORT(80, void, png_set_read_status_fn, (png_structrp png_ptr,1610png_read_status_ptr read_row_fn));16111612PNG_EXPORT(81, void, png_set_write_status_fn, (png_structrp png_ptr,1613png_write_status_ptr write_row_fn));16141615#ifdef PNG_USER_MEM_SUPPORTED1616/* Replace the default memory allocation functions with user supplied one(s). */1617PNG_EXPORT(82, void, png_set_mem_fn, (png_structrp png_ptr, png_voidp mem_ptr,1618png_malloc_ptr malloc_fn, png_free_ptr free_fn));1619/* Return the user pointer associated with the memory functions */1620PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structrp png_ptr));1621#endif16221623#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED1624PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structrp png_ptr,1625png_user_transform_ptr read_user_transform_fn));1626#endif16271628#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED1629PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structrp png_ptr,1630png_user_transform_ptr write_user_transform_fn));1631#endif16321633#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED1634PNG_EXPORT(86, void, png_set_user_transform_info, (png_structrp png_ptr,1635png_voidp user_transform_ptr, int user_transform_depth,1636int user_transform_channels));1637/* Return the user pointer associated with the user transform functions */1638PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr,1639(png_const_structrp png_ptr));1640#endif16411642#ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED1643/* Return information about the row currently being processed. Note that these1644* APIs do not fail but will return unexpected results if called outside a user1645* transform callback. Also note that when transforming an interlaced image the1646* row number is the row number within the sub-image of the interlace pass, so1647* the value will increase to the height of the sub-image (not the full image)1648* then reset to 0 for the next pass.1649*1650* Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to1651* find the output pixel (x,y) given an interlaced sub-image pixel1652* (row,col,pass). (See below for these macros.)1653*/1654PNG_EXPORT(217, png_uint_32, png_get_current_row_number, (png_const_structrp));1655PNG_EXPORT(218, png_byte, png_get_current_pass_number, (png_const_structrp));1656#endif16571658#ifdef PNG_READ_USER_CHUNKS_SUPPORTED1659/* This callback is called only for *unknown* chunks. If1660* PNG_HANDLE_AS_UNKNOWN_SUPPORTED is set then it is possible to set known1661* chunks to be treated as unknown, however in this case the callback must do1662* any processing required by the chunk (e.g. by calling the appropriate1663* png_set_ APIs.)1664*1665* There is no write support - on write, by default, all the chunks in the1666* 'unknown' list are written in the specified position.1667*1668* The integer return from the callback function is interpreted thus:1669*1670* negative: An error occurred; png_chunk_error will be called.1671* zero: The chunk was not handled, the chunk will be saved. A critical1672* chunk will cause an error at this point unless it is to be saved.1673* positive: The chunk was handled, libpng will ignore/discard it.1674*1675* See "INTERACTION WITH USER CHUNK CALLBACKS" below for important notes about1676* how this behavior will change in libpng 1.71677*/1678PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structrp png_ptr,1679png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn));1680#endif16811682#ifdef PNG_USER_CHUNKS_SUPPORTED1683PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structrp png_ptr));1684#endif16851686#ifdef PNG_PROGRESSIVE_READ_SUPPORTED1687/* Sets the function callbacks for the push reader, and a pointer to a1688* user-defined structure available to the callback functions.1689*/1690PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structrp png_ptr,1691png_voidp progressive_ptr, png_progressive_info_ptr info_fn,1692png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn));16931694/* Returns the user pointer associated with the push read functions */1695PNG_EXPORT(91, png_voidp, png_get_progressive_ptr,1696(png_const_structrp png_ptr));16971698/* Function to be called when data becomes available */1699PNG_EXPORT(92, void, png_process_data, (png_structrp png_ptr,1700png_inforp info_ptr, png_bytep buffer, size_t buffer_size));17011702/* A function which may be called *only* within png_process_data to stop the1703* processing of any more data. The function returns the number of bytes1704* remaining, excluding any that libpng has cached internally. A subsequent1705* call to png_process_data must supply these bytes again. If the argument1706* 'save' is set to true the routine will first save all the pending data and1707* will always return 0.1708*/1709PNG_EXPORT(219, size_t, png_process_data_pause, (png_structrp, int save));17101711/* A function which may be called *only* outside (after) a call to1712* png_process_data. It returns the number of bytes of data to skip in the1713* input. Normally it will return 0, but if it returns a non-zero value the1714* application must skip than number of bytes of input data and pass the1715* following data to the next call to png_process_data.1716*/1717PNG_EXPORT(220, png_uint_32, png_process_data_skip, (png_structrp));17181719/* Function that combines rows. 'new_row' is a flag that should come from1720* the callback and be non-NULL if anything needs to be done; the library1721* stores its own version of the new data internally and ignores the passed1722* in value.1723*/1724PNG_EXPORT(93, void, png_progressive_combine_row, (png_const_structrp png_ptr,1725png_bytep old_row, png_const_bytep new_row));1726#endif /* PROGRESSIVE_READ */17271728PNG_EXPORTA(94, png_voidp, png_malloc, (png_const_structrp png_ptr,1729png_alloc_size_t size), PNG_ALLOCATED);1730/* Added at libpng version 1.4.0 */1731PNG_EXPORTA(95, png_voidp, png_calloc, (png_const_structrp png_ptr,1732png_alloc_size_t size), PNG_ALLOCATED);17331734/* Added at libpng version 1.2.4 */1735PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_const_structrp png_ptr,1736png_alloc_size_t size), PNG_ALLOCATED);17371738/* Frees a pointer allocated by png_malloc() */1739PNG_EXPORT(97, void, png_free, (png_const_structrp png_ptr, png_voidp ptr));17401741/* Free data that was allocated internally */1742PNG_EXPORT(98, void, png_free_data, (png_const_structrp png_ptr,1743png_inforp info_ptr, png_uint_32 free_me, int num));17441745/* Reassign the responsibility for freeing existing data, whether allocated1746* by libpng or by the application; this works on the png_info structure passed1747* in, without changing the state for other png_info structures.1748*/1749PNG_EXPORT(99, void, png_data_freer, (png_const_structrp png_ptr,1750png_inforp info_ptr, int freer, png_uint_32 mask));17511752/* Assignments for png_data_freer */1753#define PNG_DESTROY_WILL_FREE_DATA 11754#define PNG_SET_WILL_FREE_DATA 11755#define PNG_USER_WILL_FREE_DATA 21756/* Flags for png_ptr->free_me and info_ptr->free_me */1757#define PNG_FREE_HIST 0x0008U1758#define PNG_FREE_ICCP 0x0010U1759#define PNG_FREE_SPLT 0x0020U1760#define PNG_FREE_ROWS 0x0040U1761#define PNG_FREE_PCAL 0x0080U1762#define PNG_FREE_SCAL 0x0100U1763#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED1764# define PNG_FREE_UNKN 0x0200U1765#endif1766/* PNG_FREE_LIST 0x0400U removed in 1.6.0 because it is ignored */1767#define PNG_FREE_PLTE 0x1000U1768#define PNG_FREE_TRNS 0x2000U1769#define PNG_FREE_TEXT 0x4000U1770#define PNG_FREE_EXIF 0x8000U /* Added at libpng-1.6.31 */1771#define PNG_FREE_ALL 0xffffU1772#define PNG_FREE_MUL 0x4220U /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */17731774#ifdef PNG_USER_MEM_SUPPORTED1775PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_const_structrp png_ptr,1776png_alloc_size_t size), PNG_ALLOCATED PNG_DEPRECATED);1777PNG_EXPORTA(101, void, png_free_default, (png_const_structrp png_ptr,1778png_voidp ptr), PNG_DEPRECATED);1779#endif17801781#ifdef PNG_ERROR_TEXT_SUPPORTED1782/* Fatal error in PNG image of libpng - can't continue */1783PNG_EXPORTA(102, void, png_error, (png_const_structrp png_ptr,1784png_const_charp error_message), PNG_NORETURN);17851786/* The same, but the chunk name is prepended to the error string. */1787PNG_EXPORTA(103, void, png_chunk_error, (png_const_structrp png_ptr,1788png_const_charp error_message), PNG_NORETURN);17891790#else1791/* Fatal error in PNG image of libpng - can't continue */1792PNG_EXPORTA(104, void, png_err, (png_const_structrp png_ptr), PNG_NORETURN);1793# define png_error(s1,s2) png_err(s1)1794# define png_chunk_error(s1,s2) png_err(s1)1795#endif17961797#ifdef PNG_WARNINGS_SUPPORTED1798/* Non-fatal error in libpng. Can continue, but may have a problem. */1799PNG_EXPORT(105, void, png_warning, (png_const_structrp png_ptr,1800png_const_charp warning_message));18011802/* Non-fatal error in libpng, chunk name is prepended to message. */1803PNG_EXPORT(106, void, png_chunk_warning, (png_const_structrp png_ptr,1804png_const_charp warning_message));1805#else1806# define png_warning(s1,s2) ((void)(s1))1807# define png_chunk_warning(s1,s2) ((void)(s1))1808#endif18091810#ifdef PNG_BENIGN_ERRORS_SUPPORTED1811/* Benign error in libpng. Can continue, but may have a problem.1812* User can choose whether to handle as a fatal error or as a warning. */1813PNG_EXPORT(107, void, png_benign_error, (png_const_structrp png_ptr,1814png_const_charp warning_message));18151816#ifdef PNG_READ_SUPPORTED1817/* Same, chunk name is prepended to message (only during read) */1818PNG_EXPORT(108, void, png_chunk_benign_error, (png_const_structrp png_ptr,1819png_const_charp warning_message));1820#endif18211822PNG_EXPORT(109, void, png_set_benign_errors,1823(png_structrp png_ptr, int allowed));1824#else1825# ifdef PNG_ALLOW_BENIGN_ERRORS1826# define png_benign_error png_warning1827# define png_chunk_benign_error png_chunk_warning1828# else1829# define png_benign_error png_error1830# define png_chunk_benign_error png_chunk_error1831# endif1832#endif18331834/* The png_set_<chunk> functions are for storing values in the png_info_struct.1835* Similarly, the png_get_<chunk> calls are used to read values from the1836* png_info_struct, either storing the parameters in the passed variables, or1837* setting pointers into the png_info_struct where the data is stored. The1838* png_get_<chunk> functions return a non-zero value if the data was available1839* in info_ptr, or return zero and do not change any of the parameters if the1840* data was not available.1841*1842* These functions should be used instead of directly accessing png_info1843* to avoid problems with future changes in the size and internal layout of1844* png_info_struct.1845*/1846/* Returns "flag" if chunk data is valid in info_ptr. */1847PNG_EXPORT(110, png_uint_32, png_get_valid, (png_const_structrp png_ptr,1848png_const_inforp info_ptr, png_uint_32 flag));18491850/* Returns number of bytes needed to hold a transformed row. */1851PNG_EXPORT(111, size_t, png_get_rowbytes, (png_const_structrp png_ptr,1852png_const_inforp info_ptr));18531854#ifdef PNG_INFO_IMAGE_SUPPORTED1855/* Returns row_pointers, which is an array of pointers to scanlines that was1856* returned from png_read_png().1857*/1858PNG_EXPORT(112, png_bytepp, png_get_rows, (png_const_structrp png_ptr,1859png_const_inforp info_ptr));18601861/* Set row_pointers, which is an array of pointers to scanlines for use1862* by png_write_png().1863*/1864PNG_EXPORT(113, void, png_set_rows, (png_const_structrp png_ptr,1865png_inforp info_ptr, png_bytepp row_pointers));1866#endif18671868/* Returns number of color channels in image. */1869PNG_EXPORT(114, png_byte, png_get_channels, (png_const_structrp png_ptr,1870png_const_inforp info_ptr));18711872#ifdef PNG_EASY_ACCESS_SUPPORTED1873/* Returns image width in pixels. */1874PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structrp png_ptr,1875png_const_inforp info_ptr));18761877/* Returns image height in pixels. */1878PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structrp png_ptr,1879png_const_inforp info_ptr));18801881/* Returns image bit_depth. */1882PNG_EXPORT(117, png_byte, png_get_bit_depth, (png_const_structrp png_ptr,1883png_const_inforp info_ptr));18841885/* Returns image color_type. */1886PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structrp png_ptr,1887png_const_inforp info_ptr));18881889/* Returns image filter_type. */1890PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structrp png_ptr,1891png_const_inforp info_ptr));18921893/* Returns image interlace_type. */1894PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structrp png_ptr,1895png_const_inforp info_ptr));18961897/* Returns image compression_type. */1898PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structrp png_ptr,1899png_const_inforp info_ptr));19001901/* Returns image resolution in pixels per meter, from pHYs chunk data. */1902PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter,1903(png_const_structrp png_ptr, png_const_inforp info_ptr));1904PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter,1905(png_const_structrp png_ptr, png_const_inforp info_ptr));1906PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter,1907(png_const_structrp png_ptr, png_const_inforp info_ptr));19081909/* Returns pixel aspect ratio, computed from pHYs chunk data. */1910PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio,1911(png_const_structrp png_ptr, png_const_inforp info_ptr))1912PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed,1913(png_const_structrp png_ptr, png_const_inforp info_ptr))19141915/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */1916PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels,1917(png_const_structrp png_ptr, png_const_inforp info_ptr));1918PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels,1919(png_const_structrp png_ptr, png_const_inforp info_ptr));1920PNG_EXPORT(128, png_int_32, png_get_x_offset_microns,1921(png_const_structrp png_ptr, png_const_inforp info_ptr));1922PNG_EXPORT(129, png_int_32, png_get_y_offset_microns,1923(png_const_structrp png_ptr, png_const_inforp info_ptr));19241925#endif /* EASY_ACCESS */19261927#ifdef PNG_READ_SUPPORTED1928/* Returns pointer to signature string read from PNG header */1929PNG_EXPORT(130, png_const_bytep, png_get_signature, (png_const_structrp png_ptr,1930png_const_inforp info_ptr));1931#endif19321933#ifdef PNG_bKGD_SUPPORTED1934PNG_EXPORT(131, png_uint_32, png_get_bKGD, (png_const_structrp png_ptr,1935png_inforp info_ptr, png_color_16p *background));1936#endif19371938#ifdef PNG_bKGD_SUPPORTED1939PNG_EXPORT(132, void, png_set_bKGD, (png_const_structrp png_ptr,1940png_inforp info_ptr, png_const_color_16p background));1941#endif19421943#ifdef PNG_cHRM_SUPPORTED1944PNG_FP_EXPORT(133, png_uint_32, png_get_cHRM, (png_const_structrp png_ptr,1945png_const_inforp info_ptr, double *white_x, double *white_y, double *red_x,1946double *red_y, double *green_x, double *green_y, double *blue_x,1947double *blue_y))1948PNG_FP_EXPORT(230, png_uint_32, png_get_cHRM_XYZ, (png_const_structrp png_ptr,1949png_const_inforp info_ptr, double *red_X, double *red_Y, double *red_Z,1950double *green_X, double *green_Y, double *green_Z, double *blue_X,1951double *blue_Y, double *blue_Z))1952PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed,1953(png_const_structrp png_ptr, png_const_inforp info_ptr,1954png_fixed_point *int_white_x, png_fixed_point *int_white_y,1955png_fixed_point *int_red_x, png_fixed_point *int_red_y,1956png_fixed_point *int_green_x, png_fixed_point *int_green_y,1957png_fixed_point *int_blue_x, png_fixed_point *int_blue_y))1958PNG_FIXED_EXPORT(231, png_uint_32, png_get_cHRM_XYZ_fixed,1959(png_const_structrp png_ptr, png_const_inforp info_ptr,1960png_fixed_point *int_red_X, png_fixed_point *int_red_Y,1961png_fixed_point *int_red_Z, png_fixed_point *int_green_X,1962png_fixed_point *int_green_Y, png_fixed_point *int_green_Z,1963png_fixed_point *int_blue_X, png_fixed_point *int_blue_Y,1964png_fixed_point *int_blue_Z))1965#endif19661967#ifdef PNG_cHRM_SUPPORTED1968PNG_FP_EXPORT(135, void, png_set_cHRM, (png_const_structrp png_ptr,1969png_inforp info_ptr,1970double white_x, double white_y, double red_x, double red_y, double green_x,1971double green_y, double blue_x, double blue_y))1972PNG_FP_EXPORT(232, void, png_set_cHRM_XYZ, (png_const_structrp png_ptr,1973png_inforp info_ptr, double red_X, double red_Y, double red_Z,1974double green_X, double green_Y, double green_Z, double blue_X,1975double blue_Y, double blue_Z))1976PNG_FIXED_EXPORT(136, void, png_set_cHRM_fixed, (png_const_structrp png_ptr,1977png_inforp info_ptr, png_fixed_point int_white_x,1978png_fixed_point int_white_y, png_fixed_point int_red_x,1979png_fixed_point int_red_y, png_fixed_point int_green_x,1980png_fixed_point int_green_y, png_fixed_point int_blue_x,1981png_fixed_point int_blue_y))1982PNG_FIXED_EXPORT(233, void, png_set_cHRM_XYZ_fixed, (png_const_structrp png_ptr,1983png_inforp info_ptr, png_fixed_point int_red_X, png_fixed_point int_red_Y,1984png_fixed_point int_red_Z, png_fixed_point int_green_X,1985png_fixed_point int_green_Y, png_fixed_point int_green_Z,1986png_fixed_point int_blue_X, png_fixed_point int_blue_Y,1987png_fixed_point int_blue_Z))1988#endif19891990#ifdef PNG_cICP_SUPPORTED1991PNG_EXPORT(250, png_uint_32, png_get_cICP, (png_const_structrp png_ptr,1992png_const_inforp info_ptr, png_bytep colour_primaries,1993png_bytep transfer_function, png_bytep matrix_coefficients,1994png_bytep video_full_range_flag));1995#endif19961997#ifdef PNG_cICP_SUPPORTED1998PNG_EXPORT(251, void, png_set_cICP, (png_const_structrp png_ptr,1999png_inforp info_ptr, png_byte colour_primaries,2000png_byte transfer_function, png_byte matrix_coefficients,2001png_byte video_full_range_flag));2002#endif20032004#ifdef PNG_cLLI_SUPPORTED2005PNG_FP_EXPORT(252, png_uint_32, png_get_cLLI, (png_const_structrp png_ptr,2006png_const_inforp info_ptr, double *maximum_content_light_level,2007double *maximum_frame_average_light_level))2008PNG_FIXED_EXPORT(253, png_uint_32, png_get_cLLI_fixed,2009(png_const_structrp png_ptr, png_const_inforp info_ptr,2010/* The values below are in cd/m2 (nits) and are scaled by 10,000; not2011* 100,000 as in the case of png_fixed_point.2012*/2013png_uint_32p maximum_content_light_level_scaled_by_10000,2014png_uint_32p maximum_frame_average_light_level_scaled_by_10000))2015#endif20162017#ifdef PNG_cLLI_SUPPORTED2018PNG_FP_EXPORT(254, void, png_set_cLLI, (png_const_structrp png_ptr,2019png_inforp info_ptr, double maximum_content_light_level,2020double maximum_frame_average_light_level))2021PNG_FIXED_EXPORT(255, void, png_set_cLLI_fixed, (png_const_structrp png_ptr,2022png_inforp info_ptr,2023/* The values below are in cd/m2 (nits) and are scaled by 10,000; not2024* 100,000 as in the case of png_fixed_point.2025*/2026png_uint_32 maximum_content_light_level_scaled_by_10000,2027png_uint_32 maximum_frame_average_light_level_scaled_by_10000))2028#endif20292030#ifdef PNG_eXIf_SUPPORTED2031PNG_EXPORT(246, png_uint_32, png_get_eXIf, (png_const_structrp png_ptr,2032png_inforp info_ptr, png_bytep *exif));2033PNG_EXPORT(247, void, png_set_eXIf, (png_const_structrp png_ptr,2034png_inforp info_ptr, png_bytep exif));20352036PNG_EXPORT(248, png_uint_32, png_get_eXIf_1, (png_const_structrp png_ptr,2037png_const_inforp info_ptr, png_uint_32 *num_exif, png_bytep *exif));2038PNG_EXPORT(249, void, png_set_eXIf_1, (png_const_structrp png_ptr,2039png_inforp info_ptr, png_uint_32 num_exif, png_bytep exif));2040#endif20412042#ifdef PNG_gAMA_SUPPORTED2043PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA, (png_const_structrp png_ptr,2044png_const_inforp info_ptr, double *file_gamma))2045PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed,2046(png_const_structrp png_ptr, png_const_inforp info_ptr,2047png_fixed_point *int_file_gamma))2048#endif20492050#ifdef PNG_gAMA_SUPPORTED2051PNG_FP_EXPORT(139, void, png_set_gAMA, (png_const_structrp png_ptr,2052png_inforp info_ptr, double file_gamma))2053PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_const_structrp png_ptr,2054png_inforp info_ptr, png_fixed_point int_file_gamma))2055#endif20562057#ifdef PNG_hIST_SUPPORTED2058PNG_EXPORT(141, png_uint_32, png_get_hIST, (png_const_structrp png_ptr,2059png_inforp info_ptr, png_uint_16p *hist));2060PNG_EXPORT(142, void, png_set_hIST, (png_const_structrp png_ptr,2061png_inforp info_ptr, png_const_uint_16p hist));2062#endif20632064PNG_EXPORT(143, png_uint_32, png_get_IHDR, (png_const_structrp png_ptr,2065png_const_inforp info_ptr, png_uint_32 *width, png_uint_32 *height,2066int *bit_depth, int *color_type, int *interlace_method,2067int *compression_method, int *filter_method));20682069PNG_EXPORT(144, void, png_set_IHDR, (png_const_structrp png_ptr,2070png_inforp info_ptr, png_uint_32 width, png_uint_32 height, int bit_depth,2071int color_type, int interlace_method, int compression_method,2072int filter_method));20732074#ifdef PNG_mDCV_SUPPORTED2075PNG_FP_EXPORT(256, png_uint_32, png_get_mDCV, (png_const_structrp png_ptr,2076png_const_inforp info_ptr,2077/* The chromaticities of the mastering display. As cHRM, but independent of2078* the encoding endpoints in cHRM, or cICP, or iCCP. These values will2079* always be in the range 0 to 1.3107.2080*/2081double *white_x, double *white_y, double *red_x, double *red_y,2082double *green_x, double *green_y, double *blue_x, double *blue_y,2083/* Mastering display luminance in cd/m2 (nits). */2084double *mastering_display_maximum_luminance,2085double *mastering_display_minimum_luminance))20862087PNG_FIXED_EXPORT(257, png_uint_32, png_get_mDCV_fixed,2088(png_const_structrp png_ptr, png_const_inforp info_ptr,2089png_fixed_point *int_white_x, png_fixed_point *int_white_y,2090png_fixed_point *int_red_x, png_fixed_point *int_red_y,2091png_fixed_point *int_green_x, png_fixed_point *int_green_y,2092png_fixed_point *int_blue_x, png_fixed_point *int_blue_y,2093/* Mastering display luminance in cd/m2 (nits) multiplied (scaled) by2094* 10,000.2095*/2096png_uint_32p mastering_display_maximum_luminance_scaled_by_10000,2097png_uint_32p mastering_display_minimum_luminance_scaled_by_10000))2098#endif20992100#ifdef PNG_mDCV_SUPPORTED2101PNG_FP_EXPORT(258, void, png_set_mDCV, (png_const_structrp png_ptr,2102png_inforp info_ptr,2103/* The chromaticities of the mastering display. As cHRM, but independent of2104* the encoding endpoints in cHRM, or cICP, or iCCP.2105*/2106double white_x, double white_y, double red_x, double red_y, double green_x,2107double green_y, double blue_x, double blue_y,2108/* Mastering display luminance in cd/m2 (nits). */2109double mastering_display_maximum_luminance,2110double mastering_display_minimum_luminance))21112112PNG_FIXED_EXPORT(259, void, png_set_mDCV_fixed, (png_const_structrp png_ptr,2113png_inforp info_ptr,2114/* The admissible range of these values is not the full range of a PNG2115* fixed point value. Negative values cannot be encoded and the maximum2116* value is about 1.3 */2117png_fixed_point int_white_x, png_fixed_point int_white_y,2118png_fixed_point int_red_x, png_fixed_point int_red_y,2119png_fixed_point int_green_x, png_fixed_point int_green_y,2120png_fixed_point int_blue_x, png_fixed_point int_blue_y,2121/* These are PNG unsigned 4 byte values: 31-bit unsigned values. The MSB2122* must be zero.2123*/2124png_uint_32 mastering_display_maximum_luminance_scaled_by_10000,2125png_uint_32 mastering_display_minimum_luminance_scaled_by_10000))2126#endif21272128#ifdef PNG_oFFs_SUPPORTED2129PNG_EXPORT(145, png_uint_32, png_get_oFFs, (png_const_structrp png_ptr,2130png_const_inforp info_ptr, png_int_32 *offset_x, png_int_32 *offset_y,2131int *unit_type));2132#endif21332134#ifdef PNG_oFFs_SUPPORTED2135PNG_EXPORT(146, void, png_set_oFFs, (png_const_structrp png_ptr,2136png_inforp info_ptr, png_int_32 offset_x, png_int_32 offset_y,2137int unit_type));2138#endif21392140#ifdef PNG_pCAL_SUPPORTED2141PNG_EXPORT(147, png_uint_32, png_get_pCAL, (png_const_structrp png_ptr,2142png_inforp info_ptr, png_charp *purpose, png_int_32 *X0,2143png_int_32 *X1, int *type, int *nparams, png_charp *units,2144png_charpp *params));2145#endif21462147#ifdef PNG_pCAL_SUPPORTED2148PNG_EXPORT(148, void, png_set_pCAL, (png_const_structrp png_ptr,2149png_inforp info_ptr, png_const_charp purpose, png_int_32 X0, png_int_32 X1,2150int type, int nparams, png_const_charp units, png_charpp params));2151#endif21522153#ifdef PNG_pHYs_SUPPORTED2154PNG_EXPORT(149, png_uint_32, png_get_pHYs, (png_const_structrp png_ptr,2155png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,2156int *unit_type));2157#endif21582159#ifdef PNG_pHYs_SUPPORTED2160PNG_EXPORT(150, void, png_set_pHYs, (png_const_structrp png_ptr,2161png_inforp info_ptr, png_uint_32 res_x, png_uint_32 res_y, int unit_type));2162#endif21632164PNG_EXPORT(151, png_uint_32, png_get_PLTE, (png_const_structrp png_ptr,2165png_inforp info_ptr, png_colorp *palette, int *num_palette));21662167PNG_EXPORT(152, void, png_set_PLTE, (png_structrp png_ptr,2168png_inforp info_ptr, png_const_colorp palette, int num_palette));21692170#ifdef PNG_sBIT_SUPPORTED2171PNG_EXPORT(153, png_uint_32, png_get_sBIT, (png_const_structrp png_ptr,2172png_inforp info_ptr, png_color_8p *sig_bit));2173#endif21742175#ifdef PNG_sBIT_SUPPORTED2176PNG_EXPORT(154, void, png_set_sBIT, (png_const_structrp png_ptr,2177png_inforp info_ptr, png_const_color_8p sig_bit));2178#endif21792180#ifdef PNG_sRGB_SUPPORTED2181PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structrp png_ptr,2182png_const_inforp info_ptr, int *file_srgb_intent));2183#endif21842185#ifdef PNG_sRGB_SUPPORTED2186PNG_EXPORT(156, void, png_set_sRGB, (png_const_structrp png_ptr,2187png_inforp info_ptr, int srgb_intent));2188PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_const_structrp png_ptr,2189png_inforp info_ptr, int srgb_intent));2190#endif21912192#ifdef PNG_iCCP_SUPPORTED2193PNG_EXPORT(158, png_uint_32, png_get_iCCP, (png_const_structrp png_ptr,2194png_inforp info_ptr, png_charpp name, int *compression_type,2195png_bytepp profile, png_uint_32 *proflen));2196#endif21972198#ifdef PNG_iCCP_SUPPORTED2199PNG_EXPORT(159, void, png_set_iCCP, (png_const_structrp png_ptr,2200png_inforp info_ptr, png_const_charp name, int compression_type,2201png_const_bytep profile, png_uint_32 proflen));2202#endif22032204#ifdef PNG_sPLT_SUPPORTED2205PNG_EXPORT(160, int, png_get_sPLT, (png_const_structrp png_ptr,2206png_inforp info_ptr, png_sPLT_tpp entries));2207#endif22082209#ifdef PNG_sPLT_SUPPORTED2210PNG_EXPORT(161, void, png_set_sPLT, (png_const_structrp png_ptr,2211png_inforp info_ptr, png_const_sPLT_tp entries, int nentries));2212#endif22132214#ifdef PNG_TEXT_SUPPORTED2215/* png_get_text also returns the number of text chunks in *num_text */2216PNG_EXPORT(162, int, png_get_text, (png_const_structrp png_ptr,2217png_inforp info_ptr, png_textp *text_ptr, int *num_text));2218#endif22192220/* Note while png_set_text() will accept a structure whose text,2221* language, and translated keywords are NULL pointers, the structure2222* returned by png_get_text will always contain regular2223* zero-terminated C strings. They might be empty strings but2224* they will never be NULL pointers.2225*/22262227#ifdef PNG_TEXT_SUPPORTED2228PNG_EXPORT(163, void, png_set_text, (png_const_structrp png_ptr,2229png_inforp info_ptr, png_const_textp text_ptr, int num_text));2230#endif22312232#ifdef PNG_tIME_SUPPORTED2233PNG_EXPORT(164, png_uint_32, png_get_tIME, (png_const_structrp png_ptr,2234png_inforp info_ptr, png_timep *mod_time));2235#endif22362237#ifdef PNG_tIME_SUPPORTED2238PNG_EXPORT(165, void, png_set_tIME, (png_const_structrp png_ptr,2239png_inforp info_ptr, png_const_timep mod_time));2240#endif22412242#ifdef PNG_tRNS_SUPPORTED2243PNG_EXPORT(166, png_uint_32, png_get_tRNS, (png_const_structrp png_ptr,2244png_inforp info_ptr, png_bytep *trans_alpha, int *num_trans,2245png_color_16p *trans_color));2246#endif22472248#ifdef PNG_tRNS_SUPPORTED2249PNG_EXPORT(167, void, png_set_tRNS, (png_structrp png_ptr,2250png_inforp info_ptr, png_const_bytep trans_alpha, int num_trans,2251png_const_color_16p trans_color));2252#endif22532254#ifdef PNG_sCAL_SUPPORTED2255PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL, (png_const_structrp png_ptr,2256png_const_inforp info_ptr, int *unit, double *width, double *height))2257#if defined(PNG_FLOATING_ARITHMETIC_SUPPORTED) || \2258defined(PNG_FLOATING_POINT_SUPPORTED)2259/* NOTE: this API is currently implemented using floating point arithmetic,2260* consequently it can only be used on systems with floating point support.2261* In any case the range of values supported by png_fixed_point is small and it2262* is highly recommended that png_get_sCAL_s be used instead.2263*/2264PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed,2265(png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,2266png_fixed_point *width, png_fixed_point *height))2267#endif2268PNG_EXPORT(169, png_uint_32, png_get_sCAL_s,2269(png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,2270png_charpp swidth, png_charpp sheight));22712272PNG_FP_EXPORT(170, void, png_set_sCAL, (png_const_structrp png_ptr,2273png_inforp info_ptr, int unit, double width, double height))2274PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_const_structrp png_ptr,2275png_inforp info_ptr, int unit, png_fixed_point width,2276png_fixed_point height))2277PNG_EXPORT(171, void, png_set_sCAL_s, (png_const_structrp png_ptr,2278png_inforp info_ptr, int unit,2279png_const_charp swidth, png_const_charp sheight));2280#endif /* sCAL */22812282#ifdef PNG_SET_UNKNOWN_CHUNKS_SUPPORTED2283/* Provide the default handling for all unknown chunks or, optionally, for2284* specific unknown chunks.2285*2286* NOTE: prior to 1.6.0 the handling specified for particular chunks on read was2287* ignored and the default was used, the per-chunk setting only had an effect on2288* write. If you wish to have chunk-specific handling on read in code that must2289* work on earlier versions you must use a user chunk callback to specify the2290* desired handling (keep or discard.)2291*2292* The 'keep' parameter is a PNG_HANDLE_CHUNK_ value as listed below. The2293* parameter is interpreted as follows:2294*2295* READ:2296* PNG_HANDLE_CHUNK_AS_DEFAULT:2297* Known chunks: do normal libpng processing, do not keep the chunk (but2298* see the comments below about PNG_HANDLE_AS_UNKNOWN_SUPPORTED)2299* Unknown chunks: for a specific chunk use the global default, when used2300* as the default discard the chunk data.2301* PNG_HANDLE_CHUNK_NEVER:2302* Discard the chunk data.2303* PNG_HANDLE_CHUNK_IF_SAFE:2304* Keep the chunk data if the chunk is not critical else raise a chunk2305* error.2306* PNG_HANDLE_CHUNK_ALWAYS:2307* Keep the chunk data.2308*2309* If the chunk data is saved it can be retrieved using png_get_unknown_chunks,2310* below. Notice that specifying "AS_DEFAULT" as a global default is equivalent2311* to specifying "NEVER", however when "AS_DEFAULT" is used for specific chunks2312* it simply resets the behavior to the libpng default.2313*2314* INTERACTION WITH USER CHUNK CALLBACKS:2315* The per-chunk handling is always used when there is a png_user_chunk_ptr2316* callback and the callback returns 0; the chunk is then always stored *unless*2317* it is critical and the per-chunk setting is other than ALWAYS. Notice that2318* the global default is *not* used in this case. (In effect the per-chunk2319* value is incremented to at least IF_SAFE.)2320*2321* IMPORTANT NOTE: this behavior will change in libpng 1.7 - the global and2322* per-chunk defaults will be honored. If you want to preserve the current2323* behavior when your callback returns 0 you must set PNG_HANDLE_CHUNK_IF_SAFE2324* as the default - if you don't do this libpng 1.6 will issue a warning.2325*2326* If you want unhandled unknown chunks to be discarded in libpng 1.6 and2327* earlier simply return '1' (handled).2328*2329* PNG_HANDLE_AS_UNKNOWN_SUPPORTED:2330* If this is *not* set known chunks will always be handled by libpng and2331* will never be stored in the unknown chunk list. Known chunks listed to2332* png_set_keep_unknown_chunks will have no effect. If it is set then known2333* chunks listed with a keep other than AS_DEFAULT will *never* be processed2334* by libpng, in addition critical chunks must either be processed by the2335* callback or saved.2336*2337* The IHDR and IEND chunks must not be listed. Because this turns off the2338* default handling for chunks that would otherwise be recognized the2339* behavior of libpng transformations may well become incorrect!2340*2341* WRITE:2342* When writing chunks the options only apply to the chunks specified by2343* png_set_unknown_chunks (below), libpng will *always* write known chunks2344* required by png_set_ calls and will always write the core critical chunks2345* (as required for PLTE).2346*2347* Each chunk in the png_set_unknown_chunks list is looked up in the2348* png_set_keep_unknown_chunks list to find the keep setting, this is then2349* interpreted as follows:2350*2351* PNG_HANDLE_CHUNK_AS_DEFAULT:2352* Write safe-to-copy chunks and write other chunks if the global2353* default is set to _ALWAYS, otherwise don't write this chunk.2354* PNG_HANDLE_CHUNK_NEVER:2355* Do not write the chunk.2356* PNG_HANDLE_CHUNK_IF_SAFE:2357* Write the chunk if it is safe-to-copy, otherwise do not write it.2358* PNG_HANDLE_CHUNK_ALWAYS:2359* Write the chunk.2360*2361* Note that the default behavior is effectively the opposite of the read case -2362* in read unknown chunks are not stored by default, in write they are written2363* by default. Also the behavior of PNG_HANDLE_CHUNK_IF_SAFE is very different2364* - on write the safe-to-copy bit is checked, on read the critical bit is2365* checked and on read if the chunk is critical an error will be raised.2366*2367* num_chunks:2368* ===========2369* If num_chunks is positive, then the "keep" parameter specifies the manner2370* for handling only those chunks appearing in the chunk_list array,2371* otherwise the chunk list array is ignored.2372*2373* If num_chunks is 0 the "keep" parameter specifies the default behavior for2374* unknown chunks, as described above.2375*2376* If num_chunks is negative, then the "keep" parameter specifies the manner2377* for handling all unknown chunks plus all chunks recognized by libpng2378* except for the IHDR, PLTE, tRNS, IDAT, and IEND chunks (which continue to2379* be processed by libpng.2380*/2381#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED2382PNG_EXPORT(172, void, png_set_keep_unknown_chunks, (png_structrp png_ptr,2383int keep, png_const_bytep chunk_list, int num_chunks));2384#endif /* HANDLE_AS_UNKNOWN */23852386/* The "keep" PNG_HANDLE_CHUNK_ parameter for the specified chunk is returned;2387* the result is therefore true (non-zero) if special handling is required,2388* false for the default handling.2389*/2390PNG_EXPORT(173, int, png_handle_as_unknown, (png_const_structrp png_ptr,2391png_const_bytep chunk_name));2392#endif /* SET_UNKNOWN_CHUNKS */23932394#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED2395PNG_EXPORT(174, void, png_set_unknown_chunks, (png_const_structrp png_ptr,2396png_inforp info_ptr, png_const_unknown_chunkp unknowns,2397int num_unknowns));2398/* NOTE: prior to 1.6.0 this routine set the 'location' field of the added2399* unknowns to the location currently stored in the png_struct. This is2400* invariably the wrong value on write. To fix this call the following API2401* for each chunk in the list with the correct location. If you know your2402* code won't be compiled on earlier versions you can rely on2403* png_set_unknown_chunks(write-ptr, png_get_unknown_chunks(read-ptr)) doing2404* the correct thing.2405*/24062407PNG_EXPORT(175, void, png_set_unknown_chunk_location,2408(png_const_structrp png_ptr, png_inforp info_ptr, int chunk, int location));24092410PNG_EXPORT(176, int, png_get_unknown_chunks, (png_const_structrp png_ptr,2411png_inforp info_ptr, png_unknown_chunkpp entries));2412#endif24132414/* Png_free_data() will turn off the "valid" flag for anything it frees.2415* If you need to turn it off for a chunk that your application has freed,2416* you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);2417*/2418PNG_EXPORT(177, void, png_set_invalid, (png_const_structrp png_ptr,2419png_inforp info_ptr, int mask));24202421#ifdef PNG_INFO_IMAGE_SUPPORTED2422/* The "params" pointer is currently not used and is for future expansion. */2423#ifdef PNG_SEQUENTIAL_READ_SUPPORTED2424PNG_EXPORT(178, void, png_read_png, (png_structrp png_ptr, png_inforp info_ptr,2425int transforms, png_voidp params));2426#endif2427#ifdef PNG_WRITE_SUPPORTED2428PNG_EXPORT(179, void, png_write_png, (png_structrp png_ptr, png_inforp info_ptr,2429int transforms, png_voidp params));2430#endif2431#endif24322433PNG_EXPORT(180, png_const_charp, png_get_copyright,2434(png_const_structrp png_ptr));2435PNG_EXPORT(181, png_const_charp, png_get_header_ver,2436(png_const_structrp png_ptr));2437PNG_EXPORT(182, png_const_charp, png_get_header_version,2438(png_const_structrp png_ptr));2439PNG_EXPORT(183, png_const_charp, png_get_libpng_ver,2440(png_const_structrp png_ptr));24412442#ifdef PNG_MNG_FEATURES_SUPPORTED2443PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structrp png_ptr,2444png_uint_32 mng_features_permitted));2445#endif24462447/* For use in png_set_keep_unknown, added to version 1.2.6 */2448#define PNG_HANDLE_CHUNK_AS_DEFAULT 02449#define PNG_HANDLE_CHUNK_NEVER 12450#define PNG_HANDLE_CHUNK_IF_SAFE 22451#define PNG_HANDLE_CHUNK_ALWAYS 32452#define PNG_HANDLE_CHUNK_LAST 424532454/* Strip the prepended error numbers ("#nnn ") from error and warning2455* messages before passing them to the error or warning handler.2456*/2457#ifdef PNG_ERROR_NUMBERS_SUPPORTED2458PNG_EXPORT(185, void, png_set_strip_error_numbers, (png_structrp png_ptr,2459png_uint_32 strip_mode));2460#endif24612462/* Added in libpng-1.2.6 */2463#ifdef PNG_SET_USER_LIMITS_SUPPORTED2464PNG_EXPORT(186, void, png_set_user_limits, (png_structrp png_ptr,2465png_uint_32 user_width_max, png_uint_32 user_height_max));2466PNG_EXPORT(187, png_uint_32, png_get_user_width_max,2467(png_const_structrp png_ptr));2468PNG_EXPORT(188, png_uint_32, png_get_user_height_max,2469(png_const_structrp png_ptr));2470/* Added in libpng-1.4.0 */2471PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structrp png_ptr,2472png_uint_32 user_chunk_cache_max));2473PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max,2474(png_const_structrp png_ptr));2475/* Added in libpng-1.4.1 */2476PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structrp png_ptr,2477png_alloc_size_t user_chunk_cache_max));2478PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max,2479(png_const_structrp png_ptr));2480#endif24812482#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)2483PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch,2484(png_const_structrp png_ptr, png_const_inforp info_ptr));24852486PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch,2487(png_const_structrp png_ptr, png_const_inforp info_ptr));24882489PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch,2490(png_const_structrp png_ptr, png_const_inforp info_ptr));24912492PNG_FP_EXPORT(196, float, png_get_x_offset_inches,2493(png_const_structrp png_ptr, png_const_inforp info_ptr))2494#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */2495PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed,2496(png_const_structrp png_ptr, png_const_inforp info_ptr))2497#endif24982499PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_const_structrp png_ptr,2500png_const_inforp info_ptr))2501#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */2502PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed,2503(png_const_structrp png_ptr, png_const_inforp info_ptr))2504#endif25052506# ifdef PNG_pHYs_SUPPORTED2507PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structrp png_ptr,2508png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,2509int *unit_type));2510# endif /* pHYs */2511#endif /* INCH_CONVERSIONS */25122513/* Added in libpng-1.4.0 */2514#ifdef PNG_IO_STATE_SUPPORTED2515PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_const_structrp png_ptr));25162517/* Removed from libpng 1.6; use png_get_io_chunk_type. */2518PNG_REMOVED(200, png_const_bytep, png_get_io_chunk_name, (png_structrp png_ptr),2519PNG_DEPRECATED)25202521PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type,2522(png_const_structrp png_ptr));25232524/* The flags returned by png_get_io_state() are the following: */2525# define PNG_IO_NONE 0x0000 /* no I/O at this moment */2526# define PNG_IO_READING 0x0001 /* currently reading */2527# define PNG_IO_WRITING 0x0002 /* currently writing */2528# define PNG_IO_SIGNATURE 0x0010 /* currently at the file signature */2529# define PNG_IO_CHUNK_HDR 0x0020 /* currently at the chunk header */2530# define PNG_IO_CHUNK_DATA 0x0040 /* currently at the chunk data */2531# define PNG_IO_CHUNK_CRC 0x0080 /* currently at the chunk crc */2532# define PNG_IO_MASK_OP 0x000f /* current operation: reading/writing */2533# define PNG_IO_MASK_LOC 0x00f0 /* current location: sig/hdr/data/crc */2534#endif /* IO_STATE */25352536/* Interlace support. The following macros are always defined so that if2537* libpng interlace handling is turned off the macros may be used to handle2538* interlaced images within the application.2539*/2540#define PNG_INTERLACE_ADAM7_PASSES 725412542/* Two macros to return the first row and first column of the original,2543* full, image which appears in a given pass. 'pass' is in the range 02544* to 6 and the result is in the range 0 to 7.2545*/2546#define PNG_PASS_START_ROW(pass) (((1&~(pass))<<(3-((pass)>>1)))&7)2547#define PNG_PASS_START_COL(pass) (((1& (pass))<<(3-(((pass)+1)>>1)))&7)25482549/* A macro to return the offset between pixels in the output row for a pair of2550* pixels in the input - effectively the inverse of the 'COL_SHIFT' macro that2551* follows. Note that ROW_OFFSET is the offset from one row to the next whereas2552* COL_OFFSET is from one column to the next, within a row.2553*/2554#define PNG_PASS_ROW_OFFSET(pass) ((pass)>2?(8>>(((pass)-1)>>1)):8)2555#define PNG_PASS_COL_OFFSET(pass) (1<<((7-(pass))>>1))25562557/* Two macros to help evaluate the number of rows or columns in each2558* pass. This is expressed as a shift - effectively log2 of the number or2559* rows or columns in each 8x8 tile of the original image.2560*/2561#define PNG_PASS_ROW_SHIFT(pass) ((pass)>2?(8-(pass))>>1:3)2562#define PNG_PASS_COL_SHIFT(pass) ((pass)>1?(7-(pass))>>1:3)25632564/* Hence two macros to determine the number of rows or columns in a given2565* pass of an image given its height or width. In fact these macros may2566* return non-zero even though the sub-image is empty, because the other2567* dimension may be empty for a small image.2568*/2569#define PNG_PASS_ROWS(height, pass) (((height)+(((1<<PNG_PASS_ROW_SHIFT(pass))\2570-1)-PNG_PASS_START_ROW(pass)))>>PNG_PASS_ROW_SHIFT(pass))2571#define PNG_PASS_COLS(width, pass) (((width)+(((1<<PNG_PASS_COL_SHIFT(pass))\2572-1)-PNG_PASS_START_COL(pass)))>>PNG_PASS_COL_SHIFT(pass))25732574/* For the reader row callbacks (both progressive and sequential) it is2575* necessary to find the row in the output image given a row in an interlaced2576* image, so two more macros:2577*/2578#define PNG_ROW_FROM_PASS_ROW(y_in, pass) \2579(((y_in)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass))2580#define PNG_COL_FROM_PASS_COL(x_in, pass) \2581(((x_in)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass))25822583/* Two macros which return a boolean (0 or 1) saying whether the given row2584* or column is in a particular pass. These use a common utility macro that2585* returns a mask for a given pass - the offset 'off' selects the row or2586* column version. The mask has the appropriate bit set for each column in2587* the tile.2588*/2589#define PNG_PASS_MASK(pass,off) ( \2590((0x110145AF>>(((7-(off))-(pass))<<2)) & 0xF) | \2591((0x01145AF0>>(((7-(off))-(pass))<<2)) & 0xF0))25922593#define PNG_ROW_IN_INTERLACE_PASS(y, pass) \2594((PNG_PASS_MASK(pass,0) >> ((y)&7)) & 1)2595#define PNG_COL_IN_INTERLACE_PASS(x, pass) \2596((PNG_PASS_MASK(pass,1) >> ((x)&7)) & 1)25972598#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED2599/* With these routines we avoid an integer divide, which will be slower on2600* most machines. However, it does take more operations than the corresponding2601* divide method, so it may be slower on a few RISC systems. There are two2602* shifts (by 8 or 16 bits) and an addition, versus a single integer divide.2603*2604* Note that the rounding factors are NOT supposed to be the same! 128 and2605* 32768 are correct for the NODIV code; 127 and 32767 are correct for the2606* standard method.2607*2608* [Optimized code by Greg Roelofs and Mark Adler...blame us for bugs. :-) ]2609*/26102611/* fg and bg should be in `gamma 1.0' space; alpha is the opacity */26122613# define png_composite(composite, fg, alpha, bg) \2614{ \2615png_uint_16 temp = (png_uint_16)((png_uint_16)(fg) \2616* (png_uint_16)(alpha) \2617+ (png_uint_16)(bg)*(png_uint_16)(255 \2618- (png_uint_16)(alpha)) + 128); \2619(composite) = (png_byte)(((temp + (temp >> 8)) >> 8) & 0xff); \2620}26212622# define png_composite_16(composite, fg, alpha, bg) \2623{ \2624png_uint_32 temp = (png_uint_32)((png_uint_32)(fg) \2625* (png_uint_32)(alpha) \2626+ (png_uint_32)(bg)*(65535 \2627- (png_uint_32)(alpha)) + 32768); \2628(composite) = (png_uint_16)(0xffff & ((temp + (temp >> 16)) >> 16)); \2629}26302631#else /* Standard method using integer division */26322633# define png_composite(composite, fg, alpha, bg) \2634(composite) = \2635(png_byte)(0xff & (((png_uint_16)(fg) * (png_uint_16)(alpha) + \2636(png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \2637127) / 255))26382639# define png_composite_16(composite, fg, alpha, bg) \2640(composite) = \2641(png_uint_16)(0xffff & (((png_uint_32)(fg) * (png_uint_32)(alpha) + \2642(png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) + \264332767) / 65535))2644#endif /* READ_COMPOSITE_NODIV */26452646#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED2647PNG_EXPORT(201, png_uint_32, png_get_uint_32, (png_const_bytep buf));2648PNG_EXPORT(202, png_uint_16, png_get_uint_16, (png_const_bytep buf));2649PNG_EXPORT(203, png_int_32, png_get_int_32, (png_const_bytep buf));2650#endif26512652PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_const_structrp png_ptr,2653png_const_bytep buf));2654/* No png_get_int_16 -- may be added if there's a real need for it. */26552656/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */2657#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED2658PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i));2659#endif2660#ifdef PNG_SAVE_INT_32_SUPPORTED2661PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i));2662#endif26632664/* Place a 16-bit number into a buffer in PNG byte order.2665* The parameter is declared unsigned int, not png_uint_16,2666* just to avoid potential problems on pre-ANSI C compilers.2667*/2668#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED2669PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i));2670/* No png_save_int_16 -- may be added if there's a real need for it. */2671#endif26722673#ifdef PNG_USE_READ_MACROS2674/* Inline macros to do direct reads of bytes from the input buffer.2675* The png_get_int_32() routine assumes we are using two's complement2676* format for negative values, which is almost certainly true.2677*/2678# define PNG_get_uint_32(buf) \2679(((png_uint_32)(*(buf)) << 24) + \2680((png_uint_32)(*((buf) + 1)) << 16) + \2681((png_uint_32)(*((buf) + 2)) << 8) + \2682((png_uint_32)(*((buf) + 3))))26832684/* From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the2685* function) incorrectly returned a value of type png_uint_32.2686*/2687# define PNG_get_uint_16(buf) \2688((png_uint_16) \2689(((unsigned int)(*(buf)) << 8) + \2690((unsigned int)(*((buf) + 1)))))26912692# define PNG_get_int_32(buf) \2693((png_int_32)((*(buf) & 0x80) \2694? -((png_int_32)(((png_get_uint_32(buf)^0xffffffffU)+1U)&0x7fffffffU)) \2695: (png_int_32)png_get_uint_32(buf)))26962697/* If PNG_PREFIX is defined the same thing as below happens in pnglibconf.h,2698* but defining a macro name prefixed with PNG_PREFIX.2699*/2700# ifndef PNG_PREFIX2701# define png_get_uint_32(buf) PNG_get_uint_32(buf)2702# define png_get_uint_16(buf) PNG_get_uint_16(buf)2703# define png_get_int_32(buf) PNG_get_int_32(buf)2704# endif2705#else2706# ifdef PNG_PREFIX2707/* No macros; revert to the (redefined) function */2708# define PNG_get_uint_32 (png_get_uint_32)2709# define PNG_get_uint_16 (png_get_uint_16)2710# define PNG_get_int_32 (png_get_int_32)2711# endif2712#endif27132714#ifdef PNG_CHECK_FOR_INVALID_INDEX_SUPPORTED2715PNG_EXPORT(242, void, png_set_check_for_invalid_index,2716(png_structrp png_ptr, int allowed));2717# ifdef PNG_GET_PALETTE_MAX_SUPPORTED2718PNG_EXPORT(243, int, png_get_palette_max, (png_const_structp png_ptr,2719png_const_infop info_ptr));2720# endif2721#endif /* CHECK_FOR_INVALID_INDEX */27222723/*******************************************************************************2724* Section 5: SIMPLIFIED API2725*******************************************************************************2726*2727* Please read the documentation in libpng-manual.txt (TODO: write said2728* documentation) if you don't understand what follows.2729*2730* The simplified API hides the details of both libpng and the PNG file format2731* itself. It allows PNG files to be read into a very limited number of2732* in-memory bitmap formats or to be written from the same formats. If these2733* formats do not accommodate your needs then you can, and should, use the more2734* sophisticated APIs above - these support a wide variety of in-memory formats2735* and a wide variety of sophisticated transformations to those formats as well2736* as a wide variety of APIs to manipulate ancillary information.2737*2738* To read a PNG file using the simplified API:2739*2740* 1) Declare a 'png_image' structure (see below) on the stack, set the2741* version field to PNG_IMAGE_VERSION and the 'opaque' pointer to NULL2742* (this is REQUIRED, your program may crash if you don't do it.)2743* 2) Call the appropriate png_image_begin_read... function.2744* 3) Set the png_image 'format' member to the required sample format.2745* 4) Allocate a buffer for the image and, if required, the color-map.2746* 5) Call png_image_finish_read to read the image and, if required, the2747* color-map into your buffers.2748*2749* There are no restrictions on the format of the PNG input itself; all valid2750* color types, bit depths, and interlace methods are acceptable, and the2751* input image is transformed as necessary to the requested in-memory format2752* during the png_image_finish_read() step. The only caveat is that if you2753* request a color-mapped image from a PNG that is full-color or makes2754* complex use of an alpha channel the transformation is extremely lossy and the2755* result may look terrible.2756*2757* To write a PNG file using the simplified API:2758*2759* 1) Declare a 'png_image' structure on the stack and memset() it to all zero.2760* 2) Initialize the members of the structure that describe the image, setting2761* the 'format' member to the format of the image samples.2762* 3) Call the appropriate png_image_write... function with a pointer to the2763* image and, if necessary, the color-map to write the PNG data.2764*2765* png_image is a structure that describes the in-memory format of an image2766* when it is being read or defines the in-memory format of an image that you2767* need to write:2768*/2769#if defined(PNG_SIMPLIFIED_READ_SUPPORTED) || \2770defined(PNG_SIMPLIFIED_WRITE_SUPPORTED)27712772#define PNG_IMAGE_VERSION 127732774typedef struct png_control *png_controlp;2775typedef struct2776{2777png_controlp opaque; /* Initialize to NULL, free with png_image_free */2778png_uint_32 version; /* Set to PNG_IMAGE_VERSION */2779png_uint_32 width; /* Image width in pixels (columns) */2780png_uint_32 height; /* Image height in pixels (rows) */2781png_uint_32 format; /* Image format as defined below */2782png_uint_32 flags; /* A bit mask containing informational flags */2783png_uint_32 colormap_entries;2784/* Number of entries in the color-map */27852786/* In the event of an error or warning the following field will be set to a2787* non-zero value and the 'message' field will contain a '\0' terminated2788* string with the libpng error or warning message. If both warnings and2789* an error were encountered, only the error is recorded. If there2790* are multiple warnings, only the first one is recorded.2791*2792* The upper 30 bits of this value are reserved, the low two bits contain2793* a value as follows:2794*/2795# define PNG_IMAGE_WARNING 12796# define PNG_IMAGE_ERROR 22797/*2798* The result is a two-bit code such that a value more than 1 indicates2799* a failure in the API just called:2800*2801* 0 - no warning or error2802* 1 - warning2803* 2 - error2804* 3 - error preceded by warning2805*/2806# define PNG_IMAGE_FAILED(png_cntrl) ((((png_cntrl).warning_or_error)&0x03)>1)28072808png_uint_32 warning_or_error;28092810char message[64];2811} png_image, *png_imagep;28122813/* The samples of the image have one to four channels whose components have2814* original values in the range 0 to 1.0:2815*2816* 1: A single gray or luminance channel (G).2817* 2: A gray/luminance channel and an alpha channel (GA).2818* 3: Three red, green, blue color channels (RGB).2819* 4: Three color channels and an alpha channel (RGBA).2820*2821* The components are encoded in one of two ways:2822*2823* a) As a small integer, value 0..255, contained in a single byte. For the2824* alpha channel the original value is simply value/255. For the color or2825* luminance channels the value is encoded according to the sRGB specification2826* and matches the 8-bit format expected by typical display devices.2827*2828* The color/gray channels are not scaled (pre-multiplied) by the alpha2829* channel and are suitable for passing to color management software.2830*2831* b) As a value in the range 0..65535, contained in a 2-byte integer. All2832* channels can be converted to the original value by dividing by 65535; all2833* channels are linear. Color channels use the RGB encoding (RGB end-points) of2834* the sRGB specification. This encoding is identified by the2835* PNG_FORMAT_FLAG_LINEAR flag below.2836*2837* When the simplified API needs to convert between sRGB and linear colorspaces,2838* the actual sRGB transfer curve defined in the sRGB specification (see the2839* article at <https://en.wikipedia.org/wiki/SRGB>) is used, not the gamma=1/2.22840* approximation used elsewhere in libpng.2841*2842* When an alpha channel is present it is expected to denote pixel coverage2843* of the color or luminance channels and is returned as an associated alpha2844* channel: the color/gray channels are scaled (pre-multiplied) by the alpha2845* value.2846*2847* The samples are either contained directly in the image data, between 1 and 82848* bytes per pixel according to the encoding, or are held in a color-map indexed2849* by bytes in the image data. In the case of a color-map the color-map entries2850* are individual samples, encoded as above, and the image data has one byte per2851* pixel to select the relevant sample from the color-map.2852*/28532854/* PNG_FORMAT_*2855*2856* #defines to be used in png_image::format. Each #define identifies a2857* particular layout of sample data and, if present, alpha values. There are2858* separate defines for each of the two component encodings.2859*2860* A format is built up using single bit flag values. All combinations are2861* valid. Formats can be built up from the flag values or you can use one of2862* the predefined values below. When testing formats always use the FORMAT_FLAG2863* macros to test for individual features - future versions of the library may2864* add new flags.2865*2866* When reading or writing color-mapped images the format should be set to the2867* format of the entries in the color-map then png_image_{read,write}_colormap2868* called to read or write the color-map and set the format correctly for the2869* image data. Do not set the PNG_FORMAT_FLAG_COLORMAP bit directly!2870*2871* NOTE: libpng can be built with particular features disabled. If you see2872* compiler errors because the definition of one of the following flags has been2873* compiled out it is because libpng does not have the required support. It is2874* possible, however, for the libpng configuration to enable the format on just2875* read or just write; in that case you may see an error at run time. You can2876* guard against this by checking for the definition of the appropriate2877* "_SUPPORTED" macro, one of:2878*2879* PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED2880*/2881#define PNG_FORMAT_FLAG_ALPHA 0x01U /* format with an alpha channel */2882#define PNG_FORMAT_FLAG_COLOR 0x02U /* color format: otherwise grayscale */2883#define PNG_FORMAT_FLAG_LINEAR 0x04U /* 2-byte channels else 1-byte */2884#define PNG_FORMAT_FLAG_COLORMAP 0x08U /* image data is color-mapped */28852886#ifdef PNG_FORMAT_BGR_SUPPORTED2887# define PNG_FORMAT_FLAG_BGR 0x10U /* BGR colors, else order is RGB */2888#endif28892890#ifdef PNG_FORMAT_AFIRST_SUPPORTED2891# define PNG_FORMAT_FLAG_AFIRST 0x20U /* alpha channel comes first */2892#endif28932894#define PNG_FORMAT_FLAG_ASSOCIATED_ALPHA 0x40U /* alpha channel is associated */28952896/* Commonly used formats have predefined macros.2897*2898* First the single byte (sRGB) formats:2899*/2900#define PNG_FORMAT_GRAY 02901#define PNG_FORMAT_GA PNG_FORMAT_FLAG_ALPHA2902#define PNG_FORMAT_AG (PNG_FORMAT_GA|PNG_FORMAT_FLAG_AFIRST)2903#define PNG_FORMAT_RGB PNG_FORMAT_FLAG_COLOR2904#define PNG_FORMAT_BGR (PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_BGR)2905#define PNG_FORMAT_RGBA (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_ALPHA)2906#define PNG_FORMAT_ARGB (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_AFIRST)2907#define PNG_FORMAT_BGRA (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_ALPHA)2908#define PNG_FORMAT_ABGR (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_AFIRST)29092910/* Then the linear 2-byte formats. When naming these "Y" is used to2911* indicate a luminance (gray) channel.2912*/2913#define PNG_FORMAT_LINEAR_Y PNG_FORMAT_FLAG_LINEAR2914#define PNG_FORMAT_LINEAR_Y_ALPHA (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_ALPHA)2915#define PNG_FORMAT_LINEAR_RGB (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR)2916#define PNG_FORMAT_LINEAR_RGB_ALPHA \2917(PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA)29182919/* With color-mapped formats the image data is one byte for each pixel, the byte2920* is an index into the color-map which is formatted as above. To obtain a2921* color-mapped format it is sufficient just to add the PNG_FOMAT_FLAG_COLORMAP2922* to one of the above definitions, or you can use one of the definitions below.2923*/2924#define PNG_FORMAT_RGB_COLORMAP (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_COLORMAP)2925#define PNG_FORMAT_BGR_COLORMAP (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_COLORMAP)2926#define PNG_FORMAT_RGBA_COLORMAP (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_COLORMAP)2927#define PNG_FORMAT_ARGB_COLORMAP (PNG_FORMAT_ARGB|PNG_FORMAT_FLAG_COLORMAP)2928#define PNG_FORMAT_BGRA_COLORMAP (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_COLORMAP)2929#define PNG_FORMAT_ABGR_COLORMAP (PNG_FORMAT_ABGR|PNG_FORMAT_FLAG_COLORMAP)29302931/* PNG_IMAGE macros2932*2933* These are convenience macros to derive information from a png_image2934* structure. The PNG_IMAGE_SAMPLE_ macros return values appropriate to the2935* actual image sample values - either the entries in the color-map or the2936* pixels in the image. The PNG_IMAGE_PIXEL_ macros return corresponding values2937* for the pixels and will always return 1 for color-mapped formats. The2938* remaining macros return information about the rows in the image and the2939* complete image.2940*2941* NOTE: All the macros that take a png_image::format parameter are compile time2942* constants if the format parameter is, itself, a constant. Therefore these2943* macros can be used in array declarations and case labels where required.2944* Similarly the macros are also pre-processor constants (sizeof is not used) so2945* they can be used in #if tests.2946*2947* First the information about the samples.2948*/2949#define PNG_IMAGE_SAMPLE_CHANNELS(fmt)\2950(((fmt)&(PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA))+1)2951/* Return the total number of channels in a given format: 1..4 */29522953#define PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt)\2954((((fmt) & PNG_FORMAT_FLAG_LINEAR) >> 2)+1)2955/* Return the size in bytes of a single component of a pixel or color-map2956* entry (as appropriate) in the image: 1 or 2.2957*/29582959#define PNG_IMAGE_SAMPLE_SIZE(fmt)\2960(PNG_IMAGE_SAMPLE_CHANNELS(fmt) * PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt))2961/* This is the size of the sample data for one sample. If the image is2962* color-mapped it is the size of one color-map entry (and image pixels are2963* one byte in size), otherwise it is the size of one image pixel.2964*/29652966#define PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)\2967(PNG_IMAGE_SAMPLE_CHANNELS(fmt) * 256)2968/* The maximum size of the color-map required by the format expressed in a2969* count of components. This can be used to compile-time allocate a2970* color-map:2971*2972* png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)];2973*2974* png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)];2975*2976* Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the2977* information from one of the png_image_begin_read_ APIs and dynamically2978* allocate the required memory.2979*/29802981/* Corresponding information about the pixels */2982#define PNG_IMAGE_PIXEL_(test,fmt)\2983(((fmt)&PNG_FORMAT_FLAG_COLORMAP)?1:test(fmt))29842985#define PNG_IMAGE_PIXEL_CHANNELS(fmt)\2986PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_CHANNELS,fmt)2987/* The number of separate channels (components) in a pixel; 1 for a2988* color-mapped image.2989*/29902991#define PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)\2992PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_COMPONENT_SIZE,fmt)2993/* The size, in bytes, of each component in a pixel; 1 for a color-mapped2994* image.2995*/29962997#define PNG_IMAGE_PIXEL_SIZE(fmt) PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_SIZE,fmt)2998/* The size, in bytes, of a complete pixel; 1 for a color-mapped image. */29993000/* Information about the whole row, or whole image */3001#define PNG_IMAGE_ROW_STRIDE(image)\3002(PNG_IMAGE_PIXEL_CHANNELS((image).format) * (image).width)3003/* Return the total number of components in a single row of the image; this3004* is the minimum 'row stride', the minimum count of components between each3005* row. For a color-mapped image this is the minimum number of bytes in a3006* row.3007*3008* WARNING: this macro overflows for some images with more than one component3009* and very large image widths. libpng will refuse to process an image where3010* this macro would overflow.3011*/30123013#define PNG_IMAGE_BUFFER_SIZE(image, row_stride)\3014(PNG_IMAGE_PIXEL_COMPONENT_SIZE((image).format)*(image).height*(row_stride))3015/* Return the size, in bytes, of an image buffer given a png_image and a row3016* stride - the number of components to leave space for in each row.3017*3018* WARNING: this macro overflows a 32-bit integer for some large PNG images,3019* libpng will refuse to process an image where such an overflow would occur.3020*/30213022#define PNG_IMAGE_SIZE(image)\3023PNG_IMAGE_BUFFER_SIZE(image, PNG_IMAGE_ROW_STRIDE(image))3024/* Return the size, in bytes, of the image in memory given just a png_image;3025* the row stride is the minimum stride required for the image.3026*/30273028#define PNG_IMAGE_COLORMAP_SIZE(image)\3029(PNG_IMAGE_SAMPLE_SIZE((image).format) * (image).colormap_entries)3030/* Return the size, in bytes, of the color-map of this image. If the image3031* format is not a color-map format this will return a size sufficient for3032* 256 entries in the given format; check PNG_FORMAT_FLAG_COLORMAP if3033* you don't want to allocate a color-map in this case.3034*/30353036/* PNG_IMAGE_FLAG_*3037*3038* Flags containing additional information about the image are held in the3039* 'flags' field of png_image.3040*/3041#define PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB 0x013042/* This indicates that the RGB values of the in-memory bitmap do not3043* correspond to the red, green and blue end-points defined by sRGB.3044*/30453046#define PNG_IMAGE_FLAG_FAST 0x023047/* On write emphasise speed over compression; the resultant PNG file will be3048* larger but will be produced significantly faster, particular for large3049* images. Do not use this option for images which will be distributed, only3050* used it when producing intermediate files that will be read back in3051* repeatedly. For a typical 24-bit image the option will double the read3052* speed at the cost of increasing the image size by 25%, however for many3053* more compressible images the PNG file can be 10 times larger with only a3054* slight speed gain.3055*/30563057#define PNG_IMAGE_FLAG_16BIT_sRGB 0x043058/* On read if the image is a 16-bit per component image and there is no gAMA3059* or sRGB chunk assume that the components are sRGB encoded. Notice that3060* images output by the simplified API always have gamma information; setting3061* this flag only affects the interpretation of 16-bit images from an3062* external source. It is recommended that the application expose this flag3063* to the user; the user can normally easily recognize the difference between3064* linear and sRGB encoding. This flag has no effect on write - the data3065* passed to the write APIs must have the correct encoding (as defined3066* above.)3067*3068* If the flag is not set (the default) input 16-bit per component data is3069* assumed to be linear.3070*3071* NOTE: the flag can only be set after the png_image_begin_read_ call,3072* because that call initializes the 'flags' field.3073*/30743075#ifdef PNG_SIMPLIFIED_READ_SUPPORTED3076/* READ APIs3077* ---------3078*3079* The png_image passed to the read APIs must have been initialized by setting3080* the png_controlp field 'opaque' to NULL (or, safer, memset the whole thing.)3081*/3082#ifdef PNG_STDIO_SUPPORTED3083PNG_EXPORT(234, int, png_image_begin_read_from_file, (png_imagep image,3084const char *file_name));3085/* The named file is opened for read and the image header is filled in3086* from the PNG header in the file.3087*/30883089PNG_EXPORT(235, int, png_image_begin_read_from_stdio, (png_imagep image,3090FILE *file));3091/* The PNG header is read from the stdio FILE object. */3092#endif /* STDIO */30933094PNG_EXPORT(236, int, png_image_begin_read_from_memory, (png_imagep image,3095png_const_voidp memory, size_t size));3096/* The PNG header is read from the given memory buffer. */30973098PNG_EXPORT(237, int, png_image_finish_read, (png_imagep image,3099png_const_colorp background, void *buffer, png_int_32 row_stride,3100void *colormap));3101/* Finish reading the image into the supplied buffer and clean up the3102* png_image structure.3103*3104* row_stride is the step, in byte or 2-byte units as appropriate,3105* between adjacent rows. A positive stride indicates that the top-most row3106* is first in the buffer - the normal top-down arrangement. A negative3107* stride indicates that the bottom-most row is first in the buffer.3108*3109* background need only be supplied if an alpha channel must be removed from3110* a png_byte format and the removal is to be done by compositing on a solid3111* color; otherwise it may be NULL and any composition will be done directly3112* onto the buffer. The value is an sRGB color to use for the background,3113* for grayscale output the green channel is used.3114*3115* background must be supplied when an alpha channel must be removed from a3116* single byte color-mapped output format, in other words if:3117*3118* 1) The original format from png_image_begin_read_from_* had3119* PNG_FORMAT_FLAG_ALPHA set.3120* 2) The format set by the application does not.3121* 3) The format set by the application has PNG_FORMAT_FLAG_COLORMAP set and3122* PNG_FORMAT_FLAG_LINEAR *not* set.3123*3124* For linear output removing the alpha channel is always done by compositing3125* on black and background is ignored.3126*3127* colormap must be supplied when PNG_FORMAT_FLAG_COLORMAP is set. It must3128* be at least the size (in bytes) returned by PNG_IMAGE_COLORMAP_SIZE.3129* image->colormap_entries will be updated to the actual number of entries3130* written to the colormap; this may be less than the original value.3131*/31323133PNG_EXPORT(238, void, png_image_free, (png_imagep image));3134/* Free any data allocated by libpng in image->opaque, setting the pointer to3135* NULL. May be called at any time after the structure is initialized.3136*/3137#endif /* SIMPLIFIED_READ */31383139#ifdef PNG_SIMPLIFIED_WRITE_SUPPORTED3140/* WRITE APIS3141* ----------3142* For write you must initialize a png_image structure to describe the image to3143* be written. To do this use memset to set the whole structure to 0 then3144* initialize fields describing your image.3145*3146* version: must be set to PNG_IMAGE_VERSION3147* opaque: must be initialized to NULL3148* width: image width in pixels3149* height: image height in rows3150* format: the format of the data (image and color-map) you wish to write3151* flags: set to 0 unless one of the defined flags applies; set3152* PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images where the RGB3153* values do not correspond to the colors in sRGB.3154* colormap_entries: set to the number of entries in the color-map (0 to 256)3155*/3156#ifdef PNG_SIMPLIFIED_WRITE_STDIO_SUPPORTED3157PNG_EXPORT(239, int, png_image_write_to_file, (png_imagep image,3158const char *file, int convert_to_8bit, const void *buffer,3159png_int_32 row_stride, const void *colormap));3160/* Write the image to the named file. */31613162PNG_EXPORT(240, int, png_image_write_to_stdio, (png_imagep image, FILE *file,3163int convert_to_8_bit, const void *buffer, png_int_32 row_stride,3164const void *colormap));3165/* Write the image to the given FILE object. */3166#endif /* SIMPLIFIED_WRITE_STDIO */31673168/* With all write APIs if image is in one of the linear formats with 16-bit3169* data then setting convert_to_8_bit will cause the output to be an 8-bit PNG3170* gamma encoded according to the sRGB specification, otherwise a 16-bit linear3171* encoded PNG file is written.3172*3173* With color-mapped data formats the colormap parameter point to a color-map3174* with at least image->colormap_entries encoded in the specified format. If3175* the format is linear the written PNG color-map will be converted to sRGB3176* regardless of the convert_to_8_bit flag.3177*3178* With all APIs row_stride is handled as in the read APIs - it is the spacing3179* from one row to the next in component sized units (1 or 2 bytes) and if3180* negative indicates a bottom-up row layout in the buffer. If row_stride is3181* zero, libpng will calculate it for you from the image width and number of3182* channels.3183*3184* Note that the write API does not support interlacing, sub-8-bit pixels or3185* most ancillary chunks. If you need to write text chunks (e.g. for copyright3186* notices) you need to use one of the other APIs.3187*/31883189PNG_EXPORT(245, int, png_image_write_to_memory, (png_imagep image, void *memory,3190png_alloc_size_t * PNG_RESTRICT memory_bytes, int convert_to_8_bit,3191const void *buffer, png_int_32 row_stride, const void *colormap));3192/* Write the image to the given memory buffer. The function both writes the3193* whole PNG data stream to *memory and updates *memory_bytes with the count3194* of bytes written.3195*3196* 'memory' may be NULL. In this case *memory_bytes is not read however on3197* success the number of bytes which would have been written will still be3198* stored in *memory_bytes. On failure *memory_bytes will contain 0.3199*3200* If 'memory' is not NULL it must point to memory[*memory_bytes] of3201* writeable memory.3202*3203* If the function returns success memory[*memory_bytes] (if 'memory' is not3204* NULL) contains the written PNG data. *memory_bytes will always be less3205* than or equal to the original value.3206*3207* If the function returns false and *memory_bytes was not changed an error3208* occurred during write. If *memory_bytes was changed, or is not 0 if3209* 'memory' was NULL, the write would have succeeded but for the memory3210* buffer being too small. *memory_bytes contains the required number of3211* bytes and will be bigger that the original value.3212*/32133214#define png_image_write_get_memory_size(image, size, convert_to_8_bit, buffer,\3215row_stride, colormap)\3216png_image_write_to_memory(&(image), 0, &(size), convert_to_8_bit, buffer,\3217row_stride, colormap)3218/* Return the amount of memory in 'size' required to compress this image.3219* The png_image structure 'image' must be filled in as in the above3220* function and must not be changed before the actual write call, the buffer3221* and all other parameters must also be identical to that in the final3222* write call. The 'size' variable need not be initialized.3223*3224* NOTE: the macro returns true/false, if false is returned 'size' will be3225* set to zero and the write failed and probably will fail if tried again.3226*/32273228/* You can pre-allocate the buffer by making sure it is of sufficient size3229* regardless of the amount of compression achieved. The buffer size will3230* always be bigger than the original image and it will never be filled. The3231* following macros are provided to assist in allocating the buffer.3232*/3233#define PNG_IMAGE_DATA_SIZE(image) (PNG_IMAGE_SIZE(image)+(image).height)3234/* The number of uncompressed bytes in the PNG byte encoding of the image;3235* uncompressing the PNG IDAT data will give this number of bytes.3236*3237* NOTE: while PNG_IMAGE_SIZE cannot overflow for an image in memory this3238* macro can because of the extra bytes used in the PNG byte encoding. You3239* need to avoid this macro if your image size approaches 2^30 in width or3240* height. The same goes for the remainder of these macros; they all produce3241* bigger numbers than the actual in-memory image size.3242*/3243#ifndef PNG_ZLIB_MAX_SIZE3244# define PNG_ZLIB_MAX_SIZE(b) ((b)+(((b)+7U)>>3)+(((b)+63U)>>6)+11U)3245/* An upper bound on the number of compressed bytes given 'b' uncompressed3246* bytes. This is based on deflateBounds() in zlib; different3247* implementations of zlib compression may conceivably produce more data so3248* if your zlib implementation is not zlib itself redefine this macro3249* appropriately.3250*/3251#endif32523253#define PNG_IMAGE_COMPRESSED_SIZE_MAX(image)\3254PNG_ZLIB_MAX_SIZE((png_alloc_size_t)PNG_IMAGE_DATA_SIZE(image))3255/* An upper bound on the size of the data in the PNG IDAT chunks. */32563257#define PNG_IMAGE_PNG_SIZE_MAX_(image, image_size)\3258((8U/*sig*/+25U/*IHDR*/+16U/*gAMA*/+44U/*cHRM*/+12U/*IEND*/+\3259(((image).format&PNG_FORMAT_FLAG_COLORMAP)?/*colormap: PLTE, tRNS*/\326012U+3U*(image).colormap_entries/*PLTE data*/+\3261(((image).format&PNG_FORMAT_FLAG_ALPHA)?\326212U/*tRNS*/+(image).colormap_entries:0U):0U)+\326312U)+(12U*((image_size)/PNG_ZBUF_SIZE))/*IDAT*/+(image_size))3264/* A helper for the following macro; if your compiler cannot handle the3265* following macro use this one with the result of3266* PNG_IMAGE_COMPRESSED_SIZE_MAX(image) as the second argument (most3267* compilers should handle this just fine.)3268*/32693270#define PNG_IMAGE_PNG_SIZE_MAX(image)\3271PNG_IMAGE_PNG_SIZE_MAX_(image, PNG_IMAGE_COMPRESSED_SIZE_MAX(image))3272/* An upper bound on the total length of the PNG data stream for 'image'.3273* The result is of type png_alloc_size_t, on 32-bit systems this may3274* overflow even though PNG_IMAGE_DATA_SIZE does not overflow; the write will3275* run out of buffer space but return a corrected size which should work.3276*/3277#endif /* SIMPLIFIED_WRITE */3278/*******************************************************************************3279* END OF SIMPLIFIED API3280******************************************************************************/3281#endif /* SIMPLIFIED_{READ|WRITE} */32823283/*******************************************************************************3284* Section 6: IMPLEMENTATION OPTIONS3285*******************************************************************************3286*3287* Support for arbitrary implementation-specific optimizations. The API allows3288* particular options to be turned on or off. 'Option' is the number of the3289* option and 'onoff' is 0 (off) or non-0 (on). The value returned is given3290* by the PNG_OPTION_ defines below.3291*3292* HARDWARE: normally hardware capabilities, such as the Intel SSE instructions,3293* are detected at run time, however sometimes it may be impossible3294* to do this in user mode, in which case it is necessary to discover3295* the capabilities in an OS specific way. Such capabilities are3296* listed here when libpng has support for them and must be turned3297* ON by the application if present.3298*3299* SOFTWARE: sometimes software optimizations actually result in performance3300* decrease on some architectures or systems, or with some sets of3301* PNG images. 'Software' options allow such optimizations to be3302* selected at run time.3303*/3304#ifdef PNG_SET_OPTION_SUPPORTED3305#ifdef PNG_ARM_NEON_API_SUPPORTED3306# define PNG_ARM_NEON 0 /* HARDWARE: ARM Neon SIMD instructions supported */3307#endif3308#define PNG_MAXIMUM_INFLATE_WINDOW 2 /* SOFTWARE: force maximum window */3309#define PNG_SKIP_sRGB_CHECK_PROFILE 4 /* SOFTWARE: Check ICC profile for sRGB */3310#ifdef PNG_MIPS_MSA_API_SUPPORTED3311# define PNG_MIPS_MSA 6 /* HARDWARE: MIPS Msa SIMD instructions supported */3312#endif3313#ifdef PNG_DISABLE_ADLER32_CHECK_SUPPORTED3314# define PNG_IGNORE_ADLER32 8 /* SOFTWARE: disable Adler32 check on IDAT */3315#endif3316#ifdef PNG_POWERPC_VSX_API_SUPPORTED3317# define PNG_POWERPC_VSX 10 /* HARDWARE: PowerPC VSX SIMD instructions3318* supported */3319#endif3320#ifdef PNG_MIPS_MMI_API_SUPPORTED3321# define PNG_MIPS_MMI 12 /* HARDWARE: MIPS MMI SIMD instructions supported */3322#endif33233324#define PNG_OPTION_NEXT 14 /* Next option - numbers must be even */33253326/* Return values: NOTE: there are four values and 'off' is *not* zero */3327#define PNG_OPTION_UNSET 0 /* Unset - defaults to off */3328#define PNG_OPTION_INVALID 1 /* Option number out of range */3329#define PNG_OPTION_OFF 23330#define PNG_OPTION_ON 333313332PNG_EXPORT(244, int, png_set_option, (png_structrp png_ptr, int option,3333int onoff));3334#endif /* SET_OPTION */33353336/*******************************************************************************3337* END OF HARDWARE AND SOFTWARE OPTIONS3338******************************************************************************/33393340/* Maintainer: Put new public prototypes here ^, in libpng.3, in project3341* defs, and in scripts/symbols.def.3342*/33433344/* The last ordinal number (this is the *last* one already used; the next3345* one to use is one more than this.)3346*/3347#ifdef PNG_EXPORT_LAST_ORDINAL3348PNG_EXPORT_LAST_ORDINAL(259);3349#endif33503351#ifdef __cplusplus3352}3353#endif33543355#endif /* PNG_VERSION_INFO_ONLY */3356/* Do not put anything past this line */3357#endif /* PNG_H */335833593360