LCOV - code coverage report
Current view: top level - libavformat - flic.c (source / functions) Hit Total Coverage
Test: coverage.info Lines: 67 114 58.8 %
Date: 2017-12-15 11:05:35 Functions: 3 3 100.0 %

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

Generated by: LCOV version 1.13