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
35 #include "libavutil/attributes.h"
36 #include "libavutil/avstring.h"
37 #include "libavutil/intreadwrite.h"
38 #include "libavutil/imgutils.h"
40 #include "bytestream.h"
46 #include "tiff_data.h"
49 typedef struct TiffContext {
50 AVCodecContext *avctx;
54 unsigned int bpp, bppcount;
55 uint32_t palette[256];
59 enum TiffPhotometric photometric;
67 int strips, rps, sstype;
69 int stripsizesoff, stripsize, stripoff, strippos;
72 uint8_t *deinvert_buf;
73 int deinvert_buf_size;
75 unsigned int yuv_line_size;
81 static void free_geotags(TiffContext *const s)
84 for (i = 0; i < s->geotag_count; i++) {
85 if (s->geotags[i].val)
86 av_freep(&s->geotags[i].val);
88 av_freep(&s->geotags);
92 #define RET_GEOKEY(TYPE, array, element)\
93 if (key >= TIFF_##TYPE##_KEY_ID_OFFSET &&\
94 key - TIFF_##TYPE##_KEY_ID_OFFSET < FF_ARRAY_ELEMS(ff_tiff_##array##_name_type_map))\
95 return ff_tiff_##array##_name_type_map[key - TIFF_##TYPE##_KEY_ID_OFFSET].element;
97 static const char *get_geokey_name(int key)
99 RET_GEOKEY(VERT, vert, name);
100 RET_GEOKEY(PROJ, proj, name);
101 RET_GEOKEY(GEOG, geog, name);
102 RET_GEOKEY(CONF, conf, name);
107 static int get_geokey_type(int key)
109 RET_GEOKEY(VERT, vert, type);
110 RET_GEOKEY(PROJ, proj, type);
111 RET_GEOKEY(GEOG, geog, type);
112 RET_GEOKEY(CONF, conf, type);
114 return AVERROR_INVALIDDATA;
117 static int cmp_id_key(const void *id, const void *k)
119 return *(const int*)id - ((const TiffGeoTagKeyName*)k)->key;
122 static const char *search_keyval(const TiffGeoTagKeyName *keys, int n, int id)
124 TiffGeoTagKeyName *r = bsearch(&id, keys, n, sizeof(keys[0]), cmp_id_key);
131 static char *get_geokey_val(int key, int val)
135 if (val == TIFF_GEO_KEY_UNDEFINED)
136 return av_strdup("undefined");
137 if (val == TIFF_GEO_KEY_USER_DEFINED)
138 return av_strdup("User-Defined");
140 #define RET_GEOKEY_VAL(TYPE, array)\
141 if (val >= TIFF_##TYPE##_OFFSET &&\
142 val - TIFF_##TYPE##_OFFSET < FF_ARRAY_ELEMS(ff_tiff_##array##_codes))\
143 return av_strdup(ff_tiff_##array##_codes[val - TIFF_##TYPE##_OFFSET]);
146 case TIFF_GT_MODEL_TYPE_GEOKEY:
147 RET_GEOKEY_VAL(GT_MODEL_TYPE, gt_model_type);
149 case TIFF_GT_RASTER_TYPE_GEOKEY:
150 RET_GEOKEY_VAL(GT_RASTER_TYPE, gt_raster_type);
152 case TIFF_GEOG_LINEAR_UNITS_GEOKEY:
153 case TIFF_PROJ_LINEAR_UNITS_GEOKEY:
154 case TIFF_VERTICAL_UNITS_GEOKEY:
155 RET_GEOKEY_VAL(LINEAR_UNIT, linear_unit);
157 case TIFF_GEOG_ANGULAR_UNITS_GEOKEY:
158 case TIFF_GEOG_AZIMUTH_UNITS_GEOKEY:
159 RET_GEOKEY_VAL(ANGULAR_UNIT, angular_unit);
161 case TIFF_GEOGRAPHIC_TYPE_GEOKEY:
162 RET_GEOKEY_VAL(GCS_TYPE, gcs_type);
163 RET_GEOKEY_VAL(GCSE_TYPE, gcse_type);
165 case TIFF_GEOG_GEODETIC_DATUM_GEOKEY:
166 RET_GEOKEY_VAL(GEODETIC_DATUM, geodetic_datum);
167 RET_GEOKEY_VAL(GEODETIC_DATUM_E, geodetic_datum_e);
169 case TIFF_GEOG_ELLIPSOID_GEOKEY:
170 RET_GEOKEY_VAL(ELLIPSOID, ellipsoid);
172 case TIFF_GEOG_PRIME_MERIDIAN_GEOKEY:
173 RET_GEOKEY_VAL(PRIME_MERIDIAN, prime_meridian);
175 case TIFF_PROJECTED_CS_TYPE_GEOKEY:
176 ap = av_strdup(search_keyval(ff_tiff_proj_cs_type_codes, FF_ARRAY_ELEMS(ff_tiff_proj_cs_type_codes), val));
179 case TIFF_PROJECTION_GEOKEY:
180 ap = av_strdup(search_keyval(ff_tiff_projection_codes, FF_ARRAY_ELEMS(ff_tiff_projection_codes), val));
183 case TIFF_PROJ_COORD_TRANS_GEOKEY:
184 RET_GEOKEY_VAL(COORD_TRANS, coord_trans);
186 case TIFF_VERTICAL_CS_TYPE_GEOKEY:
187 RET_GEOKEY_VAL(VERT_CS, vert_cs);
188 RET_GEOKEY_VAL(ORTHO_VERT_CS, ortho_vert_cs);
195 snprintf(ap, 14, "Unknown-%d", val);
199 static char *doubles2str(double *dp, int count, const char *sep)
203 uint64_t component_len;
204 if (!sep) sep = ", ";
205 component_len = 24LL + strlen(sep);
206 if (count >= (INT_MAX - 1)/component_len)
208 ap = av_malloc(component_len * count + 1);
213 for (i = 0; i < count; i++) {
214 unsigned l = snprintf(ap, component_len, "%.15g%s", dp[i], sep);
215 if(l >= component_len) {
221 ap0[strlen(ap0) - strlen(sep)] = '\0';
225 static int add_metadata(int count, int type,
226 const char *name, const char *sep, TiffContext *s, AVFrame *frame)
229 case TIFF_DOUBLE: return ff_tadd_doubles_metadata(count, name, sep, &s->gb, s->le, avpriv_frame_get_metadatap(frame));
230 case TIFF_SHORT : return ff_tadd_shorts_metadata(count, name, sep, &s->gb, s->le, 0, avpriv_frame_get_metadatap(frame));
231 case TIFF_STRING: return ff_tadd_string_metadata(count, name, &s->gb, s->le, avpriv_frame_get_metadatap(frame));
232 default : return AVERROR_INVALIDDATA;
236 static void av_always_inline horizontal_fill(unsigned int bpp, uint8_t* dst,
237 int usePtr, const uint8_t *src,
238 uint8_t c, int width, int offset)
242 while (--width >= 0) {
243 dst[(width+offset)*8+7] = (usePtr ? src[width] : c) & 0x1;
244 dst[(width+offset)*8+6] = (usePtr ? src[width] : c) >> 1 & 0x1;
245 dst[(width+offset)*8+5] = (usePtr ? src[width] : c) >> 2 & 0x1;
246 dst[(width+offset)*8+4] = (usePtr ? src[width] : c) >> 3 & 0x1;
247 dst[(width+offset)*8+3] = (usePtr ? src[width] : c) >> 4 & 0x1;
248 dst[(width+offset)*8+2] = (usePtr ? src[width] : c) >> 5 & 0x1;
249 dst[(width+offset)*8+1] = (usePtr ? src[width] : c) >> 6 & 0x1;
250 dst[(width+offset)*8+0] = (usePtr ? src[width] : c) >> 7;
254 while (--width >= 0) {
255 dst[(width+offset)*4+3] = (usePtr ? src[width] : c) & 0x3;
256 dst[(width+offset)*4+2] = (usePtr ? src[width] : c) >> 2 & 0x3;
257 dst[(width+offset)*4+1] = (usePtr ? src[width] : c) >> 4 & 0x3;
258 dst[(width+offset)*4+0] = (usePtr ? src[width] : c) >> 6;
262 while (--width >= 0) {
263 dst[(width+offset)*2+1] = (usePtr ? src[width] : c) & 0xF;
264 dst[(width+offset)*2+0] = (usePtr ? src[width] : c) >> 4;
269 memcpy(dst + offset, src, width);
271 memset(dst + offset, c, width);
276 static int deinvert_buffer(TiffContext *s, const uint8_t *src, int size)
280 av_fast_padded_malloc(&s->deinvert_buf, &s->deinvert_buf_size, size);
281 if (!s->deinvert_buf)
282 return AVERROR(ENOMEM);
283 for (i = 0; i < size; i++)
284 s->deinvert_buf[i] = ff_reverse[src[i]];
289 static void unpack_yuv(TiffContext *s, AVFrame *p,
290 const uint8_t *src, int lnum)
293 int w = (s->width - 1) / s->subsampling[0] + 1;
294 uint8_t *pu = &p->data[1][lnum / s->subsampling[1] * p->linesize[1]];
295 uint8_t *pv = &p->data[2][lnum / s->subsampling[1] * p->linesize[2]];
296 if (s->width % s->subsampling[0] || s->height % s->subsampling[1]) {
297 for (i = 0; i < w; i++) {
298 for (j = 0; j < s->subsampling[1]; j++)
299 for (k = 0; k < s->subsampling[0]; k++)
300 p->data[0][FFMIN(lnum + j, s->height-1) * p->linesize[0] +
301 FFMIN(i * s->subsampling[0] + k, s->width-1)] = *src++;
306 for (i = 0; i < w; i++) {
307 for (j = 0; j < s->subsampling[1]; j++)
308 for (k = 0; k < s->subsampling[0]; k++)
309 p->data[0][(lnum + j) * p->linesize[0] +
310 i * s->subsampling[0] + k] = *src++;
318 static int tiff_uncompress(uint8_t *dst, unsigned long *len, const uint8_t *src,
321 z_stream zstream = { 0 };
324 zstream.next_in = (uint8_t *)src;
325 zstream.avail_in = size;
326 zstream.next_out = dst;
327 zstream.avail_out = *len;
328 zret = inflateInit(&zstream);
330 av_log(NULL, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
333 zret = inflate(&zstream, Z_SYNC_FLUSH);
334 inflateEnd(&zstream);
335 *len = zstream.total_out;
336 return zret == Z_STREAM_END ? Z_OK : zret;
339 static int tiff_unpack_zlib(TiffContext *s, AVFrame *p, uint8_t *dst, int stride,
340 const uint8_t *src, int size, int width, int lines,
341 int strip_start, int is_yuv)
344 unsigned long outlen;
346 outlen = width * lines;
347 zbuf = av_malloc(outlen);
349 return AVERROR(ENOMEM);
351 if ((ret = deinvert_buffer(s, src, size)) < 0) {
355 src = s->deinvert_buf;
357 ret = tiff_uncompress(zbuf, &outlen, src, size);
359 av_log(s->avctx, AV_LOG_ERROR,
360 "Uncompressing failed (%lu of %lu) with error %d\n", outlen,
361 (unsigned long)width * lines, ret);
363 return AVERROR_UNKNOWN;
366 for (line = 0; line < lines; line++) {
367 if (s->bpp < 8 && s->avctx->pix_fmt == AV_PIX_FMT_PAL8) {
368 horizontal_fill(s->bpp, dst, 1, src, 0, width, 0);
370 memcpy(dst, src, width);
373 unpack_yuv(s, p, dst, strip_start + line);
374 line += s->subsampling[1] - 1;
385 static int tiff_uncompress_lzma(uint8_t *dst, uint64_t *len, const uint8_t *src,
388 lzma_stream stream = LZMA_STREAM_INIT;
391 stream.next_in = (uint8_t *)src;
392 stream.avail_in = size;
393 stream.next_out = dst;
394 stream.avail_out = *len;
395 ret = lzma_stream_decoder(&stream, UINT64_MAX, 0);
396 if (ret != LZMA_OK) {
397 av_log(NULL, AV_LOG_ERROR, "LZMA init error: %d\n", ret);
400 ret = lzma_code(&stream, LZMA_RUN);
402 *len = stream.total_out;
403 return ret == LZMA_STREAM_END ? LZMA_OK : ret;
406 static int tiff_unpack_lzma(TiffContext *s, AVFrame *p, uint8_t *dst, int stride,
407 const uint8_t *src, int size, int width, int lines,
408 int strip_start, int is_yuv)
410 uint64_t outlen = width * lines;
412 uint8_t *buf = av_malloc(outlen);
414 return AVERROR(ENOMEM);
416 if ((ret = deinvert_buffer(s, src, size)) < 0) {
420 src = s->deinvert_buf;
422 ret = tiff_uncompress_lzma(buf, &outlen, src, size);
423 if (ret != LZMA_OK) {
424 av_log(s->avctx, AV_LOG_ERROR,
425 "Uncompressing failed (%"PRIu64" of %"PRIu64") with error %d\n", outlen,
426 (uint64_t)width * lines, ret);
428 return AVERROR_UNKNOWN;
431 for (line = 0; line < lines; line++) {
432 if (s->bpp < 8 && s->avctx->pix_fmt == AV_PIX_FMT_PAL8) {
433 horizontal_fill(s->bpp, dst, 1, src, 0, width, 0);
435 memcpy(dst, src, width);
438 unpack_yuv(s, p, dst, strip_start + line);
439 line += s->subsampling[1] - 1;
449 static int tiff_unpack_fax(TiffContext *s, uint8_t *dst, int stride,
450 const uint8_t *src, int size, int width, int lines)
454 uint8_t *src2 = av_malloc((unsigned)size +
455 FF_INPUT_BUFFER_PADDING_SIZE);
458 av_log(s->avctx, AV_LOG_ERROR,
459 "Error allocating temporary buffer\n");
460 return AVERROR(ENOMEM);
462 if (s->fax_opts & 2) {
463 avpriv_request_sample(s->avctx, "Uncompressed fax mode");
465 return AVERROR_PATCHWELCOME;
467 if (!s->fill_order) {
468 memcpy(src2, src, size);
470 for (i = 0; i < size; i++)
471 src2[i] = ff_reverse[src[i]];
473 memset(src2 + size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
474 ret = ff_ccitt_unpack(s->avctx, src2, size, dst, lines, stride,
475 s->compr, s->fax_opts);
476 if (s->bpp < 8 && s->avctx->pix_fmt == AV_PIX_FMT_PAL8)
477 for (line = 0; line < lines; line++) {
478 horizontal_fill(s->bpp, dst, 1, dst, 0, width, 0);
485 static int tiff_unpack_strip(TiffContext *s, AVFrame *p, uint8_t *dst, int stride,
486 const uint8_t *src, int size, int strip_start, int lines)
489 int c, line, pixels, code, ret;
490 const uint8_t *ssrc = src;
491 int width = ((s->width * s->bpp) + 7) >> 3;
492 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(p->format);
493 int is_yuv = !(desc->flags & AV_PIX_FMT_FLAG_RGB) &&
494 (desc->flags & AV_PIX_FMT_FLAG_PLANAR) &&
495 desc->nb_components >= 3;
498 width /= s->bppcount;
501 return AVERROR_INVALIDDATA;
504 int bytes_per_row = (((s->width - 1) / s->subsampling[0] + 1) * s->bpp *
505 s->subsampling[0] * s->subsampling[1] + 7) >> 3;
506 av_fast_padded_malloc(&s->yuv_line, &s->yuv_line_size, bytes_per_row);
507 if (s->yuv_line == NULL) {
508 av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
509 return AVERROR(ENOMEM);
513 width = s->width * s->subsampling[1] + 2*(s->width / s->subsampling[0]);
514 av_assert0(width <= bytes_per_row);
515 av_assert0(s->bpp == 24);
518 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
520 return tiff_unpack_zlib(s, p, dst, stride, src, size, width, lines,
521 strip_start, is_yuv);
523 av_log(s->avctx, AV_LOG_ERROR,
524 "zlib support not enabled, "
525 "deflate compression not supported\n");
526 return AVERROR(ENOSYS);
529 if (s->compr == TIFF_LZMA) {
531 return tiff_unpack_lzma(s, p, dst, stride, src, size, width, lines,
532 strip_start, is_yuv);
534 av_log(s->avctx, AV_LOG_ERROR,
535 "LZMA support not enabled\n");
536 return AVERROR(ENOSYS);
539 if (s->compr == TIFF_LZW) {
541 if ((ret = deinvert_buffer(s, src, size)) < 0)
543 ssrc = src = s->deinvert_buf;
545 if (size > 1 && !src[0] && (src[1]&1)) {
546 av_log(s->avctx, AV_LOG_ERROR, "Old style LZW is unsupported\n");
548 if ((ret = ff_lzw_decode_init(s->lzw, 8, src, size, FF_LZW_TIFF)) < 0) {
549 av_log(s->avctx, AV_LOG_ERROR, "Error initializing LZW decoder\n");
552 for (line = 0; line < lines; line++) {
553 pixels = ff_lzw_decode(s->lzw, dst, width);
554 if (pixels < width) {
555 av_log(s->avctx, AV_LOG_ERROR, "Decoded only %i bytes of %i\n",
557 return AVERROR_INVALIDDATA;
559 if (s->bpp < 8 && s->avctx->pix_fmt == AV_PIX_FMT_PAL8)
560 horizontal_fill(s->bpp, dst, 1, dst, 0, width, 0);
562 unpack_yuv(s, p, dst, strip_start + line);
563 line += s->subsampling[1] - 1;
569 if (s->compr == TIFF_CCITT_RLE ||
570 s->compr == TIFF_G3 ||
571 s->compr == TIFF_G4) {
573 return AVERROR_INVALIDDATA;
575 return tiff_unpack_fax(s, dst, stride, src, size, width, lines);
578 bytestream2_init(&s->gb, src, size);
579 bytestream2_init_writer(&pb, dst, is_yuv ? s->yuv_line_size : (stride * lines));
581 for (line = 0; line < lines; line++) {
582 if (src - ssrc > size) {
583 av_log(s->avctx, AV_LOG_ERROR, "Source data overread\n");
584 return AVERROR_INVALIDDATA;
587 if (bytestream2_get_bytes_left(&s->gb) == 0 || bytestream2_get_eof(&pb))
589 bytestream2_seek_p(&pb, stride * line, SEEK_SET);
592 if (ssrc + size - src < width)
593 return AVERROR_INVALIDDATA;
595 if (!s->fill_order) {
596 horizontal_fill(s->bpp * (s->avctx->pix_fmt == AV_PIX_FMT_PAL8),
597 dst, 1, src, 0, width, 0);
600 for (i = 0; i < width; i++)
601 dst[i] = ff_reverse[src[i]];
606 for (pixels = 0; pixels < width;) {
607 if (ssrc + size - src < 2) {
608 av_log(s->avctx, AV_LOG_ERROR, "Read went out of bounds\n");
609 return AVERROR_INVALIDDATA;
611 code = s->fill_order ? (int8_t) ff_reverse[*src++]: (int8_t) *src++;
614 if (pixels + code > width ||
615 ssrc + size - src < code) {
616 av_log(s->avctx, AV_LOG_ERROR,
617 "Copy went out of bounds\n");
618 return AVERROR_INVALIDDATA;
620 horizontal_fill(s->bpp * (s->avctx->pix_fmt == AV_PIX_FMT_PAL8),
621 dst, 1, src, 0, code, pixels);
624 } else if (code != -128) { // -127..-1
626 if (pixels + code > width) {
627 av_log(s->avctx, AV_LOG_ERROR,
628 "Run went out of bounds\n");
629 return AVERROR_INVALIDDATA;
632 horizontal_fill(s->bpp * (s->avctx->pix_fmt == AV_PIX_FMT_PAL8),
633 dst, 0, NULL, c, code, pixels);
639 for (i = 0; i < width; i++)
640 dst[i] = ff_reverse[dst[i]];
645 unpack_yuv(s, p, dst, strip_start + line);
646 line += s->subsampling[1] - 1;
653 static int init_image(TiffContext *s, ThreadFrame *frame)
657 switch (s->planar * 1000 + s->bpp * 10 + s->bppcount) {
659 if (!s->palette_is_set) {
660 s->avctx->pix_fmt = AV_PIX_FMT_MONOBLACK;
666 s->avctx->pix_fmt = s->palette_is_set ? AV_PIX_FMT_PAL8 : AV_PIX_FMT_GRAY8;
669 if (s->photometric == TIFF_PHOTOMETRIC_YCBCR) {
670 if (s->subsampling[0] == 1 && s->subsampling[1] == 1) {
671 s->avctx->pix_fmt = AV_PIX_FMT_YUV444P;
672 } else if (s->subsampling[0] == 2 && s->subsampling[1] == 1) {
673 s->avctx->pix_fmt = AV_PIX_FMT_YUV422P;
674 } else if (s->subsampling[0] == 4 && s->subsampling[1] == 1) {
675 s->avctx->pix_fmt = AV_PIX_FMT_YUV411P;
676 } else if (s->subsampling[0] == 1 && s->subsampling[1] == 2) {
677 s->avctx->pix_fmt = AV_PIX_FMT_YUV440P;
678 } else if (s->subsampling[0] == 2 && s->subsampling[1] == 2) {
679 s->avctx->pix_fmt = AV_PIX_FMT_YUV420P;
680 } else if (s->subsampling[0] == 4 && s->subsampling[1] == 4) {
681 s->avctx->pix_fmt = AV_PIX_FMT_YUV410P;
683 av_log(s->avctx, AV_LOG_ERROR, "Unsupported YCbCr subsampling\n");
684 return AVERROR_PATCHWELCOME;
687 s->avctx->pix_fmt = AV_PIX_FMT_RGB24;
690 s->avctx->pix_fmt = s->le ? AV_PIX_FMT_GRAY16LE : AV_PIX_FMT_GRAY16BE;
693 s->avctx->pix_fmt = AV_PIX_FMT_YA8;
696 s->avctx->pix_fmt = s->le ? AV_PIX_FMT_YA16LE : AV_PIX_FMT_YA16BE;
699 s->avctx->pix_fmt = AV_PIX_FMT_RGBA;
702 s->avctx->pix_fmt = s->le ? AV_PIX_FMT_RGB48LE : AV_PIX_FMT_RGB48BE;
705 s->avctx->pix_fmt = s->le ? AV_PIX_FMT_RGBA64LE : AV_PIX_FMT_RGBA64BE;
708 s->avctx->pix_fmt = AV_PIX_FMT_GBRP;
711 s->avctx->pix_fmt = AV_PIX_FMT_GBRAP;
714 s->avctx->pix_fmt = s->le ? AV_PIX_FMT_GBRP16LE : AV_PIX_FMT_GBRP16BE;
717 s->avctx->pix_fmt = s->le ? AV_PIX_FMT_GBRAP16LE : AV_PIX_FMT_GBRAP16BE;
720 av_log(s->avctx, AV_LOG_ERROR,
721 "This format is not supported (bpp=%d, bppcount=%d)\n",
722 s->bpp, s->bppcount);
723 return AVERROR_INVALIDDATA;
726 if (s->photometric == TIFF_PHOTOMETRIC_YCBCR) {
727 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(s->avctx->pix_fmt);
728 if((desc->flags & AV_PIX_FMT_FLAG_RGB) ||
729 !(desc->flags & AV_PIX_FMT_FLAG_PLANAR) ||
730 desc->nb_components < 3) {
731 av_log(s->avctx, AV_LOG_ERROR, "Unsupported YCbCr variant\n");
732 return AVERROR_INVALIDDATA;
736 if (s->width != s->avctx->width || s->height != s->avctx->height) {
737 ret = ff_set_dimensions(s->avctx, s->width, s->height);
741 if ((ret = ff_thread_get_buffer(s->avctx, frame, 0)) < 0)
743 if (s->avctx->pix_fmt == AV_PIX_FMT_PAL8) {
744 memcpy(frame->f->data[1], s->palette, sizeof(s->palette));
749 static void set_sar(TiffContext *s, unsigned tag, unsigned num, unsigned den)
751 int offset = tag == TIFF_YRES ? 2 : 0;
752 s->res[offset++] = num;
753 s->res[offset] = den;
754 if (s->res[0] && s->res[1] && s->res[2] && s->res[3])
755 av_reduce(&s->avctx->sample_aspect_ratio.num, &s->avctx->sample_aspect_ratio.den,
756 s->res[2] * (uint64_t)s->res[1], s->res[0] * (uint64_t)s->res[3], INT32_MAX);
759 static int tiff_decode_tag(TiffContext *s, AVFrame *frame)
761 unsigned tag, type, count, off, value = 0, value2 = 0;
767 ret = ff_tread_tag(&s->gb, s->le, &tag, &type, &count, &start);
772 off = bytestream2_tell(&s->gb);
778 value = ff_tget(&s->gb, type, s->le);
781 value = ff_tget(&s->gb, TIFF_LONG, s->le);
782 value2 = ff_tget(&s->gb, TIFF_LONG, s->le);
803 av_log(s->avctx, AV_LOG_ERROR,
804 "This format is not supported (bpp=%d, %d components)\n",
806 return AVERROR_INVALIDDATA;
816 if (bytestream2_get_bytes_left(&s->gb) < type_sizes[type] * count)
817 return AVERROR_INVALIDDATA;
818 for (i = 0; i < count; i++)
819 s->bpp += ff_tget(&s->gb, type, s->le);
826 case TIFF_SAMPLES_PER_PIXEL:
828 av_log(s->avctx, AV_LOG_ERROR,
829 "Samples per pixel requires a single value, many provided\n");
830 return AVERROR_INVALIDDATA;
833 av_log(s->avctx, AV_LOG_ERROR,
834 "Samples per pixel %d is too large\n", value);
835 return AVERROR_INVALIDDATA;
837 if (s->bppcount == 1)
855 case TIFF_ADOBE_DEFLATE:
859 av_log(s->avctx, AV_LOG_ERROR, "Deflate: ZLib not compiled in\n");
860 return AVERROR(ENOSYS);
864 avpriv_report_missing_feature(s->avctx, "JPEG compression");
865 return AVERROR_PATCHWELCOME;
870 av_log(s->avctx, AV_LOG_ERROR, "LZMA not compiled in\n");
871 return AVERROR(ENOSYS);
874 av_log(s->avctx, AV_LOG_ERROR, "Unknown compression method %i\n",
876 return AVERROR_INVALIDDATA;
879 case TIFF_ROWSPERSTRIP:
880 if (!value || (type == TIFF_LONG && value == UINT_MAX))
882 s->rps = FFMIN(value, s->height);
884 case TIFF_STRIP_OFFS:
895 case TIFF_STRIP_SIZE:
897 s->stripsizesoff = 0;
898 s->stripsize = value;
901 s->stripsizesoff = off;
908 set_sar(s, tag, value, value2);
910 case TIFF_TILE_BYTE_COUNTS:
911 case TIFF_TILE_LENGTH:
912 case TIFF_TILE_OFFSETS:
913 case TIFF_TILE_WIDTH:
914 av_log(s->avctx, AV_LOG_ERROR, "Tiled images are not supported\n");
915 return AVERROR_PATCHWELCOME;
918 s->predictor = value;
920 case TIFF_PHOTOMETRIC:
922 case TIFF_PHOTOMETRIC_WHITE_IS_ZERO:
923 case TIFF_PHOTOMETRIC_BLACK_IS_ZERO:
924 case TIFF_PHOTOMETRIC_RGB:
925 case TIFF_PHOTOMETRIC_PALETTE:
926 case TIFF_PHOTOMETRIC_YCBCR:
927 s->photometric = value;
929 case TIFF_PHOTOMETRIC_ALPHA_MASK:
930 case TIFF_PHOTOMETRIC_SEPARATED:
931 case TIFF_PHOTOMETRIC_CIE_LAB:
932 case TIFF_PHOTOMETRIC_ICC_LAB:
933 case TIFF_PHOTOMETRIC_ITU_LAB:
934 case TIFF_PHOTOMETRIC_CFA:
935 case TIFF_PHOTOMETRIC_LOG_L:
936 case TIFF_PHOTOMETRIC_LOG_LUV:
937 case TIFF_PHOTOMETRIC_LINEAR_RAW:
938 avpriv_report_missing_feature(s->avctx,
939 "PhotometricInterpretation 0x%04X",
941 return AVERROR_PATCHWELCOME;
943 av_log(s->avctx, AV_LOG_ERROR, "PhotometricInterpretation %u is "
945 return AVERROR_INVALIDDATA;
948 case TIFF_FILL_ORDER:
949 if (value < 1 || value > 2) {
950 av_log(s->avctx, AV_LOG_ERROR,
951 "Unknown FillOrder value %d, trying default one\n", value);
954 s->fill_order = value - 1;
957 GetByteContext pal_gb[3];
958 off = type_sizes[type];
959 if (count / 3 > 256 ||
960 bytestream2_get_bytes_left(&s->gb) < count / 3 * off * 3)
961 return AVERROR_INVALIDDATA;
963 pal_gb[0] = pal_gb[1] = pal_gb[2] = s->gb;
964 bytestream2_skip(&pal_gb[1], count / 3 * off);
965 bytestream2_skip(&pal_gb[2], count / 3 * off * 2);
967 off = (type_sizes[type] - 1) << 3;
968 for (i = 0; i < count / 3; i++) {
969 uint32_t p = 0xFF000000;
970 p |= (ff_tget(&pal_gb[0], type, s->le) >> off) << 16;
971 p |= (ff_tget(&pal_gb[1], type, s->le) >> off) << 8;
972 p |= ff_tget(&pal_gb[2], type, s->le) >> off;
975 s->palette_is_set = 1;
979 s->planar = value == 2;
981 case TIFF_YCBCR_SUBSAMPLING:
983 av_log(s->avctx, AV_LOG_ERROR, "subsample count invalid\n");
984 return AVERROR_INVALIDDATA;
986 for (i = 0; i < count; i++)
987 s->subsampling[i] = ff_tget(&s->gb, type, s->le);
990 if (s->compr == TIFF_G3)
994 if (s->compr == TIFF_G4)
997 #define ADD_METADATA(count, name, sep)\
998 if ((ret = add_metadata(count, type, name, sep, s, frame)) < 0) {\
999 av_log(s->avctx, AV_LOG_ERROR, "Error allocating temporary buffer\n");\
1002 case TIFF_MODEL_PIXEL_SCALE:
1003 ADD_METADATA(count, "ModelPixelScaleTag", NULL);
1005 case TIFF_MODEL_TRANSFORMATION:
1006 ADD_METADATA(count, "ModelTransformationTag", NULL);
1008 case TIFF_MODEL_TIEPOINT:
1009 ADD_METADATA(count, "ModelTiepointTag", NULL);
1011 case TIFF_GEO_KEY_DIRECTORY:
1012 ADD_METADATA(1, "GeoTIFF_Version", NULL);
1013 ADD_METADATA(2, "GeoTIFF_Key_Revision", ".");
1014 s->geotag_count = ff_tget_short(&s->gb, s->le);
1015 if (s->geotag_count > count / 4 - 1) {
1016 s->geotag_count = count / 4 - 1;
1017 av_log(s->avctx, AV_LOG_WARNING, "GeoTIFF key directory buffer shorter than specified\n");
1019 if (bytestream2_get_bytes_left(&s->gb) < s->geotag_count * sizeof(int16_t) * 4) {
1020 s->geotag_count = 0;
1023 s->geotags = av_mallocz_array(s->geotag_count, sizeof(TiffGeoTag));
1025 av_log(s->avctx, AV_LOG_ERROR, "Error allocating temporary buffer\n");
1026 s->geotag_count = 0;
1029 for (i = 0; i < s->geotag_count; i++) {
1030 s->geotags[i].key = ff_tget_short(&s->gb, s->le);
1031 s->geotags[i].type = ff_tget_short(&s->gb, s->le);
1032 s->geotags[i].count = ff_tget_short(&s->gb, s->le);
1034 if (!s->geotags[i].type)
1035 s->geotags[i].val = get_geokey_val(s->geotags[i].key, ff_tget_short(&s->gb, s->le));
1037 s->geotags[i].offset = ff_tget_short(&s->gb, s->le);
1040 case TIFF_GEO_DOUBLE_PARAMS:
1041 if (count >= INT_MAX / sizeof(int64_t))
1042 return AVERROR_INVALIDDATA;
1043 if (bytestream2_get_bytes_left(&s->gb) < count * sizeof(int64_t))
1044 return AVERROR_INVALIDDATA;
1045 dp = av_malloc_array(count, sizeof(double));
1047 av_log(s->avctx, AV_LOG_ERROR, "Error allocating temporary buffer\n");
1050 for (i = 0; i < count; i++)
1051 dp[i] = ff_tget_double(&s->gb, s->le);
1052 for (i = 0; i < s->geotag_count; i++) {
1053 if (s->geotags[i].type == TIFF_GEO_DOUBLE_PARAMS) {
1054 if (s->geotags[i].count == 0
1055 || s->geotags[i].offset + s->geotags[i].count > count) {
1056 av_log(s->avctx, AV_LOG_WARNING, "Invalid GeoTIFF key %d\n", s->geotags[i].key);
1058 char *ap = doubles2str(&dp[s->geotags[i].offset], s->geotags[i].count, ", ");
1060 av_log(s->avctx, AV_LOG_ERROR, "Error allocating temporary buffer\n");
1062 return AVERROR(ENOMEM);
1064 s->geotags[i].val = ap;
1070 case TIFF_GEO_ASCII_PARAMS:
1071 pos = bytestream2_tell(&s->gb);
1072 for (i = 0; i < s->geotag_count; i++) {
1073 if (s->geotags[i].type == TIFF_GEO_ASCII_PARAMS) {
1074 if (s->geotags[i].count == 0
1075 || s->geotags[i].offset + s->geotags[i].count > count) {
1076 av_log(s->avctx, AV_LOG_WARNING, "Invalid GeoTIFF key %d\n", s->geotags[i].key);
1080 bytestream2_seek(&s->gb, pos + s->geotags[i].offset, SEEK_SET);
1081 if (bytestream2_get_bytes_left(&s->gb) < s->geotags[i].count)
1082 return AVERROR_INVALIDDATA;
1083 ap = av_malloc(s->geotags[i].count);
1085 av_log(s->avctx, AV_LOG_ERROR, "Error allocating temporary buffer\n");
1086 return AVERROR(ENOMEM);
1088 bytestream2_get_bufferu(&s->gb, ap, s->geotags[i].count);
1089 ap[s->geotags[i].count - 1] = '\0'; //replace the "|" delimiter with a 0 byte
1090 s->geotags[i].val = ap;
1096 ADD_METADATA(count, "artist", NULL);
1098 case TIFF_COPYRIGHT:
1099 ADD_METADATA(count, "copyright", NULL);
1102 ADD_METADATA(count, "date", NULL);
1104 case TIFF_DOCUMENT_NAME:
1105 ADD_METADATA(count, "document_name", NULL);
1107 case TIFF_HOST_COMPUTER:
1108 ADD_METADATA(count, "computer", NULL);
1110 case TIFF_IMAGE_DESCRIPTION:
1111 ADD_METADATA(count, "description", NULL);
1114 ADD_METADATA(count, "make", NULL);
1117 ADD_METADATA(count, "model", NULL);
1119 case TIFF_PAGE_NAME:
1120 ADD_METADATA(count, "page_name", NULL);
1122 case TIFF_PAGE_NUMBER:
1123 ADD_METADATA(count, "page_number", " / ");
1125 case TIFF_SOFTWARE_NAME:
1126 ADD_METADATA(count, "software", NULL);
1129 if (s->avctx->err_recognition & AV_EF_EXPLODE) {
1130 av_log(s->avctx, AV_LOG_ERROR,
1131 "Unknown or unsupported tag %d/0X%0X\n",
1133 return AVERROR_INVALIDDATA;
1137 bytestream2_seek(&s->gb, start, SEEK_SET);
1141 static int decode_frame(AVCodecContext *avctx,
1142 void *data, int *got_frame, AVPacket *avpkt)
1144 TiffContext *const s = avctx->priv_data;
1145 AVFrame *const p = data;
1146 ThreadFrame frame = { .f = data };
1148 int le, ret, plane, planes;
1149 int i, j, entries, stride;
1150 unsigned soff, ssize;
1152 GetByteContext stripsizes;
1153 GetByteContext stripdata;
1155 bytestream2_init(&s->gb, avpkt->data, avpkt->size);
1157 // parse image header
1158 if ((ret = ff_tdecode_header(&s->gb, &le, &off))) {
1159 av_log(avctx, AV_LOG_ERROR, "Invalid TIFF header\n");
1161 } else if (off >= UINT_MAX - 14 || avpkt->size < off + 14) {
1162 av_log(avctx, AV_LOG_ERROR, "IFD offset is greater than image size\n");
1163 return AVERROR_INVALIDDATA;
1166 // TIFF_BPP is not a required tag and defaults to 1
1167 s->bppcount = s->bpp = 1;
1168 s->photometric = TIFF_PHOTOMETRIC_NONE;
1169 s->compr = TIFF_RAW;
1173 // Reset these offsets so we can tell if they were set this frame
1174 s->stripsizesoff = s->strippos = 0;
1175 /* parse image file directory */
1176 bytestream2_seek(&s->gb, off, SEEK_SET);
1177 entries = ff_tget_short(&s->gb, le);
1178 if (bytestream2_get_bytes_left(&s->gb) < entries * 12)
1179 return AVERROR_INVALIDDATA;
1180 for (i = 0; i < entries; i++) {
1181 if ((ret = tiff_decode_tag(s, p)) < 0)
1185 for (i = 0; i<s->geotag_count; i++) {
1186 const char *keyname = get_geokey_name(s->geotags[i].key);
1188 av_log(avctx, AV_LOG_WARNING, "Unknown or unsupported GeoTIFF key %d\n", s->geotags[i].key);
1191 if (get_geokey_type(s->geotags[i].key) != s->geotags[i].type) {
1192 av_log(avctx, AV_LOG_WARNING, "Type of GeoTIFF key %d is wrong\n", s->geotags[i].key);
1195 ret = av_dict_set(avpriv_frame_get_metadatap(p), keyname, s->geotags[i].val, 0);
1197 av_log(avctx, AV_LOG_ERROR, "Writing metadata with key '%s' failed\n", keyname);
1202 if (!s->strippos && !s->stripoff) {
1203 av_log(avctx, AV_LOG_ERROR, "Image data is missing\n");
1204 return AVERROR_INVALIDDATA;
1206 /* now we have the data and may start decoding */
1207 if ((ret = init_image(s, &frame)) < 0)
1210 if (s->strips == 1 && !s->stripsize) {
1211 av_log(avctx, AV_LOG_WARNING, "Image data size missing\n");
1212 s->stripsize = avpkt->size - s->stripoff;
1215 if (s->stripsizesoff) {
1216 if (s->stripsizesoff >= (unsigned)avpkt->size)
1217 return AVERROR_INVALIDDATA;
1218 bytestream2_init(&stripsizes, avpkt->data + s->stripsizesoff,
1219 avpkt->size - s->stripsizesoff);
1222 if (s->strippos >= (unsigned)avpkt->size)
1223 return AVERROR_INVALIDDATA;
1224 bytestream2_init(&stripdata, avpkt->data + s->strippos,
1225 avpkt->size - s->strippos);
1229 av_log(avctx, AV_LOG_ERROR, "rps %d invalid\n", s->rps);
1230 return AVERROR_INVALIDDATA;
1233 planes = s->planar ? s->bppcount : 1;
1234 for (plane = 0; plane < planes; plane++) {
1235 stride = p->linesize[plane];
1236 dst = p->data[plane];
1237 for (i = 0; i < s->height; i += s->rps) {
1238 if (s->stripsizesoff)
1239 ssize = ff_tget(&stripsizes, s->sstype, le);
1241 ssize = s->stripsize;
1244 soff = ff_tget(&stripdata, s->sot, le);
1248 if (soff > avpkt->size || ssize > avpkt->size - soff) {
1249 av_log(avctx, AV_LOG_ERROR, "Invalid strip size/offset\n");
1250 return AVERROR_INVALIDDATA;
1252 if ((ret = tiff_unpack_strip(s, p, dst, stride, avpkt->data + soff, ssize, i,
1253 FFMIN(s->rps, s->height - i))) < 0) {
1254 if (avctx->err_recognition & AV_EF_EXPLODE)
1258 dst += s->rps * stride;
1260 if (s->predictor == 2) {
1261 if (s->photometric == TIFF_PHOTOMETRIC_YCBCR) {
1262 av_log(s->avctx, AV_LOG_ERROR, "predictor == 2 with YUV is unsupported");
1263 return AVERROR_PATCHWELCOME;
1265 dst = p->data[plane];
1268 soff = FFMAX(soff / s->bppcount, 1);
1269 ssize = s->width * soff;
1270 if (s->avctx->pix_fmt == AV_PIX_FMT_RGB48LE ||
1271 s->avctx->pix_fmt == AV_PIX_FMT_RGBA64LE ||
1272 s->avctx->pix_fmt == AV_PIX_FMT_GBRP16LE ||
1273 s->avctx->pix_fmt == AV_PIX_FMT_GBRAP16LE) {
1274 for (i = 0; i < s->height; i++) {
1275 for (j = soff; j < ssize; j += 2)
1276 AV_WL16(dst + j, AV_RL16(dst + j) + AV_RL16(dst + j - soff));
1279 } else if (s->avctx->pix_fmt == AV_PIX_FMT_RGB48BE ||
1280 s->avctx->pix_fmt == AV_PIX_FMT_RGBA64BE ||
1281 s->avctx->pix_fmt == AV_PIX_FMT_GBRP16BE ||
1282 s->avctx->pix_fmt == AV_PIX_FMT_GBRAP16BE) {
1283 for (i = 0; i < s->height; i++) {
1284 for (j = soff; j < ssize; j += 2)
1285 AV_WB16(dst + j, AV_RB16(dst + j) + AV_RB16(dst + j - soff));
1289 for (i = 0; i < s->height; i++) {
1290 for (j = soff; j < ssize; j++)
1291 dst[j] += dst[j - soff];
1297 if (s->photometric == TIFF_PHOTOMETRIC_WHITE_IS_ZERO) {
1298 dst = p->data[plane];
1299 for (i = 0; i < s->height; i++) {
1300 for (j = 0; j < p->linesize[plane]; j++)
1301 dst[j] = (s->avctx->pix_fmt == AV_PIX_FMT_PAL8 ? (1<<s->bpp) - 1 : 255) - dst[j];
1307 if (s->planar && s->bppcount > 2) {
1308 FFSWAP(uint8_t*, p->data[0], p->data[2]);
1309 FFSWAP(int, p->linesize[0], p->linesize[2]);
1310 FFSWAP(uint8_t*, p->data[0], p->data[1]);
1311 FFSWAP(int, p->linesize[0], p->linesize[1]);
1319 static av_cold int tiff_init(AVCodecContext *avctx)
1321 TiffContext *s = avctx->priv_data;
1326 s->subsampling[1] = 1;
1328 ff_lzw_decode_open(&s->lzw);
1329 ff_ccitt_unpack_init();
1334 static av_cold int tiff_end(AVCodecContext *avctx)
1336 TiffContext *const s = avctx->priv_data;
1340 ff_lzw_decode_close(&s->lzw);
1341 av_freep(&s->deinvert_buf);
1345 AVCodec ff_tiff_decoder = {
1347 .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),
1348 .type = AVMEDIA_TYPE_VIDEO,
1349 .id = AV_CODEC_ID_TIFF,
1350 .priv_data_size = sizeof(TiffContext),
1353 .decode = decode_frame,
1354 .init_thread_copy = ONLY_IF_THREADS_ENABLED(tiff_init),
1355 .capabilities = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,