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