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 {
54 URLContext *out; // Current output stream where all output is written
55 URLContext *out2; // Auxiliary output stream where all output is also written
56 URLContext *tail_out; // The actual main output stream, if we're currently seeked back to write elsewhere
57 int64_t tail_pos, cur_pos, cur_start_pos;
59 const char *stream_type_tag;
60 int nb_fragments, fragments_size, fragment_index;
69 typedef struct SmoothStreamingContext {
70 const AVClass *class; /* Class for private options. */
72 int extra_window_size;
74 int min_frag_duration;
76 OutputStream *streams;
77 int has_video, has_audio;
79 } SmoothStreamingContext;
81 static int ism_write(void *opaque, uint8_t *buf, int buf_size)
83 OutputStream *os = opaque;
85 ffurl_write(os->out, buf, buf_size);
87 ffurl_write(os->out2, buf, buf_size);
88 os->cur_pos += buf_size;
89 if (os->cur_pos >= os->tail_pos)
90 os->tail_pos = os->cur_pos;
94 static int64_t ism_seek(void *opaque, int64_t offset, int whence)
96 OutputStream *os = opaque;
98 if (whence != SEEK_SET)
99 return AVERROR(ENOSYS);
101 ffurl_closep(&os->out);
102 ffurl_closep(&os->out2);
103 os->out = os->tail_out;
106 if (offset >= os->cur_start_pos) {
108 ffurl_seek(os->out, offset - os->cur_start_pos, SEEK_SET);
109 os->cur_pos = offset;
112 for (i = os->nb_fragments - 1; i >= 0; i--) {
113 Fragment *frag = os->fragments[i];
114 if (offset >= frag->start_pos && offset < frag->start_pos + frag->size) {
116 AVDictionary *opts = NULL;
117 os->tail_out = os->out;
118 av_dict_set(&opts, "truncate", "0", 0);
119 ret = ffurl_open_whitelist(&os->out, frag->file, AVIO_FLAG_WRITE,
120 &os->ctx->interrupt_callback, &opts, os->ctx->protocol_whitelist, os->ctx->protocol_blacklist, NULL);
123 os->out = os->tail_out;
127 av_dict_set(&opts, "truncate", "0", 0);
128 ffurl_open_whitelist(&os->out2, frag->infofile, AVIO_FLAG_WRITE,
129 &os->ctx->interrupt_callback, &opts, os->ctx->protocol_whitelist, os->ctx->protocol_blacklist, NULL);
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 AVCodecParameters *par = os->ctx->streams[0]->codecpar;
144 uint8_t *ptr = par->extradata;
145 int size = par->extradata_size;
147 if (par->codec_id == AV_CODEC_ID_H264) {
148 ff_avc_write_annexb_extradata(ptr, &ptr, &size);
150 ptr = par->extradata;
154 os->private_str = av_mallocz(2*size + 1);
155 if (!os->private_str)
157 for (i = 0; i < size; i++)
158 snprintf(&os->private_str[2*i], 3, "%02x", ptr[i]);
160 if (ptr != par->extradata)
164 static void ism_free(AVFormatContext *s)
166 SmoothStreamingContext *c = s->priv_data;
170 for (i = 0; i < s->nb_streams; i++) {
171 OutputStream *os = &c->streams[i];
172 ffurl_closep(&os->out);
173 ffurl_closep(&os->out2);
174 ffurl_closep(&os->tail_out);
175 if (os->ctx && os->ctx->pb)
176 avio_context_free(&os->ctx->pb);
177 avformat_free_context(os->ctx);
178 av_freep(&os->private_str);
179 for (j = 0; j < os->nb_fragments; j++)
180 av_freep(&os->fragments[j]);
181 av_freep(&os->fragments);
183 av_freep(&c->streams);
186 static void output_chunk_list(OutputStream *os, AVIOContext *out, int final, int skip, int window_size)
188 int removed = 0, i, start = 0;
189 if (os->nb_fragments <= 0)
191 if (os->fragments[0]->n > 0)
196 start = FFMAX(os->nb_fragments - skip - window_size, 0);
197 for (i = start; i < os->nb_fragments - skip; i++) {
198 Fragment *frag = os->fragments[i];
199 if (!final || removed)
200 avio_printf(out, "<c t=\"%"PRIu64"\" d=\"%"PRIu64"\" />\n", frag->start_time, frag->duration);
202 avio_printf(out, "<c n=\"%d\" d=\"%"PRIu64"\" />\n", frag->n, frag->duration);
206 static int write_manifest(AVFormatContext *s, int final)
208 SmoothStreamingContext *c = s->priv_data;
210 char filename[1024], temp_filename[1024];
211 int ret, i, video_chunks = 0, audio_chunks = 0, video_streams = 0, audio_streams = 0;
212 int64_t duration = 0;
214 snprintf(filename, sizeof(filename), "%s/Manifest", s->url);
215 snprintf(temp_filename, sizeof(temp_filename), "%s/Manifest.tmp", s->url);
216 ret = s->io_open(s, &out, temp_filename, AVIO_FLAG_WRITE, NULL);
218 av_log(s, AV_LOG_ERROR, "Unable to open %s for writing\n", temp_filename);
221 avio_printf(out, "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n");
222 for (i = 0; i < s->nb_streams; i++) {
223 OutputStream *os = &c->streams[i];
224 if (os->nb_fragments > 0) {
225 Fragment *last = os->fragments[os->nb_fragments - 1];
226 duration = last->start_time + last->duration;
228 if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
229 video_chunks = os->nb_fragments;
232 audio_chunks = os->nb_fragments;
238 video_chunks = audio_chunks = 0;
240 if (c->window_size) {
241 video_chunks = FFMIN(video_chunks, c->window_size);
242 audio_chunks = FFMIN(audio_chunks, c->window_size);
244 avio_printf(out, "<SmoothStreamingMedia MajorVersion=\"2\" MinorVersion=\"0\" Duration=\"%"PRIu64"\"", duration);
246 avio_printf(out, " IsLive=\"true\" LookAheadFragmentCount=\"%d\" DVRWindowLength=\"0\"", c->lookahead_count);
247 avio_printf(out, ">\n");
249 int last = -1, index = 0;
250 avio_printf(out, "<StreamIndex Type=\"video\" QualityLevels=\"%d\" Chunks=\"%d\" Url=\"QualityLevels({bitrate})/Fragments(video={start time})\">\n", video_streams, video_chunks);
251 for (i = 0; i < s->nb_streams; i++) {
252 OutputStream *os = &c->streams[i];
253 if (s->streams[i]->codecpar->codec_type != AVMEDIA_TYPE_VIDEO)
256 avio_printf(out, "<QualityLevel Index=\"%d\" Bitrate=\"%"PRId64"\" FourCC=\"%s\" MaxWidth=\"%d\" MaxHeight=\"%d\" CodecPrivateData=\"%s\" />\n", index, s->streams[i]->codecpar->bit_rate, os->fourcc, s->streams[i]->codecpar->width, s->streams[i]->codecpar->height, os->private_str);
259 output_chunk_list(&c->streams[last], out, final, c->lookahead_count, c->window_size);
260 avio_printf(out, "</StreamIndex>\n");
263 int last = -1, index = 0;
264 avio_printf(out, "<StreamIndex Type=\"audio\" QualityLevels=\"%d\" Chunks=\"%d\" Url=\"QualityLevels({bitrate})/Fragments(audio={start time})\">\n", audio_streams, audio_chunks);
265 for (i = 0; i < s->nb_streams; i++) {
266 OutputStream *os = &c->streams[i];
267 if (s->streams[i]->codecpar->codec_type != AVMEDIA_TYPE_AUDIO)
270 avio_printf(out, "<QualityLevel Index=\"%d\" Bitrate=\"%"PRId64"\" FourCC=\"%s\" SamplingRate=\"%d\" Channels=\"%d\" BitsPerSample=\"16\" PacketSize=\"%d\" AudioTag=\"%d\" CodecPrivateData=\"%s\" />\n", index, 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);
273 output_chunk_list(&c->streams[last], out, final, c->lookahead_count, c->window_size);
274 avio_printf(out, "</StreamIndex>\n");
276 avio_printf(out, "</SmoothStreamingMedia>\n");
278 ff_format_io_close(s, &out);
279 return ff_rename(temp_filename, filename, s);
282 static int ism_write_header(AVFormatContext *s)
284 SmoothStreamingContext *c = s->priv_data;
286 ff_const59 AVOutputFormat *oformat;
288 if (mkdir(s->url, 0777) == -1 && errno != EEXIST) {
289 av_log(s, AV_LOG_ERROR, "mkdir failed\n");
290 return AVERROR(errno);
293 oformat = av_guess_format("ismv", NULL, NULL);
295 return AVERROR_MUXER_NOT_FOUND;
298 c->streams = av_mallocz_array(s->nb_streams, sizeof(*c->streams));
300 return AVERROR(ENOMEM);
303 for (i = 0; i < s->nb_streams; i++) {
304 OutputStream *os = &c->streams[i];
305 AVFormatContext *ctx;
307 AVDictionary *opts = NULL;
309 if (!s->streams[i]->codecpar->bit_rate) {
310 av_log(s, AV_LOG_WARNING, "No bit rate set for stream %d\n", i);
311 // create a tmp name for the directory of fragments
312 snprintf(os->dirname, sizeof(os->dirname), "%s/QualityLevels(Tmp_%d)", s->url, i);
314 snprintf(os->dirname, sizeof(os->dirname), "%s/QualityLevels(%"PRId64")", s->url, s->streams[i]->codecpar->bit_rate);
317 if (mkdir(os->dirname, 0777) == -1 && errno != EEXIST) {
318 av_log(s, AV_LOG_ERROR, "mkdir failed\n");
319 return AVERROR(errno);
322 os->ctx = ctx = avformat_alloc_context();
324 return AVERROR(ENOMEM);
326 if ((ret = ff_copy_whiteblacklists(ctx, s)) < 0)
328 ctx->oformat = oformat;
329 ctx->interrupt_callback = s->interrupt_callback;
331 if (!(st = avformat_new_stream(ctx, NULL))) {
332 return AVERROR(ENOMEM);
334 avcodec_parameters_copy(st->codecpar, s->streams[i]->codecpar);
335 st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
336 st->time_base = s->streams[i]->time_base;
338 ctx->pb = avio_alloc_context(os->iobuf, sizeof(os->iobuf), AVIO_FLAG_WRITE, os, NULL, ism_write, ism_seek);
340 return AVERROR(ENOMEM);
343 av_dict_set_int(&opts, "ism_lookahead", c->lookahead_count, 0);
344 av_dict_set(&opts, "movflags", "frag_custom", 0);
345 ret = avformat_write_header(ctx, &opts);
351 s->streams[i]->time_base = st->time_base;
352 if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
354 os->stream_type_tag = "video";
355 if (st->codecpar->codec_id == AV_CODEC_ID_H264) {
357 } else if (st->codecpar->codec_id == AV_CODEC_ID_VC1) {
360 av_log(s, AV_LOG_ERROR, "Unsupported video codec\n");
361 return AVERROR(EINVAL);
365 os->stream_type_tag = "audio";
366 if (st->codecpar->codec_id == AV_CODEC_ID_AAC) {
368 os->audio_tag = 0xff;
369 } else if (st->codecpar->codec_id == AV_CODEC_ID_WMAPRO) {
371 os->audio_tag = 0x0162;
373 av_log(s, AV_LOG_ERROR, "Unsupported audio codec\n");
374 return AVERROR(EINVAL);
376 os->packet_size = st->codecpar->block_align ? st->codecpar->block_align : 4;
378 get_private_data(os);
381 if (!c->has_video && c->min_frag_duration <= 0) {
382 av_log(s, AV_LOG_WARNING, "no video stream and no min frag duration set\n");
383 return AVERROR(EINVAL);
385 ret = write_manifest(s, 0);
392 static int parse_fragment(AVFormatContext *s, const char *filename, int64_t *start_ts, int64_t *duration, int64_t *moof_size, int64_t size)
397 if ((ret = s->io_open(s, &in, filename, AVIO_FLAG_READ, NULL)) < 0)
400 *moof_size = avio_rb32(in);
401 if (*moof_size < 8 || *moof_size > size)
403 if (avio_rl32(in) != MKTAG('m','o','o','f'))
406 if (len > *moof_size)
408 if (avio_rl32(in) != MKTAG('m','f','h','d'))
410 avio_seek(in, len - 8, SEEK_CUR);
411 avio_rb32(in); /* traf size */
412 if (avio_rl32(in) != MKTAG('t','r','a','f'))
414 while (avio_tell(in) < *moof_size) {
415 uint32_t len = avio_rb32(in);
416 uint32_t tag = avio_rl32(in);
417 int64_t end = avio_tell(in) + len - 8;
418 if (len < 8 || len >= *moof_size)
420 if (tag == MKTAG('u','u','i','d')) {
421 static const uint8_t tfxd[] = {
422 0x6d, 0x1d, 0x9b, 0x05, 0x42, 0xd5, 0x44, 0xe6,
423 0x80, 0xe2, 0x14, 0x1d, 0xaf, 0xf7, 0x57, 0xb2
426 avio_read(in, uuid, 16);
427 if (!memcmp(uuid, tfxd, 16) && len >= 8 + 16 + 4 + 16) {
428 avio_seek(in, 4, SEEK_CUR);
429 *start_ts = avio_rb64(in);
430 *duration = avio_rb64(in);
435 avio_seek(in, end, SEEK_SET);
438 ff_format_io_close(s, &in);
442 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)
446 if (os->nb_fragments >= os->fragments_size) {
447 os->fragments_size = (os->fragments_size + 1) * 2;
448 if ((err = av_reallocp_array(&os->fragments, sizeof(*os->fragments),
449 os->fragments_size)) < 0) {
450 os->fragments_size = 0;
451 os->nb_fragments = 0;
455 frag = av_mallocz(sizeof(*frag));
457 return AVERROR(ENOMEM);
458 av_strlcpy(frag->file, file, sizeof(frag->file));
459 av_strlcpy(frag->infofile, infofile, sizeof(frag->infofile));
460 frag->start_time = start_time;
461 frag->duration = duration;
462 frag->start_pos = start_pos;
464 frag->n = os->fragment_index;
465 os->fragments[os->nb_fragments++] = frag;
466 os->fragment_index++;
470 static int copy_moof(AVFormatContext *s, const char* infile, const char *outfile, int64_t size)
472 AVIOContext *in, *out;
474 if ((ret = s->io_open(s, &in, infile, AVIO_FLAG_READ, NULL)) < 0)
476 if ((ret = s->io_open(s, &out, outfile, AVIO_FLAG_WRITE, NULL)) < 0) {
477 ff_format_io_close(s, &in);
482 int n = FFMIN(size, sizeof(buf));
483 n = avio_read(in, buf, n);
488 avio_write(out, buf, n);
492 ff_format_io_close(s, &out);
493 ff_format_io_close(s, &in);
497 static int ism_flush(AVFormatContext *s, int final)
499 SmoothStreamingContext *c = s->priv_data;
502 for (i = 0; i < s->nb_streams; i++) {
503 OutputStream *os = &c->streams[i];
504 char filename[1024], target_filename[1024], header_filename[1024], curr_dirname[1024];
506 int64_t start_ts, duration, moof_size;
507 if (!os->packets_written)
510 snprintf(filename, sizeof(filename), "%s/temp", os->dirname);
511 ret = ffurl_open_whitelist(&os->out, filename, AVIO_FLAG_WRITE, &s->interrupt_callback, NULL, s->protocol_whitelist, s->protocol_blacklist, NULL);
514 os->cur_start_pos = os->tail_pos;
515 av_write_frame(os->ctx, NULL);
516 avio_flush(os->ctx->pb);
517 os->packets_written = 0;
518 if (!os->out || os->tail_out)
521 ffurl_closep(&os->out);
522 size = os->tail_pos - os->cur_start_pos;
523 if ((ret = parse_fragment(s, filename, &start_ts, &duration, &moof_size, size)) < 0)
526 if (!s->streams[i]->codecpar->bit_rate) {
527 int64_t bitrate = (int64_t) size * 8 * AV_TIME_BASE / av_rescale_q(duration, s->streams[i]->time_base, AV_TIME_BASE_Q);
529 av_log(s, AV_LOG_ERROR, "calculating bitrate got zero.\n");
530 ret = AVERROR(EINVAL);
534 av_log(s, AV_LOG_DEBUG, "calculated bitrate: %"PRId64"\n", bitrate);
535 s->streams[i]->codecpar->bit_rate = bitrate;
536 memcpy(curr_dirname, os->dirname, sizeof(os->dirname));
537 snprintf(os->dirname, sizeof(os->dirname), "%s/QualityLevels(%"PRId64")", s->url, s->streams[i]->codecpar->bit_rate);
538 snprintf(filename, sizeof(filename), "%s/temp", os->dirname);
540 // rename the tmp folder back to the correct name since we now have the bitrate
541 if ((ret = ff_rename((const char*)curr_dirname, os->dirname, s)) < 0)
545 snprintf(header_filename, sizeof(header_filename), "%s/FragmentInfo(%s=%"PRIu64")", os->dirname, os->stream_type_tag, start_ts);
546 snprintf(target_filename, sizeof(target_filename), "%s/Fragments(%s=%"PRIu64")", os->dirname, os->stream_type_tag, start_ts);
547 copy_moof(s, filename, header_filename, moof_size);
548 ret = ff_rename(filename, target_filename, s);
551 add_fragment(os, target_filename, header_filename, start_ts, duration,
552 os->cur_start_pos, size);
555 if (c->window_size || (final && c->remove_at_exit)) {
556 for (i = 0; i < s->nb_streams; i++) {
557 OutputStream *os = &c->streams[i];
559 int remove = os->nb_fragments - c->window_size - c->extra_window_size - c->lookahead_count;
560 if (final && c->remove_at_exit)
561 remove = os->nb_fragments;
563 for (j = 0; j < remove; j++) {
564 unlink(os->fragments[j]->file);
565 unlink(os->fragments[j]->infofile);
566 av_freep(&os->fragments[j]);
568 os->nb_fragments -= remove;
569 memmove(os->fragments, os->fragments + remove, os->nb_fragments * sizeof(*os->fragments));
571 if (final && c->remove_at_exit)
577 ret = write_manifest(s, final);
581 static int ism_write_packet(AVFormatContext *s, AVPacket *pkt)
583 SmoothStreamingContext *c = s->priv_data;
584 AVStream *st = s->streams[pkt->stream_index];
585 OutputStream *os = &c->streams[pkt->stream_index];
586 int64_t end_dts = (c->nb_fragments + 1) * (int64_t) c->min_frag_duration;
589 if (st->first_dts == AV_NOPTS_VALUE)
590 st->first_dts = pkt->dts;
592 if ((!c->has_video || st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) &&
593 av_compare_ts(pkt->dts - st->first_dts, st->time_base,
594 end_dts, AV_TIME_BASE_Q) >= 0 &&
595 pkt->flags & AV_PKT_FLAG_KEY && os->packets_written) {
597 if ((ret = ism_flush(s, 0)) < 0)
602 os->packets_written++;
603 return ff_write_chained(os->ctx, 0, pkt, s, 0);
606 static int ism_write_trailer(AVFormatContext *s)
608 SmoothStreamingContext *c = s->priv_data;
611 if (c->remove_at_exit) {
613 snprintf(filename, sizeof(filename), "%s/Manifest", s->url);
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,
651 .priv_class = &ism_class,