pngpriv.h 64.8 KB
Newer Older
1

2
/* pngpriv.h - private declarations for use inside libpng
3 4
 *
 * For conditions of distribution and use, see copyright notice in png.h
5
 * Copyright (c) 1998-2011 Glenn Randers-Pehrson
6 7
 * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)
 * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
8
 *
9
 * Last changed in libpng 1.5.7 [(PENDING RELEASE)]
10
 *
11
 * This code is released under the libpng license.
12
 * For conditions of distribution and use, see the disclaimer
13
 * and license in png.h
14 15
 */

16 17 18 19 20 21 22 23 24 25 26
/* The symbols declared in this file (including the functions declared
 * as PNG_EXTERN) are PRIVATE.  They are not part of the libpng public
 * interface, and are not recommended for use by regular applications.
 * Some of them may become public in the future; others may stay private,
 * change in an incompatible way, or even disappear.
 * Although the libpng users are not forbidden to include this header,
 * they should be well aware of the issues that may arise from doing so.
 */

#ifndef PNGPRIV_H
#define PNGPRIV_H
27

28 29 30 31 32 33 34 35 36 37 38 39 40 41
/* Feature Test Macros.  The following are defined here to ensure that correctly
 * implemented libraries reveal the APIs libpng needs to build and hide those
 * that are not needed and potentially damaging to the compilation.
 *
 * Feature Test Macros must be defined before any system header is included (see
 * POSIX 1003.1 2.8.2 "POSIX Symbols."
 *
 * These macros only have an effect if the operating system supports either
 * POSIX 1003.1 or C99, or both.  On other operating systems (particularly
 * Windows/Visual Studio) there is no effect; the OS specific tests below are
 * still required (as of 2011-05-02.)
 */
#define _POSIX_SOURCE 1 /* Just the POSIX 1003.1 and C89 APIs */

42 43 44 45 46
/* This is required for the definition of abort(), used as a last ditch
 * error handler when all else fails.
 */
#include <stdlib.h>

47 48 49
/* This is used to find 'offsetof', used below for alignment tests. */
#include <stddef.h>

50 51
#define PNGLIB_BUILD /*libpng is being built, not used*/

52 53
#ifdef PNG_USER_CONFIG
#  include "pngusr.h"
54 55 56 57 58 59 60
   /* These should have been defined in pngusr.h */
#  ifndef PNG_USER_PRIVATEBUILD
#    define PNG_USER_PRIVATEBUILD "Custom libpng build"
#  endif
#  ifndef PNG_USER_DLLFNAME_POSTFIX
#    define PNG_USER_DLLFNAME_POSTFIX "Cb"
#  endif
61
#endif
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126

/* Is this a build of a DLL where compilation of the object modules requires
 * different preprocessor settings to those required for a simple library?  If
 * so PNG_BUILD_DLL must be set.
 *
 * If libpng is used inside a DLL but that DLL does not export the libpng APIs
 * PNG_BUILD_DLL must not be set.  To avoid the code below kicking in build a
 * static library of libpng then link the DLL against that.
 */
#ifndef PNG_BUILD_DLL
#  ifdef DLL_EXPORT
      /* This is set by libtool when files are compiled for a DLL; libtool
       * always compiles twice, even on systems where it isn't necessary.  Set
       * PNG_BUILD_DLL in case it is necessary:
       */
#     define PNG_BUILD_DLL
#  else
#     ifdef _WINDLL
         /* This is set by the Microsoft Visual Studio IDE in projects that
          * build a DLL.  It can't easily be removed from those projects (it
          * isn't visible in the Visual Studio UI) so it is a fairly reliable
          * indication that PNG_IMPEXP needs to be set to the DLL export
          * attributes.
          */
#        define PNG_BUILD_DLL
#     else
#        ifdef __DLL__
            /* This is set by the Borland C system when compiling for a DLL
             * (as above.)
             */
#           define PNG_BUILD_DLL
#        else
            /* Add additional compiler cases here. */
#        endif
#     endif
#  endif
#endif /* Setting PNG_BUILD_DLL if required */

/* See pngconf.h for more details: the builder of the library may set this on
 * the command line to the right thing for the specific compilation system or it
 * may be automagically set above (at present we know of no system where it does
 * need to be set on the command line.)
 *
 * PNG_IMPEXP must be set here when building the library to prevent pngconf.h
 * setting it to the "import" setting for a DLL build.
 */
#ifndef PNG_IMPEXP
#  ifdef PNG_BUILD_DLL
#     define PNG_IMPEXP PNG_DLL_EXPORT
#  else
      /* Not building a DLL, or the DLL doesn't require specific export
       * definitions.
       */
#     define PNG_IMPEXP
#  endif
#endif

/* No warnings for private or deprecated functions in the build: */
#ifndef PNG_DEPRECATED
#  define PNG_DEPRECATED
#endif
#ifndef PNG_PRIVATE
#  define PNG_PRIVATE
#endif

127 128 129
#include "png.h"
#include "pnginfo.h"
#include "pngstruct.h"
130

131 132 133 134 135
/* pngconf.h does not set PNG_DLL_EXPORT unless it is required, so: */
#ifndef PNG_DLL_EXPORT
#  define PNG_DLL_EXPORT
#endif

136 137
/* This is used for 16 bit gamma tables - only the top level pointers are const,
 * this could be changed:
G
[devel]  
Glenn Randers-Pehrson 已提交
138
 */
139
typedef PNG_CONST png_uint_16p FAR * png_const_uint_16pp;
140

141 142 143 144
/* Added at libpng-1.2.9 */
/* Moved to pngpriv.h at libpng-1.5.0 */

/* config.h is created by and PNG_CONFIGURE_LIBPNG is set by the "configure"
145 146
 * script.  We may need it here to get the correct configuration on things
 * like limits.
147 148 149 150 151 152 153
 */
#ifdef PNG_CONFIGURE_LIBPNG
#  ifdef HAVE_CONFIG_H
#    include "config.h"
#  endif
#endif

154
/* Moved to pngpriv.h at libpng-1.5.0 */
155 156
/* NOTE: some of these may have been used in external applications as
 * these definitions were exposed in pngconf.h prior to 1.5.
G
[devel]  
Glenn Randers-Pehrson 已提交
157
 */
158

159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
/* If you are running on a machine where you cannot allocate more
 * than 64K of memory at once, uncomment this.  While libpng will not
 * normally need that much memory in a chunk (unless you load up a very
 * large file), zlib needs to know how big of a chunk it can use, and
 * libpng thus makes sure to check any memory allocation to verify it
 * will fit into memory.
 *
 * zlib provides 'MAXSEG_64K' which, if defined, indicates the
 * same limit and pngconf.h (already included) sets the limit
 * if certain operating systems are detected.
 */
#if defined(MAXSEG_64K) && !defined(PNG_MAX_MALLOC_64K)
#  define PNG_MAX_MALLOC_64K
#endif

174
#ifndef PNG_UNUSED
175 176 177 178 179
/* Unused formal parameter warnings are silenced using the following macro
 * which is expected to have no bad effects on performance (optimizing
 * compilers will probably remove it entirely).  Note that if you replace
 * it with something other than whitespace, you must include the terminating
 * semicolon.
180
 */
181 182
#  define PNG_UNUSED(param) (void)param;
#endif
183

G
[devel]  
Glenn Randers-Pehrson 已提交
184 185
/* Just a little check that someone hasn't tried to define something
 * contradictory.
186
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
187 188 189
#if (PNG_ZBUF_SIZE > 65536L) && defined(PNG_MAX_MALLOC_64K)
#  undef PNG_ZBUF_SIZE
#  define PNG_ZBUF_SIZE 65536L
190 191
#endif

192 193 194 195 196 197 198
/* PNG_STATIC is used to mark internal file scope functions if they need to be
 * accessed for implementation tests (see the code in tests/?*).
 */
#ifndef PNG_STATIC
#   define PNG_STATIC static
#endif

199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
/* C99 restrict is used where possible, to do this 'restrict' is defined as
 * empty if we can't be sure it is supported.  configure builds have already
 * done this work.
 */
#ifdef PNG_CONFIGURE_LIBPNG
#  define PNG_RESTRICT restrict
#else
   /* Modern compilers support restrict, but assume not for anything not
    * recognized here:
    */
#  if defined __GNUC__ || defined _MSC_VER || defined __WATCOMC__
#     define PNG_RESTRICT restrict
#  else
#     define PNG_RESTRICT
#  endif
#endif

216
/* If warnings or errors are turned off the code is disabled or redirected here.
217
 * From 1.5.4 functions have been added to allow very limited formatting of
218
 * error and warning messages - this code will also be disabled here.
219
 */
220 221 222 223 224 225 226 227 228
#ifdef PNG_WARNINGS_SUPPORTED
#  define PNG_WARNING_PARAMETERS(p) png_warning_parameters p;
#else
#  define png_warning(s1,s2) ((void)(s1))
#  define png_chunk_warning(s1,s2) ((void)(s1))
#  define png_warning_parameter(p,number,string) ((void)0)
#  define png_warning_parameter_unsigned(p,number,format,value) ((void)0)
#  define png_warning_parameter_signed(p,number,format,value) ((void)0)
#  define png_formatted_warning(pp,p,message) ((void)(pp))
229
#  define PNG_WARNING_PARAMETERS(p)
230 231 232 233
#endif
#ifndef PNG_ERROR_TEXT_SUPPORTED
#  define png_error(s1,s2) png_err(s1)
#  define png_chunk_error(s1,s2) png_err(s1)
234
#  define png_fixed_error(s1,s2) png_err(s1)
235 236
#endif

237 238 239 240 241 242 243 244 245 246 247
/* C allows up-casts from (void*) to any pointer and (const void*) to any
 * pointer to a const object.  C++ regards this as a type error and requires an
 * explicit, static, cast and provides the static_cast<> rune to ensure that
 * const is not cast away.
 */
#ifdef __cplusplus
#  define png_voidcast(type, value) static_cast<type>(value)
#else
#  define png_voidcast(type, value) (value)
#endif /* __cplusplus */

248
#ifndef PNG_EXTERN
249
/* The functions exported by PNG_EXTERN are internal functions, which
250
 * aren't usually used outside the library (as far as I know), so it is
251 252
 * debatable if they should be exported at all.  In the future, when it
 * is possible to have run-time registry of chunk-handling functions,
253
 * some of these might be made available again.
254 255 256
 *
 * 1.5.7: turned the use of 'extern' back on, since it is localized to pngpriv.h
 * it should be safe now (it is unclear why it was turned off.)
257
 */
258
#  define PNG_EXTERN extern
259
#endif
260

261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
#ifndef PNG_CONST_DATA
/* Some compilers fail if given an "extern const" data declaration followed by a
 * "const" definition, therefore declaring const data in pngpriv.h is
 * impossible, the following allows a work-round for the problematic compilers
 * by defining -DPNG_NO_CONST_DATA on the command line (notice that this does
 * not affect static const definitions, where there is no declaration.)
 */
