3 * Copyright (c) 2000 Fabrice Bellard.
5 * This file is part of FFmpeg.
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.
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.
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
23 * First version by Francois Revol revol@free.fr
25 * Features and limitations:
26 * - currently no compression is performed,
27 * in fact the size of the data is 9/8 the size of the image in 8bpp
28 * - uses only a global standard palette
29 * - tested with IE 5.0, Opera for BeOS, NetPositive (BeOS), and Mozilla (BeOS).
31 * Reference documents:
32 * http://www.goice.co.jp/member/mo/formats/gif.html
33 * http://astronomy.swin.edu.au/pbourke/dataformats/gif/
34 * http://www.dcs.ed.ac.uk/home/mxr/gfx/2d/GIF89a.txt
36 * this url claims to have an LZW algorithm not covered by Unisys patent:
37 * http://www.msg.net/utility/whirlgif/gifencod.html
38 * could help reduce the size of the files _a lot_...
39 * some sites mentions an RLE type compression also.
43 #include "libavcodec/bitstream.h"
45 /* bitstream minipacket size */
46 #define GIF_CHUNKS 100
48 /* slows down the decoding (and some browsers don't like it) */
49 /* update on the 'some browsers don't like it issue from above: this was probably due to missing 'Data Sub-block Terminator' (byte 19) in the app_header */
50 #define GIF_ADD_APP_HEADER // required to enable looping of animated gif
58 /* we use the standard 216 color palette */
60 /* this script was used to create the palette:
61 * 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
62 * echo -n "{ 0x$r, 0x$g, 0x$b }, "; done; echo ""; done; done
65 static const rgb_triplet gif_clut
[216] = {
66 { 0x00, 0x00, 0x00 }, { 0x00, 0x00, 0x33 }, { 0x00, 0x00, 0x66 }, { 0x00, 0x00, 0x99 }, { 0x00, 0x00, 0xcc }, { 0x00, 0x00, 0xff },
67 { 0x00, 0x33, 0x00 }, { 0x00, 0x33, 0x33 }, { 0x00, 0x33, 0x66 }, { 0x00, 0x33, 0x99 }, { 0x00, 0x33, 0xcc }, { 0x00, 0x33, 0xff },
68 { 0x00, 0x66, 0x00 }, { 0x00, 0x66, 0x33 }, { 0x00, 0x66, 0x66 }, { 0x00, 0x66, 0x99 }, { 0x00, 0x66, 0xcc }, { 0x00, 0x66, 0xff },
69 { 0x00, 0x99, 0x00 }, { 0x00, 0x99, 0x33 }, { 0x00, 0x99, 0x66 }, { 0x00, 0x99, 0x99 }, { 0x00, 0x99, 0xcc }, { 0x00, 0x99, 0xff },
70 { 0x00, 0xcc, 0x00 }, { 0x00, 0xcc, 0x33 }, { 0x00, 0xcc, 0x66 }, { 0x00, 0xcc, 0x99 }, { 0x00, 0xcc, 0xcc }, { 0x00, 0xcc, 0xff },
71 { 0x00, 0xff, 0x00 }, { 0x00, 0xff, 0x33 }, { 0x00, 0xff, 0x66 }, { 0x00, 0xff, 0x99 }, { 0x00, 0xff, 0xcc }, { 0x00, 0xff, 0xff },
72 { 0x33, 0x00, 0x00 }, { 0x33, 0x00, 0x33 }, { 0x33, 0x00, 0x66 }, { 0x33, 0x00, 0x99 }, { 0x33, 0x00, 0xcc }, { 0x33, 0x00, 0xff },
73 { 0x33, 0x33, 0x00 }, { 0x33, 0x33, 0x33 }, { 0x33, 0x33, 0x66 }, { 0x33, 0x33, 0x99 }, { 0x33, 0x33, 0xcc }, { 0x33, 0x33, 0xff },
74 { 0x33, 0x66, 0x00 }, { 0x33, 0x66, 0x33 }, { 0x33, 0x66, 0x66 }, { 0x33, 0x66, 0x99 }, { 0x33, 0x66, 0xcc }, { 0x33, 0x66, 0xff },
75 { 0x33, 0x99, 0x00 }, { 0x33, 0x99, 0x33 }, { 0x33, 0x99, 0x66 }, { 0x33, 0x99, 0x99 }, { 0x33, 0x99, 0xcc }, { 0x33, 0x99, 0xff },
76 { 0x33, 0xcc, 0x00 }, { 0x33, 0xcc, 0x33 }, { 0x33, 0xcc, 0x66 }, { 0x33, 0xcc, 0x99 }, { 0x33, 0xcc, 0xcc }, { 0x33, 0xcc, 0xff },
77 { 0x33, 0xff, 0x00 }, { 0x33, 0xff, 0x33 }, { 0x33, 0xff, 0x66 }, { 0x33, 0xff, 0x99 }, { 0x33, 0xff, 0xcc }, { 0x33, 0xff, 0xff },
78 { 0x66, 0x00, 0x00 }, { 0x66, 0x00, 0x33 }, { 0x66, 0x00, 0x66 }, { 0x66, 0x00, 0x99 }, { 0x66, 0x00, 0xcc }, { 0x66, 0x00, 0xff },
79 { 0x66, 0x33, 0x00 }, { 0x66, 0x33, 0x33 }, { 0x66, 0x33, 0x66 }, { 0x66, 0x33, 0x99 }, { 0x66, 0x33, 0xcc }, { 0x66, 0x33, 0xff },
80 { 0x66, 0x66, 0x00 }, { 0x66, 0x66, 0x33 }, { 0x66, 0x66, 0x66 }, { 0x66, 0x66, 0x99 }, { 0x66, 0x66, 0xcc }, { 0x66, 0x66, 0xff },
81 { 0x66, 0x99, 0x00 }, { 0x66, 0x99, 0x33 }, { 0x66, 0x99, 0x66 }, { 0x66, 0x99, 0x99 }, { 0x66, 0x99, 0xcc }, { 0x66, 0x99, 0xff },
82 { 0x66, 0xcc, 0x00 }, { 0x66, 0xcc, 0x33 }, { 0x66, 0xcc, 0x66 }, { 0x66, 0xcc, 0x99 }, { 0x66, 0xcc, 0xcc }, { 0x66, 0xcc, 0xff },
83 { 0x66, 0xff, 0x00 }, { 0x66, 0xff, 0x33 }, { 0x66, 0xff, 0x66 }, { 0x66, 0xff, 0x99 }, { 0x66, 0xff, 0xcc }, { 0x66, 0xff, 0xff },
84 { 0x99, 0x00, 0x00 }, { 0x99, 0x00, 0x33 }, { 0x99, 0x00, 0x66 }, { 0x99, 0x00, 0x99 }, { 0x99, 0x00, 0xcc }, { 0x99, 0x00, 0xff },
85 { 0x99, 0x33, 0x00 }, { 0x99, 0x33, 0x33 }, { 0x99, 0x33, 0x66 }, { 0x99, 0x33, 0x99 }, { 0x99, 0x33, 0xcc }, { 0x99, 0x33, 0xff },
86 { 0x99, 0x66, 0x00 }, { 0x99, 0x66, 0x33 }, { 0x99, 0x66, 0x66 }, { 0x99, 0x66, 0x99 }, { 0x99, 0x66, 0xcc }, { 0x99, 0x66, 0xff },
87 { 0x99, 0x99, 0x00 }, { 0x99, 0x99, 0x33 }, { 0x99, 0x99, 0x66 }, { 0x99, 0x99, 0x99 }, { 0x99, 0x99, 0xcc }, { 0x99, 0x99, 0xff },
88 { 0x99, 0xcc, 0x00 }, { 0x99, 0xcc, 0x33 }, { 0x99, 0xcc, 0x66 }, { 0x99, 0xcc, 0x99 }, { 0x99, 0xcc, 0xcc }, { 0x99, 0xcc, 0xff },
89 { 0x99, 0xff, 0x00 }, { 0x99, 0xff, 0x33 }, { 0x99, 0xff, 0x66 }, { 0x99, 0xff, 0x99 }, { 0x99, 0xff, 0xcc }, { 0x99, 0xff, 0xff },
90 { 0xcc, 0x00, 0x00 }, { 0xcc, 0x00, 0x33 }, { 0xcc, 0x00, 0x66 }, { 0xcc, 0x00, 0x99 }, { 0xcc, 0x00, 0xcc }, { 0xcc, 0x00, 0xff },
91 { 0xcc, 0x33, 0x00 }, { 0xcc, 0x33, 0x33 }, { 0xcc, 0x33, 0x66 }, { 0xcc, 0x33, 0x99 }, { 0xcc, 0x33, 0xcc }, { 0xcc, 0x33, 0xff },
92 { 0xcc, 0x66, 0x00 }, { 0xcc, 0x66, 0x33 }, { 0xcc, 0x66, 0x66 }, { 0xcc, 0x66, 0x99 }, { 0xcc, 0x66, 0xcc }, { 0xcc, 0x66, 0xff },
93 { 0xcc, 0x99, 0x00 }, { 0xcc, 0x99, 0x33 }, { 0xcc, 0x99, 0x66 }, { 0xcc, 0x99, 0x99 }, { 0xcc, 0x99, 0xcc }, { 0xcc, 0x99, 0xff },
94 { 0xcc, 0xcc, 0x00 }, { 0xcc, 0xcc, 0x33 }, { 0xcc, 0xcc, 0x66 }, { 0xcc, 0xcc, 0x99 }, { 0xcc, 0xcc, 0xcc }, { 0xcc, 0xcc, 0xff },
95 { 0xcc, 0xff, 0x00 }, { 0xcc, 0xff, 0x33 }, { 0xcc, 0xff, 0x66 }, { 0xcc, 0xff, 0x99 }, { 0xcc, 0xff, 0xcc }, { 0xcc, 0xff, 0xff },
96 { 0xff, 0x00, 0x00 }, { 0xff, 0x00, 0x33 }, { 0xff, 0x00, 0x66 }, { 0xff, 0x00, 0x99 }, { 0xff, 0x00, 0xcc }, { 0xff, 0x00, 0xff },
97 { 0xff, 0x33, 0x00 }, { 0xff, 0x33, 0x33 }, { 0xff, 0x33, 0x66 }, { 0xff, 0x33, 0x99 }, { 0xff, 0x33, 0xcc }, { 0xff, 0x33, 0xff },
98 { 0xff, 0x66, 0x00 }, { 0xff, 0x66, 0x33 }, { 0xff, 0x66, 0x66 }, { 0xff, 0x66, 0x99 }, { 0xff, 0x66, 0xcc }, { 0xff, 0x66, 0xff },
99 { 0xff, 0x99, 0x00 }, { 0xff, 0x99, 0x33 }, { 0xff, 0x99, 0x66 }, { 0xff, 0x99, 0x99 }, { 0xff, 0x99, 0xcc }, { 0xff, 0x99, 0xff },
100 { 0xff, 0xcc, 0x00 }, { 0xff, 0xcc, 0x33 }, { 0xff, 0xcc, 0x66 }, { 0xff, 0xcc, 0x99 }, { 0xff, 0xcc, 0xcc }, { 0xff, 0xcc, 0xff },
101 { 0xff, 0xff, 0x00 }, { 0xff, 0xff, 0x33 }, { 0xff, 0xff, 0x66 }, { 0xff, 0xff, 0x99 }, { 0xff, 0xff, 0xcc }, { 0xff, 0xff, 0xff },
104 /* The GIF format uses reversed order for bitstreams... */
105 /* at least they don't use PDP_ENDIAN :) */
106 /* so we 'extend' PutBitContext. hmmm, OOP :) */
107 /* seems this thing changed slightly since I wrote it... */
109 #ifdef ALT_BITSTREAM_WRITER
110 # error no ALT_BITSTREAM_WRITER support for now
113 static void gif_put_bits_rev(PutBitContext
*s
, int n
, unsigned int value
)
115 unsigned int bit_buf
;
118 // printf("put_bits=%d %x\n", n, value);
119 assert(n
== 32 || value
< (1U << n
));
121 bit_buf
= s
->bit_buf
;
122 bit_cnt
= 32 - s
->bit_left
; /* XXX:lazyness... was = s->bit_cnt; */
124 // printf("n=%d value=%x cnt=%d buf=%x\n", n, value, bit_cnt, bit_buf);
126 if (n
< (32-bit_cnt
)) {
127 bit_buf
|= value
<< (bit_cnt
);
130 bit_buf
|= value
<< (bit_cnt
);
132 *s
->buf_ptr
= bit_buf
& 0xff;
133 s
->buf_ptr
[1] = (bit_buf
>> 8) & 0xff;
134 s
->buf_ptr
[2] = (bit_buf
>> 16) & 0xff;
135 s
->buf_ptr
[3] = (bit_buf
>> 24) & 0xff;
137 //printf("bitbuf = %08x\n", bit_buf);
139 if (s
->buf_ptr
>= s
->buf_end
)
141 // flush_buffer_rev(s);
142 bit_cnt
=bit_cnt
+ n
- 32;
146 bit_buf
= value
>> (n
- bit_cnt
);
150 s
->bit_buf
= bit_buf
;
151 s
->bit_left
= 32 - bit_cnt
;
154 /* pad the end of the output stream with zeros */
155 static void gif_flush_put_bits_rev(PutBitContext
*s
)
157 while (s
->bit_left
< 32) {
158 /* XXX: should test end of buffer */
159 *s
->buf_ptr
++=s
->bit_buf
& 0xff;
163 // flush_buffer_rev(s);
168 /* !RevPutBitContext */
171 static int gif_image_write_header(ByteIOContext
*pb
,
172 int width
, int height
, int loop_count
,
181 put_le16(pb
, height
);
183 put_byte(pb
, 0xf7); /* flags: global clut, 256 entries */
184 put_byte(pb
, 0x1f); /* background color index */
185 put_byte(pb
, 0); /* aspect ratio */
187 /* the global palette */
189 put_buffer(pb
, (const unsigned char *)gif_clut
, 216*3);
190 for(i
=0;i
<((256-216)*3);i
++)
195 put_byte(pb
, (v
>> 16) & 0xff);
196 put_byte(pb
, (v
>> 8) & 0xff);
197 put_byte(pb
, (v
) & 0xff);
201 /* update: this is the 'NETSCAPE EXTENSION' that allows for looped animated gif
202 see http://members.aol.com/royalef/gifabout.htm#net-extension
204 byte 1 : 33 (hex 0x21) GIF Extension code
205 byte 2 : 255 (hex 0xFF) Application Extension Label
206 byte 3 : 11 (hex (0x0B) Length of Application Block
207 (eleven bytes of data to follow)
208 bytes 4 to 11 : "NETSCAPE"
209 bytes 12 to 14 : "2.0"
210 byte 15 : 3 (hex 0x03) Length of Data Sub-Block
211 (three bytes of data to follow)
212 byte 16 : 1 (hex 0x01)
213 bytes 17 to 18 : 0 to 65535, an unsigned integer in
214 lo-hi byte format. This indicate the
215 number of iterations the loop should
217 bytes 19 : 0 (hex 0x00) a Data Sub-block Terminator
220 /* application extension header */
221 #ifdef GIF_ADD_APP_HEADER
222 if (loop_count
>= 0 && loop_count
<= 65535) {
226 put_tag(pb
, "NETSCAPE2.0"); // bytes 4 to 14
227 put_byte(pb
, 0x03); // byte 15
228 put_byte(pb
, 0x01); // byte 16
229 put_le16(pb
, (uint16_t)loop_count
);
230 put_byte(pb
, 0x00); // byte 19
236 /* this is maybe slow, but allows for extensions */
237 static inline unsigned char gif_clut_index(uint8_t r
, uint8_t g
, uint8_t b
)
239 return (((r
) / 47) % 6) * 6 * 6 + (((g
) / 47) % 6) * 6 + (((b
) / 47) % 6);
243 static int gif_image_write_image(ByteIOContext
*pb
,
244 int x1
, int y1
, int width
, int height
,
245 const uint8_t *buf
, int linesize
, int pix_fmt
)
248 uint8_t buffer
[200]; /* 100 * 9 / 8 = 113 */
257 put_le16(pb
, height
);
258 put_byte(pb
, 0x00); /* flags */
263 left
= width
* height
;
265 init_put_bits(&p
, buffer
, 130);
268 * the thing here is the bitstream is written as little packets, with a size byte before
269 * but it's still the same bitstream between packets (no flush !)
275 gif_put_bits_rev(&p
, 9, 0x0100); /* clear code */
277 for(i
=(left
<GIF_CHUNKS
)?left
:GIF_CHUNKS
;i
;i
--) {
278 if (pix_fmt
== PIX_FMT_RGB24
) {
279 v
= gif_clut_index(ptr
[0], ptr
[1], ptr
[2]);
284 gif_put_bits_rev(&p
, 9, v
);
292 if(left
<=GIF_CHUNKS
) {
293 gif_put_bits_rev(&p
, 9, 0x101); /* end of stream */
294 gif_flush_put_bits_rev(&p
);
296 if(pbBufPtr(&p
) - p
.buf
> 0) {
297 put_byte(pb
, pbBufPtr(&p
) - p
.buf
); /* byte count of the packet */
298 put_buffer(pb
, p
.buf
, pbBufPtr(&p
) - p
.buf
); /* the actual buffer */
299 p
.buf_ptr
= p
.buf
; /* dequeue the bytes off the bitstream */
303 put_byte(pb
, 0x00); /* end of image block */
309 int64_t time
, file_time
;
310 uint8_t buffer
[100]; /* data chunks */
313 static int gif_write_header(AVFormatContext
*s
)
315 GIFContext
*gif
= s
->priv_data
;
316 ByteIOContext
*pb
= s
->pb
;
317 AVCodecContext
*enc
, *video_enc
;
318 int i
, width
, height
, loop_count
/*, rate*/;
320 /* XXX: do we reject audio streams or just ignore them ?
321 if(s->nb_streams > 1)
328 for(i
=0;i
<s
->nb_streams
;i
++) {
329 enc
= s
->streams
[i
]->codec
;
330 if (enc
->codec_type
!= CODEC_TYPE_AUDIO
)
338 width
= video_enc
->width
;
339 height
= video_enc
->height
;
340 loop_count
= s
->loop_output
;
341 // rate = video_enc->time_base.den;
344 if (video_enc
->pix_fmt
!= PIX_FMT_RGB24
) {
345 av_log(s
, AV_LOG_ERROR
, "ERROR: gif only handles the rgb24 pixel format. Use -pix_fmt rgb24.\n");
349 gif_image_write_header(pb
, width
, height
, loop_count
, NULL
);
351 put_flush_packet(s
->pb
);
355 static int gif_write_video(AVFormatContext
*s
,
356 AVCodecContext
*enc
, const uint8_t *buf
, int size
)
358 ByteIOContext
*pb
= s
->pb
;
359 GIFContext
*gif
= s
->priv_data
;
363 /* graphic control extension block */
366 put_byte(pb
, 0x04); /* block size */
367 put_byte(pb
, 0x04); /* flags */
369 /* 1 jiffy is 1/70 s */
370 /* the delay_time field indicates the number of jiffies - 1 */
371 delay
= gif
->file_time
- gif
->time
;
373 /* XXX: should use delay, in order to be more accurate */
374 /* instead of using the same rounded value each time */
375 /* XXX: don't even remember if I really use it for now */
376 jiffies
= (70*enc
->time_base
.num
/enc
->time_base
.den
) - 1;
378 put_le16(pb
, jiffies
);
380 put_byte(pb
, 0x1f); /* transparent color index */
383 gif_image_write_image(pb
, 0, 0, enc
->width
, enc
->height
,
384 buf
, enc
->width
* 3, PIX_FMT_RGB24
);
386 put_flush_packet(s
->pb
);
390 static int gif_write_packet(AVFormatContext
*s
, AVPacket
*pkt
)
392 AVCodecContext
*codec
= s
->streams
[pkt
->stream_index
]->codec
;
393 if (codec
->codec_type
== CODEC_TYPE_AUDIO
)
394 return 0; /* just ignore audio */
396 return gif_write_video(s
, codec
, pkt
->data
, pkt
->size
);
399 static int gif_write_trailer(AVFormatContext
*s
)
401 ByteIOContext
*pb
= s
->pb
;
404 put_flush_packet(s
->pb
);
408 AVOutputFormat gif_muxer
= {
410 NULL_IF_CONFIG_SMALL("GIF Animation"),