per context frame_rate_base, this should finally fix frame_rate related av sync issues
[ffmpeg.git] / libavformat / gifdec.c
1 /*
2  * GIF decoder
3  * Copyright (c) 2003 Fabrice Bellard.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  */
19 #include "avformat.h"
20
21 int gif_write(ByteIOContext *pb, AVImageInfo *info);
22
23 //#define DEBUG
24
25 #define MAXBITS         12
26 #define SIZTABLE        (1<<MAXBITS)
27
28 #define GCE_DISPOSAL_NONE       0
29 #define GCE_DISPOSAL_INPLACE    1
30 #define GCE_DISPOSAL_BACKGROUND 2
31 #define GCE_DISPOSAL_RESTORE    3
32
33 typedef struct GifState {
34     int screen_width;
35     int screen_height;
36     int bits_per_pixel;
37     int background_color_index;
38     int transparent_color_index;
39     int color_resolution;
40     uint8_t *image_buf;
41     int image_linesize;
42     uint32_t *image_palette;
43     int pix_fmt;
44
45     /* after the frame is displayed, the disposal method is used */
46     int gce_disposal;
47     /* delay during which the frame is shown */
48     int gce_delay;
49     
50     /* LZW compatible decoder */
51     ByteIOContext *f;
52     int eob_reached;
53     uint8_t *pbuf, *ebuf;
54     int bbits;
55     unsigned int bbuf;
56
57     int cursize;                /* The current code size */
58     int curmask;
59     int codesize;
60     int clear_code;
61     int end_code;
62     int newcodes;               /* First available code */
63     int top_slot;               /* Highest code for current size */
64     int slot;                   /* Last read code */
65     int fc, oc;
66     uint8_t *sp;
67     uint8_t stack[SIZTABLE];
68     uint8_t suffix[SIZTABLE];
69     uint16_t prefix[SIZTABLE];
70
71     /* aux buffers */
72     uint8_t global_palette[256 * 3];
73     uint8_t local_palette[256 * 3];
74     uint8_t buf[256];
75 } GifState;
76
77
78 static const uint8_t gif87a_sig[6] = "GIF87a";
79 static const uint8_t gif89a_sig[6] = "GIF89a";
80
81 static const uint16_t mask[17] =
82 {
83     0x0000, 0x0001, 0x0003, 0x0007,
84     0x000F, 0x001F, 0x003F, 0x007F,
85     0x00FF, 0x01FF, 0x03FF, 0x07FF,
86     0x0FFF, 0x1FFF, 0x3FFF, 0x7FFF, 0xFFFF
87 };
88
89 /* Probe gif video format or gif image format. The current heuristic
90    supposes the gif87a is always a single image. For gif89a, we
91    consider it as a video only if a GCE extension is present in the
92    first kilobyte. */
93 static int gif_video_probe(AVProbeData * pd)
94 {
95     const uint8_t *p, *p_end;
96     int bits_per_pixel, has_global_palette, ext_code, ext_len;
97     
98     if (pd->buf_size < 24 ||
99         memcmp(pd->buf, gif89a_sig, 6) != 0)
100         return 0;
101     p_end = pd->buf + pd->buf_size;
102     p = pd->buf + 6;
103     bits_per_pixel = (p[4] & 0x07) + 1;
104     has_global_palette = (p[4] & 0x80);
105     p += 7;
106     if (has_global_palette)
107         p += (1 << bits_per_pixel) * 3;
108     for(;;) {
109         if (p >= p_end)
110             return 0;
111         if (*p != '!')
112             break;
113         p++;
114         if (p >= p_end)
115             return 0;
116         ext_code = *p++;
117         /* if GCE extension found: it is likely to be an animation */
118         if (ext_code == 0xf9)
119             return AVPROBE_SCORE_MAX;
120         for(;;) {
121             if (p >= p_end)
122                 return 0;
123             ext_len = *p++;
124             if (ext_len == 0)
125                 break;
126             p += ext_len;
127         }
128     }
129     return 0;
130 }
131
132 static int gif_image_probe(AVProbeData * pd)
133 {
134     if (pd->buf_size >= 24 &&
135         (memcmp(pd->buf, gif87a_sig, 6) == 0 ||
136          memcmp(pd->buf, gif89a_sig, 6) == 0))
137         return AVPROBE_SCORE_MAX - 1;
138     else
139         return 0;
140 }
141
142
143 static void GLZWDecodeInit(GifState * s, int csize)
144 {
145     /* read buffer */
146     s->eob_reached = 0;
147     s->pbuf = s->buf;
148     s->ebuf = s->buf;
149     s->bbuf = 0;
150     s->bbits = 0;
151
152     /* decoder */
153     s->codesize = csize;
154     s->cursize = s->codesize + 1;
155     s->curmask = mask[s->cursize];
156     s->top_slot = 1 << s->cursize;
157     s->clear_code = 1 << s->codesize;
158     s->end_code = s->clear_code + 1;
159     s->slot = s->newcodes = s->clear_code + 2;
160     s->oc = s->fc = 0;
161     s->sp = s->stack;
162 }
163
164 /* XXX: optimize */
165 static inline int GetCode(GifState * s)
166 {
167     int c, sizbuf;
168     uint8_t *ptr;
169
170     while (s->bbits < s->cursize) {
171         ptr = s->pbuf;
172         if (ptr >= s->ebuf) {
173             if (!s->eob_reached) {
174                 sizbuf = get_byte(s->f);
175                 s->ebuf = s->buf + sizbuf;
176                 s->pbuf = s->buf;
177                 if (sizbuf > 0) {
178                     get_buffer(s->f, s->buf, sizbuf);
179                 } else {
180                     s->eob_reached = 1;
181                 }
182             }
183             ptr = s->pbuf;
184         }
185         s->bbuf |= ptr[0] << s->bbits;
186         ptr++;
187         s->pbuf = ptr;
188         s->bbits += 8;
189     }
190     c = s->bbuf & s->curmask;
191     s->bbuf >>= s->cursize;
192     s->bbits -= s->cursize;
193     return c;
194 }
195
196 /* NOTE: the algorithm here is inspired from the LZW GIF decoder
197    written by Steven A. Bennett in 1987. */
198 /* return the number of byte decoded */
199 static int GLZWDecode(GifState * s, uint8_t * buf, int len)
200 {
201     int l, c, code, oc, fc;
202     uint8_t *sp;
203
204     if (s->end_code < 0)
205         return 0;
206
207     l = len;
208     sp = s->sp;
209     oc = s->oc;
210     fc = s->fc;
211
212     while (sp > s->stack) {
213         *buf++ = *(--sp);
214         if ((--l) == 0)
215             goto the_end;
216     }
217
218     for (;;) {
219         c = GetCode(s);
220         if (c == s->end_code) {
221             s->end_code = -1;
222             break;
223         } else if (c == s->clear_code) {
224             s->cursize = s->codesize + 1;
225             s->curmask = mask[s->cursize];
226             s->slot = s->newcodes;
227             s->top_slot = 1 << s->cursize;
228             while ((c = GetCode(s)) == s->clear_code);
229             if (c == s->end_code) {
230                 s->end_code = -1;
231                 break;
232             }
233             /* test error */
234             if (c >= s->slot)
235                 c = 0;
236             fc = oc = c;
237             *buf++ = c;
238             if ((--l) == 0)
239                 break;
240         } else {
241             code = c;
242             if (code >= s->slot) {
243                 *sp++ = fc;
244                 code = oc;
245             }
246             while (code >= s->newcodes) {
247                 *sp++ = s->suffix[code];
248                 code = s->prefix[code];
249             }
250             *sp++ = code;
251             if (s->slot < s->top_slot) {
252                 s->suffix[s->slot] = fc = code;
253                 s->prefix[s->slot++] = oc;
254                 oc = c;
255             }
256             if (s->slot >= s->top_slot) {
257                 if (s->cursize < MAXBITS) {
258                     s->top_slot <<= 1;
259                     s->curmask = mask[++s->cursize];
260                 }
261             }
262             while (sp > s->stack) {
263                 *buf++ = *(--sp);
264                 if ((--l) == 0)
265                     goto the_end;
266             }
267         }
268     }
269   the_end:
270     s->sp = sp;
271     s->oc = oc;
272     s->fc = fc;
273     return len - l;
274 }
275
276 static int gif_read_image(GifState *s)
277 {
278     ByteIOContext *f = s->f;
279     int left, top, width, height, bits_per_pixel, code_size, flags;
280     int is_interleaved, has_local_palette, y, x, pass, y1, linesize, n, i;
281     uint8_t *ptr, *line, *d, *spal, *palette, *sptr, *ptr1;
282
283     left = get_le16(f);
284     top = get_le16(f);
285     width = get_le16(f);
286     height = get_le16(f);
287     flags = get_byte(f);
288     is_interleaved = flags & 0x40;
289     has_local_palette = flags & 0x80;
290     bits_per_pixel = (flags & 0x07) + 1;
291 #ifdef DEBUG
292     printf("gif: image x=%d y=%d w=%d h=%d\n", left, top, width, height);
293 #endif
294
295     if (has_local_palette) {
296         get_buffer(f, s->local_palette, 3 * (1 << bits_per_pixel));
297         palette = s->local_palette;
298     } else {
299         palette = s->global_palette;
300         bits_per_pixel = s->bits_per_pixel;
301     }
302     
303     /* verify that all the image is inside the screen dimensions */
304     if (left + width > s->screen_width ||
305         top + height > s->screen_height)
306         return -EINVAL;
307
308     /* build the palette */
309     if (s->pix_fmt == PIX_FMT_RGB24) {
310         line = av_malloc(width);
311         if (!line)
312             return -ENOMEM;
313     } else {
314         n = (1 << bits_per_pixel);
315         spal = palette;
316         for(i = 0; i < n; i++) {
317             s->image_palette[i] = (0xff << 24) | 
318                 (spal[0] << 16) | (spal[1] << 8) | (spal[2]);
319             spal += 3;
320         }
321         for(; i < 256; i++)
322             s->image_palette[i] = (0xff << 24);
323         line = NULL;
324     }
325
326     /* now get the image data */
327     s->f = f;
328     code_size = get_byte(f);
329     GLZWDecodeInit(s, code_size);
330
331     /* read all the image */
332     linesize = s->image_linesize;
333     ptr1 = s->image_buf + top * linesize + (left * 3);
334     ptr = ptr1;
335     pass = 0;
336     y1 = 0;
337     for (y = 0; y < height; y++) {
338         if (s->pix_fmt == PIX_FMT_RGB24) {
339             /* transcode to RGB24 */
340             GLZWDecode(s, line, width);
341             d = ptr;
342             sptr = line;
343             for(x = 0; x < width; x++) {
344                 spal = palette + sptr[0] * 3;
345                 d[0] = spal[0];
346                 d[1] = spal[1];
347                 d[2] = spal[2];
348                 d += 3;
349                 sptr++;
350             }
351         } else {
352             GLZWDecode(s, ptr, width);
353         }
354         if (is_interleaved) {
355             switch(pass) {
356             default:
357             case 0:
358             case 1:
359                 y1 += 8;
360                 ptr += linesize * 8;
361                 if (y1 >= height) {
362                     y1 = 4;
363                     if (pass == 0) 
364                         ptr = ptr1 + linesize * 4;
365                     else
366                         ptr = ptr1 + linesize * 2;
367                     pass++;
368                 }
369                 break;
370             case 2:
371                 y1 += 4;
372                 ptr += linesize * 4;
373                 if (y1 >= height) {
374                     y1 = 1;
375                     ptr = ptr1 + linesize;
376                     pass++;
377                 }
378                 break;
379             case 3:
380                 y1 += 2;
381                 ptr += linesize * 2;
382                 break;
383             }
384         } else {
385             ptr += linesize;
386         }
387     }
388     av_free(line);
389     
390     /* read the garbage data until end marker is found */
391     while (!s->eob_reached)
392         GetCode(s);
393     return 0;
394 }
395
396 static int gif_read_extension(GifState *s)
397 {
398     ByteIOContext *f = s->f;
399     int ext_code, ext_len, i, gce_flags, gce_transparent_index;
400
401     /* extension */
402     ext_code = get_byte(f);
403     ext_len = get_byte(f);
404 #ifdef DEBUG
405     printf("gif: ext_code=0x%x len=%d\n", ext_code, ext_len);
406 #endif
407     switch(ext_code) {
408     case 0xf9:
409         if (ext_len != 4)
410             goto discard_ext;
411         s->transparent_color_index = -1;
412         gce_flags = get_byte(f);
413         s->gce_delay = get_le16(f);
414         gce_transparent_index = get_byte(f);
415         if (gce_flags & 0x01)
416             s->transparent_color_index = gce_transparent_index;
417         else
418             s->transparent_color_index = -1;
419         s->gce_disposal = (gce_flags >> 2) & 0x7;
420 #ifdef DEBUG
421         printf("gif: gce_flags=%x delay=%d tcolor=%d disposal=%d\n", 
422                gce_flags, s->gce_delay, 
423                s->transparent_color_index, s->gce_disposal);
424 #endif
425         ext_len = get_byte(f);
426         break;
427     }
428         
429     /* NOTE: many extension blocks can come after */
430  discard_ext:
431     while (ext_len != 0) {
432         for (i = 0; i < ext_len; i++)
433             get_byte(f);
434         ext_len = get_byte(f);
435 #ifdef DEBUG
436         printf("gif: ext_len1=%d\n", ext_len);
437 #endif
438     }
439     return 0;
440 }
441
442 static int gif_read_header1(GifState *s)
443 {
444     ByteIOContext *f = s->f;
445     uint8_t sig[6];
446     int ret, v, n;
447     int has_global_palette;
448
449     /* read gif signature */
450     ret = get_buffer(f, sig, 6);
451     if (ret != 6)
452         return -1;
453     if (memcmp(sig, gif87a_sig, 6) != 0 &&
454         memcmp(sig, gif89a_sig, 6) != 0)
455         return -1;
456
457     /* read screen header */
458     s->transparent_color_index = -1;
459     s->screen_width = get_le16(f);
460     s->screen_height = get_le16(f);
461     v = get_byte(f);
462     s->color_resolution = ((v & 0x70) >> 4) + 1;
463     has_global_palette = (v & 0x80);
464     s->bits_per_pixel = (v & 0x07) + 1;
465     s->background_color_index = get_byte(f);
466     get_byte(f);                /* ignored */
467 #ifdef DEBUG
468     printf("gif: screen_w=%d screen_h=%d bpp=%d global_palette=%d\n",
469            s->screen_width, s->screen_height, s->bits_per_pixel,
470            has_global_palette);
471 #endif
472     if (has_global_palette) {
473         n = 1 << s->bits_per_pixel;
474         get_buffer(f, s->global_palette, n * 3);
475     }
476     return 0;
477 }
478
479 static int gif_parse_next_image(GifState *s)
480 {
481     ByteIOContext *f = s->f;
482     int ret, code;
483
484     for (;;) {
485         code = url_fgetc(f);
486 #ifdef DEBUG
487         printf("gif: code=%02x '%c'\n", code, code);
488 #endif
489         switch (code) {
490         case ',':
491             if (gif_read_image(s) < 0)
492                 return -EIO;
493             ret = 0;
494             goto the_end;
495         case ';':
496             /* end of image */
497             ret = -EIO;
498             goto the_end;
499         case '!':
500             if (gif_read_extension(s) < 0)
501                 return -EIO;
502             break;
503         case EOF:
504         default:
505             /* error or errneous EOF */
506             ret = -EIO;
507             goto the_end;
508         }
509     }
510   the_end:
511     return ret;
512 }
513
514 static int gif_read_header(AVFormatContext * s1,
515                            AVFormatParameters * ap)
516 {
517     GifState *s = s1->priv_data;
518     ByteIOContext *f = &s1->pb;
519     AVStream *st;
520
521     s->f = f;
522     if (gif_read_header1(s) < 0)
523         return -1;
524     
525     /* allocate image buffer */
526     s->image_linesize = s->screen_width * 3;
527     s->image_buf = av_malloc(s->screen_height * s->image_linesize);
528     if (!s->image_buf)
529         return -ENOMEM;
530     s->pix_fmt = PIX_FMT_RGB24;
531     /* now we are ready: build format streams */
532     st = av_new_stream(s1, 0);
533     if (!st)
534         return -1;
535
536     st->codec.codec_type = CODEC_TYPE_VIDEO;
537     st->codec.codec_id = CODEC_ID_RAWVIDEO;
538     st->codec.frame_rate = 5;
539     st->codec.frame_rate_base = 1;
540     /* XXX: check if screen size is always valid */
541     st->codec.width = s->screen_width;
542     st->codec.height = s->screen_height;
543     st->codec.pix_fmt = PIX_FMT_RGB24;
544     return 0;
545 }
546
547 static int gif_read_packet(AVFormatContext * s1,
548                            AVPacket * pkt)
549 {
550     GifState *s = s1->priv_data;
551     int ret;
552
553     ret = gif_parse_next_image(s);
554     if (ret < 0)
555         return ret;
556
557     /* XXX: avoid copying */
558     if (av_new_packet(pkt, s->screen_width * s->screen_height * 3)) {
559         return -EIO;
560     }
561     pkt->stream_index = 0;
562     memcpy(pkt->data, s->image_buf, s->screen_width * s->screen_height * 3);
563     return 0;
564 }
565
566 static int gif_read_close(AVFormatContext *s1)
567 {
568     GifState *s = s1->priv_data;
569     av_free(s->image_buf);
570     return 0;
571 }
572
573 /* read gif as image */
574 static int gif_read(ByteIOContext *f, 
575                     int (*alloc_cb)(void *opaque, AVImageInfo *info), void *opaque)
576 {
577     GifState s1, *s = &s1;
578     AVImageInfo info1, *info = &info1;
579     int ret;
580
581     memset(s, 0, sizeof(GifState));
582     s->f = f;
583     if (gif_read_header1(s) < 0)
584         return -1;
585     info->width = s->screen_width;
586     info->height = s->screen_height;
587     info->pix_fmt = PIX_FMT_PAL8;
588     ret = alloc_cb(opaque, info);
589     if (ret)
590         return ret;
591     s->image_buf = info->pict.data[0];
592     s->image_linesize = info->pict.linesize[0];
593     s->image_palette = (uint32_t *)info->pict.data[1];
594
595     if (gif_parse_next_image(s) < 0)
596         return -1;
597     return 0;
598 }
599
600 AVInputFormat gif_iformat =
601 {
602     "gif",
603     "gif format",
604     sizeof(GifState),
605     gif_video_probe,
606     gif_read_header,
607     gif_read_packet,
608     gif_read_close,
609 };
610
611 AVImageFormat gif_image_format = {
612     "gif",
613     "gif",
614     gif_image_probe,
615     gif_read,
616     (1 << PIX_FMT_PAL8),
617     gif_write,
618 };