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