]> git.sesse.net Git - ffmpeg/blobdiff - libavformat/flic.c
Combine deprecation guards where appropriate
[ffmpeg] / libavformat / flic.c
index bbf30d14356b152eb82eda89f6a37b8a51746ba0..85e4790f876263592411782eac9e98441b462d0a 100644 (file)
 /*
  * FLI/FLC Animation File Demuxer
- * Copyright (c) 2003 The ffmpeg Project
+ * Copyright (c) 2003 The FFmpeg project
  *
- * This library is free software; you can redistribute it and/or
+ * This file is part of Libav.
+ *
+ * Libav is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
- * version 2 of the License, or (at your option) any later version.
+ * version 2.1 of the License, or (at your option) any later version.
  *
- * This library is distributed in the hope that it will be useful,
+ * Libav is distributed in the hope that it will be useful,
  * 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
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ * License along with Libav; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
- * @file flic.c
+ * @file
  * 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".
+ * This demuxer handles standard 0xAF11- and 0xAF12-type FLIs. It also handles
+ * special FLIs from the PC games "Magic Carpet" and "X-COM: Terror from the Deep".
  */
 
+#include "libavutil/channel_layout.h"
+#include "libavutil/intreadwrite.h"
 #include "avformat.h"
+#include "internal.h"
 
 #define FLIC_FILE_MAGIC_1 0xAF11
 #define FLIC_FILE_MAGIC_2 0xAF12
+#define FLIC_FILE_MAGIC_3 0xAF44  /* Flic Type for Extended FLX Format which
+                                     originated in Dave's Targa Animator (DTA) */
 #define FLIC_CHUNK_MAGIC_1 0xF1FA
 #define FLIC_CHUNK_MAGIC_2 0xF5FA
-#define FLIC_MC_PTS_INC 6000  /* pts increment for Magic Carpet game FLIs */
-#define FLIC_DEFAULT_PTS_INC 6000  /* for FLIs that have 0 speed */
+#define FLIC_MC_SPEED 5  /* speed for Magic Carpet game FLIs */
+#define FLIC_DEFAULT_SPEED 5  /* for FLIs that have 0 speed */
+#define FLIC_TFTD_CHUNK_AUDIO 0xAAAA /* Audio chunk. Used in Terror from the Deep.
+                                        Has 10 B extra header not accounted for in the chunk header */
+#define FLIC_TFTD_SAMPLE_RATE 22050
 
 #define FLIC_HEADER_SIZE 128
 #define FLIC_PREAMBLE_SIZE 6
 
 typedef struct FlicDemuxContext {
-    int frame_pts_inc;
-    int64_t pts;
     int video_stream_index;
+    int audio_stream_index;
+    int frame_number;
 } FlicDemuxContext;
 
 static int flic_probe(AVProbeData *p)
 {
     int magic_number;
 
-    if (p->buf_size < 6)
+    if(p->buf_size < FLIC_HEADER_SIZE)
         return 0;
 
-    magic_number = LE_16(&p->buf[4]);
+    magic_number = AV_RL16(&p->buf[4]);
     if ((magic_number != FLIC_FILE_MAGIC_1) &&
-        (magic_number != FLIC_FILE_MAGIC_2))
+        (magic_number != FLIC_FILE_MAGIC_2) &&
+        (magic_number != FLIC_FILE_MAGIC_3))
+        return 0;
+
+    if(AV_RL16(&p->buf[0x10]) != FLIC_CHUNK_MAGIC_1){
+        if(AV_RL32(&p->buf[0x10]) > 2000)
+            return 0;
+    }
+
+    if(   AV_RL16(&p->buf[0x08]) > 4096
+       || AV_RL16(&p->buf[0x0A]) > 4096)
         return 0;
 
+
     return AVPROBE_SCORE_MAX;
 }
 
