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