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