-static int flic_read_header(AVFormatContext *s,
-                            AVFormatParameters *ap)
+static int flic_read_header(AVFormatContext *s)
 {
-    FlicDemuxContext *flic = (FlicDemuxContext *)s->priv_data;
-    ByteIOContext *pb = &s->pb;
+    FlicDemuxContext *flic = s->priv_data;
+    AVIOContext *pb = s->pb;
     unsigned char header[FLIC_HEADER_SIZE];
-    AVStream *st;
+    AVStream *st, *ast;
     int speed;
     int magic_number;
+    unsigned char preamble[FLIC_PREAMBLE_SIZE];
 
-    flic->pts = 0;
+    flic->frame_number = 0;
 
     /* load the whole header and pull out the width and height */
-    if (get_buffer(pb, header, FLIC_HEADER_SIZE) != FLIC_HEADER_SIZE)
-        return -EIO;
+    if (avio_read(pb, header, FLIC_HEADER_SIZE) != FLIC_HEADER_SIZE)
+        return AVERROR(EIO);
 
-    magic_number = LE_16(&header[4]);
-    speed = LE_32(&header[0x10]);
+    magic_number = AV_RL16(&header[4]);
+    speed = AV_RL32(&header[0x10]);
+    if (speed == 0)
+        speed = FLIC_DEFAULT_SPEED;
 
     /* initialize the decoder streams */
-    st = av_new_stream(s, 0);
+    st = avformat_new_stream(s, NULL);
     if (!st)
-        return AVERROR_NOMEM;
+        return AVERROR(ENOMEM);
     flic->video_stream_index = st->index;
-    st->codec.codec_type = CODEC_TYPE_VIDEO;
-    st->codec.codec_id = CODEC_ID_FLIC;
-    st->codec.codec_tag = 0;  /* no fourcc */
-    st->codec.width = LE_16(&header[0x08]);
-    st->codec.height = LE_16(&header[0x0A]);
-
-    if (!st->codec.width || !st->codec.height)
-        return AVERROR_INVALIDDATA;
+    st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
+    st->codecpar->codec_id = AV_CODEC_ID_FLIC;
+    st->codecpar->codec_tag = 0;  /* no fourcc */
+    st->codecpar->width = AV_RL16(&header[0x08]);
+    st->codecpar->height = AV_RL16(&header[0x0A]);
+
+    if (!st->codecpar->width || !st->codecpar->height) {
+        /* Ugly hack needed for the following sample: */
+        /* http://samples.libav.org/fli-flc/fli-bugs/specular.flc */
+        av_log(s, AV_LOG_WARNING,
+               "File with no specified width/height. Trying 640x480.\n");
+        st->codecpar->width  = 640;
+        st->codecpar->height = 480;
+    }
 
     /* send over the whole 128-byte FLIC header */
-    st->codec.extradata_size = FLIC_HEADER_SIZE;
-    st->codec.extradata = av_malloc(FLIC_HEADER_SIZE);
-    memcpy(st->codec.extradata, header, FLIC_HEADER_SIZE);
-
-    av_set_pts_info(st, 33, 1, 90000);
-
-    /* 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. */
-    if (LE_16(&header[0x10]) == FLIC_CHUNK_MAGIC_1) {
+    st->codecpar->extradata_size = FLIC_HEADER_SIZE;
+    st->codecpar->extradata = av_malloc(FLIC_HEADER_SIZE);
+    memcpy(st->codecpar->extradata, header, FLIC_HEADER_SIZE);
+
+    /* peek at the preamble to detect TFTD videos - they seem to always start with an audio chunk */
+    if (avio_read(pb, preamble, FLIC_PREAMBLE_SIZE) != FLIC_PREAMBLE_SIZE) {
+        av_log(s, AV_LOG_ERROR, "Failed to peek at preamble\n");
+        return AVERROR(EIO);
+    }
 
-        flic->frame_pts_inc = FLIC_MC_PTS_INC;
+    avio_seek(pb, -FLIC_PREAMBLE_SIZE, SEEK_CUR);
+
+    /* Time to figure out the framerate:
+     * If the first preamble's magic number is 0xAAAA then this file is from
+     * X-COM: Terror from the Deep. If on the other hand there is a FLIC chunk
+     * magic number at offset 0x10 assume this file is from Magic Carpet instead.
+     * If neither of the above is true then this is a normal FLIC file.
+     */
+    if (AV_RL16(&preamble[4]) == FLIC_TFTD_CHUNK_AUDIO) {
+        /* TFTD videos have an extra 22050 Hz 8-bit mono audio stream */
+        ast = avformat_new_stream(s, NULL);
+        if (!ast)
+            return AVERROR(ENOMEM);
+
+        flic->audio_stream_index = ast->index;
+
+        /* all audio frames are the same size, so use the size of the first chunk for block_align */
+        ast->codecpar->block_align = AV_RL32(&preamble[0]);
+        ast->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
+        ast->codecpar->codec_id = AV_CODEC_ID_PCM_U8;
+        ast->codecpar->codec_tag = 0;
+        ast->codecpar->sample_rate = FLIC_TFTD_SAMPLE_RATE;
+        ast->codecpar->channels = 1;
+        ast->codecpar->format   = AV_SAMPLE_FMT_U8;
+        ast->codecpar->bit_rate = st->codecpar->sample_rate * 8;
+        ast->codecpar->bits_per_coded_sample = 8;
+        ast->codecpar->channel_layout = AV_CH_LAYOUT_MONO;
+        ast->codecpar->extradata_size = 0;
+
+        /* Since the header information is incorrect we have to figure out the
+         * framerate using block_align and the fact that the audio is 22050 Hz.
+         * We usually have two cases: 2205 -> 10 fps and 1470 -> 15 fps */
+        avpriv_set_pts_info(st, 64, ast->codecpar->block_align, FLIC_TFTD_SAMPLE_RATE);
+        avpriv_set_pts_info(ast, 64, 1, FLIC_TFTD_SAMPLE_RATE);
+    } else if (AV_RL16(&header[0x10]) == FLIC_CHUNK_MAGIC_1) {
+        avpriv_set_pts_info(st, 64, FLIC_MC_SPEED, 70);
 
         /* rewind the stream since the first chunk is at offset 12 */
-        url_fseek(pb, 12, SEEK_SET);
+        avio_seek(pb, 12, SEEK_SET);
 
         /* send over abbreviated FLIC header chunk */
-        av_free(st->codec.extradata);
-        st->codec.extradata_size = 12;
-        st->codec.extradata = av_malloc(12);
-        memcpy(st->codec.extradata, header, 12);
+        av_free(st->codecpar->extradata);
+        st->codecpar->extradata_size = 12;
+        st->codecpar->extradata = av_malloc(12);
+        memcpy(st->codecpar->extradata, header, 12);
 
     } else if (magic_number == FLIC_FILE_MAGIC_1) {
-        /*
-         * in this case, the speed (n) is number of 1/70s ticks between frames:
-         *
-         *    pts        n * frame #
-         *  --------  =  -----------  => pts = n * (90000/70) * frame #
-         *   90000           70
-         *
-         *  therefore, the frame pts increment = n * 1285.7
-         */
-        flic->frame_pts_inc = speed * 1285.7;
-    } else if (magic_number == FLIC_FILE_MAGIC_2) {
-        /*
-         * in this case, the speed (n) is number of milliseconds between frames:
-         *
-         *    pts        n * frame #
-         *  --------  =  -----------  => pts = n * 90 * frame #
-         *   90000          1000
-         *
-         *  therefore, the frame pts increment = n * 90
-         */
-        flic->frame_pts_inc = speed * 90;
-    } else
+        avpriv_set_pts_info(st, 64, speed, 70);
+    } else if ((magic_number == FLIC_FILE_MAGIC_2) ||
+               (magic_number == FLIC_FILE_MAGIC_3)) {
+        avpriv_set_pts_info(st, 64, speed, 1000);
+    } else {
+        av_log(s, AV_LOG_INFO, "Invalid or unsupported magic chunk in file\n");
         return AVERROR_INVALIDDATA;
-
-    if (flic->frame_pts_inc == 0)
-        flic->frame_pts_inc = FLIC_DEFAULT_PTS_INC;
+    }
 
     return 0;
 }
