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