libmpdemux/demux_gif.c

   1 /*
   2  * GIF file parser
   3  * Copyright (C) 2003 Joey Parrish
   4  *
   5  * This file is part of MPlayer.
   6  *
   7  * MPlayer is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * MPlayer 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
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with MPlayer; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <unistd.h>
  25
  26 #include "config.h"
  27
  28 #include "mp_msg.h"
  29 #include "help_mp.h"
  30
  31 #include "stream/stream.h"
  32 #include "demuxer.h"
  33 #include "stheader.h"
  34
  35 #include <gif_lib.h>
  36 #include "libvo/fastmemcpy.h"
  37 typedef struct {
  38   int current_pts;
  39   unsigned char *palette;
  40   GifFileType *gif;
  41   int w, h;
  42   int useref;
  43   uint8_t *refimg;
  44 } gif_priv_t;
  45
  46 #define GIF_SIGNATURE (('G' << 16) | ('I' << 8) | 'F')
  47
  48 #ifndef CONFIG_GIF_TVT_HACK
  49 // not supported by certain versions of the library
  50 static int my_read_gif(GifFileType *gif, uint8_t *buf, int len)
  51 {
  52   return stream_read(gif->UserData, buf, len);
  53 }
  54 #endif
  55
  56 static int gif_check_file(demuxer_t *demuxer)
  57 {
  58   if (stream_read_int24(demuxer->stream) == GIF_SIGNATURE)
  59     return DEMUXER_TYPE_GIF;
  60   return 0;
  61 }
  62
  63 static void memcpy_transp_pic(uint8_t *dst, uint8_t *src, int w, int h,
  64                 int dstride, int sstride, int transp, uint8_t trans_col) {
  65   if (transp) {
  66     dstride -= w;
  67     sstride -= w;
  68     while (h-- > 0) {
  69       int wleft = w;
  70       while (wleft-- > 0) {
  71         if (*src != trans_col)
  72           *dst = *src;
  73         dst++; src++;
  74       }
  75       dst += dstride;
  76       src += sstride;
  77     }
  78   } else
  79     memcpy_pic(dst, src, w, h, dstride, sstride);
  80 }
  81
  82 static int demux_gif_fill_buffer(demuxer_t *demuxer, demux_stream_t *ds)
  83 {
  84   gif_priv_t *priv = demuxer->priv;
  85   GifFileType *gif = priv->gif;
  86   GifRecordType type = UNDEFINED_RECORD_TYPE;
  87   int len = 0;
  88   demux_packet_t *dp = NULL;
  89   ColorMapObject *effective_map = NULL;
  90   uint8_t *buf = NULL;
  91   int refmode = 0;
  92   int transparency = 0;
  93   uint8_t transparent_col;
  94
  95   while (type != IMAGE_DESC_RECORD_TYPE) {
  96     if (DGifGetRecordType(gif, &type) == GIF_ERROR) {
  97       PrintGifError();
  98       return 0; // oops
  99     }
 100     if (type == TERMINATE_RECORD_TYPE)
 101       return 0; // eof
 102     if (type == SCREEN_DESC_RECORD_TYPE) {
 103       if (DGifGetScreenDesc(gif) == GIF_ERROR) {
 104         PrintGifError();
 105         return 0; // oops
 106       }
 107     }
 108     if (type == EXTENSION_RECORD_TYPE) {
 109       int code;
 110       unsigned char *p = NULL;
 111       if (DGifGetExtension(gif, &code, &p) == GIF_ERROR) {
 112         PrintGifError();
 113         return 0; // oops
 114       }
 115       if (code == 0xF9) {
 116         int frametime = 0;
 117         if (p[0] == 4) // is the length correct?
 118         {
 119           transparency = p[1] & 1;
 120           refmode = (p[1] >> 2) & 3;
 121           // HACK: specification says
 122           // > 0 - No disposal specified. The decoder is not required to take any action.
 123           // but browsers treat it the same way as
 124           // > 1 - Do not dispose. The graphic is to be left in place.
 125           // Some broken files rely on this, e.g.
 126           // http://samples.mplayerhq.hu/GIF/broken-gif/CLAIRE.GIF
 127           if (refmode == 0) refmode = 1;
 128           frametime = (p[3] << 8) | p[2]; // set the time, centiseconds
 129           transparent_col = p[4];
 130         }
 131         priv->current_pts += frametime;
 132       } else if ((code == 0xFE) && (verbose)) { // comment extension
 133         // print iff verbose
 134         printf("GIF comment: ");
 135         while (p != NULL) {
 136           int length = p[0];
 137           char *comments = p + 1;
 138           comments[length] = 0;
 139           printf("%s", comments);
 140           if (DGifGetExtensionNext(gif, &p) == GIF_ERROR) {
 141             PrintGifError();
 142             return 0; // oops
 143           }
 144         }
 145         printf("\n");
 146       }
 147       while (p != NULL) {
 148         if (DGifGetExtensionNext(gif, &p) == GIF_ERROR) {
 149           PrintGifError();
 150           return 0; // oops
 151         }
 152       }
 153     }
 154   }
 155
 156   if (DGifGetImageDesc(gif) == GIF_ERROR) {
 157     PrintGifError();
 158     return 0; // oops
 159   }
 160
 161   len = gif->Image.Width * gif->Image.Height;
 162   dp = new_demux_packet(priv->w * priv->h);
 163   buf = calloc(gif->Image.Width, gif->Image.Height);
 164   if (priv->useref)
 165     fast_memcpy(dp->buffer, priv->refimg, priv->w * priv->h);
 166   else
 167     memset(dp->buffer, gif->SBackGroundColor, priv->w * priv->h);
 168
 169   if (DGifGetLine(gif, buf, len) == GIF_ERROR) {
 170     PrintGifError();
 171     return 0; // oops
 172   }
 173
 174   effective_map = gif->Image.ColorMap;
 175   if (effective_map == NULL) effective_map = gif->SColorMap;
 176
 177   {
 178     int y;
 179     int cnt = FFMIN(effective_map->ColorCount, 256);
 180     int l = av_clip(gif->Image.Left, 0, priv->w);
 181     int t = av_clip(gif->Image.Top, 0, priv->h);
 182     int w = av_clip(gif->Image.Width, 0, priv->w - l);
 183     int h = av_clip(gif->Image.Height, 0, priv->h - t);
 184     unsigned char *dest = dp->buffer + priv->w * t + l;
 185
 186     // copy the palette
 187     for (y = 0; y < cnt; y++) {
 188       priv->palette[(y * 4) + 0] = effective_map->Colors[y].Blue;
 189       priv->palette[(y * 4) + 1] = effective_map->Colors[y].Green;
 190       priv->palette[(y * 4) + 2] = effective_map->Colors[y].Red;
 191       priv->palette[(y * 4) + 3] = 0;
 192     }
 193
 194     if (gif->Image.Interlace) {
 195       uint8_t *s = buf;
 196       int ih = (h - 0 + 7) >> 3;
 197       memcpy_transp_pic(dest, s, w, ih,
 198                         priv->w << 3, gif->Image.Width,
 199                         transparency, transparent_col);
 200       s += ih * w;
 201       ih = (h - 4 + 7) >> 3;
 202       memcpy_transp_pic(dest + (priv->w << 2), s, w, ih,
 203                         priv->w << 3, gif->Image.Width,
 204                         transparency, transparent_col);
 205       s += ih * w;
 206       ih = (h - 2 + 3) >> 2;
 207       memcpy_transp_pic(dest + (priv->w << 1), s, w, ih,
 208                         priv->w << 2, gif->Image.Width,
 209                         transparency, transparent_col);
 210       s += ih * w;
 211       ih = (h - 1 + 1) >> 1;
 212       memcpy_transp_pic(dest + priv->w, s, w, ih,
 213                         priv->w << 1, gif->Image.Width,
 214                         transparency, transparent_col);
 215     } else
 216       memcpy_transp_pic(dest, buf, w, h, priv->w, gif->Image.Width,
 217                         transparency, transparent_col);
 218
 219     if (refmode == 1) fast_memcpy(priv->refimg, dp->buffer, priv->w * priv->h);
 220     if (refmode == 2 && priv->useref) {
 221       dest = priv->refimg + priv->w * t + l;
 222       memset(buf, gif->SBackGroundColor, len);
 223       memcpy_pic(dest, buf, w, h, priv->w, gif->Image.Width);
 224     }
 225     if (!(refmode & 2)) priv->useref = refmode & 1;
 226   }
 227
 228   free(buf);
 229
 230   demuxer->video->dpos++;
 231   dp->pts = ((float)priv->current_pts) / 100;
 232   dp->pos = stream_tell(demuxer->stream);
 233   ds_add_packet(demuxer->video, dp);
 234
 235   return 1;
 236 }
 237
 238 static demuxer_t* demux_open_gif(demuxer_t* demuxer)
 239 {
 240   gif_priv_t *priv = calloc(1, sizeof(gif_priv_t));
 241   sh_video_t *sh_video = NULL;
 242   GifFileType *gif = NULL;
 243
 244   priv->current_pts = 0;
 245   demuxer->seekable = 0; // FIXME
 246
 247   // go back to the beginning
 248   stream_seek(demuxer->stream,demuxer->stream->start_pos);
 249
 250 #ifdef CONFIG_GIF_TVT_HACK
 251   // without the TVT functionality of libungif, a hard seek must be
 252   // done to the beginning of the file.  this is because libgif is
 253   // unable to use mplayer's cache, and without this lseek libgif will
 254   // not read from the beginning of the file and the command will fail.
 255   // with this hack enabled, you will lose the ability to stream a GIF.
 256   lseek(demuxer->stream->fd, 0, SEEK_SET);
 257   gif = DGifOpenFileHandle(demuxer->stream->fd);
 258 #else
 259   gif = DGifOpen(demuxer->stream, my_read_gif);
 260 #endif
 261   if (!gif) {
 262     PrintGifError();
 263     return NULL;
 264   }
 265
 266   // create a new video stream header
 267   sh_video = new_sh_video(demuxer, 0);
 268
 269   // make sure the demuxer knows about the new video stream header
 270   // (even though new_sh_video() ought to take care of it)
 271   demuxer->video->sh = sh_video;
 272
 273   // make sure that the video demuxer stream header knows about its
 274   // parent video demuxer stream (this is getting wacky), or else
 275   // video_read_properties() will choke
 276   sh_video->ds = demuxer->video;
 277
 278   sh_video->format = mmioFOURCC(8, 'R', 'G', 'B');
 279
 280   sh_video->fps = 5.0f;
 281   sh_video->frametime = 1.0f / sh_video->fps;
 282
 283   sh_video->bih = malloc(sizeof(BITMAPINFOHEADER) + (256 * 4));
 284   sh_video->bih->biCompression = sh_video->format;
 285   sh_video->bih->biWidth = priv->w = (uint16_t)gif->SWidth;
 286   sh_video->bih->biHeight = priv->h = (uint16_t)gif->SHeight;
 287   sh_video->bih->biBitCount = 8;
 288   sh_video->bih->biPlanes = 2;
 289   priv->palette = (unsigned char *)(sh_video->bih + 1);
 290   priv->refimg = malloc(priv->w * priv->h);
 291
 292   priv->gif = gif;
 293   demuxer->priv = priv;
 294
 295   return demuxer;
 296 }
 297
 298 static void demux_close_gif(demuxer_t* demuxer)
 299 {
 300   gif_priv_t *priv = demuxer->priv;
 301   if (!priv) return;
 302   if (priv->gif && DGifCloseFile(priv->gif) == GIF_ERROR)
 303     PrintGifError();
 304   free(priv->refimg);
 305   free(priv);
 306 }
 307
 308
 309 const demuxer_desc_t demuxer_desc_gif = {
 310   "GIF demuxer",
 311   "gif",
 312   "GIF",
 313   "Joey Parrish",
 314   "",
 315   DEMUXER_TYPE_GIF,
 316   0, // unsafe autodetect
 317   gif_check_file,
 318   demux_gif_fill_buffer,
 319   demux_open_gif,
 320   demux_close_gif,
 321   NULL,
 322   NULL
 323 };