2 * Apple HTTP Live Streaming segmenter
3 * Copyright (c) 2012, Luca Barbato
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 "libavutil/avassert.h"
30 #include "libavutil/mathematics.h"
31 #include "libavutil/parseutils.h"
32 #include "libavutil/avstring.h"
33 #include "libavutil/opt.h"
34 #include "libavutil/log.h"
35 #include "libavutil/time_internal.h"
38 #include "avio_internal.h"
40 #include "os_support.h"
43 #define LINE_BUFFER_SIZE 1024
45 typedef struct HLSSegment {
47 char sub_filename[1024];
48 double duration; /* in seconds */
53 char key_uri[LINE_BUFFER_SIZE + 1];
54 char iv_string[KEYSIZE*2 + 1];
56 struct HLSSegment *next;
59 typedef enum HLSFlags {
60 // Generate a single media file and use byte ranges in the playlist.
61 HLS_SINGLE_FILE = (1 << 0),
62 HLS_DELETE_SEGMENTS = (1 << 1),
63 HLS_ROUND_DURATIONS = (1 << 2),
64 HLS_DISCONT_START = (1 << 3),
65 HLS_OMIT_ENDLIST = (1 << 4),
66 HLS_SPLIT_BY_TIME = (1 << 5),
67 HLS_APPEND_LIST = (1 << 6),
68 HLS_PROGRAM_DATE_TIME = (1 << 7),
69 HLS_SECOND_LEVEL_SEGMENT_INDEX = (1 << 8), // include segment index in segment filenames when use_localtime e.g.: %%03d
79 typedef struct HLSContext {
80 const AVClass *class; // Class for private options.
83 int64_t start_sequence;
84 AVOutputFormat *oformat;
85 AVOutputFormat *vtt_oformat;
88 AVFormatContext *vtt_avf;
90 float time; // Set by a private option.
91 float init_time; // Set by a private option.
92 int max_nb_segments; // Set by a private option.
93 int wrap; // Set by a private option.
94 uint32_t flags; // enum HLSFlags
95 uint32_t pl_type; // enum PlaylistType
96 char *segment_filename;
98 int use_localtime; ///< flag to expand filename with localtime
99 int use_localtime_mkdir;///< flag to mkdir dirname in timebased filename
101 int64_t recording_time;
106 double duration; // last segment duration computed so far, in seconds
107 int64_t start_pos; // last segment starting position
108 int64_t size; // last segment size
109 int64_t max_seg_size; // every segment file max size
111 int discontinuity_set;
114 HLSSegment *segments;
115 HLSSegment *last_segment;
116 HLSSegment *old_segments;
122 char *format_options_str;
123 char *vtt_format_options_str;
124 char *subtitle_filename;
125 AVDictionary *format_options;
128 char key_file[LINE_BUFFER_SIZE + 1];
129 char key_uri[LINE_BUFFER_SIZE + 1];
130 char key_string[KEYSIZE*2 + 1];
131 char iv_string[KEYSIZE*2 + 1];
132 AVDictionary *vtt_format_options;
136 double initial_prog_date_time;
139 static int mkdir_p(const char *path) {
141 char *temp = av_strdup(path);
145 if (!path || !temp) {
149 if (!strncmp(temp, "/", 1) || !strncmp(temp, "\\", 1)) {
151 } else if (!strncmp(temp, "./", 2) || !strncmp(temp, ".\\", 2)) {
155 for ( ; *pos != '\0'; ++pos) {
156 if (*pos == '/' || *pos == '\\') {
159 ret = mkdir(temp, 0755);
164 if ((*(pos - 1) != '/') || (*(pos - 1) != '\\')) {
165 ret = mkdir(temp, 0755);
172 static int hls_delete_old_segments(HLSContext *hls) {
174 HLSSegment *segment, *previous_segment = NULL;
175 float playlist_duration = 0.0f;
176 int ret = 0, path_size, sub_path_size;
177 char *dirname = NULL, *p, *sub_path;
180 segment = hls->segments;
182 playlist_duration += segment->duration;
183 segment = segment->next;
186 segment = hls->old_segments;
188 playlist_duration -= segment->duration;
189 previous_segment = segment;
190 segment = previous_segment->next;
191 if (playlist_duration <= -previous_segment->duration) {
192 previous_segment->next = NULL;
197 if (segment && !hls->use_localtime_mkdir) {
198 if (hls->segment_filename) {
199 dirname = av_strdup(hls->segment_filename);
201 dirname = av_strdup(hls->avf->filename);
204 ret = AVERROR(ENOMEM);
207 p = (char *)av_basename(dirname);
212 av_log(hls, AV_LOG_DEBUG, "deleting old segment %s\n",
214 path_size = (hls->use_localtime_mkdir ? 0 : strlen(dirname)) + strlen(segment->filename) + 1;
215 path = av_malloc(path_size);
217 ret = AVERROR(ENOMEM);
221 if (hls->use_localtime_mkdir)
222 av_strlcpy(path, segment->filename, path_size);
223 else { // segment->filename contains basename only
224 av_strlcpy(path, dirname, path_size);
225 av_strlcat(path, segment->filename, path_size);
228 if (unlink(path) < 0) {
229 av_log(hls, AV_LOG_ERROR, "failed to delete old segment %s: %s\n",
230 path, strerror(errno));
233 if (segment->sub_filename[0] != '\0') {
234 sub_path_size = strlen(dirname) + strlen(segment->sub_filename) + 1;
235 sub_path = av_malloc(sub_path_size);
237 ret = AVERROR(ENOMEM);
241 av_strlcpy(sub_path, dirname, sub_path_size);
242 av_strlcat(sub_path, segment->sub_filename, sub_path_size);
243 if (unlink(sub_path) < 0) {
244 av_log(hls, AV_LOG_ERROR, "failed to delete old segment %s: %s\n",
245 sub_path, strerror(errno));
250 previous_segment = segment;
251 segment = previous_segment->next;
252 av_free(previous_segment);
262 static int hls_encryption_start(AVFormatContext *s)
264 HLSContext *hls = s->priv_data;
267 uint8_t key[KEYSIZE];
269 if ((ret = s->io_open(s, &pb, hls->key_info_file, AVIO_FLAG_READ, NULL)) < 0) {
270 av_log(hls, AV_LOG_ERROR,
271 "error opening key info file %s\n", hls->key_info_file);
275 ff_get_line(pb, hls->key_uri, sizeof(hls->key_uri));
276 hls->key_uri[strcspn(hls->key_uri, "\r\n")] = '\0';
278 ff_get_line(pb, hls->key_file, sizeof(hls->key_file));
279 hls->key_file[strcspn(hls->key_file, "\r\n")] = '\0';
281 ff_get_line(pb, hls->iv_string, sizeof(hls->iv_string));
282 hls->iv_string[strcspn(hls->iv_string, "\r\n")] = '\0';
284 ff_format_io_close(s, &pb);
286 if (!*hls->key_uri) {
287 av_log(hls, AV_LOG_ERROR, "no key URI specified in key info file\n");
288 return AVERROR(EINVAL);
291 if (!*hls->key_file) {
292 av_log(hls, AV_LOG_ERROR, "no key file specified in key info file\n");
293 return AVERROR(EINVAL);
296 if ((ret = s->io_open(s, &pb, hls->key_file, AVIO_FLAG_READ, NULL)) < 0) {
297 av_log(hls, AV_LOG_ERROR, "error opening key file %s\n", hls->key_file);
301 ret = avio_read(pb, key, sizeof(key));
302 ff_format_io_close(s, &pb);
303 if (ret != sizeof(key)) {
304 av_log(hls, AV_LOG_ERROR, "error reading key file %s\n", hls->key_file);
305 if (ret >= 0 || ret == AVERROR_EOF)
306 ret = AVERROR(EINVAL);
309 ff_data_to_hex(hls->key_string, key, sizeof(key), 0);
314 static int read_chomp_line(AVIOContext *s, char *buf, int maxlen)
316 int len = ff_get_line(s, buf, maxlen);
317 while (len > 0 && av_isspace(buf[len - 1]))
322 static int hls_mux_init(AVFormatContext *s)
324 HLSContext *hls = s->priv_data;
326 AVFormatContext *vtt_oc = NULL;
329 ret = avformat_alloc_output_context2(&hls->avf, hls->oformat, NULL, NULL);
334 oc->oformat = hls->oformat;
335 oc->interrupt_callback = s->interrupt_callback;
336 oc->max_delay = s->max_delay;
337 oc->opaque = s->opaque;
338 oc->io_open = s->io_open;
339 oc->io_close = s->io_close;
340 av_dict_copy(&oc->metadata, s->metadata, 0);
342 if(hls->vtt_oformat) {
343 ret = avformat_alloc_output_context2(&hls->vtt_avf, hls->vtt_oformat, NULL, NULL);
346 vtt_oc = hls->vtt_avf;
347 vtt_oc->oformat = hls->vtt_oformat;
348 av_dict_copy(&vtt_oc->metadata, s->metadata, 0);
351 for (i = 0; i < s->nb_streams; i++) {
353 AVFormatContext *loc;
354 if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE)
359 if (!(st = avformat_new_stream(loc, NULL)))
360 return AVERROR(ENOMEM);
361 avcodec_parameters_copy(st->codecpar, s->streams[i]->codecpar);
362 st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
363 st->time_base = s->streams[i]->time_base;
370 static HLSSegment *find_segment_by_filename(HLSSegment *segment, const char *filename)
373 if (!av_strcasecmp(segment->filename,filename))
375 segment = segment->next;
377 return (HLSSegment *) NULL;
380 /* Create a new segment and append it to the segment list */
381 static int hls_append_segment(struct AVFormatContext *s, HLSContext *hls, double duration,
382 int64_t pos, int64_t size)
384 HLSSegment *en = av_malloc(sizeof(*en));
385 const char *filename;
389 return AVERROR(ENOMEM);
391 filename = av_basename(hls->avf->filename);
393 if (hls->use_localtime_mkdir) {
394 filename = hls->avf->filename;
396 if (find_segment_by_filename(hls->segments, filename)
397 || find_segment_by_filename(hls->old_segments, en->filename)) {
398 av_log(hls, AV_LOG_WARNING, "Duplicated segment filename detected: %s\n", filename);
400 av_strlcpy(en->filename, filename, sizeof(en->filename));
402 if(hls->has_subtitle)
403 av_strlcpy(en->sub_filename, av_basename(hls->vtt_avf->filename), sizeof(en->sub_filename));
405 en->sub_filename[0] = '\0';
407 en->duration = duration;
413 if (hls->discontinuity) {
415 hls->discontinuity = 0;
418 if (hls->key_info_file) {
419 av_strlcpy(en->key_uri, hls->key_uri, sizeof(en->key_uri));
420 av_strlcpy(en->iv_string, hls->iv_string, sizeof(en->iv_string));
426 hls->last_segment->next = en;
428 hls->last_segment = en;
430 // EVENT or VOD playlists imply sliding window cannot be used
431 if (hls->pl_type != PLAYLIST_TYPE_NONE)
432 hls->max_nb_segments = 0;
434 if (hls->max_nb_segments && hls->nb_entries >= hls->max_nb_segments) {
436 hls->initial_prog_date_time += en->duration;
437 hls->segments = en->next;
438 if (en && hls->flags & HLS_DELETE_SEGMENTS &&
439 !(hls->flags & HLS_SINGLE_FILE || hls->wrap)) {
440 en->next = hls->old_segments;
441 hls->old_segments = en;
442 if ((ret = hls_delete_old_segments(hls)) < 0)
449 if (hls->max_seg_size > 0) {
457 static int parse_playlist(AVFormatContext *s, const char *url)
459 HLSContext *hls = s->priv_data;
461 int ret = 0, is_segment = 0;
462 int64_t new_start_pos;
466 if ((ret = ffio_open_whitelist(&in, url, AVIO_FLAG_READ,
467 &s->interrupt_callback, NULL,
468 s->protocol_whitelist, s->protocol_blacklist)) < 0)
471 read_chomp_line(in, line, sizeof(line));
472 if (strcmp(line, "#EXTM3U")) {
473 ret = AVERROR_INVALIDDATA;
477 hls->discontinuity = 0;
478 while (!avio_feof(in)) {
479 read_chomp_line(in, line, sizeof(line));
480 if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
481 hls->sequence = atoi(ptr);
482 } else if (av_strstart(line, "#EXT-X-DISCONTINUITY", &ptr)) {
484 hls->discontinuity = 1;
485 } else if (av_strstart(line, "#EXTINF:", &ptr)) {
487 hls->duration = atof(ptr);
488 } else if (av_strstart(line, "#", NULL)) {
490 } else if (line[0]) {
493 new_start_pos = avio_tell(hls->avf->pb);
494 hls->size = new_start_pos - hls->start_pos;
495 av_strlcpy(hls->avf->filename, line, sizeof(line));
496 ret = hls_append_segment(s, hls, hls->duration, hls->start_pos, hls->size);
499 hls->start_pos = new_start_pos;
509 static void hls_free_segments(HLSSegment *p)
520 static void set_http_options(AVDictionary **options, HLSContext *c)
523 av_dict_set(options, "method", c->method, 0);
526 static int hls_window(AVFormatContext *s, int last)
528 HLSContext *hls = s->priv_data;
530 int target_duration = 0;
532 AVIOContext *out = NULL;
533 AVIOContext *sub_out = NULL;
534 char temp_filename[1024];
535 int64_t sequence = FFMAX(hls->start_sequence, hls->sequence - hls->nb_entries);
537 const char *proto = avio_find_protocol_name(s->filename);
538 int use_rename = proto && !strcmp(proto, "file");
539 static unsigned warned_non_file;
540 char *key_uri = NULL;
541 char *iv_string = NULL;
542 AVDictionary *options = NULL;
543 double prog_date_time = hls->initial_prog_date_time;
544 int byterange_mode = (hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size > 0);
546 if (byterange_mode) {
551 if (!use_rename && !warned_non_file++)
552 av_log(s, AV_LOG_ERROR, "Cannot use rename on non file protocol, this may lead to races and temporary partial files\n");
554 set_http_options(&options, hls);
555 snprintf(temp_filename, sizeof(temp_filename), use_rename ? "%s.tmp" : "%s", s->filename);
556 if ((ret = s->io_open(s, &out, temp_filename, AVIO_FLAG_WRITE, &options)) < 0)
559 for (en = hls->segments; en; en = en->next) {
560 if (target_duration < en->duration)
561 target_duration = ceil(en->duration);
564 hls->discontinuity_set = 0;
565 avio_printf(out, "#EXTM3U\n");
566 avio_printf(out, "#EXT-X-VERSION:%d\n", version);
567 if (hls->allowcache == 0 || hls->allowcache == 1) {
568 avio_printf(out, "#EXT-X-ALLOW-CACHE:%s\n", hls->allowcache == 0 ? "NO" : "YES");
570 avio_printf(out, "#EXT-X-TARGETDURATION:%d\n", target_duration);
571 avio_printf(out, "#EXT-X-MEDIA-SEQUENCE:%"PRId64"\n", sequence);
572 if (hls->pl_type == PLAYLIST_TYPE_EVENT) {
573 avio_printf(out, "#EXT-X-PLAYLIST-TYPE:EVENT\n");
574 } else if (hls->pl_type == PLAYLIST_TYPE_VOD) {
575 avio_printf(out, "#EXT-X-PLAYLIST-TYPE:VOD\n");
578 av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%"PRId64"\n",
580 if((hls->flags & HLS_DISCONT_START) && sequence==hls->start_sequence && hls->discontinuity_set==0 ){
581 avio_printf(out, "#EXT-X-DISCONTINUITY\n");
582 hls->discontinuity_set = 1;
584 for (en = hls->segments; en; en = en->next) {
585 if (hls->key_info_file && (!key_uri || strcmp(en->key_uri, key_uri) ||
586 av_strcasecmp(en->iv_string, iv_string))) {
587 avio_printf(out, "#EXT-X-KEY:METHOD=AES-128,URI=\"%s\"", en->key_uri);
589 avio_printf(out, ",IV=0x%s", en->iv_string);
590 avio_printf(out, "\n");
591 key_uri = en->key_uri;
592 iv_string = en->iv_string;
596 avio_printf(out, "#EXT-X-DISCONTINUITY\n");
599 if (hls->flags & HLS_ROUND_DURATIONS)
600 avio_printf(out, "#EXTINF:%ld,\n", lrint(en->duration));
602 avio_printf(out, "#EXTINF:%f,\n", en->duration);
604 avio_printf(out, "#EXT-X-BYTERANGE:%"PRIi64"@%"PRIi64"\n",
606 if (hls->flags & HLS_PROGRAM_DATE_TIME) {
607 time_t tt, wrongsecs;
609 struct tm *tm, tmpbuf;
610 char buf0[128], buf1[128];
611 tt = (int64_t)prog_date_time;
612 milli = av_clip(lrint(1000*(prog_date_time - tt)), 0, 999);
613 tm = localtime_r(&tt, &tmpbuf);
614 strftime(buf0, sizeof(buf0), "%Y-%m-%dT%H:%M:%S", tm);
615 if (!strftime(buf1, sizeof(buf1), "%z", tm) || buf1[1]<'0' ||buf1[1]>'2') {
616 int tz_min, dst = tm->tm_isdst;
617 tm = gmtime_r(&tt, &tmpbuf);
619 wrongsecs = mktime(tm);
620 tz_min = (abs(wrongsecs - tt) + 30) / 60;
621 snprintf(buf1, sizeof(buf1),
623 wrongsecs <= tt ? '+' : '-',
627 avio_printf(out, "#EXT-X-PROGRAM-DATE-TIME:%s.%03d%s\n", buf0, milli, buf1);
628 prog_date_time += en->duration;
631 avio_printf(out, "%s", hls->baseurl);
632 avio_printf(out, "%s\n", en->filename);
635 if (last && (hls->flags & HLS_OMIT_ENDLIST)==0)
636 avio_printf(out, "#EXT-X-ENDLIST\n");
638 if( hls->vtt_m3u8_name ) {
639 if ((ret = s->io_open(s, &sub_out, hls->vtt_m3u8_name, AVIO_FLAG_WRITE, &options)) < 0)
641 avio_printf(sub_out, "#EXTM3U\n");
642 avio_printf(sub_out, "#EXT-X-VERSION:%d\n", version);
643 if (hls->allowcache == 0 || hls->allowcache == 1) {
644 avio_printf(sub_out, "#EXT-X-ALLOW-CACHE:%s\n", hls->allowcache == 0 ? "NO" : "YES");
646 avio_printf(sub_out, "#EXT-X-TARGETDURATION:%d\n", target_duration);
647 avio_printf(sub_out, "#EXT-X-MEDIA-SEQUENCE:%"PRId64"\n", sequence);
649 av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%"PRId64"\n",
652 for (en = hls->segments; en; en = en->next) {
653 avio_printf(sub_out, "#EXTINF:%f,\n", en->duration);
655 avio_printf(sub_out, "#EXT-X-BYTERANGE:%"PRIi64"@%"PRIi64"\n",
658 avio_printf(sub_out, "%s", hls->baseurl);
659 avio_printf(sub_out, "%s\n", en->sub_filename);
663 avio_printf(sub_out, "#EXT-X-ENDLIST\n");
668 av_dict_free(&options);
669 ff_format_io_close(s, &out);
670 ff_format_io_close(s, &sub_out);
671 if (ret >= 0 && use_rename)
672 ff_rename(temp_filename, s->filename, s);
676 static int hls_start(AVFormatContext *s)
678 HLSContext *c = s->priv_data;
679 AVFormatContext *oc = c->avf;
680 AVFormatContext *vtt_oc = c->vtt_avf;
681 AVDictionary *options = NULL;
682 char *filename, iv_string[KEYSIZE*2 + 1];
685 if (c->flags & HLS_SINGLE_FILE) {
686 av_strlcpy(oc->filename, c->basename,
687 sizeof(oc->filename));
689 av_strlcpy(vtt_oc->filename, c->vtt_basename,
690 sizeof(vtt_oc->filename));
691 } else if (c->max_seg_size > 0) {
692 if (av_get_frame_filename2(oc->filename, sizeof(oc->filename),
693 c->basename, c->wrap ? c->sequence % c->wrap : c->sequence,
694 AV_FRAME_FILENAME_FLAGS_MULTIPLE) < 0) {
695 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s', you can try to use -use_localtime 1 with it\n", c->basename);
696 return AVERROR(EINVAL);
699 if (c->use_localtime) {
701 struct tm *tm, tmpbuf;
703 tm = localtime_r(&now0, &tmpbuf);
704 if (!strftime(oc->filename, sizeof(oc->filename), c->basename, tm)) {
705 av_log(oc, AV_LOG_ERROR, "Could not get segment filename with use_localtime\n");
706 return AVERROR(EINVAL);
708 if (c->flags & HLS_SECOND_LEVEL_SEGMENT_INDEX) {
709 char * filename = av_strdup(oc->filename); // %%d will be %d after strftime
711 return AVERROR(ENOMEM);
712 if (av_get_frame_filename2(oc->filename, sizeof(oc->filename),
713 filename, c->wrap ? c->sequence % c->wrap : c->sequence,
714 AV_FRAME_FILENAME_FLAGS_MULTIPLE) < 0) {
715 av_log(c, AV_LOG_ERROR, "Invalid second level segment filename template '%s', you can try to remove second_level_segment_index flag\n", filename);
717 return AVERROR(EINVAL);
721 if (c->use_localtime_mkdir) {
723 char *fn_copy = av_strdup(oc->filename);
725 return AVERROR(ENOMEM);
727 dir = av_dirname(fn_copy);
728 if (mkdir_p(dir) == -1 && errno != EEXIST) {
729 av_log(oc, AV_LOG_ERROR, "Could not create directory %s with use_localtime_mkdir\n", dir);
731 return AVERROR(errno);
735 } else if (av_get_frame_filename2(oc->filename, sizeof(oc->filename),
736 c->basename, c->wrap ? c->sequence % c->wrap : c->sequence,
737 AV_FRAME_FILENAME_FLAGS_MULTIPLE) < 0) {
738 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s' you can try to use -use_localtime 1 with it\n", c->basename);
739 return AVERROR(EINVAL);
741 if( c->vtt_basename) {
742 if (av_get_frame_filename2(vtt_oc->filename, sizeof(vtt_oc->filename),
743 c->vtt_basename, c->wrap ? c->sequence % c->wrap : c->sequence,
744 AV_FRAME_FILENAME_FLAGS_MULTIPLE) < 0) {
745 av_log(vtt_oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", c->vtt_basename);
746 return AVERROR(EINVAL);
752 set_http_options(&options, c);
754 if (c->key_info_file) {
755 if ((err = hls_encryption_start(s)) < 0)
757 if ((err = av_dict_set(&options, "encryption_key", c->key_string, 0))
760 err = av_strlcpy(iv_string, c->iv_string, sizeof(iv_string));
762 snprintf(iv_string, sizeof(iv_string), "%032"PRIx64, c->sequence);
763 if ((err = av_dict_set(&options, "encryption_iv", iv_string, 0)) < 0)
766 filename = av_asprintf("crypto:%s", oc->filename);
768 err = AVERROR(ENOMEM);
771 err = s->io_open(s, &oc->pb, filename, AVIO_FLAG_WRITE, &options);
773 av_dict_free(&options);
777 if ((err = s->io_open(s, &oc->pb, oc->filename, AVIO_FLAG_WRITE, &options)) < 0)
779 if (c->vtt_basename) {
780 set_http_options(&options, c);
781 if ((err = s->io_open(s, &vtt_oc->pb, vtt_oc->filename, AVIO_FLAG_WRITE, &options)) < 0)
784 av_dict_free(&options);
786 /* We only require one PAT/PMT per segment. */
787 if (oc->oformat->priv_class && oc->priv_data) {
790 snprintf(period, sizeof(period), "%d", (INT_MAX / 2) - 1);
792 av_opt_set(oc->priv_data, "mpegts_flags", "resend_headers", 0);
793 av_opt_set(oc->priv_data, "sdt_period", period, 0);
794 av_opt_set(oc->priv_data, "pat_period", period, 0);
797 if (c->vtt_basename) {
798 err = avformat_write_header(vtt_oc,NULL);
805 av_dict_free(&options);
810 static const char * get_default_pattern_localtime_fmt(void)
813 time_t t = time(NULL);
815 p = localtime_r(&t, &tmbuf);
816 // no %s support when strftime returned error or left format string unchanged
817 return (!strftime(b, sizeof(b), "%s", p) || !strcmp(b, "%s")) ? "-%Y%m%d%H%I%S.ts" : "-%s.ts";
820 static int hls_write_header(AVFormatContext *s)
822 HLSContext *hls = s->priv_data;
825 const char *pattern = "%d.ts";
826 const char *pattern_localtime_fmt = get_default_pattern_localtime_fmt();
827 const char *vtt_pattern = "%d.vtt";
828 AVDictionary *options = NULL;
830 int vtt_basename_size;
832 hls->sequence = hls->start_sequence;
833 hls->recording_time = (hls->init_time ? hls->init_time : hls->time) * AV_TIME_BASE;
834 hls->start_pts = AV_NOPTS_VALUE;
836 if (hls->flags & HLS_PROGRAM_DATE_TIME) {
839 hls->initial_prog_date_time = now0;
842 if (hls->format_options_str) {
843 ret = av_dict_parse_string(&hls->format_options, hls->format_options_str, "=", ":", 0);
845 av_log(s, AV_LOG_ERROR, "Could not parse format options list '%s'\n", hls->format_options_str);
850 for (i = 0; i < s->nb_streams; i++) {
852 s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO;
854 s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE;
857 if (hls->has_video > 1)
858 av_log(s, AV_LOG_WARNING,
859 "More than a single video stream present, "
860 "expect issues decoding it.\n");
862 hls->oformat = av_guess_format("mpegts", NULL, NULL);
865 ret = AVERROR_MUXER_NOT_FOUND;
869 if(hls->has_subtitle) {
870 hls->vtt_oformat = av_guess_format("webvtt", NULL, NULL);
872 ret = AVERROR_MUXER_NOT_FOUND;
877 if (hls->segment_filename) {
878 hls->basename = av_strdup(hls->segment_filename);
879 if (!hls->basename) {
880 ret = AVERROR(ENOMEM);
884 if (hls->flags & HLS_SINGLE_FILE)
887 if (hls->use_localtime) {
888 basename_size = strlen(s->filename) + strlen(pattern_localtime_fmt) + 1;
890 basename_size = strlen(s->filename) + strlen(pattern) + 1;
892 hls->basename = av_malloc(basename_size);
893 if (!hls->basename) {
894 ret = AVERROR(ENOMEM);
898 av_strlcpy(hls->basename, s->filename, basename_size);
900 p = strrchr(hls->basename, '.');
903 if (hls->use_localtime) {
904 av_strlcat(hls->basename, pattern_localtime_fmt, basename_size);
906 av_strlcat(hls->basename, pattern, basename_size);
909 if (!hls->use_localtime && (hls->flags & HLS_SECOND_LEVEL_SEGMENT_INDEX)) {
910 av_log(hls, AV_LOG_ERROR, "second_level_segment_index hls_flag requires use_localtime to be true\n");
911 ret = AVERROR(EINVAL);
914 if(hls->has_subtitle) {
916 if (hls->flags & HLS_SINGLE_FILE)
917 vtt_pattern = ".vtt";
918 vtt_basename_size = strlen(s->filename) + strlen(vtt_pattern) + 1;
919 hls->vtt_basename = av_malloc(vtt_basename_size);
920 if (!hls->vtt_basename) {
921 ret = AVERROR(ENOMEM);
924 hls->vtt_m3u8_name = av_malloc(vtt_basename_size);
925 if (!hls->vtt_m3u8_name ) {
926 ret = AVERROR(ENOMEM);
929 av_strlcpy(hls->vtt_basename, s->filename, vtt_basename_size);
930 p = strrchr(hls->vtt_basename, '.');
934 if( hls->subtitle_filename ) {
935 strcpy(hls->vtt_m3u8_name, hls->subtitle_filename);
937 strcpy(hls->vtt_m3u8_name, hls->vtt_basename);
938 av_strlcat(hls->vtt_m3u8_name, "_vtt.m3u8", vtt_basename_size);
940 av_strlcat(hls->vtt_basename, vtt_pattern, vtt_basename_size);
943 if ((ret = hls_mux_init(s)) < 0)
946 if (hls->flags & HLS_APPEND_LIST) {
947 parse_playlist(s, s->filename);
948 hls->discontinuity = 1;
949 if (hls->init_time > 0) {
950 av_log(s, AV_LOG_WARNING, "append_list mode does not support hls_init_time,"
951 " hls_init_time value will have no effect\n");
953 hls->recording_time = hls->time * AV_TIME_BASE;
957 if ((ret = hls_start(s)) < 0)
960 av_dict_copy(&options, hls->format_options, 0);
961 ret = avformat_write_header(hls->avf, &options);
962 if (av_dict_count(options)) {
963 av_log(s, AV_LOG_ERROR, "Some of provided format options in '%s' are not recognized\n", hls->format_options_str);
964 ret = AVERROR(EINVAL);
967 //av_assert0(s->nb_streams == hls->avf->nb_streams);
968 for (i = 0; i < s->nb_streams; i++) {
970 AVStream *outer_st = s->streams[i];
972 if (hls->max_seg_size > 0) {
973 if ((outer_st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) &&
974 (outer_st->codecpar->bit_rate > hls->max_seg_size)) {
975 av_log(s, AV_LOG_WARNING, "Your video bitrate is bigger than hls_segment_size, "
976 "(%"PRId64 " > %"PRId64 "), the result maybe not be what you want.",
977 outer_st->codecpar->bit_rate, hls->max_seg_size);
981 if (outer_st->codecpar->codec_type != AVMEDIA_TYPE_SUBTITLE)
982 inner_st = hls->avf->streams[i];
983 else if (hls->vtt_avf)
984 inner_st = hls->vtt_avf->streams[0];
986 /* We have a subtitle stream, when the user does not want one */
990 avpriv_set_pts_info(outer_st, inner_st->pts_wrap_bits, inner_st->time_base.num, inner_st->time_base.den);
994 av_dict_free(&options);
996 av_freep(&hls->basename);
997 av_freep(&hls->vtt_basename);
999 avformat_free_context(hls->avf);
1001 avformat_free_context(hls->vtt_avf);
1007 static int hls_write_packet(AVFormatContext *s, AVPacket *pkt)
1009 HLSContext *hls = s->priv_data;
1010 AVFormatContext *oc = NULL;
1011 AVStream *st = s->streams[pkt->stream_index];
1012 int64_t end_pts = hls->recording_time * hls->number;
1014 int ret, can_split = 1;
1015 int stream_index = 0;
1017 if (hls->sequence - hls->nb_entries > hls->start_sequence && hls->init_time > 0) {
1018 /* reset end_pts, hls->recording_time at end of the init hls list */
1019 int init_list_dur = hls->init_time * hls->nb_entries * AV_TIME_BASE;
1020 int after_init_list_dur = (hls->sequence - hls->nb_entries ) * hls->time * AV_TIME_BASE;
1021 hls->recording_time = hls->time * AV_TIME_BASE;
1022 end_pts = init_list_dur + after_init_list_dur ;
1025 if( st->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE ) {
1030 stream_index = pkt->stream_index;
1032 if (hls->start_pts == AV_NOPTS_VALUE) {
1033 hls->start_pts = pkt->pts;
1034 hls->end_pts = pkt->pts;
1037 if (hls->has_video) {
1038 can_split = st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO &&
1039 ((pkt->flags & AV_PKT_FLAG_KEY) || (hls->flags & HLS_SPLIT_BY_TIME));
1040 is_ref_pkt = st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO;
1042 if (pkt->pts == AV_NOPTS_VALUE)
1043 is_ref_pkt = can_split = 0;
1046 hls->duration = (double)(pkt->pts - hls->end_pts)
1047 * st->time_base.num / st->time_base.den;
1049 if (can_split && av_compare_ts(pkt->pts - hls->start_pts, st->time_base,
1050 end_pts, AV_TIME_BASE_Q) >= 0) {
1051 int64_t new_start_pos;
1052 av_write_frame(oc, NULL); /* Flush any buffered data */
1054 new_start_pos = avio_tell(hls->avf->pb);
1055 hls->size = new_start_pos - hls->start_pos;
1056 ret = hls_append_segment(s, hls, hls->duration, hls->start_pos, hls->size);
1057 hls->start_pos = new_start_pos;
1061 hls->end_pts = pkt->pts;
1064 if (hls->flags & HLS_SINGLE_FILE) {
1065 if (hls->avf->oformat->priv_class && hls->avf->priv_data)
1066 av_opt_set(hls->avf->priv_data, "mpegts_flags", "resend_headers", 0);
1068 } else if (hls->max_seg_size > 0) {
1069 if (hls->avf->oformat->priv_class && hls->avf->priv_data)
1070 av_opt_set(hls->avf->priv_data, "mpegts_flags", "resend_headers", 0);
1071 if (hls->start_pos >= hls->max_seg_size) {
1073 ff_format_io_close(s, &oc->pb);
1075 ff_format_io_close(s, &hls->vtt_avf->pb);
1078 /* When split segment by byte, the duration is short than hls_time,
1079 * so it is not enough one segment duration as hls_time, */
1084 ff_format_io_close(s, &oc->pb);
1086 ff_format_io_close(s, &hls->vtt_avf->pb);
1094 if( st->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE )
1099 if ((ret = hls_window(s, 0)) < 0)
1103 ret = ff_write_chained(oc, stream_index, pkt, s, 0);
1108 static int hls_write_trailer(struct AVFormatContext *s)
1110 HLSContext *hls = s->priv_data;
1111 AVFormatContext *oc = hls->avf;
1112 AVFormatContext *vtt_oc = hls->vtt_avf;
1114 av_write_trailer(oc);
1116 hls->size = avio_tell(hls->avf->pb) - hls->start_pos;
1117 ff_format_io_close(s, &oc->pb);
1118 hls_append_segment(s, hls, hls->duration, hls->start_pos, hls->size);
1123 av_write_trailer(vtt_oc);
1124 hls->size = avio_tell(hls->vtt_avf->pb) - hls->start_pos;
1125 ff_format_io_close(s, &vtt_oc->pb);
1127 av_freep(&hls->basename);
1128 avformat_free_context(oc);
1134 av_freep(&hls->vtt_basename);
1135 av_freep(&hls->vtt_m3u8_name);
1136 avformat_free_context(vtt_oc);
1139 hls_free_segments(hls->segments);
1140 hls_free_segments(hls->old_segments);
1144 #define OFFSET(x) offsetof(HLSContext, x)
1145 #define E AV_OPT_FLAG_ENCODING_PARAM
1146 static const AVOption options[] = {
1147 {"start_number", "set first number in the sequence", OFFSET(start_sequence),AV_OPT_TYPE_INT64, {.i64 = 0}, 0, INT64_MAX, E},
1148 {"hls_time", "set segment length in seconds", OFFSET(time), AV_OPT_TYPE_FLOAT, {.dbl = 2}, 0, FLT_MAX, E},
1149 {"hls_init_time", "set segment length in seconds at init list", OFFSET(init_time), AV_OPT_TYPE_FLOAT, {.dbl = 0}, 0, FLT_MAX, E},
1150 {"hls_list_size", "set maximum number of playlist entries", OFFSET(max_nb_segments), AV_OPT_TYPE_INT, {.i64 = 5}, 0, INT_MAX, E},
1151 {"hls_ts_options","set hls mpegts list of options for the container format used for hls", OFFSET(format_options_str), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
1152 {"hls_vtt_options","set hls vtt list of options for the container format used for hls", OFFSET(vtt_format_options_str), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
1153 {"hls_wrap", "set number after which the index wraps", OFFSET(wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E},
1154 {"hls_allow_cache", "explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments", OFFSET(allowcache), AV_OPT_TYPE_INT, {.i64 = -1}, INT_MIN, INT_MAX, E},
1155 {"hls_base_url", "url to prepend to each playlist entry", OFFSET(baseurl), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
1156 {"hls_segment_filename", "filename template for segment files", OFFSET(segment_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
1157 {"hls_segment_size", "maximum size per segment file, (in bytes)", OFFSET(max_seg_size), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E},
1158 {"hls_key_info_file", "file with key URI and key file path", OFFSET(key_info_file), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
1159 {"hls_subtitle_path", "set path of hls subtitles", OFFSET(subtitle_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
1160 {"hls_flags", "set flags affecting HLS playlist and media file generation", OFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0 }, 0, UINT_MAX, E, "flags"},
1161 {"single_file", "generate a single media file indexed with byte ranges", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_SINGLE_FILE }, 0, UINT_MAX, E, "flags"},
1162 {"delete_segments", "delete segment files that are no longer part of the playlist", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_DELETE_SEGMENTS }, 0, UINT_MAX, E, "flags"},
1163 {"round_durations", "round durations in m3u8 to whole numbers", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_ROUND_DURATIONS }, 0, UINT_MAX, E, "flags"},
1164 {"discont_start", "start the playlist with a discontinuity tag", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_DISCONT_START }, 0, UINT_MAX, E, "flags"},
1165 {"omit_endlist", "Do not append an endlist when ending stream", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_OMIT_ENDLIST }, 0, UINT_MAX, E, "flags"},
1166 {"split_by_time", "split the hls segment by time which user set by hls_time", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_SPLIT_BY_TIME }, 0, UINT_MAX, E, "flags"},
1167 {"append_list", "append the new segments into old hls segment list", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_APPEND_LIST }, 0, UINT_MAX, E, "flags"},
1168 {"program_date_time", "add EXT-X-PROGRAM-DATE-TIME", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_PROGRAM_DATE_TIME }, 0, UINT_MAX, E, "flags"},
1169 {"second_level_segment_index", "include segment index in segment filenames when use_localtime", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_SECOND_LEVEL_SEGMENT_INDEX }, 0, UINT_MAX, E, "flags"},
1170 {"use_localtime", "set filename expansion with strftime at segment creation", OFFSET(use_localtime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1171 {"use_localtime_mkdir", "create last directory component in strftime-generated filename", OFFSET(use_localtime_mkdir), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1172 {"hls_playlist_type", "set the HLS playlist type", OFFSET(pl_type), AV_OPT_TYPE_INT, {.i64 = PLAYLIST_TYPE_NONE }, 0, PLAYLIST_TYPE_NB-1, E, "pl_type" },
1173 {"event", "EVENT playlist", 0, AV_OPT_TYPE_CONST, {.i64 = PLAYLIST_TYPE_EVENT }, INT_MIN, INT_MAX, E, "pl_type" },
1174 {"vod", "VOD playlist", 0, AV_OPT_TYPE_CONST, {.i64 = PLAYLIST_TYPE_VOD }, INT_MIN, INT_MAX, E, "pl_type" },
1175 {"method", "set the HTTP method", OFFSET(method), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
1180 static const AVClass hls_class = {
1181 .class_name = "hls muxer",
1182 .item_name = av_default_item_name,
1184 .version = LIBAVUTIL_VERSION_INT,
1188 AVOutputFormat ff_hls_muxer = {
1190 .long_name = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
1191 .extensions = "m3u8",
1192 .priv_data_size = sizeof(HLSContext),
1193 .audio_codec = AV_CODEC_ID_AAC,
1194 .video_codec = AV_CODEC_ID_H264,
1195 .subtitle_codec = AV_CODEC_ID_WEBVTT,
1196 .flags = AVFMT_NOFILE | AVFMT_ALLOW_FLUSH,
1197 .write_header = hls_write_header,
1198 .write_packet = hls_write_packet,
1199 .write_trailer = hls_write_trailer,
1200 .priv_class = &hls_class,