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
29 #include "avio_internal.h"
31 #include "os_support.h"
36 #include "libavutil/opt.h"
37 #include "libavutil/avstring.h"
38 #include "libavutil/file.h"
39 #include "libavutil/mathematics.h"
40 #include "libavutil/intreadwrite.h"
42 typedef struct Fragment {
45 int64_t start_time, duration;
47 int64_t start_pos, size;
50 typedef struct OutputStream {
55 URLContext *out; // Current output stream where all output is written
56 URLContext *out2; // Auxiliary output stream where all output is also written
57 URLContext *tail_out; // The actual main output stream, if we're currently seeked back to write elsewhere
58 int64_t tail_pos, cur_pos, cur_start_pos;
60 const char *stream_type_tag;
61 int nb_fragments, fragments_size, fragment_index;
70 typedef struct SmoothStreamingContext {
71 const AVClass *class; /* Class for private options. */
73 int extra_window_size;
75 int min_frag_duration;
77 OutputStream *streams;
78 int has_video, has_audio;
80 } SmoothStreamingContext;
82 static int ism_write(void *opaque, uint8_t *buf, int buf_size)
84 OutputStream *os = opaque;
86 ffurl_write(os->out, buf, buf_size);
88 ffurl_write(os->out2, buf, buf_size);
89 os->cur_pos += buf_size;
90 if (os->cur_pos >= os->tail_pos)
91 os->tail_pos = os->cur_pos;
95 static int64_t ism_seek(void *opaque, int64_t offset, int whence)
97 OutputStream *os = opaque;
99 if (whence != SEEK_SET)
100 return AVERROR(ENOSYS);
103 ffurl_close(os->out);
106 ffurl_close(os->out2);
108 os->out = os->tail_out;
112 if (offset >= os->cur_start_pos) {
114 ffurl_seek(os->out, offset - os->cur_start_pos, SEEK_SET);
115 os->cur_pos = offset;
118 for (i = os->nb_fragments - 1; i >= 0; i--) {
119 Fragment *frag = os->fragments[i];
120 if (offset >= frag->start_pos && offset < frag->start_pos + frag->size) {
122 AVDictionary *opts = NULL;
123 os->tail_out = os->out;
124 av_dict_set(&opts, "truncate", "0", 0);
125 ret = ffurl_open_whitelist(&os->out, frag->file, AVIO_FLAG_WRITE,
126 &os->ctx->interrupt_callback, &opts, os->ctx->protocol_whitelist, os->ctx->protocol_blacklist);
129 os->out = os->tail_out;
133 av_dict_set(&opts, "truncate", "0", 0);
134 ffurl_open_whitelist(&os->out2, frag->infofile, AVIO_FLAG_WRITE,
135 &os->ctx->interrupt_callback, &opts, os->ctx->protocol_whitelist, os->ctx->protocol_blacklist);
137 ffurl_seek(os->out, offset - frag->start_pos, SEEK_SET);
139 ffurl_seek(os->out2, offset - frag->start_pos, SEEK_SET);
140 os->cur_pos = offset;
147 static void get_private_data(OutputStream *os)
149 AVCodecParameters *par = os->ctx->streams[0]->codecpar;
150 uint8_t *ptr = par->extradata;
151 int size = par->extradata_size;
153 if (par->codec_id == AV_CODEC_ID_H264) {
154 ff_avc_write_annexb_extradata(ptr, &ptr, &size);
156 ptr = par->extradata;
160 os->private_str = av_mallocz(2*size + 1);
161 if (!os->private_str)
163 for (i = 0; i < size; i++)
164 snprintf(&os->private_str[2*i], 3, "%02x", ptr[i]);
166 if (ptr != par->extradata)
170 static void ism_free(AVFormatContext *s)
172 SmoothStreamingContext *c = s->priv_data;
176 for (i = 0; i < s->nb_streams; i++) {
177 OutputStream *os = &c->streams[i];
178 ffurl_close(os->out);
179 ffurl_close(os->out2);
180 ffurl_close(os->tail_out);
181 os->out = os->out2 = os->tail_out = NULL;
182 if (os->ctx && os->ctx_inited)
183 av_write_trailer(os->ctx);
184 if (os->ctx && os->ctx->pb)
185 av_freep(&os->ctx->pb);
187 avformat_free_context(os->ctx);
188 av_freep(&os->private_str);
189 for (j = 0; j < os->nb_fragments; j++)
190 av_freep(&os->fragments[j]);
191 av_freep(&os->fragments);
193 av_freep(&c->streams);
196 static void output_chunk_list(OutputStream *os, AVIOContext *out, int final, int skip, int window_size)
198 int removed = 0, i, start = 0;
199 if (os->nb_fragments <= 0)
201 if (os->fragments[0]->n > 0)
206 start = FFMAX(os->nb_fragments - skip - window_size, 0);
207 for (i = start; i < os->nb_fragments - skip; i++) {
208 Fragment *frag = os->fragments[i];
209 if (!final || removed)
210 avio_printf(out, "<c t=\"%"PRIu64"\" d=\"%"PRIu64"\" />\n", frag->start_time, frag->duration);
212 avio_printf(out, "<c n=\"%d\" d=\"%"PRIu64"\" />\n", frag->n, frag->duration);
216 static int write_manifest(AVFormatContext *s, int final)
218 SmoothStreamingContext *c = s->priv_data;
220 char filename[1024], temp_filename[1024];
221 int ret, i, video_chunks = 0, audio_chunks = 0, video_streams = 0, audio_streams = 0;
222 int64_t duration = 0;
224 snprintf(filename, sizeof(filename), "%s/Manifest", s->filename);
225 snprintf(temp_filename, sizeof(temp_filename), "%s/Manifest.tmp", s->filename);
226 ret = s->io_open(s, &out, temp_filename, AVIO_FLAG_WRITE, NULL);
228 av_log(s, AV_LOG_ERROR, "Unable to open %s for writing\n", temp_filename);
231 avio_printf(out, "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n");
232 for (i = 0; i < s->nb_streams; i++) {
233 OutputStream *os = &c->streams[i];
234 if (os->nb_fragments > 0) {
235 Fragment *last = os->fragments[os->nb_fragments - 1];
236 duration = last->start_time + last->duration;
238 if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
239 video_chunks = os->nb_fragments;
242 audio_chunks = os->nb_fragments;
248 video_chunks = audio_chunks = 0;
250 if (c->window_size) {
251 video_chunks = FFMIN(video_chunks, c->window_size);
252 audio_chunks = FFMIN(audio_chunks, c->window_size);
254 avio_printf(out, "<SmoothStreamingMedia MajorVersion=\"2\" MinorVersion=\"0\" Duration=\"%"PRIu64"\"", duration);
256 avio_printf(out, " IsLive=\"true\" LookAheadFragmentCount=\"%d\" DVRWindowLength=\"0\"", c->lookahead_count);
257 avio_printf(out, ">\n");
259 int last = -1, index = 0;
260 avio_printf(out, "<StreamIndex Type=\"video\" QualityLevels=\"%d\" Chunks=\"%d\" Url=\"QualityLevels({bitrate})/Fragments(video={start time})\">\n", video_streams, video_chunks);
261 for (i = 0; i < s->nb_streams; i++) {
262 OutputStream *os = &c->streams[i];
263 if (s->streams[i]->codecpar->codec_type != AVMEDIA_TYPE_VIDEO)
266 avio_printf(out, "<QualityLevel Index=\"%d\" Bitrate=\"%"PRId64"\" FourCC=\"%s\" MaxWidth=\"%d\" MaxHeight=\"%d\" CodecPrivateData=\"%s\" />\n", index, (int64_t)s->streams[i]->codecpar->bit_rate, os->fourcc, s->streams[i]->codecpar->width, s->streams[i]->codecpar->height, os->private_str);
269 output_chunk_list(&c->streams[last], out, final, c->lookahead_count, c->window_size);
270 avio_printf(out, "</StreamIndex>\n");
273 int last = -1, index = 0;
274 avio_printf(out, "<StreamIndex Type=\"audio\" QualityLevels=\"%d\" Chunks=\"%d\" Url=\"QualityLevels({bitrate})/Fragments(audio={start time})\">\n", audio_streams, audio_chunks);
275 for (i = 0; i < s->nb_streams; i++) {
276 OutputStream *os = &c->streams[i];
277 if (s->streams[i]->codecpar->codec_type != AVMEDIA_TYPE_AUDIO)
280 avio_printf(out, "<QualityLevel Index=\"%d\" Bitrate=\"%"PRId64"\" FourCC=\"%s\" SamplingRate=\"%d\" Channels=\"%d\" BitsPerSample=\"16\" PacketSize=\"%d\" AudioTag=\"%d\" CodecPrivateData=\"%s\" />\n", index, (int64_t)s->streams[i]->codecpar->bit_rate, os->fourcc, s->streams[i]->codecpar->sample_rate, s->streams[i]->codecpar->channels, os->packet_size, os->audio_tag, os->private_str);
283 output_chunk_list(&c->streams[last], out, final, c->lookahead_count, c->window_size);
284 avio_printf(out, "</StreamIndex>\n");
286 avio_printf(out, "</SmoothStreamingMedia>\n");
288 ff_format_io_close(s, &out);
289 return ff_rename(temp_filename, filename, s);
292 static int ism_write_header(AVFormatContext *s)
294 SmoothStreamingContext *c = s->priv_data;
296 AVOutputFormat *oformat;
298 if (mkdir(s->filename, 0777) == -1 && errno != EEXIST) {
299 ret = AVERROR(errno);
300 av_log(s, AV_LOG_ERROR, "mkdir failed\n");
304 oformat = av_guess_format("ismv", NULL, NULL);
306 ret = AVERROR_MUXER_NOT_FOUND;
310 c->streams = av_mallocz_array(s->nb_streams, sizeof(*c->streams));
312 ret = AVERROR(ENOMEM);
316 for (i = 0; i < s->nb_streams; i++) {
317 OutputStream *os = &c->streams[i];
318 AVFormatContext *ctx;
320 AVDictionary *opts = NULL;
322 if (!s->streams[i]->codecpar->bit_rate) {
323 av_log(s, AV_LOG_ERROR, "No bit rate set for stream %d\n", i);
324 ret = AVERROR(EINVAL);
327 snprintf(os->dirname, sizeof(os->dirname), "%s/QualityLevels(%"PRId64")", s->filename, (int64_t)s->streams[i]->codecpar->bit_rate);
328 if (mkdir(os->dirname, 0777) == -1 && errno != EEXIST) {
329 ret = AVERROR(errno);
330 av_log(s, AV_LOG_ERROR, "mkdir failed\n");
334 ctx = avformat_alloc_context();
335 if (!ctx || ff_copy_whiteblacklists(ctx, s) < 0) {
336 ret = AVERROR(ENOMEM);
340 ctx->oformat = oformat;
341 ctx->interrupt_callback = s->interrupt_callback;
343 if (!(st = avformat_new_stream(ctx, NULL))) {
344 ret = AVERROR(ENOMEM);
347 avcodec_parameters_copy(st->codecpar, s->streams[i]->codecpar);
348 st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
349 st->time_base = s->streams[i]->time_base;
351 ctx->pb = avio_alloc_context(os->iobuf, sizeof(os->iobuf), AVIO_FLAG_WRITE, os, NULL, ism_write, ism_seek);
353 ret = AVERROR(ENOMEM);
357 av_dict_set_int(&opts, "ism_lookahead", c->lookahead_count, 0);
358 av_dict_set(&opts, "movflags", "frag_custom", 0);
359 if ((ret = avformat_write_header(ctx, &opts)) < 0) {
365 s->streams[i]->time_base = st->time_base;
366 if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
368 os->stream_type_tag = "video";
369 if (st->codecpar->codec_id == AV_CODEC_ID_H264) {
371 } else if (st->codecpar->codec_id == AV_CODEC_ID_VC1) {
374 av_log(s, AV_LOG_ERROR, "Unsupported video codec\n");
375 ret = AVERROR(EINVAL);
380 os->stream_type_tag = "audio";
381 if (st->codecpar->codec_id == AV_CODEC_ID_AAC) {
383 os->audio_tag = 0xff;
384 } else if (st->codecpar->codec_id == AV_CODEC_ID_WMAPRO) {
386 os->audio_tag = 0x0162;
388 av_log(s, AV_LOG_ERROR, "Unsupported audio codec\n");
389 ret = AVERROR(EINVAL);
392 os->packet_size = st->codecpar->block_align ? st->codecpar->block_align : 4;
394 get_private_data(os);
397 if (!c->has_video && c->min_frag_duration <= 0) {
398 av_log(s, AV_LOG_WARNING, "no video stream and no min frag duration set\n");
399 ret = AVERROR(EINVAL);
402 ret = write_manifest(s, 0);
410 static int parse_fragment(AVFormatContext *s, const char *filename, int64_t *start_ts, int64_t *duration, int64_t *moof_size, int64_t size)
415 if ((ret = s->io_open(s, &in, filename, AVIO_FLAG_READ, NULL)) < 0)
418 *moof_size = avio_rb32(in);
419 if (*moof_size < 8 || *moof_size > size)
421 if (avio_rl32(in) != MKTAG('m','o','o','f'))
424 if (len > *moof_size)
426 if (avio_rl32(in) != MKTAG('m','f','h','d'))
428 avio_seek(in, len - 8, SEEK_CUR);
429 avio_rb32(in); /* traf size */
430 if (avio_rl32(in) != MKTAG('t','r','a','f'))
432 while (avio_tell(in) < *moof_size) {
433 uint32_t len = avio_rb32(in);
434 uint32_t tag = avio_rl32(in);
435 int64_t end = avio_tell(in) + len - 8;
436 if (len < 8 || len >= *moof_size)
438 if (tag == MKTAG('u','u','i','d')) {
439 static const uint8_t tfxd[] = {
440 0x6d, 0x1d, 0x9b, 0x05, 0x42, 0xd5, 0x44, 0xe6,
441 0x80, 0xe2, 0x14, 0x1d, 0xaf, 0xf7, 0x57, 0xb2
444 avio_read(in, uuid, 16);
445 if (!memcmp(uuid, tfxd, 16) && len >= 8 + 16 + 4 + 16) {
446 avio_seek(in, 4, SEEK_CUR);
447 *start_ts = avio_rb64(in);
448 *duration = avio_rb64(in);
453 avio_seek(in, end, SEEK_SET);
456 ff_format_io_close(s, &in);
460 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)
464 if (os->nb_fragments >= os->fragments_size) {
465 os->fragments_size = (os->fragments_size + 1) * 2;
466 if ((err = av_reallocp(&os->fragments, sizeof(*os->fragments) *
467 os->fragments_size)) < 0) {
468 os->fragments_size = 0;
469 os->nb_fragments = 0;
473 frag = av_mallocz(sizeof(*frag));
475 return AVERROR(ENOMEM);
476 av_strlcpy(frag->file, file, sizeof(frag->file));
477 av_strlcpy(frag->infofile, infofile, sizeof(frag->infofile));
478 frag->start_time = start_time;
479 frag->duration = duration;
480 frag->start_pos = start_pos;
482 frag->n = os->fragment_index;
483 os->fragments[os->nb_fragments++] = frag;
484 os->fragment_index++;
488 static int copy_moof(AVFormatContext *s, const char* infile, const char *outfile, int64_t size)
490 AVIOContext *in, *out;
492 if ((ret = s->io_open(s, &in, infile, AVIO_FLAG_READ, NULL)) < 0)
494 if ((ret = s->io_open(s, &out, outfile, AVIO_FLAG_WRITE, NULL)) < 0) {
495 ff_format_io_close(s, &in);
500 int n = FFMIN(size, sizeof(buf));
501 n = avio_read(in, buf, n);
506 avio_write(out, buf, n);
510 ff_format_io_close(s, &out);
511 ff_format_io_close(s, &in);
515 static int ism_flush(AVFormatContext *s, int final)
517 SmoothStreamingContext *c = s->priv_data;
520 for (i = 0; i < s->nb_streams; i++) {
521 OutputStream *os = &c->streams[i];
522 char filename[1024], target_filename[1024], header_filename[1024];
524 int64_t start_ts, duration, moof_size;
525 if (!os->packets_written)
528 snprintf(filename, sizeof(filename), "%s/temp", os->dirname);
529 ret = ffurl_open_whitelist(&os->out, filename, AVIO_FLAG_WRITE, &s->interrupt_callback, NULL, s->protocol_whitelist, s->protocol_blacklist);
532 os->cur_start_pos = os->tail_pos;
533 av_write_frame(os->ctx, NULL);
534 avio_flush(os->ctx->pb);
535 os->packets_written = 0;
536 if (!os->out || os->tail_out)
539 ffurl_close(os->out);
541 size = os->tail_pos - os->cur_start_pos;
542 if ((ret = parse_fragment(s, filename, &start_ts, &duration, &moof_size, size)) < 0)
544 snprintf(header_filename, sizeof(header_filename), "%s/FragmentInfo(%s=%"PRIu64")", os->dirname, os->stream_type_tag, start_ts);
545 snprintf(target_filename, sizeof(target_filename), "%s/Fragments(%s=%"PRIu64")", os->dirname, os->stream_type_tag, start_ts);
546 copy_moof(s, filename, header_filename, moof_size);
547 ret = ff_rename(filename, target_filename, s);
550 add_fragment(os, target_filename, header_filename, start_ts, duration,
551 os->cur_start_pos, size);
554 if (c->window_size || (final && c->remove_at_exit)) {
555 for (i = 0; i < s->nb_streams; i++) {
556 OutputStream *os = &c->streams[i];
558 int remove = os->nb_fragments - c->window_size - c->extra_window_size - c->lookahead_count;
559 if (final && c->remove_at_exit)
560 remove = os->nb_fragments;
562 for (j = 0; j < remove; j++) {
563 unlink(os->fragments[j]->file);
564 unlink(os->fragments[j]->infofile);
565 av_freep(&os->fragments[j]);
567 os->nb_fragments -= remove;
568 memmove(os->fragments, os->fragments + remove, os->nb_fragments * sizeof(*os->fragments));
570 if (final && c->remove_at_exit)
576 ret = write_manifest(s, final);
580 static int ism_write_packet(AVFormatContext *s, AVPacket *pkt)
582 SmoothStreamingContext *c = s->priv_data;
583 AVStream *st = s->streams[pkt->stream_index];
584 OutputStream *os = &c->streams[pkt->stream_index];
585 int64_t end_dts = (c->nb_fragments + 1) * (int64_t) c->min_frag_duration;
588 if (st->first_dts == AV_NOPTS_VALUE)
589 st->first_dts = pkt->dts;
591 if ((!c->has_video || st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) &&
592 av_compare_ts(pkt->dts - st->first_dts, st->time_base,
593 end_dts, AV_TIME_BASE_Q) >= 0 &&
594 pkt->flags & AV_PKT_FLAG_KEY && os->packets_written) {
596 if ((ret = ism_flush(s, 0)) < 0)
601 os->packets_written++;
602 return ff_write_chained(os->ctx, 0, pkt, s, 0);
605 static int ism_write_trailer(AVFormatContext *s)
607 SmoothStreamingContext *c = s->priv_data;
610 if (c->remove_at_exit) {
612 snprintf(filename, sizeof(filename), "%s/Manifest", s->filename);
621 #define OFFSET(x) offsetof(SmoothStreamingContext, x)
622 #define E AV_OPT_FLAG_ENCODING_PARAM
623 static const AVOption options[] = {
624 { "window_size", "number of fragments kept in the manifest", OFFSET(window_size), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, E },
625 { "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 },
626 { "lookahead_count", "number of lookahead fragments", OFFSET(lookahead_count), AV_OPT_TYPE_INT, { .i64 = 2 }, 0, INT_MAX, E },
627 { "min_frag_duration", "minimum fragment duration (in microseconds)", OFFSET(min_frag_duration), AV_OPT_TYPE_INT64, { .i64 = 5000000 }, 0, INT_MAX, E },
628 { "remove_at_exit", "remove all fragments when finished", OFFSET(remove_at_exit), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, E },
632 static const AVClass ism_class = {
633 .class_name = "smooth streaming muxer",
634 .item_name = av_default_item_name,
636 .version = LIBAVUTIL_VERSION_INT,
640 AVOutputFormat ff_smoothstreaming_muxer = {
641 .name = "smoothstreaming",
642 .long_name = NULL_IF_CONFIG_SMALL("Smooth Streaming Muxer"),
643 .priv_data_size = sizeof(SmoothStreamingContext),
644 .audio_codec = AV_CODEC_ID_AAC,
645 .video_codec = AV_CODEC_ID_H264,
646 .flags = AVFMT_GLOBALHEADER | AVFMT_NOFILE,
647 .write_header = ism_write_header,
648 .write_packet = ism_write_packet,
649 .write_trailer = ism_write_trailer,
650 .codec_tag = (const AVCodecTag* const []){ ff_mp4_obj_type, 0 },
651 .priv_class = &ism_class,