yading@11: /*
yading@11:  * FLI/FLC Animation File Demuxer
yading@11:  * Copyright (c) 2003 The ffmpeg Project
yading@11:  *
yading@11:  * This file is part of FFmpeg.
yading@11:  *
yading@11:  * FFmpeg is free software; you can redistribute it and/or
yading@11:  * modify it under the terms of the GNU Lesser General Public
yading@11:  * License as published by the Free Software Foundation; either
yading@11:  * version 2.1 of the License, or (at your option) any later version.
yading@11:  *
yading@11:  * FFmpeg is distributed in the hope that it will be useful,
yading@11:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@11:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@11:  * Lesser General Public License for more details.
yading@11:  *
yading@11:  * You should have received a copy of the GNU Lesser General Public
yading@11:  * License along with FFmpeg; if not, write to the Free Software
yading@11:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@11:  */
yading@11: 
yading@11: /**
yading@11:  * @file
yading@11:  * FLI/FLC file demuxer
yading@11:  * by Mike Melanson (melanson@pcisys.net)
yading@11:  * for more information on the .fli/.flc file format and all of its many
yading@11:  * variations, visit:
yading@11:  *   http://www.compuphase.com/flic.htm
yading@11:  *
yading@11:  * This demuxer handles standard 0xAF11- and 0xAF12-type FLIs. It also handles
yading@11:  * special FLIs from the PC games "Magic Carpet" and "X-COM: Terror from the Deep".
yading@11:  */
yading@11: 
yading@11: #include "libavutil/channel_layout.h"
yading@11: #include "libavutil/intreadwrite.h"
yading@11: #include "avformat.h"
yading@11: #include "internal.h"
yading@11: 
yading@11: #define FLIC_FILE_MAGIC_1 0xAF11
yading@11: #define FLIC_FILE_MAGIC_2 0xAF12
yading@11: #define FLIC_FILE_MAGIC_3 0xAF44  /* Flic Type for Extended FLX Format which
yading@11:                                      originated in Dave's Targa Animator (DTA) */
yading@11: #define FLIC_CHUNK_MAGIC_1 0xF1FA
yading@11: #define FLIC_CHUNK_MAGIC_2 0xF5FA
yading@11: #define FLIC_MC_SPEED 5  /* speed for Magic Carpet game FLIs */
yading@11: #define FLIC_DEFAULT_SPEED 5  /* for FLIs that have 0 speed */
yading@11: #define FLIC_TFTD_CHUNK_AUDIO 0xAAAA /* Audio chunk. Used in Terror from the Deep.
yading@11:                                         Has 10 B extra header not accounted for in the chunk header */
yading@11: #define FLIC_TFTD_SAMPLE_RATE 22050
yading@11: 
yading@11: #define FLIC_HEADER_SIZE 128
yading@11: #define FLIC_PREAMBLE_SIZE 6
yading@11: 
yading@11: typedef struct FlicDemuxContext {
yading@11:     int video_stream_index;
yading@11:     int audio_stream_index;
yading@11:     int frame_number;
yading@11: } FlicDemuxContext;
yading@11: 
yading@11: static int flic_probe(AVProbeData *p)
yading@11: {
yading@11:     int magic_number;
yading@11: 
yading@11:     if(p->buf_size < FLIC_HEADER_SIZE)
yading@11:         return 0;
yading@11: 
yading@11:     magic_number = AV_RL16(&p->buf[4]);
yading@11:     if ((magic_number != FLIC_FILE_MAGIC_1) &&
yading@11:         (magic_number != FLIC_FILE_MAGIC_2) &&
yading@11:         (magic_number != FLIC_FILE_MAGIC_3))
yading@11:         return 0;
yading@11: 
yading@11:     if(AV_RL16(&p->buf[0x10]) != FLIC_CHUNK_MAGIC_1){
yading@11:         if(AV_RL32(&p->buf[0x10]) > 2000)
yading@11:             return 0;
yading@11:     }
yading@11: 
yading@11:     if(   AV_RL16(&p->buf[0x08]) > 4096
yading@11:        || AV_RL16(&p->buf[0x0A]) > 4096)
yading@11:         return 0;
yading@11: 
yading@11: 
yading@11:     return AVPROBE_SCORE_MAX;
yading@11: }
yading@11: 
yading@11: static int flic_read_header(AVFormatContext *s)
yading@11: {
yading@11:     FlicDemuxContext *flic = s->priv_data;
yading@11:     AVIOContext *pb = s->pb;
yading@11:     unsigned char header[FLIC_HEADER_SIZE];
yading@11:     AVStream *st, *ast;
yading@11:     int speed;
yading@11:     int magic_number;
yading@11:     unsigned char preamble[FLIC_PREAMBLE_SIZE];
yading@11: 
yading@11:     flic->frame_number = 0;
yading@11: 
yading@11:     /* load the whole header and pull out the width and height */
yading@11:     if (avio_read(pb, header, FLIC_HEADER_SIZE) != FLIC_HEADER_SIZE)
yading@11:         return AVERROR(EIO);
yading@11: 
yading@11:     magic_number = AV_RL16(&header[4]);
yading@11:     speed = AV_RL32(&header[0x10]);
yading@11:     if (speed == 0)
yading@11:         speed = FLIC_DEFAULT_SPEED;
yading@11: 
yading@11:     /* initialize the decoder streams */
yading@11:     st = avformat_new_stream(s, NULL);
yading@11:     if (!st)
yading@11:         return AVERROR(ENOMEM);
yading@11:     flic->video_stream_index = st->index;
yading@11:     st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
yading@11:     st->codec->codec_id = AV_CODEC_ID_FLIC;
yading@11:     st->codec->codec_tag = 0;  /* no fourcc */
yading@11:     st->codec->width = AV_RL16(&header[0x08]);
yading@11:     st->codec->height = AV_RL16(&header[0x0A]);
yading@11: 
yading@11:     if (!st->codec->width || !st->codec->height) {
yading@11:         /* Ugly hack needed for the following sample: */
yading@11:         /* http://samples.mplayerhq.hu/fli-flc/fli-bugs/specular.flc */
yading@11:         av_log(s, AV_LOG_WARNING,
yading@11:                "File with no specified width/height. Trying 640x480.\n");
yading@11:         st->codec->width  = 640;
yading@11:         st->codec->height = 480;
yading@11:     }
yading@11: 
yading@11:     /* send over the whole 128-byte FLIC header */
yading@11:     st->codec->extradata_size = FLIC_HEADER_SIZE;
yading@11:     st->codec->extradata = av_malloc(FLIC_HEADER_SIZE);
yading@11:     memcpy(st->codec->extradata, header, FLIC_HEADER_SIZE);
yading@11: 
yading@11:     /* peek at the preamble to detect TFTD videos - they seem to always start with an audio chunk */
yading@11:     if (avio_read(pb, preamble, FLIC_PREAMBLE_SIZE) != FLIC_PREAMBLE_SIZE) {
yading@11:         av_log(s, AV_LOG_ERROR, "Failed to peek at preamble\n");
yading@11:         return AVERROR(EIO);
yading@11:     }
yading@11: 
yading@11:     avio_seek(pb, -FLIC_PREAMBLE_SIZE, SEEK_CUR);
yading@11: 
yading@11:     /* Time to figure out the framerate:
yading@11:      * If the first preamble's magic number is 0xAAAA then this file is from
yading@11:      * X-COM: Terror from the Deep. If on the other hand there is a FLIC chunk
yading@11:      * magic number at offset 0x10 assume this file is from Magic Carpet instead.
yading@11:      * If neither of the above is true then this is a normal FLIC file.
yading@11:      */
yading@11:     if (AV_RL16(&preamble[4]) == FLIC_TFTD_CHUNK_AUDIO) {
yading@11:         /* TFTD videos have an extra 22050 Hz 8-bit mono audio stream */
yading@11:         ast = avformat_new_stream(s, NULL);
yading@11:         if (!ast)
yading@11:             return AVERROR(ENOMEM);
yading@11: 
yading@11:         flic->audio_stream_index = ast->index;
yading@11: 
yading@11:         /* all audio frames are the same size, so use the size of the first chunk for block_align */
yading@11:         ast->codec->block_align = AV_RL32(&preamble[0]);
yading@11:         ast->codec->codec_type = AVMEDIA_TYPE_AUDIO;
yading@11:         ast->codec->codec_id = AV_CODEC_ID_PCM_U8;
yading@11:         ast->codec->codec_tag = 0;
yading@11:         ast->codec->sample_rate = FLIC_TFTD_SAMPLE_RATE;
yading@11:         ast->codec->channels = 1;
yading@11:         ast->codec->bit_rate = st->codec->sample_rate * 8;
yading@11:         ast->codec->bits_per_coded_sample = 8;
yading@11:         ast->codec->channel_layout = AV_CH_LAYOUT_MONO;
yading@11:         ast->codec->extradata_size = 0;
yading@11: 
yading@11:         /* Since the header information is incorrect we have to figure out the
yading@11:          * framerate using block_align and the fact that the audio is 22050 Hz.
yading@11:          * We usually have two cases: 2205 -> 10 fps and 1470 -> 15 fps */
yading@11:         avpriv_set_pts_info(st, 64, ast->codec->block_align, FLIC_TFTD_SAMPLE_RATE);
yading@11:         avpriv_set_pts_info(ast, 64, 1, FLIC_TFTD_SAMPLE_RATE);
yading@11:     } else if (AV_RL16(&header[0x10]) == FLIC_CHUNK_MAGIC_1) {
yading@11:         avpriv_set_pts_info(st, 64, FLIC_MC_SPEED, 70);
yading@11: 
yading@11:         /* rewind the stream since the first chunk is at offset 12 */
yading@11:         avio_seek(pb, 12, SEEK_SET);
yading@11: 
yading@11:         /* send over abbreviated FLIC header chunk */
yading@11:         av_free(st->codec->extradata);
yading@11:         st->codec->extradata_size = 12;
yading@11:         st->codec->extradata = av_malloc(12);
yading@11:         memcpy(st->codec->extradata, header, 12);
yading@11: 
yading@11:     } else if (magic_number == FLIC_FILE_MAGIC_1) {
yading@11:         avpriv_set_pts_info(st, 64, speed, 70);
yading@11:     } else if ((magic_number == FLIC_FILE_MAGIC_2) ||
yading@11:                (magic_number == FLIC_FILE_MAGIC_3)) {
yading@11:         avpriv_set_pts_info(st, 64, speed, 1000);
yading@11:     } else {
yading@11:         av_log(s, AV_LOG_ERROR, "Invalid or unsupported magic chunk in file\n");
yading@11:         return AVERROR_INVALIDDATA;
yading@11:     }
yading@11: 
yading@11:     return 0;
yading@11: }
yading@11: 
yading@11: static int flic_read_packet(AVFormatContext *s,
yading@11:                             AVPacket *pkt)
yading@11: {
yading@11:     FlicDemuxContext *flic = s->priv_data;
yading@11:     AVIOContext *pb = s->pb;
yading@11:     int packet_read = 0;
yading@11:     unsigned int size;
yading@11:     int magic;
yading@11:     int ret = 0;
yading@11:     unsigned char preamble[FLIC_PREAMBLE_SIZE];
yading@11: 
yading@11:     while (!packet_read) {
yading@11: 
yading@11:         if ((ret = avio_read(pb, preamble, FLIC_PREAMBLE_SIZE)) !=
yading@11:             FLIC_PREAMBLE_SIZE) {
yading@11:             ret = AVERROR(EIO);
yading@11:             break;
yading@11:         }
yading@11: 
yading@11:         size = AV_RL32(&preamble[0]);
yading@11:         magic = AV_RL16(&preamble[4]);
yading@11: 
yading@11:         if (((magic == FLIC_CHUNK_MAGIC_1) || (magic == FLIC_CHUNK_MAGIC_2)) && size > FLIC_PREAMBLE_SIZE) {
yading@11:             if (av_new_packet(pkt, size)) {
yading@11:                 ret = AVERROR(EIO);
yading@11:                 break;
yading@11:             }
yading@11:             pkt->stream_index = flic->video_stream_index;
yading@11:             pkt->pts = flic->frame_number++;
yading@11:             pkt->pos = avio_tell(pb);
yading@11:             memcpy(pkt->data, preamble, FLIC_PREAMBLE_SIZE);
yading@11:             ret = avio_read(pb, pkt->data + FLIC_PREAMBLE_SIZE,
yading@11:                 size - FLIC_PREAMBLE_SIZE);
yading@11:             if (ret != size - FLIC_PREAMBLE_SIZE) {
yading@11:                 av_free_packet(pkt);
yading@11:                 ret = AVERROR(EIO);
yading@11:             }
yading@11:             packet_read = 1;
yading@11:         } else if (magic == FLIC_TFTD_CHUNK_AUDIO) {
yading@11:             if (av_new_packet(pkt, size)) {
yading@11:                 ret = AVERROR(EIO);
yading@11:                 break;
yading@11:             }
yading@11: 
yading@11:             /* skip useless 10B sub-header (yes, it's not accounted for in the chunk header) */
yading@11:             avio_skip(pb, 10);
yading@11: 
yading@11:             pkt->stream_index = flic->audio_stream_index;
yading@11:             pkt->pos = avio_tell(pb);
yading@11:             ret = avio_read(pb, pkt->data, size);
yading@11: 
yading@11:             if (ret != size) {
yading@11:                 av_free_packet(pkt);
yading@11:                 ret = AVERROR(EIO);
yading@11:             }
yading@11: 
yading@11:             packet_read = 1;
yading@11:         } else {
yading@11:             /* not interested in this chunk */
yading@11:             avio_skip(pb, size - 6);
yading@11:         }
yading@11:     }
yading@11: 
yading@11:     return ret;
yading@11: }
yading@11: 
yading@11: AVInputFormat ff_flic_demuxer = {
yading@11:     .name           = "flic",
yading@11:     .long_name      = NULL_IF_CONFIG_SMALL("FLI/FLC/FLX animation"),
yading@11:     .priv_data_size = sizeof(FlicDemuxContext),
yading@11:     .read_probe     = flic_probe,
yading@11:     .read_header    = flic_read_header,
yading@11:     .read_packet    = flic_read_packet,
yading@11: };