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