matroskaenc: Mux clusters better
[ffmpeg.git] / libavformat / matroskaenc.c
1 /*
2  * Matroska muxer
3  * Copyright (c) 2007 David Conrad
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 #include "avformat.h"
23 #include "riff.h"
24 #include "isom.h"
25 #include "matroska.h"
26 #include "avc.h"
27 #include "flacenc.h"
28 #include "libavutil/intreadwrite.h"
29 #include "libavutil/md5.h"
30 #include "libavcodec/xiph.h"
31 #include "libavcodec/mpeg4audio.h"
32
33 typedef struct ebml_master {
34     int64_t         pos;                ///< absolute offset in the file where the master's elements start
35     int             sizebytes;          ///< how many bytes were reserved for the size
36 } ebml_master;
37
38 typedef struct mkv_seekhead_entry {
39     unsigned int    elementid;
40     uint64_t        segmentpos;
41 } mkv_seekhead_entry;
42
43 typedef struct mkv_seekhead {
44     int64_t                 filepos;
45     int64_t                 segment_offset;     ///< the file offset to the beginning of the segment
46     int                     reserved_size;      ///< -1 if appending to file
47     int                     max_entries;
48     mkv_seekhead_entry      *entries;
49     int                     num_entries;
50 } mkv_seekhead;
51
52 typedef struct {
53     uint64_t        pts;
54     int             tracknum;
55     int64_t         cluster_pos;        ///< file offset of the cluster containing the block
56 } mkv_cuepoint;
57
58 typedef struct {
59     int64_t         segment_offset;
60     mkv_cuepoint    *entries;
61     int             num_entries;
62 } mkv_cues;
63
64 typedef struct {
65     int             write_dts;
66 } mkv_track;
67
68 typedef struct MatroskaMuxContext {
69     ByteIOContext   *dyn_bc;
70     ebml_master     segment;
71     int64_t         segment_offset;
72     int64_t         segment_uid;
73     ebml_master     cluster;
74     int64_t         cluster_pos;        ///< file offset of the current cluster
75     int64_t         cluster_pts;
76     int64_t         duration_offset;
77     int64_t         duration;
78     mkv_seekhead    *main_seekhead;
79     mkv_seekhead    *cluster_seekhead;
80     mkv_cues        *cues;
81     mkv_track       *tracks;
82
83     struct AVMD5    *md5_ctx;
84     unsigned int    audio_buffer_size;
85     AVPacket        cur_audio_pkt;
86 } MatroskaMuxContext;
87
88
89 /** 2 bytes * 3 for EBML IDs, 3 1-byte EBML lengths, 8 bytes for 64 bit
90  * offset, 4 bytes for target EBML ID */
91 #define MAX_SEEKENTRY_SIZE 21
92
93 /** per-cuepoint-track - 3 1-byte EBML IDs, 3 1-byte EBML sizes, 2
94  * 8-byte uint max */
95 #define MAX_CUETRACKPOS_SIZE 22
96
97 /** per-cuepoint - 2 1-byte EBML IDs, 2 1-byte EBML sizes, 8-byte uint max */
98 #define MAX_CUEPOINT_SIZE(num_tracks) 12 + MAX_CUETRACKPOS_SIZE*num_tracks
99
100
101 static int ebml_id_size(unsigned int id)
102 {
103     return (av_log2(id+1)-1)/7+1;
104 }
105
106 static void put_ebml_id(ByteIOContext *pb, unsigned int id)
107 {
108     int i = ebml_id_size(id);
109     while (i--)
110         put_byte(pb, id >> (i*8));
111 }
112
113 /**
114  * Write an EBML size meaning "unknown size".
115  *
116  * @param bytes The number of bytes the size should occupy (maximum: 8).
117  */
118 static void put_ebml_size_unknown(ByteIOContext *pb, int bytes)
119 {
120     assert(bytes <= 8);
121     put_byte(pb, 0x1ff >> bytes);
122     while (--bytes)
123         put_byte(pb, 0xff);
124 }
125
126 /**
127  * Calculate how many bytes are needed to represent a given number in EBML.
128  */
129 static int ebml_num_size(uint64_t num)
130 {
131     int bytes = 1;
132     while ((num+1) >> bytes*7) bytes++;
133     return bytes;
134 }
135
136 /**
137  * Write a number in EBML variable length format.
138  *
139  * @param bytes The number of bytes that need to be used to write the number.
140  *              If zero, any number of bytes can be used.
141  */
142 static void put_ebml_num(ByteIOContext *pb, uint64_t num, int bytes)
143 {
144     int i, needed_bytes = ebml_num_size(num);
145
146     // sizes larger than this are currently undefined in EBML
147     assert(num < (1ULL<<56)-1);
148
149     if (bytes == 0)
150         // don't care how many bytes are used, so use the min
151         bytes = needed_bytes;
152     // the bytes needed to write the given size would exceed the bytes
153     // that we need to use, so write unknown size. This shouldn't happen.
154     assert(bytes >= needed_bytes);
155
156     num |= 1ULL << bytes*7;
157     for (i = bytes - 1; i >= 0; i--)
158         put_byte(pb, num >> i*8);
159 }
160
161 static void put_ebml_uint(ByteIOContext *pb, unsigned int elementid, uint64_t val)
162 {
163     int i, bytes = 1;
164     uint64_t tmp = val;
165     while (tmp>>=8) bytes++;
166
167     put_ebml_id(pb, elementid);
168     put_ebml_num(pb, bytes, 0);
169     for (i = bytes - 1; i >= 0; i--)
170         put_byte(pb, val >> i*8);
171 }
172
173 static void put_ebml_float(ByteIOContext *pb, unsigned int elementid, double val)
174 {
175     put_ebml_id(pb, elementid);
176     put_ebml_num(pb, 8, 0);
177     put_be64(pb, av_dbl2int(val));
178 }
179
180 static void put_ebml_binary(ByteIOContext *pb, unsigned int elementid,
181                             const uint8_t *buf, int size)
182 {
183     put_ebml_id(pb, elementid);
184     put_ebml_num(pb, size, 0);
185     put_buffer(pb, buf, size);
186 }
187
188 static void put_ebml_string(ByteIOContext *pb, unsigned int elementid, const char *str)
189 {
190     put_ebml_binary(pb, elementid, str, strlen(str));
191 }
192
193 /**
194  * Writes a void element of a given size. Useful for reserving space in
195  * the file to be written to later.
196  *
197  * @param size The number of bytes to reserve, which must be at least 2.
198  */
199 static void put_ebml_void(ByteIOContext *pb, uint64_t size)
200 {
201     int64_t currentpos = url_ftell(pb);
202
203     assert(size >= 2);
204
205     put_ebml_id(pb, EBML_ID_VOID);
206     // we need to subtract the length needed to store the size from the
207     // size we need to reserve so 2 cases, we use 8 bytes to store the
208     // size if possible, 1 byte otherwise
209     if (size < 10)
210         put_ebml_num(pb, size-1, 0);
211     else
212         put_ebml_num(pb, size-9, 8);
213     while(url_ftell(pb) < currentpos + size)
214         put_byte(pb, 0);
215 }
216
217 static ebml_master start_ebml_master(ByteIOContext *pb, unsigned int elementid, uint64_t expectedsize)
218 {
219     int bytes = expectedsize ? ebml_num_size(expectedsize) : 8;
220     put_ebml_id(pb, elementid);
221     put_ebml_size_unknown(pb, bytes);
222     return (ebml_master){ url_ftell(pb), bytes };
223 }
224
225 static void end_ebml_master(ByteIOContext *pb, ebml_master master)
226 {
227     int64_t pos = url_ftell(pb);
228
229     if (url_fseek(pb, master.pos - master.sizebytes, SEEK_SET) < 0)
230         return;
231     put_ebml_num(pb, pos - master.pos, master.sizebytes);
232     url_fseek(pb, pos, SEEK_SET);
233 }
234
235 static void put_xiph_size(ByteIOContext *pb, int size)
236 {
237     int i;
238     for (i = 0; i < size / 255; i++)
239         put_byte(pb, 255);
240     put_byte(pb, size % 255);
241 }
242
243 /**
244  * Initialize a mkv_seekhead element to be ready to index level 1 Matroska
245  * elements. If a maximum number of elements is specified, enough space
246  * will be reserved at the current file location to write a seek head of
247  * that size.
248  *
249  * @param segment_offset The absolute offset to the position in the file
250  *                       where the segment begins.
251  * @param numelements The maximum number of elements that will be indexed
252  *                    by this seek head, 0 if unlimited.
253  */
254 static mkv_seekhead * mkv_start_seekhead(ByteIOContext *pb, int64_t segment_offset, int numelements)
255 {
256     mkv_seekhead *new_seekhead = av_mallocz(sizeof(mkv_seekhead));
257     if (new_seekhead == NULL)
258         return NULL;
259
260     new_seekhead->segment_offset = segment_offset;
261
262     if (numelements > 0) {
263         new_seekhead->filepos = url_ftell(pb);
264         // 21 bytes max for a seek entry, 10 bytes max for the SeekHead ID
265         // and size, and 3 bytes to guarantee that an EBML void element
266         // will fit afterwards
267         new_seekhead->reserved_size = numelements * MAX_SEEKENTRY_SIZE + 13;
268         new_seekhead->max_entries = numelements;
269         put_ebml_void(pb, new_seekhead->reserved_size);
270     }
271     return new_seekhead;
272 }
273
274 static int mkv_add_seekhead_entry(mkv_seekhead *seekhead, unsigned int elementid, uint64_t filepos)
275 {
276     mkv_seekhead_entry *entries = seekhead->entries;
277
278     // don't store more elements than we reserved space for
279     if (seekhead->max_entries > 0 && seekhead->max_entries <= seekhead->num_entries)
280         return -1;
281
282     entries = av_realloc(entries, (seekhead->num_entries + 1) * sizeof(mkv_seekhead_entry));
283     if (entries == NULL)
284         return AVERROR(ENOMEM);
285
286     entries[seekhead->num_entries  ].elementid = elementid;
287     entries[seekhead->num_entries++].segmentpos = filepos - seekhead->segment_offset;
288
289     seekhead->entries = entries;
290     return 0;
291 }
292
293 /**
294  * Write the seek head to the file and free it. If a maximum number of
295  * elements was specified to mkv_start_seekhead(), the seek head will
296  * be written at the location reserved for it. Otherwise, it is written
297  * at the current location in the file.
298  *
299  * @return The file offset where the seekhead was written,
300  * -1 if an error occurred.
301  */
302 static int64_t mkv_write_seekhead(ByteIOContext *pb, mkv_seekhead *seekhead)
303 {
304     ebml_master metaseek, seekentry;
305     int64_t currentpos;
306     int i;
307
308     currentpos = url_ftell(pb);
309
310     if (seekhead->reserved_size > 0)
311         if (url_fseek(pb, seekhead->filepos, SEEK_SET) < 0)
312             return -1;
313
314     metaseek = start_ebml_master(pb, MATROSKA_ID_SEEKHEAD, seekhead->reserved_size);
315     for (i = 0; i < seekhead->num_entries; i++) {
316         mkv_seekhead_entry *entry = &seekhead->entries[i];
317
318         seekentry = start_ebml_master(pb, MATROSKA_ID_SEEKENTRY, MAX_SEEKENTRY_SIZE);
319
320         put_ebml_id(pb, MATROSKA_ID_SEEKID);
321         put_ebml_num(pb, ebml_id_size(entry->elementid), 0);
322         put_ebml_id(pb, entry->elementid);
323
324         put_ebml_uint(pb, MATROSKA_ID_SEEKPOSITION, entry->segmentpos);
325         end_ebml_master(pb, seekentry);
326     }
327     end_ebml_master(pb, metaseek);
328
329     if (seekhead->reserved_size > 0) {
330         uint64_t remaining = seekhead->filepos + seekhead->reserved_size - url_ftell(pb);
331         put_ebml_void(pb, remaining);
332         url_fseek(pb, currentpos, SEEK_SET);
333
334         currentpos = seekhead->filepos;
335     }
336     av_free(seekhead->entries);
337     av_free(seekhead);
338
339     return currentpos;
340 }
341
342 static mkv_cues * mkv_start_cues(int64_t segment_offset)
343 {
344     mkv_cues *cues = av_mallocz(sizeof(mkv_cues));
345     if (cues == NULL)
346         return NULL;
347
348     cues->segment_offset = segment_offset;
349     return cues;
350 }
351
352 static int mkv_add_cuepoint(mkv_cues *cues, int stream, int64_t ts, int64_t cluster_pos)
353 {
354     mkv_cuepoint *entries = cues->entries;
355
356     entries = av_realloc(entries, (cues->num_entries + 1) * sizeof(mkv_cuepoint));
357     if (entries == NULL)
358         return AVERROR(ENOMEM);
359
360     if (ts < 0)
361         return 0;
362
363     entries[cues->num_entries  ].pts = ts;
364     entries[cues->num_entries  ].tracknum = stream + 1;
365     entries[cues->num_entries++].cluster_pos = cluster_pos - cues->segment_offset;
366
367     cues->entries = entries;
368     return 0;
369 }
370
371 static int64_t mkv_write_cues(ByteIOContext *pb, mkv_cues *cues, int num_tracks)
372 {
373     ebml_master cues_element;
374     int64_t currentpos;
375     int i, j;
376
377     currentpos = url_ftell(pb);
378     cues_element = start_ebml_master(pb, MATROSKA_ID_CUES, 0);
379
380     for (i = 0; i < cues->num_entries; i++) {
381         ebml_master cuepoint, track_positions;
382         mkv_cuepoint *entry = &cues->entries[i];
383         uint64_t pts = entry->pts;
384
385         cuepoint = start_ebml_master(pb, MATROSKA_ID_POINTENTRY, MAX_CUEPOINT_SIZE(num_tracks));
386         put_ebml_uint(pb, MATROSKA_ID_CUETIME, pts);
387
388         // put all the entries from different tracks that have the exact same
389         // timestamp into the same CuePoint
390         for (j = 0; j < cues->num_entries - i && entry[j].pts == pts; j++) {
391             track_positions = start_ebml_master(pb, MATROSKA_ID_CUETRACKPOSITION, MAX_CUETRACKPOS_SIZE);
392             put_ebml_uint(pb, MATROSKA_ID_CUETRACK          , entry[j].tracknum   );
393             put_ebml_uint(pb, MATROSKA_ID_CUECLUSTERPOSITION, entry[j].cluster_pos);
394             end_ebml_master(pb, track_positions);
395         }
396         i += j - 1;
397         end_ebml_master(pb, cuepoint);
398     }
399     end_ebml_master(pb, cues_element);
400
401     av_free(cues->entries);
402     av_free(cues);
403     return currentpos;
404 }
405
406 static int put_xiph_codecpriv(AVFormatContext *s, ByteIOContext *pb, AVCodecContext *codec)
407 {
408     uint8_t *header_start[3];
409     int header_len[3];
410     int first_header_size;
411     int j;
412
413     if (codec->codec_id == CODEC_ID_VORBIS)
414         first_header_size = 30;
415     else
416         first_header_size = 42;
417
418     if (ff_split_xiph_headers(codec->extradata, codec->extradata_size,
419                               first_header_size, header_start, header_len) < 0) {
420         av_log(s, AV_LOG_ERROR, "Extradata corrupt.\n");
421         return -1;
422     }
423
424     put_byte(pb, 2);                    // number packets - 1
425     for (j = 0; j < 2; j++) {
426         put_xiph_size(pb, header_len[j]);
427     }
428     for (j = 0; j < 3; j++)
429         put_buffer(pb, header_start[j], header_len[j]);
430
431     return 0;
432 }
433
434 static void get_aac_sample_rates(AVFormatContext *s, AVCodecContext *codec, int *sample_rate, int *output_sample_rate)
435 {
436     int sri;
437
438     if (codec->extradata_size < 2) {
439         av_log(s, AV_LOG_WARNING, "No AAC extradata, unable to determine samplerate.\n");
440         return;
441     }
442
443     sri = ((codec->extradata[0] << 1) & 0xE) | (codec->extradata[1] >> 7);
444     if (sri > 12) {
445         av_log(s, AV_LOG_WARNING, "AAC samplerate index out of bounds\n");
446         return;
447     }
448     *sample_rate = ff_mpeg4audio_sample_rates[sri];
449
450     // if sbr, get output sample rate as well
451     if (codec->extradata_size == 5) {
452         sri = (codec->extradata[4] >> 3) & 0xF;
453         if (sri > 12) {
454             av_log(s, AV_LOG_WARNING, "AAC output samplerate index out of bounds\n");
455             return;
456         }
457         *output_sample_rate = ff_mpeg4audio_sample_rates[sri];
458     }
459 }
460
461 static int mkv_write_codecprivate(AVFormatContext *s, ByteIOContext *pb, AVCodecContext *codec, int native_id, int qt_id)
462 {
463     ByteIOContext *dyn_cp;
464     uint8_t *codecpriv;
465     int ret, codecpriv_size;
466
467     ret = url_open_dyn_buf(&dyn_cp);
468     if(ret < 0)
469         return ret;
470
471     if (native_id) {
472         if (codec->codec_id == CODEC_ID_VORBIS || codec->codec_id == CODEC_ID_THEORA)
473             ret = put_xiph_codecpriv(s, dyn_cp, codec);
474         else if (codec->codec_id == CODEC_ID_FLAC)
475             ret = ff_flac_write_header(dyn_cp, codec, 1);
476         else if (codec->codec_id == CODEC_ID_H264)
477             ret = ff_isom_write_avcc(dyn_cp, codec->extradata, codec->extradata_size);
478         else if (codec->extradata_size)
479             put_buffer(dyn_cp, codec->extradata, codec->extradata_size);
480     } else if (codec->codec_type == AVMEDIA_TYPE_VIDEO) {
481         if (qt_id) {
482             if (!codec->codec_tag)
483                 codec->codec_tag = ff_codec_get_tag(codec_movvideo_tags, codec->codec_id);
484             if (codec->extradata_size)
485                 put_buffer(dyn_cp, codec->extradata, codec->extradata_size);
486         } else {
487             if (!codec->codec_tag)
488                 codec->codec_tag = ff_codec_get_tag(ff_codec_bmp_tags, codec->codec_id);
489             if (!codec->codec_tag) {
490                 av_log(s, AV_LOG_ERROR, "No bmp codec ID found.\n");
491                 ret = -1;
492             }
493
494             ff_put_bmp_header(dyn_cp, codec, ff_codec_bmp_tags, 0);
495         }
496
497     } else if (codec->codec_type == AVMEDIA_TYPE_AUDIO) {
498         unsigned int tag;
499         tag = ff_codec_get_tag(ff_codec_wav_tags, codec->codec_id);
500         if (!tag) {
501             av_log(s, AV_LOG_ERROR, "No wav codec ID found.\n");
502             ret = -1;
503         }
504         if (!codec->codec_tag)
505             codec->codec_tag = tag;
506
507         ff_put_wav_header(dyn_cp, codec);
508     }
509
510     codecpriv_size = url_close_dyn_buf(dyn_cp, &codecpriv);
511     if (codecpriv_size)
512         put_ebml_binary(pb, MATROSKA_ID_CODECPRIVATE, codecpriv, codecpriv_size);
513     av_free(codecpriv);
514     return ret;
515 }
516
517 static int mkv_write_tracks(AVFormatContext *s)
518 {
519     MatroskaMuxContext *mkv = s->priv_data;
520     ByteIOContext *pb = s->pb;
521     ebml_master tracks;
522     int i, j, ret;
523
524     ret = mkv_add_seekhead_entry(mkv->main_seekhead, MATROSKA_ID_TRACKS, url_ftell(pb));
525     if (ret < 0) return ret;
526
527     tracks = start_ebml_master(pb, MATROSKA_ID_TRACKS, 0);
528     for (i = 0; i < s->nb_streams; i++) {
529         AVStream *st = s->streams[i];
530         AVCodecContext *codec = st->codec;
531         ebml_master subinfo, track;
532         int native_id = 0;
533         int qt_id = 0;
534         int bit_depth = av_get_bits_per_sample(codec->codec_id);
535         int sample_rate = codec->sample_rate;
536         int output_sample_rate = 0;
537         AVMetadataTag *tag;
538
539         if (!bit_depth)
540             bit_depth = av_get_bits_per_sample_format(codec->sample_fmt);
541
542         if (codec->codec_id == CODEC_ID_AAC)
543             get_aac_sample_rates(s, codec, &sample_rate, &output_sample_rate);
544
545         track = start_ebml_master(pb, MATROSKA_ID_TRACKENTRY, 0);
546         put_ebml_uint (pb, MATROSKA_ID_TRACKNUMBER     , i + 1);
547         put_ebml_uint (pb, MATROSKA_ID_TRACKUID        , i + 1);
548         put_ebml_uint (pb, MATROSKA_ID_TRACKFLAGLACING , 0);    // no lacing (yet)
549
550         if ((tag = av_metadata_get(st->metadata, "title", NULL, 0)))
551             put_ebml_string(pb, MATROSKA_ID_TRACKNAME, tag->value);
552         tag = av_metadata_get(st->metadata, "language", NULL, 0);
553         put_ebml_string(pb, MATROSKA_ID_TRACKLANGUAGE, tag ? tag->value:"und");
554
555         if (st->disposition)
556             put_ebml_uint(pb, MATROSKA_ID_TRACKFLAGDEFAULT, !!(st->disposition & AV_DISPOSITION_DEFAULT));
557
558         // look for a codec ID string specific to mkv to use,
559         // if none are found, use AVI codes
560         for (j = 0; ff_mkv_codec_tags[j].id != CODEC_ID_NONE; j++) {
561             if (ff_mkv_codec_tags[j].id == codec->codec_id) {
562                 put_ebml_string(pb, MATROSKA_ID_CODECID, ff_mkv_codec_tags[j].str);
563                 native_id = 1;
564                 break;
565             }
566         }
567
568         switch (codec->codec_type) {
569             case AVMEDIA_TYPE_VIDEO:
570                 put_ebml_uint(pb, MATROSKA_ID_TRACKTYPE, MATROSKA_TRACK_TYPE_VIDEO);
571                 put_ebml_uint(pb, MATROSKA_ID_TRACKDEFAULTDURATION, av_q2d(codec->time_base)*1E9);
572
573                 if (!native_id &&
574                       ff_codec_get_tag(codec_movvideo_tags, codec->codec_id) &&
575                     (!ff_codec_get_tag(ff_codec_bmp_tags,   codec->codec_id)
576                      || codec->codec_id == CODEC_ID_SVQ1
577                      || codec->codec_id == CODEC_ID_SVQ3
578                      || codec->codec_id == CODEC_ID_CINEPAK))
579                     qt_id = 1;
580
581                 if (qt_id)
582                     put_ebml_string(pb, MATROSKA_ID_CODECID, "V_QUICKTIME");
583                 else if (!native_id) {
584                     // if there is no mkv-specific codec ID, use VFW mode
585                     put_ebml_string(pb, MATROSKA_ID_CODECID, "V_MS/VFW/FOURCC");
586                     mkv->tracks[i].write_dts = 1;
587                 }
588
589                 subinfo = start_ebml_master(pb, MATROSKA_ID_TRACKVIDEO, 0);
590                 // XXX: interlace flag?
591                 put_ebml_uint (pb, MATROSKA_ID_VIDEOPIXELWIDTH , codec->width);
592                 put_ebml_uint (pb, MATROSKA_ID_VIDEOPIXELHEIGHT, codec->height);
593                 if (st->sample_aspect_ratio.num) {
594                     int d_width = codec->width*av_q2d(st->sample_aspect_ratio);
595                     put_ebml_uint(pb, MATROSKA_ID_VIDEODISPLAYWIDTH , d_width);
596                     put_ebml_uint(pb, MATROSKA_ID_VIDEODISPLAYHEIGHT, codec->height);
597                 }
598                 end_ebml_master(pb, subinfo);
599                 break;
600
601             case AVMEDIA_TYPE_AUDIO:
602                 put_ebml_uint(pb, MATROSKA_ID_TRACKTYPE, MATROSKA_TRACK_TYPE_AUDIO);
603
604                 if (!native_id)
605                     // no mkv-specific ID, use ACM mode
606                     put_ebml_string(pb, MATROSKA_ID_CODECID, "A_MS/ACM");
607
608                 subinfo = start_ebml_master(pb, MATROSKA_ID_TRACKAUDIO, 0);
609                 put_ebml_uint  (pb, MATROSKA_ID_AUDIOCHANNELS    , codec->channels);
610                 put_ebml_float (pb, MATROSKA_ID_AUDIOSAMPLINGFREQ, sample_rate);
611                 if (output_sample_rate)
612                     put_ebml_float(pb, MATROSKA_ID_AUDIOOUTSAMPLINGFREQ, output_sample_rate);
613                 if (bit_depth)
614                     put_ebml_uint(pb, MATROSKA_ID_AUDIOBITDEPTH, bit_depth);
615                 end_ebml_master(pb, subinfo);
616                 break;
617
618             case AVMEDIA_TYPE_SUBTITLE:
619                 put_ebml_uint(pb, MATROSKA_ID_TRACKTYPE, MATROSKA_TRACK_TYPE_SUBTITLE);
620                 break;
621             default:
622                 av_log(s, AV_LOG_ERROR, "Only audio, video, and subtitles are supported for Matroska.");
623                 break;
624         }
625         ret = mkv_write_codecprivate(s, pb, codec, native_id, qt_id);
626         if (ret < 0) return ret;
627
628         end_ebml_master(pb, track);
629
630         // ms precision is the de-facto standard timescale for mkv files
631         av_set_pts_info(st, 64, 1, 1000);
632     }
633     end_ebml_master(pb, tracks);
634     return 0;
635 }
636
637 static int mkv_write_chapters(AVFormatContext *s)
638 {
639     MatroskaMuxContext *mkv = s->priv_data;
640     ByteIOContext *pb = s->pb;
641     ebml_master chapters, editionentry;
642     AVRational scale = {1, 1E9};
643     int i, ret;
644
645     if (!s->nb_chapters)
646         return 0;
647
648     ret = mkv_add_seekhead_entry(mkv->main_seekhead, MATROSKA_ID_CHAPTERS, url_ftell(pb));
649     if (ret < 0) return ret;
650
651     chapters     = start_ebml_master(pb, MATROSKA_ID_CHAPTERS    , 0);
652     editionentry = start_ebml_master(pb, MATROSKA_ID_EDITIONENTRY, 0);
653     put_ebml_uint(pb, MATROSKA_ID_EDITIONFLAGDEFAULT, 1);
654     put_ebml_uint(pb, MATROSKA_ID_EDITIONFLAGHIDDEN , 0);
655     for (i = 0; i < s->nb_chapters; i++) {
656         ebml_master chapteratom, chapterdisplay;
657         AVChapter *c     = s->chapters[i];
658         AVMetadataTag *t = NULL;
659
660         chapteratom = start_ebml_master(pb, MATROSKA_ID_CHAPTERATOM, 0);
661         put_ebml_uint(pb, MATROSKA_ID_CHAPTERUID, c->id);
662         put_ebml_uint(pb, MATROSKA_ID_CHAPTERTIMESTART,
663                       av_rescale_q(c->start, c->time_base, scale));
664         put_ebml_uint(pb, MATROSKA_ID_CHAPTERTIMEEND,
665                       av_rescale_q(c->end,   c->time_base, scale));
666         put_ebml_uint(pb, MATROSKA_ID_CHAPTERFLAGHIDDEN , 0);
667         put_ebml_uint(pb, MATROSKA_ID_CHAPTERFLAGENABLED, 1);
668         if ((t = av_metadata_get(c->metadata, "title", NULL, 0))) {
669             chapterdisplay = start_ebml_master(pb, MATROSKA_ID_CHAPTERDISPLAY, 0);
670             put_ebml_string(pb, MATROSKA_ID_CHAPSTRING, t->value);
671             put_ebml_string(pb, MATROSKA_ID_CHAPLANG  , "und");
672             end_ebml_master(pb, chapterdisplay);
673         }
674         end_ebml_master(pb, chapteratom);
675     }
676     end_ebml_master(pb, editionentry);
677     end_ebml_master(pb, chapters);
678     return 0;
679 }
680
681 static int mkv_write_header(AVFormatContext *s)
682 {
683     MatroskaMuxContext *mkv = s->priv_data;
684     ByteIOContext *pb = s->pb;
685     ebml_master ebml_header, segment_info;
686     AVMetadataTag *tag;
687     int ret;
688
689     mkv->md5_ctx = av_mallocz(av_md5_size);
690     av_md5_init(mkv->md5_ctx);
691     mkv->tracks = av_mallocz(s->nb_streams * sizeof(*mkv->tracks));
692
693     ebml_header = start_ebml_master(pb, EBML_ID_HEADER, 0);
694     put_ebml_uint   (pb, EBML_ID_EBMLVERSION        ,           1);
695     put_ebml_uint   (pb, EBML_ID_EBMLREADVERSION    ,           1);
696     put_ebml_uint   (pb, EBML_ID_EBMLMAXIDLENGTH    ,           4);
697     put_ebml_uint   (pb, EBML_ID_EBMLMAXSIZELENGTH  ,           8);
698     put_ebml_string (pb, EBML_ID_DOCTYPE            ,  "matroska");
699     put_ebml_uint   (pb, EBML_ID_DOCTYPEVERSION     ,           2);
700     put_ebml_uint   (pb, EBML_ID_DOCTYPEREADVERSION ,           2);
701     end_ebml_master(pb, ebml_header);
702
703     mkv->segment = start_ebml_master(pb, MATROSKA_ID_SEGMENT, 0);
704     mkv->segment_offset = url_ftell(pb);
705
706     // we write 2 seek heads - one at the end of the file to point to each
707     // cluster, and one at the beginning to point to all other level one
708     // elements (including the seek head at the end of the file), which
709     // isn't more than 10 elements if we only write one of each other
710     // currently defined level 1 element
711     mkv->main_seekhead    = mkv_start_seekhead(pb, mkv->segment_offset, 10);
712     mkv->cluster_seekhead = mkv_start_seekhead(pb, mkv->segment_offset, 0);
713     if (mkv->main_seekhead == NULL || mkv->cluster_seekhead == NULL)
714         return AVERROR(ENOMEM);
715
716     ret = mkv_add_seekhead_entry(mkv->main_seekhead, MATROSKA_ID_INFO, url_ftell(pb));
717     if (ret < 0) return ret;
718
719     segment_info = start_ebml_master(pb, MATROSKA_ID_INFO, 0);
720     put_ebml_uint(pb, MATROSKA_ID_TIMECODESCALE, 1000000);
721     if ((tag = av_metadata_get(s->metadata, "title", NULL, 0)))
722         put_ebml_string(pb, MATROSKA_ID_TITLE, tag->value);
723     if (!(s->streams[0]->codec->flags & CODEC_FLAG_BITEXACT)) {
724         put_ebml_string(pb, MATROSKA_ID_MUXINGAPP , LIBAVFORMAT_IDENT);
725         put_ebml_string(pb, MATROSKA_ID_WRITINGAPP, LIBAVFORMAT_IDENT);
726
727         // reserve space to write the segment UID later
728         mkv->segment_uid = url_ftell(pb);
729         put_ebml_void(pb, 19);
730     }
731
732     // reserve space for the duration
733     mkv->duration = 0;
734     mkv->duration_offset = url_ftell(pb);
735     put_ebml_void(pb, 11);                  // assumes double-precision float to be written
736     end_ebml_master(pb, segment_info);
737
738     ret = mkv_write_tracks(s);
739     if (ret < 0) return ret;
740
741     ret = mkv_write_chapters(s);
742     if (ret < 0) return ret;
743
744     if (url_is_streamed(s->pb))
745         mkv_write_seekhead(pb, mkv->main_seekhead);
746
747     mkv->cues = mkv_start_cues(mkv->segment_offset);
748     if (mkv->cues == NULL)
749         return AVERROR(ENOMEM);
750
751     av_init_packet(&mkv->cur_audio_pkt);
752     mkv->cur_audio_pkt.size = 0;
753     mkv->audio_buffer_size  = 0;
754
755     put_flush_packet(pb);
756     return 0;
757 }
758
759 static int mkv_blockgroup_size(int pkt_size)
760 {
761     int size = pkt_size + 4;
762     size += ebml_num_size(size);
763     size += 2;              // EBML ID for block and block duration
764     size += 8;              // max size of block duration
765     size += ebml_num_size(size);
766     size += 1;              // blockgroup EBML ID
767     return size;
768 }
769
770 static int ass_get_duration(const uint8_t *p)
771 {
772     int sh, sm, ss, sc, eh, em, es, ec;
773     uint64_t start, end;
774
775     if (sscanf(p, "%*[^,],%d:%d:%d%*c%d,%d:%d:%d%*c%d",
776                &sh, &sm, &ss, &sc, &eh, &em, &es, &ec) != 8)
777         return 0;
778     start = 3600000*sh + 60000*sm + 1000*ss + 10*sc;
779     end   = 3600000*eh + 60000*em + 1000*es + 10*ec;
780     return end - start;
781 }
782
783 static int mkv_write_ass_blocks(AVFormatContext *s, ByteIOContext *pb, AVPacket *pkt)
784 {
785     MatroskaMuxContext *mkv = s->priv_data;
786     int i, layer = 0, max_duration = 0, size, line_size, data_size = pkt->size;
787     uint8_t *start, *end, *data = pkt->data;
788     ebml_master blockgroup;
789     char buffer[2048];
790
791     while (data_size) {
792         int duration = ass_get_duration(data);
793         max_duration = FFMAX(duration, max_duration);
794         end = memchr(data, '\n', data_size);
795         size = line_size = end ? end-data+1 : data_size;
796         size -= end ? (end[-1]=='\r')+1 : 0;
797         start = data;
798         for (i=0; i<3; i++, start++)
799             if (!(start = memchr(start, ',', size-(start-data))))
800                 return max_duration;
801         size -= start - data;
802         sscanf(data, "Dialogue: %d,", &layer);
803         i = snprintf(buffer, sizeof(buffer), "%"PRId64",%d,",
804                      s->streams[pkt->stream_index]->nb_frames++, layer);
805         size = FFMIN(i+size, sizeof(buffer));
806         memcpy(buffer+i, start, size-i);
807
808         av_log(s, AV_LOG_DEBUG, "Writing block at offset %" PRIu64 ", size %d, "
809                "pts %" PRId64 ", duration %d\n",
810                url_ftell(pb), size, pkt->pts, duration);
811         blockgroup = start_ebml_master(pb, MATROSKA_ID_BLOCKGROUP, mkv_blockgroup_size(size));
812         put_ebml_id(pb, MATROSKA_ID_BLOCK);
813         put_ebml_num(pb, size+4, 0);
814         put_byte(pb, 0x80 | (pkt->stream_index + 1));     // this assumes stream_index is less than 126
815         put_be16(pb, pkt->pts - mkv->cluster_pts);
816         put_byte(pb, 0);
817         put_buffer(pb, buffer, size);
818         put_ebml_uint(pb, MATROSKA_ID_BLOCKDURATION, duration);
819         end_ebml_master(pb, blockgroup);
820
821         data += line_size;
822         data_size -= line_size;
823     }
824
825     return max_duration;
826 }
827
828 static void mkv_write_block(AVFormatContext *s, ByteIOContext *pb,
829                             unsigned int blockid, AVPacket *pkt, int flags)
830 {
831     MatroskaMuxContext *mkv = s->priv_data;
832     AVCodecContext *codec = s->streams[pkt->stream_index]->codec;
833     uint8_t *data = NULL;
834     int size = pkt->size;
835     int64_t ts = mkv->tracks[pkt->stream_index].write_dts ? pkt->dts : pkt->pts;
836
837     av_log(s, AV_LOG_DEBUG, "Writing block at offset %" PRIu64 ", size %d, "
838            "pts %" PRId64 ", dts %" PRId64 ", duration %d, flags %d\n",
839            url_ftell(pb), pkt->size, pkt->pts, pkt->dts, pkt->duration, flags);
840     if (codec->codec_id == CODEC_ID_H264 && codec->extradata_size > 0 &&
841         (AV_RB24(codec->extradata) == 1 || AV_RB32(codec->extradata) == 1))
842         ff_avc_parse_nal_units_buf(pkt->data, &data, &size);
843     else
844         data = pkt->data;
845     put_ebml_id(pb, blockid);
846     put_ebml_num(pb, size+4, 0);
847     put_byte(pb, 0x80 | (pkt->stream_index + 1));     // this assumes stream_index is less than 126
848     put_be16(pb, ts - mkv->cluster_pts);
849     put_byte(pb, flags);
850     put_buffer(pb, data, size);
851     if (data != pkt->data)
852         av_free(data);
853 }
854
855 static void mkv_flush_dynbuf(AVFormatContext *s)
856 {
857     MatroskaMuxContext *mkv = s->priv_data;
858     int bufsize;
859     uint8_t *dyn_buf;
860
861     if (!mkv->dyn_bc)
862         return;
863
864     bufsize = url_close_dyn_buf(mkv->dyn_bc, &dyn_buf);
865     put_buffer(s->pb, dyn_buf, bufsize);
866     av_free(dyn_buf);
867     mkv->dyn_bc = NULL;
868 }
869
870 static int mkv_write_packet_internal(AVFormatContext *s, AVPacket *pkt)
871 {
872     MatroskaMuxContext *mkv = s->priv_data;
873     ByteIOContext *pb = s->pb;
874     AVCodecContext *codec = s->streams[pkt->stream_index]->codec;
875     int keyframe = !!(pkt->flags & AV_PKT_FLAG_KEY);
876     int duration = pkt->duration;
877     int ret;
878     int64_t ts = mkv->tracks[pkt->stream_index].write_dts ? pkt->dts : pkt->pts;
879
880     if (ts == AV_NOPTS_VALUE) {
881         av_log(s, AV_LOG_ERROR, "Can't write packet with unknown timestamp\n");
882         return AVERROR(EINVAL);
883     }
884
885     if (url_is_streamed(s->pb)) {
886         if (!mkv->dyn_bc)
887             url_open_dyn_buf(&mkv->dyn_bc);
888         pb = mkv->dyn_bc;
889     }
890
891     if (!mkv->cluster_pos) {
892         ret = mkv_add_seekhead_entry(mkv->cluster_seekhead, MATROSKA_ID_CLUSTER, url_ftell(pb));
893         if (ret < 0) return ret;
894
895         mkv->cluster_pos = url_ftell(s->pb);
896         mkv->cluster = start_ebml_master(pb, MATROSKA_ID_CLUSTER, 0);
897         put_ebml_uint(pb, MATROSKA_ID_CLUSTERTIMECODE, FFMAX(0, ts));
898         mkv->cluster_pts = FFMAX(0, ts);
899         av_md5_update(mkv->md5_ctx, pkt->data, FFMIN(200, pkt->size));
900     }
901
902     if (codec->codec_type != AVMEDIA_TYPE_SUBTITLE) {
903         mkv_write_block(s, pb, MATROSKA_ID_SIMPLEBLOCK, pkt, keyframe << 7);
904     } else if (codec->codec_id == CODEC_ID_SSA) {
905         duration = mkv_write_ass_blocks(s, pb, pkt);
906     } else {
907         ebml_master blockgroup = start_ebml_master(pb, MATROSKA_ID_BLOCKGROUP, mkv_blockgroup_size(pkt->size));
908         duration = pkt->convergence_duration;
909         mkv_write_block(s, pb, MATROSKA_ID_BLOCK, pkt, 0);
910         put_ebml_uint(pb, MATROSKA_ID_BLOCKDURATION, duration);
911         end_ebml_master(pb, blockgroup);
912     }
913
914     if (codec->codec_type == AVMEDIA_TYPE_VIDEO && keyframe) {
915         ret = mkv_add_cuepoint(mkv->cues, pkt->stream_index, ts, mkv->cluster_pos);
916         if (ret < 0) return ret;
917     }
918
919     mkv->duration = FFMAX(mkv->duration, ts + duration);
920     return 0;
921 }
922
923 static int mkv_copy_packet(MatroskaMuxContext *mkv, const AVPacket *pkt)
924 {
925     uint8_t *data           = mkv->cur_audio_pkt.data;
926     mkv->cur_audio_pkt      = *pkt;
927     mkv->cur_audio_pkt.data = av_fast_realloc(data, &mkv->audio_buffer_size, pkt->size);
928     if (!mkv->cur_audio_pkt.data)
929         return AVERROR(ENOMEM);
930
931     memcpy(mkv->cur_audio_pkt.data, pkt->data, pkt->size);
932     mkv->cur_audio_pkt.size = pkt->size;
933     return 0;
934 }
935
936 static int mkv_write_packet(AVFormatContext *s, AVPacket *pkt)
937 {
938     MatroskaMuxContext *mkv = s->priv_data;
939     ByteIOContext *pb = url_is_streamed(s->pb) ? mkv->dyn_bc : s->pb;
940     AVCodecContext *codec = s->streams[pkt->stream_index]->codec;
941     int ret, keyframe = !!(pkt->flags & AV_PKT_FLAG_KEY);
942     int64_t ts = mkv->tracks[pkt->stream_index].write_dts ? pkt->dts : pkt->pts;
943     int cluster_size = url_ftell(pb) - (url_is_streamed(s->pb) ? 0 : mkv->cluster_pos);
944
945     // start a new cluster every 5 MB or 5 sec, or 32k / 1 sec for streaming or
946     // after 4k and on a keyframe
947     if (mkv->cluster_pos &&
948         ((url_is_streamed(s->pb) && (cluster_size > 32*1024 || ts > mkv->cluster_pts + 1000))
949          ||                      cluster_size > 5*1024*1024 || ts > mkv->cluster_pts + 5000
950          || (codec->codec_type == AVMEDIA_TYPE_VIDEO && keyframe && cluster_size > 4*1024))) {
951         av_log(s, AV_LOG_DEBUG, "Starting new cluster at offset %" PRIu64
952                " bytes, pts %" PRIu64 "\n", url_ftell(pb), ts);
953         end_ebml_master(pb, mkv->cluster);
954         mkv->cluster_pos = 0;
955         if (mkv->dyn_bc)
956             mkv_flush_dynbuf(s);
957     }
958
959     // check if we have an audio packet cached
960     if (mkv->cur_audio_pkt.size > 0) {
961         ret = mkv_write_packet_internal(s, &mkv->cur_audio_pkt);
962         mkv->cur_audio_pkt.size = 0;
963         if (ret < 0) {
964             av_log(s, AV_LOG_ERROR, "Could not write cached audio packet ret:%d\n", ret);
965             return ret;
966         }
967     }
968
969     // buffer an audio packet to ensure the packet containing the video
970     // keyframe's timecode is contained in the same cluster for WebM
971     if (codec->codec_type == AVMEDIA_TYPE_AUDIO)
972         ret = mkv_copy_packet(mkv, pkt);
973     else
974         ret = mkv_write_packet_internal(s, pkt);
975     return ret;
976 }
977
978 static int mkv_write_trailer(AVFormatContext *s)
979 {
980     MatroskaMuxContext *mkv = s->priv_data;
981     ByteIOContext *pb = s->pb;
982     int64_t currentpos, second_seekhead, cuespos;
983     int ret;
984
985     // check if we have an audio packet cached
986     if (mkv->cur_audio_pkt.size > 0) {
987         ret = mkv_write_packet_internal(s, &mkv->cur_audio_pkt);
988         mkv->cur_audio_pkt.size = 0;
989         if (ret < 0) {
990             av_log(s, AV_LOG_ERROR, "Could not write cached audio packet ret:%d\n", ret);
991             return ret;
992         }
993     }
994
995     if (mkv->dyn_bc) {
996         end_ebml_master(mkv->dyn_bc, mkv->cluster);
997         mkv_flush_dynbuf(s);
998     } else if (mkv->cluster_pos) {
999         end_ebml_master(pb, mkv->cluster);
1000     }
1001
1002     if (!url_is_streamed(pb)) {
1003         cuespos = mkv_write_cues(pb, mkv->cues, s->nb_streams);
1004         second_seekhead = mkv_write_seekhead(pb, mkv->cluster_seekhead);
1005
1006         ret = mkv_add_seekhead_entry(mkv->main_seekhead, MATROSKA_ID_CUES    , cuespos);
1007         if (ret < 0) return ret;
1008         if (second_seekhead >= 0) {
1009             ret = mkv_add_seekhead_entry(mkv->main_seekhead, MATROSKA_ID_SEEKHEAD, second_seekhead);
1010             if (ret < 0) return ret;
1011         }
1012         mkv_write_seekhead(pb, mkv->main_seekhead);
1013
1014         // update the duration
1015         av_log(s, AV_LOG_DEBUG, "end duration = %" PRIu64 "\n", mkv->duration);
1016         currentpos = url_ftell(pb);
1017         url_fseek(pb, mkv->duration_offset, SEEK_SET);
1018         put_ebml_float(pb, MATROSKA_ID_DURATION, mkv->duration);
1019
1020         // write the md5sum of some frames as the segment UID
1021         if (!(s->streams[0]->codec->flags & CODEC_FLAG_BITEXACT)) {
1022             uint8_t segment_uid[16];
1023             av_md5_final(mkv->md5_ctx, segment_uid);
1024             url_fseek(pb, mkv->segment_uid, SEEK_SET);
1025             put_ebml_binary(pb, MATROSKA_ID_SEGMENTUID, segment_uid, 16);
1026         }
1027         url_fseek(pb, currentpos, SEEK_SET);
1028     }
1029
1030     end_ebml_master(pb, mkv->segment);
1031     av_free(mkv->md5_ctx);
1032     av_free(mkv->tracks);
1033     av_destruct_packet(&mkv->cur_audio_pkt);
1034     put_flush_packet(pb);
1035     return 0;
1036 }
1037
1038 AVOutputFormat matroska_muxer = {
1039     "matroska",
1040     NULL_IF_CONFIG_SMALL("Matroska file format"),
1041     "video/x-matroska",
1042     "mkv",
1043     sizeof(MatroskaMuxContext),
1044     CODEC_ID_MP2,
1045     CODEC_ID_MPEG4,
1046     mkv_write_header,
1047     mkv_write_packet,
1048     mkv_write_trailer,
1049     .flags = AVFMT_GLOBALHEADER | AVFMT_VARIABLE_FPS,
1050     .codec_tag = (const AVCodecTag* const []){ff_codec_bmp_tags, ff_codec_wav_tags, 0},
1051     .subtitle_codec = CODEC_ID_TEXT,
1052 };
1053
1054 AVOutputFormat matroska_audio_muxer = {
1055     "matroska",
1056     NULL_IF_CONFIG_SMALL("Matroska file format"),
1057     "audio/x-matroska",
1058     "mka",
1059     sizeof(MatroskaMuxContext),
1060     CODEC_ID_MP2,
1061     CODEC_ID_NONE,
1062     mkv_write_header,
1063     mkv_write_packet,
1064     mkv_write_trailer,
1065     .flags = AVFMT_GLOBALHEADER,
1066     .codec_tag = (const AVCodecTag* const []){ff_codec_wav_tags, 0},
1067 };