pngvalid.c 309.8 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.0 [February 14, 2013]
5
 * Copyright (c) 2013 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
#ifdef HAVE_FEENABLEEXCEPT /* from config.h, if included */
34 35
#  include <fenv.h>
#endif
36

37 38 39 40 41 42 43 44
/* 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
45

46 47
#ifdef PNG_WRITE_SUPPORTED /* else pngvalid can do nothing */

48
#if PNG_LIBPNG_VER < 10500
49
/* This deliberately lacks the PNG_CONST. */
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
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)

74
/* These are needed too for the default build: */
75 76
#define PNG_WRITE_16BIT_SUPPORTED
#define PNG_READ_16BIT_SUPPORTED
77 78

/* This comes from pnglibconf.h afer 1.5: */
79
#define PNG_FP_1 100000
80
#define PNG_GAMMA_THRESHOLD_FIXED\
81
   ((png_fixed_point)(PNG_GAMMA_THRESHOLD * PNG_FP_1))
82 83
#endif

84 85 86 87
#if PNG_LIBPNG_VER < 10600
   /* 1.6.0 constifies many APIs, the following exists to allow pngvalid to be
    * compiled against earlier versions.
    */
88
#  define png_const_structp png_structp
89 90
#endif

91
#include <zlib.h>   /* For crc32 */
G
[devel]  
Glenn Randers-Pehrson 已提交
92

93
#include <float.h>  /* For floating point constants */
G
[devel]  
Glenn Randers-Pehrson 已提交
94 95 96 97
#include <stdlib.h> /* For malloc */
#include <string.h> /* For memcpy, memset */
#include <math.h>   /* For floor */

98 99 100 101
/* Unused formal parameter errors are removed using the following macro which is
 * expected to have no bad effects on performance.
 */
#ifndef UNUSED
102 103 104 105 106
#  if defined(__GNUC__) || defined(_MSC_VER)
#     define UNUSED(param) (void)param;
#  else
#     define UNUSED(param)
#  endif
107 108
#endif

109
/***************************** EXCEPTION HANDLING *****************************/
110 111 112 113 114
#ifdef PNG_FREESTANDING_TESTS
#  include <cexcept.h>
#else
#  include "../visupng/cexcept.h"
#endif
115 116 117 118 119 120 121 122 123

#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 */

124
struct png_store;
125 126
define_exception_type(struct png_store*);

127
/* The following are macros to reduce typing everywhere where the well known
128 129
 * name 'the_exception_context' must be defined.
 */
130 131 132
#define anon_context(ps) struct exception_context *the_exception_context = \
   &(ps)->exception_context
#define context(ps,fault) anon_context(ps); png_store *fault
133

134 135 136 137 138 139 140
/******************************* 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.
 */
141 142
static size_t safecat(char *buffer, size_t bufsize, size_t pos,
   PNG_CONST char *cat)
G
[devel]  
Glenn Randers-Pehrson 已提交
143
{
144 145 146 147 148 149
   while (pos < bufsize && cat != NULL && *cat != 0)
      buffer[pos++] = *cat++;

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

G
[devel]  
Glenn Randers-Pehrson 已提交
150 151 152 153 154 155 156 157 158 159 160
   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);
}

161
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
162
static size_t safecatd(char *buffer, size_t bufsize, size_t pos, double d,
163
    int precision)
G
[devel]  
Glenn Randers-Pehrson 已提交
164 165 166 167 168
{
   char number[64];
   sprintf(number, "%.*f", precision, d);
   return safecat(buffer, bufsize, pos, number);
}
169
#endif
G
[devel]  
Glenn Randers-Pehrson 已提交
170

171 172
static PNG_CONST char invalid[] = "invalid";
static PNG_CONST char sep[] = ": ";
G
[devel]  
Glenn Randers-Pehrson 已提交
173

174
static PNG_CONST char *colour_types[8] =
G
[devel]  
Glenn Randers-Pehrson 已提交
175
{
176 177
   "grayscale", invalid, "truecolour", "indexed-colour",
   "grayscale with alpha", invalid, "truecolour with alpha", invalid
G
[devel]  
Glenn Randers-Pehrson 已提交
178 179
};

180
#ifdef PNG_READ_SUPPORTED
181 182 183 184 185 186 187
/* 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;
}
188
#endif /* PNG_READ_SUPPORTED */
189

190 191 192 193
/* 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
194 195
 * Hill, "The Art of Electronics" (Pseudo-Random Bit Sequences and Noise
 * Generation.)
196 197 198
 */
static void
make_random_bytes(png_uint_32* seed, void* pv, size_t size)
199
{
200
   png_uint_32 u0 = seed[0], u1 = seed[1];
201
   png_bytep bytes = voidcast(png_bytep, pv);
202

203 204 205 206 207 208 209 210 211 212 213 214 215 216
   /* 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;
   }
217

218 219 220
   seed[0] = u0;
   seed[1] = u1;
}
221

222 223 224 225 226
static void
make_four_random_bytes(png_uint_32* seed, png_bytep bytes)
{
   make_random_bytes(seed, bytes, 4);
}
227

228
#ifdef PNG_READ_SUPPORTED
229 230 231 232 233
static void
randomize(void *pv, size_t size)
{
   static png_uint_32 random_seed[2] = {0x56789abc, 0xd};
   make_random_bytes(random_seed, pv, size);
234 235
}

236 237
#define RANDOMIZE(this) randomize(&(this), sizeof (this))

238 239 240 241 242 243 244 245 246 247
static unsigned int
random_mod(unsigned int max)
{
   unsigned int x;

   RANDOMIZE(x);

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

248
#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
249 250 251 252 253 254 255 256 257
static int
random_choice(void)
{
   unsigned char x;

   RANDOMIZE(x);

   return x & 1;
}
258
#endif
259
#endif /* PNG_READ_SUPPORTED */
260

261 262
/* A numeric ID based on PNG file characteristics.  The 'do_interlace' field
 * simply records whether pngvalid did the interlace itself or whether it
263 264
 * 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.)
265
 */
266 267
#define FILEID(col, depth, palette, interlace, width, height, do_interlace) \
   ((png_uint_32)((col) + ((depth)<<3) + ((palette)<<8) + ((interlace)<<13) + \
268 269
    (((do_interlace)!=0)<<15) + ((width)<<16) + ((height)<<24)))

270 271
#define COL_FROM_ID(id) ((png_byte)((id)& 0x7U))
#define DEPTH_FROM_ID(id) ((png_byte)(((id) >> 3) & 0x1fU))
272
#define PALETTE_FROM_ID(id) (((id) >> 8) & 0x1f)
273
#define INTERLACE_FROM_ID(id) ((int)(((id) >> 13) & 0x3))
274 275 276
#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)
277 278 279 280

/* 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,
281
    int bit_depth, unsigned int npalette, int interlace_type,
282
    png_uint_32 w, png_uint_32 h, int do_interlace)
283 284
{
   pos = safecat(buffer, bufsize, pos, colour_types[colour_type]);
285 286 287 288 289 290
   if (npalette > 0)
   {
      pos = safecat(buffer, bufsize, pos, "[");
      pos = safecatn(buffer, bufsize, pos, npalette);
      pos = safecat(buffer, bufsize, pos, "]");
   }
291
   pos = safecat(buffer, bufsize, pos, " ");
292
   pos = safecatn(buffer, bufsize, pos, bit_depth);
293
   pos = safecat(buffer, bufsize, pos, " bit");
294 295

   if (interlace_type != PNG_INTERLACE_NONE)
296
   {
297
      pos = safecat(buffer, bufsize, pos, " interlaced");
298 299 300 301 302 303
      if (do_interlace)
         pos = safecat(buffer, bufsize, pos, "(pngvalid)");
      else
         pos = safecat(buffer, bufsize, pos, "(libpng)");
   }

304 305 306 307 308 309 310
   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);
   }
311 312 313 314 315 316 317 318

   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),
319
      DEPTH_FROM_ID(id), PALETTE_FROM_ID(id), INTERLACE_FROM_ID(id),
320
      WIDTH_FROM_ID(id), HEIGHT_FROM_ID(id), DO_INTERLACE_FROM_ID(id));
321 322
}

323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
/* 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

340 341 342
/* The following defines the number of different palettes to generate for
 * each log bit depth of a colour type 3 standard image.
 */
343
#define PALETTE_COUNT(bit_depth) ((bit_depth) > 4 ? 1U : 16U)
344

G
[devel]  
Glenn Randers-Pehrson 已提交
345
static int
346 347
next_format(png_bytep colour_type, png_bytep bit_depth,
   unsigned int* palette_number)
G
[devel]  
Glenn Randers-Pehrson 已提交
348 349 350
{
   if (*bit_depth == 0)
   {
351
      *colour_type = 0, *bit_depth = 1, *palette_number = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
352 353
      return 1;
   }
354

355 356 357 358 359 360 361 362 363
   if (*colour_type == 3)
   {
      /* Add multiple palettes for colour type 3. */
      if (++*palette_number < PALETTE_COUNT(*bit_depth))
         return 1;

      *palette_number = 0;
   }

364 365 366
   *bit_depth = (png_byte)(*bit_depth << 1);

   /* Palette images are restricted to 8 bit depth */
367 368 369 370 371
   if (*bit_depth <= 8
#     ifdef DO_16BIT
         || (*colour_type != 3 && *bit_depth <= 16)
#     endif
      )
372 373 374 375
      return 1;

   /* Move to the next color type, or return 0 at the end. */
   switch (*colour_type)
G
[devel]  
Glenn Randers-Pehrson 已提交
376
   {
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
      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 已提交
399 400 401
   }
}

402
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
403
static unsigned int
404
sample(png_const_bytep row, png_byte colour_type, png_byte bit_depth,
405
    png_uint_32 x, unsigned int sample_index)
G
[devel]  
Glenn Randers-Pehrson 已提交
406
{
407
   png_uint_32 bit_index, result;
408

G
[devel]  
Glenn Randers-Pehrson 已提交
409 410
   /* Find a sample index for the desired sample: */
   x *= bit_depth;
411
   bit_index = x;
412

G
[devel]  
Glenn Randers-Pehrson 已提交
413 414 415
   if ((colour_type & 1) == 0) /* !palette */
   {
      if (colour_type & 2)
416
         bit_index *= 3;
417 418

      if (colour_type & 4)
419
         bit_index += x; /* Alpha channel */
420

421
      /* Multiple channels; select one: */
422
      if (colour_type & (2+4))
423
         bit_index += sample_index * bit_depth;
G
[devel]  
Glenn Randers-Pehrson 已提交
424 425 426
   }

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

G
[devel]  
Glenn Randers-Pehrson 已提交
430 431
   if (bit_depth == 8)
      return result;
432

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

G
[devel]  
Glenn Randers-Pehrson 已提交
436
   /* Less than 8 bits per sample. */
437 438
   bit_index &= 7;
   return (result >> (8-bit_index-bit_depth)) & ((1U<<bit_depth)-1);
G
[devel]  
Glenn Randers-Pehrson 已提交
439
}
440
#endif /* PNG_READ_TRANSFORMS_SUPPORTED */
G
[devel]  
Glenn Randers-Pehrson 已提交
441

442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
/* 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);
}

478
#ifdef PNG_READ_SUPPORTED
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
/* 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));
   }
}

501 502 503 504 505 506
/* 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)
{
507
#if PNG_LIBPNG_VER < 10506
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
   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;
   }
528 529 530 531 532 533 534
#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
535

536 537 538 539 540 541 542
   /* Return the index of the changed byte. */
   {
      png_uint_32 where = 0;

      while (pa[where] == pb[where]) ++where;
      return 1+where;
   }
543
}
544
#endif /* PNG_READ_SUPPORTED */
545

G
[devel]  
Glenn Randers-Pehrson 已提交
546
/*************************** BASIC PNG FILE WRITING ***************************/
547
/* A png_store takes data from the sequential writer or provides data
G
[devel]  
Glenn Randers-Pehrson 已提交
548 549 550
 * to the sequential reader.  It can also store the result of a PNG
 * write for later retrieval.
 */
551 552
#define STORE_BUFFER_SIZE 500 /* arbitrary */
typedef struct png_store_buffer
G
[devel]  
Glenn Randers-Pehrson 已提交
553
{
554 555 556
   struct png_store_buffer*  prev;    /* NOTE: stored in reverse order */
   png_byte                  buffer[STORE_BUFFER_SIZE];
} png_store_buffer;
G
[devel]  
Glenn Randers-Pehrson 已提交
557

558 559
#define FILE_NAME_SIZE 64

560 561 562 563 564 565 566 567
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];

568
typedef struct png_store_file
G
[devel]  
Glenn Randers-Pehrson 已提交
569
{
570
   struct png_store_file*  next;      /* as many as you like... */
571
   char                    name[FILE_NAME_SIZE];
572
   png_uint_32             id;        /* must be correct (see FILEID) */
G
[devel]  
Glenn Randers-Pehrson 已提交
573
   png_size_t              datacount; /* In this (the last) buffer */
574
   png_store_buffer        data;      /* Last buffer in file */
575 576
   int                     npalette;  /* Number of entries in palette */
   store_palette_entry*    palette;   /* May be NULL */
577
} png_store_file;
G
[devel]  
Glenn Randers-Pehrson 已提交
578

579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
/* 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;

600
typedef struct png_store
G
[devel]  
Glenn Randers-Pehrson 已提交
601
{
602 603 604 605 606 607 608
   /* 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;

609 610
   unsigned int       verbose :1;
   unsigned int       treat_warnings_as_errors :1;
611 612 613
   unsigned int       expect_error :1;
   unsigned int       expect_warning :1;
   unsigned int       saw_warning :1;
614
   unsigned int       speed :1;
615 616
   unsigned int       progressive :1; /* use progressive read */
   unsigned int       validated :1;   /* used as a temporary flag */
G
[devel]  
Glenn Randers-Pehrson 已提交
617 618
   int                nerrors;
   int                nwarnings;
619 620
   char               test[128]; /* Name of test */
   char               error[256];
621

G
[devel]  
Glenn Randers-Pehrson 已提交
622 623 624
   /* Read fields */
   png_structp        pread;    /* Used to read a saved file */
   png_infop          piread;
625 626
   png_store_file*    current;  /* Set when reading */
   png_store_buffer*  next;     /* Set when reading */
G
[devel]  
Glenn Randers-Pehrson 已提交
627
   png_size_t         readpos;  /* Position in *next */
628
   png_byte*          image;    /* Buffer for reading interlaced images */
629 630 631
   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 */
632
   store_pool         read_memory_pool;
633

G
[devel]  
Glenn Randers-Pehrson 已提交
634
   /* Write fields */
635
   png_store_file*    saved;
G
[devel]  
Glenn Randers-Pehrson 已提交
636 637 638
   png_structp        pwrite;   /* Used when writing a new file */
   png_infop          piwrite;
   png_size_t         writepos; /* Position in .new */
639
   char               wname[FILE_NAME_SIZE];
640
   png_store_buffer   new;      /* The end of the new PNG file being written. */
641
   store_pool         write_memory_pool;
642 643
   store_palette_entry* palette;
   int                  npalette;
644
} png_store;
G
[devel]  
Glenn Randers-Pehrson 已提交
645 646

/* Initialization and cleanup */
647
static void
648
store_pool_mark(png_bytep mark)
649
{
650
   static png_uint_32 store_seed[2] = { 0x12345678, 1};
651

652
   make_four_random_bytes(store_seed, mark);
653 654
}

655
#ifdef PNG_READ_SUPPORTED
656
/* Use this for random 32 bit values; this function makes sure the result is
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
 * non-zero.
 */
static png_uint_32
random_32(void)
{

   for(;;)
   {
      png_byte mark[4];
      png_uint_32 result;

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

      if (result != 0)
         return result;
   }
}
675
#endif /* PNG_READ_SUPPORTED */
676

677 678 679 680 681 682 683 684 685 686 687 688
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 已提交
689
static void
690
store_init(png_store* ps)
G
[devel]  
Glenn Randers-Pehrson 已提交
691 692
{
   memset(ps, 0, sizeof *ps);
693 694 695
   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 已提交
696 697
   ps->verbose = 0;
   ps->treat_warnings_as_errors = 0;
698 699 700
   ps->expect_error = 0;
   ps->expect_warning = 0;
   ps->saw_warning = 0;
701
   ps->speed = 0;
702
   ps->progressive = 0;
703
   ps->validated = 0;
704
   ps->nerrors = ps->nwarnings = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
705 706 707 708 709
   ps->pread = NULL;
   ps->piread = NULL;
   ps->saved = ps->current = NULL;
   ps->next = NULL;
   ps->readpos = 0;
710 711
   ps->image = NULL;
   ps->cb_image = 0;
712 713
   ps->cb_row = 0;
   ps->image_h = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
714 715 716 717
   ps->pwrite = NULL;
   ps->piwrite = NULL;
   ps->writepos = 0;
   ps->new.prev = NULL;
718 719
   ps->palette = NULL;
   ps->npalette = 0;
720 721
}

G
[devel]  
Glenn Randers-Pehrson 已提交
722
static void
723
store_freebuffer(png_store_buffer* psb)
G
[devel]  
Glenn Randers-Pehrson 已提交
724 725 726
{
   if (psb->prev)
   {
727
      store_freebuffer(psb->prev);
G
[devel]  
Glenn Randers-Pehrson 已提交
728 729 730 731 732 733
      free(psb->prev);
      psb->prev = NULL;
   }
}

static void
734
store_freenew(png_store *ps)
G
[devel]  
Glenn Randers-Pehrson 已提交
735
{
736
   store_freebuffer(&ps->new);
G
[devel]  
Glenn Randers-Pehrson 已提交
737
   ps->writepos = 0;
738 739 740 741 742 743
   if (ps->palette != NULL)
   {
      free(ps->palette);
      ps->palette = NULL;
      ps->npalette = 0;
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
744 745 746
}

static void
747
store_storenew(png_store *ps)
G
[devel]  
Glenn Randers-Pehrson 已提交
748
{
749
   png_store_buffer *pb;
750

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

754
   pb = voidcast(png_store_buffer*, malloc(sizeof *pb));
755

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

G
[devel]  
Glenn Randers-Pehrson 已提交
759 760 761 762 763 764
   *pb = ps->new;
   ps->new.prev = pb;
   ps->writepos = 0;
}

static void
765
store_freefile(png_store_file **ppf)
G
[devel]  
Glenn Randers-Pehrson 已提交
766
{
767 768 769
   if (*ppf != NULL)
   {
      store_freefile(&(*ppf)->next);
770

771 772
      store_freebuffer(&(*ppf)->data);
      (*ppf)->datacount = 0;
773 774 775 776 777 778
      if ((*ppf)->palette != NULL)
      {
         free((*ppf)->palette);
         (*ppf)->palette = NULL;
         (*ppf)->npalette = 0;
      }
779 780 781
      free(*ppf);
      *ppf = NULL;
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
782 783 784
}

/* Main interface to file storeage, after writing a new PNG file (see the API
785
 * below) call store_storefile to store the result with the given name and id.
G
[devel]  
Glenn Randers-Pehrson 已提交
786 787
 */
static void
788
store_storefile(png_store *ps, png_uint_32 id)
G
[devel]  
Glenn Randers-Pehrson 已提交
789
{
790
   png_store_file *pf = voidcast(png_store_file*, malloc(sizeof *pf));
G
[devel]  
Glenn Randers-Pehrson 已提交
791 792 793 794 795 796 797 798
   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;
799 800 801 802
   pf->palette = ps->palette;
   pf->npalette = ps->npalette;
   ps->palette = 0;
   ps->npalette = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
803 804 805 806 807 808 809 810

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

/* Generate an error message (in the given buffer) */
static size_t
811
store_message(png_store *ps, png_const_structp pp, char *buffer, size_t bufsize,
812
   size_t pos, PNG_CONST char *msg)
G
[devel]  
Glenn Randers-Pehrson 已提交
813
{
814
   if (pp != NULL && pp == ps->pread)
G
[devel]  
Glenn Randers-Pehrson 已提交
815 816 817
   {
      /* Reading a file */
      pos = safecat(buffer, bufsize, pos, "read: ");
818

G
[devel]  
Glenn Randers-Pehrson 已提交
819 820 821
      if (ps->current != NULL)
      {
         pos = safecat(buffer, bufsize, pos, ps->current->name);
822
         pos = safecat(buffer, bufsize, pos, sep);
G
[devel]  
Glenn Randers-Pehrson 已提交
823 824
      }
   }
825

826
   else if (pp != NULL && pp == ps->pwrite)
G
[devel]  
Glenn Randers-Pehrson 已提交
827 828 829 830
   {
      /* Writing a file */
      pos = safecat(buffer, bufsize, pos, "write: ");
      pos = safecat(buffer, bufsize, pos, ps->wname);
831
      pos = safecat(buffer, bufsize, pos, sep);
G
[devel]  
Glenn Randers-Pehrson 已提交
832
   }
833

G
[devel]  
Glenn Randers-Pehrson 已提交
834 835
   else
   {
836
      /* Neither reading nor writing (or a memory error in struct delete) */
G
[devel]  
Glenn Randers-Pehrson 已提交
837 838 839
      pos = safecat(buffer, bufsize, pos, "pngvalid: ");
   }

840 841 842 843 844
   if (ps->test[0] != 0)
   {
      pos = safecat(buffer, bufsize, pos, ps->test);
      pos = safecat(buffer, bufsize, pos, sep);
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
845 846 847 848
   pos = safecat(buffer, bufsize, pos, msg);
   return pos;
}

849 850
/* Verbose output to the error stream: */
static void
851
store_verbose(png_store *ps, png_const_structp pp, png_const_charp prefix,
852 853 854 855 856 857 858 859 860 861 862 863
   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);
}

864
/* Log an error or warning - the relevant count is always incremented. */
G
[devel]  
Glenn Randers-Pehrson 已提交
865
static void
866 867
store_log(png_store* ps, png_const_structp pp, png_const_charp message,
   int is_error)
G
[devel]  
Glenn Randers-Pehrson 已提交
868
{
869 870 871 872 873 874 875
   /* 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 已提交
876

877
   if (ps->verbose)
878
      store_verbose(ps, pp, is_error ? "error: " : "warning: ", message);
879
}
G
[devel]  
Glenn Randers-Pehrson 已提交
880

881
#ifdef PNG_READ_SUPPORTED
882 883 884 885 886 887 888 889 890 891 892 893
/* 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;
   }
}
894
#endif /* PNG_READ_SUPPORTED */
895

896 897
/* Functions to use as PNG callbacks. */
static void
898
store_error(png_structp ppIn, png_const_charp message) /* PNG_NORETURN */
899
{
900
   png_const_structp pp = ppIn;
901
   png_store *ps = voidcast(png_store*, png_get_error_ptr(pp));
G
[devel]  
Glenn Randers-Pehrson 已提交
902

903
   if (!ps->expect_error)
904
      store_log(ps, pp, message, 1 /* error */);
905 906 907 908 909 910

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

static void
914
store_warning(png_structp ppIn, png_const_charp message)
G
[devel]  
Glenn Randers-Pehrson 已提交
915
{
916
   png_const_structp pp = ppIn;
917
   png_store *ps = voidcast(png_store*, png_get_error_ptr(pp));
G
[devel]  
Glenn Randers-Pehrson 已提交
918

919
   if (!ps->expect_warning)
920
      store_log(ps, pp, message, 0 /* warning */);
921 922
   else
      ps->saw_warning = 1;
G
[devel]  
Glenn Randers-Pehrson 已提交
923 924
}

925 926 927 928 929
/* 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
930
store_image_row(PNG_CONST png_store* ps, png_const_structp pp, int nImage,
931 932 933 934 935 936 937 938 939 940 941 942 943 944
   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
945
store_image_free(png_store *ps, png_const_structp pp)
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
{
   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
967 968
store_ensure_image(png_store *ps, png_const_structp pp, int nImages,
   png_size_t cbRow, png_uint_32 cRows)
969 970 971 972 973 974 975 976 977 978
{
   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. */
979
      image = voidcast(png_bytep, malloc(cb+2));
980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
      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;
   }

998
   /* We have an adequate sized image; lay out the rows.  There are 2 bytes at
999 1000
    * 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.)
1001 1002 1003 1004
    */
   ps->cb_row = cbRow;
   ps->image_h = cRows;

1005 1006 1007 1008 1009
   /* 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'.
1010
    */
1011
   memset(ps->image, 178, cb);
1012

1013
   /* Then put in the marks. */
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
   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;
      }
   }
}

1032
#ifdef PNG_READ_SUPPORTED
1033
static void
1034
store_image_check(PNG_CONST png_store* ps, png_const_structp pp, int iImage)
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
{
   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;
      }
   }
}
1062
#endif /* PNG_READ_SUPPORTED */
1063

