blob: e7d2d2f3c79beab63fa449d8c3a2baf161702418 [file] [log] [blame]
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -05002#if 0 /* in case someone actually tries to compile this */
3
Glenn Randers-Pehrsonb7f95932006-03-05 20:15:20 -06004/* example.c - an example of using libpng
John Bowler550bab02011-06-14 06:17:26 -05005 * Last changed in libpng 1.5.4 [(PENDING RELEASE)]
Glenn Randers-Pehrsonb7f95932006-03-05 20:15:20 -06006 * This file has been placed in the public domain by the authors.
Glenn Randers-Pehrson64b863c2011-01-04 09:57:06 -06007 * Maintained 1998-2011 Glenn Randers-Pehrson
Glenn Randers-Pehrsonb7f95932006-03-05 20:15:20 -06008 * Maintained 1996, 1997 Andreas Dilger)
9 * Written 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
10 */
Guy Schalnat0d580581995-07-20 02:43:20 -050011
Andreas Dilger47a0c421997-05-16 02:46:07 -050012/* This is an example of how to use libpng to read and write PNG files.
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -050013 * The file libpng-manual.txt is much more verbose then this. If you have not
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060014 * read it, do so first. This was designed to be a starting point of an
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060015 * implementation. This is not officially part of libpng, is hereby placed
16 * in the public domain, and therefore does not require a copyright notice.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060017 *
18 * This file does not currently compile, because it is missing certain
19 * parts, like allocating memory to hold an image. You will have to
20 * supply these parts to get it to compile. For an example of a minimal
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060021 * working PNG reader/writer, see pngtest.c, included in this distribution;
22 * see also the programs in the contrib directory.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060023 */
Guy Schalnat0d580581995-07-20 02:43:20 -050024
Glenn Randers-Pehrsone1018a52011-05-05 21:03:07 -050025#define _POSIX_SOURCE 1 /* libpng and zlib are POSIX-compliant. You may
26 * change this if your application uses non-POSIX
27 * extensions. */
28
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -060029#include "png.h"
Guy Schalnat0d580581995-07-20 02:43:20 -050030
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060031 /* The png_jmpbuf() macro, used in error handling, became available in
32 * libpng version 1.0.6. If you want to be able to run your code with older
33 * versions of libpng, you must define the macro yourself (but only if it
34 * is not already defined by libpng!).
35 */
36
37#ifndef png_jmpbuf
Glenn Randers-Pehrson95ca51b2010-02-19 14:09:09 -060038# define png_jmpbuf(png_ptr) ((png_ptr)->png_jmpbuf)
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060039#endif
40
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -060041/* Check to see if a file is a PNG file using png_sig_cmp(). png_sig_cmp()
42 * returns zero if the image is a PNG and nonzero if it isn't a PNG.
43 *
44 * The function check_if_png() shown here, but not used, returns nonzero (true)
45 * if the file can be opened and is a PNG, 0 (false) otherwise.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060046 *
47 * If this call is successful, and you are going to keep the file open,
48 * you should call png_set_sig_bytes(png_ptr, PNG_BYTES_TO_CHECK); once
49 * you have created the png_ptr, so that libpng knows your application
50 * has read that many bytes from the start of the file. Make sure you
51 * don't call png_set_sig_bytes() with more than 8 bytes read or give it
52 * an incorrect number of bytes read, or you will either have read too
53 * many bytes (your fault), or you are telling libpng to read the wrong
54 * number of magic bytes (also your fault).
55 *
56 * Many applications already read the first 2 or 4 bytes from the start
57 * of the image to determine the file type, so it would be easiest just
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -060058 * to pass the bytes to png_sig_cmp() or even skip that if you know
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060059 * you have a PNG file, and call png_set_sig_bytes().
60 */
Andreas Dilger47a0c421997-05-16 02:46:07 -050061#define PNG_BYTES_TO_CHECK 4
62int check_if_png(char *file_name, FILE **fp)
Guy Schalnat0d580581995-07-20 02:43:20 -050063{
Andreas Dilger47a0c421997-05-16 02:46:07 -050064 char buf[PNG_BYTES_TO_CHECK];
Guy Schalnat0d580581995-07-20 02:43:20 -050065
Andreas Dilger47a0c421997-05-16 02:46:07 -050066 /* Open the prospective PNG file. */
Glenn Randers-Pehrson68ea2432000-04-01 21:10:05 -060067 if ((*fp = fopen(file_name, "rb")) == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -050068 return 0;
69
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -060070 /* Read in some of the signature bytes */
Andreas Dilger47a0c421997-05-16 02:46:07 -050071 if (fread(buf, 1, PNG_BYTES_TO_CHECK, *fp) != PNG_BYTES_TO_CHECK)
72 return 0;
Guy Schalnat0d580581995-07-20 02:43:20 -050073
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -060074 /* Compare the first PNG_BYTES_TO_CHECK bytes of the signature.
75 Return nonzero (true) if they match */
76
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -050077 return(!png_sig_cmp(buf, (png_size_t)0, PNG_BYTES_TO_CHECK));
Guy Schalnat0d580581995-07-20 02:43:20 -050078}
79
Andreas Dilger47a0c421997-05-16 02:46:07 -050080/* Read a PNG file. You may want to return an error code if the read
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060081 * fails (depending upon the failure). There are two "prototypes" given
82 * here - one where we are given the filename, and we need to open the
83 * file, and the other where we are given an open file (possibly with
84 * some or all of the magic bytes read - see comments above).
85 */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -060086#ifdef open_file /* prototype 1 */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060087void read_png(char *file_name) /* We need to open the file */
Guy Schalnat0d580581995-07-20 02:43:20 -050088{
Guy Schalnatb2e01bd1996-01-26 01:38:47 -060089 png_structp png_ptr;
Guy Schalnat6d764711995-12-19 03:22:19 -060090 png_infop info_ptr;
Andreas Dilger47a0c421997-05-16 02:46:07 -050091 unsigned int sig_read = 0;
92 png_uint_32 width, height;
93 int bit_depth, color_type, interlace_type;
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060094 FILE *fp;
Guy Schalnat0d580581995-07-20 02:43:20 -050095
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060096 if ((fp = fopen(file_name, "rb")) == NULL)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -050097 return (ERROR);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -050098
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -060099#else no_open_file /* prototype 2 */
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500100void read_png(FILE *fp, unsigned int sig_read) /* File is already open */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600101{
102 png_structp png_ptr;
103 png_infop info_ptr;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500104 png_uint_32 width, height;
105 int bit_depth, color_type, interlace_type;
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500106#endif no_open_file /* Only use one prototype! */
Guy Schalnat0d580581995-07-20 02:43:20 -0500107
Guy Schalnate5a37791996-06-05 15:50:50 -0500108 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500109 * functions. If you want to use the default stderr and longjump method,
110 * you can supply NULL for the last three parameters. We also supply the
111 * the compiler header file version, so that we know if the application
112 * was compiled with a compatible version of the library. REQUIRED
113 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500114 png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500115 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500116
Andreas Dilger47a0c421997-05-16 02:46:07 -0500117 if (png_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500118 {
119 fclose(fp);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500120 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500121 }
122
Andreas Dilger47a0c421997-05-16 02:46:07 -0500123 /* Allocate/initialize the memory for image information. REQUIRED. */
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -0600124 info_ptr = png_create_info_struct(png_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500125 if (info_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500126 {
127 fclose(fp);
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500128 png_destroy_read_struct(&png_ptr, NULL, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500129 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500130 }
131
Andreas Dilger47a0c421997-05-16 02:46:07 -0500132 /* Set error handling if you are using the setjmp/longjmp method (this is
133 * the normal method of doing things with libpng). REQUIRED unless you
134 * set up your own error handlers in the png_create_read_struct() earlier.
135 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600136
137 if (setjmp(png_jmpbuf(png_ptr)))
Guy Schalnat0d580581995-07-20 02:43:20 -0500138 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500139 /* Free all of the memory associated with the png_ptr and info_ptr */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500140 png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
Guy Schalnat0d580581995-07-20 02:43:20 -0500141 fclose(fp);
Guy Schalnat0d580581995-07-20 02:43:20 -0500142 /* If we get here, we had a problem reading the file */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500143 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500144 }
145
Andreas Dilger47a0c421997-05-16 02:46:07 -0500146 /* One of the following I/O initialization methods is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600147#ifdef streams /* PNG file I/O method 1 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500148 /* Set up the input control if you are using standard C streams */
Guy Schalnat0d580581995-07-20 02:43:20 -0500149 png_init_io(png_ptr, fp);
150
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600151#else no_streams /* PNG file I/O method 2 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500152 /* If you are using replacement read functions, instead of calling
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600153 * png_init_io() here you would call:
154 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500155 png_set_read_fn(png_ptr, (void *)user_io_ptr, user_read_fn);
156 /* where user_io_ptr is a structure you want available to the callbacks */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600157#endif no_streams /* Use only one I/O method! */
Guy Schalnat69b14481996-01-10 02:56:49 -0600158
Andreas Dilger47a0c421997-05-16 02:46:07 -0500159 /* If we have already read some of the signature */
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -0600160 png_set_sig_bytes(png_ptr, sig_read);
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600161
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600162#ifdef hilevel
163 /*
164 * If you have enough memory to read in the entire image at once,
165 * and you need to specify only transforms that can be controlled
166 * with one of the PNG_TRANSFORM_* bits (this presently excludes
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500167 * quantizing, filling, setting background, and doing gamma
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600168 * adjustment), then you can read the entire image (including
169 * pixels) into the info structure with this call:
170 */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500171 png_read_png(png_ptr, info_ptr, png_transforms, NULL);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500172
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600173#else
174 /* OK, you're doing it the hard way, with the lower-level functions */
175
Andreas Dilger47a0c421997-05-16 02:46:07 -0500176 /* The call to png_read_info() gives us all of the information from the
177 * PNG file before the first IDAT (image data chunk). REQUIRED
178 */
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600179 png_read_info(png_ptr, info_ptr);
Guy Schalnat69b14481996-01-10 02:56:49 -0600180
Andreas Dilger47a0c421997-05-16 02:46:07 -0500181 png_get_IHDR(png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500182 &interlace_type, NULL, NULL);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500183
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500184 /* Set up the data transformations you want. Note that these are all
185 * optional. Only call them if you want/need them. Many of the
186 * transformations only work on specific types of images, and many
187 * are mutually exclusive.
188 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500189
Glenn Randers-Pehrson857dbbe2011-06-16 09:39:40 -0500190 /* Tell libpng to strip 16 bit/color files down to 8 bits/color.
191 * Use accurate scaling if it's available, otherwise just chop off the
192 * low byte.
193 */
John Bowler8d261262011-06-18 13:37:11 -0500194#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
Glenn Randers-Pehrsonab63dd02011-06-17 20:04:17 -0500195 png_set_scale_16(png_ptr);
Glenn Randers-Pehrson857dbbe2011-06-16 09:39:40 -0500196#else
Glenn Randers-Pehrsonab63dd02011-06-17 20:04:17 -0500197 png_set_strip_16(png_ptr);
Glenn Randers-Pehrson857dbbe2011-06-16 09:39:40 -0500198#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -0500199
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500200 /* Strip alpha bytes from the input data without combining with the
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600201 * background (not recommended).
202 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500203 png_set_strip_alpha(png_ptr);
204
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600205 /* Extract multiple pixels with bit depths of 1, 2, and 4 from a single
Andreas Dilger47a0c421997-05-16 02:46:07 -0500206 * byte into separate bytes (useful for paletted and grayscale images).
207 */
208 png_set_packing(png_ptr);
209
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600210 /* Change the order of packed pixels to least significant bit first
Andreas Dilger47a0c421997-05-16 02:46:07 -0500211 * (not useful if you are using png_set_packing). */
212 png_set_packswap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500213
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600214 /* Expand paletted colors into true RGB triplets */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500215 if (color_type == PNG_COLOR_TYPE_PALETTE)
Glenn Randers-Pehrsonf46918d2006-06-02 05:31:20 -0500216 png_set_palette_to_rgb(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500217
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600218 /* Expand grayscale images to the full 8 bits from 1, 2, or 4 bits/pixel */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500219 if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8)
Glenn Randers-Pehrson56f63962008-10-06 10:16:17 -0500220 png_set_expand_gray_1_2_4_to_8(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500221
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600222 /* Expand paletted or RGB images with transparency to full alpha channels
223 * so the data will be available as RGBA quartets.
224 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500225 if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS))
Glenn Randers-Pehrsonb1828932001-06-23 08:03:17 -0500226 png_set_tRNS_to_alpha(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500227
Andreas Dilger47a0c421997-05-16 02:46:07 -0500228 /* Set the background color to draw transparent and alpha images over.
229 * It is possible to set the red, green, and blue components directly
230 * for paletted images instead of supplying a palette index. Note that
231 * even if the PNG file supplies a background, you are not required to
232 * use it - you should use the (solid) application background if it has one.
233 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500234
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600235 png_color_16 my_background, *image_background;
Guy Schalnat0d580581995-07-20 02:43:20 -0500236
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600237 if (png_get_bKGD(png_ptr, info_ptr, &image_background))
238 png_set_background(png_ptr, image_background,
Guy Schalnate5a37791996-06-05 15:50:50 -0500239 PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600240 else
241 png_set_background(png_ptr, &my_background,
Guy Schalnate5a37791996-06-05 15:50:50 -0500242 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
Guy Schalnat0d580581995-07-20 02:43:20 -0500243
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500244 /* Some suggestions as to how to get a screen gamma value
245 *
246 * Note that screen gamma is the display_exponent, which includes
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500247 * the CRT_exponent and any correction for viewing conditions
248 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500249 if (/* We have a user-defined screen gamma value */)
250 {
251 screen_gamma = user-defined screen_gamma;
252 }
253 /* This is one way that applications share the same screen gamma value */
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600254 else if ((gamma_str = getenv("SCREEN_GAMMA")) != NULL)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500255 {
256 screen_gamma = atof(gamma_str);
257 }
258 /* If we don't have another value */
259 else
260 {
Glenn Randers-Pehrsonf0a8fe02009-04-14 08:28:15 -0500261 screen_gamma = 2.2; /* A good guess for a PC monitor in a dimly
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600262 lit room */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500263 screen_gamma = 1.7 or 1.0; /* A good guess for Mac systems */
264 }
265
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600266 /* Tell libpng to handle the gamma conversion for you. The final call
Andreas Dilger47a0c421997-05-16 02:46:07 -0500267 * is a good guess for PC generated images, but it should be configurable
268 * by the user at run time by the user. It is strongly suggested that
269 * your application support gamma correction.
270 */
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600271
272 int intent;
273
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600274 if (png_get_sRGB(png_ptr, info_ptr, &intent))
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600275 png_set_gamma(png_ptr, screen_gamma, 0.45455);
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600276 else
277 {
278 double image_gamma;
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600279 if (png_get_gAMA(png_ptr, info_ptr, &image_gamma))
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600280 png_set_gamma(png_ptr, screen_gamma, image_gamma);
281 else
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600282 png_set_gamma(png_ptr, screen_gamma, 0.45455);
283 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500284
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500285#ifdef PNG_READ_QUANTIZE_SUPPORTED
286 /* Quantize RGB files down to 8 bit palette or reduce palettes
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600287 * to the number of colors available on your screen.
288 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500289 if (color_type & PNG_COLOR_MASK_COLOR)
Guy Schalnat0d580581995-07-20 02:43:20 -0500290 {
Glenn Randers-Pehrsonf05f8032000-12-23 14:27:39 -0600291 int num_palette;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500292 png_colorp palette;
293
294 /* This reduces the image to the application supplied palette */
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500295 if (/* We have our own palette */)
Guy Schalnat0d580581995-07-20 02:43:20 -0500296 {
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500297 /* An array of colors to which the image should be quantized */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500298 png_color std_color_cube[MAX_SCREEN_COLORS];
Guy Schalnat0d580581995-07-20 02:43:20 -0500299
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500300 png_set_quantize(png_ptr, std_color_cube, MAX_SCREEN_COLORS,
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500301 MAX_SCREEN_COLORS, NULL, 0);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500302 }
303 /* This reduces the image to the palette supplied in the file */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600304 else if (png_get_PLTE(png_ptr, info_ptr, &palette, &num_palette))
Andreas Dilger47a0c421997-05-16 02:46:07 -0500305 {
Glenn Randers-Pehrson865f4f02002-09-15 20:30:38 -0500306 png_uint_16p histogram = NULL;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500307
308 png_get_hIST(png_ptr, info_ptr, &histogram);
309
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500310 png_set_quantize(png_ptr, palette, num_palette,
Andreas Dilger47a0c421997-05-16 02:46:07 -0500311 max_screen_colors, histogram, 0);
Guy Schalnat0d580581995-07-20 02:43:20 -0500312 }
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600313 }
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500314#endif /* PNG_READ_QUANTIZE_SUPPORTED */
Guy Schalnat0d580581995-07-20 02:43:20 -0500315
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500316 /* Invert monochrome files to have 0 as white and 1 as black */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600317 png_set_invert_mono(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500318
Andreas Dilger47a0c421997-05-16 02:46:07 -0500319 /* If you want to shift the pixel values from the range [0,255] or
320 * [0,65535] to the original [0,7] or [0,31], or whatever range the
321 * colors were originally in:
322 */
323 if (png_get_valid(png_ptr, info_ptr, PNG_INFO_sBIT))
324 {
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500325 png_color_8p sig_bit_p;
Guy Schalnat0d580581995-07-20 02:43:20 -0500326
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500327 png_get_sBIT(png_ptr, info_ptr, &sig_bit_p);
328 png_set_shift(png_ptr, sig_bit_p);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500329 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500330
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500331 /* Flip the RGB pixels to BGR (or RGBA to BGRA) */
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -0500332 if (color_type & PNG_COLOR_MASK_COLOR)
333 png_set_bgr(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500334
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500335 /* Swap the RGBA or GA data to ARGB or AG (or BGRA to ABGR) */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500336 png_set_swap_alpha(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500337
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500338 /* Swap bytes of 16 bit files to least significant byte first */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500339 png_set_swap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500340
Andreas Dilger47a0c421997-05-16 02:46:07 -0500341 /* Add filler (or alpha) byte (before/after each RGB triplet) */
342 png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER);
343
344 /* Turn on interlace handling. REQUIRED if you are not using
345 * png_read_image(). To see how to handle interlacing passes,
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600346 * see the png_read_row() method below:
Andreas Dilger47a0c421997-05-16 02:46:07 -0500347 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500348 number_passes = png_set_interlace_handling(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500349
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600350 /* Optional call to gamma correct and add the background to the palette
Andreas Dilger47a0c421997-05-16 02:46:07 -0500351 * and update info structure. REQUIRED if you are expecting libpng to
352 * update the palette for you (ie you selected such a transform above).
353 */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500354 png_read_update_info(png_ptr, info_ptr);
355
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600356 /* Allocate the memory to hold the image using the fields of info_ptr. */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500357
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600358 /* The easiest way to read the image: */
Guy Schalnat6d764711995-12-19 03:22:19 -0600359 png_bytep row_pointers[height];
Guy Schalnate5a37791996-06-05 15:50:50 -0500360
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500361 /* Clear the pointer array */
Guy Schalnate5a37791996-06-05 15:50:50 -0500362 for (row = 0; row < height; row++)
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500363 row_pointers[row] = NULL;
364
365 for (row = 0; row < height; row++)
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500366 row_pointers[row] = png_malloc(png_ptr, png_get_rowbytes(png_ptr,
367 info_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -0500368
Andreas Dilger47a0c421997-05-16 02:46:07 -0500369 /* Now it's time to read the image. One of these methods is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600370#ifdef entire /* Read the entire image in one go */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500371 png_read_image(png_ptr, row_pointers);
372
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600373#else no_entire /* Read the image one or more scanlines at a time */
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600374 /* The other way to read images - deal with interlacing: */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500375
Guy Schalnat0d580581995-07-20 02:43:20 -0500376 for (pass = 0; pass < number_passes; pass++)
377 {
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600378#ifdef single /* Read the image a single row at a time */
Guy Schalnat0d580581995-07-20 02:43:20 -0500379 for (y = 0; y < height; y++)
380 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500381 png_read_rows(png_ptr, &row_pointers[y], NULL, 1);
Guy Schalnat0d580581995-07-20 02:43:20 -0500382 }
383
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600384#else no_single /* Read the image several rows at a time */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500385 for (y = 0; y < height; y += number_of_rows)
386 {
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600387#ifdef sparkle /* Read the image using the "sparkle" effect. */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500388 png_read_rows(png_ptr, &row_pointers[y], NULL,
389 number_of_rows);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600390#else no_sparkle /* Read the image using the "rectangle" effect */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500391 png_read_rows(png_ptr, NULL, &row_pointers[y],
392 number_of_rows);
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500393#endif no_sparkle /* Use only one of these two methods */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500394 }
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600395
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500396 /* If you want to display the image after every pass, do so here */
397#endif no_single /* Use only one of these two methods */
Guy Schalnat0d580581995-07-20 02:43:20 -0500398 }
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500399#endif no_entire /* Use only one of these two methods */
Guy Schalnat0d580581995-07-20 02:43:20 -0500400
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500401 /* Read rest of file, and get additional chunks in info_ptr - REQUIRED */
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600402 png_read_end(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600403#endif hilevel
404
405 /* At this point you have read the entire image */
Guy Schalnat0d580581995-07-20 02:43:20 -0500406
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500407 /* Clean up after the read, and free any memory allocated - REQUIRED */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500408 png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
Guy Schalnat0d580581995-07-20 02:43:20 -0500409
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500410 /* Close the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500411 fclose(fp);
412
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500413 /* That's it */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500414 return (OK);
Guy Schalnat0d580581995-07-20 02:43:20 -0500415}
416
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500417/* Progressively read a file */
Guy Schalnat6d764711995-12-19 03:22:19 -0600418
Guy Schalnat6d764711995-12-19 03:22:19 -0600419int
Guy Schalnate5a37791996-06-05 15:50:50 -0500420initialize_png_reader(png_structp *png_ptr, png_infop *info_ptr)
Guy Schalnat6d764711995-12-19 03:22:19 -0600421{
Guy Schalnate5a37791996-06-05 15:50:50 -0500422 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500423 * functions. If you want to use the default stderr and longjump method,
424 * you can supply NULL for the last three parameters. We also check that
425 * the library version is compatible in case we are using dynamically
426 * linked libraries.
Guy Schalnate5a37791996-06-05 15:50:50 -0500427 */
428 *png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500429 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500430
Andreas Dilger47a0c421997-05-16 02:46:07 -0500431 if (*png_ptr == NULL)
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600432 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500433 *info_ptr = NULL;
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500434 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600435 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600436
Guy Schalnate5a37791996-06-05 15:50:50 -0500437 *info_ptr = png_create_info_struct(png_ptr);
438
Andreas Dilger47a0c421997-05-16 02:46:07 -0500439 if (*info_ptr == NULL)
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600440 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500441 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500442 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600443 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600444
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600445 if (setjmp(png_jmpbuf((*png_ptr))))
Guy Schalnate5a37791996-06-05 15:50:50 -0500446 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500447 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500448 return (ERROR);
Guy Schalnate5a37791996-06-05 15:50:50 -0500449 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600450
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600451 /* This one's new. You will need to provide all three
Andreas Dilger47a0c421997-05-16 02:46:07 -0500452 * function callbacks, even if you aren't using them all.
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600453 * If you aren't using all functions, you can specify NULL
454 * parameters. Even when all three functions are NULL,
455 * you need to call png_set_progressive_read_fn().
Andreas Dilger47a0c421997-05-16 02:46:07 -0500456 * These functions shouldn't be dependent on global or
457 * static variables if you are decoding several images
458 * simultaneously. You should store stream specific data
459 * in a separate struct, given as the second parameter,
460 * and retrieve the pointer from inside the callbacks using
461 * the function png_get_progressive_ptr(png_ptr).
462 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500463 png_set_progressive_read_fn(*png_ptr, (void *)stream_data,
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600464 info_callback, row_callback, end_callback);
Guy Schalnat6d764711995-12-19 03:22:19 -0600465
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500466 return (OK);
Guy Schalnat6d764711995-12-19 03:22:19 -0600467}
468
469int
Guy Schalnate5a37791996-06-05 15:50:50 -0500470process_data(png_structp *png_ptr, png_infop *info_ptr,
471 png_bytep buffer, png_uint_32 length)
Guy Schalnat6d764711995-12-19 03:22:19 -0600472{
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600473 if (setjmp(png_jmpbuf((*png_ptr))))
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600474 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500475 /* Free the png_ptr and info_ptr memory on error */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500476 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500477 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600478 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600479
Andreas Dilger47a0c421997-05-16 02:46:07 -0500480 /* This one's new also. Simply give it chunks of data as
481 * they arrive from the data stream (in order, of course).
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500482 * On segmented machines, don't give it any more than 64K.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500483 * The library seems to run fine with sizes of 4K, although
484 * you can give it much less if necessary (I assume you can
485 * give it chunks of 1 byte, but I haven't tried with less
486 * than 256 bytes yet). When this function returns, you may
487 * want to display any rows that were generated in the row
488 * callback, if you aren't already displaying them there.
489 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500490 png_process_data(*png_ptr, *info_ptr, buffer, length);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500491 return (OK);
Guy Schalnat6d764711995-12-19 03:22:19 -0600492}
493
494info_callback(png_structp png_ptr, png_infop info)
495{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500496 /* Do any setup here, including setting any of the transformations
497 * mentioned in the Reading PNG files section. For now, you _must_
498 * call either png_start_read_image() or png_read_update_info()
499 * after all the transformations are set (even if you don't set
500 * any). You may start getting rows before png_process_data()
501 * returns, so this is your last chance to prepare for that.
502 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600503}
504
505row_callback(png_structp png_ptr, png_bytep new_row,
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600506 png_uint_32 row_num, int pass)
Guy Schalnat6d764711995-12-19 03:22:19 -0600507{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500508 /*
509 * This function is called for every row in the image. If the
510 * image is interlaced, and you turned on the interlace handler,
511 * this function will be called for every row in every pass.
512 *
513 * In this function you will receive a pointer to new row data from
514 * libpng called new_row that is to replace a corresponding row (of
515 * the same data format) in a buffer allocated by your application.
516 *
517 * The new row data pointer "new_row" may be NULL, indicating there is
518 * no new data to be replaced (in cases of interlace loading).
519 *
520 * If new_row is not NULL then you need to call
521 * png_progressive_combine_row() to replace the corresponding row as
522 * shown below:
523 */
524
Glenn Randers-Pehrson53c07f52010-06-18 18:55:55 -0500525 /* Get pointer to corresponding row in our
526 * PNG read buffer.
527 */
528 png_bytep old_row = ((png_bytep *)our_data)[row_num];
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -0500529
Glenn Randers-Pehrson53c07f52010-06-18 18:55:55 -0500530 /* If both rows are allocated then copy the new row
531 * data to the corresponding row data.
532 */
533 if ((old_row != NULL) && (new_row != NULL))
534 png_progressive_combine_row(png_ptr, old_row, new_row);
535
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500536 /*
537 * The rows and passes are called in order, so you don't really
538 * need the row_num and pass, but I'm supplying them because it
539 * may make your life easier.
540 *
541 * For the non-NULL rows of interlaced images, you must call
542 * png_progressive_combine_row() passing in the new row and the
543 * old row, as demonstrated above. You can call this function for
544 * NULL rows (it will just return) and for non-interlaced images
545 * (it just does the png_memcpy for you) if it will make the code
546 * easier. Thus, you can just do this for all cases:
547 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600548
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600549 png_progressive_combine_row(png_ptr, old_row, new_row);
Guy Schalnat6d764711995-12-19 03:22:19 -0600550
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500551 /* where old_row is what was displayed for previous rows. Note
552 * that the first pass (pass == 0 really) will completely cover
553 * the old row, so the rows do not have to be initialized. After
554 * the first pass (and only for interlaced images), you will have
555 * to pass the current row as new_row, and the function will combine
556 * the old row and the new row.
557 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600558}
559
560end_callback(png_structp png_ptr, png_infop info)
561{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500562 /* This function is called when the whole image has been read,
563 * including any chunks after the image (up to and including
564 * the IEND). You will usually have the same info chunk as you
565 * had in the header, although some data may have been added
566 * to the comments and time fields.
567 *
568 * Most people won't do much here, perhaps setting a flag that
569 * marks the image as finished.
570 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600571}
572
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500573/* Write a png file */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600574void write_png(char *file_name /* , ... other image information ... */)
Guy Schalnat0d580581995-07-20 02:43:20 -0500575{
576 FILE *fp;
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600577 png_structp png_ptr;
578 png_infop info_ptr;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600579 png_colorp palette;
Guy Schalnat0d580581995-07-20 02:43:20 -0500580
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500581 /* Open the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500582 fp = fopen(file_name, "wb");
Andreas Dilger47a0c421997-05-16 02:46:07 -0500583 if (fp == NULL)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500584 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500585
Guy Schalnate5a37791996-06-05 15:50:50 -0500586 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500587 * functions. If you want to use the default stderr and longjump method,
588 * you can supply NULL for the last three parameters. We also check that
589 * the library version is compatible with the one used at compile time,
590 * in case we are using dynamically linked libraries. REQUIRED.
Guy Schalnate5a37791996-06-05 15:50:50 -0500591 */
592 png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500593 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500594
Andreas Dilger47a0c421997-05-16 02:46:07 -0500595 if (png_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500596 {
597 fclose(fp);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500598 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500599 }
600
Andreas Dilger47a0c421997-05-16 02:46:07 -0500601 /* Allocate/initialize the image information data. REQUIRED */
Guy Schalnate5a37791996-06-05 15:50:50 -0500602 info_ptr = png_create_info_struct(png_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500603 if (info_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500604 {
605 fclose(fp);
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500606 png_destroy_write_struct(&png_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500607 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500608 }
609
Andreas Dilger47a0c421997-05-16 02:46:07 -0500610 /* Set error handling. REQUIRED if you aren't supplying your own
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600611 * error handling functions in the png_create_write_struct() call.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500612 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600613 if (setjmp(png_jmpbuf(png_ptr)))
Guy Schalnat0d580581995-07-20 02:43:20 -0500614 {
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500615 /* If we get here, we had a problem writing the file */
Guy Schalnate5a37791996-06-05 15:50:50 -0500616 fclose(fp);
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -0500617 png_destroy_write_struct(&png_ptr, &info_ptr);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500618 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500619 }
620
Andreas Dilger47a0c421997-05-16 02:46:07 -0500621 /* One of the following I/O initialization functions is REQUIRED */
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500622
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600623#ifdef streams /* I/O initialization method 1 */
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500624 /* Set up the output control if you are using standard C streams */
Guy Schalnat0d580581995-07-20 02:43:20 -0500625 png_init_io(png_ptr, fp);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500626
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600627#else no_streams /* I/O initialization method 2 */
Glenn Randers-Pehrsona5fa5c92008-09-06 07:06:22 -0500628 /* If you are using replacement write functions, instead of calling
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500629 * png_init_io() here you would call
630 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500631 png_set_write_fn(png_ptr, (void *)user_io_ptr, user_write_fn,
632 user_IO_flush_function);
633 /* where user_io_ptr is a structure you want available to the callbacks */
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500634#endif no_streams /* Only use one initialization method */
Guy Schalnat0d580581995-07-20 02:43:20 -0500635
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600636#ifdef hilevel
637 /* This is the easy way. Use it if you already have all the
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500638 * image info living in the structure. You could "|" many
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600639 * PNG_TRANSFORM flags into the png_transforms integer here.
640 */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500641 png_write_png(png_ptr, info_ptr, png_transforms, NULL);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500642
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600643#else
644 /* This is the hard way */
645
Andreas Dilger47a0c421997-05-16 02:46:07 -0500646 /* Set the image information here. Width and height are up to 2^31,
647 * bit_depth is one of 1, 2, 4, 8, or 16, but valid values also depend on
648 * the color_type selected. color_type is one of PNG_COLOR_TYPE_GRAY,
649 * PNG_COLOR_TYPE_GRAY_ALPHA, PNG_COLOR_TYPE_PALETTE, PNG_COLOR_TYPE_RGB,
650 * or PNG_COLOR_TYPE_RGB_ALPHA. interlace is either PNG_INTERLACE_NONE or
651 * PNG_INTERLACE_ADAM7, and the compression_type and filter_type MUST
652 * currently be PNG_COMPRESSION_TYPE_BASE and PNG_FILTER_TYPE_BASE. REQUIRED
653 */
654 png_set_IHDR(png_ptr, info_ptr, width, height, bit_depth, PNG_COLOR_TYPE_???,
655 PNG_INTERLACE_????, PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
Guy Schalnat0d580581995-07-20 02:43:20 -0500656
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500657 /* Set the palette if there is one. REQUIRED for indexed-color images */
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500658 palette = (png_colorp)png_malloc(png_ptr, PNG_MAX_PALETTE_LENGTH
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500659 * png_sizeof(png_color));
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500660 /* ... Set palette colors ... */
Glenn Randers-Pehrson76e5fd62000-12-28 07:50:05 -0600661 png_set_PLTE(png_ptr, info_ptr, palette, PNG_MAX_PALETTE_LENGTH);
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600662 /* You must not free palette here, because png_set_PLTE only makes a link to
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500663 * the palette that you malloced. Wait until you are about to destroy
664 * the png structure.
665 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500666
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500667 /* Optional significant bit (sBIT) chunk */
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500668 png_color_8 sig_bit;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500669
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500670 /* If we are dealing with a grayscale image then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500671 sig_bit.gray = true_bit_depth;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500672
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500673 /* Otherwise, if we are dealing with a color image then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500674 sig_bit.red = true_red_bit_depth;
675 sig_bit.green = true_green_bit_depth;
676 sig_bit.blue = true_blue_bit_depth;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500677
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500678 /* If the image has an alpha channel then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500679 sig_bit.alpha = true_alpha_bit_depth;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500680
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500681 png_set_sBIT(png_ptr, info_ptr, &sig_bit);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500682
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600683
Andreas Dilger47a0c421997-05-16 02:46:07 -0500684 /* Optional gamma chunk is strongly suggested if you have any guess
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600685 * as to the correct gamma of the image.
686 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500687 png_set_gAMA(png_ptr, info_ptr, gamma);
Guy Schalnat0d580581995-07-20 02:43:20 -0500688
Andreas Dilger47a0c421997-05-16 02:46:07 -0500689 /* Optionally write comments into the image */
690 text_ptr[0].key = "Title";
691 text_ptr[0].text = "Mona Lisa";
692 text_ptr[0].compression = PNG_TEXT_COMPRESSION_NONE;
Glenn Randers-Pehrsondd78d522010-03-30 08:34:02 -0500693 text_ptr[0].itxt_length = 0;
694 text_ptr[0].lang = NULL;
695 text_ptr[0].lang_key = NULL;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500696 text_ptr[1].key = "Author";
697 text_ptr[1].text = "Leonardo DaVinci";
698 text_ptr[1].compression = PNG_TEXT_COMPRESSION_NONE;
Glenn Randers-Pehrsondd78d522010-03-30 08:34:02 -0500699 text_ptr[1].itxt_length = 0;
700 text_ptr[1].lang = NULL;
701 text_ptr[1].lang_key = NULL;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500702 text_ptr[2].key = "Description";
703 text_ptr[2].text = "<long text>";
704 text_ptr[2].compression = PNG_TEXT_COMPRESSION_zTXt;
Glenn Randers-Pehrsondd78d522010-03-30 08:34:02 -0500705 text_ptr[2].itxt_length = 0;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600706 text_ptr[2].lang = NULL;
Glenn Randers-Pehrsondd78d522010-03-30 08:34:02 -0500707 text_ptr[2].lang_key = NULL;
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500708 png_set_text(png_ptr, info_ptr, text_ptr, 3);
Guy Schalnat0d580581995-07-20 02:43:20 -0500709
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500710 /* Other optional chunks like cHRM, bKGD, tRNS, tIME, oFFs, pHYs */
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500711
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500712 /* Note that if sRGB is present the gAMA and cHRM chunks must be ignored
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500713 * on read and, if your application chooses to write them, they must
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500714 * be written in accordance with the sRGB profile
715 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500716
717 /* Write the file header information. REQUIRED */
Guy Schalnat0d580581995-07-20 02:43:20 -0500718 png_write_info(png_ptr, info_ptr);
719
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600720 /* If you want, you can write the info in two steps, in case you need to
721 * write your private chunk ahead of PLTE:
722 *
723 * png_write_info_before_PLTE(write_ptr, write_info_ptr);
724 * write_my_chunk();
725 * png_write_info(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600726 *
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500727 * However, given the level of known- and unknown-chunk support in 1.2.0
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600728 * and up, this should no longer be necessary.
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600729 */
730
Andreas Dilger47a0c421997-05-16 02:46:07 -0500731 /* Once we write out the header, the compression type on the text
732 * chunks gets changed to PNG_TEXT_COMPRESSION_NONE_WR or
733 * PNG_TEXT_COMPRESSION_zTXt_WR, so it doesn't get written out again
734 * at the end.
735 */
736
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500737 /* Set up the transformations you want. Note that these are
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600738 * all optional. Only call them if you want them.
739 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500740
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500741 /* Invert monochrome pixels */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600742 png_set_invert_mono(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500743
Andreas Dilger47a0c421997-05-16 02:46:07 -0500744 /* Shift the pixels up to a legal bit depth and fill in
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600745 * as appropriate to correctly scale the image.
746 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500747 png_set_shift(png_ptr, &sig_bit);
Guy Schalnat0d580581995-07-20 02:43:20 -0500748
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500749 /* Pack pixels into bytes */
Guy Schalnat0d580581995-07-20 02:43:20 -0500750 png_set_packing(png_ptr);
751
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500752 /* Swap location of alpha bytes from ARGB to RGBA */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500753 png_set_swap_alpha(png_ptr);
754
755 /* Get rid of filler (OR ALPHA) bytes, pack XRGB/RGBX/ARGB/RGBA into
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600756 * RGB (4 channels -> 3 channels). The second parameter is not used.
757 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500758 png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
759
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500760 /* Flip BGR pixels to RGB */
Guy Schalnat0d580581995-07-20 02:43:20 -0500761 png_set_bgr(png_ptr);
762
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500763 /* Swap bytes of 16-bit files to most significant byte first */
Guy Schalnat0d580581995-07-20 02:43:20 -0500764 png_set_swap(png_ptr);
765
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500766 /* Swap bits of 1, 2, 4 bit packed pixel formats */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500767 png_set_packswap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500768
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500769 /* Turn on interlace handling if you are not using png_write_image() */
Guy Schalnat0d580581995-07-20 02:43:20 -0500770 if (interlacing)
771 number_passes = png_set_interlace_handling(png_ptr);
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500772
Guy Schalnat0d580581995-07-20 02:43:20 -0500773 else
774 number_passes = 1;
775
Andreas Dilger47a0c421997-05-16 02:46:07 -0500776 /* The easiest way to write the image (you may have a different memory
777 * layout, however, so choose what fits your needs best). You need to
778 * use the first method if you aren't handling interlacing yourself.
779 */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500780 png_uint_32 k, height, width;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600781 png_byte image[height][width*bytes_per_pixel];
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500782 png_bytep row_pointers[height];
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500783
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500784 if (height > PNG_UINT_32_MAX/png_sizeof(png_bytep))
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -0500785 png_error (png_ptr, "Image is too tall to process in memory");
786
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500787 for (k = 0; k < height; k++)
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600788 row_pointers[k] = image + k*width*bytes_per_pixel;
Guy Schalnate5a37791996-06-05 15:50:50 -0500789
Andreas Dilger47a0c421997-05-16 02:46:07 -0500790 /* One of the following output methods is REQUIRED */
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500791
792#ifdef entire /* Write out the entire image data in one call */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500793 png_write_image(png_ptr, row_pointers);
794
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500795 /* The other way to write the image - deal with interlacing */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500796
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500797#else no_entire /* Write out the image data by one or more scanlines */
798
Andreas Dilger47a0c421997-05-16 02:46:07 -0500799 /* The number of passes is either 1 for non-interlaced images,
800 * or 7 for interlaced images.
801 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500802 for (pass = 0; pass < number_passes; pass++)
803 {
804 /* Write a few rows at a time. */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500805 png_write_rows(png_ptr, &row_pointers[first_row], number_of_rows);
Guy Schalnat0d580581995-07-20 02:43:20 -0500806
807 /* If you are only writing one row at a time, this works */
808 for (y = 0; y < height; y++)
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500809 png_write_rows(png_ptr, &row_pointers[y], 1);
Guy Schalnat0d580581995-07-20 02:43:20 -0500810 }
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500811#endif no_entire /* Use only one output method */
Guy Schalnat0d580581995-07-20 02:43:20 -0500812
Andreas Dilger47a0c421997-05-16 02:46:07 -0500813 /* You can write optional chunks like tEXt, zTXt, and tIME at the end
Glenn Randers-Pehrsonf0a8fe02009-04-14 08:28:15 -0500814 * as well. Shouldn't be necessary in 1.2.0 and up as all the public
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600815 * chunks are supported and you can use png_set_unknown_chunks() to
816 * register unknown chunks into the info structure to be written out.
Guy Schalnate5a37791996-06-05 15:50:50 -0500817 */
818
Andreas Dilger47a0c421997-05-16 02:46:07 -0500819 /* It is REQUIRED to call this to finish writing the rest of the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500820 png_write_end(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600821#endif hilevel
Guy Schalnat0d580581995-07-20 02:43:20 -0500822
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600823 /* If you png_malloced a palette, free it here (don't free info_ptr->palette,
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500824 * as recommended in versions 1.0.5m and earlier of this example; if
825 * libpng mallocs info_ptr->palette, libpng will free it). If you
826 * allocated it with malloc() instead of png_malloc(), use free() instead
827 * of png_free().
828 */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600829 png_free(png_ptr, palette);
Glenn Randers-Pehrson895a9c92008-07-25 08:51:18 -0500830 palette = NULL;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600831
832 /* Similarly, if you png_malloced any data that you passed in with
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500833 * png_set_something(), such as a hist or trans array, free it here,
834 * when you can be sure that libpng is through with it.
835 */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600836 png_free(png_ptr, trans);
Glenn Randers-Pehrson895a9c92008-07-25 08:51:18 -0500837 trans = NULL;
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500838 /* Whenever you use png_free() it is a good idea to set the pointer to
839 * NULL in case your application inadvertently tries to png_free() it
840 * again. When png_free() sees a NULL it returns without action, thus
841 * avoiding the double-free security problem.
842 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500843
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500844 /* Clean up after the write, and free any memory allocated */
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -0500845 png_destroy_write_struct(&png_ptr, &info_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500846
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500847 /* Close the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500848 fclose(fp);
849
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500850 /* That's it */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500851 return (OK);
Guy Schalnat0d580581995-07-20 02:43:20 -0500852}
853
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -0500854#endif /* if 0 */