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