libavcodec/tiff.c

   1 /*
   2  * Copyright (c) 2006 Konstantin Shishkov
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg 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 GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 /**
  22  * @file
  23  * TIFF image decoder
  24  */
  25 #include "avcodec.h"
  26 #if CONFIG_ZLIB
  27 #include <zlib.h>
  28 #endif
  29 #include "lzw.h"
  30 #include "tiff.h"
  31 #include "faxcompr.h"
  32 #include "libavutil/common.h"
  33 #include "libavutil/intreadwrite.h"
  34 #include "libavutil/imgutils.h"
  35
  36 typedef struct TiffContext {
  37     AVCodecContext *avctx;
  38     AVFrame picture;
  39
  40     int width, height;
  41     unsigned int bpp, bppcount;
  42     uint32_t palette[256];
  43     int palette_is_set;
  44     int le;
  45     enum TiffCompr compr;
  46     int invert;
  47     int fax_opts;
  48     int predictor;
  49     int fill_order;
  50
  51     int strips, rps, sstype;
  52     int sot;
  53     const uint8_t* stripdata;
  54     const uint8_t* stripsizes;
  55     int stripsize, stripoff;
  56     LZWState *lzw;
  57 } TiffContext;
  58
  59 static int tget_short(const uint8_t **p, int le){
  60     int v = le ? AV_RL16(*p) : AV_RB16(*p);
  61     *p += 2;
  62     return v;
  63 }
  64
  65 static int tget_long(const uint8_t **p, int le){
  66     int v = le ? AV_RL32(*p) : AV_RB32(*p);
  67     *p += 4;
  68     return v;
  69 }
  70
  71 static int tget(const uint8_t **p, int type, int le){
  72     switch(type){
  73     case TIFF_BYTE : return *(*p)++;
  74     case TIFF_SHORT: return tget_short(p, le);
  75     case TIFF_LONG : return tget_long (p, le);
  76     default        : return -1;
  77     }
  78 }
  79
  80 #if CONFIG_ZLIB
  81 static int tiff_uncompress(uint8_t *dst, unsigned long *len, const uint8_t *src, int size)
  82 {
  83     z_stream zstream;
  84     int zret;
  85
  86     memset(&zstream, 0, sizeof(zstream));
  87     zstream.next_in = src;
  88     zstream.avail_in = size;
  89     zstream.next_out = dst;
  90     zstream.avail_out = *len;
  91     zret = inflateInit(&zstream);
  92     if (zret != Z_OK) {
  93         av_log(NULL, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
  94         return zret;
  95     }
  96     zret = inflate(&zstream, Z_SYNC_FLUSH);
  97     inflateEnd(&zstream);
  98     *len = zstream.total_out;
  99     return zret == Z_STREAM_END ? Z_OK : zret;
 100 }
 101 #endif
 102
 103 static int tiff_unpack_strip(TiffContext *s, uint8_t* dst, int stride, const uint8_t *src, int size, int lines){
 104     int c, line, pixels, code;
 105     const uint8_t *ssrc = src;
 106     int width = ((s->width * s->bpp) + 7) >> 3;
 107 #if CONFIG_ZLIB
 108     uint8_t *zbuf; unsigned long outlen;
 109
 110     if(s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE){
 111         int ret;
 112         outlen = width * lines;
 113         zbuf = av_malloc(outlen);
 114         ret = tiff_uncompress(zbuf, &outlen, src, size);
 115         if(ret != Z_OK){
 116             av_log(s->avctx, AV_LOG_ERROR, "Uncompressing failed (%lu of %lu) with error %d\n", outlen, (unsigned long)width * lines, ret);
 117             av_free(zbuf);
 118             return -1;
 119         }
 120         src = zbuf;
 121         for(line = 0; line < lines; line++){
 122             memcpy(dst, src, width);
 123             dst += stride;
 124             src += width;
 125         }
 126         av_free(zbuf);
 127         return 0;
 128     }
 129 #endif
 130     if(s->compr == TIFF_LZW){
 131         if(ff_lzw_decode_init(s->lzw, 8, src, size, FF_LZW_TIFF) < 0){
 132             av_log(s->avctx, AV_LOG_ERROR, "Error initializing LZW decoder\n");
 133             return -1;
 134         }
 135     }
 136     if(s->compr == TIFF_CCITT_RLE || s->compr == TIFF_G3 || s->compr == TIFF_G4){
 137         int i, ret = 0;
 138         uint8_t *src2 = av_malloc(size + FF_INPUT_BUFFER_PADDING_SIZE);
 139
 140         if(!src2 || (unsigned)size + FF_INPUT_BUFFER_PADDING_SIZE < (unsigned)size){
 141             av_log(s->avctx, AV_LOG_ERROR, "Error allocating temporary buffer\n");
 142             return -1;
 143         }
 144         if(s->fax_opts & 2){
 145             av_log(s->avctx, AV_LOG_ERROR, "Uncompressed fax mode is not supported (yet)\n");
 146             av_free(src2);
 147             return -1;
 148         }
 149         if(!s->fill_order){
 150             memcpy(src2, src, size);
 151         }else{
 152             for(i = 0; i < size; i++)
 153                 src2[i] = av_reverse[src[i]];
 154         }
 155         memset(src2+size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
 156         switch(s->compr){
 157         case TIFF_CCITT_RLE:
 158         case TIFF_G3:
 159         case TIFF_G4:
 160             ret = ff_ccitt_unpack(s->avctx, src2, size, dst, lines, stride, s->compr, s->fax_opts);
 161             break;
 162         }
 163         av_free(src2);
 164         return ret;
 165     }
 166     for(line = 0; line < lines; line++){
 167         if(src - ssrc > size){
 168             av_log(s->avctx, AV_LOG_ERROR, "Source data overread\n");
 169             return -1;
 170         }
 171         switch(s->compr){
 172         case TIFF_RAW:
 173             if (!s->fill_order) {
 174                 memcpy(dst, src, width);
 175             } else {
 176                 int i;
 177                 for (i = 0; i < width; i++)
 178                     dst[i] = av_reverse[src[i]];
 179             }
 180             src += width;
 181             break;
 182         case TIFF_PACKBITS:
 183             for(pixels = 0; pixels < width;){
 184                 code = (int8_t)*src++;
 185                 if(code >= 0){
 186                     code++;
 187                     if(pixels + code > width){
 188                         av_log(s->avctx, AV_LOG_ERROR, "Copy went out of bounds\n");
 189                         return -1;
 190                     }
 191                     memcpy(dst + pixels, src, code);
 192                     src += code;
 193                     pixels += code;
 194                 }else if(code != -128){ // -127..-1
 195                     code = (-code) + 1;
 196                     if(pixels + code > width){
 197                         av_log(s->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
 198                         return -1;
 199                     }
 200                     c = *src++;
 201                     memset(dst + pixels, c, code);
 202                     pixels += code;
 203                 }
 204             }
 205             break;
 206         case TIFF_LZW:
 207             pixels = ff_lzw_decode(s->lzw, dst, width);
 208             if(pixels < width){
 209                 av_log(s->avctx, AV_LOG_ERROR, "Decoded only %i bytes of %i\n", pixels, width);
 210                 return -1;
 211             }
 212             break;
 213         }
 214         dst += stride;
 215     }
 216     return 0;
 217 }
 218
 219 static int init_image(TiffContext *s)
 220 {
 221     int i, ret;
 222     uint32_t *pal;
 223
 224     switch (s->bpp * 10 + s->bppcount) {
 225     case 11:
 226         s->avctx->pix_fmt = PIX_FMT_MONOBLACK;
 227         break;
 228     case 81:
 229         s->avctx->pix_fmt = PIX_FMT_PAL8;
 230         break;
 231     case 243:
 232         s->avctx->pix_fmt = PIX_FMT_RGB24;
 233         break;
 234     case 161:
 235         s->avctx->pix_fmt = PIX_FMT_GRAY16BE;
 236         break;
 237     case 324:
 238         s->avctx->pix_fmt = PIX_FMT_RGBA;
 239         break;
 240     case 483:
 241         s->avctx->pix_fmt = s->le ? PIX_FMT_RGB48LE : PIX_FMT_RGB48BE;
 242         break;
 243     default:
 244         av_log(s->avctx, AV_LOG_ERROR,
 245                "This format is not supported (bpp=%d, bppcount=%d)\n",
 246                s->bpp, s->bppcount);
 247         return AVERROR_INVALIDDATA;
 248     }
 249     if (s->width != s->avctx->width || s->height != s->avctx->height) {
 250         if ((ret = av_image_check_size(s->width, s->height, 0, s->avctx)) < 0)
 251             return ret;
 252         avcodec_set_dimensions(s->avctx, s->width, s->height);
 253     }
 254     if (s->picture.data[0])
 255         s->avctx->release_buffer(s->avctx, &s->picture);
 256     if ((ret = s->avctx->get_buffer(s->avctx, &s->picture)) < 0) {
 257         av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
 258         return ret;
 259     }
 260     if (s->avctx->pix_fmt == PIX_FMT_PAL8) {
 261         if (s->palette_is_set) {
 262             memcpy(s->picture.data[1], s->palette, sizeof(s->palette));
 263         } else {
 264             /* make default grayscale pal */
 265             pal = (uint32_t *) s->picture.data[1];
 266             for (i = 0; i < 256; i++)
 267                 pal[i] = i * 0x010101;
 268         }
 269     }
 270     return 0;
 271 }
 272
 273 static int tiff_decode_tag(TiffContext *s, const uint8_t *start, const uint8_t *buf, const uint8_t *end_buf)
 274 {
 275     int tag, type, count, off, value = 0;
 276     int i, j;
 277     uint32_t *pal;
 278     const uint8_t *rp, *gp, *bp;
 279
 280     tag = tget_short(&buf, s->le);
 281     type = tget_short(&buf, s->le);
 282     count = tget_long(&buf, s->le);
 283     off = tget_long(&buf, s->le);
 284
 285     if(count == 1){
 286         switch(type){
 287         case TIFF_BYTE:
 288         case TIFF_SHORT:
 289             buf -= 4;
 290             value = tget(&buf, type, s->le);
 291             buf = NULL;
 292             break;
 293         case TIFF_LONG:
 294             value = off;
 295             buf = NULL;
 296             break;
 297         case TIFF_STRING:
 298             if(count <= 4){
 299                 buf -= 4;
 300                 break;
 301             }
 302         default:
 303             value = -1;
 304             buf = start + off;
 305         }
 306     }else if(type_sizes[type] * count <= 4){
 307         buf -= 4;
 308     }else{
 309         buf = start + off;
 310     }
 311
 312     if(buf && (buf < start || buf > end_buf)){
 313         av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
 314         return -1;
 315     }
 316
 317     switch(tag){
 318     case TIFF_WIDTH:
 319         s->width = value;
 320         break;
 321     case TIFF_HEIGHT:
 322         s->height = value;
 323         break;
 324     case TIFF_BPP:
 325         s->bppcount = count;
 326         if(count > 4){
 327             av_log(s->avctx, AV_LOG_ERROR, "This format is not supported (bpp=%d, %d components)\n", s->bpp, count);
 328             return -1;
 329         }
 330         if(count == 1) s->bpp = value;
 331         else{
 332             switch(type){
 333             case TIFF_BYTE:
 334                 s->bpp = (off & 0xFF) + ((off >> 8) & 0xFF) + ((off >> 16) & 0xFF) + ((off >> 24) & 0xFF);
 335                 break;
 336             case TIFF_SHORT:
 337             case TIFF_LONG:
 338                 s->bpp = 0;
 339                 for(i = 0; i < count; i++) s->bpp += tget(&buf, type, s->le);
 340                 break;
 341             default:
 342                 s->bpp = -1;
 343             }
 344         }
 345         break;
 346     case TIFF_SAMPLES_PER_PIXEL:
 347         if (count != 1) {
 348             av_log(s->avctx, AV_LOG_ERROR,
 349                    "Samples per pixel requires a single value, many provided\n");
 350             return AVERROR_INVALIDDATA;
 351         }
 352         if (s->bppcount == 1)
 353             s->bpp *= value;
 354         s->bppcount = value;
 355         break;
 356     case TIFF_COMPR:
 357         s->compr = value;
 358         s->predictor = 0;
 359         switch(s->compr){
 360         case TIFF_RAW:
 361         case TIFF_PACKBITS:
 362         case TIFF_LZW:
 363         case TIFF_CCITT_RLE:
 364             break;
 365         case TIFF_G3:
 366         case TIFF_G4:
 367             s->fax_opts = 0;
 368             break;
 369         case TIFF_DEFLATE:
 370         case TIFF_ADOBE_DEFLATE:
 371 #if CONFIG_ZLIB
 372             break;
 373 #else
 374             av_log(s->avctx, AV_LOG_ERROR, "Deflate: ZLib not compiled in\n");
 375             return -1;
 376 #endif
 377         case TIFF_JPEG:
 378         case TIFF_NEWJPEG:
 379             av_log(s->avctx, AV_LOG_ERROR, "JPEG compression is not supported\n");
 380             return -1;
 381         default:
 382             av_log(s->avctx, AV_LOG_ERROR, "Unknown compression method %i\n", s->compr);
 383             return -1;
 384         }
 385         break;
 386     case TIFF_ROWSPERSTRIP:
 387         if(type == TIFF_LONG && value == -1)
 388             value = s->avctx->height;
 389         if(value < 1){
 390             av_log(s->avctx, AV_LOG_ERROR, "Incorrect value of rows per strip\n");
 391             return -1;
 392         }
 393         s->rps = value;
 394         break;
 395     case TIFF_STRIP_OFFS:
 396         if(count == 1){
 397             s->stripdata = NULL;
 398             s->stripoff = value;
 399         }else
 400             s->stripdata = start + off;
 401         s->strips = count;
 402         if(s->strips == 1) s->rps = s->height;
 403         s->sot = type;
 404         if(s->stripdata > end_buf){
 405             av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
 406             return -1;
 407         }
 408         break;
 409     case TIFF_STRIP_SIZE:
 410         if(count == 1){
 411             s->stripsizes = NULL;
 412             s->stripsize = value;
 413             s->strips = 1;
 414         }else{
 415             s->stripsizes = start + off;
 416         }
 417         s->strips = count;
 418         s->sstype = type;
 419         if(s->stripsizes > end_buf){
 420             av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
 421             return -1;
 422         }
 423         break;
 424     case TIFF_PREDICTOR:
 425         s->predictor = value;
 426         break;
 427     case TIFF_INVERT:
 428         switch(value){
 429         case 0:
 430             s->invert = 1;
 431             break;
 432         case 1:
 433             s->invert = 0;
 434             break;
 435         case 2:
 436         case 3:
 437             break;
 438         default:
 439             av_log(s->avctx, AV_LOG_ERROR, "Color mode %d is not supported\n", value);
 440             return -1;
 441         }
 442         break;
 443     case TIFF_FILL_ORDER:
 444         if(value < 1 || value > 2){
 445             av_log(s->avctx, AV_LOG_ERROR, "Unknown FillOrder value %d, trying default one\n", value);
 446             value = 1;
 447         }
 448         s->fill_order = value - 1;
 449         break;
 450     case TIFF_PAL:
 451         pal = (uint32_t *) s->palette;
 452         off = type_sizes[type];
 453         rp = buf;
 454         gp = buf + count / 3 * off;
 455         bp = buf + count / 3 * off * 2;
 456         off = (type_sizes[type] - 1) << 3;
 457         for(i = 0; i < count / 3; i++){
 458             j = 0xff << 24;
 459             j |= (tget(&rp, type, s->le) >> off) << 16;
 460             j |= (tget(&gp, type, s->le) >> off) << 8;
 461             j |= tget(&bp, type, s->le) >> off;
 462             pal[i] = j;
 463         }
 464         s->palette_is_set = 1;
 465         break;
 466     case TIFF_PLANAR:
 467         if(value == 2){
 468             av_log(s->avctx, AV_LOG_ERROR, "Planar format is not supported\n");
 469             return -1;
 470         }
 471         break;
 472     case TIFF_T4OPTIONS:
 473         if(s->compr == TIFF_G3)
 474             s->fax_opts = value;
 475         break;
 476     case TIFF_T6OPTIONS:
 477         if(s->compr == TIFF_G4)
 478             s->fax_opts = value;
 479         break;
 480
 481     default:
 482         av_log(s->avctx, AV_LOG_DEBUG, "Unknown or unsupported tag %d/0X%0X\n", tag, tag);
 483     }
 484     return 0;
 485 }
 486
 487 static int decode_frame(AVCodecContext *avctx,
 488                         void *data, int *data_size,
 489                         AVPacket *avpkt)
 490 {
 491     const uint8_t *buf = avpkt->data;
 492     int buf_size = avpkt->size;
 493     TiffContext * const s = avctx->priv_data;
 494     AVFrame *picture = data;
 495     AVFrame * const p= (AVFrame*)&s->picture;
 496     const uint8_t *orig_buf = buf, *end_buf = buf + buf_size;
 497     int id, le, off, ret;
 498     int i, j, entries;
 499     int stride, soff, ssize;
 500     uint8_t *dst;
 501
 502     //parse image header
 503     id = AV_RL16(buf); buf += 2;
 504     if(id == 0x4949) le = 1;
 505     else if(id == 0x4D4D) le = 0;
 506     else{
 507         av_log(avctx, AV_LOG_ERROR, "TIFF header not found\n");
 508         return -1;
 509     }
 510     s->le = le;
 511     s->invert = 0;
 512     s->compr = TIFF_RAW;
 513     s->fill_order = 0;
 514     // As TIFF 6.0 specification puts it "An arbitrary but carefully chosen number
 515     // that further identifies the file as a TIFF file"
 516     if(tget_short(&buf, le) != 42){
 517         av_log(avctx, AV_LOG_ERROR, "The answer to life, universe and everything is not correct!\n");
 518         return -1;
 519     }
 520     /* parse image file directory */
 521     off = tget_long(&buf, le);
 522     if(orig_buf + off + 14 >= end_buf){
 523         av_log(avctx, AV_LOG_ERROR, "IFD offset is greater than image size\n");
 524         return -1;
 525     }
 526     buf = orig_buf + off;
 527     entries = tget_short(&buf, le);
 528     for(i = 0; i < entries; i++){
 529         if(tiff_decode_tag(s, orig_buf, buf, end_buf) < 0)
 530             return -1;
 531         buf += 12;
 532     }
 533     if(!s->stripdata && !s->stripoff){
 534         av_log(avctx, AV_LOG_ERROR, "Image data is missing\n");
 535         return -1;
 536     }
 537     /* now we have the data and may start decoding */
 538     if ((ret = init_image(s)) < 0)
 539         return ret;
 540
 541     if(s->strips == 1 && !s->stripsize){
 542         av_log(avctx, AV_LOG_WARNING, "Image data size missing\n");
 543         s->stripsize = buf_size - s->stripoff;
 544     }
 545     stride = p->linesize[0];
 546     dst = p->data[0];
 547     for(i = 0; i < s->height; i += s->rps){
 548         if(s->stripsizes)
 549             ssize = tget(&s->stripsizes, s->sstype, s->le);
 550         else
 551             ssize = s->stripsize;
 552
 553         if (ssize > buf_size) {
 554             av_log(avctx, AV_LOG_ERROR, "Buffer size is smaller than strip size\n");
 555             return -1;
 556         }
 557
 558         if(s->stripdata){
 559             soff = tget(&s->stripdata, s->sot, s->le);
 560         }else
 561             soff = s->stripoff;
 562         if (soff < 0) {
 563             av_log(avctx, AV_LOG_ERROR, "Invalid stripoff: %d\n", soff);
 564             return AVERROR(EINVAL);
 565         }
 566         if(tiff_unpack_strip(s, dst, stride, orig_buf + soff, ssize, FFMIN(s->rps, s->height - i)) < 0)
 567             break;
 568         dst += s->rps * stride;
 569     }
 570     if(s->predictor == 2){
 571         dst = p->data[0];
 572         soff = s->bpp >> 3;
 573         ssize = s->width * soff;
 574         for(i = 0; i < s->height; i++) {
 575             for(j = soff; j < ssize; j++)
 576                 dst[j] += dst[j - soff];
 577             dst += stride;
 578         }
 579     }
 580
 581     if(s->invert){
 582         uint8_t *src;
 583         int j;
 584
 585         src = s->picture.data[0];
 586         for(j = 0; j < s->height; j++){
 587             for(i = 0; i < s->picture.linesize[0]; i++)
 588                 src[i] = 255 - src[i];
 589             src += s->picture.linesize[0];
 590         }
 591     }
 592     *picture= *(AVFrame*)&s->picture;
 593     *data_size = sizeof(AVPicture);
 594
 595     return buf_size;
 596 }
 597
 598 static av_cold int tiff_init(AVCodecContext *avctx){
 599     TiffContext *s = avctx->priv_data;
 600
 601     s->width = 0;
 602     s->height = 0;
 603     s->avctx = avctx;
 604     avcodec_get_frame_defaults((AVFrame*)&s->picture);
 605     avctx->coded_frame= (AVFrame*)&s->picture;
 606     ff_lzw_decode_open(&s->lzw);
 607     ff_ccitt_unpack_init();
 608
 609     return 0;
 610 }
 611
 612 static av_cold int tiff_end(AVCodecContext *avctx)
 613 {
 614     TiffContext * const s = avctx->priv_data;
 615
 616     ff_lzw_decode_close(&s->lzw);
 617     if(s->picture.data[0])
 618         avctx->release_buffer(avctx, &s->picture);
 619     return 0;
 620 }
 621
 622 AVCodec ff_tiff_decoder = {
 623     "tiff",
 624     AVMEDIA_TYPE_VIDEO,
 625     CODEC_ID_TIFF,
 626     sizeof(TiffContext),
 627     tiff_init,
 628     NULL,
 629     tiff_end,
 630     decode_frame,
 631     CODEC_CAP_DR1,
 632     NULL,
 633     .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),
 634 };