git.sesse.net Git - ffmpeg/blob - libavcodec/gif.c

   1 /*
   2  * GIF encoder.
   3  * Copyright (c) 2000 Fabrice Bellard
   4  * Copyright (c) 2002 Francois Revol
   5  * Copyright (c) 2006 Baptiste Coudurier
   6  *
   7  * This file is part of FFmpeg.
   8  *
   9  * FFmpeg is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2.1 of the License, or (at your option) any later version.
  13  *
  14  * FFmpeg is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with FFmpeg; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  22  */
  23
  24 /*
  25  * First version by Francois Revol revol@free.fr
  26  *
  27  * Features and limitations:
  28  * - currently no compression is performed,
  29  *   in fact the size of the data is 9/8 the size of the image in 8bpp
  30  * - uses only a global standard palette
  31  * - tested with IE 5.0, Opera for BeOS, NetPositive (BeOS), and Mozilla (BeOS).
  32  *
  33  * Reference documents:
  34  * http://www.goice.co.jp/member/mo/formats/gif.html
  35  * http://astronomy.swin.edu.au/pbourke/dataformats/gif/
  36  * http://www.dcs.ed.ac.uk/home/mxr/gfx/2d/GIF89a.txt
  37  *
  38  * this url claims to have an LZW algorithm not covered by Unisys patent:
  39  * http://www.msg.net/utility/whirlgif/gifencod.html
  40  * could help reduce the size of the files _a lot_...
  41  * some sites mentions an RLE type compression also.
  42  */
  43
  44 #include "avcodec.h"
  45 #include "bytestream.h"
  46
  47 /* The GIF format uses reversed order for bitstreams... */
  48 /* at least they don't use PDP_ENDIAN :) */
  49 #define BITSTREAM_WRITER_LE
  50
  51 #include "put_bits.h"
  52
  53 /* bitstream minipacket size */
  54 #define GIF_CHUNKS 100
  55
  56 typedef struct {
  57     AVFrame picture;
  58 } GIFContext;
  59
  60 /* GIF header */
  61 static int gif_image_write_header(AVCodecContext *avctx,
  62                                   uint8_t **bytestream, uint32_t *palette)
  63 {
  64     int i;
  65     unsigned int v;
  66
  67     bytestream_put_buffer(bytestream, "GIF", 3);
  68     bytestream_put_buffer(bytestream, "89a", 3);
  69     bytestream_put_le16(bytestream, avctx->width);
  70     bytestream_put_le16(bytestream, avctx->height);
  71
  72     bytestream_put_byte(bytestream, 0xf7); /* flags: global clut, 256 entries */
  73     bytestream_put_byte(bytestream, 0x1f); /* background color index */
  74     bytestream_put_byte(bytestream, 0); /* aspect ratio */
  75
  76     /* the global palette */
  77     for(i=0;i<256;i++) {
  78         v = palette[i];
  79         bytestream_put_be24(bytestream, v);
  80     }
  81
  82     return 0;
  83 }
  84
  85 static int gif_image_write_image(AVCodecContext *avctx, uint8_t **bytestream,
  86                                  const uint8_t *buf, int linesize)
  87 {
  88     PutBitContext p;
  89     uint8_t buffer[200]; /* 100 * 9 / 8 = 113 */
  90     int i, left, w;
  91     const uint8_t *ptr;
  92     /* image block */
  93
  94     bytestream_put_byte(bytestream, 0x2c);
  95     bytestream_put_le16(bytestream, 0);
  96     bytestream_put_le16(bytestream, 0);
  97     bytestream_put_le16(bytestream, avctx->width);
  98     bytestream_put_le16(bytestream, avctx->height);
  99     bytestream_put_byte(bytestream, 0x00); /* flags */
 100     /* no local clut */
 101
 102     bytestream_put_byte(bytestream, 0x08);
 103
 104     left= avctx->width * avctx->height;
 105
 106     init_put_bits(&p, buffer, 130);
 107
 108 /*
 109  * the thing here is the bitstream is written as little packets, with a size byte before
 110  * but it's still the same bitstream between packets (no flush !)
 111  */
 112     ptr = buf;
 113     w = avctx->width;
 114     while(left>0) {
 115
 116         put_bits(&p, 9, 0x0100); /* clear code */
 117
 118         for(i=(left<GIF_CHUNKS)?left:GIF_CHUNKS;i;i--) {
 119             put_bits(&p, 9, *ptr++);
 120             if (--w == 0) {
 121                 w = avctx->width;
 122                 buf += linesize;
 123                 ptr = buf;
 124             }
 125         }
 126
 127         if(left<=GIF_CHUNKS) {
 128             put_bits(&p, 9, 0x101); /* end of stream */
 129             flush_put_bits(&p);
 130         }
 131         if(put_bits_ptr(&p) - p.buf > 0) {
 132             bytestream_put_byte(bytestream, put_bits_ptr(&p) - p.buf); /* byte count of the packet */
 133             bytestream_put_buffer(bytestream, p.buf, put_bits_ptr(&p) - p.buf); /* the actual buffer */
 134             p.buf_ptr = p.buf; /* dequeue the bytes off the bitstream */
 135         }
 136         left-=GIF_CHUNKS;
 137     }
 138     bytestream_put_byte(bytestream, 0x00); /* end of image block */
 139     bytestream_put_byte(bytestream, 0x3b);
 140     return 0;
 141 }
 142
 143 static av_cold int gif_encode_init(AVCodecContext *avctx)
 144 {
 145     GIFContext *s = avctx->priv_data;
 146
 147     avctx->coded_frame = &s->picture;
 148     return 0;
 149 }
 150
 151 /* better than nothing gif encoder */
 152 static int gif_encode_frame(AVCodecContext *avctx, unsigned char *outbuf, int buf_size, void *data)
 153 {
 154     GIFContext *s = avctx->priv_data;
 155     AVFrame *pict = data;
 156     AVFrame *const p = (AVFrame *)&s->picture;
 157     uint8_t *outbuf_ptr = outbuf;
 158
 159     *p = *pict;
 160     p->pict_type = FF_I_TYPE;
 161     p->key_frame = 1;
 162     gif_image_write_header(avctx, &outbuf_ptr, (uint32_t *)pict->data[1]);
 163     gif_image_write_image(avctx, &outbuf_ptr, pict->data[0], pict->linesize[0]);
 164     return outbuf_ptr - outbuf;
 165 }
 166
 167 AVCodec gif_encoder = {
 168     "gif",
 169     CODEC_TYPE_VIDEO,
 170     CODEC_ID_GIF,
 171     sizeof(GIFContext),
 172     gif_encode_init,
 173     gif_encode_frame,
 174     NULL, //encode_end,
 175     .pix_fmts= (const enum PixelFormat[]){PIX_FMT_RGB8, PIX_FMT_BGR8, PIX_FMT_RGB4_BYTE, PIX_FMT_BGR4_BYTE, PIX_FMT_GRAY8, PIX_FMT_PAL8, PIX_FMT_NONE},
 176     .long_name= NULL_IF_CONFIG_SMALL("GIF (Graphics Interchange Format)"),
 177 };