avformat: add TTML muxer
[ffmpeg.git] / libavformat / bink.c
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
38 enum 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 #define SMUSH_BLOCK_SIZE        512
49
50 typedef struct BinkDemuxContext {
51     uint32_t file_size;
52
53     uint32_t num_audio_tracks;
54     int current_track;      ///< audio track to return in next packet
55     int64_t video_pts;
56     int64_t audio_pts[BINK_MAX_AUDIO_TRACKS];
57
58     uint32_t remain_packet_size;
59     int flags;
60     int smush_size;
61 } BinkDemuxContext;
62
63 static int probe(const AVProbeData *p)
64 {
65     const uint8_t *b = p->buf;
66     int smush = AV_RN32(p->buf) == AV_RN32("SMUS");
67
68     do {
69         if (((b[0] == 'B' && b[1] == 'I' && b[2] == 'K' && /* Bink 1 */
70              (b[3] == 'b' || b[3] == 'f' || b[3] == 'g' || b[3] == 'h' || b[3] == 'i' ||
71               b[3] == 'k')) ||
72              (b[0] == 'K' && b[1] == 'B' && b[2] == '2' && /* Bink 2 */
73              (b[3] == 'a' || b[3] == 'd' || b[3] == 'f' || b[3] == 'g' || b[3] == 'h' ||
74               b[3] == 'i' || b[3] == 'j' || b[3] == 'k'))) &&
75             AV_RL32(b+8) > 0 &&  // num_frames
76             AV_RL32(b+20) > 0 && AV_RL32(b+20) <= BINK_MAX_WIDTH &&
77             AV_RL32(b+24) > 0 && AV_RL32(b+24) <= BINK_MAX_HEIGHT &&
78             AV_RL32(b+28) > 0 && AV_RL32(b+32) > 0)  // fps num,den
79             return AVPROBE_SCORE_MAX;
80         b += SMUSH_BLOCK_SIZE;
81     } while (smush && b < p->buf + p->buf_size - 32);
82     return 0;
83 }
84
85 static int read_header(AVFormatContext *s)
86 {
87     BinkDemuxContext *bink = s->priv_data;
88     AVIOContext *pb = s->pb;
89     uint32_t fps_num, fps_den;
90     AVStream *vst, *ast;
91     unsigned int i;
92     uint32_t pos, next_pos;
93     uint16_t flags;
94     int next_keyframe = 1;
95     int keyframe;
96     int ret;
97     uint32_t signature;
98     uint8_t revision;
99
100     vst = avformat_new_stream(s, NULL);
101     if (!vst)
102         return AVERROR(ENOMEM);
103
104     vst->codecpar->codec_tag = avio_rl32(pb);
105     if (vst->codecpar->codec_tag == AV_RL32("SMUS")) {
106         do {
107             bink->smush_size += SMUSH_BLOCK_SIZE;
108             avio_skip(pb, SMUSH_BLOCK_SIZE - 4);
109             vst->codecpar->codec_tag = avio_rl32(pb);
110         } while (!avio_feof(pb) && (vst->codecpar->codec_tag & 0xFFFFFF) != AV_RL32("BIK"));
111         if (avio_feof(pb)) {
112             av_log(s, AV_LOG_ERROR, "invalid SMUSH header: BIK not found\n");
113             return AVERROR_INVALIDDATA;
114         }
115     }
116
117     bink->file_size = avio_rl32(pb) + 8;
118     vst->duration   = avio_rl32(pb);
119
120     if (vst->duration > 1000000) {
121         av_log(s, AV_LOG_ERROR, "invalid header: more than 1000000 frames\n");
122         return AVERROR(EIO);
123     }
124
125     if (avio_rl32(pb) > bink->file_size) {
126         av_log(s, AV_LOG_ERROR,
127                "invalid header: largest frame size greater than file size\n");
128         return AVERROR(EIO);
129     }
130
131     avio_skip(pb, 4);
132
133     vst->codecpar->width  = avio_rl32(pb);
134     vst->codecpar->height = avio_rl32(pb);
135
136     fps_num = avio_rl32(pb);
137     fps_den = avio_rl32(pb);
138     if (fps_num == 0 || fps_den == 0) {
139         av_log(s, AV_LOG_ERROR,
140                "invalid header: invalid fps (%"PRIu32"/%"PRIu32")\n",
141                fps_num, fps_den);
142         return AVERROR(EIO);
143     }
144     avpriv_set_pts_info(vst, 64, fps_den, fps_num);
145     vst->avg_frame_rate = av_inv_q(vst->time_base);
146
147     vst->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
148     vst->codecpar->codec_id   = AV_CODEC_ID_BINKVIDEO;
149
150     if ((vst->codecpar->codec_tag & 0xFFFFFF) == MKTAG('K', 'B', '2', 0)) {
151         av_log(s, AV_LOG_WARNING, "Bink 2 video is not implemented\n");
152         vst->codecpar->codec_id = AV_CODEC_ID_NONE;
153     }
154
155     if ((ret = ff_get_extradata(s, vst->codecpar, pb, 4)) < 0)
156         return ret;
157
158     bink->num_audio_tracks = avio_rl32(pb);
159
160     if (bink->num_audio_tracks > BINK_MAX_AUDIO_TRACKS) {
161         av_log(s, AV_LOG_ERROR,
162                "invalid header: more than "AV_STRINGIFY(BINK_MAX_AUDIO_TRACKS)" audio tracks (%"PRIu32")\n",
163                bink->num_audio_tracks);
164         return AVERROR(EIO);
165     }
166
167     signature = (vst->codecpar->codec_tag & 0xFFFFFF);
168     revision = ((vst->codecpar->codec_tag >> 24) % 0xFF);
169
170     if ((signature == AV_RL32("BIK") && (revision == 'k')) ||
171         (signature == AV_RL32("KB2") && (revision == 'i' || revision == 'j' || revision == 'k')))
172         avio_skip(pb, 4); /* unknown new field */
173
174     if (bink->num_audio_tracks) {
175         avio_skip(pb, 4 * bink->num_audio_tracks); /* max decoded size */
176
177         for (i = 0; i < bink->num_audio_tracks; i++) {
178             ast = avformat_new_stream(s, NULL);
179             if (!ast)
180                 return AVERROR(ENOMEM);
181             ast->codecpar->codec_type  = AVMEDIA_TYPE_AUDIO;
182             ast->codecpar->codec_tag   = 0;
183             ast->codecpar->sample_rate = avio_rl16(pb);
184             avpriv_set_pts_info(ast, 64, 1, ast->codecpar->sample_rate);
185             flags = avio_rl16(pb);
186             ast->codecpar->codec_id = flags & BINK_AUD_USEDCT ?
187                                    AV_CODEC_ID_BINKAUDIO_DCT : AV_CODEC_ID_BINKAUDIO_RDFT;
188             if (flags & BINK_AUD_STEREO) {
189                 ast->codecpar->channels       = 2;
190                 ast->codecpar->channel_layout = AV_CH_LAYOUT_STEREO;
191             } else {
192                 ast->codecpar->channels       = 1;
193                 ast->codecpar->channel_layout = AV_CH_LAYOUT_MONO;
194             }
195             if ((ret = ff_alloc_extradata(ast->codecpar, 4)) < 0)
196                 return ret;
197             AV_WL32(ast->codecpar->extradata, vst->codecpar->codec_tag);
198         }
199
200         for (i = 0; i < bink->num_audio_tracks; i++)
201             s->streams[i + 1]->id = avio_rl32(pb);
202     }
203
204     /* frame index table */
205     next_pos = avio_rl32(pb);
206     for (i = 0; i < vst->duration; i++) {
207         pos = next_pos;
208         keyframe = next_keyframe;
209         if (i == vst->duration - 1) {
210             next_pos = bink->file_size;
211             next_keyframe = 0;
212         } else {
213             next_pos = avio_rl32(pb);
214             next_keyframe = next_pos & 1;
215         }
216         pos &= ~1;
217         next_pos &= ~1;
218
219         if (next_pos <= pos) {
220             av_log(s, AV_LOG_ERROR, "invalid frame index table\n");
221             return AVERROR(EIO);
222         }
223         if ((ret = av_add_index_entry(vst, pos, i, next_pos - pos, 0,
224                                       keyframe ? AVINDEX_KEYFRAME : 0)) < 0)
225             return ret;
226     }
227
228     if (vst->internal->index_entries)
229         avio_seek(pb, vst->internal->index_entries[0].pos + bink->smush_size, SEEK_SET);
230     else
231         avio_skip(pb, 4);
232
233     bink->current_track = -1;
234     return 0;
235 }
236
237 static int read_packet(AVFormatContext *s, AVPacket *pkt)
238 {
239     BinkDemuxContext *bink = s->priv_data;
240     AVIOContext *pb = s->pb;
241     int ret;
242
243     if (bink->current_track < 0) {
244         int index_entry;
245         AVStream *st = s->streams[0]; // stream 0 is video stream with index
246
247         if (bink->video_pts >= st->duration)
248             return AVERROR_EOF;
249
250         index_entry = av_index_search_timestamp(st, bink->video_pts,
251                                                 AVSEEK_FLAG_ANY);
252         if (index_entry < 0) {
253             av_log(s, AV_LOG_ERROR,
254                    "could not find index entry for frame %"PRId64"\n",
255                    bink->video_pts);
256             return AVERROR(EIO);
257         }
258
259         bink->remain_packet_size = st->internal->index_entries[index_entry].size;
260         bink->flags = st->internal->index_entries[index_entry].flags;
261         bink->current_track = 0;
262     }
263
264     while (bink->current_track < bink->num_audio_tracks) {
265         uint32_t audio_size = avio_rl32(pb);
266         if (audio_size > bink->remain_packet_size - 4) {
267             av_log(s, AV_LOG_ERROR,
268                    "frame %"PRId64": audio size in header (%"PRIu32") > size of packet left (%"PRIu32")\n",
269                    bink->video_pts, audio_size, bink->remain_packet_size);
270             return AVERROR(EIO);
271         }
272         bink->remain_packet_size -= 4 + audio_size;
273         bink->current_track++;
274         if (audio_size >= 4) {
275             /* get one audio packet per track */
276             if ((ret = av_get_packet(pb, pkt, audio_size)) < 0)
277                 return ret;
278             pkt->stream_index = bink->current_track;
279             pkt->pts = bink->audio_pts[bink->current_track - 1];
280
281             /* Each audio packet reports the number of decompressed samples
282                (in bytes). We use this value to calculate the audio PTS */
283             if (pkt->size >= 4)
284                 bink->audio_pts[bink->current_track -1] +=
285                     AV_RL32(pkt->data) / (2 * s->streams[bink->current_track]->codecpar->channels);
286             return 0;
287         } else {
288             avio_skip(pb, audio_size);
289         }
290     }
291
292     /* get video packet */
293     if ((ret = av_get_packet(pb, pkt, bink->remain_packet_size)) < 0)
294         return ret;
295     pkt->stream_index = 0;
296     pkt->pts = bink->video_pts++;
297     if (bink->flags & AVINDEX_KEYFRAME)
298         pkt->flags |= AV_PKT_FLAG_KEY;
299
300     /* -1 instructs the next call to read_packet() to read the next frame */
301     bink->current_track = -1;
302
303     return 0;
304 }
305
306 static int read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
307 {
308     BinkDemuxContext *bink = s->priv_data;
309     AVStream *vst = s->streams[0];
310     int64_t ret;
311
312     if (!(s->pb->seekable & AVIO_SEEKABLE_NORMAL))
313         return -1;
314
315     /* seek to the first frame */
316     ret = avio_seek(s->pb, vst->internal->index_entries[0].pos + bink->smush_size, SEEK_SET);
317     if (ret < 0)
318         return ret;
319
320     bink->video_pts = 0;
321     memset(bink->audio_pts, 0, sizeof(bink->audio_pts));
322     bink->current_track = -1;
323     return 0;
324 }
325
326 AVInputFormat ff_bink_demuxer = {
327     .name           = "bink",
328     .long_name      = NULL_IF_CONFIG_SMALL("Bink"),
329     .priv_data_size = sizeof(BinkDemuxContext),
330     .read_probe     = probe,
331     .read_header    = read_header,
332     .read_packet    = read_packet,
333     .read_seek      = read_seek,
334     .flags          = AVFMT_SHOW_IDS,
335 };