FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
brstm.c
Go to the documentation of this file.
1 /*
2  * BRSTM demuxer
3  * Copyright (c) 2012 Paul B Mahol
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 #include "libavutil/intreadwrite.h"
23 #include "libavcodec/bytestream.h"
24 #include "avformat.h"
25 #include "internal.h"
26 
27 typedef struct BRSTMDemuxContext {
28  uint32_t block_size;
29  uint32_t block_count;
30  uint32_t current_block;
33  uint32_t last_block_size;
35  uint32_t data_start;
40 
41 static int probe(AVProbeData *p)
42 {
43  if (AV_RL32(p->buf) == MKTAG('R','S','T','M') &&
44  (AV_RL16(p->buf + 4) == 0xFFFE ||
45  AV_RL16(p->buf + 4) == 0xFEFF))
46  return AVPROBE_SCORE_MAX / 3 * 2;
47  return 0;
48 }
49 
50 static int probe_bfstm(AVProbeData *p)
51 {
52  if ((AV_RL32(p->buf) == MKTAG('F','S','T','M') ||
53  AV_RL32(p->buf) == MKTAG('C','S','T','M')) &&
54  (AV_RL16(p->buf + 4) == 0xFFFE ||
55  AV_RL16(p->buf + 4) == 0xFEFF))
56  return AVPROBE_SCORE_MAX / 3 * 2;
57  return 0;
58 }
59 
61 {
63 
64  av_freep(&b->table);
65  av_freep(&b->adpc);
66 
67  return 0;
68 }
69 
71 {
73  if (b->little_endian)
74  return avio_rl16(s->pb);
75  else
76  return avio_rb16(s->pb);
77 }
78 
80 {
82  if (b->little_endian)
83  return avio_rl32(s->pb);
84  else
85  return avio_rb32(s->pb);
86 }
87 
89 {
91  int bom, major, minor, codec, chunk;
92  int64_t h1offset, pos, toffset;
93  uint32_t size, asize, start = 0;
94  AVStream *st;
95  int ret = AVERROR_EOF;
96  int loop = 0;
97  int bfstm = !strcmp("bfstm", s->iformat->name);
98 
99  st = avformat_new_stream(s, NULL);
100  if (!st)
101  return AVERROR(ENOMEM);
103 
104  avio_skip(s->pb, 4);
105 
106  bom = avio_rb16(s->pb);
107  if (bom != 0xFEFF && bom != 0xFFFE) {
108  av_log(s, AV_LOG_ERROR, "invalid byte order: %X\n", bom);
109  return AVERROR_INVALIDDATA;
110  }
111 
112  if (bom == 0xFFFE)
113  b->little_endian = 1;
114 
115  if (!bfstm) {
116  major = avio_r8(s->pb);
117  minor = avio_r8(s->pb);
118  avio_skip(s->pb, 4); // size of file
119  size = read16(s);
120  if (size < 14)
121  return AVERROR_INVALIDDATA;
122 
123  avio_skip(s->pb, size - 14);
124  pos = avio_tell(s->pb);
125  if (avio_rl32(s->pb) != MKTAG('H','E','A','D'))
126  return AVERROR_INVALIDDATA;
127  } else {
128  uint32_t info_offset = 0, info_size;
129  uint16_t section_count, header_size, i;
130 
131  header_size = read16(s); // 6
132 
133  avio_skip(s->pb, 4); // Unknown constant 0x00030000
134  avio_skip(s->pb, 4); // size of file
135  section_count = read16(s);
136  avio_skip(s->pb, 2); // padding
137  for (i = 0; avio_tell(s->pb) < header_size
138  && !(start && info_offset)
139  && i < section_count; i++) {
140  uint16_t flag = read16(s);
141  avio_skip(s->pb, 2);
142  switch (flag) {
143  case 0x4000:
144  info_offset = read32(s);
145  info_size = read32(s);
146  break;
147  case 0x4001:
148  avio_skip(s->pb, 4); // seek offset
149  avio_skip(s->pb, 4); // seek size
150  break;
151  case 0x4002:
152  start = read32(s) + 8;
153  avio_skip(s->pb, 4); //data_size = read32(s);
154  break;
155  case 0x4003:
156  avio_skip(s->pb, 4); // REGN offset
157  avio_skip(s->pb, 4); // REGN size
158  break;
159  }
160  }
161 
162  if (!info_offset || !start)
163  return AVERROR_INVALIDDATA;
164 
165  avio_skip(s->pb, info_offset - avio_tell(s->pb));
166  pos = avio_tell(s->pb);
167  if (avio_rl32(s->pb) != MKTAG('I','N','F','O'))
168  return AVERROR_INVALIDDATA;
169  }
170 
171  size = read32(s);
172  if (size < 192)
173  return AVERROR_INVALIDDATA;
174  avio_skip(s->pb, 4); // unknown
175  h1offset = read32(s);
176  if (h1offset > size)
177  return AVERROR_INVALIDDATA;
178  avio_skip(s->pb, 12);
179  toffset = read32(s) + 16LL;
180  if (toffset > size)
181  return AVERROR_INVALIDDATA;
182 
183  avio_skip(s->pb, pos + h1offset + 8 - avio_tell(s->pb));
184  codec = avio_r8(s->pb);
185 
186  switch (codec) {
187  case 0: codec = AV_CODEC_ID_PCM_S8_PLANAR; break;
188  case 1: codec = b->little_endian ?
191  case 2: codec = b->little_endian ?
193  AV_CODEC_ID_ADPCM_THP; break;
194  default:
195  avpriv_request_sample(s, "codec %d", codec);
196  return AVERROR_PATCHWELCOME;
197  }
198 
199  loop = avio_r8(s->pb); // loop flag
200  st->codec->codec_id = codec;
201  st->codec->channels = avio_r8(s->pb);
202  if (!st->codec->channels)
203  return AVERROR_INVALIDDATA;
204 
205  avio_skip(s->pb, 1); // padding
206 
207  st->codec->sample_rate = bfstm ? read32(s) : read16(s);
208  if (!st->codec->sample_rate)
209  return AVERROR_INVALIDDATA;
210 
211  if (!bfstm)
212  avio_skip(s->pb, 2); // padding
213 
214  if (loop) {
215  if (av_dict_set_int(&s->metadata, "loop_start",
217  st->codec->sample_rate),
218  0) < 0)
219  return AVERROR(ENOMEM);
220  } else {
221  avio_skip(s->pb, 4);
222  }
223 
224  st->start_time = 0;
225  st->duration = read32(s);
226  avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
227 
228  if (!bfstm)
229  start = read32(s);
230  b->current_block = 0;
231  b->block_count = read32(s);
232  if (b->block_count > UINT16_MAX) {
233  av_log(s, AV_LOG_WARNING, "too many blocks: %u\n", b->block_count);
234  return AVERROR_INVALIDDATA;
235  }
236 
237  b->block_size = read32(s);
238  if (b->block_size > UINT32_MAX / st->codec->channels)
239  return AVERROR_INVALIDDATA;
240 
241  b->samples_per_block = read32(s);
243  b->last_block_samples = read32(s);
244  b->last_block_size = read32(s);
245  if (b->last_block_size > UINT32_MAX / st->codec->channels)
246  return AVERROR_INVALIDDATA;
248  return AVERROR_INVALIDDATA;
249 
250 
251  if (codec == AV_CODEC_ID_ADPCM_THP || codec == AV_CODEC_ID_ADPCM_THP_LE) {
252  int ch;
253 
254  avio_skip(s->pb, pos + toffset - avio_tell(s->pb));
255  if (!bfstm)
256  toffset = read32(s) + 16LL;
257  else
258  toffset = toffset + read32(s) + st->codec->channels * 8 - 8;
259  if (toffset > size)
260  return AVERROR_INVALIDDATA;
261 
262  avio_skip(s->pb, pos + toffset - avio_tell(s->pb));
263  b->table = av_mallocz(32 * st->codec->channels);
264  if (!b->table)
265  return AVERROR(ENOMEM);
266 
267  for (ch = 0; ch < st->codec->channels; ch++) {
268  if (avio_read(s->pb, b->table + ch * 32, 32) != 32) {
269  ret = AVERROR_INVALIDDATA;
270  goto fail;
271  }
272  avio_skip(s->pb, bfstm ? 14 : 24);
273  }
274  }
275 
276  if (size < (avio_tell(s->pb) - pos)) {
277  ret = AVERROR_INVALIDDATA;
278  goto fail;
279  }
280 
281  avio_skip(s->pb, size - (avio_tell(s->pb) - pos));
282 
283  while (!avio_feof(s->pb)) {
284  chunk = avio_rl32(s->pb);
285  size = read32(s);
286  if (size < 8) {
287  ret = AVERROR_INVALIDDATA;
288  goto fail;
289  }
290  size -= 8;
291  switch (chunk) {
292  case MKTAG('S','E','E','K'):
293  case MKTAG('A','D','P','C'):
294  if (codec != AV_CODEC_ID_ADPCM_THP &&
295  codec != AV_CODEC_ID_ADPCM_THP_LE)
296  goto skip;
297 
298  asize = b->block_count * st->codec->channels * 4;
299  if (size < asize) {
300  ret = AVERROR_INVALIDDATA;
301  goto fail;
302  }
303  if (b->adpc) {
304  av_log(s, AV_LOG_WARNING, "skipping additional ADPC chunk\n");
305  goto skip;
306  } else {
307  b->adpc = av_mallocz(asize);
308  if (!b->adpc) {
309  ret = AVERROR(ENOMEM);
310  goto fail;
311  }
312  if (bfstm && codec != AV_CODEC_ID_ADPCM_THP_LE) {
313  // Big-endian BFSTMs have little-endian SEEK tables
314  // for some strange reason.
315  int i;
316  for (i = 0; i < asize; i += 2) {
317  b->adpc[i+1] = avio_r8(s->pb);
318  b->adpc[i] = avio_r8(s->pb);
319  }
320  } else {
321  avio_read(s->pb, b->adpc, asize);
322  }
323  avio_skip(s->pb, size - asize);
324  }
325  break;
326  case MKTAG('D','A','T','A'):
327  if ((start < avio_tell(s->pb)) ||
328  (!b->adpc && (codec == AV_CODEC_ID_ADPCM_THP ||
329  codec == AV_CODEC_ID_ADPCM_THP_LE))) {
330  ret = AVERROR_INVALIDDATA;
331  goto fail;
332  }
333  avio_skip(s->pb, start - avio_tell(s->pb));
334 
335  if (bfstm && (codec == AV_CODEC_ID_ADPCM_THP ||
336  codec == AV_CODEC_ID_ADPCM_THP_LE))
337  avio_skip(s->pb, 24);
338 
339  b->data_start = avio_tell(s->pb);
340 
341  if (!bfstm && (major != 1 || minor))
342  avpriv_request_sample(s, "Version %d.%d", major, minor);
343 
344  return 0;
345  default:
346  av_log(s, AV_LOG_WARNING, "skipping unknown chunk: %X\n", chunk);
347 skip:
348  avio_skip(s->pb, size);
349  }
350  }
351 
352 fail:
353  read_close(s);
354 
355  return ret;
356 }
357 
359 {
360  AVCodecContext *codec = s->streams[0]->codec;
362  uint32_t samples, size, skip = 0;
363  int ret, i;
364 
365  if (avio_feof(s->pb))
366  return AVERROR_EOF;
367  b->current_block++;
368  if (b->current_block == b->block_count) {
369  size = b->last_block_used_bytes;
370  samples = b->last_block_samples;
371  skip = b->last_block_size - b->last_block_used_bytes;
372 
373  if (samples < size * 14 / 8) {
374  uint32_t adjusted_size = samples / 14 * 8;
375  if (samples % 14)
376  adjusted_size += (samples % 14 + 1) / 2 + 1;
377 
378  skip += size - adjusted_size;
379  size = adjusted_size;
380  }
381  } else if (b->current_block < b->block_count) {
382  size = b->block_size;
383  samples = b->samples_per_block;
384  } else {
385  return AVERROR_EOF;
386  }
387 
388  if (codec->codec_id == AV_CODEC_ID_ADPCM_THP ||
390  uint8_t *dst;
391 
392  if (av_new_packet(pkt, 8 + (32 + 4 + size) * codec->channels) < 0)
393  return AVERROR(ENOMEM);
394  dst = pkt->data;
395  if (codec->codec_id == AV_CODEC_ID_ADPCM_THP_LE) {
396  bytestream_put_le32(&dst, size * codec->channels);
397  bytestream_put_le32(&dst, samples);
398  } else {
399  bytestream_put_be32(&dst, size * codec->channels);
400  bytestream_put_be32(&dst, samples);
401  }
402  bytestream_put_buffer(&dst, b->table, 32 * codec->channels);
403  bytestream_put_buffer(&dst, b->adpc + 4 * codec->channels *
404  (b->current_block - 1), 4 * codec->channels);
405 
406  for (i = 0; i < codec->channels; i++) {
407  ret = avio_read(s->pb, dst, size);
408  dst += size;
409  avio_skip(s->pb, skip);
410  if (ret != size) {
411  av_free_packet(pkt);
412  break;
413  }
414  }
415  pkt->duration = samples;
416  } else {
417  size *= codec->channels;
418  ret = av_get_packet(s->pb, pkt, size);
419  }
420 
421  pkt->stream_index = 0;
422 
423  if (ret != size)
424  ret = AVERROR(EIO);
425 
426  return ret;
427 }
428 
429 static int read_seek(AVFormatContext *s, int stream_index,
430  int64_t timestamp, int flags)
431 {
432  AVStream *st = s->streams[stream_index];
434  int64_t ret = 0;
435 
436  timestamp /= b->samples_per_block;
437  ret = avio_seek(s->pb, b->data_start + timestamp * b->block_size *
438  st->codec->channels, SEEK_SET);
439  if (ret < 0)
440  return ret;
441 
442  b->current_block = timestamp;
443  ff_update_cur_dts(s, st, timestamp * b->samples_per_block);
444  return 0;
445 }
446 
448  .name = "brstm",
449  .long_name = NULL_IF_CONFIG_SMALL("BRSTM (Binary Revolution Stream)"),
450  .priv_data_size = sizeof(BRSTMDemuxContext),
451  .read_probe = probe,
455  .read_seek = read_seek,
456  .extensions = "brstm",
457 };
458 
460  .name = "bfstm",
461  .long_name = NULL_IF_CONFIG_SMALL("BFSTM (Binary Cafe Stream)"),
462  .priv_data_size = sizeof(BRSTMDemuxContext),
467  .read_seek = read_seek,
468  .extensions = "bfstm,bcstm",
469 };
#define NULL
Definition: coverity.c:32
const char * s
Definition: avisynth_c.h:631
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
void av_free_packet(AVPacket *pkt)
Free a packet.
Definition: avpacket.c:280
uint32_t block_count
Definition: brstm.c:29
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
uint32_t data_start
Definition: brstm.c:35
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:4006
AVInputFormat ff_bfstm_demuxer
Definition: brstm.c:459
const char * b
Definition: vf_curves.c:109
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:204
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:277
static AVPacket pkt
unsigned int avio_rb16(AVIOContext *s)
Definition: aviobuf.c:675
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_RL16
Definition: bytestream.h:85
static av_always_inline unsigned int read16(AVFormatContext *s)
Definition: brstm.c:70
Format I/O context.
Definition: avformat.h:1272
void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp)
Update cur_dts of all streams based on the given timestamp and AVStream.
Definition: utils.c:1656
static int probe_bfstm(AVProbeData *p)
Definition: brstm.c:50
void void avpriv_request_sample(void *avc, const char *msg,...) av_printf_format(2
Log a generic warning message about a missing feature.
uint8_t
unsigned int avio_rb32(AVIOContext *s)
Definition: aviobuf.c:690
uint32_t block_size
Definition: brstm.c:28
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:3672
static int probe(AVProbeData *p)
Definition: brstm.c:41
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1340
uint8_t * data
Definition: avcodec.h:1173
uint32_t samples_per_block
Definition: brstm.c:31
#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:241
ptrdiff_t size
Definition: opengl_enc.c:101
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:390
int duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: avcodec.h:1191
static const char * bom
Definition: microdvddec.c:77
#define av_log(a,...)
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:538
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:83
uint32_t last_block_samples
Definition: brstm.c:34
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
AVDictionary * metadata
Metadata that applies to the whole file.
Definition: avformat.h:1482
uint32_t last_block_used_bytes
Definition: brstm.c:32
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:659
#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:175
int avio_r8(AVIOContext *s)
Definition: aviobuf.c:529
AVCodecContext * codec
Codec context associated with this stream.
Definition: avformat.h:861
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:450
int64_t av_rescale(int64_t a, int64_t b, int64_t c)
Rescale a 64-bit integer with rounding to nearest.
Definition: mathematics.c:127
#define AV_TIME_BASE
Internal time base represented as integer.
Definition: avutil.h:254
uint32_t current_block
Definition: brstm.c:30
static int read_probe(AVProbeData *pd)
Definition: jvdec.c:55
ret
Definition: avfilter.c:974
static int read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
Definition: brstm.c:429
uint8_t * table
Definition: brstm.c:36
Stream structure.
Definition: avformat.h:842
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:62
uint8_t * adpc
Definition: brstm.c:37
enum AVMediaType codec_type
Definition: avcodec.h:1260
enum AVCodecID codec_id
Definition: avcodec.h:1269
int sample_rate
samples per second
Definition: avcodec.h:2010
AVIOContext * pb
I/O context.
Definition: avformat.h:1314
static int loop
Definition: ffplay.c:329
main external API structure.
Definition: avcodec.h:1252
int little_endian
Definition: brstm.c:38
This structure contains the data a format has to probe a file.
Definition: avformat.h:448
static int flags
Definition: cpu.c:47
AVInputFormat ff_brstm_demuxer
Definition: brstm.c:447
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:901
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:460
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:643
Main libavformat public API header.
int64_t start_time
Decoding: pts of the first frame of the stream in presentation order, in stream time base...
Definition: avformat.h:894
int av_dict_set_int(AVDictionary **pm, const char *key, int64_t value, int flags)
Convenience wrapper for av_dict_set that converts the value to a string and stores it...
Definition: dict.c:143
struct AVInputFormat * iformat
The input container format.
Definition: avformat.h:1284
static int read_header(AVFormatContext *s)
Definition: brstm.c:88
static av_always_inline void bytestream_put_buffer(uint8_t **b, const uint8_t *src, unsigned int size)
Definition: bytestream.h:366
int channels
number of audio channels
Definition: avcodec.h:2011
void * priv_data
Format private data.
Definition: avformat.h:1300
static av_always_inline unsigned int read32(AVFormatContext *s)
Definition: brstm.c:79
static int read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: brstm.c:358
#define av_freep(p)
void INT64 start
Definition: avisynth_c.h:553
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:628
#define av_always_inline
Definition: attributes.h:37
static int read_close(AVFormatContext *s)
Definition: brstm.c:60
int avio_feof(AVIOContext *s)
feof() equivalent for AVIOContext.
Definition: aviobuf.c:301
int stream_index
Definition: avcodec.h:1175
#define MKTAG(a, b, c, d)
Definition: common.h:315
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:85
This structure stores compressed data.
Definition: avcodec.h:1150
uint32_t last_block_size
Definition: brstm.c:33
void * av_mallocz(size_t size)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:250