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