blob: 1e953c84e23d567100ebde31006c3928c6a2dc99 [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
Guy Schalnat0d580581995-07-20 02:43:20 -05004/* example.c - an example of using libpng */
5
Andreas Dilger47a0c421997-05-16 02:46:07 -05006/* This is an example of how to use libpng to read and write PNG files.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06007 * The file libpng.txt is much more verbose then this. If you have not
8 * read it, do so first. This was designed to be a starting point of an
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -06009 * implementation. This is not officially part of libpng, is hereby placed
10 * in the public domain, and therefore does not require a copyright notice.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060011 *
12 * This file does not currently compile, because it is missing certain
13 * parts, like allocating memory to hold an image. You will have to
14 * supply these parts to get it to compile. For an example of a minimal
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060015 * working PNG reader/writer, see pngtest.c, included in this distribution;
16 * see also the programs in the contrib directory.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060017 */
Guy Schalnat0d580581995-07-20 02:43:20 -050018
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -060019#include "png.h"
Guy Schalnat0d580581995-07-20 02:43:20 -050020
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060021 /* The png_jmpbuf() macro, used in error handling, became available in
22 * libpng version 1.0.6. If you want to be able to run your code with older
23 * versions of libpng, you must define the macro yourself (but only if it
24 * is not already defined by libpng!).
25 */
26
27#ifndef png_jmpbuf
28# define png_jmpbuf(png_ptr) ((png_ptr)->jmpbuf)
29#endif
30
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -060031/* Check to see if a file is a PNG file using png_sig_cmp(). png_sig_cmp()
32 * returns zero if the image is a PNG and nonzero if it isn't a PNG.
33 *
34 * The function check_if_png() shown here, but not used, returns nonzero (true)
35 * if the file can be opened and is a PNG, 0 (false) otherwise.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060036 *
37 * If this call is successful, and you are going to keep the file open,
38 * you should call png_set_sig_bytes(png_ptr, PNG_BYTES_TO_CHECK); once
39 * you have created the png_ptr, so that libpng knows your application
40 * has read that many bytes from the start of the file. Make sure you
41 * don't call png_set_sig_bytes() with more than 8 bytes read or give it
42 * an incorrect number of bytes read, or you will either have read too
43 * many bytes (your fault), or you are telling libpng to read the wrong
44 * number of magic bytes (also your fault).
45 *
46 * Many applications already read the first 2 or 4 bytes from the start
47 * of the image to determine the file type, so it would be easiest just
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -060048 * to pass the bytes to png_sig_cmp() or even skip that if you know
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060049 * you have a PNG file, and call png_set_sig_bytes().
50 */
Andreas Dilger47a0c421997-05-16 02:46:07 -050051#define PNG_BYTES_TO_CHECK 4
52int check_if_png(char *file_name, FILE **fp)
Guy Schalnat0d580581995-07-20 02:43:20 -050053{
Andreas Dilger47a0c421997-05-16 02:46:07 -050054 char buf[PNG_BYTES_TO_CHECK];
Guy Schalnat0d580581995-07-20 02:43:20 -050055
Andreas Dilger47a0c421997-05-16 02:46:07 -050056 /* Open the prospective PNG file. */
Glenn Randers-Pehrson68ea2432000-04-01 21:10:05 -060057 if ((*fp = fopen(file_name, "rb")) == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -050058 return 0;
59
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -060060 /* Read in some of the signature bytes */
Andreas Dilger47a0c421997-05-16 02:46:07 -050061 if (fread(buf, 1, PNG_BYTES_TO_CHECK, *fp) != PNG_BYTES_TO_CHECK)
62 return 0;
Guy Schalnat0d580581995-07-20 02:43:20 -050063
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -060064 /* Compare the first PNG_BYTES_TO_CHECK bytes of the signature.
65 Return nonzero (true) if they match */
66
67 return(!png_sig_cmp(buf, (png_size_t)0, PNG_BYTES_TO_CHECK));
Guy Schalnat0d580581995-07-20 02:43:20 -050068}
69
Andreas Dilger47a0c421997-05-16 02:46:07 -050070/* Read a PNG file. You may want to return an error code if the read
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060071 * fails (depending upon the failure). There are two "prototypes" given
72 * here - one where we are given the filename, and we need to open the
73 * file, and the other where we are given an open file (possibly with
74 * some or all of the magic bytes read - see comments above).
75 */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -060076#ifdef open_file /* prototype 1 */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060077void read_png(char *file_name) /* We need to open the file */
Guy Schalnat0d580581995-07-20 02:43:20 -050078{
Guy Schalnatb2e01bd1996-01-26 01:38:47 -060079 png_structp png_ptr;
Guy Schalnat6d764711995-12-19 03:22:19 -060080 png_infop info_ptr;
Andreas Dilger47a0c421997-05-16 02:46:07 -050081 unsigned int sig_read = 0;
82 png_uint_32 width, height;
83 int bit_depth, color_type, interlace_type;
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060084 FILE *fp;
Guy Schalnat0d580581995-07-20 02:43:20 -050085
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060086 if ((fp = fopen(file_name, "rb")) == NULL)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -050087 return (ERROR);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -060088#else no_open_file /* prototype 2 */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060089void read_png(FILE *fp, unsigned int sig_read) /* file is already open */
90{
91 png_structp png_ptr;
92 png_infop info_ptr;
Andreas Dilger47a0c421997-05-16 02:46:07 -050093 png_uint_32 width, height;
94 int bit_depth, color_type, interlace_type;
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -060095#endif no_open_file /* only use one prototype! */
Guy Schalnat0d580581995-07-20 02:43:20 -050096
Guy Schalnate5a37791996-06-05 15:50:50 -050097 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -050098 * functions. If you want to use the default stderr and longjump method,
99 * you can supply NULL for the last three parameters. We also supply the
100 * the compiler header file version, so that we know if the application
101 * was compiled with a compatible version of the library. REQUIRED
102 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500103 png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500104 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500105
Andreas Dilger47a0c421997-05-16 02:46:07 -0500106 if (png_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500107 {
108 fclose(fp);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500109 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500110 }
111
Andreas Dilger47a0c421997-05-16 02:46:07 -0500112 /* Allocate/initialize the memory for image information. REQUIRED. */
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -0600113 info_ptr = png_create_info_struct(png_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500114 if (info_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500115 {
116 fclose(fp);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500117 png_destroy_read_struct(&png_ptr, (png_infopp)NULL, (png_infopp)NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500118 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500119 }
120
Andreas Dilger47a0c421997-05-16 02:46:07 -0500121 /* Set error handling if you are using the setjmp/longjmp method (this is
122 * the normal method of doing things with libpng). REQUIRED unless you
123 * set up your own error handlers in the png_create_read_struct() earlier.
124 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600125
126 if (setjmp(png_jmpbuf(png_ptr)))
Guy Schalnat0d580581995-07-20 02:43:20 -0500127 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500128 /* Free all of the memory associated with the png_ptr and info_ptr */
129 png_destroy_read_struct(&png_ptr, &info_ptr, (png_infopp)NULL);
Guy Schalnat0d580581995-07-20 02:43:20 -0500130 fclose(fp);
Guy Schalnat0d580581995-07-20 02:43:20 -0500131 /* If we get here, we had a problem reading the file */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500132 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500133 }
134
Andreas Dilger47a0c421997-05-16 02:46:07 -0500135 /* One of the following I/O initialization methods is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600136#ifdef streams /* PNG file I/O method 1 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500137 /* Set up the input control if you are using standard C streams */
Guy Schalnat0d580581995-07-20 02:43:20 -0500138 png_init_io(png_ptr, fp);
139
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600140#else no_streams /* PNG file I/O method 2 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500141 /* If you are using replacement read functions, instead of calling
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600142 * png_init_io() here you would call:
143 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500144 png_set_read_fn(png_ptr, (void *)user_io_ptr, user_read_fn);
145 /* where user_io_ptr is a structure you want available to the callbacks */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600146#endif no_streams /* Use only one I/O method! */
Guy Schalnat69b14481996-01-10 02:56:49 -0600147
Andreas Dilger47a0c421997-05-16 02:46:07 -0500148 /* If we have already read some of the signature */
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -0600149 png_set_sig_bytes(png_ptr, sig_read);
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600150
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600151#ifdef hilevel
152 /*
153 * If you have enough memory to read in the entire image at once,
154 * and you need to specify only transforms that can be controlled
155 * with one of the PNG_TRANSFORM_* bits (this presently excludes
156 * dithering, filling, setting background, and doing gamma
157 * adjustment), then you can read the entire image (including
158 * pixels) into the info structure with this call:
159 */
160 png_read_png(png_ptr, info_ptr, png_transforms, NULL);
161#else
162 /* OK, you're doing it the hard way, with the lower-level functions */
163
Andreas Dilger47a0c421997-05-16 02:46:07 -0500164 /* The call to png_read_info() gives us all of the information from the
165 * PNG file before the first IDAT (image data chunk). REQUIRED
166 */
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600167 png_read_info(png_ptr, info_ptr);
Guy Schalnat69b14481996-01-10 02:56:49 -0600168
Andreas Dilger47a0c421997-05-16 02:46:07 -0500169 png_get_IHDR(png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
170 &interlace_type, NULL, NULL);
171
172/**** Set up the data transformations you want. Note that these are all
173 **** optional. Only call them if you want/need them. Many of the
174 **** transformations only work on specific types of images, and many
175 **** are mutually exclusive.
176 ****/
177
178 /* tell libpng to strip 16 bit/color files down to 8 bits/color */
179 png_set_strip_16(png_ptr);
180
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500181 /* Strip alpha bytes from the input data without combining with the
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600182 * background (not recommended).
183 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500184 png_set_strip_alpha(png_ptr);
185
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600186 /* Extract multiple pixels with bit depths of 1, 2, and 4 from a single
Andreas Dilger47a0c421997-05-16 02:46:07 -0500187 * byte into separate bytes (useful for paletted and grayscale images).
188 */
189 png_set_packing(png_ptr);
190
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600191 /* Change the order of packed pixels to least significant bit first
Andreas Dilger47a0c421997-05-16 02:46:07 -0500192 * (not useful if you are using png_set_packing). */
193 png_set_packswap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500194
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600195 /* Expand paletted colors into true RGB triplets */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500196 if (color_type == PNG_COLOR_TYPE_PALETTE)
Guy Schalnat0d580581995-07-20 02:43:20 -0500197 png_set_expand(png_ptr);
198
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600199 /* Expand grayscale images to the full 8 bits from 1, 2, or 4 bits/pixel */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500200 if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8)
Guy Schalnat0d580581995-07-20 02:43:20 -0500201 png_set_expand(png_ptr);
202
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600203 /* Expand paletted or RGB images with transparency to full alpha channels
204 * so the data will be available as RGBA quartets.
205 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500206 if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS))
Guy Schalnat0d580581995-07-20 02:43:20 -0500207 png_set_expand(png_ptr);
208
Andreas Dilger47a0c421997-05-16 02:46:07 -0500209 /* Set the background color to draw transparent and alpha images over.
210 * It is possible to set the red, green, and blue components directly
211 * for paletted images instead of supplying a palette index. Note that
212 * even if the PNG file supplies a background, you are not required to
213 * use it - you should use the (solid) application background if it has one.
214 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500215
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600216 png_color_16 my_background, *image_background;
Guy Schalnat0d580581995-07-20 02:43:20 -0500217
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600218 if (png_get_bKGD(png_ptr, info_ptr, &image_background))
219 png_set_background(png_ptr, image_background,
Guy Schalnate5a37791996-06-05 15:50:50 -0500220 PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600221 else
222 png_set_background(png_ptr, &my_background,
Guy Schalnate5a37791996-06-05 15:50:50 -0500223 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
Guy Schalnat0d580581995-07-20 02:43:20 -0500224
Andreas Dilger47a0c421997-05-16 02:46:07 -0500225 /* Some suggestions as to how to get a screen gamma value */
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600226
Glenn Randers-Pehrsonbcfd15d1999-10-01 14:22:25 -0500227 /* Note that screen gamma is the display_exponent, which includes
228 * the CRT_exponent and any correction for viewing conditions */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500229 if (/* We have a user-defined screen gamma value */)
230 {
231 screen_gamma = user-defined screen_gamma;
232 }
233 /* This is one way that applications share the same screen gamma value */
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600234 else if ((gamma_str = getenv("SCREEN_GAMMA")) != NULL)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500235 {
236 screen_gamma = atof(gamma_str);
237 }
238 /* If we don't have another value */
239 else
240 {
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600241 screen_gamma = 2.2; /* A good guess for a PC monitors in a dimly
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600242 lit room */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500243 screen_gamma = 1.7 or 1.0; /* A good guess for Mac systems */
244 }
245
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600246 /* Tell libpng to handle the gamma conversion for you. The final call
Andreas Dilger47a0c421997-05-16 02:46:07 -0500247 * is a good guess for PC generated images, but it should be configurable
248 * by the user at run time by the user. It is strongly suggested that
249 * your application support gamma correction.
250 */
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600251
252 int intent;
253
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600254 if (png_get_sRGB(png_ptr, info_ptr, &intent))
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600255 png_set_gamma(png_ptr, screen_gamma, 0.45455);
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600256 else
257 {
258 double image_gamma;
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600259 if (png_get_gAMA(png_ptr, info_ptr, &image_gamma))
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600260 png_set_gamma(png_ptr, screen_gamma, image_gamma);
261 else
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600262 png_set_gamma(png_ptr, screen_gamma, 0.45455);
263 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500264
Andreas Dilger47a0c421997-05-16 02:46:07 -0500265 /* Dither RGB files down to 8 bit palette or reduce palettes
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600266 * to the number of colors available on your screen.
267 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500268 if (color_type & PNG_COLOR_MASK_COLOR)
Guy Schalnat0d580581995-07-20 02:43:20 -0500269 {
Glenn Randers-Pehrsonf05f8032000-12-23 14:27:39 -0600270 int num_palette;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500271 png_colorp palette;
272
273 /* This reduces the image to the application supplied palette */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600274 if (/* we have our own palette */)
Guy Schalnat0d580581995-07-20 02:43:20 -0500275 {
Andreas Dilger47a0c421997-05-16 02:46:07 -0500276 /* An array of colors to which the image should be dithered */
277 png_color std_color_cube[MAX_SCREEN_COLORS];
Guy Schalnat0d580581995-07-20 02:43:20 -0500278
279 png_set_dither(png_ptr, std_color_cube, MAX_SCREEN_COLORS,
Andreas Dilger47a0c421997-05-16 02:46:07 -0500280 MAX_SCREEN_COLORS, NULL, 0);
281 }
282 /* This reduces the image to the palette supplied in the file */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600283 else if (png_get_PLTE(png_ptr, info_ptr, &palette, &num_palette))
Andreas Dilger47a0c421997-05-16 02:46:07 -0500284 {
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500285 png_uint_16p histogram;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500286
287 png_get_hIST(png_ptr, info_ptr, &histogram);
288
289 png_set_dither(png_ptr, palette, num_palette,
290 max_screen_colors, histogram, 0);
Guy Schalnat0d580581995-07-20 02:43:20 -0500291 }
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600292 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500293
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500294 /* invert monochrome files to have 0 as white and 1 as black */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600295 png_set_invert_mono(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500296
Andreas Dilger47a0c421997-05-16 02:46:07 -0500297 /* If you want to shift the pixel values from the range [0,255] or
298 * [0,65535] to the original [0,7] or [0,31], or whatever range the
299 * colors were originally in:
300 */
301 if (png_get_valid(png_ptr, info_ptr, PNG_INFO_sBIT))
302 {
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600303 png_color_8p sig_bit;
Guy Schalnat0d580581995-07-20 02:43:20 -0500304
Andreas Dilger47a0c421997-05-16 02:46:07 -0500305 png_get_sBIT(png_ptr, info_ptr, &sig_bit);
306 png_set_shift(png_ptr, sig_bit);
307 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500308
Andreas Dilger47a0c421997-05-16 02:46:07 -0500309 /* flip the RGB pixels to BGR (or RGBA to BGRA) */
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -0500310 if (color_type & PNG_COLOR_MASK_COLOR)
311 png_set_bgr(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500312
Andreas Dilger47a0c421997-05-16 02:46:07 -0500313 /* swap the RGBA or GA data to ARGB or AG (or BGRA to ABGR) */
314 png_set_swap_alpha(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500315
Andreas Dilger47a0c421997-05-16 02:46:07 -0500316 /* swap bytes of 16 bit files to least significant byte first */
317 png_set_swap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500318
Andreas Dilger47a0c421997-05-16 02:46:07 -0500319 /* Add filler (or alpha) byte (before/after each RGB triplet) */
320 png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER);
321
322 /* Turn on interlace handling. REQUIRED if you are not using
323 * png_read_image(). To see how to handle interlacing passes,
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600324 * see the png_read_row() method below:
Andreas Dilger47a0c421997-05-16 02:46:07 -0500325 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500326 number_passes = png_set_interlace_handling(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500327
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600328 /* Optional call to gamma correct and add the background to the palette
Andreas Dilger47a0c421997-05-16 02:46:07 -0500329 * and update info structure. REQUIRED if you are expecting libpng to
330 * update the palette for you (ie you selected such a transform above).
331 */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500332 png_read_update_info(png_ptr, info_ptr);
333
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600334 /* Allocate the memory to hold the image using the fields of info_ptr. */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500335
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600336 /* The easiest way to read the image: */
Guy Schalnat6d764711995-12-19 03:22:19 -0600337 png_bytep row_pointers[height];
Guy Schalnate5a37791996-06-05 15:50:50 -0500338
339 for (row = 0; row < height; row++)
340 {
Andreas Dilger47a0c421997-05-16 02:46:07 -0500341 row_pointers[row] = malloc(png_get_rowbytes(png_ptr, info_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -0500342 }
343
Andreas Dilger47a0c421997-05-16 02:46:07 -0500344 /* Now it's time to read the image. One of these methods is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600345#ifdef entire /* Read the entire image in one go */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500346 png_read_image(png_ptr, row_pointers);
347
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600348#else no_entire /* Read the image one or more scanlines at a time */
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600349 /* The other way to read images - deal with interlacing: */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500350
Guy Schalnat0d580581995-07-20 02:43:20 -0500351 for (pass = 0; pass < number_passes; pass++)
352 {
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600353#ifdef single /* Read the image a single row at a time */
Guy Schalnat0d580581995-07-20 02:43:20 -0500354 for (y = 0; y < height; y++)
355 {
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500356 png_read_rows(png_ptr, &row_pointers[y], NULL, 1);
Guy Schalnat0d580581995-07-20 02:43:20 -0500357 }
358
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600359#else no_single /* Read the image several rows at a time */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500360 for (y = 0; y < height; y += number_of_rows)
361 {
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600362#ifdef sparkle /* Read the image using the "sparkle" effect. */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500363 png_read_rows(png_ptr, &row_pointers[y], NULL, number_of_rows);
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600364
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500365 png_read_rows(png_ptr, NULL, row_pointers[y], number_of_rows);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600366#else no_sparkle /* Read the image using the "rectangle" effect */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500367 png_read_rows(png_ptr, NULL, &row_pointers[y], number_of_rows);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600368#endif no_sparkle /* use only one of these two methods */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500369 }
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600370
Guy Schalnat0d580581995-07-20 02:43:20 -0500371 /* if you want to display the image after every pass, do
372 so here */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600373#endif no_single /* use only one of these two methods */
Guy Schalnat0d580581995-07-20 02:43:20 -0500374 }
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600375#endif no_entire /* use only one of these two methods */
Guy Schalnat0d580581995-07-20 02:43:20 -0500376
Andreas Dilger47a0c421997-05-16 02:46:07 -0500377 /* read rest of file, and get additional chunks in info_ptr - REQUIRED */
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600378 png_read_end(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600379#endif hilevel
380
381 /* At this point you have read the entire image */
Guy Schalnat0d580581995-07-20 02:43:20 -0500382
Andreas Dilger47a0c421997-05-16 02:46:07 -0500383 /* clean up after the read, and free any memory allocated - REQUIRED */
Guy Schalnate5a37791996-06-05 15:50:50 -0500384 png_destroy_read_struct(&png_ptr, &info_ptr, (png_infopp)NULL);
Guy Schalnat0d580581995-07-20 02:43:20 -0500385
386 /* close the file */
387 fclose(fp);
388
389 /* that's it */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500390 return (OK);
Guy Schalnat0d580581995-07-20 02:43:20 -0500391}
392
Guy Schalnat6d764711995-12-19 03:22:19 -0600393/* progressively read a file */
394
Guy Schalnat6d764711995-12-19 03:22:19 -0600395int
Guy Schalnate5a37791996-06-05 15:50:50 -0500396initialize_png_reader(png_structp *png_ptr, png_infop *info_ptr)
Guy Schalnat6d764711995-12-19 03:22:19 -0600397{
Guy Schalnate5a37791996-06-05 15:50:50 -0500398 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500399 * functions. If you want to use the default stderr and longjump method,
400 * you can supply NULL for the last three parameters. We also check that
401 * the library version is compatible in case we are using dynamically
402 * linked libraries.
Guy Schalnate5a37791996-06-05 15:50:50 -0500403 */
404 *png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500405 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500406
Andreas Dilger47a0c421997-05-16 02:46:07 -0500407 if (*png_ptr == NULL)
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600408 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500409 *info_ptr = NULL;
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500410 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600411 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600412
Guy Schalnate5a37791996-06-05 15:50:50 -0500413 *info_ptr = png_create_info_struct(png_ptr);
414
Andreas Dilger47a0c421997-05-16 02:46:07 -0500415 if (*info_ptr == NULL)
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600416 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500417 png_destroy_read_struct(png_ptr, info_ptr, (png_infopp)NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500418 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600419 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600420
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600421 if (setjmp(png_jmpbuf((*png_ptr))))
Guy Schalnate5a37791996-06-05 15:50:50 -0500422 {
423 png_destroy_read_struct(png_ptr, info_ptr, (png_infopp)NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500424 return (ERROR);
Guy Schalnate5a37791996-06-05 15:50:50 -0500425 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600426
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600427 /* This one's new. You will need to provide all three
Andreas Dilger47a0c421997-05-16 02:46:07 -0500428 * function callbacks, even if you aren't using them all.
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600429 * If you aren't using all functions, you can specify NULL
430 * parameters. Even when all three functions are NULL,
431 * you need to call png_set_progressive_read_fn().
Andreas Dilger47a0c421997-05-16 02:46:07 -0500432 * These functions shouldn't be dependent on global or
433 * static variables if you are decoding several images
434 * simultaneously. You should store stream specific data
435 * in a separate struct, given as the second parameter,
436 * and retrieve the pointer from inside the callbacks using
437 * the function png_get_progressive_ptr(png_ptr).
438 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500439 png_set_progressive_read_fn(*png_ptr, (void *)stream_data,
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600440 info_callback, row_callback, end_callback);
Guy Schalnat6d764711995-12-19 03:22:19 -0600441
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500442 return (OK);
Guy Schalnat6d764711995-12-19 03:22:19 -0600443}
444
445int
Guy Schalnate5a37791996-06-05 15:50:50 -0500446process_data(png_structp *png_ptr, png_infop *info_ptr,
447 png_bytep buffer, png_uint_32 length)
Guy Schalnat6d764711995-12-19 03:22:19 -0600448{
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600449 if (setjmp(png_jmpbuf((*png_ptr))))
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600450 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500451 /* Free the png_ptr and info_ptr memory on error */
452 png_destroy_read_struct(png_ptr, info_ptr, (png_infopp)NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500453 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600454 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600455
Andreas Dilger47a0c421997-05-16 02:46:07 -0500456 /* This one's new also. Simply give it chunks of data as
457 * they arrive from the data stream (in order, of course).
458 * On Segmented machines, don't give it any more than 64K.
459 * The library seems to run fine with sizes of 4K, although
460 * you can give it much less if necessary (I assume you can
461 * give it chunks of 1 byte, but I haven't tried with less
462 * than 256 bytes yet). When this function returns, you may
463 * want to display any rows that were generated in the row
464 * callback, if you aren't already displaying them there.
465 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500466 png_process_data(*png_ptr, *info_ptr, buffer, length);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500467 return (OK);
Guy Schalnat6d764711995-12-19 03:22:19 -0600468}
469
470info_callback(png_structp png_ptr, png_infop info)
471{
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600472/* do any setup here, including setting any of the transformations
Andreas Dilger47a0c421997-05-16 02:46:07 -0500473 * mentioned in the Reading PNG files section. For now, you _must_
474 * call either png_start_read_image() or png_read_update_info()
475 * after all the transformations are set (even if you don't set
476 * any). You may start getting rows before png_process_data()
477 * returns, so this is your last chance to prepare for that.
478 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600479}
480
481row_callback(png_structp png_ptr, png_bytep new_row,
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600482 png_uint_32 row_num, int pass)
Guy Schalnat6d764711995-12-19 03:22:19 -0600483{
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600484/* this function is called for every row in the image. If the
Andreas Dilger47a0c421997-05-16 02:46:07 -0500485 * image is interlacing, and you turned on the interlace handler,
486 * this function will be called for every row in every pass.
487 * Some of these rows will not be changed from the previous pass.
488 * When the row is not changed, the new_row variable will be NULL.
489 * The rows and passes are called in order, so you don't really
490 * need the row_num and pass, but I'm supplying them because it
491 * may make your life easier.
492 *
493 * For the non-NULL rows of interlaced images, you must call
494 * png_progressive_combine_row() passing in the row and the
495 * old row. You can call this function for NULL rows (it will
496 * just return) and for non-interlaced images (it just does the
497 * memcpy for you) if it will make the code easier. Thus, you
498 * can just do this for all cases:
499 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600500
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600501 png_progressive_combine_row(png_ptr, old_row, new_row);
Guy Schalnat6d764711995-12-19 03:22:19 -0600502
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600503/* where old_row is what was displayed for previous rows. Note
Andreas Dilger47a0c421997-05-16 02:46:07 -0500504 * that the first pass (pass == 0 really) will completely cover
505 * the old row, so the rows do not have to be initialized. After
506 * the first pass (and only for interlaced images), you will have
507 * to pass the current row, and the function will combine the
508 * old row and the new row.
509 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600510}
511
512end_callback(png_structp png_ptr, png_infop info)
513{
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600514/* this function is called when the whole image has been read,
Andreas Dilger47a0c421997-05-16 02:46:07 -0500515 * including any chunks after the image (up to and including
516 * the IEND). You will usually have the same info chunk as you
517 * had in the header, although some data may have been added
518 * to the comments and time fields.
519 *
520 * Most people won't do much here, perhaps setting a flag that
521 * marks the image as finished.
522 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600523}
524
Guy Schalnat0d580581995-07-20 02:43:20 -0500525/* write a png file */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600526void write_png(char *file_name /* , ... other image information ... */)
Guy Schalnat0d580581995-07-20 02:43:20 -0500527{
528 FILE *fp;
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600529 png_structp png_ptr;
530 png_infop info_ptr;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600531 png_colorp palette;
Guy Schalnat0d580581995-07-20 02:43:20 -0500532
533 /* open the file */
534 fp = fopen(file_name, "wb");
Andreas Dilger47a0c421997-05-16 02:46:07 -0500535 if (fp == NULL)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500536 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500537
Guy Schalnate5a37791996-06-05 15:50:50 -0500538 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500539 * functions. If you want to use the default stderr and longjump method,
540 * you can supply NULL for the last three parameters. We also check that
541 * the library version is compatible with the one used at compile time,
542 * in case we are using dynamically linked libraries. REQUIRED.
Guy Schalnate5a37791996-06-05 15:50:50 -0500543 */
544 png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500545 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500546
Andreas Dilger47a0c421997-05-16 02:46:07 -0500547 if (png_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500548 {
549 fclose(fp);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500550 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500551 }
552
Andreas Dilger47a0c421997-05-16 02:46:07 -0500553 /* Allocate/initialize the image information data. REQUIRED */
Guy Schalnate5a37791996-06-05 15:50:50 -0500554 info_ptr = png_create_info_struct(png_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500555 if (info_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500556 {
557 fclose(fp);
Guy Schalnate5a37791996-06-05 15:50:50 -0500558 png_destroy_write_struct(&png_ptr, (png_infopp)NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500559 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500560 }
561
Andreas Dilger47a0c421997-05-16 02:46:07 -0500562 /* Set error handling. REQUIRED if you aren't supplying your own
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600563 * error handling functions in the png_create_write_struct() call.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500564 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600565 if (setjmp(png_jmpbuf(png_ptr)))
Guy Schalnat0d580581995-07-20 02:43:20 -0500566 {
Guy Schalnat0d580581995-07-20 02:43:20 -0500567 /* If we get here, we had a problem reading the file */
Guy Schalnate5a37791996-06-05 15:50:50 -0500568 fclose(fp);
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -0500569 png_destroy_write_struct(&png_ptr, &info_ptr);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500570 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500571 }
572
Andreas Dilger47a0c421997-05-16 02:46:07 -0500573 /* One of the following I/O initialization functions is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600574#ifdef streams /* I/O initialization method 1 */
Guy Schalnat69b14481996-01-10 02:56:49 -0600575 /* set up the output control if you are using standard C streams */
Guy Schalnat0d580581995-07-20 02:43:20 -0500576 png_init_io(png_ptr, fp);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600577#else no_streams /* I/O initialization method 2 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500578 /* If you are using replacement read functions, instead of calling
579 * png_init_io() here you would call */
580 png_set_write_fn(png_ptr, (void *)user_io_ptr, user_write_fn,
581 user_IO_flush_function);
582 /* where user_io_ptr is a structure you want available to the callbacks */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600583#endif no_streams /* only use one initialization method */
Guy Schalnat0d580581995-07-20 02:43:20 -0500584
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600585#ifdef hilevel
586 /* This is the easy way. Use it if you already have all the
587 * image info living info in the structure. You could "|" many
588 * PNG_TRANSFORM flags into the png_transforms integer here.
589 */
590 png_write_png(png_ptr, info_ptr, png_transforms, NULL);
591#else
592 /* This is the hard way */
593
Andreas Dilger47a0c421997-05-16 02:46:07 -0500594 /* Set the image information here. Width and height are up to 2^31,
595 * bit_depth is one of 1, 2, 4, 8, or 16, but valid values also depend on
596 * the color_type selected. color_type is one of PNG_COLOR_TYPE_GRAY,
597 * PNG_COLOR_TYPE_GRAY_ALPHA, PNG_COLOR_TYPE_PALETTE, PNG_COLOR_TYPE_RGB,
598 * or PNG_COLOR_TYPE_RGB_ALPHA. interlace is either PNG_INTERLACE_NONE or
599 * PNG_INTERLACE_ADAM7, and the compression_type and filter_type MUST
600 * currently be PNG_COMPRESSION_TYPE_BASE and PNG_FILTER_TYPE_BASE. REQUIRED
601 */
602 png_set_IHDR(png_ptr, info_ptr, width, height, bit_depth, PNG_COLOR_TYPE_???,
603 PNG_INTERLACE_????, PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
Guy Schalnat0d580581995-07-20 02:43:20 -0500604
Andreas Dilger47a0c421997-05-16 02:46:07 -0500605 /* set the palette if there is one. REQUIRED for indexed-color images */
Glenn Randers-Pehrson76e5fd62000-12-28 07:50:05 -0600606 palette = (png_colorp)png_malloc(png_ptr, PNG_MAX_PALETTE_LENGTH * sizeof (png_color));
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600607 /* ... set palette colors ... */
Glenn Randers-Pehrson76e5fd62000-12-28 07:50:05 -0600608 png_set_PLTE(png_ptr, info_ptr, palette, PNG_MAX_PALETTE_LENGTH);
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600609 /* You must not free palette here, because png_set_PLTE only makes a link to
610 the palette that you malloced. Wait until you are about to destroy
611 the png structure. */
Guy Schalnat0d580581995-07-20 02:43:20 -0500612
613 /* optional significant bit chunk */
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600614 /* if we are dealing with a grayscale image then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500615 sig_bit.gray = true_bit_depth;
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600616 /* otherwise, if we are dealing with a color image then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500617 sig_bit.red = true_red_bit_depth;
618 sig_bit.green = true_green_bit_depth;
619 sig_bit.blue = true_blue_bit_depth;
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600620 /* if the image has an alpha channel then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500621 sig_bit.alpha = true_alpha_bit_depth;
622 png_set_sBIT(png_ptr, info_ptr, sig_bit);
623
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600624
Andreas Dilger47a0c421997-05-16 02:46:07 -0500625 /* Optional gamma chunk is strongly suggested if you have any guess
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600626 * as to the correct gamma of the image.
627 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500628 png_set_gAMA(png_ptr, info_ptr, gamma);
Guy Schalnat0d580581995-07-20 02:43:20 -0500629
Andreas Dilger47a0c421997-05-16 02:46:07 -0500630 /* Optionally write comments into the image */
631 text_ptr[0].key = "Title";
632 text_ptr[0].text = "Mona Lisa";
633 text_ptr[0].compression = PNG_TEXT_COMPRESSION_NONE;
634 text_ptr[1].key = "Author";
635 text_ptr[1].text = "Leonardo DaVinci";
636 text_ptr[1].compression = PNG_TEXT_COMPRESSION_NONE;
637 text_ptr[2].key = "Description";
638 text_ptr[2].text = "<long text>";
639 text_ptr[2].compression = PNG_TEXT_COMPRESSION_zTXt;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600640#ifdef PNG_iTXt_SUPPORTED
641 text_ptr[0].lang = NULL;
642 text_ptr[1].lang = NULL;
643 text_ptr[2].lang = NULL;
644#endif
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500645 png_set_text(png_ptr, info_ptr, text_ptr, 3);
Guy Schalnat0d580581995-07-20 02:43:20 -0500646
Andreas Dilger47a0c421997-05-16 02:46:07 -0500647 /* other optional chunks like cHRM, bKGD, tRNS, tIME, oFFs, pHYs, */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600648 /* note that if sRGB is present the gAMA and cHRM chunks must be ignored
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600649 * on read and must be written in accordance with the sRGB profile */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500650
651 /* Write the file header information. REQUIRED */
Guy Schalnat0d580581995-07-20 02:43:20 -0500652 png_write_info(png_ptr, info_ptr);
653
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600654 /* If you want, you can write the info in two steps, in case you need to
655 * write your private chunk ahead of PLTE:
656 *
657 * png_write_info_before_PLTE(write_ptr, write_info_ptr);
658 * write_my_chunk();
659 * png_write_info(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600660 *
661 * However, given the level of known- and unknown-chunk support in 1.1.0
662 * and up, this should no longer be necessary.
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600663 */
664
Andreas Dilger47a0c421997-05-16 02:46:07 -0500665 /* Once we write out the header, the compression type on the text
666 * chunks gets changed to PNG_TEXT_COMPRESSION_NONE_WR or
667 * PNG_TEXT_COMPRESSION_zTXt_WR, so it doesn't get written out again
668 * at the end.
669 */
670
Guy Schalnat0d580581995-07-20 02:43:20 -0500671 /* set up the transformations you want. Note that these are
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600672 * all optional. Only call them if you want them.
673 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500674
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500675 /* invert monochrome pixels */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600676 png_set_invert_mono(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500677
Andreas Dilger47a0c421997-05-16 02:46:07 -0500678 /* Shift the pixels up to a legal bit depth and fill in
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600679 * as appropriate to correctly scale the image.
680 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500681 png_set_shift(png_ptr, &sig_bit);
Guy Schalnat0d580581995-07-20 02:43:20 -0500682
683 /* pack pixels into bytes */
684 png_set_packing(png_ptr);
685
Andreas Dilger47a0c421997-05-16 02:46:07 -0500686 /* swap location of alpha bytes from ARGB to RGBA */
687 png_set_swap_alpha(png_ptr);
688
689 /* Get rid of filler (OR ALPHA) bytes, pack XRGB/RGBX/ARGB/RGBA into
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600690 * RGB (4 channels -> 3 channels). The second parameter is not used.
691 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500692 png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
693
694 /* flip BGR pixels to RGB */
Guy Schalnat0d580581995-07-20 02:43:20 -0500695 png_set_bgr(png_ptr);
696
Andreas Dilger47a0c421997-05-16 02:46:07 -0500697 /* swap bytes of 16-bit files to most significant byte first */
Guy Schalnat0d580581995-07-20 02:43:20 -0500698 png_set_swap(png_ptr);
699
Andreas Dilger47a0c421997-05-16 02:46:07 -0500700 /* swap bits of 1, 2, 4 bit packed pixel formats */
701 png_set_packswap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500702
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500703 /* turn on interlace handling if you are not using png_write_image() */
Guy Schalnat0d580581995-07-20 02:43:20 -0500704 if (interlacing)
705 number_passes = png_set_interlace_handling(png_ptr);
706 else
707 number_passes = 1;
708
Andreas Dilger47a0c421997-05-16 02:46:07 -0500709 /* The easiest way to write the image (you may have a different memory
710 * layout, however, so choose what fits your needs best). You need to
711 * use the first method if you aren't handling interlacing yourself.
712 */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500713 png_uint_32 k, height, width;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600714 png_byte image[height][width*bytes_per_pixel];
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500715 png_bytep row_pointers[height];
716 for (k = 0; k < height; k++)
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600717 row_pointers[k] = image + k*width*bytes_per_pixel;
Guy Schalnate5a37791996-06-05 15:50:50 -0500718
Andreas Dilger47a0c421997-05-16 02:46:07 -0500719 /* One of the following output methods is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600720#ifdef entire /* write out the entire image data in one call */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500721 png_write_image(png_ptr, row_pointers);
722
723 /* the other way to write the image - deal with interlacing */
724
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600725#else no_entire /* write out the image data by one or more scanlines */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500726 /* The number of passes is either 1 for non-interlaced images,
727 * or 7 for interlaced images.
728 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500729 for (pass = 0; pass < number_passes; pass++)
730 {
731 /* Write a few rows at a time. */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500732 png_write_rows(png_ptr, &row_pointers[first_row], number_of_rows);
Guy Schalnat0d580581995-07-20 02:43:20 -0500733
734 /* If you are only writing one row at a time, this works */
735 for (y = 0; y < height; y++)
736 {
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500737 png_write_rows(png_ptr, &row_pointers[y], 1);
Guy Schalnat0d580581995-07-20 02:43:20 -0500738 }
739 }
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600740#endif no_entire /* use only one output method */
Guy Schalnat0d580581995-07-20 02:43:20 -0500741
Andreas Dilger47a0c421997-05-16 02:46:07 -0500742 /* You can write optional chunks like tEXt, zTXt, and tIME at the end
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600743 * as well. Shouldn't be necessary in 1.1.0 and up as all the public
744 * chunks are supported and you can use png_set_unknown_chunks() to
745 * register unknown chunks into the info structure to be written out.
Guy Schalnate5a37791996-06-05 15:50:50 -0500746 */
747
Andreas Dilger47a0c421997-05-16 02:46:07 -0500748 /* It is REQUIRED to call this to finish writing the rest of the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500749 png_write_end(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600750#endif hilevel
Guy Schalnat0d580581995-07-20 02:43:20 -0500751
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600752 /* If you png_malloced a palette, free it here (don't free info_ptr->palette,
753 as recommended in versions 1.0.5m and earlier of this example; if
754 libpng mallocs info_ptr->palette, libpng will free it). If you
755 allocated it with malloc() instead of png_malloc(), use free() instead
756 of png_free(). */
757 png_free(png_ptr, palette);
Glenn Randers-Pehrson4766a242000-07-17 06:17:09 -0500758 palette=NULL;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600759
760 /* Similarly, if you png_malloced any data that you passed in with
761 png_set_something(), such as a hist or trans array, free it here,
762 when you can be sure that libpng is through with it. */
763 png_free(png_ptr, trans);
Glenn Randers-Pehrson4766a242000-07-17 06:17:09 -0500764 trans=NULL;
Guy Schalnat0d580581995-07-20 02:43:20 -0500765
Guy Schalnate5a37791996-06-05 15:50:50 -0500766 /* clean up after the write, and free any memory allocated */
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -0500767 png_destroy_write_struct(&png_ptr, &info_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500768
769 /* close the file */
770 fclose(fp);
771
772 /* that's it */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500773 return (OK);
Guy Schalnat0d580581995-07-20 02:43:20 -0500774}
775
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -0500776#endif /* if 0 */