4l: TIFF stores short strings inside tag, do not interpret it is as an offset
[ffmpeg.git] / libavcodec / tiff.c
1 /*
2  * TIFF image decoder
3  * Copyright (c) 2006 Konstantin Shishkov
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * TIFF image decoder
24  * @file tiff.c
25  * @author Konstantin Shishkov
26  */
27 #include "avcodec.h"
28 #ifdef CONFIG_ZLIB
29 #include <zlib.h>
30 #endif
31 #include "lzw.h"
32 #include "tiff.h"
33
34
35 typedef struct TiffContext {
36     AVCodecContext *avctx;
37     AVFrame picture;
38
39     int width, height;
40     unsigned int bpp;
41     int le;
42     int compr;
43     int invert;
44
45     int strips, rps;
46     int sot;
47     const uint8_t* stripdata;
48     const uint8_t* stripsizes;
49     int stripsize, stripoff;
50     LZWState *lzw;
51 } TiffContext;
52
53 static int tget_short(const uint8_t **p, int le){
54     int v = le ? AV_RL16(*p) : AV_RB16(*p);
55     *p += 2;
56     return v;
57 }
58
59 static int tget_long(const uint8_t **p, int le){
60     int v = le ? AV_RL32(*p) : AV_RB32(*p);
61     *p += 4;
62     return v;
63 }
64
65 static int tget(const uint8_t **p, int type, int le){
66     switch(type){
67     case TIFF_BYTE : return *(*p)++;
68     case TIFF_SHORT: return tget_short(p, le);
69     case TIFF_LONG : return tget_long (p, le);
70     default        : return -1;
71     }
72 }
73
74 static int tiff_unpack_strip(TiffContext *s, uint8_t* dst, int stride, const uint8_t *src, int size, int lines){
75     int c, line, pixels, code;
76     const uint8_t *ssrc = src;
77     int width = s->width * (s->bpp / 8);
78 #ifdef CONFIG_ZLIB
79     uint8_t *zbuf; unsigned long outlen;
80
81     if(s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE){
82         outlen = width * lines;
83         zbuf = av_malloc(outlen);
84         if(uncompress(zbuf, &outlen, src, size) != Z_OK){
85             av_log(s->avctx, AV_LOG_ERROR, "Uncompressing failed (%lu of %lu)\n", outlen, (unsigned long)width * lines);
86             av_free(zbuf);
87             return -1;
88         }
89         src = zbuf;
90         for(line = 0; line < lines; line++){
91             memcpy(dst, src, width);
92             dst += stride;
93             src += width;
94         }
95         av_free(zbuf);
96         return 0;
97     }
98 #endif
99     if(s->compr == TIFF_LZW){
100         if(ff_lzw_decode_init(s->lzw, 8, src, size, FF_LZW_TIFF) < 0){
101             av_log(s->avctx, AV_LOG_ERROR, "Error initializing LZW decoder\n");
102             return -1;
103         }
104     }
105     for(line = 0; line < lines; line++){
106         if(src - ssrc > size){
107             av_log(s->avctx, AV_LOG_ERROR, "Source data overread\n");
108             return -1;
109         }
110         switch(s->compr){
111         case TIFF_RAW:
112             memcpy(dst, src, s->width * (s->bpp / 8));
113             src += s->width * (s->bpp / 8);
114             break;
115         case TIFF_PACKBITS:
116             for(pixels = 0; pixels < width;){
117                 code = (int8_t)*src++;
118                 if(code >= 0){
119                     code++;
120                     if(pixels + code > width){
121                         av_log(s->avctx, AV_LOG_ERROR, "Copy went out of bounds\n");
122                         return -1;
123                     }
124                     memcpy(dst + pixels, src, code);
125                     src += code;
126                     pixels += code;
127                 }else if(code != -128){ // -127..-1
128                     code = (-code) + 1;
129                     if(pixels + code > width){
130                         av_log(s->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
131                         return -1;
132                     }
133                     c = *src++;
134                     memset(dst + pixels, c, code);
135                     pixels += code;
136                 }
137             }
138             break;
139         case TIFF_LZW:
140             pixels = ff_lzw_decode(s->lzw, dst, width);
141             if(pixels < width){
142                 av_log(s->avctx, AV_LOG_ERROR, "Decoded only %i bytes of %i\n", pixels, width);
143                 return -1;
144             }
145             break;
146         }
147         dst += stride;
148     }
149     return 0;
150 }
151
152
153 static int tiff_decode_tag(TiffContext *s, const uint8_t *start, const uint8_t *buf, const uint8_t *end_buf, AVFrame *pic)
154 {
155     int tag, type, count, off, value = 0;
156     const uint8_t *src;
157     uint8_t *dst;
158     int i, j, ssize, soff, stride;
159     uint32_t *pal;
160     const uint8_t *rp, *gp, *bp;
161
162     tag = tget_short(&buf, s->le);
163     type = tget_short(&buf, s->le);
164     count = tget_long(&buf, s->le);
165     off = tget_long(&buf, s->le);
166
167     if(count == 1){
168         switch(type){
169         case TIFF_BYTE:
170         case TIFF_SHORT:
171             buf -= 4;
172             value = tget(&buf, type, s->le);
173             buf = NULL;
174             break;
175         case TIFF_LONG:
176             value = off;
177             buf = NULL;
178             break;
179         case TIFF_STRING:
180             if(count <= 4){
181                 buf -= 4;
182                 break;
183             }
184         default:
185             value = -1;
186             buf = start + off;
187         }
188     }else if(type_sizes[type] * count <= 4){
189         buf -= 4;
190     }else{
191         buf = start + off;
192     }
193
194     if(buf && (buf < start || buf > end_buf)){
195         av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
196         return -1;
197     }
198
199     switch(tag){
200     case TIFF_WIDTH:
201         s->width = value;
202         break;
203     case TIFF_HEIGHT:
204         s->height = value;
205         break;
206     case TIFF_BPP:
207         if(count == 1) s->bpp = value;
208         else{
209             switch(type){
210             case TIFF_BYTE:
211                 s->bpp = (off & 0xFF) + ((off >> 8) & 0xFF) + ((off >> 16) & 0xFF) + ((off >> 24) & 0xFF);
212                 break;
213             case TIFF_SHORT:
214             case TIFF_LONG:
215                 s->bpp = 0;
216                 for(i = 0; i < count; i++) s->bpp += tget(&buf, type, s->le);
217                 break;
218             default:
219                 s->bpp = -1;
220             }
221         }
222         switch(s->bpp){
223         case 8:
224             s->avctx->pix_fmt = PIX_FMT_PAL8;
225             break;
226         case 24:
227             s->avctx->pix_fmt = PIX_FMT_RGB24;
228             break;
229         case 16:
230             if(count == 1){
231                 s->avctx->pix_fmt = PIX_FMT_GRAY16BE;
232             }else{
233                 av_log(s->avctx, AV_LOG_ERROR, "This format is not supported (bpp=%i)\n", s->bpp);
234                 return -1;
235             }
236             break;
237         default:
238             av_log(s->avctx, AV_LOG_ERROR, "This format is not supported (bpp=%i)\n", s->bpp);
239             return -1;
240         }
241         if(s->width != s->avctx->width || s->height != s->avctx->height){
242             if(avcodec_check_dimensions(s->avctx, s->width, s->height))
243                 return -1;
244             avcodec_set_dimensions(s->avctx, s->width, s->height);
245         }
246         if(s->picture.data[0])
247             s->avctx->release_buffer(s->avctx, &s->picture);
248         if(s->avctx->get_buffer(s->avctx, &s->picture) < 0){
249             av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
250             return -1;
251         }
252         if(s->bpp == 8){
253             /* make default grayscale pal */
254             pal = (uint32_t *) s->picture.data[1];
255             for(i = 0; i < 256; i++)
256                 pal[i] = i * 0x010101;
257         }
258         break;
259     case TIFF_COMPR:
260         s->compr = value;
261         switch(s->compr){
262         case TIFF_RAW:
263         case TIFF_PACKBITS:
264         case TIFF_LZW:
265             break;
266         case TIFF_DEFLATE:
267         case TIFF_ADOBE_DEFLATE:
268 #ifdef CONFIG_ZLIB
269             break;
270 #else
271             av_log(s->avctx, AV_LOG_ERROR, "Deflate: ZLib not compiled in\n");
272             return -1;
273 #endif
274         case TIFF_G3:
275             av_log(s->avctx, AV_LOG_ERROR, "CCITT G3 compression is not supported\n");
276             return -1;
277         case TIFF_G4:
278             av_log(s->avctx, AV_LOG_ERROR, "CCITT G4 compression is not supported\n");
279             return -1;
280         case TIFF_CCITT_RLE:
281             av_log(s->avctx, AV_LOG_ERROR, "CCITT RLE compression is not supported\n");
282             return -1;
283         case TIFF_JPEG:
284         case TIFF_NEWJPEG:
285             av_log(s->avctx, AV_LOG_ERROR, "JPEG compression is not supported\n");
286             return -1;
287         default:
288             av_log(s->avctx, AV_LOG_ERROR, "Unknown compression method %i\n", s->compr);
289             return -1;
290         }
291         break;
292     case TIFF_ROWSPERSTRIP:
293         if(value < 1){
294             av_log(s->avctx, AV_LOG_ERROR, "Incorrect value of rows per strip\n");
295             return -1;
296         }
297         s->rps = value;
298         break;
299     case TIFF_STRIP_OFFS:
300         if(count == 1){
301             s->stripdata = NULL;
302             s->stripoff = value;
303         }else
304             s->stripdata = start + off;
305         s->strips = count;
306         if(s->strips == 1) s->rps = s->height;
307         s->sot = type;
308         if(s->stripdata > end_buf){
309             av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
310             return -1;
311         }
312         break;
313     case TIFF_STRIP_SIZE:
314         if(count == 1){
315             s->stripsizes = NULL;
316             s->stripsize = value;
317             s->strips = 1;
318         }else{
319             s->stripsizes = start + off;
320         }
321         s->strips = count;
322         if(s->stripsizes > end_buf){
323             av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
324             return -1;
325         }
326         if(!pic->data[0]){
327             av_log(s->avctx, AV_LOG_ERROR, "Picture initialization missing\n");
328             return -1;
329         }
330         /* now we have the data and may start decoding */
331         stride = pic->linesize[0];
332         dst = pic->data[0];
333         for(i = 0; i < s->height; i += s->rps){
334             if(s->stripsizes)
335                 ssize = tget(&s->stripsizes, type, s->le);
336             else
337                 ssize = s->stripsize;
338
339             if(s->stripdata){
340                 soff = tget(&s->stripdata, s->sot, s->le);
341             }else
342                 soff = s->stripoff;
343             src = start + soff;
344             if(tiff_unpack_strip(s, dst, stride, src, ssize, FFMIN(s->rps, s->height - i)) < 0)
345                 break;
346             dst += s->rps * stride;
347         }
348         break;
349     case TIFF_PREDICTOR:
350         if(!pic->data[0]){
351             av_log(s->avctx, AV_LOG_ERROR, "Picture initialization missing\n");
352             return -1;
353         }
354         if(value == 2){
355             dst = pic->data[0];
356             stride = pic->linesize[0];
357             soff = s->bpp >> 3;
358             ssize = s->width * soff;
359             for(i = 0; i < s->height; i++) {
360                 for(j = soff; j < ssize; j++)
361                     dst[j] += dst[j - soff];
362                 dst += stride;
363             }
364         }
365         break;
366     case TIFF_INVERT:
367         switch(value){
368         case 0:
369             s->invert = 1;
370             break;
371         case 1:
372             s->invert = 0;
373             break;
374         case 2:
375         case 3:
376             break;
377         default:
378             av_log(s->avctx, AV_LOG_ERROR, "Color mode %d is not supported\n", value);
379             return -1;
380         }
381         break;
382     case TIFF_PAL:
383         if(s->avctx->pix_fmt != PIX_FMT_PAL8){
384             av_log(s->avctx, AV_LOG_ERROR, "Palette met but this is not palettized format\n");
385             return -1;
386         }
387         pal = (uint32_t *) s->picture.data[1];
388         off = type_sizes[type];
389         rp = buf;
390         gp = buf + count / 3 * off;
391         bp = buf + count / 3 * off * 2;
392         off = (type_sizes[type] - 1) << 3;
393         for(i = 0; i < count / 3; i++){
394             j = (tget(&rp, type, s->le) >> off) << 16;
395             j |= (tget(&gp, type, s->le) >> off) << 8;
396             j |= tget(&bp, type, s->le) >> off;
397             pal[i] = j;
398         }
399         break;
400     case TIFF_PLANAR:
401         if(value == 2){
402             av_log(s->avctx, AV_LOG_ERROR, "Planar format is not supported\n");
403             return -1;
404         }
405         break;
406     }
407     return 0;
408 }
409
410 static int decode_frame(AVCodecContext *avctx,
411                         void *data, int *data_size,
412                         const uint8_t *buf, int buf_size)
413 {
414     TiffContext * const s = avctx->priv_data;
415     AVFrame *picture = data;
416     AVFrame * const p= (AVFrame*)&s->picture;
417     const uint8_t *orig_buf = buf, *end_buf = buf + buf_size;
418     int id, le, off;
419     int i, entries;
420
421     //parse image header
422     id = AV_RL16(buf); buf += 2;
423     if(id == 0x4949) le = 1;
424     else if(id == 0x4D4D) le = 0;
425     else{
426         av_log(avctx, AV_LOG_ERROR, "TIFF header not found\n");
427         return -1;
428     }
429     s->le = le;
430     s->invert = 0;
431     s->compr = TIFF_RAW;
432     // As TIFF 6.0 specification puts it "An arbitrary but carefully chosen number
433     // that further identifies the file as a TIFF file"
434     if(tget_short(&buf, le) != 42){
435         av_log(avctx, AV_LOG_ERROR, "The answer to life, universe and everything is not correct!\n");
436         return -1;
437     }
438     /* parse image file directory */
439     off = tget_long(&buf, le);
440     if(orig_buf + off + 14 >= end_buf){
441         av_log(avctx, AV_LOG_ERROR, "IFD offset is greater than image size\n");
442         return -1;
443     }
444     buf = orig_buf + off;
445     entries = tget_short(&buf, le);
446     for(i = 0; i < entries; i++){
447         if(tiff_decode_tag(s, orig_buf, buf, end_buf, p) < 0)
448             return -1;
449         buf += 12;
450     }
451
452     if(s->invert){
453         uint8_t *src;
454         int j;
455
456         src = s->picture.data[0];
457         for(j = 0; j < s->height; j++){
458             for(i = 0; i < s->picture.linesize[0]; i++)
459                 src[i] = 255 - src[i];
460             src += s->picture.linesize[0];
461         }
462     }
463     *picture= *(AVFrame*)&s->picture;
464     *data_size = sizeof(AVPicture);
465
466     return buf_size;
467 }
468
469 static av_cold int tiff_init(AVCodecContext *avctx){
470     TiffContext *s = avctx->priv_data;
471
472     s->width = 0;
473     s->height = 0;
474     s->avctx = avctx;
475     avcodec_get_frame_defaults((AVFrame*)&s->picture);
476     avctx->coded_frame= (AVFrame*)&s->picture;
477     s->picture.data[0] = NULL;
478     ff_lzw_decode_open(&s->lzw);
479
480     return 0;
481 }
482
483 static av_cold int tiff_end(AVCodecContext *avctx)
484 {
485     TiffContext * const s = avctx->priv_data;
486
487     ff_lzw_decode_close(&s->lzw);
488     if(s->picture.data[0])
489         avctx->release_buffer(avctx, &s->picture);
490     return 0;
491 }
492
493 AVCodec tiff_decoder = {
494     "tiff",
495     CODEC_TYPE_VIDEO,
496     CODEC_ID_TIFF,
497     sizeof(TiffContext),
498     tiff_init,
499     NULL,
500     tiff_end,
501     decode_frame,
502     0,
503     NULL,
504     .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),
505 };