fix for openout message (HH)
[luatex.git] / source / libs / libpng / libpng-1.6.16 / pngwrite.c
blob94548877bd0ee6fae6f63a083a5a944565435de1
2 /* pngwrite.c - general routines to write a PNG file
4 * Last changed in libpng 1.6.15 [November 20, 2014]
5 * Copyright (c) 1998-2014 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
14 #include "pngpriv.h"
15 #if defined(PNG_SIMPLIFIED_WRITE_SUPPORTED) && defined(PNG_STDIO_SUPPORTED)
16 # include <errno.h>
17 #endif
19 #ifdef PNG_WRITE_SUPPORTED
21 #ifdef PNG_WRITE_UNKNOWN_CHUNKS_SUPPORTED
22 /* Write out all the unknown chunks for the current given location */
23 static void
24 write_unknown_chunks(png_structrp png_ptr, png_const_inforp info_ptr,
25 unsigned int where)
27 if (info_ptr->unknown_chunks_num != 0)
29 png_const_unknown_chunkp up;
31 png_debug(5, "writing extra chunks");
33 for (up = info_ptr->unknown_chunks;
34 up < info_ptr->unknown_chunks + info_ptr->unknown_chunks_num;
35 ++up)
36 if ((up->location & where) != 0)
38 /* If per-chunk unknown chunk handling is enabled use it, otherwise
39 * just write the chunks the application has set.
41 #ifdef PNG_SET_UNKNOWN_CHUNKS_SUPPORTED
42 int keep = png_handle_as_unknown(png_ptr, up->name);
44 /* NOTE: this code is radically different from the read side in the
45 * matter of handling an ancillary unknown chunk. In the read side
46 * the default behavior is to discard it, in the code below the default
47 * behavior is to write it. Critical chunks are, however, only
48 * written if explicitly listed or if the default is set to write all
49 * unknown chunks.
51 * The default handling is also slightly weird - it is not possible to
52 * stop the writing of all unsafe-to-copy chunks!
54 * TODO: REVIEW: this would seem to be a bug.
56 if (keep != PNG_HANDLE_CHUNK_NEVER &&
57 ((up->name[3] & 0x20) /* safe-to-copy overrides everything */ ||
58 keep == PNG_HANDLE_CHUNK_ALWAYS ||
59 (keep == PNG_HANDLE_CHUNK_AS_DEFAULT &&
60 png_ptr->unknown_default == PNG_HANDLE_CHUNK_ALWAYS)))
61 #endif
63 /* TODO: review, what is wrong with a zero length unknown chunk? */
64 if (up->size == 0)
65 png_warning(png_ptr, "Writing zero-length unknown chunk");
67 png_write_chunk(png_ptr, up->name, up->data, up->size);
72 #endif /* WRITE_UNKNOWN_CHUNKS */
74 /* Writes all the PNG information. This is the suggested way to use the
75 * library. If you have a new chunk to add, make a function to write it,
76 * and put it in the correct location here. If you want the chunk written
77 * after the image data, put it in png_write_end(). I strongly encourage
78 * you to supply a PNG_INFO_ flag, and check info_ptr->valid before writing
79 * the chunk, as that will keep the code from breaking if you want to just
80 * write a plain PNG file. If you have long comments, I suggest writing
81 * them in png_write_end(), and compressing them.
83 void PNGAPI
84 png_write_info_before_PLTE(png_structrp png_ptr, png_const_inforp info_ptr)
86 png_debug(1, "in png_write_info_before_PLTE");
88 if (png_ptr == NULL || info_ptr == NULL)
89 return;
91 if ((png_ptr->mode & PNG_WROTE_INFO_BEFORE_PLTE) == 0)
93 /* Write PNG signature */
94 png_write_sig(png_ptr);
96 #ifdef PNG_MNG_FEATURES_SUPPORTED
97 if ((png_ptr->mode & PNG_HAVE_PNG_SIGNATURE) != 0 && \
98 png_ptr->mng_features_permitted != 0)
100 png_warning(png_ptr, "MNG features are not allowed in a PNG datastream");
101 png_ptr->mng_features_permitted = 0;
103 #endif
105 /* Write IHDR information. */
106 png_write_IHDR(png_ptr, info_ptr->width, info_ptr->height,
107 info_ptr->bit_depth, info_ptr->color_type, info_ptr->compression_type,
108 info_ptr->filter_type,
109 #ifdef PNG_WRITE_INTERLACING_SUPPORTED
110 info_ptr->interlace_type
111 #else
113 #endif
116 /* The rest of these check to see if the valid field has the appropriate
117 * flag set, and if it does, writes the chunk.
119 * 1.6.0: COLORSPACE support controls the writing of these chunks too, and
120 * the chunks will be written if the WRITE routine is there and information
121 * is available in the COLORSPACE. (See png_colorspace_sync_info in png.c
122 * for where the valid flags get set.)
124 * Under certain circumstances the colorspace can be invalidated without
125 * syncing the info_struct 'valid' flags; this happens if libpng detects and
126 * error and calls png_error while the color space is being set, yet the
127 * application continues writing the PNG. So check the 'invalid' flag here
128 * too.
130 #ifdef PNG_GAMMA_SUPPORTED
131 # ifdef PNG_WRITE_gAMA_SUPPORTED
132 if ((info_ptr->colorspace.flags & PNG_COLORSPACE_INVALID) == 0 &&
133 (info_ptr->colorspace.flags & PNG_COLORSPACE_FROM_gAMA) != 0 &&
134 (info_ptr->valid & PNG_INFO_gAMA) != 0)
135 png_write_gAMA_fixed(png_ptr, info_ptr->colorspace.gamma);
136 # endif
137 #endif
139 #ifdef PNG_COLORSPACE_SUPPORTED
140 /* Write only one of sRGB or an ICC profile. If a profile was supplied
141 * and it matches one of the known sRGB ones issue a warning.
143 # ifdef PNG_WRITE_iCCP_SUPPORTED
144 if ((info_ptr->colorspace.flags & PNG_COLORSPACE_INVALID) == 0 &&
145 (info_ptr->valid & PNG_INFO_iCCP) != 0)
147 # ifdef PNG_WRITE_sRGB_SUPPORTED
148 if ((info_ptr->valid & PNG_INFO_sRGB) != 0)
149 png_app_warning(png_ptr,
150 "profile matches sRGB but writing iCCP instead");
151 # endif
153 png_write_iCCP(png_ptr, info_ptr->iccp_name,
154 info_ptr->iccp_profile);
156 # ifdef PNG_WRITE_sRGB_SUPPORTED
157 else
158 # endif
159 # endif
161 # ifdef PNG_WRITE_sRGB_SUPPORTED
162 if ((info_ptr->colorspace.flags & PNG_COLORSPACE_INVALID) == 0 &&
163 (info_ptr->valid & PNG_INFO_sRGB) != 0)
164 png_write_sRGB(png_ptr, info_ptr->colorspace.rendering_intent);
165 # endif /* WRITE_sRGB */
166 #endif /* COLORSPACE */
168 #ifdef PNG_WRITE_sBIT_SUPPORTED
169 if ((info_ptr->valid & PNG_INFO_sBIT) != 0)
170 png_write_sBIT(png_ptr, &(info_ptr->sig_bit), info_ptr->color_type);
171 #endif
173 #ifdef PNG_COLORSPACE_SUPPORTED
174 # ifdef PNG_WRITE_cHRM_SUPPORTED
175 if ((info_ptr->colorspace.flags & PNG_COLORSPACE_INVALID) == 0 &&
176 (info_ptr->colorspace.flags & PNG_COLORSPACE_FROM_cHRM) != 0 &&
177 (info_ptr->valid & PNG_INFO_cHRM) != 0)
178 png_write_cHRM_fixed(png_ptr, &info_ptr->colorspace.end_points_xy);
179 # endif
180 #endif
182 #ifdef PNG_WRITE_UNKNOWN_CHUNKS_SUPPORTED
183 write_unknown_chunks(png_ptr, info_ptr, PNG_HAVE_IHDR);
184 #endif
186 png_ptr->mode |= PNG_WROTE_INFO_BEFORE_PLTE;
190 void PNGAPI
191 png_write_info(png_structrp png_ptr, png_const_inforp info_ptr)
193 #if defined(PNG_WRITE_TEXT_SUPPORTED) || defined(PNG_WRITE_sPLT_SUPPORTED)
194 int i;
195 #endif
197 png_debug(1, "in png_write_info");
199 if (png_ptr == NULL || info_ptr == NULL)
200 return;
202 png_write_info_before_PLTE(png_ptr, info_ptr);
204 if ((info_ptr->valid & PNG_INFO_PLTE) != 0)
205 png_write_PLTE(png_ptr, info_ptr->palette,
206 (png_uint_32)info_ptr->num_palette);
208 else if ((info_ptr->color_type == PNG_COLOR_TYPE_PALETTE) !=0)
209 png_error(png_ptr, "Valid palette required for paletted images");
211 #ifdef PNG_WRITE_tRNS_SUPPORTED
212 if ((info_ptr->valid & PNG_INFO_tRNS) !=0)
214 #ifdef PNG_WRITE_INVERT_ALPHA_SUPPORTED
215 /* Invert the alpha channel (in tRNS) */
216 if ((png_ptr->transformations & PNG_INVERT_ALPHA) != 0 &&
217 info_ptr->color_type == PNG_COLOR_TYPE_PALETTE)
219 int j;
220 for (j = 0; j<(int)info_ptr->num_trans; j++)
221 info_ptr->trans_alpha[j] =
222 (png_byte)(255 - info_ptr->trans_alpha[j]);
224 #endif
225 png_write_tRNS(png_ptr, info_ptr->trans_alpha, &(info_ptr->trans_color),
226 info_ptr->num_trans, info_ptr->color_type);
228 #endif
229 #ifdef PNG_WRITE_bKGD_SUPPORTED
230 if ((info_ptr->valid & PNG_INFO_bKGD) != 0)
231 png_write_bKGD(png_ptr, &(info_ptr->background), info_ptr->color_type);
232 #endif
234 #ifdef PNG_WRITE_hIST_SUPPORTED
235 if ((info_ptr->valid & PNG_INFO_hIST) != 0)
236 png_write_hIST(png_ptr, info_ptr->hist, info_ptr->num_palette);
237 #endif
239 #ifdef PNG_WRITE_oFFs_SUPPORTED
240 if ((info_ptr->valid & PNG_INFO_oFFs) != 0)
241 png_write_oFFs(png_ptr, info_ptr->x_offset, info_ptr->y_offset,
242 info_ptr->offset_unit_type);
243 #endif
245 #ifdef PNG_WRITE_pCAL_SUPPORTED
246 if ((info_ptr->valid & PNG_INFO_pCAL) != 0)
247 png_write_pCAL(png_ptr, info_ptr->pcal_purpose, info_ptr->pcal_X0,
248 info_ptr->pcal_X1, info_ptr->pcal_type, info_ptr->pcal_nparams,
249 info_ptr->pcal_units, info_ptr->pcal_params);
250 #endif
252 #ifdef PNG_WRITE_sCAL_SUPPORTED
253 if ((info_ptr->valid & PNG_INFO_sCAL) != 0)
254 png_write_sCAL_s(png_ptr, (int)info_ptr->scal_unit,
255 info_ptr->scal_s_width, info_ptr->scal_s_height);
256 #endif /* sCAL */
258 #ifdef PNG_WRITE_pHYs_SUPPORTED
259 if ((info_ptr->valid & PNG_INFO_pHYs) != 0)
260 png_write_pHYs(png_ptr, info_ptr->x_pixels_per_unit,
261 info_ptr->y_pixels_per_unit, info_ptr->phys_unit_type);
262 #endif /* pHYs */
264 #ifdef PNG_WRITE_tIME_SUPPORTED
265 if ((info_ptr->valid & PNG_INFO_tIME) != 0)
267 png_write_tIME(png_ptr, &(info_ptr->mod_time));
268 png_ptr->mode |= PNG_WROTE_tIME;
270 #endif /* tIME */
272 #ifdef PNG_WRITE_sPLT_SUPPORTED
273 if ((info_ptr->valid & PNG_INFO_sPLT) != 0)
274 for (i = 0; i < (int)info_ptr->splt_palettes_num; i++)
275 png_write_sPLT(png_ptr, info_ptr->splt_palettes + i);
276 #endif /* sPLT */
278 #ifdef PNG_WRITE_TEXT_SUPPORTED
279 /* Check to see if we need to write text chunks */
280 for (i = 0; i < info_ptr->num_text; i++)
282 png_debug2(2, "Writing header text chunk %d, type %d", i,
283 info_ptr->text[i].compression);
284 /* An internationalized chunk? */
285 if (info_ptr->text[i].compression > 0)
287 #ifdef PNG_WRITE_iTXt_SUPPORTED
288 /* Write international chunk */
289 png_write_iTXt(png_ptr,
290 info_ptr->text[i].compression,
291 info_ptr->text[i].key,
292 info_ptr->text[i].lang,
293 info_ptr->text[i].lang_key,
294 info_ptr->text[i].text);
295 /* Mark this chunk as written */
296 if (info_ptr->text[i].compression == PNG_TEXT_COMPRESSION_NONE)
297 info_ptr->text[i].compression = PNG_TEXT_COMPRESSION_NONE_WR;
298 else
299 info_ptr->text[i].compression = PNG_TEXT_COMPRESSION_zTXt_WR;
300 #else
301 png_warning(png_ptr, "Unable to write international text");
302 #endif
305 /* If we want a compressed text chunk */
306 else if (info_ptr->text[i].compression == PNG_TEXT_COMPRESSION_zTXt)
308 #ifdef PNG_WRITE_zTXt_SUPPORTED
309 /* Write compressed chunk */
310 png_write_zTXt(png_ptr, info_ptr->text[i].key,
311 info_ptr->text[i].text, info_ptr->text[i].compression);
312 /* Mark this chunk as written */
313 info_ptr->text[i].compression = PNG_TEXT_COMPRESSION_zTXt_WR;
314 #else
315 png_warning(png_ptr, "Unable to write compressed text");
316 #endif
319 else if (info_ptr->text[i].compression == PNG_TEXT_COMPRESSION_NONE)
321 #ifdef PNG_WRITE_tEXt_SUPPORTED
322 /* Write uncompressed chunk */
323 png_write_tEXt(png_ptr, info_ptr->text[i].key,
324 info_ptr->text[i].text,
326 /* Mark this chunk as written */
327 info_ptr->text[i].compression = PNG_TEXT_COMPRESSION_NONE_WR;
328 #else
329 /* Can't get here */
330 png_warning(png_ptr, "Unable to write uncompressed text");
331 #endif
334 #endif /* tEXt */
336 #ifdef PNG_WRITE_UNKNOWN_CHUNKS_SUPPORTED
337 write_unknown_chunks(png_ptr, info_ptr, PNG_HAVE_PLTE);
338 #endif
341 /* Writes the end of the PNG file. If you don't want to write comments or
342 * time information, you can pass NULL for info. If you already wrote these
343 * in png_write_info(), do not write them again here. If you have long
344 * comments, I suggest writing them here, and compressing them.
346 void PNGAPI
347 png_write_end(png_structrp png_ptr, png_inforp info_ptr)
349 png_debug(1, "in png_write_end");
351 if (png_ptr == NULL)
352 return;
354 if ((png_ptr->mode & PNG_HAVE_IDAT) == 0)
355 png_error(png_ptr, "No IDATs written into file");
357 #ifdef PNG_WRITE_CHECK_FOR_INVALID_INDEX_SUPPORTED
358 if (png_ptr->num_palette_max > png_ptr->num_palette)
359 png_benign_error(png_ptr, "Wrote palette index exceeding num_palette");
360 #endif
362 /* See if user wants us to write information chunks */
363 if (info_ptr != NULL)
365 #ifdef PNG_WRITE_TEXT_SUPPORTED
366 int i; /* local index variable */
367 #endif
368 #ifdef PNG_WRITE_tIME_SUPPORTED
369 /* Check to see if user has supplied a time chunk */
370 if ((info_ptr->valid & PNG_INFO_tIME) != 0 &&
371 (png_ptr->mode & PNG_WROTE_tIME) == 0)
372 png_write_tIME(png_ptr, &(info_ptr->mod_time));
374 #endif
375 #ifdef PNG_WRITE_TEXT_SUPPORTED
376 /* Loop through comment chunks */
377 for (i = 0; i < info_ptr->num_text; i++)
379 png_debug2(2, "Writing trailer text chunk %d, type %d", i,
380 info_ptr->text[i].compression);
381 /* An internationalized chunk? */
382 if (info_ptr->text[i].compression > 0)
384 #ifdef PNG_WRITE_iTXt_SUPPORTED
385 /* Write international chunk */
386 png_write_iTXt(png_ptr,
387 info_ptr->text[i].compression,
388 info_ptr->text[i].key,
389 info_ptr->text[i].lang,
390 info_ptr->text[i].lang_key,
391 info_ptr->text[i].text);
392 /* Mark this chunk as written */
393 if (info_ptr->text[i].compression == PNG_TEXT_COMPRESSION_NONE)
394 info_ptr->text[i].compression = PNG_TEXT_COMPRESSION_NONE_WR;
395 else
396 info_ptr->text[i].compression = PNG_TEXT_COMPRESSION_zTXt_WR;
397 #else
398 png_warning(png_ptr, "Unable to write international text");
399 #endif
402 else if (info_ptr->text[i].compression >= PNG_TEXT_COMPRESSION_zTXt)
404 #ifdef PNG_WRITE_zTXt_SUPPORTED
405 /* Write compressed chunk */
406 png_write_zTXt(png_ptr, info_ptr->text[i].key,
407 info_ptr->text[i].text, info_ptr->text[i].compression);
408 /* Mark this chunk as written */
409 info_ptr->text[i].compression = PNG_TEXT_COMPRESSION_zTXt_WR;
410 #else
411 png_warning(png_ptr, "Unable to write compressed text");
412 #endif
415 else if (info_ptr->text[i].compression == PNG_TEXT_COMPRESSION_NONE)
417 #ifdef PNG_WRITE_tEXt_SUPPORTED
418 /* Write uncompressed chunk */
419 png_write_tEXt(png_ptr, info_ptr->text[i].key,
420 info_ptr->text[i].text, 0);
421 /* Mark this chunk as written */
422 info_ptr->text[i].compression = PNG_TEXT_COMPRESSION_NONE_WR;
423 #else
424 png_warning(png_ptr, "Unable to write uncompressed text");
425 #endif
428 #endif
429 #ifdef PNG_WRITE_UNKNOWN_CHUNKS_SUPPORTED
430 write_unknown_chunks(png_ptr, info_ptr, PNG_AFTER_IDAT);
431 #endif
434 png_ptr->mode |= PNG_AFTER_IDAT;
436 /* Write end of PNG file */
437 png_write_IEND(png_ptr);
439 /* This flush, added in libpng-1.0.8, removed from libpng-1.0.9beta03,
440 * and restored again in libpng-1.2.30, may cause some applications that
441 * do not set png_ptr->output_flush_fn to crash. If your application
442 * experiences a problem, please try building libpng with
443 * PNG_WRITE_FLUSH_AFTER_IEND_SUPPORTED defined, and report the event to
444 * png-mng-implement at lists.sf.net .
446 #ifdef PNG_WRITE_FLUSH_SUPPORTED
447 # ifdef PNG_WRITE_FLUSH_AFTER_IEND_SUPPORTED
448 png_flush(png_ptr);
449 # endif
450 #endif
453 #ifdef PNG_CONVERT_tIME_SUPPORTED
454 void PNGAPI
455 png_convert_from_struct_tm(png_timep ptime, PNG_CONST struct tm * ttime)
457 png_debug(1, "in png_convert_from_struct_tm");
459 ptime->year = (png_uint_16)(1900 + ttime->tm_year);
460 ptime->month = (png_byte)(ttime->tm_mon + 1);
461 ptime->day = (png_byte)ttime->tm_mday;
462 ptime->hour = (png_byte)ttime->tm_hour;
463 ptime->minute = (png_byte)ttime->tm_min;
464 ptime->second = (png_byte)ttime->tm_sec;
467 void PNGAPI
468 png_convert_from_time_t(png_timep ptime, time_t ttime)
470 struct tm *tbuf;
472 png_debug(1, "in png_convert_from_time_t");
474 tbuf = gmtime(&ttime);
475 png_convert_from_struct_tm(ptime, tbuf);
477 #endif
479 /* Initialize png_ptr structure, and allocate any memory needed */
480 PNG_FUNCTION(png_structp,PNGAPI
481 png_create_write_struct,(png_const_charp user_png_ver, png_voidp error_ptr,
482 png_error_ptr error_fn, png_error_ptr warn_fn),PNG_ALLOCATED)
484 #ifndef PNG_USER_MEM_SUPPORTED
485 png_structrp png_ptr = png_create_png_struct(user_png_ver, error_ptr,
486 error_fn, warn_fn, NULL, NULL, NULL);
487 #else
488 return png_create_write_struct_2(user_png_ver, error_ptr, error_fn,
489 warn_fn, NULL, NULL, NULL);
492 /* Alternate initialize png_ptr structure, and allocate any memory needed */
493 PNG_FUNCTION(png_structp,PNGAPI
494 png_create_write_struct_2,(png_const_charp user_png_ver, png_voidp error_ptr,
495 png_error_ptr error_fn, png_error_ptr warn_fn, png_voidp mem_ptr,
496 png_malloc_ptr malloc_fn, png_free_ptr free_fn),PNG_ALLOCATED)
498 png_structrp png_ptr = png_create_png_struct(user_png_ver, error_ptr,
499 error_fn, warn_fn, mem_ptr, malloc_fn, free_fn);
500 #endif /* USER_MEM */
501 if (png_ptr != NULL)
503 /* Set the zlib control values to defaults; they can be overridden by the
504 * application after the struct has been created.
506 png_ptr->zbuffer_size = PNG_ZBUF_SIZE;
508 /* The 'zlib_strategy' setting is irrelevant because png_default_claim in
509 * pngwutil.c defaults it according to whether or not filters will be
510 * used, and ignores this setting.
512 png_ptr->zlib_strategy = PNG_Z_DEFAULT_STRATEGY;
513 png_ptr->zlib_level = PNG_Z_DEFAULT_COMPRESSION;
514 png_ptr->zlib_mem_level = 8;
515 png_ptr->zlib_window_bits = 15;
516 png_ptr->zlib_method = 8;
518 #ifdef PNG_WRITE_COMPRESSED_TEXT_SUPPORTED
519 png_ptr->zlib_text_strategy = PNG_TEXT_Z_DEFAULT_STRATEGY;
520 png_ptr->zlib_text_level = PNG_TEXT_Z_DEFAULT_COMPRESSION;
521 png_ptr->zlib_text_mem_level = 8;
522 png_ptr->zlib_text_window_bits = 15;
523 png_ptr->zlib_text_method = 8;
524 #endif /* WRITE_COMPRESSED_TEXT */
526 /* This is a highly dubious configuration option; by default it is off,
527 * but it may be appropriate for private builds that are testing
528 * extensions not conformant to the current specification, or of
529 * applications that must not fail to write at all costs!
531 #ifdef PNG_BENIGN_WRITE_ERRORS_SUPPORTED
532 /* In stable builds only warn if an application error can be completely
533 * handled.
535 png_ptr->flags |= PNG_FLAG_BENIGN_ERRORS_WARN;
536 #endif
538 /* App warnings are warnings in release (or release candidate) builds but
539 * are errors during development.
541 #if PNG_LIBPNG_BUILD_BASE_TYPE >= PNG_LIBPNG_BUILD_RC
542 png_ptr->flags |= PNG_FLAG_APP_WARNINGS_WARN;
543 #endif
545 /* TODO: delay this, it can be done in png_init_io() (if the app doesn't
546 * do it itself) avoiding setting the default function if it is not
547 * required.
549 png_set_write_fn(png_ptr, NULL, NULL, NULL);
552 return png_ptr;
556 /* Write a few rows of image data. If the image is interlaced,
557 * either you will have to write the 7 sub images, or, if you
558 * have called png_set_interlace_handling(), you will have to
559 * "write" the image seven times.
561 void PNGAPI
562 png_write_rows(png_structrp png_ptr, png_bytepp row,
563 png_uint_32 num_rows)
565 png_uint_32 i; /* row counter */
566 png_bytepp rp; /* row pointer */
568 png_debug(1, "in png_write_rows");
570 if (png_ptr == NULL)
571 return;
573 /* Loop through the rows */
574 for (i = 0, rp = row; i < num_rows; i++, rp++)
576 png_write_row(png_ptr, *rp);
580 /* Write the image. You only need to call this function once, even
581 * if you are writing an interlaced image.
583 void PNGAPI
584 png_write_image(png_structrp png_ptr, png_bytepp image)
586 png_uint_32 i; /* row index */
587 int pass, num_pass; /* pass variables */
588 png_bytepp rp; /* points to current row */
590 if (png_ptr == NULL)
591 return;
593 png_debug(1, "in png_write_image");
595 #ifdef PNG_WRITE_INTERLACING_SUPPORTED
596 /* Initialize interlace handling. If image is not interlaced,
597 * this will set pass to 1
599 num_pass = png_set_interlace_handling(png_ptr);
600 #else
601 num_pass = 1;
602 #endif
603 /* Loop through passes */
604 for (pass = 0; pass < num_pass; pass++)
606 /* Loop through image */
607 for (i = 0, rp = image; i < png_ptr->height; i++, rp++)
609 png_write_row(png_ptr, *rp);
614 #ifdef PNG_MNG_FEATURES_SUPPORTED
615 /* Performs intrapixel differencing */
616 static void
617 png_do_write_intrapixel(png_row_infop row_info, png_bytep row)
619 png_debug(1, "in png_do_write_intrapixel");
621 if ((row_info->color_type & PNG_COLOR_MASK_COLOR) != 0)
623 int bytes_per_pixel;
624 png_uint_32 row_width = row_info->width;
625 if (row_info->bit_depth == 8)
627 png_bytep rp;
628 png_uint_32 i;
630 if (row_info->color_type == PNG_COLOR_TYPE_RGB)
631 bytes_per_pixel = 3;
633 else if (row_info->color_type == PNG_COLOR_TYPE_RGB_ALPHA)
634 bytes_per_pixel = 4;
636 else
637 return;
639 for (i = 0, rp = row; i < row_width; i++, rp += bytes_per_pixel)
641 *(rp) = (png_byte)((*rp - *(rp + 1)) & 0xff);
642 *(rp + 2) = (png_byte)((*(rp + 2) - *(rp + 1)) & 0xff);
646 #ifdef PNG_WRITE_16BIT_SUPPORTED
647 else if (row_info->bit_depth == 16)
649 png_bytep rp;
650 png_uint_32 i;
652 if (row_info->color_type == PNG_COLOR_TYPE_RGB)
653 bytes_per_pixel = 6;
655 else if (row_info->color_type == PNG_COLOR_TYPE_RGB_ALPHA)
656 bytes_per_pixel = 8;
658 else
659 return;
661 for (i = 0, rp = row; i < row_width; i++, rp += bytes_per_pixel)
663 png_uint_32 s0 = (*(rp ) << 8) | *(rp + 1);
664 png_uint_32 s1 = (*(rp + 2) << 8) | *(rp + 3);
665 png_uint_32 s2 = (*(rp + 4) << 8) | *(rp + 5);
666 png_uint_32 red = (png_uint_32)((s0 - s1) & 0xffffL);
667 png_uint_32 blue = (png_uint_32)((s2 - s1) & 0xffffL);
668 *(rp ) = (png_byte)((red >> 8) & 0xff);
669 *(rp + 1) = (png_byte)(red & 0xff);
670 *(rp + 4) = (png_byte)((blue >> 8) & 0xff);
671 *(rp + 5) = (png_byte)(blue & 0xff);
674 #endif /* WRITE_16BIT */
677 #endif /* MNG_FEATURES */
679 /* Called by user to write a row of image data */
680 void PNGAPI
681 png_write_row(png_structrp png_ptr, png_const_bytep row)
683 /* 1.5.6: moved from png_struct to be a local structure: */
684 png_row_info row_info;
686 if (png_ptr == NULL)
687 return;
689 png_debug2(1, "in png_write_row (row %u, pass %d)",
690 png_ptr->row_number, png_ptr->pass);
692 /* Initialize transformations and other stuff if first time */
693 if (png_ptr->row_number == 0 && png_ptr->pass == 0)
695 /* Make sure we wrote the header info */
696 if ((png_ptr->mode & PNG_WROTE_INFO_BEFORE_PLTE) == 0)
697 png_error(png_ptr,
698 "png_write_info was never called before png_write_row");
700 /* Check for transforms that have been set but were defined out */
701 #if !defined(PNG_WRITE_INVERT_SUPPORTED) && defined(PNG_READ_INVERT_SUPPORTED)
702 if ((png_ptr->transformations & PNG_INVERT_MONO) != 0)
703 png_warning(png_ptr, "PNG_WRITE_INVERT_SUPPORTED is not defined");
704 #endif
706 #if !defined(PNG_WRITE_FILLER_SUPPORTED) && defined(PNG_READ_FILLER_SUPPORTED)
707 if ((png_ptr->transformations & PNG_FILLER) != 0)
708 png_warning(png_ptr, "PNG_WRITE_FILLER_SUPPORTED is not defined");
709 #endif
710 #if !defined(PNG_WRITE_PACKSWAP_SUPPORTED) && \
711 defined(PNG_READ_PACKSWAP_SUPPORTED)
712 if ((png_ptr->transformations & PNG_PACKSWAP) != 0)
713 png_warning(png_ptr,
714 "PNG_WRITE_PACKSWAP_SUPPORTED is not defined");
715 #endif
717 #if !defined(PNG_WRITE_PACK_SUPPORTED) && defined(PNG_READ_PACK_SUPPORTED)
718 if ((png_ptr->transformations & PNG_PACK) != 0)
719 png_warning(png_ptr, "PNG_WRITE_PACK_SUPPORTED is not defined");
720 #endif
722 #if !defined(PNG_WRITE_SHIFT_SUPPORTED) && defined(PNG_READ_SHIFT_SUPPORTED)
723 if ((png_ptr->transformations & PNG_SHIFT) != 0)
724 png_warning(png_ptr, "PNG_WRITE_SHIFT_SUPPORTED is not defined");
725 #endif
727 #if !defined(PNG_WRITE_BGR_SUPPORTED) && defined(PNG_READ_BGR_SUPPORTED)
728 if ((png_ptr->transformations & PNG_BGR) != 0)
729 png_warning(png_ptr, "PNG_WRITE_BGR_SUPPORTED is not defined");
730 #endif
732 #if !defined(PNG_WRITE_SWAP_SUPPORTED) && defined(PNG_READ_SWAP_SUPPORTED)
733 if ((png_ptr->transformations & PNG_SWAP_BYTES) != 0)
734 png_warning(png_ptr, "PNG_WRITE_SWAP_SUPPORTED is not defined");
735 #endif
737 png_write_start_row(png_ptr);
740 #ifdef PNG_WRITE_INTERLACING_SUPPORTED
741 /* If interlaced and not interested in row, return */
742 if (png_ptr->interlaced != 0 &&
743 (png_ptr->transformations & PNG_INTERLACE) != 0)
745 switch (png_ptr->pass)
747 case 0:
748 if ((png_ptr->row_number & 0x07) != 0)
750 png_write_finish_row(png_ptr);
751 return;
753 break;
755 case 1:
756 if ((png_ptr->row_number & 0x07) != 0 || png_ptr->width < 5)
758 png_write_finish_row(png_ptr);
759 return;
761 break;
763 case 2:
764 if ((png_ptr->row_number & 0x07) != 4)
766 png_write_finish_row(png_ptr);
767 return;
769 break;
771 case 3:
772 if ((png_ptr->row_number & 0x03) != 0 || png_ptr->width < 3)
774 png_write_finish_row(png_ptr);
775 return;
777 break;
779 case 4:
780 if ((png_ptr->row_number & 0x03) != 2)
782 png_write_finish_row(png_ptr);
783 return;
785 break;
787 case 5:
788 if ((png_ptr->row_number & 0x01) != 0 || png_ptr->width < 2)
790 png_write_finish_row(png_ptr);
791 return;
793 break;
795 case 6:
796 if ((png_ptr->row_number & 0x01) == 0)
798 png_write_finish_row(png_ptr);
799 return;
801 break;
803 default: /* error: ignore it */
804 break;
807 #endif
809 /* Set up row info for transformations */
810 row_info.color_type = png_ptr->color_type;
811 row_info.width = png_ptr->usr_width;
812 row_info.channels = png_ptr->usr_channels;
813 row_info.bit_depth = png_ptr->usr_bit_depth;
814 row_info.pixel_depth = (png_byte)(row_info.bit_depth * row_info.channels);
815 row_info.rowbytes = PNG_ROWBYTES(row_info.pixel_depth, row_info.width);
817 png_debug1(3, "row_info->color_type = %d", row_info.color_type);
818 png_debug1(3, "row_info->width = %u", row_info.width);
819 png_debug1(3, "row_info->channels = %d", row_info.channels);
820 png_debug1(3, "row_info->bit_depth = %d", row_info.bit_depth);
821 png_debug1(3, "row_info->pixel_depth = %d", row_info.pixel_depth);
822 png_debug1(3, "row_info->rowbytes = %lu", (unsigned long)row_info.rowbytes);
824 /* Copy user's row into buffer, leaving room for filter byte. */
825 memcpy(png_ptr->row_buf + 1, row, row_info.rowbytes);
827 #ifdef PNG_WRITE_INTERLACING_SUPPORTED
828 /* Handle interlacing */
829 if (png_ptr->interlaced && png_ptr->pass < 6 &&
830 (png_ptr->transformations & PNG_INTERLACE) != 0)
832 png_do_write_interlace(&row_info, png_ptr->row_buf + 1, png_ptr->pass);
833 /* This should always get caught above, but still ... */
834 if (row_info.width == 0)
836 png_write_finish_row(png_ptr);
837 return;
840 #endif
842 #ifdef PNG_WRITE_TRANSFORMS_SUPPORTED
843 /* Handle other transformations */
844 if (png_ptr->transformations != 0)
845 png_do_write_transformations(png_ptr, &row_info);
846 #endif
848 /* At this point the row_info pixel depth must match the 'transformed' depth,
849 * which is also the output depth.
851 if (row_info.pixel_depth != png_ptr->pixel_depth ||
852 row_info.pixel_depth != png_ptr->transformed_pixel_depth)
853 png_error(png_ptr, "internal write transform logic error");
855 #ifdef PNG_MNG_FEATURES_SUPPORTED
856 /* Write filter_method 64 (intrapixel differencing) only if
857 * 1. Libpng was compiled with PNG_MNG_FEATURES_SUPPORTED and
858 * 2. Libpng did not write a PNG signature (this filter_method is only
859 * used in PNG datastreams that are embedded in MNG datastreams) and
860 * 3. The application called png_permit_mng_features with a mask that
861 * included PNG_FLAG_MNG_FILTER_64 and
862 * 4. The filter_method is 64 and
863 * 5. The color_type is RGB or RGBA
865 if ((png_ptr->mng_features_permitted & PNG_FLAG_MNG_FILTER_64) != 0 &&
866 (png_ptr->filter_type == PNG_INTRAPIXEL_DIFFERENCING))
868 /* Intrapixel differencing */
869 png_do_write_intrapixel(&row_info, png_ptr->row_buf + 1);
871 #endif
873 /* Added at libpng-1.5.10 */
874 #ifdef PNG_WRITE_CHECK_FOR_INVALID_INDEX_SUPPORTED
875 /* Check for out-of-range palette index */
876 if (row_info.color_type == PNG_COLOR_TYPE_PALETTE &&
877 png_ptr->num_palette_max >= 0)
878 png_do_check_palette_indexes(png_ptr, &row_info);
879 #endif
881 /* Find a filter if necessary, filter the row and write it out. */
882 png_write_find_filter(png_ptr, &row_info);
884 if (png_ptr->write_row_fn != NULL)
885 (*(png_ptr->write_row_fn))(png_ptr, png_ptr->row_number, png_ptr->pass);
888 #ifdef PNG_WRITE_FLUSH_SUPPORTED
889 /* Set the automatic flush interval or 0 to turn flushing off */
890 void PNGAPI
891 png_set_flush(png_structrp png_ptr, int nrows)
893 png_debug(1, "in png_set_flush");
895 if (png_ptr == NULL)
896 return;
898 png_ptr->flush_dist = (nrows < 0 ? 0 : nrows);
901 /* Flush the current output buffers now */
902 void PNGAPI
903 png_write_flush(png_structrp png_ptr)
905 png_debug(1, "in png_write_flush");
907 if (png_ptr == NULL)
908 return;
910 /* We have already written out all of the data */
911 if (png_ptr->row_number >= png_ptr->num_rows)
912 return;
914 png_compress_IDAT(png_ptr, NULL, 0, Z_SYNC_FLUSH);
915 png_ptr->flush_rows = 0;
916 png_flush(png_ptr);
918 #endif /* WRITE_FLUSH */
920 #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED
921 static void png_reset_filter_heuristics(png_structrp png_ptr);/* forward decl */
922 #endif
924 /* Free any memory used in png_ptr struct without freeing the struct itself. */
925 static void
926 png_write_destroy(png_structrp png_ptr)
928 png_debug(1, "in png_write_destroy");
930 /* Free any memory zlib uses */
931 if ((png_ptr->flags & PNG_FLAG_ZSTREAM_INITIALIZED) != 0)
932 deflateEnd(&png_ptr->zstream);
934 /* Free our memory. png_free checks NULL for us. */
935 png_free_buffer_list(png_ptr, &png_ptr->zbuffer_list);
936 png_free(png_ptr, png_ptr->row_buf);
937 png_ptr->row_buf = NULL;
938 #ifdef PNG_WRITE_FILTER_SUPPORTED
939 png_free(png_ptr, png_ptr->prev_row);
940 png_free(png_ptr, png_ptr->sub_row);
941 png_free(png_ptr, png_ptr->up_row);
942 png_free(png_ptr, png_ptr->avg_row);
943 png_free(png_ptr, png_ptr->paeth_row);
944 png_ptr->prev_row = NULL;
945 png_ptr->sub_row = NULL;
946 png_ptr->up_row = NULL;
947 png_ptr->avg_row = NULL;
948 png_ptr->paeth_row = NULL;
949 #endif
951 #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED
952 /* Use this to save a little code space, it doesn't free the filter_costs */
953 png_reset_filter_heuristics(png_ptr);
954 png_free(png_ptr, png_ptr->filter_costs);
955 png_free(png_ptr, png_ptr->inv_filter_costs);
956 png_ptr->filter_costs = NULL;
957 png_ptr->inv_filter_costs = NULL;
958 #endif
960 #ifdef PNG_SET_UNKNOWN_CHUNKS_SUPPORTED
961 png_free(png_ptr, png_ptr->chunk_list);
962 png_ptr->chunk_list = NULL;
963 #endif
965 /* The error handling and memory handling information is left intact at this
966 * point: the jmp_buf may still have to be freed. See png_destroy_png_struct
967 * for how this happens.
971 /* Free all memory used by the write.
972 * In libpng 1.6.0 this API changed quietly to no longer accept a NULL value for
973 * *png_ptr_ptr. Prior to 1.6.0 it would accept such a value and it would free
974 * the passed in info_structs but it would quietly fail to free any of the data
975 * inside them. In 1.6.0 it quietly does nothing (it has to be quiet because it
976 * has no png_ptr.)
978 void PNGAPI
979 png_destroy_write_struct(png_structpp png_ptr_ptr, png_infopp info_ptr_ptr)
981 png_debug(1, "in png_destroy_write_struct");
983 if (png_ptr_ptr != NULL)
985 png_structrp png_ptr = *png_ptr_ptr;
987 if (png_ptr != NULL) /* added in libpng 1.6.0 */
989 png_destroy_info_struct(png_ptr, info_ptr_ptr);
991 *png_ptr_ptr = NULL;
992 png_write_destroy(png_ptr);
993 png_destroy_png_struct(png_ptr);
998 /* Allow the application to select one or more row filters to use. */
999 void PNGAPI
1000 png_set_filter(png_structrp png_ptr, int method, int filters)
1002 png_debug(1, "in png_set_filter");
1004 if (png_ptr == NULL)
1005 return;
1007 #ifdef PNG_MNG_FEATURES_SUPPORTED
1008 if ((png_ptr->mng_features_permitted & PNG_FLAG_MNG_FILTER_64) != 0 &&
1009 (method == PNG_INTRAPIXEL_DIFFERENCING))
1010 method = PNG_FILTER_TYPE_BASE;
1012 #endif
1013 if (method == PNG_FILTER_TYPE_BASE)
1015 switch (filters & (PNG_ALL_FILTERS | 0x07))
1017 #ifdef PNG_WRITE_FILTER_SUPPORTED
1018 case 5:
1019 case 6:
1020 case 7: png_app_error(png_ptr, "Unknown row filter for method 0");
1021 /* FALL THROUGH */
1022 #endif /* WRITE_FILTER */
1023 case PNG_FILTER_VALUE_NONE:
1024 png_ptr->do_filter = PNG_FILTER_NONE; break;
1026 #ifdef PNG_WRITE_FILTER_SUPPORTED
1027 case PNG_FILTER_VALUE_SUB:
1028 png_ptr->do_filter = PNG_FILTER_SUB; break;
1030 case PNG_FILTER_VALUE_UP:
1031 png_ptr->do_filter = PNG_FILTER_UP; break;
1033 case PNG_FILTER_VALUE_AVG:
1034 png_ptr->do_filter = PNG_FILTER_AVG; break;
1036 case PNG_FILTER_VALUE_PAETH:
1037 png_ptr->do_filter = PNG_FILTER_PAETH; break;
1039 default:
1040 png_ptr->do_filter = (png_byte)filters; break;
1041 #else
1042 default:
1043 png_app_error(png_ptr, "Unknown row filter for method 0");
1044 #endif /* WRITE_FILTER */
1047 /* If we have allocated the row_buf, this means we have already started
1048 * with the image and we should have allocated all of the filter buffers
1049 * that have been selected. If prev_row isn't already allocated, then
1050 * it is too late to start using the filters that need it, since we
1051 * will be missing the data in the previous row. If an application
1052 * wants to start and stop using particular filters during compression,
1053 * it should start out with all of the filters, and then add and
1054 * remove them after the start of compression.
1056 if (png_ptr->row_buf != NULL)
1058 #ifdef PNG_WRITE_FILTER_SUPPORTED
1059 if ((png_ptr->do_filter & PNG_FILTER_SUB) != 0 &&
1060 png_ptr->sub_row == NULL)
1062 png_ptr->sub_row = (png_bytep)png_malloc(png_ptr,
1063 (png_ptr->rowbytes + 1));
1064 png_ptr->sub_row[0] = PNG_FILTER_VALUE_SUB;
1067 if ((png_ptr->do_filter & PNG_FILTER_UP) != 0 &&
1068 png_ptr->up_row == NULL)
1070 if (png_ptr->prev_row == NULL)
1072 png_warning(png_ptr, "Can't add Up filter after starting");
1073 png_ptr->do_filter = (png_byte)(png_ptr->do_filter &
1074 ~PNG_FILTER_UP);
1077 else
1079 png_ptr->up_row = (png_bytep)png_malloc(png_ptr,
1080 (png_ptr->rowbytes + 1));
1081 png_ptr->up_row[0] = PNG_FILTER_VALUE_UP;
1085 if ((png_ptr->do_filter & PNG_FILTER_AVG) != 0 &&
1086 png_ptr->avg_row == NULL)
1088 if (png_ptr->prev_row == NULL)
1090 png_warning(png_ptr, "Can't add Average filter after starting");
1091 png_ptr->do_filter = (png_byte)(png_ptr->do_filter &
1092 ~PNG_FILTER_AVG);
1095 else
1097 png_ptr->avg_row = (png_bytep)png_malloc(png_ptr,
1098 (png_ptr->rowbytes + 1));
1099 png_ptr->avg_row[0] = PNG_FILTER_VALUE_AVG;
1103 if ((png_ptr->do_filter & PNG_FILTER_PAETH) != 0 &&
1104 png_ptr->paeth_row == NULL)
1106 if (png_ptr->prev_row == NULL)
1108 png_warning(png_ptr, "Can't add Paeth filter after starting");
1109 png_ptr->do_filter &= (png_byte)(~PNG_FILTER_PAETH);
1112 else
1114 png_ptr->paeth_row = (png_bytep)png_malloc(png_ptr,
1115 (png_ptr->rowbytes + 1));
1116 png_ptr->paeth_row[0] = PNG_FILTER_VALUE_PAETH;
1120 if (png_ptr->do_filter == PNG_NO_FILTERS)
1121 #endif /* WRITE_FILTER */
1122 png_ptr->do_filter = PNG_FILTER_NONE;
1125 else
1126 png_error(png_ptr, "Unknown custom filter method");
1129 /* This allows us to influence the way in which libpng chooses the "best"
1130 * filter for the current scanline. While the "minimum-sum-of-absolute-
1131 * differences metric is relatively fast and effective, there is some
1132 * question as to whether it can be improved upon by trying to keep the
1133 * filtered data going to zlib more consistent, hopefully resulting in
1134 * better compression.
1136 #ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* GRR 970116 */
1137 /* Convenience reset API. */
1138 static void
1139 png_reset_filter_heuristics(png_structrp png_ptr)
1141 /* Clear out any old values in the 'weights' - this must be done because if
1142 * the app calls set_filter_heuristics multiple times with different
1143 * 'num_weights' values we would otherwise potentially have wrong sized
1144 * arrays.
1146 png_ptr->num_prev_filters = 0;
1147 png_ptr->heuristic_method = PNG_FILTER_HEURISTIC_UNWEIGHTED;
1148 if (png_ptr->prev_filters != NULL)
1150 png_bytep old = png_ptr->prev_filters;
1151 png_ptr->prev_filters = NULL;
1152 png_free(png_ptr, old);
1154 if (png_ptr->filter_weights != NULL)
1156 png_uint_16p old = png_ptr->filter_weights;
1157 png_ptr->filter_weights = NULL;
1158 png_free(png_ptr, old);
1161 if (png_ptr->inv_filter_weights != NULL)
1163 png_uint_16p old = png_ptr->inv_filter_weights;
1164 png_ptr->inv_filter_weights = NULL;
1165 png_free(png_ptr, old);
1168 /* Leave the filter_costs - this array is fixed size. */
1171 static int
1172 png_init_filter_heuristics(png_structrp png_ptr, int heuristic_method,
1173 int num_weights)
1175 if (png_ptr == NULL)
1176 return 0;
1178 /* Clear out the arrays */
1179 png_reset_filter_heuristics(png_ptr);
1181 /* Check arguments; the 'reset' function makes the correct settings for the
1182 * unweighted case, but we must handle the weight case by initializing the
1183 * arrays for the caller.
1185 if (heuristic_method == PNG_FILTER_HEURISTIC_WEIGHTED)
1187 int i;
1189 if (num_weights > 0)
1191 png_ptr->prev_filters = (png_bytep)png_malloc(png_ptr,
1192 (png_uint_32)((sizeof (png_byte)) * num_weights));
1194 /* To make sure that the weighting starts out fairly */
1195 for (i = 0; i < num_weights; i++)
1197 png_ptr->prev_filters[i] = 255;
1200 png_ptr->filter_weights = (png_uint_16p)png_malloc(png_ptr,
1201 (png_uint_32)((sizeof (png_uint_16)) * num_weights));
1203 png_ptr->inv_filter_weights = (png_uint_16p)png_malloc(png_ptr,
1204 (png_uint_32)((sizeof (png_uint_16)) * num_weights));
1206 for (i = 0; i < num_weights; i++)
1208 png_ptr->inv_filter_weights[i] =
1209 png_ptr->filter_weights[i] = PNG_WEIGHT_FACTOR;
1212 /* Safe to set this now */
1213 png_ptr->num_prev_filters = (png_byte)num_weights;
1216 /* If, in the future, there are other filter methods, this would
1217 * need to be based on png_ptr->filter.
1219 if (png_ptr->filter_costs == NULL)
1221 png_ptr->filter_costs = (png_uint_16p)png_malloc(png_ptr,
1222 (png_uint_32)((sizeof (png_uint_16)) * PNG_FILTER_VALUE_LAST));
1224 png_ptr->inv_filter_costs = (png_uint_16p)png_malloc(png_ptr,
1225 (png_uint_32)((sizeof (png_uint_16)) * PNG_FILTER_VALUE_LAST));
1228 for (i = 0; i < PNG_FILTER_VALUE_LAST; i++)
1230 png_ptr->inv_filter_costs[i] =
1231 png_ptr->filter_costs[i] = PNG_COST_FACTOR;
1234 /* All the arrays are inited, safe to set this: */
1235 png_ptr->heuristic_method = PNG_FILTER_HEURISTIC_WEIGHTED;
1237 /* Return the 'ok' code. */
1238 return 1;
1240 else if (heuristic_method == PNG_FILTER_HEURISTIC_DEFAULT ||
1241 heuristic_method == PNG_FILTER_HEURISTIC_UNWEIGHTED)
1243 return 1;
1245 else
1247 png_warning(png_ptr, "Unknown filter heuristic method");
1248 return 0;
1252 /* Provide floating and fixed point APIs */
1253 #ifdef PNG_FLOATING_POINT_SUPPORTED
1254 void PNGAPI
1255 png_set_filter_heuristics(png_structrp png_ptr, int heuristic_method,
1256 int num_weights, png_const_doublep filter_weights,
1257 png_const_doublep filter_costs)
1259 png_debug(1, "in png_set_filter_heuristics");
1261 /* The internal API allocates all the arrays and ensures that the elements of
1262 * those arrays are set to the default value.
1264 if (png_init_filter_heuristics(png_ptr, heuristic_method, num_weights) == 0)
1265 return;
1267 /* If using the weighted method copy in the weights. */
1268 if (heuristic_method == PNG_FILTER_HEURISTIC_WEIGHTED)
1270 int i;
1271 for (i = 0; i < num_weights; i++)
1273 if (filter_weights[i] <= 0.0)
1275 png_ptr->inv_filter_weights[i] =
1276 png_ptr->filter_weights[i] = PNG_WEIGHT_FACTOR;
1279 else
1281 png_ptr->inv_filter_weights[i] =
1282 (png_uint_16)(PNG_WEIGHT_FACTOR*filter_weights[i]+.5);
1284 png_ptr->filter_weights[i] =
1285 (png_uint_16)(PNG_WEIGHT_FACTOR/filter_weights[i]+.5);
1289 /* Here is where we set the relative costs of the different filters. We
1290 * should take the desired compression level into account when setting
1291 * the costs, so that Paeth, for instance, has a high relative cost at low
1292 * compression levels, while it has a lower relative cost at higher
1293 * compression settings. The filter types are in order of increasing
1294 * relative cost, so it would be possible to do this with an algorithm.
1296 for (i = 0; i < PNG_FILTER_VALUE_LAST; i++) if (filter_costs[i] >= 1.0)
1298 png_ptr->inv_filter_costs[i] =
1299 (png_uint_16)(PNG_COST_FACTOR / filter_costs[i] + .5);
1301 png_ptr->filter_costs[i] =
1302 (png_uint_16)(PNG_COST_FACTOR * filter_costs[i] + .5);
1306 #endif /* FLOATING_POINT */
1308 #ifdef PNG_FIXED_POINT_SUPPORTED
1309 void PNGAPI
1310 png_set_filter_heuristics_fixed(png_structrp png_ptr, int heuristic_method,
1311 int num_weights, png_const_fixed_point_p filter_weights,
1312 png_const_fixed_point_p filter_costs)
1314 png_debug(1, "in png_set_filter_heuristics_fixed");
1316 /* The internal API allocates all the arrays and ensures that the elements of
1317 * those arrays are set to the default value.
1319 if (png_init_filter_heuristics(png_ptr, heuristic_method, num_weights) == 0)
1320 return;
1322 /* If using the weighted method copy in the weights. */
1323 if (heuristic_method == PNG_FILTER_HEURISTIC_WEIGHTED)
1325 int i;
1326 for (i = 0; i < num_weights; i++)
1328 if (filter_weights[i] <= 0)
1330 png_ptr->inv_filter_weights[i] =
1331 png_ptr->filter_weights[i] = PNG_WEIGHT_FACTOR;
1334 else
1336 png_ptr->inv_filter_weights[i] = (png_uint_16)
1337 ((PNG_WEIGHT_FACTOR*filter_weights[i]+PNG_FP_HALF)/PNG_FP_1);
1339 png_ptr->filter_weights[i] = (png_uint_16)((PNG_WEIGHT_FACTOR*
1340 PNG_FP_1+(filter_weights[i]/2))/filter_weights[i]);
1344 /* Here is where we set the relative costs of the different filters. We
1345 * should take the desired compression level into account when setting
1346 * the costs, so that Paeth, for instance, has a high relative cost at low
1347 * compression levels, while it has a lower relative cost at higher
1348 * compression settings. The filter types are in order of increasing
1349 * relative cost, so it would be possible to do this with an algorithm.
1351 for (i = 0; i < PNG_FILTER_VALUE_LAST; i++)
1352 if (filter_costs[i] >= PNG_FP_1)
1354 png_uint_32 tmp;
1356 /* Use a 32 bit unsigned temporary here because otherwise the
1357 * intermediate value will be a 32 bit *signed* integer (ANSI rules)
1358 * and this will get the wrong answer on division.
1360 tmp = PNG_COST_FACTOR*PNG_FP_1 + (filter_costs[i]/2);
1361 tmp /= filter_costs[i];
1363 png_ptr->inv_filter_costs[i] = (png_uint_16)tmp;
1365 tmp = PNG_COST_FACTOR * filter_costs[i] + PNG_FP_HALF;
1366 tmp /= PNG_FP_1;
1368 png_ptr->filter_costs[i] = (png_uint_16)tmp;
1372 #endif /* FIXED_POINT */
1373 #endif /* WRITE_WEIGHTED_FILTER */
1375 void PNGAPI
1376 png_set_compression_level(png_structrp png_ptr, int level)
1378 png_debug(1, "in png_set_compression_level");
1380 if (png_ptr == NULL)
1381 return;
1383 png_ptr->zlib_level = level;
1386 void PNGAPI
1387 png_set_compression_mem_level(png_structrp png_ptr, int mem_level)
1389 png_debug(1, "in png_set_compression_mem_level");
1391 if (png_ptr == NULL)
1392 return;
1394 png_ptr->zlib_mem_level = mem_level;
1397 void PNGAPI
1398 png_set_compression_strategy(png_structrp png_ptr, int strategy)
1400 png_debug(1, "in png_set_compression_strategy");
1402 if (png_ptr == NULL)
1403 return;
1405 /* The flag setting here prevents the libpng dynamic selection of strategy.
1407 png_ptr->flags |= PNG_FLAG_ZLIB_CUSTOM_STRATEGY;
1408 png_ptr->zlib_strategy = strategy;
1411 /* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1412 * smaller value of window_bits if it can do so safely.
1414 void PNGAPI
1415 png_set_compression_window_bits(png_structrp png_ptr, int window_bits)
1417 if (png_ptr == NULL)
1418 return;
1420 /* Prior to 1.6.0 this would warn but then set the window_bits value, this
1421 * meant that negative window bits values could be selected which would cause
1422 * libpng to write a non-standard PNG file with raw deflate or gzip
1423 * compressed IDAT or ancillary chunks. Such files can be read and there is
1424 * no warning on read, so this seems like a very bad idea.
1426 if (window_bits > 15)
1428 png_warning(png_ptr, "Only compression windows <= 32k supported by PNG");
1429 window_bits = 15;
1432 else if (window_bits < 8)
1434 png_warning(png_ptr, "Only compression windows >= 256 supported by PNG");
1435 window_bits = 8;
1438 png_ptr->zlib_window_bits = window_bits;
1441 void PNGAPI
1442 png_set_compression_method(png_structrp png_ptr, int method)
1444 png_debug(1, "in png_set_compression_method");
1446 if (png_ptr == NULL)
1447 return;
1449 /* This would produce an invalid PNG file if it worked, but it doesn't and
1450 * deflate will fault it, so it is harmless to just warn here.
1452 if (method != 8)
1453 png_warning(png_ptr, "Only compression method 8 is supported by PNG");
1455 png_ptr->zlib_method = method;
1458 /* The following were added to libpng-1.5.4 */
1459 #ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED
1460 void PNGAPI
1461 png_set_text_compression_level(png_structrp png_ptr, int level)
1463 png_debug(1, "in png_set_text_compression_level");
1465 if (png_ptr == NULL)
1466 return;
1468 png_ptr->zlib_text_level = level;
1471 void PNGAPI
1472 png_set_text_compression_mem_level(png_structrp png_ptr, int mem_level)
1474 png_debug(1, "in png_set_text_compression_mem_level");
1476 if (png_ptr == NULL)
1477 return;
1479 png_ptr->zlib_text_mem_level = mem_level;
1482 void PNGAPI
1483 png_set_text_compression_strategy(png_structrp png_ptr, int strategy)
1485 png_debug(1, "in png_set_text_compression_strategy");
1487 if (png_ptr == NULL)
1488 return;
1490 png_ptr->zlib_text_strategy = strategy;
1493 /* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1494 * smaller value of window_bits if it can do so safely.
1496 void PNGAPI
1497 png_set_text_compression_window_bits(png_structrp png_ptr, int window_bits)
1499 if (png_ptr == NULL)
1500 return;
1502 if (window_bits > 15)
1504 png_warning(png_ptr, "Only compression windows <= 32k supported by PNG");
1505 window_bits = 15;
1508 else if (window_bits < 8)
1510 png_warning(png_ptr, "Only compression windows >= 256 supported by PNG");
1511 window_bits = 8;
1514 png_ptr->zlib_text_window_bits = window_bits;
1517 void PNGAPI
1518 png_set_text_compression_method(png_structrp png_ptr, int method)
1520 png_debug(1, "in png_set_text_compression_method");
1522 if (png_ptr == NULL)
1523 return;
1525 if (method != 8)
1526 png_warning(png_ptr, "Only compression method 8 is supported by PNG");
1528 png_ptr->zlib_text_method = method;
1530 #endif /* WRITE_CUSTOMIZE_ZTXT_COMPRESSION */
1531 /* end of API added to libpng-1.5.4 */
1533 void PNGAPI
1534 png_set_write_status_fn(png_structrp png_ptr, png_write_status_ptr write_row_fn)
1536 if (png_ptr == NULL)
1537 return;
1539 png_ptr->write_row_fn = write_row_fn;
1542 #ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
1543 void PNGAPI
1544 png_set_write_user_transform_fn(png_structrp png_ptr, png_user_transform_ptr
1545 write_user_transform_fn)
1547 png_debug(1, "in png_set_write_user_transform_fn");
1549 if (png_ptr == NULL)
1550 return;
1552 png_ptr->transformations |= PNG_USER_TRANSFORM;
1553 png_ptr->write_user_transform_fn = write_user_transform_fn;
1555 #endif
1558 #ifdef PNG_INFO_IMAGE_SUPPORTED
1559 void PNGAPI
1560 png_write_png(png_structrp png_ptr, png_inforp info_ptr,
1561 int transforms, voidp params)
1563 if (png_ptr == NULL || info_ptr == NULL)
1564 return;
1566 if ((info_ptr->valid & PNG_INFO_IDAT) == 0)
1568 png_app_error(png_ptr, "no rows for png_write_image to write");
1569 return;
1572 /* Write the file header information. */
1573 png_write_info(png_ptr, info_ptr);
1575 /* ------ these transformations don't touch the info structure ------- */
1577 /* Invert monochrome pixels */
1578 if ((transforms & PNG_TRANSFORM_INVERT_MONO) != 0)
1579 #ifdef PNG_WRITE_INVERT_SUPPORTED
1580 png_set_invert_mono(png_ptr);
1581 #else
1582 png_app_error(png_ptr, "PNG_TRANSFORM_INVERT_MONO not supported");
1583 #endif
1585 /* Shift the pixels up to a legal bit depth and fill in
1586 * as appropriate to correctly scale the image.
1588 if ((transforms & PNG_TRANSFORM_SHIFT) != 0)
1589 #ifdef PNG_WRITE_SHIFT_SUPPORTED
1590 if ((info_ptr->valid & PNG_INFO_sBIT) != 0)
1591 png_set_shift(png_ptr, &info_ptr->sig_bit);
1592 #else
1593 png_app_error(png_ptr, "PNG_TRANSFORM_SHIFT not supported");
1594 #endif
1596 /* Pack pixels into bytes */
1597 if ((transforms & PNG_TRANSFORM_PACKING) != 0)
1598 #ifdef PNG_WRITE_PACK_SUPPORTED
1599 png_set_packing(png_ptr);
1600 #else
1601 png_app_error(png_ptr, "PNG_TRANSFORM_PACKING not supported");
1602 #endif
1604 /* Swap location of alpha bytes from ARGB to RGBA */
1605 if ((transforms & PNG_TRANSFORM_SWAP_ALPHA) != 0)
1606 #ifdef PNG_WRITE_SWAP_ALPHA_SUPPORTED
1607 png_set_swap_alpha(png_ptr);
1608 #else
1609 png_app_error(png_ptr, "PNG_TRANSFORM_SWAP_ALPHA not supported");
1610 #endif
1612 /* Remove a filler (X) from XRGB/RGBX/AG/GA into to convert it into
1613 * RGB, note that the code expects the input color type to be G or RGB; no
1614 * alpha channel.
1616 if ((transforms & (PNG_TRANSFORM_STRIP_FILLER_AFTER|
1617 PNG_TRANSFORM_STRIP_FILLER_BEFORE)) != 0)
1619 #ifdef PNG_WRITE_FILLER_SUPPORTED
1620 if ((transforms & PNG_TRANSFORM_STRIP_FILLER_AFTER) != 0)
1622 if ((transforms & PNG_TRANSFORM_STRIP_FILLER_BEFORE) != 0)
1623 png_app_error(png_ptr,
1624 "PNG_TRANSFORM_STRIP_FILLER: BEFORE+AFTER not supported");
1626 /* Continue if ignored - this is the pre-1.6.10 behavior */
1627 png_set_filler(png_ptr, 0, PNG_FILLER_AFTER);
1630 else if ((transforms & PNG_TRANSFORM_STRIP_FILLER_BEFORE) != 0)
1631 png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
1632 #else
1633 png_app_error(png_ptr, "PNG_TRANSFORM_STRIP_FILLER not supported");
1634 #endif
1637 /* Flip BGR pixels to RGB */
1638 if ((transforms & PNG_TRANSFORM_BGR) != 0)
1639 #ifdef PNG_WRITE_BGR_SUPPORTED
1640 png_set_bgr(png_ptr);
1641 #else
1642 png_app_error(png_ptr, "PNG_TRANSFORM_BGR not supported");
1643 #endif
1645 /* Swap bytes of 16-bit files to most significant byte first */
1646 if ((transforms & PNG_TRANSFORM_SWAP_ENDIAN) != 0)
1647 #ifdef PNG_WRITE_SWAP_SUPPORTED
1648 png_set_swap(png_ptr);
1649 #else
1650 png_app_error(png_ptr, "PNG_TRANSFORM_SWAP_ENDIAN not supported");
1651 #endif
1653 /* Swap bits of 1, 2, 4 bit packed pixel formats */
1654 if ((transforms & PNG_TRANSFORM_PACKSWAP) != 0)
1655 #ifdef PNG_WRITE_PACKSWAP_SUPPORTED
1656 png_set_packswap(png_ptr);
1657 #else
1658 png_app_error(png_ptr, "PNG_TRANSFORM_PACKSWAP not supported");
1659 #endif
1661 /* Invert the alpha channel from opacity to transparency */
1662 if ((transforms & PNG_TRANSFORM_INVERT_ALPHA) != 0)
1663 #ifdef PNG_WRITE_INVERT_ALPHA_SUPPORTED
1664 png_set_invert_alpha(png_ptr);
1665 #else
1666 png_app_error(png_ptr, "PNG_TRANSFORM_INVERT_ALPHA not supported");
1667 #endif
1669 /* ----------------------- end of transformations ------------------- */
1671 /* Write the bits */
1672 png_write_image(png_ptr, info_ptr->row_pointers);
1674 /* It is REQUIRED to call this to finish writing the rest of the file */
1675 png_write_end(png_ptr, info_ptr);
1677 PNG_UNUSED(params)
1679 #endif
1682 #ifdef PNG_SIMPLIFIED_WRITE_SUPPORTED
1683 #ifdef PNG_STDIO_SUPPORTED /* currently required for png_image_write_* */
1684 /* Initialize the write structure - general purpose utility. */
1685 static int
1686 png_image_write_init(png_imagep image)
1688 png_structp png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING, image,
1689 png_safe_error, png_safe_warning);
1691 if (png_ptr != NULL)
1693 png_infop info_ptr = png_create_info_struct(png_ptr);
1695 if (info_ptr != NULL)
1697 png_controlp control = png_voidcast(png_controlp,
1698 png_malloc_warn(png_ptr, (sizeof *control)));
1700 if (control != NULL)
1702 memset(control, 0, (sizeof *control));
1704 control->png_ptr = png_ptr;
1705 control->info_ptr = info_ptr;
1706 control->for_write = 1;
1708 image->opaque = control;
1709 return 1;
1712 /* Error clean up */
1713 png_destroy_info_struct(png_ptr, &info_ptr);
1716 png_destroy_write_struct(&png_ptr, NULL);
1719 return png_image_error(image, "png_image_write_: out of memory");
1722 /* Arguments to png_image_write_main: */
1723 typedef struct
1725 /* Arguments: */
1726 png_imagep image;
1727 png_const_voidp buffer;
1728 png_int_32 row_stride;
1729 png_const_voidp colormap;
1730 int convert_to_8bit;
1731 /* Local variables: */
1732 png_const_voidp first_row;
1733 ptrdiff_t row_bytes;
1734 png_voidp local_row;
1735 } png_image_write_control;
1737 /* Write png_uint_16 input to a 16-bit PNG; the png_ptr has already been set to
1738 * do any necessary byte swapping. The component order is defined by the
1739 * png_image format value.
1741 static int
1742 png_write_image_16bit(png_voidp argument)
1744 png_image_write_control *display = png_voidcast(png_image_write_control*,
1745 argument);
1746 png_imagep image = display->image;
1747 png_structrp png_ptr = image->opaque->png_ptr;
1749 png_const_uint_16p input_row = png_voidcast(png_const_uint_16p,
1750 display->first_row);
1751 png_uint_16p output_row = png_voidcast(png_uint_16p, display->local_row);
1752 png_uint_16p row_end;
1753 const int channels = (image->format & PNG_FORMAT_FLAG_COLOR) != 0 ? 3 : 1;
1754 int aindex = 0;
1755 png_uint_32 y = image->height;
1757 if ((image->format & PNG_FORMAT_FLAG_ALPHA) != 0)
1759 # ifdef PNG_SIMPLIFIED_WRITE_AFIRST_SUPPORTED
1760 if ((image->format & PNG_FORMAT_FLAG_AFIRST) != 0)
1762 aindex = -1;
1763 ++input_row; /* To point to the first component */
1764 ++output_row;
1767 else
1768 # endif
1769 aindex = channels;
1772 else
1773 png_error(png_ptr, "png_write_image: internal call error");
1775 /* Work out the output row end and count over this, note that the increment
1776 * above to 'row' means that row_end can actually be beyond the end of the
1777 * row; this is correct.
1779 row_end = output_row + image->width * (channels+1);
1781 while (y-- > 0)
1783 png_const_uint_16p in_ptr = input_row;
1784 png_uint_16p out_ptr = output_row;
1786 while (out_ptr < row_end)
1788 const png_uint_16 alpha = in_ptr[aindex];
1789 png_uint_32 reciprocal = 0;
1790 int c;
1792 out_ptr[aindex] = alpha;
1794 /* Calculate a reciprocal. The correct calculation is simply
1795 * component/alpha*65535 << 15. (I.e. 15 bits of precision); this
1796 * allows correct rounding by adding .5 before the shift. 'reciprocal'
1797 * is only initialized when required.
1799 if (alpha > 0 && alpha < 65535)
1800 reciprocal = ((0xffff<<15)+(alpha>>1))/alpha;
1802 c = channels;
1803 do /* always at least one channel */
1805 png_uint_16 component = *in_ptr++;
1807 /* The following gives 65535 for an alpha of 0, which is fine,
1808 * otherwise if 0/0 is represented as some other value there is more
1809 * likely to be a discontinuity which will probably damage
1810 * compression when moving from a fully transparent area to a
1811 * nearly transparent one. (The assumption here is that opaque
1812 * areas tend not to be 0 intensity.)
1814 if (component >= alpha)
1815 component = 65535;
1817 /* component<alpha, so component/alpha is less than one and
1818 * component*reciprocal is less than 2^31.
1820 else if (component > 0 && alpha < 65535)
1822 png_uint_32 calc = component * reciprocal;
1823 calc += 16384; /* round to nearest */
1824 component = (png_uint_16)(calc >> 15);
1827 *out_ptr++ = component;
1829 while (--c > 0);
1831 /* Skip to next component (skip the intervening alpha channel) */
1832 ++in_ptr;
1833 ++out_ptr;
1836 png_write_row(png_ptr, png_voidcast(png_const_bytep, display->local_row));
1837 input_row += display->row_bytes/(sizeof (png_uint_16));
1840 return 1;
1843 /* Given 16-bit input (1 to 4 channels) write 8-bit output. If an alpha channel
1844 * is present it must be removed from the components, the components are then
1845 * written in sRGB encoding. No components are added or removed.
1847 * Calculate an alpha reciprocal to reverse pre-multiplication. As above the
1848 * calculation can be done to 15 bits of accuracy; however, the output needs to
1849 * be scaled in the range 0..255*65535, so include that scaling here.
1851 #define UNP_RECIPROCAL(alpha) ((((0xffff*0xff)<<7)+(alpha>>1))/alpha)
1853 static png_byte
1854 png_unpremultiply(png_uint_32 component, png_uint_32 alpha,
1855 png_uint_32 reciprocal/*from the above macro*/)
1857 /* The following gives 1.0 for an alpha of 0, which is fine, otherwise if 0/0
1858 * is represented as some other value there is more likely to be a
1859 * discontinuity which will probably damage compression when moving from a
1860 * fully transparent area to a nearly transparent one. (The assumption here
1861 * is that opaque areas tend not to be 0 intensity.)
1863 * There is a rounding problem here; if alpha is less than 128 it will end up
1864 * as 0 when scaled to 8 bits. To avoid introducing spurious colors into the
1865 * output change for this too.
1867 if (component >= alpha || alpha < 128)
1868 return 255;
1870 /* component<alpha, so component/alpha is less than one and
1871 * component*reciprocal is less than 2^31.
1873 else if (component > 0)
1875 /* The test is that alpha/257 (rounded) is less than 255, the first value
1876 * that becomes 255 is 65407.
1877 * NOTE: this must agree with the PNG_DIV257 macro (which must, therefore,
1878 * be exact!) [Could also test reciprocal != 0]
1880 if (alpha < 65407)
1882 component *= reciprocal;
1883 component += 64; /* round to nearest */
1884 component >>= 7;
1887 else
1888 component *= 255;
1890 /* Convert the component to sRGB. */
1891 return (png_byte)PNG_sRGB_FROM_LINEAR(component);
1894 else
1895 return 0;
1898 static int
1899 png_write_image_8bit(png_voidp argument)
1901 png_image_write_control *display = png_voidcast(png_image_write_control*,
1902 argument);
1903 png_imagep image = display->image;
1904 png_structrp png_ptr = image->opaque->png_ptr;
1906 png_const_uint_16p input_row = png_voidcast(png_const_uint_16p,
1907 display->first_row);
1908 png_bytep output_row = png_voidcast(png_bytep, display->local_row);
1909 png_uint_32 y = image->height;
1910 const int channels = (image->format & PNG_FORMAT_FLAG_COLOR) != 0 ? 3 : 1;
1912 if ((image->format & PNG_FORMAT_FLAG_ALPHA) != 0)
1914 png_bytep row_end;
1915 int aindex;
1917 # ifdef PNG_SIMPLIFIED_WRITE_AFIRST_SUPPORTED
1918 if ((image->format & PNG_FORMAT_FLAG_AFIRST) != 0)
1920 aindex = -1;
1921 ++input_row; /* To point to the first component */
1922 ++output_row;
1925 else
1926 # endif
1927 aindex = channels;
1929 /* Use row_end in place of a loop counter: */
1930 row_end = output_row + image->width * (channels+1);
1932 while (y-- > 0)
1934 png_const_uint_16p in_ptr = input_row;
1935 png_bytep out_ptr = output_row;
1937 while (out_ptr < row_end)
1939 png_uint_16 alpha = in_ptr[aindex];
1940 png_byte alphabyte = (png_byte)PNG_DIV257(alpha);
1941 png_uint_32 reciprocal = 0;
1942 int c;
1944 /* Scale and write the alpha channel. */
1945 out_ptr[aindex] = alphabyte;
1947 if (alphabyte > 0 && alphabyte < 255)
1948 reciprocal = UNP_RECIPROCAL(alpha);
1950 c = channels;
1951 do /* always at least one channel */
1952 *out_ptr++ = png_unpremultiply(*in_ptr++, alpha, reciprocal);
1953 while (--c > 0);
1955 /* Skip to next component (skip the intervening alpha channel) */
1956 ++in_ptr;
1957 ++out_ptr;
1958 } /* while out_ptr < row_end */
1960 png_write_row(png_ptr, png_voidcast(png_const_bytep,
1961 display->local_row));
1962 input_row += display->row_bytes/(sizeof (png_uint_16));
1963 } /* while y */
1966 else
1968 /* No alpha channel, so the row_end really is the end of the row and it
1969 * is sufficient to loop over the components one by one.
1971 png_bytep row_end = output_row + image->width * channels;
1973 while (y-- > 0)
1975 png_const_uint_16p in_ptr = input_row;
1976 png_bytep out_ptr = output_row;
1978 while (out_ptr < row_end)
1980 png_uint_32 component = *in_ptr++;
1982 component *= 255;
1983 *out_ptr++ = (png_byte)PNG_sRGB_FROM_LINEAR(component);
1986 png_write_row(png_ptr, output_row);
1987 input_row += display->row_bytes/(sizeof (png_uint_16));
1991 return 1;
1994 static void
1995 png_image_set_PLTE(png_image_write_control *display)
1997 const png_imagep image = display->image;
1998 const void *cmap = display->colormap;
1999 const int entries = image->colormap_entries > 256 ? 256 :
2000 (int)image->colormap_entries;
2002 /* NOTE: the caller must check for cmap != NULL and entries != 0 */
2003 const png_uint_32 format = image->format;
2004 const int channels = PNG_IMAGE_SAMPLE_CHANNELS(format);
2006 # if defined(PNG_FORMAT_BGR_SUPPORTED) &&\
2007 defined(PNG_SIMPLIFIED_WRITE_AFIRST_SUPPORTED)
2008 const int afirst = (format & PNG_FORMAT_FLAG_AFIRST) != 0 &&
2009 (format & PNG_FORMAT_FLAG_ALPHA) != 0;
2010 # else
2011 # define afirst 0
2012 # endif
2014 # ifdef PNG_FORMAT_BGR_SUPPORTED
2015 const int bgr = (format & PNG_FORMAT_FLAG_BGR) != 0 ? 2 : 0;
2016 # else
2017 # define bgr 0
2018 # endif
2020 int i, num_trans;
2021 png_color palette[256];
2022 png_byte tRNS[256];
2024 memset(tRNS, 255, (sizeof tRNS));
2025 memset(palette, 0, (sizeof palette));
2027 for (i=num_trans=0; i<entries; ++i)
2029 /* This gets automatically converted to sRGB with reversal of the
2030 * pre-multiplication if the color-map has an alpha channel.
2032 if ((format & PNG_FORMAT_FLAG_LINEAR) != 0)
2034 png_const_uint_16p entry = png_voidcast(png_const_uint_16p, cmap);
2036 entry += i * channels;
2038 if ((channels & 1) != 0) /* no alpha */
2040 if (channels >= 3) /* RGB */
2042 palette[i].blue = (png_byte)PNG_sRGB_FROM_LINEAR(255 *
2043 entry[(2 ^ bgr)]);
2044 palette[i].green = (png_byte)PNG_sRGB_FROM_LINEAR(255 *
2045 entry[1]);
2046 palette[i].red = (png_byte)PNG_sRGB_FROM_LINEAR(255 *
2047 entry[bgr]);
2050 else /* Gray */
2051 palette[i].blue = palette[i].red = palette[i].green =
2052 (png_byte)PNG_sRGB_FROM_LINEAR(255 * *entry);
2055 else /* alpha */
2057 png_uint_16 alpha = entry[afirst ? 0 : channels-1];
2058 png_byte alphabyte = (png_byte)PNG_DIV257(alpha);
2059 png_uint_32 reciprocal = 0;
2061 /* Calculate a reciprocal, as in the png_write_image_8bit code above
2062 * this is designed to produce a value scaled to 255*65535 when
2063 * divided by 128 (i.e. asr 7).
2065 if (alphabyte > 0 && alphabyte < 255)
2066 reciprocal = (((0xffff*0xff)<<7)+(alpha>>1))/alpha;
2068 tRNS[i] = alphabyte;
2069 if (alphabyte < 255)
2070 num_trans = i+1;
2072 if (channels >= 3) /* RGB */
2074 palette[i].blue = png_unpremultiply(entry[afirst + (2 ^ bgr)],
2075 alpha, reciprocal);
2076 palette[i].green = png_unpremultiply(entry[afirst + 1], alpha,
2077 reciprocal);
2078 palette[i].red = png_unpremultiply(entry[afirst + bgr], alpha,
2079 reciprocal);
2082 else /* gray */
2083 palette[i].blue = palette[i].red = palette[i].green =
2084 png_unpremultiply(entry[afirst], alpha, reciprocal);
2088 else /* Color-map has sRGB values */
2090 png_const_bytep entry = png_voidcast(png_const_bytep, cmap);
2092 entry += i * channels;
2094 switch (channels)
2096 case 4:
2097 tRNS[i] = entry[afirst ? 0 : 3];
2098 if (tRNS[i] < 255)
2099 num_trans = i+1;
2100 /* FALL THROUGH */
2101 case 3:
2102 palette[i].blue = entry[afirst + (2 ^ bgr)];
2103 palette[i].green = entry[afirst + 1];
2104 palette[i].red = entry[afirst + bgr];
2105 break;
2107 case 2:
2108 tRNS[i] = entry[1 ^ afirst];
2109 if (tRNS[i] < 255)
2110 num_trans = i+1;
2111 /* FALL THROUGH */
2112 case 1:
2113 palette[i].blue = palette[i].red = palette[i].green =
2114 entry[afirst];
2115 break;
2117 default:
2118 break;
2123 # ifdef afirst
2124 # undef afirst
2125 # endif
2126 # ifdef bgr
2127 # undef bgr
2128 # endif
2130 png_set_PLTE(image->opaque->png_ptr, image->opaque->info_ptr, palette,
2131 entries);
2133 if (num_trans > 0)
2134 png_set_tRNS(image->opaque->png_ptr, image->opaque->info_ptr, tRNS,
2135 num_trans, NULL);
2137 image->colormap_entries = entries;
2140 static int
2141 png_image_write_main(png_voidp argument)
2143 png_image_write_control *display = png_voidcast(png_image_write_control*,
2144 argument);
2145 png_imagep image = display->image;
2146 png_structrp png_ptr = image->opaque->png_ptr;
2147 png_inforp info_ptr = image->opaque->info_ptr;
2148 png_uint_32 format = image->format;
2150 /* The following four ints are actually booleans */
2151 int colormap = (format & PNG_FORMAT_FLAG_COLORMAP);
2152 int linear = !colormap && (format & PNG_FORMAT_FLAG_LINEAR); /* input */
2153 int alpha = !colormap && (format & PNG_FORMAT_FLAG_ALPHA);
2154 int write_16bit = linear && !colormap && (display->convert_to_8bit == 0);
2156 # ifdef PNG_BENIGN_ERRORS_SUPPORTED
2157 /* Make sure we error out on any bad situation */
2158 png_set_benign_errors(png_ptr, 0/*error*/);
2159 # endif
2161 /* Default the 'row_stride' parameter if required. */
2162 if (display->row_stride == 0)
2163 display->row_stride = PNG_IMAGE_ROW_STRIDE(*image);
2165 /* Set the required transforms then write the rows in the correct order. */
2166 if ((format & PNG_FORMAT_FLAG_COLORMAP) != 0)
2168 if (display->colormap != NULL && image->colormap_entries > 0)
2170 png_uint_32 entries = image->colormap_entries;
2172 png_set_IHDR(png_ptr, info_ptr, image->width, image->height,
2173 entries > 16 ? 8 : (entries > 4 ? 4 : (entries > 2 ? 2 : 1)),
2174 PNG_COLOR_TYPE_PALETTE, PNG_INTERLACE_NONE,
2175 PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
2177 png_image_set_PLTE(display);
2180 else
2181 png_error(image->opaque->png_ptr,
2182 "no color-map for color-mapped image");
2185 else
2186 png_set_IHDR(png_ptr, info_ptr, image->width, image->height,
2187 write_16bit ? 16 : 8,
2188 ((format & PNG_FORMAT_FLAG_COLOR) ? PNG_COLOR_MASK_COLOR : 0) +
2189 ((format & PNG_FORMAT_FLAG_ALPHA) ? PNG_COLOR_MASK_ALPHA : 0),
2190 PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
2192 /* Counter-intuitively the data transformations must be called *after*
2193 * png_write_info, not before as in the read code, but the 'set' functions
2194 * must still be called before. Just set the color space information, never
2195 * write an interlaced image.
2198 if (write_16bit != 0)
2200 /* The gamma here is 1.0 (linear) and the cHRM chunk matches sRGB. */
2201 png_set_gAMA_fixed(png_ptr, info_ptr, PNG_GAMMA_LINEAR);
2203 if ((image->flags & PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB) == 0)
2204 png_set_cHRM_fixed(png_ptr, info_ptr,
2205 /* color x y */
2206 /* white */ 31270, 32900,
2207 /* red */ 64000, 33000,
2208 /* green */ 30000, 60000,
2209 /* blue */ 15000, 6000
2213 else if ((image->flags & PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB) == 0)
2214 png_set_sRGB(png_ptr, info_ptr, PNG_sRGB_INTENT_PERCEPTUAL);
2216 /* Else writing an 8-bit file and the *colors* aren't sRGB, but the 8-bit
2217 * space must still be gamma encoded.
2219 else
2220 png_set_gAMA_fixed(png_ptr, info_ptr, PNG_GAMMA_sRGB_INVERSE);
2222 /* Write the file header. */
2223 png_write_info(png_ptr, info_ptr);
2225 /* Now set up the data transformations (*after* the header is written),
2226 * remove the handled transformations from the 'format' flags for checking.
2228 * First check for a little endian system if writing 16 bit files.
2230 if (write_16bit != 0)
2232 PNG_CONST png_uint_16 le = 0x0001;
2234 if ((*(png_const_bytep) & le) != 0)
2235 png_set_swap(png_ptr);
2238 # ifdef PNG_SIMPLIFIED_WRITE_BGR_SUPPORTED
2239 if ((format & PNG_FORMAT_FLAG_BGR) != 0)
2241 if (colormap == 0 && (format & PNG_FORMAT_FLAG_COLOR) != 0)
2242 png_set_bgr(png_ptr);
2243 format &= ~PNG_FORMAT_FLAG_BGR;
2245 # endif
2247 # ifdef PNG_SIMPLIFIED_WRITE_AFIRST_SUPPORTED
2248 if ((format & PNG_FORMAT_FLAG_AFIRST) != 0)
2250 if (colormap == 0 && (format & PNG_FORMAT_FLAG_ALPHA) != 0)
2251 png_set_swap_alpha(png_ptr);
2252 format &= ~PNG_FORMAT_FLAG_AFIRST;
2254 # endif
2256 /* If there are 16 or fewer color-map entries we wrote a lower bit depth
2257 * above, but the application data is still byte packed.
2259 if (colormap != 0 && image->colormap_entries <= 16)
2260 png_set_packing(png_ptr);
2262 /* That should have handled all (both) the transforms. */
2263 if ((format & ~(png_uint_32)(PNG_FORMAT_FLAG_COLOR | PNG_FORMAT_FLAG_LINEAR |
2264 PNG_FORMAT_FLAG_ALPHA | PNG_FORMAT_FLAG_COLORMAP)) != 0)
2265 png_error(png_ptr, "png_write_image: unsupported transformation");
2268 png_const_bytep row = png_voidcast(png_const_bytep, display->buffer);
2269 ptrdiff_t row_bytes = display->row_stride;
2271 if (linear != 0)
2272 row_bytes *= (sizeof (png_uint_16));
2274 if (row_bytes < 0)
2275 row += (image->height-1) * (-row_bytes);
2277 display->first_row = row;
2278 display->row_bytes = row_bytes;
2281 /* Apply 'fast' options if the flag is set. */
2282 if ((image->flags & PNG_IMAGE_FLAG_FAST) != 0)
2284 png_set_filter(png_ptr, PNG_FILTER_TYPE_BASE, PNG_NO_FILTERS);
2285 /* NOTE: determined by experiment using pngstest, this reflects some
2286 * balance between the time to write the image once and the time to read
2287 * it about 50 times. The speed-up in pngstest was about 10-20% of the
2288 * total (user) time on a heavily loaded system.
2290 png_set_compression_level(png_ptr, 3);
2293 /* Check for the cases that currently require a pre-transform on the row
2294 * before it is written. This only applies when the input is 16-bit and
2295 * either there is an alpha channel or it is converted to 8-bit.
2297 if ((linear != 0 && alpha != 0 ) ||
2298 (colormap == 0 && display->convert_to_8bit != 0))
2300 png_bytep row = png_voidcast(png_bytep, png_malloc(png_ptr,
2301 png_get_rowbytes(png_ptr, info_ptr)));
2302 int result;
2304 display->local_row = row;
2305 if (write_16bit != 0)
2306 result = png_safe_execute(image, png_write_image_16bit, display);
2307 else
2308 result = png_safe_execute(image, png_write_image_8bit, display);
2309 display->local_row = NULL;
2311 png_free(png_ptr, row);
2313 /* Skip the 'write_end' on error: */
2314 if (result == 0)
2315 return 0;
2318 /* Otherwise this is the case where the input is in a format currently
2319 * supported by the rest of the libpng write code; call it directly.
2321 else
2323 png_const_bytep row = png_voidcast(png_const_bytep, display->first_row);
2324 ptrdiff_t row_bytes = display->row_bytes;
2325 png_uint_32 y = image->height;
2327 while (y-- > 0)
2329 png_write_row(png_ptr, row);
2330 row += row_bytes;
2334 png_write_end(png_ptr, info_ptr);
2335 return 1;
2338 int PNGAPI
2339 png_image_write_to_stdio(png_imagep image, FILE *file, int convert_to_8bit,
2340 const void *buffer, png_int_32 row_stride, const void *colormap)
2342 /* Write the image to the given (FILE*). */
2343 if (image != NULL && image->version == PNG_IMAGE_VERSION)
2345 if (file != NULL)
2347 if (png_image_write_init(image) != 0)
2349 png_image_write_control display;
2350 int result;
2352 /* This is slightly evil, but png_init_io doesn't do anything other
2353 * than this and we haven't changed the standard IO functions so
2354 * this saves a 'safe' function.
2356 image->opaque->png_ptr->io_ptr = file;
2358 memset(&display, 0, (sizeof display));
2359 display.image = image;
2360 display.buffer = buffer;
2361 display.row_stride = row_stride;
2362 display.colormap = colormap;
2363 display.convert_to_8bit = convert_to_8bit;
2365 result = png_safe_execute(image, png_image_write_main, &display);
2366 png_image_free(image);
2367 return result;
2370 else
2371 return 0;
2374 else
2375 return png_image_error(image,
2376 "png_image_write_to_stdio: invalid argument");
2379 else if (image != NULL)
2380 return png_image_error(image,
2381 "png_image_write_to_stdio: incorrect PNG_IMAGE_VERSION");
2383 else
2384 return 0;
2387 int PNGAPI
2388 png_image_write_to_file(png_imagep image, const char *file_name,
2389 int convert_to_8bit, const void *buffer, png_int_32 row_stride,
2390 const void *colormap)
2392 /* Write the image to the named file. */
2393 if (image != NULL && image->version == PNG_IMAGE_VERSION)
2395 if (file_name != NULL)
2397 FILE *fp = fopen(file_name, "wb");
2399 if (fp != NULL)
2401 if (png_image_write_to_stdio(image, fp, convert_to_8bit, buffer,
2402 row_stride, colormap) != 0)
2404 int error; /* from fflush/fclose */
2406 /* Make sure the file is flushed correctly. */
2407 if (fflush(fp) == 0 && ferror(fp) == 0)
2409 if (fclose(fp) == 0)
2410 return 1;
2412 error = errno; /* from fclose */
2415 else
2417 error = errno; /* from fflush or ferror */
2418 (void)fclose(fp);
2421 (void)remove(file_name);
2422 /* The image has already been cleaned up; this is just used to
2423 * set the error (because the original write succeeded).
2425 return png_image_error(image, strerror(error));
2428 else
2430 /* Clean up: just the opened file. */
2431 (void)fclose(fp);
2432 (void)remove(file_name);
2433 return 0;
2437 else
2438 return png_image_error(image, strerror(errno));
2441 else
2442 return png_image_error(image,
2443 "png_image_write_to_file: invalid argument");
2446 else if (image != NULL)
2447 return png_image_error(image,
2448 "png_image_write_to_file: incorrect PNG_IMAGE_VERSION");
2450 else
2451 return 0;
2453 #endif /* STDIO */
2454 #endif /* SIMPLIFIED_WRITE */
2455 #endif /* WRITE */