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 CODEC_ATTRIBUTE_WRITTEN = 0,
63 CODEC_ATTRIBUTE_WILL_NOT_BE_WRITTEN,
64 } CodecAttributeStatus;
67 #define LINE_BUFFER_SIZE 1024
68 #define HLS_MICROSECOND_UNIT 1000000
69 #define POSTFIX_PATTERN "_%d"
71 typedef struct HLSSegment {
73 char sub_filename[1024];
74 double duration; /* in seconds */
79 char key_uri[LINE_BUFFER_SIZE + 1];
80 char iv_string[KEYSIZE*2 + 1];
82 struct HLSSegment *next;
85 typedef enum HLSFlags {
86 // Generate a single media file and use byte ranges in the playlist.
87 HLS_SINGLE_FILE = (1 << 0),
88 HLS_DELETE_SEGMENTS = (1 << 1),
89 HLS_ROUND_DURATIONS = (1 << 2),
90 HLS_DISCONT_START = (1 << 3),
91 HLS_OMIT_ENDLIST = (1 << 4),
92 HLS_SPLIT_BY_TIME = (1 << 5),
93 HLS_APPEND_LIST = (1 << 6),
94 HLS_PROGRAM_DATE_TIME = (1 << 7),
95 HLS_SECOND_LEVEL_SEGMENT_INDEX = (1 << 8), // include segment index in segment filenames when use_localtime e.g.: %%03d
96 HLS_SECOND_LEVEL_SEGMENT_DURATION = (1 << 9), // include segment duration (microsec) in segment filenames when use_localtime e.g.: %%09t
97 HLS_SECOND_LEVEL_SEGMENT_SIZE = (1 << 10), // include segment size (bytes) in segment filenames when use_localtime e.g.: %%014s
98 HLS_TEMP_FILE = (1 << 11),
99 HLS_PERIODIC_REKEY = (1 << 12),
100 HLS_INDEPENDENT_SEGMENTS = (1 << 13),
108 typedef struct VariantStream {
111 AVOutputFormat *oformat;
112 AVOutputFormat *vtt_oformat;
115 int init_range_length;
117 AVFormatContext *avf;
118 AVFormatContext *vtt_avf;
123 double dpp; // duration per packet
126 double duration; // last segment duration computed so far, in seconds
127 int64_t start_pos; // last segment starting position
128 int64_t size; // last segment size
130 int discontinuity_set;
133 HLSSegment *segments;
134 HLSSegment *last_segment;
135 HLSSegment *old_segments;
142 double initial_prog_date_time;
143 char current_segment_final_filename_fmt[1024]; // when renaming segments
145 char *fmp4_init_filename;
146 char *base_output_dirname;
150 char codec_attr[128];
151 CodecAttributeStatus attr_status;
152 unsigned int nb_streams;
153 int m3u8_created; /* status of media play-list creation */
154 char *agroup; /* audio group name */
158 typedef struct HLSContext {
159 const AVClass *class; // Class for private options.
160 int64_t start_sequence;
161 uint32_t start_sequence_source_type; // enum StartSequenceSourceType
163 float time; // Set by a private option.
164 float init_time; // Set by a private option.
165 int max_nb_segments; // Set by a private option.
167 int wrap; // Set by a private option.
169 uint32_t flags; // enum HLSFlags
170 uint32_t pl_type; // enum PlaylistType
171 char *segment_filename;
172 char *fmp4_init_filename;
175 int use_localtime; ///< flag to expand filename with localtime
176 int use_localtime_mkdir;///< flag to mkdir dirname in timebased filename
178 int64_t recording_time;
179 int64_t max_seg_size; // every segment file max size
182 char *format_options_str;
183 char *vtt_format_options_str;
184 char *subtitle_filename;
185 AVDictionary *format_options;
195 char key_file[LINE_BUFFER_SIZE + 1];
196 char key_uri[LINE_BUFFER_SIZE + 1];
197 char key_string[KEYSIZE*2 + 1];
198 char iv_string[KEYSIZE*2 + 1];
199 AVDictionary *vtt_format_options;
204 VariantStream *var_streams;
205 unsigned int nb_varstreams;
207 int master_m3u8_created; /* status of master play-list creation */
208 char *master_m3u8_url; /* URL of the master m3u8 file */
209 int version; /* HLS version */
210 char *var_stream_map; /* user specified variant stream map string */
211 char *master_pl_name;
212 unsigned int master_publish_rate;
214 AVIOContext *m3u8_out;
215 AVIOContext *sub_m3u8_out;
218 static int mkdir_p(const char *path) {
220 char *temp = av_strdup(path);
224 if (!path || !temp) {
228 if (!strncmp(temp, "/", 1) || !strncmp(temp, "\\", 1)) {
230 } else if (!strncmp(temp, "./", 2) || !strncmp(temp, ".\\", 2)) {
234 for ( ; *pos != '\0'; ++pos) {
235 if (*pos == '/' || *pos == '\\') {
238 ret = mkdir(temp, 0755);
243 if ((*(pos - 1) != '/') || (*(pos - 1) != '\\')) {
244 ret = mkdir(temp, 0755);
251 static int hlsenc_io_open(AVFormatContext *s, AVIOContext **pb, char *filename,
252 AVDictionary **options) {
253 HLSContext *hls = s->priv_data;
254 int http_base_proto = filename ? ff_is_http_proto(filename) : 0;
255 int err = AVERROR_MUXER_NOT_FOUND;
256 if (!*pb || !http_base_proto || !hls->http_persistent) {
257 err = s->io_open(s, pb, filename, AVIO_FLAG_WRITE, options);
258 #if CONFIG_HTTP_PROTOCOL
260 URLContext *http_url_context = ffio_geturlcontext(*pb);
261 av_assert0(http_url_context);
262 err = ff_http_do_new_request(http_url_context, filename);
268 static void hlsenc_io_close(AVFormatContext *s, AVIOContext **pb, char *filename) {
269 HLSContext *hls = s->priv_data;
270 int http_base_proto = filename ? ff_is_http_proto(filename) : 0;
271 if (!http_base_proto || !hls->http_persistent || hls->key_info_file || hls->encrypt) {
272 ff_format_io_close(s, pb);
273 #if CONFIG_HTTP_PROTOCOL
275 URLContext *http_url_context = ffio_geturlcontext(*pb);
276 av_assert0(http_url_context);
278 ffurl_shutdown(http_url_context, AVIO_FLAG_WRITE);
283 static void set_http_options(AVFormatContext *s, AVDictionary **options, HLSContext *c)
285 int http_base_proto = ff_is_http_proto(s->filename);
288 av_dict_set(options, "method", c->method, 0);
289 } else if (http_base_proto) {
290 av_log(c, AV_LOG_WARNING, "No HTTP method set, hls muxer defaulting to method PUT.\n");
291 av_dict_set(options, "method", "PUT", 0);
294 av_dict_set(options, "user_agent", c->user_agent, 0);
295 if (c->http_persistent)
296 av_dict_set_int(options, "multiple_requests", 1, 0);
300 static void write_codec_attr(AVStream *st, VariantStream *vs) {
301 int codec_strlen = strlen(vs->codec_attr);
304 if (st->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE)
306 if (vs->attr_status == CODEC_ATTRIBUTE_WILL_NOT_BE_WRITTEN)
309 if (st->codecpar->codec_id == AV_CODEC_ID_H264) {
310 uint8_t *data = st->codecpar->extradata;
311 if (data && (data[0] | data[1] | data[2]) == 0 && data[3] == 1 && (data[4] & 0x1F) == 7) {
312 snprintf(attr, sizeof(attr),
313 "avc1.%02x%02x%02x", data[5], data[6], data[7]);
317 } else if (st->codecpar->codec_id == AV_CODEC_ID_MP2) {
318 snprintf(attr, sizeof(attr), "mp4a.40.33");
319 } else if (st->codecpar->codec_id == AV_CODEC_ID_MP3) {
320 snprintf(attr, sizeof(attr), "mp4a.40.34");
321 } else if (st->codecpar->codec_id == AV_CODEC_ID_AAC) {
322 /* TODO : For HE-AAC, HE-AACv2, the last digit needs to be set to 5 and 29 respectively */
323 snprintf(attr, sizeof(attr), "mp4a.40.2");
324 } else if (st->codecpar->codec_id == AV_CODEC_ID_AC3) {
325 snprintf(attr, sizeof(attr), "ac-3");
326 } else if (st->codecpar->codec_id == AV_CODEC_ID_EAC3) {
327 snprintf(attr, sizeof(attr), "ec-3");
331 // Don't write the same attribute multiple times
332 if (!av_stristr(vs->codec_attr, attr)) {
333 snprintf(vs->codec_attr + codec_strlen,
334 sizeof(vs->codec_attr) - codec_strlen,
335 "%s%s", codec_strlen ? "," : "", attr);
340 vs->codec_attr[0] = '\0';
341 vs->attr_status = CODEC_ATTRIBUTE_WILL_NOT_BE_WRITTEN;
345 static int replace_int_data_in_filename(char *buf, int buf_size, const char *filename, char placeholder, int64_t number)
348 char *q, buf1[20], c;
349 int nd, len, addchar_count;
358 if (c == '%' && *(p+1) == '%') // %%
360 else if (c == '%' && (av_isdigit(*(p+1)) || *(p+1) == placeholder)) {
363 while (av_isdigit(*(p + addchar_count))) {
364 nd = nd * 10 + *(p + addchar_count) - '0';
368 if (*(p + addchar_count) == placeholder) {
369 len = snprintf(buf1, sizeof(buf1), "%0*"PRId64, (number < 0) ? nd : nd++, number);
370 if (len < 1) // returned error or empty buf1
372 if ((q - buf + len) > buf_size - 1)
374 memcpy(q, buf1, len);
376 p += (addchar_count + 1);
384 while (addchar_count--)
385 if ((q - buf) < buf_size - 1)
397 static void write_styp(AVIOContext *pb)
400 ffio_wfourcc(pb, "styp");
401 ffio_wfourcc(pb, "msdh");
402 avio_wb32(pb, 0); /* minor */
403 ffio_wfourcc(pb, "msdh");
404 ffio_wfourcc(pb, "msix");
407 static int flush_dynbuf(VariantStream *vs, int *range_length)
409 AVFormatContext *ctx = vs->avf;
413 return AVERROR(EINVAL);
417 av_write_frame(ctx, NULL);
421 *range_length = avio_close_dyn_buf(ctx->pb, &buffer);
423 avio_write(vs->out, buffer, *range_length);
427 return avio_open_dyn_buf(&ctx->pb);
430 static int hls_delete_old_segments(AVFormatContext *s, HLSContext *hls,
433 HLSSegment *segment, *previous_segment = NULL;
434 float playlist_duration = 0.0f;
435 int ret = 0, path_size, sub_path_size;
436 char *dirname = NULL, *p, *sub_path;
438 AVDictionary *options = NULL;
439 AVIOContext *out = NULL;
440 const char *proto = NULL;
442 segment = vs->segments;
444 playlist_duration += segment->duration;
445 segment = segment->next;
448 segment = vs->old_segments;
450 playlist_duration -= segment->duration;
451 previous_segment = segment;
452 segment = previous_segment->next;
453 if (playlist_duration <= -previous_segment->duration) {
454 previous_segment->next = NULL;
459 if (segment && !hls->use_localtime_mkdir) {
460 if (hls->segment_filename) {
461 dirname = av_strdup(hls->segment_filename);
463 dirname = av_strdup(vs->avf->filename);
466 ret = AVERROR(ENOMEM);
469 p = (char *)av_basename(dirname);
474 av_log(hls, AV_LOG_DEBUG, "deleting old segment %s\n",
476 path_size = (hls->use_localtime_mkdir ? 0 : strlen(dirname)) + strlen(segment->filename) + 1;
477 path = av_malloc(path_size);
479 ret = AVERROR(ENOMEM);
483 if (hls->use_localtime_mkdir)
484 av_strlcpy(path, segment->filename, path_size);
485 else { // segment->filename contains basename only
486 av_strlcpy(path, dirname, path_size);
487 av_strlcat(path, segment->filename, path_size);
490 proto = avio_find_protocol_name(s->filename);
491 if (hls->method || (proto && !av_strcasecmp(proto, "http"))) {
492 av_dict_set(&options, "method", "DELETE", 0);
493 if ((ret = vs->avf->io_open(vs->avf, &out, path, AVIO_FLAG_WRITE, &options)) < 0)
495 ff_format_io_close(vs->avf, &out);
496 } else if (unlink(path) < 0) {
497 av_log(hls, AV_LOG_ERROR, "failed to delete old segment %s: %s\n",
498 path, strerror(errno));
501 if ((segment->sub_filename[0] != '\0')) {
502 sub_path_size = strlen(segment->sub_filename) + 1 + (dirname ? strlen(dirname) : 0);
503 sub_path = av_malloc(sub_path_size);
505 ret = AVERROR(ENOMEM);
509 av_strlcpy(sub_path, dirname, sub_path_size);
510 av_strlcat(sub_path, segment->sub_filename, sub_path_size);
512 if (hls->method || (proto && !av_strcasecmp(proto, "http"))) {
513 av_dict_set(&options, "method", "DELETE", 0);
514 if ((ret = vs->avf->io_open(vs->avf, &out, sub_path, AVIO_FLAG_WRITE, &options)) < 0) {
518 ff_format_io_close(vs->avf, &out);
519 } else if (unlink(sub_path) < 0) {
520 av_log(hls, AV_LOG_ERROR, "failed to delete old segment %s: %s\n",
521 sub_path, strerror(errno));
526 previous_segment = segment;
527 segment = previous_segment->next;
528 av_free(previous_segment);
538 static int randomize(uint8_t *buf, int len)
541 gcry_randomize(buf, len, GCRY_VERY_STRONG_RANDOM);
544 if (RAND_bytes(buf, len))
547 return AVERROR(ENOSYS);
549 return AVERROR(EINVAL);
552 static int do_encrypt(AVFormatContext *s, VariantStream *vs)
554 HLSContext *hls = s->priv_data;
558 uint8_t key[KEYSIZE];
560 len = strlen(s->filename) + 4 + 1;
561 hls->key_basename = av_mallocz(len);
562 if (!hls->key_basename)
563 return AVERROR(ENOMEM);
565 av_strlcpy(hls->key_basename, s->filename, len);
566 av_strlcat(hls->key_basename, ".key", len);
569 av_strlcpy(hls->key_file, hls->key_url, sizeof(hls->key_file));
570 av_strlcpy(hls->key_uri, hls->key_url, sizeof(hls->key_uri));
572 av_strlcpy(hls->key_file, hls->key_basename, sizeof(hls->key_file));
573 av_strlcpy(hls->key_uri, hls->key_basename, sizeof(hls->key_uri));
576 if (!*hls->iv_string) {
577 uint8_t iv[16] = { 0 };
581 AV_WB64(iv + 8, vs->sequence);
583 memcpy(iv, hls->iv, sizeof(iv));
585 ff_data_to_hex(buf, iv, sizeof(iv), 0);
587 memcpy(hls->iv_string, buf, sizeof(hls->iv_string));
590 if (!*hls->key_uri) {
591 av_log(hls, AV_LOG_ERROR, "no key URI specified in key info file\n");
592 return AVERROR(EINVAL);
595 if (!*hls->key_file) {
596 av_log(hls, AV_LOG_ERROR, "no key file specified in key info file\n");
597 return AVERROR(EINVAL);
600 if (!*hls->key_string) {
602 if ((ret = randomize(key, sizeof(key))) < 0) {
603 av_log(s, AV_LOG_ERROR, "Cannot generate a strong random key\n");
607 memcpy(key, hls->key, sizeof(key));
610 ff_data_to_hex(hls->key_string, key, sizeof(key), 0);
611 if ((ret = s->io_open(s, &pb, hls->key_file, AVIO_FLAG_WRITE, NULL)) < 0)
613 avio_seek(pb, 0, SEEK_CUR);
614 avio_write(pb, key, KEYSIZE);
621 static int hls_encryption_start(AVFormatContext *s)
623 HLSContext *hls = s->priv_data;
626 uint8_t key[KEYSIZE];
628 if ((ret = s->io_open(s, &pb, hls->key_info_file, AVIO_FLAG_READ, NULL)) < 0) {
629 av_log(hls, AV_LOG_ERROR,
630 "error opening key info file %s\n", hls->key_info_file);
634 ff_get_line(pb, hls->key_uri, sizeof(hls->key_uri));
635 hls->key_uri[strcspn(hls->key_uri, "\r\n")] = '\0';
637 ff_get_line(pb, hls->key_file, sizeof(hls->key_file));
638 hls->key_file[strcspn(hls->key_file, "\r\n")] = '\0';
640 ff_get_line(pb, hls->iv_string, sizeof(hls->iv_string));
641 hls->iv_string[strcspn(hls->iv_string, "\r\n")] = '\0';
643 ff_format_io_close(s, &pb);
645 if (!*hls->key_uri) {
646 av_log(hls, AV_LOG_ERROR, "no key URI specified in key info file\n");
647 return AVERROR(EINVAL);
650 if (!*hls->key_file) {
651 av_log(hls, AV_LOG_ERROR, "no key file specified in key info file\n");
652 return AVERROR(EINVAL);
655 if ((ret = s->io_open(s, &pb, hls->key_file, AVIO_FLAG_READ, NULL)) < 0) {
656 av_log(hls, AV_LOG_ERROR, "error opening key file %s\n", hls->key_file);
660 ret = avio_read(pb, key, sizeof(key));
661 ff_format_io_close(s, &pb);
662 if (ret != sizeof(key)) {
663 av_log(hls, AV_LOG_ERROR, "error reading key file %s\n", hls->key_file);
664 if (ret >= 0 || ret == AVERROR_EOF)
665 ret = AVERROR(EINVAL);
668 ff_data_to_hex(hls->key_string, key, sizeof(key), 0);
673 static int read_chomp_line(AVIOContext *s, char *buf, int maxlen)
675 int len = ff_get_line(s, buf, maxlen);
676 while (len > 0 && av_isspace(buf[len - 1]))
681 static int hls_mux_init(AVFormatContext *s, VariantStream *vs)
683 AVDictionary *options = NULL;
684 HLSContext *hls = s->priv_data;
686 AVFormatContext *vtt_oc = NULL;
687 int byterange_mode = (hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size > 0);
690 ret = avformat_alloc_output_context2(&vs->avf, vs->oformat, NULL, NULL);
695 oc->filename[0] = '\0';
696 oc->oformat = vs->oformat;
697 oc->interrupt_callback = s->interrupt_callback;
698 oc->max_delay = s->max_delay;
699 oc->opaque = s->opaque;
700 oc->io_open = s->io_open;
701 oc->io_close = s->io_close;
702 av_dict_copy(&oc->metadata, s->metadata, 0);
704 if(vs->vtt_oformat) {
705 ret = avformat_alloc_output_context2(&vs->vtt_avf, vs->vtt_oformat, NULL, NULL);
708 vtt_oc = vs->vtt_avf;
709 vtt_oc->oformat = vs->vtt_oformat;
710 av_dict_copy(&vtt_oc->metadata, s->metadata, 0);
713 for (i = 0; i < vs->nb_streams; i++) {
715 AVFormatContext *loc;
716 if (vs->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE)
721 if (!(st = avformat_new_stream(loc, NULL)))
722 return AVERROR(ENOMEM);
723 avcodec_parameters_copy(st->codecpar, vs->streams[i]->codecpar);
724 if (!oc->oformat->codec_tag ||
725 av_codec_get_id (oc->oformat->codec_tag, vs->streams[i]->codecpar->codec_tag) == st->codecpar->codec_id ||
726 av_codec_get_tag(oc->oformat->codec_tag, vs->streams[i]->codecpar->codec_id) <= 0) {
727 st->codecpar->codec_tag = vs->streams[i]->codecpar->codec_tag;
729 st->codecpar->codec_tag = 0;
732 st->sample_aspect_ratio = vs->streams[i]->sample_aspect_ratio;
733 st->time_base = vs->streams[i]->time_base;
734 av_dict_copy(&st->metadata, vs->streams[i]->metadata, 0);
737 vs->packets_written = 1;
740 vs->fmp4_init_mode = 0;
742 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
743 if (hls->max_seg_size > 0) {
744 av_log(s, AV_LOG_WARNING, "Multi-file byterange mode is currently unsupported in the HLS muxer.\n");
745 return AVERROR_PATCHWELCOME;
748 vs->packets_written = 0;
749 vs->init_range_length = 0;
750 vs->fmp4_init_mode = !byterange_mode;
751 set_http_options(s, &options, hls);
752 if ((ret = avio_open_dyn_buf(&oc->pb)) < 0)
755 ret = hlsenc_io_open(s, &vs->out, vs->base_output_dirname, &options);
756 av_dict_free(&options);
758 av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", vs->fmp4_init_filename);
762 if (hls->format_options_str) {
763 ret = av_dict_parse_string(&hls->format_options, hls->format_options_str, "=", ":", 0);
765 av_log(s, AV_LOG_ERROR, "Could not parse format options list '%s'\n",
766 hls->format_options_str);
771 av_dict_copy(&options, hls->format_options, 0);
772 av_dict_set(&options, "fflags", "-autobsf", 0);
773 av_dict_set(&options, "movflags", "frag_custom+dash+delay_moov", 0);
774 ret = avformat_init_output(oc, &options);
777 if (av_dict_count(options)) {
778 av_log(s, AV_LOG_ERROR, "Some of the provided format options in '%s' are not recognized\n", hls->format_options_str);
779 av_dict_free(&options);
780 return AVERROR(EINVAL);
783 av_dict_free(&options);
788 static HLSSegment *find_segment_by_filename(HLSSegment *segment, const char *filename)
791 if (!av_strcasecmp(segment->filename,filename))
793 segment = segment->next;
795 return (HLSSegment *) NULL;
798 static int sls_flags_filename_process(struct AVFormatContext *s, HLSContext *hls,
799 VariantStream *vs, HLSSegment *en,
800 double duration, int64_t pos, int64_t size)
802 if ((hls->flags & (HLS_SECOND_LEVEL_SEGMENT_SIZE | HLS_SECOND_LEVEL_SEGMENT_DURATION)) &&
803 strlen(vs->current_segment_final_filename_fmt)) {
804 av_strlcpy(vs->avf->filename, vs->current_segment_final_filename_fmt, sizeof(vs->avf->filename));
805 if (hls->flags & HLS_SECOND_LEVEL_SEGMENT_SIZE) {
806 char * filename = av_strdup(vs->avf->filename); // %%s will be %s after strftime
809 return AVERROR(ENOMEM);
811 if (replace_int_data_in_filename(vs->avf->filename, sizeof(vs->avf->filename),
812 filename, 's', pos + size) < 1) {
813 av_log(hls, AV_LOG_ERROR,
814 "Invalid second level segment filename template '%s', "
815 "you can try to remove second_level_segment_size flag\n",
819 return AVERROR(EINVAL);
823 if (hls->flags & HLS_SECOND_LEVEL_SEGMENT_DURATION) {
824 char * filename = av_strdup(vs->avf->filename); // %%t will be %t after strftime
827 return AVERROR(ENOMEM);
829 if (replace_int_data_in_filename(vs->avf->filename, sizeof(vs->avf->filename),
830 filename, 't', (int64_t)round(duration * HLS_MICROSECOND_UNIT)) < 1) {
831 av_log(hls, AV_LOG_ERROR,
832 "Invalid second level segment filename template '%s', "
833 "you can try to remove second_level_segment_time flag\n",
837 return AVERROR(EINVAL);
845 static int sls_flag_check_duration_size_index(HLSContext *hls)
849 if (hls->flags & HLS_SECOND_LEVEL_SEGMENT_DURATION) {
850 av_log(hls, AV_LOG_ERROR,
851 "second_level_segment_duration hls_flag requires use_localtime to be true\n");
852 ret = AVERROR(EINVAL);
854 if (hls->flags & HLS_SECOND_LEVEL_SEGMENT_SIZE) {
855 av_log(hls, AV_LOG_ERROR,
856 "second_level_segment_size hls_flag requires use_localtime to be true\n");
857 ret = AVERROR(EINVAL);
859 if (hls->flags & HLS_SECOND_LEVEL_SEGMENT_INDEX) {
860 av_log(hls, AV_LOG_ERROR,
861 "second_level_segment_index hls_flag requires use_localtime to be true\n");
862 ret = AVERROR(EINVAL);
868 static int sls_flag_check_duration_size(HLSContext *hls, VariantStream *vs)
870 const char *proto = avio_find_protocol_name(vs->basename);
871 int segment_renaming_ok = proto && !strcmp(proto, "file");
874 if ((hls->flags & HLS_SECOND_LEVEL_SEGMENT_DURATION) && !segment_renaming_ok) {
875 av_log(hls, AV_LOG_ERROR,
876 "second_level_segment_duration hls_flag works only with file protocol segment names\n");
877 ret = AVERROR(EINVAL);
879 if ((hls->flags & HLS_SECOND_LEVEL_SEGMENT_SIZE) && !segment_renaming_ok) {
880 av_log(hls, AV_LOG_ERROR,
881 "second_level_segment_size hls_flag works only with file protocol segment names\n");
882 ret = AVERROR(EINVAL);
888 static void sls_flag_file_rename(HLSContext *hls, VariantStream *vs, char *old_filename) {
889 if ((hls->flags & (HLS_SECOND_LEVEL_SEGMENT_SIZE | HLS_SECOND_LEVEL_SEGMENT_DURATION)) &&
890 strlen(vs->current_segment_final_filename_fmt)) {
891 ff_rename(old_filename, vs->avf->filename, hls);
895 static int sls_flag_use_localtime_filename(AVFormatContext *oc, HLSContext *c, VariantStream *vs)
897 if (c->flags & HLS_SECOND_LEVEL_SEGMENT_INDEX) {
898 char * filename = av_strdup(oc->filename); // %%d will be %d after strftime
900 return AVERROR(ENOMEM);
901 if (replace_int_data_in_filename(oc->filename, sizeof(oc->filename),
903 filename, 'd', c->wrap ? vs->sequence % c->wrap : vs->sequence) < 1) {
905 filename, 'd', vs->sequence) < 1) {
907 av_log(c, AV_LOG_ERROR, "Invalid second level segment filename template '%s', "
908 "you can try to remove second_level_segment_index flag\n",
911 return AVERROR(EINVAL);
915 if (c->flags & (HLS_SECOND_LEVEL_SEGMENT_SIZE | HLS_SECOND_LEVEL_SEGMENT_DURATION)) {
916 av_strlcpy(vs->current_segment_final_filename_fmt, oc->filename,
917 sizeof(vs->current_segment_final_filename_fmt));
918 if (c->flags & HLS_SECOND_LEVEL_SEGMENT_SIZE) {
919 char * filename = av_strdup(oc->filename); // %%s will be %s after strftime
921 return AVERROR(ENOMEM);
922 if (replace_int_data_in_filename(oc->filename, sizeof(oc->filename), filename, 's', 0) < 1) {
923 av_log(c, AV_LOG_ERROR, "Invalid second level segment filename template '%s', "
924 "you can try to remove second_level_segment_size flag\n",
927 return AVERROR(EINVAL);
931 if (c->flags & HLS_SECOND_LEVEL_SEGMENT_DURATION) {
932 char * filename = av_strdup(oc->filename); // %%t will be %t after strftime
934 return AVERROR(ENOMEM);
935 if (replace_int_data_in_filename(oc->filename, sizeof(oc->filename), filename, 't', 0) < 1) {
936 av_log(c, AV_LOG_ERROR, "Invalid second level segment filename template '%s', "
937 "you can try to remove second_level_segment_time flag\n",
940 return AVERROR(EINVAL);
948 /* Create a new segment and append it to the segment list */
949 static int hls_append_segment(struct AVFormatContext *s, HLSContext *hls,
950 VariantStream *vs, double duration, int64_t pos,
953 HLSSegment *en = av_malloc(sizeof(*en));
954 const char *filename;
955 int byterange_mode = (hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size > 0);
959 return AVERROR(ENOMEM);
961 ret = sls_flags_filename_process(s, hls, vs, en, duration, pos, size);
966 filename = av_basename(vs->avf->filename);
968 if (hls->use_localtime_mkdir) {
969 filename = vs->avf->filename;
971 if ((find_segment_by_filename(vs->segments, filename) || find_segment_by_filename(vs->old_segments, filename))
972 && !byterange_mode) {
973 av_log(hls, AV_LOG_WARNING, "Duplicated segment filename detected: %s\n", filename);
975 av_strlcpy(en->filename, filename, sizeof(en->filename));
978 av_strlcpy(en->sub_filename, av_basename(vs->vtt_avf->filename), sizeof(en->sub_filename));
980 en->sub_filename[0] = '\0';
982 en->duration = duration;
988 if (vs->discontinuity) {
990 vs->discontinuity = 0;
993 if (hls->key_info_file || hls->encrypt) {
994 av_strlcpy(en->key_uri, hls->key_uri, sizeof(en->key_uri));
995 av_strlcpy(en->iv_string, hls->iv_string, sizeof(en->iv_string));
1001 vs->last_segment->next = en;
1003 vs->last_segment = en;
1005 // EVENT or VOD playlists imply sliding window cannot be used
1006 if (hls->pl_type != PLAYLIST_TYPE_NONE)
1007 hls->max_nb_segments = 0;
1009 if (hls->max_nb_segments && vs->nb_entries >= hls->max_nb_segments) {
1011 vs->initial_prog_date_time += en->duration;
1012 vs->segments = en->next;
1013 if (en && hls->flags & HLS_DELETE_SEGMENTS &&
1015 !(hls->flags & HLS_SINGLE_FILE || hls->wrap)) {
1017 !(hls->flags & HLS_SINGLE_FILE)) {
1019 en->next = vs->old_segments;
1020 vs->old_segments = en;
1021 if ((ret = hls_delete_old_segments(s, hls, vs)) < 0)
1028 if (hls->max_seg_size > 0) {
1036 static int parse_playlist(AVFormatContext *s, const char *url, VariantStream *vs)
1038 HLSContext *hls = s->priv_data;
1040 int ret = 0, is_segment = 0;
1041 int64_t new_start_pos;
1046 if ((ret = ffio_open_whitelist(&in, url, AVIO_FLAG_READ,
1047 &s->interrupt_callback, NULL,
1048 s->protocol_whitelist, s->protocol_blacklist)) < 0)
1051 read_chomp_line(in, line, sizeof(line));
1052 if (strcmp(line, "#EXTM3U")) {
1053 ret = AVERROR_INVALIDDATA;
1057 vs->discontinuity = 0;
1058 while (!avio_feof(in)) {
1059 read_chomp_line(in, line, sizeof(line));
1060 if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
1061 int64_t tmp_sequence = strtoll(ptr, NULL, 10);
1062 if (tmp_sequence < vs->sequence)
1063 av_log(hls, AV_LOG_VERBOSE,
1064 "Found playlist sequence number was smaller """
1065 "than specified start sequence number: %"PRId64" < %"PRId64", "
1066 "omitting\n", tmp_sequence, hls->start_sequence);
1068 av_log(hls, AV_LOG_DEBUG, "Found playlist sequence number: %"PRId64"\n", tmp_sequence);
1069 vs->sequence = tmp_sequence;
1071 } else if (av_strstart(line, "#EXT-X-DISCONTINUITY", &ptr)) {
1073 vs->discontinuity = 1;
1074 } else if (av_strstart(line, "#EXTINF:", &ptr)) {
1076 vs->duration = atof(ptr);
1077 } else if (av_stristart(line, "#EXT-X-KEY:", &ptr)) {
1078 ptr = av_stristr(line, "URI=\"");
1080 ptr += strlen("URI=\"");
1081 end = av_stristr(ptr, ",");
1083 av_strlcpy(hls->key_uri, ptr, end - ptr);
1085 av_strlcpy(hls->key_uri, ptr, sizeof(hls->key_uri));
1089 ptr = av_stristr(line, "IV=0x");
1091 ptr += strlen("IV=0x");
1092 end = av_stristr(ptr, ",");
1094 av_strlcpy(hls->iv_string, ptr, end - ptr);
1096 av_strlcpy(hls->iv_string, ptr, sizeof(hls->iv_string));
1100 } else if (av_strstart(line, "#", NULL)) {
1102 } else if (line[0]) {
1105 new_start_pos = avio_tell(vs->avf->pb);
1106 vs->size = new_start_pos - vs->start_pos;
1107 av_strlcpy(vs->avf->filename, line, sizeof(line));
1108 ret = hls_append_segment(s, hls, vs, vs->duration, vs->start_pos, vs->size);
1111 vs->start_pos = new_start_pos;
1121 static void hls_free_segments(HLSSegment *p)
1132 static void hls_rename_temp_file(AVFormatContext *s, AVFormatContext *oc)
1134 size_t len = strlen(oc->filename);
1135 char final_filename[sizeof(oc->filename)];
1137 av_strlcpy(final_filename, oc->filename, len);
1138 final_filename[len-4] = '\0';
1139 ff_rename(oc->filename, final_filename, s);
1140 oc->filename[len-4] = '\0';
1143 static int get_relative_url(const char *master_url, const char *media_url,
1144 char *rel_url, int rel_url_buf_size)
1148 p = strrchr(master_url, '/') ? strrchr(master_url, '/') :\
1149 strrchr(master_url, '\\');
1151 base_len = FFABS(p - master_url);
1152 if (av_strncasecmp(master_url, media_url, base_len)) {
1153 av_log(NULL, AV_LOG_WARNING, "Unable to find relative url\n");
1154 return AVERROR(EINVAL);
1157 av_strlcpy(rel_url, &(media_url[base_len + 1]), rel_url_buf_size);
1161 static int create_master_playlist(AVFormatContext *s,
1162 VariantStream * const input_vs)
1164 HLSContext *hls = s->priv_data;
1165 VariantStream *vs, *temp_vs;
1166 AVStream *vid_st, *aud_st;
1167 AVDictionary *options = NULL;
1169 int m3u8_name_size, ret, bandwidth;
1170 char *m3u8_rel_name;
1172 input_vs->m3u8_created = 1;
1173 if (!hls->master_m3u8_created) {
1174 /* For the first time, wait until all the media playlists are created */
1175 for (i = 0; i < hls->nb_varstreams; i++)
1176 if (!hls->var_streams[i].m3u8_created)
1179 /* Keep publishing the master playlist at the configured rate */
1180 if (&hls->var_streams[0] != input_vs || !hls->master_publish_rate ||
1181 input_vs->number % hls->master_publish_rate)
1185 set_http_options(s, &options, hls);
1187 ret = hlsenc_io_open(s, &hls->m3u8_out, hls->master_m3u8_url, &options);
1188 av_dict_free(&options);
1190 av_log(NULL, AV_LOG_ERROR, "Failed to open master play list file '%s'\n",
1191 hls->master_m3u8_url);
1195 ff_hls_write_playlist_version(hls->m3u8_out, hls->version);
1197 /* For audio only variant streams add #EXT-X-MEDIA tag with attributes*/
1198 for (i = 0; i < hls->nb_varstreams; i++) {
1199 vs = &(hls->var_streams[i]);
1201 if (vs->has_video || vs->has_subtitle || !vs->agroup)
1204 m3u8_name_size = strlen(vs->m3u8_name) + 1;
1205 m3u8_rel_name = av_malloc(m3u8_name_size);
1206 if (!m3u8_rel_name) {
1207 ret = AVERROR(ENOMEM);
1210 av_strlcpy(m3u8_rel_name, vs->m3u8_name, m3u8_name_size);
1211 ret = get_relative_url(hls->master_m3u8_url, vs->m3u8_name,
1212 m3u8_rel_name, m3u8_name_size);
1214 av_log(s, AV_LOG_ERROR, "Unable to find relative URL\n");
1218 ff_hls_write_audio_rendition(hls->m3u8_out, vs->agroup, m3u8_rel_name, 0, 1);
1220 av_freep(&m3u8_rel_name);
1223 /* For variant streams with video add #EXT-X-STREAM-INF tag with attributes*/
1224 for (i = 0; i < hls->nb_varstreams; i++) {
1225 vs = &(hls->var_streams[i]);
1227 m3u8_name_size = strlen(vs->m3u8_name) + 1;
1228 m3u8_rel_name = av_malloc(m3u8_name_size);
1229 if (!m3u8_rel_name) {
1230 ret = AVERROR(ENOMEM);
1233 av_strlcpy(m3u8_rel_name, vs->m3u8_name, m3u8_name_size);
1234 ret = get_relative_url(hls->master_m3u8_url, vs->m3u8_name,
1235 m3u8_rel_name, m3u8_name_size);
1237 av_log(NULL, AV_LOG_ERROR, "Unable to find relative URL\n");
1243 for (j = 0; j < vs->nb_streams; j++) {
1244 if (vs->streams[j]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO)
1245 vid_st = vs->streams[j];
1246 else if (vs->streams[j]->codecpar->codec_type == AVMEDIA_TYPE_AUDIO)
1247 aud_st = vs->streams[j];
1250 if (!vid_st && !aud_st) {
1251 av_log(NULL, AV_LOG_WARNING, "Media stream not found\n");
1256 * Traverse through the list of audio only rendition streams and find
1257 * the rendition which has highest bitrate in the same audio group
1260 for (j = 0; j < hls->nb_varstreams; j++) {
1261 temp_vs = &(hls->var_streams[j]);
1262 if (!temp_vs->has_video && !temp_vs->has_subtitle &&
1264 !av_strcasecmp(temp_vs->agroup, vs->agroup)) {
1266 aud_st = temp_vs->streams[0];
1267 if (temp_vs->streams[0]->codecpar->bit_rate >
1268 aud_st->codecpar->bit_rate)
1269 aud_st = temp_vs->streams[0];
1276 bandwidth += vid_st->codecpar->bit_rate;
1278 bandwidth += aud_st->codecpar->bit_rate;
1279 bandwidth += bandwidth / 10;
1281 ff_hls_write_stream_info(vid_st, hls->m3u8_out, bandwidth, m3u8_rel_name,
1282 aud_st ? vs->agroup : NULL, vs->codec_attr);
1284 av_freep(&m3u8_rel_name);
1288 hls->master_m3u8_created = 1;
1289 av_freep(&m3u8_rel_name);
1290 hlsenc_io_close(s, &hls->m3u8_out, hls->master_m3u8_url);
1294 static int hls_window(AVFormatContext *s, int last, VariantStream *vs)
1296 HLSContext *hls = s->priv_data;
1298 int target_duration = 0;
1300 char temp_filename[1024];
1301 int64_t sequence = FFMAX(hls->start_sequence, vs->sequence - vs->nb_entries);
1302 const char *proto = avio_find_protocol_name(s->filename);
1303 int use_rename = proto && !strcmp(proto, "file");
1304 static unsigned warned_non_file;
1305 char *key_uri = NULL;
1306 char *iv_string = NULL;
1307 AVDictionary *options = NULL;
1308 double prog_date_time = vs->initial_prog_date_time;
1309 double *prog_date_time_p = (hls->flags & HLS_PROGRAM_DATE_TIME) ? &prog_date_time : NULL;
1310 int byterange_mode = (hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size > 0);
1313 if (byterange_mode) {
1318 if (hls->flags & HLS_INDEPENDENT_SEGMENTS) {
1322 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
1326 if (!use_rename && !warned_non_file++)
1327 av_log(s, AV_LOG_ERROR, "Cannot use rename on non file protocol, this may lead to races and temporary partial files\n");
1329 set_http_options(s, &options, hls);
1330 snprintf(temp_filename, sizeof(temp_filename), use_rename ? "%s.tmp" : "%s", vs->m3u8_name);
1331 if ((ret = hlsenc_io_open(s, &hls->m3u8_out, temp_filename, &options)) < 0)
1334 for (en = vs->segments; en; en = en->next) {
1335 if (target_duration <= en->duration)
1336 target_duration = lrint(en->duration);
1339 vs->discontinuity_set = 0;
1340 ff_hls_write_playlist_header(hls->m3u8_out, hls->version, hls->allowcache,
1341 target_duration, sequence, hls->pl_type);
1343 if((hls->flags & HLS_DISCONT_START) && sequence==hls->start_sequence && vs->discontinuity_set==0 ){
1344 avio_printf(hls->m3u8_out, "#EXT-X-DISCONTINUITY\n");
1345 vs->discontinuity_set = 1;
1347 if (vs->has_video && (hls->flags & HLS_INDEPENDENT_SEGMENTS)) {
1348 avio_printf(hls->m3u8_out, "#EXT-X-INDEPENDENT-SEGMENTS\n");
1350 for (en = vs->segments; en; en = en->next) {
1351 if ((hls->encrypt || hls->key_info_file) && (!key_uri || strcmp(en->key_uri, key_uri) ||
1352 av_strcasecmp(en->iv_string, iv_string))) {
1353 avio_printf(hls->m3u8_out, "#EXT-X-KEY:METHOD=AES-128,URI=\"%s\"", en->key_uri);
1355 avio_printf(hls->m3u8_out, ",IV=0x%s", en->iv_string);
1356 avio_printf(hls->m3u8_out, "\n");
1357 key_uri = en->key_uri;
1358 iv_string = en->iv_string;
1361 if ((hls->segment_type == SEGMENT_TYPE_FMP4) && (en == vs->segments)) {
1362 ff_hls_write_init_file(hls->m3u8_out, vs->fmp4_init_filename,
1363 hls->flags & HLS_SINGLE_FILE, en->size, en->pos);
1366 ret = ff_hls_write_file_entry(hls->m3u8_out, en->discont, byterange_mode,
1367 en->duration, hls->flags & HLS_ROUND_DURATIONS,
1368 en->size, en->pos, vs->baseurl,
1369 en->filename, prog_date_time_p);
1371 av_log(s, AV_LOG_WARNING, "ff_hls_write_file_entry get error\n");
1375 if (last && (hls->flags & HLS_OMIT_ENDLIST)==0)
1376 ff_hls_write_end_list(hls->m3u8_out);
1378 if( vs->vtt_m3u8_name ) {
1379 if ((ret = hlsenc_io_open(s, &hls->sub_m3u8_out, vs->vtt_m3u8_name, &options)) < 0)
1381 ff_hls_write_playlist_header(hls->sub_m3u8_out, hls->version, hls->allowcache,
1382 target_duration, sequence, PLAYLIST_TYPE_NONE);
1383 for (en = vs->segments; en; en = en->next) {
1384 ret = ff_hls_write_file_entry(hls->sub_m3u8_out, 0, byterange_mode,
1385 en->duration, 0, en->size, en->pos,
1386 vs->baseurl, en->sub_filename, NULL);
1388 av_log(s, AV_LOG_WARNING, "ff_hls_write_file_entry get error\n");
1393 ff_hls_write_end_list(hls->sub_m3u8_out);
1398 av_dict_free(&options);
1399 hlsenc_io_close(s, &hls->m3u8_out, temp_filename);
1400 hlsenc_io_close(s, &hls->sub_m3u8_out, vs->vtt_m3u8_name);
1401 if (ret >= 0 && use_rename)
1402 ff_rename(temp_filename, vs->m3u8_name, s);
1404 if (ret >= 0 && hls->master_pl_name)
1405 if (create_master_playlist(s, vs) < 0)
1406 av_log(s, AV_LOG_WARNING, "Master playlist creation failed\n");
1411 static int hls_start(AVFormatContext *s, VariantStream *vs)
1413 HLSContext *c = s->priv_data;
1414 AVFormatContext *oc = vs->avf;
1415 AVFormatContext *vtt_oc = vs->vtt_avf;
1416 AVDictionary *options = NULL;
1417 char *filename, iv_string[KEYSIZE*2 + 1];
1420 if (c->flags & HLS_SINGLE_FILE) {
1421 av_strlcpy(oc->filename, vs->basename,
1422 sizeof(oc->filename));
1423 if (vs->vtt_basename)
1424 av_strlcpy(vtt_oc->filename, vs->vtt_basename,
1425 sizeof(vtt_oc->filename));
1426 } else if (c->max_seg_size > 0) {
1427 if (replace_int_data_in_filename(oc->filename, sizeof(oc->filename),
1429 vs->basename, 'd', c->wrap ? vs->sequence % c->wrap : vs->sequence) < 1) {
1431 vs->basename, 'd', vs->sequence) < 1) {
1433 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s', you can try to use -use_localtime 1 with it\n", vs->basename);
1434 return AVERROR(EINVAL);
1437 if (c->use_localtime) {
1439 struct tm *tm, tmpbuf;
1441 tm = localtime_r(&now0, &tmpbuf);
1442 if (!strftime(oc->filename, sizeof(oc->filename), vs->basename, tm)) {
1443 av_log(oc, AV_LOG_ERROR, "Could not get segment filename with use_localtime\n");
1444 return AVERROR(EINVAL);
1447 err = sls_flag_use_localtime_filename(oc, c, vs);
1449 return AVERROR(ENOMEM);
1452 if (c->use_localtime_mkdir) {
1454 char *fn_copy = av_strdup(oc->filename);
1456 return AVERROR(ENOMEM);
1458 dir = av_dirname(fn_copy);
1459 if (mkdir_p(dir) == -1 && errno != EEXIST) {
1460 av_log(oc, AV_LOG_ERROR, "Could not create directory %s with use_localtime_mkdir\n", dir);
1462 return AVERROR(errno);
1466 } else if (replace_int_data_in_filename(oc->filename, sizeof(oc->filename),
1468 vs->basename, 'd', c->wrap ? vs->sequence % c->wrap : vs->sequence) < 1) {
1470 vs->basename, 'd', vs->sequence) < 1) {
1472 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s' you can try to use -use_localtime 1 with it\n", vs->basename);
1473 return AVERROR(EINVAL);
1475 if( vs->vtt_basename) {
1476 if (replace_int_data_in_filename(vtt_oc->filename, sizeof(vtt_oc->filename),
1478 vs->vtt_basename, 'd', c->wrap ? vs->sequence % c->wrap : vs->sequence) < 1) {
1480 vs->vtt_basename, 'd', vs->sequence) < 1) {
1482 av_log(vtt_oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", vs->vtt_basename);
1483 return AVERROR(EINVAL);
1489 set_http_options(s, &options, c);
1491 if (c->flags & HLS_TEMP_FILE) {
1492 av_strlcat(oc->filename, ".tmp", sizeof(oc->filename));
1495 if (c->key_info_file || c->encrypt) {
1496 if (c->key_info_file && c->encrypt) {
1497 av_log(s, AV_LOG_WARNING, "Cannot use both -hls_key_info_file and -hls_enc,"
1498 " will use -hls_key_info_file priority\n");
1501 if (!c->encrypt_started || (c->flags & HLS_PERIODIC_REKEY)) {
1502 if (c->key_info_file) {
1503 if ((err = hls_encryption_start(s)) < 0)
1506 if ((err = do_encrypt(s, vs)) < 0)
1509 c->encrypt_started = 1;
1511 if ((err = av_dict_set(&options, "encryption_key", c->key_string, 0))
1514 err = av_strlcpy(iv_string, c->iv_string, sizeof(iv_string));
1516 snprintf(iv_string, sizeof(iv_string), "%032"PRIx64, vs->sequence);
1517 if ((err = av_dict_set(&options, "encryption_iv", iv_string, 0)) < 0)
1520 filename = av_asprintf("crypto:%s", oc->filename);
1522 err = AVERROR(ENOMEM);
1525 err = hlsenc_io_open(s, &oc->pb, filename, &options);
1527 av_dict_free(&options);
1530 } else if (c->segment_type != SEGMENT_TYPE_FMP4) {
1531 if ((err = hlsenc_io_open(s, &oc->pb, oc->filename, &options)) < 0)
1534 if (vs->vtt_basename) {
1535 set_http_options(s, &options, c);
1536 if ((err = hlsenc_io_open(s, &vtt_oc->pb, vtt_oc->filename, &options)) < 0)
1539 av_dict_free(&options);
1541 if (c->segment_type != SEGMENT_TYPE_FMP4) {
1542 /* We only require one PAT/PMT per segment. */
1543 if (oc->oformat->priv_class && oc->priv_data) {
1546 snprintf(period, sizeof(period), "%d", (INT_MAX / 2) - 1);
1548 av_opt_set(oc->priv_data, "mpegts_flags", "resend_headers", 0);
1549 av_opt_set(oc->priv_data, "sdt_period", period, 0);
1550 av_opt_set(oc->priv_data, "pat_period", period, 0);
1554 if (vs->vtt_basename) {
1555 err = avformat_write_header(vtt_oc,NULL);
1562 av_dict_free(&options);
1567 static const char * get_default_pattern_localtime_fmt(AVFormatContext *s)
1570 time_t t = time(NULL);
1571 struct tm *p, tmbuf;
1572 HLSContext *hls = s->priv_data;
1574 p = localtime_r(&t, &tmbuf);
1575 // no %s support when strftime returned error or left format string unchanged
1576 // also no %s support on MSVC, which invokes the invalid parameter handler on unsupported format strings, instead of returning an error
1577 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
1578 return (HAVE_LIBC_MSVCRT || !strftime(b, sizeof(b), "%s", p) || !strcmp(b, "%s")) ? "-%Y%m%d%H%M%S.m4s" : "-%s.m4s";
1580 return (HAVE_LIBC_MSVCRT || !strftime(b, sizeof(b), "%s", p) || !strcmp(b, "%s")) ? "-%Y%m%d%H%M%S.ts" : "-%s.ts";
1583 static int append_postfix(char *name, int name_buf_len, int i)
1586 char extension[10] = {'\0'};
1588 p = strrchr(name, '.');
1590 av_strlcpy(extension, p, sizeof(extension));
1594 snprintf(name + strlen(name), name_buf_len - strlen(name), POSTFIX_PATTERN, i);
1596 if (strlen(extension))
1597 av_strlcat(name, extension, name_buf_len);
1602 static int validate_name(int nb_vs, const char *fn)
1604 const char *filename, *subdir_name;
1605 char *fn_dup = NULL;
1609 ret = AVERROR(EINVAL);
1613 fn_dup = av_strdup(fn);
1615 ret = AVERROR(ENOMEM);
1619 filename = av_basename(fn);
1620 subdir_name = av_dirname(fn_dup);
1622 if (nb_vs > 1 && !av_stristr(filename, "%v") && !av_stristr(subdir_name, "%v")) {
1623 av_log(NULL, AV_LOG_ERROR, "More than 1 variant streams are present, %%v is expected in the filename %s\n",
1625 ret = AVERROR(EINVAL);
1629 if (av_stristr(filename, "%v") && av_stristr(subdir_name, "%v")) {
1630 av_log(NULL, AV_LOG_ERROR, "%%v is expected either in filename or in the sub-directory name of file %s\n",
1632 ret = AVERROR(EINVAL);
1641 static int format_name(char *buf, int buf_len, int index)
1643 const char *proto, *dir;
1644 char *orig_buf_dup = NULL, *mod_buf_dup = NULL;
1647 if (!av_stristr(buf, "%v"))
1650 orig_buf_dup = av_strdup(buf);
1651 if (!orig_buf_dup) {
1652 ret = AVERROR(ENOMEM);
1656 if (replace_int_data_in_filename(buf, buf_len, orig_buf_dup, 'v', index) < 1) {
1657 ret = AVERROR(EINVAL);
1661 proto = avio_find_protocol_name(orig_buf_dup);
1662 dir = av_dirname(orig_buf_dup);
1664 /* if %v is present in the file's directory, create sub-directory */
1665 if (av_stristr(dir, "%v") && proto && !strcmp(proto, "file")) {
1666 mod_buf_dup = av_strdup(buf);
1668 ret = AVERROR(ENOMEM);
1672 dir = av_dirname(mod_buf_dup);
1673 if (mkdir_p(dir) == -1 && errno != EEXIST) {
1674 ret = AVERROR(errno);
1680 av_freep(&orig_buf_dup);
1681 av_freep(&mod_buf_dup);
1685 static int get_nth_codec_stream_index(AVFormatContext *s,
1686 enum AVMediaType codec_type,
1689 unsigned int stream_index, cnt;
1690 if (stream_id < 0 || stream_id > s->nb_streams - 1)
1693 for (stream_index = 0; stream_index < s->nb_streams; stream_index++) {
1694 if (s->streams[stream_index]->codecpar->codec_type != codec_type)
1696 if (cnt == stream_id)
1697 return stream_index;
1703 static int parse_variant_stream_mapstring(AVFormatContext *s)
1705 HLSContext *hls = s->priv_data;
1708 enum AVMediaType codec_type;
1709 int nb_varstreams, nb_streams;
1710 char *p, *q, *saveptr1, *saveptr2, *varstr, *keyval;
1714 * Expected format for var_stream_map string is as below:
1716 * "a:0,agroup:a0 a:1,agroup:a1 v:0,agroup:a0 v:1,agroup:a1"
1717 * This string specifies how to group the audio, video and subtitle streams
1718 * into different variant streams. The variant stream groups are separated
1721 * a:, v:, s: are keys to specify audio, video and subtitle streams
1722 * respectively. Allowed values are 0 to 9 digits (limited just based on
1725 * agroup: is key to specify audio group. A string can be given as value.
1727 p = av_strdup(hls->var_stream_map);
1729 while(av_strtok(q, " \t", &saveptr1)) {
1731 hls->nb_varstreams++;
1735 hls->var_streams = av_mallocz(sizeof(*hls->var_streams) * hls->nb_varstreams);
1736 if (!hls->var_streams)
1737 return AVERROR(ENOMEM);
1739 p = hls->var_stream_map;
1741 while (varstr = av_strtok(p, " \t", &saveptr1)) {
1744 if (nb_varstreams < hls->nb_varstreams)
1745 vs = &(hls->var_streams[nb_varstreams++]);
1747 return AVERROR(EINVAL);
1750 while (q < varstr + strlen(varstr)) {
1751 if (!av_strncasecmp(q, "a:", 2) || !av_strncasecmp(q, "v:", 2) ||
1752 !av_strncasecmp(q, "s:", 2))
1756 vs->streams = av_mallocz(sizeof(AVStream *) * vs->nb_streams);
1758 return AVERROR(ENOMEM);
1761 while (keyval = av_strtok(varstr, ",", &saveptr2)) {
1764 if (av_strstart(keyval, "agroup:", &val)) {
1765 vs->agroup = av_strdup(val);
1767 return AVERROR(ENOMEM);
1769 } else if (av_strstart(keyval, "v:", &val)) {
1770 codec_type = AVMEDIA_TYPE_VIDEO;
1771 } else if (av_strstart(keyval, "a:", &val)) {
1772 codec_type = AVMEDIA_TYPE_AUDIO;
1773 } else if (av_strstart(keyval, "s:", &val)) {
1774 codec_type = AVMEDIA_TYPE_SUBTITLE;
1776 av_log(s, AV_LOG_ERROR, "Invalid keyval %s\n", keyval);
1777 return AVERROR(EINVAL);
1781 if (av_isdigit(*val))
1782 stream_index = get_nth_codec_stream_index (s, codec_type,
1785 if (stream_index >= 0 && nb_streams < vs->nb_streams) {
1786 vs->streams[nb_streams++] = s->streams[stream_index];
1788 av_log(s, AV_LOG_ERROR, "Unable to map stream at %s\n", keyval);
1789 return AVERROR(EINVAL);
1793 av_log(s, AV_LOG_DEBUG, "Number of variant streams %d\n",
1794 hls->nb_varstreams);
1799 static int update_variant_stream_info(AVFormatContext *s) {
1800 HLSContext *hls = s->priv_data;
1803 if (hls->var_stream_map) {
1804 return parse_variant_stream_mapstring(s);
1806 //By default, a single variant stream with all the codec streams is created
1807 hls->nb_varstreams = 1;
1808 hls->var_streams = av_mallocz(sizeof(*hls->var_streams) *
1809 hls->nb_varstreams);
1810 if (!hls->var_streams)
1811 return AVERROR(ENOMEM);
1813 hls->var_streams[0].nb_streams = s->nb_streams;
1814 hls->var_streams[0].streams = av_mallocz(sizeof(AVStream *) *
1815 hls->var_streams[0].nb_streams);
1816 if (!hls->var_streams[0].streams)
1817 return AVERROR(ENOMEM);
1819 for (i = 0; i < s->nb_streams; i++)
1820 hls->var_streams[0].streams[i] = s->streams[i];
1825 static int update_master_pl_info(AVFormatContext *s) {
1826 HLSContext *hls = s->priv_data;
1828 char *fn1= NULL, *fn2 = NULL;
1831 fn1 = av_strdup(s->filename);
1833 ret = AVERROR(ENOMEM);
1837 dir = av_dirname(fn1);
1840 * if output file's directory has %v, variants are created in sub-directories
1841 * then master is created at the sub-directories level
1843 if (dir && av_stristr(av_basename(dir), "%v")) {
1844 fn2 = av_strdup(dir);
1846 ret = AVERROR(ENOMEM);
1849 dir = av_dirname(fn2);
1852 if (dir && strcmp(dir, "."))
1853 hls->master_m3u8_url = av_append_path_component(dir, hls->master_pl_name);
1855 hls->master_m3u8_url = av_strdup(hls->master_pl_name);
1857 if (!hls->master_m3u8_url) {
1858 ret = AVERROR(ENOMEM);
1869 static int hls_write_header(AVFormatContext *s)
1871 HLSContext *hls = s->priv_data;
1873 AVDictionary *options = NULL;
1874 VariantStream *vs = NULL;
1876 for (i = 0; i < hls->nb_varstreams; i++) {
1877 vs = &hls->var_streams[i];
1879 av_dict_copy(&options, hls->format_options, 0);
1880 ret = avformat_write_header(vs->avf, &options);
1881 if (av_dict_count(options)) {
1882 av_log(s, AV_LOG_ERROR, "Some of provided format options in '%s' are not recognized\n", hls->format_options_str);
1883 ret = AVERROR(EINVAL);
1884 av_dict_free(&options);
1887 av_dict_free(&options);
1888 //av_assert0(s->nb_streams == hls->avf->nb_streams);
1889 for (j = 0; j < vs->nb_streams; j++) {
1891 AVStream *outer_st = vs->streams[j];
1893 if (hls->max_seg_size > 0) {
1894 if ((outer_st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) &&
1895 (outer_st->codecpar->bit_rate > hls->max_seg_size)) {
1896 av_log(s, AV_LOG_WARNING, "Your video bitrate is bigger than hls_segment_size, "
1897 "(%"PRId64 " > %"PRId64 "), the result maybe not be what you want.",
1898 outer_st->codecpar->bit_rate, hls->max_seg_size);
1902 if (outer_st->codecpar->codec_type != AVMEDIA_TYPE_SUBTITLE)
1903 inner_st = vs->avf->streams[j];
1904 else if (vs->vtt_avf)
1905 inner_st = vs->vtt_avf->streams[0];
1907 /* We have a subtitle stream, when the user does not want one */
1911 avpriv_set_pts_info(outer_st, inner_st->pts_wrap_bits, inner_st->time_base.num, inner_st->time_base.den);
1912 write_codec_attr(outer_st, vs);
1915 /* Update the Codec Attr string for the mapped audio groups */
1916 if (vs->has_video && vs->agroup) {
1917 for (j = 0; j < hls->nb_varstreams; j++) {
1918 VariantStream *vs_agroup = &(hls->var_streams[j]);
1919 if (!vs_agroup->has_video && !vs_agroup->has_subtitle &&
1920 vs_agroup->agroup &&
1921 !av_strcasecmp(vs_agroup->agroup, vs->agroup)) {
1922 write_codec_attr(vs_agroup->streams[0], vs);
1932 static int hls_write_packet(AVFormatContext *s, AVPacket *pkt)
1934 HLSContext *hls = s->priv_data;
1935 AVFormatContext *oc = NULL;
1936 AVStream *st = s->streams[pkt->stream_index];
1937 int64_t end_pts = 0;
1939 int ret = 0, can_split = 1, i, j;
1940 int stream_index = 0;
1941 int range_length = 0;
1942 uint8_t *buffer = NULL;
1943 VariantStream *vs = NULL;
1945 for (i = 0; i < hls->nb_varstreams; i++) {
1946 vs = &hls->var_streams[i];
1947 for (j = 0; j < vs->nb_streams; j++) {
1948 if (vs->streams[j] == st) {
1949 if( st->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE ) {
1965 av_log(s, AV_LOG_ERROR, "Unable to find mapping variant stream\n");
1966 return AVERROR(ENOMEM);
1969 end_pts = hls->recording_time * vs->number;
1971 if (vs->sequence - vs->nb_entries > hls->start_sequence && hls->init_time > 0) {
1972 /* reset end_pts, hls->recording_time at end of the init hls list */
1973 int init_list_dur = hls->init_time * vs->nb_entries * AV_TIME_BASE;
1974 int after_init_list_dur = (vs->sequence - vs->nb_entries ) * hls->time * AV_TIME_BASE;
1975 hls->recording_time = hls->time * AV_TIME_BASE;
1976 end_pts = init_list_dur + after_init_list_dur ;
1979 if (vs->start_pts == AV_NOPTS_VALUE) {
1980 vs->start_pts = pkt->pts;
1983 if (vs->has_video) {
1984 can_split = st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO &&
1985 ((pkt->flags & AV_PKT_FLAG_KEY) || (hls->flags & HLS_SPLIT_BY_TIME));
1986 is_ref_pkt = st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO;
1988 if (pkt->pts == AV_NOPTS_VALUE)
1989 is_ref_pkt = can_split = 0;
1992 if (vs->end_pts == AV_NOPTS_VALUE)
1993 vs->end_pts = pkt->pts;
1994 if (vs->new_start) {
1996 vs->duration = (double)(pkt->pts - vs->end_pts)
1997 * st->time_base.num / st->time_base.den;
1998 vs->dpp = (double)(pkt->duration) * st->time_base.num / st->time_base.den;
2000 if (pkt->duration) {
2001 vs->duration += (double)(pkt->duration) * st->time_base.num / st->time_base.den;
2003 av_log(s, AV_LOG_WARNING, "pkt->duration = 0, maybe the hls segment duration will not precise\n");
2004 vs->duration = (double)(pkt->pts - vs->end_pts) * st->time_base.num / st->time_base.den;
2010 if (vs->packets_written && can_split && av_compare_ts(pkt->pts - vs->start_pts, st->time_base,
2011 end_pts, AV_TIME_BASE_Q) >= 0) {
2012 int64_t new_start_pos;
2013 char *old_filename = av_strdup(vs->avf->filename);
2014 int byterange_mode = (hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size > 0);
2016 if (!old_filename) {
2017 return AVERROR(ENOMEM);
2020 av_write_frame(vs->avf, NULL); /* Flush any buffered data */
2022 new_start_pos = avio_tell(vs->avf->pb);
2023 vs->size = new_start_pos - vs->start_pos;
2025 if (!byterange_mode) {
2026 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
2027 if (!vs->init_range_length) {
2029 range_length = avio_close_dyn_buf(oc->pb, &buffer);
2030 avio_write(vs->out, buffer, range_length);
2031 vs->init_range_length = range_length;
2032 avio_open_dyn_buf(&oc->pb);
2033 vs->packets_written = 0;
2034 ff_format_io_close(s, &vs->out);
2035 hlsenc_io_close(s, &vs->out, vs->base_output_dirname);
2038 hlsenc_io_close(s, &oc->pb, oc->filename);
2041 hlsenc_io_close(s, &vs->vtt_avf->pb, vs->vtt_avf->filename);
2044 if ((hls->flags & HLS_TEMP_FILE) && oc->filename[0]) {
2045 if (!(hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size <= 0))
2046 if ((vs->avf->oformat->priv_class && vs->avf->priv_data) && hls->segment_type != SEGMENT_TYPE_FMP4)
2047 av_opt_set(vs->avf->priv_data, "mpegts_flags", "resend_headers", 0);
2048 hls_rename_temp_file(s, oc);
2051 if (vs->fmp4_init_mode) {
2055 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
2056 ret = hlsenc_io_open(s, &vs->out, vs->avf->filename, NULL);
2058 av_log(NULL, AV_LOG_ERROR, "Failed to open file '%s'\n",
2060 av_free(old_filename);
2063 write_styp(vs->out);
2064 ret = flush_dynbuf(vs, &range_length);
2066 av_free(old_filename);
2069 ff_format_io_close(s, &vs->out);
2071 ret = hls_append_segment(s, hls, vs, vs->duration, vs->start_pos, vs->size);
2072 vs->start_pos = new_start_pos;
2074 av_free(old_filename);
2078 vs->end_pts = pkt->pts;
2081 vs->fmp4_init_mode = 0;
2082 if (hls->flags & HLS_SINGLE_FILE) {
2084 } else if (hls->max_seg_size > 0) {
2085 if (vs->start_pos >= hls->max_seg_size) {
2087 sls_flag_file_rename(hls, vs, old_filename);
2088 ret = hls_start(s, vs);
2090 /* When split segment by byte, the duration is short than hls_time,
2091 * so it is not enough one segment duration as hls_time, */
2096 sls_flag_file_rename(hls, vs, old_filename);
2097 ret = hls_start(s, vs);
2099 av_free(old_filename);
2105 if (!vs->fmp4_init_mode || byterange_mode)
2106 if ((ret = hls_window(s, 0, vs)) < 0) {
2111 vs->packets_written++;
2112 ret = ff_write_chained(oc, stream_index, pkt, s, 0);
2117 static int hls_write_trailer(struct AVFormatContext *s)
2119 HLSContext *hls = s->priv_data;
2120 AVFormatContext *oc = NULL;
2121 AVFormatContext *vtt_oc = NULL;
2122 char *old_filename = NULL;
2125 VariantStream *vs = NULL;
2127 for (i = 0; i < hls->nb_varstreams; i++) {
2128 vs = &hls->var_streams[i];
2131 vtt_oc = vs->vtt_avf;
2132 old_filename = av_strdup(vs->avf->filename);
2134 if (!old_filename) {
2135 return AVERROR(ENOMEM);
2137 if ( hls->segment_type == SEGMENT_TYPE_FMP4) {
2138 int range_length = 0;
2139 ret = hlsenc_io_open(s, &vs->out, vs->avf->filename, NULL);
2141 av_log(NULL, AV_LOG_ERROR, "Failed to open file '%s'\n", vs->avf->filename);
2144 write_styp(vs->out);
2145 ret = flush_dynbuf(vs, &range_length);
2149 ff_format_io_close(s, &vs->out);
2153 av_write_trailer(oc);
2155 vs->size = avio_tell(vs->avf->pb) - vs->start_pos;
2156 if (hls->segment_type != SEGMENT_TYPE_FMP4)
2157 ff_format_io_close(s, &oc->pb);
2159 if ((hls->flags & HLS_TEMP_FILE) && oc->filename[0]) {
2160 hls_rename_temp_file(s, oc);
2163 /* after av_write_trailer, then duration + 1 duration per packet */
2164 hls_append_segment(s, hls, vs, vs->duration + vs->dpp, vs->start_pos, vs->size);
2167 sls_flag_file_rename(hls, vs, old_filename);
2171 av_write_trailer(vtt_oc);
2172 vs->size = avio_tell(vs->vtt_avf->pb) - vs->start_pos;
2173 ff_format_io_close(s, &vtt_oc->pb);
2175 av_freep(&vs->basename);
2176 av_freep(&vs->base_output_dirname);
2177 avformat_free_context(oc);
2180 hls_window(s, 1, vs);
2182 av_freep(&vs->fmp4_init_filename);
2184 av_freep(&vs->vtt_basename);
2185 av_freep(&vs->vtt_m3u8_name);
2186 avformat_free_context(vtt_oc);
2189 hls_free_segments(vs->segments);
2190 hls_free_segments(vs->old_segments);
2191 av_free(old_filename);
2192 av_freep(&vs->m3u8_name);
2193 av_freep(&vs->streams);
2194 av_freep(&vs->agroup);
2195 av_freep(&vs->baseurl);
2198 ff_format_io_close(s, &hls->m3u8_out);
2199 ff_format_io_close(s, &hls->sub_m3u8_out);
2200 av_freep(&hls->key_basename);
2201 av_freep(&hls->var_streams);
2202 av_freep(&hls->master_m3u8_url);
2207 static int hls_init(AVFormatContext *s)
2212 HLSContext *hls = s->priv_data;
2213 const char *pattern = "%d.ts";
2214 VariantStream *vs = NULL;
2215 int basename_size = 0;
2216 const char *pattern_localtime_fmt = get_default_pattern_localtime_fmt(s);
2217 const char *vtt_pattern = "%d.vtt";
2219 int vtt_basename_size = 0;
2220 int fmp4_init_filename_len = strlen(hls->fmp4_init_filename) + 1;
2222 ret = update_variant_stream_info(s);
2224 av_log(s, AV_LOG_ERROR, "Variant stream info update failed with status %x\n",
2228 //TODO: Updates needed to encryption functionality with periodic re-key when more than one variant streams are present
2229 if (hls->nb_varstreams > 1 && hls->flags & HLS_PERIODIC_REKEY) {
2230 ret = AVERROR(EINVAL);
2231 av_log(s, AV_LOG_ERROR, "Periodic re-key not supported when more than one variant streams are present\n");
2235 ret = validate_name(hls->nb_varstreams, s->filename);
2239 if (hls->segment_filename) {
2240 ret = validate_name(hls->nb_varstreams, hls->segment_filename);
2245 if (av_strcasecmp(hls->fmp4_init_filename, "init.mp4")) {
2246 ret = validate_name(hls->nb_varstreams, hls->fmp4_init_filename);
2251 if (hls->subtitle_filename) {
2252 ret = validate_name(hls->nb_varstreams, hls->subtitle_filename);
2257 if (hls->master_pl_name) {
2258 ret = update_master_pl_info(s);
2260 av_log(s, AV_LOG_ERROR, "Master stream info update failed with status %x\n",
2266 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
2269 if ((hls->start_sequence_source_type == HLS_START_SEQUENCE_AS_SECONDS_SINCE_EPOCH) ||
2270 (hls->start_sequence_source_type == HLS_START_SEQUENCE_AS_FORMATTED_DATETIME)) {
2271 time_t t = time(NULL); // we will need it in either case
2272 if (hls->start_sequence_source_type == HLS_START_SEQUENCE_AS_SECONDS_SINCE_EPOCH) {
2273 hls->start_sequence = (int64_t)t;
2274 } else if (hls->start_sequence_source_type == HLS_START_SEQUENCE_AS_FORMATTED_DATETIME) {
2276 struct tm *p, tmbuf;
2277 if (!(p = localtime_r(&t, &tmbuf)))
2278 return AVERROR(ENOMEM);
2279 if (!strftime(b, sizeof(b), "%Y%m%d%H%M%S", p))
2280 return AVERROR(ENOMEM);
2281 hls->start_sequence = strtoll(b, NULL, 10);
2283 av_log(hls, AV_LOG_DEBUG, "start_number evaluated to %"PRId64"\n", hls->start_sequence);
2286 hls->recording_time = (hls->init_time ? hls->init_time : hls->time) * AV_TIME_BASE;
2287 for (i = 0; i < hls->nb_varstreams; i++) {
2288 vs = &hls->var_streams[i];
2290 vs->m3u8_name = av_strdup(s->filename);
2291 if (!vs->m3u8_name ) {
2292 ret = AVERROR(ENOMEM);
2295 ret = format_name(vs->m3u8_name, strlen(s->filename) + 1, i);
2299 vs->sequence = hls->start_sequence;
2300 vs->start_pts = AV_NOPTS_VALUE;
2301 vs->end_pts = AV_NOPTS_VALUE;
2302 vs->current_segment_final_filename_fmt[0] = '\0';
2304 if (hls->flags & HLS_SPLIT_BY_TIME && hls->flags & HLS_INDEPENDENT_SEGMENTS) {
2305 // Independent segments cannot be guaranteed when splitting by time
2306 hls->flags &= ~HLS_INDEPENDENT_SEGMENTS;
2307 av_log(s, AV_LOG_WARNING,
2308 "'split_by_time' and 'independent_segments' cannot be enabled together. "
2309 "Disabling 'independent_segments' flag\n");
2312 if (hls->flags & HLS_PROGRAM_DATE_TIME) {
2315 vs->initial_prog_date_time = now0;
2317 if (hls->format_options_str) {
2318 ret = av_dict_parse_string(&hls->format_options, hls->format_options_str, "=", ":", 0);
2320 av_log(s, AV_LOG_ERROR, "Could not parse format options list '%s'\n", hls->format_options_str);
2325 for (j = 0; j < vs->nb_streams; j++) {
2326 vs->has_video += vs->streams[j]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO;
2327 vs->has_subtitle += vs->streams[j]->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE;
2330 if (vs->has_video > 1)
2331 av_log(s, AV_LOG_WARNING, "More than a single video stream present, expect issues decoding it.\n");
2332 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
2333 vs->oformat = av_guess_format("mp4", NULL, NULL);
2335 vs->oformat = av_guess_format("mpegts", NULL, NULL);
2339 ret = AVERROR_MUXER_NOT_FOUND;
2343 if (vs->has_subtitle) {
2344 vs->vtt_oformat = av_guess_format("webvtt", NULL, NULL);
2346 ret = AVERROR_MUXER_NOT_FOUND;
2350 if (hls->segment_filename) {
2351 basename_size = strlen(hls->segment_filename) + 1;
2352 vs->basename = av_malloc(basename_size);
2353 if (!vs->basename) {
2354 ret = AVERROR(ENOMEM);
2358 av_strlcpy(vs->basename, hls->segment_filename, basename_size);
2359 ret = format_name(vs->basename, basename_size, i);
2363 if (hls->flags & HLS_SINGLE_FILE) {
2364 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
2371 if (hls->use_localtime) {
2372 basename_size = strlen(vs->m3u8_name) + strlen(pattern_localtime_fmt) + 1;
2374 basename_size = strlen(vs->m3u8_name) + strlen(pattern) + 1;
2377 vs->basename = av_malloc(basename_size);
2378 if (!vs->basename) {
2379 ret = AVERROR(ENOMEM);
2383 av_strlcpy(vs->basename, vs->m3u8_name, basename_size);
2385 p = strrchr(vs->basename, '.');
2388 if (hls->use_localtime) {
2389 av_strlcat(vs->basename, pattern_localtime_fmt, basename_size);
2391 av_strlcat(vs->basename, pattern, basename_size);
2395 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
2396 if (hls->nb_varstreams > 1)
2397 fmp4_init_filename_len += strlen(POSTFIX_PATTERN);
2398 vs->fmp4_init_filename = av_malloc(fmp4_init_filename_len);
2399 if (!vs->fmp4_init_filename ) {
2400 ret = AVERROR(ENOMEM);
2403 av_strlcpy(vs->fmp4_init_filename, hls->fmp4_init_filename,
2404 fmp4_init_filename_len);
2406 if (av_strcasecmp(hls->fmp4_init_filename, "init.mp4")) {
2407 ret = format_name(vs->fmp4_init_filename, fmp4_init_filename_len, i);
2411 fmp4_init_filename_len = strlen(vs->fmp4_init_filename) + 1;
2412 vs->base_output_dirname = av_malloc(fmp4_init_filename_len);
2413 if (!vs->base_output_dirname) {
2414 ret = AVERROR(ENOMEM);
2417 av_strlcpy(vs->base_output_dirname, vs->fmp4_init_filename,
2418 fmp4_init_filename_len);
2420 if (hls->nb_varstreams > 1) {
2421 ret = append_postfix(vs->fmp4_init_filename, fmp4_init_filename_len, i);
2426 fmp4_init_filename_len = strlen(vs->m3u8_name) +
2427 strlen(vs->fmp4_init_filename) + 1;
2429 vs->base_output_dirname = av_malloc(fmp4_init_filename_len);
2430 if (!vs->base_output_dirname) {
2431 ret = AVERROR(ENOMEM);
2435 av_strlcpy(vs->base_output_dirname, vs->m3u8_name,
2436 fmp4_init_filename_len);
2437 p = strrchr(vs->base_output_dirname, '/');
2440 av_strlcat(vs->base_output_dirname, vs->fmp4_init_filename,
2441 fmp4_init_filename_len);
2443 av_strlcpy(vs->base_output_dirname, vs->fmp4_init_filename,
2444 fmp4_init_filename_len);
2449 if (!hls->use_localtime) {
2450 ret = sls_flag_check_duration_size_index(hls);
2455 ret = sls_flag_check_duration_size(hls, vs);
2460 if (vs->has_subtitle) {
2462 if (hls->flags & HLS_SINGLE_FILE)
2463 vtt_pattern = ".vtt";
2464 vtt_basename_size = strlen(vs->m3u8_name) + strlen(vtt_pattern) + 1;
2466 vs->vtt_basename = av_malloc(vtt_basename_size);
2467 if (!vs->vtt_basename) {
2468 ret = AVERROR(ENOMEM);
2471 vs->vtt_m3u8_name = av_malloc(vtt_basename_size);
2472 if (!vs->vtt_m3u8_name ) {
2473 ret = AVERROR(ENOMEM);
2476 av_strlcpy(vs->vtt_basename, vs->m3u8_name, vtt_basename_size);
2477 p = strrchr(vs->vtt_basename, '.');
2481 if ( hls->subtitle_filename ) {
2482 strcpy(vs->vtt_m3u8_name, hls->subtitle_filename);
2483 ret = format_name(vs->vtt_m3u8_name, vtt_basename_size, i);
2487 strcpy(vs->vtt_m3u8_name, vs->vtt_basename);
2488 av_strlcat(vs->vtt_m3u8_name, "_vtt.m3u8", vtt_basename_size);
2490 av_strlcat(vs->vtt_basename, vtt_pattern, vtt_basename_size);
2494 vs->baseurl = av_strdup(hls->baseurl);
2496 ret = AVERROR(ENOMEM);
2501 if ((hls->flags & HLS_SINGLE_FILE) && (hls->segment_type == SEGMENT_TYPE_FMP4)) {
2502 vs->fmp4_init_filename = av_strdup(vs->basename);
2503 if (!vs->fmp4_init_filename) {
2504 ret = AVERROR(ENOMEM);
2508 if ((ret = hls_mux_init(s, vs)) < 0)
2511 if (hls->flags & HLS_APPEND_LIST) {
2512 parse_playlist(s, vs->m3u8_name, vs);
2513 vs->discontinuity = 1;
2514 if (hls->init_time > 0) {
2515 av_log(s, AV_LOG_WARNING, "append_list mode does not support hls_init_time,"
2516 " hls_init_time value will have no effect\n");
2518 hls->recording_time = hls->time * AV_TIME_BASE;
2522 if ((ret = hls_start(s, vs)) < 0)
2528 av_freep(&hls->key_basename);
2529 for (i = 0; i < hls->nb_varstreams && hls->var_streams; i++) {
2530 vs = &hls->var_streams[i];
2531 av_freep(&vs->basename);
2532 av_freep(&vs->vtt_basename);
2533 av_freep(&vs->fmp4_init_filename);
2534 av_freep(&vs->m3u8_name);
2535 av_freep(&vs->vtt_m3u8_name);
2536 av_freep(&vs->streams);
2537 av_freep(&vs->agroup);
2538 av_freep(&vs->baseurl);
2540 avformat_free_context(vs->avf);
2542 avformat_free_context(vs->vtt_avf);
2544 av_freep(&hls->var_streams);
2545 av_freep(&hls->master_m3u8_url);
2551 #define OFFSET(x) offsetof(HLSContext, x)
2552 #define E AV_OPT_FLAG_ENCODING_PARAM
2553 static const AVOption options[] = {
2554 {"start_number", "set first number in the sequence", OFFSET(start_sequence),AV_OPT_TYPE_INT64, {.i64 = 0}, 0, INT64_MAX, E},
2555 {"hls_time", "set segment length in seconds", OFFSET(time), AV_OPT_TYPE_FLOAT, {.dbl = 2}, 0, FLT_MAX, E},
2556 {"hls_init_time", "set segment length in seconds at init list", OFFSET(init_time), AV_OPT_TYPE_FLOAT, {.dbl = 0}, 0, FLT_MAX, E},
2557 {"hls_list_size", "set maximum number of playlist entries", OFFSET(max_nb_segments), AV_OPT_TYPE_INT, {.i64 = 5}, 0, INT_MAX, E},
2558 {"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},
2559 {"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},
2561 {"hls_wrap", "set number after which the index wraps (will be deprecated)", OFFSET(wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E},
2563 {"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},
2564 {"hls_base_url", "url to prepend to each playlist entry", OFFSET(baseurl), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
2565 {"hls_segment_filename", "filename template for segment files", OFFSET(segment_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
2566 {"hls_segment_size", "maximum size per segment file, (in bytes)", OFFSET(max_seg_size), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E},
2567 {"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},
2568 {"hls_enc", "enable AES128 encryption support", OFFSET(encrypt), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E},
2569 {"hls_enc_key", "hex-coded 16 byte key to encrypt the segments", OFFSET(key), AV_OPT_TYPE_STRING, .flags = E},
2570 {"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},
2571 {"hls_enc_iv", "hex-coded 16 byte initialization vector", OFFSET(iv), AV_OPT_TYPE_STRING, .flags = E},
2572 {"hls_subtitle_path", "set path of hls subtitles", OFFSET(subtitle_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
2573 {"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"},
2574 {"mpegts", "make segment file to mpegts files in m3u8", 0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_TYPE_MPEGTS }, 0, UINT_MAX, E, "segment_type"},
2575 {"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"},
2576 {"hls_fmp4_init_filename", "set fragment mp4 file init filename", OFFSET(fmp4_init_filename), AV_OPT_TYPE_STRING, {.str = "init.mp4"}, 0, 0, E},
2577 {"hls_flags", "set flags affecting HLS playlist and media file generation", OFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0 }, 0, UINT_MAX, E, "flags"},
2578 {"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"},
2579 {"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"},
2580 {"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"},
2581 {"round_durations", "round durations in m3u8 to whole numbers", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_ROUND_DURATIONS }, 0, UINT_MAX, E, "flags"},
2582 {"discont_start", "start the playlist with a discontinuity tag", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_DISCONT_START }, 0, UINT_MAX, E, "flags"},
2583 {"omit_endlist", "Do not append an endlist when ending stream", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_OMIT_ENDLIST }, 0, UINT_MAX, E, "flags"},
2584 {"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"},
2585 {"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"},
2586 {"program_date_time", "add EXT-X-PROGRAM-DATE-TIME", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_PROGRAM_DATE_TIME }, 0, UINT_MAX, E, "flags"},
2587 {"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"},
2588 {"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"},
2589 {"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"},
2590 {"periodic_rekey", "reload keyinfo file periodically for re-keying", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_PERIODIC_REKEY }, 0, UINT_MAX, E, "flags"},
2591 {"independent_segments", "add EXT-X-INDEPENDENT-SEGMENTS, whenever applicable", 0, AV_OPT_TYPE_CONST, { .i64 = HLS_INDEPENDENT_SEGMENTS }, 0, UINT_MAX, E, "flags"},
2592 {"use_localtime", "set filename expansion with strftime at segment creation", OFFSET(use_localtime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
2593 {"use_localtime_mkdir", "create last directory component in strftime-generated filename", OFFSET(use_localtime_mkdir), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
2594 {"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" },
2595 {"event", "EVENT playlist", 0, AV_OPT_TYPE_CONST, {.i64 = PLAYLIST_TYPE_EVENT }, INT_MIN, INT_MAX, E, "pl_type" },
2596 {"vod", "VOD playlist", 0, AV_OPT_TYPE_CONST, {.i64 = PLAYLIST_TYPE_VOD }, INT_MIN, INT_MAX, E, "pl_type" },
2597 {"method", "set the HTTP method(default: PUT)", OFFSET(method), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
2598 {"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" },
2599 {"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" },
2600 {"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" },
2601 {"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" },
2602 {"http_user_agent", "override User-Agent field in HTTP header", OFFSET(user_agent), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
2603 {"var_stream_map", "Variant stream map string", OFFSET(var_stream_map), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
2604 {"master_pl_name", "Create HLS master playlist with this name", OFFSET(master_pl_name), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
2605 {"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},
2606 {"http_persistent", "Use persistent HTTP connections", OFFSET(http_persistent), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
2610 static const AVClass hls_class = {
2611 .class_name = "hls muxer",
2612 .item_name = av_default_item_name,
2614 .version = LIBAVUTIL_VERSION_INT,
2618 AVOutputFormat ff_hls_muxer = {
2620 .long_name = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
2621 .extensions = "m3u8",
2622 .priv_data_size = sizeof(HLSContext),
2623 .audio_codec = AV_CODEC_ID_AAC,
2624 .video_codec = AV_CODEC_ID_H264,
2625 .subtitle_codec = AV_CODEC_ID_WEBVTT,
2626 .flags = AVFMT_NOFILE | AVFMT_GLOBALHEADER | AVFMT_ALLOW_FLUSH,
2628 .write_header = hls_write_header,
2629 .write_packet = hls_write_packet,
2630 .write_trailer = hls_write_trailer,
2631 .priv_class = &hls_class,