blob: 46bce0a0f1c221d7cfeffc6cb0754633a4e218a3 [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
Glenn Randers-Pehrsonf0eda4e2010-10-15 15:01:57 -05005 * Last changed in libpng 1.5.0 [(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-Pehrsoncbe52d81998-02-28 07:00:24 -060025#include "png.h"
Guy Schalnat0d580581995-07-20 02:43:20 -050026
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060027 /* The png_jmpbuf() macro, used in error handling, became available in
28 * libpng version 1.0.6. If you want to be able to run your code with older
29 * versions of libpng, you must define the macro yourself (but only if it
30 * is not already defined by libpng!).
31 */
32
33#ifndef png_jmpbuf
Glenn Randers-Pehrson95ca51b2010-02-19 14:09:09 -060034# define png_jmpbuf(png_ptr) ((png_ptr)->png_jmpbuf)
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060035#endif
36
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -060037/* Check to see if a file is a PNG file using png_sig_cmp(). png_sig_cmp()
38 * returns zero if the image is a PNG and nonzero if it isn't a PNG.
39 *
40 * The function check_if_png() shown here, but not used, returns nonzero (true)
41 * if the file can be opened and is a PNG, 0 (false) otherwise.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060042 *
43 * If this call is successful, and you are going to keep the file open,
44 * you should call png_set_sig_bytes(png_ptr, PNG_BYTES_TO_CHECK); once
45 * you have created the png_ptr, so that libpng knows your application
46 * has read that many bytes from the start of the file. Make sure you
47 * don't call png_set_sig_bytes() with more than 8 bytes read or give it
48 * an incorrect number of bytes read, or you will either have read too
49 * many bytes (your fault), or you are telling libpng to read the wrong
50 * number of magic bytes (also your fault).
51 *
52 * Many applications already read the first 2 or 4 bytes from the start
53 * of the image to determine the file type, so it would be easiest just
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -060054 * to pass the bytes to png_sig_cmp() or even skip that if you know
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060055 * you have a PNG file, and call png_set_sig_bytes().
56 */
Andreas Dilger47a0c421997-05-16 02:46:07 -050057#define PNG_BYTES_TO_CHECK 4
58int check_if_png(char *file_name, FILE **fp)
Guy Schalnat0d580581995-07-20 02:43:20 -050059{
Andreas Dilger47a0c421997-05-16 02:46:07 -050060 char buf[PNG_BYTES_TO_CHECK];
Guy Schalnat0d580581995-07-20 02:43:20 -050061
Andreas Dilger47a0c421997-05-16 02:46:07 -050062 /* Open the prospective PNG file. */
Glenn Randers-Pehrson68ea2432000-04-01 21:10:05 -060063 if ((*fp = fopen(file_name, "rb")) == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -050064 return 0;
65
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -060066 /* Read in some of the signature bytes */
Andreas Dilger47a0c421997-05-16 02:46:07 -050067 if (fread(buf, 1, PNG_BYTES_TO_CHECK, *fp) != PNG_BYTES_TO_CHECK)
68 return 0;
Guy Schalnat0d580581995-07-20 02:43:20 -050069
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -060070 /* Compare the first PNG_BYTES_TO_CHECK bytes of the signature.
71 Return nonzero (true) if they match */
72
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -050073 return(!png_sig_cmp(buf, (png_size_t)0, PNG_BYTES_TO_CHECK));
Guy Schalnat0d580581995-07-20 02:43:20 -050074}
75
Andreas Dilger47a0c421997-05-16 02:46:07 -050076/* Read a PNG file. You may want to return an error code if the read
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060077 * fails (depending upon the failure). There are two "prototypes" given
78 * here - one where we are given the filename, and we need to open the
79 * file, and the other where we are given an open file (possibly with
80 * some or all of the magic bytes read - see comments above).
81 */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -060082#ifdef open_file /* prototype 1 */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060083void read_png(char *file_name) /* We need to open the file */
Guy Schalnat0d580581995-07-20 02:43:20 -050084{
Guy Schalnatb2e01bd1996-01-26 01:38:47 -060085 png_structp png_ptr;
Guy Schalnat6d764711995-12-19 03:22:19 -060086 png_infop info_ptr;
Andreas Dilger47a0c421997-05-16 02:46:07 -050087 unsigned int sig_read = 0;
88 png_uint_32 width, height;
89 int bit_depth, color_type, interlace_type;
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060090 FILE *fp;
Guy Schalnat0d580581995-07-20 02:43:20 -050091
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060092 if ((fp = fopen(file_name, "rb")) == NULL)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -050093 return (ERROR);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -050094
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -060095#else no_open_file /* prototype 2 */
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -050096void read_png(FILE *fp, unsigned int sig_read) /* File is already open */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060097{
98 png_structp png_ptr;
99 png_infop info_ptr;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500100 png_uint_32 width, height;
101 int bit_depth, color_type, interlace_type;
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500102#endif no_open_file /* Only use one prototype! */
Guy Schalnat0d580581995-07-20 02:43:20 -0500103
Guy Schalnate5a37791996-06-05 15:50:50 -0500104 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500105 * functions. If you want to use the default stderr and longjump method,
106 * you can supply NULL for the last three parameters. We also supply the
107 * the compiler header file version, so that we know if the application
108 * was compiled with a compatible version of the library. REQUIRED
109 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500110 png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500111 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500112
Andreas Dilger47a0c421997-05-16 02:46:07 -0500113 if (png_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500114 {
115 fclose(fp);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500116 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500117 }
118
Andreas Dilger47a0c421997-05-16 02:46:07 -0500119 /* Allocate/initialize the memory for image information. REQUIRED. */
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -0600120 info_ptr = png_create_info_struct(png_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500121 if (info_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500122 {
123 fclose(fp);
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500124 png_destroy_read_struct(&png_ptr, NULL, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500125 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500126 }
127
Andreas Dilger47a0c421997-05-16 02:46:07 -0500128 /* Set error handling if you are using the setjmp/longjmp method (this is
129 * the normal method of doing things with libpng). REQUIRED unless you
130 * set up your own error handlers in the png_create_read_struct() earlier.
131 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600132
133 if (setjmp(png_jmpbuf(png_ptr)))
Guy Schalnat0d580581995-07-20 02:43:20 -0500134 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500135 /* Free all of the memory associated with the png_ptr and info_ptr */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500136 png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
Guy Schalnat0d580581995-07-20 02:43:20 -0500137 fclose(fp);
Guy Schalnat0d580581995-07-20 02:43:20 -0500138 /* If we get here, we had a problem reading the file */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500139 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500140 }
141
Andreas Dilger47a0c421997-05-16 02:46:07 -0500142 /* One of the following I/O initialization methods is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600143#ifdef streams /* PNG file I/O method 1 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500144 /* Set up the input control if you are using standard C streams */
Guy Schalnat0d580581995-07-20 02:43:20 -0500145 png_init_io(png_ptr, fp);
146
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600147#else no_streams /* PNG file I/O method 2 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500148 /* If you are using replacement read functions, instead of calling
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600149 * png_init_io() here you would call:
150 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500151 png_set_read_fn(png_ptr, (void *)user_io_ptr, user_read_fn);
152 /* where user_io_ptr is a structure you want available to the callbacks */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600153#endif no_streams /* Use only one I/O method! */
Guy Schalnat69b14481996-01-10 02:56:49 -0600154
Andreas Dilger47a0c421997-05-16 02:46:07 -0500155 /* If we have already read some of the signature */
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -0600156 png_set_sig_bytes(png_ptr, sig_read);
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600157
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600158#ifdef hilevel
159 /*
160 * If you have enough memory to read in the entire image at once,
161 * and you need to specify only transforms that can be controlled
162 * with one of the PNG_TRANSFORM_* bits (this presently excludes
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500163 * quantizing, filling, setting background, and doing gamma
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600164 * adjustment), then you can read the entire image (including
165 * pixels) into the info structure with this call:
166 */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500167 png_read_png(png_ptr, info_ptr, png_transforms, NULL);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500168
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600169#else
170 /* OK, you're doing it the hard way, with the lower-level functions */
171
Andreas Dilger47a0c421997-05-16 02:46:07 -0500172 /* The call to png_read_info() gives us all of the information from the
173 * PNG file before the first IDAT (image data chunk). REQUIRED
174 */
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600175 png_read_info(png_ptr, info_ptr);
Guy Schalnat69b14481996-01-10 02:56:49 -0600176
Andreas Dilger47a0c421997-05-16 02:46:07 -0500177 png_get_IHDR(png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500178 &interlace_type, NULL, NULL);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500179
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500180 /* Set up the data transformations you want. Note that these are all
181 * optional. Only call them if you want/need them. Many of the
182 * transformations only work on specific types of images, and many
183 * are mutually exclusive.
184 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500185
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500186 /* Tell libpng to strip 16 bit/color files down to 8 bits/color */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500187 png_set_strip_16(png_ptr);
188
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500189 /* Strip alpha bytes from the input data without combining with the
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600190 * background (not recommended).
191 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500192 png_set_strip_alpha(png_ptr);
193
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600194 /* Extract multiple pixels with bit depths of 1, 2, and 4 from a single
Andreas Dilger47a0c421997-05-16 02:46:07 -0500195 * byte into separate bytes (useful for paletted and grayscale images).
196 */
197 png_set_packing(png_ptr);
198
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600199 /* Change the order of packed pixels to least significant bit first
Andreas Dilger47a0c421997-05-16 02:46:07 -0500200 * (not useful if you are using png_set_packing). */
201 png_set_packswap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500202
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600203 /* Expand paletted colors into true RGB triplets */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500204 if (color_type == PNG_COLOR_TYPE_PALETTE)
Glenn Randers-Pehrsonf46918d2006-06-02 05:31:20 -0500205 png_set_palette_to_rgb(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500206
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600207 /* Expand grayscale images to the full 8 bits from 1, 2, or 4 bits/pixel */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500208 if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8)
Glenn Randers-Pehrson56f63962008-10-06 10:16:17 -0500209 png_set_expand_gray_1_2_4_to_8(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500210
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600211 /* Expand paletted or RGB images with transparency to full alpha channels
212 * so the data will be available as RGBA quartets.
213 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500214 if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS))
Glenn Randers-Pehrsonb1828932001-06-23 08:03:17 -0500215 png_set_tRNS_to_alpha(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500216
Andreas Dilger47a0c421997-05-16 02:46:07 -0500217 /* Set the background color to draw transparent and alpha images over.
218 * It is possible to set the red, green, and blue components directly
219 * for paletted images instead of supplying a palette index. Note that
220 * even if the PNG file supplies a background, you are not required to
221 * use it - you should use the (solid) application background if it has one.
222 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500223
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600224 png_color_16 my_background, *image_background;
Guy Schalnat0d580581995-07-20 02:43:20 -0500225
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600226 if (png_get_bKGD(png_ptr, info_ptr, &image_background))
227 png_set_background(png_ptr, image_background,
Guy Schalnate5a37791996-06-05 15:50:50 -0500228 PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600229 else
230 png_set_background(png_ptr, &my_background,
Guy Schalnate5a37791996-06-05 15:50:50 -0500231 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
Guy Schalnat0d580581995-07-20 02:43:20 -0500232
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500233 /* Some suggestions as to how to get a screen gamma value
234 *
235 * Note that screen gamma is the display_exponent, which includes
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500236 * the CRT_exponent and any correction for viewing conditions
237 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500238 if (/* We have a user-defined screen gamma value */)
239 {
240 screen_gamma = user-defined screen_gamma;
241 }
242 /* This is one way that applications share the same screen gamma value */
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600243 else if ((gamma_str = getenv("SCREEN_GAMMA")) != NULL)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500244 {
245 screen_gamma = atof(gamma_str);
246 }
247 /* If we don't have another value */
248 else
249 {
Glenn Randers-Pehrsonf0a8fe02009-04-14 08:28:15 -0500250 screen_gamma = 2.2; /* A good guess for a PC monitor in a dimly
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600251 lit room */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500252 screen_gamma = 1.7 or 1.0; /* A good guess for Mac systems */
253 }
254
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600255 /* Tell libpng to handle the gamma conversion for you. The final call
Andreas Dilger47a0c421997-05-16 02:46:07 -0500256 * is a good guess for PC generated images, but it should be configurable
257 * by the user at run time by the user. It is strongly suggested that
258 * your application support gamma correction.
259 */
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600260
261 int intent;
262
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600263 if (png_get_sRGB(png_ptr, info_ptr, &intent))
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600264 png_set_gamma(png_ptr, screen_gamma, 0.45455);
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600265 else
266 {
267 double image_gamma;
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600268 if (png_get_gAMA(png_ptr, info_ptr, &image_gamma))
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600269 png_set_gamma(png_ptr, screen_gamma, image_gamma);
270 else
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600271 png_set_gamma(png_ptr, screen_gamma, 0.45455);
272 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500273
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500274#ifdef PNG_READ_QUANTIZE_SUPPORTED
275 /* Quantize RGB files down to 8 bit palette or reduce palettes
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600276 * to the number of colors available on your screen.
277 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500278 if (color_type & PNG_COLOR_MASK_COLOR)
Guy Schalnat0d580581995-07-20 02:43:20 -0500279 {
Glenn Randers-Pehrsonf05f8032000-12-23 14:27:39 -0600280 int num_palette;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500281 png_colorp palette;
282
283 /* This reduces the image to the application supplied palette */
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500284 if (/* We have our own palette */)
Guy Schalnat0d580581995-07-20 02:43:20 -0500285 {
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500286 /* An array of colors to which the image should be quantized */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500287 png_color std_color_cube[MAX_SCREEN_COLORS];
Guy Schalnat0d580581995-07-20 02:43:20 -0500288
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500289 png_set_quantize(png_ptr, std_color_cube, MAX_SCREEN_COLORS,
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500290 MAX_SCREEN_COLORS, NULL, 0);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500291 }
292 /* This reduces the image to the palette supplied in the file */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600293 else if (png_get_PLTE(png_ptr, info_ptr, &palette, &num_palette))
Andreas Dilger47a0c421997-05-16 02:46:07 -0500294 {
Glenn Randers-Pehrson865f4f02002-09-15 20:30:38 -0500295 png_uint_16p histogram = NULL;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500296
297 png_get_hIST(png_ptr, info_ptr, &histogram);
298
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500299 png_set_quantize(png_ptr, palette, num_palette,
Andreas Dilger47a0c421997-05-16 02:46:07 -0500300 max_screen_colors, histogram, 0);
Guy Schalnat0d580581995-07-20 02:43:20 -0500301 }
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600302 }
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500303#endif /* PNG_READ_QUANTIZE_SUPPORTED */
Guy Schalnat0d580581995-07-20 02:43:20 -0500304
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500305 /* Invert monochrome files to have 0 as white and 1 as black */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600306 png_set_invert_mono(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500307
Andreas Dilger47a0c421997-05-16 02:46:07 -0500308 /* If you want to shift the pixel values from the range [0,255] or
309 * [0,65535] to the original [0,7] or [0,31], or whatever range the
310 * colors were originally in:
311 */
312 if (png_get_valid(png_ptr, info_ptr, PNG_INFO_sBIT))
313 {
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500314 png_color_8p sig_bit_p;
Guy Schalnat0d580581995-07-20 02:43:20 -0500315
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500316 png_get_sBIT(png_ptr, info_ptr, &sig_bit_p);
317 png_set_shift(png_ptr, sig_bit_p);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500318 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500319
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500320 /* Flip the RGB pixels to BGR (or RGBA to BGRA) */
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -0500321 if (color_type & PNG_COLOR_MASK_COLOR)
322 png_set_bgr(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500323
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500324 /* Swap the RGBA or GA data to ARGB or AG (or BGRA to ABGR) */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500325 png_set_swap_alpha(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500326
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500327 /* Swap bytes of 16 bit files to least significant byte first */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500328 png_set_swap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500329
Andreas Dilger47a0c421997-05-16 02:46:07 -0500330 /* Add filler (or alpha) byte (before/after each RGB triplet) */
331 png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER);
332
333 /* Turn on interlace handling. REQUIRED if you are not using
334 * png_read_image(). To see how to handle interlacing passes,
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600335 * see the png_read_row() method below:
Andreas Dilger47a0c421997-05-16 02:46:07 -0500336 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500337 number_passes = png_set_interlace_handling(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500338
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600339 /* Optional call to gamma correct and add the background to the palette
Andreas Dilger47a0c421997-05-16 02:46:07 -0500340 * and update info structure. REQUIRED if you are expecting libpng to
341 * update the palette for you (ie you selected such a transform above).
342 */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500343 png_read_update_info(png_ptr, info_ptr);
344
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600345 /* Allocate the memory to hold the image using the fields of info_ptr. */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500346
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600347 /* The easiest way to read the image: */
Guy Schalnat6d764711995-12-19 03:22:19 -0600348 png_bytep row_pointers[height];
Guy Schalnate5a37791996-06-05 15:50:50 -0500349
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500350 /* Clear the pointer array */
Guy Schalnate5a37791996-06-05 15:50:50 -0500351 for (row = 0; row < height; row++)
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500352 row_pointers[row] = NULL;
353
354 for (row = 0; row < height; row++)
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500355 row_pointers[row] = png_malloc(png_ptr, png_get_rowbytes(png_ptr,
356 info_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -0500357
Andreas Dilger47a0c421997-05-16 02:46:07 -0500358 /* Now it's time to read the image. One of these methods is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600359#ifdef entire /* Read the entire image in one go */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500360 png_read_image(png_ptr, row_pointers);
361
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600362#else no_entire /* Read the image one or more scanlines at a time */
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600363 /* The other way to read images - deal with interlacing: */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500364
Guy Schalnat0d580581995-07-20 02:43:20 -0500365 for (pass = 0; pass < number_passes; pass++)
366 {
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600367#ifdef single /* Read the image a single row at a time */
Guy Schalnat0d580581995-07-20 02:43:20 -0500368 for (y = 0; y < height; y++)
369 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500370 png_read_rows(png_ptr, &row_pointers[y], NULL, 1);
Guy Schalnat0d580581995-07-20 02:43:20 -0500371 }
372
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600373#else no_single /* Read the image several rows at a time */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500374 for (y = 0; y < height; y += number_of_rows)
375 {
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600376#ifdef sparkle /* Read the image using the "sparkle" effect. */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500377 png_read_rows(png_ptr, &row_pointers[y], NULL,
378 number_of_rows);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600379#else no_sparkle /* Read the image using the "rectangle" effect */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500380 png_read_rows(png_ptr, NULL, &row_pointers[y],
381 number_of_rows);
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500382#endif no_sparkle /* Use only one of these two methods */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500383 }
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600384
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500385 /* If you want to display the image after every pass, do so here */
386#endif no_single /* Use only one of these two methods */
Guy Schalnat0d580581995-07-20 02:43:20 -0500387 }
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500388#endif no_entire /* Use only one of these two methods */
Guy Schalnat0d580581995-07-20 02:43:20 -0500389
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500390 /* Read rest of file, and get additional chunks in info_ptr - REQUIRED */
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600391 png_read_end(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600392#endif hilevel
393
394 /* At this point you have read the entire image */
Guy Schalnat0d580581995-07-20 02:43:20 -0500395
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500396 /* Clean up after the read, and free any memory allocated - REQUIRED */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500397 png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
Guy Schalnat0d580581995-07-20 02:43:20 -0500398
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500399 /* Close the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500400 fclose(fp);
401
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500402 /* That's it */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500403 return (OK);
Guy Schalnat0d580581995-07-20 02:43:20 -0500404}
405
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500406/* Progressively read a file */
Guy Schalnat6d764711995-12-19 03:22:19 -0600407
Guy Schalnat6d764711995-12-19 03:22:19 -0600408int
Guy Schalnate5a37791996-06-05 15:50:50 -0500409initialize_png_reader(png_structp *png_ptr, png_infop *info_ptr)
Guy Schalnat6d764711995-12-19 03:22:19 -0600410{
Guy Schalnate5a37791996-06-05 15:50:50 -0500411 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500412 * functions. If you want to use the default stderr and longjump method,
413 * you can supply NULL for the last three parameters. We also check that
414 * the library version is compatible in case we are using dynamically
415 * linked libraries.
Guy Schalnate5a37791996-06-05 15:50:50 -0500416 */
417 *png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500418 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500419
Andreas Dilger47a0c421997-05-16 02:46:07 -0500420 if (*png_ptr == NULL)
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600421 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500422 *info_ptr = NULL;
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500423 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600424 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600425
Guy Schalnate5a37791996-06-05 15:50:50 -0500426 *info_ptr = png_create_info_struct(png_ptr);
427
Andreas Dilger47a0c421997-05-16 02:46:07 -0500428 if (*info_ptr == NULL)
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600429 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500430 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500431 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600432 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600433
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600434 if (setjmp(png_jmpbuf((*png_ptr))))
Guy Schalnate5a37791996-06-05 15:50:50 -0500435 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500436 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500437 return (ERROR);
Guy Schalnate5a37791996-06-05 15:50:50 -0500438 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600439
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600440 /* This one's new. You will need to provide all three
Andreas Dilger47a0c421997-05-16 02:46:07 -0500441 * function callbacks, even if you aren't using them all.
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600442 * If you aren't using all functions, you can specify NULL
443 * parameters. Even when all three functions are NULL,
444 * you need to call png_set_progressive_read_fn().
Andreas Dilger47a0c421997-05-16 02:46:07 -0500445 * These functions shouldn't be dependent on global or
446 * static variables if you are decoding several images
447 * simultaneously. You should store stream specific data
448 * in a separate struct, given as the second parameter,
449 * and retrieve the pointer from inside the callbacks using
450 * the function png_get_progressive_ptr(png_ptr).
451 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500452 png_set_progressive_read_fn(*png_ptr, (void *)stream_data,
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600453 info_callback, row_callback, end_callback);
Guy Schalnat6d764711995-12-19 03:22:19 -0600454
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500455 return (OK);
Guy Schalnat6d764711995-12-19 03:22:19 -0600456}
457
458int
Guy Schalnate5a37791996-06-05 15:50:50 -0500459process_data(png_structp *png_ptr, png_infop *info_ptr,
460 png_bytep buffer, png_uint_32 length)
Guy Schalnat6d764711995-12-19 03:22:19 -0600461{
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600462 if (setjmp(png_jmpbuf((*png_ptr))))
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600463 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500464 /* Free the png_ptr and info_ptr memory on error */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500465 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500466 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600467 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600468
Andreas Dilger47a0c421997-05-16 02:46:07 -0500469 /* This one's new also. Simply give it chunks of data as
470 * they arrive from the data stream (in order, of course).
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500471 * On segmented machines, don't give it any more than 64K.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500472 * The library seems to run fine with sizes of 4K, although
473 * you can give it much less if necessary (I assume you can
474 * give it chunks of 1 byte, but I haven't tried with less
475 * than 256 bytes yet). When this function returns, you may
476 * want to display any rows that were generated in the row
477 * callback, if you aren't already displaying them there.
478 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500479 png_process_data(*png_ptr, *info_ptr, buffer, length);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500480 return (OK);
Guy Schalnat6d764711995-12-19 03:22:19 -0600481}
482
483info_callback(png_structp png_ptr, png_infop info)
484{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500485 /* Do any setup here, including setting any of the transformations
486 * mentioned in the Reading PNG files section. For now, you _must_
487 * call either png_start_read_image() or png_read_update_info()
488 * after all the transformations are set (even if you don't set
489 * any). You may start getting rows before png_process_data()
490 * returns, so this is your last chance to prepare for that.
491 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600492}
493
494row_callback(png_structp png_ptr, png_bytep new_row,
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600495 png_uint_32 row_num, int pass)
Guy Schalnat6d764711995-12-19 03:22:19 -0600496{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500497 /*
498 * This function is called for every row in the image. If the
499 * image is interlaced, and you turned on the interlace handler,
500 * this function will be called for every row in every pass.
501 *
502 * In this function you will receive a pointer to new row data from
503 * libpng called new_row that is to replace a corresponding row (of
504 * the same data format) in a buffer allocated by your application.
505 *
506 * The new row data pointer "new_row" may be NULL, indicating there is
507 * no new data to be replaced (in cases of interlace loading).
508 *
509 * If new_row is not NULL then you need to call
510 * png_progressive_combine_row() to replace the corresponding row as
511 * shown below:
512 */
513
Glenn Randers-Pehrson53c07f52010-06-18 18:55:55 -0500514 /* Get pointer to corresponding row in our
515 * PNG read buffer.
516 */
517 png_bytep old_row = ((png_bytep *)our_data)[row_num];
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -0500518
Glenn Randers-Pehrson53c07f52010-06-18 18:55:55 -0500519 /* If both rows are allocated then copy the new row
520 * data to the corresponding row data.
521 */
522 if ((old_row != NULL) && (new_row != NULL))
523 png_progressive_combine_row(png_ptr, old_row, new_row);
524
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500525 /*
526 * The rows and passes are called in order, so you don't really
527 * need the row_num and pass, but I'm supplying them because it
528 * may make your life easier.
529 *
530 * For the non-NULL rows of interlaced images, you must call
531 * png_progressive_combine_row() passing in the new row and the
532 * old row, as demonstrated above. You can call this function for
533 * NULL rows (it will just return) and for non-interlaced images
534 * (it just does the png_memcpy for you) if it will make the code
535 * easier. Thus, you can just do this for all cases:
536 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600537
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600538 png_progressive_combine_row(png_ptr, old_row, new_row);
Guy Schalnat6d764711995-12-19 03:22:19 -0600539
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500540 /* where old_row is what was displayed for previous rows. Note
541 * that the first pass (pass == 0 really) will completely cover
542 * the old row, so the rows do not have to be initialized. After
543 * the first pass (and only for interlaced images), you will have
544 * to pass the current row as new_row, and the function will combine
545 * the old row and the new row.
546 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600547}
548
549end_callback(png_structp png_ptr, png_infop info)
550{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500551 /* This function is called when the whole image has been read,
552 * including any chunks after the image (up to and including
553 * the IEND). You will usually have the same info chunk as you
554 * had in the header, although some data may have been added
555 * to the comments and time fields.
556 *
557 * Most people won't do much here, perhaps setting a flag that
558 * marks the image as finished.
559 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600560}
561
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500562/* Write a png file */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600563void write_png(char *file_name /* , ... other image information ... */)
Guy Schalnat0d580581995-07-20 02:43:20 -0500564{
565 FILE *fp;
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600566 png_structp png_ptr;
567 png_infop info_ptr;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600568 png_colorp palette;
Guy Schalnat0d580581995-07-20 02:43:20 -0500569
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500570 /* Open the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500571 fp = fopen(file_name, "wb");
Andreas Dilger47a0c421997-05-16 02:46:07 -0500572 if (fp == NULL)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500573 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500574
Guy Schalnate5a37791996-06-05 15:50:50 -0500575 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500576 * functions. If you want to use the default stderr and longjump method,
577 * you can supply NULL for the last three parameters. We also check that
578 * the library version is compatible with the one used at compile time,
579 * in case we are using dynamically linked libraries. REQUIRED.
Guy Schalnate5a37791996-06-05 15:50:50 -0500580 */
581 png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500582 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500583
Andreas Dilger47a0c421997-05-16 02:46:07 -0500584 if (png_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500585 {
586 fclose(fp);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500587 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500588 }
589
Andreas Dilger47a0c421997-05-16 02:46:07 -0500590 /* Allocate/initialize the image information data. REQUIRED */
Guy Schalnate5a37791996-06-05 15:50:50 -0500591 info_ptr = png_create_info_struct(png_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500592 if (info_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500593 {
594 fclose(fp);
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500595 png_destroy_write_struct(&png_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500596 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500597 }
598
Andreas Dilger47a0c421997-05-16 02:46:07 -0500599 /* Set error handling. REQUIRED if you aren't supplying your own
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600600 * error handling functions in the png_create_write_struct() call.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500601 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600602 if (setjmp(png_jmpbuf(png_ptr)))
Guy Schalnat0d580581995-07-20 02:43:20 -0500603 {
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500604 /* If we get here, we had a problem writing the file */
Guy Schalnate5a37791996-06-05 15:50:50 -0500605 fclose(fp);
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -0500606 png_destroy_write_struct(&png_ptr, &info_ptr);
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 /* One of the following I/O initialization functions is REQUIRED */
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500611
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600612#ifdef streams /* I/O initialization method 1 */
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500613 /* Set up the output control if you are using standard C streams */
Guy Schalnat0d580581995-07-20 02:43:20 -0500614 png_init_io(png_ptr, fp);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500615
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600616#else no_streams /* I/O initialization method 2 */
Glenn Randers-Pehrsona5fa5c92008-09-06 07:06:22 -0500617 /* If you are using replacement write functions, instead of calling
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500618 * png_init_io() here you would call
619 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500620 png_set_write_fn(png_ptr, (void *)user_io_ptr, user_write_fn,
621 user_IO_flush_function);
622 /* where user_io_ptr is a structure you want available to the callbacks */
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500623#endif no_streams /* Only use one initialization method */
Guy Schalnat0d580581995-07-20 02:43:20 -0500624
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600625#ifdef hilevel
626 /* This is the easy way. Use it if you already have all the
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500627 * image info living in the structure. You could "|" many
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600628 * PNG_TRANSFORM flags into the png_transforms integer here.
629 */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500630 png_write_png(png_ptr, info_ptr, png_transforms, NULL);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500631
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600632#else
633 /* This is the hard way */
634
Andreas Dilger47a0c421997-05-16 02:46:07 -0500635 /* Set the image information here. Width and height are up to 2^31,
636 * bit_depth is one of 1, 2, 4, 8, or 16, but valid values also depend on
637 * the color_type selected. color_type is one of PNG_COLOR_TYPE_GRAY,
638 * PNG_COLOR_TYPE_GRAY_ALPHA, PNG_COLOR_TYPE_PALETTE, PNG_COLOR_TYPE_RGB,
639 * or PNG_COLOR_TYPE_RGB_ALPHA. interlace is either PNG_INTERLACE_NONE or
640 * PNG_INTERLACE_ADAM7, and the compression_type and filter_type MUST
641 * currently be PNG_COMPRESSION_TYPE_BASE and PNG_FILTER_TYPE_BASE. REQUIRED
642 */
643 png_set_IHDR(png_ptr, info_ptr, width, height, bit_depth, PNG_COLOR_TYPE_???,
644 PNG_INTERLACE_????, PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
Guy Schalnat0d580581995-07-20 02:43:20 -0500645
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500646 /* Set the palette if there is one. REQUIRED for indexed-color images */
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500647 palette = (png_colorp)png_malloc(png_ptr, PNG_MAX_PALETTE_LENGTH
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500648 * png_sizeof(png_color));
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500649 /* ... Set palette colors ... */
Glenn Randers-Pehrson76e5fd62000-12-28 07:50:05 -0600650 png_set_PLTE(png_ptr, info_ptr, palette, PNG_MAX_PALETTE_LENGTH);
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600651 /* You must not free palette here, because png_set_PLTE only makes a link to
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500652 * the palette that you malloced. Wait until you are about to destroy
653 * the png structure.
654 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500655
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500656 /* Optional significant bit (sBIT) chunk */
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500657 png_color_8 sig_bit;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500658
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500659 /* If we are dealing with a grayscale image then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500660 sig_bit.gray = true_bit_depth;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500661
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500662 /* Otherwise, if we are dealing with a color image then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500663 sig_bit.red = true_red_bit_depth;
664 sig_bit.green = true_green_bit_depth;
665 sig_bit.blue = true_blue_bit_depth;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500666
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500667 /* If the image has an alpha channel then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500668 sig_bit.alpha = true_alpha_bit_depth;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500669
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500670 png_set_sBIT(png_ptr, info_ptr, &sig_bit);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500671
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600672
Andreas Dilger47a0c421997-05-16 02:46:07 -0500673 /* Optional gamma chunk is strongly suggested if you have any guess
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600674 * as to the correct gamma of the image.
675 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500676 png_set_gAMA(png_ptr, info_ptr, gamma);
Guy Schalnat0d580581995-07-20 02:43:20 -0500677
Andreas Dilger47a0c421997-05-16 02:46:07 -0500678 /* Optionally write comments into the image */
679 text_ptr[0].key = "Title";
680 text_ptr[0].text = "Mona Lisa";
681 text_ptr[0].compression = PNG_TEXT_COMPRESSION_NONE;
Glenn Randers-Pehrsondd78d522010-03-30 08:34:02 -0500682 text_ptr[0].itxt_length = 0;
683 text_ptr[0].lang = NULL;
684 text_ptr[0].lang_key = NULL;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500685 text_ptr[1].key = "Author";
686 text_ptr[1].text = "Leonardo DaVinci";
687 text_ptr[1].compression = PNG_TEXT_COMPRESSION_NONE;
Glenn Randers-Pehrsondd78d522010-03-30 08:34:02 -0500688 text_ptr[1].itxt_length = 0;
689 text_ptr[1].lang = NULL;
690 text_ptr[1].lang_key = NULL;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500691 text_ptr[2].key = "Description";
692 text_ptr[2].text = "<long text>";
693 text_ptr[2].compression = PNG_TEXT_COMPRESSION_zTXt;
Glenn Randers-Pehrsondd78d522010-03-30 08:34:02 -0500694 text_ptr[2].itxt_length = 0;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600695 text_ptr[2].lang = NULL;
Glenn Randers-Pehrsondd78d522010-03-30 08:34:02 -0500696 text_ptr[2].lang_key = NULL;
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500697 png_set_text(png_ptr, info_ptr, text_ptr, 3);
Guy Schalnat0d580581995-07-20 02:43:20 -0500698
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500699 /* Other optional chunks like cHRM, bKGD, tRNS, tIME, oFFs, pHYs */
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500700
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500701 /* Note that if sRGB is present the gAMA and cHRM chunks must be ignored
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500702 * on read and, if your application chooses to write them, they must
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500703 * be written in accordance with the sRGB profile
704 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500705
706 /* Write the file header information. REQUIRED */
Guy Schalnat0d580581995-07-20 02:43:20 -0500707 png_write_info(png_ptr, info_ptr);
708
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600709 /* If you want, you can write the info in two steps, in case you need to
710 * write your private chunk ahead of PLTE:
711 *
712 * png_write_info_before_PLTE(write_ptr, write_info_ptr);
713 * write_my_chunk();
714 * png_write_info(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600715 *
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500716 * However, given the level of known- and unknown-chunk support in 1.2.0
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600717 * and up, this should no longer be necessary.
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600718 */
719
Andreas Dilger47a0c421997-05-16 02:46:07 -0500720 /* Once we write out the header, the compression type on the text
721 * chunks gets changed to PNG_TEXT_COMPRESSION_NONE_WR or
722 * PNG_TEXT_COMPRESSION_zTXt_WR, so it doesn't get written out again
723 * at the end.
724 */
725
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500726 /* Set up the transformations you want. Note that these are
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600727 * all optional. Only call them if you want them.
728 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500729
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500730 /* Invert monochrome pixels */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600731 png_set_invert_mono(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500732
Andreas Dilger47a0c421997-05-16 02:46:07 -0500733 /* Shift the pixels up to a legal bit depth and fill in
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600734 * as appropriate to correctly scale the image.
735 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500736 png_set_shift(png_ptr, &sig_bit);
Guy Schalnat0d580581995-07-20 02:43:20 -0500737
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500738 /* Pack pixels into bytes */
Guy Schalnat0d580581995-07-20 02:43:20 -0500739 png_set_packing(png_ptr);
740
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500741 /* Swap location of alpha bytes from ARGB to RGBA */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500742 png_set_swap_alpha(png_ptr);
743
744 /* Get rid of filler (OR ALPHA) bytes, pack XRGB/RGBX/ARGB/RGBA into
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600745 * RGB (4 channels -> 3 channels). The second parameter is not used.
746 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500747 png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
748
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500749 /* Flip BGR pixels to RGB */
Guy Schalnat0d580581995-07-20 02:43:20 -0500750 png_set_bgr(png_ptr);
751
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500752 /* Swap bytes of 16-bit files to most significant byte first */
Guy Schalnat0d580581995-07-20 02:43:20 -0500753 png_set_swap(png_ptr);
754
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500755 /* Swap bits of 1, 2, 4 bit packed pixel formats */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500756 png_set_packswap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500757
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500758 /* Turn on interlace handling if you are not using png_write_image() */
Guy Schalnat0d580581995-07-20 02:43:20 -0500759 if (interlacing)
760 number_passes = png_set_interlace_handling(png_ptr);
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500761
Guy Schalnat0d580581995-07-20 02:43:20 -0500762 else
763 number_passes = 1;
764
Andreas Dilger47a0c421997-05-16 02:46:07 -0500765 /* The easiest way to write the image (you may have a different memory
766 * layout, however, so choose what fits your needs best). You need to
767 * use the first method if you aren't handling interlacing yourself.
768 */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500769 png_uint_32 k, height, width;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600770 png_byte image[height][width*bytes_per_pixel];
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500771 png_bytep row_pointers[height];
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500772
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500773 if (height > PNG_UINT_32_MAX/png_sizeof(png_bytep))
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -0500774 png_error (png_ptr, "Image is too tall to process in memory");
775
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500776 for (k = 0; k < height; k++)
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600777 row_pointers[k] = image + k*width*bytes_per_pixel;
Guy Schalnate5a37791996-06-05 15:50:50 -0500778
Andreas Dilger47a0c421997-05-16 02:46:07 -0500779 /* One of the following output methods is REQUIRED */
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500780
781#ifdef entire /* Write out the entire image data in one call */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500782 png_write_image(png_ptr, row_pointers);
783
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500784 /* The other way to write the image - deal with interlacing */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500785
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500786#else no_entire /* Write out the image data by one or more scanlines */
787
Andreas Dilger47a0c421997-05-16 02:46:07 -0500788 /* The number of passes is either 1 for non-interlaced images,
789 * or 7 for interlaced images.
790 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500791 for (pass = 0; pass < number_passes; pass++)
792 {
793 /* Write a few rows at a time. */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500794 png_write_rows(png_ptr, &row_pointers[first_row], number_of_rows);
Guy Schalnat0d580581995-07-20 02:43:20 -0500795
796 /* If you are only writing one row at a time, this works */
797 for (y = 0; y < height; y++)
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500798 png_write_rows(png_ptr, &row_pointers[y], 1);
Guy Schalnat0d580581995-07-20 02:43:20 -0500799 }
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500800#endif no_entire /* Use only one output method */
Guy Schalnat0d580581995-07-20 02:43:20 -0500801
Andreas Dilger47a0c421997-05-16 02:46:07 -0500802 /* You can write optional chunks like tEXt, zTXt, and tIME at the end
Glenn Randers-Pehrsonf0a8fe02009-04-14 08:28:15 -0500803 * as well. Shouldn't be necessary in 1.2.0 and up as all the public
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600804 * chunks are supported and you can use png_set_unknown_chunks() to
805 * register unknown chunks into the info structure to be written out.
Guy Schalnate5a37791996-06-05 15:50:50 -0500806 */
807
Andreas Dilger47a0c421997-05-16 02:46:07 -0500808 /* It is REQUIRED to call this to finish writing the rest of the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500809 png_write_end(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600810#endif hilevel
Guy Schalnat0d580581995-07-20 02:43:20 -0500811
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600812 /* If you png_malloced a palette, free it here (don't free info_ptr->palette,
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500813 * as recommended in versions 1.0.5m and earlier of this example; if
814 * libpng mallocs info_ptr->palette, libpng will free it). If you
815 * allocated it with malloc() instead of png_malloc(), use free() instead
816 * of png_free().
817 */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600818 png_free(png_ptr, palette);
Glenn Randers-Pehrson895a9c92008-07-25 08:51:18 -0500819 palette = NULL;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600820
821 /* Similarly, if you png_malloced any data that you passed in with
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500822 * png_set_something(), such as a hist or trans array, free it here,
823 * when you can be sure that libpng is through with it.
824 */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600825 png_free(png_ptr, trans);
Glenn Randers-Pehrson895a9c92008-07-25 08:51:18 -0500826 trans = NULL;
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500827 /* Whenever you use png_free() it is a good idea to set the pointer to
828 * NULL in case your application inadvertently tries to png_free() it
829 * again. When png_free() sees a NULL it returns without action, thus
830 * avoiding the double-free security problem.
831 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500832
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500833 /* Clean up after the write, and free any memory allocated */
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -0500834 png_destroy_write_struct(&png_ptr, &info_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500835
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500836 /* Close the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500837 fclose(fp);
838
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500839 /* That's it */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500840 return (OK);
Guy Schalnat0d580581995-07-20 02:43:20 -0500841}
842
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -0500843#endif /* if 0 */