FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
gifdec.c
Go to the documentation of this file.
1 /*
2  * GIF decoder
3  * Copyright (c) 2003 Fabrice Bellard
4  * Copyright (c) 2006 Baptiste Coudurier
5  * Copyright (c) 2012 Vitaliy E Sugrobov
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 #include "libavutil/imgutils.h"
25 #include "libavutil/opt.h"
26 #include "avcodec.h"
27 #include "bytestream.h"
28 #include "internal.h"
29 #include "lzw.h"
30 #include "gif.h"
31 
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.
35  */
36 #define GIF_TRANSPARENT_COLOR 0x00ffffff
37 
38 typedef struct GifState {
39  const AVClass *class;
45  uint32_t bg_color;
49  /* intermediate buffer for storing color indices
50  * obtained from lzw-encoded data stream */
53 
54  /* after the frame is displayed, the disposal method is used */
57  /* rectangle describing area that must be disposed */
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;
65 
68 
69  /* aux buffers */
70  uint32_t global_palette[256];
71  uint32_t local_palette[256];
72 
74  int keyframe;
76  int trans_color; /**< color value that is used instead of transparent color */
77 } GifState;
78 
79 static void gif_read_palette(GifState *s, uint32_t *pal, int nb)
80 {
81  int i;
82 
83  for (i = 0; i < nb; i++, pal++)
84  *pal = (0xffu << 24) | bytestream2_get_be24u(&s->gb);
85 }
86 
87 static void gif_fill(AVFrame *picture, uint32_t color)
88 {
89  uint32_t *p = (uint32_t *)picture->data[0];
90  uint32_t *p_end = p + (picture->linesize[0] / sizeof(uint32_t)) * picture->height;
91 
92  for (; p < p_end; p++)
93  *p = color;
94 }
95 
96 static void gif_fill_rect(AVFrame *picture, uint32_t color, int l, int t, int w, int h)
97 {
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;
101  uint32_t *px;
102 
103  for (; py < pb; py += linesize) {
104  px = (uint32_t *)py + l;
105  pr = px + w;
106 
107  for (; px < pr; px++)
108  *px = color;
109  }
110 }
111 
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)
114 {
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;
120  uint32_t *dst_px;
121 
122  for (; src_py < src_pb; src_py += linesize, dst_py += linesize) {
123  src_px = src_py + l;
124  dst_px = (uint32_t *)dst_py + l;
125 
126  memcpy(dst_px, src_px, w * sizeof(uint32_t));
127  }
128 }
129 
131 {
132  int left, top, width, height, bits_per_pixel, code_size, flags, pw;
133  int is_interleaved, has_local_palette, y, pass, y1, linesize, pal_size;
134  uint32_t *ptr, *pal, *px, *pr, *ptr1;
135  int ret;
136  uint8_t *idx;
137 
138  /* At least 9 bytes of Image Descriptor. */
139  if (bytestream2_get_bytes_left(&s->gb) < 9)
140  return AVERROR_INVALIDDATA;
141 
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;
150 
151  av_dlog(s->avctx, "image x=%d y=%d w=%d h=%d\n", left, top, width, height);
152 
153  if (has_local_palette) {
154  pal_size = 1 << bits_per_pixel;
155 
156  if (bytestream2_get_bytes_left(&s->gb) < pal_size * 3)
157  return AVERROR_INVALIDDATA;
158 
159  gif_read_palette(s, s->local_palette, pal_size);
160  pal = s->local_palette;
161  } else {
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;
165  }
166 
167  pal = s->global_palette;
168  }
169 
170  if (s->keyframe) {
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);
174  } else {
175  /* otherwise fill with transparent color.
176  * this is necessary since by default picture filled with 0x80808080. */
177  gif_fill(frame, s->trans_color);
178  }
179  }
180 
181  /* verify that all the image is inside the screen dimensions */
182  if (!width || width > s->screen_width || left >= s->screen_width) {
183  av_log(s->avctx, AV_LOG_ERROR, "Invalid image width.\n");
184  return AVERROR_INVALIDDATA;
185  }
186  if (!height || height > s->screen_height || top >= s->screen_height) {
187  av_log(s->avctx, AV_LOG_ERROR, "Invalid image height.\n");
188  return AVERROR_INVALIDDATA;
189  }
190  if (left + width > s->screen_width) {
191  /* width must be kept around to avoid lzw vs line desync */
192  pw = s->screen_width - left;
193  av_log(s->avctx, AV_LOG_WARNING, "Image too wide by %d, truncating.\n",
194  left + width - s->screen_width);
195  } else {
196  pw = width;
197  }
198  if (top + height > s->screen_height) {
199  /* we don't care about the extra invisible lines */
200  av_log(s->avctx, AV_LOG_WARNING, "Image too high by %d, truncating.\n",
201  top + height - s->screen_height);
202  height = s->screen_height - top;
203  }
204 
205  /* process disposal method */
207  gif_fill_rect(frame, s->stored_bg_color, s->gce_l, s->gce_t, s->gce_w, s->gce_h);
208  } else if (s->gce_prev_disposal == GCE_DISPOSAL_RESTORE) {
209  gif_copy_img_rect(s->stored_img, (uint32_t *)frame->data[0],
210  frame->linesize[0] / sizeof(uint32_t), s->gce_l, s->gce_t, s->gce_w, s->gce_h);
211  }
212 
214 
215  if (s->gce_disposal != GCE_DISPOSAL_NONE) {
216  s->gce_l = left; s->gce_t = top;
217  s->gce_w = pw; s->gce_h = height;
218 
220  if (s->transparent_color_index >= 0)
222  else
223  s->stored_bg_color = s->bg_color;
224  } else if (s->gce_disposal == GCE_DISPOSAL_RESTORE) {
225  av_fast_malloc(&s->stored_img, &s->stored_img_size, frame->linesize[0] * frame->height);
226  if (!s->stored_img)
227  return AVERROR(ENOMEM);
228 
229  gif_copy_img_rect((uint32_t *)frame->data[0], s->stored_img,
230  frame->linesize[0] / sizeof(uint32_t), left, top, pw, height);
231  }
232  }
233 
234  /* Expect at least 2 bytes: 1 for lzw code size and 1 for block size. */
235  if (bytestream2_get_bytes_left(&s->gb) < 2)
236  return AVERROR_INVALIDDATA;
237 
238  /* now get the image data */
239  code_size = bytestream2_get_byteu(&s->gb);
240  if ((ret = ff_lzw_decode_init(s->lzw, code_size, s->gb.buffer,
242  av_log(s->avctx, AV_LOG_ERROR, "LZW init failed\n");
243  return ret;
244  }
245 
246  /* read all the image */
247  linesize = frame->linesize[0] / sizeof(uint32_t);
248  ptr1 = (uint32_t *)frame->data[0] + top * linesize + left;
249  ptr = ptr1;
250  pass = 0;
251  y1 = 0;
252  for (y = 0; y < height; y++) {
253  int count = ff_lzw_decode(s->lzw, s->idx_line, width);
254  if (count != width) {
255  if (count)
256  av_log(s->avctx, AV_LOG_ERROR, "LZW decode failed\n");
257  goto decode_tail;
258  }
259 
260  pr = ptr + pw;
261 
262  for (px = ptr, idx = s->idx_line; px < pr; px++, idx++) {
263  if (*idx != s->transparent_color_index)
264  *px = pal[*idx];
265  }
266 
267  if (is_interleaved) {
268  switch(pass) {
269  default:
270  case 0:
271  case 1:
272  y1 += 8;
273  ptr += linesize * 8;
274  if (y1 >= height) {
275  y1 = pass ? 2 : 4;
276  ptr = ptr1 + linesize * y1;
277  pass++;
278  }
279  break;
280  case 2:
281  y1 += 4;
282  ptr += linesize * 4;
283  if (y1 >= height) {
284  y1 = 1;
285  ptr = ptr1 + linesize;
286  pass++;
287  }
288  break;
289  case 3:
290  y1 += 2;
291  ptr += linesize * 2;
292  break;
293  }
294  } else {
295  ptr += linesize;
296  }
297  }
298 
299  decode_tail:
300  /* read the garbage data until end marker is found */
302 
303  /* Graphic Control Extension's scope is single frame.
304  * Remove its influence. */
305  s->transparent_color_index = -1;
307 
308  return 0;
309 }
310 
312 {
313  int ext_code, ext_len, gce_flags, gce_transparent_index;
314 
315  /* There must be at least 2 bytes:
316  * 1 for extension label and 1 for extension length. */
317  if (bytestream2_get_bytes_left(&s->gb) < 2)
318  return AVERROR_INVALIDDATA;
319 
320  ext_code = bytestream2_get_byteu(&s->gb);
321  ext_len = bytestream2_get_byteu(&s->gb);
322 
323  av_dlog(s->avctx, "ext_code=0x%x len=%d\n", ext_code, ext_len);
324 
325  switch(ext_code) {
326  case GIF_GCE_EXT_LABEL:
327  if (ext_len != 4)
328  goto discard_ext;
329 
330  /* We need at least 5 bytes more: 4 is for extension body
331  * and 1 for next block size. */
332  if (bytestream2_get_bytes_left(&s->gb) < 5)
333  return AVERROR_INVALIDDATA;
334 
335  gce_flags = bytestream2_get_byteu(&s->gb);
336  bytestream2_skipu(&s->gb, 2); // delay during which the frame is shown
337  gce_transparent_index = bytestream2_get_byteu(&s->gb);
338  if (gce_flags & 0x01)
339  s->transparent_color_index = gce_transparent_index;
340  else
341  s->transparent_color_index = -1;
342  s->gce_disposal = (gce_flags >> 2) & 0x7;
343 
344  av_dlog(s->avctx, "gce_flags=%x tcolor=%d disposal=%d\n",
345  gce_flags,
347 
348  if (s->gce_disposal > 3) {
350  av_dlog(s->avctx, "invalid value in gce_disposal (%d). Using default value of 0.\n", ext_len);
351  }
352 
353  ext_len = bytestream2_get_byteu(&s->gb);
354  break;
355  }
356 
357  /* NOTE: many extension blocks can come after */
358  discard_ext:
359  while (ext_len) {
360  /* There must be at least ext_len bytes and 1 for next block size byte. */
361  if (bytestream2_get_bytes_left(&s->gb) < ext_len + 1)
362  return AVERROR_INVALIDDATA;
363 
364  bytestream2_skipu(&s->gb, ext_len);
365  ext_len = bytestream2_get_byteu(&s->gb);
366 
367  av_dlog(s->avctx, "ext_len1=%d\n", ext_len);
368  }
369  return 0;
370 }
371 
373 {
374  uint8_t sig[6];
375  int v, n;
376  int background_color_index;
377 
378  if (bytestream2_get_bytes_left(&s->gb) < 13)
379  return AVERROR_INVALIDDATA;
380 
381  /* read gif signature */
382  bytestream2_get_bufferu(&s->gb, sig, 6);
383  if (memcmp(sig, gif87a_sig, 6) &&
384  memcmp(sig, gif89a_sig, 6))
385  return AVERROR_INVALIDDATA;
386 
387  /* read screen header */
388  s->transparent_color_index = -1;
389  s->screen_width = bytestream2_get_le16u(&s->gb);
390  s->screen_height = bytestream2_get_le16u(&s->gb);
391 
392  v = bytestream2_get_byteu(&s->gb);
393  s->color_resolution = ((v & 0x70) >> 4) + 1;
394  s->has_global_palette = (v & 0x80);
395  s->bits_per_pixel = (v & 0x07) + 1;
396  background_color_index = bytestream2_get_byteu(&s->gb);
397  n = bytestream2_get_byteu(&s->gb);
398  if (n) {
399  s->avctx->sample_aspect_ratio.num = n + 15;
400  s->avctx->sample_aspect_ratio.den = 64;
401  }
402 
403  av_dlog(s->avctx, "screen_w=%d screen_h=%d bpp=%d global_palette=%d\n",
405  s->has_global_palette);
406 
407  if (s->has_global_palette) {
408  s->background_color_index = background_color_index;
409  n = 1 << s->bits_per_pixel;
410  if (bytestream2_get_bytes_left(&s->gb) < n * 3)
411  return AVERROR_INVALIDDATA;
412 
415  } else
416  s->background_color_index = -1;
417 
418  return 0;
419 }
420 
422 {
423  while (bytestream2_get_bytes_left(&s->gb) > 0) {
424  int code = bytestream2_get_byte(&s->gb);
425  int ret;
426 
427  av_log(s->avctx, AV_LOG_DEBUG, "code=%02x '%c'\n", code, code);
428 
429  switch (code) {
430  case GIF_IMAGE_SEPARATOR:
431  return gif_read_image(s, frame);
433  if ((ret = gif_read_extension(s)) < 0)
434  return ret;
435  break;
436  case GIF_TRAILER:
437  /* end of image */
438  return AVERROR_EOF;
439  default:
440  /* erroneous block label */
441  return AVERROR_INVALIDDATA;
442  }
443  }
444  return AVERROR_EOF;
445 }
446 
448 {
449  GifState *s = avctx->priv_data;
450 
451  s->avctx = avctx;
452 
453  avctx->pix_fmt = AV_PIX_FMT_RGB32;
454  s->frame = av_frame_alloc();
455  if (!s->frame)
456  return AVERROR(ENOMEM);
457  ff_lzw_decode_open(&s->lzw);
458  return 0;
459 }
460 
461 static int gif_decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
462 {
463  GifState *s = avctx->priv_data;
464  int ret;
465 
466  bytestream2_init(&s->gb, avpkt->data, avpkt->size);
467 
468  s->frame->pts = avpkt->pts;
469  s->frame->pkt_pts = avpkt->pts;
470  s->frame->pkt_dts = avpkt->dts;
472 
473  if (avpkt->size >= 6) {
474  s->keyframe = memcmp(avpkt->data, gif87a_sig, 6) == 0 ||
475  memcmp(avpkt->data, gif89a_sig, 6) == 0;
476  } else {
477  s->keyframe = 0;
478  }
479 
480  if (s->keyframe) {
481  s->keyframe_ok = 0;
483  if ((ret = gif_read_header1(s)) < 0)
484  return ret;
485 
486  if ((ret = ff_set_dimensions(avctx, s->screen_width, s->screen_height)) < 0)
487  return ret;
488 
489  av_frame_unref(s->frame);
490  if ((ret = ff_get_buffer(avctx, s->frame, 0)) < 0)
491  return ret;
492 
494  if (!s->idx_line)
495  return AVERROR(ENOMEM);
496 
498  s->frame->key_frame = 1;
499  s->keyframe_ok = 1;
500  } else {
501  if (!s->keyframe_ok) {
502  av_log(avctx, AV_LOG_ERROR, "cannot decode frame without keyframe\n");
503  return AVERROR_INVALIDDATA;
504  }
505 
506  if ((ret = ff_reget_buffer(avctx, s->frame)) < 0)
507  return ret;
508 
510  s->frame->key_frame = 0;
511  }
512 
513  ret = gif_parse_next_image(s, s->frame);
514  if (ret < 0)
515  return ret;
516 
517  if ((ret = av_frame_ref(data, s->frame)) < 0)
518  return ret;
519  *got_frame = 1;
520 
521  return bytestream2_tell(&s->gb);
522 }
523 
525 {
526  GifState *s = avctx->priv_data;
527 
529  av_frame_free(&s->frame);
530  av_freep(&s->idx_line);
531  av_freep(&s->stored_img);
532 
533  return 0;
534 }
535 
536 static const AVOption options[] = {
537  { "trans_color", "color value (ARGB) that is used instead of transparent color",
538  offsetof(GifState, trans_color), AV_OPT_TYPE_INT,
539  {.i64 = GIF_TRANSPARENT_COLOR}, 0, 0xffffffff,
541  { NULL },
542 };
543 
544 static const AVClass decoder_class = {
545  .class_name = "gif decoder",
546  .item_name = av_default_item_name,
547  .option = options,
548  .version = LIBAVUTIL_VERSION_INT,
549  .category = AV_CLASS_CATEGORY_DECODER,
550 };
551 
553  .name = "gif",
554  .long_name = NULL_IF_CONFIG_SMALL("GIF (Graphics Interchange Format)"),
555  .type = AVMEDIA_TYPE_VIDEO,
556  .id = AV_CODEC_ID_GIF,
557  .priv_data_size = sizeof(GifState),
561  .capabilities = CODEC_CAP_DR1,
562  .priv_class = &decoder_class,
563 };