G
[devel]  
Glenn Randers-Pehrson 已提交
1064
static void
1065
store_write(png_structp ppIn, png_bytep pb, png_size_t st)
G
[devel]  
Glenn Randers-Pehrson 已提交
1066
{
1067
   png_const_structp pp = ppIn;
1068
   png_store *ps = voidcast(png_store*, png_get_io_ptr(pp));
1069

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

G
[devel]  
Glenn Randers-Pehrson 已提交
1073 1074 1075 1076
   while (st > 0)
   {
      size_t cb;

1077 1078
      if (ps->writepos >= STORE_BUFFER_SIZE)
         store_storenew(ps);
G
[devel]  
Glenn Randers-Pehrson 已提交
1079 1080

      cb = st;
1081

1082 1083
      if (cb > STORE_BUFFER_SIZE - ps->writepos)
         cb = STORE_BUFFER_SIZE - ps->writepos;
1084

G
[devel]  
Glenn Randers-Pehrson 已提交
1085 1086 1087 1088 1089 1090 1091 1092
      memcpy(ps->new.buffer + ps->writepos, pb, cb);
      pb += cb;
      st -= cb;
      ps->writepos += cb;
   }
}

static void
1093
store_flush(png_structp ppIn)
G
[devel]  
Glenn Randers-Pehrson 已提交
1094
{
1095
   UNUSED(ppIn) /*DOES NOTHING*/
G
[devel]  
Glenn Randers-Pehrson 已提交
1096 1097
}

1098
#ifdef PNG_READ_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1099
static size_t
1100
store_read_buffer_size(png_store *ps)
G
[devel]  
Glenn Randers-Pehrson 已提交
1101 1102 1103
{
   /* Return the bytes available for read in the current buffer. */
   if (ps->next != &ps->current->data)
1104
      return STORE_BUFFER_SIZE;
G
[devel]  
Glenn Randers-Pehrson 已提交
1105 1106 1107 1108

   return ps->current->datacount;
}

1109
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
/* 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;
}
1134
#endif
1135

G
[devel]  
Glenn Randers-Pehrson 已提交
1136
static int
1137
store_read_buffer_next(png_store *ps)
G
[devel]  
Glenn Randers-Pehrson 已提交
1138
{
1139 1140
   png_store_buffer *pbOld = ps->next;
   png_store_buffer *pbNew = &ps->current->data;
G
[devel]  
Glenn Randers-Pehrson 已提交
1141 1142 1143 1144
   if (pbOld != pbNew)
   {
      while (pbNew != NULL && pbNew->prev != pbOld)
         pbNew = pbNew->prev;
1145

G
[devel]  
Glenn Randers-Pehrson 已提交
1146 1147 1148
      if (pbNew != NULL)
      {
         ps->next = pbNew;
1149 1150
         ps->readpos = 0;
         return 1;
G
[devel]  
Glenn Randers-Pehrson 已提交
1151 1152 1153 1154 1155 1156 1157 1158
      }

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

   return 0; /* EOF or error */
}

1159 1160 1161
/* 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 已提交
1162
static void
1163
store_read_imp(png_store *ps, png_bytep pb, png_size_t st)
G
[devel]  
Glenn Randers-Pehrson 已提交
1164
{
1165 1166
   if (ps->current == NULL || ps->next == NULL)
      png_error(ps->pread, "store state damaged");
1167

G
[devel]  
Glenn Randers-Pehrson 已提交
1168 1169
   while (st > 0)
   {
1170
      size_t cbAvail = store_read_buffer_size(ps) - ps->readpos;
G
[devel]  
Glenn Randers-Pehrson 已提交
1171 1172 1173 1174

      if (cbAvail > 0)
      {
         if (cbAvail > st) cbAvail = st;
1175 1176 1177 1178
         memcpy(pb, ps->next->buffer + ps->readpos, cbAvail);
         st -= cbAvail;
         pb += cbAvail;
         ps->readpos += cbAvail;
G
[devel]  
Glenn Randers-Pehrson 已提交
1179
      }
1180

1181
      else if (!store_read_buffer_next(ps))
1182
         png_error(ps->pread, "read beyond end of file");
G
[devel]  
Glenn Randers-Pehrson 已提交
1183 1184 1185
   }
}

1186
static void
1187
store_read(png_structp ppIn, png_bytep pb, png_size_t st)
1188
{
1189
   png_const_structp pp = ppIn;
1190
   png_store *ps = voidcast(png_store*, png_get_io_ptr(pp));
1191

1192 1193 1194 1195 1196 1197 1198 1199 1200
   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)
{
1201 1202 1203 1204
   /* 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)
1205
      png_error(pp, "store state damaged (progressive)");
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215

   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));
}
1216
#endif /* PNG_READ_SUPPORTED */
1217

1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230
/* 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)
   {
1231 1232
      ps->palette = voidcast(store_palette_entry*, malloc(npalette *
         sizeof *ps->palette));
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242

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

      ps->npalette = npalette;
   }

   return ps->palette;
}

1243
#ifdef PNG_READ_SUPPORTED
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256
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;
}
1257
#endif /* PNG_READ_SUPPORTED */
1258

1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
/***************************** MEMORY MANAGEMENT*** ***************************/
/* 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
1280
store_pool_error(png_store *ps, png_const_structp pp, PNG_CONST char *msg)
1281 1282 1283 1284
{
   if (pp != NULL)
      png_error(pp, msg);

1285 1286 1287 1288
   /* 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.
    */
1289
   store_log(ps, pp, msg, 1 /* error */);
1290 1291 1292
}

static void
1293
store_memory_free(png_const_structp pp, store_pool *pool, store_memory *memory)
1294 1295 1296 1297 1298 1299
{
   /* 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)
1300
      store_pool_error(pool->store, pp, "memory corrupted (pool)");
1301 1302

   else if (memcmp(memory->mark, pool->mark, sizeof memory->mark) != 0)
1303
      store_pool_error(pool->store, pp, "memory corrupted (start)");
1304 1305 1306 1307 1308 1309 1310

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

      if (cb > pool->max)
1311
         store_pool_error(pool->store, pp, "memory corrupted (size)");
1312 1313 1314

      else if (memcmp((png_bytep)(memory+1)+cb, pool->mark, sizeof pool->mark)
         != 0)
1315
         store_pool_error(pool->store, pp, "memory corrupted (end)");
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342

      /* 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;

1343
         fprintf(stderr, "\t%lu bytes @ %p\n",
1344
             (unsigned long)next->size, (PNG_CONST void*)(next+1));
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
         /* 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;
1362 1363 1364 1365

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

1366
   pool->limit = 0;
1367 1368 1369 1370

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

1371 1372 1373 1374 1375 1376 1377 1378
   pool->total = 0;

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

/* The memory callbacks: */
static png_voidp
1379
store_malloc(png_structp ppIn, png_alloc_size_t cb)
1380
{
1381
   png_const_structp pp = ppIn;
1382 1383 1384
   store_pool *pool = voidcast(store_pool*, png_get_mem_ptr(pp));
   store_memory *new = voidcast(store_memory*, malloc(cb + (sizeof *new) +
      (sizeof pool->mark)));
1385 1386 1387

   if (new != NULL)
   {
1388 1389 1390
      if (cb > pool->max)
         pool->max = cb;

1391
      pool->current += cb;
1392 1393 1394 1395

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

1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
      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;
   }
1406

1407
   else
1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
   {
      /* 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 */);
   }
1423 1424 1425 1426 1427

   return new;
}

static void
1428
store_free(png_structp ppIn, png_voidp memory)
1429
{
1430
   png_const_structp pp = ppIn;
1431 1432
   store_pool *pool = voidcast(store_pool*, png_get_mem_ptr(pp));
   store_memory *this = voidcast(store_memory*, memory), **test;
1433

1434 1435 1436 1437 1438 1439 1440 1441
   /* 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;

1442
   /* First check that this 'memory' really is valid memory - it must be in the
1443
    * pool list.  If it is, use the shared memory_free function to free it.
1444 1445 1446 1447 1448 1449
    */
   --this;
   for (test = &pool->list; *test != this; test = &(*test)->next)
   {
      if (*test == NULL)
      {
1450
         store_pool_error(pool->store, pp, "bad pointer to free");
1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
         return;
      }
   }

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

G
[devel]  
Glenn Randers-Pehrson 已提交
1461 1462 1463
/* Setup functions. */
/* Cleanup when aborting a write or after storing the new file. */
static void
1464
store_write_reset(png_store *ps)
G
[devel]  
Glenn Randers-Pehrson 已提交
1465 1466 1467
{
   if (ps->pwrite != NULL)
   {
1468 1469 1470 1471 1472 1473 1474 1475 1476 1477
      anon_context(ps);

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

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

G
[devel]  
Glenn Randers-Pehrson 已提交
1478 1479 1480
      ps->pwrite = NULL;
      ps->piwrite = NULL;
   }
1481 1482 1483 1484 1485

   /* 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.
    */
   store_pool_delete(ps, &ps->write_memory_pool);
1486

1487
   store_freenew(ps);
G
[devel]  
Glenn Randers-Pehrson 已提交
1488 1489 1490
}

/* The following is the main write function, it returns a png_struct and,
1491
 * optionally, a png_info suitable for writiing a new PNG file.  Use
1492 1493
 * 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 已提交
1494 1495
 */
static png_structp
1496 1497
set_store_for_write(png_store *ps, png_infopp ppi,
   PNG_CONST char * volatile name)
G
[devel]  
Glenn Randers-Pehrson 已提交
1498
{
1499
   anon_context(ps);
G
[devel]  
Glenn Randers-Pehrson 已提交
1500

1501 1502 1503
   Try
   {
      if (ps->pwrite != NULL)
1504
         png_error(ps->pwrite, "write store already in use");
1505 1506 1507

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

1509 1510 1511 1512
      /* Don't do the slow memory checks if doing a speed test. */
      if (ps->speed)
         ps->pwrite = png_create_write_struct(PNG_LIBPNG_VER_STRING,
            ps, store_error, store_warning);
1513

1514 1515 1516 1517
      else
         ps->pwrite = png_create_write_struct_2(PNG_LIBPNG_VER_STRING,
            ps, store_error, store_warning, &ps->write_memory_pool,
            store_malloc, store_free);
1518

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

1521 1522 1523 1524
      if (ppi != NULL)
         *ppi = ps->piwrite = png_create_info_struct(ps->pwrite);
   }

1525 1526
   Catch_anonymous
      return NULL;
G
[devel]  
Glenn Randers-Pehrson 已提交
1527

1528
   return ps->pwrite;
G
[devel]  
Glenn Randers-Pehrson 已提交
1529 1530
}

1531
/* Cleanup when finished reading (either due to error or in the success case).
1532 1533
 * 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 已提交
1534 1535
 */
static void
1536
store_read_reset(png_store *ps)
G
[devel]  
Glenn Randers-Pehrson 已提交
1537
{
1538 1539 1540 1541
#  ifdef PNG_READ_SUPPORTED
      if (ps->pread != NULL)
      {
         anon_context(ps);
1542

1543 1544
         Try
            png_destroy_read_struct(&ps->pread, &ps->piread, NULL);
1545

1546 1547 1548 1549
         Catch_anonymous
         {
            /* error already output: continue */
         }
1550

1551 1552 1553 1554
         ps->pread = NULL;
         ps->piread = NULL;
      }
#  endif
G
[devel]  
Glenn Randers-Pehrson 已提交
1555

1556 1557 1558
   /* Always do this to be safe. */
   store_pool_delete(ps, &ps->read_memory_pool);

G
[devel]  
Glenn Randers-Pehrson 已提交
1559 1560 1561
   ps->current = NULL;
   ps->next = NULL;
   ps->readpos = 0;
1562
   ps->validated = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
1563 1564
}

1565
#ifdef PNG_READ_SUPPORTED
G
[devel]  
Glenn Randers-Pehrson 已提交
1566
static void
1567
store_read_set(png_store *ps, png_uint_32 id)
G
[devel]  
Glenn Randers-Pehrson 已提交
1568
{
1569
   png_store_file *pf = ps->saved;
G
[devel]  
Glenn Randers-Pehrson 已提交
1570 1571 1572 1573 1574 1575

   while (pf != NULL)
   {
      if (pf->id == id)
      {
         ps->current = pf;
1576
         ps->next = NULL;
1577
         store_read_buffer_next(ps);
1578
         return;
G
[devel]  
Glenn Randers-Pehrson 已提交
1579 1580 1581 1582 1583
      }

      pf = pf->next;
   }

1584 1585 1586 1587 1588 1589 1590 1591
      {
      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);
      }
G
[devel]  
Glenn Randers-Pehrson 已提交
1592 1593 1594 1595 1596
}

/* 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
1597
 * destroyed by store_read_reset above.
G
[devel]  
Glenn Randers-Pehrson 已提交
1598 1599
 */
static png_structp
1600
set_store_for_read(png_store *ps, png_infopp ppi, png_uint_32 id,
1601
   PNG_CONST char *name)
G
[devel]  
Glenn Randers-Pehrson 已提交
1602
{
1603
   /* Set the name for png_error */
G
[devel]  
Glenn Randers-Pehrson 已提交
1604 1605
   safecat(ps->test, sizeof ps->test, 0, name);

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

1609
   store_read_reset(ps);
1610

1611
   /* Both the create APIs can return NULL if used in their default mode
1612 1613 1614 1615
    * (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.
1616 1617 1618 1619
    */
   if (ps->speed)
      ps->pread = png_create_read_struct(PNG_LIBPNG_VER_STRING, ps,
          store_error, store_warning);
1620

1621 1622 1623 1624
   else
      ps->pread = png_create_read_struct_2(PNG_LIBPNG_VER_STRING, ps,
          store_error, store_warning, &ps->read_memory_pool, store_malloc,
          store_free);
G
[devel]  
Glenn Randers-Pehrson 已提交
1625

1626 1627 1628
   if (ps->pread == NULL)
   {
      struct exception_context *the_exception_context = &ps->exception_context;
G
[devel]  
Glenn Randers-Pehrson 已提交
1629

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

1633
      Throw ps;
1634
   }
1635

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

1638 1639 1640 1641
   if (ppi != NULL)
      *ppi = ps->piread = png_create_info_struct(ps->pread);

   return ps->pread;
G
[devel]  
Glenn Randers-Pehrson 已提交
1642
}
1643
#endif /* PNG_READ_SUPPORTED */
G
[devel]  
Glenn Randers-Pehrson 已提交
1644

1645 1646 1647 1648 1649 1650 1651 1652 1653
/* 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);
1654
   store_image_free(ps, NULL);
1655 1656
}

G
[devel]  
Glenn Randers-Pehrson 已提交
1657 1658
/*********************** PNG FILE MODIFICATION ON READ ************************/
/* Files may be modified on read.  The following structure contains a complete
1659
 * png_store together with extra members to handle modification and a special
G
[devel]  
Glenn Randers-Pehrson 已提交
1660 1661 1662
 * 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
1663 1664
 * png_store.  There is a special read function, set_modifier_for_read, which
 * replaces set_store_for_read.
G
[devel]  
Glenn Randers-Pehrson 已提交
1665
 */
1666 1667 1668 1669 1670 1671 1672
typedef enum modifier_state
{
   modifier_start,                        /* Initial value */
   modifier_signature,                    /* Have a signature */
   modifier_IHDR                          /* Have an IHDR */
} modifier_state;

1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694
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;

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;

1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707
#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);
}

1708 1709 1710 1711
static CIE_color
white_point(PNG_CONST color_encoding *encoding)
{
   CIE_color white;
1712

1713 1714 1715 1716 1717 1718 1719
   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;
}

1720
#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739
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;
   }
}
1740
#endif
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780

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;
}
1781
#endif /* PNG_READ_SUPPORTED */
1782

