536b74f3911299c7c23d5c3edbdf7d40b5a86a24
[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 libavcodec/tiff.c
25  * @author Konstantin Shishkov
26  */
27 #include "avcodec.h"
28 #if CONFIG_ZLIB
29 #include <zlib.h>
30 #endif
31 #include "lzw.h"
32 #include "tiff.h"
33 #include "faxcompr.h"
34
35
36 typedef struct TiffContext {
37     AVCodecContext *avctx;
38     AVFrame picture;
39
40     int width, height;
41     unsigned int bpp;
42     int le;
43     int compr;
44     int invert;
45     int fax_opts;
46     int predictor;
47     int fill_order;
48
49     int strips, rps, sstype;
50     int sot;
51     const uint8_t* stripdata;
52     const uint8_t* stripsizes;
53     int stripsize, stripoff;
54     LZWState *lzw;
55 } TiffContext;
56
57 static int tget_short(const uint8_t **p, int le){
58     int v = le ? AV_RL16(*p) : AV_RB16(*p);
59     *p += 2;
60     return v;
61 }
62
63 static int tget_long(const uint8_t **p, int le){
64     int v = le ? AV_RL32(*p) : AV_RB32(*p);
65     *p += 4;
66     return v;
67 }
68
69 static int tget(const uint8_t **p, int type, int le){
70     switch(type){
71     case TIFF_BYTE : return *(*p)++;
72     case TIFF_SHORT: return tget_short(p, le);
73     case TIFF_LONG : return tget_long (p, le);
74     default        : return -1;
75     }
76 }
77
78 #if CONFIG_ZLIB
79 static int tiff_uncompress(uint8_t *dst, unsigned long *len, const uint8_t *src, int size)
80 {
81     z_stream zstream;
82     int zret;
83
84     memset(&zstream, 0, sizeof(zstream));
85     zstream.next_in = src;
86     zstream.avail_in = size;
87     zstream.next_out = dst;
88     zstream.avail_out = *len;
89     zret = inflateInit(&zstream);
90     if (zret != Z_OK) {
91         av_log(NULL, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
92         return zret;
93     }
94     zret = inflate(&zstream, Z_SYNC_FLUSH);
95     inflateEnd(&zstream);
96     *len = zstream.total_out;
97     return zret == Z_STREAM_END ? Z_OK : zret;
98 }
99 #endif
100
101 static int tiff_unpack_strip(TiffContext *s, uint8_t* dst, int stride, const uint8_t *src, int size, int lines){
102     int c, line, pixels, code;
103     const uint8_t *ssrc = src;
104     int width = s->width * s->bpp >> 3;
105 #if CONFIG_ZLIB
106     uint8_t *zbuf; unsigned long outlen;
107
108     if(s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE){
109         int ret;
110         outlen = width * lines;
111         zbuf = av_malloc(outlen);
112         ret = tiff_uncompress(zbuf, &outlen, src, size);
113         if(ret != Z_OK){
114             av_log(s->avctx, AV_LOG_ERROR, "Uncompressing failed (%lu of %lu) with error %d\n", outlen, (unsigned long)width * lines, ret);
115             av_free(zbuf);
116             return -1;
117         }
118         src = zbuf;
119         for(line = 0; line < lines; line++){
120             memcpy(dst, src, width);
121             dst += stride;
122             src += width;
123         }
124         av_free(zbuf);
125         return 0;
126     }
127 #endif
128     if(s->compr == TIFF_LZW){
129         if(ff_lzw_decode_init(s->lzw, 8, src, size, FF_LZW_TIFF) < 0){
130             av_log(s->avctx, AV_LOG_ERROR, "Error initializing LZW decoder\n");
131             return -1;
132         }
133     }
134     if(s->compr == TIFF_CCITT_RLE || s->compr == TIFF_G3 || s->compr == TIFF_G4){
135         int i, ret = 0;
136         uint8_t *src2 = av_malloc(size + FF_INPUT_BUFFER_PADDING_SIZE);
137
138         if(!src2 || (unsigned)size + FF_INPUT_BUFFER_PADDING_SIZE < (unsigned)size){
139             av_log(s->avctx, AV_LOG_ERROR, "Error allocating temporary buffer\n");
140             return -1;
141         }
142         if(!s->fill_order){
143             memcpy(src2, src, size);
144         }else{
145             for(i = 0; i < size; i++)
146                 src2[i] = ff_reverse[src[i]];
147         }
148         memset(src2+size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
149         if(s->compr == TIFF_G3 && !(s->fax_opts & 1))
150             s->compr = TIFF_CCITT_RLE;
151         switch(s->compr){
152         case TIFF_CCITT_RLE:
153         case TIFF_G3:
154         case TIFF_G4:
155             ret = ff_ccitt_unpack(s->avctx, src2, size, dst, lines, stride, s->compr);
156             break;
157         }
158         av_free(src2);
159         return ret;
160     }
161     for(line = 0; line < lines; line++){
162         if(src - ssrc > size){
163             av_log(s->avctx, AV_LOG_ERROR, "Source data overread\n");
164             return -1;
165         }
166         switch(s->compr){
167         case TIFF_RAW:
168             memcpy(dst, src, width);
169             src += width;
170             break;
171         case TIFF_PACKBITS:
172             for(pixels = 0; pixels < width;){
173                 code = (int8_t)*src++;
174                 if(code >= 0){
175                     code++;
176                     if(pixels + code > width){
177                         av_log(s->avctx, AV_LOG_ERROR, "Copy went out of bounds\n");
178                         return -1;
179                     }
180                     memcpy(dst + pixels, src, code);
181                     src += code;
182                     pixels += code;
183                 }else if(code != -128){ // -127..-1
184                     code = (-code) + 1;
185                     if(pixels + code > width){
186                         av_log(s->avctx, AV_LOG_ERROR, "Run went out of bounds\n");
187                         return -1;
188                     }
189                     c = *src++;
190                     memset(dst + pixels, c, code);
191                     pixels += code;
192                 }
193             }
194             break;
195         case TIFF_LZW:
196             pixels = ff_lzw_decode(s->lzw, dst, width);
197             if(pixels < width){
198                 av_log(s->avctx, AV_LOG_ERROR, "Decoded only %i bytes of %i\n", pixels, width);
199                 return -1;
200             }
201             break;
202         }
203         dst += stride;
204     }
205     return 0;
206 }
207
208
209 static int tiff_decode_tag(TiffContext *s, const uint8_t *start, const uint8_t *buf, const uint8_t *end_buf)
210 {
211     int tag, type, count, off, value = 0;
212     int i, j;
213     uint32_t *pal;
214     const uint8_t *rp, *gp, *bp;
215
216     tag = tget_short(&buf, s->le);
217     type = tget_short(&buf, s->le);
218     count = tget_long(&buf, s->le);
219     off = tget_long(&buf, s->le);
220
221     if(count == 1){
222         switch(type){
223         case TIFF_BYTE:
224         case TIFF_SHORT:
225             buf -= 4;
226             value = tget(&buf, type, s->le);
227             buf = NULL;
228             break;
229         case TIFF_LONG:
230             value = off;
231             buf = NULL;
232             break;
233         case TIFF_STRING:
234             if(count <= 4){
235                 buf -= 4;
236                 break;
237             }
238         default:
239             value = -1;
240             buf = start + off;
241         }
242     }else if(type_sizes[type] * count <= 4){
243         buf -= 4;
244     }else{
245         buf = start + off;
246     }
247
248     if(buf && (buf < start || buf > end_buf)){
249         av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
250         return -1;
251     }
252
253     switch(tag){
254     case TIFF_WIDTH:
255         s->width = value;
256         break;
257     case TIFF_HEIGHT:
258         s->height = value;
259         break;
260     case TIFF_BPP:
261         if(count == 1) s->bpp = value;
262         else{
263             switch(type){
264             case TIFF_BYTE:
265                 s->bpp = (off & 0xFF) + ((off >> 8) & 0xFF) + ((off >> 16) & 0xFF) + ((off >> 24) & 0xFF);
266                 break;
267             case TIFF_SHORT:
268             case TIFF_LONG:
269                 s->bpp = 0;
270                 for(i = 0; i < count; i++) s->bpp += tget(&buf, type, s->le);
271                 break;
272             default:
273                 s->bpp = -1;
274             }
275         }
276         if(count > 4){
277             av_log(s->avctx, AV_LOG_ERROR, "This format is not supported (bpp=%d, %d components)\n", s->bpp, count);
278             return -1;
279         }
280         switch(s->bpp*10 + count){
281         case 11:
282             s->avctx->pix_fmt = PIX_FMT_MONOBLACK;
283             break;
284         case 81:
285             s->avctx->pix_fmt = PIX_FMT_PAL8;
286             break;
287         case 243:
288             s->avctx->pix_fmt = PIX_FMT_RGB24;
289             break;
290         case 161:
291             s->avctx->pix_fmt = PIX_FMT_GRAY16BE;
292             break;
293         case 324:
294             s->avctx->pix_fmt = PIX_FMT_RGBA;
295             break;
296         case 483:
297             s->avctx->pix_fmt = s->le ? PIX_FMT_RGB48LE : PIX_FMT_RGB48BE;
298             break;
299         default:
300             av_log(s->avctx, AV_LOG_ERROR, "This format is not supported (bpp=%d, %d components)\n", s->bpp, count);
301             return -1;
302         }
303         if(s->width != s->avctx->width || s->height != s->avctx->height){
304             if(avcodec_check_dimensions(s->avctx, s->width, s->height))
305                 return -1;
306             avcodec_set_dimensions(s->avctx, s->width, s->height);
307         }
308         if(s->picture.data[0])
309             s->avctx->release_buffer(s->avctx, &s->picture);
310         if(s->avctx->get_buffer(s->avctx, &s->picture) < 0){
311             av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
312             return -1;
313         }
314         if(s->bpp == 8){
315             /* make default grayscale pal */
316             pal = (uint32_t *) s->picture.data[1];
317             for(i = 0; i < 256; i++)
318                 pal[i] = i * 0x010101;
319         }
320         break;
321     case TIFF_COMPR:
322         s->compr = value;
323         s->predictor = 0;
324         switch(s->compr){
325         case TIFF_RAW:
326         case TIFF_PACKBITS:
327         case TIFF_LZW:
328         case TIFF_CCITT_RLE:
329             break;
330         case TIFF_G3:
331         case TIFF_G4:
332             s->fax_opts = 0;
333             break;
334         case TIFF_DEFLATE:
335         case TIFF_ADOBE_DEFLATE:
336 #if CONFIG_ZLIB
337             break;
338 #else
339             av_log(s->avctx, AV_LOG_ERROR, "Deflate: ZLib not compiled in\n");
340             return -1;
341 #endif
342         case TIFF_JPEG:
343         case TIFF_NEWJPEG:
344             av_log(s->avctx, AV_LOG_ERROR, "JPEG compression is not supported\n");
345             return -1;
346         default:
347             av_log(s->avctx, AV_LOG_ERROR, "Unknown compression method %i\n", s->compr);
348             return -1;
349         }
350         break;
351     case TIFF_ROWSPERSTRIP:
352         if(type == TIFF_LONG && value == -1)
353             value = s->avctx->height;
354         if(value < 1){
355             av_log(s->avctx, AV_LOG_ERROR, "Incorrect value of rows per strip\n");
356             return -1;
357         }
358         s->rps = value;
359         break;
360     case TIFF_STRIP_OFFS:
361         if(count == 1){
362             s->stripdata = NULL;
363             s->stripoff = value;
364         }else
365             s->stripdata = start + off;
366         s->strips = count;
367         if(s->strips == 1) s->rps = s->height;
368         s->sot = type;
369         if(s->stripdata > end_buf){
370             av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
371             return -1;
372         }
373         break;
374     case TIFF_STRIP_SIZE:
375         if(count == 1){
376             s->stripsizes = NULL;
377             s->stripsize = value;
378             s->strips = 1;
379         }else{
380             s->stripsizes = start + off;
381         }
382         s->strips = count;
383         s->sstype = type;
384         if(s->stripsizes > end_buf){
385             av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
386             return -1;
387         }
388         break;
389     case TIFF_PREDICTOR:
390         s->predictor = value;
391         break;
392     case TIFF_INVERT:
393         switch(value){
394         case 0:
395             s->invert = 1;
396             break;
397         case 1:
398             s->invert = 0;
399             break;
400         case 2:
401         case 3:
402             break;
403         default:
404             av_log(s->avctx, AV_LOG_ERROR, "Color mode %d is not supported\n", value);
405             return -1;
406         }
407         break;
408     case TIFF_FILL_ORDER:
409         if(value < 1 || value > 2){
410             av_log(s->avctx, AV_LOG_ERROR, "Unknown FillOrder value %d, trying default one\n", value);
411             value = 1;
412         }
413         s->fill_order = value - 1;
414         break;
415     case TIFF_PAL:
416         if(s->avctx->pix_fmt != PIX_FMT_PAL8){
417             av_log(s->avctx, AV_LOG_ERROR, "Palette met but this is not palettized format\n");
418             return -1;
419         }
420         pal = (uint32_t *) s->picture.data[1];
421         off = type_sizes[type];
422         rp = buf;
423         gp = buf + count / 3 * off;
424         bp = buf + count / 3 * off * 2;
425         off = (type_sizes[type] - 1) << 3;
426         for(i = 0; i < count / 3; i++){
427             j = (tget(&rp, type, s->le) >> off) << 16;
428             j |= (tget(&gp, type, s->le) >> off) << 8;
429             j |= tget(&bp, type, s->le) >> off;
430             pal[i] = j;
431         }
432         break;
433     case TIFF_PLANAR:
434         if(value == 2){
435             av_log(s->avctx, AV_LOG_ERROR, "Planar format is not supported\n");
436             return -1;
437         }
438         break;
439     case TIFF_T4OPTIONS:
440         if(s->compr == TIFF_G3)
441             s->fax_opts = value;
442         break;
443     case TIFF_T6OPTIONS:
444         if(s->compr == TIFF_G4)
445             s->fax_opts = value;
446         break;
447     }
448     return 0;
449 }
450
451 static int decode_frame(AVCodecContext *avctx,
452                         void *data, int *data_size,
453                         AVPacket *avpkt)
454 {
455     const uint8_t *buf = avpkt->data;
456     int buf_size = avpkt->size;
457     TiffContext * const s = avctx->priv_data;
458     AVFrame *picture = data;
459     AVFrame * const p= (AVFrame*)&s->picture;
460     const uint8_t *orig_buf = buf, *end_buf = buf + buf_size;
461     int id, le, off;
462     int i, j, entries;
463     int stride, soff, ssize;
464     uint8_t *dst;
465
466     //parse image header
467     id = AV_RL16(buf); buf += 2;
468     if(id == 0x4949) le = 1;
469     else if(id == 0x4D4D) le = 0;
470     else{
471         av_log(avctx, AV_LOG_ERROR, "TIFF header not found\n");
472         return -1;
473     }
474     s->le = le;
475     s->invert = 0;
476     s->compr = TIFF_RAW;
477     s->fill_order = 0;
478     // As TIFF 6.0 specification puts it "An arbitrary but carefully chosen number
479     // that further identifies the file as a TIFF file"
480     if(tget_short(&buf, le) != 42){
481         av_log(avctx, AV_LOG_ERROR, "The answer to life, universe and everything is not correct!\n");
482         return -1;
483     }
484     /* parse image file directory */
485     off = tget_long(&buf, le);
486     if(orig_buf + off + 14 >= end_buf){
487         av_log(avctx, AV_LOG_ERROR, "IFD offset is greater than image size\n");
488         return -1;
489     }
490     buf = orig_buf + off;
491     entries = tget_short(&buf, le);
492     for(i = 0; i < entries; i++){
493         if(tiff_decode_tag(s, orig_buf, buf, end_buf) < 0)
494             return -1;
495         buf += 12;
496     }
497     if(!s->stripdata && !s->stripoff){
498         av_log(avctx, AV_LOG_ERROR, "Image data is missing\n");
499         return -1;
500     }
501     /* now we have the data and may start decoding */
502     if(!p->data[0]){
503         av_log(s->avctx, AV_LOG_ERROR, "Picture initialization missing\n");
504         return -1;
505     }
506     if(s->strips == 1 && !s->stripsize){
507         av_log(avctx, AV_LOG_WARNING, "Image data size missing\n");
508         s->stripsize = buf_size - s->stripoff;
509     }
510     stride = p->linesize[0];
511     dst = p->data[0];
512     for(i = 0; i < s->height; i += s->rps){
513         if(s->stripsizes)
514             ssize = tget(&s->stripsizes, s->sstype, s->le);
515         else
516             ssize = s->stripsize;
517
518         if(s->stripdata){
519             soff = tget(&s->stripdata, s->sot, s->le);
520         }else
521             soff = s->stripoff;
522         if(tiff_unpack_strip(s, dst, stride, orig_buf + soff, ssize, FFMIN(s->rps, s->height - i)) < 0)
523             break;
524         dst += s->rps * stride;
525     }
526     if(s->predictor == 2){
527         dst = p->data[0];
528         soff = s->bpp >> 3;
529         ssize = s->width * soff;
530         for(i = 0; i < s->height; i++) {
531             for(j = soff; j < ssize; j++)
532                 dst[j] += dst[j - soff];
533             dst += stride;
534         }
535     }
536
537     if(s->invert){
538         uint8_t *src;
539         int j;
540
541         src = s->picture.data[0];
542         for(j = 0; j < s->height; j++){
543             for(i = 0; i < s->picture.linesize[0]; i++)
544                 src[i] = 255 - src[i];
545             src += s->picture.linesize[0];
546         }
547     }
548     *picture= *(AVFrame*)&s->picture;
549     *data_size = sizeof(AVPicture);
550
551     return buf_size;
552 }
553
554 static av_cold int tiff_init(AVCodecContext *avctx){
555     TiffContext *s = avctx->priv_data;
556
557     s->width = 0;
558     s->height = 0;
559     s->avctx = avctx;
560     avcodec_get_frame_defaults((AVFrame*)&s->picture);
561     avctx->coded_frame= (AVFrame*)&s->picture;
562     ff_lzw_decode_open(&s->lzw);
563     ff_ccitt_unpack_init();
564
565     return 0;
566 }
567
568 static av_cold int tiff_end(AVCodecContext *avctx)
569 {
570     TiffContext * const s = avctx->priv_data;
571
572     ff_lzw_decode_close(&s->lzw);
573     if(s->picture.data[0])
574         avctx->release_buffer(avctx, &s->picture);
575     return 0;
576 }
577
578 AVCodec tiff_decoder = {
579     "tiff",
580     CODEC_TYPE_VIDEO,
581     CODEC_ID_TIFF,
582     sizeof(TiffContext),
583     tiff_init,
584     NULL,
585     tiff_end,
586     decode_frame,
587     CODEC_CAP_DR1,
588     NULL,
589     .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),
590 };