#  ifndef PNG_NO_CONST_DATA
      /* List of compilers where "extern const" is known to be OK: */
#     if defined __GNUC__ || defined _MSC_VER || defined __WATCOMC__
#        define PNG_CONST_DATA const
#     endif
#  endif

   /* Default to disabling const data declarations: */
#  ifndef PNG_CONST_DATA
#     define PNG_CONST_DATA /*const*/
#  endif
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
281 282 283 284 285 286 287 288 289 290
/* Some fixed point APIs are still required even if not exported because
 * they get used by the corresponding floating point APIs.  This magic
 * deals with this:
 */
#ifdef PNG_FIXED_POINT_SUPPORTED
#  define PNGFAPI PNGAPI
#else
#  define PNGFAPI /* PRIVATE */
#endif

291 292 293
/* Other defines specific to compilers can go here.  Try to keep
 * them inside an appropriate ifdef/endif pair for portability.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
294 295
#if defined(PNG_FLOATING_POINT_SUPPORTED) ||\
    defined(PNG_FLOATING_ARITHMETIC_SUPPORTED)
296
   /* png.c requires the following ANSI-C constants if the conversion of
G
[devel]  
Glenn Randers-Pehrson 已提交
297
    * floating point to ASCII is implemented therein:
298
    *
G
[devel]  
Glenn Randers-Pehrson 已提交
299
    *  DBL_DIG  Maximum number of decimal digits (can be set to any constant)
300
    *  DBL_MIN  Smallest normalized fp number (can be set to an arbitrary value)
G
[devel]  
Glenn Randers-Pehrson 已提交
301 302 303
    *  DBL_MAX  Maximum floating point number (can be set to an arbitrary value)
    */
#  include <float.h>
304

305 306
#  if (defined(__MWERKS__) && defined(macintosh)) || defined(applec) || \
    defined(THINK_C) || defined(__SC__) || defined(TARGET_OS_MAC)
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
     /* We need to check that <math.h> hasn't already been included earlier
      * as it seems it doesn't agree with <fp.h>, yet we should really use
      * <fp.h> if possible.
      */
#    if !defined(__MATH_H__) && !defined(__MATH_H) && !defined(__cmath__)
#      include <fp.h>
#    endif
#  else
#    include <math.h>
#  endif
#  if defined(_AMIGA) && defined(__SASC) && defined(_M68881)
     /* Amiga SAS/C: We must include builtin FPU functions when compiling using
      * MATH=68881
      */
#    include <m68881.h>
#  endif
#endif

/* This provides the non-ANSI (far) memory allocation routines. */
#if defined(__TURBOC__) && defined(__MSDOS__)
#  include <mem.h>
#  include <alloc.h>
#endif

#if defined(WIN32) || defined(_Windows) || defined(_WINDOWS) || \
332
    defined(_WIN32) || defined(__WIN32__)
333 334 335
#  include <windows.h>  /* defines _WINDOWS_ macro */
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
336 337 338
/* Moved here around 1.5.0beta36 from pngconf.h */
/* Users may want to use these so they are not private.  Any library
 * functions that are passed far data must be model-independent.
339 340
 */

G
[devel]  
Glenn Randers-Pehrson 已提交
341 342 343 344 345 346 347
/* Memory model/platform independent fns */
#ifndef PNG_ABORT
#  ifdef _WINDOWS_
#    define PNG_ABORT() ExitProcess(0)
#  else
#    define PNG_ABORT() abort()
#  endif
348 349
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
#ifdef USE_FAR_KEYWORD
/* Use this to make far-to-near assignments */
#  define CHECK   1
#  define NOCHECK 0
#  define CVT_PTR(ptr) (png_far_to_near(png_ptr,ptr,CHECK))
#  define CVT_PTR_NOCHECK(ptr) (png_far_to_near(png_ptr,ptr,NOCHECK))
#  define png_strlen  _fstrlen
#  define png_memcmp  _fmemcmp    /* SJT: added */
#  define png_memcpy  _fmemcpy
#  define png_memset  _fmemset
#else
#  ifdef _WINDOWS_  /* Favor Windows over C runtime fns */
#    define CVT_PTR(ptr)         (ptr)
#    define CVT_PTR_NOCHECK(ptr) (ptr)
#    define png_strlen  lstrlenA
#    define png_memcmp  memcmp
#    define png_memcpy  CopyMemory
#    define png_memset  memset
#  else
#    define CVT_PTR(ptr)         (ptr)
#    define CVT_PTR_NOCHECK(ptr) (ptr)
#    define png_strlen  strlen
#    define png_memcmp  memcmp      /* SJT: added */
#    define png_memcpy  memcpy
#    define png_memset  memset
#  endif
376
#endif
377

378 379 380
/* These macros may need to be architecture dependent. */
#define PNG_ALIGN_NONE   0 /* do not use data alignment */
#define PNG_ALIGN_ALWAYS 1 /* assume unaligned accesses are OK */
381
#ifdef offsetof
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
#  define PNG_ALIGN_OFFSET 2 /* use offsetof to determine alignment */
#else
#  define PNG_ALIGN_OFFSET -1 /* prevent the use of this */
#endif
#define PNG_ALIGN_SIZE   3 /* use sizeof to determine alignment */

#ifndef PNG_ALIGN_TYPE
   /* Default to using aligned access optimizations and requiring alignment to a
    * multiple of the data type size.  Override in a compiler specific fashion
    * if necessary by inserting tests here:
    */
#  define PNG_ALIGN_TYPE PNG_ALIGN_SIZE
#endif

#if PNG_ALIGN_TYPE == PNG_ALIGN_SIZE
   /* This is used because in some compiler implementations non-aligned
    * structure members are supported, so the offsetof approach below fails.
    * Set PNG_ALIGN_TO_SIZE=0 for compiler combinations where unaligned access
    * is good for performance.  Do not do this unless you have tested the result
    * and understand it.
    */
#  define png_alignof(type) (sizeof (type))
#else
#  if PNG_ALIGN_TYPE == PNG_ALIGN_OFFSET
#     define png_alignof(type) offsetof(struct{char c; type t;}, t)
#  else
#     if PNG_ALIGN_TYPE == PNG_ALIGN_ALWAYS
#        define png_alignof(type) (1)
#     endif
      /* Else leave png_alignof undefined to prevent use thereof */
#  endif
413 414 415 416 417
#endif

/* This implicitly assumes alignment is always to a power of 2. */
#ifdef png_alignof
#  define png_isaligned(ptr, type)\
418
   ((((const char*)ptr-(const char*)0) & (png_alignof(type)-1)) == 0)
419 420 421 422
#else
#  define png_isaligned(ptr, type) 0
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
423 424 425 426 427 428
/* End of memory model/platform independent support */
/* End of 1.5.0beta36 move from pngconf.h */

/* CONSTANTS and UTILITY MACROS
 * These are used internally by libpng and not exposed in the API
 */
429

430
/* Various modes of operation.  Note that after an init, mode is set to
431 432 433
 * zero automatically when the structure is created.  Three of these
 * are defined in png.h because they need to be visible to applications
 * that call png_set_unknown_chunk().
434
 */
435 436
/* #define PNG_HAVE_IHDR            0x01 (defined in png.h) */
/* #define PNG_HAVE_PLTE            0x02 (defined in png.h) */
437
#define PNG_HAVE_IDAT               0x04
438
/* #define PNG_AFTER_IDAT           0x08 (defined in png.h) */
439 440 441 442 443 444 445 446 447
#define PNG_HAVE_IEND               0x10
#define PNG_HAVE_gAMA               0x20
#define PNG_HAVE_cHRM               0x40
#define PNG_HAVE_sRGB               0x80
#define PNG_HAVE_CHUNK_HEADER      0x100
#define PNG_WROTE_tIME             0x200
#define PNG_WROTE_INFO_BEFORE_PLTE 0x400
#define PNG_BACKGROUND_IS_GRAY     0x800
#define PNG_HAVE_PNG_SIGNATURE    0x1000
448
#define PNG_HAVE_CHUNK_AFTER_IDAT 0x2000 /* Have another chunk after IDAT */
449

450
/* Flags for the transformations the PNG library does on the image data */
451 452 453 454 455 456
#define PNG_BGR                 0x0001
#define PNG_INTERLACE           0x0002
#define PNG_PACK                0x0004
#define PNG_SHIFT               0x0008
#define PNG_SWAP_BYTES          0x0010
#define PNG_INVERT_MONO         0x0020
457
#define PNG_QUANTIZE            0x0040
458
#define PNG_COMPOSE             0x0080     /* Was PNG_BACKGROUND */
459
#define PNG_BACKGROUND_EXPAND   0x0100
460
#define PNG_EXPAND_16           0x0200     /* Added to libpng 1.5.2 */
461
#define PNG_16_TO_8             0x0400     /* Becomes 'chop' in 1.5.4 */
462 463 464 465
#define PNG_RGBA                0x0800
#define PNG_EXPAND              0x1000
#define PNG_GAMMA               0x2000
#define PNG_GRAY_TO_RGB         0x4000
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
#define PNG_FILLER              0x8000
#define PNG_PACKSWAP           0x10000
#define PNG_SWAP_ALPHA         0x20000
#define PNG_STRIP_ALPHA        0x40000
#define PNG_INVERT_ALPHA       0x80000
#define PNG_USER_TRANSFORM    0x100000
#define PNG_RGB_TO_GRAY_ERR   0x200000
#define PNG_RGB_TO_GRAY_WARN  0x400000
#define PNG_RGB_TO_GRAY       0x600000 /* two bits, RGB_TO_GRAY_ERR|WARN */
#define PNG_ENCODE_ALPHA      0x800000 /* Added to libpng-1.5.4 */
#define PNG_ADD_ALPHA         0x1000000 /* Added to libpng-1.2.7 */
#define PNG_EXPAND_tRNS       0x2000000 /* Added to libpng-1.2.9 */
#define PNG_SCALE_16_TO_8     0x4000000 /* Added to libpng-1.5.4 */
                       /*   0x8000000 unused */
                       /*  0x10000000 unused */
                       /*  0x20000000 unused */
                       /*  0x40000000 unused */
483
/* Flags for png_create_struct */
484 485 486 487 488 489 490
#define PNG_STRUCT_PNG   0x0001
#define PNG_STRUCT_INFO  0x0002

/* Scaling factor for filter heuristic weighting calculations */
#define PNG_WEIGHT_FACTOR (1<<(PNG_WEIGHT_SHIFT))
#define PNG_COST_FACTOR (1<<(PNG_COST_SHIFT))

