FFmpeg  4.1.11
4xm.c
Go to the documentation of this file.
1 /*
2  * 4X Technologies .4xm File Demuxer (no muxer)
3  * Copyright (c) 2003 The FFmpeg project
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 /**
23  * @file
24  * 4X Technologies file demuxer
25  * by Mike Melanson (melanson@pcisys.net)
26  * for more information on the .4xm file format, visit:
27  * http://www.pcisys.net/~melanson/codecs/
28  */
29 
30 #include "libavutil/intreadwrite.h"
31 #include "libavutil/intfloat.h"
32 #include "libavcodec/internal.h"
33 #include "avformat.h"
34 #include "internal.h"
35 
36 #define RIFF_TAG MKTAG('R', 'I', 'F', 'F')
37 #define FOURXMV_TAG MKTAG('4', 'X', 'M', 'V')
38 #define LIST_TAG MKTAG('L', 'I', 'S', 'T')
39 #define HEAD_TAG MKTAG('H', 'E', 'A', 'D')
40 #define TRK__TAG MKTAG('T', 'R', 'K', '_')
41 #define MOVI_TAG MKTAG('M', 'O', 'V', 'I')
42 #define VTRK_TAG MKTAG('V', 'T', 'R', 'K')
43 #define STRK_TAG MKTAG('S', 'T', 'R', 'K')
44 #define std__TAG MKTAG('s', 't', 'd', '_')
45 #define name_TAG MKTAG('n', 'a', 'm', 'e')
46 #define vtrk_TAG MKTAG('v', 't', 'r', 'k')
47 #define strk_TAG MKTAG('s', 't', 'r', 'k')
48 #define ifrm_TAG MKTAG('i', 'f', 'r', 'm')
49 #define pfrm_TAG MKTAG('p', 'f', 'r', 'm')
50 #define cfrm_TAG MKTAG('c', 'f', 'r', 'm')
51 #define ifr2_TAG MKTAG('i', 'f', 'r', '2')
52 #define pfr2_TAG MKTAG('p', 'f', 'r', '2')
53 #define cfr2_TAG MKTAG('c', 'f', 'r', '2')
54 #define snd__TAG MKTAG('s', 'n', 'd', '_')
55 
56 #define vtrk_SIZE 0x44
57 #define strk_SIZE 0x28
58 
59 #define GET_LIST_HEADER() \
60  fourcc_tag = avio_rl32(pb); \
61  size = avio_rl32(pb); \
62  if (fourcc_tag != LIST_TAG) { \
63  ret = AVERROR_INVALIDDATA; \
64  goto fail; \
65  } \
66  fourcc_tag = avio_rl32(pb);
67 
68 typedef struct AudioTrack {
70  int bits;
71  int channels;
73  int adpcm;
74  int64_t audio_pts;
75 } AudioTrack;
76 
77 typedef struct FourxmDemuxContext {
81 
82  int64_t video_pts;
85 
86 static int fourxm_probe(AVProbeData *p)
87 {
88  if ((AV_RL32(&p->buf[0]) != RIFF_TAG) ||
89  (AV_RL32(&p->buf[8]) != FOURXMV_TAG))
90  return 0;
91 
92  return AVPROBE_SCORE_MAX;
93 }
94 
96  FourxmDemuxContext *fourxm, uint8_t *buf, int size,
97  int left)
98 {
99  AVStream *st;
100  /* check that there is enough data */
101  if (size != vtrk_SIZE || left < size + 8) {
102  return AVERROR_INVALIDDATA;
103  }
104 
105  /* allocate a new AVStream */
106  st = avformat_new_stream(s, NULL);
107  if (!st)
108  return AVERROR(ENOMEM);
109 
110  avpriv_set_pts_info(st, 60, fourxm->fps.den, fourxm->fps.num);
111 
112  fourxm->video_stream_index = st->index;
113 
116 
118  if (!st->codecpar->extradata)
119  return AVERROR(ENOMEM);
120  st->codecpar->extradata_size = 4;
121  AV_WL32(st->codecpar->extradata, AV_RL32(buf + 16));
122  st->codecpar->width = AV_RL32(buf + 36);
123  st->codecpar->height = AV_RL32(buf + 40);
124 
125  return 0;
126 }
127 
128 
130  FourxmDemuxContext *fourxm, uint8_t *buf, int size,
131  int left)
132 {
133  AVStream *st;
134  int track;
135  /* check that there is enough data */
136  if (size != strk_SIZE || left < size + 8)
137  return AVERROR_INVALIDDATA;
138 
139  track = AV_RL32(buf + 8);
140  if ((unsigned)track >= UINT_MAX / sizeof(AudioTrack) - 1 ||
141  track >= s->max_streams) {
142  av_log(s, AV_LOG_ERROR, "current_track too large\n");
143  return AVERROR_INVALIDDATA;
144  }
145 
146  if (track + 1 > fourxm->track_count) {
147  if (av_reallocp_array(&fourxm->tracks, track + 1, sizeof(AudioTrack)))
148  return AVERROR(ENOMEM);
149  memset(&fourxm->tracks[fourxm->track_count], 0,
150  sizeof(AudioTrack) * (track + 1 - fourxm->track_count));
151  fourxm->track_count = track + 1;
152  } else {
153  if (fourxm->tracks[track].bits)
154  return AVERROR_INVALIDDATA;
155  }
156  fourxm->tracks[track].adpcm = AV_RL32(buf + 12);
157  fourxm->tracks[track].channels = AV_RL32(buf + 36);
158  fourxm->tracks[track].sample_rate = AV_RL32(buf + 40);
159  fourxm->tracks[track].bits = AV_RL32(buf + 44);
160  fourxm->tracks[track].audio_pts = 0;
161 
162  if (fourxm->tracks[track].channels <= 0 ||
163  fourxm->tracks[track].channels > FF_SANE_NB_CHANNELS ||
164  fourxm->tracks[track].sample_rate <= 0 ||
165  fourxm->tracks[track].bits <= 0 ||
166  fourxm->tracks[track].bits > INT_MAX / FF_SANE_NB_CHANNELS) {
167  av_log(s, AV_LOG_ERROR, "audio header invalid\n");
168  return AVERROR_INVALIDDATA;
169  }
170  if (!fourxm->tracks[track].adpcm && fourxm->tracks[track].bits<8) {
171  av_log(s, AV_LOG_ERROR, "bits unspecified for non ADPCM\n");
172  return AVERROR_INVALIDDATA;
173  }
174 
175  if (fourxm->tracks[track].sample_rate > INT64_MAX / fourxm->tracks[track].bits / fourxm->tracks[track].channels) {
176  av_log(s, AV_LOG_ERROR, "Overflow during bit rate calculation %d * %d * %d\n",
177  fourxm->tracks[track].sample_rate, fourxm->tracks[track].bits, fourxm->tracks[track].channels);
178  return AVERROR_INVALIDDATA;
179  }
180 
181  /* allocate a new AVStream */
182  st = avformat_new_stream(s, NULL);
183  if (!st)
184  return AVERROR(ENOMEM);
185 
186  st->id = track;
187  avpriv_set_pts_info(st, 60, 1, fourxm->tracks[track].sample_rate);
188 
189  fourxm->tracks[track].stream_index = st->index;
190 
192  st->codecpar->codec_tag = 0;
193  st->codecpar->channels = fourxm->tracks[track].channels;
194  st->codecpar->sample_rate = fourxm->tracks[track].sample_rate;
195  st->codecpar->bits_per_coded_sample = fourxm->tracks[track].bits;
196  st->codecpar->bit_rate = (int64_t)st->codecpar->channels *
197  st->codecpar->sample_rate *
199  st->codecpar->block_align = st->codecpar->channels *
201 
202  if (fourxm->tracks[track].adpcm){
204  } else if (st->codecpar->bits_per_coded_sample == 8) {
206  } else
208 
209  return 0;
210 }
211 
213 {
214  AVIOContext *pb = s->pb;
215  unsigned int fourcc_tag;
216  unsigned int size;
217  int header_size;
218  FourxmDemuxContext *fourxm = s->priv_data;
219  unsigned char *header = NULL;
220  int i, ret;
221 
222  fourxm->track_count = 0;
223  fourxm->tracks = NULL;
224  fourxm->fps = (AVRational){1,1};
225  fourxm->video_stream_index = -1;
226 
227  /* skip the first 3 32-bit numbers */
228  avio_skip(pb, 12);
229 
230  /* check for LIST-HEAD */
231  GET_LIST_HEADER();
232  header_size = size - 4;
233  if (fourcc_tag != HEAD_TAG || header_size < 0)
234  return AVERROR_INVALIDDATA;
235 
236  /* allocate space for the header and load the whole thing */
237  header = av_malloc(header_size);
238  if (!header)
239  return AVERROR(ENOMEM);
240  if (avio_read(pb, header, header_size) != header_size) {
241  av_free(header);
242  return AVERROR(EIO);
243  }
244 
245  /* take the lazy approach and search for any and all vtrk and strk chunks */
246  for (i = 0; i < header_size - 8; i++) {
247  fourcc_tag = AV_RL32(&header[i]);
248  size = AV_RL32(&header[i + 4]);
249  if (size > header_size - i - 8 && (fourcc_tag == vtrk_TAG || fourcc_tag == strk_TAG)) {
250  av_log(s, AV_LOG_ERROR, "chunk larger than array %d>%d\n", size, header_size - i - 8);
251  return AVERROR_INVALIDDATA;
252  }
253 
254  if (fourcc_tag == std__TAG) {
255  if (header_size - i < 16) {
256  av_log(s, AV_LOG_ERROR, "std TAG truncated\n");
257  ret = AVERROR_INVALIDDATA;
258  goto fail;
259  }
260  fourxm->fps = av_d2q(av_int2float(AV_RL32(&header[i + 12])), 10000);
261  } else if (fourcc_tag == vtrk_TAG) {
262  if ((ret = parse_vtrk(s, fourxm, header + i, size,
263  header_size - i)) < 0)
264  goto fail;
265 
266  i += 8 + size;
267  } else if (fourcc_tag == strk_TAG) {
268  if ((ret = parse_strk(s, fourxm, header + i, size,
269  header_size - i)) < 0)
270  goto fail;
271 
272  i += 8 + size;
273  }
274  }
275 
276  /* skip over the LIST-MOVI chunk (which is where the stream should be */
277  GET_LIST_HEADER();
278  if (fourcc_tag != MOVI_TAG) {
279  ret = AVERROR_INVALIDDATA;
280  goto fail;
281  }
282 
283  av_free(header);
284  /* initialize context members */
285  fourxm->video_pts = -1; /* first frame will push to 0 */
286 
287  return 0;
288 fail:
289  av_freep(&fourxm->tracks);
290  av_free(header);
291  return ret;
292 }
293 
295  AVPacket *pkt)
296 {
297  FourxmDemuxContext *fourxm = s->priv_data;
298  AVIOContext *pb = s->pb;
299  unsigned int fourcc_tag;
300  unsigned int size;
301  int ret = 0;
302  unsigned int track_number;
303  int packet_read = 0;
304  unsigned char header[8];
305  int64_t audio_frame_count;
306 
307  while (!packet_read) {
308  if ((ret = avio_read(s->pb, header, 8)) < 0)
309  return ret;
310  fourcc_tag = AV_RL32(&header[0]);
311  size = AV_RL32(&header[4]);
312  if (avio_feof(pb))
313  return AVERROR(EIO);
314  switch (fourcc_tag) {
315  case LIST_TAG:
316  /* this is a good time to bump the video pts */
317  fourxm->video_pts++;
318 
319  /* skip the LIST-* tag and move on to the next fourcc */
320  avio_rl32(pb);
321  break;
322 
323  case ifrm_TAG:
324  case pfrm_TAG:
325  case cfrm_TAG:
326  case ifr2_TAG:
327  case pfr2_TAG:
328  case cfr2_TAG:
329  /* allocate 8 more bytes than 'size' to account for fourcc
330  * and size */
331  if (fourxm->video_stream_index < 0)
332  return AVERROR_INVALIDDATA;
333  if (size + 8 < size || av_new_packet(pkt, size + 8))
334  return AVERROR(EIO);
335  pkt->stream_index = fourxm->video_stream_index;
336  pkt->pts = fourxm->video_pts;
337  pkt->pos = avio_tell(s->pb);
338  memcpy(pkt->data, header, 8);
339  ret = avio_read(s->pb, &pkt->data[8], size);
340 
341  if (ret < 0) {
342  av_packet_unref(pkt);
343  } else {
344  packet_read = 1;
345  av_shrink_packet(pkt, ret + 8);
346  }
347  break;
348 
349  case snd__TAG:
350  track_number = avio_rl32(pb);
351  avio_skip(pb, 4);
352  size -= 8;
353 
354  if (track_number < fourxm->track_count &&
355  fourxm->tracks[track_number].channels > 0) {
356  ret = av_get_packet(s->pb, pkt, size);
357  if (ret < 0)
358  return AVERROR(EIO);
359  pkt->stream_index =
360  fourxm->tracks[track_number].stream_index;
361  pkt->pts = fourxm->tracks[track_number].audio_pts;
362  packet_read = 1;
363 
364  /* pts accounting */
365  audio_frame_count = size;
366  if (fourxm->tracks[track_number].adpcm)
367  audio_frame_count -= 2 * (fourxm->tracks[track_number].channels);
368  audio_frame_count /= fourxm->tracks[track_number].channels;
369  if (fourxm->tracks[track_number].adpcm) {
370  audio_frame_count *= 2;
371  } else
372  audio_frame_count /=
373  (fourxm->tracks[track_number].bits / 8);
374  fourxm->tracks[track_number].audio_pts += audio_frame_count;
375  } else {
376  avio_skip(pb, size);
377  }
378  break;
379 
380  default:
381  avio_skip(pb, size);
382  break;
383  }
384  }
385  return ret;
386 }
387 
389 {
390  FourxmDemuxContext *fourxm = s->priv_data;
391 
392  av_freep(&fourxm->tracks);
393 
394  return 0;
395 }
396 
398  .name = "4xm",
399  .long_name = NULL_IF_CONFIG_SMALL("4X Technologies"),
400  .priv_data_size = sizeof(FourxmDemuxContext),
405 };
#define FF_SANE_NB_CHANNELS
Definition: internal.h:86
#define NULL
Definition: coverity.c:32
int sample_rate
Definition: 4xm.c:69
Bytestream IO Context.
Definition: avio.h:161
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
int size
static int fourxm_probe(AVProbeData *p)
Definition: 4xm.c:86
int64_t audio_pts
Definition: 4xm.c:74
int64_t pos
byte position in stream, -1 if unknown
Definition: avcodec.h:1465
void av_shrink_packet(AVPacket *pkt, int size)
Reduce packet size, correctly zeroing padding.
Definition: avpacket.c:101
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:4899
#define ifr2_TAG
Definition: 4xm.c:51
static av_always_inline float av_int2float(uint32_t i)
Reinterpret a 32-bit integer as a float.
Definition: intfloat.h:40
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:3900
int num
Numerator.
Definition: rational.h:59
int index
stream index in AVFormatContext
Definition: avformat.h:875
static int audio_frame_count
#define strk_SIZE
Definition: 4xm.c:57
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:331
static int parse_vtrk(AVFormatContext *s, FourxmDemuxContext *fourxm, uint8_t *buf, int size, int left)
Definition: 4xm.c:95
int channels
Definition: 4xm.c:71
static AVPacket pkt
AVRational fps
Definition: 4xm.c:83
static int fourxm_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: 4xm.c:294
int adpcm
Definition: 4xm.c:73
Format I/O context.
Definition: avformat.h:1351
#define cfrm_TAG
Definition: 4xm.c:50
uint8_t
#define av_malloc(s)
int width
Video only.
Definition: avcodec.h:3966
#define FOURXMV_TAG
Definition: 4xm.c:37
int id
Format-specific stream ID.
Definition: avformat.h:881
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4469
#define vtrk_SIZE
Definition: 4xm.c:56
#define strk_TAG
Definition: 4xm.c:47
uint8_t * data
Definition: avcodec.h:1445
Definition: 4xm.c:68
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:145
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
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:557
static const uint8_t header[24]
Definition: sdr2.c:67
AVInputFormat ff_fourxm_demuxer
Definition: 4xm.c:397
#define av_log(a,...)
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:647
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: avcodec.h:3929
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:86
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:258
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:769
#define AVERROR(e)
Definition: error.h:43
#define RIFF_TAG
Definition: 4xm.c:36
int video_stream_index
Definition: 4xm.c:78
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:188
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:3896
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:236
#define fail()
Definition: checkasm.h:117
int extradata_size
Size of the extradata content in bytes.
Definition: avcodec.h:3918
int av_reallocp_array(void *ptr, size_t nmemb, size_t size)
Allocate, reallocate, or free an array through a pointer to a pointer.
Definition: mem.c:205
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:450
int block_align
Audio only.
Definition: avcodec.h:4017
static int fourxm_read_close(AVFormatContext *s)
Definition: 4xm.c:388
static int parse_strk(AVFormatContext *s, FourxmDemuxContext *fourxm, uint8_t *buf, int size, int left)
Definition: 4xm.c:129
int stream_index
Definition: 4xm.c:72
int64_t video_pts
Definition: 4xm.c:82
static int read_probe(AVProbeData *pd)
Definition: jvdec.c:55
int track_count
Definition: 4xm.c:79
int max_streams
The maximum number of streams.
Definition: avformat.h:1953
#define pfrm_TAG
Definition: 4xm.c:49
#define s(width, name)
Definition: cbs_vp9.c:257
AudioTrack * tracks
Definition: 4xm.c:80
#define AV_RL32
Definition: intreadwrite.h:146
#define MOVI_TAG
Definition: 4xm.c:41
static int fourxm_read_header(AVFormatContext *s)
Definition: 4xm.c:212
if(ret< 0)
Definition: vf_mcdeint.c:279
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:548
Stream structure.
Definition: avformat.h:874
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
AVIOContext * pb
I/O context.
Definition: avformat.h:1393
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:598
void * buf
Definition: avisynth_c.h:690
#define LIST_TAG
Definition: 4xm.c:38
#define std__TAG
Definition: 4xm.c:44
Rational number (pair of numerator and denominator).
Definition: rational.h:58
#define ifrm_TAG
Definition: 4xm.c:48
This structure contains the data a format has to probe a file.
Definition: avformat.h:448
#define snd__TAG
Definition: 4xm.c:54
AVRational av_d2q(double d, int max)
Convert a double precision floating point number to a rational.
Definition: rational.c:106
int sample_rate
Audio only.
Definition: avcodec.h:4010
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:460
Main libavformat public API header.
common internal api header.
#define vtrk_TAG
Definition: 4xm.c:46
int bits
Definition: 4xm.c:70
int den
Denominator.
Definition: rational.h:60
#define AV_INPUT_BUFFER_PADDING_SIZE
Required number of additionally allocated bytes at the end of the input bitstream for decoding...
Definition: avcodec.h:782
#define GET_LIST_HEADER()
Definition: 4xm.c:59
#define av_free(p)
void * priv_data
Format private data.
Definition: avformat.h:1379
#define cfr2_TAG
Definition: 4xm.c:53
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: avcodec.h:3942
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: avcodec.h:3914
#define pfr2_TAG
Definition: 4xm.c:52
int channels
Audio only.
Definition: avcodec.h:4006
#define av_freep(p)
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:647
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1021
int avio_feof(AVIOContext *s)
feof() equivalent for AVIOContext.
Definition: aviobuf.c:358
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: avcodec.h:3904
int stream_index
Definition: avcodec.h:1447
This structure stores compressed data.
Definition: avcodec.h:1422
#define HEAD_TAG
Definition: 4xm.c:39
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1438
#define AV_WL32(p, v)
Definition: intreadwrite.h:426