flic.c 6.26 KB
Newer Older
Mike Melanson's avatar
Mike Melanson committed
1 2 3 4
/*
 * FLI/FLC Animation File Demuxer
 * Copyright (c) 2003 The ffmpeg Project
 *
5 6 7
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
Mike Melanson's avatar
Mike Melanson committed
8 9
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
10
 * version 2.1 of the License, or (at your option) any later version.
Mike Melanson's avatar
Mike Melanson committed
11
 *
12
 * FFmpeg is distributed in the hope that it will be useful,
Mike Melanson's avatar
Mike Melanson committed
13 14 15 16 17
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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
Mike Melanson's avatar
Mike Melanson committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
 */

/**
 * @file flic.c
 * FLI/FLC file demuxer
 * by Mike Melanson (melanson@pcisys.net)
 * for more information on the .fli/.flc file format and all of its many
 * variations, visit:
 *   http://www.compuphase.com/flic.htm
 *
 * This demuxer handles standard 0xAF11- and 0xAF12-type FLIs. It also
 * handles special FLIs from the PC game "Magic Carpet".
 */

#include "avformat.h"

#define FLIC_FILE_MAGIC_1 0xAF11
#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) */
Mike Melanson's avatar
Mike Melanson committed
40 41
#define FLIC_CHUNK_MAGIC_1 0xF1FA
#define FLIC_CHUNK_MAGIC_2 0xF5FA
Mike Melanson's avatar
Mike Melanson committed
42 43
#define FLIC_MC_SPEED 5  /* speed for Magic Carpet game FLIs */
#define FLIC_DEFAULT_SPEED 5  /* for FLIs that have 0 speed */
Mike Melanson's avatar
Mike Melanson committed
44 45 46 47 48 49

#define FLIC_HEADER_SIZE 128
#define FLIC_PREAMBLE_SIZE 6

typedef struct FlicDemuxContext {
    int video_stream_index;
Mike Melanson's avatar
Mike Melanson committed
50
    int frame_number;
Mike Melanson's avatar
Mike Melanson committed
51 52 53 54 55 56
} FlicDemuxContext;

static int flic_probe(AVProbeData *p)
{
    int magic_number;

57
    magic_number = AV_RL16(&p->buf[4]);
Mike Melanson's avatar
Mike Melanson committed
58
    if ((magic_number != FLIC_FILE_MAGIC_1) &&
59 60
        (magic_number != FLIC_FILE_MAGIC_2) &&
        (magic_number != FLIC_FILE_MAGIC_3))
Mike Melanson's avatar
Mike Melanson committed
61 62 63 64 65 66 67 68
        return 0;

    return AVPROBE_SCORE_MAX;
}

static int flic_read_header(AVFormatContext *s,
                            AVFormatParameters *ap)
{
69
    FlicDemuxContext *flic = s->priv_data;
70
    ByteIOContext *pb = s->pb;
Mike Melanson's avatar
Mike Melanson committed
71 72 73 74 75
    unsigned char header[FLIC_HEADER_SIZE];
    AVStream *st;
    int speed;
    int magic_number;

Mike Melanson's avatar
Mike Melanson committed
76
    flic->frame_number = 0;
Mike Melanson's avatar
Mike Melanson committed
77 78 79

    /* load the whole header and pull out the width and height */
    if (get_buffer(pb, header, FLIC_HEADER_SIZE) != FLIC_HEADER_SIZE)
80
        return AVERROR(EIO);
Mike Melanson's avatar
Mike Melanson committed
81

82 83
    magic_number = AV_RL16(&header[4]);
    speed = AV_RL32(&header[0x10]);
Mike Melanson's avatar
Mike Melanson committed
84 85
    if (speed == 0)
        speed = FLIC_DEFAULT_SPEED;
Mike Melanson's avatar
Mike Melanson committed
86 87 88 89

    /* initialize the decoder streams */
    st = av_new_stream(s, 0);
    if (!st)
90
        return AVERROR(ENOMEM);
Mike Melanson's avatar
Mike Melanson committed
91
    flic->video_stream_index = st->index;
92 93 94
    st->codec->codec_type = CODEC_TYPE_VIDEO;
    st->codec->codec_id = CODEC_ID_FLIC;
    st->codec->codec_tag = 0;  /* no fourcc */
95 96
    st->codec->width = AV_RL16(&header[0x08]);
    st->codec->height = AV_RL16(&header[0x0A]);
Mike Melanson's avatar
Mike Melanson committed
97

98 99 100 101 102 103 104 105
    if (!st->codec->width || !st->codec->height) {
        /* Ugly hack needed for the following sample: */
        /* http://samples.mplayerhq.hu/fli-flc/fli-bugs/specular.flc */
        av_log(s, AV_LOG_WARNING,
               "File with no specified width/height. Trying 640x480.\n");
        st->codec->width  = 640;
        st->codec->height = 480;
    }
Mike Melanson's avatar
Mike Melanson committed
106 107

    /* send over the whole 128-byte FLIC header */
108 109 110
    st->codec->extradata_size = FLIC_HEADER_SIZE;
    st->codec->extradata = av_malloc(FLIC_HEADER_SIZE);
    memcpy(st->codec->extradata, header, FLIC_HEADER_SIZE);
Mike Melanson's avatar
Mike Melanson committed
111 112 113 114

    /* Time to figure out the framerate: If there is a FLIC chunk magic
     * number at offset 0x10, assume this is from the Bullfrog game,
     * Magic Carpet. */
115
    if (AV_RL16(&header[0x10]) == FLIC_CHUNK_MAGIC_1) {
Mike Melanson's avatar
Mike Melanson committed
116

Mike Melanson's avatar
Mike Melanson committed
117
        av_set_pts_info(st, 64, FLIC_MC_SPEED, 70);
Mike Melanson's avatar
Mike Melanson committed
118 119 120 121 122

        /* rewind the stream since the first chunk is at offset 12 */
        url_fseek(pb, 12, SEEK_SET);

        /* send over abbreviated FLIC header chunk */
123 124 125 126
        av_free(st->codec->extradata);
        st->codec->extradata_size = 12;
        st->codec->extradata = av_malloc(12);
        memcpy(st->codec->extradata, header, 12);
Mike Melanson's avatar
Mike Melanson committed
127 128

    } else if (magic_number == FLIC_FILE_MAGIC_1) {
Mike Melanson's avatar
Mike Melanson committed
129
        av_set_pts_info(st, 64, speed, 70);
130 131
    } else if ((magic_number == FLIC_FILE_MAGIC_2) ||
               (magic_number == FLIC_FILE_MAGIC_3)) {
Mike Melanson's avatar
Mike Melanson committed
132
        av_set_pts_info(st, 64, speed, 1000);
133 134
    } else {
        av_log(s, AV_LOG_INFO, "Invalid or unsupported magic chunk in file\n");
Mike Melanson's avatar
Mike Melanson committed
135
        return AVERROR_INVALIDDATA;
136
    }
Mike Melanson's avatar
Mike Melanson committed
137 138 139 140 141 142 143

    return 0;
}

