FFmpeg  4.4
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 
59  int flags;
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;
81  } while (smush && b < p->buf + p->buf_size - 32);
82  return 0;
83 }
84 
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) {
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) {
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 
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");
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 
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);
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);
188  if (flags & BINK_AUD_STEREO) {
189  ast->codecpar->channels = 2;
191  } else {
192  ast->codecpar->channels = 1;
194  }
195  if ((ret = ff_alloc_extradata(ast->codecpar, 4)) < 0)
196  return ret;
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->index_entries)
229  avio_seek(pb, vst->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 
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,
252  if (index_entry < 0) {
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->index_entries[index_entry].size;
260  bink->flags = st->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) {
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)
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->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 
327  .name = "bink",
328  .long_name = NULL_IF_CONFIG_SMALL("Bink"),
329  .priv_data_size = sizeof(BinkDemuxContext),
330  .read_probe = probe,
333  .read_seek = read_seek,
335 };
uint8_t
Main libavformat public API header.
#define AVINDEX_KEYFRAME
Definition: avformat.h:811
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:453
#define AVFMT_SHOW_IDS
Show format stream IDs numbers.
Definition: avformat.h:460
#define AVSEEK_FLAG_ANY
seek to any frame, even non-keyframes
Definition: avformat.h:2417
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
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:253
#define AVIO_SEEKABLE_NORMAL
Seeking works like for a local file.
Definition: avio.h:40
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:364
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:734
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:337
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:750
#define AV_RL32
Definition: intreadwrite.h:146
#define flags(name, subs,...)
Definition: cbs_av1.c:561
#define s(width, name)
Definition: cbs_vp9.c:257
audio channel layout utility functions
#define MKTAG(a, b, c, d)
Definition: common.h:478
#define NULL
Definition: coverity.c:32
#define AV_CH_LAYOUT_MONO
#define AV_CH_LAYOUT_STEREO
@ AV_CODEC_ID_NONE
Definition: codec_id.h:47
@ AV_CODEC_ID_BINKAUDIO_DCT
Definition: codec_id.h:472
@ AV_CODEC_ID_BINKVIDEO
Definition: codec_id.h:184
@ AV_CODEC_ID_BINKAUDIO_RDFT
Definition: codec_id.h:471
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: packet.h:410
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4505
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:2011
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags)
Get the index for a specific timestamp.
Definition: utils.c:2128
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
#define AVERROR_EOF
End of file.
Definition: error.h:55
#define AVERROR(e)
Definition: error.h:43
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:200
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:194
static av_always_inline AVRational av_inv_q(AVRational q)
Invert a rational.
Definition: rational.h:159
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
#define AV_STRINGIFY(s)
Definition: macros.h:36
int i
Definition: input.c:407
#define AV_RN32(p)
Definition: intreadwrite.h:364
#define AV_WL32(p, v)
Definition: intreadwrite.h:426
static const char signature[]
Definition: ipmovie.c:615
static int read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
Definition: bink.c:306
#define BINK_MAX_HEIGHT
Definition: bink.c:47
static int read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: bink.c:237
AVInputFormat ff_bink_demuxer
Definition: bink.c:326
#define BINK_MAX_AUDIO_TRACKS
Definition: bink.c:45
BinkAudFlags
Definition: bink.c:38
@ BINK_AUD_16BITS
prefer 16-bit output
Definition: bink.c:39
@ BINK_AUD_USEDCT
Definition: bink.c:41
@ BINK_AUD_STEREO
Definition: bink.c:40
#define BINK_MAX_WIDTH
Definition: bink.c:46
#define SMUSH_BLOCK_SIZE
Definition: bink.c:48
static int read_header(AVFormatContext *s)
Definition: bink.c:85
static int probe(const AVProbeData *p)
Definition: bink.c:63
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:4941
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:3312
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:3330
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
common internal API header
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
unsigned int pos
Definition: spdifenc.c:412
uint64_t channel_layout
Audio only.
Definition: codec_par.h:162
int channels
Audio only.
Definition: codec_par.h:166
int width
Video only.
Definition: codec_par.h:126
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:56
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: codec_par.h:64
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: codec_par.h:74
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:60
int sample_rate
Audio only.
Definition: codec_par.h:170
Format I/O context.
Definition: avformat.h:1232
Bytestream IO Context.
Definition: avio.h:161
int64_t pos
Definition: avformat.h:804
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:645
This structure stores compressed data.
Definition: packet.h:346
int stream_index
Definition: packet.h:371
int flags
A combination of AV_PKT_FLAG values.
Definition: packet.h:375
int size
Definition: packet.h:370
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:362
uint8_t * data
Definition: packet.h:369
This structure contains the data a format has to probe a file.
Definition: avformat.h:441
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:444
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:443
Stream structure.
Definition: avformat.h:873
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1038
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:922
AVRational avg_frame_rate
Average framerate.
Definition: avformat.h:946
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.
Definition: avformat.h:902
AVIndexEntry * index_entries
Only used if the format does not support seeking natively.
Definition: avformat.h:1090
int64_t audio_pts[BINK_MAX_AUDIO_TRACKS]
Definition: bink.c:56
int64_t video_pts
Definition: bink.c:55
int smush_size
Definition: bink.c:60
uint32_t remain_packet_size
Definition: bink.c:58
int current_track
audio track to return in next packet
Definition: bink.c:54
uint32_t file_size
Definition: bink.c:51
uint32_t num_audio_tracks
Definition: bink.c:53
#define av_log(a,...)
AVPacket * pkt
Definition: movenc.c:59
const char * b
Definition: vf_curves.c:118