3 * Copyright (c) 2006 Konstantin Shishkov
5 * This file is part of Libav.
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.
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.
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
25 * @author Konstantin Shishkov
33 #include "libavutil/attributes.h"
34 #include "libavutil/intreadwrite.h"
35 #include "libavutil/imgutils.h"
37 #include "bytestream.h"
44 typedef struct TiffContext {
45 AVCodecContext *avctx;
49 unsigned int bpp, bppcount;
50 uint32_t palette[256];
54 enum TiffPhotometric photometric;
60 int strips, rps, sstype;
62 int stripsizesoff, stripsize, stripoff, strippos;
66 static unsigned tget_short(GetByteContext *gb, int le)
68 return le ? bytestream2_get_le16(gb) : bytestream2_get_be16(gb);
71 static unsigned tget_long(GetByteContext *gb, int le)
73 return le ? bytestream2_get_le32(gb) : bytestream2_get_be32(gb);
76 static unsigned tget(GetByteContext *gb, int type, int le)
79 case TIFF_BYTE: return bytestream2_get_byte(gb);
80 case TIFF_SHORT: return tget_short(gb, le);
81 case TIFF_LONG: return tget_long(gb, le);
82 default: return UINT_MAX;
87 static int tiff_uncompress(uint8_t *dst, unsigned long *len, const uint8_t *src,
90 z_stream zstream = { 0 };
93 zstream.next_in = src;
94 zstream.avail_in = size;
95 zstream.next_out = dst;
96 zstream.avail_out = *len;
97 zret = inflateInit(&zstream);
99 av_log(NULL, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
102 zret = inflate(&zstream, Z_SYNC_FLUSH);
103 inflateEnd(&zstream);
104 *len = zstream.total_out;
105 return zret == Z_STREAM_END ? Z_OK : zret;
108 static int tiff_unpack_zlib(TiffContext *s, uint8_t *dst, int stride,
109 const uint8_t *src, int size,
110 int width, int lines)
113 unsigned long outlen;
115 outlen = width * lines;
116 zbuf = av_malloc(outlen);
118 return AVERROR(ENOMEM);
119 ret = tiff_uncompress(zbuf, &outlen, src, size);
121 av_log(s->avctx, AV_LOG_ERROR,
122 "Uncompressing failed (%lu of %lu) with error %d\n", outlen,
123 (unsigned long)width * lines, ret);
125 return AVERROR_UNKNOWN;
128 for (line = 0; line < lines; line++) {
129 memcpy(dst, src, width);
139 static int tiff_unpack_fax(TiffContext *s, uint8_t *dst, int stride,
140 const uint8_t *src, int size, int lines)
143 uint8_t *src2 = av_malloc((unsigned)size +
144 AV_INPUT_BUFFER_PADDING_SIZE);
147 av_log(s->avctx, AV_LOG_ERROR,
148 "Error allocating temporary buffer\n");
149 return AVERROR(ENOMEM);
151 if (s->fax_opts & 2) {
152 avpriv_request_sample(s->avctx, "Uncompressed fax mode");
154 return AVERROR_PATCHWELCOME;
156 if (!s->fill_order) {
157 memcpy(src2, src, size);
159 for (i = 0; i < size; i++)
160 src2[i] = ff_reverse[src[i]];
162 memset(src2 + size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
163 ret = ff_ccitt_unpack(s->avctx, src2, size, dst, lines, stride,
164 s->compr, s->fax_opts);
169 static int tiff_unpack_strip(TiffContext *s, uint8_t *dst, int stride,
170 const uint8_t *src, int size, int lines)
173 int c, line, pixels, code, ret;
174 int width = ((s->width * s->bpp) + 7) >> 3;
177 width /= s->bppcount;
180 return AVERROR_INVALIDDATA;
182 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
184 return tiff_unpack_zlib(s, dst, stride, src, size, width, lines);
186 av_log(s->avctx, AV_LOG_ERROR,
187 "zlib support not enabled, "
188 "deflate compression not supported\n");
189 return AVERROR(ENOSYS);
192 if (s->compr == TIFF_LZW) {
193 if ((ret = ff_lzw_decode_init(s->lzw, 8, src, size, FF_LZW_TIFF)) < 0) {
194 av_log(s->avctx, AV_LOG_ERROR, "Error initializing LZW decoder\n");
197 for (line = 0; line < lines; line++) {
198 pixels = ff_lzw_decode(s->lzw, dst, width);
199 if (pixels < width) {
200 av_log(s->avctx, AV_LOG_ERROR, "Decoded only %i bytes of %i\n",
202 return AVERROR_INVALIDDATA;
208 if (s->compr == TIFF_CCITT_RLE ||
209 s->compr == TIFF_G3 ||
210 s->compr == TIFF_G4) {
211 return tiff_unpack_fax(s, dst, stride, src, size, lines);
214 bytestream2_init(&s->gb, src, size);
215 bytestream2_init_writer(&pb, dst, stride * lines);
217 for (line = 0; line < lines; line++) {
218 if (bytestream2_get_bytes_left(&s->gb) == 0 || bytestream2_get_eof(&pb))
220 bytestream2_seek_p(&pb, stride * line, SEEK_SET);
223 if (!s->fill_order) {
224 bytestream2_copy_buffer(&pb, &s->gb, width);
227 for (i = 0; i < width; i++)
228 bytestream2_put_byte(&pb, ff_reverse[bytestream2_get_byte(&s->gb)]);
232 for (pixels = 0; pixels < width;) {
233 code = ff_u8_to_s8(bytestream2_get_byte(&s->gb));
236 bytestream2_copy_buffer(&pb, &s->gb, code);
238 } else if (code != -128) { // -127..-1
240 c = bytestream2_get_byte(&s->gb);
241 bytestream2_set_buffer(&pb, c, code);
251 static int init_image(TiffContext *s, AVFrame *frame)
255 // make sure there is no aliasing in the following switch
256 if (s->bpp >= 100 || s->bppcount >= 10) {
257 av_log(s->avctx, AV_LOG_ERROR,
258 "Unsupported image parameters: bpp=%d, bppcount=%d\n",
259 s->bpp, s->bppcount);
260 return AVERROR_INVALIDDATA;
263 switch (s->planar * 1000 + s->bpp * 10 + s->bppcount) {
265 s->avctx->pix_fmt = AV_PIX_FMT_MONOBLACK;
268 s->avctx->pix_fmt = s->palette_is_set ? AV_PIX_FMT_PAL8 : AV_PIX_FMT_GRAY8;
271 s->avctx->pix_fmt = AV_PIX_FMT_RGB24;
274 s->avctx->pix_fmt = s->le ? AV_PIX_FMT_GRAY16LE : AV_PIX_FMT_GRAY16BE;
277 s->avctx->pix_fmt = AV_PIX_FMT_YA8;
280 s->avctx->pix_fmt = s->le ? AV_PIX_FMT_YA16LE : AV_PIX_FMT_YA16BE;
283 s->avctx->pix_fmt = AV_PIX_FMT_RGBA;
286 s->avctx->pix_fmt = s->le ? AV_PIX_FMT_RGB48LE : AV_PIX_FMT_RGB48BE;
289 s->avctx->pix_fmt = s->le ? AV_PIX_FMT_RGBA64LE : AV_PIX_FMT_RGBA64BE;
292 s->avctx->pix_fmt = AV_PIX_FMT_GBRP;
295 s->avctx->pix_fmt = AV_PIX_FMT_GBRAP;
298 s->avctx->pix_fmt = s->le ? AV_PIX_FMT_GBRP16LE : AV_PIX_FMT_GBRP16BE;
301 s->avctx->pix_fmt = s->le ? AV_PIX_FMT_GBRAP16LE : AV_PIX_FMT_GBRAP16BE;
304 av_log(s->avctx, AV_LOG_ERROR,
305 "This format is not supported (bpp=%d, bppcount=%d)\n",
306 s->bpp, s->bppcount);
307 return AVERROR_INVALIDDATA;
309 if (s->width != s->avctx->width || s->height != s->avctx->height) {
310 ret = ff_set_dimensions(s->avctx, s->width, s->height);
314 if ((ret = ff_get_buffer(s->avctx, frame, 0)) < 0) {
315 av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
318 if (s->avctx->pix_fmt == AV_PIX_FMT_PAL8) {
319 memcpy(frame->data[1], s->palette, sizeof(s->palette));
324 static int tiff_decode_tag(TiffContext *s)
326 unsigned tag, type, count, off, value = 0;
329 if (bytestream2_get_bytes_left(&s->gb) < 12)
330 return AVERROR_INVALIDDATA;
331 tag = tget_short(&s->gb, s->le);
332 type = tget_short(&s->gb, s->le);
333 count = tget_long(&s->gb, s->le);
334 off = tget_long(&s->gb, s->le);
335 start = bytestream2_tell(&s->gb);
337 if (type == 0 || type >= FF_ARRAY_ELEMS(type_sizes)) {
338 av_log(s->avctx, AV_LOG_DEBUG, "Unknown tiff type (%u) encountered\n",
347 bytestream2_seek(&s->gb, -4, SEEK_CUR);
348 value = tget(&s->gb, type, s->le);
355 bytestream2_seek(&s->gb, -4, SEEK_CUR);
360 bytestream2_seek(&s->gb, off, SEEK_SET);
363 if (count <= 4 && type_sizes[type] * count <= 4)
364 bytestream2_seek(&s->gb, -4, SEEK_CUR);
366 bytestream2_seek(&s->gb, off, SEEK_SET);
379 av_log(s->avctx, AV_LOG_ERROR,
380 "This format is not supported (bpp=%d, %d components)\n",
382 return AVERROR_INVALIDDATA;
389 s->bpp = (off & 0xFF) + ((off >> 8) & 0xFF) +
390 ((off >> 16) & 0xFF) + ((off >> 24) & 0xFF);
395 for (i = 0; i < count; i++)
396 s->bpp += tget(&s->gb, type, s->le);
403 case TIFF_SAMPLES_PER_PIXEL:
405 av_log(s->avctx, AV_LOG_ERROR,
406 "Samples per pixel requires a single value, many provided\n");
407 return AVERROR_INVALIDDATA;
409 if (s->bppcount == 1)
427 case TIFF_ADOBE_DEFLATE:
431 av_log(s->avctx, AV_LOG_ERROR, "Deflate: ZLib not compiled in\n");
432 return AVERROR(ENOSYS);
436 avpriv_report_missing_feature(s->avctx, "JPEG compression");
437 return AVERROR_PATCHWELCOME;
439 avpriv_report_missing_feature(s->avctx, "LZMA compression");
440 return AVERROR_PATCHWELCOME;
442 av_log(s->avctx, AV_LOG_ERROR, "Unknown compression method %i\n",
444 return AVERROR_INVALIDDATA;
447 case TIFF_ROWSPERSTRIP:
448 if (!value || (type == TIFF_LONG && value == UINT_MAX))
450 s->rps = FFMIN(value, s->height);
452 case TIFF_STRIP_OFFS:
463 case TIFF_STRIP_SIZE:
465 s->stripsizesoff = 0;
466 s->stripsize = value;
469 s->stripsizesoff = off;
475 s->predictor = value;
477 case TIFF_PHOTOMETRIC:
479 case TIFF_PHOTOMETRIC_WHITE_IS_ZERO:
480 case TIFF_PHOTOMETRIC_BLACK_IS_ZERO:
481 case TIFF_PHOTOMETRIC_RGB:
482 case TIFF_PHOTOMETRIC_PALETTE:
483 s->photometric = value;
485 case TIFF_PHOTOMETRIC_ALPHA_MASK:
486 case TIFF_PHOTOMETRIC_SEPARATED:
487 case TIFF_PHOTOMETRIC_YCBCR:
488 case TIFF_PHOTOMETRIC_CIE_LAB:
489 case TIFF_PHOTOMETRIC_ICC_LAB:
490 case TIFF_PHOTOMETRIC_ITU_LAB:
491 case TIFF_PHOTOMETRIC_CFA:
492 case TIFF_PHOTOMETRIC_LOG_L:
493 case TIFF_PHOTOMETRIC_LOG_LUV:
494 case TIFF_PHOTOMETRIC_LINEAR_RAW:
495 avpriv_report_missing_feature(s->avctx,
496 "PhotometricInterpretation 0x%04X",
498 return AVERROR_PATCHWELCOME;
500 av_log(s->avctx, AV_LOG_ERROR, "PhotometricInterpretation %u is "
502 return AVERROR_INVALIDDATA;
505 case TIFF_FILL_ORDER:
506 if (value < 1 || value > 2) {
507 av_log(s->avctx, AV_LOG_ERROR,
508 "Unknown FillOrder value %d, trying default one\n", value);
511 s->fill_order = value - 1;
514 GetByteContext pal_gb[3];
515 off = type_sizes[type];
516 if (count / 3 > 256 ||
517 bytestream2_get_bytes_left(&s->gb) < count / 3 * off * 3)
518 return AVERROR_INVALIDDATA;
519 pal_gb[0] = pal_gb[1] = pal_gb[2] = s->gb;
520 bytestream2_skip(&pal_gb[1], count / 3 * off);
521 bytestream2_skip(&pal_gb[2], count / 3 * off * 2);
522 off = (type_sizes[type] - 1) << 3;
523 for (i = 0; i < count / 3; i++) {
524 uint32_t p = 0xFF000000;
525 p |= (tget(&pal_gb[0], type, s->le) >> off) << 16;
526 p |= (tget(&pal_gb[1], type, s->le) >> off) << 8;
527 p |= tget(&pal_gb[2], type, s->le) >> off;
530 s->palette_is_set = 1;
534 s->planar = value == 2;
537 if (s->compr == TIFF_G3)
541 if (s->compr == TIFF_G4)
545 if (s->avctx->err_recognition & AV_EF_EXPLODE) {
546 av_log(s->avctx, AV_LOG_ERROR,
547 "Unknown or unsupported tag %d/0X%0X\n",
549 return AVERROR_INVALIDDATA;
552 bytestream2_seek(&s->gb, start, SEEK_SET);
556 static int decode_frame(AVCodecContext *avctx,
557 void *data, int *got_frame, AVPacket *avpkt)
559 TiffContext *const s = avctx->priv_data;
560 AVFrame *const p = data;
562 int id, le, ret, plane, planes;
563 int i, j, entries, stride;
564 unsigned soff, ssize;
566 GetByteContext stripsizes;
567 GetByteContext stripdata;
569 bytestream2_init(&s->gb, avpkt->data, avpkt->size);
571 // parse image header
573 return AVERROR_INVALIDDATA;
574 id = bytestream2_get_le16(&s->gb);
577 else if (id == 0x4D4D)
580 av_log(avctx, AV_LOG_ERROR, "TIFF header not found\n");
581 return AVERROR_INVALIDDATA;
584 s->photometric = TIFF_PHOTOMETRIC_NONE;
587 // As TIFF 6.0 specification puts it "An arbitrary but carefully chosen number
588 // that further identifies the file as a TIFF file"
589 if (tget_short(&s->gb, le) != 42) {
590 av_log(avctx, AV_LOG_ERROR,
591 "The answer to life, universe and everything is not correct!\n");
592 return AVERROR_INVALIDDATA;
594 // Reset these offsets so we can tell if they were set this frame
595 s->stripsizesoff = s->strippos = 0;
596 /* parse image file directory */
597 off = tget_long(&s->gb, le);
598 if (off >= UINT_MAX - 14 || avpkt->size < off + 14) {
599 av_log(avctx, AV_LOG_ERROR, "IFD offset is greater than image size\n");
600 return AVERROR_INVALIDDATA;
602 bytestream2_seek(&s->gb, off, SEEK_SET);
603 entries = tget_short(&s->gb, le);
604 for (i = 0; i < entries; i++) {
605 if ((ret = tiff_decode_tag(s)) < 0)
608 if (!s->strippos && !s->stripoff) {
609 av_log(avctx, AV_LOG_ERROR, "Image data is missing\n");
610 return AVERROR_INVALIDDATA;
612 /* now we have the data and may start decoding */
613 if ((ret = init_image(s, p)) < 0)
616 if (s->strips == 1 && !s->stripsize) {
617 av_log(avctx, AV_LOG_WARNING, "Image data size missing\n");
618 s->stripsize = avpkt->size - s->stripoff;
621 if (s->stripsizesoff) {
622 if (s->stripsizesoff >= avpkt->size)
623 return AVERROR_INVALIDDATA;
624 bytestream2_init(&stripsizes, avpkt->data + s->stripsizesoff,
625 avpkt->size - s->stripsizesoff);
628 if (s->strippos >= avpkt->size)
629 return AVERROR_INVALIDDATA;
630 bytestream2_init(&stripdata, avpkt->data + s->strippos,
631 avpkt->size - s->strippos);
634 planes = s->planar ? s->bppcount : 1;
635 for (plane = 0; plane < planes; plane++) {
636 stride = p->linesize[plane];
637 dst = p->data[plane];
638 for (i = 0; i < s->height; i += s->rps) {
639 if (s->stripsizesoff)
640 ssize = tget(&stripsizes, s->sstype, le);
642 ssize = s->stripsize;
645 soff = tget(&stripdata, s->sot, le);
649 if (soff > avpkt->size || ssize > avpkt->size - soff) {
650 av_log(avctx, AV_LOG_ERROR, "Invalid strip size/offset\n");
651 return AVERROR_INVALIDDATA;
653 if ((ret = tiff_unpack_strip(s, dst, stride, avpkt->data + soff, ssize,
654 FFMIN(s->rps, s->height - i))) < 0) {
655 if (avctx->err_recognition & AV_EF_EXPLODE)
659 dst += s->rps * stride;
661 if (s->predictor == 2) {
662 dst = p->data[plane];
664 ssize = s->width * soff;
665 if (s->avctx->pix_fmt == AV_PIX_FMT_RGB48LE ||
666 s->avctx->pix_fmt == AV_PIX_FMT_RGBA64LE) {
667 for (i = 0; i < s->height; i++) {
668 for (j = soff; j < ssize; j += 2)
669 AV_WL16(dst + j, AV_RL16(dst + j) + AV_RL16(dst + j - soff));
672 } else if (s->avctx->pix_fmt == AV_PIX_FMT_RGB48BE ||
673 s->avctx->pix_fmt == AV_PIX_FMT_RGBA64BE) {
674 for (i = 0; i < s->height; i++) {
675 for (j = soff; j < ssize; j += 2)
676 AV_WB16(dst + j, AV_RB16(dst + j) + AV_RB16(dst + j - soff));
680 for (i = 0; i < s->height; i++) {
681 for (j = soff; j < ssize; j++)
682 dst[j] += dst[j - soff];
688 if (s->photometric == TIFF_PHOTOMETRIC_WHITE_IS_ZERO) {
689 dst = p->data[plane];
690 for (i = 0; i < s->height; i++) {
691 for (j = 0; j < stride; j++)
692 dst[j] = 255 - dst[j];
698 if (s->planar && s->bppcount > 2) {
699 FFSWAP(uint8_t*, p->data[0], p->data[2]);
700 FFSWAP(int, p->linesize[0], p->linesize[2]);
701 FFSWAP(uint8_t*, p->data[0], p->data[1]);
702 FFSWAP(int, p->linesize[0], p->linesize[1]);
710 static av_cold int tiff_init(AVCodecContext *avctx)
712 TiffContext *s = avctx->priv_data;
717 ff_lzw_decode_open(&s->lzw);
718 ff_ccitt_unpack_init();
723 static av_cold int tiff_end(AVCodecContext *avctx)
725 TiffContext *const s = avctx->priv_data;
727 ff_lzw_decode_close(&s->lzw);
731 AVCodec ff_tiff_decoder = {
733 .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),
734 .type = AVMEDIA_TYPE_VIDEO,
735 .id = AV_CODEC_ID_TIFF,
736 .priv_data_size = sizeof(TiffContext),
739 .decode = decode_frame,
740 .capabilities = AV_CODEC_CAP_DR1,