3 * Copyright (c) 2003 Fabrice Bellard
4 * Copyright (c) 2006 Baptiste Coudurier
5 * Copyright (c) 2012 Vitaliy E Sugrobov
7 * This file is part of FFmpeg.
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.
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.
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
24 #include "libavutil/imgutils.h"
25 #include "libavutil/opt.h"
27 #include "bytestream.h"
32 /* This value is intentionally set to "transparent white" color.
33 * It is much better to have white background instead of black
34 * when gif image converted to format which not support transparency.
36 #define GIF_TRANSPARENT_COLOR 0x00ffffff
38 typedef struct GifState {
43 int has_global_palette;
46 int background_color_index;
47 int transparent_color_index;
49 /* intermediate buffer for storing color indices
50 * obtained from lzw-encoded data stream */
54 /* after the frame is displayed, the disposal method is used */
55 int gce_prev_disposal;
57 /* rectangle describing area that must be disposed */
58 int gce_l, gce_t, gce_w, gce_h;
59 /* depending on disposal method we store either part of the image
60 * drawn on the canvas or background color that
61 * should be used upon disposal */
62 uint32_t * stored_img;
70 uint32_t global_palette[256];
71 uint32_t local_palette[256];
73 AVCodecContext *avctx;
76 int trans_color; /**< color value that is used instead of transparent color */
79 static void gif_read_palette(GifState *s, uint32_t *pal, int nb)
83 for (i = 0; i < nb; i++, pal++)
84 *pal = (0xffu << 24) | bytestream2_get_be24u(&s->gb);
87 static void gif_fill(AVFrame *picture, uint32_t color)
89 uint32_t *p = (uint32_t *)picture->data[0];
90 uint32_t *p_end = p + (picture->linesize[0] / sizeof(uint32_t)) * picture->height;
92 for (; p < p_end; p++)
96 static void gif_fill_rect(AVFrame *picture, uint32_t color, int l, int t, int w, int h)
98 const int linesize = picture->linesize[0] / sizeof(uint32_t);
99 const uint32_t *py = (uint32_t *)picture->data[0] + t * linesize;
100 const uint32_t *pr, *pb = py + h * linesize;
103 for (; py < pb; py += linesize) {
104 px = (uint32_t *)py + l;
107 for (; px < pr; px++)
112 static void gif_copy_img_rect(const uint32_t *src, uint32_t *dst,
113 int linesize, int l, int t, int w, int h)
115 const int y_start = t * linesize;
116 const uint32_t *src_px,
117 *src_py = src + y_start,
118 *dst_py = dst + y_start;
119 const uint32_t *src_pb = src_py + h * linesize;
122 for (; src_py < src_pb; src_py += linesize, dst_py += linesize) {
124 dst_px = (uint32_t *)dst_py + l;
126 memcpy(dst_px, src_px, w * sizeof(uint32_t));
130 static int gif_read_image(GifState *s, AVFrame *frame)
132 int left, top, width, height, bits_per_pixel, code_size, flags;
133 int is_interleaved, has_local_palette, y, pass, y1, linesize, pal_size;
134 uint32_t *ptr, *pal, *px, *pr, *ptr1;
138 /* At least 9 bytes of Image Descriptor. */
139 if (bytestream2_get_bytes_left(&s->gb) < 9)
140 return AVERROR_INVALIDDATA;
142 left = bytestream2_get_le16u(&s->gb);
143 top = bytestream2_get_le16u(&s->gb);
144 width = bytestream2_get_le16u(&s->gb);
145 height = bytestream2_get_le16u(&s->gb);
146 flags = bytestream2_get_byteu(&s->gb);
147 is_interleaved = flags & 0x40;
148 has_local_palette = flags & 0x80;
149 bits_per_pixel = (flags & 0x07) + 1;
151 av_dlog(s->avctx, "image x=%d y=%d w=%d h=%d\n", left, top, width, height);
153 if (has_local_palette) {
154 pal_size = 1 << bits_per_pixel;
156 if (bytestream2_get_bytes_left(&s->gb) < pal_size * 3)
157 return AVERROR_INVALIDDATA;
159 gif_read_palette(s, s->local_palette, pal_size);
160 pal = s->local_palette;
162 if (!s->has_global_palette) {
163 av_log(s->avctx, AV_LOG_ERROR, "picture doesn't have either global or local palette.\n");
164 return AVERROR_INVALIDDATA;
167 pal = s->global_palette;
171 if (s->transparent_color_index == -1 && s->has_global_palette) {
172 /* transparency wasn't set before the first frame, fill with background color */
173 gif_fill(frame, s->bg_color);
175 /* otherwise fill with transparent color.
176 * this is necessary since by default picture filled with 0x80808080. */
177 gif_fill(frame, s->trans_color);
181 /* verify that all the image is inside the screen dimensions */
182 if (left + width > s->screen_width ||
183 top + height > s->screen_height) {
184 av_log(s->avctx, AV_LOG_ERROR, "image is outside the screen dimensions.\n");
185 return AVERROR_INVALIDDATA;
187 if (width <= 0 || height <= 0) {
188 av_log(s->avctx, AV_LOG_ERROR, "Invalid image dimensions.\n");
189 return AVERROR_INVALIDDATA;
192 /* process disposal method */
193 if (s->gce_prev_disposal == GCE_DISPOSAL_BACKGROUND) {
194 gif_fill_rect(frame, s->stored_bg_color, s->gce_l, s->gce_t, s->gce_w, s->gce_h);
195 } else if (s->gce_prev_disposal == GCE_DISPOSAL_RESTORE) {
196 gif_copy_img_rect(s->stored_img, (uint32_t *)frame->data[0],
197 frame->linesize[0] / sizeof(uint32_t), s->gce_l, s->gce_t, s->gce_w, s->gce_h);
200 s->gce_prev_disposal = s->gce_disposal;
202 if (s->gce_disposal != GCE_DISPOSAL_NONE) {
203 s->gce_l = left; s->gce_t = top;
204 s->gce_w = width; s->gce_h = height;
206 if (s->gce_disposal == GCE_DISPOSAL_BACKGROUND) {
207 if (s->transparent_color_index >= 0)
208 s->stored_bg_color = s->trans_color;
210 s->stored_bg_color = s->bg_color;
211 } else if (s->gce_disposal == GCE_DISPOSAL_RESTORE) {
212 av_fast_malloc(&s->stored_img, &s->stored_img_size, frame->linesize[0] * frame->height);
214 return AVERROR(ENOMEM);
216 gif_copy_img_rect((uint32_t *)frame->data[0], s->stored_img,
217 frame->linesize[0] / sizeof(uint32_t), left, top, width, height);
221 /* Expect at least 2 bytes: 1 for lzw code size and 1 for block size. */
222 if (bytestream2_get_bytes_left(&s->gb) < 2)
223 return AVERROR_INVALIDDATA;
225 /* now get the image data */
226 code_size = bytestream2_get_byteu(&s->gb);
227 if ((ret = ff_lzw_decode_init(s->lzw, code_size, s->gb.buffer,
228 bytestream2_get_bytes_left(&s->gb), FF_LZW_GIF)) < 0) {
229 av_log(s->avctx, AV_LOG_ERROR, "LZW init failed\n");
233 /* read all the image */
234 linesize = frame->linesize[0] / sizeof(uint32_t);
235 ptr1 = (uint32_t *)frame->data[0] + top * linesize + left;
239 for (y = 0; y < height; y++) {
240 int count = ff_lzw_decode(s->lzw, s->idx_line, width);
241 if (count != width) {
243 av_log(s->avctx, AV_LOG_ERROR, "LZW decode failed\n");
249 for (px = ptr, idx = s->idx_line; px < pr; px++, idx++) {
250 if (*idx != s->transparent_color_index)
254 if (is_interleaved) {
263 ptr = ptr1 + linesize * y1;
272 ptr = ptr1 + linesize;
287 /* read the garbage data until end marker is found */
288 ff_lzw_decode_tail(s->lzw);
290 /* Graphic Control Extension's scope is single frame.
291 * Remove its influence. */
292 s->transparent_color_index = -1;
293 s->gce_disposal = GCE_DISPOSAL_NONE;
298 static int gif_read_extension(GifState *s)
300 int ext_code, ext_len, gce_flags, gce_transparent_index;
302 /* There must be at least 2 bytes:
303 * 1 for extension label and 1 for extension length. */
304 if (bytestream2_get_bytes_left(&s->gb) < 2)
305 return AVERROR_INVALIDDATA;
307 ext_code = bytestream2_get_byteu(&s->gb);
308 ext_len = bytestream2_get_byteu(&s->gb);
310 av_dlog(s->avctx, "ext_code=0x%x len=%d\n", ext_code, ext_len);
313 case GIF_GCE_EXT_LABEL:
317 /* We need at least 5 bytes more: 4 is for extension body
318 * and 1 for next block size. */
319 if (bytestream2_get_bytes_left(&s->gb) < 5)
320 return AVERROR_INVALIDDATA;
322 gce_flags = bytestream2_get_byteu(&s->gb);
323 bytestream2_skipu(&s->gb, 2); // delay during which the frame is shown
324 gce_transparent_index = bytestream2_get_byteu(&s->gb);
325 if (gce_flags & 0x01)
326 s->transparent_color_index = gce_transparent_index;
328 s->transparent_color_index = -1;
329 s->gce_disposal = (gce_flags >> 2) & 0x7;
331 av_dlog(s->avctx, "gce_flags=%x tcolor=%d disposal=%d\n",
333 s->transparent_color_index, s->gce_disposal);
335 if (s->gce_disposal > 3) {
336 s->gce_disposal = GCE_DISPOSAL_NONE;
337 av_dlog(s->avctx, "invalid value in gce_disposal (%d). Using default value of 0.\n", ext_len);
340 ext_len = bytestream2_get_byteu(&s->gb);
344 /* NOTE: many extension blocks can come after */
347 /* There must be at least ext_len bytes and 1 for next block size byte. */
348 if (bytestream2_get_bytes_left(&s->gb) < ext_len + 1)
349 return AVERROR_INVALIDDATA;
351 bytestream2_skipu(&s->gb, ext_len);
352 ext_len = bytestream2_get_byteu(&s->gb);
354 av_dlog(s->avctx, "ext_len1=%d\n", ext_len);
359 static int gif_read_header1(GifState *s)
363 int background_color_index;
365 if (bytestream2_get_bytes_left(&s->gb) < 13)
366 return AVERROR_INVALIDDATA;
368 /* read gif signature */
369 bytestream2_get_bufferu(&s->gb, sig, 6);
370 if (memcmp(sig, gif87a_sig, 6) &&
371 memcmp(sig, gif89a_sig, 6))
372 return AVERROR_INVALIDDATA;
374 /* read screen header */
375 s->transparent_color_index = -1;
376 s->screen_width = bytestream2_get_le16u(&s->gb);
377 s->screen_height = bytestream2_get_le16u(&s->gb);
379 v = bytestream2_get_byteu(&s->gb);
380 s->color_resolution = ((v & 0x70) >> 4) + 1;
381 s->has_global_palette = (v & 0x80);
382 s->bits_per_pixel = (v & 0x07) + 1;
383 background_color_index = bytestream2_get_byteu(&s->gb);
384 n = bytestream2_get_byteu(&s->gb);
386 s->avctx->sample_aspect_ratio.num = n + 15;
387 s->avctx->sample_aspect_ratio.den = 64;
390 av_dlog(s->avctx, "screen_w=%d screen_h=%d bpp=%d global_palette=%d\n",
391 s->screen_width, s->screen_height, s->bits_per_pixel,
392 s->has_global_palette);
394 if (s->has_global_palette) {
395 s->background_color_index = background_color_index;
396 n = 1 << s->bits_per_pixel;
397 if (bytestream2_get_bytes_left(&s->gb) < n * 3)
398 return AVERROR_INVALIDDATA;
400 gif_read_palette(s, s->global_palette, n);
401 s->bg_color = s->global_palette[s->background_color_index];
403 s->background_color_index = -1;
408 static int gif_parse_next_image(GifState *s, AVFrame *frame)
410 while (bytestream2_get_bytes_left(&s->gb) > 0) {
411 int code = bytestream2_get_byte(&s->gb);
414 av_log(s->avctx, AV_LOG_DEBUG, "code=%02x '%c'\n", code, code);
417 case GIF_IMAGE_SEPARATOR:
418 return gif_read_image(s, frame);
419 case GIF_EXTENSION_INTRODUCER:
420 if ((ret = gif_read_extension(s)) < 0)
427 /* erroneous block label */
428 return AVERROR_INVALIDDATA;
434 static av_cold int gif_decode_init(AVCodecContext *avctx)
436 GifState *s = avctx->priv_data;
440 avctx->pix_fmt = AV_PIX_FMT_RGB32;
441 s->frame = av_frame_alloc();
443 return AVERROR(ENOMEM);
444 ff_lzw_decode_open(&s->lzw);
448 static int gif_decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
450 GifState *s = avctx->priv_data;
453 bytestream2_init(&s->gb, avpkt->data, avpkt->size);
455 s->frame->pts = avpkt->pts;
456 s->frame->pkt_pts = avpkt->pts;
457 s->frame->pkt_dts = avpkt->dts;
458 av_frame_set_pkt_duration(s->frame, avpkt->duration);
460 if (avpkt->size >= 6) {
461 s->keyframe = memcmp(avpkt->data, gif87a_sig, 6) == 0 ||
462 memcmp(avpkt->data, gif89a_sig, 6) == 0;
469 s->gce_prev_disposal = GCE_DISPOSAL_NONE;
470 if ((ret = gif_read_header1(s)) < 0)
473 if ((ret = ff_set_dimensions(avctx, s->screen_width, s->screen_height)) < 0)
476 av_frame_unref(s->frame);
477 if ((ret = ff_get_buffer(avctx, s->frame, 0)) < 0)
480 av_fast_malloc(&s->idx_line, &s->idx_line_size, s->screen_width);
482 return AVERROR(ENOMEM);
484 s->frame->pict_type = AV_PICTURE_TYPE_I;
485 s->frame->key_frame = 1;
488 if (!s->keyframe_ok) {
489 av_log(avctx, AV_LOG_ERROR, "cannot decode frame without keyframe\n");
490 return AVERROR_INVALIDDATA;
493 if ((ret = ff_reget_buffer(avctx, s->frame)) < 0)
496 s->frame->pict_type = AV_PICTURE_TYPE_P;
497 s->frame->key_frame = 0;
500 ret = gif_parse_next_image(s, s->frame);
504 if ((ret = av_frame_ref(data, s->frame)) < 0)
508 return bytestream2_tell(&s->gb);
511 static av_cold int gif_decode_close(AVCodecContext *avctx)
513 GifState *s = avctx->priv_data;
515 ff_lzw_decode_close(&s->lzw);
516 av_frame_free(&s->frame);
517 av_freep(&s->idx_line);
518 av_freep(&s->stored_img);
523 static const AVOption options[] = {
524 { "trans_color", "color value (ARGB) that is used instead of transparent color",
525 offsetof(GifState, trans_color), AV_OPT_TYPE_INT,
526 {.i64 = GIF_TRANSPARENT_COLOR}, 0, 0xffffffff,
527 AV_OPT_FLAG_DECODING_PARAM|AV_OPT_FLAG_VIDEO_PARAM },
531 static const AVClass decoder_class = {
532 .class_name = "gif decoder",
533 .item_name = av_default_item_name,
535 .version = LIBAVUTIL_VERSION_INT,
536 .category = AV_CLASS_CATEGORY_DECODER,
539 AVCodec ff_gif_decoder = {
541 .long_name = NULL_IF_CONFIG_SMALL("GIF (Graphics Interchange Format)"),
542 .type = AVMEDIA_TYPE_VIDEO,
543 .id = AV_CODEC_ID_GIF,
544 .priv_data_size = sizeof(GifState),
545 .init = gif_decode_init,
546 .close = gif_decode_close,
547 .decode = gif_decode_frame,
548 .capabilities = CODEC_CAP_DR1,
549 .priv_class = &decoder_class,