4xm: refactor fourxm_read_header
[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 Libav.
6  *
7  * Libav 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  * Libav 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 Libav; 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 (track + 1 > fourxm->track_count) {
133         if (av_reallocp_array(&fourxm->tracks, track + 1, sizeof(AudioTrack)))
134             return AVERROR(ENOMEM);
135         memset(&fourxm->tracks[fourxm->track_count], 0,
136                sizeof(AudioTrack) * (track + 1 - fourxm->track_count));
137         fourxm->track_count = track + 1;
138     }
139     fourxm->tracks[track].adpcm       = AV_RL32(buf + 12);
140     fourxm->tracks[track].channels    = AV_RL32(buf + 36);
141     fourxm->tracks[track].sample_rate = AV_RL32(buf + 40);
142     fourxm->tracks[track].bits        = AV_RL32(buf + 44);
143     fourxm->tracks[track].audio_pts   = 0;
144
145     if (fourxm->tracks[track].channels    <= 0 ||
146         fourxm->tracks[track].sample_rate <= 0 ||
147         fourxm->tracks[track].bits        < 0) {
148         av_log(s, AV_LOG_ERROR, "audio header invalid\n");
149         return AVERROR_INVALIDDATA;
150     }
151     /* allocate a new AVStream */
152     st = avformat_new_stream(s, NULL);
153     if (!st)
154         return AVERROR(ENOMEM);
155
156     st->id = track;
157     avpriv_set_pts_info(st, 60, 1, fourxm->tracks[track].sample_rate);
158
159     fourxm->tracks[track].stream_index = st->index;
160
161     st->codec->codec_type            = AVMEDIA_TYPE_AUDIO;
162     st->codec->codec_tag             = 0;
163     st->codec->channels              = fourxm->tracks[track].channels;
164     st->codec->sample_rate           = fourxm->tracks[track].sample_rate;
165     st->codec->bits_per_coded_sample = fourxm->tracks[track].bits;
166     st->codec->bit_rate              = st->codec->channels *
167                                        st->codec->sample_rate *
168                                        st->codec->bits_per_coded_sample;
169     st->codec->block_align           = st->codec->channels *
170                                        st->codec->bits_per_coded_sample;
171
172     if (fourxm->tracks[track].adpcm){
173         st->codec->codec_id = AV_CODEC_ID_ADPCM_4XM;
174     } else if (st->codec->bits_per_coded_sample == 8) {
175         st->codec->codec_id = AV_CODEC_ID_PCM_U8;
176     } else
177         st->codec->codec_id = AV_CODEC_ID_PCM_S16LE;
178
179     return 0;
180 }
181
182 static int fourxm_read_header(AVFormatContext *s)
183 {
184     AVIOContext *pb = s->pb;
185     unsigned int fourcc_tag;
186     unsigned int size;
187     int header_size;
188     FourxmDemuxContext *fourxm = s->priv_data;
189     unsigned char *header;
190     int i, ret;
191
192     fourxm->track_count = 0;
193     fourxm->tracks      = NULL;
194     fourxm->fps         = 1.0;
195
196     /* skip the first 3 32-bit numbers */
197     avio_skip(pb, 12);
198
199     /* check for LIST-HEAD */
200     GET_LIST_HEADER();
201     header_size = size - 4;
202     if (fourcc_tag != HEAD_TAG || header_size < 0)
203         return AVERROR_INVALIDDATA;
204
205     /* allocate space for the header and load the whole thing */
206     header = av_malloc(header_size);
207     if (!header)
208         return AVERROR(ENOMEM);
209     if (avio_read(pb, header, header_size) != header_size) {
210         av_free(header);
211         return AVERROR(EIO);
212     }
213
214     /* take the lazy approach and search for any and all vtrk and strk chunks */
215     for (i = 0; i < header_size - 8; i++) {
216         fourcc_tag = AV_RL32(&header[i]);
217         size       = AV_RL32(&header[i + 4]);
218
219         if (fourcc_tag == std__TAG) {
220             fourxm->fps = av_int2float(AV_RL32(&header[i + 12]));
221         } else if (fourcc_tag == vtrk_TAG) {
222             if ((ret = parse_vtrk(s, fourxm, header + i, size)) < 0)
223                 goto fail;
224
225             i += 8 + size;
226         } else if (fourcc_tag == strk_TAG) {
227             if ((ret = parse_strk(s, fourxm, header + i, size)) < 0)
228                 goto fail;
229
230             i += 8 + size;
231         }
232     }
233
234     /* skip over the LIST-MOVI chunk (which is where the stream should be */
235     GET_LIST_HEADER();
236     if (fourcc_tag != MOVI_TAG) {
237         ret = AVERROR_INVALIDDATA;
238         goto fail;
239     }
240
241     av_free(header);
242     /* initialize context members */
243     fourxm->video_pts = -1;  /* first frame will push to 0 */
244
245     return 0;
246 fail:
247     av_freep(&fourxm->tracks);
248     av_free(header);
249     return ret;
250 }
251
252 static int fourxm_read_packet(AVFormatContext *s,
253                               AVPacket *pkt)
254 {
255     FourxmDemuxContext *fourxm = s->priv_data;
256     AVIOContext *pb            = s->pb;
257     unsigned int fourcc_tag;
258     unsigned int size;
259     int ret = 0;
260     unsigned int track_number;
261     int packet_read = 0;
262     unsigned char header[8];
263     int audio_frame_count;
264
265     while (!packet_read) {
266         if ((ret = avio_read(s->pb, header, 8)) < 0)
267             return ret;
268         fourcc_tag = AV_RL32(&header[0]);
269         size       = AV_RL32(&header[4]);
270         if (pb->eof_reached)
271             return AVERROR(EIO);
272         switch (fourcc_tag) {
273         case LIST_TAG:
274             /* this is a good time to bump the video pts */
275             fourxm->video_pts++;
276
277             /* skip the LIST-* tag and move on to the next fourcc */
278             avio_rl32(pb);
279             break;
280
281         case ifrm_TAG:
282         case pfrm_TAG:
283         case cfrm_TAG:
284         case ifr2_TAG:
285         case pfr2_TAG:
286         case cfr2_TAG:
287             /* allocate 8 more bytes than 'size' to account for fourcc
288              * and size */
289             if (size + 8 < size || av_new_packet(pkt, size + 8))
290                 return AVERROR(EIO);
291             pkt->stream_index = fourxm->video_stream_index;
292             pkt->pts          = fourxm->video_pts;
293             pkt->pos          = avio_tell(s->pb);
294             memcpy(pkt->data, header, 8);
295             ret = avio_read(s->pb, &pkt->data[8], size);
296
297             if (ret < 0) {
298                 av_free_packet(pkt);
299             } else
300                 packet_read = 1;
301             break;
302
303         case snd__TAG:
304             track_number = avio_rl32(pb);
305             avio_skip(pb, 4);
306             size -= 8;
307
308             if (track_number < fourxm->track_count &&
309                 fourxm->tracks[track_number].channels > 0) {
310                 ret = av_get_packet(s->pb, pkt, size);
311                 if (ret < 0)
312                     return AVERROR(EIO);
313                 pkt->stream_index =
314                     fourxm->tracks[track_number].stream_index;
315                 pkt->pts    = fourxm->tracks[track_number].audio_pts;
316                 packet_read = 1;
317
318                 /* pts accounting */
319                 audio_frame_count = size;
320                 if (fourxm->tracks[track_number].adpcm)
321                     audio_frame_count -= 2 * (fourxm->tracks[track_number].channels);
322                 audio_frame_count /= fourxm->tracks[track_number].channels;
323                 if (fourxm->tracks[track_number].adpcm) {
324                     audio_frame_count *= 2;
325                 } else
326                     audio_frame_count /=
327                         (fourxm->tracks[track_number].bits / 8);
328                 fourxm->tracks[track_number].audio_pts += audio_frame_count;
329             } else {
330                 avio_skip(pb, size);
331             }
332             break;
333
334         default:
335             avio_skip(pb, size);
336             break;
337         }
338     }
339     return ret;
340 }
341
342 static int fourxm_read_close(AVFormatContext *s)
343 {
344     FourxmDemuxContext *fourxm = s->priv_data;
345
346     av_freep(&fourxm->tracks);
347
348     return 0;
349 }
350
351 AVInputFormat ff_fourxm_demuxer = {
352     .name           = "4xm",
353     .long_name      = NULL_IF_CONFIG_SMALL("4X Technologies"),
354     .priv_data_size = sizeof(FourxmDemuxContext),
355     .read_probe     = fourxm_probe,
356     .read_header    = fourxm_read_header,
357     .read_packet    = fourxm_read_packet,
358     .read_close     = fourxm_read_close,
359 };