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

   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 //#define DEBUG
  25
  26 #include "libavutil/imgutils.h"
  27 #include "libavutil/opt.h"
  28 #include "avcodec.h"
  29 #include "bytestream.h"
  30 #include "internal.h"
  31 #include "lzw.h"
  32 #include "gif.h"
  33
  34 /* This value is intentionally set to "transparent white" color.
  35  * It is much better to have white background instead of black
  36  * when gif image converted to format which not support transparency.
  37  */
  38 #define GIF_TRANSPARENT_COLOR    0x00ffffff
  39
  40 typedef struct GifState {
  41     const AVClass *class;
  42     AVFrame picture;
  43     int screen_width;
  44     int screen_height;
  45     int has_global_palette;
  46     int bits_per_pixel;
  47     uint32_t bg_color;
  48     int background_color_index;
  49     int transparent_color_index;
  50     int color_resolution;
  51     /* intermediate buffer for storing color indices
  52      * obtained from lzw-encoded data stream */
  53     uint8_t *idx_line;
  54     int idx_line_size;
  55
  56     /* after the frame is displayed, the disposal method is used */
  57     int gce_prev_disposal;
  58     int gce_disposal;
  59     /* rectangle describing area that must be disposed */
  60     int gce_l, gce_t, gce_w, gce_h;
  61     /* depending on disposal method we store either part of the image
  62      * drawn on the canvas or background color that
  63      * should be used upon disposal */
  64     uint32_t * stored_img;
  65     int stored_img_size;
  66     int stored_bg_color;
  67
  68     GetByteContext gb;
  69     /* LZW compatible decoder */
  70     LZWState *lzw;
  71
  72     /* aux buffers */
  73     uint32_t global_palette[256];
  74     uint32_t local_palette[256];
  75
  76     AVCodecContext *avctx;
  77     int keyframe;
  78     int trans_color;    /**< color value that is used instead of transparent color */
  79 } GifState;
  80
  81 static void gif_read_palette(GifState *s, uint32_t *pal, int nb)
  82 {
  83     int i;
  84
  85     for (i = 0; i < nb; i++, pal++)
  86         *pal = (0xffu << 24) | bytestream2_get_be24u(&s->gb);
  87 }
  88
  89 static void gif_fill(AVFrame *picture, uint32_t color)
  90 {
  91     uint32_t *p = (uint32_t *)picture->data[0];
  92     uint32_t *p_end = p + (picture->linesize[0] / sizeof(uint32_t)) * picture->height;
  93
  94     for (; p < p_end; p++)
  95         *p = color;
  96 }
  97
  98 static void gif_fill_rect(AVFrame *picture, uint32_t color, int l, int t, int w, int h)
  99 {
 100     const int linesize = picture->linesize[0] / sizeof(uint32_t);
 101     const uint32_t *py = (uint32_t *)picture->data[0] + t * linesize;
 102     const uint32_t *pr, *pb = py + h * linesize;
 103     uint32_t *px;
 104
 105     for (; py < pb; py += linesize) {
 106         px = (uint32_t *)py + l;
 107         pr = px + w;
 108
 109         for (; px < pr; px++)
 110             *px = color;
 111     }
 112 }
 113
 114 static void gif_copy_img_rect(const uint32_t *src, uint32_t *dst,
 115                               int linesize, int l, int t, int w, int h)
 116 {
 117     const int y_start = t * linesize;
 118     const uint32_t *src_px, *src_pr,
 119                    *src_py = src + y_start,
 120                    *dst_py = dst + y_start;
 121     const uint32_t *src_pb = src_py + t * linesize;
 122     uint32_t *dst_px;
 123
 124     for (; src_py < src_pb; src_py += linesize, dst_py += linesize) {
 125         src_px = src_py + l;
 126         dst_px = (uint32_t *)dst_py + l;
 127         src_pr = src_px + w;
 128
 129         for (; src_px < src_pr; src_px++, dst_px++)
 130             *dst_px = *src_px;
 131     }
 132 }
 133
 134 static int gif_read_image(GifState *s)
 135 {
 136     int left, top, width, height, bits_per_pixel, code_size, flags;
 137     int is_interleaved, has_local_palette, y, pass, y1, linesize, pal_size;
 138     uint32_t *ptr, *pal, *px, *pr, *ptr1;
 139     int ret;
 140     uint8_t *idx;
 141
 142     /* At least 9 bytes of Image Descriptor. */
 143     if (bytestream2_get_bytes_left(&s->gb) < 9)
 144         return AVERROR_INVALIDDATA;
 145
 146     left = bytestream2_get_le16u(&s->gb);
 147     top = bytestream2_get_le16u(&s->gb);
 148     width = bytestream2_get_le16u(&s->gb);
 149     height = bytestream2_get_le16u(&s->gb);
 150     flags = bytestream2_get_byteu(&s->gb);
 151     is_interleaved = flags & 0x40;
 152     has_local_palette = flags & 0x80;
 153     bits_per_pixel = (flags & 0x07) + 1;
 154
 155     av_dlog(s->avctx, "image x=%d y=%d w=%d h=%d\n", left, top, width, height);
 156
 157     if (has_local_palette) {
 158         pal_size = 1 << bits_per_pixel;
 159
 160         if (bytestream2_get_bytes_left(&s->gb) < pal_size * 3)
 161             return AVERROR_INVALIDDATA;
 162
 163         gif_read_palette(s, s->local_palette, pal_size);
 164         pal = s->local_palette;
 165     } else {
 166         if (!s->has_global_palette) {
 167             av_log(s->avctx, AV_LOG_FATAL, "picture doesn't have either global or local palette.\n");
 168             return AVERROR_INVALIDDATA;
 169         }
 170
 171         pal = s->global_palette;
 172     }
 173
 174     if (s->keyframe) {
 175         if (s->transparent_color_index == -1 && s->has_global_palette) {
 176             /* transparency wasn't set before the first frame, fill with background color */
 177             gif_fill(&s->picture, s->bg_color);
 178         } else {
 179             /* otherwise fill with transparent color.
 180              * this is necessary since by default picture filled with 0x80808080. */
 181             gif_fill(&s->picture, s->trans_color);
 182         }
 183     }
 184
 185     /* verify that all the image is inside the screen dimensions */
 186     if (left + width > s->screen_width ||
 187         top + height > s->screen_height)
 188         return AVERROR(EINVAL);
 189
 190     /* process disposal method */
 191     if (s->gce_prev_disposal == GCE_DISPOSAL_BACKGROUND) {
 192         gif_fill_rect(&s->picture, s->stored_bg_color, s->gce_l, s->gce_t, s->gce_w, s->gce_h);
 193     } else if (s->gce_prev_disposal == GCE_DISPOSAL_RESTORE) {
 194         gif_copy_img_rect(s->stored_img, (uint32_t *)s->picture.data[0],
 195             s->picture.linesize[0] / sizeof(uint32_t), s->gce_l, s->gce_t, s->gce_w, s->gce_h);
 196     }
 197
 198     s->gce_prev_disposal = s->gce_disposal;
 199
 200     if (s->gce_disposal != GCE_DISPOSAL_NONE) {
 201         s->gce_l = left;  s->gce_t = top;
 202         s->gce_w = width; s->gce_h = height;
 203
 204         if (s->gce_disposal == GCE_DISPOSAL_BACKGROUND) {
 205             if (s->background_color_index == s->transparent_color_index)
 206                 s->stored_bg_color = s->trans_color;
 207             else
 208                 s->stored_bg_color = s->bg_color;
 209         } else if (s->gce_disposal == GCE_DISPOSAL_RESTORE) {
 210             av_fast_malloc(&s->stored_img, &s->stored_img_size, s->picture.linesize[0] * s->picture.height);
 211             if (!s->stored_img)
 212                 return AVERROR(ENOMEM);
 213
 214             gif_copy_img_rect((uint32_t *)s->picture.data[0], s->stored_img,
 215                 s->picture.linesize[0] / sizeof(uint32_t), left, top, width, height);
 216         }
 217     }
 218
 219     /* Expect at least 2 bytes: 1 for lzw code size and 1 for block size. */
 220     if (bytestream2_get_bytes_left(&s->gb) < 2)
 221         return AVERROR_INVALIDDATA;
 222
 223     /* now get the image data */
 224     code_size = bytestream2_get_byteu(&s->gb);
 225     if ((ret = ff_lzw_decode_init(s->lzw, code_size, s->gb.buffer,
 226                                   bytestream2_get_bytes_left(&s->gb), FF_LZW_GIF)) < 0) {
 227         av_log(s->avctx, AV_LOG_ERROR, "LZW init failed\n");
 228         return ret;
 229     }
 230
 231     /* read all the image */
 232     linesize = s->picture.linesize[0] / sizeof(uint32_t);
 233     ptr1 = (uint32_t *)s->picture.data[0] + top * linesize + left;
 234     ptr = ptr1;
 235     pass = 0;
 236     y1 = 0;
 237     for (y = 0; y < height; y++) {
 238         if (ff_lzw_decode(s->lzw, s->idx_line, width) == 0)
 239             goto decode_tail;
 240
 241         pr = ptr + width;
 242
 243         for (px = ptr, idx = s->idx_line; px < pr; px++, idx++) {
 244             *px = pal[*idx];
 245             if (*idx == s->transparent_color_index)
 246                 *px &= 0xFFFFFF;
 247         }
 248
 249         if (is_interleaved) {
 250             switch(pass) {
 251             default:
 252             case 0:
 253             case 1:
 254                 y1 += 8;
 255                 ptr += linesize * 8;
 256                 if (y1 >= height) {
 257                     y1 = pass ? 2 : 4;
 258                     ptr = ptr1 + linesize * y1;
 259                     pass++;
 260                 }
 261                 break;
 262             case 2:
 263                 y1 += 4;
 264                 ptr += linesize * 4;
 265                 if (y1 >= height) {
 266                     y1 = 1;
 267                     ptr = ptr1 + linesize;
 268                     pass++;
 269                 }
 270                 break;
 271             case 3:
 272                 y1 += 2;
 273                 ptr += linesize * 2;
 274                 break;
 275             }
 276         } else {
 277             ptr += linesize;
 278         }
 279     }
 280
 281  decode_tail:
 282     /* read the garbage data until end marker is found */
 283     ff_lzw_decode_tail(s->lzw);
 284
 285     /* Graphic Control Extension's scope is single frame.
 286      * Remove its influence. */
 287     s->transparent_color_index = -1;
 288     s->gce_disposal = GCE_DISPOSAL_NONE;
 289
 290     return 0;
 291 }
 292
 293 static int gif_read_extension(GifState *s)
 294 {
 295     int ext_code, ext_len, gce_flags, gce_transparent_index;
 296
 297     /* There must be at least 2 bytes:
 298      * 1 for extension label and 1 for extension length. */
 299     if (bytestream2_get_bytes_left(&s->gb) < 2)
 300         return AVERROR_INVALIDDATA;
 301
 302     ext_code = bytestream2_get_byteu(&s->gb);
 303     ext_len = bytestream2_get_byteu(&s->gb);
 304
 305     av_dlog(s->avctx, "ext_code=0x%x len=%d\n", ext_code, ext_len);
 306
 307     switch(ext_code) {
 308     case GIF_GCE_EXT_LABEL:
 309         if (ext_len != 4)
 310             goto discard_ext;
 311
 312         /* We need at least 5 bytes more: 4 is for extension body
 313          * and 1 for next block size. */
 314         if (bytestream2_get_bytes_left(&s->gb) < 5)
 315             return AVERROR_INVALIDDATA;
 316
 317         s->transparent_color_index = -1;
 318         gce_flags = bytestream2_get_byteu(&s->gb);
 319         bytestream2_skipu(&s->gb, 2);    // delay during which the frame is shown
 320         gce_transparent_index = bytestream2_get_byteu(&s->gb);
 321         if (gce_flags & 0x01)
 322             s->transparent_color_index = gce_transparent_index;
 323         else
 324             s->transparent_color_index = -1;
 325         s->gce_disposal = (gce_flags >> 2) & 0x7;
 326
 327         av_dlog(s->avctx, "gce_flags=%x tcolor=%d disposal=%d\n",
 328                gce_flags,
 329                s->transparent_color_index, s->gce_disposal);
 330
 331         if (s->gce_disposal > 3) {
 332             s->gce_disposal = GCE_DISPOSAL_NONE;
 333             av_dlog(s->avctx, "invalid value in gce_disposal (%d). Using default value of 0.\n", ext_len);
 334         }
 335
 336         ext_len = bytestream2_get_byteu(&s->gb);
 337         break;
 338     }
 339
 340     /* NOTE: many extension blocks can come after */
 341  discard_ext:
 342     while (ext_len != 0) {
 343         /* There must be at least ext_len bytes and 1 for next block size byte. */
 344         if (bytestream2_get_bytes_left(&s->gb) < ext_len + 1)
 345             return AVERROR_INVALIDDATA;
 346
 347         bytestream2_skipu(&s->gb, ext_len);
 348         ext_len = bytestream2_get_byteu(&s->gb);
 349
 350         av_dlog(s->avctx, "ext_len1=%d\n", ext_len);
 351     }
 352     return 0;
 353 }
 354
 355 static int gif_read_header1(GifState *s)
 356 {
 357     uint8_t sig[6];
 358     int v, n;
 359     int background_color_index;
 360
 361     if (bytestream2_get_bytes_left(&s->gb) < 13)
 362         return AVERROR_INVALIDDATA;
 363
 364     /* read gif signature */
 365     bytestream2_get_bufferu(&s->gb, sig, 6);
 366     if (memcmp(sig, gif87a_sig, 6) != 0 &&
 367         memcmp(sig, gif89a_sig, 6) != 0)
 368         return AVERROR_INVALIDDATA;
 369
 370     /* read screen header */
 371     s->transparent_color_index = -1;
 372     s->screen_width = bytestream2_get_le16u(&s->gb);
 373     s->screen_height = bytestream2_get_le16u(&s->gb);
 374     if(   (unsigned)s->screen_width  > 32767
 375        || (unsigned)s->screen_height > 32767){
 376         av_log(s->avctx, AV_LOG_ERROR, "picture size too large\n");
 377         return AVERROR_INVALIDDATA;
 378     }
 379
 380     av_fast_malloc(&s->idx_line, &s->idx_line_size, s->screen_width);
 381     if (!s->idx_line)
 382         return AVERROR(ENOMEM);
 383
 384     v = bytestream2_get_byteu(&s->gb);
 385     s->color_resolution = ((v & 0x70) >> 4) + 1;
 386     s->has_global_palette = (v & 0x80);
 387     s->bits_per_pixel = (v & 0x07) + 1;
 388     background_color_index = bytestream2_get_byteu(&s->gb);
 389     n = bytestream2_get_byteu(&s->gb);
 390     if (n) {
 391         s->avctx->sample_aspect_ratio.num = n + 15;
 392         s->avctx->sample_aspect_ratio.den = 64;
 393     }
 394
 395     av_dlog(s->avctx, "screen_w=%d screen_h=%d bpp=%d global_palette=%d\n",
 396            s->screen_width, s->screen_height, s->bits_per_pixel,
 397            s->has_global_palette);
 398
 399     if (s->has_global_palette) {
 400         s->background_color_index = background_color_index;
 401         n = 1 << s->bits_per_pixel;
 402         if (bytestream2_get_bytes_left(&s->gb) < n * 3)
 403             return AVERROR_INVALIDDATA;
 404
 405         gif_read_palette(s, s->global_palette, n);
 406         s->bg_color = s->global_palette[s->background_color_index];
 407     } else
 408         s->background_color_index = -1;
 409
 410     return 0;
 411 }
 412
 413 static int gif_parse_next_image(GifState *s, int *got_picture)
 414 {
 415     int ret;
 416     *got_picture = 1;
 417     while (bytestream2_get_bytes_left(&s->gb)) {
 418         int code = bytestream2_get_byte(&s->gb);
 419
 420         av_dlog(s->avctx, "code=%02x '%c'\n", code, code);
 421
 422         switch (code) {
 423         case GIF_IMAGE_SEPARATOR:
 424             return gif_read_image(s);
 425         case GIF_EXTENSION_INTRODUCER:
 426             if ((ret = gif_read_extension(s)) < 0)
 427                 return ret;
 428             break;
 429         case GIF_TRAILER:
 430             /* end of image */
 431             *got_picture = 0;
 432             return 0;
 433         default:
 434             /* erroneous block label */
 435             return AVERROR_INVALIDDATA;
 436         }
 437     }
 438     return AVERROR_EOF;
 439 }
 440
 441 static av_cold int gif_decode_init(AVCodecContext *avctx)
 442 {
 443     GifState *s = avctx->priv_data;
 444
 445     s->avctx = avctx;
 446
 447     avctx->pix_fmt = AV_PIX_FMT_RGB32;
 448     avcodec_get_frame_defaults(&s->picture);
 449     avctx->coded_frame= &s->picture;
 450     s->picture.data[0] = NULL;
 451     ff_lzw_decode_open(&s->lzw);
 452     return 0;
 453 }
 454
 455 static int gif_decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
 456 {
 457     GifState *s = avctx->priv_data;
 458     AVFrame *picture = data;
 459     int ret;
 460
 461     bytestream2_init(&s->gb, avpkt->data, avpkt->size);
 462
 463     s->picture.pts          = avpkt->pts;
 464     s->picture.pkt_pts      = avpkt->pts;
 465     s->picture.pkt_dts      = avpkt->dts;
 466     s->picture.pkt_duration = avpkt->duration;
 467
 468     if (avpkt->size >= 6) {
 469         s->keyframe = memcmp(avpkt->data, gif87a_sig, 6) == 0 ||
 470                       memcmp(avpkt->data, gif89a_sig, 6) == 0;
 471     } else {
 472         s->keyframe = 0;
 473     }
 474
 475     if (s->keyframe) {
 476         if ((ret = gif_read_header1(s)) < 0)
 477             return ret;
 478
 479         if ((ret = av_image_check_size(s->screen_width, s->screen_height, 0, avctx)) < 0)
 480             return ret;
 481         avcodec_set_dimensions(avctx, s->screen_width, s->screen_height);
 482
 483         if (s->picture.data[0])
 484             avctx->release_buffer(avctx, &s->picture);
 485
 486         if ((ret = ff_get_buffer(avctx, &s->picture)) < 0) {
 487             av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
 488             return ret;
 489         }
 490
 491         s->picture.pict_type = AV_PICTURE_TYPE_I;
 492         s->picture.key_frame = 1;
 493     } else {
 494         if ((ret = avctx->reget_buffer(avctx, &s->picture)) < 0) {
 495             av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
 496             return ret;
 497         }
 498
 499         s->picture.pict_type = AV_PICTURE_TYPE_P;
 500         s->picture.key_frame = 0;
 501     }
 502
 503     ret = gif_parse_next_image(s, got_frame);
 504     if (ret < 0)
 505         return ret;
 506     else if (*got_frame)
 507         *picture = s->picture;
 508
 509     return avpkt->size;
 510 }
 511
 512 static av_cold int gif_decode_close(AVCodecContext *avctx)
 513 {
 514     GifState *s = avctx->priv_data;
 515
 516     ff_lzw_decode_close(&s->lzw);
 517     if(s->picture.data[0])
 518         avctx->release_buffer(avctx, &s->picture);
 519
 520     av_freep(&s->idx_line);
 521     av_freep(&s->stored_img);
 522
 523     return 0;
 524 }
 525
 526 static const AVOption options[] = {
 527     { "trans_color", "color value (ARGB) that is used instead of transparent color",
 528       offsetof(GifState, trans_color), AV_OPT_TYPE_INT,
 529       {.i64 = GIF_TRANSPARENT_COLOR}, 0, 0xffffffff,
 530       AV_OPT_FLAG_DECODING_PARAM|AV_OPT_FLAG_VIDEO_PARAM },
 531     { NULL },
 532 };
 533
 534 static const AVClass decoder_class = {
 535     .class_name = "gif decoder",
 536     .item_name  = av_default_item_name,
 537     .option     = options,
 538     .version    = LIBAVUTIL_VERSION_INT,
 539     .category   = AV_CLASS_CATEGORY_DECODER,
 540 };
 541
 542 AVCodec ff_gif_decoder = {
 543     .name           = "gif",
 544     .type           = AVMEDIA_TYPE_VIDEO,
 545     .id             = AV_CODEC_ID_GIF,
 546     .priv_data_size = sizeof(GifState),
 547     .init           = gif_decode_init,
 548     .close          = gif_decode_close,
 549     .decode         = gif_decode_frame,
 550     .capabilities   = CODEC_CAP_DR1,
 551     .long_name      = NULL_IF_CONFIG_SMALL("GIF (Graphics Interchange Format)"),
 552     .priv_class     = &decoder_class,
 553 };