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-2014 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/>.
35 #include "imgoutput.h"
37 #define MIN(a, b) ((a) < (b) ? (a) : (b))
40 static int verbose = 0;
41 static char *outname = "out";
42 static int usepalette = 1;
45 OPT_PREFIX = UCHAR_MAX+1,
48 static void printusage(void)
50 puts("usage: lbximg [-i|-d] [-v] [-p palette_file] [-O override_file]"
52 puts(" [-F format] [frameno ...]");
55 static void printhelp(void)
58 puts("For now, see the man page for detailed help.");
67 static const struct img_format {
68 img_output_func *output;
73 { img_output_png, "png", 1 },
75 { img_output_pam, "pam", 1 },
76 { img_output_ppm, "ppm", 1 },
77 { img_output_pbm, "pbm", 1 },
80 static int lookup_format(const char *fmt)
82 for (size_t i = 0; i < sizeof formats / sizeof formats[0]; i++) {
83 assert(!formats[i].name[sizeof formats[i].name - 1]);
85 if (!fmt && formats[i].enabled)
88 if (strcmp(formats[i].name, fmt))
91 if (!formats[i].enabled) {
92 tool_err(-1, "%s support disabled at build time", fmt);
99 tool_err(-1, "unknown format %s", fmt);
103 bool img_is_masked(unsigned char *mask, unsigned width, unsigned height)
105 unsigned long npixels = (unsigned long) width * height;
106 unsigned long mask_sz = npixels / CHAR_BIT + (npixels % CHAR_BIT != 0);
108 for (unsigned long i = 0; i < mask_sz; i++) {
110 if (mask[i] != (unsigned char)-1)
113 unsigned char test = (1u << npixels % CHAR_BIT) - 1;
115 if ((mask[i] & test) != test)
123 int parserange(unsigned frames, char *str, unsigned char *bits)
125 unsigned long start, end;
129 start = strtoul(str, &endptr, 0);
130 if (start >= frames) {
131 tool_err(-1, "frame %lu out of range.", start);
136 tool_err(-1, "invalid frame range: %s.", str);
145 end = strtoul(endptr+1, &endptr, 0);
147 tool_err(-1, "frame %lu out of range.", end);
155 tool_err(-1, "invalid frame range: %s.", str);
160 tool_err(-1, "invalid frame range: %s.", str);
164 for (i = start; i <= end; i++) {
165 bits[i / CHAR_BIT] |= 1 << (i % CHAR_BIT);
171 int output(unsigned int frameno, const struct img_format *fmt,
172 unsigned char *pixels, unsigned char *pixel_mask,
173 unsigned int width, unsigned int height,
174 struct lbx_colour palette[static 256])
176 char name[strlen(outname) + sizeof ".65535.png"];
180 assert(fmt->output != NULL);
181 assert(frameno < 65536);
182 snprintf(name, sizeof name, "%s.%03d.%s", outname, frameno, fmt->name);
184 of = fopen(name, "wb");
186 tool_err(0, "failed to open %s", name);
190 rc = fmt->output(of, name, width, height, pixels, pixel_mask, palette);
196 if (fclose(of) == EOF) {
197 tool_err(0, "error writing %s", name);
202 printf("wrote %s\n", name);
207 static int loadoverride(FILE *f, struct lbx_colour palette[static 256])
209 struct lbx_image *img;
212 img = lbx_img_open(f, &lbx_default_fops, NULL);
214 tool_err(-1, "failed to open override image: %s", lbx_errmsg());
218 rc = lbx_img_getpalette(img, palette);
220 tool_err(-1, "error reading override palette: %s", lbx_errmsg());
222 } else if (rc == 0) {
223 tool_err(-1, "override image has no palette.");
231 static int loadpalette(struct lbx_image *img, FILE *palf, FILE *override,
232 struct lbx_colour *palette)
236 /* Default the palette to a wonderful pink. */
237 for (unsigned i = 0; i < 256; i++) {
238 palette[i] = (struct lbx_colour){0x3f, 0x00, 0x3f};
241 /* Read the external palette, if any. */
243 rc = lbx_img_loadpalette(palf, &lbx_default_fops, palette);
245 tool_err(-1, "error reading external palette: %s", lbx_errmsg());
252 /* Read the embedded palette */
253 rc = lbx_img_getpalette(img, palette);
255 tool_err(-1, "error reading embedded palette: %s", lbx_errmsg());
261 /* Read the override palette, if any. */
263 rc = loadoverride(override, palette);
269 /* If we literally have no palette data at all, may as well fail. */
271 tool_err(-1, "no palette available.");
275 /* Return true iff a divides b. */
276 static bool divides(unsigned a, unsigned b)
286 /* Set n bits starting from offset in the bitmap. */
288 set_bits(unsigned char *bitmap, unsigned long offset, unsigned long n)
290 if (offset % CHAR_BIT) {
291 bitmap[offset/CHAR_BIT] |= (n >= CHAR_BIT ? -1u : (1u << n) - 1)
294 n -= MIN(n, CHAR_BIT - offset%CHAR_BIT);
295 offset += CHAR_BIT - offset%CHAR_BIT;
299 memset(&bitmap[offset/CHAR_BIT], -1, n/CHAR_BIT);
301 offset += n - n%CHAR_BIT;
306 bitmap[offset/CHAR_BIT] |= (1u << n) - 1;
310 static int decode_frame(struct lbx_image *img, unsigned n,
311 unsigned char *pixels, unsigned char *pixel_mask)
316 rc = lbx_img_seek(img, n);
318 tool_err(-1, "frame %u: invalid frame: %s\n", n, lbx_errmsg());
322 while ((rc = lbx_img_read_row_header(img, &x, &y)) != 0) {
323 unsigned long offset;
326 tool_err(-1, "frame %u: invalid row: %s", n, lbx_errmsg());
330 offset = (unsigned long) y * img->width + x;
331 rc = lbx_img_read_row_data(img, pixels+offset);
333 tool_err(-1, "frame %u: error reading row: %s\n", n, lbx_errmsg());
337 set_bits(pixel_mask, offset, rc);
344 decode(struct lbx_image *img, FILE *palf, FILE *override, int fmt, char **argv)
346 unsigned char *pixels = NULL, *pixel_mask = NULL, *framebits = NULL;
347 struct lbx_colour palette[256];
348 int rc, ret = EXIT_FAILURE;
351 size_t npixels, mask_sz;
353 assert(fmt >= 0 && fmt < sizeof formats / sizeof formats[0]);
355 npixels = img->width;
356 if (img->height && npixels >= SIZE_MAX / img->height) {
357 tool_err(-1, "image too large");
360 npixels *= img->height;
362 /* Ensure there is at least 1 byte to allocate */
366 framebits = calloc(1, img->frames / CHAR_BIT + 1);
368 tool_err(0, "failed to allocate memory");
372 pixels = calloc(img->width, img->height);
374 tool_err(0, "failed to allocate memory");
378 mask_sz = npixels / CHAR_BIT + (npixels % CHAR_BIT != 0);
379 pixel_mask = malloc(mask_sz);
381 tool_err(0, "failed to allocate memory");
385 /* Figure out what images we're extracting. */
387 /* extract all images by default. */
388 memset(framebits, -1, img->frames / CHAR_BIT + 1);
390 for (i = 0; argv[i]; i++) {
391 parserange(img->frames, argv[i], framebits);
396 if (loadpalette(img, palf, override, palette) == -1) {
402 /* Extract the images, in order. */
404 for (i = 0; i < img->frames; i++) {
405 if (divides(img->chunk, i))
406 memset(pixel_mask, 0, mask_sz);
408 rc = decode_frame(img, i, pixels, pixel_mask);
414 if (framebits[i / CHAR_BIT] & (1u << (i % CHAR_BIT))) {
415 rc = output(i, &formats[fmt], pixels, pixel_mask,
416 img->width, img->height,
417 usepalette ? palette : NULL);
426 tool_err(-1, "no frames extracted.");
436 int main(int argc, char **argv)
438 int mode = MODE_NONE, fmt, opt, rc = EXIT_FAILURE;
439 struct lbx_pipe_state stdin_handle = { .f = stdin };
440 const char *file = NULL, *fmtstring = NULL;
441 const char *ext_palette = NULL, *ovr_palette = NULL;
442 FILE *palf = NULL, *overf = NULL;
443 struct lbx_image *img;
445 static const char sopts[] = "idnvF:f:p:O:VH";
446 static const struct option lopts[] = {
447 { "identify", 0, NULL, 'i' },
448 { "decode", 0, NULL, 'd' },
449 { "verbose", 0, NULL, 'v' },
450 { "file", 1, NULL, 'f' },
451 { "format", 1, NULL, 'F' },
452 { "palette", 1, NULL, 'p' },
453 { "override", 1, NULL, 'O' },
454 { "no-palette", 0, NULL, 'n' },
456 { "output-prefix", 1, NULL, OPT_PREFIX },
458 { "version", 0, NULL, 'V' },
459 { "usage", 0, NULL, 'U' },
460 { "help", 0, NULL, 'H' },
465 tool_init("lbximg", argc, argv);
466 while ((opt = getopt_long(argc, argv, sopts, lopts, NULL)) != -1) {
487 ext_palette = optarg;
491 ovr_palette = optarg;
510 if (mode == MODE_NONE) {
511 tool_err(-1, "you must specify a mode.");
515 fmt = lookup_format(fmtstring);
520 img = lbx_img_fopen(file);
522 img = lbx_img_open(&stdin_handle, &lbx_pipe_fops, NULL);
525 tool_err(-1, "failed to open image: %s.", lbx_errmsg());
529 if (ext_palette && !(palf = fopen(ext_palette, "rb"))) {
530 tool_err(0, "failed to open %s", optarg);
534 if (ovr_palette && !(overf = fopen(ovr_palette, "rb"))) {
535 tool_err(0, "failed to open %s", optarg);
539 if (verbose || mode == MODE_IDENT) {
545 palette_count = lbx_img_getpalette(img, NULL);
546 if (palette_count < 0) {
547 tool_err(-1, "error reading image: %s", lbx_errmsg());
551 printf("%s is %hux%hu LBX image, %hhu frame(s)%s%s%s\n",
552 file, img->width, img->height, img->frames,
553 palette_count ? ", embedded palette" : "",
554 img->chunk ? ", chunked" : "",
555 img->leadin+1 < img->frames ? ", loops" : "");
563 rc = decode(img, palf, overf, fmt, &argv[optind]);