Add monochrome TIFF support
[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 >> 3;
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, width);
113             src += width;
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 1:
224             s->avctx->pix_fmt = PIX_FMT_MONOBLACK;
225             break;
226         case 8:
227             s->avctx->pix_fmt = PIX_FMT_PAL8;
228             break;
229         case 24:
230             s->avctx->pix_fmt = PIX_FMT_RGB24;
231             break;
232         case 16:
233             if(count == 1){
234                 s->avctx->pix_fmt = PIX_FMT_GRAY16BE;
235             }else{
236                 av_log(s->avctx, AV_LOG_ERROR, "This format is not supported (bpp=%i)\n", s->bpp);
237                 return -1;
238             }
239             break;
240         default:
241             av_log(s->avctx, AV_LOG_ERROR, "This format is not supported (bpp=%i)\n", s->bpp);
242             return -1;
243         }
244         if(s->width != s->avctx->width || s->height != s->avctx->height){
245             if(avcodec_check_dimensions(s->avctx, s->width, s->height))
246                 return -1;
247             avcodec_set_dimensions(s->avctx, s->width, s->height);
248         }
249         if(s->picture.data[0])
250             s->avctx->release_buffer(s->avctx, &s->picture);
251         if(s->avctx->get_buffer(s->avctx, &s->picture) < 0){
252             av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
253             return -1;
254         }
255         if(s->bpp == 8){
256             /* make default grayscale pal */
257             pal = (uint32_t *) s->picture.data[1];
258             for(i = 0; i < 256; i++)
259                 pal[i] = i * 0x010101;
260         }
261         break;
262     case TIFF_COMPR:
263         s->compr = value;
264         switch(s->compr){
265         case TIFF_RAW:
266         case TIFF_PACKBITS:
267         case TIFF_LZW:
268             break;
269         case TIFF_DEFLATE:
270         case TIFF_ADOBE_DEFLATE:
271 #ifdef CONFIG_ZLIB
272             break;
273 #else
274             av_log(s->avctx, AV_LOG_ERROR, "Deflate: ZLib not compiled in\n");
275             return -1;
276 #endif
277         case TIFF_G3:
278             av_log(s->avctx, AV_LOG_ERROR, "CCITT G3 compression is not supported\n");
279             return -1;
280         case TIFF_G4:
281             av_log(s->avctx, AV_LOG_ERROR, "CCITT G4 compression is not supported\n");
282             return -1;
283         case TIFF_CCITT_RLE:
284             av_log(s->avctx, AV_LOG_ERROR, "CCITT RLE compression is not supported\n");
285             return -1;
286         case TIFF_JPEG:
287         case TIFF_NEWJPEG:
288             av_log(s->avctx, AV_LOG_ERROR, "JPEG compression is not supported\n");
289             return -1;
290         default:
291             av_log(s->avctx, AV_LOG_ERROR, "Unknown compression method %i\n", s->compr);
292             return -1;
293         }
294         break;
295     case TIFF_ROWSPERSTRIP:
296         if(value < 1){
297             av_log(s->avctx, AV_LOG_ERROR, "Incorrect value of rows per strip\n");
298             return -1;
299         }
300         s->rps = value;
301         break;
302     case TIFF_STRIP_OFFS:
303         if(count == 1){
304             s->stripdata = NULL;
305             s->stripoff = value;
306         }else
307             s->stripdata = start + off;
308         s->strips = count;
309         if(s->strips == 1) s->rps = s->height;
310         s->sot = type;
311         if(s->stripdata > end_buf){
312             av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
313             return -1;
314         }
315         break;
316     case TIFF_STRIP_SIZE:
317         if(count == 1){
318             s->stripsizes = NULL;
319             s->stripsize = value;
320             s->strips = 1;
321         }else{
322             s->stripsizes = start + off;
323         }
324         s->strips = count;
325         if(s->stripsizes > end_buf){
326             av_log(s->avctx, AV_LOG_ERROR, "Tag referencing position outside the image\n");
327             return -1;
328         }
329         if(!pic->data[0]){
330             av_log(s->avctx, AV_LOG_ERROR, "Picture initialization missing\n");
331             return -1;
332         }
333         /* now we have the data and may start decoding */
334         stride = pic->linesize[0];
335         dst = pic->data[0];
336         for(i = 0; i < s->height; i += s->rps){
337             if(s->stripsizes)
338                 ssize = tget(&s->stripsizes, type, s->le);
339             else
340                 ssize = s->stripsize;
341
342             if(s->stripdata){
343                 soff = tget(&s->stripdata, s->sot, s->le);
344             }else
345                 soff = s->stripoff;
346             src = start + soff;
347             if(tiff_unpack_strip(s, dst, stride, src, ssize, FFMIN(s->rps, s->height - i)) < 0)
348                 break;
349             dst += s->rps * stride;
350         }
351         break;
352     case TIFF_PREDICTOR:
353         if(!pic->data[0]){
354             av_log(s->avctx, AV_LOG_ERROR, "Picture initialization missing\n");
355             return -1;
356         }
357         if(value == 2){
358             dst = pic->data[0];
359             stride = pic->linesize[0];
360             soff = s->bpp >> 3;
361             ssize = s->width * soff;
362             for(i = 0; i < s->height; i++) {
363                 for(j = soff; j < ssize; j++)
364                     dst[j] += dst[j - soff];
365                 dst += stride;
366             }
367         }
368         break;
369     case TIFF_INVERT:
370         switch(value){
371         case 0:
372             s->invert = 1;
373             break;
374         case 1:
375             s->invert = 0;
376             break;
377         case 2:
378         case 3:
379             break;
380         default:
381             av_log(s->avctx, AV_LOG_ERROR, "Color mode %d is not supported\n", value);
382             return -1;
383         }
384         break;
385     case TIFF_PAL:
386         if(s->avctx->pix_fmt != PIX_FMT_PAL8){
387             av_log(s->avctx, AV_LOG_ERROR, "Palette met but this is not palettized format\n");
388             return -1;
389         }
390         pal = (uint32_t *) s->picture.data[1];
391         off = type_sizes[type];
392         rp = buf;
393         gp = buf + count / 3 * off;
394         bp = buf + count / 3 * off * 2;
395         off = (type_sizes[type] - 1) << 3;
396         for(i = 0; i < count / 3; i++){
397             j = (tget(&rp, type, s->le) >> off) << 16;
398             j |= (tget(&gp, type, s->le) >> off) << 8;
399             j |= tget(&bp, type, s->le) >> off;
400             pal[i] = j;
401         }
402         break;
403     case TIFF_PLANAR:
404         if(value == 2){
405             av_log(s->avctx, AV_LOG_ERROR, "Planar format is not supported\n");
406             return -1;
407         }
408         break;
409     }
410     return 0;
411 }
412
413 static int decode_frame(AVCodecContext *avctx,
414                         void *data, int *data_size,
415                         const uint8_t *buf, int buf_size)
416 {
417     TiffContext * const s = avctx->priv_data;
418     AVFrame *picture = data;
419     AVFrame * const p= (AVFrame*)&s->picture;
420     const uint8_t *orig_buf = buf, *end_buf = buf + buf_size;
421     int id, le, off;
422     int i, entries;
423
424     //parse image header
425     id = AV_RL16(buf); buf += 2;
426     if(id == 0x4949) le = 1;
427     else if(id == 0x4D4D) le = 0;
428     else{
429         av_log(avctx, AV_LOG_ERROR, "TIFF header not found\n");
430         return -1;
431     }
432     s->le = le;
433     s->invert = 0;
434     s->compr = TIFF_RAW;
435     // As TIFF 6.0 specification puts it "An arbitrary but carefully chosen number
436     // that further identifies the file as a TIFF file"
437     if(tget_short(&buf, le) != 42){
438         av_log(avctx, AV_LOG_ERROR, "The answer to life, universe and everything is not correct!\n");
439         return -1;
440     }
441     /* parse image file directory */
442     off = tget_long(&buf, le);
443     if(orig_buf + off + 14 >= end_buf){
444         av_log(avctx, AV_LOG_ERROR, "IFD offset is greater than image size\n");
445         return -1;
446     }
447     buf = orig_buf + off;
448     entries = tget_short(&buf, le);
449     for(i = 0; i < entries; i++){
450         if(tiff_decode_tag(s, orig_buf, buf, end_buf, p) < 0)
451             return -1;
452         buf += 12;
453     }
454
455     if(s->invert){
456         uint8_t *src;
457         int j;
458
459         src = s->picture.data[0];
460         for(j = 0; j < s->height; j++){
461             for(i = 0; i < s->picture.linesize[0]; i++)
462                 src[i] = 255 - src[i];
463             src += s->picture.linesize[0];
464         }
465     }
466     *picture= *(AVFrame*)&s->picture;
467     *data_size = sizeof(AVPicture);
468
469     return buf_size;
470 }
471
472 static av_cold int tiff_init(AVCodecContext *avctx){
473     TiffContext *s = avctx->priv_data;
474
475     s->width = 0;
476     s->height = 0;
477     s->avctx = avctx;
478     avcodec_get_frame_defaults((AVFrame*)&s->picture);
479     avctx->coded_frame= (AVFrame*)&s->picture;
480     s->picture.data[0] = NULL;
481     ff_lzw_decode_open(&s->lzw);
482
483     return 0;
484 }
485
486 static av_cold int tiff_end(AVCodecContext *avctx)
487 {
488     TiffContext * const s = avctx->priv_data;
489
490     ff_lzw_decode_close(&s->lzw);
491     if(s->picture.data[0])
492         avctx->release_buffer(avctx, &s->picture);
493     return 0;
494 }
495
496 AVCodec tiff_decoder = {
497     "tiff",
498     CODEC_TYPE_VIDEO,
499     CODEC_ID_TIFF,
500     sizeof(TiffContext),
501     tiff_init,
502     NULL,
503     tiff_end,
504     decode_frame,
505     0,
506     NULL,
507     .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),
508 };