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 typedef uint8_t UID[16];
52 enum MXFMetadataSetType {
65 typedef struct MXFStructuralComponent {
67 enum MXFMetadataSetType type;
68 UID source_package_uid;
69 UID data_definition_ul;
71 int64_t start_position;
73 } MXFStructuralComponent;
75 typedef struct MXFSequence {
77 enum MXFMetadataSetType type;
78 UID data_definition_ul;
79 UID *structural_components_refs;
80 int structural_components_count;
84 typedef struct MXFTrack {
86 enum MXFMetadataSetType type;
87 MXFSequence *sequence; /* mandatory, and only one */
90 uint8_t track_number[4];
94 typedef struct MXFDescriptor {
96 enum MXFMetadataSetType type;
97 UID essence_container_ul;
99 AVRational sample_rate;
100 AVRational aspect_ratio;
105 UID *sub_descriptors_refs;
106 int sub_descriptors_count;
112 typedef struct MXFPackage {
114 enum MXFMetadataSetType type;
118 MXFDescriptor *descriptor; /* only one */
122 typedef struct MXFEssenceContainerData {
124 enum MXFMetadataSetType type;
125 UID linked_package_uid;
126 } MXFEssenceContainerData;
130 enum MXFMetadataSetType type;
133 typedef struct MXFContext {
136 UID *essence_container_data_sets_refs;
137 int essence_container_data_sets_count;
138 UID *essence_containers_uls; /* Universal Labels SMPTE RP224 */
139 int essence_containers_uls_count;
140 UID operational_pattern_ul;
141 UID content_storage_uid;
142 MXFMetadataSet **metadata_sets;
143 int metadata_sets_count;
148 typedef struct KLVPacket {
154 enum MXFWrappingScheme {
159 typedef struct MXFCodecUL {
162 enum MXFWrappingScheme wrapping;
165 typedef struct MXFDataDefinitionUL {
168 } MXFDataDefinitionUL;
170 typedef struct MXFMetadataReadTableEntry {
172 int (*read)(MXFContext *mxf, KLVPacket *klv);
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 /* complete keys to match */
179 static const uint8_t mxf_encrypted_triplet_key[] = { 0x06,0x0e,0x2b,0x34,0x02,0x04,0x01,0x07,0x0d,0x01,0x03,0x01,0x02,0x7e,0x01,0x00 };
181 #define IS_KLV_KEY(x, y) (!memcmp(x, y, sizeof(y)))
183 #define PRINT_KEY(s, x) dprintf("%s %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X\n", s, \
184 (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])
186 static int64_t klv_decode_ber_length(ByteIOContext *pb)
188 uint64_t size = get_byte(pb);
189 if (size & 0x80) { /* long form */
190 int bytes_num = size & 0x7f;
191 /* SMPTE 379M 5.3.4 guarantee that bytes_num must not exceed 8 bytes */
196 size = size << 8 | get_byte(pb);
201 static int klv_read_packet(KLVPacket *klv, ByteIOContext *pb)
203 klv->offset = url_ftell(pb);
204 get_buffer(pb, klv->key, 16);
205 klv->length = klv_decode_ber_length(pb);
206 return klv->length == -1 ? -1 : 0;
209 static int mxf_get_stream_index(AVFormatContext *s, KLVPacket *klv)
213 for (i = 0; i < s->nb_streams; i++) {
214 MXFTrack *track = s->streams[i]->priv_data;
216 if (!memcmp(klv->key + sizeof(mxf_essence_element_key), track->track_number, sizeof(track->track_number)))
219 /* return 0 if only one stream, for OP Atom files with 0 as track number */
220 return s->nb_streams == 1 ? 0 : -1;
223 /* XXX: use AVBitStreamFilter */
224 static int mxf_get_d10_aes3_packet(ByteIOContext *pb, AVStream *st, AVPacket *pkt, int64_t length)
226 uint8_t buffer[61444];
227 uint8_t *buf_ptr, *end_ptr, *data_ptr;
229 if (length > 61444) /* worst case PAL 1920 samples 8 channels */
231 get_buffer(pb, buffer, length);
232 av_new_packet(pkt, length);
233 data_ptr = pkt->data;
234 end_ptr = buffer + length;
235 buf_ptr = buffer + 4; /* skip SMPTE 331M header */
236 for (; buf_ptr < end_ptr; buf_ptr += 4) {
237 if (st->codec->bits_per_sample == 24) {
238 data_ptr[0] = (buf_ptr[2] >> 4) | ((buf_ptr[3] & 0x0f) << 4);
239 data_ptr[1] = (buf_ptr[1] >> 4) | ((buf_ptr[2] & 0x0f) << 4);
240 data_ptr[2] = (buf_ptr[0] >> 4) | ((buf_ptr[1] & 0x0f) << 4);
243 data_ptr[0] = (buf_ptr[2] >> 4) | ((buf_ptr[3] & 0x0f) << 4);
244 data_ptr[1] = (buf_ptr[1] >> 4) | ((buf_ptr[2] & 0x0f) << 4);
248 pkt->size = data_ptr - pkt->data;
252 static int mxf_read_packet(AVFormatContext *s, AVPacket *pkt)
254 MXFContext *mxf = s->priv_data;
257 while (!url_feof(&s->pb)) {
258 if (klv_read_packet(&klv, &s->pb) < 0) {
259 av_log(s, AV_LOG_ERROR, "error reading KLV packet\n");
263 PRINT_KEY("read packet", klv.key);
265 if (IS_KLV_KEY(klv.key, mxf_encrypted_triplet_key)) {
266 mxf->sync_key = mxf_encrypted_triplet_key;
267 av_log(s, AV_LOG_ERROR, "encrypted triplet not supported\n");
270 if (IS_KLV_KEY(klv.key, mxf_essence_element_key)) {
271 int index = mxf_get_stream_index(s, &klv);
273 av_log(s, AV_LOG_ERROR, "error getting stream index\n");
274 url_fskip(&s->pb, klv.length);
277 /* check for 8 channels AES3 element */
278 if (klv.key[12] == 0x06 && klv.key[13] == 0x01 && klv.key[14] == 0x10) {
279 if (mxf_get_d10_aes3_packet(&s->pb, s->streams[index], pkt, klv.length) < 0) {
280 av_log(s, AV_LOG_ERROR, "error reading D-10 aes3 frame\n");
284 av_get_packet(&s->pb, pkt, klv.length);
285 pkt->stream_index = index;
288 url_fskip(&s->pb, klv.length);
293 static int mxf_add_metadata_set(MXFContext *mxf, void *metadata_set)
295 mxf->metadata_sets = av_realloc(mxf->metadata_sets, (mxf->metadata_sets_count + 1) * sizeof(*mxf->metadata_sets));
296 mxf->metadata_sets[mxf->metadata_sets_count] = metadata_set;
297 mxf->metadata_sets_count++;
301 static int mxf_read_metadata_preface(MXFContext *mxf, KLVPacket *klv)
303 ByteIOContext *pb = &mxf->fc->pb;
306 while (bytes_read < klv->length) {
307 int tag = get_be16(pb);
308 int size = get_be16(pb); /* SMPTE 336M Table 8 KLV specified length, 0x53 */
312 get_buffer(pb, mxf->content_storage_uid, 16);
315 get_buffer(pb, mxf->operational_pattern_ul, 16);
318 mxf->essence_containers_uls_count = get_be32(pb);
319 if (mxf->essence_containers_uls_count >= UINT_MAX / sizeof(UID))
321 mxf->essence_containers_uls = av_malloc(mxf->essence_containers_uls_count * sizeof(UID));
322 url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
323 get_buffer(pb, (uint8_t *)mxf->essence_containers_uls, mxf->essence_containers_uls_count * sizeof(UID));
328 bytes_read += size + 4;
333 static int mxf_read_metadata_content_storage(MXFContext *mxf, KLVPacket *klv)
335 ByteIOContext *pb = &mxf->fc->pb;
338 while (bytes_read < klv->length) {
339 int tag = get_be16(pb);
340 int size = get_be16(pb); /* SMPTE 336M Table 8 KLV specified length, 0x53 */
342 dprintf("tag 0x%04X, size %d\n", tag, size);
345 mxf->packages_count = get_be32(pb);
346 if (mxf->packages_count >= UINT_MAX / sizeof(UID))
348 mxf->packages_refs = av_malloc(mxf->packages_count * sizeof(UID));
349 url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
350 get_buffer(pb, (uint8_t *)mxf->packages_refs, mxf->packages_count * sizeof(UID));
353 mxf->essence_container_data_sets_count = get_be32(pb);
354 if (mxf->essence_container_data_sets_count >= UINT_MAX / sizeof(UID))
356 mxf->essence_container_data_sets_refs = av_malloc(mxf->essence_container_data_sets_count * sizeof(UID));
357 url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
358 get_buffer(pb, (uint8_t *)mxf->essence_container_data_sets_refs, mxf->essence_container_data_sets_count * sizeof(UID));
363 bytes_read += size + 4;
368 #define MXF_READ_LOCAL_TAGS_START(typename, ctype, name) \
369 ByteIOContext *pb = &mxf->fc->pb;\
370 ctype *name = av_mallocz(sizeof(*name));\
373 while (bytes_read < klv->length) {\
374 int tag = get_be16(pb);\
375 int size = get_be16(pb); /* KLV specified by 0x53 */\
377 bytes_read += size + 4;\
378 dprintf("tag 0x%04X, size %d\n", tag, size);\
379 if (!size) { /* ignore empty tag, needed for some files with empty UMID tag */\
380 av_log(mxf->fc, AV_LOG_ERROR, "local tag 0x%04X with 0 size\n", tag);\
385 get_buffer(pb, name->uid, 16);\
388 #define MXF_READ_LOCAL_TAGS_STOP(typename, ctype, name)\
390 url_fskip(pb, size);\
393 name->type = typename;\
394 return mxf_add_metadata_set(mxf, name);
396 static int mxf_read_metadata_source_clip(MXFContext *mxf, KLVPacket *klv)
398 MXF_READ_LOCAL_TAGS_START(SourceClip, MXFStructuralComponent, source_clip)
400 source_clip->duration = get_be64(pb);
403 source_clip->start_position = get_be64(pb);
406 /* UMID, only get last 16 bytes */
408 get_buffer(pb, source_clip->source_package_uid, 16);
411 source_clip->source_track_id = get_be32(pb);
413 MXF_READ_LOCAL_TAGS_STOP(SourceClip, MXFStructuralComponent, source_clip)
416 static int mxf_read_metadata_material_package(MXFContext *mxf, KLVPacket *klv)
418 MXF_READ_LOCAL_TAGS_START(MaterialPackage, MXFPackage, package)
420 package->tracks_count = get_be32(pb);
421 if (package->tracks_count >= UINT_MAX / sizeof(UID))
423 package->tracks_refs = av_malloc(package->tracks_count * sizeof(UID));
424 url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
425 get_buffer(pb, (uint8_t *)package->tracks_refs, package->tracks_count * sizeof(UID));
427 MXF_READ_LOCAL_TAGS_STOP(MaterialPackage, MXFPackage, package)
430 static int mxf_read_metadata_track(MXFContext *mxf, KLVPacket *klv)
432 MXF_READ_LOCAL_TAGS_START(Track, MXFTrack, track)
434 track->track_id = get_be32(pb);
437 get_buffer(pb, track->track_number, 4);
440 track->edit_rate.den = get_be32(pb);
441 track->edit_rate.num = get_be32(pb);
444 get_buffer(pb, track->sequence_ref, 16);
446 MXF_READ_LOCAL_TAGS_STOP(Track, MXFTrack, track)
449 static int mxf_read_metadata_sequence(MXFContext *mxf, KLVPacket *klv)
451 MXF_READ_LOCAL_TAGS_START(Sequence, MXFSequence, sequence)
453 sequence->duration = get_be64(pb);
456 get_buffer(pb, sequence->data_definition_ul, 16);
459 sequence->structural_components_count = get_be32(pb);
460 if (sequence->structural_components_count >= UINT_MAX / sizeof(UID))
462 sequence->structural_components_refs = av_malloc(sequence->structural_components_count * sizeof(UID));
463 url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
464 get_buffer(pb, (uint8_t *)sequence->structural_components_refs, sequence->structural_components_count * sizeof(UID));
466 MXF_READ_LOCAL_TAGS_STOP(Sequence, MXFSequence, sequence)
469 static int mxf_read_metadata_source_package(MXFContext *mxf, KLVPacket *klv)
471 MXF_READ_LOCAL_TAGS_START(SourcePackage, MXFPackage, package)
473 package->tracks_count = get_be32(pb);
474 if (package->tracks_count >= UINT_MAX / sizeof(UID))
476 package->tracks_refs = av_malloc(package->tracks_count * sizeof(UID));
477 url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
478 get_buffer(pb, (uint8_t *)package->tracks_refs, package->tracks_count * sizeof(UID));
481 /* UMID, only get last 16 bytes */
483 get_buffer(pb, package->package_uid, 16);
486 get_buffer(pb, package->descriptor_ref, 16);
488 MXF_READ_LOCAL_TAGS_STOP(SourcePackage, MXFPackage, package)
491 static int mxf_read_metadata_multiple_descriptor(MXFContext *mxf, KLVPacket *klv)
493 MXF_READ_LOCAL_TAGS_START(MultipleDescriptor, MXFDescriptor, descriptor)
495 descriptor->sub_descriptors_count = get_be32(pb);
496 if (descriptor->sub_descriptors_count >= UINT_MAX / sizeof(UID))
498 descriptor->sub_descriptors_refs = av_malloc(descriptor->sub_descriptors_count * sizeof(UID));
499 url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
500 get_buffer(pb, (uint8_t *)descriptor->sub_descriptors_refs, descriptor->sub_descriptors_count * sizeof(UID));
502 MXF_READ_LOCAL_TAGS_STOP(MultipleDescriptor, MXFDescriptor, descriptor)
505 static void mxf_read_metadata_pixel_layout(ByteIOContext *pb, MXFDescriptor *descriptor)
511 dprintf("pixel layout: code 0x%x\n", code);
514 descriptor->bits_per_sample += get_byte(pb);
517 descriptor->bits_per_sample += get_byte(pb);
520 descriptor->bits_per_sample += get_byte(pb);
525 } while (code != 0); /* SMPTE 377M E.2.46 */
528 static int mxf_read_metadata_generic_descriptor(MXFContext *mxf, KLVPacket *klv)
530 MXF_READ_LOCAL_TAGS_START(Descriptor, MXFDescriptor, descriptor)
532 get_buffer(pb, descriptor->essence_container_ul, 16);
535 descriptor->linked_track_id = get_be32(pb);
537 case 0x3201: /* PictureEssenceCoding */
538 get_buffer(pb, descriptor->essence_codec_ul, 16);
541 descriptor->width = get_be32(pb);
544 descriptor->height = get_be32(pb);
547 descriptor->aspect_ratio.num = get_be32(pb);
548 descriptor->aspect_ratio.den = get_be32(pb);
551 descriptor->sample_rate.num = get_be32(pb);
552 descriptor->sample_rate.den = get_be32(pb);
554 case 0x3D06: /* SoundEssenceCompression */
555 get_buffer(pb, descriptor->essence_codec_ul, 16);
558 descriptor->channels = get_be32(pb);
561 descriptor->bits_per_sample = get_be32(pb);
564 mxf_read_metadata_pixel_layout(pb, descriptor);
566 case 0x8201: /* Private tag used by SONY C0023S01.mxf */
567 descriptor->extradata = av_malloc(size);
568 descriptor->extradata_size = size;
569 get_buffer(pb, descriptor->extradata, size);
571 MXF_READ_LOCAL_TAGS_STOP(Descriptor, MXFDescriptor, descriptor)
574 /* SMPTE RP224 http://www.smpte-ra.org/mdd/index.html */
575 static const MXFDataDefinitionUL mxf_data_definition_uls[] = {
576 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x01,0x03,0x02,0x02,0x01,0x00,0x00,0x00 }, CODEC_TYPE_VIDEO },
577 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x01,0x03,0x02,0x02,0x02,0x00,0x00,0x00 }, CODEC_TYPE_AUDIO },
578 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x05,0x01,0x03,0x02,0x02,0x02,0x02,0x00,0x00 }, CODEC_TYPE_AUDIO },
579 { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, CODEC_TYPE_DATA },
582 static const MXFCodecUL mxf_codec_uls[] = {
583 /* PictureEssenceCoding */
584 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x03,0x04,0x01,0x02,0x02,0x01,0x02,0x02,0x00 }, CODEC_ID_MPEG2VIDEO, Frame }, /* 422P@ML I-Frame */
585 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x03,0x04,0x01,0x02,0x02,0x01,0x04,0x02,0x00 }, CODEC_ID_MPEG2VIDEO, Frame }, /* 422P@HL I-Frame */
586 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x03,0x04,0x01,0x02,0x02,0x01,0x04,0x03,0x00 }, CODEC_ID_MPEG2VIDEO, Frame }, /* 422P@HL Long GoP */
587 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x03,0x04,0x01,0x02,0x02,0x01,0x01,0x11,0x00 }, CODEC_ID_MPEG2VIDEO, Frame }, /* MP@ML Long GoP */
588 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x03,0x04,0x01,0x02,0x02,0x01,0x02,0x03,0x00 }, CODEC_ID_MPEG2VIDEO, Frame }, /* 422P@ML Long GoP */
589 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x03,0x04,0x01,0x02,0x02,0x01,0x03,0x03,0x00 }, CODEC_ID_MPEG2VIDEO, Frame }, /* MP@HL Long GoP */
590 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x03,0x04,0x01,0x02,0x02,0x01,0x20,0x02,0x03 }, CODEC_ID_MPEG4, Frame }, /* XDCAM proxy_pal030926.mxf */
591 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x03,0x04,0x01,0x02,0x02,0x01,0x20,0x02,0x04 }, CODEC_ID_MPEG4, Frame }, /* XDCAM Proxy C0023S01.mxf */
592 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x01,0x02,0x02,0x01,0x02,0x01,0x05 }, CODEC_ID_MPEG2VIDEO, Frame }, /* D-10 30Mbps PAL */
593 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x01,0x02,0x02,0x01,0x02,0x01,0x01 }, CODEC_ID_MPEG2VIDEO, Frame }, /* D-10 50Mbps PAL */
594 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x01,0x02,0x02,0x02,0x02,0x04,0x00 }, CODEC_ID_DVVIDEO, Frame }, /* DVCPRO50 PAL */
595 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x01,0x02,0x02,0x02,0x02,0x02,0x00 }, CODEC_ID_DVVIDEO, Frame }, /* DVCPRO25 PAL */
596 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x01,0x02,0x02,0x02,0x01,0x02,0x00 }, CODEC_ID_DVVIDEO, Frame }, /* DV25 IEC PAL */
597 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x07,0x04,0x01,0x02,0x02,0x03,0x01,0x01,0x00 }, CODEC_ID_JPEG2000, Frame }, /* JPEG2000 Codestream */
598 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x01,0x02,0x01,0x7F,0x00,0x00,0x00 }, CODEC_ID_RAWVIDEO, Frame }, /* Uncompressed */
599 /* SoundEssenceCompression */
600 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x02,0x02,0x01,0x00,0x00,0x00,0x00 }, CODEC_ID_PCM_S16LE, Frame }, /* Uncompressed */
601 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x02,0x02,0x01,0x7F,0x00,0x00,0x00 }, CODEC_ID_PCM_S16LE, Frame },
602 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x07,0x04,0x02,0x02,0x01,0x7E,0x00,0x00,0x00 }, CODEC_ID_PCM_S16BE, Frame }, /* From Omneon MXF file */
603 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x02,0x02,0x02,0x03,0x01,0x01,0x00 }, CODEC_ID_PCM_ALAW, Frame },
604 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x04,0x04,0x02,0x02,0x02,0x03,0x01,0x01,0x00 }, CODEC_ID_PCM_ALAW, Frame }, /* XDCAM Proxy C0023S01.mxf */
605 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x02,0x02,0x02,0x03,0x02,0x01,0x00 }, CODEC_ID_AC3, Frame },
606 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x02,0x02,0x02,0x03,0x02,0x05,0x00 }, CODEC_ID_MP2, Frame }, /* MP2 or MP3 */
607 //{ { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x04,0x02,0x02,0x02,0x03,0x02,0x1C,0x00 }, CODEC_ID_DOLBY_E, Frame }, /* Dolby-E */
608 { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, CODEC_ID_NONE, Frame },
611 static const MXFCodecUL mxf_picture_essence_container_uls[] = {
612 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x02,0x0D,0x01,0x03,0x01,0x02,0x04,0x60,0x01 }, CODEC_ID_MPEG2VIDEO, Frame }, /* MPEG-ES Frame wrapped */
613 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x02,0x0D,0x01,0x03,0x01,0x02,0x04,0xe0,0x02 }, CODEC_ID_MPEG2VIDEO, Clip }, /* MPEG-ES Clip wrapped, 0xe0 MPV stream id */
614 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x04,0x61,0x07 }, CODEC_ID_MPEG2VIDEO, Clip }, /* MPEG-ES Custom wrapped, 0x61 ??? stream id */
615 { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, CODEC_ID_NONE, Frame },
618 static const MXFCodecUL mxf_sound_essence_container_uls[] = {
619 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x06,0x01,0x00 }, CODEC_ID_PCM_S16LE, Frame }, /* BWF Frame wrapped */
620 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x06,0x03,0x00 }, CODEC_ID_PCM_S16LE, Frame }, /* AES Frame wrapped */
621 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x02,0x0D,0x01,0x03,0x01,0x02,0x04,0x40,0x01 }, CODEC_ID_MP2, Frame }, /* MPEG-ES Frame wrapped, 0x40 ??? stream id */
622 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x02,0x0D,0x01,0x03,0x01,0x02,0x04,0xc0,0x01 }, CODEC_ID_MP2, Frame }, /* MPEG-ES Frame wrapped, 0xc0 MPA stream id */
623 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x02,0x0D,0x01,0x03,0x01,0x02,0x04,0xc0,0x02 }, CODEC_ID_MP2, Clip }, /* MPEG-ES Clip wrapped, 0xc0 MPA stream id */
624 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x01,0x05,0x01 }, CODEC_ID_PCM_S16BE, Frame }, /* D-10 Mapping 30Mbps PAL Extended Template */
625 { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x01,0x01,0x01 }, CODEC_ID_PCM_S16BE, Frame }, /* D-10 Mapping 50Mbps PAL Extended Template */
626 { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, CODEC_ID_NONE, Frame },
629 static const MXFCodecUL *mxf_get_codec_ul(const MXFCodecUL *uls, UID *uid)
631 while (uls->id != CODEC_ID_NONE) {
632 if(!memcmp(uls->uid, *uid, 16))
639 static enum CodecType mxf_get_codec_type(const MXFDataDefinitionUL *uls, UID *uid)
641 while (uls->type != CODEC_TYPE_DATA) {
642 if(!memcmp(uls->uid, *uid, 16))
649 static void *mxf_resolve_strong_ref(MXFContext *mxf, UID *strong_ref, enum MXFMetadataSetType type)
655 for (i = 0; i < mxf->metadata_sets_count; i++) {
656 if (!memcmp(*strong_ref, mxf->metadata_sets[i]->uid, 16) &&
657 (type == AnyType || mxf->metadata_sets[i]->type == type)) {
658 return mxf->metadata_sets[i];
664 static int mxf_parse_structural_metadata(MXFContext *mxf)
666 MXFPackage *material_package = NULL;
667 MXFPackage *temp_package = NULL;
670 dprintf("metadata sets count %d\n", mxf->metadata_sets_count);
671 /* TODO: handle multiple material packages (OP3x) */
672 for (i = 0; i < mxf->packages_count; i++) {
673 material_package = mxf_resolve_strong_ref(mxf, &mxf->packages_refs[i], MaterialPackage);
674 if (material_package) break;
676 if (!material_package) {
677 av_log(mxf->fc, AV_LOG_ERROR, "no material package found\n");
681 for (i = 0; i < material_package->tracks_count; i++) {
682 MXFPackage *source_package = NULL;
683 MXFTrack *material_track = NULL;
684 MXFTrack *source_track = NULL;
685 MXFTrack *temp_track = NULL;
686 MXFDescriptor *descriptor = NULL;
687 MXFStructuralComponent *component = NULL;
688 const MXFCodecUL *codec_ul = NULL;
689 const MXFCodecUL *container_ul = NULL;
692 if (!(material_track = mxf_resolve_strong_ref(mxf, &material_package->tracks_refs[i], Track))) {
693 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve material track strong ref\n");
697 if (!(material_track->sequence = mxf_resolve_strong_ref(mxf, &material_track->sequence_ref, Sequence))) {
698 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve material track sequence strong ref\n");
702 /* TODO: handle multiple source clips */
703 for (j = 0; j < material_track->sequence->structural_components_count; j++) {
704 /* TODO: handle timecode component */
705 component = mxf_resolve_strong_ref(mxf, &material_track->sequence->structural_components_refs[j], SourceClip);
709 for (k = 0; k < mxf->packages_count; k++) {
710 temp_package = mxf_resolve_strong_ref(mxf, &mxf->packages_refs[k], SourcePackage);
713 if (!memcmp(temp_package->package_uid, component->source_package_uid, 16)) {
714 source_package = temp_package;
718 if (!source_package) {
719 av_log(mxf->fc, AV_LOG_ERROR, "material track %d: no corresponding source package found\n", material_track->track_id);
722 for (k = 0; k < source_package->tracks_count; k++) {
723 if (!(temp_track = mxf_resolve_strong_ref(mxf, &source_package->tracks_refs[k], Track))) {
724 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve source track strong ref\n");
727 if (temp_track->track_id == component->source_track_id) {
728 source_track = temp_track;
733 av_log(mxf->fc, AV_LOG_ERROR, "material track %d: no corresponding source track found\n", material_track->track_id);
740 st = av_new_stream(mxf->fc, source_track->track_id);
741 st->priv_data = source_track;
742 st->duration = component->duration;
743 if (st->duration == -1)
744 st->duration = AV_NOPTS_VALUE;
745 st->start_time = component->start_position;
746 av_set_pts_info(st, 64, material_track->edit_rate.num, material_track->edit_rate.den);
748 if (!(source_track->sequence = mxf_resolve_strong_ref(mxf, &source_track->sequence_ref, Sequence))) {
749 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve source track sequence strong ref\n");
754 PRINT_KEY("data definition ul", source_track->sequence->data_definition_ul);
756 st->codec->codec_type = mxf_get_codec_type(mxf_data_definition_uls, &source_track->sequence->data_definition_ul);
758 source_package->descriptor = mxf_resolve_strong_ref(mxf, &source_package->descriptor_ref, AnyType);
759 if (source_package->descriptor) {
760 if (source_package->descriptor->type == MultipleDescriptor) {
761 for (j = 0; j < source_package->descriptor->sub_descriptors_count; j++) {
762 MXFDescriptor *sub_descriptor = mxf_resolve_strong_ref(mxf, &source_package->descriptor->sub_descriptors_refs[j], Descriptor);
764 if (!sub_descriptor) {
765 av_log(mxf->fc, AV_LOG_ERROR, "could not resolve sub descriptor strong ref\n");
768 if (sub_descriptor->linked_track_id == source_track->track_id) {
769 descriptor = sub_descriptor;
773 } else if (source_package->descriptor->type == Descriptor)
774 descriptor = source_package->descriptor;
777 av_log(mxf->fc, AV_LOG_INFO, "source track %d: stream %d, no descriptor found\n", source_track->track_id, st->index);
781 PRINT_KEY("essence codec ul", descriptor->essence_codec_ul);
782 PRINT_KEY("essence container ul", descriptor->essence_container_ul);
784 /* TODO: drop PictureEssenceCoding and SoundEssenceCompression, only check EssenceContainer */
785 codec_ul = mxf_get_codec_ul(mxf_codec_uls, &descriptor->essence_codec_ul);
786 st->codec->codec_id = codec_ul->id;
787 if (descriptor->extradata) {
788 st->codec->extradata = descriptor->extradata;
789 st->codec->extradata_size = descriptor->extradata_size;
791 if (st->codec->codec_type == CODEC_TYPE_VIDEO) {
792 container_ul = mxf_get_codec_ul(mxf_picture_essence_container_uls, &descriptor->essence_container_ul);
793 if (st->codec->codec_id == CODEC_ID_NONE)
794 st->codec->codec_id = container_ul->id;
795 st->codec->width = descriptor->width;
796 st->codec->height = descriptor->height;
797 st->codec->bits_per_sample = descriptor->bits_per_sample; /* Uncompressed */
798 st->need_parsing = 2; /* only parse headers */
799 } else if (st->codec->codec_type == CODEC_TYPE_AUDIO) {
800 container_ul = mxf_get_codec_ul(mxf_sound_essence_container_uls, &descriptor->essence_container_ul);
801 if (st->codec->codec_id == CODEC_ID_NONE)
802 st->codec->codec_id = container_ul->id;
803 st->codec->channels = descriptor->channels;
804 st->codec->bits_per_sample = descriptor->bits_per_sample;
805 st->codec->sample_rate = descriptor->sample_rate.num / descriptor->sample_rate.den;
806 /* TODO: implement CODEC_ID_RAWAUDIO */
807 if (st->codec->codec_id == CODEC_ID_PCM_S16LE) {
808 if (descriptor->bits_per_sample == 24)
809 st->codec->codec_id = CODEC_ID_PCM_S24LE;
810 else if (descriptor->bits_per_sample == 32)
811 st->codec->codec_id = CODEC_ID_PCM_S32LE;
812 } else if (st->codec->codec_id == CODEC_ID_PCM_S16BE) {
813 if (descriptor->bits_per_sample == 24)
814 st->codec->codec_id = CODEC_ID_PCM_S24BE;
815 else if (descriptor->bits_per_sample == 32)
816 st->codec->codec_id = CODEC_ID_PCM_S32BE;
817 if (descriptor->essence_container_ul[13] == 0x01) /* D-10 Mapping */
818 st->codec->channels = 8; /* force channels to 8 */
819 } else if (st->codec->codec_id == CODEC_ID_MP2) {
820 st->need_parsing = 1;
823 if (container_ul && container_ul->wrapping == Clip) {
824 dprintf("stream %d: clip wrapped essence\n", st->index);
825 st->need_parsing = 1;
831 static const MXFMetadataReadTableEntry mxf_metadata_read_table[] = {
832 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x2F,0x00 }, mxf_read_metadata_preface },
833 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x18,0x00 }, mxf_read_metadata_content_storage },
834 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x37,0x00 }, mxf_read_metadata_source_package },
835 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x36,0x00 }, mxf_read_metadata_material_package },
836 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x0F,0x00 }, mxf_read_metadata_sequence },
837 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x11,0x00 }, mxf_read_metadata_source_clip },
838 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x44,0x00 }, mxf_read_metadata_multiple_descriptor },
839 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x42,0x00 }, mxf_read_metadata_generic_descriptor }, /* Generic Sound */
840 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x28,0x00 }, mxf_read_metadata_generic_descriptor }, /* CDCI */
841 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x29,0x00 }, mxf_read_metadata_generic_descriptor }, /* RGBA */
842 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x51,0x00 }, mxf_read_metadata_generic_descriptor }, /* MPEG 2 Video */
843 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x48,0x00 }, mxf_read_metadata_generic_descriptor }, /* Wave */
844 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x47,0x00 }, mxf_read_metadata_generic_descriptor }, /* AES3 */
845 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x3A,0x00 }, mxf_read_metadata_track }, /* Static Track */
846 { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x3B,0x00 }, mxf_read_metadata_track }, /* Generic Track */
847 { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, NULL },
850 static int mxf_read_sync(ByteIOContext *pb, const uint8_t *key, unsigned size)
853 for (i = 0; i < size && !url_feof(pb); i++) {
857 else if (b != key[i])
863 static int mxf_read_header(AVFormatContext *s, AVFormatParameters *ap)
865 MXFContext *mxf = s->priv_data;
868 mxf->sync_key = mxf_essence_element_key;
869 if (!mxf_read_sync(&s->pb, mxf_header_partition_pack_key, 14)) {
870 av_log(s, AV_LOG_ERROR, "could not find header partition pack key\n");
873 url_fseek(&s->pb, -14, SEEK_CUR);
875 while (!url_feof(&s->pb)) {
876 const MXFMetadataReadTableEntry *function;
878 if (klv_read_packet(&klv, &s->pb) < 0) {
879 av_log(s, AV_LOG_ERROR, "error reading KLV packet\n");
883 PRINT_KEY("read header", klv.key);
885 if (IS_KLV_KEY(klv.key, mxf_essence_element_key)) {
886 /* FIXME avoid seek */
887 url_fseek(&s->pb, klv.offset, SEEK_SET);
891 for (function = mxf_metadata_read_table; function->read; function++) {
892 if (IS_KLV_KEY(klv.key, function->key)) {
893 if (function->read(mxf, &klv) < 0) {
894 av_log(s, AV_LOG_ERROR, "error reading header metadata\n");
901 url_fskip(&s->pb, klv.length);
903 return mxf_parse_structural_metadata(mxf);
906 static int mxf_read_close(AVFormatContext *s)
908 MXFContext *mxf = s->priv_data;
911 av_freep(&mxf->packages_refs);
912 av_freep(&mxf->essence_container_data_sets_refs);
913 av_freep(&mxf->essence_containers_uls);
914 for (i = 0; i < mxf->metadata_sets_count; i++) {
915 switch (mxf->metadata_sets[i]->type) {
916 case MultipleDescriptor:
917 av_freep(&((MXFDescriptor *)mxf->metadata_sets[i])->sub_descriptors_refs);
920 av_freep(&((MXFSequence *)mxf->metadata_sets[i])->structural_components_refs);
923 case MaterialPackage:
924 av_freep(&((MXFPackage *)mxf->metadata_sets[i])->tracks_refs);
929 av_freep(&mxf->metadata_sets[i]);
931 av_freep(&mxf->metadata_sets);
935 static int mxf_probe(AVProbeData *p) {
936 uint8_t *bufp = p->buf;
937 uint8_t *end = p->buf + p->buf_size;
939 if (p->buf_size < sizeof(mxf_header_partition_pack_key))
942 /* Must skip Run-In Sequence and search for MXF header partition pack key SMPTE 377M 5.5 */
943 end -= sizeof(mxf_header_partition_pack_key);
944 for (; bufp < end; bufp++) {
945 if (IS_KLV_KEY(bufp, mxf_header_partition_pack_key))
946 return AVPROBE_SCORE_MAX;
951 /* rudimentary binary seek */
952 /* XXX: use MXF Index */
953 static int mxf_read_seek(AVFormatContext *s, int stream_index, int64_t sample_time, int flags)
955 MXFContext *mxf = s->priv_data;
956 AVStream *st = s->streams[stream_index];
963 seconds = av_rescale(sample_time, st->time_base.num, st->time_base.den);
964 url_fseek(&s->pb, (s->bit_rate * seconds) >> 3, SEEK_SET);
965 if (!mxf_read_sync(&s->pb, mxf->sync_key, 12))
969 url_fseek(&s->pb, -12, SEEK_CUR);
970 av_update_cur_dts(s, st, sample_time);
974 AVInputFormat mxf_demuxer = {