@@ -152,8 +197,8 @@ static int flic_read_header(AVFormatContext *s,
 static int flic_read_packet(AVFormatContext *s,
                             AVPacket *pkt)
 {
-    FlicDemuxContext *flic = (FlicDemuxContext *)s->priv_data;
-    ByteIOContext *pb = &s->pb;
+    FlicDemuxContext *flic = s->priv_data;
+    AVIOContext *pb = s->pb;
     int packet_read = 0;
     unsigned int size;
     int magic;
@@ -162,59 +207,64 @@ static int flic_read_packet(AVFormatContext *s,
 
     while (!packet_read) {
 
-        if ((ret = get_buffer(pb, preamble, FLIC_PREAMBLE_SIZE)) !=
+        if ((ret = avio_read(pb, preamble, FLIC_PREAMBLE_SIZE)) !=
             FLIC_PREAMBLE_SIZE) {
-            ret = -EIO;
+            ret = AVERROR(EIO);
             break;
         }
 
-        size = LE_32(&preamble[0]);
-        magic = LE_16(&preamble[4]);
+        size = AV_RL32(&preamble[0]);
+        magic = AV_RL16(&preamble[4]);
 
-        if ((magic == FLIC_CHUNK_MAGIC_1) || (magic == FLIC_CHUNK_MAGIC_2)) {
+        if (((magic == FLIC_CHUNK_MAGIC_1) || (magic == FLIC_CHUNK_MAGIC_2)) && size > FLIC_PREAMBLE_SIZE) {
             if (av_new_packet(pkt, size)) {
-                ret = -EIO;
+                ret = AVERROR(EIO);
                 break;
             }
             pkt->stream_index = flic->video_stream_index;
-            pkt->pts = flic->pts;
+            pkt->pts = flic->frame_number++;
+            pkt->pos = avio_tell(pb);
             memcpy(pkt->data, preamble, FLIC_PREAMBLE_SIZE);
-            ret = get_buffer(pb, pkt->data + FLIC_PREAMBLE_SIZE, 
+            ret = avio_read(pb, pkt->data + FLIC_PREAMBLE_SIZE,
                 size - FLIC_PREAMBLE_SIZE);
             if (ret != size - FLIC_PREAMBLE_SIZE) {
-                av_free_packet(pkt);
-                ret = -EIO;
+                av_packet_unref(pkt);
+                ret = AVERROR(EIO);
             }
-            flic->pts += flic->frame_pts_inc;
+            packet_read = 1;
+        } else if (magic == FLIC_TFTD_CHUNK_AUDIO) {
+            if (av_new_packet(pkt, size)) {
+                ret = AVERROR(EIO);
+                break;
+            }
+
+            /* skip useless 10B sub-header (yes, it's not accounted for in the chunk header) */
+            avio_skip(pb, 10);
+
+            pkt->stream_index = flic->audio_stream_index;
+            pkt->pos = avio_tell(pb);
+            ret = avio_read(pb, pkt->data, size);
+
+            if (ret != size) {
+                av_packet_unref(pkt);
+                ret = AVERROR(EIO);
+            }
+
             packet_read = 1;
         } else {
             /* not interested in this chunk */
-            url_fseek(pb, size - 6, SEEK_CUR);
+            avio_skip(pb, size - 6);
         }
     }
 
     return ret;
 }
 
-static int flic_read_close(AVFormatContext *s)
-{
-//    FlicDemuxContext *flic = (FlicDemuxContext *)s->priv_data;
-
-    return 0;
-}
-
-static AVInputFormat flic_iformat = {
-    "flic",
-    "FLI/FLC animation format",
-    sizeof(FlicDemuxContext),
-    flic_probe,
-    flic_read_header,
-    flic_read_packet,
-    flic_read_close,
+AVInputFormat ff_flic_demuxer = {
+    .name           = "flic",
+    .long_name      = NULL_IF_CONFIG_SMALL("FLI/FLC/FLX animation"),
+    .priv_data_size = sizeof(FlicDemuxContext),
+    .read_probe     = flic_probe,
+    .read_header    = flic_read_header,
+    .read_packet    = flic_read_packet,
 };
-
-int flic_init(void)
-{
-    av_register_input_format(&flic_iformat);
-    return 0;
-}