FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
bink.c
Go to the documentation of this file.
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 
34 #include "libavutil/intreadwrite.h"
35 #include "avformat.h"
36 #include "internal.h"
37 
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;
57 
61 
62 static int probe(AVProbeData *p)
63 {
64  const uint8_t *b = p->buf;
65  int smush = AV_RN32(p->buf) == AV_RN32("SMUS");
66 
67  do {
68  if (((b[0] == 'B' && b[1] == 'I' && b[2] == 'K' &&
69  (b[3] == 'b' || b[3] == 'f' || b[3] == 'g' || b[3] == 'h' || b[3] == 'i')) ||
70  (b[0] == 'K' && b[1] == 'B' && b[2] == '2' && /* Bink 2 */
71  (b[3] == 'a' || b[3] == 'd' || b[3] == 'f' || b[3] == 'g'))) &&
72  AV_RL32(b+8) > 0 && // num_frames
73  AV_RL32(b+20) > 0 && AV_RL32(b+20) <= BINK_MAX_WIDTH &&
74  AV_RL32(b+24) > 0 && AV_RL32(b+24) <= BINK_MAX_HEIGHT &&
75  AV_RL32(b+28) > 0 && AV_RL32(b+32) > 0) // fps num,den
76  return AVPROBE_SCORE_MAX;
77  b += SMUSH_BLOCK_SIZE;
78  } while (smush && b < p->buf + p->buf_size - 32);
79  return 0;
80 }
81 
83 {
84  BinkDemuxContext *bink = s->priv_data;
85  AVIOContext *pb = s->pb;
86  uint32_t fps_num, fps_den;
87  AVStream *vst, *ast;
88  unsigned int i;
89  uint32_t pos, next_pos;
90  uint16_t flags;
91  int keyframe;
92  int ret;
93 
94  vst = avformat_new_stream(s, NULL);
95  if (!vst)
96  return AVERROR(ENOMEM);
97 
98  vst->codecpar->codec_tag = avio_rl32(pb);
99  if (vst->codecpar->codec_tag == AV_RL32("SMUS")) {
100  do {
101  bink->smush_size += SMUSH_BLOCK_SIZE;
102  avio_skip(pb, SMUSH_BLOCK_SIZE - 4);
103  vst->codecpar->codec_tag = avio_rl32(pb);
104  } while (!avio_feof(pb) && (vst->codecpar->codec_tag & 0xFFFFFF) != AV_RL32("BIK"));
105  if (avio_feof(pb)) {
106  av_log(s, AV_LOG_ERROR, "invalid SMUSH header: BIK not found\n");
107  return AVERROR_INVALIDDATA;
108  }
109  }
110 
111  bink->file_size = avio_rl32(pb) + 8;
112  vst->duration = avio_rl32(pb);
113 
114  if (vst->duration > 1000000) {
115  av_log(s, AV_LOG_ERROR, "invalid header: more than 1000000 frames\n");
116  return AVERROR(EIO);
117  }
118 
119  if (avio_rl32(pb) > bink->file_size) {
120  av_log(s, AV_LOG_ERROR,
121  "invalid header: largest frame size greater than file size\n");
122  return AVERROR(EIO);
123  }
124 
125  avio_skip(pb, 4);
126 
127  vst->codecpar->width = avio_rl32(pb);
128  vst->codecpar->height = avio_rl32(pb);
129 
130  fps_num = avio_rl32(pb);
131  fps_den = avio_rl32(pb);
132  if (fps_num == 0 || fps_den == 0) {
133  av_log(s, AV_LOG_ERROR,
134  "invalid header: invalid fps (%"PRIu32"/%"PRIu32")\n",
135  fps_num, fps_den);
136  return AVERROR(EIO);
137  }
138  avpriv_set_pts_info(vst, 64, fps_den, fps_num);
139  vst->avg_frame_rate = av_inv_q(vst->time_base);
140 
143 
144  if ((vst->codecpar->codec_tag & 0xFFFFFF) == MKTAG('K', 'B', '2', 0)) {
145  av_log(s, AV_LOG_WARNING, "Bink 2 video is not implemented\n");
147  }
148 
149  if (ff_get_extradata(s, vst->codecpar, pb, 4) < 0)
150  return AVERROR(ENOMEM);
151 
152  bink->num_audio_tracks = avio_rl32(pb);
153 
155  av_log(s, AV_LOG_ERROR,
156  "invalid header: more than "AV_STRINGIFY(BINK_MAX_AUDIO_TRACKS)" audio tracks (%"PRIu32")\n",
157  bink->num_audio_tracks);
158  return AVERROR(EIO);
159  }
160 
161  if (bink->num_audio_tracks) {
162  avio_skip(pb, 4 * bink->num_audio_tracks);
163 
164  for (i = 0; i < bink->num_audio_tracks; i++) {
165  ast = avformat_new_stream(s, NULL);
166  if (!ast)
167  return AVERROR(ENOMEM);
169  ast->codecpar->codec_tag = 0;
170  ast->codecpar->sample_rate = avio_rl16(pb);
171  avpriv_set_pts_info(ast, 64, 1, ast->codecpar->sample_rate);
172  flags = avio_rl16(pb);
173  ast->codecpar->codec_id = flags & BINK_AUD_USEDCT ?
175  if (flags & BINK_AUD_STEREO) {
176  ast->codecpar->channels = 2;
178  } else {
179  ast->codecpar->channels = 1;
181  }
182  if (ff_alloc_extradata(ast->codecpar, 4))
183  return AVERROR(ENOMEM);
185  }
186 
187  for (i = 0; i < bink->num_audio_tracks; i++)
188  s->streams[i + 1]->id = avio_rl32(pb);
189  }
190 
191  /* frame index table */
192  next_pos = avio_rl32(pb);
193  for (i = 0; i < vst->duration; i++) {
194  pos = next_pos;
195  if (i == vst->duration - 1) {
196  next_pos = bink->file_size;
197  keyframe = 0;
198  } else {
199  next_pos = avio_rl32(pb);
200  keyframe = pos & 1;
201  }
202  pos &= ~1;
203  next_pos &= ~1;
204 
205  if (next_pos <= pos) {
206  av_log(s, AV_LOG_ERROR, "invalid frame index table\n");
207  return AVERROR(EIO);
208  }
209  if ((ret = av_add_index_entry(vst, pos, i, next_pos - pos, 0,
210  keyframe ? AVINDEX_KEYFRAME : 0)) < 0)
211  return ret;
212  }
213 
214  if (vst->index_entries)
215  avio_seek(pb, vst->index_entries[0].pos + bink->smush_size, SEEK_SET);
216  else
217  avio_skip(pb, 4);
218 
219  bink->current_track = -1;
220  return 0;
221 }
222 
224 {
225  BinkDemuxContext *bink = s->priv_data;
226  AVIOContext *pb = s->pb;
227  int ret;
228 
229  if (bink->current_track < 0) {
230  int index_entry;
231  AVStream *st = s->streams[0]; // stream 0 is video stream with index
232 
233  if (bink->video_pts >= st->duration)
234  return AVERROR_EOF;
235 
236  index_entry = av_index_search_timestamp(st, bink->video_pts,
238  if (index_entry < 0) {
239  av_log(s, AV_LOG_ERROR,
240  "could not find index entry for frame %"PRId64"\n",
241  bink->video_pts);
242  return AVERROR(EIO);
243  }
244 
245  bink->remain_packet_size = st->index_entries[index_entry].size;
246  bink->current_track = 0;
247  }
248 
249  while (bink->current_track < bink->num_audio_tracks) {
250  uint32_t audio_size = avio_rl32(pb);
251  if (audio_size > bink->remain_packet_size - 4) {
252  av_log(s, AV_LOG_ERROR,
253  "frame %"PRId64": audio size in header (%"PRIu32") > size of packet left (%"PRIu32")\n",
254  bink->video_pts, audio_size, bink->remain_packet_size);
255  return AVERROR(EIO);
256  }
257  bink->remain_packet_size -= 4 + audio_size;
258  bink->current_track++;
259  if (audio_size >= 4) {
260  /* get one audio packet per track */
261  if ((ret = av_get_packet(pb, pkt, audio_size)) < 0)
262  return ret;
263  pkt->stream_index = bink->current_track;
264  pkt->pts = bink->audio_pts[bink->current_track - 1];
265 
266  /* Each audio packet reports the number of decompressed samples
267  (in bytes). We use this value to calculate the audio PTS */
268  if (pkt->size >= 4)
269  bink->audio_pts[bink->current_track -1] +=
270  AV_RL32(pkt->data) / (2 * s->streams[bink->current_track]->codecpar->channels);
271  return 0;
272  } else {
273  avio_skip(pb, audio_size);
274  }
275  }
276 
277  /* get video packet */
278  if ((ret = av_get_packet(pb, pkt, bink->remain_packet_size)) < 0)
279  return ret;
280  pkt->stream_index = 0;
281  pkt->pts = bink->video_pts++;
282  pkt->flags |= AV_PKT_FLAG_KEY;
283 
284  /* -1 instructs the next call to read_packet() to read the next frame */
285  bink->current_track = -1;
286 
287  return 0;
288 }
289 
290 static int read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
291 {
292  BinkDemuxContext *bink = s->priv_data;
293  AVStream *vst = s->streams[0];
294 
295  if (!s->pb->seekable)
296  return -1;
297 
298  /* seek to the first frame */
299  if (avio_seek(s->pb, vst->index_entries[0].pos + bink->smush_size, SEEK_SET) < 0)
300  return -1;
301 
302  bink->video_pts = 0;
303  memset(bink->audio_pts, 0, sizeof(bink->audio_pts));
304  bink->current_track = -1;
305  return 0;
306 }
307 
309  .name = "bink",
310  .long_name = NULL_IF_CONFIG_SMALL("Bink"),
311  .priv_data_size = sizeof(BinkDemuxContext),
312  .read_probe = probe,
315  .read_seek = read_seek,
317 };
#define NULL
Definition: coverity.c:32
const char * s
Definition: avisynth_c.h:768
Bytestream IO Context.
Definition: avio.h:147
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp, int size, int distance, int flags)
Add an index entry into a sorted list.
Definition: utils.c:1945
int64_t video_pts
Definition: bink.c:55
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
static int probe(AVProbeData *p)
Definition: bink.c:62
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:4549
int64_t pos
Definition: avformat.h:818
#define BINK_MAX_AUDIO_TRACKS
Definition: bink.c:45
#define AVSEEK_FLAG_ANY
seek to any frame, even non-keyframes
Definition: avformat.h:2380
uint32_t file_size
Definition: bink.c:51
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:3969
int size
Definition: avcodec.h:1601
const char * b
Definition: vf_curves.c:113
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:230
AVIndexEntry * index_entries
Only used if the format does not support seeking natively.
Definition: avformat.h:1079
BinkAudFlags
Definition: bink.c:38
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:304
static AVPacket pkt
#define AV_CH_LAYOUT_STEREO
#define AVFMT_SHOW_IDS
Show format stream IDs numbers.
Definition: avformat.h:480
uint32_t num_audio_tracks
Definition: bink.c:53
Format I/O context.
Definition: avformat.h:1330
#define BINK_MAX_WIDTH
Definition: bink.c:46
uint8_t
int width
Video only.
Definition: avcodec.h:4035
int current_track
audio track to return in next packet
Definition: bink.c:54
int id
Format-specific stream ID.
Definition: avformat.h:888
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4182
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1398
uint8_t * data
Definition: avcodec.h:1600
#define AVERROR_EOF
End of file.
Definition: error.h:55
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size)
Allocate and read the payload of a packet and initialize its fields with default values.
Definition: utils.c:289
uint64_t channel_layout
Audio only.
Definition: avcodec.h:4071
#define av_log(a,...)
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1632
AVInputFormat ff_bink_demuxer
Definition: bink.c:308
#define AVINDEX_KEYFRAME
Definition: avformat.h:825
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
#define BINK_MAX_HEIGHT
Definition: bink.c:47
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags)
Get the index for a specific timestamp.
Definition: utils.c:2054
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:726
#define AVERROR(e)
Definition: error.h:43
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:176
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:3965
#define SMUSH_BLOCK_SIZE
Definition: bink.c:48
AVRational avg_frame_rate
Average framerate.
Definition: avformat.h:959
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:1606
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:464
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:463
int smush_size
Definition: bink.c:59
int seekable
A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
Definition: avio.h:243
audio channel layout utility functions
int ff_alloc_extradata(AVCodecParameters *par, int size)
Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end which is always set to 0...
Definition: utils.c:3165
static int read_header(AVFormatContext *s)
Definition: bink.c:82
static int read_probe(AVProbeData *pd)
Definition: jvdec.c:55
Stream structure.
Definition: avformat.h:881
AVIOContext * pb
I/O context.
Definition: avformat.h:1372
void * buf
Definition: avisynth_c.h:690
#define AV_STRINGIFY(s)
Definition: macros.h:36
prefer 16-bit output
Definition: bink.c:39
This structure contains the data a format has to probe a file.
Definition: avformat.h:461
#define AV_RN32(p)
Definition: intreadwrite.h:364
int64_t audio_pts[BINK_MAX_AUDIO_TRACKS]
Definition: bink.c:56
static int flags
Definition: cpu.c:47
static int read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: bink.c:223
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:935
static av_always_inline AVRational av_inv_q(AVRational q)
Invert a rational.
Definition: rational.h:159
int sample_rate
Audio only.
Definition: avcodec.h:4079
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:473
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:710
Main libavformat public API header.
int ff_get_extradata(AVFormatContext *s, AVCodecParameters *par, AVIOContext *pb, int size)
Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end which is always set to 0 and f...
Definition: utils.c:3186
uint32_t remain_packet_size
Definition: bink.c:58
static int read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
Definition: bink.c:290
void * priv_data
Format private data.
Definition: avformat.h:1358
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: avcodec.h:3983
int channels
Audio only.
Definition: avcodec.h:4075
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:662
AVCodecParameters * codecpar
Definition: avformat.h:1233
int avio_feof(AVIOContext *s)
feof() equivalent for AVIOContext.
Definition: aviobuf.c:328
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: avcodec.h:3973
int stream_index
Definition: avcodec.h:1602
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avformat.h:918
#define AV_CH_LAYOUT_MONO
#define MKTAG(a, b, c, d)
Definition: common.h:342
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:87
This structure stores compressed data.
Definition: avcodec.h:1577
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1593
#define AV_WL32(p, v)
Definition: intreadwrite.h:426