avcodec/tiff: parse subsample factors
[ffmpeg.git] / libavcodec / tiff.c
1 /*
2  * Copyright (c) 2006 Konstantin Shishkov
3  *
4  * This file is part of FFmpeg.
5  *
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.
10  *
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.
15  *
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
19  */
20
21 /**
22  * @file
23  * TIFF image decoder
24  * @author Konstantin Shishkov
25  */
26
27 #include "config.h"
28 #if CONFIG_ZLIB
29 #include <zlib.h>
30 #endif
31
32 #include "libavutil/attributes.h"
33 #include "libavutil/avstring.h"
34 #include "libavutil/intreadwrite.h"
35 #include "libavutil/imgutils.h"
36 #include "avcodec.h"
37 #include "bytestream.h"
38 #include "faxcompr.h"
39 #include "internal.h"
40 #include "lzw.h"
41 #include "mathops.h"
42 #include "tiff.h"
43 #include "tiff_data.h"
44 #include "thread.h"
45
46 typedef struct TiffContext {
47     AVCodecContext *avctx;
48     GetByteContext gb;
49
50     int width, height;
51     unsigned int bpp, bppcount;
52     uint32_t palette[256];
53     int palette_is_set;
54     int le;
55     enum TiffCompr compr;
56     enum TiffPhotometric photometric;
57     int planar;
58     int subsampling[2];
59     int fax_opts;
60     int predictor;
61     int fill_order;
62     uint32_t res[4];
63
64     int strips, rps, sstype;
65     int sot;
66     int stripsizesoff, stripsize, stripoff, strippos;
67     LZWState *lzw;
68
69     uint8_t *deinvert_buf;
70     int deinvert_buf_size;
71
72     int geotag_count;
73     TiffGeoTag *geotags;
74 } TiffContext;
75
76 static void free_geotags(TiffContext *const s)
77 {
78     int i;
79     for (i = 0; i < s->geotag_count; i++) {
80         if (s->geotags[i].val)
81             av_freep(&s->geotags[i].val);
82     }
83     av_freep(&s->geotags);
84     s->geotag_count = 0;
85 }
86
87 #define RET_GEOKEY(TYPE, array, element)\
88     if (key >= TIFF_##TYPE##_KEY_ID_OFFSET &&\
89         key - TIFF_##TYPE##_KEY_ID_OFFSET < FF_ARRAY_ELEMS(ff_tiff_##array##_name_type_map))\
90         return ff_tiff_##array##_name_type_map[key - TIFF_##TYPE##_KEY_ID_OFFSET].element;
91
92 static const char *get_geokey_name(int key)
93 {
94     RET_GEOKEY(VERT, vert, name);
95     RET_GEOKEY(PROJ, proj, name);
96     RET_GEOKEY(GEOG, geog, name);
97     RET_GEOKEY(CONF, conf, name);
98
99     return NULL;
100 }
101
102 static int get_geokey_type(int key)
103 {
104     RET_GEOKEY(VERT, vert, type);
105     RET_GEOKEY(PROJ, proj, type);
106     RET_GEOKEY(GEOG, geog, type);
107     RET_GEOKEY(CONF, conf, type);
108
109     return AVERROR_INVALIDDATA;
110 }
111
112 static int cmp_id_key(const void *id, const void *k)
113 {
114     return *(const int*)id - ((const TiffGeoTagKeyName*)k)->key;
115 }
116
117 static const char *search_keyval(const TiffGeoTagKeyName *keys, int n, int id)
118 {
119     TiffGeoTagKeyName *r = bsearch(&id, keys, n, sizeof(keys[0]), cmp_id_key);
120     if(r)
121         return r->name;
122
123     return NULL;
124 }
125
126 static char *get_geokey_val(int key, int val)
127 {
128     char *ap;
129
130     if (val == TIFF_GEO_KEY_UNDEFINED)
131         return av_strdup("undefined");
132     if (val == TIFF_GEO_KEY_USER_DEFINED)
133         return av_strdup("User-Defined");
134
135 #define RET_GEOKEY_VAL(TYPE, array)\
136     if (val >= TIFF_##TYPE##_OFFSET &&\
137         val - TIFF_##TYPE##_OFFSET < FF_ARRAY_ELEMS(ff_tiff_##array##_codes))\
138         return av_strdup(ff_tiff_##array##_codes[val - TIFF_##TYPE##_OFFSET]);
139
140     switch (key) {
141     case TIFF_GT_MODEL_TYPE_GEOKEY:
142         RET_GEOKEY_VAL(GT_MODEL_TYPE, gt_model_type);
143         break;
144     case TIFF_GT_RASTER_TYPE_GEOKEY:
145         RET_GEOKEY_VAL(GT_RASTER_TYPE, gt_raster_type);
146         break;
147     case TIFF_GEOG_LINEAR_UNITS_GEOKEY:
148     case TIFF_PROJ_LINEAR_UNITS_GEOKEY:
149     case TIFF_VERTICAL_UNITS_GEOKEY:
150         RET_GEOKEY_VAL(LINEAR_UNIT, linear_unit);
151         break;
152     case TIFF_GEOG_ANGULAR_UNITS_GEOKEY:
153     case TIFF_GEOG_AZIMUTH_UNITS_GEOKEY:
154         RET_GEOKEY_VAL(ANGULAR_UNIT, angular_unit);
155         break;
156     case TIFF_GEOGRAPHIC_TYPE_GEOKEY:
157         RET_GEOKEY_VAL(GCS_TYPE, gcs_type);
158         RET_GEOKEY_VAL(GCSE_TYPE, gcse_type);
159         break;
160     case TIFF_GEOG_GEODETIC_DATUM_GEOKEY:
161         RET_GEOKEY_VAL(GEODETIC_DATUM, geodetic_datum);
162         RET_GEOKEY_VAL(GEODETIC_DATUM_E, geodetic_datum_e);
163         break;
164     case TIFF_GEOG_ELLIPSOID_GEOKEY:
165         RET_GEOKEY_VAL(ELLIPSOID, ellipsoid);
166         break;
167     case TIFF_GEOG_PRIME_MERIDIAN_GEOKEY:
168         RET_GEOKEY_VAL(PRIME_MERIDIAN, prime_meridian);
169         break;
170     case TIFF_PROJECTED_CS_TYPE_GEOKEY:
171         ap = av_strdup(search_keyval(ff_tiff_proj_cs_type_codes, FF_ARRAY_ELEMS(ff_tiff_proj_cs_type_codes), val));
172         if(ap) return ap;
173         break;
174     case TIFF_PROJECTION_GEOKEY:
175         ap = av_strdup(search_keyval(ff_tiff_projection_codes, FF_ARRAY_ELEMS(ff_tiff_projection_codes), val));
176         if(ap) return ap;
177         break;
178     case TIFF_PROJ_COORD_TRANS_GEOKEY:
179         RET_GEOKEY_VAL(COORD_TRANS, coord_trans);
180         break;
181     case TIFF_VERTICAL_CS_TYPE_GEOKEY:
182         RET_GEOKEY_VAL(VERT_CS, vert_cs);
183         RET_GEOKEY_VAL(ORTHO_VERT_CS, ortho_vert_cs);
184         break;
185
186     }
187
188     ap = av_malloc(14);
189     if (ap)
190         snprintf(ap, 14, "Unknown-%d", val);
191     return ap;
192 }
193
194 static char *doubles2str(double *dp, int count, const char *sep)
195 {
196     int i;
197     char *ap, *ap0;
198     uint64_t component_len;
199     if (!sep) sep = ", ";
200     component_len = 24LL + strlen(sep);
201     if (count >= (INT_MAX - 1)/component_len)
202         return NULL;
203     ap = av_malloc(component_len * count + 1);
204     if (!ap)
205         return NULL;
206     ap0   = ap;
207     ap[0] = '\0';
208     for (i = 0; i < count; i++) {
209         unsigned l = snprintf(ap, component_len, "%.15g%s", dp[i], sep);
210         if(l >= component_len) {
211             av_free(ap0);
212             return NULL;
213         }
214         ap += l;
215     }
216     ap0[strlen(ap0) - strlen(sep)] = '\0';
217     return ap0;
218 }
219
220 static int add_metadata(int count, int type,
221                         const char *name, const char *sep, TiffContext *s, AVFrame *frame)
222 {
223     switch(type) {
224     case TIFF_DOUBLE: return ff_tadd_doubles_metadata(count, name, sep, &s->gb, s->le, avpriv_frame_get_metadatap(frame));
225     case TIFF_SHORT : return ff_tadd_shorts_metadata(count, name, sep, &s->gb, s->le, 0, avpriv_frame_get_metadatap(frame));
226     case TIFF_STRING: return ff_tadd_string_metadata(count, name, &s->gb, s->le, avpriv_frame_get_metadatap(frame));
227     default         : return AVERROR_INVALIDDATA;
228     };
229 }
230
231 static void av_always_inline horizontal_fill(unsigned int bpp, uint8_t* dst,
232                                              int usePtr, const uint8_t *src,
233                                              uint8_t c, int width, int offset)
234 {
235     switch (bpp) {
236     case 1:
237         while (--width >= 0) {
238             dst[(width+offset)*8+7] = (usePtr ? src[width] : c)      & 0x1;
239             dst[(width+offset)*8+6] = (usePtr ? src[width] : c) >> 1 & 0x1;
240             dst[(width+offset)*8+5] = (usePtr ? src[width] : c) >> 2 & 0x1;
241             dst[(width+offset)*8+4] = (usePtr ? src[width] : c) >> 3 & 0x1;
242             dst[(width+offset)*8+3] = (usePtr ? src[width] : c) >> 4 & 0x1;
243             dst[(width+offset)*8+2] = (usePtr ? src[width] : c) >> 5 & 0x1;
244             dst[(width+offset)*8+1] = (usePtr ? src[width] : c) >> 6 & 0x1;
245             dst[(width+offset)*8+0] = (usePtr ? src[width] : c) >> 7;
246         }
247         break;
248     case 2:
249         while (--width >= 0) {
250             dst[(width+offset)*4+3] = (usePtr ? src[width] : c) & 0x3;
251             dst[(width+offset)*4+2] = (usePtr ? src[width] : c) >> 2 & 0x3;
252             dst[(width+offset)*4+1] = (usePtr ? src[width] : c) >> 4 & 0x3;
253             dst[(width+offset)*4+0] = (usePtr ? src[width] : c) >> 6;
254         }
255         break;
256     case 4:
257         while (--width >= 0) {
258             dst[(width+offset)*2+1] = (usePtr ? src[width] : c) & 0xF;
259             dst[(width+offset)*2+0] = (usePtr ? src[width] : c) >> 4;
260         }
261         break;
262     default:
263         if (usePtr) {
264             memcpy(dst + offset, src, width);
265         } else {
266             memset(dst + offset, c, width);
267         }
268     }
269 }
270
271 static int deinvert_buffer(TiffContext *s, const uint8_t *src, int size)
272 {
273     int i;
274
275     av_fast_padded_malloc(&s->deinvert_buf, &s->deinvert_buf_size, size);
276     if (!s->deinvert_buf)
277         return AVERROR(ENOMEM);
278     for (i = 0; i < size; i++)
279         s->deinvert_buf[i] = ff_reverse[src[i]];
280
281     return 0;
282 }
283
284 #if CONFIG_ZLIB
285 static int tiff_uncompress(uint8_t *dst, unsigned long *len, const uint8_t *src,
286                            int size)
287 {
288     z_stream zstream = { 0 };
289     int zret;
290
291     zstream.next_in   = (uint8_t *)src;
292     zstream.avail_in  = size;
293     zstream.next_out  = dst;
294     zstream.avail_out = *len;
295     zret              = inflateInit(&zstream);
296     if (zret != Z_OK) {
297         av_log(NULL, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
298         return zret;
299     }
300     zret = inflate(&zstream, Z_SYNC_FLUSH);
301     inflateEnd(&zstream);
302     *len = zstream.total_out;
303     return zret == Z_STREAM_END ? Z_OK : zret;
304 }
305
306 static int tiff_unpack_zlib(TiffContext *s, uint8_t *dst, int stride,
307                             const uint8_t *src, int size,
308                             int width, int lines)
309 {
310     uint8_t *zbuf;
311     unsigned long outlen;
312     int ret, line;
313     outlen = width * lines;
314     zbuf   = av_malloc(outlen);
315     if (!zbuf)
316         return AVERROR(ENOMEM);
317     if (s->fill_order) {
318         if ((ret = deinvert_buffer(s, src, size)) < 0) {
319             av_free(zbuf);
320             return ret;
321         }
322         src = s->deinvert_buf;
323     }
324     ret = tiff_uncompress(zbuf, &outlen, src, size);
325     if (ret != Z_OK) {
326         av_log(s->avctx, AV_LOG_ERROR,
327                "Uncompressing failed (%lu of %lu) with error %d\n", outlen,
328                (unsigned long)width * lines, ret);
329         av_free(zbuf);
330         return AVERROR_UNKNOWN;
331     }
332     src = zbuf;
333     for (line = 0; line < lines; line++) {
334         if (s->bpp < 8 && s->avctx->pix_fmt == AV_PIX_FMT_PAL8) {
335             horizontal_fill(s->bpp, dst, 1, src, 0, width, 0);
336         } else {
337             memcpy(dst, src, width);
338         }
339         dst += stride;
340         src += width;
341     }
342     av_free(zbuf);
343     return 0;
344 }
345 #endif
346
347
348 static int tiff_unpack_fax(TiffContext *s, uint8_t *dst, int stride,
349                            const uint8_t *src, int size, int width, int lines)
350 {
351     int i, ret = 0;
352     int line;
353     uint8_t *src2 = av_malloc((unsigned)size +
354                               FF_INPUT_BUFFER_PADDING_SIZE);
355
356     if (!src2) {
357         av_log(s->avctx, AV_LOG_ERROR,
358                "Error allocating temporary buffer\n");
359         return AVERROR(ENOMEM);
360     }
361     if (s->fax_opts & 2) {
362         avpriv_request_sample(s->avctx, "Uncompressed fax mode");
363         av_free(src2);
364         return AVERROR_PATCHWELCOME;
365     }
366     if (!s->fill_order) {
367         memcpy(src2, src, size);
368     } else {
369         for (i = 0; i < size; i++)
370             src2[i] = ff_reverse[src[i]];
371     }
372     memset(src2 + size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
373     ret = ff_ccitt_unpack(s->avctx, src2, size, dst, lines, stride,
374                           s->compr, s->fax_opts);
375     if (s->bpp < 8 && s->avctx->pix_fmt == AV_PIX_FMT_PAL8)
376         for (line = 0; line < lines; line++) {
377             horizontal_fill(s->bpp, dst, 1, dst, 0, width, 0);
378             dst += stride;
379         }
380     av_free(src2);
381     return ret;
382 }
383
384 static int tiff_unpack_strip(TiffContext *s, uint8_t *dst, int stride,
385                              const uint8_t *src, int size, int lines)
386 {
387     PutByteContext pb;
388     int c, line, pixels, code, ret;
389     const uint8_t *ssrc = src;
390     int width = ((s->width * s->bpp) + 7) >> 3;
391
392     if (s->planar)
393         width /= s->bppcount;
394
395     if (size <= 0)
396         return AVERROR_INVALIDDATA;
397
398     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
399 #if CONFIG_ZLIB
400         return tiff_unpack_zlib(s, dst, stride, src, size, width, lines);
401 #else
402         av_log(s->avctx, AV_LOG_ERROR,
403                "zlib support not enabled, "
404                "deflate compression not supported\n");
405         return AVERROR(ENOSYS);
406 #endif
407     }
408     if (s->compr == TIFF_LZW) {
409         if (s->fill_order) {
410             if ((ret = deinvert_buffer(s, src, size)) < 0)
411                 return ret;
412             ssrc = src = s->deinvert_buf;
413         }
414         if (size > 1 && !src[0] && (src[1]&1)) {
415             av_log(s->avctx, AV_LOG_ERROR, "Old style LZW is unsupported\n");
416         }
417         if ((ret = ff_lzw_decode_init(s->lzw, 8, src, size, FF_LZW_TIFF)) < 0) {
418             av_log(s->avctx, AV_LOG_ERROR, "Error initializing LZW decoder\n");
419             return ret;
420         }
421         for (line = 0; line < lines; line++) {
422             pixels = ff_lzw_decode(s->lzw, dst, width);
423             if (pixels < width) {
424                 av_log(s->avctx, AV_LOG_ERROR, "Decoded only %i bytes of %i\n",
425                        pixels, width);
426                 return AVERROR_INVALIDDATA;
427             }
428             if (s->bpp < 8 && s->avctx->pix_fmt == AV_PIX_FMT_PAL8)
429                 horizontal_fill(s->bpp, dst, 1, dst, 0, width, 0);
430             dst += stride;
431         }
432         return 0;
433     }
434     if (s->compr == TIFF_CCITT_RLE ||
435         s->compr == TIFF_G3        ||
436         s->compr == TIFF_G4) {
437         return tiff_unpack_fax(s, dst, stride, src, size, width, lines);
438     }
439
440     bytestream2_init(&s->gb, src, size);
441     bytestream2_init_writer(&pb, dst, stride * lines);
442
443     for (line = 0; line < lines; line++) {
444         if (src - ssrc > size) {
445             av_log(s->avctx, AV_LOG_ERROR, "Source data overread\n");
446             return AVERROR_INVALIDDATA;
447         }
448
449         if (bytestream2_get_bytes_left(&s->gb) == 0 || bytestream2_get_eof(&pb))
450             break;
451         bytestream2_seek_p(&pb, stride * line, SEEK_SET);
452         switch (s->compr) {
453         case TIFF_RAW:
454             if (ssrc + size - src < width)
455                 return AVERROR_INVALIDDATA;
456
457             if (!s->fill_order) {
458                 horizontal_fill(s->bpp * (s->avctx->pix_fmt == AV_PIX_FMT_PAL8),
459                                 dst, 1, src, 0, width, 0);
460             } else {
461                 int i;
462                 for (i = 0; i < width; i++)
463                     dst[i] = ff_reverse[src[i]];
464             }
465             src += width;
466             break;
467         case TIFF_PACKBITS:
468             for (pixels = 0; pixels < width;) {
469                 if (ssrc + size - src < 2) {
470                     av_log(s->avctx, AV_LOG_ERROR, "Read went out of bounds\n");
471                     return AVERROR_INVALIDDATA;
472                 }
473                 code = s->fill_order ? (int8_t) ff_reverse[*src++]: (int8_t) *src++;
474                 if (code >= 0) {
475                     code++;
476                     if (pixels + code > width ||
477                         ssrc + size - src < code) {
478                         av_log(s->avctx, AV_LOG_ERROR,
479                                "Copy went out of bounds\n");
480                         return AVERROR_INVALIDDATA;
481                     }
482                     horizontal_fill(s->bpp * (s->avctx->pix_fmt == AV_PIX_FMT_PAL8),
483                                     dst, 1, src, 0, code, pixels);
484                     src    += code;
485                     pixels += code;
486                 } else if (code != -128) { // -127..-1
487                     code = (-code) + 1;
488                     if (pixels + code > width) {
489                         av_log(s->avctx, AV_LOG_ERROR,
490                                "Run went out of bounds\n");
491                         return AVERROR_INVALIDDATA;
492                     }
493                     c = *src++;
494                     horizontal_fill(s->bpp * (s->avctx->pix_fmt == AV_PIX_FMT_PAL8),
495                                     dst, 0, NULL, c, code, pixels);
496                     pixels += code;
497                 }
498             }
499             if (s->fill_order) {
500                 int i;
501                 for (i = 0; i < width; i++)
502                     dst[i] = ff_reverse[dst[i]];
503             }
504             break;
505         }
506         dst += stride;
507     }
508     return 0;
509 }
510
511 static int init_image(TiffContext *s, ThreadFrame *frame)
512 {
513     int i, ret;
514     uint32_t *pal;
515
516     switch (s->planar * 1000 + s->bpp * 10 + s->bppcount) {
517     case 11:
518         if (!s->palette_is_set) {
519             s->avctx->pix_fmt = AV_PIX_FMT_MONOBLACK;
520             break;
521         }
522     case 21:
523     case 41:
524     case 81:
525         s->avctx->pix_fmt = AV_PIX_FMT_PAL8;
526         break;
527     case 243:
528         s->avctx->pix_fmt = AV_PIX_FMT_RGB24;
529         break;
530     case 161:
531         s->avctx->pix_fmt = s->le ? AV_PIX_FMT_GRAY16LE : AV_PIX_FMT_GRAY16BE;
532         break;
533     case 162:
534         s->avctx->pix_fmt = AV_PIX_FMT_GRAY8A;
535         break;
536     case 324:
537         s->avctx->pix_fmt = AV_PIX_FMT_RGBA;
538         break;
539     case 483:
540         s->avctx->pix_fmt = s->le ? AV_PIX_FMT_RGB48LE  : AV_PIX_FMT_RGB48BE;
541         break;
542     case 644:
543         s->avctx->pix_fmt = s->le ? AV_PIX_FMT_RGBA64LE  : AV_PIX_FMT_RGBA64BE;
544         break;
545     case 1243:
546         s->avctx->pix_fmt = AV_PIX_FMT_GBRP;
547         break;
548     case 1324:
549         s->avctx->pix_fmt = AV_PIX_FMT_GBRAP;
550         break;
551     case 1483:
552         s->avctx->pix_fmt = s->le ? AV_PIX_FMT_GBRP16LE : AV_PIX_FMT_GBRP16BE;
553         break;
554     case 1644:
555         s->avctx->pix_fmt = s->le ? AV_PIX_FMT_GBRAP16LE : AV_PIX_FMT_GBRAP16BE;
556         break;
557     default:
558         av_log(s->avctx, AV_LOG_ERROR,
559                "This format is not supported (bpp=%d, bppcount=%d)\n",
560                s->bpp, s->bppcount);
561         return AVERROR_INVALIDDATA;
562     }
563     if (s->width != s->avctx->width || s->height != s->avctx->height) {
564         ret = ff_set_dimensions(s->avctx, s->width, s->height);
565         if (ret < 0)
566             return ret;
567     }
568     if ((ret = ff_thread_get_buffer(s->avctx, frame, 0)) < 0)
569         return ret;
570     if (s->avctx->pix_fmt == AV_PIX_FMT_PAL8) {
571         if (s->palette_is_set) {
572             memcpy(frame->f->data[1], s->palette, sizeof(s->palette));
573         } else {
574             /* make default grayscale pal */
575             pal = (uint32_t *) frame->f->data[1];
576             for (i = 0; i < 1<<s->bpp; i++)
577                 pal[i] = 0xFFU << 24 | i * 255 / ((1<<s->bpp) - 1) * 0x010101;
578         }
579     }
580     return 0;
581 }
582
583 static void set_sar(TiffContext *s, unsigned tag, unsigned num, unsigned den)
584 {
585     int offset = tag == TIFF_YRES ? 2 : 0;
586     s->res[offset++] = num;
587     s->res[offset]   = den;
588     if (s->res[0] && s->res[1] && s->res[2] && s->res[3])
589         av_reduce(&s->avctx->sample_aspect_ratio.num, &s->avctx->sample_aspect_ratio.den,
590                   s->res[2] * (uint64_t)s->res[1], s->res[0] * (uint64_t)s->res[3], INT32_MAX);
591 }
592
593 static int tiff_decode_tag(TiffContext *s, AVFrame *frame)
594 {
595     unsigned tag, type, count, off, value = 0, value2 = 0;
596     int i, start;
597     int pos;
598     int ret;
599     double *dp;
600
601     ret = ff_tread_tag(&s->gb, s->le, &tag, &type, &count, &start);
602     if (ret < 0) {
603         goto end;
604     }
605
606     off = bytestream2_tell(&s->gb);
607     if (count == 1) {
608         switch (type) {
609         case TIFF_BYTE:
610         case TIFF_SHORT:
611         case TIFF_LONG:
612             value = ff_tget(&s->gb, type, s->le);
613             break;
614         case TIFF_RATIONAL:
615             value  = ff_tget(&s->gb, TIFF_LONG, s->le);
616             value2 = ff_tget(&s->gb, TIFF_LONG, s->le);
617             break;
618         case TIFF_STRING:
619             if (count <= 4) {
620                 break;
621             }
622         default:
623             value = UINT_MAX;
624         }
625     }
626
627     switch (tag) {
628     case TIFF_WIDTH:
629         s->width = value;
630         break;
631     case TIFF_HEIGHT:
632         s->height = value;
633         break;
634     case TIFF_BPP:
635         s->bppcount = count;
636         if (count > 4) {
637             av_log(s->avctx, AV_LOG_ERROR,
638                    "This format is not supported (bpp=%d, %d components)\n",
639                    s->bpp, count);
640             return AVERROR_INVALIDDATA;
641         }
642         if (count == 1)
643             s->bpp = value;
644         else {
645             switch (type) {
646             case TIFF_BYTE:
647             case TIFF_SHORT:
648             case TIFF_LONG:
649                 s->bpp = 0;
650                 if (bytestream2_get_bytes_left(&s->gb) < type_sizes[type] * count)
651                     return AVERROR_INVALIDDATA;
652                 for (i = 0; i < count; i++)
653                     s->bpp += ff_tget(&s->gb, type, s->le);
654                 break;
655             default:
656                 s->bpp = -1;
657             }
658         }
659         break;
660     case TIFF_SAMPLES_PER_PIXEL:
661         if (count != 1) {
662             av_log(s->avctx, AV_LOG_ERROR,
663                    "Samples per pixel requires a single value, many provided\n");
664             return AVERROR_INVALIDDATA;
665         }
666         if (value > 4U) {
667             av_log(s->avctx, AV_LOG_ERROR,
668                    "Samples per pixel %d is too large\n", value);
669             return AVERROR_INVALIDDATA;
670         }
671         if (s->bppcount == 1)
672             s->bpp *= value;
673         s->bppcount = value;
674         break;
675     case TIFF_COMPR:
676         s->compr     = value;
677         s->predictor = 0;
678         switch (s->compr) {
679         case TIFF_RAW:
680         case TIFF_PACKBITS:
681         case TIFF_LZW:
682         case TIFF_CCITT_RLE:
683             break;
684         case TIFF_G3:
685         case TIFF_G4:
686             s->fax_opts = 0;
687             break;
688         case TIFF_DEFLATE:
689         case TIFF_ADOBE_DEFLATE:
690 #if CONFIG_ZLIB
691             break;
692 #else
693             av_log(s->avctx, AV_LOG_ERROR, "Deflate: ZLib not compiled in\n");
694             return AVERROR(ENOSYS);
695 #endif
696         case TIFF_JPEG:
697         case TIFF_NEWJPEG:
698             avpriv_report_missing_feature(s->avctx, "JPEG compression");
699             return AVERROR_PATCHWELCOME;
700         default:
701             av_log(s->avctx, AV_LOG_ERROR, "Unknown compression method %i\n",
702                    s->compr);
703             return AVERROR_INVALIDDATA;
704         }
705         break;
706     case TIFF_ROWSPERSTRIP:
707         if (!value || (type == TIFF_LONG && value == UINT_MAX))
708             value = s->height;
709         s->rps = FFMIN(value, s->height);
710         break;
711     case TIFF_STRIP_OFFS:
712         if (count == 1) {
713             s->strippos = 0;
714             s->stripoff = value;
715         } else
716             s->strippos = off;
717         s->strips = count;
718         if (s->strips == 1)
719             s->rps = s->height;
720         s->sot = type;
721         break;
722     case TIFF_STRIP_SIZE:
723         if (count == 1) {
724             s->stripsizesoff = 0;
725             s->stripsize     = value;
726             s->strips        = 1;
727         } else {
728             s->stripsizesoff = off;
729         }
730         s->strips = count;
731         s->sstype = type;
732         break;
733     case TIFF_XRES:
734     case TIFF_YRES:
735         set_sar(s, tag, value, value2);
736         break;
737     case TIFF_TILE_BYTE_COUNTS:
738     case TIFF_TILE_LENGTH:
739     case TIFF_TILE_OFFSETS:
740     case TIFF_TILE_WIDTH:
741         av_log(s->avctx, AV_LOG_ERROR, "Tiled images are not supported\n");
742         return AVERROR_PATCHWELCOME;
743         break;
744     case TIFF_PREDICTOR:
745         s->predictor = value;
746         break;
747     case TIFF_PHOTOMETRIC:
748         switch (value) {
749         case TIFF_PHOTOMETRIC_WHITE_IS_ZERO:
750         case TIFF_PHOTOMETRIC_BLACK_IS_ZERO:
751         case TIFF_PHOTOMETRIC_RGB:
752         case TIFF_PHOTOMETRIC_PALETTE:
753             s->photometric = value;
754             break;
755         case TIFF_PHOTOMETRIC_ALPHA_MASK:
756         case TIFF_PHOTOMETRIC_SEPARATED:
757         case TIFF_PHOTOMETRIC_YCBCR:
758         case TIFF_PHOTOMETRIC_CIE_LAB:
759         case TIFF_PHOTOMETRIC_ICC_LAB:
760         case TIFF_PHOTOMETRIC_ITU_LAB:
761         case TIFF_PHOTOMETRIC_CFA:
762         case TIFF_PHOTOMETRIC_LOG_L:
763         case TIFF_PHOTOMETRIC_LOG_LUV:
764         case TIFF_PHOTOMETRIC_LINEAR_RAW:
765             avpriv_report_missing_feature(s->avctx,
766                                           "PhotometricInterpretation 0x%04X",
767                                           value);
768             return AVERROR_PATCHWELCOME;
769         default:
770             av_log(s->avctx, AV_LOG_ERROR, "PhotometricInterpretation %u is "
771                    "unknown\n", value);
772             return AVERROR_INVALIDDATA;
773         }
774         break;
775     case TIFF_FILL_ORDER:
776         if (value < 1 || value > 2) {
777             av_log(s->avctx, AV_LOG_ERROR,
778                    "Unknown FillOrder value %d, trying default one\n", value);
779             value = 1;
780         }
781         s->fill_order = value - 1;
782         break;
783     case TIFF_PAL: {
784         GetByteContext pal_gb[3];
785         off = type_sizes[type];
786         if (count / 3 > 256 ||
787             bytestream2_get_bytes_left(&s->gb) < count / 3 * off * 3)
788             return AVERROR_INVALIDDATA;
789
790         pal_gb[0] = pal_gb[1] = pal_gb[2] = s->gb;
791         bytestream2_skip(&pal_gb[1], count / 3 * off);
792         bytestream2_skip(&pal_gb[2], count / 3 * off * 2);
793
794         off = (type_sizes[type] - 1) << 3;
795         for (i = 0; i < count / 3; i++) {
796             uint32_t p = 0xFF000000;
797             p |= (ff_tget(&pal_gb[0], type, s->le) >> off) << 16;
798             p |= (ff_tget(&pal_gb[1], type, s->le) >> off) << 8;
799             p |=  ff_tget(&pal_gb[2], type, s->le) >> off;
800             s->palette[i] = p;
801         }
802         s->palette_is_set = 1;
803         break;
804     }
805     case TIFF_PLANAR:
806         s->planar = value == 2;
807         break;
808     case TIFF_YCBCR_SUBSAMPLING:
809         if (count != 2) {
810             av_log(s->avctx, AV_LOG_ERROR, "subsample count invalid\n");
811             return AVERROR_INVALIDDATA;
812         }
813         for (i = 0; i < count; i++)
814             s->subsampling[i] = ff_tget(&s->gb, type, s->le);
815         break;
816     case TIFF_T4OPTIONS:
817         if (s->compr == TIFF_G3)
818             s->fax_opts = value;
819         break;
820     case TIFF_T6OPTIONS:
821         if (s->compr == TIFF_G4)
822             s->fax_opts = value;
823         break;
824 #define ADD_METADATA(count, name, sep)\
825     if ((ret = add_metadata(count, type, name, sep, s, frame)) < 0) {\
826         av_log(s->avctx, AV_LOG_ERROR, "Error allocating temporary buffer\n");\
827         goto end;\
828     }
829     case TIFF_MODEL_PIXEL_SCALE:
830         ADD_METADATA(count, "ModelPixelScaleTag", NULL);
831         break;
832     case TIFF_MODEL_TRANSFORMATION:
833         ADD_METADATA(count, "ModelTransformationTag", NULL);
834         break;
835     case TIFF_MODEL_TIEPOINT:
836         ADD_METADATA(count, "ModelTiepointTag", NULL);
837         break;
838     case TIFF_GEO_KEY_DIRECTORY:
839         ADD_METADATA(1, "GeoTIFF_Version", NULL);
840         ADD_METADATA(2, "GeoTIFF_Key_Revision", ".");
841         s->geotag_count   = ff_tget_short(&s->gb, s->le);
842         if (s->geotag_count > count / 4 - 1) {
843             s->geotag_count = count / 4 - 1;
844             av_log(s->avctx, AV_LOG_WARNING, "GeoTIFF key directory buffer shorter than specified\n");
845         }
846         if (bytestream2_get_bytes_left(&s->gb) < s->geotag_count * sizeof(int16_t) * 4) {
847             s->geotag_count = 0;
848             return -1;
849         }
850         s->geotags = av_mallocz_array(s->geotag_count, sizeof(TiffGeoTag));
851         if (!s->geotags) {
852             av_log(s->avctx, AV_LOG_ERROR, "Error allocating temporary buffer\n");
853             s->geotag_count = 0;
854             goto end;
855         }
856         for (i = 0; i < s->geotag_count; i++) {
857             s->geotags[i].key    = ff_tget_short(&s->gb, s->le);
858             s->geotags[i].type   = ff_tget_short(&s->gb, s->le);
859             s->geotags[i].count  = ff_tget_short(&s->gb, s->le);
860
861             if (!s->geotags[i].type)
862                 s->geotags[i].val  = get_geokey_val(s->geotags[i].key, ff_tget_short(&s->gb, s->le));
863             else
864                 s->geotags[i].offset = ff_tget_short(&s->gb, s->le);
865         }
866         break;
867     case TIFF_GEO_DOUBLE_PARAMS:
868         if (count >= INT_MAX / sizeof(int64_t))
869             return AVERROR_INVALIDDATA;
870         if (bytestream2_get_bytes_left(&s->gb) < count * sizeof(int64_t))
871             return AVERROR_INVALIDDATA;
872         dp = av_malloc_array(count, sizeof(double));
873         if (!dp) {
874             av_log(s->avctx, AV_LOG_ERROR, "Error allocating temporary buffer\n");
875             goto end;
876         }
877         for (i = 0; i < count; i++)
878             dp[i] = ff_tget_double(&s->gb, s->le);
879         for (i = 0; i < s->geotag_count; i++) {
880             if (s->geotags[i].type == TIFF_GEO_DOUBLE_PARAMS) {
881                 if (s->geotags[i].count == 0
882                     || s->geotags[i].offset + s->geotags[i].count > count) {
883                     av_log(s->avctx, AV_LOG_WARNING, "Invalid GeoTIFF key %d\n", s->geotags[i].key);
884                 } else {
885                     char *ap = doubles2str(&dp[s->geotags[i].offset], s->geotags[i].count, ", ");
886                     if (!ap) {
887                         av_log(s->avctx, AV_LOG_ERROR, "Error allocating temporary buffer\n");
888                         av_freep(&dp);
889                         return AVERROR(ENOMEM);
890                     }
891                     s->geotags[i].val = ap;
892                 }
893             }
894         }
895         av_freep(&dp);
896         break;
897     case TIFF_GEO_ASCII_PARAMS:
898         pos = bytestream2_tell(&s->gb);
899         for (i = 0; i < s->geotag_count; i++) {
900             if (s->geotags[i].type == TIFF_GEO_ASCII_PARAMS) {
901                 if (s->geotags[i].count == 0
902                     || s->geotags[i].offset +  s->geotags[i].count > count) {
903                     av_log(s->avctx, AV_LOG_WARNING, "Invalid GeoTIFF key %d\n", s->geotags[i].key);
904                 } else {
905                     char *ap;
906
907                     bytestream2_seek(&s->gb, pos + s->geotags[i].offset, SEEK_SET);
908                     if (bytestream2_get_bytes_left(&s->gb) < s->geotags[i].count)
909                         return AVERROR_INVALIDDATA;
910                     ap = av_malloc(s->geotags[i].count);
911                     if (!ap) {
912                         av_log(s->avctx, AV_LOG_ERROR, "Error allocating temporary buffer\n");
913                         return AVERROR(ENOMEM);
914                     }
915                     bytestream2_get_bufferu(&s->gb, ap, s->geotags[i].count);
916                     ap[s->geotags[i].count - 1] = '\0'; //replace the "|" delimiter with a 0 byte
917                     s->geotags[i].val = ap;
918                 }
919             }
920         }
921         break;
922     case TIFF_ARTIST:
923         ADD_METADATA(count, "artist", NULL);
924         break;
925     case TIFF_COPYRIGHT:
926         ADD_METADATA(count, "copyright", NULL);
927         break;
928     case TIFF_DATE:
929         ADD_METADATA(count, "date", NULL);
930         break;
931     case TIFF_DOCUMENT_NAME:
932         ADD_METADATA(count, "document_name", NULL);
933         break;
934     case TIFF_HOST_COMPUTER:
935         ADD_METADATA(count, "computer", NULL);
936         break;
937     case TIFF_IMAGE_DESCRIPTION:
938         ADD_METADATA(count, "description", NULL);
939         break;
940     case TIFF_MAKE:
941         ADD_METADATA(count, "make", NULL);
942         break;
943     case TIFF_MODEL:
944         ADD_METADATA(count, "model", NULL);
945         break;
946     case TIFF_PAGE_NAME:
947         ADD_METADATA(count, "page_name", NULL);
948         break;
949     case TIFF_PAGE_NUMBER:
950         ADD_METADATA(count, "page_number", " / ");
951         break;
952     case TIFF_SOFTWARE_NAME:
953         ADD_METADATA(count, "software", NULL);
954         break;
955     default:
956         if (s->avctx->err_recognition & AV_EF_EXPLODE) {
957             av_log(s->avctx, AV_LOG_ERROR,
958                    "Unknown or unsupported tag %d/0X%0X\n",
959                    tag, tag);
960             return AVERROR_INVALIDDATA;
961         }
962     }
963 end:
964     bytestream2_seek(&s->gb, start, SEEK_SET);
965     return 0;
966 }
967
968 static int decode_frame(AVCodecContext *avctx,
969                         void *data, int *got_frame, AVPacket *avpkt)
970 {
971     TiffContext *const s = avctx->priv_data;
972     AVFrame *const p = data;
973     ThreadFrame frame = { .f = data };
974     unsigned off;
975     int le, ret, plane, planes;
976     int i, j, entries, stride;
977     unsigned soff, ssize;
978     uint8_t *dst;
979     GetByteContext stripsizes;
980     GetByteContext stripdata;
981
982     bytestream2_init(&s->gb, avpkt->data, avpkt->size);
983
984     // parse image header
985     if ((ret = ff_tdecode_header(&s->gb, &le, &off))) {
986         av_log(avctx, AV_LOG_ERROR, "Invalid TIFF header\n");
987         return ret;
988     } else if (off >= UINT_MAX - 14 || avpkt->size < off + 14) {
989         av_log(avctx, AV_LOG_ERROR, "IFD offset is greater than image size\n");
990         return AVERROR_INVALIDDATA;
991     }
992     s->le          = le;
993     // TIFF_BPP is not a required tag and defaults to 1
994     s->bppcount    = s->bpp = 1;
995     s->photometric = TIFF_PHOTOMETRIC_NONE;
996     s->compr       = TIFF_RAW;
997     s->fill_order  = 0;
998     free_geotags(s);
999
1000     // Reset these offsets so we can tell if they were set this frame
1001     s->stripsizesoff = s->strippos = 0;
1002     /* parse image file directory */
1003     bytestream2_seek(&s->gb, off, SEEK_SET);
1004     entries = ff_tget_short(&s->gb, le);
1005     if (bytestream2_get_bytes_left(&s->gb) < entries * 12)
1006         return AVERROR_INVALIDDATA;
1007     for (i = 0; i < entries; i++) {
1008         if ((ret = tiff_decode_tag(s, p)) < 0)
1009             return ret;
1010     }
1011
1012     for (i = 0; i<s->geotag_count; i++) {
1013         const char *keyname = get_geokey_name(s->geotags[i].key);
1014         if (!keyname) {
1015             av_log(avctx, AV_LOG_WARNING, "Unknown or unsupported GeoTIFF key %d\n", s->geotags[i].key);
1016             continue;
1017         }
1018         if (get_geokey_type(s->geotags[i].key) != s->geotags[i].type) {
1019             av_log(avctx, AV_LOG_WARNING, "Type of GeoTIFF key %d is wrong\n", s->geotags[i].key);
1020             continue;
1021         }
1022         ret = av_dict_set(avpriv_frame_get_metadatap(p), keyname, s->geotags[i].val, 0);
1023         if (ret<0) {
1024             av_log(avctx, AV_LOG_ERROR, "Writing metadata with key '%s' failed\n", keyname);
1025             return ret;
1026         }
1027     }
1028
1029     if (!s->strippos && !s->stripoff) {
1030         av_log(avctx, AV_LOG_ERROR, "Image data is missing\n");
1031         return AVERROR_INVALIDDATA;
1032     }
1033     /* now we have the data and may start decoding */
1034     if ((ret = init_image(s, &frame)) < 0)
1035         return ret;
1036
1037     if (s->strips == 1 && !s->stripsize) {
1038         av_log(avctx, AV_LOG_WARNING, "Image data size missing\n");
1039         s->stripsize = avpkt->size - s->stripoff;
1040     }
1041
1042     if (s->stripsizesoff) {
1043         if (s->stripsizesoff >= (unsigned)avpkt->size)
1044             return AVERROR_INVALIDDATA;
1045         bytestream2_init(&stripsizes, avpkt->data + s->stripsizesoff,
1046                          avpkt->size - s->stripsizesoff);
1047     }
1048     if (s->strippos) {
1049         if (s->strippos >= (unsigned)avpkt->size)
1050             return AVERROR_INVALIDDATA;
1051         bytestream2_init(&stripdata, avpkt->data + s->strippos,
1052                          avpkt->size - s->strippos);
1053     }
1054
1055     if (s->rps <= 0) {
1056         av_log(avctx, AV_LOG_ERROR, "rps %d invalid\n", s->rps);
1057         return AVERROR_INVALIDDATA;
1058     }
1059
1060     planes = s->planar ? s->bppcount : 1;
1061     for (plane = 0; plane < planes; plane++) {
1062         stride = p->linesize[plane];
1063         dst    = p->data[plane];
1064     for (i = 0; i < s->height; i += s->rps) {
1065         if (s->stripsizesoff)
1066             ssize = ff_tget(&stripsizes, s->sstype, le);
1067         else
1068             ssize = s->stripsize;
1069
1070         if (s->strippos)
1071             soff = ff_tget(&stripdata, s->sot, le);
1072         else
1073             soff = s->stripoff;
1074
1075         if (soff > avpkt->size || ssize > avpkt->size - soff) {
1076             av_log(avctx, AV_LOG_ERROR, "Invalid strip size/offset\n");
1077             return AVERROR_INVALIDDATA;
1078         }
1079         if ((ret = tiff_unpack_strip(s, dst, stride, avpkt->data + soff, ssize,
1080                                      FFMIN(s->rps, s->height - i))) < 0) {
1081             if (avctx->err_recognition & AV_EF_EXPLODE)
1082                 return ret;
1083             break;
1084         }
1085         dst += s->rps * stride;
1086     }
1087     if (s->predictor == 2) {
1088         dst   = p->data[plane];
1089         soff  = s->bpp >> 3;
1090         if (s->planar)
1091             soff  = FFMAX(soff / s->bppcount, 1);
1092         ssize = s->width * soff;
1093         if (s->avctx->pix_fmt == AV_PIX_FMT_RGB48LE ||
1094             s->avctx->pix_fmt == AV_PIX_FMT_RGBA64LE ||
1095             s->avctx->pix_fmt == AV_PIX_FMT_GBRP16LE ||
1096             s->avctx->pix_fmt == AV_PIX_FMT_GBRAP16LE) {
1097             for (i = 0; i < s->height; i++) {
1098                 for (j = soff; j < ssize; j += 2)
1099                     AV_WL16(dst + j, AV_RL16(dst + j) + AV_RL16(dst + j - soff));
1100                 dst += stride;
1101             }
1102         } else if (s->avctx->pix_fmt == AV_PIX_FMT_RGB48BE ||
1103                    s->avctx->pix_fmt == AV_PIX_FMT_RGBA64BE ||
1104                    s->avctx->pix_fmt == AV_PIX_FMT_GBRP16BE ||
1105                    s->avctx->pix_fmt == AV_PIX_FMT_GBRAP16BE) {
1106             for (i = 0; i < s->height; i++) {
1107                 for (j = soff; j < ssize; j += 2)
1108                     AV_WB16(dst + j, AV_RB16(dst + j) + AV_RB16(dst + j - soff));
1109                 dst += stride;
1110             }
1111         } else {
1112             for (i = 0; i < s->height; i++) {
1113                 for (j = soff; j < ssize; j++)
1114                     dst[j] += dst[j - soff];
1115                 dst += stride;
1116             }
1117         }
1118     }
1119
1120     if (s->photometric == TIFF_PHOTOMETRIC_WHITE_IS_ZERO) {
1121         dst = p->data[plane];
1122         for (i = 0; i < s->height; i++) {
1123             for (j = 0; j < p->linesize[plane]; j++)
1124                 dst[j] = (s->avctx->pix_fmt == AV_PIX_FMT_PAL8 ? (1<<s->bpp) - 1 : 255) - dst[j];
1125             dst += stride;
1126         }
1127     }
1128     }
1129
1130     if (s->planar && s->bppcount > 2) {
1131         FFSWAP(uint8_t*, p->data[0],     p->data[2]);
1132         FFSWAP(int,      p->linesize[0], p->linesize[2]);
1133         FFSWAP(uint8_t*, p->data[0],     p->data[1]);
1134         FFSWAP(int,      p->linesize[0], p->linesize[1]);
1135     }
1136
1137     *got_frame = 1;
1138
1139     return avpkt->size;
1140 }
1141
1142 static av_cold int tiff_init(AVCodecContext *avctx)
1143 {
1144     TiffContext *s = avctx->priv_data;
1145
1146     s->width  = 0;
1147     s->height = 0;
1148     s->subsampling[0] =
1149     s->subsampling[1] = 1;
1150     s->avctx  = avctx;
1151     ff_lzw_decode_open(&s->lzw);
1152     ff_ccitt_unpack_init();
1153
1154     return 0;
1155 }
1156
1157 static av_cold int tiff_end(AVCodecContext *avctx)
1158 {
1159     TiffContext *const s = avctx->priv_data;
1160
1161     free_geotags(s);
1162
1163     ff_lzw_decode_close(&s->lzw);
1164     av_freep(&s->deinvert_buf);
1165     return 0;
1166 }
1167
1168 AVCodec ff_tiff_decoder = {
1169     .name           = "tiff",
1170     .long_name      = NULL_IF_CONFIG_SMALL("TIFF image"),
1171     .type           = AVMEDIA_TYPE_VIDEO,
1172     .id             = AV_CODEC_ID_TIFF,
1173     .priv_data_size = sizeof(TiffContext),
1174     .init           = tiff_init,
1175     .close          = tiff_end,
1176     .decode         = decode_frame,
1177     .init_thread_copy = ONLY_IF_THREADS_ENABLED(tiff_init),
1178     .capabilities   = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
1179 };