static int flic_read_packet(AVFormatContext *s,
                            AVPacket *pkt)
{
144
    FlicDemuxContext *flic = s->priv_data;
145
    ByteIOContext *pb = s->pb;
Mike Melanson's avatar
Mike Melanson committed
146 147 148 149 150 151 152 153 154 155
    int packet_read = 0;
    unsigned int size;
    int magic;
    int ret = 0;
    unsigned char preamble[FLIC_PREAMBLE_SIZE];

    while (!packet_read) {

        if ((ret = get_buffer(pb, preamble, FLIC_PREAMBLE_SIZE)) !=
            FLIC_PREAMBLE_SIZE) {
156
            ret = AVERROR(EIO);
Mike Melanson's avatar
Mike Melanson committed
157 158 159
            break;
        }

160 161
        size = AV_RL32(&preamble[0]);
        magic = AV_RL16(&preamble[4]);
Mike Melanson's avatar
Mike Melanson committed
162

163
        if (((magic == FLIC_CHUNK_MAGIC_1) || (magic == FLIC_CHUNK_MAGIC_2)) && size > FLIC_PREAMBLE_SIZE) {
Mike Melanson's avatar
Mike Melanson committed
164
            if (av_new_packet(pkt, size)) {
165
                ret = AVERROR(EIO);
Mike Melanson's avatar
Mike Melanson committed
166 167 168
                break;
            }
            pkt->stream_index = flic->video_stream_index;
Mike Melanson's avatar
Mike Melanson committed
169
            pkt->pts = flic->frame_number++;
170
            pkt->pos = url_ftell(pb);
Mike Melanson's avatar
Mike Melanson committed
171
            memcpy(pkt->data, preamble, FLIC_PREAMBLE_SIZE);
172
            ret = get_buffer(pb, pkt->data + FLIC_PREAMBLE_SIZE,
Mike Melanson's avatar
Mike Melanson committed
173 174 175
                size - FLIC_PREAMBLE_SIZE);
            if (ret != size - FLIC_PREAMBLE_SIZE) {
                av_free_packet(pkt);
176
                ret = AVERROR(EIO);
Mike Melanson's avatar
Mike Melanson committed
177 178 179 180 181 182 183 184 185 186 187 188 189
            }
            packet_read = 1;
        } else {
            /* not interested in this chunk */
            url_fseek(pb, size - 6, SEEK_CUR);
        }
    }

    return ret;
}

static int flic_read_close(AVFormatContext *s)
{
190
//    FlicDemuxContext *flic = s->priv_data;
Mike Melanson's avatar
Mike Melanson committed
191 192 193 194

    return 0;
}

195
AVInputFormat flic_demuxer = {
Mike Melanson's avatar
Mike Melanson committed
196
    "flic",
197
    "FLI/FLC/FLX animation format",
Mike Melanson's avatar
Mike Melanson committed
198 199 200 201 202 203
    sizeof(FlicDemuxContext),
    flic_probe,
    flic_read_header,
    flic_read_packet,
    flic_read_close,
};