491
/* Flags for the png_ptr->flags rather than declaring a byte for each one */
492 493 494 495 496 497 498 499 500 501 502 503
#define PNG_FLAG_ZLIB_CUSTOM_STRATEGY     0x0001
#define PNG_FLAG_ZLIB_CUSTOM_LEVEL        0x0002
#define PNG_FLAG_ZLIB_CUSTOM_MEM_LEVEL    0x0004
#define PNG_FLAG_ZLIB_CUSTOM_WINDOW_BITS  0x0008
#define PNG_FLAG_ZLIB_CUSTOM_METHOD       0x0010
#define PNG_FLAG_ZLIB_FINISHED            0x0020
#define PNG_FLAG_ROW_INIT                 0x0040
#define PNG_FLAG_FILLER_AFTER             0x0080
#define PNG_FLAG_CRC_ANCILLARY_USE        0x0100
#define PNG_FLAG_CRC_ANCILLARY_NOWARN     0x0200
#define PNG_FLAG_CRC_CRITICAL_USE         0x0400
#define PNG_FLAG_CRC_CRITICAL_IGNORE      0x0800
504 505 506
#define PNG_FLAG_ASSUME_sRGB              0x1000  /* Added to libpng-1.5.4 */
#define PNG_FLAG_OPTIMIZE_ALPHA           0x2000  /* Added to libpng-1.5.4 */
#define PNG_FLAG_DETECT_UNINITIALIZED     0x4000  /* Added to libpng-1.5.4 */
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
#define PNG_FLAG_KEEP_UNKNOWN_CHUNKS      0x8000
#define PNG_FLAG_KEEP_UNSAFE_CHUNKS       0x10000
#define PNG_FLAG_LIBRARY_MISMATCH         0x20000
#define PNG_FLAG_STRIP_ERROR_NUMBERS      0x40000
#define PNG_FLAG_STRIP_ERROR_TEXT         0x80000
#define PNG_FLAG_MALLOC_NULL_MEM_OK       0x100000
                                  /*      0x200000  unused */
                                  /*      0x400000  unused */
#define PNG_FLAG_BENIGN_ERRORS_WARN       0x800000  /* Added to libpng-1.4.0 */
#define PNG_FLAG_ZTXT_CUSTOM_STRATEGY    0x1000000  /* 5 lines added */
#define PNG_FLAG_ZTXT_CUSTOM_LEVEL       0x2000000  /* to libpng-1.5.4 */
#define PNG_FLAG_ZTXT_CUSTOM_MEM_LEVEL   0x4000000
#define PNG_FLAG_ZTXT_CUSTOM_WINDOW_BITS 0x8000000
#define PNG_FLAG_ZTXT_CUSTOM_METHOD      0x10000000
                                  /*     0x20000000  unused */
                                  /*     0x40000000  unused */
523 524 525 526 527 528 529 530 531 532

#define PNG_FLAG_CRC_ANCILLARY_MASK (PNG_FLAG_CRC_ANCILLARY_USE | \
                                     PNG_FLAG_CRC_ANCILLARY_NOWARN)

#define PNG_FLAG_CRC_CRITICAL_MASK  (PNG_FLAG_CRC_CRITICAL_USE | \
                                     PNG_FLAG_CRC_CRITICAL_IGNORE)

#define PNG_FLAG_CRC_MASK           (PNG_FLAG_CRC_ANCILLARY_MASK | \
                                     PNG_FLAG_CRC_CRITICAL_MASK)

533 534 535 536 537 538 539 540 541 542 543 544
/* zlib.h declares a magic type 'uInt' that limits the amount of data that zlib
 * can handle at once.  This type need be no larger than 16 bits (so maximum of
 * 65535), this define allows us to discover how big it is, but limited by the
 * maximuum for png_size_t.  The value can be overriden in a library build
 * (pngusr.h, or set it in CPPFLAGS) and it works to set it to a considerably
 * lower value (e.g. 255 works).  A lower value may help memory usage (slightly)
 * and may even improve performance on some systems (and degrade it on others.)
 */
#ifndef ZLIB_IO_MAX
#  define ZLIB_IO_MAX ((uInt)-1)
#endif

545
/* Save typing and make code easier to understand */
546 547 548 549 550

#define PNG_COLOR_DIST(c1, c2) (abs((int)((c1).red) - (int)((c2).red)) + \
   abs((int)((c1).green) - (int)((c2).green)) + \
   abs((int)((c1).blue) - (int)((c2).blue)))

551
/* Added to libpng-1.5.7: sRGB conversion tables */
552 553
#if defined PNG_SIMPLIFIED_READ_SUPPORTED ||\
   defined PNG_SIMPLIFIED_WRITE_SUPPORTED
554
#ifdef PNG_SIMPLIFIED_READ_SUPPORTED
555
extern /*PRIVATE*/ PNG_CONST_DATA png_uint_16 png_sRGB_table[256];
556 557 558 559 560
   /* Convert from an sRGB encoded value 0..255 to a 16-bit linear value,
    * 0..65535.  This table gives the closes 16-bit answers (no errors).
    */
#endif

561 562
extern /*PRIVATE*/ PNG_CONST_DATA png_uint_16 png_sRGB_base[512];
extern /*PRIVATE*/ PNG_CONST_DATA png_byte png_sRGB_delta[512];
563 564 565 566 567 568

#define PNG_sRGB_FROM_LINEAR(linear) ((png_sRGB_base[(linear)>>15] +\
   ((((linear)&0x7fff)*png_sRGB_delta[(linear)>>15])>>12)) >> 8)
   /* Given a value 'linear' in the range 0..255*65535 calculate the 8-bit sRGB
    * encoded value with maximum error 0.646365.  Note that the input is not a
    * 16-bit value; it has been multiplied by 255! */
569
#endif /* PNG_SIMPLIFIED_READ/WRITE */
570

571 572 573
/* Added to libpng-1.2.6 JB */
#define PNG_ROWBYTES(pixel_bits, width) \
    ((pixel_bits) >= 8 ? \
574 575
    ((png_size_t)(width) * (((png_size_t)(pixel_bits)) >> 3)) : \
    (( ((png_size_t)(width) * ((png_size_t)(pixel_bits))) + 7) >> 3) )
576 577

/* PNG_OUT_OF_RANGE returns true if value is outside the range
578 579 580 581
 * ideal-delta..ideal+delta.  Each argument is evaluated twice.
 * "ideal" and "delta" should be constants, normally simple
 * integers, "value" a variable. Added to libpng-1.2.6 JB
 */
582
#define PNG_OUT_OF_RANGE(value, ideal, delta) \
583
   ( (value) < (ideal)-(delta) || (value) > (ideal)+(delta) )
584

585
/* Conversions between fixed and floating point, only defined if
G
[devel]  
Glenn Randers-Pehrson 已提交
586 587 588 589
 * required (to make sure the code doesn't accidentally use float
 * when it is supposedly disabled.)
 */
#ifdef PNG_FLOATING_POINT_SUPPORTED
590
/* The floating point conversion can't overflow, though it can and
G
[devel]  
Glenn Randers-Pehrson 已提交
591 592 593 594 595 596 597 598
 * does lose accuracy relative to the original fixed point value.
 * In practice this doesn't matter because png_fixed_point only
 * stores numbers with very low precision.  The png_ptr and s
 * arguments are unused by default but are there in case error
 * checking becomes a requirement.
 */
#define png_float(png_ptr, fixed, s) (.00001 * (fixed))

599
/* The fixed point conversion performs range checking and evaluates
G
[devel]  
Glenn Randers-Pehrson 已提交
600 601 602
 * its argument multiple times, so must be used with care.  The
 * range checking uses the PNG specification values for a signed
 * 32 bit fixed point value except that the values are deliberately
603 604 605
 * rounded-to-zero to an integral value - 21474 (21474.83 is roughly
 * (2^31-1) * 100000). 's' is a string that describes the value being
 * converted.
G
[devel]  
Glenn Randers-Pehrson 已提交
606 607 608 609 610 611 612 613 614 615 616
 *
 * NOTE: this macro will raise a png_error if the range check fails,
 * therefore it is normally only appropriate to use this on values
 * that come from API calls or other sources where an out of range
 * error indicates a programming error, not a data error!
 *
 * NOTE: by default this is off - the macro is not used - because the
 * function call saves a lot of code.
 */
#ifdef PNG_FIXED_POINT_MACRO_SUPPORTED
#define png_fixed(png_ptr, fp, s) ((fp) <= 21474 && (fp) >= -21474 ?\
617
    ((png_fixed_point)(100000 * (fp))) : (png_fixed_error(png_ptr, s),0))
G
[devel]  
Glenn Randers-Pehrson 已提交
618 619 620 621 622 623
#else
PNG_EXTERN png_fixed_point png_fixed PNGARG((png_structp png_ptr, double fp,
   png_const_charp text));
#endif
#endif

624 625 626 627 628 629 630 631 632 633 634 635
/* Constants for known chunk types.  If you need to add a chunk, define the name
 * here.  For historical reasons these constants have the form png_<name>; i.e.
 * the prefix is lower case.  Please use decimal values as the parameters to
 * match the ISO PNG specification and to avoid relying on the C locale
 * interpretation of character values.
 *
 * Prior to 1.5.6 these constants were strings, as of 1.5.6 png_uint_32 values
 * are computed and a new macro (PNG_STRING_FROM_CHUNK) added to allow a string
 * to be generated if required.
 *
 * PNG_32b correctly produces a value shifted by up to 24 bits, even on
 * architectures where (int) is only 16 bits.
636
 */
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
#define PNG_32b(b,s) ((png_uint_32)(b) << (s))
#define PNG_CHUNK(b1,b2,b3,b4) \
   (PNG_32b(b1,24) | PNG_32b(b2,16) | PNG_32b(b3,8) | PNG_32b(b4,0))

#define png_IHDR PNG_CHUNK( 73,  72,  68,  82)
#define png_IDAT PNG_CHUNK( 73,  68,  65,  84)
#define png_IEND PNG_CHUNK( 73,  69,  78,  68)
#define png_PLTE PNG_CHUNK( 80,  76,  84,  69)
#define png_bKGD PNG_CHUNK( 98,  75,  71,  68)
#define png_cHRM PNG_CHUNK( 99,  72,  82,  77)
#define png_gAMA PNG_CHUNK(103,  65,  77,  65)
#define png_hIST PNG_CHUNK(104,  73,  83,  84)
#define png_iCCP PNG_CHUNK(105,  67,  67,  80)
#define png_iTXt PNG_CHUNK(105,  84,  88, 116)
#define png_oFFs PNG_CHUNK(111,  70,  70, 115)
#define png_pCAL PNG_CHUNK(112,  67,  65,  76)
#define png_sCAL PNG_CHUNK(115,  67,  65,  76)
#define png_pHYs PNG_CHUNK(112,  72,  89, 115)
#define png_sBIT PNG_CHUNK(115,  66,  73,  84)
#define png_sPLT PNG_CHUNK(115,  80,  76,  84)
#define png_sRGB PNG_CHUNK(115,  82,  71,  66)
#define png_sTER PNG_CHUNK(115,  84,  69,  82)
#define png_tEXt PNG_CHUNK(116,  69,  88, 116)
#define png_tIME PNG_CHUNK(116,  73,  77,  69)
#define png_tRNS PNG_CHUNK(116,  82,  78,  83)
#define png_zTXt PNG_CHUNK(122,  84,  88, 116)

