Bink demuxer

Originally committed as revision 21569 to svn://svn.ffmpeg.org/ffmpeg/trunk

Changelog

@@ -51,6 +51,7 @@ version <next>:
 - SIPR decoder
 - Adobe Filmstrip muxer and demuxer
 - RTP depacketization of H.263
+- Bink demuxer
 
 
 

doc/general.texi

@@ -58,6 +58,8 @@ library:
     @tab Audio and video format used in some games by Beam Software.
 @item Bethesda Softworks VID    @tab   @tab X
     @tab Used in some games from Bethesda Softworks.
+@item Bink                      @tab   @tab X
+    @tab Multimedia format used by many games.
 @item Brute Force & Ignorance   @tab   @tab X
     @tab Used in the game Flash Traffic: City of Angels.
 @item Interplay C93             @tab   @tab X

libavformat/Makefile

@@ -42,6 +42,7 @@ OBJS-$(CONFIG_AVM2_MUXER)                += swfenc.o
 OBJS-$(CONFIG_AVS_DEMUXER)               += avs.o vocdec.o voc.o
 OBJS-$(CONFIG_BETHSOFTVID_DEMUXER)       += bethsoftvid.o
 OBJS-$(CONFIG_BFI_DEMUXER)               += bfi.o
+OBJS-$(CONFIG_BINK_DEMUXER)              += bink.o
 OBJS-$(CONFIG_C93_DEMUXER)               += c93.o vocdec.o voc.o
 OBJS-$(CONFIG_CAF_DEMUXER)               += cafdec.o caf.o mov.o riff.o isom.o
 OBJS-$(CONFIG_CAVSVIDEO_DEMUXER)         += raw.o

libavformat/allformats.c

@@ -66,6 +66,7 @@ void av_register_all(void)
     REGISTER_DEMUXER  (AVS, avs);
     REGISTER_DEMUXER  (BETHSOFTVID, bethsoftvid);
     REGISTER_DEMUXER  (BFI, bfi);
+    REGISTER_DEMUXER  (BINK, bink);
     REGISTER_DEMUXER  (C93, c93);
     REGISTER_DEMUXER  (CAF, caf);
     REGISTER_DEMUXER  (CAVSVIDEO, cavsvideo);

libavformat/bink.c

