2 * Apple HTTP Live Streaming segmenter
3 * Copyright (c) 2012, Luca Barbato
4 * Copyright (c) 2017 Akamai Technologies, Inc.
6 * This file is part of FFmpeg.
8 * FFmpeg is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * FFmpeg is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
33 #include <openssl/rand.h>
36 #include "libavutil/avassert.h"
37 #include "libavutil/mathematics.h"
38 #include "libavutil/parseutils.h"
39 #include "libavutil/avstring.h"
40 #include "libavutil/intreadwrite.h"
41 #include "libavutil/random_seed.h"
42 #include "libavutil/opt.h"
43 #include "libavutil/log.h"
44 #include "libavutil/time_internal.h"
47 #include "avio_internal.h"
48 #if CONFIG_HTTP_PROTOCOL
51 #include "hlsplaylist.h"
53 #include "os_support.h"
56 HLS_START_SEQUENCE_AS_START_NUMBER = 0,
57 HLS_START_SEQUENCE_AS_SECONDS_SINCE_EPOCH = 1,
58 HLS_START_SEQUENCE_AS_FORMATTED_DATETIME = 2, // YYYYMMDDhhmmss
59 } StartSequenceSourceType;
62 #define LINE_BUFFER_SIZE 1024
63 #define HLS_MICROSECOND_UNIT 1000000
64 #define POSTFIX_PATTERN "_%d"
66 typedef struct HLSSegment {
68 char sub_filename[1024];
69 double duration; /* in seconds */
74 char key_uri[LINE_BUFFER_SIZE + 1];
75 char iv_string[KEYSIZE*2 + 1];
77 struct HLSSegment *next;
80 typedef enum HLSFlags {
81 // Generate a single media file and use byte ranges in the playlist.
82 HLS_SINGLE_FILE = (1 << 0),
83 HLS_DELETE_SEGMENTS = (1 << 1),
84 HLS_ROUND_DURATIONS = (1 << 2),
85 HLS_DISCONT_START = (1 << 3),
86 HLS_OMIT_ENDLIST = (1 << 4),
87 HLS_SPLIT_BY_TIME = (1 << 5),
88 HLS_APPEND_LIST = (1 << 6),
89 HLS_PROGRAM_DATE_TIME = (1 << 7),
90 HLS_SECOND_LEVEL_SEGMENT_INDEX = (1 << 8), // include segment index in segment filenames when use_localtime e.g.: %%03d
91 HLS_SECOND_LEVEL_SEGMENT_DURATION = (1 << 9), // include segment duration (microsec) in segment filenames when use_localtime e.g.: %%09t
92 HLS_SECOND_LEVEL_SEGMENT_SIZE = (1 << 10), // include segment size (bytes) in segment filenames when use_localtime e.g.: %%014s
93 HLS_TEMP_FILE = (1 << 11),
94 HLS_PERIODIC_REKEY = (1 << 12),
95 HLS_INDEPENDENT_SEGMENTS = (1 << 13),
103 typedef struct VariantStream {
106 AVOutputFormat *oformat;
107 AVOutputFormat *vtt_oformat;
110 int init_range_length;
112 AVFormatContext *avf;
113 AVFormatContext *vtt_avf;
118 double dpp; // duration per packet
121 double duration; // last segment duration computed so far, in seconds
122 int64_t start_pos; // last segment starting position
123 int64_t size; // last segment size
125 int discontinuity_set;
128 HLSSegment *segments;
129 HLSSegment *last_segment;
130 HLSSegment *old_segments;
137 double initial_prog_date_time;
138 char current_segment_final_filename_fmt[1024]; // when renaming segments
140 char *fmp4_init_filename;
141 char *base_output_dirname;
145 unsigned int nb_streams;
146 int m3u8_created; /* status of media play-list creation */
147 char *agroup; /* audio group name */
151 typedef struct HLSContext {
152 const AVClass *class; // Class for private options.
153 int64_t start_sequence;
154 uint32_t start_sequence_source_type; // enum StartSequenceSourceType
156 float time; // Set by a private option.
157 float init_time; // Set by a private option.
158 int max_nb_segments; // Set by a private option.
160 int wrap; // Set by a private option.
162 uint32_t flags; // enum HLSFlags
163 uint32_t pl_type; // enum PlaylistType
164 char *segment_filename;
165 char *fmp4_init_filename;
168 int use_localtime; ///< flag to expand filename with localtime
169 int use_localtime_mkdir;///< flag to mkdir dirname in timebased filename
171 int64_t recording_time;
172 int64_t max_seg_size; // every segment file max size
175 char *format_options_str;
176 char *vtt_format_options_str;
177 char *subtitle_filename;
178 AVDictionary *format_options;
188 char key_file[LINE_BUFFER_SIZE + 1];
189 char key_uri[LINE_BUFFER_SIZE + 1];
190 char key_string[KEYSIZE*2 + 1];
191 char iv_string[KEYSIZE*2 + 1];
192 AVDictionary *vtt_format_options;
197 VariantStream *var_streams;
198 unsigned int nb_varstreams;
200 int master_m3u8_created; /* status of master play-list creation */
201 char *master_m3u8_url; /* URL of the master m3u8 file */
202 int version; /* HLS version */
203 char *var_stream_map; /* user specified variant stream map string */
204 char *master_pl_name;
205 unsigned int master_publish_rate;
207 AVIOContext *m3u8_out;
208 AVIOContext *sub_m3u8_out;
211 static int mkdir_p(const char *path) {
213 char *temp = av_strdup(path);
217 if (!path || !temp) {
221 if (!strncmp(temp, "/", 1) || !strncmp(temp, "\\", 1)) {
223 } else if (!strncmp(temp, "./", 2) || !strncmp(temp, ".\\", 2)) {
227 for ( ; *pos != '\0'; ++pos) {
228 if (*pos == '/' || *pos == '\\') {
231 ret = mkdir(temp, 0755);
236 if ((*(pos - 1) != '/') || (*(pos - 1) != '\\')) {
237 ret = mkdir(temp, 0755);
244 static int is_http_proto(char *filename) {
245 const char *proto = avio_find_protocol_name(filename);
246 return proto ? (!av_strcasecmp(proto, "http") || !av_strcasecmp(proto, "https")) : 0;
249 static int hlsenc_io_open(AVFormatContext *s, AVIOContext **pb, char *filename,
250 AVDictionary **options) {
251 HLSContext *hls = s->priv_data;
252 int http_base_proto = filename ? is_http_proto(filename) : 0;
253 int err = AVERROR_MUXER_NOT_FOUND;
254 if (!*pb || !http_base_proto || !hls->http_persistent) {
255 err = s->io_open(s, pb, filename, AVIO_FLAG_WRITE, options);
256 #if CONFIG_HTTP_PROTOCOL
258 URLContext *http_url_context = ffio_geturlcontext(*pb);
259 av_assert0(http_url_context);
260 err = ff_http_do_new_request(http_url_context, filename);
266 static void hlsenc_io_close(AVFormatContext *s, AVIOContext **pb, char *filename) {
267 HLSContext *hls = s->priv_data;
268 int http_base_proto = filename ? is_http_proto(filename) : 0;
270 if (!http_base_proto || !hls->http_persistent || hls->key_info_file || hls->encrypt) {
271 ff_format_io_close(s, pb);
272 #if CONFIG_HTTP_PROTOCOL
274 URLContext *http_url_context = ffio_geturlcontext(*pb);
275 av_assert0(http_url_context);
277 ffurl_shutdown(http_url_context, AVIO_FLAG_WRITE);
282 static void set_http_options(AVFormatContext *s, AVDictionary **options, HLSContext *c)
284 int http_base_proto = is_http_proto(s->filename);
287 av_dict_set(options, "method", c->method, 0);
288 } else if (http_base_proto) {
289 av_log(c, AV_LOG_WARNING, "No HTTP method set, hls muxer defaulting to method PUT.\n");
290 av_dict_set(options, "method", "PUT", 0);
293 av_dict_set(options, "user_agent", c->user_agent, 0);
294 if (c->http_persistent)
295 av_dict_set_int(options, "multiple_requests", 1, 0);
299 static int replace_int_data_in_filename(char *buf, int buf_size, const char *filename, char placeholder, int64_t number)
302 char *q, buf1[20], c;
303 int nd, len, addchar_count;
312 if (c == '%' && *(p+1) == '%') // %%
314 else if (c == '%' && (av_isdigit(*(p+1)) || *(p+1) == placeholder)) {
317 while (av_isdigit(*(p + addchar_count))) {
318 nd = nd * 10 + *(p + addchar_count) - '0';
322 if (*(p + addchar_count) == placeholder) {
323 len = snprintf(buf1, sizeof(buf1), "%0*"PRId64, (number < 0) ? nd : nd++, number);
324 if (len < 1) // returned error or empty buf1
326 if ((q - buf + len) > buf_size - 1)
328 memcpy(q, buf1, len);
330 p += (addchar_count + 1);
338 while (addchar_count--)
339 if ((q - buf) < buf_size - 1)
351 static void write_styp(AVIOContext *pb)
354 ffio_wfourcc(pb, "styp");
355 ffio_wfourcc(pb, "msdh");
356 avio_wb32(pb, 0); /* minor */
357 ffio_wfourcc(pb, "msdh");
358 ffio_wfourcc(pb, "msix");
361 static int flush_dynbuf(VariantStream *vs, int *range_length)
363 AVFormatContext *ctx = vs->avf;
367 return AVERROR(EINVAL);
371 av_write_frame(ctx, NULL);
375 *range_length = avio_close_dyn_buf(ctx->pb, &buffer);
377 avio_write(vs->out, buffer, *range_length);
381 return avio_open_dyn_buf(&ctx->pb);
384 static int hls_delete_old_segments(AVFormatContext *s, HLSContext *hls,
387 HLSSegment *segment, *previous_segment = NULL;
388 float playlist_duration = 0.0f;
389 int ret = 0, path_size, sub_path_size;
390 char *dirname = NULL, *p, *sub_path;
392 AVDictionary *options = NULL;
393 AVIOContext *out = NULL;
394 const char *proto = NULL;
396 segment = vs->segments;
398 playlist_duration += segment->duration;
399 segment = segment->next;
402 segment = vs->old_segments;
404 playlist_duration -= segment->duration;
405 previous_segment = segment;
406 segment = previous_segment->next;
407 if (playlist_duration <= -previous_segment->duration) {
408 previous_segment->next = NULL;
413 if (segment && !hls->use_localtime_mkdir) {
414 if (hls->segment_filename) {
415 dirname = av_strdup(hls->segment_filename);
417 dirname = av_strdup(vs->avf->filename);
420 ret = AVERROR(ENOMEM);
423 p = (char *)av_basename(dirname);
428 av_log(hls, AV_LOG_DEBUG, "deleting old segment %s\n",
430 path_size = (hls->use_localtime_mkdir ? 0 : strlen(dirname)) + strlen(segment->filename) + 1;
431 path = av_malloc(path_size);
433 ret = AVERROR(ENOMEM);
437 if (hls->use_localtime_mkdir)
438 av_strlcpy(path, segment->filename, path_size);
439 else { // segment->filename contains basename only
440 av_strlcpy(path, dirname, path_size);
441 av_strlcat(path, segment->filename, path_size);
444 proto = avio_find_protocol_name(s->filename);
445 if (hls->method || (proto && !av_strcasecmp(proto, "http"))) {
446 av_dict_set(&options, "method", "DELETE", 0);
447 if ((ret = vs->avf->io_open(vs->avf, &out, path, AVIO_FLAG_WRITE, &options)) < 0)
449 ff_format_io_close(vs->avf, &out);
450 } else if (unlink(path) < 0) {
451 av_log(hls, AV_LOG_ERROR, "failed to delete old segment %s: %s\n",
452 path, strerror(errno));
455 if ((segment->sub_filename[0] != '\0')) {
456 sub_path_size = strlen(segment->sub_filename) + 1 + (dirname ? strlen(dirname) : 0);
457 sub_path = av_malloc(sub_path_size);
459 ret = AVERROR(ENOMEM);
463 av_strlcpy(sub_path, dirname, sub_path_size);
464 av_strlcat(sub_path, segment->sub_filename, sub_path_size);
466 if (hls->method || (proto && !av_strcasecmp(proto, "http"))) {
467 av_dict_set(&options, "method", "DELETE", 0);
468 if ((ret = vs->avf->io_open(vs->avf, &out, sub_path, AVIO_FLAG_WRITE, &options)) < 0) {
472 ff_format_io_close(vs->avf, &out);
473 } else if (unlink(sub_path) < 0) {
474 av_log(hls, AV_LOG_ERROR, "failed to delete old segment %s: %s\n",
475 sub_path, strerror(errno));
480 previous_segment = segment;
481 segment = previous_segment->next;
482 av_free(previous_segment);
492 static int randomize(uint8_t *buf, int len)
495 gcry_randomize(buf, len, GCRY_VERY_STRONG_RANDOM);
498 if (RAND_bytes(buf, len))
501 return AVERROR(ENOSYS);
503 return AVERROR(EINVAL);
506 static int do_encrypt(AVFormatContext *s, VariantStream *vs)
508 HLSContext *hls = s->priv_data;
512 uint8_t key[KEYSIZE];
514 len = strlen(s->filename) + 4 + 1;
515 hls->key_basename = av_mallocz(len);
516 if (!hls->key_basename)
517 return AVERROR(ENOMEM);
519 av_strlcpy(hls->key_basename, s->filename, len);
520 av_strlcat(hls->key_basename, ".key", len);
523 av_strlcpy(hls->key_file, hls->key_url, sizeof(hls->key_file));
524 av_strlcpy(hls->key_uri, hls->key_url, sizeof(hls->key_uri));
526 av_strlcpy(hls->key_file, hls->key_basename, sizeof(hls->key_file));
527 av_strlcpy(hls->key_uri, hls->key_basename, sizeof(hls->key_uri));
530 if (!*hls->iv_string) {
531 uint8_t iv[16] = { 0 };
535 AV_WB64(iv + 8, vs->sequence);
537 memcpy(iv, hls->iv, sizeof(iv));
539 ff_data_to_hex(buf, iv, sizeof(iv), 0);
541 memcpy(hls->iv_string, buf, sizeof(hls->iv_string));
544 if (!*hls->key_uri) {
545 av_log(hls, AV_LOG_ERROR, "no key URI specified in key info file\n");
546 return AVERROR(EINVAL);
549 if (!*hls->key_file) {
550 av_log(hls, AV_LOG_ERROR, "no key file specified in key info file\n");
551 return AVERROR(EINVAL);
554 if (!*hls->key_string) {
556 if ((ret = randomize(key, sizeof(key))) < 0) {
557 av_log(s, AV_LOG_ERROR, "Cannot generate a strong random key\n");
561 memcpy(key, hls->key, sizeof(key));
564 ff_data_to_hex(hls->key_string, key, sizeof(key), 0);
565 if ((ret = s->io_open(s, &pb, hls->key_file, AVIO_FLAG_WRITE, NULL)) < 0)
567 avio_seek(pb, 0, SEEK_CUR);
568 avio_write(pb, key, KEYSIZE);
575 static int hls_encryption_start(AVFormatContext *s)
577 HLSContext *hls = s->priv_data;
580 uint8_t key[KEYSIZE];
582 if ((ret = s->io_open(s, &pb, hls->key_info_file, AVIO_FLAG_READ, NULL)) < 0) {
583 av_log(hls, AV_LOG_ERROR,
584 "error opening key info file %s\n", hls->key_info_file);
588 ff_get_line(pb, hls->key_uri, sizeof(hls->key_uri));
589 hls->key_uri[strcspn(hls->key_uri, "\r\n")] = '\0';
591 ff_get_line(pb, hls->key_file, sizeof(hls->key_file));
592 hls->key_file[strcspn(hls->key_file, "\r\n")] = '\0';
594 ff_get_line(pb, hls->iv_string, sizeof(hls->iv_string));
595 hls->iv_string[strcspn(hls->iv_string, "\r\n")] = '\0';
597 ff_format_io_close(s, &pb);
599 if (!*hls->key_uri) {
600 av_log(hls, AV_LOG_ERROR, "no key URI specified in key info file\n");
601 return AVERROR(EINVAL);
604 if (!*hls->key_file) {
605 av_log(hls, AV_LOG_ERROR, "no key file specified in key info file\n");
606 return AVERROR(EINVAL);
609 if ((ret = s->io_open(s, &pb, hls->key_file, AVIO_FLAG_READ, NULL)) < 0) {
610 av_log(hls, AV_LOG_ERROR, "error opening key file %s\n", hls->key_file);
614 ret = avio_read(pb, key, sizeof(key));
615 ff_format_io_close(s, &pb);
616 if (ret != sizeof(key)) {
617 av_log(hls, AV_LOG_ERROR, "error reading key file %s\n", hls->key_file);
618 if (ret >= 0 || ret == AVERROR_EOF)
619 ret = AVERROR(EINVAL);
622 ff_data_to_hex(hls->key_string, key, sizeof(key), 0);
627 static int read_chomp_line(AVIOContext *s, char *buf, int maxlen)
629 int len = ff_get_line(s, buf, maxlen);
630 while (len > 0 && av_isspace(buf[len - 1]))
635 static int hls_mux_init(AVFormatContext *s, VariantStream *vs)
637 AVDictionary *options = NULL;
638 HLSContext *hls = s->priv_data;
640 AVFormatContext *vtt_oc = NULL;
641 int byterange_mode = (hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size > 0);
644 ret = avformat_alloc_output_context2(&vs->avf, vs->oformat, NULL, NULL);
649 oc->filename[0] = '\0';
650 oc->oformat = vs->oformat;
651 oc->interrupt_callback = s->interrupt_callback;
652 oc->max_delay = s->max_delay;
653 oc->opaque = s->opaque;
654 oc->io_open = s->io_open;
655 oc->io_close = s->io_close;
656 av_dict_copy(&oc->metadata, s->metadata, 0);
658 if(vs->vtt_oformat) {
659 ret = avformat_alloc_output_context2(&vs->vtt_avf, vs->vtt_oformat, NULL, NULL);
662 vtt_oc = vs->vtt_avf;
663 vtt_oc->oformat = vs->vtt_oformat;
664 av_dict_copy(&vtt_oc->metadata, s->metadata, 0);
667 for (i = 0; i < vs->nb_streams; i++) {
669 AVFormatContext *loc;
670 if (vs->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE)
675 if (!(st = avformat_new_stream(loc, NULL)))
676 return AVERROR(ENOMEM);
677 avcodec_parameters_copy(st->codecpar, vs->streams[i]->codecpar);
678 if (!oc->oformat->codec_tag ||
679 av_codec_get_id (oc->oformat->codec_tag, vs->streams[i]->codecpar->codec_tag) == st->codecpar->codec_id ||
680 av_codec_get_tag(oc->oformat->codec_tag, vs->streams[i]->codecpar->codec_id) <= 0) {
681 st->codecpar->codec_tag = vs->streams[i]->codecpar->codec_tag;
683 st->codecpar->codec_tag = 0;
686 st->sample_aspect_ratio = vs->streams[i]->sample_aspect_ratio;
687 st->time_base = vs->streams[i]->time_base;
688 av_dict_copy(&st->metadata, vs->streams[i]->metadata, 0);
691 vs->packets_written = 1;
694 vs->fmp4_init_mode = 0;
696 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
697 if (hls->max_seg_size > 0) {
698 av_log(s, AV_LOG_WARNING, "Multi-file byterange mode is currently unsupported in the HLS muxer.\n");
699 return AVERROR_PATCHWELCOME;
702 vs->packets_written = 0;
703 vs->init_range_length = 0;
704 vs->fmp4_init_mode = !byterange_mode;
705 set_http_options(s, &options, hls);
706 if ((ret = avio_open_dyn_buf(&oc->pb)) < 0)
709 ret = hlsenc_io_open(s, &vs->out, vs->base_output_dirname, &options);
710 av_dict_free(&options);
712 av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", vs->fmp4_init_filename);
716 if (hls->format_options_str) {
717 ret = av_dict_parse_string(&hls->format_options, hls->format_options_str, "=", ":", 0);
719 av_log(s, AV_LOG_ERROR, "Could not parse format options list '%s'\n",
720 hls->format_options_str);
725 av_dict_copy(&options, hls->format_options, 0);
726 av_dict_set(&options, "fflags", "-autobsf", 0);
727 av_dict_set(&options, "movflags", "frag_custom+dash+delay_moov", 0);
728 ret = avformat_init_output(oc, &options);
731 if (av_dict_count(options)) {
732 av_log(s, AV_LOG_ERROR, "Some of the provided format options in '%s' are not recognized\n", hls->format_options_str);
733 av_dict_free(&options);
734 return AVERROR(EINVAL);
737 av_dict_free(&options);
742 static HLSSegment *find_segment_by_filename(HLSSegment *segment, const char *filename)
745 if (!av_strcasecmp(segment->filename,filename))
747 segment = segment->next;
749 return (HLSSegment *) NULL;
752 static int sls_flags_filename_process(struct AVFormatContext *s, HLSContext *hls,
753 VariantStream *vs, HLSSegment *en,
754 double duration, int64_t pos, int64_t size)
756 if ((hls->flags & (HLS_SECOND_LEVEL_SEGMENT_SIZE | HLS_SECOND_LEVEL_SEGMENT_DURATION)) &&
757 strlen(vs->current_segment_final_filename_fmt)) {
758 av_strlcpy(vs->avf->filename, vs->current_segment_final_filename_fmt, sizeof(vs->avf->filename));
759 if (hls->flags & HLS_SECOND_LEVEL_SEGMENT_SIZE) {
760 char * filename = av_strdup(vs->avf->filename); // %%s will be %s after strftime
763 return AVERROR(ENOMEM);
765 if (replace_int_data_in_filename(vs->avf->filename, sizeof(vs->avf->filename),
766 filename, 's', pos + size) < 1) {
767 av_log(hls, AV_LOG_ERROR,
768 "Invalid second level segment filename template '%s', "
769 "you can try to remove second_level_segment_size flag\n",
773 return AVERROR(EINVAL);
777 if (hls->flags & HLS_SECOND_LEVEL_SEGMENT_DURATION) {
778 char * filename = av_strdup(vs->avf->filename); // %%t will be %t after strftime
781 return AVERROR(ENOMEM);
783 if (replace_int_data_in_filename(vs->avf->filename, sizeof(vs->avf->filename),
784 filename, 't', (int64_t)round(duration * HLS_MICROSECOND_UNIT)) < 1) {
785 av_log(hls, AV_LOG_ERROR,
786 "Invalid second level segment filename template '%s', "
787 "you can try to remove second_level_segment_time flag\n",
791 return AVERROR(EINVAL);
799 static int sls_flag_check_duration_size_index(HLSContext *hls)
803 if (hls->flags & HLS_SECOND_LEVEL_SEGMENT_DURATION) {
804 av_log(hls, AV_LOG_ERROR,
805 "second_level_segment_duration hls_flag requires use_localtime to be true\n");
806 ret = AVERROR(EINVAL);
808 if (hls->flags & HLS_SECOND_LEVEL_SEGMENT_SIZE) {
809 av_log(hls, AV_LOG_ERROR,
810 "second_level_segment_size hls_flag requires use_localtime to be true\n");
811 ret = AVERROR(EINVAL);
813 if (hls->flags & HLS_SECOND_LEVEL_SEGMENT_INDEX) {
814 av_log(hls, AV_LOG_ERROR,
815 "second_level_segment_index hls_flag requires use_localtime to be true\n");
816 ret = AVERROR(EINVAL);
822 static int sls_flag_check_duration_size(HLSContext *hls, VariantStream *vs)
824 const char *proto = avio_find_protocol_name(vs->basename);
825 int segment_renaming_ok = proto && !strcmp(proto, "file");
828 if ((hls->flags & HLS_SECOND_LEVEL_SEGMENT_DURATION) && !segment_renaming_ok) {
829 av_log(hls, AV_LOG_ERROR,
830 "second_level_segment_duration hls_flag works only with file protocol segment names\n");
831 ret = AVERROR(EINVAL);
833 if ((hls->flags & HLS_SECOND_LEVEL_SEGMENT_SIZE) && !segment_renaming_ok) {
834 av_log(hls, AV_LOG_ERROR,
835 "second_level_segment_size hls_flag works only with file protocol segment names\n");
836 ret = AVERROR(EINVAL);
842 static void sls_flag_file_rename(HLSContext *hls, VariantStream *vs, char *old_filename) {
843 if ((hls->flags & (HLS_SECOND_LEVEL_SEGMENT_SIZE | HLS_SECOND_LEVEL_SEGMENT_DURATION)) &&
844 strlen(vs->current_segment_final_filename_fmt)) {
845 ff_rename(old_filename, vs->avf->filename, hls);
849 static int sls_flag_use_localtime_filename(AVFormatContext *oc, HLSContext *c, VariantStream *vs)
851 if (c->flags & HLS_SECOND_LEVEL_SEGMENT_INDEX) {
852 char * filename = av_strdup(oc->filename); // %%d will be %d after strftime
854 return AVERROR(ENOMEM);
855 if (replace_int_data_in_filename(oc->filename, sizeof(oc->filename),
857 filename, 'd', c->wrap ? vs->sequence % c->wrap : vs->sequence) < 1) {
859 filename, 'd', vs->sequence) < 1) {
861 av_log(c, AV_LOG_ERROR, "Invalid second level segment filename template '%s', "
862 "you can try to remove second_level_segment_index flag\n",
865 return AVERROR(EINVAL);
869 if (c->flags & (HLS_SECOND_LEVEL_SEGMENT_SIZE | HLS_SECOND_LEVEL_SEGMENT_DURATION)) {
870 av_strlcpy(vs->current_segment_final_filename_fmt, oc->filename,
871 sizeof(vs->current_segment_final_filename_fmt));
872 if (c->flags & HLS_SECOND_LEVEL_SEGMENT_SIZE) {
873 char * filename = av_strdup(oc->filename); // %%s will be %s after strftime
875 return AVERROR(ENOMEM);
876 if (replace_int_data_in_filename(oc->filename, sizeof(oc->filename), filename, 's', 0) < 1) {
877 av_log(c, AV_LOG_ERROR, "Invalid second level segment filename template '%s', "
878 "you can try to remove second_level_segment_size flag\n",
881 return AVERROR(EINVAL);
885 if (c->flags & HLS_SECOND_LEVEL_SEGMENT_DURATION) {
886 char * filename = av_strdup(oc->filename); // %%t will be %t after strftime
888 return AVERROR(ENOMEM);
889 if (replace_int_data_in_filename(oc->filename, sizeof(oc->filename), filename, 't', 0) < 1) {
890 av_log(c, AV_LOG_ERROR, "Invalid second level segment filename template '%s', "
891 "you can try to remove second_level_segment_time flag\n",
894 return AVERROR(EINVAL);
902 /* Create a new segment and append it to the segment list */
903 static int hls_append_segment(struct AVFormatContext *s, HLSContext *hls,
904 VariantStream *vs, double duration, int64_t pos,
907 HLSSegment *en = av_malloc(sizeof(*en));
908 const char *filename;
909 int byterange_mode = (hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size > 0);
913 return AVERROR(ENOMEM);
915 ret = sls_flags_filename_process(s, hls, vs, en, duration, pos, size);
920 filename = av_basename(vs->avf->filename);
922 if (hls->use_localtime_mkdir) {
923 filename = vs->avf->filename;
925 if ((find_segment_by_filename(vs->segments, filename) || find_segment_by_filename(vs->old_segments, filename))
926 && !byterange_mode) {
927 av_log(hls, AV_LOG_WARNING, "Duplicated segment filename detected: %s\n", filename);
929 av_strlcpy(en->filename, filename, sizeof(en->filename));
932 av_strlcpy(en->sub_filename, av_basename(vs->vtt_avf->filename), sizeof(en->sub_filename));
934 en->sub_filename[0] = '\0';
936 en->duration = duration;
942 if (vs->discontinuity) {
944 vs->discontinuity = 0;
947 if (hls->key_info_file || hls->encrypt) {
948 av_strlcpy(en->key_uri, hls->key_uri, sizeof(en->key_uri));
949 av_strlcpy(en->iv_string, hls->iv_string, sizeof(en->iv_string));
955 vs->last_segment->next = en;
957 vs->last_segment = en;
959 // EVENT or VOD playlists imply sliding window cannot be used
960 if (hls->pl_type != PLAYLIST_TYPE_NONE)
961 hls->max_nb_segments = 0;
963 if (hls->max_nb_segments && vs->nb_entries >= hls->max_nb_segments) {
965 vs->initial_prog_date_time += en->duration;
966 vs->segments = en->next;
967 if (en && hls->flags & HLS_DELETE_SEGMENTS &&
969 !(hls->flags & HLS_SINGLE_FILE || hls->wrap)) {
971 !(hls->flags & HLS_SINGLE_FILE)) {
973 en->next = vs->old_segments;
974 vs->old_segments = en;
975 if ((ret = hls_delete_old_segments(s, hls, vs)) < 0)
982 if (hls->max_seg_size > 0) {
990 static int parse_playlist(AVFormatContext *s, const char *url, VariantStream *vs)
992 HLSContext *hls = s->priv_data;
994 int ret = 0, is_segment = 0;
995 int64_t new_start_pos;
1000 if ((ret = ffio_open_whitelist(&in, url, AVIO_FLAG_READ,
1001 &s->interrupt_callback, NULL,
1002 s->protocol_whitelist, s->protocol_blacklist)) < 0)
1005 read_chomp_line(in, line, sizeof(line));
1006 if (strcmp(line, "#EXTM3U")) {
1007 ret = AVERROR_INVALIDDATA;
1011 vs->discontinuity = 0;
1012 while (!avio_feof(in)) {
1013 read_chomp_line(in, line, sizeof(line));
1014 if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
1015 int64_t tmp_sequence = strtoll(ptr, NULL, 10);
1016 if (tmp_sequence < vs->sequence)
1017 av_log(hls, AV_LOG_VERBOSE,
1018 "Found playlist sequence number was smaller """
1019 "than specified start sequence number: %"PRId64" < %"PRId64", "
1020 "omitting\n", tmp_sequence, hls->start_sequence);
1022 av_log(hls, AV_LOG_DEBUG, "Found playlist sequence number: %"PRId64"\n", tmp_sequence);
1023 vs->sequence = tmp_sequence;
1025 } else if (av_strstart(line, "#EXT-X-DISCONTINUITY", &ptr)) {
1027 vs->discontinuity = 1;
1028 } else if (av_strstart(line, "#EXTINF:", &ptr)) {
1030 vs->duration = atof(ptr);
1031 } else if (av_stristart(line, "#EXT-X-KEY:", &ptr)) {
1032 ptr = av_stristr(line, "URI=\"");
1034 ptr += strlen("URI=\"");
1035 end = av_stristr(ptr, ",");
1037 av_strlcpy(hls->key_uri, ptr, end - ptr);
1039 av_strlcpy(hls->key_uri, ptr, sizeof(hls->key_uri));
1043 ptr = av_stristr(line, "IV=0x");
1045 ptr += strlen("IV=0x");
1046 end = av_stristr(ptr, ",");
1048 av_strlcpy(hls->iv_string, ptr, end - ptr);
1050 av_strlcpy(hls->iv_string, ptr, sizeof(hls->iv_string));
1054 } else if (av_strstart(line, "#", NULL)) {
1056 } else if (line[0]) {
1059 new_start_pos = avio_tell(vs->avf->pb);
1060 vs->size = new_start_pos - vs->start_pos;
1061 av_strlcpy(vs->avf->filename, line, sizeof(line));
1062 ret = hls_append_segment(s, hls, vs, vs->duration, vs->start_pos, vs->size);
1065 vs->start_pos = new_start_pos;
1075 static void hls_free_segments(HLSSegment *p)
1086 static void hls_rename_temp_file(AVFormatContext *s, AVFormatContext *oc)
1088 size_t len = strlen(oc->filename);
1089 char final_filename[sizeof(oc->filename)];
1091 av_strlcpy(final_filename, oc->filename, len);
1092 final_filename[len-4] = '\0';
1093 ff_rename(oc->filename, final_filename, s);
1094 oc->filename[len-4] = '\0';
1097 static int get_relative_url(const char *master_url, const char *media_url,
1098 char *rel_url, int rel_url_buf_size)
1102 p = strrchr(master_url, '/') ? strrchr(master_url, '/') :\
1103 strrchr(master_url, '\\');
1105 base_len = FFABS(p - master_url);
1106 if (av_strncasecmp(master_url, media_url, base_len)) {
1107 av_log(NULL, AV_LOG_WARNING, "Unable to find relative url\n");
1108 return AVERROR(EINVAL);
1111 av_strlcpy(rel_url, &(media_url[base_len + 1]), rel_url_buf_size);
1115 static int create_master_playlist(AVFormatContext *s,
1116 VariantStream * const input_vs)
1118 HLSContext *hls = s->priv_data;
1119 VariantStream *vs, *temp_vs;
1120 AVStream *vid_st, *aud_st;
1121 AVDictionary *options = NULL;
1123 int m3u8_name_size, ret, bandwidth;
1124 char *m3u8_rel_name;
1126 input_vs->m3u8_created = 1;
1127 if (!hls->master_m3u8_created) {
1128 /* For the first time, wait until all the media playlists are created */
1129 for (i = 0; i < hls->nb_varstreams; i++)
1130 if (!hls->var_streams[i].m3u8_created)
1133 /* Keep publishing the master playlist at the configured rate */
1134 if (&hls->var_streams[0] != input_vs || !hls->master_publish_rate ||
1135 input_vs->number % hls->master_publish_rate)
1139 set_http_options(s, &options, hls);
1141 ret = hlsenc_io_open(s, &hls->m3u8_out, hls->master_m3u8_url, &options);
1142 av_dict_free(&options);
1144 av_log(NULL, AV_LOG_ERROR, "Failed to open master play list file '%s'\n",
1145 hls->master_m3u8_url);
1149 ff_hls_write_playlist_version(hls->m3u8_out, hls->version);
1151 /* For audio only variant streams add #EXT-X-MEDIA tag with attributes*/
1152 for (i = 0; i < hls->nb_varstreams; i++) {
1153 vs = &(hls->var_streams[i]);
1155 if (vs->has_video || vs->has_subtitle || !vs->agroup)
1158 m3u8_name_size = strlen(vs->m3u8_name) + 1;
1159 m3u8_rel_name = av_malloc(m3u8_name_size);
1160 if (!m3u8_rel_name) {
1161 ret = AVERROR(ENOMEM);
1164 av_strlcpy(m3u8_rel_name, vs->m3u8_name, m3u8_name_size);
1165 ret = get_relative_url(hls->master_m3u8_url, vs->m3u8_name,
1166 m3u8_rel_name, m3u8_name_size);
1168 av_log(s, AV_LOG_ERROR, "Unable to find relative URL\n");
1172 avio_printf(hls->m3u8_out, "#EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID=\"group_%s\"",
1174 avio_printf(hls->m3u8_out, ",NAME=\"audio_0\",DEFAULT=YES,URI=\"%s\"\n",
1176 av_freep(&m3u8_rel_name);
1179 /* For variant streams with video add #EXT-X-STREAM-INF tag with attributes*/
1180 for (i = 0; i < hls->nb_varstreams; i++) {
1181 vs = &(hls->var_streams[i]);
1183 m3u8_name_size = strlen(vs->m3u8_name) + 1;
1184 m3u8_rel_name = av_malloc(m3u8_name_size);
1185 if (!m3u8_rel_name) {
1186 ret = AVERROR(ENOMEM);
1189 av_strlcpy(m3u8_rel_name, vs->m3u8_name, m3u8_name_size);
1190 ret = get_relative_url(hls->master_m3u8_url, vs->m3u8_name,
1191 m3u8_rel_name, m3u8_name_size);
1193 av_log(NULL, AV_LOG_ERROR, "Unable to find relative URL\n");
1199 for (j = 0; j < vs->nb_streams; j++) {
1200 if (vs->streams[j]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO)
1201 vid_st = vs->streams[j];
1202 else if (vs->streams[j]->codecpar->codec_type == AVMEDIA_TYPE_AUDIO)
1203 aud_st = vs->streams[j];
1206 if (!vid_st && !aud_st) {
1207 av_log(NULL, AV_LOG_WARNING, "Media stream not found\n");
1212 * Traverse through the list of audio only rendition streams and find
1213 * the rendition which has highest bitrate in the same audio group
1216 for (j = 0; j < hls->nb_varstreams; j++) {
1217 temp_vs = &(hls->var_streams[j]);
1218 if (!temp_vs->has_video && !temp_vs->has_subtitle &&
1220 !av_strcasecmp(temp_vs->agroup, vs->agroup)) {
1222 aud_st = temp_vs->streams[0];
1223 if (temp_vs->streams[0]->codecpar->bit_rate >
1224 aud_st->codecpar->bit_rate)
1225 aud_st = temp_vs->streams[0];
1232 bandwidth += vid_st->codecpar->bit_rate;
1234 bandwidth += aud_st->codecpar->bit_rate;
1235 bandwidth += bandwidth / 10;
1237 ff_hls_write_stream_info(vid_st, hls->m3u8_out, bandwidth, m3u8_rel_name,
1238 aud_st ? vs->agroup : NULL);
1240 av_freep(&m3u8_rel_name);
1244 hls->master_m3u8_created = 1;
1245 av_freep(&m3u8_rel_name);
1246 hlsenc_io_close(s, &hls->m3u8_out, hls->master_m3u8_url);
1250 static int hls_window(AVFormatContext *s, int last, VariantStream *vs)
1252 HLSContext *hls = s->priv_data;
1254 int target_duration = 0;
1256 char temp_filename[1024];
1257 int64_t sequence = FFMAX(hls->start_sequence, vs->sequence - vs->nb_entries);
1258 const char *proto = avio_find_protocol_name(s->filename);
1259 int use_rename = proto && !strcmp(proto, "file");
1260 static unsigned warned_non_file;
1261 char *key_uri = NULL;
1262 char *iv_string = NULL;
1263 AVDictionary *options = NULL;
1264 double prog_date_time = vs->initial_prog_date_time;
1265 double *prog_date_time_p = (hls->flags & HLS_PROGRAM_DATE_TIME) ? &prog_date_time : NULL;
1266 int byterange_mode = (hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size > 0);
1269 if (byterange_mode) {
1274 if (hls->flags & HLS_INDEPENDENT_SEGMENTS) {
1278 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
1282 if (!use_rename && !warned_non_file++)
1283 av_log(s, AV_LOG_ERROR, "Cannot use rename on non file protocol, this may lead to races and temporary partial files\n");
1285 set_http_options(s, &options, hls);
1286 snprintf(temp_filename, sizeof(temp_filename), use_rename ? "%s.tmp" : "%s", vs->m3u8_name);
1287 if ((ret = hlsenc_io_open(s, &hls->m3u8_out, temp_filename, &options)) < 0)
1290 for (en = vs->segments; en; en = en->next) {
1291 if (target_duration <= en->duration)
1292 target_duration = lrint(en->duration);
1295 vs->discontinuity_set = 0;
1296 ff_hls_write_playlist_header(hls->m3u8_out, hls->version, hls->allowcache,
1297 target_duration, sequence, hls->pl_type);
1299 if((hls->flags & HLS_DISCONT_START) && sequence==hls->start_sequence && vs->discontinuity_set==0 ){
1300 avio_printf(hls->m3u8_out, "#EXT-X-DISCONTINUITY\n");
1301 vs->discontinuity_set = 1;
1303 if (vs->has_video && (hls->flags & HLS_INDEPENDENT_SEGMENTS)) {
1304 avio_printf(hls->m3u8_out, "#EXT-X-INDEPENDENT-SEGMENTS\n");
1306 for (en = vs->segments; en; en = en->next) {
1307 if ((hls->encrypt || hls->key_info_file) && (!key_uri || strcmp(en->key_uri, key_uri) ||
1308 av_strcasecmp(en->iv_string, iv_string))) {
1309 avio_printf(hls->m3u8_out, "#EXT-X-KEY:METHOD=AES-128,URI=\"%s\"", en->key_uri);
1311 avio_printf(hls->m3u8_out, ",IV=0x%s", en->iv_string);
1312 avio_printf(hls->m3u8_out, "\n");
1313 key_uri = en->key_uri;
1314 iv_string = en->iv_string;
1317 if ((hls->segment_type == SEGMENT_TYPE_FMP4) && (en == vs->segments)) {
1318 ff_hls_write_init_file(hls->m3u8_out, vs->fmp4_init_filename,
1319 hls->flags & HLS_SINGLE_FILE, en->size, en->pos);
1322 ret = ff_hls_write_file_entry(hls->m3u8_out, en->discont, byterange_mode,
1323 en->duration, hls->flags & HLS_ROUND_DURATIONS,
1324 en->size, en->pos, vs->baseurl,
1325 en->filename, prog_date_time_p);
1327 av_log(s, AV_LOG_WARNING, "ff_hls_write_file_entry get error\n");
1331 if (last && (hls->flags & HLS_OMIT_ENDLIST)==0)
1332 ff_hls_write_end_list(hls->m3u8_out);
1334 if( vs->vtt_m3u8_name ) {
1335 if ((ret = hlsenc_io_open(s, &hls->sub_m3u8_out, vs->vtt_m3u8_name, &options)) < 0)
1337 ff_hls_write_playlist_header(hls->sub_m3u8_out, hls->version, hls->allowcache,
1338 target_duration, sequence, PLAYLIST_TYPE_NONE);
1339 for (en = vs->segments; en; en = en->next) {
1340 ret = ff_hls_write_file_entry(hls->sub_m3u8_out, 0, byterange_mode,
1341 en->duration, 0, en->size, en->pos,
1342 vs->baseurl, en->sub_filename, NULL);
1344 av_log(s, AV_LOG_WARNING, "ff_hls_write_file_entry get error\n");
1349 ff_hls_write_end_list(hls->sub_m3u8_out);
1354 av_dict_free(&options);
1355 hlsenc_io_close(s, &hls->m3u8_out, temp_filename);
1356 hlsenc_io_close(s, &hls->sub_m3u8_out, vs->vtt_m3u8_name);
1357 if (ret >= 0 && use_rename)
1358 ff_rename(temp_filename, vs->m3u8_name, s);
1360 if (ret >= 0 && hls->master_pl_name)
1361 if (create_master_playlist(s, vs) < 0)
1362 av_log(s, AV_LOG_WARNING, "Master playlist creation failed\n");
1367 static int hls_start(AVFormatContext *s, VariantStream *vs)
1369 HLSContext *c = s->priv_data;
1370 AVFormatContext *oc = vs->avf;
1371 AVFormatContext *vtt_oc = vs->vtt_avf;
1372 AVDictionary *options = NULL;
1373 char *filename, iv_string[KEYSIZE*2 + 1];
1376 if (c->flags & HLS_SINGLE_FILE) {
1377 av_strlcpy(oc->filename, vs->basename,
1378 sizeof(oc->filename));
1379 if (vs->vtt_basename)
1380 av_strlcpy(vtt_oc->filename, vs->vtt_basename,
1381 sizeof(vtt_oc->filename));
1382 } else if (c->max_seg_size > 0) {
1383 if (replace_int_data_in_filename(oc->filename, sizeof(oc->filename),
1385 vs->basename, 'd', c->wrap ? vs->sequence % c->wrap : vs->sequence) < 1) {
1387 vs->basename, 'd', vs->sequence) < 1) {
1389 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s', you can try to use -use_localtime 1 with it\n", vs->basename);
1390 return AVERROR(EINVAL);
1393 if (c->use_localtime) {
1395 struct tm *tm, tmpbuf;
1397 tm = localtime_r(&now0, &tmpbuf);
1398 if (!strftime(oc->filename, sizeof(oc->filename), vs->basename, tm)) {
1399 av_log(oc, AV_LOG_ERROR, "Could not get segment filename with use_localtime\n");
1400 return AVERROR(EINVAL);
1403 err = sls_flag_use_localtime_filename(oc, c, vs);
1405 return AVERROR(ENOMEM);
1408 if (c->use_localtime_mkdir) {
1410 char *fn_copy = av_strdup(oc->filename);
1412 return AVERROR(ENOMEM);
1414 dir = av_dirname(fn_copy);
1415 if (mkdir_p(dir) == -1 && errno != EEXIST) {
1416 av_log(oc, AV_LOG_ERROR, "Could not create directory %s with use_localtime_mkdir\n", dir);
1418 return AVERROR(errno);
1422 } else if (replace_int_data_in_filename(oc->filename, sizeof(oc->filename),
1424 vs->basename, 'd', c->wrap ? vs->sequence % c->wrap : vs->sequence) < 1) {
1426 vs->basename, 'd', vs->sequence) < 1) {
1428 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s' you can try to use -use_localtime 1 with it\n", vs->basename);
1429 return AVERROR(EINVAL);
1431 if( vs->vtt_basename) {
1432 if (replace_int_data_in_filename(vtt_oc->filename, sizeof(vtt_oc->filename),
1434 vs->vtt_basename, 'd', c->wrap ? vs->sequence % c->wrap : vs->sequence) < 1) {
1436 vs->vtt_basename, 'd', vs->sequence) < 1) {
1438 av_log(vtt_oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", vs->vtt_basename);
1439 return AVERROR(EINVAL);
1445 set_http_options(s, &options, c);
1447 if (c->flags & HLS_TEMP_FILE) {
1448 av_strlcat(oc->filename, ".tmp", sizeof(oc->filename));
1451 if (c->key_info_file || c->encrypt) {
1452 if (c->key_info_file && c->encrypt) {
1453 av_log(s, AV_LOG_WARNING, "Cannot use both -hls_key_info_file and -hls_enc,"
1454 " will use -hls_key_info_file priority\n");
1457 if (!c->encrypt_started || (c->flags & HLS_PERIODIC_REKEY)) {
1458 if (c->key_info_file) {
1459 if ((err = hls_encryption_start(s)) < 0)
1462 if ((err = do_encrypt(s, vs)) < 0)
1465 c->encrypt_started = 1;
1467 if ((err = av_dict_set(&options, "encryption_key", c->key_string, 0))
1470 err = av_strlcpy(iv_string, c->iv_string, sizeof(iv_string));
1472 snprintf(iv_string, sizeof(iv_string), "%032"PRIx64, vs->sequence);
1473 if ((err = av_dict_set(&options, "encryption_iv", iv_string, 0)) < 0)
1476 filename = av_asprintf("crypto:%s", oc->filename);
1478 err = AVERROR(ENOMEM);
1481 err = hlsenc_io_open(s, &oc->pb, filename, &options);
1483 av_dict_free(&options);
1486 } else if (c->segment_type != SEGMENT_TYPE_FMP4) {
1487 if ((err = hlsenc_io_open(s, &oc->pb, oc->filename, &options)) < 0)
1490 if (vs->vtt_basename) {
1491 set_http_options(s, &options, c);
1492 if ((err = hlsenc_io_open(s, &vtt_oc->pb, vtt_oc->filename, &options)) < 0)
1495 av_dict_free(&options);
1497 if (c->segment_type != SEGMENT_TYPE_FMP4) {
1498 /* We only require one PAT/PMT per segment. */
1499 if (oc->oformat->priv_class && oc->priv_data) {
1502 snprintf(period, sizeof(period), "%d", (INT_MAX / 2) - 1);
1504 av_opt_set(oc->priv_data, "mpegts_flags", "resend_headers", 0);
1505 av_opt_set(oc->priv_data, "sdt_period", period, 0);
1506 av_opt_set(oc->priv_data, "pat_period", period, 0);
1510 if (vs->vtt_basename) {
1511 err = avformat_write_header(vtt_oc,NULL);
1518 av_dict_free(&options);
1523 static const char * get_default_pattern_localtime_fmt(AVFormatContext *s)
1526 time_t t = time(NULL);
1527 struct tm *p, tmbuf;
1528 HLSContext *hls = s->priv_data;
1530 p = localtime_r(&t, &tmbuf);
1531 // no %s support when strftime returned error or left format string unchanged
1532 // also no %s support on MSVC, which invokes the invalid parameter handler on unsupported format strings, instead of returning an error
1533 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
1534 return (HAVE_LIBC_MSVCRT || !strftime(b, sizeof(b), "%s", p) || !strcmp(b, "%s")) ? "-%Y%m%d%H%M%S.m4s" : "-%s.m4s";
1536 return (HAVE_LIBC_MSVCRT || !strftime(b, sizeof(b), "%s", p) || !strcmp(b, "%s")) ? "-%Y%m%d%H%M%S.ts" : "-%s.ts";
1539 static int format_name(char *name, int name_buf_len, int i)
1542 char extension[10] = {'\0'};
1544 p = strrchr(name, '.');
1546 av_strlcpy(extension, p, sizeof(extension));
1550 snprintf(name + strlen(name), name_buf_len - strlen(name), POSTFIX_PATTERN, i);
1552 if (strlen(extension))
1553 av_strlcat(name, extension, name_buf_len);
1558 static int get_nth_codec_stream_index(AVFormatContext *s,
1559 enum AVMediaType codec_type,
1562 unsigned int stream_index, cnt;
1563 if (stream_id < 0 || stream_id > s->nb_streams - 1)
1566 for (stream_index = 0; stream_index < s->nb_streams; stream_index++) {
1567 if (s->streams[stream_index]->codecpar->codec_type != codec_type)
1569 if (cnt == stream_id)
1570 return stream_index;
1576 static int parse_variant_stream_mapstring(AVFormatContext *s)
1578 HLSContext *hls = s->priv_data;
1581 enum AVMediaType codec_type;
1582 int nb_varstreams, nb_streams;
1583 char *p, *q, *saveptr1, *saveptr2, *varstr, *keyval;
1587 * Expected format for var_stream_map string is as below:
1589 * "a:0,agroup:a0 a:1,agroup:a1 v:0,agroup:a0 v:1,agroup:a1"
1590 * This string specifies how to group the audio, video and subtitle streams
1591 * into different variant streams. The variant stream groups are separated
1594 * a:, v:, s: are keys to specify audio, video and subtitle streams
1595 * respectively. Allowed values are 0 to 9 digits (limited just based on
1598 * agroup: is key to specify audio group. A string can be given as value.
1600 p = av_strdup(hls->var_stream_map);
1602 while(av_strtok(q, " \t", &saveptr1)) {
1604 hls->nb_varstreams++;
1608 hls->var_streams = av_mallocz(sizeof(*hls->var_streams) * hls->nb_varstreams);
1609 if (!hls->var_streams)
1610 return AVERROR(ENOMEM);
1612 p = hls->var_stream_map;
1614 while (varstr = av_strtok(p, " \t", &saveptr1)) {
1617 if (nb_varstreams < hls->nb_varstreams)
1618 vs = &(hls->var_streams[nb_varstreams++]);
1620 return AVERROR(EINVAL);
1623 while (q < varstr + strlen(varstr)) {
1624 if (!av_strncasecmp(q, "a:", 2) || !av_strncasecmp(q, "v:", 2) ||
1625 !av_strncasecmp(q, "s:", 2))
1629 vs->streams = av_mallocz(sizeof(AVStream *) * vs->nb_streams);
1631 return AVERROR(ENOMEM);
1634 while (keyval = av_strtok(varstr, ",", &saveptr2)) {
1637 if (av_strstart(keyval, "agroup:", &val)) {
1638 vs->agroup = av_strdup(val);
1640 return AVERROR(ENOMEM);
1642 } else if (av_strstart(keyval, "v:", &val)) {
1643 codec_type = AVMEDIA_TYPE_VIDEO;
1644 } else if (av_strstart(keyval, "a:", &val)) {
1645 codec_type = AVMEDIA_TYPE_AUDIO;
1646 } else if (av_strstart(keyval, "s:", &val)) {
1647 codec_type = AVMEDIA_TYPE_SUBTITLE;
1649 av_log(s, AV_LOG_ERROR, "Invalid keyval %s\n", keyval);
1650 return AVERROR(EINVAL);
1654 if (av_isdigit(*val))
1655 stream_index = get_nth_codec_stream_index (s, codec_type,
1658 if (stream_index >= 0 && nb_streams < vs->nb_streams) {
1659 vs->streams[nb_streams++] = s->streams[stream_index];
1661 av_log(s, AV_LOG_ERROR, "Unable to map stream at %s\n", keyval);
1662 return AVERROR(EINVAL);
1666 av_log(s, AV_LOG_DEBUG, "Number of variant streams %d\n",
1667 hls->nb_varstreams);
1672 static int update_variant_stream_info(AVFormatContext *s) {
1673 HLSContext *hls = s->priv_data;
1676 if (hls->var_stream_map) {
1677 return parse_variant_stream_mapstring(s);
1679 //By default, a single variant stream with all the codec streams is created
1680 hls->nb_varstreams = 1;
1681 hls->var_streams = av_mallocz(sizeof(*hls->var_streams) *
1682 hls->nb_varstreams);
1683 if (!hls->var_streams)
1684 return AVERROR(ENOMEM);
1686 hls->var_streams[0].nb_streams = s->nb_streams;
1687 hls->var_streams[0].streams = av_mallocz(sizeof(AVStream *) *
1688 hls->var_streams[0].nb_streams);
1689 if (!hls->var_streams[0].streams)
1690 return AVERROR(ENOMEM);
1692 for (i = 0; i < s->nb_streams; i++)
1693 hls->var_streams[0].streams[i] = s->streams[i];
1698 static int update_master_pl_info(AVFormatContext *s) {
1699 HLSContext *hls = s->priv_data;
1700 int m3u8_name_size, ret;
1703 m3u8_name_size = strlen(s->filename) + strlen(hls->master_pl_name) + 1;
1704 hls->master_m3u8_url = av_malloc(m3u8_name_size);
1705 if (!hls->master_m3u8_url) {
1706 ret = AVERROR(ENOMEM);
1710 av_strlcpy(hls->master_m3u8_url, s->filename, m3u8_name_size);
1711 p = strrchr(hls->master_m3u8_url, '/') ?
1712 strrchr(hls->master_m3u8_url, '/') :
1713 strrchr(hls->master_m3u8_url, '\\');
1716 av_strlcat(hls->master_m3u8_url, hls->master_pl_name, m3u8_name_size);
1718 av_strlcpy(hls->master_m3u8_url, hls->master_pl_name, m3u8_name_size);
1724 static int hls_write_header(AVFormatContext *s)
1726 HLSContext *hls = s->priv_data;
1728 AVDictionary *options = NULL;
1729 VariantStream *vs = NULL;
1731 for (i = 0; i < hls->nb_varstreams; i++) {
1732 vs = &hls->var_streams[i];
1734 av_dict_copy(&options, hls->format_options, 0);
1735 ret = avformat_write_header(vs->avf, &options);
1736 if (av_dict_count(options)) {
1737 av_log(s, AV_LOG_ERROR, "Some of provided format options in '%s' are not recognized\n", hls->format_options_str);
1738 ret = AVERROR(EINVAL);
1739 av_dict_free(&options);
1742 av_dict_free(&options);
1743 //av_assert0(s->nb_streams == hls->avf->nb_streams);
1744 for (j = 0; j < vs->nb_streams; j++) {
1746 AVStream *outer_st = vs->streams[j];
1748 if (hls->max_seg_size > 0) {
1749 if ((outer_st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) &&
1750 (outer_st->codecpar->bit_rate > hls->max_seg_size)) {
1751 av_log(s, AV_LOG_WARNING, "Your video bitrate is bigger than hls_segment_size, "
1752 "(%"PRId64 " > %"PRId64 "), the result maybe not be what you want.",
1753 outer_st->codecpar->bit_rate, hls->max_seg_size);
1757 if (outer_st->codecpar->codec_type != AVMEDIA_TYPE_SUBTITLE)
1758 inner_st = vs->avf->streams[j];
1759 else if (vs->vtt_avf)
1760 inner_st = vs->vtt_avf->streams[0];
1762 /* We have a subtitle stream, when the user does not want one */
1766 avpriv_set_pts_info(outer_st, inner_st->pts_wrap_bits, inner_st->time_base.num, inner_st->time_base.den);
1774 static int hls_write_packet(AVFormatContext *s, AVPacket *pkt)
1776 HLSContext *hls = s->priv_data;
1777 AVFormatContext *oc = NULL;
1778 AVStream *st = s->streams[pkt->stream_index];
1779 int64_t end_pts = 0;
1781 int ret = 0, can_split = 1, i, j;
1782 int stream_index = 0;
1783 int range_length = 0;
1784 uint8_t *buffer = NULL;
1785 VariantStream *vs = NULL;
1787 for (i = 0; i < hls->nb_varstreams; i++) {
1788 vs = &hls->var_streams[i];
1789 for (j = 0; j < vs->nb_streams; j++) {
1790 if (vs->streams[j] == st) {
1791 if( st->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE ) {
1807 av_log(s, AV_LOG_ERROR, "Unable to find mapping variant stream\n");
1808 return AVERROR(ENOMEM);
1811 end_pts = hls->recording_time * vs->number;
1813 if (vs->sequence - vs->nb_entries > hls->start_sequence && hls->init_time > 0) {
1814 /* reset end_pts, hls->recording_time at end of the init hls list */
1815 int init_list_dur = hls->init_time * vs->nb_entries * AV_TIME_BASE;
1816 int after_init_list_dur = (vs->sequence - vs->nb_entries ) * hls->time * AV_TIME_BASE;
1817 hls->recording_time = hls->time * AV_TIME_BASE;
1818 end_pts = init_list_dur + after_init_list_dur ;
1821 if (vs->start_pts == AV_NOPTS_VALUE) {
1822 vs->start_pts = pkt->pts;
1825 if (vs->has_video) {
1826 can_split = st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO &&
1827 ((pkt->flags & AV_PKT_FLAG_KEY) || (hls->flags & HLS_SPLIT_BY_TIME));
1828 is_ref_pkt = st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO;
1830 if (pkt->pts == AV_NOPTS_VALUE)
1831 is_ref_pkt = can_split = 0;
1834 if (vs->end_pts == AV_NOPTS_VALUE)
1835 vs->end_pts = pkt->pts;
1836 if (vs->new_start) {
1838 vs->duration = (double)(pkt->pts - vs->end_pts)
1839 * st->time_base.num / st->time_base.den;
1840 vs->dpp = (double)(pkt->duration) * st->time_base.num / st->time_base.den;
1842 if (pkt->duration) {
1843 vs->duration += (double)(pkt->duration) * st->time_base.num / st->time_base.den;
1845 av_log(s, AV_LOG_WARNING, "pkt->duration = 0, maybe the hls segment duration will not precise\n");
1846 vs->duration = (double)(pkt->pts - vs->end_pts) * st->time_base.num / st->time_base.den;
1852 if (vs->packets_written && can_split && av_compare_ts(pkt->pts - vs->start_pts, st->time_base,
1853 end_pts, AV_TIME_BASE_Q) >= 0) {
1854 int64_t new_start_pos;
1855 char *old_filename = av_strdup(vs->avf->filename);
1856 int byterange_mode = (hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size > 0);
1858 if (!old_filename) {
1859 return AVERROR(ENOMEM);
1862 av_write_frame(vs->avf, NULL); /* Flush any buffered data */
1864 new_start_pos = avio_tell(vs->avf->pb);
1865 vs->size = new_start_pos - vs->start_pos;
1867 if (!byterange_mode) {
1868 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
1869 if (!vs->init_range_length) {
1871 range_length = avio_close_dyn_buf(oc->pb, &buffer);
1872 avio_write(vs->out, buffer, range_length);
1873 vs->init_range_length = range_length;
1874 avio_open_dyn_buf(&oc->pb);
1875 vs->packets_written = 0;
1876 ff_format_io_close(s, &vs->out);
1877 hlsenc_io_close(s, &vs->out, vs->base_output_dirname);
1880 hlsenc_io_close(s, &oc->pb, oc->filename);
1883 hlsenc_io_close(s, &vs->vtt_avf->pb, vs->vtt_avf->filename);
1886 if ((hls->flags & HLS_TEMP_FILE) && oc->filename[0]) {
1887 if (!(hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size <= 0))
1888 if ((vs->avf->oformat->priv_class && vs->avf->priv_data) && hls->segment_type != SEGMENT_TYPE_FMP4)
1889 av_opt_set(vs->avf->priv_data, "mpegts_flags", "resend_headers", 0);
1890 hls_rename_temp_file(s, oc);
1893 if (vs->fmp4_init_mode) {
1897 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
1898 ret = hlsenc_io_open(s, &vs->out, vs->avf->filename, NULL);
1900 av_log(NULL, AV_LOG_ERROR, "Failed to open file '%s'\n",
1904 write_styp(vs->out);
1905 ret = flush_dynbuf(vs, &range_length);
1909 ff_format_io_close(s, &vs->out);
1911 ret = hls_append_segment(s, hls, vs, vs->duration, vs->start_pos, vs->size);
1912 vs->start_pos = new_start_pos;
1914 av_free(old_filename);
1918 vs->end_pts = pkt->pts;
1921 vs->fmp4_init_mode = 0;
1922 if (hls->flags & HLS_SINGLE_FILE) {
1924 } else if (hls->max_seg_size > 0) {
1925 if (vs->start_pos >= hls->max_seg_size) {
1927 sls_flag_file_rename(hls, vs, old_filename);
1928 ret = hls_start(s, vs);
1930 /* When split segment by byte, the duration is short than hls_time,
1931 * so it is not enough one segment duration as hls_time, */
1936 sls_flag_file_rename(hls, vs, old_filename);
1937 ret = hls_start(s, vs);
1939 av_free(old_filename);
1945 if (!vs->fmp4_init_mode || byterange_mode)
1946 if ((ret = hls_window(s, 0, vs)) < 0) {
1951 vs->packets_written++;
1952 ret = ff_write_chained(oc, stream_index, pkt, s, 0);
1957 static int hls_write_trailer(struct AVFormatContext *s)
1959 HLSContext *hls = s->priv_data;
1960 AVFormatContext *oc = NULL;
1961 AVFormatContext *vtt_oc = NULL;
1962 char *old_filename = NULL;
1965 VariantStream *vs = NULL;
1967 for (i = 0; i < hls->nb_varstreams; i++) {
1968 vs = &hls->var_streams[i];
1971 vtt_oc = vs->vtt_avf;
1972 old_filename = av_strdup(vs->avf->filename);
1974 if (!old_filename) {
1975 return AVERROR(ENOMEM);
1977 if ( hls->segment_type == SEGMENT_TYPE_FMP4) {
1978 int range_length = 0;
1979 ret = hlsenc_io_open(s, &vs->out, vs->avf->filename, NULL);
1981 av_log(NULL, AV_LOG_ERROR, "Failed to open file '%s'\n", vs->avf->filename);
1982 return AVERROR(ENOENT);
1984 write_styp(vs->out);
1985 ret = flush_dynbuf(vs, &range_length);
1989 ff_format_io_close(s, &vs->out);
1992 av_write_trailer(oc);
1994 vs->size = avio_tell(vs->avf->pb) - vs->start_pos;
1995 if (hls->segment_type != SEGMENT_TYPE_FMP4)
1996 ff_format_io_close(s, &oc->pb);
1998 if ((hls->flags & HLS_TEMP_FILE) && oc->filename[0]) {
1999 hls_rename_temp_file(s, oc);
2002 /* after av_write_trailer, then duration + 1 duration per packet */
2003 hls_append_segment(s, hls, vs, vs->duration + vs->dpp, vs->start_pos, vs->size);
2006 sls_flag_file_rename(hls, vs, old_filename);
2010 av_write_trailer(vtt_oc);
2011 vs->size = avio_tell(vs->vtt_avf->pb) - vs->start_pos;
2012 ff_format_io_close(s, &vtt_oc->pb);
2014 av_freep(&vs->basename);
2015 av_freep(&vs->base_output_dirname);
2016 avformat_free_context(oc);
2019 hls_window(s, 1, vs);
2021 av_freep(&vs->fmp4_init_filename);
2023 av_freep(&vs->vtt_basename);
2024 av_freep(&vs->vtt_m3u8_name);
2025 avformat_free_context(vtt_oc);
2028 hls_free_segments(vs->segments);
2029 hls_free_segments(vs->old_segments);
2030 av_free(old_filename);
2031 av_freep(&vs->m3u8_name);
2032 av_freep(&vs->streams);
2033 av_freep(&vs->agroup);
2034 av_freep(&vs->baseurl);
2037 ff_format_io_close(s, &hls->m3u8_out);
2038 ff_format_io_close(s, &hls->sub_m3u8_out);
2039 av_freep(&hls->key_basename);
2040 av_freep(&hls->var_streams);
2041 av_freep(&hls->master_m3u8_url);
2046 static int hls_init(AVFormatContext *s)
2051 HLSContext *hls = s->priv_data;
2052 const char *pattern = "%d.ts";
2053 VariantStream *vs = NULL;
2054 int basename_size = 0;
2055 const char *pattern_localtime_fmt = get_default_pattern_localtime_fmt(s);
2056 const char *vtt_pattern = "%d.vtt";
2058 int vtt_basename_size = 0, m3u8_name_size = 0;
2059 int fmp4_init_filename_len = strlen(hls->fmp4_init_filename) + 1;
2061 ret = update_variant_stream_info(s);
2063 av_log(s, AV_LOG_ERROR, "Variant stream info update failed with status %x\n",
2067 //TODO: Updates needed to encryption functionality with periodic re-key when more than one variant streams are present
2068 if (hls->nb_varstreams > 1 && hls->flags & HLS_PERIODIC_REKEY) {
2069 ret = AVERROR(EINVAL);
2070 av_log(s, AV_LOG_ERROR, "Periodic re-key not supported when more than one variant streams are present\n");
2074 if (hls->master_pl_name) {
2075 ret = update_master_pl_info(s);
2077 av_log(s, AV_LOG_ERROR, "Master stream info update failed with status %x\n",
2083 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
2086 if ((hls->start_sequence_source_type == HLS_START_SEQUENCE_AS_SECONDS_SINCE_EPOCH) ||
2087 (hls->start_sequence_source_type == HLS_START_SEQUENCE_AS_FORMATTED_DATETIME)) {
2088 time_t t = time(NULL); // we will need it in either case
2089 if (hls->start_sequence_source_type == HLS_START_SEQUENCE_AS_SECONDS_SINCE_EPOCH) {
2090 hls->start_sequence = (int64_t)t;
2091 } else if (hls->start_sequence_source_type == HLS_START_SEQUENCE_AS_FORMATTED_DATETIME) {
2093 struct tm *p, tmbuf;
2094 if (!(p = localtime_r(&t, &tmbuf)))
2095 return AVERROR(ENOMEM);
2096 if (!strftime(b, sizeof(b), "%Y%m%d%H%M%S", p))
2097 return AVERROR(ENOMEM);
2098 hls->start_sequence = strtoll(b, NULL, 10);
2100 av_log(hls, AV_LOG_DEBUG, "start_number evaluated to %"PRId64"\n", hls->start_sequence);
2103 hls->recording_time = (hls->init_time ? hls->init_time : hls->time) * AV_TIME_BASE;
2104 for (i = 0; i < hls->nb_varstreams; i++) {
2105 vs = &hls->var_streams[i];
2106 vs->sequence = hls->start_sequence;
2107 vs->start_pts = AV_NOPTS_VALUE;
2108 vs->end_pts = AV_NOPTS_VALUE;
2109 vs->current_segment_final_filename_fmt[0] = '\0';
2111 if (hls->flags & HLS_SPLIT_BY_TIME && hls->flags & HLS_INDEPENDENT_SEGMENTS) {
2112 // Independent segments cannot be guaranteed when splitting by time
2113 hls->flags &= ~HLS_INDEPENDENT_SEGMENTS;
2114 av_log(s, AV_LOG_WARNING,
2115 "'split_by_time' and 'independent_segments' cannot be enabled together. "
2116 "Disabling 'independent_segments' flag\n");
2119 if (hls->flags & HLS_PROGRAM_DATE_TIME) {
2122 vs->initial_prog_date_time = now0;
2124 if (hls->format_options_str) {
2125 ret = av_dict_parse_string(&hls->format_options, hls->format_options_str, "=", ":", 0);
2127 av_log(s, AV_LOG_ERROR, "Could not parse format options list '%s'\n", hls->format_options_str);
2132 for (j = 0; j < vs->nb_streams; j++) {
2133 vs->has_video += vs->streams[j]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO;
2134 vs->has_subtitle += vs->streams[j]->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE;
2137 if (vs->has_video > 1)
2138 av_log(s, AV_LOG_WARNING, "More than a single video stream present, expect issues decoding it.\n");
2139 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
2140 vs->oformat = av_guess_format("mp4", NULL, NULL);
2142 vs->oformat = av_guess_format("mpegts", NULL, NULL);
2146 ret = AVERROR_MUXER_NOT_FOUND;
2150 if (vs->has_subtitle) {
2151 vs->vtt_oformat = av_guess_format("webvtt", NULL, NULL);
2153 ret = AVERROR_MUXER_NOT_FOUND;
2157 if (hls->segment_filename) {
2158 basename_size = strlen(hls->segment_filename) + 1;
2159 if (hls->nb_varstreams > 1) {
2160 basename_size += strlen(POSTFIX_PATTERN);
2162 vs->basename = av_malloc(basename_size);
2163 if (!vs->basename) {
2164 ret = AVERROR(ENOMEM);
2168 av_strlcpy(vs->basename, hls->segment_filename, basename_size);
2170 if (hls->flags & HLS_SINGLE_FILE) {
2171 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
2178 if (hls->use_localtime) {
2179 basename_size = strlen(s->filename) + strlen(pattern_localtime_fmt) + 1;
2181 basename_size = strlen(s->filename) + strlen(pattern) + 1;
2184 if (hls->nb_varstreams > 1) {
2185 basename_size += strlen(POSTFIX_PATTERN);
2188 vs->basename = av_malloc(basename_size);
2189 if (!vs->basename) {
2190 ret = AVERROR(ENOMEM);
2194 av_strlcpy(vs->basename, s->filename, basename_size);
2196 p = strrchr(vs->basename, '.');
2199 if (hls->use_localtime) {
2200 av_strlcat(vs->basename, pattern_localtime_fmt, basename_size);
2202 av_strlcat(vs->basename, pattern, basename_size);
2206 m3u8_name_size = strlen(s->filename) + 1;
2207 if (hls->nb_varstreams > 1) {
2208 m3u8_name_size += strlen(POSTFIX_PATTERN);
2211 vs->m3u8_name = av_malloc(m3u8_name_size);
2212 if (!vs->m3u8_name ) {
2213 ret = AVERROR(ENOMEM);
2217 av_strlcpy(vs->m3u8_name, s->filename, m3u8_name_size);
2219 if (hls->nb_varstreams > 1) {
2220 ret = format_name(vs->basename, basename_size, i);
2223 ret = format_name(vs->m3u8_name, m3u8_name_size, i);
2228 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
2229 if (hls->nb_varstreams > 1)
2230 fmp4_init_filename_len += strlen(POSTFIX_PATTERN);
2231 vs->fmp4_init_filename = av_malloc(fmp4_init_filename_len);
2232 if (!vs->fmp4_init_filename ) {
2233 ret = AVERROR(ENOMEM);
2236 av_strlcpy(vs->fmp4_init_filename, hls->fmp4_init_filename,
2237 fmp4_init_filename_len);
2238 if (hls->nb_varstreams > 1) {
2239 ret = format_name(vs->fmp4_init_filename, fmp4_init_filename_len, i);
2244 if (av_strcasecmp(hls->fmp4_init_filename, "init.mp4")) {
2245 fmp4_init_filename_len = strlen(vs->fmp4_init_filename) + 1;
2246 vs->base_output_dirname = av_malloc(fmp4_init_filename_len);
2247 if (!vs->base_output_dirname) {
2248 ret = AVERROR(ENOMEM);
2251 av_strlcpy(vs->base_output_dirname, vs->fmp4_init_filename,
2252 fmp4_init_filename_len);
2254 fmp4_init_filename_len = strlen(vs->m3u8_name) +
2255 strlen(vs->fmp4_init_filename) + 1;
2257 vs->base_output_dirname = av_malloc(fmp4_init_filename_len);
2258 if (!vs->base_output_dirname) {
2259 ret = AVERROR(ENOMEM);
2263 av_strlcpy(vs->base_output_dirname, vs->m3u8_name,
2264 fmp4_init_filename_len);
2265 p = strrchr(vs->base_output_dirname, '/');
2268 av_strlcat(vs->base_output_dirname, vs->fmp4_init_filename,
2269 fmp4_init_filename_len);
2271 av_strlcpy(vs->base_output_dirname, vs->fmp4_init_filename,
2272 fmp4_init_filename_len);
2277 if (!hls->use_localtime) {
2278 ret = sls_flag_check_duration_size_index(hls);
2283 ret = sls_flag_check_duration_size(hls, vs);
2288 if (vs->has_subtitle) {
2290 if (hls->flags & HLS_SINGLE_FILE)
2291 vtt_pattern = ".vtt";
2292 vtt_basename_size = strlen(s->filename) + strlen(vtt_pattern) + 1;
2293 if (hls->nb_varstreams > 1) {
2294 vtt_basename_size += strlen(POSTFIX_PATTERN);
2297 vs->vtt_basename = av_malloc(vtt_basename_size);
2298 if (!vs->vtt_basename) {
2299 ret = AVERROR(ENOMEM);
2302 vs->vtt_m3u8_name = av_malloc(vtt_basename_size);
2303 if (!vs->vtt_m3u8_name ) {
2304 ret = AVERROR(ENOMEM);
2307 av_strlcpy(vs->vtt_basename, s->filename, vtt_basename_size);
2308 p = strrchr(vs->vtt_basename, '.');
2312 if ( hls->subtitle_filename ) {
2313 strcpy(vs->vtt_m3u8_name, hls->subtitle_filename);
2315 strcpy(vs->vtt_m3u8_name, vs->vtt_basename);
2316 av_strlcat(vs->vtt_m3u8_name, "_vtt.m3u8", vtt_basename_size);
2318 av_strlcat(vs->vtt_basename, vtt_pattern, vtt_basename_size);
2320 if (hls->nb_varstreams > 1) {
2321 ret= format_name(vs->vtt_basename, vtt_basename_size, i);
2324 ret = format_name(vs->vtt_m3u8_name, vtt_basename_size, i);
2331 vs->baseurl = av_strdup(hls->baseurl);
2333 ret = AVERROR(ENOMEM);
2338 if ((hls->flags & HLS_SINGLE_FILE) && (hls->segment_type == SEGMENT_TYPE_FMP4)) {
2339 vs->fmp4_init_filename = av_strdup(vs->basename);
2340 if (!vs->fmp4_init_filename) {
2341 ret = AVERROR(ENOMEM);
2345 if ((ret = hls_mux_init(s, vs)) < 0)
2348 if (hls->flags & HLS_APPEND_LIST) {
2349 parse_playlist(s, vs->m3u8_name, vs);
2350 vs->discontinuity = 1;
2351 if (hls->init_time > 0) {
2352 av_log(s, AV_LOG_WARNING, "append_list mode does not support hls_init_time,"
2353 " hls_init_time value will have no effect\n");
2355 hls->recording_time = hls->time * AV_TIME_BASE;
2359 if ((ret = hls_start(s, vs)) < 0)
2365 av_freep(&hls->key_basename);
2366 for (i = 0; i < hls->nb_varstreams && hls->var_streams; i++) {
2367 vs = &hls->var_streams[i];
2368 av_freep(&vs->basename);
2369 av_freep(&vs->vtt_basename);
2370 av_freep(&vs->fmp4_init_filename);
2371 av_freep(&vs->m3u8_name);
2372 av_freep(&vs->vtt_m3u8_name);
2373 av_freep(&vs->streams);
2374 av_freep(&vs->agroup);
2375 av_freep(&vs->baseurl);
2377 avformat_free_context(vs->avf);
2379 avformat_free_context(vs->vtt_avf);
2381 av_freep(&hls->var_streams);
2382 av_freep(&hls->master_m3u8_url);
2388 #define OFFSET(x) offsetof(HLSContext, x)
2389 #define E AV_OPT_FLAG_ENCODING_PARAM
2390 static const AVOption options[] = {
2391 {"start_number", "set first number in the sequence", OFFSET(start_sequence),AV_OPT_TYPE_INT64, {.i64 = 0}, 0, INT64_MAX, E},
2392 {"hls_time", "set segment length in seconds", OFFSET(time), AV_OPT_TYPE_FLOAT, {.dbl = 2}, 0, FLT_MAX, E},
2393 {"hls_init_time", "set segment length in seconds at init list", OFFSET(init_time), AV_OPT_TYPE_FLOAT, {.dbl = 0}, 0, FLT_MAX, E},
2394 {"hls_list_size", "set maximum number of playlist entries", OFFSET(max_nb_segments), AV_OPT_TYPE_INT, {.i64 = 5}, 0, INT_MAX, E},
2395 {"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},
2396 {"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},
2398 {"hls_wrap", "set number after which the index wraps (will be deprecated)", OFFSET(wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E},
2400 {"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},
2401 {"hls_base_url", "url to prepend to each playlist entry", OFFSET(baseurl), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
2402 {"hls_segment_filename", "filename template for segment files", OFFSET(segment_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
2403 {"hls_segment_size", "maximum size per segment file, (in bytes)", OFFSET(max_seg_size), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E},
2404 {"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},
2405 {"hls_enc", "enable AES128 encryption support", OFFSET(encrypt), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E},
2406 {"hls_enc_key", "hex-coded 16 byte key to encrypt the segments", OFFSET(key), AV_OPT_TYPE_STRING, .flags = E},
2407 {"hls_enc_key_url", "url to access the key to decrypt the segments", OFFSET(key_url), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
2408 {"hls_enc_iv", "hex-coded 16 byte initialization vector", OFFSET(iv), AV_OPT_TYPE_STRING, .flags = E},
2409 {"hls_subtitle_path", "set path of hls subtitles", OFFSET(subtitle_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
2410 {"hls_segment_type", "set hls segment files type", OFFSET(segment_type), AV_OPT_TYPE_INT, {.i64 = SEGMENT_TYPE_MPEGTS }, 0, SEGMENT_TYPE_FMP4, E, "segment_type"},
2411 {"mpegts", "make segment file to mpegts files in m3u8", 0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_TYPE_MPEGTS }, 0, UINT_MAX, E, "segment_type"},
2412 {"fmp4", "make segment file to fragment mp4 files in m3u8", 0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_TYPE_FMP4 }, 0, UINT_MAX, E, "segment_type"},
2413 {"hls_fmp4_init_filename", "set fragment mp4 file init filename", OFFSET(fmp4_init_filename), AV_OPT_TYPE_STRING, {.str = "init.mp4"}, 0, 0, E},
2414 {"hls_flags", "set flags affecting HLS playlist and media file generation", OFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0 }, 0, UINT_MAX, E, "flags"},
2415 {"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"},
2416 {"temp_file", "write segment to temporary file and rename when complete", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_TEMP_FILE }, 0, UINT_MAX, E, "flags"},
2417 {"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"},
2418 {"round_durations", "round durations in m3u8 to whole numbers", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_ROUND_DURATIONS }, 0, UINT_MAX, E, "flags"},
2419 {"discont_start", "start the playlist with a discontinuity tag", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_DISCONT_START }, 0, UINT_MAX, E, "flags"},
2420 {"omit_endlist", "Do not append an endlist when ending stream", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_OMIT_ENDLIST }, 0, UINT_MAX, E, "flags"},
2421 {"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"},
2422 {"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"},
2423 {"program_date_time", "add EXT-X-PROGRAM-DATE-TIME", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_PROGRAM_DATE_TIME }, 0, UINT_MAX, E, "flags"},
2424 {"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"},
2425 {"second_level_segment_duration", "include segment duration in segment filenames when use_localtime", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_SECOND_LEVEL_SEGMENT_DURATION }, 0, UINT_MAX, E, "flags"},
2426 {"second_level_segment_size", "include segment size in segment filenames when use_localtime", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_SECOND_LEVEL_SEGMENT_SIZE }, 0, UINT_MAX, E, "flags"},
2427 {"periodic_rekey", "reload keyinfo file periodically for re-keying", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_PERIODIC_REKEY }, 0, UINT_MAX, E, "flags"},
2428 {"independent_segments", "add EXT-X-INDEPENDENT-SEGMENTS, whenever applicable", 0, AV_OPT_TYPE_CONST, { .i64 = HLS_INDEPENDENT_SEGMENTS }, 0, UINT_MAX, E, "flags"},
2429 {"use_localtime", "set filename expansion with strftime at segment creation", OFFSET(use_localtime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
2430 {"use_localtime_mkdir", "create last directory component in strftime-generated filename", OFFSET(use_localtime_mkdir), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
2431 {"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" },
2432 {"event", "EVENT playlist", 0, AV_OPT_TYPE_CONST, {.i64 = PLAYLIST_TYPE_EVENT }, INT_MIN, INT_MAX, E, "pl_type" },
2433 {"vod", "VOD playlist", 0, AV_OPT_TYPE_CONST, {.i64 = PLAYLIST_TYPE_VOD }, INT_MIN, INT_MAX, E, "pl_type" },
2434 {"method", "set the HTTP method(default: PUT)", OFFSET(method), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
2435 {"hls_start_number_source", "set source of first number in sequence", OFFSET(start_sequence_source_type), AV_OPT_TYPE_INT, {.i64 = HLS_START_SEQUENCE_AS_START_NUMBER }, 0, HLS_START_SEQUENCE_AS_FORMATTED_DATETIME, E, "start_sequence_source_type" },
2436 {"generic", "start_number value (default)", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_START_SEQUENCE_AS_START_NUMBER }, INT_MIN, INT_MAX, E, "start_sequence_source_type" },
2437 {"epoch", "seconds since epoch", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_START_SEQUENCE_AS_SECONDS_SINCE_EPOCH }, INT_MIN, INT_MAX, E, "start_sequence_source_type" },
2438 {"datetime", "current datetime as YYYYMMDDhhmmss", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_START_SEQUENCE_AS_FORMATTED_DATETIME }, INT_MIN, INT_MAX, E, "start_sequence_source_type" },
2439 {"http_user_agent", "override User-Agent field in HTTP header", OFFSET(user_agent), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
2440 {"var_stream_map", "Variant stream map string", OFFSET(var_stream_map), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
2441 {"master_pl_name", "Create HLS master playlist with this name", OFFSET(master_pl_name), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
2442 {"master_pl_publish_rate", "Publish master play list every after this many segment intervals", OFFSET(master_publish_rate), AV_OPT_TYPE_INT, {.i64 = 0}, 0, UINT_MAX, E},
2443 {"http_persistent", "Use persistent HTTP connections", OFFSET(http_persistent), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
2447 static const AVClass hls_class = {
2448 .class_name = "hls muxer",
2449 .item_name = av_default_item_name,
2451 .version = LIBAVUTIL_VERSION_INT,
2455 AVOutputFormat ff_hls_muxer = {
2457 .long_name = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
2458 .extensions = "m3u8",
2459 .priv_data_size = sizeof(HLSContext),
2460 .audio_codec = AV_CODEC_ID_AAC,
2461 .video_codec = AV_CODEC_ID_H264,
2462 .subtitle_codec = AV_CODEC_ID_WEBVTT,
2463 .flags = AVFMT_NOFILE | AVFMT_GLOBALHEADER | AVFMT_ALLOW_FLUSH,
2465 .write_header = hls_write_header,
2466 .write_packet = hls_write_packet,
2467 .write_trailer = hls_write_trailer,
2468 .priv_class = &hls_class,