/* The following will work on (signed char*) strings, whereas the get_uint_32
 * macro will fail on top-bit-set values because of the sign extension.
 */
#define PNG_CHUNK_FROM_STRING(s)\
   PNG_CHUNK(0xff&(s)[0], 0xff&(s)[1], 0xff&(s)[2], 0xff&(s)[3])

/* This uses (char), not (png_byte) to avoid warnings on systems where (char) is
 * signed and the argument is a (char[])  This macro will fail miserably on
 * systems where (char) is more than 8 bits.
 */
#define PNG_STRING_FROM_CHUNK(s,c)\
   (void)(((char*)(s))[0]=(char)((c)>>24), ((char*)(s))[1]=(char)((c)>>16),\
676
   ((char*)(s))[2]=(char)((c)>>8), ((char*)(s))[3]=(char)((c)))
677 678 679 680 681 682 683 684 685 686 687

/* Do the same but terminate with a null character. */
#define PNG_CSTRING_FROM_CHUNK(s,c)\
   (void)(PNG_STRING_FROM_CHUNK(s,c), ((char*)(s))[4] = 0)

/* Test on flag values as defined in the spec (section 5.4): */
#define PNG_CHUNK_ANCILLIARY(c)   (1 & ((c) >> 29))
#define PNG_CHUNK_CRITICAL(c)     (!PNG_CHUNK_ANCILLIARY(c))
#define PNG_CHUNK_PRIVATE(c)      (1 & ((c) >> 21))
#define PNG_CHUNK_RESERVED(c)     (1 & ((c) >> 13))
#define PNG_CHUNK_SAFE_TO_COPY(c) (1 & ((c) >>  5))
688

689
/* Gamma values (new at libpng-1.5.4): */
690 691 692 693
#define PNG_GAMMA_MAC_OLD 151724  /* Assume '1.8' is really 2.2/1.45! */
#define PNG_GAMMA_MAC_INVERSE 65909
#define PNG_GAMMA_sRGB_INVERSE 45455

694 695 696 697 698 699 700 701 702 703 704 705

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

/* These functions are used internally in the code.  They generally
 * shouldn't be used unless you are writing code to add or replace some
 * functionality in libpng.  More information about most functions can
 * be found in the files where the functions are located.
 */

706 707 708 709 710 711
/* Check the user version string for compatibility, returns false if the version
 * numbers aren't compatible.
 */
PNG_EXTERN int png_user_version_check(png_structp png_ptr,
   png_const_charp user_png_ver);

712
/* Allocate memory for an internal libpng struct */
713 714
PNG_EXTERN PNG_FUNCTION(png_voidp,png_create_struct,PNGARG((int type)),
   PNG_ALLOCATED);
715 716 717 718

/* Free memory from internal libpng struct */
PNG_EXTERN void png_destroy_struct PNGARG((png_voidp struct_ptr));

719 720 721
PNG_EXTERN PNG_FUNCTION(png_voidp,png_create_struct_2,
   PNGARG((int type, png_malloc_ptr malloc_fn, png_voidp mem_ptr)),
   PNG_ALLOCATED);
722
PNG_EXTERN void png_destroy_struct_2 PNGARG((png_voidp struct_ptr,
723
    png_free_ptr free_fn, png_voidp mem_ptr));
724 725 726

/* Free any memory that info_ptr points to and reset struct. */
PNG_EXTERN void png_info_destroy PNGARG((png_structp png_ptr,
727
    png_infop info_ptr));
728

729
/* Function to allocate memory for zlib.  PNGAPI is disallowed. */
730 731
PNG_EXTERN PNG_FUNCTION(voidpf,png_zalloc,PNGARG((voidpf png_ptr, uInt items,
   uInt size)),PNG_ALLOCATED);
732

733
/* Function to free memory for zlib.  PNGAPI is disallowed. */
734 735
PNG_EXTERN void png_zfree PNGARG((voidpf png_ptr, voidpf ptr));

736
/* Next four functions are used internally as callbacks.  PNGCBAPI is required
G
[devel]  
Glenn Randers-Pehrson 已提交
737 738
 * but not PNG_EXPORT.  PNGAPI added at libpng version 1.2.3, changed to
 * PNGCBAPI at 1.5.0
739
 */
740

741
PNG_EXTERN void PNGCBAPI png_default_read_data PNGARG((png_structp png_ptr,
742
    png_bytep data, png_size_t length));
743 744

#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
745
PNG_EXTERN void PNGCBAPI png_push_fill_buffer PNGARG((png_structp png_ptr,
746
    png_bytep buffer, png_size_t length));
747 748
#endif

749
PNG_EXTERN void PNGCBAPI png_default_write_data PNGARG((png_structp png_ptr,
750
    png_bytep data, png_size_t length));
751

752
#ifdef PNG_WRITE_FLUSH_SUPPORTED
753
#  ifdef PNG_STDIO_SUPPORTED
754
PNG_EXTERN void PNGCBAPI png_default_flush PNGARG((png_structp png_ptr));
755
#  endif
756 757 758 759 760
#endif

/* Reset the CRC variable */
PNG_EXTERN void png_reset_crc PNGARG((png_structp png_ptr));

761
/* Write the "data" buffer to whatever output you are using */
762 763
PNG_EXTERN void png_write_data PNGARG((png_structp png_ptr,
    png_const_bytep data, png_size_t length));
764

765 766 767
/* Read and check the PNG file signature */
PNG_EXTERN void png_read_sig PNGARG((png_structp png_ptr, png_infop info_ptr));

768 769 770
/* Read the chunk header (length + type name) */
PNG_EXTERN png_uint_32 png_read_chunk_header PNGARG((png_structp png_ptr));

771 772
/* Read data from whatever input you are using into the "data" buffer */
PNG_EXTERN void png_read_data PNGARG((png_structp png_ptr, png_bytep data,
773
    png_size_t length));
774 775 776

/* Read bytes into buf, and update png_ptr->crc */
PNG_EXTERN void png_crc_read PNGARG((png_structp png_ptr, png_bytep buf,
777
    png_size_t length));
778 779

/* Decompress data in a chunk that uses compression */
780
#if defined(PNG_READ_COMPRESSED_TEXT_SUPPORTED)
781
PNG_EXTERN void png_decompress_chunk PNGARG((png_structp png_ptr,
782 783
    int comp_type, png_size_t chunklength, png_size_t prefix_length,
    png_size_t *data_length));
784 785 786 787 788 789 790 791 792 793 794 795
#endif

/* Read "skip" bytes, read the file crc, and (optionally) verify png_ptr->crc */
PNG_EXTERN int png_crc_finish PNGARG((png_structp png_ptr, png_uint_32 skip));

/* Read the CRC from the file and compare it to the libpng calculated CRC */
PNG_EXTERN int png_crc_error PNGARG((png_structp png_ptr));

/* Calculate the CRC over a section of data.  Note that we are only
 * passing a maximum of 64K on systems that have this as a memory limit,
 * since this is the maximum buffer size we can specify.
 */
796 797
PNG_EXTERN void png_calculate_crc PNGARG((png_structp png_ptr,
    png_const_bytep ptr, png_size_t length));
798

799
#ifdef PNG_WRITE_FLUSH_SUPPORTED
800 801 802
PNG_EXTERN void png_flush PNGARG((png_structp png_ptr));
#endif

803
/* Write various chunks */
804 805 806 807 808

/* Write the IHDR chunk, and update the png_struct with the necessary
 * information.
 */
PNG_EXTERN void png_write_IHDR PNGARG((png_structp png_ptr, png_uint_32 width,
809 810 811
    png_uint_32 height,
    int bit_depth, int color_type, int compression_method, int filter_method,
    int interlace_method));
812

813 814
PNG_EXTERN void png_write_PLTE PNGARG((png_structp png_ptr,
    png_const_colorp palette, png_uint_32 num_pal));
815 816

PNG_EXTERN void png_write_IDAT PNGARG((png_structp png_ptr, png_bytep data,
817
    png_size_t length));
818 819 820

PNG_EXTERN void png_write_IEND PNGARG((png_structp png_ptr));

821
#ifdef PNG_WRITE_gAMA_SUPPORTED
822
#  ifdef PNG_FLOATING_POINT_SUPPORTED
823
PNG_EXTERN void png_write_gAMA PNGARG((png_structp png_ptr, double file_gamma));
824 825
#  endif
#  ifdef PNG_FIXED_POINT_SUPPORTED
826 827
PNG_EXTERN void png_write_gAMA_fixed PNGARG((png_structp png_ptr,
    png_fixed_point file_gamma));
828
#  endif
829 830
#endif

831
#ifdef PNG_WRITE_sBIT_SUPPORTED
832 833
PNG_EXTERN void png_write_sBIT PNGARG((png_structp png_ptr,
    png_const_color_8p sbit, int color_type));
834 835
#endif

836
#ifdef PNG_WRITE_cHRM_SUPPORTED
837
#  ifdef PNG_FLOATING_POINT_SUPPORTED
838
PNG_EXTERN void png_write_cHRM PNGARG((png_structp png_ptr,
839 840 841
    double white_x, double white_y,
    double red_x, double red_y, double green_x, double green_y,
    double blue_x, double blue_y));
842
#  endif
843
PNG_EXTERN void png_write_cHRM_fixed PNGARG((png_structp png_ptr,
844 845 846 847
    png_fixed_point int_white_x, png_fixed_point int_white_y,
    png_fixed_point int_red_x, png_fixed_point int_red_y, png_fixed_point
    int_green_x, png_fixed_point int_green_y, png_fixed_point int_blue_x,
    png_fixed_point int_blue_y));
848 849
#endif

850
#ifdef PNG_WRITE_sRGB_SUPPORTED
851
PNG_EXTERN void png_write_sRGB PNGARG((png_structp png_ptr,
852
    int intent));
853 854
#endif

855
#ifdef PNG_WRITE_iCCP_SUPPORTED
856
PNG_EXTERN void png_write_iCCP PNGARG((png_structp png_ptr,
857 858
    png_const_charp name, int compression_type,
    png_const_charp profile, int proflen));
859 860 861
   /* Note to maintainer: profile should be png_bytep */
#endif

862
#ifdef PNG_WRITE_sPLT_SUPPORTED
863
PNG_EXTERN void png_write_sPLT PNGARG((png_structp png_ptr,
864
    png_const_sPLT_tp palette));
865 866
#endif

867
#ifdef PNG_WRITE_tRNS_SUPPORTED
868 869 870
PNG_EXTERN void png_write_tRNS PNGARG((png_structp png_ptr,
    png_const_bytep trans, png_const_color_16p values, int number,
    int color_type));
871 872
#endif

873
#ifdef PNG_WRITE_bKGD_SUPPORTED
874
PNG_EXTERN void png_write_bKGD PNGARG((png_structp png_ptr,
875
    png_const_color_16p values, int color_type));
876 877
#endif

