3 * Copyright (c) 2007 David Conrad
5 * This file is part of Libav.
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.
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.
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
28 #include "avlanguage.h"
29 #include "libavutil/samplefmt.h"
30 #include "libavutil/intreadwrite.h"
31 #include "libavutil/intfloat_readwrite.h"
32 #include "libavutil/random_seed.h"
33 #include "libavutil/lfg.h"
34 #include "libavutil/dict.h"
35 #include "libavcodec/xiph.h"
36 #include "libavcodec/mpeg4audio.h"
39 typedef struct ebml_master {
40 int64_t pos; ///< absolute offset in the file where the master's elements start
41 int sizebytes; ///< how many bytes were reserved for the size
44 typedef struct mkv_seekhead_entry {
45 unsigned int elementid;
49 typedef struct mkv_seekhead {
51 int64_t segment_offset; ///< the file offset to the beginning of the segment
52 int reserved_size; ///< -1 if appending to file
54 mkv_seekhead_entry *entries;
61 int64_t cluster_pos; ///< file offset of the cluster containing the block
65 int64_t segment_offset;
66 mkv_cuepoint *entries;
74 #define MODE_MATROSKAv2 0x01
75 #define MODE_WEBM 0x02
77 typedef struct MatroskaMuxContext {
81 int64_t segment_offset;
83 int64_t cluster_pos; ///< file offset of the current cluster
85 int64_t duration_offset;
87 mkv_seekhead *main_seekhead;
91 unsigned int audio_buffer_size;
92 AVPacket cur_audio_pkt;
96 /** 2 bytes * 3 for EBML IDs, 3 1-byte EBML lengths, 8 bytes for 64 bit
97 * offset, 4 bytes for target EBML ID */
98 #define MAX_SEEKENTRY_SIZE 21
100 /** per-cuepoint-track - 3 1-byte EBML IDs, 3 1-byte EBML sizes, 2
102 #define MAX_CUETRACKPOS_SIZE 22
104 /** per-cuepoint - 2 1-byte EBML IDs, 2 1-byte EBML sizes, 8-byte uint max */
105 #define MAX_CUEPOINT_SIZE(num_tracks) 12 + MAX_CUETRACKPOS_SIZE*num_tracks
108 static int ebml_id_size(unsigned int id)
110 return (av_log2(id+1)-1)/7+1;
113 static void put_ebml_id(AVIOContext *pb, unsigned int id)
115 int i = ebml_id_size(id);
117 avio_w8(pb, id >> (i*8));
121 * Write an EBML size meaning "unknown size".
123 * @param bytes The number of bytes the size should occupy (maximum: 8).
125 static void put_ebml_size_unknown(AVIOContext *pb, int bytes)
128 avio_w8(pb, 0x1ff >> bytes);
134 * Calculate how many bytes are needed to represent a given number in EBML.
136 static int ebml_num_size(uint64_t num)
139 while ((num+1) >> bytes*7) bytes++;
144 * Write a number in EBML variable length format.
146 * @param bytes The number of bytes that need to be used to write the number.
147 * If zero, any number of bytes can be used.
149 static void put_ebml_num(AVIOContext *pb, uint64_t num, int bytes)
151 int i, needed_bytes = ebml_num_size(num);
153 // sizes larger than this are currently undefined in EBML
154 assert(num < (1ULL<<56)-1);
157 // don't care how many bytes are used, so use the min
158 bytes = needed_bytes;
159 // the bytes needed to write the given size would exceed the bytes
160 // that we need to use, so write unknown size. This shouldn't happen.
161 assert(bytes >= needed_bytes);
163 num |= 1ULL << bytes*7;
164 for (i = bytes - 1; i >= 0; i--)
165 avio_w8(pb, num >> i*8);
168 static void put_ebml_uint(AVIOContext *pb, unsigned int elementid, uint64_t val)
172 while (tmp>>=8) bytes++;
174 put_ebml_id(pb, elementid);
175 put_ebml_num(pb, bytes, 0);
176 for (i = bytes - 1; i >= 0; i--)
177 avio_w8(pb, val >> i*8);
180 static void put_ebml_float(AVIOContext *pb, unsigned int elementid, double val)
182 put_ebml_id(pb, elementid);
183 put_ebml_num(pb, 8, 0);
184 avio_wb64(pb, av_dbl2int(val));
187 static void put_ebml_binary(AVIOContext *pb, unsigned int elementid,
188 const void *buf, int size)
190 put_ebml_id(pb, elementid);
191 put_ebml_num(pb, size, 0);
192 avio_write(pb, buf, size);
195 static void put_ebml_string(AVIOContext *pb, unsigned int elementid, const char *str)
197 put_ebml_binary(pb, elementid, str, strlen(str));
201 * Write a void element of a given size. Useful for reserving space in
202 * the file to be written to later.
204 * @param size The number of bytes to reserve, which must be at least 2.
206 static void put_ebml_void(AVIOContext *pb, uint64_t size)
208 int64_t currentpos = avio_tell(pb);
212 put_ebml_id(pb, EBML_ID_VOID);
213 // we need to subtract the length needed to store the size from the
214 // size we need to reserve so 2 cases, we use 8 bytes to store the
215 // size if possible, 1 byte otherwise
217 put_ebml_num(pb, size-1, 0);
219 put_ebml_num(pb, size-9, 8);
220 while(avio_tell(pb) < currentpos + size)
224 static ebml_master start_ebml_master(AVIOContext *pb, unsigned int elementid, uint64_t expectedsize)
226 int bytes = expectedsize ? ebml_num_size(expectedsize) : 8;
227 put_ebml_id(pb, elementid);
228 put_ebml_size_unknown(pb, bytes);
229 return (ebml_master){ avio_tell(pb), bytes };
232 static void end_ebml_master(AVIOContext *pb, ebml_master master)
234 int64_t pos = avio_tell(pb);
236 if (avio_seek(pb, master.pos - master.sizebytes, SEEK_SET) < 0)
238 put_ebml_num(pb, pos - master.pos, master.sizebytes);
239 avio_seek(pb, pos, SEEK_SET);
242 static void put_xiph_size(AVIOContext *pb, int size)
245 for (i = 0; i < size / 255; i++)
247 avio_w8(pb, size % 255);
251 * Initialize a mkv_seekhead element to be ready to index level 1 Matroska
252 * elements. If a maximum number of elements is specified, enough space
253 * will be reserved at the current file location to write a seek head of
256 * @param segment_offset The absolute offset to the position in the file
257 * where the segment begins.
258 * @param numelements The maximum number of elements that will be indexed
259 * by this seek head, 0 if unlimited.
261 static mkv_seekhead * mkv_start_seekhead(AVIOContext *pb, int64_t segment_offset, int numelements)
263 mkv_seekhead *new_seekhead = av_mallocz(sizeof(mkv_seekhead));
264 if (new_seekhead == NULL)
267 new_seekhead->segment_offset = segment_offset;
269 if (numelements > 0) {
270 new_seekhead->filepos = avio_tell(pb);
271 // 21 bytes max for a seek entry, 10 bytes max for the SeekHead ID
272 // and size, and 3 bytes to guarantee that an EBML void element
273 // will fit afterwards
274 new_seekhead->reserved_size = numelements * MAX_SEEKENTRY_SIZE + 13;
275 new_seekhead->max_entries = numelements;
276 put_ebml_void(pb, new_seekhead->reserved_size);
281 static int mkv_add_seekhead_entry(mkv_seekhead *seekhead, unsigned int elementid, uint64_t filepos)
283 mkv_seekhead_entry *entries = seekhead->entries;
285 // don't store more elements than we reserved space for
286 if (seekhead->max_entries > 0 && seekhead->max_entries <= seekhead->num_entries)
289 entries = av_realloc(entries, (seekhead->num_entries + 1) * sizeof(mkv_seekhead_entry));
291 return AVERROR(ENOMEM);
293 entries[seekhead->num_entries ].elementid = elementid;
294 entries[seekhead->num_entries++].segmentpos = filepos - seekhead->segment_offset;
296 seekhead->entries = entries;
301 * Write the seek head to the file and free it. If a maximum number of
302 * elements was specified to mkv_start_seekhead(), the seek head will
303 * be written at the location reserved for it. Otherwise, it is written
304 * at the current location in the file.
306 * @return The file offset where the seekhead was written,
307 * -1 if an error occurred.
309 static int64_t mkv_write_seekhead(AVIOContext *pb, mkv_seekhead *seekhead)
311 ebml_master metaseek, seekentry;
315 currentpos = avio_tell(pb);
317 if (seekhead->reserved_size > 0)
318 if (avio_seek(pb, seekhead->filepos, SEEK_SET) < 0)
321 metaseek = start_ebml_master(pb, MATROSKA_ID_SEEKHEAD, seekhead->reserved_size);
322 for (i = 0; i < seekhead->num_entries; i++) {
323 mkv_seekhead_entry *entry = &seekhead->entries[i];
325 seekentry = start_ebml_master(pb, MATROSKA_ID_SEEKENTRY, MAX_SEEKENTRY_SIZE);
327 put_ebml_id(pb, MATROSKA_ID_SEEKID);
328 put_ebml_num(pb, ebml_id_size(entry->elementid), 0);
329 put_ebml_id(pb, entry->elementid);
331 put_ebml_uint(pb, MATROSKA_ID_SEEKPOSITION, entry->segmentpos);
332 end_ebml_master(pb, seekentry);
334 end_ebml_master(pb, metaseek);
336 if (seekhead->reserved_size > 0) {
337 uint64_t remaining = seekhead->filepos + seekhead->reserved_size - avio_tell(pb);
338 put_ebml_void(pb, remaining);
339 avio_seek(pb, currentpos, SEEK_SET);
341 currentpos = seekhead->filepos;
343 av_free(seekhead->entries);
349 static mkv_cues * mkv_start_cues(int64_t segment_offset)
351 mkv_cues *cues = av_mallocz(sizeof(mkv_cues));
355 cues->segment_offset = segment_offset;
359 static int mkv_add_cuepoint(mkv_cues *cues, int stream, int64_t ts, int64_t cluster_pos)
361 mkv_cuepoint *entries = cues->entries;
363 entries = av_realloc(entries, (cues->num_entries + 1) * sizeof(mkv_cuepoint));
365 return AVERROR(ENOMEM);
370 entries[cues->num_entries ].pts = ts;
371 entries[cues->num_entries ].tracknum = stream + 1;
372 entries[cues->num_entries++].cluster_pos = cluster_pos - cues->segment_offset;
374 cues->entries = entries;
378 static int64_t mkv_write_cues(AVIOContext *pb, mkv_cues *cues, int num_tracks)
380 ebml_master cues_element;
384 currentpos = avio_tell(pb);
385 cues_element = start_ebml_master(pb, MATROSKA_ID_CUES, 0);
387 for (i = 0; i < cues->num_entries; i++) {
388 ebml_master cuepoint, track_positions;
389 mkv_cuepoint *entry = &cues->entries[i];
390 uint64_t pts = entry->pts;
392 cuepoint = start_ebml_master(pb, MATROSKA_ID_POINTENTRY, MAX_CUEPOINT_SIZE(num_tracks));
393 put_ebml_uint(pb, MATROSKA_ID_CUETIME, pts);
395 // put all the entries from different tracks that have the exact same
396 // timestamp into the same CuePoint
397 for (j = 0; j < cues->num_entries - i && entry[j].pts == pts; j++) {
398 track_positions = start_ebml_master(pb, MATROSKA_ID_CUETRACKPOSITION, MAX_CUETRACKPOS_SIZE);
399 put_ebml_uint(pb, MATROSKA_ID_CUETRACK , entry[j].tracknum );
400 put_ebml_uint(pb, MATROSKA_ID_CUECLUSTERPOSITION, entry[j].cluster_pos);
401 end_ebml_master(pb, track_positions);
404 end_ebml_master(pb, cuepoint);
406 end_ebml_master(pb, cues_element);
411 static int put_xiph_codecpriv(AVFormatContext *s, AVIOContext *pb, AVCodecContext *codec)
413 uint8_t *header_start[3];
415 int first_header_size;
418 if (codec->codec_id == CODEC_ID_VORBIS)
419 first_header_size = 30;
421 first_header_size = 42;
423 if (ff_split_xiph_headers(codec->extradata, codec->extradata_size,
424 first_header_size, header_start, header_len) < 0) {
425 av_log(s, AV_LOG_ERROR, "Extradata corrupt.\n");
429 avio_w8(pb, 2); // number packets - 1
430 for (j = 0; j < 2; j++) {
431 put_xiph_size(pb, header_len[j]);
433 for (j = 0; j < 3; j++)
434 avio_write(pb, header_start[j], header_len[j]);
439 static void get_aac_sample_rates(AVFormatContext *s, AVCodecContext *codec, int *sample_rate, int *output_sample_rate)
441 MPEG4AudioConfig mp4ac;
443 if (ff_mpeg4audio_get_config(&mp4ac, codec->extradata, codec->extradata_size) < 0) {
444 av_log(s, AV_LOG_WARNING, "Error parsing AAC extradata, unable to determine samplerate.\n");
448 *sample_rate = mp4ac.sample_rate;
449 *output_sample_rate = mp4ac.ext_sample_rate;
452 static int mkv_write_codecprivate(AVFormatContext *s, AVIOContext *pb, AVCodecContext *codec, int native_id, int qt_id)
456 int ret, codecpriv_size;
458 ret = avio_open_dyn_buf(&dyn_cp);
463 if (codec->codec_id == CODEC_ID_VORBIS || codec->codec_id == CODEC_ID_THEORA)
464 ret = put_xiph_codecpriv(s, dyn_cp, codec);
465 else if (codec->codec_id == CODEC_ID_FLAC)
466 ret = ff_flac_write_header(dyn_cp, codec, 1);
467 else if (codec->codec_id == CODEC_ID_H264)
468 ret = ff_isom_write_avcc(dyn_cp, codec->extradata, codec->extradata_size);
469 else if (codec->extradata_size)
470 avio_write(dyn_cp, codec->extradata, codec->extradata_size);
471 } else if (codec->codec_type == AVMEDIA_TYPE_VIDEO) {
473 if (!codec->codec_tag)
474 codec->codec_tag = ff_codec_get_tag(codec_movvideo_tags, codec->codec_id);
475 if (codec->extradata_size)
476 avio_write(dyn_cp, codec->extradata, codec->extradata_size);
478 if (!codec->codec_tag)
479 codec->codec_tag = ff_codec_get_tag(ff_codec_bmp_tags, codec->codec_id);
480 if (!codec->codec_tag) {
481 av_log(s, AV_LOG_ERROR, "No bmp codec ID found.\n");
485 ff_put_bmp_header(dyn_cp, codec, ff_codec_bmp_tags, 0);
488 } else if (codec->codec_type == AVMEDIA_TYPE_AUDIO) {
490 tag = ff_codec_get_tag(ff_codec_wav_tags, codec->codec_id);
492 av_log(s, AV_LOG_ERROR, "No wav codec ID found.\n");
495 if (!codec->codec_tag)
496 codec->codec_tag = tag;
498 ff_put_wav_header(dyn_cp, codec);
501 codecpriv_size = avio_close_dyn_buf(dyn_cp, &codecpriv);
503 put_ebml_binary(pb, MATROSKA_ID_CODECPRIVATE, codecpriv, codecpriv_size);
508 static int mkv_write_tracks(AVFormatContext *s)
510 MatroskaMuxContext *mkv = s->priv_data;
511 AVIOContext *pb = s->pb;
515 ret = mkv_add_seekhead_entry(mkv->main_seekhead, MATROSKA_ID_TRACKS, avio_tell(pb));
516 if (ret < 0) return ret;
518 tracks = start_ebml_master(pb, MATROSKA_ID_TRACKS, 0);
519 for (i = 0; i < s->nb_streams; i++) {
520 AVStream *st = s->streams[i];
521 AVCodecContext *codec = st->codec;
522 ebml_master subinfo, track;
525 int bit_depth = av_get_bits_per_sample(codec->codec_id);
526 int sample_rate = codec->sample_rate;
527 int output_sample_rate = 0;
528 AVDictionaryEntry *tag;
531 bit_depth = av_get_bytes_per_sample(codec->sample_fmt) << 3;
533 if (codec->codec_id == CODEC_ID_AAC)
534 get_aac_sample_rates(s, codec, &sample_rate, &output_sample_rate);
536 track = start_ebml_master(pb, MATROSKA_ID_TRACKENTRY, 0);
537 put_ebml_uint (pb, MATROSKA_ID_TRACKNUMBER , i + 1);
538 put_ebml_uint (pb, MATROSKA_ID_TRACKUID , i + 1);
539 put_ebml_uint (pb, MATROSKA_ID_TRACKFLAGLACING , 0); // no lacing (yet)
541 if ((tag = av_dict_get(st->metadata, "title", NULL, 0)))
542 put_ebml_string(pb, MATROSKA_ID_TRACKNAME, tag->value);
543 tag = av_dict_get(st->metadata, "language", NULL, 0);
544 put_ebml_string(pb, MATROSKA_ID_TRACKLANGUAGE, tag ? tag->value:"und");
547 put_ebml_uint(pb, MATROSKA_ID_TRACKFLAGDEFAULT, !!(st->disposition & AV_DISPOSITION_DEFAULT));
549 // look for a codec ID string specific to mkv to use,
550 // if none are found, use AVI codes
551 for (j = 0; ff_mkv_codec_tags[j].id != CODEC_ID_NONE; j++) {
552 if (ff_mkv_codec_tags[j].id == codec->codec_id) {
553 put_ebml_string(pb, MATROSKA_ID_CODECID, ff_mkv_codec_tags[j].str);
559 if (mkv->mode == MODE_WEBM && !(codec->codec_id == CODEC_ID_VP8 ||
560 codec->codec_id == CODEC_ID_VORBIS)) {
561 av_log(s, AV_LOG_ERROR,
562 "Only VP8 video and Vorbis audio are supported for WebM.\n");
563 return AVERROR(EINVAL);
566 switch (codec->codec_type) {
567 case AVMEDIA_TYPE_VIDEO:
568 put_ebml_uint(pb, MATROSKA_ID_TRACKTYPE, MATROSKA_TRACK_TYPE_VIDEO);
569 put_ebml_uint(pb, MATROSKA_ID_TRACKDEFAULTDURATION, av_q2d(codec->time_base)*1E9);
572 ff_codec_get_tag(codec_movvideo_tags, codec->codec_id) &&
573 (!ff_codec_get_tag(ff_codec_bmp_tags, codec->codec_id)
574 || codec->codec_id == CODEC_ID_SVQ1
575 || codec->codec_id == CODEC_ID_SVQ3
576 || codec->codec_id == CODEC_ID_CINEPAK))
580 put_ebml_string(pb, MATROSKA_ID_CODECID, "V_QUICKTIME");
581 else if (!native_id) {
582 // if there is no mkv-specific codec ID, use VFW mode
583 put_ebml_string(pb, MATROSKA_ID_CODECID, "V_MS/VFW/FOURCC");
584 mkv->tracks[i].write_dts = 1;
587 subinfo = start_ebml_master(pb, MATROSKA_ID_TRACKVIDEO, 0);
588 // XXX: interlace flag?
589 put_ebml_uint (pb, MATROSKA_ID_VIDEOPIXELWIDTH , codec->width);
590 put_ebml_uint (pb, MATROSKA_ID_VIDEOPIXELHEIGHT, codec->height);
591 if ((tag = av_dict_get(s->metadata, "stereo_mode", NULL, 0))) {
592 uint8_t stereo_fmt = atoi(tag->value);
597 if (stereo_fmt <= MATROSKA_VIDEO_STEREOMODE_TYPE_TOP_BOTTOM
598 || stereo_fmt == MATROSKA_VIDEO_STEREOMODE_TYPE_RIGHT_LEFT)
601 case MODE_MATROSKAv2:
602 if (stereo_fmt <= MATROSKA_VIDEO_STEREOMODE_TYPE_BOTH_EYES_BLOCK_RL)
608 put_ebml_uint (pb, MATROSKA_ID_VIDEOSTEREOMODE, stereo_fmt);
610 if (st->sample_aspect_ratio.num) {
611 int d_width = codec->width*av_q2d(st->sample_aspect_ratio);
612 put_ebml_uint(pb, MATROSKA_ID_VIDEODISPLAYWIDTH , d_width);
613 put_ebml_uint(pb, MATROSKA_ID_VIDEODISPLAYHEIGHT, codec->height);
614 put_ebml_uint(pb, MATROSKA_ID_VIDEODISPLAYUNIT, 3);
616 end_ebml_master(pb, subinfo);
619 case AVMEDIA_TYPE_AUDIO:
620 put_ebml_uint(pb, MATROSKA_ID_TRACKTYPE, MATROSKA_TRACK_TYPE_AUDIO);
623 // no mkv-specific ID, use ACM mode
624 put_ebml_string(pb, MATROSKA_ID_CODECID, "A_MS/ACM");
626 subinfo = start_ebml_master(pb, MATROSKA_ID_TRACKAUDIO, 0);
627 put_ebml_uint (pb, MATROSKA_ID_AUDIOCHANNELS , codec->channels);
628 put_ebml_float (pb, MATROSKA_ID_AUDIOSAMPLINGFREQ, sample_rate);
629 if (output_sample_rate)
630 put_ebml_float(pb, MATROSKA_ID_AUDIOOUTSAMPLINGFREQ, output_sample_rate);
632 put_ebml_uint(pb, MATROSKA_ID_AUDIOBITDEPTH, bit_depth);
633 end_ebml_master(pb, subinfo);
636 case AVMEDIA_TYPE_SUBTITLE:
637 put_ebml_uint(pb, MATROSKA_ID_TRACKTYPE, MATROSKA_TRACK_TYPE_SUBTITLE);
639 av_log(s, AV_LOG_ERROR, "Subtitle codec %d is not supported.\n", codec->codec_id);
640 return AVERROR(ENOSYS);
644 av_log(s, AV_LOG_ERROR, "Only audio, video, and subtitles are supported for Matroska.\n");
647 ret = mkv_write_codecprivate(s, pb, codec, native_id, qt_id);
648 if (ret < 0) return ret;
650 end_ebml_master(pb, track);
652 // ms precision is the de-facto standard timescale for mkv files
653 av_set_pts_info(st, 64, 1, 1000);
655 end_ebml_master(pb, tracks);
659 static int mkv_write_chapters(AVFormatContext *s)
661 MatroskaMuxContext *mkv = s->priv_data;
662 AVIOContext *pb = s->pb;
663 ebml_master chapters, editionentry;
664 AVRational scale = {1, 1E9};
670 ret = mkv_add_seekhead_entry(mkv->main_seekhead, MATROSKA_ID_CHAPTERS, avio_tell(pb));
671 if (ret < 0) return ret;
673 chapters = start_ebml_master(pb, MATROSKA_ID_CHAPTERS , 0);
674 editionentry = start_ebml_master(pb, MATROSKA_ID_EDITIONENTRY, 0);
675 put_ebml_uint(pb, MATROSKA_ID_EDITIONFLAGDEFAULT, 1);
676 put_ebml_uint(pb, MATROSKA_ID_EDITIONFLAGHIDDEN , 0);
677 for (i = 0; i < s->nb_chapters; i++) {
678 ebml_master chapteratom, chapterdisplay;
679 AVChapter *c = s->chapters[i];
680 AVDictionaryEntry *t = NULL;
682 chapteratom = start_ebml_master(pb, MATROSKA_ID_CHAPTERATOM, 0);
683 put_ebml_uint(pb, MATROSKA_ID_CHAPTERUID, c->id);
684 put_ebml_uint(pb, MATROSKA_ID_CHAPTERTIMESTART,
685 av_rescale_q(c->start, c->time_base, scale));
686 put_ebml_uint(pb, MATROSKA_ID_CHAPTERTIMEEND,
687 av_rescale_q(c->end, c->time_base, scale));
688 put_ebml_uint(pb, MATROSKA_ID_CHAPTERFLAGHIDDEN , 0);
689 put_ebml_uint(pb, MATROSKA_ID_CHAPTERFLAGENABLED, 1);
690 if ((t = av_dict_get(c->metadata, "title", NULL, 0))) {
691 chapterdisplay = start_ebml_master(pb, MATROSKA_ID_CHAPTERDISPLAY, 0);
692 put_ebml_string(pb, MATROSKA_ID_CHAPSTRING, t->value);
693 put_ebml_string(pb, MATROSKA_ID_CHAPLANG , "und");
694 end_ebml_master(pb, chapterdisplay);
696 end_ebml_master(pb, chapteratom);
698 end_ebml_master(pb, editionentry);
699 end_ebml_master(pb, chapters);
703 static void mkv_write_simpletag(AVIOContext *pb, AVDictionaryEntry *t)
705 uint8_t *key = av_strdup(t->key);
707 const uint8_t *lang = NULL;
710 if ((p = strrchr(p, '-')) &&
711 (lang = av_convert_lang_to(p + 1, AV_LANG_ISO639_2_BIBL)))
718 else if (*p >= 'a' && *p <= 'z')
723 tag = start_ebml_master(pb, MATROSKA_ID_SIMPLETAG, 0);
724 put_ebml_string(pb, MATROSKA_ID_TAGNAME, key);
726 put_ebml_string(pb, MATROSKA_ID_TAGLANG, lang);
727 put_ebml_string(pb, MATROSKA_ID_TAGSTRING, t->value);
728 end_ebml_master(pb, tag);
733 static int mkv_write_tag(AVFormatContext *s, AVDictionary *m, unsigned int elementid,
734 unsigned int uid, ebml_master *tags)
736 MatroskaMuxContext *mkv = s->priv_data;
737 ebml_master tag, targets;
738 AVDictionaryEntry *t = NULL;
742 ret = mkv_add_seekhead_entry(mkv->main_seekhead, MATROSKA_ID_TAGS, avio_tell(s->pb));
743 if (ret < 0) return ret;
745 *tags = start_ebml_master(s->pb, MATROSKA_ID_TAGS, 0);
748 tag = start_ebml_master(s->pb, MATROSKA_ID_TAG, 0);
749 targets = start_ebml_master(s->pb, MATROSKA_ID_TAGTARGETS, 0);
751 put_ebml_uint(s->pb, elementid, uid);
752 end_ebml_master(s->pb, targets);
754 while ((t = av_dict_get(m, "", t, AV_DICT_IGNORE_SUFFIX)))
755 if (strcasecmp(t->key, "title"))
756 mkv_write_simpletag(s->pb, t);
758 end_ebml_master(s->pb, tag);
762 static int mkv_write_tags(AVFormatContext *s)
764 ebml_master tags = {0};
767 ff_metadata_conv_ctx(s, ff_mkv_metadata_conv, NULL);
769 if (av_dict_get(s->metadata, "", NULL, AV_DICT_IGNORE_SUFFIX)) {
770 ret = mkv_write_tag(s, s->metadata, 0, 0, &tags);
771 if (ret < 0) return ret;
774 for (i = 0; i < s->nb_streams; i++) {
775 AVStream *st = s->streams[i];
777 if (!av_dict_get(st->metadata, "", 0, AV_DICT_IGNORE_SUFFIX))
780 ret = mkv_write_tag(s, st->metadata, MATROSKA_ID_TAGTARGETS_TRACKUID, i + 1, &tags);
781 if (ret < 0) return ret;
784 for (i = 0; i < s->nb_chapters; i++) {
785 AVChapter *ch = s->chapters[i];
787 if (!av_dict_get(ch->metadata, "", NULL, AV_DICT_IGNORE_SUFFIX))
790 ret = mkv_write_tag(s, ch->metadata, MATROSKA_ID_TAGTARGETS_CHAPTERUID, ch->id, &tags);
791 if (ret < 0) return ret;
795 end_ebml_master(s->pb, tags);
799 static int mkv_write_header(AVFormatContext *s)
801 MatroskaMuxContext *mkv = s->priv_data;
802 AVIOContext *pb = s->pb;
803 ebml_master ebml_header, segment_info;
804 AVDictionaryEntry *tag;
807 if (!strcmp(s->oformat->name, "webm")) mkv->mode = MODE_WEBM;
808 else mkv->mode = MODE_MATROSKAv2;
810 mkv->tracks = av_mallocz(s->nb_streams * sizeof(*mkv->tracks));
812 return AVERROR(ENOMEM);
814 ebml_header = start_ebml_master(pb, EBML_ID_HEADER, 0);
815 put_ebml_uint (pb, EBML_ID_EBMLVERSION , 1);
816 put_ebml_uint (pb, EBML_ID_EBMLREADVERSION , 1);
817 put_ebml_uint (pb, EBML_ID_EBMLMAXIDLENGTH , 4);
818 put_ebml_uint (pb, EBML_ID_EBMLMAXSIZELENGTH , 8);
819 put_ebml_string (pb, EBML_ID_DOCTYPE , s->oformat->name);
820 put_ebml_uint (pb, EBML_ID_DOCTYPEVERSION , 2);
821 put_ebml_uint (pb, EBML_ID_DOCTYPEREADVERSION , 2);
822 end_ebml_master(pb, ebml_header);
824 mkv->segment = start_ebml_master(pb, MATROSKA_ID_SEGMENT, 0);
825 mkv->segment_offset = avio_tell(pb);
827 // we write 2 seek heads - one at the end of the file to point to each
828 // cluster, and one at the beginning to point to all other level one
829 // elements (including the seek head at the end of the file), which
830 // isn't more than 10 elements if we only write one of each other
831 // currently defined level 1 element
832 mkv->main_seekhead = mkv_start_seekhead(pb, mkv->segment_offset, 10);
833 if (!mkv->main_seekhead)
834 return AVERROR(ENOMEM);
836 ret = mkv_add_seekhead_entry(mkv->main_seekhead, MATROSKA_ID_INFO, avio_tell(pb));
837 if (ret < 0) return ret;
839 segment_info = start_ebml_master(pb, MATROSKA_ID_INFO, 0);
840 put_ebml_uint(pb, MATROSKA_ID_TIMECODESCALE, 1000000);
841 if ((tag = av_dict_get(s->metadata, "title", NULL, 0)))
842 put_ebml_string(pb, MATROSKA_ID_TITLE, tag->value);
843 if (!(s->streams[0]->codec->flags & CODEC_FLAG_BITEXACT)) {
844 uint32_t segment_uid[4];
847 av_lfg_init(&lfg, av_get_random_seed());
849 for (i = 0; i < 4; i++)
850 segment_uid[i] = av_lfg_get(&lfg);
852 put_ebml_string(pb, MATROSKA_ID_MUXINGAPP , LIBAVFORMAT_IDENT);
853 put_ebml_string(pb, MATROSKA_ID_WRITINGAPP, LIBAVFORMAT_IDENT);
854 put_ebml_binary(pb, MATROSKA_ID_SEGMENTUID, segment_uid, 16);
857 // reserve space for the duration
859 mkv->duration_offset = avio_tell(pb);
860 put_ebml_void(pb, 11); // assumes double-precision float to be written
861 end_ebml_master(pb, segment_info);
863 ret = mkv_write_tracks(s);
864 if (ret < 0) return ret;
866 if (mkv->mode != MODE_WEBM) {
867 ret = mkv_write_chapters(s);
868 if (ret < 0) return ret;
870 ret = mkv_write_tags(s);
871 if (ret < 0) return ret;
874 if (!s->pb->seekable)
875 mkv_write_seekhead(pb, mkv->main_seekhead);
877 mkv->cues = mkv_start_cues(mkv->segment_offset);
878 if (mkv->cues == NULL)
879 return AVERROR(ENOMEM);
881 av_init_packet(&mkv->cur_audio_pkt);
882 mkv->cur_audio_pkt.size = 0;
883 mkv->audio_buffer_size = 0;
889 static int mkv_blockgroup_size(int pkt_size)
891 int size = pkt_size + 4;
892 size += ebml_num_size(size);
893 size += 2; // EBML ID for block and block duration
894 size += 8; // max size of block duration
895 size += ebml_num_size(size);
896 size += 1; // blockgroup EBML ID
900 static int ass_get_duration(const uint8_t *p)
902 int sh, sm, ss, sc, eh, em, es, ec;
905 if (sscanf(p, "%*[^,],%d:%d:%d%*c%d,%d:%d:%d%*c%d",
906 &sh, &sm, &ss, &sc, &eh, &em, &es, &ec) != 8)
908 start = 3600000*sh + 60000*sm + 1000*ss + 10*sc;
909 end = 3600000*eh + 60000*em + 1000*es + 10*ec;
913 static int mkv_write_ass_blocks(AVFormatContext *s, AVIOContext *pb, AVPacket *pkt)
915 MatroskaMuxContext *mkv = s->priv_data;
916 int i, layer = 0, max_duration = 0, size, line_size, data_size = pkt->size;
917 uint8_t *start, *end, *data = pkt->data;
918 ebml_master blockgroup;
922 int duration = ass_get_duration(data);
923 max_duration = FFMAX(duration, max_duration);
924 end = memchr(data, '\n', data_size);
925 size = line_size = end ? end-data+1 : data_size;
926 size -= end ? (end[-1]=='\r')+1 : 0;
928 for (i=0; i<3; i++, start++)
929 if (!(start = memchr(start, ',', size-(start-data))))
931 size -= start - data;
932 sscanf(data, "Dialogue: %d,", &layer);
933 i = snprintf(buffer, sizeof(buffer), "%"PRId64",%d,",
934 s->streams[pkt->stream_index]->nb_frames++, layer);
935 size = FFMIN(i+size, sizeof(buffer));
936 memcpy(buffer+i, start, size-i);
938 av_log(s, AV_LOG_DEBUG, "Writing block at offset %" PRIu64 ", size %d, "
939 "pts %" PRId64 ", duration %d\n",
940 avio_tell(pb), size, pkt->pts, duration);
941 blockgroup = start_ebml_master(pb, MATROSKA_ID_BLOCKGROUP, mkv_blockgroup_size(size));
942 put_ebml_id(pb, MATROSKA_ID_BLOCK);
943 put_ebml_num(pb, size+4, 0);
944 avio_w8(pb, 0x80 | (pkt->stream_index + 1)); // this assumes stream_index is less than 126
945 avio_wb16(pb, pkt->pts - mkv->cluster_pts);
947 avio_write(pb, buffer, size);
948 put_ebml_uint(pb, MATROSKA_ID_BLOCKDURATION, duration);
949 end_ebml_master(pb, blockgroup);
952 data_size -= line_size;
958 static void mkv_write_block(AVFormatContext *s, AVIOContext *pb,
959 unsigned int blockid, AVPacket *pkt, int flags)
961 MatroskaMuxContext *mkv = s->priv_data;
962 AVCodecContext *codec = s->streams[pkt->stream_index]->codec;
963 uint8_t *data = NULL;
964 int size = pkt->size;
965 int64_t ts = mkv->tracks[pkt->stream_index].write_dts ? pkt->dts : pkt->pts;
967 av_log(s, AV_LOG_DEBUG, "Writing block at offset %" PRIu64 ", size %d, "
968 "pts %" PRId64 ", dts %" PRId64 ", duration %d, flags %d\n",
969 avio_tell(pb), pkt->size, pkt->pts, pkt->dts, pkt->duration, flags);
970 if (codec->codec_id == CODEC_ID_H264 && codec->extradata_size > 0 &&
971 (AV_RB24(codec->extradata) == 1 || AV_RB32(codec->extradata) == 1))
972 ff_avc_parse_nal_units_buf(pkt->data, &data, &size);
975 put_ebml_id(pb, blockid);
976 put_ebml_num(pb, size+4, 0);
977 avio_w8(pb, 0x80 | (pkt->stream_index + 1)); // this assumes stream_index is less than 126
978 avio_wb16(pb, ts - mkv->cluster_pts);
980 avio_write(pb, data, size);
981 if (data != pkt->data)
985 static int srt_get_duration(uint8_t **buf)
989 for (i=0; i<2 && !duration; i++) {
990 int s_hour, s_min, s_sec, s_hsec, e_hour, e_min, e_sec, e_hsec;
991 if (sscanf(*buf, "%d:%2d:%2d%*1[,.]%3d --> %d:%2d:%2d%*1[,.]%3d",
992 &s_hour, &s_min, &s_sec, &s_hsec,
993 &e_hour, &e_min, &e_sec, &e_hsec) == 8) {
994 s_min += 60*s_hour; e_min += 60*e_hour;
995 s_sec += 60*s_min; e_sec += 60*e_min;
996 s_hsec += 1000*s_sec; e_hsec += 1000*e_sec;
997 duration = e_hsec - s_hsec;
999 *buf += strcspn(*buf, "\n") + 1;
1004 static int mkv_write_srt_blocks(AVFormatContext *s, AVIOContext *pb, AVPacket *pkt)
1006 ebml_master blockgroup;
1007 AVPacket pkt2 = *pkt;
1008 int64_t duration = srt_get_duration(&pkt2.data);
1009 pkt2.size -= pkt2.data - pkt->data;
1011 blockgroup = start_ebml_master(pb, MATROSKA_ID_BLOCKGROUP,
1012 mkv_blockgroup_size(pkt2.size));
1013 mkv_write_block(s, pb, MATROSKA_ID_BLOCK, &pkt2, 0);
1014 put_ebml_uint(pb, MATROSKA_ID_BLOCKDURATION, duration);
1015 end_ebml_master(pb, blockgroup);
1020 static void mkv_flush_dynbuf(AVFormatContext *s)
1022 MatroskaMuxContext *mkv = s->priv_data;
1029 bufsize = avio_close_dyn_buf(mkv->dyn_bc, &dyn_buf);
1030 avio_write(s->pb, dyn_buf, bufsize);
1035 static int mkv_write_packet_internal(AVFormatContext *s, AVPacket *pkt)
1037 MatroskaMuxContext *mkv = s->priv_data;
1038 AVIOContext *pb = s->pb;
1039 AVCodecContext *codec = s->streams[pkt->stream_index]->codec;
1040 int keyframe = !!(pkt->flags & AV_PKT_FLAG_KEY);
1041 int duration = pkt->duration;
1043 int64_t ts = mkv->tracks[pkt->stream_index].write_dts ? pkt->dts : pkt->pts;
1045 if (ts == AV_NOPTS_VALUE) {
1046 av_log(s, AV_LOG_ERROR, "Can't write packet with unknown timestamp\n");
1047 return AVERROR(EINVAL);
1050 if (!s->pb->seekable) {
1052 avio_open_dyn_buf(&mkv->dyn_bc);
1056 if (!mkv->cluster_pos) {
1057 mkv->cluster_pos = avio_tell(s->pb);
1058 mkv->cluster = start_ebml_master(pb, MATROSKA_ID_CLUSTER, 0);
1059 put_ebml_uint(pb, MATROSKA_ID_CLUSTERTIMECODE, FFMAX(0, ts));
1060 mkv->cluster_pts = FFMAX(0, ts);
1063 if (codec->codec_type != AVMEDIA_TYPE_SUBTITLE) {
1064 mkv_write_block(s, pb, MATROSKA_ID_SIMPLEBLOCK, pkt, keyframe << 7);
1065 } else if (codec->codec_id == CODEC_ID_SSA) {
1066 duration = mkv_write_ass_blocks(s, pb, pkt);
1067 } else if (codec->codec_id == CODEC_ID_SRT) {
1068 duration = mkv_write_srt_blocks(s, pb, pkt);
1070 ebml_master blockgroup = start_ebml_master(pb, MATROSKA_ID_BLOCKGROUP, mkv_blockgroup_size(pkt->size));
1071 duration = pkt->convergence_duration;
1072 mkv_write_block(s, pb, MATROSKA_ID_BLOCK, pkt, 0);
1073 put_ebml_uint(pb, MATROSKA_ID_BLOCKDURATION, duration);
1074 end_ebml_master(pb, blockgroup);
1077 if (codec->codec_type == AVMEDIA_TYPE_VIDEO && keyframe) {
1078 ret = mkv_add_cuepoint(mkv->cues, pkt->stream_index, ts, mkv->cluster_pos);
1079 if (ret < 0) return ret;
1082 mkv->duration = FFMAX(mkv->duration, ts + duration);
1086 static int mkv_copy_packet(MatroskaMuxContext *mkv, const AVPacket *pkt)
1088 uint8_t *data = mkv->cur_audio_pkt.data;
1089 mkv->cur_audio_pkt = *pkt;
1090 mkv->cur_audio_pkt.data = av_fast_realloc(data, &mkv->audio_buffer_size, pkt->size);
1091 if (!mkv->cur_audio_pkt.data)
1092 return AVERROR(ENOMEM);
1094 memcpy(mkv->cur_audio_pkt.data, pkt->data, pkt->size);
1095 mkv->cur_audio_pkt.size = pkt->size;
1099 static int mkv_write_packet(AVFormatContext *s, AVPacket *pkt)
1101 MatroskaMuxContext *mkv = s->priv_data;
1102 AVIOContext *pb = s->pb->seekable ? s->pb : mkv->dyn_bc;
1103 AVCodecContext *codec = s->streams[pkt->stream_index]->codec;
1104 int ret, keyframe = !!(pkt->flags & AV_PKT_FLAG_KEY);
1105 int64_t ts = mkv->tracks[pkt->stream_index].write_dts ? pkt->dts : pkt->pts;
1106 int cluster_size = avio_tell(pb) - (s->pb->seekable ? mkv->cluster_pos : 0);
1108 // start a new cluster every 5 MB or 5 sec, or 32k / 1 sec for streaming or
1109 // after 4k and on a keyframe
1110 if (mkv->cluster_pos &&
1111 ((!s->pb->seekable && (cluster_size > 32*1024 || ts > mkv->cluster_pts + 1000))
1112 || cluster_size > 5*1024*1024 || ts > mkv->cluster_pts + 5000
1113 || (codec->codec_type == AVMEDIA_TYPE_VIDEO && keyframe && cluster_size > 4*1024))) {
1114 av_log(s, AV_LOG_DEBUG, "Starting new cluster at offset %" PRIu64
1115 " bytes, pts %" PRIu64 "\n", avio_tell(pb), ts);
1116 end_ebml_master(pb, mkv->cluster);
1117 mkv->cluster_pos = 0;
1119 mkv_flush_dynbuf(s);
1122 // check if we have an audio packet cached
1123 if (mkv->cur_audio_pkt.size > 0) {
1124 ret = mkv_write_packet_internal(s, &mkv->cur_audio_pkt);
1125 mkv->cur_audio_pkt.size = 0;
1127 av_log(s, AV_LOG_ERROR, "Could not write cached audio packet ret:%d\n", ret);
1132 // buffer an audio packet to ensure the packet containing the video
1133 // keyframe's timecode is contained in the same cluster for WebM
1134 if (codec->codec_type == AVMEDIA_TYPE_AUDIO)
1135 ret = mkv_copy_packet(mkv, pkt);
1137 ret = mkv_write_packet_internal(s, pkt);
1141 static int mkv_write_trailer(AVFormatContext *s)
1143 MatroskaMuxContext *mkv = s->priv_data;
1144 AVIOContext *pb = s->pb;
1145 int64_t currentpos, cuespos;
1148 // check if we have an audio packet cached
1149 if (mkv->cur_audio_pkt.size > 0) {
1150 ret = mkv_write_packet_internal(s, &mkv->cur_audio_pkt);
1151 mkv->cur_audio_pkt.size = 0;
1153 av_log(s, AV_LOG_ERROR, "Could not write cached audio packet ret:%d\n", ret);
1159 end_ebml_master(mkv->dyn_bc, mkv->cluster);
1160 mkv_flush_dynbuf(s);
1161 } else if (mkv->cluster_pos) {
1162 end_ebml_master(pb, mkv->cluster);
1166 if (mkv->cues->num_entries) {
1167 cuespos = mkv_write_cues(pb, mkv->cues, s->nb_streams);
1169 ret = mkv_add_seekhead_entry(mkv->main_seekhead, MATROSKA_ID_CUES, cuespos);
1170 if (ret < 0) return ret;
1173 mkv_write_seekhead(pb, mkv->main_seekhead);
1175 // update the duration
1176 av_log(s, AV_LOG_DEBUG, "end duration = %" PRIu64 "\n", mkv->duration);
1177 currentpos = avio_tell(pb);
1178 avio_seek(pb, mkv->duration_offset, SEEK_SET);
1179 put_ebml_float(pb, MATROSKA_ID_DURATION, mkv->duration);
1181 avio_seek(pb, currentpos, SEEK_SET);
1184 end_ebml_master(pb, mkv->segment);
1185 av_free(mkv->tracks);
1186 av_freep(&mkv->cues->entries);
1187 av_freep(&mkv->cues);
1188 av_destruct_packet(&mkv->cur_audio_pkt);
1193 #if CONFIG_MATROSKA_MUXER
1194 AVOutputFormat ff_matroska_muxer = {
1196 NULL_IF_CONFIG_SMALL("Matroska file format"),
1199 sizeof(MatroskaMuxContext),
1205 .flags = AVFMT_GLOBALHEADER | AVFMT_VARIABLE_FPS,
1206 .codec_tag = (const AVCodecTag* const []){ff_codec_bmp_tags, ff_codec_wav_tags, 0},
1207 .subtitle_codec = CODEC_ID_TEXT,
1211 #if CONFIG_WEBM_MUXER
1212 AVOutputFormat ff_webm_muxer = {
1214 NULL_IF_CONFIG_SMALL("WebM file format"),
1217 sizeof(MatroskaMuxContext),
1223 .flags = AVFMT_GLOBALHEADER | AVFMT_VARIABLE_FPS,
1227 #if CONFIG_MATROSKA_AUDIO_MUXER
1228 AVOutputFormat ff_matroska_audio_muxer = {
1230 NULL_IF_CONFIG_SMALL("Matroska file format"),
1233 sizeof(MatroskaMuxContext),
1239 .flags = AVFMT_GLOBALHEADER,
1240 .codec_tag = (const AVCodecTag* const []){ff_codec_wav_tags, 0},