remove implicit header inclusions from mxf.h
[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 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     uint8_t buffer[61444];
218     const uint8_t *buf_ptr, *end_ptr;
219     uint8_t *data_ptr;
220     int i;
221
222     if (length > 61444) /* worst case PAL 1920 samples 8 channels */
223         return -1;
224     get_buffer(pb, buffer, length);
225     av_new_packet(pkt, length);
226     data_ptr = pkt->data;
227     end_ptr = buffer + length;
228     buf_ptr = buffer + 4; /* skip SMPTE 331M header */
229     for (; buf_ptr < end_ptr; ) {
230         for (i = 0; i < st->codec->channels; i++) {
231             uint32_t sample = bytestream_get_le32(&buf_ptr);
232             if (st->codec->bits_per_coded_sample == 24)
233                 bytestream_put_le24(&data_ptr, (sample >> 4) & 0xffffff);
234             else
235                 bytestream_put_le16(&data_ptr, (sample >> 12) & 0xffff);
236         }
237         buf_ptr += 32 - st->codec->channels*4; // always 8 channels stored SMPTE 331M
238     }
239     pkt->size = data_ptr - pkt->data;
240     return 0;
241 }
242
243 static int mxf_decrypt_triplet(AVFormatContext *s, AVPacket *pkt, KLVPacket *klv)
244 {
245     static const uint8_t checkv[16] = {0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b, 0x43, 0x48, 0x55, 0x4b};
246     MXFContext *mxf = s->priv_data;
247     ByteIOContext *pb = s->pb;
248     int64_t end = url_ftell(pb) + klv->length;
249     uint64_t size;
250     uint64_t orig_size;
251     uint64_t plaintext_size;
252     uint8_t ivec[16];
253     uint8_t tmpbuf[16];
254     int index;
255
256     if (!mxf->aesc && s->key && s->keylen == 16) {
257         mxf->aesc = av_malloc(av_aes_size);
258         if (!mxf->aesc)
259             return -1;
260         av_aes_init(mxf->aesc, s->key, 128, 1);
261     }
262     // crypto context
263     url_fskip(pb, klv_decode_ber_length(pb));
264     // plaintext offset
265     klv_decode_ber_length(pb);
266     plaintext_size = get_be64(pb);
267     // source klv key
268     klv_decode_ber_length(pb);
269     get_buffer(pb, klv->key, 16);
270     if (!IS_KLV_KEY(klv, mxf_essence_element_key))
271         return -1;
272     index = mxf_get_stream_index(s, klv);
273     if (index < 0)
274         return -1;
275     // source size
276     klv_decode_ber_length(pb);
277     orig_size = get_be64(pb);
278     if (orig_size < plaintext_size)
279         return -1;
280     // enc. code
281     size = klv_decode_ber_length(pb);
282     if (size < 32 || size - 32 < orig_size)
283         return -1;
284     get_buffer(pb, ivec, 16);
285     get_buffer(pb, tmpbuf, 16);
286     if (mxf->aesc)
287         av_aes_crypt(mxf->aesc, tmpbuf, tmpbuf, 1, ivec, 1);
288     if (memcmp(tmpbuf, checkv, 16))
289         av_log(s, AV_LOG_ERROR, "probably incorrect decryption key\n");
290     size -= 32;
291     av_get_packet(pb, pkt, size);
292     size -= plaintext_size;
293     if (mxf->aesc)
294         av_aes_crypt(mxf->aesc, &pkt->data[plaintext_size],
295                      &pkt->data[plaintext_size], size >> 4, ivec, 1);
296     pkt->size = orig_size;
297     pkt->stream_index = index;
298     url_fskip(pb, end - url_ftell(pb));
299     return 0;
300 }
301
302 static int mxf_read_packet(AVFormatContext *s, AVPacket *pkt)
303 {
304     KLVPacket klv;
305
306     while (!url_feof(s->pb)) {
307         if (klv_read_packet(&klv, s->pb) < 0)
308             return -1;
309         PRINT_KEY(s, "read packet", klv.key);
310         dprintf(s, "size %lld offset %#llx\n", klv.length, klv.offset);
311         if (IS_KLV_KEY(klv.key, mxf_encrypted_triplet_key)) {
312             int res = mxf_decrypt_triplet(s, pkt, &klv);
313             if (res < 0) {
314                 av_log(s, AV_LOG_ERROR, "invalid encoded triplet\n");
315                 return -1;
316             }
317             return 0;
318         }
319         if (IS_KLV_KEY(klv.key, mxf_essence_element_key)) {
320             int index = mxf_get_stream_index(s, &klv);
321             if (index < 0) {
322                 av_log(s, AV_LOG_ERROR, "error getting stream index %d\n", AV_RB32(klv.key+12));
323                 goto skip;
324             }
325             if (s->streams[index]->discard == AVDISCARD_ALL)
326                 goto skip;
327             /* check for 8 channels AES3 element */
328             if (klv.key[12] == 0x06 && klv.key[13] == 0x01 && klv.key[14] == 0x10) {
329                 if (mxf_get_d10_aes3_packet(s->pb, s->streams[index], pkt, klv.length) < 0) {
330                     av_log(s, AV_LOG_ERROR, "error reading D-10 aes3 frame\n");
331                     return -1;
332                 }
333             } else
334                 av_get_packet(s->pb, pkt, klv.length);
335             pkt->stream_index = index;
336             pkt->pos = klv.offset;
337             return 0;
338         } else
339         skip:
340             url_fskip(s->pb, klv.length);
341     }
342     return AVERROR(EIO);
343 }
344
345 static int mxf_read_primer_pack(MXFContext *mxf)
346 {
347     ByteIOContext *pb = mxf->fc->pb;
348     int item_num = get_be32(pb);
349     int item_len = get_be32(pb);
350
351     if (item_len != 18) {
352         av_log(mxf->fc, AV_LOG_ERROR, "unsupported primer pack item length\n");
353         return -1;
354     }
355     if (item_num > UINT_MAX / item_len)
356         return -1;
357     mxf->local_tags_count = item_num;
358     mxf->local_tags = av_malloc(item_num*item_len);
359     if (!mxf->local_tags)
360         return -1;
361     get_buffer(pb, mxf->local_tags, item_num*item_len);
362     return 0;
363 }
364
365 static int mxf_add_metadata_set(MXFContext *mxf, void *metadata_set)
366 {
367     mxf->metadata_sets = av_realloc(mxf->metadata_sets, (mxf->metadata_sets_count + 1) * sizeof(*mxf->metadata_sets));
368     if (!mxf->metadata_sets)
369         return -1;
370     mxf->metadata_sets[mxf->metadata_sets_count] = metadata_set;
371     mxf->metadata_sets_count++;
372     return 0;
373 }
374
375 static int mxf_read_cryptographic_context(MXFCryptoContext *cryptocontext, ByteIOContext *pb, int tag, int size, UID uid)
376 {
377     if (size != 16)
378         return -1;
379     if (IS_KLV_KEY(uid, mxf_crypto_source_container_ul))
380         get_buffer(pb, cryptocontext->source_container_ul, 16);
381     return 0;
382 }
383
384 static int mxf_read_content_storage(MXFContext *mxf, ByteIOContext *pb, int tag)
385 {
386     switch (tag) {
387     case 0x1901:
388         mxf->packages_count = get_be32(pb);
389         if (mxf->packages_count >= UINT_MAX / sizeof(UID))
390             return -1;
391         mxf->packages_refs = av_malloc(mxf->packages_count * sizeof(UID));
392         if (!mxf->packages_refs)
393             return -1;
394         url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
395         get_buffer(pb, (uint8_t *)mxf->packages_refs, mxf->packages_count * sizeof(UID));
396         break;
397     }
398     return 0;
399 }
400
401 static int mxf_read_source_clip(MXFStructuralComponent *source_clip, ByteIOContext *pb, int tag)
402 {
403     switch(tag) {
404     case 0x0202:
405         source_clip->duration = get_be64(pb);
406         break;
407     case 0x1201:
408         source_clip->start_position = get_be64(pb);
409         break;
410     case 0x1101:
411         /* UMID, only get last 16 bytes */
412         url_fskip(pb, 16);
413         get_buffer(pb, source_clip->source_package_uid, 16);
414         break;
415     case 0x1102:
416         source_clip->source_track_id = get_be32(pb);
417         break;
418     }
419     return 0;
420 }
421
422 static int mxf_read_material_package(MXFPackage *package, ByteIOContext *pb, int tag)
423 {
424     switch(tag) {
425     case 0x4403:
426         package->tracks_count = get_be32(pb);
427         if (package->tracks_count >= UINT_MAX / sizeof(UID))
428             return -1;
429         package->tracks_refs = av_malloc(package->tracks_count * sizeof(UID));
430         if (!package->tracks_refs)
431             return -1;
432         url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
433         get_buffer(pb, (uint8_t *)package->tracks_refs, package->tracks_count * sizeof(UID));
434         break;
435     }
436     return 0;
437 }
438
439 static int mxf_read_track(MXFTrack *track, ByteIOContext *pb, int tag)
440 {
441     switch(tag) {
442     case 0x4801:
443         track->track_id = get_be32(pb);
444         break;
445     case 0x4804:
446         get_buffer(pb, track->track_number, 4);
447         break;
448     case 0x4B01:
449         track->edit_rate.den = get_be32(pb);
450         track->edit_rate.num = get_be32(pb);
451         break;
452     case 0x4803:
453         get_buffer(pb, track->sequence_ref, 16);
454         break;
455     }
456     return 0;
457 }
458
459 static int mxf_read_sequence(MXFSequence *sequence, ByteIOContext *pb, int tag)
460 {
461     switch(tag) {
462     case 0x0202:
463         sequence->duration = get_be64(pb);
464         break;
465     case 0x0201:
466         get_buffer(pb, sequence->data_definition_ul, 16);
467         break;
468     case 0x1001:
469         sequence->structural_components_count = get_be32(pb);
470         if (sequence->structural_components_count >= UINT_MAX / sizeof(UID))
471             return -1;
472         sequence->structural_components_refs = av_malloc(sequence->structural_components_count * sizeof(UID));
473         if (!sequence->structural_components_refs)
474             return -1;
475         url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
476         get_buffer(pb, (uint8_t *)sequence->structural_components_refs, sequence->structural_components_count * sizeof(UID));
477         break;
478     }
479     return 0;
480 }
481
482 static int mxf_read_source_package(MXFPackage *package, ByteIOContext *pb, int tag)
483 {
484     switch(tag) {
485     case 0x4403:
486         package->tracks_count = get_be32(pb);
487         if (package->tracks_count >= UINT_MAX / sizeof(UID))
488             return -1;
489         package->tracks_refs = av_malloc(package->tracks_count * sizeof(UID));
490         if (!package->tracks_refs)
491             return -1;
492         url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
493         get_buffer(pb, (uint8_t *)package->tracks_refs, package->tracks_count * sizeof(UID));
494         break;
495     case 0x4401:
496         /* UMID, only get last 16 bytes */
497         url_fskip(pb, 16);
498         get_buffer(pb, package->package_uid, 16);
499         break;
500     case 0x4701:
501         get_buffer(pb, package->descriptor_ref, 16);
502         break;
503     }
504     return 0;
505 }
506
507 static int mxf_read_index_table_segment(MXFIndexTableSegment *segment, ByteIOContext *pb, int tag)
508 {
509     switch(tag) {
510     case 0x3F05: dprintf(NULL, "EditUnitByteCount %d\n", get_be32(pb)); break;
511     case 0x3F06: dprintf(NULL, "IndexSID %d\n", get_be32(pb)); break;
512     case 0x3F07: dprintf(NULL, "BodySID %d\n", get_be32(pb)); break;
513     case 0x3F0B: dprintf(NULL, "IndexEditRate %d/%d\n", get_be32(pb), get_be32(pb)); break;
514     case 0x3F0C: dprintf(NULL, "IndexStartPosition %lld\n", get_be64(pb)); break;
515     case 0x3F0D: dprintf(NULL, "IndexDuration %lld\n", get_be64(pb)); break;
516     }
517     return 0;
518 }
519
520 static void mxf_read_pixel_layout(ByteIOContext *pb, MXFDescriptor *descriptor)
521 {
522     int code;
523
524     do {
525         code = get_byte(pb);
526         dprintf(NULL, "pixel layout: code %#x\n", code);
527         switch (code) {
528         case 0x52: /* R */
529             descriptor->bits_per_sample += get_byte(pb);
530             break;
531         case 0x47: /* G */
532             descriptor->bits_per_sample += get_byte(pb);
533             break;
534         case 0x42: /* B */
535             descriptor->bits_per_sample += get_byte(pb);
536             break;
537         default:
538             get_byte(pb);
539         }
540     } while (code != 0); /* SMPTE 377M E.2.46 */
541 }
542
543 static int mxf_read_generic_descriptor(MXFDescriptor *descriptor, ByteIOContext *pb, int tag, int size, UID uid)
544 {
545     switch(tag) {
546     case 0x3F01:
547         descriptor->sub_descriptors_count = get_be32(pb);
548         if (descriptor->sub_descriptors_count >= UINT_MAX / sizeof(UID))
549             return -1;
550         descriptor->sub_descriptors_refs = av_malloc(descriptor->sub_descriptors_count * sizeof(UID));
551         if (!descriptor->sub_descriptors_refs)
552             return -1;
553         url_fskip(pb, 4); /* useless size of objects, always 16 according to specs */
554         get_buffer(pb, (uint8_t *)descriptor->sub_descriptors_refs, descriptor->sub_descriptors_count * sizeof(UID));
555         break;
556     case 0x3004:
557         get_buffer(pb, descriptor->essence_container_ul, 16);
558         break;
559     case 0x3006:
560         descriptor->linked_track_id = get_be32(pb);
561         break;
562     case 0x3201: /* PictureEssenceCoding */
563         get_buffer(pb, descriptor->essence_codec_ul, 16);
564         break;
565     case 0x3203:
566         descriptor->width = get_be32(pb);
567         break;
568     case 0x3202:
569         descriptor->height = get_be32(pb);
570         break;
571     case 0x320E:
572         descriptor->aspect_ratio.num = get_be32(pb);
573         descriptor->aspect_ratio.den = get_be32(pb);
574         break;
575     case 0x3D03:
576         descriptor->sample_rate.num = get_be32(pb);
577         descriptor->sample_rate.den = get_be32(pb);
578         break;
579     case 0x3D06: /* SoundEssenceCompression */
580         get_buffer(pb, descriptor->essence_codec_ul, 16);
581         break;
582     case 0x3D07:
583         descriptor->channels = get_be32(pb);
584         break;
585     case 0x3D01:
586         descriptor->bits_per_sample = get_be32(pb);
587         break;
588     case 0x3401:
589         mxf_read_pixel_layout(pb, descriptor);
590         break;
591     default:
592         /* Private uid used by SONY C0023S01.mxf */
593         if (IS_KLV_KEY(uid, mxf_sony_mpeg4_extradata)) {
594             descriptor->extradata = av_malloc(size);
595             if (!descriptor->extradata)
596                 return -1;
597             descriptor->extradata_size = size;
598             get_buffer(pb, descriptor->extradata, size);
599         }
600         break;
601     }
602     return 0;
603 }
604
605 /*
606  * Match an uid independently of the version byte and up to len common bytes
607  * Returns: boolean
608  */
609 static int mxf_match_uid(const UID key, const UID uid, int len)
610 {
611     int i;
612     for (i = 0; i < len; i++) {
613         if (i != 7 && key[i] != uid[i])
614             return 0;
615     }
616     return 1;
617 }
618
619 static const MXFCodecUL *mxf_get_codec_ul(const MXFCodecUL *uls, UID *uid)
620 {
621     while (uls->id != CODEC_ID_NONE) {
622         if(mxf_match_uid(uls->uid, *uid, uls->matching_len))
623             break;
624         uls++;
625     }
626     return uls;
627 }
628
629 static enum CodecType mxf_get_codec_type(const MXFDataDefinitionUL *uls, UID *uid)
630 {
631     while (uls->type != CODEC_TYPE_DATA) {
632         if(mxf_match_uid(uls->uid, *uid, 16))
633             break;
634         uls++;
635     }
636     return uls->type;
637 }
638
639 static void *mxf_resolve_strong_ref(MXFContext *mxf, UID *strong_ref, enum MXFMetadataSetType type)
640 {
641     int i;
642
643     if (!strong_ref)
644         return NULL;
645     for (i = 0; i < mxf->metadata_sets_count; i++) {
646         if (!memcmp(*strong_ref, mxf->metadata_sets[i]->uid, 16) &&
647             (type == AnyType || mxf->metadata_sets[i]->type == type)) {
648             return mxf->metadata_sets[i];
649         }
650     }
651     return NULL;
652 }
653
654 static const MXFCodecUL mxf_essence_container_uls[] = {
655     // video essence container uls
656     { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x02,0x0D,0x01,0x03,0x01,0x02,0x04,0x60,0x01 }, 14, CODEC_ID_MPEG2VIDEO }, /* MPEG-ES Frame wrapped */
657     { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x02,0x41,0x01 }, 14,    CODEC_ID_DVVIDEO }, /* DV 625 25mbps */
658     // sound essence container uls
659     { { 0x06,0x0E,0x2B,0x34,0x04,0x01,0x01,0x01,0x0D,0x01,0x03,0x01,0x02,0x06,0x01,0x00 }, 14, CODEC_ID_PCM_S16LE }, /* BWF Frame wrapped */
660     { { 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 */
661     { { 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 */
662     { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 },  0,      CODEC_ID_NONE },
663 };
664
665 static int mxf_parse_structural_metadata(MXFContext *mxf)
666 {
667     MXFPackage *material_package = NULL;
668     MXFPackage *temp_package = NULL;
669     int i, j, k;
670
671     dprintf(mxf->fc, "metadata sets count %d\n", mxf->metadata_sets_count);
672     /* TODO: handle multiple material packages (OP3x) */
673     for (i = 0; i < mxf->packages_count; i++) {
674         material_package = mxf_resolve_strong_ref(mxf, &mxf->packages_refs[i], MaterialPackage);
675         if (material_package) break;
676     }
677     if (!material_package) {
678         av_log(mxf->fc, AV_LOG_ERROR, "no material package found\n");
679         return -1;
680     }
681
682     for (i = 0; i < material_package->tracks_count; i++) {
683         MXFPackage *source_package = NULL;
684         MXFTrack *material_track = NULL;
685         MXFTrack *source_track = NULL;
686         MXFTrack *temp_track = NULL;
687         MXFDescriptor *descriptor = NULL;
688         MXFStructuralComponent *component = NULL;
689         UID *essence_container_ul = NULL;
690         const MXFCodecUL *codec_ul = NULL;
691         const MXFCodecUL *container_ul = NULL;
692         AVStream *st;
693
694         if (!(material_track = mxf_resolve_strong_ref(mxf, &material_package->tracks_refs[i], Track))) {
695             av_log(mxf->fc, AV_LOG_ERROR, "could not resolve material track strong ref\n");
696             continue;
697         }
698
699         if (!(material_track->sequence = mxf_resolve_strong_ref(mxf, &material_track->sequence_ref, Sequence))) {
700             av_log(mxf->fc, AV_LOG_ERROR, "could not resolve material track sequence strong ref\n");
701             return -1;
702         }
703
704         /* TODO: handle multiple source clips */
705         for (j = 0; j < material_track->sequence->structural_components_count; j++) {
706             /* TODO: handle timecode component */
707             component = mxf_resolve_strong_ref(mxf, &material_track->sequence->structural_components_refs[j], SourceClip);
708             if (!component)
709                 continue;
710
711             for (k = 0; k < mxf->packages_count; k++) {
712                 temp_package = mxf_resolve_strong_ref(mxf, &mxf->packages_refs[k], SourcePackage);
713                 if (!temp_package)
714                     continue;
715                 if (!memcmp(temp_package->package_uid, component->source_package_uid, 16)) {
716                     source_package = temp_package;
717                     break;
718                 }
719             }
720             if (!source_package) {
721                 av_log(mxf->fc, AV_LOG_ERROR, "material track %d: no corresponding source package found\n", material_track->track_id);
722                 break;
723             }
724             for (k = 0; k < source_package->tracks_count; k++) {
725                 if (!(temp_track = mxf_resolve_strong_ref(mxf, &source_package->tracks_refs[k], Track))) {
726                     av_log(mxf->fc, AV_LOG_ERROR, "could not resolve source track strong ref\n");
727                     return -1;
728                 }
729                 if (temp_track->track_id == component->source_track_id) {
730                     source_track = temp_track;
731                     break;
732                 }
733             }
734             if (!source_track) {
735                 av_log(mxf->fc, AV_LOG_ERROR, "material track %d: no corresponding source track found\n", material_track->track_id);
736                 break;
737             }
738         }
739         if (!source_track)
740             continue;
741
742         st = av_new_stream(mxf->fc, source_track->track_id);
743         if (!st) {
744             av_log(mxf->fc, AV_LOG_ERROR, "could not allocate stream\n");
745             return -1;
746         }
747         st->priv_data = source_track;
748         st->duration = component->duration;
749         if (st->duration == -1)
750             st->duration = AV_NOPTS_VALUE;
751         st->start_time = component->start_position;
752         av_set_pts_info(st, 64, material_track->edit_rate.num, material_track->edit_rate.den);
753
754         if (!(source_track->sequence = mxf_resolve_strong_ref(mxf, &source_track->sequence_ref, Sequence))) {
755             av_log(mxf->fc, AV_LOG_ERROR, "could not resolve source track sequence strong ref\n");
756             return -1;
757         }
758
759         PRINT_KEY(mxf->fc, "data definition   ul", source_track->sequence->data_definition_ul);
760         st->codec->codec_type = mxf_get_codec_type(ff_mxf_data_definition_uls, &source_track->sequence->data_definition_ul);
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 == CODEC_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             st->codec->bits_per_coded_sample = descriptor->bits_per_sample; /* Uncompressed */
813             st->need_parsing = AVSTREAM_PARSE_HEADERS;
814         } else if (st->codec->codec_type == CODEC_TYPE_AUDIO) {
815             container_ul = mxf_get_codec_ul(mxf_essence_container_uls, essence_container_ul);
816             if (st->codec->codec_id == CODEC_ID_NONE)
817                 st->codec->codec_id = container_ul->id;
818             st->codec->channels = descriptor->channels;
819             st->codec->bits_per_coded_sample = descriptor->bits_per_sample;
820             st->codec->sample_rate = descriptor->sample_rate.num / descriptor->sample_rate.den;
821             /* TODO: implement CODEC_ID_RAWAUDIO */
822             if (st->codec->codec_id == CODEC_ID_PCM_S16LE) {
823                 if (descriptor->bits_per_sample == 24)
824                     st->codec->codec_id = CODEC_ID_PCM_S24LE;
825                 else if (descriptor->bits_per_sample == 32)
826                     st->codec->codec_id = CODEC_ID_PCM_S32LE;
827             } else if (st->codec->codec_id == CODEC_ID_PCM_S16BE) {
828                 if (descriptor->bits_per_sample == 24)
829                     st->codec->codec_id = CODEC_ID_PCM_S24BE;
830                 else if (descriptor->bits_per_sample == 32)
831                     st->codec->codec_id = CODEC_ID_PCM_S32BE;
832             } else if (st->codec->codec_id == CODEC_ID_MP2) {
833                 st->need_parsing = AVSTREAM_PARSE_FULL;
834             }
835         }
836         if (st->codec->codec_type != CODEC_TYPE_DATA && (*essence_container_ul)[15] > 0x01) {
837             av_log(mxf->fc, AV_LOG_WARNING, "only frame wrapped mappings are correctly supported\n");
838             st->need_parsing = AVSTREAM_PARSE_FULL;
839         }
840     }
841     return 0;
842 }
843
844 static const MXFMetadataReadTableEntry mxf_metadata_read_table[] = {
845     { { 0x06,0x0E,0x2B,0x34,0x02,0x05,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x05,0x01,0x00 }, mxf_read_primer_pack },
846     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x18,0x00 }, mxf_read_content_storage, 0, AnyType },
847     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x37,0x00 }, mxf_read_source_package, sizeof(MXFPackage), SourcePackage },
848     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x36,0x00 }, mxf_read_material_package, sizeof(MXFPackage), MaterialPackage },
849     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x0F,0x00 }, mxf_read_sequence, sizeof(MXFSequence), Sequence },
850     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x11,0x00 }, mxf_read_source_clip, sizeof(MXFStructuralComponent), SourceClip },
851     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x44,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), MultipleDescriptor },
852     { { 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 */
853     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x28,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* CDCI */
854     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x29,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* RGBA */
855     { { 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 */
856     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x48,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* Wave */
857     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x47,0x00 }, mxf_read_generic_descriptor, sizeof(MXFDescriptor), Descriptor }, /* AES3 */
858     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x3A,0x00 }, mxf_read_track, sizeof(MXFTrack), Track }, /* Static Track */
859     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x01,0x01,0x01,0x01,0x3B,0x00 }, mxf_read_track, sizeof(MXFTrack), Track }, /* Generic Track */
860     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x04,0x01,0x02,0x02,0x00,0x00 }, mxf_read_cryptographic_context, sizeof(MXFCryptoContext), CryptoContext },
861     { { 0x06,0x0E,0x2B,0x34,0x02,0x53,0x01,0x01,0x0d,0x01,0x02,0x01,0x01,0x10,0x01,0x00 }, mxf_read_index_table_segment, sizeof(MXFIndexTableSegment), IndexTableSegment },
862     { { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 }, NULL, 0, AnyType },
863 };
864
865 static int mxf_read_local_tags(MXFContext *mxf, KLVPacket *klv, int (*read_child)(), int ctx_size, enum MXFMetadataSetType type)
866 {
867     ByteIOContext *pb = mxf->fc->pb;
868     MXFMetadataSet *ctx = ctx_size ? av_mallocz(ctx_size) : mxf;
869     uint64_t klv_end = url_ftell(pb) + klv->length;
870
871     if (!ctx)
872         return -1;
873     while (url_ftell(pb) + 4 < klv_end) {
874         int tag = get_be16(pb);
875         int size = get_be16(pb); /* KLV specified by 0x53 */
876         uint64_t next = url_ftell(pb) + size;
877         UID uid = {0};
878
879         dprintf(mxf->fc, "local tag %#04x size %d\n", tag, size);
880         if (!size) { /* ignore empty tag, needed for some files with empty UMID tag */
881             av_log(mxf->fc, AV_LOG_ERROR, "local tag %#04x with 0 size\n", tag);
882             continue;
883         }
884         if (tag > 0x7FFF) { /* dynamic tag */
885             int i;
886             for (i = 0; i < mxf->local_tags_count; i++) {
887                 int local_tag = AV_RB16(mxf->local_tags+i*18);
888                 if (local_tag == tag) {
889                     memcpy(uid, mxf->local_tags+i*18+2, 16);
890                     dprintf(mxf->fc, "local tag %#04x\n", local_tag);
891                     PRINT_KEY(mxf->fc, "uid", uid);
892                 }
893             }
894         }
895         if (ctx_size && tag == 0x3C0A)
896             get_buffer(pb, ctx->uid, 16);
897         else if (read_child(ctx, pb, tag, size, uid) < 0)
898             return -1;
899
900         url_fseek(pb, next, SEEK_SET);
901     }
902     if (ctx_size) ctx->type = type;
903     return ctx_size ? mxf_add_metadata_set(mxf, ctx) : 0;
904 }
905
906 static int mxf_read_header(AVFormatContext *s, AVFormatParameters *ap)
907 {
908     MXFContext *mxf = s->priv_data;
909     KLVPacket klv;
910
911     if (!mxf_read_sync(s->pb, mxf_header_partition_pack_key, 14)) {
912         av_log(s, AV_LOG_ERROR, "could not find header partition pack key\n");
913         return -1;
914     }
915     url_fseek(s->pb, -14, SEEK_CUR);
916     mxf->fc = s;
917     while (!url_feof(s->pb)) {
918         const MXFMetadataReadTableEntry *metadata;
919
920         if (klv_read_packet(&klv, s->pb) < 0)
921             return -1;
922         PRINT_KEY(s, "read header", klv.key);
923         dprintf(s, "size %lld offset %#llx\n", klv.length, klv.offset);
924         if (IS_KLV_KEY(klv.key, mxf_encrypted_triplet_key) ||
925             IS_KLV_KEY(klv.key, mxf_essence_element_key)) {
926             /* FIXME avoid seek */
927             url_fseek(s->pb, klv.offset, SEEK_SET);
928             break;
929         }
930
931         for (metadata = mxf_metadata_read_table; metadata->read; metadata++) {
932             if (IS_KLV_KEY(klv.key, metadata->key)) {
933                 int (*read)() = klv.key[5] == 0x53 ? mxf_read_local_tags : metadata->read;
934                 if (read(mxf, &klv, metadata->read, metadata->ctx_size, metadata->type) < 0) {
935                     av_log(s, AV_LOG_ERROR, "error reading header metadata\n");
936                     return -1;
937                 }
938                 break;
939             }
940         }
941         if (!metadata->read)
942             url_fskip(s->pb, klv.length);
943     }
944     return mxf_parse_structural_metadata(mxf);
945 }
946
947 static int mxf_read_close(AVFormatContext *s)
948 {
949     MXFContext *mxf = s->priv_data;
950     int i;
951
952     av_freep(&mxf->packages_refs);
953     for (i = 0; i < mxf->metadata_sets_count; i++) {
954         switch (mxf->metadata_sets[i]->type) {
955         case MultipleDescriptor:
956             av_freep(&((MXFDescriptor *)mxf->metadata_sets[i])->sub_descriptors_refs);
957             break;
958         case Sequence:
959             av_freep(&((MXFSequence *)mxf->metadata_sets[i])->structural_components_refs);
960             break;
961         case SourcePackage:
962         case MaterialPackage:
963             av_freep(&((MXFPackage *)mxf->metadata_sets[i])->tracks_refs);
964             break;
965         case Track:
966             mxf->metadata_sets[i] = NULL; /* will be freed later */
967             break;
968         default:
969             break;
970         }
971         av_freep(&mxf->metadata_sets[i]);
972     }
973     av_freep(&mxf->metadata_sets);
974     av_freep(&mxf->aesc);
975     av_freep(&mxf->local_tags);
976     return 0;
977 }
978
979 static int mxf_probe(AVProbeData *p) {
980     uint8_t *bufp = p->buf;
981     uint8_t *end = p->buf + p->buf_size;
982
983     if (p->buf_size < sizeof(mxf_header_partition_pack_key))
984         return 0;
985
986     /* Must skip Run-In Sequence and search for MXF header partition pack key SMPTE 377M 5.5 */
987     end -= sizeof(mxf_header_partition_pack_key);
988     for (; bufp < end; bufp++) {
989         if (IS_KLV_KEY(bufp, mxf_header_partition_pack_key))
990             return AVPROBE_SCORE_MAX;
991     }
992     return 0;
993 }
994
995 /* rudimentary byte seek */
996 /* XXX: use MXF Index */
997 static int mxf_read_seek(AVFormatContext *s, int stream_index, int64_t sample_time, int flags)
998 {
999     AVStream *st = s->streams[stream_index];
1000     int64_t seconds;
1001
1002     if (!s->bit_rate)
1003         return -1;
1004     if (sample_time < 0)
1005         sample_time = 0;
1006     seconds = av_rescale(sample_time, st->time_base.num, st->time_base.den);
1007     url_fseek(s->pb, (s->bit_rate * seconds) >> 3, SEEK_SET);
1008     av_update_cur_dts(s, st, sample_time);
1009     return 0;
1010 }
1011
1012 AVInputFormat mxf_demuxer = {
1013     "mxf",
1014     NULL_IF_CONFIG_SMALL("Material eXchange Format"),
1015     sizeof(MXFContext),
1016     mxf_probe,
1017     mxf_read_header,
1018     mxf_read_packet,
1019     mxf_read_close,
1020     mxf_read_seek,
1021 };