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