2 * Live smooth streaming fragmenter
3 * Copyright (c) 2012 Martin Storsjo
5 * This file is part of Libav.
7 * Libav 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 * Libav 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 Libav; 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/file.h"
38 #include "libavutil/mathematics.h"
39 #include "libavutil/intreadwrite.h"
44 int64_t start_time, duration;
46 int64_t start_pos, size;
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;
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);
102 ffurl_close(os->out);
105 ffurl_close(os->out2);
107 os->out = os->tail_out;
111 if (offset >= os->cur_start_pos) {
113 ffurl_seek(os->out, offset - os->cur_start_pos, SEEK_SET);
114 os->cur_pos = offset;
117 for (i = os->nb_fragments - 1; i >= 0; i--) {
118 Fragment *frag = os->fragments[i];
119 if (offset >= frag->start_pos && offset < frag->start_pos + frag->size) {
121 AVDictionary *opts = NULL;
122 os->tail_out = os->out;
123 av_dict_set(&opts, "truncate", "0", 0);
124 ret = ffurl_open(&os->out, frag->file, AVIO_FLAG_READ_WRITE, &os->ctx->interrupt_callback, &opts);
127 os->out = os->tail_out;
131 av_dict_set(&opts, "truncate", "0", 0);
132 ffurl_open(&os->out2, frag->infofile, AVIO_FLAG_READ_WRITE, &os->ctx->interrupt_callback, &opts);
134 ffurl_seek(os->out, offset - frag->start_pos, SEEK_SET);
136 ffurl_seek(os->out2, offset - frag->start_pos, SEEK_SET);
137 os->cur_pos = offset;
144 static void get_private_data(OutputStream *os)
146 AVCodecContext *codec = os->ctx->streams[0]->codec;
147 uint8_t *ptr = codec->extradata;
148 int size = codec->extradata_size;
150 if (codec->codec_id == AV_CODEC_ID_H264) {
151 ff_avc_write_annexb_extradata(ptr, &ptr, &size);
153 ptr = codec->extradata;
157 os->private_str = av_mallocz(2*size + 1);
158 if (!os->private_str)
160 for (i = 0; i < size; i++)
161 snprintf(&os->private_str[2*i], 3, "%02x", ptr[i]);
163 if (ptr != codec->extradata)
167 static void ism_free(AVFormatContext *s)
169 SmoothStreamingContext *c = s->priv_data;
173 for (i = 0; i < s->nb_streams; i++) {
174 OutputStream *os = &c->streams[i];
175 ffurl_close(os->out);
176 ffurl_close(os->out2);
177 ffurl_close(os->tail_out);
178 os->out = os->out2 = os->tail_out = NULL;
179 if (os->ctx && os->ctx_inited)
180 av_write_trailer(os->ctx);
181 if (os->ctx && os->ctx->pb)
182 av_free(os->ctx->pb);
184 avformat_free_context(os->ctx);
185 av_free(os->private_str);
186 for (j = 0; j < os->nb_fragments; j++)
187 av_free(os->fragments[j]);
188 av_free(os->fragments);
190 av_freep(&c->streams);
193 static void output_chunk_list(OutputStream *os, AVIOContext *out, int final, int skip, int window_size)
195 int removed = 0, i, start = 0;
196 if (os->nb_fragments <= 0)
198 if (os->fragments[0]->n > 0)
203 start = FFMAX(os->nb_fragments - skip - window_size, 0);
204 for (i = start; i < os->nb_fragments - skip; i++) {
205 Fragment *frag = os->fragments[i];
206 if (!final || removed)
207 avio_printf(out, "<c t=\"%"PRIu64"\" d=\"%"PRIu64"\" />\n", frag->start_time, frag->duration);
209 avio_printf(out, "<c n=\"%d\" d=\"%"PRIu64"\" />\n", frag->n, frag->duration);
213 static int write_manifest(AVFormatContext *s, int final)
215 SmoothStreamingContext *c = s->priv_data;
217 char filename[1024], temp_filename[1024];
218 const char *write_filename;
219 int ret, i, video_chunks = 0, audio_chunks = 0, video_streams = 0, audio_streams = 0;
220 int64_t duration = 0;
222 snprintf(filename, sizeof(filename), "%s/Manifest", s->filename);
223 snprintf(temp_filename, sizeof(temp_filename), "%s/Manifest.tmp", s->filename);
224 write_filename = USE_RENAME_REPLACE ? temp_filename : filename;
225 ret = avio_open2(&out, write_filename, AVIO_FLAG_WRITE, &s->interrupt_callback, NULL);
227 av_log(s, AV_LOG_ERROR, "Unable to open %s for writing\n", write_filename);
230 avio_printf(out, "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n");
231 for (i = 0; i < s->nb_streams; i++) {
232 OutputStream *os = &c->streams[i];
233 if (os->nb_fragments > 0) {
234 Fragment *last = os->fragments[os->nb_fragments - 1];
235 duration = last->start_time + last->duration;
237 if (s->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
238 video_chunks = os->nb_fragments;
241 audio_chunks = os->nb_fragments;
247 video_chunks = audio_chunks = 0;
249 if (c->window_size) {
250 video_chunks = FFMIN(video_chunks, c->window_size);
251 audio_chunks = FFMIN(audio_chunks, c->window_size);
253 avio_printf(out, "<SmoothStreamingMedia MajorVersion=\"2\" MinorVersion=\"0\" Duration=\"%"PRIu64"\"", duration);
255 avio_printf(out, " IsLive=\"true\" LookAheadFragmentCount=\"%d\" DVRWindowLength=\"0\"", c->lookahead_count);
256 avio_printf(out, ">\n");
258 int last = -1, index = 0;
259 avio_printf(out, "<StreamIndex Type=\"video\" QualityLevels=\"%d\" Chunks=\"%d\" Url=\"QualityLevels({bitrate})/Fragments(video={start time})\">\n", video_streams, video_chunks);
260 for (i = 0; i < s->nb_streams; i++) {
261 OutputStream *os = &c->streams[i];
262 if (s->streams[i]->codec->codec_type != AVMEDIA_TYPE_VIDEO)
265 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);
268 output_chunk_list(&c->streams[last], out, final, c->lookahead_count, c->window_size);
269 avio_printf(out, "</StreamIndex>\n");
272 int last = -1, index = 0;
273 avio_printf(out, "<StreamIndex Type=\"audio\" QualityLevels=\"%d\" Chunks=\"%d\" Url=\"QualityLevels({bitrate})/Fragments(audio={start time})\">\n", audio_streams, audio_chunks);
274 for (i = 0; i < s->nb_streams; i++) {
275 OutputStream *os = &c->streams[i];
276 if (s->streams[i]->codec->codec_type != AVMEDIA_TYPE_AUDIO)
279 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);
282 output_chunk_list(&c->streams[last], out, final, c->lookahead_count, c->window_size);
283 avio_printf(out, "</StreamIndex>\n");
285 avio_printf(out, "</SmoothStreamingMedia>\n");
288 return USE_RENAME_REPLACE ? ff_rename(temp_filename, filename) : 0;
291 static int ism_write_header(AVFormatContext *s)
293 SmoothStreamingContext *c = s->priv_data;
295 AVOutputFormat *oformat;
297 if (mkdir(s->filename, 0777) == -1 && errno != EEXIST) {
298 ret = AVERROR(errno);
302 oformat = av_guess_format("ismv", NULL, NULL);
304 ret = AVERROR_MUXER_NOT_FOUND;
308 c->streams = av_mallocz(sizeof(*c->streams) * s->nb_streams);
310 ret = AVERROR(ENOMEM);
314 for (i = 0; i < s->nb_streams; i++) {
315 OutputStream *os = &c->streams[i];
316 AVFormatContext *ctx;
318 AVDictionary *opts = NULL;
321 if (!s->streams[i]->codec->bit_rate) {
322 av_log(s, AV_LOG_ERROR, "No bit rate set for stream %d\n", i);
323 ret = AVERROR(EINVAL);
326 snprintf(os->dirname, sizeof(os->dirname), "%s/QualityLevels(%d)", s->filename, s->streams[i]->codec->bit_rate);
327 if (mkdir(os->dirname, 0777) == -1 && errno != EEXIST) {
328 ret = AVERROR(errno);
332 ctx = avformat_alloc_context();
334 ret = AVERROR(ENOMEM);
338 ctx->oformat = oformat;
339 ctx->interrupt_callback = s->interrupt_callback;
341 if (!(st = avformat_new_stream(ctx, NULL))) {
342 ret = AVERROR(ENOMEM);
345 avcodec_copy_context(st->codec, s->streams[i]->codec);
346 st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
347 st->time_base = s->streams[i]->time_base;
349 ctx->pb = avio_alloc_context(os->iobuf, sizeof(os->iobuf), AVIO_FLAG_WRITE, os, NULL, ism_write, ism_seek);
351 ret = AVERROR(ENOMEM);
355 snprintf(buf, sizeof(buf), "%d", c->lookahead_count);
356 av_dict_set(&opts, "ism_lookahead", buf, 0);
357 av_dict_set(&opts, "movflags", "frag_custom", 0);
358 if ((ret = avformat_write_header(ctx, &opts)) < 0) {
364 s->streams[i]->time_base = st->time_base;
365 if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
367 os->stream_type_tag = "video";
368 if (st->codec->codec_id == AV_CODEC_ID_H264) {
370 } else if (st->codec->codec_id == AV_CODEC_ID_VC1) {
373 av_log(s, AV_LOG_ERROR, "Unsupported video codec\n");
374 ret = AVERROR(EINVAL);
379 os->stream_type_tag = "audio";
380 if (st->codec->codec_id == AV_CODEC_ID_AAC) {
382 os->audio_tag = 0xff;
383 } else if (st->codec->codec_id == AV_CODEC_ID_WMAPRO) {
385 os->audio_tag = 0x0162;
387 av_log(s, AV_LOG_ERROR, "Unsupported audio codec\n");
388 ret = AVERROR(EINVAL);
391 os->packet_size = st->codec->block_align ? st->codec->block_align : 4;
393 get_private_data(os);
396 if (!c->has_video && c->min_frag_duration <= 0) {
397 av_log(s, AV_LOG_WARNING, "no video stream and no min frag duration set\n");
398 ret = AVERROR(EINVAL);
400 ret = write_manifest(s, 0);
408 static int parse_fragment(AVFormatContext *s, const char *filename, int64_t *start_ts, int64_t *duration, int64_t *moof_size, int64_t size)
413 if ((ret = avio_open2(&in, filename, AVIO_FLAG_READ, &s->interrupt_callback, NULL)) < 0)
416 *moof_size = avio_rb32(in);
417 if (*moof_size < 8 || *moof_size > size)
419 if (avio_rl32(in) != MKTAG('m','o','o','f'))
422 if (len > *moof_size)
424 if (avio_rl32(in) != MKTAG('m','f','h','d'))
426 avio_seek(in, len - 8, SEEK_CUR);
427 avio_rb32(in); /* traf size */
428 if (avio_rl32(in) != MKTAG('t','r','a','f'))
430 while (avio_tell(in) < *moof_size) {
431 uint32_t len = avio_rb32(in);
432 uint32_t tag = avio_rl32(in);
433 int64_t end = avio_tell(in) + len - 8;
434 if (len < 8 || len >= *moof_size)
436 if (tag == MKTAG('u','u','i','d')) {
437 const uint8_t tfxd[] = {
438 0x6d, 0x1d, 0x9b, 0x05, 0x42, 0xd5, 0x44, 0xe6,
439 0x80, 0xe2, 0x14, 0x1d, 0xaf, 0xf7, 0x57, 0xb2
442 avio_read(in, uuid, 16);
443 if (!memcmp(uuid, tfxd, 16) && len >= 8 + 16 + 4 + 16) {
444 avio_seek(in, 4, SEEK_CUR);
445 *start_ts = avio_rb64(in);
446 *duration = avio_rb64(in);
451 avio_seek(in, end, SEEK_SET);
458 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)
462 if (os->nb_fragments >= os->fragments_size) {
463 os->fragments_size = (os->fragments_size + 1) * 2;
464 if ((err = av_reallocp(&os->fragments, sizeof(*os->fragments) *
465 os->fragments_size)) < 0) {
466 os->fragments_size = 0;
467 os->nb_fragments = 0;
471 frag = av_mallocz(sizeof(*frag));
473 return AVERROR(ENOMEM);
474 av_strlcpy(frag->file, file, sizeof(frag->file));
475 av_strlcpy(frag->infofile, infofile, sizeof(frag->infofile));
476 frag->start_time = start_time;
477 frag->duration = duration;
478 frag->start_pos = start_pos;
480 frag->n = os->fragment_index;
481 os->fragments[os->nb_fragments++] = frag;
482 os->fragment_index++;
486 static int copy_moof(AVFormatContext *s, const char* infile, const char *outfile, int64_t size)
488 AVIOContext *in, *out;
490 if ((ret = avio_open2(&in, infile, AVIO_FLAG_READ, &s->interrupt_callback, NULL)) < 0)
492 if ((ret = avio_open2(&out, outfile, AVIO_FLAG_WRITE, &s->interrupt_callback, NULL)) < 0) {
498 int n = FFMIN(size, sizeof(buf));
499 n = avio_read(in, buf, n);
504 avio_write(out, buf, n);
513 static int ism_flush(AVFormatContext *s, int final)
515 SmoothStreamingContext *c = s->priv_data;
518 for (i = 0; i < s->nb_streams; i++) {
519 OutputStream *os = &c->streams[i];
520 char filename[1024], target_filename[1024], header_filename[1024];
522 int64_t start_ts, duration, moof_size;
523 if (!os->packets_written)
526 snprintf(filename, sizeof(filename), "%s/temp", os->dirname);
527 ret = ffurl_open(&os->out, filename, AVIO_FLAG_WRITE, &s->interrupt_callback, NULL);
530 os->cur_start_pos = os->tail_pos;
531 av_write_frame(os->ctx, NULL);
532 avio_flush(os->ctx->pb);
533 os->packets_written = 0;
534 if (!os->out || os->tail_out)
537 ffurl_close(os->out);
539 size = os->tail_pos - os->cur_start_pos;
540 if ((ret = parse_fragment(s, filename, &start_ts, &duration, &moof_size, size)) < 0)
542 snprintf(header_filename, sizeof(header_filename), "%s/FragmentInfo(%s=%"PRIu64")", os->dirname, os->stream_type_tag, start_ts);
543 snprintf(target_filename, sizeof(target_filename), "%s/Fragments(%s=%"PRIu64")", os->dirname, os->stream_type_tag, start_ts);
544 copy_moof(s, filename, header_filename, moof_size);
545 ret = ff_rename(filename, target_filename);
548 add_fragment(os, target_filename, header_filename, start_ts, duration,
549 os->cur_start_pos, size);
552 if (c->window_size || (final && c->remove_at_exit)) {
553 for (i = 0; i < s->nb_streams; i++) {
554 OutputStream *os = &c->streams[i];
556 int remove = os->nb_fragments - c->window_size - c->extra_window_size - c->lookahead_count;
557 if (final && c->remove_at_exit)
558 remove = os->nb_fragments;
560 for (j = 0; j < remove; j++) {
561 unlink(os->fragments[j]->file);
562 unlink(os->fragments[j]->infofile);
563 av_free(os->fragments[j]);
565 os->nb_fragments -= remove;
566 memmove(os->fragments, os->fragments + remove, os->nb_fragments * sizeof(*os->fragments));
568 if (final && c->remove_at_exit)
574 ret = write_manifest(s, final);
578 static int ism_write_packet(AVFormatContext *s, AVPacket *pkt)
580 SmoothStreamingContext *c = s->priv_data;
581 AVStream *st = s->streams[pkt->stream_index];
582 OutputStream *os = &c->streams[pkt->stream_index];
583 int64_t end_dts = (c->nb_fragments + 1) * (int64_t) c->min_frag_duration;
586 if (st->first_dts == AV_NOPTS_VALUE)
587 st->first_dts = pkt->dts;
589 if ((!c->has_video || st->codec->codec_type == AVMEDIA_TYPE_VIDEO) &&
590 av_compare_ts(pkt->dts - st->first_dts, st->time_base,
591 end_dts, AV_TIME_BASE_Q) >= 0 &&
592 pkt->flags & AV_PKT_FLAG_KEY && os->packets_written) {
594 if ((ret = ism_flush(s, 0)) < 0)
599 os->packets_written++;
600 return ff_write_chained(os->ctx, 0, pkt, s);
603 static int ism_write_trailer(AVFormatContext *s)
605 SmoothStreamingContext *c = s->priv_data;
608 if (c->remove_at_exit) {
610 snprintf(filename, sizeof(filename), "%s/Manifest", s->filename);
619 #define OFFSET(x) offsetof(SmoothStreamingContext, x)
620 #define E AV_OPT_FLAG_ENCODING_PARAM
621 static const AVOption options[] = {
622 { "window_size", "number of fragments kept in the manifest", OFFSET(window_size), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, E },
623 { "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 },
624 { "lookahead_count", "number of lookahead fragments", OFFSET(lookahead_count), AV_OPT_TYPE_INT, { .i64 = 2 }, 0, INT_MAX, E },
625 { "min_frag_duration", "minimum fragment duration (in microseconds)", OFFSET(min_frag_duration), AV_OPT_TYPE_INT64, { .i64 = 5000000 }, 0, INT_MAX, E },
626 { "remove_at_exit", "remove all fragments when finished", OFFSET(remove_at_exit), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, E },
630 static const AVClass ism_class = {
631 .class_name = "smooth streaming muxer",
632 .item_name = av_default_item_name,
634 .version = LIBAVUTIL_VERSION_INT,
638 AVOutputFormat ff_smoothstreaming_muxer = {
639 .name = "smoothstreaming",
640 .long_name = NULL_IF_CONFIG_SMALL("Smooth Streaming Muxer"),
641 .priv_data_size = sizeof(SmoothStreamingContext),
642 .audio_codec = AV_CODEC_ID_AAC,
643 .video_codec = AV_CODEC_ID_H264,
644 .flags = AVFMT_GLOBALHEADER | AVFMT_NOFILE,
645 .write_header = ism_write_header,
646 .write_packet = ism_write_packet,
647 .write_trailer = ism_write_trailer,
648 .codec_tag = (const AVCodecTag* const []){ ff_mp4_obj_type, 0 },
649 .priv_class = &ism_class,