2 * Live smooth streaming fragmenter
3 * Copyright (c) 2012 Martin Storsjo
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
30 #include "os_support.h"
34 #include "libavutil/opt.h"
35 #include "libavutil/avstring.h"
36 #include "libavutil/mathematics.h"
37 #include "libavutil/intreadwrite.h"
42 int64_t start_time, duration;
44 int64_t start_pos, size;
52 URLContext *out; // Current output stream where all output is written
53 URLContext *out2; // Auxillary output stream where all output also is written
54 URLContext *tail_out; // The actual main output stream, if we're currently seeked back to write elsewhere
55 int64_t tail_pos, cur_pos, cur_start_pos;
57 const char *stream_type_tag;
58 int nb_fragments, fragments_size, fragment_index;
68 const AVClass *class; /* Class for private options. */
70 int extra_window_size;
72 int min_frag_duration;
74 OutputStream *streams;
75 int has_video, has_audio;
77 } SmoothStreamingContext;
79 static int ism_write(void *opaque, uint8_t *buf, int buf_size)
81 OutputStream *os = opaque;
83 ffurl_write(os->out, buf, buf_size);
85 ffurl_write(os->out2, buf, buf_size);
86 os->cur_pos += buf_size;
87 if (os->cur_pos >= os->tail_pos)
88 os->tail_pos = os->cur_pos;
92 static int64_t ism_seek(void *opaque, int64_t offset, int whence)
94 OutputStream *os = opaque;
96 if (whence != SEEK_SET)
97 return AVERROR(ENOSYS);
100 ffurl_close(os->out);
103 ffurl_close(os->out2);
105 os->out = os->tail_out;
109 if (offset >= os->cur_start_pos) {
110 ffurl_seek(os->out, offset - os->cur_start_pos, SEEK_SET);
111 os->cur_pos = offset;
114 for (i = os->nb_fragments - 1; i >= 0; i--) {
115 Fragment *frag = os->fragments[i];
116 if (offset >= frag->start_pos && offset < frag->start_pos + frag->size) {
118 AVDictionary *opts = NULL;
119 os->tail_out = os->out;
120 av_dict_set(&opts, "truncate", "0", 0);
121 ret = ffurl_open(&os->out, frag->file, AVIO_FLAG_READ_WRITE, &os->ctx->interrupt_callback, &opts);
124 os->out = os->tail_out;
128 av_dict_set(&opts, "truncate", "0", 0);
129 ffurl_open(&os->out2, frag->infofile, AVIO_FLAG_READ_WRITE, &os->ctx->interrupt_callback, &opts);
131 ffurl_seek(os->out, offset - frag->start_pos, SEEK_SET);
133 ffurl_seek(os->out2, offset - frag->start_pos, SEEK_SET);
134 os->cur_pos = offset;
141 static void get_private_data(OutputStream *os)
143 AVCodecContext *codec = os->ctx->streams[0]->codec;
144 uint8_t *ptr = codec->extradata;
145 int size = codec->extradata_size;
147 if (codec->codec_id == AV_CODEC_ID_H264) {
148 ff_avc_write_annexb_extradata(ptr, &ptr, &size);
150 ptr = codec->extradata;
154 os->private_str = av_mallocz(2*size + 1);
155 for (i = 0; i < size; i++)
156 snprintf(&os->private_str[2*i], 3, "%02x", ptr[i]);
157 if (ptr != codec->extradata)
161 static void ism_free(AVFormatContext *s)
163 SmoothStreamingContext *c = s->priv_data;
167 for (i = 0; i < s->nb_streams; i++) {
168 OutputStream *os = &c->streams[i];
169 ffurl_close(os->out);
170 ffurl_close(os->out2);
171 ffurl_close(os->tail_out);
172 os->out = os->out2 = os->tail_out = NULL;
173 if (os->ctx && os->ctx_inited)
174 av_write_trailer(os->ctx);
175 if (os->ctx && os->ctx->pb)
176 av_free(os->ctx->pb);
178 avformat_free_context(os->ctx);
179 av_free(os->private_str);
180 for (j = 0; j < os->nb_fragments; j++)
181 av_free(os->fragments[j]);
182 av_free(os->fragments);
184 av_freep(&c->streams);
187 static int ism_write_header(AVFormatContext *s)
189 SmoothStreamingContext *c = s->priv_data;
191 AVOutputFormat *oformat;
193 ret = mkdir(s->filename, 0777);
195 av_log(s, AV_LOG_ERROR, "mkdir(%s): %s\n", s->filename, strerror(errno));
196 return AVERROR(errno);
200 oformat = av_guess_format("ismv", NULL, NULL);
202 ret = AVERROR_MUXER_NOT_FOUND;
206 c->streams = av_mallocz(sizeof(*c->streams) * s->nb_streams);
208 ret = AVERROR(ENOMEM);
212 for (i = 0; i < s->nb_streams; i++) {
213 OutputStream *os = &c->streams[i];
214 AVFormatContext *ctx;
216 AVDictionary *opts = NULL;
219 if (!s->streams[i]->codec->bit_rate) {
220 av_log(s, AV_LOG_ERROR, "No bit rate set for stream %d\n", i);
221 ret = AVERROR(EINVAL);
224 snprintf(os->dirname, sizeof(os->dirname), "%s/QualityLevels(%d)", s->filename, s->streams[i]->codec->bit_rate);
225 mkdir(os->dirname, 0777);
227 ctx = avformat_alloc_context();
229 ret = AVERROR(ENOMEM);
233 ctx->oformat = oformat;
234 ctx->interrupt_callback = s->interrupt_callback;
236 if (!(st = avformat_new_stream(ctx, NULL))) {
237 ret = AVERROR(ENOMEM);
240 avcodec_copy_context(st->codec, s->streams[i]->codec);
242 ctx->pb = avio_alloc_context(os->iobuf, sizeof(os->iobuf), AVIO_FLAG_WRITE, os, NULL, ism_write, ism_seek);
244 ret = AVERROR(ENOMEM);
248 snprintf(buf, sizeof(buf), "%d", c->lookahead_count);
249 av_dict_set(&opts, "ism_lookahead", buf, 0);
250 av_dict_set(&opts, "movflags", "frag_custom", 0);
251 if ((ret = avformat_write_header(ctx, &opts)) < 0) {
257 s->streams[i]->time_base = st->time_base;
258 if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
260 os->stream_type_tag = "video";
261 if (st->codec->codec_id == AV_CODEC_ID_H264) {
263 } else if (st->codec->codec_id == AV_CODEC_ID_VC1) {
266 av_log(s, AV_LOG_ERROR, "Unsupported video codec\n");
267 ret = AVERROR(EINVAL);
272 os->stream_type_tag = "audio";
273 if (st->codec->codec_id == AV_CODEC_ID_AAC) {
275 os->audio_tag = 0xff;
276 } else if (st->codec->codec_id == AV_CODEC_ID_WMAPRO) {
278 os->audio_tag = 0x0162;
280 av_log(s, AV_LOG_ERROR, "Unsupported audio codec\n");
281 ret = AVERROR(EINVAL);
284 os->packet_size = st->codec->block_align ? st->codec->block_align : 4;
286 get_private_data(os);
289 if (!c->has_video && c->min_frag_duration <= 0) {
290 av_log(s, AV_LOG_WARNING, "no video stream and no min frag duration set\n");
291 ret = AVERROR(EINVAL);
300 static int parse_fragment(AVFormatContext *s, const char *filename, int64_t *start_ts, int64_t *duration, int64_t *moof_size, int64_t size)
305 if ((ret = avio_open2(&in, filename, AVIO_FLAG_READ, &s->interrupt_callback, NULL)) < 0)
308 *moof_size = avio_rb32(in);
309 if (*moof_size < 8 || *moof_size > size)
311 if (avio_rl32(in) != MKTAG('m','o','o','f'))
314 if (len > *moof_size)
316 if (avio_rl32(in) != MKTAG('m','f','h','d'))
318 avio_seek(in, len - 8, SEEK_CUR);
319 avio_rb32(in); /* traf size */
320 if (avio_rl32(in) != MKTAG('t','r','a','f'))
322 while (avio_tell(in) < *moof_size) {
323 uint32_t len = avio_rb32(in);
324 uint32_t tag = avio_rl32(in);
325 int64_t end = avio_tell(in) + len - 8;
326 if (len < 8 || len >= *moof_size)
328 if (tag == MKTAG('u','u','i','d')) {
329 const uint8_t tfxd[] = {
330 0x6d, 0x1d, 0x9b, 0x05, 0x42, 0xd5, 0x44, 0xe6,
331 0x80, 0xe2, 0x14, 0x1d, 0xaf, 0xf7, 0x57, 0xb2
334 avio_read(in, uuid, 16);
335 if (!memcmp(uuid, tfxd, 16) && len >= 8 + 16 + 4 + 16) {
336 avio_seek(in, 4, SEEK_CUR);
337 *start_ts = avio_rb64(in);
338 *duration = avio_rb64(in);
343 avio_seek(in, end, SEEK_SET);
350 static int add_fragment(OutputStream *os, const char *file, const char *infofile, int64_t start_time, int64_t duration, int64_t start_pos, int64_t size)
353 if (os->nb_fragments >= os->fragments_size) {
354 os->fragments_size = (os->fragments_size + 1) * 2;
355 os->fragments = av_realloc(os->fragments, sizeof(*os->fragments)*os->fragments_size);
357 return AVERROR(ENOMEM);
359 frag = av_mallocz(sizeof(*frag));
361 return AVERROR(ENOMEM);
362 av_strlcpy(frag->file, file, sizeof(frag->file));
363 av_strlcpy(frag->infofile, infofile, sizeof(frag->infofile));
364 frag->start_time = start_time;
365 frag->duration = duration;
366 frag->start_pos = start_pos;
368 frag->n = os->fragment_index;
369 os->fragments[os->nb_fragments++] = frag;
370 os->fragment_index++;
374 static int copy_moof(AVFormatContext *s, const char* infile, const char *outfile, int64_t size)
376 AVIOContext *in, *out;
378 if ((ret = avio_open2(&in, infile, AVIO_FLAG_READ, &s->interrupt_callback, NULL)) < 0)
380 if ((ret = avio_open2(&out, outfile, AVIO_FLAG_WRITE, &s->interrupt_callback, NULL)) < 0) {
386 int n = FFMIN(size, sizeof(buf));
387 n = avio_read(in, buf, n);
392 avio_write(out, buf, n);
401 static void output_chunk_list(OutputStream *os, AVIOContext *out, int final, int skip, int window_size)
403 int removed = 0, i, start = 0;
404 if (os->nb_fragments <= 0)
406 if (os->fragments[0]->n > 0)
411 start = FFMAX(os->nb_fragments - skip - window_size, 0);
412 for (i = start; i < os->nb_fragments - skip; i++) {
413 Fragment *frag = os->fragments[i];
414 if (!final || removed)
415 avio_printf(out, "<c t=\"%"PRIu64"\" d=\"%"PRIu64"\" />\n", frag->start_time, frag->duration);
417 avio_printf(out, "<c n=\"%d\" d=\"%"PRIu64"\" />\n", frag->n, frag->duration);
421 static int write_manifest(AVFormatContext *s, int final)
423 SmoothStreamingContext *c = s->priv_data;
426 int ret, i, video_chunks = 0, audio_chunks = 0, video_streams = 0, audio_streams = 0;
427 int64_t duration = 0;
429 snprintf(filename, sizeof(filename), "%s/Manifest", s->filename);
430 ret = avio_open2(&out, filename, AVIO_FLAG_WRITE, &s->interrupt_callback, NULL);
433 avio_printf(out, "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n");
434 for (i = 0; i < s->nb_streams; i++) {
435 OutputStream *os = &c->streams[i];
436 if (os->nb_fragments > 0) {
437 Fragment *last = os->fragments[os->nb_fragments - 1];
438 duration = last->start_time + last->duration;
440 if (s->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
441 video_chunks = os->nb_fragments;
444 audio_chunks = os->nb_fragments;
450 video_chunks = audio_chunks = 0;
452 if (c->window_size) {
453 video_chunks = FFMIN(video_chunks, c->window_size);
454 audio_chunks = FFMIN(audio_chunks, c->window_size);
456 avio_printf(out, "<SmoothStreamingMedia MajorVersion=\"2\" MinorVersion=\"0\" Duration=\"%"PRIu64"\"", duration);
458 avio_printf(out, " IsLive=\"true\" LookAheadFragmentCount=\"%d\" DVRWindowLength=\"0\"", c->lookahead_count);
459 avio_printf(out, ">\n");
461 int last = -1, index = 0;
462 avio_printf(out, "<StreamIndex Type=\"video\" QualityLevels=\"%d\" Chunks=\"%d\" Url=\"QualityLevels({bitrate})/Fragments(video={start time})\">\n", video_streams, video_chunks);
463 for (i = 0; i < s->nb_streams; i++) {
464 OutputStream *os = &c->streams[i];
465 if (s->streams[i]->codec->codec_type != AVMEDIA_TYPE_VIDEO)
468 avio_printf(out, "<QualityLevel Index=\"%d\" Bitrate=\"%d\" FourCC=\"%s\" MaxWidth=\"%d\" MaxHeight=\"%d\" CodecPrivateData=\"%s\" />\n", index, s->streams[i]->codec->bit_rate, os->fourcc, s->streams[i]->codec->width, s->streams[i]->codec->height, os->private_str);
471 output_chunk_list(&c->streams[last], out, final, c->lookahead_count, c->window_size);
472 avio_printf(out, "</StreamIndex>\n");
475 int last = -1, index = 0;
476 avio_printf(out, "<StreamIndex Type=\"audio\" QualityLevels=\"%d\" Chunks=\"%d\" Url=\"QualityLevels({bitrate})/Fragments(audio={start time})\">\n", audio_streams, audio_chunks);
477 for (i = 0; i < s->nb_streams; i++) {
478 OutputStream *os = &c->streams[i];
479 if (s->streams[i]->codec->codec_type != AVMEDIA_TYPE_AUDIO)
482 avio_printf(out, "<QualityLevel Index=\"%d\" Bitrate=\"%d\" FourCC=\"%s\" SamplingRate=\"%d\" Channels=\"%d\" BitsPerSample=\"16\" PacketSize=\"%d\" AudioTag=\"%d\" CodecPrivateData=\"%s\" />\n", index, s->streams[i]->codec->bit_rate, os->fourcc, s->streams[i]->codec->sample_rate, s->streams[i]->codec->channels, os->packet_size, os->audio_tag, os->private_str);
485 output_chunk_list(&c->streams[last], out, final, c->lookahead_count, c->window_size);
486 avio_printf(out, "</StreamIndex>\n");
488 avio_printf(out, "</SmoothStreamingMedia>\n");
494 static int ism_flush(AVFormatContext *s, int final)
496 SmoothStreamingContext *c = s->priv_data;
499 for (i = 0; i < s->nb_streams; i++) {
500 OutputStream *os = &c->streams[i];
501 char filename[1024], target_filename[1024], header_filename[1024];
502 int64_t start_pos = os->tail_pos, size;
503 int64_t start_ts, duration, moof_size;
504 if (!os->packets_written)
507 snprintf(filename, sizeof(filename), "%s/temp", os->dirname);
508 ret = ffurl_open(&os->out, filename, AVIO_FLAG_WRITE, &s->interrupt_callback, NULL);
511 os->cur_start_pos = os->tail_pos;
512 av_write_frame(os->ctx, NULL);
513 avio_flush(os->ctx->pb);
514 os->packets_written = 0;
515 if (!os->out || os->tail_out)
518 ffurl_close(os->out);
520 size = os->tail_pos - start_pos;
521 if ((ret = parse_fragment(s, filename, &start_ts, &duration, &moof_size, size)) < 0)
523 snprintf(header_filename, sizeof(header_filename), "%s/FragmentInfo(%s=%"PRIu64")", os->dirname, os->stream_type_tag, start_ts);
524 snprintf(target_filename, sizeof(target_filename), "%s/Fragments(%s=%"PRIu64")", os->dirname, os->stream_type_tag, start_ts);
525 copy_moof(s, filename, header_filename, moof_size);
526 rename(filename, target_filename);
527 add_fragment(os, target_filename, header_filename, start_ts, duration, start_pos, size);
530 if (c->window_size || (final && c->remove_at_exit)) {
531 for (i = 0; i < s->nb_streams; i++) {
532 OutputStream *os = &c->streams[i];
534 int remove = os->nb_fragments - c->window_size - c->extra_window_size - c->lookahead_count;
535 if (final && c->remove_at_exit)
536 remove = os->nb_fragments;
538 for (j = 0; j < remove; j++) {
539 unlink(os->fragments[j]->file);
540 unlink(os->fragments[j]->infofile);
541 av_free(os->fragments[j]);
543 os->nb_fragments -= remove;
544 memmove(os->fragments, os->fragments + remove, os->nb_fragments * sizeof(*os->fragments));
546 if (final && c->remove_at_exit)
551 write_manifest(s, final);
555 static int ism_write_packet(AVFormatContext *s, AVPacket *pkt)
557 SmoothStreamingContext *c = s->priv_data;
558 AVStream *st = s->streams[pkt->stream_index];
559 OutputStream *os = &c->streams[pkt->stream_index];
560 int64_t end_pts = (c->nb_fragments + 1) * c->min_frag_duration;
562 if ((!c->has_video || st->codec->codec_type == AVMEDIA_TYPE_VIDEO) &&
563 av_compare_ts(pkt->pts, st->time_base,
564 end_pts, AV_TIME_BASE_Q) >= 0 &&
565 pkt->flags & AV_PKT_FLAG_KEY && os->packets_written) {
571 os->packets_written++;
572 return ff_write_chained(os->ctx, 0, pkt, s);
575 static int ism_write_trailer(AVFormatContext *s)
577 SmoothStreamingContext *c = s->priv_data;
580 if (c->remove_at_exit) {
582 snprintf(filename, sizeof(filename), "%s/Manifest", s->filename);
591 #define OFFSET(x) offsetof(SmoothStreamingContext, x)
592 #define E AV_OPT_FLAG_ENCODING_PARAM
593 static const AVOption options[] = {
594 { "window_size", "number of fragments kept in the manifest", OFFSET(window_size), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, E },
595 { "extra_window_size", "number of fragments kept outside of the manifest before removing from disk", OFFSET(extra_window_size), AV_OPT_TYPE_INT, { .i64 = 5 }, 0, INT_MAX, E },
596 { "lookahead_count", "number of lookahead fragments", OFFSET(lookahead_count), AV_OPT_TYPE_INT, { .i64 = 2 }, 0, INT_MAX, E },
597 { "min_frag_duration", "minimum fragment duration (in microseconds)", OFFSET(min_frag_duration), AV_OPT_TYPE_INT64, { .i64 = 5000000 }, 0, INT_MAX, E },
598 { "remove_at_exit", "remove all fragments when finished", OFFSET(remove_at_exit), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, E },
602 static const AVClass ism_class = {
603 .class_name = "smooth streaming muxer",
604 .item_name = av_default_item_name,
606 .version = LIBAVUTIL_VERSION_INT,
610 AVOutputFormat ff_smoothstreaming_muxer = {
611 .name = "smoothstreaming",
612 .long_name = NULL_IF_CONFIG_SMALL("Smooth Streaming Muxer"),
613 .priv_data_size = sizeof(SmoothStreamingContext),
614 .audio_codec = AV_CODEC_ID_AAC,
615 .video_codec = AV_CODEC_ID_H264,
616 .flags = AVFMT_GLOBALHEADER | AVFMT_NOFILE,
617 .write_header = ism_write_header,
618 .write_packet = ism_write_packet,
619 .write_trailer = ism_write_trailer,
620 .priv_class = &ism_class,