878
#ifdef PNG_WRITE_hIST_SUPPORTED
879 880
PNG_EXTERN void png_write_hIST PNGARG((png_structp png_ptr,
    png_const_uint_16p hist, int num_hist));
881 882
#endif

883
/* Chunks that have keywords */
884 885 886
#if defined(PNG_WRITE_TEXT_SUPPORTED) || defined(PNG_WRITE_pCAL_SUPPORTED) || \
    defined(PNG_WRITE_iCCP_SUPPORTED) || defined(PNG_WRITE_sPLT_SUPPORTED)
PNG_EXTERN png_size_t png_check_keyword PNGARG((png_structp png_ptr,
887
    png_const_charp key, png_charpp new_key));
888 889
#endif

890
#ifdef PNG_WRITE_tEXt_SUPPORTED
891 892
PNG_EXTERN void png_write_tEXt PNGARG((png_structp png_ptr, png_const_charp key,
    png_const_charp text, png_size_t text_len));
893 894
#endif

895
#ifdef PNG_WRITE_zTXt_SUPPORTED
896 897
PNG_EXTERN void png_write_zTXt PNGARG((png_structp png_ptr, png_const_charp key,
    png_const_charp text, png_size_t text_len, int compression));
898 899
#endif

900
#ifdef PNG_WRITE_iTXt_SUPPORTED
901
PNG_EXTERN void png_write_iTXt PNGARG((png_structp png_ptr,
902 903
    int compression, png_const_charp key, png_const_charp lang,
    png_const_charp lang_key, png_const_charp text));
904 905
#endif

906
#ifdef PNG_TEXT_SUPPORTED  /* Added at version 1.0.14 and 1.2.4 */
907
PNG_EXTERN int png_set_text_2 PNGARG((png_structp png_ptr,
908
    png_infop info_ptr, png_const_textp text_ptr, int num_text));
909 910
#endif

911
#ifdef PNG_WRITE_oFFs_SUPPORTED
912
PNG_EXTERN void png_write_oFFs PNGARG((png_structp png_ptr,
913
    png_int_32 x_offset, png_int_32 y_offset, int unit_type));
914 915
#endif

916
#ifdef PNG_WRITE_pCAL_SUPPORTED
917
PNG_EXTERN void png_write_pCAL PNGARG((png_structp png_ptr, png_charp purpose,
918
    png_int_32 X0, png_int_32 X1, int type, int nparams,
919
    png_const_charp units, png_charpp params));
920 921
#endif

922
#ifdef PNG_WRITE_pHYs_SUPPORTED
923
PNG_EXTERN void png_write_pHYs PNGARG((png_structp png_ptr,
924 925
    png_uint_32 x_pixels_per_unit, png_uint_32 y_pixels_per_unit,
    int unit_type));
926 927
#endif

928
#ifdef PNG_WRITE_tIME_SUPPORTED
929
PNG_EXTERN void png_write_tIME PNGARG((png_structp png_ptr,
930
    png_const_timep mod_time));
931 932
#endif

933
#ifdef PNG_WRITE_sCAL_SUPPORTED
934
PNG_EXTERN void png_write_sCAL_s PNGARG((png_structp png_ptr,
935
    int unit, png_const_charp width, png_const_charp height));
936 937 938 939 940 941 942 943
#endif

/* Called when finished processing a row of data */
PNG_EXTERN void png_write_finish_row PNGARG((png_structp png_ptr));

/* Internal use only.   Called before first row of data */
PNG_EXTERN void png_write_start_row PNGARG((png_structp png_ptr));

944
/* Combine a row of data, dealing with alpha, etc. if requested.  'row' is an
945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
 * array of png_ptr->width pixels.  If the image is not interlaced or this
 * is the final pass this just does a png_memcpy, otherwise the "display" flag
 * is used to determine whether to copy pixels that are not in the current pass.
 *
 * Because 'png_do_read_interlace' (below) replicates pixels this allows this
 * function to achieve the documented 'blocky' appearance during interlaced read
 * if display is 1 and the 'sparkle' appearance, where existing pixels in 'row'
 * are not changed if they are not in the current pass, when display is 0.
 *
 * 'display' must be 0 or 1, otherwise the memcpy will be done regardless.
 *
 * The API always reads from the png_struct row buffer and always assumes that
 * it is full width (png_do_read_interlace has already been called.)
 *
 * This function is only ever used to write to row buffers provided by the
 * caller of the relevant libpng API and the row must have already been
 * transformed by the read transformations.
962 963 964 965
 *
 * The PNG_USE_COMPILE_TIME_MASKS option causes generation of pre-computed
 * bitmasks for use within the code, otherwise runtime generated masks are used.
 * The default is compile time masks.
966
 */
967 968 969
#ifndef PNG_USE_COMPILE_TIME_MASKS
#  define PNG_USE_COMPILE_TIME_MASKS 1
#endif
970
PNG_EXTERN void png_combine_row PNGARG((png_structp png_ptr, png_bytep row,
971
    int display));
972

973
#ifdef PNG_READ_INTERLACING_SUPPORTED
974 975 976 977 978 979
/* Expand an interlaced row: the 'row_info' describes the pass data that has
 * been read in and must correspond to the pixels in 'row', the pixels are
 * expanded (moved apart) in 'row' to match the final layout, when doing this
 * the pixels are *replicated* to the intervening space.  This is essential for
 * the correct operation of png_combine_row, above.
 */
980
PNG_EXTERN void png_do_read_interlace PNGARG((png_row_infop row_info,
981
    png_bytep row, int pass, png_uint_32 transformations));
982 983 984 985
#endif

/* GRR TO DO (2.0 or whenever):  simplify other internal calling interfaces */

986
#ifdef PNG_WRITE_INTERLACING_SUPPORTED
987
/* Grab pixels out of a row for an interlaced pass */
988
PNG_EXTERN void png_do_write_interlace PNGARG((png_row_infop row_info,
989
    png_bytep row, int pass));
990 991
#endif

992 993 994
/* Unfilter a row: check the filter value before calling this, there is no point
 * calling it for PNG_FILTER_VALUE_NONE.
 */
995
PNG_EXTERN void png_read_filter_row PNGARG((png_structp pp, png_row_infop row_info,
996
    png_bytep row, png_const_bytep prev_row, int filter));
997

998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
PNG_EXTERN void png_read_filter_row_up_neon PNGARG((png_row_infop row_info,
    png_bytep row, png_const_bytep prev_row));
PNG_EXTERN void png_read_filter_row_sub3_neon PNGARG((png_row_infop row_info,
    png_bytep row, png_const_bytep prev_row));
PNG_EXTERN void png_read_filter_row_sub4_neon PNGARG((png_row_infop row_info,
    png_bytep row, png_const_bytep prev_row));
PNG_EXTERN void png_read_filter_row_avg3_neon PNGARG((png_row_infop row_info,
    png_bytep row, png_const_bytep prev_row));
PNG_EXTERN void png_read_filter_row_avg4_neon PNGARG((png_row_infop row_info,
    png_bytep row, png_const_bytep prev_row));
PNG_EXTERN void png_read_filter_row_paeth3_neon PNGARG((png_row_infop row_info,
    png_bytep row, png_const_bytep prev_row));
PNG_EXTERN void png_read_filter_row_paeth4_neon PNGARG((png_row_infop row_info,
    png_bytep row, png_const_bytep prev_row));

1013 1014
/* Choose the best filter to use and filter the row data */
PNG_EXTERN void png_write_find_filter PNGARG((png_structp png_ptr,
1015
    png_row_infop row_info));
1016

1017
/* Finish a row while reading, dealing with interlacing passes, etc. */
1018 1019
PNG_EXTERN void png_read_finish_row PNGARG((png_structp png_ptr));

1020
/* Initialize the row buffers, etc. */
1021
PNG_EXTERN void png_read_start_row PNGARG((png_structp png_ptr));
1022 1023

#ifdef PNG_READ_TRANSFORMS_SUPPORTED
1024
/* Optional call to update the users info structure */
1025
PNG_EXTERN void png_read_transform_info PNGARG((png_structp png_ptr,
1026
    png_infop info_ptr));
1027
#endif
1028

1029
/* These are the functions that do the transformations */
1030
#ifdef PNG_READ_FILLER_SUPPORTED
1031
PNG_EXTERN void png_do_read_filler PNGARG((png_row_infop row_info,
1032
    png_bytep row, png_uint_32 filler, png_uint_32 flags));
1033 1034
#endif

1035
#ifdef PNG_READ_SWAP_ALPHA_SUPPORTED
1036
PNG_EXTERN void png_do_read_swap_alpha PNGARG((png_row_infop row_info,
1037
    png_bytep row));
1038 1039
#endif

1040
#ifdef PNG_WRITE_SWAP_ALPHA_SUPPORTED
1041
PNG_EXTERN void png_do_write_swap_alpha PNGARG((png_row_infop row_info,
1042
    png_bytep row));
1043 1044
#endif

1045
#ifdef PNG_READ_INVERT_ALPHA_SUPPORTED
1046
PNG_EXTERN void png_do_read_invert_alpha PNGARG((png_row_infop row_info,
1047
    png_bytep row));
1048 1049
#endif

1050
#ifdef PNG_WRITE_INVERT_ALPHA_SUPPORTED
1051
PNG_EXTERN void png_do_write_invert_alpha PNGARG((png_row_infop row_info,
1052
    png_bytep row));
1053 1054 1055 1056
#endif

#if defined(PNG_WRITE_FILLER_SUPPORTED) || \
    defined(PNG_READ_STRIP_ALPHA_SUPPORTED)
1057 1058
PNG_EXTERN void png_do_strip_channel PNGARG((png_row_infop row_info,
    png_bytep row, int at_start));
1059 1060
#endif

1061
#ifdef PNG_16BIT_SUPPORTED
1062
#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
1063 1064
PNG_EXTERN void png_do_swap PNGARG((png_row_infop row_info,
    png_bytep row));
1065
#endif
1066
#endif
1067

1068 1069
#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
    defined(PNG_WRITE_PACKSWAP_SUPPORTED)
1070 1071
PNG_EXTERN void png_do_packswap PNGARG((png_row_infop row_info,
    png_bytep row));
1072 1073
#endif

1074
#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
1075 1076
PNG_EXTERN int png_do_rgb_to_gray PNGARG((png_structp png_ptr,
    png_row_infop row_info, png_bytep row));
1077 1078
#endif

1079
#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
1080
PNG_EXTERN void png_do_gray_to_rgb PNGARG((png_row_infop row_info,
1081
    png_bytep row));
1082 1083
#endif

1084
#ifdef PNG_READ_PACK_SUPPORTED
1085 1086
PNG_EXTERN void png_do_unpack PNGARG((png_row_infop row_info,
    png_bytep row));
1087 1088
#endif

1089
#ifdef PNG_READ_SHIFT_SUPPORTED
1090 1091
PNG_EXTERN void png_do_unshift PNGARG((png_row_infop row_info,
    png_bytep row, png_const_color_8p sig_bits));
1092 1093 1094
#endif

