blob: 093b483fea0e3900ba91d234050cd81a98da492e [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-Pehrson63a054d2009-09-17 09:42:25 -05005 * Last changed in libpng 1.4.0 [September 17, 2009]
Glenn Randers-Pehrsonb7f95932006-03-05 20:15:20 -06006 * This file has been placed in the public domain by the authors.
Glenn Randers-Pehrson79134c62009-02-14 10:32:18 -06007 * Maintained 1998-2009 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-Pehrsonb6ce43d1998-01-01 07:13:13 -060013 * The file libpng.txt is much more verbose then this. If you have not
14 * 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
34# define png_jmpbuf(png_ptr) ((png_ptr)->jmpbuf)
35#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
163 * dithering, filling, setting background, and doing gamma
164 * 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
Andreas Dilger47a0c421997-05-16 02:46:07 -0500274 /* Dither RGB files down to 8 bit palette or reduce palettes
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600275 * to the number of colors available on your screen.
276 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500277 if (color_type & PNG_COLOR_MASK_COLOR)
Guy Schalnat0d580581995-07-20 02:43:20 -0500278 {
Glenn Randers-Pehrsonf05f8032000-12-23 14:27:39 -0600279 int num_palette;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500280 png_colorp palette;
281
282 /* This reduces the image to the application supplied palette */
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500283 if (/* We have our own palette */)
Guy Schalnat0d580581995-07-20 02:43:20 -0500284 {
Andreas Dilger47a0c421997-05-16 02:46:07 -0500285 /* An array of colors to which the image should be dithered */
286 png_color std_color_cube[MAX_SCREEN_COLORS];
Guy Schalnat0d580581995-07-20 02:43:20 -0500287
288 png_set_dither(png_ptr, std_color_cube, MAX_SCREEN_COLORS,
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500289 MAX_SCREEN_COLORS, NULL, 0);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500290 }
291 /* This reduces the image to the palette supplied in the file */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600292 else if (png_get_PLTE(png_ptr, info_ptr, &palette, &num_palette))
Andreas Dilger47a0c421997-05-16 02:46:07 -0500293 {
Glenn Randers-Pehrson865f4f02002-09-15 20:30:38 -0500294 png_uint_16p histogram = NULL;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500295
296 png_get_hIST(png_ptr, info_ptr, &histogram);
297
298 png_set_dither(png_ptr, palette, num_palette,
299 max_screen_colors, histogram, 0);
Guy Schalnat0d580581995-07-20 02:43:20 -0500300 }
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600301 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500302
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500303 /* Invert monochrome files to have 0 as white and 1 as black */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600304 png_set_invert_mono(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500305
Andreas Dilger47a0c421997-05-16 02:46:07 -0500306 /* If you want to shift the pixel values from the range [0,255] or
307 * [0,65535] to the original [0,7] or [0,31], or whatever range the
308 * colors were originally in:
309 */
310 if (png_get_valid(png_ptr, info_ptr, PNG_INFO_sBIT))
311 {
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500312 png_color_8p sig_bit_p;
Guy Schalnat0d580581995-07-20 02:43:20 -0500313
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500314 png_get_sBIT(png_ptr, info_ptr, &sig_bit_p);
315 png_set_shift(png_ptr, sig_bit_p);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500316 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500317
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500318 /* Flip the RGB pixels to BGR (or RGBA to BGRA) */
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -0500319 if (color_type & PNG_COLOR_MASK_COLOR)
320 png_set_bgr(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500321
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500322 /* Swap the RGBA or GA data to ARGB or AG (or BGRA to ABGR) */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500323 png_set_swap_alpha(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500324
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500325 /* Swap bytes of 16 bit files to least significant byte first */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500326 png_set_swap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500327
Andreas Dilger47a0c421997-05-16 02:46:07 -0500328 /* Add filler (or alpha) byte (before/after each RGB triplet) */
329 png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER);
330
331 /* Turn on interlace handling. REQUIRED if you are not using
332 * png_read_image(). To see how to handle interlacing passes,
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600333 * see the png_read_row() method below:
Andreas Dilger47a0c421997-05-16 02:46:07 -0500334 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500335 number_passes = png_set_interlace_handling(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500336
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600337 /* Optional call to gamma correct and add the background to the palette
Andreas Dilger47a0c421997-05-16 02:46:07 -0500338 * and update info structure. REQUIRED if you are expecting libpng to
339 * update the palette for you (ie you selected such a transform above).
340 */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500341 png_read_update_info(png_ptr, info_ptr);
342
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600343 /* Allocate the memory to hold the image using the fields of info_ptr. */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500344
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600345 /* The easiest way to read the image: */
Guy Schalnat6d764711995-12-19 03:22:19 -0600346 png_bytep row_pointers[height];
Guy Schalnate5a37791996-06-05 15:50:50 -0500347
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500348 /* Clear the pointer array */
Guy Schalnate5a37791996-06-05 15:50:50 -0500349 for (row = 0; row < height; row++)
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500350 row_pointers[row] = NULL;
351
352 for (row = 0; row < height; row++)
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500353 row_pointers[row] = png_malloc(png_ptr, png_get_rowbytes(png_ptr,
354 info_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -0500355
Andreas Dilger47a0c421997-05-16 02:46:07 -0500356 /* Now it's time to read the image. One of these methods is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600357#ifdef entire /* Read the entire image in one go */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500358 png_read_image(png_ptr, row_pointers);
359
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600360#else no_entire /* Read the image one or more scanlines at a time */
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600361 /* The other way to read images - deal with interlacing: */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500362
Guy Schalnat0d580581995-07-20 02:43:20 -0500363 for (pass = 0; pass < number_passes; pass++)
364 {
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600365#ifdef single /* Read the image a single row at a time */
Guy Schalnat0d580581995-07-20 02:43:20 -0500366 for (y = 0; y < height; y++)
367 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500368 png_read_rows(png_ptr, &row_pointers[y], NULL, 1);
Guy Schalnat0d580581995-07-20 02:43:20 -0500369 }
370
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600371#else no_single /* Read the image several rows at a time */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500372 for (y = 0; y < height; y += number_of_rows)
373 {
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600374#ifdef sparkle /* Read the image using the "sparkle" effect. */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500375 png_read_rows(png_ptr, &row_pointers[y], NULL,
376 number_of_rows);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600377#else no_sparkle /* Read the image using the "rectangle" effect */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500378 png_read_rows(png_ptr, NULL, &row_pointers[y],
379 number_of_rows);
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500380#endif no_sparkle /* Use only one of these two methods */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500381 }
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600382
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500383 /* If you want to display the image after every pass, do so here */
384#endif no_single /* Use only one of these two methods */
Guy Schalnat0d580581995-07-20 02:43:20 -0500385 }
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500386#endif no_entire /* Use only one of these two methods */
Guy Schalnat0d580581995-07-20 02:43:20 -0500387
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500388 /* Read rest of file, and get additional chunks in info_ptr - REQUIRED */
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600389 png_read_end(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600390#endif hilevel
391
392 /* At this point you have read the entire image */
Guy Schalnat0d580581995-07-20 02:43:20 -0500393
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500394 /* Clean up after the read, and free any memory allocated - REQUIRED */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500395 png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
Guy Schalnat0d580581995-07-20 02:43:20 -0500396
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500397 /* Close the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500398 fclose(fp);
399
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500400 /* That's it */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500401 return (OK);
Guy Schalnat0d580581995-07-20 02:43:20 -0500402}
403
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500404/* Progressively read a file */
Guy Schalnat6d764711995-12-19 03:22:19 -0600405
Guy Schalnat6d764711995-12-19 03:22:19 -0600406int
Guy Schalnate5a37791996-06-05 15:50:50 -0500407initialize_png_reader(png_structp *png_ptr, png_infop *info_ptr)
Guy Schalnat6d764711995-12-19 03:22:19 -0600408{
Guy Schalnate5a37791996-06-05 15:50:50 -0500409 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500410 * functions. If you want to use the default stderr and longjump method,
411 * you can supply NULL for the last three parameters. We also check that
412 * the library version is compatible in case we are using dynamically
413 * linked libraries.
Guy Schalnate5a37791996-06-05 15:50:50 -0500414 */
415 *png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500416 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500417
Andreas Dilger47a0c421997-05-16 02:46:07 -0500418 if (*png_ptr == NULL)
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600419 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500420 *info_ptr = NULL;
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500421 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600422 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600423
Guy Schalnate5a37791996-06-05 15:50:50 -0500424 *info_ptr = png_create_info_struct(png_ptr);
425
Andreas Dilger47a0c421997-05-16 02:46:07 -0500426 if (*info_ptr == NULL)
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600427 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500428 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500429 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600430 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600431
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600432 if (setjmp(png_jmpbuf((*png_ptr))))
Guy Schalnate5a37791996-06-05 15:50:50 -0500433 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500434 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500435 return (ERROR);
Guy Schalnate5a37791996-06-05 15:50:50 -0500436 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600437
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600438 /* This one's new. You will need to provide all three
Andreas Dilger47a0c421997-05-16 02:46:07 -0500439 * function callbacks, even if you aren't using them all.
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600440 * If you aren't using all functions, you can specify NULL
441 * parameters. Even when all three functions are NULL,
442 * you need to call png_set_progressive_read_fn().
Andreas Dilger47a0c421997-05-16 02:46:07 -0500443 * These functions shouldn't be dependent on global or
444 * static variables if you are decoding several images
445 * simultaneously. You should store stream specific data
446 * in a separate struct, given as the second parameter,
447 * and retrieve the pointer from inside the callbacks using
448 * the function png_get_progressive_ptr(png_ptr).
449 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500450 png_set_progressive_read_fn(*png_ptr, (void *)stream_data,
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600451 info_callback, row_callback, end_callback);
Guy Schalnat6d764711995-12-19 03:22:19 -0600452
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500453 return (OK);
Guy Schalnat6d764711995-12-19 03:22:19 -0600454}
455
456int
Guy Schalnate5a37791996-06-05 15:50:50 -0500457process_data(png_structp *png_ptr, png_infop *info_ptr,
458 png_bytep buffer, png_uint_32 length)
Guy Schalnat6d764711995-12-19 03:22:19 -0600459{
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600460 if (setjmp(png_jmpbuf((*png_ptr))))
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600461 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500462 /* Free the png_ptr and info_ptr memory on error */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500463 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500464 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600465 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600466
Andreas Dilger47a0c421997-05-16 02:46:07 -0500467 /* This one's new also. Simply give it chunks of data as
468 * they arrive from the data stream (in order, of course).
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500469 * On segmented machines, don't give it any more than 64K.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500470 * The library seems to run fine with sizes of 4K, although
471 * you can give it much less if necessary (I assume you can
472 * give it chunks of 1 byte, but I haven't tried with less
473 * than 256 bytes yet). When this function returns, you may
474 * want to display any rows that were generated in the row
475 * callback, if you aren't already displaying them there.
476 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500477 png_process_data(*png_ptr, *info_ptr, buffer, length);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500478 return (OK);
Guy Schalnat6d764711995-12-19 03:22:19 -0600479}
480
481info_callback(png_structp png_ptr, png_infop info)
482{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500483 /* Do any setup here, including setting any of the transformations
484 * mentioned in the Reading PNG files section. For now, you _must_
485 * call either png_start_read_image() or png_read_update_info()
486 * after all the transformations are set (even if you don't set
487 * any). You may start getting rows before png_process_data()
488 * returns, so this is your last chance to prepare for that.
489 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600490}
491
492row_callback(png_structp png_ptr, png_bytep new_row,
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600493 png_uint_32 row_num, int pass)
Guy Schalnat6d764711995-12-19 03:22:19 -0600494{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500495 /*
496 * This function is called for every row in the image. If the
497 * image is interlaced, and you turned on the interlace handler,
498 * this function will be called for every row in every pass.
499 *
500 * In this function you will receive a pointer to new row data from
501 * libpng called new_row that is to replace a corresponding row (of
502 * the same data format) in a buffer allocated by your application.
503 *
504 * The new row data pointer "new_row" may be NULL, indicating there is
505 * no new data to be replaced (in cases of interlace loading).
506 *
507 * If new_row is not NULL then you need to call
508 * png_progressive_combine_row() to replace the corresponding row as
509 * shown below:
510 */
511
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -0500512 /* Check if row_num is in bounds. */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500513 if ((row_num >= 0) && (row_num < height))
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -0500514 {
515 /* Get pointer to corresponding row in our
516 * PNG read buffer.
517 */
518 png_bytep old_row = ((png_bytep *)our_data)[row_num];
519
520 /* If both rows are allocated then copy the new row
521 * data to the corresponding row data.
522 */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500523 if ((old_row != NULL) && (new_row != NULL))
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -0500524 png_progressive_combine_row(png_ptr, old_row, new_row);
525 }
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500526 /*
527 * The rows and passes are called in order, so you don't really
528 * need the row_num and pass, but I'm supplying them because it
529 * may make your life easier.
530 *
531 * For the non-NULL rows of interlaced images, you must call
532 * png_progressive_combine_row() passing in the new row and the
533 * old row, as demonstrated above. You can call this function for
534 * NULL rows (it will just return) and for non-interlaced images
535 * (it just does the png_memcpy for you) if it will make the code
536 * easier. Thus, you can just do this for all cases:
537 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600538
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600539 png_progressive_combine_row(png_ptr, old_row, new_row);
Guy Schalnat6d764711995-12-19 03:22:19 -0600540
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500541 /* where old_row is what was displayed for previous rows. Note
542 * that the first pass (pass == 0 really) will completely cover
543 * the old row, so the rows do not have to be initialized. After
544 * the first pass (and only for interlaced images), you will have
545 * to pass the current row as new_row, and the function will combine
546 * the old row and the new row.
547 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600548}
549
550end_callback(png_structp png_ptr, png_infop info)
551{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500552 /* This function is called when the whole image has been read,
553 * including any chunks after the image (up to and including
554 * the IEND). You will usually have the same info chunk as you
555 * had in the header, although some data may have been added
556 * to the comments and time fields.
557 *
558 * Most people won't do much here, perhaps setting a flag that
559 * marks the image as finished.
560 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600561}
562
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500563/* Write a png file */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600564void write_png(char *file_name /* , ... other image information ... */)
Guy Schalnat0d580581995-07-20 02:43:20 -0500565{
566 FILE *fp;
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600567 png_structp png_ptr;
568 png_infop info_ptr;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600569 png_colorp palette;
Guy Schalnat0d580581995-07-20 02:43:20 -0500570
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500571 /* Open the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500572 fp = fopen(file_name, "wb");
Andreas Dilger47a0c421997-05-16 02:46:07 -0500573 if (fp == NULL)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500574 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500575
Guy Schalnate5a37791996-06-05 15:50:50 -0500576 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500577 * functions. If you want to use the default stderr and longjump method,
578 * you can supply NULL for the last three parameters. We also check that
579 * the library version is compatible with the one used at compile time,
580 * in case we are using dynamically linked libraries. REQUIRED.
Guy Schalnate5a37791996-06-05 15:50:50 -0500581 */
582 png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500583 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500584
Andreas Dilger47a0c421997-05-16 02:46:07 -0500585 if (png_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500586 {
587 fclose(fp);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500588 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500589 }
590
Andreas Dilger47a0c421997-05-16 02:46:07 -0500591 /* Allocate/initialize the image information data. REQUIRED */
Guy Schalnate5a37791996-06-05 15:50:50 -0500592 info_ptr = png_create_info_struct(png_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500593 if (info_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500594 {
595 fclose(fp);
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500596 png_destroy_write_struct(&png_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500597 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500598 }
599
Andreas Dilger47a0c421997-05-16 02:46:07 -0500600 /* Set error handling. REQUIRED if you aren't supplying your own
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600601 * error handling functions in the png_create_write_struct() call.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500602 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600603 if (setjmp(png_jmpbuf(png_ptr)))
Guy Schalnat0d580581995-07-20 02:43:20 -0500604 {
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500605 /* If we get here, we had a problem writing the file */
Guy Schalnate5a37791996-06-05 15:50:50 -0500606 fclose(fp);
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -0500607 png_destroy_write_struct(&png_ptr, &info_ptr);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500608 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500609 }
610
Andreas Dilger47a0c421997-05-16 02:46:07 -0500611 /* One of the following I/O initialization functions is REQUIRED */
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500612
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600613#ifdef streams /* I/O initialization method 1 */
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500614 /* Set up the output control if you are using standard C streams */
Guy Schalnat0d580581995-07-20 02:43:20 -0500615 png_init_io(png_ptr, fp);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500616
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600617#else no_streams /* I/O initialization method 2 */
Glenn Randers-Pehrsona5fa5c92008-09-06 07:06:22 -0500618 /* If you are using replacement write functions, instead of calling
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500619 * png_init_io() here you would call
620 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500621 png_set_write_fn(png_ptr, (void *)user_io_ptr, user_write_fn,
622 user_IO_flush_function);
623 /* where user_io_ptr is a structure you want available to the callbacks */
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500624#endif no_streams /* Only use one initialization method */
Guy Schalnat0d580581995-07-20 02:43:20 -0500625
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600626#ifdef hilevel
627 /* This is the easy way. Use it if you already have all the
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500628 * image info living in the structure. You could "|" many
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600629 * PNG_TRANSFORM flags into the png_transforms integer here.
630 */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500631 png_write_png(png_ptr, info_ptr, png_transforms, NULL);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500632
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600633#else
634 /* This is the hard way */
635
Andreas Dilger47a0c421997-05-16 02:46:07 -0500636 /* Set the image information here. Width and height are up to 2^31,
637 * bit_depth is one of 1, 2, 4, 8, or 16, but valid values also depend on
638 * the color_type selected. color_type is one of PNG_COLOR_TYPE_GRAY,
639 * PNG_COLOR_TYPE_GRAY_ALPHA, PNG_COLOR_TYPE_PALETTE, PNG_COLOR_TYPE_RGB,
640 * or PNG_COLOR_TYPE_RGB_ALPHA. interlace is either PNG_INTERLACE_NONE or
641 * PNG_INTERLACE_ADAM7, and the compression_type and filter_type MUST
642 * currently be PNG_COMPRESSION_TYPE_BASE and PNG_FILTER_TYPE_BASE. REQUIRED
643 */
644 png_set_IHDR(png_ptr, info_ptr, width, height, bit_depth, PNG_COLOR_TYPE_???,
645 PNG_INTERLACE_????, PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
Guy Schalnat0d580581995-07-20 02:43:20 -0500646
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500647 /* Set the palette if there is one. REQUIRED for indexed-color images */
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500648 palette = (png_colorp)png_malloc(png_ptr, PNG_MAX_PALETTE_LENGTH
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500649 * png_sizeof(png_color));
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500650 /* ... Set palette colors ... */
Glenn Randers-Pehrson76e5fd62000-12-28 07:50:05 -0600651 png_set_PLTE(png_ptr, info_ptr, palette, PNG_MAX_PALETTE_LENGTH);
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600652 /* You must not free palette here, because png_set_PLTE only makes a link to
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500653 * the palette that you malloced. Wait until you are about to destroy
654 * the png structure.
655 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500656
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500657 /* Optional significant bit (sBIT) chunk */
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500658 png_color_8 sig_bit;
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-Pehrson64548de2009-05-13 15:23:03 -0500661 /* Otherwise, if we are dealing with a color image then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500662 sig_bit.red = true_red_bit_depth;
663 sig_bit.green = true_green_bit_depth;
664 sig_bit.blue = true_blue_bit_depth;
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500665 /* If the image has an alpha channel then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500666 sig_bit.alpha = true_alpha_bit_depth;
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500667 png_set_sBIT(png_ptr, info_ptr, &sig_bit);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500668
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600669
Andreas Dilger47a0c421997-05-16 02:46:07 -0500670 /* Optional gamma chunk is strongly suggested if you have any guess
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600671 * as to the correct gamma of the image.
672 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500673 png_set_gAMA(png_ptr, info_ptr, gamma);
Guy Schalnat0d580581995-07-20 02:43:20 -0500674
Andreas Dilger47a0c421997-05-16 02:46:07 -0500675 /* Optionally write comments into the image */
676 text_ptr[0].key = "Title";
677 text_ptr[0].text = "Mona Lisa";
678 text_ptr[0].compression = PNG_TEXT_COMPRESSION_NONE;
679 text_ptr[1].key = "Author";
680 text_ptr[1].text = "Leonardo DaVinci";
681 text_ptr[1].compression = PNG_TEXT_COMPRESSION_NONE;
682 text_ptr[2].key = "Description";
683 text_ptr[2].text = "<long text>";
684 text_ptr[2].compression = PNG_TEXT_COMPRESSION_zTXt;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600685#ifdef PNG_iTXt_SUPPORTED
686 text_ptr[0].lang = NULL;
687 text_ptr[1].lang = NULL;
688 text_ptr[2].lang = NULL;
689#endif
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500690 png_set_text(png_ptr, info_ptr, text_ptr, 3);
Guy Schalnat0d580581995-07-20 02:43:20 -0500691
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500692 /* Other optional chunks like cHRM, bKGD, tRNS, tIME, oFFs, pHYs */
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500693
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500694 /* Note that if sRGB is present the gAMA and cHRM chunks must be ignored
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500695 * on read and, if your application chooses to write them, they must
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500696 * be written in accordance with the sRGB profile
697 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500698
699 /* Write the file header information. REQUIRED */
Guy Schalnat0d580581995-07-20 02:43:20 -0500700 png_write_info(png_ptr, info_ptr);
701
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600702 /* If you want, you can write the info in two steps, in case you need to
703 * write your private chunk ahead of PLTE:
704 *
705 * png_write_info_before_PLTE(write_ptr, write_info_ptr);
706 * write_my_chunk();
707 * png_write_info(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600708 *
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500709 * However, given the level of known- and unknown-chunk support in 1.2.0
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600710 * and up, this should no longer be necessary.
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600711 */
712
Andreas Dilger47a0c421997-05-16 02:46:07 -0500713 /* Once we write out the header, the compression type on the text
714 * chunks gets changed to PNG_TEXT_COMPRESSION_NONE_WR or
715 * PNG_TEXT_COMPRESSION_zTXt_WR, so it doesn't get written out again
716 * at the end.
717 */
718
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500719 /* Set up the transformations you want. Note that these are
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600720 * all optional. Only call them if you want them.
721 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500722
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500723 /* Invert monochrome pixels */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600724 png_set_invert_mono(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500725
Andreas Dilger47a0c421997-05-16 02:46:07 -0500726 /* Shift the pixels up to a legal bit depth and fill in
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600727 * as appropriate to correctly scale the image.
728 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500729 png_set_shift(png_ptr, &sig_bit);
Guy Schalnat0d580581995-07-20 02:43:20 -0500730
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500731 /* Pack pixels into bytes */
Guy Schalnat0d580581995-07-20 02:43:20 -0500732 png_set_packing(png_ptr);
733
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500734 /* Swap location of alpha bytes from ARGB to RGBA */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500735 png_set_swap_alpha(png_ptr);
736
737 /* Get rid of filler (OR ALPHA) bytes, pack XRGB/RGBX/ARGB/RGBA into
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600738 * RGB (4 channels -> 3 channels). The second parameter is not used.
739 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500740 png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
741
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500742 /* Flip BGR pixels to RGB */
Guy Schalnat0d580581995-07-20 02:43:20 -0500743 png_set_bgr(png_ptr);
744
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500745 /* Swap bytes of 16-bit files to most significant byte first */
Guy Schalnat0d580581995-07-20 02:43:20 -0500746 png_set_swap(png_ptr);
747
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500748 /* Swap bits of 1, 2, 4 bit packed pixel formats */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500749 png_set_packswap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500750
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500751 /* Turn on interlace handling if you are not using png_write_image() */
Guy Schalnat0d580581995-07-20 02:43:20 -0500752 if (interlacing)
753 number_passes = png_set_interlace_handling(png_ptr);
754 else
755 number_passes = 1;
756
Andreas Dilger47a0c421997-05-16 02:46:07 -0500757 /* The easiest way to write the image (you may have a different memory
758 * layout, however, so choose what fits your needs best). You need to
759 * use the first method if you aren't handling interlacing yourself.
760 */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500761 png_uint_32 k, height, width;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600762 png_byte image[height][width*bytes_per_pixel];
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500763 png_bytep row_pointers[height];
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500764
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500765 if (height > PNG_UINT_32_MAX/png_sizeof(png_bytep))
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -0500766 png_error (png_ptr, "Image is too tall to process in memory");
767
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500768 for (k = 0; k < height; k++)
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600769 row_pointers[k] = image + k*width*bytes_per_pixel;
Guy Schalnate5a37791996-06-05 15:50:50 -0500770
Andreas Dilger47a0c421997-05-16 02:46:07 -0500771 /* One of the following output methods is REQUIRED */
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500772
773#ifdef entire /* Write out the entire image data in one call */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500774 png_write_image(png_ptr, row_pointers);
775
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500776 /* The other way to write the image - deal with interlacing */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500777
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500778#else no_entire /* Write out the image data by one or more scanlines */
779
Andreas Dilger47a0c421997-05-16 02:46:07 -0500780 /* The number of passes is either 1 for non-interlaced images,
781 * or 7 for interlaced images.
782 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500783 for (pass = 0; pass < number_passes; pass++)
784 {
785 /* Write a few rows at a time. */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500786 png_write_rows(png_ptr, &row_pointers[first_row], number_of_rows);
Guy Schalnat0d580581995-07-20 02:43:20 -0500787
788 /* If you are only writing one row at a time, this works */
789 for (y = 0; y < height; y++)
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500790 png_write_rows(png_ptr, &row_pointers[y], 1);
Guy Schalnat0d580581995-07-20 02:43:20 -0500791 }
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500792#endif no_entire /* Use only one output method */
Guy Schalnat0d580581995-07-20 02:43:20 -0500793
Andreas Dilger47a0c421997-05-16 02:46:07 -0500794 /* You can write optional chunks like tEXt, zTXt, and tIME at the end
Glenn Randers-Pehrsonf0a8fe02009-04-14 08:28:15 -0500795 * as well. Shouldn't be necessary in 1.2.0 and up as all the public
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600796 * chunks are supported and you can use png_set_unknown_chunks() to
797 * register unknown chunks into the info structure to be written out.
Guy Schalnate5a37791996-06-05 15:50:50 -0500798 */
799
Andreas Dilger47a0c421997-05-16 02:46:07 -0500800 /* It is REQUIRED to call this to finish writing the rest of the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500801 png_write_end(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600802#endif hilevel
Guy Schalnat0d580581995-07-20 02:43:20 -0500803
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600804 /* If you png_malloced a palette, free it here (don't free info_ptr->palette,
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500805 * as recommended in versions 1.0.5m and earlier of this example; if
806 * libpng mallocs info_ptr->palette, libpng will free it). If you
807 * allocated it with malloc() instead of png_malloc(), use free() instead
808 * of png_free().
809 */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600810 png_free(png_ptr, palette);
Glenn Randers-Pehrson895a9c92008-07-25 08:51:18 -0500811 palette = NULL;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600812
813 /* Similarly, if you png_malloced any data that you passed in with
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500814 * png_set_something(), such as a hist or trans array, free it here,
815 * when you can be sure that libpng is through with it.
816 */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600817 png_free(png_ptr, trans);
Glenn Randers-Pehrson895a9c92008-07-25 08:51:18 -0500818 trans = NULL;
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500819 /* Whenever you use png_free() it is a good idea to set the pointer to
820 * NULL in case your application inadvertently tries to png_free() it
821 * again. When png_free() sees a NULL it returns without action, thus
822 * avoiding the double-free security problem.
823 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500824
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500825 /* Clean up after the write, and free any memory allocated */
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -0500826 png_destroy_write_struct(&png_ptr, &info_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500827
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500828 /* Close the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500829 fclose(fp);
830
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500831 /* That's it */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500832 return (OK);
Guy Schalnat0d580581995-07-20 02:43:20 -0500833}
834
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -0500835#endif /* if 0 */