The c93 demuxer depends on vocdec.o.
[ffmpeg.git] / libavformat / gxf.c
1 /*
2  * GXF demuxer.
3  * Copyright (c) 2006 Reimar Doeffinger.
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 #include "avformat.h"
22 #include "common.h"
23
24 typedef enum {
25     PKT_MAP = 0xbc,
26     PKT_MEDIA = 0xbf,
27     PKT_EOS = 0xfb,
28     PKT_FLT = 0xfc,
29     PKT_UMF = 0xfd
30 } pkt_type_t;
31
32 typedef enum {
33     MAT_NAME = 0x40,
34     MAT_FIRST_FIELD = 0x41,
35     MAT_LAST_FIELD = 0x42,
36     MAT_MARK_IN = 0x43,
37     MAT_MARK_OUT = 0x44,
38     MAT_SIZE = 0x45
39 } mat_tag_t;
40
41 typedef enum {
42     TRACK_NAME = 0x4c,
43     TRACK_AUX = 0x4d,
44     TRACK_VER = 0x4e,
45     TRACK_MPG_AUX = 0x4f,
46     TRACK_FPS = 0x50,
47     TRACK_LINES = 0x51,
48     TRACK_FPF = 0x52
49 } track_tag_t;
50
51 typedef struct {
52     int64_t first_field;
53     int64_t last_field;
54     AVRational frames_per_second;
55     int32_t fields_per_frame;
56 } st_info_t;
57
58 /**
59  * \brief parses a packet header, extracting type and length
60  * \param pb ByteIOContext to read header from
61  * \param type detected packet type is stored here
62  * \param length detected packet length, excluding header is stored here
63  * \return 0 if header not found or contains invalid data, 1 otherwise
64  */
65 static int parse_packet_header(ByteIOContext *pb, pkt_type_t *type, int *length) {
66     if (get_be32(pb))
67         return 0;
68     if (get_byte(pb) != 1)
69         return 0;
70     *type = get_byte(pb);
71     *length = get_be32(pb);
72     if ((*length >> 24) || *length < 16)
73         return 0;
74     *length -= 16;
75     if (get_be32(pb))
76         return 0;
77     if (get_byte(pb) != 0xe1)
78         return 0;
79     if (get_byte(pb) != 0xe2)
80         return 0;
81     return 1;
82 }
83
84 /**
85  * \brief check if file starts with a PKT_MAP header
86  */
87 static int gxf_probe(AVProbeData *p) {
88     static const uint8_t startcode[] = {0, 0, 0, 0, 1, 0xbc}; // start with map packet
89     static const uint8_t endcode[] = {0, 0, 0, 0, 0xe1, 0xe2};
90     if (!memcmp(p->buf, startcode, sizeof(startcode)) &&
91         !memcmp(&p->buf[16 - sizeof(endcode)], endcode, sizeof(endcode)))
92         return AVPROBE_SCORE_MAX;
93     return 0;
94 }
95
96 /**
97  * \brief gets the stream index for the track with the specified id, creates new
98  *        stream if not found
99  * \param stream id of stream to find / add
100  * \param format stream format identifier
101  */
102 static int get_sindex(AVFormatContext *s, int id, int format) {
103     int i;
104     AVStream *st = NULL;
105     for (i = 0; i < s->nb_streams; i++) {
106         if (s->streams[i]->id == id)
107             return i;
108     }
109     st = av_new_stream(s, id);
110     switch (format) {
111         case 3:
112         case 4:
113             st->codec->codec_type = CODEC_TYPE_VIDEO;
114             st->codec->codec_id = CODEC_ID_MJPEG;
115             break;
116         case 13:
117         case 15:
118             st->codec->codec_type = CODEC_TYPE_VIDEO;
119             st->codec->codec_id = CODEC_ID_DVVIDEO;
120             break;
121         case 14:
122         case 16:
123             st->codec->codec_type = CODEC_TYPE_VIDEO;
124             st->codec->codec_id = CODEC_ID_DVVIDEO;
125             break;
126         case 11:
127         case 12:
128         case 20:
129             st->codec->codec_type = CODEC_TYPE_VIDEO;
130             st->codec->codec_id = CODEC_ID_MPEG2VIDEO;
131             st->need_parsing = AVSTREAM_PARSE_HEADERS; //get keyframe flag etc.
132             break;
133         case 22:
134         case 23:
135             st->codec->codec_type = CODEC_TYPE_VIDEO;
136             st->codec->codec_id = CODEC_ID_MPEG1VIDEO;
137             st->need_parsing = AVSTREAM_PARSE_HEADERS; //get keyframe flag etc.
138             break;
139         case 9:
140             st->codec->codec_type = CODEC_TYPE_AUDIO;
141             st->codec->codec_id = CODEC_ID_PCM_S24LE;
142             st->codec->channels = 1;
143             st->codec->sample_rate = 48000;
144             st->codec->bit_rate = 3 * 1 * 48000 * 8;
145             st->codec->block_align = 3 * 1;
146             st->codec->bits_per_sample = 24;
147             break;
148         case 10:
149             st->codec->codec_type = CODEC_TYPE_AUDIO;
150             st->codec->codec_id = CODEC_ID_PCM_S16LE;
151             st->codec->channels = 1;
152             st->codec->sample_rate = 48000;
153             st->codec->bit_rate = 2 * 1 * 48000 * 8;
154             st->codec->block_align = 2 * 1;
155             st->codec->bits_per_sample = 16;
156             break;
157         case 17:
158             st->codec->codec_type = CODEC_TYPE_AUDIO;
159             st->codec->codec_id = CODEC_ID_AC3;
160             st->codec->channels = 2;
161             st->codec->sample_rate = 48000;
162             break;
163         // timecode tracks:
164         case 7:
165         case 8:
166         case 24:
167             st->codec->codec_type = CODEC_TYPE_DATA;
168             st->codec->codec_id = CODEC_ID_NONE;
169             break;
170         default:
171             st->codec->codec_type = CODEC_TYPE_UNKNOWN;
172             st->codec->codec_id = CODEC_ID_NONE;
173             break;
174     }
175     return s->nb_streams - 1;
176 }
177
178 /**
179  * \brief filters out interesting tags from material information.
180  * \param len lenght of tag section, will be adjusted to contain remaining bytes
181  * \param si struct to store collected information into
182  */
183 static void gxf_material_tags(ByteIOContext *pb, int *len, st_info_t *si) {
184     si->first_field = AV_NOPTS_VALUE;
185     si->last_field = AV_NOPTS_VALUE;
186     while (*len >= 2) {
187         mat_tag_t tag = get_byte(pb);
188         int tlen = get_byte(pb);
189         *len -= 2;
190         if (tlen > *len)
191             return;
192         *len -= tlen;
193         if (tlen == 4) {
194             uint32_t value = get_be32(pb);
195             if (tag == MAT_FIRST_FIELD)
196                 si->first_field = value;
197             else if (tag == MAT_LAST_FIELD)
198                 si->last_field = value;
199         } else
200             url_fskip(pb, tlen);
201     }
202 }
203
204 /**
205  * \brief convert fps tag value to AVRational fps
206  * \param fps fps value from tag
207  * \return fps as AVRational, or 0 / 0 if unknown
208  */
209 static AVRational fps_tag2avr(int32_t fps) {
210     extern const AVRational ff_frame_rate_tab[];
211     if (fps < 1 || fps > 9) fps = 9;
212     return ff_frame_rate_tab[9 - fps]; // values have opposite order
213 }
214
215 /**
216  * \brief convert UMF attributes flags to AVRational fps
217  * \param fps fps value from flags
218  * \return fps as AVRational, or 0 / 0 if unknown
219  */
220 static AVRational fps_umf2avr(uint32_t flags) {
221     static const AVRational map[] = {{50, 1}, {60000, 1001}, {24, 1},
222         {25, 1}, {30000, 1001}};
223     int idx =  av_log2((flags & 0x7c0) >> 6);
224     return map[idx];
225 }
226
227 /**
228  * \brief filters out interesting tags from track information.
229  * \param len length of tag section, will be adjusted to contain remaining bytes
230  * \param si struct to store collected information into
231  */
232 static void gxf_track_tags(ByteIOContext *pb, int *len, st_info_t *si) {
233     si->frames_per_second = (AVRational){0, 0};
234     si->fields_per_frame = 0;
235     while (*len >= 2) {
236         track_tag_t tag = get_byte(pb);
237         int tlen = get_byte(pb);
238         *len -= 2;
239         if (tlen > *len)
240             return;
241         *len -= tlen;
242         if (tlen == 4) {
243             uint32_t value = get_be32(pb);
244             if (tag == TRACK_FPS)
245                 si->frames_per_second = fps_tag2avr(value);
246             else if (tag == TRACK_FPF && (value == 1 || value == 2))
247                 si->fields_per_frame = value;
248         } else
249             url_fskip(pb, tlen);
250     }
251 }
252
253 /**
254  * \brief read index from FLT packet into stream 0 av_index
255  */
256 static void gxf_read_index(AVFormatContext *s, int pkt_len) {
257     ByteIOContext *pb = &s->pb;
258     AVStream *st = s->streams[0];
259     uint32_t fields_per_map = get_le32(pb);
260     uint32_t map_cnt = get_le32(pb);
261     int i;
262     pkt_len -= 8;
263     if (map_cnt > 1000) {
264         av_log(s, AV_LOG_ERROR, "GXF: too many index entries %u (%x)\n", map_cnt, map_cnt);
265         map_cnt = 1000;
266     }
267     if (pkt_len < 4 * map_cnt) {
268         av_log(s, AV_LOG_ERROR, "GXF: invalid index length\n");
269         url_fskip(pb, pkt_len);
270         return;
271     }
272     pkt_len -= 4 * map_cnt;
273     av_add_index_entry(st, 0, 0, 0, 0, 0);
274     for (i = 0; i < map_cnt; i++)
275         av_add_index_entry(st, (uint64_t)get_le32(pb) * 1024,
276                            i * (uint64_t)fields_per_map + 1, 0, 0, 0);
277     url_fskip(pb, pkt_len);
278 }
279
280 static int gxf_header(AVFormatContext *s, AVFormatParameters *ap) {
281     ByteIOContext *pb = &s->pb;
282     pkt_type_t pkt_type;
283     int map_len;
284     int len;
285     AVRational main_timebase = {0, 0};
286     st_info_t si;
287     int i;
288     if (!parse_packet_header(pb, &pkt_type, &map_len) || pkt_type != PKT_MAP) {
289         av_log(s, AV_LOG_ERROR, "GXF: map packet not found\n");
290         return 0;
291     }
292     map_len -= 2;
293     if (get_byte(pb) != 0x0e0 || get_byte(pb) != 0xff) {
294         av_log(s, AV_LOG_ERROR, "GXF: unknown version or invalid map preamble\n");
295         return 0;
296     }
297     map_len -= 2;
298     len = get_be16(pb); // length of material data section
299     if (len > map_len) {
300         av_log(s, AV_LOG_ERROR, "GXF: material data longer than map data\n");
301         return 0;
302     }
303     map_len -= len;
304     gxf_material_tags(pb, &len, &si);
305     url_fskip(pb, len);
306     map_len -= 2;
307     len = get_be16(pb); // length of track description
308     if (len > map_len) {
309         av_log(s, AV_LOG_ERROR, "GXF: track description longer than map data\n");
310         return 0;
311     }
312     map_len -= len;
313     while (len > 0) {
314         int track_type, track_id, track_len;
315         AVStream *st;
316         int idx;
317         len -= 4;
318         track_type = get_byte(pb);
319         track_id = get_byte(pb);
320         track_len = get_be16(pb);
321         len -= track_len;
322         gxf_track_tags(pb, &track_len, &si);
323         url_fskip(pb, track_len);
324         if (!(track_type & 0x80)) {
325            av_log(s, AV_LOG_ERROR, "GXF: invalid track type %x\n", track_type);
326            continue;
327         }
328         track_type &= 0x7f;
329         if ((track_id & 0xc0) != 0xc0) {
330            av_log(s, AV_LOG_ERROR, "GXF: invalid track id %x\n", track_id);
331            continue;
332         }
333         track_id &= 0x3f;
334         idx = get_sindex(s, track_id, track_type);
335         if (idx < 0) continue;
336         st = s->streams[idx];
337         if (!main_timebase.num || !main_timebase.den) {
338             main_timebase.num = si.frames_per_second.den;
339             main_timebase.den = si.frames_per_second.num * si.fields_per_frame;
340         }
341         st->start_time = si.first_field;
342         if (si.first_field != AV_NOPTS_VALUE && si.last_field != AV_NOPTS_VALUE)
343             st->duration = si.last_field - si.first_field;
344     }
345     if (len < 0)
346         av_log(s, AV_LOG_ERROR, "GXF: invalid track description length specified\n");
347     if (map_len)
348         url_fskip(pb, map_len);
349     if (!parse_packet_header(pb, &pkt_type, &len)) {
350         av_log(s, AV_LOG_ERROR, "GXF: sync lost in header\n");
351         return -1;
352     }
353     if (pkt_type == PKT_FLT) {
354         gxf_read_index(s, len);
355         if (!parse_packet_header(pb, &pkt_type, &len)) {
356             av_log(s, AV_LOG_ERROR, "GXF: sync lost in header\n");
357             return -1;
358         }
359     }
360     if (pkt_type == PKT_UMF) {
361         if (len >= 0x39) {
362             AVRational fps;
363             len -= 0x39;
364             url_fskip(pb, 5); // preamble
365             url_fskip(pb, 0x30); // payload description
366             fps = fps_umf2avr(get_le32(pb));
367             if (!main_timebase.num || !main_timebase.den) {
368                 // this may not always be correct, but simply the best we can get
369                 main_timebase.num = fps.den;
370                 main_timebase.den = fps.num;
371             }
372         } else
373             av_log(s, AV_LOG_INFO, "GXF: UMF packet too short\n");
374     } else
375         av_log(s, AV_LOG_INFO, "GXF: UMF packet missing\n");
376     url_fskip(pb, len);
377     if (!main_timebase.num || !main_timebase.den)
378         main_timebase = (AVRational){1, 50}; // set some arbitrary fallback
379     for (i = 0; i < s->nb_streams; i++) {
380         AVStream *st = s->streams[i];
381         av_set_pts_info(st, 32, main_timebase.num, main_timebase.den);
382     }
383     return 0;
384 }
385
386 #define READ_ONE() \
387     { \
388         if (!max_interval-- || url_feof(pb)) \
389             goto out; \
390         tmp = tmp << 8 | get_byte(pb); \
391     }
392
393 /**
394  * \brief resync the stream on the next media packet with specified properties
395  * \param max_interval how many bytes to search for matching packet at most
396  * \param track track id the media packet must belong to, -1 for any
397  * \param timestamp minimum timestamp (== field number) the packet must have, -1 for any
398  * \return timestamp of packet found
399  */
400 static int64_t gxf_resync_media(AVFormatContext *s, uint64_t max_interval, int track, int timestamp) {
401     uint32_t tmp;
402     uint64_t last_pos;
403     uint64_t last_found_pos = 0;
404     int cur_track;
405     int64_t cur_timestamp = AV_NOPTS_VALUE;
406     int len;
407     ByteIOContext *pb = &s->pb;
408     pkt_type_t type;
409     tmp = get_be32(pb);
410 start:
411     while (tmp)
412         READ_ONE();
413     READ_ONE();
414     if (tmp != 1)
415         goto start;
416     last_pos = url_ftell(pb);
417     url_fseek(pb, -5, SEEK_CUR);
418     if (!parse_packet_header(pb, &type, &len) || type != PKT_MEDIA) {
419         url_fseek(pb, last_pos, SEEK_SET);
420         goto start;
421     }
422     get_byte(pb);
423     cur_track = get_byte(pb);
424     cur_timestamp = get_be32(pb);
425     last_found_pos = url_ftell(pb) - 16 - 6;
426     if ((track >= 0 && track != cur_track) || (timestamp >= 0 && timestamp > cur_timestamp)) {
427         url_fseek(pb, last_pos, SEEK_SET);
428         goto start;
429     }
430 out:
431     if (last_found_pos)
432         url_fseek(pb, last_found_pos, SEEK_SET);
433     return cur_timestamp;
434 }
435
436 static int gxf_packet(AVFormatContext *s, AVPacket *pkt) {
437     ByteIOContext *pb = &s->pb;
438     pkt_type_t pkt_type;
439     int pkt_len;
440     while (!url_feof(pb)) {
441         int track_type, track_id, ret;
442         int field_nr;
443         if (!parse_packet_header(pb, &pkt_type, &pkt_len)) {
444             if (!url_feof(pb))
445                 av_log(s, AV_LOG_ERROR, "GXF: sync lost\n");
446             return -1;
447         }
448         if (pkt_type == PKT_FLT) {
449             gxf_read_index(s, pkt_len);
450             continue;
451         }
452         if (pkt_type != PKT_MEDIA) {
453             url_fskip(pb, pkt_len);
454             continue;
455         }
456         if (pkt_len < 16) {
457             av_log(s, AV_LOG_ERROR, "GXF: invalid media packet length\n");
458             continue;
459         }
460         pkt_len -= 16;
461         track_type = get_byte(pb);
462         track_id = get_byte(pb);
463         field_nr = get_be32(pb);
464         get_be32(pb); // field information
465         get_be32(pb); // "timeline" field number
466         get_byte(pb); // flags
467         get_byte(pb); // reserved
468         // NOTE: there is also data length information in the
469         // field information, it might be better to take this into account
470         // as well.
471         ret = av_get_packet(pb, pkt, pkt_len);
472         pkt->stream_index = get_sindex(s, track_id, track_type);
473         pkt->dts = field_nr;
474         return ret;
475     }
476     return AVERROR_IO;
477 }
478
479 static int gxf_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags) {
480     uint64_t pos;
481     uint64_t maxlen = 100 * 1024 * 1024;
482     AVStream *st = s->streams[0];
483     int64_t start_time = s->streams[stream_index]->start_time;
484     int64_t found;
485     int idx;
486     if (timestamp < start_time) timestamp = start_time;
487     idx = av_index_search_timestamp(st, timestamp - start_time,
488                                     AVSEEK_FLAG_ANY | AVSEEK_FLAG_BACKWARD);
489     if (idx < 0)
490         return -1;
491     pos = st->index_entries[idx].pos;
492     if (idx < st->nb_index_entries - 2)
493         maxlen = st->index_entries[idx + 2].pos - pos;
494     maxlen = FFMAX(maxlen, 200 * 1024);
495     url_fseek(&s->pb, pos, SEEK_SET);
496     found = gxf_resync_media(s, maxlen, -1, timestamp);
497     if (FFABS(found - timestamp) > 4)
498         return -1;
499     return 0;
500 }
501
502 static int64_t gxf_read_timestamp(AVFormatContext *s, int stream_index,
503                                   int64_t *pos, int64_t pos_limit) {
504     ByteIOContext *pb = &s->pb;
505     int64_t res;
506     url_fseek(pb, *pos, SEEK_SET);
507     res = gxf_resync_media(s, pos_limit - *pos, -1, -1);
508     *pos = url_ftell(pb);
509     return res;
510 }
511
512 AVInputFormat gxf_demuxer = {
513     "gxf",
514     "GXF format",
515     0,
516     gxf_probe,
517     gxf_header,
518     gxf_packet,
519     NULL,
520     gxf_seek,
521     gxf_read_timestamp,
522 };