2 * Copyright (c) 2006 Konstantin Shishkov
4 * This file is part of FFmpeg.
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.
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.
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
24 * @author Konstantin Shishkov
34 #include "libavutil/common.h"
35 #include "libavutil/intreadwrite.h"
36 #include "libavutil/imgutils.h"
38 typedef struct TiffContext {
39 AVCodecContext *avctx;
43 unsigned int bpp, bppcount;
44 uint32_t palette[256];
53 int strips, rps, sstype;
55 const uint8_t *stripdata;
56 const uint8_t *stripsizes;
57 int stripsize, stripoff;
61 static unsigned tget_short(const uint8_t **p, int le)
63 unsigned v = le ? AV_RL16(*p) : AV_RB16(*p);
68 static unsigned tget_long(const uint8_t **p, int le)
70 unsigned v = le ? AV_RL32(*p) : AV_RB32(*p);
75 static unsigned tget(const uint8_t **p, int type, int le)
78 case TIFF_BYTE : return *(*p)++;
79 case TIFF_SHORT: return tget_short(p, le);
80 case TIFF_LONG : return tget_long(p, le);
81 default : return UINT_MAX;
86 static int tiff_uncompress(uint8_t *dst, unsigned long *len, const uint8_t *src,
89 z_stream zstream = { 0 };
92 zstream.next_in = src;
93 zstream.avail_in = size;
94 zstream.next_out = dst;
95 zstream.avail_out = *len;
96 zret = inflateInit(&zstream);
98 av_log(NULL, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
101 zret = inflate(&zstream, Z_SYNC_FLUSH);
102 inflateEnd(&zstream);
103 *len = zstream.total_out;
104 return zret == Z_STREAM_END ? Z_OK : zret;
108 static void av_always_inline horizontal_fill(unsigned int bpp, uint8_t* dst,
109 int usePtr, const uint8_t *src,
110 uint8_t c, int width, int offset)
114 while (--width >= 0) {
115 dst[(width+offset)*8+7] = (usePtr ? src[width] : c) & 0x1;
116 dst[(width+offset)*8+6] = (usePtr ? src[width] : c) >> 1 & 0x1;
117 dst[(width+offset)*8+5] = (usePtr ? src[width] : c) >> 2 & 0x1;
118 dst[(width+offset)*8+4] = (usePtr ? src[width] : c) >> 3 & 0x1;
119 dst[(width+offset)*8+3] = (usePtr ? src[width] : c) >> 4 & 0x1;
120 dst[(width+offset)*8+2] = (usePtr ? src[width] : c) >> 5 & 0x1;
121 dst[(width+offset)*8+1] = (usePtr ? src[width] : c) >> 6 & 0x1;
122 dst[(width+offset)*8+0] = (usePtr ? src[width] : c) >> 7;
126 while (--width >= 0) {
127 dst[(width+offset)*4+3] = (usePtr ? src[width] : c) & 0x3;
128 dst[(width+offset)*4+2] = (usePtr ? src[width] : c) >> 2 & 0x3;
129 dst[(width+offset)*4+1] = (usePtr ? src[width] : c) >> 4 & 0x3;
130 dst[(width+offset)*4+0] = (usePtr ? src[width] : c) >> 6;
134 while (--width >= 0) {
135 dst[(width+offset)*2+1] = (usePtr ? src[width] : c) & 0xF;
136 dst[(width+offset)*2+0] = (usePtr ? src[width] : c) >> 4;
141 memcpy(dst + offset, src, width);
143 memset(dst + offset, c, width);
148 static int tiff_unpack_strip(TiffContext *s, uint8_t *dst, int stride,
149 const uint8_t *src, int size, int lines)
151 int c, line, pixels, code;
152 const uint8_t *ssrc = src;
153 int width = ((s->width * s->bpp) + 7) >> 3;
156 return AVERROR_INVALIDDATA;
159 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
161 unsigned long outlen;
163 outlen = width * lines;
164 zbuf = av_malloc(outlen);
166 return AVERROR(ENOMEM);
167 ret = tiff_uncompress(zbuf, &outlen, src, size);
169 av_log(s->avctx, AV_LOG_ERROR,
170 "Uncompressing failed (%lu of %lu) with error %d\n", outlen,
171 (unsigned long)width * lines, ret);
176 for (line = 0; line < lines; line++) {
177 if(s->bpp < 8 && s->avctx->pix_fmt == PIX_FMT_PAL8){
178 horizontal_fill(s->bpp, dst, 1, src, 0, width, 0);
180 memcpy(dst, src, width);
189 if (s->compr == TIFF_LZW) {
190 if (ff_lzw_decode_init(s->lzw, 8, src, size, FF_LZW_TIFF) < 0) {
191 av_log(s->avctx, AV_LOG_ERROR, "Error initializing LZW decoder\n");
195 if (s->compr == TIFF_CCITT_RLE || s->compr == TIFF_G3
196 || s->compr == TIFF_G4) {
198 uint8_t *src2 = av_malloc((unsigned)size +
199 FF_INPUT_BUFFER_PADDING_SIZE);
202 av_log(s->avctx, AV_LOG_ERROR,
203 "Error allocating temporary buffer\n");
204 return AVERROR(ENOMEM);
206 if (s->fax_opts & 2) {
207 av_log(s->avctx, AV_LOG_ERROR,
208 "Uncompressed fax mode is not supported (yet)\n");
212 if (!s->fill_order) {
213 memcpy(src2, src, size);
215 for (i = 0; i < size; i++)
216 src2[i] = av_reverse[src[i]];
218 memset(src2 + size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
223 ret = ff_ccitt_unpack(s->avctx, src2, size, dst, lines, stride,
224 s->compr, s->fax_opts);
227 if (s->bpp < 8 && s->avctx->pix_fmt == PIX_FMT_PAL8)
228 for (line = 0; line < lines; line++) {
229 horizontal_fill(s->bpp, dst, 1, dst, 0, width, 0);
235 for (line = 0; line < lines; line++) {
236 if (src - ssrc > size) {
237 av_log(s->avctx, AV_LOG_ERROR, "Source data overread\n");
242 if (ssrc + size - src < width)
243 return AVERROR_INVALIDDATA;
244 if (!s->fill_order) {
245 horizontal_fill(s->bpp * (s->avctx->pix_fmt == PIX_FMT_PAL8),
246 dst, 1, src, 0, width, 0);
249 for (i = 0; i < width; i++)
250 dst[i] = av_reverse[src[i]];
255 for (pixels = 0; pixels < width;) {
256 if (ssrc + size - src < 2) {
257 av_log(s->avctx, AV_LOG_ERROR, "Read went out of bounds\n");
258 return AVERROR_INVALIDDATA;
260 code = (int8_t) * src++;
263 if (pixels + code > width) {
264 av_log(s->avctx, AV_LOG_ERROR,
265 "Copy went out of bounds\n");
268 if (ssrc + size - src < code) {
269 av_log(s->avctx, AV_LOG_ERROR, "Read went out of bounds\n");
270 return AVERROR_INVALIDDATA;
272 horizontal_fill(s->bpp * (s->avctx->pix_fmt == PIX_FMT_PAL8),
273 dst, 1, src, 0, code, pixels);
276 } else if (code != -128) { // -127..-1
278 if (pixels + code > width) {
279 av_log(s->avctx, AV_LOG_ERROR,
280 "Run went out of bounds\n");
284 horizontal_fill(s->bpp * (s->avctx->pix_fmt == PIX_FMT_PAL8),
285 dst, 0, NULL, c, code, pixels);
291 pixels = ff_lzw_decode(s->lzw, dst, width);
292 if (pixels < width) {
293 av_log(s->avctx, AV_LOG_ERROR, "Decoded only %i bytes of %i\n",
297 if (s->bpp < 8 && s->avctx->pix_fmt == PIX_FMT_PAL8)
298 horizontal_fill(s->bpp, dst, 1, dst, 0, width, 0);
306 static int init_image(TiffContext *s)
311 switch (s->bpp * 10 + s->bppcount) {
313 if (!s->palette_is_set) {
314 s->avctx->pix_fmt = PIX_FMT_MONOBLACK;
320 s->avctx->pix_fmt = PIX_FMT_PAL8;
323 s->avctx->pix_fmt = PIX_FMT_RGB24;
326 s->avctx->pix_fmt = s->le ? PIX_FMT_GRAY16LE : PIX_FMT_GRAY16BE;
329 s->avctx->pix_fmt = PIX_FMT_GRAY8A;
332 s->avctx->pix_fmt = PIX_FMT_RGBA;
335 s->avctx->pix_fmt = s->le ? PIX_FMT_RGB48LE : PIX_FMT_RGB48BE;
338 s->avctx->pix_fmt = s->le ? PIX_FMT_RGBA64LE : PIX_FMT_RGBA64BE;
341 av_log(s->avctx, AV_LOG_ERROR,
342 "This format is not supported (bpp=%d, bppcount=%d)\n",
343 s->bpp, s->bppcount);
344 return AVERROR_INVALIDDATA;
346 if (s->width != s->avctx->width || s->height != s->avctx->height) {
347 if ((ret = av_image_check_size(s->width, s->height, 0, s->avctx)) < 0)
349 avcodec_set_dimensions(s->avctx, s->width, s->height);
351 if (s->picture.data[0])
352 s->avctx->release_buffer(s->avctx, &s->picture);
353 if ((ret = s->avctx->get_buffer(s->avctx, &s->picture)) < 0) {
354 av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
357 if (s->avctx->pix_fmt == PIX_FMT_PAL8) {
358 if (s->palette_is_set) {
359 memcpy(s->picture.data[1], s->palette, sizeof(s->palette));
361 /* make default grayscale pal */
362 pal = (uint32_t *) s->picture.data[1];
363 for (i = 0; i < 1<<s->bpp; i++)
364 pal[i] = 0xFF << 24 | i * 255 / ((1<<s->bpp) - 1) * 0x010101;
370 static int tiff_decode_tag(TiffContext *s, const uint8_t *start,
371 const uint8_t *buf, const uint8_t *end_buf)
373 unsigned tag, type, count, off, value = 0;
376 const uint8_t *rp, *gp, *bp;
378 if (end_buf - buf < 12)
380 tag = tget_short(&buf, s->le);
381 type = tget_short(&buf, s->le);
382 count = tget_long(&buf, s->le);
383 off = tget_long(&buf, s->le);
385 if (type == 0 || type >= FF_ARRAY_ELEMS(type_sizes)) {
386 av_log(s->avctx, AV_LOG_DEBUG, "Unknown tiff type (%u) encountered\n",
396 value = tget(&buf, type, s->le);
413 if (count <= 4 && type_sizes[type] * count <= 4) {
420 if (buf && (buf < start || buf > end_buf)) {
421 av_log(s->avctx, AV_LOG_ERROR,
422 "Tag referencing position outside the image\n");
436 av_log(s->avctx, AV_LOG_ERROR,
437 "This format is not supported (bpp=%d, %d components)\n",
446 s->bpp = (off & 0xFF) + ((off >> 8) & 0xFF) +
447 ((off >> 16) & 0xFF) + ((off >> 24) & 0xFF);
452 for (i = 0; i < count && buf < end_buf; i++)
453 s->bpp += tget(&buf, type, s->le);
460 case TIFF_SAMPLES_PER_PIXEL:
462 av_log(s->avctx, AV_LOG_ERROR,
463 "Samples per pixel requires a single value, many provided\n");
464 return AVERROR_INVALIDDATA;
466 if (s->bppcount == 1)
484 case TIFF_ADOBE_DEFLATE:
488 av_log(s->avctx, AV_LOG_ERROR, "Deflate: ZLib not compiled in\n");
493 av_log(s->avctx, AV_LOG_ERROR,
494 "JPEG compression is not supported\n");
497 av_log(s->avctx, AV_LOG_ERROR, "Unknown compression method %i\n",
502 case TIFF_ROWSPERSTRIP:
503 if (type == TIFF_LONG && value == UINT_MAX)
504 value = s->avctx->height;
506 av_log(s->avctx, AV_LOG_ERROR,
507 "Incorrect value of rows per strip\n");
512 case TIFF_STRIP_OFFS:
517 s->stripdata = start + off;
522 if (s->stripdata > end_buf) {
523 av_log(s->avctx, AV_LOG_ERROR,
524 "Tag referencing position outside the image\n");
528 case TIFF_STRIP_SIZE:
530 s->stripsizes = NULL;
531 s->stripsize = value;
534 s->stripsizes = start + off;
538 if (s->stripsizes > end_buf) {
539 av_log(s->avctx, AV_LOG_ERROR,
540 "Tag referencing position outside the image\n");
544 case TIFF_TILE_BYTE_COUNTS:
545 case TIFF_TILE_LENGTH:
546 case TIFF_TILE_OFFSETS:
547 case TIFF_TILE_WIDTH:
548 av_log(s->avctx, AV_LOG_ERROR, "Tiled images are not supported\n");
549 return AVERROR_PATCHWELCOME;
552 s->predictor = value;
566 av_log(s->avctx, AV_LOG_ERROR, "Color mode %d is not supported\n",
571 case TIFF_FILL_ORDER:
572 if (value < 1 || value > 2) {
573 av_log(s->avctx, AV_LOG_ERROR,
574 "Unknown FillOrder value %d, trying default one\n", value);
577 s->fill_order = value - 1;
580 pal = (uint32_t *) s->palette;
581 off = type_sizes[type];
582 if (count / 3 > 256 || end_buf - buf < count / 3 * off * 3)
585 gp = buf + count / 3 * off;
586 bp = buf + count / 3 * off * 2;
587 off = (type_sizes[type] - 1) << 3;
588 for (i = 0; i < count / 3; i++) {
590 j |= (tget(&rp, type, s->le) >> off) << 16;
591 j |= (tget(&gp, type, s->le) >> off) << 8;
592 j |= tget(&bp, type, s->le) >> off;
595 s->palette_is_set = 1;
599 av_log(s->avctx, AV_LOG_ERROR, "Planar format is not supported\n");
604 if (s->compr == TIFF_G3)
608 if (s->compr == TIFF_G4)
612 av_log(s->avctx, AV_LOG_DEBUG, "Unknown or unsupported tag %d/0X%0X\n",
618 static int decode_frame(AVCodecContext *avctx,
619 void *data, int *data_size, AVPacket *avpkt)
621 const uint8_t *buf = avpkt->data;
622 int buf_size = avpkt->size;
623 TiffContext *const s = avctx->priv_data;
624 AVFrame *picture = data;
625 AVFrame *const p = &s->picture;
626 const uint8_t *orig_buf = buf, *end_buf = buf + buf_size;
631 unsigned soff, ssize;
635 if (end_buf - buf < 8)
636 return AVERROR_INVALIDDATA;
641 else if (id == 0x4D4D)
644 av_log(avctx, AV_LOG_ERROR, "TIFF header not found\n");
651 // As TIFF 6.0 specification puts it "An arbitrary but carefully chosen number
652 // that further identifies the file as a TIFF file"
653 if (tget_short(&buf, le) != 42) {
654 av_log(avctx, AV_LOG_ERROR,
655 "The answer to life, universe and everything is not correct!\n");
658 // Reset these pointers so we can tell if they were set this frame
659 s->stripsizes = s->stripdata = NULL;
660 /* parse image file directory */
661 off = tget_long(&buf, le);
662 if (off >= UINT_MAX - 14 || end_buf - orig_buf < off + 14) {
663 av_log(avctx, AV_LOG_ERROR, "IFD offset is greater than image size\n");
664 return AVERROR_INVALIDDATA;
666 buf = orig_buf + off;
667 entries = tget_short(&buf, le);
668 for (i = 0; i < entries; i++) {
669 if (tiff_decode_tag(s, orig_buf, buf, end_buf) < 0)
673 if (!s->stripdata && !s->stripoff) {
674 av_log(avctx, AV_LOG_ERROR, "Image data is missing\n");
677 /* now we have the data and may start decoding */
678 if ((ret = init_image(s)) < 0)
681 if (s->strips == 1 && !s->stripsize) {
682 av_log(avctx, AV_LOG_WARNING, "Image data size missing\n");
683 s->stripsize = buf_size - s->stripoff;
685 stride = p->linesize[0];
687 for (i = 0; i < s->height; i += s->rps) {
689 if (s->stripsizes >= end_buf)
690 return AVERROR_INVALIDDATA;
691 ssize = tget(&s->stripsizes, s->sstype, s->le);
693 ssize = s->stripsize;
696 if (s->stripdata >= end_buf)
697 return AVERROR_INVALIDDATA;
698 soff = tget(&s->stripdata, s->sot, s->le);
702 if (soff > buf_size || ssize > buf_size - soff) {
703 av_log(avctx, AV_LOG_ERROR, "Invalid strip size/offset\n");
706 if (tiff_unpack_strip(s, dst, stride, orig_buf + soff, ssize,
707 FFMIN(s->rps, s->height - i)) < 0)
709 dst += s->rps * stride;
711 if (s->predictor == 2) {
714 ssize = s->width * soff;
715 if (s->avctx->pix_fmt == PIX_FMT_RGB48LE ||
716 s->avctx->pix_fmt == PIX_FMT_RGBA64LE) {
717 for (i = 0; i < s->height; i++) {
718 for (j = soff; j < ssize; j += 2)
719 AV_WL16(dst + j, AV_RL16(dst + j) + AV_RL16(dst + j - soff));
722 } else if (s->avctx->pix_fmt == PIX_FMT_RGB48BE ||
723 s->avctx->pix_fmt == PIX_FMT_RGBA64BE) {
724 for (i = 0; i < s->height; i++) {
725 for (j = soff; j < ssize; j += 2)
726 AV_WB16(dst + j, AV_RB16(dst + j) + AV_RB16(dst + j - soff));
730 for (i = 0; i < s->height; i++) {
731 for (j = soff; j < ssize; j++)
732 dst[j] += dst[j - soff];
739 dst = s->picture.data[0];
740 for (i = 0; i < s->height; i++) {
741 for (j = 0; j < s->picture.linesize[0]; j++)
742 dst[j] = (s->avctx->pix_fmt == PIX_FMT_PAL8 ? (1<<s->bpp) - 1 : 255) - dst[j];
743 dst += s->picture.linesize[0];
746 *picture = s->picture;
747 *data_size = sizeof(AVPicture);
752 static av_cold int tiff_init(AVCodecContext *avctx)
754 TiffContext *s = avctx->priv_data;
759 avcodec_get_frame_defaults(&s->picture);
760 avctx->coded_frame = &s->picture;
761 ff_lzw_decode_open(&s->lzw);
762 ff_ccitt_unpack_init();
767 static av_cold int tiff_end(AVCodecContext *avctx)
769 TiffContext *const s = avctx->priv_data;
771 ff_lzw_decode_close(&s->lzw);
772 if (s->picture.data[0])
773 avctx->release_buffer(avctx, &s->picture);
777 AVCodec ff_tiff_decoder = {
779 .type = AVMEDIA_TYPE_VIDEO,
781 .priv_data_size = sizeof(TiffContext),
784 .decode = decode_frame,
785 .capabilities = CODEC_CAP_DR1,
786 .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),