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