blob: c05f90ab7fdcdfe15ca8765da9105126873f8ed5 [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-Pehrsond6d80752008-12-02 09:49:43 -06005 * Last changed in libpng 1.4.0 [December 2, 2008]
Glenn Randers-Pehrsonb7f95932006-03-05 20:15:20 -06006 * This file has been placed in the public domain by the authors.
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -05007 * Maintained 1998-2008 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-Pehrsoncbe52d81998-02-28 07:00:24 -060094#else no_open_file /* prototype 2 */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060095void read_png(FILE *fp, unsigned int sig_read) /* file is already open */
96{
97 png_structp png_ptr;
98 png_infop info_ptr;
Andreas Dilger47a0c421997-05-16 02:46:07 -050099 png_uint_32 width, height;
100 int bit_depth, color_type, interlace_type;
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600101#endif no_open_file /* only use one prototype! */
Guy Schalnat0d580581995-07-20 02:43:20 -0500102
Guy Schalnate5a37791996-06-05 15:50:50 -0500103 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500104 * functions. If you want to use the default stderr and longjump method,
105 * you can supply NULL for the last three parameters. We also supply the
106 * the compiler header file version, so that we know if the application
107 * was compiled with a compatible version of the library. REQUIRED
108 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500109 png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500110 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500111
Andreas Dilger47a0c421997-05-16 02:46:07 -0500112 if (png_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500113 {
114 fclose(fp);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500115 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500116 }
117
Andreas Dilger47a0c421997-05-16 02:46:07 -0500118 /* Allocate/initialize the memory for image information. REQUIRED. */
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -0600119 info_ptr = png_create_info_struct(png_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500120 if (info_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500121 {
122 fclose(fp);
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500123 png_destroy_read_struct(&png_ptr, NULL, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500124 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500125 }
126
Andreas Dilger47a0c421997-05-16 02:46:07 -0500127 /* Set error handling if you are using the setjmp/longjmp method (this is
128 * the normal method of doing things with libpng). REQUIRED unless you
129 * set up your own error handlers in the png_create_read_struct() earlier.
130 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600131
132 if (setjmp(png_jmpbuf(png_ptr)))
Guy Schalnat0d580581995-07-20 02:43:20 -0500133 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500134 /* Free all of the memory associated with the png_ptr and info_ptr */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500135 png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
Guy Schalnat0d580581995-07-20 02:43:20 -0500136 fclose(fp);
Guy Schalnat0d580581995-07-20 02:43:20 -0500137 /* If we get here, we had a problem reading the file */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500138 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500139 }
140
Andreas Dilger47a0c421997-05-16 02:46:07 -0500141 /* One of the following I/O initialization methods is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600142#ifdef streams /* PNG file I/O method 1 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500143 /* Set up the input control if you are using standard C streams */
Guy Schalnat0d580581995-07-20 02:43:20 -0500144 png_init_io(png_ptr, fp);
145
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600146#else no_streams /* PNG file I/O method 2 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500147 /* If you are using replacement read functions, instead of calling
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600148 * png_init_io() here you would call:
149 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500150 png_set_read_fn(png_ptr, (void *)user_io_ptr, user_read_fn);
151 /* where user_io_ptr is a structure you want available to the callbacks */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600152#endif no_streams /* Use only one I/O method! */
Guy Schalnat69b14481996-01-10 02:56:49 -0600153
Andreas Dilger47a0c421997-05-16 02:46:07 -0500154 /* If we have already read some of the signature */
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -0600155 png_set_sig_bytes(png_ptr, sig_read);
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600156
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600157#ifdef hilevel
158 /*
159 * If you have enough memory to read in the entire image at once,
160 * and you need to specify only transforms that can be controlled
161 * with one of the PNG_TRANSFORM_* bits (this presently excludes
162 * dithering, filling, setting background, and doing gamma
163 * adjustment), then you can read the entire image (including
164 * pixels) into the info structure with this call:
165 */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500166 png_read_png(png_ptr, info_ptr, png_transforms, NULL);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600167#else
168 /* OK, you're doing it the hard way, with the lower-level functions */
169
Andreas Dilger47a0c421997-05-16 02:46:07 -0500170 /* The call to png_read_info() gives us all of the information from the
171 * PNG file before the first IDAT (image data chunk). REQUIRED
172 */
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600173 png_read_info(png_ptr, info_ptr);
Guy Schalnat69b14481996-01-10 02:56:49 -0600174
Andreas Dilger47a0c421997-05-16 02:46:07 -0500175 png_get_IHDR(png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500176 &interlace_type, NULL, NULL);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500177
Glenn Randers-Pehrsond1e8c862002-06-20 06:54:34 -0500178/* Set up the data transformations you want. Note that these are all
179 * optional. Only call them if you want/need them. Many of the
180 * transformations only work on specific types of images, and many
181 * are mutually exclusive.
182 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500183
184 /* tell libpng to strip 16 bit/color files down to 8 bits/color */
185 png_set_strip_16(png_ptr);
186
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500187 /* Strip alpha bytes from the input data without combining with the
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600188 * background (not recommended).
189 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500190 png_set_strip_alpha(png_ptr);
191
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600192 /* Extract multiple pixels with bit depths of 1, 2, and 4 from a single
Andreas Dilger47a0c421997-05-16 02:46:07 -0500193 * byte into separate bytes (useful for paletted and grayscale images).
194 */
195 png_set_packing(png_ptr);
196
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600197 /* Change the order of packed pixels to least significant bit first
Andreas Dilger47a0c421997-05-16 02:46:07 -0500198 * (not useful if you are using png_set_packing). */
199 png_set_packswap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500200
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600201 /* Expand paletted colors into true RGB triplets */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500202 if (color_type == PNG_COLOR_TYPE_PALETTE)
Glenn Randers-Pehrsonf46918d2006-06-02 05:31:20 -0500203 png_set_palette_to_rgb(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500204
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600205 /* Expand grayscale images to the full 8 bits from 1, 2, or 4 bits/pixel */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500206 if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8)
Glenn Randers-Pehrson56f63962008-10-06 10:16:17 -0500207 png_set_expand_gray_1_2_4_to_8(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500208
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600209 /* Expand paletted or RGB images with transparency to full alpha channels
210 * so the data will be available as RGBA quartets.
211 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500212 if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS))
Glenn Randers-Pehrsonb1828932001-06-23 08:03:17 -0500213 png_set_tRNS_to_alpha(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500214
Andreas Dilger47a0c421997-05-16 02:46:07 -0500215 /* Set the background color to draw transparent and alpha images over.
216 * It is possible to set the red, green, and blue components directly
217 * for paletted images instead of supplying a palette index. Note that
218 * even if the PNG file supplies a background, you are not required to
219 * use it - you should use the (solid) application background if it has one.
220 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500221
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600222 png_color_16 my_background, *image_background;
Guy Schalnat0d580581995-07-20 02:43:20 -0500223
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600224 if (png_get_bKGD(png_ptr, info_ptr, &image_background))
225 png_set_background(png_ptr, image_background,
Guy Schalnate5a37791996-06-05 15:50:50 -0500226 PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600227 else
228 png_set_background(png_ptr, &my_background,
Guy Schalnate5a37791996-06-05 15:50:50 -0500229 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
Guy Schalnat0d580581995-07-20 02:43:20 -0500230
Andreas Dilger47a0c421997-05-16 02:46:07 -0500231 /* Some suggestions as to how to get a screen gamma value */
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600232
Glenn Randers-Pehrsonbcfd15d1999-10-01 14:22:25 -0500233 /* Note that screen gamma is the display_exponent, which includes
234 * the CRT_exponent and any correction for viewing conditions */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500235 if (/* We have a user-defined screen gamma value */)
236 {
237 screen_gamma = user-defined screen_gamma;
238 }
239 /* This is one way that applications share the same screen gamma value */
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600240 else if ((gamma_str = getenv("SCREEN_GAMMA")) != NULL)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500241 {
242 screen_gamma = atof(gamma_str);
243 }
244 /* If we don't have another value */
245 else
246 {
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600247 screen_gamma = 2.2; /* A good guess for a PC monitors in a dimly
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600248 lit room */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500249 screen_gamma = 1.7 or 1.0; /* A good guess for Mac systems */
250 }
251
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600252 /* Tell libpng to handle the gamma conversion for you. The final call
Andreas Dilger47a0c421997-05-16 02:46:07 -0500253 * is a good guess for PC generated images, but it should be configurable
254 * by the user at run time by the user. It is strongly suggested that
255 * your application support gamma correction.
256 */
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600257
258 int intent;
259
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600260 if (png_get_sRGB(png_ptr, info_ptr, &intent))
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600261 png_set_gamma(png_ptr, screen_gamma, 0.45455);
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600262 else
263 {
264 double image_gamma;
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600265 if (png_get_gAMA(png_ptr, info_ptr, &image_gamma))
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600266 png_set_gamma(png_ptr, screen_gamma, image_gamma);
267 else
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600268 png_set_gamma(png_ptr, screen_gamma, 0.45455);
269 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500270
Andreas Dilger47a0c421997-05-16 02:46:07 -0500271 /* Dither RGB files down to 8 bit palette or reduce palettes
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600272 * to the number of colors available on your screen.
273 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500274 if (color_type & PNG_COLOR_MASK_COLOR)
Guy Schalnat0d580581995-07-20 02:43:20 -0500275 {
Glenn Randers-Pehrsonf05f8032000-12-23 14:27:39 -0600276 int num_palette;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500277 png_colorp palette;
278
279 /* This reduces the image to the application supplied palette */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600280 if (/* we have our own palette */)
Guy Schalnat0d580581995-07-20 02:43:20 -0500281 {
Andreas Dilger47a0c421997-05-16 02:46:07 -0500282 /* An array of colors to which the image should be dithered */
283 png_color std_color_cube[MAX_SCREEN_COLORS];
Guy Schalnat0d580581995-07-20 02:43:20 -0500284
285 png_set_dither(png_ptr, std_color_cube, MAX_SCREEN_COLORS,
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500286 MAX_SCREEN_COLORS, NULL, 0);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500287 }
288 /* This reduces the image to the palette supplied in the file */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600289 else if (png_get_PLTE(png_ptr, info_ptr, &palette, &num_palette))
Andreas Dilger47a0c421997-05-16 02:46:07 -0500290 {
Glenn Randers-Pehrson865f4f02002-09-15 20:30:38 -0500291 png_uint_16p histogram = NULL;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500292
293 png_get_hIST(png_ptr, info_ptr, &histogram);
294
295 png_set_dither(png_ptr, palette, num_palette,
296 max_screen_colors, histogram, 0);
Guy Schalnat0d580581995-07-20 02:43:20 -0500297 }
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600298 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500299
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500300 /* invert monochrome files to have 0 as white and 1 as black */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600301 png_set_invert_mono(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500302
Andreas Dilger47a0c421997-05-16 02:46:07 -0500303 /* If you want to shift the pixel values from the range [0,255] or
304 * [0,65535] to the original [0,7] or [0,31], or whatever range the
305 * colors were originally in:
306 */
307 if (png_get_valid(png_ptr, info_ptr, PNG_INFO_sBIT))
308 {
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600309 png_color_8p sig_bit;
Guy Schalnat0d580581995-07-20 02:43:20 -0500310
Andreas Dilger47a0c421997-05-16 02:46:07 -0500311 png_get_sBIT(png_ptr, info_ptr, &sig_bit);
312 png_set_shift(png_ptr, sig_bit);
313 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500314
Andreas Dilger47a0c421997-05-16 02:46:07 -0500315 /* flip the RGB pixels to BGR (or RGBA to BGRA) */
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -0500316 if (color_type & PNG_COLOR_MASK_COLOR)
317 png_set_bgr(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500318
Andreas Dilger47a0c421997-05-16 02:46:07 -0500319 /* swap the RGBA or GA data to ARGB or AG (or BGRA to ABGR) */
320 png_set_swap_alpha(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500321
Andreas Dilger47a0c421997-05-16 02:46:07 -0500322 /* swap bytes of 16 bit files to least significant byte first */
323 png_set_swap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500324
Andreas Dilger47a0c421997-05-16 02:46:07 -0500325 /* Add filler (or alpha) byte (before/after each RGB triplet) */
326 png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER);
327
328 /* Turn on interlace handling. REQUIRED if you are not using
329 * png_read_image(). To see how to handle interlacing passes,
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600330 * see the png_read_row() method below:
Andreas Dilger47a0c421997-05-16 02:46:07 -0500331 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500332 number_passes = png_set_interlace_handling(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500333
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600334 /* Optional call to gamma correct and add the background to the palette
Andreas Dilger47a0c421997-05-16 02:46:07 -0500335 * and update info structure. REQUIRED if you are expecting libpng to
336 * update the palette for you (ie you selected such a transform above).
337 */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500338 png_read_update_info(png_ptr, info_ptr);
339
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600340 /* Allocate the memory to hold the image using the fields of info_ptr. */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500341
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600342 /* The easiest way to read the image: */
Guy Schalnat6d764711995-12-19 03:22:19 -0600343 png_bytep row_pointers[height];
Guy Schalnate5a37791996-06-05 15:50:50 -0500344
345 for (row = 0; row < height; row++)
346 {
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500347 row_pointers[row] = png_malloc(png_ptr, png_get_rowbytes(png_ptr,
348 info_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -0500349 }
350
Andreas Dilger47a0c421997-05-16 02:46:07 -0500351 /* Now it's time to read the image. One of these methods is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600352#ifdef entire /* Read the entire image in one go */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500353 png_read_image(png_ptr, row_pointers);
354
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600355#else no_entire /* Read the image one or more scanlines at a time */
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600356 /* The other way to read images - deal with interlacing: */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500357
Guy Schalnat0d580581995-07-20 02:43:20 -0500358 for (pass = 0; pass < number_passes; pass++)
359 {
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600360#ifdef single /* Read the image a single row at a time */
Guy Schalnat0d580581995-07-20 02:43:20 -0500361 for (y = 0; y < height; y++)
362 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500363 png_read_rows(png_ptr, &row_pointers[y], NULL, 1);
Guy Schalnat0d580581995-07-20 02:43:20 -0500364 }
365
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600366#else no_single /* Read the image several rows at a time */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500367 for (y = 0; y < height; y += number_of_rows)
368 {
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600369#ifdef sparkle /* Read the image using the "sparkle" effect. */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500370 png_read_rows(png_ptr, &row_pointers[y], NULL,
371 number_of_rows);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600372#else no_sparkle /* Read the image using the "rectangle" effect */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500373 png_read_rows(png_ptr, NULL, &row_pointers[y],
374 number_of_rows);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600375#endif no_sparkle /* use only one of these two methods */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500376 }
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600377
Guy Schalnat0d580581995-07-20 02:43:20 -0500378 /* if you want to display the image after every pass, do
379 so here */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600380#endif no_single /* use only one of these two methods */
Guy Schalnat0d580581995-07-20 02:43:20 -0500381 }
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600382#endif no_entire /* use only one of these two methods */
Guy Schalnat0d580581995-07-20 02:43:20 -0500383
Andreas Dilger47a0c421997-05-16 02:46:07 -0500384 /* read rest of file, and get additional chunks in info_ptr - REQUIRED */
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600385 png_read_end(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600386#endif hilevel
387
388 /* At this point you have read the entire image */
Guy Schalnat0d580581995-07-20 02:43:20 -0500389
Andreas Dilger47a0c421997-05-16 02:46:07 -0500390 /* clean up after the read, and free any memory allocated - REQUIRED */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500391 png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
Guy Schalnat0d580581995-07-20 02:43:20 -0500392
393 /* close the file */
394 fclose(fp);
395
396 /* that's it */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500397 return (OK);
Guy Schalnat0d580581995-07-20 02:43:20 -0500398}
399
Guy Schalnat6d764711995-12-19 03:22:19 -0600400/* progressively read a file */
401
Guy Schalnat6d764711995-12-19 03:22:19 -0600402int
Guy Schalnate5a37791996-06-05 15:50:50 -0500403initialize_png_reader(png_structp *png_ptr, png_infop *info_ptr)
Guy Schalnat6d764711995-12-19 03:22:19 -0600404{
Guy Schalnate5a37791996-06-05 15:50:50 -0500405 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500406 * functions. If you want to use the default stderr and longjump method,
407 * you can supply NULL for the last three parameters. We also check that
408 * the library version is compatible in case we are using dynamically
409 * linked libraries.
Guy Schalnate5a37791996-06-05 15:50:50 -0500410 */
411 *png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500412 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500413
Andreas Dilger47a0c421997-05-16 02:46:07 -0500414 if (*png_ptr == NULL)
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600415 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500416 *info_ptr = NULL;
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500417 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600418 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600419
Guy Schalnate5a37791996-06-05 15:50:50 -0500420 *info_ptr = png_create_info_struct(png_ptr);
421
Andreas Dilger47a0c421997-05-16 02:46:07 -0500422 if (*info_ptr == NULL)
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600423 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500424 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500425 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600426 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600427
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600428 if (setjmp(png_jmpbuf((*png_ptr))))
Guy Schalnate5a37791996-06-05 15:50:50 -0500429 {
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 Schalnate5a37791996-06-05 15:50:50 -0500432 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600433
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600434 /* This one's new. You will need to provide all three
Andreas Dilger47a0c421997-05-16 02:46:07 -0500435 * function callbacks, even if you aren't using them all.
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600436 * If you aren't using all functions, you can specify NULL
437 * parameters. Even when all three functions are NULL,
438 * you need to call png_set_progressive_read_fn().
Andreas Dilger47a0c421997-05-16 02:46:07 -0500439 * These functions shouldn't be dependent on global or
440 * static variables if you are decoding several images
441 * simultaneously. You should store stream specific data
442 * in a separate struct, given as the second parameter,
443 * and retrieve the pointer from inside the callbacks using
444 * the function png_get_progressive_ptr(png_ptr).
445 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500446 png_set_progressive_read_fn(*png_ptr, (void *)stream_data,
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600447 info_callback, row_callback, end_callback);
Guy Schalnat6d764711995-12-19 03:22:19 -0600448
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500449 return (OK);
Guy Schalnat6d764711995-12-19 03:22:19 -0600450}
451
452int
Guy Schalnate5a37791996-06-05 15:50:50 -0500453process_data(png_structp *png_ptr, png_infop *info_ptr,
454 png_bytep buffer, png_uint_32 length)
Guy Schalnat6d764711995-12-19 03:22:19 -0600455{
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600456 if (setjmp(png_jmpbuf((*png_ptr))))
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600457 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500458 /* Free the png_ptr and info_ptr memory on error */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500459 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500460 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600461 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600462
Andreas Dilger47a0c421997-05-16 02:46:07 -0500463 /* This one's new also. Simply give it chunks of data as
464 * they arrive from the data stream (in order, of course).
465 * On Segmented machines, don't give it any more than 64K.
466 * The library seems to run fine with sizes of 4K, although
467 * you can give it much less if necessary (I assume you can
468 * give it chunks of 1 byte, but I haven't tried with less
469 * than 256 bytes yet). When this function returns, you may
470 * want to display any rows that were generated in the row
471 * callback, if you aren't already displaying them there.
472 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500473 png_process_data(*png_ptr, *info_ptr, buffer, length);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500474 return (OK);
Guy Schalnat6d764711995-12-19 03:22:19 -0600475}
476
477info_callback(png_structp png_ptr, png_infop info)
478{
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600479/* do any setup here, including setting any of the transformations
Andreas Dilger47a0c421997-05-16 02:46:07 -0500480 * mentioned in the Reading PNG files section. For now, you _must_
481 * call either png_start_read_image() or png_read_update_info()
482 * after all the transformations are set (even if you don't set
483 * any). You may start getting rows before png_process_data()
484 * returns, so this is your last chance to prepare for that.
485 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600486}
487
488row_callback(png_structp png_ptr, png_bytep new_row,
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600489 png_uint_32 row_num, int pass)
Guy Schalnat6d764711995-12-19 03:22:19 -0600490{
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -0500491/*
492 * This function is called for every row in the image. If the
493 * image is interlaced, and you turned on the interlace handler,
Andreas Dilger47a0c421997-05-16 02:46:07 -0500494 * this function will be called for every row in every pass.
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -0500495 *
496 * In this function you will receive a pointer to new row data from
497 * libpng called new_row that is to replace a corresponding row (of
498 * the same data format) in a buffer allocated by your application.
Glenn Randers-Pehrsone6474622006-03-04 16:50:47 -0600499 *
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -0500500 * The new row data pointer new_row may be NULL, indicating there is
501 * no new data to be replaced (in cases of interlace loading).
Glenn Randers-Pehrsone6474622006-03-04 16:50:47 -0600502 *
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -0500503 * If new_row is not NULL then you need to call
504 * png_progressive_combine_row() to replace the corresponding row as
505 * shown below:
506 */
507 /* Check if row_num is in bounds. */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500508 if ((row_num >= 0) && (row_num < height))
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -0500509 {
510 /* Get pointer to corresponding row in our
511 * PNG read buffer.
512 */
513 png_bytep old_row = ((png_bytep *)our_data)[row_num];
514
515 /* If both rows are allocated then copy the new row
516 * data to the corresponding row data.
517 */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500518 if ((old_row != NULL) && (new_row != NULL))
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -0500519 png_progressive_combine_row(png_ptr, old_row, new_row);
520 }
521/*
Andreas Dilger47a0c421997-05-16 02:46:07 -0500522 * The rows and passes are called in order, so you don't really
523 * need the row_num and pass, but I'm supplying them because it
524 * may make your life easier.
525 *
526 * For the non-NULL rows of interlaced images, you must call
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -0500527 * png_progressive_combine_row() passing in the new row and the
528 * old row, as demonstrated above. You can call this function for
529 * NULL rows (it will just return) and for non-interlaced images
530 * (it just does the png_memcpy for you) if it will make the code
531 * easier. Thus, you can just do this for all cases:
Andreas Dilger47a0c421997-05-16 02:46:07 -0500532 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600533
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600534 png_progressive_combine_row(png_ptr, old_row, new_row);
Guy Schalnat6d764711995-12-19 03:22:19 -0600535
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600536/* where old_row is what was displayed for previous rows. Note
Andreas Dilger47a0c421997-05-16 02:46:07 -0500537 * that the first pass (pass == 0 really) will completely cover
538 * the old row, so the rows do not have to be initialized. After
539 * the first pass (and only for interlaced images), you will have
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -0500540 * to pass the current row as new_row, and the function will combine
541 * the old row and the new row.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500542 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600543}
544
545end_callback(png_structp png_ptr, png_infop info)
546{
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600547/* this function is called when the whole image has been read,
Andreas Dilger47a0c421997-05-16 02:46:07 -0500548 * including any chunks after the image (up to and including
549 * the IEND). You will usually have the same info chunk as you
550 * had in the header, although some data may have been added
551 * to the comments and time fields.
552 *
553 * Most people won't do much here, perhaps setting a flag that
554 * marks the image as finished.
555 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600556}
557
Guy Schalnat0d580581995-07-20 02:43:20 -0500558/* write a png file */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600559void write_png(char *file_name /* , ... other image information ... */)
Guy Schalnat0d580581995-07-20 02:43:20 -0500560{
561 FILE *fp;
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600562 png_structp png_ptr;
563 png_infop info_ptr;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600564 png_colorp palette;
Guy Schalnat0d580581995-07-20 02:43:20 -0500565
566 /* open the file */
567 fp = fopen(file_name, "wb");
Andreas Dilger47a0c421997-05-16 02:46:07 -0500568 if (fp == NULL)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500569 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500570
Guy Schalnate5a37791996-06-05 15:50:50 -0500571 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500572 * functions. If you want to use the default stderr and longjump method,
573 * you can supply NULL for the last three parameters. We also check that
574 * the library version is compatible with the one used at compile time,
575 * in case we are using dynamically linked libraries. REQUIRED.
Guy Schalnate5a37791996-06-05 15:50:50 -0500576 */
577 png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500578 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500579
Andreas Dilger47a0c421997-05-16 02:46:07 -0500580 if (png_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500581 {
582 fclose(fp);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500583 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500584 }
585
Andreas Dilger47a0c421997-05-16 02:46:07 -0500586 /* Allocate/initialize the image information data. REQUIRED */
Guy Schalnate5a37791996-06-05 15:50:50 -0500587 info_ptr = png_create_info_struct(png_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500588 if (info_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500589 {
590 fclose(fp);
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500591 png_destroy_write_struct(&png_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500592 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500593 }
594
Andreas Dilger47a0c421997-05-16 02:46:07 -0500595 /* Set error handling. REQUIRED if you aren't supplying your own
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600596 * error handling functions in the png_create_write_struct() call.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500597 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600598 if (setjmp(png_jmpbuf(png_ptr)))
Guy Schalnat0d580581995-07-20 02:43:20 -0500599 {
Guy Schalnat0d580581995-07-20 02:43:20 -0500600 /* If we get here, we had a problem reading the file */
Guy Schalnate5a37791996-06-05 15:50:50 -0500601 fclose(fp);
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -0500602 png_destroy_write_struct(&png_ptr, &info_ptr);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500603 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500604 }
605
Andreas Dilger47a0c421997-05-16 02:46:07 -0500606 /* One of the following I/O initialization functions is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600607#ifdef streams /* I/O initialization method 1 */
Guy Schalnat69b14481996-01-10 02:56:49 -0600608 /* set up the output control if you are using standard C streams */
Guy Schalnat0d580581995-07-20 02:43:20 -0500609 png_init_io(png_ptr, fp);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600610#else no_streams /* I/O initialization method 2 */
Glenn Randers-Pehrsona5fa5c92008-09-06 07:06:22 -0500611 /* If you are using replacement write functions, instead of calling
Andreas Dilger47a0c421997-05-16 02:46:07 -0500612 * png_init_io() here you would call */
613 png_set_write_fn(png_ptr, (void *)user_io_ptr, user_write_fn,
614 user_IO_flush_function);
615 /* where user_io_ptr is a structure you want available to the callbacks */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600616#endif no_streams /* only use one initialization method */
Guy Schalnat0d580581995-07-20 02:43:20 -0500617
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600618#ifdef hilevel
619 /* This is the easy way. Use it if you already have all the
620 * image info living info in the structure. You could "|" many
621 * PNG_TRANSFORM flags into the png_transforms integer here.
622 */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500623 png_write_png(png_ptr, info_ptr, png_transforms, NULL);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600624#else
625 /* This is the hard way */
626
Andreas Dilger47a0c421997-05-16 02:46:07 -0500627 /* Set the image information here. Width and height are up to 2^31,
628 * bit_depth is one of 1, 2, 4, 8, or 16, but valid values also depend on
629 * the color_type selected. color_type is one of PNG_COLOR_TYPE_GRAY,
630 * PNG_COLOR_TYPE_GRAY_ALPHA, PNG_COLOR_TYPE_PALETTE, PNG_COLOR_TYPE_RGB,
631 * or PNG_COLOR_TYPE_RGB_ALPHA. interlace is either PNG_INTERLACE_NONE or
632 * PNG_INTERLACE_ADAM7, and the compression_type and filter_type MUST
633 * currently be PNG_COMPRESSION_TYPE_BASE and PNG_FILTER_TYPE_BASE. REQUIRED
634 */
635 png_set_IHDR(png_ptr, info_ptr, width, height, bit_depth, PNG_COLOR_TYPE_???,
636 PNG_INTERLACE_????, PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
Guy Schalnat0d580581995-07-20 02:43:20 -0500637
Andreas Dilger47a0c421997-05-16 02:46:07 -0500638 /* set the palette if there is one. REQUIRED for indexed-color images */
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500639 palette = (png_colorp)png_malloc(png_ptr, PNG_MAX_PALETTE_LENGTH
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500640 * png_sizeof(png_color));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600641 /* ... set palette colors ... */
Glenn Randers-Pehrson76e5fd62000-12-28 07:50:05 -0600642 png_set_PLTE(png_ptr, info_ptr, palette, PNG_MAX_PALETTE_LENGTH);
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600643 /* You must not free palette here, because png_set_PLTE only makes a link to
644 the palette that you malloced. Wait until you are about to destroy
645 the png structure. */
Guy Schalnat0d580581995-07-20 02:43:20 -0500646
647 /* optional significant bit chunk */
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600648 /* if we are dealing with a grayscale image then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500649 sig_bit.gray = true_bit_depth;
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600650 /* otherwise, if we are dealing with a color image then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500651 sig_bit.red = true_red_bit_depth;
652 sig_bit.green = true_green_bit_depth;
653 sig_bit.blue = true_blue_bit_depth;
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600654 /* if the image has an alpha channel then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500655 sig_bit.alpha = true_alpha_bit_depth;
656 png_set_sBIT(png_ptr, info_ptr, sig_bit);
657
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600658
Andreas Dilger47a0c421997-05-16 02:46:07 -0500659 /* Optional gamma chunk is strongly suggested if you have any guess
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600660 * as to the correct gamma of the image.
661 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500662 png_set_gAMA(png_ptr, info_ptr, gamma);
Guy Schalnat0d580581995-07-20 02:43:20 -0500663
Andreas Dilger47a0c421997-05-16 02:46:07 -0500664 /* Optionally write comments into the image */
665 text_ptr[0].key = "Title";
666 text_ptr[0].text = "Mona Lisa";
667 text_ptr[0].compression = PNG_TEXT_COMPRESSION_NONE;
668 text_ptr[1].key = "Author";
669 text_ptr[1].text = "Leonardo DaVinci";
670 text_ptr[1].compression = PNG_TEXT_COMPRESSION_NONE;
671 text_ptr[2].key = "Description";
672 text_ptr[2].text = "<long text>";
673 text_ptr[2].compression = PNG_TEXT_COMPRESSION_zTXt;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600674#ifdef PNG_iTXt_SUPPORTED
675 text_ptr[0].lang = NULL;
676 text_ptr[1].lang = NULL;
677 text_ptr[2].lang = NULL;
678#endif
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500679 png_set_text(png_ptr, info_ptr, text_ptr, 3);
Guy Schalnat0d580581995-07-20 02:43:20 -0500680
Andreas Dilger47a0c421997-05-16 02:46:07 -0500681 /* other optional chunks like cHRM, bKGD, tRNS, tIME, oFFs, pHYs, */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600682 /* note that if sRGB is present the gAMA and cHRM chunks must be ignored
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600683 * on read and must be written in accordance with the sRGB profile */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500684
685 /* Write the file header information. REQUIRED */
Guy Schalnat0d580581995-07-20 02:43:20 -0500686 png_write_info(png_ptr, info_ptr);
687
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600688 /* If you want, you can write the info in two steps, in case you need to
689 * write your private chunk ahead of PLTE:
690 *
691 * png_write_info_before_PLTE(write_ptr, write_info_ptr);
692 * write_my_chunk();
693 * png_write_info(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600694 *
695 * However, given the level of known- and unknown-chunk support in 1.1.0
696 * and up, this should no longer be necessary.
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600697 */
698
Andreas Dilger47a0c421997-05-16 02:46:07 -0500699 /* Once we write out the header, the compression type on the text
700 * chunks gets changed to PNG_TEXT_COMPRESSION_NONE_WR or
701 * PNG_TEXT_COMPRESSION_zTXt_WR, so it doesn't get written out again
702 * at the end.
703 */
704
Guy Schalnat0d580581995-07-20 02:43:20 -0500705 /* set up the transformations you want. Note that these are
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600706 * all optional. Only call them if you want them.
707 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500708
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500709 /* invert monochrome pixels */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600710 png_set_invert_mono(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500711
Andreas Dilger47a0c421997-05-16 02:46:07 -0500712 /* Shift the pixels up to a legal bit depth and fill in
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600713 * as appropriate to correctly scale the image.
714 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500715 png_set_shift(png_ptr, &sig_bit);
Guy Schalnat0d580581995-07-20 02:43:20 -0500716
717 /* pack pixels into bytes */
718 png_set_packing(png_ptr);
719
Andreas Dilger47a0c421997-05-16 02:46:07 -0500720 /* swap location of alpha bytes from ARGB to RGBA */
721 png_set_swap_alpha(png_ptr);
722
723 /* Get rid of filler (OR ALPHA) bytes, pack XRGB/RGBX/ARGB/RGBA into
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600724 * RGB (4 channels -> 3 channels). The second parameter is not used.
725 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500726 png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
727
728 /* flip BGR pixels to RGB */
Guy Schalnat0d580581995-07-20 02:43:20 -0500729 png_set_bgr(png_ptr);
730
Andreas Dilger47a0c421997-05-16 02:46:07 -0500731 /* swap bytes of 16-bit files to most significant byte first */
Guy Schalnat0d580581995-07-20 02:43:20 -0500732 png_set_swap(png_ptr);
733
Andreas Dilger47a0c421997-05-16 02:46:07 -0500734 /* swap bits of 1, 2, 4 bit packed pixel formats */
735 png_set_packswap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500736
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500737 /* turn on interlace handling if you are not using png_write_image() */
Guy Schalnat0d580581995-07-20 02:43:20 -0500738 if (interlacing)
739 number_passes = png_set_interlace_handling(png_ptr);
740 else
741 number_passes = 1;
742
Andreas Dilger47a0c421997-05-16 02:46:07 -0500743 /* The easiest way to write the image (you may have a different memory
744 * layout, however, so choose what fits your needs best). You need to
745 * use the first method if you aren't handling interlacing yourself.
746 */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500747 png_uint_32 k, height, width;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600748 png_byte image[height][width*bytes_per_pixel];
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500749 png_bytep row_pointers[height];
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500750
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500751 if (height > PNG_UINT_32_MAX/png_sizeof(png_bytep))
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -0500752 png_error (png_ptr, "Image is too tall to process in memory");
753
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500754 for (k = 0; k < height; k++)
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600755 row_pointers[k] = image + k*width*bytes_per_pixel;
Guy Schalnate5a37791996-06-05 15:50:50 -0500756
Andreas Dilger47a0c421997-05-16 02:46:07 -0500757 /* One of the following output methods is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600758#ifdef entire /* write out the entire image data in one call */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500759 png_write_image(png_ptr, row_pointers);
760
761 /* the other way to write the image - deal with interlacing */
762
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600763#else no_entire /* write out the image data by one or more scanlines */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500764 /* The number of passes is either 1 for non-interlaced images,
765 * or 7 for interlaced images.
766 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500767 for (pass = 0; pass < number_passes; pass++)
768 {
769 /* Write a few rows at a time. */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500770 png_write_rows(png_ptr, &row_pointers[first_row], number_of_rows);
Guy Schalnat0d580581995-07-20 02:43:20 -0500771
772 /* If you are only writing one row at a time, this works */
773 for (y = 0; y < height; y++)
774 {
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500775 png_write_rows(png_ptr, &row_pointers[y], 1);
Guy Schalnat0d580581995-07-20 02:43:20 -0500776 }
777 }
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600778#endif no_entire /* use only one output method */
Guy Schalnat0d580581995-07-20 02:43:20 -0500779
Andreas Dilger47a0c421997-05-16 02:46:07 -0500780 /* You can write optional chunks like tEXt, zTXt, and tIME at the end
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600781 * as well. Shouldn't be necessary in 1.1.0 and up as all the public
782 * chunks are supported and you can use png_set_unknown_chunks() to
783 * register unknown chunks into the info structure to be written out.
Guy Schalnate5a37791996-06-05 15:50:50 -0500784 */
785
Andreas Dilger47a0c421997-05-16 02:46:07 -0500786 /* It is REQUIRED to call this to finish writing the rest of the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500787 png_write_end(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600788#endif hilevel
Guy Schalnat0d580581995-07-20 02:43:20 -0500789
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600790 /* If you png_malloced a palette, free it here (don't free info_ptr->palette,
791 as recommended in versions 1.0.5m and earlier of this example; if
792 libpng mallocs info_ptr->palette, libpng will free it). If you
793 allocated it with malloc() instead of png_malloc(), use free() instead
794 of png_free(). */
795 png_free(png_ptr, palette);
Glenn Randers-Pehrson895a9c92008-07-25 08:51:18 -0500796 palette = NULL;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600797
798 /* Similarly, if you png_malloced any data that you passed in with
799 png_set_something(), such as a hist or trans array, free it here,
800 when you can be sure that libpng is through with it. */
801 png_free(png_ptr, trans);
Glenn Randers-Pehrson895a9c92008-07-25 08:51:18 -0500802 trans = NULL;
Guy Schalnat0d580581995-07-20 02:43:20 -0500803
Guy Schalnate5a37791996-06-05 15:50:50 -0500804 /* clean up after the write, and free any memory allocated */
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -0500805 png_destroy_write_struct(&png_ptr, &info_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500806
807 /* close the file */
808 fclose(fp);
809
810 /* that's it */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500811 return (OK);
Guy Schalnat0d580581995-07-20 02:43:20 -0500812}
813
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -0500814#endif /* if 0 */