Merge commit 'e7a44f87d07655ec0cd31c315936931674434340'
[ffmpeg.git] / libavformat / 4xm.c
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 "avformat.h"
33 #include "internal.h"
34
35 #define     RIFF_TAG MKTAG('R', 'I', 'F', 'F')
36 #define  FOURXMV_TAG MKTAG('4', 'X', 'M', 'V')
37 #define     LIST_TAG MKTAG('L', 'I', 'S', 'T')
38 #define     HEAD_TAG MKTAG('H', 'E', 'A', 'D')
39 #define     TRK__TAG MKTAG('T', 'R', 'K', '_')
40 #define     MOVI_TAG MKTAG('M', 'O', 'V', 'I')
41 #define     VTRK_TAG MKTAG('V', 'T', 'R', 'K')
42 #define     STRK_TAG MKTAG('S', 'T', 'R', 'K')
43 #define     std__TAG MKTAG('s', 't', 'd', '_')
44 #define     name_TAG MKTAG('n', 'a', 'm', 'e')
45 #define     vtrk_TAG MKTAG('v', 't', 'r', 'k')
46 #define     strk_TAG MKTAG('s', 't', 'r', 'k')
47 #define     ifrm_TAG MKTAG('i', 'f', 'r', 'm')
48 #define     pfrm_TAG MKTAG('p', 'f', 'r', 'm')
49 #define     cfrm_TAG MKTAG('c', 'f', 'r', 'm')
50 #define     ifr2_TAG MKTAG('i', 'f', 'r', '2')
51 #define     pfr2_TAG MKTAG('p', 'f', 'r', '2')
52 #define     cfr2_TAG MKTAG('c', 'f', 'r', '2')
53 #define     snd__TAG MKTAG('s', 'n', 'd', '_')
54
55 #define vtrk_SIZE 0x44
56 #define strk_SIZE 0x28
57
58 #define GET_LIST_HEADER() \
59     fourcc_tag = avio_rl32(pb); \
60     size       = avio_rl32(pb); \
61     if (fourcc_tag != LIST_TAG) \
62         return AVERROR_INVALIDDATA; \
63     fourcc_tag = avio_rl32(pb);
64
65 typedef struct AudioTrack {
66     int sample_rate;
67     int bits;
68     int channels;
69     int stream_index;
70     int adpcm;
71     int64_t audio_pts;
72 } AudioTrack;
73
74 typedef struct FourxmDemuxContext {
75     int video_stream_index;
76     int track_count;
77     AudioTrack *tracks;
78
79     int64_t video_pts;
80     float fps;
81 } FourxmDemuxContext;
82
83 static int fourxm_probe(AVProbeData *p)
84 {
85     if ((AV_RL32(&p->buf[0]) != RIFF_TAG) ||
86         (AV_RL32(&p->buf[8]) != FOURXMV_TAG))
87         return 0;
88
89     return AVPROBE_SCORE_MAX;
90 }
91
92 static int parse_vtrk(AVFormatContext *s,
93                       FourxmDemuxContext *fourxm, uint8_t *buf, int size)
94 {
95     AVStream *st;
96     /* check that there is enough data */
97     if (size != vtrk_SIZE) {
98         return AVERROR_INVALIDDATA;
99     }
100
101     /* allocate a new AVStream */
102     st = avformat_new_stream(s, NULL);
103     if (!st)
104         return AVERROR(ENOMEM);
105
106     avpriv_set_pts_info(st, 60, 1, fourxm->fps);
107
108     fourxm->video_stream_index = st->index;
109
110     st->codec->codec_type     = AVMEDIA_TYPE_VIDEO;
111     st->codec->codec_id       = AV_CODEC_ID_4XM;
112     st->codec->extradata_size = 4;
113     st->codec->extradata      = av_malloc(4);
114     AV_WL32(st->codec->extradata, AV_RL32(buf + 16));
115     st->codec->width  = AV_RL32(buf + 36);
116     st->codec->height = AV_RL32(buf + 40);
117
118     return 0;
119 }
120
121
122 static int parse_strk(AVFormatContext *s,
123                       FourxmDemuxContext *fourxm, uint8_t *buf, int size)
124 {
125     AVStream *st;
126     int track;
127     /* check that there is enough data */
128     if (size != strk_SIZE)
129         return AVERROR_INVALIDDATA;
130
131     track = AV_RL32(buf + 8);
132     if ((unsigned)track >= UINT_MAX / sizeof(AudioTrack) - 1) {
133         av_log(s, AV_LOG_ERROR, "current_track too large\n");
134         return AVERROR_INVALIDDATA;
135     }
136     if (track + 1 > fourxm->track_count) {
137         if (av_reallocp_array(&fourxm->tracks, track + 1, sizeof(AudioTrack)))
138             return AVERROR(ENOMEM);
139         memset(&fourxm->tracks[fourxm->track_count], 0,
140                sizeof(AudioTrack) * (track + 1 - fourxm->track_count));
141         fourxm->track_count = track + 1;
142     }
143     fourxm->tracks[track].adpcm       = AV_RL32(buf + 12);
144     fourxm->tracks[track].channels    = AV_RL32(buf + 36);
145     fourxm->tracks[track].sample_rate = AV_RL32(buf + 40);
146     fourxm->tracks[track].bits        = AV_RL32(buf + 44);
147     fourxm->tracks[track].audio_pts   = 0;
148
149     if (fourxm->tracks[track].channels    <= 0 ||
150         fourxm->tracks[track].sample_rate <= 0 ||
151         fourxm->tracks[track].bits        < 0) {
152         av_log(s, AV_LOG_ERROR, "audio header invalid\n");
153         return AVERROR_INVALIDDATA;
154     }
155     if (!fourxm->tracks[track].adpcm && fourxm->tracks[track].bits<8) {
156         av_log(s, AV_LOG_ERROR, "bits unspecified for non ADPCM\n");
157         return AVERROR_INVALIDDATA;
158     }
159
160     /* allocate a new AVStream */
161     st = avformat_new_stream(s, NULL);
162     if (!st)
163         return AVERROR(ENOMEM);
164
165     st->id = track;
166     avpriv_set_pts_info(st, 60, 1, fourxm->tracks[track].sample_rate);
167
168     fourxm->tracks[track].stream_index = st->index;
169
170     st->codec->codec_type            = AVMEDIA_TYPE_AUDIO;
171     st->codec->codec_tag             = 0;
172     st->codec->channels              = fourxm->tracks[track].channels;
173     st->codec->sample_rate           = fourxm->tracks[track].sample_rate;
174     st->codec->bits_per_coded_sample = fourxm->tracks[track].bits;
175     st->codec->bit_rate              = st->codec->channels *
176                                        st->codec->sample_rate *
177                                        st->codec->bits_per_coded_sample;
178     st->codec->block_align           = st->codec->channels *
179                                        st->codec->bits_per_coded_sample;
180
181     if (fourxm->tracks[track].adpcm){
182         st->codec->codec_id = AV_CODEC_ID_ADPCM_4XM;
183     } else if (st->codec->bits_per_coded_sample == 8) {
184         st->codec->codec_id = AV_CODEC_ID_PCM_U8;
185     } else
186         st->codec->codec_id = AV_CODEC_ID_PCM_S16LE;
187
188     return 0;
189 }
190
191 static int fourxm_read_header(AVFormatContext *s)
192 {
193     AVIOContext *pb = s->pb;
194     unsigned int fourcc_tag;
195     unsigned int size;
196     int header_size;
197     FourxmDemuxContext *fourxm = s->priv_data;
198     unsigned char *header;
199     int i, ret;
200
201     fourxm->track_count = 0;
202     fourxm->tracks      = NULL;
203     fourxm->fps         = 1.0;
204
205     /* skip the first 3 32-bit numbers */
206     avio_skip(pb, 12);
207
208     /* check for LIST-HEAD */
209     GET_LIST_HEADER();
210     header_size = size - 4;
211     if (fourcc_tag != HEAD_TAG || header_size < 0)
212         return AVERROR_INVALIDDATA;
213
214     /* allocate space for the header and load the whole thing */
215     header = av_malloc(header_size);
216     if (!header)
217         return AVERROR(ENOMEM);
218     if (avio_read(pb, header, header_size) != header_size) {
219         av_free(header);
220         return AVERROR(EIO);
221     }
222
223     /* take the lazy approach and search for any and all vtrk and strk chunks */
224     for (i = 0; i < header_size - 8; i++) {
225         fourcc_tag = AV_RL32(&header[i]);
226         size       = AV_RL32(&header[i + 4]);
227         if (size > header_size - i - 8 && (fourcc_tag == vtrk_TAG || fourcc_tag == strk_TAG)) {
228             av_log(s, AV_LOG_ERROR, "chunk larger than array %d>%d\n", size, header_size - i - 8);
229             return AVERROR_INVALIDDATA;
230         }
231
232         if (fourcc_tag == std__TAG) {
233             if (header_size < i + 16) {
234                 av_log(s, AV_LOG_ERROR, "std TAG truncated\n");
235                 return AVERROR_INVALIDDATA;
236             }
237             fourxm->fps = av_int2float(AV_RL32(&header[i + 12]));
238         } else if (fourcc_tag == vtrk_TAG) {
239             if ((ret = parse_vtrk(s, fourxm, header + i, size)) < 0)
240                 goto fail;
241
242             i += 8 + size;
243         } else if (fourcc_tag == strk_TAG) {
244             if ((ret = parse_strk(s, fourxm, header + i, size)) < 0)
245                 goto fail;
246
247             i += 8 + size;
248         }
249     }
250
251     /* skip over the LIST-MOVI chunk (which is where the stream should be */
252     GET_LIST_HEADER();
253     if (fourcc_tag != MOVI_TAG) {
254         ret = AVERROR_INVALIDDATA;
255         goto fail;
256     }
257
258     av_free(header);
259     /* initialize context members */
260     fourxm->video_pts = -1;  /* first frame will push to 0 */
261
262     return 0;
263 fail:
264     av_freep(&fourxm->tracks);
265     av_free(header);
266     return ret;
267 }
268
269 static int fourxm_read_packet(AVFormatContext *s,
270                               AVPacket *pkt)
271 {
272     FourxmDemuxContext *fourxm = s->priv_data;
273     AVIOContext *pb            = s->pb;
274     unsigned int fourcc_tag;
275     unsigned int size;
276     int ret = 0;
277     unsigned int track_number;
278     int packet_read = 0;
279     unsigned char header[8];
280     int audio_frame_count;
281
282     while (!packet_read) {
283         if ((ret = avio_read(s->pb, header, 8)) < 0)
284             return ret;
285         fourcc_tag = AV_RL32(&header[0]);
286         size       = AV_RL32(&header[4]);
287         if (url_feof(pb))
288             return AVERROR(EIO);
289         switch (fourcc_tag) {
290         case LIST_TAG:
291             /* this is a good time to bump the video pts */
292             fourxm->video_pts++;
293
294             /* skip the LIST-* tag and move on to the next fourcc */
295             avio_rl32(pb);
296             break;
297
298         case ifrm_TAG:
299         case pfrm_TAG:
300         case cfrm_TAG:
301         case ifr2_TAG:
302         case pfr2_TAG:
303         case cfr2_TAG:
304             /* allocate 8 more bytes than 'size' to account for fourcc
305              * and size */
306             if (size + 8 < size || av_new_packet(pkt, size + 8))
307                 return AVERROR(EIO);
308             pkt->stream_index = fourxm->video_stream_index;
309             pkt->pts          = fourxm->video_pts;
310             pkt->pos          = avio_tell(s->pb);
311             memcpy(pkt->data, header, 8);
312             ret = avio_read(s->pb, &pkt->data[8], size);
313
314             if (ret < 0) {
315                 av_free_packet(pkt);
316             } else
317                 packet_read = 1;
318             break;
319
320         case snd__TAG:
321             track_number = avio_rl32(pb);
322             avio_skip(pb, 4);
323             size -= 8;
324
325             if (track_number < fourxm->track_count &&
326                 fourxm->tracks[track_number].channels > 0) {
327                 ret = av_get_packet(s->pb, pkt, size);
328                 if (ret < 0)
329                     return AVERROR(EIO);
330                 pkt->stream_index =
331                     fourxm->tracks[track_number].stream_index;
332                 pkt->pts    = fourxm->tracks[track_number].audio_pts;
333                 packet_read = 1;
334
335                 /* pts accounting */
336                 audio_frame_count = size;
337                 if (fourxm->tracks[track_number].adpcm)
338                     audio_frame_count -= 2 * (fourxm->tracks[track_number].channels);
339                 audio_frame_count /= fourxm->tracks[track_number].channels;
340                 if (fourxm->tracks[track_number].adpcm) {
341                     audio_frame_count *= 2;
342                 } else
343                     audio_frame_count /=
344                         (fourxm->tracks[track_number].bits / 8);
345                 fourxm->tracks[track_number].audio_pts += audio_frame_count;
346             } else {
347                 avio_skip(pb, size);
348             }
349             break;
350
351         default:
352             avio_skip(pb, size);
353             break;
354         }
355     }
356     return ret;
357 }
358
359 static int fourxm_read_close(AVFormatContext *s)
360 {
361     FourxmDemuxContext *fourxm = s->priv_data;
362
363     av_freep(&fourxm->tracks);
364
365     return 0;
366 }
367
368 AVInputFormat ff_fourxm_demuxer = {
369     .name           = "4xm",
370     .long_name      = NULL_IF_CONFIG_SMALL("4X Technologies"),
371     .priv_data_size = sizeof(FourxmDemuxContext),
372     .read_probe     = fourxm_probe,
373     .read_header    = fourxm_read_header,
374     .read_packet    = fourxm_read_packet,
375     .read_close     = fourxm_read_close,
376 };