]> git.sesse.net Git - ffmpeg/blob - libavformat/gxf.c
gxf: Factorize code in get_sindex()
[ffmpeg] / 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
22 #include "libavutil/channel_layout.h"
23 #include "libavutil/common.h"
24 #include "avformat.h"
25 #include "internal.h"
26 #include "gxf.h"
27 #include "libavcodec/mpeg12data.h"
28
29 struct gxf_stream_info {
30     int64_t first_field;
31     int64_t last_field;
32     AVRational frames_per_second;
33     int32_t fields_per_frame;
34     int64_t track_aux_data;
35 };
36
37 /**
38  * @brief parse gxf timecode and add it to metadata
39  */
40 static int add_timecode_metadata(AVDictionary **pm, const char *key, uint32_t timecode, int fields_per_frame)
41 {
42    char tmp[128];
43    int field  = timecode & 0xff;
44    int frame  = fields_per_frame ? field / fields_per_frame : field;
45    int second = (timecode >>  8) & 0xff;
46    int minute = (timecode >> 16) & 0xff;
47    int hour   = (timecode >> 24) & 0x1f;
48    int drop   = (timecode >> 29) & 1;
49    // bit 30: color_frame, unused
50    // ignore invalid time code
51    if (timecode >> 31)
52        return 0;
53    snprintf(tmp, sizeof(tmp), "%02d:%02d:%02d%c%02d",
54        hour, minute, second, drop ? ';' : ':', frame);
55    return av_dict_set(pm, key, tmp, 0);
56 }
57
58 /**
59  * @brief parses a packet header, extracting type and length
60  * @param pb AVIOContext 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(AVIOContext *pb, GXFPktType *type, int *length) {
66     if (avio_rb32(pb))
67         return 0;
68     if (avio_r8(pb) != 1)
69         return 0;
70     *type = avio_r8(pb);
71     *length = avio_rb32(pb);
72     if ((*length >> 24) || *length < 16)
73         return 0;
74     *length -= 16;
75     if (avio_rb32(pb))
76         return 0;
77     if (avio_r8(pb) != 0xe1)
78         return 0;
79     if (avio_r8(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 id     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     i = ff_find_stream_index(s, id);
106     if (i >= 0)
107         return i;
108     st = avformat_new_stream(s, NULL);
109     if (!st)
110         return AVERROR(ENOMEM);
111     st->id = id;
112     switch (format) {
113         case 3:
114         case 4:
115             st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
116             st->codec->codec_id = AV_CODEC_ID_MJPEG;
117             break;
118         case 13:
119         case 14:
120         case 15:
121         case 16:
122         case 25:
123             st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
124             st->codec->codec_id = AV_CODEC_ID_DVVIDEO;
125             break;
126         case 11:
127         case 12:
128         case 20:
129             st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
130             st->codec->codec_id = AV_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 = AVMEDIA_TYPE_VIDEO;
136             st->codec->codec_id = AV_CODEC_ID_MPEG1VIDEO;
137             st->need_parsing = AVSTREAM_PARSE_HEADERS; //get keyframe flag etc.
138             break;
139         case 9:
140             st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
141             st->codec->codec_id = AV_CODEC_ID_PCM_S24LE;
142             st->codec->channels = 1;
143             st->codec->channel_layout = AV_CH_LAYOUT_MONO;
144             st->codec->sample_rate = 48000;
145             st->codec->bit_rate = 3 * 1 * 48000 * 8;
146             st->codec->block_align = 3 * 1;
147             st->codec->bits_per_coded_sample = 24;
148             break;
149         case 10:
150             st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
151             st->codec->codec_id = AV_CODEC_ID_PCM_S16LE;
152             st->codec->channels = 1;
153             st->codec->channel_layout = AV_CH_LAYOUT_MONO;
154             st->codec->sample_rate = 48000;
155             st->codec->bit_rate = 2 * 1 * 48000 * 8;
156             st->codec->block_align = 2 * 1;
157             st->codec->bits_per_coded_sample = 16;
158             break;
159         case 17:
160             st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
161             st->codec->codec_id = AV_CODEC_ID_AC3;
162             st->codec->channels = 2;
163             st->codec->channel_layout = AV_CH_LAYOUT_STEREO;
164             st->codec->sample_rate = 48000;
165             break;
166         // timecode tracks:
167         case 7:
168         case 8:
169         case 24:
170             st->codec->codec_type = AVMEDIA_TYPE_DATA;
171             st->codec->codec_id = AV_CODEC_ID_NONE;
172             break;
173         default:
174             st->codec->codec_type = AVMEDIA_TYPE_UNKNOWN;
175             st->codec->codec_id = AV_CODEC_ID_NONE;
176             break;
177     }
178     return s->nb_streams - 1;
179 }
180
181 /**
182  * @brief filters out interesting tags from material information.
183  * @param len length of tag section, will be adjusted to contain remaining bytes
184  * @param si struct to store collected information into
185  */
186 static void gxf_material_tags(AVIOContext *pb, int *len, struct gxf_stream_info *si) {
187     si->first_field = AV_NOPTS_VALUE;
188     si->last_field = AV_NOPTS_VALUE;
189     while (*len >= 2) {
190         GXFMatTag tag = avio_r8(pb);
191         int tlen = avio_r8(pb);
192         *len -= 2;
193         if (tlen > *len)
194             return;
195         *len -= tlen;
196         if (tlen == 4) {
197             uint32_t value = avio_rb32(pb);
198             if (tag == MAT_FIRST_FIELD)
199                 si->first_field = value;
200             else if (tag == MAT_LAST_FIELD)
201                 si->last_field = value;
202         } else
203             avio_skip(pb, tlen);
204     }
205 }
206
207 static const AVRational frame_rate_tab[] = {
208     {   60,    1},
209     {60000, 1001},
210     {   50,    1},
211     {   30,    1},
212     {30000, 1001},
213     {   25,    1},
214     {   24,    1},
215     {24000, 1001},
216     {    0,    0},
217 };
218
219 /**
220  * @brief convert fps tag value to AVRational fps
221  * @param fps fps value from tag
222  * @return fps as AVRational, or 0 / 0 if unknown
223  */
224 static AVRational fps_tag2avr(int32_t fps) {
225     if (fps < 1 || fps > 9) fps = 9;
226     return frame_rate_tab[fps - 1];
227 }
228
229 /**
230  * @brief convert UMF attributes flags to AVRational fps
231  * @param flags UMF flags to convert
232  * @return fps as AVRational, or 0 / 0 if unknown
233  */
234 static AVRational fps_umf2avr(uint32_t flags) {
235     static const AVRational map[] = {{50, 1}, {60000, 1001}, {24, 1},
236         {25, 1}, {30000, 1001}};
237     int idx =  av_log2((flags & 0x7c0) >> 6);
238     return map[idx];
239 }
240
241 /**
242  * @brief filters out interesting tags from track information.
243  * @param len length of tag section, will be adjusted to contain remaining bytes
244  * @param si struct to store collected information into
245  */
246 static void gxf_track_tags(AVIOContext *pb, int *len, struct gxf_stream_info *si) {
247     si->frames_per_second = (AVRational){0, 0};
248     si->fields_per_frame = 0;
249     si->track_aux_data = 0x80000000;
250     while (*len >= 2) {
251         GXFTrackTag tag = avio_r8(pb);
252         int tlen = avio_r8(pb);
253         *len -= 2;
254         if (tlen > *len)
255             return;
256         *len -= tlen;
257         if (tlen == 4) {
258             uint32_t value = avio_rb32(pb);
259             if (tag == TRACK_FPS)
260                 si->frames_per_second = fps_tag2avr(value);
261             else if (tag == TRACK_FPF && (value == 1 || value == 2))
262                 si->fields_per_frame = value;
263         } else if (tlen == 8 && tag == TRACK_AUX)
264             si->track_aux_data = avio_rl64(pb);
265         else
266             avio_skip(pb, tlen);
267     }
268 }
269
270 /**
271  * @brief read index from FLT packet into stream 0 av_index
272  */
273 static void gxf_read_index(AVFormatContext *s, int pkt_len) {
274     AVIOContext *pb = s->pb;
275     AVStream *st;
276     uint32_t fields_per_map = avio_rl32(pb);
277     uint32_t map_cnt = avio_rl32(pb);
278     int i;
279     pkt_len -= 8;
280     if ((s->flags & AVFMT_FLAG_IGNIDX) || !s->streams) {
281         avio_skip(pb, pkt_len);
282         return;
283     }
284     st = s->streams[0];
285     if (map_cnt > 1000) {
286         av_log(s, AV_LOG_ERROR, "too many index entries %u (%x)\n", map_cnt, map_cnt);
287         map_cnt = 1000;
288     }
289     if (pkt_len < 4 * map_cnt) {
290         av_log(s, AV_LOG_ERROR, "invalid index length\n");
291         avio_skip(pb, pkt_len);
292         return;
293     }
294     pkt_len -= 4 * map_cnt;
295     av_add_index_entry(st, 0, 0, 0, 0, 0);
296     for (i = 0; i < map_cnt; i++)
297         av_add_index_entry(st, (uint64_t)avio_rl32(pb) * 1024,
298                            i * (uint64_t)fields_per_map + 1, 0, 0, 0);
299     avio_skip(pb, pkt_len);
300 }
301
302 static int gxf_header(AVFormatContext *s) {
303     AVIOContext *pb = s->pb;
304     GXFPktType pkt_type;
305     int map_len;
306     int len;
307     AVRational main_timebase = {0, 0};
308     struct gxf_stream_info *si = s->priv_data;
309     int i;
310     if (!parse_packet_header(pb, &pkt_type, &map_len) || pkt_type != PKT_MAP) {
311         av_log(s, AV_LOG_ERROR, "map packet not found\n");
312         return 0;
313     }
314     map_len -= 2;
315     if (avio_r8(pb) != 0x0e0 || avio_r8(pb) != 0xff) {
316         av_log(s, AV_LOG_ERROR, "unknown version or invalid map preamble\n");
317         return 0;
318     }
319     map_len -= 2;
320     len = avio_rb16(pb); // length of material data section
321     if (len > map_len) {
322         av_log(s, AV_LOG_ERROR, "material data longer than map data\n");
323         return 0;
324     }
325     map_len -= len;
326     gxf_material_tags(pb, &len, si);
327     avio_skip(pb, len);
328     map_len -= 2;
329     len = avio_rb16(pb); // length of track description
330     if (len > map_len) {
331         av_log(s, AV_LOG_ERROR, "track description longer than map data\n");
332         return 0;
333     }
334     map_len -= len;
335     while (len > 0) {
336         int track_type, track_id, track_len;
337         AVStream *st;
338         int idx;
339         len -= 4;
340         track_type = avio_r8(pb);
341         track_id = avio_r8(pb);
342         track_len = avio_rb16(pb);
343         len -= track_len;
344         if (!(track_type & 0x80)) {
345            av_log(s, AV_LOG_ERROR, "invalid track type %x\n", track_type);
346            continue;
347         }
348         track_type &= 0x7f;
349         if ((track_id & 0xc0) != 0xc0) {
350            av_log(s, AV_LOG_ERROR, "invalid track id %x\n", track_id);
351            continue;
352         }
353         track_id &= 0x3f;
354         gxf_track_tags(pb, &track_len, si);
355         // check for timecode tracks
356         if (track_type == 7 || track_type == 8 || track_type == 24) {
357             add_timecode_metadata(&s->metadata, "timecode",
358                                   si->track_aux_data & 0xffffffff,
359                                   si->fields_per_frame);
360
361         }
362         avio_skip(pb, track_len);
363
364         idx = get_sindex(s, track_id, track_type);
365         if (idx < 0) continue;
366         st = s->streams[idx];
367         if (!main_timebase.num || !main_timebase.den) {
368             main_timebase.num = si->frames_per_second.den;
369             main_timebase.den = si->frames_per_second.num * 2;
370         }
371         st->start_time = si->first_field;
372         if (si->first_field != AV_NOPTS_VALUE && si->last_field != AV_NOPTS_VALUE)
373             st->duration = si->last_field - si->first_field;
374     }
375     if (len < 0)
376         av_log(s, AV_LOG_ERROR, "invalid track description length specified\n");
377     if (map_len)
378         avio_skip(pb, map_len);
379     if (!parse_packet_header(pb, &pkt_type, &len)) {
380         av_log(s, AV_LOG_ERROR, "sync lost in header\n");
381         return -1;
382     }
383     if (pkt_type == PKT_FLT) {
384         gxf_read_index(s, len);
385         if (!parse_packet_header(pb, &pkt_type, &len)) {
386             av_log(s, AV_LOG_ERROR, "sync lost in header\n");
387             return -1;
388         }
389     }
390     if (pkt_type == PKT_UMF) {
391         if (len >= 0x39) {
392             AVRational fps;
393             len -= 0x39;
394             avio_skip(pb, 5); // preamble
395             avio_skip(pb, 0x30); // payload description
396             fps = fps_umf2avr(avio_rl32(pb));
397             if (!main_timebase.num || !main_timebase.den) {
398                 av_log(s, AV_LOG_WARNING, "No FPS track tag, using UMF fps tag."
399                                           " This might give wrong results.\n");
400                 // this may not always be correct, but simply the best we can get
401                 main_timebase.num = fps.den;
402                 main_timebase.den = fps.num * 2;
403             }
404
405             if (len >= 0x18) {
406                 len -= 0x18;
407                 avio_skip(pb, 0x10);
408                 add_timecode_metadata(&s->metadata, "timecode_at_mark_in",
409                                       avio_rl32(pb), si->fields_per_frame);
410                 add_timecode_metadata(&s->metadata, "timecode_at_mark_out",
411                                       avio_rl32(pb), si->fields_per_frame);
412             }
413         } else
414             av_log(s, AV_LOG_INFO, "UMF packet too short\n");
415     } else
416         av_log(s, AV_LOG_INFO, "UMF packet missing\n");
417     avio_skip(pb, len);
418     // set a fallback value, 60000/1001 is specified for audio-only files
419     // so use that regardless of why we do not know the video frame rate.
420     if (!main_timebase.num || !main_timebase.den)
421         main_timebase = (AVRational){1001, 60000};
422     for (i = 0; i < s->nb_streams; i++) {
423         AVStream *st = s->streams[i];
424         avpriv_set_pts_info(st, 32, main_timebase.num, main_timebase.den);
425     }
426     return 0;
427 }
428
429 #define READ_ONE() \
430     { \
431         if (!max_interval-- || url_feof(pb)) \
432             goto out; \
433         tmp = tmp << 8 | avio_r8(pb); \
434     }
435
436 /**
437  * @brief resync the stream on the next media packet with specified properties
438  * @param max_interval how many bytes to search for matching packet at most
439  * @param track track id the media packet must belong to, -1 for any
440  * @param timestamp minimum timestamp (== field number) the packet must have, -1 for any
441  * @return timestamp of packet found
442  */
443 static int64_t gxf_resync_media(AVFormatContext *s, uint64_t max_interval, int track, int timestamp) {
444     uint32_t tmp;
445     uint64_t last_pos;
446     uint64_t last_found_pos = 0;
447     int cur_track;
448     int64_t cur_timestamp = AV_NOPTS_VALUE;
449     int len;
450     AVIOContext *pb = s->pb;
451     GXFPktType type;
452     tmp = avio_rb32(pb);
453 start:
454     while (tmp)
455         READ_ONE();
456     READ_ONE();
457     if (tmp != 1)
458         goto start;
459     last_pos = avio_tell(pb);
460     if (avio_seek(pb, -5, SEEK_CUR) < 0)
461         goto out;
462     if (!parse_packet_header(pb, &type, &len) || type != PKT_MEDIA) {
463         if (avio_seek(pb, last_pos, SEEK_SET) < 0)
464             goto out;
465         goto start;
466     }
467     avio_r8(pb);
468     cur_track = avio_r8(pb);
469     cur_timestamp = avio_rb32(pb);
470     last_found_pos = avio_tell(pb) - 16 - 6;
471     if ((track >= 0 && track != cur_track) || (timestamp >= 0 && timestamp > cur_timestamp)) {
472         if (avio_seek(pb, last_pos, SEEK_SET) >= 0)
473             goto start;
474     }
475 out:
476     if (last_found_pos)
477         avio_seek(pb, last_found_pos, SEEK_SET);
478     return cur_timestamp;
479 }
480
481 static int gxf_packet(AVFormatContext *s, AVPacket *pkt) {
482     AVIOContext *pb = s->pb;
483     GXFPktType pkt_type;
484     int pkt_len;
485     struct gxf_stream_info *si = s->priv_data;
486
487     while (!pb->eof_reached) {
488         AVStream *st;
489         int track_type, track_id, ret;
490         int field_nr, field_info, skip = 0;
491         int stream_index;
492         if (!parse_packet_header(pb, &pkt_type, &pkt_len)) {
493             if (!url_feof(pb))
494                 av_log(s, AV_LOG_ERROR, "sync lost\n");
495             return -1;
496         }
497         if (pkt_type == PKT_FLT) {
498             gxf_read_index(s, pkt_len);
499             continue;
500         }
501         if (pkt_type != PKT_MEDIA) {
502             avio_skip(pb, pkt_len);
503             continue;
504         }
505         if (pkt_len < 16) {
506             av_log(s, AV_LOG_ERROR, "invalid media packet length\n");
507             continue;
508         }
509         pkt_len -= 16;
510         track_type = avio_r8(pb);
511         track_id = avio_r8(pb);
512         stream_index = get_sindex(s, track_id, track_type);
513         if (stream_index < 0)
514             return stream_index;
515         st = s->streams[stream_index];
516         field_nr = avio_rb32(pb);
517         field_info = avio_rb32(pb);
518         avio_rb32(pb); // "timeline" field number
519         avio_r8(pb); // flags
520         avio_r8(pb); // reserved
521         if (st->codec->codec_id == AV_CODEC_ID_PCM_S24LE ||
522             st->codec->codec_id == AV_CODEC_ID_PCM_S16LE) {
523             int first = field_info >> 16;
524             int last  = field_info & 0xffff; // last is exclusive
525             int bps = av_get_bits_per_sample(st->codec->codec_id)>>3;
526             if (first <= last && last*bps <= pkt_len) {
527                 avio_skip(pb, first*bps);
528                 skip = pkt_len - last*bps;
529                 pkt_len = (last-first)*bps;
530             } else
531                 av_log(s, AV_LOG_ERROR, "invalid first and last sample values\n");
532         }
533         ret = av_get_packet(pb, pkt, pkt_len);
534         if (skip)
535             avio_skip(pb, skip);
536         pkt->stream_index = stream_index;
537         pkt->dts = field_nr;
538
539         //set duration manually for DV or else lavf misdetects the frame rate
540         if (st->codec->codec_id == AV_CODEC_ID_DVVIDEO)
541             pkt->duration = si->fields_per_frame;
542
543         return ret;
544     }
545     return AVERROR_EOF;
546 }
547
548 static int gxf_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags) {
549     int res = 0;
550     uint64_t pos;
551     uint64_t maxlen = 100 * 1024 * 1024;
552     AVStream *st = s->streams[0];
553     int64_t start_time = s->streams[stream_index]->start_time;
554     int64_t found;
555     int idx;
556     if (timestamp < start_time) timestamp = start_time;
557     idx = av_index_search_timestamp(st, timestamp - start_time,
558                                     AVSEEK_FLAG_ANY | AVSEEK_FLAG_BACKWARD);
559     if (idx < 0)
560         return -1;
561     pos = st->index_entries[idx].pos;
562     if (idx < st->nb_index_entries - 2)
563         maxlen = st->index_entries[idx + 2].pos - pos;
564     maxlen = FFMAX(maxlen, 200 * 1024);
565     res = avio_seek(s->pb, pos, SEEK_SET);
566     if (res < 0)
567         return res;
568     found = gxf_resync_media(s, maxlen, -1, timestamp);
569     if (FFABS(found - timestamp) > 4)
570         return -1;
571     return 0;
572 }
573
574 static int64_t gxf_read_timestamp(AVFormatContext *s, int stream_index,
575                                   int64_t *pos, int64_t pos_limit) {
576     AVIOContext *pb = s->pb;
577     int64_t res;
578     if (avio_seek(pb, *pos, SEEK_SET) < 0)
579         return AV_NOPTS_VALUE;
580     res = gxf_resync_media(s, pos_limit - *pos, -1, -1);
581     *pos = avio_tell(pb);
582     return res;
583 }
584
585 AVInputFormat ff_gxf_demuxer = {
586     .name           = "gxf",
587     .long_name      = NULL_IF_CONFIG_SMALL("GXF (General eXchange Format)"),
588     .priv_data_size = sizeof(struct gxf_stream_info),
589     .read_probe     = gxf_probe,
590     .read_header    = gxf_header,
591     .read_packet    = gxf_packet,
592     .read_seek      = gxf_seek,
593     .read_timestamp = gxf_read_timestamp,
594 };