png.h (151806B)
1 /* png.h - header file for PNG reference library 2 * 3 * libpng version 1.6.53 4 * 5 * Copyright (c) 2018-2025 Cosmin Truta 6 * Copyright (c) 1998-2002,2004,2006-2018 Glenn Randers-Pehrson 7 * Copyright (c) 1996-1997 Andreas Dilger 8 * Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc. 9 * 10 * This code is released under the libpng license. (See LICENSE, below.) 11 * 12 * Authors and maintainers: 13 * libpng versions 0.71, May 1995, through 0.88, January 1996: Guy Schalnat 14 * libpng versions 0.89, June 1996, through 0.96, May 1997: Andreas Dilger 15 * libpng versions 0.97, January 1998, through 1.6.35, July 2018: 16 * Glenn Randers-Pehrson 17 * libpng versions 1.6.36, December 2018, through 1.6.53, December 2025: 18 * Cosmin Truta 19 * See also "Contributing Authors", below. 20 */ 21 22 /* 23 * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE 24 * ========================================= 25 * 26 * PNG Reference Library License version 2 27 * --------------------------------------- 28 * 29 * * Copyright (c) 1995-2025 The PNG Reference Library Authors. 30 * * Copyright (c) 2018-2025 Cosmin Truta. 31 * * Copyright (c) 2000-2002, 2004, 2006-2018 Glenn Randers-Pehrson. 32 * * Copyright (c) 1996-1997 Andreas Dilger. 33 * * Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc. 34 * 35 * The software is supplied "as is", without warranty of any kind, 36 * express or implied, including, without limitation, the warranties 37 * of merchantability, fitness for a particular purpose, title, and 38 * non-infringement. In no event shall the Copyright owners, or 39 * anyone distributing the software, be liable for any damages or 40 * other liability, whether in contract, tort or otherwise, arising 41 * from, out of, or in connection with the software, or the use or 42 * other dealings in the software, even if advised of the possibility 43 * of such damage. 44 * 45 * Permission is hereby granted to use, copy, modify, and distribute 46 * this software, or portions hereof, for any purpose, without fee, 47 * subject to the following restrictions: 48 * 49 * 1. The origin of this software must not be misrepresented; you 50 * must not claim that you wrote the original software. If you 51 * use this software in a product, an acknowledgment in the product 52 * documentation would be appreciated, but is not required. 53 * 54 * 2. Altered source versions must be plainly marked as such, and must 55 * not be misrepresented as being the original software. 56 * 57 * 3. This Copyright notice may not be removed or altered from any 58 * source or altered source distribution. 59 * 60 * 61 * PNG Reference Library License version 1 (for libpng 0.5 through 1.6.35) 62 * ----------------------------------------------------------------------- 63 * 64 * libpng versions 1.0.7, July 1, 2000, through 1.6.35, July 15, 2018 are 65 * Copyright (c) 2000-2002, 2004, 2006-2018 Glenn Randers-Pehrson, are 66 * derived from libpng-1.0.6, and are distributed according to the same 67 * disclaimer and license as libpng-1.0.6 with the following individuals 68 * added to the list of Contributing Authors: 69 * 70 * Simon-Pierre Cadieux 71 * Eric S. Raymond 72 * Mans Rullgard 73 * Cosmin Truta 74 * Gilles Vollant 75 * James Yu 76 * Mandar Sahastrabuddhe 77 * Google Inc. 78 * Vadim Barkov 79 * 80 * and with the following additions to the disclaimer: 81 * 82 * There is no warranty against interference with your enjoyment of 83 * the library or against infringement. There is no warranty that our 84 * efforts or the library will fulfill any of your particular purposes 85 * or needs. This library is provided with all faults, and the entire 86 * risk of satisfactory quality, performance, accuracy, and effort is 87 * with the user. 88 * 89 * Some files in the "contrib" directory and some configure-generated 90 * files that are distributed with libpng have other copyright owners, and 91 * are released under other open source licenses. 92 * 93 * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are 94 * Copyright (c) 1998-2000 Glenn Randers-Pehrson, are derived from 95 * libpng-0.96, and are distributed according to the same disclaimer and 96 * license as libpng-0.96, with the following individuals added to the 97 * list of Contributing Authors: 98 * 99 * Tom Lane 100 * Glenn Randers-Pehrson 101 * Willem van Schaik 102 * 103 * libpng versions 0.89, June 1996, through 0.96, May 1997, are 104 * Copyright (c) 1996-1997 Andreas Dilger, are derived from libpng-0.88, 105 * and are distributed according to the same disclaimer and license as 106 * libpng-0.88, with the following individuals added to the list of 107 * Contributing Authors: 108 * 109 * John Bowler 110 * Kevin Bracey 111 * Sam Bushell 112 * Magnus Holmgren 113 * Greg Roelofs 114 * Tom Tanner 115 * 116 * Some files in the "scripts" directory have other copyright owners, 117 * but are released under this license. 118 * 119 * libpng versions 0.5, May 1995, through 0.88, January 1996, are 120 * Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc. 121 * 122 * For the purposes of this copyright and license, "Contributing Authors" 123 * is defined as the following set of individuals: 124 * 125 * Andreas Dilger 126 * Dave Martindale 127 * Guy Eric Schalnat 128 * Paul Schmidt 129 * Tim Wegner 130 * 131 * The PNG Reference Library is supplied "AS IS". The Contributing 132 * Authors and Group 42, Inc. disclaim all warranties, expressed or 133 * implied, including, without limitation, the warranties of 134 * merchantability and of fitness for any purpose. The Contributing 135 * Authors and Group 42, Inc. assume no liability for direct, indirect, 136 * incidental, special, exemplary, or consequential damages, which may 137 * result from the use of the PNG Reference Library, even if advised of 138 * the possibility of such damage. 139 * 140 * Permission is hereby granted to use, copy, modify, and distribute this 141 * source code, or portions hereof, for any purpose, without fee, subject 142 * to the following restrictions: 143 * 144 * 1. The origin of this source code must not be misrepresented. 145 * 146 * 2. Altered versions must be plainly marked as such and must not 147 * be misrepresented as being the original source. 148 * 149 * 3. This Copyright notice may not be removed or altered from any 150 * source or altered source distribution. 151 * 152 * The Contributing Authors and Group 42, Inc. specifically permit, 153 * without fee, and encourage the use of this source code as a component 154 * to supporting the PNG file format in commercial products. If you use 155 * this source code in a product, acknowledgment is not required but would 156 * be appreciated. 157 * 158 * END OF COPYRIGHT NOTICE, DISCLAIMER, and LICENSE. 159 * 160 * TRADEMARK 161 * ========= 162 * 163 * The name "libpng" has not been registered by the Copyright owners 164 * as a trademark in any jurisdiction. However, because libpng has 165 * been distributed and maintained world-wide, continually since 1995, 166 * the Copyright owners claim "common-law trademark protection" in any 167 * jurisdiction where common-law trademark is recognized. 168 */ 169 170 /* 171 * A "png_get_copyright" function is available, for convenient use in "about" 172 * boxes and the like: 173 * 174 * printf("%s", png_get_copyright(NULL)); 175 * 176 * Also, the PNG logo (in PNG format, of course) is supplied in the 177 * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31). 178 */ 179 180 /* 181 * The contributing authors would like to thank all those who helped 182 * with testing, bug fixes, and patience. This wouldn't have been 183 * possible without all of you. 184 * 185 * Thanks to Frank J. T. Wojcik for helping with the documentation. 186 */ 187 188 /* Note about libpng version numbers: 189 * 190 * Due to various miscommunications, unforeseen code incompatibilities 191 * and occasional factors outside the authors' control, version numbering 192 * on the library has not always been consistent and straightforward. 193 * The following table summarizes matters since version 0.89c, which was 194 * the first widely used release: 195 * 196 * source png.h png.h shared-lib 197 * version string int version 198 * ------- ------ ----- ---------- 199 * 0.89c "1.0 beta 3" 0.89 89 1.0.89 200 * 0.90 "1.0 beta 4" 0.90 90 0.90 [should have been 2.0.90] 201 * 0.95 "1.0 beta 5" 0.95 95 0.95 [should have been 2.0.95] 202 * 0.96 "1.0 beta 6" 0.96 96 0.96 [should have been 2.0.96] 203 * 0.97b "1.00.97 beta 7" 1.00.97 97 1.0.1 [should have been 2.0.97] 204 * 0.97c 0.97 97 2.0.97 205 * 0.98 0.98 98 2.0.98 206 * 0.99 0.99 98 2.0.99 207 * 0.99a-m 0.99 99 2.0.99 208 * 1.00 1.00 100 2.1.0 [100 should be 10000] 209 * 1.0.0 (from here on, the 100 2.1.0 [100 should be 10000] 210 * 1.0.1 png.h string is 10001 2.1.0 211 * 1.0.1a-e identical to the 10002 from here on, the shared library 212 * 1.0.2 source version) 10002 is 2.V where V is the source code 213 * 1.0.2a-b 10003 version, except as noted. 214 * 1.0.3 10003 215 * 1.0.3a-d 10004 216 * 1.0.4 10004 217 * 1.0.4a-f 10005 218 * 1.0.5 (+ 2 patches) 10005 219 * 1.0.5a-d 10006 220 * 1.0.5e-r 10100 (not source compatible) 221 * 1.0.5s-v 10006 (not binary compatible) 222 * 1.0.6 (+ 3 patches) 10006 (still binary incompatible) 223 * 1.0.6d-f 10007 (still binary incompatible) 224 * 1.0.6g 10007 225 * 1.0.6h 10007 10.6h (testing xy.z so-numbering) 226 * 1.0.6i 10007 10.6i 227 * 1.0.6j 10007 2.1.0.6j (incompatible with 1.0.0) 228 * 1.0.7beta11-14 DLLNUM 10007 2.1.0.7beta11-14 (binary compatible) 229 * 1.0.7beta15-18 1 10007 2.1.0.7beta15-18 (binary compatible) 230 * 1.0.7rc1-2 1 10007 2.1.0.7rc1-2 (binary compatible) 231 * 1.0.7 1 10007 (still compatible) 232 * ... 233 * 1.0.69 10 10069 10.so.0.69[.0] 234 * ... 235 * 1.2.59 13 10259 12.so.0.59[.0] 236 * ... 237 * 1.4.20 14 10420 14.so.0.20[.0] 238 * ... 239 * 1.5.30 15 10530 15.so.15.30[.0] 240 * ... 241 * 1.6.53 16 10651 16.so.16.53[.0] 242 * 243 * Henceforth the source version will match the shared-library major and 244 * minor numbers; the shared-library major version number will be used for 245 * changes in backward compatibility, as it is intended. 246 * The PNG_LIBPNG_VER macro, which is not used within libpng but is 247 * available for applications, is an unsigned integer of the form XYYZZ 248 * corresponding to the source version X.Y.Z (leading zeros in Y and Z). 249 * Beta versions were given the previous public release number plus a 250 * letter, until version 1.0.6j; from then on they were given the upcoming 251 * public release number plus "betaNN" or "rcNN". 252 * 253 * Binary incompatibility exists only when applications make direct access 254 * to the info_ptr or png_ptr members through png.h, and the compiled 255 * application is loaded with a different version of the library. 256 * 257 * See libpng.txt or libpng.3 for more information. The PNG specification 258 * is available as a W3C Recommendation and as an ISO/IEC Standard; see 259 * <https://www.w3.org/TR/2003/REC-PNG-20031110/> 260 */ 261 262 #ifndef PNG_H 263 #define PNG_H 264 265 /* This is not the place to learn how to use libpng. The file libpng-manual.txt 266 * describes how to use libpng, and the file example.c summarizes it 267 * with some code on which to build. This file is useful for looking 268 * at the actual function definitions and structure components. If that 269 * file has been stripped from your copy of libpng, you can find it at 270 * <http://www.libpng.org/pub/png/libpng-manual.txt> 271 * 272 * If you just need to read a PNG file and don't want to read the documentation 273 * skip to the end of this file and read the section entitled 'simplified API'. 274 */ 275 276 /* Version information for png.h - this should match the version in png.c */ 277 #define PNG_LIBPNG_VER_STRING "1.6.53" 278 #define PNG_HEADER_VERSION_STRING " libpng version " PNG_LIBPNG_VER_STRING "\n" 279 280 /* The versions of shared library builds should stay in sync, going forward */ 281 #define PNG_LIBPNG_VER_SHAREDLIB 16 282 #define PNG_LIBPNG_VER_SONUM PNG_LIBPNG_VER_SHAREDLIB /* [Deprecated] */ 283 #define PNG_LIBPNG_VER_DLLNUM PNG_LIBPNG_VER_SHAREDLIB /* [Deprecated] */ 284 285 /* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */ 286 #define PNG_LIBPNG_VER_MAJOR 1 287 #define PNG_LIBPNG_VER_MINOR 6 288 #define PNG_LIBPNG_VER_RELEASE 53 289 290 /* This should be zero for a public release, or non-zero for a 291 * development version. 292 */ 293 #define PNG_LIBPNG_VER_BUILD 0 294 295 /* Release Status */ 296 #define PNG_LIBPNG_BUILD_ALPHA 1 297 #define PNG_LIBPNG_BUILD_BETA 2 298 #define PNG_LIBPNG_BUILD_RC 3 299 #define PNG_LIBPNG_BUILD_STABLE 4 300 #define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7 301 302 /* Release-Specific Flags */ 303 #define PNG_LIBPNG_BUILD_PATCH 8 /* Can be OR'ed with 304 PNG_LIBPNG_BUILD_STABLE only */ 305 #define PNG_LIBPNG_BUILD_PRIVATE 16 /* Cannot be OR'ed with 306 PNG_LIBPNG_BUILD_SPECIAL */ 307 #define PNG_LIBPNG_BUILD_SPECIAL 32 /* Cannot be OR'ed with 308 PNG_LIBPNG_BUILD_PRIVATE */ 309 310 #define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_STABLE 311 312 /* Careful here. At one time, Guy wanted to use 082, but that 313 * would be octal. We must not include leading zeros. 314 * Versions 0.7 through 1.0.0 were in the range 0 to 100 here 315 * (only version 1.0.0 was mis-numbered 100 instead of 10000). 316 * From version 1.0.1 it is: 317 * XXYYZZ, where XX=major, YY=minor, ZZ=release 318 */ 319 #define PNG_LIBPNG_VER 10653 /* 1.6.53 */ 320 321 /* Library configuration: these options cannot be changed after 322 * the library has been built. 323 */ 324 #ifndef PNGLCONF_H 325 /* If pnglibconf.h is missing, you can 326 * copy scripts/pnglibconf.h.prebuilt to pnglibconf.h 327 */ 328 # include "pnglibconf.h" 329 #endif 330 331 #define PNG_APNG_SUPPORTED 332 #define PNG_READ_APNG_SUPPORTED 333 #define PNG_WRITE_APNG_SUPPORTED 334 335 #ifndef PNG_VERSION_INFO_ONLY 336 /* Machine specific configuration. */ 337 # include "pngconf.h" 338 #endif 339 340 /* 341 * Added at libpng-1.2.8 342 * 343 * Ref MSDN: Private as priority over Special 344 * VS_FF_PRIVATEBUILD File *was not* built using standard release 345 * procedures. If this value is given, the StringFileInfo block must 346 * contain a PrivateBuild string. 347 * 348 * VS_FF_SPECIALBUILD File *was* built by the original company using 349 * standard release procedures but is a variation of the standard 350 * file of the same version number. If this value is given, the 351 * StringFileInfo block must contain a SpecialBuild string. 352 */ 353 354 #ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */ 355 # define PNG_LIBPNG_BUILD_TYPE \ 356 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE) 357 #else 358 # ifdef PNG_LIBPNG_SPECIALBUILD 359 # define PNG_LIBPNG_BUILD_TYPE \ 360 (PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL) 361 # else 362 # define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE) 363 # endif 364 #endif 365 366 #ifndef PNG_VERSION_INFO_ONLY 367 368 /* Inhibit C++ name-mangling for libpng functions but not for system calls. */ 369 #ifdef __cplusplus 370 extern "C" { 371 #endif /* __cplusplus */ 372 373 /* Version information for C files, stored in png.c. This had better match 374 * the version above. 375 */ 376 #define png_libpng_ver png_get_header_ver(NULL) 377 378 /* This file is arranged in several sections: 379 * 380 * 1. [omitted] 381 * 2. Any configuration options that can be specified by for the application 382 * code when it is built. (Build time configuration is in pnglibconf.h) 383 * 3. Type definitions (base types are defined in pngconf.h), structure 384 * definitions. 385 * 4. Exported library functions. 386 * 5. Simplified API. 387 * 6. Implementation options. 388 * 389 * The library source code has additional files (principally pngpriv.h) that 390 * allow configuration of the library. 391 */ 392 393 /* Section 1: [omitted] */ 394 395 /* Section 2: run time configuration 396 * See pnglibconf.h for build time configuration 397 * 398 * Run time configuration allows the application to choose between 399 * implementations of certain arithmetic APIs. The default is set 400 * at build time and recorded in pnglibconf.h, but it is safe to 401 * override these (and only these) settings. Note that this won't 402 * change what the library does, only application code, and the 403 * settings can (and probably should) be made on a per-file basis 404 * by setting the #defines before including png.h 405 * 406 * Use macros to read integers from PNG data or use the exported 407 * functions? 408 * PNG_USE_READ_MACROS: use the macros (see below) Note that 409 * the macros evaluate their argument multiple times. 410 * PNG_NO_USE_READ_MACROS: call the relevant library function. 411 * 412 * Use the alternative algorithm for compositing alpha samples that 413 * does not use division? 414 * PNG_READ_COMPOSITE_NODIV_SUPPORTED: use the 'no division' 415 * algorithm. 416 * PNG_NO_READ_COMPOSITE_NODIV: use the 'division' algorithm. 417 * 418 * How to handle benign errors if PNG_ALLOW_BENIGN_ERRORS is 419 * false? 420 * PNG_ALLOW_BENIGN_ERRORS: map calls to the benign error 421 * APIs to png_warning. 422 * Otherwise the calls are mapped to png_error. 423 */ 424 425 /* Section 3: type definitions, including structures and compile time 426 * constants. 427 * See pngconf.h for base types that vary by machine/system 428 */ 429 430 #ifdef PNG_APNG_SUPPORTED 431 /* dispose_op flags from inside fcTL */ 432 #define PNG_DISPOSE_OP_NONE 0x00 433 #define PNG_DISPOSE_OP_BACKGROUND 0x01 434 #define PNG_DISPOSE_OP_PREVIOUS 0x02 435 436 /* blend_op flags from inside fcTL */ 437 #define PNG_BLEND_OP_SOURCE 0x00 438 #define PNG_BLEND_OP_OVER 0x01 439 #endif /* APNG */ 440 441 /* This triggers a compiler error in png.c, if png.c and png.h 442 * do not agree upon the version number. 443 */ 444 typedef char* png_libpng_version_1_6_53; 445 446 /* Basic control structions. Read libpng-manual.txt or libpng.3 for more info. 447 * 448 * png_struct is the cache of information used while reading or writing a single 449 * PNG file. One of these is always required, although the simplified API 450 * (below) hides the creation and destruction of it. 451 */ 452 typedef struct png_struct_def png_struct; 453 typedef const png_struct * png_const_structp; 454 typedef png_struct * png_structp; 455 typedef png_struct * * png_structpp; 456 457 /* png_info contains information read from or to be written to a PNG file. One 458 * or more of these must exist while reading or creating a PNG file. The 459 * information is not used by libpng during read but is used to control what 460 * gets written when a PNG file is created. "png_get_" function calls read 461 * information during read and "png_set_" functions calls write information 462 * when creating a PNG. 463 * been moved into a separate header file that is not accessible to 464 * applications. Read libpng-manual.txt or libpng.3 for more info. 465 */ 466 typedef struct png_info_def png_info; 467 typedef png_info * png_infop; 468 typedef const png_info * png_const_infop; 469 typedef png_info * * png_infopp; 470 471 /* Types with names ending 'p' are pointer types. The corresponding types with 472 * names ending 'rp' are identical pointer types except that the pointer is 473 * marked 'restrict', which means that it is the only pointer to the object 474 * passed to the function. Applications should not use the 'restrict' types; 475 * it is always valid to pass 'p' to a pointer with a function argument of the 476 * corresponding 'rp' type. Different compilers have different rules with 477 * regard to type matching in the presence of 'restrict'. For backward 478 * compatibility libpng callbacks never have 'restrict' in their parameters and, 479 * consequentially, writing portable application code is extremely difficult if 480 * an attempt is made to use 'restrict'. 481 */ 482 typedef png_struct * PNG_RESTRICT png_structrp; 483 typedef const png_struct * PNG_RESTRICT png_const_structrp; 484 typedef png_info * PNG_RESTRICT png_inforp; 485 typedef const png_info * PNG_RESTRICT png_const_inforp; 486 487 /* Three color definitions. The order of the red, green, and blue, (and the 488 * exact size) is not important, although the size of the fields need to 489 * be png_byte or png_uint_16 (as defined below). 490 */ 491 typedef struct png_color_struct 492 { 493 png_byte red; 494 png_byte green; 495 png_byte blue; 496 } png_color; 497 typedef png_color * png_colorp; 498 typedef const png_color * png_const_colorp; 499 typedef png_color * * png_colorpp; 500 501 typedef struct png_color_16_struct 502 { 503 png_byte index; /* used for palette files */ 504 png_uint_16 red; /* for use in red green blue files */ 505 png_uint_16 green; 506 png_uint_16 blue; 507 png_uint_16 gray; /* for use in grayscale files */ 508 } png_color_16; 509 typedef png_color_16 * png_color_16p; 510 typedef const png_color_16 * png_const_color_16p; 511 typedef png_color_16 * * png_color_16pp; 512 513 typedef struct png_color_8_struct 514 { 515 png_byte red; /* for use in red green blue files */ 516 png_byte green; 517 png_byte blue; 518 png_byte gray; /* for use in grayscale files */ 519 png_byte alpha; /* for alpha channel files */ 520 } png_color_8; 521 typedef png_color_8 * png_color_8p; 522 typedef const png_color_8 * png_const_color_8p; 523 typedef png_color_8 * * png_color_8pp; 524 525 /* 526 * The following two structures are used for the in-core representation 527 * of sPLT chunks. 528 */ 529 typedef struct png_sPLT_entry_struct 530 { 531 png_uint_16 red; 532 png_uint_16 green; 533 png_uint_16 blue; 534 png_uint_16 alpha; 535 png_uint_16 frequency; 536 } png_sPLT_entry; 537 typedef png_sPLT_entry * png_sPLT_entryp; 538 typedef const png_sPLT_entry * png_const_sPLT_entryp; 539 typedef png_sPLT_entry * * png_sPLT_entrypp; 540 541 /* When the depth of the sPLT palette is 8 bits, the color and alpha samples 542 * occupy the LSB of their respective members, and the MSB of each member 543 * is zero-filled. The frequency member always occupies the full 16 bits. 544 */ 545 546 typedef struct png_sPLT_struct 547 { 548 png_charp name; /* palette name */ 549 png_byte depth; /* depth of palette samples */ 550 png_sPLT_entryp entries; /* palette entries */ 551 png_int_32 nentries; /* number of palette entries */ 552 } png_sPLT_t; 553 typedef png_sPLT_t * png_sPLT_tp; 554 typedef const png_sPLT_t * png_const_sPLT_tp; 555 typedef png_sPLT_t * * png_sPLT_tpp; 556 557 #ifdef PNG_TEXT_SUPPORTED 558 /* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file, 559 * and whether that contents is compressed or not. The "key" field 560 * points to a regular zero-terminated C string. The "text" fields can be a 561 * regular C string, an empty string, or a NULL pointer. 562 * However, the structure returned by png_get_text() will always contain 563 * the "text" field as a regular zero-terminated C string (possibly 564 * empty), never a NULL pointer, so it can be safely used in printf() and 565 * other string-handling functions. Note that the "itxt_length", "lang", and 566 * "lang_key" members of the structure only exist when the library is built 567 * with iTXt chunk support. Prior to libpng-1.4.0 the library was built by 568 * default without iTXt support. Also note that when iTXt *is* supported, 569 * the "lang" and "lang_key" fields contain NULL pointers when the 570 * "compression" field contains * PNG_TEXT_COMPRESSION_NONE or 571 * PNG_TEXT_COMPRESSION_zTXt. Note that the "compression value" is not the 572 * same as what appears in the PNG tEXt/zTXt/iTXt chunk's "compression flag" 573 * which is always 0 or 1, or its "compression method" which is always 0. 574 */ 575 typedef struct png_text_struct 576 { 577 int compression; /* compression value: 578 -1: tEXt, none 579 0: zTXt, deflate 580 1: iTXt, none 581 2: iTXt, deflate */ 582 png_charp key; /* keyword, 1-79 character description of "text" */ 583 png_charp text; /* comment, may be an empty string (ie "") 584 or a NULL pointer */ 585 size_t text_length; /* length of the text string */ 586 size_t itxt_length; /* length of the itxt string */ 587 png_charp lang; /* language code, 0-79 characters 588 or a NULL pointer */ 589 png_charp lang_key; /* keyword translated UTF-8 string, 0 or more 590 chars or a NULL pointer */ 591 } png_text; 592 typedef png_text * png_textp; 593 typedef const png_text * png_const_textp; 594 typedef png_text * * png_textpp; 595 #endif 596 597 /* Supported compression types for text in PNG files (tEXt, and zTXt). 598 * The values of the PNG_TEXT_COMPRESSION_ defines should NOT be changed. */ 599 #define PNG_TEXT_COMPRESSION_NONE_WR -3 600 #define PNG_TEXT_COMPRESSION_zTXt_WR -2 601 #define PNG_TEXT_COMPRESSION_NONE -1 602 #define PNG_TEXT_COMPRESSION_zTXt 0 603 #define PNG_ITXT_COMPRESSION_NONE 1 604 #define PNG_ITXT_COMPRESSION_zTXt 2 605 #define PNG_TEXT_COMPRESSION_LAST 3 /* Not a valid value */ 606 607 /* png_time is a way to hold the time in an machine independent way. 608 * Two conversions are provided, both from time_t and struct tm. There 609 * is no portable way to convert to either of these structures, as far 610 * as I know. If you know of a portable way, send it to me. As a side 611 * note - PNG has always been Year 2000 compliant! 612 */ 613 typedef struct png_time_struct 614 { 615 png_uint_16 year; /* full year, as in, 1995 */ 616 png_byte month; /* month of year, 1 - 12 */ 617 png_byte day; /* day of month, 1 - 31 */ 618 png_byte hour; /* hour of day, 0 - 23 */ 619 png_byte minute; /* minute of hour, 0 - 59 */ 620 png_byte second; /* second of minute, 0 - 60 (for leap seconds) */ 621 } png_time; 622 typedef png_time * png_timep; 623 typedef const png_time * png_const_timep; 624 typedef png_time * * png_timepp; 625 626 #if defined(PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED) ||\ 627 defined(PNG_USER_CHUNKS_SUPPORTED) 628 /* png_unknown_chunk is a structure to hold queued chunks for which there is 629 * no specific support. The idea is that we can use this to queue 630 * up private chunks for output even though the library doesn't actually 631 * know about their semantics. 632 * 633 * The data in the structure is set by libpng on read and used on write. 634 */ 635 typedef struct png_unknown_chunk_t 636 { 637 png_byte name[5]; /* Textual chunk name with '\0' terminator */ 638 png_byte *data; /* Data, should not be modified on read! */ 639 size_t size; 640 641 /* On write 'location' must be set using the flag values listed below. 642 * Notice that on read it is set by libpng however the values stored have 643 * more bits set than are listed below. Always treat the value as a 644 * bitmask. On write set only one bit - setting multiple bits may cause the 645 * chunk to be written in multiple places. 646 */ 647 png_byte location; /* mode of operation at read time */ 648 } 649 png_unknown_chunk; 650 651 typedef png_unknown_chunk * png_unknown_chunkp; 652 typedef const png_unknown_chunk * png_const_unknown_chunkp; 653 typedef png_unknown_chunk * * png_unknown_chunkpp; 654 #endif 655 656 /* Flag values for the unknown chunk location byte. */ 657 #define PNG_HAVE_IHDR 0x01 658 #define PNG_HAVE_PLTE 0x02 659 #define PNG_AFTER_IDAT 0x08 660 661 /* Maximum positive integer used in PNG is (2^31)-1 */ 662 #define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL) 663 #define PNG_UINT_32_MAX ((png_uint_32)(-1)) 664 #define PNG_SIZE_MAX ((size_t)(-1)) 665 666 /* These are constants for fixed point values encoded in the 667 * PNG specification manner (x100000) 668 */ 669 #define PNG_FP_1 100000 670 #define PNG_FP_HALF 50000 671 #define PNG_FP_MAX ((png_fixed_point)0x7fffffffL) 672 #define PNG_FP_MIN (-PNG_FP_MAX) 673 674 /* These describe the color_type field in png_info. */ 675 /* color type masks */ 676 #define PNG_COLOR_MASK_PALETTE 1 677 #define PNG_COLOR_MASK_COLOR 2 678 #define PNG_COLOR_MASK_ALPHA 4 679 680 /* color types. Note that not all combinations are legal */ 681 #define PNG_COLOR_TYPE_GRAY 0 682 #define PNG_COLOR_TYPE_PALETTE (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE) 683 #define PNG_COLOR_TYPE_RGB (PNG_COLOR_MASK_COLOR) 684 #define PNG_COLOR_TYPE_RGB_ALPHA (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA) 685 #define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA) 686 /* aliases */ 687 #define PNG_COLOR_TYPE_RGBA PNG_COLOR_TYPE_RGB_ALPHA 688 #define PNG_COLOR_TYPE_GA PNG_COLOR_TYPE_GRAY_ALPHA 689 690 /* This is for compression type. PNG 1.0-1.2 only define the single type. */ 691 #define PNG_COMPRESSION_TYPE_BASE 0 /* Deflate method 8, 32K window */ 692 #define PNG_COMPRESSION_TYPE_DEFAULT PNG_COMPRESSION_TYPE_BASE 693 694 /* This is for filter type. PNG 1.0-1.2 only define the single type. */ 695 #define PNG_FILTER_TYPE_BASE 0 /* Single row per-byte filtering */ 696 #define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */ 697 #define PNG_FILTER_TYPE_DEFAULT PNG_FILTER_TYPE_BASE 698 699 /* These are for the interlacing type. These values should NOT be changed. */ 700 #define PNG_INTERLACE_NONE 0 /* Non-interlaced image */ 701 #define PNG_INTERLACE_ADAM7 1 /* Adam7 interlacing */ 702 #define PNG_INTERLACE_LAST 2 /* Not a valid value */ 703 704 /* These are for the oFFs chunk. These values should NOT be changed. */ 705 #define PNG_OFFSET_PIXEL 0 /* Offset in pixels */ 706 #define PNG_OFFSET_MICROMETER 1 /* Offset in micrometers (1/10^6 meter) */ 707 #define PNG_OFFSET_LAST 2 /* Not a valid value */ 708 709 /* These are for the pCAL chunk. These values should NOT be changed. */ 710 #define PNG_EQUATION_LINEAR 0 /* Linear transformation */ 711 #define PNG_EQUATION_BASE_E 1 /* Exponential base e transform */ 712 #define PNG_EQUATION_ARBITRARY 2 /* Arbitrary base exponential transform */ 713 #define PNG_EQUATION_HYPERBOLIC 3 /* Hyperbolic sine transformation */ 714 #define PNG_EQUATION_LAST 4 /* Not a valid value */ 715 716 /* These are for the sCAL chunk. These values should NOT be changed. */ 717 #define PNG_SCALE_UNKNOWN 0 /* unknown unit (image scale) */ 718 #define PNG_SCALE_METER 1 /* meters per pixel */ 719 #define PNG_SCALE_RADIAN 2 /* radians per pixel */ 720 #define PNG_SCALE_LAST 3 /* Not a valid value */ 721 722 /* These are for the pHYs chunk. These values should NOT be changed. */ 723 #define PNG_RESOLUTION_UNKNOWN 0 /* pixels/unknown unit (aspect ratio) */ 724 #define PNG_RESOLUTION_METER 1 /* pixels/meter */ 725 #define PNG_RESOLUTION_LAST 2 /* Not a valid value */ 726 727 /* These are for the sRGB chunk. These values should NOT be changed. */ 728 #define PNG_sRGB_INTENT_PERCEPTUAL 0 729 #define PNG_sRGB_INTENT_RELATIVE 1 730 #define PNG_sRGB_INTENT_SATURATION 2 731 #define PNG_sRGB_INTENT_ABSOLUTE 3 732 #define PNG_sRGB_INTENT_LAST 4 /* Not a valid value */ 733 734 /* This is for text chunks */ 735 #define PNG_KEYWORD_MAX_LENGTH 79 736 737 /* Maximum number of entries in PLTE/sPLT/tRNS arrays */ 738 #define PNG_MAX_PALETTE_LENGTH 256 739 740 /* These determine if an ancillary chunk's data has been successfully read 741 * from the PNG header, or if the application has filled in the corresponding 742 * data in the info_struct to be written into the output file. The values 743 * of the PNG_INFO_<chunk> defines should NOT be changed. 744 */ 745 #define PNG_INFO_gAMA 0x0001U 746 #define PNG_INFO_sBIT 0x0002U 747 #define PNG_INFO_cHRM 0x0004U 748 #define PNG_INFO_PLTE 0x0008U 749 #define PNG_INFO_tRNS 0x0010U 750 #define PNG_INFO_bKGD 0x0020U 751 #define PNG_INFO_hIST 0x0040U 752 #define PNG_INFO_pHYs 0x0080U 753 #define PNG_INFO_oFFs 0x0100U 754 #define PNG_INFO_tIME 0x0200U 755 #define PNG_INFO_pCAL 0x0400U 756 #define PNG_INFO_sRGB 0x0800U /* GR-P, 0.96a */ 757 #define PNG_INFO_iCCP 0x1000U /* ESR, 1.0.6 */ 758 #define PNG_INFO_sPLT 0x2000U /* ESR, 1.0.6 */ 759 #define PNG_INFO_sCAL 0x4000U /* ESR, 1.0.6 */ 760 #define PNG_INFO_IDAT 0x8000U /* ESR, 1.0.6 */ 761 #define PNG_INFO_eXIf 0x10000U /* GR-P, 1.6.31 */ 762 #define PNG_INFO_cICP 0x20000U /* PNGv3: 1.6.45 */ 763 #define PNG_INFO_cLLI 0x40000U /* PNGv3: 1.6.45 */ 764 #define PNG_INFO_mDCV 0x80000U /* PNGv3: 1.6.45 */ 765 /* APNG: these chunks are stored as unknown, these flags are never set 766 * however they are provided as a convenience for implementors of APNG and 767 * avoids any merge conflicts. 768 * 769 * Private chunks: these chunk names violate the chunk name recommendations 770 * because the chunk definitions have no signature and because the private 771 * chunks with these names have been reserved. Private definitions should 772 * avoid them. 773 */ 774 #define PNG_INFO_acTL 0x100000U /* PNGv3: 1.6.45: unknown */ 775 #define PNG_INFO_fcTL 0x200000U /* PNGv3: 1.6.45: unknown */ 776 #define PNG_INFO_fdAT 0x400000U /* PNGv3: 1.6.45: unknown */ 777 778 /* This is used for the transformation routines, as some of them 779 * change these values for the row. It also should enable using 780 * the routines for other purposes. 781 */ 782 typedef struct png_row_info_struct 783 { 784 png_uint_32 width; /* width of row */ 785 size_t rowbytes; /* number of bytes in row */ 786 png_byte color_type; /* color type of row */ 787 png_byte bit_depth; /* bit depth of row */ 788 png_byte channels; /* number of channels (1, 2, 3, or 4) */ 789 png_byte pixel_depth; /* bits per pixel (depth * channels) */ 790 } png_row_info; 791 792 typedef png_row_info * png_row_infop; 793 typedef png_row_info * * png_row_infopp; 794 795 /* These are the function types for the I/O functions and for the functions 796 * that allow the user to override the default I/O functions with his or her 797 * own. The png_error_ptr type should match that of user-supplied warning 798 * and error functions, while the png_rw_ptr type should match that of the 799 * user read/write data functions. Note that the 'write' function must not 800 * modify the buffer it is passed. The 'read' function, on the other hand, is 801 * expected to return the read data in the buffer. 802 */ 803 typedef PNG_CALLBACK(void, *png_error_ptr, (png_structp, png_const_charp)); 804 typedef PNG_CALLBACK(void, *png_rw_ptr, (png_structp, png_bytep, size_t)); 805 typedef PNG_CALLBACK(void, *png_flush_ptr, (png_structp)); 806 typedef PNG_CALLBACK(void, *png_read_status_ptr, (png_structp, png_uint_32, 807 int)); 808 typedef PNG_CALLBACK(void, *png_write_status_ptr, (png_structp, png_uint_32, 809 int)); 810 811 #ifdef PNG_PROGRESSIVE_READ_SUPPORTED 812 typedef PNG_CALLBACK(void, *png_progressive_info_ptr, (png_structp, png_infop)); 813 typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop)); 814 #ifdef PNG_APNG_SUPPORTED 815 typedef PNG_CALLBACK(void, *png_progressive_frame_ptr, (png_structp, 816 png_uint_32)); 817 #endif 818 819 /* The following callback receives png_uint_32 row_number, int pass for the 820 * png_bytep data of the row. When transforming an interlaced image the 821 * row number is the row number within the sub-image of the interlace pass, so 822 * the value will increase to the height of the sub-image (not the full image) 823 * then reset to 0 for the next pass. 824 * 825 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to 826 * find the output pixel (x,y) given an interlaced sub-image pixel 827 * (row,col,pass). (See below for these macros.) 828 */ 829 typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep, 830 png_uint_32, int)); 831 #endif 832 833 #if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \ 834 defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED) 835 typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop, 836 png_bytep)); 837 #endif 838 839 #ifdef PNG_USER_CHUNKS_SUPPORTED 840 typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp, 841 png_unknown_chunkp)); 842 #endif 843 #ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED 844 /* not used anywhere */ 845 /* typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp)); */ 846 #endif 847 848 #ifdef PNG_SETJMP_SUPPORTED 849 /* This must match the function definition in <setjmp.h>, and the application 850 * must include this before png.h to obtain the definition of jmp_buf. The 851 * function is required to be PNG_NORETURN, but this is not checked. If the 852 * function does return the application will crash via an abort() or similar 853 * system level call. 854 * 855 * If you get a warning here while building the library you may need to make 856 * changes to ensure that pnglibconf.h records the calling convention used by 857 * your compiler. This may be very difficult - try using a different compiler 858 * to build the library! 859 */ 860 PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), (jmp_buf, int), typedef); 861 #endif 862 863 /* Transform masks for the high-level interface */ 864 #define PNG_TRANSFORM_IDENTITY 0x0000 /* read and write */ 865 #define PNG_TRANSFORM_STRIP_16 0x0001 /* read only */ 866 #define PNG_TRANSFORM_STRIP_ALPHA 0x0002 /* read only */ 867 #define PNG_TRANSFORM_PACKING 0x0004 /* read and write */ 868 #define PNG_TRANSFORM_PACKSWAP 0x0008 /* read and write */ 869 #define PNG_TRANSFORM_EXPAND 0x0010 /* read only */ 870 #define PNG_TRANSFORM_INVERT_MONO 0x0020 /* read and write */ 871 #define PNG_TRANSFORM_SHIFT 0x0040 /* read and write */ 872 #define PNG_TRANSFORM_BGR 0x0080 /* read and write */ 873 #define PNG_TRANSFORM_SWAP_ALPHA 0x0100 /* read and write */ 874 #define PNG_TRANSFORM_SWAP_ENDIAN 0x0200 /* read and write */ 875 #define PNG_TRANSFORM_INVERT_ALPHA 0x0400 /* read and write */ 876 #define PNG_TRANSFORM_STRIP_FILLER 0x0800 /* write only */ 877 /* Added to libpng-1.2.34 */ 878 #define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER 879 #define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */ 880 /* Added to libpng-1.4.0 */ 881 #define PNG_TRANSFORM_GRAY_TO_RGB 0x2000 /* read only */ 882 /* Added to libpng-1.5.4 */ 883 #define PNG_TRANSFORM_EXPAND_16 0x4000 /* read only */ 884 #if ~0U > 0xffffU /* or else this might break on a 16-bit machine */ 885 #define PNG_TRANSFORM_SCALE_16 0x8000 /* read only */ 886 #endif 887 888 /* Flags for MNG supported features */ 889 #define PNG_FLAG_MNG_EMPTY_PLTE 0x01 890 #define PNG_FLAG_MNG_FILTER_64 0x04 891 #define PNG_ALL_MNG_FEATURES 0x05 892 893 /* NOTE: prior to 1.5 these functions had no 'API' style declaration, 894 * this allowed the zlib default functions to be used on Windows 895 * platforms. In 1.5 the zlib default malloc (which just calls malloc and 896 * ignores the first argument) should be completely compatible with the 897 * following. 898 */ 899 typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp, 900 png_alloc_size_t)); 901 typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp)); 902 903 /* Section 4: exported functions 904 * Here are the function definitions most commonly used. This is not 905 * the place to find out how to use libpng. See libpng-manual.txt for the 906 * full explanation, see example.c for the summary. This just provides 907 * a simple one line description of the use of each function. 908 * 909 * The PNG_EXPORT() and PNG_EXPORTA() macros used below are defined in 910 * pngconf.h and in the *.dfn files in the scripts directory. 911 * 912 * PNG_EXPORT(ordinal, type, name, (args)); 913 * 914 * ordinal: ordinal that is used while building 915 * *.def files. The ordinal value is only 916 * relevant when preprocessing png.h with 917 * the *.dfn files for building symbol table 918 * entries, and are removed by pngconf.h. 919 * type: return type of the function 920 * name: function name 921 * args: function arguments, with types 922 * 923 * When we wish to append attributes to a function prototype we use 924 * the PNG_EXPORTA() macro instead. 925 * 926 * PNG_EXPORTA(ordinal, type, name, (args), attributes); 927 * 928 * ordinal, type, name, and args: same as in PNG_EXPORT(). 929 * attributes: function attributes 930 */ 931 932 /* Returns the version number of the library */ 933 PNG_EXPORT(1, png_uint_32, png_access_version_number, (void)); 934 935 /* Tell lib we have already handled the first <num_bytes> magic bytes. 936 * Handling more than 8 bytes from the beginning of the file is an error. 937 */ 938 PNG_EXPORT(2, void, png_set_sig_bytes, (png_structrp png_ptr, int num_bytes)); 939 940 /* Check sig[start] through sig[start + num_to_check - 1] to see if it's a 941 * PNG file. Returns zero if the supplied bytes match the 8-byte PNG 942 * signature, and non-zero otherwise. Having num_to_check == 0 or 943 * start > 7 will always fail (i.e. return non-zero). 944 */ 945 PNG_EXPORT(3, int, png_sig_cmp, (png_const_bytep sig, size_t start, 946 size_t num_to_check)); 947 948 /* Simple signature checking function. This is the same as calling 949 * png_check_sig(sig, n) := (png_sig_cmp(sig, 0, n) == 0). 950 */ 951 #define png_check_sig(sig, n) (png_sig_cmp((sig), 0, (n)) == 0) /* DEPRECATED */ 952 953 /* Allocate and initialize png_ptr struct for reading, and any other memory. */ 954 PNG_EXPORTA(4, png_structp, png_create_read_struct, 955 (png_const_charp user_png_ver, png_voidp error_ptr, 956 png_error_ptr error_fn, png_error_ptr warn_fn), 957 PNG_ALLOCATED); 958 959 /* Allocate and initialize png_ptr struct for writing, and any other memory */ 960 PNG_EXPORTA(5, png_structp, png_create_write_struct, 961 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn, 962 png_error_ptr warn_fn), 963 PNG_ALLOCATED); 964 965 PNG_EXPORT(6, size_t, png_get_compression_buffer_size, 966 (png_const_structrp png_ptr)); 967 968 PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structrp png_ptr, 969 size_t size)); 970 971 /* Moved from pngconf.h in 1.4.0 and modified to ensure setjmp/longjmp 972 * match up. 973 */ 974 #ifdef PNG_SETJMP_SUPPORTED 975 /* This function returns the jmp_buf built in to *png_ptr. It must be 976 * supplied with an appropriate 'longjmp' function to use on that jmp_buf 977 * unless the default error function is overridden in which case NULL is 978 * acceptable. The size of the jmp_buf is checked against the actual size 979 * allocated by the library - the call will return NULL on a mismatch 980 * indicating an ABI mismatch. 981 */ 982 PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structrp png_ptr, 983 png_longjmp_ptr longjmp_fn, size_t jmp_buf_size)); 984 # define png_jmpbuf(png_ptr) \ 985 (*png_set_longjmp_fn((png_ptr), longjmp, (sizeof (jmp_buf)))) 986 #else 987 # define png_jmpbuf(png_ptr) \ 988 (LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP) 989 #endif 990 /* This function should be used by libpng applications in place of 991 * longjmp(png_ptr->jmpbuf, val). If longjmp_fn() has been set, it 992 * will use it; otherwise it will call PNG_ABORT(). This function was 993 * added in libpng-1.5.0. 994 */ 995 PNG_EXPORTA(9, void, png_longjmp, (png_const_structrp png_ptr, int val), 996 PNG_NORETURN); 997 998 #ifdef PNG_READ_SUPPORTED 999 /* Reset the compression stream */ 1000 PNG_EXPORTA(10, int, png_reset_zstream, (png_structrp png_ptr), PNG_DEPRECATED); 1001 #endif 1002 1003 /* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */ 1004 #ifdef PNG_USER_MEM_SUPPORTED 1005 PNG_EXPORTA(11, png_structp, png_create_read_struct_2, 1006 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn, 1007 png_error_ptr warn_fn, 1008 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn), 1009 PNG_ALLOCATED); 1010 PNG_EXPORTA(12, png_structp, png_create_write_struct_2, 1011 (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn, 1012 png_error_ptr warn_fn, 1013 png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn), 1014 PNG_ALLOCATED); 1015 #endif 1016 1017 /* Write the PNG file signature. */ 1018 PNG_EXPORT(13, void, png_write_sig, (png_structrp png_ptr)); 1019 1020 /* Write a PNG chunk - size, type, (optional) data, CRC. */ 1021 PNG_EXPORT(14, void, png_write_chunk, (png_structrp png_ptr, png_const_bytep 1022 chunk_name, png_const_bytep data, size_t length)); 1023 1024 /* Write the start of a PNG chunk - length and chunk name. */ 1025 PNG_EXPORT(15, void, png_write_chunk_start, (png_structrp png_ptr, 1026 png_const_bytep chunk_name, png_uint_32 length)); 1027 1028 /* Write the data of a PNG chunk started with png_write_chunk_start(). */ 1029 PNG_EXPORT(16, void, png_write_chunk_data, (png_structrp png_ptr, 1030 png_const_bytep data, size_t length)); 1031 1032 /* Finish a chunk started with png_write_chunk_start() (includes CRC). */ 1033 PNG_EXPORT(17, void, png_write_chunk_end, (png_structrp png_ptr)); 1034 1035 /* Allocate and initialize the info structure */ 1036 PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_const_structrp png_ptr), 1037 PNG_ALLOCATED); 1038 1039 /* DEPRECATED: this function allowed init structures to be created using the 1040 * default allocation method (typically malloc). Use is deprecated in 1.6.0 and 1041 * the API will be removed in the future. 1042 */ 1043 PNG_EXPORTA(19, void, png_info_init_3, (png_infopp info_ptr, 1044 size_t png_info_struct_size), PNG_DEPRECATED); 1045 1046 /* Writes all the PNG information before the image. */ 1047 PNG_EXPORT(20, void, png_write_info_before_PLTE, 1048 (png_structrp png_ptr, png_const_inforp info_ptr)); 1049 PNG_EXPORT(21, void, png_write_info, 1050 (png_structrp png_ptr, png_const_inforp info_ptr)); 1051 1052 #ifdef PNG_SEQUENTIAL_READ_SUPPORTED 1053 /* Read the information before the actual image data. */ 1054 PNG_EXPORT(22, void, png_read_info, 1055 (png_structrp png_ptr, png_inforp info_ptr)); 1056 #endif 1057 1058 #ifdef PNG_TIME_RFC1123_SUPPORTED 1059 /* Convert to a US string format: there is no localization support in this 1060 * routine. The original implementation used a 29 character buffer in 1061 * png_struct, this will be removed in future versions. 1062 */ 1063 #if PNG_LIBPNG_VER < 10700 1064 /* To do: remove this from libpng17 (and from libpng17/png.c and pngstruct.h) */ 1065 PNG_EXPORTA(23, png_const_charp, png_convert_to_rfc1123, (png_structrp png_ptr, 1066 png_const_timep ptime),PNG_DEPRECATED); 1067 #endif 1068 PNG_EXPORT(241, int, png_convert_to_rfc1123_buffer, (char out[29], 1069 png_const_timep ptime)); 1070 #endif 1071 1072 #ifdef PNG_CONVERT_tIME_SUPPORTED 1073 /* Convert from a struct tm to png_time */ 1074 PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime, 1075 const struct tm * ttime)); 1076 1077 /* Convert from time_t to png_time. Uses gmtime() */ 1078 PNG_EXPORT(25, void, png_convert_from_time_t, (png_timep ptime, time_t ttime)); 1079 #endif /* CONVERT_tIME */ 1080 1081 #ifdef PNG_READ_EXPAND_SUPPORTED 1082 /* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */ 1083 PNG_EXPORT(26, void, png_set_expand, (png_structrp png_ptr)); 1084 PNG_EXPORT(27, void, png_set_expand_gray_1_2_4_to_8, (png_structrp png_ptr)); 1085 PNG_EXPORT(28, void, png_set_palette_to_rgb, (png_structrp png_ptr)); 1086 PNG_EXPORT(29, void, png_set_tRNS_to_alpha, (png_structrp png_ptr)); 1087 #endif 1088 1089 #ifdef PNG_READ_EXPAND_16_SUPPORTED 1090 /* Expand to 16-bit channels, forces conversion of palette to RGB and expansion 1091 * of a tRNS chunk if present. 1092 */ 1093 PNG_EXPORT(221, void, png_set_expand_16, (png_structrp png_ptr)); 1094 #endif 1095 1096 #if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED) 1097 /* Use blue, green, red order for pixels. */ 1098 PNG_EXPORT(30, void, png_set_bgr, (png_structrp png_ptr)); 1099 #endif 1100 1101 #ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED 1102 /* Expand the grayscale to 24-bit RGB if necessary. */ 1103 PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structrp png_ptr)); 1104 #endif 1105 1106 #ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED 1107 /* Reduce RGB to grayscale. */ 1108 #define PNG_ERROR_ACTION_NONE 1 1109 #define PNG_ERROR_ACTION_WARN 2 1110 #define PNG_ERROR_ACTION_ERROR 3 1111 #define PNG_RGB_TO_GRAY_DEFAULT (-1)/*for red/green coefficients*/ 1112 1113 PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structrp png_ptr, 1114 int error_action, double red, double green)) 1115 PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structrp png_ptr, 1116 int error_action, png_fixed_point red, png_fixed_point green)) 1117 1118 PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structrp 1119 png_ptr)); 1120 #endif 1121 1122 #ifdef PNG_BUILD_GRAYSCALE_PALETTE_SUPPORTED 1123 PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth, 1124 png_colorp palette)); 1125 #endif 1126 1127 #ifdef PNG_READ_ALPHA_MODE_SUPPORTED 1128 /* How the alpha channel is interpreted - this affects how the color channels 1129 * of a PNG file are returned to the calling application when an alpha channel, 1130 * or a tRNS chunk in a palette file, is present. 1131 * 1132 * This has no effect on the way pixels are written into a PNG output 1133 * datastream. The color samples in a PNG datastream are never premultiplied 1134 * with the alpha samples. 1135 * 1136 * The default is to return data according to the PNG specification: the alpha 1137 * channel is a linear measure of the contribution of the pixel to the 1138 * corresponding composited pixel, and the color channels are unassociated 1139 * (not premultiplied). The gamma encoded color channels must be scaled 1140 * according to the contribution and to do this it is necessary to undo 1141 * the encoding, scale the color values, perform the composition and re-encode 1142 * the values. This is the 'PNG' mode. 1143 * 1144 * The alternative is to 'associate' the alpha with the color information by 1145 * storing color channel values that have been scaled by the alpha. 1146 * image. These are the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' modes 1147 * (the latter being the two common names for associated alpha color channels). 1148 * 1149 * For the 'OPTIMIZED' mode, a pixel is treated as opaque only if the alpha 1150 * value is equal to the maximum value. 1151 * 1152 * The final choice is to gamma encode the alpha channel as well. This is 1153 * broken because, in practice, no implementation that uses this choice 1154 * correctly undoes the encoding before handling alpha composition. Use this 1155 * choice only if other serious errors in the software or hardware you use 1156 * mandate it; the typical serious error is for dark halos to appear around 1157 * opaque areas of the composited PNG image because of arithmetic overflow. 1158 * 1159 * The API function png_set_alpha_mode specifies which of these choices to use 1160 * with an enumerated 'mode' value and the gamma of the required output: 1161 */ 1162 #define PNG_ALPHA_PNG 0 /* according to the PNG standard */ 1163 #define PNG_ALPHA_STANDARD 1 /* according to Porter/Duff */ 1164 #define PNG_ALPHA_ASSOCIATED 1 /* as above; this is the normal practice */ 1165 #define PNG_ALPHA_PREMULTIPLIED 1 /* as above */ 1166 #define PNG_ALPHA_OPTIMIZED 2 /* 'PNG' for opaque pixels, else 'STANDARD' */ 1167 #define PNG_ALPHA_BROKEN 3 /* the alpha channel is gamma encoded */ 1168 1169 PNG_FP_EXPORT(227, void, png_set_alpha_mode, (png_structrp png_ptr, int mode, 1170 double output_gamma)) 1171 PNG_FIXED_EXPORT(228, void, png_set_alpha_mode_fixed, (png_structrp png_ptr, 1172 int mode, png_fixed_point output_gamma)) 1173 #endif 1174 1175 #if defined(PNG_GAMMA_SUPPORTED) || defined(PNG_READ_ALPHA_MODE_SUPPORTED) 1176 /* The output_gamma value is a screen gamma in libpng terminology: it expresses 1177 * how to decode the output values, not how they are encoded. 1178 */ 1179 #define PNG_DEFAULT_sRGB -1 /* sRGB gamma and color space */ 1180 #define PNG_GAMMA_MAC_18 -2 /* Old Mac '1.8' gamma and color space */ 1181 #define PNG_GAMMA_sRGB 220000 /* Television standards--matches sRGB gamma */ 1182 #define PNG_GAMMA_LINEAR PNG_FP_1 /* Linear */ 1183 #endif 1184 1185 /* The following are examples of calls to png_set_alpha_mode to achieve the 1186 * required overall gamma correction and, where necessary, alpha 1187 * premultiplication. 1188 * 1189 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB); 1190 * This is the default libpng handling of the alpha channel - it is not 1191 * pre-multiplied into the color components. In addition the call states 1192 * that the output is for a sRGB system and causes all PNG files without gAMA 1193 * chunks to be assumed to be encoded using sRGB. 1194 * 1195 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC); 1196 * In this case the output is assumed to be something like an sRGB conformant 1197 * display preceded by a power-law lookup table of power 1.45. This is how 1198 * early Mac systems behaved. 1199 * 1200 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR); 1201 * This is the classic Jim Blinn approach and will work in academic 1202 * environments where everything is done by the book. It has the shortcoming 1203 * of assuming that input PNG data with no gamma information is linear - this 1204 * is unlikely to be correct unless the PNG files where generated locally. 1205 * Most of the time the output precision will be so low as to show 1206 * significant banding in dark areas of the image. 1207 * 1208 * png_set_expand_16(pp); 1209 * png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB); 1210 * This is a somewhat more realistic Jim Blinn inspired approach. PNG files 1211 * are assumed to have the sRGB encoding if not marked with a gamma value and 1212 * the output is always 16 bits per component. This permits accurate scaling 1213 * and processing of the data. If you know that your input PNG files were 1214 * generated locally you might need to replace PNG_DEFAULT_sRGB with the 1215 * correct value for your system. 1216 * 1217 * png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB); 1218 * If you just need to composite the PNG image onto an existing background 1219 * and if you control the code that does this you can use the optimization 1220 * setting. In this case you just copy completely opaque pixels to the 1221 * output. For pixels that are not completely transparent (you just skip 1222 * those) you do the composition math using png_composite or png_composite_16 1223 * below then encode the resultant 8-bit or 16-bit values to match the output 1224 * encoding. 1225 * 1226 * Other cases 1227 * If neither the PNG nor the standard linear encoding work for you because 1228 * of the software or hardware you use then you have a big problem. The PNG 1229 * case will probably result in halos around the image. The linear encoding 1230 * will probably result in a washed out, too bright, image (it's actually too 1231 * contrasty.) Try the ALPHA_OPTIMIZED mode above - this will probably 1232 * substantially reduce the halos. Alternatively try: 1233 * 1234 * png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB); 1235 * This option will also reduce the halos, but there will be slight dark 1236 * halos round the opaque parts of the image where the background is light. 1237 * In the OPTIMIZED mode the halos will be light halos where the background 1238 * is dark. Take your pick - the halos are unavoidable unless you can get 1239 * your hardware/software fixed! (The OPTIMIZED approach is slightly 1240 * faster.) 1241 * 1242 * When the default gamma of PNG files doesn't match the output gamma. 1243 * If you have PNG files with no gamma information png_set_alpha_mode allows 1244 * you to provide a default gamma, but it also sets the output gamma to the 1245 * matching value. If you know your PNG files have a gamma that doesn't 1246 * match the output you can take advantage of the fact that 1247 * png_set_alpha_mode always sets the output gamma but only sets the PNG 1248 * default if it is not already set: 1249 * 1250 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB); 1251 * png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC); 1252 * The first call sets both the default and the output gamma values, the 1253 * second call overrides the output gamma without changing the default. This 1254 * is easier than achieving the same effect with png_set_gamma. You must use 1255 * PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will 1256 * fire if more than one call to png_set_alpha_mode and png_set_background is 1257 * made in the same read operation, however multiple calls with PNG_ALPHA_PNG 1258 * are ignored. 1259 */ 1260 1261 #ifdef PNG_READ_STRIP_ALPHA_SUPPORTED 1262 PNG_EXPORT(36, void, png_set_strip_alpha, (png_structrp png_ptr)); 1263 #endif 1264 1265 #if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \ 1266 defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED) 1267 PNG_EXPORT(37, void, png_set_swap_alpha, (png_structrp png_ptr)); 1268 #endif 1269 1270 #if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \ 1271 defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED) 1272 PNG_EXPORT(38, void, png_set_invert_alpha, (png_structrp png_ptr)); 1273 #endif 1274 1275 #if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED) 1276 /* Add a filler byte to 8-bit or 16-bit Gray or 24-bit or 48-bit RGB images. */ 1277 PNG_EXPORT(39, void, png_set_filler, (png_structrp png_ptr, png_uint_32 filler, 1278 int flags)); 1279 /* The values of the PNG_FILLER_ defines should NOT be changed */ 1280 # define PNG_FILLER_BEFORE 0 1281 # define PNG_FILLER_AFTER 1 1282 /* Add an alpha byte to 8-bit or 16-bit Gray or 24-bit or 48-bit RGB images. */ 1283 PNG_EXPORT(40, void, png_set_add_alpha, (png_structrp png_ptr, 1284 png_uint_32 filler, int flags)); 1285 #endif /* READ_FILLER || WRITE_FILLER */ 1286 1287 #if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED) 1288 /* Swap bytes in 16-bit depth files. */ 1289 PNG_EXPORT(41, void, png_set_swap, (png_structrp png_ptr)); 1290 #endif 1291 1292 #if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED) 1293 /* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */ 1294 PNG_EXPORT(42, void, png_set_packing, (png_structrp png_ptr)); 1295 #endif 1296 1297 #if defined(PNG_READ_PACKSWAP_SUPPORTED) || \ 1298 defined(PNG_WRITE_PACKSWAP_SUPPORTED) 1299 /* Swap packing order of pixels in bytes. */ 1300 PNG_EXPORT(43, void, png_set_packswap, (png_structrp png_ptr)); 1301 #endif 1302 1303 #if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED) 1304 /* Converts files to legal bit depths. */ 1305 PNG_EXPORT(44, void, png_set_shift, (png_structrp png_ptr, png_const_color_8p 1306 true_bits)); 1307 #endif 1308 1309 #if defined(PNG_READ_INTERLACING_SUPPORTED) || \ 1310 defined(PNG_WRITE_INTERLACING_SUPPORTED) 1311 /* Have the code handle the interlacing. Returns the number of passes. 1312 * MUST be called before png_read_update_info or png_start_read_image, 1313 * otherwise it will not have the desired effect. Note that it is still 1314 * necessary to call png_read_row or png_read_rows png_get_image_height 1315 * times for each pass. 1316 */ 1317 PNG_EXPORT(45, int, png_set_interlace_handling, (png_structrp png_ptr)); 1318 #endif 1319 1320 #if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED) 1321 /* Invert monochrome files */ 1322 PNG_EXPORT(46, void, png_set_invert_mono, (png_structrp png_ptr)); 1323 #endif 1324 1325 #ifdef PNG_READ_BACKGROUND_SUPPORTED 1326 /* Handle alpha and tRNS by replacing with a background color. Prior to 1327 * libpng-1.5.4 this API must not be called before the PNG file header has been 1328 * read. Doing so will result in unexpected behavior and possible warnings or 1329 * errors if the PNG file contains a bKGD chunk. 1330 */ 1331 PNG_FP_EXPORT(47, void, png_set_background, (png_structrp png_ptr, 1332 png_const_color_16p background_color, int background_gamma_code, 1333 int need_expand, double background_gamma)) 1334 PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structrp png_ptr, 1335 png_const_color_16p background_color, int background_gamma_code, 1336 int need_expand, png_fixed_point background_gamma)) 1337 #endif 1338 #ifdef PNG_READ_BACKGROUND_SUPPORTED 1339 # define PNG_BACKGROUND_GAMMA_UNKNOWN 0 1340 # define PNG_BACKGROUND_GAMMA_SCREEN 1 1341 # define PNG_BACKGROUND_GAMMA_FILE 2 1342 # define PNG_BACKGROUND_GAMMA_UNIQUE 3 1343 #endif 1344 1345 #ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED 1346 /* Scale a 16-bit depth file down to 8-bit, accurately. */ 1347 PNG_EXPORT(229, void, png_set_scale_16, (png_structrp png_ptr)); 1348 #endif 1349 1350 #ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED 1351 #define PNG_READ_16_TO_8_SUPPORTED /* Name prior to 1.5.4 */ 1352 /* Strip the second byte of information from a 16-bit depth file. */ 1353 PNG_EXPORT(48, void, png_set_strip_16, (png_structrp png_ptr)); 1354 #endif 1355 1356 #ifdef PNG_READ_QUANTIZE_SUPPORTED 1357 /* Turn on quantizing, and reduce the palette to the number of colors 1358 * available. 1359 */ 1360 PNG_EXPORT(49, void, png_set_quantize, (png_structrp png_ptr, 1361 png_colorp palette, int num_palette, int maximum_colors, 1362 png_const_uint_16p histogram, int full_quantize)); 1363 #endif 1364 1365 #ifdef PNG_READ_GAMMA_SUPPORTED 1366 /* The threshold on gamma processing is configurable but hard-wired into the 1367 * library. The following is the floating point variant. 1368 */ 1369 #define PNG_GAMMA_THRESHOLD (PNG_GAMMA_THRESHOLD_FIXED*.00001) 1370 1371 /* Handle gamma correction. Screen_gamma=(display_exponent). 1372 * NOTE: this API simply sets the screen and file gamma values. It will 1373 * therefore override the value for gamma in a PNG file if it is called after 1374 * the file header has been read - use with care - call before reading the PNG 1375 * file for best results! 1376 * 1377 * These routines accept the same gamma values as png_set_alpha_mode (described 1378 * above). The PNG_GAMMA_ defines and PNG_DEFAULT_sRGB can be passed to either 1379 * API (floating point or fixed.) Notice, however, that the 'file_gamma' value 1380 * is the inverse of a 'screen gamma' value. 1381 */ 1382 PNG_FP_EXPORT(50, void, png_set_gamma, (png_structrp png_ptr, 1383 double screen_gamma, double override_file_gamma)) 1384 PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structrp png_ptr, 1385 png_fixed_point screen_gamma, png_fixed_point override_file_gamma)) 1386 #endif 1387 1388 #ifdef PNG_WRITE_FLUSH_SUPPORTED 1389 /* Set how many lines between output flushes - 0 for no flushing */ 1390 PNG_EXPORT(51, void, png_set_flush, (png_structrp png_ptr, int nrows)); 1391 /* Flush the current PNG output buffer */ 1392 PNG_EXPORT(52, void, png_write_flush, (png_structrp png_ptr)); 1393 #endif 1394 1395 /* Optional update palette with requested transformations */ 1396 PNG_EXPORT(53, void, png_start_read_image, (png_structrp png_ptr)); 1397 1398 /* Optional call to update the users info structure */ 1399 PNG_EXPORT(54, void, png_read_update_info, (png_structrp png_ptr, 1400 png_inforp info_ptr)); 1401 1402 #ifdef PNG_SEQUENTIAL_READ_SUPPORTED 1403 /* Read one or more rows of image data. */ 1404 PNG_EXPORT(55, void, png_read_rows, (png_structrp png_ptr, png_bytepp row, 1405 png_bytepp display_row, png_uint_32 num_rows)); 1406 #endif 1407 1408 #ifdef PNG_SEQUENTIAL_READ_SUPPORTED 1409 /* Read a row of data. */ 1410 PNG_EXPORT(56, void, png_read_row, (png_structrp png_ptr, png_bytep row, 1411 png_bytep display_row)); 1412 #endif 1413 1414 #ifdef PNG_SEQUENTIAL_READ_SUPPORTED 1415 /* Read the whole image into memory at once. */ 1416 PNG_EXPORT(57, void, png_read_image, (png_structrp png_ptr, png_bytepp image)); 1417 #endif 1418 1419 /* Write a row of image data */ 1420 PNG_EXPORT(58, void, png_write_row, (png_structrp png_ptr, 1421 png_const_bytep row)); 1422 1423 /* Write a few rows of image data: (*row) is not written; however, the type 1424 * is declared as writeable to maintain compatibility with previous versions 1425 * of libpng and to allow the 'display_row' array from read_rows to be passed 1426 * unchanged to write_rows. 1427 */ 1428 PNG_EXPORT(59, void, png_write_rows, (png_structrp png_ptr, png_bytepp row, 1429 png_uint_32 num_rows)); 1430 1431 /* Write the image data */ 1432 PNG_EXPORT(60, void, png_write_image, (png_structrp png_ptr, png_bytepp image)); 1433 1434 /* Write the end of the PNG file. */ 1435 PNG_EXPORT(61, void, png_write_end, (png_structrp png_ptr, 1436 png_inforp info_ptr)); 1437 1438 #ifdef PNG_SEQUENTIAL_READ_SUPPORTED 1439 /* Read the end of the PNG file. */ 1440 PNG_EXPORT(62, void, png_read_end, (png_structrp png_ptr, png_inforp info_ptr)); 1441 #endif 1442 1443 /* Free any memory associated with the png_info_struct */ 1444 PNG_EXPORT(63, void, png_destroy_info_struct, (png_const_structrp png_ptr, 1445 png_infopp info_ptr_ptr)); 1446 1447 /* Free any memory associated with the png_struct and the png_info_structs */ 1448 PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr, 1449 png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr)); 1450 1451 /* Free any memory associated with the png_struct and the png_info_structs */ 1452 PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr, 1453 png_infopp info_ptr_ptr)); 1454 1455 /* Set the libpng method of handling chunk CRC errors */ 1456 PNG_EXPORT(66, void, png_set_crc_action, (png_structrp png_ptr, int crit_action, 1457 int ancil_action)); 1458 1459 /* Values for png_set_crc_action() say how to handle CRC errors in 1460 * ancillary and critical chunks, and whether to use the data contained 1461 * therein. Note that it is impossible to "discard" data in a critical 1462 * chunk. For versions prior to 0.90, the action was always error/quit, 1463 * whereas in version 0.90 and later, the action for CRC errors in ancillary 1464 * chunks is warn/discard. These values should NOT be changed. 1465 * 1466 * value action:critical action:ancillary 1467 */ 1468 #define PNG_CRC_DEFAULT 0 /* error/quit warn/discard data */ 1469 #define PNG_CRC_ERROR_QUIT 1 /* error/quit error/quit */ 1470 #define PNG_CRC_WARN_DISCARD 2 /* (INVALID) warn/discard data */ 1471 #define PNG_CRC_WARN_USE 3 /* warn/use data warn/use data */ 1472 #define PNG_CRC_QUIET_USE 4 /* quiet/use data quiet/use data */ 1473 #define PNG_CRC_NO_CHANGE 5 /* use current value use current value */ 1474 1475 #ifdef PNG_WRITE_SUPPORTED 1476 /* These functions give the user control over the scan-line filtering in 1477 * libpng and the compression methods used by zlib. These functions are 1478 * mainly useful for testing, as the defaults should work with most users. 1479 * Those users who are tight on memory or want faster performance at the 1480 * expense of compression can modify them. See the compression library 1481 * header file (zlib.h) for an explanation of the compression functions. 1482 */ 1483 1484 /* Set the filtering method(s) used by libpng. Currently, the only valid 1485 * value for "method" is 0. 1486 */ 1487 PNG_EXPORT(67, void, png_set_filter, (png_structrp png_ptr, int method, 1488 int filters)); 1489 #endif /* WRITE */ 1490 1491 /* Flags for png_set_filter() to say which filters to use. The flags 1492 * are chosen so that they don't conflict with real filter types 1493 * below, in case they are supplied instead of the #defined constants. 1494 * These values should NOT be changed. 1495 */ 1496 #define PNG_NO_FILTERS 0x00 1497 #define PNG_FILTER_NONE 0x08 1498 #define PNG_FILTER_SUB 0x10 1499 #define PNG_FILTER_UP 0x20 1500 #define PNG_FILTER_AVG 0x40 1501 #define PNG_FILTER_PAETH 0x80 1502 #define PNG_FAST_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP) 1503 #define PNG_ALL_FILTERS (PNG_FAST_FILTERS | PNG_FILTER_AVG | PNG_FILTER_PAETH) 1504 1505 /* Filter values (not flags) - used in pngwrite.c, pngwutil.c for now. 1506 * These defines should NOT be changed. 1507 */ 1508 #define PNG_FILTER_VALUE_NONE 0 1509 #define PNG_FILTER_VALUE_SUB 1 1510 #define PNG_FILTER_VALUE_UP 2 1511 #define PNG_FILTER_VALUE_AVG 3 1512 #define PNG_FILTER_VALUE_PAETH 4 1513 #define PNG_FILTER_VALUE_LAST 5 1514 1515 #ifdef PNG_WRITE_SUPPORTED 1516 #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* DEPRECATED */ 1517 PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structrp png_ptr, 1518 int heuristic_method, int num_weights, png_const_doublep filter_weights, 1519 png_const_doublep filter_costs)) 1520 PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed, 1521 (png_structrp png_ptr, int heuristic_method, int num_weights, 1522 png_const_fixed_point_p filter_weights, 1523 png_const_fixed_point_p filter_costs)) 1524 #endif /* WRITE_WEIGHTED_FILTER */ 1525 1526 /* The following are no longer used and will be removed from libpng-1.7: */ 1527 #define PNG_FILTER_HEURISTIC_DEFAULT 0 /* Currently "UNWEIGHTED" */ 1528 #define PNG_FILTER_HEURISTIC_UNWEIGHTED 1 /* Used by libpng < 0.95 */ 1529 #define PNG_FILTER_HEURISTIC_WEIGHTED 2 /* Experimental feature */ 1530 #define PNG_FILTER_HEURISTIC_LAST 3 /* Not a valid value */ 1531 1532 /* Set the library compression level. Currently, valid values range from 1533 * 0 - 9, corresponding directly to the zlib compression levels 0 - 9 1534 * (0 - no compression, 9 - "maximal" compression). Note that tests have 1535 * shown that zlib compression levels 3-6 usually perform as well as level 9 1536 * for PNG images, and do considerably fewer calculations. In the future, 1537 * these values may not correspond directly to the zlib compression levels. 1538 */ 1539 #ifdef PNG_WRITE_CUSTOMIZE_COMPRESSION_SUPPORTED 1540 PNG_EXPORT(69, void, png_set_compression_level, (png_structrp png_ptr, 1541 int level)); 1542 1543 PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structrp png_ptr, 1544 int mem_level)); 1545 1546 PNG_EXPORT(71, void, png_set_compression_strategy, (png_structrp png_ptr, 1547 int strategy)); 1548 1549 /* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a 1550 * smaller value of window_bits if it can do so safely. 1551 */ 1552 PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structrp png_ptr, 1553 int window_bits)); 1554 1555 PNG_EXPORT(73, void, png_set_compression_method, (png_structrp png_ptr, 1556 int method)); 1557 #endif /* WRITE_CUSTOMIZE_COMPRESSION */ 1558 1559 #ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED 1560 /* Also set zlib parameters for compressing non-IDAT chunks */ 1561 PNG_EXPORT(222, void, png_set_text_compression_level, (png_structrp png_ptr, 1562 int level)); 1563 1564 PNG_EXPORT(223, void, png_set_text_compression_mem_level, (png_structrp png_ptr, 1565 int mem_level)); 1566 1567 PNG_EXPORT(224, void, png_set_text_compression_strategy, (png_structrp png_ptr, 1568 int strategy)); 1569 1570 /* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a 1571 * smaller value of window_bits if it can do so safely. 1572 */ 1573 PNG_EXPORT(225, void, png_set_text_compression_window_bits, 1574 (png_structrp png_ptr, int window_bits)); 1575 1576 PNG_EXPORT(226, void, png_set_text_compression_method, (png_structrp png_ptr, 1577 int method)); 1578 #endif /* WRITE_CUSTOMIZE_ZTXT_COMPRESSION */ 1579 #endif /* WRITE */ 1580 1581 /* These next functions are called for input/output, memory, and error 1582 * handling. They are in the file pngrio.c, pngwio.c, and pngerror.c, 1583 * and call standard C I/O routines such as fread(), fwrite(), and 1584 * fprintf(). These functions can be made to use other I/O routines 1585 * at run time for those applications that need to handle I/O in a 1586 * different manner by calling png_set_???_fn(). See libpng-manual.txt for 1587 * more information. 1588 */ 1589 1590 #ifdef PNG_STDIO_SUPPORTED 1591 /* Initialize the input/output for the PNG file to the default functions. */ 1592 PNG_EXPORT(74, void, png_init_io, (png_structrp png_ptr, FILE *fp)); 1593 #endif 1594 1595 /* Replace the (error and abort), and warning functions with user 1596 * supplied functions. If no messages are to be printed you must still 1597 * write and use replacement functions. The replacement error_fn should 1598 * still do a longjmp to the last setjmp location if you are using this 1599 * method of error handling. If error_fn or warning_fn is NULL, the 1600 * default function will be used. 1601 */ 1602 1603 PNG_EXPORT(75, void, png_set_error_fn, (png_structrp png_ptr, 1604 png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warning_fn)); 1605 1606 /* Return the user pointer associated with the error functions */ 1607 PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structrp png_ptr)); 1608 1609 /* Replace the default data output functions with a user supplied one(s). 1610 * If buffered output is not used, then output_flush_fn can be set to NULL. 1611 * If PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile time 1612 * output_flush_fn will be ignored (and thus can be NULL). 1613 * It is probably a mistake to use NULL for output_flush_fn if 1614 * write_data_fn is not also NULL unless you have built libpng with 1615 * PNG_WRITE_FLUSH_SUPPORTED undefined, because in this case libpng's 1616 * default flush function, which uses the standard *FILE structure, will 1617 * be used. 1618 */ 1619 PNG_EXPORT(77, void, png_set_write_fn, (png_structrp png_ptr, png_voidp io_ptr, 1620 png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn)); 1621 1622 /* Replace the default data input function with a user supplied one. */ 1623 PNG_EXPORT(78, void, png_set_read_fn, (png_structrp png_ptr, png_voidp io_ptr, 1624 png_rw_ptr read_data_fn)); 1625 1626 /* Return the user pointer associated with the I/O functions */ 1627 PNG_EXPORT(79, png_voidp, png_get_io_ptr, (png_const_structrp png_ptr)); 1628 1629 PNG_EXPORT(80, void, png_set_read_status_fn, (png_structrp png_ptr, 1630 png_read_status_ptr read_row_fn)); 1631 1632 PNG_EXPORT(81, void, png_set_write_status_fn, (png_structrp png_ptr, 1633 png_write_status_ptr write_row_fn)); 1634 1635 #ifdef PNG_USER_MEM_SUPPORTED 1636 /* Replace the default memory allocation functions with user supplied one(s). */ 1637 PNG_EXPORT(82, void, png_set_mem_fn, (png_structrp png_ptr, png_voidp mem_ptr, 1638 png_malloc_ptr malloc_fn, png_free_ptr free_fn)); 1639 /* Return the user pointer associated with the memory functions */ 1640 PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structrp png_ptr)); 1641 #endif 1642 1643 #ifdef PNG_READ_USER_TRANSFORM_SUPPORTED 1644 PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structrp png_ptr, 1645 png_user_transform_ptr read_user_transform_fn)); 1646 #endif 1647 1648 #ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED 1649 PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structrp png_ptr, 1650 png_user_transform_ptr write_user_transform_fn)); 1651 #endif 1652 1653 #ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED 1654 PNG_EXPORT(86, void, png_set_user_transform_info, (png_structrp png_ptr, 1655 png_voidp user_transform_ptr, int user_transform_depth, 1656 int user_transform_channels)); 1657 /* Return the user pointer associated with the user transform functions */ 1658 PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr, 1659 (png_const_structrp png_ptr)); 1660 #endif 1661 1662 #ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED 1663 /* Return information about the row currently being processed. Note that these 1664 * APIs do not fail but will return unexpected results if called outside a user 1665 * transform callback. Also note that when transforming an interlaced image the 1666 * row number is the row number within the sub-image of the interlace pass, so 1667 * the value will increase to the height of the sub-image (not the full image) 1668 * then reset to 0 for the next pass. 1669 * 1670 * Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to 1671 * find the output pixel (x,y) given an interlaced sub-image pixel 1672 * (row,col,pass). (See below for these macros.) 1673 */ 1674 PNG_EXPORT(217, png_uint_32, png_get_current_row_number, (png_const_structrp)); 1675 PNG_EXPORT(218, png_byte, png_get_current_pass_number, (png_const_structrp)); 1676 #endif 1677 1678 #ifdef PNG_READ_USER_CHUNKS_SUPPORTED 1679 /* This callback is called only for *unknown* chunks. If 1680 * PNG_HANDLE_AS_UNKNOWN_SUPPORTED is set then it is possible to set known 1681 * chunks to be treated as unknown, however in this case the callback must do 1682 * any processing required by the chunk (e.g. by calling the appropriate 1683 * png_set_ APIs.) 1684 * 1685 * There is no write support - on write, by default, all the chunks in the 1686 * 'unknown' list are written in the specified position. 1687 * 1688 * The integer return from the callback function is interpreted thus: 1689 * 1690 * negative: An error occurred; png_chunk_error will be called. 1691 * zero: The chunk was not handled, the chunk will be saved. A critical 1692 * chunk will cause an error at this point unless it is to be saved. 1693 * positive: The chunk was handled, libpng will ignore/discard it. 1694 * 1695 * See "INTERACTION WITH USER CHUNK CALLBACKS" below for important notes about 1696 * how this behavior will change in libpng 1.7 1697 */ 1698 PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structrp png_ptr, 1699 png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn)); 1700 #endif 1701 1702 #ifdef PNG_USER_CHUNKS_SUPPORTED 1703 PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structrp png_ptr)); 1704 #endif 1705 1706 #ifdef PNG_PROGRESSIVE_READ_SUPPORTED 1707 /* Sets the function callbacks for the push reader, and a pointer to a 1708 * user-defined structure available to the callback functions. 1709 */ 1710 PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structrp png_ptr, 1711 png_voidp progressive_ptr, png_progressive_info_ptr info_fn, 1712 png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn)); 1713 1714 /* Returns the user pointer associated with the push read functions */ 1715 PNG_EXPORT(91, png_voidp, png_get_progressive_ptr, 1716 (png_const_structrp png_ptr)); 1717 1718 /* Function to be called when data becomes available */ 1719 PNG_EXPORT(92, void, png_process_data, (png_structrp png_ptr, 1720 png_inforp info_ptr, png_bytep buffer, size_t buffer_size)); 1721 1722 /* A function which may be called *only* within png_process_data to stop the 1723 * processing of any more data. The function returns the number of bytes 1724 * remaining, excluding any that libpng has cached internally. A subsequent 1725 * call to png_process_data must supply these bytes again. If the argument 1726 * 'save' is set to true the routine will first save all the pending data and 1727 * will always return 0. 1728 */ 1729 PNG_EXPORT(219, size_t, png_process_data_pause, (png_structrp, int save)); 1730 1731 /* A function which may be called *only* outside (after) a call to 1732 * png_process_data. It returns the number of bytes of data to skip in the 1733 * input. Normally it will return 0, but if it returns a non-zero value the 1734 * application must skip than number of bytes of input data and pass the 1735 * following data to the next call to png_process_data. 1736 */ 1737 PNG_EXPORT(220, png_uint_32, png_process_data_skip, (png_structrp)); 1738 1739 /* Function that combines rows. 'new_row' is a flag that should come from 1740 * the callback and be non-NULL if anything needs to be done; the library 1741 * stores its own version of the new data internally and ignores the passed 1742 * in value. 1743 */ 1744 PNG_EXPORT(93, void, png_progressive_combine_row, (png_const_structrp png_ptr, 1745 png_bytep old_row, png_const_bytep new_row)); 1746 #endif /* PROGRESSIVE_READ */ 1747 1748 PNG_EXPORTA(94, png_voidp, png_malloc, (png_const_structrp png_ptr, 1749 png_alloc_size_t size), PNG_ALLOCATED); 1750 /* Added at libpng version 1.4.0 */ 1751 PNG_EXPORTA(95, png_voidp, png_calloc, (png_const_structrp png_ptr, 1752 png_alloc_size_t size), PNG_ALLOCATED); 1753 1754 /* Added at libpng version 1.2.4 */ 1755 PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_const_structrp png_ptr, 1756 png_alloc_size_t size), PNG_ALLOCATED); 1757 1758 /* Frees a pointer allocated by png_malloc() */ 1759 PNG_EXPORT(97, void, png_free, (png_const_structrp png_ptr, png_voidp ptr)); 1760 1761 /* Free data that was allocated internally */ 1762 PNG_EXPORT(98, void, png_free_data, (png_const_structrp png_ptr, 1763 png_inforp info_ptr, png_uint_32 free_me, int num)); 1764 1765 /* Reassign the responsibility for freeing existing data, whether allocated 1766 * by libpng or by the application; this works on the png_info structure passed 1767 * in, without changing the state for other png_info structures. 1768 */ 1769 PNG_EXPORT(99, void, png_data_freer, (png_const_structrp png_ptr, 1770 png_inforp info_ptr, int freer, png_uint_32 mask)); 1771 1772 /* Assignments for png_data_freer */ 1773 #define PNG_DESTROY_WILL_FREE_DATA 1 1774 #define PNG_SET_WILL_FREE_DATA 1 1775 #define PNG_USER_WILL_FREE_DATA 2 1776 /* Flags for png_ptr->free_me and info_ptr->free_me */ 1777 #define PNG_FREE_HIST 0x0008U 1778 #define PNG_FREE_ICCP 0x0010U 1779 #define PNG_FREE_SPLT 0x0020U 1780 #define PNG_FREE_ROWS 0x0040U 1781 #define PNG_FREE_PCAL 0x0080U 1782 #define PNG_FREE_SCAL 0x0100U 1783 #ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED 1784 # define PNG_FREE_UNKN 0x0200U 1785 #endif 1786 /* PNG_FREE_LIST 0x0400U removed in 1.6.0 because it is ignored */ 1787 #define PNG_FREE_PLTE 0x1000U 1788 #define PNG_FREE_TRNS 0x2000U 1789 #define PNG_FREE_TEXT 0x4000U 1790 #define PNG_FREE_EXIF 0x8000U /* Added at libpng-1.6.31 */ 1791 #define PNG_FREE_ALL 0xffffU 1792 #define PNG_FREE_MUL 0x4220U /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */ 1793 1794 #ifdef PNG_USER_MEM_SUPPORTED 1795 PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_const_structrp png_ptr, 1796 png_alloc_size_t size), PNG_ALLOCATED PNG_DEPRECATED); 1797 PNG_EXPORTA(101, void, png_free_default, (png_const_structrp png_ptr, 1798 png_voidp ptr), PNG_DEPRECATED); 1799 #endif 1800 1801 #ifdef PNG_ERROR_TEXT_SUPPORTED 1802 /* Fatal error in PNG image of libpng - can't continue */ 1803 PNG_EXPORTA(102, void, png_error, (png_const_structrp png_ptr, 1804 png_const_charp error_message), PNG_NORETURN); 1805 1806 /* The same, but the chunk name is prepended to the error string. */ 1807 PNG_EXPORTA(103, void, png_chunk_error, (png_const_structrp png_ptr, 1808 png_const_charp error_message), PNG_NORETURN); 1809 1810 #else 1811 /* Fatal error in PNG image of libpng - can't continue */ 1812 PNG_EXPORTA(104, void, png_err, (png_const_structrp png_ptr), PNG_NORETURN); 1813 # define png_error(s1,s2) png_err(s1) 1814 # define png_chunk_error(s1,s2) png_err(s1) 1815 #endif 1816 1817 #ifdef PNG_WARNINGS_SUPPORTED 1818 /* Non-fatal error in libpng. Can continue, but may have a problem. */ 1819 PNG_EXPORT(105, void, png_warning, (png_const_structrp png_ptr, 1820 png_const_charp warning_message)); 1821 1822 /* Non-fatal error in libpng, chunk name is prepended to message. */ 1823 PNG_EXPORT(106, void, png_chunk_warning, (png_const_structrp png_ptr, 1824 png_const_charp warning_message)); 1825 #else 1826 # define png_warning(s1,s2) ((void)(s1)) 1827 # define png_chunk_warning(s1,s2) ((void)(s1)) 1828 #endif 1829 1830 #ifdef PNG_BENIGN_ERRORS_SUPPORTED 1831 /* Benign error in libpng. Can continue, but may have a problem. 1832 * User can choose whether to handle as a fatal error or as a warning. */ 1833 PNG_EXPORT(107, void, png_benign_error, (png_const_structrp png_ptr, 1834 png_const_charp warning_message)); 1835 1836 #ifdef PNG_READ_SUPPORTED 1837 /* Same, chunk name is prepended to message (only during read) */ 1838 PNG_EXPORT(108, void, png_chunk_benign_error, (png_const_structrp png_ptr, 1839 png_const_charp warning_message)); 1840 #endif 1841 1842 PNG_EXPORT(109, void, png_set_benign_errors, 1843 (png_structrp png_ptr, int allowed)); 1844 #else 1845 # ifdef PNG_ALLOW_BENIGN_ERRORS 1846 # define png_benign_error png_warning 1847 # define png_chunk_benign_error png_chunk_warning 1848 # else 1849 # define png_benign_error png_error 1850 # define png_chunk_benign_error png_chunk_error 1851 # endif 1852 #endif 1853 1854 /* The png_set_<chunk> functions are for storing values in the png_info_struct. 1855 * Similarly, the png_get_<chunk> calls are used to read values from the 1856 * png_info_struct, either storing the parameters in the passed variables, or 1857 * setting pointers into the png_info_struct where the data is stored. The 1858 * png_get_<chunk> functions return a non-zero value if the data was available 1859 * in info_ptr, or return zero and do not change any of the parameters if the 1860 * data was not available. 1861 * 1862 * These functions should be used instead of directly accessing png_info 1863 * to avoid problems with future changes in the size and internal layout of 1864 * png_info_struct. 1865 */ 1866 /* Returns "flag" if chunk data is valid in info_ptr. */ 1867 PNG_EXPORT(110, png_uint_32, png_get_valid, (png_const_structrp png_ptr, 1868 png_const_inforp info_ptr, png_uint_32 flag)); 1869 1870 /* Returns number of bytes needed to hold a transformed row. */ 1871 PNG_EXPORT(111, size_t, png_get_rowbytes, (png_const_structrp png_ptr, 1872 png_const_inforp info_ptr)); 1873 1874 #ifdef PNG_INFO_IMAGE_SUPPORTED 1875 /* Returns row_pointers, which is an array of pointers to scanlines that was 1876 * returned from png_read_png(). 1877 */ 1878 PNG_EXPORT(112, png_bytepp, png_get_rows, (png_const_structrp png_ptr, 1879 png_const_inforp info_ptr)); 1880 1881 /* Set row_pointers, which is an array of pointers to scanlines for use 1882 * by png_write_png(). 1883 */ 1884 PNG_EXPORT(113, void, png_set_rows, (png_const_structrp png_ptr, 1885 png_inforp info_ptr, png_bytepp row_pointers)); 1886 #endif 1887 1888 /* Returns number of color channels in image. */ 1889 PNG_EXPORT(114, png_byte, png_get_channels, (png_const_structrp png_ptr, 1890 png_const_inforp info_ptr)); 1891 1892 #ifdef PNG_EASY_ACCESS_SUPPORTED 1893 /* Returns image width in pixels. */ 1894 PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structrp png_ptr, 1895 png_const_inforp info_ptr)); 1896 1897 /* Returns image height in pixels. */ 1898 PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structrp png_ptr, 1899 png_const_inforp info_ptr)); 1900 1901 /* Returns image bit_depth. */ 1902 PNG_EXPORT(117, png_byte, png_get_bit_depth, (png_const_structrp png_ptr, 1903 png_const_inforp info_ptr)); 1904 1905 /* Returns image color_type. */ 1906 PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structrp png_ptr, 1907 png_const_inforp info_ptr)); 1908 1909 /* Returns image filter_type. */ 1910 PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structrp png_ptr, 1911 png_const_inforp info_ptr)); 1912 1913 /* Returns image interlace_type. */ 1914 PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structrp png_ptr, 1915 png_const_inforp info_ptr)); 1916 1917 /* Returns image compression_type. */ 1918 PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structrp png_ptr, 1919 png_const_inforp info_ptr)); 1920 1921 /* Returns image resolution in pixels per meter, from pHYs chunk data. */ 1922 PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter, 1923 (png_const_structrp png_ptr, png_const_inforp info_ptr)); 1924 PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter, 1925 (png_const_structrp png_ptr, png_const_inforp info_ptr)); 1926 PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter, 1927 (png_const_structrp png_ptr, png_const_inforp info_ptr)); 1928 1929 /* Returns pixel aspect ratio, computed from pHYs chunk data. */ 1930 PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio, 1931 (png_const_structrp png_ptr, png_const_inforp info_ptr)) 1932 PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed, 1933 (png_const_structrp png_ptr, png_const_inforp info_ptr)) 1934 1935 /* Returns image x, y offset in pixels or microns, from oFFs chunk data. */ 1936 PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels, 1937 (png_const_structrp png_ptr, png_const_inforp info_ptr)); 1938 PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels, 1939 (png_const_structrp png_ptr, png_const_inforp info_ptr)); 1940 PNG_EXPORT(128, png_int_32, png_get_x_offset_microns, 1941 (png_const_structrp png_ptr, png_const_inforp info_ptr)); 1942 PNG_EXPORT(129, png_int_32, png_get_y_offset_microns, 1943 (png_const_structrp png_ptr, png_const_inforp info_ptr)); 1944 1945 #endif /* EASY_ACCESS */ 1946 1947 #ifdef PNG_READ_SUPPORTED 1948 /* Returns pointer to signature string read from PNG header */ 1949 PNG_EXPORT(130, png_const_bytep, png_get_signature, (png_const_structrp png_ptr, 1950 png_const_inforp info_ptr)); 1951 #endif 1952 1953 #ifdef PNG_bKGD_SUPPORTED 1954 PNG_EXPORT(131, png_uint_32, png_get_bKGD, (png_const_structrp png_ptr, 1955 png_inforp info_ptr, png_color_16p *background)); 1956 #endif 1957 1958 #ifdef PNG_bKGD_SUPPORTED 1959 PNG_EXPORT(132, void, png_set_bKGD, (png_const_structrp png_ptr, 1960 png_inforp info_ptr, png_const_color_16p background)); 1961 #endif 1962 1963 #ifdef PNG_cHRM_SUPPORTED 1964 PNG_FP_EXPORT(133, png_uint_32, png_get_cHRM, (png_const_structrp png_ptr, 1965 png_const_inforp info_ptr, double *white_x, double *white_y, double *red_x, 1966 double *red_y, double *green_x, double *green_y, double *blue_x, 1967 double *blue_y)) 1968 PNG_FP_EXPORT(230, png_uint_32, png_get_cHRM_XYZ, (png_const_structrp png_ptr, 1969 png_const_inforp info_ptr, double *red_X, double *red_Y, double *red_Z, 1970 double *green_X, double *green_Y, double *green_Z, double *blue_X, 1971 double *blue_Y, double *blue_Z)) 1972 PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed, 1973 (png_const_structrp png_ptr, png_const_inforp info_ptr, 1974 png_fixed_point *int_white_x, png_fixed_point *int_white_y, 1975 png_fixed_point *int_red_x, png_fixed_point *int_red_y, 1976 png_fixed_point *int_green_x, png_fixed_point *int_green_y, 1977 png_fixed_point *int_blue_x, png_fixed_point *int_blue_y)) 1978 PNG_FIXED_EXPORT(231, png_uint_32, png_get_cHRM_XYZ_fixed, 1979 (png_const_structrp png_ptr, png_const_inforp info_ptr, 1980 png_fixed_point *int_red_X, png_fixed_point *int_red_Y, 1981 png_fixed_point *int_red_Z, png_fixed_point *int_green_X, 1982 png_fixed_point *int_green_Y, png_fixed_point *int_green_Z, 1983 png_fixed_point *int_blue_X, png_fixed_point *int_blue_Y, 1984 png_fixed_point *int_blue_Z)) 1985 #endif 1986 1987 #ifdef PNG_cHRM_SUPPORTED 1988 PNG_FP_EXPORT(135, void, png_set_cHRM, (png_const_structrp png_ptr, 1989 png_inforp info_ptr, 1990 double white_x, double white_y, double red_x, double red_y, double green_x, 1991 double green_y, double blue_x, double blue_y)) 1992 PNG_FP_EXPORT(232, void, png_set_cHRM_XYZ, (png_const_structrp png_ptr, 1993 png_inforp info_ptr, double red_X, double red_Y, double red_Z, 1994 double green_X, double green_Y, double green_Z, double blue_X, 1995 double blue_Y, double blue_Z)) 1996 PNG_FIXED_EXPORT(136, void, png_set_cHRM_fixed, (png_const_structrp png_ptr, 1997 png_inforp info_ptr, png_fixed_point int_white_x, 1998 png_fixed_point int_white_y, png_fixed_point int_red_x, 1999 png_fixed_point int_red_y, png_fixed_point int_green_x, 2000 png_fixed_point int_green_y, png_fixed_point int_blue_x, 2001 png_fixed_point int_blue_y)) 2002 PNG_FIXED_EXPORT(233, void, png_set_cHRM_XYZ_fixed, (png_const_structrp png_ptr, 2003 png_inforp info_ptr, png_fixed_point int_red_X, png_fixed_point int_red_Y, 2004 png_fixed_point int_red_Z, png_fixed_point int_green_X, 2005 png_fixed_point int_green_Y, png_fixed_point int_green_Z, 2006 png_fixed_point int_blue_X, png_fixed_point int_blue_Y, 2007 png_fixed_point int_blue_Z)) 2008 #endif 2009 2010 #ifdef PNG_cICP_SUPPORTED 2011 PNG_EXPORT(250, png_uint_32, png_get_cICP, (png_const_structrp png_ptr, 2012 png_const_inforp info_ptr, png_bytep colour_primaries, 2013 png_bytep transfer_function, png_bytep matrix_coefficients, 2014 png_bytep video_full_range_flag)); 2015 #endif 2016 2017 #ifdef PNG_cICP_SUPPORTED 2018 PNG_EXPORT(251, void, png_set_cICP, (png_const_structrp png_ptr, 2019 png_inforp info_ptr, png_byte colour_primaries, 2020 png_byte transfer_function, png_byte matrix_coefficients, 2021 png_byte video_full_range_flag)); 2022 #endif 2023 2024 #ifdef PNG_cLLI_SUPPORTED 2025 PNG_FP_EXPORT(252, png_uint_32, png_get_cLLI, (png_const_structrp png_ptr, 2026 png_const_inforp info_ptr, double *maximum_content_light_level, 2027 double *maximum_frame_average_light_level)) 2028 PNG_FIXED_EXPORT(253, png_uint_32, png_get_cLLI_fixed, 2029 (png_const_structrp png_ptr, png_const_inforp info_ptr, 2030 /* The values below are in cd/m2 (nits) and are scaled by 10,000; not 2031 * 100,000 as in the case of png_fixed_point. 2032 */ 2033 png_uint_32p maximum_content_light_level_scaled_by_10000, 2034 png_uint_32p maximum_frame_average_light_level_scaled_by_10000)) 2035 #endif 2036 2037 #ifdef PNG_cLLI_SUPPORTED 2038 PNG_FP_EXPORT(254, void, png_set_cLLI, (png_const_structrp png_ptr, 2039 png_inforp info_ptr, double maximum_content_light_level, 2040 double maximum_frame_average_light_level)) 2041 PNG_FIXED_EXPORT(255, void, png_set_cLLI_fixed, (png_const_structrp png_ptr, 2042 png_inforp info_ptr, 2043 /* The values below are in cd/m2 (nits) and are scaled by 10,000; not 2044 * 100,000 as in the case of png_fixed_point. 2045 */ 2046 png_uint_32 maximum_content_light_level_scaled_by_10000, 2047 png_uint_32 maximum_frame_average_light_level_scaled_by_10000)) 2048 #endif 2049 2050 #ifdef PNG_eXIf_SUPPORTED 2051 PNG_EXPORT(246, png_uint_32, png_get_eXIf, (png_const_structrp png_ptr, 2052 png_inforp info_ptr, png_bytep *exif)); 2053 PNG_EXPORT(247, void, png_set_eXIf, (png_const_structrp png_ptr, 2054 png_inforp info_ptr, png_bytep exif)); 2055 2056 PNG_EXPORT(248, png_uint_32, png_get_eXIf_1, (png_const_structrp png_ptr, 2057 png_const_inforp info_ptr, png_uint_32 *num_exif, png_bytep *exif)); 2058 PNG_EXPORT(249, void, png_set_eXIf_1, (png_const_structrp png_ptr, 2059 png_inforp info_ptr, png_uint_32 num_exif, png_bytep exif)); 2060 #endif 2061 2062 #ifdef PNG_gAMA_SUPPORTED 2063 PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA, (png_const_structrp png_ptr, 2064 png_const_inforp info_ptr, double *file_gamma)) 2065 PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed, 2066 (png_const_structrp png_ptr, png_const_inforp info_ptr, 2067 png_fixed_point *int_file_gamma)) 2068 #endif 2069 2070 #ifdef PNG_gAMA_SUPPORTED 2071 PNG_FP_EXPORT(139, void, png_set_gAMA, (png_const_structrp png_ptr, 2072 png_inforp info_ptr, double file_gamma)) 2073 PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_const_structrp png_ptr, 2074 png_inforp info_ptr, png_fixed_point int_file_gamma)) 2075 #endif 2076 2077 #ifdef PNG_hIST_SUPPORTED 2078 PNG_EXPORT(141, png_uint_32, png_get_hIST, (png_const_structrp png_ptr, 2079 png_inforp info_ptr, png_uint_16p *hist)); 2080 PNG_EXPORT(142, void, png_set_hIST, (png_const_structrp png_ptr, 2081 png_inforp info_ptr, png_const_uint_16p hist)); 2082 #endif 2083 2084 PNG_EXPORT(143, png_uint_32, png_get_IHDR, (png_const_structrp png_ptr, 2085 png_const_inforp info_ptr, png_uint_32 *width, png_uint_32 *height, 2086 int *bit_depth, int *color_type, int *interlace_method, 2087 int *compression_method, int *filter_method)); 2088 2089 PNG_EXPORT(144, void, png_set_IHDR, (png_const_structrp png_ptr, 2090 png_inforp info_ptr, png_uint_32 width, png_uint_32 height, int bit_depth, 2091 int color_type, int interlace_method, int compression_method, 2092 int filter_method)); 2093 2094 #ifdef PNG_mDCV_SUPPORTED 2095 PNG_FP_EXPORT(256, png_uint_32, png_get_mDCV, (png_const_structrp png_ptr, 2096 png_const_inforp info_ptr, 2097 /* The chromaticities of the mastering display. As cHRM, but independent of 2098 * the encoding endpoints in cHRM, or cICP, or iCCP. These values will 2099 * always be in the range 0 to 1.3107. 2100 */ 2101 double *white_x, double *white_y, double *red_x, double *red_y, 2102 double *green_x, double *green_y, double *blue_x, double *blue_y, 2103 /* Mastering display luminance in cd/m2 (nits). */ 2104 double *mastering_display_maximum_luminance, 2105 double *mastering_display_minimum_luminance)) 2106 2107 PNG_FIXED_EXPORT(257, png_uint_32, png_get_mDCV_fixed, 2108 (png_const_structrp png_ptr, png_const_inforp info_ptr, 2109 png_fixed_point *int_white_x, png_fixed_point *int_white_y, 2110 png_fixed_point *int_red_x, png_fixed_point *int_red_y, 2111 png_fixed_point *int_green_x, png_fixed_point *int_green_y, 2112 png_fixed_point *int_blue_x, png_fixed_point *int_blue_y, 2113 /* Mastering display luminance in cd/m2 (nits) multiplied (scaled) by 2114 * 10,000. 2115 */ 2116 png_uint_32p mastering_display_maximum_luminance_scaled_by_10000, 2117 png_uint_32p mastering_display_minimum_luminance_scaled_by_10000)) 2118 #endif 2119 2120 #ifdef PNG_mDCV_SUPPORTED 2121 PNG_FP_EXPORT(258, void, png_set_mDCV, (png_const_structrp png_ptr, 2122 png_inforp info_ptr, 2123 /* The chromaticities of the mastering display. As cHRM, but independent of 2124 * the encoding endpoints in cHRM, or cICP, or iCCP. 2125 */ 2126 double white_x, double white_y, double red_x, double red_y, double green_x, 2127 double green_y, double blue_x, double blue_y, 2128 /* Mastering display luminance in cd/m2 (nits). */ 2129 double mastering_display_maximum_luminance, 2130 double mastering_display_minimum_luminance)) 2131 2132 PNG_FIXED_EXPORT(259, void, png_set_mDCV_fixed, (png_const_structrp png_ptr, 2133 png_inforp info_ptr, 2134 /* The admissible range of these values is not the full range of a PNG 2135 * fixed point value. Negative values cannot be encoded and the maximum 2136 * value is about 1.3 */ 2137 png_fixed_point int_white_x, png_fixed_point int_white_y, 2138 png_fixed_point int_red_x, png_fixed_point int_red_y, 2139 png_fixed_point int_green_x, png_fixed_point int_green_y, 2140 png_fixed_point int_blue_x, png_fixed_point int_blue_y, 2141 /* These are PNG unsigned 4 byte values: 31-bit unsigned values. The MSB 2142 * must be zero. 2143 */ 2144 png_uint_32 mastering_display_maximum_luminance_scaled_by_10000, 2145 png_uint_32 mastering_display_minimum_luminance_scaled_by_10000)) 2146 #endif 2147 2148 #ifdef PNG_oFFs_SUPPORTED 2149 PNG_EXPORT(145, png_uint_32, png_get_oFFs, (png_const_structrp png_ptr, 2150 png_const_inforp info_ptr, png_int_32 *offset_x, png_int_32 *offset_y, 2151 int *unit_type)); 2152 #endif 2153 2154 #ifdef PNG_oFFs_SUPPORTED 2155 PNG_EXPORT(146, void, png_set_oFFs, (png_const_structrp png_ptr, 2156 png_inforp info_ptr, png_int_32 offset_x, png_int_32 offset_y, 2157 int unit_type)); 2158 #endif 2159 2160 #ifdef PNG_pCAL_SUPPORTED 2161 PNG_EXPORT(147, png_uint_32, png_get_pCAL, (png_const_structrp png_ptr, 2162 png_inforp info_ptr, png_charp *purpose, png_int_32 *X0, 2163 png_int_32 *X1, int *type, int *nparams, png_charp *units, 2164 png_charpp *params)); 2165 #endif 2166 2167 #ifdef PNG_pCAL_SUPPORTED 2168 PNG_EXPORT(148, void, png_set_pCAL, (png_const_structrp png_ptr, 2169 png_inforp info_ptr, png_const_charp purpose, png_int_32 X0, png_int_32 X1, 2170 int type, int nparams, png_const_charp units, png_charpp params)); 2171 #endif 2172 2173 #ifdef PNG_pHYs_SUPPORTED 2174 PNG_EXPORT(149, png_uint_32, png_get_pHYs, (png_const_structrp png_ptr, 2175 png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y, 2176 int *unit_type)); 2177 #endif 2178 2179 #ifdef PNG_pHYs_SUPPORTED 2180 PNG_EXPORT(150, void, png_set_pHYs, (png_const_structrp png_ptr, 2181 png_inforp info_ptr, png_uint_32 res_x, png_uint_32 res_y, int unit_type)); 2182 #endif 2183 2184 PNG_EXPORT(151, png_uint_32, png_get_PLTE, (png_const_structrp png_ptr, 2185 png_inforp info_ptr, png_colorp *palette, int *num_palette)); 2186 2187 PNG_EXPORT(152, void, png_set_PLTE, (png_structrp png_ptr, 2188 png_inforp info_ptr, png_const_colorp palette, int num_palette)); 2189 2190 #ifdef PNG_sBIT_SUPPORTED 2191 PNG_EXPORT(153, png_uint_32, png_get_sBIT, (png_const_structrp png_ptr, 2192 png_inforp info_ptr, png_color_8p *sig_bit)); 2193 #endif 2194 2195 #ifdef PNG_sBIT_SUPPORTED 2196 PNG_EXPORT(154, void, png_set_sBIT, (png_const_structrp png_ptr, 2197 png_inforp info_ptr, png_const_color_8p sig_bit)); 2198 #endif 2199 2200 #ifdef PNG_sRGB_SUPPORTED 2201 PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structrp png_ptr, 2202 png_const_inforp info_ptr, int *file_srgb_intent)); 2203 #endif 2204 2205 #ifdef PNG_sRGB_SUPPORTED 2206 PNG_EXPORT(156, void, png_set_sRGB, (png_const_structrp png_ptr, 2207 png_inforp info_ptr, int srgb_intent)); 2208 PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_const_structrp png_ptr, 2209 png_inforp info_ptr, int srgb_intent)); 2210 #endif 2211 2212 #ifdef PNG_iCCP_SUPPORTED 2213 PNG_EXPORT(158, png_uint_32, png_get_iCCP, (png_const_structrp png_ptr, 2214 png_inforp info_ptr, png_charpp name, int *compression_type, 2215 png_bytepp profile, png_uint_32 *proflen)); 2216 #endif 2217 2218 #ifdef PNG_iCCP_SUPPORTED 2219 PNG_EXPORT(159, void, png_set_iCCP, (png_const_structrp png_ptr, 2220 png_inforp info_ptr, png_const_charp name, int compression_type, 2221 png_const_bytep profile, png_uint_32 proflen)); 2222 #endif 2223 2224 #ifdef PNG_sPLT_SUPPORTED 2225 PNG_EXPORT(160, int, png_get_sPLT, (png_const_structrp png_ptr, 2226 png_inforp info_ptr, png_sPLT_tpp entries)); 2227 #endif 2228 2229 #ifdef PNG_sPLT_SUPPORTED 2230 PNG_EXPORT(161, void, png_set_sPLT, (png_const_structrp png_ptr, 2231 png_inforp info_ptr, png_const_sPLT_tp entries, int nentries)); 2232 #endif 2233 2234 #ifdef PNG_TEXT_SUPPORTED 2235 /* png_get_text also returns the number of text chunks in *num_text */ 2236 PNG_EXPORT(162, int, png_get_text, (png_const_structrp png_ptr, 2237 png_inforp info_ptr, png_textp *text_ptr, int *num_text)); 2238 #endif 2239 2240 /* Note while png_set_text() will accept a structure whose text, 2241 * language, and translated keywords are NULL pointers, the structure 2242 * returned by png_get_text will always contain regular 2243 * zero-terminated C strings. They might be empty strings but 2244 * they will never be NULL pointers. 2245 */ 2246 2247 #ifdef PNG_TEXT_SUPPORTED 2248 PNG_EXPORT(163, void, png_set_text, (png_const_structrp png_ptr, 2249 png_inforp info_ptr, png_const_textp text_ptr, int num_text)); 2250 #endif 2251 2252 #ifdef PNG_tIME_SUPPORTED 2253 PNG_EXPORT(164, png_uint_32, png_get_tIME, (png_const_structrp png_ptr, 2254 png_inforp info_ptr, png_timep *mod_time)); 2255 #endif 2256 2257 #ifdef PNG_tIME_SUPPORTED 2258 PNG_EXPORT(165, void, png_set_tIME, (png_const_structrp png_ptr, 2259 png_inforp info_ptr, png_const_timep mod_time)); 2260 #endif 2261 2262 #ifdef PNG_tRNS_SUPPORTED 2263 PNG_EXPORT(166, png_uint_32, png_get_tRNS, (png_const_structrp png_ptr, 2264 png_inforp info_ptr, png_bytep *trans_alpha, int *num_trans, 2265 png_color_16p *trans_color)); 2266 #endif 2267 2268 #ifdef PNG_tRNS_SUPPORTED 2269 PNG_EXPORT(167, void, png_set_tRNS, (png_structrp png_ptr, 2270 png_inforp info_ptr, png_const_bytep trans_alpha, int num_trans, 2271 png_const_color_16p trans_color)); 2272 #endif 2273 2274 #ifdef PNG_sCAL_SUPPORTED 2275 PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL, (png_const_structrp png_ptr, 2276 png_const_inforp info_ptr, int *unit, double *width, double *height)) 2277 #if defined(PNG_FLOATING_ARITHMETIC_SUPPORTED) || \ 2278 defined(PNG_FLOATING_POINT_SUPPORTED) 2279 /* NOTE: this API is currently implemented using floating point arithmetic, 2280 * consequently it can only be used on systems with floating point support. 2281 * In any case the range of values supported by png_fixed_point is small and it 2282 * is highly recommended that png_get_sCAL_s be used instead. 2283 */ 2284 PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed, 2285 (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit, 2286 png_fixed_point *width, png_fixed_point *height)) 2287 #endif 2288 PNG_EXPORT(169, png_uint_32, png_get_sCAL_s, 2289 (png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit, 2290 png_charpp swidth, png_charpp sheight)); 2291 2292 PNG_FP_EXPORT(170, void, png_set_sCAL, (png_const_structrp png_ptr, 2293 png_inforp info_ptr, int unit, double width, double height)) 2294 PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_const_structrp png_ptr, 2295 png_inforp info_ptr, int unit, png_fixed_point width, 2296 png_fixed_point height)) 2297 PNG_EXPORT(171, void, png_set_sCAL_s, (png_const_structrp png_ptr, 2298 png_inforp info_ptr, int unit, 2299 png_const_charp swidth, png_const_charp sheight)); 2300 #endif /* sCAL */ 2301 2302 #ifdef PNG_SET_UNKNOWN_CHUNKS_SUPPORTED 2303 /* Provide the default handling for all unknown chunks or, optionally, for 2304 * specific unknown chunks. 2305 * 2306 * NOTE: prior to 1.6.0 the handling specified for particular chunks on read was 2307 * ignored and the default was used, the per-chunk setting only had an effect on 2308 * write. If you wish to have chunk-specific handling on read in code that must 2309 * work on earlier versions you must use a user chunk callback to specify the 2310 * desired handling (keep or discard.) 2311 * 2312 * The 'keep' parameter is a PNG_HANDLE_CHUNK_ value as listed below. The 2313 * parameter is interpreted as follows: 2314 * 2315 * READ: 2316 * PNG_HANDLE_CHUNK_AS_DEFAULT: 2317 * Known chunks: do normal libpng processing, do not keep the chunk (but 2318 * see the comments below about PNG_HANDLE_AS_UNKNOWN_SUPPORTED) 2319 * Unknown chunks: for a specific chunk use the global default, when used 2320 * as the default discard the chunk data. 2321 * PNG_HANDLE_CHUNK_NEVER: 2322 * Discard the chunk data. 2323 * PNG_HANDLE_CHUNK_IF_SAFE: 2324 * Keep the chunk data if the chunk is not critical else raise a chunk 2325 * error. 2326 * PNG_HANDLE_CHUNK_ALWAYS: 2327 * Keep the chunk data. 2328 * 2329 * If the chunk data is saved it can be retrieved using png_get_unknown_chunks, 2330 * below. Notice that specifying "AS_DEFAULT" as a global default is equivalent 2331 * to specifying "NEVER", however when "AS_DEFAULT" is used for specific chunks 2332 * it simply resets the behavior to the libpng default. 2333 * 2334 * INTERACTION WITH USER CHUNK CALLBACKS: 2335 * The per-chunk handling is always used when there is a png_user_chunk_ptr 2336 * callback and the callback returns 0; the chunk is then always stored *unless* 2337 * it is critical and the per-chunk setting is other than ALWAYS. Notice that 2338 * the global default is *not* used in this case. (In effect the per-chunk 2339 * value is incremented to at least IF_SAFE.) 2340 * 2341 * IMPORTANT NOTE: this behavior will change in libpng 1.7 - the global and 2342 * per-chunk defaults will be honored. If you want to preserve the current 2343 * behavior when your callback returns 0 you must set PNG_HANDLE_CHUNK_IF_SAFE 2344 * as the default - if you don't do this libpng 1.6 will issue a warning. 2345 * 2346 * If you want unhandled unknown chunks to be discarded in libpng 1.6 and 2347 * earlier simply return '1' (handled). 2348 * 2349 * PNG_HANDLE_AS_UNKNOWN_SUPPORTED: 2350 * If this is *not* set known chunks will always be handled by libpng and 2351 * will never be stored in the unknown chunk list. Known chunks listed to 2352 * png_set_keep_unknown_chunks will have no effect. If it is set then known 2353 * chunks listed with a keep other than AS_DEFAULT will *never* be processed 2354 * by libpng, in addition critical chunks must either be processed by the 2355 * callback or saved. 2356 * 2357 * The IHDR and IEND chunks must not be listed. Because this turns off the 2358 * default handling for chunks that would otherwise be recognized the 2359 * behavior of libpng transformations may well become incorrect! 2360 * 2361 * WRITE: 2362 * When writing chunks the options only apply to the chunks specified by 2363 * png_set_unknown_chunks (below), libpng will *always* write known chunks 2364 * required by png_set_ calls and will always write the core critical chunks 2365 * (as required for PLTE). 2366 * 2367 * Each chunk in the png_set_unknown_chunks list is looked up in the 2368 * png_set_keep_unknown_chunks list to find the keep setting, this is then 2369 * interpreted as follows: 2370 * 2371 * PNG_HANDLE_CHUNK_AS_DEFAULT: 2372 * Write safe-to-copy chunks and write other chunks if the global 2373 * default is set to _ALWAYS, otherwise don't write this chunk. 2374 * PNG_HANDLE_CHUNK_NEVER: 2375 * Do not write the chunk. 2376 * PNG_HANDLE_CHUNK_IF_SAFE: 2377 * Write the chunk if it is safe-to-copy, otherwise do not write it. 2378 * PNG_HANDLE_CHUNK_ALWAYS: 2379 * Write the chunk. 2380 * 2381 * Note that the default behavior is effectively the opposite of the read case - 2382 * in read unknown chunks are not stored by default, in write they are written 2383 * by default. Also the behavior of PNG_HANDLE_CHUNK_IF_SAFE is very different 2384 * - on write the safe-to-copy bit is checked, on read the critical bit is 2385 * checked and on read if the chunk is critical an error will be raised. 2386 * 2387 * num_chunks: 2388 * =========== 2389 * If num_chunks is positive, then the "keep" parameter specifies the manner 2390 * for handling only those chunks appearing in the chunk_list array, 2391 * otherwise the chunk list array is ignored. 2392 * 2393 * If num_chunks is 0 the "keep" parameter specifies the default behavior for 2394 * unknown chunks, as described above. 2395 * 2396 * If num_chunks is negative, then the "keep" parameter specifies the manner 2397 * for handling all unknown chunks plus all chunks recognized by libpng 2398 * except for the IHDR, PLTE, tRNS, IDAT, and IEND chunks (which continue to 2399 * be processed by libpng. 2400 */ 2401 #ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED 2402 PNG_EXPORT(172, void, png_set_keep_unknown_chunks, (png_structrp png_ptr, 2403 int keep, png_const_bytep chunk_list, int num_chunks)); 2404 #endif /* HANDLE_AS_UNKNOWN */ 2405 2406 /* The "keep" PNG_HANDLE_CHUNK_ parameter for the specified chunk is returned; 2407 * the result is therefore true (non-zero) if special handling is required, 2408 * false for the default handling. 2409 */ 2410 PNG_EXPORT(173, int, png_handle_as_unknown, (png_const_structrp png_ptr, 2411 png_const_bytep chunk_name)); 2412 #endif /* SET_UNKNOWN_CHUNKS */ 2413 2414 #ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED 2415 PNG_EXPORT(174, void, png_set_unknown_chunks, (png_const_structrp png_ptr, 2416 png_inforp info_ptr, png_const_unknown_chunkp unknowns, 2417 int num_unknowns)); 2418 /* NOTE: prior to 1.6.0 this routine set the 'location' field of the added 2419 * unknowns to the location currently stored in the png_struct. This is 2420 * invariably the wrong value on write. To fix this call the following API 2421 * for each chunk in the list with the correct location. If you know your 2422 * code won't be compiled on earlier versions you can rely on 2423 * png_set_unknown_chunks(write-ptr, png_get_unknown_chunks(read-ptr)) doing 2424 * the correct thing. 2425 */ 2426 2427 PNG_EXPORT(175, void, png_set_unknown_chunk_location, 2428 (png_const_structrp png_ptr, png_inforp info_ptr, int chunk, int location)); 2429 2430 PNG_EXPORT(176, int, png_get_unknown_chunks, (png_const_structrp png_ptr, 2431 png_inforp info_ptr, png_unknown_chunkpp entries)); 2432 #endif 2433 2434 /* Png_free_data() will turn off the "valid" flag for anything it frees. 2435 * If you need to turn it off for a chunk that your application has freed, 2436 * you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK); 2437 */ 2438 PNG_EXPORT(177, void, png_set_invalid, (png_const_structrp png_ptr, 2439 png_inforp info_ptr, int mask)); 2440 2441 #ifdef PNG_INFO_IMAGE_SUPPORTED 2442 /* The "params" pointer is currently not used and is for future expansion. */ 2443 #ifdef PNG_SEQUENTIAL_READ_SUPPORTED 2444 PNG_EXPORT(178, void, png_read_png, (png_structrp png_ptr, png_inforp info_ptr, 2445 int transforms, png_voidp params)); 2446 #endif 2447 #ifdef PNG_WRITE_SUPPORTED 2448 PNG_EXPORT(179, void, png_write_png, (png_structrp png_ptr, png_inforp info_ptr, 2449 int transforms, png_voidp params)); 2450 #endif 2451 #endif 2452 2453 PNG_EXPORT(180, png_const_charp, png_get_copyright, 2454 (png_const_structrp png_ptr)); 2455 PNG_EXPORT(181, png_const_charp, png_get_header_ver, 2456 (png_const_structrp png_ptr)); 2457 PNG_EXPORT(182, png_const_charp, png_get_header_version, 2458 (png_const_structrp png_ptr)); 2459 PNG_EXPORT(183, png_const_charp, png_get_libpng_ver, 2460 (png_const_structrp png_ptr)); 2461 2462 #ifdef PNG_MNG_FEATURES_SUPPORTED 2463 PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structrp png_ptr, 2464 png_uint_32 mng_features_permitted)); 2465 #endif 2466 2467 /* For use in png_set_keep_unknown, added to version 1.2.6 */ 2468 #define PNG_HANDLE_CHUNK_AS_DEFAULT 0 2469 #define PNG_HANDLE_CHUNK_NEVER 1 2470 #define PNG_HANDLE_CHUNK_IF_SAFE 2 2471 #define PNG_HANDLE_CHUNK_ALWAYS 3 2472 #define PNG_HANDLE_CHUNK_LAST 4 2473 2474 /* Strip the prepended error numbers ("#nnn ") from error and warning 2475 * messages before passing them to the error or warning handler. 2476 */ 2477 #ifdef PNG_ERROR_NUMBERS_SUPPORTED 2478 PNG_EXPORT(185, void, png_set_strip_error_numbers, (png_structrp png_ptr, 2479 png_uint_32 strip_mode)); 2480 #endif 2481 2482 /* Added in libpng-1.2.6 */ 2483 #ifdef PNG_SET_USER_LIMITS_SUPPORTED 2484 PNG_EXPORT(186, void, png_set_user_limits, (png_structrp png_ptr, 2485 png_uint_32 user_width_max, png_uint_32 user_height_max)); 2486 PNG_EXPORT(187, png_uint_32, png_get_user_width_max, 2487 (png_const_structrp png_ptr)); 2488 PNG_EXPORT(188, png_uint_32, png_get_user_height_max, 2489 (png_const_structrp png_ptr)); 2490 /* Added in libpng-1.4.0 */ 2491 PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structrp png_ptr, 2492 png_uint_32 user_chunk_cache_max)); 2493 PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max, 2494 (png_const_structrp png_ptr)); 2495 /* Added in libpng-1.4.1 */ 2496 PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structrp png_ptr, 2497 png_alloc_size_t user_chunk_cache_max)); 2498 PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max, 2499 (png_const_structrp png_ptr)); 2500 #endif 2501 2502 #if defined(PNG_INCH_CONVERSIONS_SUPPORTED) 2503 PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch, 2504 (png_const_structrp png_ptr, png_const_inforp info_ptr)); 2505 2506 PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch, 2507 (png_const_structrp png_ptr, png_const_inforp info_ptr)); 2508 2509 PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch, 2510 (png_const_structrp png_ptr, png_const_inforp info_ptr)); 2511 2512 PNG_FP_EXPORT(196, float, png_get_x_offset_inches, 2513 (png_const_structrp png_ptr, png_const_inforp info_ptr)) 2514 #ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */ 2515 PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed, 2516 (png_const_structrp png_ptr, png_const_inforp info_ptr)) 2517 #endif 2518 2519 PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_const_structrp png_ptr, 2520 png_const_inforp info_ptr)) 2521 #ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */ 2522 PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed, 2523 (png_const_structrp png_ptr, png_const_inforp info_ptr)) 2524 #endif 2525 2526 # ifdef PNG_pHYs_SUPPORTED 2527 PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structrp png_ptr, 2528 png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y, 2529 int *unit_type)); 2530 # endif /* pHYs */ 2531 #endif /* INCH_CONVERSIONS */ 2532 2533 /* Added in libpng-1.4.0 */ 2534 #ifdef PNG_IO_STATE_SUPPORTED 2535 PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_const_structrp png_ptr)); 2536 2537 /* Removed from libpng 1.6; use png_get_io_chunk_type. */ 2538 PNG_REMOVED(200, png_const_bytep, png_get_io_chunk_name, (png_structrp png_ptr), 2539 PNG_DEPRECATED) 2540 2541 PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type, 2542 (png_const_structrp png_ptr)); 2543 2544 /* The flags returned by png_get_io_state() are the following: */ 2545 # define PNG_IO_NONE 0x0000 /* no I/O at this moment */ 2546 # define PNG_IO_READING 0x0001 /* currently reading */ 2547 # define PNG_IO_WRITING 0x0002 /* currently writing */ 2548 # define PNG_IO_SIGNATURE 0x0010 /* currently at the file signature */ 2549 # define PNG_IO_CHUNK_HDR 0x0020 /* currently at the chunk header */ 2550 # define PNG_IO_CHUNK_DATA 0x0040 /* currently at the chunk data */ 2551 # define PNG_IO_CHUNK_CRC 0x0080 /* currently at the chunk crc */ 2552 # define PNG_IO_MASK_OP 0x000f /* current operation: reading/writing */ 2553 # define PNG_IO_MASK_LOC 0x00f0 /* current location: sig/hdr/data/crc */ 2554 #endif /* IO_STATE */ 2555 2556 /* Interlace support. The following macros are always defined so that if 2557 * libpng interlace handling is turned off the macros may be used to handle 2558 * interlaced images within the application. 2559 */ 2560 #define PNG_INTERLACE_ADAM7_PASSES 7 2561 2562 /* Two macros to return the first row and first column of the original, 2563 * full, image which appears in a given pass. 'pass' is in the range 0 2564 * to 6 and the result is in the range 0 to 7. 2565 */ 2566 #define PNG_PASS_START_ROW(pass) (((1&~(pass))<<(3-((pass)>>1)))&7) 2567 #define PNG_PASS_START_COL(pass) (((1& (pass))<<(3-(((pass)+1)>>1)))&7) 2568 2569 /* A macro to return the offset between pixels in the output row for a pair of 2570 * pixels in the input - effectively the inverse of the 'COL_SHIFT' macro that 2571 * follows. Note that ROW_OFFSET is the offset from one row to the next whereas 2572 * COL_OFFSET is from one column to the next, within a row. 2573 */ 2574 #define PNG_PASS_ROW_OFFSET(pass) ((pass)>2?(8>>(((pass)-1)>>1)):8) 2575 #define PNG_PASS_COL_OFFSET(pass) (1<<((7-(pass))>>1)) 2576 2577 /* Two macros to help evaluate the number of rows or columns in each 2578 * pass. This is expressed as a shift - effectively log2 of the number or 2579 * rows or columns in each 8x8 tile of the original image. 2580 */ 2581 #define PNG_PASS_ROW_SHIFT(pass) ((pass)>2?(8-(pass))>>1:3) 2582 #define PNG_PASS_COL_SHIFT(pass) ((pass)>1?(7-(pass))>>1:3) 2583 2584 /* Hence two macros to determine the number of rows or columns in a given 2585 * pass of an image given its height or width. In fact these macros may 2586 * return non-zero even though the sub-image is empty, because the other 2587 * dimension may be empty for a small image. 2588 */ 2589 #define PNG_PASS_ROWS(height, pass) (((height)+(((1<<PNG_PASS_ROW_SHIFT(pass))\ 2590 -1)-PNG_PASS_START_ROW(pass)))>>PNG_PASS_ROW_SHIFT(pass)) 2591 #define PNG_PASS_COLS(width, pass) (((width)+(((1<<PNG_PASS_COL_SHIFT(pass))\ 2592 -1)-PNG_PASS_START_COL(pass)))>>PNG_PASS_COL_SHIFT(pass)) 2593 2594 /* For the reader row callbacks (both progressive and sequential) it is 2595 * necessary to find the row in the output image given a row in an interlaced 2596 * image, so two more macros: 2597 */ 2598 #define PNG_ROW_FROM_PASS_ROW(y_in, pass) \ 2599 (((y_in)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass)) 2600 #define PNG_COL_FROM_PASS_COL(x_in, pass) \ 2601 (((x_in)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass)) 2602 2603 /* Two macros which return a boolean (0 or 1) saying whether the given row 2604 * or column is in a particular pass. These use a common utility macro that 2605 * returns a mask for a given pass - the offset 'off' selects the row or 2606 * column version. The mask has the appropriate bit set for each column in 2607 * the tile. 2608 */ 2609 #define PNG_PASS_MASK(pass,off) ( \ 2610 ((0x110145AF>>(((7-(off))-(pass))<<2)) & 0xF) | \ 2611 ((0x01145AF0>>(((7-(off))-(pass))<<2)) & 0xF0)) 2612 2613 #define PNG_ROW_IN_INTERLACE_PASS(y, pass) \ 2614 ((PNG_PASS_MASK(pass,0) >> ((y)&7)) & 1) 2615 #define PNG_COL_IN_INTERLACE_PASS(x, pass) \ 2616 ((PNG_PASS_MASK(pass,1) >> ((x)&7)) & 1) 2617 2618 #ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED 2619 /* With these routines we avoid an integer divide, which will be slower on 2620 * most machines. However, it does take more operations than the corresponding 2621 * divide method, so it may be slower on a few RISC systems. There are two 2622 * shifts (by 8 or 16 bits) and an addition, versus a single integer divide. 2623 * 2624 * Note that the rounding factors are NOT supposed to be the same! 128 and 2625 * 32768 are correct for the NODIV code; 127 and 32767 are correct for the 2626 * standard method. 2627 * 2628 * [Optimized code by Greg Roelofs and Mark Adler...blame us for bugs. :-) ] 2629 */ 2630 2631 /* fg and bg should be in `gamma 1.0' space; alpha is the opacity */ 2632 2633 # define png_composite(composite, fg, alpha, bg) \ 2634 { \ 2635 png_uint_16 temp = (png_uint_16)((png_uint_16)(fg) \ 2636 * (png_uint_16)(alpha) \ 2637 + (png_uint_16)(bg)*(png_uint_16)(255 \ 2638 - (png_uint_16)(alpha)) + 128); \ 2639 (composite) = (png_byte)(((temp + (temp >> 8)) >> 8) & 0xff); \ 2640 } 2641 2642 # define png_composite_16(composite, fg, alpha, bg) \ 2643 { \ 2644 png_uint_32 temp = (png_uint_32)((png_uint_32)(fg) \ 2645 * (png_uint_32)(alpha) \ 2646 + (png_uint_32)(bg)*(65535 \ 2647 - (png_uint_32)(alpha)) + 32768); \ 2648 (composite) = (png_uint_16)(0xffff & ((temp + (temp >> 16)) >> 16)); \ 2649 } 2650 2651 #else /* Standard method using integer division */ 2652 2653 # define png_composite(composite, fg, alpha, bg) \ 2654 (composite) = \ 2655 (png_byte)(0xff & (((png_uint_16)(fg) * (png_uint_16)(alpha) + \ 2656 (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \ 2657 127) / 255)) 2658 2659 # define png_composite_16(composite, fg, alpha, bg) \ 2660 (composite) = \ 2661 (png_uint_16)(0xffff & (((png_uint_32)(fg) * (png_uint_32)(alpha) + \ 2662 (png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) + \ 2663 32767) / 65535)) 2664 #endif /* READ_COMPOSITE_NODIV */ 2665 2666 #ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED 2667 PNG_EXPORT(201, png_uint_32, png_get_uint_32, (png_const_bytep buf)); 2668 PNG_EXPORT(202, png_uint_16, png_get_uint_16, (png_const_bytep buf)); 2669 PNG_EXPORT(203, png_int_32, png_get_int_32, (png_const_bytep buf)); 2670 #endif 2671 2672 PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_const_structrp png_ptr, 2673 png_const_bytep buf)); 2674 /* No png_get_int_16 -- may be added if there's a real need for it. */ 2675 2676 /* Place a 32-bit number into a buffer in PNG byte order (big-endian). */ 2677 #ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED 2678 PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i)); 2679 #endif 2680 #ifdef PNG_SAVE_INT_32_SUPPORTED 2681 PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i)); 2682 #endif 2683 2684 /* Place a 16-bit number into a buffer in PNG byte order. 2685 * The parameter is declared unsigned int, not png_uint_16, 2686 * just to avoid potential problems on pre-ANSI C compilers. 2687 */ 2688 #ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED 2689 PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i)); 2690 /* No png_save_int_16 -- may be added if there's a real need for it. */ 2691 #endif 2692 2693 #ifdef PNG_USE_READ_MACROS 2694 /* Inline macros to do direct reads of bytes from the input buffer. 2695 * The png_get_int_32() routine assumes we are using two's complement 2696 * format for negative values, which is almost certainly true. 2697 */ 2698 # define PNG_get_uint_32(buf) \ 2699 (((png_uint_32)(*(buf)) << 24) + \ 2700 ((png_uint_32)(*((buf) + 1)) << 16) + \ 2701 ((png_uint_32)(*((buf) + 2)) << 8) + \ 2702 ((png_uint_32)(*((buf) + 3)))) 2703 2704 /* From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the 2705 * function) incorrectly returned a value of type png_uint_32. 2706 */ 2707 # define PNG_get_uint_16(buf) \ 2708 ((png_uint_16) \ 2709 (((unsigned int)(*(buf)) << 8) + \ 2710 ((unsigned int)(*((buf) + 1))))) 2711 2712 # define PNG_get_int_32(buf) \ 2713 ((png_int_32)((*(buf) & 0x80) \ 2714 ? -((png_int_32)(((png_get_uint_32(buf)^0xffffffffU)+1U)&0x7fffffffU)) \ 2715 : (png_int_32)png_get_uint_32(buf))) 2716 2717 /* If PNG_PREFIX is defined the same thing as below happens in pnglibconf.h, 2718 * but defining a macro name prefixed with PNG_PREFIX. 2719 */ 2720 # ifndef PNG_PREFIX 2721 # define png_get_uint_32(buf) PNG_get_uint_32(buf) 2722 # define png_get_uint_16(buf) PNG_get_uint_16(buf) 2723 # define png_get_int_32(buf) PNG_get_int_32(buf) 2724 # endif 2725 #else 2726 # ifdef PNG_PREFIX 2727 /* No macros; revert to the (redefined) function */ 2728 # define PNG_get_uint_32 (png_get_uint_32) 2729 # define PNG_get_uint_16 (png_get_uint_16) 2730 # define PNG_get_int_32 (png_get_int_32) 2731 # endif 2732 #endif 2733 2734 #ifdef PNG_CHECK_FOR_INVALID_INDEX_SUPPORTED 2735 PNG_EXPORT(242, void, png_set_check_for_invalid_index, 2736 (png_structrp png_ptr, int allowed)); 2737 # ifdef PNG_GET_PALETTE_MAX_SUPPORTED 2738 PNG_EXPORT(243, int, png_get_palette_max, (png_const_structp png_ptr, 2739 png_const_infop info_ptr)); 2740 # endif 2741 #endif /* CHECK_FOR_INVALID_INDEX */ 2742 2743 /******************************************************************************* 2744 * Section 5: SIMPLIFIED API 2745 ******************************************************************************* 2746 * 2747 * Please read the documentation in libpng-manual.txt (TODO: write said 2748 * documentation) if you don't understand what follows. 2749 * 2750 * The simplified API hides the details of both libpng and the PNG file format 2751 * itself. It allows PNG files to be read into a very limited number of 2752 * in-memory bitmap formats or to be written from the same formats. If these 2753 * formats do not accommodate your needs then you can, and should, use the more 2754 * sophisticated APIs above - these support a wide variety of in-memory formats 2755 * and a wide variety of sophisticated transformations to those formats as well 2756 * as a wide variety of APIs to manipulate ancillary information. 2757 * 2758 * To read a PNG file using the simplified API: 2759 * 2760 * 1) Declare a 'png_image' structure (see below) on the stack, set the 2761 * version field to PNG_IMAGE_VERSION and the 'opaque' pointer to NULL 2762 * (this is REQUIRED, your program may crash if you don't do it.) 2763 * 2) Call the appropriate png_image_begin_read... function. 2764 * 3) Set the png_image 'format' member to the required sample format. 2765 * 4) Allocate a buffer for the image and, if required, the color-map. 2766 * 5) Call png_image_finish_read to read the image and, if required, the 2767 * color-map into your buffers. 2768 * 2769 * There are no restrictions on the format of the PNG input itself; all valid 2770 * color types, bit depths, and interlace methods are acceptable, and the 2771 * input image is transformed as necessary to the requested in-memory format 2772 * during the png_image_finish_read() step. The only caveat is that if you 2773 * request a color-mapped image from a PNG that is full-color or makes 2774 * complex use of an alpha channel the transformation is extremely lossy and the 2775 * result may look terrible. 2776 * 2777 * To write a PNG file using the simplified API: 2778 * 2779 * 1) Declare a 'png_image' structure on the stack and memset() it to all zero. 2780 * 2) Initialize the members of the structure that describe the image, setting 2781 * the 'format' member to the format of the image samples. 2782 * 3) Call the appropriate png_image_write... function with a pointer to the 2783 * image and, if necessary, the color-map to write the PNG data. 2784 * 2785 * png_image is a structure that describes the in-memory format of an image 2786 * when it is being read or defines the in-memory format of an image that you 2787 * need to write: 2788 */ 2789 #if defined(PNG_SIMPLIFIED_READ_SUPPORTED) || \ 2790 defined(PNG_SIMPLIFIED_WRITE_SUPPORTED) 2791 2792 #define PNG_IMAGE_VERSION 1 2793 2794 typedef struct png_control *png_controlp; 2795 typedef struct 2796 { 2797 png_controlp opaque; /* Initialize to NULL, free with png_image_free */ 2798 png_uint_32 version; /* Set to PNG_IMAGE_VERSION */ 2799 png_uint_32 width; /* Image width in pixels (columns) */ 2800 png_uint_32 height; /* Image height in pixels (rows) */ 2801 png_uint_32 format; /* Image format as defined below */ 2802 png_uint_32 flags; /* A bit mask containing informational flags */ 2803 png_uint_32 colormap_entries; 2804 /* Number of entries in the color-map */ 2805 2806 /* In the event of an error or warning the following field will be set to a 2807 * non-zero value and the 'message' field will contain a '\0' terminated 2808 * string with the libpng error or warning message. If both warnings and 2809 * an error were encountered, only the error is recorded. If there 2810 * are multiple warnings, only the first one is recorded. 2811 * 2812 * The upper 30 bits of this value are reserved, the low two bits contain 2813 * a value as follows: 2814 */ 2815 # define PNG_IMAGE_WARNING 1 2816 # define PNG_IMAGE_ERROR 2 2817 /* 2818 * The result is a two-bit code such that a value more than 1 indicates 2819 * a failure in the API just called: 2820 * 2821 * 0 - no warning or error 2822 * 1 - warning 2823 * 2 - error 2824 * 3 - error preceded by warning 2825 */ 2826 # define PNG_IMAGE_FAILED(png_cntrl) ((((png_cntrl).warning_or_error)&0x03)>1) 2827 2828 png_uint_32 warning_or_error; 2829 2830 char message[64]; 2831 } png_image, *png_imagep; 2832 2833 /* The samples of the image have one to four channels whose components have 2834 * original values in the range 0 to 1.0: 2835 * 2836 * 1: A single gray or luminance channel (G). 2837 * 2: A gray/luminance channel and an alpha channel (GA). 2838 * 3: Three red, green, blue color channels (RGB). 2839 * 4: Three color channels and an alpha channel (RGBA). 2840 * 2841 * The components are encoded in one of two ways: 2842 * 2843 * a) As a small integer, value 0..255, contained in a single byte. For the 2844 * alpha channel the original value is simply value/255. For the color or 2845 * luminance channels the value is encoded according to the sRGB specification 2846 * and matches the 8-bit format expected by typical display devices. 2847 * 2848 * The color/gray channels are not scaled (pre-multiplied) by the alpha 2849 * channel and are suitable for passing to color management software. 2850 * 2851 * b) As a value in the range 0..65535, contained in a 2-byte integer. All 2852 * channels can be converted to the original value by dividing by 65535; all 2853 * channels are linear. Color channels use the RGB encoding (RGB end-points) of 2854 * the sRGB specification. This encoding is identified by the 2855 * PNG_FORMAT_FLAG_LINEAR flag below. 2856 * 2857 * When the simplified API needs to convert between sRGB and linear colorspaces, 2858 * the actual sRGB transfer curve defined in the sRGB specification (see the 2859 * article at <https://en.wikipedia.org/wiki/SRGB>) is used, not the gamma=1/2.2 2860 * approximation used elsewhere in libpng. 2861 * 2862 * When an alpha channel is present it is expected to denote pixel coverage 2863 * of the color or luminance channels and is returned as an associated alpha 2864 * channel: the color/gray channels are scaled (pre-multiplied) by the alpha 2865 * value. 2866 * 2867 * The samples are either contained directly in the image data, between 1 and 8 2868 * bytes per pixel according to the encoding, or are held in a color-map indexed 2869 * by bytes in the image data. In the case of a color-map the color-map entries 2870 * are individual samples, encoded as above, and the image data has one byte per 2871 * pixel to select the relevant sample from the color-map. 2872 */ 2873 2874 /* PNG_FORMAT_* 2875 * 2876 * #defines to be used in png_image::format. Each #define identifies a 2877 * particular layout of sample data and, if present, alpha values. There are 2878 * separate defines for each of the two component encodings. 2879 * 2880 * A format is built up using single bit flag values. All combinations are 2881 * valid. Formats can be built up from the flag values or you can use one of 2882 * the predefined values below. When testing formats always use the FORMAT_FLAG 2883 * macros to test for individual features - future versions of the library may 2884 * add new flags. 2885 * 2886 * When reading or writing color-mapped images the format should be set to the 2887 * format of the entries in the color-map then png_image_{read,write}_colormap 2888 * called to read or write the color-map and set the format correctly for the 2889 * image data. Do not set the PNG_FORMAT_FLAG_COLORMAP bit directly! 2890 * 2891 * NOTE: libpng can be built with particular features disabled. If you see 2892 * compiler errors because the definition of one of the following flags has been 2893 * compiled out it is because libpng does not have the required support. It is 2894 * possible, however, for the libpng configuration to enable the format on just 2895 * read or just write; in that case you may see an error at run time. You can 2896 * guard against this by checking for the definition of the appropriate 2897 * "_SUPPORTED" macro, one of: 2898 * 2899 * PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED 2900 */ 2901 #define PNG_FORMAT_FLAG_ALPHA 0x01U /* format with an alpha channel */ 2902 #define PNG_FORMAT_FLAG_COLOR 0x02U /* color format: otherwise grayscale */ 2903 #define PNG_FORMAT_FLAG_LINEAR 0x04U /* 2-byte channels else 1-byte */ 2904 #define PNG_FORMAT_FLAG_COLORMAP 0x08U /* image data is color-mapped */ 2905 2906 #ifdef PNG_FORMAT_BGR_SUPPORTED 2907 # define PNG_FORMAT_FLAG_BGR 0x10U /* BGR colors, else order is RGB */ 2908 #endif 2909 2910 #ifdef PNG_FORMAT_AFIRST_SUPPORTED 2911 # define PNG_FORMAT_FLAG_AFIRST 0x20U /* alpha channel comes first */ 2912 #endif 2913 2914 #define PNG_FORMAT_FLAG_ASSOCIATED_ALPHA 0x40U /* alpha channel is associated */ 2915 2916 /* Commonly used formats have predefined macros. 2917 * 2918 * First the single byte (sRGB) formats: 2919 */ 2920 #define PNG_FORMAT_GRAY 0 2921 #define PNG_FORMAT_GA PNG_FORMAT_FLAG_ALPHA 2922 #define PNG_FORMAT_AG (PNG_FORMAT_GA|PNG_FORMAT_FLAG_AFIRST) 2923 #define PNG_FORMAT_RGB PNG_FORMAT_FLAG_COLOR 2924 #define PNG_FORMAT_BGR (PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_BGR) 2925 #define PNG_FORMAT_RGBA (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_ALPHA) 2926 #define PNG_FORMAT_ARGB (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_AFIRST) 2927 #define PNG_FORMAT_BGRA (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_ALPHA) 2928 #define PNG_FORMAT_ABGR (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_AFIRST) 2929 2930 /* Then the linear 2-byte formats. When naming these "Y" is used to 2931 * indicate a luminance (gray) channel. 2932 */ 2933 #define PNG_FORMAT_LINEAR_Y PNG_FORMAT_FLAG_LINEAR 2934 #define PNG_FORMAT_LINEAR_Y_ALPHA (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_ALPHA) 2935 #define PNG_FORMAT_LINEAR_RGB (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR) 2936 #define PNG_FORMAT_LINEAR_RGB_ALPHA \ 2937 (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA) 2938 2939 /* With color-mapped formats the image data is one byte for each pixel, the byte 2940 * is an index into the color-map which is formatted as above. To obtain a 2941 * color-mapped format it is sufficient just to add the PNG_FOMAT_FLAG_COLORMAP 2942 * to one of the above definitions, or you can use one of the definitions below. 2943 */ 2944 #define PNG_FORMAT_RGB_COLORMAP (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_COLORMAP) 2945 #define PNG_FORMAT_BGR_COLORMAP (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_COLORMAP) 2946 #define PNG_FORMAT_RGBA_COLORMAP (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_COLORMAP) 2947 #define PNG_FORMAT_ARGB_COLORMAP (PNG_FORMAT_ARGB|PNG_FORMAT_FLAG_COLORMAP) 2948 #define PNG_FORMAT_BGRA_COLORMAP (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_COLORMAP) 2949 #define PNG_FORMAT_ABGR_COLORMAP (PNG_FORMAT_ABGR|PNG_FORMAT_FLAG_COLORMAP) 2950 2951 /* PNG_IMAGE macros 2952 * 2953 * These are convenience macros to derive information from a png_image 2954 * structure. The PNG_IMAGE_SAMPLE_ macros return values appropriate to the 2955 * actual image sample values - either the entries in the color-map or the 2956 * pixels in the image. The PNG_IMAGE_PIXEL_ macros return corresponding values 2957 * for the pixels and will always return 1 for color-mapped formats. The 2958 * remaining macros return information about the rows in the image and the 2959 * complete image. 2960 * 2961 * NOTE: All the macros that take a png_image::format parameter are compile time 2962 * constants if the format parameter is, itself, a constant. Therefore these 2963 * macros can be used in array declarations and case labels where required. 2964 * Similarly the macros are also pre-processor constants (sizeof is not used) so 2965 * they can be used in #if tests. 2966 * 2967 * First the information about the samples. 2968 */ 2969 #define PNG_IMAGE_SAMPLE_CHANNELS(fmt)\ 2970 (((fmt)&(PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA))+1) 2971 /* Return the total number of channels in a given format: 1..4 */ 2972 2973 #define PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt)\ 2974 ((((fmt) & PNG_FORMAT_FLAG_LINEAR) >> 2)+1) 2975 /* Return the size in bytes of a single component of a pixel or color-map 2976 * entry (as appropriate) in the image: 1 or 2. 2977 */ 2978 2979 #define PNG_IMAGE_SAMPLE_SIZE(fmt)\ 2980 (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt)) 2981 /* This is the size of the sample data for one sample. If the image is 2982 * color-mapped it is the size of one color-map entry (and image pixels are 2983 * one byte in size), otherwise it is the size of one image pixel. 2984 */ 2985 2986 #define PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)\ 2987 (PNG_IMAGE_SAMPLE_CHANNELS(fmt) * 256) 2988 /* The maximum size of the color-map required by the format expressed in a 2989 * count of components. This can be used to compile-time allocate a 2990 * color-map: 2991 * 2992 * png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)]; 2993 * 2994 * png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)]; 2995 * 2996 * Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the 2997 * information from one of the png_image_begin_read_ APIs and dynamically 2998 * allocate the required memory. 2999 */ 3000 3001 /* Corresponding information about the pixels */ 3002 #define PNG_IMAGE_PIXEL_(test,fmt)\ 3003 (((fmt)&PNG_FORMAT_FLAG_COLORMAP)?1:test(fmt)) 3004 3005 #define PNG_IMAGE_PIXEL_CHANNELS(fmt)\ 3006 PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_CHANNELS,fmt) 3007 /* The number of separate channels (components) in a pixel; 1 for a 3008 * color-mapped image. 3009 */ 3010 3011 #define PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)\ 3012 PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_COMPONENT_SIZE,fmt) 3013 /* The size, in bytes, of each component in a pixel; 1 for a color-mapped 3014 * image. 3015 */ 3016 3017 #define PNG_IMAGE_PIXEL_SIZE(fmt) PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_SIZE,fmt) 3018 /* The size, in bytes, of a complete pixel; 1 for a color-mapped image. */ 3019 3020 /* Information about the whole row, or whole image */ 3021 #define PNG_IMAGE_ROW_STRIDE(image)\ 3022 (PNG_IMAGE_PIXEL_CHANNELS((image).format) * (image).width) 3023 /* Return the total number of components in a single row of the image; this 3024 * is the minimum 'row stride', the minimum count of components between each 3025 * row. For a color-mapped image this is the minimum number of bytes in a 3026 * row. 3027 * 3028 * WARNING: this macro overflows for some images with more than one component 3029 * and very large image widths. libpng will refuse to process an image where 3030 * this macro would overflow. 3031 */ 3032 3033 #define PNG_IMAGE_BUFFER_SIZE(image, row_stride)\ 3034 (PNG_IMAGE_PIXEL_COMPONENT_SIZE((image).format)*(image).height*(row_stride)) 3035 /* Return the size, in bytes, of an image buffer given a png_image and a row 3036 * stride - the number of components to leave space for in each row. 3037 * 3038 * WARNING: this macro overflows a 32-bit integer for some large PNG images, 3039 * libpng will refuse to process an image where such an overflow would occur. 3040 */ 3041 3042 #define PNG_IMAGE_SIZE(image)\ 3043 PNG_IMAGE_BUFFER_SIZE(image, PNG_IMAGE_ROW_STRIDE(image)) 3044 /* Return the size, in bytes, of the image in memory given just a png_image; 3045 * the row stride is the minimum stride required for the image. 3046 */ 3047 3048 #define PNG_IMAGE_COLORMAP_SIZE(image)\ 3049 (PNG_IMAGE_SAMPLE_SIZE((image).format) * (image).colormap_entries) 3050 /* Return the size, in bytes, of the color-map of this image. If the image 3051 * format is not a color-map format this will return a size sufficient for 3052 * 256 entries in the given format; check PNG_FORMAT_FLAG_COLORMAP if 3053 * you don't want to allocate a color-map in this case. 3054 */ 3055 3056 /* PNG_IMAGE_FLAG_* 3057 * 3058 * Flags containing additional information about the image are held in the 3059 * 'flags' field of png_image. 3060 */ 3061 #define PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB 0x01 3062 /* This indicates that the RGB values of the in-memory bitmap do not 3063 * correspond to the red, green and blue end-points defined by sRGB. 3064 */ 3065 3066 #define PNG_IMAGE_FLAG_FAST 0x02 3067 /* On write emphasise speed over compression; the resultant PNG file will be 3068 * larger but will be produced significantly faster, particular for large 3069 * images. Do not use this option for images which will be distributed, only 3070 * used it when producing intermediate files that will be read back in 3071 * repeatedly. For a typical 24-bit image the option will double the read 3072 * speed at the cost of increasing the image size by 25%, however for many 3073 * more compressible images the PNG file can be 10 times larger with only a 3074 * slight speed gain. 3075 */ 3076 3077 #define PNG_IMAGE_FLAG_16BIT_sRGB 0x04 3078 /* On read if the image is a 16-bit per component image and there is no gAMA 3079 * or sRGB chunk assume that the components are sRGB encoded. Notice that 3080 * images output by the simplified API always have gamma information; setting 3081 * this flag only affects the interpretation of 16-bit images from an 3082 * external source. It is recommended that the application expose this flag 3083 * to the user; the user can normally easily recognize the difference between 3084 * linear and sRGB encoding. This flag has no effect on write - the data 3085 * passed to the write APIs must have the correct encoding (as defined 3086 * above.) 3087 * 3088 * If the flag is not set (the default) input 16-bit per component data is 3089 * assumed to be linear. 3090 * 3091 * NOTE: the flag can only be set after the png_image_begin_read_ call, 3092 * because that call initializes the 'flags' field. 3093 */ 3094 3095 #ifdef PNG_SIMPLIFIED_READ_SUPPORTED 3096 /* READ APIs 3097 * --------- 3098 * 3099 * The png_image passed to the read APIs must have been initialized by setting 3100 * the png_controlp field 'opaque' to NULL (or, safer, memset the whole thing.) 3101 */ 3102 #ifdef PNG_STDIO_SUPPORTED 3103 PNG_EXPORT(234, int, png_image_begin_read_from_file, (png_imagep image, 3104 const char *file_name)); 3105 /* The named file is opened for read and the image header is filled in 3106 * from the PNG header in the file. 3107 */ 3108 3109 PNG_EXPORT(235, int, png_image_begin_read_from_stdio, (png_imagep image, 3110 FILE *file)); 3111 /* The PNG header is read from the stdio FILE object. */ 3112 #endif /* STDIO */ 3113 3114 PNG_EXPORT(236, int, png_image_begin_read_from_memory, (png_imagep image, 3115 png_const_voidp memory, size_t size)); 3116 /* The PNG header is read from the given memory buffer. */ 3117 3118 PNG_EXPORT(237, int, png_image_finish_read, (png_imagep image, 3119 png_const_colorp background, void *buffer, png_int_32 row_stride, 3120 void *colormap)); 3121 /* Finish reading the image into the supplied buffer and clean up the 3122 * png_image structure. 3123 * 3124 * row_stride is the step, in byte or 2-byte units as appropriate, 3125 * between adjacent rows. A positive stride indicates that the top-most row 3126 * is first in the buffer - the normal top-down arrangement. A negative 3127 * stride indicates that the bottom-most row is first in the buffer. 3128 * 3129 * background need only be supplied if an alpha channel must be removed from 3130 * a png_byte format and the removal is to be done by compositing on a solid 3131 * color; otherwise it may be NULL and any composition will be done directly 3132 * onto the buffer. The value is an sRGB color to use for the background, 3133 * for grayscale output the green channel is used. 3134 * 3135 * background must be supplied when an alpha channel must be removed from a 3136 * single byte color-mapped output format, in other words if: 3137 * 3138 * 1) The original format from png_image_begin_read_from_* had 3139 * PNG_FORMAT_FLAG_ALPHA set. 3140 * 2) The format set by the application does not. 3141 * 3) The format set by the application has PNG_FORMAT_FLAG_COLORMAP set and 3142 * PNG_FORMAT_FLAG_LINEAR *not* set. 3143 * 3144 * For linear output removing the alpha channel is always done by compositing 3145 * on black and background is ignored. 3146 * 3147 * colormap must be supplied when PNG_FORMAT_FLAG_COLORMAP is set. It must 3148 * be at least the size (in bytes) returned by PNG_IMAGE_COLORMAP_SIZE. 3149 * image->colormap_entries will be updated to the actual number of entries 3150 * written to the colormap; this may be less than the original value. 3151 */ 3152 3153 PNG_EXPORT(238, void, png_image_free, (png_imagep image)); 3154 /* Free any data allocated by libpng in image->opaque, setting the pointer to 3155 * NULL. May be called at any time after the structure is initialized. 3156 */ 3157 #endif /* SIMPLIFIED_READ */ 3158 3159 #ifdef PNG_SIMPLIFIED_WRITE_SUPPORTED 3160 /* WRITE APIS 3161 * ---------- 3162 * For write you must initialize a png_image structure to describe the image to 3163 * be written. To do this use memset to set the whole structure to 0 then 3164 * initialize fields describing your image. 3165 * 3166 * version: must be set to PNG_IMAGE_VERSION 3167 * opaque: must be initialized to NULL 3168 * width: image width in pixels 3169 * height: image height in rows 3170 * format: the format of the data (image and color-map) you wish to write 3171 * flags: set to 0 unless one of the defined flags applies; set 3172 * PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images where the RGB 3173 * values do not correspond to the colors in sRGB. 3174 * colormap_entries: set to the number of entries in the color-map (0 to 256) 3175 */ 3176 #ifdef PNG_SIMPLIFIED_WRITE_STDIO_SUPPORTED 3177 PNG_EXPORT(239, int, png_image_write_to_file, (png_imagep image, 3178 const char *file, int convert_to_8bit, const void *buffer, 3179 png_int_32 row_stride, const void *colormap)); 3180 /* Write the image to the named file. */ 3181 3182 PNG_EXPORT(240, int, png_image_write_to_stdio, (png_imagep image, FILE *file, 3183 int convert_to_8_bit, const void *buffer, png_int_32 row_stride, 3184 const void *colormap)); 3185 /* Write the image to the given FILE object. */ 3186 #endif /* SIMPLIFIED_WRITE_STDIO */ 3187 3188 /* With all write APIs if image is in one of the linear formats with 16-bit 3189 * data then setting convert_to_8_bit will cause the output to be an 8-bit PNG 3190 * gamma encoded according to the sRGB specification, otherwise a 16-bit linear 3191 * encoded PNG file is written. 3192 * 3193 * With color-mapped data formats the colormap parameter point to a color-map 3194 * with at least image->colormap_entries encoded in the specified format. If 3195 * the format is linear the written PNG color-map will be converted to sRGB 3196 * regardless of the convert_to_8_bit flag. 3197 * 3198 * With all APIs row_stride is handled as in the read APIs - it is the spacing 3199 * from one row to the next in component sized units (1 or 2 bytes) and if 3200 * negative indicates a bottom-up row layout in the buffer. If row_stride is 3201 * zero, libpng will calculate it for you from the image width and number of 3202 * channels. 3203 * 3204 * Note that the write API does not support interlacing, sub-8-bit pixels or 3205 * most ancillary chunks. If you need to write text chunks (e.g. for copyright 3206 * notices) you need to use one of the other APIs. 3207 */ 3208 3209 PNG_EXPORT(245, int, png_image_write_to_memory, (png_imagep image, void *memory, 3210 png_alloc_size_t * PNG_RESTRICT memory_bytes, int convert_to_8_bit, 3211 const void *buffer, png_int_32 row_stride, const void *colormap)); 3212 /* Write the image to the given memory buffer. The function both writes the 3213 * whole PNG data stream to *memory and updates *memory_bytes with the count 3214 * of bytes written. 3215 * 3216 * 'memory' may be NULL. In this case *memory_bytes is not read however on 3217 * success the number of bytes which would have been written will still be 3218 * stored in *memory_bytes. On failure *memory_bytes will contain 0. 3219 * 3220 * If 'memory' is not NULL it must point to memory[*memory_bytes] of 3221 * writeable memory. 3222 * 3223 * If the function returns success memory[*memory_bytes] (if 'memory' is not 3224 * NULL) contains the written PNG data. *memory_bytes will always be less 3225 * than or equal to the original value. 3226 * 3227 * If the function returns false and *memory_bytes was not changed an error 3228 * occurred during write. If *memory_bytes was changed, or is not 0 if 3229 * 'memory' was NULL, the write would have succeeded but for the memory 3230 * buffer being too small. *memory_bytes contains the required number of 3231 * bytes and will be bigger that the original value. 3232 */ 3233 3234 #define png_image_write_get_memory_size(image, size, convert_to_8_bit, buffer,\ 3235 row_stride, colormap)\ 3236 png_image_write_to_memory(&(image), 0, &(size), convert_to_8_bit, buffer,\ 3237 row_stride, colormap) 3238 /* Return the amount of memory in 'size' required to compress this image. 3239 * The png_image structure 'image' must be filled in as in the above 3240 * function and must not be changed before the actual write call, the buffer 3241 * and all other parameters must also be identical to that in the final 3242 * write call. The 'size' variable need not be initialized. 3243 * 3244 * NOTE: the macro returns true/false, if false is returned 'size' will be 3245 * set to zero and the write failed and probably will fail if tried again. 3246 */ 3247 3248 /* You can pre-allocate the buffer by making sure it is of sufficient size 3249 * regardless of the amount of compression achieved. The buffer size will 3250 * always be bigger than the original image and it will never be filled. The 3251 * following macros are provided to assist in allocating the buffer. 3252 */ 3253 #define PNG_IMAGE_DATA_SIZE(image) (PNG_IMAGE_SIZE(image)+(image).height) 3254 /* The number of uncompressed bytes in the PNG byte encoding of the image; 3255 * uncompressing the PNG IDAT data will give this number of bytes. 3256 * 3257 * NOTE: while PNG_IMAGE_SIZE cannot overflow for an image in memory this 3258 * macro can because of the extra bytes used in the PNG byte encoding. You 3259 * need to avoid this macro if your image size approaches 2^30 in width or 3260 * height. The same goes for the remainder of these macros; they all produce 3261 * bigger numbers than the actual in-memory image size. 3262 */ 3263 #ifndef PNG_ZLIB_MAX_SIZE 3264 # define PNG_ZLIB_MAX_SIZE(b) ((b)+(((b)+7U)>>3)+(((b)+63U)>>6)+11U) 3265 /* An upper bound on the number of compressed bytes given 'b' uncompressed 3266 * bytes. This is based on deflateBounds() in zlib; different 3267 * implementations of zlib compression may conceivably produce more data so 3268 * if your zlib implementation is not zlib itself redefine this macro 3269 * appropriately. 3270 */ 3271 #endif 3272 3273 #define PNG_IMAGE_COMPRESSED_SIZE_MAX(image)\ 3274 PNG_ZLIB_MAX_SIZE((png_alloc_size_t)PNG_IMAGE_DATA_SIZE(image)) 3275 /* An upper bound on the size of the data in the PNG IDAT chunks. */ 3276 3277 #define PNG_IMAGE_PNG_SIZE_MAX_(image, image_size)\ 3278 ((8U/*sig*/+25U/*IHDR*/+16U/*gAMA*/+44U/*cHRM*/+12U/*IEND*/+\ 3279 (((image).format&PNG_FORMAT_FLAG_COLORMAP)?/*colormap: PLTE, tRNS*/\ 3280 12U+3U*(image).colormap_entries/*PLTE data*/+\ 3281 (((image).format&PNG_FORMAT_FLAG_ALPHA)?\ 3282 12U/*tRNS*/+(image).colormap_entries:0U):0U)+\ 3283 12U)+(12U*((image_size)/PNG_ZBUF_SIZE))/*IDAT*/+(image_size)) 3284 /* A helper for the following macro; if your compiler cannot handle the 3285 * following macro use this one with the result of 3286 * PNG_IMAGE_COMPRESSED_SIZE_MAX(image) as the second argument (most 3287 * compilers should handle this just fine.) 3288 */ 3289 3290 #define PNG_IMAGE_PNG_SIZE_MAX(image)\ 3291 PNG_IMAGE_PNG_SIZE_MAX_(image, PNG_IMAGE_COMPRESSED_SIZE_MAX(image)) 3292 /* An upper bound on the total length of the PNG data stream for 'image'. 3293 * The result is of type png_alloc_size_t, on 32-bit systems this may 3294 * overflow even though PNG_IMAGE_DATA_SIZE does not overflow; the write will 3295 * run out of buffer space but return a corrected size which should work. 3296 */ 3297 #endif /* SIMPLIFIED_WRITE */ 3298 /******************************************************************************* 3299 * END OF SIMPLIFIED API 3300 ******************************************************************************/ 3301 #endif /* SIMPLIFIED_{READ|WRITE} */ 3302 3303 /******************************************************************************* 3304 * Section 6: IMPLEMENTATION OPTIONS 3305 ******************************************************************************* 3306 * 3307 * Support for arbitrary implementation-specific optimizations. The API allows 3308 * particular options to be turned on or off. 'Option' is the number of the 3309 * option and 'onoff' is 0 (off) or non-0 (on). The value returned is given 3310 * by the PNG_OPTION_ defines below. 3311 * 3312 * HARDWARE: normally hardware capabilities, such as the Intel SSE instructions, 3313 * are detected at run time, however sometimes it may be impossible 3314 * to do this in user mode, in which case it is necessary to discover 3315 * the capabilities in an OS specific way. Such capabilities are 3316 * listed here when libpng has support for them and must be turned 3317 * ON by the application if present. 3318 * 3319 * SOFTWARE: sometimes software optimizations actually result in performance 3320 * decrease on some architectures or systems, or with some sets of 3321 * PNG images. 'Software' options allow such optimizations to be 3322 * selected at run time. 3323 */ 3324 #ifdef PNG_SET_OPTION_SUPPORTED 3325 3326 /* HARDWARE: ARM Neon SIMD instructions supported */ 3327 #ifdef PNG_ARM_NEON_API_SUPPORTED 3328 # define PNG_ARM_NEON 0 3329 #endif 3330 3331 /* SOFTWARE: Force maximum window */ 3332 #define PNG_MAXIMUM_INFLATE_WINDOW 2 3333 3334 /* SOFTWARE: Check ICC profile for sRGB */ 3335 #define PNG_SKIP_sRGB_CHECK_PROFILE 4 3336 3337 /* HARDWARE: MIPS MSA SIMD instructions supported */ 3338 #ifdef PNG_MIPS_MSA_API_SUPPORTED 3339 # define PNG_MIPS_MSA 6 3340 #endif 3341 3342 /* SOFTWARE: Disable Adler32 check on IDAT */ 3343 #ifdef PNG_DISABLE_ADLER32_CHECK_SUPPORTED 3344 # define PNG_IGNORE_ADLER32 8 3345 #endif 3346 3347 /* HARDWARE: PowerPC VSX SIMD instructions supported */ 3348 #ifdef PNG_POWERPC_VSX_API_SUPPORTED 3349 # define PNG_POWERPC_VSX 10 3350 #endif 3351 3352 /* HARDWARE: MIPS MMI SIMD instructions supported */ 3353 #ifdef PNG_MIPS_MMI_API_SUPPORTED 3354 # define PNG_MIPS_MMI 12 3355 #endif 3356 3357 /* HARDWARE: RISC-V RVV SIMD instructions supported */ 3358 #ifdef PNG_RISCV_RVV_API_SUPPORTED 3359 # define PNG_RISCV_RVV 14 3360 #endif 3361 3362 /* Next option - numbers must be even */ 3363 #define PNG_OPTION_NEXT 16 3364 3365 /* Return values: NOTE: there are four values and 'off' is *not* zero */ 3366 #define PNG_OPTION_UNSET 0 /* Unset - defaults to off */ 3367 #define PNG_OPTION_INVALID 1 /* Option number out of range */ 3368 #define PNG_OPTION_OFF 2 3369 #define PNG_OPTION_ON 3 3370 3371 PNG_EXPORT(244, int, png_set_option, (png_structrp png_ptr, int option, 3372 int onoff)); 3373 #endif /* SET_OPTION */ 3374 3375 /******************************************************************************* 3376 * END OF HARDWARE AND SOFTWARE OPTIONS 3377 ******************************************************************************/ 3378 3379 #ifdef PNG_APNG_SUPPORTED 3380 PNG_EXPORT(260, png_uint_32, png_get_acTL, (png_structp png_ptr, 3381 png_infop info_ptr, png_uint_32 *num_frames, png_uint_32 *num_plays)); 3382 3383 PNG_EXPORT(261, png_uint_32, png_set_acTL, (png_structp png_ptr, 3384 png_infop info_ptr, png_uint_32 num_frames, png_uint_32 num_plays)); 3385 3386 PNG_EXPORT(262, png_uint_32, png_get_num_frames, (png_structp png_ptr, 3387 png_infop info_ptr)); 3388 3389 PNG_EXPORT(263, png_uint_32, png_get_num_plays, (png_structp png_ptr, 3390 png_infop info_ptr)); 3391 3392 PNG_EXPORT(264, png_uint_32, png_get_next_frame_fcTL, 3393 (png_structp png_ptr, png_infop info_ptr, png_uint_32 *width, 3394 png_uint_32 *height, png_uint_32 *x_offset, png_uint_32 *y_offset, 3395 png_uint_16 *delay_num, png_uint_16 *delay_den, png_byte *dispose_op, 3396 png_byte *blend_op)); 3397 3398 PNG_EXPORT(265, png_uint_32, png_set_next_frame_fcTL, 3399 (png_structp png_ptr, png_infop info_ptr, png_uint_32 width, 3400 png_uint_32 height, png_uint_32 x_offset, png_uint_32 y_offset, 3401 png_uint_16 delay_num, png_uint_16 delay_den, png_byte dispose_op, 3402 png_byte blend_op)); 3403 3404 PNG_EXPORT(266, png_uint_32, png_get_next_frame_width, 3405 (png_structp png_ptr, png_infop info_ptr)); 3406 PNG_EXPORT(267, png_uint_32, png_get_next_frame_height, 3407 (png_structp png_ptr, png_infop info_ptr)); 3408 PNG_EXPORT(268, png_uint_32, png_get_next_frame_x_offset, 3409 (png_structp png_ptr, png_infop info_ptr)); 3410 PNG_EXPORT(269, png_uint_32, png_get_next_frame_y_offset, 3411 (png_structp png_ptr, png_infop info_ptr)); 3412 PNG_EXPORT(270, png_uint_16, png_get_next_frame_delay_num, 3413 (png_structp png_ptr, png_infop info_ptr)); 3414 PNG_EXPORT(271, png_uint_16, png_get_next_frame_delay_den, 3415 (png_structp png_ptr, png_infop info_ptr)); 3416 PNG_EXPORT(272, png_byte, png_get_next_frame_dispose_op, 3417 (png_structp png_ptr, png_infop info_ptr)); 3418 PNG_EXPORT(273, png_byte, png_get_next_frame_blend_op, 3419 (png_structp png_ptr, png_infop info_ptr)); 3420 PNG_EXPORT(274, png_byte, png_get_first_frame_is_hidden, 3421 (png_structp png_ptr, png_infop info_ptr)); 3422 PNG_EXPORT(275, png_uint_32, png_set_first_frame_is_hidden, 3423 (png_structp png_ptr, png_infop info_ptr, png_byte is_hidden)); 3424 3425 #ifdef PNG_READ_APNG_SUPPORTED 3426 PNG_EXPORT(276, void, png_read_frame_head, (png_structp png_ptr, 3427 png_infop info_ptr)); 3428 #ifdef PNG_PROGRESSIVE_READ_SUPPORTED 3429 PNG_EXPORT(277, void, png_set_progressive_frame_fn, (png_structp png_ptr, 3430 png_progressive_frame_ptr frame_info_fn, 3431 png_progressive_frame_ptr frame_end_fn)); 3432 #endif /* PROGRESSIVE_READ */ 3433 #endif /* READ_APNG */ 3434 3435 #ifdef PNG_WRITE_APNG_SUPPORTED 3436 PNG_EXPORT(278, void, png_write_frame_head, (png_structp png_ptr, 3437 png_infop info_ptr, png_bytepp row_pointers, 3438 png_uint_32 width, png_uint_32 height, 3439 png_uint_32 x_offset, png_uint_32 y_offset, 3440 png_uint_16 delay_num, png_uint_16 delay_den, png_byte dispose_op, 3441 png_byte blend_op)); 3442 3443 PNG_EXPORT(279, void, png_write_frame_tail, (png_structp png_ptr, 3444 png_infop info_ptr)); 3445 #endif /* WRITE_APNG */ 3446 #endif /* APNG */ 3447 3448 /* Maintainer: Put new public prototypes here ^, in libpng.3, in project 3449 * defs, and in scripts/symbols.def. 3450 */ 3451 3452 /* The last ordinal number (this is the *last* one already used; the next 3453 * one to use is one more than this.) 3454 */ 3455 #ifdef PNG_EXPORT_LAST_ORDINAL 3456 #ifdef PNG_APNG_SUPPORTED 3457 PNG_EXPORT_LAST_ORDINAL(279); 3458 #else 3459 PNG_EXPORT_LAST_ORDINAL(259); 3460 #endif /* APNG */ 3461 #endif 3462 3463 #ifdef __cplusplus 3464 } 3465 #endif 3466 3467 #endif /* PNG_VERSION_INFO_ONLY */ 3468 /* Do not put anything past this line */ 3469 #endif /* PNG_H */