FFmpeg
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(const 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' && /* Bink 1 */
69  (b[3] == 'b' || b[3] == 'f' || b[3] == 'g' || b[3] == 'h' || b[3] == 'i' ||
70  b[3] == 'k')) ||
71  (b[0] == 'K' && b[1] == 'B' && b[2] == '2' && /* Bink 2 */
72  (b[3] == 'a' || b[3] == 'd' || b[3] == 'f' || b[3] == 'g' || b[3] == 'h' ||
73  b[3] == 'i' || b[3] == 'j' || b[3] == 'k'))) &&
74  AV_RL32(b+8) > 0 && // num_frames
75  AV_RL32(b+20) > 0 && AV_RL32(b+20) <= BINK_MAX_WIDTH &&
76  AV_RL32(b+24) > 0 && AV_RL32(b+24) <= BINK_MAX_HEIGHT &&
77  AV_RL32(b+28) > 0 && AV_RL32(b+32) > 0) // fps num,den
78  return AVPROBE_SCORE_MAX;
80  } while (smush && b < p->buf + p->buf_size - 32);
81  return 0;
82 }
83 
85 {
86  BinkDemuxContext *bink = s->priv_data;
87  AVIOContext *pb = s->pb;
88  uint32_t fps_num, fps_den;
89  AVStream *vst, *ast;
90  unsigned int i;
91  uint32_t pos, next_pos;
92  uint16_t flags;
93  int keyframe;
94  int ret;
95  uint32_t signature;
96  uint8_t revision;
97 
98  vst = avformat_new_stream(s, NULL);
99  if (!vst)
100  return AVERROR(ENOMEM);
101 
102  vst->codecpar->codec_tag = avio_rl32(pb);
103  if (vst->codecpar->codec_tag == AV_RL32("SMUS")) {
104  do {
105  bink->smush_size += SMUSH_BLOCK_SIZE;
106  avio_skip(pb, SMUSH_BLOCK_SIZE - 4);
107  vst->codecpar->codec_tag = avio_rl32(pb);
108  } while (!avio_feof(pb) && (vst->codecpar->codec_tag & 0xFFFFFF) != AV_RL32("BIK"));
109  if (avio_feof(pb)) {
110  av_log(s, AV_LOG_ERROR, "invalid SMUSH header: BIK not found\n");
111  return AVERROR_INVALIDDATA;
112  }
113  }
114 
115  bink->file_size = avio_rl32(pb) + 8;
116  vst->duration = avio_rl32(pb);
117 
118  if (vst->duration > 1000000) {
119  av_log(s, AV_LOG_ERROR, "invalid header: more than 1000000 frames\n");
120  return AVERROR(EIO);
121  }
122 
123  if (avio_rl32(pb) > bink->file_size) {
125  "invalid header: largest frame size greater than file size\n");
126  return AVERROR(EIO);
127  }
128 
129  avio_skip(pb, 4);
130 
131  vst->codecpar->width = avio_rl32(pb);
132  vst->codecpar->height = avio_rl32(pb);
133 
134  fps_num = avio_rl32(pb);
135  fps_den = avio_rl32(pb);
136  if (fps_num == 0 || fps_den == 0) {
138  "invalid header: invalid fps (%"PRIu32"/%"PRIu32")\n",
139  fps_num, fps_den);
140  return AVERROR(EIO);
141  }
142  avpriv_set_pts_info(vst, 64, fps_den, fps_num);
143  vst->avg_frame_rate = av_inv_q(vst->time_base);
144 
147 
148  if ((vst->codecpar->codec_tag & 0xFFFFFF) == MKTAG('K', 'B', '2', 0)) {
149  av_log(s, AV_LOG_WARNING, "Bink 2 video is not implemented\n");
151  }
152 
153  if (ff_get_extradata(s, vst->codecpar, pb, 4) < 0)
154  return AVERROR(ENOMEM);
155 
156  bink->num_audio_tracks = avio_rl32(pb);
157 
160  "invalid header: more than "AV_STRINGIFY(BINK_MAX_AUDIO_TRACKS)" audio tracks (%"PRIu32")\n",
161  bink->num_audio_tracks);
162  return AVERROR(EIO);
163  }
164 
165  signature = (vst->codecpar->codec_tag & 0xFFFFFF);
166  revision = ((vst->codecpar->codec_tag >> 24) % 0xFF);
167 
168  if ((signature == AV_RL32("BIK") && (revision == 'k')) ||
169  (signature == AV_RL32("KB2") && (revision == 'i' || revision == 'j' || revision == 'k')))
170  avio_skip(pb, 4); /* unknown new field */
171 
172  if (bink->num_audio_tracks) {
173  avio_skip(pb, 4 * bink->num_audio_tracks); /* max decoded size */
174 
175  for (i = 0; i < bink->num_audio_tracks; i++) {
176  ast = avformat_new_stream(s, NULL);
177  if (!ast)
178  return AVERROR(ENOMEM);
180  ast->codecpar->codec_tag = 0;
181  ast->codecpar->sample_rate = avio_rl16(pb);
182  avpriv_set_pts_info(ast, 64, 1, ast->codecpar->sample_rate);
183  flags = avio_rl16(pb);
186  if (flags & BINK_AUD_STEREO) {
187  ast->codecpar->channels = 2;
189  } else {
190  ast->codecpar->channels = 1;
192  }
193  if (ff_alloc_extradata(ast->codecpar, 4))
194  return AVERROR(ENOMEM);
196  }
197 
198  for (i = 0; i < bink->num_audio_tracks; i++)
199  s->streams[i + 1]->id = avio_rl32(pb);
200  }
201 
202  /* frame index table */
203  next_pos = avio_rl32(pb);
204  for (i = 0; i < vst->duration; i++) {
205  pos = next_pos;
206  if (i == vst->duration - 1) {
207  next_pos = bink->file_size;
208  keyframe = 0;
209  } else {
210  next_pos = avio_rl32(pb);
211  keyframe = pos & 1;
212  }
213  pos &= ~1;
214  next_pos &= ~1;
215 
216  if (next_pos <= pos) {
217  av_log(s, AV_LOG_ERROR, "invalid frame index table\n");
218  return AVERROR(EIO);
219  }
220  if ((ret = av_add_index_entry(vst, pos, i, next_pos - pos, 0,
221  keyframe ? AVINDEX_KEYFRAME : 0)) < 0)
222  return ret;
223  }
224 
225  if (vst->index_entries)
226  avio_seek(pb, vst->index_entries[0].pos + bink->smush_size, SEEK_SET);
227  else
228  avio_skip(pb, 4);
229 
230  bink->current_track = -1;
231  return 0;
232 }
233 
235 {
236  BinkDemuxContext *bink = s->priv_data;
237  AVIOContext *pb = s->pb;
238  int ret;
239 
240  if (bink->current_track < 0) {
241  int index_entry;
242  AVStream *st = s->streams[0]; // stream 0 is video stream with index
243 
244  if (bink->video_pts >= st->duration)
245  return AVERROR_EOF;
246 
247  index_entry = av_index_search_timestamp(st, bink->video_pts,
249  if (index_entry < 0) {
251  "could not find index entry for frame %"PRId64"\n",
252  bink->video_pts);
253  return AVERROR(EIO);
254  }
255 
256  bink->remain_packet_size = st->index_entries[index_entry].size;
257  bink->current_track = 0;
258  }
259 
260  while (bink->current_track < bink->num_audio_tracks) {
261  uint32_t audio_size = avio_rl32(pb);
262  if (audio_size > bink->remain_packet_size - 4) {
264  "frame %"PRId64": audio size in header (%"PRIu32") > size of packet left (%"PRIu32")\n",
265  bink->video_pts, audio_size, bink->remain_packet_size);
266  return AVERROR(EIO);
267  }
268  bink->remain_packet_size -= 4 + audio_size;
269  bink->current_track++;
270  if (audio_size >= 4) {
271  /* get one audio packet per track */
272  if ((ret = av_get_packet(pb, pkt, audio_size)) < 0)
273  return ret;
274  pkt->stream_index = bink->current_track;
275  pkt->pts = bink->audio_pts[bink->current_track - 1];
276 
277  /* Each audio packet reports the number of decompressed samples
278  (in bytes). We use this value to calculate the audio PTS */
279  if (pkt->size >= 4)
280  bink->audio_pts[bink->current_track -1] +=
281  AV_RL32(pkt->data) / (2 * s->streams[bink->current_track]->codecpar->channels);
282  return 0;
283  } else {
284  avio_skip(pb, audio_size);
285  }
286  }
287 
288  /* get video packet */
289  if ((ret = av_get_packet(pb, pkt, bink->remain_packet_size)) < 0)
290  return ret;
291  pkt->stream_index = 0;
292  pkt->pts = bink->video_pts++;
294 
295  /* -1 instructs the next call to read_packet() to read the next frame */
296  bink->current_track = -1;
297 
298  return 0;
299 }
300 
301 static int read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
302 {
303  BinkDemuxContext *bink = s->priv_data;
304  AVStream *vst = s->streams[0];
305 
306  if (!(s->pb->seekable & AVIO_SEEKABLE_NORMAL))
307  return -1;
308 
309  /* seek to the first frame */
310  if (avio_seek(s->pb, vst->index_entries[0].pos + bink->smush_size, SEEK_SET) < 0)
311  return -1;
312 
313  bink->video_pts = 0;
314  memset(bink->audio_pts, 0, sizeof(bink->audio_pts));
315  bink->current_track = -1;
316  return 0;
317 }
318 
320  .name = "bink",
321  .long_name = NULL_IF_CONFIG_SMALL("Bink"),
322  .priv_data_size = sizeof(BinkDemuxContext),
323  .read_probe = probe,
326  .read_seek = read_seek,
328 };
AVStream::index_entries
AVIndexEntry * index_entries
Only used if the format does not support seeking natively.
Definition: avformat.h:1099
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
AVCodecParameters::extradata
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: avcodec.h:3971
BINK_AUD_STEREO
@ BINK_AUD_STEREO
Definition: bink.c:40
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
avformat_new_stream
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4480
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:3953
AVFMT_SHOW_IDS
#define AVFMT_SHOW_IDS
Show format stream IDs numbers.
Definition: avformat.h:465
AV_WL32
#define AV_WL32(p, v)
Definition: intreadwrite.h:426
ff_get_extradata
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:3327
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:55
MKTAG
#define MKTAG(a, b, c, d)
Definition: common.h:366
BinkAudFlags
BinkAudFlags
Definition: bink.c:38
AV_CH_LAYOUT_MONO
#define AV_CH_LAYOUT_MONO
Definition: channel_layout.h:85
BinkDemuxContext::video_pts
int64_t video_pts
Definition: bink.c:55
AVPacket::data
uint8_t * data
Definition: avcodec.h:1477
b
#define b
Definition: input.c:41
AVStream::avg_frame_rate
AVRational avg_frame_rate
Average framerate.
Definition: avformat.h:943
BinkDemuxContext
Definition: bink.c:50
AVCodecParameters::codec_tag
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: avcodec.h:3961
AVProbeData::buf_size
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:449
BinkDemuxContext::file_size
uint32_t file_size
Definition: bink.c:51
AV_PKT_FLAG_KEY
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1509
AVINDEX_KEYFRAME
#define AVINDEX_KEYFRAME
Definition: avformat.h:808
BinkDemuxContext::current_track
int current_track
audio track to return in next packet
Definition: bink.c:54
AVPROBE_SCORE_MAX
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:458
AVCodecParameters::channels
int channels
Audio only.
Definition: avcodec.h:4063
AVSEEK_FLAG_ANY
#define AVSEEK_FLAG_ANY
seek to any frame, even non-keyframes
Definition: avformat.h:2497
av_add_index_entry
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:2056
BinkDemuxContext::num_audio_tracks
uint32_t num_audio_tracks
Definition: bink.c:53
AVStream::duration
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:919
avio_rl16
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:753
AV_CH_LAYOUT_STEREO
#define AV_CH_LAYOUT_STEREO
Definition: channel_layout.h:86
signature
static const char signature[]
Definition: ipmovie.c:615
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
buf
void * buf
Definition: avisynth_c.h:766
AVInputFormat
Definition: avformat.h:640
read_seek
static int read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
Definition: bink.c:301
BINK_AUD_USEDCT
@ BINK_AUD_USEDCT
Definition: bink.c:41
BINK_MAX_AUDIO_TRACKS
#define BINK_MAX_AUDIO_TRACKS
Definition: bink.c:45
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:257
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:645
AVProbeData::buf
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:448
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
AVCodecParameters::width
int width
Video only.
Definition: avcodec.h:4023
AVIndexEntry::size
int size
Definition: avformat.h:811
AV_CODEC_ID_BINKAUDIO_DCT
@ AV_CODEC_ID_BINKAUDIO_DCT
Definition: avcodec.h:612
AVFormatContext
Format I/O context.
Definition: avformat.h:1342
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1017
SMUSH_BLOCK_SIZE
#define SMUSH_BLOCK_SIZE
Definition: bink.c:48
AVStream::time_base
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.
Definition: avformat.h:899
NULL
#define NULL
Definition: coverity.c:32
read_probe
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
AV_RN32
#define AV_RN32(p)
Definition: intreadwrite.h:364
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:446
probe
static int probe(const AVProbeData *p)
Definition: bink.c:62
BinkDemuxContext::smush_size
int smush_size
Definition: bink.c:59
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: avcodec.h:4067
avio_rl32
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:769
AVIOContext
Bytestream IO Context.
Definition: avio.h:161
AVPacket::size
int size
Definition: avcodec.h:1478
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:188
avpriv_set_pts_info
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:4910
read_header
static int read_header(AVFormatContext *s)
Definition: bink.c:84
BINK_MAX_HEIGHT
#define BINK_MAX_HEIGHT
Definition: bink.c:47
AVPacket::flags
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:1483
BINK_AUD_16BITS
@ BINK_AUD_16BITS
prefer 16-bit output
Definition: bink.c:39
AV_CODEC_ID_NONE
@ AV_CODEC_ID_NONE
Definition: avcodec.h:216
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:259
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1470
AVCodecParameters::height
int height
Definition: avcodec.h:4024
AV_STRINGIFY
#define AV_STRINGIFY(s)
Definition: macros.h:36
uint8_t
uint8_t
Definition: audio_convert.c:194
av_inv_q
static av_always_inline AVRational av_inv_q(AVRational q)
Invert a rational.
Definition: rational.h:159
av_get_packet
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:313
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:870
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:246
read_packet
static int read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: bink.c:234
avformat.h
BinkDemuxContext::audio_pts
int64_t audio_pts[BINK_MAX_AUDIO_TRACKS]
Definition: bink.c:56
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:88
channel_layout.h
pkt
static AVPacket pkt
Definition: demuxing_decoding.c:54
AV_CODEC_ID_BINKVIDEO
@ AV_CODEC_ID_BINKVIDEO
Definition: avcodec.h:353
AVIO_SEEKABLE_NORMAL
#define AVIO_SEEKABLE_NORMAL
Seeking works like for a local file.
Definition: avio.h:40
BinkDemuxContext::remain_packet_size
uint32_t remain_packet_size
Definition: bink.c:58
AVIndexEntry::pos
int64_t pos
Definition: avformat.h:801
AVPacket::stream_index
int stream_index
Definition: avcodec.h:1479
avio_skip
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:331
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
ff_bink_demuxer
AVInputFormat ff_bink_demuxer
Definition: bink.c:319
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:3957
AVPacket
This structure stores compressed data.
Definition: avcodec.h:1454
AVCodecParameters::channel_layout
uint64_t channel_layout
Audio only.
Definition: avcodec.h:4059
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:565
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
AV_CODEC_ID_BINKAUDIO_RDFT
@ AV_CODEC_ID_BINKAUDIO_RDFT
Definition: avcodec.h:611
BINK_MAX_WIDTH
#define BINK_MAX_WIDTH
Definition: bink.c:46
av_index_search_timestamp
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags)
Get the index for a specific timestamp.
Definition: utils.c:2167
ff_alloc_extradata
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:3309
avio_feof
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:358