3 * Copyright (c) 2007 David Conrad
5 * This file is part of FFmpeg.
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.
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.
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
28 #include "avlanguage.h"
29 #include "libavutil/samplefmt.h"
30 #include "libavutil/intreadwrite.h"
31 #include "libavutil/intfloat_readwrite.h"
32 #include "libavutil/mathematics.h"
33 #include "libavutil/random_seed.h"
34 #include "libavutil/lfg.h"
35 #include "libavutil/dict.h"
36 #include "libavcodec/xiph.h"
37 #include "libavcodec/mpeg4audio.h"
40 typedef struct ebml_master {
41 int64_t pos; ///< absolute offset in the file where the master's elements start
42 int sizebytes; ///< how many bytes were reserved for the size
45 typedef struct mkv_seekhead_entry {
46 unsigned int elementid;
50 typedef struct mkv_seekhead {
52 int64_t segment_offset; ///< the file offset to the beginning of the segment
53 int reserved_size; ///< -1 if appending to file
55 mkv_seekhead_entry *entries;
62 int64_t cluster_pos; ///< file offset of the cluster containing the block
66 int64_t segment_offset;
67 mkv_cuepoint *entries;
75 #define MODE_MATROSKAv2 0x01
76 #define MODE_WEBM 0x02
78 typedef struct MatroskaMuxContext {
82 int64_t segment_offset;
84 int64_t cluster_pos; ///< file offset of the current cluster
86 int64_t duration_offset;
88 mkv_seekhead *main_seekhead;
92 unsigned int audio_buffer_size;
93 AVPacket cur_audio_pkt;
97 /** 2 bytes * 3 for EBML IDs, 3 1-byte EBML lengths, 8 bytes for 64 bit
98 * offset, 4 bytes for target EBML ID */
99 #define MAX_SEEKENTRY_SIZE 21
101 /** per-cuepoint-track - 3 1-byte EBML IDs, 3 1-byte EBML sizes, 2
103 #define MAX_CUETRACKPOS_SIZE 22
105 /** per-cuepoint - 2 1-byte EBML IDs, 2 1-byte EBML sizes, 8-byte uint max */
106 #define MAX_CUEPOINT_SIZE(num_tracks) 12 + MAX_CUETRACKPOS_SIZE*num_tracks
109 static int ebml_id_size(unsigned int id)
111 return (av_log2(id+1)-1)/7+1;
114 static void put_ebml_id(AVIOContext *pb, unsigned int id)
116 int i = ebml_id_size(id);
118 avio_w8(pb, id >> (i*8));
122 * Write an EBML size meaning "unknown size".
124 * @param bytes The number of bytes the size should occupy (maximum: 8).
126 static void put_ebml_size_unknown(AVIOContext *pb, int bytes)
129 avio_w8(pb, 0x1ff >> bytes);
135 * Calculate how many bytes are needed to represent a given number in EBML.
137 static int ebml_num_size(uint64_t num)
140 while ((num+1) >> bytes*7) bytes++;
145 * Write a number in EBML variable length format.
147 * @param bytes The number of bytes that need to be used to write the number.
148 * If zero, any number of bytes can be used.
150 static void put_ebml_num(AVIOContext *pb, uint64_t num, int bytes)
152 int i, needed_bytes = ebml_num_size(num);
154 // sizes larger than this are currently undefined in EBML
155 assert(num < (1ULL<<56)-1);
158 // don't care how many bytes are used, so use the min
159 bytes = needed_bytes;
160 // the bytes needed to write the given size would exceed the bytes
161 // that we need to use, so write unknown size. This shouldn't happen.
162 assert(bytes >= needed_bytes);
164 num |= 1ULL << bytes*7;
165 for (i = bytes - 1; i >= 0; i--)
166 avio_w8(pb, num >> i*8);
169 static void put_ebml_uint(AVIOContext *pb, unsigned int elementid, uint64_t val)
173 while (tmp>>=8) bytes++;
175 put_ebml_id(pb, elementid);
176 put_ebml_num(pb, bytes, 0);
177 for (i = bytes - 1; i >= 0; i--)
178 avio_w8(pb, val >> i*8);
181 static void put_ebml_float(AVIOContext *pb, unsigned int elementid, double val)
183 put_ebml_id(pb, elementid);
184 put_ebml_num(pb, 8, 0);
185 avio_wb64(pb, av_dbl2int(val));
188 static void put_ebml_binary(AVIOContext *pb, unsigned int elementid,
189 const void *buf, int size)
191 put_ebml_id(pb, elementid);
192 put_ebml_num(pb, size, 0);
193 avio_write(pb, buf, size);
196 static void put_ebml_string(AVIOContext *pb, unsigned int elementid, const char *str)
198 put_ebml_binary(pb, elementid, str, strlen(str));
202 * Write a void element of a given size. Useful for reserving space in
203 * the file to be written to later.
205 * @param size The number of bytes to reserve, which must be at least 2.
207 static void put_ebml_void(AVIOContext *pb, uint64_t size)
209 int64_t currentpos = avio_tell(pb);
213 put_ebml_id(pb, EBML_ID_VOID);
214 // we need to subtract the length needed to store the size from the
215 // size we need to reserve so 2 cases, we use 8 bytes to store the
216 // size if possible, 1 byte otherwise
218 put_ebml_num(pb, size-1, 0);
220 put_ebml_num(pb, size-9, 8);
221 while(avio_tell(pb) < currentpos + size)
225 static ebml_master start_ebml_master(AVIOContext *pb, unsigned int elementid, uint64_t expectedsize)
227 int bytes = expectedsize ? ebml_num_size(expectedsize) : 8;
228 put_ebml_id(pb, elementid);
229 put_ebml_size_unknown(pb, bytes);
230 return (ebml_master){ avio_tell(pb), bytes };
233 static void end_ebml_master(AVIOContext *pb, ebml_master master)
235 int64_t pos = avio_tell(pb);
237 if (avio_seek(pb, master.pos - master.sizebytes, SEEK_SET) < 0)
239 put_ebml_num(pb, pos - master.pos, master.sizebytes);
240 avio_seek(pb, pos, SEEK_SET);
243 static void put_xiph_size(AVIOContext *pb, int size)
246 for (i = 0; i < size / 255; i++)
248 avio_w8(pb, size % 255);
252 * Initialize a mkv_seekhead element to be ready to index level 1 Matroska
253 * elements. If a maximum number of elements is specified, enough space
254 * will be reserved at the current file location to write a seek head of
257 * @param segment_offset The absolute offset to the position in the file
258 * where the segment begins.
259 * @param numelements The maximum number of elements that will be indexed
260 * by this seek head, 0 if unlimited.
262 static mkv_seekhead * mkv_start_seekhead(AVIOContext *pb, int64_t segment_offset, int numelements)
264 mkv_seekhead *new_seekhead = av_mallocz(sizeof(mkv_seekhead));
265 if (new_seekhead == NULL)
268 new_seekhead->segment_offset = segment_offset;
270 if (numelements > 0) {
271 new_seekhead->filepos = avio_tell(pb);
272 // 21 bytes max for a seek entry, 10 bytes max for the SeekHead ID
273 // and size, and 3 bytes to guarantee that an EBML void element
274 // will fit afterwards
275 new_seekhead->reserved_size = numelements * MAX_SEEKENTRY_SIZE + 13;
276 new_seekhead->max_entries = numelements;
277 put_ebml_void(pb, new_seekhead->reserved_size);
282 static int mkv_add_seekhead_entry(mkv_seekhead *seekhead, unsigned int elementid, uint64_t filepos)
284 mkv_seekhead_entry *entries = seekhead->entries;
286 // don't store more elements than we reserved space for
287 if (seekhead->max_entries > 0 && seekhead->max_entries <= seekhead->num_entries)
290 entries = av_realloc(entries, (seekhead->num_entries + 1) * sizeof(mkv_seekhead_entry));
292 return AVERROR(ENOMEM);
294 entries[seekhead->num_entries ].elementid = elementid;
295 entries[seekhead->num_entries++].segmentpos = filepos - seekhead->segment_offset;
297 seekhead->entries = entries;
302 * Write the seek head to the file and free it. If a maximum number of
303 * elements was specified to mkv_start_seekhead(), the seek head will
304 * be written at the location reserved for it. Otherwise, it is written
305 * at the current location in the file.
307 * @return The file offset where the seekhead was written,
308 * -1 if an error occurred.
310 static int64_t mkv_write_seekhead(AVIOContext *pb, mkv_seekhead *seekhead)
312 ebml_master metaseek, seekentry;
316 currentpos = avio_tell(pb);
318 if (seekhead->reserved_size > 0)
319 if (avio_seek(pb, seekhead->filepos, SEEK_SET) < 0)
322 metaseek = start_ebml_master(pb, MATROSKA_ID_SEEKHEAD, seekhead->reserved_size);
323 for (i = 0; i < seekhead->num_entries; i++) {
324 mkv_seekhead_entry *entry = &seekhead->entries[i];
326 seekentry = start_ebml_master(pb, MATROSKA_ID_SEEKENTRY, MAX_SEEKENTRY_SIZE);
328 put_ebml_id(pb, MATROSKA_ID_SEEKID);
329 put_ebml_num(pb, ebml_id_size(entry->elementid), 0);
330 put_ebml_id(pb, entry->elementid);
332 put_ebml_uint(pb, MATROSKA_ID_SEEKPOSITION, entry->segmentpos);
333 end_ebml_master(pb, seekentry);
335 end_ebml_master(pb, metaseek);
337 if (seekhead->reserved_size > 0) {
338 uint64_t remaining = seekhead->filepos + seekhead->reserved_size - avio_tell(pb);
339 put_ebml_void(pb, remaining);
340 avio_seek(pb, currentpos, SEEK_SET);
342 currentpos = seekhead->filepos;
344 av_free(seekhead->entries);
350 static mkv_cues * mkv_start_cues(int64_t segment_offset)
352 mkv_cues *cues = av_mallocz(sizeof(mkv_cues));
356 cues->segment_offset = segment_offset;
360 static int mkv_add_cuepoint(mkv_cues *cues, int stream, int64_t ts, int64_t cluster_pos)
362 mkv_cuepoint *entries = cues->entries;
364 entries = av_realloc(entries, (cues->num_entries + 1) * sizeof(mkv_cuepoint));
366 return AVERROR(ENOMEM);
371 entries[cues->num_entries ].pts = ts;
372 entries[cues->num_entries ].tracknum = stream + 1;
373 entries[cues->num_entries++].cluster_pos = cluster_pos - cues->segment_offset;
375 cues->entries = entries;
379 static int64_t mkv_write_cues(AVIOContext *pb, mkv_cues *cues, int num_tracks)
381 ebml_master cues_element;
385 currentpos = avio_tell(pb);
386 cues_element = start_ebml_master(pb, MATROSKA_ID_CUES, 0);
388 for (i = 0; i < cues->num_entries; i++) {
389 ebml_master cuepoint, track_positions;
390 mkv_cuepoint *entry = &cues->entries[i];
391 uint64_t pts = entry->pts;
393 cuepoint = start_ebml_master(pb, MATROSKA_ID_POINTENTRY, MAX_CUEPOINT_SIZE(num_tracks));
394 put_ebml_uint(pb, MATROSKA_ID_CUETIME, pts);
396 // put all the entries from different tracks that have the exact same
397 // timestamp into the same CuePoint
398 for (j = 0; j < cues->num_entries - i && entry[j].pts == pts; j++) {
399 track_positions = start_ebml_master(pb, MATROSKA_ID_CUETRACKPOSITION, MAX_CUETRACKPOS_SIZE);
400 put_ebml_uint(pb, MATROSKA_ID_CUETRACK , entry[j].tracknum );
401 put_ebml_uint(pb, MATROSKA_ID_CUECLUSTERPOSITION, entry[j].cluster_pos);
402 end_ebml_master(pb, track_positions);
405 end_ebml_master(pb, cuepoint);
407 end_ebml_master(pb, cues_element);
412 static int put_xiph_codecpriv(AVFormatContext *s, AVIOContext *pb, AVCodecContext *codec)
414 uint8_t *header_start[3];
416 int first_header_size;
419 if (codec->codec_id == CODEC_ID_VORBIS)
420 first_header_size = 30;
422 first_header_size = 42;
424 if (ff_split_xiph_headers(codec->extradata, codec->extradata_size,
425 first_header_size, header_start, header_len) < 0) {
426 av_log(s, AV_LOG_ERROR, "Extradata corrupt.\n");
430 avio_w8(pb, 2); // number packets - 1
431 for (j = 0; j < 2; j++) {
432 put_xiph_size(pb, header_len[j]);
434 for (j = 0; j < 3; j++)
435 avio_write(pb, header_start[j], header_len[j]);
440 static void get_aac_sample_rates(AVFormatContext *s, AVCodecContext *codec, int *sample_rate, int *output_sample_rate)
442 MPEG4AudioConfig mp4ac;
444 if (ff_mpeg4audio_get_config(&mp4ac, codec->extradata, codec->extradata_size) < 0) {
445 av_log(s, AV_LOG_WARNING, "Error parsing AAC extradata, unable to determine samplerate.\n");
449 *sample_rate = mp4ac.sample_rate;
450 *output_sample_rate = mp4ac.ext_sample_rate;
453 static int mkv_write_codecprivate(AVFormatContext *s, AVIOContext *pb, AVCodecContext *codec, int native_id, int qt_id)
457 int ret, codecpriv_size;
459 ret = avio_open_dyn_buf(&dyn_cp);
464 if (codec->codec_id == CODEC_ID_VORBIS || codec->codec_id == CODEC_ID_THEORA)
465 ret = put_xiph_codecpriv(s, dyn_cp, codec);
466 else if (codec->codec_id == CODEC_ID_FLAC)
467 ret = ff_flac_write_header(dyn_cp, codec, 1);
468 else if (codec->codec_id == CODEC_ID_H264)
469 ret = ff_isom_write_avcc(dyn_cp, codec->extradata, codec->extradata_size);
470 else if (codec->extradata_size)
471 avio_write(dyn_cp, codec->extradata, codec->extradata_size);
472 } else if (codec->codec_type == AVMEDIA_TYPE_VIDEO) {
474 if (!codec->codec_tag)
475 codec->codec_tag = ff_codec_get_tag(codec_movvideo_tags, codec->codec_id);
476 if (codec->extradata_size)
477 avio_write(dyn_cp, codec->extradata, codec->extradata_size);
479 if (!codec->codec_tag)
480 codec->codec_tag = ff_codec_get_tag(ff_codec_bmp_tags, codec->codec_id);
481 if (!codec->codec_tag) {
482 av_log(s, AV_LOG_ERROR, "No bmp codec ID found.\n");
486 ff_put_bmp_header(dyn_cp, codec, ff_codec_bmp_tags, 0);
489 } else if (codec->codec_type == AVMEDIA_TYPE_AUDIO) {
491 tag = ff_codec_get_tag(ff_codec_wav_tags, codec->codec_id);
493 av_log(s, AV_LOG_ERROR, "No wav codec ID found.\n");
496 if (!codec->codec_tag)
497 codec->codec_tag = tag;
499 ff_put_wav_header(dyn_cp, codec);
502 codecpriv_size = avio_close_dyn_buf(dyn_cp, &codecpriv);
504 put_ebml_binary(pb, MATROSKA_ID_CODECPRIVATE, codecpriv, codecpriv_size);
509 static int mkv_write_tracks(AVFormatContext *s)
511 MatroskaMuxContext *mkv = s->priv_data;
512 AVIOContext *pb = s->pb;
516 ret = mkv_add_seekhead_entry(mkv->main_seekhead, MATROSKA_ID_TRACKS, avio_tell(pb));
517 if (ret < 0) return ret;
519 tracks = start_ebml_master(pb, MATROSKA_ID_TRACKS, 0);
520 for (i = 0; i < s->nb_streams; i++) {
521 AVStream *st = s->streams[i];
522 AVCodecContext *codec = st->codec;
523 ebml_master subinfo, track;
526 int bit_depth = av_get_bits_per_sample(codec->codec_id);
527 int sample_rate = codec->sample_rate;
528 int output_sample_rate = 0;
529 AVDictionaryEntry *tag;
532 bit_depth = av_get_bytes_per_sample(codec->sample_fmt) << 3;
534 if (codec->codec_id == CODEC_ID_AAC)
535 get_aac_sample_rates(s, codec, &sample_rate, &output_sample_rate);
537 track = start_ebml_master(pb, MATROSKA_ID_TRACKENTRY, 0);
538 put_ebml_uint (pb, MATROSKA_ID_TRACKNUMBER , i + 1);
539 put_ebml_uint (pb, MATROSKA_ID_TRACKUID , i + 1);
540 put_ebml_uint (pb, MATROSKA_ID_TRACKFLAGLACING , 0); // no lacing (yet)
542 if ((tag = av_dict_get(st->metadata, "title", NULL, 0)))
543 put_ebml_string(pb, MATROSKA_ID_TRACKNAME, tag->value);
544 tag = av_dict_get(st->metadata, "language", NULL, 0);
545 put_ebml_string(pb, MATROSKA_ID_TRACKLANGUAGE, tag ? tag->value:"und");
548 put_ebml_uint(pb, MATROSKA_ID_TRACKFLAGDEFAULT, !!(st->disposition & AV_DISPOSITION_DEFAULT));
550 // look for a codec ID string specific to mkv to use,
551 // if none are found, use AVI codes
552 for (j = 0; ff_mkv_codec_tags[j].id != CODEC_ID_NONE; j++) {
553 if (ff_mkv_codec_tags[j].id == codec->codec_id) {
554 put_ebml_string(pb, MATROSKA_ID_CODECID, ff_mkv_codec_tags[j].str);
560 if (mkv->mode == MODE_WEBM && !(codec->codec_id == CODEC_ID_VP8 ||
561 codec->codec_id == CODEC_ID_VORBIS)) {
562 av_log(s, AV_LOG_ERROR,
563 "Only VP8 video and Vorbis audio are supported for WebM.\n");
564 return AVERROR(EINVAL);
567 switch (codec->codec_type) {
568 case AVMEDIA_TYPE_VIDEO:
569 put_ebml_uint(pb, MATROSKA_ID_TRACKTYPE, MATROSKA_TRACK_TYPE_VIDEO);
570 put_ebml_uint(pb, MATROSKA_ID_TRACKDEFAULTDURATION, av_q2d(codec->time_base)*1E9);
573 ff_codec_get_tag(codec_movvideo_tags, codec->codec_id) &&
574 (!ff_codec_get_tag(ff_codec_bmp_tags, codec->codec_id)
575 || codec->codec_id == CODEC_ID_SVQ1
576 || codec->codec_id == CODEC_ID_SVQ3
577 || codec->codec_id == CODEC_ID_CINEPAK))
581 put_ebml_string(pb, MATROSKA_ID_CODECID, "V_QUICKTIME");
582 else if (!native_id) {
583 // if there is no mkv-specific codec ID, use VFW mode
584 put_ebml_string(pb, MATROSKA_ID_CODECID, "V_MS/VFW/FOURCC");
585 mkv->tracks[i].write_dts = 1;
588 subinfo = start_ebml_master(pb, MATROSKA_ID_TRACKVIDEO, 0);
589 // XXX: interlace flag?
590 put_ebml_uint (pb, MATROSKA_ID_VIDEOPIXELWIDTH , codec->width);
591 put_ebml_uint (pb, MATROSKA_ID_VIDEOPIXELHEIGHT, codec->height);
593 if ((tag = av_dict_get(st->metadata, "stereo_mode", NULL, 0)) ||
594 (tag = av_dict_get( s->metadata, "stereo_mode", NULL, 0))) {
595 // save stereo mode flag
596 uint64_t st_mode = MATROSKA_VIDEO_STEREO_MODE_COUNT;
598 for (j=0; j<MATROSKA_VIDEO_STEREO_MODE_COUNT; j++)
599 if (!strcmp(tag->value, matroska_video_stereo_mode[j])){
604 if ((mkv->mode == MODE_WEBM && st_mode > 3 && st_mode != 11)
605 || st_mode >= MATROSKA_VIDEO_STEREO_MODE_COUNT) {
606 av_log(s, AV_LOG_ERROR,
607 "The specified stereo mode is not valid.\n");
608 return AVERROR(EINVAL);
610 put_ebml_uint(pb, MATROSKA_ID_VIDEOSTEREOMODE, st_mode);
613 if (st->sample_aspect_ratio.num) {
614 int d_width = codec->width*av_q2d(st->sample_aspect_ratio);
615 put_ebml_uint(pb, MATROSKA_ID_VIDEODISPLAYWIDTH , d_width);
616 put_ebml_uint(pb, MATROSKA_ID_VIDEODISPLAYHEIGHT, codec->height);
617 put_ebml_uint(pb, MATROSKA_ID_VIDEODISPLAYUNIT, 3);
620 if (codec->codec_id == CODEC_ID_RAWVIDEO) {
621 uint32_t color_space = av_le2ne32(codec->codec_tag);
622 put_ebml_binary(pb, MATROSKA_ID_VIDEOCOLORSPACE, &color_space, sizeof(color_space));
624 end_ebml_master(pb, subinfo);
627 case AVMEDIA_TYPE_AUDIO:
628 put_ebml_uint(pb, MATROSKA_ID_TRACKTYPE, MATROSKA_TRACK_TYPE_AUDIO);
631 // no mkv-specific ID, use ACM mode
632 put_ebml_string(pb, MATROSKA_ID_CODECID, "A_MS/ACM");
634 subinfo = start_ebml_master(pb, MATROSKA_ID_TRACKAUDIO, 0);
635 put_ebml_uint (pb, MATROSKA_ID_AUDIOCHANNELS , codec->channels);
636 put_ebml_float (pb, MATROSKA_ID_AUDIOSAMPLINGFREQ, sample_rate);
637 if (output_sample_rate)
638 put_ebml_float(pb, MATROSKA_ID_AUDIOOUTSAMPLINGFREQ, output_sample_rate);
640 put_ebml_uint(pb, MATROSKA_ID_AUDIOBITDEPTH, bit_depth);
641 end_ebml_master(pb, subinfo);
644 case AVMEDIA_TYPE_SUBTITLE:
645 put_ebml_uint(pb, MATROSKA_ID_TRACKTYPE, MATROSKA_TRACK_TYPE_SUBTITLE);
647 av_log(s, AV_LOG_ERROR, "Subtitle codec %d is not supported.\n", codec->codec_id);
648 return AVERROR(ENOSYS);
652 av_log(s, AV_LOG_ERROR, "Only audio, video, and subtitles are supported for Matroska.\n");
655 ret = mkv_write_codecprivate(s, pb, codec, native_id, qt_id);
656 if (ret < 0) return ret;
658 end_ebml_master(pb, track);
660 // ms precision is the de-facto standard timescale for mkv files
661 av_set_pts_info(st, 64, 1, 1000);
663 end_ebml_master(pb, tracks);
667 static int mkv_write_chapters(AVFormatContext *s)
669 MatroskaMuxContext *mkv = s->priv_data;
670 AVIOContext *pb = s->pb;
671 ebml_master chapters, editionentry;
672 AVRational scale = {1, 1E9};
678 ret = mkv_add_seekhead_entry(mkv->main_seekhead, MATROSKA_ID_CHAPTERS, avio_tell(pb));
679 if (ret < 0) return ret;
681 chapters = start_ebml_master(pb, MATROSKA_ID_CHAPTERS , 0);
682 editionentry = start_ebml_master(pb, MATROSKA_ID_EDITIONENTRY, 0);
683 put_ebml_uint(pb, MATROSKA_ID_EDITIONFLAGDEFAULT, 1);
684 put_ebml_uint(pb, MATROSKA_ID_EDITIONFLAGHIDDEN , 0);
685 for (i = 0; i < s->nb_chapters; i++) {
686 ebml_master chapteratom, chapterdisplay;
687 AVChapter *c = s->chapters[i];
688 AVDictionaryEntry *t = NULL;
690 chapteratom = start_ebml_master(pb, MATROSKA_ID_CHAPTERATOM, 0);
691 put_ebml_uint(pb, MATROSKA_ID_CHAPTERUID, c->id);
692 put_ebml_uint(pb, MATROSKA_ID_CHAPTERTIMESTART,
693 av_rescale_q(c->start, c->time_base, scale));
694 put_ebml_uint(pb, MATROSKA_ID_CHAPTERTIMEEND,
695 av_rescale_q(c->end, c->time_base, scale));
696 put_ebml_uint(pb, MATROSKA_ID_CHAPTERFLAGHIDDEN , 0);
697 put_ebml_uint(pb, MATROSKA_ID_CHAPTERFLAGENABLED, 1);
698 if ((t = av_dict_get(c->metadata, "title", NULL, 0))) {
699 chapterdisplay = start_ebml_master(pb, MATROSKA_ID_CHAPTERDISPLAY, 0);
700 put_ebml_string(pb, MATROSKA_ID_CHAPSTRING, t->value);
701 put_ebml_string(pb, MATROSKA_ID_CHAPLANG , "und");
702 end_ebml_master(pb, chapterdisplay);
704 end_ebml_master(pb, chapteratom);
706 end_ebml_master(pb, editionentry);
707 end_ebml_master(pb, chapters);
711 static void mkv_write_simpletag(AVIOContext *pb, AVDictionaryEntry *t)
713 uint8_t *key = av_strdup(t->key);
715 const uint8_t *lang = NULL;
718 if ((p = strrchr(p, '-')) &&
719 (lang = av_convert_lang_to(p + 1, AV_LANG_ISO639_2_BIBL)))
726 else if (*p >= 'a' && *p <= 'z')
731 tag = start_ebml_master(pb, MATROSKA_ID_SIMPLETAG, 0);
732 put_ebml_string(pb, MATROSKA_ID_TAGNAME, key);
734 put_ebml_string(pb, MATROSKA_ID_TAGLANG, lang);
735 put_ebml_string(pb, MATROSKA_ID_TAGSTRING, t->value);
736 end_ebml_master(pb, tag);
741 static int mkv_write_tag(AVFormatContext *s, AVDictionary *m, unsigned int elementid,
742 unsigned int uid, ebml_master *tags)
744 MatroskaMuxContext *mkv = s->priv_data;
745 ebml_master tag, targets;
746 AVDictionaryEntry *t = NULL;
750 ret = mkv_add_seekhead_entry(mkv->main_seekhead, MATROSKA_ID_TAGS, avio_tell(s->pb));
751 if (ret < 0) return ret;
753 *tags = start_ebml_master(s->pb, MATROSKA_ID_TAGS, 0);
756 tag = start_ebml_master(s->pb, MATROSKA_ID_TAG, 0);
757 targets = start_ebml_master(s->pb, MATROSKA_ID_TAGTARGETS, 0);
759 put_ebml_uint(s->pb, elementid, uid);
760 end_ebml_master(s->pb, targets);
762 while ((t = av_dict_get(m, "", t, AV_DICT_IGNORE_SUFFIX)))
763 if (strcasecmp(t->key, "title") && strcasecmp(t->key, "stereo_mode"))
764 mkv_write_simpletag(s->pb, t);
766 end_ebml_master(s->pb, tag);
770 static int mkv_write_tags(AVFormatContext *s)
772 ebml_master tags = {0};
775 ff_metadata_conv_ctx(s, ff_mkv_metadata_conv, NULL);
777 if (av_dict_get(s->metadata, "", NULL, AV_DICT_IGNORE_SUFFIX)) {
778 ret = mkv_write_tag(s, s->metadata, 0, 0, &tags);
779 if (ret < 0) return ret;
782 for (i = 0; i < s->nb_streams; i++) {
783 AVStream *st = s->streams[i];
785 if (!av_dict_get(st->metadata, "", 0, AV_DICT_IGNORE_SUFFIX))
788 ret = mkv_write_tag(s, st->metadata, MATROSKA_ID_TAGTARGETS_TRACKUID, i + 1, &tags);
789 if (ret < 0) return ret;
792 for (i = 0; i < s->nb_chapters; i++) {
793 AVChapter *ch = s->chapters[i];
795 if (!av_dict_get(ch->metadata, "", NULL, AV_DICT_IGNORE_SUFFIX))
798 ret = mkv_write_tag(s, ch->metadata, MATROSKA_ID_TAGTARGETS_CHAPTERUID, ch->id, &tags);
799 if (ret < 0) return ret;
803 end_ebml_master(s->pb, tags);
807 static int mkv_write_header(AVFormatContext *s)
809 MatroskaMuxContext *mkv = s->priv_data;
810 AVIOContext *pb = s->pb;
811 ebml_master ebml_header, segment_info;
812 AVDictionaryEntry *tag;
815 if (!strcmp(s->oformat->name, "webm")) mkv->mode = MODE_WEBM;
816 else mkv->mode = MODE_MATROSKAv2;
818 mkv->tracks = av_mallocz(s->nb_streams * sizeof(*mkv->tracks));
820 return AVERROR(ENOMEM);
822 ebml_header = start_ebml_master(pb, EBML_ID_HEADER, 0);
823 put_ebml_uint (pb, EBML_ID_EBMLVERSION , 1);
824 put_ebml_uint (pb, EBML_ID_EBMLREADVERSION , 1);
825 put_ebml_uint (pb, EBML_ID_EBMLMAXIDLENGTH , 4);
826 put_ebml_uint (pb, EBML_ID_EBMLMAXSIZELENGTH , 8);
827 put_ebml_string (pb, EBML_ID_DOCTYPE , s->oformat->name);
828 put_ebml_uint (pb, EBML_ID_DOCTYPEVERSION , 2);
829 put_ebml_uint (pb, EBML_ID_DOCTYPEREADVERSION , 2);
830 end_ebml_master(pb, ebml_header);
832 mkv->segment = start_ebml_master(pb, MATROSKA_ID_SEGMENT, 0);
833 mkv->segment_offset = avio_tell(pb);
835 // we write 2 seek heads - one at the end of the file to point to each
836 // cluster, and one at the beginning to point to all other level one
837 // elements (including the seek head at the end of the file), which
838 // isn't more than 10 elements if we only write one of each other
839 // currently defined level 1 element
840 mkv->main_seekhead = mkv_start_seekhead(pb, mkv->segment_offset, 10);
841 if (!mkv->main_seekhead)
842 return AVERROR(ENOMEM);
844 ret = mkv_add_seekhead_entry(mkv->main_seekhead, MATROSKA_ID_INFO, avio_tell(pb));
845 if (ret < 0) return ret;
847 segment_info = start_ebml_master(pb, MATROSKA_ID_INFO, 0);
848 put_ebml_uint(pb, MATROSKA_ID_TIMECODESCALE, 1000000);
849 if ((tag = av_dict_get(s->metadata, "title", NULL, 0)))
850 put_ebml_string(pb, MATROSKA_ID_TITLE, tag->value);
851 if (!(s->streams[0]->codec->flags & CODEC_FLAG_BITEXACT)) {
852 uint32_t segment_uid[4];
855 av_lfg_init(&lfg, av_get_random_seed());
857 for (i = 0; i < 4; i++)
858 segment_uid[i] = av_lfg_get(&lfg);
860 put_ebml_string(pb, MATROSKA_ID_MUXINGAPP , LIBAVFORMAT_IDENT);
861 put_ebml_string(pb, MATROSKA_ID_WRITINGAPP, LIBAVFORMAT_IDENT);
862 put_ebml_binary(pb, MATROSKA_ID_SEGMENTUID, segment_uid, 16);
865 // reserve space for the duration
867 mkv->duration_offset = avio_tell(pb);
868 put_ebml_void(pb, 11); // assumes double-precision float to be written
869 end_ebml_master(pb, segment_info);
871 ret = mkv_write_tracks(s);
872 if (ret < 0) return ret;
874 if (mkv->mode != MODE_WEBM) {
875 ret = mkv_write_chapters(s);
876 if (ret < 0) return ret;
878 ret = mkv_write_tags(s);
879 if (ret < 0) return ret;
882 if (!s->pb->seekable)
883 mkv_write_seekhead(pb, mkv->main_seekhead);
885 mkv->cues = mkv_start_cues(mkv->segment_offset);
886 if (mkv->cues == NULL)
887 return AVERROR(ENOMEM);
889 av_init_packet(&mkv->cur_audio_pkt);
890 mkv->cur_audio_pkt.size = 0;
891 mkv->audio_buffer_size = 0;
897 static int mkv_blockgroup_size(int pkt_size)
899 int size = pkt_size + 4;
900 size += ebml_num_size(size);
901 size += 2; // EBML ID for block and block duration
902 size += 8; // max size of block duration
903 size += ebml_num_size(size);
904 size += 1; // blockgroup EBML ID
908 static int ass_get_duration(const uint8_t *p)
910 int sh, sm, ss, sc, eh, em, es, ec;
913 if (sscanf(p, "%*[^,],%d:%d:%d%*c%d,%d:%d:%d%*c%d",
914 &sh, &sm, &ss, &sc, &eh, &em, &es, &ec) != 8)
916 start = 3600000*sh + 60000*sm + 1000*ss + 10*sc;
917 end = 3600000*eh + 60000*em + 1000*es + 10*ec;
921 static int mkv_write_ass_blocks(AVFormatContext *s, AVIOContext *pb, AVPacket *pkt)
923 MatroskaMuxContext *mkv = s->priv_data;
924 int i, layer = 0, max_duration = 0, size, line_size, data_size = pkt->size;
925 uint8_t *start, *end, *data = pkt->data;
926 ebml_master blockgroup;
930 int duration = ass_get_duration(data);
931 max_duration = FFMAX(duration, max_duration);
932 end = memchr(data, '\n', data_size);
933 size = line_size = end ? end-data+1 : data_size;
934 size -= end ? (end[-1]=='\r')+1 : 0;
936 for (i=0; i<3; i++, start++)
937 if (!(start = memchr(start, ',', size-(start-data))))
939 size -= start - data;
940 sscanf(data, "Dialogue: %d,", &layer);
941 i = snprintf(buffer, sizeof(buffer), "%"PRId64",%d,",
942 s->streams[pkt->stream_index]->nb_frames, layer);
943 size = FFMIN(i+size, sizeof(buffer));
944 memcpy(buffer+i, start, size-i);
946 av_log(s, AV_LOG_DEBUG, "Writing block at offset %" PRIu64 ", size %d, "
947 "pts %" PRId64 ", duration %d\n",
948 avio_tell(pb), size, pkt->pts, duration);
949 blockgroup = start_ebml_master(pb, MATROSKA_ID_BLOCKGROUP, mkv_blockgroup_size(size));
950 put_ebml_id(pb, MATROSKA_ID_BLOCK);
951 put_ebml_num(pb, size+4, 0);
952 avio_w8(pb, 0x80 | (pkt->stream_index + 1)); // this assumes stream_index is less than 126
953 avio_wb16(pb, pkt->pts - mkv->cluster_pts);
955 avio_write(pb, buffer, size);
956 put_ebml_uint(pb, MATROSKA_ID_BLOCKDURATION, duration);
957 end_ebml_master(pb, blockgroup);
960 data_size -= line_size;
966 static void mkv_write_block(AVFormatContext *s, AVIOContext *pb,
967 unsigned int blockid, AVPacket *pkt, int flags)
969 MatroskaMuxContext *mkv = s->priv_data;
970 AVCodecContext *codec = s->streams[pkt->stream_index]->codec;
971 uint8_t *data = NULL;
972 int size = pkt->size;
973 int64_t ts = mkv->tracks[pkt->stream_index].write_dts ? pkt->dts : pkt->pts;
975 av_log(s, AV_LOG_DEBUG, "Writing block at offset %" PRIu64 ", size %d, "
976 "pts %" PRId64 ", dts %" PRId64 ", duration %d, flags %d\n",
977 avio_tell(pb), pkt->size, pkt->pts, pkt->dts, pkt->duration, flags);
978 if (codec->codec_id == CODEC_ID_H264 && codec->extradata_size > 0 &&
979 (AV_RB24(codec->extradata) == 1 || AV_RB32(codec->extradata) == 1))
980 ff_avc_parse_nal_units_buf(pkt->data, &data, &size);
983 put_ebml_id(pb, blockid);
984 put_ebml_num(pb, size+4, 0);
985 avio_w8(pb, 0x80 | (pkt->stream_index + 1)); // this assumes stream_index is less than 126
986 avio_wb16(pb, ts - mkv->cluster_pts);
988 avio_write(pb, data, size);
989 if (data != pkt->data)
993 static int srt_get_duration(uint8_t **buf)
997 for (i=0; i<2 && !duration; i++) {
998 int s_hour, s_min, s_sec, s_hsec, e_hour, e_min, e_sec, e_hsec;
999 if (sscanf(*buf, "%d:%2d:%2d%*1[,.]%3d --> %d:%2d:%2d%*1[,.]%3d",
1000 &s_hour, &s_min, &s_sec, &s_hsec,
1001 &e_hour, &e_min, &e_sec, &e_hsec) == 8) {
1002 s_min += 60*s_hour; e_min += 60*e_hour;
1003 s_sec += 60*s_min; e_sec += 60*e_min;
1004 s_hsec += 1000*s_sec; e_hsec += 1000*e_sec;
1005 duration = e_hsec - s_hsec;
1007 *buf += strcspn(*buf, "\n") + 1;
1012 static int mkv_write_srt_blocks(AVFormatContext *s, AVIOContext *pb, AVPacket *pkt)
1014 ebml_master blockgroup;
1015 AVPacket pkt2 = *pkt;
1016 int64_t duration = srt_get_duration(&pkt2.data);
1017 pkt2.size -= pkt2.data - pkt->data;
1019 blockgroup = start_ebml_master(pb, MATROSKA_ID_BLOCKGROUP,
1020 mkv_blockgroup_size(pkt2.size));
1021 mkv_write_block(s, pb, MATROSKA_ID_BLOCK, &pkt2, 0);
1022 put_ebml_uint(pb, MATROSKA_ID_BLOCKDURATION, duration);
1023 end_ebml_master(pb, blockgroup);
1028 static void mkv_flush_dynbuf(AVFormatContext *s)
1030 MatroskaMuxContext *mkv = s->priv_data;
1037 bufsize = avio_close_dyn_buf(mkv->dyn_bc, &dyn_buf);
1038 avio_write(s->pb, dyn_buf, bufsize);
1043 static int mkv_write_packet_internal(AVFormatContext *s, AVPacket *pkt)
1045 MatroskaMuxContext *mkv = s->priv_data;
1046 AVIOContext *pb = s->pb;
1047 AVCodecContext *codec = s->streams[pkt->stream_index]->codec;
1048 int keyframe = !!(pkt->flags & AV_PKT_FLAG_KEY);
1049 int duration = pkt->duration;
1051 int64_t ts = mkv->tracks[pkt->stream_index].write_dts ? pkt->dts : pkt->pts;
1053 if (ts == AV_NOPTS_VALUE) {
1054 av_log(s, AV_LOG_ERROR, "Can't write packet with unknown timestamp\n");
1055 return AVERROR(EINVAL);
1058 if (!s->pb->seekable) {
1060 avio_open_dyn_buf(&mkv->dyn_bc);
1064 if (!mkv->cluster_pos) {
1065 mkv->cluster_pos = avio_tell(s->pb);
1066 mkv->cluster = start_ebml_master(pb, MATROSKA_ID_CLUSTER, 0);
1067 put_ebml_uint(pb, MATROSKA_ID_CLUSTERTIMECODE, FFMAX(0, ts));
1068 mkv->cluster_pts = FFMAX(0, ts);
1071 if (codec->codec_type != AVMEDIA_TYPE_SUBTITLE) {
1072 mkv_write_block(s, pb, MATROSKA_ID_SIMPLEBLOCK, pkt, keyframe << 7);
1073 } else if (codec->codec_id == CODEC_ID_SSA) {
1074 duration = mkv_write_ass_blocks(s, pb, pkt);
1075 } else if (codec->codec_id == CODEC_ID_SRT) {
1076 duration = mkv_write_srt_blocks(s, pb, pkt);
1078 ebml_master blockgroup = start_ebml_master(pb, MATROSKA_ID_BLOCKGROUP, mkv_blockgroup_size(pkt->size));
1079 duration = pkt->convergence_duration;
1080 mkv_write_block(s, pb, MATROSKA_ID_BLOCK, pkt, 0);
1081 put_ebml_uint(pb, MATROSKA_ID_BLOCKDURATION, duration);
1082 end_ebml_master(pb, blockgroup);
1085 if (codec->codec_type == AVMEDIA_TYPE_VIDEO && keyframe) {
1086 ret = mkv_add_cuepoint(mkv->cues, pkt->stream_index, ts, mkv->cluster_pos);
1087 if (ret < 0) return ret;
1090 mkv->duration = FFMAX(mkv->duration, ts + duration);
1094 static int mkv_copy_packet(MatroskaMuxContext *mkv, const AVPacket *pkt)
1096 uint8_t *data = mkv->cur_audio_pkt.data;
1097 mkv->cur_audio_pkt = *pkt;
1098 mkv->cur_audio_pkt.data = av_fast_realloc(data, &mkv->audio_buffer_size, pkt->size);
1099 if (!mkv->cur_audio_pkt.data)
1100 return AVERROR(ENOMEM);
1102 memcpy(mkv->cur_audio_pkt.data, pkt->data, pkt->size);
1103 mkv->cur_audio_pkt.size = pkt->size;
1107 static int mkv_write_packet(AVFormatContext *s, AVPacket *pkt)
1109 MatroskaMuxContext *mkv = s->priv_data;
1110 AVIOContext *pb = s->pb->seekable ? s->pb : mkv->dyn_bc;
1111 AVCodecContext *codec = s->streams[pkt->stream_index]->codec;
1112 int ret, keyframe = !!(pkt->flags & AV_PKT_FLAG_KEY);
1113 int64_t ts = mkv->tracks[pkt->stream_index].write_dts ? pkt->dts : pkt->pts;
1114 int cluster_size = avio_tell(pb) - (s->pb->seekable ? mkv->cluster_pos : 0);
1116 // start a new cluster every 5 MB or 5 sec, or 32k / 1 sec for streaming or
1117 // after 4k and on a keyframe
1118 if (mkv->cluster_pos &&
1119 ((!s->pb->seekable && (cluster_size > 32*1024 || ts > mkv->cluster_pts + 1000))
1120 || cluster_size > 5*1024*1024 || ts > mkv->cluster_pts + 5000
1121 || (codec->codec_type == AVMEDIA_TYPE_VIDEO && keyframe && cluster_size > 4*1024))) {
1122 av_log(s, AV_LOG_DEBUG, "Starting new cluster at offset %" PRIu64
1123 " bytes, pts %" PRIu64 "\n", avio_tell(pb), ts);
1124 end_ebml_master(pb, mkv->cluster);
1125 mkv->cluster_pos = 0;
1127 mkv_flush_dynbuf(s);
1130 // check if we have an audio packet cached
1131 if (mkv->cur_audio_pkt.size > 0) {
1132 ret = mkv_write_packet_internal(s, &mkv->cur_audio_pkt);
1133 mkv->cur_audio_pkt.size = 0;
1135 av_log(s, AV_LOG_ERROR, "Could not write cached audio packet ret:%d\n", ret);
1140 // buffer an audio packet to ensure the packet containing the video
1141 // keyframe's timecode is contained in the same cluster for WebM
1142 if (codec->codec_type == AVMEDIA_TYPE_AUDIO)
1143 ret = mkv_copy_packet(mkv, pkt);
1145 ret = mkv_write_packet_internal(s, pkt);
1149 static int mkv_write_trailer(AVFormatContext *s)
1151 MatroskaMuxContext *mkv = s->priv_data;
1152 AVIOContext *pb = s->pb;
1153 int64_t currentpos, cuespos;
1156 // check if we have an audio packet cached
1157 if (mkv->cur_audio_pkt.size > 0) {
1158 ret = mkv_write_packet_internal(s, &mkv->cur_audio_pkt);
1159 mkv->cur_audio_pkt.size = 0;
1161 av_log(s, AV_LOG_ERROR, "Could not write cached audio packet ret:%d\n", ret);
1167 end_ebml_master(mkv->dyn_bc, mkv->cluster);
1168 mkv_flush_dynbuf(s);
1169 } else if (mkv->cluster_pos) {
1170 end_ebml_master(pb, mkv->cluster);
1174 if (mkv->cues->num_entries) {
1175 cuespos = mkv_write_cues(pb, mkv->cues, s->nb_streams);
1177 ret = mkv_add_seekhead_entry(mkv->main_seekhead, MATROSKA_ID_CUES, cuespos);
1178 if (ret < 0) return ret;
1181 mkv_write_seekhead(pb, mkv->main_seekhead);
1183 // update the duration
1184 av_log(s, AV_LOG_DEBUG, "end duration = %" PRIu64 "\n", mkv->duration);
1185 currentpos = avio_tell(pb);
1186 avio_seek(pb, mkv->duration_offset, SEEK_SET);
1187 put_ebml_float(pb, MATROSKA_ID_DURATION, mkv->duration);
1189 avio_seek(pb, currentpos, SEEK_SET);
1192 end_ebml_master(pb, mkv->segment);
1193 av_free(mkv->tracks);
1194 av_freep(&mkv->cues->entries);
1195 av_freep(&mkv->cues);
1196 av_destruct_packet(&mkv->cur_audio_pkt);
1201 #if CONFIG_MATROSKA_MUXER
1202 AVOutputFormat ff_matroska_muxer = {
1204 .long_name = NULL_IF_CONFIG_SMALL("Matroska file format"),
1205 .mime_type = "video/x-matroska",
1206 .extensions = "mkv",
1207 .priv_data_size = sizeof(MatroskaMuxContext),
1208 .audio_codec = CODEC_ID_MP2,
1209 .video_codec = CODEC_ID_MPEG4,
1210 .write_header = mkv_write_header,
1211 .write_packet = mkv_write_packet,
1212 .write_trailer = mkv_write_trailer,
1213 .flags = AVFMT_GLOBALHEADER | AVFMT_VARIABLE_FPS,
1214 .codec_tag = (const AVCodecTag* const []){ff_codec_bmp_tags, ff_codec_wav_tags, 0},
1215 .subtitle_codec = CODEC_ID_SSA,
1219 #if CONFIG_WEBM_MUXER
1220 AVOutputFormat ff_webm_muxer = {
1222 .long_name = NULL_IF_CONFIG_SMALL("WebM file format"),
1223 .mime_type = "video/webm",
1224 .extensions = "webm",
1225 .priv_data_size = sizeof(MatroskaMuxContext),
1226 .audio_codec = CODEC_ID_VORBIS,
1227 .video_codec = CODEC_ID_VP8,
1228 .write_header = mkv_write_header,
1229 .write_packet = mkv_write_packet,
1230 .write_trailer = mkv_write_trailer,
1231 .flags = AVFMT_GLOBALHEADER | AVFMT_VARIABLE_FPS | AVFMT_TS_NONSTRICT,
1235 #if CONFIG_MATROSKA_AUDIO_MUXER
1236 AVOutputFormat ff_matroska_audio_muxer = {
1238 .long_name = NULL_IF_CONFIG_SMALL("Matroska file format"),
1239 .mime_type = "audio/x-matroska",
1240 .extensions = "mka",
1241 .priv_data_size = sizeof(MatroskaMuxContext),
1242 .audio_codec = CODEC_ID_MP2,
1243 .video_codec = CODEC_ID_NONE,
1244 .write_header = mkv_write_header,
1245 .write_packet = mkv_write_packet,
1246 .write_trailer = mkv_write_trailer,
1247 .flags = AVFMT_GLOBALHEADER,
1248 .codec_tag = (const AVCodecTag* const []){ff_codec_wav_tags, 0},