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