libavcodec/tiff.c

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