#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
1095 1096
PNG_EXTERN void png_do_invert PNGARG((png_row_infop row_info,
    png_bytep row));
1097 1098
#endif

1099
#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
1100 1101
PNG_EXTERN void png_do_scale_16_to_8 PNGARG((png_row_infop row_info,
    png_bytep row));
1102
#endif
1103

1104
#ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED
1105 1106
PNG_EXTERN void png_do_chop PNGARG((png_row_infop row_info,
    png_bytep row));
1107
#endif
1108

1109 1110
#ifdef PNG_READ_QUANTIZE_SUPPORTED
PNG_EXTERN void png_do_quantize PNGARG((png_row_infop row_info,
1111 1112
    png_bytep row, png_const_bytep palette_lookup,
    png_const_bytep quantize_lookup));
1113

1114
#  ifdef PNG_CORRECT_PALETTE_SUPPORTED
1115
PNG_EXTERN void png_correct_palette PNGARG((png_structp png_ptr,
1116
    png_colorp palette, int num_palette));
1117 1118 1119 1120
#  endif
#endif

#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
1121 1122
PNG_EXTERN void png_do_bgr PNGARG((png_row_infop row_info,
    png_bytep row));
1123 1124
#endif

1125
#ifdef PNG_WRITE_PACK_SUPPORTED
1126 1127 1128 1129
PNG_EXTERN void png_do_pack PNGARG((png_row_infop row_info,
   png_bytep row, png_uint_32 bit_depth));
#endif

1130
#ifdef PNG_WRITE_SHIFT_SUPPORTED
1131 1132
PNG_EXTERN void png_do_shift PNGARG((png_row_infop row_info,
    png_bytep row, png_const_color_8p bit_depth));
1133 1134
#endif

1135 1136 1137
#if defined(PNG_READ_BACKGROUND_SUPPORTED) ||\
    defined(PNG_READ_ALPHA_MODE_SUPPORTED)
PNG_EXTERN void png_do_compose PNGARG((png_row_infop row_info,
1138
    png_bytep row, png_structp png_ptr));
1139 1140
#endif

1141
#ifdef PNG_READ_GAMMA_SUPPORTED
1142
PNG_EXTERN void png_do_gamma PNGARG((png_row_infop row_info,
1143
    png_bytep row, png_structp png_ptr));
1144 1145
#endif

1146 1147 1148 1149 1150
#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
PNG_EXTERN void png_do_encode_alpha PNGARG((png_row_infop row_info,
   png_bytep row, png_structp png_ptr));
#endif

1151
#ifdef PNG_READ_EXPAND_SUPPORTED
1152
PNG_EXTERN void png_do_expand_palette PNGARG((png_row_infop row_info,
1153 1154
    png_bytep row, png_const_colorp palette, png_const_bytep trans,
    int num_trans));
1155
PNG_EXTERN void png_do_expand PNGARG((png_row_infop row_info,
1156
    png_bytep row, png_const_color_16p trans_color));
1157 1158
#endif

1159 1160 1161 1162 1163
#ifdef PNG_READ_EXPAND_16_SUPPORTED
PNG_EXTERN void png_do_expand_16 PNGARG((png_row_infop row_info,
    png_bytep row));
#endif

1164 1165 1166 1167
/* The following decodes the appropriate chunks, and does error correction,
 * then calls the appropriate callback for the chunk if it is valid.
 */

1168
/* Decode the IHDR chunk */
1169
PNG_EXTERN void png_handle_IHDR PNGARG((png_structp png_ptr, png_infop info_ptr,
1170
    png_uint_32 length));
1171
PNG_EXTERN void png_handle_PLTE PNGARG((png_structp png_ptr, png_infop info_ptr,
1172
    png_uint_32 length));
1173
PNG_EXTERN void png_handle_IEND PNGARG((png_structp png_ptr, png_infop info_ptr,
1174
    png_uint_32 length));
1175

1176
#ifdef PNG_READ_bKGD_SUPPORTED
1177
PNG_EXTERN void png_handle_bKGD PNGARG((png_structp png_ptr, png_infop info_ptr,
1178
    png_uint_32 length));
1179 1180
#endif

1181
#ifdef PNG_READ_cHRM_SUPPORTED
1182
PNG_EXTERN void png_handle_cHRM PNGARG((png_structp png_ptr, png_infop info_ptr,
1183
    png_uint_32 length));
1184 1185
#endif

1186
#ifdef PNG_READ_gAMA_SUPPORTED
1187
PNG_EXTERN void png_handle_gAMA PNGARG((png_structp png_ptr, png_infop info_ptr,
1188
    png_uint_32 length));
1189 1190
#endif

1191
#ifdef PNG_READ_hIST_SUPPORTED
1192
PNG_EXTERN void png_handle_hIST PNGARG((png_structp png_ptr, png_infop info_ptr,
1193
    png_uint_32 length));
1194 1195
#endif

1196
#ifdef PNG_READ_iCCP_SUPPORTED
1197
PNG_EXTERN void png_handle_iCCP PNGARG((png_structp png_ptr, png_infop info_ptr,
1198
    png_uint_32 length));
1199 1200
#endif /* PNG_READ_iCCP_SUPPORTED */

1201
#ifdef PNG_READ_iTXt_SUPPORTED
1202
PNG_EXTERN void png_handle_iTXt PNGARG((png_structp png_ptr, png_infop info_ptr,
1203
    png_uint_32 length));
1204 1205
#endif

1206
#ifdef PNG_READ_oFFs_SUPPORTED
1207
PNG_EXTERN void png_handle_oFFs PNGARG((png_structp png_ptr, png_infop info_ptr,
1208
    png_uint_32 length));
1209 1210
#endif

1211
#ifdef PNG_READ_pCAL_SUPPORTED
1212
PNG_EXTERN void png_handle_pCAL PNGARG((png_structp png_ptr, png_infop info_ptr,
1213
    png_uint_32 length));
1214 1215
#endif

1216
#ifdef PNG_READ_pHYs_SUPPORTED
1217
PNG_EXTERN void png_handle_pHYs PNGARG((png_structp png_ptr, png_infop info_ptr,
1218
    png_uint_32 length));
1219 1220
#endif

1221
#ifdef PNG_READ_sBIT_SUPPORTED
1222
PNG_EXTERN void png_handle_sBIT PNGARG((png_structp png_ptr, png_infop info_ptr,
1223
    png_uint_32 length));
1224 1225
#endif

1226
#ifdef PNG_READ_sCAL_SUPPORTED
1227
PNG_EXTERN void png_handle_sCAL PNGARG((png_structp png_ptr, png_infop info_ptr,
1228
    png_uint_32 length));
1229 1230
#endif

1231
#ifdef PNG_READ_sPLT_SUPPORTED
1232
PNG_EXTERN void png_handle_sPLT PNGARG((png_structp png_ptr, png_infop info_ptr,
1233
    png_uint_32 length));
1234 1235
#endif /* PNG_READ_sPLT_SUPPORTED */

1236
#ifdef PNG_READ_sRGB_SUPPORTED
1237
PNG_EXTERN void png_handle_sRGB PNGARG((png_structp png_ptr, png_infop info_ptr,
1238
    png_uint_32 length));
1239 1240
#endif

1241
#ifdef PNG_READ_tEXt_SUPPORTED
1242
PNG_EXTERN void png_handle_tEXt PNGARG((png_structp png_ptr, png_infop info_ptr,
1243
    png_uint_32 length));
1244 1245
#endif

1246
#ifdef PNG_READ_tIME_SUPPORTED
1247
PNG_EXTERN void png_handle_tIME PNGARG((png_structp png_ptr, png_infop info_ptr,
1248
    png_uint_32 length));
1249 1250
#endif

1251
#ifdef PNG_READ_tRNS_SUPPORTED
1252
PNG_EXTERN void png_handle_tRNS PNGARG((png_structp png_ptr, png_infop info_ptr,
1253
    png_uint_32 length));
1254 1255
#endif

1256
#ifdef PNG_READ_zTXt_SUPPORTED
1257
PNG_EXTERN void png_handle_zTXt PNGARG((png_structp png_ptr, png_infop info_ptr,
1258
    png_uint_32 length));
1259 1260
#endif

1261
#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
1262
PNG_EXTERN void png_handle_unknown PNGARG((png_structp png_ptr,
1263
    png_infop info_ptr, png_uint_32 length));
1264
#endif
1265 1266

PNG_EXTERN void png_check_chunk_name PNGARG((png_structp png_ptr,
1267 1268 1269 1270 1271 1272 1273 1274 1275
    png_uint_32 chunk_name));

#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
/* Exactly as png_handle_as_unknown() except that the argument is a 32-bit chunk
 * name, not a string.
 */
PNG_EXTERN int png_chunk_unknown_handling PNGARG((png_structp png_ptr,
    png_uint_32 chunk_name));
#endif
1276

1277
/* Handle the transformations for reading and writing */
1278
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
1279 1280
PNG_EXTERN void png_do_read_transformations PNGARG((png_structp png_ptr,
   png_row_infop row_info));
1281 1282
#endif
#ifdef PNG_WRITE_TRANSFORMS_SUPPORTED
1283 1284
PNG_EXTERN void png_do_write_transformations PNGARG((png_structp png_ptr,
   png_row_infop row_info));
1285
#endif
1286

1287
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
1288
PNG_EXTERN void png_init_read_transformations PNGARG((png_structp png_ptr));
1289
#endif
1290 1291 1292

#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
PNG_EXTERN void png_push_read_chunk PNGARG((png_structp png_ptr,
1293
    png_infop info_ptr));
1294
PNG_EXTERN void png_push_read_sig PNGARG((png_structp png_ptr,
1295
    png_infop info_ptr));
1296 1297
PNG_EXTERN void png_push_check_crc PNGARG((png_structp png_ptr));
PNG_EXTERN void png_push_crc_skip PNGARG((png_structp png_ptr,
1298
    png_uint_32 length));
1299 1300 1301
PNG_EXTERN void png_push_crc_finish PNGARG((png_structp png_ptr));
PNG_EXTERN void png_push_save_buffer PNGARG((png_structp png_ptr));
PNG_EXTERN void png_push_restore_buffer PNGARG((png_structp png_ptr,
1302
    png_bytep buffer, png_size_t buffer_length));
1303 1304
PNG_EXTERN void png_push_read_IDAT PNGARG((png_structp png_ptr));
PNG_EXTERN void png_process_IDAT_data PNGARG((png_structp png_ptr,
1305
    png_bytep buffer, png_size_t buffer_length));
1306 1307 1308 1309 1310 1311 1312 1313 1314
PNG_EXTERN void png_push_process_row PNGARG((png_structp png_ptr));
PNG_EXTERN void png_push_handle_unknown PNGARG((png_structp png_ptr,
   png_infop info_ptr, png_uint_32 length));
PNG_EXTERN void png_push_have_info PNGARG((png_structp png_ptr,
   png_infop info_ptr));
PNG_EXTERN void png_push_have_end PNGARG((png_structp png_ptr,
   png_infop info_ptr));
