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"
35 #include "libavutil/opt.h"
36 #include "libavutil/avstring.h"
37 #include "libavutil/mathematics.h"
38 #include "libavutil/intreadwrite.h"
43 int64_t start_time, duration;
45 int64_t start_pos, size;
53 URLContext *out; // Current output stream where all output is written
54 URLContext *out2; // Auxillary output stream where all output also is written
55 URLContext *tail_out; // The actual main output stream, if we're currently seeked back to write elsewhere
56 int64_t tail_pos, cur_pos, cur_start_pos;
58 const char *stream_type_tag;
59 int nb_fragments, fragments_size, fragment_index;
69 const AVClass *class; /* Class for private options. */
71 int extra_window_size;
73 int min_frag_duration;
75 OutputStream *streams;
76 int has_video, has_audio;
78 } SmoothStreamingContext;
80 static int ism_write(void *opaque, uint8_t *buf, int buf_size)
82 OutputStream *os = opaque;
84 ffurl_write(os->out, buf, buf_size);
86 ffurl_write(os->out2, buf, buf_size);
87 os->cur_pos += buf_size;
88 if (os->cur_pos >= os->tail_pos)
89 os->tail_pos = os->cur_pos;
93 static int64_t ism_seek(void *opaque, int64_t offset, int whence)
95 OutputStream *os = opaque;
97 if (whence != SEEK_SET)
98 return AVERROR(ENOSYS);
101 ffurl_close(os->out);
104 ffurl_close(os->out2);
106 os->out = os->tail_out;
110 if (offset >= os->cur_start_pos) {
111 ffurl_seek(os->out, offset - os->cur_start_pos, SEEK_SET);
112 os->cur_pos = offset;
115 for (i = os->nb_fragments - 1; i >= 0; i--) {
116 Fragment *frag = os->fragments[i];
117 if (offset >= frag->start_pos && offset < frag->start_pos + frag->size) {
119 AVDictionary *opts = NULL;
120 os->tail_out = os->out;
121 av_dict_set(&opts, "truncate", "0", 0);
122 ret = ffurl_open(&os->out, frag->file, AVIO_FLAG_READ_WRITE, &os->ctx->interrupt_callback, &opts);
125 os->out = os->tail_out;
129 av_dict_set(&opts, "truncate", "0", 0);
130 ffurl_open(&os->out2, frag->infofile, AVIO_FLAG_READ_WRITE, &os->ctx->interrupt_callback, &opts);
132 ffurl_seek(os->out, offset - frag->start_pos, SEEK_SET);
134 ffurl_seek(os->out2, offset - frag->start_pos, SEEK_SET);
135 os->cur_pos = offset;
142 static void get_private_data(OutputStream *os)
144 AVCodecContext *codec = os->ctx->streams[0]->codec;
145 uint8_t *ptr = codec->extradata;
146 int size = codec->extradata_size;
148 if (codec->codec_id == AV_CODEC_ID_H264) {
149 ff_avc_write_annexb_extradata(ptr, &ptr, &size);
151 ptr = codec->extradata;
155 os->private_str = av_mallocz(2*size + 1);
156 for (i = 0; i < size; i++)
157 snprintf(&os->private_str[2*i], 3, "%02x", ptr[i]);
158 if (ptr != codec->extradata)
162 static void ism_free(AVFormatContext *s)
164 SmoothStreamingContext *c = s->priv_data;
168 for (i = 0; i < s->nb_streams; i++) {
169 OutputStream *os = &c->streams[i];
170 ffurl_close(os->out);
171 ffurl_close(os->out2);
172 ffurl_close(os->tail_out);
173 os->out = os->out2 = os->tail_out = NULL;
174 if (os->ctx && os->ctx_inited)
175 av_write_trailer(os->ctx);
176 if (os->ctx && os->ctx->pb)
177 av_free(os->ctx->pb);
179 avformat_free_context(os->ctx);
180 av_free(os->private_str);
181 for (j = 0; j < os->nb_fragments; j++)
182 av_free(os->fragments[j]);
183 av_free(os->fragments);
185 av_freep(&c->streams);
188 static int ism_write_header(AVFormatContext *s)
190 SmoothStreamingContext *c = s->priv_data;
192 AVOutputFormat *oformat;
194 ret = mkdir(s->filename, 0777);
196 av_log(s, AV_LOG_ERROR, "mkdir(%s): %s\n", s->filename, strerror(errno));
197 return AVERROR(errno);
201 oformat = av_guess_format("ismv", NULL, NULL);
203 ret = AVERROR_MUXER_NOT_FOUND;
207 c->streams = av_mallocz(sizeof(*c->streams) * s->nb_streams);
209 ret = AVERROR(ENOMEM);
213 for (i = 0; i < s->nb_streams; i++) {
214 OutputStream *os = &c->streams[i];
215 AVFormatContext *ctx;
217 AVDictionary *opts = NULL;
220 if (!s->streams[i]->codec->bit_rate) {
221 av_log(s, AV_LOG_ERROR, "No bit rate set for stream %d\n", i);
222 ret = AVERROR(EINVAL);
225 snprintf(os->dirname, sizeof(os->dirname), "%s/QualityLevels(%d)", s->filename, s->streams[i]->codec->bit_rate);
226 mkdir(os->dirname, 0777);
228 ctx = avformat_alloc_context();
230 ret = AVERROR(ENOMEM);
234 ctx->oformat = oformat;
235 ctx->interrupt_callback = s->interrupt_callback;
237 if (!(st = avformat_new_stream(ctx, NULL))) {
238 ret = AVERROR(ENOMEM);
241 avcodec_copy_context(st->codec, s->streams[i]->codec);
243 ctx->pb = avio_alloc_context(os->iobuf, sizeof(os->iobuf), AVIO_FLAG_WRITE, os, NULL, ism_write, ism_seek);
245 ret = AVERROR(ENOMEM);
249 snprintf(buf, sizeof(buf), "%d", c->lookahead_count);
250 av_dict_set(&opts, "ism_lookahead", buf, 0);
251 av_dict_set(&opts, "movflags", "frag_custom", 0);
252 if ((ret = avformat_write_header(ctx, &opts)) < 0) {
258 s->streams[i]->time_base = st->time_base;
259 if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
261 os->stream_type_tag = "video";
262 if (st->codec->codec_id == AV_CODEC_ID_H264) {
264 } else if (st->codec->codec_id == AV_CODEC_ID_VC1) {
267 av_log(s, AV_LOG_ERROR, "Unsupported video codec\n");
268 ret = AVERROR(EINVAL);
273 os->stream_type_tag = "audio";
274 if (st->codec->codec_id == AV_CODEC_ID_AAC) {
276 os->audio_tag = 0xff;
277 } else if (st->codec->codec_id == AV_CODEC_ID_WMAPRO) {
279 os->audio_tag = 0x0162;
281 av_log(s, AV_LOG_ERROR, "Unsupported audio codec\n");
282 ret = AVERROR(EINVAL);
285 os->packet_size = st->codec->block_align ? st->codec->block_align : 4;
287 get_private_data(os);
290 if (!c->has_video && c->min_frag_duration <= 0) {
291 av_log(s, AV_LOG_WARNING, "no video stream and no min frag duration set\n");
292 ret = AVERROR(EINVAL);
301 static int parse_fragment(AVFormatContext *s, const char *filename, int64_t *start_ts, int64_t *duration, int64_t *moof_size, int64_t size)
306 if ((ret = avio_open2(&in, filename, AVIO_FLAG_READ, &s->interrupt_callback, NULL)) < 0)
309 *moof_size = avio_rb32(in);
310 if (*moof_size < 8 || *moof_size > size)
312 if (avio_rl32(in) != MKTAG('m','o','o','f'))
315 if (len > *moof_size)
317 if (avio_rl32(in) != MKTAG('m','f','h','d'))
319 avio_seek(in, len - 8, SEEK_CUR);
320 avio_rb32(in); /* traf size */
321 if (avio_rl32(in) != MKTAG('t','r','a','f'))
323 while (avio_tell(in) < *moof_size) {
324 uint32_t len = avio_rb32(in);
325 uint32_t tag = avio_rl32(in);
326 int64_t end = avio_tell(in) + len - 8;
327 if (len < 8 || len >= *moof_size)
329 if (tag == MKTAG('u','u','i','d')) {
330 const uint8_t tfxd[] = {
331 0x6d, 0x1d, 0x9b, 0x05, 0x42, 0xd5, 0x44, 0xe6,
332 0x80, 0xe2, 0x14, 0x1d, 0xaf, 0xf7, 0x57, 0xb2
335 avio_read(in, uuid, 16);
336 if (!memcmp(uuid, tfxd, 16) && len >= 8 + 16 + 4 + 16) {
337 avio_seek(in, 4, SEEK_CUR);
338 *start_ts = avio_rb64(in);
339 *duration = avio_rb64(in);
344 avio_seek(in, end, SEEK_SET);
351 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)
354 if (os->nb_fragments >= os->fragments_size) {
355 os->fragments_size = (os->fragments_size + 1) * 2;
356 os->fragments = av_realloc(os->fragments, sizeof(*os->fragments)*os->fragments_size);
358 return AVERROR(ENOMEM);
360 frag = av_mallocz(sizeof(*frag));
362 return AVERROR(ENOMEM);
363 av_strlcpy(frag->file, file, sizeof(frag->file));
364 av_strlcpy(frag->infofile, infofile, sizeof(frag->infofile));
365 frag->start_time = start_time;
366 frag->duration = duration;
367 frag->start_pos = start_pos;
369 frag->n = os->fragment_index;
370 os->fragments[os->nb_fragments++] = frag;
371 os->fragment_index++;
375 static int copy_moof(AVFormatContext *s, const char* infile, const char *outfile, int64_t size)
377 AVIOContext *in, *out;
379 if ((ret = avio_open2(&in, infile, AVIO_FLAG_READ, &s->interrupt_callback, NULL)) < 0)
381 if ((ret = avio_open2(&out, outfile, AVIO_FLAG_WRITE, &s->interrupt_callback, NULL)) < 0) {
387 int n = FFMIN(size, sizeof(buf));
388 n = avio_read(in, buf, n);
393 avio_write(out, buf, n);
402 static void output_chunk_list(OutputStream *os, AVIOContext *out, int final, int skip, int window_size)
404 int removed = 0, i, start = 0;
405 if (os->nb_fragments <= 0)
407 if (os->fragments[0]->n > 0)
412 start = FFMAX(os->nb_fragments - skip - window_size, 0);
413 for (i = start; i < os->nb_fragments - skip; i++) {
414 Fragment *frag = os->fragments[i];
415 if (!final || removed)
416 avio_printf(out, "<c t=\"%"PRIu64"\" d=\"%"PRIu64"\" />\n", frag->start_time, frag->duration);
418 avio_printf(out, "<c n=\"%d\" d=\"%"PRIu64"\" />\n", frag->n, frag->duration);
422 static int write_manifest(AVFormatContext *s, int final)
424 SmoothStreamingContext *c = s->priv_data;
427 int ret, i, video_chunks = 0, audio_chunks = 0, video_streams = 0, audio_streams = 0;
428 int64_t duration = 0;
430 snprintf(filename, sizeof(filename), "%s/Manifest", s->filename);
431 ret = avio_open2(&out, filename, AVIO_FLAG_WRITE, &s->interrupt_callback, NULL);
434 avio_printf(out, "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n");
435 for (i = 0; i < s->nb_streams; i++) {
436 OutputStream *os = &c->streams[i];
437 if (os->nb_fragments > 0) {
438 Fragment *last = os->fragments[os->nb_fragments - 1];
439 duration = last->start_time + last->duration;
441 if (s->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
442 video_chunks = os->nb_fragments;
445 audio_chunks = os->nb_fragments;
451 video_chunks = audio_chunks = 0;
453 if (c->window_size) {
454 video_chunks = FFMIN(video_chunks, c->window_size);
455 audio_chunks = FFMIN(audio_chunks, c->window_size);
457 avio_printf(out, "<SmoothStreamingMedia MajorVersion=\"2\" MinorVersion=\"0\" Duration=\"%"PRIu64"\"", duration);
459 avio_printf(out, " IsLive=\"true\" LookAheadFragmentCount=\"%d\" DVRWindowLength=\"0\"", c->lookahead_count);
460 avio_printf(out, ">\n");
462 int last = -1, index = 0;
463 avio_printf(out, "<StreamIndex Type=\"video\" QualityLevels=\"%d\" Chunks=\"%d\" Url=\"QualityLevels({bitrate})/Fragments(video={start time})\">\n", video_streams, video_chunks);
464 for (i = 0; i < s->nb_streams; i++) {
465 OutputStream *os = &c->streams[i];
466 if (s->streams[i]->codec->codec_type != AVMEDIA_TYPE_VIDEO)
469 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);
472 output_chunk_list(&c->streams[last], out, final, c->lookahead_count, c->window_size);
473 avio_printf(out, "</StreamIndex>\n");
476 int last = -1, index = 0;
477 avio_printf(out, "<StreamIndex Type=\"audio\" QualityLevels=\"%d\" Chunks=\"%d\" Url=\"QualityLevels({bitrate})/Fragments(audio={start time})\">\n", audio_streams, audio_chunks);
478 for (i = 0; i < s->nb_streams; i++) {
479 OutputStream *os = &c->streams[i];
480 if (s->streams[i]->codec->codec_type != AVMEDIA_TYPE_AUDIO)
483 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);
486 output_chunk_list(&c->streams[last], out, final, c->lookahead_count, c->window_size);
487 avio_printf(out, "</StreamIndex>\n");
489 avio_printf(out, "</SmoothStreamingMedia>\n");
495 static int ism_flush(AVFormatContext *s, int final)
497 SmoothStreamingContext *c = s->priv_data;
500 for (i = 0; i < s->nb_streams; i++) {
501 OutputStream *os = &c->streams[i];
502 char filename[1024], target_filename[1024], header_filename[1024];
503 int64_t start_pos = os->tail_pos, size;
504 int64_t start_ts, duration, moof_size;
505 if (!os->packets_written)
508 snprintf(filename, sizeof(filename), "%s/temp", os->dirname);
509 ret = ffurl_open(&os->out, filename, AVIO_FLAG_WRITE, &s->interrupt_callback, NULL);
512 os->cur_start_pos = os->tail_pos;
513 av_write_frame(os->ctx, NULL);
514 avio_flush(os->ctx->pb);
515 os->packets_written = 0;
516 if (!os->out || os->tail_out)
519 ffurl_close(os->out);
521 size = os->tail_pos - start_pos;
522 if ((ret = parse_fragment(s, filename, &start_ts, &duration, &moof_size, size)) < 0)
524 snprintf(header_filename, sizeof(header_filename), "%s/FragmentInfo(%s=%"PRIu64")", os->dirname, os->stream_type_tag, start_ts);
525 snprintf(target_filename, sizeof(target_filename), "%s/Fragments(%s=%"PRIu64")", os->dirname, os->stream_type_tag, start_ts);
526 copy_moof(s, filename, header_filename, moof_size);
527 rename(filename, target_filename);
528 add_fragment(os, target_filename, header_filename, start_ts, duration, start_pos, size);
531 if (c->window_size || (final && c->remove_at_exit)) {
532 for (i = 0; i < s->nb_streams; i++) {
533 OutputStream *os = &c->streams[i];
535 int remove = os->nb_fragments - c->window_size - c->extra_window_size - c->lookahead_count;
536 if (final && c->remove_at_exit)
537 remove = os->nb_fragments;
539 for (j = 0; j < remove; j++) {
540 unlink(os->fragments[j]->file);
541 unlink(os->fragments[j]->infofile);
542 av_free(os->fragments[j]);
544 os->nb_fragments -= remove;
545 memmove(os->fragments, os->fragments + remove, os->nb_fragments * sizeof(*os->fragments));
547 if (final && c->remove_at_exit)
552 write_manifest(s, final);
556 static int ism_write_packet(AVFormatContext *s, AVPacket *pkt)
558 SmoothStreamingContext *c = s->priv_data;
559 AVStream *st = s->streams[pkt->stream_index];
560 OutputStream *os = &c->streams[pkt->stream_index];
561 int64_t end_pts = (c->nb_fragments + 1) * c->min_frag_duration;
563 if ((!c->has_video || st->codec->codec_type == AVMEDIA_TYPE_VIDEO) &&
564 av_compare_ts(pkt->pts, st->time_base,
565 end_pts, AV_TIME_BASE_Q) >= 0 &&
566 pkt->flags & AV_PKT_FLAG_KEY && os->packets_written) {
572 os->packets_written++;
573 return ff_write_chained(os->ctx, 0, pkt, s);
576 static int ism_write_trailer(AVFormatContext *s)
578 SmoothStreamingContext *c = s->priv_data;
581 if (c->remove_at_exit) {
583 snprintf(filename, sizeof(filename), "%s/Manifest", s->filename);
592 #define OFFSET(x) offsetof(SmoothStreamingContext, x)
593 #define E AV_OPT_FLAG_ENCODING_PARAM
594 static const AVOption options[] = {
595 { "window_size", "number of fragments kept in the manifest", OFFSET(window_size), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, E },
596 { "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 },
597 { "lookahead_count", "number of lookahead fragments", OFFSET(lookahead_count), AV_OPT_TYPE_INT, { .i64 = 2 }, 0, INT_MAX, E },
598 { "min_frag_duration", "minimum fragment duration (in microseconds)", OFFSET(min_frag_duration), AV_OPT_TYPE_INT64, { .i64 = 5000000 }, 0, INT_MAX, E },
599 { "remove_at_exit", "remove all fragments when finished", OFFSET(remove_at_exit), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, E },
603 static const AVClass ism_class = {
604 .class_name = "smooth streaming muxer",
605 .item_name = av_default_item_name,
607 .version = LIBAVUTIL_VERSION_INT,
611 AVOutputFormat ff_smoothstreaming_muxer = {
612 .name = "smoothstreaming",
613 .long_name = NULL_IF_CONFIG_SMALL("Smooth Streaming Muxer"),
614 .priv_data_size = sizeof(SmoothStreamingContext),
615 .audio_codec = AV_CODEC_ID_AAC,
616 .video_codec = AV_CODEC_ID_H264,
617 .flags = AVFMT_GLOBALHEADER | AVFMT_NOFILE,
618 .write_header = ism_write_header,
619 .write_packet = ism_write_packet,
620 .write_trailer = ism_write_trailer,
621 .codec_tag = (const AVCodecTag* const []){ ff_mp4_obj_type, 0 },
622 .priv_class = &ism_class,