2 * 2ooM: The Master of Orion II Reverse Engineering Project
3 * Simple command-line tool to convert an LBX image to other formats.
4 * Copyright © 2006-2011, 2013 Nick Bowler
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 #include "imgoutput.h"
37 static int verbose = 0;
38 static char *outname = "out";
39 static int usepalette = 1;
42 OPT_PREFIX = UCHAR_MAX+1,
45 static void printusage(void)
47 puts("usage: lbximg [-i|-d] [-v] [-p palette_file] [-O override_file]"
49 puts(" [-F format] [frameno ...]");
52 static void printhelp(void)
55 puts("For now, see the man page for detailed help.");
64 static const struct img_format {
65 img_output_func *output;
70 { img_output_png, "png", 1 },
72 { img_output_pam, "pam", 1 },
73 { img_output_ppm, "ppm", 1 },
74 { img_output_pbm, "pbm", 1 },
77 static int lookup_format(const char *fmt)
79 for (size_t i = 0; i < sizeof formats / sizeof formats[0]; i++) {
80 assert(!formats[i].name[sizeof formats[i].name - 1]);
82 if (!fmt && formats[i].enabled)
85 if (strcmp(formats[i].name, fmt))
88 if (!formats[i].enabled) {
89 tool_err(-1, "%s support disabled at build time", fmt);
96 tool_err(-1, "unknown format %s", fmt);
100 bool img_is_masked(unsigned char **mask, unsigned width, unsigned height)
104 for (x = y = 0; y < height; ++x < width || (x = 0, y++)) {
112 int parserange(unsigned frames, char *str, unsigned char *bits)
114 unsigned long start, end;
118 start = strtoul(str, &endptr, 0);
119 if (start >= frames) {
120 tool_err(-1, "frame %lu out of range.", start);
125 tool_err(-1, "invalid frame range: %s.", str);
134 end = strtoul(endptr+1, &endptr, 0);
136 tool_err(-1, "frame %lu out of range.", end);
144 tool_err(-1, "invalid frame range: %s.", str);
149 tool_err(-1, "invalid frame range: %s.", str);
153 for (i = start; i <= end; i++) {
154 bits[i / CHAR_BIT] |= 1 << (i % CHAR_BIT);
160 int output(unsigned int frameno, const struct img_format *fmt,
161 unsigned char **framedata, unsigned char **mask,
162 unsigned int width, unsigned int height,
163 struct lbx_colour palette[static 256])
165 char name[strlen(outname) + sizeof ".65535.png"];
169 assert(fmt->output != NULL);
170 assert(frameno < 65536);
171 snprintf(name, sizeof name, "%s.%03d.%s", outname, frameno, fmt->name);
173 of = fopen(name, "wb");
175 tool_err(0, "failed to open %s", name);
179 rc = fmt->output(of, name, width, height, framedata, mask, palette);
185 if (fclose(of) == EOF) {
186 tool_err(0, "error writing %s", name);
191 printf("wrote %s\n", name);
196 static int loadoverride(FILE *f, struct lbx_colour palette[static 256])
198 struct lbx_image *overimg = lbx_img_open(f, &lbx_default_fops, NULL);
199 struct lbx_imginfo info;
202 tool_err(-1, "failed to open override image: %s", lbx_errmsg());
205 lbx_img_getinfo(overimg, &info);
207 if (!info.palettesz) {
208 tool_err(-1, "override image has no palette.");
209 lbx_img_close(overimg);
213 if (lbx_img_getpalette(overimg, palette) == -1) {
214 tool_err(-1, "error reading override palette: %s", lbx_errmsg());
215 lbx_img_close(overimg);
219 lbx_img_close(overimg);
223 static int loadpalette(struct lbx_image *img, struct lbx_imginfo *info,
224 FILE *palf, FILE *override,
225 struct lbx_colour palette[static 256])
230 if (!palf && !info->palettesz && !override) {
231 tool_err(-1, "no palette available.");
235 /* Default the palette to a wonderful pink. */
236 for (i = 0; i < 256; i++) {
237 palette[i] = (struct lbx_colour){0x3f, 0x00, 0x3f};
240 /* Read the external palette, if any. */
241 if (palf && lbx_img_loadpalette(palf, &lbx_default_fops, palette) != 0) {
242 tool_err(-1, "error reading external palette: %s", lbx_errmsg());
246 /* Read the embedded palette, if any. */
247 if (info->palettesz && lbx_img_getpalette(img, palette) == -1) {
248 tool_err(-1, "error reading embedded palette: %s", lbx_errmsg());
252 /* Read the override palette, if any. */
253 if (override && loadoverride(override, palette) == -1) {
261 decode(struct lbx_image *img, FILE *palf, FILE *override, int fmt, char **argv)
263 unsigned char *framebits;
264 struct lbx_colour palette[256];
265 struct lbx_imginfo info;
269 assert(fmt >= 0 && fmt < sizeof formats / sizeof formats[0]);
271 lbx_img_getinfo(img, &info);
273 framebits = calloc(1, img->frames / CHAR_BIT + 1);
278 /* Figure out what images we're extracting. */
280 /* extract all images by default. */
281 memset(framebits, -1, img->frames / CHAR_BIT + 1);
283 for (i = 0; argv[i]; i++) {
284 parserange(img->frames, argv[i], framebits);
289 if (loadpalette(img, &info, palf, override, palette) == -1) {
294 /* Extract the images, in order. */
295 for (i = 0; i < img->frames; i++) {
296 unsigned char **data;
297 unsigned char **mask;
299 if (!(framebits[i / CHAR_BIT] & (1 << (i % CHAR_BIT))))
302 data = lbx_img_getframe(img, i);
304 tool_err(-1, "error in frame %u: %s", i, lbx_errmsg());
308 mask = lbx_img_getmask(img);
310 if (!output(i, &formats[fmt], data, mask,
311 img->width, img->height,
312 usepalette ? palette : NULL)) {
318 tool_err(-1, "no frames extracted.");
329 int main(int argc, char **argv)
331 int mode = MODE_NONE, fmt, opt, rc = EXIT_FAILURE;
332 struct lbx_pipe_state stdin_handle = { .f = stdin };
333 const char *file = NULL, *fmtstring = NULL;
334 FILE *palf = NULL, *overf = NULL;
335 struct lbx_image *img;
337 static const char sopts[] = "idnvF:f:p:O:VH";
338 static const struct option lopts[] = {
339 { "identify", 0, NULL, 'i' },
340 { "decode", 0, NULL, 'd' },
341 { "verbose", 0, NULL, 'v' },
342 { "file", 1, NULL, 'f' },
343 { "format", 1, NULL, 'F' },
344 { "palette", 1, NULL, 'p' },
345 { "override", 1, NULL, 'O' },
346 { "no-palette", 0, NULL, 'n' },
348 { "output-prefix", 1, NULL, OPT_PREFIX },
350 { "version", 0, NULL, 'V' },
351 { "usage", 0, NULL, 'U' },
352 { "help", 0, NULL, 'H' },
357 tool_init("lbximg", argc, argv);
358 while ((opt = getopt_long(argc, argv, sopts, lopts, NULL)) != -1) {
379 palf = fopen(optarg, "rb");
381 tool_err(0, "failed to open %s", optarg);
387 overf = fopen(optarg, "rb");
389 tool_err(0, "failed to open %s", optarg);
410 if (mode == MODE_NONE) {
411 tool_err(-1, "you must specify a mode.");
415 fmt = lookup_format(fmtstring);
420 img = lbx_img_fopen(file);
422 img = lbx_img_open(&stdin_handle, &lbx_pipe_fops, NULL);
425 tool_err(-1, "failed to open image: %s.", lbx_errmsg());
429 if (verbose || mode == MODE_IDENT) {
430 struct lbx_imginfo info;
435 lbx_img_getinfo(img, &info);
436 printf("%s is %hux%hu LBX image, %hhu frame(s)%s%s%s\n",
437 file, img->width, img->height, img->frames,
438 info.palettesz ? ", embedded palette" : "",
439 img->chunk ? ", chunked" : "",
440 info.looping ? ", loops" : "");
448 rc = decode(img, palf, overf, fmt, &argv[optind]);