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 int tget_short(const uint8_t **p, int le){
62 int v = le ? AV_RL16(*p) : AV_RB16(*p);
67 static int tget_long(const uint8_t **p, int le){
68 int v = le ? AV_RL32(*p) : AV_RB32(*p);
73 static int tget(const uint8_t **p, int type, int le){
75 case TIFF_BYTE : return *(*p)++;
76 case TIFF_SHORT: return tget_short(p, le);
77 case TIFF_LONG : return tget_long (p, le);
83 static int tiff_uncompress(uint8_t *dst, unsigned long *len, const uint8_t *src, int size)
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);
95 av_log(NULL, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
98 zret = inflate(&zstream, Z_SYNC_FLUSH);
100 *len = zstream.total_out;
101 return zret == Z_STREAM_END ? Z_OK : zret;
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)
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;
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;
125 memcpy(dst + offset, src, width);
127 memset(dst + offset, c, width);
132 static void av_always_inline split_nibbles(uint8_t *dst, const uint8_t *src,
135 while (--width >= 0) {
136 // src == dst for LZW
137 dst[width * 2 + 1] = src[width] & 0xF;
138 dst[width * 2 + 0] = src[width] >> 4;
142 static int tiff_unpack_strip(TiffContext *s, uint8_t* dst, int stride, const uint8_t *src, int size, int lines){
143 int c, line, pixels, code;
144 const uint8_t *ssrc = src;
145 int width = ((s->width * s->bpp) + 7) >> 3;
147 uint8_t *zbuf; unsigned long outlen;
149 if(s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE){
151 outlen = width * lines;
152 zbuf = av_malloc(outlen);
153 ret = tiff_uncompress(zbuf, &outlen, src, size);
155 av_log(s->avctx, AV_LOG_ERROR, "Uncompressing failed (%lu of %lu) with error %d\n", outlen, (unsigned long)width * lines, ret);
160 for(line = 0; line < lines; line++){
162 split_nibbles(dst, src, width);
164 memcpy(dst, src, width);
173 if(s->compr == TIFF_LZW){
174 if(ff_lzw_decode_init(s->lzw, 8, src, size, FF_LZW_TIFF) < 0){
175 av_log(s->avctx, AV_LOG_ERROR, "Error initializing LZW decoder\n");
179 if(s->compr == TIFF_CCITT_RLE || s->compr == TIFF_G3 || s->compr == TIFF_G4){
181 uint8_t *src2 = av_malloc(size + FF_INPUT_BUFFER_PADDING_SIZE);
183 if(!src2 || (unsigned)size + FF_INPUT_BUFFER_PADDING_SIZE < (unsigned)size){
184 av_log(s->avctx, AV_LOG_ERROR, "Error allocating temporary buffer\n");
188 av_log(s->avctx, AV_LOG_ERROR, "Uncompressed fax mode is not supported (yet)\n");
193 memcpy(src2, src, size);
195 for(i = 0; i < size; i++)
196 src2[i] = av_reverse[src[i]];
198 memset(src2+size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
203 ret = ff_ccitt_unpack(s->avctx, src2, size, dst, lines, stride, s->compr, s->fax_opts);
209 for(line = 0; line < lines; line++){
210 if(src - ssrc > size){
211 av_log(s->avctx, AV_LOG_ERROR, "Source data overread\n");
216 if (ssrc + size - src < width)
217 return AVERROR_INVALIDDATA;
218 if (!s->fill_order) {
219 horizontal_fill(s->bpp, dst, 1, src, 0, width, 0);
222 for (i = 0; i < width; i++)
223 dst[i] = av_reverse[src[i]];
228 for(pixels = 0; pixels < width;){
229 code = (int8_t)*src++;
232 if(pixels + code > width){
233 av_log(s->avctx, AV_LOG_ERROR, "Copy went out of bounds\n");
236 horizontal_fill(s->bpp, dst, 1, src, 0, code, pixels);
239 }else if(code != -128){ // -127..-1
241 if(pixels + code > width){
242 av_log(s->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
246 horizontal_fill(s->bpp, dst, 0, NULL, c, code, pixels);
252 pixels = ff_lzw_decode(s->lzw, dst, width);
254 av_log(s->avctx, AV_LOG_ERROR, "Decoded only %i bytes of %i\n", pixels, width);
258 split_nibbles(dst, dst, width);
266 static int init_image(TiffContext *s)
271 switch (s->bpp * 10 + s->bppcount) {
273 s->avctx->pix_fmt = PIX_FMT_MONOBLACK;
278 s->avctx->pix_fmt = PIX_FMT_PAL8;
281 s->avctx->pix_fmt = PIX_FMT_RGB24;
284 s->avctx->pix_fmt = PIX_FMT_GRAY16BE;
287 s->avctx->pix_fmt = PIX_FMT_RGBA;
290 s->avctx->pix_fmt = s->le ? PIX_FMT_RGB48LE : PIX_FMT_RGB48BE;
293 av_log(s->avctx, AV_LOG_ERROR,
294 "This format is not supported (bpp=%d, bppcount=%d)\n",
295 s->bpp, s->bppcount);
296 return AVERROR_INVALIDDATA;
298 if (s->width != s->avctx->width || s->height != s->avctx->height) {
299 if ((ret = av_image_check_size(s->width, s->height, 0, s->avctx)) < 0)
301 avcodec_set_dimensions(s->avctx, s->width, s->height);
303 if (s->picture.data[0])
304 s->avctx->release_buffer(s->avctx, &s->picture);
305 if ((ret = s->avctx->get_buffer(s->avctx, &s->picture)) < 0) {
306 av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
309 if (s->avctx->pix_fmt == PIX_FMT_PAL8) {
310 if (s->palette_is_set) {
311 memcpy(s->picture.data[1], s->palette, sizeof(s->palette));
313 /* make default grayscale pal */
314 pal = (uint32_t *) s->picture.data[1];
315 for (i = 0; i < 1<<s->bpp; i++)
316 pal[i] = 0xFF << 24 | i * 255 / ((1<<s->bpp) - 1) * 0x010101;
322 static int tiff_decode_tag(TiffContext *s, const uint8_t *start, const uint8_t *buf, const uint8_t *end_buf)
324 int tag, type, count, off, value = 0;
327 const uint8_t *rp, *gp, *bp;
329 if (end_buf - buf < 12)
331 tag = tget_short(&buf, s->le);
332 type = tget_short(&buf, s->le);
333 count = tget_long(&buf, s->le);
334 off = tget_long(&buf, s->le);
341 value = tget(&buf, type, s->le);
357 }else if(type_sizes[type] * count <= 4){
363 if(buf && (buf < start || buf > end_buf)){
364 av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
378 av_log(s->avctx, AV_LOG_ERROR, "This format is not supported (bpp=%d, %d components)\n", s->bpp, count);
381 if(count == 1) s->bpp = value;
385 s->bpp = (off & 0xFF) + ((off >> 8) & 0xFF) + ((off >> 16) & 0xFF) + ((off >> 24) & 0xFF);
390 for(i = 0; i < count && buf < end_buf; i++) s->bpp += tget(&buf, type, s->le);
397 case TIFF_SAMPLES_PER_PIXEL:
399 av_log(s->avctx, AV_LOG_ERROR,
400 "Samples per pixel requires a single value, many provided\n");
401 return AVERROR_INVALIDDATA;
403 if (s->bppcount == 1)
421 case TIFF_ADOBE_DEFLATE:
425 av_log(s->avctx, AV_LOG_ERROR, "Deflate: ZLib not compiled in\n");
430 av_log(s->avctx, AV_LOG_ERROR, "JPEG compression is not supported\n");
433 av_log(s->avctx, AV_LOG_ERROR, "Unknown compression method %i\n", s->compr);
437 case TIFF_ROWSPERSTRIP:
438 if(type == TIFF_LONG && value == -1)
439 value = s->avctx->height;
441 av_log(s->avctx, AV_LOG_ERROR, "Incorrect value of rows per strip\n");
446 case TIFF_STRIP_OFFS:
451 s->stripdata = start + off;
453 if(s->strips == 1) s->rps = s->height;
455 if(s->stripdata > end_buf){
456 av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
460 case TIFF_STRIP_SIZE:
462 s->stripsizes = NULL;
463 s->stripsize = value;
466 s->stripsizes = start + off;
470 if(s->stripsizes > end_buf){
471 av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
476 s->predictor = value;
490 av_log(s->avctx, AV_LOG_ERROR, "Color mode %d is not supported\n", value);
494 case TIFF_FILL_ORDER:
495 if(value < 1 || value > 2){
496 av_log(s->avctx, AV_LOG_ERROR, "Unknown FillOrder value %d, trying default one\n", value);
499 s->fill_order = value - 1;
502 pal = (uint32_t *) s->palette;
503 off = type_sizes[type];
504 if (count / 3 > 256 || end_buf - buf < count / 3 * off * 3)
507 gp = buf + count / 3 * off;
508 bp = buf + count / 3 * off * 2;
509 off = (type_sizes[type] - 1) << 3;
510 for(i = 0; i < count / 3; i++){
512 j |= (tget(&rp, type, s->le) >> off) << 16;
513 j |= (tget(&gp, type, s->le) >> off) << 8;
514 j |= tget(&bp, type, s->le) >> off;
517 s->palette_is_set = 1;
521 av_log(s->avctx, AV_LOG_ERROR, "Planar format is not supported\n");
526 if(s->compr == TIFF_G3)
530 if(s->compr == TIFF_G4)
534 av_log(s->avctx, AV_LOG_DEBUG, "Unknown or unsupported tag %d/0X%0X\n", tag, tag);
539 static int decode_frame(AVCodecContext *avctx,
540 void *data, int *data_size,
543 const uint8_t *buf = avpkt->data;
544 int buf_size = avpkt->size;
545 TiffContext * const s = avctx->priv_data;
546 AVFrame *picture = data;
547 AVFrame * const p= (AVFrame*)&s->picture;
548 const uint8_t *orig_buf = buf, *end_buf = buf + buf_size;
553 unsigned soff, ssize;
557 if (end_buf - buf < 8)
558 return AVERROR_INVALIDDATA;
559 id = AV_RL16(buf); buf += 2;
560 if(id == 0x4949) le = 1;
561 else if(id == 0x4D4D) le = 0;
563 av_log(avctx, AV_LOG_ERROR, "TIFF header not found\n");
570 // As TIFF 6.0 specification puts it "An arbitrary but carefully chosen number
571 // that further identifies the file as a TIFF file"
572 if(tget_short(&buf, le) != 42){
573 av_log(avctx, AV_LOG_ERROR, "The answer to life, universe and everything is not correct!\n");
576 /* parse image file directory */
577 off = tget_long(&buf, le);
578 if (off >= UINT_MAX - 14 || end_buf - orig_buf < off + 14) {
579 av_log(avctx, AV_LOG_ERROR, "IFD offset is greater than image size\n");
580 return AVERROR_INVALIDDATA;
582 buf = orig_buf + off;
583 entries = tget_short(&buf, le);
584 for(i = 0; i < entries; i++){
585 if(tiff_decode_tag(s, orig_buf, buf, end_buf) < 0)
589 if(!s->stripdata && !s->stripoff){
590 av_log(avctx, AV_LOG_ERROR, "Image data is missing\n");
593 /* now we have the data and may start decoding */
594 if ((ret = init_image(s)) < 0)
597 if(s->strips == 1 && !s->stripsize){
598 av_log(avctx, AV_LOG_WARNING, "Image data size missing\n");
599 s->stripsize = buf_size - s->stripoff;
601 stride = p->linesize[0];
603 for(i = 0; i < s->height; i += s->rps){
605 if (s->stripsizes >= end_buf)
606 return AVERROR_INVALIDDATA;
607 ssize = tget(&s->stripsizes, s->sstype, s->le);
609 ssize = s->stripsize;
612 if (s->stripdata >= end_buf)
613 return AVERROR_INVALIDDATA;
614 soff = tget(&s->stripdata, s->sot, s->le);
618 if (soff > buf_size || ssize > buf_size - soff) {
619 av_log(avctx, AV_LOG_ERROR, "Invalid strip size/offset\n");
622 if(tiff_unpack_strip(s, dst, stride, orig_buf + soff, ssize, FFMIN(s->rps, s->height - i)) < 0)
624 dst += s->rps * stride;
626 if(s->predictor == 2){
629 ssize = s->width * soff;
630 if (s->avctx->pix_fmt == PIX_FMT_RGB48LE) {
631 for (i = 0; i < s->height; i++) {
632 for (j = soff; j < ssize; j += 2)
633 AV_WL16(dst + j, AV_RL16(dst + j) + AV_RL16(dst + j - soff));
636 } else if (s->avctx->pix_fmt == PIX_FMT_RGB48BE) {
637 for (i = 0; i < s->height; i++) {
638 for (j = soff; j < ssize; j += 2)
639 AV_WB16(dst + j, AV_RB16(dst + j) + AV_RB16(dst + j - soff));
643 for(i = 0; i < s->height; i++) {
644 for(j = soff; j < ssize; j++)
645 dst[j] += dst[j - soff];
652 dst = s->picture.data[0];
653 for(i = 0; i < s->height; i++){
654 for(j = 0; j < s->picture.linesize[0]; j++)
655 dst[j] = (s->avctx->pix_fmt == PIX_FMT_PAL8 ? (1<<s->bpp) - 1 : 255) - dst[j];
656 dst += s->picture.linesize[0];
659 *picture= *(AVFrame*)&s->picture;
660 *data_size = sizeof(AVPicture);
665 static av_cold int tiff_init(AVCodecContext *avctx){
666 TiffContext *s = avctx->priv_data;
671 avcodec_get_frame_defaults((AVFrame*)&s->picture);
672 avctx->coded_frame= (AVFrame*)&s->picture;
673 ff_lzw_decode_open(&s->lzw);
674 ff_ccitt_unpack_init();
679 static av_cold int tiff_end(AVCodecContext *avctx)
681 TiffContext * const s = avctx->priv_data;
683 ff_lzw_decode_close(&s->lzw);
684 if(s->picture.data[0])
685 avctx->release_buffer(avctx, &s->picture);
689 AVCodec ff_tiff_decoder = {
691 .type = AVMEDIA_TYPE_VIDEO,
693 .priv_data_size = sizeof(TiffContext),
696 .decode = decode_frame,
697 .capabilities = CODEC_CAP_DR1,
698 .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),