G
[devel]  
Glenn Randers-Pehrson 已提交
1783 1784
typedef struct png_modifier
{
1785
   png_store               this;             /* I am a png_store */
G
[devel]  
Glenn Randers-Pehrson 已提交
1786
   struct png_modification *modifications;   /* Changes to make */
1787

1788
   modifier_state           state;           /* My state */
G
[devel]  
Glenn Randers-Pehrson 已提交
1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800

   /* 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 */
1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816
   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 已提交
1817 1818

   /* Lowest sbit to test (libpng fails for sbit < 8) */
1819
   png_byte                 sbitlow;
G
[devel]  
Glenn Randers-Pehrson 已提交
1820 1821 1822 1823 1824

   /* Error control - these are the limits on errors accepted by the gamma tests
    * below.
    */
   double                   maxout8;  /* Maximum output value error */
G
Glenn Randers-Pehrson 已提交
1825
   double                   maxabs8;  /* Absolute sample error 0..1 */
1826
   double                   maxcalc8; /* Absolute sample error 0..1 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1827 1828 1829
   double                   maxpc8;   /* Percentage sample error 0..100% */
   double                   maxout16; /* Maximum output value error */
   double                   maxabs16; /* Absolute sample error 0..1 */
1830
   double                   maxcalc16;/* Absolute sample error 0..1 */
G
[devel]  
Glenn Randers-Pehrson 已提交
1831 1832
   double                   maxpc16;  /* Percentage sample error 0..100% */

1833 1834 1835 1836 1837 1838 1839
   /* 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 */

1840 1841 1842 1843 1844 1845
   /* 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 已提交
1846 1847 1848 1849 1850 1851 1852
   /* 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;
1853
   double                   error_indexed;
G
[devel]  
Glenn Randers-Pehrson 已提交
1854 1855

   /* Flags: */
1856 1857 1858 1859 1860
   /* Whether to call png_read_update_info, not png_read_start_image, and how
    * many times to call it.
    */
   int                      use_update_info;

1861 1862 1863
   /* Whether or not to interlace. */
   int                      interlace_type :9; /* int, but must store '1' */

1864 1865 1866
   /* Run the standard tests? */
   unsigned int             test_standard :1;

1867 1868 1869
   /* Run the odd-sized image and interlace read/write tests? */
   unsigned int             test_size :1;

1870 1871 1872
   /* Run tests on reading with a combiniation of transforms, */
   unsigned int             test_transform :1;

G
[devel]  
Glenn Randers-Pehrson 已提交
1873
   /* When to use the use_input_precision option: */
1874 1875 1876
   unsigned int             use_input_precision :1;
   unsigned int             use_input_precision_sbit :1;
   unsigned int             use_input_precision_16to8 :1;
1877

1878 1879 1880 1881 1882 1883 1884 1885 1886
   /* 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;

   /* If set assume that the calculations are done in 16 bits even if both input
    * and output are 8 bit or less.
    */
   unsigned int             assume_16_bit_calculations :1;
1887

1888
   /* Which gamma tests to run: */
1889 1890 1891
   unsigned int             test_gamma_threshold :1;
   unsigned int             test_gamma_transform :1; /* main tests */
   unsigned int             test_gamma_sbit :1;
1892
   unsigned int             test_gamma_scale16 :1;
1893 1894 1895
   unsigned int             test_gamma_background :1;
   unsigned int             test_gamma_alpha_mode :1;
   unsigned int             test_gamma_expand16 :1;
1896
   unsigned int             test_exhaustive :1;
1897

1898
   unsigned int             log :1;   /* Log max error */
G
[devel]  
Glenn Randers-Pehrson 已提交
1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914

   /* 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
 * failed and it is running silently.
 */
static int fail(png_modifier *pm)
{
   return !pm->log && !pm->this.verbose && (pm->this.nerrors > 0 ||
1915
       (pm->this.treat_warnings_as_errors && pm->this.nwarnings > 0));
G
[devel]  
Glenn Randers-Pehrson 已提交
1916 1917 1918 1919 1920 1921
}

static void
modifier_init(png_modifier *pm)
{
   memset(pm, 0, sizeof *pm);
1922
   store_init(&pm->this);
G
[devel]  
Glenn Randers-Pehrson 已提交
1923 1924
   pm->modifications = NULL;
   pm->state = modifier_start;
1925
   pm->sbitlow = 1U;
1926
   pm->ngammas = 0;
1927
   pm->ngamma_tests = 0;
1928
   pm->gammas = 0;
1929 1930 1931 1932 1933 1934 1935 1936
   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;
1937 1938
   pm->maxout8 = pm->maxpc8 = pm->maxabs8 = pm->maxcalc8 = 0;
   pm->maxout16 = pm->maxpc16 = pm->maxabs16 = pm->maxcalc16 = 0;
1939
   pm->limit = 4E-3;
1940
   pm->log8 = pm->log16 = 0; /* Means 'off' */
G
[devel]  
Glenn Randers-Pehrson 已提交
1941 1942
   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;
1943
   pm->error_indexed = 0;
1944
   pm->use_update_info = 0;
1945
   pm->interlace_type = PNG_INTERLACE_NONE;
1946
   pm->test_standard = 0;
1947
   pm->test_size = 0;
1948
   pm->test_transform = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
1949 1950 1951
   pm->use_input_precision = 0;
   pm->use_input_precision_sbit = 0;
   pm->use_input_precision_16to8 = 0;
1952
   pm->calculations_use_input_precision = 0;
1953 1954 1955
   pm->test_gamma_threshold = 0;
   pm->test_gamma_transform = 0;
   pm->test_gamma_sbit = 0;
1956
   pm->test_gamma_scale16 = 0;
1957 1958 1959
   pm->test_gamma_background = 0;
   pm->test_gamma_alpha_mode = 0;
   pm->test_gamma_expand16 = 0;
1960
   pm->test_exhaustive = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
1961 1962 1963 1964 1965
   pm->log = 0;

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

1966
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
1967 1968 1969 1970 1971
/* If pm->calculations_use_input_precision is set then operations will happen
 * with only 8 bit precision unless both the input and output bit depth are 16.
 *
 * 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
1972 1973
 * to a calculation - not a digitization operation - unless the following API is
 * called directly.
1974
 */
1975
#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999
static double digitize(PNG_CONST png_modifier *pm, double value,
   int sample_depth, int do_round)
{
   /* '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.
    */
   PNG_CONST unsigned int digitization_factor =
      (pm->assume_16_bit_calculations || sample_depth == 16) ? 65535 : 255;

   /* 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;
   else if (value >= 1)
      value = 1;

   value *= digitization_factor;
   if (do_round) value += .5;
   return floor(value)/digitization_factor;
}
2000
#endif
2001

2002 2003
#if defined(PNG_READ_GAMMA_SUPPORTED) ||\
   defined(PNG_READ_RGB_TO_GRAY_SUPPORTED)
2004
static double abserr(PNG_CONST png_modifier *pm, int in_depth, int out_depth)
2005
{
2006 2007 2008 2009 2010 2011 2012 2013
   /* Absolute error permitted in linear values - affected by the bit depth of
    * the calculations.
    */
   if (pm->assume_16_bit_calculations || (out_depth == 16 && (in_depth == 16 ||
      !pm->calculations_use_input_precision)))
      return pm->maxabs16;
   else
      return pm->maxabs8;
2014
}
2015
#endif
2016

2017
#ifdef PNG_READ_GAMMA_SUPPORTED
2018
static double calcerr(PNG_CONST png_modifier *pm, int in_depth, int out_depth)
2019
{
2020 2021
   /* Error in the linear composition arithmetic - only relevant when
    * composition actually happens (0 < alpha < 1).
2022
    */
2023 2024 2025
   if (pm->assume_16_bit_calculations || (out_depth == 16 && (in_depth == 16 ||
      !pm->calculations_use_input_precision)))
      return pm->maxcalc16;
2026
   else
2027
      return pm->maxcalc8;
2028 2029
}

2030
static double pcerr(PNG_CONST png_modifier *pm, int in_depth, int out_depth)
2031
{
2032 2033 2034 2035 2036 2037 2038 2039
   /* Percentage error permitted in the linear values.  Note that the specified
    * value is a percentage but this routine returns a simple number.
    */
   if (pm->assume_16_bit_calculations || (out_depth == 16 && (in_depth == 16 ||
      !pm->calculations_use_input_precision)))
      return pm->maxpc16 * .01;
   else
      return pm->maxpc8 * .01;
2040 2041
}

2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052
/* 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.
 */
2053
static double outerr(PNG_CONST png_modifier *pm, int in_depth, int out_depth)
2054 2055 2056
{
   /* 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
2057
    * error in 4 bit grayscale gamma is up to the value below.  This is a hack
2058
    * to allow pngvalid to succeed:
2059 2060
    *
    * TODO: fix this in libpng
2061
    */
2062
   if (out_depth == 2)
2063 2064
      return .73182-.5;

2065
   if (out_depth == 4)
2066 2067
      return .90644-.5;

2068 2069 2070
   if (out_depth == 16 && (in_depth == 16 ||
      !pm->calculations_use_input_precision))
      return pm->maxout16;
2071

2072 2073 2074 2075 2076 2077 2078 2079 2080 2081
   /* 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;
}

2082 2083 2084 2085
/* 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.
 */
2086
static double outlog(PNG_CONST png_modifier *pm, int in_depth, int out_depth)
2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119
{
   /* 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;
   }

   if (out_depth == 16 && (in_depth == 16 ||
      !pm->calculations_use_input_precision))
   {
      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;
}

2120 2121 2122 2123 2124
/* 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!
 */
2125
static int output_quantization_factor(PNG_CONST png_modifier *pm, int in_depth,
2126 2127 2128 2129 2130 2131 2132
   int out_depth)
{
   if (out_depth == 16 && in_depth != 16
      && pm->calculations_use_input_precision)
      return 257;
   else
      return 1;
2133
}
2134
#endif /* PNG_READ_GAMMA_SUPPORTED */
2135

2136
/* One modification structure must be provided for each chunk to be modified (in
G
[devel]  
Glenn Randers-Pehrson 已提交
2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148
 * 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;
2149

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

G
[devel]  
Glenn Randers-Pehrson 已提交
2154 2155 2156 2157 2158
   /* 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;
2159 2160 2161
   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 已提交
2162 2163
} png_modification;

2164 2165
static void
modification_reset(png_modification *pmm)
G
[devel]  
Glenn Randers-Pehrson 已提交
2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186
{
   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);
}

2187
#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198
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;
}
2199
#endif
2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279

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 已提交
2280 2281 2282
static void
modifier_reset(png_modifier *pm)
{
2283
   store_read_reset(&pm->this);
2284 2285 2286
   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 已提交
2287 2288
   pm->modifications = NULL;
   pm->state = modifier_start;
2289 2290 2291 2292 2293 2294 2295 2296 2297 2298
   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 已提交
2299
   pm->bit_depth = pm->colour_type = 0;
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
}

/* 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 已提交
2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378
}

/* 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);
2379
   uLong crc = crc32(0, buffer+4, datalen+4);
2380 2381 2382
   /* 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 已提交
2383 2384 2385 2386 2387 2388 2389 2390 2391 2392
}

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;
}

2393 2394 2395 2396
/* 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 已提交
2397
static void
2398
modifier_read_imp(png_modifier *pm, png_bytep pb, png_size_t st)
G
[devel]  
Glenn Randers-Pehrson 已提交
2399 2400 2401 2402 2403 2404 2405 2406 2407
{
   while (st > 0)
   {
      size_t cb;
      png_uint_32 len, chunk;
      png_modification *mod;

      if (pm->buffer_position >= pm->buffer_count) switch (pm->state)
      {
2408 2409
         static png_byte sign[8] = { 137, 80, 78, 71, 13, 10, 26, 10 };
         case modifier_start:
2410
            store_read_imp(&pm->this, pm->buffer, 8); /* size of signature. */
2411 2412
            pm->buffer_count = 8;
            pm->buffer_position = 0;
2413

2414
            if (memcmp(pm->buffer, sign, 8) != 0)
2415
               png_error(pm->this.pread, "invalid PNG file signature");
2416 2417
            pm->state = modifier_signature;
            break;
2418

2419
         case modifier_signature:
2420
            store_read_imp(&pm->this, pm->buffer, 13+12); /* size of IHDR */
2421 2422
            pm->buffer_count = 13+12;
            pm->buffer_position = 0;
2423

2424 2425
            if (png_get_uint_32(pm->buffer) != 13 ||
                png_get_uint_32(pm->buffer+4) != CHUNK_IHDR)
2426
               png_error(pm->this.pread, "invalid IHDR");
2427

2428
            /* Check the list of modifiers for modifications to the IHDR. */
2429 2430 2431
            mod = pm->modifications;
            while (mod != NULL)
            {
2432
               if (mod->chunk == CHUNK_IHDR && mod->modify_fn &&
2433
                   (*mod->modify_fn)(pm, mod, 0))
2434
                  {
2435 2436
                  mod->modified = 1;
                  modifier_setbuffer(pm);
2437
                  }
2438

2439
               /* Ignore removal or add if IHDR! */
2440 2441
               mod = mod->next;
            }
2442

2443 2444 2445
            /* Cache information from the IHDR (the modified one.) */
            pm->bit_depth = pm->buffer[8+8];
            pm->colour_type = pm->buffer[8+8+1];
2446

2447 2448 2449
            pm->state = modifier_IHDR;
            pm->flush = 0;
            break;
2450

2451 2452 2453 2454 2455
         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.
2456
             */
2457 2458 2459 2460
            if ((cb = pm->flush) > 0)
            {
               if (cb > st) cb = st;
               pm->flush -= cb;
2461
               store_read_imp(&pm->this, pb, cb);
2462 2463
               pb += cb;
               st -= cb;
2464
               if (st == 0) return;
2465
            }
2466

2467 2468 2469 2470
            /* No more bytes to flush, read a header, or handle a pending
             * chunk.
             */
            if (pm->pending_chunk != 0)
2471
            {
2472 2473 2474 2475 2476 2477
               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
2478
               store_read_imp(&pm->this, pm->buffer, 8);
2479

2480 2481
            pm->buffer_count = 8;
            pm->buffer_position = 0;
2482

2483 2484 2485
            /* Check for something to modify or a terminator chunk. */
            len = png_get_uint_32(pm->buffer);
            chunk = png_get_uint_32(pm->buffer+4);
2486

2487 2488 2489 2490 2491 2492 2493
            /* Terminators first, they may have to be delayed for added
             * chunks
             */
            if (chunk == CHUNK_PLTE || chunk == CHUNK_IDAT ||
                chunk == CHUNK_IEND)
            {
               mod = pm->modifications;
2494

2495
               while (mod != NULL)
2496
               {
2497 2498 2499
                  if ((mod->add == chunk ||
                      (mod->add == CHUNK_PLTE && chunk == CHUNK_IDAT)) &&
                      mod->modify_fn != NULL && !mod->modified && !mod->added)
2500
                  {
2501 2502 2503 2504
                     /* Regardless of what the modify function does do not run
                      * this again.
                      */
                     mod->added = 1;
2505

2506
                     if ((*mod->modify_fn)(pm, mod, 1 /*add*/))
2507 2508 2509 2510 2511 2512 2513 2514 2515 2516
                     {
                        /* Reset the CRC on a new chunk */
                        if (pm->buffer_count > 0)
                           modifier_setbuffer(pm);

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

2518 2519 2520 2521 2522 2523 2524
                        /* 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 */
                     }
2525
                  }
2526

2527 2528
                  mod = mod->next;
               }
2529

2530
               /* Don't do any further processing if the buffer was modified -
2531 2532
                * otherwise the code will end up modifying a chunk that was
                * just added.
2533 2534 2535 2536
                */
               if (mod != NULL)
                  break; /* out of switch */
            }
2537

2538 2539
            /* 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
2540 2541 2542 2543
             * it just gets flushed.
             */
            if (len+12 <= sizeof pm->buffer)
            {
2544
               store_read_imp(&pm->this, pm->buffer+pm->buffer_count,
2545 2546
                   len+12-pm->buffer_count);
               pm->buffer_count = len+12;
2547

2548 2549 2550 2551 2552
               /* Check for a modification, else leave it be. */
               mod = pm->modifications;
               while (mod != NULL)
               {
                  if (mod->chunk == chunk)
2553
                  {
2554 2555 2556 2557 2558 2559 2560 2561
                     if (mod->modify_fn == NULL)
                     {
                        /* Remove this chunk */
                        pm->buffer_count = pm->buffer_position = 0;
                        mod->removed = 1;
                        break; /* Terminate the while loop */
                     }

2562
                     else if ((*mod->modify_fn)(pm, mod, 0))
2563
                     {
2564 2565 2566 2567 2568 2569 2570 2571
                        mod->modified = 1;
                        /* The chunk may have been removed: */
                        if (pm->buffer_count == 0)
                        {
                           pm->buffer_position = 0;
                           break;
                        }
                        modifier_setbuffer(pm);
2572 2573
                     }
                  }
2574

2575
                  mod = mod->next;
2576 2577 2578
               }
            }

2579 2580
            else
               pm->flush = len+12 - pm->buffer_count; /* data + crc */
2581

2582 2583
            /* Take the data from the buffer (if there is any). */
            break;
G
[devel]  
Glenn Randers-Pehrson 已提交
2584 2585 2586
      }

      /* Here to read from the modifier buffer (not directly from
2587
       * the store, as in the flush case above.)
G
[devel]  
Glenn Randers-Pehrson 已提交
2588 2589
       */
      cb = pm->buffer_count - pm->buffer_position;
2590 2591 2592 2593

      if (cb > st)
         cb = st;

G
[devel]  
Glenn Randers-Pehrson 已提交
2594 2595 2596 2597 2598 2599 2600
      memcpy(pb, pm->buffer + pm->buffer_position, cb);
      st -= cb;
      pb += cb;
      pm->buffer_position += cb;
   }
}

2601 2602
/* The callback: */
static void
2603
modifier_read(png_structp ppIn, png_bytep pb, png_size_t st)
2604
{
2605
   png_const_structp pp = ppIn;
2606
   png_modifier *pm = voidcast(png_modifier*, png_get_io_ptr(pp));
2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624

   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
2625
    * the aim is to stress the progressive reader with truly horrible variable
2626 2627 2628
    * 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.
2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670
    */
   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 已提交
2671 2672 2673
/* Set up a modifier. */
static png_structp
set_modifier_for_read(png_modifier *pm, png_infopp ppi, png_uint_32 id,
2674
    PNG_CONST char *name)
G
[devel]  
Glenn Randers-Pehrson 已提交
2675
{
2676 2677 2678 2679 2680 2681 2682
   /* 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;
2683

2684 2685 2686 2687 2688
   pm->pending_len = 0;
   pm->pending_chunk = 0;
   pm->flush = 0;
   pm->buffer_count = 0;
   pm->buffer_position = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
2689

2690
   return set_store_for_read(&pm->this, ppi, id, name);
G
[devel]  
Glenn Randers-Pehrson 已提交
2691
}
2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 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 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 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


/******************************** 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;
}

2825
#ifdef PNG_READ_GAMMA_SUPPORTED
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
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;
}
2892
#endif /* PNG_READ_GAMMA_SUPPORTED */
2893
#endif /* PNG_READ_TRANSFORMS_SUPPORTED */
G
[devel]  
Glenn Randers-Pehrson 已提交
2894 2895 2896

/***************************** STANDARD PNG FILES *****************************/
/* Standard files - write and save standard files. */
2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908
/* 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 已提交
2909
 * buffer.  This makes allocation easier below.  Further regardless of the file
2910
 * format every row has 128 pixels (giving 1024 bytes for 64bpp formats).
G
[devel]  
Glenn Randers-Pehrson 已提交
2911 2912
 *
 * Files are stored with no gAMA or sBIT chunks, with a PLTE only when needed
2913
 * and with an ID derived from the colour type, bit depth and interlace type
2914 2915 2916 2917 2918 2919 2920
 * 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.
2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934
 *
 * 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
2935
 * testing.)
2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953
 *
 * 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)
   {
2954 2955 2956
      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);
2957 2958
   }

2959
   /* Then add 62 grays (one quarter of the remaining 256 slots). */
2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989
   {
      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
2990
    * already have, chance is less than 1/65536.  Don't worry about grays,
2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038
    * 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 已提交
3039
 */
3040
/* TODO: the png_structp here can probably be 'const' in the future */
3041 3042 3043 3044 3045 3046 3047 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 3078 3079 3080 3081 3082 3083
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;

      if (j > 0)
         png_set_tRNS(pp, pi, tRNS, j, 0/*color*/);
   }
}
3084

3085
/* The number of passes is related to the interlace type. There was no libpng
3086
 * API to determine this prior to 1.5, so we need an inquiry function:
3087 3088
 */
static int
3089
npasses_from_interlace_type(png_const_structp pp, int interlace_type)
3090 3091 3092 3093 3094 3095 3096 3097 3098 3099
{
   switch (interlace_type)
   {
   default:
      png_error(pp, "invalid interlace type");

   case PNG_INTERLACE_NONE:
      return 1;

   case PNG_INTERLACE_ADAM7:
3100
      return PNG_INTERLACE_ADAM7_PASSES;
3101 3102
   }
}
G
[devel]  
Glenn Randers-Pehrson 已提交
3103

3104
static unsigned int
3105
bit_size(png_const_structp pp, png_byte colour_type, png_byte bit_depth)
G
[devel]  
Glenn Randers-Pehrson 已提交
3106 3107 3108
{
   switch (colour_type)
   {
3109 3110
      default: png_error(pp, "invalid color type");

3111 3112 3113 3114 3115 3116 3117 3118 3119
      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 已提交
3120 3121 3122
   }
}

3123 3124 3125 3126
#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 */
3127
#define SIZE_HEIGHTMAX 16 /* Maximum range of size images */
3128

G
[devel]  
Glenn Randers-Pehrson 已提交
3129
static size_t
3130 3131
transform_rowsize(png_const_structp pp, png_byte colour_type,
   png_byte bit_depth)
G
[devel]  
Glenn Randers-Pehrson 已提交
3132
{
3133
   return (TRANSFORM_WIDTH * bit_size(pp, colour_type, bit_depth)) / 8;
G
[devel]  
Glenn Randers-Pehrson 已提交
3134 3135
}

3136
/* transform_width(pp, colour_type, bit_depth) current returns the same number
3137 3138
 * every time, so just use a macro:
 */
3139
#define transform_width(pp, colour_type, bit_depth) TRANSFORM_WIDTH
G
[devel]  
Glenn Randers-Pehrson 已提交
3140 3141

static png_uint_32
3142
transform_height(png_const_structp pp, png_byte colour_type, png_byte bit_depth)
G
[devel]  
Glenn Randers-Pehrson 已提交
3143 3144 3145
{
   switch (bit_size(pp, colour_type, bit_depth))
   {
3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163
      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. */
3164
#        define TRANSFORM_HEIGHTMAX 2048
3165 3166 3167

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

3171
#ifdef PNG_READ_SUPPORTED
3172 3173 3174 3175
/* The following can only be defined here, now we have the definitions
 * of the transform image sizes.
 */
static png_uint_32
3176
standard_width(png_const_structp pp, png_uint_32 id)
3177 3178
{
   png_uint_32 width = WIDTH_FROM_ID(id);
3179
   UNUSED(pp)
3180 3181 3182 3183 3184 3185 3186 3187

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

   return width;
}

static png_uint_32
3188
standard_height(png_const_structp pp, png_uint_32 id)
3189 3190 3191 3192 3193 3194 3195 3196 3197 3198
{
   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
3199
standard_rowsize(png_const_structp pp, png_uint_32 id)
3200 3201 3202 3203 3204 3205 3206
{
   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;
}
3207
#endif /* PNG_READ_SUPPORTED */
3208

G
[devel]  
Glenn Randers-Pehrson 已提交
3209
static void
3210
transform_row(png_const_structp pp, png_byte buffer[TRANSFORM_ROWMAX],
3211
   png_byte colour_type, png_byte bit_depth, png_uint_32 y)
G
[devel]  
Glenn Randers-Pehrson 已提交
3212 3213 3214 3215 3216 3217
{
   png_uint_32 v = y << 7;
   png_uint_32 i = 0;

   switch (bit_size(pp, colour_type, bit_depth))
   {
3218
      case 1:
3219
         while (i<128/8) buffer[i] = (png_byte)(v & 0xff), v += 17, ++i;
3220 3221 3222
         return;

      case 2:
3223
         while (i<128/4) buffer[i] = (png_byte)(v & 0xff), v += 33, ++i;
3224 3225 3226
         return;

      case 4:
3227
         while (i<128/2) buffer[i] = (png_byte)(v & 0xff), v += 65, ++i;
3228 3229 3230 3231
         return;

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

      case 16:
3236 3237
         /* Generate all 65536 pixel values in order, which includes the 8 bit
          * GA case as well as the 16 bit G case.
3238 3239
          */
         while (i<128)
3240 3241 3242 3243 3244 3245
         {
            buffer[2*i] = (png_byte)((v>>8) & 0xff);
            buffer[2*i+1] = (png_byte)(v & 0xff);
            ++v;
            ++i;
         }
3246 3247 3248 3249 3250 3251 3252 3253

         return;

      case 24:
         /* 65535 pixels, but rotate the values. */
         while (i<128)
         {
            /* Three bytes per pixel, r, g, b, make b by r^g */
3254 3255 3256
            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);
3257 3258 3259 3260 3261 3262 3263 3264 3265 3266
            ++v;
            ++i;
         }

         return;

      case 32:
         /* 65535 pixels, r, g, b, a; just replicate */
         while (i<128)
         {
3267 3268 3269 3270
            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);
3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283
            ++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++;
3284 3285
            buffer[6*i+0] = (png_byte)((t >> 8) & 0xff);
            buffer[6*i+1] = (png_byte)(t & 0xff);
3286
            t *= 257;
3287 3288
            buffer[6*i+2] = (png_byte)((t >> 8) & 0xff);
            buffer[6*i+3] = (png_byte)(t & 0xff);
3289
            t *= 17;
3290 3291
            buffer[6*i+4] = (png_byte)((t >> 8) & 0xff);
            buffer[6*i+5] = (png_byte)(t & 0xff);
3292 3293 3294 3295 3296 3297 3298 3299 3300 3301
            ++i;
         }

         return;

      case 64:
         /* As above in the 32 bit case. */
         while (i<128)
         {
            png_uint_32 t = v++;
3302 3303 3304 3305
            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);
3306
            t *= 257;
3307 3308 3309 3310
            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);
3311 3312 3313
            ++i;
         }
         return;
3314

3315 3316
      default:
         break;
G
[devel]  
Glenn Randers-Pehrson 已提交
3317 3318 3319 3320 3321
   }

   png_error(pp, "internal error");
}

3322 3323 3324 3325 3326
/* 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)))

3327 3328 3329 3330 3331 3332
/* 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 已提交
3333
static void
3334
make_transform_image(png_store* PNG_CONST ps, png_byte PNG_CONST colour_type,
3335 3336
    png_byte PNG_CONST bit_depth, unsigned int palette_number,
    int interlace_type, png_const_charp name)
G
[devel]  
Glenn Randers-Pehrson 已提交
3337
{
3338
   context(ps, fault);
3339

3340
   Try
G
[devel]  
Glenn Randers-Pehrson 已提交
3341 3342
   {
      png_infop pi;
3343 3344 3345 3346 3347 3348 3349 3350 3351 3352
      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;

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

3355
      png_set_IHDR(pp, pi, transform_width(pp, colour_type, bit_depth), h,
3356 3357 3358
         bit_depth, colour_type, interlace_type,
         PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);

3359
#ifdef PNG_TEXT_SUPPORTED
3360
#  if defined(PNG_READ_zTXt_SUPPORTED) && defined(PNG_WRITE_zTXt_SUPPORTED)
3361 3362 3363 3364
#     define TEXT_COMPRESSION PNG_TEXT_COMPRESSION_zTXt
#  else
#     define TEXT_COMPRESSION PNG_TEXT_COMPRESSION_NONE
#  endif
3365 3366 3367 3368 3369 3370 3371 3372 3373
      {
         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.
          */
3374
         text.compression = TEXT_COMPRESSION;
3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387
         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

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

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

3393
      if (png_get_rowbytes(pp, pi) !=
3394
          transform_rowsize(pp, colour_type, bit_depth))
3395 3396 3397
         png_error(pp, "row size incorrect");

      else
G
[devel]  
Glenn Randers-Pehrson 已提交
3398
      {
3399
         /* Somewhat confusingly this must be called *after* png_write_info
3400
          * because if it is called before, the information in *pp has not been
3401 3402 3403 3404
          * updated to reflect the interlaced image.
          */
         int npasses = png_set_interlace_handling(pp);
         int pass;
G
[devel]  
Glenn Randers-Pehrson 已提交
3405

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

3409
         for (pass=0; pass<npasses; ++pass)
3410
         {
3411
            png_uint_32 y;
G
[devel]  
Glenn Randers-Pehrson 已提交
3412

3413 3414
            for (y=0; y<h; ++y)
            {
3415
               png_byte buffer[TRANSFORM_ROWMAX];
G
[devel]  
Glenn Randers-Pehrson 已提交
3416

3417
               transform_row(pp, buffer, colour_type, bit_depth, y);
3418 3419
               png_write_row(pp, buffer);
            }
3420
         }
3421
      }
G
[devel]  
Glenn Randers-Pehrson 已提交
3422

3423 3424 3425 3426 3427 3428 3429 3430 3431
#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.
          */
3432
         text.compression = TEXT_COMPRESSION;
3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443
         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

3444
      png_write_end(pp, pi);
3445

3446
      /* And store this under the appropriate id, then clean up. */
3447 3448
      store_storefile(ps, FILEID(colour_type, bit_depth, palette_number,
         interlace_type, 0, 0, 0));
3449

3450 3451
      store_write_reset(ps);
   }
3452

3453 3454
   Catch(fault)
   {
3455
      /* Use the png_store returned by the exception. This may help the compiler
3456 3457 3458 3459
       * 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);
3460 3461
   }
}
3462

3463
static void
3464
make_transform_images(png_store *ps)
3465
{
3466 3467
   png_byte colour_type = 0;
   png_byte bit_depth = 0;
3468
   unsigned int palette_number = 0;
3469 3470 3471 3472 3473 3474 3475 3476

   /* 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.
    */
   while (next_format(&colour_type, &bit_depth, &palette_number))
3477 3478
   {
      int interlace_type;
3479

3480 3481
      for (interlace_type = PNG_INTERLACE_NONE;
           interlace_type < PNG_INTERLACE_LAST; ++interlace_type)
3482
      {
3483 3484
         char name[FILE_NAME_SIZE];

3485 3486 3487 3488
         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);
3489
      }
G
[devel]  
Glenn Randers-Pehrson 已提交
3490 3491 3492
   }
}

3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515
/* 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;
   }
}

3516
#ifdef PNG_READ_SUPPORTED
3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536
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;
   }
}
3537
#endif /* PNG_READ_SUPPORTED */
3538

3539
/* Build a single row for the 'size' test images; this fills in only the
3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573
 * 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);

   Try
   {
      png_infop pi;
3574
      png_structp pp;
3575
      unsigned int pixel_size;
3576 3577 3578

      /* Make a name and get an appropriate id for the store: */
      char name[FILE_NAME_SIZE];
3579 3580
      PNG_CONST png_uint_32 id = FILEID(colour_type, bit_depth, 0/*palette*/,
         interlace_type, w, h, do_interlace);
3581 3582 3583

      standard_name_from_id(name, sizeof name, 0, id);
      pp = set_store_for_write(ps, &pi, name);
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594

      /* 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);

3595 3596 3597 3598 3599 3600 3601 3602 3603 3604
#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.
          */
3605
         text.compression = TEXT_COMPRESSION;
3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618
         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

3619
      if (colour_type == 3) /* palette */
3620
         init_standard_palette(ps, pp, pi, 1U << bit_depth, 0/*do tRNS*/);
3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665

      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;
         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
3666
                * need a reduced interlace row; this may be reduced
3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695
                * 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;
               }

               /* Only get to here if the row has some pixels in it. */
               png_write_row(pp, row);
            }
         }
      }

3696 3697 3698 3699 3700 3701 3702 3703 3704
#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.
          */
3705
         text.compression = TEXT_COMPRESSION;
3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716
         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

3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780
      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);
            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);
         }
      }
   }
}

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);
}

3781
#ifdef PNG_READ_SUPPORTED
3782 3783
/* Return a row based on image id and 'y' for checking: */
static void
3784 3785
standard_row(png_const_structp pp, png_byte std[STANDARD_ROWMAX],
   png_uint_32 id, png_uint_32 y)
3786 3787 3788 3789 3790 3791 3792
{
   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);
}
3793
#endif /* PNG_READ_SUPPORTED */
3794

G
[devel]  
Glenn Randers-Pehrson 已提交
3795
/* Tests - individual test cases */
3796 3797 3798 3799
/* 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!
 */
3800 3801 3802
/* TODO: the 'set' functions can probably all be made to take a
 * png_const_structp rather than a modifiable one.
 */
3803
#ifdef PNG_WARNINGS_SUPPORTED
3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830
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);
}

3831
static PNG_CONST struct
3832 3833 3834 3835 3836 3837
{
   void          (*fn)(png_structp, png_infop);
   PNG_CONST char *msg;
   unsigned int    warning :1; /* the error is a warning... */
} error_test[] =
    {
3838
       /* no warnings makes these errors undetectable. */
3839 3840 3841 3842 3843
       { sBIT0_error_fn, "sBIT(0): failed to detect error", 1 },
       { sBIT_error_fn, "sBIT(too big): failed to detect error", 1 },
    };

