]> code.delx.au - refind/blob - libeg/lodepng.h
Fixed refind-install bug that could cause mountesp script to be
[refind] / libeg / lodepng.h
1 /*
2 LodePNG version 20151024
3
4 Copyright (c) 2005-2015 Lode Vandevenne
5
6 This software is provided 'as-is', without any express or implied
7 warranty. In no event will the authors be held liable for any damages
8 arising from the use of this software.
9
10 Permission is granted to anyone to use this software for any purpose,
11 including commercial applications, and to alter it and redistribute it
12 freely, subject to the following restrictions:
13
14 1. The origin of this software must not be misrepresented; you must not
15 claim that you wrote the original software. If you use this software
16 in a product, an acknowledgment in the product documentation would be
17 appreciated but is not required.
18
19 2. Altered source versions must be plainly marked as such, and must not be
20 misrepresented as being the original software.
21
22 3. This notice may not be removed or altered from any source
23 distribution.
24 */
25 /*
26 * This version of lodepng.h is modified for use with rEFInd. Some options
27 * are commented out and several definitions (commented on shortly) are added
28 * for GNU-EFI compatibility. The associated lodepng.c file is unmodified
29 * from the original.
30 */
31
32 #ifndef LODEPNG_H
33 #define LODEPNG_H
34
35 #include <string.h> /*for size_t*/
36
37 // Below block of lines required for GNU-EFI and TianoCore (program hangs
38 // when run without them, and associated function in lodepng_xtra.c)
39 int MyStrlen(const char *InString);
40 #define strlen(c) MyStrlen(c)
41 #include <stdlib.h>
42 #define abs(x) (((x) < 0) ? -(x) : (x))
43 #ifdef __MAKEWITH_GNUEFI
44 #include <efi.h>
45 #include <efilib.h>
46 #else
47 #include "../include/tiano_includes.h"
48 #endif
49 VOID *MyMemSet(VOID *s, int c, size_t n);
50 VOID *MyMemCpy(void *__restrict __dest, const void *__restrict __src, size_t __n);
51 #define memset(s, c, n) MyMemSet(s, c, n)
52 #define memcpy(d, s, n) MyMemCpy(d, s, n)
53
54 #ifdef __cplusplus
55 #include <vector>
56 #include <string>
57 #endif /*__cplusplus*/
58
59 extern const char* LODEPNG_VERSION_STRING;
60
61 /*
62 The following #defines are used to create code sections. They can be disabled
63 to disable code sections, which can give faster compile time and smaller binary.
64 The "NO_COMPILE" defines are designed to be used to pass as defines to the
65 compiler command to disable them without modifying this header, e.g.
66 -DLODEPNG_NO_COMPILE_ZLIB for gcc.
67 In addition to those below, you can also define LODEPNG_NO_COMPILE_CRC to
68 allow implementing a custom lodepng_crc32.
69 */
70 /*deflate & zlib. If disabled, you must specify alternative zlib functions in
71 the custom_zlib field of the compress and decompress settings*/
72 #ifndef LODEPNG_NO_COMPILE_ZLIB
73 #define LODEPNG_COMPILE_ZLIB
74 #endif
75 /*png encoder and png decoder*/
76 #ifndef LODEPNG_NO_COMPILE_PNG
77 #define LODEPNG_COMPILE_PNG
78 #endif
79 /*deflate&zlib decoder and png decoder*/
80 #ifndef LODEPNG_NO_COMPILE_DECODER
81 #define LODEPNG_COMPILE_DECODER
82 #endif
83 /*deflate&zlib encoder and png encoder*/
84 // #ifndef LODEPNG_NO_COMPILE_ENCODER
85 // #define LODEPNG_COMPILE_ENCODER
86 // #endif
87 /*the optional built in harddisk file loading and saving functions*/
88 // #ifndef LODEPNG_NO_COMPILE_DISK
89 // #define LODEPNG_COMPILE_DISK
90 // #endif
91 /*support for chunks other than IHDR, IDAT, PLTE, tRNS, IEND: ancillary and unknown chunks*/
92 // #ifndef LODEPNG_NO_COMPILE_ANCILLARY_CHUNKS
93 // #define LODEPNG_COMPILE_ANCILLARY_CHUNKS
94 // #endif
95 /*ability to convert error numerical codes to English text string*/
96 // #ifndef LODEPNG_NO_COMPILE_ERROR_TEXT
97 // #define LODEPNG_COMPILE_ERROR_TEXT
98 // #endif
99 /*Compile the default allocators (C's free, malloc and realloc). If you disable this,
100 you can define the functions lodepng_free, lodepng_malloc and lodepng_realloc in your
101 source files with custom allocators.*/
102 // #ifndef LODEPNG_NO_COMPILE_ALLOCATORS
103 // #define LODEPNG_COMPILE_ALLOCATORS
104 // #endif
105 /*compile the C++ version (you can disable the C++ wrapper here even when compiling for C++)*/
106 #ifdef __cplusplus
107 #ifndef LODEPNG_NO_COMPILE_CPP
108 #define LODEPNG_COMPILE_CPP
109 #endif
110 #endif
111
112 #ifdef LODEPNG_COMPILE_PNG
113 /*The PNG color types (also used for raw).*/
114 typedef enum LodePNGColorType
115 {
116 LCT_GREY = 0, /*greyscale: 1,2,4,8,16 bit*/
117 LCT_RGB = 2, /*RGB: 8,16 bit*/
118 LCT_PALETTE = 3, /*palette: 1,2,4,8 bit*/
119 LCT_GREY_ALPHA = 4, /*greyscale with alpha: 8,16 bit*/
120 LCT_RGBA = 6 /*RGB with alpha: 8,16 bit*/
121 } LodePNGColorType;
122
123 #ifdef LODEPNG_COMPILE_DECODER
124 /*
125 Converts PNG data in memory to raw pixel data.
126 out: Output parameter. Pointer to buffer that will contain the raw pixel data.
127 After decoding, its size is w * h * (bytes per pixel) bytes larger than
128 initially. Bytes per pixel depends on colortype and bitdepth.
129 Must be freed after usage with free(*out).
130 Note: for 16-bit per channel colors, uses big endian format like PNG does.
131 w: Output parameter. Pointer to width of pixel data.
132 h: Output parameter. Pointer to height of pixel data.
133 in: Memory buffer with the PNG file.
134 insize: size of the in buffer.
135 colortype: the desired color type for the raw output image. See explanation on PNG color types.
136 bitdepth: the desired bit depth for the raw output image. See explanation on PNG color types.
137 Return value: LodePNG error code (0 means no error).
138 */
139 unsigned lodepng_decode_memory(unsigned char** out, unsigned* w, unsigned* h,
140 const unsigned char* in, size_t insize,
141 LodePNGColorType colortype, unsigned bitdepth);
142
143 /*Same as lodepng_decode_memory, but always decodes to 32-bit RGBA raw image*/
144 unsigned lodepng_decode32(unsigned char** out, unsigned* w, unsigned* h,
145 const unsigned char* in, size_t insize);
146
147 /*Same as lodepng_decode_memory, but always decodes to 24-bit RGB raw image*/
148 unsigned lodepng_decode24(unsigned char** out, unsigned* w, unsigned* h,
149 const unsigned char* in, size_t insize);
150
151 #ifdef LODEPNG_COMPILE_DISK
152 /*
153 Load PNG from disk, from file with given name.
154 Same as the other decode functions, but instead takes a filename as input.
155 */
156 unsigned lodepng_decode_file(unsigned char** out, unsigned* w, unsigned* h,
157 const char* filename,
158 LodePNGColorType colortype, unsigned bitdepth);
159
160 /*Same as lodepng_decode_file, but always decodes to 32-bit RGBA raw image.*/
161 unsigned lodepng_decode32_file(unsigned char** out, unsigned* w, unsigned* h,
162 const char* filename);
163
164 /*Same as lodepng_decode_file, but always decodes to 24-bit RGB raw image.*/
165 unsigned lodepng_decode24_file(unsigned char** out, unsigned* w, unsigned* h,
166 const char* filename);
167 #endif /*LODEPNG_COMPILE_DISK*/
168 #endif /*LODEPNG_COMPILE_DECODER*/
169
170
171 #ifdef LODEPNG_COMPILE_ENCODER
172 /*
173 Converts raw pixel data into a PNG image in memory. The colortype and bitdepth
174 of the output PNG image cannot be chosen, they are automatically determined
175 by the colortype, bitdepth and content of the input pixel data.
176 Note: for 16-bit per channel colors, needs big endian format like PNG does.
177 out: Output parameter. Pointer to buffer that will contain the PNG image data.
178 Must be freed after usage with free(*out).
179 outsize: Output parameter. Pointer to the size in bytes of the out buffer.
180 image: The raw pixel data to encode. The size of this buffer should be
181 w * h * (bytes per pixel), bytes per pixel depends on colortype and bitdepth.
182 w: width of the raw pixel data in pixels.
183 h: height of the raw pixel data in pixels.
184 colortype: the color type of the raw input image. See explanation on PNG color types.
185 bitdepth: the bit depth of the raw input image. See explanation on PNG color types.
186 Return value: LodePNG error code (0 means no error).
187 */
188 unsigned lodepng_encode_memory(unsigned char** out, size_t* outsize,
189 const unsigned char* image, unsigned w, unsigned h,
190 LodePNGColorType colortype, unsigned bitdepth);
191
192 /*Same as lodepng_encode_memory, but always encodes from 32-bit RGBA raw image.*/
193 unsigned lodepng_encode32(unsigned char** out, size_t* outsize,
194 const unsigned char* image, unsigned w, unsigned h);
195
196 /*Same as lodepng_encode_memory, but always encodes from 24-bit RGB raw image.*/
197 unsigned lodepng_encode24(unsigned char** out, size_t* outsize,
198 const unsigned char* image, unsigned w, unsigned h);
199
200 #ifdef LODEPNG_COMPILE_DISK
201 /*
202 Converts raw pixel data into a PNG file on disk.
203 Same as the other encode functions, but instead takes a filename as output.
204 NOTE: This overwrites existing files without warning!
205 */
206 unsigned lodepng_encode_file(const char* filename,
207 const unsigned char* image, unsigned w, unsigned h,
208 LodePNGColorType colortype, unsigned bitdepth);
209
210 /*Same as lodepng_encode_file, but always encodes from 32-bit RGBA raw image.*/
211 unsigned lodepng_encode32_file(const char* filename,
212 const unsigned char* image, unsigned w, unsigned h);
213
214 /*Same as lodepng_encode_file, but always encodes from 24-bit RGB raw image.*/
215 unsigned lodepng_encode24_file(const char* filename,
216 const unsigned char* image, unsigned w, unsigned h);
217 #endif /*LODEPNG_COMPILE_DISK*/
218 #endif /*LODEPNG_COMPILE_ENCODER*/
219
220
221 #ifdef LODEPNG_COMPILE_CPP
222 namespace lodepng
223 {
224 #ifdef LODEPNG_COMPILE_DECODER
225 /*Same as lodepng_decode_memory, but decodes to an std::vector. The colortype
226 is the format to output the pixels to. Default is RGBA 8-bit per channel.*/
227 unsigned decode(std::vector<unsigned char>& out, unsigned& w, unsigned& h,
228 const unsigned char* in, size_t insize,
229 LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
230 unsigned decode(std::vector<unsigned char>& out, unsigned& w, unsigned& h,
231 const std::vector<unsigned char>& in,
232 LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
233 #ifdef LODEPNG_COMPILE_DISK
234 /*
235 Converts PNG file from disk to raw pixel data in memory.
236 Same as the other decode functions, but instead takes a filename as input.
237 */
238 unsigned decode(std::vector<unsigned char>& out, unsigned& w, unsigned& h,
239 const std::string& filename,
240 LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
241 #endif /* LODEPNG_COMPILE_DISK */
242 #endif /* LODEPNG_COMPILE_DECODER */
243
244 #ifdef LODEPNG_COMPILE_ENCODER
245 /*Same as lodepng_encode_memory, but encodes to an std::vector. colortype
246 is that of the raw input data. The output PNG color type will be auto chosen.*/
247 unsigned encode(std::vector<unsigned char>& out,
248 const unsigned char* in, unsigned w, unsigned h,
249 LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
250 unsigned encode(std::vector<unsigned char>& out,
251 const std::vector<unsigned char>& in, unsigned w, unsigned h,
252 LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
253 #ifdef LODEPNG_COMPILE_DISK
254 /*
255 Converts 32-bit RGBA raw pixel data into a PNG file on disk.
256 Same as the other encode functions, but instead takes a filename as output.
257 NOTE: This overwrites existing files without warning!
258 */
259 unsigned encode(const std::string& filename,
260 const unsigned char* in, unsigned w, unsigned h,
261 LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
262 unsigned encode(const std::string& filename,
263 const std::vector<unsigned char>& in, unsigned w, unsigned h,
264 LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
265 #endif /* LODEPNG_COMPILE_DISK */
266 #endif /* LODEPNG_COMPILE_ENCODER */
267 } /* namespace lodepng */
268 #endif /*LODEPNG_COMPILE_CPP*/
269 #endif /*LODEPNG_COMPILE_PNG*/
270
271 #ifdef LODEPNG_COMPILE_ERROR_TEXT
272 /*Returns an English description of the numerical error code.*/
273 const char* lodepng_error_text(unsigned code);
274 #endif /*LODEPNG_COMPILE_ERROR_TEXT*/
275
276 #ifdef LODEPNG_COMPILE_DECODER
277 /*Settings for zlib decompression*/
278 typedef struct LodePNGDecompressSettings LodePNGDecompressSettings;
279 struct LodePNGDecompressSettings
280 {
281 unsigned ignore_adler32; /*if 1, continue and don't give an error message if the Adler32 checksum is corrupted*/
282
283 /*use custom zlib decoder instead of built in one (default: null)*/
284 unsigned (*custom_zlib)(unsigned char**, size_t*,
285 const unsigned char*, size_t,
286 const LodePNGDecompressSettings*);
287 /*use custom deflate decoder instead of built in one (default: null)
288 if custom_zlib is used, custom_deflate is ignored since only the built in
289 zlib function will call custom_deflate*/
290 unsigned (*custom_inflate)(unsigned char**, size_t*,
291 const unsigned char*, size_t,
292 const LodePNGDecompressSettings*);
293
294 const void* custom_context; /*optional custom settings for custom functions*/
295 };
296
297 extern const LodePNGDecompressSettings lodepng_default_decompress_settings;
298 void lodepng_decompress_settings_init(LodePNGDecompressSettings* settings);
299 #endif /*LODEPNG_COMPILE_DECODER*/
300
301 #ifdef LODEPNG_COMPILE_ENCODER
302 /*
303 Settings for zlib compression. Tweaking these settings tweaks the balance
304 between speed and compression ratio.
305 */
306 typedef struct LodePNGCompressSettings LodePNGCompressSettings;
307 struct LodePNGCompressSettings /*deflate = compress*/
308 {
309 /*LZ77 related settings*/
310 unsigned btype; /*the block type for LZ (0, 1, 2 or 3, see zlib standard). Should be 2 for proper compression.*/
311 unsigned use_lz77; /*whether or not to use LZ77. Should be 1 for proper compression.*/
312 unsigned windowsize; /*must be a power of two <= 32768. higher compresses more but is slower. Default value: 2048.*/
313 unsigned minmatch; /*mininum lz77 length. 3 is normally best, 6 can be better for some PNGs. Default: 0*/
314 unsigned nicematch; /*stop searching if >= this length found. Set to 258 for best compression. Default: 128*/
315 unsigned lazymatching; /*use lazy matching: better compression but a bit slower. Default: true*/
316
317 /*use custom zlib encoder instead of built in one (default: null)*/
318 unsigned (*custom_zlib)(unsigned char**, size_t*,
319 const unsigned char*, size_t,
320 const LodePNGCompressSettings*);
321 /*use custom deflate encoder instead of built in one (default: null)
322 if custom_zlib is used, custom_deflate is ignored since only the built in
323 zlib function will call custom_deflate*/
324 unsigned (*custom_deflate)(unsigned char**, size_t*,
325 const unsigned char*, size_t,
326 const LodePNGCompressSettings*);
327
328 const void* custom_context; /*optional custom settings for custom functions*/
329 };
330
331 extern const LodePNGCompressSettings lodepng_default_compress_settings;
332 void lodepng_compress_settings_init(LodePNGCompressSettings* settings);
333 #endif /*LODEPNG_COMPILE_ENCODER*/
334
335 #ifdef LODEPNG_COMPILE_PNG
336 /*
337 Color mode of an image. Contains all information required to decode the pixel
338 bits to RGBA colors. This information is the same as used in the PNG file
339 format, and is used both for PNG and raw image data in LodePNG.
340 */
341 typedef struct LodePNGColorMode
342 {
343 /*header (IHDR)*/
344 LodePNGColorType colortype; /*color type, see PNG standard or documentation further in this header file*/
345 unsigned bitdepth; /*bits per sample, see PNG standard or documentation further in this header file*/
346
347 /*
348 palette (PLTE and tRNS)
349
350 Dynamically allocated with the colors of the palette, including alpha.
351 When encoding a PNG, to store your colors in the palette of the LodePNGColorMode, first use
352 lodepng_palette_clear, then for each color use lodepng_palette_add.
353 If you encode an image without alpha with palette, don't forget to put value 255 in each A byte of the palette.
354
355 When decoding, by default you can ignore this palette, since LodePNG already
356 fills the palette colors in the pixels of the raw RGBA output.
357
358 The palette is only supported for color type 3.
359 */
360 unsigned char* palette; /*palette in RGBARGBA... order. When allocated, must be either 0, or have size 1024*/
361 size_t palettesize; /*palette size in number of colors (amount of bytes is 4 * palettesize)*/
362
363 /*
364 transparent color key (tRNS)
365
366 This color uses the same bit depth as the bitdepth value in this struct, which can be 1-bit to 16-bit.
367 For greyscale PNGs, r, g and b will all 3 be set to the same.
368
369 When decoding, by default you can ignore this information, since LodePNG sets
370 pixels with this key to transparent already in the raw RGBA output.
371
372 The color key is only supported for color types 0 and 2.
373 */
374 unsigned key_defined; /*is a transparent color key given? 0 = false, 1 = true*/
375 unsigned key_r; /*red/greyscale component of color key*/
376 unsigned key_g; /*green component of color key*/
377 unsigned key_b; /*blue component of color key*/
378 } LodePNGColorMode;
379
380 /*init, cleanup and copy functions to use with this struct*/
381 void lodepng_color_mode_init(LodePNGColorMode* info);
382 void lodepng_color_mode_cleanup(LodePNGColorMode* info);
383 /*return value is error code (0 means no error)*/
384 unsigned lodepng_color_mode_copy(LodePNGColorMode* dest, const LodePNGColorMode* source);
385
386 void lodepng_palette_clear(LodePNGColorMode* info);
387 /*add 1 color to the palette*/
388 unsigned lodepng_palette_add(LodePNGColorMode* info,
389 unsigned char r, unsigned char g, unsigned char b, unsigned char a);
390
391 /*get the total amount of bits per pixel, based on colortype and bitdepth in the struct*/
392 unsigned lodepng_get_bpp(const LodePNGColorMode* info);
393 /*get the amount of color channels used, based on colortype in the struct.
394 If a palette is used, it counts as 1 channel.*/
395 unsigned lodepng_get_channels(const LodePNGColorMode* info);
396 /*is it a greyscale type? (only colortype 0 or 4)*/
397 unsigned lodepng_is_greyscale_type(const LodePNGColorMode* info);
398 /*has it got an alpha channel? (only colortype 2 or 6)*/
399 unsigned lodepng_is_alpha_type(const LodePNGColorMode* info);
400 /*has it got a palette? (only colortype 3)*/
401 unsigned lodepng_is_palette_type(const LodePNGColorMode* info);
402 /*only returns true if there is a palette and there is a value in the palette with alpha < 255.
403 Loops through the palette to check this.*/
404 unsigned lodepng_has_palette_alpha(const LodePNGColorMode* info);
405 /*
406 Check if the given color info indicates the possibility of having non-opaque pixels in the PNG image.
407 Returns true if the image can have translucent or invisible pixels (it still be opaque if it doesn't use such pixels).
408 Returns false if the image can only have opaque pixels.
409 In detail, it returns true only if it's a color type with alpha, or has a palette with non-opaque values,
410 or if "key_defined" is true.
411 */
412 unsigned lodepng_can_have_alpha(const LodePNGColorMode* info);
413 /*Returns the byte size of a raw image buffer with given width, height and color mode*/
414 size_t lodepng_get_raw_size(unsigned w, unsigned h, const LodePNGColorMode* color);
415
416 #ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS
417 /*The information of a Time chunk in PNG.*/
418 typedef struct LodePNGTime
419 {
420 unsigned year; /*2 bytes used (0-65535)*/
421 unsigned month; /*1-12*/
422 unsigned day; /*1-31*/
423 unsigned hour; /*0-23*/
424 unsigned minute; /*0-59*/
425 unsigned second; /*0-60 (to allow for leap seconds)*/
426 } LodePNGTime;
427 #endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/
428
429 /*Information about the PNG image, except pixels, width and height.*/
430 typedef struct LodePNGInfo
431 {
432 /*header (IHDR), palette (PLTE) and transparency (tRNS) chunks*/
433 unsigned compression_method;/*compression method of the original file. Always 0.*/
434 unsigned filter_method; /*filter method of the original file*/
435 unsigned interlace_method; /*interlace method of the original file*/
436 LodePNGColorMode color; /*color type and bits, palette and transparency of the PNG file*/
437
438 #ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS
439 /*
440 suggested background color chunk (bKGD)
441 This color uses the same color mode as the PNG (except alpha channel), which can be 1-bit to 16-bit.
442
443 For greyscale PNGs, r, g and b will all 3 be set to the same. When encoding
444 the encoder writes the red one. For palette PNGs: When decoding, the RGB value
445 will be stored, not a palette index. But when encoding, specify the index of
446 the palette in background_r, the other two are then ignored.
447
448 The decoder does not use this background color to edit the color of pixels.
449 */
450 unsigned background_defined; /*is a suggested background color given?*/
451 unsigned background_r; /*red component of suggested background color*/
452 unsigned background_g; /*green component of suggested background color*/
453 unsigned background_b; /*blue component of suggested background color*/
454
455 /*
456 non-international text chunks (tEXt and zTXt)
457
458 The char** arrays each contain num strings. The actual messages are in
459 text_strings, while text_keys are keywords that give a short description what
460 the actual text represents, e.g. Title, Author, Description, or anything else.
461
462 A keyword is minimum 1 character and maximum 79 characters long. It's
463 discouraged to use a single line length longer than 79 characters for texts.
464
465 Don't allocate these text buffers yourself. Use the init/cleanup functions
466 correctly and use lodepng_add_text and lodepng_clear_text.
467 */
468 size_t text_num; /*the amount of texts in these char** buffers (there may be more texts in itext)*/
469 char** text_keys; /*the keyword of a text chunk (e.g. "Comment")*/
470 char** text_strings; /*the actual text*/
471
472 /*
473 international text chunks (iTXt)
474 Similar to the non-international text chunks, but with additional strings
475 "langtags" and "transkeys".
476 */
477 size_t itext_num; /*the amount of international texts in this PNG*/
478 char** itext_keys; /*the English keyword of the text chunk (e.g. "Comment")*/
479 char** itext_langtags; /*language tag for this text's language, ISO/IEC 646 string, e.g. ISO 639 language tag*/
480 char** itext_transkeys; /*keyword translated to the international language - UTF-8 string*/
481 char** itext_strings; /*the actual international text - UTF-8 string*/
482
483 /*time chunk (tIME)*/
484 unsigned time_defined; /*set to 1 to make the encoder generate a tIME chunk*/
485 LodePNGTime time;
486
487 /*phys chunk (pHYs)*/
488 unsigned phys_defined; /*if 0, there is no pHYs chunk and the values below are undefined, if 1 else there is one*/
489 unsigned phys_x; /*pixels per unit in x direction*/
490 unsigned phys_y; /*pixels per unit in y direction*/
491 unsigned phys_unit; /*may be 0 (unknown unit) or 1 (metre)*/
492
493 /*
494 unknown chunks
495 There are 3 buffers, one for each position in the PNG where unknown chunks can appear
496 each buffer contains all unknown chunks for that position consecutively
497 The 3 buffers are the unknown chunks between certain critical chunks:
498 0: IHDR-PLTE, 1: PLTE-IDAT, 2: IDAT-IEND
499 Do not allocate or traverse this data yourself. Use the chunk traversing functions declared
500 later, such as lodepng_chunk_next and lodepng_chunk_append, to read/write this struct.
501 */
502 unsigned char* unknown_chunks_data[3];
503 size_t unknown_chunks_size[3]; /*size in bytes of the unknown chunks, given for protection*/
504 #endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/
505 } LodePNGInfo;
506
507 /*init, cleanup and copy functions to use with this struct*/
508 void lodepng_info_init(LodePNGInfo* info);
509 void lodepng_info_cleanup(LodePNGInfo* info);
510 /*return value is error code (0 means no error)*/
511 unsigned lodepng_info_copy(LodePNGInfo* dest, const LodePNGInfo* source);
512
513 #ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS
514 void lodepng_clear_text(LodePNGInfo* info); /*use this to clear the texts again after you filled them in*/
515 unsigned lodepng_add_text(LodePNGInfo* info, const char* key, const char* str); /*push back both texts at once*/
516
517 void lodepng_clear_itext(LodePNGInfo* info); /*use this to clear the itexts again after you filled them in*/
518 unsigned lodepng_add_itext(LodePNGInfo* info, const char* key, const char* langtag,
519 const char* transkey, const char* str); /*push back the 4 texts of 1 chunk at once*/
520 #endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/
521
522 /*
523 Converts raw buffer from one color type to another color type, based on
524 LodePNGColorMode structs to describe the input and output color type.
525 See the reference manual at the end of this header file to see which color conversions are supported.
526 return value = LodePNG error code (0 if all went ok, an error if the conversion isn't supported)
527 The out buffer must have size (w * h * bpp + 7) / 8, where bpp is the bits per pixel
528 of the output color type (lodepng_get_bpp).
529 For < 8 bpp images, there should not be padding bits at the end of scanlines.
530 For 16-bit per channel colors, uses big endian format like PNG does.
531 Return value is LodePNG error code
532 */
533 unsigned lodepng_convert(unsigned char* out, const unsigned char* in,
534 const LodePNGColorMode* mode_out, const LodePNGColorMode* mode_in,
535 unsigned w, unsigned h);
536
537 #ifdef LODEPNG_COMPILE_DECODER
538 /*
539 Settings for the decoder. This contains settings for the PNG and the Zlib
540 decoder, but not the Info settings from the Info structs.
541 */
542 typedef struct LodePNGDecoderSettings
543 {
544 LodePNGDecompressSettings zlibsettings; /*in here is the setting to ignore Adler32 checksums*/
545
546 unsigned ignore_crc; /*ignore CRC checksums*/
547
548 unsigned color_convert; /*whether to convert the PNG to the color type you want. Default: yes*/
549
550 #ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS
551 unsigned read_text_chunks; /*if false but remember_unknown_chunks is true, they're stored in the unknown chunks*/
552 /*store all bytes from unknown chunks in the LodePNGInfo (off by default, useful for a png editor)*/
553 unsigned remember_unknown_chunks;
554 #endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/
555 } LodePNGDecoderSettings;
556
557 void lodepng_decoder_settings_init(LodePNGDecoderSettings* settings);
558 #endif /*LODEPNG_COMPILE_DECODER*/
559
560 #ifdef LODEPNG_COMPILE_ENCODER
561 /*automatically use color type with less bits per pixel if losslessly possible. Default: AUTO*/
562 typedef enum LodePNGFilterStrategy
563 {
564 /*every filter at zero*/
565 LFS_ZERO,
566 /*Use filter that gives minimum sum, as described in the official PNG filter heuristic.*/
567 LFS_MINSUM,
568 /*Use the filter type that gives smallest Shannon entropy for this scanline. Depending
569 on the image, this is better or worse than minsum.*/
570 LFS_ENTROPY,
571 /*
572 Brute-force-search PNG filters by compressing each filter for each scanline.
573 Experimental, very slow, and only rarely gives better compression than MINSUM.
574 */
575 LFS_BRUTE_FORCE,
576 /*use predefined_filters buffer: you specify the filter type for each scanline*/
577 LFS_PREDEFINED
578 } LodePNGFilterStrategy;
579
580 /*Gives characteristics about the colors of the image, which helps decide which color model to use for encoding.
581 Used internally by default if "auto_convert" is enabled. Public because it's useful for custom algorithms.*/
582 typedef struct LodePNGColorProfile
583 {
584 unsigned colored; /*not greyscale*/
585 unsigned key; /*if true, image is not opaque. Only if true and alpha is false, color key is possible.*/
586 unsigned short key_r; /*these values are always in 16-bit bitdepth in the profile*/
587 unsigned short key_g;
588 unsigned short key_b;
589 unsigned alpha; /*alpha channel or alpha palette required*/
590 unsigned numcolors; /*amount of colors, up to 257. Not valid if bits == 16.*/
591 unsigned char palette[1024]; /*Remembers up to the first 256 RGBA colors, in no particular order*/
592 unsigned bits; /*bits per channel (not for palette). 1,2 or 4 for greyscale only. 16 if 16-bit per channel required.*/
593 } LodePNGColorProfile;
594
595 void lodepng_color_profile_init(LodePNGColorProfile* profile);
596
597 /*Get a LodePNGColorProfile of the image.*/
598 unsigned lodepng_get_color_profile(LodePNGColorProfile* profile,
599 const unsigned char* image, unsigned w, unsigned h,
600 const LodePNGColorMode* mode_in);
601 /*The function LodePNG uses internally to decide the PNG color with auto_convert.
602 Chooses an optimal color model, e.g. grey if only grey pixels, palette if < 256 colors, ...*/
603 unsigned lodepng_auto_choose_color(LodePNGColorMode* mode_out,
604 const unsigned char* image, unsigned w, unsigned h,
605 const LodePNGColorMode* mode_in);
606
607 /*Settings for the encoder.*/
608 typedef struct LodePNGEncoderSettings
609 {
610 LodePNGCompressSettings zlibsettings; /*settings for the zlib encoder, such as window size, ...*/
611
612 unsigned auto_convert; /*automatically choose output PNG color type. Default: true*/
613
614 /*If true, follows the official PNG heuristic: if the PNG uses a palette or lower than
615 8 bit depth, set all filters to zero. Otherwise use the filter_strategy. Note that to
616 completely follow the official PNG heuristic, filter_palette_zero must be true and
617 filter_strategy must be LFS_MINSUM*/
618 unsigned filter_palette_zero;
619 /*Which filter strategy to use when not using zeroes due to filter_palette_zero.
620 Set filter_palette_zero to 0 to ensure always using your chosen strategy. Default: LFS_MINSUM*/
621 LodePNGFilterStrategy filter_strategy;
622 /*used if filter_strategy is LFS_PREDEFINED. In that case, this must point to a buffer with
623 the same length as the amount of scanlines in the image, and each value must <= 5. You
624 have to cleanup this buffer, LodePNG will never free it. Don't forget that filter_palette_zero
625 must be set to 0 to ensure this is also used on palette or low bitdepth images.*/
626 const unsigned char* predefined_filters;
627
628 /*force creating a PLTE chunk if colortype is 2 or 6 (= a suggested palette).
629 If colortype is 3, PLTE is _always_ created.*/
630 unsigned force_palette;
631 #ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS
632 /*add LodePNG identifier and version as a text chunk, for debugging*/
633 unsigned add_id;
634 /*encode text chunks as zTXt chunks instead of tEXt chunks, and use compression in iTXt chunks*/
635 unsigned text_compression;
636 #endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/
637 } LodePNGEncoderSettings;
638
639 void lodepng_encoder_settings_init(LodePNGEncoderSettings* settings);
640 #endif /*LODEPNG_COMPILE_ENCODER*/
641
642
643 #if defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER)
644 /*The settings, state and information for extended encoding and decoding.*/
645 typedef struct LodePNGState
646 {
647 #ifdef LODEPNG_COMPILE_DECODER
648 LodePNGDecoderSettings decoder; /*the decoding settings*/
649 #endif /*LODEPNG_COMPILE_DECODER*/
650 #ifdef LODEPNG_COMPILE_ENCODER
651 LodePNGEncoderSettings encoder; /*the encoding settings*/
652 #endif /*LODEPNG_COMPILE_ENCODER*/
653 LodePNGColorMode info_raw; /*specifies the format in which you would like to get the raw pixel buffer*/
654 LodePNGInfo info_png; /*info of the PNG image obtained after decoding*/
655 unsigned error;
656 #ifdef LODEPNG_COMPILE_CPP
657 /* For the lodepng::State subclass. */
658 virtual ~LodePNGState(){}
659 #endif
660 } LodePNGState;
661
662 /*init, cleanup and copy functions to use with this struct*/
663 void lodepng_state_init(LodePNGState* state);
664 void lodepng_state_cleanup(LodePNGState* state);
665 void lodepng_state_copy(LodePNGState* dest, const LodePNGState* source);
666 #endif /* defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER) */
667
668 #ifdef LODEPNG_COMPILE_DECODER
669 /*
670 Same as lodepng_decode_memory, but uses a LodePNGState to allow custom settings and
671 getting much more information about the PNG image and color mode.
672 */
673 unsigned lodepng_decode(unsigned char** out, unsigned* w, unsigned* h,
674 LodePNGState* state,
675 const unsigned char* in, size_t insize);
676
677 /*
678 Read the PNG header, but not the actual data. This returns only the information
679 that is in the header chunk of the PNG, such as width, height and color type. The
680 information is placed in the info_png field of the LodePNGState.
681 */
682 unsigned lodepng_inspect(unsigned* w, unsigned* h,
683 LodePNGState* state,
684 const unsigned char* in, size_t insize);
685 #endif /*LODEPNG_COMPILE_DECODER*/
686
687
688 #ifdef LODEPNG_COMPILE_ENCODER
689 /*This function allocates the out buffer with standard malloc and stores the size in *outsize.*/
690 unsigned lodepng_encode(unsigned char** out, size_t* outsize,
691 const unsigned char* image, unsigned w, unsigned h,
692 LodePNGState* state);
693 #endif /*LODEPNG_COMPILE_ENCODER*/
694
695 /*
696 The lodepng_chunk functions are normally not needed, except to traverse the
697 unknown chunks stored in the LodePNGInfo struct, or add new ones to it.
698 It also allows traversing the chunks of an encoded PNG file yourself.
699
700 PNG standard chunk naming conventions:
701 First byte: uppercase = critical, lowercase = ancillary
702 Second byte: uppercase = public, lowercase = private
703 Third byte: must be uppercase
704 Fourth byte: uppercase = unsafe to copy, lowercase = safe to copy
705 */
706
707 /*
708 Gets the length of the data of the chunk. Total chunk length has 12 bytes more.
709 There must be at least 4 bytes to read from. If the result value is too large,
710 it may be corrupt data.
711 */
712 unsigned lodepng_chunk_length(const unsigned char* chunk);
713
714 /*puts the 4-byte type in null terminated string*/
715 void lodepng_chunk_type(char type[5], const unsigned char* chunk);
716
717 /*check if the type is the given type*/
718 unsigned char lodepng_chunk_type_equals(const unsigned char* chunk, const char* type);
719
720 /*0: it's one of the critical chunk types, 1: it's an ancillary chunk (see PNG standard)*/
721 unsigned char lodepng_chunk_ancillary(const unsigned char* chunk);
722
723 /*0: public, 1: private (see PNG standard)*/
724 unsigned char lodepng_chunk_private(const unsigned char* chunk);
725
726 /*0: the chunk is unsafe to copy, 1: the chunk is safe to copy (see PNG standard)*/
727 unsigned char lodepng_chunk_safetocopy(const unsigned char* chunk);
728
729 /*get pointer to the data of the chunk, where the input points to the header of the chunk*/
730 unsigned char* lodepng_chunk_data(unsigned char* chunk);
731 const unsigned char* lodepng_chunk_data_const(const unsigned char* chunk);
732
733 /*returns 0 if the crc is correct, 1 if it's incorrect (0 for OK as usual!)*/
734 unsigned lodepng_chunk_check_crc(const unsigned char* chunk);
735
736 /*generates the correct CRC from the data and puts it in the last 4 bytes of the chunk*/
737 void lodepng_chunk_generate_crc(unsigned char* chunk);
738
739 /*iterate to next chunks. don't use on IEND chunk, as there is no next chunk then*/
740 unsigned char* lodepng_chunk_next(unsigned char* chunk);
741 const unsigned char* lodepng_chunk_next_const(const unsigned char* chunk);
742
743 /*
744 Appends chunk to the data in out. The given chunk should already have its chunk header.
745 The out variable and outlength are updated to reflect the new reallocated buffer.
746 Returns error code (0 if it went ok)
747 */
748 unsigned lodepng_chunk_append(unsigned char** out, size_t* outlength, const unsigned char* chunk);
749
750 /*
751 Appends new chunk to out. The chunk to append is given by giving its length, type
752 and data separately. The type is a 4-letter string.
753 The out variable and outlength are updated to reflect the new reallocated buffer.
754 Returne error code (0 if it went ok)
755 */
756 unsigned lodepng_chunk_create(unsigned char** out, size_t* outlength, unsigned length,
757 const char* type, const unsigned char* data);
758
759
760 /*Calculate CRC32 of buffer*/
761 unsigned lodepng_crc32(const unsigned char* buf, size_t len);
762 #endif /*LODEPNG_COMPILE_PNG*/
763
764
765 #ifdef LODEPNG_COMPILE_ZLIB
766 /*
767 This zlib part can be used independently to zlib compress and decompress a
768 buffer. It cannot be used to create gzip files however, and it only supports the
769 part of zlib that is required for PNG, it does not support dictionaries.
770 */
771
772 #ifdef LODEPNG_COMPILE_DECODER
773 /*Inflate a buffer. Inflate is the decompression step of deflate. Out buffer must be freed after use.*/
774 unsigned lodepng_inflate(unsigned char** out, size_t* outsize,
775 const unsigned char* in, size_t insize,
776 const LodePNGDecompressSettings* settings);
777
778 /*
779 Decompresses Zlib data. Reallocates the out buffer and appends the data. The
780 data must be according to the zlib specification.
781 Either, *out must be NULL and *outsize must be 0, or, *out must be a valid
782 buffer and *outsize its size in bytes. out must be freed by user after usage.
783 */
784 unsigned lodepng_zlib_decompress(unsigned char** out, size_t* outsize,
785 const unsigned char* in, size_t insize,
786 const LodePNGDecompressSettings* settings);
787 #endif /*LODEPNG_COMPILE_DECODER*/
788
789 #ifdef LODEPNG_COMPILE_ENCODER
790 /*
791 Compresses data with Zlib. Reallocates the out buffer and appends the data.
792 Zlib adds a small header and trailer around the deflate data.
793 The data is output in the format of the zlib specification.
794 Either, *out must be NULL and *outsize must be 0, or, *out must be a valid
795 buffer and *outsize its size in bytes. out must be freed by user after usage.
796 */
797 unsigned lodepng_zlib_compress(unsigned char** out, size_t* outsize,
798 const unsigned char* in, size_t insize,
799 const LodePNGCompressSettings* settings);
800
801 /*
802 Find length-limited Huffman code for given frequencies. This function is in the
803 public interface only for tests, it's used internally by lodepng_deflate.
804 */
805 unsigned lodepng_huffman_code_lengths(unsigned* lengths, const unsigned* frequencies,
806 size_t numcodes, unsigned maxbitlen);
807
808 /*Compress a buffer with deflate. See RFC 1951. Out buffer must be freed after use.*/
809 unsigned lodepng_deflate(unsigned char** out, size_t* outsize,
810 const unsigned char* in, size_t insize,
811 const LodePNGCompressSettings* settings);
812
813 #endif /*LODEPNG_COMPILE_ENCODER*/
814 #endif /*LODEPNG_COMPILE_ZLIB*/
815
816 #ifdef LODEPNG_COMPILE_DISK
817 /*
818 Load a file from disk into buffer. The function allocates the out buffer, and
819 after usage you should free it.
820 out: output parameter, contains pointer to loaded buffer.
821 outsize: output parameter, size of the allocated out buffer
822 filename: the path to the file to load
823 return value: error code (0 means ok)
824 */
825 unsigned lodepng_load_file(unsigned char** out, size_t* outsize, const char* filename);
826
827 /*
828 Save a file from buffer to disk. Warning, if it exists, this function overwrites
829 the file without warning!
830 buffer: the buffer to write
831 buffersize: size of the buffer to write
832 filename: the path to the file to save to
833 return value: error code (0 means ok)
834 */
835 unsigned lodepng_save_file(const unsigned char* buffer, size_t buffersize, const char* filename);
836 #endif /*LODEPNG_COMPILE_DISK*/
837
838 #ifdef LODEPNG_COMPILE_CPP
839 /* The LodePNG C++ wrapper uses std::vectors instead of manually allocated memory buffers. */
840 namespace lodepng
841 {
842 #ifdef LODEPNG_COMPILE_PNG
843 class State : public LodePNGState
844 {
845 public:
846 State();
847 State(const State& other);
848 virtual ~State();
849 State& operator=(const State& other);
850 };
851
852 #ifdef LODEPNG_COMPILE_DECODER
853 /* Same as other lodepng::decode, but using a State for more settings and information. */
854 unsigned decode(std::vector<unsigned char>& out, unsigned& w, unsigned& h,
855 State& state,
856 const unsigned char* in, size_t insize);
857 unsigned decode(std::vector<unsigned char>& out, unsigned& w, unsigned& h,
858 State& state,
859 const std::vector<unsigned char>& in);
860 #endif /*LODEPNG_COMPILE_DECODER*/
861
862 #ifdef LODEPNG_COMPILE_ENCODER
863 /* Same as other lodepng::encode, but using a State for more settings and information. */
864 unsigned encode(std::vector<unsigned char>& out,
865 const unsigned char* in, unsigned w, unsigned h,
866 State& state);
867 unsigned encode(std::vector<unsigned char>& out,
868 const std::vector<unsigned char>& in, unsigned w, unsigned h,
869 State& state);
870 #endif /*LODEPNG_COMPILE_ENCODER*/
871
872 #ifdef LODEPNG_COMPILE_DISK
873 /*
874 Load a file from disk into an std::vector. If the vector is empty, then either
875 the file doesn't exist or is an empty file.
876 */
877 void load_file(std::vector<unsigned char>& buffer, const std::string& filename);
878
879 /*
880 Save the binary data in an std::vector to a file on disk. The file is overwritten
881 without warning.
882 */
883 unsigned save_file(const std::vector<unsigned char>& buffer, const std::string& filename);
884 #endif /* LODEPNG_COMPILE_DISK */
885 #endif /* LODEPNG_COMPILE_PNG */
886
887 #ifdef LODEPNG_COMPILE_ZLIB
888 #ifdef LODEPNG_COMPILE_DECODER
889 /* Zlib-decompress an unsigned char buffer */
890 unsigned decompress(std::vector<unsigned char>& out, const unsigned char* in, size_t insize,
891 const LodePNGDecompressSettings& settings = lodepng_default_decompress_settings);
892
893 /* Zlib-decompress an std::vector */
894 unsigned decompress(std::vector<unsigned char>& out, const std::vector<unsigned char>& in,
895 const LodePNGDecompressSettings& settings = lodepng_default_decompress_settings);
896 #endif /* LODEPNG_COMPILE_DECODER */
897
898 #ifdef LODEPNG_COMPILE_ENCODER
899 /* Zlib-compress an unsigned char buffer */
900 unsigned compress(std::vector<unsigned char>& out, const unsigned char* in, size_t insize,
901 const LodePNGCompressSettings& settings = lodepng_default_compress_settings);
902
903 /* Zlib-compress an std::vector */
904 unsigned compress(std::vector<unsigned char>& out, const std::vector<unsigned char>& in,
905 const LodePNGCompressSettings& settings = lodepng_default_compress_settings);
906 #endif /* LODEPNG_COMPILE_ENCODER */
907 #endif /* LODEPNG_COMPILE_ZLIB */
908 } /* namespace lodepng */
909 #endif /*LODEPNG_COMPILE_CPP*/
910
911 /*
912 TODO:
913 [.] test if there are no memory leaks or security exploits - done a lot but needs to be checked often
914 [.] check compatibility with various compilers - done but needs to be redone for every newer version
915 [X] converting color to 16-bit per channel types
916 [ ] read all public PNG chunk types (but never let the color profile and gamma ones touch RGB values)
917 [ ] make sure encoder generates no chunks with size > (2^31)-1
918 [ ] partial decoding (stream processing)
919 [X] let the "isFullyOpaque" function check color keys and transparent palettes too
920 [X] better name for the variables "codes", "codesD", "codelengthcodes", "clcl" and "lldl"
921 [ ] don't stop decoding on errors like 69, 57, 58 (make warnings)
922 [ ] let the C++ wrapper catch exceptions coming from the standard library and return LodePNG error codes
923 [ ] allow user to provide custom color conversion functions, e.g. for premultiplied alpha, padding bits or not, ...
924 */
925
926 #endif /*LODEPNG_H inclusion guard*/
927
928 /*
929 LodePNG Documentation
930 ---------------------
931
932 0. table of contents
933 --------------------
934
935 1. about
936 1.1. supported features
937 1.2. features not supported
938 2. C and C++ version
939 3. security
940 4. decoding
941 5. encoding
942 6. color conversions
943 6.1. PNG color types
944 6.2. color conversions
945 6.3. padding bits
946 6.4. A note about 16-bits per channel and endianness
947 7. error values
948 8. chunks and PNG editing
949 9. compiler support
950 10. examples
951 10.1. decoder C++ example
952 10.2. decoder C example
953 11. changes
954 12. contact information
955
956
957 1. about
958 --------
959
960 PNG is a file format to store raster images losslessly with good compression,
961 supporting different color types and alpha channel.
962
963 LodePNG is a PNG codec according to the Portable Network Graphics (PNG)
964 Specification (Second Edition) - W3C Recommendation 10 November 2003.
965
966 The specifications used are:
967
968 *) Portable Network Graphics (PNG) Specification (Second Edition):
969 http://www.w3.org/TR/2003/REC-PNG-20031110
970 *) RFC 1950 ZLIB Compressed Data Format version 3.3:
971 http://www.gzip.org/zlib/rfc-zlib.html
972 *) RFC 1951 DEFLATE Compressed Data Format Specification ver 1.3:
973 http://www.gzip.org/zlib/rfc-deflate.html
974
975 The most recent version of LodePNG can currently be found at
976 http://lodev.org/lodepng/
977
978 LodePNG works both in C (ISO C90) and C++, with a C++ wrapper that adds
979 extra functionality.
980
981 LodePNG exists out of two files:
982 -lodepng.h: the header file for both C and C++
983 -lodepng.c(pp): give it the name lodepng.c or lodepng.cpp (or .cc) depending on your usage
984
985 If you want to start using LodePNG right away without reading this doc, get the
986 examples from the LodePNG website to see how to use it in code, or check the
987 smaller examples in chapter 13 here.
988
989 LodePNG is simple but only supports the basic requirements. To achieve
990 simplicity, the following design choices were made: There are no dependencies
991 on any external library. There are functions to decode and encode a PNG with
992 a single function call, and extended versions of these functions taking a
993 LodePNGState struct allowing to specify or get more information. By default
994 the colors of the raw image are always RGB or RGBA, no matter what color type
995 the PNG file uses. To read and write files, there are simple functions to
996 convert the files to/from buffers in memory.
997
998 This all makes LodePNG suitable for loading textures in games, demos and small
999 programs, ... It's less suitable for full fledged image editors, loading PNGs
1000 over network (it requires all the image data to be available before decoding can
1001 begin), life-critical systems, ...
1002
1003 1.1. supported features
1004 -----------------------
1005
1006 The following features are supported by the decoder:
1007
1008 *) decoding of PNGs with any color type, bit depth and interlace mode, to a 24- or 32-bit color raw image,
1009 or the same color type as the PNG
1010 *) encoding of PNGs, from any raw image to 24- or 32-bit color, or the same color type as the raw image
1011 *) Adam7 interlace and deinterlace for any color type
1012 *) loading the image from harddisk or decoding it from a buffer from other sources than harddisk
1013 *) support for alpha channels, including RGBA color model, translucent palettes and color keying
1014 *) zlib decompression (inflate)
1015 *) zlib compression (deflate)
1016 *) CRC32 and ADLER32 checksums
1017 *) handling of unknown chunks, allowing making a PNG editor that stores custom and unknown chunks.
1018 *) the following chunks are supported (generated/interpreted) by both encoder and decoder:
1019 IHDR: header information
1020 PLTE: color palette
1021 IDAT: pixel data
1022 IEND: the final chunk
1023 tRNS: transparency for palettized images
1024 tEXt: textual information
1025 zTXt: compressed textual information
1026 iTXt: international textual information
1027 bKGD: suggested background color
1028 pHYs: physical dimensions
1029 tIME: modification time
1030
1031 1.2. features not supported
1032 ---------------------------
1033
1034 The following features are _not_ supported:
1035
1036 *) some features needed to make a conformant PNG-Editor might be still missing.
1037 *) partial loading/stream processing. All data must be available and is processed in one call.
1038 *) The following public chunks are not supported but treated as unknown chunks by LodePNG
1039 cHRM, gAMA, iCCP, sRGB, sBIT, hIST, sPLT
1040 Some of these are not supported on purpose: LodePNG wants to provide the RGB values
1041 stored in the pixels, not values modified by system dependent gamma or color models.
1042
1043
1044 2. C and C++ version
1045 --------------------
1046
1047 The C version uses buffers allocated with alloc that you need to free()
1048 yourself. You need to use init and cleanup functions for each struct whenever
1049 using a struct from the C version to avoid exploits and memory leaks.
1050
1051 The C++ version has extra functions with std::vectors in the interface and the
1052 lodepng::State class which is a LodePNGState with constructor and destructor.
1053
1054 These files work without modification for both C and C++ compilers because all
1055 the additional C++ code is in "#ifdef __cplusplus" blocks that make C-compilers
1056 ignore it, and the C code is made to compile both with strict ISO C90 and C++.
1057
1058 To use the C++ version, you need to rename the source file to lodepng.cpp
1059 (instead of lodepng.c), and compile it with a C++ compiler.
1060
1061 To use the C version, you need to rename the source file to lodepng.c (instead
1062 of lodepng.cpp), and compile it with a C compiler.
1063
1064
1065 3. Security
1066 -----------
1067
1068 Even if carefully designed, it's always possible that LodePNG contains possible
1069 exploits. If you discover one, please let me know, and it will be fixed.
1070
1071 When using LodePNG, care has to be taken with the C version of LodePNG, as well
1072 as the C-style structs when working with C++. The following conventions are used
1073 for all C-style structs:
1074
1075 -if a struct has a corresponding init function, always call the init function when making a new one
1076 -if a struct has a corresponding cleanup function, call it before the struct disappears to avoid memory leaks
1077 -if a struct has a corresponding copy function, use the copy function instead of "=".
1078 The destination must also be inited already.
1079
1080
1081 4. Decoding
1082 -----------
1083
1084 Decoding converts a PNG compressed image to a raw pixel buffer.
1085
1086 Most documentation on using the decoder is at its declarations in the header
1087 above. For C, simple decoding can be done with functions such as
1088 lodepng_decode32, and more advanced decoding can be done with the struct
1089 LodePNGState and lodepng_decode. For C++, all decoding can be done with the
1090 various lodepng::decode functions, and lodepng::State can be used for advanced
1091 features.
1092
1093 When using the LodePNGState, it uses the following fields for decoding:
1094 *) LodePNGInfo info_png: it stores extra information about the PNG (the input) in here
1095 *) LodePNGColorMode info_raw: here you can say what color mode of the raw image (the output) you want to get
1096 *) LodePNGDecoderSettings decoder: you can specify a few extra settings for the decoder to use
1097
1098 LodePNGInfo info_png
1099 --------------------
1100
1101 After decoding, this contains extra information of the PNG image, except the actual
1102 pixels, width and height because these are already gotten directly from the decoder
1103 functions.
1104
1105 It contains for example the original color type of the PNG image, text comments,
1106 suggested background color, etc... More details about the LodePNGInfo struct are
1107 at its declaration documentation.
1108
1109 LodePNGColorMode info_raw
1110 -------------------------
1111
1112 When decoding, here you can specify which color type you want
1113 the resulting raw image to be. If this is different from the colortype of the
1114 PNG, then the decoder will automatically convert the result. This conversion
1115 always works, except if you want it to convert a color PNG to greyscale or to
1116 a palette with missing colors.
1117
1118 By default, 32-bit color is used for the result.
1119
1120 LodePNGDecoderSettings decoder
1121 ------------------------------
1122
1123 The settings can be used to ignore the errors created by invalid CRC and Adler32
1124 chunks, and to disable the decoding of tEXt chunks.
1125
1126 There's also a setting color_convert, true by default. If false, no conversion
1127 is done, the resulting data will be as it was in the PNG (after decompression)
1128 and you'll have to puzzle the colors of the pixels together yourself using the
1129 color type information in the LodePNGInfo.
1130
1131
1132 5. Encoding
1133 -----------
1134
1135 Encoding converts a raw pixel buffer to a PNG compressed image.
1136
1137 Most documentation on using the encoder is at its declarations in the header
1138 above. For C, simple encoding can be done with functions such as
1139 lodepng_encode32, and more advanced decoding can be done with the struct
1140 LodePNGState and lodepng_encode. For C++, all encoding can be done with the
1141 various lodepng::encode functions, and lodepng::State can be used for advanced
1142 features.
1143
1144 Like the decoder, the encoder can also give errors. However it gives less errors
1145 since the encoder input is trusted, the decoder input (a PNG image that could
1146 be forged by anyone) is not trusted.
1147
1148 When using the LodePNGState, it uses the following fields for encoding:
1149 *) LodePNGInfo info_png: here you specify how you want the PNG (the output) to be.
1150 *) LodePNGColorMode info_raw: here you say what color type of the raw image (the input) has
1151 *) LodePNGEncoderSettings encoder: you can specify a few settings for the encoder to use
1152
1153 LodePNGInfo info_png
1154 --------------------
1155
1156 When encoding, you use this the opposite way as when decoding: for encoding,
1157 you fill in the values you want the PNG to have before encoding. By default it's
1158 not needed to specify a color type for the PNG since it's automatically chosen,
1159 but it's possible to choose it yourself given the right settings.
1160
1161 The encoder will not always exactly match the LodePNGInfo struct you give,
1162 it tries as close as possible. Some things are ignored by the encoder. The
1163 encoder uses, for example, the following settings from it when applicable:
1164 colortype and bitdepth, text chunks, time chunk, the color key, the palette, the
1165 background color, the interlace method, unknown chunks, ...
1166
1167 When encoding to a PNG with colortype 3, the encoder will generate a PLTE chunk.
1168 If the palette contains any colors for which the alpha channel is not 255 (so
1169 there are translucent colors in the palette), it'll add a tRNS chunk.
1170
1171 LodePNGColorMode info_raw
1172 -------------------------
1173
1174 You specify the color type of the raw image that you give to the input here,
1175 including a possible transparent color key and palette you happen to be using in
1176 your raw image data.
1177
1178 By default, 32-bit color is assumed, meaning your input has to be in RGBA
1179 format with 4 bytes (unsigned chars) per pixel.
1180
1181 LodePNGEncoderSettings encoder
1182 ------------------------------
1183
1184 The following settings are supported (some are in sub-structs):
1185 *) auto_convert: when this option is enabled, the encoder will
1186 automatically choose the smallest possible color mode (including color key) that
1187 can encode the colors of all pixels without information loss.
1188 *) btype: the block type for LZ77. 0 = uncompressed, 1 = fixed huffman tree,
1189 2 = dynamic huffman tree (best compression). Should be 2 for proper
1190 compression.
1191 *) use_lz77: whether or not to use LZ77 for compressed block types. Should be
1192 true for proper compression.
1193 *) windowsize: the window size used by the LZ77 encoder (1 - 32768). Has value
1194 2048 by default, but can be set to 32768 for better, but slow, compression.
1195 *) force_palette: if colortype is 2 or 6, you can make the encoder write a PLTE
1196 chunk if force_palette is true. This can used as suggested palette to convert
1197 to by viewers that don't support more than 256 colors (if those still exist)
1198 *) add_id: add text chunk "Encoder: LodePNG <version>" to the image.
1199 *) text_compression: default 1. If 1, it'll store texts as zTXt instead of tEXt chunks.
1200 zTXt chunks use zlib compression on the text. This gives a smaller result on
1201 large texts but a larger result on small texts (such as a single program name).
1202 It's all tEXt or all zTXt though, there's no separate setting per text yet.
1203
1204
1205 6. color conversions
1206 --------------------
1207
1208 An important thing to note about LodePNG, is that the color type of the PNG, and
1209 the color type of the raw image, are completely independent. By default, when
1210 you decode a PNG, you get the result as a raw image in the color type you want,
1211 no matter whether the PNG was encoded with a palette, greyscale or RGBA color.
1212 And if you encode an image, by default LodePNG will automatically choose the PNG
1213 color type that gives good compression based on the values of colors and amount
1214 of colors in the image. It can be configured to let you control it instead as
1215 well, though.
1216
1217 To be able to do this, LodePNG does conversions from one color mode to another.
1218 It can convert from almost any color type to any other color type, except the
1219 following conversions: RGB to greyscale is not supported, and converting to a
1220 palette when the palette doesn't have a required color is not supported. This is
1221 not supported on purpose: this is information loss which requires a color
1222 reduction algorithm that is beyong the scope of a PNG encoder (yes, RGB to grey
1223 is easy, but there are multiple ways if you want to give some channels more
1224 weight).
1225
1226 By default, when decoding, you get the raw image in 32-bit RGBA or 24-bit RGB
1227 color, no matter what color type the PNG has. And by default when encoding,
1228 LodePNG automatically picks the best color model for the output PNG, and expects
1229 the input image to be 32-bit RGBA or 24-bit RGB. So, unless you want to control
1230 the color format of the images yourself, you can skip this chapter.
1231
1232 6.1. PNG color types
1233 --------------------
1234
1235 A PNG image can have many color types, ranging from 1-bit color to 64-bit color,
1236 as well as palettized color modes. After the zlib decompression and unfiltering
1237 in the PNG image is done, the raw pixel data will have that color type and thus
1238 a certain amount of bits per pixel. If you want the output raw image after
1239 decoding to have another color type, a conversion is done by LodePNG.
1240
1241 The PNG specification gives the following color types:
1242
1243 0: greyscale, bit depths 1, 2, 4, 8, 16
1244 2: RGB, bit depths 8 and 16
1245 3: palette, bit depths 1, 2, 4 and 8
1246 4: greyscale with alpha, bit depths 8 and 16
1247 6: RGBA, bit depths 8 and 16
1248
1249 Bit depth is the amount of bits per pixel per color channel. So the total amount
1250 of bits per pixel is: amount of channels * bitdepth.
1251
1252 6.2. color conversions
1253 ----------------------
1254
1255 As explained in the sections about the encoder and decoder, you can specify
1256 color types and bit depths in info_png and info_raw to change the default
1257 behaviour.
1258
1259 If, when decoding, you want the raw image to be something else than the default,
1260 you need to set the color type and bit depth you want in the LodePNGColorMode,
1261 or the parameters colortype and bitdepth of the simple decoding function.
1262
1263 If, when encoding, you use another color type than the default in the raw input
1264 image, you need to specify its color type and bit depth in the LodePNGColorMode
1265 of the raw image, or use the parameters colortype and bitdepth of the simple
1266 encoding function.
1267
1268 If, when encoding, you don't want LodePNG to choose the output PNG color type
1269 but control it yourself, you need to set auto_convert in the encoder settings
1270 to false, and specify the color type you want in the LodePNGInfo of the
1271 encoder (including palette: it can generate a palette if auto_convert is true,
1272 otherwise not).
1273
1274 If the input and output color type differ (whether user chosen or auto chosen),
1275 LodePNG will do a color conversion, which follows the rules below, and may
1276 sometimes result in an error.
1277
1278 To avoid some confusion:
1279 -the decoder converts from PNG to raw image
1280 -the encoder converts from raw image to PNG
1281 -the colortype and bitdepth in LodePNGColorMode info_raw, are those of the raw image
1282 -the colortype and bitdepth in the color field of LodePNGInfo info_png, are those of the PNG
1283 -when encoding, the color type in LodePNGInfo is ignored if auto_convert
1284 is enabled, it is automatically generated instead
1285 -when decoding, the color type in LodePNGInfo is set by the decoder to that of the original
1286 PNG image, but it can be ignored since the raw image has the color type you requested instead
1287 -if the color type of the LodePNGColorMode and PNG image aren't the same, a conversion
1288 between the color types is done if the color types are supported. If it is not
1289 supported, an error is returned. If the types are the same, no conversion is done.
1290 -even though some conversions aren't supported, LodePNG supports loading PNGs from any
1291 colortype and saving PNGs to any colortype, sometimes it just requires preparing
1292 the raw image correctly before encoding.
1293 -both encoder and decoder use the same color converter.
1294
1295 Non supported color conversions:
1296 -color to greyscale: no error is thrown, but the result will look ugly because
1297 only the red channel is taken
1298 -anything to palette when that palette does not have that color in it: in this
1299 case an error is thrown
1300
1301 Supported color conversions:
1302 -anything to 8-bit RGB, 8-bit RGBA, 16-bit RGB, 16-bit RGBA
1303 -any grey or grey+alpha, to grey or grey+alpha
1304 -anything to a palette, as long as the palette has the requested colors in it
1305 -removing alpha channel
1306 -higher to smaller bitdepth, and vice versa
1307
1308 If you want no color conversion to be done (e.g. for speed or control):
1309 -In the encoder, you can make it save a PNG with any color type by giving the
1310 raw color mode and LodePNGInfo the same color mode, and setting auto_convert to
1311 false.
1312 -In the decoder, you can make it store the pixel data in the same color type
1313 as the PNG has, by setting the color_convert setting to false. Settings in
1314 info_raw are then ignored.
1315
1316 The function lodepng_convert does the color conversion. It is available in the
1317 interface but normally isn't needed since the encoder and decoder already call
1318 it.
1319
1320 6.3. padding bits
1321 -----------------
1322
1323 In the PNG file format, if a less than 8-bit per pixel color type is used and the scanlines
1324 have a bit amount that isn't a multiple of 8, then padding bits are used so that each
1325 scanline starts at a fresh byte. But that is NOT true for the LodePNG raw input and output.
1326 The raw input image you give to the encoder, and the raw output image you get from the decoder
1327 will NOT have these padding bits, e.g. in the case of a 1-bit image with a width
1328 of 7 pixels, the first pixel of the second scanline will the the 8th bit of the first byte,
1329 not the first bit of a new byte.
1330
1331 6.4. A note about 16-bits per channel and endianness
1332 ----------------------------------------------------
1333
1334 LodePNG uses unsigned char arrays for 16-bit per channel colors too, just like
1335 for any other color format. The 16-bit values are stored in big endian (most
1336 significant byte first) in these arrays. This is the opposite order of the
1337 little endian used by x86 CPU's.
1338
1339 LodePNG always uses big endian because the PNG file format does so internally.
1340 Conversions to other formats than PNG uses internally are not supported by
1341 LodePNG on purpose, there are myriads of formats, including endianness of 16-bit
1342 colors, the order in which you store R, G, B and A, and so on. Supporting and
1343 converting to/from all that is outside the scope of LodePNG.
1344
1345 This may mean that, depending on your use case, you may want to convert the big
1346 endian output of LodePNG to little endian with a for loop. This is certainly not
1347 always needed, many applications and libraries support big endian 16-bit colors
1348 anyway, but it means you cannot simply cast the unsigned char* buffer to an
1349 unsigned short* buffer on x86 CPUs.
1350
1351
1352 7. error values
1353 ---------------
1354
1355 All functions in LodePNG that return an error code, return 0 if everything went
1356 OK, or a non-zero code if there was an error.
1357
1358 The meaning of the LodePNG error values can be retrieved with the function
1359 lodepng_error_text: given the numerical error code, it returns a description
1360 of the error in English as a string.
1361
1362 Check the implementation of lodepng_error_text to see the meaning of each code.
1363
1364
1365 8. chunks and PNG editing
1366 -------------------------
1367
1368 If you want to add extra chunks to a PNG you encode, or use LodePNG for a PNG
1369 editor that should follow the rules about handling of unknown chunks, or if your
1370 program is able to read other types of chunks than the ones handled by LodePNG,
1371 then that's possible with the chunk functions of LodePNG.
1372
1373 A PNG chunk has the following layout:
1374
1375 4 bytes length
1376 4 bytes type name
1377 length bytes data
1378 4 bytes CRC
1379
1380 8.1. iterating through chunks
1381 -----------------------------
1382
1383 If you have a buffer containing the PNG image data, then the first chunk (the
1384 IHDR chunk) starts at byte number 8 of that buffer. The first 8 bytes are the
1385 signature of the PNG and are not part of a chunk. But if you start at byte 8
1386 then you have a chunk, and can check the following things of it.
1387
1388 NOTE: none of these functions check for memory buffer boundaries. To avoid
1389 exploits, always make sure the buffer contains all the data of the chunks.
1390 When using lodepng_chunk_next, make sure the returned value is within the
1391 allocated memory.
1392
1393 unsigned lodepng_chunk_length(const unsigned char* chunk):
1394
1395 Get the length of the chunk's data. The total chunk length is this length + 12.
1396
1397 void lodepng_chunk_type(char type[5], const unsigned char* chunk):
1398 unsigned char lodepng_chunk_type_equals(const unsigned char* chunk, const char* type):
1399
1400 Get the type of the chunk or compare if it's a certain type
1401
1402 unsigned char lodepng_chunk_critical(const unsigned char* chunk):
1403 unsigned char lodepng_chunk_private(const unsigned char* chunk):
1404 unsigned char lodepng_chunk_safetocopy(const unsigned char* chunk):
1405
1406 Check if the chunk is critical in the PNG standard (only IHDR, PLTE, IDAT and IEND are).
1407 Check if the chunk is private (public chunks are part of the standard, private ones not).
1408 Check if the chunk is safe to copy. If it's not, then, when modifying data in a critical
1409 chunk, unsafe to copy chunks of the old image may NOT be saved in the new one if your
1410 program doesn't handle that type of unknown chunk.
1411
1412 unsigned char* lodepng_chunk_data(unsigned char* chunk):
1413 const unsigned char* lodepng_chunk_data_const(const unsigned char* chunk):
1414
1415 Get a pointer to the start of the data of the chunk.
1416
1417 unsigned lodepng_chunk_check_crc(const unsigned char* chunk):
1418 void lodepng_chunk_generate_crc(unsigned char* chunk):
1419
1420 Check if the crc is correct or generate a correct one.
1421
1422 unsigned char* lodepng_chunk_next(unsigned char* chunk):
1423 const unsigned char* lodepng_chunk_next_const(const unsigned char* chunk):
1424
1425 Iterate to the next chunk. This works if you have a buffer with consecutive chunks. Note that these
1426 functions do no boundary checking of the allocated data whatsoever, so make sure there is enough
1427 data available in the buffer to be able to go to the next chunk.
1428
1429 unsigned lodepng_chunk_append(unsigned char** out, size_t* outlength, const unsigned char* chunk):
1430 unsigned lodepng_chunk_create(unsigned char** out, size_t* outlength, unsigned length,
1431 const char* type, const unsigned char* data):
1432
1433 These functions are used to create new chunks that are appended to the data in *out that has
1434 length *outlength. The append function appends an existing chunk to the new data. The create
1435 function creates a new chunk with the given parameters and appends it. Type is the 4-letter
1436 name of the chunk.
1437
1438 8.2. chunks in info_png
1439 -----------------------
1440
1441 The LodePNGInfo struct contains fields with the unknown chunk in it. It has 3
1442 buffers (each with size) to contain 3 types of unknown chunks:
1443 the ones that come before the PLTE chunk, the ones that come between the PLTE
1444 and the IDAT chunks, and the ones that come after the IDAT chunks.
1445 It's necessary to make the distionction between these 3 cases because the PNG
1446 standard forces to keep the ordering of unknown chunks compared to the critical
1447 chunks, but does not force any other ordering rules.
1448
1449 info_png.unknown_chunks_data[0] is the chunks before PLTE
1450 info_png.unknown_chunks_data[1] is the chunks after PLTE, before IDAT
1451 info_png.unknown_chunks_data[2] is the chunks after IDAT
1452
1453 The chunks in these 3 buffers can be iterated through and read by using the same
1454 way described in the previous subchapter.
1455
1456 When using the decoder to decode a PNG, you can make it store all unknown chunks
1457 if you set the option settings.remember_unknown_chunks to 1. By default, this
1458 option is off (0).
1459
1460 The encoder will always encode unknown chunks that are stored in the info_png.
1461 If you need it to add a particular chunk that isn't known by LodePNG, you can
1462 use lodepng_chunk_append or lodepng_chunk_create to the chunk data in
1463 info_png.unknown_chunks_data[x].
1464
1465 Chunks that are known by LodePNG should not be added in that way. E.g. to make
1466 LodePNG add a bKGD chunk, set background_defined to true and add the correct
1467 parameters there instead.
1468
1469
1470 9. compiler support
1471 -------------------
1472
1473 No libraries other than the current standard C library are needed to compile
1474 LodePNG. For the C++ version, only the standard C++ library is needed on top.
1475 Add the files lodepng.c(pp) and lodepng.h to your project, include
1476 lodepng.h where needed, and your program can read/write PNG files.
1477
1478 It is compatible with C90 and up, and C++03 and up.
1479
1480 If performance is important, use optimization when compiling! For both the
1481 encoder and decoder, this makes a large difference.
1482
1483 Make sure that LodePNG is compiled with the same compiler of the same version
1484 and with the same settings as the rest of the program, or the interfaces with
1485 std::vectors and std::strings in C++ can be incompatible.
1486
1487 CHAR_BITS must be 8 or higher, because LodePNG uses unsigned chars for octets.
1488
1489 *) gcc and g++
1490
1491 LodePNG is developed in gcc so this compiler is natively supported. It gives no
1492 warnings with compiler options "-Wall -Wextra -pedantic -ansi", with gcc and g++
1493 version 4.7.1 on Linux, 32-bit and 64-bit.
1494
1495 *) Clang
1496
1497 Fully supported and warning-free.
1498
1499 *) Mingw
1500
1501 The Mingw compiler (a port of gcc for Windows) should be fully supported by
1502 LodePNG.
1503
1504 *) Visual Studio and Visual C++ Express Edition
1505
1506 LodePNG should be warning-free with warning level W4. Two warnings were disabled
1507 with pragmas though: warning 4244 about implicit conversions, and warning 4996
1508 where it wants to use a non-standard function fopen_s instead of the standard C
1509 fopen.
1510
1511 Visual Studio may want "stdafx.h" files to be included in each source file and
1512 give an error "unexpected end of file while looking for precompiled header".
1513 This is not standard C++ and will not be added to the stock LodePNG. You can
1514 disable it for lodepng.cpp only by right clicking it, Properties, C/C++,
1515 Precompiled Headers, and set it to Not Using Precompiled Headers there.
1516
1517 NOTE: Modern versions of VS should be fully supported, but old versions, e.g.
1518 VS6, are not guaranteed to work.
1519
1520 *) Compilers on Macintosh
1521
1522 LodePNG has been reported to work both with gcc and LLVM for Macintosh, both for
1523 C and C++.
1524
1525 *) Other Compilers
1526
1527 If you encounter problems on any compilers, feel free to let me know and I may
1528 try to fix it if the compiler is modern and standards complient.
1529
1530
1531 10. examples
1532 ------------
1533
1534 This decoder example shows the most basic usage of LodePNG. More complex
1535 examples can be found on the LodePNG website.
1536
1537 10.1. decoder C++ example
1538 -------------------------
1539
1540 #include "lodepng.h"
1541 #include <iostream>
1542
1543 int main(int argc, char *argv[])
1544 {
1545 const char* filename = argc > 1 ? argv[1] : "test.png";
1546
1547 //load and decode
1548 std::vector<unsigned char> image;
1549 unsigned width, height;
1550 unsigned error = lodepng::decode(image, width, height, filename);
1551
1552 //if there's an error, display it
1553 if(error) std::cout << "decoder error " << error << ": " << lodepng_error_text(error) << std::endl;
1554
1555 //the pixels are now in the vector "image", 4 bytes per pixel, ordered RGBARGBA..., use it as texture, draw it, ...
1556 }
1557
1558 10.2. decoder C example
1559 -----------------------
1560
1561 #include "lodepng.h"
1562
1563 int main(int argc, char *argv[])
1564 {
1565 unsigned error;
1566 unsigned char* image;
1567 size_t width, height;
1568 const char* filename = argc > 1 ? argv[1] : "test.png";
1569
1570 error = lodepng_decode32_file(&image, &width, &height, filename);
1571
1572 if(error) printf("decoder error %u: %s\n", error, lodepng_error_text(error));
1573
1574 / * use image here * /
1575
1576 free(image);
1577 return 0;
1578 }
1579
1580
1581 11. changes
1582 -----------
1583
1584 The version number of LodePNG is the date of the change given in the format
1585 yyyymmdd.
1586
1587 Some changes aren't backwards compatible. Those are indicated with a (!)
1588 symbol.
1589
1590 *) 24 okt 2015: Bugfix with decoding to palette output.
1591 *) 18 apr 2015: Boundary PM instead of just package-merge for faster encoding.
1592 *) 23 aug 2014: Reduced needless memory usage of decoder.
1593 *) 28 jun 2014: Removed fix_png setting, always support palette OOB for
1594 simplicity. Made ColorProfile public.
1595 *) 09 jun 2014: Faster encoder by fixing hash bug and more zeros optimization.
1596 *) 22 dec 2013: Power of two windowsize required for optimization.
1597 *) 15 apr 2013: Fixed bug with LAC_ALPHA and color key.
1598 *) 25 mar 2013: Added an optional feature to ignore some PNG errors (fix_png).
1599 *) 11 mar 2013 (!): Bugfix with custom free. Changed from "my" to "lodepng_"
1600 prefix for the custom allocators and made it possible with a new #define to
1601 use custom ones in your project without needing to change lodepng's code.
1602 *) 28 jan 2013: Bugfix with color key.
1603 *) 27 okt 2012: Tweaks in text chunk keyword length error handling.
1604 *) 8 okt 2012 (!): Added new filter strategy (entropy) and new auto color mode.
1605 (no palette). Better deflate tree encoding. New compression tweak settings.
1606 Faster color conversions while decoding. Some internal cleanups.
1607 *) 23 sep 2012: Reduced warnings in Visual Studio a little bit.
1608 *) 1 sep 2012 (!): Removed #define's for giving custom (de)compression functions
1609 and made it work with function pointers instead.
1610 *) 23 jun 2012: Added more filter strategies. Made it easier to use custom alloc
1611 and free functions and toggle #defines from compiler flags. Small fixes.
1612 *) 6 may 2012 (!): Made plugging in custom zlib/deflate functions more flexible.
1613 *) 22 apr 2012 (!): Made interface more consistent, renaming a lot. Removed
1614 redundant C++ codec classes. Reduced amount of structs. Everything changed,
1615 but it is cleaner now imho and functionality remains the same. Also fixed
1616 several bugs and shrunk the implementation code. Made new samples.
1617 *) 6 nov 2011 (!): By default, the encoder now automatically chooses the best
1618 PNG color model and bit depth, based on the amount and type of colors of the
1619 raw image. For this, autoLeaveOutAlphaChannel replaced by auto_choose_color.
1620 *) 9 okt 2011: simpler hash chain implementation for the encoder.
1621 *) 8 sep 2011: lz77 encoder lazy matching instead of greedy matching.
1622 *) 23 aug 2011: tweaked the zlib compression parameters after benchmarking.
1623 A bug with the PNG filtertype heuristic was fixed, so that it chooses much
1624 better ones (it's quite significant). A setting to do an experimental, slow,
1625 brute force search for PNG filter types is added.
1626 *) 17 aug 2011 (!): changed some C zlib related function names.
1627 *) 16 aug 2011: made the code less wide (max 120 characters per line).
1628 *) 17 apr 2011: code cleanup. Bugfixes. Convert low to 16-bit per sample colors.
1629 *) 21 feb 2011: fixed compiling for C90. Fixed compiling with sections disabled.
1630 *) 11 dec 2010: encoding is made faster, based on suggestion by Peter Eastman
1631 to optimize long sequences of zeros.
1632 *) 13 nov 2010: added LodePNG_InfoColor_hasPaletteAlpha and
1633 LodePNG_InfoColor_canHaveAlpha functions for convenience.
1634 *) 7 nov 2010: added LodePNG_error_text function to get error code description.
1635 *) 30 okt 2010: made decoding slightly faster
1636 *) 26 okt 2010: (!) changed some C function and struct names (more consistent).
1637 Reorganized the documentation and the declaration order in the header.
1638 *) 08 aug 2010: only changed some comments and external samples.
1639 *) 05 jul 2010: fixed bug thanks to warnings in the new gcc version.
1640 *) 14 mar 2010: fixed bug where too much memory was allocated for char buffers.
1641 *) 02 sep 2008: fixed bug where it could create empty tree that linux apps could
1642 read by ignoring the problem but windows apps couldn't.
1643 *) 06 jun 2008: added more error checks for out of memory cases.
1644 *) 26 apr 2008: added a few more checks here and there to ensure more safety.
1645 *) 06 mar 2008: crash with encoding of strings fixed
1646 *) 02 feb 2008: support for international text chunks added (iTXt)
1647 *) 23 jan 2008: small cleanups, and #defines to divide code in sections
1648 *) 20 jan 2008: support for unknown chunks allowing using LodePNG for an editor.
1649 *) 18 jan 2008: support for tIME and pHYs chunks added to encoder and decoder.
1650 *) 17 jan 2008: ability to encode and decode compressed zTXt chunks added
1651 Also various fixes, such as in the deflate and the padding bits code.
1652 *) 13 jan 2008: Added ability to encode Adam7-interlaced images. Improved
1653 filtering code of encoder.
1654 *) 07 jan 2008: (!) changed LodePNG to use ISO C90 instead of C++. A
1655 C++ wrapper around this provides an interface almost identical to before.
1656 Having LodePNG be pure ISO C90 makes it more portable. The C and C++ code
1657 are together in these files but it works both for C and C++ compilers.
1658 *) 29 dec 2007: (!) changed most integer types to unsigned int + other tweaks
1659 *) 30 aug 2007: bug fixed which makes this Borland C++ compatible
1660 *) 09 aug 2007: some VS2005 warnings removed again
1661 *) 21 jul 2007: deflate code placed in new namespace separate from zlib code
1662 *) 08 jun 2007: fixed bug with 2- and 4-bit color, and small interlaced images
1663 *) 04 jun 2007: improved support for Visual Studio 2005: crash with accessing
1664 invalid std::vector element [0] fixed, and level 3 and 4 warnings removed
1665 *) 02 jun 2007: made the encoder add a tag with version by default
1666 *) 27 may 2007: zlib and png code separated (but still in the same file),
1667 simple encoder/decoder functions added for more simple usage cases
1668 *) 19 may 2007: minor fixes, some code cleaning, new error added (error 69),
1669 moved some examples from here to lodepng_examples.cpp
1670 *) 12 may 2007: palette decoding bug fixed
1671 *) 24 apr 2007: changed the license from BSD to the zlib license
1672 *) 11 mar 2007: very simple addition: ability to encode bKGD chunks.
1673 *) 04 mar 2007: (!) tEXt chunk related fixes, and support for encoding
1674 palettized PNG images. Plus little interface change with palette and texts.
1675 *) 03 mar 2007: Made it encode dynamic Huffman shorter with repeat codes.
1676 Fixed a bug where the end code of a block had length 0 in the Huffman tree.
1677 *) 26 feb 2007: Huffman compression with dynamic trees (BTYPE 2) now implemented
1678 and supported by the encoder, resulting in smaller PNGs at the output.
1679 *) 27 jan 2007: Made the Adler-32 test faster so that a timewaste is gone.
1680 *) 24 jan 2007: gave encoder an error interface. Added color conversion from any
1681 greyscale type to 8-bit greyscale with or without alpha.
1682 *) 21 jan 2007: (!) Totally changed the interface. It allows more color types
1683 to convert to and is more uniform. See the manual for how it works now.
1684 *) 07 jan 2007: Some cleanup & fixes, and a few changes over the last days:
1685 encode/decode custom tEXt chunks, separate classes for zlib & deflate, and
1686 at last made the decoder give errors for incorrect Adler32 or Crc.
1687 *) 01 jan 2007: Fixed bug with encoding PNGs with less than 8 bits per channel.
1688 *) 29 dec 2006: Added support for encoding images without alpha channel, and
1689 cleaned out code as well as making certain parts faster.
1690 *) 28 dec 2006: Added "Settings" to the encoder.
1691 *) 26 dec 2006: The encoder now does LZ77 encoding and produces much smaller files now.
1692 Removed some code duplication in the decoder. Fixed little bug in an example.
1693 *) 09 dec 2006: (!) Placed output parameters of public functions as first parameter.
1694 Fixed a bug of the decoder with 16-bit per color.
1695 *) 15 okt 2006: Changed documentation structure
1696 *) 09 okt 2006: Encoder class added. It encodes a valid PNG image from the
1697 given image buffer, however for now it's not compressed.
1698 *) 08 sep 2006: (!) Changed to interface with a Decoder class
1699 *) 30 jul 2006: (!) LodePNG_InfoPng , width and height are now retrieved in different
1700 way. Renamed decodePNG to decodePNGGeneric.
1701 *) 29 jul 2006: (!) Changed the interface: image info is now returned as a
1702 struct of type LodePNG::LodePNG_Info, instead of a vector, which was a bit clumsy.
1703 *) 28 jul 2006: Cleaned the code and added new error checks.
1704 Corrected terminology "deflate" into "inflate".
1705 *) 23 jun 2006: Added SDL example in the documentation in the header, this
1706 example allows easy debugging by displaying the PNG and its transparency.
1707 *) 22 jun 2006: (!) Changed way to obtain error value. Added
1708 loadFile function for convenience. Made decodePNG32 faster.
1709 *) 21 jun 2006: (!) Changed type of info vector to unsigned.
1710 Changed position of palette in info vector. Fixed an important bug that
1711 happened on PNGs with an uncompressed block.
1712 *) 16 jun 2006: Internally changed unsigned into unsigned where
1713 needed, and performed some optimizations.
1714 *) 07 jun 2006: (!) Renamed functions to decodePNG and placed them
1715 in LodePNG namespace. Changed the order of the parameters. Rewrote the
1716 documentation in the header. Renamed files to lodepng.cpp and lodepng.h
1717 *) 22 apr 2006: Optimized and improved some code
1718 *) 07 sep 2005: (!) Changed to std::vector interface
1719 *) 12 aug 2005: Initial release (C++, decoder only)
1720
1721
1722 12. contact information
1723 -----------------------
1724
1725 Feel free to contact me with suggestions, problems, comments, ... concerning
1726 LodePNG. If you encounter a PNG image that doesn't work properly with this
1727 decoder, feel free to send it and I'll use it to find and fix the problem.
1728
1729 My email address is (puzzle the account and domain together with an @ symbol):
1730 Domain: gmail dot com.
1731 Account: lode dot vandevenne.
1732
1733
1734 Copyright (c) 2005-2015 Lode Vandevenne
1735 */