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