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