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;
79  b += SMUSH_BLOCK_SIZE;
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) {
124  av_log(s, AV_LOG_ERROR,
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) {
137  av_log(s, AV_LOG_ERROR,
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 
159  av_log(s, AV_LOG_ERROR,
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);
184  ast->codecpar->codec_id = flags & BINK_AUD_USEDCT ?
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) {
250  av_log(s, AV_LOG_ERROR,
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) {
263  av_log(s, AV_LOG_ERROR,
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++;
293  pkt->flags |= AV_PKT_FLAG_KEY;
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 };
#define NULL
Definition: coverity.c:32
static int probe(const AVProbeData *p)
Definition: bink.c:62
Bytestream IO Context.
Definition: avio.h:161
#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:2039
int64_t video_pts
Definition: bink.c:55
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
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:4882
int64_t pos
Definition: avformat.h:810
#define BINK_MAX_AUDIO_TRACKS
Definition: bink.c:45
#define AVSEEK_FLAG_ANY
seek to any frame, even non-keyframes
Definition: avformat.h:2513
uint32_t file_size
Definition: bink.c:51
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:3953
int size
Definition: avcodec.h:1478
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:246
AVIndexEntry * index_entries
Only used if the format does not support seeking natively.
Definition: avformat.h:1110
BinkAudFlags
Definition: bink.c:38
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:331
static AVPacket pkt
#define AV_CH_LAYOUT_STEREO
#define AVFMT_SHOW_IDS
Show format stream IDs numbers.
Definition: avformat.h:465
uint32_t num_audio_tracks
Definition: bink.c:53
Format I/O context.
Definition: avformat.h:1358
#define BINK_MAX_WIDTH
Definition: bink.c:46
static const char signature[]
Definition: ipmovie.c:615
uint8_t
int width
Video only.
Definition: avcodec.h:4019
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:4455
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1426
uint8_t * data
Definition: avcodec.h:1477
#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:310
uint64_t channel_layout
Audio only.
Definition: avcodec.h:4055
#define av_log(a,...)
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1509
AVInputFormat ff_bink_demuxer
Definition: bink.c:319
#define AVINDEX_KEYFRAME
Definition: avformat.h:817
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:260
#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:2148
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:770
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:3949
#define SMUSH_BLOCK_SIZE
Definition: bink.c:48
AVRational avg_frame_rate
Average framerate.
Definition: avformat.h:954
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:1483
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:449
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:448
int smush_size
Definition: bink.c:59
#define b
Definition: input.c:41
int seekable
A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
Definition: avio.h:260
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:3287
static int read_header(AVFormatContext *s)
Definition: bink.c:84
#define s(width, name)
Definition: cbs_vp9.c:257
Stream structure.
Definition: avformat.h:881
#define AVIO_SEEKABLE_NORMAL
Seeking works like for a local file.
Definition: avio.h:40
AVIOContext * pb
I/O context.
Definition: avformat.h:1400
void * buf
Definition: avisynth_c.h:766
#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:446
#define AV_RN32(p)
Definition: intreadwrite.h:364
int64_t audio_pts[BINK_MAX_AUDIO_TRACKS]
Definition: bink.c:56
#define flags(name, subs,...)
Definition: cbs_av1.c:561
static int read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: bink.c:234
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:930
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:4063
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:458
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:754
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:3305
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:301
void * priv_data
Format private data.
Definition: avformat.h:1386
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: avcodec.h:3967
int channels
Audio only.
Definition: avcodec.h:4059
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:654
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1028
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:358
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: avcodec.h:3957
int stream_index
Definition: avcodec.h:1479
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avformat.h:910
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
#define AV_CH_LAYOUT_MONO
#define MKTAG(a, b, c, d)
Definition: common.h:366
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:87
This structure stores compressed data.
Definition: avcodec.h:1454
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1470
#define AV_WL32(p, v)
Definition: intreadwrite.h:426