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
  48     int strips, rps, sstype;
  49     int sot;
  50     const uint8_t* stripdata;
  51     const uint8_t* stripsizes;
  52     int stripsize, stripoff;
  53     LZWState *lzw;
  54 } TiffContext;
  55
  56 static int tget_short(const uint8_t **p, int le){
  57     int v = le ? AV_RL16(*p) : AV_RB16(*p);
  58     *p += 2;
  59     return v;
  60 }
  61
  62 static int tget_long(const uint8_t **p, int le){
  63     int v = le ? AV_RL32(*p) : AV_RB32(*p);
  64     *p += 4;
  65     return v;
  66 }
  67
  68 static int tget(const uint8_t **p, int type, int le){
  69     switch(type){
  70     case TIFF_BYTE : return *(*p)++;
  71     case TIFF_SHORT: return tget_short(p, le);
  72     case TIFF_LONG : return tget_long (p, le);
  73     default        : return -1;
  74     }
  75 }
  76
  77 static int tiff_unpack_strip(TiffContext *s, uint8_t* dst, int stride, const uint8_t *src, int size, int lines){
  78     int c, line, pixels, code;
  79     const uint8_t *ssrc = src;
  80     int width = s->width * s->bpp >> 3;
  81 #if CONFIG_ZLIB
  82     uint8_t *zbuf; unsigned long outlen;
  83
  84     if(s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE){
  85         outlen = width * lines;
  86         zbuf = av_malloc(outlen);
  87         if(uncompress(zbuf, &outlen, src, size) != Z_OK){
  88             av_log(s->avctx, AV_LOG_ERROR, "Uncompressing failed (%lu of %lu)\n", outlen, (unsigned long)width * lines);
  89             av_free(zbuf);
  90             return -1;
  91         }
  92         src = zbuf;
  93         for(line = 0; line < lines; line++){
  94             memcpy(dst, src, width);
  95             dst += stride;
  96             src += width;
  97         }
  98         av_free(zbuf);
  99         return 0;
 100     }
 101 #endif
 102     if(s->compr == TIFF_LZW){
 103         if(ff_lzw_decode_init(s->lzw, 8, src, size, FF_LZW_TIFF) < 0){
 104             av_log(s->avctx, AV_LOG_ERROR, "Error initializing LZW decoder\n");
 105             return -1;
 106         }
 107     }
 108     if(s->compr == TIFF_CCITT_RLE || s->compr == TIFF_G3 || s->compr == TIFF_G4){
 109         int i, ret = 0;
 110         uint8_t *src2 = av_malloc(size + FF_INPUT_BUFFER_PADDING_SIZE);
 111
 112         if(!src2 || (unsigned)size + FF_INPUT_BUFFER_PADDING_SIZE < (unsigned)size){
 113             av_log(s->avctx, AV_LOG_ERROR, "Error allocating temporary buffer\n");
 114             return -1;
 115         }
 116         for(i = 0; i < size; i++)
 117             src2[i] = ff_reverse[src[i]];
 118         memset(src2+size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
 119         if(s->compr == TIFF_G3 && !(s->fax_opts & 1))
 120             s->compr = TIFF_CCITT_RLE;
 121         switch(s->compr){
 122         case TIFF_CCITT_RLE:
 123         case TIFF_G3:
 124         case TIFF_G4:
 125             ret = ff_ccitt_unpack(s->avctx, src2, size, dst, lines, stride, s->compr);
 126             break;
 127         }
 128         av_free(src2);
 129         return ret;
 130     }
 131     for(line = 0; line < lines; line++){
 132         if(src - ssrc > size){
 133             av_log(s->avctx, AV_LOG_ERROR, "Source data overread\n");
 134             return -1;
 135         }
 136         switch(s->compr){
 137         case TIFF_RAW:
 138             memcpy(dst, src, width);
 139             src += width;
 140             break;
 141         case TIFF_PACKBITS:
 142             for(pixels = 0; pixels < width;){
 143                 code = (int8_t)*src++;
 144                 if(code >= 0){
 145                     code++;
 146                     if(pixels + code > width){
 147                         av_log(s->avctx, AV_LOG_ERROR, "Copy went out of bounds\n");
 148                         return -1;
 149                     }
 150                     memcpy(dst + pixels, src, code);
 151                     src += code;
 152                     pixels += code;
 153                 }else if(code != -128){ // -127..-1
 154                     code = (-code) + 1;
 155                     if(pixels + code > width){
 156                         av_log(s->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
 157                         return -1;
 158                     }
 159                     c = *src++;
 160                     memset(dst + pixels, c, code);
 161                     pixels += code;
 162                 }
 163             }
 164             break;
 165         case TIFF_LZW:
 166             pixels = ff_lzw_decode(s->lzw, dst, width);
 167             if(pixels < width){
 168                 av_log(s->avctx, AV_LOG_ERROR, "Decoded only %i bytes of %i\n", pixels, width);
 169                 return -1;
 170             }
 171             break;
 172         }
 173         dst += stride;
 174     }
 175     return 0;
 176 }
 177
 178
 179 static int tiff_decode_tag(TiffContext *s, const uint8_t *start, const uint8_t *buf, const uint8_t *end_buf)
 180 {
 181     int tag, type, count, off, value = 0;
 182     int i, j;
 183     uint32_t *pal;
 184     const uint8_t *rp, *gp, *bp;
 185
 186     tag = tget_short(&buf, s->le);
 187     type = tget_short(&buf, s->le);
 188     count = tget_long(&buf, s->le);
 189     off = tget_long(&buf, s->le);
 190
 191     if(count == 1){
 192         switch(type){
 193         case TIFF_BYTE:
 194         case TIFF_SHORT:
 195             buf -= 4;
 196             value = tget(&buf, type, s->le);
 197             buf = NULL;
 198             break;
 199         case TIFF_LONG:
 200             value = off;
 201             buf = NULL;
 202             break;
 203         case TIFF_STRING:
 204             if(count <= 4){
 205                 buf -= 4;
 206                 break;
 207             }
 208         default:
 209             value = -1;
 210             buf = start + off;
 211         }
 212     }else if(type_sizes[type] * count <= 4){
 213         buf -= 4;
 214     }else{
 215         buf = start + off;
 216     }
 217
 218     if(buf && (buf < start || buf > end_buf)){
 219         av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
 220         return -1;
 221     }
 222
 223     switch(tag){
 224     case TIFF_WIDTH:
 225         s->width = value;
 226         break;
 227     case TIFF_HEIGHT:
 228         s->height = value;
 229         break;
 230     case TIFF_BPP:
 231         if(count == 1) s->bpp = value;
 232         else{
 233             switch(type){
 234             case TIFF_BYTE:
 235                 s->bpp = (off & 0xFF) + ((off >> 8) & 0xFF) + ((off >> 16) & 0xFF) + ((off >> 24) & 0xFF);
 236                 break;
 237             case TIFF_SHORT:
 238             case TIFF_LONG:
 239                 s->bpp = 0;
 240                 for(i = 0; i < count; i++) s->bpp += tget(&buf, type, s->le);
 241                 break;
 242             default:
 243                 s->bpp = -1;
 244             }
 245         }
 246         switch(s->bpp){
 247         case 1:
 248             s->avctx->pix_fmt = PIX_FMT_MONOBLACK;
 249             break;
 250         case 8:
 251             s->avctx->pix_fmt = PIX_FMT_PAL8;
 252             break;
 253         case 24:
 254             s->avctx->pix_fmt = PIX_FMT_RGB24;
 255             break;
 256         case 16:
 257             if(count == 1){
 258                 s->avctx->pix_fmt = PIX_FMT_GRAY16BE;
 259             }else{
 260                 av_log(s->avctx, AV_LOG_ERROR, "This format is not supported (bpp=%i)\n", s->bpp);
 261                 return -1;
 262             }
 263             break;
 264         case 32:
 265             if(count == 4){
 266                 s->avctx->pix_fmt = PIX_FMT_RGBA;
 267             }else{
 268                 av_log(s->avctx, AV_LOG_ERROR, "This format is not supported (bpp=%d, %d components)\n", s->bpp, count);
 269                 return -1;
 270             }
 271             break;
 272         default:
 273             av_log(s->avctx, AV_LOG_ERROR, "This format is not supported (bpp=%d, %d components)\n", s->bpp, count);
 274             return -1;
 275         }
 276         if(s->width != s->avctx->width || s->height != s->avctx->height){
 277             if(avcodec_check_dimensions(s->avctx, s->width, s->height))
 278                 return -1;
 279             avcodec_set_dimensions(s->avctx, s->width, s->height);
 280         }
 281         if(s->picture.data[0])
 282             s->avctx->release_buffer(s->avctx, &s->picture);
 283         if(s->avctx->get_buffer(s->avctx, &s->picture) < 0){
 284             av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
 285             return -1;
 286         }
 287         if(s->bpp == 8){
 288             /* make default grayscale pal */
 289             pal = (uint32_t *) s->picture.data[1];
 290             for(i = 0; i < 256; i++)
 291                 pal[i] = i * 0x010101;
 292         }
 293         break;
 294     case TIFF_COMPR:
 295         s->compr = value;
 296         s->predictor = 0;
 297         switch(s->compr){
 298         case TIFF_RAW:
 299         case TIFF_PACKBITS:
 300         case TIFF_LZW:
 301         case TIFF_CCITT_RLE:
 302             break;
 303         case TIFF_G3:
 304         case TIFF_G4:
 305             s->fax_opts = 0;
 306             break;
 307         case TIFF_DEFLATE:
 308         case TIFF_ADOBE_DEFLATE:
 309 #if CONFIG_ZLIB
 310             break;
 311 #else
 312             av_log(s->avctx, AV_LOG_ERROR, "Deflate: ZLib not compiled in\n");
 313             return -1;
 314 #endif
 315         case TIFF_JPEG:
 316         case TIFF_NEWJPEG:
 317             av_log(s->avctx, AV_LOG_ERROR, "JPEG compression is not supported\n");
 318             return -1;
 319         default:
 320             av_log(s->avctx, AV_LOG_ERROR, "Unknown compression method %i\n", s->compr);
 321             return -1;
 322         }
 323         break;
 324     case TIFF_ROWSPERSTRIP:
 325         if(type == TIFF_LONG && value == -1)
 326             value = s->avctx->height;
 327         if(value < 1){
 328             av_log(s->avctx, AV_LOG_ERROR, "Incorrect value of rows per strip\n");
 329             return -1;
 330         }
 331         s->rps = value;
 332         break;
 333     case TIFF_STRIP_OFFS:
 334         if(count == 1){
 335             s->stripdata = NULL;
 336             s->stripoff = value;
 337         }else
 338             s->stripdata = start + off;
 339         s->strips = count;
 340         if(s->strips == 1) s->rps = s->height;
 341         s->sot = type;
 342         if(s->stripdata > end_buf){
 343             av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
 344             return -1;
 345         }
 346         break;
 347     case TIFF_STRIP_SIZE:
 348         if(count == 1){
 349             s->stripsizes = NULL;
 350             s->stripsize = value;
 351             s->strips = 1;
 352         }else{
 353             s->stripsizes = start + off;
 354         }
 355         s->strips = count;
 356         s->sstype = type;
 357         if(s->stripsizes > end_buf){
 358             av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
 359             return -1;
 360         }
 361         break;
 362     case TIFF_PREDICTOR:
 363         s->predictor = value;
 364         break;
 365     case TIFF_INVERT:
 366         switch(value){
 367         case 0:
 368             s->invert = 1;
 369             break;
 370         case 1:
 371             s->invert = 0;
 372             break;
 373         case 2:
 374         case 3:
 375             break;
 376         default:
 377             av_log(s->avctx, AV_LOG_ERROR, "Color mode %d is not supported\n", value);
 378             return -1;
 379         }
 380         break;
 381     case TIFF_PAL:
 382         if(s->avctx->pix_fmt != PIX_FMT_PAL8){
 383             av_log(s->avctx, AV_LOG_ERROR, "Palette met but this is not palettized format\n");
 384             return -1;
 385         }
 386         pal = (uint32_t *) s->picture.data[1];
 387         off = type_sizes[type];
 388         rp = buf;
 389         gp = buf + count / 3 * off;
 390         bp = buf + count / 3 * off * 2;
 391         off = (type_sizes[type] - 1) << 3;
 392         for(i = 0; i < count / 3; i++){
 393             j = (tget(&rp, type, s->le) >> off) << 16;
 394             j |= (tget(&gp, type, s->le) >> off) << 8;
 395             j |= tget(&bp, type, s->le) >> off;
 396             pal[i] = j;
 397         }
 398         break;
 399     case TIFF_PLANAR:
 400         if(value == 2){
 401             av_log(s->avctx, AV_LOG_ERROR, "Planar format is not supported\n");
 402             return -1;
 403         }
 404         break;
 405     case TIFF_T4OPTIONS:
 406     case TIFF_T6OPTIONS:
 407         s->fax_opts = value;
 408         break;
 409     }
 410     return 0;
 411 }
 412
 413 static int decode_frame(AVCodecContext *avctx,
 414                         void *data, int *data_size,
 415                         AVPacket *avpkt)
 416 {
 417     const uint8_t *buf = avpkt->data;
 418     int buf_size = avpkt->size;
 419     TiffContext * const s = avctx->priv_data;
 420     AVFrame *picture = data;
 421     AVFrame * const p= (AVFrame*)&s->picture;
 422     const uint8_t *orig_buf = buf, *end_buf = buf + buf_size;
 423     int id, le, off;
 424     int i, j, entries;
 425     int stride, soff, ssize;
 426     uint8_t *dst;
 427
 428     //parse image header
 429     id = AV_RL16(buf); buf += 2;
 430     if(id == 0x4949) le = 1;
 431     else if(id == 0x4D4D) le = 0;
 432     else{
 433         av_log(avctx, AV_LOG_ERROR, "TIFF header not found\n");
 434         return -1;
 435     }
 436     s->le = le;
 437     s->invert = 0;
 438     s->compr = TIFF_RAW;
 439     // As TIFF 6.0 specification puts it "An arbitrary but carefully chosen number
 440     // that further identifies the file as a TIFF file"
 441     if(tget_short(&buf, le) != 42){
 442         av_log(avctx, AV_LOG_ERROR, "The answer to life, universe and everything is not correct!\n");
 443         return -1;
 444     }
 445     /* parse image file directory */
 446     off = tget_long(&buf, le);
 447     if(orig_buf + off + 14 >= end_buf){
 448         av_log(avctx, AV_LOG_ERROR, "IFD offset is greater than image size\n");
 449         return -1;
 450     }
 451     buf = orig_buf + off;
 452     entries = tget_short(&buf, le);
 453     for(i = 0; i < entries; i++){
 454         if(tiff_decode_tag(s, orig_buf, buf, end_buf) < 0)
 455             return -1;
 456         buf += 12;
 457     }
 458     if(!s->stripdata && !s->stripoff){
 459         av_log(avctx, AV_LOG_ERROR, "Image data is missing\n");
 460         return -1;
 461     }
 462     /* now we have the data and may start decoding */
 463     if(!p->data[0]){
 464         av_log(s->avctx, AV_LOG_ERROR, "Picture initialization missing\n");
 465         return -1;
 466     }
 467     if(s->strips == 1 && !s->stripsize){
 468         av_log(avctx, AV_LOG_WARNING, "Image data size missing\n");
 469         s->stripsize = buf_size - s->stripoff;
 470     }
 471     stride = p->linesize[0];
 472     dst = p->data[0];
 473     for(i = 0; i < s->height; i += s->rps){
 474         if(s->stripsizes)
 475             ssize = tget(&s->stripsizes, s->sstype, s->le);
 476         else
 477             ssize = s->stripsize;
 478
 479         if(s->stripdata){
 480             soff = tget(&s->stripdata, s->sot, s->le);
 481         }else
 482             soff = s->stripoff;
 483         if(tiff_unpack_strip(s, dst, stride, orig_buf + soff, ssize, FFMIN(s->rps, s->height - i)) < 0)
 484             break;
 485         dst += s->rps * stride;
 486     }
 487     if(s->predictor == 2){
 488         dst = p->data[0];
 489         soff = s->bpp >> 3;
 490         ssize = s->width * soff;
 491         for(i = 0; i < s->height; i++) {
 492             for(j = soff; j < ssize; j++)
 493                 dst[j] += dst[j - soff];
 494             dst += stride;
 495         }
 496     }
 497
 498     if(s->invert){
 499         uint8_t *src;
 500         int j;
 501
 502         src = s->picture.data[0];
 503         for(j = 0; j < s->height; j++){
 504             for(i = 0; i < s->picture.linesize[0]; i++)
 505                 src[i] = 255 - src[i];
 506             src += s->picture.linesize[0];
 507         }
 508     }
 509     *picture= *(AVFrame*)&s->picture;
 510     *data_size = sizeof(AVPicture);
 511
 512     return buf_size;
 513 }
 514
 515 static av_cold int tiff_init(AVCodecContext *avctx){
 516     TiffContext *s = avctx->priv_data;
 517
 518     s->width = 0;
 519     s->height = 0;
 520     s->avctx = avctx;
 521     avcodec_get_frame_defaults((AVFrame*)&s->picture);
 522     avctx->coded_frame= (AVFrame*)&s->picture;
 523     ff_lzw_decode_open(&s->lzw);
 524     ff_ccitt_unpack_init();
 525
 526     return 0;
 527 }
 528
 529 static av_cold int tiff_end(AVCodecContext *avctx)
 530 {
 531     TiffContext * const s = avctx->priv_data;
 532
 533     ff_lzw_decode_close(&s->lzw);
 534     if(s->picture.data[0])
 535         avctx->release_buffer(avctx, &s->picture);
 536     return 0;
 537 }
 538
 539 AVCodec tiff_decoder = {
 540     "tiff",
 541     CODEC_TYPE_VIDEO,
 542     CODEC_ID_TIFF,
 543     sizeof(TiffContext),
 544     tiff_init,
 545     NULL,
 546     tiff_end,
 547     decode_frame,
 548     0,
 549     NULL,
 550     .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),
 551 };