PNG_EXTERN void png_push_have_row PNGARG((png_structp png_ptr, png_bytep row));
PNG_EXTERN void png_push_read_end PNGARG((png_structp png_ptr,
1315
    png_infop info_ptr));
1316
PNG_EXTERN void png_process_some_data PNGARG((png_structp png_ptr,
1317
    png_infop info_ptr));
1318
PNG_EXTERN void png_read_push_finish_row PNGARG((png_structp png_ptr));
1319
#  ifdef PNG_READ_tEXt_SUPPORTED
1320
PNG_EXTERN void png_push_handle_tEXt PNGARG((png_structp png_ptr,
1321
    png_infop info_ptr, png_uint_32 length));
1322
PNG_EXTERN void png_push_read_tEXt PNGARG((png_structp png_ptr,
1323
    png_infop info_ptr));
1324 1325
#  endif
#  ifdef PNG_READ_zTXt_SUPPORTED
1326
PNG_EXTERN void png_push_handle_zTXt PNGARG((png_structp png_ptr,
1327
    png_infop info_ptr, png_uint_32 length));
1328
PNG_EXTERN void png_push_read_zTXt PNGARG((png_structp png_ptr,
1329
    png_infop info_ptr));
1330 1331
#  endif
#  ifdef PNG_READ_iTXt_SUPPORTED
1332
PNG_EXTERN void png_push_handle_iTXt PNGARG((png_structp png_ptr,
1333
    png_infop info_ptr, png_uint_32 length));
1334
PNG_EXTERN void png_push_read_iTXt PNGARG((png_structp png_ptr,
1335
    png_infop info_ptr));
1336
#  endif
1337 1338 1339 1340 1341

#endif /* PNG_PROGRESSIVE_READ_SUPPORTED */

#ifdef PNG_MNG_FEATURES_SUPPORTED
PNG_EXTERN void png_do_read_intrapixel PNGARG((png_row_infop row_info,
1342
    png_bytep row));
1343
PNG_EXTERN void png_do_write_intrapixel PNGARG((png_row_infop row_info,
1344
    png_bytep row));
1345 1346
#endif

1347
/* Added at libpng version 1.4.0 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1348
#ifdef PNG_CHECK_cHRM_SUPPORTED
1349
PNG_EXTERN int png_check_cHRM_fixed PNGARG((png_structp png_ptr,
1350 1351 1352 1353
    png_fixed_point int_white_x, png_fixed_point int_white_y,
    png_fixed_point int_red_x, png_fixed_point int_red_y, png_fixed_point
    int_green_x, png_fixed_point int_green_y, png_fixed_point int_blue_x,
    png_fixed_point int_blue_y));
1354 1355
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
1356
#ifdef PNG_CHECK_cHRM_SUPPORTED
1357
/* Added at libpng version 1.2.34 and 1.4.0 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1358
/* Currently only used by png_check_cHRM_fixed */
1359
PNG_EXTERN void png_64bit_product PNGARG((long v1, long v2,
1360
    unsigned long *hi_product, unsigned long *lo_product));
1361 1362
#endif

1363
#ifdef PNG_cHRM_SUPPORTED
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379
/* Added at libpng version 1.5.5 */
typedef struct png_xy
{
   png_fixed_point redx, redy;
   png_fixed_point greenx, greeny;
   png_fixed_point bluex, bluey;
   png_fixed_point whitex, whitey;
} png_xy;

typedef struct png_XYZ
{
   png_fixed_point redX, redY, redZ;
   png_fixed_point greenX, greenY, greenZ;
   png_fixed_point blueX, blueY, blueZ;
} png_XYZ;

1380 1381 1382 1383 1384 1385
/* The conversion APIs return 0 on success, non-zero on a parameter error. They
 * allow conversion between the above representations of a color encoding.  When
 * converting from XYZ end points to chromaticities the absolute magnitude of
 * the end points is lost, when converting back the sum of the Y values of the
 * three end points will be 1.0
 */
1386 1387 1388 1389 1390 1391
PNG_EXTERN int png_xy_from_XYZ PNGARG((png_xy *xy, png_XYZ XYZ));
PNG_EXTERN int png_XYZ_from_xy PNGARG((png_XYZ *XYZ, png_xy xy));
PNG_EXTERN int png_XYZ_from_xy_checked PNGARG((png_structp png_ptr,
   png_XYZ *XYZ, png_xy xy));
#endif

1392 1393
/* Added at libpng version 1.4.0 */
PNG_EXTERN void png_check_IHDR PNGARG((png_structp png_ptr,
1394 1395 1396
    png_uint_32 width, png_uint_32 height, int bit_depth,
    int color_type, int interlace_type, int compression_type,
    int filter_type));
1397

1398
/* Free all memory used by the read (old method - NOT DLL EXPORTED) */
G
[devel]  
Glenn Randers-Pehrson 已提交
1399 1400
PNG_EXTERN void png_read_destroy PNGARG((png_structp png_ptr,
    png_infop info_ptr, png_infop end_info_ptr));
1401 1402

/* Free any memory used in png_ptr struct (old method - NOT DLL EXPORTED) */
1403
PNG_EXTERN void png_write_destroy PNGARG((png_structp png_ptr));
1404 1405

#ifdef USE_FAR_KEYWORD  /* memory model conversion function */
G
[devel]  
Glenn Randers-Pehrson 已提交
1406
PNG_EXTERN void *png_far_to_near PNGARG((png_structp png_ptr, png_voidp ptr,
1407
    int check));
1408 1409
#endif /* USE_FAR_KEYWORD */

G
[devel]  
Glenn Randers-Pehrson 已提交
1410
#if defined(PNG_FLOATING_POINT_SUPPORTED) && defined(PNG_ERROR_TEXT_SUPPORTED)
1411 1412
PNG_EXTERN PNG_FUNCTION(void, png_fixed_error, (png_structp png_ptr,
   png_const_charp name),PNG_NORETURN);
G
[devel]  
Glenn Randers-Pehrson 已提交
1413 1414
#endif

1415 1416 1417 1418 1419 1420 1421
/* Puts 'string' into 'buffer' at buffer[pos], taking care never to overwrite
 * the end.  Always leaves the buffer nul terminated.  Never errors out (and
 * there is no error code.)
 */
PNG_EXTERN size_t png_safecat(png_charp buffer, size_t bufsize, size_t pos,
    png_const_charp string);

1422 1423 1424 1425
/* Various internal functions to handle formatted warning messages, currently
 * only implemented for warnings.
 */
#if defined(PNG_WARNINGS_SUPPORTED) || defined(PNG_TIME_RFC1123_SUPPORTED)
1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453
/* Utility to dump an unsigned value into a buffer, given a start pointer and
 * and end pointer (which should point just *beyond* the end of the buffer!)
 * Returns the pointer to the start of the formatted string.  This utility only
 * does unsigned values.
 */
PNG_EXTERN png_charp png_format_number(png_const_charp start, png_charp end,
   int format, png_alloc_size_t number);

/* Convenience macro that takes an array: */
#define PNG_FORMAT_NUMBER(buffer,format,number) \
   png_format_number(buffer, buffer + (sizeof buffer), format, number)

/* Suggested size for a number buffer (enough for 64 bits and a sign!) */
#define PNG_NUMBER_BUFFER_SIZE 24

/* These are the integer formats currently supported, the name is formed from
 * the standard printf(3) format string.
 */
#define PNG_NUMBER_FORMAT_u     1 /* chose unsigned API! */
#define PNG_NUMBER_FORMAT_02u   2
#define PNG_NUMBER_FORMAT_d     1 /* chose signed API! */
#define PNG_NUMBER_FORMAT_02d   2
#define PNG_NUMBER_FORMAT_x     3
#define PNG_NUMBER_FORMAT_02x   4
#define PNG_NUMBER_FORMAT_fixed 5 /* choose the signed API */
#endif

#ifdef PNG_WARNINGS_SUPPORTED
1454
/* New defines and members adding in libpng-1.5.4 */
1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484
#  define PNG_WARNING_PARAMETER_SIZE 32
#  define PNG_WARNING_PARAMETER_COUNT 8

/* An l-value of this type has to be passed to the APIs below to cache the
 * values of the parameters to a formatted warning message.
 */
typedef char png_warning_parameters[PNG_WARNING_PARAMETER_COUNT][
   PNG_WARNING_PARAMETER_SIZE];

PNG_EXTERN void png_warning_parameter(png_warning_parameters p, int number,
    png_const_charp string);
    /* Parameters are limited in size to PNG_WARNING_PARAMETER_SIZE characters,
     * including the trailing '\0'.
     */
PNG_EXTERN void png_warning_parameter_unsigned(png_warning_parameters p,
    int number, int format, png_alloc_size_t value);
    /* Use png_alloc_size_t because it is an unsigned type as big as any we
     * need to output.  Use the following for a signed value.
     */
PNG_EXTERN void png_warning_parameter_signed(png_warning_parameters p,
    int number, int format, png_int_32 value);

PNG_EXTERN void png_formatted_warning(png_structp png_ptr,
    png_warning_parameters p, png_const_charp message);
    /* 'message' follows the X/Open approach of using @1, @2 to insert
     * parameters previously supplied using the above functions.  Errors in
     * specifying the paramters will simple result in garbage substitutions.
     */
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
1485 1486 1487
/* ASCII to FP interfaces, currently only implemented if sCAL
 * support is required.
 */
1488
#if defined(PNG_READ_sCAL_SUPPORTED)
G
[devel]  
Glenn Randers-Pehrson 已提交
1489 1490 1491 1492 1493 1494
/* MAX_DIGITS is actually the maximum number of characters in an sCAL
 * width or height, derived from the precision (number of significant
 * digits - a build time settable option) and assumpitions about the
 * maximum ridiculous exponent.
 */
#define PNG_sCAL_MAX_DIGITS (PNG_sCAL_PRECISION+1/*.*/+1/*E*/+10/*exponent*/)
1495 1496

#ifdef PNG_FLOATING_POINT_SUPPORTED
1497
PNG_EXTERN void png_ascii_from_fp PNGARG((png_structp png_ptr, png_charp ascii,
1498
    png_size_t size, double fp, unsigned int precision));
1499 1500 1501 1502 1503 1504 1505
#endif /* FLOATING_POINT */

#ifdef PNG_FIXED_POINT_SUPPORTED
PNG_EXTERN void png_ascii_from_fixed PNGARG((png_structp png_ptr,
    png_charp ascii, png_size_t size, png_fixed_point fp));
#endif /* FIXED_POINT */
#endif /* READ_sCAL */
G
[devel]  
Glenn Randers-Pehrson 已提交
1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546

