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  *
   6  * This file is part of Libav.
   7  *
   8  * Libav is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * Libav is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with Libav; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  21  */
  22
  23 #include "libavutil/imgutils.h"
  24 #include "avcodec.h"
  25 #include "bytestream.h"
  26 #include "internal.h"
  27 #include "lzw.h"
  28
  29 #define GCE_DISPOSAL_NONE       0
  30 #define GCE_DISPOSAL_INPLACE    1
  31 #define GCE_DISPOSAL_BACKGROUND 2
  32 #define GCE_DISPOSAL_RESTORE    3
  33
  34 typedef struct GifState {
  35     int screen_width;
  36     int screen_height;
  37     int bits_per_pixel;
  38     int background_color_index;
  39     int transparent_color_index;
  40     int color_resolution;
  41     uint32_t *image_palette;
  42
  43     /* after the frame is displayed, the disposal method is used */
  44     int gce_disposal;
  45     /* delay during which the frame is shown */
  46     int gce_delay;
  47
  48     /* LZW compatible decoder */
  49     GetByteContext gb;
  50     LZWState *lzw;
  51
  52     /* aux buffers */
  53     uint8_t global_palette[256 * 3];
  54     uint8_t local_palette[256 * 3];
  55
  56   AVCodecContext* avctx;
  57 } GifState;
  58
  59 static const uint8_t gif87a_sig[6] = "GIF87a";
  60 static const uint8_t gif89a_sig[6] = "GIF89a";
  61
  62 static int gif_read_image(GifState *s, AVFrame *frame)
  63 {
  64     int left, top, width, height, bits_per_pixel, code_size, flags;
  65     int is_interleaved, has_local_palette, y, pass, y1, linesize, n, i;
  66     uint8_t *ptr, *spal, *palette, *ptr1;
  67
  68     left   = bytestream2_get_le16(&s->gb);
  69     top    = bytestream2_get_le16(&s->gb);
  70     width  = bytestream2_get_le16(&s->gb);
  71     height = bytestream2_get_le16(&s->gb);
  72     flags  = bytestream2_get_byte(&s->gb);
  73     is_interleaved = flags & 0x40;
  74     has_local_palette = flags & 0x80;
  75     bits_per_pixel = (flags & 0x07) + 1;
  76
  77     av_dlog(s->avctx, "gif: image x=%d y=%d w=%d h=%d\n", left, top, width, height);
  78
  79     if (has_local_palette) {
  80         bytestream2_get_buffer(&s->gb, s->local_palette, 3 * (1 << bits_per_pixel));
  81         palette = s->local_palette;
  82     } else {
  83         palette = s->global_palette;
  84         bits_per_pixel = s->bits_per_pixel;
  85     }
  86
  87     /* verify that all the image is inside the screen dimensions */
  88     if (left + width > s->screen_width ||
  89         top + height > s->screen_height ||
  90         !width || !height) {
  91         av_log(s->avctx, AV_LOG_ERROR, "Invalid image dimensions.\n");
  92         return AVERROR_INVALIDDATA;
  93     }
  94
  95     /* build the palette */
  96     n = (1 << bits_per_pixel);
  97     spal = palette;
  98     for(i = 0; i < n; i++) {
  99         s->image_palette[i] = (0xffu << 24) | AV_RB24(spal);
 100         spal += 3;
 101     }
 102     for(; i < 256; i++)
 103         s->image_palette[i] = (0xffu << 24);
 104     /* handle transparency */
 105     if (s->transparent_color_index >= 0)
 106         s->image_palette[s->transparent_color_index] = 0;
 107
 108     /* now get the image data */
 109     code_size = bytestream2_get_byte(&s->gb);
 110     ff_lzw_decode_init(s->lzw, code_size, s->gb.buffer,
 111                        bytestream2_get_bytes_left(&s->gb), FF_LZW_GIF);
 112
 113     /* read all the image */
 114     linesize = frame->linesize[0];
 115     ptr1 = frame->data[0] + top * linesize + left;
 116     ptr = ptr1;
 117     pass = 0;
 118     y1 = 0;
 119     for (y = 0; y < height; y++) {
 120         ff_lzw_decode(s->lzw, ptr, width);
 121         if (is_interleaved) {
 122             switch(pass) {
 123             default:
 124             case 0:
 125             case 1:
 126                 y1 += 8;
 127                 ptr += linesize * 8;
 128                 if (y1 >= height) {
 129                     y1 = pass ? 2 : 4;
 130                     ptr = ptr1 + linesize * y1;
 131                     pass++;
 132                 }
 133                 break;
 134             case 2:
 135                 y1 += 4;
 136                 ptr += linesize * 4;
 137                 if (y1 >= height) {
 138                     y1 = 1;
 139                     ptr = ptr1 + linesize;
 140                     pass++;
 141                 }
 142                 break;
 143             case 3:
 144                 y1 += 2;
 145                 ptr += linesize * 2;
 146                 break;
 147             }
 148         } else {
 149             ptr += linesize;
 150         }
 151     }
 152     /* read the garbage data until end marker is found */
 153     ff_lzw_decode_tail(s->lzw);
 154
 155     bytestream2_skip(&s->gb, ff_lzw_size_read(s->lzw));
 156     return 0;
 157 }
 158
 159 static int gif_read_extension(GifState *s)
 160 {
 161     int ext_code, ext_len, i, gce_flags, gce_transparent_index;
 162
 163     /* extension */
 164     ext_code = bytestream2_get_byte(&s->gb);
 165     ext_len  = bytestream2_get_byte(&s->gb);
 166
 167     av_dlog(s->avctx, "gif: ext_code=0x%x len=%d\n", ext_code, ext_len);
 168
 169     switch(ext_code) {
 170     case 0xf9:
 171         if (ext_len != 4)
 172             goto discard_ext;
 173         s->transparent_color_index = -1;
 174         gce_flags    = bytestream2_get_byte(&s->gb);
 175         s->gce_delay = bytestream2_get_le16(&s->gb);
 176         gce_transparent_index = bytestream2_get_byte(&s->gb);
 177         if (gce_flags & 0x01)
 178             s->transparent_color_index = gce_transparent_index;
 179         else
 180             s->transparent_color_index = -1;
 181         s->gce_disposal = (gce_flags >> 2) & 0x7;
 182
 183         av_dlog(s->avctx, "gif: gce_flags=%x delay=%d tcolor=%d disposal=%d\n",
 184                gce_flags, s->gce_delay,
 185                s->transparent_color_index, s->gce_disposal);
 186
 187         ext_len = bytestream2_get_byte(&s->gb);
 188         break;
 189     }
 190
 191     /* NOTE: many extension blocks can come after */
 192  discard_ext:
 193     while (ext_len != 0) {
 194         for (i = 0; i < ext_len; i++)
 195             bytestream2_get_byte(&s->gb);
 196         ext_len = bytestream2_get_byte(&s->gb);
 197
 198         av_dlog(s->avctx, "gif: ext_len1=%d\n", ext_len);
 199     }
 200     return 0;
 201 }
 202
 203 static int gif_read_header1(GifState *s)
 204 {
 205     uint8_t sig[6];
 206     int v, n;
 207     int has_global_palette;
 208
 209     if (bytestream2_get_bytes_left(&s->gb) < 13)
 210         return AVERROR_INVALIDDATA;
 211
 212     /* read gif signature */
 213     bytestream2_get_buffer(&s->gb, sig, 6);
 214     if (memcmp(sig, gif87a_sig, 6) != 0 &&
 215         memcmp(sig, gif89a_sig, 6) != 0)
 216         return AVERROR_INVALIDDATA;
 217
 218     /* read screen header */
 219     s->transparent_color_index = -1;
 220     s->screen_width  = bytestream2_get_le16(&s->gb);
 221     s->screen_height = bytestream2_get_le16(&s->gb);
 222     if(   (unsigned)s->screen_width  > 32767
 223        || (unsigned)s->screen_height > 32767){
 224         av_log(NULL, AV_LOG_ERROR, "picture size too large\n");
 225         return AVERROR_INVALIDDATA;
 226     }
 227
 228     v = bytestream2_get_byte(&s->gb);
 229     s->color_resolution = ((v & 0x70) >> 4) + 1;
 230     has_global_palette = (v & 0x80);
 231     s->bits_per_pixel = (v & 0x07) + 1;
 232     s->background_color_index = bytestream2_get_byte(&s->gb);
 233     bytestream2_get_byte(&s->gb);                /* ignored */
 234
 235     av_dlog(s->avctx, "gif: screen_w=%d screen_h=%d bpp=%d global_palette=%d\n",
 236            s->screen_width, s->screen_height, s->bits_per_pixel,
 237            has_global_palette);
 238
 239     if (has_global_palette) {
 240         n = 1 << s->bits_per_pixel;
 241         if (bytestream2_get_bytes_left(&s->gb) < n * 3)
 242             return AVERROR_INVALIDDATA;
 243         bytestream2_get_buffer(&s->gb, s->global_palette, n * 3);
 244     }
 245     return 0;
 246 }
 247
 248 static int gif_parse_next_image(GifState *s, AVFrame *frame)
 249 {
 250     while (bytestream2_get_bytes_left(&s->gb) > 0) {
 251         int code = bytestream2_get_byte(&s->gb);
 252         int ret;
 253
 254         av_dlog(s->avctx, "gif: code=%02x '%c'\n", code, code);
 255
 256         switch (code) {
 257         case ',':
 258             return gif_read_image(s, frame);
 259         case '!':
 260             if ((ret = gif_read_extension(s)) < 0)
 261                 return ret;
 262             break;
 263         case ';':
 264             /* end of image */
 265         default:
 266             /* error or erroneous EOF */
 267             return AVERROR_INVALIDDATA;
 268         }
 269     }
 270     return AVERROR_INVALIDDATA;
 271 }
 272
 273 static av_cold int gif_decode_init(AVCodecContext *avctx)
 274 {
 275     GifState *s = avctx->priv_data;
 276
 277     s->avctx = avctx;
 278
 279     ff_lzw_decode_open(&s->lzw);
 280     return 0;
 281 }
 282
 283 static int gif_decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
 284                             AVPacket *avpkt)
 285 {
 286     const uint8_t *buf = avpkt->data;
 287     int buf_size = avpkt->size;
 288     GifState *s = avctx->priv_data;
 289     AVFrame *picture = data;
 290     int ret;
 291
 292     bytestream2_init(&s->gb, buf, buf_size);
 293     if ((ret = gif_read_header1(s)) < 0)
 294         return ret;
 295
 296     avctx->pix_fmt = AV_PIX_FMT_PAL8;
 297
 298     if ((ret = ff_set_dimensions(avctx, s->screen_width, s->screen_height)) < 0)
 299         return ret;
 300
 301     if ((ret = ff_get_buffer(avctx, picture, 0)) < 0) {
 302         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
 303         return ret;
 304     }
 305     s->image_palette = (uint32_t *)picture->data[1];
 306     ret = gif_parse_next_image(s, picture);
 307     if (ret < 0)
 308         return ret;
 309
 310     *got_frame = 1;
 311     return bytestream2_tell(&s->gb);
 312 }
 313
 314 static av_cold int gif_decode_close(AVCodecContext *avctx)
 315 {
 316     GifState *s = avctx->priv_data;
 317
 318     ff_lzw_decode_close(&s->lzw);
 319     return 0;
 320 }
 321
 322 AVCodec ff_gif_decoder = {
 323     .name           = "gif",
 324     .long_name      = NULL_IF_CONFIG_SMALL("GIF (Graphics Interchange Format)"),
 325     .type           = AVMEDIA_TYPE_VIDEO,
 326     .id             = AV_CODEC_ID_GIF,
 327     .priv_data_size = sizeof(GifState),
 328     .init           = gif_decode_init,
 329     .close          = gif_decode_close,
 330     .decode         = gif_decode_frame,
 331     .capabilities   = CODEC_CAP_DR1,
 332 };