[packaging] Fix runtime error with enabled UBSan
[platform/upstream/libpng.git] / pngpriv.h
1
2 /* pngpriv.h - private declarations for use inside libpng
3  *
4  * Copyright (c) 2018 Cosmin Truta
5  * Copyright (c) 1998-2002,2004,2006-2018 Glenn Randers-Pehrson
6  * Copyright (c) 1996-1997 Andreas Dilger
7  * Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc.
8  *
9  * This code is released under the libpng license.
10  * For conditions of distribution and use, see the disclaimer
11  * and license in png.h
12  */
13
14 /* The symbols declared in this file (including the functions declared
15  * as extern) are PRIVATE.  They are not part of the libpng public
16  * interface, and are not recommended for use by regular applications.
17  * Some of them may become public in the future; others may stay private,
18  * change in an incompatible way, or even disappear.
19  * Although the libpng users are not forbidden to include this header,
20  * they should be well aware of the issues that may arise from doing so.
21  */
22
23 #ifndef PNGPRIV_H
24 #define PNGPRIV_H
25
26 /* Feature Test Macros.  The following are defined here to ensure that correctly
27  * implemented libraries reveal the APIs libpng needs to build and hide those
28  * that are not needed and potentially damaging to the compilation.
29  *
30  * Feature Test Macros must be defined before any system header is included (see
31  * POSIX 1003.1 2.8.2 "POSIX Symbols."
32  *
33  * These macros only have an effect if the operating system supports either
34  * POSIX 1003.1 or C99, or both.  On other operating systems (particularly
35  * Windows/Visual Studio) there is no effect; the OS specific tests below are
36  * still required (as of 2011-05-02.)
37  */
38 #ifndef _POSIX_SOURCE
39 # define _POSIX_SOURCE 1 /* Just the POSIX 1003.1 and C89 APIs */
40 #endif
41
42 #ifndef PNG_VERSION_INFO_ONLY
43 /* Standard library headers not required by png.h: */
44 #  include <stdlib.h>
45 #  include <string.h>
46 #endif
47
48 #define PNGLIB_BUILD /*libpng is being built, not used*/
49
50 /* If HAVE_CONFIG_H is defined during the build then the build system must
51  * provide an appropriate "config.h" file on the include path.  The header file
52  * must provide definitions as required below (search for "HAVE_CONFIG_H");
53  * see configure.ac for more details of the requirements.  The macro
54  * "PNG_NO_CONFIG_H" is provided for maintainers to test for dependencies on
55  * 'configure'; define this macro to prevent the configure build including the
56  * configure generated config.h.  Libpng is expected to compile without *any*
57  * special build system support on a reasonably ANSI-C compliant system.
58  */
59 #if defined(HAVE_CONFIG_H) && !defined(PNG_NO_CONFIG_H)
60 #  include <config.h>
61
62    /* Pick up the definition of 'restrict' from config.h if it was read: */
63 #  define PNG_RESTRICT restrict
64 #endif
65
66 /* To support symbol prefixing it is necessary to know *before* including png.h
67  * whether the fixed point (and maybe other) APIs are exported, because if they
68  * are not internal definitions may be required.  This is handled below just
69  * before png.h is included, but load the configuration now if it is available.
70  */
71 #ifndef PNGLCONF_H
72 #  include "pnglibconf.h"
73 #endif
74
75 /* Local renames may change non-exported API functions from png.h */
76 #if defined(PNG_PREFIX) && !defined(PNGPREFIX_H)
77 #  include "pngprefix.h"
78 #endif
79
80 #ifdef PNG_USER_CONFIG
81 #  include "pngusr.h"
82    /* These should have been defined in pngusr.h */
83 #  ifndef PNG_USER_PRIVATEBUILD
84 #    define PNG_USER_PRIVATEBUILD "Custom libpng build"
85 #  endif
86 #  ifndef PNG_USER_DLLFNAME_POSTFIX
87 #    define PNG_USER_DLLFNAME_POSTFIX "Cb"
88 #  endif
89 #endif
90
91 /* Compile time options.
92  * =====================
93  * In a multi-arch build the compiler may compile the code several times for the
94  * same object module, producing different binaries for different architectures.
95  * When this happens configure-time setting of the target host options cannot be
96  * done and this interferes with the handling of the ARM NEON optimizations, and
97  * possibly other similar optimizations.  Put additional tests here; in general
98  * this is needed when the same option can be changed at both compile time and
99  * run time depending on the target OS (i.e. iOS vs Android.)
100  *
101  * NOTE: symbol prefixing does not pass $(CFLAGS) to the preprocessor, because
102  * this is not possible with certain compilers (Oracle SUN OS CC), as a result
103  * it is necessary to ensure that all extern functions that *might* be used
104  * regardless of $(CFLAGS) get declared in this file.  The test on __ARM_NEON__
105  * below is one example of this behavior because it is controlled by the
106  * presence or not of -mfpu=neon on the GCC command line, it is possible to do
107  * this in $(CC), e.g. "CC=gcc -mfpu=neon", but people who build libpng rarely
108  * do this.
109  */
110 #ifndef PNG_ARM_NEON_OPT
111    /* ARM NEON optimizations are being controlled by the compiler settings,
112     * typically the target FPU.  If the FPU has been set to NEON (-mfpu=neon
113     * with GCC) then the compiler will define __ARM_NEON__ and we can rely
114     * unconditionally on NEON instructions not crashing, otherwise we must
115     * disable use of NEON instructions.
116     *
117     * NOTE: at present these optimizations depend on 'ALIGNED_MEMORY', so they
118     * can only be turned on automatically if that is supported too.  If
119     * PNG_ARM_NEON_OPT is set in CPPFLAGS (to >0) then arm/arm_init.c will fail
120     * to compile with an appropriate #error if ALIGNED_MEMORY has been turned
121     * off.
122     *
123     * Note that gcc-4.9 defines __ARM_NEON instead of the deprecated
124     * __ARM_NEON__, so we check both variants.
125     *
126     * To disable ARM_NEON optimizations entirely, and skip compiling the
127     * associated assembler code, pass --enable-arm-neon=no to configure
128     * or put -DPNG_ARM_NEON_OPT=0 in CPPFLAGS.
129     */
130 #  if (defined(__ARM_NEON__) || defined(__ARM_NEON)) && \
131    defined(PNG_ALIGNED_MEMORY_SUPPORTED)
132 #     define PNG_ARM_NEON_OPT 2
133 #  else
134 #     define PNG_ARM_NEON_OPT 0
135 #  endif
136 #endif
137
138 #if PNG_ARM_NEON_OPT > 0
139    /* NEON optimizations are to be at least considered by libpng, so enable the
140     * callbacks to do this.
141     */
142 #  define PNG_FILTER_OPTIMIZATIONS png_init_filter_functions_neon
143
144    /* By default the 'intrinsics' code in arm/filter_neon_intrinsics.c is used
145     * if possible - if __ARM_NEON__ is set and the compiler version is not known
146     * to be broken.  This is controlled by PNG_ARM_NEON_IMPLEMENTATION which can
147     * be:
148     *
149     *    1  The intrinsics code (the default with __ARM_NEON__)
150     *    2  The hand coded assembler (the default without __ARM_NEON__)
151     *
152     * It is possible to set PNG_ARM_NEON_IMPLEMENTATION in CPPFLAGS, however
153     * this is *NOT* supported and may cease to work even after a minor revision
154     * to libpng.  It *is* valid to do this for testing purposes, e.g. speed
155     * testing or a new compiler, but the results should be communicated to the
156     * libpng implementation list for incorporation in the next minor release.
157     */
158 #  ifndef PNG_ARM_NEON_IMPLEMENTATION
159 #     if defined(__ARM_NEON__) || defined(__ARM_NEON)
160 #        if defined(__clang__)
161             /* At present it is unknown by the libpng developers which versions
162              * of clang support the intrinsics, however some or perhaps all
163              * versions do not work with the assembler so this may be
164              * irrelevant, so just use the default (do nothing here.)
165              */
166 #        elif defined(__GNUC__)
167             /* GCC 4.5.4 NEON support is known to be broken.  4.6.3 is known to
168              * work, so if this *is* GCC, or G++, look for a version >4.5
169              */
170 #           if __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 6)
171 #              define PNG_ARM_NEON_IMPLEMENTATION 2
172 #           endif /* no GNUC support */
173 #        endif /* __GNUC__ */
174 #     else /* !defined __ARM_NEON__ */
175          /* The 'intrinsics' code simply won't compile without this -mfpu=neon:
176           */
177 #        if !defined(__aarch64__)
178             /* The assembler code currently does not work on ARM64 */
179 #          define PNG_ARM_NEON_IMPLEMENTATION 2
180 #        endif /* __aarch64__ */
181 #     endif /* __ARM_NEON__ */
182 #  endif /* !PNG_ARM_NEON_IMPLEMENTATION */
183
184 #  ifndef PNG_ARM_NEON_IMPLEMENTATION
185       /* Use the intrinsics code by default. */
186 #     define PNG_ARM_NEON_IMPLEMENTATION 1
187 #  endif
188 #endif /* PNG_ARM_NEON_OPT > 0 */
189
190 #ifndef PNG_MIPS_MSA_OPT
191 #  if defined(__mips_msa) && (__mips_isa_rev >= 5) && defined(PNG_ALIGNED_MEMORY_SUPPORTED)
192 #     define PNG_MIPS_MSA_OPT 2
193 #  else
194 #     define PNG_MIPS_MSA_OPT 0
195 #  endif
196 #endif
197
198 #ifndef PNG_POWERPC_VSX_OPT
199 #  if defined(__PPC64__) && defined(__ALTIVEC__) && defined(__VSX__)
200 #     define PNG_POWERPC_VSX_OPT 2
201 #  else
202 #     define PNG_POWERPC_VSX_OPT 0
203 #  endif
204 #endif
205
206 #ifndef PNG_INTEL_SSE_OPT
207 #   ifdef PNG_INTEL_SSE
208       /* Only check for SSE if the build configuration has been modified to
209        * enable SSE optimizations.  This means that these optimizations will
210        * be off by default.  See contrib/intel for more details.
211        */
212 #     if defined(__SSE4_1__) || defined(__AVX__) || defined(__SSSE3__) || \
213        defined(__SSE2__) || defined(_M_X64) || defined(_M_AMD64) || \
214        (defined(_M_IX86_FP) && _M_IX86_FP >= 2)
215 #         define PNG_INTEL_SSE_OPT 1
216 #      else
217 #         define PNG_INTEL_SSE_OPT 0
218 #      endif
219 #   else
220 #      define PNG_INTEL_SSE_OPT 0
221 #   endif
222 #endif
223
224 #if PNG_INTEL_SSE_OPT > 0
225 #   ifndef PNG_INTEL_SSE_IMPLEMENTATION
226 #      if defined(__SSE4_1__) || defined(__AVX__)
227           /* We are not actually using AVX, but checking for AVX is the best
228              way we can detect SSE4.1 and SSSE3 on MSVC.
229           */
230 #         define PNG_INTEL_SSE_IMPLEMENTATION 3
231 #      elif defined(__SSSE3__)
232 #         define PNG_INTEL_SSE_IMPLEMENTATION 2
233 #      elif defined(__SSE2__) || defined(_M_X64) || defined(_M_AMD64) || \
234        (defined(_M_IX86_FP) && _M_IX86_FP >= 2)
235 #         define PNG_INTEL_SSE_IMPLEMENTATION 1
236 #      else
237 #         define PNG_INTEL_SSE_IMPLEMENTATION 0
238 #      endif
239 #   endif
240
241 #   if PNG_INTEL_SSE_IMPLEMENTATION > 0
242 #      define PNG_FILTER_OPTIMIZATIONS png_init_filter_functions_sse2
243 #   endif
244 #else
245 #   define PNG_INTEL_SSE_IMPLEMENTATION 0
246 #endif
247
248 #if PNG_MIPS_MSA_OPT > 0
249 #  define PNG_FILTER_OPTIMIZATIONS png_init_filter_functions_msa
250 #  ifndef PNG_MIPS_MSA_IMPLEMENTATION
251 #     if defined(__mips_msa)
252 #        if defined(__clang__)
253 #        elif defined(__GNUC__)
254 #           if __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 7)
255 #              define PNG_MIPS_MSA_IMPLEMENTATION 2
256 #           endif /* no GNUC support */
257 #        endif /* __GNUC__ */
258 #     else /* !defined __mips_msa */
259 #        define PNG_MIPS_MSA_IMPLEMENTATION 2
260 #     endif /* __mips_msa */
261 #  endif /* !PNG_MIPS_MSA_IMPLEMENTATION */
262
263 #  ifndef PNG_MIPS_MSA_IMPLEMENTATION
264 #     define PNG_MIPS_MSA_IMPLEMENTATION 1
265 #  endif
266 #endif /* PNG_MIPS_MSA_OPT > 0 */
267
268 #if PNG_POWERPC_VSX_OPT > 0
269 #  define PNG_FILTER_OPTIMIZATIONS png_init_filter_functions_vsx
270 #  define PNG_POWERPC_VSX_IMPLEMENTATION 1
271 #endif
272
273
274 /* Is this a build of a DLL where compilation of the object modules requires
275  * different preprocessor settings to those required for a simple library?  If
276  * so PNG_BUILD_DLL must be set.
277  *
278  * If libpng is used inside a DLL but that DLL does not export the libpng APIs
279  * PNG_BUILD_DLL must not be set.  To avoid the code below kicking in build a
280  * static library of libpng then link the DLL against that.
281  */
282 #ifndef PNG_BUILD_DLL
283 #  ifdef DLL_EXPORT
284       /* This is set by libtool when files are compiled for a DLL; libtool
285        * always compiles twice, even on systems where it isn't necessary.  Set
286        * PNG_BUILD_DLL in case it is necessary:
287        */
288 #     define PNG_BUILD_DLL
289 #  else
290 #     ifdef _WINDLL
291          /* This is set by the Microsoft Visual Studio IDE in projects that
292           * build a DLL.  It can't easily be removed from those projects (it
293           * isn't visible in the Visual Studio UI) so it is a fairly reliable
294           * indication that PNG_IMPEXP needs to be set to the DLL export
295           * attributes.
296           */
297 #        define PNG_BUILD_DLL
298 #     else
299 #        ifdef __DLL__
300             /* This is set by the Borland C system when compiling for a DLL
301              * (as above.)
302              */
303 #           define PNG_BUILD_DLL
304 #        else
305             /* Add additional compiler cases here. */
306 #        endif
307 #     endif
308 #  endif
309 #endif /* Setting PNG_BUILD_DLL if required */
310
311 /* See pngconf.h for more details: the builder of the library may set this on
312  * the command line to the right thing for the specific compilation system or it
313  * may be automagically set above (at present we know of no system where it does
314  * need to be set on the command line.)
315  *
316  * PNG_IMPEXP must be set here when building the library to prevent pngconf.h
317  * setting it to the "import" setting for a DLL build.
318  */
319 #ifndef PNG_IMPEXP
320 #  ifdef PNG_BUILD_DLL
321 #     define PNG_IMPEXP PNG_DLL_EXPORT
322 #  else
323       /* Not building a DLL, or the DLL doesn't require specific export
324        * definitions.
325        */
326 #     define PNG_IMPEXP
327 #  endif
328 #endif
329
330 /* No warnings for private or deprecated functions in the build: */
331 #ifndef PNG_DEPRECATED
332 #  define PNG_DEPRECATED
333 #endif
334 #ifndef PNG_PRIVATE
335 #  define PNG_PRIVATE
336 #endif
337
338 /* Symbol preprocessing support.
339  *
340  * To enable listing global, but internal, symbols the following macros should
341  * always be used to declare an extern data or function object in this file.
342  */
343 #ifndef PNG_INTERNAL_DATA
344 #  define PNG_INTERNAL_DATA(type, name, array) PNG_LINKAGE_DATA type name array
345 #endif
346
347 #ifndef PNG_INTERNAL_FUNCTION
348 #  define PNG_INTERNAL_FUNCTION(type, name, args, attributes)\
349       PNG_LINKAGE_FUNCTION PNG_FUNCTION(type, name, args, PNG_EMPTY attributes)
350 #endif
351
352 #ifndef PNG_INTERNAL_CALLBACK
353 #  define PNG_INTERNAL_CALLBACK(type, name, args, attributes)\
354       PNG_LINKAGE_CALLBACK PNG_FUNCTION(type, (PNGCBAPI name), args,\
355          PNG_EMPTY attributes)
356 #endif
357
358 /* If floating or fixed point APIs are disabled they may still be compiled
359  * internally.  To handle this make sure they are declared as the appropriate
360  * internal extern function (otherwise the symbol prefixing stuff won't work and
361  * the functions will be used without definitions.)
362  *
363  * NOTE: although all the API functions are declared here they are not all
364  * actually built!  Because the declarations are still made it is necessary to
365  * fake out types that they depend on.
366  */
367 #ifndef PNG_FP_EXPORT
368 #  ifndef PNG_FLOATING_POINT_SUPPORTED
369 #     define PNG_FP_EXPORT(ordinal, type, name, args)\
370          PNG_INTERNAL_FUNCTION(type, name, args, PNG_EMPTY);
371 #     ifndef PNG_VERSION_INFO_ONLY
372          typedef struct png_incomplete png_double;
373          typedef png_double*           png_doublep;
374          typedef const png_double*     png_const_doublep;
375          typedef png_double**          png_doublepp;
376 #     endif
377 #  endif
378 #endif
379 #ifndef PNG_FIXED_EXPORT
380 #  ifndef PNG_FIXED_POINT_SUPPORTED
381 #     define PNG_FIXED_EXPORT(ordinal, type, name, args)\
382          PNG_INTERNAL_FUNCTION(type, name, args, PNG_EMPTY);
383 #  endif
384 #endif
385
386 #include "png.h"
387
388 /* pngconf.h does not set PNG_DLL_EXPORT unless it is required, so: */
389 #ifndef PNG_DLL_EXPORT
390 #  define PNG_DLL_EXPORT
391 #endif
392
393 /* This is a global switch to set the compilation for an installed system
394  * (a release build).  It can be set for testing debug builds to ensure that
395  * they will compile when the build type is switched to RC or STABLE, the
396  * default is just to use PNG_LIBPNG_BUILD_BASE_TYPE.  Set this in CPPFLAGS
397  * with either:
398  *
399  *   -DPNG_RELEASE_BUILD Turns on the release compile path
400  *   -DPNG_RELEASE_BUILD=0 Turns it off
401  * or in your pngusr.h with
402  *   #define PNG_RELEASE_BUILD=1 Turns on the release compile path
403  *   #define PNG_RELEASE_BUILD=0 Turns it off
404  */
405 #ifndef PNG_RELEASE_BUILD
406 #  define PNG_RELEASE_BUILD (PNG_LIBPNG_BUILD_BASE_TYPE >= PNG_LIBPNG_BUILD_RC)
407 #endif
408
409 /* SECURITY and SAFETY:
410  *
411  * libpng is built with support for internal limits on image dimensions and
412  * memory usage.  These are documented in scripts/pnglibconf.dfa of the
413  * source and recorded in the machine generated header file pnglibconf.h.
414  */
415
416 /* If you are running on a machine where you cannot allocate more
417  * than 64K of memory at once, uncomment this.  While libpng will not
418  * normally need that much memory in a chunk (unless you load up a very
419  * large file), zlib needs to know how big of a chunk it can use, and
420  * libpng thus makes sure to check any memory allocation to verify it
421  * will fit into memory.
422  *
423  * zlib provides 'MAXSEG_64K' which, if defined, indicates the
424  * same limit and pngconf.h (already included) sets the limit
425  * if certain operating systems are detected.
426  */
427 #if defined(MAXSEG_64K) && !defined(PNG_MAX_MALLOC_64K)
428 #  define PNG_MAX_MALLOC_64K
429 #endif
430
431 #ifndef PNG_UNUSED
432 /* Unused formal parameter warnings are silenced using the following macro
433  * which is expected to have no bad effects on performance (optimizing
434  * compilers will probably remove it entirely).  Note that if you replace
435  * it with something other than whitespace, you must include the terminating
436  * semicolon.
437  */
438 #  define PNG_UNUSED(param) (void)param;
439 #endif
440
441 /* Just a little check that someone hasn't tried to define something
442  * contradictory.
443  */
444 #if (PNG_ZBUF_SIZE > 65536L) && defined(PNG_MAX_MALLOC_64K)
445 #  undef PNG_ZBUF_SIZE
446 #  define PNG_ZBUF_SIZE 65536L
447 #endif
448
449 /* If warnings or errors are turned off the code is disabled or redirected here.
450  * From 1.5.4 functions have been added to allow very limited formatting of
451  * error and warning messages - this code will also be disabled here.
452  */
453 #ifdef PNG_WARNINGS_SUPPORTED
454 #  define PNG_WARNING_PARAMETERS(p) png_warning_parameters p;
455 #else
456 #  define png_warning_parameter(p,number,string) ((void)0)
457 #  define png_warning_parameter_unsigned(p,number,format,value) ((void)0)
458 #  define png_warning_parameter_signed(p,number,format,value) ((void)0)
459 #  define png_formatted_warning(pp,p,message) ((void)(pp))
460 #  define PNG_WARNING_PARAMETERS(p)
461 #endif
462 #ifndef PNG_ERROR_TEXT_SUPPORTED
463 #  define png_fixed_error(s1,s2) png_err(s1)
464 #endif
465
466 /* Some fixed point APIs are still required even if not exported because
467  * they get used by the corresponding floating point APIs.  This magic
468  * deals with this:
469  */
470 #ifdef PNG_FIXED_POINT_SUPPORTED
471 #  define PNGFAPI PNGAPI
472 #else
473 #  define PNGFAPI /* PRIVATE */
474 #endif
475
476 #ifndef PNG_VERSION_INFO_ONLY
477 /* Other defines specific to compilers can go here.  Try to keep
478  * them inside an appropriate ifdef/endif pair for portability.
479  */
480
481 /* C allows up-casts from (void*) to any pointer and (const void*) to any
482  * pointer to a const object.  C++ regards this as a type error and requires an
483  * explicit, static, cast and provides the static_cast<> rune to ensure that
484  * const is not cast away.
485  */
486 #ifdef __cplusplus
487 #  define png_voidcast(type, value) static_cast<type>(value)
488 #  define png_constcast(type, value) const_cast<type>(value)
489 #  define png_aligncast(type, value) \
490    static_cast<type>(static_cast<void*>(value))
491 #  define png_aligncastconst(type, value) \
492    static_cast<type>(static_cast<const void*>(value))
493 #else
494 #  define png_voidcast(type, value) (value)
495 #  ifdef _WIN64
496 #     ifdef __GNUC__
497          typedef unsigned long long png_ptruint;
498 #     else
499          typedef unsigned __int64 png_ptruint;
500 #     endif
501 #  else
502       typedef unsigned long png_ptruint;
503 #  endif
504 #  define png_constcast(type, value) ((type)(png_ptruint)(const void*)(value))
505 #  define png_aligncast(type, value) ((void*)(value))
506 #  define png_aligncastconst(type, value) ((const void*)(value))
507 #endif /* __cplusplus */
508
509 #if defined(PNG_FLOATING_POINT_SUPPORTED) ||\
510     defined(PNG_FLOATING_ARITHMETIC_SUPPORTED)
511    /* png.c requires the following ANSI-C constants if the conversion of
512     * floating point to ASCII is implemented therein:
513     *
514     *  DBL_DIG  Maximum number of decimal digits (can be set to any constant)
515     *  DBL_MIN  Smallest normalized fp number (can be set to an arbitrary value)
516     *  DBL_MAX  Maximum floating point number (can be set to an arbitrary value)
517     */
518 #  include <float.h>
519
520 #  if (defined(__MWERKS__) && defined(macintosh)) || defined(applec) || \
521     defined(THINK_C) || defined(__SC__) || defined(TARGET_OS_MAC)
522    /* We need to check that <math.h> hasn't already been included earlier
523     * as it seems it doesn't agree with <fp.h>, yet we should really use
524     * <fp.h> if possible.
525     */
526 #    if !defined(__MATH_H__) && !defined(__MATH_H) && !defined(__cmath__)
527 #      include <fp.h>
528 #    endif
529 #  else
530 #    include <math.h>
531 #  endif
532 #  if defined(_AMIGA) && defined(__SASC) && defined(_M68881)
533    /* Amiga SAS/C: We must include builtin FPU functions when compiling using
534     * MATH=68881
535     */
536 #    include <m68881.h>
537 #  endif
538 #endif
539
540 /* This provides the non-ANSI (far) memory allocation routines. */
541 #if defined(__TURBOC__) && defined(__MSDOS__)
542 #  include <mem.h>
543 #  include <alloc.h>
544 #endif
545
546 #if defined(WIN32) || defined(_Windows) || defined(_WINDOWS) || \
547     defined(_WIN32) || defined(__WIN32__)
548 #  include <windows.h>  /* defines _WINDOWS_ macro */
549 #endif
550 #endif /* PNG_VERSION_INFO_ONLY */
551
552 /* Moved here around 1.5.0beta36 from pngconf.h */
553 /* Users may want to use these so they are not private.  Any library
554  * functions that are passed far data must be model-independent.
555  */
556
557 /* Memory model/platform independent fns */
558 #ifndef PNG_ABORT
559 #  ifdef _WINDOWS_
560 #    define PNG_ABORT() ExitProcess(0)
561 #  else
562 #    define PNG_ABORT() abort()
563 #  endif
564 #endif
565
566 /* These macros may need to be architecture dependent. */
567 #define PNG_ALIGN_NONE   0 /* do not use data alignment */
568 #define PNG_ALIGN_ALWAYS 1 /* assume unaligned accesses are OK */
569 #ifdef offsetof
570 #  define PNG_ALIGN_OFFSET 2 /* use offsetof to determine alignment */
571 #else
572 #  define PNG_ALIGN_OFFSET -1 /* prevent the use of this */
573 #endif
574 #define PNG_ALIGN_SIZE   3 /* use sizeof to determine alignment */
575
576 #ifndef PNG_ALIGN_TYPE
577    /* Default to using aligned access optimizations and requiring alignment to a
578     * multiple of the data type size.  Override in a compiler specific fashion
579     * if necessary by inserting tests here:
580     */
581 #  define PNG_ALIGN_TYPE PNG_ALIGN_SIZE
582 #endif
583
584 #if PNG_ALIGN_TYPE == PNG_ALIGN_SIZE
585    /* This is used because in some compiler implementations non-aligned
586     * structure members are supported, so the offsetof approach below fails.
587     * Set PNG_ALIGN_SIZE=0 for compiler combinations where unaligned access
588     * is good for performance.  Do not do this unless you have tested the result
589     * and understand it.
590     */
591 #  define png_alignof(type) (sizeof (type))
592 #else
593 #  if PNG_ALIGN_TYPE == PNG_ALIGN_OFFSET
594 #     define png_alignof(type) offsetof(struct{char c; type t;}, t)
595 #  else
596 #     if PNG_ALIGN_TYPE == PNG_ALIGN_ALWAYS
597 #        define png_alignof(type) (1)
598 #     endif
599       /* Else leave png_alignof undefined to prevent use thereof */
600 #  endif
601 #endif
602
603 /* This implicitly assumes alignment is always to a power of 2. */
604 #ifdef png_alignof
605 #  define png_isaligned(ptr, type)\
606    (((type)((const char*)ptr-(const char*)0) & \
607    (type)(png_alignof(type)-1)) == 0)
608 #else
609 #  define png_isaligned(ptr, type) 0
610 #endif
611
612 /* End of memory model/platform independent support */
613 /* End of 1.5.0beta36 move from pngconf.h */
614
615 /* CONSTANTS and UTILITY MACROS
616  * These are used internally by libpng and not exposed in the API
617  */
618
619 /* Various modes of operation.  Note that after an init, mode is set to
620  * zero automatically when the structure is created.  Three of these
621  * are defined in png.h because they need to be visible to applications
622  * that call png_set_unknown_chunk().
623  */
624 /* #define PNG_HAVE_IHDR            0x01U (defined in png.h) */
625 /* #define PNG_HAVE_PLTE            0x02U (defined in png.h) */
626 #define PNG_HAVE_IDAT               0x04U
627 /* #define PNG_AFTER_IDAT           0x08U (defined in png.h) */
628 #define PNG_HAVE_IEND               0x10U
629                    /*               0x20U (unused) */
630                    /*               0x40U (unused) */
631                    /*               0x80U (unused) */
632 #define PNG_HAVE_CHUNK_HEADER      0x100U
633 #define PNG_WROTE_tIME             0x200U
634 #define PNG_WROTE_INFO_BEFORE_PLTE 0x400U
635 #define PNG_BACKGROUND_IS_GRAY     0x800U
636 #define PNG_HAVE_PNG_SIGNATURE    0x1000U
637 #define PNG_HAVE_CHUNK_AFTER_IDAT 0x2000U /* Have another chunk after IDAT */
638                    /*             0x4000U (unused) */
639 #define PNG_IS_READ_STRUCT        0x8000U /* Else is a write struct */
640
641 /* Flags for the transformations the PNG library does on the image data */
642 #define PNG_BGR                 0x0001U
643 #define PNG_INTERLACE           0x0002U
644 #define PNG_PACK                0x0004U
645 #define PNG_SHIFT               0x0008U
646 #define PNG_SWAP_BYTES          0x0010U
647 #define PNG_INVERT_MONO         0x0020U
648 #define PNG_QUANTIZE            0x0040U
649 #define PNG_COMPOSE             0x0080U    /* Was PNG_BACKGROUND */
650 #define PNG_BACKGROUND_EXPAND   0x0100U
651 #define PNG_EXPAND_16           0x0200U    /* Added to libpng 1.5.2 */
652 #define PNG_16_TO_8             0x0400U    /* Becomes 'chop' in 1.5.4 */
653 #define PNG_RGBA                0x0800U
654 #define PNG_EXPAND              0x1000U
655 #define PNG_GAMMA               0x2000U
656 #define PNG_GRAY_TO_RGB         0x4000U
657 #define PNG_FILLER              0x8000U
658 #define PNG_PACKSWAP           0x10000U
659 #define PNG_SWAP_ALPHA         0x20000U
660 #define PNG_STRIP_ALPHA        0x40000U
661 #define PNG_INVERT_ALPHA       0x80000U
662 #define PNG_USER_TRANSFORM    0x100000U
663 #define PNG_RGB_TO_GRAY_ERR   0x200000U
664 #define PNG_RGB_TO_GRAY_WARN  0x400000U
665 #define PNG_RGB_TO_GRAY       0x600000U /* two bits, RGB_TO_GRAY_ERR|WARN */
666 #define PNG_ENCODE_ALPHA      0x800000U /* Added to libpng-1.5.4 */
667 #define PNG_ADD_ALPHA        0x1000000U /* Added to libpng-1.2.7 */
668 #define PNG_EXPAND_tRNS      0x2000000U /* Added to libpng-1.2.9 */
669 #define PNG_SCALE_16_TO_8    0x4000000U /* Added to libpng-1.5.4 */
670                        /*    0x8000000U unused */
671                        /*   0x10000000U unused */
672                        /*   0x20000000U unused */
673                        /*   0x40000000U unused */
674 /* Flags for png_create_struct */
675 #define PNG_STRUCT_PNG   0x0001U
676 #define PNG_STRUCT_INFO  0x0002U
677
678 /* Flags for the png_ptr->flags rather than declaring a byte for each one */
679 #define PNG_FLAG_ZLIB_CUSTOM_STRATEGY     0x0001U
680 #define PNG_FLAG_ZSTREAM_INITIALIZED      0x0002U /* Added to libpng-1.6.0 */
681                                   /*      0x0004U    unused */
682 #define PNG_FLAG_ZSTREAM_ENDED            0x0008U /* Added to libpng-1.6.0 */
683                                   /*      0x0010U    unused */
684                                   /*      0x0020U    unused */
685 #define PNG_FLAG_ROW_INIT                 0x0040U
686 #define PNG_FLAG_FILLER_AFTER             0x0080U
687 #define PNG_FLAG_CRC_ANCILLARY_USE        0x0100U
688 #define PNG_FLAG_CRC_ANCILLARY_NOWARN     0x0200U
689 #define PNG_FLAG_CRC_CRITICAL_USE         0x0400U
690 #define PNG_FLAG_CRC_CRITICAL_IGNORE      0x0800U
691 #define PNG_FLAG_ASSUME_sRGB              0x1000U /* Added to libpng-1.5.4 */
692 #define PNG_FLAG_OPTIMIZE_ALPHA           0x2000U /* Added to libpng-1.5.4 */
693 #define PNG_FLAG_DETECT_UNINITIALIZED     0x4000U /* Added to libpng-1.5.4 */
694 /* #define PNG_FLAG_KEEP_UNKNOWN_CHUNKS      0x8000U */
695 /* #define PNG_FLAG_KEEP_UNSAFE_CHUNKS      0x10000U */
696 #define PNG_FLAG_LIBRARY_MISMATCH        0x20000U
697 #define PNG_FLAG_STRIP_ERROR_NUMBERS     0x40000U
698 #define PNG_FLAG_STRIP_ERROR_TEXT        0x80000U
699 #define PNG_FLAG_BENIGN_ERRORS_WARN     0x100000U /* Added to libpng-1.4.0 */
700 #define PNG_FLAG_APP_WARNINGS_WARN      0x200000U /* Added to libpng-1.6.0 */
701 #define PNG_FLAG_APP_ERRORS_WARN        0x400000U /* Added to libpng-1.6.0 */
702                                   /*    0x800000U    unused */
703                                   /*   0x1000000U    unused */
704                                   /*   0x2000000U    unused */
705                                   /*   0x4000000U    unused */
706                                   /*   0x8000000U    unused */
707                                   /*  0x10000000U    unused */
708                                   /*  0x20000000U    unused */
709                                   /*  0x40000000U    unused */
710
711 #define PNG_FLAG_CRC_ANCILLARY_MASK (PNG_FLAG_CRC_ANCILLARY_USE | \
712                                      PNG_FLAG_CRC_ANCILLARY_NOWARN)
713
714 #define PNG_FLAG_CRC_CRITICAL_MASK  (PNG_FLAG_CRC_CRITICAL_USE | \
715                                      PNG_FLAG_CRC_CRITICAL_IGNORE)
716
717 #define PNG_FLAG_CRC_MASK           (PNG_FLAG_CRC_ANCILLARY_MASK | \
718                                      PNG_FLAG_CRC_CRITICAL_MASK)
719
720 /* Save typing and make code easier to understand */
721
722 #define PNG_COLOR_DIST(c1, c2) (abs((int)((c1).red) - (int)((c2).red)) + \
723    abs((int)((c1).green) - (int)((c2).green)) + \
724    abs((int)((c1).blue) - (int)((c2).blue)))
725
726 /* Added to libpng-1.6.0: scale a 16-bit value in the range 0..65535 to 0..255
727  * by dividing by 257 *with rounding*.  This macro is exact for the given range.
728  * See the discourse in pngrtran.c png_do_scale_16_to_8.  The values in the
729  * macro were established by experiment (modifying the added value).  The macro
730  * has a second variant that takes a value already scaled by 255 and divides by
731  * 65535 - this has a maximum error of .502.  Over the range 0..65535*65535 it
732  * only gives off-by-one errors and only for 0.5% (1 in 200) of the values.
733  */
734 #define PNG_DIV65535(v24) (((v24) + 32895) >> 16)
735 #define PNG_DIV257(v16) PNG_DIV65535((png_uint_32)(v16) * 255)
736
737 /* Added to libpng-1.2.6 JB */
738 #define PNG_ROWBYTES(pixel_bits, width) \
739     ((pixel_bits) >= 8 ? \
740     ((size_t)(width) * (((size_t)(pixel_bits)) >> 3)) : \
741     (( ((size_t)(width) * ((size_t)(pixel_bits))) + 7) >> 3) )
742
743 /* This returns the number of trailing bits in the last byte of a row, 0 if the
744  * last byte is completely full of pixels.  It is, in principle, (pixel_bits x
745  * width) % 8, but that would overflow for large 'width'.  The second macro is
746  * the same except that it returns the number of unused bits in the last byte;
747  * (8-TRAILBITS), but 0 when TRAILBITS is 0.
748  *
749  * NOTE: these macros are intended to be self-evidently correct and never
750  * overflow on the assumption that pixel_bits is in the range 0..255.  The
751  * arguments are evaluated only once and they can be signed (e.g. as a result of
752  * the integral promotions).  The result of the expression always has type
753  * (png_uint_32), however the compiler always knows it is in the range 0..7.
754  */
755 #define PNG_TRAILBITS(pixel_bits, width) \
756     (((pixel_bits) * ((width) % (png_uint_32)8)) % 8)
757
758 #define PNG_PADBITS(pixel_bits, width) \
759     ((8 - PNG_TRAILBITS(pixel_bits, width)) % 8)
760
761 /* PNG_OUT_OF_RANGE returns true if value is outside the range
762  * ideal-delta..ideal+delta.  Each argument is evaluated twice.
763  * "ideal" and "delta" should be constants, normally simple
764  * integers, "value" a variable. Added to libpng-1.2.6 JB
765  */
766 #define PNG_OUT_OF_RANGE(value, ideal, delta) \
767    ( (value) < (ideal)-(delta) || (value) > (ideal)+(delta) )
768
769 /* Conversions between fixed and floating point, only defined if
770  * required (to make sure the code doesn't accidentally use float
771  * when it is supposedly disabled.)
772  */
773 #ifdef PNG_FLOATING_POINT_SUPPORTED
774 /* The floating point conversion can't overflow, though it can and
775  * does lose accuracy relative to the original fixed point value.
776  * In practice this doesn't matter because png_fixed_point only
777  * stores numbers with very low precision.  The png_ptr and s
778  * arguments are unused by default but are there in case error
779  * checking becomes a requirement.
780  */
781 #define png_float(png_ptr, fixed, s) (.00001 * (fixed))
782
783 /* The fixed point conversion performs range checking and evaluates
784  * its argument multiple times, so must be used with care.  The
785  * range checking uses the PNG specification values for a signed
786  * 32-bit fixed point value except that the values are deliberately
787  * rounded-to-zero to an integral value - 21474 (21474.83 is roughly
788  * (2^31-1) * 100000). 's' is a string that describes the value being
789  * converted.
790  *
791  * NOTE: this macro will raise a png_error if the range check fails,
792  * therefore it is normally only appropriate to use this on values
793  * that come from API calls or other sources where an out of range
794  * error indicates a programming error, not a data error!
795  *
796  * NOTE: by default this is off - the macro is not used - because the
797  * function call saves a lot of code.
798  */
799 #ifdef PNG_FIXED_POINT_MACRO_SUPPORTED
800 #define png_fixed(png_ptr, fp, s) ((fp) <= 21474 && (fp) >= -21474 ?\
801     ((png_fixed_point)(100000 * (fp))) : (png_fixed_error(png_ptr, s),0))
802 #endif
803 /* else the corresponding function is defined below, inside the scope of the
804  * cplusplus test.
805  */
806 #endif
807
808 /* Constants for known chunk types.  If you need to add a chunk, define the name
809  * here.  For historical reasons these constants have the form png_<name>; i.e.
810  * the prefix is lower case.  Please use decimal values as the parameters to
811  * match the ISO PNG specification and to avoid relying on the C locale
812  * interpretation of character values.
813  *
814  * Prior to 1.5.6 these constants were strings, as of 1.5.6 png_uint_32 values
815  * are computed and a new macro (PNG_STRING_FROM_CHUNK) added to allow a string
816  * to be generated if required.
817  *
818  * PNG_32b correctly produces a value shifted by up to 24 bits, even on
819  * architectures where (int) is only 16 bits.
820  */
821 #define PNG_32b(b,s) ((png_uint_32)(b) << (s))
822 #define PNG_U32(b1,b2,b3,b4) \
823    (PNG_32b(b1,24) | PNG_32b(b2,16) | PNG_32b(b3,8) | PNG_32b(b4,0))
824
825 /* Constants for known chunk types.
826  *
827  * MAINTAINERS: If you need to add a chunk, define the name here.
828  * For historical reasons these constants have the form png_<name>; i.e.
829  * the prefix is lower case.  Please use decimal values as the parameters to
830  * match the ISO PNG specification and to avoid relying on the C locale
831  * interpretation of character values.  Please keep the list sorted.
832  *
833  * Notice that PNG_U32 is used to define a 32-bit value for the 4 byte chunk
834  * type.  In fact the specification does not express chunk types this way,
835  * however using a 32-bit value means that the chunk type can be read from the
836  * stream using exactly the same code as used for a 32-bit unsigned value and
837  * can be examined far more efficiently (using one arithmetic compare).
838  *
839  * Prior to 1.5.6 the chunk type constants were expressed as C strings.  The
840  * libpng API still uses strings for 'unknown' chunks and a macro,
841  * PNG_STRING_FROM_CHUNK, allows a string to be generated if required.  Notice
842  * that for portable code numeric values must still be used; the string "IHDR"
843  * is not portable and neither is PNG_U32('I', 'H', 'D', 'R').
844  *
845  * In 1.7.0 the definitions will be made public in png.h to avoid having to
846  * duplicate the same definitions in application code.
847  */
848 #define png_IDAT PNG_U32( 73,  68,  65,  84)
849 #define png_IEND PNG_U32( 73,  69,  78,  68)
850 #define png_IHDR PNG_U32( 73,  72,  68,  82)
851 #define png_PLTE PNG_U32( 80,  76,  84,  69)
852 #define png_bKGD PNG_U32( 98,  75,  71,  68)
853 #define png_cHRM PNG_U32( 99,  72,  82,  77)
854 #define png_eXIf PNG_U32(101,  88,  73, 102) /* registered July 2017 */
855 #define png_fRAc PNG_U32(102,  82,  65,  99) /* registered, not defined */
856 #define png_gAMA PNG_U32(103,  65,  77,  65)
857 #define png_gIFg PNG_U32(103,  73,  70, 103)
858 #define png_gIFt PNG_U32(103,  73,  70, 116) /* deprecated */
859 #define png_gIFx PNG_U32(103,  73,  70, 120)
860 #define png_hIST PNG_U32(104,  73,  83,  84)
861 #define png_iCCP PNG_U32(105,  67,  67,  80)
862 #define png_iTXt PNG_U32(105,  84,  88, 116)
863 #define png_oFFs PNG_U32(111,  70,  70, 115)
864 #define png_pCAL PNG_U32(112,  67,  65,  76)
865 #define png_pHYs PNG_U32(112,  72,  89, 115)
866 #define png_sBIT PNG_U32(115,  66,  73,  84)
867 #define png_sCAL PNG_U32(115,  67,  65,  76)
868 #define png_sPLT PNG_U32(115,  80,  76,  84)
869 #define png_sRGB PNG_U32(115,  82,  71,  66)
870 #define png_sTER PNG_U32(115,  84,  69,  82)
871 #define png_tEXt PNG_U32(116,  69,  88, 116)
872 #define png_tIME PNG_U32(116,  73,  77,  69)
873 #define png_tRNS PNG_U32(116,  82,  78,  83)
874 #define png_zTXt PNG_U32(122,  84,  88, 116)
875
876 /* The following will work on (signed char*) strings, whereas the get_uint_32
877  * macro will fail on top-bit-set values because of the sign extension.
878  */
879 #define PNG_CHUNK_FROM_STRING(s)\
880    PNG_U32(0xff & (s)[0], 0xff & (s)[1], 0xff & (s)[2], 0xff & (s)[3])
881
882 /* This uses (char), not (png_byte) to avoid warnings on systems where (char) is
883  * signed and the argument is a (char[])  This macro will fail miserably on
884  * systems where (char) is more than 8 bits.
885  */
886 #define PNG_STRING_FROM_CHUNK(s,c)\
887    (void)(((char*)(s))[0]=(char)(((c)>>24) & 0xff), \
888    ((char*)(s))[1]=(char)(((c)>>16) & 0xff),\
889    ((char*)(s))[2]=(char)(((c)>>8) & 0xff), \
890    ((char*)(s))[3]=(char)((c & 0xff)))
891
892 /* Do the same but terminate with a null character. */
893 #define PNG_CSTRING_FROM_CHUNK(s,c)\
894    (void)(PNG_STRING_FROM_CHUNK(s,c), ((char*)(s))[4] = 0)
895
896 /* Test on flag values as defined in the spec (section 5.4): */
897 #define PNG_CHUNK_ANCILLARY(c)   (1 & ((c) >> 29))
898 #define PNG_CHUNK_CRITICAL(c)     (!PNG_CHUNK_ANCILLARY(c))
899 #define PNG_CHUNK_PRIVATE(c)      (1 & ((c) >> 21))
900 #define PNG_CHUNK_RESERVED(c)     (1 & ((c) >> 13))
901 #define PNG_CHUNK_SAFE_TO_COPY(c) (1 & ((c) >>  5))
902
903 /* Gamma values (new at libpng-1.5.4): */
904 #define PNG_GAMMA_MAC_OLD 151724  /* Assume '1.8' is really 2.2/1.45! */
905 #define PNG_GAMMA_MAC_INVERSE 65909
906 #define PNG_GAMMA_sRGB_INVERSE 45455
907
908 /* Almost everything below is C specific; the #defines above can be used in
909  * non-C code (so long as it is C-preprocessed) the rest of this stuff cannot.
910  */
911 #ifndef PNG_VERSION_INFO_ONLY
912
913 #include "pngstruct.h"
914 #include "pnginfo.h"
915
916 /* Validate the include paths - the include path used to generate pnglibconf.h
917  * must match that used in the build, or we must be using pnglibconf.h.prebuilt:
918  */
919 #if PNG_ZLIB_VERNUM != 0 && PNG_ZLIB_VERNUM != ZLIB_VERNUM
920 #  error ZLIB_VERNUM != PNG_ZLIB_VERNUM \
921       "-I (include path) error: see the notes in pngpriv.h"
922    /* This means that when pnglibconf.h was built the copy of zlib.h that it
923     * used is not the same as the one being used here.  Because the build of
924     * libpng makes decisions to use inflateInit2 and inflateReset2 based on the
925     * zlib version number and because this affects handling of certain broken
926     * PNG files the -I directives must match.
927     *
928     * The most likely explanation is that you passed a -I in CFLAGS. This will
929     * not work; all the preprocessor directives and in particular all the -I
930     * directives must be in CPPFLAGS.
931     */
932 #endif
933
934 /* This is used for 16-bit gamma tables -- only the top level pointers are
935  * const; this could be changed:
936  */
937 typedef const png_uint_16p * png_const_uint_16pp;
938
939 /* Added to libpng-1.5.7: sRGB conversion tables */
940 #if defined(PNG_SIMPLIFIED_READ_SUPPORTED) ||\
941    defined(PNG_SIMPLIFIED_WRITE_SUPPORTED)
942 #ifdef PNG_SIMPLIFIED_READ_SUPPORTED
943 PNG_INTERNAL_DATA(const png_uint_16, png_sRGB_table, [256]);
944    /* Convert from an sRGB encoded value 0..255 to a 16-bit linear value,
945     * 0..65535.  This table gives the closest 16-bit answers (no errors).
946     */
947 #endif
948
949 PNG_INTERNAL_DATA(const png_uint_16, png_sRGB_base, [512]);
950 PNG_INTERNAL_DATA(const png_byte, png_sRGB_delta, [512]);
951
952 #define PNG_sRGB_FROM_LINEAR(linear) \
953   ((png_byte)(0xff & ((png_sRGB_base[(linear)>>15] \
954    + ((((linear) & 0x7fff)*png_sRGB_delta[(linear)>>15])>>12)) >> 8)))
955    /* Given a value 'linear' in the range 0..255*65535 calculate the 8-bit sRGB
956     * encoded value with maximum error 0.646365.  Note that the input is not a
957     * 16-bit value; it has been multiplied by 255! */
958 #endif /* SIMPLIFIED_READ/WRITE */
959
960
961 /* Inhibit C++ name-mangling for libpng functions but not for system calls. */
962 #ifdef __cplusplus
963 extern "C" {
964 #endif /* __cplusplus */
965
966 /* Internal functions; these are not exported from a DLL however because they
967  * are used within several of the C source files they have to be C extern.
968  *
969  * All of these functions must be declared with PNG_INTERNAL_FUNCTION.
970  */
971
972 /* Zlib support */
973 #define PNG_UNEXPECTED_ZLIB_RETURN (-7)
974 PNG_INTERNAL_FUNCTION(void, png_zstream_error,(png_structrp png_ptr, int ret),
975    PNG_EMPTY);
976    /* Used by the zlib handling functions to ensure that z_stream::msg is always
977     * set before they return.
978     */
979
980 #ifdef PNG_WRITE_SUPPORTED
981 PNG_INTERNAL_FUNCTION(void,png_free_buffer_list,(png_structrp png_ptr,
982    png_compression_bufferp *list),PNG_EMPTY);
983    /* Free the buffer list used by the compressed write code. */
984 #endif
985
986 #if defined(PNG_FLOATING_POINT_SUPPORTED) && \
987    !defined(PNG_FIXED_POINT_MACRO_SUPPORTED) && \
988    (defined(PNG_gAMA_SUPPORTED) || defined(PNG_cHRM_SUPPORTED) || \
989    defined(PNG_sCAL_SUPPORTED) || defined(PNG_READ_BACKGROUND_SUPPORTED) || \
990    defined(PNG_READ_RGB_TO_GRAY_SUPPORTED)) || \
991    (defined(PNG_sCAL_SUPPORTED) && \
992    defined(PNG_FLOATING_ARITHMETIC_SUPPORTED))
993 PNG_INTERNAL_FUNCTION(png_fixed_point,png_fixed,(png_const_structrp png_ptr,
994    double fp, png_const_charp text),PNG_EMPTY);
995 #endif
996
997 /* Check the user version string for compatibility, returns false if the version
998  * numbers aren't compatible.
999  */
1000 PNG_INTERNAL_FUNCTION(int,png_user_version_check,(png_structrp png_ptr,
1001    png_const_charp user_png_ver),PNG_EMPTY);
1002
1003 /* Internal base allocator - no messages, NULL on failure to allocate.  This
1004  * does, however, call the application provided allocator and that could call
1005  * png_error (although that would be a bug in the application implementation.)
1006  */
1007 PNG_INTERNAL_FUNCTION(png_voidp,png_malloc_base,(png_const_structrp png_ptr,
1008    png_alloc_size_t size),PNG_ALLOCATED);
1009
1010 #if defined(PNG_TEXT_SUPPORTED) || defined(PNG_sPLT_SUPPORTED) ||\
1011    defined(PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED)
1012 /* Internal array allocator, outputs no error or warning messages on failure,
1013  * just returns NULL.
1014  */
1015 PNG_INTERNAL_FUNCTION(png_voidp,png_malloc_array,(png_const_structrp png_ptr,
1016    int nelements, size_t element_size),PNG_ALLOCATED);
1017
1018 /* The same but an existing array is extended by add_elements.  This function
1019  * also memsets the new elements to 0 and copies the old elements.  The old
1020  * array is not freed or altered.
1021  */
1022 PNG_INTERNAL_FUNCTION(png_voidp,png_realloc_array,(png_const_structrp png_ptr,
1023    png_const_voidp array, int old_elements, int add_elements,
1024    size_t element_size),PNG_ALLOCATED);
1025 #endif /* text, sPLT or unknown chunks */
1026
1027 /* Magic to create a struct when there is no struct to call the user supplied
1028  * memory allocators.  Because error handling has not been set up the memory
1029  * handlers can't safely call png_error, but this is an obscure and undocumented
1030  * restriction so libpng has to assume that the 'free' handler, at least, might
1031  * call png_error.
1032  */
1033 PNG_INTERNAL_FUNCTION(png_structp,png_create_png_struct,
1034    (png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
1035     png_error_ptr warn_fn, png_voidp mem_ptr, png_malloc_ptr malloc_fn,
1036     png_free_ptr free_fn),PNG_ALLOCATED);
1037
1038 /* Free memory from internal libpng struct */
1039 PNG_INTERNAL_FUNCTION(void,png_destroy_png_struct,(png_structrp png_ptr),
1040    PNG_EMPTY);
1041
1042 /* Free an allocated jmp_buf (always succeeds) */
1043 PNG_INTERNAL_FUNCTION(void,png_free_jmpbuf,(png_structrp png_ptr),PNG_EMPTY);
1044
1045 /* Function to allocate memory for zlib.  PNGAPI is disallowed. */
1046 PNG_INTERNAL_FUNCTION(voidpf,png_zalloc,(voidpf png_ptr, uInt items, uInt size),
1047    PNG_ALLOCATED);
1048
1049 /* Function to free memory for zlib.  PNGAPI is disallowed. */
1050 PNG_INTERNAL_FUNCTION(void,png_zfree,(voidpf png_ptr, voidpf ptr),PNG_EMPTY);
1051
1052 /* Next four functions are used internally as callbacks.  PNGCBAPI is required
1053  * but not PNG_EXPORT.  PNGAPI added at libpng version 1.2.3, changed to
1054  * PNGCBAPI at 1.5.0
1055  */
1056
1057 PNG_INTERNAL_FUNCTION(void PNGCBAPI,png_default_read_data,(png_structp png_ptr,
1058     png_bytep data, size_t length),PNG_EMPTY);
1059
1060 #ifdef PNG_PROGRESSIVE_READ_SUPPORTED
1061 PNG_INTERNAL_FUNCTION(void PNGCBAPI,png_push_fill_buffer,(png_structp png_ptr,
1062     png_bytep buffer, size_t length),PNG_EMPTY);
1063 #endif
1064
1065 PNG_INTERNAL_FUNCTION(void PNGCBAPI,png_default_write_data,(png_structp png_ptr,
1066     png_bytep data, size_t length),PNG_EMPTY);
1067
1068 #ifdef PNG_WRITE_FLUSH_SUPPORTED
1069 #  ifdef PNG_STDIO_SUPPORTED
1070 PNG_INTERNAL_FUNCTION(void PNGCBAPI,png_default_flush,(png_structp png_ptr),
1071    PNG_EMPTY);
1072 #  endif
1073 #endif
1074
1075 /* Reset the CRC variable */
1076 PNG_INTERNAL_FUNCTION(void,png_reset_crc,(png_structrp png_ptr),PNG_EMPTY);
1077
1078 /* Write the "data" buffer to whatever output you are using */
1079 PNG_INTERNAL_FUNCTION(void,png_write_data,(png_structrp png_ptr,
1080     png_const_bytep data, size_t length),PNG_EMPTY);
1081
1082 /* Read and check the PNG file signature */
1083 PNG_INTERNAL_FUNCTION(void,png_read_sig,(png_structrp png_ptr,
1084    png_inforp info_ptr),PNG_EMPTY);
1085
1086 /* Read the chunk header (length + type name) */
1087 PNG_INTERNAL_FUNCTION(png_uint_32,png_read_chunk_header,(png_structrp png_ptr),
1088    PNG_EMPTY);
1089
1090 /* Read data from whatever input you are using into the "data" buffer */
1091 PNG_INTERNAL_FUNCTION(void,png_read_data,(png_structrp png_ptr, png_bytep data,
1092     size_t length),PNG_EMPTY);
1093
1094 /* Read bytes into buf, and update png_ptr->crc */
1095 PNG_INTERNAL_FUNCTION(void,png_crc_read,(png_structrp png_ptr, png_bytep buf,
1096     png_uint_32 length),PNG_EMPTY);
1097
1098 /* Read "skip" bytes, read the file crc, and (optionally) verify png_ptr->crc */
1099 PNG_INTERNAL_FUNCTION(int,png_crc_finish,(png_structrp png_ptr,
1100    png_uint_32 skip),PNG_EMPTY);
1101
1102 /* Read the CRC from the file and compare it to the libpng calculated CRC */
1103 PNG_INTERNAL_FUNCTION(int,png_crc_error,(png_structrp png_ptr),PNG_EMPTY);
1104
1105 /* Calculate the CRC over a section of data.  Note that we are only
1106  * passing a maximum of 64K on systems that have this as a memory limit,
1107  * since this is the maximum buffer size we can specify.
1108  */
1109 PNG_INTERNAL_FUNCTION(void,png_calculate_crc,(png_structrp png_ptr,
1110    png_const_bytep ptr, size_t length),PNG_EMPTY);
1111
1112 #ifdef PNG_WRITE_FLUSH_SUPPORTED
1113 PNG_INTERNAL_FUNCTION(void,png_flush,(png_structrp png_ptr),PNG_EMPTY);
1114 #endif
1115
1116 /* Write various chunks */
1117
1118 /* Write the IHDR chunk, and update the png_struct with the necessary
1119  * information.
1120  */
1121 PNG_INTERNAL_FUNCTION(void,png_write_IHDR,(png_structrp png_ptr,
1122    png_uint_32 width, png_uint_32 height, int bit_depth, int color_type,
1123    int compression_method, int filter_method, int interlace_method),PNG_EMPTY);
1124
1125 PNG_INTERNAL_FUNCTION(void,png_write_PLTE,(png_structrp png_ptr,
1126    png_const_colorp palette, png_uint_32 num_pal),PNG_EMPTY);
1127
1128 PNG_INTERNAL_FUNCTION(void,png_compress_IDAT,(png_structrp png_ptr,
1129    png_const_bytep row_data, png_alloc_size_t row_data_length, int flush),
1130    PNG_EMPTY);
1131
1132 PNG_INTERNAL_FUNCTION(void,png_write_IEND,(png_structrp png_ptr),PNG_EMPTY);
1133
1134 #ifdef PNG_WRITE_gAMA_SUPPORTED
1135 PNG_INTERNAL_FUNCTION(void,png_write_gAMA_fixed,(png_structrp png_ptr,
1136     png_fixed_point file_gamma),PNG_EMPTY);
1137 #endif
1138
1139 #ifdef PNG_WRITE_sBIT_SUPPORTED
1140 PNG_INTERNAL_FUNCTION(void,png_write_sBIT,(png_structrp png_ptr,
1141     png_const_color_8p sbit, int color_type),PNG_EMPTY);
1142 #endif
1143
1144 #ifdef PNG_WRITE_cHRM_SUPPORTED
1145 PNG_INTERNAL_FUNCTION(void,png_write_cHRM_fixed,(png_structrp png_ptr,
1146     const png_xy *xy), PNG_EMPTY);
1147    /* The xy value must have been previously validated */
1148 #endif
1149
1150 #ifdef PNG_WRITE_sRGB_SUPPORTED
1151 PNG_INTERNAL_FUNCTION(void,png_write_sRGB,(png_structrp png_ptr,
1152     int intent),PNG_EMPTY);
1153 #endif
1154
1155 #ifdef PNG_WRITE_eXIf_SUPPORTED
1156 PNG_INTERNAL_FUNCTION(void,png_write_eXIf,(png_structrp png_ptr,
1157     png_bytep exif, int num_exif),PNG_EMPTY);
1158 #endif
1159
1160 #ifdef PNG_WRITE_iCCP_SUPPORTED
1161 PNG_INTERNAL_FUNCTION(void,png_write_iCCP,(png_structrp png_ptr,
1162    png_const_charp name, png_const_bytep profile), PNG_EMPTY);
1163    /* The profile must have been previously validated for correctness, the
1164     * length comes from the first four bytes.  Only the base, deflate,
1165     * compression is supported.
1166     */
1167 #endif
1168
1169 #ifdef PNG_WRITE_sPLT_SUPPORTED
1170 PNG_INTERNAL_FUNCTION(void,png_write_sPLT,(png_structrp png_ptr,
1171     png_const_sPLT_tp palette),PNG_EMPTY);
1172 #endif
1173
1174 #ifdef PNG_WRITE_tRNS_SUPPORTED
1175 PNG_INTERNAL_FUNCTION(void,png_write_tRNS,(png_structrp png_ptr,
1176     png_const_bytep trans, png_const_color_16p values, int number,
1177     int color_type),PNG_EMPTY);
1178 #endif
1179
1180 #ifdef PNG_WRITE_bKGD_SUPPORTED
1181 PNG_INTERNAL_FUNCTION(void,png_write_bKGD,(png_structrp png_ptr,
1182     png_const_color_16p values, int color_type),PNG_EMPTY);
1183 #endif
1184
1185 #ifdef PNG_WRITE_hIST_SUPPORTED
1186 PNG_INTERNAL_FUNCTION(void,png_write_hIST,(png_structrp png_ptr,
1187     png_const_uint_16p hist, int num_hist),PNG_EMPTY);
1188 #endif
1189
1190 /* Chunks that have keywords */
1191 #ifdef PNG_WRITE_tEXt_SUPPORTED
1192 PNG_INTERNAL_FUNCTION(void,png_write_tEXt,(png_structrp png_ptr,
1193    png_const_charp key, png_const_charp text, size_t text_len),PNG_EMPTY);
1194 #endif
1195
1196 #ifdef PNG_WRITE_zTXt_SUPPORTED
1197 PNG_INTERNAL_FUNCTION(void,png_write_zTXt,(png_structrp png_ptr, png_const_charp
1198     key, png_const_charp text, int compression),PNG_EMPTY);
1199 #endif
1200
1201 #ifdef PNG_WRITE_iTXt_SUPPORTED
1202 PNG_INTERNAL_FUNCTION(void,png_write_iTXt,(png_structrp png_ptr,
1203     int compression, png_const_charp key, png_const_charp lang,
1204     png_const_charp lang_key, png_const_charp text),PNG_EMPTY);
1205 #endif
1206
1207 #ifdef PNG_TEXT_SUPPORTED  /* Added at version 1.0.14 and 1.2.4 */
1208 PNG_INTERNAL_FUNCTION(int,png_set_text_2,(png_const_structrp png_ptr,
1209     png_inforp info_ptr, png_const_textp text_ptr, int num_text),PNG_EMPTY);
1210 #endif
1211
1212 #ifdef PNG_WRITE_oFFs_SUPPORTED
1213 PNG_INTERNAL_FUNCTION(void,png_write_oFFs,(png_structrp png_ptr,
1214     png_int_32 x_offset, png_int_32 y_offset, int unit_type),PNG_EMPTY);
1215 #endif
1216
1217 #ifdef PNG_WRITE_pCAL_SUPPORTED
1218 PNG_INTERNAL_FUNCTION(void,png_write_pCAL,(png_structrp png_ptr,
1219     png_charp purpose, png_int_32 X0, png_int_32 X1, int type, int nparams,
1220     png_const_charp units, png_charpp params),PNG_EMPTY);
1221 #endif
1222
1223 #ifdef PNG_WRITE_pHYs_SUPPORTED
1224 PNG_INTERNAL_FUNCTION(void,png_write_pHYs,(png_structrp png_ptr,
1225     png_uint_32 x_pixels_per_unit, png_uint_32 y_pixels_per_unit,
1226     int unit_type),PNG_EMPTY);
1227 #endif
1228
1229 #ifdef PNG_WRITE_tIME_SUPPORTED
1230 PNG_INTERNAL_FUNCTION(void,png_write_tIME,(png_structrp png_ptr,
1231     png_const_timep mod_time),PNG_EMPTY);
1232 #endif
1233
1234 #ifdef PNG_WRITE_sCAL_SUPPORTED
1235 PNG_INTERNAL_FUNCTION(void,png_write_sCAL_s,(png_structrp png_ptr,
1236     int unit, png_const_charp width, png_const_charp height),PNG_EMPTY);
1237 #endif
1238
1239 /* Called when finished processing a row of data */
1240 PNG_INTERNAL_FUNCTION(void,png_write_finish_row,(png_structrp png_ptr),
1241     PNG_EMPTY);
1242
1243 /* Internal use only.   Called before first row of data */
1244 PNG_INTERNAL_FUNCTION(void,png_write_start_row,(png_structrp png_ptr),
1245     PNG_EMPTY);
1246
1247 /* Combine a row of data, dealing with alpha, etc. if requested.  'row' is an
1248  * array of png_ptr->width pixels.  If the image is not interlaced or this
1249  * is the final pass this just does a memcpy, otherwise the "display" flag
1250  * is used to determine whether to copy pixels that are not in the current pass.
1251  *
1252  * Because 'png_do_read_interlace' (below) replicates pixels this allows this
1253  * function to achieve the documented 'blocky' appearance during interlaced read
1254  * if display is 1 and the 'sparkle' appearance, where existing pixels in 'row'
1255  * are not changed if they are not in the current pass, when display is 0.
1256  *
1257  * 'display' must be 0 or 1, otherwise the memcpy will be done regardless.
1258  *
1259  * The API always reads from the png_struct row buffer and always assumes that
1260  * it is full width (png_do_read_interlace has already been called.)
1261  *
1262  * This function is only ever used to write to row buffers provided by the
1263  * caller of the relevant libpng API and the row must have already been
1264  * transformed by the read transformations.
1265  *
1266  * The PNG_USE_COMPILE_TIME_MASKS option causes generation of pre-computed
1267  * bitmasks for use within the code, otherwise runtime generated masks are used.
1268  * The default is compile time masks.
1269  */
1270 #ifndef PNG_USE_COMPILE_TIME_MASKS
1271 #  define PNG_USE_COMPILE_TIME_MASKS 1
1272 #endif
1273 PNG_INTERNAL_FUNCTION(void,png_combine_row,(png_const_structrp png_ptr,
1274     png_bytep row, int display),PNG_EMPTY);
1275
1276 #ifdef PNG_READ_INTERLACING_SUPPORTED
1277 /* Expand an interlaced row: the 'row_info' describes the pass data that has
1278  * been read in and must correspond to the pixels in 'row', the pixels are
1279  * expanded (moved apart) in 'row' to match the final layout, when doing this
1280  * the pixels are *replicated* to the intervening space.  This is essential for
1281  * the correct operation of png_combine_row, above.
1282  */
1283 PNG_INTERNAL_FUNCTION(void,png_do_read_interlace,(png_row_infop row_info,
1284     png_bytep row, int pass, png_uint_32 transformations),PNG_EMPTY);
1285 #endif
1286
1287 /* GRR TO DO (2.0 or whenever):  simplify other internal calling interfaces */
1288
1289 #ifdef PNG_WRITE_INTERLACING_SUPPORTED
1290 /* Grab pixels out of a row for an interlaced pass */
1291 PNG_INTERNAL_FUNCTION(void,png_do_write_interlace,(png_row_infop row_info,
1292     png_bytep row, int pass),PNG_EMPTY);
1293 #endif
1294
1295 /* Unfilter a row: check the filter value before calling this, there is no point
1296  * calling it for PNG_FILTER_VALUE_NONE.
1297  */
1298 PNG_INTERNAL_FUNCTION(void,png_read_filter_row,(png_structrp pp, png_row_infop
1299     row_info, png_bytep row, png_const_bytep prev_row, int filter),PNG_EMPTY);
1300
1301 #if PNG_ARM_NEON_OPT > 0
1302 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_up_neon,(png_row_infop row_info,
1303     png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1304 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_sub3_neon,(png_row_infop
1305     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1306 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_sub4_neon,(png_row_infop
1307     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1308 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_avg3_neon,(png_row_infop
1309     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1310 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_avg4_neon,(png_row_infop
1311     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1312 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_paeth3_neon,(png_row_infop
1313     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1314 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_paeth4_neon,(png_row_infop
1315     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1316 #endif
1317
1318 #if PNG_MIPS_MSA_OPT > 0
1319 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_up_msa,(png_row_infop row_info,
1320     png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1321 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_sub3_msa,(png_row_infop
1322     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1323 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_sub4_msa,(png_row_infop
1324     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1325 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_avg3_msa,(png_row_infop
1326     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1327 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_avg4_msa,(png_row_infop
1328     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1329 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_paeth3_msa,(png_row_infop
1330     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1331 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_paeth4_msa,(png_row_infop
1332     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1333 #endif
1334
1335 #if PNG_POWERPC_VSX_OPT > 0
1336 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_up_vsx,(png_row_infop row_info,
1337     png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1338 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_sub3_vsx,(png_row_infop
1339     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1340 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_sub4_vsx,(png_row_infop
1341     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1342 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_avg3_vsx,(png_row_infop
1343     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1344 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_avg4_vsx,(png_row_infop
1345     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1346 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_paeth3_vsx,(png_row_infop
1347     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1348 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_paeth4_vsx,(png_row_infop
1349     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1350 #endif
1351
1352 #if PNG_INTEL_SSE_IMPLEMENTATION > 0
1353 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_sub3_sse2,(png_row_infop
1354     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1355 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_sub4_sse2,(png_row_infop
1356     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1357 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_avg3_sse2,(png_row_infop
1358     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1359 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_avg4_sse2,(png_row_infop
1360     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1361 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_paeth3_sse2,(png_row_infop
1362     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1363 PNG_INTERNAL_FUNCTION(void,png_read_filter_row_paeth4_sse2,(png_row_infop
1364     row_info, png_bytep row, png_const_bytep prev_row),PNG_EMPTY);
1365 #endif
1366
1367 /* Choose the best filter to use and filter the row data */
1368 PNG_INTERNAL_FUNCTION(void,png_write_find_filter,(png_structrp png_ptr,
1369     png_row_infop row_info),PNG_EMPTY);
1370
1371 #ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1372 PNG_INTERNAL_FUNCTION(void,png_read_IDAT_data,(png_structrp png_ptr,
1373    png_bytep output, png_alloc_size_t avail_out),PNG_EMPTY);
1374    /* Read 'avail_out' bytes of data from the IDAT stream.  If the output buffer
1375     * is NULL the function checks, instead, for the end of the stream.  In this
1376     * case a benign error will be issued if the stream end is not found or if
1377     * extra data has to be consumed.
1378     */
1379 PNG_INTERNAL_FUNCTION(void,png_read_finish_IDAT,(png_structrp png_ptr),
1380    PNG_EMPTY);
1381    /* This cleans up when the IDAT LZ stream does not end when the last image
1382     * byte is read; there is still some pending input.
1383     */
1384
1385 PNG_INTERNAL_FUNCTION(void,png_read_finish_row,(png_structrp png_ptr),
1386    PNG_EMPTY);
1387    /* Finish a row while reading, dealing with interlacing passes, etc. */
1388 #endif /* SEQUENTIAL_READ */
1389
1390 /* Initialize the row buffers, etc. */
1391 PNG_INTERNAL_FUNCTION(void,png_read_start_row,(png_structrp png_ptr),PNG_EMPTY);
1392
1393 #if ZLIB_VERNUM >= 0x1240
1394 PNG_INTERNAL_FUNCTION(int,png_zlib_inflate,(png_structrp png_ptr, int flush),
1395       PNG_EMPTY);
1396 #  define PNG_INFLATE(pp, flush) png_zlib_inflate(pp, flush)
1397 #else /* Zlib < 1.2.4 */
1398 #  define PNG_INFLATE(pp, flush) inflate(&(pp)->zstream, flush)
1399 #endif /* Zlib < 1.2.4 */
1400
1401 #ifdef PNG_READ_TRANSFORMS_SUPPORTED
1402 /* Optional call to update the users info structure */
1403 PNG_INTERNAL_FUNCTION(void,png_read_transform_info,(png_structrp png_ptr,
1404     png_inforp info_ptr),PNG_EMPTY);
1405 #endif
1406
1407 /* Shared transform functions, defined in pngtran.c */
1408 #if defined(PNG_WRITE_FILLER_SUPPORTED) || \
1409     defined(PNG_READ_STRIP_ALPHA_SUPPORTED)
1410 PNG_INTERNAL_FUNCTION(void,png_do_strip_channel,(png_row_infop row_info,
1411     png_bytep row, int at_start),PNG_EMPTY);
1412 #endif
1413
1414 #ifdef PNG_16BIT_SUPPORTED
1415 #if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
1416 PNG_INTERNAL_FUNCTION(void,png_do_swap,(png_row_infop row_info,
1417     png_bytep row),PNG_EMPTY);
1418 #endif
1419 #endif
1420
1421 #if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
1422     defined(PNG_WRITE_PACKSWAP_SUPPORTED)
1423 PNG_INTERNAL_FUNCTION(void,png_do_packswap,(png_row_infop row_info,
1424     png_bytep row),PNG_EMPTY);
1425 #endif
1426
1427 #if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
1428 PNG_INTERNAL_FUNCTION(void,png_do_invert,(png_row_infop row_info,
1429     png_bytep row),PNG_EMPTY);
1430 #endif
1431
1432 #if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
1433 PNG_INTERNAL_FUNCTION(void,png_do_bgr,(png_row_infop row_info,
1434     png_bytep row),PNG_EMPTY);
1435 #endif
1436
1437 /* The following decodes the appropriate chunks, and does error correction,
1438  * then calls the appropriate callback for the chunk if it is valid.
1439  */
1440
1441 /* Decode the IHDR chunk */
1442 PNG_INTERNAL_FUNCTION(void,png_handle_IHDR,(png_structrp png_ptr,
1443     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1444 PNG_INTERNAL_FUNCTION(void,png_handle_PLTE,(png_structrp png_ptr,
1445     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1446 PNG_INTERNAL_FUNCTION(void,png_handle_IEND,(png_structrp png_ptr,
1447     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1448
1449 #ifdef PNG_READ_bKGD_SUPPORTED
1450 PNG_INTERNAL_FUNCTION(void,png_handle_bKGD,(png_structrp png_ptr,
1451     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1452 #endif
1453
1454 #ifdef PNG_READ_cHRM_SUPPORTED
1455 PNG_INTERNAL_FUNCTION(void,png_handle_cHRM,(png_structrp png_ptr,
1456     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1457 #endif
1458
1459 #ifdef PNG_READ_eXIf_SUPPORTED
1460 PNG_INTERNAL_FUNCTION(void,png_handle_eXIf,(png_structrp png_ptr,
1461     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1462 #endif
1463
1464 #ifdef PNG_READ_gAMA_SUPPORTED
1465 PNG_INTERNAL_FUNCTION(void,png_handle_gAMA,(png_structrp png_ptr,
1466     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1467 #endif
1468
1469 #ifdef PNG_READ_hIST_SUPPORTED
1470 PNG_INTERNAL_FUNCTION(void,png_handle_hIST,(png_structrp png_ptr,
1471     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1472 #endif
1473
1474 #ifdef PNG_READ_iCCP_SUPPORTED
1475 PNG_INTERNAL_FUNCTION(void,png_handle_iCCP,(png_structrp png_ptr,
1476     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1477 #endif /* READ_iCCP */
1478
1479 #ifdef PNG_READ_iTXt_SUPPORTED
1480 PNG_INTERNAL_FUNCTION(void,png_handle_iTXt,(png_structrp png_ptr,
1481     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1482 #endif
1483
1484 #ifdef PNG_READ_oFFs_SUPPORTED
1485 PNG_INTERNAL_FUNCTION(void,png_handle_oFFs,(png_structrp png_ptr,
1486     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1487 #endif
1488
1489 #ifdef PNG_READ_pCAL_SUPPORTED
1490 PNG_INTERNAL_FUNCTION(void,png_handle_pCAL,(png_structrp png_ptr,
1491     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1492 #endif
1493
1494 #ifdef PNG_READ_pHYs_SUPPORTED
1495 PNG_INTERNAL_FUNCTION(void,png_handle_pHYs,(png_structrp png_ptr,
1496     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1497 #endif
1498
1499 #ifdef PNG_READ_sBIT_SUPPORTED
1500 PNG_INTERNAL_FUNCTION(void,png_handle_sBIT,(png_structrp png_ptr,
1501     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1502 #endif
1503
1504 #ifdef PNG_READ_sCAL_SUPPORTED
1505 PNG_INTERNAL_FUNCTION(void,png_handle_sCAL,(png_structrp png_ptr,
1506     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1507 #endif
1508
1509 #ifdef PNG_READ_sPLT_SUPPORTED
1510 PNG_INTERNAL_FUNCTION(void,png_handle_sPLT,(png_structrp png_ptr,
1511     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1512 #endif /* READ_sPLT */
1513
1514 #ifdef PNG_READ_sRGB_SUPPORTED
1515 PNG_INTERNAL_FUNCTION(void,png_handle_sRGB,(png_structrp png_ptr,
1516     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1517 #endif
1518
1519 #ifdef PNG_READ_tEXt_SUPPORTED
1520 PNG_INTERNAL_FUNCTION(void,png_handle_tEXt,(png_structrp png_ptr,
1521     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1522 #endif
1523
1524 #ifdef PNG_READ_tIME_SUPPORTED
1525 PNG_INTERNAL_FUNCTION(void,png_handle_tIME,(png_structrp png_ptr,
1526     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1527 #endif
1528
1529 #ifdef PNG_READ_tRNS_SUPPORTED
1530 PNG_INTERNAL_FUNCTION(void,png_handle_tRNS,(png_structrp png_ptr,
1531     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1532 #endif
1533
1534 #ifdef PNG_READ_zTXt_SUPPORTED
1535 PNG_INTERNAL_FUNCTION(void,png_handle_zTXt,(png_structrp png_ptr,
1536     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1537 #endif
1538
1539 PNG_INTERNAL_FUNCTION(void,png_check_chunk_name,(png_const_structrp png_ptr,
1540     png_uint_32 chunk_name),PNG_EMPTY);
1541
1542 PNG_INTERNAL_FUNCTION(void,png_check_chunk_length,(png_const_structrp png_ptr,
1543     png_uint_32 chunk_length),PNG_EMPTY);
1544
1545 PNG_INTERNAL_FUNCTION(void,png_handle_unknown,(png_structrp png_ptr,
1546     png_inforp info_ptr, png_uint_32 length, int keep),PNG_EMPTY);
1547    /* This is the function that gets called for unknown chunks.  The 'keep'
1548     * argument is either non-zero for a known chunk that has been set to be
1549     * handled as unknown or zero for an unknown chunk.  By default the function
1550     * just skips the chunk or errors out if it is critical.
1551     */
1552
1553 #if defined(PNG_READ_UNKNOWN_CHUNKS_SUPPORTED) ||\
1554     defined(PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
1555 PNG_INTERNAL_FUNCTION(int,png_chunk_unknown_handling,
1556     (png_const_structrp png_ptr, png_uint_32 chunk_name),PNG_EMPTY);
1557    /* Exactly as the API png_handle_as_unknown() except that the argument is a
1558     * 32-bit chunk name, not a string.
1559     */
1560 #endif /* READ_UNKNOWN_CHUNKS || HANDLE_AS_UNKNOWN */
1561
1562 /* Handle the transformations for reading and writing */
1563 #ifdef PNG_READ_TRANSFORMS_SUPPORTED
1564 PNG_INTERNAL_FUNCTION(void,png_do_read_transformations,(png_structrp png_ptr,
1565    png_row_infop row_info),PNG_EMPTY);
1566 #endif
1567 #ifdef PNG_WRITE_TRANSFORMS_SUPPORTED
1568 PNG_INTERNAL_FUNCTION(void,png_do_write_transformations,(png_structrp png_ptr,
1569    png_row_infop row_info),PNG_EMPTY);
1570 #endif
1571
1572 #ifdef PNG_READ_TRANSFORMS_SUPPORTED
1573 PNG_INTERNAL_FUNCTION(void,png_init_read_transformations,(png_structrp png_ptr),
1574     PNG_EMPTY);
1575 #endif
1576
1577 #ifdef PNG_PROGRESSIVE_READ_SUPPORTED
1578 PNG_INTERNAL_FUNCTION(void,png_push_read_chunk,(png_structrp png_ptr,
1579     png_inforp info_ptr),PNG_EMPTY);
1580 PNG_INTERNAL_FUNCTION(void,png_push_read_sig,(png_structrp png_ptr,
1581     png_inforp info_ptr),PNG_EMPTY);
1582 PNG_INTERNAL_FUNCTION(void,png_push_check_crc,(png_structrp png_ptr),PNG_EMPTY);
1583 PNG_INTERNAL_FUNCTION(void,png_push_save_buffer,(png_structrp png_ptr),
1584     PNG_EMPTY);
1585 PNG_INTERNAL_FUNCTION(void,png_push_restore_buffer,(png_structrp png_ptr,
1586     png_bytep buffer, size_t buffer_length),PNG_EMPTY);
1587 PNG_INTERNAL_FUNCTION(void,png_push_read_IDAT,(png_structrp png_ptr),PNG_EMPTY);
1588 PNG_INTERNAL_FUNCTION(void,png_process_IDAT_data,(png_structrp png_ptr,
1589     png_bytep buffer, size_t buffer_length),PNG_EMPTY);
1590 PNG_INTERNAL_FUNCTION(void,png_push_process_row,(png_structrp png_ptr),
1591     PNG_EMPTY);
1592 PNG_INTERNAL_FUNCTION(void,png_push_handle_unknown,(png_structrp png_ptr,
1593    png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1594 PNG_INTERNAL_FUNCTION(void,png_push_have_info,(png_structrp png_ptr,
1595    png_inforp info_ptr),PNG_EMPTY);
1596 PNG_INTERNAL_FUNCTION(void,png_push_have_end,(png_structrp png_ptr,
1597    png_inforp info_ptr),PNG_EMPTY);
1598 PNG_INTERNAL_FUNCTION(void,png_push_have_row,(png_structrp png_ptr,
1599     png_bytep row),PNG_EMPTY);
1600 PNG_INTERNAL_FUNCTION(void,png_push_read_end,(png_structrp png_ptr,
1601     png_inforp info_ptr),PNG_EMPTY);
1602 PNG_INTERNAL_FUNCTION(void,png_process_some_data,(png_structrp png_ptr,
1603     png_inforp info_ptr),PNG_EMPTY);
1604 PNG_INTERNAL_FUNCTION(void,png_read_push_finish_row,(png_structrp png_ptr),
1605     PNG_EMPTY);
1606 #  ifdef PNG_READ_tEXt_SUPPORTED
1607 PNG_INTERNAL_FUNCTION(void,png_push_handle_tEXt,(png_structrp png_ptr,
1608     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1609 PNG_INTERNAL_FUNCTION(void,png_push_read_tEXt,(png_structrp png_ptr,
1610     png_inforp info_ptr),PNG_EMPTY);
1611 #  endif
1612 #  ifdef PNG_READ_zTXt_SUPPORTED
1613 PNG_INTERNAL_FUNCTION(void,png_push_handle_zTXt,(png_structrp png_ptr,
1614     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1615 PNG_INTERNAL_FUNCTION(void,png_push_read_zTXt,(png_structrp png_ptr,
1616     png_inforp info_ptr),PNG_EMPTY);
1617 #  endif
1618 #  ifdef PNG_READ_iTXt_SUPPORTED
1619 PNG_INTERNAL_FUNCTION(void,png_push_handle_iTXt,(png_structrp png_ptr,
1620     png_inforp info_ptr, png_uint_32 length),PNG_EMPTY);
1621 PNG_INTERNAL_FUNCTION(void,png_push_read_iTXt,(png_structrp png_ptr,
1622     png_inforp info_ptr),PNG_EMPTY);
1623 #  endif
1624
1625 #endif /* PROGRESSIVE_READ */
1626
1627 /* Added at libpng version 1.6.0 */
1628 #ifdef PNG_GAMMA_SUPPORTED
1629 PNG_INTERNAL_FUNCTION(void,png_colorspace_set_gamma,(png_const_structrp png_ptr,
1630     png_colorspacerp colorspace, png_fixed_point gAMA), PNG_EMPTY);
1631    /* Set the colorspace gamma with a value provided by the application or by
1632     * the gAMA chunk on read.  The value will override anything set by an ICC
1633     * profile.
1634     */
1635
1636 PNG_INTERNAL_FUNCTION(void,png_colorspace_sync_info,(png_const_structrp png_ptr,
1637     png_inforp info_ptr), PNG_EMPTY);
1638    /* Synchronize the info 'valid' flags with the colorspace */
1639
1640 PNG_INTERNAL_FUNCTION(void,png_colorspace_sync,(png_const_structrp png_ptr,
1641     png_inforp info_ptr), PNG_EMPTY);
1642    /* Copy the png_struct colorspace to the info_struct and call the above to
1643     * synchronize the flags.  Checks for NULL info_ptr and does nothing.
1644     */
1645 #endif
1646
1647 /* Added at libpng version 1.4.0 */
1648 #ifdef PNG_COLORSPACE_SUPPORTED
1649 /* These internal functions are for maintaining the colorspace structure within
1650  * a png_info or png_struct (or, indeed, both).
1651  */
1652 PNG_INTERNAL_FUNCTION(int,png_colorspace_set_chromaticities,
1653    (png_const_structrp png_ptr, png_colorspacerp colorspace, const png_xy *xy,
1654     int preferred), PNG_EMPTY);
1655
1656 PNG_INTERNAL_FUNCTION(int,png_colorspace_set_endpoints,
1657    (png_const_structrp png_ptr, png_colorspacerp colorspace, const png_XYZ *XYZ,
1658     int preferred), PNG_EMPTY);
1659
1660 #ifdef PNG_sRGB_SUPPORTED
1661 PNG_INTERNAL_FUNCTION(int,png_colorspace_set_sRGB,(png_const_structrp png_ptr,
1662    png_colorspacerp colorspace, int intent), PNG_EMPTY);
1663    /* This does set the colorspace gAMA and cHRM values too, but doesn't set the
1664     * flags to write them, if it returns false there was a problem and an error
1665     * message has already been output (but the colorspace may still need to be
1666     * synced to record the invalid flag).
1667     */
1668 #endif /* sRGB */
1669
1670 #ifdef PNG_iCCP_SUPPORTED
1671 PNG_INTERNAL_FUNCTION(int,png_colorspace_set_ICC,(png_const_structrp png_ptr,
1672    png_colorspacerp colorspace, png_const_charp name,
1673    png_uint_32 profile_length, png_const_bytep profile, int color_type),
1674    PNG_EMPTY);
1675    /* The 'name' is used for information only */
1676
1677 /* Routines for checking parts of an ICC profile. */
1678 #ifdef PNG_READ_iCCP_SUPPORTED
1679 PNG_INTERNAL_FUNCTION(int,png_icc_check_length,(png_const_structrp png_ptr,
1680    png_colorspacerp colorspace, png_const_charp name,
1681    png_uint_32 profile_length), PNG_EMPTY);
1682 #endif /* READ_iCCP */
1683 PNG_INTERNAL_FUNCTION(int,png_icc_check_header,(png_const_structrp png_ptr,
1684    png_colorspacerp colorspace, png_const_charp name,
1685    png_uint_32 profile_length,
1686    png_const_bytep profile /* first 132 bytes only */, int color_type),
1687    PNG_EMPTY);
1688 PNG_INTERNAL_FUNCTION(int,png_icc_check_tag_table,(png_const_structrp png_ptr,
1689    png_colorspacerp colorspace, png_const_charp name,
1690    png_uint_32 profile_length,
1691    png_const_bytep profile /* header plus whole tag table */), PNG_EMPTY);
1692 #ifdef PNG_sRGB_SUPPORTED
1693 PNG_INTERNAL_FUNCTION(void,png_icc_set_sRGB,(
1694    png_const_structrp png_ptr, png_colorspacerp colorspace,
1695    png_const_bytep profile, uLong adler), PNG_EMPTY);
1696    /* 'adler' is the Adler32 checksum of the uncompressed profile data. It may
1697     * be zero to indicate that it is not available.  It is used, if provided,
1698     * as a fast check on the profile when checking to see if it is sRGB.
1699     */
1700 #endif
1701 #endif /* iCCP */
1702
1703 #ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
1704 PNG_INTERNAL_FUNCTION(void,png_colorspace_set_rgb_coefficients,
1705    (png_structrp png_ptr), PNG_EMPTY);
1706    /* Set the rgb_to_gray coefficients from the colorspace Y values */
1707 #endif /* READ_RGB_TO_GRAY */
1708 #endif /* COLORSPACE */
1709
1710 /* Added at libpng version 1.4.0 */
1711 PNG_INTERNAL_FUNCTION(void,png_check_IHDR,(png_const_structrp png_ptr,
1712     png_uint_32 width, png_uint_32 height, int bit_depth,
1713     int color_type, int interlace_type, int compression_type,
1714     int filter_type),PNG_EMPTY);
1715
1716 /* Added at libpng version 1.5.10 */
1717 #if defined(PNG_READ_CHECK_FOR_INVALID_INDEX_SUPPORTED) || \
1718     defined(PNG_WRITE_CHECK_FOR_INVALID_INDEX_SUPPORTED)
1719 PNG_INTERNAL_FUNCTION(void,png_do_check_palette_indexes,
1720    (png_structrp png_ptr, png_row_infop row_info),PNG_EMPTY);
1721 #endif
1722
1723 #if defined(PNG_FLOATING_POINT_SUPPORTED) && defined(PNG_ERROR_TEXT_SUPPORTED)
1724 PNG_INTERNAL_FUNCTION(void,png_fixed_error,(png_const_structrp png_ptr,
1725    png_const_charp name),PNG_NORETURN);
1726 #endif
1727
1728 /* Puts 'string' into 'buffer' at buffer[pos], taking care never to overwrite
1729  * the end.  Always leaves the buffer nul terminated.  Never errors out (and
1730  * there is no error code.)
1731  */
1732 PNG_INTERNAL_FUNCTION(size_t,png_safecat,(png_charp buffer, size_t bufsize,
1733    size_t pos, png_const_charp string),PNG_EMPTY);
1734
1735 /* Various internal functions to handle formatted warning messages, currently
1736  * only implemented for warnings.
1737  */
1738 #if defined(PNG_WARNINGS_SUPPORTED) || defined(PNG_TIME_RFC1123_SUPPORTED)
1739 /* Utility to dump an unsigned value into a buffer, given a start pointer and
1740  * and end pointer (which should point just *beyond* the end of the buffer!)
1741  * Returns the pointer to the start of the formatted string.  This utility only
1742  * does unsigned values.
1743  */
1744 PNG_INTERNAL_FUNCTION(png_charp,png_format_number,(png_const_charp start,
1745    png_charp end, int format, png_alloc_size_t number),PNG_EMPTY);
1746
1747 /* Convenience macro that takes an array: */
1748 #define PNG_FORMAT_NUMBER(buffer,format,number) \
1749    png_format_number(buffer, buffer + (sizeof buffer), format, number)
1750
1751 /* Suggested size for a number buffer (enough for 64 bits and a sign!) */
1752 #define PNG_NUMBER_BUFFER_SIZE 24
1753
1754 /* These are the integer formats currently supported, the name is formed from
1755  * the standard printf(3) format string.
1756  */
1757 #define PNG_NUMBER_FORMAT_u     1 /* chose unsigned API! */
1758 #define PNG_NUMBER_FORMAT_02u   2
1759 #define PNG_NUMBER_FORMAT_d     1 /* chose signed API! */
1760 #define PNG_NUMBER_FORMAT_02d   2
1761 #define PNG_NUMBER_FORMAT_x     3
1762 #define PNG_NUMBER_FORMAT_02x   4
1763 #define PNG_NUMBER_FORMAT_fixed 5 /* choose the signed API */
1764 #endif
1765
1766 #ifdef PNG_WARNINGS_SUPPORTED
1767 /* New defines and members adding in libpng-1.5.4 */
1768 #  define PNG_WARNING_PARAMETER_SIZE 32
1769 #  define PNG_WARNING_PARAMETER_COUNT 8 /* Maximum 9; see pngerror.c */
1770
1771 /* An l-value of this type has to be passed to the APIs below to cache the
1772  * values of the parameters to a formatted warning message.
1773  */
1774 typedef char png_warning_parameters[PNG_WARNING_PARAMETER_COUNT][
1775    PNG_WARNING_PARAMETER_SIZE];
1776
1777 PNG_INTERNAL_FUNCTION(void,png_warning_parameter,(png_warning_parameters p,
1778    int number, png_const_charp string),PNG_EMPTY);
1779    /* Parameters are limited in size to PNG_WARNING_PARAMETER_SIZE characters,
1780     * including the trailing '\0'.
1781     */
1782 PNG_INTERNAL_FUNCTION(void,png_warning_parameter_unsigned,
1783    (png_warning_parameters p, int number, int format, png_alloc_size_t value),
1784    PNG_EMPTY);
1785    /* Use png_alloc_size_t because it is an unsigned type as big as any we
1786     * need to output.  Use the following for a signed value.
1787     */
1788 PNG_INTERNAL_FUNCTION(void,png_warning_parameter_signed,
1789    (png_warning_parameters p, int number, int format, png_int_32 value),
1790    PNG_EMPTY);
1791
1792 PNG_INTERNAL_FUNCTION(void,png_formatted_warning,(png_const_structrp png_ptr,
1793    png_warning_parameters p, png_const_charp message),PNG_EMPTY);
1794    /* 'message' follows the X/Open approach of using @1, @2 to insert
1795     * parameters previously supplied using the above functions.  Errors in
1796     * specifying the parameters will simply result in garbage substitutions.
1797     */
1798 #endif
1799
1800 #ifdef PNG_BENIGN_ERRORS_SUPPORTED
1801 /* Application errors (new in 1.6); use these functions (declared below) for
1802  * errors in the parameters or order of API function calls on read.  The
1803  * 'warning' should be used for an error that can be handled completely; the
1804  * 'error' for one which can be handled safely but which may lose application
1805  * information or settings.
1806  *
1807  * By default these both result in a png_error call prior to release, while in a
1808  * released version the 'warning' is just a warning.  However if the application
1809  * explicitly disables benign errors (explicitly permitting the code to lose
1810  * information) they both turn into warnings.
1811  *
1812  * If benign errors aren't supported they end up as the corresponding base call
1813  * (png_warning or png_error.)
1814  */
1815 PNG_INTERNAL_FUNCTION(void,png_app_warning,(png_const_structrp png_ptr,
1816    png_const_charp message),PNG_EMPTY);
1817    /* The application provided invalid parameters to an API function or called
1818     * an API function at the wrong time, libpng can completely recover.
1819     */
1820
1821 PNG_INTERNAL_FUNCTION(void,png_app_error,(png_const_structrp png_ptr,
1822    png_const_charp message),PNG_EMPTY);
1823    /* As above but libpng will ignore the call, or attempt some other partial
1824     * recovery from the error.
1825     */
1826 #else
1827 #  define png_app_warning(pp,s) png_warning(pp,s)
1828 #  define png_app_error(pp,s) png_error(pp,s)
1829 #endif
1830
1831 PNG_INTERNAL_FUNCTION(void,png_chunk_report,(png_const_structrp png_ptr,
1832    png_const_charp message, int error),PNG_EMPTY);
1833    /* Report a recoverable issue in chunk data.  On read this is used to report
1834     * a problem found while reading a particular chunk and the
1835     * png_chunk_benign_error or png_chunk_warning function is used as
1836     * appropriate.  On write this is used to report an error that comes from
1837     * data set via an application call to a png_set_ API and png_app_error or
1838     * png_app_warning is used as appropriate.
1839     *
1840     * The 'error' parameter must have one of the following values:
1841     */
1842 #define PNG_CHUNK_WARNING     0 /* never an error */
1843 #define PNG_CHUNK_WRITE_ERROR 1 /* an error only on write */
1844 #define PNG_CHUNK_ERROR       2 /* always an error */
1845
1846 /* ASCII to FP interfaces, currently only implemented if sCAL
1847  * support is required.
1848  */
1849 #if defined(PNG_sCAL_SUPPORTED)
1850 /* MAX_DIGITS is actually the maximum number of characters in an sCAL
1851  * width or height, derived from the precision (number of significant
1852  * digits - a build time settable option) and assumptions about the
1853  * maximum ridiculous exponent.
1854  */
1855 #define PNG_sCAL_MAX_DIGITS (PNG_sCAL_PRECISION+1/*.*/+1/*E*/+10/*exponent*/)
1856
1857 #ifdef PNG_FLOATING_POINT_SUPPORTED
1858 PNG_INTERNAL_FUNCTION(void,png_ascii_from_fp,(png_const_structrp png_ptr,
1859    png_charp ascii, size_t size, double fp, unsigned int precision),
1860    PNG_EMPTY);
1861 #endif /* FLOATING_POINT */
1862
1863 #ifdef PNG_FIXED_POINT_SUPPORTED
1864 PNG_INTERNAL_FUNCTION(void,png_ascii_from_fixed,(png_const_structrp png_ptr,
1865    png_charp ascii, size_t size, png_fixed_point fp),PNG_EMPTY);
1866 #endif /* FIXED_POINT */
1867 #endif /* sCAL */
1868
1869 #if defined(PNG_sCAL_SUPPORTED) || defined(PNG_pCAL_SUPPORTED)
1870 /* An internal API to validate the format of a floating point number.
1871  * The result is the index of the next character.  If the number is
1872  * not valid it will be the index of a character in the supposed number.
1873  *
1874  * The format of a number is defined in the PNG extensions specification
1875  * and this API is strictly conformant to that spec, not anyone elses!
1876  *
1877  * The format as a regular expression is:
1878  *
1879  * [+-]?[0-9]+.?([Ee][+-]?[0-9]+)?
1880  *
1881  * or:
1882  *
1883  * [+-]?.[0-9]+(.[0-9]+)?([Ee][+-]?[0-9]+)?
1884  *
1885  * The complexity is that either integer or fraction must be present and the
1886  * fraction is permitted to have no digits only if the integer is present.
1887  *
1888  * NOTE: The dangling E problem.
1889  *   There is a PNG valid floating point number in the following:
1890  *
1891  *       PNG floating point numbers are not greedy.
1892  *
1893  *   Working this out requires *TWO* character lookahead (because of the
1894  *   sign), the parser does not do this - it will fail at the 'r' - this
1895  *   doesn't matter for PNG sCAL chunk values, but it requires more care
1896  *   if the value were ever to be embedded in something more complex.  Use
1897  *   ANSI-C strtod if you need the lookahead.
1898  */
1899 /* State table for the parser. */
1900 #define PNG_FP_INTEGER    0  /* before or in integer */
1901 #define PNG_FP_FRACTION   1  /* before or in fraction */
1902 #define PNG_FP_EXPONENT   2  /* before or in exponent */
1903 #define PNG_FP_STATE      3  /* mask for the above */
1904 #define PNG_FP_SAW_SIGN   4  /* Saw +/- in current state */
1905 #define PNG_FP_SAW_DIGIT  8  /* Saw a digit in current state */
1906 #define PNG_FP_SAW_DOT   16  /* Saw a dot in current state */
1907 #define PNG_FP_SAW_E     32  /* Saw an E (or e) in current state */
1908 #define PNG_FP_SAW_ANY   60  /* Saw any of the above 4 */
1909
1910 /* These three values don't affect the parser.  They are set but not used.
1911  */
1912 #define PNG_FP_WAS_VALID 64  /* Preceding substring is a valid fp number */
1913 #define PNG_FP_NEGATIVE 128  /* A negative number, including "-0" */
1914 #define PNG_FP_NONZERO  256  /* A non-zero value */
1915 #define PNG_FP_STICKY   448  /* The above three flags */
1916
1917 /* This is available for the caller to store in 'state' if required.  Do not
1918  * call the parser after setting it (the parser sometimes clears it.)
1919  */
1920 #define PNG_FP_INVALID  512  /* Available for callers as a distinct value */
1921
1922 /* Result codes for the parser (boolean - true meants ok, false means
1923  * not ok yet.)
1924  */
1925 #define PNG_FP_MAYBE      0  /* The number may be valid in the future */
1926 #define PNG_FP_OK         1  /* The number is valid */
1927
1928 /* Tests on the sticky non-zero and negative flags.  To pass these checks
1929  * the state must also indicate that the whole number is valid - this is
1930  * achieved by testing PNG_FP_SAW_DIGIT (see the implementation for why this
1931  * is equivalent to PNG_FP_OK above.)
1932  */
1933 #define PNG_FP_NZ_MASK (PNG_FP_SAW_DIGIT | PNG_FP_NEGATIVE | PNG_FP_NONZERO)
1934    /* NZ_MASK: the string is valid and a non-zero negative value */
1935 #define PNG_FP_Z_MASK (PNG_FP_SAW_DIGIT | PNG_FP_NONZERO)
1936    /* Z MASK: the string is valid and a non-zero value. */
1937    /* PNG_FP_SAW_DIGIT: the string is valid. */
1938 #define PNG_FP_IS_ZERO(state) (((state) & PNG_FP_Z_MASK) == PNG_FP_SAW_DIGIT)
1939 #define PNG_FP_IS_POSITIVE(state) (((state) & PNG_FP_NZ_MASK) == PNG_FP_Z_MASK)
1940 #define PNG_FP_IS_NEGATIVE(state) (((state) & PNG_FP_NZ_MASK) == PNG_FP_NZ_MASK)
1941
1942 /* The actual parser.  This can be called repeatedly. It updates
1943  * the index into the string and the state variable (which must
1944  * be initialized to 0).  It returns a result code, as above.  There
1945  * is no point calling the parser any more if it fails to advance to
1946  * the end of the string - it is stuck on an invalid character (or
1947  * terminated by '\0').
1948  *
1949  * Note that the pointer will consume an E or even an E+ and then leave
1950  * a 'maybe' state even though a preceding integer.fraction is valid.
1951  * The PNG_FP_WAS_VALID flag indicates that a preceding substring was
1952  * a valid number.  It's possible to recover from this by calling
1953  * the parser again (from the start, with state 0) but with a string
1954  * that omits the last character (i.e. set the size to the index of
1955  * the problem character.)  This has not been tested within libpng.
1956  */
1957 PNG_INTERNAL_FUNCTION(int,png_check_fp_number,(png_const_charp string,
1958    size_t size, int *statep, png_size_tp whereami),PNG_EMPTY);
1959
1960 /* This is the same but it checks a complete string and returns true
1961  * only if it just contains a floating point number.  As of 1.5.4 this
1962  * function also returns the state at the end of parsing the number if
1963  * it was valid (otherwise it returns 0.)  This can be used for testing
1964  * for negative or zero values using the sticky flag.
1965  */
1966 PNG_INTERNAL_FUNCTION(int,png_check_fp_string,(png_const_charp string,
1967    size_t size),PNG_EMPTY);
1968 #endif /* pCAL || sCAL */
1969
1970 #if defined(PNG_GAMMA_SUPPORTED) ||\
1971     defined(PNG_INCH_CONVERSIONS_SUPPORTED) || defined(PNG_READ_pHYs_SUPPORTED)
1972 /* Added at libpng version 1.5.0 */
1973 /* This is a utility to provide a*times/div (rounded) and indicate
1974  * if there is an overflow.  The result is a boolean - false (0)
1975  * for overflow, true (1) if no overflow, in which case *res
1976  * holds the result.
1977  */
1978 PNG_INTERNAL_FUNCTION(int,png_muldiv,(png_fixed_point_p res, png_fixed_point a,
1979    png_int_32 multiplied_by, png_int_32 divided_by),PNG_EMPTY);
1980 #endif
1981
1982 #if defined(PNG_READ_GAMMA_SUPPORTED) || defined(PNG_INCH_CONVERSIONS_SUPPORTED)
1983 /* Same deal, but issue a warning on overflow and return 0. */
1984 PNG_INTERNAL_FUNCTION(png_fixed_point,png_muldiv_warn,
1985    (png_const_structrp png_ptr, png_fixed_point a, png_int_32 multiplied_by,
1986    png_int_32 divided_by),PNG_EMPTY);
1987 #endif
1988
1989 #ifdef PNG_GAMMA_SUPPORTED
1990 /* Calculate a reciprocal - used for gamma values.  This returns
1991  * 0 if the argument is 0 in order to maintain an undefined value;
1992  * there are no warnings.
1993  */
1994 PNG_INTERNAL_FUNCTION(png_fixed_point,png_reciprocal,(png_fixed_point a),
1995    PNG_EMPTY);
1996
1997 #ifdef PNG_READ_GAMMA_SUPPORTED
1998 /* The same but gives a reciprocal of the product of two fixed point
1999  * values.  Accuracy is suitable for gamma calculations but this is
2000  * not exact - use png_muldiv for that.  Only required at present on read.
2001  */
2002 PNG_INTERNAL_FUNCTION(png_fixed_point,png_reciprocal2,(png_fixed_point a,
2003    png_fixed_point b),PNG_EMPTY);
2004 #endif
2005
2006 /* Return true if the gamma value is significantly different from 1.0 */
2007 PNG_INTERNAL_FUNCTION(int,png_gamma_significant,(png_fixed_point gamma_value),
2008    PNG_EMPTY);
2009 #endif
2010
2011 #ifdef PNG_READ_GAMMA_SUPPORTED
2012 /* Internal fixed point gamma correction.  These APIs are called as
2013  * required to convert single values - they don't need to be fast,
2014  * they are not used when processing image pixel values.
2015  *
2016  * While the input is an 'unsigned' value it must actually be the
2017  * correct bit value - 0..255 or 0..65535 as required.
2018  */
2019 PNG_INTERNAL_FUNCTION(png_uint_16,png_gamma_correct,(png_structrp png_ptr,
2020    unsigned int value, png_fixed_point gamma_value),PNG_EMPTY);
2021 PNG_INTERNAL_FUNCTION(png_uint_16,png_gamma_16bit_correct,(unsigned int value,
2022    png_fixed_point gamma_value),PNG_EMPTY);
2023 PNG_INTERNAL_FUNCTION(png_byte,png_gamma_8bit_correct,(unsigned int value,
2024    png_fixed_point gamma_value),PNG_EMPTY);
2025 PNG_INTERNAL_FUNCTION(void,png_destroy_gamma_table,(png_structrp png_ptr),
2026    PNG_EMPTY);
2027 PNG_INTERNAL_FUNCTION(void,png_build_gamma_table,(png_structrp png_ptr,
2028    int bit_depth),PNG_EMPTY);
2029 #endif
2030
2031 /* SIMPLIFIED READ/WRITE SUPPORT */
2032 #if defined(PNG_SIMPLIFIED_READ_SUPPORTED) ||\
2033    defined(PNG_SIMPLIFIED_WRITE_SUPPORTED)
2034 /* The internal structure that png_image::opaque points to. */
2035 typedef struct png_control
2036 {
2037    png_structp png_ptr;
2038    png_infop   info_ptr;
2039    png_voidp   error_buf;           /* Always a jmp_buf at present. */
2040
2041    png_const_bytep memory;          /* Memory buffer. */
2042    size_t          size;            /* Size of the memory buffer. */
2043
2044    unsigned int for_write       :1; /* Otherwise it is a read structure */
2045    unsigned int owned_file      :1; /* We own the file in io_ptr */
2046 } png_control;
2047
2048 /* Return the pointer to the jmp_buf from a png_control: necessary because C
2049  * does not reveal the type of the elements of jmp_buf.
2050  */
2051 #ifdef __cplusplus
2052 #  define png_control_jmp_buf(pc) (((jmp_buf*)((pc)->error_buf))[0])
2053 #else
2054 #  define png_control_jmp_buf(pc) ((pc)->error_buf)
2055 #endif
2056
2057 /* Utility to safely execute a piece of libpng code catching and logging any
2058  * errors that might occur.  Returns true on success, false on failure (either
2059  * of the function or as a result of a png_error.)
2060  */
2061 PNG_INTERNAL_CALLBACK(void,png_safe_error,(png_structp png_ptr,
2062    png_const_charp error_message),PNG_NORETURN);
2063
2064 #ifdef PNG_WARNINGS_SUPPORTED
2065 PNG_INTERNAL_CALLBACK(void,png_safe_warning,(png_structp png_ptr,
2066    png_const_charp warning_message),PNG_EMPTY);
2067 #else
2068 #  define png_safe_warning 0/*dummy argument*/
2069 #endif
2070
2071 PNG_INTERNAL_FUNCTION(int,png_safe_execute,(png_imagep image,
2072    int (*function)(png_voidp), png_voidp arg),PNG_EMPTY);
2073
2074 /* Utility to log an error; this also cleans up the png_image; the function
2075  * always returns 0 (false).
2076  */
2077 PNG_INTERNAL_FUNCTION(int,png_image_error,(png_imagep image,
2078    png_const_charp error_message),PNG_EMPTY);
2079
2080 #ifndef PNG_SIMPLIFIED_READ_SUPPORTED
2081 /* png_image_free is used by the write code but not exported */
2082 PNG_INTERNAL_FUNCTION(void, png_image_free, (png_imagep image), PNG_EMPTY);
2083 #endif /* !SIMPLIFIED_READ */
2084
2085 #endif /* SIMPLIFIED READ/WRITE */
2086
2087 /* These are initialization functions for hardware specific PNG filter
2088  * optimizations; list these here then select the appropriate one at compile
2089  * time using the macro PNG_FILTER_OPTIMIZATIONS.  If the macro is not defined
2090  * the generic code is used.
2091  */
2092 #ifdef PNG_FILTER_OPTIMIZATIONS
2093 PNG_INTERNAL_FUNCTION(void, PNG_FILTER_OPTIMIZATIONS, (png_structp png_ptr,
2094    unsigned int bpp), PNG_EMPTY);
2095    /* Just declare the optimization that will be used */
2096 #else
2097    /* List *all* the possible optimizations here - this branch is required if
2098     * the builder of libpng passes the definition of PNG_FILTER_OPTIMIZATIONS in
2099     * CFLAGS in place of CPPFLAGS *and* uses symbol prefixing.
2100     */
2101 #  if PNG_ARM_NEON_OPT > 0
2102 PNG_INTERNAL_FUNCTION(void, png_init_filter_functions_neon,
2103    (png_structp png_ptr, unsigned int bpp), PNG_EMPTY);
2104 #endif
2105
2106 #if PNG_MIPS_MSA_OPT > 0
2107 PNG_INTERNAL_FUNCTION(void, png_init_filter_functions_msa,
2108    (png_structp png_ptr, unsigned int bpp), PNG_EMPTY);
2109 #endif
2110
2111 #  if PNG_INTEL_SSE_IMPLEMENTATION > 0
2112 PNG_INTERNAL_FUNCTION(void, png_init_filter_functions_sse2,
2113    (png_structp png_ptr, unsigned int bpp), PNG_EMPTY);
2114 #  endif
2115 #endif
2116
2117 PNG_INTERNAL_FUNCTION(png_uint_32, png_check_keyword, (png_structrp png_ptr,
2118    png_const_charp key, png_bytep new_key), PNG_EMPTY);
2119
2120 #if PNG_ARM_NEON_IMPLEMENTATION == 1
2121 PNG_INTERNAL_FUNCTION(void,
2122                       png_riffle_palette_rgba,
2123                       (png_structrp, png_row_infop),
2124                       PNG_EMPTY);
2125 PNG_INTERNAL_FUNCTION(int,
2126                       png_do_expand_palette_neon_rgba,
2127                       (png_structrp,
2128                        png_row_infop,
2129                        png_const_bytep,
2130                        const png_bytepp,
2131                        const png_bytepp),
2132                       PNG_EMPTY);
2133 PNG_INTERNAL_FUNCTION(int,
2134                       png_do_expand_palette_neon_rgb,
2135                       (png_structrp,
2136                        png_row_infop,
2137                        png_const_bytep,
2138                        const png_bytepp,
2139                        const png_bytepp),
2140                       PNG_EMPTY);
2141 #endif
2142
2143 /* Maintainer: Put new private prototypes here ^ */
2144
2145 #include "pngdebug.h"
2146
2147 #ifdef __cplusplus
2148 }
2149 #endif
2150
2151 #endif /* PNG_VERSION_INFO_ONLY */
2152 #endif /* PNGPRIV_H */