Mercurial > hg > dmlib
annotate tools/libgfx.h @ 2065:451980580189
Refactor how paletted/indexed formats are handled in libgfx.
| author | Matti Hamalainen <ccr@tnsp.org> |
|---|---|
| date | Wed, 05 Dec 2018 13:33:03 +0200 |
| parents | 3617ef01c1de |
| children | 63284e9ad95e |
| rev | line source |
|---|---|
| 435 | 1 /* |
| 2 * Functions for loading and saving bitmap images | |
| 3 * Programmed and designed by Matti 'ccr' Hamalainen | |
| 4 * (C) Copyright 2012 Tecnic Software productions (TNSP) | |
| 5 * | |
| 6 * Please read file 'COPYING' for information on license and distribution. | |
| 7 */ | |
| 8 #ifndef LIBMGFX_H | |
| 9 #define LIBMGFX_H 1 | |
| 10 | |
| 11 #include "dmlib.h" | |
|
1609
c29adf5ce240
Convert libgfx file format routines to use DMResource instead of stdio FILE.
Matti Hamalainen <ccr@tnsp.org>
parents:
1545
diff
changeset
|
12 #include "dmres.h" |
|
947
5ac8f5513978
Delete useless include line.
Matti Hamalainen <ccr@tnsp.org>
parents:
929
diff
changeset
|
13 |
| 435 | 14 |
| 15 #ifdef __cplusplus | |
| 16 extern "C" { | |
| 17 #endif | |
| 18 | |
| 19 | |
| 20 enum | |
| 21 { | |
|
1543
416d7b3ba3b2
Rename libgfx IMGFMT_* constants to DM_IMGFMT_*.
Matti Hamalainen <ccr@tnsp.org>
parents:
1341
diff
changeset
|
22 DM_IMGFMT_PNG, |
|
416d7b3ba3b2
Rename libgfx IMGFMT_* constants to DM_IMGFMT_*.
Matti Hamalainen <ccr@tnsp.org>
parents:
1341
diff
changeset
|
23 DM_IMGFMT_PPM, |
|
416d7b3ba3b2
Rename libgfx IMGFMT_* constants to DM_IMGFMT_*.
Matti Hamalainen <ccr@tnsp.org>
parents:
1341
diff
changeset
|
24 DM_IMGFMT_PCX, |
|
2064
3617ef01c1de
Separate ILBM and PBM subformats of IFF images.
Matti Hamalainen <ccr@tnsp.org>
parents:
2047
diff
changeset
|
25 DM_IMGFMT_IFF_ILBM, |
|
3617ef01c1de
Separate ILBM and PBM subformats of IFF images.
Matti Hamalainen <ccr@tnsp.org>
parents:
2047
diff
changeset
|
26 DM_IMGFMT_IFF_PBM, |
|
1543
416d7b3ba3b2
Rename libgfx IMGFMT_* constants to DM_IMGFMT_*.
Matti Hamalainen <ccr@tnsp.org>
parents:
1341
diff
changeset
|
27 DM_IMGFMT_RAW, |
|
416d7b3ba3b2
Rename libgfx IMGFMT_* constants to DM_IMGFMT_*.
Matti Hamalainen <ccr@tnsp.org>
parents:
1341
diff
changeset
|
28 DM_IMGFMT_ARAW, |
|
2047
3829c292df02
Add 'cdump' image output format, mainly for debugging purposes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1921
diff
changeset
|
29 DM_IMGFMT_CDUMP, |
| 435 | 30 }; |
| 31 | |
| 32 | |
| 33 enum | |
| 34 { | |
| 1801 | 35 DM_COLFMT_PALETTE, |
| 36 DM_COLFMT_RGB, | |
| 37 DM_COLFMT_RGBA, | |
| 435 | 38 }; |
| 39 | |
| 40 | |
| 1544 | 41 // Error handling modes |
|
1285
e4bda4909d72
Make libgfx error mode a global variable, at least for now.
Matti Hamalainen <ccr@tnsp.org>
parents:
971
diff
changeset
|
42 enum |
|
e4bda4909d72
Make libgfx error mode a global variable, at least for now.
Matti Hamalainen <ccr@tnsp.org>
parents:
971
diff
changeset
|
43 { |
| 1544 | 44 DM_ERRMODE_FAIL = 0, |
|
1285
e4bda4909d72
Make libgfx error mode a global variable, at least for now.
Matti Hamalainen <ccr@tnsp.org>
parents:
971
diff
changeset
|
45 DM_ERRMODE_RECOV_1, |
|
e4bda4909d72
Make libgfx error mode a global variable, at least for now.
Matti Hamalainen <ccr@tnsp.org>
parents:
971
diff
changeset
|
46 DM_ERRMODE_RECOV_2, |
|
e4bda4909d72
Make libgfx error mode a global variable, at least for now.
Matti Hamalainen <ccr@tnsp.org>
parents:
971
diff
changeset
|
47 }; |
|
e4bda4909d72
Make libgfx error mode a global variable, at least for now.
Matti Hamalainen <ccr@tnsp.org>
parents:
971
diff
changeset
|
48 |
|
e4bda4909d72
Make libgfx error mode a global variable, at least for now.
Matti Hamalainen <ccr@tnsp.org>
parents:
971
diff
changeset
|
49 |
| 1544 | 50 // Probe scores |
| 51 enum | |
| 52 { | |
| 53 DM_PROBE_SCORE_FALSE = 0, | |
| 54 DM_PROBE_SCORE_MAYBE = 250, | |
| 55 DM_PROBE_SCORE_AVG = 500, | |
| 56 DM_PROBE_SCORE_GOOD = 750, | |
| 57 DM_PROBE_SCORE_MAX = 1000, | |
| 58 }; | |
| 59 | |
| 60 | |
|
1545
3b613fcbf3ff
Improve how format read/write capabilities are marked and shown.
Matti Hamalainen <ccr@tnsp.org>
parents:
1544
diff
changeset
|
61 // Flags for readability/writeability of formats |
|
3b613fcbf3ff
Improve how format read/write capabilities are marked and shown.
Matti Hamalainen <ccr@tnsp.org>
parents:
1544
diff
changeset
|
62 enum |
|
3b613fcbf3ff
Improve how format read/write capabilities are marked and shown.
Matti Hamalainen <ccr@tnsp.org>
parents:
1544
diff
changeset
|
63 { |
|
1759
027fb7313d85
Add a format flag for marking formats that have broken/incomplete support and use it.
Matti Hamalainen <ccr@tnsp.org>
parents:
1733
diff
changeset
|
64 DM_FMT_WR = 0x0001, // Format can be written |
|
027fb7313d85
Add a format flag for marking formats that have broken/incomplete support and use it.
Matti Hamalainen <ccr@tnsp.org>
parents:
1733
diff
changeset
|
65 DM_FMT_RD = 0x0002, // Format can be read |
|
027fb7313d85
Add a format flag for marking formats that have broken/incomplete support and use it.
Matti Hamalainen <ccr@tnsp.org>
parents:
1733
diff
changeset
|
66 DM_FMT_RDWR = (DM_FMT_RD | DM_FMT_WR), // Read and write support |
|
027fb7313d85
Add a format flag for marking formats that have broken/incomplete support and use it.
Matti Hamalainen <ccr@tnsp.org>
parents:
1733
diff
changeset
|
67 DM_FMT_BROKEN = 0x1000, // Support is broken/incomplete |
|
1545
3b613fcbf3ff
Improve how format read/write capabilities are marked and shown.
Matti Hamalainen <ccr@tnsp.org>
parents:
1544
diff
changeset
|
68 }; |
|
3b613fcbf3ff
Improve how format read/write capabilities are marked and shown.
Matti Hamalainen <ccr@tnsp.org>
parents:
1544
diff
changeset
|
69 |
|
3b613fcbf3ff
Improve how format read/write capabilities are marked and shown.
Matti Hamalainen <ccr@tnsp.org>
parents:
1544
diff
changeset
|
70 |
|
1609
c29adf5ce240
Convert libgfx file format routines to use DMResource instead of stdio FILE.
Matti Hamalainen <ccr@tnsp.org>
parents:
1545
diff
changeset
|
71 // Bitmapped image struct |
| 435 | 72 typedef struct |
| 73 { | |
| 1801 | 74 int format; // one of types specified by DM_COLFMT_* |
| 1286 | 75 int width, height; |
| 76 int pitch; // bytes per scanline | |
| 77 int bpp; // bits per pixel | |
| 78 | |
|
1628
a549d33d543a
Add image aspect ratio information.
Matti Hamalainen <ccr@tnsp.org>
parents:
1616
diff
changeset
|
79 float aspect; // aspect ratio (vert / horiz), <= 0 if not set |
|
a549d33d543a
Add image aspect ratio information.
Matti Hamalainen <ccr@tnsp.org>
parents:
1616
diff
changeset
|
80 |
| 1286 | 81 int ncolors; // number of colors in palette, if any |
| 82 int ctransp; // transparency color index | |
| 83 BOOL constpal; // is the palette a const? | |
| 84 DMColor *pal; // pointer to palette struct, NULL if no palette | |
| 85 | |
|
929
e1378398be0f
Add size field for allocated data size in DMImage.
Matti Hamalainen <ccr@tnsp.org>
parents:
902
diff
changeset
|
86 size_t size; |
| 435 | 87 Uint8 *data; |
| 88 } DMImage; | |
| 89 | |
| 90 | |
| 91 typedef struct | |
| 92 { | |
|
2065
451980580189
Refactor how paletted/indexed formats are handled in libgfx.
Matti Hamalainen <ccr@tnsp.org>
parents:
2064
diff
changeset
|
93 int fmtid; // DM_IMGFMT_* of target format (a bit of a kludge here) |
|
451980580189
Refactor how paletted/indexed formats are handled in libgfx.
Matti Hamalainen <ccr@tnsp.org>
parents:
2064
diff
changeset
|
94 int format; // Target color format DM_COLFMT_* |
|
451980580189
Refactor how paletted/indexed formats are handled in libgfx.
Matti Hamalainen <ccr@tnsp.org>
parents:
2064
diff
changeset
|
95 int scaleX, scaleY; // Scale factors (1..) |
|
451980580189
Refactor how paletted/indexed formats are handled in libgfx.
Matti Hamalainen <ccr@tnsp.org>
parents:
2064
diff
changeset
|
96 int nplanes, bpp, mask; |
|
451980580189
Refactor how paletted/indexed formats are handled in libgfx.
Matti Hamalainen <ccr@tnsp.org>
parents:
2064
diff
changeset
|
97 BOOL planar; |
|
451980580189
Refactor how paletted/indexed formats are handled in libgfx.
Matti Hamalainen <ccr@tnsp.org>
parents:
2064
diff
changeset
|
98 int compression; // Use compression/compression level (0 = none, 9 = max) |
|
1290
e7dc9bb9777e
Rename struct DMImageSpec to DMImageConvSpec.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
99 } DMImageConvSpec; |
| 435 | 100 |
| 101 | |
| 102 typedef struct | |
| 103 { | |
| 104 char *fext; | |
|
1616
36d073c45327
Refactor the format handling a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
1609
diff
changeset
|
105 char *name; |
|
36d073c45327
Refactor the format handling a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
1609
diff
changeset
|
106 int fmtid; // DM_IMGFMT_* |
|
36d073c45327
Refactor the format handling a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
1609
diff
changeset
|
107 int flags; // DM_FMT_* flags |
| 435 | 108 int (*probe)(const Uint8 *buf, const size_t len); |
|
1886
1af79412f249
Remove the stdio FILE support from libgfx API, now only DMResource is supported.
Matti Hamalainen <ccr@tnsp.org>
parents:
1809
diff
changeset
|
109 int (*read)(DMResource *fp, DMImage **pimg); |
|
1af79412f249
Remove the stdio FILE support from libgfx API, now only DMResource is supported.
Matti Hamalainen <ccr@tnsp.org>
parents:
1809
diff
changeset
|
110 int (*write)(DMResource *fp, const DMImage *pimg, const DMImageConvSpec *spec); |
| 435 | 111 } DMImageFormat; |
| 112 | |
| 113 | |
|
1616
36d073c45327
Refactor the format handling a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
1609
diff
changeset
|
114 extern const DMImageFormat dmImageFormatList[]; |
|
36d073c45327
Refactor the format handling a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
1609
diff
changeset
|
115 extern const int ndmImageFormatList; |
|
1285
e4bda4909d72
Make libgfx error mode a global variable, at least for now.
Matti Hamalainen <ccr@tnsp.org>
parents:
971
diff
changeset
|
116 extern int dmGFXErrorMode; |
| 435 | 117 |
| 118 | |
| 1286 | 119 DMImage * dmImageAlloc(const int width, const int height, const int format, const int bpp); |
| 435 | 120 void dmImageFree(DMImage *img); |
| 1286 | 121 int dmImageGetBytesPerPixel(const int format); |
|
1616
36d073c45327
Refactor the format handling a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
1609
diff
changeset
|
122 int dmImageProbeGeneric(const Uint8 *buf, const size_t len, const DMImageFormat **fmt, int *index); |
| 435 | 123 |
|
487
b89598501cec
Move dmCompareColor() to libgfx.
Matti Hamalainen <ccr@tnsp.org>
parents:
462
diff
changeset
|
124 BOOL dmCompareColor(const DMColor *c1, const DMColor *c2, BOOL alpha); |
|
1733
59c2b08a80a6
Make some palette allocation functions public.
Matti Hamalainen <ccr@tnsp.org>
parents:
1628
diff
changeset
|
125 BOOL dmPaletteAlloc(DMColor **ppal, int ncolors, int ctransp); |
|
59c2b08a80a6
Make some palette allocation functions public.
Matti Hamalainen <ccr@tnsp.org>
parents:
1628
diff
changeset
|
126 BOOL dmImagePaletteAlloc(DMImage *img, int ncolors, int ctransp); |
|
487
b89598501cec
Move dmCompareColor() to libgfx.
Matti Hamalainen <ccr@tnsp.org>
parents:
462
diff
changeset
|
127 |
| 435 | 128 |
|
1886
1af79412f249
Remove the stdio FILE support from libgfx API, now only DMResource is supported.
Matti Hamalainen <ccr@tnsp.org>
parents:
1809
diff
changeset
|
129 int dmWriteImageData(const DMImage *img, void *cbdata, |
|
1af79412f249
Remove the stdio FILE support from libgfx API, now only DMResource is supported.
Matti Hamalainen <ccr@tnsp.org>
parents:
1809
diff
changeset
|
130 int (*writeRowCB)(void *, const Uint8 *, const size_t), const DMImageConvSpec *spec); |
|
1af79412f249
Remove the stdio FILE support from libgfx API, now only DMResource is supported.
Matti Hamalainen <ccr@tnsp.org>
parents:
1809
diff
changeset
|
131 |
| 435 | 132 |
|
2065
451980580189
Refactor how paletted/indexed formats are handled in libgfx.
Matti Hamalainen <ccr@tnsp.org>
parents:
2064
diff
changeset
|
133 int dmWriteIFFMasterRAWHeader(DMResource *fp, const char *filename, const char *prefix, const DMImage *img, const DMImageConvSpec *spec); |
|
1886
1af79412f249
Remove the stdio FILE support from libgfx API, now only DMResource is supported.
Matti Hamalainen <ccr@tnsp.org>
parents:
1809
diff
changeset
|
134 int dmWriteRAWImage(DMResource *fp, const DMImage *img, const DMImageConvSpec *spec); |
| 435 | 135 |
|
1886
1af79412f249
Remove the stdio FILE support from libgfx API, now only DMResource is supported.
Matti Hamalainen <ccr@tnsp.org>
parents:
1809
diff
changeset
|
136 int dmWritePPMImage(DMResource *fp, const DMImage *img, const DMImageConvSpec *spec); |
| 435 | 137 |
| 138 #ifdef DM_USE_LIBPNG | |
|
1886
1af79412f249
Remove the stdio FILE support from libgfx API, now only DMResource is supported.
Matti Hamalainen <ccr@tnsp.org>
parents:
1809
diff
changeset
|
139 int dmWritePNGImage(DMResource *fp, const DMImage *img, const DMImageConvSpec *spec); |
|
1af79412f249
Remove the stdio FILE support from libgfx API, now only DMResource is supported.
Matti Hamalainen <ccr@tnsp.org>
parents:
1809
diff
changeset
|
140 int dmReadPNGImage(DMResource *fp, DMImage **pimg); |
| 435 | 141 #endif |
| 142 | |
|
1886
1af79412f249
Remove the stdio FILE support from libgfx API, now only DMResource is supported.
Matti Hamalainen <ccr@tnsp.org>
parents:
1809
diff
changeset
|
143 int dmWritePCXImage(DMResource *fp, const DMImage *img, const DMImageConvSpec *spec); |
|
1af79412f249
Remove the stdio FILE support from libgfx API, now only DMResource is supported.
Matti Hamalainen <ccr@tnsp.org>
parents:
1809
diff
changeset
|
144 int dmReadPCXImage(DMResource *fp, DMImage **pimg); |
| 435 | 145 |
|
1892
cbc911ffd21e
Rename ILBM functions to IFF, which is more approriate as we support both ILBM and PBM variants of the IFF images.
Matti Hamalainen <ccr@tnsp.org>
parents:
1886
diff
changeset
|
146 int dmReadIFFImage(DMResource *fp, DMImage **pimg); |
|
1896
f80b2dc77c30
Work begins on IFF ILBM/PBM image writer. It is pretty broken, some things
Matti Hamalainen <ccr@tnsp.org>
parents:
1892
diff
changeset
|
147 int dmWriteIFFImage(DMResource *fp, const DMImage *img, const DMImageConvSpec *spec); |
|
1809
a20655e40e6c
Move ILBM function declarations to position that better reflects their
Matti Hamalainen <ccr@tnsp.org>
parents:
1801
diff
changeset
|
148 |
| 435 | 149 |
|
1309
5ad7d780a09b
Move bitstream reading functions to libgfx, as they were only used there.
Matti Hamalainen <ccr@tnsp.org>
parents:
1307
diff
changeset
|
150 typedef struct _DMBitStreamContext |
|
5ad7d780a09b
Move bitstream reading functions to libgfx, as they were only used there.
Matti Hamalainen <ccr@tnsp.org>
parents:
1307
diff
changeset
|
151 { |
|
5ad7d780a09b
Move bitstream reading functions to libgfx, as they were only used there.
Matti Hamalainen <ccr@tnsp.org>
parents:
1307
diff
changeset
|
152 void *handle; |
|
5ad7d780a09b
Move bitstream reading functions to libgfx, as they were only used there.
Matti Hamalainen <ccr@tnsp.org>
parents:
1307
diff
changeset
|
153 |
|
5ad7d780a09b
Move bitstream reading functions to libgfx, as they were only used there.
Matti Hamalainen <ccr@tnsp.org>
parents:
1307
diff
changeset
|
154 BOOL (*putByte)(struct _DMBitStreamContext *ctx, Uint8 val); |
|
5ad7d780a09b
Move bitstream reading functions to libgfx, as they were only used there.
Matti Hamalainen <ccr@tnsp.org>
parents:
1307
diff
changeset
|
155 |
|
5ad7d780a09b
Move bitstream reading functions to libgfx, as they were only used there.
Matti Hamalainen <ccr@tnsp.org>
parents:
1307
diff
changeset
|
156 int outBuf, outBitCount, outByteCount; |
|
5ad7d780a09b
Move bitstream reading functions to libgfx, as they were only used there.
Matti Hamalainen <ccr@tnsp.org>
parents:
1307
diff
changeset
|
157 } DMBitStreamContext; |
|
5ad7d780a09b
Move bitstream reading functions to libgfx, as they were only used there.
Matti Hamalainen <ccr@tnsp.org>
parents:
1307
diff
changeset
|
158 |
|
5ad7d780a09b
Move bitstream reading functions to libgfx, as they were only used there.
Matti Hamalainen <ccr@tnsp.org>
parents:
1307
diff
changeset
|
159 |
|
5ad7d780a09b
Move bitstream reading functions to libgfx, as they were only used there.
Matti Hamalainen <ccr@tnsp.org>
parents:
1307
diff
changeset
|
160 void dmInitBitStreamContext(DMBitStreamContext *ctx); |
|
5ad7d780a09b
Move bitstream reading functions to libgfx, as they were only used there.
Matti Hamalainen <ccr@tnsp.org>
parents:
1307
diff
changeset
|
161 int dmFlushBitStream(DMBitStreamContext *ctx); |
|
5ad7d780a09b
Move bitstream reading functions to libgfx, as they were only used there.
Matti Hamalainen <ccr@tnsp.org>
parents:
1307
diff
changeset
|
162 BOOL dmPutBits(DMBitStreamContext *ctx, const int val, const int n); |
|
1609
c29adf5ce240
Convert libgfx file format routines to use DMResource instead of stdio FILE.
Matti Hamalainen <ccr@tnsp.org>
parents:
1545
diff
changeset
|
163 int dmInitBitStreamFILE(DMBitStreamContext *ctx, DMResource *fp); |
|
1309
5ad7d780a09b
Move bitstream reading functions to libgfx, as they were only used there.
Matti Hamalainen <ccr@tnsp.org>
parents:
1307
diff
changeset
|
164 |
|
5ad7d780a09b
Move bitstream reading functions to libgfx, as they were only used there.
Matti Hamalainen <ccr@tnsp.org>
parents:
1307
diff
changeset
|
165 |
| 435 | 166 #ifdef __cplusplus |
| 167 } | |
| 168 #endif | |
| 169 | |
| 170 #endif // LIBMGFX_H |