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