libavformat/mxfdec.c

   1 /*
   2  * MXF demuxer.
   3  * Copyright (c) 2006 SmartJog S.A., Baptiste Coudurier <baptiste dot coudurier at smartjog dot com>.
   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  * References
  24  * SMPTE 336M KLV Data Encoding Protocol Using Key-Length-Value
  25  * SMPTE 377M MXF File Format Specifications
  26  * SMPTE 378M Operational Pattern 1a
  27  * SMPTE 379M MXF Generic Container
  28  * SMPTE 381M Mapping MPEG Streams into the MXF Generic Container
  29  * SMPTE 382M Mapping AES3 and Broadcast Wave Audio into the MXF Generic Container
  30  * SMPTE 383M Mapping DV-DIF Data to the MXF Generic Container
  31  *
  32  * Principle
  33  * Search for Track numbers which will identify essence element KLV packets.
  34  * Search for SourcePackage which define tracks which contains Track numbers.
  35  * Material Package contains tracks with reference to SourcePackage tracks.
  36  * Search for Descriptors (Picture, Sound) which contains codec info and parameters.
  37  * Assign Descriptors to correct Tracks.
  38  *
  39  * Metadata reading functions read Local Tags, get InstanceUID(0x3C0A) then add MetaDataSet to MXFContext.
  40  * Metadata parsing resolves Strong References to objects.
  41  *
  42  * Simple demuxer, only OP1A supported and some files might not work at all.
  43  * Only tracks with associated descriptors will be decoded. "Highly Desirable" SMPTE 377M D.1
  44  */
  45
  46 //#define DEBUG
  47
  48 #include "libavutil/aes.h"
  49 #include "mxf.h"
  50
  51 typedef struct {
  52     UID uid;
  53     enum MXFMetadataSetType type;
  54     UID source_container_ul;
  55 } MXFCryptoContext;
  56
  57 typedef struct {
  58     UID uid;
  59     enum MXFMetadataSetType type;
  60     UID source_package_uid;
  61     UID data_definition_ul;
  62     int64_t duration;
  63     int64_t start_position;
  64     int source_track_id;
  65 } MXFStructuralComponent;
  66
  67 typedef struct {
  68     UID uid;
  69     enum MXFMetadataSetType type;
  70     UID data_definition_ul;
  71     UID *structural_components_refs;
  72     int structural_components_count;
  73     int64_t duration;
  74 } MXFSequence;
  75
  76 typedef struct {
  77     UID uid;
  78     enum MXFMetadataSetType type;
  79     MXFSequence *sequence; /* mandatory, and only one */
  80     UID sequence_ref;
  81     int track_id;
  82     uint8_t track_number[4];
  83     AVRational edit_rate;
  84 } MXFTrack;
  85
  86 typedef struct {
  87     UID uid;
  88     enum MXFMetadataSetType type;
  89     UID essence_container_ul;
  90     UID essence_codec_ul;
  91     AVRational sample_rate;
  92     AVRational aspect_ratio;
  93     int width;
  94     int height;
  95     int channels;
  96     int bits_per_sample;
  97     UID *sub_descriptors_refs;
  98     int sub_descriptors_count;
  99     int linked_track_id;
 100     uint8_t *extradata;
 101     int extradata_size;
 102 } MXFDescriptor;
 103
 104 typedef struct {
 105     UID uid;
 106     enum MXFMetadataSetType type;
 107     UID package_uid;
 108     UID *tracks_refs;
 109     int tracks_count;
 110     MXFDescriptor *descriptor; /* only one */
 111     UID descriptor_ref;
 112 } MXFPackage;
 113
 114 typedef struct {
 115     UID uid;
 116     enum MXFMetadataSetType type;
 117 } MXFMetadataSet;
 118
 119 typedef struct {
 120     UID *packages_refs;
 121     int packages_count;
 122     MXFMetadataSet **metadata_sets;
 123     int metadata_sets_count;
 124     AVFormatContext *fc;
 125     struct AVAES *aesc;
 126     uint8_t *local_tags;
 127     int local_tags_count;
 128 } MXFContext;
 129
 130 enum MXFWrappingScheme {
 131     Frame,
 132     Clip,
 133 };
 134
 135 typedef struct {
 136     const UID key;
 137     int (*read)();
 138     int ctx_size;
 139     enum MXFMetadataSetType type;
 140 } MXFMetadataReadTableEntry;
 141
 142 /* partial keys to match */
 143 static const uint8_t mxf_header_partition_pack_key[]       = { 0x06,0x0e,0x2b,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x02 };
 144 static const uint8_t mxf_essence_element_key[]             = { 0x06,0x0e,0x2b,0x34,0x01,0x02,0x01,0x01,0x0d,0x01,0x03,0x01 };
 145 static const uint8_t mxf_klv_key[]                         = { 0x06,0x0e,0x2b,0x34 };
 146 /* complete keys to match */
 147 static const uint8_t mxf_crypto_source_container_ul[]      = { 0x06,0x0e,0x2b,0x34,0x01,0x01,0x01,0x09,0x06,0x01,0x01,0x02,0x02,0x00,0x00,0x00 };
 148 static const uint8_t mxf_encrypted_triplet_key[]           = { 0x06,0x0e,0x2b,0x34,0x02,0x04,0x01,0x07,0x0d,0x01,0x03,0x01,0x02,0x7e,0x01,0x00 };
 149 static const uint8_t mxf_encrypted_essence_container[]     = { 0x06,0x0e,0x2b,0x34,0x04,0x01,0x01,0x07,0x0d,0x01,0x03,0x01,0x02,0x0b,0x01,0x00 };
 150 static const uint8_t mxf_sony_mpeg4_extradata[]            = { 0x06,0x0e,0x2b,0x34,0x04,0x01,0x01,0x01,0x0e,0x06,0x06,0x02,0x02,0x01,0x00,0x00 };
 151
 152 #define IS_KLV_KEY(x, y) (!memcmp(x, y, sizeof(y)))
 153
 154 static int64_t klv_decode_ber_length(ByteIOContext *pb)
 155 {
 156     uint64_t size = get_byte(pb);
 157     if (size & 0x80) { /* long form */
 158         int bytes_num = size & 0x7f;
 159         /* SMPTE 379M 5.3.4 guarantee that bytes_num must not exceed 8 bytes */
 160         if (bytes_num > 8)
 161             return -1;
 162         size = 0;
 163         while (bytes_num--)
 164             size = size << 8 | get_byte(pb);
 165     }
 166     return size;
 167 }
 168
 169 static int mxf_read_sync(ByteIOContext *pb, const uint8_t *key, unsigned size)
 170 {
 171     int i, b;
 172     for (i = 0; i < size && !url_feof(pb); i++) {
 173         b = get_byte(pb);
 174         if (b == key[0])
 175             i = 0;
 176         else if (b != key[i])
 177             i = -1;
 178     }
 179     return i == size;
 180 }
 181
 182 static int klv_read_packet(KLVPacket *klv, ByteIOContext *pb)
 183 {
 184     if (!mxf_read_sync(pb, mxf_klv_key, 4))
 185         return -1;
 186     klv->offset = url_ftell(pb) - 4;
 187     memcpy(klv->key, mxf_klv_key, 4);
 188     get_buffer(pb, klv->key + 4, 12);
 189     klv->length = klv_decode_ber_length(pb);
 190     return klv->length == -1 ? -1 : 0;
 191 }
 192
 193 static int mxf_get_stream_index(AVFormatContext *s, KLVPacket *klv)
 194 {
 195     int i;
 196
 197     for (i = 0; i < s->nb_streams; i++) {
 198         MXFTrack *track = s->streams[i]->priv_data;
 199         /* SMPTE 379M 7.3 */
 200         if (!memcmp(klv->key + sizeof(mxf_essence_element_key), track->track_number, sizeof(track->track_number)))
 201             return i;
 202     }
 203     /* return 0 if only one stream, for OP Atom files with 0 as track number */
 204     return s->nb_streams == 1 ? 0 : -1;
 205 }
 206
 207 /* XXX: use AVBitStreamFilter */
 208 static int mxf_get_d10_aes3_packet(ByteIOContext *pb, AVStream *st, AVPacket *pkt, int64_t length)
 209 {
 210     uint8_t buffer[61444];
 211     const uint8_t *buf_ptr, *end_ptr;
 212     uint8_t *data_ptr;
 213     int i;
 214
 215     if (length > 61444) /* worst case PAL 1920 samples 8 channels */
 216         return -1;
 217     get_buffer(pb, buffer, length);
 218     av_new_packet(pkt, length);
 219     data_ptr = pkt->data;
 220     end_ptr = buffer + length;
 221     buf_ptr = buffer + 4; /* skip SMPTE 331M header */
 222     for (; buf_ptr < end_ptr; ) {
 223         for (i = 0; i < st->codec->channels; i++) {
 224             uint32_t sample = bytestream_get_le32(&buf_ptr);
 225             if (st->codec->bits_per_coded_sample == 24)
 226                 bytestream_put_le24(&data_ptr, (sample >> 4) & 0xffffff);
 227             else
 228                 bytestream_put_le16(&data_ptr, (sample >> 12) & 0xffff);
 229         }
 230         buf_ptr += 32 - st->codec->channels*4; // always 8 channels stored SMPTE 331M
 231     }
 232     pkt->size = data_ptr - pkt->data;
 233     return 0;
 234 }
 235
 236 static int mxf_decrypt_triplet(AVFormatContext *s, AVPacket *pkt, KLVPacket *klv)
 237 {
 238     static const uint8_t checkv[16] = {0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b};
 239     MXFContext *mxf = s->priv_data;
 240     ByteIOContext *pb = s->pb;
 241     int64_t end = url_ftell(pb) + klv->length;
 242     uint64_t size;
 243     uint64_t orig_size;
 244     uint64_t plaintext_size;
 245     uint8_t ivec[16];
 246     uint8_t tmpbuf[16];
 247     int index;
 248
 249     if (!mxf->aesc && s->key && s->keylen == 16) {
 250         mxf->aesc = av_malloc(av_aes_size);
 251         if (!mxf->aesc)
 252             return -1;
 253         av_aes_init(mxf->aesc, s->key, 128, 1);
 254     }
 255     // crypto context
 256     url_fskip(pb, klv_decode_ber_length(pb));
 257     // plaintext offset
 258     klv_decode_ber_length(pb);
 259     plaintext_size = get_be64(pb);
 260     // source klv key
 261     klv_decode_ber_length(pb);
 262     get_buffer(pb, klv->key, 16);
 263     if (!IS_KLV_KEY(klv, mxf_essence_element_key))
 264         return -1;
 265     index = mxf_get_stream_index(s, klv);
 266     if (index < 0)
 267         return -1;
 268     // source size
 269     klv_decode_ber_length(pb);
 270     orig_size = get_be64(pb);
 271     if (orig_size < plaintext_size)
 272         return -1;
 273     // enc. code
 274     size = klv_decode_ber_length(pb);
 275     if (size < 32 || size - 32 < orig_size)
 276         return -1;
 277     get_buffer(pb, ivec, 16);
 278     get_buffer(pb, tmpbuf, 16);
 279     if (mxf->aesc)
 280         av_aes_crypt(mxf->aesc, tmpbuf, tmpbuf, 1, ivec, 1);
 281     if (memcmp(tmpbuf, checkv, 16))
 282         av_log(s, AV_LOG_ERROR, "probably incorrect decryption key\n");
 283     size -= 32;
 284     av_get_packet(pb, pkt, size);
 285     size -= plaintext_size;
 286     if (mxf->aesc)
 287         av_aes_crypt(mxf->aesc, &pkt->data[plaintext_size],
 288                      &pkt->data[plaintext_size], size >> 4, ivec, 1);
 289     pkt->size = orig_size;
 290     pkt->stream_index = index;
 291     url_fskip(pb, end - url_ftell(pb));
 292     return 0;
 293 }
 294
 295 static int mxf_read_packet(AVFormatContext *s, AVPacket *pkt)
 296 {
 297     KLVPacket klv;
 298
 299     while (!url_feof(s->pb)) {
 300         if (klv_read_packet(&klv, s->pb) < 0)
 301             return -1;
 302         PRINT_KEY(s, "read packet", klv.key);
 303         if (IS_KLV_KEY(klv.key, mxf_encrypted_triplet_key)) {
 304             int res = mxf_decrypt_triplet(s, pkt, &klv);
 305             if (res < 0) {
 306                 av_log(s, AV_LOG_ERROR, "invalid encoded triplet\n");
 307                 return -1;
 308             }
 309             return 0;
 310         }
 311         if (IS_KLV_KEY(klv.key, mxf_essence_element_key)) {
 312             int index = mxf_get_stream_index(s, &klv);
 313             if (index < 0) {
 314                 av_log(s, AV_LOG_ERROR, "error getting stream index %d\n", AV_RB32(klv.key+12));
 315                 goto skip;
 316             }
 317             if (s->streams[index]->discard == AVDISCARD_ALL)
 318                 goto skip;
 319             /* check for 8 channels AES3 element */
 320             if (klv.key[12] == 0x06 && klv.key[13] == 0x01 && klv.key[14] == 0x10) {
 321                 if (mxf_get_d10_aes3_packet(s->pb, s->streams[index], pkt, klv.length) < 0) {
 322                     av_log(s, AV_LOG_ERROR, "error reading D-10 aes3 frame\n");
 323                     return -1;
 324                 }
 325             } else
 326                 av_get_packet(s->pb, pkt, klv.length);
 327             pkt->stream_index = index;
 328             pkt->pos = klv.offset;
 329             return 0;
 330         } else
 331         skip:
 332             url_fskip(s->pb, klv.length);
 333     }
 334     return AVERROR(EIO);
 335 }
 336
 337 static int mxf_read_primer_pack(MXFContext *mxf)
 338 {
 339     ByteIOContext *pb = mxf->fc->pb;
 340     int item_num = get_be32(pb);
 341     int item_len = get_be32(pb);
 342
 343     if (item_len != 18) {
 344         av_log(mxf->fc, AV_LOG_ERROR, "unsupported primer pack item length\n");
 345         return -1;
 346     }
 347     if (item_num > UINT_MAX / item_len)
 348         return -1;
 349     mxf->local_tags_count = item_num;
 350     mxf->local_tags = av_malloc(item_num*item_len);
 351     if (!mxf->local_tags)
 352         return -1;
 353     get_buffer(pb, mxf->local_tags, item_num*item_len);
 354     return 0;
 355 }
 356
 357 static int mxf_add_metadata_set(MXFContext *mxf, void *metadata_set)
 358 {
 359     mxf->metadata_sets = av_realloc(mxf->metadata_sets, (mxf->metadata_sets_count + 1) * sizeof(*mxf->metadata_sets));
 360     if (!mxf->metadata_sets)
 361         return -1;
 362     mxf->metadata_sets[mxf->metadata_sets_count] = metadata_set;
 363     mxf->metadata_sets_count++;
 364     return 0;
 365 }
 366
 367 static int mxf_read_cryptographic_context(MXFCryptoContext *cryptocontext, ByteIOContext *pb, int tag, int size, UID uid)
 368 {
 369     if (size != 16)
 370         return -1;
 371     if (IS_KLV_KEY(uid, mxf_crypto_source_container_ul))
 372         get_buffer(pb, cryptocontext->source_container_ul, 16);
 373     return 0;
 374 }
 375
 376 static int mxf_read_content_storage(MXFContext *mxf, ByteIOContext *pb, int tag)
 377 {
 378     switch (tag) {
 379     case 0x1901:
 380         mxf->packages_count = get_be32(pb);
 381         if (mxf->packages_count >= UINT_MAX / sizeof(UID))
 382             return -1;
 383         mxf->packages_refs = av_malloc(mxf->packages_count * sizeof(UID));
 384         if (!mxf->packages_refs)
 385             return -1;
 386         url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
 387         get_buffer(pb, (uint8_t *)mxf->packages_refs, mxf->packages_count * sizeof(UID));
 388         break;
 389     }
 390     return 0;
 391 }
 392
 393 static int mxf_read_source_clip(MXFStructuralComponent *source_clip, ByteIOContext *pb, int tag)
 394 {
 395     switch(tag) {
 396     case 0x0202:
 397         source_clip->duration = get_be64(pb);
 398         break;
 399     case 0x1201:
 400         source_clip->start_position = get_be64(pb);
 401         break;
 402     case 0x1101:
 403         /* UMID, only get last 16 bytes */
 404         url_fskip(pb, 16);
 405         get_buffer(pb, source_clip->source_package_uid, 16);
 406         break;
 407     case 0x1102:
 408         source_clip->source_track_id = get_be32(pb);
 409         break;
 410     }
 411     return 0;
 412 }
 413
 414 static int mxf_read_material_package(MXFPackage *package, ByteIOContext *pb, int tag)
 415 {
 416     switch(tag) {
 417     case 0x4403:
 418         package->tracks_count = get_be32(pb);
 419         if (package->tracks_count >= UINT_MAX / sizeof(UID))
 420             return -1;
 421         package->tracks_refs = av_malloc(package->tracks_count * sizeof(UID));
 422         if (!package->tracks_refs)
 423             return -1;
 424         url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
 425         get_buffer(pb, (uint8_t *)package->tracks_refs, package->tracks_count * sizeof(UID));
 426         break;
 427     }
 428     return 0;
 429 }
 430
 431 static int mxf_read_track(MXFTrack *track, ByteIOContext *pb, int tag)
 432 {
 433     switch(tag) {
 434     case 0x4801:
 435         track->track_id = get_be32(pb);
 436         break;
 437     case 0x4804:
 438         get_buffer(pb, track->track_number, 4);
 439         break;
 440     case 0x4B01:
 441         track->edit_rate.den = get_be32(pb);
 442         track->edit_rate.num = get_be32(pb);
 443         break;
 444     case 0x4803:
 445         get_buffer(pb, track->sequence_ref, 16);
 446         break;
 447     }
 448     return 0;
 449 }
 450
 451 static int mxf_read_sequence(MXFSequence *sequence, ByteIOContext *pb, int tag)
 452 {
 453     switch(tag) {
 454     case 0x0202:
 455         sequence->duration = get_be64(pb);
 456         break;
 457     case 0x0201:
 458         get_buffer(pb, sequence->data_definition_ul, 16);
 459         break;
 460     case 0x1001:
 461         sequence->structural_components_count = get_be32(pb);
 462         if (sequence->structural_components_count >= UINT_MAX / sizeof(UID))
 463             return -1;
 464         sequence->structural_components_refs = av_malloc(sequence->structural_components_count * sizeof(UID));
 465         if (!sequence->structural_components_refs)
 466             return -1;
 467         url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
 468         get_buffer(pb, (uint8_t *)sequence->structural_components_refs, sequence->structural_components_count * sizeof(UID));
 469         break;
 470     }
 471     return 0;
 472 }
 473
 474 static int mxf_read_source_package(MXFPackage *package, ByteIOContext *pb, int tag)
 475 {
 476     switch(tag) {
 477     case 0x4403:
 478         package->tracks_count = get_be32(pb);
 479         if (package->tracks_count >= UINT_MAX / sizeof(UID))
 480             return -1;
 481         package->tracks_refs = av_malloc(package->tracks_count * sizeof(UID));
 482         if (!package->tracks_refs)
 483             return -1;
 484         url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
 485         get_buffer(pb, (uint8_t *)package->tracks_refs, package->tracks_count * sizeof(UID));
 486         break;
 487     case 0x4401:
 488         /* UMID, only get last 16 bytes */
 489         url_fskip(pb, 16);
 490         get_buffer(pb, package->package_uid, 16);
 491         break;
 492     case 0x4701:
 493         get_buffer(pb, package->descriptor_ref, 16);
 494         break;
 495     }
 496     return 0;
 497 }
 498
 499 static void mxf_read_pixel_layout(ByteIOContext *pb, MXFDescriptor *descriptor)
 500 {
 501     int code;
 502
 503     do {
 504         code = get_byte(pb);
 505         dprintf(NULL, "pixel layout: code 0x%x\n", code);
 506         switch (code) {
 507         case 0x52: /* R */
 508             descriptor->bits_per_sample += get_byte(pb);
 509             break;
 510         case 0x47: /* G */
 511             descriptor->bits_per_sample += get_byte(pb);
 512             break;
 513         case 0x42: /* B */
 514             descriptor->bits_per_sample += get_byte(pb);
 515             break;
 516         default:
 517             get_byte(pb);
 518         }
 519     } while (code != 0); /* SMPTE 377M E.2.46 */
 520 }
 521
 522 static int mxf_read_generic_descriptor(MXFDescriptor *descriptor, ByteIOContext *pb, int tag, int size, UID uid)
 523 {
 524     switch(tag) {
 525     case 0x3F01:
 526         descriptor->sub_descriptors_count = get_be32(pb);
 527         if (descriptor->sub_descriptors_count >= UINT_MAX / sizeof(UID))
 528             return -1;
 529         descriptor->sub_descriptors_refs = av_malloc(descriptor->sub_descriptors_count * sizeof(UID));
 530         if (!descriptor->sub_descriptors_refs)
 531             return -1;
 532         url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
 533         get_buffer(pb, (uint8_t *)descriptor->sub_descriptors_refs, descriptor->sub_descriptors_count * sizeof(UID));
 534         break;
 535     case 0x3004:
 536         get_buffer(pb, descriptor->essence_container_ul, 16);
 537         break;
 538     case 0x3006:
 539         descriptor->linked_track_id = get_be32(pb);
 540         break;
 541     case 0x3201: /* PictureEssenceCoding */
 542         get_buffer(pb, descriptor->essence_codec_ul, 16);
 543         break;
 544     case 0x3203:
 545         descriptor->width = get_be32(pb);
 546         break;
 547     case 0x3202:
 548         descriptor->height = get_be32(pb);
 549         break;
 550     case 0x320E:
 551         descriptor->aspect_ratio.num = get_be32(pb);
 552         descriptor->aspect_ratio.den = get_be32(pb);
 553         break;
 554     case 0x3D03:
 555         descriptor->sample_rate.num = get_be32(pb);
 556         descriptor->sample_rate.den = get_be32(pb);
 557         break;
 558     case 0x3D06: /* SoundEssenceCompression */
 559         get_buffer(pb, descriptor->essence_codec_ul, 16);
 560         break;
 561     case 0x3D07:
 562         descriptor->channels = get_be32(pb);
 563         break;
 564     case 0x3D01:
 565         descriptor->bits_per_sample = get_be32(pb);
 566         break;
 567     case 0x3401:
 568         mxf_read_pixel_layout(pb, descriptor);
 569         break;
 570     default:
 571         /* Private uid used by SONY C0023S01.mxf */
 572         if (IS_KLV_KEY(uid, mxf_sony_mpeg4_extradata)) {
 573             descriptor->extradata = av_malloc(size);
 574             if (!descriptor->extradata)
 575                 return -1;
 576             descriptor->extradata_size = size;
 577             get_buffer(pb, descriptor->extradata, size);
 578         }
 579         break;
 580     }
 581     return 0;
 582 }
 583
 584 /*
 585  * Match an uid independently of the version byte and up to len common bytes
 586  * Returns: boolean
 587  */
 588 static int mxf_match_uid(const UID key, const UID uid, int len)
 589 {
 590     int i;
 591     for (i = 0; i < len; i++) {
 592         if (i != 7 && key[i] != uid[i])
 593             return 0;
 594     }
 595     return 1;
 596 }
 597
 598 static const MXFCodecUL *mxf_get_codec_ul(const MXFCodecUL *uls, UID *uid)
 599 {
 600     while (uls->id != CODEC_ID_NONE) {
 601         if(mxf_match_uid(uls->uid, *uid, uls->matching_len))
 602             break;
 603         uls++;
 604     }
 605     return uls;
 606 }
 607
 608 static enum CodecType mxf_get_codec_type(const MXFDataDefinitionUL *uls, UID *uid)
 609 {
 610     while (uls->type != CODEC_TYPE_DATA) {
 611         if(mxf_match_uid(uls->uid, *uid, 16))
 612             break;
 613         uls++;
 614     }
 615     return uls->type;
 616 }
 617
 618 static void *mxf_resolve_strong_ref(MXFContext *mxf, UID *strong_ref, enum MXFMetadataSetType type)
 619 {
 620     int i;
 621
 622     if (!strong_ref)
 623         return NULL;
 624     for (i = 0; i < mxf->metadata_sets_count; i++) {
 625         if (!memcmp(*strong_ref, mxf->metadata_sets[i]->uid, 16) &&
 626             (type == AnyType || mxf->metadata_sets[i]->type == type)) {
 627             return mxf->metadata_sets[i];
 628         }
 629     }
 630     return NULL;
 631 }
 632
 633 static const MXFCodecUL mxf_essence_container_uls[] = {
 634     // video essence container uls
 635     { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x02,0x0D,0x01,0x03,0x01,0x02,0x04,0x60,0x01 }, 14, CODEC_ID_MPEG2VIDEO }, /* MPEG-ES Frame wrapped */
 636     { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x02,0x41,0x01 }, 14,    CODEC_ID_DVVIDEO }, /* DV 625 25mbps */
 637     // sound essence container uls
 638     { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x06,0x01,0x00 }, 14, CODEC_ID_PCM_S16LE }, /* BWF Frame wrapped */
 639     { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x02,0x0D,0x01,0x03,0x01,0x02,0x04,0x40,0x01 }, 14,       CODEC_ID_MP2 }, /* MPEG-ES Frame wrapped, 0x40 ??? stream id */
 640     { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x01,0x01,0x01 }, 14, CODEC_ID_PCM_S16LE }, /* D-10 Mapping 50Mbps PAL Extended Template */
 641     { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 },  0,      CODEC_ID_NONE },
 642 };
 643
 644 static int mxf_parse_structural_metadata(MXFContext *mxf)
 645 {
 646     MXFPackage *material_package = NULL;
 647     MXFPackage *temp_package = NULL;
 648     int i, j, k;
 649
 650     dprintf(mxf->fc, "metadata sets count %d\n", mxf->metadata_sets_count);
 651     /* TODO: handle multiple material packages (OP3x) */
 652     for (i = 0; i < mxf->packages_count; i++) {
 653         material_package = mxf_resolve_strong_ref(mxf, &mxf->packages_refs[i], MaterialPackage);
 654         if (material_package) break;
 655     }
 656     if (!material_package) {
 657         av_log(mxf->fc, AV_LOG_ERROR, "no material package found\n");
 658         return -1;
 659     }
 660
 661     for (i = 0; i < material_package->tracks_count; i++) {
 662         MXFPackage *source_package = NULL;
 663         MXFTrack *material_track = NULL;
 664         MXFTrack *source_track = NULL;
 665         MXFTrack *temp_track = NULL;
 666         MXFDescriptor *descriptor = NULL;
 667         MXFStructuralComponent *component = NULL;
 668         UID *essence_container_ul = NULL;
 669         const MXFCodecUL *codec_ul = NULL;
 670         const MXFCodecUL *container_ul = NULL;
 671         AVStream *st;
 672
 673         if (!(material_track = mxf_resolve_strong_ref(mxf, &material_package->tracks_refs[i], Track))) {
 674             av_log(mxf->fc, AV_LOG_ERROR, "could not resolve material track strong ref\n");
 675             continue;
 676         }
 677
 678         if (!(material_track->sequence = mxf_resolve_strong_ref(mxf, &material_track->sequence_ref, Sequence))) {
 679             av_log(mxf->fc, AV_LOG_ERROR, "could not resolve material track sequence strong ref\n");
 680             return -1;
 681         }
 682
 683         /* TODO: handle multiple source clips */
 684         for (j = 0; j < material_track->sequence->structural_components_count; j++) {
 685             /* TODO: handle timecode component */
 686             component = mxf_resolve_strong_ref(mxf, &material_track->sequence->structural_components_refs[j], SourceClip);
 687             if (!component)
 688                 continue;
 689
 690             for (k = 0; k < mxf->packages_count; k++) {
 691                 temp_package = mxf_resolve_strong_ref(mxf, &mxf->packages_refs[k], SourcePackage);
 692                 if (!temp_package)
 693                     continue;
 694                 if (!memcmp(temp_package->package_uid, component->source_package_uid, 16)) {
 695                     source_package = temp_package;
 696                     break;
 697                 }
 698             }
 699             if (!source_package) {
 700                 av_log(mxf->fc, AV_LOG_ERROR, "material track %d: no corresponding source package found\n", material_track->track_id);
 701                 break;
 702             }
 703             for (k = 0; k < source_package->tracks_count; k++) {
 704                 if (!(temp_track = mxf_resolve_strong_ref(mxf, &source_package->tracks_refs[k], Track))) {
 705                     av_log(mxf->fc, AV_LOG_ERROR, "could not resolve source track strong ref\n");
 706                     return -1;
 707                 }
 708                 if (temp_track->track_id == component->source_track_id) {
 709                     source_track = temp_track;
 710                     break;
 711                 }
 712             }
 713             if (!source_track) {
 714                 av_log(mxf->fc, AV_LOG_ERROR, "material track %d: no corresponding source track found\n", material_track->track_id);
 715                 break;
 716             }
 717         }
 718         if (!source_track)
 719             continue;
 720
 721         st = av_new_stream(mxf->fc, source_track->track_id);
 722         if (!st) {
 723             av_log(mxf->fc, AV_LOG_ERROR, "could not allocate stream\n");
 724             return -1;
 725         }
 726         st->priv_data = source_track;
 727         st->duration = component->duration;
 728         if (st->duration == -1)
 729             st->duration = AV_NOPTS_VALUE;
 730         st->start_time = component->start_position;
 731         av_set_pts_info(st, 64, material_track->edit_rate.num, material_track->edit_rate.den);
 732
 733         if (!(source_track->sequence = mxf_resolve_strong_ref(mxf, &source_track->sequence_ref, Sequence))) {
 734             av_log(mxf->fc, AV_LOG_ERROR, "could not resolve source track sequence strong ref\n");
 735             return -1;
 736         }
 737
 738         PRINT_KEY(mxf->fc, "data definition   ul", source_track->sequence->data_definition_ul);
 739         st->codec->codec_type = mxf_get_codec_type(ff_mxf_data_definition_uls, &source_track->sequence->data_definition_ul);
 740
 741         source_package->descriptor = mxf_resolve_strong_ref(mxf, &source_package->descriptor_ref, AnyType);
 742         if (source_package->descriptor) {
 743             if (source_package->descriptor->type == MultipleDescriptor) {
 744                 for (j = 0; j < source_package->descriptor->sub_descriptors_count; j++) {
 745                     MXFDescriptor *sub_descriptor = mxf_resolve_strong_ref(mxf, &source_package->descriptor->sub_descriptors_refs[j], Descriptor);
 746
 747                     if (!sub_descriptor) {
 748                         av_log(mxf->fc, AV_LOG_ERROR, "could not resolve sub descriptor strong ref\n");
 749                         continue;
 750                     }
 751                     if (sub_descriptor->linked_track_id == source_track->track_id) {
 752                         descriptor = sub_descriptor;
 753                         break;
 754                     }
 755                 }
 756             } else if (source_package->descriptor->type == Descriptor)
 757                 descriptor = source_package->descriptor;
 758         }
 759         if (!descriptor) {
 760             av_log(mxf->fc, AV_LOG_INFO, "source track %d: stream %d, no descriptor found\n", source_track->track_id, st->index);
 761             continue;
 762         }
 763         PRINT_KEY(mxf->fc, "essence codec     ul", descriptor->essence_codec_ul);
 764         PRINT_KEY(mxf->fc, "essence container ul", descriptor->essence_container_ul);
 765         essence_container_ul = &descriptor->essence_container_ul;
 766         /* HACK: replacing the original key with mxf_encrypted_essence_container
 767          * is not allowed according to s429-6, try to find correct information anyway */
 768         if (IS_KLV_KEY(essence_container_ul, mxf_encrypted_essence_container)) {
 769             av_log(mxf->fc, AV_LOG_INFO, "broken encrypted mxf file\n");
 770             for (k = 0; k < mxf->metadata_sets_count; k++) {
 771                 MXFMetadataSet *metadata = mxf->metadata_sets[k];
 772                 if (metadata->type == CryptoContext) {
 773                     essence_container_ul = &((MXFCryptoContext *)metadata)->source_container_ul;
 774                     break;
 775                 }
 776             }
 777         }
 778         /* TODO: drop PictureEssenceCoding and SoundEssenceCompression, only check EssenceContainer */
 779         codec_ul = mxf_get_codec_ul(ff_mxf_codec_uls, &descriptor->essence_codec_ul);
 780         st->codec->codec_id = codec_ul->id;
 781         if (descriptor->extradata) {
 782             st->codec->extradata = descriptor->extradata;
 783             st->codec->extradata_size = descriptor->extradata_size;
 784         }
 785         if (st->codec->codec_type == CODEC_TYPE_VIDEO) {
 786             container_ul = mxf_get_codec_ul(mxf_essence_container_uls, essence_container_ul);
 787             if (st->codec->codec_id == CODEC_ID_NONE)
 788                 st->codec->codec_id = container_ul->id;
 789             st->codec->width = descriptor->width;
 790             st->codec->height = descriptor->height;
 791             st->codec->bits_per_coded_sample = descriptor->bits_per_sample; /* Uncompressed */
 792             st->need_parsing = AVSTREAM_PARSE_HEADERS;
 793         } else if (st->codec->codec_type == CODEC_TYPE_AUDIO) {
 794             container_ul = mxf_get_codec_ul(mxf_essence_container_uls, essence_container_ul);
 795             if (st->codec->codec_id == CODEC_ID_NONE)
 796                 st->codec->codec_id = container_ul->id;
 797             st->codec->channels = descriptor->channels;
 798             st->codec->bits_per_coded_sample = descriptor->bits_per_sample;
 799             st->codec->sample_rate = descriptor->sample_rate.num / descriptor->sample_rate.den;
 800             /* TODO: implement CODEC_ID_RAWAUDIO */
 801             if (st->codec->codec_id == CODEC_ID_PCM_S16LE) {
 802                 if (descriptor->bits_per_sample == 24)
 803                     st->codec->codec_id = CODEC_ID_PCM_S24LE;
 804                 else if (descriptor->bits_per_sample == 32)
 805                     st->codec->codec_id = CODEC_ID_PCM_S32LE;
 806             } else if (st->codec->codec_id == CODEC_ID_PCM_S16BE) {
 807                 if (descriptor->bits_per_sample == 24)
 808                     st->codec->codec_id = CODEC_ID_PCM_S24BE;
 809                 else if (descriptor->bits_per_sample == 32)
 810                     st->codec->codec_id = CODEC_ID_PCM_S32BE;
 811             } else if (st->codec->codec_id == CODEC_ID_MP2) {
 812                 st->need_parsing = AVSTREAM_PARSE_FULL;
 813             }
 814         }
 815         if (st->codec->codec_type != CODEC_TYPE_DATA && (*essence_container_ul)[15] > 0x01) {
 816             av_log(mxf->fc, AV_LOG_WARNING, "only frame wrapped mappings are correctly supported\n");
 817             st->need_parsing = AVSTREAM_PARSE_FULL;
 818         }
 819     }
 820     return 0;
 821 }
 822
 823 static const MXFMetadataReadTableEntry mxf_metadata_read_table[] = {
 824     { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x05,0x01,0x00 }, mxf_read_primer_pack },
 825     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x18,0x00 }, mxf_read_content_storage, 0, AnyType },
 826     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x37,0x00 }, mxf_read_source_package, sizeof(MXFPackage), SourcePackage },
 827     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x36,0x00 }, mxf_read_material_package, sizeof(MXFPackage), MaterialPackage },
 828     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x0F,0x00 }, mxf_read_sequence, sizeof(MXFSequence), Sequence },
 829     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x11,0x00 }, mxf_read_source_clip, sizeof(MXFStructuralComponent), SourceClip },
 830     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x44,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), MultipleDescriptor },
 831     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x42,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* Generic Sound */
 832     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x28,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* CDCI */
 833     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x29,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* RGBA */
 834     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x51,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* MPEG 2 Video */
 835     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x48,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* Wave */
 836     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x47,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* AES3 */
 837     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x3A,0x00 }, mxf_read_track, sizeof(MXFTrack), Track }, /* Static Track */
 838     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x3B,0x00 }, mxf_read_track, sizeof(MXFTrack), Track }, /* Generic Track */
 839     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x04,0x01,0x02,0x02,0x00,0x00 }, mxf_read_cryptographic_context, sizeof(MXFCryptoContext), CryptoContext },
 840     { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, NULL, 0, AnyType },
 841 };
 842
 843 static int mxf_read_local_tags(MXFContext *mxf, KLVPacket *klv, int (*read_child)(), int ctx_size, enum MXFMetadataSetType type)
 844 {
 845     ByteIOContext *pb = mxf->fc->pb;
 846     MXFMetadataSet *ctx = ctx_size ? av_mallocz(ctx_size) : mxf;
 847     uint64_t klv_end = url_ftell(pb) + klv->length;
 848
 849     if (!ctx)
 850         return -1;
 851     while (url_ftell(pb) + 4 < klv_end) {
 852         int tag = get_be16(pb);
 853         int size = get_be16(pb); /* KLV specified by 0x53 */
 854         uint64_t next = url_ftell(pb) + size;
 855         UID uid = {0};
 856
 857         if (!size) { /* ignore empty tag, needed for some files with empty UMID tag */
 858             av_log(mxf->fc, AV_LOG_ERROR, "local tag 0x%04X with 0 size\n", tag);
 859             continue;
 860         }
 861         if (tag > 0x7FFF) { /* dynamic tag */
 862             int i;
 863             for (i = 0; i < mxf->local_tags_count; i++) {
 864                 int local_tag = AV_RB16(mxf->local_tags+i*18);
 865                 if (local_tag == tag) {
 866                     memcpy(uid, mxf->local_tags+i*18+2, 16);
 867                     dprintf(mxf->fc, "local tag 0x%04X\n", local_tag);
 868                     PRINT_KEY(mxf->fc, "uid", uid);
 869                 }
 870             }
 871         }
 872         if (ctx_size && tag == 0x3C0A)
 873             get_buffer(pb, ctx->uid, 16);
 874         else if (read_child(ctx, pb, tag, size, uid) < 0)
 875             return -1;
 876
 877         url_fseek(pb, next, SEEK_SET);
 878     }
 879     if (ctx_size) ctx->type = type;
 880     return ctx_size ? mxf_add_metadata_set(mxf, ctx) : 0;
 881 }
 882
 883 static int mxf_read_header(AVFormatContext *s, AVFormatParameters *ap)
 884 {
 885     MXFContext *mxf = s->priv_data;
 886     KLVPacket klv;
 887
 888     if (!mxf_read_sync(s->pb, mxf_header_partition_pack_key, 14)) {
 889         av_log(s, AV_LOG_ERROR, "could not find header partition pack key\n");
 890         return -1;
 891     }
 892     url_fseek(s->pb, -14, SEEK_CUR);
 893     mxf->fc = s;
 894     while (!url_feof(s->pb)) {
 895         const MXFMetadataReadTableEntry *metadata;
 896
 897         if (klv_read_packet(&klv, s->pb) < 0)
 898             return -1;
 899         PRINT_KEY(s, "read header", klv.key);
 900         if (IS_KLV_KEY(klv.key, mxf_encrypted_triplet_key) ||
 901             IS_KLV_KEY(klv.key, mxf_essence_element_key)) {
 902             /* FIXME avoid seek */
 903             url_fseek(s->pb, klv.offset, SEEK_SET);
 904             break;
 905         }
 906
 907         for (metadata = mxf_metadata_read_table; metadata->read; metadata++) {
 908             if (IS_KLV_KEY(klv.key, metadata->key)) {
 909                 int (*read)() = klv.key[5] == 0x53 ? mxf_read_local_tags : metadata->read;
 910                 if (read(mxf, &klv, metadata->read, metadata->ctx_size, metadata->type) < 0) {
 911                     av_log(s, AV_LOG_ERROR, "error reading header metadata\n");
 912                     return -1;
 913                 }
 914                 break;
 915             }
 916         }
 917         if (!metadata->read)
 918             url_fskip(s->pb, klv.length);
 919     }
 920     return mxf_parse_structural_metadata(mxf);
 921 }
 922
 923 static int mxf_read_close(AVFormatContext *s)
 924 {
 925     MXFContext *mxf = s->priv_data;
 926     int i;
 927
 928     av_freep(&mxf->packages_refs);
 929     for (i = 0; i < mxf->metadata_sets_count; i++) {
 930         switch (mxf->metadata_sets[i]->type) {
 931         case MultipleDescriptor:
 932             av_freep(&((MXFDescriptor *)mxf->metadata_sets[i])->sub_descriptors_refs);
 933             break;
 934         case Sequence:
 935             av_freep(&((MXFSequence *)mxf->metadata_sets[i])->structural_components_refs);
 936             break;
 937         case SourcePackage:
 938         case MaterialPackage:
 939             av_freep(&((MXFPackage *)mxf->metadata_sets[i])->tracks_refs);
 940             break;
 941         case Track:
 942             mxf->metadata_sets[i] = NULL; /* will be freed later */
 943             break;
 944         default:
 945             break;
 946         }
 947         av_freep(&mxf->metadata_sets[i]);
 948     }
 949     av_freep(&mxf->metadata_sets);
 950     av_freep(&mxf->aesc);
 951     av_freep(&mxf->local_tags);
 952     return 0;
 953 }
 954
 955 static int mxf_probe(AVProbeData *p) {
 956     uint8_t *bufp = p->buf;
 957     uint8_t *end = p->buf + p->buf_size;
 958
 959     if (p->buf_size < sizeof(mxf_header_partition_pack_key))
 960         return 0;
 961
 962     /* Must skip Run-In Sequence and search for MXF header partition pack key SMPTE 377M 5.5 */
 963     end -= sizeof(mxf_header_partition_pack_key);
 964     for (; bufp < end; bufp++) {
 965         if (IS_KLV_KEY(bufp, mxf_header_partition_pack_key))
 966             return AVPROBE_SCORE_MAX;
 967     }
 968     return 0;
 969 }
 970
 971 /* rudimentary byte seek */
 972 /* XXX: use MXF Index */
 973 static int mxf_read_seek(AVFormatContext *s, int stream_index, int64_t sample_time, int flags)
 974 {
 975     AVStream *st = s->streams[stream_index];
 976     int64_t seconds;
 977
 978     if (!s->bit_rate)
 979         return -1;
 980     if (sample_time < 0)
 981         sample_time = 0;
 982     seconds = av_rescale(sample_time, st->time_base.num, st->time_base.den);
 983     url_fseek(s->pb, (s->bit_rate * seconds) >> 3, SEEK_SET);
 984     av_update_cur_dts(s, st, sample_time);
 985     return 0;
 986 }
 987
 988 AVInputFormat mxf_demuxer = {
 989     "mxf",
 990     NULL_IF_CONFIG_SMALL("Material eXchange Format"),
 991     sizeof(MXFContext),
 992     mxf_probe,
 993     mxf_read_header,
 994     mxf_read_packet,
 995     mxf_read_close,
 996     mxf_read_seek,
 997 };