#if defined(PNG_sCAL_SUPPORTED) || defined(PNG_pCAL_SUPPORTED)
/* An internal API to validate the format of a floating point number.
 * The result is the index of the next character.  If the number is
 * not valid it will be the index of a character in the supposed number.
 *
 * The format of a number is defined in the PNG extensions specification
 * and this API is strictly conformant to that spec, not anyone elses!
 *
 * The format as a regular expression is:
 *
 * [+-]?[0-9]+.?([Ee][+-]?[0-9]+)?
 *
 * or:
 *
 * [+-]?.[0-9]+(.[0-9]+)?([Ee][+-]?[0-9]+)?
 *
 * The complexity is that either integer or fraction must be present and the
 * fraction is permitted to have no digits only if the integer is present.
 *
 * NOTE: The dangling E problem.
 *   There is a PNG valid floating point number in the following:
 *
 *       PNG floating point numb1.ers are not greedy.
 *
 *   Working this out requires *TWO* character lookahead (because of the
 *   sign), the parser does not do this - it will fail at the 'r' - this
 *   doesn't matter for PNG sCAL chunk values, but it requires more care
 *   if the value were ever to be embedded in something more complex.  Use
 *   ANSI-C strtod if you need the lookahead.
 */
/* State table for the parser. */
#define PNG_FP_INTEGER    0  /* before or in integer */
#define PNG_FP_FRACTION   1  /* before or in fraction */
#define PNG_FP_EXPONENT   2  /* before or in exponent */
#define PNG_FP_STATE      3  /* mask for the above */
#define PNG_FP_SAW_SIGN   4  /* Saw +/- in current state */
#define PNG_FP_SAW_DIGIT  8  /* Saw a digit in current state */
#define PNG_FP_SAW_DOT   16  /* Saw a dot in current state */
#define PNG_FP_SAW_E     32  /* Saw an E (or e) in current state */
#define PNG_FP_SAW_ANY   60  /* Saw any of the above 4 */
1547 1548 1549

/* These three values don't affect the parser.  They are set but not used.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1550
#define PNG_FP_WAS_VALID 64  /* Preceding substring is a valid fp number */
1551 1552 1553 1554 1555 1556 1557 1558
#define PNG_FP_NEGATIVE 128  /* A negative number, including "-0" */
#define PNG_FP_NONZERO  256  /* A non-zero value */
#define PNG_FP_STICKY   448  /* The above three flags */

/* This is available for the caller to store in 'state' if required.  Do not
 * call the parser after setting it (the parser sometimes clears it.)
 */
#define PNG_FP_INVALID  512  /* Available for callers as a distinct value */
G
[devel]  
Glenn Randers-Pehrson 已提交
1559 1560 1561 1562 1563 1564 1565

/* Result codes for the parser (boolean - true meants ok, false means
 * not ok yet.)
 */
#define PNG_FP_MAYBE      0  /* The number may be valid in the future */
#define PNG_FP_OK         1  /* The number is valid */

1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579
/* Tests on the sticky non-zero and negative flags.  To pass these checks
 * the state must also indicate that the whole number is valid - this is
 * achieved by testing PNG_FP_SAW_DIGIT (see the implementation for why this
 * is equivalent to PNG_FP_OK above.)
 */
#define PNG_FP_NZ_MASK (PNG_FP_SAW_DIGIT | PNG_FP_NEGATIVE | PNG_FP_NONZERO)
   /* NZ_MASK: the string is valid and a non-zero negative value */
#define PNG_FP_Z_MASK (PNG_FP_SAW_DIGIT | PNG_FP_NONZERO)
   /* Z MASK: the string is valid and a non-zero value. */
   /* PNG_FP_SAW_DIGIT: the string is valid. */
#define PNG_FP_IS_ZERO(state) (((state) & PNG_FP_Z_MASK) == PNG_FP_SAW_DIGIT)
#define PNG_FP_IS_POSITIVE(state) (((state) & PNG_FP_NZ_MASK) == PNG_FP_Z_MASK)
#define PNG_FP_IS_NEGATIVE(state) (((state) & PNG_FP_NZ_MASK) == PNG_FP_NZ_MASK)
 
G
[devel]  
Glenn Randers-Pehrson 已提交
1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594
/* The actual parser.  This can be called repeatedly, it updates
 * the index into the string and the state variable (which must
 * be initialzed to 0).  It returns a result code, as above.  There
 * is no point calling the parser any more if it fails to advance to
 * the end of the string - it is stuck on an invalid character (or
 * terminated by '\0').
 *
 * Note that the pointer will consume an E or even an E+ then leave
 * a 'maybe' state even though a preceding integer.fraction is valid.
 * The PNG_FP_WAS_VALID flag indicates that a preceding substring was
 * a valid number.  It's possible to recover from this by calling
 * the parser again (from the start, with state 0) but with a string
 * that omits the last character (i.e. set the size to the index of
 * the problem character.)  This has not been tested within libpng.
 */
1595 1596
PNG_EXTERN int png_check_fp_number PNGARG((png_const_charp string,
    png_size_t size, int *statep, png_size_tp whereami));
G
[devel]  
Glenn Randers-Pehrson 已提交
1597 1598

/* This is the same but it checks a complete string and returns true
1599 1600 1601 1602
 * only if it just contains a floating point number.  As of 1.5.4 this
 * function also returns the state at the end of parsing the number if
 * it was valid (otherwise it returns 0.)  This can be used for testing
 * for negative or zero values using the sticky flag.
G
[devel]  
Glenn Randers-Pehrson 已提交
1603
 */
1604 1605
PNG_EXTERN int png_check_fp_string PNGARG((png_const_charp string,
    png_size_t size));
G
[devel]  
Glenn Randers-Pehrson 已提交
1606 1607
#endif /* pCAL || sCAL */

1608 1609
#if defined(PNG_READ_GAMMA_SUPPORTED) ||\
    defined(PNG_INCH_CONVERSIONS_SUPPORTED) || defined(PNG_READ_pHYs_SUPPORTED)
G
[devel]  
Glenn Randers-Pehrson 已提交
1610 1611 1612 1613 1614 1615 1616
/* Added at libpng version 1.5.0 */
/* This is a utility to provide a*times/div (rounded) and indicate
 * if there is an overflow.  The result is a boolean - false (0)
 * for overflow, true (1) if no overflow, in which case *res
 * holds the result.
 */
PNG_EXTERN int png_muldiv PNGARG((png_fixed_point_p res, png_fixed_point a,
1617
    png_int_32 multiplied_by, png_int_32 divided_by));
G
[devel]  
Glenn Randers-Pehrson 已提交
1618 1619 1620 1621 1622
#endif

#if defined(PNG_READ_GAMMA_SUPPORTED) || defined(PNG_INCH_CONVERSIONS_SUPPORTED)
/* Same deal, but issue a warning on overflow and return 0. */
PNG_EXTERN png_fixed_point png_muldiv_warn PNGARG((png_structp png_ptr,
1623
    png_fixed_point a, png_int_32 multiplied_by, png_int_32 divided_by));
G
[devel]  
Glenn Randers-Pehrson 已提交
1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649
#endif

#ifdef PNG_READ_GAMMA_SUPPORTED
/* Calculate a reciprocal - used for gamma values.  This returns
 * 0 if the argument is 0 in order to maintain an undefined value,
 * there are no warnings.
 */
PNG_EXTERN png_fixed_point png_reciprocal PNGARG((png_fixed_point a));

/* The same but gives a reciprocal of the product of two fixed point
 * values.  Accuracy is suitable for gamma calculations but this is
 * not exact - use png_muldiv for that.
 */
PNG_EXTERN png_fixed_point png_reciprocal2 PNGARG((png_fixed_point a,
    png_fixed_point b));
#endif

#ifdef PNG_READ_GAMMA_SUPPORTED
/* Internal fixed point gamma correction.  These APIs are called as
 * required to convert single values - they don't need to be fast,
 * they are not used when processing image pixel values.
 *
 * While the input is an 'unsigned' value it must actually be the
 * correct bit value - 0..255 or 0..65535 as required.
 */
PNG_EXTERN png_uint_16 png_gamma_correct PNGARG((png_structp png_ptr,
1650 1651
    unsigned int value, png_fixed_point gamma_value));
PNG_EXTERN int png_gamma_significant PNGARG((png_fixed_point gamma_value));
1652
PNG_EXTERN png_uint_16 png_gamma_16bit_correct PNGARG((unsigned int value,
1653
    png_fixed_point gamma_value));
1654
PNG_EXTERN png_byte png_gamma_8bit_correct PNGARG((unsigned int value,
1655
    png_fixed_point gamma_value));
1656
PNG_EXTERN void png_destroy_gamma_table(png_structp png_ptr);
G
[devel]  
Glenn Randers-Pehrson 已提交
1657
PNG_EXTERN void png_build_gamma_table PNGARG((png_structp png_ptr,
1658
    int bit_depth));
G
[devel]  
Glenn Randers-Pehrson 已提交
1659
#endif
1660

1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677
/* SIMPLIFIED READ/WRITE SUPPORT */
#if defined PNG_SIMPLIFIED_READ_SUPPORTED ||\
   defined PNG_SIMPLIFIED_WRITE_SUPPORTED
/* The internal structure that png_image::opaque points to. */
typedef struct png_control
{
   png_structp  png_ptr;
   png_infop    info_ptr;
   png_voidp    error_buf;     /* Always a jmp_buf at present. */

   png_const_bytep memory;     /* Memory buffer. */
   png_size_t      size;       /* Size of the memory buffer. */

   unsigned int for_write :1;  /* Otherwise it is a read structure */
   unsigned int owned_file :1; /* We own the file in io_ptr */
} png_control;

1678 1679 1680 1681 1682 1683 1684 1685 1686
/* Return the pointer to the jmp_buf from a png_control: necessary because C
 * does not reveal the type of the elements of jmp_buf.
 */
#ifdef __cplusplus
#  define png_control_jmp_buf(pc) (((jmp_buf*)((pc)->error_buf))[0])
#else
#  define png_control_jmp_buf(pc) ((pc)->error_buf)
#endif

1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710
/* Utility to safely execute a piece of libpng code catching and logging any
 * errors that might occur.  Returns true on success, false on failure (either
 * of the function or as a result of a png_error.)
 */
PNG_FUNCTION(void, png_safe_error, (png_structp png_ptr,
   png_const_charp error_message), PNG_NORETURN);

#ifdef PNG_WARNINGS_SUPPORTED
   PNG_EXTERN void png_safe_warning(png_structp png_ptr,
      png_const_charp warning_message);
#else
#  define png_safe_warning 0/*dummy argument*/
#endif

PNG_EXTERN int png_safe_execute PNGARG((png_imagep image,
   int (*function)(png_voidp), png_voidp arg));

/* Utility to log an error, this also cleans up the png_image, the function
 * always returns 0 (false).
 */
PNG_EXTERN int png_image_error(png_imagep image, png_const_charp error_message);

#endif /* SIMPLIFIED READ/WRITE */

1711 1712
/* Maintainer: Put new private prototypes here ^ and in libpngpf.3 */

G
[devel]  
Glenn Randers-Pehrson 已提交
1713 1714 1715

#include "pngdebug.h"

1716 1717 1718 1719
#ifdef __cplusplus
}
#endif

1720
#endif /* PNGPRIV_H */