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
50 #include "bytestream.h"
52 typedef uint8_t UID[16];
54 enum MXFMetadataSetType {
69 enum MXFMetadataSetType type;
70 UID source_container_ul;
75 enum MXFMetadataSetType type;
76 UID source_package_uid;
77 UID data_definition_ul;
79 int64_t start_position;
81 } MXFStructuralComponent;
85 enum MXFMetadataSetType type;
86 UID data_definition_ul;
87 UID *structural_components_refs;
88 int structural_components_count;
94 enum MXFMetadataSetType type;
95 MXFSequence *sequence; /* mandatory, and only one */
98 uint8_t track_number[4];
104 enum MXFMetadataSetType type;
105 UID essence_container_ul;
106 UID essence_codec_ul;
107 AVRational sample_rate;
108 AVRational aspect_ratio;
113 UID *sub_descriptors_refs;
114 int sub_descriptors_count;
122 enum MXFMetadataSetType type;
126 MXFDescriptor *descriptor; /* only one */
132 enum MXFMetadataSetType type;
138 MXFMetadataSet **metadata_sets;
139 int metadata_sets_count;
143 int local_tags_count;
152 enum MXFWrappingScheme {
159 unsigned matching_len;
166 } MXFDataDefinitionUL;
172 enum MXFMetadataSetType type;
173 } MXFMetadataReadTableEntry;
175 /* partial keys to match */
176 static const uint8_t mxf_header_partition_pack_key[] = { 0x06,0x0e,0x2b,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x02 };
177 static const uint8_t mxf_essence_element_key[] = { 0x06,0x0e,0x2b,0x34,0x01,0x02,0x01,0x01,0x0d,0x01,0x03,0x01 };
178 static const uint8_t mxf_klv_key[] = { 0x06,0x0e,0x2b,0x34 };
179 /* complete keys to match */
180 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 };
181 static const uint8_t mxf_encrypted_triplet_key[] = { 0x06,0x0e,0x2b,0x34,0x02,0x04,0x01,0x07,0x0d,0x01,0x03,0x01,0x02,0x7e,0x01,0x00 };
182 static const uint8_t mxf_encrypted_essence_container[] = { 0x06,0x0e,0x2b,0x34,0x04,0x01,0x01,0x07,0x0d,0x01,0x03,0x01,0x02,0x0b,0x01,0x00 };
183 static const uint8_t mxf_sony_mpeg4_extradata[] = { 0x06,0x0e,0x2b,0x34,0x04,0x01,0x01,0x01,0x0e,0x06,0x06,0x02,0x02,0x01,0x00,0x00 };
185 #define IS_KLV_KEY(x, y) (!memcmp(x, y, sizeof(y)))
187 #define PRINT_KEY(pc, s, x) dprintf(pc, "%s %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X\n", s, \
188 (x)[0], (x)[1], (x)[2], (x)[3], (x)[4], (x)[5], (x)[6], (x)[7], (x)[8], (x)[9], (x)[10], (x)[11], (x)[12], (x)[13], (x)[14], (x)[15])
190 static int64_t klv_decode_ber_length(ByteIOContext *pb)
192 uint64_t size = get_byte(pb);
193 if (size & 0x80) { /* long form */
194 int bytes_num = size & 0x7f;
195 /* SMPTE 379M 5.3.4 guarantee that bytes_num must not exceed 8 bytes */
200 size = size << 8 | get_byte(pb);
205 static int mxf_read_sync(ByteIOContext *pb, const uint8_t *key, unsigned size)
208 for (i = 0; i < size && !url_feof(pb); i++) {
212 else if (b != key[i])
218 static int klv_read_packet(KLVPacket *klv, ByteIOContext *pb)
220 if (!mxf_read_sync(pb, mxf_klv_key, 4))
222 klv->offset = url_ftell(pb) - 4;
223 memcpy(klv->key, mxf_klv_key, 4);
224 get_buffer(pb, klv->key + 4, 12);
225 klv->length = klv_decode_ber_length(pb);
226 return klv->length == -1 ? -1 : 0;
229 static int mxf_get_stream_index(AVFormatContext *s, KLVPacket *klv)
233 for (i = 0; i < s->nb_streams; i++) {
234 MXFTrack *track = s->streams[i]->priv_data;
236 if (!memcmp(klv->key + sizeof(mxf_essence_element_key), track->track_number, sizeof(track->track_number)))
239 /* return 0 if only one stream, for OP Atom files with 0 as track number */
240 return s->nb_streams == 1 ? 0 : -1;
243 /* XXX: use AVBitStreamFilter */
244 static int mxf_get_d10_aes3_packet(ByteIOContext *pb, AVStream *st, AVPacket *pkt, int64_t length)
246 uint8_t buffer[61444];
247 uint8_t *buf_ptr, *end_ptr, *data_ptr;
250 if (length > 61444) /* worst case PAL 1920 samples 8 channels */
252 get_buffer(pb, buffer, length);
253 av_new_packet(pkt, length);
254 data_ptr = pkt->data;
255 end_ptr = buffer + length;
256 buf_ptr = buffer + 4; /* skip SMPTE 331M header */
257 for (; buf_ptr < end_ptr; ) {
258 for (i = 0; i < st->codec->channels; i++) {
259 uint32_t sample = bytestream_get_le32(&buf_ptr);
260 if (st->codec->bits_per_sample == 24)
261 bytestream_put_le24(&data_ptr, (sample >> 4) & 0xffffff);
263 bytestream_put_le16(&data_ptr, (sample >> 12) & 0xffff);
265 buf_ptr += 32 - st->codec->channels*4; // always 8 channels stored SMPTE 331M
267 pkt->size = data_ptr - pkt->data;
271 static int mxf_decrypt_triplet(AVFormatContext *s, AVPacket *pkt, KLVPacket *klv)
273 static const uint8_t checkv[16] = {0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b};
274 MXFContext *mxf = s->priv_data;
275 ByteIOContext *pb = s->pb;
276 offset_t end = url_ftell(pb) + klv->length;
279 uint64_t plaintext_size;
284 if (!mxf->aesc && s->key && s->keylen == 16) {
285 mxf->aesc = av_malloc(av_aes_size);
288 av_aes_init(mxf->aesc, s->key, 128, 1);
291 url_fskip(pb, klv_decode_ber_length(pb));
293 klv_decode_ber_length(pb);
294 plaintext_size = get_be64(pb);
296 klv_decode_ber_length(pb);
297 get_buffer(pb, klv->key, 16);
298 if (!IS_KLV_KEY(klv, mxf_essence_element_key))
300 index = mxf_get_stream_index(s, klv);
304 klv_decode_ber_length(pb);
305 orig_size = get_be64(pb);
306 if (orig_size < plaintext_size)
309 size = klv_decode_ber_length(pb);
310 if (size < 32 || size - 32 < orig_size)
312 get_buffer(pb, ivec, 16);
313 get_buffer(pb, tmpbuf, 16);
315 av_aes_crypt(mxf->aesc, tmpbuf, tmpbuf, 1, ivec, 1);
316 if (memcmp(tmpbuf, checkv, 16))
317 av_log(s, AV_LOG_ERROR, "probably incorrect decryption key\n");
319 av_get_packet(pb, pkt, size);
320 size -= plaintext_size;
322 av_aes_crypt(mxf->aesc, &pkt->data[plaintext_size],
323 &pkt->data[plaintext_size], size >> 4, ivec, 1);
324 pkt->size = orig_size;
325 pkt->stream_index = index;
326 url_fskip(pb, end - url_ftell(pb));
330 static int mxf_read_packet(AVFormatContext *s, AVPacket *pkt)
334 while (!url_feof(s->pb)) {
335 if (klv_read_packet(&klv, s->pb) < 0)
338 PRINT_KEY(s, "read packet", klv.key);
340 if (IS_KLV_KEY(klv.key, mxf_encrypted_triplet_key)) {
341 int res = mxf_decrypt_triplet(s, pkt, &klv);
343 av_log(s, AV_LOG_ERROR, "invalid encoded triplet\n");
348 if (IS_KLV_KEY(klv.key, mxf_essence_element_key)) {
349 int index = mxf_get_stream_index(s, &klv);
351 av_log(s, AV_LOG_ERROR, "error getting stream index\n");
352 url_fskip(s->pb, klv.length);
355 /* check for 8 channels AES3 element */
356 if (klv.key[12] == 0x06 && klv.key[13] == 0x01 && klv.key[14] == 0x10) {
357 if (mxf_get_d10_aes3_packet(s->pb, s->streams[index], pkt, klv.length) < 0) {
358 av_log(s, AV_LOG_ERROR, "error reading D-10 aes3 frame\n");
362 av_get_packet(s->pb, pkt, klv.length);
363 pkt->stream_index = index;
364 pkt->pos = klv.offset;
367 url_fskip(s->pb, klv.length);
372 static int mxf_read_primer_pack(MXFContext *mxf)
374 ByteIOContext *pb = mxf->fc->pb;
375 int item_num = get_be32(pb);
376 int item_len = get_be32(pb);
378 if (item_len != 18) {
379 av_log(mxf->fc, AV_LOG_ERROR, "unsupported primer pack item length\n");
382 if (item_num > UINT_MAX / item_len)
384 mxf->local_tags_count = item_num;
385 mxf->local_tags = av_malloc(item_num*item_len);
386 if (!mxf->local_tags)
388 get_buffer(pb, mxf->local_tags, item_num*item_len);
392 static int mxf_add_metadata_set(MXFContext *mxf, void *metadata_set)
394 mxf->metadata_sets = av_realloc(mxf->metadata_sets, (mxf->metadata_sets_count + 1) * sizeof(*mxf->metadata_sets));
395 if (!mxf->metadata_sets)
397 mxf->metadata_sets[mxf->metadata_sets_count] = metadata_set;
398 mxf->metadata_sets_count++;
402 static int mxf_read_cryptographic_context(MXFCryptoContext *cryptocontext, ByteIOContext *pb, int tag, int size, UID uid)
406 if (IS_KLV_KEY(uid, mxf_crypto_source_container_ul))
407 get_buffer(pb, cryptocontext->source_container_ul, 16);
411 static int mxf_read_content_storage(MXFContext *mxf, ByteIOContext *pb, int tag)
415 mxf->packages_count = get_be32(pb);
416 if (mxf->packages_count >= UINT_MAX / sizeof(UID))
418 mxf->packages_refs = av_malloc(mxf->packages_count * sizeof(UID));
419 if (!mxf->packages_refs)
421 url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
422 get_buffer(pb, (uint8_t *)mxf->packages_refs, mxf->packages_count * sizeof(UID));
428 static int mxf_read_source_clip(MXFStructuralComponent *source_clip, ByteIOContext *pb, int tag)
432 source_clip->duration = get_be64(pb);
435 source_clip->start_position = get_be64(pb);
438 /* UMID, only get last 16 bytes */
440 get_buffer(pb, source_clip->source_package_uid, 16);
443 source_clip->source_track_id = get_be32(pb);
449 static int mxf_read_material_package(MXFPackage *package, ByteIOContext *pb, int tag)
453 package->tracks_count = get_be32(pb);
454 if (package->tracks_count >= UINT_MAX / sizeof(UID))
456 package->tracks_refs = av_malloc(package->tracks_count * sizeof(UID));
457 if (!package->tracks_refs)
459 url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
460 get_buffer(pb, (uint8_t *)package->tracks_refs, package->tracks_count * sizeof(UID));
466 static int mxf_read_track(MXFTrack *track, ByteIOContext *pb, int tag)
470 track->track_id = get_be32(pb);
473 get_buffer(pb, track->track_number, 4);
476 track->edit_rate.den = get_be32(pb);
477 track->edit_rate.num = get_be32(pb);
480 get_buffer(pb, track->sequence_ref, 16);
486 static int mxf_read_sequence(MXFSequence *sequence, ByteIOContext *pb, int tag)
490 sequence->duration = get_be64(pb);
493 get_buffer(pb, sequence->data_definition_ul, 16);
496 sequence->structural_components_count = get_be32(pb);
497 if (sequence->structural_components_count >= UINT_MAX / sizeof(UID))
499 sequence->structural_components_refs = av_malloc(sequence->structural_components_count * sizeof(UID));
500 if (!sequence->structural_components_refs)
502 url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
503 get_buffer(pb, (uint8_t *)sequence->structural_components_refs, sequence->structural_components_count * sizeof(UID));
509 static int mxf_read_source_package(MXFPackage *package, ByteIOContext *pb, int tag)
513 package->tracks_count = get_be32(pb);
514 if (package->tracks_count >= UINT_MAX / sizeof(UID))
516 package->tracks_refs = av_malloc(package->tracks_count * sizeof(UID));
517 if (!package->tracks_refs)
519 url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
520 get_buffer(pb, (uint8_t *)package->tracks_refs, package->tracks_count * sizeof(UID));
523 /* UMID, only get last 16 bytes */
525 get_buffer(pb, package->package_uid, 16);
528 get_buffer(pb, package->descriptor_ref, 16);
534 static void mxf_read_pixel_layout(ByteIOContext *pb, MXFDescriptor *descriptor)
540 dprintf(NULL, "pixel layout: code 0x%x\n", code);
543 descriptor->bits_per_sample += get_byte(pb);
546 descriptor->bits_per_sample += get_byte(pb);
549 descriptor->bits_per_sample += get_byte(pb);
554 } while (code != 0); /* SMPTE 377M E.2.46 */
557 static int mxf_read_generic_descriptor(MXFDescriptor *descriptor, ByteIOContext *pb, int tag, int size, UID uid)
561 descriptor->sub_descriptors_count = get_be32(pb);
562 if (descriptor->sub_descriptors_count >= UINT_MAX / sizeof(UID))
564 descriptor->sub_descriptors_refs = av_malloc(descriptor->sub_descriptors_count * sizeof(UID));
565 if (!descriptor->sub_descriptors_refs)
567 url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
568 get_buffer(pb, (uint8_t *)descriptor->sub_descriptors_refs, descriptor->sub_descriptors_count * sizeof(UID));
571 get_buffer(pb, descriptor->essence_container_ul, 16);
574 descriptor->linked_track_id = get_be32(pb);
576 case 0x3201: /* PictureEssenceCoding */
577 get_buffer(pb, descriptor->essence_codec_ul, 16);
580 descriptor->width = get_be32(pb);
583 descriptor->height = get_be32(pb);
586 descriptor->aspect_ratio.num = get_be32(pb);
587 descriptor->aspect_ratio.den = get_be32(pb);
590 descriptor->sample_rate.num = get_be32(pb);
591 descriptor->sample_rate.den = get_be32(pb);
593 case 0x3D06: /* SoundEssenceCompression */
594 get_buffer(pb, descriptor->essence_codec_ul, 16);
597 descriptor->channels = get_be32(pb);
600 descriptor->bits_per_sample = get_be32(pb);
603 mxf_read_pixel_layout(pb, descriptor);
606 /* Private uid used by SONY C0023S01.mxf */
607 if (IS_KLV_KEY(uid, mxf_sony_mpeg4_extradata)) {
608 descriptor->extradata = av_malloc(size);
609 if (!descriptor->extradata)
611 descriptor->extradata_size = size;
612 get_buffer(pb, descriptor->extradata, size);
619 /* SMPTE RP224 http://www.smpte-ra.org/mdd/index.html */
620 static const MXFDataDefinitionUL mxf_data_definition_uls[] = {
621 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x01,0x03,0x02,0x02,0x01,0x00,0x00,0x00 }, CODEC_TYPE_VIDEO },
622 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x01,0x03,0x02,0x02,0x02,0x00,0x00,0x00 }, CODEC_TYPE_AUDIO },
623 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x05,0x01,0x03,0x02,0x02,0x02,0x02,0x00,0x00 }, CODEC_TYPE_AUDIO },
624 { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, CODEC_TYPE_DATA },
627 static const MXFCodecUL mxf_codec_uls[] = {
628 /* PictureEssenceCoding */
629 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x03,0x04,0x01,0x02,0x02,0x01,0x01,0x11,0x00 }, 14, CODEC_ID_MPEG2VIDEO }, /* MP@ML Long GoP */
630 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x01,0x02,0x02,0x01,0x02,0x01,0x01 }, 14, CODEC_ID_MPEG2VIDEO }, /* D-10 50Mbps PAL */
631 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x03,0x04,0x01,0x02,0x02,0x01,0x03,0x03,0x00 }, 14, CODEC_ID_MPEG2VIDEO }, /* MP@HL Long GoP */
632 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x03,0x04,0x01,0x02,0x02,0x01,0x04,0x02,0x00 }, 14, CODEC_ID_MPEG2VIDEO }, /* 422P@HL I-Frame */
633 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x03,0x04,0x01,0x02,0x02,0x01,0x20,0x02,0x03 }, 14, CODEC_ID_MPEG4 }, /* XDCAM proxy_pal030926.mxf */
634 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x01,0x02,0x02,0x02,0x01,0x02,0x00 }, 13, CODEC_ID_DVVIDEO }, /* DV25 IEC PAL */
635 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x07,0x04,0x01,0x02,0x02,0x03,0x01,0x01,0x00 }, 14, CODEC_ID_JPEG2000 }, /* JPEG2000 Codestream */
636 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x01,0x02,0x01,0x7F,0x00,0x00,0x00 }, 13, CODEC_ID_RAWVIDEO }, /* Uncompressed */
637 /* SoundEssenceCompression */
638 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x02,0x02,0x01,0x00,0x00,0x00,0x00 }, 13, CODEC_ID_PCM_S16LE }, /* Uncompressed */
639 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x02,0x02,0x01,0x7F,0x00,0x00,0x00 }, 13, CODEC_ID_PCM_S16LE },
640 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x07,0x04,0x02,0x02,0x01,0x7E,0x00,0x00,0x00 }, 13, CODEC_ID_PCM_S16BE }, /* From Omneon MXF file */
641 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x04,0x04,0x02,0x02,0x02,0x03,0x01,0x01,0x00 }, 15, CODEC_ID_PCM_ALAW }, /* XDCAM Proxy C0023S01.mxf */
642 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x02,0x02,0x02,0x03,0x02,0x01,0x00 }, 15, CODEC_ID_AC3 },
643 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x02,0x02,0x02,0x03,0x02,0x05,0x00 }, 15, CODEC_ID_MP2 }, /* MP2 or MP3 */
644 //{ { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x02,0x02,0x02,0x03,0x02,0x1C,0x00 }, 15, CODEC_ID_DOLBY_E }, /* Dolby-E */
645 { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, 0, CODEC_ID_NONE },
648 static const MXFCodecUL mxf_picture_essence_container_uls[] = {
649 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x02,0x0D,0x01,0x03,0x01,0x02,0x04,0x60,0x01 }, 14, CODEC_ID_MPEG2VIDEO }, /* MPEG-ES Frame wrapped */
650 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x02,0x41,0x01 }, 14, CODEC_ID_DVVIDEO }, /* DV 625 25mbps */
651 { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, 0, CODEC_ID_NONE },
654 static const MXFCodecUL mxf_sound_essence_container_uls[] = {
655 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x06,0x01,0x00 }, 14, CODEC_ID_PCM_S16LE }, /* BWF Frame wrapped */
656 { { 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 */
657 { { 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 */
658 { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, 0, CODEC_ID_NONE },
662 * Match an uid independently of the version byte and up to len common bytes
665 static int mxf_match_uid(const UID key, const UID uid, int len)
668 for (i = 0; i < len; i++) {
669 if (i != 7 && key[i] != uid[i])
675 static const MXFCodecUL *mxf_get_codec_ul(const MXFCodecUL *uls, UID *uid)
677 while (uls->id != CODEC_ID_NONE) {
678 if(mxf_match_uid(uls->uid, *uid, uls->matching_len))
685 static enum CodecType mxf_get_codec_type(const MXFDataDefinitionUL *uls, UID *uid)
687 while (uls->type != CODEC_TYPE_DATA) {
688 if(mxf_match_uid(uls->uid, *uid, 16))
695 static void *mxf_resolve_strong_ref(MXFContext *mxf, UID *strong_ref, enum MXFMetadataSetType type)
701 for (i = 0; i < mxf->metadata_sets_count; i++) {
702 if (!memcmp(*strong_ref, mxf->metadata_sets[i]->uid, 16) &&
703 (type == AnyType || mxf->metadata_sets[i]->type == type)) {
704 return mxf->metadata_sets[i];
710 static int mxf_parse_structural_metadata(MXFContext *mxf)
712 MXFPackage *material_package = NULL;
713 MXFPackage *temp_package = NULL;
716 dprintf(mxf->fc, "metadata sets count %d\n", mxf->metadata_sets_count);
717 /* TODO: handle multiple material packages (OP3x) */
718 for (i = 0; i < mxf->packages_count; i++) {
719 material_package = mxf_resolve_strong_ref(mxf, &mxf->packages_refs[i], MaterialPackage);
720 if (material_package) break;
722 if (!material_package) {
723 av_log(mxf->fc, AV_LOG_ERROR, "no material package found\n");
727 for (i = 0; i < material_package->tracks_count; i++) {
728 MXFPackage *source_package = NULL;
729 MXFTrack *material_track = NULL;
730 MXFTrack *source_track = NULL;
731 MXFTrack *temp_track = NULL;
732 MXFDescriptor *descriptor = NULL;
733 MXFStructuralComponent *component = NULL;
734 UID *essence_container_ul = NULL;
735 const MXFCodecUL *codec_ul = NULL;
736 const MXFCodecUL *container_ul = NULL;
739 if (!(material_track = mxf_resolve_strong_ref(mxf, &material_package->tracks_refs[i], Track))) {
740 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve material track strong ref\n");
744 if (!(material_track->sequence = mxf_resolve_strong_ref(mxf, &material_track->sequence_ref, Sequence))) {
745 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve material track sequence strong ref\n");
749 /* TODO: handle multiple source clips */
750 for (j = 0; j < material_track->sequence->structural_components_count; j++) {
751 /* TODO: handle timecode component */
752 component = mxf_resolve_strong_ref(mxf, &material_track->sequence->structural_components_refs[j], SourceClip);
756 for (k = 0; k < mxf->packages_count; k++) {
757 temp_package = mxf_resolve_strong_ref(mxf, &mxf->packages_refs[k], SourcePackage);
760 if (!memcmp(temp_package->package_uid, component->source_package_uid, 16)) {
761 source_package = temp_package;
765 if (!source_package) {
766 av_log(mxf->fc, AV_LOG_ERROR, "material track %d: no corresponding source package found\n", material_track->track_id);
769 for (k = 0; k < source_package->tracks_count; k++) {
770 if (!(temp_track = mxf_resolve_strong_ref(mxf, &source_package->tracks_refs[k], Track))) {
771 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve source track strong ref\n");
774 if (temp_track->track_id == component->source_track_id) {
775 source_track = temp_track;
780 av_log(mxf->fc, AV_LOG_ERROR, "material track %d: no corresponding source track found\n", material_track->track_id);
787 st = av_new_stream(mxf->fc, source_track->track_id);
789 av_log(mxf->fc, AV_LOG_ERROR, "could not allocate stream\n");
792 st->priv_data = source_track;
793 st->duration = component->duration;
794 if (st->duration == -1)
795 st->duration = AV_NOPTS_VALUE;
796 st->start_time = component->start_position;
797 av_set_pts_info(st, 64, material_track->edit_rate.num, material_track->edit_rate.den);
799 if (!(source_track->sequence = mxf_resolve_strong_ref(mxf, &source_track->sequence_ref, Sequence))) {
800 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve source track sequence strong ref\n");
805 PRINT_KEY(mxf->fc, "data definition ul", source_track->sequence->data_definition_ul);
807 st->codec->codec_type = mxf_get_codec_type(mxf_data_definition_uls, &source_track->sequence->data_definition_ul);
809 source_package->descriptor = mxf_resolve_strong_ref(mxf, &source_package->descriptor_ref, AnyType);
810 if (source_package->descriptor) {
811 if (source_package->descriptor->type == MultipleDescriptor) {
812 for (j = 0; j < source_package->descriptor->sub_descriptors_count; j++) {
813 MXFDescriptor *sub_descriptor = mxf_resolve_strong_ref(mxf, &source_package->descriptor->sub_descriptors_refs[j], Descriptor);
815 if (!sub_descriptor) {
816 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve sub descriptor strong ref\n");
819 if (sub_descriptor->linked_track_id == source_track->track_id) {
820 descriptor = sub_descriptor;
824 } else if (source_package->descriptor->type == Descriptor)
825 descriptor = source_package->descriptor;
828 av_log(mxf->fc, AV_LOG_INFO, "source track %d: stream %d, no descriptor found\n", source_track->track_id, st->index);
832 PRINT_KEY(mxf->fc, "essence codec ul", descriptor->essence_codec_ul);
833 PRINT_KEY(mxf->fc, "essence container ul", descriptor->essence_container_ul);
835 essence_container_ul = &descriptor->essence_container_ul;
836 /* HACK: replacing the original key with mxf_encrypted_essence_container
837 * is not allowed according to s429-6, try to find correct information anyway */
838 if (IS_KLV_KEY(essence_container_ul, mxf_encrypted_essence_container)) {
839 av_log(mxf->fc, AV_LOG_INFO, "broken encrypted mxf file\n");
840 for (k = 0; k < mxf->metadata_sets_count; k++) {
841 MXFMetadataSet *metadata = mxf->metadata_sets[k];
842 if (metadata->type == CryptoContext) {
843 essence_container_ul = &((MXFCryptoContext *)metadata)->source_container_ul;
848 /* TODO: drop PictureEssenceCoding and SoundEssenceCompression, only check EssenceContainer */
849 codec_ul = mxf_get_codec_ul(mxf_codec_uls, &descriptor->essence_codec_ul);
850 st->codec->codec_id = codec_ul->id;
851 if (descriptor->extradata) {
852 st->codec->extradata = descriptor->extradata;
853 st->codec->extradata_size = descriptor->extradata_size;
855 if (st->codec->codec_type == CODEC_TYPE_VIDEO) {
856 container_ul = mxf_get_codec_ul(mxf_picture_essence_container_uls, essence_container_ul);
857 if (st->codec->codec_id == CODEC_ID_NONE)
858 st->codec->codec_id = container_ul->id;
859 st->codec->width = descriptor->width;
860 st->codec->height = descriptor->height;
861 st->codec->bits_per_sample = descriptor->bits_per_sample; /* Uncompressed */
862 st->need_parsing = AVSTREAM_PARSE_HEADERS;
863 } else if (st->codec->codec_type == CODEC_TYPE_AUDIO) {
864 container_ul = mxf_get_codec_ul(mxf_sound_essence_container_uls, essence_container_ul);
865 if (st->codec->codec_id == CODEC_ID_NONE)
866 st->codec->codec_id = container_ul->id;
867 st->codec->channels = descriptor->channels;
868 st->codec->bits_per_sample = descriptor->bits_per_sample;
869 st->codec->sample_rate = descriptor->sample_rate.num / descriptor->sample_rate.den;
870 /* TODO: implement CODEC_ID_RAWAUDIO */
871 if (st->codec->codec_id == CODEC_ID_PCM_S16LE) {
872 if (descriptor->bits_per_sample == 24)
873 st->codec->codec_id = CODEC_ID_PCM_S24LE;
874 else if (descriptor->bits_per_sample == 32)
875 st->codec->codec_id = CODEC_ID_PCM_S32LE;
876 } else if (st->codec->codec_id == CODEC_ID_PCM_S16BE) {
877 if (descriptor->bits_per_sample == 24)
878 st->codec->codec_id = CODEC_ID_PCM_S24BE;
879 else if (descriptor->bits_per_sample == 32)
880 st->codec->codec_id = CODEC_ID_PCM_S32BE;
881 } else if (st->codec->codec_id == CODEC_ID_MP2) {
882 st->need_parsing = AVSTREAM_PARSE_FULL;
885 if (st->codec->codec_type != CODEC_TYPE_DATA && (*essence_container_ul)[15] > 0x01) {
886 av_log(mxf->fc, AV_LOG_WARNING, "only frame wrapped mappings are correctly supported\n");
887 st->need_parsing = AVSTREAM_PARSE_FULL;
893 static const MXFMetadataReadTableEntry mxf_metadata_read_table[] = {
894 { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x05,0x01,0x00 }, mxf_read_primer_pack },
895 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x18,0x00 }, mxf_read_content_storage, 0, AnyType },
896 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x37,0x00 }, mxf_read_source_package, sizeof(MXFPackage), SourcePackage },
897 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x36,0x00 }, mxf_read_material_package, sizeof(MXFPackage), MaterialPackage },
898 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x0F,0x00 }, mxf_read_sequence, sizeof(MXFSequence), Sequence },
899 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x11,0x00 }, mxf_read_source_clip, sizeof(MXFStructuralComponent), SourceClip },
900 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x44,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), MultipleDescriptor },
901 { { 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 */
902 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x28,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* CDCI */
903 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x29,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* RGBA */
904 { { 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 */
905 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x48,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* Wave */
906 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x47,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* AES3 */
907 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x3A,0x00 }, mxf_read_track, sizeof(MXFTrack), Track }, /* Static Track */
908 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x3B,0x00 }, mxf_read_track, sizeof(MXFTrack), Track }, /* Generic Track */
909 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x04,0x01,0x02,0x02,0x00,0x00 }, mxf_read_cryptographic_context, sizeof(MXFCryptoContext), CryptoContext },
910 { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, NULL, 0, AnyType },
913 static int mxf_read_local_tags(MXFContext *mxf, KLVPacket *klv, int (*read_child)(), int ctx_size, enum MXFMetadataSetType type)
915 ByteIOContext *pb = mxf->fc->pb;
916 MXFMetadataSet *ctx = ctx_size ? av_mallocz(ctx_size) : mxf;
917 uint64_t klv_end = url_ftell(pb) + klv->length;
921 while (url_ftell(pb) + 4 < klv_end) {
922 int tag = get_be16(pb);
923 int size = get_be16(pb); /* KLV specified by 0x53 */
924 uint64_t next = url_ftell(pb) + size;
927 if (!size) { /* ignore empty tag, needed for some files with empty UMID tag */
928 av_log(mxf->fc, AV_LOG_ERROR, "local tag 0x%04X with 0 size\n", tag);
931 if (tag > 0x7FFF) { /* dynamic tag */
933 for (i = 0; i < mxf->local_tags_count; i++) {
934 int local_tag = AV_RB16(mxf->local_tags+i*18);
935 if (local_tag == tag) {
936 memcpy(uid, mxf->local_tags+i*18+2, 16);
937 dprintf(mxf->fc, "local tag 0x%04X\n", local_tag);
939 PRINT_KEY(mxf->fc, "uid", uid);
944 if (ctx_size && tag == 0x3C0A)
945 get_buffer(pb, ctx->uid, 16);
946 else if (read_child(ctx, pb, tag, size, uid) < 0)
949 url_fseek(pb, next, SEEK_SET);
951 if (ctx_size) ctx->type = type;
952 return ctx_size ? mxf_add_metadata_set(mxf, ctx) : 0;
955 static int mxf_read_header(AVFormatContext *s, AVFormatParameters *ap)
957 MXFContext *mxf = s->priv_data;
960 if (!mxf_read_sync(s->pb, mxf_header_partition_pack_key, 14)) {
961 av_log(s, AV_LOG_ERROR, "could not find header partition pack key\n");
964 url_fseek(s->pb, -14, SEEK_CUR);
966 while (!url_feof(s->pb)) {
967 const MXFMetadataReadTableEntry *metadata;
969 if (klv_read_packet(&klv, s->pb) < 0)
972 PRINT_KEY(s, "read header", klv.key);
974 if (IS_KLV_KEY(klv.key, mxf_encrypted_triplet_key) ||
975 IS_KLV_KEY(klv.key, mxf_essence_element_key)) {
976 /* FIXME avoid seek */
977 url_fseek(s->pb, klv.offset, SEEK_SET);
981 for (metadata = mxf_metadata_read_table; metadata->read; metadata++) {
982 if (IS_KLV_KEY(klv.key, metadata->key)) {
983 int (*read)() = klv.key[5] == 0x53 ? mxf_read_local_tags : metadata->read;
984 if (read(mxf, &klv, metadata->read, metadata->ctx_size, metadata->type) < 0) {
985 av_log(s, AV_LOG_ERROR, "error reading header metadata\n");
992 url_fskip(s->pb, klv.length);
994 return mxf_parse_structural_metadata(mxf);
997 static int mxf_read_close(AVFormatContext *s)
999 MXFContext *mxf = s->priv_data;
1002 av_freep(&mxf->packages_refs);
1003 for (i = 0; i < mxf->metadata_sets_count; i++) {
1004 switch (mxf->metadata_sets[i]->type) {
1005 case MultipleDescriptor:
1006 av_freep(&((MXFDescriptor *)mxf->metadata_sets[i])->sub_descriptors_refs);
1009 av_freep(&((MXFSequence *)mxf->metadata_sets[i])->structural_components_refs);
1012 case MaterialPackage:
1013 av_freep(&((MXFPackage *)mxf->metadata_sets[i])->tracks_refs);
1018 av_freep(&mxf->metadata_sets[i]);
1020 av_freep(&mxf->metadata_sets);
1021 av_freep(&mxf->aesc);
1022 av_freep(&mxf->local_tags);
1026 static int mxf_probe(AVProbeData *p) {
1027 uint8_t *bufp = p->buf;
1028 uint8_t *end = p->buf + p->buf_size;
1030 if (p->buf_size < sizeof(mxf_header_partition_pack_key))
1033 /* Must skip Run-In Sequence and search for MXF header partition pack key SMPTE 377M 5.5 */
1034 end -= sizeof(mxf_header_partition_pack_key);
1035 for (; bufp < end; bufp++) {
1036 if (IS_KLV_KEY(bufp, mxf_header_partition_pack_key))
1037 return AVPROBE_SCORE_MAX;
1042 /* rudimentary byte seek */
1043 /* XXX: use MXF Index */
1044 static int mxf_read_seek(AVFormatContext *s, int stream_index, int64_t sample_time, int flags)
1046 AVStream *st = s->streams[stream_index];
1051 if (sample_time < 0)
1053 seconds = av_rescale(sample_time, st->time_base.num, st->time_base.den);
1054 url_fseek(s->pb, (s->bit_rate * seconds) >> 3, SEEK_SET);
1055 av_update_cur_dts(s, st, sample_time);
1059 AVInputFormat mxf_demuxer = {