3 * Copyright (c) 2006 SmartJog S.A., Baptiste Coudurier <baptiste dot coudurier at smartjog dot com>
5 * This file is part of FFmpeg.
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.
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.
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
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"
76 MXFPartitionType type;
77 uint64_t previous_partition;
78 uint64_t footer_partition;
85 enum MXFMetadataSetType type;
86 UID source_container_ul;
91 enum MXFMetadataSetType type;
92 UID source_package_uid;
93 UID data_definition_ul;
95 int64_t start_position;
97 } MXFStructuralComponent;
101 enum MXFMetadataSetType type;
102 UID data_definition_ul;
103 UID *structural_components_refs;
104 int structural_components_count;
110 enum MXFMetadataSetType type;
111 MXFSequence *sequence; /* mandatory, and only one */
114 uint8_t track_number[4];
115 AVRational edit_rate;
120 enum MXFMetadataSetType type;
121 UID essence_container_ul;
122 UID essence_codec_ul;
123 AVRational sample_rate;
124 AVRational aspect_ratio;
129 UID *sub_descriptors_refs;
130 int sub_descriptors_count;
134 enum PixelFormat pix_fmt;
139 enum MXFMetadataSetType type;
140 } MXFIndexTableSegment;
144 enum MXFMetadataSetType type;
148 MXFDescriptor *descriptor; /* only one */
154 enum MXFMetadataSetType type;
158 MXFPartition *partitions;
159 unsigned partitions_count;
163 MXFMetadataSet **metadata_sets;
164 int metadata_sets_count;
168 int local_tags_count;
171 enum MXFWrappingScheme {
176 typedef int MXFMetadataReadFunc(void *arg, AVIOContext *pb, int tag, int size, UID uid);
180 MXFMetadataReadFunc *read;
182 enum MXFMetadataSetType type;
183 } MXFMetadataReadTableEntry;
185 /* partial keys to match */
186 static const uint8_t mxf_header_partition_pack_key[] = { 0x06,0x0e,0x2b,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x02 };
187 static const uint8_t mxf_essence_element_key[] = { 0x06,0x0e,0x2b,0x34,0x01,0x02,0x01,0x01,0x0d,0x01,0x03,0x01 };
188 static const uint8_t mxf_klv_key[] = { 0x06,0x0e,0x2b,0x34 };
189 /* complete keys to match */
190 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 };
191 static const uint8_t mxf_encrypted_triplet_key[] = { 0x06,0x0e,0x2b,0x34,0x02,0x04,0x01,0x07,0x0d,0x01,0x03,0x01,0x02,0x7e,0x01,0x00 };
192 static const uint8_t mxf_encrypted_essence_container[] = { 0x06,0x0e,0x2b,0x34,0x04,0x01,0x01,0x07,0x0d,0x01,0x03,0x01,0x02,0x0b,0x01,0x00 };
193 static const uint8_t mxf_sony_mpeg4_extradata[] = { 0x06,0x0e,0x2b,0x34,0x04,0x01,0x01,0x01,0x0e,0x06,0x06,0x02,0x02,0x01,0x00,0x00 };
195 #define IS_KLV_KEY(x, y) (!memcmp(x, y, sizeof(y)))
197 static int64_t klv_decode_ber_length(AVIOContext *pb)
199 uint64_t size = avio_r8(pb);
200 if (size & 0x80) { /* long form */
201 int bytes_num = size & 0x7f;
202 /* SMPTE 379M 5.3.4 guarantee that bytes_num must not exceed 8 bytes */
207 size = size << 8 | avio_r8(pb);
212 static int mxf_read_sync(AVIOContext *pb, const uint8_t *key, unsigned size)
215 for (i = 0; i < size && !url_feof(pb); i++) {
219 else if (b != key[i])
225 static int klv_read_packet(KLVPacket *klv, AVIOContext *pb)
227 if (!mxf_read_sync(pb, mxf_klv_key, 4))
229 klv->offset = avio_tell(pb) - 4;
230 memcpy(klv->key, mxf_klv_key, 4);
231 avio_read(pb, klv->key + 4, 12);
232 klv->length = klv_decode_ber_length(pb);
233 return klv->length == -1 ? -1 : 0;
236 static int mxf_get_stream_index(AVFormatContext *s, KLVPacket *klv)
240 for (i = 0; i < s->nb_streams; i++) {
241 MXFTrack *track = s->streams[i]->priv_data;
243 if (!memcmp(klv->key + sizeof(mxf_essence_element_key), track->track_number, sizeof(track->track_number)))
246 /* return 0 if only one stream, for OP Atom files with 0 as track number */
247 return s->nb_streams == 1 ? 0 : -1;
250 /* XXX: use AVBitStreamFilter */
251 static int mxf_get_d10_aes3_packet(AVIOContext *pb, AVStream *st, AVPacket *pkt, int64_t length)
253 const uint8_t *buf_ptr, *end_ptr;
257 if (length > 61444) /* worst case PAL 1920 samples 8 channels */
259 av_new_packet(pkt, length);
260 avio_read(pb, pkt->data, length);
261 data_ptr = pkt->data;
262 end_ptr = pkt->data + length;
263 buf_ptr = pkt->data + 4; /* skip SMPTE 331M header */
264 for (; buf_ptr < end_ptr; ) {
265 for (i = 0; i < st->codec->channels; i++) {
266 uint32_t sample = bytestream_get_le32(&buf_ptr);
267 if (st->codec->bits_per_coded_sample == 24)
268 bytestream_put_le24(&data_ptr, (sample >> 4) & 0xffffff);
270 bytestream_put_le16(&data_ptr, (sample >> 12) & 0xffff);
272 buf_ptr += 32 - st->codec->channels*4; // always 8 channels stored SMPTE 331M
274 pkt->size = data_ptr - pkt->data;
278 static int mxf_decrypt_triplet(AVFormatContext *s, AVPacket *pkt, KLVPacket *klv)
280 static const uint8_t checkv[16] = {0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b};
281 MXFContext *mxf = s->priv_data;
282 AVIOContext *pb = s->pb;
283 int64_t end = avio_tell(pb) + klv->length;
286 uint64_t plaintext_size;
291 if (!mxf->aesc && s->key && s->keylen == 16) {
292 mxf->aesc = av_malloc(av_aes_size);
295 av_aes_init(mxf->aesc, s->key, 128, 1);
298 avio_skip(pb, klv_decode_ber_length(pb));
300 klv_decode_ber_length(pb);
301 plaintext_size = avio_rb64(pb);
303 klv_decode_ber_length(pb);
304 avio_read(pb, klv->key, 16);
305 if (!IS_KLV_KEY(klv, mxf_essence_element_key))
307 index = mxf_get_stream_index(s, klv);
311 klv_decode_ber_length(pb);
312 orig_size = avio_rb64(pb);
313 if (orig_size < plaintext_size)
316 size = klv_decode_ber_length(pb);
317 if (size < 32 || size - 32 < orig_size)
319 avio_read(pb, ivec, 16);
320 avio_read(pb, tmpbuf, 16);
322 av_aes_crypt(mxf->aesc, tmpbuf, tmpbuf, 1, ivec, 1);
323 if (memcmp(tmpbuf, checkv, 16))
324 av_log(s, AV_LOG_ERROR, "probably incorrect decryption key\n");
326 av_get_packet(pb, pkt, size);
327 size -= plaintext_size;
329 av_aes_crypt(mxf->aesc, &pkt->data[plaintext_size],
330 &pkt->data[plaintext_size], size >> 4, ivec, 1);
331 pkt->size = orig_size;
332 pkt->stream_index = index;
333 avio_skip(pb, end - avio_tell(pb));
337 static int mxf_read_packet(AVFormatContext *s, AVPacket *pkt)
341 while (!url_feof(s->pb)) {
342 if (klv_read_packet(&klv, s->pb) < 0)
344 PRINT_KEY(s, "read packet", klv.key);
345 av_dlog(s, "size %"PRIu64" offset %#"PRIx64"\n", klv.length, klv.offset);
346 if (IS_KLV_KEY(klv.key, mxf_encrypted_triplet_key)) {
347 int res = mxf_decrypt_triplet(s, pkt, &klv);
349 av_log(s, AV_LOG_ERROR, "invalid encoded triplet\n");
354 if (IS_KLV_KEY(klv.key, mxf_essence_element_key)) {
355 int index = mxf_get_stream_index(s, &klv);
357 av_log(s, AV_LOG_ERROR, "error getting stream index %d\n", AV_RB32(klv.key+12));
360 if (s->streams[index]->discard == AVDISCARD_ALL)
362 /* check for 8 channels AES3 element */
363 if (klv.key[12] == 0x06 && klv.key[13] == 0x01 && klv.key[14] == 0x10) {
364 if (mxf_get_d10_aes3_packet(s->pb, s->streams[index], pkt, klv.length) < 0) {
365 av_log(s, AV_LOG_ERROR, "error reading D-10 aes3 frame\n");
369 av_get_packet(s->pb, pkt, klv.length);
370 pkt->stream_index = index;
371 pkt->pos = klv.offset;
375 avio_skip(s->pb, klv.length);
380 static int mxf_read_primer_pack(void *arg, AVIOContext *pb, int tag, int size, UID uid)
382 MXFContext *mxf = arg;
383 int item_num = avio_rb32(pb);
384 int item_len = avio_rb32(pb);
386 if (item_len != 18) {
387 av_log(mxf->fc, AV_LOG_ERROR, "unsupported primer pack item length\n");
390 if (item_num > UINT_MAX / item_len)
392 mxf->local_tags_count = item_num;
393 mxf->local_tags = av_malloc(item_num*item_len);
394 if (!mxf->local_tags)
396 avio_read(pb, mxf->local_tags, item_num*item_len);
400 static int mxf_read_partition_pack(void *arg, ByteIOContext *pb, int tag, int size, UID uid)
402 MXFContext *mxf = arg;
403 MXFPartition *partition;
406 if (mxf->partitions_count+1 >= UINT_MAX / sizeof(*mxf->partitions))
407 return AVERROR(ENOMEM);
409 mxf->partitions = av_realloc(mxf->partitions, (mxf->partitions_count + 1) * sizeof(*mxf->partitions));
410 if (!mxf->partitions)
411 return AVERROR(ENOMEM);
413 partition = &mxf->partitions[mxf->partitions_count++];
417 partition->type = Header;
420 partition->type = BodyPartition;
423 partition->type = Footer;
426 av_log(mxf->fc, AV_LOG_ERROR, "unknown partition type %i\n", uid[13]);
427 return AVERROR_INVALIDDATA;
430 /* consider both footers to be closed (there is only Footer and CompleteFooter) */
431 partition->closed = partition->type == Footer || !(uid[14] & 1);
432 partition->complete = uid[14] > 2;
434 partition->previous_partition = avio_rb64(pb);
435 partition->footer_partition = avio_rb64(pb);
437 partition->index_sid = avio_rb32(pb);
439 partition->body_sid = avio_rb32(pb);
440 avio_read(pb, op, sizeof(UID));
442 av_dlog(mxf->fc, "PartitionPack: PreviousPartition = 0x%lx, "
443 "FooterPartition = 0x%lx, IndexSID = %i, BodySID = %i\n",
444 partition->previous_partition, partition->footer_partition,
445 partition->index_sid, partition->body_sid);
447 if (op[12] == 1 && op[13] == 1) mxf->op = OP1a;
448 else if (op[12] == 1 && op[13] == 2) mxf->op = OP1b;
449 else if (op[12] == 1 && op[13] == 3) mxf->op = OP1c;
450 else if (op[12] == 2 && op[13] == 1) mxf->op = OP2a;
451 else if (op[12] == 2 && op[13] == 2) mxf->op = OP2b;
452 else if (op[12] == 2 && op[13] == 3) mxf->op = OP2c;
453 else if (op[12] == 3 && op[13] == 1) mxf->op = OP3a;
454 else if (op[12] == 3 && op[13] == 2) mxf->op = OP3b;
455 else if (op[12] == 3 && op[13] == 3) mxf->op = OP3c;
456 else if (op[12] == 0x10) mxf->op = OPAtom;
458 av_log(mxf->fc, AV_LOG_ERROR, "unknown operational pattern: %02xh %02xh\n", op[12], op[13]);
463 static int mxf_add_metadata_set(MXFContext *mxf, void *metadata_set)
465 if (mxf->metadata_sets_count+1 >= UINT_MAX / sizeof(*mxf->metadata_sets))
466 return AVERROR(ENOMEM);
467 mxf->metadata_sets = av_realloc(mxf->metadata_sets, (mxf->metadata_sets_count + 1) * sizeof(*mxf->metadata_sets));
468 if (!mxf->metadata_sets)
470 mxf->metadata_sets[mxf->metadata_sets_count] = metadata_set;
471 mxf->metadata_sets_count++;
475 static int mxf_read_cryptographic_context(void *arg, AVIOContext *pb, int tag, int size, UID uid)
477 MXFCryptoContext *cryptocontext = arg;
480 if (IS_KLV_KEY(uid, mxf_crypto_source_container_ul))
481 avio_read(pb, cryptocontext->source_container_ul, 16);
485 static int mxf_read_content_storage(void *arg, AVIOContext *pb, int tag, int size, UID uid)
487 MXFContext *mxf = arg;
490 mxf->packages_count = avio_rb32(pb);
491 if (mxf->packages_count >= UINT_MAX / sizeof(UID))
493 mxf->packages_refs = av_malloc(mxf->packages_count * sizeof(UID));
494 if (!mxf->packages_refs)
496 avio_skip(pb, 4); /* useless size of objects, always 16 according to specs */
497 avio_read(pb, (uint8_t *)mxf->packages_refs, mxf->packages_count * sizeof(UID));
503 static int mxf_read_source_clip(void *arg, AVIOContext *pb, int tag, int size, UID uid)
505 MXFStructuralComponent *source_clip = arg;
508 source_clip->duration = avio_rb64(pb);
511 source_clip->start_position = avio_rb64(pb);
514 /* UMID, only get last 16 bytes */
516 avio_read(pb, source_clip->source_package_uid, 16);
519 source_clip->source_track_id = avio_rb32(pb);
525 static int mxf_read_material_package(void *arg, AVIOContext *pb, int tag, int size, UID uid)
527 MXFPackage *package = arg;
530 package->tracks_count = avio_rb32(pb);
531 if (package->tracks_count >= UINT_MAX / sizeof(UID))
533 package->tracks_refs = av_malloc(package->tracks_count * sizeof(UID));
534 if (!package->tracks_refs)
536 avio_skip(pb, 4); /* useless size of objects, always 16 according to specs */
537 avio_read(pb, (uint8_t *)package->tracks_refs, package->tracks_count * sizeof(UID));
543 static int mxf_read_track(void *arg, AVIOContext *pb, int tag, int size, UID uid)
545 MXFTrack *track = arg;
548 track->track_id = avio_rb32(pb);
551 avio_read(pb, track->track_number, 4);
554 track->edit_rate.den = avio_rb32(pb);
555 track->edit_rate.num = avio_rb32(pb);
558 avio_read(pb, track->sequence_ref, 16);
564 static int mxf_read_sequence(void *arg, AVIOContext *pb, int tag, int size, UID uid)
566 MXFSequence *sequence = arg;
569 sequence->duration = avio_rb64(pb);
572 avio_read(pb, sequence->data_definition_ul, 16);
575 sequence->structural_components_count = avio_rb32(pb);
576 if (sequence->structural_components_count >= UINT_MAX / sizeof(UID))
578 sequence->structural_components_refs = av_malloc(sequence->structural_components_count * sizeof(UID));
579 if (!sequence->structural_components_refs)
581 avio_skip(pb, 4); /* useless size of objects, always 16 according to specs */
582 avio_read(pb, (uint8_t *)sequence->structural_components_refs, sequence->structural_components_count * sizeof(UID));
588 static int mxf_read_source_package(void *arg, AVIOContext *pb, int tag, int size, UID uid)
590 MXFPackage *package = arg;
593 package->tracks_count = avio_rb32(pb);
594 if (package->tracks_count >= UINT_MAX / sizeof(UID))
596 package->tracks_refs = av_malloc(package->tracks_count * sizeof(UID));
597 if (!package->tracks_refs)
599 avio_skip(pb, 4); /* useless size of objects, always 16 according to specs */
600 avio_read(pb, (uint8_t *)package->tracks_refs, package->tracks_count * sizeof(UID));
603 /* UMID, only get last 16 bytes */
605 avio_read(pb, package->package_uid, 16);
608 avio_read(pb, package->descriptor_ref, 16);
614 static int mxf_read_index_table_segment(void *arg, AVIOContext *pb, int tag, int size, UID uid)
617 case 0x3F05: av_dlog(NULL, "EditUnitByteCount %d\n", avio_rb32(pb)); break;
618 case 0x3F06: av_dlog(NULL, "IndexSID %d\n", avio_rb32(pb)); break;
619 case 0x3F07: av_dlog(NULL, "BodySID %d\n", avio_rb32(pb)); break;
620 case 0x3F0B: av_dlog(NULL, "IndexEditRate %d/%d\n", avio_rb32(pb), avio_rb32(pb)); break;
621 case 0x3F0C: av_dlog(NULL, "IndexStartPosition %"PRIu64"\n", avio_rb64(pb)); break;
622 case 0x3F0D: av_dlog(NULL, "IndexDuration %"PRIu64"\n", avio_rb64(pb)); break;
627 static void mxf_read_pixel_layout(AVIOContext *pb, MXFDescriptor *descriptor)
629 int code, value, ofs = 0;
630 char layout[16] = {0};
635 av_dlog(NULL, "pixel layout: code %#x\n", code);
638 layout[ofs++] = code;
639 layout[ofs++] = value;
641 } while (code != 0); /* SMPTE 377M E.2.46 */
643 ff_mxf_decode_pixel_layout(layout, &descriptor->pix_fmt);
646 static int mxf_read_generic_descriptor(void *arg, AVIOContext *pb, int tag, int size, UID uid)
648 MXFDescriptor *descriptor = arg;
651 descriptor->sub_descriptors_count = avio_rb32(pb);
652 if (descriptor->sub_descriptors_count >= UINT_MAX / sizeof(UID))
654 descriptor->sub_descriptors_refs = av_malloc(descriptor->sub_descriptors_count * sizeof(UID));
655 if (!descriptor->sub_descriptors_refs)
657 avio_skip(pb, 4); /* useless size of objects, always 16 according to specs */
658 avio_read(pb, (uint8_t *)descriptor->sub_descriptors_refs, descriptor->sub_descriptors_count * sizeof(UID));
661 avio_read(pb, descriptor->essence_container_ul, 16);
664 descriptor->linked_track_id = avio_rb32(pb);
666 case 0x3201: /* PictureEssenceCoding */
667 avio_read(pb, descriptor->essence_codec_ul, 16);
670 descriptor->width = avio_rb32(pb);
673 descriptor->height = avio_rb32(pb);
676 descriptor->aspect_ratio.num = avio_rb32(pb);
677 descriptor->aspect_ratio.den = avio_rb32(pb);
680 descriptor->sample_rate.num = avio_rb32(pb);
681 descriptor->sample_rate.den = avio_rb32(pb);
683 case 0x3D06: /* SoundEssenceCompression */
684 avio_read(pb, descriptor->essence_codec_ul, 16);
687 descriptor->channels = avio_rb32(pb);
690 descriptor->bits_per_sample = avio_rb32(pb);
693 mxf_read_pixel_layout(pb, descriptor);
696 /* Private uid used by SONY C0023S01.mxf */
697 if (IS_KLV_KEY(uid, mxf_sony_mpeg4_extradata)) {
698 descriptor->extradata = av_malloc(size + FF_INPUT_BUFFER_PADDING_SIZE);
699 if (!descriptor->extradata)
701 descriptor->extradata_size = size;
702 avio_read(pb, descriptor->extradata, size);
710 * Match an uid independently of the version byte and up to len common bytes
713 static int mxf_match_uid(const UID key, const UID uid, int len)
716 for (i = 0; i < len; i++) {
717 if (i != 7 && key[i] != uid[i])
723 static const MXFCodecUL *mxf_get_codec_ul(const MXFCodecUL *uls, UID *uid)
725 while (uls->uid[0]) {
726 if(mxf_match_uid(uls->uid, *uid, uls->matching_len))
733 static void *mxf_resolve_strong_ref(MXFContext *mxf, UID *strong_ref, enum MXFMetadataSetType type)
739 for (i = 0; i < mxf->metadata_sets_count; i++) {
740 if (!memcmp(*strong_ref, mxf->metadata_sets[i]->uid, 16) &&
741 (type == AnyType || mxf->metadata_sets[i]->type == type)) {
742 return mxf->metadata_sets[i];
748 static const MXFCodecUL mxf_essence_container_uls[] = {
749 // video essence container uls
750 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x02,0x0D,0x01,0x03,0x01,0x02,0x04,0x60,0x01 }, 14, CODEC_ID_MPEG2VIDEO }, /* MPEG-ES Frame wrapped */
751 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x02,0x41,0x01 }, 14, CODEC_ID_DVVIDEO }, /* DV 625 25mbps */
752 // sound essence container uls
753 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x06,0x01,0x00 }, 14, CODEC_ID_PCM_S16LE }, /* BWF Frame wrapped */
754 { { 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 */
755 { { 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 */
756 { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, 0, CODEC_ID_NONE },
759 static int mxf_parse_structural_metadata(MXFContext *mxf)
761 MXFPackage *material_package = NULL;
762 MXFPackage *temp_package = NULL;
765 av_dlog(mxf->fc, "metadata sets count %d\n", mxf->metadata_sets_count);
766 /* TODO: handle multiple material packages (OP3x) */
767 for (i = 0; i < mxf->packages_count; i++) {
768 material_package = mxf_resolve_strong_ref(mxf, &mxf->packages_refs[i], MaterialPackage);
769 if (material_package) break;
771 if (!material_package) {
772 av_log(mxf->fc, AV_LOG_ERROR, "no material package found\n");
776 for (i = 0; i < material_package->tracks_count; i++) {
777 MXFPackage *source_package = NULL;
778 MXFTrack *material_track = NULL;
779 MXFTrack *source_track = NULL;
780 MXFTrack *temp_track = NULL;
781 MXFDescriptor *descriptor = NULL;
782 MXFStructuralComponent *component = NULL;
783 UID *essence_container_ul = NULL;
784 const MXFCodecUL *codec_ul = NULL;
785 const MXFCodecUL *container_ul = NULL;
788 if (!(material_track = mxf_resolve_strong_ref(mxf, &material_package->tracks_refs[i], Track))) {
789 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve material track strong ref\n");
793 if (!(material_track->sequence = mxf_resolve_strong_ref(mxf, &material_track->sequence_ref, Sequence))) {
794 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve material track sequence strong ref\n");
798 /* TODO: handle multiple source clips */
799 for (j = 0; j < material_track->sequence->structural_components_count; j++) {
800 /* TODO: handle timecode component */
801 component = mxf_resolve_strong_ref(mxf, &material_track->sequence->structural_components_refs[j], SourceClip);
805 for (k = 0; k < mxf->packages_count; k++) {
806 temp_package = mxf_resolve_strong_ref(mxf, &mxf->packages_refs[k], SourcePackage);
809 if (!memcmp(temp_package->package_uid, component->source_package_uid, 16)) {
810 source_package = temp_package;
814 if (!source_package) {
815 av_log(mxf->fc, AV_LOG_ERROR, "material track %d: no corresponding source package found\n", material_track->track_id);
818 for (k = 0; k < source_package->tracks_count; k++) {
819 if (!(temp_track = mxf_resolve_strong_ref(mxf, &source_package->tracks_refs[k], Track))) {
820 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve source track strong ref\n");
823 if (temp_track->track_id == component->source_track_id) {
824 source_track = temp_track;
829 av_log(mxf->fc, AV_LOG_ERROR, "material track %d: no corresponding source track found\n", material_track->track_id);
836 st = av_new_stream(mxf->fc, source_track->track_id);
838 av_log(mxf->fc, AV_LOG_ERROR, "could not allocate stream\n");
841 st->priv_data = source_track;
842 st->duration = component->duration;
843 if (st->duration == -1)
844 st->duration = AV_NOPTS_VALUE;
845 st->start_time = component->start_position;
846 av_set_pts_info(st, 64, material_track->edit_rate.num, material_track->edit_rate.den);
848 if (!(source_track->sequence = mxf_resolve_strong_ref(mxf, &source_track->sequence_ref, Sequence))) {
849 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve source track sequence strong ref\n");
853 PRINT_KEY(mxf->fc, "data definition ul", source_track->sequence->data_definition_ul);
854 codec_ul = mxf_get_codec_ul(ff_mxf_data_definition_uls, &source_track->sequence->data_definition_ul);
855 st->codec->codec_type = codec_ul->id;
857 source_package->descriptor = mxf_resolve_strong_ref(mxf, &source_package->descriptor_ref, AnyType);
858 if (source_package->descriptor) {
859 if (source_package->descriptor->type == MultipleDescriptor) {
860 for (j = 0; j < source_package->descriptor->sub_descriptors_count; j++) {
861 MXFDescriptor *sub_descriptor = mxf_resolve_strong_ref(mxf, &source_package->descriptor->sub_descriptors_refs[j], Descriptor);
863 if (!sub_descriptor) {
864 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve sub descriptor strong ref\n");
867 if (sub_descriptor->linked_track_id == source_track->track_id) {
868 descriptor = sub_descriptor;
872 } else if (source_package->descriptor->type == Descriptor)
873 descriptor = source_package->descriptor;
876 av_log(mxf->fc, AV_LOG_INFO, "source track %d: stream %d, no descriptor found\n", source_track->track_id, st->index);
879 PRINT_KEY(mxf->fc, "essence codec ul", descriptor->essence_codec_ul);
880 PRINT_KEY(mxf->fc, "essence container ul", descriptor->essence_container_ul);
881 essence_container_ul = &descriptor->essence_container_ul;
882 /* HACK: replacing the original key with mxf_encrypted_essence_container
883 * is not allowed according to s429-6, try to find correct information anyway */
884 if (IS_KLV_KEY(essence_container_ul, mxf_encrypted_essence_container)) {
885 av_log(mxf->fc, AV_LOG_INFO, "broken encrypted mxf file\n");
886 for (k = 0; k < mxf->metadata_sets_count; k++) {
887 MXFMetadataSet *metadata = mxf->metadata_sets[k];
888 if (metadata->type == CryptoContext) {
889 essence_container_ul = &((MXFCryptoContext *)metadata)->source_container_ul;
894 /* TODO: drop PictureEssenceCoding and SoundEssenceCompression, only check EssenceContainer */
895 codec_ul = mxf_get_codec_ul(ff_mxf_codec_uls, &descriptor->essence_codec_ul);
896 st->codec->codec_id = codec_ul->id;
897 if (descriptor->extradata) {
898 st->codec->extradata = descriptor->extradata;
899 st->codec->extradata_size = descriptor->extradata_size;
901 if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
902 container_ul = mxf_get_codec_ul(mxf_essence_container_uls, essence_container_ul);
903 if (st->codec->codec_id == CODEC_ID_NONE)
904 st->codec->codec_id = container_ul->id;
905 st->codec->width = descriptor->width;
906 st->codec->height = descriptor->height;
907 if (st->codec->codec_id == CODEC_ID_RAWVIDEO)
908 st->codec->pix_fmt = descriptor->pix_fmt;
909 st->need_parsing = AVSTREAM_PARSE_HEADERS;
910 } else if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
911 container_ul = mxf_get_codec_ul(mxf_essence_container_uls, essence_container_ul);
912 if (st->codec->codec_id == CODEC_ID_NONE)
913 st->codec->codec_id = container_ul->id;
914 st->codec->channels = descriptor->channels;
915 st->codec->bits_per_coded_sample = descriptor->bits_per_sample;
916 st->codec->sample_rate = descriptor->sample_rate.num / descriptor->sample_rate.den;
917 /* TODO: implement CODEC_ID_RAWAUDIO */
918 if (st->codec->codec_id == CODEC_ID_PCM_S16LE) {
919 if (descriptor->bits_per_sample == 24)
920 st->codec->codec_id = CODEC_ID_PCM_S24LE;
921 else if (descriptor->bits_per_sample == 32)
922 st->codec->codec_id = CODEC_ID_PCM_S32LE;
923 } else if (st->codec->codec_id == CODEC_ID_PCM_S16BE) {
924 if (descriptor->bits_per_sample == 24)
925 st->codec->codec_id = CODEC_ID_PCM_S24BE;
926 else if (descriptor->bits_per_sample == 32)
927 st->codec->codec_id = CODEC_ID_PCM_S32BE;
928 } else if (st->codec->codec_id == CODEC_ID_MP2) {
929 st->need_parsing = AVSTREAM_PARSE_FULL;
932 if (st->codec->codec_type != AVMEDIA_TYPE_DATA && (*essence_container_ul)[15] > 0x01) {
933 av_log(mxf->fc, AV_LOG_WARNING, "only frame wrapped mappings are correctly supported\n");
934 st->need_parsing = AVSTREAM_PARSE_FULL;
940 static const MXFMetadataReadTableEntry mxf_metadata_read_table[] = {
941 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x05,0x01,0x00 }, mxf_read_primer_pack },
942 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x02,0x01,0x00 }, mxf_read_partition_pack },
943 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x02,0x02,0x00 }, mxf_read_partition_pack },
944 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x02,0x03,0x00 }, mxf_read_partition_pack },
945 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x02,0x04,0x00 }, mxf_read_partition_pack },
946 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x03,0x01,0x00 }, mxf_read_partition_pack },
947 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x03,0x02,0x00 }, mxf_read_partition_pack },
948 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x03,0x03,0x00 }, mxf_read_partition_pack },
949 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x03,0x04,0x00 }, mxf_read_partition_pack },
950 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x04,0x02,0x00 }, mxf_read_partition_pack },
951 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x04,0x04,0x00 }, mxf_read_partition_pack },
952 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x18,0x00 }, mxf_read_content_storage, 0, AnyType },
953 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x37,0x00 }, mxf_read_source_package, sizeof(MXFPackage), SourcePackage },
954 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x36,0x00 }, mxf_read_material_package, sizeof(MXFPackage), MaterialPackage },
955 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x0F,0x00 }, mxf_read_sequence, sizeof(MXFSequence), Sequence },
956 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x11,0x00 }, mxf_read_source_clip, sizeof(MXFStructuralComponent), SourceClip },
957 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x44,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), MultipleDescriptor },
958 { { 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 */
959 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x28,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* CDCI */
960 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x29,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* RGBA */
961 { { 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 */
962 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x48,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* Wave */
963 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x47,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* AES3 */
964 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x3A,0x00 }, mxf_read_track, sizeof(MXFTrack), Track }, /* Static Track */
965 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x3B,0x00 }, mxf_read_track, sizeof(MXFTrack), Track }, /* Generic Track */
966 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x04,0x01,0x02,0x02,0x00,0x00 }, mxf_read_cryptographic_context, sizeof(MXFCryptoContext), CryptoContext },
967 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x10,0x01,0x00 }, mxf_read_index_table_segment, sizeof(MXFIndexTableSegment), IndexTableSegment },
968 { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, NULL, 0, AnyType },
971 static int mxf_read_local_tags(MXFContext *mxf, KLVPacket *klv, MXFMetadataReadFunc *read_child, int ctx_size, enum MXFMetadataSetType type)
973 AVIOContext *pb = mxf->fc->pb;
974 MXFMetadataSet *ctx = ctx_size ? av_mallocz(ctx_size) : mxf;
975 uint64_t klv_end = avio_tell(pb) + klv->length;
979 while (avio_tell(pb) + 4 < klv_end) {
980 int tag = avio_rb16(pb);
981 int size = avio_rb16(pb); /* KLV specified by 0x53 */
982 uint64_t next = avio_tell(pb) + size;
985 av_dlog(mxf->fc, "local tag %#04x size %d\n", tag, size);
986 if (!size) { /* ignore empty tag, needed for some files with empty UMID tag */
987 av_log(mxf->fc, AV_LOG_ERROR, "local tag %#04x with 0 size\n", tag);
990 if (tag > 0x7FFF) { /* dynamic tag */
992 for (i = 0; i < mxf->local_tags_count; i++) {
993 int local_tag = AV_RB16(mxf->local_tags+i*18);
994 if (local_tag == tag) {
995 memcpy(uid, mxf->local_tags+i*18+2, 16);
996 av_dlog(mxf->fc, "local tag %#04x\n", local_tag);
997 PRINT_KEY(mxf->fc, "uid", uid);
1001 if (ctx_size && tag == 0x3C0A)
1002 avio_read(pb, ctx->uid, 16);
1003 else if (read_child(ctx, pb, tag, size, uid) < 0)
1006 avio_seek(pb, next, SEEK_SET);
1008 if (ctx_size) ctx->type = type;
1009 return ctx_size ? mxf_add_metadata_set(mxf, ctx) : 0;
1012 static int mxf_read_header(AVFormatContext *s, AVFormatParameters *ap)
1014 MXFContext *mxf = s->priv_data;
1017 if (!mxf_read_sync(s->pb, mxf_header_partition_pack_key, 14)) {
1018 av_log(s, AV_LOG_ERROR, "could not find header partition pack key\n");
1021 avio_seek(s->pb, -14, SEEK_CUR);
1023 while (!url_feof(s->pb)) {
1024 const MXFMetadataReadTableEntry *metadata;
1026 if (klv_read_packet(&klv, s->pb) < 0)
1028 PRINT_KEY(s, "read header", klv.key);
1029 av_dlog(s, "size %"PRIu64" offset %#"PRIx64"\n", klv.length, klv.offset);
1030 if (IS_KLV_KEY(klv.key, mxf_encrypted_triplet_key) ||
1031 IS_KLV_KEY(klv.key, mxf_essence_element_key)) {
1032 /* FIXME avoid seek */
1033 avio_seek(s->pb, klv.offset, SEEK_SET);
1037 for (metadata = mxf_metadata_read_table; metadata->read; metadata++) {
1038 if (IS_KLV_KEY(klv.key, metadata->key)) {
1040 if (klv.key[5] == 0x53) {
1041 res = mxf_read_local_tags(mxf, &klv, metadata->read, metadata->ctx_size, metadata->type);
1043 res = metadata->read(mxf, s->pb, 0, 0, klv.key);
1045 av_log(s, AV_LOG_ERROR, "error reading header metadata\n");
1051 if (!metadata->read)
1052 avio_skip(s->pb, klv.length);
1054 return mxf_parse_structural_metadata(mxf);
1057 static int mxf_read_close(AVFormatContext *s)
1059 MXFContext *mxf = s->priv_data;
1062 av_freep(&mxf->packages_refs);
1064 for (i = 0; i < s->nb_streams; i++)
1065 s->streams[i]->priv_data = NULL;
1067 for (i = 0; i < mxf->metadata_sets_count; i++) {
1068 switch (mxf->metadata_sets[i]->type) {
1069 case MultipleDescriptor:
1070 av_freep(&((MXFDescriptor *)mxf->metadata_sets[i])->sub_descriptors_refs);
1073 av_freep(&((MXFSequence *)mxf->metadata_sets[i])->structural_components_refs);
1076 case MaterialPackage:
1077 av_freep(&((MXFPackage *)mxf->metadata_sets[i])->tracks_refs);
1082 av_freep(&mxf->metadata_sets[i]);
1084 av_freep(&mxf->partitions);
1085 av_freep(&mxf->metadata_sets);
1086 av_freep(&mxf->aesc);
1087 av_freep(&mxf->local_tags);
1091 static int mxf_probe(AVProbeData *p) {
1092 uint8_t *bufp = p->buf;
1093 uint8_t *end = p->buf + p->buf_size;
1095 if (p->buf_size < sizeof(mxf_header_partition_pack_key))
1098 /* Must skip Run-In Sequence and search for MXF header partition pack key SMPTE 377M 5.5 */
1099 end -= sizeof(mxf_header_partition_pack_key);
1100 for (; bufp < end; bufp++) {
1101 if (IS_KLV_KEY(bufp, mxf_header_partition_pack_key))
1102 return AVPROBE_SCORE_MAX;
1107 /* rudimentary byte seek */
1108 /* XXX: use MXF Index */
1109 static int mxf_read_seek(AVFormatContext *s, int stream_index, int64_t sample_time, int flags)
1111 AVStream *st = s->streams[stream_index];
1116 if (sample_time < 0)
1118 seconds = av_rescale(sample_time, st->time_base.num, st->time_base.den);
1119 avio_seek(s->pb, (s->bit_rate * seconds) >> 3, SEEK_SET);
1120 av_update_cur_dts(s, st, sample_time);
1124 AVInputFormat ff_mxf_demuxer = {
1126 .long_name = NULL_IF_CONFIG_SMALL("Material eXchange Format"),
1127 .priv_data_size = sizeof(MXFContext),
1128 .read_probe = mxf_probe,
1129 .read_header = mxf_read_header,
1130 .read_packet = mxf_read_packet,
1131 .read_close = mxf_read_close,
1132 .read_seek = mxf_read_seek,