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' && /* 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 
96  vst = avformat_new_stream(s, NULL);
97  if (!vst)
98  return AVERROR(ENOMEM);
99 
100  vst->codecpar->codec_tag = avio_rl32(pb);
101  if (vst->codecpar->codec_tag == AV_RL32("SMUS")) {
102  do {
103  bink->smush_size += SMUSH_BLOCK_SIZE;
104  avio_skip(pb, SMUSH_BLOCK_SIZE - 4);
105  vst->codecpar->codec_tag = avio_rl32(pb);
106  } while (!avio_feof(pb) && (vst->codecpar->codec_tag & 0xFFFFFF) != AV_RL32("BIK"));
107  if (avio_feof(pb)) {
108  av_log(s, AV_LOG_ERROR, "invalid SMUSH header: BIK not found\n");
109  return AVERROR_INVALIDDATA;
110  }
111  }
112 
113  bink->file_size = avio_rl32(pb) + 8;
114  vst->duration = avio_rl32(pb);
115 
116  if (vst->duration > 1000000) {
117  av_log(s, AV_LOG_ERROR, "invalid header: more than 1000000 frames\n");
118  return AVERROR(EIO);
119  }
120 
121  if (avio_rl32(pb) > bink->file_size) {
122  av_log(s, AV_LOG_ERROR,
123  "invalid header: largest frame size greater than file size\n");
124  return AVERROR(EIO);
125  }
126 
127  avio_skip(pb, 4);
128 
129  vst->codecpar->width = avio_rl32(pb);
130  vst->codecpar->height = avio_rl32(pb);
131 
132  fps_num = avio_rl32(pb);
133  fps_den = avio_rl32(pb);
134  if (fps_num == 0 || fps_den == 0) {
135  av_log(s, AV_LOG_ERROR,
136  "invalid header: invalid fps (%"PRIu32"/%"PRIu32")\n",
137  fps_num, fps_den);
138  return AVERROR(EIO);
139  }
140  avpriv_set_pts_info(vst, 64, fps_den, fps_num);
141  vst->avg_frame_rate = av_inv_q(vst->time_base);
142 
145 
146  if ((vst->codecpar->codec_tag & 0xFFFFFF) == MKTAG('K', 'B', '2', 0)) {
147  av_log(s, AV_LOG_WARNING, "Bink 2 video is not implemented\n");
149  }
150 
151  if (ff_get_extradata(s, vst->codecpar, pb, 4) < 0)
152  return AVERROR(ENOMEM);
153 
154  bink->num_audio_tracks = avio_rl32(pb);
155 
157  av_log(s, AV_LOG_ERROR,
158  "invalid header: more than "AV_STRINGIFY(BINK_MAX_AUDIO_TRACKS)" audio tracks (%"PRIu32")\n",
159  bink->num_audio_tracks);
160  return AVERROR(EIO);
161  }
162 
163  if (bink->num_audio_tracks) {
164  uint32_t signature = (vst->codecpar->codec_tag & 0xFFFFFF);
165  uint8_t revision = ((vst->codecpar->codec_tag >> 24) % 0xFF);
166 
167  if ((signature == AV_RL32("BIK") && (revision == 0x6b)) || /* k */
168  (signature == AV_RL32("KB2") && (revision == 0x69 || revision == 0x6a || revision == 0x6b))) /* i,j,k */
169  avio_skip(pb, 4); /* unknown new field */
170 
171  avio_skip(pb, 4 * bink->num_audio_tracks); /* max decoded size */
172 
173  for (i = 0; i < bink->num_audio_tracks; i++) {
174  ast = avformat_new_stream(s, NULL);
175  if (!ast)
176  return AVERROR(ENOMEM);
178  ast->codecpar->codec_tag = 0;
179  ast->codecpar->sample_rate = avio_rl16(pb);
180  avpriv_set_pts_info(ast, 64, 1, ast->codecpar->sample_rate);
181  flags = avio_rl16(pb);
182  ast->codecpar->codec_id = flags & BINK_AUD_USEDCT ?
184  if (flags & BINK_AUD_STEREO) {
185  ast->codecpar->channels = 2;
187  } else {
188  ast->codecpar->channels = 1;
190  }
191  if (ff_alloc_extradata(ast->codecpar, 4))
192  return AVERROR(ENOMEM);
194  }
195 
196  for (i = 0; i < bink->num_audio_tracks; i++)
197  s->streams[i + 1]->id = avio_rl32(pb);
198  }
199 
200  /* frame index table */
201  next_pos = avio_rl32(pb);
202  for (i = 0; i < vst->duration; i++) {
203  pos = next_pos;
204  if (i == vst->duration - 1) {
205  next_pos = bink->file_size;
206  keyframe = 0;
207  } else {
208  next_pos = avio_rl32(pb);
209  keyframe = pos & 1;
210  }
211  pos &= ~1;
212  next_pos &= ~1;
213 
214  if (next_pos <= pos) {
215  av_log(s, AV_LOG_ERROR, "invalid frame index table\n");
216  return AVERROR(EIO);
217  }
218  if ((ret = av_add_index_entry(vst, pos, i, next_pos - pos, 0,
219  keyframe ? AVINDEX_KEYFRAME : 0)) < 0)
220  return ret;
221  }
222 
223  if (vst->index_entries)
224  avio_seek(pb, vst->index_entries[0].pos + bink->smush_size, SEEK_SET);
225  else
226  avio_skip(pb, 4);
227 
228  bink->current_track = -1;
229  return 0;
230 }
231 
233 {
234  BinkDemuxContext *bink = s->priv_data;
235  AVIOContext *pb = s->pb;
236  int ret;
237 
238  if (bink->current_track < 0) {
239  int index_entry;
240  AVStream *st = s->streams[0]; // stream 0 is video stream with index
241 
242  if (bink->video_pts >= st->duration)
243  return AVERROR_EOF;
244 
245  index_entry = av_index_search_timestamp(st, bink->video_pts,
247  if (index_entry < 0) {
248  av_log(s, AV_LOG_ERROR,
249  "could not find index entry for frame %"PRId64"\n",
250  bink->video_pts);
251  return AVERROR(EIO);
252  }
253 
254  bink->remain_packet_size = st->index_entries[index_entry].size;
255  bink->current_track = 0;
256  }
257 
258  while (bink->current_track < bink->num_audio_tracks) {
259  uint32_t audio_size = avio_rl32(pb);
260  if (audio_size > bink->remain_packet_size - 4) {
261  av_log(s, AV_LOG_ERROR,
262  "frame %"PRId64": audio size in header (%"PRIu32") > size of packet left (%"PRIu32")\n",
263  bink->video_pts, audio_size, bink->remain_packet_size);
264  return AVERROR(EIO);
265  }
266  bink->remain_packet_size -= 4 + audio_size;
267  bink->current_track++;
268  if (audio_size >= 4) {
269  /* get one audio packet per track */
270  if ((ret = av_get_packet(pb, pkt, audio_size)) < 0)
271  return ret;
272  pkt->stream_index = bink->current_track;
273  pkt->pts = bink->audio_pts[bink->current_track - 1];
274 
275  /* Each audio packet reports the number of decompressed samples
276  (in bytes). We use this value to calculate the audio PTS */
277  if (pkt->size >= 4)
278  bink->audio_pts[bink->current_track -1] +=
279  AV_RL32(pkt->data) / (2 * s->streams[bink->current_track]->codecpar->channels);
280  return 0;
281  } else {
282  avio_skip(pb, audio_size);
283  }
284  }
285 
286  /* get video packet */
287  if ((ret = av_get_packet(pb, pkt, bink->remain_packet_size)) < 0)
288  return ret;
289  pkt->stream_index = 0;
290  pkt->pts = bink->video_pts++;
291  pkt->flags |= AV_PKT_FLAG_KEY;
292 
293  /* -1 instructs the next call to read_packet() to read the next frame */
294  bink->current_track = -1;
295 
296  return 0;
297 }
298 
299 static int read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
300 {
301  BinkDemuxContext *bink = s->priv_data;
302  AVStream *vst = s->streams[0];
303 
304  if (!(s->pb->seekable & AVIO_SEEKABLE_NORMAL))
305  return -1;
306 
307  /* seek to the first frame */
308  if (avio_seek(s->pb, vst->index_entries[0].pos + bink->smush_size, SEEK_SET) < 0)
309  return -1;
310 
311  bink->video_pts = 0;
312  memset(bink->audio_pts, 0, sizeof(bink->audio_pts));
313  bink->current_track = -1;
314  return 0;
315 }
316 
318  .name = "bink",
319  .long_name = NULL_IF_CONFIG_SMALL("Bink"),
320  .priv_data_size = sizeof(BinkDemuxContext),
321  .read_probe = probe,
324  .read_seek = read_seek,
326 };
#define NULL
Definition: coverity.c:32
const char * s
Definition: avisynth_c.h:768
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:1982
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:4741
int64_t pos
Definition: avformat.h:820
#define BINK_MAX_AUDIO_TRACKS
Definition: bink.c:45
#define AVSEEK_FLAG_ANY
seek to any frame, even non-keyframes
Definition: avformat.h:2425
uint32_t file_size
Definition: bink.c:51
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:4152
int size
Definition: avcodec.h:1680
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:244
AVIndexEntry * index_entries
Only used if the format does not support seeking natively.
Definition: avformat.h:1092
BinkAudFlags
Definition: bink.c:38
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:329
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:1349
#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:4218
int current_track
audio track to return in next packet
Definition: bink.c:54
int id
Format-specific stream ID.
Definition: avformat.h:896
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4371
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1417
uint8_t * data
Definition: avcodec.h:1679
static int flags
Definition: log.c:57
#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:4254
#define av_log(a,...)
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1711
AVInputFormat ff_bink_demuxer
Definition: bink.c:317
#define AVINDEX_KEYFRAME
Definition: avformat.h:827
#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:2091
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:759
#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:179
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:4148
#define SMUSH_BLOCK_SIZE
Definition: bink.c:48
AVRational avg_frame_rate
Average framerate.
Definition: avformat.h:970
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:1685
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:261
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:3215
static int read_header(AVFormatContext *s)
Definition: bink.c:84
static int read_probe(AVProbeData *pd)
Definition: jvdec.c:55
Stream structure.
Definition: avformat.h:889
#define AVIO_SEEKABLE_NORMAL
Seeking works like for a local file.
Definition: avio.h:40
AVIOContext * pb
I/O context.
Definition: avformat.h:1391
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:369
int64_t audio_pts[BINK_MAX_AUDIO_TRACKS]
Definition: bink.c:56
static int read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: bink.c:232
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:946
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:4262
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:473
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:743
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:3236
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:299
void * priv_data
Format private data.
Definition: avformat.h:1377
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: avcodec.h:4166
int channels
Audio only.
Definition: avcodec.h:4258
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:664
AVCodecParameters * codecpar
Definition: avformat.h:1252
int avio_feof(AVIOContext *s)
feof() equivalent for AVIOContext.
Definition: aviobuf.c:356
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: avcodec.h:4156
int stream_index
Definition: avcodec.h:1681
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avformat.h:926
#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:1656
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1672
#define AV_WL32(p, v)
Definition: intreadwrite.h:431