+/*
+ * Bink demuxer
+ * Copyright (c) 2008-2010 Peter Ross (pross@xvid.org)
+ * Copyright (c) 2009 Daniel Verkamp (daniel@drv.nu)
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg 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.1 of the License, or (at your option) any later version.
+ *
+ * FFmpeg 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 FFmpeg; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+/**
+ * @file libavformat/bink.c
+ * Bink demuxer
+ *
+ * Technical details here:
+ *  http://wiki.multimedia.cx/index.php?title=Bink_Container
+ */
+
+#include "libavutil/intreadwrite.h"
+#include "avformat.h"
+
+enum BinkAudFlags {
+    BINK_AUD_16BITS = 0x4000, ///< prefer 16-bit output
+    BINK_AUD_STEREO = 0x2000,
+    BINK_AUD_USEDCT = 0x1000,
+};
+
+#define BINK_EXTRADATA_SIZE     1
+#define BINK_MAX_AUDIO_TRACKS   256
+#define BINK_MAX_WIDTH          7680
+#define BINK_MAX_HEIGHT         4800
+
+typedef struct {
+    uint32_t file_size;
+    uint32_t total_frames;
+
+    uint32_t num_audio_tracks;
+    int current_track;      ///< audio track to return in next packet
+    int64_t video_pts;
+    int64_t audio_pts[BINK_MAX_AUDIO_TRACKS];
+
+    uint32_t remain_packet_size;
+} BinkDemuxContext;
+
+static int probe(AVProbeData *p)
+{
+    const uint8_t *b = p->buf;
+
+    if ( b[0] == 'B' && b[1] == 'I' && b[2] == 'K' &&
+        (b[3] == 'b' || b[3] == 'f' || b[3] == 'g' || b[3] == 'h' || b[3] == 'i') &&
+        AV_RL32(b+8) > 0 &&  // num_frames
+        AV_RL32(b+20) > 0 && AV_RL32(b+20) <= BINK_MAX_WIDTH &&
+        AV_RL32(b+24) > 0 && AV_RL32(b+24) <= BINK_MAX_HEIGHT &&
+        AV_RL32(b+28) > 0 && AV_RL32(b+32) > 0)  // fps num,den
+        return AVPROBE_SCORE_MAX;
+    return 0;
+}
+
+static int read_header(AVFormatContext *s, AVFormatParameters *ap)
+{
+    BinkDemuxContext *bink = s->priv_data;
+    ByteIOContext *pb = s->pb;
+    uint32_t fps_num, fps_den;
+    AVStream *vst, *ast;
+    unsigned int i;
+    uint32_t pos, prev_pos;
+    uint16_t flags;
+    int keyframe;
+
+    vst = av_new_stream(s, 0);
+    if (!vst)
+        return AVERROR(ENOMEM);
+
+    vst->codec->codec_tag = get_le32(pb);
+
+    bink->file_size = get_le32(pb) + 8;
+    bink->total_frames = get_le32(pb);
+
+    if (bink->total_frames > 1000000) {
+        av_log(s, AV_LOG_ERROR, "invalid header: more than 1000000 frames\n");
+        return AVERROR(EIO);
+    }
+
+    if (get_le32(pb) > bink->file_size) {
+        av_log(s, AV_LOG_ERROR,
+               "invalid header: largest frame size greater than file size\n");
+        return AVERROR(EIO);
+    }
+
+    url_fskip(pb, 4);
+
+    vst->codec->width  = get_le32(pb);
+    vst->codec->height = get_le32(pb);
+
+    fps_num = get_le32(pb);
+    fps_den = get_le32(pb);
+    if (fps_num == 0 || fps_den == 0) {
+        av_log(s, AV_LOG_ERROR, "invalid header: invalid fps (%d/%d)\n", fps_num, fps_den);
+        return AVERROR(EIO);
+    }
+    av_set_pts_info(vst, 64, fps_den, fps_num);
+
+    url_fskip(pb, 4);
+
+    vst->codec->codec_type = CODEC_TYPE_VIDEO;
+    vst->codec->codec_id   = 0; /* FIXME: CODEC_ID_BINKVIDEO */
+    bink->num_audio_tracks = get_le32(pb);
+
+    if (bink->num_audio_tracks > BINK_MAX_AUDIO_TRACKS) {
+        av_log(s, AV_LOG_ERROR,
+               "invalid header: more than "AV_STRINGIFY(BINK_MAX_AUDIO_TRACKS)" audio tracks (%d)\n",
+               bink->num_audio_tracks);
+        return AVERROR(EIO);
+    }
+
+    if (bink->num_audio_tracks) {
+        url_fskip(pb, 4 * bink->num_audio_tracks);
+
+        for (i = 0; i < bink->num_audio_tracks; i++) {
+            ast = av_new_stream(s, 1);
+            if (!ast)
+                return AVERROR(ENOMEM);
+            ast->codec->codec_type  = CODEC_TYPE_AUDIO;
+            ast->codec->codec_tag   = 0;
+            ast->codec->sample_rate = get_le16(pb);
+            av_set_pts_info(ast, 64, 1, ast->codec->sample_rate);
+            flags = get_le16(pb);
+            ast->codec->codec_id = flags & BINK_AUD_USEDCT ?
+                                   CODEC_ID_BINKAUDIO_DCT : CODEC_ID_BINKAUDIO_RDFT;
+            ast->codec->channels = flags & BINK_AUD_STEREO ? 2 : 1;
+        }
+
+        url_fskip(pb, 4 * bink->num_audio_tracks);
+    }
+
+    /* frame index table */
+    pos = get_le32(pb) & ~1;
+    for (i = 0; i < bink->total_frames; i++) {
+        prev_pos = pos;
+        if (i == bink->total_frames - 1) {
+            pos = bink->file_size;
+            keyframe = 0;
+        } else {
+            pos = get_le32(pb);
+            keyframe = pos & 1;
+            pos &= ~1;
+        }
+        if (pos <= prev_pos) {
+            av_log(s, AV_LOG_ERROR, "invalid frame index table\n");
+            return AVERROR(EIO);
+        }
+        av_add_index_entry(vst, pos, i, pos - prev_pos, 0,
+                           keyframe ? AVINDEX_KEYFRAME : 0);
+    }
+
+    url_fskip(pb, 4);
+
+    bink->current_track = -1;
+    return 0;
+}
+
+static int read_packet(AVFormatContext *s, AVPacket *pkt)
+{
+    BinkDemuxContext *bink = s->priv_data;
+    ByteIOContext *pb = s->pb;
+    int ret;
+
+    if (bink->current_track < 0) {
+        int index_entry;
+        AVStream *st = s->streams[0]; // stream 0 is video stream with index
+
+        if (bink->video_pts >= bink->total_frames)
+            return AVERROR(EIO);
+
+        index_entry = av_index_search_timestamp(st, bink->video_pts,
+                                                AVSEEK_FLAG_ANY);
+        if (index_entry < 0) {
+            av_log(s, AV_LOG_ERROR,
+                   "could not find index entry for frame %"PRId64"\n",
+                   bink->video_pts);
+            return AVERROR(EIO);
+        }
+
+        bink->remain_packet_size = st->index_entries[index_entry].size;
+        bink->current_track = 0;
+    }
+
+    if (bink->current_track < bink->num_audio_tracks) {
+        uint32_t audio_size = get_le32(pb);
+        if (audio_size > bink->remain_packet_size - 4) {
+            av_log(s, AV_LOG_ERROR,
+                   "frame %"PRId64": audio size in header (%u) > size of packet left (%u)\n",
+                   bink->video_pts, audio_size, bink->remain_packet_size);
+            return AVERROR(EIO);
+        }
+        bink->remain_packet_size -= 4 + audio_size;
+        bink->current_track++;
+        if (audio_size > 0) {
+            /* Each audio packet reports the number of decompressed samples
+               (in bytes). We use this value to calcuate the audio PTS */
+            int reported_size = get_le32(pb) / (2 * s->streams[bink->current_track]->codec->channels);
+            url_fseek(pb, -4, SEEK_CUR);
+
+            /* get one audio packet per track */
+            if ((ret = av_get_packet(pb, pkt, audio_size))
+                                           != audio_size)
+                return ret;
+            pkt->stream_index = bink->current_track;
+            pkt->pts = bink->audio_pts[bink->current_track - 1] += reported_size;
+            return 0;
+        }
+    }
+
+    /* get video packet */
+    if ((ret = av_get_packet(pb, pkt, bink->remain_packet_size))
+                                   != bink->remain_packet_size)
+        return ret;
+    pkt->stream_index = 0;
+    pkt->pts = bink->video_pts++;
+    pkt->flags |= PKT_FLAG_KEY;
+
+    /* -1 instructs the next call to read_packet() to read the next frame */
+    bink->current_track = -1;
+
+    return 0;
+}
+
+AVInputFormat bink_demuxer = {
+    "bink",
+    NULL_IF_CONFIG_SMALL("Bink"),
+    sizeof(BinkDemuxContext),
+    probe,
+    read_header,
+    read_packet,
+};