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 libavformat/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 "libavutil/intreadwrite.h"
35#include "avformat.h"
36
37#define FLIC_FILE_MAGIC_1 0xAF11
38#define FLIC_FILE_MAGIC_2 0xAF12
39#define FLIC_FILE_MAGIC_3 0xAF44  /* Flic Type for Extended FLX Format which
40                                     originated in Dave's Targa Animator (DTA) */
41#define FLIC_CHUNK_MAGIC_1 0xF1FA
42#define FLIC_CHUNK_MAGIC_2 0xF5FA
43#define FLIC_MC_SPEED 5  /* speed for Magic Carpet game FLIs */
44#define FLIC_DEFAULT_SPEED 5  /* for FLIs that have 0 speed */
45
46#define FLIC_HEADER_SIZE 128
47#define FLIC_PREAMBLE_SIZE 6
48
49typedef struct FlicDemuxContext {
50    int video_stream_index;
51    int frame_number;
52} FlicDemuxContext;
53
54static int flic_probe(AVProbeData *p)
55{
56    int magic_number;
57
58    if(p->buf_size < FLIC_HEADER_SIZE)
59        return 0;
60
61    magic_number = AV_RL16(&p->buf[4]);
62    if ((magic_number != FLIC_FILE_MAGIC_1) &&
63        (magic_number != FLIC_FILE_MAGIC_2) &&
64        (magic_number != FLIC_FILE_MAGIC_3))
65        return 0;
66
67    if(AV_RL16(&p->buf[0x10]) != FLIC_CHUNK_MAGIC_1){
68        if(AV_RL32(&p->buf[0x10]) > 2000)
69            return 0;
70    }
71
72    if(   AV_RL16(&p->buf[0x08]) > 4096
73       || AV_RL16(&p->buf[0x0A]) > 4096)
74        return 0;
75
76
77    return AVPROBE_SCORE_MAX;
78}
79
80static int flic_read_header(AVFormatContext *s,
81                            AVFormatParameters *ap)
82{
83    FlicDemuxContext *flic = s->priv_data;
84    ByteIOContext *pb = s->pb;
85    unsigned char header[FLIC_HEADER_SIZE];
86    AVStream *st;
87    int speed;
88    int magic_number;
89
90    flic->frame_number = 0;
91
92    /* load the whole header and pull out the width and height */
93    if (get_buffer(pb, header, FLIC_HEADER_SIZE) != FLIC_HEADER_SIZE)
94        return AVERROR(EIO);
95
96    magic_number = AV_RL16(&header[4]);
97    speed = AV_RL32(&header[0x10]);
98    if (speed == 0)
99        speed = FLIC_DEFAULT_SPEED;
100
101    /* initialize the decoder streams */
102    st = av_new_stream(s, 0);
103    if (!st)
104        return AVERROR(ENOMEM);
105    flic->video_stream_index = st->index;
106    st->codec->codec_type = CODEC_TYPE_VIDEO;
107    st->codec->codec_id = CODEC_ID_FLIC;
108    st->codec->codec_tag = 0;  /* no fourcc */
109    st->codec->width = AV_RL16(&header[0x08]);
110    st->codec->height = AV_RL16(&header[0x0A]);
111
112    if (!st->codec->width || !st->codec->height) {
113        /* Ugly hack needed for the following sample: */
114        /* http://samples.mplayerhq.hu/fli-flc/fli-bugs/specular.flc */
115        av_log(s, AV_LOG_WARNING,
116               "File with no specified width/height. Trying 640x480.\n");
117        st->codec->width  = 640;
118        st->codec->height = 480;
119    }
120
121    /* send over the whole 128-byte FLIC header */
122    st->codec->extradata_size = FLIC_HEADER_SIZE;
123    st->codec->extradata = av_malloc(FLIC_HEADER_SIZE);
124    memcpy(st->codec->extradata, header, FLIC_HEADER_SIZE);
125
126    /* Time to figure out the framerate: If there is a FLIC chunk magic
127     * number at offset 0x10, assume this is from the Bullfrog game,
128     * Magic Carpet. */
129    if (AV_RL16(&header[0x10]) == FLIC_CHUNK_MAGIC_1) {
130
131        av_set_pts_info(st, 64, FLIC_MC_SPEED, 70);
132
133        /* rewind the stream since the first chunk is at offset 12 */
134        url_fseek(pb, 12, SEEK_SET);
135
136        /* send over abbreviated FLIC header chunk */
137        av_free(st->codec->extradata);
138        st->codec->extradata_size = 12;
139        st->codec->extradata = av_malloc(12);
140        memcpy(st->codec->extradata, header, 12);
141
142    } else if (magic_number == FLIC_FILE_MAGIC_1) {
143        av_set_pts_info(st, 64, speed, 70);
144    } else if ((magic_number == FLIC_FILE_MAGIC_2) ||
145               (magic_number == FLIC_FILE_MAGIC_3)) {
146        av_set_pts_info(st, 64, speed, 1000);
147    } else {
148        av_log(s, AV_LOG_INFO, "Invalid or unsupported magic chunk in file\n");
149        return AVERROR_INVALIDDATA;
150    }
151
152    return 0;
153}
154
155static int flic_read_packet(AVFormatContext *s,
156                            AVPacket *pkt)
157{
158    FlicDemuxContext *flic = s->priv_data;
159    ByteIOContext *pb = s->pb;
160    int packet_read = 0;
161    unsigned int size;
162    int magic;
163    int ret = 0;
164    unsigned char preamble[FLIC_PREAMBLE_SIZE];
165
166    while (!packet_read) {
167
168        if ((ret = get_buffer(pb, preamble, FLIC_PREAMBLE_SIZE)) !=
169            FLIC_PREAMBLE_SIZE) {
170            ret = AVERROR(EIO);
171            break;
172        }
173
174        size = AV_RL32(&preamble[0]);
175        magic = AV_RL16(&preamble[4]);
176
177        if (((magic == FLIC_CHUNK_MAGIC_1) || (magic == FLIC_CHUNK_MAGIC_2)) && size > FLIC_PREAMBLE_SIZE) {
178            if (av_new_packet(pkt, size)) {
179                ret = AVERROR(EIO);
180                break;
181            }
182            pkt->stream_index = flic->video_stream_index;
183            pkt->pts = flic->frame_number++;
184            pkt->pos = url_ftell(pb);
185            memcpy(pkt->data, preamble, FLIC_PREAMBLE_SIZE);
186            ret = get_buffer(pb, pkt->data + FLIC_PREAMBLE_SIZE,
187                size - FLIC_PREAMBLE_SIZE);
188            if (ret != size - FLIC_PREAMBLE_SIZE) {
189                av_free_packet(pkt);
190                ret = AVERROR(EIO);
191            }
192            packet_read = 1;
193        } else {
194            /* not interested in this chunk */
195            url_fseek(pb, size - 6, SEEK_CUR);
196        }
197    }
198
199    return ret;
200}
201
202AVInputFormat flic_demuxer = {
203    "flic",
204    NULL_IF_CONFIG_SMALL("FLI/FLC/FLX animation format"),
205    sizeof(FlicDemuxContext),
206    flic_probe,
207    flic_read_header,
208    flic_read_packet,
209};
210