static void
3844
make_error(png_store* volatile psIn, png_byte PNG_CONST colour_type,
3845
    png_byte bit_depth, int interlace_type, int test, png_const_charp name)
3846
{
3847 3848
   png_store * volatile ps = psIn;

3849
   context(ps, fault);
3850

3851 3852 3853 3854
   Try
   {
      png_structp pp;
      png_infop pi;
3855

3856
      pp = set_store_for_write(ps, &pi, name);
3857

3858 3859
      if (pp == NULL)
         Throw ps;
3860

3861 3862
      png_set_IHDR(pp, pi, transform_width(pp, colour_type, bit_depth),
         transform_height(pp, colour_type, bit_depth), bit_depth, colour_type,
3863
         interlace_type, PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
3864

3865
      if (colour_type == 3) /* palette */
3866
         init_standard_palette(ps, pp, pi, 1U << bit_depth, 0/*do tRNS*/);
3867

3868
      /* Time for a few errors; these are in various optional chunks, the
3869 3870
       * standard tests test the standard chunks pretty well.
       */
3871 3872
#     define exception__prev exception_prev_1
#     define exception__env exception_env_1
3873 3874 3875 3876 3877 3878 3879
      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);
3880

3881 3882
         /* Normally the error is only detected here: */
         png_write_info(pp, pi);
3883

3884 3885 3886
         /* And handle the case where it was only a warning: */
         if (ps->expect_warning && ps->saw_warning)
            Throw ps;
3887

3888 3889
         /* 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.
3890
          */
3891
         store_log(ps, pp, error_test[test].msg, 1 /*error*/);
3892
      }
3893

3894
      Catch (fault)
3895
         ps = fault; /* expected exit, make sure ps is not clobbered */
3896 3897
#undef exception__prev
#undef exception__env
3898

3899 3900
      /* And clear these flags */
      ps->expect_error = 0;
3901
      ps->expect_warning = 0;
3902

3903 3904 3905 3906
      /* 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) !=
3907
          transform_rowsize(pp, colour_type, bit_depth))
3908
         png_error(pp, "row size incorrect");
3909

3910 3911
      else
      {
3912
         png_uint_32 h = transform_height(pp, colour_type, bit_depth);
3913 3914 3915 3916 3917 3918
         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");

3919
         for (pass=0; pass<npasses; ++pass)
3920 3921
         {
            png_uint_32 y;
3922

3923
            for (y=0; y<h; ++y)
3924
            {
3925
               png_byte buffer[TRANSFORM_ROWMAX];
3926

3927
               transform_row(pp, buffer, colour_type, bit_depth, y);
3928 3929
               png_write_row(pp, buffer);
            }
3930 3931
         }
      }
3932

3933
      png_write_end(pp, pi);
3934

3935 3936 3937
      /* The following deletes the file that was just written. */
      store_write_reset(ps);
   }
3938

3939 3940
   Catch(fault)
   {
3941
      store_write_reset(fault);
3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958
   }
}

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;

      for (interlace_type = PNG_INTERLACE_NONE;
           interlace_type < PNG_INTERLACE_LAST; ++interlace_type)
      {
         unsigned int test;
         char name[FILE_NAME_SIZE];

3959 3960
         standard_name(name, sizeof name, 0, colour_type, 1<<bdlo, 0,
            interlace_type, 0, 0, 0);
3961 3962

         for (test=0; test<(sizeof error_test)/(sizeof error_test[0]); ++test)
3963
         {
3964 3965
            make_error(&pm->this, colour_type, DEPTH(bdlo), interlace_type,
               test, name);
3966

3967 3968
            if (fail(pm))
               return 0;
3969 3970
         }
      }
3971 3972 3973
   }

   return 1; /* keep going */
3974
}
3975
#endif
3976 3977 3978 3979

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

3984
   if (!make_errors(pm, 0, 0, WRITE_BDHI))
3985 3986
      return;

3987
   if (!make_errors(pm, 2, 3, WRITE_BDHI))
3988 3989
      return;

3990
   if (!make_errors(pm, 3, 0, 3))
3991 3992
      return;

3993
   if (!make_errors(pm, 4, 3, WRITE_BDHI))
3994 3995
      return;

3996
   if (!make_errors(pm, 6, 3, WRITE_BDHI))
3997
      return;
3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018
#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;
4019 4020 4021
#     if PNG_LIBPNG_VER >= 10600
         char timestring[29];
#     endif
4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038
      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 */

4039 4040 4041 4042 4043 4044 4045 4046 4047
#     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
4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075

      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
4076 4077
}

4078
#ifdef PNG_READ_SUPPORTED
4079 4080 4081 4082 4083 4084
/* 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.
 *
4085
 * The technique adopted is to reinvent part of what Dijkstra termed a
4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100
 * '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
4101
 * nested functions!
4102 4103 4104 4105 4106 4107
 */
typedef struct standard_display
{
   png_store*  ps;             /* Test parameters (passed to the function) */
   png_byte    colour_type;
   png_byte    bit_depth;
4108 4109 4110 4111
   png_byte    red_sBIT;       /* Input data sBIT values. */
   png_byte    green_sBIT;
   png_byte    blue_sBIT;
   png_byte    alpha_sBIT;
4112 4113 4114 4115 4116
   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 */
4117 4118 4119 4120
   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 */
4121 4122
   int         is_transparent; /* Transparency information was present. */
   int         speed;          /* Doing a speed test */
4123
   int         use_update_info;/* Call update_info, not start_image */
4124 4125 4126 4127 4128 4129
   struct
   {
      png_uint_16 red;
      png_uint_16 green;
      png_uint_16 blue;
   }           transparent;    /* The transparent color, if set. */
4130 4131
   int         npalette;       /* Number of entries in the palette. */
   store_palette
4132
               palette;
4133 4134
} standard_display;

4135
static void
4136
standard_display_init(standard_display *dp, png_store* ps, png_uint_32 id,
4137
   int do_interlace, int use_update_info)
4138
{
4139 4140
   memset(dp, 0, sizeof *dp);

4141
   dp->ps = ps;
4142 4143
   dp->colour_type = COL_FROM_ID(id);
   dp->bit_depth = DEPTH_FROM_ID(id);
4144 4145
   if (dp->bit_depth < 1 || dp->bit_depth > 16)
      internal_error(ps, "internal: bad bit depth");
4146 4147 4148 4149 4150
   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;
4151 4152 4153
   dp->interlace_type = INTERLACE_FROM_ID(id);
   dp->id = id;
   /* All the rest are filled in after the read_info: */
4154 4155 4156
   dp->w = 0;
   dp->h = 0;
   dp->npasses = 0;
4157 4158
   dp->pixel_size = 0;
   dp->bit_width = 0;
4159
   dp->cbRow = 0;
4160
   dp->do_interlace = do_interlace;
4161
   dp->is_transparent = 0;
4162
   dp->speed = ps->speed;
4163
   dp->use_update_info = use_update_info;
4164
   dp->npalette = 0;
4165 4166 4167 4168
   /* 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);
4169 4170
}

4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204
/* 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.)
4205 4206
 */
static int
4207 4208
read_palette(store_palette palette, int *npalette, png_const_structp pp,
   png_infop pi)
4209 4210 4211 4212 4213 4214
{
   png_colorp pal;
   png_bytep trans_alpha;
   int num;

   pal = 0;
4215 4216 4217
   *npalette = -1;

   if (png_get_PLTE(pp, pi, &pal, npalette) & PNG_INFO_PLTE)
4218
   {
4219
      int i = *npalette;
4220

4221 4222 4223 4224
      if (i <= 0 || i > 256)
         png_error(pp, "validate: invalid PLTE count");

      while (--i >= 0)
4225 4226 4227 4228 4229 4230
      {
         palette[i].red = pal[i].red;
         palette[i].green = pal[i].green;
         palette[i].blue = pal[i].blue;
      }

4231 4232 4233 4234
      /* 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);
4235 4236 4237
   }

   else /* !png_get_PLTE */
4238 4239 4240 4241 4242
   {
      if (*npalette != (-1))
         png_error(pp, "validate: invalid PLTE result");
      /* But there is no palette, so record this: */
      *npalette = 0;
4243
      memset(palette, 113, sizeof (store_palette));
4244
   }
4245 4246

   trans_alpha = 0;
4247 4248 4249 4250
   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
4251 4252
       * 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
4253 4254 4255
       * to) and we get num_trans == 0:
       */
      !(trans_alpha != NULL && num == 0)) /* TODO: fix this in libpng. */
4256 4257 4258 4259 4260 4261 4262 4263 4264
   {
      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.
       */
4265
      if (trans_alpha == NULL || num <= 0 || num > 256 || num > *npalette)
4266 4267 4268 4269 4270
         png_error(pp, "validate: unexpected png_get_tRNS (palette) result");

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

4271
      for (num=*npalette; i<num; ++i)
4272 4273
         palette[i].alpha = 255;

4274 4275 4276
      for (; i<256; ++i)
         palette[i].alpha = 33; /* flag value */

4277 4278 4279 4280 4281
      return 1; /* transparency */
   }

   else
   {
4282
      /* No palette transparency - just set the alpha channel to opaque. */
4283 4284
      int i;

4285
      for (i=0, num=*npalette; i<num; ++i)
4286 4287
         palette[i].alpha = 255;

4288 4289 4290
      for (; i<256; ++i)
         palette[i].alpha = 55; /* flag value */

4291 4292 4293 4294
      return 0; /* no transparency */
   }
}

4295 4296 4297 4298
/* Utility to validate the palette if it should not have changed (the
 * non-transform case).
 */
static void
4299 4300
standard_palette_validate(standard_display *dp, png_const_structp pp,
   png_infop pi)
4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331
{
   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");
   }
}

4332
/* By passing a 'standard_display' the progressive callbacks can be used
4333
 * directly by the sequential code, the functions suffixed "_imp" are the
4334 4335 4336 4337 4338 4339 4340 4341
 * 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)
4342
{
4343
   if (png_get_bit_depth(pp, pi) != dp->bit_depth)
4344 4345
      png_error(pp, "validate: bit depth changed");

4346
   if (png_get_color_type(pp, pi) != dp->colour_type)
4347 4348 4349 4350 4351
      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");

4352
   if (png_get_interlace_type(pp, pi) != dp->interlace_type)
4353 4354 4355 4356 4357
      png_error(pp, "validate: interlacing changed");

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

4358 4359
   dp->w = png_get_image_width(pp, pi);

4360
   if (dp->w != standard_width(pp, dp->id))
4361 4362 4363 4364
      png_error(pp, "validate: image width changed");

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

4365
   if (dp->h != standard_height(pp, dp->id))
4366 4367
      png_error(pp, "validate: image height changed");

4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422
   /* 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");
      }
   }

4423 4424
   /* 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
4425
    * no transforms, but it does for other tests where rowbytes may change after
4426 4427
    * png_read_update_info.
    */
4428
   if (png_get_rowbytes(pp, pi) != standard_rowsize(pp, dp->id))
4429 4430
      png_error(pp, "validate: row size changed");

4431 4432
   /* Validate the colour type 3 palette (this can be present on other color
    * types.)
4433
    */
4434
   standard_palette_validate(dp, pp, pi);
4435

4436 4437 4438 4439
   /* 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!)
    */
4440 4441 4442 4443 4444 4445 4446 4447 4448 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
   {
      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");
         }
      }
4474 4475 4476 4477
   }

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

4484 4485 4486
   /* Caller calls png_read_update_info or png_start_read_image now, then calls
    * part2.
    */
4487 4488
}

4489 4490 4491 4492
/* 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.
 */
4493
static void
4494 4495
standard_info_part2(standard_display *dp, png_const_structp pp,
    png_const_infop pi, int nImages)
4496
{
4497
   /* Record cbRow now that it can be found. */
4498 4499 4500
   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;
4501
   dp->cbRow = png_get_rowbytes(pp, pi);
4502

4503 4504 4505 4506
   /* Validate the rowbytes here again. */
   if (dp->cbRow != (dp->bit_width+7)/8)
      png_error(pp, "bad png_get_rowbytes calculation");

4507
   /* Then ensure there is enough space for the output image(s). */
4508
   store_ensure_image(dp->ps, pp, nImages, dp->cbRow, dp->h);
4509 4510 4511
}

static void
4512 4513
standard_info_imp(standard_display *dp, png_structp pp, png_infop pi,
    int nImages)
4514 4515 4516 4517
{
   /* Note that the validation routine has the side effect of turning on
    * interlace handling in the subsequent code.
    */
4518
   standard_info_part1(dp, pp, pi);
4519 4520 4521 4522

   /* And the info callback has to call this (or png_read_update_info - see
    * below in the png_modifier code for that variant.
    */
4523 4524 4525 4526 4527 4528 4529 4530 4531 4532
   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);
4533 4534 4535 4536

   /* Validate the height, width and rowbytes plus ensure that sufficient buffer
    * exists for decoding the image.
    */
4537 4538 4539 4540 4541 4542
   standard_info_part2(dp, pp, pi, nImages);
}

static void
standard_info(png_structp pp, png_infop pi)
{
4543 4544
   standard_display *dp = voidcast(standard_display*,
      png_get_progressive_ptr(pp));
4545 4546 4547 4548

   /* Call with nImages==1 because the progressive reader can only produce one
    * image.
    */
4549
   standard_info_imp(dp, pp, pi, 1 /*only one image*/);
4550 4551 4552
}

static void
4553
progressive_row(png_structp ppIn, png_bytep new_row, png_uint_32 y, int pass)
4554
{
4555
   png_const_structp pp = ppIn;
4556 4557
   PNG_CONST standard_display *dp = voidcast(standard_display*,
      png_get_progressive_ptr(pp));
4558 4559

   /* When handling interlacing some rows will be absent in each pass, the
4560 4561 4562
    * 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.
4563 4564 4565
    */
   if (new_row != NULL)
   {
4566 4567 4568 4569 4570 4571
      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)
4572
      {
4573
#ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED
4574 4575 4576 4577
         /* 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");

4578 4579
         if (pass != png_get_current_pass_number(pp))
            png_error(pp, "png_get_current_pass_number is broken");
4580
#endif
4581

4582
         y = PNG_ROW_FROM_PASS_ROW(y, pass);
4583
      }
4584 4585 4586 4587 4588

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

4589
      row = store_image_row(dp->ps, pp, 0, y);
4590

4591
#ifdef PNG_READ_INTERLACING_SUPPORTED
4592
      /* Combine the new row into the old: */
4593 4594 4595 4596 4597
      if (dp->do_interlace)
      {
         if (dp->interlace_type == PNG_INTERLACE_ADAM7)
            deinterlace_row(row, new_row, dp->pixel_size, dp->w, pass);
         else
4598
            row_copy(row, new_row, dp->pixel_size * dp->w);
4599 4600 4601 4602 4603 4604 4605
      }
      else
         png_progressive_combine_row(pp, row, new_row);
   } else if (dp->interlace_type == PNG_INTERLACE_ADAM7 &&
      PNG_ROW_IN_INTERLACE_PASS(y, pass) &&
      PNG_PASS_COLS(dp->w, pass) > 0)
      png_error(pp, "missing row in progressive de-interlacing");
4606
#endif /* PNG_READ_INTERLACING_SUPPORTED */
4607 4608
}

4609 4610
static void
sequential_row(standard_display *dp, png_structp pp, png_infop pi,
4611
    PNG_CONST int iImage, PNG_CONST int iDisplay)
4612 4613
{
   PNG_CONST int         npasses = dp->npasses;
4614 4615 4616 4617
   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);
4618
   PNG_CONST png_store*  ps = dp->ps;
4619 4620
   int pass;

4621
   for (pass=0; pass<npasses; ++pass)
4622 4623
   {
      png_uint_32 y;
4624
      png_uint_32 wPass = PNG_PASS_COLS(width, pass);
4625

4626
      for (y=0; y<height; ++y)
4627
      {
4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641
         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
4642 4643 4644
                * 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).
4645
                */
4646 4647
               memset(row, 0xc5, sizeof row);
               memset(display, 0x5c, sizeof display);
4648 4649 4650

               png_read_row(pp, row, display);

4651 4652 4653
               if (iImage >= 0)
                  deinterlace_row(store_image_row(ps, pp, iImage, y), row,
                     dp->pixel_size, dp->w, pass);
4654

4655 4656 4657
               if (iDisplay >= 0)
                  deinterlace_row(store_image_row(ps, pp, iDisplay, y), display,
                     dp->pixel_size, dp->w, pass);
4658 4659 4660
            }
         }
         else
4661 4662 4663
            png_read_row(pp,
               iImage >= 0 ? store_image_row(ps, pp, iImage, y) : NULL,
               iDisplay >= 0 ? store_image_row(ps, pp, iDisplay, y) : NULL);
4664 4665 4666 4667 4668 4669 4670 4671 4672
      }
   }

   /* 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);
}

4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685
#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;

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

4690
      sprintf(buf, "compression [%d->%d], ", TEXT_COMPRESSION,
4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715
         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];
4716 4717
         sprintf(buf, "text length changed[%lu->%lu], ",
            (unsigned long)strlen(text), (unsigned long)tp->text_length);
4718 4719 4720 4721 4722 4723 4724 4725 4726
         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);
4727
         pos = safecat(msg, sizeof msg, pos, "\"), ");
4728 4729 4730 4731 4732
      }
   }

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

4734 4735 4736 4737 4738 4739
   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, "\", ");
   }
4740

4741 4742 4743 4744 4745 4746
   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, "\", ");
   }
4747

4748 4749 4750 4751 4752 4753 4754 4755 4756
   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,
4757
   png_infop pi)
4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780
{
   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);
      standard_check_text(pp, tp+1, "end marker", "end");
   }

   else
   {
      char msg[64];

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

4781
static void
4782
standard_row_validate(standard_display *dp, png_const_structp pp,
4783
   int iImage, int iDisplay, png_uint_32 y)
4784
{
4785
   int where;
4786 4787
   png_byte std[STANDARD_ROWMAX];

4788 4789 4790 4791
   /* The row must be pre-initialized to the magic number here for the size
    * tests to pass:
    */
   memset(std, 178, sizeof std);
4792 4793 4794 4795 4796 4797
   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.
4798
#if PNG_LIBPNG_VER < 10506
4799 4800 4801 4802 4803 4804
    * 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.
4805
#endif
4806
    */
4807 4808 4809
   if (iImage >= 0 &&
      (where = pixel_cmp(std, store_image_row(dp->ps, pp, iImage, y),
            dp->bit_width)) != 0)
4810 4811
   {
      char msg[64];
4812 4813
      sprintf(msg, "PNG image row[%lu][%d] changed from %.2x to %.2x",
         (unsigned long)y, where-1, std[where-1],
4814
         store_image_row(dp->ps, pp, iImage, y)[where-1]);
4815 4816 4817
      png_error(pp, msg);
   }

4818
#if PNG_LIBPNG_VER < 10506
4819 4820
   /* 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
4821 4822
    * of 8 bits wide.  (This is fixed in libpng-1.5.6 and pixel_cmp is
    * changed to match!)
4823
    */
4824
#endif
4825 4826 4827
   if (iDisplay >= 0 &&
      (where = pixel_cmp(std, store_image_row(dp->ps, pp, iDisplay, y),
         dp->bit_width)) != 0)
4828 4829
   {
      char msg[64];
4830 4831
      sprintf(msg, "display  row[%lu][%d] changed from %.2x to %.2x",
         (unsigned long)y, where-1, std[where-1],
4832
         store_image_row(dp->ps, pp, iDisplay, y)[where-1]);
4833 4834 4835 4836 4837
      png_error(pp, msg);
   }
}

static void
4838
standard_image_validate(standard_display *dp, png_const_structp pp, int iImage,
4839
    int iDisplay)
4840 4841 4842
{
   png_uint_32 y;

4843 4844
   if (iImage >= 0)
      store_image_check(dp->ps, pp, iImage);
4845

4846 4847
   if (iDisplay >= 0)
      store_image_check(dp->ps, pp, iDisplay);
4848

4849 4850
   for (y=0; y<dp->h; ++y)
      standard_row_validate(dp, pp, iImage, iDisplay, y);
4851 4852

   /* This avoids false positives if the validation code is never called! */
4853
   dp->ps->validated = 1;
4854 4855 4856
}

static void
4857
standard_end(png_structp ppIn, png_infop pi)
4858
{
4859
   png_const_structp pp = ppIn;
4860 4861
   standard_display *dp = voidcast(standard_display*,
      png_get_progressive_ptr(pp));
4862

4863
   UNUSED(pi)
4864 4865 4866 4867

   /* Validate the image - progressive reading only produces one variant for
    * interlaced images.
    */
4868
   standard_text_validate(dp, pp, pi);
4869
   standard_image_validate(dp, pp, 0, -1);
4870 4871
}

4872
/* A single test run checking the standard image to ensure it is not damaged. */
G
[devel]  
Glenn Randers-Pehrson 已提交
4873
static void
4874
standard_test(png_store* PNG_CONST psIn, png_uint_32 PNG_CONST id,
4875
   int do_interlace, int use_update_info)
