2 /* pngunknown.c - test the read side unknown chunk handling
4 * Last changed in libpng 1.6.10 [March 6, 2014]
5 * Copyright (c) 2014 Glenn Randers-Pehrson
6 * Written by John Cunningham Bowler
8 * This code is released under the libpng license.
9 * For conditions of distribution and use, see the disclaimer
10 * and license in png.h
13 * This is a C program that is intended to be linked against libpng. It
14 * allows the libpng unknown handling code to be tested by interpreting
15 * arguments to save or discard combinations of chunks. The program is
16 * currently just a minimal validation for the built-in libpng facilities.
24 /* Define the following to use this test against your installed libpng, rather
25 * than the one being built here:
27 #ifdef PNG_FREESTANDING_TESTS
30 # include "../../png.h"
33 /* Since this program tests the ability to change the unknown chunk handling
34 * these must be defined:
36 #if defined(PNG_SET_UNKNOWN_CHUNKS_SUPPORTED) &&\
37 defined(PNG_READ_SUPPORTED)
39 /* One of these must be defined to allow us to find out what happened. It is
40 * still useful to set unknown chunk handling without either of these in order
41 * to cause *known* chunks to be discarded. This can be a significant
42 * efficiency gain, but it can't really be tested here.
44 #if defined(PNG_READ_USER_CHUNKS_SUPPORTED) ||\
45 defined(PNG_SAVE_UNKNOWN_CHUNKS_SUPPORTED)
47 #if PNG_LIBPNG_VER < 10500
48 /* This deliberately lacks the PNG_CONST. */
49 typedef png_byte
*png_const_bytep
;
51 /* This is copied from 1.5.1 png.h: */
52 #define PNG_INTERLACE_ADAM7_PASSES 7
53 #define PNG_PASS_START_ROW(pass) (((1U&~(pass))<<(3-((pass)>>1)))&7)
54 #define PNG_PASS_START_COL(pass) (((1U& (pass))<<(3-(((pass)+1)>>1)))&7)
55 #define PNG_PASS_ROW_SHIFT(pass) ((pass)>2?(8-(pass))>>1:3)
56 #define PNG_PASS_COL_SHIFT(pass) ((pass)>1?(7-(pass))>>1:3)
57 #define PNG_PASS_ROWS(height, pass) (((height)+(((1<<PNG_PASS_ROW_SHIFT(pass))\
58 -1)-PNG_PASS_START_ROW(pass)))>>PNG_PASS_ROW_SHIFT(pass))
59 #define PNG_PASS_COLS(width, pass) (((width)+(((1<<PNG_PASS_COL_SHIFT(pass))\
60 -1)-PNG_PASS_START_COL(pass)))>>PNG_PASS_COL_SHIFT(pass))
61 #define PNG_ROW_FROM_PASS_ROW(yIn, pass) \
62 (((yIn)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass))
63 #define PNG_COL_FROM_PASS_COL(xIn, pass) \
64 (((xIn)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass))
65 #define PNG_PASS_MASK(pass,off) ( \
66 ((0x110145AFU>>(((7-(off))-(pass))<<2)) & 0xFU) | \
67 ((0x01145AF0U>>(((7-(off))-(pass))<<2)) & 0xF0U))
68 #define PNG_ROW_IN_INTERLACE_PASS(y, pass) \
69 ((PNG_PASS_MASK(pass,0) >> ((y)&7)) & 1)
70 #define PNG_COL_IN_INTERLACE_PASS(x, pass) \
71 ((PNG_PASS_MASK(pass,1) >> ((x)&7)) & 1)
73 /* These are needed too for the default build: */
74 #define PNG_WRITE_16BIT_SUPPORTED
75 #define PNG_READ_16BIT_SUPPORTED
77 /* This comes from pnglibconf.h afer 1.5: */
78 #define PNG_FP_1 100000
79 #define PNG_GAMMA_THRESHOLD_FIXED\
80 ((png_fixed_point)(PNG_GAMMA_THRESHOLD * PNG_FP_1))
83 #if PNG_LIBPNG_VER < 10600
84 /* 1.6.0 constifies many APIs. The following exists to allow pngvalid to be
85 * compiled against earlier versions.
87 # define png_const_structp png_structp
90 #if PNG_LIBPNG_VER < 10700
91 /* Copied from libpng 1.7.0 png.h */
92 #define PNG_u2(b1, b2) (((unsigned int)(b1) << 8) + (b2))
94 #define PNG_U16(b1, b2) ((png_uint_16)PNG_u2(b1, b2))
95 #define PNG_U32(b1, b2, b3, b4)\
96 (((png_uint_32)PNG_u2(b1, b2) << 16) + PNG_u2(b3, b4))
98 /* Constants for known chunk types.
100 #define png_IDAT PNG_U32( 73, 68, 65, 84)
101 #define png_IEND PNG_U32( 73, 69, 78, 68)
102 #define png_IHDR PNG_U32( 73, 72, 68, 82)
103 #define png_PLTE PNG_U32( 80, 76, 84, 69)
104 #define png_bKGD PNG_U32( 98, 75, 71, 68)
105 #define png_cHRM PNG_U32( 99, 72, 82, 77)
106 #define png_fRAc PNG_U32(102, 82, 65, 99) /* registered, not defined */
107 #define png_gAMA PNG_U32(103, 65, 77, 65)
108 #define png_gIFg PNG_U32(103, 73, 70, 103)
109 #define png_gIFt PNG_U32(103, 73, 70, 116) /* deprecated */
110 #define png_gIFx PNG_U32(103, 73, 70, 120)
111 #define png_hIST PNG_U32(104, 73, 83, 84)
112 #define png_iCCP PNG_U32(105, 67, 67, 80)
113 #define png_iTXt PNG_U32(105, 84, 88, 116)
114 #define png_oFFs PNG_U32(111, 70, 70, 115)
115 #define png_pCAL PNG_U32(112, 67, 65, 76)
116 #define png_pHYs PNG_U32(112, 72, 89, 115)
117 #define png_sBIT PNG_U32(115, 66, 73, 84)
118 #define png_sCAL PNG_U32(115, 67, 65, 76)
119 #define png_sPLT PNG_U32(115, 80, 76, 84)
120 #define png_sRGB PNG_U32(115, 82, 71, 66)
121 #define png_sTER PNG_U32(115, 84, 69, 82)
122 #define png_tEXt PNG_U32(116, 69, 88, 116)
123 #define png_tIME PNG_U32(116, 73, 77, 69)
124 #define png_tRNS PNG_U32(116, 82, 78, 83)
125 #define png_zTXt PNG_U32(122, 84, 88, 116)
127 /* Test on flag values as defined in the spec (section 5.4): */
128 #define PNG_CHUNK_ANCILLARY(c) (1 & ((c) >> 29))
129 #define PNG_CHUNK_CRITICAL(c) (!PNG_CHUNK_ANCILLARY(c))
130 #define PNG_CHUNK_PRIVATE(c) (1 & ((c) >> 21))
131 #define PNG_CHUNK_RESERVED(c) (1 & ((c) >> 13))
132 #define PNG_CHUNK_SAFE_TO_COPY(c) (1 & ((c) >> 5))
134 #endif /* PNG_LIBPNG_VER < 10700 */
137 # define this not_the_cpp_this
138 # define new not_the_cpp_new
139 # define voidcast(type, value) static_cast<type>(value)
141 # define voidcast(type, value) (value)
142 #endif /* __cplusplus */
144 /* Unused formal parameter errors are removed using the following macro which is
145 * expected to have no bad effects on performance.
148 # if defined(__GNUC__) || defined(_MSC_VER)
149 # define UNUSED(param) (void)param;
151 # define UNUSED(param)
155 /* Types of chunks not known to libpng */
156 #define png_vpAg PNG_U32(118, 112, 65, 103)
158 /* Chunk information */
159 #define PNG_INFO_tEXt 0x10000000U
160 #define PNG_INFO_iTXt 0x20000000U
161 #define PNG_INFO_zTXt 0x40000000U
163 #define PNG_INFO_sTER 0x01000000U
164 #define PNG_INFO_vpAg 0x02000000U
175 int unknown
; /* Chunk not known to libpng */
176 int all
; /* Chunk set by the '-1' option */
177 int position
; /* position in pngtest.png */
178 int keep
; /* unknown handling setting */
180 /* Critical chunks */
181 { "IDAT", PNG_INFO_IDAT
, png_IDAT
, 0, 0, START
, 0 }, /* must be [0] */
182 { "PLTE", PNG_INFO_PLTE
, png_PLTE
, 0, 0, ABSENT
, 0 },
184 /* Non-critical chunks that libpng handles */
185 /* This is a mess but it seems to be the only way to do it - there is no way
186 * to check for a definition outside a #if.
188 { "bKGD", PNG_INFO_bKGD
, png_bKGD
,
189 # ifdef PNG_READ_bKGD_SUPPORTED
195 { "cHRM", PNG_INFO_cHRM
, png_cHRM
,
196 # ifdef PNG_READ_cHRM_SUPPORTED
202 { "gAMA", PNG_INFO_gAMA
, png_gAMA
,
203 # ifdef PNG_READ_gAMA_SUPPORTED
209 { "hIST", PNG_INFO_hIST
, png_hIST
,
210 # ifdef PNG_READ_hIST_SUPPORTED
216 { "iCCP", PNG_INFO_iCCP
, png_iCCP
,
217 # ifdef PNG_READ_iCCP_SUPPORTED
223 { "iTXt", PNG_INFO_iTXt
, png_iTXt
,
224 # ifdef PNG_READ_iTXt_SUPPORTED
230 { "oFFs", PNG_INFO_oFFs
, png_oFFs
,
231 # ifdef PNG_READ_oFFs_SUPPORTED
237 { "pCAL", PNG_INFO_pCAL
, png_pCAL
,
238 # ifdef PNG_READ_pCAL_SUPPORTED
244 { "pHYs", PNG_INFO_pHYs
, png_pHYs
,
245 # ifdef PNG_READ_pHYs_SUPPORTED
251 { "sBIT", PNG_INFO_sBIT
, png_sBIT
,
252 # ifdef PNG_READ_sBIT_SUPPORTED
258 { "sCAL", PNG_INFO_sCAL
, png_sCAL
,
259 # ifdef PNG_READ_sCAL_SUPPORTED
265 { "sPLT", PNG_INFO_sPLT
, png_sPLT
,
266 # ifdef PNG_READ_sPLT_SUPPORTED
272 { "sRGB", PNG_INFO_sRGB
, png_sRGB
,
273 # ifdef PNG_READ_sRGB_SUPPORTED
279 { "tEXt", PNG_INFO_tEXt
, png_tEXt
,
280 # ifdef PNG_READ_tEXt_SUPPORTED
286 { "tIME", PNG_INFO_tIME
, png_tIME
,
287 # ifdef PNG_READ_tIME_SUPPORTED
293 { "tRNS", PNG_INFO_tRNS
, png_tRNS
,
294 # ifdef PNG_READ_tRNS_SUPPORTED
300 { "zTXt", PNG_INFO_zTXt
, png_zTXt
,
301 # ifdef PNG_READ_zTXt_SUPPORTED
308 /* No libpng handling */
309 { "sTER", PNG_INFO_sTER
, png_sTER
, 1, 1, START
, 0 },
310 { "vpAg", PNG_INFO_vpAg
, png_vpAg
, 1, 0, START
, 0 },
313 #define NINFO ((int)((sizeof chunk_info)/(sizeof chunk_info[0])))
320 chunk_info
[i
].keep
= 0;
324 find(const char *name
)
329 if (memcmp(chunk_info
[i
].name
, name
, 4) == 0)
337 findb(const png_byte
*name
)
342 if (memcmp(chunk_info
[i
].name
, name
, 4) == 0)
350 find_by_flag(png_uint_32 flag
)
354 while (--i
>= 0) if (chunk_info
[i
].flag
== flag
) return i
;
356 fprintf(stderr
, "pngunknown: internal error\n");
361 ancillary(const char *name
)
363 return PNG_CHUNK_ANCILLARY(PNG_U32(name
[0], name
[1], name
[2], name
[3]));
366 #ifdef PNG_SAVE_UNKNOWN_CHUNKS_SUPPORTED
368 ancillaryb(const png_byte
*name
)
370 return PNG_CHUNK_ANCILLARY(PNG_U32(name
[0], name
[1], name
[2], name
[3]));
374 /* Type of an error_ptr */
377 jmp_buf error_return
;
379 png_infop info_ptr
, end_ptr
;
380 png_uint_32 before_IDAT
;
381 png_uint_32 after_IDAT
;
384 int keep
; /* the default value */
390 static const char init
[] = "initialization";
391 static const char cmd
[] = "command line";
394 init_display(display
*d
, const char *program
)
396 memset(d
, 0, sizeof *d
);
398 d
->info_ptr
= d
->end_ptr
= NULL
;
399 d
->error_count
= d
->warning_count
= 0;
400 d
->program
= program
;
406 clean_display(display
*d
)
408 png_destroy_read_struct(&d
->png_ptr
, &d
->info_ptr
, &d
->end_ptr
);
410 /* This must not happen - it might cause an app crash */
411 if (d
->png_ptr
!= NULL
|| d
->info_ptr
!= NULL
|| d
->end_ptr
!= NULL
)
413 fprintf(stderr
, "%s(%s): png_destroy_read_struct error\n", d
->file
,
419 PNG_FUNCTION(void, display_exit
, (display
*d
), static PNG_NORETURN
)
423 if (d
->png_ptr
!= NULL
)
426 /* During initialization and if this is a single command line argument set
427 * exit now - there is only one test, otherwise longjmp to do the next test.
429 if (d
->test
== init
|| d
->test
== cmd
)
432 longjmp(d
->error_return
, 1);
436 display_rc(const display
*d
, int strict
)
438 return d
->error_count
+ (strict
? d
->warning_count
: 0);
441 /* libpng error and warning callbacks */
442 PNG_FUNCTION(void, (PNGCBAPI error
), (png_structp png_ptr
, const char *message
),
445 display
*d
= (display
*)png_get_error_ptr(png_ptr
);
447 fprintf(stderr
, "%s(%s): libpng error: %s\n", d
->file
, d
->test
, message
);
452 warning(png_structp png_ptr
, const char *message
)
454 display
*d
= (display
*)png_get_error_ptr(png_ptr
);
456 fprintf(stderr
, "%s(%s): libpng warning: %s\n", d
->file
, d
->test
, message
);
457 ++(d
->warning_count
);
461 get_valid(display
*d
, png_infop info_ptr
)
463 png_uint_32 flags
= png_get_valid(d
->png_ptr
, info_ptr
, (png_uint_32
)~0);
465 /* Map the text chunks back into the flags */
468 png_uint_32 ntext
= png_get_text(d
->png_ptr
, info_ptr
, &text
, NULL
);
470 while (ntext
-- > 0) switch (text
[ntext
].compression
)
473 flags
|= PNG_INFO_tEXt
;
476 flags
|= PNG_INFO_zTXt
;
480 flags
|= PNG_INFO_iTXt
;
483 fprintf(stderr
, "%s(%s): unknown text compression %d\n", d
->file
,
484 d
->test
, text
[ntext
].compression
);
492 #ifdef PNG_READ_USER_CHUNKS_SUPPORTED
494 read_callback(png_structp pp
, png_unknown_chunkp pc
)
496 /* This function mimics the behavior of png_set_keep_unknown_chunks by
497 * returning '0' to keep the chunk and '1' to discard it.
499 display
*d
= voidcast(display
*, png_get_user_chunk_ptr(pp
));
500 int chunk
= findb(pc
->name
);
503 if (chunk
< 0) /* not one in our list, so not a known chunk */
508 keep
= chunk_info
[chunk
].keep
;
509 if (keep
== PNG_HANDLE_CHUNK_AS_DEFAULT
)
511 /* See the comments in png.h - use the default for unknown chunks,
512 * do not keep known chunks.
514 if (chunk_info
[chunk
].unknown
)
518 keep
= PNG_HANDLE_CHUNK_NEVER
;
525 fprintf(stderr
, "%s(%s): %d: unrecognized chunk option\n", d
->file
,
526 d
->test
, chunk_info
[chunk
].keep
);
529 case PNG_HANDLE_CHUNK_AS_DEFAULT
:
530 case PNG_HANDLE_CHUNK_NEVER
:
531 discard
= 1/*handled; discard*/;
534 case PNG_HANDLE_CHUNK_IF_SAFE
:
535 case PNG_HANDLE_CHUNK_ALWAYS
:
536 discard
= 0/*not handled; keep*/;
540 /* Also store information about this chunk in the display, the relevant flag
541 * is set if the chunk is to be kept ('not handled'.)
543 if (chunk
>= 0) if (!discard
) /* stupidity to stop a GCC warning */
545 png_uint_32 flag
= chunk_info
[chunk
].flag
;
547 if (pc
->location
& PNG_AFTER_IDAT
)
548 d
->after_IDAT
|= flag
;
551 d
->before_IDAT
|= flag
;
554 /* However if there is no support to store unknown chunks don't ask libpng to
555 * do it; there will be an png_error.
557 # ifdef PNG_SAVE_UNKNOWN_CHUNKS_SUPPORTED
560 return 1; /*handled; discard*/
563 #endif /* READ_USER_CHUNKS_SUPPORTED */
565 #ifdef PNG_SAVE_UNKNOWN_CHUNKS_SUPPORTED
567 get_unknown(display
*d
, png_infop info_ptr
, int after_IDAT
)
569 /* Create corresponding 'unknown' flags */
570 png_uint_32 flags
= 0;
575 png_unknown_chunkp unknown
;
576 int num_unknown
= png_get_unknown_chunks(d
->png_ptr
, info_ptr
, &unknown
);
578 while (--num_unknown
>= 0)
580 int chunk
= findb(unknown
[num_unknown
].name
);
582 /* Chunks not known to pngunknown must be validated here; since they
583 * must also be unknown to libpng the 'display->keep' behavior should
586 if (chunk
< 0) switch (d
->keep
)
588 default: /* impossible */
589 case PNG_HANDLE_CHUNK_AS_DEFAULT
:
590 case PNG_HANDLE_CHUNK_NEVER
:
591 fprintf(stderr
, "%s(%s): %s: %s: unknown chunk saved\n",
592 d
->file
, d
->test
, d
->keep
? "discard" : "default",
593 unknown
[num_unknown
].name
);
597 case PNG_HANDLE_CHUNK_IF_SAFE
:
598 if (!ancillaryb(unknown
[num_unknown
].name
))
601 "%s(%s): if-safe: %s: unknown critical chunk saved\n",
602 d
->file
, d
->test
, unknown
[num_unknown
].name
);
606 /* FALL THROUGH (safe) */
607 case PNG_HANDLE_CHUNK_ALWAYS
:
612 flags
|= chunk_info
[chunk
].flag
;
620 get_unknown(display
*d
, png_infop info_ptr
, int after_IDAT
)
621 /* Otherwise this will return the cached values set by any user callback */
626 return d
->after_IDAT
;
629 return d
->before_IDAT
;
632 # ifndef PNG_READ_USER_CHUNKS_SUPPORTED
633 /* The #defines above should mean this is never reached, it's just here as
634 * a check to ensure the logic is correct.
636 # error No store support and no user chunk support, this will not work
641 check(FILE *fp
, int argc
, const char **argv
, png_uint_32p flags
/*out*/,
642 display
*d
, int set_callback
)
644 int i
, npasses
, ipass
;
647 d
->keep
= PNG_HANDLE_CHUNK_AS_DEFAULT
;
651 /* Some of these errors are permanently fatal and cause an exit here, others
652 * are per-test and cause an error return.
654 d
->png_ptr
= png_create_read_struct(PNG_LIBPNG_VER_STRING
, d
, error
,
656 if (d
->png_ptr
== NULL
)
658 fprintf(stderr
, "%s(%s): could not allocate png struct\n", d
->file
,
660 /* Terminate here, this error is not test specific. */
664 d
->info_ptr
= png_create_info_struct(d
->png_ptr
);
665 d
->end_ptr
= png_create_info_struct(d
->png_ptr
);
666 if (d
->info_ptr
== NULL
|| d
->end_ptr
== NULL
)
668 fprintf(stderr
, "%s(%s): could not allocate png info\n", d
->file
,
674 png_init_io(d
->png_ptr
, fp
);
676 # ifdef PNG_READ_USER_CHUNKS_SUPPORTED
677 /* This is only done if requested by the caller; it interferes with the
678 * standard store/save mechanism.
681 png_set_read_user_chunk_fn(d
->png_ptr
, d
, read_callback
);
686 /* Handle each argument in turn; multiple settings are possible for the same
687 * chunk and multiple calls will occur (the last one should override all
690 for (i
=0; i
<argc
; ++i
)
692 const char *equals
= strchr(argv
[i
], '=');
698 if (strcmp(equals
+1, "default") == 0)
699 option
= PNG_HANDLE_CHUNK_AS_DEFAULT
;
700 else if (strcmp(equals
+1, "discard") == 0)
701 option
= PNG_HANDLE_CHUNK_NEVER
;
702 else if (strcmp(equals
+1, "if-safe") == 0)
703 option
= PNG_HANDLE_CHUNK_IF_SAFE
;
704 else if (strcmp(equals
+1, "save") == 0)
705 option
= PNG_HANDLE_CHUNK_ALWAYS
;
708 fprintf(stderr
, "%s(%s): %s: unrecognized chunk option\n", d
->file
,
713 switch (equals
- argv
[i
])
715 case 4: /* chunk name */
716 chunk
= find(argv
[i
]);
720 /* These #if tests have the effect of skipping the arguments
721 * if SAVE support is unavailable - we can't do a useful test
722 * in this case, so we just check the arguments! This could
723 * be improved in the future by using the read callback.
725 # if PNG_LIBPNG_VER >= 10700 &&\
726 !defined(PNG_SAVE_UNKNOWN_CHUNKS_SUPPORTED)
727 if (option
< PNG_HANDLE_CHUNK_IF_SAFE
)
728 # endif /* 1.7+ SAVE_UNKNOWN_CHUNKS */
732 memcpy(name
, chunk_info
[chunk
].name
, 5);
733 png_set_keep_unknown_chunks(d
->png_ptr
, option
, name
, 1);
734 chunk_info
[chunk
].keep
= option
;
741 case 7: /* default */
742 if (memcmp(argv
[i
], "default", 7) == 0)
744 # if PNG_LIBPNG_VER >= 10700 &&\
745 !defined(PNG_SAVE_UNKNOWN_CHUNKS_SUPPORTED)
746 if (option
< PNG_HANDLE_CHUNK_IF_SAFE
)
747 # endif /* 1.7+ SAVE_UNKNOWN_CHUNKS */
748 png_set_keep_unknown_chunks(d
->png_ptr
, option
, NULL
, 0);
757 if (memcmp(argv
[i
], "all", 3) == 0)
759 # if PNG_LIBPNG_VER >= 10700 &&\
760 !defined(PNG_SAVE_UNKNOWN_CHUNKS_SUPPORTED)
761 if (option
< PNG_HANDLE_CHUNK_IF_SAFE
)
762 # endif /* 1.7+ SAVE_UNKNOWN_CHUNKS */
763 png_set_keep_unknown_chunks(d
->png_ptr
, option
, NULL
, -1);
767 for (chunk
= 0; chunk
< NINFO
; ++chunk
)
768 if (chunk_info
[chunk
].all
)
769 chunk_info
[chunk
].keep
= option
;
775 default: /* some misplaced = */
781 fprintf(stderr
, "%s(%s): %s: unrecognized chunk argument\n", d
->file
,
786 png_read_info(d
->png_ptr
, d
->info_ptr
);
788 switch (png_get_interlace_type(d
->png_ptr
, d
->info_ptr
))
790 case PNG_INTERLACE_NONE
:
794 case PNG_INTERLACE_ADAM7
:
795 npasses
= PNG_INTERLACE_ADAM7_PASSES
;
799 /* Hard error because it is not test specific */
800 fprintf(stderr
, "%s(%s): invalid interlace type\n", d
->file
, d
->test
);
805 /* Skip the image data, if IDAT is not being handled then don't do this
806 * because it will cause a CRC error.
808 if (chunk_info
[0/*IDAT*/].keep
== PNG_HANDLE_CHUNK_AS_DEFAULT
)
810 png_start_read_image(d
->png_ptr
);
811 height
= png_get_image_height(d
->png_ptr
, d
->info_ptr
);
815 png_uint_32 width
= png_get_image_width(d
->png_ptr
, d
->info_ptr
);
817 for (ipass
=0; ipass
<npasses
; ++ipass
)
819 png_uint_32 wPass
= PNG_PASS_COLS(width
, ipass
);
825 for (y
=0; y
<height
; ++y
) if (PNG_ROW_IN_INTERLACE_PASS(y
, ipass
))
826 png_read_row(d
->png_ptr
, NULL
, NULL
);
831 else /* not interlaced */
835 for (y
=0; y
<height
; ++y
)
836 png_read_row(d
->png_ptr
, NULL
, NULL
);
840 png_read_end(d
->png_ptr
, d
->end_ptr
);
842 flags
[0] = get_valid(d
, d
->info_ptr
);
843 flags
[1] = get_unknown(d
, d
->info_ptr
, 0/*before IDAT*/);
845 /* Only png_read_png sets PNG_INFO_IDAT! */
846 flags
[chunk_info
[0/*IDAT*/].keep
!= PNG_HANDLE_CHUNK_AS_DEFAULT
] |=
849 flags
[2] = get_valid(d
, d
->end_ptr
);
850 flags
[3] = get_unknown(d
, d
->end_ptr
, 1/*after IDAT*/);
858 check_error(display
*d
, png_uint_32 flags
, const char *message
)
862 png_uint_32 flag
= flags
& -(png_int_32
)flags
;
863 int i
= find_by_flag(flag
);
865 fprintf(stderr
, "%s(%s): chunk %s: %s\n", d
->file
, d
->test
,
866 chunk_info
[i
].name
, message
);
874 check_handling(display
*d
, int def
, png_uint_32 chunks
, png_uint_32 known
,
875 png_uint_32 unknown
, const char *position
, int set_callback
)
879 png_uint_32 flag
= chunks
& -(png_int_32
)chunks
;
880 int i
= find_by_flag(flag
);
881 int keep
= chunk_info
[i
].keep
;
883 const char *errorx
= NULL
;
885 if (chunk_info
[i
].unknown
)
887 if (keep
== PNG_HANDLE_CHUNK_AS_DEFAULT
)
889 type
= "UNKNOWN (default)";
894 type
= "UNKNOWN (specified)";
897 errorx
= "chunk processed";
901 case PNG_HANDLE_CHUNK_AS_DEFAULT
:
903 errorx
= "DEFAULT: unknown chunk saved";
906 case PNG_HANDLE_CHUNK_NEVER
:
908 errorx
= "DISCARD: unknown chunk saved";
911 case PNG_HANDLE_CHUNK_IF_SAFE
:
912 if (ancillary(chunk_info
[i
].name
))
914 if (!(flag
& unknown
))
915 errorx
= "IF-SAFE: unknown ancillary chunk lost";
918 else if (flag
& unknown
)
919 errorx
= "IF-SAFE: unknown critical chunk saved";
922 case PNG_HANDLE_CHUNK_ALWAYS
:
923 if (!(flag
& unknown
))
924 errorx
= "SAVE: unknown chunk lost";
928 errorx
= "internal error: bad keep";
931 } /* unknown chunk */
933 else /* known chunk */
939 /* chunk was processed, it won't have been saved because that is
940 * caught below when checking for inconsistent processing.
942 if (keep
!= PNG_HANDLE_CHUNK_AS_DEFAULT
)
943 errorx
= "!DEFAULT: known chunk processed";
946 else /* not processed */ switch (keep
)
948 case PNG_HANDLE_CHUNK_AS_DEFAULT
:
949 errorx
= "DEFAULT: known chunk not processed";
952 case PNG_HANDLE_CHUNK_NEVER
:
954 errorx
= "DISCARD: known chunk saved";
957 case PNG_HANDLE_CHUNK_IF_SAFE
:
958 if (ancillary(chunk_info
[i
].name
))
960 if (!(flag
& unknown
))
961 errorx
= "IF-SAFE: known ancillary chunk lost";
964 else if (flag
& unknown
)
965 errorx
= "IF-SAFE: known critical chunk saved";
968 case PNG_HANDLE_CHUNK_ALWAYS
:
969 if (!(flag
& unknown
))
970 errorx
= "SAVE: known chunk lost";
974 errorx
= "internal error: bad keep (2)";
982 fprintf(stderr
, "%s(%s%s): %s %s %s: %s\n", d
->file
, d
->test
,
983 set_callback
? ",callback" : "",
984 type
, chunk_info
[i
].name
, position
, errorx
);
992 perform_one_test(FILE *fp
, int argc
, const char **argv
,
993 png_uint_32
*default_flags
, display
*d
, int set_callback
)
996 png_uint_32 flags
[2][4];
1000 memcpy(flags
[0], default_flags
, sizeof flags
[0]);
1002 def
= check(fp
, argc
, argv
, flags
[1], d
, set_callback
);
1004 /* Chunks should either be known or unknown, never both and this should apply
1005 * whether the chunk is before or after the IDAT (actually, the app can
1006 * probably change this by swapping the handling after the image, but this
1007 * test does not do that.)
1009 check_error(d
, (flags
[0][0]|flags
[0][2]) & (flags
[0][1]|flags
[0][3]),
1010 "chunk handled inconsistently in count tests");
1011 check_error(d
, (flags
[1][0]|flags
[1][2]) & (flags
[1][1]|flags
[1][3]),
1012 "chunk handled inconsistently in option tests");
1014 /* Now find out what happened to each chunk before and after the IDAT and
1015 * determine if the behavior was correct. First some basic sanity checks,
1016 * any known chunk should be known in the original count, any unknown chunk
1017 * should be either known or unknown in the original.
1022 test
= flags
[1][0] & ~flags
[0][0];
1023 check_error(d
, test
, "new known chunk before IDAT");
1024 test
= flags
[1][1] & ~(flags
[0][0] | flags
[0][1]);
1025 check_error(d
, test
, "new unknown chunk before IDAT");
1026 test
= flags
[1][2] & ~flags
[0][2];
1027 check_error(d
, test
, "new known chunk after IDAT");
1028 test
= flags
[1][3] & ~(flags
[0][2] | flags
[0][3]);
1029 check_error(d
, test
, "new unknown chunk after IDAT");
1032 /* Now each chunk in the original list should have been handled according to
1033 * the options set for that chunk, regardless of whether libpng knows about
1036 check_handling(d
, def
, flags
[0][0] | flags
[0][1], flags
[1][0], flags
[1][1],
1037 "before IDAT", set_callback
);
1038 check_handling(d
, def
, flags
[0][2] | flags
[0][3], flags
[1][2], flags
[1][3],
1039 "after IDAT", set_callback
);
1043 perform_one_test_safe(FILE *fp
, int argc
, const char **argv
,
1044 png_uint_32
*default_flags
, display
*d
, const char *test
)
1046 if (setjmp(d
->error_return
) == 0)
1048 d
->test
= test
; /* allow use of d->error_return */
1049 # ifdef PNG_SAVE_UNKNOWN_CHUNKS_SUPPORTED
1050 perform_one_test(fp
, argc
, argv
, default_flags
, d
, 0);
1052 # ifdef PNG_READ_USER_CHUNKS_SUPPORTED
1053 perform_one_test(fp
, argc
, argv
, default_flags
, d
, 1);
1055 d
->test
= init
; /* prevent use of d->error_return */
1059 static const char *standard_tests
[] =
1061 "discard", "default=discard", 0,
1062 "save", "default=save", 0,
1063 "if-safe", "default=if-safe", 0,
1064 "vpAg", "vpAg=if-safe", 0,
1065 "sTER", "sTER=if-safe", 0,
1066 "IDAT", "default=discard", "IDAT=save", 0,
1067 "sAPI", "bKGD=save", "cHRM=save", "gAMA=save", "all=discard", "iCCP=save",
1068 "sBIT=save", "sRGB=save", 0,
1072 static PNG_NORETURN
void
1073 usage(const char *program
, const char *reason
)
1075 fprintf(stderr
, "pngunknown: %s: usage:\n %s [--strict] "
1076 "--default|{(CHNK|default|all)=(default|discard|if-safe|save)} "
1077 "testfile.png\n", reason
, program
);
1082 main(int argc
, const char **argv
)
1085 png_uint_32 default_flags
[4/*valid,unknown{before,after}*/];
1086 int strict
= 0, default_tests
= 0;
1087 const char *count_argv
= "default=save";
1088 const char *touch_file
= NULL
;
1091 init_display(&d
, argv
[0]);
1093 while (++argv
, --argc
> 0)
1095 if (strcmp(*argv
, "--strict") == 0)
1098 else if (strcmp(*argv
, "--default") == 0)
1101 else if (strcmp(*argv
, "--touch") == 0)
1104 touch_file
= *++argv
, --argc
;
1107 usage(d
.program
, "--touch: missing file name");
1114 /* A file name is required, but there should be no other arguments if
1115 * --default was specified.
1118 usage(d
.program
, "missing test file");
1120 /* GCC BUG: if (default_tests && argc != 1) triggers some weird GCC argc
1121 * optimization which causes warnings with -Wstrict-overflow!
1123 else if (default_tests
) if (argc
!= 1)
1124 usage(d
.program
, "extra arguments");
1126 /* The name of the test file is the last argument; remove it. */
1127 d
.file
= argv
[--argc
];
1129 fp
= fopen(d
.file
, "rb");
1136 /* First find all the chunks, known and unknown, in the test file, a failure
1137 * here aborts the whole test.
1139 * If 'save' is supported then the normal saving method should happen,
1140 * otherwise if 'read' is supported then the read callback will do the
1141 * same thing. If both are supported the 'read' callback won't be
1142 * instantiated by default. If 'save' is *not* supported then a user
1143 * callback is required even though we can call png_get_unknown_chunks.
1145 if (check(fp
, 1, &count_argv
, default_flags
, &d
,
1146 # ifdef PNG_SAVE_UNKNOWN_CHUNKS_SUPPORTED
1151 ) != PNG_HANDLE_CHUNK_ALWAYS
)
1153 fprintf(stderr
, "%s: %s: internal error\n", d
.program
, d
.file
);
1157 /* Now find what the various supplied options cause to change: */
1160 d
.test
= cmd
; /* acts as a flag to say exit, do not longjmp */
1161 # ifdef PNG_SAVE_UNKNOWN_CHUNKS_SUPPORTED
1162 perform_one_test(fp
, argc
, argv
, default_flags
, &d
, 0);
1164 # ifdef PNG_READ_USER_CHUNKS_SUPPORTED
1165 perform_one_test(fp
, argc
, argv
, default_flags
, &d
, 1);
1172 const char **test
= standard_tests
;
1174 /* Set the exit_test pointer here so we can continue after a libpng error.
1175 * NOTE: this leaks memory because the png_struct data from the failing
1176 * test is never freed.
1180 const char *this_test
= *test
++;
1181 const char **next
= test
;
1182 int count
= display_rc(&d
, strict
), new_count
;
1186 while (*next
) ++next
, ++arg_count
;
1188 perform_one_test_safe(fp
, arg_count
, test
, default_flags
, &d
,
1191 new_count
= display_rc(&d
, strict
);
1193 if (new_count
== count
)
1199 printf("%s: %s %s\n", result
, d
.program
, this_test
);
1207 if (display_rc(&d
, strict
) == 0)
1209 /* Success, touch the success file if appropriate */
1210 if (touch_file
!= NULL
)
1212 FILE *fsuccess
= fopen(touch_file
, "wt");
1214 if (fsuccess
!= NULL
)
1217 fprintf(fsuccess
, "PNG unknown tests succeeded\n");
1219 err
= ferror(fsuccess
);
1221 if (fclose(fsuccess
) || err
)
1223 fprintf(stderr
, "%s: write failed\n", touch_file
);
1230 fprintf(stderr
, "%s: open failed\n", touch_file
);
1241 #else /* !(READ_USER_CHUNKS || SAVE_UNKNOWN_CHUNKS) */
1246 " test ignored: no support to find out about unknown chunks\n");
1247 /* So the test is skipped: */
1250 #endif /* READ_USER_CHUNKS || SAVE_UNKNOWN_CHUNKS */
1252 #else /* !(SET_UNKNOWN_CHUNKS && READ) */
1257 " test ignored: no support to modify unknown chunk handling\n");
1258 /* So the test is skipped: */
1261 #endif /* SET_UNKNOWN_CHUNKS && READ*/