1/*
2 * Bink demuxer
3 * Copyright (c) 2008-2010 Peter Ross (pross@xvid.org)
4 * Copyright (c) 2009 Daniel Verkamp (daniel@drv.nu)
5 *
6 * This file is part of FFmpeg.
7 *
8 * FFmpeg is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
12 *
13 * FFmpeg is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 */
22
23/**
24 * @file
25 * Bink demuxer
26 *
27 * Technical details here:
28 *  http://wiki.multimedia.cx/index.php?title=Bink_Container
29 */
30
31#include <inttypes.h>
32
33#include "libavutil/channel_layout.h"
34#include "libavutil/intreadwrite.h"
35#include "avformat.h"
36#include "internal.h"
37
38enum BinkAudFlags {
39    BINK_AUD_16BITS = 0x4000, ///< prefer 16-bit output
40    BINK_AUD_STEREO = 0x2000,
41    BINK_AUD_USEDCT = 0x1000,
42};
43
44#define BINK_EXTRADATA_SIZE     1
45#define BINK_MAX_AUDIO_TRACKS   256
46#define BINK_MAX_WIDTH          7680
47#define BINK_MAX_HEIGHT         4800
48
49typedef struct {
50    uint32_t file_size;
51
52    uint32_t num_audio_tracks;
53    int current_track;      ///< audio track to return in next packet
54    int64_t video_pts;
55    int64_t audio_pts[BINK_MAX_AUDIO_TRACKS];
56
57    uint32_t remain_packet_size;
58} BinkDemuxContext;
59
60static int probe(AVProbeData *p)
61{
62    const uint8_t *b = p->buf;
63
64    if (((b[0] == 'B' && b[1] == 'I' && b[2] == 'K' &&
65         (b[3] == 'b' || b[3] == 'f' || b[3] == 'g' || b[3] == 'h' || b[3] == 'i')) ||
66         (b[0] == 'K' && b[1] == 'B' && b[2] == '2' && /* Bink 2 */
67         (b[3] == 'a' || b[3] == 'd' || b[3] == 'f' || b[3] == 'g'))) &&
68        AV_RL32(b+8) > 0 &&  // num_frames
69        AV_RL32(b+20) > 0 && AV_RL32(b+20) <= BINK_MAX_WIDTH &&
70        AV_RL32(b+24) > 0 && AV_RL32(b+24) <= BINK_MAX_HEIGHT &&
71        AV_RL32(b+28) > 0 && AV_RL32(b+32) > 0)  // fps num,den
72        return AVPROBE_SCORE_MAX;
73    return 0;
74}
75
76static int read_header(AVFormatContext *s)
77{
78    BinkDemuxContext *bink = s->priv_data;
79    AVIOContext *pb = s->pb;
80    uint32_t fps_num, fps_den;
81    AVStream *vst, *ast;
82    unsigned int i;
83    uint32_t pos, next_pos;
84    uint16_t flags;
85    int keyframe;
86    int ret;
87
88    vst = avformat_new_stream(s, NULL);
89    if (!vst)
90        return AVERROR(ENOMEM);
91
92    vst->codec->codec_tag = avio_rl32(pb);
93
94    bink->file_size = avio_rl32(pb) + 8;
95    vst->duration   = avio_rl32(pb);
96
97    if (vst->duration > 1000000) {
98        av_log(s, AV_LOG_ERROR, "invalid header: more than 1000000 frames\n");
99        return AVERROR(EIO);
100    }
101
102    if (avio_rl32(pb) > bink->file_size) {
103        av_log(s, AV_LOG_ERROR,
104               "invalid header: largest frame size greater than file size\n");
105        return AVERROR(EIO);
106    }
107
108    avio_skip(pb, 4);
109
110    vst->codec->width  = avio_rl32(pb);
111    vst->codec->height = avio_rl32(pb);
112
113    fps_num = avio_rl32(pb);
114    fps_den = avio_rl32(pb);
115    if (fps_num == 0 || fps_den == 0) {
116        av_log(s, AV_LOG_ERROR,
117               "invalid header: invalid fps (%"PRIu32"/%"PRIu32")\n",
118               fps_num, fps_den);
119        return AVERROR(EIO);
120    }
121    avpriv_set_pts_info(vst, 64, fps_den, fps_num);
122    vst->avg_frame_rate = av_inv_q(vst->time_base);
123
124    vst->codec->codec_type = AVMEDIA_TYPE_VIDEO;
125    vst->codec->codec_id   = AV_CODEC_ID_BINKVIDEO;
126
127    if ((vst->codec->codec_tag & 0xFFFFFF) == MKTAG('K', 'B', '2', 0)) {
128        av_log(s, AV_LOG_WARNING, "Bink 2 video is not implemented\n");
129        vst->codec->codec_id = AV_CODEC_ID_NONE;
130    }
131
132    if (ff_get_extradata(vst->codec, pb, 4) < 0)
133        return AVERROR(ENOMEM);
134
135    bink->num_audio_tracks = avio_rl32(pb);
136
137    if (bink->num_audio_tracks > BINK_MAX_AUDIO_TRACKS) {
138        av_log(s, AV_LOG_ERROR,
139               "invalid header: more than "AV_STRINGIFY(BINK_MAX_AUDIO_TRACKS)" audio tracks (%"PRIu32")\n",
140               bink->num_audio_tracks);
141        return AVERROR(EIO);
142    }
143
144    if (bink->num_audio_tracks) {
145        avio_skip(pb, 4 * bink->num_audio_tracks);
146
147        for (i = 0; i < bink->num_audio_tracks; i++) {
148            ast = avformat_new_stream(s, NULL);
149            if (!ast)
150                return AVERROR(ENOMEM);
151            ast->codec->codec_type  = AVMEDIA_TYPE_AUDIO;
152            ast->codec->codec_tag   = 0;
153            ast->codec->sample_rate = avio_rl16(pb);
154            avpriv_set_pts_info(ast, 64, 1, ast->codec->sample_rate);
155            flags = avio_rl16(pb);
156            ast->codec->codec_id = flags & BINK_AUD_USEDCT ?
157                                   AV_CODEC_ID_BINKAUDIO_DCT : AV_CODEC_ID_BINKAUDIO_RDFT;
158            if (flags & BINK_AUD_STEREO) {
159                ast->codec->channels       = 2;
160                ast->codec->channel_layout = AV_CH_LAYOUT_STEREO;
161            } else {
162                ast->codec->channels       = 1;
163                ast->codec->channel_layout = AV_CH_LAYOUT_MONO;
164            }
165            if (ff_alloc_extradata(ast->codec, 4))
166                return AVERROR(ENOMEM);
167            AV_WL32(ast->codec->extradata, vst->codec->codec_tag);
168        }
169
170        for (i = 0; i < bink->num_audio_tracks; i++)
171            s->streams[i + 1]->id = avio_rl32(pb);
172    }
173
174    /* frame index table */
175    next_pos = avio_rl32(pb);
176    for (i = 0; i < vst->duration; i++) {
177        pos = next_pos;
178        if (i == vst->duration - 1) {
179            next_pos = bink->file_size;
180            keyframe = 0;
181        } else {
182            next_pos = avio_rl32(pb);
183            keyframe = pos & 1;
184        }
185        pos &= ~1;
186        next_pos &= ~1;
187
188        if (next_pos <= pos) {
189            av_log(s, AV_LOG_ERROR, "invalid frame index table\n");
190            return AVERROR(EIO);
191        }
192        if ((ret = av_add_index_entry(vst, pos, i, next_pos - pos, 0,
193                                      keyframe ? AVINDEX_KEYFRAME : 0)) < 0)
194            return ret;
195    }
196
197    avio_seek(pb, vst->index_entries[0].pos, SEEK_SET);
198
199    bink->current_track = -1;
200    return 0;
201}
202
203static int read_packet(AVFormatContext *s, AVPacket *pkt)
204{
205    BinkDemuxContext *bink = s->priv_data;
206    AVIOContext *pb = s->pb;
207    int ret;
208
209    if (bink->current_track < 0) {
210        int index_entry;
211        AVStream *st = s->streams[0]; // stream 0 is video stream with index
212
213        if (bink->video_pts >= st->duration)
214            return AVERROR_EOF;
215
216        index_entry = av_index_search_timestamp(st, bink->video_pts,
217                                                AVSEEK_FLAG_ANY);
218        if (index_entry < 0) {
219            av_log(s, AV_LOG_ERROR,
220                   "could not find index entry for frame %"PRId64"\n",
221                   bink->video_pts);
222            return AVERROR(EIO);
223        }
224
225        bink->remain_packet_size = st->index_entries[index_entry].size;
226        bink->current_track = 0;
227    }
228
229    while (bink->current_track < bink->num_audio_tracks) {
230        uint32_t audio_size = avio_rl32(pb);
231        if (audio_size > bink->remain_packet_size - 4) {
232            av_log(s, AV_LOG_ERROR,
233                   "frame %"PRId64": audio size in header (%"PRIu32") > size of packet left (%"PRIu32")\n",
234                   bink->video_pts, audio_size, bink->remain_packet_size);
235            return AVERROR(EIO);
236        }
237        bink->remain_packet_size -= 4 + audio_size;
238        bink->current_track++;
239        if (audio_size >= 4) {
240            /* get one audio packet per track */
241            if ((ret = av_get_packet(pb, pkt, audio_size)) < 0)
242                return ret;
243            pkt->stream_index = bink->current_track;
244            pkt->pts = bink->audio_pts[bink->current_track - 1];
245
246            /* Each audio packet reports the number of decompressed samples
247               (in bytes). We use this value to calcuate the audio PTS */
248            if (pkt->size >= 4)
249                bink->audio_pts[bink->current_track -1] +=
250                    AV_RL32(pkt->data) / (2 * s->streams[bink->current_track]->codec->channels);
251            return 0;
252        } else {
253            avio_skip(pb, audio_size);
254        }
255    }
256
257    /* get video packet */
258    if ((ret = av_get_packet(pb, pkt, bink->remain_packet_size)) < 0)
259        return ret;
260    pkt->stream_index = 0;
261    pkt->pts = bink->video_pts++;
262    pkt->flags |= AV_PKT_FLAG_KEY;
263
264    /* -1 instructs the next call to read_packet() to read the next frame */
265    bink->current_track = -1;
266
267    return 0;
268}
269
270static int read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
271{
272    BinkDemuxContext *bink = s->priv_data;
273    AVStream *vst = s->streams[0];
274
275    if (!s->pb->seekable)
276        return -1;
277
278    /* seek to the first frame */
279    if (avio_seek(s->pb, vst->index_entries[0].pos, SEEK_SET) < 0)
280        return -1;
281
282    bink->video_pts = 0;
283    memset(bink->audio_pts, 0, sizeof(bink->audio_pts));
284    bink->current_track = -1;
285    return 0;
286}
287
288AVInputFormat ff_bink_demuxer = {
289    .name           = "bink",
290    .long_name      = NULL_IF_CONFIG_SMALL("Bink"),
291    .priv_data_size = sizeof(BinkDemuxContext),
292    .read_probe     = probe,
293    .read_header    = read_header,
294    .read_packet    = read_packet,
295    .read_seek      = read_seek,
296    .flags          = AVFMT_SHOW_IDS,
297};
298