G
[devel]  
Glenn Randers-Pehrson 已提交
4876
{
4877 4878 4879 4880 4881 4882
   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.
    */
4883
   standard_display_init(&d, psIn, id, do_interlace, use_update_info);
4884

4885 4886 4887
   /* Everything is protected by a Try/Catch.  The functions called also
    * typically have local Try/Catch blocks.
    */
4888 4889
   Try
   {
4890 4891 4892
      png_structp pp;
      png_infop pi;

4893
      /* Get a png_struct for reading the image. This will throw an error if it
4894 4895
       * fails, so we don't need to check the result.
       */
4896
      pp = set_store_for_read(d.ps, &pi, d.id,
4897 4898 4899 4900
         d.do_interlace ?  (d.ps->progressive ?
            "pngvalid progressive deinterlacer" :
            "pngvalid sequential deinterlacer") : (d.ps->progressive ?
               "progressive reader" : "sequential reader"));
G
[devel]  
Glenn Randers-Pehrson 已提交
4901

4902 4903 4904
      /* Initialize the palette correctly from the png_store_file. */
      standard_palette_init(&d);

4905
      /* Introduce the correct read function. */
4906
      if (d.ps->progressive)
4907
      {
4908 4909
         png_set_progressive_read_fn(pp, &d, standard_info, progressive_row,
            standard_end);
4910

4911
         /* Now feed data into the reader until we reach the end: */
4912
         store_progressive_read(d.ps, pp, pi);
4913
      }
4914 4915
      else
      {
4916 4917
         /* Note that this takes the store, not the display. */
         png_set_read_fn(pp, d.ps, store_read);
4918

4919 4920
         /* Check the header values: */
         png_read_info(pp, pi);
4921

4922 4923 4924
         /* The code tests both versions of the images that the sequential
          * reader can produce.
          */
4925
         standard_info_imp(&d, pp, pi, 2 /*images*/);
4926

4927
         /* Need the total bytes in the image below; we can't get to this point
4928 4929 4930
          * unless the PNG file values have been checked against the expected
          * values.
          */
4931
         {
4932
            sequential_row(&d, pp, pi, 0, 1);
4933 4934 4935 4936

            /* After the last pass loop over the rows again to check that the
             * image is correct.
             */
4937
            if (!d.speed)
4938 4939
            {
               standard_text_validate(&d, pp, pi);
4940
               standard_image_validate(&d, pp, 0, 1);
4941
            }
4942 4943
            else
               d.ps->validated = 1;
4944
         }
4945
      }
4946

4947
      /* Check for validation. */
4948
      if (!d.ps->validated)
4949
         png_error(pp, "image read failed silently");
4950

4951
      /* Successful completion. */
4952
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
4953

4954
   Catch(fault)
4955 4956 4957 4958
      d.ps = fault; /* make sure this hasn't been clobbered. */

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

4961 4962
static int
test_standard(png_modifier* PNG_CONST pm, png_byte PNG_CONST colour_type,
4963
    int bdlo, int PNG_CONST bdhi)
4964 4965 4966
{
   for (; bdlo <= bdhi; ++bdlo)
   {
4967
      int interlace_type;
4968

4969 4970 4971
      for (interlace_type = PNG_INTERLACE_NONE;
           interlace_type < PNG_INTERLACE_LAST; ++interlace_type)
      {
4972
         standard_test(&pm->this, FILEID(colour_type, DEPTH(bdlo), 0/*palette*/,
4973
            interlace_type, 0, 0, 0), 0/*do_interlace*/, pm->use_update_info);
4974 4975 4976 4977

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

4980
   return 1; /* keep going */
G
[devel]  
Glenn Randers-Pehrson 已提交
4981 4982 4983 4984 4985
}

static void
perform_standard_test(png_modifier *pm)
{
4986 4987 4988
   /* 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.
    */
4989
   if (!test_standard(pm, 0, 0, READ_BDHI))
4990 4991
      return;

4992
   if (!test_standard(pm, 2, 3, READ_BDHI))
4993 4994
      return;

4995
   if (!test_standard(pm, 3, 0, 3))
4996 4997
      return;

4998
   if (!test_standard(pm, 4, 3, READ_BDHI))
4999 5000
      return;

5001
   if (!test_standard(pm, 6, 3, READ_BDHI))
5002
      return;
G
[devel]  
Glenn Randers-Pehrson 已提交
5003 5004 5005
}


5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030
/********************************** 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.
          */
5031
         standard_test(&pm->this, FILEID(colour_type, DEPTH(bdlo), 0/*palette*/,
5032 5033
            PNG_INTERLACE_NONE, w, h, 0), 0/*do_interlace*/,
            pm->use_update_info);
5034 5035 5036 5037

         if (fail(pm))
            return 0;

5038
         standard_test(&pm->this, FILEID(colour_type, DEPTH(bdlo), 0/*palette*/,
5039 5040
            PNG_INTERLACE_NONE, w, h, 1), 0/*do_interlace*/,
            pm->use_update_info);
5041 5042 5043 5044

         if (fail(pm))
            return 0;

5045
         standard_test(&pm->this, FILEID(colour_type, DEPTH(bdlo), 0/*palette*/,
5046 5047
            PNG_INTERLACE_ADAM7, w, h, 0), 0/*do_interlace*/,
            pm->use_update_info);
5048 5049 5050 5051

         if (fail(pm))
            return 0;

5052
         standard_test(&pm->this, FILEID(colour_type, DEPTH(bdlo), 0/*palette*/,
5053 5054
            PNG_INTERLACE_ADAM7, w, h, 1), 0/*do_interlace*/,
            pm->use_update_info);
5055 5056 5057 5058 5059 5060 5061 5062

         if (fail(pm))
            return 0;

         /* 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.
          */
5063
         standard_test(&pm->this, FILEID(colour_type, DEPTH(bdlo), 0/*palette*/,
5064 5065
            PNG_INTERLACE_NONE, w, h, 0), 1/*do_interlace*/,
            pm->use_update_info);
5066 5067 5068 5069

         if (fail(pm))
            return 0;

5070
         standard_test(&pm->this, FILEID(colour_type, DEPTH(bdlo), 0/*palette*/,
5071 5072
            PNG_INTERLACE_ADAM7, w, h, 0), 1/*do_interlace*/,
            pm->use_update_info);
5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094

         if (fail(pm))
            return 0;
      }
   }

   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
5095
    * compared to the grayscale test.
5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109
    */
#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;
}


5110
/******************************* TRANSFORM TESTS ******************************/
5111
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
5112 5113 5114 5115 5116 5117
/* 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 已提交
5118
{
5119 5120 5121 5122 5123 5124
   /* 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. */
5125 5126
   png_byte bit_depth;                   /* Defines bit size in row */
   png_byte sample_depth;                /* Scale of samples */
5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139
   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 已提交
5140

5141 5142 5143
/* Shared utility function, see below. */
static void
image_pixel_setf(image_pixel *this, unsigned int max)
G
[devel]  
Glenn Randers-Pehrson 已提交
5144
{
5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165
   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 已提交
5166 5167
}

5168 5169 5170 5171
/* 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 已提交
5172
static void
5173
image_pixel_init(image_pixel *this, png_const_bytep row, png_byte colour_type,
5174
    png_byte bit_depth, png_uint_32 x, store_palette palette)
G
[devel]  
Glenn Randers-Pehrson 已提交
5175
{
5176 5177 5178
   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 已提交
5179

5180 5181 5182 5183 5184 5185 5186 5187
   /* 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 =
5188 5189 5190 5191 5192 5193 5194 5195 5196
      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;
5197

5198 5199 5200 5201 5202 5203 5204 5205
         this->red = palette[i].red;
         this->green = palette[i].green;
         this->blue = palette[i].blue;
         this->alpha = palette[i].alpha;
      }
   }

   else /* not palette */
5206
   {
5207 5208 5209 5210 5211 5212 5213 5214 5215 5216
      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);
5217
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
5218

5219 5220 5221 5222 5223
   /* 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 已提交
5224

5225 5226 5227 5228 5229
   /* Store the input information for use in the transforms - these will
    * modify the information.
    */
   this->colour_type = colour_type;
   this->bit_depth = bit_depth;
5230
   this->sample_depth = sample_depth;
5231
   this->have_tRNS = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
5232 5233
}

5234
/* Convert a palette image to an rgb image.  This necessarily converts the tRNS
5235 5236 5237 5238 5239
 * 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.
5240
 */
G
[devel]  
Glenn Randers-Pehrson 已提交
5241
static void
5242
image_pixel_convert_PLTE(image_pixel *this)
G
[devel]  
Glenn Randers-Pehrson 已提交
5243
{
5244
   if (this->colour_type == PNG_COLOR_TYPE_PALETTE)
G
[devel]  
Glenn Randers-Pehrson 已提交
5245
   {
5246 5247 5248 5249 5250 5251 5252 5253
      if (this->have_tRNS)
      {
         this->colour_type = PNG_COLOR_TYPE_RGB_ALPHA;
         this->have_tRNS = 0;
      }
      else
         this->colour_type = PNG_COLOR_TYPE_RGB;

5254 5255
      /* 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.)
5256
       */
5257
      this->bit_depth = 8;
5258
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
5259 5260
}

5261
/* Add an alpha channel; this will import the tRNS information because tRNS is
5262 5263 5264 5265
 * 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
5266
image_pixel_add_alpha(image_pixel *this, PNG_CONST standard_display *display)
G
[devel]  
Glenn Randers-Pehrson 已提交
5267
{
5268
   if (this->colour_type == PNG_COLOR_TYPE_PALETTE)
5269
      image_pixel_convert_PLTE(this);
G
[devel]  
Glenn Randers-Pehrson 已提交
5270

5271
   if ((this->colour_type & PNG_COLOR_MASK_ALPHA) == 0)
G
[devel]  
Glenn Randers-Pehrson 已提交
5272
   {
5273
      if (this->colour_type == PNG_COLOR_TYPE_GRAY)
G
[devel]  
Glenn Randers-Pehrson 已提交
5274
      {
5275 5276
         if (this->bit_depth < 8)
            this->bit_depth = 8;
5277

5278 5279 5280
         if (this->have_tRNS)
         {
            this->have_tRNS = 0;
5281

5282 5283 5284 5285 5286 5287 5288 5289 5290 5291
            /* 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;
5292

5293
         this->colour_type = PNG_COLOR_TYPE_GRAY_ALPHA;
G
[devel]  
Glenn Randers-Pehrson 已提交
5294 5295
      }

5296 5297 5298 5299 5300
      else if (this->colour_type == PNG_COLOR_TYPE_RGB)
      {
         if (this->have_tRNS)
         {
            this->have_tRNS = 0;
5301

5302 5303 5304 5305 5306 5307 5308 5309 5310
            /* 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 已提交
5311

5312 5313 5314 5315 5316 5317 5318 5319 5320
            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 已提交
5321 5322 5323
   }
}

5324 5325
struct transform_display;
typedef struct image_transform
G
[devel]  
Glenn Randers-Pehrson 已提交
5326
{
5327 5328 5329 5330 5331 5332
   /* The name of this transform: a string. */
   PNG_CONST char *name;

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

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

5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351
   /* 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.
    *
5352 5353 5354 5355 5356 5357 5358
    * 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:
5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369
    */
   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,
5370
      png_const_structp pp, PNG_CONST struct transform_display *display);
5371 5372 5373 5374 5375 5376 5377

   /* 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,
5378
      PNG_CONST struct image_transform **that, png_byte colour_type,
5379 5380 5381 5382
      png_byte bit_depth);
} image_transform;

typedef struct transform_display
5383 5384 5385 5386
{
   standard_display this;

   /* Parameters */
5387 5388
   png_modifier*              pm;
   PNG_CONST image_transform* transform_list;
5389 5390

   /* Local variables */
5391 5392
   png_byte output_colour_type;
   png_byte output_bit_depth;
5393

5394 5395 5396 5397
   /* Modifications (not necessarily used.) */
   gama_modification gama_mod;
   chrm_modification chrm_mod;
   srgb_modification srgb_mod;
5398
} transform_display;
5399

5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435
/* 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 已提交
5436
static void
5437 5438
image_transform_set_end(PNG_CONST image_transform *this,
   transform_display *that, png_structp pp, png_infop pi)
G
[devel]  
Glenn Randers-Pehrson 已提交
5439
{
5440 5441 5442 5443
   UNUSED(this)
   UNUSED(that)
   UNUSED(pp)
   UNUSED(pi)
5444
}
5445

5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464
/* 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,
5465
    png_const_structp pp, PNG_CONST transform_display *display)
5466
{
5467
   PNG_CONST unsigned int scale = (1U<<that->sample_depth)-1;
5468

5469 5470 5471
   UNUSED(this)
   UNUSED(pp)
   UNUSED(display)
5472

5473 5474 5475 5476
   /* 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
5477 5478 5479 5480 5481 5482 5483 5484 5485 5486
    * 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),
5487 5488 5489 5490
    * 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.
5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507
    */
   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;
   }

5508 5509
   if ((that->colour_type & PNG_COLOR_MASK_ALPHA) ||
      that->colour_type == PNG_COLOR_TYPE_PALETTE)
5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524
   {
      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 =
{
5525 5526
   "(end)", /* name */
   1, /* enable */
5527 5528 5529 5530
   0, /* list */
   0, /* global_use */
   0, /* local_use */
   0, /* next */
5531
   image_transform_ini_end,
5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543
   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)
{
5544
   memset(dp, 0, sizeof *dp);
5545

5546
   /* Standard fields */
5547
   standard_display_init(&dp->this, &pm->this, id, 0/*do_interlace*/,
5548
      pm->use_update_info);
5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568

   /* 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: */
5569 5570 5571 5572 5573 5574 5575
   {
      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);
   }
5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625

   /* 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;
5626 5627 5628 5629
      if (test_pixel.colour_type == PNG_COLOR_TYPE_PALETTE)
         test_pixel.sample_depth = 8;
      else
         test_pixel.sample_depth = test_pixel.bit_depth;
5630 5631 5632
      /* Don't need sBIT here, but it must be set to non-zero to avoid
       * arithmetic overflows.
       */
5633
      test_pixel.have_tRNS = dp->this.is_transparent;
5634 5635
      test_pixel.red_sBIT = test_pixel.green_sBIT = test_pixel.blue_sBIT =
         test_pixel.alpha_sBIT = test_pixel.sample_depth;
5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661

      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);
      }
5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682

      /* 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);
      }
5683 5684 5685 5686 5687 5688
   }
}

static void
transform_info(png_structp pp, png_infop pi)
{
5689 5690
   transform_info_imp(voidcast(transform_display*, png_get_progressive_ptr(pp)),
      pp, pi);
5691 5692 5693
}

static void
5694
transform_range_check(png_const_structp pp, unsigned int r, unsigned int g,
5695
   unsigned int b, unsigned int a, unsigned int in_digitized, double in,
5696 5697
   unsigned int out, png_byte sample_depth, double err, double limit,
   PNG_CONST char *name, double digitization_error)
5698 5699 5700 5701
{
   /* 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
5702
    * palette images where it is always 8.)  The check on 'err' is to detect
5703
    * internal errors in pngvalid itself.
5704 5705
    */
   unsigned int max = (1U<<sample_depth)-1;
5706 5707
   double in_min = ceil((in-err)*max - digitization_error);
   double in_max = floor((in+err)*max + digitization_error);
5708
   if (err > limit || !(out >= in_min && out <= in_max))
5709
   {
5710
      char message[256];
5711 5712 5713
      size_t pos;

      pos = safecat(message, sizeof message, 0, name);
5714 5715 5716 5717 5718 5719 5720 5721 5722 5723
      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);
5724
      pos = safecat(message, sizeof message, pos, " expected: ");
5725 5726 5727
      pos = safecatn(message, sizeof message, pos, in_digitized);
      pos = safecat(message, sizeof message, pos, " (");
      pos = safecatd(message, sizeof message, pos, (in-err)*max, 3);
5728
      pos = safecat(message, sizeof message, pos, "..");
5729 5730
      pos = safecatd(message, sizeof message, pos, (in+err)*max, 3);
      pos = safecat(message, sizeof message, pos, ")");
5731 5732 5733 5734 5735 5736

      png_error(pp, message);
   }
}

static void
5737 5738
transform_image_validate(transform_display *dp, png_const_structp pp,
   png_infop pi)
5739 5740
{
   /* Constants for the loop below: */
5741
   PNG_CONST png_store* PNG_CONST ps = dp->this.ps;
5742 5743 5744 5745 5746 5747
   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;
5748 5749
   PNG_CONST png_byte sample_depth = (png_byte)(out_ct ==
      PNG_COLOR_TYPE_PALETTE ? 8 : out_bd);
5750 5751 5752 5753 5754
   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;
5755
   double digitization_error;
5756

5757
   store_palette out_palette;
5758 5759
   png_uint_32 y;

5760 5761
   UNUSED(pi)

5762 5763 5764
   /* Check for row overwrite errors */
   store_image_check(dp->this.ps, pp, 0);

5765 5766 5767 5768
   /* 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)
5769 5770 5771 5772 5773 5774 5775 5776 5777
   {
      /* 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");
5778 5779

      digitization_error = .5;
5780
   }
5781
   else
5782 5783 5784
   {
      png_byte in_sample_depth;

5785 5786
      memset(out_palette, 0x5e, sizeof out_palette);

5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808
      /* assume-8-bit-calculations 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.
       *
       * TODO: fix this in libpng; png_set_expand_16 should cause 16 bit
       * calculations to be used throughout.
       */
      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;

      /* Else errors are at 8 bit precision, scale .5 in 8 bits to the 16 bits:
       */
      else
         digitization_error = .5 * 257;
   }

5809
   for (y=0; y<h; ++y)
5810
   {
5811
      png_const_bytep PNG_CONST pRow = store_image_row(ps, pp, 0, y);
5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824
      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;
5825
         unsigned int r, g, b, a;
5826 5827

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

5830 5831 5832 5833 5834 5835
         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;

5836 5837 5838 5839 5840 5841
         /* For error detection, below. */
         r = in_pixel.red;
         g = in_pixel.green;
         b = in_pixel.blue;
         a = in_pixel.alpha;

5842 5843 5844
         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
5845
          * use the error field here, so no need to update sBIT.
5846
          */
5847
         image_pixel_init(&out_pixel, pRow, out_ct, out_bd, x, out_palette);
5848

5849 5850 5851 5852 5853
         /* 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)
5854 5855 5856 5857 5858
         {
            if (in_pixel.palette_index != out_pixel.palette_index)
               png_error(pp, "unexpected transformed palette index");
         }

5859 5860 5861 5862 5863
         /* 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,
5864 5865
               out_pixel.red, sample_depth, in_pixel.rede,
               dp->pm->limit + 1./(2*((1U<<in_pixel.red_sBIT)-1)), "red/gray",
5866
               digitization_error);
5867 5868 5869 5870 5871

         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,
5872 5873
               dp->pm->limit + 1./(2*((1U<<in_pixel.green_sBIT)-1)), "green",
               digitization_error);
5874 5875 5876 5877

         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,
5878 5879
               out_pixel.blue, sample_depth, in_pixel.bluee,
               dp->pm->limit + 1./(2*((1U<<in_pixel.blue_sBIT)-1)), "blue",
5880
               digitization_error);
5881 5882 5883 5884 5885

         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,
5886 5887
               dp->pm->limit + 1./(2*((1U<<in_pixel.alpha_sBIT)-1)), "alpha",
               digitization_error);
5888 5889 5890 5891 5892 5893 5894 5895
      } /* pixel (x) loop */
   } /* row (y) loop */

   /* Record that something was actually checked to avoid a false positive. */
   dp->this.ps->validated = 1;
}

static void
5896
transform_end(png_structp ppIn, png_infop pi)
5897
{
5898
   png_const_structp pp = ppIn;
5899 5900
   transform_display *dp = voidcast(transform_display*,
      png_get_progressive_ptr(pp));
5901

5902 5903 5904 5905
   if (!dp->this.speed)
      transform_image_validate(dp, pp, pi);
   else
      dp->this.ps->validated = 1;
5906 5907 5908 5909 5910
}

/* A single test run. */
static void
transform_test(png_modifier *pmIn, PNG_CONST png_uint_32 idIn,
5911
    PNG_CONST image_transform* transform_listIn, PNG_CONST char * volatile name)
5912 5913 5914 5915 5916 5917 5918 5919
{
   transform_display d;
   context(&pmIn->this, fault);

   transform_display_init(&d, pmIn, idIn, transform_listIn);

   Try
   {
5920
      size_t pos = 0;
5921 5922
      png_structp pp;
      png_infop pi;
5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935
      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);
5936

5937
      /* Get a png_struct for reading the image. */
5938
      pp = set_modifier_for_read(d.pm, &pi, d.this.id, full_name);
5939
      standard_palette_init(&d.this);
5940

5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952
#     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

5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973
      /* 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);

5974
         sequential_row(&d.this, pp, pi, -1, 0);
5975

5976 5977
         if (!d.this.speed)
            transform_image_validate(&d, pp, pi);
5978 5979
         else
            d.this.ps->validated = 1;
5980 5981 5982 5983 5984 5985
      }

      modifier_reset(d.pm);
   }

   Catch(fault)
5986
   {
5987
      modifier_reset((png_modifier*)fault);
5988
   }
5989 5990 5991 5992
}

/* The transforms: */
#define ITSTRUCT(name) image_transform_##name
5993 5994
#define ITDATA(name) image_transform_data_##name
#define image_transform_ini image_transform_default_ini
5995
#define IT(name)\
5996 5997
static image_transform ITSTRUCT(name) =\
{\
5998 5999
   #name,\
   1, /*enable*/\
6000
   &PT, /*list*/\
6001 6002 6003
   0, /*global_use*/\
   0, /*local_use*/\
   0, /*next*/\
6004
   image_transform_ini,\
6005 6006 6007 6008
   image_transform_png_set_##name##_set,\
   image_transform_png_set_##name##_mod,\
   image_transform_png_set_##name##_add\
}
6009
#define PT ITSTRUCT(end) /* stores the previous transform */
6010

6011
/* To save code: */
6012 6013 6014 6015 6016 6017 6018
static void
image_transform_default_ini(PNG_CONST image_transform *this,
    transform_display *that)
{
   this->next->ini(this->next, that);
}

6019
#ifdef PNG_READ_BACKGROUND_SUPPORTED
6020
static int
6021 6022
image_transform_default_add(image_transform *this,
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
6023
{
6024 6025 6026
   UNUSED(colour_type)
   UNUSED(bit_depth)

6027 6028 6029
   this->next = *that;
   *that = this;

6030
   return 1;
6031
}
6032
#endif
6033

6034
#ifdef PNG_READ_EXPAND_SUPPORTED
6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045
/* 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,
6046 6047
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6048 6049
{
   if (that->colour_type == PNG_COLOR_TYPE_PALETTE)
6050
      image_pixel_convert_PLTE(that);
6051 6052 6053 6054 6055 6056

   this->next->mod(this->next, that, pp, display);
}

static int
image_transform_png_set_palette_to_rgb_add(image_transform *this,
6057
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
6058
{
6059
   UNUSED(bit_depth)
6060 6061 6062 6063 6064 6065 6066

   this->next = *that;
   *that = this;

   return colour_type == PNG_COLOR_TYPE_PALETTE;
}

6067 6068 6069 6070
IT(palette_to_rgb);
#undef PT
#define PT ITSTRUCT(palette_to_rgb)
#endif /* PNG_READ_EXPAND_SUPPORTED */
6071

6072
#ifdef PNG_READ_EXPAND_SUPPORTED
6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083
/* 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,
6084 6085
   image_pixel *that, png_const_structp pp,
   PNG_CONST transform_display *display)
6086
{
6087 6088
   /* LIBPNG BUG: this always forces palette images to RGB. */
   if (that->colour_type == PNG_COLOR_TYPE_PALETTE)
6089
      image_pixel_convert_PLTE(that);
6090

6091
   /* This effectively does an 'expand' only if there is some transparency to
6092
    * convert to an alpha channel.
6093 6094 6095 6096 6097
    */
   if (that->have_tRNS)
      image_pixel_add_alpha(that, &display->this);

   /* LIBPNG BUG: otherwise libpng still expands to 8 bits! */
6098 6099 6100 6101 6102 6103 6104
   else
   {
      if (that->bit_depth < 8)
         that->bit_depth =8;
      if (that->sample_depth < 8)
         that->sample_depth = 8;
   }
6105 6106 6107 6108 6109 6110

   this->next->mod(this->next, that, pp, display);
}

static int
image_transform_png_set_tRNS_to_alpha_add(image_transform *this,
6111
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
6112
{
6113
   UNUSED(bit_depth)
6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124

   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;
}

6125 6126 6127 6128
IT(tRNS_to_alpha);
#undef PT
#define PT ITSTRUCT(tRNS_to_alpha)
#endif /* PNG_READ_EXPAND_SUPPORTED */
6129

6130
#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141
/* 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,
6142 6143
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157
{
   /* 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)
6158
         that->sample_depth = that->bit_depth = 8;
6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173

      /* 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,
6174
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
6175
{
6176
   UNUSED(bit_depth)
6177 6178 6179 6180 6181 6182 6183

   this->next = *that;
   *that = this;

   return (colour_type & PNG_COLOR_MASK_COLOR) == 0;
}

6184 6185 6186 6187
IT(gray_to_rgb);
#undef PT
#define PT ITSTRUCT(gray_to_rgb)
#endif /* PNG_READ_GRAY_TO_RGB_SUPPORTED */
6188

6189
#ifdef PNG_READ_EXPAND_SUPPORTED
6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200
/* 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,
6201 6202
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6203 6204 6205
{
   /* The general expand case depends on what the colour type is: */
   if (that->colour_type == PNG_COLOR_TYPE_PALETTE)
6206
      image_pixel_convert_PLTE(that);
6207 6208
   else if (that->bit_depth < 8) /* grayscale */
      that->sample_depth = that->bit_depth = 8;
6209 6210 6211 6212 6213 6214 6215 6216 6217

   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,
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 6228 6229 6230

   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;
}

6231 6232 6233 6234
IT(expand);
#undef PT
#define PT ITSTRUCT(expand)
#endif /* PNG_READ_EXPAND_SUPPORTED */
6235

6236
#ifdef PNG_READ_EXPAND_SUPPORTED
6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250
/* 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(
6251
    PNG_CONST image_transform *this, image_pixel *that, png_const_structp pp,
6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264
    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);
}

6265 6266 6267 6268 6269 6270
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
6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281
/* 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,
6282 6283
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6284 6285 6286 6287 6288
{
   /* 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)
6289
      image_pixel_convert_PLTE(that);
6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312

   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;
}

6313 6314 6315 6316
IT(expand_16);
#undef PT
#define PT ITSTRUCT(expand_16)
#endif /* PNG_READ_EXPAND_16_SUPPORTED */
6317

6318
#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED  /* API added in 1.5.4 */
6319
/* png_set_scale_16 */
6320
static void
6321
image_transform_png_set_scale_16_set(PNG_CONST image_transform *this,
6322 6323
    transform_display *that, png_structp pp, png_infop pi)
{
6324
   png_set_scale_16(pp);
6325 6326 6327 6328
   this->next->set(this->next, that, pp, pi);
}

static void
6329
image_transform_png_set_scale_16_mod(PNG_CONST image_transform *this,
6330 6331
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6332 6333 6334
{
   if (that->bit_depth == 16)
   {
6335
      that->sample_depth = that->bit_depth = 8;
6336 6337 6338 6339 6340 6341 6342 6343 6344 6345
      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
6346
image_transform_png_set_scale_16_add(image_transform *this,
6347
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
6348
{
6349
   UNUSED(colour_type)
6350 6351 6352 6353 6354 6355 6356

   this->next = *that;
   *that = this;

   return bit_depth > 8;
}

6357
IT(scale_16);
6358
#undef PT
6359
#define PT ITSTRUCT(scale_16)
6360
#endif /* PNG_READ_SCALE_16_TO_8_SUPPORTED (1.5.4 on) */
6361

6362
#ifdef PNG_READ_16_TO_8_SUPPORTED /* the default before 1.5.4 */
6363
/* png_set_strip_16 */
6364
static void
6365
image_transform_png_set_strip_16_set(PNG_CONST image_transform *this,
6366 6367
    transform_display *that, png_structp pp, png_infop pi)
{
6368
   png_set_strip_16(pp);
6369 6370 6371 6372
   this->next->set(this->next, that, pp, pi);
}

static void
6373
image_transform_png_set_strip_16_mod(PNG_CONST image_transform *this,
6374 6375
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6376 6377 6378 6379 6380 6381 6382 6383 6384
{
   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;

6385 6386 6387
      /* 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.
6388
       */
6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406
#     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
6407 6408 6409 6410 6411 6412
   }

   this->next->mod(this->next, that, pp, display);
}

static int
6413
image_transform_png_set_strip_16_add(image_transform *this,
6414 6415 6416 6417 6418 6419 6420 6421 6422 6423
    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;
}

6424
IT(strip_16);
6425
#undef PT
6426
#define PT ITSTRUCT(strip_16)
6427
#endif /* PNG_READ_16_TO_8_SUPPORTED */
6428

6429
#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440
/* 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,
6441 6442
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6443 6444 6445 6446 6447 6448
{
   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;

6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604
   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;
   }
6605

6606 6607 6608 6609 6610
   else
   {
      data.red_to_set = -1;
      data.green_to_set = -1;
   }
6611

6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623
   /* 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)
      {
         /* The 16 bit case ends up producing a maximum error of about
          * +/-5 in 65535, allow for +/-8 with the given gamma.
          */
         that->pm->limit += pow(8./65535, data.gamma);
      }
6624

6625 6626 6627 6628 6629 6630 6631 6632 6633
      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.
          */
         that->pm->limit += pow(1./255, data.gamma);
      }
   }
6634

6635 6636 6637 6638 6639 6640 6641 6642
   else
   {
      /* With no gamma correction a large error comes from the truncation of the
       * calculation in the 8 bit case, allow for that here.
       */
      if (that->this.bit_depth != 16)
         that->pm->limit += 4E-3;
   }
6643 6644 6645 6646 6647 6648 6649 6650 6651
}

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
6652
      png_set_rgb_to_gray(pp, error_action, data.red_to_set, data.green_to_set);
6653
#  else
6654 6655
      png_set_rgb_to_gray_fixed(pp, error_action, data.red_to_set,
         data.green_to_set);
6656 6657
#  endif

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 6766 6767 6768
#  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 */

6769 6770 6771 6772 6773
   this->next->set(this->next, that, pp, pi);
}

