libavformat/flic.c

   1 /*
   2  * FLI/FLC Animation File Demuxer
   3  * Copyright (c) 2003 The ffmpeg Project
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * FFmpeg 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 GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 /**
  23  * @file flic.c
  24  * FLI/FLC file demuxer
  25  * by Mike Melanson (melanson@pcisys.net)
  26  * for more information on the .fli/.flc file format and all of its many
  27  * variations, visit:
  28  *   http://www.compuphase.com/flic.htm
  29  *
  30  * This demuxer handles standard 0xAF11- and 0xAF12-type FLIs. It also
  31  * handles special FLIs from the PC game "Magic Carpet".
  32  */
  33
  34 #include "avformat.h"
  35
  36 #define FLIC_FILE_MAGIC_1 0xAF11
  37 #define FLIC_FILE_MAGIC_2 0xAF12
  38 #define FLIC_FILE_MAGIC_3 0xAF44  /* Flic Type for Extended FLX Format which
  39                                      originated in Dave's Targa Animator (DTA) */
  40 #define FLIC_CHUNK_MAGIC_1 0xF1FA
  41 #define FLIC_CHUNK_MAGIC_2 0xF5FA
  42 #define FLIC_MC_SPEED 5  /* speed for Magic Carpet game FLIs */
  43 #define FLIC_DEFAULT_SPEED 5  /* for FLIs that have 0 speed */
  44
  45 #define FLIC_HEADER_SIZE 128
  46 #define FLIC_PREAMBLE_SIZE 6
  47
  48 typedef struct FlicDemuxContext {
  49     int video_stream_index;
  50     int frame_number;
  51 } FlicDemuxContext;
  52
  53 static int flic_probe(AVProbeData *p)
  54 {
  55     int magic_number;
  56
  57     if(p->buf_size < FLIC_HEADER_SIZE)
  58         return 0;
  59
  60     magic_number = AV_RL16(&p->buf[4]);
  61     if ((magic_number != FLIC_FILE_MAGIC_1) &&
  62         (magic_number != FLIC_FILE_MAGIC_2) &&
  63         (magic_number != FLIC_FILE_MAGIC_3))
  64         return 0;
  65
  66     if(AV_RL16(&p->buf[0x10]) != FLIC_CHUNK_MAGIC_1){
  67         if(AV_RL32(&p->buf[0x10]) > 2000)
  68             return 0;
  69     }
  70
  71     if(   AV_RL16(&p->buf[0x08]) > 4096
  72        || AV_RL16(&p->buf[0x0A]) > 4096)
  73         return 0;
  74
  75
  76     return AVPROBE_SCORE_MAX;
  77 }
  78
  79 static int flic_read_header(AVFormatContext *s,
  80                             AVFormatParameters *ap)
  81 {
  82     FlicDemuxContext *flic = s->priv_data;
  83     ByteIOContext *pb = s->pb;
  84     unsigned char header[FLIC_HEADER_SIZE];
  85     AVStream *st;
  86     int speed;
  87     int magic_number;
  88
  89     flic->frame_number = 0;
  90
  91     /* load the whole header and pull out the width and height */
  92     if (get_buffer(pb, header, FLIC_HEADER_SIZE) != FLIC_HEADER_SIZE)
  93         return AVERROR(EIO);
  94
  95     magic_number = AV_RL16(&header[4]);
  96     speed = AV_RL32(&header[0x10]);
  97     if (speed == 0)
  98         speed = FLIC_DEFAULT_SPEED;
  99
 100     /* initialize the decoder streams */
 101     st = av_new_stream(s, 0);
 102     if (!st)
 103         return AVERROR(ENOMEM);
 104     flic->video_stream_index = st->index;
 105     st->codec->codec_type = CODEC_TYPE_VIDEO;
 106     st->codec->codec_id = CODEC_ID_FLIC;
 107     st->codec->codec_tag = 0;  /* no fourcc */
 108     st->codec->width = AV_RL16(&header[0x08]);
 109     st->codec->height = AV_RL16(&header[0x0A]);
 110
 111     if (!st->codec->width || !st->codec->height) {
 112         /* Ugly hack needed for the following sample: */
 113         /* http://samples.mplayerhq.hu/fli-flc/fli-bugs/specular.flc */
 114         av_log(s, AV_LOG_WARNING,
 115                "File with no specified width/height. Trying 640x480.\n");
 116         st->codec->width  = 640;
 117         st->codec->height = 480;
 118     }
 119
 120     /* send over the whole 128-byte FLIC header */
 121     st->codec->extradata_size = FLIC_HEADER_SIZE;
 122     st->codec->extradata = av_malloc(FLIC_HEADER_SIZE);
 123     memcpy(st->codec->extradata, header, FLIC_HEADER_SIZE);
 124
 125     /* Time to figure out the framerate: If there is a FLIC chunk magic
 126      * number at offset 0x10, assume this is from the Bullfrog game,
 127      * Magic Carpet. */
 128     if (AV_RL16(&header[0x10]) == FLIC_CHUNK_MAGIC_1) {
 129
 130         av_set_pts_info(st, 64, FLIC_MC_SPEED, 70);
 131
 132         /* rewind the stream since the first chunk is at offset 12 */
 133         url_fseek(pb, 12, SEEK_SET);
 134
 135         /* send over abbreviated FLIC header chunk */
 136         av_free(st->codec->extradata);
 137         st->codec->extradata_size = 12;
 138         st->codec->extradata = av_malloc(12);
 139         memcpy(st->codec->extradata, header, 12);
 140
 141     } else if (magic_number == FLIC_FILE_MAGIC_1) {
 142         av_set_pts_info(st, 64, speed, 70);
 143     } else if ((magic_number == FLIC_FILE_MAGIC_2) ||
 144                (magic_number == FLIC_FILE_MAGIC_3)) {
 145         av_set_pts_info(st, 64, speed, 1000);
 146     } else {
 147         av_log(s, AV_LOG_INFO, "Invalid or unsupported magic chunk in file\n");
 148         return AVERROR_INVALIDDATA;
 149     }
 150
 151     return 0;
 152 }
 153
 154 static int flic_read_packet(AVFormatContext *s,
 155                             AVPacket *pkt)
 156 {
 157     FlicDemuxContext *flic = s->priv_data;
 158     ByteIOContext *pb = s->pb;
 159     int packet_read = 0;
 160     unsigned int size;
 161     int magic;
 162     int ret = 0;
 163     unsigned char preamble[FLIC_PREAMBLE_SIZE];
 164
 165     while (!packet_read) {
 166
 167         if ((ret = get_buffer(pb, preamble, FLIC_PREAMBLE_SIZE)) !=
 168             FLIC_PREAMBLE_SIZE) {
 169             ret = AVERROR(EIO);
 170             break;
 171         }
 172
 173         size = AV_RL32(&preamble[0]);
 174         magic = AV_RL16(&preamble[4]);
 175
 176         if (((magic == FLIC_CHUNK_MAGIC_1) || (magic == FLIC_CHUNK_MAGIC_2)) && size > FLIC_PREAMBLE_SIZE) {
 177             if (av_new_packet(pkt, size)) {
 178                 ret = AVERROR(EIO);
 179                 break;
 180             }
 181             pkt->stream_index = flic->video_stream_index;
 182             pkt->pts = flic->frame_number++;
 183             pkt->pos = url_ftell(pb);
 184             memcpy(pkt->data, preamble, FLIC_PREAMBLE_SIZE);
 185             ret = get_buffer(pb, pkt->data + FLIC_PREAMBLE_SIZE,
 186                 size - FLIC_PREAMBLE_SIZE);
 187             if (ret != size - FLIC_PREAMBLE_SIZE) {
 188                 av_free_packet(pkt);
 189                 ret = AVERROR(EIO);
 190             }
 191             packet_read = 1;
 192         } else {
 193             /* not interested in this chunk */
 194             url_fseek(pb, size - 6, SEEK_CUR);
 195         }
 196     }
 197
 198     return ret;
 199 }
 200
 201 AVInputFormat flic_demuxer = {
 202     "flic",
 203     NULL_IF_CONFIG_SMALL("FLI/FLC/FLX animation format"),
 204     sizeof(FlicDemuxContext),
 205     flic_probe,
 206     flic_read_header,
 207     flic_read_packet,
 208 };