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
  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 handles
  31  * special FLIs from the PC games "Magic Carpet" and "X-COM: Terror from the Deep".
  32  */
  33
  34 #include "libavutil/channel_layout.h"
  35 #include "libavutil/intreadwrite.h"
  36 #include "avformat.h"
  37 #include "avio_internal.h"
  38 #include "demux.h"
  39 #include "internal.h"
  40
  41 #define FLIC_FILE_MAGIC_1 0xAF11
  42 #define FLIC_FILE_MAGIC_2 0xAF12
  43 #define FLIC_FILE_MAGIC_3 0xAF44  /* Flic Type for Extended FLX Format which
  44                                      originated in Dave's Targa Animator (DTA) */
  45 #define FLIC_CHUNK_MAGIC_1 0xF1FA
  46 #define FLIC_CHUNK_MAGIC_2 0xF5FA
  47 #define FLIC_MC_SPEED 5  /* speed for Magic Carpet game FLIs */
  48 #define FLIC_DEFAULT_SPEED 5  /* for FLIs that have 0 speed */
  49 #define FLIC_TFTD_CHUNK_AUDIO 0xAAAA /* Audio chunk. Used in Terror from the Deep.
  50                                         Has 10 B extra header not accounted for in the chunk header */
  51 #define FLIC_TFTD_SAMPLE_RATE 22050
  52
  53 #define FLIC_HEADER_SIZE 128
  54 #define FLIC_PREAMBLE_SIZE 6
  55
  56 typedef struct FlicDemuxContext {
  57     int video_stream_index;
  58     int audio_stream_index;
  59     int frame_number;
  60 } FlicDemuxContext;
  61
  62 static int flic_probe(const AVProbeData *p)
  63 {
  64     int magic_number;
  65
  66     if(p->buf_size < FLIC_HEADER_SIZE)
  67         return 0;
  68
  69     magic_number = AV_RL16(&p->buf[4]);
  70     if ((magic_number != FLIC_FILE_MAGIC_1) &&
  71         (magic_number != FLIC_FILE_MAGIC_2) &&
  72         (magic_number != FLIC_FILE_MAGIC_3))
  73         return 0;
  74
  75     if(AV_RL16(&p->buf[0x10]) != FLIC_CHUNK_MAGIC_1){
  76         if(AV_RL32(&p->buf[0x10]) > 2000)
  77             return 0;
  78     }
  79
  80     if(   AV_RL16(&p->buf[0x08]) > 4096
  81        || AV_RL16(&p->buf[0x0A]) > 4096)
  82         return 0;
  83
  84
  85     return AVPROBE_SCORE_MAX - 1;
  86 }
  87
  88 static int flic_read_header(AVFormatContext *s)
  89 {
  90     FlicDemuxContext *flic = s->priv_data;
  91     AVIOContext *pb = s->pb;
  92     unsigned char header[FLIC_HEADER_SIZE];
  93     AVStream *st, *ast;
  94     int speed, ret;
  95     int magic_number;
  96     unsigned char preamble[FLIC_PREAMBLE_SIZE];
  97
  98     flic->frame_number = 0;
  99
 100     /* load the whole header and pull out the width and height */
 101     if ((ret = ffio_read_size(pb, header, FLIC_HEADER_SIZE)) < 0)
 102         return ret;
 103
 104     magic_number = AV_RL16(&header[4]);
 105     speed = AV_RL32(&header[0x10]);
 106     if (speed == 0)
 107         speed = FLIC_DEFAULT_SPEED;
 108
 109     /* initialize the decoder streams */
 110     st = avformat_new_stream(s, NULL);
 111     if (!st)
 112         return AVERROR(ENOMEM);
 113     flic->video_stream_index = st->index;
 114     st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
 115     st->codecpar->codec_id = AV_CODEC_ID_FLIC;
 116     st->codecpar->codec_tag = 0;  /* no fourcc */
 117     st->codecpar->width = AV_RL16(&header[0x08]);
 118     st->codecpar->height = AV_RL16(&header[0x0A]);
 119
 120     if (!st->codecpar->width || !st->codecpar->height) {
 121         /* Ugly hack needed for the following sample: */
 122         /* http://samples.mplayerhq.hu/fli-flc/fli-bugs/specular.flc */
 123         av_log(s, AV_LOG_WARNING,
 124                "File with no specified width/height. Trying 640x480.\n");
 125         st->codecpar->width  = 640;
 126         st->codecpar->height = 480;
 127     }
 128
 129     /* send over the whole 128-byte FLIC header */
 130     if ((ret = ff_alloc_extradata(st->codecpar, FLIC_HEADER_SIZE)) < 0)
 131         return ret;
 132     memcpy(st->codecpar->extradata, header, FLIC_HEADER_SIZE);
 133
 134     /* peek at the preamble to detect TFTD videos - they seem to always start with an audio chunk */
 135     if ((ret = ffio_read_size(pb, preamble, FLIC_PREAMBLE_SIZE)) < 0) {
 136         av_log(s, AV_LOG_ERROR, "Failed to peek at preamble\n");
 137         return ret;
 138     }
 139
 140     avio_seek(pb, -FLIC_PREAMBLE_SIZE, SEEK_CUR);
 141
 142     /* Time to figure out the framerate:
 143      * If the first preamble's magic number is 0xAAAA then this file is from
 144      * X-COM: Terror from the Deep. If on the other hand there is a FLIC chunk
 145      * magic number at offset 0x10 assume this file is from Magic Carpet instead.
 146      * If neither of the above is true then this is a normal FLIC file.
 147      */
 148     if (AV_RL16(&preamble[4]) == FLIC_TFTD_CHUNK_AUDIO) {
 149         /* TFTD videos have an extra 22050 Hz 8-bit mono audio stream */
 150         ast = avformat_new_stream(s, NULL);
 151         if (!ast)
 152             return AVERROR(ENOMEM);
 153
 154         flic->audio_stream_index = ast->index;
 155
 156         /* all audio frames are the same size, so use the size of the first chunk for block_align */
 157         ast->codecpar->block_align = AV_RL32(&preamble[0]);
 158         ast->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
 159         ast->codecpar->codec_id = AV_CODEC_ID_PCM_U8;
 160         ast->codecpar->codec_tag = 0;
 161         ast->codecpar->sample_rate = FLIC_TFTD_SAMPLE_RATE;
 162         ast->codecpar->bit_rate = st->codecpar->sample_rate * 8;
 163         ast->codecpar->bits_per_coded_sample = 8;
 164         ast->codecpar->ch_layout = (AVChannelLayout)AV_CHANNEL_LAYOUT_MONO;
 165         ast->codecpar->extradata_size = 0;
 166
 167         /* Since the header information is incorrect we have to figure out the
 168          * framerate using block_align and the fact that the audio is 22050 Hz.
 169          * We usually have two cases: 2205 -> 10 fps and 1470 -> 15 fps */
 170         avpriv_set_pts_info(st, 64, ast->codecpar->block_align, FLIC_TFTD_SAMPLE_RATE);
 171         avpriv_set_pts_info(ast, 64, 1, FLIC_TFTD_SAMPLE_RATE);
 172     } else if (AV_RL16(&header[0x10]) == FLIC_CHUNK_MAGIC_1) {
 173         avpriv_set_pts_info(st, 64, FLIC_MC_SPEED, 70);
 174
 175         /* rewind the stream since the first chunk is at offset 12 */
 176         avio_seek(pb, 12, SEEK_SET);
 177
 178         /* send over abbreviated FLIC header chunk */
 179         if ((ret = ff_alloc_extradata(st->codecpar, 12)) < 0)
 180             return ret;
 181         memcpy(st->codecpar->extradata, header, 12);
 182
 183     } else if (magic_number == FLIC_FILE_MAGIC_1) {
 184         avpriv_set_pts_info(st, 64, speed, 70);
 185     } else if ((magic_number == FLIC_FILE_MAGIC_2) ||
 186                (magic_number == FLIC_FILE_MAGIC_3)) {
 187         avpriv_set_pts_info(st, 64, speed, 1000);
 188     } else {
 189         av_log(s, AV_LOG_ERROR, "Invalid or unsupported magic chunk in file\n");
 190         return AVERROR_INVALIDDATA;
 191     }
 192
 193     return 0;
 194 }
 195
 196 static int flic_read_packet(AVFormatContext *s,
 197                             AVPacket *pkt)
 198 {
 199     FlicDemuxContext *flic = s->priv_data;
 200     AVIOContext *pb = s->pb;
 201     int packet_read = 0;
 202     unsigned int size;
 203     int magic;
 204     int ret = 0;
 205     unsigned char preamble[FLIC_PREAMBLE_SIZE];
 206     int64_t pos = avio_tell(pb);
 207
 208     while (!packet_read && !avio_feof(pb)) {
 209
 210         if ((ret = ffio_read_size(pb, preamble, FLIC_PREAMBLE_SIZE)) < 0)
 211             break;
 212
 213         size = AV_RL32(&preamble[0]);
 214         magic = AV_RL16(&preamble[4]);
 215
 216         if (((magic == FLIC_CHUNK_MAGIC_1) || (magic == FLIC_CHUNK_MAGIC_2)) && size > FLIC_PREAMBLE_SIZE) {
 217             if ((ret = av_new_packet(pkt, size)) < 0)
 218                 return ret;
 219
 220             pkt->stream_index = flic->video_stream_index;
 221             pkt->pos = pos;
 222             memcpy(pkt->data, preamble, FLIC_PREAMBLE_SIZE);
 223             ret = ffio_read_size(pb, pkt->data + FLIC_PREAMBLE_SIZE,
 224                 size - FLIC_PREAMBLE_SIZE);
 225             pkt->flags = flic->frame_number == 0 ? AV_PKT_FLAG_KEY : 0;
 226             pkt->pts = flic->frame_number;
 227             if (flic->frame_number == 0)
 228                 av_add_index_entry(s->streams[flic->video_stream_index], pkt->pos, pkt->pts, pkt->size, 0, AVINDEX_KEYFRAME);
 229             packet_read = 1;
 230             flic->frame_number++;
 231         } else if (magic == FLIC_TFTD_CHUNK_AUDIO) {
 232             if ((ret = av_new_packet(pkt, size)) < 0)
 233                 return ret;
 234
 235             /* skip useless 10B sub-header (yes, it's not accounted for in the chunk header) */
 236             avio_skip(pb, 10);
 237
 238             pkt->stream_index = flic->audio_stream_index;
 239             pkt->pos = pos;
 240             pkt->flags = AV_PKT_FLAG_KEY;
 241             ret = ffio_read_size(pb, pkt->data, size);
 242
 243             if (ret < 0)
 244                 break;
 245
 246             packet_read = 1;
 247         } else {
 248             /* not interested in this chunk */
 249             avio_skip(pb, size - 6);
 250         }
 251     }
 252
 253     return avio_feof(pb) ? AVERROR_EOF : ret;
 254 }
 255
 256 static int flic_read_seek(AVFormatContext *s, int stream_index,
 257                           int64_t pts, int flags)
 258 {
 259     FlicDemuxContext *flic = s->priv_data;
 260     AVStream *st = s->streams[stream_index];
 261     FFStream *const sti = ffstream(st);
 262     int64_t pos, ts;
 263     int index;
 264
 265     if (!sti->index_entries || stream_index != flic->video_stream_index)
 266         return -1;
 267
 268     index = av_index_search_timestamp(st, pts, flags);
 269
 270     if (index < 0)
 271         index = av_index_search_timestamp(st, pts, flags ^ AVSEEK_FLAG_BACKWARD);
 272     if (index < 0)
 273         return -1;
 274
 275     pos = sti->index_entries[index].pos;
 276     ts  = sti->index_entries[index].timestamp;
 277     flic->frame_number = ts;
 278     avio_seek(s->pb, pos, SEEK_SET);
 279     return 0;
 280 }
 281
 282 const FFInputFormat ff_flic_demuxer = {
 283     .p.name         = "flic",
 284     .p.long_name    = NULL_IF_CONFIG_SMALL("FLI/FLC/FLX animation"),
 285     .priv_data_size = sizeof(FlicDemuxContext),
 286     .read_probe     = flic_probe,
 287     .read_header    = flic_read_header,
 288     .read_packet    = flic_read_packet,
 289     .read_seek      = flic_read_seek,
 290 };