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