static void
image_transform_png_set_rgb_to_gray_mod(PNG_CONST image_transform *this,
6774 6775
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
6776 6777 6778
{
   if ((that->colour_type & PNG_COLOR_MASK_COLOR) != 0)
   {
6779 6780
      double gray, err;

6781
      if (that->colour_type == PNG_COLOR_TYPE_PALETTE)
6782
         image_pixel_convert_PLTE(that);
6783 6784

      /* Image now has RGB channels... */
6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851
      {
         PNG_CONST png_modifier *pm = display->pm;
         PNG_CONST unsigned int sample_depth = that->sample_depth;
         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;
         rlo = digitize(pm, rlo, sample_depth, 1/*round*/);
         rhi += that->rede;
         rhi = digitize(pm, rhi, sample_depth, 1/*round*/);

         g = glo = ghi = that->greenf;
         glo -= that->greene;
         glo = digitize(pm, glo, sample_depth, 1/*round*/);
         ghi += that->greene;
         ghi = digitize(pm, ghi, sample_depth, 1/*round*/);

         b = blo = bhi = that->bluef;
         blo -= that->bluee;
         blo = digitize(pm, blo, sample_depth, 1/*round*/);
         bhi += that->greene;
         bhi = digitize(pm, bhi, sample_depth, 1/*round*/);

         isgray = r==g && g==b;

         if (data.gamma != 1)
         {
            PNG_CONST double power = 1/data.gamma;
            PNG_CONST double abse = abserr(pm, sample_depth, sample_depth);

            /* '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);
            rlo = digitize(pm, pow(rlo, power)-abse, sample_depth, 1);
            rhi = digitize(pm, pow(rhi, power)+abse, sample_depth, 1);

            g = pow(g, power);
            glo = digitize(pm, pow(glo, power)-abse, sample_depth, 1);
            ghi = digitize(pm, pow(ghi, power)+abse, sample_depth, 1);

            b = pow(b, power);
            blo = digitize(pm, pow(blo, power)-abse, sample_depth, 1);
            bhi = digitize(pm, pow(bhi, power)+abse, sample_depth, 1);
         }

         /* 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.
          *
6852
          * The only time when rounding doesn't occur in 1.5.5 and later is when
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
          * 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;

         {
            PNG_CONST int do_round = data.gamma != 1 || sample_depth == 16;
            PNG_CONST double ce = 1. / 32768;

            graylo = digitize(pm, rlo * (data.red_coefficient-ce) +
               glo * (data.green_coefficient-ce) +
               blo * (data.blue_coefficient-ce), sample_depth, do_round);
            if (graylo <= 0)
               graylo = 0;

            grayhi = digitize(pm, rhi * (data.red_coefficient+ce) +
               ghi * (data.green_coefficient+ce) +
               bhi * (data.blue_coefficient+ce), sample_depth, do_round);
            if (grayhi >= 1)
               grayhi = 1;
         }

         /* And invert the gamma. */
         if (data.gamma != 1)
         {
            PNG_CONST double power = data.gamma;

            gray = pow(gray, power);
            graylo = digitize(pm, pow(graylo, power), sample_depth, 1);
            grayhi = digitize(pm, pow(grayhi, power), sample_depth, 1);
         }

         /* 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: */
            if (err > display->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,
                  display->pm->limit, 6);
               png_error(pp, buffer);
            }
         }
      }

      that->bluef = that->greenf = that->redf = gray;
      that->bluee = that->greene = that->rede = err;
6917 6918 6919 6920 6921 6922 6923 6924

      /* 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;

6925
      /* And remove the colour bit in the type: */
6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936
      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,
6937
    PNG_CONST image_transform **that, png_byte colour_type, png_byte bit_depth)
6938
{
6939
   UNUSED(bit_depth)
6940 6941 6942 6943 6944 6945 6946

   this->next = *that;
   *that = this;

   return (colour_type & PNG_COLOR_MASK_COLOR) != 0;
}

6947
#undef data
6948 6949 6950
IT(rgb_to_gray);
#undef PT
#define PT ITSTRUCT(rgb_to_gray)
6951 6952
#undef image_transform_ini
#define image_transform_ini image_transform_default_ini
6953
#endif /* PNG_READ_RGB_TO_GRAY_SUPPORTED */
6954

6955
#ifdef PNG_READ_BACKGROUND_SUPPORTED
6956 6957 6958 6959 6960 6961
/* 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)
 *
6962
 * As with rgb_to_gray this ignores the gamma (at present.)
6963
*/
6964 6965 6966
#define data ITDATA(background)
static image_pixel data;

6967 6968 6969 6970
static void
image_transform_png_set_background_set(PNG_CONST image_transform *this,
    transform_display *that, png_structp pp, png_infop pi)
{
6971 6972
   png_byte colour_type, bit_depth;
   png_byte random_bytes[8]; /* 8 bytes - 64 bits - the biggest pixel */
6973 6974
   png_color_16 back;

6975 6976 6977 6978 6979 6980 6981 6982 6983
   /* 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.
6984
    */
6985 6986 6987 6988 6989 6990 6991 6992 6993 6994
   colour_type = that->this.colour_type;
   if (colour_type == 3)
   {
      colour_type = PNG_COLOR_TYPE_RGB;
      bit_depth = 8;
   }

   else
      bit_depth = that->this.bit_depth;

6995
   image_pixel_init(&data, random_bytes, colour_type,
6996
      bit_depth, 0/*x*/, 0/*unused: palette*/);
6997

6998 6999 7000 7001 7002 7003 7004
   /* 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)
   {
7005 7006 7007
      back.red = (png_uint_16)data.red;
      back.green = (png_uint_16)data.green;
      back.blue = (png_uint_16)data.blue;
7008 7009 7010
   }

   else
7011
      back.gray = (png_uint_16)data.red;
7012

7013
#  ifdef PNG_FLOATING_POINT_SUPPORTED
7014 7015
      png_set_background(pp, &back, PNG_BACKGROUND_GAMMA_FILE, 1/*need expand*/,
         0);
7016
#  else
7017 7018
      png_set_background_fixed(pp, &back, PNG_BACKGROUND_GAMMA_FILE,
         1/*need expand*/, 0);
7019 7020 7021 7022 7023 7024 7025
#  endif

   this->next->set(this->next, that, pp, pi);
}

static void
image_transform_png_set_background_mod(PNG_CONST image_transform *this,
7026 7027
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
7028
{
7029 7030
   /* Check for tRNS first: */
   if (that->have_tRNS && that->colour_type != PNG_COLOR_TYPE_PALETTE)
7031 7032
      image_pixel_add_alpha(that, &display->this);

7033 7034
   /* This is only necessary if the alpha value is less than 1. */
   if (that->alphaf < 1)
7035
   {
7036
      /* Now we do the background calculation without any gamma correction. */
7037 7038
      if (that->alphaf <= 0)
      {
7039 7040 7041
         that->redf = data.redf;
         that->greenf = data.greenf;
         that->bluef = data.bluef;
7042

7043 7044 7045
         that->rede = data.rede;
         that->greene = data.greene;
         that->bluee = data.bluee;
7046

7047 7048 7049
         that->red_sBIT= data.red_sBIT;
         that->green_sBIT= data.green_sBIT;
         that->blue_sBIT= data.blue_sBIT;
7050 7051
      }

7052
      else /* 0 < alpha < 1 */
7053
      {
7054 7055
         double alf = 1 - that->alphaf;

7056 7057
         that->redf = that->redf * that->alphaf + data.redf * alf;
         that->rede = that->rede * that->alphaf + data.rede * alf +
7058
            DBL_EPSILON;
7059 7060
         that->greenf = that->greenf * that->alphaf + data.greenf * alf;
         that->greene = that->greene * that->alphaf + data.greene * alf +
7061
            DBL_EPSILON;
7062 7063
         that->bluef = that->bluef * that->alphaf + data.bluef * alf;
         that->bluee = that->bluee * that->alphaf + data.bluee * alf +
7064 7065 7066
            DBL_EPSILON;
      }

7067
      /* Remove the alpha type and set the alpha (not in that order.) */
7068 7069 7070 7071 7072 7073 7074
      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;
7075
      /* PNG_COLOR_TYPE_PALETTE is not changed */
7076 7077
   }

7078 7079 7080 7081 7082
   this->next->mod(this->next, that, pp, display);
}

#define image_transform_png_set_background_add image_transform_default_add

7083
#undef data
7084 7085 7086 7087
IT(background);
#undef PT
#define PT ITSTRUCT(background)
#endif /* PNG_READ_BACKGROUND_SUPPORTED */
7088

7089 7090
/* This may just be 'end' if all the transforms are disabled! */
static image_transform *PNG_CONST image_transform_first = &PT;
7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102

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)
7103
   {
7104 7105 7106 7107 7108 7109 7110 7111 7112
      if (strcmp(list->name, name) == 0)
      {
         list->enable = 1;
         found_it = 1;
      }
      else if (!all_disabled)
         list->enable = 0;

      list = list->list;
7113 7114
   }

7115 7116 7117 7118 7119 7120 7121 7122
   all_disabled = 1;

   if (!found_it)
   {
      fprintf(stderr, "pngvalid: --transform-enable=%s: unknown transform\n",
         name);
      exit(1);
   }
7123 7124
}

7125 7126
static void
transform_disable(PNG_CONST char *name)
7127
{
7128
   image_transform *list = image_transform_first;
7129

7130 7131 7132 7133 7134 7135 7136
   while (list != &image_transform_end)
   {
      if (strcmp(list->name, name) == 0)
      {
         list->enable = 0;
         return;
      }
7137

7138 7139
      list = list->list;
   }
7140

7141 7142 7143
   fprintf(stderr, "pngvalid: --transform-disable=%s: unknown transform\n",
      name);
   exit(1);
7144 7145
}

7146 7147 7148 7149 7150
static void
image_transform_reset_count(void)
{
   image_transform *next = image_transform_first;
   int count = 0;
7151

7152 7153 7154 7155 7156 7157 7158
   while (next != &image_transform_end)
   {
      next->local_use = 0;
      next->next = 0;
      next = next->list;
      ++count;
   }
7159

7160 7161 7162 7163 7164 7165 7166 7167
   /* 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)
7168
{
7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186
   /* 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;
}
7187 7188

static png_uint_32
7189
image_transform_add(PNG_CONST image_transform **this, unsigned int max,
7190 7191 7192
   png_uint_32 counter, char *name, size_t sizeof_name, size_t *pos,
   png_byte colour_type, png_byte bit_depth)
{
7193
   for (;;) /* until we manage to add something */
7194
   {
7195 7196
      png_uint_32 mask;
      image_transform *list;
7197

7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210
      /* 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 */
7211
      {
7212 7213 7214 7215 7216 7217 7218
         switch (max)
         {
            case 0:  ++counter; break;
            case 1:  counter <<= 1; break;
            default: counter = random_32(); break;
         }
      }
7219

7220 7221 7222 7223
      /* Now add all these items, if possible */
      *this = &image_transform_end;
      list = image_transform_first;
      mask = 1;
7224

7225 7226 7227 7228 7229
      /* 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))
7230
         {
7231 7232
            /* Candidate to add: */
            if (list->add(list, this, colour_type, bit_depth) || max == 0)
7233
            {
7234 7235 7236
               /* Added, so add to the name too. */
               *pos = safecat(name, sizeof_name, *pos, " +");
               *pos = safecat(name, sizeof_name, *pos, list->name);
7237 7238
            }

7239
            else
7240
            {
7241
               /* Not useful and max>0, so remove it from *this: */
7242 7243
               *this = list->next;
               list->next = 0;
7244

7245 7246 7247 7248 7249
               /* And, since we know it isn't useful, stop it being added again
                * in this run:
                */
               list->local_use = max;
            }
7250 7251
         }

7252 7253 7254
         mask <<= 1;
         list = list->list;
      }
7255

7256 7257 7258
      /* Now if anything was added we have something to do. */
      if (*this != &image_transform_end)
         return counter;
7259

7260 7261 7262
      /* Nothing added, but was there anything in there to add? */
      if (!image_transform_test_counter(counter, max))
         return 0;
7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276
   }
}

#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,
7277 7278
    image_pixel *that, png_const_structp pp,
    PNG_CONST transform_display *display)
7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342
{
   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 */

7343 7344
static void
perform_transform_test(png_modifier *pm)
7345
{
7346 7347
   png_byte colour_type = 0;
   png_byte bit_depth = 0;
7348
   unsigned int palette_number = 0;
7349 7350

   while (next_format(&colour_type, &bit_depth, &palette_number))
7351
   {
7352
      png_uint_32 counter = 0;
7353 7354 7355 7356 7357 7358 7359 7360 7361 7362
      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;

7363
         /* 'max' is currently hardwired to '1'; this should be settable on the
7364 7365 7366 7367
          * command line.
          */
         counter = image_transform_add(&list, 1/*max*/, counter,
            name, sizeof name, &pos, colour_type, bit_depth);
7368 7369 7370 7371 7372

         if (counter == 0)
            break;

         /* The command line can change this to checking interlaced images. */
7373 7374 7375 7376 7377
         do
         {
            pm->repeat = 0;
            transform_test(pm, FILEID(colour_type, bit_depth, palette_number,
               pm->interlace_type, 0, 0, 0), list, name);
7378

7379 7380 7381 7382
            if (fail(pm))
               return;
         }
         while (pm->repeat);
7383 7384 7385
      }
   }
}
7386
#endif /* PNG_READ_TRANSFORMS_SUPPORTED */
7387 7388

/********************************* GAMMA TESTS ********************************/
7389
#ifdef PNG_READ_GAMMA_SUPPORTED
7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400
/* 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;
7401
   double           background_gamma;
7402 7403 7404
   png_byte         sbit;
   int              threshold_test;
   int              use_input_precision;
7405
   int              scale16;
7406 7407 7408
   int              expand16;
   int              do_background;
   png_color_16     background_color;
7409 7410 7411 7412 7413 7414 7415

   /* Local variables */
   double       maxerrout;
   double       maxerrpc;
   double       maxerrabs;
} gamma_display;

7416 7417
#define ALPHA_MODE_OFFSET 4

7418 7419 7420
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,
7421
    int use_input_precision, int scale16, int expand16,
7422 7423
    int do_background, PNG_CONST png_color_16 *pointer_to_the_background_color,
    double background_gamma)
7424 7425
{
   /* Standard fields */
7426
   standard_display_init(&dp->this, &pm->this, id, 0/*do_interlace*/,
7427
      pm->use_update_info);
7428 7429 7430 7431 7432

   /* Parameter fields */
   dp->pm = pm;
   dp->file_gamma = file_gamma;
   dp->screen_gamma = screen_gamma;
7433
   dp->background_gamma = background_gamma;
7434 7435
   dp->sbit = sbit;
   dp->threshold_test = threshold_test;
7436
   dp->use_input_precision = use_input_precision;
7437
   dp->scale16 = scale16;
7438 7439 7440 7441 7442 7443
   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 已提交
7444

7445 7446 7447
   /* Local variable fields */
   dp->maxerrout = dp->maxerrpc = dp->maxerrabs = 0;
}
G
[devel]  
Glenn Randers-Pehrson 已提交
7448

7449 7450 7451
static void
gamma_info_imp(gamma_display *dp, png_structp pp, png_infop pi)
{
7452
   /* Reuse the standard stuff as appropriate. */
7453
   standard_info_part1(&dp->this, pp, pi);
G
[devel]  
Glenn Randers-Pehrson 已提交
7454

7455 7456 7457 7458 7459
   /* 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.
    */
7460
   if (dp->scale16)
7461
#     ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
7462
         png_set_scale_16(pp);
7463
#     else
7464 7465 7466 7467 7468 7469
         /* 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
7470
#     endif
G
[devel]  
Glenn Randers-Pehrson 已提交
7471

7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491
   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
7492
            PNG_CONST png_fixed_point g = fix(sg);
7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509
#        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
7510
               png_fixed_point f = fix(dp->file_gamma);
7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526
               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
      {
7527 7528
         png_fixed_point s = fix(dp->screen_gamma);
         png_fixed_point f = fix(dp->file_gamma);
7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539
         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
7540
            PNG_CONST png_fixed_point g = fix(bg);
7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555
#        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
      }
   }

7556 7557 7558 7559 7560 7561 7562
   {
      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 已提交
7563

7564
   /* Now we may get a different cbRow: */
7565
   standard_info_part2(&dp->this, pp, pi, 1 /*images*/);
7566 7567 7568 7569 7570
}

static void
gamma_info(png_structp pp, png_infop pi)
{
7571 7572
   gamma_info_imp(voidcast(gamma_display*, png_get_progressive_ptr(pp)), pp,
      pi);
7573
}
7574

7575 7576 7577 7578 7579 7580
/* 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
{
7581
   png_const_structp  pp;
7582 7583 7584 7585
   gamma_display *dp;
   png_byte sbit;
   int use_input_precision;
   int do_background;
7586
   int scale16;
7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600
   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;
7601
   double maxpc;
7602 7603
   double maxcalc;
   double maxout;
7604
   double maxout_total;     /* Total including quantization error */
7605
   double outlog;
7606
   int    outquant;
7607 7608 7609 7610
}
validate_info;

static void
7611
init_validate_info(validate_info *vi, gamma_display *dp, png_const_structp pp,
7612
    int in_depth, int out_depth)
7613
{
7614
   PNG_CONST unsigned int outmax = (1U<<out_depth)-1;
7615 7616 7617

   vi->pp = pp;
   vi->dp = dp;
7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631

   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;
7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643

   /* 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;
7644 7645 7646 7647 7648 7649
   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;
7650
   vi->outlog = outlog(dp->pm, in_depth, out_depth);
7651

7652 7653
   if ((dp->this.colour_type & PNG_COLOR_MASK_ALPHA) != 0 ||
      (dp->this.colour_type == 3 && dp->this.is_transparent))
7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696
   {
      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;

7697
   vi->scale16 = dp->scale16;
7698 7699
}

7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710
/* 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)
   {
7711
#ifdef PNG_READ_BACKGROUND_SUPPORTED
7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728
      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;
7729
#endif
7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761

#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.)
          */
7762 7763 7764
         UNUSED(alpha)
         UNUSED(background)
         UNUSED(compose)
7765 7766 7767 7768 7769 7770
         break;
   }

   return input_sample;
}

7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823
/* 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;

7824
      if (encoded_error < vi->maxout_total && encoded_error < vi->outlog)
7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837
         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 */
7838
      double output, error, encoded_sample, encoded_error;
7839
      double es_lo, es_hi;
7840 7841
      int compose = 0;           /* Set to one if composition done */
      int output_is_encoded;     /* Set if encoded to screen gamma */
7842
      int log_max_error = 1;     /* Check maximum error values */
7843
      png_const_charp pass = 0;  /* Reason test passes (or 0 for fail) */
7844 7845 7846 7847

      /* Convert to linear light (with the above caveat.)  The alpha channel is
       * already linear.
       */
7848 7849 7850 7851
      if (alpha >= 0)
      {
         int tcompose;

7852
         if (vi->file_inverse > 0)
7853 7854 7855 7856 7857 7858 7859 7860 7861 7862
            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;
      }
7863 7864

      /* And similarly for the output value, but we need to check the background
7865
       * handling to linearize it correctly.
7866 7867 7868 7869
       */
      output = od;
      output /= outmax;

7870
      output_is_encoded = vi->screen_gamma > 0;
7871

7872 7873
      if (alpha < 0) /* The alpha channel */
      {
7874
#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
7875
         if (do_background != ALPHA_MODE_OFFSET + PNG_ALPHA_BROKEN)
7876
#endif
7877
         {
7878 7879 7880
            /* In all other cases the output alpha channel is linear already,
             * don't log errors here, they are much larger in linear data.
             */
7881
            output_is_encoded = 0;
7882
            log_max_error = 0;
7883
         }
7884 7885
      }

7886
#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
7887
      else /* A component */
7888
      {
7889 7890 7891 7892 7893 7894
         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;
         }
7895
      }
7896
#endif
7897

7898 7899 7900
      if (output_is_encoded)
         output = pow(output, vi->screen_gamma);

7901 7902 7903 7904 7905 7906 7907 7908
      /* 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;

7909
      encoded_error = fabs(od-encoded_sample);
7910

7911 7912 7913 7914 7915
      /* 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;
7916

7917 7918 7919
      if (encoded_error < vi->maxout_total)
      {
         if (encoded_error < vi->outlog)
7920
            return i;
7921 7922 7923 7924 7925

         /* Test passed but error is bigger than the log limit, record why the
          * test passed:
          */
         pass = "less than maxout:\n";
7926 7927
      }

7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938
      /* 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
       */

7939 7940 7941 7942 7943 7944 7945 7946 7947
      /* 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
7948
       * dominate the percentage errors for lower result values:
7949
       */
7950
      if (log_max_error && input_sample > .5)
7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965
      {
         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;
7966 7967 7968 7969 7970 7971
         /* 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.
          */
7972 7973
         if (compose && tmp < vi->maxcalc) tmp = vi->maxcalc;

7974 7975 7976
         /* The 'maxout' value refers to the encoded result, to compare with
          * this encode input_sample adjusted by the maximum error (tmp) above.
          */
7977 7978 7979 7980 7981 7982 7983 7984 7985
         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;
7986 7987 7988

            /* Quantize this appropriately: */
            es_lo = ceil(es_lo / vi->outquant - .5) * vi->outquant;
7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002
         }

         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;
8003 8004

            es_hi = floor(es_hi / vi->outquant + .5) * vi->outquant;
8005 8006 8007 8008 8009 8010 8011 8012
         }

         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
8013
       * calculated above.
8014
       */
8015 8016 8017 8018 8019 8020 8021 8022 8023 8024
      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";
      }

8025
      {
8026 8027 8028
         /* There has been an error in processing, or we need to log this
          * value.
          */
8029 8030
         double is_lo, is_hi;

8031 8032 8033 8034 8035
         /* 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.
          */
         if (pass == 0 && vi->use_input_precision)
8036 8037
         {
            /* Ok, something is wrong - this actually happens in current libpng
8038 8039
             * 16-to-8 processing.  Assume that the input value (id, adjusted
             * for sbit) can be anywhere between value-.5 and value+.5 - quite a
8040 8041 8042 8043
             * large range if sbit is low.
             */
            double tmp = (isbit - .5)/sbit_max;

8044 8045
            if (tmp <= 0)
               tmp = 0;
8046

8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058
            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)
8059 8060 8061 8062
               is_lo = 0;

            tmp = (isbit + .5)/sbit_max;

8063 8064
            if (tmp <= 0)
               tmp = 0;
8065

8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077
            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)
8078 8079
               is_hi = outmax;

8080
            if (!(od < is_lo || od > is_hi))
