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