13 tga.c - implements reading and writing targa files, uses io layer.
17 io_glue *ig = io_new_fd( fd );
18 i_img *im = i_readtga_wiol(ig, -1); // no limit on how much is read
20 io_glue *ig = io_new_fd( fd );
21 return_code = i_writetga_wiol(im, ig);
25 tga.c implements the basic functions to read and write portable targa
26 files. It uses the iolayer and needs either a seekable source or an
27 entire memory mapped buffer.
29 =head1 FUNCTION REFERENCE
31 Some of these functions are internal.
45 short int colourmaporigin;
46 short int colourmaplength;
57 typedef enum { NoInit, Raw, Rle } rle_state;
63 unsigned char cval[4];
79 =item bpp_to_bytes(bpp)
81 Convert bits per pixel into bytes per pixel
91 bpp_to_bytes(unsigned int bpp) {
109 =item bpp_to_channels(bpp)
111 Convert bits per pixel into channels in the image
120 bpp_to_channels(unsigned int bpp) {
139 * Packing functions - used for (un)packing
140 * datastructures into raw bytes.
145 =item color_unpack(buf, bytepp, val)
147 Unpacks bytes into colour structures, for 2 byte type the first byte
148 coming from the file will actually be GGGBBBBB, and the second will be
149 ARRRRRGG. "A" represents an attribute bit. The 3 byte entry contains
150 1 byte each of blue, green, and red. The 4 byte entry contains 1 byte
151 each of blue, green, red, and attribute.
153 buf - pointer to data
154 bytepp - bytes per pixel
155 val - pointer to color to store to
162 color_unpack(unsigned char *buf, int bytepp, i_color *val) {
165 val->gray.gray_color = buf[0];
168 val->rgba.r = (buf[1] & 0x7c) << 1;
169 val->rgba.g = ((buf[1] & 0x03) << 6) | ((buf[0] & 0xe0) >> 2);
170 val->rgba.b = (buf[0] & 0x1f) << 3;
171 val->rgba.a = (buf[1] & 0x80) ? 255 : 0;
172 val->rgba.r |= val->rgba.r >> 5;
173 val->rgba.g |= val->rgba.g >> 5;
174 val->rgba.b |= val->rgba.b >> 5;
182 val->rgba.b = buf[0];
183 val->rgba.g = buf[1];
184 val->rgba.r = buf[2];
185 val->rgba.a = buf[3];
196 Packs a colour into an array of bytes, for 2 byte type the first byte
197 will be GGGBBBBB, and the second will be ARRRRRGG. "A" represents an
198 attribute bit. The 3 byte entry contains 1 byte each of blue, green,
199 and red. The 4 byte entry contains 1 byte each of blue, green, red,
202 buf - destination buffer
203 bitspp - bits per pixel
211 color_pack(unsigned char *buf, int bitspp, i_color *val) {
214 buf[0] = val->gray.gray_color;
217 buf[0] = (val->rgba.b >> 3);
218 buf[0] |= (val->rgba.g & 0x38) << 2;
219 buf[1] = (val->rgba.r & 0xf8)>> 1;
220 buf[1] |= (val->rgba.g >> 6);
222 buf[1] |= val->rgba.a & 0x80;
230 buf[0] = val->rgba.b;
231 buf[1] = val->rgba.g;
232 buf[2] = val->rgba.r;
233 buf[3] = val->rgba.a;
243 Helper function for rle compressor to find the next triple repeat of the
244 same pixel value in buffer.
247 length - number of pixel values in buffer
248 bytepp - number of bytes in a pixel value
255 find_repeat(unsigned char *buf, int length, int bytepp) {
259 if(memcmp(buf+i*bytepp, buf+(i+1)*bytepp, bytepp) == 0) {
260 if (i == length-2) return -1;
261 if (memcmp(buf+(i+1)*bytepp, buf+(i+2)*bytepp,bytepp) == 0)
274 Helper function for rle compressor to find the length of a span where
275 the same pixel value is in the buffer.
278 length - number of pixel values in buffer
279 bytepp - number of bytes in a pixel value
286 find_span(unsigned char *buf, int length, int bytepp) {
289 if(memcmp(buf, buf+(i*bytepp), bytepp) != 0) return i;
297 =item tga_header_unpack(header, headbuf)
299 Unpacks the header structure into from buffer and stores
300 in the header structure.
302 header - header structure
303 headbuf - buffer to unpack from
310 tga_header_unpack(tga_header *header, unsigned char headbuf[18]) {
311 header->idlength = headbuf[0];
312 header->colourmaptype = headbuf[1];
313 header->datatypecode = headbuf[2];
314 header->colourmaporigin = (headbuf[4] << 8) + headbuf[3];
315 header->colourmaplength = (headbuf[6] << 8) + headbuf[5];
316 header->colourmapdepth = headbuf[7];
317 header->x_origin = (headbuf[9] << 8) + headbuf[8];
318 header->y_origin = (headbuf[11] << 8) + headbuf[10];
319 header->width = (headbuf[13] << 8) + headbuf[12];
320 header->height = (headbuf[15] << 8) + headbuf[14];
321 header->bitsperpixel = headbuf[16];
322 header->imagedescriptor = headbuf[17];
327 =item tga_header_pack(header, headbuf)
329 Packs header structure into buffer for writing.
331 header - header structure
332 headbuf - buffer to pack into
339 tga_header_pack(tga_header *header, unsigned char headbuf[18]) {
340 headbuf[0] = header->idlength;
341 headbuf[1] = header->colourmaptype;
342 headbuf[2] = header->datatypecode;
343 headbuf[3] = header->colourmaporigin & 0xff;
344 headbuf[4] = header->colourmaporigin >> 8;
345 headbuf[5] = header->colourmaplength & 0xff;
346 headbuf[6] = header->colourmaplength >> 8;
347 headbuf[7] = header->colourmapdepth;
348 headbuf[8] = header->x_origin & 0xff;
349 headbuf[9] = header->x_origin >> 8;
350 headbuf[10] = header->y_origin & 0xff;
351 headbuf[11] = header->y_origin >> 8;
352 headbuf[12] = header->width & 0xff;
353 headbuf[13] = header->width >> 8;
354 headbuf[14] = header->height & 0xff;
355 headbuf[15] = header->height >> 8;
356 headbuf[16] = header->bitsperpixel;
357 headbuf[17] = header->imagedescriptor;
362 =item tga_source_read(s, buf, pixels)
364 Reads pixel number of pixels from source s into buffer buf. Takes
365 care of decompressing the stream if needed.
368 buf - destination buffer
369 pixels - number of pixels to put into buffer
376 tga_source_read(tga_source *s, unsigned char *buf, size_t pixels) {
378 if (!s->compressed) {
379 if (s->ig->readcb(s->ig, buf, pixels*s->bytepp) != pixels*s->bytepp) return 0;
385 if (s->len == 0) s->state = NoInit;
388 if (s->ig->readcb(s->ig, &s->hdr, 1) != 1) return 0;
390 s->len = (s->hdr &~(1<<7))+1;
391 s->state = (s->hdr & (1<<7)) ? Rle : Raw;
392 if (s->state == Rle && s->ig->readcb(s->ig, s->cval, s->bytepp) != s->bytepp) return 0;
396 ml = min(s->len, pixels-cp);
397 for(k=0; k<ml; k++) for(j=0; j<s->bytepp; j++)
398 buf[(cp+k)*s->bytepp+j] = s->cval[j];
399 // memset(buf+cp, s->cidx, ml);
404 ml = min(s->len, pixels-cp);
405 if (s->ig->readcb(s->ig, buf+cp*s->bytepp, ml*s->bytepp) != ml*s->bytepp) return 0;
418 =item tga_dest_write(s, buf, pixels)
420 Writes pixels from buf to destination s. Takes care of compressing if the
421 destination is compressed.
425 pixels - number of pixels to put write to destination
432 tga_dest_write(tga_dest *s, unsigned char *buf, size_t pixels) {
435 if (!s->compressed) {
436 if (s->ig->writecb(s->ig, buf, pixels*s->bytepp) != pixels*s->bytepp) return 0;
442 int nxtrip = find_repeat(buf+cp*s->bytepp, pixels-cp, s->bytepp);
443 tlen = (nxtrip == -1) ? pixels-cp : nxtrip;
445 int clen = (tlen>128) ? 128 : tlen;
447 if (s->ig->writecb(s->ig, &clen, 1) != 1) return 0;
449 if (s->ig->writecb(s->ig, buf+cp*s->bytepp, clen*s->bytepp) != clen*s->bytepp) return 0;
453 if (cp >= pixels) break;
454 tlen = find_span(buf+cp*s->bytepp, pixels-cp, s->bytepp);
456 int clen = (tlen>128) ? 128 : tlen;
457 clen = (clen - 1) | 0x80;
458 if (s->ig->writecb(s->ig, &clen, 1) != 1) return 0;
459 clen = (clen & ~0x80) + 1;
460 if (s->ig->writecb(s->ig, buf+cp*s->bytepp, s->bytepp) != s->bytepp) return 0;
474 =item tga_palette_read(ig, img, bytepp, colourmaplength)
476 Reads the colormap from a tga file and stores in the paletted image
479 ig - iolayer data source
480 img - image structure
481 bytepp - bytes per pixel
482 colourmaplength - number of colours in colourmap
489 tga_palette_read(io_glue *ig, i_img *img, int bytepp, int colourmaplength) {
492 unsigned char *palbuf;
495 palbsize = colourmaplength*bytepp;
496 palbuf = mymalloc(palbsize);
498 if (ig->readcb(ig, palbuf, palbsize) != palbsize) {
499 i_push_error(errno, "could not read targa colourmap");
503 /* populate the palette of the new image */
504 for(i=0; i<colourmaplength; i++) {
505 color_unpack(palbuf+i*bytepp, bytepp, &val);
506 i_addcolors(img, &val, 1);
514 =item tga_palette_write(ig, img, bitspp, colourmaplength)
516 Stores the colormap of an image in the destination ig.
518 ig - iolayer data source
519 img - image structure
520 bitspp - bits per pixel in colourmap
521 colourmaplength - number of colours in colourmap
528 tga_palette_write(io_glue *ig, i_img *img, int bitspp, int colourmaplength) {
530 int bytepp = bpp_to_bytes(bitspp);
531 size_t palbsize = i_colorcount(img)*bytepp;
532 unsigned char *palbuf = mymalloc(palbsize);
534 for(i=0; i<colourmaplength; i++) {
536 i_getcolors(img, i, &val, 1);
537 color_pack(palbuf+i*bytepp, bitspp, &val);
540 if (ig->writecb(ig, palbuf, palbsize) != palbsize) {
541 i_push_error(errno, "could not write targa colourmap");
551 =item i_readtga_wiol(ig, length)
553 Read in an image from the iolayer data source and return the image structure to it.
554 Returns NULL on error.
557 length - maximum length to read from data source, before closing it -1
564 i_readtga_wiol(io_glue *ig, int length) {
567 int width, height, channels;
573 unsigned char headbuf[18];
574 unsigned char *databuf;
575 unsigned char *reorderbuf;
577 i_color *linebuf = NULL;
580 mm_log((1,"i_readtga(ig %p, length %d)\n", ig, length));
582 io_glue_commit_types(ig);
584 if (ig->readcb(ig, &headbuf, 18) != 18) {
585 i_push_error(errno, "could not read targa header");
589 tga_header_unpack(&header, headbuf);
591 mm_log((1,"Id length: %d\n",header.idlength));
592 mm_log((1,"Colour map type: %d\n",header.colourmaptype));
593 mm_log((1,"Image type: %d\n",header.datatypecode));
594 mm_log((1,"Colour map offset: %d\n",header.colourmaporigin));
595 mm_log((1,"Colour map length: %d\n",header.colourmaplength));
596 mm_log((1,"Colour map depth: %d\n",header.colourmapdepth));
597 mm_log((1,"X origin: %d\n",header.x_origin));
598 mm_log((1,"Y origin: %d\n",header.y_origin));
599 mm_log((1,"Width: %d\n",header.width));
600 mm_log((1,"Height: %d\n",header.height));
601 mm_log((1,"Bits per pixel: %d\n",header.bitsperpixel));
602 mm_log((1,"Descriptor: %d\n",header.imagedescriptor));
604 if (header.idlength) {
605 idstring = mymalloc(header.idlength+1);
606 if (ig->readcb(ig, idstring, header.idlength) != header.idlength) {
607 i_push_error(errno, "short read on targa idstring");
610 myfree(idstring); /* Move this later, once this is stored in a tag */
613 width = header.width;
614 height = header.height;
618 switch (header.datatypecode) {
619 case 0: /* No data in image */
620 i_push_error(0, "Targa image contains no image data");
623 case 1: /* Uncompressed, color-mapped images */
624 case 9: /* Compressed, color-mapped images */
625 case 3: /* Uncompressed, grayscale images */
626 case 11: /* Compressed, grayscale images */
627 if (header.bitsperpixel != 8) {
628 i_push_error(0, "Targa: mapped/grayscale image's bpp is not 8, unsupported.");
633 case 2: /* Uncompressed, rgb images */
634 case 10: /* Compressed, rgb images */
635 if ((src.bytepp = bpp_to_bytes(header.bitsperpixel)))
637 i_push_error(0, "Targa: direct color image's bpp is not 15/16/24/32 - unsupported.");
640 case 32: /* Compressed color-mapped, Huffman, Delta and runlength */
641 case 33: /* Compressed color-mapped, Huffman, Delta and runlength */
642 i_push_error(0, "Unsupported Targa (Huffman/delta/rle/quadtree) subformat is not supported");
645 default: /* All others which we don't know which might be */
646 i_push_error(0, "Unknown targa format");
654 src.compressed = !!(header.datatypecode & (1<<3));
656 /* Determine number of channels */
659 switch (header.datatypecode) {
661 case 2: /* Uncompressed, rgb images */
662 case 10: /* Compressed, rgb images */
664 case 1: /* Uncompressed, color-mapped images */
665 case 9: /* Compressed, color-mapped images */
666 if ((channels = bpp_to_channels(mapped ?
667 header.colourmapdepth :
668 header.bitsperpixel))) break;
669 i_push_error(0, "Targa Image has none of 15/16/24/32 pixel layout");
672 case 3: /* Uncompressed, grayscale images */
673 case 11: /* Compressed, grayscale images */
680 i_img_pal_new(width, height, channels, 256) :
681 i_img_empty_ch(NULL, width, height, channels);
684 !tga_palette_read(ig,
686 bpp_to_bytes(header.colourmapdepth),
687 header.colourmaplength)
689 i_push_error(0, "Targa Image has none of 15/16/24/32 pixel layout");
693 /* Allocate buffers */
694 databuf = mymalloc(width*src.bytepp);
695 if (!mapped) linebuf = mymalloc(width*sizeof(i_color));
697 for(y=0; y<height; y++) {
698 if (!tga_source_read(&src, databuf, width)) {
699 i_push_error(errno, "read for targa data failed");
703 if (mapped && header.colourmaporigin) for(x=0; x<width; x++) databuf[x] -= header.colourmaporigin;
704 if (mapped) i_ppal(img, 0, width, header.imagedescriptor & (1<<5) ? y : height-1-y, databuf);
706 for(x=0; x<width; x++) color_unpack(databuf+x*src.bytepp, src.bytepp, linebuf+x);
707 i_plin(img, 0, width, header.imagedescriptor & (1<<5) ? y : height-1-y, linebuf);
711 if (linebuf) myfree(linebuf);
718 =item i_writetga_wiol(img, ig)
720 Writes an image in targa format. Returns 0 on error.
729 i_writetga_wiol(i_img *img, io_glue *ig, int wierdpack, int compress, char *idstring, size_t idlen) {
730 static int rgb_chan[] = { 2, 1, 0, 3 };
733 unsigned char headbuf[18];
734 // unsigned char *data;
743 char *idstring = "testing";
747 idlen = strlen(idstring);
748 mapped = img->type == i_palette_type;
750 mm_log((1,"i_writetga_wiol(img %p, ig %p, idstring %p, idlen %d, wierdpack %d, compress %d)\n",
751 img, ig, idstring, idlen, wierdpack, compress));
752 mm_log((1, "virtual %d, paletted %d\n", img->virtual, mapped));
753 mm_log((1, "channels %d\n", img->channels));
757 switch (img->channels) {
761 mm_log((1,"wierdpack option ignored for 1 channel images\n"));
766 i_push_error(0, "Cannot store 2 channel image in targa format");
770 bitspp = wierdpack ? 15 : 24;
773 bitspp = wierdpack ? 16 : 32;
776 i_push_error(0, "Targa only handles 1,3 and 4 channel images.");
780 io_glue_commit_types(ig);
783 header.idlength = idlen;
784 header.colourmaptype = mapped ? 1 : 0;
785 header.datatypecode = mapped ? 1 : img->channels == 1 ? 3 : 2;
786 header.datatypecode += compress ? 8 : 0;
787 mm_log((1, "datatypecode %d\n", header.datatypecode));
788 header.colourmaporigin = 0;
789 header.colourmaplength = mapped ? i_colorcount(img) : 0;
790 header.colourmapdepth = mapped ? bitspp : 0;
793 header.width = img->xsize;
794 header.height = img->ysize;
795 header.bitsperpixel = mapped ? 8 : bitspp;
796 header.imagedescriptor = (1<<5); /* normal order instead of upside down */
798 tga_header_pack(&header, headbuf);
800 if (ig->writecb(ig, &headbuf, sizeof(headbuf)) != sizeof(headbuf)) {
801 i_push_error(errno, "could not write targa header");
806 if (ig->writecb(ig, idstring, idlen) != idlen) {
807 i_push_error(errno, "could not write targa idstring");
812 /* Make this into a constructor? */
813 dest.compressed = compress;
814 dest.bytepp = mapped ? 1 : bpp_to_bytes(bitspp);
817 mm_log((1, "dest.compressed = %d\n", dest.compressed));
818 mm_log((1, "dest.bytepp = %d\n", dest.bytepp));
820 if (img->type == i_palette_type) {
822 int bytepp = bpp_to_bytes(bitspp);
823 if (!tga_palette_write(ig, img, bitspp, i_colorcount(img))) return 0;
825 if (!img->virtual && !dest.compressed) {
826 if (ig->writecb(ig, img->idata, img->bytes) != img->bytes) {
827 i_push_error(errno, "could not write targa image data");
832 i_palidx *vals = mymalloc(sizeof(i_palidx)*img->xsize);
833 for(y=0; y<img->ysize; y++) {
834 i_gpal(img, 0, img->xsize, y, vals);
835 tga_dest_write(&dest, vals, img->xsize);
839 } else { /* direct type */
841 int bytepp = wierdpack ? 2 : bpp_to_bytes(bitspp);
842 int lsize = bytepp * img->xsize;
843 i_color *vals = mymalloc(img->xsize*sizeof(i_color));
844 unsigned char *buf = mymalloc(lsize);
846 for(y=0; y<img->ysize; y++) {
847 i_glin(img, 0, img->xsize, y, vals);
848 for(x=0; x<img->xsize; x++) color_pack(buf+x*bytepp, bitspp, vals+x);
849 tga_dest_write(&dest, buf, img->xsize);