2 /* pngwutil.c - utilities to write a PNG file
4 * Last changed in libpng 1.6.17 [March 26, 2015]
5 * Copyright (c) 1998-2015 Glenn Randers-Pehrson
6 * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)
7 * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
9 * This code is released under the libpng license.
10 * For conditions of distribution and use, see the disclaimer
11 * and license in png.h
16 #ifdef PNG_WRITE_SUPPORTED
18 #ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
19 /* Place a 32-bit number into a buffer in PNG byte order. We work
20 * with unsigned numbers for convenience, although one supported
21 * ancillary chunk uses signed (two's complement) numbers.
24 png_save_uint_32(png_bytep buf, png_uint_32 i)
26 buf[0] = (png_byte)(i >> 24);
27 buf[1] = (png_byte)(i >> 16);
28 buf[2] = (png_byte)(i >> 8);
29 buf[3] = (png_byte)(i );
32 /* Place a 16-bit number into a buffer in PNG byte order.
33 * The parameter is declared unsigned int, not png_uint_16,
34 * just to avoid potential problems on pre-ANSI C compilers.
37 png_save_uint_16(png_bytep buf, unsigned int i)
39 buf[0] = (png_byte)(i >> 8);
40 buf[1] = (png_byte)(i );
44 /* Simple function to write the signature. If we have already written
45 * the magic bytes of the signature, or more likely, the PNG stream is
46 * being embedded into another stream and doesn't need its own signature,
47 * we should call png_set_sig_bytes() to tell libpng how many of the
48 * bytes have already been written.
51 png_write_sig(png_structrp png_ptr)
53 png_byte png_signature[8] = {137, 80, 78, 71, 13, 10, 26, 10};
55 #ifdef PNG_IO_STATE_SUPPORTED
56 /* Inform the I/O callback that the signature is being written */
57 png_ptr->io_state = PNG_IO_WRITING | PNG_IO_SIGNATURE;
60 /* Write the rest of the 8 byte signature */
61 png_write_data(png_ptr, &png_signature[png_ptr->sig_bytes],
62 (png_size_t)(8 - png_ptr->sig_bytes));
64 if (png_ptr->sig_bytes < 3)
65 png_ptr->mode |= PNG_HAVE_PNG_SIGNATURE;
68 /* Write the start of a PNG chunk. The type is the chunk type.
69 * The total_length is the sum of the lengths of all the data you will be
70 * passing in png_write_chunk_data().
73 png_write_chunk_header(png_structrp png_ptr, png_uint_32 chunk_name,
78 #if defined(PNG_DEBUG) && (PNG_DEBUG > 0)
79 PNG_CSTRING_FROM_CHUNK(buf, chunk_name);
80 png_debug2(0, "Writing %s chunk, length = %lu", buf, (unsigned long)length);
86 #ifdef PNG_IO_STATE_SUPPORTED
87 /* Inform the I/O callback that the chunk header is being written.
88 * PNG_IO_CHUNK_HDR requires a single I/O call.
90 png_ptr->io_state = PNG_IO_WRITING | PNG_IO_CHUNK_HDR;
93 /* Write the length and the chunk name */
94 png_save_uint_32(buf, length);
95 png_save_uint_32(buf + 4, chunk_name);
96 png_write_data(png_ptr, buf, 8);
98 /* Put the chunk name into png_ptr->chunk_name */
99 png_ptr->chunk_name = chunk_name;
101 /* Reset the crc and run it over the chunk name */
102 png_reset_crc(png_ptr);
104 png_calculate_crc(png_ptr, buf + 4, 4);
106 #ifdef PNG_IO_STATE_SUPPORTED
107 /* Inform the I/O callback that chunk data will (possibly) be written.
108 * PNG_IO_CHUNK_DATA does NOT require a specific number of I/O calls.
110 png_ptr->io_state = PNG_IO_WRITING | PNG_IO_CHUNK_DATA;
115 png_write_chunk_start(png_structrp png_ptr, png_const_bytep chunk_string,
118 png_write_chunk_header(png_ptr, PNG_CHUNK_FROM_STRING(chunk_string), length);
121 /* Write the data of a PNG chunk started with png_write_chunk_header().
122 * Note that multiple calls to this function are allowed, and that the
123 * sum of the lengths from these calls *must* add up to the total_length
124 * given to png_write_chunk_header().
127 png_write_chunk_data(png_structrp png_ptr, png_const_bytep data,
130 /* Write the data, and run the CRC over it */
134 if (data != NULL && length > 0)
136 png_write_data(png_ptr, data, length);
138 /* Update the CRC after writing the data,
139 * in case the user I/O routine alters it.
141 png_calculate_crc(png_ptr, data, length);
145 /* Finish a chunk started with png_write_chunk_header(). */
147 png_write_chunk_end(png_structrp png_ptr)
151 if (png_ptr == NULL) return;
153 #ifdef PNG_IO_STATE_SUPPORTED
154 /* Inform the I/O callback that the chunk CRC is being written.
155 * PNG_IO_CHUNK_CRC requires a single I/O function call.
157 png_ptr->io_state = PNG_IO_WRITING | PNG_IO_CHUNK_CRC;
160 /* Write the crc in a single operation */
161 png_save_uint_32(buf, png_ptr->crc);
163 png_write_data(png_ptr, buf, (png_size_t)4);
166 /* Write a PNG chunk all at once. The type is an array of ASCII characters
167 * representing the chunk name. The array must be at least 4 bytes in
168 * length, and does not need to be null terminated. To be safe, pass the
169 * pre-defined chunk names here, and if you need a new one, define it
170 * where the others are defined. The length is the length of the data.
171 * All the data must be present. If that is not possible, use the
172 * png_write_chunk_start(), png_write_chunk_data(), and png_write_chunk_end()
176 png_write_complete_chunk(png_structrp png_ptr, png_uint_32 chunk_name,
177 png_const_bytep data, png_size_t length)
182 /* On 64 bit architectures 'length' may not fit in a png_uint_32. */
183 if (length > PNG_UINT_31_MAX)
184 png_error(png_ptr, "length exceeds PNG maximum");
186 png_write_chunk_header(png_ptr, chunk_name, (png_uint_32)length);
187 png_write_chunk_data(png_ptr, data, length);
188 png_write_chunk_end(png_ptr);
191 /* This is the API that calls the internal function above. */
193 png_write_chunk(png_structrp png_ptr, png_const_bytep chunk_string,
194 png_const_bytep data, png_size_t length)
196 png_write_complete_chunk(png_ptr, PNG_CHUNK_FROM_STRING(chunk_string), data,
200 /* This is used below to find the size of an image to pass to png_deflate_claim,
201 * so it only needs to be accurate if the size is less than 16384 bytes (the
202 * point at which a lower LZ window size can be used.)
204 static png_alloc_size_t
205 png_image_size(png_structrp png_ptr)
207 /* Only return sizes up to the maximum of a png_uint_32; do this by limiting
208 * the width and height used to 15 bits.
210 png_uint_32 h = png_ptr->height;
212 if (png_ptr->rowbytes < 32768 && h < 32768)
214 if (png_ptr->interlaced != 0)
216 /* Interlacing makes the image larger because of the replication of
217 * both the filter byte and the padding to a byte boundary.
219 png_uint_32 w = png_ptr->width;
220 unsigned int pd = png_ptr->pixel_depth;
221 png_alloc_size_t cb_base;
224 for (cb_base=0, pass=0; pass<=6; ++pass)
226 png_uint_32 pw = PNG_PASS_COLS(w, pass);
229 cb_base += (PNG_ROWBYTES(pd, pw)+1) * PNG_PASS_ROWS(h, pass);
236 return (png_ptr->rowbytes+1) * h;
243 #ifdef PNG_WRITE_OPTIMIZE_CMF_SUPPORTED
244 /* This is the code to hack the first two bytes of the deflate stream (the
245 * deflate header) to correct the windowBits value to match the actual data
246 * size. Note that the second argument is the *uncompressed* size but the
247 * first argument is the *compressed* data (and it must be deflate
251 optimize_cmf(png_bytep data, png_alloc_size_t data_size)
253 /* Optimize the CMF field in the zlib stream. The resultant zlib stream is
254 * still compliant to the stream specification.
256 if (data_size <= 16384) /* else windowBits must be 15 */
258 unsigned int z_cmf = data[0]; /* zlib compression method and flags */
260 if ((z_cmf & 0x0f) == 8 && (z_cmf & 0xf0) <= 0x70)
262 unsigned int z_cinfo;
263 unsigned int half_z_window_size;
265 z_cinfo = z_cmf >> 4;
266 half_z_window_size = 1U << (z_cinfo + 7);
268 if (data_size <= half_z_window_size) /* else no change */
274 half_z_window_size >>= 1;
277 while (z_cinfo > 0 && data_size <= half_z_window_size);
279 z_cmf = (z_cmf & 0x0f) | (z_cinfo << 4);
281 data[0] = (png_byte)z_cmf;
282 tmp = data[1] & 0xe0;
283 tmp += 0x1f - ((z_cmf << 8) + tmp) % 0x1f;
284 data[1] = (png_byte)tmp;
289 #endif /* WRITE_OPTIMIZE_CMF */
291 /* Initialize the compressor for the appropriate type of compression. */
293 png_deflate_claim(png_structrp png_ptr, png_uint_32 owner,
294 png_alloc_size_t data_size)
296 if (png_ptr->zowner != 0)
298 #if defined(PNG_WARNINGS_SUPPORTED) || defined(PNG_ERROR_TEXT_SUPPORTED)
301 PNG_STRING_FROM_CHUNK(msg, owner);
304 PNG_STRING_FROM_CHUNK(msg+6, png_ptr->zowner);
305 /* So the message that results is "<chunk> using zstream"; this is an
306 * internal error, but is very useful for debugging. i18n requirements
309 (void)png_safecat(msg, (sizeof msg), 10, " using zstream");
311 #if PNG_LIBPNG_BUILD_BASE_TYPE >= PNG_LIBPNG_BUILD_RC
312 png_warning(png_ptr, msg);
314 /* Attempt sane error recovery */
315 if (png_ptr->zowner == png_IDAT) /* don't steal from IDAT */
317 png_ptr->zstream.msg = PNGZ_MSG_CAST("in use by IDAT");
318 return Z_STREAM_ERROR;
323 png_error(png_ptr, msg);
328 int level = png_ptr->zlib_level;
329 int method = png_ptr->zlib_method;
330 int windowBits = png_ptr->zlib_window_bits;
331 int memLevel = png_ptr->zlib_mem_level;
332 int strategy; /* set below */
333 int ret; /* zlib return code */
335 if (owner == png_IDAT)
337 if ((png_ptr->flags & PNG_FLAG_ZLIB_CUSTOM_STRATEGY) != 0)
338 strategy = png_ptr->zlib_strategy;
340 else if (png_ptr->do_filter != PNG_FILTER_NONE)
341 strategy = PNG_Z_DEFAULT_STRATEGY;
344 strategy = PNG_Z_DEFAULT_NOFILTER_STRATEGY;
349 #ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED
350 level = png_ptr->zlib_text_level;
351 method = png_ptr->zlib_text_method;
352 windowBits = png_ptr->zlib_text_window_bits;
353 memLevel = png_ptr->zlib_text_mem_level;
354 strategy = png_ptr->zlib_text_strategy;
356 /* If customization is not supported the values all come from the
357 * IDAT values except for the strategy, which is fixed to the
358 * default. (This is the pre-1.6.0 behavior too, although it was
359 * implemented in a very different way.)
361 strategy = Z_DEFAULT_STRATEGY;
365 /* Adjust 'windowBits' down if larger than 'data_size'; to stop this
366 * happening just pass 32768 as the data_size parameter. Notice that zlib
367 * requires an extra 262 bytes in the window in addition to the data to be
368 * able to see the whole of the data, so if data_size+262 takes us to the
369 * next windowBits size we need to fix up the value later. (Because even
370 * though deflate needs the extra window, inflate does not!)
372 if (data_size <= 16384)
374 /* IMPLEMENTATION NOTE: this 'half_window_size' stuff is only here to
375 * work round a Microsoft Visual C misbehavior which, contrary to C-90,
376 * widens the result of the following shift to 64-bits if (and,
377 * apparently, only if) it is used in a test.
379 unsigned int half_window_size = 1U << (windowBits-1);
381 while (data_size + 262 <= half_window_size)
383 half_window_size >>= 1;
388 /* Check against the previous initialized values, if any. */
389 if ((png_ptr->flags & PNG_FLAG_ZSTREAM_INITIALIZED) != 0 &&
390 (png_ptr->zlib_set_level != level ||
391 png_ptr->zlib_set_method != method ||
392 png_ptr->zlib_set_window_bits != windowBits ||
393 png_ptr->zlib_set_mem_level != memLevel ||
394 png_ptr->zlib_set_strategy != strategy))
396 if (deflateEnd(&png_ptr->zstream) != Z_OK)
397 png_warning(png_ptr, "deflateEnd failed (ignored)");
399 png_ptr->flags &= ~PNG_FLAG_ZSTREAM_INITIALIZED;
402 /* For safety clear out the input and output pointers (currently zlib
403 * doesn't use them on Init, but it might in the future).
405 png_ptr->zstream.next_in = NULL;
406 png_ptr->zstream.avail_in = 0;
407 png_ptr->zstream.next_out = NULL;
408 png_ptr->zstream.avail_out = 0;
410 /* Now initialize if required, setting the new parameters, otherwise just
411 * to a simple reset to the previous parameters.
413 if ((png_ptr->flags & PNG_FLAG_ZSTREAM_INITIALIZED) != 0)
414 ret = deflateReset(&png_ptr->zstream);
418 ret = deflateInit2(&png_ptr->zstream, level, method, windowBits,
422 png_ptr->flags |= PNG_FLAG_ZSTREAM_INITIALIZED;
425 /* The return code is from either deflateReset or deflateInit2; they have
426 * pretty much the same set of error codes.
429 png_ptr->zowner = owner;
432 png_zstream_error(png_ptr, ret);
438 /* Clean up (or trim) a linked list of compression buffers. */
440 png_free_buffer_list(png_structrp png_ptr, png_compression_bufferp *listp)
442 png_compression_bufferp list = *listp;
450 png_compression_bufferp next = list->next;
452 png_free(png_ptr, list);
455 while (list != NULL);
459 #ifdef PNG_WRITE_COMPRESSED_TEXT_SUPPORTED
460 /* This pair of functions encapsulates the operation of (a) compressing a
461 * text string, and (b) issuing it later as a series of chunk data writes.
462 * The compression_state structure is shared context for these functions
463 * set up by the caller to allow access to the relevant local variables.
465 * compression_buffer (new in 1.6.0) is just a linked list of zbuffer_size
466 * temporary buffers. From 1.6.0 it is retained in png_struct so that it will
467 * be correctly freed in the event of a write error (previous implementations
468 * just leaked memory.)
472 png_const_bytep input; /* The uncompressed input data */
473 png_alloc_size_t input_len; /* Its length */
474 png_uint_32 output_len; /* Final compressed length */
475 png_byte output[1024]; /* First block of output */
479 png_text_compress_init(compression_state *comp, png_const_bytep input,
480 png_alloc_size_t input_len)
483 comp->input_len = input_len;
484 comp->output_len = 0;
487 /* Compress the data in the compression state input */
489 png_text_compress(png_structrp png_ptr, png_uint_32 chunk_name,
490 compression_state *comp, png_uint_32 prefix_len)
494 /* To find the length of the output it is necessary to first compress the
495 * input. The result is buffered rather than using the two-pass algorithm
496 * that is used on the inflate side; deflate is assumed to be slower and a
497 * PNG writer is assumed to have more memory available than a PNG reader.
499 * IMPLEMENTATION NOTE: the zlib API deflateBound() can be used to find an
500 * upper limit on the output size, but it is always bigger than the input
501 * size so it is likely to be more efficient to use this linked-list
504 ret = png_deflate_claim(png_ptr, chunk_name, comp->input_len);
509 /* Set up the compression buffers, we need a loop here to avoid overflowing a
510 * uInt. Use ZLIB_IO_MAX to limit the input. The output is always limited
511 * by the output buffer size, so there is no need to check that. Since this
512 * is ANSI-C we know that an 'int', hence a uInt, is always at least 16 bits
516 png_compression_bufferp *end = &png_ptr->zbuffer_list;
517 png_alloc_size_t input_len = comp->input_len; /* may be zero! */
518 png_uint_32 output_len;
520 /* zlib updates these for us: */
521 png_ptr->zstream.next_in = PNGZ_INPUT_CAST(comp->input);
522 png_ptr->zstream.avail_in = 0; /* Set below */
523 png_ptr->zstream.next_out = comp->output;
524 png_ptr->zstream.avail_out = (sizeof comp->output);
526 output_len = png_ptr->zstream.avail_out;
530 uInt avail_in = ZLIB_IO_MAX;
532 if (avail_in > input_len)
533 avail_in = (uInt)input_len;
535 input_len -= avail_in;
537 png_ptr->zstream.avail_in = avail_in;
539 if (png_ptr->zstream.avail_out == 0)
541 png_compression_buffer *next;
543 /* Chunk data is limited to 2^31 bytes in length, so the prefix
544 * length must be counted here.
546 if (output_len + prefix_len > PNG_UINT_31_MAX)
552 /* Need a new (malloc'ed) buffer, but there may be one present
558 next = png_voidcast(png_compression_bufferp, png_malloc_base
559 (png_ptr, PNG_COMPRESSION_BUFFER_SIZE(png_ptr)));
567 /* Link in this buffer (so that it will be freed later) */
572 png_ptr->zstream.next_out = next->output;
573 png_ptr->zstream.avail_out = png_ptr->zbuffer_size;
574 output_len += png_ptr->zstream.avail_out;
576 /* Move 'end' to the next buffer pointer. */
580 /* Compress the data */
581 ret = deflate(&png_ptr->zstream,
582 input_len > 0 ? Z_NO_FLUSH : Z_FINISH);
584 /* Claw back input data that was not consumed (because avail_in is
585 * reset above every time round the loop).
587 input_len += png_ptr->zstream.avail_in;
588 png_ptr->zstream.avail_in = 0; /* safety */
592 /* There may be some space left in the last output buffer. This needs to
593 * be subtracted from output_len.
595 output_len -= png_ptr->zstream.avail_out;
596 png_ptr->zstream.avail_out = 0; /* safety */
597 comp->output_len = output_len;
599 /* Now double check the output length, put in a custom message if it is
600 * too long. Otherwise ensure the z_stream::msg pointer is set to
603 if (output_len + prefix_len >= PNG_UINT_31_MAX)
605 png_ptr->zstream.msg = PNGZ_MSG_CAST("compressed data too long");
610 png_zstream_error(png_ptr, ret);
612 /* Reset zlib for another zTXt/iTXt or image data */
615 /* The only success case is Z_STREAM_END, input_len must be 0; if not this
616 * is an internal error.
618 if (ret == Z_STREAM_END && input_len == 0)
620 #ifdef PNG_WRITE_OPTIMIZE_CMF_SUPPORTED
621 /* Fix up the deflate header, if required */
622 optimize_cmf(comp->output, comp->input_len);
624 /* But Z_OK is returned, not Z_STREAM_END; this allows the claim
625 * function above to return Z_STREAM_END on an error (though it never
626 * does in the current versions of zlib.)
636 /* Ship the compressed text out via chunk writes */
638 png_write_compressed_data_out(png_structrp png_ptr, compression_state *comp)
640 png_uint_32 output_len = comp->output_len;
641 png_const_bytep output = comp->output;
642 png_uint_32 avail = (sizeof comp->output);
643 png_compression_buffer *next = png_ptr->zbuffer_list;
647 if (avail > output_len)
650 png_write_chunk_data(png_ptr, output, avail);
654 if (output_len == 0 || next == NULL)
657 avail = png_ptr->zbuffer_size;
658 output = next->output;
662 /* This is an internal error; 'next' must have been NULL! */
664 png_error(png_ptr, "error writing ancillary chunked compressed data");
666 #endif /* WRITE_COMPRESSED_TEXT */
668 #if defined(PNG_WRITE_TEXT_SUPPORTED) || defined(PNG_WRITE_pCAL_SUPPORTED) || \
669 defined(PNG_WRITE_iCCP_SUPPORTED) || defined(PNG_WRITE_sPLT_SUPPORTED)
670 /* Check that the tEXt or zTXt keyword is valid per PNG 1.0 specification,
671 * and if invalid, correct the keyword rather than discarding the entire
672 * chunk. The PNG 1.0 specification requires keywords 1-79 characters in
673 * length, forbids leading or trailing whitespace, multiple internal spaces,
674 * and the non-break space (0x80) from ISO 8859-1. Returns keyword length.
676 * The 'new_key' buffer must be 80 characters in size (for the keyword plus a
677 * trailing '\0'). If this routine returns 0 then there was no keyword, or a
678 * valid one could not be generated, and the caller must png_error.
681 png_check_keyword(png_structrp png_ptr, png_const_charp key, png_bytep new_key)
683 png_const_charp orig_key = key;
684 png_uint_32 key_len = 0;
685 int bad_character = 0;
688 png_debug(1, "in png_check_keyword");
696 while (*key && key_len < 79)
698 png_byte ch = (png_byte)*key++;
700 if ((ch > 32 && ch <= 126) || (ch >= 161 /*&& ch <= 255*/))
701 *new_key++ = ch, ++key_len, space = 0;
705 /* A space or an invalid character when one wasn't seen immediately
706 * before; output just a space.
708 *new_key++ = 32, ++key_len, space = 1;
710 /* If the character was not a space then it is invalid. */
715 else if (bad_character == 0)
716 bad_character = ch; /* just skip it, record the first error */
719 if (key_len > 0 && space != 0) /* trailing space */
721 --key_len, --new_key;
722 if (bad_character == 0)
726 /* Terminate the keyword */
732 #ifdef PNG_WARNINGS_SUPPORTED
733 /* Try to only output one warning per keyword: */
734 if (*key != 0) /* keyword too long */
735 png_warning(png_ptr, "keyword truncated");
737 else if (bad_character != 0)
739 PNG_WARNING_PARAMETERS(p)
741 png_warning_parameter(p, 1, orig_key);
742 png_warning_parameter_signed(p, 2, PNG_NUMBER_FORMAT_02x, bad_character);
744 png_formatted_warning(png_ptr, p, "keyword \"@1\": bad character '0x@2'");
746 #endif /* WARNINGS */
750 #endif /* WRITE_TEXT || WRITE_pCAL || WRITE_iCCP || WRITE_sPLT */
752 /* Write the IHDR chunk, and update the png_struct with the necessary
753 * information. Note that the rest of this code depends upon this
754 * information being correct.
757 png_write_IHDR(png_structrp png_ptr, png_uint_32 width, png_uint_32 height,
758 int bit_depth, int color_type, int compression_type, int filter_type,
761 png_byte buf[13]; /* Buffer to store the IHDR info */
763 png_debug(1, "in png_write_IHDR");
765 /* Check that we have valid input data from the application info */
768 case PNG_COLOR_TYPE_GRAY:
775 #ifdef PNG_WRITE_16BIT_SUPPORTED
778 png_ptr->channels = 1; break;
782 "Invalid bit depth for grayscale image");
786 case PNG_COLOR_TYPE_RGB:
787 #ifdef PNG_WRITE_16BIT_SUPPORTED
788 if (bit_depth != 8 && bit_depth != 16)
792 png_error(png_ptr, "Invalid bit depth for RGB image");
794 png_ptr->channels = 3;
797 case PNG_COLOR_TYPE_PALETTE:
804 png_ptr->channels = 1;
808 png_error(png_ptr, "Invalid bit depth for paletted image");
812 case PNG_COLOR_TYPE_GRAY_ALPHA:
813 if (bit_depth != 8 && bit_depth != 16)
814 png_error(png_ptr, "Invalid bit depth for grayscale+alpha image");
816 png_ptr->channels = 2;
819 case PNG_COLOR_TYPE_RGB_ALPHA:
820 #ifdef PNG_WRITE_16BIT_SUPPORTED
821 if (bit_depth != 8 && bit_depth != 16)
825 png_error(png_ptr, "Invalid bit depth for RGBA image");
827 png_ptr->channels = 4;
831 png_error(png_ptr, "Invalid image color type specified");
834 if (compression_type != PNG_COMPRESSION_TYPE_BASE)
836 png_warning(png_ptr, "Invalid compression type specified");
837 compression_type = PNG_COMPRESSION_TYPE_BASE;
840 /* Write filter_method 64 (intrapixel differencing) only if
841 * 1. Libpng was compiled with PNG_MNG_FEATURES_SUPPORTED and
842 * 2. Libpng did not write a PNG signature (this filter_method is only
843 * used in PNG datastreams that are embedded in MNG datastreams) and
844 * 3. The application called png_permit_mng_features with a mask that
845 * included PNG_FLAG_MNG_FILTER_64 and
846 * 4. The filter_method is 64 and
847 * 5. The color_type is RGB or RGBA
850 #ifdef PNG_MNG_FEATURES_SUPPORTED
851 !((png_ptr->mng_features_permitted & PNG_FLAG_MNG_FILTER_64) != 0 &&
852 ((png_ptr->mode & PNG_HAVE_PNG_SIGNATURE) == 0) &&
853 (color_type == PNG_COLOR_TYPE_RGB ||
854 color_type == PNG_COLOR_TYPE_RGB_ALPHA) &&
855 (filter_type == PNG_INTRAPIXEL_DIFFERENCING)) &&
857 filter_type != PNG_FILTER_TYPE_BASE)
859 png_warning(png_ptr, "Invalid filter type specified");
860 filter_type = PNG_FILTER_TYPE_BASE;
863 #ifdef PNG_WRITE_INTERLACING_SUPPORTED
864 if (interlace_type != PNG_INTERLACE_NONE &&
865 interlace_type != PNG_INTERLACE_ADAM7)
867 png_warning(png_ptr, "Invalid interlace type specified");
868 interlace_type = PNG_INTERLACE_ADAM7;
871 interlace_type=PNG_INTERLACE_NONE;
874 /* Save the relevant information */
875 png_ptr->bit_depth = (png_byte)bit_depth;
876 png_ptr->color_type = (png_byte)color_type;
877 png_ptr->interlaced = (png_byte)interlace_type;
878 #ifdef PNG_MNG_FEATURES_SUPPORTED
879 png_ptr->filter_type = (png_byte)filter_type;
881 png_ptr->compression_type = (png_byte)compression_type;
882 png_ptr->width = width;
883 png_ptr->height = height;
885 png_ptr->pixel_depth = (png_byte)(bit_depth * png_ptr->channels);
886 png_ptr->rowbytes = PNG_ROWBYTES(png_ptr->pixel_depth, width);
887 /* Set the usr info, so any transformations can modify it */
888 png_ptr->usr_width = png_ptr->width;
889 png_ptr->usr_bit_depth = png_ptr->bit_depth;
890 png_ptr->usr_channels = png_ptr->channels;
892 /* Pack the header information into the buffer */
893 png_save_uint_32(buf, width);
894 png_save_uint_32(buf + 4, height);
895 buf[8] = (png_byte)bit_depth;
896 buf[9] = (png_byte)color_type;
897 buf[10] = (png_byte)compression_type;
898 buf[11] = (png_byte)filter_type;
899 buf[12] = (png_byte)interlace_type;
901 /* Write the chunk */
902 png_write_complete_chunk(png_ptr, png_IHDR, buf, (png_size_t)13);
904 if ((png_ptr->do_filter) == PNG_NO_FILTERS)
906 if (png_ptr->color_type == PNG_COLOR_TYPE_PALETTE ||
907 png_ptr->bit_depth < 8)
908 png_ptr->do_filter = PNG_FILTER_NONE;
911 png_ptr->do_filter = PNG_ALL_FILTERS;
914 png_ptr->mode = PNG_HAVE_IHDR; /* not READY_FOR_ZTXT */
917 /* Write the palette. We are careful not to trust png_color to be in the
918 * correct order for PNG, so people can redefine it to any convenient
922 png_write_PLTE(png_structrp png_ptr, png_const_colorp palette,
926 png_const_colorp pal_ptr;
929 png_debug(1, "in png_write_PLTE");
932 #ifdef PNG_MNG_FEATURES_SUPPORTED
933 (png_ptr->mng_features_permitted & PNG_FLAG_MNG_EMPTY_PLTE) == 0 &&
935 num_pal == 0) || num_pal > 256)
937 if (png_ptr->color_type == PNG_COLOR_TYPE_PALETTE)
939 png_error(png_ptr, "Invalid number of colors in palette");
944 png_warning(png_ptr, "Invalid number of colors in palette");
949 if ((png_ptr->color_type & PNG_COLOR_MASK_COLOR) == 0)
952 "Ignoring request to write a PLTE chunk in grayscale PNG");
957 png_ptr->num_palette = (png_uint_16)num_pal;
958 png_debug1(3, "num_palette = %d", png_ptr->num_palette);
960 png_write_chunk_header(png_ptr, png_PLTE, (png_uint_32)(num_pal * 3));
961 #ifdef PNG_POINTER_INDEXING_SUPPORTED
963 for (i = 0, pal_ptr = palette; i < num_pal; i++, pal_ptr++)
965 buf[0] = pal_ptr->red;
966 buf[1] = pal_ptr->green;
967 buf[2] = pal_ptr->blue;
968 png_write_chunk_data(png_ptr, buf, (png_size_t)3);
972 /* This is a little slower but some buggy compilers need to do this
977 for (i = 0; i < num_pal; i++)
979 buf[0] = pal_ptr[i].red;
980 buf[1] = pal_ptr[i].green;
981 buf[2] = pal_ptr[i].blue;
982 png_write_chunk_data(png_ptr, buf, (png_size_t)3);
986 png_write_chunk_end(png_ptr);
987 png_ptr->mode |= PNG_HAVE_PLTE;
990 /* This is similar to png_text_compress, above, except that it does not require
991 * all of the data at once and, instead of buffering the compressed result,
992 * writes it as IDAT chunks. Unlike png_text_compress it *can* png_error out
993 * because it calls the write interface. As a result it does its own error
994 * reporting and does not return an error code. In the event of error it will
995 * just call png_error. The input data length may exceed 32-bits. The 'flush'
996 * parameter is exactly the same as that to deflate, with the following
999 * Z_NO_FLUSH: normal incremental output of compressed data
1000 * Z_SYNC_FLUSH: do a SYNC_FLUSH, used by png_write_flush
1001 * Z_FINISH: this is the end of the input, do a Z_FINISH and clean up
1003 * The routine manages the acquire and release of the png_ptr->zstream by
1004 * checking and (at the end) clearing png_ptr->zowner; it does some sanity
1005 * checks on the 'mode' flags while doing this.
1008 png_compress_IDAT(png_structrp png_ptr, png_const_bytep input,
1009 png_alloc_size_t input_len, int flush)
1011 if (png_ptr->zowner != png_IDAT)
1013 /* First time. Ensure we have a temporary buffer for compression and
1014 * trim the buffer list if it has more than one entry to free memory.
1015 * If 'WRITE_COMPRESSED_TEXT' is not set the list will never have been
1016 * created at this point, but the check here is quick and safe.
1018 if (png_ptr->zbuffer_list == NULL)
1020 png_ptr->zbuffer_list = png_voidcast(png_compression_bufferp,
1021 png_malloc(png_ptr, PNG_COMPRESSION_BUFFER_SIZE(png_ptr)));
1022 png_ptr->zbuffer_list->next = NULL;
1026 png_free_buffer_list(png_ptr, &png_ptr->zbuffer_list->next);
1028 /* It is a terminal error if we can't claim the zstream. */
1029 if (png_deflate_claim(png_ptr, png_IDAT, png_image_size(png_ptr)) != Z_OK)
1030 png_error(png_ptr, png_ptr->zstream.msg);
1032 /* The output state is maintained in png_ptr->zstream, so it must be
1033 * initialized here after the claim.
1035 png_ptr->zstream.next_out = png_ptr->zbuffer_list->output;
1036 png_ptr->zstream.avail_out = png_ptr->zbuffer_size;
1039 /* Now loop reading and writing until all the input is consumed or an error
1040 * terminates the operation. The _out values are maintained across calls to
1041 * this function, but the input must be reset each time.
1043 png_ptr->zstream.next_in = PNGZ_INPUT_CAST(input);
1044 png_ptr->zstream.avail_in = 0; /* set below */
1049 /* INPUT: from the row data */
1050 uInt avail = ZLIB_IO_MAX;
1052 if (avail > input_len)
1053 avail = (uInt)input_len; /* safe because of the check */
1055 png_ptr->zstream.avail_in = avail;
1058 ret = deflate(&png_ptr->zstream, input_len > 0 ? Z_NO_FLUSH : flush);
1060 /* Include as-yet unconsumed input */
1061 input_len += png_ptr->zstream.avail_in;
1062 png_ptr->zstream.avail_in = 0;
1064 /* OUTPUT: write complete IDAT chunks when avail_out drops to zero. Note
1065 * that these two zstream fields are preserved across the calls, therefore
1066 * there is no need to set these up on entry to the loop.
1068 if (png_ptr->zstream.avail_out == 0)
1070 png_bytep data = png_ptr->zbuffer_list->output;
1071 uInt size = png_ptr->zbuffer_size;
1073 /* Write an IDAT containing the data then reset the buffer. The
1074 * first IDAT may need deflate header optimization.
1076 #ifdef PNG_WRITE_OPTIMIZE_CMF_SUPPORTED
1077 if ((png_ptr->mode & PNG_HAVE_IDAT) == 0 &&
1078 png_ptr->compression_type == PNG_COMPRESSION_TYPE_BASE)
1079 optimize_cmf(data, png_image_size(png_ptr));
1082 png_write_complete_chunk(png_ptr, png_IDAT, data, size);
1083 png_ptr->mode |= PNG_HAVE_IDAT;
1085 png_ptr->zstream.next_out = data;
1086 png_ptr->zstream.avail_out = size;
1088 /* For SYNC_FLUSH or FINISH it is essential to keep calling zlib with
1089 * the same flush parameter until it has finished output, for NO_FLUSH
1090 * it doesn't matter.
1092 if (ret == Z_OK && flush != Z_NO_FLUSH)
1096 /* The order of these checks doesn't matter much; it just affects which
1097 * possible error might be detected if multiple things go wrong at once.
1099 if (ret == Z_OK) /* most likely return code! */
1101 /* If all the input has been consumed then just return. If Z_FINISH
1102 * was used as the flush parameter something has gone wrong if we get
1107 if (flush == Z_FINISH)
1108 png_error(png_ptr, "Z_OK on Z_FINISH with output space");
1114 else if (ret == Z_STREAM_END && flush == Z_FINISH)
1116 /* This is the end of the IDAT data; any pending output must be
1117 * flushed. For small PNG files we may still be at the beginning.
1119 png_bytep data = png_ptr->zbuffer_list->output;
1120 uInt size = png_ptr->zbuffer_size - png_ptr->zstream.avail_out;
1122 #ifdef PNG_WRITE_OPTIMIZE_CMF_SUPPORTED
1123 if ((png_ptr->mode & PNG_HAVE_IDAT) == 0 &&
1124 png_ptr->compression_type == PNG_COMPRESSION_TYPE_BASE)
1125 optimize_cmf(data, png_image_size(png_ptr));
1128 png_write_complete_chunk(png_ptr, png_IDAT, data, size);
1129 png_ptr->zstream.avail_out = 0;
1130 png_ptr->zstream.next_out = NULL;
1131 png_ptr->mode |= PNG_HAVE_IDAT | PNG_AFTER_IDAT;
1133 png_ptr->zowner = 0; /* Release the stream */
1139 /* This is an error condition. */
1140 png_zstream_error(png_ptr, ret);
1141 png_error(png_ptr, png_ptr->zstream.msg);
1146 /* Write an IEND chunk */
1148 png_write_IEND(png_structrp png_ptr)
1150 png_debug(1, "in png_write_IEND");
1152 png_write_complete_chunk(png_ptr, png_IEND, NULL, (png_size_t)0);
1153 png_ptr->mode |= PNG_HAVE_IEND;
1156 #ifdef PNG_WRITE_gAMA_SUPPORTED
1157 /* Write a gAMA chunk */
1159 png_write_gAMA_fixed(png_structrp png_ptr, png_fixed_point file_gamma)
1163 png_debug(1, "in png_write_gAMA");
1165 /* file_gamma is saved in 1/100,000ths */
1166 png_save_uint_32(buf, (png_uint_32)file_gamma);
1167 png_write_complete_chunk(png_ptr, png_gAMA, buf, (png_size_t)4);
1171 #ifdef PNG_WRITE_sRGB_SUPPORTED
1172 /* Write a sRGB chunk */
1174 png_write_sRGB(png_structrp png_ptr, int srgb_intent)
1178 png_debug(1, "in png_write_sRGB");
1180 if (srgb_intent >= PNG_sRGB_INTENT_LAST)
1181 png_warning(png_ptr,
1182 "Invalid sRGB rendering intent specified");
1184 buf[0]=(png_byte)srgb_intent;
1185 png_write_complete_chunk(png_ptr, png_sRGB, buf, (png_size_t)1);
1189 #ifdef PNG_WRITE_iCCP_SUPPORTED
1190 /* Write an iCCP chunk */
1192 png_write_iCCP(png_structrp png_ptr, png_const_charp name,
1193 png_const_bytep profile)
1195 png_uint_32 name_len;
1196 png_uint_32 profile_len;
1197 png_byte new_name[81]; /* 1 byte for the compression byte */
1198 compression_state comp;
1201 png_debug(1, "in png_write_iCCP");
1203 /* These are all internal problems: the profile should have been checked
1204 * before when it was stored.
1206 if (profile == NULL)
1207 png_error(png_ptr, "No profile for iCCP chunk"); /* internal error */
1209 profile_len = png_get_uint_32(profile);
1211 if (profile_len < 132)
1212 png_error(png_ptr, "ICC profile too short");
1214 temp = (png_uint_32) (*(profile+8));
1215 if (temp > 3 && (profile_len & 0x03))
1216 png_error(png_ptr, "ICC profile length invalid (not a multiple of 4)");
1219 png_uint_32 embedded_profile_len = png_get_uint_32(profile);
1221 if (profile_len != embedded_profile_len)
1222 png_error(png_ptr, "Profile length does not match profile");
1225 name_len = png_check_keyword(png_ptr, name, new_name);
1228 png_error(png_ptr, "iCCP: invalid keyword");
1230 new_name[++name_len] = PNG_COMPRESSION_TYPE_BASE;
1232 /* Make sure we include the NULL after the name and the compression type */
1235 png_text_compress_init(&comp, profile, profile_len);
1237 /* Allow for keyword terminator and compression byte */
1238 if (png_text_compress(png_ptr, png_iCCP, &comp, name_len) != Z_OK)
1239 png_error(png_ptr, png_ptr->zstream.msg);
1241 png_write_chunk_header(png_ptr, png_iCCP, name_len + comp.output_len);
1243 png_write_chunk_data(png_ptr, new_name, name_len);
1245 png_write_compressed_data_out(png_ptr, &comp);
1247 png_write_chunk_end(png_ptr);
1251 #ifdef PNG_WRITE_sPLT_SUPPORTED
1252 /* Write a sPLT chunk */
1254 png_write_sPLT(png_structrp png_ptr, png_const_sPLT_tp spalette)
1256 png_uint_32 name_len;
1257 png_byte new_name[80];
1258 png_byte entrybuf[10];
1259 png_size_t entry_size = (spalette->depth == 8 ? 6 : 10);
1260 png_size_t palette_size = entry_size * spalette->nentries;
1262 #ifndef PNG_POINTER_INDEXING_SUPPORTED
1266 png_debug(1, "in png_write_sPLT");
1268 name_len = png_check_keyword(png_ptr, spalette->name, new_name);
1271 png_error(png_ptr, "sPLT: invalid keyword");
1273 /* Make sure we include the NULL after the name */
1274 png_write_chunk_header(png_ptr, png_sPLT,
1275 (png_uint_32)(name_len + 2 + palette_size));
1277 png_write_chunk_data(png_ptr, (png_bytep)new_name,
1278 (png_size_t)(name_len + 1));
1280 png_write_chunk_data(png_ptr, &spalette->depth, (png_size_t)1);
1282 /* Loop through each palette entry, writing appropriately */
1283 #ifdef PNG_POINTER_INDEXING_SUPPORTED
1284 for (ep = spalette->entries; ep<spalette->entries + spalette->nentries; ep++)
1286 if (spalette->depth == 8)
1288 entrybuf[0] = (png_byte)ep->red;
1289 entrybuf[1] = (png_byte)ep->green;
1290 entrybuf[2] = (png_byte)ep->blue;
1291 entrybuf[3] = (png_byte)ep->alpha;
1292 png_save_uint_16(entrybuf + 4, ep->frequency);
1297 png_save_uint_16(entrybuf + 0, ep->red);
1298 png_save_uint_16(entrybuf + 2, ep->green);
1299 png_save_uint_16(entrybuf + 4, ep->blue);
1300 png_save_uint_16(entrybuf + 6, ep->alpha);
1301 png_save_uint_16(entrybuf + 8, ep->frequency);
1304 png_write_chunk_data(png_ptr, entrybuf, entry_size);
1307 ep=spalette->entries;
1308 for (i = 0; i>spalette->nentries; i++)
1310 if (spalette->depth == 8)
1312 entrybuf[0] = (png_byte)ep[i].red;
1313 entrybuf[1] = (png_byte)ep[i].green;
1314 entrybuf[2] = (png_byte)ep[i].blue;
1315 entrybuf[3] = (png_byte)ep[i].alpha;
1316 png_save_uint_16(entrybuf + 4, ep[i].frequency);
1321 png_save_uint_16(entrybuf + 0, ep[i].red);
1322 png_save_uint_16(entrybuf + 2, ep[i].green);
1323 png_save_uint_16(entrybuf + 4, ep[i].blue);
1324 png_save_uint_16(entrybuf + 6, ep[i].alpha);
1325 png_save_uint_16(entrybuf + 8, ep[i].frequency);
1328 png_write_chunk_data(png_ptr, entrybuf, entry_size);
1332 png_write_chunk_end(png_ptr);
1336 #ifdef PNG_WRITE_sBIT_SUPPORTED
1337 /* Write the sBIT chunk */
1339 png_write_sBIT(png_structrp png_ptr, png_const_color_8p sbit, int color_type)
1344 png_debug(1, "in png_write_sBIT");
1346 /* Make sure we don't depend upon the order of PNG_COLOR_8 */
1347 if ((color_type & PNG_COLOR_MASK_COLOR) != 0)
1351 maxbits = (png_byte)(color_type==PNG_COLOR_TYPE_PALETTE ? 8 :
1352 png_ptr->usr_bit_depth);
1354 if (sbit->red == 0 || sbit->red > maxbits ||
1355 sbit->green == 0 || sbit->green > maxbits ||
1356 sbit->blue == 0 || sbit->blue > maxbits)
1358 png_warning(png_ptr, "Invalid sBIT depth specified");
1363 buf[1] = sbit->green;
1364 buf[2] = sbit->blue;
1370 if (sbit->gray == 0 || sbit->gray > png_ptr->usr_bit_depth)
1372 png_warning(png_ptr, "Invalid sBIT depth specified");
1376 buf[0] = sbit->gray;
1380 if ((color_type & PNG_COLOR_MASK_ALPHA) != 0)
1382 if (sbit->alpha == 0 || sbit->alpha > png_ptr->usr_bit_depth)
1384 png_warning(png_ptr, "Invalid sBIT depth specified");
1388 buf[size++] = sbit->alpha;
1391 png_write_complete_chunk(png_ptr, png_sBIT, buf, size);
1395 #ifdef PNG_WRITE_cHRM_SUPPORTED
1396 /* Write the cHRM chunk */
1398 png_write_cHRM_fixed(png_structrp png_ptr, const png_xy *xy)
1402 png_debug(1, "in png_write_cHRM");
1404 /* Each value is saved in 1/100,000ths */
1405 png_save_int_32(buf, xy->whitex);
1406 png_save_int_32(buf + 4, xy->whitey);
1408 png_save_int_32(buf + 8, xy->redx);
1409 png_save_int_32(buf + 12, xy->redy);
1411 png_save_int_32(buf + 16, xy->greenx);
1412 png_save_int_32(buf + 20, xy->greeny);
1414 png_save_int_32(buf + 24, xy->bluex);
1415 png_save_int_32(buf + 28, xy->bluey);
1417 png_write_complete_chunk(png_ptr, png_cHRM, buf, 32);
1421 #ifdef PNG_WRITE_tRNS_SUPPORTED
1422 /* Write the tRNS chunk */
1424 png_write_tRNS(png_structrp png_ptr, png_const_bytep trans_alpha,
1425 png_const_color_16p tran, int num_trans, int color_type)
1429 png_debug(1, "in png_write_tRNS");
1431 if (color_type == PNG_COLOR_TYPE_PALETTE)
1433 if (num_trans <= 0 || num_trans > (int)png_ptr->num_palette)
1435 png_app_warning(png_ptr,
1436 "Invalid number of transparent colors specified");
1440 /* Write the chunk out as it is */
1441 png_write_complete_chunk(png_ptr, png_tRNS, trans_alpha,
1442 (png_size_t)num_trans);
1445 else if (color_type == PNG_COLOR_TYPE_GRAY)
1447 /* One 16 bit value */
1448 if (tran->gray >= (1 << png_ptr->bit_depth))
1450 png_app_warning(png_ptr,
1451 "Ignoring attempt to write tRNS chunk out-of-range for bit_depth");
1456 png_save_uint_16(buf, tran->gray);
1457 png_write_complete_chunk(png_ptr, png_tRNS, buf, (png_size_t)2);
1460 else if (color_type == PNG_COLOR_TYPE_RGB)
1462 /* Three 16 bit values */
1463 png_save_uint_16(buf, tran->red);
1464 png_save_uint_16(buf + 2, tran->green);
1465 png_save_uint_16(buf + 4, tran->blue);
1466 #ifdef PNG_WRITE_16BIT_SUPPORTED
1467 if (png_ptr->bit_depth == 8 && (buf[0] | buf[2] | buf[4]) != 0)
1469 if ((buf[0] | buf[2] | buf[4]) != 0)
1472 png_app_warning(png_ptr,
1473 "Ignoring attempt to write 16-bit tRNS chunk when bit_depth is 8");
1477 png_write_complete_chunk(png_ptr, png_tRNS, buf, (png_size_t)6);
1482 png_app_warning(png_ptr, "Can't write tRNS with an alpha channel");
1487 #ifdef PNG_WRITE_bKGD_SUPPORTED
1488 /* Write the background chunk */
1490 png_write_bKGD(png_structrp png_ptr, png_const_color_16p back, int color_type)
1494 png_debug(1, "in png_write_bKGD");
1496 if (color_type == PNG_COLOR_TYPE_PALETTE)
1499 #ifdef PNG_MNG_FEATURES_SUPPORTED
1500 (png_ptr->num_palette != 0 ||
1501 (png_ptr->mng_features_permitted & PNG_FLAG_MNG_EMPTY_PLTE) == 0) &&
1503 back->index >= png_ptr->num_palette)
1505 png_warning(png_ptr, "Invalid background palette index");
1509 buf[0] = back->index;
1510 png_write_complete_chunk(png_ptr, png_bKGD, buf, (png_size_t)1);
1513 else if ((color_type & PNG_COLOR_MASK_COLOR) != 0)
1515 png_save_uint_16(buf, back->red);
1516 png_save_uint_16(buf + 2, back->green);
1517 png_save_uint_16(buf + 4, back->blue);
1518 #ifdef PNG_WRITE_16BIT_SUPPORTED
1519 if (png_ptr->bit_depth == 8 && (buf[0] | buf[2] | buf[4]) != 0)
1521 if ((buf[0] | buf[2] | buf[4]) != 0)
1524 png_warning(png_ptr,
1525 "Ignoring attempt to write 16-bit bKGD chunk when bit_depth is 8");
1530 png_write_complete_chunk(png_ptr, png_bKGD, buf, (png_size_t)6);
1535 if (back->gray >= (1 << png_ptr->bit_depth))
1537 png_warning(png_ptr,
1538 "Ignoring attempt to write bKGD chunk out-of-range for bit_depth");
1543 png_save_uint_16(buf, back->gray);
1544 png_write_complete_chunk(png_ptr, png_bKGD, buf, (png_size_t)2);
1549 #ifdef PNG_WRITE_hIST_SUPPORTED
1550 /* Write the histogram */
1552 png_write_hIST(png_structrp png_ptr, png_const_uint_16p hist, int num_hist)
1557 png_debug(1, "in png_write_hIST");
1559 if (num_hist > (int)png_ptr->num_palette)
1561 png_debug2(3, "num_hist = %d, num_palette = %d", num_hist,
1562 png_ptr->num_palette);
1564 png_warning(png_ptr, "Invalid number of histogram entries specified");
1568 png_write_chunk_header(png_ptr, png_hIST, (png_uint_32)(num_hist * 2));
1570 for (i = 0; i < num_hist; i++)
1572 png_save_uint_16(buf, hist[i]);
1573 png_write_chunk_data(png_ptr, buf, (png_size_t)2);
1576 png_write_chunk_end(png_ptr);
1580 #ifdef PNG_WRITE_tEXt_SUPPORTED
1581 /* Write a tEXt chunk */
1583 png_write_tEXt(png_structrp png_ptr, png_const_charp key, png_const_charp text,
1584 png_size_t text_len)
1586 png_uint_32 key_len;
1587 png_byte new_key[80];
1589 png_debug(1, "in png_write_tEXt");
1591 key_len = png_check_keyword(png_ptr, key, new_key);
1594 png_error(png_ptr, "tEXt: invalid keyword");
1596 if (text == NULL || *text == '\0')
1600 text_len = strlen(text);
1602 if (text_len > PNG_UINT_31_MAX - (key_len+1))
1603 png_error(png_ptr, "tEXt: text too long");
1605 /* Make sure we include the 0 after the key */
1606 png_write_chunk_header(png_ptr, png_tEXt,
1607 (png_uint_32)/*checked above*/(key_len + text_len + 1));
1609 * We leave it to the application to meet PNG-1.0 requirements on the
1610 * contents of the text. PNG-1.0 through PNG-1.2 discourage the use of
1611 * any non-Latin-1 characters except for NEWLINE. ISO PNG will forbid them.
1612 * The NUL character is forbidden by PNG-1.0 through PNG-1.2 and ISO PNG.
1614 png_write_chunk_data(png_ptr, new_key, key_len + 1);
1617 png_write_chunk_data(png_ptr, (png_const_bytep)text, text_len);
1619 png_write_chunk_end(png_ptr);
1623 #ifdef PNG_WRITE_zTXt_SUPPORTED
1624 /* Write a compressed text chunk */
1626 png_write_zTXt(png_structrp png_ptr, png_const_charp key, png_const_charp text,
1629 png_uint_32 key_len;
1630 png_byte new_key[81];
1631 compression_state comp;
1633 png_debug(1, "in png_write_zTXt");
1635 if (compression == PNG_TEXT_COMPRESSION_NONE)
1637 png_write_tEXt(png_ptr, key, text, 0);
1641 if (compression != PNG_TEXT_COMPRESSION_zTXt)
1642 png_error(png_ptr, "zTXt: invalid compression type");
1644 key_len = png_check_keyword(png_ptr, key, new_key);
1647 png_error(png_ptr, "zTXt: invalid keyword");
1649 /* Add the compression method and 1 for the keyword separator. */
1650 new_key[++key_len] = PNG_COMPRESSION_TYPE_BASE;
1653 /* Compute the compressed data; do it now for the length */
1654 png_text_compress_init(&comp, (png_const_bytep)text,
1655 text == NULL ? 0 : strlen(text));
1657 if (png_text_compress(png_ptr, png_zTXt, &comp, key_len) != Z_OK)
1658 png_error(png_ptr, png_ptr->zstream.msg);
1660 /* Write start of chunk */
1661 png_write_chunk_header(png_ptr, png_zTXt, key_len + comp.output_len);
1664 png_write_chunk_data(png_ptr, new_key, key_len);
1666 /* Write the compressed data */
1667 png_write_compressed_data_out(png_ptr, &comp);
1669 /* Close the chunk */
1670 png_write_chunk_end(png_ptr);
1674 #ifdef PNG_WRITE_iTXt_SUPPORTED
1675 /* Write an iTXt chunk */
1677 png_write_iTXt(png_structrp png_ptr, int compression, png_const_charp key,
1678 png_const_charp lang, png_const_charp lang_key, png_const_charp text)
1680 png_uint_32 key_len, prefix_len;
1681 png_size_t lang_len, lang_key_len;
1682 png_byte new_key[82];
1683 compression_state comp;
1685 png_debug(1, "in png_write_iTXt");
1687 key_len = png_check_keyword(png_ptr, key, new_key);
1690 png_error(png_ptr, "iTXt: invalid keyword");
1692 /* Set the compression flag */
1693 switch (compression)
1695 case PNG_ITXT_COMPRESSION_NONE:
1696 case PNG_TEXT_COMPRESSION_NONE:
1697 compression = new_key[++key_len] = 0; /* no compression */
1700 case PNG_TEXT_COMPRESSION_zTXt:
1701 case PNG_ITXT_COMPRESSION_zTXt:
1702 compression = new_key[++key_len] = 1; /* compressed */
1706 png_error(png_ptr, "iTXt: invalid compression");
1709 new_key[++key_len] = PNG_COMPRESSION_TYPE_BASE;
1710 ++key_len; /* for the keywod separator */
1712 /* We leave it to the application to meet PNG-1.0 requirements on the
1713 * contents of the text. PNG-1.0 through PNG-1.2 discourage the use of
1714 * any non-Latin-1 characters except for NEWLINE. ISO PNG, however,
1715 * specifies that the text is UTF-8 and this really doesn't require any
1718 * The NUL character is forbidden by PNG-1.0 through PNG-1.2 and ISO PNG.
1720 * TODO: validate the language tag correctly (see the spec.)
1722 if (lang == NULL) lang = ""; /* empty language is valid */
1723 lang_len = strlen(lang)+1;
1724 if (lang_key == NULL) lang_key = ""; /* may be empty */
1725 lang_key_len = strlen(lang_key)+1;
1726 if (text == NULL) text = ""; /* may be empty */
1728 prefix_len = key_len;
1729 if (lang_len > PNG_UINT_31_MAX-prefix_len)
1730 prefix_len = PNG_UINT_31_MAX;
1732 prefix_len = (png_uint_32)(prefix_len + lang_len);
1734 if (lang_key_len > PNG_UINT_31_MAX-prefix_len)
1735 prefix_len = PNG_UINT_31_MAX;
1737 prefix_len = (png_uint_32)(prefix_len + lang_key_len);
1739 png_text_compress_init(&comp, (png_const_bytep)text, strlen(text));
1741 if (compression != 0)
1743 if (png_text_compress(png_ptr, png_iTXt, &comp, prefix_len) != Z_OK)
1744 png_error(png_ptr, png_ptr->zstream.msg);
1749 if (comp.input_len > PNG_UINT_31_MAX-prefix_len)
1750 png_error(png_ptr, "iTXt: uncompressed text too long");
1752 /* So the string will fit in a chunk: */
1753 comp.output_len = (png_uint_32)/*SAFE*/comp.input_len;
1756 png_write_chunk_header(png_ptr, png_iTXt, comp.output_len + prefix_len);
1758 png_write_chunk_data(png_ptr, new_key, key_len);
1760 png_write_chunk_data(png_ptr, (png_const_bytep)lang, lang_len);
1762 png_write_chunk_data(png_ptr, (png_const_bytep)lang_key, lang_key_len);
1764 if (compression != 0)
1765 png_write_compressed_data_out(png_ptr, &comp);
1768 png_write_chunk_data(png_ptr, (png_const_bytep)text, comp.output_len);
1770 png_write_chunk_end(png_ptr);
1774 #ifdef PNG_WRITE_oFFs_SUPPORTED
1775 /* Write the oFFs chunk */
1777 png_write_oFFs(png_structrp png_ptr, png_int_32 x_offset, png_int_32 y_offset,
1782 png_debug(1, "in png_write_oFFs");
1784 if (unit_type >= PNG_OFFSET_LAST)
1785 png_warning(png_ptr, "Unrecognized unit type for oFFs chunk");
1787 png_save_int_32(buf, x_offset);
1788 png_save_int_32(buf + 4, y_offset);
1789 buf[8] = (png_byte)unit_type;
1791 png_write_complete_chunk(png_ptr, png_oFFs, buf, (png_size_t)9);
1794 #ifdef PNG_WRITE_pCAL_SUPPORTED
1795 /* Write the pCAL chunk (described in the PNG extensions document) */
1797 png_write_pCAL(png_structrp png_ptr, png_charp purpose, png_int_32 X0,
1798 png_int_32 X1, int type, int nparams, png_const_charp units,
1801 png_uint_32 purpose_len;
1802 png_size_t units_len, total_len;
1803 png_size_tp params_len;
1805 png_byte new_purpose[80];
1808 png_debug1(1, "in png_write_pCAL (%d parameters)", nparams);
1810 if (type >= PNG_EQUATION_LAST)
1811 png_error(png_ptr, "Unrecognized equation type for pCAL chunk");
1813 purpose_len = png_check_keyword(png_ptr, purpose, new_purpose);
1815 if (purpose_len == 0)
1816 png_error(png_ptr, "pCAL: invalid keyword");
1818 ++purpose_len; /* terminator */
1820 png_debug1(3, "pCAL purpose length = %d", (int)purpose_len);
1821 units_len = strlen(units) + (nparams == 0 ? 0 : 1);
1822 png_debug1(3, "pCAL units length = %d", (int)units_len);
1823 total_len = purpose_len + units_len + 10;
1825 params_len = (png_size_tp)png_malloc(png_ptr,
1826 (png_alloc_size_t)(nparams * (sizeof (png_size_t))));
1828 /* Find the length of each parameter, making sure we don't count the
1829 * null terminator for the last parameter.
1831 for (i = 0; i < nparams; i++)
1833 params_len[i] = strlen(params[i]) + (i == nparams - 1 ? 0 : 1);
1834 png_debug2(3, "pCAL parameter %d length = %lu", i,
1835 (unsigned long)params_len[i]);
1836 total_len += params_len[i];
1839 png_debug1(3, "pCAL total length = %d", (int)total_len);
1840 png_write_chunk_header(png_ptr, png_pCAL, (png_uint_32)total_len);
1841 png_write_chunk_data(png_ptr, new_purpose, purpose_len);
1842 png_save_int_32(buf, X0);
1843 png_save_int_32(buf + 4, X1);
1844 buf[8] = (png_byte)type;
1845 buf[9] = (png_byte)nparams;
1846 png_write_chunk_data(png_ptr, buf, (png_size_t)10);
1847 png_write_chunk_data(png_ptr, (png_const_bytep)units, (png_size_t)units_len);
1849 for (i = 0; i < nparams; i++)
1851 png_write_chunk_data(png_ptr, (png_const_bytep)params[i], params_len[i]);
1854 png_free(png_ptr, params_len);
1855 png_write_chunk_end(png_ptr);
1859 #ifdef PNG_WRITE_sCAL_SUPPORTED
1860 /* Write the sCAL chunk */
1862 png_write_sCAL_s(png_structrp png_ptr, int unit, png_const_charp width,
1863 png_const_charp height)
1866 png_size_t wlen, hlen, total_len;
1868 png_debug(1, "in png_write_sCAL_s");
1870 wlen = strlen(width);
1871 hlen = strlen(height);
1872 total_len = wlen + hlen + 2;
1876 png_warning(png_ptr, "Can't write sCAL (buffer too small)");
1880 buf[0] = (png_byte)unit;
1881 memcpy(buf + 1, width, wlen + 1); /* Append the '\0' here */
1882 memcpy(buf + wlen + 2, height, hlen); /* Do NOT append the '\0' here */
1884 png_debug1(3, "sCAL total length = %u", (unsigned int)total_len);
1885 png_write_complete_chunk(png_ptr, png_sCAL, buf, total_len);
1889 #ifdef PNG_WRITE_pHYs_SUPPORTED
1890 /* Write the pHYs chunk */
1892 png_write_pHYs(png_structrp png_ptr, png_uint_32 x_pixels_per_unit,
1893 png_uint_32 y_pixels_per_unit,
1898 png_debug(1, "in png_write_pHYs");
1900 if (unit_type >= PNG_RESOLUTION_LAST)
1901 png_warning(png_ptr, "Unrecognized unit type for pHYs chunk");
1903 png_save_uint_32(buf, x_pixels_per_unit);
1904 png_save_uint_32(buf + 4, y_pixels_per_unit);
1905 buf[8] = (png_byte)unit_type;
1907 png_write_complete_chunk(png_ptr, png_pHYs, buf, (png_size_t)9);
1911 #ifdef PNG_WRITE_tIME_SUPPORTED
1912 /* Write the tIME chunk. Use either png_convert_from_struct_tm()
1913 * or png_convert_from_time_t(), or fill in the structure yourself.
1916 png_write_tIME(png_structrp png_ptr, png_const_timep mod_time)
1920 png_debug(1, "in png_write_tIME");
1922 if (mod_time->month > 12 || mod_time->month < 1 ||
1923 mod_time->day > 31 || mod_time->day < 1 ||
1924 mod_time->hour > 23 || mod_time->second > 60)
1926 png_warning(png_ptr, "Invalid time specified for tIME chunk");
1930 png_save_uint_16(buf, mod_time->year);
1931 buf[2] = mod_time->month;
1932 buf[3] = mod_time->day;
1933 buf[4] = mod_time->hour;
1934 buf[5] = mod_time->minute;
1935 buf[6] = mod_time->second;
1937 png_write_complete_chunk(png_ptr, png_tIME, buf, (png_size_t)7);
1941 /* Initializes the row writing capability of libpng */
1943 png_write_start_row(png_structrp png_ptr)
1945 #ifdef PNG_WRITE_INTERLACING_SUPPORTED
1946 /* Arrays to facilitate easy interlacing - use pass (0 - 6) as index */
1948 /* Start of interlace block */
1949 static PNG_CONST png_byte png_pass_start[7] = {0, 4, 0, 2, 0, 1, 0};
1951 /* Offset to next interlace block */
1952 static PNG_CONST png_byte png_pass_inc[7] = {8, 8, 4, 4, 2, 2, 1};
1954 /* Start of interlace block in the y direction */
1955 static PNG_CONST png_byte png_pass_ystart[7] = {0, 0, 4, 0, 2, 0, 1};
1957 /* Offset to next interlace block in the y direction */
1958 static PNG_CONST png_byte png_pass_yinc[7] = {8, 8, 8, 4, 4, 2, 2};
1961 png_alloc_size_t buf_size;
1962 int usr_pixel_depth;
1964 png_debug(1, "in png_write_start_row");
1966 usr_pixel_depth = png_ptr->usr_channels * png_ptr->usr_bit_depth;
1967 buf_size = PNG_ROWBYTES(usr_pixel_depth, png_ptr->width) + 1;
1969 /* 1.5.6: added to allow checking in the row write code. */
1970 png_ptr->transformed_pixel_depth = png_ptr->pixel_depth;
1971 png_ptr->maximum_pixel_depth = (png_byte)usr_pixel_depth;
1973 /* Set up row buffer */
1974 png_ptr->row_buf = (png_bytep)png_malloc(png_ptr, buf_size);
1976 png_ptr->row_buf[0] = PNG_FILTER_VALUE_NONE;
1978 #ifdef PNG_WRITE_FILTER_SUPPORTED
1979 /* Set up filtering buffer, if using this filter */
1980 if (png_ptr->do_filter & PNG_FILTER_SUB)
1982 png_ptr->sub_row = (png_bytep)png_malloc(png_ptr, png_ptr->rowbytes + 1);
1984 png_ptr->sub_row[0] = PNG_FILTER_VALUE_SUB;
1987 /* We only need to keep the previous row if we are using one of these. */
1988 if ((png_ptr->do_filter &
1989 (PNG_FILTER_AVG | PNG_FILTER_UP | PNG_FILTER_PAETH)) != 0)
1991 /* Set up previous row buffer */
1992 png_ptr->prev_row = (png_bytep)png_calloc(png_ptr, buf_size);
1994 if ((png_ptr->do_filter & PNG_FILTER_UP) != 0)
1996 png_ptr->up_row = (png_bytep)png_malloc(png_ptr,
1997 png_ptr->rowbytes + 1);
1999 png_ptr->up_row[0] = PNG_FILTER_VALUE_UP;
2002 if ((png_ptr->do_filter & PNG_FILTER_AVG) != 0)
2004 png_ptr->avg_row = (png_bytep)png_malloc(png_ptr,
2005 png_ptr->rowbytes + 1);
2007 png_ptr->avg_row[0] = PNG_FILTER_VALUE_AVG;
2010 if ((png_ptr->do_filter & PNG_FILTER_PAETH) != 0)
2012 png_ptr->paeth_row = (png_bytep)png_malloc(png_ptr,
2013 png_ptr->rowbytes + 1);
2015 png_ptr->paeth_row[0] = PNG_FILTER_VALUE_PAETH;
2018 #endif /* WRITE_FILTER */
2020 #ifdef PNG_WRITE_INTERLACING_SUPPORTED
2021 /* If interlaced, we need to set up width and height of pass */
2022 if (png_ptr->interlaced != 0)
2024 if ((png_ptr->transformations & PNG_INTERLACE) == 0)
2026 png_ptr->num_rows = (png_ptr->height + png_pass_yinc[0] - 1 -
2027 png_pass_ystart[0]) / png_pass_yinc[0];
2029 png_ptr->usr_width = (png_ptr->width + png_pass_inc[0] - 1 -
2030 png_pass_start[0]) / png_pass_inc[0];
2035 png_ptr->num_rows = png_ptr->height;
2036 png_ptr->usr_width = png_ptr->width;
2043 png_ptr->num_rows = png_ptr->height;
2044 png_ptr->usr_width = png_ptr->width;
2048 /* Internal use only. Called when finished processing a row of data. */
2050 png_write_finish_row(png_structrp png_ptr)
2052 #ifdef PNG_WRITE_INTERLACING_SUPPORTED
2053 /* Arrays to facilitate easy interlacing - use pass (0 - 6) as index */
2055 /* Start of interlace block */
2056 static PNG_CONST png_byte png_pass_start[7] = {0, 4, 0, 2, 0, 1, 0};
2058 /* Offset to next interlace block */
2059 static PNG_CONST png_byte png_pass_inc[7] = {8, 8, 4, 4, 2, 2, 1};
2061 /* Start of interlace block in the y direction */
2062 static PNG_CONST png_byte png_pass_ystart[7] = {0, 0, 4, 0, 2, 0, 1};
2064 /* Offset to next interlace block in the y direction */
2065 static PNG_CONST png_byte png_pass_yinc[7] = {8, 8, 8, 4, 4, 2, 2};
2068 png_debug(1, "in png_write_finish_row");
2071 png_ptr->row_number++;
2073 /* See if we are done */
2074 if (png_ptr->row_number < png_ptr->num_rows)
2077 #ifdef PNG_WRITE_INTERLACING_SUPPORTED
2078 /* If interlaced, go to next pass */
2079 if (png_ptr->interlaced != 0)
2081 png_ptr->row_number = 0;
2082 if ((png_ptr->transformations & PNG_INTERLACE) != 0)
2089 /* Loop until we find a non-zero width or height pass */
2094 if (png_ptr->pass >= 7)
2097 png_ptr->usr_width = (png_ptr->width +
2098 png_pass_inc[png_ptr->pass] - 1 -
2099 png_pass_start[png_ptr->pass]) /
2100 png_pass_inc[png_ptr->pass];
2102 png_ptr->num_rows = (png_ptr->height +
2103 png_pass_yinc[png_ptr->pass] - 1 -
2104 png_pass_ystart[png_ptr->pass]) /
2105 png_pass_yinc[png_ptr->pass];
2107 if ((png_ptr->transformations & PNG_INTERLACE) != 0)
2110 } while (png_ptr->usr_width == 0 || png_ptr->num_rows == 0);
2114 /* Reset the row above the image for the next pass */
2115 if (png_ptr->pass < 7)
2117 if (png_ptr->prev_row != NULL)
2118 memset(png_ptr->prev_row, 0,
2119 (png_size_t)(PNG_ROWBYTES(png_ptr->usr_channels*
2120 png_ptr->usr_bit_depth, png_ptr->width)) + 1);
2127 /* If we get here, we've just written the last row, so we need
2128 to flush the compressor */
2129 png_compress_IDAT(png_ptr, NULL, 0, Z_FINISH);
2132 #ifdef PNG_WRITE_INTERLACING_SUPPORTED
2133 /* Pick out the correct pixels for the interlace pass.
2134 * The basic idea here is to go through the row with a source
2135 * pointer and a destination pointer (sp and dp), and copy the
2136 * correct pixels for the pass. As the row gets compacted,
2137 * sp will always be >= dp, so we should never overwrite anything.
2138 * See the default: case for the easiest code to understand.
2141 png_do_write_interlace(png_row_infop row_info, png_bytep row, int pass)
2143 /* Arrays to facilitate easy interlacing - use pass (0 - 6) as index */
2145 /* Start of interlace block */
2146 static PNG_CONST png_byte png_pass_start[7] = {0, 4, 0, 2, 0, 1, 0};
2148 /* Offset to next interlace block */
2149 static PNG_CONST png_byte png_pass_inc[7] = {8, 8, 4, 4, 2, 2, 1};
2151 png_debug(1, "in png_do_write_interlace");
2153 /* We don't have to do anything on the last pass (6) */
2156 /* Each pixel depth is handled separately */
2157 switch (row_info->pixel_depth)
2167 png_uint_32 row_width = row_info->width;
2173 for (i = png_pass_start[pass]; i < row_width;
2174 i += png_pass_inc[pass])
2176 sp = row + (png_size_t)(i >> 3);
2177 value = (int)(*sp >> (7 - (int)(i & 0x07))) & 0x01;
2178 d |= (value << shift);
2183 *dp++ = (png_byte)d;
2205 png_uint_32 row_width = row_info->width;
2211 for (i = png_pass_start[pass]; i < row_width;
2212 i += png_pass_inc[pass])
2214 sp = row + (png_size_t)(i >> 2);
2215 value = (*sp >> ((3 - (int)(i & 0x03)) << 1)) & 0x03;
2216 d |= (value << shift);
2221 *dp++ = (png_byte)d;
2242 png_uint_32 row_width = row_info->width;
2247 for (i = png_pass_start[pass]; i < row_width;
2248 i += png_pass_inc[pass])
2250 sp = row + (png_size_t)(i >> 1);
2251 value = (*sp >> ((1 - (int)(i & 0x01)) << 2)) & 0x0f;
2252 d |= (value << shift);
2257 *dp++ = (png_byte)d;
2275 png_uint_32 row_width = row_info->width;
2276 png_size_t pixel_bytes;
2278 /* Start at the beginning */
2281 /* Find out how many bytes each pixel takes up */
2282 pixel_bytes = (row_info->pixel_depth >> 3);
2284 /* Loop through the row, only looking at the pixels that matter */
2285 for (i = png_pass_start[pass]; i < row_width;
2286 i += png_pass_inc[pass])
2288 /* Find out where the original pixel is */
2289 sp = row + (png_size_t)i * pixel_bytes;
2291 /* Move the pixel */
2293 memcpy(dp, sp, pixel_bytes);
2301 /* Set new row width */
2302 row_info->width = (row_info->width +
2303 png_pass_inc[pass] - 1 -
2304 png_pass_start[pass]) /
2307 row_info->rowbytes = PNG_ROWBYTES(row_info->pixel_depth,
2313 /* This filters the row, chooses which filter to use, if it has not already
2314 * been specified by the application, and then writes the row out with the
2317 static void /* PRIVATE */
2318 png_write_filtered_row(png_structrp png_ptr, png_bytep filtered_row,
2319 png_size_t row_bytes);
2321 #define PNG_MAXSUM (((png_uint_32)(-1)) >> 1)
2322 #define PNG_HISHIFT 10
2323 #define PNG_LOMASK ((png_uint_32)0xffffL)
2324 #define PNG_HIMASK ((png_uint_32)(~PNG_LOMASK >> PNG_HISHIFT))
2326 png_write_find_filter(png_structrp png_ptr, png_row_infop row_info)
2329 #ifdef PNG_WRITE_FILTER_SUPPORTED
2330 png_bytep prev_row, row_buf;
2331 png_uint_32 mins, bpp;
2332 png_byte filter_to_do = png_ptr->do_filter;
2333 png_size_t row_bytes = row_info->rowbytes;
2334 #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED
2335 int num_p_filters = png_ptr->num_prev_filters;
2338 png_debug(1, "in png_write_find_filter");
2340 #ifndef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED
2341 if (png_ptr->row_number == 0 && filter_to_do == PNG_ALL_FILTERS)
2343 /* These will never be selected so we need not test them. */
2344 filter_to_do &= ~(PNG_FILTER_UP | PNG_FILTER_PAETH);
2348 /* Find out how many bytes offset each pixel is */
2349 bpp = (row_info->pixel_depth + 7) >> 3;
2351 prev_row = png_ptr->prev_row;
2353 best_row = png_ptr->row_buf;
2354 #ifdef PNG_WRITE_FILTER_SUPPORTED
2358 /* The prediction method we use is to find which method provides the
2359 * smallest value when summing the absolute values of the distances
2360 * from zero, using anything >= 128 as negative numbers. This is known
2361 * as the "minimum sum of absolute differences" heuristic. Other
2362 * heuristics are the "weighted minimum sum of absolute differences"
2363 * (experimental and can in theory improve compression), and the "zlib
2364 * predictive" method (not implemented yet), which does test compressions
2365 * of lines using different filter methods, and then chooses the
2366 * (series of) filter(s) that give minimum compressed data size (VERY
2367 * computationally expensive).
2369 * GRR 980525: consider also
2371 * (1) minimum sum of absolute differences from running average (i.e.,
2372 * keep running sum of non-absolute differences & count of bytes)
2373 * [track dispersion, too? restart average if dispersion too large?]
2375 * (1b) minimum sum of absolute differences from sliding average, probably
2376 * with window size <= deflate window (usually 32K)
2378 * (2) minimum sum of squared differences from zero or running average
2379 * (i.e., ~ root-mean-square approach)
2383 /* We don't need to test the 'no filter' case if this is the only filter
2384 * that has been chosen, as it doesn't actually do anything to the data.
2386 if ((filter_to_do & PNG_FILTER_NONE) != 0 && filter_to_do != PNG_FILTER_NONE)
2389 png_uint_32 sum = 0;
2393 for (i = 0, rp = row_buf + 1; i < row_bytes; i++, rp++)
2396 sum += (v < 128) ? v : 256 - v;
2399 #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED
2400 if (png_ptr->heuristic_method == PNG_FILTER_HEURISTIC_WEIGHTED)
2402 png_uint_32 sumhi, sumlo;
2404 sumlo = sum & PNG_LOMASK;
2405 sumhi = (sum >> PNG_HISHIFT) & PNG_HIMASK; /* Gives us some footroom */
2407 /* Reduce the sum if we match any of the previous rows */
2408 for (j = 0; j < num_p_filters; j++)
2410 if (png_ptr->prev_filters[j] == PNG_FILTER_VALUE_NONE)
2412 sumlo = (sumlo * png_ptr->filter_weights[j]) >>
2415 sumhi = (sumhi * png_ptr->filter_weights[j]) >>
2420 /* Factor in the cost of this filter (this is here for completeness,
2421 * but it makes no sense to have a "cost" for the NONE filter, as
2422 * it has the minimum possible computational cost - none).
2424 sumlo = (sumlo * png_ptr->filter_costs[PNG_FILTER_VALUE_NONE]) >>
2427 sumhi = (sumhi * png_ptr->filter_costs[PNG_FILTER_VALUE_NONE]) >>
2430 if (sumhi > PNG_HIMASK)
2434 sum = (sumhi << PNG_HISHIFT) + sumlo;
2441 if (filter_to_do == PNG_FILTER_SUB)
2442 /* It's the only filter so no testing is needed */
2444 png_bytep rp, lp, dp;
2447 for (i = 0, rp = row_buf + 1, dp = png_ptr->sub_row + 1; i < bpp;
2453 for (lp = row_buf + 1; i < row_bytes;
2454 i++, rp++, lp++, dp++)
2456 *dp = (png_byte)((int)*rp - (int)*lp);
2459 best_row = png_ptr->sub_row;
2462 else if ((filter_to_do & PNG_FILTER_SUB) != 0)
2464 png_bytep rp, dp, lp;
2465 png_uint_32 sum = 0, lmins = mins;
2469 #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED
2470 /* We temporarily increase the "minimum sum" by the factor we
2471 * would reduce the sum of this filter, so that we can do the
2472 * early exit comparison without scaling the sum each time.
2474 if (png_ptr->heuristic_method == PNG_FILTER_HEURISTIC_WEIGHTED)
2477 png_uint_32 lmhi, lmlo;
2478 lmlo = lmins & PNG_LOMASK;
2479 lmhi = (lmins >> PNG_HISHIFT) & PNG_HIMASK;
2481 for (j = 0; j < num_p_filters; j++)
2483 if (png_ptr->prev_filters[j] == PNG_FILTER_VALUE_SUB)
2485 lmlo = (lmlo * png_ptr->inv_filter_weights[j]) >>
2488 lmhi = (lmhi * png_ptr->inv_filter_weights[j]) >>
2493 lmlo = (lmlo * png_ptr->inv_filter_costs[PNG_FILTER_VALUE_SUB]) >>
2496 lmhi = (lmhi * png_ptr->inv_filter_costs[PNG_FILTER_VALUE_SUB]) >>
2499 if (lmhi > PNG_HIMASK)
2503 lmins = (lmhi << PNG_HISHIFT) + lmlo;
2507 for (i = 0, rp = row_buf + 1, dp = png_ptr->sub_row + 1; i < bpp;
2512 sum += (v < 128) ? v : 256 - v;
2515 for (lp = row_buf + 1; i < row_bytes;
2516 i++, rp++, lp++, dp++)
2518 v = *dp = (png_byte)((int)*rp - (int)*lp);
2520 sum += (v < 128) ? v : 256 - v;
2522 if (sum > lmins) /* We are already worse, don't continue. */
2526 #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED
2527 if (png_ptr->heuristic_method == PNG_FILTER_HEURISTIC_WEIGHTED)
2530 png_uint_32 sumhi, sumlo;
2531 sumlo = sum & PNG_LOMASK;
2532 sumhi = (sum >> PNG_HISHIFT) & PNG_HIMASK;
2534 for (j = 0; j < num_p_filters; j++)
2536 if (png_ptr->prev_filters[j] == PNG_FILTER_VALUE_SUB)
2538 sumlo = (sumlo * png_ptr->inv_filter_weights[j]) >>
2541 sumhi = (sumhi * png_ptr->inv_filter_weights[j]) >>
2546 sumlo = (sumlo * png_ptr->inv_filter_costs[PNG_FILTER_VALUE_SUB]) >>
2549 sumhi = (sumhi * png_ptr->inv_filter_costs[PNG_FILTER_VALUE_SUB]) >>
2552 if (sumhi > PNG_HIMASK)
2556 sum = (sumhi << PNG_HISHIFT) + sumlo;
2563 best_row = png_ptr->sub_row;
2568 if (filter_to_do == PNG_FILTER_UP)
2570 png_bytep rp, dp, pp;
2573 for (i = 0, rp = row_buf + 1, dp = png_ptr->up_row + 1,
2574 pp = prev_row + 1; i < row_bytes;
2575 i++, rp++, pp++, dp++)
2577 *dp = (png_byte)((int)*rp - (int)*pp);
2580 best_row = png_ptr->up_row;
2583 else if ((filter_to_do & PNG_FILTER_UP) != 0)
2585 png_bytep rp, dp, pp;
2586 png_uint_32 sum = 0, lmins = mins;
2591 #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED
2592 if (png_ptr->heuristic_method == PNG_FILTER_HEURISTIC_WEIGHTED)
2595 png_uint_32 lmhi, lmlo;
2596 lmlo = lmins & PNG_LOMASK;
2597 lmhi = (lmins >> PNG_HISHIFT) & PNG_HIMASK;
2599 for (j = 0; j < num_p_filters; j++)
2601 if (png_ptr->prev_filters[j] == PNG_FILTER_VALUE_UP)
2603 lmlo = (lmlo * png_ptr->inv_filter_weights[j]) >>
2606 lmhi = (lmhi * png_ptr->inv_filter_weights[j]) >>
2611 lmlo = (lmlo * png_ptr->inv_filter_costs[PNG_FILTER_VALUE_UP]) >>
2614 lmhi = (lmhi * png_ptr->inv_filter_costs[PNG_FILTER_VALUE_UP]) >>
2617 if (lmhi > PNG_HIMASK)
2621 lmins = (lmhi << PNG_HISHIFT) + lmlo;
2625 for (i = 0, rp = row_buf + 1, dp = png_ptr->up_row + 1,
2626 pp = prev_row + 1; i < row_bytes; i++)
2628 v = *dp++ = (png_byte)((int)*rp++ - (int)*pp++);
2630 sum += (v < 128) ? v : 256 - v;
2632 if (sum > lmins) /* We are already worse, don't continue. */
2636 #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED
2637 if (png_ptr->heuristic_method == PNG_FILTER_HEURISTIC_WEIGHTED)
2640 png_uint_32 sumhi, sumlo;
2641 sumlo = sum & PNG_LOMASK;
2642 sumhi = (sum >> PNG_HISHIFT) & PNG_HIMASK;
2644 for (j = 0; j < num_p_filters; j++)
2646 if (png_ptr->prev_filters[j] == PNG_FILTER_VALUE_UP)
2648 sumlo = (sumlo * png_ptr->filter_weights[j]) >>
2651 sumhi = (sumhi * png_ptr->filter_weights[j]) >>
2656 sumlo = (sumlo * png_ptr->filter_costs[PNG_FILTER_VALUE_UP]) >>
2659 sumhi = (sumhi * png_ptr->filter_costs[PNG_FILTER_VALUE_UP]) >>
2662 if (sumhi > PNG_HIMASK)
2666 sum = (sumhi << PNG_HISHIFT) + sumlo;
2673 best_row = png_ptr->up_row;
2678 if (filter_to_do == PNG_FILTER_AVG)
2680 png_bytep rp, dp, pp, lp;
2683 for (i = 0, rp = row_buf + 1, dp = png_ptr->avg_row + 1,
2684 pp = prev_row + 1; i < bpp; i++)
2686 *dp++ = (png_byte)((int)*rp++ - ((int)*pp++ / 2));
2689 for (lp = row_buf + 1; i < row_bytes; i++)
2692 (png_byte)((int)*rp++ - (((int)*pp++ + (int)*lp++) / 2));
2694 best_row = png_ptr->avg_row;
2697 else if ((filter_to_do & PNG_FILTER_AVG) != 0)
2699 png_bytep rp, dp, pp, lp;
2700 png_uint_32 sum = 0, lmins = mins;
2704 #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED
2705 if (png_ptr->heuristic_method == PNG_FILTER_HEURISTIC_WEIGHTED)
2708 png_uint_32 lmhi, lmlo;
2709 lmlo = lmins & PNG_LOMASK;
2710 lmhi = (lmins >> PNG_HISHIFT) & PNG_HIMASK;
2712 for (j = 0; j < num_p_filters; j++)
2714 if (png_ptr->prev_filters[j] == PNG_FILTER_VALUE_AVG)
2716 lmlo = (lmlo * png_ptr->inv_filter_weights[j]) >>
2719 lmhi = (lmhi * png_ptr->inv_filter_weights[j]) >>
2724 lmlo = (lmlo * png_ptr->inv_filter_costs[PNG_FILTER_VALUE_AVG]) >>
2727 lmhi = (lmhi * png_ptr->inv_filter_costs[PNG_FILTER_VALUE_AVG]) >>
2730 if (lmhi > PNG_HIMASK)
2734 lmins = (lmhi << PNG_HISHIFT) + lmlo;
2738 for (i = 0, rp = row_buf + 1, dp = png_ptr->avg_row + 1,
2739 pp = prev_row + 1; i < bpp; i++)
2741 v = *dp++ = (png_byte)((int)*rp++ - ((int)*pp++ / 2));
2743 sum += (v < 128) ? v : 256 - v;
2746 for (lp = row_buf + 1; i < row_bytes; i++)
2749 (png_byte)(((int)*rp++ - ((int)*pp++ + (int)*lp++) / 2));
2751 sum += (v < 128) ? v : 256 - v;
2753 if (sum > lmins) /* We are already worse, don't continue. */
2757 #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED
2758 if (png_ptr->heuristic_method == PNG_FILTER_HEURISTIC_WEIGHTED)
2761 png_uint_32 sumhi, sumlo;
2762 sumlo = sum & PNG_LOMASK;
2763 sumhi = (sum >> PNG_HISHIFT) & PNG_HIMASK;
2765 for (j = 0; j < num_p_filters; j++)
2767 if (png_ptr->prev_filters[j] == PNG_FILTER_VALUE_NONE)
2769 sumlo = (sumlo * png_ptr->filter_weights[j]) >>
2772 sumhi = (sumhi * png_ptr->filter_weights[j]) >>
2777 sumlo = (sumlo * png_ptr->filter_costs[PNG_FILTER_VALUE_AVG]) >>
2780 sumhi = (sumhi * png_ptr->filter_costs[PNG_FILTER_VALUE_AVG]) >>
2783 if (sumhi > PNG_HIMASK)
2787 sum = (sumhi << PNG_HISHIFT) + sumlo;
2794 best_row = png_ptr->avg_row;
2799 if ((filter_to_do == PNG_FILTER_PAETH) != 0)
2801 png_bytep rp, dp, pp, cp, lp;
2804 for (i = 0, rp = row_buf + 1, dp = png_ptr->paeth_row + 1,
2805 pp = prev_row + 1; i < bpp; i++)
2807 *dp++ = (png_byte)((int)*rp++ - (int)*pp++);
2810 for (lp = row_buf + 1, cp = prev_row + 1; i < row_bytes; i++)
2812 int a, b, c, pa, pb, pc, p;
2826 pa = p < 0 ? -p : p;
2827 pb = pc < 0 ? -pc : pc;
2828 pc = (p + pc) < 0 ? -(p + pc) : p + pc;
2831 p = (pa <= pb && pa <=pc) ? a : (pb <= pc) ? b : c;
2833 *dp++ = (png_byte)((int)*rp++ - p);
2835 best_row = png_ptr->paeth_row;
2838 else if ((filter_to_do & PNG_FILTER_PAETH) != 0)
2840 png_bytep rp, dp, pp, cp, lp;
2841 png_uint_32 sum = 0, lmins = mins;
2845 #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED
2846 if (png_ptr->heuristic_method == PNG_FILTER_HEURISTIC_WEIGHTED)
2849 png_uint_32 lmhi, lmlo;
2850 lmlo = lmins & PNG_LOMASK;
2851 lmhi = (lmins >> PNG_HISHIFT) & PNG_HIMASK;
2853 for (j = 0; j < num_p_filters; j++)
2855 if (png_ptr->prev_filters[j] == PNG_FILTER_VALUE_PAETH)
2857 lmlo = (lmlo * png_ptr->inv_filter_weights[j]) >>
2860 lmhi = (lmhi * png_ptr->inv_filter_weights[j]) >>
2865 lmlo = (lmlo * png_ptr->inv_filter_costs[PNG_FILTER_VALUE_PAETH]) >>
2868 lmhi = (lmhi * png_ptr->inv_filter_costs[PNG_FILTER_VALUE_PAETH]) >>
2871 if (lmhi > PNG_HIMASK)
2875 lmins = (lmhi << PNG_HISHIFT) + lmlo;
2879 for (i = 0, rp = row_buf + 1, dp = png_ptr->paeth_row + 1,
2880 pp = prev_row + 1; i < bpp; i++)
2882 v = *dp++ = (png_byte)((int)*rp++ - (int)*pp++);
2884 sum += (v < 128) ? v : 256 - v;
2887 for (lp = row_buf + 1, cp = prev_row + 1; i < row_bytes; i++)
2889 int a, b, c, pa, pb, pc, p;
2895 #ifndef PNG_SLOW_PAETH
2903 pa = p < 0 ? -p : p;
2904 pb = pc < 0 ? -pc : pc;
2905 pc = (p + pc) < 0 ? -(p + pc) : p + pc;
2907 p = (pa <= pb && pa <=pc) ? a : (pb <= pc) ? b : c;
2908 #else /* SLOW_PAETH */
2914 if (pa <= pb && pa <= pc)
2922 #endif /* SLOW_PAETH */
2924 v = *dp++ = (png_byte)((int)*rp++ - p);
2926 sum += (v < 128) ? v : 256 - v;
2928 if (sum > lmins) /* We are already worse, don't continue. */
2932 #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED
2933 if (png_ptr->heuristic_method == PNG_FILTER_HEURISTIC_WEIGHTED)
2936 png_uint_32 sumhi, sumlo;
2937 sumlo = sum & PNG_LOMASK;
2938 sumhi = (sum >> PNG_HISHIFT) & PNG_HIMASK;
2940 for (j = 0; j < num_p_filters; j++)
2942 if (png_ptr->prev_filters[j] == PNG_FILTER_VALUE_PAETH)
2944 sumlo = (sumlo * png_ptr->filter_weights[j]) >>
2947 sumhi = (sumhi * png_ptr->filter_weights[j]) >>
2952 sumlo = (sumlo * png_ptr->filter_costs[PNG_FILTER_VALUE_PAETH]) >>
2955 sumhi = (sumhi * png_ptr->filter_costs[PNG_FILTER_VALUE_PAETH]) >>
2958 if (sumhi > PNG_HIMASK)
2962 sum = (sumhi << PNG_HISHIFT) + sumlo;
2968 best_row = png_ptr->paeth_row;
2971 #endif /* WRITE_FILTER */
2973 /* Do the actual writing of the filtered row data from the chosen filter. */
2974 png_write_filtered_row(png_ptr, best_row, row_info->rowbytes+1);
2976 #ifdef PNG_WRITE_FILTER_SUPPORTED
2977 #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED
2978 /* Save the type of filter we picked this time for future calculations */
2979 if (png_ptr->num_prev_filters > 0)
2983 for (j = 1; j < num_p_filters; j++)
2985 png_ptr->prev_filters[j] = png_ptr->prev_filters[j - 1];
2988 png_ptr->prev_filters[j] = best_row[0];
2991 #endif /* WRITE_FILTER */
2995 /* Do the actual writing of a previously filtered row. */
2997 png_write_filtered_row(png_structrp png_ptr, png_bytep filtered_row,
2998 png_size_t full_row_length/*includes filter byte*/)
3000 png_debug(1, "in png_write_filtered_row");
3002 png_debug1(2, "filter = %d", filtered_row[0]);
3004 png_compress_IDAT(png_ptr, filtered_row, full_row_length, Z_NO_FLUSH);
3006 #ifdef PNG_WRITE_FILTER_SUPPORTED
3007 /* Swap the current and previous rows */
3008 if (png_ptr->prev_row != NULL)
3012 tptr = png_ptr->prev_row;
3013 png_ptr->prev_row = png_ptr->row_buf;
3014 png_ptr->row_buf = tptr;
3016 #endif /* WRITE_FILTER */
3018 /* Finish row - updates counters and flushes zlib if last row */
3019 png_write_finish_row(png_ptr);
3021 #ifdef PNG_WRITE_FLUSH_SUPPORTED
3022 png_ptr->flush_rows++;
3024 if (png_ptr->flush_dist > 0 &&
3025 png_ptr->flush_rows >= png_ptr->flush_dist)
3027 png_write_flush(png_ptr);
3029 #endif /* WRITE_FLUSH */