libavformat/gif.c

   1 /*
   2  * Animated GIF encoder
   3  * Copyright (c) 2000 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
  20 /*
  21  * First version by Francois Revol revol@free.fr
  22  *
  23  * Features and limitations:
  24  * - currently no compression is performed,
  25  *   in fact the size of the data is 9/8 the size of the image in 8bpp
  26  * - uses only a global standard palette
  27  * - tested with IE 5.0, Opera for BeOS, NetPositive (BeOS), and Mozilla (BeOS).
  28  *
  29  * Reference documents:
  30  * http://www.goice.co.jp/member/mo/formats/gif.html
  31  * http://astronomy.swin.edu.au/pbourke/dataformats/gif/
  32  * http://www.dcs.ed.ac.uk/home/mxr/gfx/2d/GIF89a.txt
  33  *
  34  * this url claims to have an LZW algorithm not covered by Unisys patent:
  35  * http://www.msg.net/utility/whirlgif/gifencod.html
  36  * could help reduce the size of the files _a lot_...
  37  * some sites mentions an RLE type compression also.
  38  */
  39
  40 #include "avformat.h"
  41
  42 /* bitstream minipacket size */
  43 #define GIF_CHUNKS 100
  44
  45 /* slows down the decoding (and some browsers doesn't like it) */
  46 /* #define GIF_ADD_APP_HEADER */
  47
  48 typedef struct {
  49     unsigned char r;
  50     unsigned char g;
  51     unsigned char b;
  52 } rgb_triplet;
  53
  54 /* we use the standard 216 color palette */
  55
  56 /* this script was used to create the palette:
  57  * for r in 00 33 66 99 cc ff; do for g in 00 33 66 99 cc ff; do echo -n "    "; for b in 00 33 66 99 cc ff; do
  58  *   echo -n "{ 0x$r, 0x$g, 0x$b }, "; done; echo ""; done; done
  59  */
  60
  61 static const rgb_triplet gif_clut[216] = {
  62     { 0x00, 0x00, 0x00 }, { 0x00, 0x00, 0x33 }, { 0x00, 0x00, 0x66 }, { 0x00, 0x00, 0x99 }, { 0x00, 0x00, 0xcc }, { 0x00, 0x00, 0xff },
  63     { 0x00, 0x33, 0x00 }, { 0x00, 0x33, 0x33 }, { 0x00, 0x33, 0x66 }, { 0x00, 0x33, 0x99 }, { 0x00, 0x33, 0xcc }, { 0x00, 0x33, 0xff },
  64     { 0x00, 0x66, 0x00 }, { 0x00, 0x66, 0x33 }, { 0x00, 0x66, 0x66 }, { 0x00, 0x66, 0x99 }, { 0x00, 0x66, 0xcc }, { 0x00, 0x66, 0xff },
  65     { 0x00, 0x99, 0x00 }, { 0x00, 0x99, 0x33 }, { 0x00, 0x99, 0x66 }, { 0x00, 0x99, 0x99 }, { 0x00, 0x99, 0xcc }, { 0x00, 0x99, 0xff },
  66     { 0x00, 0xcc, 0x00 }, { 0x00, 0xcc, 0x33 }, { 0x00, 0xcc, 0x66 }, { 0x00, 0xcc, 0x99 }, { 0x00, 0xcc, 0xcc }, { 0x00, 0xcc, 0xff },
  67     { 0x00, 0xff, 0x00 }, { 0x00, 0xff, 0x33 }, { 0x00, 0xff, 0x66 }, { 0x00, 0xff, 0x99 }, { 0x00, 0xff, 0xcc }, { 0x00, 0xff, 0xff },
  68     { 0x33, 0x00, 0x00 }, { 0x33, 0x00, 0x33 }, { 0x33, 0x00, 0x66 }, { 0x33, 0x00, 0x99 }, { 0x33, 0x00, 0xcc }, { 0x33, 0x00, 0xff },
  69     { 0x33, 0x33, 0x00 }, { 0x33, 0x33, 0x33 }, { 0x33, 0x33, 0x66 }, { 0x33, 0x33, 0x99 }, { 0x33, 0x33, 0xcc }, { 0x33, 0x33, 0xff },
  70     { 0x33, 0x66, 0x00 }, { 0x33, 0x66, 0x33 }, { 0x33, 0x66, 0x66 }, { 0x33, 0x66, 0x99 }, { 0x33, 0x66, 0xcc }, { 0x33, 0x66, 0xff },
  71     { 0x33, 0x99, 0x00 }, { 0x33, 0x99, 0x33 }, { 0x33, 0x99, 0x66 }, { 0x33, 0x99, 0x99 }, { 0x33, 0x99, 0xcc }, { 0x33, 0x99, 0xff },
  72     { 0x33, 0xcc, 0x00 }, { 0x33, 0xcc, 0x33 }, { 0x33, 0xcc, 0x66 }, { 0x33, 0xcc, 0x99 }, { 0x33, 0xcc, 0xcc }, { 0x33, 0xcc, 0xff },
  73     { 0x33, 0xff, 0x00 }, { 0x33, 0xff, 0x33 }, { 0x33, 0xff, 0x66 }, { 0x33, 0xff, 0x99 }, { 0x33, 0xff, 0xcc }, { 0x33, 0xff, 0xff },
  74     { 0x66, 0x00, 0x00 }, { 0x66, 0x00, 0x33 }, { 0x66, 0x00, 0x66 }, { 0x66, 0x00, 0x99 }, { 0x66, 0x00, 0xcc }, { 0x66, 0x00, 0xff },
  75     { 0x66, 0x33, 0x00 }, { 0x66, 0x33, 0x33 }, { 0x66, 0x33, 0x66 }, { 0x66, 0x33, 0x99 }, { 0x66, 0x33, 0xcc }, { 0x66, 0x33, 0xff },
  76     { 0x66, 0x66, 0x00 }, { 0x66, 0x66, 0x33 }, { 0x66, 0x66, 0x66 }, { 0x66, 0x66, 0x99 }, { 0x66, 0x66, 0xcc }, { 0x66, 0x66, 0xff },
  77     { 0x66, 0x99, 0x00 }, { 0x66, 0x99, 0x33 }, { 0x66, 0x99, 0x66 }, { 0x66, 0x99, 0x99 }, { 0x66, 0x99, 0xcc }, { 0x66, 0x99, 0xff },
  78     { 0x66, 0xcc, 0x00 }, { 0x66, 0xcc, 0x33 }, { 0x66, 0xcc, 0x66 }, { 0x66, 0xcc, 0x99 }, { 0x66, 0xcc, 0xcc }, { 0x66, 0xcc, 0xff },
  79     { 0x66, 0xff, 0x00 }, { 0x66, 0xff, 0x33 }, { 0x66, 0xff, 0x66 }, { 0x66, 0xff, 0x99 }, { 0x66, 0xff, 0xcc }, { 0x66, 0xff, 0xff },
  80     { 0x99, 0x00, 0x00 }, { 0x99, 0x00, 0x33 }, { 0x99, 0x00, 0x66 }, { 0x99, 0x00, 0x99 }, { 0x99, 0x00, 0xcc }, { 0x99, 0x00, 0xff },
  81     { 0x99, 0x33, 0x00 }, { 0x99, 0x33, 0x33 }, { 0x99, 0x33, 0x66 }, { 0x99, 0x33, 0x99 }, { 0x99, 0x33, 0xcc }, { 0x99, 0x33, 0xff },
  82     { 0x99, 0x66, 0x00 }, { 0x99, 0x66, 0x33 }, { 0x99, 0x66, 0x66 }, { 0x99, 0x66, 0x99 }, { 0x99, 0x66, 0xcc }, { 0x99, 0x66, 0xff },
  83     { 0x99, 0x99, 0x00 }, { 0x99, 0x99, 0x33 }, { 0x99, 0x99, 0x66 }, { 0x99, 0x99, 0x99 }, { 0x99, 0x99, 0xcc }, { 0x99, 0x99, 0xff },
  84     { 0x99, 0xcc, 0x00 }, { 0x99, 0xcc, 0x33 }, { 0x99, 0xcc, 0x66 }, { 0x99, 0xcc, 0x99 }, { 0x99, 0xcc, 0xcc }, { 0x99, 0xcc, 0xff },
  85     { 0x99, 0xff, 0x00 }, { 0x99, 0xff, 0x33 }, { 0x99, 0xff, 0x66 }, { 0x99, 0xff, 0x99 }, { 0x99, 0xff, 0xcc }, { 0x99, 0xff, 0xff },
  86     { 0xcc, 0x00, 0x00 }, { 0xcc, 0x00, 0x33 }, { 0xcc, 0x00, 0x66 }, { 0xcc, 0x00, 0x99 }, { 0xcc, 0x00, 0xcc }, { 0xcc, 0x00, 0xff },
  87     { 0xcc, 0x33, 0x00 }, { 0xcc, 0x33, 0x33 }, { 0xcc, 0x33, 0x66 }, { 0xcc, 0x33, 0x99 }, { 0xcc, 0x33, 0xcc }, { 0xcc, 0x33, 0xff },
  88     { 0xcc, 0x66, 0x00 }, { 0xcc, 0x66, 0x33 }, { 0xcc, 0x66, 0x66 }, { 0xcc, 0x66, 0x99 }, { 0xcc, 0x66, 0xcc }, { 0xcc, 0x66, 0xff },
  89     { 0xcc, 0x99, 0x00 }, { 0xcc, 0x99, 0x33 }, { 0xcc, 0x99, 0x66 }, { 0xcc, 0x99, 0x99 }, { 0xcc, 0x99, 0xcc }, { 0xcc, 0x99, 0xff },
  90     { 0xcc, 0xcc, 0x00 }, { 0xcc, 0xcc, 0x33 }, { 0xcc, 0xcc, 0x66 }, { 0xcc, 0xcc, 0x99 }, { 0xcc, 0xcc, 0xcc }, { 0xcc, 0xcc, 0xff },
  91     { 0xcc, 0xff, 0x00 }, { 0xcc, 0xff, 0x33 }, { 0xcc, 0xff, 0x66 }, { 0xcc, 0xff, 0x99 }, { 0xcc, 0xff, 0xcc }, { 0xcc, 0xff, 0xff },
  92     { 0xff, 0x00, 0x00 }, { 0xff, 0x00, 0x33 }, { 0xff, 0x00, 0x66 }, { 0xff, 0x00, 0x99 }, { 0xff, 0x00, 0xcc }, { 0xff, 0x00, 0xff },
  93     { 0xff, 0x33, 0x00 }, { 0xff, 0x33, 0x33 }, { 0xff, 0x33, 0x66 }, { 0xff, 0x33, 0x99 }, { 0xff, 0x33, 0xcc }, { 0xff, 0x33, 0xff },
  94     { 0xff, 0x66, 0x00 }, { 0xff, 0x66, 0x33 }, { 0xff, 0x66, 0x66 }, { 0xff, 0x66, 0x99 }, { 0xff, 0x66, 0xcc }, { 0xff, 0x66, 0xff },
  95     { 0xff, 0x99, 0x00 }, { 0xff, 0x99, 0x33 }, { 0xff, 0x99, 0x66 }, { 0xff, 0x99, 0x99 }, { 0xff, 0x99, 0xcc }, { 0xff, 0x99, 0xff },
  96     { 0xff, 0xcc, 0x00 }, { 0xff, 0xcc, 0x33 }, { 0xff, 0xcc, 0x66 }, { 0xff, 0xcc, 0x99 }, { 0xff, 0xcc, 0xcc }, { 0xff, 0xcc, 0xff },
  97     { 0xff, 0xff, 0x00 }, { 0xff, 0xff, 0x33 }, { 0xff, 0xff, 0x66 }, { 0xff, 0xff, 0x99 }, { 0xff, 0xff, 0xcc }, { 0xff, 0xff, 0xff },
  98 };
  99
 100 /* The GIF format uses reversed order for bitstreams... */
 101 /* at least they don't use PDP_ENDIAN :) */
 102 /* so we 'extend' PutBitContext. hmmm, OOP :) */
 103 /* seems this thing changed slightly since I wrote it... */
 104
 105 #ifdef ALT_BITSTREAM_WRITER
 106 # error no ALT_BITSTREAM_WRITER support for now
 107 #endif
 108
 109 static void gif_put_bits_rev(PutBitContext *s, int n, unsigned int value)
 110 {
 111     unsigned int bit_buf;
 112     int bit_cnt;
 113
 114 #ifdef STATS
 115     st_out_bit_counts[st_current_index] += n;
 116 #endif
 117     //    printf("put_bits=%d %x\n", n, value);
 118     assert(n == 32 || value < (1U << n));
 119
 120     bit_buf = s->bit_buf;
 121     bit_cnt = 32 - s->bit_left; /* XXX:lazyness... was = s->bit_cnt; */
 122
 123     //    printf("n=%d value=%x cnt=%d buf=%x\n", n, value, bit_cnt, bit_buf);
 124     /* XXX: optimize */
 125     if (n < (32-bit_cnt)) {
 126         bit_buf |= value << (bit_cnt);
 127         bit_cnt+=n;
 128     } else {
 129         bit_buf |= value << (bit_cnt);
 130
 131         *s->buf_ptr = bit_buf & 0xff;
 132         s->buf_ptr[1] = (bit_buf >> 8) & 0xff;
 133         s->buf_ptr[2] = (bit_buf >> 16) & 0xff;
 134         s->buf_ptr[3] = (bit_buf >> 24) & 0xff;
 135
 136         //printf("bitbuf = %08x\n", bit_buf);
 137         s->buf_ptr+=4;
 138         if (s->buf_ptr >= s->buf_end)
 139             puts("bit buffer overflow !!"); // should never happen ! who got rid of the callback ???
 140 //            flush_buffer_rev(s);
 141         bit_cnt=bit_cnt + n - 32;
 142         if (bit_cnt == 0) {
 143             bit_buf = 0;
 144         } else {
 145             bit_buf = value >> (n - bit_cnt);
 146         }
 147     }
 148
 149     s->bit_buf = bit_buf;
 150     s->bit_left = 32 - bit_cnt;
 151 }
 152
 153 /* pad the end of the output stream with zeros */
 154 static void gif_flush_put_bits_rev(PutBitContext *s)
 155 {
 156     while (s->bit_left < 32) {
 157         /* XXX: should test end of buffer */
 158         *s->buf_ptr++=s->bit_buf & 0xff;
 159         s->bit_buf>>=8;
 160         s->bit_left+=8;
 161     }
 162 //    flush_buffer_rev(s);
 163     s->bit_left=32;
 164     s->bit_buf=0;
 165 }
 166
 167 /* !RevPutBitContext */
 168
 169 /* GIF header */
 170 static int gif_image_write_header(ByteIOContext *pb, int width, int height)
 171 {
 172     int i;
 173
 174     put_tag(pb, "GIF");
 175     put_tag(pb, "89a");
 176     put_le16(pb, width);
 177     put_le16(pb, height);
 178
 179     put_byte(pb, 0xf7); /* flags: global clut, 256 entries */
 180     put_byte(pb, 0x1f); /* background color index */
 181     put_byte(pb, 0); /* aspect ratio */
 182
 183     /* the global palette */
 184
 185     put_buffer(pb, (unsigned char *)gif_clut, 216*3);
 186     for(i=0;i<((256-216)*3);i++)
 187        put_byte(pb, 0);
 188
 189     /* application extension header */
 190     /* XXX: not really sure what to put in here... */
 191 #ifdef GIF_ADD_APP_HEADER
 192     put_byte(pb, 0x21);
 193     put_byte(pb, 0xff);
 194     put_byte(pb, 0x0b);
 195     put_tag(pb, "NETSCAPE2.0");
 196     put_byte(pb, 0x03);
 197     put_byte(pb, 0x01);
 198     put_byte(pb, 0x00);
 199     put_byte(pb, 0x00);
 200 #endif
 201     return 0;
 202 }
 203
 204 /* this is maybe slow, but allows for extensions */
 205 static inline unsigned char gif_clut_index(rgb_triplet *clut, UINT8 r, UINT8 g, UINT8 b)
 206 {
 207     return ((((r)/47)%6)*6*6+(((g)/47)%6)*6+(((b)/47)%6));
 208 }
 209
 210
 211 static int gif_image_write_image(ByteIOContext *pb,
 212                                  int x1, int y1, int width, int height,
 213                                  uint8_t *buf, int linesize)
 214 {
 215     PutBitContext p;
 216     UINT8 buffer[200]; /* 100 * 9 / 8 = 113 */
 217     int i, left, w;
 218     uint8_t *ptr;
 219     /* image block */
 220
 221     put_byte(pb, 0x2c);
 222     put_le16(pb, x1);
 223     put_le16(pb, y1);
 224     put_le16(pb, width);
 225     put_le16(pb, height);
 226     put_byte(pb, 0x00); /* flags */
 227     /* no local clut */
 228
 229     put_byte(pb, 0x08);
 230
 231     left= width * height;
 232
 233     init_put_bits(&p, buffer, 130, NULL, NULL);
 234
 235 /*
 236  * the thing here is the bitstream is written as little packets, with a size byte before
 237  * but it's still the same bitstream between packets (no flush !)
 238  */
 239     ptr = buf;
 240     w = width;
 241     while(left>0) {
 242
 243         gif_put_bits_rev(&p, 9, 0x0100); /* clear code */
 244
 245         for(i=0;i<GIF_CHUNKS;i++) {
 246             gif_put_bits_rev(&p, 9, gif_clut_index(NULL, ptr[0], ptr[1], ptr[2]));
 247             ptr+=3;
 248             if (--w == 0) {
 249                 w = width;
 250                 buf += linesize;
 251                 ptr = buf;
 252             }
 253         }
 254
 255         if(left<=GIF_CHUNKS) {
 256             gif_put_bits_rev(&p, 9, 0x101); /* end of stream */
 257             gif_flush_put_bits_rev(&p);
 258         }
 259         if(pbBufPtr(&p) - p.buf > 0) {
 260             put_byte(pb, pbBufPtr(&p) - p.buf); /* byte count of the packet */
 261             put_buffer(pb, p.buf, pbBufPtr(&p) - p.buf); /* the actual buffer */
 262             p.data_out_size += pbBufPtr(&p) - p.buf;
 263             p.buf_ptr = p.buf; /* dequeue the bytes off the bitstream */
 264         }
 265         if(left<=GIF_CHUNKS) {
 266             put_byte(pb, 0x00); /* end of image block */
 267         }
 268
 269         left-=GIF_CHUNKS;
 270     }
 271     return 0;
 272 }
 273
 274 typedef struct {
 275     INT64 time, file_time;
 276     UINT8 buffer[100]; /* data chunks */
 277 } GIFContext;
 278
 279 static int gif_write_header(AVFormatContext *s)
 280 {
 281     GIFContext *gif = s->priv_data;
 282     ByteIOContext *pb = &s->pb;
 283     AVCodecContext *enc, *video_enc;
 284     int i, width, height, rate;
 285
 286 /* XXX: do we reject audio streams or just ignore them ?
 287     if(s->nb_streams > 1)
 288         return -1;
 289 */
 290     gif->time = 0;
 291     gif->file_time = 0;
 292
 293     video_enc = NULL;
 294     for(i=0;i<s->nb_streams;i++) {
 295         enc = &s->streams[i]->codec;
 296         if (enc->codec_type != CODEC_TYPE_AUDIO)
 297             video_enc = enc;
 298     }
 299
 300     if (!video_enc) {
 301         av_free(gif);
 302         return -1;
 303     } else {
 304         width = video_enc->width;
 305         height = video_enc->height;
 306         rate = video_enc->frame_rate;
 307     }
 308
 309     /* XXX: is it allowed ? seems to work so far... */
 310     video_enc->pix_fmt = PIX_FMT_RGB24;
 311
 312     gif_image_write_header(pb, width, height);
 313
 314     put_flush_packet(&s->pb);
 315     return 0;
 316 }
 317
 318 /* chunk writer callback */
 319 /* !!! XXX:deprecated
 320 static void gif_put_chunk(void *pbctx, UINT8 *buffer, int count)
 321 {
 322     ByteIOContext *pb = (ByteIOContext *)pbctx;
 323     put_byte(pb, (UINT8)count);
 324     put_buffer(pb, buffer, count);
 325 }
 326 */
 327
 328 static int gif_write_video(AVFormatContext *s,
 329                            AVCodecContext *enc, UINT8 *buf, int size)
 330 {
 331     ByteIOContext *pb = &s->pb;
 332     GIFContext *gif = s->priv_data;
 333     int jiffies;
 334     INT64 delay;
 335
 336     /* graphic control extension block */
 337     put_byte(pb, 0x21);
 338     put_byte(pb, 0xf9);
 339     put_byte(pb, 0x04); /* block size */
 340     put_byte(pb, 0x04); /* flags */
 341
 342     /* 1 jiffy is 1/70 s */
 343     /* the delay_time field indicates the number of jiffies - 1 */
 344     delay = gif->file_time - gif->time;
 345
 346     /* XXX: should use delay, in order to be more accurate */
 347     /* instead of using the same rounded value each time */
 348     /* XXX: don't even remember if I really use it for now */
 349     jiffies = (70*FRAME_RATE_BASE/enc->frame_rate) - 1;
 350
 351     put_le16(pb, jiffies);
 352
 353     put_byte(pb, 0x1f); /* transparent color index */
 354     put_byte(pb, 0x00);
 355
 356     gif_image_write_image(pb, 0, 0, enc->width, enc->height,
 357                           buf, enc->width * 3);
 358
 359     put_flush_packet(&s->pb);
 360     return 0;
 361 }
 362
 363 static int gif_write_packet(AVFormatContext *s, int stream_index,
 364                            UINT8 *buf, int size, int force_pts)
 365 {
 366     AVCodecContext *codec = &s->streams[stream_index]->codec;
 367     if (codec->codec_type == CODEC_TYPE_AUDIO)
 368         return 0; /* just ignore audio */
 369     else
 370         return gif_write_video(s, codec, buf, size);
 371 }
 372
 373 static int gif_write_trailer(AVFormatContext *s)
 374 {
 375     ByteIOContext *pb = &s->pb;
 376
 377     put_byte(pb, 0x3b);
 378     put_flush_packet(&s->pb);
 379     return 0;
 380 }
 381
 382 /* better than nothing gif image writer */
 383 int gif_write(ByteIOContext *pb, AVImageInfo *info)
 384 {
 385     gif_image_write_header(pb, info->width, info->height);
 386     gif_image_write_image(pb, 0, 0, info->width, info->height,
 387                           info->pict.data[0], info->pict.linesize[0]);
 388     put_byte(pb, 0x3b);
 389     put_flush_packet(pb);
 390     return 0;
 391 }
 392
 393 static AVOutputFormat gif_oformat = {
 394     "gif",
 395     "GIF Animation",
 396     "image/gif",
 397     "gif",
 398     sizeof(GIFContext),
 399     CODEC_ID_NONE,
 400     CODEC_ID_RAWVIDEO,
 401     gif_write_header,
 402     gif_write_packet,
 403     gif_write_trailer,
 404 };
 405
 406 extern AVInputFormat gif_iformat;
 407
 408 int gif_init(void)
 409 {
 410     av_register_output_format(&gif_oformat);
 411     av_register_input_format(&gif_iformat);
 412     return 0;
 413 }