pngvalid.c 325.6 KB
Newer Older
G
[devel]  
Glenn Randers-Pehrson 已提交
1 2 3

/* pngvalid.c - validate libpng by constructing then reading png files.
 *
4
 * Last changed in libpng 1.6.14 [October 23, 2014]
5
 * Copyright (c) 2014 Glenn Randers-Pehrson
6
 * Written by John Cunningham Bowler
G
[devel]  
Glenn Randers-Pehrson 已提交
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * This code is released under the libpng license.
 * For conditions of distribution and use, see the disclaimer
 * and license in png.h
 *
 * NOTES:
 *   This is a C program that is intended to be linked against libpng.  It
 *   generates bitmaps internally, stores them as PNG files (using the
 *   sequential write code) then reads them back (using the sequential
 *   read code) and validates that the result has the correct data.
 *
 *   The program can be modified and extended to test the correctness of
 *   transformations performed by libpng.
 */

22
#define _POSIX_SOURCE 1
23 24 25 26
#define _ISOC99_SOURCE 1 /* For floating point */
#define _GNU_SOURCE 1 /* For the floating point exception extension */

#include <signal.h>
27
#include <stdio.h>
28

29
#if defined(HAVE_CONFIG_H) && !defined(PNG_NO_CONFIG_H)
30 31
#  include <config.h>
#endif
32

33 34 35 36 37
#ifdef HAVE_FEENABLEEXCEPT /* from config.h, if included */
#  include <fenv.h>
#endif

#ifndef FE_DIVBYZERO
38
#  define FE_DIVBYZERO 0
39 40
#endif
#ifndef FE_INVALID
41
#  define FE_INVALID 0
42 43
#endif
#ifndef FE_OVERFLOW
44
#  define FE_OVERFLOW 0
45 46
#endif

47 48 49 50 51 52 53 54
/* Define the following to use this test against your installed libpng, rather
 * than the one being built here:
 */
#ifdef PNG_FREESTANDING_TESTS
#  include <png.h>
#else
#  include "../../png.h"
#endif
55

56 57 58 59 60 61
#ifdef PNG_ZLIB_HEADER
#  include PNG_ZLIB_HEADER
#else
#  include <zlib.h>   /* For crc32 */
#endif

62 63 64 65 66 67 68 69 70
/* 1.6.1 added support for the configure test harness, which uses 77 to indicate
 * a skipped test, in earlier versions we need to succeed on a skipped test, so:
 */
#if PNG_LIBPNG_VER < 10601
#  define SKIP 0
#else
#  define SKIP 77
#endif

71 72 73 74
/* pngvalid requires write support and one of the fixed or floating point APIs.
 */
#if defined(PNG_WRITE_SUPPORTED) &&\
   (defined(PNG_FIXED_POINT_SUPPORTED) || defined(PNG_FLOATING_POINT_SUPPORTED))
75

76
#if PNG_LIBPNG_VER < 10500
77
/* This deliberately lacks the PNG_CONST. */
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
typedef png_byte *png_const_bytep;

/* This is copied from 1.5.1 png.h: */
#define PNG_INTERLACE_ADAM7_PASSES 7
#define PNG_PASS_START_ROW(pass) (((1U&~(pass))<<(3-((pass)>>1)))&7)
#define PNG_PASS_START_COL(pass) (((1U& (pass))<<(3-(((pass)+1)>>1)))&7)
#define PNG_PASS_ROW_SHIFT(pass) ((pass)>2?(8-(pass))>>1:3)
#define PNG_PASS_COL_SHIFT(pass) ((pass)>1?(7-(pass))>>1:3)
#define PNG_PASS_ROWS(height, pass) (((height)+(((1<<PNG_PASS_ROW_SHIFT(pass))\
   -1)-PNG_PASS_START_ROW(pass)))>>PNG_PASS_ROW_SHIFT(pass))
#define PNG_PASS_COLS(width, pass) (((width)+(((1<<PNG_PASS_COL_SHIFT(pass))\
   -1)-PNG_PASS_START_COL(pass)))>>PNG_PASS_COL_SHIFT(pass))
#define PNG_ROW_FROM_PASS_ROW(yIn, pass) \
   (((yIn)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass))
#define PNG_COL_FROM_PASS_COL(xIn, pass) \
   (((xIn)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass))
#define PNG_PASS_MASK(pass,off) ( \
   ((0x110145AFU>>(((7-(off))-(pass))<<2)) & 0xFU) | \
   ((0x01145AF0U>>(((7-(off))-(pass))<<2)) & 0xF0U))
#define PNG_ROW_IN_INTERLACE_PASS(y, pass) \
   ((PNG_PASS_MASK(pass,0) >> ((y)&7)) & 1)
#define PNG_COL_IN_INTERLACE_PASS(x, pass) \
   ((PNG_PASS_MASK(pass,1) >> ((x)&7)) & 1)

102
/* These are needed too for the default build: */
103 104
#define PNG_WRITE_16BIT_SUPPORTED
#define PNG_READ_16BIT_SUPPORTED
105 106

/* This comes from pnglibconf.h afer 1.5: */
107
#define PNG_FP_1 100000
108
#define PNG_GAMMA_THRESHOLD_FIXED\
109
   ((png_fixed_point)(PNG_GAMMA_THRESHOLD * PNG_FP_1))
110 111
#endif

112 113 114 115
#if PNG_LIBPNG_VER < 10600
   /* 1.6.0 constifies many APIs, the following exists to allow pngvalid to be
    * compiled against earlier versions.
    */
116
#  define png_const_structp png_structp
117 118
#endif

119
#include <float.h>  /* For floating point constants */
G
[devel]  
Glenn Randers-Pehrson 已提交
120 121 122 123
#include <stdlib.h> /* For malloc */
#include <string.h> /* For memcpy, memset */
#include <math.h>   /* For floor */

124 125 126 127
/* Unused formal parameter errors are removed using the following macro which is
 * expected to have no bad effects on performance.
 */
#ifndef UNUSED
128 129 130 131 132
#  if defined(__GNUC__) || defined(_MSC_VER)
#     define UNUSED(param) (void)param;
#  else
#     define UNUSED(param)
#  endif
133 134
#endif

135
/***************************** EXCEPTION HANDLING *****************************/
136 137 138 139 140
#ifdef PNG_FREESTANDING_TESTS
#  include <cexcept.h>
#else
#  include "../visupng/cexcept.h"
#endif
141 142 143 144 145 146 147 148 149

#ifdef __cplusplus
#  define this not_the_cpp_this
#  define new not_the_cpp_new
#  define voidcast(type, value) static_cast<type>(value)
#else
#  define voidcast(type, value) (value)
#endif /* __cplusplus */

150
struct png_store;
151 152
define_exception_type(struct png_store*);

153
/* The following are macros to reduce typing everywhere where the well known
154 155
 * name 'the_exception_context' must be defined.
 */
156 157 158
#define anon_context(ps) struct exception_context *the_exception_context = \
   &(ps)->exception_context
#define context(ps,fault) anon_context(ps); png_store *fault
159

160 161 162 163 164 165 166
/******************************* UTILITIES ************************************/
/* Error handling is particularly problematic in production code - error
 * handlers often themselves have bugs which lead to programs that detect
 * minor errors crashing.  The following functions deal with one very
 * common class of errors in error handlers - attempting to format error or
 * warning messages into buffers that are too small.
 */
167 168
static size_t safecat(char *buffer, size_t bufsize, size_t pos,
   PNG_CONST char *cat)
G
[devel]  
Glenn Randers-Pehrson 已提交
169
{
170 171 172 173 174 175
   while (pos < bufsize && cat != NULL && *cat != 0)
      buffer[pos++] = *cat++;

   if (pos >= bufsize)
      pos = bufsize-1;

G
[devel]  
Glenn Randers-Pehrson 已提交
176 177 178 179 180 181 182 183 184 185 186
   buffer[pos] = 0;
   return pos;
}

static size_t safecatn(char *buffer, size_t bufsize, size_t pos, int n)
{
   char number[64];
   sprintf(number, "%d", n);
   return safecat(buffer, bufsize, pos, number);
}

187
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
188
static size_t safecatd(char *buffer, size_t bufsize, size_t pos, double d,
189
    int precision)
G
[devel]  
Glenn Randers-Pehrson 已提交
190 191 192 193 194
{
   char number[64];
   sprintf(number, "%.*f", precision, d);
   return safecat(buffer, bufsize, pos, number);
}
195
#endif
G
[devel]  
Glenn Randers-Pehrson 已提交
196

197 198
static PNG_CONST char invalid[] = "invalid";
static PNG_CONST char sep[] = ": ";
G
[devel]  
Glenn Randers-Pehrson 已提交
199

200
static PNG_CONST char *colour_types[8] =
G
[devel]  
Glenn Randers-Pehrson 已提交
201
{
202 203
   "grayscale", invalid, "truecolour", "indexed-colour",
   "grayscale with alpha", invalid, "truecolour with alpha", invalid
G
[devel]  
Glenn Randers-Pehrson 已提交
204 205
};

206
#ifdef PNG_READ_SUPPORTED
207 208 209 210 211 212 213
/* Convert a double precision value to fixed point. */
static png_fixed_point
fix(double d)
{
   d = floor(d * PNG_FP_1 + .5);
   return (png_fixed_point)d;
}
214
#endif /* PNG_READ_SUPPORTED */
215

216 217 218 219
/* Generate random bytes.  This uses a boring repeatable algorithm and it
 * is implemented here so that it gives the same set of numbers on every
 * architecture.  It's a linear congruential generator (Knuth or Sedgewick
 * "Algorithms") but it comes from the 'feedback taps' table in Horowitz and
220 221
 * Hill, "The Art of Electronics" (Pseudo-Random Bit Sequences and Noise
 * Generation.)
222 223 224
 */
static void
make_random_bytes(png_uint_32* seed, void* pv, size_t size)
225
{
226
   png_uint_32 u0 = seed[0], u1 = seed[1];
227
   png_bytep bytes = voidcast(png_bytep, pv);
228

229 230 231 232 233 234 235 236 237 238 239 240 241 242
   /* There are thirty three bits, the next bit in the sequence is bit-33 XOR
    * bit-20.  The top 1 bit is in u1, the bottom 32 are in u0.
    */
   size_t i;
   for (i=0; i<size; ++i)
   {
      /* First generate 8 new bits then shift them in at the end. */
      png_uint_32 u = ((u0 >> (20-8)) ^ ((u1 << 7) | (u0 >> (32-7)))) & 0xff;
      u1 <<= 8;
      u1 |= u0 >> 24;
      u0 <<= 8;
      u0 |= u;
      *bytes++ = (png_byte)u;
   }
243

244 245 246
   seed[0] = u0;
   seed[1] = u1;
}
247

248 249 250 251 252
static void
make_four_random_bytes(png_uint_32* seed, png_bytep bytes)
{
   make_random_bytes(seed, bytes, 4);
}
253

254
#ifdef PNG_READ_SUPPORTED
255 256 257 258 259
static void
randomize(void *pv, size_t size)
{
   static png_uint_32 random_seed[2] = {0x56789abc, 0xd};
   make_random_bytes(random_seed, pv, size);
260 261
}

262 263
#define RANDOMIZE(this) randomize(&(this), sizeof (this))

264 265 266 267 268 269 270 271 272 273
static unsigned int
random_mod(unsigned int max)
{
   unsigned int x;

   RANDOMIZE(x);

   return x % max; /* 0 .. max-1 */
}

274
#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
275 276 277 278 279 280 281 282 283
static int
random_choice(void)
{
   unsigned char x;

   RANDOMIZE(x);

   return x & 1;
}
284 285
#endif
#endif /* PNG_READ_SUPPORTED */
286

287 288
/* A numeric ID based on PNG file characteristics.  The 'do_interlace' field
 * simply records whether pngvalid did the interlace itself or whether it
289 290
 * was done by libpng.  Width and height must be less than 256.  'palette' is an
 * index of the palette to use for formats with a palette (0 otherwise.)
291
 */
292 293
#define FILEID(col, depth, palette, interlace, width, height, do_interlace) \
   ((png_uint_32)((col) + ((depth)<<3) + ((palette)<<8) + ((interlace)<<13) + \
294 295
    (((do_interlace)!=0)<<15) + ((width)<<16) + ((height)<<24)))

296 297
#define COL_FROM_ID(id) ((png_byte)((id)& 0x7U))
#define DEPTH_FROM_ID(id) ((png_byte)(((id) >> 3) & 0x1fU))
298
#define PALETTE_FROM_ID(id) (((id) >> 8) & 0x1f)
299
#define INTERLACE_FROM_ID(id) ((int)(((id) >> 13) & 0x3))
300 301 302
#define DO_INTERLACE_FROM_ID(id) ((int)(((id)>>15) & 1))
#define WIDTH_FROM_ID(id) (((id)>>16) & 0xff)
#define HEIGHT_FROM_ID(id) (((id)>>24) & 0xff)
303 304 305 306

/* Utility to construct a standard name for a standard image. */
static size_t
standard_name(char *buffer, size_t bufsize, size_t pos, png_byte colour_type,
307
    int bit_depth, unsigned int npalette, int interlace_type,
308
    png_uint_32 w, png_uint_32 h, int do_interlace)
309 310
{
   pos = safecat(buffer, bufsize, pos, colour_types[colour_type]);
311 312 313 314 315 316
   if (npalette > 0)
   {
      pos = safecat(buffer, bufsize, pos, "[");
      pos = safecatn(buffer, bufsize, pos, npalette);
      pos = safecat(buffer, bufsize, pos, "]");
   }
317
   pos = safecat(buffer, bufsize, pos, " ");
318
   pos = safecatn(buffer, bufsize, pos, bit_depth);
319
   pos = safecat(buffer, bufsize, pos, " bit");
320 321

   if (interlace_type != PNG_INTERLACE_NONE)
322
   {
323
      pos = safecat(buffer, bufsize, pos, " interlaced");
324 325 326 327 328 329
      if (do_interlace)
         pos = safecat(buffer, bufsize, pos, "(pngvalid)");
      else
         pos = safecat(buffer, bufsize, pos, "(libpng)");
   }

330 331 332 333 334 335 336
   if (w > 0 || h > 0)
   {
      pos = safecat(buffer, bufsize, pos, " ");
      pos = safecatn(buffer, bufsize, pos, w);
      pos = safecat(buffer, bufsize, pos, "x");
      pos = safecatn(buffer, bufsize, pos, h);
   }
337 338 339 340 341 342 343 344

   return pos;
}

static size_t
standard_name_from_id(char *buffer, size_t bufsize, size_t pos, png_uint_32 id)
{
   return standard_name(buffer, bufsize, pos, COL_FROM_ID(id),
345
      DEPTH_FROM_ID(id), PALETTE_FROM_ID(id), INTERLACE_FROM_ID(id),
346
      WIDTH_FROM_ID(id), HEIGHT_FROM_ID(id), DO_INTERLACE_FROM_ID(id));
347 348
}

349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
/* Convenience API and defines to list valid formats.  Note that 16 bit read and
 * write support is required to do 16 bit read tests (we must be able to make a
 * 16 bit image to test!)
 */
#ifdef PNG_WRITE_16BIT_SUPPORTED
#  define WRITE_BDHI 4
#  ifdef PNG_READ_16BIT_SUPPORTED
#     define READ_BDHI 4
#     define DO_16BIT
#  endif
#else
#  define WRITE_BDHI 3
#endif
#ifndef DO_16BIT
#  define READ_BDHI 3
#endif

366 367 368
/* The following defines the number of different palettes to generate for
 * each log bit depth of a colour type 3 standard image.
 */
369
#define PALETTE_COUNT(bit_depth) ((bit_depth) > 4 ? 1U : 16U)
370

G
[devel]  
Glenn Randers-Pehrson 已提交
371
static int
372
next_format(png_bytep colour_type, png_bytep bit_depth,
373
   unsigned int* palette_number, int no_low_depth_gray)
G
[devel]  
Glenn Randers-Pehrson 已提交
374 375 376
{
   if (*bit_depth == 0)
   {
377 378 379 380 381 382
      *colour_type = 0;
      if (no_low_depth_gray)
         *bit_depth = 8;
      else
         *bit_depth = 1;
      *palette_number = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
383 384
      return 1;
   }
385

386 387 388 389 390 391 392 393 394
   if (*colour_type == 3)
   {
      /* Add multiple palettes for colour type 3. */
      if (++*palette_number < PALETTE_COUNT(*bit_depth))
         return 1;

      *palette_number = 0;
   }

395 396 397
   *bit_depth = (png_byte)(*bit_depth << 1);

   /* Palette images are restricted to 8 bit depth */
398
   if (*bit_depth <= 8
399
#ifdef DO_16BIT
400
         || (*colour_type != 3 && *bit_depth <= 16)
401
#endif
402
      )
403 404 405 406
      return 1;

   /* Move to the next color type, or return 0 at the end. */
   switch (*colour_type)
G
[devel]  
Glenn Randers-Pehrson 已提交
407
   {
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
      case 0:
         *colour_type = 2;
         *bit_depth = 8;
         return 1;

      case 2:
         *colour_type = 3;
         *bit_depth = 1;
         return 1;

      case 3:
         *colour_type = 4;
         *bit_depth = 8;
         return 1;

      case 4:
         *colour_type = 6;
         *bit_depth = 8;
         return 1;

      default:
         return 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
430 431 432
   }
}

433
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
434
static unsigned int
435
sample(png_const_bytep row, png_byte colour_type, png_byte bit_depth,
436
    png_uint_32 x, unsigned int sample_index)
G
[devel]  
Glenn Randers-Pehrson 已提交
437
{
438
   png_uint_32 bit_index, result;
439

G
[devel]  
Glenn Randers-Pehrson 已提交
440 441
   /* Find a sample index for the desired sample: */
   x *= bit_depth;
442
   bit_index = x;
443

G
[devel]  
Glenn Randers-Pehrson 已提交
444 445 446
   if ((colour_type & 1) == 0) /* !palette */
   {
      if (colour_type & 2)
447
         bit_index *= 3;
448 449

      if (colour_type & 4)
450
         bit_index += x; /* Alpha channel */
451

452
      /* Multiple channels; select one: */
453
      if (colour_type & (2+4))
454
         bit_index += sample_index * bit_depth;
G
[devel]  
Glenn Randers-Pehrson 已提交
455 456 457
   }

   /* Return the sample from the row as an integer. */
458
   row += bit_index >> 3;
G
[devel]  
Glenn Randers-Pehrson 已提交
459
   result = *row;
460

G
[devel]  
Glenn Randers-Pehrson 已提交
461 462
   if (bit_depth == 8)
      return result;
463

G
[devel]  
Glenn Randers-Pehrson 已提交
464 465
   else if (bit_depth > 8)
      return (result << 8) + *++row;
466

G
[devel]  
Glenn Randers-Pehrson 已提交
467
   /* Less than 8 bits per sample. */
468 469
   bit_index &= 7;
   return (result >> (8-bit_index-bit_depth)) & ((1U<<bit_depth)-1);
G
[devel]  
Glenn Randers-Pehrson 已提交
470
}
471
#endif /* PNG_READ_TRANSFORMS_SUPPORTED */
G
[devel]  
Glenn Randers-Pehrson 已提交
472

473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
/* Copy a single pixel, of a given size, from one buffer to another -
 * while this is basically bit addressed there is an implicit assumption
 * that pixels 8 or more bits in size are byte aligned and that pixels
 * do not otherwise cross byte boundaries.  (This is, so far as I know,
 * universally true in bitmap computer graphics.  [JCB 20101212])
 *
 * NOTE: The to and from buffers may be the same.
 */
static void
pixel_copy(png_bytep toBuffer, png_uint_32 toIndex,
   png_const_bytep fromBuffer, png_uint_32 fromIndex, unsigned int pixelSize)
{
   /* Assume we can multiply by 'size' without overflow because we are
    * just working in a single buffer.
    */
   toIndex *= pixelSize;
   fromIndex *= pixelSize;
   if (pixelSize < 8) /* Sub-byte */
   {
      /* Mask to select the location of the copied pixel: */
      unsigned int destMask = ((1U<<pixelSize)-1) << (8-pixelSize-(toIndex&7));
      /* The following read the entire pixels and clears the extra: */
      unsigned int destByte = toBuffer[toIndex >> 3] & ~destMask;
      unsigned int sourceByte = fromBuffer[fromIndex >> 3];

      /* Don't rely on << or >> supporting '0' here, just in case: */
      fromIndex &= 7;
      if (fromIndex > 0) sourceByte <<= fromIndex;
      if ((toIndex & 7) > 0) sourceByte >>= toIndex & 7;

      toBuffer[toIndex >> 3] = (png_byte)(destByte | (sourceByte & destMask));
   }
   else /* One or more bytes */
      memmove(toBuffer+(toIndex>>3), fromBuffer+(fromIndex>>3), pixelSize>>3);
}

509
#ifdef PNG_READ_SUPPORTED
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
/* Copy a complete row of pixels, taking into account potential partial
 * bytes at the end.
 */
static void
row_copy(png_bytep toBuffer, png_const_bytep fromBuffer, unsigned int bitWidth)
{
   memcpy(toBuffer, fromBuffer, bitWidth >> 3);

   if ((bitWidth & 7) != 0)
   {
      unsigned int mask;

      toBuffer += bitWidth >> 3;
      fromBuffer += bitWidth >> 3;
      /* The remaining bits are in the top of the byte, the mask is the bits to
       * retain.
       */
      mask = 0xff >> (bitWidth & 7);
      *toBuffer = (png_byte)((*toBuffer & mask) | (*fromBuffer & ~mask));
   }
}

532 533 534 535 536 537
/* Compare pixels - they are assumed to start at the first byte in the
 * given buffers.
 */
static int
pixel_cmp(png_const_bytep pa, png_const_bytep pb, png_uint_32 bit_width)
{
538
#if PNG_LIBPNG_VER < 10506
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
   if (memcmp(pa, pb, bit_width>>3) == 0)
   {
      png_uint_32 p;

      if ((bit_width & 7) == 0) return 0;

      /* Ok, any differences? */
      p = pa[bit_width >> 3];
      p ^= pb[bit_width >> 3];

      if (p == 0) return 0;

      /* There are, but they may not be significant, remove the bits
       * after the end (the low order bits in PNG.)
       */
      bit_width &= 7;
      p >>= 8-bit_width;

      if (p == 0) return 0;
   }
559 560 561 562 563 564 565
#else
   /* From libpng-1.5.6 the overwrite should be fixed, so compare the trailing
    * bits too:
    */
   if (memcmp(pa, pb, (bit_width+7)>>3) == 0)
      return 0;
#endif
566

567 568 569 570 571 572 573
   /* Return the index of the changed byte. */
   {
      png_uint_32 where = 0;

      while (pa[where] == pb[where]) ++where;
      return 1+where;
   }
574
}
575
#endif /* PNG_READ_SUPPORTED */
576

G
[devel]  
Glenn Randers-Pehrson 已提交
577
/*************************** BASIC PNG FILE WRITING ***************************/
578
/* A png_store takes data from the sequential writer or provides data
G
[devel]  
Glenn Randers-Pehrson 已提交
579 580 581
 * to the sequential reader.  It can also store the result of a PNG
 * write for later retrieval.
 */
582 583
#define STORE_BUFFER_SIZE 500 /* arbitrary */
typedef struct png_store_buffer
G
[devel]  
Glenn Randers-Pehrson 已提交
584
{
585 586 587
   struct png_store_buffer*  prev;    /* NOTE: stored in reverse order */
   png_byte                  buffer[STORE_BUFFER_SIZE];
} png_store_buffer;
G
[devel]  
Glenn Randers-Pehrson 已提交
588

589 590
#define FILE_NAME_SIZE 64

591 592 593 594 595 596 597 598
typedef struct store_palette_entry /* record of a single palette entry */
{
   png_byte red;
   png_byte green;
   png_byte blue;
   png_byte alpha;
} store_palette_entry, store_palette[256];

599
typedef struct png_store_file
G
[devel]  
Glenn Randers-Pehrson 已提交
600
{
601
   struct png_store_file*  next;      /* as many as you like... */
602
   char                    name[FILE_NAME_SIZE];
603
   png_uint_32             id;        /* must be correct (see FILEID) */
G
[devel]  
Glenn Randers-Pehrson 已提交
604
   png_size_t              datacount; /* In this (the last) buffer */
605
   png_store_buffer        data;      /* Last buffer in file */
606 607
   int                     npalette;  /* Number of entries in palette */
   store_palette_entry*    palette;   /* May be NULL */
608
} png_store_file;
G
[devel]  
Glenn Randers-Pehrson 已提交
609

610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
/* The following is a pool of memory allocated by a single libpng read or write
 * operation.
 */
typedef struct store_pool
{
   struct png_store    *store;   /* Back pointer */
   struct store_memory *list;    /* List of allocated memory */
   png_byte             mark[4]; /* Before and after data */

   /* Statistics for this run. */
   png_alloc_size_t     max;     /* Maximum single allocation */
   png_alloc_size_t     current; /* Current allocation */
   png_alloc_size_t     limit;   /* Highest current allocation */
   png_alloc_size_t     total;   /* Total allocation */

   /* Overall statistics (retained across successive runs). */
   png_alloc_size_t     max_max;
   png_alloc_size_t     max_limit;
   png_alloc_size_t     max_total;
} store_pool;

631
typedef struct png_store
G
[devel]  
Glenn Randers-Pehrson 已提交
632
{
633 634 635 636 637 638 639
   /* For cexcept.h exception handling - simply store one of these;
    * the context is a self pointer but it may point to a different
    * png_store (in fact it never does in this program.)
    */
   struct exception_context
                      exception_context;

640 641
   unsigned int       verbose :1;
   unsigned int       treat_warnings_as_errors :1;
642 643 644
   unsigned int       expect_error :1;
   unsigned int       expect_warning :1;
   unsigned int       saw_warning :1;
645
   unsigned int       speed :1;
646 647
   unsigned int       progressive :1; /* use progressive read */
   unsigned int       validated :1;   /* used as a temporary flag */
G
[devel]  
Glenn Randers-Pehrson 已提交
648 649
   int                nerrors;
   int                nwarnings;
650 651 652 653 654 655
   int                noptions;       /* number of options below: */
   struct {
      unsigned char   option;         /* option number, 0..30 */
      unsigned char   setting;        /* setting (unset,invalid,on,off) */
   }                  options[16];
   char               test[128];      /* Name of test */
656
   char               error[256];
657

G
[devel]  
Glenn Randers-Pehrson 已提交
658 659 660
   /* Read fields */
   png_structp        pread;    /* Used to read a saved file */
   png_infop          piread;
661 662
   png_store_file*    current;  /* Set when reading */
   png_store_buffer*  next;     /* Set when reading */
G
[devel]  
Glenn Randers-Pehrson 已提交
663
   png_size_t         readpos;  /* Position in *next */
664
   png_byte*          image;    /* Buffer for reading interlaced images */
665 666 667
   png_size_t         cb_image; /* Size of this buffer */
   png_size_t         cb_row;   /* Row size of the image(s) */
   png_uint_32        image_h;  /* Number of rows in a single image */
668
   store_pool         read_memory_pool;
669

G
[devel]  
Glenn Randers-Pehrson 已提交
670
   /* Write fields */
671
   png_store_file*    saved;
G
[devel]  
Glenn Randers-Pehrson 已提交
672 673 674
   png_structp        pwrite;   /* Used when writing a new file */
   png_infop          piwrite;
   png_size_t         writepos; /* Position in .new */
675
   char               wname[FILE_NAME_SIZE];
676
   png_store_buffer   new;      /* The end of the new PNG file being written. */
677
   store_pool         write_memory_pool;
678 679
   store_palette_entry* palette;
   int                  npalette;
680
} png_store;
G
[devel]  
Glenn Randers-Pehrson 已提交
681 682

/* Initialization and cleanup */
683
static void
684
store_pool_mark(png_bytep mark)
685
{
686
   static png_uint_32 store_seed[2] = { 0x12345678, 1};
687

688
   make_four_random_bytes(store_seed, mark);
689 690
}

691
#ifdef PNG_READ_SUPPORTED
692
/* Use this for random 32 bit values; this function makes sure the result is
693 694 695 696 697 698
 * non-zero.
 */
static png_uint_32
random_32(void)
{

699
   for (;;)
700 701 702 703 704 705 706 707 708 709 710
   {
      png_byte mark[4];
      png_uint_32 result;

      store_pool_mark(mark);
      result = png_get_uint_32(mark);

      if (result != 0)
         return result;
   }
}
711
#endif /* PNG_READ_SUPPORTED */
712

713 714 715 716 717 718 719 720 721 722 723 724
static void
store_pool_init(png_store *ps, store_pool *pool)
{
   memset(pool, 0, sizeof *pool);

   pool->store = ps;
   pool->list = NULL;
   pool->max = pool->current = pool->limit = pool->total = 0;
   pool->max_max = pool->max_limit = pool->max_total = 0;
   store_pool_mark(pool->mark);
}

G
[devel]  
Glenn Randers-Pehrson 已提交
725
static void
726
store_init(png_store* ps)
G
[devel]  
Glenn Randers-Pehrson 已提交
727 728
{
   memset(ps, 0, sizeof *ps);
729 730 731
   init_exception_context(&ps->exception_context);
   store_pool_init(ps, &ps->read_memory_pool);
   store_pool_init(ps, &ps->write_memory_pool);
G
[devel]  
Glenn Randers-Pehrson 已提交
732 733
   ps->verbose = 0;
   ps->treat_warnings_as_errors = 0;
734 735 736
   ps->expect_error = 0;
   ps->expect_warning = 0;
   ps->saw_warning = 0;
737
   ps->speed = 0;
738
   ps->progressive = 0;
739
   ps->validated = 0;
740
   ps->nerrors = ps->nwarnings = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
741 742 743 744 745
   ps->pread = NULL;
   ps->piread = NULL;
   ps->saved = ps->current = NULL;
   ps->next = NULL;
   ps->readpos = 0;
746 747
   ps->image = NULL;
   ps->cb_image = 0;
748 749
   ps->cb_row = 0;
   ps->image_h = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
750 751 752 753
   ps->pwrite = NULL;
   ps->piwrite = NULL;
   ps->writepos = 0;
   ps->new.prev = NULL;
754 755
   ps->palette = NULL;
   ps->npalette = 0;
756
   ps->noptions = 0;
757 758
}

G
[devel]  
Glenn Randers-Pehrson 已提交
759
static void
760
store_freebuffer(png_store_buffer* psb)
G
[devel]  
Glenn Randers-Pehrson 已提交
761 762 763
{
   if (psb->prev)
   {
764
      store_freebuffer(psb->prev);
G
[devel]  
Glenn Randers-Pehrson 已提交
765 766 767 768 769 770
      free(psb->prev);
      psb->prev = NULL;
   }
}

static void
771
store_freenew(png_store *ps)
G
[devel]  
Glenn Randers-Pehrson 已提交
772
{
773
   store_freebuffer(&ps->new);
G
[devel]  
Glenn Randers-Pehrson 已提交
774
   ps->writepos = 0;
775 776 777 778 779 780
   if (ps->palette != NULL)
   {
      free(ps->palette);
      ps->palette = NULL;
      ps->npalette = 0;
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
781 782 783
}

static void
784
store_storenew(png_store *ps)
G
[devel]  
Glenn Randers-Pehrson 已提交
785
{
786
   png_store_buffer *pb;
787

788
   if (ps->writepos != STORE_BUFFER_SIZE)
G
[devel]  
Glenn Randers-Pehrson 已提交
789
      png_error(ps->pwrite, "invalid store call");
790

791
   pb = voidcast(png_store_buffer*, malloc(sizeof *pb));
792

G
[devel]  
Glenn Randers-Pehrson 已提交
793 794
   if (pb == NULL)
      png_error(ps->pwrite, "store new: OOM");
795

G
[devel]  
Glenn Randers-Pehrson 已提交
796 797 798 799 800 801
   *pb = ps->new;
   ps->new.prev = pb;
   ps->writepos = 0;
}

static void
802
store_freefile(png_store_file **ppf)
G
[devel]  
Glenn Randers-Pehrson 已提交
803
{
804 805 806
   if (*ppf != NULL)
   {
      store_freefile(&(*ppf)->next);
807

808 809
      store_freebuffer(&(*ppf)->data);
      (*ppf)->datacount = 0;
810 811 812 813 814 815
      if ((*ppf)->palette != NULL)
      {
         free((*ppf)->palette);
         (*ppf)->palette = NULL;
         (*ppf)->npalette = 0;
      }
816 817 818
      free(*ppf);
      *ppf = NULL;
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
819 820 821
}

/* Main interface to file storeage, after writing a new PNG file (see the API
822
 * below) call store_storefile to store the result with the given name and id.
G
[devel]  
Glenn Randers-Pehrson 已提交
823 824
 */
static void
825
store_storefile(png_store *ps, png_uint_32 id)
G
[devel]  
Glenn Randers-Pehrson 已提交
826
{
827
   png_store_file *pf = voidcast(png_store_file*, malloc(sizeof *pf));
G
[devel]  
Glenn Randers-Pehrson 已提交
828 829 830 831 832 833 834 835
   if (pf == NULL)
      png_error(ps->pwrite, "storefile: OOM");
   safecat(pf->name, sizeof pf->name, 0, ps->wname);
   pf->id = id;
   pf->data = ps->new;
   pf->datacount = ps->writepos;
   ps->new.prev = NULL;
   ps->writepos = 0;
836 837 838 839
   pf->palette = ps->palette;
   pf->npalette = ps->npalette;
   ps->palette = 0;
   ps->npalette = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
840 841 842 843 844 845 846 847

   /* And save it. */
   pf->next = ps->saved;
   ps->saved = pf;
}

/* Generate an error message (in the given buffer) */
static size_t
848
store_message(png_store *ps, png_const_structp pp, char *buffer, size_t bufsize,
849
   size_t pos, PNG_CONST char *msg)
G
[devel]  
Glenn Randers-Pehrson 已提交
850
{
851
   if (pp != NULL && pp == ps->pread)
G
[devel]  
Glenn Randers-Pehrson 已提交
852 853 854
   {
      /* Reading a file */
      pos = safecat(buffer, bufsize, pos, "read: ");
855

G
[devel]  
Glenn Randers-Pehrson 已提交
856 857 858
      if (ps->current != NULL)
      {
         pos = safecat(buffer, bufsize, pos, ps->current->name);
859
         pos = safecat(buffer, bufsize, pos, sep);
G
[devel]  
Glenn Randers-Pehrson 已提交
860 861
      }
   }
862

863
   else if (pp != NULL && pp == ps->pwrite)
G
[devel]  
Glenn Randers-Pehrson 已提交
864 865 866 867
   {
      /* Writing a file */
      pos = safecat(buffer, bufsize, pos, "write: ");
      pos = safecat(buffer, bufsize, pos, ps->wname);
868
      pos = safecat(buffer, bufsize, pos, sep);
G
[devel]  
Glenn Randers-Pehrson 已提交
869
   }
870

G
[devel]  
Glenn Randers-Pehrson 已提交
871 872
   else
   {
873
      /* Neither reading nor writing (or a memory error in struct delete) */
G
[devel]  
Glenn Randers-Pehrson 已提交
874 875 876
      pos = safecat(buffer, bufsize, pos, "pngvalid: ");
   }

877 878 879 880 881
   if (ps->test[0] != 0)
   {
      pos = safecat(buffer, bufsize, pos, ps->test);
      pos = safecat(buffer, bufsize, pos, sep);
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
882 883 884 885
   pos = safecat(buffer, bufsize, pos, msg);
   return pos;
}

886 887
/* Verbose output to the error stream: */
static void
888
store_verbose(png_store *ps, png_const_structp pp, png_const_charp prefix,
889 890 891 892 893 894 895 896 897 898 899 900
   png_const_charp message)
{
   char buffer[512];

   if (prefix)
      fputs(prefix, stderr);

   (void)store_message(ps, pp, buffer, sizeof buffer, 0, message);
   fputs(buffer, stderr);
   fputc('\n', stderr);
}

901
/* Log an error or warning - the relevant count is always incremented. */
G
[devel]  
Glenn Randers-Pehrson 已提交
902
static void
903 904
store_log(png_store* ps, png_const_structp pp, png_const_charp message,
   int is_error)
G
[devel]  
Glenn Randers-Pehrson 已提交
905
{
906 907 908 909 910 911 912
   /* The warning is copied to the error buffer if there are no errors and it is
    * the first warning.  The error is copied to the error buffer if it is the
    * first error (overwriting any prior warnings).
    */
   if (is_error ? (ps->nerrors)++ == 0 :
       (ps->nwarnings)++ == 0 && ps->nerrors == 0)
      store_message(ps, pp, ps->error, sizeof ps->error, 0, message);
G
[devel]  
Glenn Randers-Pehrson 已提交
913

914
   if (ps->verbose)
915
      store_verbose(ps, pp, is_error ? "error: " : "warning: ", message);
916
}
G
[devel]  
Glenn Randers-Pehrson 已提交
917

918
#ifdef PNG_READ_SUPPORTED
919 920 921 922 923 924 925 926 927 928 929 930
/* Internal error function, called with a png_store but no libpng stuff. */
static void
internal_error(png_store *ps, png_const_charp message)
{
   store_log(ps, NULL, message, 1 /* error */);

   /* And finally throw an exception. */
   {
      struct exception_context *the_exception_context = &ps->exception_context;
      Throw ps;
   }
}
931
#endif /* PNG_READ_SUPPORTED */
932

933
/* Functions to use as PNG callbacks. */
934
static void PNGCBAPI
935
store_error(png_structp ppIn, png_const_charp message) /* PNG_NORETURN */
936
{
937
   png_const_structp pp = ppIn;
938
   png_store *ps = voidcast(png_store*, png_get_error_ptr(pp));
G
[devel]  
Glenn Randers-Pehrson 已提交
939

940
   if (!ps->expect_error)
941
      store_log(ps, pp, message, 1 /* error */);
942 943 944 945 946 947

   /* And finally throw an exception. */
   {
      struct exception_context *the_exception_context = &ps->exception_context;
      Throw ps;
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
948 949
}

950
static void PNGCBAPI
951
store_warning(png_structp ppIn, png_const_charp message)
G
[devel]  
Glenn Randers-Pehrson 已提交
952
{
953
   png_const_structp pp = ppIn;
954
   png_store *ps = voidcast(png_store*, png_get_error_ptr(pp));
G
[devel]  
Glenn Randers-Pehrson 已提交
955

956
   if (!ps->expect_warning)
957
      store_log(ps, pp, message, 0 /* warning */);
958 959
   else
      ps->saw_warning = 1;
G
[devel]  
Glenn Randers-Pehrson 已提交
960 961
}

962 963 964 965 966
/* These somewhat odd functions are used when reading an image to ensure that
 * the buffer is big enough, the png_structp is for errors.
 */
/* Return a single row from the correct image. */
static png_bytep
967
store_image_row(PNG_CONST png_store* ps, png_const_structp pp, int nImage,
968 969 970 971 972 973 974 975 976 977 978 979 980 981
   png_uint_32 y)
{
   png_size_t coffset = (nImage * ps->image_h + y) * (ps->cb_row + 5) + 2;

   if (ps->image == NULL)
      png_error(pp, "no allocated image");

   if (coffset + ps->cb_row + 3 > ps->cb_image)
      png_error(pp, "image too small");

   return ps->image + coffset;
}

static void
982
store_image_free(png_store *ps, png_const_structp pp)
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
{
   if (ps->image != NULL)
   {
      png_bytep image = ps->image;

      if (image[-1] != 0xed || image[ps->cb_image] != 0xfe)
      {
         if (pp != NULL)
            png_error(pp, "png_store image overwrite (1)");
         else
            store_log(ps, NULL, "png_store image overwrite (2)", 1);
      }

      ps->image = NULL;
      ps->cb_image = 0;
      --image;
      free(image);
   }
}

static void
1004 1005
store_ensure_image(png_store *ps, png_const_structp pp, int nImages,
   png_size_t cbRow, png_uint_32 cRows)
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
{
   png_size_t cb = nImages * cRows * (cbRow + 5);

   if (ps->cb_image < cb)
   {
      png_bytep image;

      store_image_free(ps, pp);

      /* The buffer is deliberately mis-aligned. */
1016
      image = voidcast(png_bytep, malloc(cb+2));
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
      if (image == NULL)
      {
         /* Called from the startup - ignore the error for the moment. */
         if (pp == NULL)
            return;

         png_error(pp, "OOM allocating image buffer");
      }

      /* These magic tags are used to detect overwrites above. */
      ++image;
      image[-1] = 0xed;
      image[cb] = 0xfe;

      ps->image = image;
      ps->cb_image = cb;
   }

1035
   /* We have an adequate sized image; lay out the rows.  There are 2 bytes at
1036 1037
    * the start and three at the end of each (this ensures that the row
    * alignment starts out odd - 2+1 and changes for larger images on each row.)
1038 1039 1040 1041
    */
   ps->cb_row = cbRow;
   ps->image_h = cRows;

1042 1043 1044 1045 1046
   /* For error checking, the whole buffer is set to 10110010 (0xb2 - 178).
    * This deliberately doesn't match the bits in the size test image which are
    * outside the image; these are set to 0xff (all 1).  To make the row
    * comparison work in the 'size' test case the size rows are pre-initialized
    * to the same value prior to calling 'standard_row'.
1047
    */
1048
   memset(ps->image, 178, cb);
1049

1050
   /* Then put in the marks. */
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
   while (--nImages >= 0)
   {
      png_uint_32 y;

      for (y=0; y<cRows; ++y)
      {
         png_bytep row = store_image_row(ps, pp, nImages, y);

         /* The markers: */
         row[-2] = 190;
         row[-1] = 239;
         row[cbRow] = 222;
         row[cbRow+1] = 173;
         row[cbRow+2] = 17;
      }
   }
}

1069
#ifdef PNG_READ_SUPPORTED
1070
static void
1071
store_image_check(PNG_CONST png_store* ps, png_const_structp pp, int iImage)
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
{
   png_const_bytep image = ps->image;

   if (image[-1] != 0xed || image[ps->cb_image] != 0xfe)
      png_error(pp, "image overwrite");
   else
   {
      png_size_t cbRow = ps->cb_row;
      png_uint_32 rows = ps->image_h;

      image += iImage * (cbRow+5) * ps->image_h;

      image += 2; /* skip image first row markers */

      while (rows-- > 0)
      {
         if (image[-2] != 190 || image[-1] != 239)
            png_error(pp, "row start overwritten");

         if (image[cbRow] != 222 || image[cbRow+1] != 173 ||
            image[cbRow+2] != 17)
            png_error(pp, "row end overwritten");

         image += cbRow+5;
      }
   }
}
1099
#endif /* PNG_READ_SUPPORTED */
1100

1101
static void PNGCBAPI
1102
store_write(png_structp ppIn, png_bytep pb, png_size_t st)
G
[devel]  
Glenn Randers-Pehrson 已提交
1103
{
1104
   png_const_structp pp = ppIn;
1105
   png_store *ps = voidcast(png_store*, png_get_io_ptr(pp));
1106

G
[devel]  
Glenn Randers-Pehrson 已提交
1107
   if (ps->pwrite != pp)
1108
      png_error(pp, "store state damaged");
1109

G
[devel]  
Glenn Randers-Pehrson 已提交
1110 1111 1112 1113
   while (st > 0)
   {
      size_t cb;

1114 1115
      if (ps->writepos >= STORE_BUFFER_SIZE)
         store_storenew(ps);
G
[devel]  
Glenn Randers-Pehrson 已提交
1116 1117

      cb = st;
1118

1119 1120
      if (cb > STORE_BUFFER_SIZE - ps->writepos)
         cb = STORE_BUFFER_SIZE - ps->writepos;
1121

G
[devel]  
Glenn Randers-Pehrson 已提交
1122 1123 1124 1125 1126 1127 1128
      memcpy(ps->new.buffer + ps->writepos, pb, cb);
      pb += cb;
      st -= cb;
      ps->writepos += cb;
   }
}

1129
static void PNGCBAPI
1130
store_flush(png_structp ppIn)
G
[devel]  
Glenn Randers-Pehrson 已提交
1131
{
1132
   UNUSED(ppIn) /*DOES NOTHING*/
G
[devel]  
Glenn Randers-Pehrson 已提交
1133 1134
}

1135
#ifdef PNG_READ_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1136
static size_t
1137
store_read_buffer_size(png_store *ps)
G
[devel]  
Glenn Randers-Pehrson 已提交
1138 1139 1140
{
   /* Return the bytes available for read in the current buffer. */
   if (ps->next != &ps->current->data)
1141
      return STORE_BUFFER_SIZE;
G
[devel]  
Glenn Randers-Pehrson 已提交
1142 1143 1144 1145

   return ps->current->datacount;
}

1146
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
/* Return total bytes available for read. */
static size_t
store_read_buffer_avail(png_store *ps)
{
   if (ps->current != NULL && ps->next != NULL)
   {
      png_store_buffer *next = &ps->current->data;
      size_t cbAvail = ps->current->datacount;

      while (next != ps->next && next != NULL)
      {
         next = next->prev;
         cbAvail += STORE_BUFFER_SIZE;
      }

      if (next != ps->next)
         png_error(ps->pread, "buffer read error");

      if (cbAvail > ps->readpos)
         return cbAvail - ps->readpos;
   }

   return 0;
}
1171
#endif
1172

G
[devel]  
Glenn Randers-Pehrson 已提交
1173
static int
1174
store_read_buffer_next(png_store *ps)
G
[devel]  
Glenn Randers-Pehrson 已提交
1175
{
1176 1177
   png_store_buffer *pbOld = ps->next;
   png_store_buffer *pbNew = &ps->current->data;
G
[devel]  
Glenn Randers-Pehrson 已提交
1178 1179 1180 1181
   if (pbOld != pbNew)
   {
      while (pbNew != NULL && pbNew->prev != pbOld)
         pbNew = pbNew->prev;
1182

G
[devel]  
Glenn Randers-Pehrson 已提交
1183 1184 1185
      if (pbNew != NULL)
      {
         ps->next = pbNew;
1186 1187
         ps->readpos = 0;
         return 1;
G
[devel]  
Glenn Randers-Pehrson 已提交
1188 1189 1190 1191 1192 1193 1194 1195
      }

      png_error(ps->pread, "buffer lost");
   }

   return 0; /* EOF or error */
}

1196 1197 1198
/* Need separate implementation and callback to allow use of the same code
 * during progressive read, where the io_ptr is set internally by libpng.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1199
static void
1200
store_read_imp(png_store *ps, png_bytep pb, png_size_t st)
G
[devel]  
Glenn Randers-Pehrson 已提交
1201
{
1202 1203
   if (ps->current == NULL || ps->next == NULL)
      png_error(ps->pread, "store state damaged");
1204

G
[devel]  
Glenn Randers-Pehrson 已提交
1205 1206
   while (st > 0)
   {
1207
      size_t cbAvail = store_read_buffer_size(ps) - ps->readpos;
G
[devel]  
Glenn Randers-Pehrson 已提交
1208 1209 1210 1211

      if (cbAvail > 0)
      {
         if (cbAvail > st) cbAvail = st;
1212 1213 1214 1215
         memcpy(pb, ps->next->buffer + ps->readpos, cbAvail);
         st -= cbAvail;
         pb += cbAvail;
         ps->readpos += cbAvail;
G
[devel]  
Glenn Randers-Pehrson 已提交
1216
      }
1217

1218
      else if (!store_read_buffer_next(ps))
1219
         png_error(ps->pread, "read beyond end of file");
G
[devel]  
Glenn Randers-Pehrson 已提交
1220 1221 1222
   }
}

1223
static void PNGCBAPI
1224
store_read(png_structp ppIn, png_bytep pb, png_size_t st)
1225
{
1226
   png_const_structp pp = ppIn;
1227
   png_store *ps = voidcast(png_store*, png_get_io_ptr(pp));
1228

1229 1230 1231 1232 1233 1234 1235 1236 1237
   if (ps == NULL || ps->pread != pp)
      png_error(pp, "bad store read call");

   store_read_imp(ps, pb, st);
}

static void
store_progressive_read(png_store *ps, png_structp pp, png_infop pi)
{
1238 1239 1240 1241
   /* Notice that a call to store_read will cause this function to fail because
    * readpos will be set.
    */
   if (ps->pread != pp || ps->current == NULL || ps->next == NULL)
1242
      png_error(pp, "store state damaged (progressive)");
1243 1244 1245 1246 1247 1248 1249 1250 1251 1252

   do
   {
      if (ps->readpos != 0)
         png_error(pp, "store_read called during progressive read");

      png_process_data(pp, pi, ps->next->buffer, store_read_buffer_size(ps));
   }
   while (store_read_buffer_next(ps));
}
1253
#endif /* PNG_READ_SUPPORTED */
1254

1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
/* The caller must fill this in: */
static store_palette_entry *
store_write_palette(png_store *ps, int npalette)
{
   if (ps->pwrite == NULL)
      store_log(ps, NULL, "attempt to write palette without write stream", 1);

   if (ps->palette != NULL)
      png_error(ps->pwrite, "multiple store_write_palette calls");

   /* This function can only return NULL if called with '0'! */
   if (npalette > 0)
   {
1268 1269
      ps->palette = voidcast(store_palette_entry*, malloc(npalette *
         sizeof *ps->palette));
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279

      if (ps->palette == NULL)
         png_error(ps->pwrite, "store new palette: OOM");

      ps->npalette = npalette;
   }

   return ps->palette;
}

1280
#ifdef PNG_READ_SUPPORTED
1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
static store_palette_entry *
store_current_palette(png_store *ps, int *npalette)
{
   /* This is an internal error (the call has been made outside a read
    * operation.)
    */
   if (ps->current == NULL)
      store_log(ps, ps->pread, "no current stream for palette", 1);

   /* The result may be null if there is no palette. */
   *npalette = ps->current->npalette;
   return ps->current->palette;
}
1294
#endif /* PNG_READ_SUPPORTED */
1295

1296
/***************************** MEMORY MANAGEMENT*** ***************************/
1297
#ifdef PNG_USER_MEM_SUPPORTED
1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
/* A store_memory is simply the header for an allocated block of memory.  The
 * pointer returned to libpng is just after the end of the header block, the
 * allocated memory is followed by a second copy of the 'mark'.
 */
typedef struct store_memory
{
   store_pool          *pool;    /* Originating pool */
   struct store_memory *next;    /* Singly linked list */
   png_alloc_size_t     size;    /* Size of memory allocated */
   png_byte             mark[4]; /* ID marker */
} store_memory;

/* Handle a fatal error in memory allocation.  This calls png_error if the
 * libpng struct is non-NULL, else it outputs a message and returns.  This means
 * that a memory problem while libpng is running will abort (png_error) the
 * handling of particular file while one in cleanup (after the destroy of the
 * struct has returned) will simply keep going and free (or attempt to free)
 * all the memory.
 */
static void
1318
store_pool_error(png_store *ps, png_const_structp pp, PNG_CONST char *msg)
1319 1320 1321 1322
{
   if (pp != NULL)
      png_error(pp, msg);

1323 1324 1325 1326
   /* Else we have to do it ourselves.  png_error eventually calls store_log,
    * above.  store_log accepts a NULL png_structp - it just changes what gets
    * output by store_message.
    */
1327
   store_log(ps, pp, msg, 1 /* error */);
1328 1329 1330
}

static void
1331
store_memory_free(png_const_structp pp, store_pool *pool, store_memory *memory)
1332 1333 1334 1335 1336 1337
{
   /* Note that pp may be NULL (see store_pool_delete below), the caller has
    * found 'memory' in pool->list *and* unlinked this entry, so this is a valid
    * pointer (for sure), but the contents may have been trashed.
    */
   if (memory->pool != pool)
1338
      store_pool_error(pool->store, pp, "memory corrupted (pool)");
1339 1340

   else if (memcmp(memory->mark, pool->mark, sizeof memory->mark) != 0)
1341
      store_pool_error(pool->store, pp, "memory corrupted (start)");
1342 1343 1344 1345 1346 1347 1348

   /* It should be safe to read the size field now. */
   else
   {
      png_alloc_size_t cb = memory->size;

      if (cb > pool->max)
1349
         store_pool_error(pool->store, pp, "memory corrupted (size)");
1350 1351 1352

      else if (memcmp((png_bytep)(memory+1)+cb, pool->mark, sizeof pool->mark)
         != 0)
1353
         store_pool_error(pool->store, pp, "memory corrupted (end)");
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380

      /* Finally give the library a chance to find problems too: */
      else
         {
         pool->current -= cb;
         free(memory);
         }
   }
}

static void
store_pool_delete(png_store *ps, store_pool *pool)
{
   if (pool->list != NULL)
   {
      fprintf(stderr, "%s: %s %s: memory lost (list follows):\n", ps->test,
         pool == &ps->read_memory_pool ? "read" : "write",
         pool == &ps->read_memory_pool ? (ps->current != NULL ?
            ps->current->name : "unknown file") : ps->wname);
      ++ps->nerrors;

      do
      {
         store_memory *next = pool->list;
         pool->list = next->next;
         next->next = NULL;

1381
         fprintf(stderr, "\t%lu bytes @ %p\n",
1382
             (unsigned long)next->size, (PNG_CONST void*)(next+1));
1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
         /* The NULL means this will always return, even if the memory is
          * corrupted.
          */
         store_memory_free(NULL, pool, next);
      }
      while (pool->list != NULL);
   }

   /* And reset the other fields too for the next time. */
   if (pool->max > pool->max_max) pool->max_max = pool->max;
   pool->max = 0;
   if (pool->current != 0) /* unexpected internal error */
      fprintf(stderr, "%s: %s %s: memory counter mismatch (internal error)\n",
         ps->test, pool == &ps->read_memory_pool ? "read" : "write",
         pool == &ps->read_memory_pool ? (ps->current != NULL ?
            ps->current->name : "unknown file") : ps->wname);
   pool->current = 0;
1400 1401 1402 1403

   if (pool->limit > pool->max_limit)
      pool->max_limit = pool->limit;

1404
   pool->limit = 0;
1405 1406 1407 1408

   if (pool->total > pool->max_total)
      pool->max_total = pool->total;

1409 1410 1411 1412 1413 1414 1415
   pool->total = 0;

   /* Get a new mark too. */
   store_pool_mark(pool->mark);
}

/* The memory callbacks: */
1416
static png_voidp PNGCBAPI
1417
store_malloc(png_structp ppIn, png_alloc_size_t cb)
1418
{
1419
   png_const_structp pp = ppIn;
1420 1421 1422
   store_pool *pool = voidcast(store_pool*, png_get_mem_ptr(pp));
   store_memory *new = voidcast(store_memory*, malloc(cb + (sizeof *new) +
      (sizeof pool->mark)));
1423 1424 1425

   if (new != NULL)
   {
1426 1427 1428
      if (cb > pool->max)
         pool->max = cb;

1429
      pool->current += cb;
1430 1431 1432 1433

      if (pool->current > pool->limit)
         pool->limit = pool->current;

1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
      pool->total += cb;

      new->size = cb;
      memcpy(new->mark, pool->mark, sizeof new->mark);
      memcpy((png_byte*)(new+1) + cb, pool->mark, sizeof pool->mark);
      new->pool = pool;
      new->next = pool->list;
      pool->list = new;
      ++new;
   }
1444

1445
   else
1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
   {
      /* NOTE: the PNG user malloc function cannot use the png_ptr it is passed
       * other than to retrieve the allocation pointer!  libpng calls the
       * store_malloc callback in two basic cases:
       *
       * 1) From png_malloc; png_malloc will do a png_error itself if NULL is
       *    returned.
       * 2) From png_struct or png_info structure creation; png_malloc is
       *    to return so cleanup can be performed.
       *
       * To handle this store_malloc can log a message, but can't do anything
       * else.
       */
      store_log(pool->store, pp, "out of memory", 1 /* is_error */);
   }
1461 1462 1463 1464

   return new;
}

1465
static void PNGCBAPI
1466
store_free(png_structp ppIn, png_voidp memory)
1467
{
1468
   png_const_structp pp = ppIn;
1469 1470
   store_pool *pool = voidcast(store_pool*, png_get_mem_ptr(pp));
   store_memory *this = voidcast(store_memory*, memory), **test;
1471

1472 1473 1474 1475 1476 1477 1478 1479
   /* Because libpng calls store_free with a dummy png_struct when deleting
    * png_struct or png_info via png_destroy_struct_2 it is necessary to check
    * the passed in png_structp to ensure it is valid, and not pass it to
    * png_error if it is not.
    */
   if (pp != pool->store->pread && pp != pool->store->pwrite)
      pp = NULL;

1480
   /* First check that this 'memory' really is valid memory - it must be in the
1481
    * pool list.  If it is, use the shared memory_free function to free it.
1482 1483 1484 1485 1486 1487
    */
   --this;
   for (test = &pool->list; *test != this; test = &(*test)->next)
   {
      if (*test == NULL)
      {
1488
         store_pool_error(pool->store, pp, "bad pointer to free");
1489 1490 1491 1492 1493 1494 1495 1496 1497
         return;
      }
   }

   /* Unlink this entry, *test == this. */
   *test = this->next;
   this->next = NULL;
   store_memory_free(pp, pool, this);
}
1498
#endif /* PNG_USER_MEM_SUPPORTED */
1499

G
[devel]  
Glenn Randers-Pehrson 已提交
1500 1501 1502
/* Setup functions. */
/* Cleanup when aborting a write or after storing the new file. */
static void
1503
store_write_reset(png_store *ps)
G
[devel]  
Glenn Randers-Pehrson 已提交
1504 1505 1506
{
   if (ps->pwrite != NULL)
   {
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516
      anon_context(ps);

      Try
         png_destroy_write_struct(&ps->pwrite, &ps->piwrite);

      Catch_anonymous
      {
         /* memory corruption: continue. */
      }

G
[devel]  
Glenn Randers-Pehrson 已提交
1517 1518 1519
      ps->pwrite = NULL;
      ps->piwrite = NULL;
   }
1520 1521 1522 1523

   /* And make sure that all the memory has been freed - this will output
    * spurious errors in the case of memory corruption above, but this is safe.
    */
1524 1525 1526
#  ifdef PNG_USER_MEM_SUPPORTED
      store_pool_delete(ps, &ps->write_memory_pool);
#  endif
1527

1528
   store_freenew(ps);
G
[devel]  
Glenn Randers-Pehrson 已提交
1529 1530 1531
}

/* The following is the main write function, it returns a png_struct and,
1532
 * optionally, a png_info suitable for writiing a new PNG file.  Use
1533 1534
 * store_storefile above to record this file after it has been written.  The
 * returned libpng structures as destroyed by store_write_reset above.
G
[devel]  
Glenn Randers-Pehrson 已提交
1535 1536
 */
static png_structp
1537 1538
set_store_for_write(png_store *ps, png_infopp ppi,
   PNG_CONST char * volatile name)
G
[devel]  
Glenn Randers-Pehrson 已提交
1539
{
1540
   anon_context(ps);
G
[devel]  
Glenn Randers-Pehrson 已提交
1541

1542 1543 1544
   Try
   {
      if (ps->pwrite != NULL)
1545
         png_error(ps->pwrite, "write store already in use");
1546 1547 1548

      store_write_reset(ps);
      safecat(ps->wname, sizeof ps->wname, 0, name);
G
[devel]  
Glenn Randers-Pehrson 已提交
1549

1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
      /* Don't do the slow memory checks if doing a speed test, also if user
       * memory is not supported we can't do it anyway.
       */
#     ifdef PNG_USER_MEM_SUPPORTED
         if (!ps->speed)
            ps->pwrite = png_create_write_struct_2(PNG_LIBPNG_VER_STRING,
               ps, store_error, store_warning, &ps->write_memory_pool,
               store_malloc, store_free);

         else
#     endif
1561 1562
         ps->pwrite = png_create_write_struct(PNG_LIBPNG_VER_STRING,
            ps, store_error, store_warning);
1563

1564
      png_set_write_fn(ps->pwrite, ps, store_write, store_flush);
G
[devel]  
Glenn Randers-Pehrson 已提交
1565

1566 1567 1568 1569 1570 1571 1572 1573 1574 1575
#     ifdef PNG_SET_OPTION_SUPPORTED
         {
            int opt;
            for (opt=0; opt<ps->noptions; ++opt)
               if (png_set_option(ps->pwrite, ps->options[opt].option,
                  ps->options[opt].setting) == PNG_OPTION_INVALID)
                  png_error(ps->pwrite, "png option invalid");
         }
#     endif

1576 1577 1578 1579
      if (ppi != NULL)
         *ppi = ps->piwrite = png_create_info_struct(ps->pwrite);
   }

1580 1581
   Catch_anonymous
      return NULL;
G
[devel]  
Glenn Randers-Pehrson 已提交
1582

1583
   return ps->pwrite;
G
[devel]  
Glenn Randers-Pehrson 已提交
1584 1585
}

1586
/* Cleanup when finished reading (either due to error or in the success case).
1587 1588
 * This routine exists even when there is no read support to make the code
 * tidier (avoid a mass of ifdefs) and so easier to maintain.
G
[devel]  
Glenn Randers-Pehrson 已提交
1589 1590
 */
static void
1591
store_read_reset(png_store *ps)
G
[devel]  
Glenn Randers-Pehrson 已提交
1592
{
1593 1594 1595 1596
#  ifdef PNG_READ_SUPPORTED
      if (ps->pread != NULL)
      {
         anon_context(ps);
1597

1598 1599
         Try
            png_destroy_read_struct(&ps->pread, &ps->piread, NULL);
1600

1601 1602 1603 1604
         Catch_anonymous
         {
            /* error already output: continue */
         }
1605

1606 1607 1608 1609
         ps->pread = NULL;
         ps->piread = NULL;
      }
#  endif
G
[devel]  
Glenn Randers-Pehrson 已提交
1610

1611 1612 1613 1614
#  ifdef PNG_USER_MEM_SUPPORTED
      /* Always do this to be safe. */
      store_pool_delete(ps, &ps->read_memory_pool);
#  endif
1615

G
[devel]  
Glenn Randers-Pehrson 已提交
1616 1617 1618
   ps->current = NULL;
   ps->next = NULL;
   ps->readpos = 0;
1619
   ps->validated = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
1620 1621
}

1622
#ifdef PNG_READ_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1623
static void
1624
store_read_set(png_store *ps, png_uint_32 id)
G
[devel]  
Glenn Randers-Pehrson 已提交
1625
{
1626
   png_store_file *pf = ps->saved;
G
[devel]  
Glenn Randers-Pehrson 已提交
1627 1628 1629 1630 1631 1632

   while (pf != NULL)
   {
      if (pf->id == id)
      {
         ps->current = pf;
1633
         ps->next = NULL;
1634
         store_read_buffer_next(ps);
1635
         return;
G
[devel]  
Glenn Randers-Pehrson 已提交
1636 1637 1638 1639 1640
      }

      pf = pf->next;
   }

1641
   {
1642 1643 1644 1645 1646 1647
      size_t pos;
      char msg[FILE_NAME_SIZE+64];

      pos = standard_name_from_id(msg, sizeof msg, 0, id);
      pos = safecat(msg, sizeof msg, pos, ": file not found");
      png_error(ps->pread, msg);
1648
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
1649 1650 1651 1652 1653
}

/* The main interface for reading a saved file - pass the id number of the file
 * to retrieve.  Ids must be unique or the earlier file will be hidden.  The API
 * returns a png_struct and, optionally, a png_info.  Both of these will be
1654
 * destroyed by store_read_reset above.
G
[devel]  
Glenn Randers-Pehrson 已提交
1655 1656
 */
static png_structp
1657
set_store_for_read(png_store *ps, png_infopp ppi, png_uint_32 id,
1658
   PNG_CONST char *name)
G
[devel]  
Glenn Randers-Pehrson 已提交
1659
{
1660
   /* Set the name for png_error */
G
[devel]  
Glenn Randers-Pehrson 已提交
1661 1662
   safecat(ps->test, sizeof ps->test, 0, name);

1663
   if (ps->pread != NULL)
1664
      png_error(ps->pread, "read store already in use");
G
[devel]  
Glenn Randers-Pehrson 已提交
1665

1666
   store_read_reset(ps);
1667

1668
   /* Both the create APIs can return NULL if used in their default mode
1669 1670 1671 1672
    * (because there is no other way of handling an error because the jmp_buf
    * by default is stored in png_struct and that has not been allocated!)
    * However, given that store_error works correctly in these circumstances
    * we don't ever expect NULL in this program.
1673
    */
1674 1675 1676 1677 1678
#  ifdef PNG_USER_MEM_SUPPORTED
      if (!ps->speed)
         ps->pread = png_create_read_struct_2(PNG_LIBPNG_VER_STRING, ps,
             store_error, store_warning, &ps->read_memory_pool, store_malloc,
             store_free);
1679

1680 1681 1682 1683
      else
#  endif
   ps->pread = png_create_read_struct(PNG_LIBPNG_VER_STRING, ps, store_error,
      store_warning);
G
[devel]  
Glenn Randers-Pehrson 已提交
1684

1685 1686 1687
   if (ps->pread == NULL)
   {
      struct exception_context *the_exception_context = &ps->exception_context;
G
[devel]  
Glenn Randers-Pehrson 已提交
1688

1689
      store_log(ps, NULL, "png_create_read_struct returned NULL (unexpected)",
1690
         1 /*error*/);
G
[devel]  
Glenn Randers-Pehrson 已提交
1691

1692
      Throw ps;
1693
   }
1694

1695 1696 1697 1698 1699 1700 1701 1702 1703 1704
#  ifdef PNG_SET_OPTION_SUPPORTED
      {
         int opt;
         for (opt=0; opt<ps->noptions; ++opt)
            if (png_set_option(ps->pread, ps->options[opt].option,
               ps->options[opt].setting) == PNG_OPTION_INVALID)
                  png_error(ps->pread, "png option invalid");
      }
#  endif

1705
   store_read_set(ps, id);
G
[devel]  
Glenn Randers-Pehrson 已提交
1706

1707 1708 1709 1710
   if (ppi != NULL)
      *ppi = ps->piread = png_create_info_struct(ps->pread);

   return ps->pread;
G
[devel]  
Glenn Randers-Pehrson 已提交
1711
}
1712
#endif /* PNG_READ_SUPPORTED */
G
[devel]  
Glenn Randers-Pehrson 已提交
1713

1714 1715 1716 1717 1718 1719 1720 1721 1722
/* The overall cleanup of a store simply calls the above then removes all the
 * saved files.  This does not delete the store itself.
 */
static void
store_delete(png_store *ps)
{
   store_write_reset(ps);
   store_read_reset(ps);
   store_freefile(&ps->saved);
1723
   store_image_free(ps, NULL);
1724 1725
}

G
[devel]  
Glenn Randers-Pehrson 已提交
1726 1727
/*********************** PNG FILE MODIFICATION ON READ ************************/
/* Files may be modified on read.  The following structure contains a complete
1728
 * png_store together with extra members to handle modification and a special
G
[devel]  
Glenn Randers-Pehrson 已提交
1729 1730 1731
 * read callback for libpng.  To use this the 'modifications' field must be set
 * to a list of png_modification structures that actually perform the
 * modification, otherwise a png_modifier is functionally equivalent to a
1732 1733
 * png_store.  There is a special read function, set_modifier_for_read, which
 * replaces set_store_for_read.
G
[devel]  
Glenn Randers-Pehrson 已提交
1734
 */
1735 1736 1737 1738 1739 1740 1741
typedef enum modifier_state
{
   modifier_start,                        /* Initial value */
   modifier_signature,                    /* Have a signature */
   modifier_IHDR                          /* Have an IHDR */
} modifier_state;

1742 1743 1744 1745 1746 1747 1748 1749 1750 1751
typedef struct CIE_color
{
   /* A single CIE tristimulus value, representing the unique response of a
    * standard observer to a variety of light spectra.  The observer recognizes
    * all spectra that produce this response as the same color, therefore this
    * is effectively a description of a color.
    */
   double X, Y, Z;
} CIE_color;

1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
typedef struct color_encoding
{
   /* A description of an (R,G,B) encoding of color (as defined above); this
    * includes the actual colors of the (R,G,B) triples (1,0,0), (0,1,0) and
    * (0,0,1) plus an encoding value that is used to encode the linear
    * components R, G and B to give the actual values R^gamma, G^gamma and
    * B^gamma that are stored.
    */
   double    gamma;            /* Encoding (file) gamma of space */
   CIE_color red, green, blue; /* End points */
} color_encoding;

1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776
#ifdef PNG_READ_SUPPORTED
static double
chromaticity_x(CIE_color c)
{
   return c.X / (c.X + c.Y + c.Z);
}

static double
chromaticity_y(CIE_color c)
{
   return c.Y / (c.X + c.Y + c.Z);
}

1777 1778 1779 1780
static CIE_color
white_point(PNG_CONST color_encoding *encoding)
{
   CIE_color white;
1781

1782 1783 1784 1785 1786 1787 1788
   white.X = encoding->red.X + encoding->green.X + encoding->blue.X;
   white.Y = encoding->red.Y + encoding->green.Y + encoding->blue.Y;
   white.Z = encoding->red.Z + encoding->green.Z + encoding->blue.Z;

   return white;
}

1789
#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808
static void
normalize_color_encoding(color_encoding *encoding)
{
   PNG_CONST double whiteY = encoding->red.Y + encoding->green.Y +
      encoding->blue.Y;

   if (whiteY != 1)
   {
      encoding->red.X /= whiteY;
      encoding->red.Y /= whiteY;
      encoding->red.Z /= whiteY;
      encoding->green.X /= whiteY;
      encoding->green.Y /= whiteY;
      encoding->green.Z /= whiteY;
      encoding->blue.X /= whiteY;
      encoding->blue.Y /= whiteY;
      encoding->blue.Z /= whiteY;
   }
}
1809
#endif
1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849

static size_t
safecat_color_encoding(char *buffer, size_t bufsize, size_t pos,
   PNG_CONST color_encoding *e, double encoding_gamma)
{
   if (e != 0)
   {
      if (encoding_gamma != 0)
         pos = safecat(buffer, bufsize, pos, "(");
      pos = safecat(buffer, bufsize, pos, "R(");
      pos = safecatd(buffer, bufsize, pos, e->red.X, 4);
      pos = safecat(buffer, bufsize, pos, ",");
      pos = safecatd(buffer, bufsize, pos, e->red.Y, 4);
      pos = safecat(buffer, bufsize, pos, ",");
      pos = safecatd(buffer, bufsize, pos, e->red.Z, 4);
      pos = safecat(buffer, bufsize, pos, "),G(");
      pos = safecatd(buffer, bufsize, pos, e->green.X, 4);
      pos = safecat(buffer, bufsize, pos, ",");
      pos = safecatd(buffer, bufsize, pos, e->green.Y, 4);
      pos = safecat(buffer, bufsize, pos, ",");
      pos = safecatd(buffer, bufsize, pos, e->green.Z, 4);
      pos = safecat(buffer, bufsize, pos, "),B(");
      pos = safecatd(buffer, bufsize, pos, e->blue.X, 4);
      pos = safecat(buffer, bufsize, pos, ",");
      pos = safecatd(buffer, bufsize, pos, e->blue.Y, 4);
      pos = safecat(buffer, bufsize, pos, ",");
      pos = safecatd(buffer, bufsize, pos, e->blue.Z, 4);
      pos = safecat(buffer, bufsize, pos, ")");
      if (encoding_gamma != 0)
         pos = safecat(buffer, bufsize, pos, ")");
   }

   if (encoding_gamma != 0)
   {
      pos = safecat(buffer, bufsize, pos, "^");
      pos = safecatd(buffer, bufsize, pos, encoding_gamma, 5);
   }

   return pos;
}
1850
#endif /* PNG_READ_SUPPORTED */
1851

G
[devel]  
Glenn Randers-Pehrson 已提交
1852 1853
typedef struct png_modifier
{
1854
   png_store               this;             /* I am a png_store */
G
[devel]  
Glenn Randers-Pehrson 已提交
1855
   struct png_modification *modifications;   /* Changes to make */
1856

1857
   modifier_state           state;           /* My state */
G
[devel]  
Glenn Randers-Pehrson 已提交
1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869

   /* Information from IHDR: */
   png_byte                 bit_depth;       /* From IHDR */
   png_byte                 colour_type;     /* From IHDR */

   /* While handling PLTE, IDAT and IEND these chunks may be pended to allow
    * other chunks to be inserted.
    */
   png_uint_32              pending_len;
   png_uint_32              pending_chunk;

   /* Test values */
1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885
   double                   *gammas;
   unsigned int              ngammas;
   unsigned int              ngamma_tests;     /* Number of gamma tests to run*/
   double                    current_gamma;    /* 0 if not set */
   PNG_CONST color_encoding *encodings;
   unsigned int              nencodings;
   PNG_CONST color_encoding *current_encoding; /* If an encoding has been set */
   unsigned int              encoding_counter; /* For iteration */
   int                       encoding_ignored; /* Something overwrote it */

   /* Control variables used to iterate through possible encodings, the
    * following must be set to 0 and tested by the function that uses the
    * png_modifier because the modifier only sets it to 1 (true.)
    */
   unsigned int              repeat :1;   /* Repeat this transform test. */
   unsigned int              test_uses_encoding :1;
G
[devel]  
Glenn Randers-Pehrson 已提交
1886 1887

   /* Lowest sbit to test (libpng fails for sbit < 8) */
1888
   png_byte                 sbitlow;
G
[devel]  
Glenn Randers-Pehrson 已提交
1889 1890 1891 1892 1893

   /* Error control - these are the limits on errors accepted by the gamma tests
    * below.
    */
   double                   maxout8;  /* Maximum output value error */
G
Glenn Randers-Pehrson 已提交
1894
   double                   maxabs8;  /* Absolute sample error 0..1 */
1895
   double                   maxcalc8; /* Absolute sample error 0..1 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1896 1897 1898
   double                   maxpc8;   /* Percentage sample error 0..100% */
   double                   maxout16; /* Maximum output value error */
   double                   maxabs16; /* Absolute sample error 0..1 */
1899
   double                   maxcalc16;/* Absolute sample error 0..1 */
1900
   double                   maxcalcG; /* Absolute sample error 0..1 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1901 1902
   double                   maxpc16;  /* Percentage sample error 0..100% */

1903 1904 1905 1906 1907 1908 1909
   /* This is set by transforms that need to allow a higher limit, it is an
    * internal check on pngvalid to ensure that the calculated error limits are
    * not ridiculous; without this it is too easy to make a mistake in pngvalid
    * that allows any value through.
    */
   double                   limit;    /* limit on error values, normally 4E-3 */

1910 1911 1912 1913 1914 1915
   /* Log limits - values above this are logged, but not necessarily
    * warned.
    */
   double                   log8;     /* Absolute error in 8 bits to log */
   double                   log16;    /* Absolute error in 16 bits to log */

G
[devel]  
Glenn Randers-Pehrson 已提交
1916 1917 1918 1919 1920 1921 1922
   /* Logged 8 and 16 bit errors ('output' values): */
   double                   error_gray_2;
   double                   error_gray_4;
   double                   error_gray_8;
   double                   error_gray_16;
   double                   error_color_8;
   double                   error_color_16;
1923
   double                   error_indexed;
G
[devel]  
Glenn Randers-Pehrson 已提交
1924 1925

   /* Flags: */
1926 1927 1928 1929 1930
   /* Whether to call png_read_update_info, not png_read_start_image, and how
    * many times to call it.
    */
   int                      use_update_info;

1931 1932 1933
   /* Whether or not to interlace. */
   int                      interlace_type :9; /* int, but must store '1' */

1934 1935 1936
   /* Run the standard tests? */
   unsigned int             test_standard :1;

1937 1938 1939
   /* Run the odd-sized image and interlace read/write tests? */
   unsigned int             test_size :1;

1940
   /* Run tests on reading with a combination of transforms, */
1941 1942
   unsigned int             test_transform :1;

1943 1944 1945 1946 1947 1948
   /* When to use the use_input_precision option, this controls the gamma
    * validation code checks.  If set any value that is within the transformed
    * range input-.5 to input+.5 will be accepted, otherwise the value must be
    * within the normal limits.  It should not be necessary to set this; the
    * result should always be exact within the permitted error limits.
    */
1949 1950 1951
   unsigned int             use_input_precision :1;
   unsigned int             use_input_precision_sbit :1;
   unsigned int             use_input_precision_16to8 :1;
1952

1953 1954 1955 1956 1957
   /* If set assume that the calculation bit depth is set by the input
    * precision, not the output precision.
    */
   unsigned int             calculations_use_input_precision :1;

1958 1959
   /* If set assume that the calculations are done in 16 bits even if the sample
    * depth is 8 bits.
1960 1961
    */
   unsigned int             assume_16_bit_calculations :1;
1962

1963
   /* Which gamma tests to run: */
1964 1965 1966
   unsigned int             test_gamma_threshold :1;
   unsigned int             test_gamma_transform :1; /* main tests */
   unsigned int             test_gamma_sbit :1;
1967
   unsigned int             test_gamma_scale16 :1;
1968 1969 1970
   unsigned int             test_gamma_background :1;
   unsigned int             test_gamma_alpha_mode :1;
   unsigned int             test_gamma_expand16 :1;
1971
   unsigned int             test_exhaustive :1;
1972

1973
   unsigned int             log :1;   /* Log max error */
G
[devel]  
Glenn Randers-Pehrson 已提交
1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984

   /* Buffer information, the buffer size limits the size of the chunks that can
    * be modified - they must fit (including header and CRC) into the buffer!
    */
   size_t                   flush;           /* Count of bytes to flush */
   size_t                   buffer_count;    /* Bytes in buffer */
   size_t                   buffer_position; /* Position in buffer */
   png_byte                 buffer[1024];
} png_modifier;

/* This returns true if the test should be stopped now because it has already
1985 1986 1987
 * failed and it is running silently.
  */
static int fail(png_modifier *pm)
G
[devel]  
Glenn Randers-Pehrson 已提交
1988 1989
{
   return !pm->log && !pm->this.verbose && (pm->this.nerrors > 0 ||
1990
       (pm->this.treat_warnings_as_errors && pm->this.nwarnings > 0));
G
[devel]  
Glenn Randers-Pehrson 已提交
1991 1992 1993 1994 1995 1996
}

static void
modifier_init(png_modifier *pm)
{
   memset(pm, 0, sizeof *pm);
1997
   store_init(&pm->this);
G
[devel]  
Glenn Randers-Pehrson 已提交
1998 1999
   pm->modifications = NULL;
   pm->state = modifier_start;
2000
   pm->sbitlow = 1U;
2001
   pm->ngammas = 0;
2002
   pm->ngamma_tests = 0;
2003
   pm->gammas = 0;
2004 2005 2006 2007 2008 2009 2010 2011
   pm->current_gamma = 0;
   pm->encodings = 0;
   pm->nencodings = 0;
   pm->current_encoding = 0;
   pm->encoding_counter = 0;
   pm->encoding_ignored = 0;
   pm->repeat = 0;
   pm->test_uses_encoding = 0;
2012 2013
   pm->maxout8 = pm->maxpc8 = pm->maxabs8 = pm->maxcalc8 = 0;
   pm->maxout16 = pm->maxpc16 = pm->maxabs16 = pm->maxcalc16 = 0;
2014
   pm->maxcalcG = 0;
2015
   pm->limit = 4E-3;
2016
   pm->log8 = pm->log16 = 0; /* Means 'off' */
G
[devel]  
Glenn Randers-Pehrson 已提交
2017 2018
   pm->error_gray_2 = pm->error_gray_4 = pm->error_gray_8 = 0;
   pm->error_gray_16 = pm->error_color_8 = pm->error_color_16 = 0;
2019
   pm->error_indexed = 0;
2020
   pm->use_update_info = 0;
2021
   pm->interlace_type = PNG_INTERLACE_NONE;
2022
   pm->test_standard = 0;
2023
   pm->test_size = 0;
2024
   pm->test_transform = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
2025 2026 2027
   pm->use_input_precision = 0;
   pm->use_input_precision_sbit = 0;
   pm->use_input_precision_16to8 = 0;
2028
   pm->calculations_use_input_precision = 0;
2029
   pm->assume_16_bit_calculations = 0;
2030 2031 2032
   pm->test_gamma_threshold = 0;
   pm->test_gamma_transform = 0;
   pm->test_gamma_sbit = 0;
2033
   pm->test_gamma_scale16 = 0;
2034 2035 2036
   pm->test_gamma_background = 0;
   pm->test_gamma_alpha_mode = 0;
   pm->test_gamma_expand16 = 0;
2037
   pm->test_exhaustive = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
2038 2039 2040 2041 2042
   pm->log = 0;

   /* Rely on the memset for all the other fields - there are no pointers */
}

2043
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
2044 2045 2046 2047 2048 2049 2050 2051

/* This controls use of checks that explicitly know how libpng digitizes the
 * samples in calculations; setting this circumvents simple error limit checking
 * in the rgb_to_gray check, replacing it with an exact copy of the libpng 1.5
 * algorithm.
 */
#define DIGITIZE PNG_LIBPNG_VER < 10700

2052
/* If pm->calculations_use_input_precision is set then operations will happen
2053
 * with the precision of the input, not the precision of the output depth.
2054 2055 2056
 *
 * If pm->assume_16_bit_calculations is set then even 8 bit calculations use 16
 * bit precision.  This only affects those of the following limits that pertain
2057 2058
 * to a calculation - not a digitization operation - unless the following API is
 * called directly.
2059
 */
2060
#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
2061 2062
#if DIGITIZE
static double digitize(double value, int depth, int do_round)
2063 2064 2065 2066 2067 2068 2069
{
   /* 'value' is in the range 0 to 1, the result is the same value rounded to a
    * multiple of the digitization factor - 8 or 16 bits depending on both the
    * sample depth and the 'assume' setting.  Digitization is normally by
    * rounding and 'do_round' should be 1, if it is 0 the digitized value will
    * be truncated.
    */
2070
   PNG_CONST unsigned int digitization_factor = (1U << depth) -1;
2071 2072 2073 2074 2075 2076

   /* Limiting the range is done as a convenience to the caller - it's easier to
    * do it once here than every time at the call site.
    */
   if (value <= 0)
      value = 0;
2077

2078 2079 2080 2081 2082 2083 2084
   else if (value >= 1)
      value = 1;

   value *= digitization_factor;
   if (do_round) value += .5;
   return floor(value)/digitization_factor;
}
2085
#endif
2086
#endif /* RGB_TO_GRAY */
2087

2088
#ifdef PNG_READ_GAMMA_SUPPORTED
2089
static double abserr(PNG_CONST png_modifier *pm, int in_depth, int out_depth)
2090
{
2091 2092 2093
   /* Absolute error permitted in linear values - affected by the bit depth of
    * the calculations.
    */
2094 2095
   if (pm->assume_16_bit_calculations ||
      (pm->calculations_use_input_precision ? in_depth : out_depth) == 16)
2096 2097 2098
      return pm->maxabs16;
   else
      return pm->maxabs8;
2099 2100
}

2101
static double calcerr(PNG_CONST png_modifier *pm, int in_depth, int out_depth)
2102
{
2103 2104
   /* Error in the linear composition arithmetic - only relevant when
    * composition actually happens (0 < alpha < 1).
2105
    */
2106
   if ((pm->calculations_use_input_precision ? in_depth : out_depth) == 16)
2107
      return pm->maxcalc16;
2108 2109
   else if (pm->assume_16_bit_calculations)
      return pm->maxcalcG;
2110
   else
2111
      return pm->maxcalc8;
2112 2113
}

2114
static double pcerr(PNG_CONST png_modifier *pm, int in_depth, int out_depth)
2115
{
2116 2117 2118
   /* Percentage error permitted in the linear values.  Note that the specified
    * value is a percentage but this routine returns a simple number.
    */
2119 2120
   if (pm->assume_16_bit_calculations ||
      (pm->calculations_use_input_precision ? in_depth : out_depth) == 16)
2121 2122 2123
      return pm->maxpc16 * .01;
   else
      return pm->maxpc8 * .01;
2124 2125
}

2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136
/* Output error - the error in the encoded value.  This is determined by the
 * digitization of the output so can be +/-0.5 in the actual output value.  In
 * the expand_16 case with the current code in libpng the expand happens after
 * all the calculations are done in 8 bit arithmetic, so even though the output
 * depth is 16 the output error is determined by the 8 bit calculation.
 *
 * This limit is not determined by the bit depth of internal calculations.
 *
 * The specified parameter does *not* include the base .5 digitization error but
 * it is added here.
 */
2137
static double outerr(PNG_CONST png_modifier *pm, int in_depth, int out_depth)
2138 2139 2140
{
   /* There is a serious error in the 2 and 4 bit grayscale transform because
    * the gamma table value (8 bits) is simply shifted, not rounded, so the
2141
    * error in 4 bit grayscale gamma is up to the value below.  This is a hack
2142
    * to allow pngvalid to succeed:
2143 2144
    *
    * TODO: fix this in libpng
2145
    */
2146
   if (out_depth == 2)
2147 2148
      return .73182-.5;

2149
   if (out_depth == 4)
2150 2151
      return .90644-.5;

2152
   if ((pm->calculations_use_input_precision ? in_depth : out_depth) == 16)
2153
      return pm->maxout16;
2154

2155 2156 2157 2158 2159 2160 2161 2162 2163 2164
   /* This is the case where the value was calculated at 8-bit precision then
    * scaled to 16 bits.
    */
   else if (out_depth == 16)
      return pm->maxout8 * 257;

   else
      return pm->maxout8;
}

2165 2166 2167 2168
/* This does the same thing as the above however it returns the value to log,
 * rather than raising a warning.  This is useful for debugging to track down
 * exactly what set of parameters cause high error values.
 */
2169
static double outlog(PNG_CONST png_modifier *pm, int in_depth, int out_depth)
2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184
{
   /* The command line parameters are either 8 bit (0..255) or 16 bit (0..65535)
    * and so must be adjusted for low bit depth grayscale:
    */
   if (out_depth <= 8)
   {
      if (pm->log8 == 0) /* switched off */
         return 256;

      if (out_depth < 8)
         return pm->log8 / 255 * ((1<<out_depth)-1);

      return pm->log8;
   }

2185
   if ((pm->calculations_use_input_precision ? in_depth : out_depth) == 16)
2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201
   {
      if (pm->log16 == 0)
         return 65536;

      return pm->log16;
   }

   /* This is the case where the value was calculated at 8-bit precision then
    * scaled to 16 bits.
    */
   if (pm->log8 == 0)
      return 65536;

   return pm->log8 * 257;
}

2202 2203 2204 2205 2206
/* This complements the above by providing the appropriate quantization for the
 * final value.  Normally this would just be quantization to an integral value,
 * but in the 8 bit calculation case it's actually quantization to a multiple of
 * 257!
 */
2207
static int output_quantization_factor(PNG_CONST png_modifier *pm, int in_depth,
2208 2209
   int out_depth)
{
2210 2211
   if (out_depth == 16 && in_depth != 16 &&
      pm->calculations_use_input_precision)
2212 2213 2214
      return 257;
   else
      return 1;
2215
}
2216
#endif /* PNG_READ_GAMMA_SUPPORTED */
2217

2218
/* One modification structure must be provided for each chunk to be modified (in
G
[devel]  
Glenn Randers-Pehrson 已提交
2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230
 * fact more than one can be provided if multiple separate changes are desired
 * for a single chunk.)  Modifications include adding a new chunk when a
 * suitable chunk does not exist.
 *
 * The caller of modify_fn will reset the CRC of the chunk and record 'modified'
 * or 'added' as appropriate if the modify_fn returns 1 (true).  If the
 * modify_fn is NULL the chunk is simply removed.
 */
typedef struct png_modification
{
   struct png_modification *next;
   png_uint_32              chunk;
2231

G
[devel]  
Glenn Randers-Pehrson 已提交
2232
   /* If the following is NULL all matching chunks will be removed: */
2233
   int                    (*modify_fn)(struct png_modifier *pm,
2234 2235
                               struct png_modification *me, int add);

G
[devel]  
Glenn Randers-Pehrson 已提交
2236 2237 2238 2239 2240
   /* If the following is set to PLTE, IDAT or IEND and the chunk has not been
    * found and modified (and there is a modify_fn) the modify_fn will be called
    * to add the chunk before the relevant chunk.
    */
   png_uint_32              add;
2241 2242 2243
   unsigned int             modified :1;     /* Chunk was modified */
   unsigned int             added    :1;     /* Chunk was added */
   unsigned int             removed  :1;     /* Chunk was removed */
G
[devel]  
Glenn Randers-Pehrson 已提交
2244 2245
} png_modification;

2246 2247
static void
modification_reset(png_modification *pmm)
G
[devel]  
Glenn Randers-Pehrson 已提交
2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268
{
   if (pmm != NULL)
   {
      pmm->modified = 0;
      pmm->added = 0;
      pmm->removed = 0;
      modification_reset(pmm->next);
   }
}

static void
modification_init(png_modification *pmm)
{
   memset(pmm, 0, sizeof *pmm);
   pmm->next = NULL;
   pmm->chunk = 0;
   pmm->modify_fn = NULL;
   pmm->add = 0;
   modification_reset(pmm);
}

2269
#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280
static void
modifier_current_encoding(PNG_CONST png_modifier *pm, color_encoding *ce)
{
   if (pm->current_encoding != 0)
      *ce = *pm->current_encoding;

   else
      memset(ce, 0, sizeof *ce);

   ce->gamma = pm->current_gamma;
}
2281
#endif
2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361

static size_t
safecat_current_encoding(char *buffer, size_t bufsize, size_t pos,
   PNG_CONST png_modifier *pm)
{
   pos = safecat_color_encoding(buffer, bufsize, pos, pm->current_encoding,
      pm->current_gamma);

   if (pm->encoding_ignored)
      pos = safecat(buffer, bufsize, pos, "[overridden]");

   return pos;
}

/* Iterate through the usefully testable color encodings.  An encoding is one
 * of:
 *
 * 1) Nothing (no color space, no gamma).
 * 2) Just a gamma value from the gamma array (including 1.0)
 * 3) A color space from the encodings array with the corresponding gamma.
 * 4) The same, but with gamma 1.0 (only really useful with 16 bit calculations)
 *
 * The iterator selects these in turn, the randomizer selects one at random,
 * which is used depends on the setting of the 'test_exhaustive' flag.  Notice
 * that this function changes the colour space encoding so it must only be
 * called on completion of the previous test.  This is what 'modifier_reset'
 * does, below.
 *
 * After the function has been called the 'repeat' flag will still be set; the
 * caller of modifier_reset must reset it at the start of each run of the test!
 */
static unsigned int
modifier_total_encodings(PNG_CONST png_modifier *pm)
{
   return 1 +                 /* (1) nothing */
      pm->ngammas +           /* (2) gamma values to test */
      pm->nencodings +        /* (3) total number of encodings */
      /* The following test only works after the first time through the
       * png_modifier code because 'bit_depth' is set when the IHDR is read.
       * modifier_reset, below, preserves the setting until after it has called
       * the iterate function (also below.)
       *
       * For this reason do not rely on this function outside a call to
       * modifier_reset.
       */
      ((pm->bit_depth == 16 || pm->assume_16_bit_calculations) ?
         pm->nencodings : 0); /* (4) encodings with gamma == 1.0 */
}

static void
modifier_encoding_iterate(png_modifier *pm)
{
   if (!pm->repeat && /* Else something needs the current encoding again. */
      pm->test_uses_encoding) /* Some transform is encoding dependent */
   {
      if (pm->test_exhaustive)
      {
         if (++pm->encoding_counter >= modifier_total_encodings(pm))
            pm->encoding_counter = 0; /* This will stop the repeat */
      }

      else
      {
         /* Not exhaustive - choose an encoding at random; generate a number in
          * the range 1..(max-1), so the result is always non-zero:
          */
         if (pm->encoding_counter == 0)
            pm->encoding_counter = random_mod(modifier_total_encodings(pm)-1)+1;
         else
            pm->encoding_counter = 0;
      }

      if (pm->encoding_counter > 0)
         pm->repeat = 1;
   }

   else if (!pm->repeat)
      pm->encoding_counter = 0;
}

G
[devel]  
Glenn Randers-Pehrson 已提交
2362 2363 2364
static void
modifier_reset(png_modifier *pm)
{
2365
   store_read_reset(&pm->this);
2366 2367 2368
   pm->limit = 4E-3;
   pm->pending_len = pm->pending_chunk = 0;
   pm->flush = pm->buffer_count = pm->buffer_position = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
2369 2370
   pm->modifications = NULL;
   pm->state = modifier_start;
2371 2372 2373 2374 2375 2376 2377 2378 2379 2380
   modifier_encoding_iterate(pm);
   /* The following must be set in the next run.  In particular
    * test_uses_encodings must be set in the _ini function of each transform
    * that looks at the encodings.  (Not the 'add' function!)
    */
   pm->test_uses_encoding = 0;
   pm->current_gamma = 0;
   pm->current_encoding = 0;
   pm->encoding_ignored = 0;
   /* These only become value after IHDR is read: */
G
[devel]  
Glenn Randers-Pehrson 已提交
2381
   pm->bit_depth = pm->colour_type = 0;
2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439
}

/* The following must be called before anything else to get the encoding set up
 * on the modifier.  In particular it must be called before the transform init
 * functions are called.
 */
static void
modifier_set_encoding(png_modifier *pm)
{
   /* Set the encoding to the one specified by the current encoding counter,
    * first clear out all the settings - this corresponds to an encoding_counter
    * of 0.
    */
   pm->current_gamma = 0;
   pm->current_encoding = 0;
   pm->encoding_ignored = 0; /* not ignored yet - happens in _ini functions. */

   /* Now, if required, set the gamma and encoding fields. */
   if (pm->encoding_counter > 0)
   {
      /* The gammas[] array is an array of screen gammas, not encoding gammas,
       * so we need the inverse:
       */
      if (pm->encoding_counter <= pm->ngammas)
         pm->current_gamma = 1/pm->gammas[pm->encoding_counter-1];

      else
      {
         unsigned int i = pm->encoding_counter - pm->ngammas;

         if (i >= pm->nencodings)
         {
            i %= pm->nencodings;
            pm->current_gamma = 1; /* Linear, only in the 16 bit case */
         }

         else
            pm->current_gamma = pm->encodings[i].gamma;

         pm->current_encoding = pm->encodings + i;
      }
   }
}

/* Enquiry functions to find out what is set.  Notice that there is an implicit
 * assumption below that the first encoding in the list is the one for sRGB.
 */
static int
modifier_color_encoding_is_sRGB(PNG_CONST png_modifier *pm)
{
   return pm->current_encoding != 0 && pm->current_encoding == pm->encodings &&
      pm->current_encoding->gamma == pm->current_gamma;
}

static int
modifier_color_encoding_is_set(PNG_CONST png_modifier *pm)
{
   return pm->current_gamma != 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460
}

/* Convenience macros. */
#define CHUNK(a,b,c,d) (((a)<<24)+((b)<<16)+((c)<<8)+(d))
#define CHUNK_IHDR CHUNK(73,72,68,82)
#define CHUNK_PLTE CHUNK(80,76,84,69)
#define CHUNK_IDAT CHUNK(73,68,65,84)
#define CHUNK_IEND CHUNK(73,69,78,68)
#define CHUNK_cHRM CHUNK(99,72,82,77)
#define CHUNK_gAMA CHUNK(103,65,77,65)
#define CHUNK_sBIT CHUNK(115,66,73,84)
#define CHUNK_sRGB CHUNK(115,82,71,66)

/* The guts of modification are performed during a read. */
static void
modifier_crc(png_bytep buffer)
{
   /* Recalculate the chunk CRC - a complete chunk must be in
    * the buffer, at the start.
    */
   uInt datalen = png_get_uint_32(buffer);
2461
   uLong crc = crc32(0, buffer+4, datalen+4);
2462 2463 2464
   /* The cast to png_uint_32 is safe because a crc32 is always a 32 bit value.
    */
   png_save_uint_32(buffer+datalen+8, (png_uint_32)crc);
G
[devel]  
Glenn Randers-Pehrson 已提交
2465 2466 2467 2468 2469 2470 2471 2472 2473 2474
}

static void
modifier_setbuffer(png_modifier *pm)
{
   modifier_crc(pm->buffer);
   pm->buffer_count = png_get_uint_32(pm->buffer)+12;
   pm->buffer_position = 0;
}

2475 2476 2477 2478
/* Separate the callback into the actual implementation (which is passed the
 * png_modifier explicitly) and the callback, which gets the modifier from the
 * png_struct.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
2479
static void
2480
modifier_read_imp(png_modifier *pm, png_bytep pb, png_size_t st)
G
[devel]  
Glenn Randers-Pehrson 已提交
2481 2482 2483 2484 2485 2486 2487 2488 2489
{
   while (st > 0)
   {
      size_t cb;
      png_uint_32 len, chunk;
      png_modification *mod;

      if (pm->buffer_position >= pm->buffer_count) switch (pm->state)
      {
2490 2491
         static png_byte sign[8] = { 137, 80, 78, 71, 13, 10, 26, 10 };
         case modifier_start:
2492
            store_read_imp(&pm->this, pm->buffer, 8); /* size of signature. */
2493 2494
            pm->buffer_count = 8;
            pm->buffer_position = 0;
2495

2496
            if (memcmp(pm->buffer, sign, 8) != 0)
2497
               png_error(pm->this.pread, "invalid PNG file signature");
2498 2499
            pm->state = modifier_signature;
            break;
2500

2501
         case modifier_signature:
2502
            store_read_imp(&pm->this, pm->buffer, 13+12); /* size of IHDR */
2503 2504
            pm->buffer_count = 13+12;
            pm->buffer_position = 0;
2505

2506 2507
            if (png_get_uint_32(pm->buffer) != 13 ||
                png_get_uint_32(pm->buffer+4) != CHUNK_IHDR)
2508
               png_error(pm->this.pread, "invalid IHDR");
2509

2510
            /* Check the list of modifiers for modifications to the IHDR. */
2511 2512 2513
            mod = pm->modifications;
            while (mod != NULL)
            {
2514
               if (mod->chunk == CHUNK_IHDR && mod->modify_fn &&
2515
                   (*mod->modify_fn)(pm, mod, 0))
2516
                  {
2517 2518
                  mod->modified = 1;
                  modifier_setbuffer(pm);
2519
                  }
2520

2521
               /* Ignore removal or add if IHDR! */
2522 2523
               mod = mod->next;
            }
2524

2525 2526 2527
            /* Cache information from the IHDR (the modified one.) */
            pm->bit_depth = pm->buffer[8+8];
            pm->colour_type = pm->buffer[8+8+1];
2528

2529 2530 2531
            pm->state = modifier_IHDR;
            pm->flush = 0;
            break;
2532

2533 2534 2535 2536 2537
         case modifier_IHDR:
         default:
            /* Read a new chunk and process it until we see PLTE, IDAT or
             * IEND.  'flush' indicates that there is still some data to
             * output from the preceding chunk.
2538
             */
2539 2540 2541 2542
            if ((cb = pm->flush) > 0)
            {
               if (cb > st) cb = st;
               pm->flush -= cb;
2543
               store_read_imp(&pm->this, pb, cb);
2544 2545
               pb += cb;
               st -= cb;
2546
               if (st == 0) return;
2547
            }
2548

2549 2550 2551 2552
            /* No more bytes to flush, read a header, or handle a pending
             * chunk.
             */
            if (pm->pending_chunk != 0)
2553
            {
2554 2555 2556 2557 2558 2559
               png_save_uint_32(pm->buffer, pm->pending_len);
               png_save_uint_32(pm->buffer+4, pm->pending_chunk);
               pm->pending_len = 0;
               pm->pending_chunk = 0;
            }
            else
2560
               store_read_imp(&pm->this, pm->buffer, 8);
2561

2562 2563
            pm->buffer_count = 8;
            pm->buffer_position = 0;
2564

2565 2566 2567
            /* Check for something to modify or a terminator chunk. */
            len = png_get_uint_32(pm->buffer);
            chunk = png_get_uint_32(pm->buffer+4);
2568

2569 2570 2571 2572 2573 2574 2575
            /* Terminators first, they may have to be delayed for added
             * chunks
             */
            if (chunk == CHUNK_PLTE || chunk == CHUNK_IDAT ||
                chunk == CHUNK_IEND)
            {
               mod = pm->modifications;
2576

2577
               while (mod != NULL)
2578
               {
2579 2580 2581
                  if ((mod->add == chunk ||
                      (mod->add == CHUNK_PLTE && chunk == CHUNK_IDAT)) &&
                      mod->modify_fn != NULL && !mod->modified && !mod->added)
2582
                  {
2583 2584 2585 2586
                     /* Regardless of what the modify function does do not run
                      * this again.
                      */
                     mod->added = 1;
2587

2588
                     if ((*mod->modify_fn)(pm, mod, 1 /*add*/))
2589 2590 2591 2592 2593 2594 2595 2596 2597 2598
                     {
                        /* Reset the CRC on a new chunk */
                        if (pm->buffer_count > 0)
                           modifier_setbuffer(pm);

                        else
                           {
                           pm->buffer_position = 0;
                           mod->removed = 1;
                           }
2599

2600 2601 2602 2603 2604 2605 2606
                        /* The buffer has been filled with something (we assume)
                         * so output this.  Pend the current chunk.
                         */
                        pm->pending_len = len;
                        pm->pending_chunk = chunk;
                        break; /* out of while */
                     }
2607
                  }
2608

2609 2610
                  mod = mod->next;
               }
2611

2612
               /* Don't do any further processing if the buffer was modified -
2613 2614
                * otherwise the code will end up modifying a chunk that was
                * just added.
2615 2616 2617 2618
                */
               if (mod != NULL)
                  break; /* out of switch */
            }
2619

2620 2621
            /* If we get to here then this chunk may need to be modified.  To
             * do this it must be less than 1024 bytes in total size, otherwise
2622 2623 2624 2625
             * it just gets flushed.
             */
            if (len+12 <= sizeof pm->buffer)
            {
2626
               store_read_imp(&pm->this, pm->buffer+pm->buffer_count,
2627 2628
                   len+12-pm->buffer_count);
               pm->buffer_count = len+12;
2629

2630 2631 2632 2633 2634
               /* Check for a modification, else leave it be. */
               mod = pm->modifications;
               while (mod != NULL)
               {
                  if (mod->chunk == chunk)
2635
                  {
2636 2637 2638 2639 2640 2641 2642 2643
                     if (mod->modify_fn == NULL)
                     {
                        /* Remove this chunk */
                        pm->buffer_count = pm->buffer_position = 0;
                        mod->removed = 1;
                        break; /* Terminate the while loop */
                     }

2644
                     else if ((*mod->modify_fn)(pm, mod, 0))
2645
                     {
2646 2647 2648 2649 2650 2651 2652 2653
                        mod->modified = 1;
                        /* The chunk may have been removed: */
                        if (pm->buffer_count == 0)
                        {
                           pm->buffer_position = 0;
                           break;
                        }
                        modifier_setbuffer(pm);
2654 2655
                     }
                  }
2656

2657
                  mod = mod->next;
2658 2659 2660
               }
            }

2661 2662
            else
               pm->flush = len+12 - pm->buffer_count; /* data + crc */
2663

2664 2665
            /* Take the data from the buffer (if there is any). */
            break;
G
[devel]  
Glenn Randers-Pehrson 已提交
2666 2667 2668
      }

      /* Here to read from the modifier buffer (not directly from
2669
       * the store, as in the flush case above.)
G
[devel]  
Glenn Randers-Pehrson 已提交
2670 2671
       */
      cb = pm->buffer_count - pm->buffer_position;
2672 2673 2674 2675

      if (cb > st)
         cb = st;

G
[devel]  
Glenn Randers-Pehrson 已提交
2676 2677 2678 2679 2680 2681 2682
      memcpy(pb, pm->buffer + pm->buffer_position, cb);
      st -= cb;
      pb += cb;
      pm->buffer_position += cb;
   }
}

2683
/* The callback: */
2684
static void PNGCBAPI
2685
modifier_read(png_structp ppIn, png_bytep pb, png_size_t st)
2686
{
2687
   png_const_structp pp = ppIn;
2688
   png_modifier *pm = voidcast(png_modifier*, png_get_io_ptr(pp));
2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706

   if (pm == NULL || pm->this.pread != pp)
      png_error(pp, "bad modifier_read call");

   modifier_read_imp(pm, pb, st);
}

/* Like store_progressive_read but the data is getting changed as we go so we
 * need a local buffer.
 */
static void
modifier_progressive_read(png_modifier *pm, png_structp pp, png_infop pi)
{
   if (pm->this.pread != pp || pm->this.current == NULL ||
       pm->this.next == NULL)
      png_error(pp, "store state damaged (progressive)");

   /* This is another Horowitz and Hill random noise generator.  In this case
2707
    * the aim is to stress the progressive reader with truly horrible variable
2708 2709 2710
    * buffer sizes in the range 1..500, so a sequence of 9 bit random numbers
    * is generated.  We could probably just count from 1 to 32767 and get as
    * good a result.
2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752
    */
   for (;;)
   {
      static png_uint_32 noise = 1;
      png_size_t cb, cbAvail;
      png_byte buffer[512];

      /* Generate 15 more bits of stuff: */
      noise = (noise << 9) | ((noise ^ (noise >> (9-5))) & 0x1ff);
      cb = noise & 0x1ff;

      /* Check that this number of bytes are available (in the current buffer.)
       * (This doesn't quite work - the modifier might delete a chunk; unlikely
       * but possible, it doesn't happen at present because the modifier only
       * adds chunks to standard images.)
       */
      cbAvail = store_read_buffer_avail(&pm->this);
      if (pm->buffer_count > pm->buffer_position)
         cbAvail += pm->buffer_count - pm->buffer_position;

      if (cb > cbAvail)
      {
         /* Check for EOF: */
         if (cbAvail == 0)
            break;

         cb = cbAvail;
      }

      modifier_read_imp(pm, buffer, cb);
      png_process_data(pp, pi, buffer, cb);
   }

   /* Check the invariants at the end (if this fails it's a problem in this
    * file!)
    */
   if (pm->buffer_count > pm->buffer_position ||
       pm->this.next != &pm->this.current->data ||
       pm->this.readpos < pm->this.current->datacount)
      png_error(pp, "progressive read implementation error");
}

G
[devel]  
Glenn Randers-Pehrson 已提交
2753 2754 2755
/* Set up a modifier. */
static png_structp
set_modifier_for_read(png_modifier *pm, png_infopp ppi, png_uint_32 id,
2756
    PNG_CONST char *name)
G
[devel]  
Glenn Randers-Pehrson 已提交
2757
{
2758 2759 2760 2761 2762 2763 2764
   /* Do this first so that the modifier fields are cleared even if an error
    * happens allocating the png_struct.  No allocation is done here so no
    * cleanup is required.
    */
   pm->state = modifier_start;
   pm->bit_depth = 0;
   pm->colour_type = 255;
2765

2766 2767 2768 2769 2770
   pm->pending_len = 0;
   pm->pending_chunk = 0;
   pm->flush = 0;
   pm->buffer_count = 0;
   pm->buffer_position = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
2771

2772
   return set_store_for_read(&pm->this, ppi, id, name);
G
[devel]  
Glenn Randers-Pehrson 已提交
2773
}
2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906


/******************************** MODIFICATIONS *******************************/
/* Standard modifications to add chunks.  These do not require the _SUPPORTED
 * macros because the chunks can be there regardless of whether this specific
 * libpng supports them.
 */
typedef struct gama_modification
{
   png_modification this;
   png_fixed_point  gamma;
} gama_modification;

static int
gama_modify(png_modifier *pm, png_modification *me, int add)
{
   UNUSED(add)
   /* This simply dumps the given gamma value into the buffer. */
   png_save_uint_32(pm->buffer, 4);
   png_save_uint_32(pm->buffer+4, CHUNK_gAMA);
   png_save_uint_32(pm->buffer+8, ((gama_modification*)me)->gamma);
   return 1;
}

static void
gama_modification_init(gama_modification *me, png_modifier *pm, double gammad)
{
   double g;

   modification_init(&me->this);
   me->this.chunk = CHUNK_gAMA;
   me->this.modify_fn = gama_modify;
   me->this.add = CHUNK_PLTE;
   g = fix(gammad);
   me->gamma = (png_fixed_point)g;
   me->this.next = pm->modifications;
   pm->modifications = &me->this;
}

typedef struct chrm_modification
{
   png_modification          this;
   PNG_CONST color_encoding *encoding;
   png_fixed_point           wx, wy, rx, ry, gx, gy, bx, by;
} chrm_modification;

static int
chrm_modify(png_modifier *pm, png_modification *me, int add)
{
   UNUSED(add)
   /* As with gAMA this just adds the required cHRM chunk to the buffer. */
   png_save_uint_32(pm->buffer   , 32);
   png_save_uint_32(pm->buffer+ 4, CHUNK_cHRM);
   png_save_uint_32(pm->buffer+ 8, ((chrm_modification*)me)->wx);
   png_save_uint_32(pm->buffer+12, ((chrm_modification*)me)->wy);
   png_save_uint_32(pm->buffer+16, ((chrm_modification*)me)->rx);
   png_save_uint_32(pm->buffer+20, ((chrm_modification*)me)->ry);
   png_save_uint_32(pm->buffer+24, ((chrm_modification*)me)->gx);
   png_save_uint_32(pm->buffer+28, ((chrm_modification*)me)->gy);
   png_save_uint_32(pm->buffer+32, ((chrm_modification*)me)->bx);
   png_save_uint_32(pm->buffer+36, ((chrm_modification*)me)->by);
   return 1;
}

static void
chrm_modification_init(chrm_modification *me, png_modifier *pm,
   PNG_CONST color_encoding *encoding)
{
   CIE_color white = white_point(encoding);

   /* Original end points: */
   me->encoding = encoding;

   /* Chromaticities (in fixed point): */
   me->wx = fix(chromaticity_x(white));
   me->wy = fix(chromaticity_y(white));

   me->rx = fix(chromaticity_x(encoding->red));
   me->ry = fix(chromaticity_y(encoding->red));
   me->gx = fix(chromaticity_x(encoding->green));
   me->gy = fix(chromaticity_y(encoding->green));
   me->bx = fix(chromaticity_x(encoding->blue));
   me->by = fix(chromaticity_y(encoding->blue));

   modification_init(&me->this);
   me->this.chunk = CHUNK_cHRM;
   me->this.modify_fn = chrm_modify;
   me->this.add = CHUNK_PLTE;
   me->this.next = pm->modifications;
   pm->modifications = &me->this;
}

typedef struct srgb_modification
{
   png_modification this;
   png_byte         intent;
} srgb_modification;

static int
srgb_modify(png_modifier *pm, png_modification *me, int add)
{
   UNUSED(add)
   /* As above, ignore add and just make a new chunk */
   png_save_uint_32(pm->buffer, 1);
   png_save_uint_32(pm->buffer+4, CHUNK_sRGB);
   pm->buffer[8] = ((srgb_modification*)me)->intent;
   return 1;
}

static void
srgb_modification_init(srgb_modification *me, png_modifier *pm, png_byte intent)
{
   modification_init(&me->this);
   me->this.chunk = CHUNK_sBIT;

   if (intent <= 3) /* if valid, else *delete* sRGB chunks */
   {
      me->this.modify_fn = srgb_modify;
      me->this.add = CHUNK_PLTE;
      me->intent = intent;
   }

   else
   {
      me->this.modify_fn = 0;
      me->this.add = 0;
      me->intent = 0;
   }

   me->this.next = pm->modifications;
   pm->modifications = &me->this;
}

2907
#ifdef PNG_READ_GAMMA_SUPPORTED
2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973
typedef struct sbit_modification
{
   png_modification this;
   png_byte         sbit;
} sbit_modification;

static int
sbit_modify(png_modifier *pm, png_modification *me, int add)
{
   png_byte sbit = ((sbit_modification*)me)->sbit;
   if (pm->bit_depth > sbit)
   {
      int cb = 0;
      switch (pm->colour_type)
      {
         case 0:
            cb = 1;
            break;

         case 2:
         case 3:
            cb = 3;
            break;

         case 4:
            cb = 2;
            break;

         case 6:
            cb = 4;
            break;

         default:
            png_error(pm->this.pread,
               "unexpected colour type in sBIT modification");
      }

      png_save_uint_32(pm->buffer, cb);
      png_save_uint_32(pm->buffer+4, CHUNK_sBIT);

      while (cb > 0)
         (pm->buffer+8)[--cb] = sbit;

      return 1;
   }
   else if (!add)
   {
      /* Remove the sBIT chunk */
      pm->buffer_count = pm->buffer_position = 0;
      return 1;
   }
   else
      return 0; /* do nothing */
}

static void
sbit_modification_init(sbit_modification *me, png_modifier *pm, png_byte sbit)
{
   modification_init(&me->this);
   me->this.chunk = CHUNK_sBIT;
   me->this.modify_fn = sbit_modify;
   me->this.add = CHUNK_PLTE;
   me->sbit = sbit;
   me->this.next = pm->modifications;
   pm->modifications = &me->this;
}
2974
#endif /* PNG_READ_GAMMA_SUPPORTED */
2975
#endif /* PNG_READ_TRANSFORMS_SUPPORTED */
G
[devel]  
Glenn Randers-Pehrson 已提交
2976 2977 2978

/***************************** STANDARD PNG FILES *****************************/
/* Standard files - write and save standard files. */
2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990
/* There are two basic forms of standard images.  Those which attempt to have
 * all the possible pixel values (not possible for 16bpp images, but a range of
 * values are produced) and those which have a range of image sizes.  The former
 * are used for testing transforms, in particular gamma correction and bit
 * reduction and increase.  The latter are reserved for testing the behavior of
 * libpng with respect to 'odd' image sizes - particularly small images where
 * rows become 1 byte and interlace passes disappear.
 *
 * The first, most useful, set are the 'transform' images, the second set of
 * small images are the 'size' images.
 *
 * The transform files are constructed with rows which fit into a 1024 byte row
G
[devel]  
Glenn Randers-Pehrson 已提交
2991
 * buffer.  This makes allocation easier below.  Further regardless of the file
2992
 * format every row has 128 pixels (giving 1024 bytes for 64bpp formats).
G
[devel]  
Glenn Randers-Pehrson 已提交
2993 2994
 *
 * Files are stored with no gAMA or sBIT chunks, with a PLTE only when needed
2995
 * and with an ID derived from the colour type, bit depth and interlace type
2996 2997 2998 2999 3000 3001 3002
 * as above (FILEID).  The width (128) and height (variable) are not stored in
 * the FILEID - instead the fields are set to 0, indicating a transform file.
 *
 * The size files ar constructed with rows a maximum of 128 bytes wide, allowing
 * a maximum width of 16 pixels (for the 64bpp case.)  They also have a maximum
 * height of 16 rows.  The width and height are stored in the FILEID and, being
 * non-zero, indicate a size file.
3003
 *
3004 3005 3006 3007 3008 3009
 * Because the PNG filter code is typically the largest CPU consumer within
 * libpng itself there is a tendency to attempt to optimize it.  This results in
 * special case code which needs to be validated.  To cause this to happen the
 * 'size' images are made to use each possible filter, in so far as this is
 * possible for smaller images.
 *
3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022
 * For palette image (colour type 3) multiple transform images are stored with
 * the same bit depth to allow testing of more colour combinations -
 * particularly important for testing the gamma code because libpng uses a
 * different code path for palette images.  For size images a single palette is
 * used.
 */

/* Make a 'standard' palette.  Because there are only 256 entries in a palette
 * (maximum) this actually makes a random palette in the hope that enough tests
 * will catch enough errors.  (Note that the same palette isn't produced every
 * time for the same test - it depends on what previous tests have been run -
 * but a given set of arguments to pngvalid will always produce the same palette
 * at the same test!  This is why pseudo-random number generators are useful for
3023
 * testing.)
3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041
 *
 * The store must be open for write when this is called, otherwise an internal
 * error will occur.  This routine contains its own magic number seed, so the
 * palettes generated don't change if there are intervening errors (changing the
 * calls to the store_mark seed.)
 */
static store_palette_entry *
make_standard_palette(png_store* ps, int npalette, int do_tRNS)
{
   static png_uint_32 palette_seed[2] = { 0x87654321, 9 };

   int i = 0;
   png_byte values[256][4];

   /* Always put in black and white plus the six primary and secondary colors.
    */
   for (; i<8; ++i)
   {
3042 3043 3044
      values[i][1] = (png_byte)((i&1) ? 255U : 0U);
      values[i][2] = (png_byte)((i&2) ? 255U : 0U);
      values[i][3] = (png_byte)((i&4) ? 255U : 0U);
3045 3046
   }

3047
   /* Then add 62 grays (one quarter of the remaining 256 slots). */
3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077
   {
      int j = 0;
      png_byte random_bytes[4];
      png_byte need[256];

      need[0] = 0; /*got black*/
      memset(need+1, 1, (sizeof need)-2); /*need these*/
      need[255] = 0; /*but not white*/

      while (i<70)
      {
         png_byte b;

         if (j==0)
         {
            make_four_random_bytes(palette_seed, random_bytes);
            j = 4;
         }

         b = random_bytes[--j];
         if (need[b])
         {
            values[i][1] = b;
            values[i][2] = b;
            values[i++][3] = b;
         }
      }
   }

   /* Finally add 192 colors at random - don't worry about matches to things we
3078
    * already have, chance is less than 1/65536.  Don't worry about grays,
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126
    * chance is the same, so we get a duplicate or extra gray less than 1 time
    * in 170.
    */
   for (; i<256; ++i)
      make_four_random_bytes(palette_seed, values[i]);

   /* Fill in the alpha values in the first byte.  Just use all possible values
    * (0..255) in an apparently random order:
    */
   {
      store_palette_entry *palette;
      png_byte selector[4];

      make_four_random_bytes(palette_seed, selector);

      if (do_tRNS)
         for (i=0; i<256; ++i)
            values[i][0] = (png_byte)(i ^ selector[0]);

      else
         for (i=0; i<256; ++i)
            values[i][0] = 255; /* no transparency/tRNS chunk */

      /* 'values' contains 256 ARGB values, but we only need 'npalette'.
       * 'npalette' will always be a power of 2: 2, 4, 16 or 256.  In the low
       * bit depth cases select colors at random, else it is difficult to have
       * a set of low bit depth palette test with any chance of a reasonable
       * range of colors.  Do this by randomly permuting values into the low
       * 'npalette' entries using an XOR mask generated here.  This also
       * permutes the npalette == 256 case in a potentially useful way (there is
       * no relationship between palette index and the color value therein!)
       */
      palette = store_write_palette(ps, npalette);

      for (i=0; i<npalette; ++i)
      {
         palette[i].alpha = values[i ^ selector[1]][0];
         palette[i].red   = values[i ^ selector[1]][1];
         palette[i].green = values[i ^ selector[1]][2];
         palette[i].blue  = values[i ^ selector[1]][3];
      }

      return palette;
   }
}

/* Initialize a standard palette on a write stream.  The 'do_tRNS' argument
 * indicates whether or not to also set the tRNS chunk.
G
[devel]  
Glenn Randers-Pehrson 已提交
3127
 */
3128
/* TODO: the png_structp here can probably be 'const' in the future */
3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167
static void
init_standard_palette(png_store *ps, png_structp pp, png_infop pi, int npalette,
   int do_tRNS)
{
   store_palette_entry *ppal = make_standard_palette(ps, npalette, do_tRNS);

   {
      int i;
      png_color palette[256];

      /* Set all entries to detect overread errors. */
      for (i=0; i<npalette; ++i)
      {
         palette[i].red = ppal[i].red;
         palette[i].green = ppal[i].green;
         palette[i].blue = ppal[i].blue;
      }

      /* Just in case fill in the rest with detectable values: */
      for (; i<256; ++i)
         palette[i].red = palette[i].green = palette[i].blue = 42;

      png_set_PLTE(pp, pi, palette, npalette);
   }

   if (do_tRNS)
   {
      int i, j;
      png_byte tRNS[256];

      /* Set all the entries, but skip trailing opaque entries */
      for (i=j=0; i<npalette; ++i)
         if ((tRNS[i] = ppal[i].alpha) < 255)
            j = i+1;

      /* Fill in the remainder with a detectable value: */
      for (; i<256; ++i)
         tRNS[i] = 24;

3168
#  ifdef PNG_WRITE_tRNS_SUPPORTED
3169 3170
         if (j > 0)
            png_set_tRNS(pp, pi, tRNS, j, 0/*color*/);
3171
#  endif
3172 3173
   }
}
3174

3175
/* The number of passes is related to the interlace type. There was no libpng
3176
 * API to determine this prior to 1.5, so we need an inquiry function:
3177 3178
 */
static int
3179
npasses_from_interlace_type(png_const_structp pp, int interlace_type)
3180 3181 3182 3183 3184 3185 3186 3187 3188 3189
{
   switch (interlace_type)
   {
   default:
      png_error(pp, "invalid interlace type");

   case PNG_INTERLACE_NONE:
      return 1;

   case PNG_INTERLACE_ADAM7:
3190
      return PNG_INTERLACE_ADAM7_PASSES;
3191 3192
   }
}
G
[devel]  
Glenn Randers-Pehrson 已提交
3193

3194
static unsigned int
3195
bit_size(png_const_structp pp, png_byte colour_type, png_byte bit_depth)
G
[devel]  
Glenn Randers-Pehrson 已提交
3196 3197 3198
{
   switch (colour_type)
   {
3199 3200
      default: png_error(pp, "invalid color type");

3201 3202 3203 3204 3205 3206 3207 3208 3209
      case 0:  return bit_depth;

      case 2:  return 3*bit_depth;

      case 3:  return bit_depth;

      case 4:  return 2*bit_depth;

      case 6:  return 4*bit_depth;
G
[devel]  
Glenn Randers-Pehrson 已提交
3210 3211 3212
   }
}

3213 3214 3215 3216
#define TRANSFORM_WIDTH  128U
#define TRANSFORM_ROWMAX (TRANSFORM_WIDTH*8U)
#define SIZE_ROWMAX (16*8U) /* 16 pixels, max 8 bytes each - 128 bytes */
#define STANDARD_ROWMAX TRANSFORM_ROWMAX /* The larger of the two */
3217
#define SIZE_HEIGHTMAX 16 /* Maximum range of size images */
3218

G
[devel]  
Glenn Randers-Pehrson 已提交
3219
static size_t
3220 3221
transform_rowsize(png_const_structp pp, png_byte colour_type,
   png_byte bit_depth)
G
[devel]  
Glenn Randers-Pehrson 已提交
3222
{
3223
   return (TRANSFORM_WIDTH * bit_size(pp, colour_type, bit_depth)) / 8;
G
[devel]  
Glenn Randers-Pehrson 已提交
3224 3225
}

3226
/* transform_width(pp, colour_type, bit_depth) current returns the same number
3227 3228
 * every time, so just use a macro:
 */
3229
#define transform_width(pp, colour_type, bit_depth) TRANSFORM_WIDTH
G
[devel]  
Glenn Randers-Pehrson 已提交
3230 3231

static png_uint_32
3232
transform_height(png_const_structp pp, png_byte colour_type, png_byte bit_depth)
G
[devel]  
Glenn Randers-Pehrson 已提交
3233 3234 3235
{
   switch (bit_size(pp, colour_type, bit_depth))
   {
3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253
      case 1:
      case 2:
      case 4:
         return 1;   /* Total of 128 pixels */

      case 8:
         return 2;   /* Total of 256 pixels/bytes */

      case 16:
         return 512; /* Total of 65536 pixels */

      case 24:
      case 32:
         return 512; /* 65536 pixels */

      case 48:
      case 64:
         return 2048;/* 4 x 65536 pixels. */
3254
#        define TRANSFORM_HEIGHTMAX 2048
3255 3256 3257

      default:
         return 0;   /* Error, will be caught later */
G
[devel]  
Glenn Randers-Pehrson 已提交
3258 3259 3260
   }
}

3261
#ifdef PNG_READ_SUPPORTED
3262 3263 3264 3265
/* The following can only be defined here, now we have the definitions
 * of the transform image sizes.
 */
static png_uint_32
3266
standard_width(png_const_structp pp, png_uint_32 id)
3267 3268
{
   png_uint_32 width = WIDTH_FROM_ID(id);
3269
   UNUSED(pp)
3270 3271 3272 3273 3274 3275 3276 3277

   if (width == 0)
      width = transform_width(pp, COL_FROM_ID(id), DEPTH_FROM_ID(id));

   return width;
}

static png_uint_32
3278
standard_height(png_const_structp pp, png_uint_32 id)
3279 3280 3281 3282 3283 3284 3285 3286 3287 3288
{
   png_uint_32 height = HEIGHT_FROM_ID(id);

   if (height == 0)
      height = transform_height(pp, COL_FROM_ID(id), DEPTH_FROM_ID(id));

   return height;
}

static png_uint_32
3289
standard_rowsize(png_const_structp pp, png_uint_32 id)
3290 3291 3292 3293 3294 3295 3296
{
   png_uint_32 width = standard_width(pp, id);

   /* This won't overflow: */
   width *= bit_size(pp, COL_FROM_ID(id), DEPTH_FROM_ID(id));
   return (width + 7) / 8;
}
3297
#endif /* PNG_READ_SUPPORTED */
3298

G
[devel]  
Glenn Randers-Pehrson 已提交
3299
static void
3300
transform_row(png_const_structp pp, png_byte buffer[TRANSFORM_ROWMAX],
3301
   png_byte colour_type, png_byte bit_depth, png_uint_32 y)
G
[devel]  
Glenn Randers-Pehrson 已提交
3302 3303 3304 3305 3306 3307
{
   png_uint_32 v = y << 7;
   png_uint_32 i = 0;

   switch (bit_size(pp, colour_type, bit_depth))
   {
3308
      case 1:
3309
         while (i<128/8) buffer[i] = (png_byte)(v & 0xff), v += 17, ++i;
3310 3311 3312
         return;

      case 2:
3313
         while (i<128/4) buffer[i] = (png_byte)(v & 0xff), v += 33, ++i;
3314 3315 3316
         return;

      case 4:
3317
         while (i<128/2) buffer[i] = (png_byte)(v & 0xff), v += 65, ++i;
3318 3319 3320 3321
         return;

      case 8:
         /* 256 bytes total, 128 bytes in each row set as follows: */
3322
         while (i<128) buffer[i] = (png_byte)(v & 0xff), ++v, ++i;
3323 3324 3325
         return;

      case 16:
3326 3327
         /* Generate all 65536 pixel values in order, which includes the 8 bit
          * GA case as well as the 16 bit G case.
3328 3329
          */
         while (i<128)
3330 3331 3332 3333 3334 3335
         {
            buffer[2*i] = (png_byte)((v>>8) & 0xff);
            buffer[2*i+1] = (png_byte)(v & 0xff);
            ++v;
            ++i;
         }
3336 3337 3338 3339 3340 3341 3342 3343

         return;

      case 24:
         /* 65535 pixels, but rotate the values. */
         while (i<128)
         {
            /* Three bytes per pixel, r, g, b, make b by r^g */
3344 3345 3346
            buffer[3*i+0] = (png_byte)((v >> 8) & 0xff);
            buffer[3*i+1] = (png_byte)(v & 0xff);
            buffer[3*i+2] = (png_byte)(((v >> 8) ^ v) & 0xff);
3347 3348 3349 3350 3351 3352 3353 3354 3355 3356
            ++v;
            ++i;
         }

         return;

      case 32:
         /* 65535 pixels, r, g, b, a; just replicate */
         while (i<128)
         {
3357 3358 3359 3360
            buffer[4*i+0] = (png_byte)((v >> 8) & 0xff);
            buffer[4*i+1] = (png_byte)(v & 0xff);
            buffer[4*i+2] = (png_byte)((v >> 8) & 0xff);
            buffer[4*i+3] = (png_byte)(v & 0xff);
3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373
            ++v;
            ++i;
         }

         return;

      case 48:
         /* y is maximum 2047, giving 4x65536 pixels, make 'r' increase by 1 at
          * each pixel, g increase by 257 (0x101) and 'b' by 0x1111:
          */
         while (i<128)
         {
            png_uint_32 t = v++;
3374 3375
            buffer[6*i+0] = (png_byte)((t >> 8) & 0xff);
            buffer[6*i+1] = (png_byte)(t & 0xff);
3376
            t *= 257;
3377 3378
            buffer[6*i+2] = (png_byte)((t >> 8) & 0xff);
            buffer[6*i+3] = (png_byte)(t & 0xff);
3379
            t *= 17;
3380 3381
            buffer[6*i+4] = (png_byte)((t >> 8) & 0xff);
            buffer[6*i+5] = (png_byte)(t & 0xff);
3382 3383 3384 3385 3386 3387 3388 3389 3390 3391
            ++i;
         }

         return;

      case 64:
         /* As above in the 32 bit case. */
         while (i<128)
         {
            png_uint_32 t = v++;
3392 3393 3394 3395
            buffer[8*i+0] = (png_byte)((t >> 8) & 0xff);
            buffer[8*i+1] = (png_byte)(t & 0xff);
            buffer[8*i+4] = (png_byte)((t >> 8) & 0xff);
            buffer[8*i+5] = (png_byte)(t & 0xff);
3396
            t *= 257;
3397 3398 3399 3400
            buffer[8*i+2] = (png_byte)((t >> 8) & 0xff);
            buffer[8*i+3] = (png_byte)(t & 0xff);
            buffer[8*i+6] = (png_byte)((t >> 8) & 0xff);
            buffer[8*i+7] = (png_byte)(t & 0xff);
3401 3402 3403
            ++i;
         }
         return;
3404

3405 3406
      default:
         break;
G
[devel]  
Glenn Randers-Pehrson 已提交
3407 3408 3409 3410 3411
   }

   png_error(pp, "internal error");
}

3412 3413 3414 3415 3416
/* This is just to do the right cast - could be changed to a function to check
 * 'bd' but there isn't much point.
 */
#define DEPTH(bd) ((png_byte)(1U << (bd)))

3417
/* This is just a helper for compiling on minimal systems with no write
3418 3419
 * interlacing support.  If there is no write interlacing we can't generate test
 * cases with interlace:
3420
 */
3421 3422 3423 3424 3425
#ifdef PNG_WRITE_INTERLACING_SUPPORTED
#  define INTERLACE_LAST PNG_INTERLACE_LAST
#  define check_interlace_type(type) ((void)(type))
#else
#  define INTERLACE_LAST (PNG_INTERLACE_NONE+1)
3426
#  define png_set_interlace_handling(a) (1)
3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439

static void
check_interlace_type(int PNG_CONST interlace_type)
{
   if (interlace_type != PNG_INTERLACE_NONE)
   {
      /* This is an internal error - --interlace tests should be skipped, not
       * attempted.
       */
      fprintf(stderr, "pngvalid: no interlace support\n");
      exit(99);
   }
}
3440 3441
#endif

3442 3443 3444 3445 3446 3447
/* Make a standardized image given a an image colour type, bit depth and
 * interlace type.  The standard images have a very restricted range of
 * rows and heights and are used for testing transforms rather than image
 * layout details.  See make_size_images below for a way to make images
 * that test odd sizes along with the libpng interlace handling.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
3448
static void
3449
make_transform_image(png_store* PNG_CONST ps, png_byte PNG_CONST colour_type,
3450 3451
    png_byte PNG_CONST bit_depth, unsigned int palette_number,
    int interlace_type, png_const_charp name)
G
[devel]  
Glenn Randers-Pehrson 已提交
3452
{
3453
   context(ps, fault);
3454

3455 3456
   check_interlace_type(interlace_type);

3457
   Try
G
[devel]  
Glenn Randers-Pehrson 已提交
3458 3459
   {
      png_infop pi;
3460 3461 3462 3463 3464 3465 3466 3467 3468 3469
      png_structp pp = set_store_for_write(ps, &pi, name);
      png_uint_32 h;

      /* In the event of a problem return control to the Catch statement below
       * to do the clean up - it is not possible to 'return' directly from a Try
       * block.
       */
      if (pp == NULL)
         Throw ps;

3470
      h = transform_height(pp, colour_type, bit_depth);
G
[devel]  
Glenn Randers-Pehrson 已提交
3471

3472
      png_set_IHDR(pp, pi, transform_width(pp, colour_type, bit_depth), h,
3473 3474 3475
         bit_depth, colour_type, interlace_type,
         PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);

3476
#ifdef PNG_TEXT_SUPPORTED
3477 3478 3479 3480 3481
#  if defined(PNG_READ_zTXt_SUPPORTED) && defined(PNG_WRITE_zTXt_SUPPORTED)
#     define TEXT_COMPRESSION PNG_TEXT_COMPRESSION_zTXt
#  else
#     define TEXT_COMPRESSION PNG_TEXT_COMPRESSION_NONE
#  endif
3482 3483 3484 3485 3486 3487 3488 3489 3490
      {
         static char key[] = "image name"; /* must be writeable */
         size_t pos;
         png_text text;
         char copy[FILE_NAME_SIZE];

         /* Use a compressed text string to test the correct interaction of text
          * compression and IDAT compression.
          */
3491
         text.compression = TEXT_COMPRESSION;
3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504
         text.key = key;
         /* Yuck: the text must be writable! */
         pos = safecat(copy, sizeof copy, 0, ps->wname);
         text.text = copy;
         text.text_length = pos;
         text.itxt_length = 0;
         text.lang = 0;
         text.lang_key = 0;

         png_set_text(pp, pi, &text, 1);
      }
#endif

3505
      if (colour_type == 3) /* palette */
3506
         init_standard_palette(ps, pp, pi, 1U << bit_depth, 1/*do tRNS*/);
G
[devel]  
Glenn Randers-Pehrson 已提交
3507

3508
      png_write_info(pp, pi);
G
[devel]  
Glenn Randers-Pehrson 已提交
3509

3510
      if (png_get_rowbytes(pp, pi) !=
3511
          transform_rowsize(pp, colour_type, bit_depth))
3512 3513 3514
         png_error(pp, "row size incorrect");

      else
G
[devel]  
Glenn Randers-Pehrson 已提交
3515
      {
3516
         /* Somewhat confusingly this must be called *after* png_write_info
3517
          * because if it is called before, the information in *pp has not been
3518 3519 3520 3521
          * updated to reflect the interlaced image.
          */
         int npasses = png_set_interlace_handling(pp);
         int pass;
G
[devel]  
Glenn Randers-Pehrson 已提交
3522

3523 3524
         if (npasses != npasses_from_interlace_type(pp, interlace_type))
            png_error(pp, "write: png_set_interlace_handling failed");
G
[devel]  
Glenn Randers-Pehrson 已提交
3525

3526
         for (pass=0; pass<npasses; ++pass)
3527
         {
3528
            png_uint_32 y;
G
[devel]  
Glenn Randers-Pehrson 已提交
3529

3530 3531
            for (y=0; y<h; ++y)
            {
3532
               png_byte buffer[TRANSFORM_ROWMAX];
G
[devel]  
Glenn Randers-Pehrson 已提交
3533

3534
               transform_row(pp, buffer, colour_type, bit_depth, y);
3535 3536
               png_write_row(pp, buffer);
            }
3537
         }
3538
      }
G
[devel]  
Glenn Randers-Pehrson 已提交
3539

3540 3541 3542 3543 3544 3545 3546 3547 3548
#ifdef PNG_TEXT_SUPPORTED
      {
         static char key[] = "end marker";
         static char comment[] = "end";
         png_text text;

         /* Use a compressed text string to test the correct interaction of text
          * compression and IDAT compression.
          */
3549
         text.compression = TEXT_COMPRESSION;
3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560
         text.key = key;
         text.text = comment;
         text.text_length = (sizeof comment)-1;
         text.itxt_length = 0;
         text.lang = 0;
         text.lang_key = 0;

         png_set_text(pp, pi, &text, 1);
      }
#endif

3561
      png_write_end(pp, pi);
3562

3563
      /* And store this under the appropriate id, then clean up. */
3564 3565
      store_storefile(ps, FILEID(colour_type, bit_depth, palette_number,
         interlace_type, 0, 0, 0));
3566

3567 3568
      store_write_reset(ps);
   }
3569

3570 3571
   Catch(fault)
   {
3572
      /* Use the png_store returned by the exception. This may help the compiler
3573 3574 3575 3576
       * because 'ps' is not used in this branch of the setjmp.  Note that fault
       * and ps will always be the same value.
       */
      store_write_reset(fault);
3577 3578
   }
}
3579

3580
static void
3581
make_transform_images(png_store *ps)
3582
{
3583 3584
   png_byte colour_type = 0;
   png_byte bit_depth = 0;
3585
   unsigned int palette_number = 0;
3586 3587 3588 3589 3590 3591 3592

   /* This is in case of errors. */
   safecat(ps->test, sizeof ps->test, 0, "make standard images");

   /* Use next_format to enumerate all the combinations we test, including
    * generating multiple low bit depth palette images.
    */
3593
   while (next_format(&colour_type, &bit_depth, &palette_number, 0))
3594 3595
   {
      int interlace_type;
3596

3597 3598
      for (interlace_type = PNG_INTERLACE_NONE;
           interlace_type < INTERLACE_LAST; ++interlace_type)
3599
      {
3600 3601
         char name[FILE_NAME_SIZE];

3602 3603 3604 3605
         standard_name(name, sizeof name, 0, colour_type, bit_depth,
            palette_number, interlace_type, 0, 0, 0);
         make_transform_image(ps, colour_type, bit_depth, palette_number,
            interlace_type, name);
3606
      }
G
[devel]  
Glenn Randers-Pehrson 已提交
3607 3608 3609
   }
}

3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632
/* The following two routines use the PNG interlace support macros from
 * png.h to interlace or deinterlace rows.
 */
static void
interlace_row(png_bytep buffer, png_const_bytep imageRow,
   unsigned int pixel_size, png_uint_32 w, int pass)
{
   png_uint_32 xin, xout, xstep;

   /* Note that this can, trivially, be optimized to a memcpy on pass 7, the
    * code is presented this way to make it easier to understand.  In practice
    * consult the code in the libpng source to see other ways of doing this.
    */
   xin = PNG_PASS_START_COL(pass);
   xstep = 1U<<PNG_PASS_COL_SHIFT(pass);

   for (xout=0; xin<w; xin+=xstep)
   {
      pixel_copy(buffer, xout, imageRow, xin, pixel_size);
      ++xout;
   }
}

3633
#ifdef PNG_READ_SUPPORTED
3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653
static void
deinterlace_row(png_bytep buffer, png_const_bytep row,
   unsigned int pixel_size, png_uint_32 w, int pass)
{
   /* The inverse of the above, 'row' is part of row 'y' of the output image,
    * in 'buffer'.  The image is 'w' wide and this is pass 'pass', distribute
    * the pixels of row into buffer and return the number written (to allow
    * this to be checked).
    */
   png_uint_32 xin, xout, xstep;

   xout = PNG_PASS_START_COL(pass);
   xstep = 1U<<PNG_PASS_COL_SHIFT(pass);

   for (xin=0; xout<w; xout+=xstep)
   {
      pixel_copy(buffer, xout, row, xin, pixel_size);
      ++xin;
   }
}
3654
#endif /* PNG_READ_SUPPORTED */
3655

3656
/* Build a single row for the 'size' test images; this fills in only the
3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687
 * first bit_width bits of the sample row.
 */
static void
size_row(png_byte buffer[SIZE_ROWMAX], png_uint_32 bit_width, png_uint_32 y)
{
   /* height is in the range 1 to 16, so: */
   y = ((y & 1) << 7) + ((y & 2) << 6) + ((y & 4) << 5) + ((y & 8) << 4);
   /* the following ensures bits are set in small images: */
   y ^= 0xA5;

   while (bit_width >= 8)
      *buffer++ = (png_byte)y++, bit_width -= 8;

   /* There may be up to 7 remaining bits, these go in the most significant
    * bits of the byte.
    */
   if (bit_width > 0)
   {
      png_uint_32 mask = (1U<<(8-bit_width))-1;
      *buffer = (png_byte)((*buffer & mask) | (y & ~mask));
   }
}

static void
make_size_image(png_store* PNG_CONST ps, png_byte PNG_CONST colour_type,
    png_byte PNG_CONST bit_depth, int PNG_CONST interlace_type,
    png_uint_32 PNG_CONST w, png_uint_32 PNG_CONST h,
    int PNG_CONST do_interlace)
{
   context(ps, fault);

3688 3689 3690 3691 3692 3693
   /* At present libpng does not support the write of an interlaced image unless
    * PNG_WRITE_INTERLACING_SUPPORTED, even with do_interlace so the code here
    * does the pixel interlace itself, so:
    */
   check_interlace_type(interlace_type);

3694 3695 3696
   Try
   {
      png_infop pi;
3697
      png_structp pp;
3698
      unsigned int pixel_size;
3699 3700 3701

      /* Make a name and get an appropriate id for the store: */
      char name[FILE_NAME_SIZE];
3702 3703
      PNG_CONST png_uint_32 id = FILEID(colour_type, bit_depth, 0/*palette*/,
         interlace_type, w, h, do_interlace);
3704 3705 3706

      standard_name_from_id(name, sizeof name, 0, id);
      pp = set_store_for_write(ps, &pi, name);
3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717

      /* In the event of a problem return control to the Catch statement below
       * to do the clean up - it is not possible to 'return' directly from a Try
       * block.
       */
      if (pp == NULL)
         Throw ps;

      png_set_IHDR(pp, pi, w, h, bit_depth, colour_type, interlace_type,
         PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);

3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741
#ifdef PNG_TEXT_SUPPORTED
      {
         static char key[] = "image name"; /* must be writeable */
         size_t pos;
         png_text text;
         char copy[FILE_NAME_SIZE];

         /* Use a compressed text string to test the correct interaction of text
          * compression and IDAT compression.
          */
         text.compression = TEXT_COMPRESSION;
         text.key = key;
         /* Yuck: the text must be writable! */
         pos = safecat(copy, sizeof copy, 0, ps->wname);
         text.text = copy;
         text.text_length = pos;
         text.itxt_length = 0;
         text.lang = 0;
         text.lang_key = 0;

         png_set_text(pp, pi, &text, 1);
      }
#endif

3742
      if (colour_type == 3) /* palette */
3743
         init_standard_palette(ps, pp, pi, 1U << bit_depth, 0/*do tRNS*/);
3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759

      png_write_info(pp, pi);

      /* Calculate the bit size, divide by 8 to get the byte size - this won't
       * overflow because we know the w values are all small enough even for
       * a system where 'unsigned int' is only 16 bits.
       */
      pixel_size = bit_size(pp, colour_type, bit_depth);
      if (png_get_rowbytes(pp, pi) != ((w * pixel_size) + 7) / 8)
         png_error(pp, "row size incorrect");

      else
      {
         int npasses = npasses_from_interlace_type(pp, interlace_type);
         png_uint_32 y;
         int pass;
3760 3761 3762
#        ifdef PNG_WRITE_FILTER_SUPPORTED
            int nfilter = PNG_FILTER_VALUE_LAST;
#        endif
3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791
         png_byte image[16][SIZE_ROWMAX];

         /* To help consistent error detection make the parts of this buffer
          * that aren't set below all '1':
          */
         memset(image, 0xff, sizeof image);

         if (!do_interlace && npasses != png_set_interlace_handling(pp))
            png_error(pp, "write: png_set_interlace_handling failed");

         /* Prepare the whole image first to avoid making it 7 times: */
         for (y=0; y<h; ++y)
            size_row(image[y], w * pixel_size, y);

         for (pass=0; pass<npasses; ++pass)
         {
            /* The following two are for checking the macros: */
            PNG_CONST png_uint_32 wPass = PNG_PASS_COLS(w, pass);

            /* If do_interlace is set we don't call png_write_row for every
             * row because some of them are empty.  In fact, for a 1x1 image,
             * most of them are empty!
             */
            for (y=0; y<h; ++y)
            {
               png_const_bytep row = image[y];
               png_byte tempRow[SIZE_ROWMAX];

               /* If do_interlace *and* the image is interlaced we
3792
                * need a reduced interlace row; this may be reduced
3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815
                * to empty.
                */
               if (do_interlace && interlace_type == PNG_INTERLACE_ADAM7)
               {
                  /* The row must not be written if it doesn't exist, notice
                   * that there are two conditions here, either the row isn't
                   * ever in the pass or the row would be but isn't wide
                   * enough to contribute any pixels.  In fact the wPass test
                   * can be used to skip the whole y loop in this case.
                   */
                  if (PNG_ROW_IN_INTERLACE_PASS(y, pass) && wPass > 0)
                  {
                     /* Set to all 1's for error detection (libpng tends to
                      * set unset things to 0).
                      */
                     memset(tempRow, 0xff, sizeof tempRow);
                     interlace_row(tempRow, row, pixel_size, w, pass);
                     row = tempRow;
                  }
                  else
                     continue;
               }

3816
#           ifdef PNG_WRITE_FILTER_SUPPORTED
3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831
               /* Only get to here if the row has some pixels in it, set the
                * filters to 'all' for the very first row and thereafter to a
                * single filter.  It isn't well documented, but png_set_filter
                * does accept a filter number (per the spec) as well as a bit
                * mask.
                *
                * The apparent wackiness of decrementing nfilter rather than
                * incrementing is so that Paeth gets used in all images bigger
                * than 1 row - it's the tricky one.
                */
               png_set_filter(pp, 0/*method*/,
                  nfilter >= PNG_FILTER_VALUE_LAST ? PNG_ALL_FILTERS : nfilter);

               if (nfilter-- == 0)
                  nfilter = PNG_FILTER_VALUE_LAST-1;
3832
#           endif
3833

3834 3835 3836 3837 3838
               png_write_row(pp, row);
            }
         }
      }

3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859
#ifdef PNG_TEXT_SUPPORTED
      {
         static char key[] = "end marker";
         static char comment[] = "end";
         png_text text;

         /* Use a compressed text string to test the correct interaction of text
          * compression and IDAT compression.
          */
         text.compression = TEXT_COMPRESSION;
         text.key = key;
         text.text = comment;
         text.text_length = (sizeof comment)-1;
         text.itxt_length = 0;
         text.lang = 0;
         text.lang_key = 0;

         png_set_text(pp, pi, &text, 1);
      }
#endif

3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899
      png_write_end(pp, pi);

      /* And store this under the appropriate id, then clean up. */
      store_storefile(ps, id);

      store_write_reset(ps);
   }

   Catch(fault)
   {
      /* Use the png_store returned by the exception. This may help the compiler
       * because 'ps' is not used in this branch of the setjmp.  Note that fault
       * and ps will always be the same value.
       */
      store_write_reset(fault);
   }
}

static void
make_size(png_store* PNG_CONST ps, png_byte PNG_CONST colour_type, int bdlo,
    int PNG_CONST bdhi)
{
   for (; bdlo <= bdhi; ++bdlo)
   {
      png_uint_32 width;

      for (width = 1; width <= 16; ++width)
      {
         png_uint_32 height;

         for (height = 1; height <= 16; ++height)
         {
            /* The four combinations of DIY interlace and interlace or not -
             * no interlace + DIY should be identical to no interlace with
             * libpng doing it.
             */
            make_size_image(ps, colour_type, DEPTH(bdlo), PNG_INTERLACE_NONE,
               width, height, 0);
            make_size_image(ps, colour_type, DEPTH(bdlo), PNG_INTERLACE_NONE,
               width, height, 1);
3900
#        ifdef PNG_WRITE_INTERLACING_SUPPORTED
3901 3902 3903 3904
            make_size_image(ps, colour_type, DEPTH(bdlo), PNG_INTERLACE_ADAM7,
               width, height, 0);
            make_size_image(ps, colour_type, DEPTH(bdlo), PNG_INTERLACE_ADAM7,
               width, height, 1);
3905
#        endif
3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925
         }
      }
   }
}

static void
make_size_images(png_store *ps)
{
   /* This is in case of errors. */
   safecat(ps->test, sizeof ps->test, 0, "make size images");

   /* Arguments are colour_type, low bit depth, high bit depth
    */
   make_size(ps, 0, 0, WRITE_BDHI);
   make_size(ps, 2, 3, WRITE_BDHI);
   make_size(ps, 3, 0, 3 /*palette: max 8 bits*/);
   make_size(ps, 4, 3, WRITE_BDHI);
   make_size(ps, 6, 3, WRITE_BDHI);
}

3926
#ifdef PNG_READ_SUPPORTED
3927 3928
/* Return a row based on image id and 'y' for checking: */
static void
3929 3930
standard_row(png_const_structp pp, png_byte std[STANDARD_ROWMAX],
   png_uint_32 id, png_uint_32 y)
3931 3932 3933 3934 3935 3936 3937
{
   if (WIDTH_FROM_ID(id) == 0)
      transform_row(pp, std, COL_FROM_ID(id), DEPTH_FROM_ID(id), y);
   else
      size_row(std, WIDTH_FROM_ID(id) * bit_size(pp, COL_FROM_ID(id),
         DEPTH_FROM_ID(id)), y);
}
3938
#endif /* PNG_READ_SUPPORTED */
3939

G
[devel]  
Glenn Randers-Pehrson 已提交
3940
/* Tests - individual test cases */
3941 3942 3943 3944
/* Like 'make_standard' but errors are deliberately introduced into the calls
 * to ensure that they get detected - it should not be possible to write an
 * invalid image with libpng!
 */
3945 3946 3947
/* TODO: the 'set' functions can probably all be made to take a
 * png_const_structp rather than a modifiable one.
 */
3948
#ifdef PNG_WARNINGS_SUPPORTED
3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975
static void
sBIT0_error_fn(png_structp pp, png_infop pi)
{
   /* 0 is invalid... */
   png_color_8 bad;
   bad.red = bad.green = bad.blue = bad.gray = bad.alpha = 0;
   png_set_sBIT(pp, pi, &bad);
}

static void
sBIT_error_fn(png_structp pp, png_infop pi)
{
   png_byte bit_depth;
   png_color_8 bad;

   if (png_get_color_type(pp, pi) == PNG_COLOR_TYPE_PALETTE)
      bit_depth = 8;

   else
      bit_depth = png_get_bit_depth(pp, pi);

   /* Now we know the bit depth we can easily generate an invalid sBIT entry */
   bad.red = bad.green = bad.blue = bad.gray = bad.alpha =
      (png_byte)(bit_depth+1);
   png_set_sBIT(pp, pi, &bad);
}

3976
static PNG_CONST struct
3977 3978 3979 3980 3981 3982
{
   void          (*fn)(png_structp, png_infop);
   PNG_CONST char *msg;
   unsigned int    warning :1; /* the error is a warning... */
} error_test[] =
    {
3983
       /* no warnings makes these errors undetectable. */
3984 3985 3986 3987 3988
       { sBIT0_error_fn, "sBIT(0): failed to detect error", 1 },
       { sBIT_error_fn, "sBIT(too big): failed to detect error", 1 },
    };

static void
3989
make_error(png_store* volatile psIn, png_byte PNG_CONST colour_type,
3990
    png_byte bit_depth, int interlace_type, int test, png_const_charp name)
3991
{
3992 3993
   png_store * volatile ps = psIn;

3994
   context(ps, fault);
3995

3996 3997
   check_interlace_type(interlace_type);

3998 3999 4000 4001
   Try
   {
      png_structp pp;
      png_infop pi;
4002

4003
      pp = set_store_for_write(ps, &pi, name);
4004

4005 4006
      if (pp == NULL)
         Throw ps;
4007

4008 4009
      png_set_IHDR(pp, pi, transform_width(pp, colour_type, bit_depth),
         transform_height(pp, colour_type, bit_depth), bit_depth, colour_type,
4010
         interlace_type, PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
4011

4012
      if (colour_type == 3) /* palette */
4013
         init_standard_palette(ps, pp, pi, 1U << bit_depth, 0/*do tRNS*/);
4014

4015
      /* Time for a few errors; these are in various optional chunks, the
4016 4017
       * standard tests test the standard chunks pretty well.
       */
4018 4019
#     define exception__prev exception_prev_1
#     define exception__env exception_env_1
4020 4021 4022 4023 4024 4025 4026
      Try
      {
         /* Expect this to throw: */
         ps->expect_error = !error_test[test].warning;
         ps->expect_warning = error_test[test].warning;
         ps->saw_warning = 0;
         error_test[test].fn(pp, pi);
4027

4028 4029
         /* Normally the error is only detected here: */
         png_write_info(pp, pi);
4030

4031 4032 4033
         /* And handle the case where it was only a warning: */
         if (ps->expect_warning && ps->saw_warning)
            Throw ps;
4034

4035 4036
         /* If we get here there is a problem, we have success - no error or
          * no warning - when we shouldn't have success.  Log an error.
4037
          */
4038
         store_log(ps, pp, error_test[test].msg, 1 /*error*/);
4039
      }
4040

4041
      Catch (fault)
4042
         ps = fault; /* expected exit, make sure ps is not clobbered */
4043 4044
#undef exception__prev
#undef exception__env
4045

4046 4047
      /* And clear these flags */
      ps->expect_error = 0;
4048
      ps->expect_warning = 0;
4049

4050 4051 4052 4053
      /* Now write the whole image, just to make sure that the detected, or
       * undetected, errro has not created problems inside libpng.
       */
      if (png_get_rowbytes(pp, pi) !=
4054
          transform_rowsize(pp, colour_type, bit_depth))
4055
         png_error(pp, "row size incorrect");
4056

4057 4058
      else
      {
4059
         png_uint_32 h = transform_height(pp, colour_type, bit_depth);
4060 4061 4062 4063 4064 4065
         int npasses = png_set_interlace_handling(pp);
         int pass;

         if (npasses != npasses_from_interlace_type(pp, interlace_type))
            png_error(pp, "write: png_set_interlace_handling failed");

4066
         for (pass=0; pass<npasses; ++pass)
4067 4068
         {
            png_uint_32 y;
4069

4070
            for (y=0; y<h; ++y)
4071
            {
4072
               png_byte buffer[TRANSFORM_ROWMAX];
4073

4074
               transform_row(pp, buffer, colour_type, bit_depth, y);
4075 4076
               png_write_row(pp, buffer);
            }
4077 4078
         }
      }
4079

4080
      png_write_end(pp, pi);
4081

4082 4083 4084
      /* The following deletes the file that was just written. */
      store_write_reset(ps);
   }
4085

4086 4087
   Catch(fault)
   {
4088
      store_write_reset(fault);
4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099
   }
}

static int
make_errors(png_modifier* PNG_CONST pm, png_byte PNG_CONST colour_type,
    int bdlo, int PNG_CONST bdhi)
{
   for (; bdlo <= bdhi; ++bdlo)
   {
      int interlace_type;

4100 4101
      for (interlace_type = PNG_INTERLACE_NONE;
           interlace_type < INTERLACE_LAST; ++interlace_type)
4102 4103 4104 4105
      {
         unsigned int test;
         char name[FILE_NAME_SIZE];

4106 4107
         standard_name(name, sizeof name, 0, colour_type, 1<<bdlo, 0,
            interlace_type, 0, 0, 0);
4108 4109

         for (test=0; test<(sizeof error_test)/(sizeof error_test[0]); ++test)
4110
         {
4111 4112
            make_error(&pm->this, colour_type, DEPTH(bdlo), interlace_type,
               test, name);
4113

4114 4115
            if (fail(pm))
               return 0;
4116 4117
         }
      }
4118 4119 4120
   }

   return 1; /* keep going */
4121
}
4122
#endif /* PNG_WARNINGS_SUPPORTED */
4123 4124 4125 4126

static void
perform_error_test(png_modifier *pm)
{
4127
#ifdef PNG_WARNINGS_SUPPORTED /* else there are no cases that work! */
4128 4129 4130
   /* Need to do this here because we just write in this test. */
   safecat(pm->this.test, sizeof pm->this.test, 0, "error test");

4131
   if (!make_errors(pm, 0, 0, WRITE_BDHI))
4132 4133
      return;

4134
   if (!make_errors(pm, 2, 3, WRITE_BDHI))
4135 4136
      return;

4137
   if (!make_errors(pm, 3, 0, 3))
4138 4139
      return;

4140
   if (!make_errors(pm, 4, 3, WRITE_BDHI))
4141 4142
      return;

4143
   if (!make_errors(pm, 6, 3, WRITE_BDHI))
4144
      return;
4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165
#else
   UNUSED(pm)
#endif
}

/* This is just to validate the internal PNG formatting code - if this fails
 * then the warning messages the library outputs will probably be garbage.
 */
static void
perform_formatting_test(png_store *volatile ps)
{
#ifdef PNG_TIME_RFC1123_SUPPORTED
   /* The handle into the formatting code is the RFC1123 support; this test does
    * nothing if that is compiled out.
    */
   context(ps, fault);

   Try
   {
      png_const_charp correct = "29 Aug 2079 13:53:60 +0000";
      png_const_charp result;
4166 4167 4168
#     if PNG_LIBPNG_VER >= 10600
         char timestring[29];
#     endif
4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185
      png_structp pp;
      png_time pt;

      pp = set_store_for_write(ps, NULL, "libpng formatting test");

      if (pp == NULL)
         Throw ps;


      /* Arbitrary settings: */
      pt.year = 2079;
      pt.month = 8;
      pt.day = 29;
      pt.hour = 13;
      pt.minute = 53;
      pt.second = 60; /* a leap second */

4186 4187 4188 4189 4190 4191 4192 4193 4194
#     if PNG_LIBPNG_VER < 10600
         result = png_convert_to_rfc1123(pp, &pt);
#     else
         if (png_convert_to_rfc1123_buffer(timestring, &pt))
            result = timestring;

         else
            result = NULL;
#     endif
4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222

      if (result == NULL)
         png_error(pp, "png_convert_to_rfc1123 failed");

      if (strcmp(result, correct) != 0)
      {
         size_t pos = 0;
         char msg[128];

         pos = safecat(msg, sizeof msg, pos, "png_convert_to_rfc1123(");
         pos = safecat(msg, sizeof msg, pos, correct);
         pos = safecat(msg, sizeof msg, pos, ") returned: '");
         pos = safecat(msg, sizeof msg, pos, result);
         pos = safecat(msg, sizeof msg, pos, "'");

         png_error(pp, msg);
      }

      store_write_reset(ps);
   }

   Catch(fault)
   {
      store_write_reset(fault);
   }
#else
   UNUSED(ps)
#endif
4223 4224
}

4225
#ifdef PNG_READ_SUPPORTED
4226 4227 4228 4229 4230 4231
/* Because we want to use the same code in both the progressive reader and the
 * sequential reader it is necessary to deal with the fact that the progressive
 * reader callbacks only have one parameter (png_get_progressive_ptr()), so this
 * must contain all the test parameters and all the local variables directly
 * accessible to the sequential reader implementation.
 *
4232
 * The technique adopted is to reinvent part of what Dijkstra termed a
4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247
 * 'display'; an array of pointers to the stack frames of enclosing functions so
 * that a nested function definition can access the local (C auto) variables of
 * the functions that contain its definition.  In fact C provides the first
 * pointer (the local variables - the stack frame pointer) and the last (the
 * global variables - the BCPL global vector typically implemented as global
 * addresses), this code requires one more pointer to make the display - the
 * local variables (and function call parameters) of the function that actually
 * invokes either the progressive or sequential reader.
 *
 * Perhaps confusingly this technique is confounded with classes - the
 * 'standard_display' defined here is sub-classed as the 'gamma_display' below.
 * A gamma_display is a standard_display, taking advantage of the ANSI-C
 * requirement that the pointer to the first member of a structure must be the
 * same as the pointer to the structure.  This allows us to reuse standard_
 * functions in the gamma test code; something that could not be done with
4248
 * nested functions!
4249 4250 4251 4252 4253 4254
 */
typedef struct standard_display
{
   png_store*  ps;             /* Test parameters (passed to the function) */
   png_byte    colour_type;
   png_byte    bit_depth;
4255 4256 4257 4258
   png_byte    red_sBIT;       /* Input data sBIT values. */
   png_byte    green_sBIT;
   png_byte    blue_sBIT;
   png_byte    alpha_sBIT;
4259 4260 4261 4262 4263
   int         interlace_type;
   png_uint_32 id;             /* Calculated file ID */
   png_uint_32 w;              /* Width of image */
   png_uint_32 h;              /* Height of image */
   int         npasses;        /* Number of interlaced passes */
4264 4265 4266 4267
   png_uint_32 pixel_size;     /* Width of one pixel in bits */
   png_uint_32 bit_width;      /* Width of output row in bits */
   size_t      cbRow;          /* Bytes in a row of the output image */
   int         do_interlace;   /* Do interlacing internally */
4268 4269
   int         is_transparent; /* Transparency information was present. */
   int         speed;          /* Doing a speed test */
4270
   int         use_update_info;/* Call update_info, not start_image */
4271 4272 4273 4274 4275 4276
   struct
   {
      png_uint_16 red;
      png_uint_16 green;
      png_uint_16 blue;
   }           transparent;    /* The transparent color, if set. */
4277 4278
   int         npalette;       /* Number of entries in the palette. */
   store_palette
4279
               palette;
4280 4281
} standard_display;

4282
static void
4283
standard_display_init(standard_display *dp, png_store* ps, png_uint_32 id,
4284
   int do_interlace, int use_update_info)
4285
{
4286 4287
   memset(dp, 0, sizeof *dp);

4288
   dp->ps = ps;
4289 4290
   dp->colour_type = COL_FROM_ID(id);
   dp->bit_depth = DEPTH_FROM_ID(id);
4291 4292
   if (dp->bit_depth < 1 || dp->bit_depth > 16)
      internal_error(ps, "internal: bad bit depth");
4293 4294 4295 4296 4297
   if (dp->colour_type == 3)
      dp->red_sBIT = dp->blue_sBIT = dp->green_sBIT = dp->alpha_sBIT = 8;
   else
      dp->red_sBIT = dp->blue_sBIT = dp->green_sBIT = dp->alpha_sBIT =
         dp->bit_depth;
4298
   dp->interlace_type = INTERLACE_FROM_ID(id);
4299
   check_interlace_type(dp->interlace_type);
4300 4301
   dp->id = id;
   /* All the rest are filled in after the read_info: */
4302 4303 4304
   dp->w = 0;
   dp->h = 0;
   dp->npasses = 0;
4305 4306
   dp->pixel_size = 0;
   dp->bit_width = 0;
4307
   dp->cbRow = 0;
4308
   dp->do_interlace = do_interlace;
4309
   dp->is_transparent = 0;
4310
   dp->speed = ps->speed;
4311
   dp->use_update_info = use_update_info;
4312
   dp->npalette = 0;
4313 4314 4315 4316
   /* Preset the transparent color to black: */
   memset(&dp->transparent, 0, sizeof dp->transparent);
   /* Preset the palette to full intensity/opaque througout: */
   memset(dp->palette, 0xff, sizeof dp->palette);
4317 4318
}

4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352
/* Initialize the palette fields - this must be done later because the palette
 * comes from the particular png_store_file that is selected.
 */
static void
standard_palette_init(standard_display *dp)
{
   store_palette_entry *palette = store_current_palette(dp->ps, &dp->npalette);

   /* The remaining entries remain white/opaque. */
   if (dp->npalette > 0)
   {
      int i = dp->npalette;
      memcpy(dp->palette, palette, i * sizeof *palette);

      /* Check for a non-opaque palette entry: */
      while (--i >= 0)
         if (palette[i].alpha < 255)
            break;

#     ifdef __GNUC__
         /* GCC can't handle the more obviously optimizable version. */
         if (i >= 0)
            dp->is_transparent = 1;
         else
            dp->is_transparent = 0;
#     else
         dp->is_transparent = (i >= 0);
#     endif
   }
}

/* Utility to read the palette from the PNG file and convert it into
 * store_palette format.  This returns 1 if there is any transparency in the
 * palette (it does not check for a transparent colour in the non-palette case.)
4353 4354
 */
static int
4355 4356
read_palette(store_palette palette, int *npalette, png_const_structp pp,
   png_infop pi)
4357 4358 4359 4360 4361 4362
{
   png_colorp pal;
   png_bytep trans_alpha;
   int num;

   pal = 0;
4363 4364 4365
   *npalette = -1;

   if (png_get_PLTE(pp, pi, &pal, npalette) & PNG_INFO_PLTE)
4366
   {
4367
      int i = *npalette;
4368

4369 4370 4371 4372
      if (i <= 0 || i > 256)
         png_error(pp, "validate: invalid PLTE count");

      while (--i >= 0)
4373 4374 4375 4376 4377 4378
      {
         palette[i].red = pal[i].red;
         palette[i].green = pal[i].green;
         palette[i].blue = pal[i].blue;
      }

4379 4380 4381 4382
      /* Mark the remainder of the entries with a flag value (other than
       * white/opaque which is the flag value stored above.)
       */
      memset(palette + *npalette, 126, (256-*npalette) * sizeof *palette);
4383 4384 4385
   }

   else /* !png_get_PLTE */
4386 4387 4388 4389 4390
   {
      if (*npalette != (-1))
         png_error(pp, "validate: invalid PLTE result");
      /* But there is no palette, so record this: */
      *npalette = 0;
4391
      memset(palette, 113, sizeof (store_palette));
4392
   }
4393 4394

   trans_alpha = 0;
4395 4396 4397 4398
   num = 2; /* force error below */
   if ((png_get_tRNS(pp, pi, &trans_alpha, &num, 0) & PNG_INFO_tRNS) != 0 &&
      (trans_alpha != NULL || num != 1/*returns 1 for a transparent color*/) &&
      /* Oops, if a palette tRNS gets expanded png_read_update_info (at least so
4399 4400
       * far as 1.5.4) does not remove the trans_alpha pointer, only num_trans,
       * so in the above call we get a success, we get a pointer (who knows what
4401 4402 4403
       * to) and we get num_trans == 0:
       */
      !(trans_alpha != NULL && num == 0)) /* TODO: fix this in libpng. */
4404 4405 4406 4407 4408 4409 4410 4411 4412
   {
      int i;

      /* Any of these are crash-worthy - given the implementation of
       * png_get_tRNS up to 1.5 an app won't crash if it just checks the
       * result above and fails to check that the variables it passed have
       * actually been filled in!  Note that if the app were to pass the
       * last, png_color_16p, variable too it couldn't rely on this.
       */
4413
      if (trans_alpha == NULL || num <= 0 || num > 256 || num > *npalette)
4414 4415 4416 4417 4418
         png_error(pp, "validate: unexpected png_get_tRNS (palette) result");

      for (i=0; i<num; ++i)
         palette[i].alpha = trans_alpha[i];

4419
      for (num=*npalette; i<num; ++i)
4420 4421
         palette[i].alpha = 255;

4422 4423 4424
      for (; i<256; ++i)
         palette[i].alpha = 33; /* flag value */

4425 4426 4427 4428 4429
      return 1; /* transparency */
   }

   else
   {
4430
      /* No palette transparency - just set the alpha channel to opaque. */
4431 4432
      int i;

4433
      for (i=0, num=*npalette; i<num; ++i)
4434 4435
         palette[i].alpha = 255;

4436 4437 4438
      for (; i<256; ++i)
         palette[i].alpha = 55; /* flag value */

4439 4440 4441 4442
      return 0; /* no transparency */
   }
}

4443 4444 4445 4446
/* Utility to validate the palette if it should not have changed (the
 * non-transform case).
 */
static void
4447 4448
standard_palette_validate(standard_display *dp, png_const_structp pp,
   png_infop pi)
4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479
{
   int npalette;
   store_palette palette;

   if (read_palette(palette, &npalette, pp, pi) != dp->is_transparent)
      png_error(pp, "validate: palette transparency changed");

   if (npalette != dp->npalette)
   {
      size_t pos = 0;
      char msg[64];

      pos = safecat(msg, sizeof msg, pos, "validate: palette size changed: ");
      pos = safecatn(msg, sizeof msg, pos, dp->npalette);
      pos = safecat(msg, sizeof msg, pos, " -> ");
      pos = safecatn(msg, sizeof msg, pos, npalette);
      png_error(pp, msg);
   }

   {
      int i = npalette; /* npalette is aliased */

      while (--i >= 0)
         if (palette[i].red != dp->palette[i].red ||
            palette[i].green != dp->palette[i].green ||
            palette[i].blue != dp->palette[i].blue ||
            palette[i].alpha != dp->palette[i].alpha)
            png_error(pp, "validate: PLTE or tRNS chunk changed");
   }
}

4480
/* By passing a 'standard_display' the progressive callbacks can be used
4481
 * directly by the sequential code, the functions suffixed "_imp" are the
4482 4483 4484 4485 4486 4487 4488 4489
 * implementations, the functions without the suffix are the callbacks.
 *
 * The code for the info callback is split into two because this callback calls
 * png_read_update_info or png_start_read_image and what gets called depends on
 * whether the info needs updating (we want to test both calls in pngvalid.)
 */
static void
standard_info_part1(standard_display *dp, png_structp pp, png_infop pi)
4490
{
4491
   if (png_get_bit_depth(pp, pi) != dp->bit_depth)
4492 4493
      png_error(pp, "validate: bit depth changed");

4494
   if (png_get_color_type(pp, pi) != dp->colour_type)
4495 4496 4497 4498 4499
      png_error(pp, "validate: color type changed");

   if (png_get_filter_type(pp, pi) != PNG_FILTER_TYPE_BASE)
      png_error(pp, "validate: filter type changed");

4500
   if (png_get_interlace_type(pp, pi) != dp->interlace_type)
4501 4502 4503 4504 4505
      png_error(pp, "validate: interlacing changed");

   if (png_get_compression_type(pp, pi) != PNG_COMPRESSION_TYPE_BASE)
      png_error(pp, "validate: compression type changed");

4506 4507
   dp->w = png_get_image_width(pp, pi);

4508
   if (dp->w != standard_width(pp, dp->id))
4509 4510 4511 4512
      png_error(pp, "validate: image width changed");

   dp->h = png_get_image_height(pp, pi);

4513
   if (dp->h != standard_height(pp, dp->id))
4514 4515
      png_error(pp, "validate: image height changed");

4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570
   /* Record (but don't check at present) the input sBIT according to the colour
    * type information.
    */
   {
      png_color_8p sBIT = 0;

      if (png_get_sBIT(pp, pi, &sBIT) & PNG_INFO_sBIT)
      {
         int sBIT_invalid = 0;

         if (sBIT == 0)
            png_error(pp, "validate: unexpected png_get_sBIT result");

         if (dp->colour_type & PNG_COLOR_MASK_COLOR)
         {
            if (sBIT->red == 0 || sBIT->red > dp->bit_depth)
               sBIT_invalid = 1;
            else
               dp->red_sBIT = sBIT->red;

            if (sBIT->green == 0 || sBIT->green > dp->bit_depth)
               sBIT_invalid = 1;
            else
               dp->green_sBIT = sBIT->green;

            if (sBIT->blue == 0 || sBIT->blue > dp->bit_depth)
               sBIT_invalid = 1;
            else
               dp->blue_sBIT = sBIT->blue;
         }

         else /* !COLOR */
         {
            if (sBIT->gray == 0 || sBIT->gray > dp->bit_depth)
               sBIT_invalid = 1;
            else
               dp->blue_sBIT = dp->green_sBIT = dp->red_sBIT = sBIT->gray;
         }

         /* All 8 bits in tRNS for a palette image are significant - see the
          * spec.
          */
         if (dp->colour_type & PNG_COLOR_MASK_ALPHA)
         {
            if (sBIT->alpha == 0 || sBIT->alpha > dp->bit_depth)
               sBIT_invalid = 1;
            else
               dp->alpha_sBIT = sBIT->alpha;
         }

         if (sBIT_invalid)
            png_error(pp, "validate: sBIT value out of range");
      }
   }

4571 4572
   /* Important: this is validating the value *before* any transforms have been
    * put in place.  It doesn't matter for the standard tests, where there are
4573
    * no transforms, but it does for other tests where rowbytes may change after
4574 4575
    * png_read_update_info.
    */
4576
   if (png_get_rowbytes(pp, pi) != standard_rowsize(pp, dp->id))
4577 4578
      png_error(pp, "validate: row size changed");

4579 4580
   /* Validate the colour type 3 palette (this can be present on other color
    * types.)
4581
    */
4582
   standard_palette_validate(dp, pp, pi);
4583

4584 4585 4586 4587
   /* In any case always check for a tranparent color (notice that the
    * colour type 3 case must not give a successful return on the get_tRNS call
    * with these arguments!)
    */
4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621
   {
      png_color_16p trans_color = 0;

      if (png_get_tRNS(pp, pi, 0, 0, &trans_color) & PNG_INFO_tRNS)
      {
         if (trans_color == 0)
            png_error(pp, "validate: unexpected png_get_tRNS (color) result");

         switch (dp->colour_type)
         {
         case 0:
            dp->transparent.red = dp->transparent.green = dp->transparent.blue =
               trans_color->gray;
            dp->is_transparent = 1;
            break;

         case 2:
            dp->transparent.red = trans_color->red;
            dp->transparent.green = trans_color->green;
            dp->transparent.blue = trans_color->blue;
            dp->is_transparent = 1;
            break;

         case 3:
            /* Not expected because it should result in the array case
             * above.
             */
            png_error(pp, "validate: unexpected png_get_tRNS result");
            break;

         default:
            png_error(pp, "validate: invalid tRNS chunk with alpha image");
         }
      }
4622 4623 4624 4625
   }

   /* Read the number of passes - expected to match the value used when
    * creating the image (interlaced or not).  This has the side effect of
4626
    * turning on interlace handling (if do_interlace is not set.)
4627
    */
4628 4629
   dp->npasses = npasses_from_interlace_type(pp, dp->interlace_type);
   if (!dp->do_interlace && dp->npasses != png_set_interlace_handling(pp))
4630 4631
      png_error(pp, "validate: file changed interlace type");

4632 4633 4634
   /* Caller calls png_read_update_info or png_start_read_image now, then calls
    * part2.
    */
4635 4636
}

4637 4638 4639 4640
/* This must be called *after* the png_read_update_info call to get the correct
 * 'rowbytes' value, otherwise png_get_rowbytes will refer to the untransformed
 * image.
 */
4641
static void
4642 4643
standard_info_part2(standard_display *dp, png_const_structp pp,
    png_const_infop pi, int nImages)
4644
{
4645
   /* Record cbRow now that it can be found. */
4646 4647 4648
   dp->pixel_size = bit_size(pp, png_get_color_type(pp, pi),
      png_get_bit_depth(pp, pi));
   dp->bit_width = png_get_image_width(pp, pi) * dp->pixel_size;
4649
   dp->cbRow = png_get_rowbytes(pp, pi);
4650

4651 4652 4653 4654
   /* Validate the rowbytes here again. */
   if (dp->cbRow != (dp->bit_width+7)/8)
      png_error(pp, "bad png_get_rowbytes calculation");

4655
   /* Then ensure there is enough space for the output image(s). */
4656
   store_ensure_image(dp->ps, pp, nImages, dp->cbRow, dp->h);
4657 4658 4659
}

static void
4660 4661
standard_info_imp(standard_display *dp, png_structp pp, png_infop pi,
    int nImages)
4662 4663 4664 4665
{
   /* Note that the validation routine has the side effect of turning on
    * interlace handling in the subsequent code.
    */
4666
   standard_info_part1(dp, pp, pi);
4667 4668 4669 4670

   /* And the info callback has to call this (or png_read_update_info - see
    * below in the png_modifier code for that variant.
    */
4671 4672 4673 4674 4675 4676 4677 4678 4679 4680
   if (dp->use_update_info)
   {
      /* For debugging the effect of multiple calls: */
      int i = dp->use_update_info;
      while (i-- > 0)
         png_read_update_info(pp, pi);
   }

   else
      png_start_read_image(pp);
4681 4682 4683 4684

   /* Validate the height, width and rowbytes plus ensure that sufficient buffer
    * exists for decoding the image.
    */
4685 4686 4687
   standard_info_part2(dp, pp, pi, nImages);
}

4688
static void PNGCBAPI
4689 4690
standard_info(png_structp pp, png_infop pi)
{
4691 4692
   standard_display *dp = voidcast(standard_display*,
      png_get_progressive_ptr(pp));
4693 4694 4695 4696

   /* Call with nImages==1 because the progressive reader can only produce one
    * image.
    */
4697
   standard_info_imp(dp, pp, pi, 1 /*only one image*/);
4698 4699
}

4700
static void PNGCBAPI
4701
progressive_row(png_structp ppIn, png_bytep new_row, png_uint_32 y, int pass)
4702
{
4703
   png_const_structp pp = ppIn;
4704 4705
   PNG_CONST standard_display *dp = voidcast(standard_display*,
      png_get_progressive_ptr(pp));
4706 4707

   /* When handling interlacing some rows will be absent in each pass, the
4708 4709 4710
    * callback still gets called, but with a NULL pointer.  This is checked
    * in the 'else' clause below.  We need our own 'cbRow', but we can't call
    * png_get_rowbytes because we got no info structure.
4711 4712 4713
    */
   if (new_row != NULL)
   {
4714 4715 4716 4717 4718 4719
      png_bytep row;

      /* In the case where the reader doesn't do the interlace it gives
       * us the y in the sub-image:
       */
      if (dp->do_interlace && dp->interlace_type == PNG_INTERLACE_ADAM7)
4720
      {
4721
#ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED
4722 4723 4724 4725
         /* Use this opportunity to validate the png 'current' APIs: */
         if (y != png_get_current_row_number(pp))
            png_error(pp, "png_get_current_row_number is broken");

4726 4727
         if (pass != png_get_current_pass_number(pp))
            png_error(pp, "png_get_current_pass_number is broken");
4728
#endif
4729

4730
         y = PNG_ROW_FROM_PASS_ROW(y, pass);
4731
      }
4732 4733 4734 4735 4736

      /* Validate this just in case. */
      if (y >= dp->h)
         png_error(pp, "invalid y to progressive row callback");

4737
      row = store_image_row(dp->ps, pp, 0, y);
4738

4739
#ifdef PNG_READ_INTERLACING_SUPPORTED
4740
      /* Combine the new row into the old: */
4741 4742 4743 4744 4745
      if (dp->do_interlace)
      {
         if (dp->interlace_type == PNG_INTERLACE_ADAM7)
            deinterlace_row(row, new_row, dp->pixel_size, dp->w, pass);
         else
4746
            row_copy(row, new_row, dp->pixel_size * dp->w);
4747 4748 4749
      }
      else
         png_progressive_combine_row(pp, row, new_row);
4750 4751 4752 4753 4754 4755 4756
#endif /* PNG_READ_INTERLACING_SUPPORTED */
   }

#ifdef PNG_READ_INTERLACING_SUPPORTED
   else if (dp->interlace_type == PNG_INTERLACE_ADAM7 &&
       PNG_ROW_IN_INTERLACE_PASS(y, pass) &&
       PNG_PASS_COLS(dp->w, pass) > 0)
4757
      png_error(pp, "missing row in progressive de-interlacing");
4758
#endif /* PNG_READ_INTERLACING_SUPPORTED */
4759 4760
}

4761 4762
static void
sequential_row(standard_display *dp, png_structp pp, png_infop pi,
4763
    PNG_CONST int iImage, PNG_CONST int iDisplay)
4764 4765
{
   PNG_CONST int         npasses = dp->npasses;
4766 4767 4768 4769
   PNG_CONST int         do_interlace = dp->do_interlace &&
      dp->interlace_type == PNG_INTERLACE_ADAM7;
   PNG_CONST png_uint_32 height = standard_height(pp, dp->id);
   PNG_CONST png_uint_32 width = standard_width(pp, dp->id);
4770
   PNG_CONST png_store*  ps = dp->ps;
4771 4772
   int pass;

4773
   for (pass=0; pass<npasses; ++pass)
4774 4775
   {
      png_uint_32 y;
4776
      png_uint_32 wPass = PNG_PASS_COLS(width, pass);
4777

4778
      for (y=0; y<height; ++y)
4779
      {
4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793
         if (do_interlace)
         {
            /* wPass may be zero or this row may not be in this pass.
             * png_read_row must not be called in either case.
             */
            if (wPass > 0 && PNG_ROW_IN_INTERLACE_PASS(y, pass))
            {
               /* Read the row into a pair of temporary buffers, then do the
                * merge here into the output rows.
                */
               png_byte row[STANDARD_ROWMAX], display[STANDARD_ROWMAX];

               /* The following aids (to some extent) error detection - we can
                * see where png_read_row wrote.  Use opposite values in row and
4794 4795 4796
                * display to make this easier.  Don't use 0xff (which is used in
                * the image write code to fill unused bits) or 0 (which is a
                * likely value to overwrite unused bits with).
4797
                */
4798 4799
               memset(row, 0xc5, sizeof row);
               memset(display, 0x5c, sizeof display);
4800 4801 4802

               png_read_row(pp, row, display);

4803 4804 4805
               if (iImage >= 0)
                  deinterlace_row(store_image_row(ps, pp, iImage, y), row,
                     dp->pixel_size, dp->w, pass);
4806

4807 4808 4809
               if (iDisplay >= 0)
                  deinterlace_row(store_image_row(ps, pp, iDisplay, y), display,
                     dp->pixel_size, dp->w, pass);
4810 4811 4812
            }
         }
         else
4813 4814 4815
            png_read_row(pp,
               iImage >= 0 ? store_image_row(ps, pp, iImage, y) : NULL,
               iDisplay >= 0 ? store_image_row(ps, pp, iDisplay, y) : NULL);
4816 4817 4818 4819 4820 4821 4822 4823 4824
      }
   }

   /* And finish the read operation (only really necessary if the caller wants
    * to find additional data in png_info from chunks after the last IDAT.)
    */
   png_read_end(pp, pi);
}

4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908
#ifdef PNG_TEXT_SUPPORTED
static void
standard_check_text(png_const_structp pp, png_const_textp tp,
   png_const_charp keyword, png_const_charp text)
{
   char msg[1024];
   size_t pos = safecat(msg, sizeof msg, 0, "text: ");
   size_t ok;

   pos = safecat(msg, sizeof msg, pos, keyword);
   pos = safecat(msg, sizeof msg, pos, ": ");
   ok = pos;

   if (tp->compression != TEXT_COMPRESSION)
   {
      char buf[64];

      sprintf(buf, "compression [%d->%d], ", TEXT_COMPRESSION,
         tp->compression);
      pos = safecat(msg, sizeof msg, pos, buf);
   }

   if (tp->key == NULL || strcmp(tp->key, keyword) != 0)
   {
      pos = safecat(msg, sizeof msg, pos, "keyword \"");
      if (tp->key != NULL)
      {
         pos = safecat(msg, sizeof msg, pos, tp->key);
         pos = safecat(msg, sizeof msg, pos, "\", ");
      }

      else
         pos = safecat(msg, sizeof msg, pos, "null, ");
   }

   if (tp->text == NULL)
      pos = safecat(msg, sizeof msg, pos, "text lost, ");

   else
   {
      if (tp->text_length != strlen(text))
      {
         char buf[64];
         sprintf(buf, "text length changed[%lu->%lu], ",
            (unsigned long)strlen(text), (unsigned long)tp->text_length);
         pos = safecat(msg, sizeof msg, pos, buf);
      }

      if (strcmp(tp->text, text) != 0)
      {
         pos = safecat(msg, sizeof msg, pos, "text becomes \"");
         pos = safecat(msg, sizeof msg, pos, tp->text);
         pos = safecat(msg, sizeof msg, pos, "\" (was \"");
         pos = safecat(msg, sizeof msg, pos, text);
         pos = safecat(msg, sizeof msg, pos, "\"), ");
      }
   }

   if (tp->itxt_length != 0)
      pos = safecat(msg, sizeof msg, pos, "iTXt length set, ");

   if (tp->lang != NULL)
   {
      pos = safecat(msg, sizeof msg, pos, "iTXt language \"");
      pos = safecat(msg, sizeof msg, pos, tp->lang);
      pos = safecat(msg, sizeof msg, pos, "\", ");
   }

   if (tp->lang_key != NULL)
   {
      pos = safecat(msg, sizeof msg, pos, "iTXt keyword \"");
      pos = safecat(msg, sizeof msg, pos, tp->lang_key);
      pos = safecat(msg, sizeof msg, pos, "\", ");
   }

   if (pos > ok)
   {
      msg[pos-2] = '\0'; /* Remove the ", " at the end */
      png_error(pp, msg);
   }
}

static void
standard_text_validate(standard_display *dp, png_const_structp pp,
4909
   png_infop pi, int check_end)
4910 4911 4912 4913 4914 4915 4916
{
   png_textp tp = NULL;
   png_uint_32 num_text = png_get_text(pp, pi, &tp, NULL);

   if (num_text == 2 && tp != NULL)
   {
      standard_check_text(pp, tp, "image name", dp->ps->current->name);
4917

4918
      /* This exists because prior to 1.5.18 the progressive reader left the
4919 4920 4921 4922 4923
       * png_struct z_stream unreset at the end of the image, so subsequent
       * attempts to use it simply returns Z_STREAM_END.
       */
      if (check_end)
         standard_check_text(pp, tp+1, "end marker", "end");
4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935
   }

   else
   {
      char msg[64];

      sprintf(msg, "expected two text items, got %lu",
         (unsigned long)num_text);
      png_error(pp, msg);
   }
}
#else
4936
#  define standard_text_validate(dp,pp,pi,check_end) ((void)0)
4937 4938
#endif

4939
static void
4940
standard_row_validate(standard_display *dp, png_const_structp pp,
4941
   int iImage, int iDisplay, png_uint_32 y)
4942
{
4943
   int where;
4944 4945
   png_byte std[STANDARD_ROWMAX];

4946 4947 4948 4949
   /* The row must be pre-initialized to the magic number here for the size
    * tests to pass:
    */
   memset(std, 178, sizeof std);
4950 4951 4952 4953 4954 4955
   standard_row(pp, std, dp->id, y);

   /* At the end both the 'row' and 'display' arrays should end up identical.
    * In earlier passes 'row' will be partially filled in, with only the pixels
    * that have been read so far, but 'display' will have those pixels
    * replicated to fill the unread pixels while reading an interlaced image.
4956
#if PNG_LIBPNG_VER < 10506
4957 4958 4959 4960 4961 4962
    * The side effect inside the libpng sequential reader is that the 'row'
    * array retains the correct values for unwritten pixels within the row
    * bytes, while the 'display' array gets bits off the end of the image (in
    * the last byte) trashed.  Unfortunately in the progressive reader the
    * row bytes are always trashed, so we always do a pixel_cmp here even though
    * a memcmp of all cbRow bytes will succeed for the sequential reader.
4963
#endif
4964
    */
4965 4966 4967
   if (iImage >= 0 &&
      (where = pixel_cmp(std, store_image_row(dp->ps, pp, iImage, y),
            dp->bit_width)) != 0)
4968 4969
   {
      char msg[64];
4970 4971
      sprintf(msg, "PNG image row[%lu][%d] changed from %.2x to %.2x",
         (unsigned long)y, where-1, std[where-1],
4972
         store_image_row(dp->ps, pp, iImage, y)[where-1]);
4973 4974 4975
      png_error(pp, msg);
   }

4976
#if PNG_LIBPNG_VER < 10506
4977 4978
   /* In this case use pixel_cmp because we need to compare a partial
    * byte at the end of the row if the row is not an exact multiple
4979 4980
    * of 8 bits wide.  (This is fixed in libpng-1.5.6 and pixel_cmp is
    * changed to match!)
4981
    */
4982
#endif
4983 4984 4985
   if (iDisplay >= 0 &&
      (where = pixel_cmp(std, store_image_row(dp->ps, pp, iDisplay, y),
         dp->bit_width)) != 0)
4986 4987
   {
      char msg[64];
4988 4989
      sprintf(msg, "display  row[%lu][%d] changed from %.2x to %.2x",
         (unsigned long)y, where-1, std[where-1],
4990
         store_image_row(dp->ps, pp, iDisplay, y)[where-1]);
4991 4992 4993 4994 4995
      png_error(pp, msg);
   }
}

static void
4996
standard_image_validate(standard_display *dp, png_const_structp pp, int iImage,
4997
    int iDisplay)
4998 4999 5000
{
   png_uint_32 y;

5001 5002
   if (iImage >= 0)
      store_image_check(dp->ps, pp, iImage);
5003

5004 5005
   if (iDisplay >= 0)
      store_image_check(dp->ps, pp, iDisplay);
5006

5007 5008
   for (y=0; y<dp->h; ++y)
      standard_row_validate(dp, pp, iImage, iDisplay, y);
5009 5010

   /* This avoids false positives if the validation code is never called! */
5011
   dp->ps->validated = 1;
5012 5013
}

5014
static void PNGCBAPI
5015
standard_end(png_structp ppIn, png_infop pi)
5016
{
5017
   png_const_structp pp = ppIn;
5018 5019
   standard_display *dp = voidcast(standard_display*,
      png_get_progressive_ptr(pp));
5020

5021
   UNUSED(pi)
5022 5023 5024 5025

   /* Validate the image - progressive reading only produces one variant for
    * interlaced images.
    */
5026
   standard_text_validate(dp, pp, pi,
5027
      PNG_LIBPNG_VER >= 10518/*check_end: see comments above*/);
5028
   standard_image_validate(dp, pp, 0, -1);
5029 5030
}

5031
/* A single test run checking the standard image to ensure it is not damaged. */
G
[devel]  
Glenn Randers-Pehrson 已提交
5032
static void
5033
standard_test(png_store* PNG_CONST psIn, png_uint_32 PNG_CONST id,
5034
   int do_interlace, int use_update_info)
G
[devel]  
Glenn Randers-Pehrson 已提交
5035
{
5036 5037 5038 5039 5040 5041
   standard_display d;
   context(psIn, fault);

   /* Set up the display (stack frame) variables from the arguments to the
    * function and initialize the locals that are filled in later.
    */
5042
   standard_display_init(&d, psIn, id, do_interlace, use_update_info);
5043

5044 5045 5046
   /* Everything is protected by a Try/Catch.  The functions called also
    * typically have local Try/Catch blocks.
    */
5047 5048
   Try
   {
5049 5050 5051
      png_structp pp;
      png_infop pi;

5052
      /* Get a png_struct for reading the image. This will throw an error if it
5053 5054
       * fails, so we don't need to check the result.
       */
5055
      pp = set_store_for_read(d.ps, &pi, d.id,
5056 5057 5058 5059
         d.do_interlace ?  (d.ps->progressive ?
            "pngvalid progressive deinterlacer" :
            "pngvalid sequential deinterlacer") : (d.ps->progressive ?
               "progressive reader" : "sequential reader"));
G
[devel]  
Glenn Randers-Pehrson 已提交
5060

5061 5062 5063
      /* Initialize the palette correctly from the png_store_file. */
      standard_palette_init(&d);

5064
      /* Introduce the correct read function. */
5065
      if (d.ps->progressive)
5066
      {
5067 5068
         png_set_progressive_read_fn(pp, &d, standard_info, progressive_row,
            standard_end);
5069

5070
         /* Now feed data into the reader until we reach the end: */
5071
         store_progressive_read(d.ps, pp, pi);
5072
      }
5073 5074
      else
      {
5075 5076
         /* Note that this takes the store, not the display. */
         png_set_read_fn(pp, d.ps, store_read);
5077

5078 5079
         /* Check the header values: */
         png_read_info(pp, pi);
5080

5081 5082 5083
         /* The code tests both versions of the images that the sequential
          * reader can produce.
          */
5084
         standard_info_imp(&d, pp, pi, 2 /*images*/);
5085

5086
         /* Need the total bytes in the image below; we can't get to this point
5087 5088 5089
          * unless the PNG file values have been checked against the expected
          * values.
          */
5090
         {
5091
            sequential_row(&d, pp, pi, 0, 1);
5092 5093 5094 5095

            /* After the last pass loop over the rows again to check that the
             * image is correct.
             */
5096
            if (!d.speed)
5097
            {
5098
               standard_text_validate(&d, pp, pi, 1/*check_end*/);
5099
               standard_image_validate(&d, pp, 0, 1);
5100
            }
5101 5102
            else
               d.ps->validated = 1;
5103
         }
5104
      }
5105

5106
      /* Check for validation. */
5107
      if (!d.ps->validated)
5108
         png_error(pp, "image read failed silently");
5109

5110
      /* Successful completion. */
5111
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
5112

5113
   Catch(fault)
5114 5115 5116 5117
      d.ps = fault; /* make sure this hasn't been clobbered. */

   /* In either case clean up the store. */
   store_read_reset(d.ps);
5118
}
G
[devel]  
Glenn Randers-Pehrson 已提交
5119

5120 5121
static int
test_standard(png_modifier* PNG_CONST pm, png_byte PNG_CONST colour_type,
5122
    int bdlo, int PNG_CONST bdhi)
5123 5124 5125
{
   for (; bdlo <= bdhi; ++bdlo)
   {
5126
      int interlace_type;
5127

5128
      for (interlace_type = PNG_INTERLACE_NONE;
5129
           interlace_type < INTERLACE_LAST; ++interlace_type)
5130
      {
5131
         standard_test(&pm->this, FILEID(colour_type, DEPTH(bdlo), 0/*palette*/,
5132
            interlace_type, 0, 0, 0), 0/*do_interlace*/, pm->use_update_info);
5133 5134 5135 5136

         if (fail(pm))
            return 0;
      }
G
[devel]  
Glenn Randers-Pehrson 已提交
5137
   }
5138

5139
   return 1; /* keep going */
G
[devel]  
Glenn Randers-Pehrson 已提交
5140 5141 5142 5143 5144
}

static void
perform_standard_test(png_modifier *pm)
{
5145 5146 5147
   /* Test each colour type over the valid range of bit depths (expressed as
    * log2(bit_depth) in turn, stop as soon as any error is detected.
    */
5148
   if (!test_standard(pm, 0, 0, READ_BDHI))
5149 5150
      return;

5151
   if (!test_standard(pm, 2, 3, READ_BDHI))
5152 5153
      return;

5154
   if (!test_standard(pm, 3, 0, 3))
5155 5156
      return;

5157
   if (!test_standard(pm, 4, 3, READ_BDHI))
5158 5159
      return;

5160
   if (!test_standard(pm, 6, 3, READ_BDHI))
5161
      return;
G
[devel]  
Glenn Randers-Pehrson 已提交
5162 5163 5164
}


5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189
/********************************** SIZE TESTS ********************************/
static int
test_size(png_modifier* PNG_CONST pm, png_byte PNG_CONST colour_type,
    int bdlo, int PNG_CONST bdhi)
{
   /* Run the tests on each combination.
    *
    * NOTE: on my 32 bit x86 each of the following blocks takes
    * a total of 3.5 seconds if done across every combo of bit depth
    * width and height.  This is a waste of time in practice, hence the
    * hinc and winc stuff:
    */
   static PNG_CONST png_byte hinc[] = {1, 3, 11, 1, 5};
   static PNG_CONST png_byte winc[] = {1, 9, 5, 7, 1};
   for (; bdlo <= bdhi; ++bdlo)
   {
      png_uint_32 h, w;

      for (h=1; h<=16; h+=hinc[bdlo]) for (w=1; w<=16; w+=winc[bdlo])
      {
         /* First test all the 'size' images against the sequential
          * reader using libpng to deinterlace (where required.)  This
          * validates the write side of libpng.  There are four possibilities
          * to validate.
          */
5190
         standard_test(&pm->this, FILEID(colour_type, DEPTH(bdlo), 0/*palette*/,
5191 5192
            PNG_INTERLACE_NONE, w, h, 0), 0/*do_interlace*/,
            pm->use_update_info);
5193 5194 5195 5196

         if (fail(pm))
            return 0;

5197
         standard_test(&pm->this, FILEID(colour_type, DEPTH(bdlo), 0/*palette*/,
5198 5199
            PNG_INTERLACE_NONE, w, h, 1), 0/*do_interlace*/,
            pm->use_update_info);
5200 5201 5202 5203

         if (fail(pm))
            return 0;

5204
#     ifdef PNG_WRITE_INTERLACING_SUPPORTED
5205
         standard_test(&pm->this, FILEID(colour_type, DEPTH(bdlo), 0/*palette*/,
5206 5207
            PNG_INTERLACE_ADAM7, w, h, 0), 0/*do_interlace*/,
            pm->use_update_info);
5208 5209 5210 5211

         if (fail(pm))
            return 0;

5212
         standard_test(&pm->this, FILEID(colour_type, DEPTH(bdlo), 0/*palette*/,
5213 5214
            PNG_INTERLACE_ADAM7, w, h, 1), 0/*do_interlace*/,
            pm->use_update_info);
5215 5216 5217

         if (fail(pm))
            return 0;
5218
#     endif
5219 5220 5221 5222 5223

         /* Now validate the interlaced read side - do_interlace true,
          * in the progressive case this does actually make a difference
          * to the code used in the non-interlaced case too.
          */
5224
         standard_test(&pm->this, FILEID(colour_type, DEPTH(bdlo), 0/*palette*/,
5225 5226
            PNG_INTERLACE_NONE, w, h, 0), 1/*do_interlace*/,
            pm->use_update_info);
5227 5228 5229 5230

         if (fail(pm))
            return 0;

5231
#     ifdef PNG_WRITE_INTERLACING_SUPPORTED
5232
         standard_test(&pm->this, FILEID(colour_type, DEPTH(bdlo), 0/*palette*/,
5233 5234
            PNG_INTERLACE_ADAM7, w, h, 0), 1/*do_interlace*/,
            pm->use_update_info);
5235 5236 5237

         if (fail(pm))
            return 0;
5238
#     endif
5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257
      }
   }

   return 1; /* keep going */
}

static void
perform_size_test(png_modifier *pm)
{
   /* Test each colour type over the valid range of bit depths (expressed as
    * log2(bit_depth) in turn, stop as soon as any error is detected.
    */
   if (!test_size(pm, 0, 0, READ_BDHI))
      return;

   if (!test_size(pm, 2, 3, READ_BDHI))
      return;

   /* For the moment don't do the palette test - it's a waste of time when
5258
    * compared to the grayscale test.
5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272
    */
#if 0
   if (!test_size(pm, 3, 0, 3))
      return;
#endif

   if (!test_size(pm, 4, 3, READ_BDHI))
      return;

   if (!test_size(pm, 6, 3, READ_BDHI))
      return;
}


5273
/******************************* TRANSFORM TESTS ******************************/
5274
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
5275 5276 5277 5278 5279 5280
/* A set of tests to validate libpng image transforms.  The possibilities here
 * are legion because the transforms can be combined in a combinatorial
 * fashion.  To deal with this some measure of restraint is required, otherwise
 * the tests would take forever.
 */
typedef struct image_pixel
G
[devel]  
Glenn Randers-Pehrson 已提交
5281
{
5282 5283 5284 5285 5286 5287
   /* A local (pngvalid) representation of a PNG pixel, in all its
    * various forms.
    */
   unsigned int red, green, blue, alpha; /* For non-palette images. */
   unsigned int palette_index;           /* For a palette image. */
   png_byte colour_type;                 /* As in the spec. */
5288 5289
   png_byte bit_depth;                   /* Defines bit size in row */
   png_byte sample_depth;                /* Scale of samples */
5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302
   int      have_tRNS;                   /* tRNS chunk may need processing */

   /* For checking the code calculates double precision floating point values
    * along with an error value, accumulated from the transforms.  Because an
    * sBIT setting allows larger error bounds (indeed, by the spec, apparently
    * up to just less than +/-1 in the scaled value) the *lowest* sBIT for each
    * channel is stored.  This sBIT value is folded in to the stored error value
    * at the end of the application of the transforms to the pixel.
    */
   double   redf, greenf, bluef, alphaf;
   double   rede, greene, bluee, alphae;
   png_byte red_sBIT, green_sBIT, blue_sBIT, alpha_sBIT;
} image_pixel;
G
[devel]  
Glenn Randers-Pehrson 已提交
5303

5304 5305 5306
/* Shared utility function, see below. */
static void
image_pixel_setf(image_pixel *this, unsigned int max)
G
[devel]  
Glenn Randers-Pehrson 已提交
5307
{
5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328
   this->redf = this->red / (double)max;
   this->greenf = this->green / (double)max;
   this->bluef = this->blue / (double)max;
   this->alphaf = this->alpha / (double)max;

   if (this->red < max)
      this->rede = this->redf * DBL_EPSILON;
   else
      this->rede = 0;
   if (this->green < max)
      this->greene = this->greenf * DBL_EPSILON;
   else
      this->greene = 0;
   if (this->blue < max)
      this->bluee = this->bluef * DBL_EPSILON;
   else
      this->bluee = 0;
   if (this->alpha < max)
      this->alphae = this->alphaf * DBL_EPSILON;
   else
      this->alphae = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
5329 5330
}

5331 5332 5333 5334
/* Initialize the structure for the next pixel - call this before doing any
 * transforms and call it for each pixel since all the fields may need to be
 * reset.
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
5335
static void
5336
image_pixel_init(image_pixel *this, png_const_bytep row, png_byte colour_type,
5337
    png_byte bit_depth, png_uint_32 x, store_palette palette)
G
[devel]  
Glenn Randers-Pehrson 已提交
5338
{
5339 5340 5341
   PNG_CONST png_byte sample_depth = (png_byte)(colour_type ==
      PNG_COLOR_TYPE_PALETTE ? 8 : bit_depth);
   PNG_CONST unsigned int max = (1U<<sample_depth)-1;
G
Glenn Randers-Pehrson 已提交
5342

5343 5344 5345 5346 5347 5348 5349 5350
   /* Initially just set everything to the same number and the alpha to opaque.
    * Note that this currently assumes a simple palette where entry x has colour
    * rgb(x,x,x)!
    */
   this->palette_index = this->red = this->green = this->blue =
      sample(row, colour_type, bit_depth, x, 0);
   this->alpha = max;
   this->red_sBIT = this->green_sBIT = this->blue_sBIT = this->alpha_sBIT =
5351 5352 5353 5354 5355 5356 5357 5358 5359
      sample_depth;

   /* Then override as appropriate: */
   if (colour_type == 3) /* palette */
   {
      /* This permits the caller to default to the sample value. */
      if (palette != 0)
      {
         PNG_CONST unsigned int i = this->palette_index;
5360

5361 5362 5363 5364 5365 5366 5367 5368
         this->red = palette[i].red;
         this->green = palette[i].green;
         this->blue = palette[i].blue;
         this->alpha = palette[i].alpha;
      }
   }

   else /* not palette */
5369
   {
5370 5371 5372 5373 5374 5375 5376 5377 5378 5379
      unsigned int i = 0;

      if (colour_type & 2)
      {
         this->green = sample(row, colour_type, bit_depth, x, 1);
         this->blue = sample(row, colour_type, bit_depth, x, 2);
         i = 2;
      }
      if (colour_type & 4)
         this->alpha = sample(row, colour_type, bit_depth, x, ++i);
5380
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
5381

5382 5383 5384 5385 5386
   /* Calculate the scaled values, these are simply the values divided by
    * 'max' and the error is initialized to the double precision epsilon value
    * from the header file.
    */
   image_pixel_setf(this, max);
G
[devel]  
Glenn Randers-Pehrson 已提交
5387

5388 5389 5390 5391 5392
   /* Store the input information for use in the transforms - these will
    * modify the information.
    */
   this->colour_type = colour_type;
   this->bit_depth = bit_depth;
5393
   this->sample_depth = sample_depth;
5394
   this->have_tRNS = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
5395 5396
}

5397
/* Convert a palette image to an rgb image.  This necessarily converts the tRNS
5398 5399 5400 5401 5402
 * chunk at the same time, because the tRNS will be in palette form.  The way
 * palette validation works means that the original palette is never updated,
 * instead the image_pixel value from the row contains the RGB of the
 * corresponding palette entry and *this* is updated.  Consequently this routine
 * only needs to change the colour type information.
5403
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
5404
static void
5405
image_pixel_convert_PLTE(image_pixel *this)
G
[devel]  
Glenn Randers-Pehrson 已提交
5406
{
5407
   if (this->colour_type == PNG_COLOR_TYPE_PALETTE)
G
[devel]  
Glenn Randers-Pehrson 已提交
5408
   {
5409 5410 5411 5412 5413 5414 5415 5416
      if (this->have_tRNS)
      {
         this->colour_type = PNG_COLOR_TYPE_RGB_ALPHA;
         this->have_tRNS = 0;
      }
      else
         this->colour_type = PNG_COLOR_TYPE_RGB;

5417 5418
      /* The bit depth of the row changes at this point too (notice that this is
       * the row format, not the sample depth, which is separate.)
5419
       */
5420
      this->bit_depth = 8;
5421
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
5422 5423
}

5424
/* Add an alpha channel; this will import the tRNS information because tRNS is
5425 5426 5427 5428
 * not valid in an alpha image.  The bit depth will invariably be set to at
 * least 8.  Palette images will be converted to alpha (using the above API).
 */
static void
5429
image_pixel_add_alpha(image_pixel *this, PNG_CONST standard_display *display)
G
[devel]  
Glenn Randers-Pehrson 已提交
5430
{
5431
   if (this->colour_type == PNG_COLOR_TYPE_PALETTE)
5432
      image_pixel_convert_PLTE(this);
G
[devel]  
Glenn Randers-Pehrson 已提交
5433

5434
   if ((this->colour_type & PNG_COLOR_MASK_ALPHA) == 0)
G
[devel]  
Glenn Randers-Pehrson 已提交
5435
   {
5436
      if (this->colour_type == PNG_COLOR_TYPE_GRAY)
G
[devel]  
Glenn Randers-Pehrson 已提交
5437
      {
5438 5439
         if (this->bit_depth < 8)
            this->bit_depth = 8;
5440

5441 5442 5443
         if (this->have_tRNS)
         {
            this->have_tRNS = 0;
5444

5445 5446 5447 5448 5449 5450 5451 5452 5453 5454
            /* Check the input, original, channel value here against the
             * original tRNS gray chunk valie.
             */
            if (this->red == display->transparent.red)
               this->alphaf = 0;
            else
               this->alphaf = 1;
         }
         else
            this->alphaf = 1;
5455

5456
         this->colour_type = PNG_COLOR_TYPE_GRAY_ALPHA;
G
[devel]  
Glenn Randers-Pehrson 已提交
5457 5458
      }

5459 5460 5461 5462 5463
      else if (this->colour_type == PNG_COLOR_TYPE_RGB)
      {
         if (this->have_tRNS)
         {
            this->have_tRNS = 0;
5464

5465 5466 5467 5468 5469 5470 5471 5472 5473
            /* Again, check the exact input values, not the current transformed
             * value!
             */
            if (this->red == display->transparent.red &&
               this->green == display->transparent.green &&
               this->blue == display->transparent.blue)
               this->alphaf = 0;
            else
               this->alphaf = 1;
G
[devel]  
Glenn Randers-Pehrson 已提交
5474

5475 5476 5477 5478 5479 5480 5481 5482 5483
            this->colour_type = PNG_COLOR_TYPE_RGB_ALPHA;
         }
      }

      /* The error in the alpha is zero and the sBIT value comes from the
       * original sBIT data (actually it will always be the original bit depth).
       */
      this->alphae = 0;
      this->alpha_sBIT = display->alpha_sBIT;
G
[devel]  
Glenn Randers-Pehrson 已提交
5484 5485 5486
   }
}

5487 5488
struct transform_display;
typedef struct image_transform
G
[devel]  
Glenn Randers-Pehrson 已提交
5489
{
5490 5491 5492 5493 5494 5495
   /* The name of this transform: a string. */
   PNG_CONST char *name;

   /* Each transform can be disabled from the command line: */
   int enable;

5496 5497
   /* The global list of transforms; read only. */
   struct image_transform *PNG_CONST list;
G
[devel]  
Glenn Randers-Pehrson 已提交
5498

5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514
   /* The global count of the number of times this transform has been set on an
    * image.
    */
   unsigned int global_use;

   /* The local count of the number of times this transform has been set. */
   unsigned int local_use;

   /* The next transform in the list, each transform must call its own next
    * transform after it has processed the pixel successfully.
    */
   PNG_CONST struct image_transform *next;

   /* A single transform for the image, expressed as a series of function
    * callbacks and some space for values.
    *
5515 5516 5517 5518 5519 5520 5521
    * First a callback to add any required modifications to the png_modifier;
    * this gets called just before the modifier is set up for read.
    */
   void (*ini)(PNG_CONST struct image_transform *this,
      struct transform_display *that);

   /* And a callback to set the transform on the current png_read_struct:
5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532
    */
   void (*set)(PNG_CONST struct image_transform *this,
      struct transform_display *that, png_structp pp, png_infop pi);

   /* Then a transform that takes an input pixel in one PNG format or another
    * and modifies it by a pngvalid implementation of the transform (thus
    * duplicating the libpng intent without, we hope, duplicating the bugs
    * in the libpng implementation!)  The png_structp is solely to allow error
    * reporting via png_error and png_warning.
    */
   void (*mod)(PNG_CONST struct image_transform *this, image_pixel *that,
5533
      png_const_structp pp, PNG_CONST struct transform_display *display);
5534 5535 5536 5537 5538 5539 5540

   /* Add this transform to the list and return true if the transform is
    * meaningful for this colour type and bit depth - if false then the
    * transform should have no effect on the image so there's not a lot of
    * point running it.
    */
   int (*add)(struct image_transform *this,
5541
      PNG_CONST struct image_transform **that, png_byte colour_type,
5542 5543 5544 5545
      png_byte bit_depth);
} image_transform;

typedef struct transform_display
5546 5547 5548 5549
{
   standard_display this;

   /* Parameters */
5550 5551
   png_modifier*              pm;
   PNG_CONST image_transform* transform_list;
5552 5553

   /* Local variables */
5554 5555
   png_byte output_colour_type;
   png_byte output_bit_depth;
5556

5557 5558 5559 5560
   /* Modifications (not necessarily used.) */
   gama_modification gama_mod;
   chrm_modification chrm_mod;
   srgb_modification srgb_mod;
5561
} transform_display;
5562

5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598
/* Set sRGB, cHRM and gAMA transforms as required by the current encoding. */
static void
transform_set_encoding(transform_display *this)
{
   /* Set up the png_modifier '_current' fields then use these to determine how
    * to add appropriate chunks.
    */
   png_modifier *pm = this->pm;

   modifier_set_encoding(pm);

   if (modifier_color_encoding_is_set(pm))
   {
      if (modifier_color_encoding_is_sRGB(pm))
         srgb_modification_init(&this->srgb_mod, pm, PNG_sRGB_INTENT_ABSOLUTE);

      else
      {
         /* Set gAMA and cHRM separately. */
         gama_modification_init(&this->gama_mod, pm, pm->current_gamma);

         if (pm->current_encoding != 0)
            chrm_modification_init(&this->chrm_mod, pm, pm->current_encoding);
      }
   }
}

/* Three functions to end the list: */
static void
image_transform_ini_end(PNG_CONST image_transform *this,
   transform_display *that)
{
   UNUSED(this)
   UNUSED(that)
}

G
[devel]  
Glenn Randers-Pehrson 已提交
5599
static void
5600 5601
image_transform_set_end(PNG_CONST image_transform *this,
   transform_display *that, png_structp pp, png_infop pi)
G
[devel]  
Glenn Randers-Pehrson 已提交
5602
{
5603 5604 5605 5606
   UNUSED(this)
   UNUSED(that)
   UNUSED(pp)
   UNUSED(pi)
5607
}
5608

5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627
/* At the end of the list recalculate the output image pixel value from the
 * double precision values set up by the preceding 'mod' calls:
 */
static unsigned int
sample_scale(double sample_value, unsigned int scale)
{
   sample_value = floor(sample_value * scale + .5);

   /* Return NaN as 0: */
   if (!(sample_value > 0))
      sample_value = 0;
   else if (sample_value > scale)
      sample_value = scale;

   return (unsigned int)sample_value;
}

static void
image_transform_mod_end(PNG_CONST image_transform *this, image_pixel *that,
5628
    png_const_structp pp, PNG_CONST transform_display *display)
5629
{
5630
   PNG_CONST unsigned int scale = (1U<<that->sample_depth)-1;
5631

5632 5633 5634
   UNUSED(this)
   UNUSED(pp)
   UNUSED(display)
5635

5636 5637 5638 5639
   /* At the end recalculate the digitized red green and blue values according
    * to the current sample_depth of the pixel.
    *
    * The sample value is simply scaled to the maximum, checking for over
5640 5641 5642 5643 5644 5645 5646 5647 5648 5649
    * and underflow (which can both happen for some image transforms,
    * including simple size scaling, though libpng doesn't do that at present.
    */
   that->red = sample_scale(that->redf, scale);

   /* The error value is increased, at the end, according to the lowest sBIT
    * value seen.  Common sense tells us that the intermediate integer
    * representations are no more accurate than +/- 0.5 in the integral values,
    * the sBIT allows the implementation to be worse than this.  In addition the
    * PNG specification actually permits any error within the range (-1..+1),
5650 5651 5652 5653
    * but that is ignored here.  Instead the final digitized value is compared,
    * below to the digitized value of the error limits - this has the net effect
    * of allowing (almost) +/-1 in the output value.  It's difficult to see how
    * any algorithm that digitizes intermediate results can be more accurate.
5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670
    */
   that->rede += 1./(2*((1U<<that->red_sBIT)-1));

   if (that->colour_type & PNG_COLOR_MASK_COLOR)
   {
      that->green = sample_scale(that->greenf, scale);
      that->blue = sample_scale(that->bluef, scale);
      that->greene += 1./(2*((1U<<that->green_sBIT)-1));
      that->bluee += 1./(2*((1U<<that->blue_sBIT)-1));
   }
   else
   {
      that->blue = that->green = that->red;
      that->bluef = that->greenf = that->redf;
      that->bluee = that->greene = that->rede;
   }

5671 5672
   if ((that->colour_type & PNG_COLOR_MASK_ALPHA) ||
      that->colour_type == PNG_COLOR_TYPE_PALETTE)
5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687
   {
      that->alpha = sample_scale(that->alphaf, scale);
      that->alphae += 1./(2*((1U<<that->alpha_sBIT)-1));
   }
   else
   {
      that->alpha = scale; /* opaque */
      that->alpha = 1;     /* Override this. */
      that->alphae = 0;    /* It's exact ;-) */
   }
}

/* Static 'end' structure: */
static image_transform image_transform_end =
{
5688 5689
   "(end)", /* name */
   1, /* enable */
5690 5691 5692 5693
   0, /* list */
   0, /* global_use */
   0, /* local_use */
   0, /* next */
5694
   image_transform_ini_end,
5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706
   image_transform_set_end,
   image_transform_mod_end,
   0 /* never called, I want it to crash if it is! */
};

/* Reader callbacks and implementations, where they differ from the standard
 * ones.
 */
static void
transform_display_init(transform_display *dp, png_modifier *pm, png_uint_32 id,
    PNG_CONST image_transform *transform_list)
{
5707
   memset(dp, 0, sizeof *dp);
5708

5709
   /* Standard fields */
5710
   standard_display_init(&dp->this, &pm->this, id, 0/*do_interlace*/,
5711
      pm->use_update_info);
5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731

   /* Parameter fields */
   dp->pm = pm;
   dp->transform_list = transform_list;

   /* Local variable fields */
   dp->output_colour_type = 255; /* invalid */
   dp->output_bit_depth = 255;  /* invalid */
}

static void
transform_info_imp(transform_display *dp, png_structp pp, png_infop pi)
{
   /* Reuse the standard stuff as appropriate. */
   standard_info_part1(&dp->this, pp, pi);

   /* Now set the list of transforms. */
   dp->transform_list->set(dp->transform_list, dp, pp, pi);

   /* Update the info structure for these transforms: */
5732 5733 5734 5735 5736 5737 5738
   {
      int i = dp->this.use_update_info;
      /* Always do one call, even if use_update_info is 0. */
      do
         png_read_update_info(pp, pi);
      while (--i > 0);
   }
5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788

   /* And get the output information into the standard_display */
   standard_info_part2(&dp->this, pp, pi, 1/*images*/);

   /* Plus the extra stuff we need for the transform tests: */
   dp->output_colour_type = png_get_color_type(pp, pi);
   dp->output_bit_depth = png_get_bit_depth(pp, pi);

   /* Validate the combination of colour type and bit depth that we are getting
    * out of libpng; the semantics of something not in the PNG spec are, at
    * best, unclear.
    */
   switch (dp->output_colour_type)
   {
   case PNG_COLOR_TYPE_PALETTE:
      if (dp->output_bit_depth > 8) goto error;
      /*FALL THROUGH*/
   case PNG_COLOR_TYPE_GRAY:
      if (dp->output_bit_depth == 1 || dp->output_bit_depth == 2 ||
         dp->output_bit_depth == 4)
         break;
      /*FALL THROUGH*/
   default:
      if (dp->output_bit_depth == 8 || dp->output_bit_depth == 16)
         break;
      /*FALL THROUGH*/
   error:
      {
         char message[128];
         size_t pos;

         pos = safecat(message, sizeof message, 0,
            "invalid final bit depth: colour type(");
         pos = safecatn(message, sizeof message, pos, dp->output_colour_type);
         pos = safecat(message, sizeof message, pos, ") with bit depth: ");
         pos = safecatn(message, sizeof message, pos, dp->output_bit_depth);

         png_error(pp, message);
      }
   }

   /* Use a test pixel to check that the output agrees with what we expect -
    * this avoids running the whole test if the output is unexpected.
    */
   {
      image_pixel test_pixel;

      memset(&test_pixel, 0, sizeof test_pixel);
      test_pixel.colour_type = dp->this.colour_type; /* input */
      test_pixel.bit_depth = dp->this.bit_depth;
5789 5790 5791 5792
      if (test_pixel.colour_type == PNG_COLOR_TYPE_PALETTE)
         test_pixel.sample_depth = 8;
      else
         test_pixel.sample_depth = test_pixel.bit_depth;
5793 5794 5795
      /* Don't need sBIT here, but it must be set to non-zero to avoid
       * arithmetic overflows.
       */
5796
      test_pixel.have_tRNS = dp->this.is_transparent;
5797 5798
      test_pixel.red_sBIT = test_pixel.green_sBIT = test_pixel.blue_sBIT =
         test_pixel.alpha_sBIT = test_pixel.sample_depth;
5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824

      dp->transform_list->mod(dp->transform_list, &test_pixel, pp, dp);

      if (test_pixel.colour_type != dp->output_colour_type)
      {
         char message[128];
         size_t pos = safecat(message, sizeof message, 0, "colour type ");

         pos = safecatn(message, sizeof message, pos, dp->output_colour_type);
         pos = safecat(message, sizeof message, pos, " expected ");
         pos = safecatn(message, sizeof message, pos, test_pixel.colour_type);

         png_error(pp, message);
      }

      if (test_pixel.bit_depth != dp->output_bit_depth)
      {
         char message[128];
         size_t pos = safecat(message, sizeof message, 0, "bit depth ");

         pos = safecatn(message, sizeof message, pos, dp->output_bit_depth);
         pos = safecat(message, sizeof message, pos, " expected ");
         pos = safecatn(message, sizeof message, pos, test_pixel.bit_depth);

         png_error(pp, message);
      }
5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845

      /* If both bit depth and colour type are correct check the sample depth.
       * I believe these are both internal errors.
       */
      if (test_pixel.colour_type == PNG_COLOR_TYPE_PALETTE)
      {
         if (test_pixel.sample_depth != 8) /* oops - internal error! */
            png_error(pp, "pngvalid: internal: palette sample depth not 8");
      }
      else if (test_pixel.sample_depth != dp->output_bit_depth)
      {
         char message[128];
         size_t pos = safecat(message, sizeof message, 0,
            "internal: sample depth ");

         pos = safecatn(message, sizeof message, pos, dp->output_bit_depth);
         pos = safecat(message, sizeof message, pos, " expected ");
         pos = safecatn(message, sizeof message, pos, test_pixel.sample_depth);

         png_error(pp, message);
      }
5846 5847 5848
   }
}

5849
static void PNGCBAPI
5850 5851
transform_info(png_structp pp, png_infop pi)
{
5852 5853
   transform_info_imp(voidcast(transform_display*, png_get_progressive_ptr(pp)),
      pp, pi);
5854 5855 5856
}

static void
5857
transform_range_check(png_const_structp pp, unsigned int r, unsigned int g,
5858
   unsigned int b, unsigned int a, unsigned int in_digitized, double in,
5859 5860
   unsigned int out, png_byte sample_depth, double err, double limit,
   PNG_CONST char *name, double digitization_error)
5861 5862 5863 5864
{
   /* Compare the scaled, digitzed, values of our local calculation (in+-err)
    * with the digitized values libpng produced;  'sample_depth' is the actual
    * digitization depth of the libpng output colors (the bit depth except for
5865
    * palette images where it is always 8.)  The check on 'err' is to detect
5866
    * internal errors in pngvalid itself.
5867 5868
    */
   unsigned int max = (1U<<sample_depth)-1;
5869 5870
   double in_min = ceil((in-err)*max - digitization_error);
   double in_max = floor((in+err)*max + digitization_error);
5871
   if (err > limit || !(out >= in_min && out <= in_max))
5872
   {
5873
      char message[256];
5874 5875 5876
      size_t pos;

      pos = safecat(message, sizeof message, 0, name);
5877 5878 5879 5880 5881 5882 5883 5884 5885 5886
      pos = safecat(message, sizeof message, pos, " output value error: rgba(");
      pos = safecatn(message, sizeof message, pos, r);
      pos = safecat(message, sizeof message, pos, ",");
      pos = safecatn(message, sizeof message, pos, g);
      pos = safecat(message, sizeof message, pos, ",");
      pos = safecatn(message, sizeof message, pos, b);
      pos = safecat(message, sizeof message, pos, ",");
      pos = safecatn(message, sizeof message, pos, a);
      pos = safecat(message, sizeof message, pos, "): ");
      pos = safecatn(message, sizeof message, pos, out);
5887
      pos = safecat(message, sizeof message, pos, " expected: ");
5888 5889 5890
      pos = safecatn(message, sizeof message, pos, in_digitized);
      pos = safecat(message, sizeof message, pos, " (");
      pos = safecatd(message, sizeof message, pos, (in-err)*max, 3);
5891
      pos = safecat(message, sizeof message, pos, "..");
5892 5893
      pos = safecatd(message, sizeof message, pos, (in+err)*max, 3);
      pos = safecat(message, sizeof message, pos, ")");
5894 5895 5896 5897 5898 5899

      png_error(pp, message);
   }
}

static void
5900 5901
transform_image_validate(transform_display *dp, png_const_structp pp,
   png_infop pi)
5902 5903
{
   /* Constants for the loop below: */
5904
   PNG_CONST png_store* PNG_CONST ps = dp->this.ps;
5905 5906 5907 5908 5909 5910
   PNG_CONST png_byte in_ct = dp->this.colour_type;
   PNG_CONST png_byte in_bd = dp->this.bit_depth;
   PNG_CONST png_uint_32 w = dp->this.w;
   PNG_CONST png_uint_32 h = dp->this.h;
   PNG_CONST png_byte out_ct = dp->output_colour_type;
   PNG_CONST png_byte out_bd = dp->output_bit_depth;
5911 5912
   PNG_CONST png_byte sample_depth = (png_byte)(out_ct ==
      PNG_COLOR_TYPE_PALETTE ? 8 : out_bd);
5913 5914 5915 5916 5917
   PNG_CONST png_byte red_sBIT = dp->this.red_sBIT;
   PNG_CONST png_byte green_sBIT = dp->this.green_sBIT;
   PNG_CONST png_byte blue_sBIT = dp->this.blue_sBIT;
   PNG_CONST png_byte alpha_sBIT = dp->this.alpha_sBIT;
   PNG_CONST int have_tRNS = dp->this.is_transparent;
5918
   double digitization_error;
5919

5920
   store_palette out_palette;
5921 5922
   png_uint_32 y;

5923 5924
   UNUSED(pi)

5925 5926 5927
   /* Check for row overwrite errors */
   store_image_check(dp->this.ps, pp, 0);

5928 5929 5930 5931
   /* Read the palette corresponding to the output if the output colour type
    * indicates a palette, othewise set out_palette to garbage.
    */
   if (out_ct == PNG_COLOR_TYPE_PALETTE)
5932 5933 5934 5935 5936 5937 5938 5939 5940
   {
      /* Validate that the palette count itself has not changed - this is not
       * expected.
       */
      int npalette = (-1);

      (void)read_palette(out_palette, &npalette, pp, pi);
      if (npalette != dp->this.npalette)
         png_error(pp, "unexpected change in palette size");
5941 5942

      digitization_error = .5;
5943
   }
5944
   else
5945 5946 5947
   {
      png_byte in_sample_depth;

5948 5949
      memset(out_palette, 0x5e, sizeof out_palette);

5950 5951 5952
      /* use-input-precision means assume that if the input has 8 bit (or less)
       * samples and the output has 16 bit samples the calculations will be done
       * with 8 bit precision, not 16.
5953 5954 5955 5956 5957 5958 5959 5960 5961 5962
       */
      if (in_ct == PNG_COLOR_TYPE_PALETTE || in_bd < 16)
         in_sample_depth = 8;
      else
         in_sample_depth = in_bd;

      if (sample_depth != 16 || in_sample_depth > 8 ||
         !dp->pm->calculations_use_input_precision)
         digitization_error = .5;

5963 5964
      /* Else calculations are at 8 bit precision, and the output actually
       * consists of scaled 8-bit values, so scale .5 in 8 bits to the 16 bits:
5965 5966 5967 5968 5969
       */
      else
         digitization_error = .5 * 257;
   }

5970
   for (y=0; y<h; ++y)
5971
   {
5972
      png_const_bytep PNG_CONST pRow = store_image_row(ps, pp, 0, y);
5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985
      png_uint_32 x;

      /* The original, standard, row pre-transforms. */
      png_byte std[STANDARD_ROWMAX];

      transform_row(pp, std, in_ct, in_bd, y);

      /* Go through each original pixel transforming it and comparing with what
       * libpng did to the same pixel.
       */
      for (x=0; x<w; ++x)
      {
         image_pixel in_pixel, out_pixel;
5986
         unsigned int r, g, b, a;
5987 5988

         /* Find out what we think the pixel should be: */
5989 5990
         image_pixel_init(&in_pixel, std, in_ct, in_bd, x, dp->this.palette);

5991 5992 5993 5994 5995 5996
         in_pixel.red_sBIT = red_sBIT;
         in_pixel.green_sBIT = green_sBIT;
         in_pixel.blue_sBIT = blue_sBIT;
         in_pixel.alpha_sBIT = alpha_sBIT;
         in_pixel.have_tRNS = have_tRNS;

5997 5998 5999 6000 6001 6002
         /* For error detection, below. */
         r = in_pixel.red;
         g = in_pixel.green;
         b = in_pixel.blue;
         a = in_pixel.alpha;

6003 6004 6005
         dp->transform_list->mod(dp->transform_list, &in_pixel, pp, dp);

         /* Read the output pixel and compare it to what we got, we don't
6006
          * use the error field here, so no need to update sBIT.
6007
          */
6008
         image_pixel_init(&out_pixel, pRow, out_ct, out_bd, x, out_palette);
6009

6010 6011 6012 6013 6014
         /* We don't expect changes to the index here even if the bit depth is
          * changed.
          */
         if (in_ct == PNG_COLOR_TYPE_PALETTE &&
            out_ct == PNG_COLOR_TYPE_PALETTE)
6015 6016 6017 6018 6019
         {
            if (in_pixel.palette_index != out_pixel.palette_index)
               png_error(pp, "unexpected transformed palette index");
         }

6020 6021 6022 6023 6024
         /* Check the colours for palette images too - in fact the palette could
          * be separately verified itself in most cases.
          */
         if (in_pixel.red != out_pixel.red)
            transform_range_check(pp, r, g, b, a, in_pixel.red, in_pixel.redf,
6025 6026
               out_pixel.red, sample_depth, in_pixel.rede,
               dp->pm->limit + 1./(2*((1U<<in_pixel.red_sBIT)-1)), "red/gray",
6027
               digitization_error);
6028 6029 6030 6031 6032

         if ((out_ct & PNG_COLOR_MASK_COLOR) != 0 &&
            in_pixel.green != out_pixel.green)
            transform_range_check(pp, r, g, b, a, in_pixel.green,
               in_pixel.greenf, out_pixel.green, sample_depth, in_pixel.greene,
6033 6034
               dp->pm->limit + 1./(2*((1U<<in_pixel.green_sBIT)-1)), "green",
               digitization_error);
6035 6036 6037 6038

         if ((out_ct & PNG_COLOR_MASK_COLOR) != 0 &&
            in_pixel.blue != out_pixel.blue)
            transform_range_check(pp, r, g, b, a, in_pixel.blue, in_pixel.bluef,
6039 6040
               out_pixel.blue, sample_depth, in_pixel.bluee,
               dp->pm->limit + 1./(2*((1U<<in_pixel.blue_sBIT)-1)), "blue",
6041
               digitization_error);
6042 6043 6044 6045 6046

         if ((out_ct & PNG_COLOR_MASK_ALPHA) != 0 &&
            in_pixel.alpha != out_pixel.alpha)
            transform_range_check(pp, r, g, b, a, in_pixel.alpha,
               in_pixel.alphaf, out_pixel.alpha, sample_depth, in_pixel.alphae,
6047 6048
               dp->pm->limit + 1./(2*((1U<<in_pixel.alpha_sBIT)-1)), "alpha",
               digitization_error);
6049 6050 6051 6052 6053 6054 6055
      } /* pixel (x) loop */
   } /* row (y) loop */

   /* Record that something was actually checked to avoid a false positive. */
   dp->this.ps->validated = 1;
}

6056
static void PNGCBAPI
6057
transform_end(png_structp ppIn, png_infop pi)
6058
{
6059
   png_const_structp pp = ppIn;
6060 6061
   transform_display *dp = voidcast(transform_display*,
      png_get_progressive_ptr(pp));
6062

6063 6064 6065 6066
   if (!dp->this.speed)
      transform_image_validate(dp, pp, pi);
   else
      dp->this.ps->validated = 1;
6067 6068 6069 6070 6071
}

/* A single test run. */
static void
transform_test(png_modifier *pmIn, PNG_CONST png_uint_32 idIn,
6072
    PNG_CONST image_transform* transform_listIn, PNG_CONST char * volatile name)
6073 6074 6075 6076 6077 6078 6079 6080
{
   transform_display d;
   context(&pmIn->this, fault);

   transform_display_init(&d, pmIn, idIn, transform_listIn);

   Try
   {
6081
      size_t pos = 0;
6082 6083
      png_structp pp;
      png_infop pi;
6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096
      char full_name[256];

      /* Make sure the encoding fields are correct and enter the required
       * modifications.
       */
      transform_set_encoding(&d);

      /* Add any modifications required by the transform list. */
      d.transform_list->ini(d.transform_list, &d);

      /* Add the color space information, if any, to the name. */
      pos = safecat(full_name, sizeof full_name, pos, name);
      pos = safecat_current_encoding(full_name, sizeof full_name, pos, d.pm);
6097

6098
      /* Get a png_struct for reading the image. */
6099
      pp = set_modifier_for_read(d.pm, &pi, d.this.id, full_name);
6100
      standard_palette_init(&d.this);
6101

6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113
#     if 0
         /* Logging (debugging only) */
         {
            char buffer[256];

            (void)store_message(&d.pm->this, pp, buffer, sizeof buffer, 0,
               "running test");

            fprintf(stderr, "%s\n", buffer);
         }
#     endif

6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134
      /* Introduce the correct read function. */
      if (d.pm->this.progressive)
      {
         /* Share the row function with the standard implementation. */
         png_set_progressive_read_fn(pp, &d, transform_info, progressive_row,
            transform_end);

         /* Now feed data into the reader until we reach the end: */
         modifier_progressive_read(d.pm, pp, pi);
      }
      else
      {
         /* modifier_read expects a png_modifier* */
         png_set_read_fn(pp, d.pm, modifier_read);

         /* Check the header values: */
         png_read_info(pp, pi);

         /* Process the 'info' requirements. Only one image is generated */
         transform_info_imp(&d, pp, pi);

6135
         sequential_row(&d.this, pp, pi, -1, 0);
6136

6137 6138
         if (!d.this.speed)
            transform_image_validate(&d, pp, pi);
6139 6140
         else
            d.this.ps->validated = 1;
6141 6142 6143 6144 6145 6146
      }

      modifier_reset(d.pm);
   }

   Catch(fault)
6147
   {
6148
      modifier_reset(voidcast(png_modifier*,(void*)fault));
6149
   }
6150 6151 6152 6153
}

/* The transforms: */
#define ITSTRUCT(name) image_transform_##name
6154 6155
#define ITDATA(name) image_transform_data_##name
#define image_transform_ini image_transform_default_ini
6156
#define IT(name)\
6157 6158
static image_transform ITSTRUCT(name) =\
{\
6159 6160
   #name,\
   1, /*enable*/\
6161
   &PT, /*list*/\
6162 6163 6164
   0, /*global_use*/\
   0, /*local_use*/\
   0, /*next*/\
6165
   image_transform_ini,\
6166 6167 6168 6169
   image_transform_png_set_##name##_set,\
   image_transform_png_set_##name##_mod,\
   image_transform_png_set_##name##_add\
}
6170
#define PT ITSTRUCT(end) /* stores the previous transform */
6171

6172
/* To save code: */
6173 6174 6175 6176 6177 6178 6179
static void
image_transform_default_ini(PNG_CONST image_transform *this,
    transform_display *that)
{
   this->next->ini(this->next, that);
}

6180
#ifdef PNG_READ_BACKGROUND_SUPPORTED
6181
static int
6182 6183
image_transform_default_add(image_transform *this,
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
6184
{
6185 6186 6187
   UNUSED(colour_type)
   UNUSED(bit_depth)

6188 6189 6190
   this->next = *that;
   *that = this;

6191
   return 1;
6192
}
6193
#endif
6194

6195
#ifdef PNG_READ_EXPAND_SUPPORTED
6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206
/* png_set_palette_to_rgb */
static void
image_transform_png_set_palette_to_rgb_set(PNG_CONST image_transform *this,
    transform_display *that, png_structp pp, png_infop pi)
{
   png_set_palette_to_rgb(pp);
   this->next->set(this->next, that, pp, pi);
}

static void
image_transform_png_set_palette_to_rgb_mod(PNG_CONST image_transform *this,
6207 6208
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6209 6210
{
   if (that->colour_type == PNG_COLOR_TYPE_PALETTE)
6211
      image_pixel_convert_PLTE(that);
6212 6213 6214 6215 6216 6217

   this->next->mod(this->next, that, pp, display);
}

static int
image_transform_png_set_palette_to_rgb_add(image_transform *this,
6218
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
6219
{
6220
   UNUSED(bit_depth)
6221 6222 6223 6224 6225 6226 6227

   this->next = *that;
   *that = this;

   return colour_type == PNG_COLOR_TYPE_PALETTE;
}

6228 6229 6230 6231
IT(palette_to_rgb);
#undef PT
#define PT ITSTRUCT(palette_to_rgb)
#endif /* PNG_READ_EXPAND_SUPPORTED */
6232

6233
#ifdef PNG_READ_EXPAND_SUPPORTED
6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244
/* png_set_tRNS_to_alpha */
static void
image_transform_png_set_tRNS_to_alpha_set(PNG_CONST image_transform *this,
   transform_display *that, png_structp pp, png_infop pi)
{
   png_set_tRNS_to_alpha(pp);
   this->next->set(this->next, that, pp, pi);
}

static void
image_transform_png_set_tRNS_to_alpha_mod(PNG_CONST image_transform *this,
6245 6246
   image_pixel *that, png_const_structp pp,
   PNG_CONST transform_display *display)
6247
{
6248 6249
   /* LIBPNG BUG: this always forces palette images to RGB. */
   if (that->colour_type == PNG_COLOR_TYPE_PALETTE)
6250
      image_pixel_convert_PLTE(that);
6251

6252
   /* This effectively does an 'expand' only if there is some transparency to
6253
    * convert to an alpha channel.
6254 6255 6256 6257 6258
    */
   if (that->have_tRNS)
      image_pixel_add_alpha(that, &display->this);

   /* LIBPNG BUG: otherwise libpng still expands to 8 bits! */
6259 6260 6261 6262 6263 6264 6265
   else
   {
      if (that->bit_depth < 8)
         that->bit_depth =8;
      if (that->sample_depth < 8)
         that->sample_depth = 8;
   }
6266 6267 6268 6269 6270 6271

   this->next->mod(this->next, that, pp, display);
}

static int
image_transform_png_set_tRNS_to_alpha_add(image_transform *this,
6272
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
6273
{
6274
   UNUSED(bit_depth)
6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285

   this->next = *that;
   *that = this;

   /* We don't know yet whether there will be a tRNS chunk, but we know that
    * this transformation should do nothing if there already is an alpha
    * channel.
    */
   return (colour_type & PNG_COLOR_MASK_ALPHA) == 0;
}

6286 6287 6288 6289
IT(tRNS_to_alpha);
#undef PT
#define PT ITSTRUCT(tRNS_to_alpha)
#endif /* PNG_READ_EXPAND_SUPPORTED */
6290

6291
#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302
/* png_set_gray_to_rgb */
static void
image_transform_png_set_gray_to_rgb_set(PNG_CONST image_transform *this,
    transform_display *that, png_structp pp, png_infop pi)
{
   png_set_gray_to_rgb(pp);
   this->next->set(this->next, that, pp, pi);
}

static void
image_transform_png_set_gray_to_rgb_mod(PNG_CONST image_transform *this,
6303 6304
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318
{
   /* NOTE: we can actually pend the tRNS processing at this point because we
    * can correctly recognize the original pixel value even though we have
    * mapped the one gray channel to the three RGB ones, but in fact libpng
    * doesn't do this, so we don't either.
    */
   if ((that->colour_type & PNG_COLOR_MASK_COLOR) == 0 && that->have_tRNS)
      image_pixel_add_alpha(that, &display->this);

   /* Simply expand the bit depth and alter the colour type as required. */
   if (that->colour_type == PNG_COLOR_TYPE_GRAY)
   {
      /* RGB images have a bit depth at least equal to '8' */
      if (that->bit_depth < 8)
6319
         that->sample_depth = that->bit_depth = 8;
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334

      /* And just changing the colour type works here because the green and blue
       * channels are being maintained in lock-step with the red/gray:
       */
      that->colour_type = PNG_COLOR_TYPE_RGB;
   }

   else if (that->colour_type == PNG_COLOR_TYPE_GRAY_ALPHA)
      that->colour_type = PNG_COLOR_TYPE_RGB_ALPHA;

   this->next->mod(this->next, that, pp, display);
}

static int
image_transform_png_set_gray_to_rgb_add(image_transform *this,
6335
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
6336
{
6337
   UNUSED(bit_depth)
6338 6339 6340 6341 6342 6343 6344

   this->next = *that;
   *that = this;

   return (colour_type & PNG_COLOR_MASK_COLOR) == 0;
}

6345 6346 6347 6348
IT(gray_to_rgb);
#undef PT
#define PT ITSTRUCT(gray_to_rgb)
#endif /* PNG_READ_GRAY_TO_RGB_SUPPORTED */
6349

6350
#ifdef PNG_READ_EXPAND_SUPPORTED
6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361
/* png_set_expand */
static void
image_transform_png_set_expand_set(PNG_CONST image_transform *this,
    transform_display *that, png_structp pp, png_infop pi)
{
   png_set_expand(pp);
   this->next->set(this->next, that, pp, pi);
}

static void
image_transform_png_set_expand_mod(PNG_CONST image_transform *this,
6362 6363
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6364 6365 6366
{
   /* The general expand case depends on what the colour type is: */
   if (that->colour_type == PNG_COLOR_TYPE_PALETTE)
6367
      image_pixel_convert_PLTE(that);
6368 6369
   else if (that->bit_depth < 8) /* grayscale */
      that->sample_depth = that->bit_depth = 8;
6370 6371 6372 6373 6374 6375 6376 6377 6378

   if (that->have_tRNS)
      image_pixel_add_alpha(that, &display->this);

   this->next->mod(this->next, that, pp, display);
}

static int
image_transform_png_set_expand_add(image_transform *this,
6379
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
6380
{
6381
   UNUSED(bit_depth)
6382 6383 6384 6385 6386 6387 6388 6389 6390 6391

   this->next = *that;
   *that = this;

   /* 'expand' should do nothing for RGBA or GA input - no tRNS and the bit
    * depth is at least 8 already.
    */
   return (colour_type & PNG_COLOR_MASK_ALPHA) == 0;
}

6392 6393 6394 6395
IT(expand);
#undef PT
#define PT ITSTRUCT(expand)
#endif /* PNG_READ_EXPAND_SUPPORTED */
6396

6397
#ifdef PNG_READ_EXPAND_SUPPORTED
6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411
/* png_set_expand_gray_1_2_4_to_8
 * LIBPNG BUG: this just does an 'expand'
 */
static void
image_transform_png_set_expand_gray_1_2_4_to_8_set(
    PNG_CONST image_transform *this, transform_display *that, png_structp pp,
    png_infop pi)
{
   png_set_expand_gray_1_2_4_to_8(pp);
   this->next->set(this->next, that, pp, pi);
}

static void
image_transform_png_set_expand_gray_1_2_4_to_8_mod(
6412
    PNG_CONST image_transform *this, image_pixel *that, png_const_structp pp,
6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425
    PNG_CONST transform_display *display)
{
   image_transform_png_set_expand_mod(this, that, pp, display);
}

static int
image_transform_png_set_expand_gray_1_2_4_to_8_add(image_transform *this,
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
{
   return image_transform_png_set_expand_add(this, that, colour_type,
      bit_depth);
}

6426 6427 6428 6429 6430 6431
IT(expand_gray_1_2_4_to_8);
#undef PT
#define PT ITSTRUCT(expand_gray_1_2_4_to_8)
#endif /* PNG_READ_EXPAND_SUPPORTED */

#ifdef PNG_READ_EXPAND_16_SUPPORTED
6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442
/* png_set_expand_16 */
static void
image_transform_png_set_expand_16_set(PNG_CONST image_transform *this,
    transform_display *that, png_structp pp, png_infop pi)
{
   png_set_expand_16(pp);
   this->next->set(this->next, that, pp, pi);
}

static void
image_transform_png_set_expand_16_mod(PNG_CONST image_transform *this,
6443 6444
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6445 6446 6447 6448 6449
{
   /* Expect expand_16 to expand everything to 16 bits as a result of also
    * causing 'expand' to happen.
    */
   if (that->colour_type == PNG_COLOR_TYPE_PALETTE)
6450
      image_pixel_convert_PLTE(that);
6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473

   if (that->have_tRNS)
      image_pixel_add_alpha(that, &display->this);

   if (that->bit_depth < 16)
      that->sample_depth = that->bit_depth = 16;

   this->next->mod(this->next, that, pp, display);
}

static int
image_transform_png_set_expand_16_add(image_transform *this,
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
{
   UNUSED(colour_type)

   this->next = *that;
   *that = this;

   /* expand_16 does something unless the bit depth is already 16. */
   return bit_depth < 16;
}

6474 6475 6476 6477
IT(expand_16);
#undef PT
#define PT ITSTRUCT(expand_16)
#endif /* PNG_READ_EXPAND_16_SUPPORTED */
6478

6479
#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED  /* API added in 1.5.4 */
6480
/* png_set_scale_16 */
6481
static void
6482
image_transform_png_set_scale_16_set(PNG_CONST image_transform *this,
6483 6484
    transform_display *that, png_structp pp, png_infop pi)
{
6485
   png_set_scale_16(pp);
6486 6487 6488 6489
   this->next->set(this->next, that, pp, pi);
}

static void
6490
image_transform_png_set_scale_16_mod(PNG_CONST image_transform *this,
6491 6492
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6493 6494 6495
{
   if (that->bit_depth == 16)
   {
6496
      that->sample_depth = that->bit_depth = 8;
6497 6498 6499 6500 6501 6502 6503 6504 6505 6506
      if (that->red_sBIT > 8) that->red_sBIT = 8;
      if (that->green_sBIT > 8) that->green_sBIT = 8;
      if (that->blue_sBIT > 8) that->blue_sBIT = 8;
      if (that->alpha_sBIT > 8) that->alpha_sBIT = 8;
   }

   this->next->mod(this->next, that, pp, display);
}

static int
6507
image_transform_png_set_scale_16_add(image_transform *this,
6508
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
6509
{
6510
   UNUSED(colour_type)
6511 6512 6513 6514 6515 6516 6517

   this->next = *that;
   *that = this;

   return bit_depth > 8;
}

6518
IT(scale_16);
6519
#undef PT
6520
#define PT ITSTRUCT(scale_16)
6521
#endif /* PNG_READ_SCALE_16_TO_8_SUPPORTED (1.5.4 on) */
6522

6523
#ifdef PNG_READ_16_TO_8_SUPPORTED /* the default before 1.5.4 */
6524
/* png_set_strip_16 */
6525
static void
6526
image_transform_png_set_strip_16_set(PNG_CONST image_transform *this,
6527 6528
    transform_display *that, png_structp pp, png_infop pi)
{
6529
   png_set_strip_16(pp);
6530 6531 6532 6533
   this->next->set(this->next, that, pp, pi);
}

static void
6534
image_transform_png_set_strip_16_mod(PNG_CONST image_transform *this,
6535 6536
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6537 6538 6539 6540 6541 6542 6543 6544 6545
{
   if (that->bit_depth == 16)
   {
      that->sample_depth = that->bit_depth = 8;
      if (that->red_sBIT > 8) that->red_sBIT = 8;
      if (that->green_sBIT > 8) that->green_sBIT = 8;
      if (that->blue_sBIT > 8) that->blue_sBIT = 8;
      if (that->alpha_sBIT > 8) that->alpha_sBIT = 8;

6546 6547 6548
      /* Prior to 1.5.4 png_set_strip_16 would use an 'accurate' method if this
       * configuration option is set.  From 1.5.4 the flag is never set and the
       * 'scale' API (above) must be used.
6549
       */
6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567
#     ifdef PNG_READ_ACCURATE_SCALE_SUPPORTED
#        if PNG_LIBPNG_VER >= 10504
#           error PNG_READ_ACCURATE_SCALE should not be set
#        endif

         /* The strip 16 algorithm drops the low 8 bits rather than calculating
          * 1/257, so we need to adjust the permitted errors appropriately:
          * Notice that this is only relevant prior to the addition of the
          * png_set_scale_16 API in 1.5.4 (but 1.5.4+ always defines the above!)
          */
         {
            PNG_CONST double d = (255-128.5)/65535;
            that->rede += d;
            that->greene += d;
            that->bluee += d;
            that->alphae += d;
         }
#     endif
6568 6569 6570 6571 6572 6573
   }

   this->next->mod(this->next, that, pp, display);
}

static int
6574
image_transform_png_set_strip_16_add(image_transform *this,
6575 6576 6577 6578 6579 6580 6581 6582 6583 6584
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
{
   UNUSED(colour_type)

   this->next = *that;
   *that = this;

   return bit_depth > 8;
}

6585
IT(strip_16);
6586
#undef PT
6587
#define PT ITSTRUCT(strip_16)
6588
#endif /* PNG_READ_16_TO_8_SUPPORTED */
6589

6590
#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601
/* png_set_strip_alpha */
static void
image_transform_png_set_strip_alpha_set(PNG_CONST image_transform *this,
    transform_display *that, png_structp pp, png_infop pi)
{
   png_set_strip_alpha(pp);
   this->next->set(this->next, that, pp, pi);
}

static void
image_transform_png_set_strip_alpha_mod(PNG_CONST image_transform *this,
6602 6603
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6604 6605 6606 6607 6608 6609
{
   if (that->colour_type == PNG_COLOR_TYPE_GRAY_ALPHA)
      that->colour_type = PNG_COLOR_TYPE_GRAY;
   else if (that->colour_type == PNG_COLOR_TYPE_RGB_ALPHA)
      that->colour_type = PNG_COLOR_TYPE_RGB;

6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765
   that->have_tRNS = 0;
   that->alphaf = 1;

   this->next->mod(this->next, that, pp, display);
}

static int
image_transform_png_set_strip_alpha_add(image_transform *this,
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
{
   UNUSED(bit_depth)

   this->next = *that;
   *that = this;

   return (colour_type & PNG_COLOR_MASK_ALPHA) != 0;
}

IT(strip_alpha);
#undef PT
#define PT ITSTRUCT(strip_alpha)
#endif /* PNG_READ_STRIP_ALPHA_SUPPORTED */

#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
/* png_set_rgb_to_gray(png_structp, int err_action, double red, double green)
 * png_set_rgb_to_gray_fixed(png_structp, int err_action, png_fixed_point red,
 *    png_fixed_point green)
 * png_get_rgb_to_gray_status
 *
 * The 'default' test here uses values known to be used inside libpng:
 *
 *   red:    6968
 *   green: 23434
 *   blue:   2366
 *
 * These values are being retained for compatibility, along with the somewhat
 * broken truncation calculation in the fast-and-inaccurate code path.  Older
 * versions of libpng will fail the accuracy tests below because they use the
 * truncation algorithm everywhere.
 */
#define data ITDATA(rgb_to_gray)
static struct
{
   double gamma;      /* File gamma to use in processing */

   /* The following are the parameters for png_set_rgb_to_gray: */
#  ifdef PNG_FLOATING_POINT_SUPPORTED
      double red_to_set;
      double green_to_set;
#  else
      png_fixed_point red_to_set;
      png_fixed_point green_to_set;
#  endif

   /* The actual coefficients: */
   double red_coefficient;
   double green_coefficient;
   double blue_coefficient;

   /* Set if the coeefficients have been overridden. */
   int coefficients_overridden;
} data;

#undef image_transform_ini
#define image_transform_ini image_transform_png_set_rgb_to_gray_ini
static void
image_transform_png_set_rgb_to_gray_ini(PNG_CONST image_transform *this,
    transform_display *that)
{
   png_modifier *pm = that->pm;
   PNG_CONST color_encoding *e = pm->current_encoding;

   UNUSED(this)

   /* Since we check the encoding this flag must be set: */
   pm->test_uses_encoding = 1;

   /* If 'e' is not NULL chromaticity information is present and either a cHRM
    * or an sRGB chunk will be inserted.
    */
   if (e != 0)
   {
      /* Coefficients come from the encoding, but may need to be normalized to a
       * white point Y of 1.0
       */
      PNG_CONST double whiteY = e->red.Y + e->green.Y + e->blue.Y;

      data.red_coefficient = e->red.Y;
      data.green_coefficient = e->green.Y;
      data.blue_coefficient = e->blue.Y;

      if (whiteY != 1)
      {
         data.red_coefficient /= whiteY;
         data.green_coefficient /= whiteY;
         data.blue_coefficient /= whiteY;
      }
   }

   else
   {
      /* The default (built in) coeffcients, as above: */
      data.red_coefficient = 6968 / 32768.;
      data.green_coefficient = 23434 / 32768.;
      data.blue_coefficient = 2366 / 32768.;
   }

   data.gamma = pm->current_gamma;

   /* If not set then the calculations assume linear encoding (implicitly): */
   if (data.gamma == 0)
      data.gamma = 1;

   /* The arguments to png_set_rgb_to_gray can override the coefficients implied
    * by the color space encoding.  If doing exhaustive checks do the override
    * in each case, otherwise do it randomly.
    */
   if (pm->test_exhaustive)
   {
      /* First time in coefficients_overridden is 0, the following sets it to 1,
       * so repeat if it is set.  If a test fails this may mean we subsequently
       * skip a non-override test, ignore that.
       */
      data.coefficients_overridden = !data.coefficients_overridden;
      pm->repeat = data.coefficients_overridden != 0;
   }

   else
      data.coefficients_overridden = random_choice();

   if (data.coefficients_overridden)
   {
      /* These values override the color encoding defaults, simply use random
       * numbers.
       */
      png_uint_32 ru;
      double total;

      RANDOMIZE(ru);
      data.green_coefficient = total = (ru & 0xffff) / 65535.;
      ru >>= 16;
      data.red_coefficient = (1 - total) * (ru & 0xffff) / 65535.;
      total += data.red_coefficient;
      data.blue_coefficient = 1 - total;

#     ifdef PNG_FLOATING_POINT_SUPPORTED
         data.red_to_set = data.red_coefficient;
         data.green_to_set = data.green_coefficient;
#     else
         data.red_to_set = fix(data.red_coefficient);
         data.green_to_set = fix(data.green_coefficient);
#     endif

      /* The following just changes the error messages: */
      pm->encoding_ignored = 1;
   }
6766

6767 6768 6769 6770 6771
   else
   {
      data.red_to_set = -1;
      data.green_to_set = -1;
   }
6772

6773 6774 6775 6776 6777 6778 6779
   /* Adjust the error limit in the png_modifier because of the larger errors
    * produced in the digitization during the gamma handling.
    */
   if (data.gamma != 1) /* Use gamma tables */
   {
      if (that->this.bit_depth == 16 || pm->assume_16_bit_calculations)
      {
6780 6781 6782 6783 6784 6785 6786 6787
         /* The computations have the form:
          *
          *    r * rc + g * gc + b * bc
          *
          *  Each component of which is +/-1/65535 from the gamma_to_1 table
          *  lookup, resulting in a base error of +/-6.  The gamma_from_1
          *  conversion adds another +/-2 in the 16-bit case and
          *  +/-(1<<(15-PNG_MAX_GAMMA_8)) in the 8-bit case.
6788
          */
6789
         that->pm->limit +=
6790 6791 6792 6793 6794 6795 6796
#        if PNG_MAX_GAMMA_8 < 14
               pow((that->this.bit_depth == 16 ?
                  8. : 6. + (1<<(15-PNG_MAX_GAMMA_8)))/65535, data.gamma);
#        else
               pow((that->this.bit_depth == 16 ?
                  8. : 8. + (1<<(15-PNG_MAX_GAMMA_8)))/65535, data.gamma);
#        endif
6797
      }
6798

6799 6800 6801 6802 6803
      else
      {
         /* Rounding to 8 bits in the linear space causes massive errors which
          * will trigger the error check in transform_range_check.  Fix that
          * here by taking the gamma encoding into account.
6804 6805 6806 6807 6808 6809 6810 6811 6812
          *
          * When DIGITIZE is set because a pre-1.7 version of libpng is being
          * tested allow a bigger slack.
          *
          * NOTE: this magic number was determined by experiment to be 1.1 (when
          * using fixed point arithmetic).  There's no great merit to the value
          * below, however it only affects the limit used for checking for
          * internal calculation errors, not the actual limit imposed by
          * pngvalid on the output errors.
6813
          */
6814
         that->pm->limit +=
6815
#        if DIGITIZE
6816
             pow(1.1 /255, data.gamma);
6817
#        else
6818
             pow(1.0 /255, data.gamma);
6819
#        endif
6820 6821
      }
   }
6822

6823 6824 6825 6826 6827
   else
   {
      /* With no gamma correction a large error comes from the truncation of the
       * calculation in the 8 bit case, allow for that here.
       */
6828
      if (that->this.bit_depth != 16 && !pm->assume_16_bit_calculations)
6829 6830
         that->pm->limit += 4E-3;
   }
6831 6832 6833 6834 6835 6836 6837 6838 6839
}

static void
image_transform_png_set_rgb_to_gray_set(PNG_CONST image_transform *this,
    transform_display *that, png_structp pp, png_infop pi)
{
   PNG_CONST int error_action = 1; /* no error, no defines in png.h */

#  ifdef PNG_FLOATING_POINT_SUPPORTED
6840
      png_set_rgb_to_gray(pp, error_action, data.red_to_set, data.green_to_set);
6841
#  else
6842 6843
      png_set_rgb_to_gray_fixed(pp, error_action, data.red_to_set,
         data.green_to_set);
6844 6845
#  endif

6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956
#  ifdef PNG_READ_cHRM_SUPPORTED
      if (that->pm->current_encoding != 0)
      {
         /* We have an encoding so a cHRM chunk may have been set; if so then
          * check that the libpng APIs give the correct (X,Y,Z) values within
          * some margin of error for the round trip through the chromaticity
          * form.
          */
#        ifdef PNG_FLOATING_POINT_SUPPORTED
#           define API_function png_get_cHRM_XYZ
#           define API_form "FP"
#           define API_type double
#           define API_cvt(x) (x)
#        else
#           define API_function png_get_cHRM_XYZ_fixed
#           define API_form "fixed"
#           define API_type png_fixed_point
#           define API_cvt(x) ((double)(x)/PNG_FP_1)
#        endif

         API_type rX, gX, bX;
         API_type rY, gY, bY;
         API_type rZ, gZ, bZ;

         if ((API_function(pp, pi, &rX, &rY, &rZ, &gX, &gY, &gZ, &bX, &bY, &bZ)
               & PNG_INFO_cHRM) != 0)
         {
            double maxe;
            PNG_CONST char *el;
            color_encoding e, o;

            /* Expect libpng to return a normalized result, but the original
             * color space encoding may not be normalized.
             */
            modifier_current_encoding(that->pm, &o);
            normalize_color_encoding(&o);

            /* Sanity check the pngvalid code - the coefficients should match
             * the normalized Y values of the encoding unless they were
             * overridden.
             */
            if (data.red_to_set == -1 && data.green_to_set == -1 &&
               (fabs(o.red.Y - data.red_coefficient) > DBL_EPSILON ||
               fabs(o.green.Y - data.green_coefficient) > DBL_EPSILON ||
               fabs(o.blue.Y - data.blue_coefficient) > DBL_EPSILON))
               png_error(pp, "internal pngvalid cHRM coefficient error");

            /* Generate a colour space encoding. */
            e.gamma = o.gamma; /* not used */
            e.red.X = API_cvt(rX);
            e.red.Y = API_cvt(rY);
            e.red.Z = API_cvt(rZ);
            e.green.X = API_cvt(gX);
            e.green.Y = API_cvt(gY);
            e.green.Z = API_cvt(gZ);
            e.blue.X = API_cvt(bX);
            e.blue.Y = API_cvt(bY);
            e.blue.Z = API_cvt(bZ);

            /* This should match the original one from the png_modifier, within
             * the range permitted by the libpng fixed point representation.
             */
            maxe = 0;
            el = "-"; /* Set to element name with error */

#           define CHECK(col,x)\
            {\
               double err = fabs(o.col.x - e.col.x);\
               if (err > maxe)\
               {\
                  maxe = err;\
                  el = #col "(" #x ")";\
               }\
            }

            CHECK(red,X)
            CHECK(red,Y)
            CHECK(red,Z)
            CHECK(green,X)
            CHECK(green,Y)
            CHECK(green,Z)
            CHECK(blue,X)
            CHECK(blue,Y)
            CHECK(blue,Z)

            /* Here in both fixed and floating cases to check the values read
             * from the cHRm chunk.  PNG uses fixed point in the cHRM chunk, so
             * we can't expect better than +/-.5E-5 on the result, allow 1E-5.
             */
            if (maxe >= 1E-5)
            {
               size_t pos = 0;
               char buffer[256];

               pos = safecat(buffer, sizeof buffer, pos, API_form);
               pos = safecat(buffer, sizeof buffer, pos, " cHRM ");
               pos = safecat(buffer, sizeof buffer, pos, el);
               pos = safecat(buffer, sizeof buffer, pos, " error: ");
               pos = safecatd(buffer, sizeof buffer, pos, maxe, 7);
               pos = safecat(buffer, sizeof buffer, pos, " ");
               /* Print the color space without the gamma value: */
               pos = safecat_color_encoding(buffer, sizeof buffer, pos, &o, 0);
               pos = safecat(buffer, sizeof buffer, pos, " -> ");
               pos = safecat_color_encoding(buffer, sizeof buffer, pos, &e, 0);

               png_error(pp, buffer);
            }
         }
      }
#  endif /* READ_cHRM */

6957 6958 6959 6960 6961
   this->next->set(this->next, that, pp, pi);
}

static void
image_transform_png_set_rgb_to_gray_mod(PNG_CONST image_transform *this,
6962 6963
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6964 6965 6966
{
   if ((that->colour_type & PNG_COLOR_MASK_COLOR) != 0)
   {
6967 6968
      double gray, err;

6969
      if (that->colour_type == PNG_COLOR_TYPE_PALETTE)
6970
         image_pixel_convert_PLTE(that);
6971 6972

      /* Image now has RGB channels... */
6973
#  if DIGITIZE
6974 6975
      {
         PNG_CONST png_modifier *pm = display->pm;
6976 6977 6978 6979 6980
         const unsigned int sample_depth = that->sample_depth;
         const unsigned int calc_depth = (pm->assume_16_bit_calculations ? 16 :
            sample_depth);
         const unsigned int gamma_depth = (sample_depth == 16 ? 16 :
            (pm->assume_16_bit_calculations ? PNG_MAX_GAMMA_8 : sample_depth));
6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995
         int isgray;
         double r, g, b;
         double rlo, rhi, glo, ghi, blo, bhi, graylo, grayhi;

         /* Do this using interval arithmetic, otherwise it is too difficult to
          * handle the errors correctly.
          *
          * To handle the gamma correction work out the upper and lower bounds
          * of the digitized value.  Assume rounding here - normally the values
          * will be identical after this operation if there is only one
          * transform, feel free to delete the png_error checks on this below in
          * the future (this is just me trying to ensure it works!)
          */
         r = rlo = rhi = that->redf;
         rlo -= that->rede;
6996
         rlo = digitize(rlo, calc_depth, 1/*round*/);
6997
         rhi += that->rede;
6998
         rhi = digitize(rhi, calc_depth, 1/*round*/);
6999 7000 7001

         g = glo = ghi = that->greenf;
         glo -= that->greene;
7002
         glo = digitize(glo, calc_depth, 1/*round*/);
7003
         ghi += that->greene;
7004
         ghi = digitize(ghi, calc_depth, 1/*round*/);
7005 7006 7007

         b = blo = bhi = that->bluef;
         blo -= that->bluee;
7008
         blo = digitize(blo, calc_depth, 1/*round*/);
7009
         bhi += that->greene;
7010
         bhi = digitize(bhi, calc_depth, 1/*round*/);
7011 7012 7013 7014 7015 7016

         isgray = r==g && g==b;

         if (data.gamma != 1)
         {
            PNG_CONST double power = 1/data.gamma;
7017
            PNG_CONST double abse = calc_depth == 16 ? .5/65535 : .5/255;
7018 7019 7020 7021 7022 7023 7024 7025

            /* 'abse' is the absolute error permitted in linear calculations. It
             * is used here to capture the error permitted in the handling
             * (undoing) of the gamma encoding.  Once again digitization occurs
             * to handle the upper and lower bounds of the values.  This is
             * where the real errors are introduced.
             */
            r = pow(r, power);
7026 7027
            rlo = digitize(pow(rlo, power)-abse, calc_depth, 1);
            rhi = digitize(pow(rhi, power)+abse, calc_depth, 1);
7028 7029

            g = pow(g, power);
7030 7031
            glo = digitize(pow(glo, power)-abse, calc_depth, 1);
            ghi = digitize(pow(ghi, power)+abse, calc_depth, 1);
7032 7033

            b = pow(b, power);
7034 7035
            blo = digitize(pow(blo, power)-abse, calc_depth, 1);
            bhi = digitize(pow(bhi, power)+abse, calc_depth, 1);
7036 7037 7038 7039 7040 7041 7042 7043 7044
         }

         /* Now calculate the actual gray values.  Although the error in the
          * coefficients depends on whether they were specified on the command
          * line (in which case truncation to 15 bits happened) or not (rounding
          * was used) the maxium error in an individual coefficient is always
          * 1/32768, because even in the rounding case the requirement that
          * coefficients add up to 32768 can cause a larger rounding error.
          *
7045
          * The only time when rounding doesn't occur in 1.5.5 and later is when
7046 7047 7048 7049 7050 7051
          * the non-gamma code path is used for less than 16 bit data.
          */
         gray = r * data.red_coefficient + g * data.green_coefficient +
            b * data.blue_coefficient;

         {
7052
            PNG_CONST int do_round = data.gamma != 1 || calc_depth == 16;
7053 7054
            PNG_CONST double ce = 1. / 32768;

7055
            graylo = digitize(rlo * (data.red_coefficient-ce) +
7056
               glo * (data.green_coefficient-ce) +
7057
               blo * (data.blue_coefficient-ce), gamma_depth, do_round);
7058 7059 7060
            if (graylo <= 0)
               graylo = 0;

7061
            grayhi = digitize(rhi * (data.red_coefficient+ce) +
7062
               ghi * (data.green_coefficient+ce) +
7063
               bhi * (data.blue_coefficient+ce), gamma_depth, do_round);
7064 7065 7066 7067 7068 7069 7070 7071 7072 7073
            if (grayhi >= 1)
               grayhi = 1;
         }

         /* And invert the gamma. */
         if (data.gamma != 1)
         {
            PNG_CONST double power = data.gamma;

            gray = pow(gray, power);
7074 7075
            graylo = digitize(pow(graylo, power), sample_depth, 1);
            grayhi = digitize(pow(grayhi, power), sample_depth, 1);
7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092
         }

         /* Now the error can be calculated.
          *
          * If r==g==b because there is no overall gamma correction libpng
          * currently preserves the original value.
          */
         if (isgray)
            err = (that->rede + that->greene + that->bluee)/3;

         else
         {
            err = fabs(grayhi-gray);
            if (fabs(gray - graylo) > err)
               err = fabs(graylo-gray);

            /* Check that this worked: */
7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201
            if (err > pm->limit)
            {
               size_t pos = 0;
               char buffer[128];

               pos = safecat(buffer, sizeof buffer, pos, "rgb_to_gray error ");
               pos = safecatd(buffer, sizeof buffer, pos, err, 6);
               pos = safecat(buffer, sizeof buffer, pos, " exceeds limit ");
               pos = safecatd(buffer, sizeof buffer, pos, pm->limit, 6);
               png_error(pp, buffer);
            }
         }
      }
#  else  /* DIGITIZE */
      {
         double r = that->redf;
         double re = that->rede;
         double g = that->greenf;
         double ge = that->greene;
         double b = that->bluef;
         double be = that->bluee;

         /* The true gray case involves no math. */
         if (r == g && r == b)
         {
            gray = r;
            err = re;
            if (err < ge) err = ge;
            if (err < be) err = be;
         }

         else if (data.gamma == 1)
         {
            /* There is no need to do the conversions to and from linear space,
             * so the calculation should be a lot more accurate.  There is a
             * built in 1/32768 error in the coefficients because they only have
             * 15 bits and are adjusted to make sure they add up to 32768, so
             * the result may have an additional error up to 1/32768.  (Note
             * that adding the 1/32768 here avoids needing to increase the
             * global error limits to take this into account.)
             */
            gray = r * data.red_coefficient + g * data.green_coefficient +
               b * data.blue_coefficient;
            err = re * data.red_coefficient + ge * data.green_coefficient +
               be * data.blue_coefficient + 1./32768 + gray * 5 * DBL_EPSILON;
         }

         else
         {
            /* The calculation happens in linear space, and this produces much
             * wider errors in the encoded space.  These are handled here by
             * factoring the errors in to the calculation.  There are two table
             * lookups in the calculation and each introduces a quantization
             * error defined by the table size.
             */
            PNG_CONST png_modifier *pm = display->pm;
            double in_qe = (that->sample_depth > 8 ? .5/65535 : .5/255);
            double out_qe = (that->sample_depth > 8 ? .5/65535 :
               (pm->assume_16_bit_calculations ? .5/(1<<PNG_MAX_GAMMA_8) :
               .5/255));
            double rhi, ghi, bhi, grayhi;
            double g1 = 1/data.gamma;

            rhi = r + re + in_qe; if (rhi > 1) rhi = 1;
            r -= re + in_qe; if (r < 0) r = 0;
            ghi = g + ge + in_qe; if (ghi > 1) ghi = 1;
            g -= ge + in_qe; if (g < 0) g = 0;
            bhi = b + be + in_qe; if (bhi > 1) bhi = 1;
            b -= be + in_qe; if (b < 0) b = 0;

            r = pow(r, g1)*(1-DBL_EPSILON); rhi = pow(rhi, g1)*(1+DBL_EPSILON);
            g = pow(g, g1)*(1-DBL_EPSILON); ghi = pow(ghi, g1)*(1+DBL_EPSILON);
            b = pow(b, g1)*(1-DBL_EPSILON); bhi = pow(bhi, g1)*(1+DBL_EPSILON);

            /* Work out the lower and upper bounds for the gray value in the
             * encoded space, then work out an average and error.  Remove the
             * previously added input quantization error at this point.
             */
            gray = r * data.red_coefficient + g * data.green_coefficient +
               b * data.blue_coefficient - 1./32768 - out_qe;
            if (gray <= 0)
               gray = 0;
            else
            {
               gray *= (1 - 6 * DBL_EPSILON);
               gray = pow(gray, data.gamma) * (1-DBL_EPSILON);
            }

            grayhi = rhi * data.red_coefficient + ghi * data.green_coefficient +
               bhi * data.blue_coefficient + 1./32768 + out_qe;
            grayhi *= (1 + 6 * DBL_EPSILON);
            if (grayhi >= 1)
               grayhi = 1;
            else
               grayhi = pow(grayhi, data.gamma) * (1+DBL_EPSILON);

            err = (grayhi - gray) / 2;
            gray = (grayhi + gray) / 2;

            if (err <= in_qe)
               err = gray * DBL_EPSILON;

            else
               err -= in_qe;

            /* Validate that the error is within limits (this has caused
             * problems before, it's much easier to detect them here.)
             */
            if (err > pm->limit)
7202 7203 7204 7205 7206 7207 7208
            {
               size_t pos = 0;
               char buffer[128];

               pos = safecat(buffer, sizeof buffer, pos, "rgb_to_gray error ");
               pos = safecatd(buffer, sizeof buffer, pos, err, 6);
               pos = safecat(buffer, sizeof buffer, pos, " exceeds limit ");
7209
               pos = safecatd(buffer, sizeof buffer, pos, pm->limit, 6);
7210 7211 7212 7213
               png_error(pp, buffer);
            }
         }
      }
7214
#  endif /* !DIGITIZE */
7215 7216 7217

      that->bluef = that->greenf = that->redf = gray;
      that->bluee = that->greene = that->rede = err;
7218 7219 7220 7221 7222 7223 7224 7225

      /* The sBIT is the minium of the three colour channel sBITs. */
      if (that->red_sBIT > that->green_sBIT)
         that->red_sBIT = that->green_sBIT;
      if (that->red_sBIT > that->blue_sBIT)
         that->red_sBIT = that->blue_sBIT;
      that->blue_sBIT = that->green_sBIT = that->red_sBIT;

7226
      /* And remove the colour bit in the type: */
7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237
      if (that->colour_type == PNG_COLOR_TYPE_RGB)
         that->colour_type = PNG_COLOR_TYPE_GRAY;
      else if (that->colour_type == PNG_COLOR_TYPE_RGB_ALPHA)
         that->colour_type = PNG_COLOR_TYPE_GRAY_ALPHA;
   }

   this->next->mod(this->next, that, pp, display);
}

static int
image_transform_png_set_rgb_to_gray_add(image_transform *this,
7238
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
7239
{
7240
   UNUSED(bit_depth)
7241 7242 7243 7244 7245 7246 7247

   this->next = *that;
   *that = this;

   return (colour_type & PNG_COLOR_MASK_COLOR) != 0;
}

7248
#undef data
7249 7250 7251
IT(rgb_to_gray);
#undef PT
#define PT ITSTRUCT(rgb_to_gray)
7252 7253
#undef image_transform_ini
#define image_transform_ini image_transform_default_ini
7254
#endif /* PNG_READ_RGB_TO_GRAY_SUPPORTED */
7255

7256
#ifdef PNG_READ_BACKGROUND_SUPPORTED
7257 7258 7259 7260 7261 7262
/* png_set_background(png_structp, png_const_color_16p background_color,
 *    int background_gamma_code, int need_expand, double background_gamma)
 * png_set_background_fixed(png_structp, png_const_color_16p background_color,
 *    int background_gamma_code, int need_expand,
 *    png_fixed_point background_gamma)
 *
7263
 * This ignores the gamma (at present.)
7264
*/
7265 7266 7267
#define data ITDATA(background)
static image_pixel data;

7268 7269 7270 7271
static void
image_transform_png_set_background_set(PNG_CONST image_transform *this,
    transform_display *that, png_structp pp, png_infop pi)
{
7272 7273
   png_byte colour_type, bit_depth;
   png_byte random_bytes[8]; /* 8 bytes - 64 bits - the biggest pixel */
7274
   int expand;
7275 7276
   png_color_16 back;

7277 7278 7279 7280 7281 7282 7283 7284 7285
   /* We need a background colour, because we don't know exactly what transforms
    * have been set we have to supply the colour in the original file format and
    * so we need to know what that is!  The background colour is stored in the
    * transform_display.
    */
   RANDOMIZE(random_bytes);

   /* Read the random value, for colour type 3 the background colour is actually
    * expressed as a 24bit rgb, not an index.
7286
    */
7287 7288 7289 7290 7291
   colour_type = that->this.colour_type;
   if (colour_type == 3)
   {
      colour_type = PNG_COLOR_TYPE_RGB;
      bit_depth = 8;
7292
      expand = 0; /* passing in an RGB not a pixel index */
7293 7294 7295
   }

   else
7296
   {
7297
      bit_depth = that->this.bit_depth;
7298 7299
      expand = 1;
   }
7300

7301
   image_pixel_init(&data, random_bytes, colour_type,
7302
      bit_depth, 0/*x*/, 0/*unused: palette*/);
7303

7304 7305 7306 7307 7308 7309 7310
   /* Extract the background colour from this image_pixel, but make sure the
    * unused fields of 'back' are garbage.
    */
   RANDOMIZE(back);

   if (colour_type & PNG_COLOR_MASK_COLOR)
   {
7311 7312 7313
      back.red = (png_uint_16)data.red;
      back.green = (png_uint_16)data.green;
      back.blue = (png_uint_16)data.blue;
7314 7315 7316
   }

   else
7317
      back.gray = (png_uint_16)data.red;
7318

7319
#  ifdef PNG_FLOATING_POINT_SUPPORTED
7320
      png_set_background(pp, &back, PNG_BACKGROUND_GAMMA_FILE, expand, 0);
7321
#  else
7322
      png_set_background_fixed(pp, &back, PNG_BACKGROUND_GAMMA_FILE, expand, 0);
7323 7324 7325 7326 7327 7328 7329
#  endif

   this->next->set(this->next, that, pp, pi);
}

static void
image_transform_png_set_background_mod(PNG_CONST image_transform *this,
7330 7331
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
7332
{
7333 7334
   /* Check for tRNS first: */
   if (that->have_tRNS && that->colour_type != PNG_COLOR_TYPE_PALETTE)
7335 7336
      image_pixel_add_alpha(that, &display->this);

7337 7338
   /* This is only necessary if the alpha value is less than 1. */
   if (that->alphaf < 1)
7339
   {
7340
      /* Now we do the background calculation without any gamma correction. */
7341 7342
      if (that->alphaf <= 0)
      {
7343 7344 7345
         that->redf = data.redf;
         that->greenf = data.greenf;
         that->bluef = data.bluef;
7346

7347 7348 7349
         that->rede = data.rede;
         that->greene = data.greene;
         that->bluee = data.bluee;
7350

7351 7352 7353
         that->red_sBIT= data.red_sBIT;
         that->green_sBIT= data.green_sBIT;
         that->blue_sBIT= data.blue_sBIT;
7354 7355
      }

7356
      else /* 0 < alpha < 1 */
7357
      {
7358 7359
         double alf = 1 - that->alphaf;

7360 7361
         that->redf = that->redf * that->alphaf + data.redf * alf;
         that->rede = that->rede * that->alphaf + data.rede * alf +
7362
            DBL_EPSILON;
7363 7364
         that->greenf = that->greenf * that->alphaf + data.greenf * alf;
         that->greene = that->greene * that->alphaf + data.greene * alf +
7365
            DBL_EPSILON;
7366 7367
         that->bluef = that->bluef * that->alphaf + data.bluef * alf;
         that->bluee = that->bluee * that->alphaf + data.bluee * alf +
7368 7369 7370
            DBL_EPSILON;
      }

7371
      /* Remove the alpha type and set the alpha (not in that order.) */
7372 7373 7374 7375 7376 7377 7378
      that->alphaf = 1;
      that->alphae = 0;

      if (that->colour_type == PNG_COLOR_TYPE_RGB_ALPHA)
         that->colour_type = PNG_COLOR_TYPE_RGB;
      else if (that->colour_type == PNG_COLOR_TYPE_GRAY_ALPHA)
         that->colour_type = PNG_COLOR_TYPE_GRAY;
7379
      /* PNG_COLOR_TYPE_PALETTE is not changed */
7380 7381
   }

7382 7383 7384 7385 7386
   this->next->mod(this->next, that, pp, display);
}

#define image_transform_png_set_background_add image_transform_default_add

7387
#undef data
7388 7389 7390 7391
IT(background);
#undef PT
#define PT ITSTRUCT(background)
#endif /* PNG_READ_BACKGROUND_SUPPORTED */
7392

7393 7394
/* This may just be 'end' if all the transforms are disabled! */
static image_transform *PNG_CONST image_transform_first = &PT;
7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406

static void
transform_enable(PNG_CONST char *name)
{
   /* Everything starts out enabled, so if we see an 'enable' disabled
    * everything else the first time round.
    */
   static int all_disabled = 0;
   int found_it = 0;
   image_transform *list = image_transform_first;

   while (list != &image_transform_end)
7407
   {
7408 7409 7410 7411 7412 7413 7414 7415 7416
      if (strcmp(list->name, name) == 0)
      {
         list->enable = 1;
         found_it = 1;
      }
      else if (!all_disabled)
         list->enable = 0;

      list = list->list;
7417 7418
   }

7419 7420 7421 7422 7423 7424
   all_disabled = 1;

   if (!found_it)
   {
      fprintf(stderr, "pngvalid: --transform-enable=%s: unknown transform\n",
         name);
7425
      exit(99);
7426
   }
7427 7428
}

7429 7430
static void
transform_disable(PNG_CONST char *name)
7431
{
7432
   image_transform *list = image_transform_first;
7433

7434 7435 7436 7437 7438 7439 7440
   while (list != &image_transform_end)
   {
      if (strcmp(list->name, name) == 0)
      {
         list->enable = 0;
         return;
      }
7441

7442 7443
      list = list->list;
   }
7444

7445 7446
   fprintf(stderr, "pngvalid: --transform-disable=%s: unknown transform\n",
      name);
7447
   exit(99);
7448 7449
}

7450 7451 7452 7453 7454
static void
image_transform_reset_count(void)
{
   image_transform *next = image_transform_first;
   int count = 0;
7455

7456 7457 7458 7459 7460 7461 7462
   while (next != &image_transform_end)
   {
      next->local_use = 0;
      next->next = 0;
      next = next->list;
      ++count;
   }
7463

7464 7465 7466 7467 7468 7469 7470 7471
   /* This can only happen if we every have more than 32 transforms (excluding
    * the end) in the list.
    */
   if (count > 32) abort();
}

static int
image_transform_test_counter(png_uint_32 counter, unsigned int max)
7472
{
7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490
   /* Test the list to see if there is any point contining, given a current
    * counter and a 'max' value.
    */
   image_transform *next = image_transform_first;

   while (next != &image_transform_end)
   {
      /* For max 0 or 1 continue until the counter overflows: */
      counter >>= 1;

      /* Continue if any entry hasn't reacked the max. */
      if (max > 1 && next->local_use < max)
         return 1;
      next = next->list;
   }

   return max <= 1 && counter == 0;
}
7491 7492

static png_uint_32
7493
image_transform_add(PNG_CONST image_transform **this, unsigned int max,
7494 7495 7496
   png_uint_32 counter, char *name, size_t sizeof_name, size_t *pos,
   png_byte colour_type, png_byte bit_depth)
{
7497
   for (;;) /* until we manage to add something */
7498
   {
7499 7500
      png_uint_32 mask;
      image_transform *list;
7501

7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514
      /* Find the next counter value, if the counter is zero this is the start
       * of the list.  This routine always returns the current counter (not the
       * next) so it returns 0 at the end and expects 0 at the beginning.
       */
      if (counter == 0) /* first time */
      {
         image_transform_reset_count();
         if (max <= 1)
            counter = 1;
         else
            counter = random_32();
      }
      else /* advance the counter */
7515
      {
7516 7517 7518 7519 7520 7521 7522
         switch (max)
         {
            case 0:  ++counter; break;
            case 1:  counter <<= 1; break;
            default: counter = random_32(); break;
         }
      }
7523

7524 7525 7526 7527
      /* Now add all these items, if possible */
      *this = &image_transform_end;
      list = image_transform_first;
      mask = 1;
7528

7529 7530 7531 7532 7533
      /* Go through the whole list adding anything that the counter selects: */
      while (list != &image_transform_end)
      {
         if ((counter & mask) != 0 && list->enable &&
             (max == 0 || list->local_use < max))
7534
         {
7535 7536
            /* Candidate to add: */
            if (list->add(list, this, colour_type, bit_depth) || max == 0)
7537
            {
7538 7539 7540
               /* Added, so add to the name too. */
               *pos = safecat(name, sizeof_name, *pos, " +");
               *pos = safecat(name, sizeof_name, *pos, list->name);
7541 7542
            }

7543
            else
7544
            {
7545
               /* Not useful and max>0, so remove it from *this: */
7546 7547
               *this = list->next;
               list->next = 0;
7548

7549 7550 7551 7552 7553
               /* And, since we know it isn't useful, stop it being added again
                * in this run:
                */
               list->local_use = max;
            }
7554 7555
         }

7556 7557 7558
         mask <<= 1;
         list = list->list;
      }
7559

7560 7561 7562
      /* Now if anything was added we have something to do. */
      if (*this != &image_transform_end)
         return counter;
7563

7564 7565 7566
      /* Nothing added, but was there anything in there to add? */
      if (!image_transform_test_counter(counter, max))
         return 0;
7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580
   }
}

#ifdef THIS_IS_THE_PROFORMA
static void
image_transform_png_set_@_set(PNG_CONST image_transform *this,
    transform_display *that, png_structp pp, png_infop pi)
{
   png_set_@(pp);
   this->next->set(this->next, that, pp, pi);
}

static void
image_transform_png_set_@_mod(PNG_CONST image_transform *this,
7581 7582
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646
{
   this->next->mod(this->next, that, pp, display);
}

static int
image_transform_png_set_@_add(image_transform *this,
    PNG_CONST image_transform **that, char *name, size_t sizeof_name,
    size_t *pos, png_byte colour_type, png_byte bit_depth)
{
   this->next = *that;
   *that = this;

   *pos = safecat(name, sizeof_name, *pos, " +@");

   return 1;
}

IT(@);
#endif

/* png_set_quantize(png_structp, png_colorp palette, int num_palette,
 *    int maximum_colors, png_const_uint_16p histogram, int full_quantize)
 *
 * Very difficult to validate this!
 */
/*NOTE: TBD NYI */

/* The data layout transforms are handled by swapping our own channel data,
 * necessarily these need to happen at the end of the transform list because the
 * semantic of the channels changes after these are executed.  Some of these,
 * like set_shift and set_packing, can't be done at present because they change
 * the layout of the data at the sub-sample level so sample() won't get the
 * right answer.
 */
/* png_set_invert_alpha */
/*NOTE: TBD NYI */

/* png_set_bgr */
/*NOTE: TBD NYI */

/* png_set_swap_alpha */
/*NOTE: TBD NYI */

/* png_set_swap */
/*NOTE: TBD NYI */

/* png_set_filler, (png_structp png_ptr, png_uint_32 filler, int flags)); */
/*NOTE: TBD NYI */

/* png_set_add_alpha, (png_structp png_ptr, png_uint_32 filler, int flags)); */
/*NOTE: TBD NYI */

/* png_set_packing */
/*NOTE: TBD NYI */

/* png_set_packswap */
/*NOTE: TBD NYI */

/* png_set_invert_mono */
/*NOTE: TBD NYI */

/* png_set_shift(png_structp, png_const_color_8p true_bits) */
/*NOTE: TBD NYI */

7647 7648
static void
perform_transform_test(png_modifier *pm)
7649
{
7650 7651
   png_byte colour_type = 0;
   png_byte bit_depth = 0;
7652
   unsigned int palette_number = 0;
7653

7654
   while (next_format(&colour_type, &bit_depth, &palette_number, 0))
7655
   {
7656
      png_uint_32 counter = 0;
7657 7658 7659 7660 7661 7662 7663 7664 7665 7666
      size_t base_pos;
      char name[64];

      base_pos = safecat(name, sizeof name, 0, "transform:");

      for (;;)
      {
         size_t pos = base_pos;
         PNG_CONST image_transform *list = 0;

7667
         /* 'max' is currently hardwired to '1'; this should be settable on the
7668 7669 7670 7671
          * command line.
          */
         counter = image_transform_add(&list, 1/*max*/, counter,
            name, sizeof name, &pos, colour_type, bit_depth);
7672 7673 7674 7675 7676

         if (counter == 0)
            break;

         /* The command line can change this to checking interlaced images. */
7677 7678 7679 7680 7681
         do
         {
            pm->repeat = 0;
            transform_test(pm, FILEID(colour_type, bit_depth, palette_number,
               pm->interlace_type, 0, 0, 0), list, name);
7682

7683 7684 7685 7686
            if (fail(pm))
               return;
         }
         while (pm->repeat);
7687 7688 7689
      }
   }
}
7690
#endif /* PNG_READ_TRANSFORMS_SUPPORTED */
7691 7692

/********************************* GAMMA TESTS ********************************/
7693
#ifdef PNG_READ_GAMMA_SUPPORTED
7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704
/* Reader callbacks and implementations, where they differ from the standard
 * ones.
 */
typedef struct gamma_display
{
   standard_display this;

   /* Parameters */
   png_modifier*    pm;
   double           file_gamma;
   double           screen_gamma;
7705
   double           background_gamma;
7706 7707 7708
   png_byte         sbit;
   int              threshold_test;
   int              use_input_precision;
7709
   int              scale16;
7710 7711 7712
   int              expand16;
   int              do_background;
   png_color_16     background_color;
7713 7714 7715 7716 7717 7718 7719

   /* Local variables */
   double       maxerrout;
   double       maxerrpc;
   double       maxerrabs;
} gamma_display;

7720 7721
#define ALPHA_MODE_OFFSET 4

7722 7723 7724
static void
gamma_display_init(gamma_display *dp, png_modifier *pm, png_uint_32 id,
    double file_gamma, double screen_gamma, png_byte sbit, int threshold_test,
7725
    int use_input_precision, int scale16, int expand16,
7726 7727
    int do_background, PNG_CONST png_color_16 *pointer_to_the_background_color,
    double background_gamma)
7728 7729
{
   /* Standard fields */
7730
   standard_display_init(&dp->this, &pm->this, id, 0/*do_interlace*/,
7731
      pm->use_update_info);
7732 7733 7734 7735 7736

   /* Parameter fields */
   dp->pm = pm;
   dp->file_gamma = file_gamma;
   dp->screen_gamma = screen_gamma;
7737
   dp->background_gamma = background_gamma;
7738 7739
   dp->sbit = sbit;
   dp->threshold_test = threshold_test;
7740
   dp->use_input_precision = use_input_precision;
7741
   dp->scale16 = scale16;
7742 7743 7744 7745 7746 7747
   dp->expand16 = expand16;
   dp->do_background = do_background;
   if (do_background && pointer_to_the_background_color != 0)
      dp->background_color = *pointer_to_the_background_color;
   else
      memset(&dp->background_color, 0, sizeof dp->background_color);
G
[devel]  
Glenn Randers-Pehrson 已提交
7748

7749 7750 7751
   /* Local variable fields */
   dp->maxerrout = dp->maxerrpc = dp->maxerrabs = 0;
}
G
[devel]  
Glenn Randers-Pehrson 已提交
7752

7753 7754 7755
static void
gamma_info_imp(gamma_display *dp, png_structp pp, png_infop pi)
{
7756
   /* Reuse the standard stuff as appropriate. */
7757
   standard_info_part1(&dp->this, pp, pi);
G
[devel]  
Glenn Randers-Pehrson 已提交
7758

7759 7760 7761 7762 7763
   /* If requested strip 16 to 8 bits - this is handled automagically below
    * because the output bit depth is read from the library.  Note that there
    * are interactions with sBIT but, internally, libpng makes sbit at most
    * PNG_MAX_GAMMA_8 when doing the following.
    */
7764
   if (dp->scale16)
7765
#     ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
7766
         png_set_scale_16(pp);
7767
#     else
7768 7769 7770 7771 7772 7773
         /* The following works both in 1.5.4 and earlier versions: */
#        ifdef PNG_READ_16_TO_8_SUPPORTED
            png_set_strip_16(pp);
#        else
            png_error(pp, "scale16 (16 to 8 bit conversion) not supported");
#        endif
7774
#     endif
G
[devel]  
Glenn Randers-Pehrson 已提交
7775

7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795
   if (dp->expand16)
#     ifdef PNG_READ_EXPAND_16_SUPPORTED
         png_set_expand_16(pp);
#     else
         png_error(pp, "expand16 (8 to 16 bit conversion) not supported");
#     endif

   if (dp->do_background >= ALPHA_MODE_OFFSET)
   {
#     ifdef PNG_READ_ALPHA_MODE_SUPPORTED
      {
         /* This tests the alpha mode handling, if supported. */
         int mode = dp->do_background - ALPHA_MODE_OFFSET;

         /* The gamma value is the output gamma, and is in the standard,
          * non-inverted, represenation.  It provides a default for the PNG file
          * gamma, but since the file has a gAMA chunk this does not matter.
          */
         PNG_CONST double sg = dp->screen_gamma;
#        ifndef PNG_FLOATING_POINT_SUPPORTED
7796
            PNG_CONST png_fixed_point g = fix(sg);
7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813
#        endif

#        ifdef PNG_FLOATING_POINT_SUPPORTED
            png_set_alpha_mode(pp, mode, sg);
#        else
            png_set_alpha_mode_fixed(pp, mode, g);
#        endif

         /* However, for the standard Porter-Duff algorithm the output defaults
          * to be linear, so if the test requires non-linear output it must be
          * corrected here.
          */
         if (mode == PNG_ALPHA_STANDARD && sg != 1)
         {
#           ifdef PNG_FLOATING_POINT_SUPPORTED
               png_set_gamma(pp, sg, dp->file_gamma);
#           else
7814
               png_fixed_point f = fix(dp->file_gamma);
7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830
               png_set_gamma_fixed(pp, g, f);
#           endif
         }
      }
#     else
         png_error(pp, "alpha mode handling not supported");
#     endif
   }

   else
   {
      /* Set up gamma processing. */
#     ifdef PNG_FLOATING_POINT_SUPPORTED
         png_set_gamma(pp, dp->screen_gamma, dp->file_gamma);
#     else
      {
7831 7832
         png_fixed_point s = fix(dp->screen_gamma);
         png_fixed_point f = fix(dp->file_gamma);
7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843
         png_set_gamma_fixed(pp, s, f);
      }
#     endif

      if (dp->do_background)
      {
#     ifdef PNG_READ_BACKGROUND_SUPPORTED
         /* NOTE: this assumes the caller provided the correct background gamma!
          */
         PNG_CONST double bg = dp->background_gamma;
#        ifndef PNG_FLOATING_POINT_SUPPORTED
7844
            PNG_CONST png_fixed_point g = fix(bg);
7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859
#        endif

#        ifdef PNG_FLOATING_POINT_SUPPORTED
            png_set_background(pp, &dp->background_color, dp->do_background,
               0/*need_expand*/, bg);
#        else
            png_set_background_fixed(pp, &dp->background_color,
               dp->do_background, 0/*need_expand*/, g);
#        endif
#     else
         png_error(pp, "png_set_background not supported");
#     endif
      }
   }

7860 7861 7862 7863 7864 7865 7866
   {
      int i = dp->this.use_update_info;
      /* Always do one call, even if use_update_info is 0. */
      do
         png_read_update_info(pp, pi);
      while (--i > 0);
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
7867

7868
   /* Now we may get a different cbRow: */
7869
   standard_info_part2(&dp->this, pp, pi, 1 /*images*/);
7870 7871
}

7872
static void PNGCBAPI
7873 7874
gamma_info(png_structp pp, png_infop pi)
{
7875 7876
   gamma_info_imp(voidcast(gamma_display*, png_get_progressive_ptr(pp)), pp,
      pi);
7877
}
7878

7879 7880 7881 7882 7883 7884
/* Validate a single component value - the routine gets the input and output
 * sample values as unscaled PNG component values along with a cache of all the
 * information required to validate the values.
 */
typedef struct validate_info
{
7885
   png_const_structp  pp;
7886 7887 7888 7889
   gamma_display *dp;
   png_byte sbit;
   int use_input_precision;
   int do_background;
7890
   int scale16;
7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904
   unsigned int sbit_max;
   unsigned int isbit_shift;
   unsigned int outmax;

   double gamma_correction; /* Overall correction required. */
   double file_inverse;     /* Inverse of file gamma. */
   double screen_gamma;
   double screen_inverse;   /* Inverse of screen gamma. */

   double background_red;   /* Linear background value, red or gray. */
   double background_green;
   double background_blue;

   double maxabs;
7905
   double maxpc;
7906 7907
   double maxcalc;
   double maxout;
7908
   double maxout_total;     /* Total including quantization error */
7909
   double outlog;
7910
   int    outquant;
7911 7912 7913 7914
}
validate_info;

static void
7915
init_validate_info(validate_info *vi, gamma_display *dp, png_const_structp pp,
7916
    int in_depth, int out_depth)
7917
{
7918
   PNG_CONST unsigned int outmax = (1U<<out_depth)-1;
7919 7920 7921

   vi->pp = pp;
   vi->dp = dp;
7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935

   if (dp->sbit > 0 && dp->sbit < in_depth)
   {
      vi->sbit = dp->sbit;
      vi->isbit_shift = in_depth - dp->sbit;
   }

   else
   {
      vi->sbit = (png_byte)in_depth;
      vi->isbit_shift = 0;
   }

   vi->sbit_max = (1U << vi->sbit)-1;
7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947

   /* This mimics the libpng threshold test, '0' is used to prevent gamma
    * correction in the validation test.
    */
   vi->screen_gamma = dp->screen_gamma;
   if (fabs(vi->screen_gamma-1) < PNG_GAMMA_THRESHOLD)
      vi->screen_gamma = vi->screen_inverse = 0;
   else
      vi->screen_inverse = 1/vi->screen_gamma;

   vi->use_input_precision = dp->use_input_precision;
   vi->outmax = outmax;
7948 7949 7950 7951 7952 7953
   vi->maxabs = abserr(dp->pm, in_depth, out_depth);
   vi->maxpc = pcerr(dp->pm, in_depth, out_depth);
   vi->maxcalc = calcerr(dp->pm, in_depth, out_depth);
   vi->maxout = outerr(dp->pm, in_depth, out_depth);
   vi->outquant = output_quantization_factor(dp->pm, in_depth, out_depth);
   vi->maxout_total = vi->maxout + vi->outquant * .5;
7954
   vi->outlog = outlog(dp->pm, in_depth, out_depth);
7955

7956 7957
   if ((dp->this.colour_type & PNG_COLOR_MASK_ALPHA) != 0 ||
      (dp->this.colour_type == 3 && dp->this.is_transparent))
7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000
   {
      vi->do_background = dp->do_background;

      if (vi->do_background != 0)
      {
         PNG_CONST double bg_inverse = 1/dp->background_gamma;
         double r, g, b;

         /* Caller must at least put the gray value into the red channel */
         r = dp->background_color.red; r /= outmax;
         g = dp->background_color.green; g /= outmax;
         b = dp->background_color.blue; b /= outmax;

#     if 0
         /* libpng doesn't do this optimization, if we do pngvalid will fail.
          */
         if (fabs(bg_inverse-1) >= PNG_GAMMA_THRESHOLD)
#     endif
         {
            r = pow(r, bg_inverse);
            g = pow(g, bg_inverse);
            b = pow(b, bg_inverse);
         }

         vi->background_red = r;
         vi->background_green = g;
         vi->background_blue = b;
      }
   }
   else
      vi->do_background = 0;

   if (vi->do_background == 0)
      vi->background_red = vi->background_green = vi->background_blue = 0;

   vi->gamma_correction = 1/(dp->file_gamma*dp->screen_gamma);
   if (fabs(vi->gamma_correction-1) < PNG_GAMMA_THRESHOLD)
      vi->gamma_correction = 0;

   vi->file_inverse = 1/dp->file_gamma;
   if (fabs(vi->file_inverse-1) < PNG_GAMMA_THRESHOLD)
      vi->file_inverse = 0;

8001
   vi->scale16 = dp->scale16;
8002 8003
}

8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014
/* This function handles composition of a single non-alpha component.  The
 * argument is the input sample value, in the range 0..1, and the alpha value.
 * The result is the composed, linear, input sample.  If alpha is less than zero
 * this is the alpha component and the function should not be called!
 */
static double
gamma_component_compose(int do_background, double input_sample, double alpha,
   double background, int *compose)
{
   switch (do_background)
   {
8015
#ifdef PNG_READ_BACKGROUND_SUPPORTED
8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032
      case PNG_BACKGROUND_GAMMA_SCREEN:
      case PNG_BACKGROUND_GAMMA_FILE:
      case PNG_BACKGROUND_GAMMA_UNIQUE:
         /* Standard PNG background processing. */
         if (alpha < 1)
         {
            if (alpha > 0)
            {
               input_sample = input_sample * alpha + background * (1-alpha);
               if (compose != NULL)
                  *compose = 1;
            }

            else
               input_sample = background;
         }
         break;
8033
#endif
8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065

#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
      case ALPHA_MODE_OFFSET + PNG_ALPHA_STANDARD:
      case ALPHA_MODE_OFFSET + PNG_ALPHA_BROKEN:
         /* The components are premultiplied in either case and the output is
          * gamma encoded (to get standard Porter-Duff we expect the output
          * gamma to be set to 1.0!)
          */
      case ALPHA_MODE_OFFSET + PNG_ALPHA_OPTIMIZED:
         /* The optimization is that the partial-alpha entries are linear
          * while the opaque pixels are gamma encoded, but this only affects the
          * output encoding.
          */
         if (alpha < 1)
         {
            if (alpha > 0)
            {
               input_sample *= alpha;
               if (compose != NULL)
                  *compose = 1;
            }

            else
               input_sample = 0;
         }
         break;
#endif

      default:
         /* Standard cases where no compositing is done (so the component
          * value is already correct.)
          */
8066 8067 8068
         UNUSED(alpha)
         UNUSED(background)
         UNUSED(compose)
8069 8070 8071 8072 8073 8074
         break;
   }

   return input_sample;
}

8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127
/* This API returns the encoded *input* component, in the range 0..1 */
static double
gamma_component_validate(PNG_CONST char *name, PNG_CONST validate_info *vi,
    PNG_CONST unsigned int id, PNG_CONST unsigned int od,
    PNG_CONST double alpha /* <0 for the alpha channel itself */,
    PNG_CONST double background /* component background value */)
{
   PNG_CONST unsigned int isbit = id >> vi->isbit_shift;
   PNG_CONST unsigned int sbit_max = vi->sbit_max;
   PNG_CONST unsigned int outmax = vi->outmax;
   PNG_CONST int do_background = vi->do_background;

   double i;

   /* First check on the 'perfect' result obtained from the digitized input
    * value, id, and compare this against the actual digitized result, 'od'.
    * 'i' is the input result in the range 0..1:
    */
   i = isbit; i /= sbit_max;

   /* Check for the fast route: if we don't do any background composition or if
    * this is the alpha channel ('alpha' < 0) or if the pixel is opaque then
    * just use the gamma_correction field to correct to the final output gamma.
    */
   if (alpha == 1 /* opaque pixel component */ || !do_background
#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
      || do_background == ALPHA_MODE_OFFSET + PNG_ALPHA_PNG
#endif
      || (alpha < 0 /* alpha channel */
#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
      && do_background != ALPHA_MODE_OFFSET + PNG_ALPHA_BROKEN
#endif
      ))
   {
      /* Then get the gamma corrected version of 'i' and compare to 'od', any
       * error less than .5 is insignificant - just quantization of the output
       * value to the nearest digital value (nevertheless the error is still
       * recorded - it's interesting ;-)
       */
      double encoded_sample = i;
      double encoded_error;

      /* alpha less than 0 indicates the alpha channel, which is always linear
       */
      if (alpha >= 0 && vi->gamma_correction > 0)
         encoded_sample = pow(encoded_sample, vi->gamma_correction);
      encoded_sample *= outmax;

      encoded_error = fabs(od-encoded_sample);

      if (encoded_error > vi->dp->maxerrout)
         vi->dp->maxerrout = encoded_error;

8128
      if (encoded_error < vi->maxout_total && encoded_error < vi->outlog)
8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141
         return i;
   }

   /* The slow route - attempt to do linear calculations. */
   /* There may be an error, or background processing is required, so calculate
    * the actual sample values - unencoded light intensity values.  Note that in
    * practice these are not completely unencoded because they include a
    * 'viewing correction' to decrease or (normally) increase the perceptual
    * contrast of the image.  There's nothing we can do about this - we don't
    * know what it is - so assume the unencoded value is perceptually linear.
    */
   {
      double input_sample = i; /* In range 0..1 */
8142
      double output, error, encoded_sample, encoded_error;
8143
      double es_lo, es_hi;
8144 8145
      int compose = 0;           /* Set to one if composition done */
      int output_is_encoded;     /* Set if encoded to screen gamma */
8146
      int log_max_error = 1;     /* Check maximum error values */
8147
      png_const_charp pass = 0;  /* Reason test passes (or 0 for fail) */
8148 8149 8150 8151

      /* Convert to linear light (with the above caveat.)  The alpha channel is
       * already linear.
       */
8152 8153 8154 8155
      if (alpha >= 0)
      {
         int tcompose;

8156
         if (vi->file_inverse > 0)
8157 8158 8159 8160 8161 8162 8163 8164 8165 8166
            input_sample = pow(input_sample, vi->file_inverse);

         /* Handle the compose processing: */
         tcompose = 0;
         input_sample = gamma_component_compose(do_background, input_sample,
            alpha, background, &tcompose);

         if (tcompose)
            compose = 1;
      }
8167 8168

      /* And similarly for the output value, but we need to check the background
8169
       * handling to linearize it correctly.
8170 8171 8172 8173
       */
      output = od;
      output /= outmax;

8174
      output_is_encoded = vi->screen_gamma > 0;
8175

8176 8177
      if (alpha < 0) /* The alpha channel */
      {
8178
#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
8179
         if (do_background != ALPHA_MODE_OFFSET + PNG_ALPHA_BROKEN)
8180
#endif
8181
         {
8182 8183 8184
            /* In all other cases the output alpha channel is linear already,
             * don't log errors here, they are much larger in linear data.
             */
8185
            output_is_encoded = 0;
8186
            log_max_error = 0;
8187
         }
8188 8189
      }

8190
#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
8191
      else /* A component */
8192
      {
8193 8194 8195 8196 8197 8198
         if (do_background == ALPHA_MODE_OFFSET + PNG_ALPHA_OPTIMIZED &&
            alpha < 1) /* the optimized case - linear output */
         {
            if (alpha > 0) log_max_error = 0;
            output_is_encoded = 0;
         }
8199
      }
8200
#endif
8201

8202 8203 8204
      if (output_is_encoded)
         output = pow(output, vi->screen_gamma);

8205 8206 8207 8208 8209 8210 8211 8212
      /* Calculate (or recalculate) the encoded_sample value and repeat the
       * check above (unnecessary if we took the fast route, but harmless.)
       */
      encoded_sample = input_sample;
      if (output_is_encoded)
         encoded_sample = pow(encoded_sample, vi->screen_inverse);
      encoded_sample *= outmax;

8213
      encoded_error = fabs(od-encoded_sample);
8214

8215 8216 8217 8218 8219
      /* Don't log errors in the alpha channel, or the 'optimized' case,
       * neither are significant to the overall perception.
       */
      if (log_max_error && encoded_error > vi->dp->maxerrout)
         vi->dp->maxerrout = encoded_error;
8220

8221 8222 8223
      if (encoded_error < vi->maxout_total)
      {
         if (encoded_error < vi->outlog)
8224
            return i;
8225 8226 8227 8228 8229

         /* Test passed but error is bigger than the log limit, record why the
          * test passed:
          */
         pass = "less than maxout:\n";
8230 8231
      }

8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242
      /* i: the original input value in the range 0..1
       *
       * pngvalid calculations:
       *  input_sample: linear result; i linearized and composed, range 0..1
       *  encoded_sample: encoded result; input_sample scaled to ouput bit depth
       *
       * libpng calculations:
       *  output: linear result; od scaled to 0..1 and linearized
       *  od: encoded result from libpng
       */

8243 8244 8245 8246 8247 8248 8249 8250 8251
      /* Now we have the numbers for real errors, both absolute values as as a
       * percentage of the correct value (output):
       */
      error = fabs(input_sample-output);

      if (log_max_error && error > vi->dp->maxerrabs)
         vi->dp->maxerrabs = error;

      /* The following is an attempt to ignore the tendency of quantization to
8252
       * dominate the percentage errors for lower result values:
8253
       */
8254
      if (log_max_error && input_sample > .5)
8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269
      {
         double percentage_error = error/input_sample;
         if (percentage_error > vi->dp->maxerrpc)
            vi->dp->maxerrpc = percentage_error;
      }

      /* Now calculate the digitization limits for 'encoded_sample' using the
       * 'max' values.  Note that maxout is in the encoded space but maxpc and
       * maxabs are in linear light space.
       *
       * First find the maximum error in linear light space, range 0..1:
       */
      {
         double tmp = input_sample * vi->maxpc;
         if (tmp < vi->maxabs) tmp = vi->maxabs;
8270 8271 8272 8273 8274 8275
         /* If 'compose' is true the composition was done in linear space using
          * integer arithmetic.  This introduces an extra error of +/- 0.5 (at
          * least) in the integer space used.  'maxcalc' records this, taking
          * into account the possibility that even for 16 bit output 8 bit space
          * may have been used.
          */
8276 8277
         if (compose && tmp < vi->maxcalc) tmp = vi->maxcalc;

8278 8279 8280
         /* The 'maxout' value refers to the encoded result, to compare with
          * this encode input_sample adjusted by the maximum error (tmp) above.
          */
8281 8282 8283 8284 8285 8286 8287 8288 8289
         es_lo = encoded_sample - vi->maxout;

         if (es_lo > 0 && input_sample-tmp > 0)
         {
            double low_value = input_sample-tmp;
            if (output_is_encoded)
               low_value = pow(low_value, vi->screen_inverse);
            low_value *= outmax;
            if (low_value < es_lo) es_lo = low_value;
8290 8291 8292

            /* Quantize this appropriately: */
            es_lo = ceil(es_lo / vi->outquant - .5) * vi->outquant;
8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306
         }

         else
            es_lo = 0;

         es_hi = encoded_sample + vi->maxout;

         if (es_hi < outmax && input_sample+tmp < 1)
         {
            double high_value = input_sample+tmp;
            if (output_is_encoded)
               high_value = pow(high_value, vi->screen_inverse);
            high_value *= outmax;
            if (high_value > es_hi) es_hi = high_value;
8307 8308

            es_hi = floor(es_hi / vi->outquant + .5) * vi->outquant;
8309 8310 8311 8312 8313 8314 8315 8316
         }

         else
            es_hi = outmax;
      }

      /* The primary test is that the final encoded value returned by the
       * library should be between the two limits (inclusive) that were
8317
       * calculated above.
8318
       */
8319 8320 8321 8322 8323 8324 8325 8326 8327 8328
      if (od >= es_lo && od <= es_hi)
      {
         /* The value passes, but we may need to log the information anyway. */
         if (encoded_error < vi->outlog)
            return i;

         if (pass == 0)
            pass = "within digitization limits:\n";
      }

8329
      {
8330 8331 8332
         /* There has been an error in processing, or we need to log this
          * value.
          */
8333 8334
         double is_lo, is_hi;

8335 8336 8337 8338
         /* pass is set at this point if either of the tests above would have
          * passed.  Don't do these additional tests here - just log the
          * original [es_lo..es_hi] values.
          */
8339
         if (pass == 0 && vi->use_input_precision && vi->dp->sbit)
8340 8341
         {
            /* Ok, something is wrong - this actually happens in current libpng
8342 8343
             * 16-to-8 processing.  Assume that the input value (id, adjusted
             * for sbit) can be anywhere between value-.5 and value+.5 - quite a
8344
             * large range if sbit is low.
8345 8346 8347 8348 8349 8350
             *
             * NOTE: at present because the libpng gamma table stuff has been
             * changed to use a rounding algorithm to correct errors in 8-bit
             * calculations the precise sbit calculation (a shift) has been
             * lost.  This can result in up to a +/-1 error in the presence of
             * an sbit less than the bit depth.
8351
             */
8352 8353 8354 8355 8356 8357
#           if PNG_LIBPNG_VER < 10700
#              define SBIT_ERROR .5
#           else
#              define SBIT_ERROR 1.
#           endif
            double tmp = (isbit - SBIT_ERROR)/sbit_max;
8358

8359 8360
            if (tmp <= 0)
               tmp = 0;
8361

8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373
            else if (alpha >= 0 && vi->file_inverse > 0 && tmp < 1)
               tmp = pow(tmp, vi->file_inverse);

            tmp = gamma_component_compose(do_background, tmp, alpha, background,
               NULL);

            if (output_is_encoded && tmp > 0 && tmp < 1)
               tmp = pow(tmp, vi->screen_inverse);

            is_lo = ceil(outmax * tmp - vi->maxout_total);

            if (is_lo < 0)
8374 8375
               is_lo = 0;

8376
            tmp = (isbit + SBIT_ERROR)/sbit_max;
8377

8378 8379
            if (tmp >= 1)
               tmp = 1;
8380

8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392
            else if (alpha >= 0 && vi->file_inverse > 0 && tmp < 1)
               tmp = pow(tmp, vi->file_inverse);

            tmp = gamma_component_compose(do_background, tmp, alpha, background,
               NULL);

            if (output_is_encoded && tmp > 0 && tmp < 1)
               tmp = pow(tmp, vi->screen_inverse);

            is_hi = floor(outmax * tmp + vi->maxout_total);

            if (is_hi > outmax)
8393 8394
               is_hi = outmax;

8395
            if (!(od < is_lo || od > is_hi))
8396 8397 8398 8399 8400 8401
            {
               if (encoded_error < vi->outlog)
                  return i;

               pass = "within input precision limits:\n";
            }
8402 8403 8404 8405 8406

            /* One last chance.  If this is an alpha channel and the 16to8
             * option has been used and 'inaccurate' scaling is used then the
             * bit reduction is obtained by simply using the top 8 bits of the
             * value.
8407 8408 8409
             *
             * This is only done for older libpng versions when the 'inaccurate'
             * (chop) method of scaling was used.
8410
             */
8411 8412 8413 8414 8415 8416 8417 8418 8419 8420
#           ifndef PNG_READ_16_TO_8_ACCURATE_SCALE_SUPPORTED
#              if PNG_LIBPNG_VER < 10504
                  /* This may be required for other components in the future,
                   * but at present the presence of gamma correction effectively
                   * prevents the errors in the component scaling (I don't quite
                   * understand why, but since it's better this way I care not
                   * to ask, JB 20110419.)
                   */
                  if (pass == 0 && alpha < 0 && vi->scale16 && vi->sbit > 8 &&
                     vi->sbit + vi->isbit_shift == 16)
8421
                  {
8422
                     tmp = ((id >> 8) - .5)/255;
8423

8424 8425 8426 8427 8428
                     if (tmp > 0)
                     {
                        is_lo = ceil(outmax * tmp - vi->maxout_total);
                        if (is_lo < 0) is_lo = 0;
                     }
8429

8430 8431
                     else
                        is_lo = 0;
8432

8433
                     tmp = ((id >> 8) + .5)/255;
8434

8435 8436 8437 8438 8439
                     if (tmp < 1)
                     {
                        is_hi = floor(outmax * tmp + vi->maxout_total);
                        if (is_hi > outmax) is_hi = outmax;
                     }
8440

8441 8442
                     else
                        is_hi = outmax;
8443

8444 8445 8446 8447 8448 8449 8450
                     if (!(od < is_lo || od > is_hi))
                     {
                        if (encoded_error < vi->outlog)
                           return i;

                        pass = "within 8 bit limits:\n";
                     }
8451
                  }
8452
#              endif
8453 8454 8455 8456 8457
#           endif
         }
         else /* !use_input_precision */
            is_lo = es_lo, is_hi = es_hi;

8458 8459 8460 8461
         /* Attempt to output a meaningful error/warning message: the message
          * output depends on the background/composite operation being performed
          * because this changes what parameters were actually used above.
          */
8462
         {
8463 8464 8465 8466 8467 8468
            size_t pos = 0;
            /* Need either 1/255 or 1/65535 precision here; 3 or 6 decimal
             * places.  Just use outmax to work out which.
             */
            int precision = (outmax >= 1000 ? 6 : 3);
            int use_input=1, use_background=0, do_compose=0;
8469 8470
            char msg[256];

8471 8472
            if (pass != 0)
               pos = safecat(msg, sizeof msg, pos, "\n\t");
8473

8474 8475 8476 8477 8478
            /* Set up the various flags, the output_is_encoded flag above
             * is also used below.  do_compose is just a double check.
             */
            switch (do_background)
            {
8479 8480 8481 8482 8483 8484 8485
#           ifdef PNG_READ_BACKGROUND_SUPPORTED
               case PNG_BACKGROUND_GAMMA_SCREEN:
               case PNG_BACKGROUND_GAMMA_FILE:
               case PNG_BACKGROUND_GAMMA_UNIQUE:
                  use_background = (alpha >= 0 && alpha < 1);
                  /*FALL THROUGH*/
#           endif
8486 8487 8488 8489 8490
#           ifdef PNG_READ_ALPHA_MODE_SUPPORTED
               case ALPHA_MODE_OFFSET + PNG_ALPHA_STANDARD:
               case ALPHA_MODE_OFFSET + PNG_ALPHA_BROKEN:
               case ALPHA_MODE_OFFSET + PNG_ALPHA_OPTIMIZED:
#           endif /* ALPHA_MODE_SUPPORTED */
8491
               do_compose = (alpha > 0 && alpha < 1);
8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637
               use_input = (alpha != 0);
               break;

            default:
               break;
            }

            /* Check the 'compose' flag */
            if (compose != do_compose)
               png_error(vi->pp, "internal error (compose)");

            /* 'name' is the component name */
            pos = safecat(msg, sizeof msg, pos, name);
            pos = safecat(msg, sizeof msg, pos, "(");
            pos = safecatn(msg, sizeof msg, pos, id);
            if (use_input || pass != 0/*logging*/)
            {
               if (isbit != id)
               {
                  /* sBIT has reduced the precision of the input: */
                  pos = safecat(msg, sizeof msg, pos, ", sbit(");
                  pos = safecatn(msg, sizeof msg, pos, vi->sbit);
                  pos = safecat(msg, sizeof msg, pos, "): ");
                  pos = safecatn(msg, sizeof msg, pos, isbit);
               }
               pos = safecat(msg, sizeof msg, pos, "/");
               /* The output is either "id/max" or "id sbit(sbit): isbit/max" */
               pos = safecatn(msg, sizeof msg, pos, vi->sbit_max);
            }
            pos = safecat(msg, sizeof msg, pos, ")");

            /* A component may have been multiplied (in linear space) by the
             * alpha value, 'compose' says whether this is relevant.
             */
            if (compose || pass != 0)
            {
               /* If any form of composition is being done report our
                * calculated linear value here (the code above doesn't record
                * the input value before composition is performed, so what
                * gets reported is the value after composition.)
                */
               if (use_input || pass != 0)
               {
                  if (vi->file_inverse > 0)
                  {
                     pos = safecat(msg, sizeof msg, pos, "^");
                     pos = safecatd(msg, sizeof msg, pos, vi->file_inverse, 2);
                  }

                  else
                     pos = safecat(msg, sizeof msg, pos, "[linear]");

                  pos = safecat(msg, sizeof msg, pos, "*(alpha)");
                  pos = safecatd(msg, sizeof msg, pos, alpha, precision);
               }

               /* Now record the *linear* background value if it was used
                * (this function is not passed the original, non-linear,
                * value but it is contained in the test name.)
                */
               if (use_background)
               {
                  pos = safecat(msg, sizeof msg, pos, use_input ? "+" : " ");
                  pos = safecat(msg, sizeof msg, pos, "(background)");
                  pos = safecatd(msg, sizeof msg, pos, background, precision);
                  pos = safecat(msg, sizeof msg, pos, "*");
                  pos = safecatd(msg, sizeof msg, pos, 1-alpha, precision);
               }
            }

            /* Report the calculated value (input_sample) and the linearized
             * libpng value (output) unless this is just a component gamma
             * correction.
             */
            if (compose || alpha < 0 || pass != 0)
            {
               pos = safecat(msg, sizeof msg, pos,
                  pass != 0 ? " =\n\t" : " = ");
               pos = safecatd(msg, sizeof msg, pos, input_sample, precision);
               pos = safecat(msg, sizeof msg, pos, " (libpng: ");
               pos = safecatd(msg, sizeof msg, pos, output, precision);
               pos = safecat(msg, sizeof msg, pos, ")");

               /* Finally report the output gamma encoding, if any. */
               if (output_is_encoded)
               {
                  pos = safecat(msg, sizeof msg, pos, " ^");
                  pos = safecatd(msg, sizeof msg, pos, vi->screen_inverse, 2);
                  pos = safecat(msg, sizeof msg, pos, "(to screen) =");
               }

               else
                  pos = safecat(msg, sizeof msg, pos, " [screen is linear] =");
            }

            if ((!compose && alpha >= 0) || pass != 0)
            {
               if (pass != 0) /* logging */
                  pos = safecat(msg, sizeof msg, pos, "\n\t[overall:");

               /* This is the non-composition case, the internal linear
                * values are irrelevant (though the log below will reveal
                * them.)  Output a much shorter warning/error message and report
                * the overall gamma correction.
                */
               if (vi->gamma_correction > 0)
               {
                  pos = safecat(msg, sizeof msg, pos, " ^");
                  pos = safecatd(msg, sizeof msg, pos, vi->gamma_correction, 2);
                  pos = safecat(msg, sizeof msg, pos, "(gamma correction) =");
               }

               else
                  pos = safecat(msg, sizeof msg, pos,
                     " [no gamma correction] =");

               if (pass != 0)
                  pos = safecat(msg, sizeof msg, pos, "]");
            }

            /* This is our calculated encoded_sample which should (but does
             * not) match od:
             */
            pos = safecat(msg, sizeof msg, pos, pass != 0 ? "\n\t" : " ");
            pos = safecatd(msg, sizeof msg, pos, is_lo, 1);
            pos = safecat(msg, sizeof msg, pos, " < ");
            pos = safecatd(msg, sizeof msg, pos, encoded_sample, 1);
            pos = safecat(msg, sizeof msg, pos, " (libpng: ");
            pos = safecatn(msg, sizeof msg, pos, od);
            pos = safecat(msg, sizeof msg, pos, ")");
            pos = safecat(msg, sizeof msg, pos, "/");
            pos = safecatn(msg, sizeof msg, pos, outmax);
            pos = safecat(msg, sizeof msg, pos, " < ");
            pos = safecatd(msg, sizeof msg, pos, is_hi, 1);

            if (pass == 0) /* The error condition */
            {
#              ifdef PNG_WARNINGS_SUPPORTED
                  png_warning(vi->pp, msg);
#              else
                  store_warning(vi->pp, msg);
#              endif
            }

            else /* logging this value */
               store_verbose(&vi->dp->pm->this, vi->pp, pass, msg);
8638 8639 8640 8641 8642 8643 8644
         }
      }
   }

   return i;
}

8645
static void
8646 8647
gamma_image_validate(gamma_display *dp, png_const_structp pp,
   png_infop pi)
8648 8649
{
   /* Get some constants derived from the input and output file formats: */
8650
   PNG_CONST png_store* PNG_CONST ps = dp->this.ps;
8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661
   PNG_CONST png_byte in_ct = dp->this.colour_type;
   PNG_CONST png_byte in_bd = dp->this.bit_depth;
   PNG_CONST png_uint_32 w = dp->this.w;
   PNG_CONST png_uint_32 h = dp->this.h;
   PNG_CONST size_t cbRow = dp->this.cbRow;
   PNG_CONST png_byte out_ct = png_get_color_type(pp, pi);
   PNG_CONST png_byte out_bd = png_get_bit_depth(pp, pi);

   /* There are three sources of error, firstly the quantization in the
    * file encoding, determined by sbit and/or the file depth, secondly
    * the output (screen) gamma and thirdly the output file encoding.
8662
    *
8663 8664 8665 8666 8667 8668 8669
    * Since this API receives the screen and file gamma in double
    * precision it is possible to calculate an exact answer given an input
    * pixel value.  Therefore we assume that the *input* value is exact -
    * sample/maxsample - calculate the corresponding gamma corrected
    * output to the limits of double precision arithmetic and compare with
    * what libpng returns.
    *
8670
    * Since the library must quantize the output to 8 or 16 bits there is
8671
    * a fundamental limit on the accuracy of the output of +/-.5 - this
8672
    * quantization limit is included in addition to the other limits
8673 8674 8675 8676 8677 8678
    * specified by the paramaters to the API.  (Effectively, add .5
    * everywhere.)
    *
    * The behavior of the 'sbit' paramter is defined by section 12.5
    * (sample depth scaling) of the PNG spec.  That section forces the
    * decoder to assume that the PNG values have been scaled if sBIT is
8679
    * present:
8680
    *
8681
    *     png-sample = floor( input-sample * (max-out/max-in) + .5);
8682 8683
    *
    * This means that only a subset of the possible PNG values should
8684
    * appear in the input. However, the spec allows the encoder to use a
8685 8686 8687 8688 8689 8690 8691 8692 8693 8694
    * variety of approximations to the above and doesn't require any
    * restriction of the values produced.
    *
    * Nevertheless the spec requires that the upper 'sBIT' bits of the
    * value stored in a PNG file be the original sample bits.
    * Consequently the code below simply scales the top sbit bits by
    * (1<<sbit)-1 to obtain an original sample value.
    *
    * Because there is limited precision in the input it is arguable that
    * an acceptable result is any valid result from input-.5 to input+.5.
8695
    * The basic tests below do not do this, however if 'use_input_precision'
8696
    * is set a subsequent test is performed above.
8697 8698
    */
   PNG_CONST unsigned int samples_per_pixel = (out_ct & 2U) ? 3U : 1U;
8699 8700
   int processing;
   png_uint_32 y;
8701 8702 8703 8704 8705
   PNG_CONST store_palette_entry *in_palette = dp->this.palette;
   PNG_CONST int in_is_transparent = dp->this.is_transparent;
   int out_npalette = -1;
   int out_is_transparent = 0; /* Just refers to the palette case */
   store_palette out_palette;
8706
   validate_info vi;
G
[devel]  
Glenn Randers-Pehrson 已提交
8707

8708 8709 8710
   /* Check for row overwrite errors */
   store_image_check(dp->this.ps, pp, 0);

8711 8712 8713 8714
   /* Supply the input and output sample depths here - 8 for an indexed image,
    * otherwise the bit depth.
    */
   init_validate_info(&vi, dp, pp, in_ct==3?8:in_bd, out_ct==3?8:out_bd);
G
[devel]  
Glenn Randers-Pehrson 已提交
8715

8716
   processing = (vi.gamma_correction > 0 && !dp->threshold_test)
8717
      || in_bd != out_bd || in_ct != out_ct || vi.do_background;
G
[devel]  
Glenn Randers-Pehrson 已提交
8718

8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731
   /* TODO: FIX THIS: MAJOR BUG!  If the transformations all happen inside
    * the palette there is no way of finding out, because libpng fails to
    * update the palette on png_read_update_info.  Indeed, libpng doesn't
    * even do the required work until much later, when it doesn't have any
    * info pointer.  Oops.  For the moment 'processing' is turned off if
    * out_ct is palette.
    */
   if (in_ct == 3 && out_ct == 3)
      processing = 0;

   if (processing && out_ct == 3)
      out_is_transparent = read_palette(out_palette, &out_npalette, pp, pi);

8732
   for (y=0; y<h; ++y)
8733
   {
8734
      png_const_bytep pRow = store_image_row(ps, pp, 0, y);
8735
      png_byte std[STANDARD_ROWMAX];
G
[devel]  
Glenn Randers-Pehrson 已提交
8736

8737
      transform_row(pp, std, in_ct, in_bd, y);
G
[devel]  
Glenn Randers-Pehrson 已提交
8738

8739
      if (processing)
G
[devel]  
Glenn Randers-Pehrson 已提交
8740
      {
8741
         unsigned int x;
8742

8743 8744 8745
         for (x=0; x<w; ++x)
         {
            double alpha = 1; /* serves as a flag value */
8746

8747 8748 8749 8750 8751 8752
            /* Record the palette index for index images. */
            PNG_CONST unsigned int in_index =
               in_ct == 3 ? sample(std, 3, in_bd, x, 0) : 256;
            PNG_CONST unsigned int out_index =
               out_ct == 3 ? sample(std, 3, out_bd, x, 0) : 256;

8753 8754
            /* Handle input alpha - png_set_background will cause the output
             * alpha to disappear so there is nothing to check.
8755
             */
8756 8757
            if ((in_ct & PNG_COLOR_MASK_ALPHA) != 0 || (in_ct == 3 &&
               in_is_transparent))
8758
            {
8759 8760
               PNG_CONST unsigned int input_alpha = in_ct == 3 ?
                  dp->this.palette[in_index].alpha :
8761
                  sample(std, in_ct, in_bd, x, samples_per_pixel);
8762

8763
               unsigned int output_alpha = 65536 /* as a flag value */;
8764

8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775
               if (out_ct == 3)
               {
                  if (out_is_transparent)
                     output_alpha = out_palette[out_index].alpha;
               }

               else if ((out_ct & PNG_COLOR_MASK_ALPHA) != 0)
                  output_alpha = sample(pRow, out_ct, out_bd, x,
                     samples_per_pixel);

               if (output_alpha != 65536)
8776
                  alpha = gamma_component_validate("alpha", &vi, input_alpha,
8777 8778 8779
                     output_alpha, -1/*alpha*/, 0/*background*/);

               else /* no alpha in output */
8780
               {
8781 8782 8783
                  /* This is a copy of the calculation of 'i' above in order to
                   * have the alpha value to use in the background calculation.
                   */
8784 8785
                  alpha = input_alpha >> vi.isbit_shift;
                  alpha /= vi.sbit_max;
8786 8787
               }
            }
8788

8789 8790
            /* Handle grayscale or RGB components. */
            if ((in_ct & PNG_COLOR_MASK_COLOR) == 0) /* grayscale */
8791 8792 8793 8794
               (void)gamma_component_validate("gray", &vi,
                  sample(std, in_ct, in_bd, x, 0),
                  sample(pRow, out_ct, out_bd, x, 0), alpha/*component*/,
                  vi.background_red);
8795
            else /* RGB or palette */
8796
            {
8797
               (void)gamma_component_validate("red", &vi,
8798 8799 8800 8801 8802
                  in_ct == 3 ? in_palette[in_index].red :
                     sample(std, in_ct, in_bd, x, 0),
                  out_ct == 3 ? out_palette[out_index].red :
                     sample(pRow, out_ct, out_bd, x, 0),
                  alpha/*component*/, vi.background_red);
8803 8804

               (void)gamma_component_validate("green", &vi,
8805 8806 8807 8808 8809
                  in_ct == 3 ? in_palette[in_index].green :
                     sample(std, in_ct, in_bd, x, 1),
                  out_ct == 3 ? out_palette[out_index].green :
                     sample(pRow, out_ct, out_bd, x, 1),
                  alpha/*component*/, vi.background_green);
8810 8811

               (void)gamma_component_validate("blue", &vi,
8812 8813 8814 8815 8816
                  in_ct == 3 ? in_palette[in_index].blue :
                     sample(std, in_ct, in_bd, x, 2),
                  out_ct == 3 ? out_palette[out_index].blue :
                     sample(pRow, out_ct, out_bd, x, 2),
                  alpha/*component*/, vi.background_blue);
8817 8818 8819
            }
         }
      }
8820

8821
      else if (memcmp(std, pRow, cbRow) != 0)
8822 8823
      {
         char msg[64];
8824

8825
         /* No transform is expected on the threshold tests. */
8826 8827
         sprintf(msg, "gamma: below threshold row %lu changed",
            (unsigned long)y);
8828

8829 8830 8831
         png_error(pp, msg);
      }
   } /* row (y) loop */
8832

8833 8834
   dp->this.ps->validated = 1;
}
8835

8836
static void PNGCBAPI
8837
gamma_end(png_structp ppIn, png_infop pi)
8838
{
8839
   png_const_structp pp = ppIn;
8840
   gamma_display *dp = voidcast(gamma_display*, png_get_progressive_ptr(pp));
8841

8842 8843
   if (!dp->this.speed)
      gamma_image_validate(dp, pp, pi);
8844 8845
   else
      dp->this.ps->validated = 1;
8846
}
8847

8848 8849 8850 8851 8852 8853 8854 8855
/* A single test run checking a gamma transformation.
 *
 * maxabs: maximum absolute error as a fraction
 * maxout: maximum output error in the output units
 * maxpc:  maximum percentage error (as a percentage)
 */
static void
gamma_test(png_modifier *pmIn, PNG_CONST png_byte colour_typeIn,
8856 8857
    PNG_CONST png_byte bit_depthIn, PNG_CONST int palette_numberIn,
    PNG_CONST int interlace_typeIn,
8858 8859
    PNG_CONST double file_gammaIn, PNG_CONST double screen_gammaIn,
    PNG_CONST png_byte sbitIn, PNG_CONST int threshold_testIn,
8860
    PNG_CONST char *name,
8861
    PNG_CONST int use_input_precisionIn, PNG_CONST int scale16In,
8862 8863
    PNG_CONST int expand16In, PNG_CONST int do_backgroundIn,
    PNG_CONST png_color_16 *bkgd_colorIn, double bkgd_gammaIn)
8864 8865 8866
{
   gamma_display d;
   context(&pmIn->this, fault);
8867

8868
   gamma_display_init(&d, pmIn, FILEID(colour_typeIn, bit_depthIn,
8869 8870
      palette_numberIn, interlace_typeIn, 0, 0, 0),
      file_gammaIn, screen_gammaIn, sbitIn,
8871
      threshold_testIn, use_input_precisionIn, scale16In,
8872
      expand16In, do_backgroundIn, bkgd_colorIn, bkgd_gammaIn);
8873

8874 8875 8876 8877
   Try
   {
      png_structp pp;
      png_infop pi;
8878
      gama_modification gama_mod;
8879 8880
      srgb_modification srgb_mod;
      sbit_modification sbit_mod;
8881

8882 8883 8884 8885 8886
      /* For the moment don't use the png_modifier support here. */
      d.pm->encoding_counter = 0;
      modifier_set_encoding(d.pm); /* Just resets everything */
      d.pm->current_gamma = d.file_gamma;

8887 8888 8889 8890
      /* Make an appropriate modifier to set the PNG file gamma to the
       * given gamma value and the sBIT chunk to the given precision.
       */
      d.pm->modifications = NULL;
8891
      gama_modification_init(&gama_mod, d.pm, d.file_gamma);
8892
      srgb_modification_init(&srgb_mod, d.pm, 127 /*delete*/);
8893 8894
      if (d.sbit > 0)
         sbit_modification_init(&sbit_mod, d.pm, d.sbit);
8895

8896 8897 8898 8899
      modification_reset(d.pm->modifications);

      /* Get a png_struct for writing the image. */
      pp = set_modifier_for_read(d.pm, &pi, d.this.id, name);
8900
      standard_palette_init(&d.this);
8901

8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919
      /* Introduce the correct read function. */
      if (d.pm->this.progressive)
      {
         /* Share the row function with the standard implementation. */
         png_set_progressive_read_fn(pp, &d, gamma_info, progressive_row,
            gamma_end);

         /* Now feed data into the reader until we reach the end: */
         modifier_progressive_read(d.pm, pp, pi);
      }
      else
      {
         /* modifier_read expects a png_modifier* */
         png_set_read_fn(pp, d.pm, modifier_read);

         /* Check the header values: */
         png_read_info(pp, pi);

8920
         /* Process the 'info' requirements. Only one image is generated */
8921 8922
         gamma_info_imp(&d, pp, pi);

8923
         sequential_row(&d.this, pp, pi, -1, 0);
8924

8925 8926
         if (!d.this.speed)
            gamma_image_validate(&d, pp, pi);
8927 8928
         else
            d.this.ps->validated = 1;
8929 8930
      }

8931
      modifier_reset(d.pm);
8932

8933
      if (d.pm->log && !d.threshold_test && !d.this.speed)
8934
         fprintf(stderr, "%d bit %s %s: max error %f (%.2g, %2g%%)\n",
8935
            d.this.bit_depth, colour_types[d.this.colour_type], name,
8936
            d.maxerrout, d.maxerrabs, 100*d.maxerrpc);
8937 8938

      /* Log the summary values too. */
8939
      if (d.this.colour_type == 0 || d.this.colour_type == 4)
8940
      {
8941
         switch (d.this.bit_depth)
8942
         {
8943 8944 8945 8946
         case 1:
            break;

         case 2:
8947 8948
            if (d.maxerrout > d.pm->error_gray_2)
               d.pm->error_gray_2 = d.maxerrout;
8949

8950 8951 8952
            break;

         case 4:
8953 8954
            if (d.maxerrout > d.pm->error_gray_4)
               d.pm->error_gray_4 = d.maxerrout;
8955

8956 8957 8958
            break;

         case 8:
8959 8960
            if (d.maxerrout > d.pm->error_gray_8)
               d.pm->error_gray_8 = d.maxerrout;
8961

8962 8963 8964
            break;

         case 16:
8965 8966
            if (d.maxerrout > d.pm->error_gray_16)
               d.pm->error_gray_16 = d.maxerrout;
8967

8968 8969 8970 8971
            break;

         default:
            png_error(pp, "bad bit depth (internal: 1)");
8972
         }
G
[devel]  
Glenn Randers-Pehrson 已提交
8973 8974
      }

8975
      else if (d.this.colour_type == 2 || d.this.colour_type == 6)
8976
      {
8977
         switch (d.this.bit_depth)
8978 8979
         {
         case 8:
8980

8981 8982
            if (d.maxerrout > d.pm->error_color_8)
               d.pm->error_color_8 = d.maxerrout;
G
[devel]  
Glenn Randers-Pehrson 已提交
8983

8984
            break;
G
[devel]  
Glenn Randers-Pehrson 已提交
8985

8986
         case 16:
8987

8988 8989
            if (d.maxerrout > d.pm->error_color_16)
               d.pm->error_color_16 = d.maxerrout;
8990 8991 8992 8993 8994 8995 8996

            break;

         default:
            png_error(pp, "bad bit depth (internal: 2)");
         }
      }
8997 8998 8999 9000 9001 9002

      else if (d.this.colour_type == 3)
      {
         if (d.maxerrout > d.pm->error_indexed)
            d.pm->error_indexed = d.maxerrout;
      }
G
[devel]  
Glenn Randers-Pehrson 已提交
9003
   }
9004 9005

   Catch(fault)
9006
      modifier_reset(voidcast(png_modifier*,(void*)fault));
G
[devel]  
Glenn Randers-Pehrson 已提交
9007 9008 9009
}

static void gamma_threshold_test(png_modifier *pm, png_byte colour_type,
9010 9011
    png_byte bit_depth, int interlace_type, double file_gamma,
    double screen_gamma)
G
[devel]  
Glenn Randers-Pehrson 已提交
9012 9013 9014 9015 9016 9017 9018 9019
{
   size_t pos = 0;
   char name[64];
   pos = safecat(name, sizeof name, pos, "threshold ");
   pos = safecatd(name, sizeof name, pos, file_gamma, 3);
   pos = safecat(name, sizeof name, pos, "/");
   pos = safecatd(name, sizeof name, pos, screen_gamma, 3);

9020
   (void)gamma_test(pm, colour_type, bit_depth, 0/*palette*/, interlace_type,
9021
      file_gamma, screen_gamma, 0/*sBIT*/, 1/*threshold test*/, name,
9022
      0 /*no input precision*/,
9023
      0 /*no scale16*/, 0 /*no expand16*/, 0 /*no background*/, 0 /*hence*/,
9024
      0 /*no background gamma*/);
G
[devel]  
Glenn Randers-Pehrson 已提交
9025 9026 9027 9028 9029 9030 9031
}

static void
perform_gamma_threshold_tests(png_modifier *pm)
{
   png_byte colour_type = 0;
   png_byte bit_depth = 0;
9032
   unsigned int palette_number = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
9033

9034 9035 9036 9037
   /* Don't test more than one instance of each palette - it's pointless, in
    * fact this test is somewhat excessive since libpng doesn't make this
    * decision based on colour type or bit depth!
    */
9038
   while (next_format(&colour_type, &bit_depth, &palette_number, 1/*gamma*/))
9039
      if (palette_number == 0)
G
[devel]  
Glenn Randers-Pehrson 已提交
9040
   {
9041 9042
      double test_gamma = 1.0;
      while (test_gamma >= .4)
G
[devel]  
Glenn Randers-Pehrson 已提交
9043
      {
9044 9045 9046 9047
         /* There's little point testing the interlacing vs non-interlacing,
          * but this can be set from the command line.
          */
         gamma_threshold_test(pm, colour_type, bit_depth, pm->interlace_type,
9048 9049
            test_gamma, 1/test_gamma);
         test_gamma *= .95;
G
[devel]  
Glenn Randers-Pehrson 已提交
9050 9051 9052
      }

      /* And a special test for sRGB */
9053 9054
      gamma_threshold_test(pm, colour_type, bit_depth, pm->interlace_type,
          .45455, 2.2);
9055 9056 9057

      if (fail(pm))
         return;
G
[devel]  
Glenn Randers-Pehrson 已提交
9058 9059 9060
   }
}

9061 9062
static void gamma_transform_test(png_modifier *pm,
   PNG_CONST png_byte colour_type, PNG_CONST png_byte bit_depth,
9063
   PNG_CONST int palette_number,
9064
   PNG_CONST int interlace_type, PNG_CONST double file_gamma,
9065
   PNG_CONST double screen_gamma, PNG_CONST png_byte sbit,
9066
   PNG_CONST int use_input_precision, PNG_CONST int scale16)
G
[devel]  
Glenn Randers-Pehrson 已提交
9067 9068 9069
{
   size_t pos = 0;
   char name[64];
9070

9071
   if (sbit != bit_depth && sbit != 0)
G
[devel]  
Glenn Randers-Pehrson 已提交
9072 9073 9074 9075 9076
   {
      pos = safecat(name, sizeof name, pos, "sbit(");
      pos = safecatn(name, sizeof name, pos, sbit);
      pos = safecat(name, sizeof name, pos, ") ");
   }
9077

G
[devel]  
Glenn Randers-Pehrson 已提交
9078 9079
   else
      pos = safecat(name, sizeof name, pos, "gamma ");
9080

9081
   if (scale16)
G
[devel]  
Glenn Randers-Pehrson 已提交
9082
      pos = safecat(name, sizeof name, pos, "16to8 ");
9083

G
[devel]  
Glenn Randers-Pehrson 已提交
9084 9085 9086 9087
   pos = safecatd(name, sizeof name, pos, file_gamma, 3);
   pos = safecat(name, sizeof name, pos, "->");
   pos = safecatd(name, sizeof name, pos, screen_gamma, 3);

9088 9089
   gamma_test(pm, colour_type, bit_depth, palette_number, interlace_type,
      file_gamma, screen_gamma, sbit, 0, name, use_input_precision,
9090
      scale16, pm->test_gamma_expand16, 0 , 0, 0);
G
[devel]  
Glenn Randers-Pehrson 已提交
9091 9092
}

9093
static void perform_gamma_transform_tests(png_modifier *pm)
G
[devel]  
Glenn Randers-Pehrson 已提交
9094 9095 9096
{
   png_byte colour_type = 0;
   png_byte bit_depth = 0;
9097
   unsigned int palette_number = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
9098

9099
   while (next_format(&colour_type, &bit_depth, &palette_number, 1/*gamma*/))
G
[devel]  
Glenn Randers-Pehrson 已提交
9100
   {
9101
      unsigned int i, j;
G
[devel]  
Glenn Randers-Pehrson 已提交
9102

9103 9104 9105 9106 9107 9108
      for (i=0; i<pm->ngamma_tests; ++i) for (j=0; j<pm->ngamma_tests; ++j)
         if (i != j)
         {
            gamma_transform_test(pm, colour_type, bit_depth, palette_number,
               pm->interlace_type, 1/pm->gammas[i], pm->gammas[j], 0/*sBIT*/,
               pm->use_input_precision, 0 /*do not scale16*/);
9109

9110 9111 9112
            if (fail(pm))
               return;
         }
G
[devel]  
Glenn Randers-Pehrson 已提交
9113 9114 9115
   }
}

9116
static void perform_gamma_sbit_tests(png_modifier *pm)
G
[devel]  
Glenn Randers-Pehrson 已提交
9117 9118 9119 9120
{
   png_byte sbit;

   /* The only interesting cases are colour and grayscale, alpha is ignored here
9121 9122
    * for overall speed.  Only bit depths where sbit is less than the bit depth
    * are tested.
G
[devel]  
Glenn Randers-Pehrson 已提交
9123
    */
9124
   for (sbit=pm->sbitlow; sbit<(1<<READ_BDHI); ++sbit)
G
[devel]  
Glenn Randers-Pehrson 已提交
9125
   {
9126 9127
      png_byte colour_type = 0, bit_depth = 0;
      unsigned int npalette = 0;
9128

9129
      while (next_format(&colour_type, &bit_depth, &npalette, 1/*gamma*/))
9130 9131 9132 9133 9134
         if ((colour_type & PNG_COLOR_MASK_ALPHA) == 0 &&
            ((colour_type == 3 && sbit < 8) ||
            (colour_type != 3 && sbit < bit_depth)))
      {
         unsigned int i;
9135

9136
         for (i=0; i<pm->ngamma_tests; ++i)
9137 9138
         {
            unsigned int j;
9139

9140
            for (j=0; j<pm->ngamma_tests; ++j) if (i != j)
9141 9142 9143
            {
               gamma_transform_test(pm, colour_type, bit_depth, npalette,
                  pm->interlace_type, 1/pm->gammas[i], pm->gammas[j],
9144
                  sbit, pm->use_input_precision_sbit, 0 /*scale16*/);
9145 9146 9147 9148

               if (fail(pm))
                  return;
            }
9149
         }
G
[devel]  
Glenn Randers-Pehrson 已提交
9150 9151 9152 9153
      }
   }
}

9154
/* Note that this requires a 16 bit source image but produces 8 bit output, so
9155 9156
 * we only need the 16bit write support, but the 16 bit images are only
 * generated if DO_16BIT is defined.
9157
 */
9158
#ifdef DO_16BIT
9159
static void perform_gamma_scale16_tests(png_modifier *pm)
G
[devel]  
Glenn Randers-Pehrson 已提交
9160 9161 9162 9163
{
#  ifndef PNG_MAX_GAMMA_8
#     define PNG_MAX_GAMMA_8 11
#  endif
9164
#  define SBIT_16_TO_8 PNG_MAX_GAMMA_8
9165
   /* Include the alpha cases here. Note that sbit matches the internal value
G
[devel]  
Glenn Randers-Pehrson 已提交
9166 9167 9168
    * used by the library - otherwise we will get spurious errors from the
    * internal sbit style approximation.
    *
9169
    * The threshold test is here because otherwise the 16 to 8 conversion will
G
[devel]  
Glenn Randers-Pehrson 已提交
9170 9171 9172
    * proceed *without* gamma correction, and the tests above will fail (but not
    * by much) - this could be fixed, it only appears with the -g option.
    */
9173
   unsigned int i, j;
9174
   for (i=0; i<pm->ngamma_tests; ++i)
G
[devel]  
Glenn Randers-Pehrson 已提交
9175
   {
9176
      for (j=0; j<pm->ngamma_tests; ++j)
9177 9178 9179 9180
      {
         if (i != j &&
             fabs(pm->gammas[j]/pm->gammas[i]-1) >= PNG_GAMMA_THRESHOLD)
         {
9181
            gamma_transform_test(pm, 0, 16, 0, pm->interlace_type,
9182
               1/pm->gammas[i], pm->gammas[j], SBIT_16_TO_8,
9183
               pm->use_input_precision_16to8, 1 /*scale16*/);
9184 9185 9186 9187

            if (fail(pm))
               return;

9188
            gamma_transform_test(pm, 2, 16, 0, pm->interlace_type,
9189
               1/pm->gammas[i], pm->gammas[j], SBIT_16_TO_8,
9190
               pm->use_input_precision_16to8, 1 /*scale16*/);
9191 9192 9193 9194

            if (fail(pm))
               return;

9195
            gamma_transform_test(pm, 4, 16, 0, pm->interlace_type,
9196
               1/pm->gammas[i], pm->gammas[j], SBIT_16_TO_8,
9197
               pm->use_input_precision_16to8, 1 /*scale16*/);
9198 9199 9200 9201

            if (fail(pm))
               return;

9202
            gamma_transform_test(pm, 6, 16, 0, pm->interlace_type,
9203
               1/pm->gammas[i], pm->gammas[j], SBIT_16_TO_8,
9204
               pm->use_input_precision_16to8, 1 /*scale16*/);
9205 9206 9207 9208 9209

            if (fail(pm))
               return;
         }
      }
G
[devel]  
Glenn Randers-Pehrson 已提交
9210 9211
   }
}
9212
#endif /* 16 to 8 bit conversion */
G
[devel]  
Glenn Randers-Pehrson 已提交
9213

9214 9215
#if defined(PNG_READ_BACKGROUND_SUPPORTED) ||\
   defined(PNG_READ_ALPHA_MODE_SUPPORTED)
9216 9217
static void gamma_composition_test(png_modifier *pm,
   PNG_CONST png_byte colour_type, PNG_CONST png_byte bit_depth,
9218
   PNG_CONST int palette_number,
9219
   PNG_CONST int interlace_type, PNG_CONST double file_gamma,
9220
   PNG_CONST double screen_gamma,
9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233
   PNG_CONST int use_input_precision, PNG_CONST int do_background,
   PNG_CONST int expand_16)
{
   size_t pos = 0;
   png_const_charp base;
   double bg;
   char name[128];
   png_color_16 background;

   /* Make up a name and get an appropriate background gamma value. */
   switch (do_background)
   {
      default:
9234
         base = "";
9235 9236 9237
         bg = 4; /* should not be used */
         break;
      case PNG_BACKGROUND_GAMMA_SCREEN:
9238
         base = " bckg(Screen):";
9239 9240 9241
         bg = 1/screen_gamma;
         break;
      case PNG_BACKGROUND_GAMMA_FILE:
9242
         base = " bckg(File):";
9243 9244 9245
         bg = file_gamma;
         break;
      case PNG_BACKGROUND_GAMMA_UNIQUE:
9246
         base = " bckg(Unique):";
9247 9248 9249 9250 9251 9252 9253 9254
         /* This tests the handling of a unique value, the math is such that the
          * value tends to be <1, but is neither screen nor file (even if they
          * match!)
          */
         bg = (file_gamma + screen_gamma) / 3;
         break;
#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
      case ALPHA_MODE_OFFSET + PNG_ALPHA_PNG:
9255
         base = " alpha(PNG)";
9256 9257 9258
         bg = 4; /* should not be used */
         break;
      case ALPHA_MODE_OFFSET + PNG_ALPHA_STANDARD:
9259
         base = " alpha(Porter-Duff)";
9260 9261 9262
         bg = 4; /* should not be used */
         break;
      case ALPHA_MODE_OFFSET + PNG_ALPHA_OPTIMIZED:
9263
         base = " alpha(Optimized)";
9264 9265 9266
         bg = 4; /* should not be used */
         break;
      case ALPHA_MODE_OFFSET + PNG_ALPHA_BROKEN:
9267
         base = " alpha(Broken)";
9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284
         bg = 4; /* should not be used */
         break;
#endif
   }

   /* Use random background values - the background is always presented in the
    * output space (8 or 16 bit components).
    */
   if (expand_16 || bit_depth == 16)
   {
      png_uint_32 r = random_32();

      background.red = (png_uint_16)r;
      background.green = (png_uint_16)(r >> 16);
      r = random_32();
      background.blue = (png_uint_16)r;
      background.gray = (png_uint_16)(r >> 16);
9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306

      /* In earlier libpng versions, those where DIGITIZE is set, any background
       * gamma correction in the expand16 case was done using 8-bit gamma
       * correction tables, resulting in larger errors.  To cope with those
       * cases use a 16-bit background value which will handle this gamma
       * correction.
       */
#     if DIGITIZE
         if (expand_16 && (do_background == PNG_BACKGROUND_GAMMA_UNIQUE ||
                           do_background == PNG_BACKGROUND_GAMMA_FILE) &&
            fabs(bg*screen_gamma-1) > PNG_GAMMA_THRESHOLD)
         {
            /* The background values will be looked up in an 8-bit table to do
             * the gamma correction, so only select values which are an exact
             * match for the 8-bit table entries:
             */
            background.red = (png_uint_16)((background.red >> 8) * 257);
            background.green = (png_uint_16)((background.green >> 8) * 257);
            background.blue = (png_uint_16)((background.blue >> 8) * 257);
            background.gray = (png_uint_16)((background.gray >> 8) * 257);
         }
#     endif
9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327
   }

   else /* 8 bit colors */
   {
      png_uint_32 r = random_32();

      background.red = (png_byte)r;
      background.green = (png_byte)(r >> 8);
      background.blue = (png_byte)(r >> 16);
      background.gray = (png_byte)(r >> 24);
   }

   background.index = 193; /* rgb(193,193,193) to detect errors */
   if (!(colour_type & PNG_COLOR_MASK_COLOR))
   {
      /* Grayscale input, we do not convert to RGB (TBD), so we must set the
       * background to gray - else libpng seems to fail.
       */
      background.red = background.green = background.blue = background.gray;
   }

9328
   pos = safecat(name, sizeof name, pos, "gamma ");
9329
   pos = safecatd(name, sizeof name, pos, file_gamma, 3);
9330 9331 9332 9333
   pos = safecat(name, sizeof name, pos, "->");
   pos = safecatd(name, sizeof name, pos, screen_gamma, 3);

   pos = safecat(name, sizeof name, pos, base);
9334 9335 9336
   if (do_background < ALPHA_MODE_OFFSET)
   {
      /* Include the background color and gamma in the name: */
9337
      pos = safecat(name, sizeof name, pos, "(");
9338 9339 9340 9341 9342 9343
      /* This assumes no expand gray->rgb - the current code won't handle that!
       */
      if (colour_type & PNG_COLOR_MASK_COLOR)
      {
         pos = safecatn(name, sizeof name, pos, background.red);
         pos = safecat(name, sizeof name, pos, ",");
9344
         pos = safecatn(name, sizeof name, pos, background.green);
9345 9346 9347 9348 9349 9350 9351 9352 9353
         pos = safecat(name, sizeof name, pos, ",");
         pos = safecatn(name, sizeof name, pos, background.blue);
      }
      else
         pos = safecatn(name, sizeof name, pos, background.gray);
      pos = safecat(name, sizeof name, pos, ")^");
      pos = safecatd(name, sizeof name, pos, bg, 3);
   }

9354
   gamma_test(pm, colour_type, bit_depth, palette_number, interlace_type,
9355
      file_gamma, screen_gamma, 0/*sBIT*/, 0, name, use_input_precision,
9356 9357 9358 9359 9360
      0/*strip 16*/, expand_16, do_background, &background, bg);
}


static void
9361
perform_gamma_composition_tests(png_modifier *pm, int do_background,
9362 9363 9364 9365
   int expand_16)
{
   png_byte colour_type = 0;
   png_byte bit_depth = 0;
9366
   unsigned int palette_number = 0;
9367

9368 9369
   /* Skip the non-alpha cases - there is no setting of a transparency colour at
    * present.
9370
    */
9371
   while (next_format(&colour_type, &bit_depth, &palette_number, 1/*gamma*/))
9372
      if ((colour_type & PNG_COLOR_MASK_ALPHA) != 0)
9373 9374 9375 9376
   {
      unsigned int i, j;

      /* Don't skip the i==j case here - it's relevant. */
9377
      for (i=0; i<pm->ngamma_tests; ++i) for (j=0; j<pm->ngamma_tests; ++j)
9378
      {
9379 9380
         gamma_composition_test(pm, colour_type, bit_depth, palette_number,
            pm->interlace_type, 1/pm->gammas[i], pm->gammas[j],
9381
            pm->use_input_precision, do_background, expand_16);
9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392

         if (fail(pm))
            return;
      }
   }
}
#endif /* READ_BACKGROUND || READ_ALPHA_MODE */

static void
init_gamma_errors(png_modifier *pm)
{
9393 9394 9395 9396 9397
   /* Use -1 to catch tests that were not actually run */
   pm->error_gray_2 = pm->error_gray_4 = pm->error_gray_8 = -1.;
   pm->error_color_8 = -1.;
   pm->error_indexed = -1.;
   pm->error_gray_16 = pm->error_color_16 = -1.;
9398 9399 9400
}

static void
9401
print_one(const char *leader, double err)
9402
{
9403 9404 9405 9406 9407 9408 9409 9410 9411 9412
   if (err != -1.)
      printf(" %s %.5f\n", leader, err);
}

static void
summarize_gamma_errors(png_modifier *pm, png_const_charp who, int low_bit_depth,
   int indexed)
{
   fflush(stderr);

9413
   if (who)
9414 9415 9416 9417
      printf("\nGamma correction with %s:\n", who);

   else
      printf("\nBasic gamma correction:\n");
9418 9419 9420

   if (low_bit_depth)
   {
9421 9422 9423 9424 9425 9426
      print_one(" 2 bit gray: ", pm->error_gray_2);
      print_one(" 4 bit gray: ", pm->error_gray_4);
      print_one(" 8 bit gray: ", pm->error_gray_8);
      print_one(" 8 bit color:", pm->error_color_8);
      if (indexed)
         print_one(" indexed:    ", pm->error_indexed);
9427 9428
   }

9429 9430 9431 9432
   print_one("16 bit gray: ", pm->error_gray_16);
   print_one("16 bit color:", pm->error_color_16);

   fflush(stdout);
9433 9434
}

G
[devel]  
Glenn Randers-Pehrson 已提交
9435
static void
9436
perform_gamma_test(png_modifier *pm, int summary)
G
[devel]  
Glenn Randers-Pehrson 已提交
9437
{
9438 9439 9440 9441
   /*TODO: remove this*/
   /* Save certain values for the temporary overrides below. */
   unsigned int calculations_use_input_precision =
      pm->calculations_use_input_precision;
9442 9443 9444
#  ifdef PNG_READ_BACKGROUND_SUPPORTED
      double maxout8 = pm->maxout8;
#  endif
9445

G
[devel]  
Glenn Randers-Pehrson 已提交
9446
   /* First some arbitrary no-transform tests: */
9447
   if (!pm->this.speed && pm->test_gamma_threshold)
G
[devel]  
Glenn Randers-Pehrson 已提交
9448 9449
   {
      perform_gamma_threshold_tests(pm);
9450 9451 9452

      if (fail(pm))
         return;
G
[devel]  
Glenn Randers-Pehrson 已提交
9453 9454 9455
   }

   /* Now some real transforms. */
9456
   if (pm->test_gamma_transform)
G
[devel]  
Glenn Randers-Pehrson 已提交
9457
   {
9458
      if (summary)
G
[devel]  
Glenn Randers-Pehrson 已提交
9459
      {
9460
         fflush(stderr);
9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471
         printf("Gamma correction error summary\n\n");
         printf("The printed value is the maximum error in the pixel values\n");
         printf("calculated by the libpng gamma correction code.  The error\n");
         printf("is calculated as the difference between the output pixel\n");
         printf("value (always an integer) and the ideal value from the\n");
         printf("libpng specification (typically not an integer).\n\n");

         printf("Expect this value to be less than .5 for 8 bit formats,\n");
         printf("less than 1 for formats with fewer than 8 bits and a small\n");
         printf("number (typically less than 5) for the 16 bit formats.\n");
         printf("For performance reasons the value for 16 bit formats\n");
9472 9473
         printf("increases when the image file includes an sBIT chunk.\n");
         fflush(stdout);
9474
      }
9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490

      init_gamma_errors(pm);
      /*TODO: remove this.  Necessary because the current libpng
       * implementation works in 8 bits:
       */
      if (pm->test_gamma_expand16)
         pm->calculations_use_input_precision = 1;
      perform_gamma_transform_tests(pm);
      if (!calculations_use_input_precision)
         pm->calculations_use_input_precision = 0;

      if (summary)
         summarize_gamma_errors(pm, 0/*who*/, 1/*low bit depth*/, 1/*indexed*/);

      if (fail(pm))
         return;
G
[devel]  
Glenn Randers-Pehrson 已提交
9491 9492
   }

9493
   /* The sbit tests produce much larger errors: */
9494
   if (pm->test_gamma_sbit)
9495
   {
9496
      init_gamma_errors(pm);
9497
      perform_gamma_sbit_tests(pm);
9498

9499
      if (summary)
9500 9501 9502 9503
         summarize_gamma_errors(pm, "sBIT", pm->sbitlow < 8U, 1/*indexed*/);

      if (fail(pm))
         return;
9504 9505
   }

9506
#ifdef DO_16BIT /* Should be READ_16BIT_SUPPORTED */
9507
   if (pm->test_gamma_scale16)
G
[devel]  
Glenn Randers-Pehrson 已提交
9508
   {
9509
      /* The 16 to 8 bit strip operations: */
9510
      init_gamma_errors(pm);
9511
      perform_gamma_scale16_tests(pm);
9512 9513 9514

      if (summary)
      {
9515 9516
         fflush(stderr);
         printf("\nGamma correction with 16 to 8 bit reduction:\n");
9517 9518
         printf(" 16 bit gray:  %.5f\n", pm->error_gray_16);
         printf(" 16 bit color: %.5f\n", pm->error_color_16);
9519
         fflush(stdout);
9520
      }
9521 9522 9523

      if (fail(pm))
         return;
G
[devel]  
Glenn Randers-Pehrson 已提交
9524
   }
9525
#endif
9526 9527 9528 9529 9530 9531

#ifdef PNG_READ_BACKGROUND_SUPPORTED
   if (pm->test_gamma_background)
   {
      init_gamma_errors(pm);

9532
      /*TODO: remove this.  Necessary because the current libpng
9533 9534 9535 9536 9537 9538 9539
       * implementation works in 8 bits:
       */
      if (pm->test_gamma_expand16)
      {
         pm->calculations_use_input_precision = 1;
         pm->maxout8 = .499; /* because the 16 bit background is smashed */
      }
9540
      perform_gamma_composition_tests(pm, PNG_BACKGROUND_GAMMA_UNIQUE,
9541
         pm->test_gamma_expand16);
9542 9543 9544
      if (!calculations_use_input_precision)
         pm->calculations_use_input_precision = 0;
      pm->maxout8 = maxout8;
9545 9546

      if (summary)
9547 9548 9549 9550
         summarize_gamma_errors(pm, "background", 1, 0/*indexed*/);

      if (fail(pm))
         return;
9551 9552 9553 9554 9555 9556 9557 9558 9559 9560
   }
#endif

#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
   if (pm->test_gamma_alpha_mode)
   {
      int do_background;

      init_gamma_errors(pm);

9561
      /*TODO: remove this.  Necessary because the current libpng
9562 9563 9564 9565
       * implementation works in 8 bits:
       */
      if (pm->test_gamma_expand16)
         pm->calculations_use_input_precision = 1;
9566 9567 9568
      for (do_background = ALPHA_MODE_OFFSET + PNG_ALPHA_STANDARD;
         do_background <= ALPHA_MODE_OFFSET + PNG_ALPHA_BROKEN && !fail(pm);
         ++do_background)
9569
         perform_gamma_composition_tests(pm, do_background,
9570
            pm->test_gamma_expand16);
9571 9572
      if (!calculations_use_input_precision)
         pm->calculations_use_input_precision = 0;
9573 9574

      if (summary)
9575 9576 9577 9578
         summarize_gamma_errors(pm, "alpha mode", 1, 0/*indexed*/);

      if (fail(pm))
         return;
9579 9580
   }
#endif
G
[devel]  
Glenn Randers-Pehrson 已提交
9581
}
9582
#endif /* PNG_READ_GAMMA_SUPPORTED */
9583
#endif /* PNG_READ_SUPPORTED */
G
[devel]  
Glenn Randers-Pehrson 已提交
9584

9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819
/* INTERLACE MACRO VALIDATION */
/* This is copied verbatim from the specification, it is simply the pass
 * number in which each pixel in each 8x8 tile appears.  The array must
 * be indexed adam7[y][x] and notice that the pass numbers are based at
 * 1, not 0 - the base libpng uses.
 */
static PNG_CONST
png_byte adam7[8][8] =
{
   { 1,6,4,6,2,6,4,6 },
   { 7,7,7,7,7,7,7,7 },
   { 5,6,5,6,5,6,5,6 },
   { 7,7,7,7,7,7,7,7 },
   { 3,6,4,6,3,6,4,6 },
   { 7,7,7,7,7,7,7,7 },
   { 5,6,5,6,5,6,5,6 },
   { 7,7,7,7,7,7,7,7 }
};

/* This routine validates all the interlace support macros in png.h for
 * a variety of valid PNG widths and heights.  It uses a number of similarly
 * named internal routines that feed off the above array.
 */
static png_uint_32
png_pass_start_row(int pass)
{
   int x, y;
   ++pass;
   for (y=0; y<8; ++y) for (x=0; x<8; ++x) if (adam7[y][x] == pass)
      return y;
   return 0xf;
}

static png_uint_32
png_pass_start_col(int pass)
{
   int x, y;
   ++pass;
   for (x=0; x<8; ++x) for (y=0; y<8; ++y) if (adam7[y][x] == pass)
      return x;
   return 0xf;
}

static int
png_pass_row_shift(int pass)
{
   int x, y, base=(-1), inc=8;
   ++pass;
   for (y=0; y<8; ++y) for (x=0; x<8; ++x) if (adam7[y][x] == pass)
   {
      if (base == (-1))
         base = y;
      else if (base == y)
         {}
      else if (inc == y-base)
         base=y;
      else if (inc == 8)
         inc = y-base, base=y;
      else if (inc != y-base)
         return 0xff; /* error - more than one 'inc' value! */
   }

   if (base == (-1)) return 0xfe; /* error - no row in pass! */

   /* The shift is always 1, 2 or 3 - no pass has all the rows! */
   switch (inc)
   {
case 2: return 1;
case 4: return 2;
case 8: return 3;
default: break;
   }

   /* error - unrecognized 'inc' */
   return (inc << 8) + 0xfd;
}

static int
png_pass_col_shift(int pass)
{
   int x, y, base=(-1), inc=8;
   ++pass;
   for (x=0; x<8; ++x) for (y=0; y<8; ++y) if (adam7[y][x] == pass)
   {
      if (base == (-1))
         base = x;
      else if (base == x)
         {}
      else if (inc == x-base)
         base=x;
      else if (inc == 8)
         inc = x-base, base=x;
      else if (inc != x-base)
         return 0xff; /* error - more than one 'inc' value! */
   }

   if (base == (-1)) return 0xfe; /* error - no row in pass! */

   /* The shift is always 1, 2 or 3 - no pass has all the rows! */
   switch (inc)
   {
case 1: return 0; /* pass 7 has all the columns */
case 2: return 1;
case 4: return 2;
case 8: return 3;
default: break;
   }

   /* error - unrecognized 'inc' */
   return (inc << 8) + 0xfd;
}

static png_uint_32
png_row_from_pass_row(png_uint_32 yIn, int pass)
{
   /* By examination of the array: */
   switch (pass)
   {
case 0: return yIn * 8;
case 1: return yIn * 8;
case 2: return yIn * 8 + 4;
case 3: return yIn * 4;
case 4: return yIn * 4 + 2;
case 5: return yIn * 2;
case 6: return yIn * 2 + 1;
default: break;
   }

   return 0xff; /* bad pass number */
}

static png_uint_32
png_col_from_pass_col(png_uint_32 xIn, int pass)
{
   /* By examination of the array: */
   switch (pass)
   {
case 0: return xIn * 8;
case 1: return xIn * 8 + 4;
case 2: return xIn * 4;
case 3: return xIn * 4 + 2;
case 4: return xIn * 2;
case 5: return xIn * 2 + 1;
case 6: return xIn;
default: break;
   }

   return 0xff; /* bad pass number */
}

static int
png_row_in_interlace_pass(png_uint_32 y, int pass)
{
   /* Is row 'y' in pass 'pass'? */
   int x;
   y &= 7;
   ++pass;
   for (x=0; x<8; ++x) if (adam7[y][x] == pass)
      return 1;

   return 0;
}

static int
png_col_in_interlace_pass(png_uint_32 x, int pass)
{
   /* Is column 'x' in pass 'pass'? */
   int y;
   x &= 7;
   ++pass;
   for (y=0; y<8; ++y) if (adam7[y][x] == pass)
      return 1;

   return 0;
}

static png_uint_32
png_pass_rows(png_uint_32 height, int pass)
{
   png_uint_32 tiles = height>>3;
   png_uint_32 rows = 0;
   unsigned int x, y;

   height &= 7;
   ++pass;
   for (y=0; y<8; ++y) for (x=0; x<8; ++x) if (adam7[y][x] == pass)
   {
      rows += tiles;
      if (y < height) ++rows;
      break; /* i.e. break the 'x', column, loop. */
   }

   return rows;
}

static png_uint_32
png_pass_cols(png_uint_32 width, int pass)
{
   png_uint_32 tiles = width>>3;
   png_uint_32 cols = 0;
   unsigned int x, y;

   width &= 7;
   ++pass;
   for (x=0; x<8; ++x) for (y=0; y<8; ++y) if (adam7[y][x] == pass)
   {
      cols += tiles;
      if (x < width) ++cols;
      break; /* i.e. break the 'y', row, loop. */
   }

   return cols;
}

static void
perform_interlace_macro_validation(void)
{
   /* The macros to validate, first those that depend only on pass:
    *
    * PNG_PASS_START_ROW(pass)
    * PNG_PASS_START_COL(pass)
    * PNG_PASS_ROW_SHIFT(pass)
    * PNG_PASS_COL_SHIFT(pass)
    */
   int pass;

   for (pass=0; pass<7; ++pass)
   {
      png_uint_32 m, f, v;

      m = PNG_PASS_START_ROW(pass);
      f = png_pass_start_row(pass);
      if (m != f)
      {
         fprintf(stderr, "PNG_PASS_START_ROW(%d) = %u != %x\n", pass, m, f);
9820
         exit(99);
9821 9822 9823 9824 9825 9826 9827
      }

      m = PNG_PASS_START_COL(pass);
      f = png_pass_start_col(pass);
      if (m != f)
      {
         fprintf(stderr, "PNG_PASS_START_COL(%d) = %u != %x\n", pass, m, f);
9828
         exit(99);
9829 9830 9831 9832 9833 9834 9835
      }

      m = PNG_PASS_ROW_SHIFT(pass);
      f = png_pass_row_shift(pass);
      if (m != f)
      {
         fprintf(stderr, "PNG_PASS_ROW_SHIFT(%d) = %u != %x\n", pass, m, f);
9836
         exit(99);
9837 9838 9839 9840 9841 9842 9843
      }

      m = PNG_PASS_COL_SHIFT(pass);
      f = png_pass_col_shift(pass);
      if (m != f)
      {
         fprintf(stderr, "PNG_PASS_COL_SHIFT(%d) = %u != %x\n", pass, m, f);
9844
         exit(99);
9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864
      }

      /* Macros that depend on the image or sub-image height too:
       *
       * PNG_PASS_ROWS(height, pass)
       * PNG_PASS_COLS(width, pass)
       * PNG_ROW_FROM_PASS_ROW(yIn, pass)
       * PNG_COL_FROM_PASS_COL(xIn, pass)
       * PNG_ROW_IN_INTERLACE_PASS(y, pass)
       * PNG_COL_IN_INTERLACE_PASS(x, pass)
       */
      for (v=0;;)
      {
         /* First the base 0 stuff: */
         m = PNG_ROW_FROM_PASS_ROW(v, pass);
         f = png_row_from_pass_row(v, pass);
         if (m != f)
         {
            fprintf(stderr, "PNG_ROW_FROM_PASS_ROW(%u, %d) = %u != %x\n",
               v, pass, m, f);
9865
            exit(99);
9866 9867 9868 9869 9870 9871 9872 9873
         }

         m = PNG_COL_FROM_PASS_COL(v, pass);
         f = png_col_from_pass_col(v, pass);
         if (m != f)
         {
            fprintf(stderr, "PNG_COL_FROM_PASS_COL(%u, %d) = %u != %x\n",
               v, pass, m, f);
9874
            exit(99);
9875 9876 9877 9878 9879 9880 9881 9882
         }

         m = PNG_ROW_IN_INTERLACE_PASS(v, pass);
         f = png_row_in_interlace_pass(v, pass);
         if (m != f)
         {
            fprintf(stderr, "PNG_ROW_IN_INTERLACE_PASS(%u, %d) = %u != %x\n",
               v, pass, m, f);
9883
            exit(99);
9884 9885 9886 9887 9888 9889 9890 9891
         }

         m = PNG_COL_IN_INTERLACE_PASS(v, pass);
         f = png_col_in_interlace_pass(v, pass);
         if (m != f)
         {
            fprintf(stderr, "PNG_COL_IN_INTERLACE_PASS(%u, %d) = %u != %x\n",
               v, pass, m, f);
9892
            exit(99);
9893 9894 9895 9896 9897 9898 9899 9900 9901 9902
         }

         /* Then the base 1 stuff: */
         ++v;
         m = PNG_PASS_ROWS(v, pass);
         f = png_pass_rows(v, pass);
         if (m != f)
         {
            fprintf(stderr, "PNG_PASS_ROWS(%u, %d) = %u != %x\n",
               v, pass, m, f);
9903
            exit(99);
9904 9905 9906 9907 9908 9909 9910 9911
         }

         m = PNG_PASS_COLS(v, pass);
         f = png_pass_cols(v, pass);
         if (m != f)
         {
            fprintf(stderr, "PNG_PASS_COLS(%u, %d) = %u != %x\n",
               v, pass, m, f);
9912
            exit(99);
9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930
         }

         /* Move to the next v - the stepping algorithm starts skipping
          * values above 1024.
          */
         if (v > 1024)
         {
            if (v == PNG_UINT_31_MAX)
               break;

            v = (v << 1) ^ v;
            if (v >= PNG_UINT_31_MAX)
               v = PNG_UINT_31_MAX-1;
         }
      }
   }
}

9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965
/* Test color encodings. These values are back-calculated from the published
 * chromaticities.  The values are accurate to about 14 decimal places; 15 are
 * given.  These values are much more accurate than the ones given in the spec,
 * which typically don't exceed 4 decimal places.  This allows testing of the
 * libpng code to its theoretical accuracy of 4 decimal places.  (If pngvalid
 * used the published errors the 'slack' permitted would have to be +/-.5E-4 or
 * more.)
 *
 * The png_modifier code assumes that encodings[0] is sRGB and treats it
 * specially: do not change the first entry in this list!
 */
static PNG_CONST color_encoding test_encodings[] =
{
/* sRGB: must be first in this list! */
/*gamma:*/ { 1/2.2,
/*red:  */ { 0.412390799265959, 0.212639005871510, 0.019330818715592 },
/*green:*/ { 0.357584339383878, 0.715168678767756, 0.119194779794626 },
/*blue: */ { 0.180480788401834, 0.072192315360734, 0.950532152249660} },
/* Kodak ProPhoto (wide gamut) */
/*gamma:*/ { 1/1.6 /*approximate: uses 1.8 power law compared to sRGB 2.4*/,
/*red:  */ { 0.797760489672303, 0.288071128229293, 0.000000000000000 },
/*green:*/ { 0.135185837175740, 0.711843217810102, 0.000000000000000 },
/*blue: */ { 0.031349349581525, 0.000085653960605, 0.825104602510460} },
/* Adobe RGB (1998) */
/*gamma:*/ { 1/(2+51./256),
/*red:  */ { 0.576669042910131, 0.297344975250536, 0.027031361386412 },
/*green:*/ { 0.185558237906546, 0.627363566255466, 0.070688852535827 },
/*blue: */ { 0.188228646234995, 0.075291458493998, 0.991337536837639} },
/* Adobe Wide Gamut RGB */
/*gamma:*/ { 1/(2+51./256),
/*red:  */ { 0.716500716779386, 0.258728243040113, 0.000000000000000 },
/*green:*/ { 0.101020574397477, 0.724682314948566, 0.051211818965388 },
/*blue: */ { 0.146774385252705, 0.016589442011321, 0.773892783545073} },
};

9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031
/* signal handler
 *
 * This attempts to trap signals and escape without crashing.  It needs a
 * context pointer so that it can throw an exception (call longjmp) to recover
 * from the condition; this is handled by making the png_modifier used by 'main'
 * into a global variable.
 */
static png_modifier pm;

static void signal_handler(int signum)
{

   size_t pos = 0;
   char msg[64];

   pos = safecat(msg, sizeof msg, pos, "caught signal: ");

   switch (signum)
   {
      case SIGABRT:
         pos = safecat(msg, sizeof msg, pos, "abort");
         break;

      case SIGFPE:
         pos = safecat(msg, sizeof msg, pos, "floating point exception");
         break;

      case SIGILL:
         pos = safecat(msg, sizeof msg, pos, "illegal instruction");
         break;

      case SIGINT:
         pos = safecat(msg, sizeof msg, pos, "interrupt");
         break;

      case SIGSEGV:
         pos = safecat(msg, sizeof msg, pos, "invalid memory access");
         break;

      case SIGTERM:
         pos = safecat(msg, sizeof msg, pos, "termination request");
         break;

      default:
         pos = safecat(msg, sizeof msg, pos, "unknown ");
         pos = safecatn(msg, sizeof msg, pos, signum);
         break;
   }

   store_log(&pm.this, NULL/*png_structp*/, msg, 1/*error*/);

   /* And finally throw an exception so we can keep going, unless this is
    * SIGTERM in which case stop now.
    */
   if (signum != SIGTERM)
   {
      struct exception_context *the_exception_context =
         &pm.this.exception_context;

      Throw &pm.this;
   }

   else
      exit(1);
}

G
[devel]  
Glenn Randers-Pehrson 已提交
10032
/* main program */
10033
int main(int argc, char **argv)
G
[devel]  
Glenn Randers-Pehrson 已提交
10034
{
10035
   volatile int summary = 1;  /* Print the error summary at the end */
10036
   volatile int memstats = 0; /* Print memory statistics at the end */
10037 10038 10039

   /* Create the given output file on success: */
   PNG_CONST char *volatile touch = NULL;
G
[devel]  
Glenn Randers-Pehrson 已提交
10040 10041 10042 10043 10044 10045

   /* This is an array of standard gamma values (believe it or not I've seen
    * every one of these mentioned somewhere.)
    *
    * In the following list the most useful values are first!
    */
10046 10047
   static double
      gammas[]={2.2, 1.0, 2.2/1.45, 1.8, 1.5, 2.4, 2.5, 2.62, 2.9};
G
[devel]  
Glenn Randers-Pehrson 已提交
10048

10049 10050 10051 10052
   /* This records the command and arguments: */
   size_t cp = 0;
   char command[1024];

10053
   anon_context(&pm.this);
10054

10055 10056
   /* Add appropriate signal handlers, just the ANSI specified ones: */
   signal(SIGABRT, signal_handler);
10057
   signal(SIGFPE, signal_handler);
10058 10059 10060 10061 10062
   signal(SIGILL, signal_handler);
   signal(SIGINT, signal_handler);
   signal(SIGSEGV, signal_handler);
   signal(SIGTERM, signal_handler);

10063
#ifdef HAVE_FEENABLEEXCEPT
10064 10065 10066 10067 10068 10069 10070
   /* Only required to enable FP exceptions on platforms where they start off
    * disabled; this is not necessary but if it is not done pngvalid will likely
    * end up ignoring FP conditions that other platforms fault.
    */
   feenableexcept(FE_DIVBYZERO | FE_INVALID | FE_OVERFLOW);
#endif

G
[devel]  
Glenn Randers-Pehrson 已提交
10071 10072
   modifier_init(&pm);

10073
   /* Preallocate the image buffer, because we know how big it needs to be,
10074 10075 10076
    * note that, for testing purposes, it is deliberately mis-aligned by tag
    * bytes either side.  All rows have an additional five bytes of padding for
    * overwrite checking.
10077
    */
10078
   store_ensure_image(&pm.this, NULL, 2, TRANSFORM_ROWMAX, TRANSFORM_HEIGHTMAX);
10079

10080 10081 10082
   /* Don't give argv[0], it's normally some horrible libtool string: */
   cp = safecat(command, sizeof command, cp, "pngvalid");

G
[devel]  
Glenn Randers-Pehrson 已提交
10083 10084 10085
   /* Default to error on warning: */
   pm.this.treat_warnings_as_errors = 1;

10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098
   /* Default assume_16_bit_calculations appropriately; this tells the checking
    * code that 16-bit arithmetic is used for 8-bit samples when it would make a
    * difference.
    */
   pm.assume_16_bit_calculations = PNG_LIBPNG_VER >= 10700;

   /* Currently 16 bit expansion happens at the end of the pipeline, so the
    * calculations are done in the input bit depth not the output.
    *
    * TODO: fix this
    */
   pm.calculations_use_input_precision = 1U;

G
[devel]  
Glenn Randers-Pehrson 已提交
10099 10100
   /* Store the test gammas */
   pm.gammas = gammas;
10101 10102 10103 10104 10105 10106 10107
   pm.ngammas = (sizeof gammas) / (sizeof gammas[0]);
   pm.ngamma_tests = 0; /* default to off */

   /* And the test encodings */
   pm.encodings = test_encodings;
   pm.nencodings = (sizeof test_encodings) / (sizeof test_encodings[0]);

10108
   pm.sbitlow = 8U; /* because libpng doesn't do sBIT below 8! */
10109

10110 10111
   /* The following allows results to pass if they correspond to anything in the
    * transformed range [input-.5,input+.5]; this is is required because of the
10112 10113
    * way libpng treates the 16_TO_8 flag when building the gamma tables in
    * releases up to 1.6.0.
10114 10115 10116 10117
    *
    * TODO: review this
    */
   pm.use_input_precision_16to8 = 1U;
10118
   pm.use_input_precision_sbit = 1U; /* because libpng now rounds sBIT */
G
[devel]  
Glenn Randers-Pehrson 已提交
10119

10120 10121 10122 10123 10124
   /* Some default values (set the behavior for 'make check' here).
    * These values simply control the maximum error permitted in the gamma
    * transformations.  The practial limits for human perception are described
    * below (the setting for maxpc16), however for 8 bit encodings it isn't
    * possible to meet the accepted capabilities of human vision - i.e. 8 bit
10125
    * images can never be good enough, regardless of encoding.
10126
    */
G
[devel]  
Glenn Randers-Pehrson 已提交
10127 10128
   pm.maxout8 = .1;     /* Arithmetic error in *encoded* value */
   pm.maxabs8 = .00005; /* 1/20000 */
10129
   pm.maxcalc8 = 1./255;  /* +/-1 in 8 bits for compose errors */
10130
   pm.maxpc8 = .499;    /* I.e., .499% fractional error */
G
[devel]  
Glenn Randers-Pehrson 已提交
10131 10132
   pm.maxout16 = .499;  /* Error in *encoded* value */
   pm.maxabs16 = .00005;/* 1/20000 */
10133 10134
   pm.maxcalc16 =1./65535;/* +/-1 in 16 bits for compose errors */
   pm.maxcalcG = 1./((1<<PNG_MAX_GAMMA_8)-1);
10135 10136

   /* NOTE: this is a reasonable perceptual limit. We assume that humans can
G
[devel]  
Glenn Randers-Pehrson 已提交
10137
    * perceive light level differences of 1% over a 100:1 range, so we need to
10138
    * maintain 1 in 10000 accuracy (in linear light space), which is what the
G
[devel]  
Glenn Randers-Pehrson 已提交
10139 10140 10141 10142 10143
    * following guarantees.  It also allows significantly higher errors at
    * higher 16 bit values, which is important for performance.  The actual
    * maximum 16 bit error is about +/-1.9 in the fixed point implementation but
    * this is only allowed for values >38149 by the following:
    */
10144
   pm.maxpc16 = .005;   /* I.e., 1/200% - 1/20000 */
G
[devel]  
Glenn Randers-Pehrson 已提交
10145 10146 10147

   /* Now parse the command line options. */
   while (--argc >= 1)
10148
   {
10149 10150
      int catmore = 0; /* Set if the argument has an argument. */

10151 10152 10153 10154 10155
      /* Record each argument for posterity: */
      cp = safecat(command, sizeof command, cp, " ");
      cp = safecat(command, sizeof command, cp, *++argv);

      if (strcmp(*argv, "-v") == 0)
G
[devel]  
Glenn Randers-Pehrson 已提交
10156
         pm.this.verbose = 1;
10157

G
[devel]  
Glenn Randers-Pehrson 已提交
10158 10159
      else if (strcmp(*argv, "-l") == 0)
         pm.log = 1;
10160

G
[devel]  
Glenn Randers-Pehrson 已提交
10161
      else if (strcmp(*argv, "-q") == 0)
10162
         summary = pm.this.verbose = pm.log = 0;
10163

G
[devel]  
Glenn Randers-Pehrson 已提交
10164 10165
      else if (strcmp(*argv, "-w") == 0)
         pm.this.treat_warnings_as_errors = 0;
10166

10167
      else if (strcmp(*argv, "--speed") == 0)
10168 10169
         pm.this.speed = 1, pm.ngamma_tests = pm.ngammas, pm.test_standard = 0,
            summary = 0;
10170 10171 10172

      else if (strcmp(*argv, "--memory") == 0)
         memstats = 1;
10173

10174 10175 10176
      else if (strcmp(*argv, "--size") == 0)
         pm.test_size = 1;

10177 10178 10179 10180 10181 10182
      else if (strcmp(*argv, "--nosize") == 0)
         pm.test_size = 0;

      else if (strcmp(*argv, "--standard") == 0)
         pm.test_standard = 1;

10183 10184
      else if (strcmp(*argv, "--nostandard") == 0)
         pm.test_standard = 0;
10185

10186 10187 10188
      else if (strcmp(*argv, "--transform") == 0)
         pm.test_transform = 1;

10189 10190 10191
      else if (strcmp(*argv, "--notransform") == 0)
         pm.test_transform = 0;

10192
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205
      else if (strncmp(*argv, "--transform-disable=",
         sizeof "--transform-disable") == 0)
         {
         pm.test_transform = 1;
         transform_disable(*argv + sizeof "--transform-disable");
         }

      else if (strncmp(*argv, "--transform-enable=",
         sizeof "--transform-enable") == 0)
         {
         pm.test_transform = 1;
         transform_enable(*argv + sizeof "--transform-enable");
         }
10206
#endif /* PNG_READ_TRANSFORMS_SUPPORTED */
10207 10208 10209 10210

      else if (strcmp(*argv, "--gamma") == 0)
         {
         /* Just do two gamma tests here (2.2 and linear) for speed: */
10211
         pm.ngamma_tests = 2U;
10212 10213 10214
         pm.test_gamma_threshold = 1;
         pm.test_gamma_transform = 1;
         pm.test_gamma_sbit = 1;
10215
         pm.test_gamma_scale16 = 1;
10216 10217
         pm.test_gamma_background = 1;
         pm.test_gamma_alpha_mode = 1;
10218 10219
         }

10220
      else if (strcmp(*argv, "--nogamma") == 0)
10221
         pm.ngamma_tests = 0;
10222

10223
      else if (strcmp(*argv, "--gamma-threshold") == 0)
10224
         pm.ngamma_tests = 2U, pm.test_gamma_threshold = 1;
10225

10226
      else if (strcmp(*argv, "--nogamma-threshold") == 0)
10227
         pm.test_gamma_threshold = 0;
10228

10229
      else if (strcmp(*argv, "--gamma-transform") == 0)
10230
         pm.ngamma_tests = 2U, pm.test_gamma_transform = 1;
10231

10232
      else if (strcmp(*argv, "--nogamma-transform") == 0)
10233
         pm.test_gamma_transform = 0;
10234

10235
      else if (strcmp(*argv, "--gamma-sbit") == 0)
10236
         pm.ngamma_tests = 2U, pm.test_gamma_sbit = 1;
10237

10238
      else if (strcmp(*argv, "--nogamma-sbit") == 0)
10239
         pm.test_gamma_sbit = 0;
10240

10241
      else if (strcmp(*argv, "--gamma-16-to-8") == 0)
10242
         pm.ngamma_tests = 2U, pm.test_gamma_scale16 = 1;
10243

10244
      else if (strcmp(*argv, "--nogamma-16-to-8") == 0)
10245
         pm.test_gamma_scale16 = 0;
10246

10247
      else if (strcmp(*argv, "--gamma-background") == 0)
10248
         pm.ngamma_tests = 2U, pm.test_gamma_background = 1;
10249 10250 10251 10252 10253

      else if (strcmp(*argv, "--nogamma-background") == 0)
         pm.test_gamma_background = 0;

      else if (strcmp(*argv, "--gamma-alpha-mode") == 0)
10254
         pm.ngamma_tests = 2U, pm.test_gamma_alpha_mode = 1;
10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265

      else if (strcmp(*argv, "--nogamma-alpha-mode") == 0)
         pm.test_gamma_alpha_mode = 0;

      else if (strcmp(*argv, "--expand16") == 0)
         pm.test_gamma_expand16 = 1;

      else if (strcmp(*argv, "--noexpand16") == 0)
         pm.test_gamma_expand16 = 0;

      else if (strcmp(*argv, "--more-gammas") == 0)
10266
         pm.ngamma_tests = 3U;
10267

10268
      else if (strcmp(*argv, "--all-gammas") == 0)
10269
         pm.ngamma_tests = pm.ngammas;
10270

10271 10272 10273
      else if (strcmp(*argv, "--progressive-read") == 0)
         pm.this.progressive = 1;

10274 10275 10276
      else if (strcmp(*argv, "--use-update-info") == 0)
         ++pm.use_update_info; /* Can call multiple times */

10277
      else if (strcmp(*argv, "--interlace") == 0)
10278 10279 10280 10281 10282 10283 10284 10285
      {
#        ifdef PNG_WRITE_INTERLACING_SUPPORTED
            pm.interlace_type = PNG_INTERLACE_ADAM7;
#        else
            fprintf(stderr, "pngvalid: no write interlace support\n");
            return SKIP;
#        endif
      }
10286

10287
      else if (strcmp(*argv, "--use-input-precision") == 0)
10288 10289 10290 10291
         pm.use_input_precision = 1U;

      else if (strcmp(*argv, "--use-calculation-precision") == 0)
         pm.use_input_precision = 0;
10292

10293
      else if (strcmp(*argv, "--calculations-use-input-precision") == 0)
10294
         pm.calculations_use_input_precision = 1U;
10295 10296

      else if (strcmp(*argv, "--assume-16-bit-calculations") == 0)
10297
         pm.assume_16_bit_calculations = 1U;
10298

10299 10300 10301
      else if (strcmp(*argv, "--calculations-follow-bit-depth") == 0)
         pm.calculations_use_input_precision =
            pm.assume_16_bit_calculations = 0;
10302

10303 10304 10305
      else if (strcmp(*argv, "--exhaustive") == 0)
         pm.test_exhaustive = 1;

10306 10307
      else if (argc > 1 && strcmp(*argv, "--sbitlow") == 0)
         --argc, pm.sbitlow = (png_byte)atoi(*++argv), catmore = 1;
10308

10309 10310 10311 10312
      else if (argc > 1 && strcmp(*argv, "--touch") == 0)
         --argc, touch = *++argv, catmore = 1;

      else if (argc > 1 && strncmp(*argv, "--max", 5) == 0)
G
[devel]  
Glenn Randers-Pehrson 已提交
10313 10314
      {
         --argc;
10315

10316
         if (strcmp(5+*argv, "abs8") == 0)
10317
            pm.maxabs8 = atof(*++argv);
10318

10319
         else if (strcmp(5+*argv, "abs16") == 0)
10320
            pm.maxabs16 = atof(*++argv);
10321

10322 10323 10324 10325 10326 10327 10328
         else if (strcmp(5+*argv, "calc8") == 0)
            pm.maxcalc8 = atof(*++argv);

         else if (strcmp(5+*argv, "calc16") == 0)
            pm.maxcalc16 = atof(*++argv);

         else if (strcmp(5+*argv, "out8") == 0)
10329
            pm.maxout8 = atof(*++argv);
10330

10331
         else if (strcmp(5+*argv, "out16") == 0)
10332
            pm.maxout16 = atof(*++argv);
10333

10334
         else if (strcmp(5+*argv, "pc8") == 0)
10335
            pm.maxpc8 = atof(*++argv);
10336

10337
         else if (strcmp(5+*argv, "pc16") == 0)
10338
            pm.maxpc16 = atof(*++argv);
10339

10340 10341 10342
         else
         {
            fprintf(stderr, "pngvalid: %s: unknown 'max' option\n", *argv);
10343
            exit(99);
10344
         }
10345 10346

         catmore = 1;
G
[devel]  
Glenn Randers-Pehrson 已提交
10347
      }
10348

10349 10350 10351 10352 10353 10354
      else if (strcmp(*argv, "--log8") == 0)
         --argc, pm.log8 = atof(*++argv), catmore = 1;

      else if (strcmp(*argv, "--log16") == 0)
         --argc, pm.log16 = atof(*++argv), catmore = 1;

10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367
#ifdef PNG_SET_OPTION_SUPPORTED
      else if (strncmp(*argv, "--option=", 9) == 0)
      {
         /* Syntax of the argument is <option>:{on|off} */
         const char *arg = 9+*argv;
         unsigned char option=0, setting=0;

#ifdef PNG_ARM_NEON_API_SUPPORTED
         if (strncmp(arg, "arm-neon:", 9) == 0)
            option = PNG_ARM_NEON, arg += 9;

         else
#endif
10368
#ifdef PNG_MAXIMUM_INFLATE_WINDOW
10369 10370 10371 10372
         if (strncmp(arg, "max-inflate-window:", 19) == 0)
            option = PNG_MAXIMUM_INFLATE_WINDOW, arg += 19;

         else
10373
#endif
10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397
         {
            fprintf(stderr, "pngvalid: %s: %s: unknown option\n", *argv, arg);
            exit(99);
         }

         if (strcmp(arg, "off") == 0)
            setting = PNG_OPTION_OFF;

         else if (strcmp(arg, "on") == 0)
            setting = PNG_OPTION_ON;

         else
         {
            fprintf(stderr,
               "pngvalid: %s: %s: unknown setting (use 'on' or 'off')\n",
               *argv, arg);
            exit(99);
         }

         pm.this.options[pm.this.noptions].option = option;
         pm.this.options[pm.this.noptions++].setting = setting;
      }
#endif /* PNG_SET_OPTION_SUPPORTED */

G
[devel]  
Glenn Randers-Pehrson 已提交
10398 10399 10400
      else
      {
         fprintf(stderr, "pngvalid: %s: unknown argument\n", *argv);
10401
         exit(99);
G
[devel]  
Glenn Randers-Pehrson 已提交
10402
      }
10403 10404 10405 10406 10407 10408

      if (catmore) /* consumed an extra *argv */
      {
         cp = safecat(command, sizeof command, cp, " ");
         cp = safecat(command, sizeof command, cp, *argv);
      }
10409
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
10410

10411 10412 10413 10414
   /* If pngvalid is run with no arguments default to a reasonable set of the
    * tests.
    */
   if (pm.test_standard == 0 && pm.test_size == 0 && pm.test_transform == 0 &&
10415
      pm.ngamma_tests == 0)
10416
   {
10417 10418 10419 10420 10421
      /* Make this do all the tests done in the test shell scripts with the same
       * parameters, where possible.  The limitation is that all the progressive
       * read and interlace stuff has to be done in separate runs, so only the
       * basic 'standard' and 'size' tests are done.
       */
10422 10423 10424
      pm.test_standard = 1;
      pm.test_size = 1;
      pm.test_transform = 1;
10425
      pm.ngamma_tests = 2U;
10426 10427
   }

10428
   if (pm.ngamma_tests > 0 &&
10429
      pm.test_gamma_threshold == 0 && pm.test_gamma_transform == 0 &&
10430
      pm.test_gamma_sbit == 0 && pm.test_gamma_scale16 == 0 &&
10431
      pm.test_gamma_background == 0 && pm.test_gamma_alpha_mode == 0)
10432 10433 10434 10435
   {
      pm.test_gamma_threshold = 1;
      pm.test_gamma_transform = 1;
      pm.test_gamma_sbit = 1;
10436
      pm.test_gamma_scale16 = 1;
10437 10438
      pm.test_gamma_background = 1;
      pm.test_gamma_alpha_mode = 1;
10439
   }
10440

10441
   else if (pm.ngamma_tests == 0)
10442 10443 10444 10445 10446
   {
      /* Nothing to test so turn everything off: */
      pm.test_gamma_threshold = 0;
      pm.test_gamma_transform = 0;
      pm.test_gamma_sbit = 0;
10447
      pm.test_gamma_scale16 = 0;
10448 10449
      pm.test_gamma_background = 0;
      pm.test_gamma_alpha_mode = 0;
10450 10451
   }

10452 10453 10454
   Try
   {
      /* Make useful base images */
10455
      make_transform_images(&pm.this);
10456 10457

      /* Perform the standard and gamma tests. */
10458
      if (pm.test_standard)
10459
      {
10460
         perform_interlace_macro_validation();
10461
         perform_formatting_test(&pm.this);
10462 10463 10464
#        ifdef PNG_READ_SUPPORTED
            perform_standard_test(&pm);
#        endif
10465 10466 10467
         perform_error_test(&pm);
      }

10468 10469 10470 10471
      /* Various oddly sized images: */
      if (pm.test_size)
      {
         make_size_images(&pm.this);
10472 10473 10474
#        ifdef PNG_READ_SUPPORTED
            perform_size_test(&pm);
#        endif
10475 10476
      }

10477
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
10478 10479 10480
      /* Combinatorial transforms: */
      if (pm.test_transform)
         perform_transform_test(&pm);
10481
#endif /* PNG_READ_TRANSFORMS_SUPPORTED */
10482

10483
#ifdef PNG_READ_GAMMA_SUPPORTED
10484
      if (pm.ngamma_tests > 0)
10485
         perform_gamma_test(&pm, summary);
10486
#endif
10487 10488
   }

10489
   Catch_anonymous
10490
   {
10491
      fprintf(stderr, "pngvalid: test aborted (probably failed in cleanup)\n");
10492 10493 10494 10495
      if (!pm.this.verbose)
      {
         if (pm.this.error[0] != 0)
            fprintf(stderr, "pngvalid: first error: %s\n", pm.this.error);
10496

10497 10498
         fprintf(stderr, "pngvalid: run with -v to see what happened\n");
      }
10499 10500
      exit(1);
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
10501

10502
   if (summary)
10503
   {
10504
      printf("%s: %s (%s point arithmetic)\n",
10505 10506 10507
         (pm.this.nerrors || (pm.this.treat_warnings_as_errors &&
            pm.this.nwarnings)) ? "FAIL" : "PASS",
         command,
G
[devel]  
Glenn Randers-Pehrson 已提交
10508
#if defined(PNG_FLOATING_ARITHMETIC_SUPPORTED) || PNG_LIBPNG_VER < 10500
10509
         "floating"
G
[devel]  
Glenn Randers-Pehrson 已提交
10510
#else
10511
         "fixed"
G
[devel]  
Glenn Randers-Pehrson 已提交
10512
#endif
10513
         );
10514 10515 10516 10517
   }

   if (memstats)
   {
10518
      printf("Allocated memory statistics (in bytes):\n"
10519 10520 10521 10522 10523 10524 10525 10526
         "\tread  %lu maximum single, %lu peak, %lu total\n"
         "\twrite %lu maximum single, %lu peak, %lu total\n",
         (unsigned long)pm.this.read_memory_pool.max_max,
         (unsigned long)pm.this.read_memory_pool.max_limit,
         (unsigned long)pm.this.read_memory_pool.max_total,
         (unsigned long)pm.this.write_memory_pool.max_max,
         (unsigned long)pm.this.write_memory_pool.max_limit,
         (unsigned long)pm.this.write_memory_pool.max_total);
10527 10528 10529 10530 10531 10532
   }

   /* Do this here to provoke memory corruption errors in memory not directly
    * allocated by libpng - not a complete test, but better than nothing.
    */
   store_delete(&pm.this);
G
[devel]  
Glenn Randers-Pehrson 已提交
10533 10534 10535 10536

   /* Error exit if there are any errors, and maybe if there are any
    * warnings.
    */
10537 10538
   if (pm.this.nerrors || (pm.this.treat_warnings_as_errors &&
       pm.this.nwarnings))
G
[devel]  
Glenn Randers-Pehrson 已提交
10539 10540 10541
   {
      if (!pm.this.verbose)
         fprintf(stderr, "pngvalid: %s\n", pm.this.error);
10542

G
[devel]  
Glenn Randers-Pehrson 已提交
10543
      fprintf(stderr, "pngvalid: %d errors, %d warnings\n", pm.this.nerrors,
10544 10545
          pm.this.nwarnings);

G
[devel]  
Glenn Randers-Pehrson 已提交
10546 10547 10548
      exit(1);
   }

10549 10550 10551 10552
   /* Success case. */
   if (touch != NULL)
   {
      FILE *fsuccess = fopen(touch, "wt");
10553

10554 10555 10556 10557 10558 10559
      if (fsuccess != NULL)
      {
         int error = 0;
         fprintf(fsuccess, "PNG validation succeeded\n");
         fflush(fsuccess);
         error = ferror(fsuccess);
10560

10561 10562 10563 10564 10565 10566
         if (fclose(fsuccess) || error)
         {
            fprintf(stderr, "%s: write failed\n", touch);
            exit(1);
         }
      }
10567 10568 10569 10570 10571 10572

      else
      {
         fprintf(stderr, "%s: open failed\n", touch);
         exit(1);
      }
10573 10574
   }

10575 10576 10577
   /* This is required because some very minimal configurations do not use it:
    */
   UNUSED(fail)
G
[devel]  
Glenn Randers-Pehrson 已提交
10578 10579
   return 0;
}
10580
#else /* write or low level APIs not supported */
10581 10582
int main(void)
{
10583 10584
   fprintf(stderr,
      "pngvalid: no low level write support in libpng, all tests skipped\n");
10585
   /* So the test is skipped: */
10586
   return SKIP;
10587 10588
}
#endif