8081 8082 8083 8084 8085 8086
            {
               if (encoded_error < vi->outlog)
                  return i;

               pass = "within input precision limits:\n";
            }
8087 8088 8089 8090 8091

            /* 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.
8092 8093 8094
             *
             * This is only done for older libpng versions when the 'inaccurate'
             * (chop) method of scaling was used.
8095
             */
8096 8097 8098 8099 8100 8101 8102 8103 8104 8105
#           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)
8106
                  {
8107
                     tmp = ((id >> 8) - .5)/255;
8108

8109 8110 8111 8112 8113
                     if (tmp > 0)
                     {
                        is_lo = ceil(outmax * tmp - vi->maxout_total);
                        if (is_lo < 0) is_lo = 0;
                     }
8114

8115 8116
                     else
                        is_lo = 0;
8117

8118
                     tmp = ((id >> 8) + .5)/255;
8119

8120 8121 8122 8123 8124
                     if (tmp < 1)
                     {
                        is_hi = floor(outmax * tmp + vi->maxout_total);
                        if (is_hi > outmax) is_hi = outmax;
                     }
8125

8126 8127
                     else
                        is_hi = outmax;
8128

8129 8130 8131 8132 8133 8134 8135
                     if (!(od < is_lo || od > is_hi))
                     {
                        if (encoded_error < vi->outlog)
                           return i;

                        pass = "within 8 bit limits:\n";
                     }
8136
                  }
8137
#              endif
8138 8139 8140 8141 8142
#           endif
         }
         else /* !use_input_precision */
            is_lo = es_lo, is_hi = es_hi;

8143 8144 8145 8146
         /* 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.
          */
8147
         {
8148 8149 8150 8151 8152 8153
            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;
8154 8155
            char msg[256];

8156 8157
            if (pass != 0)
               pos = safecat(msg, sizeof msg, pos, "\n\t");
8158

8159 8160 8161 8162 8163
            /* 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)
            {
8164 8165 8166 8167 8168 8169 8170
#           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
8171 8172 8173 8174 8175
#           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 */
8176
               do_compose = (alpha > 0 && alpha < 1);
8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322
               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);
8323 8324 8325 8326 8327 8328 8329
         }
      }
   }

   return i;
}

8330
static void
8331 8332
gamma_image_validate(gamma_display *dp, png_const_structp pp,
   png_infop pi)
8333 8334
{
   /* Get some constants derived from the input and output file formats: */
8335
   PNG_CONST png_store* PNG_CONST ps = dp->this.ps;
8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346
   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.
8347
    *
8348 8349 8350 8351 8352 8353 8354
    * 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.
    *
8355
    * Since the library must quantize the output to 8 or 16 bits there is
8356
    * a fundamental limit on the accuracy of the output of +/-.5 - this
8357
    * quantization limit is included in addition to the other limits
8358 8359 8360 8361 8362 8363
    * 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
8364
    * present:
8365
    *
8366
    *     png-sample = floor( input-sample * (max-out/max-in) + .5);
8367 8368
    *
    * This means that only a subset of the possible PNG values should
8369
    * appear in the input. However, the spec allows the encoder to use a
8370 8371 8372 8373 8374 8375 8376 8377 8378 8379
    * 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.
8380 8381
    * The basic tests below do not do this, however if 'use_input_precision'
    * is set a subsequent test is performed below.
8382 8383
    */
   PNG_CONST unsigned int samples_per_pixel = (out_ct & 2U) ? 3U : 1U;
8384 8385
   int processing;
   png_uint_32 y;
8386 8387 8388 8389 8390
   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;
8391
   validate_info vi;
G
[devel]  
Glenn Randers-Pehrson 已提交
8392

8393 8394 8395
   /* Check for row overwrite errors */
   store_image_check(dp->this.ps, pp, 0);

8396 8397 8398 8399
   /* 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 已提交
8400

8401
   processing = (vi.gamma_correction > 0 && !dp->threshold_test)
8402
      || in_bd != out_bd || in_ct != out_ct || vi.do_background;
G
[devel]  
Glenn Randers-Pehrson 已提交
8403

8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416
   /* 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);

8417
   for (y=0; y<h; ++y)
8418
   {
8419
      png_const_bytep pRow = store_image_row(ps, pp, 0, y);
8420
      png_byte std[STANDARD_ROWMAX];
G
[devel]  
Glenn Randers-Pehrson 已提交
8421

8422
      transform_row(pp, std, in_ct, in_bd, y);
G
[devel]  
Glenn Randers-Pehrson 已提交
8423

8424
      if (processing)
G
[devel]  
Glenn Randers-Pehrson 已提交
8425
      {
8426
         unsigned int x;
8427

8428 8429 8430
         for (x=0; x<w; ++x)
         {
            double alpha = 1; /* serves as a flag value */
8431

8432 8433 8434 8435 8436 8437
            /* 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;

8438 8439
            /* Handle input alpha - png_set_background will cause the output
             * alpha to disappear so there is nothing to check.
8440
             */
8441 8442
            if ((in_ct & PNG_COLOR_MASK_ALPHA) != 0 || (in_ct == 3 &&
               in_is_transparent))
8443
            {
8444 8445
               PNG_CONST unsigned int input_alpha = in_ct == 3 ?
                  dp->this.palette[in_index].alpha :
8446
                  sample(std, in_ct, in_bd, x, samples_per_pixel);
8447

8448
               unsigned int output_alpha = 65536 /* as a flag value */;
8449

8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460
               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)
8461
                  alpha = gamma_component_validate("alpha", &vi, input_alpha,
8462 8463 8464
                     output_alpha, -1/*alpha*/, 0/*background*/);

               else /* no alpha in output */
8465
               {
8466 8467 8468
                  /* This is a copy of the calculation of 'i' above in order to
                   * have the alpha value to use in the background calculation.
                   */
8469 8470
                  alpha = input_alpha >> vi.isbit_shift;
                  alpha /= vi.sbit_max;
8471 8472
               }
            }
8473

8474 8475
            /* Handle grayscale or RGB components. */
            if ((in_ct & PNG_COLOR_MASK_COLOR) == 0) /* grayscale */
8476 8477 8478 8479
               (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);
8480
            else /* RGB or palette */
8481
            {
8482
               (void)gamma_component_validate("red", &vi,
8483 8484 8485 8486 8487
                  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);
8488 8489

               (void)gamma_component_validate("green", &vi,
8490 8491 8492 8493 8494
                  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);
8495 8496

               (void)gamma_component_validate("blue", &vi,
8497 8498 8499 8500 8501
                  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);
8502 8503 8504
            }
         }
      }
8505

8506
      else if (memcmp(std, pRow, cbRow) != 0)
8507 8508
      {
         char msg[64];
8509

8510
         /* No transform is expected on the threshold tests. */
8511 8512
         sprintf(msg, "gamma: below threshold row %lu changed",
            (unsigned long)y);
8513

8514 8515 8516
         png_error(pp, msg);
      }
   } /* row (y) loop */
8517

8518 8519
   dp->this.ps->validated = 1;
}
8520

8521
static void
8522
gamma_end(png_structp ppIn, png_infop pi)
8523
{
8524
   png_const_structp pp = ppIn;
8525
   gamma_display *dp = voidcast(gamma_display*, png_get_progressive_ptr(pp));
8526

8527 8528
   if (!dp->this.speed)
      gamma_image_validate(dp, pp, pi);
8529 8530
   else
      dp->this.ps->validated = 1;
8531
}
8532

8533 8534 8535 8536 8537 8538 8539 8540
/* 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,
8541 8542
    PNG_CONST png_byte bit_depthIn, PNG_CONST int palette_numberIn,
    PNG_CONST int interlace_typeIn,
8543 8544
    PNG_CONST double file_gammaIn, PNG_CONST double screen_gammaIn,
    PNG_CONST png_byte sbitIn, PNG_CONST int threshold_testIn,
8545
    PNG_CONST char *name,
8546
    PNG_CONST int use_input_precisionIn, PNG_CONST int scale16In,
8547 8548
    PNG_CONST int expand16In, PNG_CONST int do_backgroundIn,
    PNG_CONST png_color_16 *bkgd_colorIn, double bkgd_gammaIn)
8549 8550 8551
{
   gamma_display d;
   context(&pmIn->this, fault);
8552

8553
   gamma_display_init(&d, pmIn, FILEID(colour_typeIn, bit_depthIn,
8554 8555
      palette_numberIn, interlace_typeIn, 0, 0, 0),
      file_gammaIn, screen_gammaIn, sbitIn,
8556
      threshold_testIn, use_input_precisionIn, scale16In,
8557
      expand16In, do_backgroundIn, bkgd_colorIn, bkgd_gammaIn);
8558

8559 8560 8561 8562
   Try
   {
      png_structp pp;
      png_infop pi;
8563
      gama_modification gama_mod;
8564 8565
      srgb_modification srgb_mod;
      sbit_modification sbit_mod;
8566

8567 8568 8569 8570 8571
      /* 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;

8572 8573 8574 8575
      /* 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;
8576
      gama_modification_init(&gama_mod, d.pm, d.file_gamma);
8577
      srgb_modification_init(&srgb_mod, d.pm, 127 /*delete*/);
8578 8579
      if (d.sbit > 0)
         sbit_modification_init(&sbit_mod, d.pm, d.sbit);
8580

8581 8582 8583 8584
      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);
8585
      standard_palette_init(&d.this);
8586

8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604
      /* 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);

8605
         /* Process the 'info' requirements. Only one image is generated */
8606 8607
         gamma_info_imp(&d, pp, pi);

8608
         sequential_row(&d.this, pp, pi, -1, 0);
8609

8610 8611
         if (!d.this.speed)
            gamma_image_validate(&d, pp, pi);
8612 8613
         else
            d.this.ps->validated = 1;
8614 8615
      }

8616
      modifier_reset(d.pm);
8617

8618
      if (d.pm->log && !d.threshold_test && !d.this.speed)
8619
         fprintf(stderr, "%d bit %s %s: max error %f (%.2g, %2g%%)\n",
8620
            d.this.bit_depth, colour_types[d.this.colour_type], name,
8621
            d.maxerrout, d.maxerrabs, 100*d.maxerrpc);
8622 8623

      /* Log the summary values too. */
8624
      if (d.this.colour_type == 0 || d.this.colour_type == 4)
8625
      {
8626
         switch (d.this.bit_depth)
8627
         {
8628 8629 8630 8631
         case 1:
            break;

         case 2:
8632 8633
            if (d.maxerrout > d.pm->error_gray_2)
               d.pm->error_gray_2 = d.maxerrout;
8634

8635 8636 8637
            break;

         case 4:
8638 8639
            if (d.maxerrout > d.pm->error_gray_4)
               d.pm->error_gray_4 = d.maxerrout;
8640

8641 8642 8643
            break;

         case 8:
8644 8645
            if (d.maxerrout > d.pm->error_gray_8)
               d.pm->error_gray_8 = d.maxerrout;
8646

8647 8648 8649
            break;

         case 16:
8650 8651
            if (d.maxerrout > d.pm->error_gray_16)
               d.pm->error_gray_16 = d.maxerrout;
8652

8653 8654 8655 8656
            break;

         default:
            png_error(pp, "bad bit depth (internal: 1)");
8657
         }
G
[devel]  
Glenn Randers-Pehrson 已提交
8658 8659
      }

8660
      else if (d.this.colour_type == 2 || d.this.colour_type == 6)
8661
      {
8662
         switch (d.this.bit_depth)
8663 8664
         {
         case 8:
8665

8666 8667
            if (d.maxerrout > d.pm->error_color_8)
               d.pm->error_color_8 = d.maxerrout;
G
[devel]  
Glenn Randers-Pehrson 已提交
8668

8669
            break;
G
[devel]  
Glenn Randers-Pehrson 已提交
8670

8671
         case 16:
8672

8673 8674
            if (d.maxerrout > d.pm->error_color_16)
               d.pm->error_color_16 = d.maxerrout;
8675 8676 8677 8678 8679 8680 8681

            break;

         default:
            png_error(pp, "bad bit depth (internal: 2)");
         }
      }
8682 8683 8684 8685 8686 8687

      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 已提交
8688
   }
8689 8690

   Catch(fault)
8691
      modifier_reset((png_modifier*)fault);
G
[devel]  
Glenn Randers-Pehrson 已提交
8692 8693 8694
}

static void gamma_threshold_test(png_modifier *pm, png_byte colour_type,
8695 8696
    png_byte bit_depth, int interlace_type, double file_gamma,
    double screen_gamma)
G
[devel]  
Glenn Randers-Pehrson 已提交
8697 8698 8699 8700 8701 8702 8703 8704
{
   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);

8705
   (void)gamma_test(pm, colour_type, bit_depth, 0/*palette*/, interlace_type,
8706
      file_gamma, screen_gamma, 0/*sBIT*/, 1/*threshold test*/, name,
8707
      0 /*no input precision*/,
8708
      0 /*no scale16*/, 0 /*no expand16*/, 0 /*no background*/, 0 /*hence*/,
8709
      0 /*no background gamma*/);
G
[devel]  
Glenn Randers-Pehrson 已提交
8710 8711 8712 8713 8714 8715 8716
}

static void
perform_gamma_threshold_tests(png_modifier *pm)
{
   png_byte colour_type = 0;
   png_byte bit_depth = 0;
8717
   unsigned int palette_number = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
8718

8719 8720 8721 8722 8723 8724
   /* 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!
    */
   while (next_format(&colour_type, &bit_depth, &palette_number))
      if (palette_number == 0)
G
[devel]  
Glenn Randers-Pehrson 已提交
8725
   {
8726 8727
      double test_gamma = 1.0;
      while (test_gamma >= .4)
G
[devel]  
Glenn Randers-Pehrson 已提交
8728
      {
8729 8730 8731 8732
         /* 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,
8733 8734
            test_gamma, 1/test_gamma);
         test_gamma *= .95;
G
[devel]  
Glenn Randers-Pehrson 已提交
8735 8736 8737
      }

      /* And a special test for sRGB */
8738 8739
      gamma_threshold_test(pm, colour_type, bit_depth, pm->interlace_type,
          .45455, 2.2);
8740 8741 8742

      if (fail(pm))
         return;
G
[devel]  
Glenn Randers-Pehrson 已提交
8743 8744 8745
   }
}

8746 8747
static void gamma_transform_test(png_modifier *pm,
   PNG_CONST png_byte colour_type, PNG_CONST png_byte bit_depth,
8748
   PNG_CONST int palette_number,
8749
   PNG_CONST int interlace_type, PNG_CONST double file_gamma,
8750
   PNG_CONST double screen_gamma, PNG_CONST png_byte sbit,
8751
   PNG_CONST int use_input_precision, PNG_CONST int scale16)
G
[devel]  
Glenn Randers-Pehrson 已提交
8752 8753 8754
{
   size_t pos = 0;
   char name[64];
8755

8756
   if (sbit != bit_depth && sbit != 0)
G
[devel]  
Glenn Randers-Pehrson 已提交
8757 8758 8759 8760 8761
   {
      pos = safecat(name, sizeof name, pos, "sbit(");
      pos = safecatn(name, sizeof name, pos, sbit);
      pos = safecat(name, sizeof name, pos, ") ");
   }
8762

G
[devel]  
Glenn Randers-Pehrson 已提交
8763 8764
   else
      pos = safecat(name, sizeof name, pos, "gamma ");
8765

8766
   if (scale16)
G
[devel]  
Glenn Randers-Pehrson 已提交
8767
      pos = safecat(name, sizeof name, pos, "16to8 ");
8768

G
[devel]  
Glenn Randers-Pehrson 已提交
8769 8770 8771 8772
   pos = safecatd(name, sizeof name, pos, file_gamma, 3);
   pos = safecat(name, sizeof name, pos, "->");
   pos = safecatd(name, sizeof name, pos, screen_gamma, 3);

8773 8774
   gamma_test(pm, colour_type, bit_depth, palette_number, interlace_type,
      file_gamma, screen_gamma, sbit, 0, name, use_input_precision,
8775
      scale16, pm->test_gamma_expand16, 0 , 0, 0);
G
[devel]  
Glenn Randers-Pehrson 已提交
8776 8777
}

8778
static void perform_gamma_transform_tests(png_modifier *pm)
G
[devel]  
Glenn Randers-Pehrson 已提交
8779 8780 8781
{
   png_byte colour_type = 0;
   png_byte bit_depth = 0;
8782
   unsigned int palette_number = 0;
G
[devel]  
Glenn Randers-Pehrson 已提交
8783

8784
   while (next_format(&colour_type, &bit_depth, &palette_number))
G
[devel]  
Glenn Randers-Pehrson 已提交
8785
   {
8786
      unsigned int i, j;
G
[devel]  
Glenn Randers-Pehrson 已提交
8787

8788 8789 8790 8791 8792 8793
      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*/);
8794

8795 8796 8797
            if (fail(pm))
               return;
         }
G
[devel]  
Glenn Randers-Pehrson 已提交
8798 8799 8800
   }
}

8801
static void perform_gamma_sbit_tests(png_modifier *pm)
G
[devel]  
Glenn Randers-Pehrson 已提交
8802 8803 8804 8805
{
   png_byte sbit;

   /* The only interesting cases are colour and grayscale, alpha is ignored here
8806 8807
    * for overall speed.  Only bit depths where sbit is less than the bit depth
    * are tested.
G
[devel]  
Glenn Randers-Pehrson 已提交
8808
    */
8809
   for (sbit=pm->sbitlow; sbit<(1<<READ_BDHI); ++sbit)
G
[devel]  
Glenn Randers-Pehrson 已提交
8810
   {
8811 8812
      png_byte colour_type = 0, bit_depth = 0;
      unsigned int npalette = 0;
8813

8814 8815 8816 8817 8818 8819
      while (next_format(&colour_type, &bit_depth, &npalette))
         if ((colour_type & PNG_COLOR_MASK_ALPHA) == 0 &&
            ((colour_type == 3 && sbit < 8) ||
            (colour_type != 3 && sbit < bit_depth)))
      {
         unsigned int i;
8820

8821
         for (i=0; i<pm->ngamma_tests; ++i)
8822 8823
         {
            unsigned int j;
8824

8825
            for (j=0; j<pm->ngamma_tests; ++j) if (i != j)
8826 8827 8828
            {
               gamma_transform_test(pm, colour_type, bit_depth, npalette,
                  pm->interlace_type, 1/pm->gammas[i], pm->gammas[j],
8829
                  sbit, pm->use_input_precision_sbit, 0 /*scale16*/);
8830 8831 8832 8833

               if (fail(pm))
                  return;
            }
8834
         }
G
[devel]  
Glenn Randers-Pehrson 已提交
8835 8836 8837 8838
      }
   }
}

8839
/* Note that this requires a 16 bit source image but produces 8 bit output, so
8840 8841
 * we only need the 16bit write support, but the 16 bit images are only
 * generated if DO_16BIT is defined.
8842
 */
8843
#ifdef DO_16BIT
8844
static void perform_gamma_scale16_tests(png_modifier *pm)
G
[devel]  
Glenn Randers-Pehrson 已提交
8845 8846 8847 8848
{
#  ifndef PNG_MAX_GAMMA_8
#     define PNG_MAX_GAMMA_8 11
#  endif
8849
   /* Include the alpha cases here. Note that sbit matches the internal value
G
[devel]  
Glenn Randers-Pehrson 已提交
8850 8851 8852
    * used by the library - otherwise we will get spurious errors from the
    * internal sbit style approximation.
    *
8853
    * The threshold test is here because otherwise the 16 to 8 conversion will
G
[devel]  
Glenn Randers-Pehrson 已提交
8854 8855 8856
    * 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.
    */
8857
   unsigned int i, j;
8858
   for (i=0; i<pm->ngamma_tests; ++i)
G
[devel]  
Glenn Randers-Pehrson 已提交
8859
   {
8860
      for (j=0; j<pm->ngamma_tests; ++j)
8861 8862 8863 8864
      {
         if (i != j &&
             fabs(pm->gammas[j]/pm->gammas[i]-1) >= PNG_GAMMA_THRESHOLD)
         {
8865 8866
            gamma_transform_test(pm, 0, 16, 0, pm->interlace_type,
               1/pm->gammas[i], pm->gammas[j], PNG_MAX_GAMMA_8,
8867
               pm->use_input_precision_16to8, 1 /*scale16*/);
8868 8869 8870 8871

            if (fail(pm))
               return;

8872 8873
            gamma_transform_test(pm, 2, 16, 0, pm->interlace_type,
               1/pm->gammas[i], pm->gammas[j], PNG_MAX_GAMMA_8,
8874
               pm->use_input_precision_16to8, 1 /*scale16*/);
8875 8876 8877 8878

            if (fail(pm))
               return;

8879 8880
            gamma_transform_test(pm, 4, 16, 0, pm->interlace_type,
               1/pm->gammas[i], pm->gammas[j], PNG_MAX_GAMMA_8,
8881
               pm->use_input_precision_16to8, 1 /*scale16*/);
8882 8883 8884 8885

            if (fail(pm))
               return;

8886 8887
            gamma_transform_test(pm, 6, 16, 0, pm->interlace_type,
               1/pm->gammas[i], pm->gammas[j], PNG_MAX_GAMMA_8,
8888
               pm->use_input_precision_16to8, 1 /*scale16*/);
8889 8890 8891 8892 8893

            if (fail(pm))
               return;
         }
      }
G
[devel]  
Glenn Randers-Pehrson 已提交
8894 8895
   }
}
8896
#endif /* 16 to 8 bit conversion */
G
[devel]  
Glenn Randers-Pehrson 已提交
8897

8898 8899
#if defined(PNG_READ_BACKGROUND_SUPPORTED) ||\
   defined(PNG_READ_ALPHA_MODE_SUPPORTED)
8900 8901
static void gamma_composition_test(png_modifier *pm,
   PNG_CONST png_byte colour_type, PNG_CONST png_byte bit_depth,
8902
   PNG_CONST int palette_number,
8903
   PNG_CONST int interlace_type, PNG_CONST double file_gamma,
8904
   PNG_CONST double screen_gamma,
8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917
   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:
8918
         base = "";
8919 8920 8921
         bg = 4; /* should not be used */
         break;
      case PNG_BACKGROUND_GAMMA_SCREEN:
8922
         base = " bckg(Screen):";
8923 8924 8925
         bg = 1/screen_gamma;
         break;
      case PNG_BACKGROUND_GAMMA_FILE:
8926
         base = " bckg(File):";
8927 8928 8929
         bg = file_gamma;
         break;
      case PNG_BACKGROUND_GAMMA_UNIQUE:
8930
         base = " bckg(Unique):";
8931 8932 8933 8934 8935 8936 8937 8938
         /* 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:
8939
         base = " alpha(PNG)";
8940 8941 8942
         bg = 4; /* should not be used */
         break;
      case ALPHA_MODE_OFFSET + PNG_ALPHA_STANDARD:
8943
         base = " alpha(Porter-Duff)";
8944 8945 8946
         bg = 4; /* should not be used */
         break;
      case ALPHA_MODE_OFFSET + PNG_ALPHA_OPTIMIZED:
8947
         base = " alpha(Optimized)";
8948 8949 8950
         bg = 4; /* should not be used */
         break;
      case ALPHA_MODE_OFFSET + PNG_ALPHA_BROKEN:
8951
         base = " alpha(Broken)";
8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989
         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);
   }

   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;
   }

8990
   pos = safecat(name, sizeof name, pos, "gamma ");
8991
   pos = safecatd(name, sizeof name, pos, file_gamma, 3);
8992 8993 8994 8995
   pos = safecat(name, sizeof name, pos, "->");
   pos = safecatd(name, sizeof name, pos, screen_gamma, 3);

   pos = safecat(name, sizeof name, pos, base);
8996 8997 8998
   if (do_background < ALPHA_MODE_OFFSET)
   {
      /* Include the background color and gamma in the name: */
8999
      pos = safecat(name, sizeof name, pos, "(");
9000 9001 9002 9003 9004 9005
      /* 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, ",");
9006
         pos = safecatn(name, sizeof name, pos, background.green);
9007 9008 9009 9010 9011 9012 9013 9014 9015
         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);
   }

9016
   gamma_test(pm, colour_type, bit_depth, palette_number, interlace_type,
9017
      file_gamma, screen_gamma, 0/*sBIT*/, 0, name, use_input_precision,
9018 9019 9020 9021 9022
      0/*strip 16*/, expand_16, do_background, &background, bg);
}


