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) {
112 ffurl_seek(os->out, offset - os->cur_start_pos, SEEK_SET);
113 os->cur_pos = offset;
116 for (i = os->nb_fragments - 1; i >= 0; i--) {
117 Fragment *frag = os->fragments[i];
118 if (offset >= frag->start_pos && offset < frag->start_pos + frag->size) {
120 AVDictionary *opts = NULL;
121 os->tail_out = os->out;
122 av_dict_set(&opts, "truncate", "0", 0);
123 ret = ffurl_open(&os->out, frag->file, AVIO_FLAG_READ_WRITE, &os->ctx->interrupt_callback, &opts);
126 os->out = os->tail_out;
130 av_dict_set(&opts, "truncate", "0", 0);
131 ffurl_open(&os->out2, frag->infofile, AVIO_FLAG_READ_WRITE, &os->ctx->interrupt_callback, &opts);
133 ffurl_seek(os->out, offset - frag->start_pos, SEEK_SET);
135 ffurl_seek(os->out2, offset - frag->start_pos, SEEK_SET);
136 os->cur_pos = offset;
143 static void get_private_data(OutputStream *os)
145 AVCodecContext *codec = os->ctx->streams[0]->codec;
146 uint8_t *ptr = codec->extradata;
147 int size = codec->extradata_size;
149 if (codec->codec_id == AV_CODEC_ID_H264) {
150 ff_avc_write_annexb_extradata(ptr, &ptr, &size);
152 ptr = codec->extradata;
156 os->private_str = av_mallocz(2*size + 1);
157 for (i = 0; i < size; i++)
158 snprintf(&os->private_str[2*i], 3, "%02x", ptr[i]);
159 if (ptr != codec->extradata)
163 static void ism_free(AVFormatContext *s)
165 SmoothStreamingContext *c = s->priv_data;
169 for (i = 0; i < s->nb_streams; i++) {
170 OutputStream *os = &c->streams[i];
171 ffurl_close(os->out);
172 ffurl_close(os->out2);
173 ffurl_close(os->tail_out);
174 os->out = os->out2 = os->tail_out = NULL;
175 if (os->ctx && os->ctx_inited)
176 av_write_trailer(os->ctx);
177 if (os->ctx && os->ctx->pb)
178 av_free(os->ctx->pb);
180 avformat_free_context(os->ctx);
181 av_free(os->private_str);
182 for (j = 0; j < os->nb_fragments; j++)
183 av_free(os->fragments[j]);
184 av_free(os->fragments);
186 av_freep(&c->streams);
189 static void output_chunk_list(OutputStream *os, AVIOContext *out, int final, int skip, int window_size)
191 int removed = 0, i, start = 0;
192 if (os->nb_fragments <= 0)
194 if (os->fragments[0]->n > 0)
199 start = FFMAX(os->nb_fragments - skip - window_size, 0);
200 for (i = start; i < os->nb_fragments - skip; i++) {
201 Fragment *frag = os->fragments[i];
202 if (!final || removed)
203 avio_printf(out, "<c t=\"%"PRIu64"\" d=\"%"PRIu64"\" />\n", frag->start_time, frag->duration);
205 avio_printf(out, "<c n=\"%d\" d=\"%"PRIu64"\" />\n", frag->n, frag->duration);
209 static int write_manifest(AVFormatContext *s, int final)
211 SmoothStreamingContext *c = s->priv_data;
214 int ret, i, video_chunks = 0, audio_chunks = 0, video_streams = 0, audio_streams = 0;
215 int64_t duration = 0;
217 snprintf(filename, sizeof(filename), "%s/Manifest", s->filename);
218 ret = avio_open2(&out, filename, AVIO_FLAG_WRITE, &s->interrupt_callback, NULL);
220 av_log(s, AV_LOG_ERROR, "Unable to open %s for writing\n", filename);
223 avio_printf(out, "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n");
224 for (i = 0; i < s->nb_streams; i++) {
225 OutputStream *os = &c->streams[i];
226 if (os->nb_fragments > 0) {
227 Fragment *last = os->fragments[os->nb_fragments - 1];
228 duration = last->start_time + last->duration;
230 if (s->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
231 video_chunks = os->nb_fragments;
234 audio_chunks = os->nb_fragments;
240 video_chunks = audio_chunks = 0;
242 if (c->window_size) {
243 video_chunks = FFMIN(video_chunks, c->window_size);
244 audio_chunks = FFMIN(audio_chunks, c->window_size);
246 avio_printf(out, "<SmoothStreamingMedia MajorVersion=\"2\" MinorVersion=\"0\" Duration=\"%"PRIu64"\"", duration);
248 avio_printf(out, " IsLive=\"true\" LookAheadFragmentCount=\"%d\" DVRWindowLength=\"0\"", c->lookahead_count);
249 avio_printf(out, ">\n");
251 int last = -1, index = 0;
252 avio_printf(out, "<StreamIndex Type=\"video\" QualityLevels=\"%d\" Chunks=\"%d\" Url=\"QualityLevels({bitrate})/Fragments(video={start time})\">\n", video_streams, video_chunks);
253 for (i = 0; i < s->nb_streams; i++) {
254 OutputStream *os = &c->streams[i];
255 if (s->streams[i]->codec->codec_type != AVMEDIA_TYPE_VIDEO)
258 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);
261 output_chunk_list(&c->streams[last], out, final, c->lookahead_count, c->window_size);
262 avio_printf(out, "</StreamIndex>\n");
265 int last = -1, index = 0;
266 avio_printf(out, "<StreamIndex Type=\"audio\" QualityLevels=\"%d\" Chunks=\"%d\" Url=\"QualityLevels({bitrate})/Fragments(audio={start time})\">\n", audio_streams, audio_chunks);
267 for (i = 0; i < s->nb_streams; i++) {
268 OutputStream *os = &c->streams[i];
269 if (s->streams[i]->codec->codec_type != AVMEDIA_TYPE_AUDIO)
272 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);
275 output_chunk_list(&c->streams[last], out, final, c->lookahead_count, c->window_size);
276 avio_printf(out, "</StreamIndex>\n");
278 avio_printf(out, "</SmoothStreamingMedia>\n");
284 static int ism_write_header(AVFormatContext *s)
286 SmoothStreamingContext *c = s->priv_data;
288 AVOutputFormat *oformat;
290 if (mkdir(s->filename, 0777) < 0) {
291 av_log(s, AV_LOG_ERROR, "mkdir failed\n");
292 ret = AVERROR(errno);
296 oformat = av_guess_format("ismv", NULL, NULL);
298 ret = AVERROR_MUXER_NOT_FOUND;
302 c->streams = av_mallocz(sizeof(*c->streams) * s->nb_streams);
304 ret = AVERROR(ENOMEM);
308 for (i = 0; i < s->nb_streams; i++) {
309 OutputStream *os = &c->streams[i];
310 AVFormatContext *ctx;
312 AVDictionary *opts = NULL;
315 if (!s->streams[i]->codec->bit_rate) {
316 av_log(s, AV_LOG_ERROR, "No bit rate set for stream %d\n", i);
317 ret = AVERROR(EINVAL);
320 snprintf(os->dirname, sizeof(os->dirname), "%s/QualityLevels(%d)", s->filename, s->streams[i]->codec->bit_rate);
321 if (mkdir(os->dirname, 0777) < 0) {
322 ret = AVERROR(errno);
323 av_log(s, AV_LOG_ERROR, "mkdir failed\n");
327 ctx = avformat_alloc_context();
329 ret = AVERROR(ENOMEM);
333 ctx->oformat = oformat;
334 ctx->interrupt_callback = s->interrupt_callback;
336 if (!(st = avformat_new_stream(ctx, NULL))) {
337 ret = AVERROR(ENOMEM);
340 avcodec_copy_context(st->codec, s->streams[i]->codec);
341 st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
343 ctx->pb = avio_alloc_context(os->iobuf, sizeof(os->iobuf), AVIO_FLAG_WRITE, os, NULL, ism_write, ism_seek);
345 ret = AVERROR(ENOMEM);
349 snprintf(buf, sizeof(buf), "%d", c->lookahead_count);
350 av_dict_set(&opts, "ism_lookahead", buf, 0);
351 av_dict_set(&opts, "movflags", "frag_custom", 0);
352 if ((ret = avformat_write_header(ctx, &opts)) < 0) {
358 s->streams[i]->time_base = st->time_base;
359 if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
361 os->stream_type_tag = "video";
362 if (st->codec->codec_id == AV_CODEC_ID_H264) {
364 } else if (st->codec->codec_id == AV_CODEC_ID_VC1) {
367 av_log(s, AV_LOG_ERROR, "Unsupported video codec\n");
368 ret = AVERROR(EINVAL);
373 os->stream_type_tag = "audio";
374 if (st->codec->codec_id == AV_CODEC_ID_AAC) {
376 os->audio_tag = 0xff;
377 } else if (st->codec->codec_id == AV_CODEC_ID_WMAPRO) {
379 os->audio_tag = 0x0162;
381 av_log(s, AV_LOG_ERROR, "Unsupported audio codec\n");
382 ret = AVERROR(EINVAL);
385 os->packet_size = st->codec->block_align ? st->codec->block_align : 4;
387 get_private_data(os);
390 if (!c->has_video && c->min_frag_duration <= 0) {
391 av_log(s, AV_LOG_WARNING, "no video stream and no min frag duration set\n");
392 ret = AVERROR(EINVAL);
394 ret = write_manifest(s, 0);
402 static int parse_fragment(AVFormatContext *s, const char *filename, int64_t *start_ts, int64_t *duration, int64_t *moof_size, int64_t size)
407 if ((ret = avio_open2(&in, filename, AVIO_FLAG_READ, &s->interrupt_callback, NULL)) < 0)
410 *moof_size = avio_rb32(in);
411 if (*moof_size < 8 || *moof_size > size)
413 if (avio_rl32(in) != MKTAG('m','o','o','f'))
416 if (len > *moof_size)
418 if (avio_rl32(in) != MKTAG('m','f','h','d'))
420 avio_seek(in, len - 8, SEEK_CUR);
421 avio_rb32(in); /* traf size */
422 if (avio_rl32(in) != MKTAG('t','r','a','f'))
424 while (avio_tell(in) < *moof_size) {
425 uint32_t len = avio_rb32(in);
426 uint32_t tag = avio_rl32(in);
427 int64_t end = avio_tell(in) + len - 8;
428 if (len < 8 || len >= *moof_size)
430 if (tag == MKTAG('u','u','i','d')) {
431 const uint8_t tfxd[] = {
432 0x6d, 0x1d, 0x9b, 0x05, 0x42, 0xd5, 0x44, 0xe6,
433 0x80, 0xe2, 0x14, 0x1d, 0xaf, 0xf7, 0x57, 0xb2
436 avio_read(in, uuid, 16);
437 if (!memcmp(uuid, tfxd, 16) && len >= 8 + 16 + 4 + 16) {
438 avio_seek(in, 4, SEEK_CUR);
439 *start_ts = avio_rb64(in);
440 *duration = avio_rb64(in);
445 avio_seek(in, end, SEEK_SET);
452 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)
455 if (os->nb_fragments >= os->fragments_size) {
456 os->fragments_size = (os->fragments_size + 1) * 2;
457 os->fragments = av_realloc(os->fragments, sizeof(*os->fragments)*os->fragments_size);
459 return AVERROR(ENOMEM);
461 frag = av_mallocz(sizeof(*frag));
463 return AVERROR(ENOMEM);
464 av_strlcpy(frag->file, file, sizeof(frag->file));
465 av_strlcpy(frag->infofile, infofile, sizeof(frag->infofile));
466 frag->start_time = start_time;
467 frag->duration = duration;
468 frag->start_pos = start_pos;
470 frag->n = os->fragment_index;
471 os->fragments[os->nb_fragments++] = frag;
472 os->fragment_index++;
476 static int copy_moof(AVFormatContext *s, const char* infile, const char *outfile, int64_t size)
478 AVIOContext *in, *out;
480 if ((ret = avio_open2(&in, infile, AVIO_FLAG_READ, &s->interrupt_callback, NULL)) < 0)
482 if ((ret = avio_open2(&out, outfile, AVIO_FLAG_WRITE, &s->interrupt_callback, NULL)) < 0) {
488 int n = FFMIN(size, sizeof(buf));
489 n = avio_read(in, buf, n);
494 avio_write(out, buf, n);
503 static int ism_flush(AVFormatContext *s, int final)
505 SmoothStreamingContext *c = s->priv_data;
508 for (i = 0; i < s->nb_streams; i++) {
509 OutputStream *os = &c->streams[i];
510 char filename[1024], target_filename[1024], header_filename[1024];
511 int64_t start_pos = os->tail_pos, size;
512 int64_t start_ts, duration, moof_size;
513 if (!os->packets_written)
516 snprintf(filename, sizeof(filename), "%s/temp", os->dirname);
517 ret = ffurl_open(&os->out, filename, AVIO_FLAG_WRITE, &s->interrupt_callback, NULL);
520 os->cur_start_pos = os->tail_pos;
521 av_write_frame(os->ctx, NULL);
522 avio_flush(os->ctx->pb);
523 os->packets_written = 0;
524 if (!os->out || os->tail_out)
527 ffurl_close(os->out);
529 size = os->tail_pos - start_pos;
530 if ((ret = parse_fragment(s, filename, &start_ts, &duration, &moof_size, size)) < 0)
532 snprintf(header_filename, sizeof(header_filename), "%s/FragmentInfo(%s=%"PRIu64")", os->dirname, os->stream_type_tag, start_ts);
533 snprintf(target_filename, sizeof(target_filename), "%s/Fragments(%s=%"PRIu64")", os->dirname, os->stream_type_tag, start_ts);
534 copy_moof(s, filename, header_filename, moof_size);
535 rename(filename, target_filename);
536 add_fragment(os, target_filename, header_filename, start_ts, duration, start_pos, size);
539 if (c->window_size || (final && c->remove_at_exit)) {
540 for (i = 0; i < s->nb_streams; i++) {
541 OutputStream *os = &c->streams[i];
543 int remove = os->nb_fragments - c->window_size - c->extra_window_size - c->lookahead_count;
544 if (final && c->remove_at_exit)
545 remove = os->nb_fragments;
547 for (j = 0; j < remove; j++) {
548 unlink(os->fragments[j]->file);
549 unlink(os->fragments[j]->infofile);
550 av_free(os->fragments[j]);
552 os->nb_fragments -= remove;
553 memmove(os->fragments, os->fragments + remove, os->nb_fragments * sizeof(*os->fragments));
555 if (final && c->remove_at_exit)
561 ret = write_manifest(s, final);
565 static int ism_write_packet(AVFormatContext *s, AVPacket *pkt)
567 SmoothStreamingContext *c = s->priv_data;
568 AVStream *st = s->streams[pkt->stream_index];
569 OutputStream *os = &c->streams[pkt->stream_index];
570 int64_t end_dts = (c->nb_fragments + 1LL) * c->min_frag_duration;
573 if (st->first_dts == AV_NOPTS_VALUE)
574 st->first_dts = pkt->dts;
576 if ((!c->has_video || st->codec->codec_type == AVMEDIA_TYPE_VIDEO) &&
577 av_compare_ts(pkt->dts - st->first_dts, st->time_base,
578 end_dts, AV_TIME_BASE_Q) >= 0 &&
579 pkt->flags & AV_PKT_FLAG_KEY && os->packets_written) {
581 if ((ret = ism_flush(s, 0)) < 0)
586 os->packets_written++;
587 return ff_write_chained(os->ctx, 0, pkt, s);
590 static int ism_write_trailer(AVFormatContext *s)
592 SmoothStreamingContext *c = s->priv_data;
595 if (c->remove_at_exit) {
597 snprintf(filename, sizeof(filename), "%s/Manifest", s->filename);
606 #define OFFSET(x) offsetof(SmoothStreamingContext, x)
607 #define E AV_OPT_FLAG_ENCODING_PARAM
608 static const AVOption options[] = {
609 { "window_size", "number of fragments kept in the manifest", OFFSET(window_size), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, E },
610 { "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 },
611 { "lookahead_count", "number of lookahead fragments", OFFSET(lookahead_count), AV_OPT_TYPE_INT, { .i64 = 2 }, 0, INT_MAX, E },
612 { "min_frag_duration", "minimum fragment duration (in microseconds)", OFFSET(min_frag_duration), AV_OPT_TYPE_INT64, { .i64 = 5000000 }, 0, INT_MAX, E },
613 { "remove_at_exit", "remove all fragments when finished", OFFSET(remove_at_exit), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, E },
617 static const AVClass ism_class = {
618 .class_name = "smooth streaming muxer",
619 .item_name = av_default_item_name,
621 .version = LIBAVUTIL_VERSION_INT,
625 AVOutputFormat ff_smoothstreaming_muxer = {
626 .name = "smoothstreaming",
627 .long_name = NULL_IF_CONFIG_SMALL("Smooth Streaming Muxer"),
628 .priv_data_size = sizeof(SmoothStreamingContext),
629 .audio_codec = AV_CODEC_ID_AAC,
630 .video_codec = AV_CODEC_ID_H264,
631 .flags = AVFMT_GLOBALHEADER | AVFMT_NOFILE,
632 .write_header = ism_write_header,
633 .write_packet = ism_write_packet,
634 .write_trailer = ism_write_trailer,
635 .codec_tag = (const AVCodecTag* const []){ ff_mp4_obj_type, 0 },
636 .priv_class = &ism_class,