Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
folium-app
GitHub Repository: folium-app/Folium
Path: blob/a-new-beginning/SharedDependencies/Sources/lodepng/include/lodepng.h
2 views
1
/*
2
LodePNG version 20250506
3
4
Copyright (c) 2005-2025 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
#ifndef LODEPNG_H
27
#define LODEPNG_H
28
29
#include <string.h> /*for size_t*/
30
31
extern const char* LODEPNG_VERSION_STRING;
32
33
/*
34
The following #defines are used to create code sections. They can be disabled
35
to disable code sections, which can give faster compile time and smaller binary.
36
The "NO_COMPILE" defines are designed to be used to pass as defines to the
37
compiler command to disable them without modifying this header, e.g.
38
-DLODEPNG_NO_COMPILE_ZLIB for gcc or clang.
39
*/
40
/*deflate & zlib. If disabled, you must specify alternative zlib functions in
41
the custom_zlib field of the compress and decompress settings*/
42
#ifndef LODEPNG_NO_COMPILE_ZLIB
43
/*pass -DLODEPNG_NO_COMPILE_ZLIB to the compiler to disable this, or comment out LODEPNG_COMPILE_ZLIB below*/
44
#define LODEPNG_COMPILE_ZLIB
45
#endif
46
47
/*png encoder and png decoder*/
48
#ifndef LODEPNG_NO_COMPILE_PNG
49
/*pass -DLODEPNG_NO_COMPILE_PNG to the compiler to disable this, or comment out LODEPNG_COMPILE_PNG below*/
50
#define LODEPNG_COMPILE_PNG
51
#endif
52
53
/*deflate&zlib decoder and png decoder*/
54
#ifndef LODEPNG_NO_COMPILE_DECODER
55
/*pass -DLODEPNG_NO_COMPILE_DECODER to the compiler to disable this, or comment out LODEPNG_COMPILE_DECODER below*/
56
#define LODEPNG_COMPILE_DECODER
57
#endif
58
59
/*deflate&zlib encoder and png encoder*/
60
#ifndef LODEPNG_NO_COMPILE_ENCODER
61
/*pass -DLODEPNG_NO_COMPILE_ENCODER to the compiler to disable this, or comment out LODEPNG_COMPILE_ENCODER below*/
62
#define LODEPNG_COMPILE_ENCODER
63
#endif
64
65
/*the optional built in harddisk file loading and saving functions*/
66
#ifndef LODEPNG_NO_COMPILE_DISK
67
/*pass -DLODEPNG_NO_COMPILE_DISK to the compiler to disable this, or comment out LODEPNG_COMPILE_DISK below*/
68
#define LODEPNG_COMPILE_DISK
69
#endif
70
71
/*support for chunks other than IHDR, IDAT, PLTE, tRNS, IEND: ancillary and unknown chunks*/
72
#ifndef LODEPNG_NO_COMPILE_ANCILLARY_CHUNKS
73
/*pass -DLODEPNG_NO_COMPILE_ANCILLARY_CHUNKS to the compiler to disable this,
74
or comment out LODEPNG_COMPILE_ANCILLARY_CHUNKS below*/
75
#define LODEPNG_COMPILE_ANCILLARY_CHUNKS
76
#endif
77
78
/*ability to convert error numerical codes to English text string*/
79
#ifndef LODEPNG_NO_COMPILE_ERROR_TEXT
80
/*pass -DLODEPNG_NO_COMPILE_ERROR_TEXT to the compiler to disable this,
81
or comment out LODEPNG_COMPILE_ERROR_TEXT below*/
82
#define LODEPNG_COMPILE_ERROR_TEXT
83
#endif
84
85
/*Compile the default allocators (C's free, malloc and realloc). If you disable this,
86
you can define the functions lodepng_free, lodepng_malloc and lodepng_realloc in your
87
source files with custom allocators.*/
88
#ifndef LODEPNG_NO_COMPILE_ALLOCATORS
89
/*pass -DLODEPNG_NO_COMPILE_ALLOCATORS to the compiler to disable the built-in ones,
90
or comment out LODEPNG_COMPILE_ALLOCATORS below*/
91
#define LODEPNG_COMPILE_ALLOCATORS
92
#endif
93
94
/*Disable built-in CRC function, in that case a custom implementation of
95
lodepng_crc32 must be defined externally so that it can be linked in.
96
The default built-in CRC code comes with 8KB of lookup tables, so for memory constrained environment you may want it
97
disabled and provide a much smaller implementation externally as said above. You can find such an example implementation
98
in a comment in the lodepng.c(pp) file in the 'else' case of the searchable LODEPNG_COMPILE_CRC section.*/
99
#ifndef LODEPNG_NO_COMPILE_CRC
100
/*pass -DLODEPNG_NO_COMPILE_CRC to the compiler to disable the built-in one,
101
or comment out LODEPNG_COMPILE_CRC below*/
102
#define LODEPNG_COMPILE_CRC
103
#endif
104
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
/*pass -DLODEPNG_NO_COMPILE_CPP to the compiler to disable C++ (not needed if a C-only compiler),
109
or comment out LODEPNG_COMPILE_CPP below*/
110
#define LODEPNG_COMPILE_CPP
111
#endif
112
#endif
113
114
#ifdef LODEPNG_COMPILE_CPP
115
#include <vector>
116
#include <string>
117
#endif /*LODEPNG_COMPILE_CPP*/
118
119
#ifdef LODEPNG_COMPILE_PNG
120
/*The PNG color types (also used for raw image).*/
121
typedef enum LodePNGColorType {
122
LCT_GREY = 0, /*grayscale: 1,2,4,8,16 bit*/
123
LCT_RGB = 2, /*RGB: 8,16 bit*/
124
LCT_PALETTE = 3, /*palette: 1,2,4,8 bit*/
125
LCT_GREY_ALPHA = 4, /*grayscale with alpha: 8,16 bit*/
126
LCT_RGBA = 6, /*RGB with alpha: 8,16 bit*/
127
/*LCT_MAX_OCTET_VALUE lets the compiler allow this enum to represent any invalid
128
byte value from 0 to 255 that could be present in an invalid PNG file header. Do
129
not use, compare with or set the name LCT_MAX_OCTET_VALUE, instead either use
130
the valid color type names above, or numeric values like 1 or 7 when checking for
131
particular disallowed color type byte values, or cast to integer to print it.*/
132
LCT_MAX_OCTET_VALUE = 255
133
} LodePNGColorType;
134
135
#ifdef LODEPNG_COMPILE_DECODER
136
/*
137
Converts PNG data in memory to raw pixel data.
138
out: Output parameter. Pointer to buffer that will contain the raw pixel data.
139
After decoding, its size is w * h * (bytes per pixel) bytes larger than
140
initially. Bytes per pixel depends on colortype and bitdepth.
141
Must be freed after usage with free(*out).
142
Note: for 16-bit per channel colors, uses big endian format like PNG does.
143
w: Output parameter. Pointer to width of pixel data.
144
h: Output parameter. Pointer to height of pixel data.
145
in: Memory buffer with the PNG file.
146
insize: size of the in buffer.
147
colortype: the desired color type for the raw output image. See explanation on PNG color types.
148
bitdepth: the desired bit depth for the raw output image. See explanation on PNG color types.
149
Return value: LodePNG error code (0 means no error).
150
*/
151
unsigned lodepng_decode_memory(unsigned char** out, unsigned* w, unsigned* h,
152
const unsigned char* in, size_t insize,
153
LodePNGColorType colortype, unsigned bitdepth);
154
155
/*Same as lodepng_decode_memory, but always decodes to 32-bit RGBA raw image*/
156
unsigned lodepng_decode32(unsigned char** out, unsigned* w, unsigned* h,
157
const unsigned char* in, size_t insize);
158
159
/*Same as lodepng_decode_memory, but always decodes to 24-bit RGB raw image*/
160
unsigned lodepng_decode24(unsigned char** out, unsigned* w, unsigned* h,
161
const unsigned char* in, size_t insize);
162
163
#ifdef LODEPNG_COMPILE_DISK
164
/*
165
Load PNG from disk, from file with given name.
166
Same as the other decode functions, but instead takes a filename as input.
167
168
NOTE: Wide-character filenames are not supported, you can use an external method
169
to handle such files and decode in-memory.*/
170
unsigned lodepng_decode_file(unsigned char** out, unsigned* w, unsigned* h,
171
const char* filename,
172
LodePNGColorType colortype, unsigned bitdepth);
173
174
/*Same as lodepng_decode_file, but always decodes to 32-bit RGBA raw image.
175
176
NOTE: Wide-character filenames are not supported, you can use an external method
177
to handle such files and decode in-memory.*/
178
unsigned lodepng_decode32_file(unsigned char** out, unsigned* w, unsigned* h,
179
const char* filename);
180
181
/*Same as lodepng_decode_file, but always decodes to 24-bit RGB raw image.
182
183
NOTE: Wide-character filenames are not supported, you can use an external method
184
to handle such files and decode in-memory.*/
185
unsigned lodepng_decode24_file(unsigned char** out, unsigned* w, unsigned* h,
186
const char* filename);
187
#endif /*LODEPNG_COMPILE_DISK*/
188
#endif /*LODEPNG_COMPILE_DECODER*/
189
190
191
#ifdef LODEPNG_COMPILE_ENCODER
192
/*
193
Converts raw pixel data into a PNG image in memory. The colortype and bitdepth
194
of the output PNG image cannot be chosen, they are automatically determined
195
by the colortype, bitdepth and content of the input pixel data.
196
Note: for 16-bit per channel colors, needs big endian format like PNG does.
197
out: Output parameter. Pointer to buffer that will contain the PNG image data.
198
Must be freed after usage with free(*out).
199
outsize: Output parameter. Pointer to the size in bytes of the out buffer.
200
image: The raw pixel data to encode. The size of this buffer should be
201
w * h * (bytes per pixel), bytes per pixel depends on colortype and bitdepth.
202
w: width of the raw pixel data in pixels.
203
h: height of the raw pixel data in pixels.
204
colortype: the color type of the raw input image. See explanation on PNG color types.
205
bitdepth: the bit depth of the raw input image. See explanation on PNG color types.
206
Return value: LodePNG error code (0 means no error).
207
*/
208
unsigned lodepng_encode_memory(unsigned char** out, size_t* outsize,
209
const unsigned char* image, unsigned w, unsigned h,
210
LodePNGColorType colortype, unsigned bitdepth);
211
212
/*Same as lodepng_encode_memory, but always encodes from 32-bit RGBA raw image.*/
213
unsigned lodepng_encode32(unsigned char** out, size_t* outsize,
214
const unsigned char* image, unsigned w, unsigned h);
215
216
/*Same as lodepng_encode_memory, but always encodes from 24-bit RGB raw image.*/
217
unsigned lodepng_encode24(unsigned char** out, size_t* outsize,
218
const unsigned char* image, unsigned w, unsigned h);
219
220
#ifdef LODEPNG_COMPILE_DISK
221
/*
222
Converts raw pixel data into a PNG file on disk.
223
Same as the other encode functions, but instead takes a filename as output.
224
225
NOTE: This overwrites existing files without warning!
226
227
NOTE: Wide-character filenames are not supported, you can use an external method
228
to handle such files and encode in-memory.*/
229
unsigned lodepng_encode_file(const char* filename,
230
const unsigned char* image, unsigned w, unsigned h,
231
LodePNGColorType colortype, unsigned bitdepth);
232
233
/*Same as lodepng_encode_file, but always encodes from 32-bit RGBA raw image.
234
235
NOTE: Wide-character filenames are not supported, you can use an external method
236
to handle such files and encode in-memory.*/
237
unsigned lodepng_encode32_file(const char* filename,
238
const unsigned char* image, unsigned w, unsigned h);
239
240
/*Same as lodepng_encode_file, but always encodes from 24-bit RGB raw image.
241
242
NOTE: Wide-character filenames are not supported, you can use an external method
243
to handle such files and encode in-memory.*/
244
unsigned lodepng_encode24_file(const char* filename,
245
const unsigned char* image, unsigned w, unsigned h);
246
#endif /*LODEPNG_COMPILE_DISK*/
247
#endif /*LODEPNG_COMPILE_ENCODER*/
248
249
250
#ifdef LODEPNG_COMPILE_CPP
251
namespace lodepng {
252
#ifdef LODEPNG_COMPILE_DECODER
253
/*Same as lodepng_decode_memory, but decodes to an std::vector. The colortype
254
is the format to output the pixels to. Default is RGBA 8-bit per channel.*/
255
unsigned decode(std::vector<unsigned char>& out, unsigned& w, unsigned& h,
256
const unsigned char* in, size_t insize,
257
LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
258
unsigned decode(std::vector<unsigned char>& out, unsigned& w, unsigned& h,
259
const std::vector<unsigned char>& in,
260
LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
261
#ifdef LODEPNG_COMPILE_DISK
262
/*
263
Converts PNG file from disk to raw pixel data in memory.
264
Same as the other decode functions, but instead takes a filename as input.
265
266
NOTE: Wide-character filenames are not supported, you can use an external method
267
to handle such files and decode in-memory.
268
*/
269
unsigned decode(std::vector<unsigned char>& out, unsigned& w, unsigned& h,
270
const std::string& filename,
271
LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
272
#endif /* LODEPNG_COMPILE_DISK */
273
#endif /* LODEPNG_COMPILE_DECODER */
274
275
#ifdef LODEPNG_COMPILE_ENCODER
276
/*Same as lodepng_encode_memory, but encodes to an std::vector. colortype
277
is that of the raw input data. The output PNG color type will be auto chosen.*/
278
unsigned encode(std::vector<unsigned char>& out,
279
const unsigned char* in, unsigned w, unsigned h,
280
LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
281
unsigned encode(std::vector<unsigned char>& out,
282
const std::vector<unsigned char>& in, unsigned w, unsigned h,
283
LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
284
#ifdef LODEPNG_COMPILE_DISK
285
/*
286
Converts 32-bit RGBA raw pixel data into a PNG file on disk.
287
Same as the other encode functions, but instead takes a filename as output.
288
289
NOTE: This overwrites existing files without warning!
290
291
NOTE: Wide-character filenames are not supported, you can use an external method
292
to handle such files and decode in-memory.
293
*/
294
unsigned encode(const std::string& filename,
295
const unsigned char* in, unsigned w, unsigned h,
296
LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
297
unsigned encode(const std::string& filename,
298
const std::vector<unsigned char>& in, unsigned w, unsigned h,
299
LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);
300
#endif /* LODEPNG_COMPILE_DISK */
301
#endif /* LODEPNG_COMPILE_ENCODER */
302
} /* namespace lodepng */
303
#endif /*LODEPNG_COMPILE_CPP*/
304
#endif /*LODEPNG_COMPILE_PNG*/
305
306
#ifdef LODEPNG_COMPILE_ERROR_TEXT
307
/*Returns an English description of the numerical error code.*/
308
const char* lodepng_error_text(unsigned code);
309
#endif /*LODEPNG_COMPILE_ERROR_TEXT*/
310
311
#ifdef LODEPNG_COMPILE_DECODER
312
/*Settings for zlib decompression*/
313
typedef struct LodePNGDecompressSettings LodePNGDecompressSettings;
314
struct LodePNGDecompressSettings {
315
/* Check LodePNGDecoderSettings for more ignorable errors such as ignore_crc */
316
unsigned ignore_adler32; /*if 1, continue and don't give an error message if the Adler32 checksum is corrupted*/
317
unsigned ignore_nlen; /*ignore complement of len checksum in uncompressed blocks*/
318
319
/*Maximum decompressed size, beyond this the decoder may (and is encouraged to) stop decoding,
320
return an error, output a data size > max_output_size and all the data up to that point. This is
321
not hard limit nor a guarantee, but can prevent excessive memory usage. This setting is
322
ignored by the PNG decoder, but is used by the deflate/zlib decoder and can be used by custom ones.
323
Set to 0 to impose no limit (the default).*/
324
size_t max_output_size;
325
326
/*use custom zlib decoder instead of built in one (default: null).
327
Should return 0 if success, any non-0 if error (numeric value not exposed).*/
328
unsigned (*custom_zlib)(unsigned char**, size_t*,
329
const unsigned char*, size_t,
330
const LodePNGDecompressSettings*);
331
/*use custom deflate decoder instead of built in one (default: null)
332
if custom_zlib is not null, custom_inflate is ignored (the zlib format uses deflate).
333
Should return 0 if success, any non-0 if error (numeric value not exposed).*/
334
unsigned (*custom_inflate)(unsigned char**, size_t*,
335
const unsigned char*, size_t,
336
const LodePNGDecompressSettings*);
337
338
const void* custom_context; /*optional custom settings for custom functions*/
339
};
340
341
extern const LodePNGDecompressSettings lodepng_default_decompress_settings;
342
void lodepng_decompress_settings_init(LodePNGDecompressSettings* settings);
343
#endif /*LODEPNG_COMPILE_DECODER*/
344
345
#ifdef LODEPNG_COMPILE_ENCODER
346
/*
347
Settings for zlib compression. Tweaking these settings tweaks the balance
348
between speed and compression ratio.
349
*/
350
typedef struct LodePNGCompressSettings LodePNGCompressSettings;
351
struct LodePNGCompressSettings /*deflate = compress*/ {
352
/*LZ77 related settings*/
353
unsigned btype; /*the block type for LZ (0, 1, 2 or 3, see zlib standard). Should be 2 for proper compression.*/
354
unsigned use_lz77; /*whether or not to use LZ77. Should be 1 for proper compression.*/
355
unsigned windowsize; /*must be a power of two <= 32768. higher compresses more but is slower. Default value: 2048.*/
356
unsigned minmatch; /*minimum lz77 length. 3 is normally best, 6 can be better for some PNGs. Default: 0*/
357
unsigned nicematch; /*stop searching if >= this length found. Set to 258 for best compression. Default: 128*/
358
unsigned lazymatching; /*use lazy matching: better compression but a bit slower. Default: true*/
359
360
/*use custom zlib encoder instead of built in one (default: null)*/
361
unsigned (*custom_zlib)(unsigned char**, size_t*,
362
const unsigned char*, size_t,
363
const LodePNGCompressSettings*);
364
/*use custom deflate encoder instead of built in one (default: null)
365
if custom_zlib is used, custom_deflate is ignored since only the built in
366
zlib function will call custom_deflate*/
367
unsigned (*custom_deflate)(unsigned char**, size_t*,
368
const unsigned char*, size_t,
369
const LodePNGCompressSettings*);
370
371
const void* custom_context; /*optional custom settings for custom functions*/
372
};
373
374
extern const LodePNGCompressSettings lodepng_default_compress_settings;
375
void lodepng_compress_settings_init(LodePNGCompressSettings* settings);
376
#endif /*LODEPNG_COMPILE_ENCODER*/
377
378
#ifdef LODEPNG_COMPILE_PNG
379
/*
380
Color mode of an image. Contains all information required to decode the pixel
381
bits to RGBA colors. This information is the same as used in the PNG file
382
format, and is used both for PNG and raw image data in LodePNG.
383
*/
384
typedef struct LodePNGColorMode {
385
/*header (IHDR)*/
386
LodePNGColorType colortype; /*color type, see PNG standard or documentation further in this header file*/
387
unsigned bitdepth; /*bits per sample, see PNG standard or documentation further in this header file*/
388
389
/*
390
palette (PLTE and tRNS)
391
392
Dynamically allocated with the colors of the palette, including alpha.
393
This field may not be allocated directly, use lodepng_color_mode_init first,
394
then lodepng_palette_add per color to correctly initialize it (to ensure size
395
of exactly 1024 bytes).
396
397
The alpha channels must be set as well, set them to 255 for opaque images.
398
399
When decoding, with the default settings you can ignore this palette, since
400
LodePNG already fills the palette colors in the pixels of the raw RGBA output,
401
but when decoding to the original PNG color mode it is needed to reconstruct
402
the colors.
403
404
The palette is only supported for color type 3.
405
*/
406
unsigned char* palette; /*palette in RGBARGBA... order. Must be either 0, or when allocated must have 1024 bytes*/
407
size_t palettesize; /*palette size in number of colors (amount of used bytes is 4 * palettesize)*/
408
409
/*
410
transparent color key (tRNS)
411
412
This color uses the same bit depth as the bitdepth value in this struct, which can be 1-bit to 16-bit.
413
For grayscale PNGs, r, g and b will all 3 be set to the same.
414
415
When decoding, by default you can ignore this information, since LodePNG sets
416
pixels with this key to transparent already in the raw RGBA output.
417
418
The color key is only supported for color types 0 and 2.
419
*/
420
unsigned key_defined; /*is a transparent color key given? 0 = false, 1 = true*/
421
unsigned key_r; /*red/grayscale component of color key*/
422
unsigned key_g; /*green component of color key*/
423
unsigned key_b; /*blue component of color key*/
424
} LodePNGColorMode;
425
426
/*init, cleanup and copy functions to use with this struct*/
427
void lodepng_color_mode_init(LodePNGColorMode* info);
428
void lodepng_color_mode_cleanup(LodePNGColorMode* info);
429
/*return value is error code (0 means no error)*/
430
unsigned lodepng_color_mode_copy(LodePNGColorMode* dest, const LodePNGColorMode* source);
431
/* Makes a temporary LodePNGColorMode that does not need cleanup (no palette) */
432
LodePNGColorMode lodepng_color_mode_make(LodePNGColorType colortype, unsigned bitdepth);
433
434
void lodepng_palette_clear(LodePNGColorMode* info);
435
/*add 1 color to the palette*/
436
unsigned lodepng_palette_add(LodePNGColorMode* info,
437
unsigned char r, unsigned char g, unsigned char b, unsigned char a);
438
439
/*get the total amount of bits per pixel, based on colortype and bitdepth in the struct*/
440
unsigned lodepng_get_bpp(const LodePNGColorMode* info);
441
/*get the amount of color channels used, based on colortype in the struct.
442
If a palette is used, it counts as 1 channel.*/
443
unsigned lodepng_get_channels(const LodePNGColorMode* info);
444
/*is it a grayscale type? (only colortype 0 or 4)*/
445
unsigned lodepng_is_greyscale_type(const LodePNGColorMode* info);
446
/*has it got an alpha channel? (only colortype 2 or 6)*/
447
unsigned lodepng_is_alpha_type(const LodePNGColorMode* info);
448
/*has it got a palette? (only colortype 3)*/
449
unsigned lodepng_is_palette_type(const LodePNGColorMode* info);
450
/*only returns true if there is a palette and there is a value in the palette with alpha < 255.
451
Loops through the palette to check this.*/
452
unsigned lodepng_has_palette_alpha(const LodePNGColorMode* info);
453
/*
454
Check if the given color info indicates the possibility of having non-opaque pixels in the PNG image.
455
Returns true if the image can have translucent or invisible pixels (it still be opaque if it doesn't use such pixels).
456
Returns false if the image can only have opaque pixels.
457
In detail, it returns true only if it's a color type with alpha, or has a palette with non-opaque values,
458
or if "key_defined" is true.
459
*/
460
unsigned lodepng_can_have_alpha(const LodePNGColorMode* info);
461
/*Returns the byte size of a raw image buffer with given width, height and color mode*/
462
size_t lodepng_get_raw_size(unsigned w, unsigned h, const LodePNGColorMode* color);
463
464
#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS
465
/*The information of a Time chunk in PNG.*/
466
typedef struct LodePNGTime {
467
unsigned year; /*2 bytes used (0-65535)*/
468
unsigned month; /*1-12*/
469
unsigned day; /*1-31*/
470
unsigned hour; /*0-23*/
471
unsigned minute; /*0-59*/
472
unsigned second; /*0-60 (to allow for leap seconds)*/
473
} LodePNGTime;
474
#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/
475
476
/*Information about the PNG image, except pixels, width and height.*/
477
typedef struct LodePNGInfo {
478
/*header (IHDR), palette (PLTE) and transparency (tRNS) chunks*/
479
unsigned compression_method;/*compression method of the original file. Always 0.*/
480
unsigned filter_method; /*filter method of the original file*/
481
unsigned interlace_method; /*interlace method of the original file: 0=none, 1=Adam7*/
482
LodePNGColorMode color; /*color type and bits, palette and transparency of the PNG file*/
483
484
#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS
485
/*
486
Suggested background color chunk (bKGD)
487
488
This uses the same color mode and bit depth as the PNG (except no alpha channel),
489
with values truncated to the bit depth in the unsigned integer.
490
491
For grayscale and palette PNGs, the value is stored in background_r. The values
492
in background_g and background_b are then unused. The decoder will set them
493
equal to background_r, the encoder ignores them in this case.
494
495
When decoding, you may get these in a different color mode than the one you requested
496
for the raw pixels: the colortype and bitdepth defined by info_png.color, that is the
497
ones defined in the header of the PNG image, are used.
498
499
When encoding with auto_convert, you must use the color model defined in info_png.color for
500
these values. The encoder normally ignores info_png.color when auto_convert is on, but will
501
use it to interpret these values (and convert copies of them to its chosen color model).
502
503
When encoding, avoid setting this to an expensive color, such as a non-gray value
504
when the image is gray, or the compression will be worse since it will be forced to
505
write the PNG with a more expensive color mode (when auto_convert is on).
506
507
The decoder does not use this background color to edit the color of pixels. This is a
508
completely optional metadata feature.
509
*/
510
unsigned background_defined; /*is a suggested background color given?*/
511
unsigned background_r; /*red/gray/palette component of suggested background color*/
512
unsigned background_g; /*green component of suggested background color*/
513
unsigned background_b; /*blue component of suggested background color*/
514
515
/*
516
Non-international text chunks (tEXt and zTXt)
517
518
The char** arrays each contain num strings. The actual messages are in
519
text_strings, while text_keys are keywords that give a short description what
520
the actual text represents, e.g. Title, Author, Description, or anything else.
521
522
All the string fields below including strings, keys, names and language tags are null terminated.
523
The PNG specification uses null characters for the keys, names and tags, and forbids null
524
characters to appear in the main text which is why we can use null termination everywhere here.
525
526
A keyword is minimum 1 character and maximum 79 characters long (plus the
527
additional null terminator). It's discouraged to use a single line length
528
longer than 79 characters for texts.
529
530
Don't allocate these text buffers yourself. Use the init/cleanup functions
531
correctly and use lodepng_add_text and lodepng_clear_text.
532
533
Standard text chunk keywords and strings are encoded using Latin-1.
534
*/
535
size_t text_num; /*the amount of texts in these char** buffers (there may be more texts in itext)*/
536
char** text_keys; /*the keyword of a text chunk (e.g. "Comment")*/
537
char** text_strings; /*the actual text*/
538
539
/*
540
International text chunks (iTXt)
541
Similar to the non-international text chunks, but with additional strings
542
"langtags" and "transkeys", and the following text encodings are used:
543
keys: Latin-1, langtags: ASCII, transkeys and strings: UTF-8.
544
keys must be 1-79 characters (plus the additional null terminator), the other
545
strings are any length.
546
*/
547
size_t itext_num; /*the amount of international texts in this PNG*/
548
char** itext_keys; /*the English keyword of the text chunk (e.g. "Comment")*/
549
char** itext_langtags; /*language tag for this text's language, ISO/IEC 646 string, e.g. ISO 639 language tag*/
550
char** itext_transkeys; /*keyword translated to the international language - UTF-8 string*/
551
char** itext_strings; /*the actual international text - UTF-8 string*/
552
553
/*
554
Optional exif metadata in exif_size bytes.
555
Don't allocate this buffer yourself. Use the init/cleanup functions
556
correctly and use lodepng_set_exif and lodepng_clear_exif.
557
The exif data is in exif-encoded form but without JPEG markers, starting with the 'II' or 'MM' marker that indicates
558
endianness. It's up to an exif handling library to encode/decode its information.
559
*/
560
unsigned exif_defined; /* Whether exif metadata is present, that is, the PNG image has an eXIf chunk */
561
unsigned char* exif; /* The bytes of the exif metadata, if present */
562
unsigned exif_size; /* The size of the exif data in bytes */
563
564
565
/*time chunk (tIME)*/
566
unsigned time_defined; /*set to 1 to make the encoder generate a tIME chunk*/
567
LodePNGTime time;
568
569
/*phys chunk (pHYs)*/
570
unsigned phys_defined; /*if 0, there is no pHYs chunk and the values below are undefined, if 1 else there is one*/
571
unsigned phys_x; /*pixels per unit in x direction*/
572
unsigned phys_y; /*pixels per unit in y direction*/
573
unsigned phys_unit; /*may be 0 (unknown unit) or 1 (metre)*/
574
575
/*
576
Color profile related chunk types: cICP, iCPP, sRGB, gAMA, cHRM, sBIT
577
578
LodePNG does not apply any color conversions on pixels in the encoder or decoder and does not interpret these color
579
profile values. It merely passes on the information. If you wish to use color profiles and convert colors, a separate
580
color management library should be used. There is also a limited library for this in lodepng_util.h.
581
582
There are 4 types of (sets of) chunks providing color information. If multiple are present, each will be decoded by
583
LodePNG, but only one should be handled by the user, with the following order of priority depending on what the user
584
supports:
585
1: cICP: Coding-independent code points (CICP)
586
2: iCCP: ICC profile
587
3: sRGB: indicates the image is in the sRGB color profile
588
4: gAMA and cHRM: indicates a gamma and chromaticity value to define the color profile
589
*/
590
591
/*
592
gAMA chunk: Image gamma
593
Optional, overridden by cICP, iCCP or sRGB if those are present.
594
Together with cHRM, this is a primitive way of specifying the image color profile.
595
*/
596
unsigned gama_defined; /* Whether a gAMA chunk is present (0 = not present, 1 = present). */
597
unsigned gama_gamma; /* Gamma exponent times 100000 */
598
599
/*
600
cHRM chunk: Primary chromaticities and white point
601
Optional, overridden by cICP, iCCP or sRGB if those are present.
602
Together with gAMA, this is a primitive way of specifying the image color profile.
603
*/
604
unsigned chrm_defined; /* Whether a cHRM chunk is present (0 = not present, 1 = present). */
605
unsigned chrm_white_x; /* White Point x times 100000 */
606
unsigned chrm_white_y; /* White Point y times 100000 */
607
unsigned chrm_red_x; /* Red x times 100000 */
608
unsigned chrm_red_y; /* Red y times 100000 */
609
unsigned chrm_green_x; /* Green x times 100000 */
610
unsigned chrm_green_y; /* Green y times 100000 */
611
unsigned chrm_blue_x; /* Blue x times 100000 */
612
unsigned chrm_blue_y; /* Blue y times 100000 */
613
614
/*
615
sRGB chunk: Indicates the image is in the sRGB color space.
616
Optional. Should not appear at the same time as iCCP.
617
If gAMA is also present gAMA must contain value 45455.
618
If cHRM is also present cHRM must contain respectively 31270,32900,64000,33000,30000,60000,15000,6000.
619
*/
620
unsigned srgb_defined; /* Whether an sRGB chunk is present (0 = not present, 1 = present). */
621
unsigned srgb_intent; /* Rendering intent: 0=perceptual, 1=rel. colorimetric, 2=saturation, 3=abs. colorimetric */
622
623
/*
624
iCCP chunk: Embedded ICC profile.
625
Optional. Should not appear at the same time as sRGB.
626
627
Contains ICC profile, which can use any version of the ICC.1 specification by the International Color Consortium. See
628
its specification for more details. LodePNG does not parse or use the ICC profile (except its color space header
629
field for "RGB" or "GRAY", see below), a separate library to handle the ICC data format is needed to use it for color
630
management and conversions.
631
632
For encoding, if iCCP is present, the PNG specification recommends to also add gAMA and cHRM chunks that approximate
633
the ICC profile, for compatibility with applications that don't use the ICC chunk. This is not required, and it's up
634
to the user to compute approximate values and set then in the appropriate gama_ and chrm_ fields, LodePNG does not do
635
this automatically since it does not interpret the ICC profile.
636
637
For encoding, the ICC profile is required by the PNG specification to be an "RGB" profile for non-gray PNG color
638
types (types 2, 3 and 6) and a "GRAY" profile for gray PNG color types (types 1 and 4). If you disable auto_convert,
639
you must ensure the ICC profile type matches your requested color type, else the encoder gives an error. If
640
auto_convert is enabled (the default), and the ICC profile is not a correct match for the pixel data, this will result
641
in an encoder error if the pixel data has non-gray pixels for a GRAY profile, or a silent less-optimal compression of
642
the pixel data if the pixels could be encoded as grayscale but the ICC profile is RGB.
643
644
To avoid this do not set an ICC profile in the image unless there is a good reason for it, and when doing so
645
make sure you compute it carefully to avoid the above problems.
646
*/
647
unsigned iccp_defined; /* Whether an iCCP chunk is present (0 = not present, 1 = present). */
648
char* iccp_name; /* Null terminated string with profile name, 1-79 bytes */
649
/*
650
The ICC profile in iccp_profile_size bytes.
651
Don't allocate this buffer yourself. Use the init/cleanup functions
652
correctly and use lodepng_set_icc and lodepng_clear_icc.
653
*/
654
unsigned char* iccp_profile;
655
unsigned iccp_profile_size; /* The size of iccp_profile in bytes */
656
657
/*
658
cICP chunk: Coding-independent code points for video signal type identification.
659
Optional. If present, and supported, overrides iCCP, sRGB, gAMA and cHRM.
660
The meaning of the values are as defined in the specification ITU-T-H.273. LodePNG does not
661
use these values, only passes on the metadata. The meaning of the values is they are enum
662
values representing certain color spaces, including HDR color spaces, such as Display P3,
663
PQ and HLG. The video full range flag value should typically be 1 for the use cases of PNG
664
images, but can be 0 for narrow-range images in certain video editing workflows.
665
*/
666
unsigned cicp_defined; /* Whether an cICP chunk is present (0 = not present, 1 = present). */
667
unsigned cicp_color_primaries; /* Colour primaries value */
668
unsigned cicp_transfer_function; /* Transfer characteristics value */
669
unsigned cicp_matrix_coefficients; /* Matrix coefficients value */
670
unsigned cicp_video_full_range_flag; /* Video full range flag value */
671
672
/*
673
mDCV chunk: Mastering Display Color Volume.
674
Optional, typically used in conjunction with certain HDR color spaces that can
675
be represented by the cICP chunk.
676
See the PNG specification, third edition, for more information on this chunk.
677
All the red, green, blue and white x and y values are encoded as 16-bit
678
integers and therefore must be in range 0-65536. The min and max luminance
679
values are 32-bit integers.
680
*/
681
unsigned mdcv_defined; /* Whether an mDCV chunk is present (0 = not present, 1 = present). */
682
/* Mastering display color primary chromaticities (CIE 1931 x,y of R,G,B) */
683
unsigned mdcv_red_x; /* Red x times 50000 */
684
unsigned mdcv_red_y; /* Red y times 50000 */
685
unsigned mdcv_green_x; /* Green x times 50000 */
686
unsigned mdcv_green_y; /* Green y times 50000 */
687
unsigned mdcv_blue_x; /* Blue x times 50000 */
688
unsigned mdcv_blue_y; /* Blue y times 50000 */
689
/* Mastering display white point chromaticity (CIE 1931 x,y) */
690
unsigned mdcv_white_x; /* White Point x times 50000 */
691
unsigned mdcv_white_y; /* White Point y times 50000 */
692
/* Mastering display luminance */
693
unsigned mdcv_max_luminance; /* Max luminance in cd/m^2 times 10000 */
694
unsigned mdcv_min_luminance; /* Min luminance in cd/m^2 times 10000 */
695
696
/*
697
cLLI chunk: Content Light Level Information.
698
Optional, typically used in conjunction with certain HDR color spaces that can
699
be represented by the cICP chunk.
700
See the PNG specification, third edition, for more information on this chunk.
701
The clli_max_cll and clli_max_fall values are 32-bit integers.
702
*/
703
unsigned clli_defined; /* Whether a cLLI chunk is present (0 = not present, 1 = present). */
704
unsigned clli_max_cll; /* Maximum Content Light Level (MaxCLL) in cd/m^2 times 10000 */
705
unsigned clli_max_fall; /* Maximum Frame-Average Light Level (MaxFALL) in cd/m^2 times 10000 */
706
707
/*
708
sBIT chunk: significant bits.
709
Optional metadata, only set this if needed.
710
711
If defined, these values give the bit depth of the original data. Since PNG only stores 1, 2, 4, 8 or 16-bit
712
per channel data, the significant bits value can be used to indicate the original encoded data has another
713
sample depth, such as 10 or 12.
714
715
Encoders using this value, when storing the pixel data, should use the most significant bits
716
of the data to store the original bits, and use a good sample depth scaling method such as
717
"left bit replication" to fill in the least significant bits, rather than fill zeroes.
718
719
Decoders using this value, if able to work with data that's e.g. 10-bit or 12-bit, should right
720
shift the data to go back to the original bit depth, but decoders are also allowed to ignore
721
sbit and work e.g. with the 8-bit or 16-bit data from the PNG directly, since thanks
722
to the encoder contract, the values encoded in PNG are in valid range for the PNG bit depth.
723
724
For grayscale images, sbit_g and sbit_b are not used, and for images that don't use color
725
type RGBA or grayscale+alpha, sbit_a is not used (it's not used even for palette images with
726
translucent palette values, or images with color key). The values that are used must be
727
greater than zero and smaller than or equal to the PNG bit depth.
728
729
The color type from the header in the PNG image defines these used and unused fields: if
730
decoding with a color mode conversion, such as always decoding to RGBA, this metadata still
731
only uses the color type of the original PNG, and may e.g. lack the alpha channel info
732
if the PNG was RGB. When encoding with auto_convert (as well as without), also always the
733
color model defined in info_png.color determines this.
734
735
NOTE: enabling sbit can hurt compression, because the encoder can then not always use
736
auto_convert to choose a more optimal color mode for the data, because the PNG format has
737
strict requirements for the allowed sbit values in combination with color modes.
738
For example, setting these fields to 10-bit will force the encoder to keep using a 16-bit per channel
739
color mode, even if the pixel data would in fact fit in a more efficient 8-bit mode.
740
*/
741
unsigned sbit_defined; /*is significant bits given? if not, the values below are unused*/
742
unsigned sbit_r; /*red or gray component of significant bits*/
743
unsigned sbit_g; /*green component of significant bits*/
744
unsigned sbit_b; /*blue component of significant bits*/
745
unsigned sbit_a; /*alpha component of significant bits*/
746
747
/* End of color profile related chunks */
748
749
750
/*
751
unknown chunks: chunks not known by LodePNG, passed on byte for byte.
752
753
There are 3 buffers, one for each position in the PNG where unknown chunks can appear.
754
Each buffer contains all unknown chunks for that position consecutively.
755
The 3 positions are:
756
0: between IHDR and PLTE, 1: between PLTE and IDAT, 2: between IDAT and IEND.
757
758
For encoding, do not store critical chunks or known chunks that are enabled with a "_defined" flag
759
above in here, since the encoder will blindly follow this and could then encode an invalid PNG file
760
(such as one with two IHDR chunks or the disallowed combination of sRGB with iCCP). But do use
761
this if you wish to store an ancillary chunk that is not supported by LodePNG (such as sPLT or hIST),
762
or any non-standard PNG chunk.
763
764
Do not allocate or traverse this data yourself. Use the chunk traversing functions declared
765
later, such as lodepng_chunk_next and lodepng_chunk_append, to read/write this struct.
766
*/
767
unsigned char* unknown_chunks_data[3];
768
size_t unknown_chunks_size[3]; /*size in bytes of the unknown chunks, given for protection*/
769
#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/
770
} LodePNGInfo;
771
772
/*init, cleanup and copy functions to use with this struct*/
773
void lodepng_info_init(LodePNGInfo* info);
774
void lodepng_info_cleanup(LodePNGInfo* info);
775
/*return value is error code (0 means no error)*/
776
unsigned lodepng_info_copy(LodePNGInfo* dest, const LodePNGInfo* source);
777
778
#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS
779
unsigned lodepng_add_text(LodePNGInfo* info, const char* key, const char* str); /*push back both texts at once*/
780
void lodepng_clear_text(LodePNGInfo* info); /*use this to clear the texts again after you filled them in*/
781
782
unsigned lodepng_add_itext(LodePNGInfo* info, const char* key, const char* langtag,
783
const char* transkey, const char* str); /*push back the 4 texts of 1 chunk at once*/
784
void lodepng_clear_itext(LodePNGInfo* info); /*use this to clear the itexts again after you filled them in*/
785
786
/*replaces if exists*/
787
unsigned lodepng_set_icc(LodePNGInfo* info, const char* name, const unsigned char* profile, unsigned profile_size);
788
void lodepng_clear_icc(LodePNGInfo* info); /*use this to clear the profile again after you filled it in*/
789
790
/*replaces if exists*/
791
unsigned lodepng_set_exif(LodePNGInfo* info, const unsigned char* exif, unsigned exif_size);
792
void lodepng_clear_exif(LodePNGInfo* info); /*use this to clear the exif metadata again after you filled it in*/
793
#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/
794
795
/*
796
Converts raw buffer from one color type to another color type, based on
797
LodePNGColorMode structs to describe the input and output color type.
798
See the reference manual at the end of this header file to see which color conversions are supported.
799
return value = LodePNG error code (0 if all went ok, an error if the conversion isn't supported)
800
The out buffer must have size (w * h * bpp + 7) / 8, where bpp is the bits per pixel
801
of the output color type (lodepng_get_bpp).
802
For < 8 bpp images, there should not be padding bits at the end of scanlines.
803
For 16-bit per channel colors, uses big endian format like PNG does.
804
Return value is LodePNG error code
805
*/
806
unsigned lodepng_convert(unsigned char* out, const unsigned char* in,
807
const LodePNGColorMode* mode_out, const LodePNGColorMode* mode_in,
808
unsigned w, unsigned h);
809
810
#ifdef LODEPNG_COMPILE_DECODER
811
/*
812
Settings for the decoder. This contains settings for the PNG and the Zlib
813
decoder, but not the Info settings from the Info structs.
814
*/
815
typedef struct LodePNGDecoderSettings {
816
LodePNGDecompressSettings zlibsettings; /*in here is the setting to ignore Adler32 checksums*/
817
818
/* Check LodePNGDecompressSettings for more ignorable errors such as ignore_adler32 */
819
unsigned ignore_crc; /*ignore CRC checksums*/
820
unsigned ignore_critical; /*ignore unknown critical chunks*/
821
unsigned ignore_end; /*ignore issues at end of file if possible (missing IEND chunk, too large chunk, ...)*/
822
/* TODO: make a system involving warnings with levels and a strict mode instead. Other potentially recoverable
823
errors: srgb rendering intent value, size of content of ancillary chunks, more than 79 characters for some
824
strings, placement/combination rules for ancillary chunks, crc of unknown chunks, allowed characters
825
in string keys, invalid characters in chunk types names, etc... */
826
827
unsigned color_convert; /*whether to convert the PNG to the color type you want. Default: yes*/
828
829
#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS
830
unsigned read_text_chunks; /*if false but remember_unknown_chunks is true, they're stored in the unknown chunks*/
831
832
/*store all bytes from unknown chunks in the LodePNGInfo (off by default, useful for a png editor)*/
833
unsigned remember_unknown_chunks;
834
835
/* maximum size for decompressed text chunks. If a text chunk's text is larger than this, an error is returned,
836
unless reading text chunks is disabled or this limit is set higher or disabled. Set to 0 to allow any size.
837
By default it is a value that prevents unreasonably large strings from hogging memory. */
838
size_t max_text_size;
839
840
/* maximum size for compressed ICC chunks. If the ICC profile is larger than this, an error will be returned. Set to
841
0 to allow any size. By default this is a value that prevents ICC profiles that would be much larger than any
842
legitimate profile could be to hog memory. */
843
size_t max_icc_size;
844
#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/
845
} LodePNGDecoderSettings;
846
847
void lodepng_decoder_settings_init(LodePNGDecoderSettings* settings);
848
#endif /*LODEPNG_COMPILE_DECODER*/
849
850
#ifdef LODEPNG_COMPILE_ENCODER
851
/*strategy to use to choose the PNG filter per scanline. Strategies 0-4 correspond
852
to each of the 5 filter types PNG supports, the next values are adaptive strategies*/
853
typedef enum LodePNGFilterStrategy {
854
/*every filter at zero*/
855
LFS_ZERO = 0,
856
/*every filter at 1, 2, 3 or 4 (paeth), unlike LFS_ZERO not a good choice, but for testing*/
857
LFS_ONE = 1,
858
LFS_TWO = 2,
859
LFS_THREE = 3,
860
LFS_FOUR = 4,
861
/*Use the filter out of the 5 above types that gives minimum sum, by trying each one. This is the adaptive filtering
862
suggested heuristic in the PNG standard chapter 'Filter selection'.*/
863
LFS_MINSUM,
864
/*Use the filter type that gives smallest Shannon entropy for this scanline. Depending
865
on the image, this is better or worse than minsum.*/
866
LFS_ENTROPY,
867
/*
868
Brute-force-search PNG filters by compressing each filter for each scanline.
869
Experimental, very slow, and only rarely gives better compression than MINSUM.
870
*/
871
LFS_BRUTE_FORCE,
872
/*use predefined_filters buffer: you specify the filter type for each scanline*/
873
LFS_PREDEFINED
874
} LodePNGFilterStrategy;
875
876
/*Gives characteristics about the integer RGBA colors of the image (count, alpha channel usage, bit depth, ...),
877
which helps decide which color model to use for encoding.
878
Used internally by default if "auto_convert" is enabled. Public because it's useful for custom algorithms.*/
879
typedef struct LodePNGColorStats {
880
unsigned colored; /*not grayscale*/
881
unsigned key; /*image is not opaque and color key is possible instead of full alpha*/
882
unsigned short key_r; /*key values, always as 16-bit, in 8-bit case the byte is duplicated, e.g. 65535 means 255*/
883
unsigned short key_g;
884
unsigned short key_b;
885
unsigned alpha; /*image is not opaque and alpha channel or alpha palette required*/
886
unsigned numcolors; /*amount of colors, up to 257. Not valid if bits == 16 or allow_palette is disabled.*/
887
unsigned char palette[1024]; /*Remembers up to the first 256 RGBA colors, in no particular order, only valid when numcolors is valid*/
888
unsigned bits; /*bits per channel (not for palette). 1,2 or 4 for grayscale only. 16 if 16-bit per channel required.*/
889
size_t numpixels;
890
891
/*user settings for computing/using the stats*/
892
unsigned allow_palette; /*default 1. if 0, disallow choosing palette colortype in auto_choose_color, and don't count numcolors*/
893
unsigned allow_greyscale; /*default 1. if 0, choose RGB or RGBA even if the image only has gray colors*/
894
} LodePNGColorStats;
895
896
void lodepng_color_stats_init(LodePNGColorStats* stats);
897
898
/*Get a LodePNGColorStats of the image. The stats must already have been inited.
899
Returns error code (e.g. alloc fail) or 0 if ok.*/
900
unsigned lodepng_compute_color_stats(LodePNGColorStats* stats,
901
const unsigned char* image, unsigned w, unsigned h,
902
const LodePNGColorMode* mode_in);
903
904
/*Settings for the encoder.*/
905
typedef struct LodePNGEncoderSettings {
906
LodePNGCompressSettings zlibsettings; /*settings for the zlib encoder, such as window size, ...*/
907
908
/*automatically choose output PNG color type. If false, must explicitely choose the output color
909
type in state.info_png.color.colortype, info_png.color.bitdepth and optionally its palette.
910
Default: true*/
911
unsigned auto_convert;
912
913
/*If true, follows the suggestion in the PNG standard in chapter 'Filter selection': if the PNG uses
914
a palette or lower than 8 bit depth, set all filters to zero.
915
In other cases this will use the heuristic from the chosen filter_strategy. The PNG standard
916
suggests LFS_MINSUM for those cases.*/
917
unsigned filter_palette_zero;
918
/*Which filter strategy to use when not using zeroes due to filter_palette_zero.
919
Set filter_palette_zero to 0 to ensure always using your chosen strategy. Default: LFS_MINSUM*/
920
LodePNGFilterStrategy filter_strategy;
921
/*used if filter_strategy is LFS_PREDEFINED. In that case, this must point to a buffer with
922
the same length as the amount of scanlines in the image, and each value must <= 5. You
923
have to cleanup this buffer, LodePNG will never free it. Don't forget that filter_palette_zero
924
must be set to 0 to ensure this is also used on palette or low bitdepth images.*/
925
const unsigned char* predefined_filters;
926
927
/*force creating a PLTE chunk if colortype is 2 or 6 (= a suggested palette).
928
If colortype is 3, PLTE is always created. If color type is explicitely set
929
to a grayscale type (1 or 4), this is not done and is ignored. If enabling this,
930
a palette must be present in the info_png.
931
NOTE: enabling this may worsen compression if auto_convert is used to choose
932
optimal color mode, because it cannot use grayscale color modes in this case*/
933
unsigned force_palette;
934
#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS
935
/*add LodePNG identifier and version as a text chunk, for debugging*/
936
unsigned add_id;
937
/*encode text chunks as zTXt chunks instead of tEXt chunks, and use compression in iTXt chunks*/
938
unsigned text_compression;
939
#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/
940
} LodePNGEncoderSettings;
941
942
void lodepng_encoder_settings_init(LodePNGEncoderSettings* settings);
943
#endif /*LODEPNG_COMPILE_ENCODER*/
944
945
946
#if defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER)
947
/*The settings, state and information for extended encoding and decoding.*/
948
typedef struct LodePNGState {
949
#ifdef LODEPNG_COMPILE_DECODER
950
LodePNGDecoderSettings decoder; /*the decoding settings*/
951
#endif /*LODEPNG_COMPILE_DECODER*/
952
#ifdef LODEPNG_COMPILE_ENCODER
953
LodePNGEncoderSettings encoder; /*the encoding settings*/
954
#endif /*LODEPNG_COMPILE_ENCODER*/
955
LodePNGColorMode info_raw; /*specifies the format in which you would like to get the raw pixel buffer*/
956
LodePNGInfo info_png; /*info of the PNG image obtained after decoding*/
957
unsigned error;
958
} LodePNGState;
959
960
/*init, cleanup and copy functions to use with this struct*/
961
void lodepng_state_init(LodePNGState* state);
962
void lodepng_state_cleanup(LodePNGState* state);
963
void lodepng_state_copy(LodePNGState* dest, const LodePNGState* source);
964
#endif /* defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER) */
965
966
#ifdef LODEPNG_COMPILE_DECODER
967
/*
968
Same as lodepng_decode_memory, but uses a LodePNGState to allow custom settings and
969
getting much more information about the PNG image and color mode.
970
*/
971
unsigned lodepng_decode(unsigned char** out, unsigned* w, unsigned* h,
972
LodePNGState* state,
973
const unsigned char* in, size_t insize);
974
975
/*
976
Read the PNG header, but not the actual data. This returns only the information
977
that is in the IHDR chunk of the PNG, such as width, height and color type. The
978
information is placed in the info_png field of the LodePNGState.
979
*/
980
unsigned lodepng_inspect(unsigned* w, unsigned* h,
981
LodePNGState* state,
982
const unsigned char* in, size_t insize);
983
#endif /*LODEPNG_COMPILE_DECODER*/
984
985
/*
986
Reads one metadata chunk (other than IHDR, which is handled by lodepng_inspect)
987
of the PNG file and outputs what it read in the state. Returns error code on failure.
988
Use lodepng_inspect first with a new state, then e.g. lodepng_chunk_find_const
989
to find the desired chunk type, and if non null use lodepng_inspect_chunk (with
990
chunk_pointer - start_of_file as pos).
991
Supports most metadata chunks from the PNG standard (gAMA, bKGD, tEXt, ...).
992
Ignores unsupported, unknown, non-metadata or IHDR chunks (without error).
993
Requirements: &in[pos] must point to start of a chunk, must use regular
994
lodepng_inspect first since format of most other chunks depends on IHDR, and if
995
there is a PLTE chunk, that one must be inspected before tRNS or bKGD.
996
*/
997
unsigned lodepng_inspect_chunk(LodePNGState* state, size_t pos,
998
const unsigned char* in, size_t insize);
999
1000
#ifdef LODEPNG_COMPILE_ENCODER
1001
/*This function allocates the out buffer with standard malloc and stores the size in *outsize.*/
1002
unsigned lodepng_encode(unsigned char** out, size_t* outsize,
1003
const unsigned char* image, unsigned w, unsigned h,
1004
LodePNGState* state);
1005
#endif /*LODEPNG_COMPILE_ENCODER*/
1006
1007
/*
1008
The lodepng_chunk functions are normally not needed, except to traverse the
1009
unknown chunks stored in the LodePNGInfo struct, or add new ones to it.
1010
It also allows traversing the chunks of an encoded PNG file yourself.
1011
1012
The chunk pointer always points to the beginning of the chunk itself, that is
1013
the first byte of the 4 length bytes.
1014
1015
In the PNG file format, chunks have the following format:
1016
-4 bytes length: length of the data of the chunk in bytes (chunk itself is 12 bytes longer)
1017
-4 bytes chunk type (ASCII a-z,A-Z only, see below)
1018
-length bytes of data (may be 0 bytes if length was 0)
1019
-4 bytes of CRC, computed on chunk name + data
1020
1021
The first chunk starts at the 8th byte of the PNG file, the entire rest of the file
1022
exists out of concatenated chunks with the above format.
1023
1024
PNG standard chunk ASCII naming conventions:
1025
-First byte: uppercase = critical, lowercase = ancillary
1026
-Second byte: uppercase = public, lowercase = private
1027
-Third byte: must be uppercase
1028
-Fourth byte: uppercase = unsafe to copy, lowercase = safe to copy
1029
*/
1030
1031
/*
1032
Gets the length of the data of the chunk. Total chunk length has 12 bytes more.
1033
There must be at least 4 bytes to read from. If the result value is too large,
1034
it may be corrupt data.
1035
*/
1036
unsigned lodepng_chunk_length(const unsigned char* chunk);
1037
1038
/*puts the 4-byte type in null terminated string*/
1039
void lodepng_chunk_type(char type[5], const unsigned char* chunk);
1040
1041
/*check if the type is the given type*/
1042
unsigned char lodepng_chunk_type_equals(const unsigned char* chunk, const char* type);
1043
1044
/*0: it's one of the critical chunk types, 1: it's an ancillary chunk (see PNG standard)*/
1045
unsigned char lodepng_chunk_ancillary(const unsigned char* chunk);
1046
1047
/*0: public, 1: private (see PNG standard)*/
1048
unsigned char lodepng_chunk_private(const unsigned char* chunk);
1049
1050
/*0: the chunk is unsafe to copy, 1: the chunk is safe to copy (see PNG standard)*/
1051
unsigned char lodepng_chunk_safetocopy(const unsigned char* chunk);
1052
1053
/*get pointer to the data of the chunk, where the input points to the header of the chunk*/
1054
unsigned char* lodepng_chunk_data(unsigned char* chunk);
1055
const unsigned char* lodepng_chunk_data_const(const unsigned char* chunk);
1056
1057
/*returns 0 if the crc is correct, 1 if it's incorrect (0 for OK as usual!)*/
1058
unsigned lodepng_chunk_check_crc(const unsigned char* chunk);
1059
1060
/*generates the correct CRC from the data and puts it in the last 4 bytes of the chunk*/
1061
void lodepng_chunk_generate_crc(unsigned char* chunk);
1062
1063
/*
1064
Iterate to next chunks, allows iterating through all chunks of the PNG file.
1065
Input must be at the beginning of a chunk (result of a previous lodepng_chunk_next call,
1066
or the 8th byte of a PNG file which always has the first chunk), or alternatively may
1067
point to the first byte of the PNG file (which is not a chunk but the magic header, the
1068
function will then skip over it and return the first real chunk).
1069
Will output pointer to the start of the next chunk, or at or beyond end of the file if there
1070
is no more chunk after this or possibly if the chunk is corrupt.
1071
Start this process at the 8th byte of the PNG file.
1072
In a non-corrupt PNG file, the last chunk should have name "IEND".
1073
*/
1074
unsigned char* lodepng_chunk_next(unsigned char* chunk, unsigned char* end);
1075
const unsigned char* lodepng_chunk_next_const(const unsigned char* chunk, const unsigned char* end);
1076
1077
/*Finds the first chunk with the given type in the range [chunk, end), or returns NULL if not found.*/
1078
unsigned char* lodepng_chunk_find(unsigned char* chunk, unsigned char* end, const char type[5]);
1079
const unsigned char* lodepng_chunk_find_const(const unsigned char* chunk, const unsigned char* end, const char type[5]);
1080
1081
/*
1082
Appends chunk to the data in out. The given chunk should already have its chunk header.
1083
The out variable and outsize are updated to reflect the new reallocated buffer.
1084
Returns error code (0 if it went ok)
1085
*/
1086
unsigned lodepng_chunk_append(unsigned char** out, size_t* outsize, const unsigned char* chunk);
1087
1088
/*
1089
Appends new chunk to out. The chunk to append is given by giving its length, type
1090
and data separately. The type is a 4-letter string.
1091
The out variable and outsize are updated to reflect the new reallocated buffer.
1092
Returne error code (0 if it went ok)
1093
*/
1094
unsigned lodepng_chunk_create(unsigned char** out, size_t* outsize, size_t length,
1095
const char* type, const unsigned char* data);
1096
1097
1098
/*Calculate CRC32 of buffer*/
1099
unsigned lodepng_crc32(const unsigned char* buf, size_t len);
1100
#endif /*LODEPNG_COMPILE_PNG*/
1101
1102
1103
#ifdef LODEPNG_COMPILE_ZLIB
1104
/*
1105
This zlib part can be used independently to zlib compress and decompress a
1106
buffer. It cannot be used to create gzip files however, and it only supports the
1107
part of zlib that is required for PNG, it does not support dictionaries.
1108
*/
1109
1110
#ifdef LODEPNG_COMPILE_DECODER
1111
/*Inflate a buffer. Inflate is the decompression step of deflate. Out buffer must be freed after use.*/
1112
unsigned lodepng_inflate(unsigned char** out, size_t* outsize,
1113
const unsigned char* in, size_t insize,
1114
const LodePNGDecompressSettings* settings);
1115
1116
/*
1117
Decompresses Zlib data. Reallocates the out buffer and appends the data. The
1118
data must be according to the zlib specification.
1119
Either, *out must be NULL and *outsize must be 0, or, *out must be a valid
1120
buffer and *outsize its size in bytes. out must be freed by user after usage.
1121
*/
1122
unsigned lodepng_zlib_decompress(unsigned char** out, size_t* outsize,
1123
const unsigned char* in, size_t insize,
1124
const LodePNGDecompressSettings* settings);
1125
#endif /*LODEPNG_COMPILE_DECODER*/
1126
1127
#ifdef LODEPNG_COMPILE_ENCODER
1128
/*
1129
Compresses data with Zlib. Reallocates the out buffer and appends the data.
1130
Zlib adds a small header and trailer around the deflate data.
1131
The data is output in the format of the zlib specification.
1132
Either, *out must be NULL and *outsize must be 0, or, *out must be a valid
1133
buffer and *outsize its size in bytes. out must be freed by user after usage.
1134
*/
1135
unsigned lodepng_zlib_compress(unsigned char** out, size_t* outsize,
1136
const unsigned char* in, size_t insize,
1137
const LodePNGCompressSettings* settings);
1138
1139
/*
1140
Find length-limited Huffman code for given frequencies. This function is in the
1141
public interface only for tests, it's used internally by lodepng_deflate.
1142
*/
1143
unsigned lodepng_huffman_code_lengths(unsigned* lengths, const unsigned* frequencies,
1144
size_t numcodes, unsigned maxbitlen);
1145
1146
/*Compress a buffer with deflate. See RFC 1951. Out buffer must be freed after use.*/
1147
unsigned lodepng_deflate(unsigned char** out, size_t* outsize,
1148
const unsigned char* in, size_t insize,
1149
const LodePNGCompressSettings* settings);
1150
1151
#endif /*LODEPNG_COMPILE_ENCODER*/
1152
#endif /*LODEPNG_COMPILE_ZLIB*/
1153
1154
#ifdef LODEPNG_COMPILE_DISK
1155
/*
1156
Load a file from disk into buffer. The function allocates the out buffer, and
1157
after usage you should free it.
1158
out: output parameter, contains pointer to loaded buffer.
1159
outsize: output parameter, size of the allocated out buffer
1160
filename: the path to the file to load
1161
return value: error code (0 means ok)
1162
1163
NOTE: Wide-character filenames are not supported, you can use an external method
1164
to handle such files and decode in-memory.
1165
*/
1166
unsigned lodepng_load_file(unsigned char** out, size_t* outsize, const char* filename);
1167
1168
/*
1169
Save a file from buffer to disk. Warning, if it exists, this function overwrites
1170
the file without warning!
1171
buffer: the buffer to write
1172
buffersize: size of the buffer to write
1173
filename: the path to the file to save to
1174
return value: error code (0 means ok)
1175
1176
NOTE: Wide-character filenames are not supported, you can use an external method
1177
to handle such files and encode in-memory
1178
*/
1179
unsigned lodepng_save_file(const unsigned char* buffer, size_t buffersize, const char* filename);
1180
#endif /*LODEPNG_COMPILE_DISK*/
1181
1182
#ifdef LODEPNG_COMPILE_CPP
1183
/* The LodePNG C++ wrapper uses std::vectors instead of manually allocated memory buffers. */
1184
namespace lodepng {
1185
#ifdef LODEPNG_COMPILE_PNG
1186
class State : public LodePNGState {
1187
public:
1188
State();
1189
State(const State& other);
1190
~State();
1191
State& operator=(const State& other);
1192
};
1193
1194
#ifdef LODEPNG_COMPILE_DECODER
1195
/* Same as other lodepng::decode, but using a State for more settings and information. */
1196
unsigned decode(std::vector<unsigned char>& out, unsigned& w, unsigned& h,
1197
State& state,
1198
const unsigned char* in, size_t insize);
1199
unsigned decode(std::vector<unsigned char>& out, unsigned& w, unsigned& h,
1200
State& state,
1201
const std::vector<unsigned char>& in);
1202
#endif /*LODEPNG_COMPILE_DECODER*/
1203
1204
#ifdef LODEPNG_COMPILE_ENCODER
1205
/* Same as other lodepng::encode, but using a State for more settings and information. */
1206
unsigned encode(std::vector<unsigned char>& out,
1207
const unsigned char* in, unsigned w, unsigned h,
1208
State& state);
1209
unsigned encode(std::vector<unsigned char>& out,
1210
const std::vector<unsigned char>& in, unsigned w, unsigned h,
1211
State& state);
1212
#endif /*LODEPNG_COMPILE_ENCODER*/
1213
1214
#ifdef LODEPNG_COMPILE_DISK
1215
/*
1216
Load a file from disk into an std::vector.
1217
return value: error code (0 means ok)
1218
1219
NOTE: Wide-character filenames are not supported, you can use an external method
1220
to handle such files and decode in-memory
1221
*/
1222
unsigned load_file(std::vector<unsigned char>& buffer, const std::string& filename);
1223
1224
/*
1225
Save the binary data in an std::vector to a file on disk. The file is overwritten
1226
without warning.
1227
1228
NOTE: Wide-character filenames are not supported, you can use an external method
1229
to handle such files and encode in-memory
1230
*/
1231
unsigned save_file(const std::vector<unsigned char>& buffer, const std::string& filename);
1232
#endif /* LODEPNG_COMPILE_DISK */
1233
#endif /* LODEPNG_COMPILE_PNG */
1234
1235
#ifdef LODEPNG_COMPILE_ZLIB
1236
#ifdef LODEPNG_COMPILE_DECODER
1237
/* Zlib-decompress an unsigned char buffer */
1238
unsigned decompress(std::vector<unsigned char>& out, const unsigned char* in, size_t insize,
1239
const LodePNGDecompressSettings& settings = lodepng_default_decompress_settings);
1240
1241
/* Zlib-decompress an std::vector */
1242
unsigned decompress(std::vector<unsigned char>& out, const std::vector<unsigned char>& in,
1243
const LodePNGDecompressSettings& settings = lodepng_default_decompress_settings);
1244
#endif /* LODEPNG_COMPILE_DECODER */
1245
1246
#ifdef LODEPNG_COMPILE_ENCODER
1247
/* Zlib-compress an unsigned char buffer */
1248
unsigned compress(std::vector<unsigned char>& out, const unsigned char* in, size_t insize,
1249
const LodePNGCompressSettings& settings = lodepng_default_compress_settings);
1250
1251
/* Zlib-compress an std::vector */
1252
unsigned compress(std::vector<unsigned char>& out, const std::vector<unsigned char>& in,
1253
const LodePNGCompressSettings& settings = lodepng_default_compress_settings);
1254
#endif /* LODEPNG_COMPILE_ENCODER */
1255
#endif /* LODEPNG_COMPILE_ZLIB */
1256
} /* namespace lodepng */
1257
#endif /*LODEPNG_COMPILE_CPP*/
1258
1259
/*
1260
TODO:
1261
[.] test if there are no memory leaks or security exploits - done a lot but needs to be checked often
1262
[.] check compatibility with various compilers - done but needs to be redone for every newer version
1263
[X] converting color to 16-bit per channel types
1264
[X] support color profile chunk types (but never let them touch RGB values by default)
1265
[ ] support all second edition public PNG chunk types (almost done except sPLT and hIST)
1266
[X] support non-animation third edition public PNG chunk types: eXIf, cICP, mDCV, cLLI
1267
[ ] make sure encoder generates no chunks with size > (2^31)-1
1268
[ ] partial decoding (stream processing)
1269
[X] let the "isFullyOpaque" function check color keys and transparent palettes too
1270
[X] better name for the variables "codes", "codesD", "codelengthcodes", "clcl" and "lldl"
1271
[ ] allow treating some errors like warnings, when image is recoverable (e.g. 69, 57, 58)
1272
[ ] make warnings like: oob palette, checksum fail, data after iend, wrong/unknown crit chunk, no null terminator in text, ...
1273
[ ] error messages with line numbers (and version)
1274
[ ] errors in state instead of as return code?
1275
[ ] new errors/warnings like suspiciously big decompressed ztxt or iccp chunk
1276
[ ] let the C++ wrapper catch exceptions coming from the standard library and return LodePNG error codes
1277
[ ] allow user to provide custom color conversion functions, e.g. for premultiplied alpha, padding bits or not, ...
1278
[ ] allow user to give data (void*) to custom allocator
1279
[X] provide alternatives for C library functions not present on some platforms (memcpy, ...)
1280
*/
1281
1282
#endif /*LODEPNG_H inclusion guard*/
1283
1284
/*
1285
LodePNG Documentation
1286
---------------------
1287
1288
0. table of contents
1289
--------------------
1290
1291
1. about
1292
1.1. supported features
1293
1.2. features not supported
1294
2. C and C++ version
1295
3. security
1296
4. decoding
1297
5. encoding
1298
6. color conversions
1299
6.1. PNG color types
1300
6.2. color conversions
1301
6.3. padding bits
1302
6.4. A note about 16-bits per channel and endianness
1303
7. error values
1304
8. chunks and PNG editing
1305
9. compiler support
1306
10. examples
1307
10.1. decoder C++ example
1308
10.2. decoder C example
1309
11. state settings reference
1310
12. changes
1311
13. contact information
1312
1313
1314
1. about
1315
--------
1316
1317
PNG is a file format to store raster images losslessly with good compression,
1318
supporting different color types and alpha channel.
1319
1320
LodePNG is a PNG codec according to the Portable Network Graphics (PNG)
1321
Specification (Second Edition) - W3C Recommendation 10 November 2003.
1322
1323
The specifications used are:
1324
1325
*) Portable Network Graphics (PNG) Specification (Second Edition):
1326
http://www.w3.org/TR/2003/REC-PNG-20031110
1327
*) RFC 1950 ZLIB Compressed Data Format version 3.3:
1328
http://www.gzip.org/zlib/rfc-zlib.html
1329
*) RFC 1951 DEFLATE Compressed Data Format Specification ver 1.3:
1330
http://www.gzip.org/zlib/rfc-deflate.html
1331
1332
The most recent version of LodePNG can currently be found at
1333
http://lodev.org/lodepng/
1334
1335
LodePNG works both in C (ISO C90) and C++, with a C++ wrapper that adds
1336
extra functionality.
1337
1338
LodePNG exists out of two files:
1339
-lodepng.h: the header file for both C and C++
1340
-lodepng.c(pp): give it the name lodepng.c or lodepng.cpp (or .cc) depending on your usage
1341
1342
If you want to start using LodePNG right away without reading this doc, get the
1343
examples from the LodePNG website to see how to use it in code, or check the
1344
smaller examples in chapter 13 here.
1345
1346
LodePNG is simple but only supports the basic requirements. To achieve
1347
simplicity, the following design choices were made: There are no dependencies
1348
on any external library. There are functions to decode and encode a PNG with
1349
a single function call, and extended versions of these functions taking a
1350
LodePNGState struct allowing to specify or get more information. By default
1351
the colors of the raw image are always RGB or RGBA, no matter what color type
1352
the PNG file uses. To read and write files, there are simple functions to
1353
convert the files to/from buffers in memory.
1354
1355
This all makes LodePNG suitable for loading textures in games, demos and small
1356
programs, ... It's less suitable for full fledged image editors, loading PNGs
1357
over network (it requires all the image data to be available before decoding can
1358
begin), life-critical systems, ...
1359
1360
1.1. supported features
1361
-----------------------
1362
1363
The following features are supported by the decoder:
1364
1365
*) decoding of PNGs with any color type, bit depth and interlace mode, to a 24- or 32-bit color raw image,
1366
or the same color type as the PNG
1367
*) encoding of PNGs, from any raw image to 24- or 32-bit color, or the same color type as the raw image
1368
*) Adam7 interlace and deinterlace for any color type
1369
*) loading the image from harddisk or decoding it from a buffer from other sources than harddisk
1370
*) support for alpha channels, including RGBA color model, translucent palettes and color keying
1371
*) zlib decompression (inflate)
1372
*) zlib compression (deflate)
1373
*) CRC32 and ADLER32 checksums
1374
*) colorimetric color profile conversions: currently experimentally available in lodepng_util.cpp only,
1375
plus alternatively ability to pass on chroma/gamma/ICC profile information to other color management system.
1376
*) handling of unknown chunks, allowing making a PNG editor that stores custom and unknown chunks.
1377
*) the following chunks are supported by both encoder and decoder:
1378
IHDR: header information
1379
PLTE: color palette
1380
IDAT: pixel data
1381
IEND: the final chunk
1382
tRNS: transparency for palettized images
1383
tEXt: textual information
1384
zTXt: compressed textual information
1385
iTXt: international textual information
1386
bKGD: suggested background color
1387
pHYs: physical dimensions
1388
tIME: modification time
1389
cHRM: RGB chromaticities
1390
gAMA: RGB gamma correction
1391
iCCP: ICC color profile
1392
sRGB: rendering intent
1393
sBIT: significant bits
1394
1395
1.2. features not supported
1396
---------------------------
1397
1398
The following features are not (yet) supported:
1399
1400
*) some features needed to make a conformant PNG-Editor might be still missing.
1401
*) partial loading/stream processing. All data must be available and is processed in one call.
1402
*) The hIST and sPLT public chunks are not (yet) supported but treated as unknown chunks
1403
1404
1405
2. C and C++ version
1406
--------------------
1407
1408
The C version uses buffers allocated with alloc that you need to free()
1409
yourself. You need to use init and cleanup functions for each struct whenever
1410
using a struct from the C version to avoid exploits and memory leaks.
1411
1412
The C++ version has extra functions with std::vectors in the interface and the
1413
lodepng::State class which is a LodePNGState with constructor and destructor.
1414
1415
These files work without modification for both C and C++ compilers because all
1416
the additional C++ code is in "#ifdef __cplusplus" blocks that make C-compilers
1417
ignore it, and the C code is made to compile both with strict ISO C90 and C++.
1418
1419
To use the C++ version, you need to rename the source file to lodepng.cpp
1420
(instead of lodepng.c), and compile it with a C++ compiler.
1421
1422
To use the C version, you need to rename the source file to lodepng.c (instead
1423
of lodepng.cpp), and compile it with a C compiler.
1424
1425
1426
3. Security
1427
-----------
1428
1429
Even if carefully designed, it's always possible that LodePNG contains possible
1430
exploits. If you discover one, please let me know, and it will be fixed.
1431
1432
When using LodePNG, care has to be taken with the C version of LodePNG, as well
1433
as the C-style structs when working with C++. The following conventions are used
1434
for all C-style structs:
1435
1436
-if a struct has a corresponding init function, always call the init function when making a new one
1437
-if a struct has a corresponding cleanup function, call it before the struct disappears to avoid memory leaks
1438
-if a struct has a corresponding copy function, use the copy function instead of "=".
1439
The destination must also be inited already.
1440
1441
1442
4. Decoding
1443
-----------
1444
1445
Decoding converts a PNG compressed image to a raw pixel buffer.
1446
1447
Most documentation on using the decoder is at its declarations in the header
1448
above. For C, simple decoding can be done with functions such as
1449
lodepng_decode32, and more advanced decoding can be done with the struct
1450
LodePNGState and lodepng_decode. For C++, all decoding can be done with the
1451
various lodepng::decode functions, and lodepng::State can be used for advanced
1452
features.
1453
1454
When using the LodePNGState, it uses the following fields for decoding:
1455
*) LodePNGInfo info_png: it stores extra information about the PNG (the input) in here
1456
*) LodePNGColorMode info_raw: here you can say what color mode of the raw image (the output) you want to get
1457
*) LodePNGDecoderSettings decoder: you can specify a few extra settings for the decoder to use
1458
1459
LodePNGInfo info_png
1460
--------------------
1461
1462
After decoding, this contains extra information of the PNG image, except the actual
1463
pixels, width and height because these are already gotten directly from the decoder
1464
functions.
1465
1466
It contains for example the original color type of the PNG image, text comments,
1467
suggested background color, etc... More details about the LodePNGInfo struct are
1468
at its declaration documentation.
1469
1470
LodePNGColorMode info_raw
1471
-------------------------
1472
1473
When decoding, here you can specify which color type you want
1474
the resulting raw image to be. If this is different from the colortype of the
1475
PNG, then the decoder will automatically convert the result. This conversion
1476
always works, except if you want it to convert a color PNG to grayscale or to
1477
a palette with missing colors.
1478
1479
By default, 32-bit color is used for the result.
1480
1481
LodePNGDecoderSettings decoder
1482
------------------------------
1483
1484
The settings can be used to ignore the errors created by invalid CRC and Adler32
1485
chunks, and to disable the decoding of tEXt chunks.
1486
1487
There's also a setting color_convert, true by default. If false, no conversion
1488
is done, the resulting data will be as it was in the PNG (after decompression)
1489
and you'll have to puzzle the colors of the pixels together yourself using the
1490
color type information in the LodePNGInfo.
1491
1492
1493
5. Encoding
1494
-----------
1495
1496
Encoding converts a raw pixel buffer to a PNG compressed image.
1497
1498
Most documentation on using the encoder is at its declarations in the header
1499
above. For C, simple encoding can be done with functions such as
1500
lodepng_encode32, and more advanced decoding can be done with the struct
1501
LodePNGState and lodepng_encode. For C++, all encoding can be done with the
1502
various lodepng::encode functions, and lodepng::State can be used for advanced
1503
features.
1504
1505
Like the decoder, the encoder can also give errors. However it gives less errors
1506
since the encoder input is trusted, the decoder input (a PNG image that could
1507
be forged by anyone) is not trusted.
1508
1509
When using the LodePNGState, it uses the following fields for encoding:
1510
*) LodePNGInfo info_png: here you specify how you want the PNG (the output) to be.
1511
*) LodePNGColorMode info_raw: here you say what color type of the raw image (the input) has
1512
*) LodePNGEncoderSettings encoder: you can specify a few settings for the encoder to use
1513
1514
LodePNGInfo info_png
1515
--------------------
1516
1517
When encoding, you use this the opposite way as when decoding: for encoding,
1518
you fill in the values you want the PNG to have before encoding. By default it's
1519
not needed to specify a color type for the PNG since it's automatically chosen,
1520
but it's possible to choose it yourself given the right settings.
1521
1522
The encoder will not always exactly match the LodePNGInfo struct you give,
1523
it tries as close as possible. Some things are ignored by the encoder. The
1524
encoder uses, for example, the following settings from it when applicable:
1525
colortype and bitdepth, text chunks, time chunk, the color key, the palette, the
1526
background color, the interlace method, unknown chunks, ...
1527
1528
When encoding to a PNG with colortype 3, the encoder will generate a PLTE chunk.
1529
If the palette contains any colors for which the alpha channel is not 255 (so
1530
there are translucent colors in the palette), it'll add a tRNS chunk.
1531
1532
LodePNGColorMode info_raw
1533
-------------------------
1534
1535
You specify the color type of the raw image that you give to the input here,
1536
including a possible transparent color key and palette you happen to be using in
1537
your raw image data.
1538
1539
By default, 32-bit color is assumed, meaning your input has to be in RGBA
1540
format with 4 bytes (unsigned chars) per pixel.
1541
1542
LodePNGEncoderSettings encoder
1543
------------------------------
1544
1545
The following settings are supported (some are in sub-structs):
1546
*) auto_convert: when this option is enabled, the encoder will
1547
automatically choose the smallest possible color mode (including color key) that
1548
can encode the colors of all pixels without information loss.
1549
*) btype: the block type for LZ77. 0 = uncompressed, 1 = fixed huffman tree,
1550
2 = dynamic huffman tree (best compression). Should be 2 for proper
1551
compression.
1552
*) use_lz77: whether or not to use LZ77 for compressed block types. Should be
1553
true for proper compression.
1554
*) windowsize: the window size used by the LZ77 encoder (1 - 32768). Has value
1555
2048 by default, but can be set to 32768 for better, but slow, compression.
1556
*) force_palette: if colortype is 2 or 6, you can make the encoder write a PLTE
1557
chunk if force_palette is true. This can used as suggested palette to convert
1558
to by viewers that don't support more than 256 colors (if those still exist)
1559
*) add_id: add text chunk "Encoder: LodePNG <version>" to the image.
1560
*) text_compression: default 1. If 1, it'll store texts as zTXt instead of tEXt chunks.
1561
zTXt chunks use zlib compression on the text. This gives a smaller result on
1562
large texts but a larger result on small texts (such as a single program name).
1563
It's all tEXt or all zTXt though, there's no separate setting per text yet.
1564
1565
1566
6. color conversions
1567
--------------------
1568
1569
An important thing to note about LodePNG, is that the color type of the PNG, and
1570
the color type of the raw image, are completely independent. By default, when
1571
you decode a PNG, you get the result as a raw image in the color type you want,
1572
no matter whether the PNG was encoded with a palette, grayscale or RGBA color.
1573
And if you encode an image, by default LodePNG will automatically choose the PNG
1574
color type that gives good compression based on the values of colors and amount
1575
of colors in the image. It can be configured to let you control it instead as
1576
well, though.
1577
1578
To be able to do this, LodePNG does conversions from one color mode to another.
1579
It can convert from almost any color type to any other color type, except the
1580
following conversions: RGB to grayscale is not supported, and converting to a
1581
palette when the palette doesn't have a required color is not supported. This is
1582
not supported on purpose: this is information loss which requires a color
1583
reduction algorithm that is beyond the scope of a PNG encoder (yes, RGB to gray
1584
is easy, but there are multiple ways if you want to give some channels more
1585
weight).
1586
1587
By default, when decoding, you get the raw image in 32-bit RGBA or 24-bit RGB
1588
color, no matter what color type the PNG has. And by default when encoding,
1589
LodePNG automatically picks the best color model for the output PNG, and expects
1590
the input image to be 32-bit RGBA or 24-bit RGB. So, unless you want to control
1591
the color format of the images yourself, you can skip this chapter.
1592
1593
6.1. PNG color types
1594
--------------------
1595
1596
A PNG image can have many color types, ranging from 1-bit color to 64-bit color,
1597
as well as palettized color modes. After the zlib decompression and unfiltering
1598
in the PNG image is done, the raw pixel data will have that color type and thus
1599
a certain amount of bits per pixel. If you want the output raw image after
1600
decoding to have another color type, a conversion is done by LodePNG.
1601
1602
The PNG specification gives the following color types:
1603
1604
0: grayscale, bit depths 1, 2, 4, 8, 16
1605
2: RGB, bit depths 8 and 16
1606
3: palette, bit depths 1, 2, 4 and 8
1607
4: grayscale with alpha, bit depths 8 and 16
1608
6: RGBA, bit depths 8 and 16
1609
1610
Bit depth is the amount of bits per pixel per color channel. So the total amount
1611
of bits per pixel is: amount of channels * bitdepth.
1612
1613
6.2. color conversions
1614
----------------------
1615
1616
As explained in the sections about the encoder and decoder, you can specify
1617
color types and bit depths in info_png and info_raw to change the default
1618
behaviour.
1619
1620
If, when decoding, you want the raw image to be something else than the default,
1621
you need to set the color type and bit depth you want in the LodePNGColorMode,
1622
or the parameters colortype and bitdepth of the simple decoding function.
1623
1624
If, when encoding, you use another color type than the default in the raw input
1625
image, you need to specify its color type and bit depth in the LodePNGColorMode
1626
of the raw image, or use the parameters colortype and bitdepth of the simple
1627
encoding function.
1628
1629
If, when encoding, you don't want LodePNG to choose the output PNG color type
1630
but control it yourself, you need to set auto_convert in the encoder settings
1631
to false, and specify the color type you want in the LodePNGInfo of the
1632
encoder (including palette: it can generate a palette if auto_convert is true,
1633
otherwise not).
1634
1635
If the input and output color type differ (whether user chosen or auto chosen),
1636
LodePNG will do a color conversion, which follows the rules below, and may
1637
sometimes result in an error.
1638
1639
To avoid some confusion:
1640
-the decoder converts from PNG to raw image
1641
-the encoder converts from raw image to PNG
1642
-the colortype and bitdepth in LodePNGColorMode info_raw, are those of the raw image
1643
-the colortype and bitdepth in the color field of LodePNGInfo info_png, are those of the PNG
1644
-when encoding, the color type in LodePNGInfo is ignored if auto_convert
1645
is enabled, it is automatically generated instead
1646
-when decoding, the color type in LodePNGInfo is set by the decoder to that of the original
1647
PNG image, but it can be ignored since the raw image has the color type you requested instead
1648
-if the color type of the LodePNGColorMode and PNG image aren't the same, a conversion
1649
between the color types is done if the color types are supported. If it is not
1650
supported, an error is returned. If the types are the same, no conversion is done.
1651
-even though some conversions aren't supported, LodePNG supports loading PNGs from any
1652
colortype and saving PNGs to any colortype, sometimes it just requires preparing
1653
the raw image correctly before encoding.
1654
-both encoder and decoder use the same color converter.
1655
1656
The function lodepng_convert does the color conversion. It is available in the
1657
interface but normally isn't needed since the encoder and decoder already call
1658
it.
1659
1660
Non supported color conversions:
1661
-color to grayscale when non-gray pixels are present: no error is thrown, but
1662
the result will look ugly because only the red channel is taken (it assumes all
1663
three channels are the same in this case so ignores green and blue). The reason
1664
no error is given is to allow converting from three-channel grayscale images to
1665
one-channel even if there are numerical imprecisions.
1666
-anything to palette when the palette does not have an exact match for a from-color
1667
in it: in this case an error is thrown
1668
1669
Supported color conversions:
1670
-anything to 8-bit RGB, 8-bit RGBA, 16-bit RGB, 16-bit RGBA
1671
-any gray or gray+alpha, to gray or gray+alpha
1672
-anything to a palette, as long as the palette has the requested colors in it
1673
-removing alpha channel
1674
-higher to smaller bitdepth, and vice versa
1675
1676
If you want no color conversion to be done (e.g. for speed or control):
1677
-In the encoder, you can make it save a PNG with any color type by giving the
1678
raw color mode and LodePNGInfo the same color mode, and setting auto_convert to
1679
false.
1680
-In the decoder, you can make it store the pixel data in the same color type
1681
as the PNG has, by setting the color_convert setting to false. Settings in
1682
info_raw are then ignored.
1683
1684
6.3. padding bits
1685
-----------------
1686
1687
In the PNG file format, if a less than 8-bit per pixel color type is used and the scanlines
1688
have a bit amount that isn't a multiple of 8, then padding bits are used so that each
1689
scanline starts at a fresh byte. But that is NOT true for the LodePNG raw input and output.
1690
The raw input image you give to the encoder, and the raw output image you get from the decoder
1691
will NOT have these padding bits, e.g. in the case of a 1-bit image with a width
1692
of 7 pixels, the first pixel of the second scanline will the 8th bit of the first byte,
1693
not the first bit of a new byte.
1694
1695
6.4. A note about 16-bits per channel and endianness
1696
----------------------------------------------------
1697
1698
LodePNG uses unsigned char arrays for 16-bit per channel colors too, just like
1699
for any other color format. The 16-bit values are stored in big endian (most
1700
significant byte first) in these arrays. This is the opposite order of the
1701
little endian used by x86 CPU's.
1702
1703
LodePNG always uses big endian because the PNG file format does so internally.
1704
Conversions to other formats than PNG uses internally are not supported by
1705
LodePNG on purpose, there are myriads of formats, including endianness of 16-bit
1706
colors, the order in which you store R, G, B and A, and so on. Supporting and
1707
converting to/from all that is outside the scope of LodePNG.
1708
1709
This may mean that, depending on your use case, you may want to convert the big
1710
endian output of LodePNG to little endian with a for loop. This is certainly not
1711
always needed, many applications and libraries support big endian 16-bit colors
1712
anyway, but it means you cannot simply cast the unsigned char* buffer to an
1713
unsigned short* buffer on x86 CPUs.
1714
1715
1716
7. error values
1717
---------------
1718
1719
All functions in LodePNG that return an error code, return 0 if everything went
1720
OK, or a non-zero code if there was an error.
1721
1722
The meaning of the LodePNG error values can be retrieved with the function
1723
lodepng_error_text: given the numerical error code, it returns a description
1724
of the error in English as a string.
1725
1726
Check the implementation of lodepng_error_text to see the meaning of each code.
1727
1728
It is not recommended to use the numerical values to programmatically make
1729
different decisions based on error types as the numbers are not guaranteed to
1730
stay backwards compatible. They are for human consumption only. Programmatically
1731
only 0 or non-0 matter.
1732
1733
1734
8. chunks and PNG editing
1735
-------------------------
1736
1737
If you want to add extra chunks to a PNG you encode, or use LodePNG for a PNG
1738
editor that should follow the rules about handling of unknown chunks, or if your
1739
program is able to read other types of chunks than the ones handled by LodePNG,
1740
then that's possible with the chunk functions of LodePNG.
1741
1742
A PNG chunk has the following layout:
1743
1744
4 bytes length
1745
4 bytes type name
1746
length bytes data
1747
4 bytes CRC
1748
1749
8.1. iterating through chunks
1750
-----------------------------
1751
1752
If you have a buffer containing the PNG image data, then the first chunk (the
1753
IHDR chunk) starts at byte number 8 of that buffer. The first 8 bytes are the
1754
signature of the PNG and are not part of a chunk. But if you start at byte 8
1755
then you have a chunk, and can check the following things of it.
1756
1757
NOTE: none of these functions check for memory buffer boundaries. To avoid
1758
exploits, always make sure the buffer contains all the data of the chunks.
1759
When using lodepng_chunk_next, make sure the returned value is within the
1760
allocated memory.
1761
1762
unsigned lodepng_chunk_length(const unsigned char* chunk):
1763
1764
Get the length of the chunk's data. The total chunk length is this length + 12.
1765
1766
void lodepng_chunk_type(char type[5], const unsigned char* chunk):
1767
unsigned char lodepng_chunk_type_equals(const unsigned char* chunk, const char* type):
1768
1769
Get the type of the chunk or compare if it's a certain type
1770
1771
unsigned char lodepng_chunk_critical(const unsigned char* chunk):
1772
unsigned char lodepng_chunk_private(const unsigned char* chunk):
1773
unsigned char lodepng_chunk_safetocopy(const unsigned char* chunk):
1774
1775
Check if the chunk is critical in the PNG standard (only IHDR, PLTE, IDAT and IEND are).
1776
Check if the chunk is private (public chunks are part of the standard, private ones not).
1777
Check if the chunk is safe to copy. If it's not, then, when modifying data in a critical
1778
chunk, unsafe to copy chunks of the old image may NOT be saved in the new one if your
1779
program doesn't handle that type of unknown chunk.
1780
1781
unsigned char* lodepng_chunk_data(unsigned char* chunk):
1782
const unsigned char* lodepng_chunk_data_const(const unsigned char* chunk):
1783
1784
Get a pointer to the start of the data of the chunk.
1785
1786
unsigned lodepng_chunk_check_crc(const unsigned char* chunk):
1787
void lodepng_chunk_generate_crc(unsigned char* chunk):
1788
1789
Check if the crc is correct or generate a correct one.
1790
1791
unsigned char* lodepng_chunk_next(unsigned char* chunk):
1792
const unsigned char* lodepng_chunk_next_const(const unsigned char* chunk):
1793
1794
Iterate to the next chunk. This works if you have a buffer with consecutive chunks. Note that these
1795
functions do no boundary checking of the allocated data whatsoever, so make sure there is enough
1796
data available in the buffer to be able to go to the next chunk.
1797
1798
unsigned lodepng_chunk_append(unsigned char** out, size_t* outsize, const unsigned char* chunk):
1799
unsigned lodepng_chunk_create(unsigned char** out, size_t* outsize, unsigned length,
1800
const char* type, const unsigned char* data):
1801
1802
These functions are used to create new chunks that are appended to the data in *out that has
1803
length *outsize. The append function appends an existing chunk to the new data. The create
1804
function creates a new chunk with the given parameters and appends it. Type is the 4-letter
1805
name of the chunk.
1806
1807
8.2. chunks in info_png
1808
-----------------------
1809
1810
The LodePNGInfo struct contains fields with the unknown chunk in it. It has 3
1811
buffers (each with size) to contain 3 types of unknown chunks:
1812
the ones that come before the PLTE chunk, the ones that come between the PLTE
1813
and the IDAT chunks, and the ones that come after the IDAT chunks.
1814
It's necessary to make the distinction between these 3 cases because the PNG
1815
standard forces to keep the ordering of unknown chunks compared to the critical
1816
chunks, but does not force any other ordering rules.
1817
1818
info_png.unknown_chunks_data[0] is the chunks before PLTE
1819
info_png.unknown_chunks_data[1] is the chunks after PLTE, before IDAT
1820
info_png.unknown_chunks_data[2] is the chunks after IDAT
1821
1822
The chunks in these 3 buffers can be iterated through and read by using the same
1823
way described in the previous subchapter.
1824
1825
When using the decoder to decode a PNG, you can make it store all unknown chunks
1826
if you set the option settings.remember_unknown_chunks to 1. By default, this
1827
option is off (0).
1828
1829
The encoder will always encode unknown chunks that are stored in the info_png.
1830
If you need it to add a particular chunk that isn't known by LodePNG, you can
1831
use lodepng_chunk_append or lodepng_chunk_create to the chunk data in
1832
info_png.unknown_chunks_data[x].
1833
1834
Chunks that are known by LodePNG should not be added in that way. E.g. to make
1835
LodePNG add a bKGD chunk, set background_defined to true and add the correct
1836
parameters there instead.
1837
1838
1839
9. compiler support
1840
-------------------
1841
1842
No libraries other than the current standard C library are needed to compile
1843
LodePNG. For the C++ version, only the standard C++ library is needed on top.
1844
Add the files lodepng.c(pp) and lodepng.h to your project, include
1845
lodepng.h where needed, and your program can read/write PNG files.
1846
1847
It is compatible with C90 and up, and C++03 and up.
1848
1849
If performance is important, use optimization when compiling! For both the
1850
encoder and decoder, this makes a large difference.
1851
1852
Make sure that LodePNG is compiled with the same compiler of the same version
1853
and with the same settings as the rest of the program, or the interfaces with
1854
std::vectors and std::strings in C++ can be incompatible.
1855
1856
CHAR_BITS must be 8 or higher, because LodePNG uses unsigned chars for octets.
1857
1858
*) gcc and g++
1859
1860
LodePNG is developed in gcc so this compiler is natively supported. It gives no
1861
warnings with compiler options "-Wall -Wextra -pedantic -ansi", with gcc and g++
1862
version 4.7.1 on Linux, 32-bit and 64-bit.
1863
1864
*) Clang
1865
1866
Fully supported and warning-free.
1867
1868
*) Mingw
1869
1870
The Mingw compiler (a port of gcc for Windows) should be fully supported by
1871
LodePNG.
1872
1873
*) Visual Studio and Visual C++ Express Edition
1874
1875
LodePNG should be warning-free with warning level W4. Two warnings were disabled
1876
with pragmas though: warning 4244 about implicit conversions, and warning 4996
1877
where it wants to use a non-standard function fopen_s instead of the standard C
1878
fopen.
1879
1880
Visual Studio may want "stdafx.h" files to be included in each source file and
1881
give an error "unexpected end of file while looking for precompiled header".
1882
This is not standard C++ and will not be added to the stock LodePNG. You can
1883
disable it for lodepng.cpp only by right clicking it, Properties, C/C++,
1884
Precompiled Headers, and set it to Not Using Precompiled Headers there.
1885
1886
NOTE: Modern versions of VS should be fully supported, but old versions, e.g.
1887
VS6, are not guaranteed to work.
1888
1889
*) Compilers on Macintosh
1890
1891
LodePNG has been reported to work both with gcc and LLVM for Macintosh, both for
1892
C and C++.
1893
1894
*) Other Compilers
1895
1896
If you encounter problems on any compilers, feel free to let me know and I may
1897
try to fix it if the compiler is modern and standards compliant.
1898
1899
1900
10. examples
1901
------------
1902
1903
This decoder example shows the most basic usage of LodePNG. More complex
1904
examples can be found on the LodePNG website.
1905
1906
NOTE: these examples do not support wide-character filenames, you can use an
1907
external method to handle such files and encode or decode in-memory
1908
1909
10.1. decoder C++ example
1910
-------------------------
1911
1912
#include "lodepng.h"
1913
#include <iostream>
1914
1915
int main(int argc, char *argv[]) {
1916
const char* filename = argc > 1 ? argv[1] : "test.png";
1917
1918
//load and decode
1919
std::vector<unsigned char> image;
1920
unsigned width, height;
1921
unsigned error = lodepng::decode(image, width, height, filename);
1922
1923
//if there's an error, display it
1924
if(error) std::cout << "decoder error " << error << ": " << lodepng_error_text(error) << std::endl;
1925
1926
//the pixels are now in the vector "image", 4 bytes per pixel, ordered RGBARGBA..., use it as texture, draw it, ...
1927
}
1928
1929
10.2. decoder C example
1930
-----------------------
1931
1932
#include "lodepng.h"
1933
1934
int main(int argc, char *argv[]) {
1935
unsigned error;
1936
unsigned char* image;
1937
size_t width, height;
1938
const char* filename = argc > 1 ? argv[1] : "test.png";
1939
1940
error = lodepng_decode32_file(&image, &width, &height, filename);
1941
1942
if(error) printf("decoder error %u: %s\n", error, lodepng_error_text(error));
1943
1944
/ * use image here * /
1945
1946
free(image);
1947
return 0;
1948
}
1949
1950
11. state settings reference
1951
----------------------------
1952
1953
A quick reference of some settings to set on the LodePNGState
1954
1955
For decoding:
1956
1957
state.decoder.zlibsettings.ignore_adler32: ignore ADLER32 checksums
1958
state.decoder.zlibsettings.custom_...: use custom inflate function
1959
state.decoder.ignore_crc: ignore CRC checksums
1960
state.decoder.ignore_critical: ignore unknown critical chunks
1961
state.decoder.ignore_end: ignore missing IEND chunk. May fail if this corruption causes other errors
1962
state.decoder.color_convert: convert internal PNG color to chosen one
1963
state.decoder.read_text_chunks: whether to read in text metadata chunks
1964
state.decoder.remember_unknown_chunks: whether to read in unknown chunks
1965
state.info_raw.colortype: desired color type for decoded image
1966
state.info_raw.bitdepth: desired bit depth for decoded image
1967
state.info_raw....: more color settings, see struct LodePNGColorMode
1968
state.info_png....: no settings for decoder but ouput, see struct LodePNGInfo
1969
1970
For encoding:
1971
1972
state.encoder.zlibsettings.btype: disable compression by setting it to 0
1973
state.encoder.zlibsettings.use_lz77: use LZ77 in compression
1974
state.encoder.zlibsettings.windowsize: tweak LZ77 windowsize
1975
state.encoder.zlibsettings.minmatch: tweak min LZ77 length to match
1976
state.encoder.zlibsettings.nicematch: tweak LZ77 match where to stop searching
1977
state.encoder.zlibsettings.lazymatching: try one more LZ77 matching
1978
state.encoder.zlibsettings.custom_...: use custom deflate function
1979
state.encoder.auto_convert: choose optimal PNG color type, if 0 uses info_png
1980
state.encoder.filter_palette_zero: PNG filter strategy for palette
1981
state.encoder.filter_strategy: PNG filter strategy to encode with
1982
state.encoder.force_palette: add palette even if not encoding to one
1983
state.encoder.add_id: add LodePNG identifier and version as a text chunk
1984
state.encoder.text_compression: use compressed text chunks for metadata
1985
state.info_raw.colortype: color type of raw input image you provide
1986
state.info_raw.bitdepth: bit depth of raw input image you provide
1987
state.info_raw: more color settings, see struct LodePNGColorMode
1988
state.info_png.color.colortype: desired color type if auto_convert is false
1989
state.info_png.color.bitdepth: desired bit depth if auto_convert is false
1990
state.info_png.color....: more color settings, see struct LodePNGColorMode
1991
state.info_png....: more PNG related settings, see struct LodePNGInfo
1992
1993
1994
12. changes
1995
-----------
1996
1997
The version number of LodePNG is the date of the change given in the format
1998
yyyymmdd.
1999
2000
Some changes aren't backwards compatible. Those are indicated with a (!)
2001
symbol.
2002
2003
Not all changes are listed here, the commit history in github lists more:
2004
https://github.com/lvandeve/lodepng
2005
2006
*) 6 may 2025: renamed mDCv to mDCV and cLLi to cLLI as per the recent rename
2007
in the draft png third edition spec. Please note that while the third
2008
edition is not finalized, backwards-incompatible changes to its features are
2009
possible.
2010
*) 23 dec 2024: added support for the mDCv and cLLi chunks (for png third
2011
edition spec)
2012
*) 22 dec 2024: added support for the cICP chunk (for png third edition spec)
2013
*) 15 dec 2024: added support for the eXIf chunk (for png third edition spec)
2014
*) 10 apr 2023: faster CRC32 implementation, but with larger lookup table.
2015
*) 13 jun 2022: added support for the sBIT chunk.
2016
*) 09 jan 2022: minor decoder speed improvements.
2017
*) 27 jun 2021: added warnings that file reading/writing functions don't support
2018
wide-character filenames (support for this is not planned, opening files is
2019
not the core part of PNG decoding/decoding and is platform dependent).
2020
*) 17 oct 2020: prevent decoding too large text/icc chunks by default.
2021
*) 06 mar 2020: simplified some of the dynamic memory allocations.
2022
*) 12 jan 2020: (!) added 'end' argument to lodepng_chunk_next to allow correct
2023
overflow checks.
2024
*) 14 aug 2019: around 25% faster decoding thanks to huffman lookup tables.
2025
*) 15 jun 2019: (!) auto_choose_color API changed (for bugfix: don't use palette
2026
if gray ICC profile) and non-ICC LodePNGColorProfile renamed to
2027
LodePNGColorStats.
2028
*) 30 dec 2018: code style changes only: removed newlines before opening braces.
2029
*) 10 sep 2018: added way to inspect metadata chunks without full decoding.
2030
*) 19 aug 2018: (!) fixed color mode bKGD is encoded with and made it use
2031
palette index in case of palette.
2032
*) 10 aug 2018: (!) added support for gAMA, cHRM, sRGB and iCCP chunks. This
2033
change is backwards compatible unless you relied on unknown_chunks for those.
2034
*) 11 jun 2018: less restrictive check for pixel size integer overflow
2035
*) 14 jan 2018: allow optionally ignoring a few more recoverable errors
2036
*) 17 sep 2017: fix memory leak for some encoder input error cases
2037
*) 27 nov 2016: grey+alpha auto color model detection bugfix
2038
*) 18 apr 2016: Changed qsort to custom stable sort (for platforms w/o qsort).
2039
*) 09 apr 2016: Fixed colorkey usage detection, and better file loading (within
2040
the limits of pure C90).
2041
*) 08 dec 2015: Made load_file function return error if file can't be opened.
2042
*) 24 oct 2015: Bugfix with decoding to palette output.
2043
*) 18 apr 2015: Boundary PM instead of just package-merge for faster encoding.
2044
*) 24 aug 2014: Moved to github
2045
*) 23 aug 2014: Reduced needless memory usage of decoder.
2046
*) 28 jun 2014: Removed fix_png setting, always support palette OOB for
2047
simplicity. Made ColorProfile public.
2048
*) 09 jun 2014: Faster encoder by fixing hash bug and more zeros optimization.
2049
*) 22 dec 2013: Power of two windowsize required for optimization.
2050
*) 15 apr 2013: Fixed bug with LAC_ALPHA and color key.
2051
*) 25 mar 2013: Added an optional feature to ignore some PNG errors (fix_png).
2052
*) 11 mar 2013: (!) Bugfix with custom free. Changed from "my" to "lodepng_"
2053
prefix for the custom allocators and made it possible with a new #define to
2054
use custom ones in your project without needing to change lodepng's code.
2055
*) 28 jan 2013: Bugfix with color key.
2056
*) 27 oct 2012: Tweaks in text chunk keyword length error handling.
2057
*) 8 oct 2012: (!) Added new filter strategy (entropy) and new auto color mode.
2058
(no palette). Better deflate tree encoding. New compression tweak settings.
2059
Faster color conversions while decoding. Some internal cleanups.
2060
*) 23 sep 2012: Reduced warnings in Visual Studio a little bit.
2061
*) 1 sep 2012: (!) Removed #define's for giving custom (de)compression functions
2062
and made it work with function pointers instead.
2063
*) 23 jun 2012: Added more filter strategies. Made it easier to use custom alloc
2064
and free functions and toggle #defines from compiler flags. Small fixes.
2065
*) 6 may 2012: (!) Made plugging in custom zlib/deflate functions more flexible.
2066
*) 22 apr 2012: (!) Made interface more consistent, renaming a lot. Removed
2067
redundant C++ codec classes. Reduced amount of structs. Everything changed,
2068
but it is cleaner now imho and functionality remains the same. Also fixed
2069
several bugs and shrunk the implementation code. Made new samples.
2070
*) 6 nov 2011: (!) By default, the encoder now automatically chooses the best
2071
PNG color model and bit depth, based on the amount and type of colors of the
2072
raw image. For this, autoLeaveOutAlphaChannel replaced by auto_choose_color.
2073
*) 9 oct 2011: simpler hash chain implementation for the encoder.
2074
*) 8 sep 2011: lz77 encoder lazy matching instead of greedy matching.
2075
*) 23 aug 2011: tweaked the zlib compression parameters after benchmarking.
2076
A bug with the PNG filtertype heuristic was fixed, so that it chooses much
2077
better ones (it's quite significant). A setting to do an experimental, slow,
2078
brute force search for PNG filter types is added.
2079
*) 17 aug 2011: (!) changed some C zlib related function names.
2080
*) 16 aug 2011: made the code less wide (max 120 characters per line).
2081
*) 17 apr 2011: code cleanup. Bugfixes. Convert low to 16-bit per sample colors.
2082
*) 21 feb 2011: fixed compiling for C90. Fixed compiling with sections disabled.
2083
*) 11 dec 2010: encoding is made faster, based on suggestion by Peter Eastman
2084
to optimize long sequences of zeros.
2085
*) 13 nov 2010: added LodePNG_InfoColor_hasPaletteAlpha and
2086
LodePNG_InfoColor_canHaveAlpha functions for convenience.
2087
*) 7 nov 2010: added LodePNG_error_text function to get error code description.
2088
*) 30 oct 2010: made decoding slightly faster
2089
*) 26 oct 2010: (!) changed some C function and struct names (more consistent).
2090
Reorganized the documentation and the declaration order in the header.
2091
*) 08 aug 2010: only changed some comments and external samples.
2092
*) 05 jul 2010: fixed bug thanks to warnings in the new gcc version.
2093
*) 14 mar 2010: fixed bug where too much memory was allocated for char buffers.
2094
*) 02 sep 2008: fixed bug where it could create empty tree that linux apps could
2095
read by ignoring the problem but windows apps couldn't.
2096
*) 06 jun 2008: added more error checks for out of memory cases.
2097
*) 26 apr 2008: added a few more checks here and there to ensure more safety.
2098
*) 06 mar 2008: crash with encoding of strings fixed
2099
*) 02 feb 2008: support for international text chunks added (iTXt)
2100
*) 23 jan 2008: small cleanups, and #defines to divide code in sections
2101
*) 20 jan 2008: support for unknown chunks allowing using LodePNG for an editor.
2102
*) 18 jan 2008: support for tIME and pHYs chunks added to encoder and decoder.
2103
*) 17 jan 2008: ability to encode and decode compressed zTXt chunks added
2104
Also various fixes, such as in the deflate and the padding bits code.
2105
*) 13 jan 2008: Added ability to encode Adam7-interlaced images. Improved
2106
filtering code of encoder.
2107
*) 07 jan 2008: (!) changed LodePNG to use ISO C90 instead of C++. A
2108
C++ wrapper around this provides an interface almost identical to before.
2109
Having LodePNG be pure ISO C90 makes it more portable. The C and C++ code
2110
are together in these files but it works both for C and C++ compilers.
2111
*) 29 dec 2007: (!) changed most integer types to unsigned int + other tweaks
2112
*) 30 aug 2007: bug fixed which makes this Borland C++ compatible
2113
*) 09 aug 2007: some VS2005 warnings removed again
2114
*) 21 jul 2007: deflate code placed in new namespace separate from zlib code
2115
*) 08 jun 2007: fixed bug with 2- and 4-bit color, and small interlaced images
2116
*) 04 jun 2007: improved support for Visual Studio 2005: crash with accessing
2117
invalid std::vector element [0] fixed, and level 3 and 4 warnings removed
2118
*) 02 jun 2007: made the encoder add a tag with version by default
2119
*) 27 may 2007: zlib and png code separated (but still in the same file),
2120
simple encoder/decoder functions added for more simple usage cases
2121
*) 19 may 2007: minor fixes, some code cleaning, new error added (error 69),
2122
moved some examples from here to lodepng_examples.cpp
2123
*) 12 may 2007: palette decoding bug fixed
2124
*) 24 apr 2007: changed the license from BSD to the zlib license
2125
*) 11 mar 2007: very simple addition: ability to encode bKGD chunks.
2126
*) 04 mar 2007: (!) tEXt chunk related fixes, and support for encoding
2127
palettized PNG images. Plus little interface change with palette and texts.
2128
*) 03 mar 2007: Made it encode dynamic Huffman shorter with repeat codes.
2129
Fixed a bug where the end code of a block had length 0 in the Huffman tree.
2130
*) 26 feb 2007: Huffman compression with dynamic trees (BTYPE 2) now implemented
2131
and supported by the encoder, resulting in smaller PNGs at the output.
2132
*) 27 jan 2007: Made the Adler-32 test faster so that a timewaste is gone.
2133
*) 24 jan 2007: gave encoder an error interface. Added color conversion from any
2134
greyscale type to 8-bit greyscale with or without alpha.
2135
*) 21 jan 2007: (!) Totally changed the interface. It allows more color types
2136
to convert to and is more uniform. See the manual for how it works now.
2137
*) 07 jan 2007: Some cleanup & fixes, and a few changes over the last days:
2138
encode/decode custom tEXt chunks, separate classes for zlib & deflate, and
2139
at last made the decoder give errors for incorrect Adler32 or Crc.
2140
*) 01 jan 2007: Fixed bug with encoding PNGs with less than 8 bits per channel.
2141
*) 29 dec 2006: Added support for encoding images without alpha channel, and
2142
cleaned out code as well as making certain parts faster.
2143
*) 28 dec 2006: Added "Settings" to the encoder.
2144
*) 26 dec 2006: The encoder now does LZ77 encoding and produces much smaller files now.
2145
Removed some code duplication in the decoder. Fixed little bug in an example.
2146
*) 09 dec 2006: (!) Placed output parameters of public functions as first parameter.
2147
Fixed a bug of the decoder with 16-bit per color.
2148
*) 15 oct 2006: Changed documentation structure
2149
*) 09 oct 2006: Encoder class added. It encodes a valid PNG image from the
2150
given image buffer, however for now it's not compressed.
2151
*) 08 sep 2006: (!) Changed to interface with a Decoder class
2152
*) 30 jul 2006: (!) LodePNG_InfoPng , width and height are now retrieved in different
2153
way. Renamed decodePNG to decodePNGGeneric.
2154
*) 29 jul 2006: (!) Changed the interface: image info is now returned as a
2155
struct of type LodePNG::LodePNG_Info, instead of a vector, which was a bit clumsy.
2156
*) 28 jul 2006: Cleaned the code and added new error checks.
2157
Corrected terminology "deflate" into "inflate".
2158
*) 23 jun 2006: Added SDL example in the documentation in the header, this
2159
example allows easy debugging by displaying the PNG and its transparency.
2160
*) 22 jun 2006: (!) Changed way to obtain error value. Added
2161
loadFile function for convenience. Made decodePNG32 faster.
2162
*) 21 jun 2006: (!) Changed type of info vector to unsigned.
2163
Changed position of palette in info vector. Fixed an important bug that
2164
happened on PNGs with an uncompressed block.
2165
*) 16 jun 2006: Internally changed unsigned into unsigned where
2166
needed, and performed some optimizations.
2167
*) 07 jun 2006: (!) Renamed functions to decodePNG and placed them
2168
in LodePNG namespace. Changed the order of the parameters. Rewrote the
2169
documentation in the header. Renamed files to lodepng.cpp and lodepng.h
2170
*) 22 apr 2006: Optimized and improved some code
2171
*) 07 sep 2005: (!) Changed to std::vector interface
2172
*) 12 aug 2005: Initial release (C++, decoder only)
2173
*/
2174
2175