3 * Copyright (c) 2006 SmartJog S.A., Baptiste Coudurier <baptiste dot coudurier at smartjog dot com>
5 * This file is part of Libav.
7 * Libav is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * Libav is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with Libav; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
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
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.
39 * Metadata reading functions read Local Tags, get InstanceUID(0x3C0A) then add MetaDataSet to MXFContext.
40 * Metadata parsing resolves Strong References to objects.
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
48 #include "libavutil/aes.h"
49 #include "libavutil/mathematics.h"
50 #include "libavcodec/bytestream.h"
77 MXFPartitionType type;
78 uint64_t previous_partition;
79 uint64_t footer_partition;
86 enum MXFMetadataSetType type;
87 UID source_container_ul;
92 enum MXFMetadataSetType type;
93 UID source_package_uid;
94 UID data_definition_ul;
96 int64_t start_position;
98 } MXFStructuralComponent;
102 enum MXFMetadataSetType type;
103 UID data_definition_ul;
104 UID *structural_components_refs;
105 int structural_components_count;
111 enum MXFMetadataSetType type;
112 MXFSequence *sequence; /* mandatory, and only one */
115 uint8_t track_number[4];
116 AVRational edit_rate;
121 enum MXFMetadataSetType type;
122 UID essence_container_ul;
123 UID essence_codec_ul;
124 AVRational sample_rate;
125 AVRational aspect_ratio;
130 UID *sub_descriptors_refs;
131 int sub_descriptors_count;
135 enum PixelFormat pix_fmt;
140 enum MXFMetadataSetType type;
141 } MXFIndexTableSegment;
145 enum MXFMetadataSetType type;
149 MXFDescriptor *descriptor; /* only one */
155 enum MXFMetadataSetType type;
159 MXFPartition *partitions;
160 unsigned partitions_count;
164 MXFMetadataSet **metadata_sets;
165 int metadata_sets_count;
169 int local_tags_count;
172 enum MXFWrappingScheme {
177 typedef int MXFMetadataReadFunc(void *arg, AVIOContext *pb, int tag, int size, UID uid);
181 MXFMetadataReadFunc *read;
183 enum MXFMetadataSetType type;
184 } MXFMetadataReadTableEntry;
186 /* partial keys to match */
187 static const uint8_t mxf_header_partition_pack_key[] = { 0x06,0x0e,0x2b,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x02 };
188 static const uint8_t mxf_essence_element_key[] = { 0x06,0x0e,0x2b,0x34,0x01,0x02,0x01,0x01,0x0d,0x01,0x03,0x01 };
189 static const uint8_t mxf_klv_key[] = { 0x06,0x0e,0x2b,0x34 };
190 /* complete keys to match */
191 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 };
192 static const uint8_t mxf_encrypted_triplet_key[] = { 0x06,0x0e,0x2b,0x34,0x02,0x04,0x01,0x07,0x0d,0x01,0x03,0x01,0x02,0x7e,0x01,0x00 };
193 static const uint8_t mxf_encrypted_essence_container[] = { 0x06,0x0e,0x2b,0x34,0x04,0x01,0x01,0x07,0x0d,0x01,0x03,0x01,0x02,0x0b,0x01,0x00 };
194 static const uint8_t mxf_sony_mpeg4_extradata[] = { 0x06,0x0e,0x2b,0x34,0x04,0x01,0x01,0x01,0x0e,0x06,0x06,0x02,0x02,0x01,0x00,0x00 };
196 #define IS_KLV_KEY(x, y) (!memcmp(x, y, sizeof(y)))
198 static int64_t klv_decode_ber_length(AVIOContext *pb)
200 uint64_t size = avio_r8(pb);
201 if (size & 0x80) { /* long form */
202 int bytes_num = size & 0x7f;
203 /* SMPTE 379M 5.3.4 guarantee that bytes_num must not exceed 8 bytes */
205 return AVERROR_INVALIDDATA;
208 size = size << 8 | avio_r8(pb);
213 static int mxf_read_sync(AVIOContext *pb, const uint8_t *key, unsigned size)
216 for (i = 0; i < size && !pb->eof_reached; i++) {
220 else if (b != key[i])
226 static int klv_read_packet(KLVPacket *klv, AVIOContext *pb)
228 if (!mxf_read_sync(pb, mxf_klv_key, 4))
229 return AVERROR_INVALIDDATA;
230 klv->offset = avio_tell(pb) - 4;
231 memcpy(klv->key, mxf_klv_key, 4);
232 avio_read(pb, klv->key + 4, 12);
233 klv->length = klv_decode_ber_length(pb);
234 return klv->length == -1 ? -1 : 0;
237 static int mxf_get_stream_index(AVFormatContext *s, KLVPacket *klv)
241 for (i = 0; i < s->nb_streams; i++) {
242 MXFTrack *track = s->streams[i]->priv_data;
244 if (!memcmp(klv->key + sizeof(mxf_essence_element_key), track->track_number, sizeof(track->track_number)))
247 /* return 0 if only one stream, for OP Atom files with 0 as track number */
248 return s->nb_streams == 1 ? 0 : -1;
251 /* XXX: use AVBitStreamFilter */
252 static int mxf_get_d10_aes3_packet(AVIOContext *pb, AVStream *st, AVPacket *pkt, int64_t length)
254 const uint8_t *buf_ptr, *end_ptr;
258 if (length > 61444) /* worst case PAL 1920 samples 8 channels */
259 return AVERROR_INVALIDDATA;
260 length = av_get_packet(pb, pkt, length);
263 data_ptr = pkt->data;
264 end_ptr = pkt->data + length;
265 buf_ptr = pkt->data + 4; /* skip SMPTE 331M header */
266 for (; buf_ptr + st->codec->channels*4 < end_ptr; ) {
267 for (i = 0; i < st->codec->channels; i++) {
268 uint32_t sample = bytestream_get_le32(&buf_ptr);
269 if (st->codec->bits_per_coded_sample == 24)
270 bytestream_put_le24(&data_ptr, (sample >> 4) & 0xffffff);
272 bytestream_put_le16(&data_ptr, (sample >> 12) & 0xffff);
274 buf_ptr += 32 - st->codec->channels*4; // always 8 channels stored SMPTE 331M
276 av_shrink_packet(pkt, data_ptr - pkt->data);
280 static int mxf_decrypt_triplet(AVFormatContext *s, AVPacket *pkt, KLVPacket *klv)
282 static const uint8_t checkv[16] = {0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b};
283 MXFContext *mxf = s->priv_data;
284 AVIOContext *pb = s->pb;
285 int64_t end = avio_tell(pb) + klv->length;
288 uint64_t plaintext_size;
293 if (!mxf->aesc && s->key && s->keylen == 16) {
294 mxf->aesc = av_malloc(av_aes_size);
296 return AVERROR(ENOMEM);
297 av_aes_init(mxf->aesc, s->key, 128, 1);
300 avio_skip(pb, klv_decode_ber_length(pb));
302 klv_decode_ber_length(pb);
303 plaintext_size = avio_rb64(pb);
305 klv_decode_ber_length(pb);
306 avio_read(pb, klv->key, 16);
307 if (!IS_KLV_KEY(klv, mxf_essence_element_key))
308 return AVERROR_INVALIDDATA;
309 index = mxf_get_stream_index(s, klv);
311 return AVERROR_INVALIDDATA;
313 klv_decode_ber_length(pb);
314 orig_size = avio_rb64(pb);
315 if (orig_size < plaintext_size)
316 return AVERROR_INVALIDDATA;
318 size = klv_decode_ber_length(pb);
319 if (size < 32 || size - 32 < orig_size)
320 return AVERROR_INVALIDDATA;
321 avio_read(pb, ivec, 16);
322 avio_read(pb, tmpbuf, 16);
324 av_aes_crypt(mxf->aesc, tmpbuf, tmpbuf, 1, ivec, 1);
325 if (memcmp(tmpbuf, checkv, 16))
326 av_log(s, AV_LOG_ERROR, "probably incorrect decryption key\n");
328 size = av_get_packet(pb, pkt, size);
331 else if (size < plaintext_size)
332 return AVERROR_INVALIDDATA;
333 size -= plaintext_size;
335 av_aes_crypt(mxf->aesc, &pkt->data[plaintext_size],
336 &pkt->data[plaintext_size], size >> 4, ivec, 1);
337 av_shrink_packet(pkt, orig_size);
338 pkt->stream_index = index;
339 avio_skip(pb, end - avio_tell(pb));
343 static int mxf_read_packet(AVFormatContext *s, AVPacket *pkt)
347 while (!s->pb->eof_reached) {
349 if (klv_read_packet(&klv, s->pb) < 0)
351 PRINT_KEY(s, "read packet", klv.key);
352 av_dlog(s, "size %"PRIu64" offset %#"PRIx64"\n", klv.length, klv.offset);
353 if (IS_KLV_KEY(klv.key, mxf_encrypted_triplet_key)) {
354 ret = mxf_decrypt_triplet(s, pkt, &klv);
356 av_log(s, AV_LOG_ERROR, "invalid encoded triplet\n");
357 return AVERROR_INVALIDDATA;
361 if (IS_KLV_KEY(klv.key, mxf_essence_element_key)) {
362 int index = mxf_get_stream_index(s, &klv);
364 av_log(s, AV_LOG_ERROR, "error getting stream index %d\n", AV_RB32(klv.key+12));
367 if (s->streams[index]->discard == AVDISCARD_ALL)
369 /* check for 8 channels AES3 element */
370 if (klv.key[12] == 0x06 && klv.key[13] == 0x01 && klv.key[14] == 0x10) {
371 if (mxf_get_d10_aes3_packet(s->pb, s->streams[index], pkt, klv.length) < 0) {
372 av_log(s, AV_LOG_ERROR, "error reading D-10 aes3 frame\n");
373 return AVERROR_INVALIDDATA;
376 ret = av_get_packet(s->pb, pkt, klv.length);
380 pkt->stream_index = index;
381 pkt->pos = klv.offset;
385 avio_skip(s->pb, klv.length);
390 static int mxf_read_primer_pack(void *arg, AVIOContext *pb, int tag, int size, UID uid)
392 MXFContext *mxf = arg;
393 int item_num = avio_rb32(pb);
394 int item_len = avio_rb32(pb);
396 if (item_len != 18) {
397 av_log_ask_for_sample(pb, "unsupported primer pack item length %d\n",
399 return AVERROR_PATCHWELCOME;
401 if (item_num > UINT_MAX / item_len)
402 return AVERROR_INVALIDDATA;
403 mxf->local_tags_count = item_num;
404 mxf->local_tags = av_malloc(item_num*item_len);
405 if (!mxf->local_tags)
406 return AVERROR(ENOMEM);
407 avio_read(pb, mxf->local_tags, item_num*item_len);
411 static int mxf_read_partition_pack(void *arg, AVIOContext *pb, int tag, int size, UID uid)
413 MXFContext *mxf = arg;
414 MXFPartition *partition;
417 if (mxf->partitions_count+1 >= UINT_MAX / sizeof(*mxf->partitions))
418 return AVERROR(ENOMEM);
420 mxf->partitions = av_realloc(mxf->partitions, (mxf->partitions_count + 1) * sizeof(*mxf->partitions));
421 if (!mxf->partitions)
422 return AVERROR(ENOMEM);
424 partition = &mxf->partitions[mxf->partitions_count++];
428 partition->type = Header;
431 partition->type = BodyPartition;
434 partition->type = Footer;
437 av_log(mxf->fc, AV_LOG_ERROR, "unknown partition type %i\n", uid[13]);
438 return AVERROR_INVALIDDATA;
441 /* consider both footers to be closed (there is only Footer and CompleteFooter) */
442 partition->closed = partition->type == Footer || !(uid[14] & 1);
443 partition->complete = uid[14] > 2;
445 partition->previous_partition = avio_rb64(pb);
446 partition->footer_partition = avio_rb64(pb);
448 partition->index_sid = avio_rb32(pb);
450 partition->body_sid = avio_rb32(pb);
451 avio_read(pb, op, sizeof(UID));
453 av_dlog(mxf->fc, "PartitionPack: PreviousPartition = 0x%lx, "
454 "FooterPartition = 0x%lx, IndexSID = %i, BodySID = %i\n",
455 partition->previous_partition, partition->footer_partition,
456 partition->index_sid, partition->body_sid);
458 if (op[12] == 1 && op[13] == 1) mxf->op = OP1a;
459 else if (op[12] == 1 && op[13] == 2) mxf->op = OP1b;
460 else if (op[12] == 1 && op[13] == 3) mxf->op = OP1c;
461 else if (op[12] == 2 && op[13] == 1) mxf->op = OP2a;
462 else if (op[12] == 2 && op[13] == 2) mxf->op = OP2b;
463 else if (op[12] == 2 && op[13] == 3) mxf->op = OP2c;
464 else if (op[12] == 3 && op[13] == 1) mxf->op = OP3a;
465 else if (op[12] == 3 && op[13] == 2) mxf->op = OP3b;
466 else if (op[12] == 3 && op[13] == 3) mxf->op = OP3c;
467 else if (op[12] == 0x10) mxf->op = OPAtom;
469 av_log(mxf->fc, AV_LOG_ERROR, "unknown operational pattern: %02xh %02xh\n", op[12], op[13]);
474 static int mxf_add_metadata_set(MXFContext *mxf, void *metadata_set)
476 if (mxf->metadata_sets_count+1 >= UINT_MAX / sizeof(*mxf->metadata_sets))
477 return AVERROR(ENOMEM);
478 mxf->metadata_sets = av_realloc(mxf->metadata_sets, (mxf->metadata_sets_count + 1) * sizeof(*mxf->metadata_sets));
479 if (!mxf->metadata_sets)
480 return AVERROR(ENOMEM);
481 mxf->metadata_sets[mxf->metadata_sets_count] = metadata_set;
482 mxf->metadata_sets_count++;
486 static int mxf_read_cryptographic_context(void *arg, AVIOContext *pb, int tag, int size, UID uid)
488 MXFCryptoContext *cryptocontext = arg;
490 return AVERROR_INVALIDDATA;
491 if (IS_KLV_KEY(uid, mxf_crypto_source_container_ul))
492 avio_read(pb, cryptocontext->source_container_ul, 16);
496 static int mxf_read_content_storage(void *arg, AVIOContext *pb, int tag, int size, UID uid)
498 MXFContext *mxf = arg;
501 mxf->packages_count = avio_rb32(pb);
502 if (mxf->packages_count >= UINT_MAX / sizeof(UID))
503 return AVERROR_INVALIDDATA;
504 mxf->packages_refs = av_malloc(mxf->packages_count * sizeof(UID));
505 if (!mxf->packages_refs)
506 return AVERROR(ENOMEM);
507 avio_skip(pb, 4); /* useless size of objects, always 16 according to specs */
508 avio_read(pb, (uint8_t *)mxf->packages_refs, mxf->packages_count * sizeof(UID));
514 static int mxf_read_source_clip(void *arg, AVIOContext *pb, int tag, int size, UID uid)
516 MXFStructuralComponent *source_clip = arg;
519 source_clip->duration = avio_rb64(pb);
522 source_clip->start_position = avio_rb64(pb);
525 /* UMID, only get last 16 bytes */
527 avio_read(pb, source_clip->source_package_uid, 16);
530 source_clip->source_track_id = avio_rb32(pb);
536 static int mxf_read_material_package(void *arg, AVIOContext *pb, int tag, int size, UID uid)
538 MXFPackage *package = arg;
541 package->tracks_count = avio_rb32(pb);
542 if (package->tracks_count >= UINT_MAX / sizeof(UID))
543 return AVERROR_INVALIDDATA;
544 package->tracks_refs = av_malloc(package->tracks_count * sizeof(UID));
545 if (!package->tracks_refs)
546 return AVERROR(ENOMEM);
547 avio_skip(pb, 4); /* useless size of objects, always 16 according to specs */
548 avio_read(pb, (uint8_t *)package->tracks_refs, package->tracks_count * sizeof(UID));
554 static int mxf_read_track(void *arg, AVIOContext *pb, int tag, int size, UID uid)
556 MXFTrack *track = arg;
559 track->track_id = avio_rb32(pb);
562 avio_read(pb, track->track_number, 4);
565 track->edit_rate.den = avio_rb32(pb);
566 track->edit_rate.num = avio_rb32(pb);
569 avio_read(pb, track->sequence_ref, 16);
575 static int mxf_read_sequence(void *arg, AVIOContext *pb, int tag, int size, UID uid)
577 MXFSequence *sequence = arg;
580 sequence->duration = avio_rb64(pb);
583 avio_read(pb, sequence->data_definition_ul, 16);
586 sequence->structural_components_count = avio_rb32(pb);
587 if (sequence->structural_components_count >= UINT_MAX / sizeof(UID))
588 return AVERROR_INVALIDDATA;
589 sequence->structural_components_refs = av_malloc(sequence->structural_components_count * sizeof(UID));
590 if (!sequence->structural_components_refs)
591 return AVERROR(ENOMEM);
592 avio_skip(pb, 4); /* useless size of objects, always 16 according to specs */
593 avio_read(pb, (uint8_t *)sequence->structural_components_refs, sequence->structural_components_count * sizeof(UID));
599 static int mxf_read_source_package(void *arg, AVIOContext *pb, int tag, int size, UID uid)
601 MXFPackage *package = arg;
604 package->tracks_count = avio_rb32(pb);
605 if (package->tracks_count >= UINT_MAX / sizeof(UID))
606 return AVERROR_INVALIDDATA;
607 package->tracks_refs = av_malloc(package->tracks_count * sizeof(UID));
608 if (!package->tracks_refs)
609 return AVERROR(ENOMEM);
610 avio_skip(pb, 4); /* useless size of objects, always 16 according to specs */
611 avio_read(pb, (uint8_t *)package->tracks_refs, package->tracks_count * sizeof(UID));
614 /* UMID, only get last 16 bytes */
616 avio_read(pb, package->package_uid, 16);
619 avio_read(pb, package->descriptor_ref, 16);
625 static int mxf_read_index_table_segment(void *arg, AVIOContext *pb, int tag, int size, UID uid)
628 case 0x3F05: av_dlog(NULL, "EditUnitByteCount %d\n", avio_rb32(pb)); break;
629 case 0x3F06: av_dlog(NULL, "IndexSID %d\n", avio_rb32(pb)); break;
630 case 0x3F07: av_dlog(NULL, "BodySID %d\n", avio_rb32(pb)); break;
631 case 0x3F0B: av_dlog(NULL, "IndexEditRate %d/%d\n", avio_rb32(pb), avio_rb32(pb)); break;
632 case 0x3F0C: av_dlog(NULL, "IndexStartPosition %"PRIu64"\n", avio_rb64(pb)); break;
633 case 0x3F0D: av_dlog(NULL, "IndexDuration %"PRIu64"\n", avio_rb64(pb)); break;
638 static void mxf_read_pixel_layout(AVIOContext *pb, MXFDescriptor *descriptor)
640 int code, value, ofs = 0;
641 char layout[16] = {0};
646 av_dlog(NULL, "pixel layout: code %#x\n", code);
649 layout[ofs++] = code;
650 layout[ofs++] = value;
652 } while (code != 0); /* SMPTE 377M E.2.46 */
654 ff_mxf_decode_pixel_layout(layout, &descriptor->pix_fmt);
657 static int mxf_read_generic_descriptor(void *arg, AVIOContext *pb, int tag, int size, UID uid)
659 MXFDescriptor *descriptor = arg;
662 descriptor->sub_descriptors_count = avio_rb32(pb);
663 if (descriptor->sub_descriptors_count >= UINT_MAX / sizeof(UID))
664 return AVERROR_INVALIDDATA;
665 descriptor->sub_descriptors_refs = av_malloc(descriptor->sub_descriptors_count * sizeof(UID));
666 if (!descriptor->sub_descriptors_refs)
667 return AVERROR(ENOMEM);
668 avio_skip(pb, 4); /* useless size of objects, always 16 according to specs */
669 avio_read(pb, (uint8_t *)descriptor->sub_descriptors_refs, descriptor->sub_descriptors_count * sizeof(UID));
672 avio_read(pb, descriptor->essence_container_ul, 16);
675 descriptor->linked_track_id = avio_rb32(pb);
677 case 0x3201: /* PictureEssenceCoding */
678 avio_read(pb, descriptor->essence_codec_ul, 16);
681 descriptor->width = avio_rb32(pb);
684 descriptor->height = avio_rb32(pb);
687 descriptor->aspect_ratio.num = avio_rb32(pb);
688 descriptor->aspect_ratio.den = avio_rb32(pb);
691 descriptor->sample_rate.num = avio_rb32(pb);
692 descriptor->sample_rate.den = avio_rb32(pb);
694 case 0x3D06: /* SoundEssenceCompression */
695 avio_read(pb, descriptor->essence_codec_ul, 16);
698 descriptor->channels = avio_rb32(pb);
701 descriptor->bits_per_sample = avio_rb32(pb);
704 mxf_read_pixel_layout(pb, descriptor);
707 /* Private uid used by SONY C0023S01.mxf */
708 if (IS_KLV_KEY(uid, mxf_sony_mpeg4_extradata)) {
709 descriptor->extradata = av_malloc(size + FF_INPUT_BUFFER_PADDING_SIZE);
710 if (!descriptor->extradata)
711 return AVERROR(ENOMEM);
712 descriptor->extradata_size = size;
713 avio_read(pb, descriptor->extradata, size);
721 * Match an uid independently of the version byte and up to len common bytes
724 static int mxf_match_uid(const UID key, const UID uid, int len)
727 for (i = 0; i < len; i++) {
728 if (i != 7 && key[i] != uid[i])
734 static const MXFCodecUL *mxf_get_codec_ul(const MXFCodecUL *uls, UID *uid)
736 while (uls->uid[0]) {
737 if(mxf_match_uid(uls->uid, *uid, uls->matching_len))
744 static void *mxf_resolve_strong_ref(MXFContext *mxf, UID *strong_ref, enum MXFMetadataSetType type)
750 for (i = 0; i < mxf->metadata_sets_count; i++) {
751 if (!memcmp(*strong_ref, mxf->metadata_sets[i]->uid, 16) &&
752 (type == AnyType || mxf->metadata_sets[i]->type == type)) {
753 return mxf->metadata_sets[i];
759 static const MXFCodecUL mxf_essence_container_uls[] = {
760 // video essence container uls
761 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x02,0x0D,0x01,0x03,0x01,0x02,0x04,0x60,0x01 }, 14, CODEC_ID_MPEG2VIDEO }, /* MPEG-ES Frame wrapped */
762 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x02,0x41,0x01 }, 14, CODEC_ID_DVVIDEO }, /* DV 625 25mbps */
763 // sound essence container uls
764 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x06,0x01,0x00 }, 14, CODEC_ID_PCM_S16LE }, /* BWF Frame wrapped */
765 { { 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 */
766 { { 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 */
767 { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, 0, CODEC_ID_NONE },
770 static int mxf_parse_structural_metadata(MXFContext *mxf)
772 MXFPackage *material_package = NULL;
773 MXFPackage *temp_package = NULL;
776 av_dlog(mxf->fc, "metadata sets count %d\n", mxf->metadata_sets_count);
777 /* TODO: handle multiple material packages (OP3x) */
778 for (i = 0; i < mxf->packages_count; i++) {
779 material_package = mxf_resolve_strong_ref(mxf, &mxf->packages_refs[i], MaterialPackage);
780 if (material_package) break;
782 if (!material_package) {
783 av_log(mxf->fc, AV_LOG_ERROR, "no material package found\n");
784 return AVERROR_INVALIDDATA;
787 for (i = 0; i < material_package->tracks_count; i++) {
788 MXFPackage *source_package = NULL;
789 MXFTrack *material_track = NULL;
790 MXFTrack *source_track = NULL;
791 MXFTrack *temp_track = NULL;
792 MXFDescriptor *descriptor = NULL;
793 MXFStructuralComponent *component = NULL;
794 UID *essence_container_ul = NULL;
795 const MXFCodecUL *codec_ul = NULL;
796 const MXFCodecUL *container_ul = NULL;
799 if (!(material_track = mxf_resolve_strong_ref(mxf, &material_package->tracks_refs[i], Track))) {
800 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve material track strong ref\n");
804 if (!(material_track->sequence = mxf_resolve_strong_ref(mxf, &material_track->sequence_ref, Sequence))) {
805 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve material track sequence strong ref\n");
809 /* TODO: handle multiple source clips */
810 for (j = 0; j < material_track->sequence->structural_components_count; j++) {
811 /* TODO: handle timecode component */
812 component = mxf_resolve_strong_ref(mxf, &material_track->sequence->structural_components_refs[j], SourceClip);
816 for (k = 0; k < mxf->packages_count; k++) {
817 temp_package = mxf_resolve_strong_ref(mxf, &mxf->packages_refs[k], SourcePackage);
820 if (!memcmp(temp_package->package_uid, component->source_package_uid, 16)) {
821 source_package = temp_package;
825 if (!source_package) {
826 av_log(mxf->fc, AV_LOG_ERROR, "material track %d: no corresponding source package found\n", material_track->track_id);
829 for (k = 0; k < source_package->tracks_count; k++) {
830 if (!(temp_track = mxf_resolve_strong_ref(mxf, &source_package->tracks_refs[k], Track))) {
831 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve source track strong ref\n");
832 return AVERROR_INVALIDDATA;
834 if (temp_track->track_id == component->source_track_id) {
835 source_track = temp_track;
840 av_log(mxf->fc, AV_LOG_ERROR, "material track %d: no corresponding source track found\n", material_track->track_id);
847 st = avformat_new_stream(mxf->fc, NULL);
849 av_log(mxf->fc, AV_LOG_ERROR, "could not allocate stream\n");
850 return AVERROR(ENOMEM);
852 st->id = source_track->track_id;
853 st->priv_data = source_track;
854 st->duration = component->duration;
855 if (st->duration == -1)
856 st->duration = AV_NOPTS_VALUE;
857 st->start_time = component->start_position;
858 avpriv_set_pts_info(st, 64, material_track->edit_rate.num, material_track->edit_rate.den);
860 if (!(source_track->sequence = mxf_resolve_strong_ref(mxf, &source_track->sequence_ref, Sequence))) {
861 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve source track sequence strong ref\n");
862 return AVERROR_INVALIDDATA;
865 PRINT_KEY(mxf->fc, "data definition ul", source_track->sequence->data_definition_ul);
866 codec_ul = mxf_get_codec_ul(ff_mxf_data_definition_uls, &source_track->sequence->data_definition_ul);
867 st->codec->codec_type = codec_ul->id;
869 source_package->descriptor = mxf_resolve_strong_ref(mxf, &source_package->descriptor_ref, AnyType);
870 if (source_package->descriptor) {
871 if (source_package->descriptor->type == MultipleDescriptor) {
872 for (j = 0; j < source_package->descriptor->sub_descriptors_count; j++) {
873 MXFDescriptor *sub_descriptor = mxf_resolve_strong_ref(mxf, &source_package->descriptor->sub_descriptors_refs[j], Descriptor);
875 if (!sub_descriptor) {
876 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve sub descriptor strong ref\n");
879 if (sub_descriptor->linked_track_id == source_track->track_id) {
880 descriptor = sub_descriptor;
884 } else if (source_package->descriptor->type == Descriptor)
885 descriptor = source_package->descriptor;
888 av_log(mxf->fc, AV_LOG_INFO, "source track %d: stream %d, no descriptor found\n", source_track->track_id, st->index);
891 PRINT_KEY(mxf->fc, "essence codec ul", descriptor->essence_codec_ul);
892 PRINT_KEY(mxf->fc, "essence container ul", descriptor->essence_container_ul);
893 essence_container_ul = &descriptor->essence_container_ul;
894 /* HACK: replacing the original key with mxf_encrypted_essence_container
895 * is not allowed according to s429-6, try to find correct information anyway */
896 if (IS_KLV_KEY(essence_container_ul, mxf_encrypted_essence_container)) {
897 av_log(mxf->fc, AV_LOG_INFO, "broken encrypted mxf file\n");
898 for (k = 0; k < mxf->metadata_sets_count; k++) {
899 MXFMetadataSet *metadata = mxf->metadata_sets[k];
900 if (metadata->type == CryptoContext) {
901 essence_container_ul = &((MXFCryptoContext *)metadata)->source_container_ul;
906 /* TODO: drop PictureEssenceCoding and SoundEssenceCompression, only check EssenceContainer */
907 codec_ul = mxf_get_codec_ul(ff_mxf_codec_uls, &descriptor->essence_codec_ul);
908 st->codec->codec_id = codec_ul->id;
909 if (descriptor->extradata) {
910 st->codec->extradata = descriptor->extradata;
911 st->codec->extradata_size = descriptor->extradata_size;
913 if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
914 container_ul = mxf_get_codec_ul(mxf_essence_container_uls, essence_container_ul);
915 if (st->codec->codec_id == CODEC_ID_NONE)
916 st->codec->codec_id = container_ul->id;
917 st->codec->width = descriptor->width;
918 st->codec->height = descriptor->height;
919 if (st->codec->codec_id == CODEC_ID_RAWVIDEO)
920 st->codec->pix_fmt = descriptor->pix_fmt;
921 st->need_parsing = AVSTREAM_PARSE_HEADERS;
922 } else if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
923 container_ul = mxf_get_codec_ul(mxf_essence_container_uls, essence_container_ul);
924 if (st->codec->codec_id == CODEC_ID_NONE)
925 st->codec->codec_id = container_ul->id;
926 st->codec->channels = descriptor->channels;
927 st->codec->bits_per_coded_sample = descriptor->bits_per_sample;
928 st->codec->sample_rate = descriptor->sample_rate.num / descriptor->sample_rate.den;
929 /* TODO: implement CODEC_ID_RAWAUDIO */
930 if (st->codec->codec_id == CODEC_ID_PCM_S16LE) {
931 if (descriptor->bits_per_sample > 16 && descriptor->bits_per_sample <= 24)
932 st->codec->codec_id = CODEC_ID_PCM_S24LE;
933 else if (descriptor->bits_per_sample == 32)
934 st->codec->codec_id = CODEC_ID_PCM_S32LE;
935 } else if (st->codec->codec_id == CODEC_ID_PCM_S16BE) {
936 if (descriptor->bits_per_sample > 16 && descriptor->bits_per_sample <= 24)
937 st->codec->codec_id = CODEC_ID_PCM_S24BE;
938 else if (descriptor->bits_per_sample == 32)
939 st->codec->codec_id = CODEC_ID_PCM_S32BE;
940 } else if (st->codec->codec_id == CODEC_ID_MP2) {
941 st->need_parsing = AVSTREAM_PARSE_FULL;
944 if (st->codec->codec_type != AVMEDIA_TYPE_DATA && (*essence_container_ul)[15] > 0x01) {
945 av_log(mxf->fc, AV_LOG_WARNING, "only frame wrapped mappings are correctly supported\n");
946 st->need_parsing = AVSTREAM_PARSE_FULL;
952 static const MXFMetadataReadTableEntry mxf_metadata_read_table[] = {
953 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x05,0x01,0x00 }, mxf_read_primer_pack },
954 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x02,0x01,0x00 }, mxf_read_partition_pack },
955 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x02,0x02,0x00 }, mxf_read_partition_pack },
956 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x02,0x03,0x00 }, mxf_read_partition_pack },
957 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x02,0x04,0x00 }, mxf_read_partition_pack },
958 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x03,0x01,0x00 }, mxf_read_partition_pack },
959 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x03,0x02,0x00 }, mxf_read_partition_pack },
960 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x03,0x03,0x00 }, mxf_read_partition_pack },
961 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x03,0x04,0x00 }, mxf_read_partition_pack },
962 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x04,0x02,0x00 }, mxf_read_partition_pack },
963 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x04,0x04,0x00 }, mxf_read_partition_pack },
964 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x18,0x00 }, mxf_read_content_storage, 0, AnyType },
965 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x37,0x00 }, mxf_read_source_package, sizeof(MXFPackage), SourcePackage },
966 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x36,0x00 }, mxf_read_material_package, sizeof(MXFPackage), MaterialPackage },
967 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x0F,0x00 }, mxf_read_sequence, sizeof(MXFSequence), Sequence },
968 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x11,0x00 }, mxf_read_source_clip, sizeof(MXFStructuralComponent), SourceClip },
969 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x44,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), MultipleDescriptor },
970 { { 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 */
971 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x28,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* CDCI */
972 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x29,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* RGBA */
973 { { 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 */
974 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x48,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* Wave */
975 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x47,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* AES3 */
976 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x3A,0x00 }, mxf_read_track, sizeof(MXFTrack), Track }, /* Static Track */
977 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x3B,0x00 }, mxf_read_track, sizeof(MXFTrack), Track }, /* Generic Track */
978 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x04,0x01,0x02,0x02,0x00,0x00 }, mxf_read_cryptographic_context, sizeof(MXFCryptoContext), CryptoContext },
979 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x10,0x01,0x00 }, mxf_read_index_table_segment, sizeof(MXFIndexTableSegment), IndexTableSegment },
980 { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, NULL, 0, AnyType },
983 static int mxf_read_local_tags(MXFContext *mxf, KLVPacket *klv, MXFMetadataReadFunc *read_child, int ctx_size, enum MXFMetadataSetType type)
985 AVIOContext *pb = mxf->fc->pb;
986 MXFMetadataSet *ctx = ctx_size ? av_mallocz(ctx_size) : mxf;
987 uint64_t klv_end = avio_tell(pb) + klv->length;
990 return AVERROR(ENOMEM);
991 while (avio_tell(pb) + 4 < klv_end) {
993 int tag = avio_rb16(pb);
994 int size = avio_rb16(pb); /* KLV specified by 0x53 */
995 uint64_t next = avio_tell(pb) + size;
998 av_dlog(mxf->fc, "local tag %#04x size %d\n", tag, size);
999 if (!size) { /* ignore empty tag, needed for some files with empty UMID tag */
1000 av_log(mxf->fc, AV_LOG_ERROR, "local tag %#04x with 0 size\n", tag);
1003 if (tag > 0x7FFF) { /* dynamic tag */
1005 for (i = 0; i < mxf->local_tags_count; i++) {
1006 int local_tag = AV_RB16(mxf->local_tags+i*18);
1007 if (local_tag == tag) {
1008 memcpy(uid, mxf->local_tags+i*18+2, 16);
1009 av_dlog(mxf->fc, "local tag %#04x\n", local_tag);
1010 PRINT_KEY(mxf->fc, "uid", uid);
1014 if (ctx_size && tag == 0x3C0A)
1015 avio_read(pb, ctx->uid, 16);
1016 else if ((ret = read_child(ctx, pb, tag, size, uid)) < 0)
1019 avio_seek(pb, next, SEEK_SET);
1021 if (ctx_size) ctx->type = type;
1022 return ctx_size ? mxf_add_metadata_set(mxf, ctx) : 0;
1025 static int mxf_read_header(AVFormatContext *s, AVFormatParameters *ap)
1027 MXFContext *mxf = s->priv_data;
1030 if (!mxf_read_sync(s->pb, mxf_header_partition_pack_key, 14)) {
1031 av_log(s, AV_LOG_ERROR, "could not find header partition pack key\n");
1032 return AVERROR_INVALIDDATA;
1034 avio_seek(s->pb, -14, SEEK_CUR);
1036 while (!s->pb->eof_reached) {
1038 const MXFMetadataReadTableEntry *metadata;
1040 if ((ret = klv_read_packet(&klv, s->pb)) < 0)
1042 PRINT_KEY(s, "read header", klv.key);
1043 av_dlog(s, "size %"PRIu64" offset %#"PRIx64"\n", klv.length, klv.offset);
1044 if (IS_KLV_KEY(klv.key, mxf_encrypted_triplet_key) ||
1045 IS_KLV_KEY(klv.key, mxf_essence_element_key)) {
1046 /* FIXME avoid seek */
1047 avio_seek(s->pb, klv.offset, SEEK_SET);
1051 for (metadata = mxf_metadata_read_table; metadata->read; metadata++) {
1052 if (IS_KLV_KEY(klv.key, metadata->key)) {
1054 if (klv.key[5] == 0x53) {
1055 res = mxf_read_local_tags(mxf, &klv, metadata->read, metadata->ctx_size, metadata->type);
1057 res = metadata->read(mxf, s->pb, 0, 0, klv.key);
1059 av_log(s, AV_LOG_ERROR, "error reading header metadata\n");
1065 if (!metadata->read)
1066 avio_skip(s->pb, klv.length);
1068 return mxf_parse_structural_metadata(mxf);
1071 static int mxf_read_close(AVFormatContext *s)
1073 MXFContext *mxf = s->priv_data;
1076 av_freep(&mxf->packages_refs);
1078 for (i = 0; i < s->nb_streams; i++)
1079 s->streams[i]->priv_data = NULL;
1081 for (i = 0; i < mxf->metadata_sets_count; i++) {
1082 switch (mxf->metadata_sets[i]->type) {
1083 case MultipleDescriptor:
1084 av_freep(&((MXFDescriptor *)mxf->metadata_sets[i])->sub_descriptors_refs);
1087 av_freep(&((MXFSequence *)mxf->metadata_sets[i])->structural_components_refs);
1090 case MaterialPackage:
1091 av_freep(&((MXFPackage *)mxf->metadata_sets[i])->tracks_refs);
1096 av_freep(&mxf->metadata_sets[i]);
1098 av_freep(&mxf->partitions);
1099 av_freep(&mxf->metadata_sets);
1100 av_freep(&mxf->aesc);
1101 av_freep(&mxf->local_tags);
1105 static int mxf_probe(AVProbeData *p) {
1106 uint8_t *bufp = p->buf;
1107 uint8_t *end = p->buf + p->buf_size;
1109 if (p->buf_size < sizeof(mxf_header_partition_pack_key))
1112 /* Must skip Run-In Sequence and search for MXF header partition pack key SMPTE 377M 5.5 */
1113 end -= sizeof(mxf_header_partition_pack_key);
1114 for (; bufp < end; bufp++) {
1115 if (IS_KLV_KEY(bufp, mxf_header_partition_pack_key))
1116 return AVPROBE_SCORE_MAX;
1121 /* rudimentary byte seek */
1122 /* XXX: use MXF Index */
1123 static int mxf_read_seek(AVFormatContext *s, int stream_index, int64_t sample_time, int flags)
1125 AVStream *st = s->streams[stream_index];
1129 return AVERROR_INVALIDDATA;
1130 if (sample_time < 0)
1132 seconds = av_rescale(sample_time, st->time_base.num, st->time_base.den);
1133 avio_seek(s->pb, (s->bit_rate * seconds) >> 3, SEEK_SET);
1134 ff_update_cur_dts(s, st, sample_time);
1138 AVInputFormat ff_mxf_demuxer = {
1140 .long_name = NULL_IF_CONFIG_SMALL("Material eXchange Format"),
1141 .priv_data_size = sizeof(MXFContext),
1142 .read_probe = mxf_probe,
1143 .read_header = mxf_read_header,
1144 .read_packet = mxf_read_packet,
1145 .read_close = mxf_read_close,
1146 .read_seek = mxf_read_seek,