static void
9023
perform_gamma_composition_tests(png_modifier *pm, int do_background,
9024 9025 9026 9027
   int expand_16)
{
   png_byte colour_type = 0;
   png_byte bit_depth = 0;
9028
   unsigned int palette_number = 0;
9029

9030 9031
   /* Skip the non-alpha cases - there is no setting of a transparency colour at
    * present.
9032
    */
9033 9034
   while (next_format(&colour_type, &bit_depth, &palette_number))
      if ((colour_type & PNG_COLOR_MASK_ALPHA) != 0)
9035 9036 9037 9038
   {
      unsigned int i, j;

      /* Don't skip the i==j case here - it's relevant. */
9039
      for (i=0; i<pm->ngamma_tests; ++i) for (j=0; j<pm->ngamma_tests; ++j)
9040
      {
9041 9042
         gamma_composition_test(pm, colour_type, bit_depth, palette_number,
            pm->interlace_type, 1/pm->gammas[i], pm->gammas[j],
9043
            pm->use_input_precision, do_background, expand_16);
9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054

         if (fail(pm))
            return;
      }
   }
}
#endif /* READ_BACKGROUND || READ_ALPHA_MODE */

static void
init_gamma_errors(png_modifier *pm)
{
9055 9056 9057
   pm->error_gray_2 = pm->error_gray_4 = pm->error_gray_8 = 0;
   pm->error_color_8 = 0;
   pm->error_indexed = 0;
9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072
   pm->error_gray_16 = pm->error_color_16 = 0;
}

static void
summarize_gamma_errors(png_modifier *pm, png_const_charp who, int low_bit_depth)
{
   if (who)
      printf("Gamma correction with %s:\n", who);

   if (low_bit_depth)
   {
      printf("  2 bit gray:  %.5f\n", pm->error_gray_2);
      printf("  4 bit gray:  %.5f\n", pm->error_gray_4);
      printf("  8 bit gray:  %.5f\n", pm->error_gray_8);
      printf("  8 bit color: %.5f\n", pm->error_color_8);
9073
      printf("  indexed:     %.5f\n", pm->error_indexed);
9074 9075 9076 9077 9078 9079 9080 9081
   }

#ifdef DO_16BIT
   printf(" 16 bit gray:  %.5f\n", pm->error_gray_16);
   printf(" 16 bit color: %.5f\n", pm->error_color_16);
#endif
}

G
[devel]  
Glenn Randers-Pehrson 已提交
9082
static void
9083
perform_gamma_test(png_modifier *pm, int summary)
G
[devel]  
Glenn Randers-Pehrson 已提交
9084
{
9085 9086 9087 9088
   /*TODO: remove this*/
   /* Save certain values for the temporary overrides below. */
   unsigned int calculations_use_input_precision =
      pm->calculations_use_input_precision;
9089 9090 9091
#  ifdef PNG_READ_BACKGROUND_SUPPORTED
      double maxout8 = pm->maxout8;
#  endif
9092

G
[devel]  
Glenn Randers-Pehrson 已提交
9093
   /* First some arbitrary no-transform tests: */
9094
   if (!pm->this.speed && pm->test_gamma_threshold)
G
[devel]  
Glenn Randers-Pehrson 已提交
9095 9096
   {
      perform_gamma_threshold_tests(pm);
9097 9098 9099

      if (fail(pm))
         return;
G
[devel]  
Glenn Randers-Pehrson 已提交
9100 9101 9102
   }

   /* Now some real transforms. */
9103
   if (pm->test_gamma_transform)
G
[devel]  
Glenn Randers-Pehrson 已提交
9104
   {
9105
      init_gamma_errors(pm);
9106
      /*TODO: remove this.  Necessary because the current libpng
9107 9108 9109 9110
       * implementation works in 8 bits:
       */
      if (pm->test_gamma_expand16)
         pm->calculations_use_input_precision = 1;
9111
      perform_gamma_transform_tests(pm);
9112 9113
      if (!calculations_use_input_precision)
         pm->calculations_use_input_precision = 0;
9114

9115
      if (summary)
G
[devel]  
Glenn Randers-Pehrson 已提交
9116
      {
9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129
         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");
         printf("increases when the image file includes an sBIT chunk.\n\n");

9130
         summarize_gamma_errors(pm, 0/*who*/, 1);
9131
      }
G
[devel]  
Glenn Randers-Pehrson 已提交
9132 9133
   }

9134
   /* The sbit tests produce much larger errors: */
9135
   if (pm->test_gamma_sbit)
9136
   {
9137
      init_gamma_errors(pm);
9138
      perform_gamma_sbit_tests(pm);
9139

9140
      if (summary)
9141
         summarize_gamma_errors(pm, "sBIT", pm->sbitlow < 8U);
9142 9143
   }

9144
#ifdef DO_16BIT /* Should be READ_16BIT_SUPPORTED */
9145
   if (pm->test_gamma_scale16)
G
[devel]  
Glenn Randers-Pehrson 已提交
9146
   {
9147
      /* The 16 to 8 bit strip operations: */
9148
      init_gamma_errors(pm);
9149
      perform_gamma_scale16_tests(pm);
9150 9151 9152 9153 9154 9155 9156

      if (summary)
      {
         printf("Gamma correction with 16 to 8 bit reduction:\n");
         printf(" 16 bit gray:  %.5f\n", pm->error_gray_16);
         printf(" 16 bit color: %.5f\n", pm->error_color_16);
      }
G
[devel]  
Glenn Randers-Pehrson 已提交
9157
   }
9158
#endif
9159 9160 9161 9162 9163 9164

#ifdef PNG_READ_BACKGROUND_SUPPORTED
   if (pm->test_gamma_background)
   {
      init_gamma_errors(pm);

9165
      /*TODO: remove this.  Necessary because the current libpng
9166 9167 9168 9169 9170 9171 9172
       * 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 */
      }
9173
      perform_gamma_composition_tests(pm, PNG_BACKGROUND_GAMMA_UNIQUE,
9174
         pm->test_gamma_expand16);
9175 9176 9177
      if (!calculations_use_input_precision)
         pm->calculations_use_input_precision = 0;
      pm->maxout8 = maxout8;
9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190

      if (summary)
         summarize_gamma_errors(pm, "background", 1);
   }
#endif

#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
   if (pm->test_gamma_alpha_mode)
   {
      int do_background;

      init_gamma_errors(pm);

9191
      /*TODO: remove this.  Necessary because the current libpng
9192 9193 9194 9195
       * implementation works in 8 bits:
       */
      if (pm->test_gamma_expand16)
         pm->calculations_use_input_precision = 1;
9196 9197 9198
      for (do_background = ALPHA_MODE_OFFSET + PNG_ALPHA_STANDARD;
         do_background <= ALPHA_MODE_OFFSET + PNG_ALPHA_BROKEN && !fail(pm);
         ++do_background)
9199
         perform_gamma_composition_tests(pm, do_background,
9200
            pm->test_gamma_expand16);
9201 9202
      if (!calculations_use_input_precision)
         pm->calculations_use_input_precision = 0;
9203 9204 9205 9206 9207

      if (summary)
         summarize_gamma_errors(pm, "alpha mode", 1);
   }
#endif
G
[devel]  
Glenn Randers-Pehrson 已提交
9208
}
9209
#endif /* PNG_READ_GAMMA_SUPPORTED */
9210
#endif /* PNG_READ_SUPPORTED */
G
[devel]  
Glenn Randers-Pehrson 已提交
9211

9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557
/* 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);
         exit(1);
      }

      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);
         exit(1);
      }

      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);
         exit(1);
      }

      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);
         exit(1);
      }

      /* 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);
            exit(1);
         }

         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);
            exit(1);
         }

         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);
            exit(1);
         }

         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);
            exit(1);
         }

         /* 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);
            exit(1);
         }

         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);
            exit(1);
         }

         /* 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;
         }
      }
   }
}

9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592
/* 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} },
};

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
/* 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 已提交
9659
/* main program */
9660
int main(int argc, char **argv)
G
[devel]  
Glenn Randers-Pehrson 已提交
9661
{
9662
   volatile int summary = 1;  /* Print the error summary at the end */
9663
   volatile int memstats = 0; /* Print memory statistics at the end */
9664 9665 9666

   /* Create the given output file on success: */
   PNG_CONST char *volatile touch = NULL;
G
[devel]  
Glenn Randers-Pehrson 已提交
9667 9668 9669 9670 9671 9672

   /* 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!
    */
9673 9674
   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 已提交
9675

9676 9677 9678 9679
   /* This records the command and arguments: */
   size_t cp = 0;
   char command[1024];

9680
   anon_context(&pm.this);
9681

9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697
   /* Add appropriate signal handlers, just the ANSI specified ones: */
   signal(SIGABRT, signal_handler);
   signal(SIGFPE, signal_handler);
   signal(SIGILL, signal_handler);
   signal(SIGINT, signal_handler);
   signal(SIGSEGV, signal_handler);
   signal(SIGTERM, signal_handler);

#ifdef HAVE_FEENABLEEXCEPT
   /* 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 已提交
9698 9699
   modifier_init(&pm);

9700
   /* Preallocate the image buffer, because we know how big it needs to be,
9701 9702 9703
    * 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.
9704
    */
9705
   store_ensure_image(&pm.this, NULL, 2, TRANSFORM_ROWMAX, TRANSFORM_HEIGHTMAX);
9706

9707 9708 9709
   /* Don't give argv[0], it's normally some horrible libtool string: */
   cp = safecat(command, sizeof command, cp, "pngvalid");

G
[devel]  
Glenn Randers-Pehrson 已提交
9710 9711 9712 9713 9714
   /* Default to error on warning: */
   pm.this.treat_warnings_as_errors = 1;

   /* Store the test gammas */
   pm.gammas = gammas;
9715 9716 9717 9718 9719 9720 9721
   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]);

9722
   pm.sbitlow = 8U; /* because libpng doesn't do sBIT below 8! */
9723 9724 9725 9726 9727 9728 9729
   /* 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
    * way libpng treates the 16_TO_8 flag when building the gamma tables.
    *
    * TODO: review this
    */
   pm.use_input_precision_16to8 = 1U;
G
[devel]  
Glenn Randers-Pehrson 已提交
9730

9731 9732 9733 9734 9735
   /* 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
9736
    * images can never be good enough, regardless of encoding.
9737
    */
G
[devel]  
Glenn Randers-Pehrson 已提交
9738 9739
   pm.maxout8 = .1;     /* Arithmetic error in *encoded* value */
   pm.maxabs8 = .00005; /* 1/20000 */
9740
   pm.maxcalc8 = .004;  /* +/-1 in 8 bits for compose errors */
9741
   pm.maxpc8 = .499;    /* I.e., .499% fractional error */
G
[devel]  
Glenn Randers-Pehrson 已提交
9742 9743
   pm.maxout16 = .499;  /* Error in *encoded* value */
   pm.maxabs16 = .00005;/* 1/20000 */
9744
   pm.maxcalc16 =.000015;/* +/-1 in 16 bits for compose errors */
9745 9746

   /* NOTE: this is a reasonable perceptual limit. We assume that humans can
G
[devel]  
Glenn Randers-Pehrson 已提交
9747
    * perceive light level differences of 1% over a 100:1 range, so we need to
9748
    * maintain 1 in 10000 accuracy (in linear light space), which is what the
G
[devel]  
Glenn Randers-Pehrson 已提交
9749 9750 9751 9752 9753
    * 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:
    */
9754
   pm.maxpc16 = .005;   /* I.e., 1/200% - 1/20000 */
G
[devel]  
Glenn Randers-Pehrson 已提交
9755 9756 9757

   /* Now parse the command line options. */
   while (--argc >= 1)
9758
   {
9759 9760
      int catmore = 0; /* Set if the argument has an argument. */

9761 9762 9763 9764 9765
      /* 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 已提交
9766
         pm.this.verbose = 1;
9767

G
[devel]  
Glenn Randers-Pehrson 已提交
9768 9769
      else if (strcmp(*argv, "-l") == 0)
         pm.log = 1;
9770

G
[devel]  
Glenn Randers-Pehrson 已提交
9771
      else if (strcmp(*argv, "-q") == 0)
9772
         summary = pm.this.verbose = pm.log = 0;
9773

G
[devel]  
Glenn Randers-Pehrson 已提交
9774 9775
      else if (strcmp(*argv, "-w") == 0)
         pm.this.treat_warnings_as_errors = 0;
9776

9777
      else if (strcmp(*argv, "--speed") == 0)
9778 9779
         pm.this.speed = 1, pm.ngamma_tests = pm.ngammas, pm.test_standard = 0,
            summary = 0;
9780 9781 9782

      else if (strcmp(*argv, "--memory") == 0)
         memstats = 1;
9783

9784 9785 9786
      else if (strcmp(*argv, "--size") == 0)
         pm.test_size = 1;

9787 9788 9789 9790 9791 9792
      else if (strcmp(*argv, "--nosize") == 0)
         pm.test_size = 0;

      else if (strcmp(*argv, "--standard") == 0)
         pm.test_standard = 1;

9793 9794
      else if (strcmp(*argv, "--nostandard") == 0)
         pm.test_standard = 0;
9795

9796 9797 9798
      else if (strcmp(*argv, "--transform") == 0)
         pm.test_transform = 1;

9799 9800 9801
      else if (strcmp(*argv, "--notransform") == 0)
         pm.test_transform = 0;

9802
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815
      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");
         }
9816
#endif /* PNG_READ_TRANSFORMS_SUPPORTED */
9817 9818 9819 9820

      else if (strcmp(*argv, "--gamma") == 0)
         {
         /* Just do two gamma tests here (2.2 and linear) for speed: */
9821
         pm.ngamma_tests = 2U;
9822 9823 9824
         pm.test_gamma_threshold = 1;
         pm.test_gamma_transform = 1;
         pm.test_gamma_sbit = 1;
9825
         pm.test_gamma_scale16 = 1;
9826 9827
         pm.test_gamma_background = 1;
         pm.test_gamma_alpha_mode = 1;
9828 9829
         }

9830
      else if (strcmp(*argv, "--nogamma") == 0)
9831
         pm.ngamma_tests = 0;
9832

9833
      else if (strcmp(*argv, "--gamma-threshold") == 0)
9834
         pm.ngamma_tests = 2U, pm.test_gamma_threshold = 1;
9835

9836
      else if (strcmp(*argv, "--nogamma-threshold") == 0)
9837
         pm.test_gamma_threshold = 0;
9838

9839
      else if (strcmp(*argv, "--gamma-transform") == 0)
9840
         pm.ngamma_tests = 2U, pm.test_gamma_transform = 1;
9841

9842
      else if (strcmp(*argv, "--nogamma-transform") == 0)
9843
         pm.test_gamma_transform = 0;
9844

9845
      else if (strcmp(*argv, "--gamma-sbit") == 0)
9846
         pm.ngamma_tests = 2U, pm.test_gamma_sbit = 1;
9847

9848
      else if (strcmp(*argv, "--nogamma-sbit") == 0)
9849
         pm.test_gamma_sbit = 0;
9850

9851
      else if (strcmp(*argv, "--gamma-16-to-8") == 0)
9852
         pm.ngamma_tests = 2U, pm.test_gamma_scale16 = 1;
9853

9854
      else if (strcmp(*argv, "--nogamma-16-to-8") == 0)
9855
         pm.test_gamma_scale16 = 0;
9856

9857
      else if (strcmp(*argv, "--gamma-background") == 0)
9858
         pm.ngamma_tests = 2U, pm.test_gamma_background = 1;
9859 9860 9861 9862 9863

      else if (strcmp(*argv, "--nogamma-background") == 0)
         pm.test_gamma_background = 0;

      else if (strcmp(*argv, "--gamma-alpha-mode") == 0)
9864
         pm.ngamma_tests = 2U, pm.test_gamma_alpha_mode = 1;
9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875

      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)
9876
         pm.ngamma_tests = 3U;
9877

9878
      else if (strcmp(*argv, "--all-gammas") == 0)
9879
         pm.ngamma_tests = pm.ngammas;
9880

9881 9882 9883
      else if (strcmp(*argv, "--progressive-read") == 0)
         pm.this.progressive = 1;

9884 9885 9886
      else if (strcmp(*argv, "--use-update-info") == 0)
         ++pm.use_update_info; /* Can call multiple times */

9887 9888 9889
      else if (strcmp(*argv, "--interlace") == 0)
         pm.interlace_type = PNG_INTERLACE_ADAM7;

9890 9891 9892
      else if (strcmp(*argv, "--use-input-precision") == 0)
         pm.use_input_precision = 1;

9893 9894 9895 9896 9897
      else if (strcmp(*argv, "--calculations-use-input-precision") == 0)
         pm.calculations_use_input_precision = 1;

      else if (strcmp(*argv, "--assume-16-bit-calculations") == 0)
         pm.assume_16_bit_calculations = 1;
9898

9899 9900 9901
      else if (strcmp(*argv, "--calculations-follow-bit-depth") == 0)
         pm.calculations_use_input_precision =
            pm.assume_16_bit_calculations = 0;
9902

9903 9904 9905
      else if (strcmp(*argv, "--exhaustive") == 0)
         pm.test_exhaustive = 1;

9906 9907
      else if (argc > 1 && strcmp(*argv, "--sbitlow") == 0)
         --argc, pm.sbitlow = (png_byte)atoi(*++argv), catmore = 1;
9908

9909 9910 9911 9912
      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 已提交
9913 9914
      {
         --argc;
9915

9916
         if (strcmp(5+*argv, "abs8") == 0)
9917
            pm.maxabs8 = atof(*++argv);
9918

9919
         else if (strcmp(5+*argv, "abs16") == 0)
9920
            pm.maxabs16 = atof(*++argv);
9921

9922 9923 9924 9925 9926 9927 9928
         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)
9929
            pm.maxout8 = atof(*++argv);
9930

9931
         else if (strcmp(5+*argv, "out16") == 0)
9932
            pm.maxout16 = atof(*++argv);
9933

9934
         else if (strcmp(5+*argv, "pc8") == 0)
9935
            pm.maxpc8 = atof(*++argv);
9936

9937
         else if (strcmp(5+*argv, "pc16") == 0)
9938
            pm.maxpc16 = atof(*++argv);
9939

9940 9941 9942 9943 9944
         else
         {
            fprintf(stderr, "pngvalid: %s: unknown 'max' option\n", *argv);
            exit(1);
         }
9945 9946

         catmore = 1;
G
[devel]  
Glenn Randers-Pehrson 已提交
9947
      }
9948

9949 9950 9951 9952 9953 9954
      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;

G
[devel]  
Glenn Randers-Pehrson 已提交
9955 9956 9957
      else
      {
         fprintf(stderr, "pngvalid: %s: unknown argument\n", *argv);
9958
         exit(1);
G
[devel]  
Glenn Randers-Pehrson 已提交
9959
      }
9960 9961 9962 9963 9964 9965

      if (catmore) /* consumed an extra *argv */
      {
         cp = safecat(command, sizeof command, cp, " ");
         cp = safecat(command, sizeof command, cp, *argv);
      }
9966
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
9967

9968 9969 9970 9971
   /* 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 &&
9972
      pm.ngamma_tests == 0)
9973
   {
9974 9975 9976 9977 9978
      /* 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.
       */
9979 9980 9981
      pm.test_standard = 1;
      pm.test_size = 1;
      pm.test_transform = 1;
9982
      pm.ngamma_tests = 2U;
9983 9984
   }

9985
   if (pm.ngamma_tests > 0 &&
9986
      pm.test_gamma_threshold == 0 && pm.test_gamma_transform == 0 &&
9987
      pm.test_gamma_sbit == 0 && pm.test_gamma_scale16 == 0 &&
9988
      pm.test_gamma_background == 0 && pm.test_gamma_alpha_mode == 0)
9989 9990 9991 9992
   {
      pm.test_gamma_threshold = 1;
      pm.test_gamma_transform = 1;
      pm.test_gamma_sbit = 1;
9993
      pm.test_gamma_scale16 = 1;
9994 9995
      pm.test_gamma_background = 1;
      pm.test_gamma_alpha_mode = 1;
9996
   }
9997

9998
   else if (pm.ngamma_tests == 0)
9999 10000 10001 10002 10003
   {
      /* Nothing to test so turn everything off: */
      pm.test_gamma_threshold = 0;
      pm.test_gamma_transform = 0;
      pm.test_gamma_sbit = 0;
10004
      pm.test_gamma_scale16 = 0;
10005 10006
      pm.test_gamma_background = 0;
      pm.test_gamma_alpha_mode = 0;
10007 10008
   }

10009 10010 10011
   Try
   {
      /* Make useful base images */
10012
      make_transform_images(&pm.this);
10013 10014

      /* Perform the standard and gamma tests. */
10015
      if (pm.test_standard)
10016
      {
10017
         perform_interlace_macro_validation();
10018
         perform_formatting_test(&pm.this);
10019 10020 10021
#        ifdef PNG_READ_SUPPORTED
            perform_standard_test(&pm);
#        endif
10022 10023 10024
         perform_error_test(&pm);
      }

10025 10026 10027 10028
      /* Various oddly sized images: */
      if (pm.test_size)
      {
         make_size_images(&pm.this);
10029 10030 10031
#        ifdef PNG_READ_SUPPORTED
            perform_size_test(&pm);
#        endif
10032 10033
      }

10034
#ifdef PNG_READ_TRANSFORMS_SUPPORTED
10035 10036 10037
      /* Combinatorial transforms: */
      if (pm.test_transform)
         perform_transform_test(&pm);
10038
#endif /* PNG_READ_TRANSFORMS_SUPPORTED */
10039

10040
#ifdef PNG_READ_GAMMA_SUPPORTED
10041
      if (pm.ngamma_tests > 0)
10042
         perform_gamma_test(&pm, summary);
10043
#endif
10044 10045
   }

10046
   Catch_anonymous
10047
   {
10048
      fprintf(stderr, "pngvalid: test aborted (probably failed in cleanup)\n");
10049 10050 10051 10052
      if (!pm.this.verbose)
      {
         if (pm.this.error[0] != 0)
            fprintf(stderr, "pngvalid: first error: %s\n", pm.this.error);
10053

10054 10055
         fprintf(stderr, "pngvalid: run with -v to see what happened\n");
      }
10056 10057
      exit(1);
   }
G
[devel]  
Glenn Randers-Pehrson 已提交
10058

10059
   if (summary)
10060
   {
10061
      printf("%s: %s (%s point arithmetic)\n",
10062 10063 10064
         (pm.this.nerrors || (pm.this.treat_warnings_as_errors &&
            pm.this.nwarnings)) ? "FAIL" : "PASS",
         command,
G
[devel]  
Glenn Randers-Pehrson 已提交
10065
#if defined(PNG_FLOATING_ARITHMETIC_SUPPORTED) || PNG_LIBPNG_VER < 10500
10066
         "floating"
G
[devel]  
Glenn Randers-Pehrson 已提交
10067
#else
10068
         "fixed"
G
[devel]  
Glenn Randers-Pehrson 已提交
10069
#endif
10070
         );
10071 10072 10073 10074
   }

   if (memstats)
   {
10075
      printf("Allocated memory statistics (in bytes):\n"
10076 10077 10078 10079 10080 10081 10082 10083
         "\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);
10084 10085 10086 10087 10088 10089
   }

   /* 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 已提交
10090 10091 10092 10093

   /* Error exit if there are any errors, and maybe if there are any
    * warnings.
    */
10094 10095
   if (pm.this.nerrors || (pm.this.treat_warnings_as_errors &&
       pm.this.nwarnings))
G
[devel]  
Glenn Randers-Pehrson 已提交
10096 10097 10098
   {
      if (!pm.this.verbose)
         fprintf(stderr, "pngvalid: %s\n", pm.this.error);
10099

G
[devel]  
Glenn Randers-Pehrson 已提交
10100
      fprintf(stderr, "pngvalid: %d errors, %d warnings\n", pm.this.nerrors,
10101 10102
          pm.this.nwarnings);

G
[devel]  
Glenn Randers-Pehrson 已提交
10103 10104 10105
      exit(1);
   }

10106 10107 10108 10109
   /* Success case. */
   if (touch != NULL)
   {
      FILE *fsuccess = fopen(touch, "wt");
10110

10111 10112 10113 10114 10115 10116
      if (fsuccess != NULL)
      {
         int error = 0;
         fprintf(fsuccess, "PNG validation succeeded\n");
         fflush(fsuccess);
         error = ferror(fsuccess);
10117

10118 10119 10120 10121 10122 10123
         if (fclose(fsuccess) || error)
         {
            fprintf(stderr, "%s: write failed\n", touch);
            exit(1);
         }
      }
10124 10125 10126 10127 10128 10129

      else
      {
         fprintf(stderr, "%s: open failed\n", touch);
         exit(1);
      }
10130 10131
   }

G
[devel]  
Glenn Randers-Pehrson 已提交
10132 10133
   return 0;
}
10134 10135 10136 10137 10138 10139 10140
#else /* write not supported */
int main(void)
{
   fprintf(stderr, "pngvalid: no write support in libpng, all tests skipped\n");
   return 0;
}
#endif