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.h"
45 #include "libavutil/time_internal.h"
48 #include "avio_internal.h"
50 #if CONFIG_HTTP_PROTOCOL
53 #include "hlsplaylist.h"
55 #include "os_support.h"
58 HLS_START_SEQUENCE_AS_START_NUMBER = 0,
59 HLS_START_SEQUENCE_AS_SECONDS_SINCE_EPOCH = 1,
60 HLS_START_SEQUENCE_AS_FORMATTED_DATETIME = 2, // YYYYMMDDhhmmss
61 HLS_START_SEQUENCE_AS_MICROSECONDS_SINCE_EPOCH = 3,
62 HLS_START_SEQUENCE_LAST, // unused
63 } StartSequenceSourceType;
66 CODEC_ATTRIBUTE_WRITTEN = 0,
67 CODEC_ATTRIBUTE_WILL_NOT_BE_WRITTEN,
68 } CodecAttributeStatus;
71 #define LINE_BUFFER_SIZE MAX_URL_SIZE
72 #define HLS_MICROSECOND_UNIT 1000000
73 #define BUFSIZE (16 * 1024)
74 #define POSTFIX_PATTERN "_%d"
76 typedef struct HLSSegment {
77 char filename[MAX_URL_SIZE];
78 char sub_filename[MAX_URL_SIZE];
79 double duration; /* in seconds */
84 int64_t keyframe_size;
85 unsigned var_stream_idx;
87 char key_uri[LINE_BUFFER_SIZE + 1];
88 char iv_string[KEYSIZE*2 + 1];
90 struct HLSSegment *next;
93 typedef enum HLSFlags {
94 // Generate a single media file and use byte ranges in the playlist.
95 HLS_SINGLE_FILE = (1 << 0),
96 HLS_DELETE_SEGMENTS = (1 << 1),
97 HLS_ROUND_DURATIONS = (1 << 2),
98 HLS_DISCONT_START = (1 << 3),
99 HLS_OMIT_ENDLIST = (1 << 4),
100 HLS_SPLIT_BY_TIME = (1 << 5),
101 HLS_APPEND_LIST = (1 << 6),
102 HLS_PROGRAM_DATE_TIME = (1 << 7),
103 HLS_SECOND_LEVEL_SEGMENT_INDEX = (1 << 8), // include segment index in segment filenames when use_localtime e.g.: %%03d
104 HLS_SECOND_LEVEL_SEGMENT_DURATION = (1 << 9), // include segment duration (microsec) in segment filenames when use_localtime e.g.: %%09t
105 HLS_SECOND_LEVEL_SEGMENT_SIZE = (1 << 10), // include segment size (bytes) in segment filenames when use_localtime e.g.: %%014s
106 HLS_TEMP_FILE = (1 << 11),
107 HLS_PERIODIC_REKEY = (1 << 12),
108 HLS_INDEPENDENT_SEGMENTS = (1 << 13),
109 HLS_I_FRAMES_ONLY = (1 << 14),
117 typedef struct VariantStream {
118 unsigned var_stream_idx;
121 ff_const59 AVOutputFormat *oformat;
122 ff_const59 AVOutputFormat *vtt_oformat;
124 AVIOContext *out_single_file;
126 int init_range_length;
127 uint8_t *temp_buffer;
128 uint8_t *init_buffer;
130 AVFormatContext *avf;
131 AVFormatContext *vtt_avf;
136 int start_pts_from_audio;
137 double dpp; // duration per packet
140 int64_t video_lastpos;
141 int64_t video_keyframe_pos;
142 int64_t video_keyframe_size;
143 double duration; // last segment duration computed so far, in seconds
144 int64_t start_pos; // last segment starting position
145 int64_t size; // last segment size
147 int discontinuity_set;
149 int reference_stream_index;
151 HLSSegment *segments;
152 HLSSegment *last_segment;
153 HLSSegment *old_segments;
161 double initial_prog_date_time;
162 char current_segment_final_filename_fmt[MAX_URL_SIZE]; // when renaming segments
164 char *fmp4_init_filename;
165 char *base_output_dirname;
169 char key_file[LINE_BUFFER_SIZE + 1];
170 char key_uri[LINE_BUFFER_SIZE + 1];
171 char key_string[KEYSIZE*2 + 1];
172 char iv_string[KEYSIZE*2 + 1];
175 char codec_attr[128];
176 CodecAttributeStatus attr_status;
177 unsigned int nb_streams;
178 int m3u8_created; /* status of media play-list creation */
179 int is_default; /* default status of audio group */
180 const char *language; /* audio lauguage name */
181 const char *agroup; /* audio group name */
182 const char *sgroup; /* subtitle group name */
183 const char *ccgroup; /* closed caption group name */
184 const char *varname; /* variant name */
187 typedef struct ClosedCaptionsStream {
188 const char *ccgroup; /* closed caption group name */
189 const char *instreamid; /* closed captions INSTREAM-ID */
190 const char *language; /* closed captions langauge */
191 } ClosedCaptionsStream;
193 typedef struct HLSContext {
194 const AVClass *class; // Class for private options.
195 int64_t start_sequence;
196 uint32_t start_sequence_source_type; // enum StartSequenceSourceType
198 float time; // Set by a private option.
199 float init_time; // Set by a private option.
200 int max_nb_segments; // Set by a private option.
201 int hls_delete_threshold; // Set by a private option.
203 int wrap; // Set by a private option.
205 uint32_t flags; // enum HLSFlags
206 uint32_t pl_type; // enum PlaylistType
207 char *segment_filename;
208 char *fmp4_init_filename;
210 int resend_init_file; ///< resend init file into disk after refresh m3u8
212 int use_localtime; ///< flag to expand filename with localtime
213 int use_localtime_mkdir;///< flag to mkdir dirname in timebased filename
215 int64_t recording_time;
216 int64_t max_seg_size; // every segment file max size
219 char *vtt_format_options_str;
220 char *subtitle_filename;
221 AVDictionary *format_options;
231 char key_file[LINE_BUFFER_SIZE + 1];
232 char key_uri[LINE_BUFFER_SIZE + 1];
233 char key_string[KEYSIZE*2 + 1];
234 char iv_string[KEYSIZE*2 + 1];
235 AVDictionary *vtt_format_options;
240 VariantStream *var_streams;
241 unsigned int nb_varstreams;
242 ClosedCaptionsStream *cc_streams;
243 unsigned int nb_ccstreams;
245 int master_m3u8_created; /* status of master play-list creation */
246 char *master_m3u8_url; /* URL of the master m3u8 file */
247 int version; /* HLS version */
248 char *var_stream_map; /* user specified variant stream map string */
249 char *cc_stream_map; /* user specified closed caption streams map string */
250 char *master_pl_name;
251 unsigned int master_publish_rate;
253 AVIOContext *m3u8_out;
254 AVIOContext *sub_m3u8_out;
256 int ignore_io_errors;
258 int has_default_key; /* has DEFAULT field of var_stream_map */
259 int has_video_m3u8; /* has video stream m3u8 list */
262 static int hlsenc_io_open(AVFormatContext *s, AVIOContext **pb, char *filename,
263 AVDictionary **options)
265 HLSContext *hls = s->priv_data;
266 int http_base_proto = filename ? ff_is_http_proto(filename) : 0;
267 int err = AVERROR_MUXER_NOT_FOUND;
268 if (!*pb || !http_base_proto || !hls->http_persistent) {
269 err = s->io_open(s, pb, filename, AVIO_FLAG_WRITE, options);
270 #if CONFIG_HTTP_PROTOCOL
272 URLContext *http_url_context = ffio_geturlcontext(*pb);
273 av_assert0(http_url_context);
274 err = ff_http_do_new_request(http_url_context, filename);
276 ff_format_io_close(s, pb);
283 static int hlsenc_io_close(AVFormatContext *s, AVIOContext **pb, char *filename)
285 HLSContext *hls = s->priv_data;
286 int http_base_proto = filename ? ff_is_http_proto(filename) : 0;
290 if (!http_base_proto || !hls->http_persistent || hls->key_info_file || hls->encrypt) {
291 ff_format_io_close(s, pb);
292 #if CONFIG_HTTP_PROTOCOL
294 URLContext *http_url_context = ffio_geturlcontext(*pb);
295 av_assert0(http_url_context);
297 ffurl_shutdown(http_url_context, AVIO_FLAG_WRITE);
298 ret = ff_http_get_shutdown_status(http_url_context);
304 static void set_http_options(AVFormatContext *s, AVDictionary **options, HLSContext *c)
306 int http_base_proto = ff_is_http_proto(s->url);
309 av_dict_set(options, "method", c->method, 0);
310 } else if (http_base_proto) {
311 av_dict_set(options, "method", "PUT", 0);
314 av_dict_set(options, "user_agent", c->user_agent, 0);
315 if (c->http_persistent)
316 av_dict_set_int(options, "multiple_requests", 1, 0);
318 av_dict_set_int(options, "timeout", c->timeout, 0);
320 av_dict_set(options, "headers", c->headers, 0);
323 static void write_codec_attr(AVStream *st, VariantStream *vs)
325 int codec_strlen = strlen(vs->codec_attr);
328 if (st->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE)
330 if (vs->attr_status == CODEC_ATTRIBUTE_WILL_NOT_BE_WRITTEN)
333 if (st->codecpar->codec_id == AV_CODEC_ID_H264) {
334 uint8_t *data = st->codecpar->extradata;
335 if (data && (data[0] | data[1] | data[2]) == 0 && data[3] == 1 && (data[4] & 0x1F) == 7) {
336 snprintf(attr, sizeof(attr),
337 "avc1.%02x%02x%02x", data[5], data[6], data[7]);
341 } else if (st->codecpar->codec_id == AV_CODEC_ID_HEVC) {
342 uint8_t *data = st->codecpar->extradata;
343 int profile = FF_PROFILE_UNKNOWN;
344 int level = FF_LEVEL_UNKNOWN;
346 if (st->codecpar->profile != FF_PROFILE_UNKNOWN)
347 profile = st->codecpar->profile;
348 if (st->codecpar->level != FF_LEVEL_UNKNOWN)
349 level = st->codecpar->level;
351 /* check the boundary of data which from current position is small than extradata_size */
352 while (data && (data - st->codecpar->extradata + 19) < st->codecpar->extradata_size) {
353 /* get HEVC SPS NAL and seek to profile_tier_level */
354 if (!(data[0] | data[1] | data[2]) && data[3] == 1 && ((data[4] & 0x7E) == 0x42)) {
358 /* skip start code + nalu header */
360 /* process by reference General NAL unit syntax */
361 remain_size = st->codecpar->extradata_size - (data - st->codecpar->extradata);
362 rbsp_buf = ff_nal_unit_extract_rbsp(data, remain_size, &rbsp_size, 0);
365 if (rbsp_size < 13) {
369 /* skip sps_video_parameter_set_id u(4),
370 * sps_max_sub_layers_minus1 u(3),
371 * and sps_temporal_id_nesting_flag u(1) */
372 profile = rbsp_buf[1] & 0x1f;
373 /* skip 8 + 8 + 32 + 4 + 43 + 1 bit */
374 level = rbsp_buf[12];
380 if (st->codecpar->codec_tag == MKTAG('h','v','c','1') &&
381 profile != FF_PROFILE_UNKNOWN &&
382 level != FF_LEVEL_UNKNOWN) {
383 snprintf(attr, sizeof(attr), "%s.%d.4.L%d.B01", av_fourcc2str(st->codecpar->codec_tag), profile, level);
386 } else if (st->codecpar->codec_id == AV_CODEC_ID_MP2) {
387 snprintf(attr, sizeof(attr), "mp4a.40.33");
388 } else if (st->codecpar->codec_id == AV_CODEC_ID_MP3) {
389 snprintf(attr, sizeof(attr), "mp4a.40.34");
390 } else if (st->codecpar->codec_id == AV_CODEC_ID_AAC) {
391 /* TODO : For HE-AAC, HE-AACv2, the last digit needs to be set to 5 and 29 respectively */
392 snprintf(attr, sizeof(attr), "mp4a.40.2");
393 } else if (st->codecpar->codec_id == AV_CODEC_ID_AC3) {
394 snprintf(attr, sizeof(attr), "ac-3");
395 } else if (st->codecpar->codec_id == AV_CODEC_ID_EAC3) {
396 snprintf(attr, sizeof(attr), "ec-3");
400 // Don't write the same attribute multiple times
401 if (!av_stristr(vs->codec_attr, attr)) {
402 snprintf(vs->codec_attr + codec_strlen,
403 sizeof(vs->codec_attr) - codec_strlen,
404 "%s%s", codec_strlen ? "," : "", attr);
409 vs->codec_attr[0] = '\0';
410 vs->attr_status = CODEC_ATTRIBUTE_WILL_NOT_BE_WRITTEN;
414 static int replace_str_data_in_filename(char **s, const char *filename, char placeholder, const char *datastring)
423 av_bprint_init(&buf, 0, AV_BPRINT_SIZE_UNLIMITED);
430 if (c == '%' && *(p+1) == '%') // %%
432 else if (c == '%' && *(p+1) == placeholder) {
433 av_bprintf(&buf, "%s", datastring);
440 if (addchar_count > 0) {
441 av_bprint_append_data(&buf, p, addchar_count);
445 if (!av_bprint_is_complete(&buf)) {
446 av_bprint_finalize(&buf, NULL);
447 return AVERROR(ENOMEM);
449 if ((ret = av_bprint_finalize(&buf, s)) < 0)
454 static int replace_int_data_in_filename(char **s, const char *filename, char placeholder, int64_t number)
458 int nd, addchar_count;
463 av_bprint_init(&buf, 0, AV_BPRINT_SIZE_UNLIMITED);
470 if (c == '%' && *(p+1) == '%') // %%
472 else if (c == '%' && (av_isdigit(*(p+1)) || *(p+1) == placeholder)) {
475 while (av_isdigit(*(p + addchar_count))) {
476 nd = nd * 10 + *(p + addchar_count) - '0';
480 if (*(p + addchar_count) == placeholder) {
481 av_bprintf(&buf, "%0*"PRId64, (number < 0) ? nd : nd++, number);
482 p += (addchar_count + 1);
490 av_bprint_append_data(&buf, p, addchar_count);
493 if (!av_bprint_is_complete(&buf)) {
494 av_bprint_finalize(&buf, NULL);
495 return AVERROR(ENOMEM);
497 if ((ret = av_bprint_finalize(&buf, s)) < 0)
502 static void write_styp(AVIOContext *pb)
505 ffio_wfourcc(pb, "styp");
506 ffio_wfourcc(pb, "msdh");
507 avio_wb32(pb, 0); /* minor */
508 ffio_wfourcc(pb, "msdh");
509 ffio_wfourcc(pb, "msix");
512 static int flush_dynbuf(VariantStream *vs, int *range_length)
514 AVFormatContext *ctx = vs->avf;
517 return AVERROR(EINVAL);
521 av_write_frame(ctx, NULL);
524 *range_length = avio_close_dyn_buf(ctx->pb, &vs->temp_buffer);
526 avio_write(vs->out, vs->temp_buffer, *range_length);
530 return avio_open_dyn_buf(&ctx->pb);
533 static void reflush_dynbuf(VariantStream *vs, int *range_length)
536 avio_write(vs->out, vs->temp_buffer, *range_length);
540 #define SEPARATOR '\\'
542 #define SEPARATOR '/'
545 static int hls_delete_file(HLSContext *hls, AVFormatContext *avf,
546 const char *path, const char *proto)
548 if (hls->method || (proto && !av_strcasecmp(proto, "http"))) {
549 AVDictionary *opt = NULL;
550 AVIOContext *out = NULL;
552 av_dict_set(&opt, "method", "DELETE", 0);
553 ret = avf->io_open(avf, &out, path, AVIO_FLAG_WRITE, &opt);
556 return hls->ignore_io_errors ? 1 : ret;
557 ff_format_io_close(avf, &out);
558 } else if (unlink(path) < 0) {
559 av_log(hls, AV_LOG_ERROR, "failed to delete old segment %s: %s\n",
560 path, strerror(errno));
565 static int hls_delete_old_segments(AVFormatContext *s, HLSContext *hls,
569 HLSSegment *segment, *previous_segment = NULL;
570 float playlist_duration = 0.0f;
574 const char *dirname = NULL;
575 char *dirname_r = NULL;
576 char *dirname_repl = NULL;
577 const char *vtt_dirname = NULL;
578 char *vtt_dirname_r = NULL;
579 const char *proto = NULL;
581 av_bprint_init(&path, 0, AV_BPRINT_SIZE_UNLIMITED);
583 segment = vs->segments;
585 playlist_duration += segment->duration;
586 segment = segment->next;
589 segment = vs->old_segments;
592 playlist_duration -= segment->duration;
593 previous_segment = segment;
594 segment = previous_segment->next;
596 if (playlist_duration <= -previous_segment->duration) {
597 previous_segment->next = NULL;
600 if (segment_cnt >= hls->hls_delete_threshold) {
601 previous_segment->next = NULL;
606 if (segment && !hls->use_localtime_mkdir) {
607 dirname_r = hls->segment_filename ? av_strdup(hls->segment_filename): av_strdup(vs->avf->url);
608 dirname = av_dirname(dirname_r);
611 /* if %v is present in the file's directory
612 * all segment belongs to the same variant, so do it only once before the loop*/
613 if (dirname && av_stristr(dirname, "%v")) {
615 if (replace_int_data_in_filename(&dirname_repl, dirname, 'v', segment->var_stream_idx) < 1) {
616 ret = AVERROR(EINVAL);
620 if (replace_str_data_in_filename(&dirname_repl, dirname, 'v', vs->varname) < 1) {
621 ret = AVERROR(EINVAL);
626 dirname = dirname_repl;
630 av_log(hls, AV_LOG_DEBUG, "deleting old segment %s\n",
632 if (!hls->use_localtime_mkdir) // segment->filename contains basename only
633 av_bprintf(&path, "%s%c", dirname, SEPARATOR);
634 av_bprintf(&path, "%s", segment->filename);
636 if (!av_bprint_is_complete(&path)) {
637 ret = AVERROR(ENOMEM);
641 proto = avio_find_protocol_name(s->url);
642 if (ret = hls_delete_file(hls, vs->avf, path.str, proto))
645 if ((segment->sub_filename[0] != '\0')) {
646 vtt_dirname_r = av_strdup(vs->vtt_avf->url);
647 vtt_dirname = av_dirname(vtt_dirname_r);
649 av_bprint_clear(&path);
650 av_bprintf(&path, "%s%c%s", vtt_dirname, SEPARATOR,
651 segment->sub_filename);
652 av_freep(&vtt_dirname_r);
654 if (!av_bprint_is_complete(&path)) {
655 ret = AVERROR(ENOMEM);
659 if (ret = hls_delete_file(hls, vs->vtt_avf, path.str, proto))
662 av_bprint_clear(&path);
663 previous_segment = segment;
664 segment = previous_segment->next;
665 av_freep(&previous_segment);
669 av_bprint_finalize(&path, NULL);
670 av_freep(&dirname_r);
671 av_freep(&dirname_repl);
676 static int randomize(uint8_t *buf, int len)
679 gcry_randomize(buf, len, GCRY_VERY_STRONG_RANDOM);
682 if (RAND_bytes(buf, len))
685 return AVERROR(ENOSYS);
687 return AVERROR(EINVAL);
690 static int do_encrypt(AVFormatContext *s, VariantStream *vs)
692 HLSContext *hls = s->priv_data;
696 uint8_t key[KEYSIZE];
697 char * key_basename_source = (hls->master_m3u8_url) ? hls->master_m3u8_url : s->url;
699 len = strlen(key_basename_source) + 4 + 1;
700 hls->key_basename = av_mallocz(len);
701 if (!hls->key_basename)
702 return AVERROR(ENOMEM);
704 av_strlcpy(hls->key_basename, key_basename_source, len);
705 av_strlcat(hls->key_basename, ".key", len);
708 av_strlcpy(hls->key_file, hls->key_url, sizeof(hls->key_file));
709 av_strlcpy(hls->key_uri, hls->key_url, sizeof(hls->key_uri));
711 av_strlcpy(hls->key_file, hls->key_basename, sizeof(hls->key_file));
712 av_strlcpy(hls->key_uri, hls->key_basename, sizeof(hls->key_uri));
715 if (!*hls->iv_string) {
716 uint8_t iv[16] = { 0 };
720 AV_WB64(iv + 8, vs->sequence);
722 memcpy(iv, hls->iv, sizeof(iv));
724 ff_data_to_hex(buf, iv, sizeof(iv), 0);
726 memcpy(hls->iv_string, buf, sizeof(hls->iv_string));
729 if (!*hls->key_uri) {
730 av_log(hls, AV_LOG_ERROR, "no key URI specified in key info file\n");
731 return AVERROR(EINVAL);
734 if (!*hls->key_file) {
735 av_log(hls, AV_LOG_ERROR, "no key file specified in key info file\n");
736 return AVERROR(EINVAL);
739 if (!*hls->key_string) {
740 AVDictionary *options = NULL;
742 if ((ret = randomize(key, sizeof(key))) < 0) {
743 av_log(s, AV_LOG_ERROR, "Cannot generate a strong random key\n");
747 memcpy(key, hls->key, sizeof(key));
750 ff_data_to_hex(hls->key_string, key, sizeof(key), 0);
751 set_http_options(s, &options, hls);
752 ret = s->io_open(s, &pb, hls->key_file, AVIO_FLAG_WRITE, &options);
753 av_dict_free(&options);
756 avio_seek(pb, 0, SEEK_CUR);
757 avio_write(pb, key, KEYSIZE);
764 static int hls_encryption_start(AVFormatContext *s, VariantStream *vs)
766 HLSContext *hls = s->priv_data;
769 uint8_t key[KEYSIZE];
770 AVDictionary *options = NULL;
772 set_http_options(s, &options, hls);
773 ret = s->io_open(s, &pb, hls->key_info_file, AVIO_FLAG_READ, &options);
774 av_dict_free(&options);
776 av_log(hls, AV_LOG_ERROR,
777 "error opening key info file %s\n", hls->key_info_file);
781 ff_get_line(pb, vs->key_uri, sizeof(vs->key_uri));
782 vs->key_uri[strcspn(vs->key_uri, "\r\n")] = '\0';
784 ff_get_line(pb, vs->key_file, sizeof(vs->key_file));
785 vs->key_file[strcspn(vs->key_file, "\r\n")] = '\0';
787 ff_get_line(pb, vs->iv_string, sizeof(vs->iv_string));
788 vs->iv_string[strcspn(vs->iv_string, "\r\n")] = '\0';
790 ff_format_io_close(s, &pb);
793 av_log(hls, AV_LOG_ERROR, "no key URI specified in key info file\n");
794 return AVERROR(EINVAL);
797 if (!*vs->key_file) {
798 av_log(hls, AV_LOG_ERROR, "no key file specified in key info file\n");
799 return AVERROR(EINVAL);
802 set_http_options(s, &options, hls);
803 ret = s->io_open(s, &pb, vs->key_file, AVIO_FLAG_READ, &options);
804 av_dict_free(&options);
806 av_log(hls, AV_LOG_ERROR, "error opening key file %s\n", vs->key_file);
810 ret = avio_read(pb, key, sizeof(key));
811 ff_format_io_close(s, &pb);
812 if (ret != sizeof(key)) {
813 av_log(hls, AV_LOG_ERROR, "error reading key file %s\n", vs->key_file);
814 if (ret >= 0 || ret == AVERROR_EOF)
815 ret = AVERROR(EINVAL);
818 ff_data_to_hex(vs->key_string, key, sizeof(key), 0);
823 static int hls_mux_init(AVFormatContext *s, VariantStream *vs)
825 AVDictionary *options = NULL;
826 HLSContext *hls = s->priv_data;
828 AVFormatContext *vtt_oc = NULL;
829 int byterange_mode = (hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size > 0);
830 int remaining_options;
833 ret = avformat_alloc_output_context2(&vs->avf, vs->oformat, NULL, NULL);
838 oc->url = av_strdup("");
840 return AVERROR(ENOMEM);
842 oc->interrupt_callback = s->interrupt_callback;
843 oc->max_delay = s->max_delay;
844 oc->opaque = s->opaque;
845 oc->io_open = s->io_open;
846 oc->io_close = s->io_close;
847 oc->strict_std_compliance = s->strict_std_compliance;
848 av_dict_copy(&oc->metadata, s->metadata, 0);
850 if (vs->vtt_oformat) {
851 ret = avformat_alloc_output_context2(&vs->vtt_avf, vs->vtt_oformat, NULL, NULL);
854 vtt_oc = vs->vtt_avf;
855 av_dict_copy(&vtt_oc->metadata, s->metadata, 0);
858 for (i = 0; i < vs->nb_streams; i++) {
860 AVFormatContext *loc;
861 if (vs->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE)
866 if (!(st = avformat_new_stream(loc, NULL)))
867 return AVERROR(ENOMEM);
868 avcodec_parameters_copy(st->codecpar, vs->streams[i]->codecpar);
869 if (!oc->oformat->codec_tag ||
870 av_codec_get_id (oc->oformat->codec_tag, vs->streams[i]->codecpar->codec_tag) == st->codecpar->codec_id ||
871 av_codec_get_tag(oc->oformat->codec_tag, vs->streams[i]->codecpar->codec_id) <= 0) {
872 st->codecpar->codec_tag = vs->streams[i]->codecpar->codec_tag;
874 st->codecpar->codec_tag = 0;
877 st->sample_aspect_ratio = vs->streams[i]->sample_aspect_ratio;
878 st->time_base = vs->streams[i]->time_base;
879 av_dict_copy(&st->metadata, vs->streams[i]->metadata, 0);
885 if (hls->segment_type == SEGMENT_TYPE_FMP4 && hls->max_seg_size > 0) {
886 if (hls->http_persistent > 0) {
887 //TODO: Support fragment fmp4 for http persistent in HLS muxer.
888 av_log(s, AV_LOG_WARNING, "http persistent mode is currently unsupported for fragment mp4 in the HLS muxer.\n");
890 if (hls->max_seg_size > 0) {
891 av_log(s, AV_LOG_WARNING, "Multi-file byterange mode is currently unsupported in the HLS muxer.\n");
892 return AVERROR_PATCHWELCOME;
896 if ((ret = avio_open_dyn_buf(&oc->pb)) < 0)
899 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
900 set_http_options(s, &options, hls);
901 if (byterange_mode) {
902 ret = hlsenc_io_open(s, &vs->out, vs->basename, &options);
904 ret = hlsenc_io_open(s, &vs->out, vs->base_output_dirname, &options);
906 av_dict_free(&options);
909 av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", vs->fmp4_init_filename);
913 av_dict_copy(&options, hls->format_options, 0);
914 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
915 av_dict_set(&options, "fflags", "-autobsf", 0);
916 av_dict_set(&options, "movflags", "+frag_custom+dash+delay_moov", AV_DICT_APPEND);
918 /* We only require one PAT/PMT per segment. */
920 snprintf(period, sizeof(period), "%d", (INT_MAX / 2) - 1);
921 av_dict_set(&options, "sdt_period", period, AV_DICT_DONT_OVERWRITE);
922 av_dict_set(&options, "pat_period", period, AV_DICT_DONT_OVERWRITE);
924 ret = avformat_init_output(oc, &options);
925 remaining_options = av_dict_count(options);
926 av_dict_free(&options);
929 if (remaining_options) {
930 av_log(s, AV_LOG_ERROR, "Some of the provided format options are not recognized\n");
931 return AVERROR(EINVAL);
937 static HLSSegment *find_segment_by_filename(HLSSegment *segment, const char *filename)
940 if (!av_strcasecmp(segment->filename,filename))
942 segment = segment->next;
944 return (HLSSegment *) NULL;
947 static int sls_flags_filename_process(struct AVFormatContext *s, HLSContext *hls,
948 VariantStream *vs, HLSSegment *en,
949 double duration, int64_t pos, int64_t size)
951 if ((hls->flags & (HLS_SECOND_LEVEL_SEGMENT_SIZE | HLS_SECOND_LEVEL_SEGMENT_DURATION)) &&
952 strlen(vs->current_segment_final_filename_fmt)) {
953 char * new_url = av_strdup(vs->current_segment_final_filename_fmt);
955 return AVERROR(ENOMEM);
957 ff_format_set_url(vs->avf, new_url);
958 if (hls->flags & HLS_SECOND_LEVEL_SEGMENT_SIZE) {
959 char *filename = NULL;
960 if (replace_int_data_in_filename(&filename, vs->avf->url, 's', pos + size) < 1) {
961 av_log(hls, AV_LOG_ERROR,
962 "Invalid second level segment filename template '%s', "
963 "you can try to remove second_level_segment_size flag\n",
966 return AVERROR(EINVAL);
968 ff_format_set_url(vs->avf, filename);
970 if (hls->flags & HLS_SECOND_LEVEL_SEGMENT_DURATION) {
971 char *filename = NULL;
972 if (replace_int_data_in_filename(&filename, vs->avf->url,
973 't', (int64_t)round(duration * HLS_MICROSECOND_UNIT)) < 1) {
974 av_log(hls, AV_LOG_ERROR,
975 "Invalid second level segment filename template '%s', "
976 "you can try to remove second_level_segment_time flag\n",
979 return AVERROR(EINVAL);
981 ff_format_set_url(vs->avf, filename);
987 static int sls_flag_check_duration_size_index(HLSContext *hls)
991 if (hls->flags & HLS_SECOND_LEVEL_SEGMENT_DURATION) {
992 av_log(hls, AV_LOG_ERROR,
993 "second_level_segment_duration hls_flag requires strftime to be true\n");
994 ret = AVERROR(EINVAL);
996 if (hls->flags & HLS_SECOND_LEVEL_SEGMENT_SIZE) {
997 av_log(hls, AV_LOG_ERROR,
998 "second_level_segment_size hls_flag requires strfime to be true\n");
999 ret = AVERROR(EINVAL);
1001 if (hls->flags & HLS_SECOND_LEVEL_SEGMENT_INDEX) {
1002 av_log(hls, AV_LOG_ERROR,
1003 "second_level_segment_index hls_flag requires strftime to be true\n");
1004 ret = AVERROR(EINVAL);
1010 static int sls_flag_check_duration_size(HLSContext *hls, VariantStream *vs)
1012 const char *proto = avio_find_protocol_name(vs->basename);
1013 int segment_renaming_ok = proto && !strcmp(proto, "file");
1016 if ((hls->flags & HLS_SECOND_LEVEL_SEGMENT_DURATION) && !segment_renaming_ok) {
1017 av_log(hls, AV_LOG_ERROR,
1018 "second_level_segment_duration hls_flag works only with file protocol segment names\n");
1019 ret = AVERROR(EINVAL);
1021 if ((hls->flags & HLS_SECOND_LEVEL_SEGMENT_SIZE) && !segment_renaming_ok) {
1022 av_log(hls, AV_LOG_ERROR,
1023 "second_level_segment_size hls_flag works only with file protocol segment names\n");
1024 ret = AVERROR(EINVAL);
1030 static void sls_flag_file_rename(HLSContext *hls, VariantStream *vs, char *old_filename) {
1031 if ((hls->flags & (HLS_SECOND_LEVEL_SEGMENT_SIZE | HLS_SECOND_LEVEL_SEGMENT_DURATION)) &&
1032 strlen(vs->current_segment_final_filename_fmt)) {
1033 ff_rename(old_filename, vs->avf->url, hls);
1037 static int sls_flag_use_localtime_filename(AVFormatContext *oc, HLSContext *c, VariantStream *vs)
1039 if (c->flags & HLS_SECOND_LEVEL_SEGMENT_INDEX) {
1040 char *filename = NULL;
1041 if (replace_int_data_in_filename(&filename,
1043 oc->url, 'd', c->wrap ? vs->sequence % c->wrap : vs->sequence) < 1) {
1045 oc->url, 'd', vs->sequence) < 1) {
1047 av_log(c, AV_LOG_ERROR, "Invalid second level segment filename template '%s', "
1048 "you can try to remove second_level_segment_index flag\n",
1050 av_freep(&filename);
1051 return AVERROR(EINVAL);
1053 ff_format_set_url(oc, filename);
1055 if (c->flags & (HLS_SECOND_LEVEL_SEGMENT_SIZE | HLS_SECOND_LEVEL_SEGMENT_DURATION)) {
1056 av_strlcpy(vs->current_segment_final_filename_fmt, oc->url,
1057 sizeof(vs->current_segment_final_filename_fmt));
1058 if (c->flags & HLS_SECOND_LEVEL_SEGMENT_SIZE) {
1059 char *filename = NULL;
1060 if (replace_int_data_in_filename(&filename, oc->url, 's', 0) < 1) {
1061 av_log(c, AV_LOG_ERROR, "Invalid second level segment filename template '%s', "
1062 "you can try to remove second_level_segment_size flag\n",
1064 av_freep(&filename);
1065 return AVERROR(EINVAL);
1067 ff_format_set_url(oc, filename);
1069 if (c->flags & HLS_SECOND_LEVEL_SEGMENT_DURATION) {
1070 char *filename = NULL;
1071 if (replace_int_data_in_filename(&filename, oc->url, 't', 0) < 1) {
1072 av_log(c, AV_LOG_ERROR, "Invalid second level segment filename template '%s', "
1073 "you can try to remove second_level_segment_time flag\n",
1075 av_freep(&filename);
1076 return AVERROR(EINVAL);
1078 ff_format_set_url(oc, filename);
1084 /* Create a new segment and append it to the segment list */
1085 static int hls_append_segment(struct AVFormatContext *s, HLSContext *hls,
1086 VariantStream *vs, double duration, int64_t pos,
1089 HLSSegment *en = av_malloc(sizeof(*en));
1090 const char *filename;
1091 int byterange_mode = (hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size > 0);
1095 return AVERROR(ENOMEM);
1097 en->var_stream_idx = vs->var_stream_idx;
1098 ret = sls_flags_filename_process(s, hls, vs, en, duration, pos, size);
1104 filename = av_basename(vs->avf->url);
1106 if (hls->use_localtime_mkdir) {
1107 filename = vs->avf->url;
1109 if ((find_segment_by_filename(vs->segments, filename) || find_segment_by_filename(vs->old_segments, filename))
1110 && !byterange_mode) {
1111 av_log(hls, AV_LOG_WARNING, "Duplicated segment filename detected: %s\n", filename);
1113 av_strlcpy(en->filename, filename, sizeof(en->filename));
1115 if (vs->has_subtitle)
1116 av_strlcpy(en->sub_filename, av_basename(vs->vtt_avf->url), sizeof(en->sub_filename));
1118 en->sub_filename[0] = '\0';
1120 en->duration = duration;
1123 en->keyframe_pos = vs->video_keyframe_pos;
1124 en->keyframe_size = vs->video_keyframe_size;
1128 if (vs->discontinuity) {
1130 vs->discontinuity = 0;
1133 if (hls->key_info_file || hls->encrypt) {
1134 av_strlcpy(en->key_uri, vs->key_uri, sizeof(en->key_uri));
1135 av_strlcpy(en->iv_string, vs->iv_string, sizeof(en->iv_string));
1141 vs->last_segment->next = en;
1143 vs->last_segment = en;
1145 // EVENT or VOD playlists imply sliding window cannot be used
1146 if (hls->pl_type != PLAYLIST_TYPE_NONE)
1147 hls->max_nb_segments = 0;
1149 if (hls->max_nb_segments && vs->nb_entries >= hls->max_nb_segments) {
1151 vs->initial_prog_date_time += en->duration;
1152 vs->segments = en->next;
1153 if (en && hls->flags & HLS_DELETE_SEGMENTS &&
1155 !(hls->flags & HLS_SINGLE_FILE || hls->wrap)) {
1157 !(hls->flags & HLS_SINGLE_FILE)) {
1159 en->next = vs->old_segments;
1160 vs->old_segments = en;
1161 if ((ret = hls_delete_old_segments(s, hls, vs)) < 0)
1168 if (hls->max_seg_size > 0) {
1176 static int parse_playlist(AVFormatContext *s, const char *url, VariantStream *vs)
1178 HLSContext *hls = s->priv_data;
1180 int ret = 0, is_segment = 0;
1181 int64_t new_start_pos;
1182 char line[MAX_URL_SIZE];
1186 if ((ret = ffio_open_whitelist(&in, url, AVIO_FLAG_READ,
1187 &s->interrupt_callback, NULL,
1188 s->protocol_whitelist, s->protocol_blacklist)) < 0)
1191 ff_get_chomp_line(in, line, sizeof(line));
1192 if (strcmp(line, "#EXTM3U")) {
1193 ret = AVERROR_INVALIDDATA;
1197 vs->discontinuity = 0;
1198 while (!avio_feof(in)) {
1199 ff_get_chomp_line(in, line, sizeof(line));
1200 if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
1201 int64_t tmp_sequence = strtoll(ptr, NULL, 10);
1202 if (tmp_sequence < vs->sequence)
1203 av_log(hls, AV_LOG_VERBOSE,
1204 "Found playlist sequence number was smaller """
1205 "than specified start sequence number: %"PRId64" < %"PRId64", "
1206 "omitting\n", tmp_sequence, hls->start_sequence);
1208 av_log(hls, AV_LOG_DEBUG, "Found playlist sequence number: %"PRId64"\n", tmp_sequence);
1209 vs->sequence = tmp_sequence;
1211 } else if (av_strstart(line, "#EXT-X-DISCONTINUITY", &ptr)) {
1213 vs->discontinuity = 1;
1214 } else if (av_strstart(line, "#EXTINF:", &ptr)) {
1216 vs->duration = atof(ptr);
1217 } else if (av_stristart(line, "#EXT-X-KEY:", &ptr)) {
1218 ptr = av_stristr(line, "URI=\"");
1220 ptr += strlen("URI=\"");
1221 end = av_stristr(ptr, ",");
1223 av_strlcpy(vs->key_uri, ptr, end - ptr);
1225 av_strlcpy(vs->key_uri, ptr, sizeof(vs->key_uri));
1229 ptr = av_stristr(line, "IV=0x");
1231 ptr += strlen("IV=0x");
1232 end = av_stristr(ptr, ",");
1234 av_strlcpy(vs->iv_string, ptr, end - ptr);
1236 av_strlcpy(vs->iv_string, ptr, sizeof(vs->iv_string));
1240 } else if (av_strstart(line, "#", NULL)) {
1242 } else if (line[0]) {
1244 char *new_file = av_strdup(line);
1246 ret = AVERROR(ENOMEM);
1249 ff_format_set_url(vs->avf, new_file);
1251 new_start_pos = avio_tell(vs->avf->pb);
1252 vs->size = new_start_pos - vs->start_pos;
1253 vs->initial_prog_date_time -= vs->duration; // this is a previously existing segment
1254 ret = hls_append_segment(s, hls, vs, vs->duration, vs->start_pos, vs->size);
1257 vs->start_pos = new_start_pos;
1267 static void hls_free_segments(HLSSegment *p)
1278 static int hls_rename_temp_file(AVFormatContext *s, AVFormatContext *oc)
1280 size_t len = strlen(oc->url);
1281 char *final_filename = av_strdup(oc->url);
1284 if (!final_filename)
1285 return AVERROR(ENOMEM);
1286 final_filename[len-4] = '\0';
1287 ret = ff_rename(oc->url, final_filename, s);
1288 oc->url[len-4] = '\0';
1289 av_freep(&final_filename);
1293 static const char* get_relative_url(const char *master_url, const char *media_url)
1295 const char *p = strrchr(master_url, '/');
1296 size_t base_len = 0;
1298 if (!p) p = strrchr(master_url, '\\');
1301 base_len = p - master_url;
1302 if (av_strncasecmp(master_url, media_url, base_len)) {
1303 av_log(NULL, AV_LOG_WARNING, "Unable to find relative url\n");
1310 return media_url + base_len + 1;
1313 static int64_t get_stream_bit_rate(AVStream *stream)
1315 AVCPBProperties *props = (AVCPBProperties*)av_stream_get_side_data(
1317 AV_PKT_DATA_CPB_PROPERTIES,
1321 if (stream->codecpar->bit_rate)
1322 return stream->codecpar->bit_rate;
1324 return props->max_bitrate;
1329 static int create_master_playlist(AVFormatContext *s,
1330 VariantStream * const input_vs)
1332 HLSContext *hls = s->priv_data;
1333 VariantStream *vs, *temp_vs;
1334 AVStream *vid_st, *aud_st;
1335 AVDictionary *options = NULL;
1338 const char *m3u8_rel_name = NULL;
1339 const char *vtt_m3u8_rel_name = NULL;
1340 const char *ccgroup;
1341 const char *sgroup = NULL;
1342 ClosedCaptionsStream *ccs;
1343 const char *proto = avio_find_protocol_name(hls->master_m3u8_url);
1344 int is_file_proto = proto && !strcmp(proto, "file");
1345 int use_temp_file = is_file_proto && ((hls->flags & HLS_TEMP_FILE) || hls->master_publish_rate);
1346 char temp_filename[MAX_URL_SIZE];
1348 input_vs->m3u8_created = 1;
1349 if (!hls->master_m3u8_created) {
1350 /* For the first time, wait until all the media playlists are created */
1351 for (i = 0; i < hls->nb_varstreams; i++)
1352 if (!hls->var_streams[i].m3u8_created)
1355 /* Keep publishing the master playlist at the configured rate */
1356 if (&hls->var_streams[0] != input_vs || !hls->master_publish_rate ||
1357 input_vs->number % hls->master_publish_rate)
1361 set_http_options(s, &options, hls);
1362 snprintf(temp_filename, sizeof(temp_filename), use_temp_file ? "%s.tmp" : "%s", hls->master_m3u8_url);
1363 ret = hlsenc_io_open(s, &hls->m3u8_out, temp_filename, &options);
1364 av_dict_free(&options);
1366 av_log(s, AV_LOG_ERROR, "Failed to open master play list file '%s'\n",
1371 ff_hls_write_playlist_version(hls->m3u8_out, hls->version);
1373 for (i = 0; i < hls->nb_ccstreams; i++) {
1374 ccs = &(hls->cc_streams[i]);
1375 avio_printf(hls->m3u8_out, "#EXT-X-MEDIA:TYPE=CLOSED-CAPTIONS");
1376 avio_printf(hls->m3u8_out, ",GROUP-ID=\"%s\"", ccs->ccgroup);
1377 avio_printf(hls->m3u8_out, ",NAME=\"%s\"", ccs->instreamid);
1379 avio_printf(hls->m3u8_out, ",LANGUAGE=\"%s\"", ccs->language);
1380 avio_printf(hls->m3u8_out, ",INSTREAM-ID=\"%s\"\n", ccs->instreamid);
1383 /* For audio only variant streams add #EXT-X-MEDIA tag with attributes*/
1384 for (i = 0; i < hls->nb_varstreams; i++) {
1385 vs = &(hls->var_streams[i]);
1387 if (vs->has_video || vs->has_subtitle || !vs->agroup)
1390 m3u8_rel_name = get_relative_url(hls->master_m3u8_url, vs->m3u8_name);
1391 if (!m3u8_rel_name) {
1392 av_log(s, AV_LOG_ERROR, "Unable to find relative URL\n");
1396 ff_hls_write_audio_rendition(hls->m3u8_out, vs->agroup, m3u8_rel_name, vs->language, i, hls->has_default_key ? vs->is_default : 1);
1399 /* For variant streams with video add #EXT-X-STREAM-INF tag with attributes*/
1400 for (i = 0; i < hls->nb_varstreams; i++) {
1401 vs = &(hls->var_streams[i]);
1403 m3u8_rel_name = get_relative_url(hls->master_m3u8_url, vs->m3u8_name);
1404 if (!m3u8_rel_name) {
1405 av_log(s, AV_LOG_ERROR, "Unable to find relative URL\n");
1411 for (j = 0; j < vs->nb_streams; j++) {
1412 if (vs->streams[j]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO)
1413 vid_st = vs->streams[j];
1414 else if (vs->streams[j]->codecpar->codec_type == AVMEDIA_TYPE_AUDIO)
1415 aud_st = vs->streams[j];
1418 if (!vid_st && !aud_st) {
1419 av_log(s, AV_LOG_WARNING, "Media stream not found\n");
1424 * Traverse through the list of audio only rendition streams and find
1425 * the rendition which has highest bitrate in the same audio group
1428 for (j = 0; j < hls->nb_varstreams; j++) {
1429 temp_vs = &(hls->var_streams[j]);
1430 if (!temp_vs->has_video && !temp_vs->has_subtitle &&
1432 !av_strcasecmp(temp_vs->agroup, vs->agroup)) {
1434 aud_st = temp_vs->streams[0];
1435 if (temp_vs->streams[0]->codecpar->bit_rate >
1436 aud_st->codecpar->bit_rate)
1437 aud_st = temp_vs->streams[0];
1444 bandwidth += get_stream_bit_rate(vid_st);
1446 bandwidth += get_stream_bit_rate(aud_st);
1447 bandwidth += bandwidth / 10;
1450 if (vid_st && vs->ccgroup) {
1451 /* check if this group name is available in the cc map string */
1452 for (j = 0; j < hls->nb_ccstreams; j++) {
1453 ccs = &(hls->cc_streams[j]);
1454 if (!av_strcasecmp(ccs->ccgroup, vs->ccgroup)) {
1455 ccgroup = vs->ccgroup;
1459 if (j == hls->nb_ccstreams)
1460 av_log(s, AV_LOG_WARNING, "mapping ccgroup %s not found\n",
1464 if (vid_st && vs->sgroup) {
1465 sgroup = vs->sgroup;
1466 vtt_m3u8_rel_name = get_relative_url(hls->master_m3u8_url, vs->vtt_m3u8_name);
1467 if (!vtt_m3u8_rel_name) {
1468 av_log(s, AV_LOG_WARNING, "Unable to find relative subtitle URL\n");
1472 ff_hls_write_subtitle_rendition(hls->m3u8_out, sgroup, vtt_m3u8_rel_name, vs->language, i, hls->has_default_key ? vs->is_default : 1);
1475 if (!hls->has_default_key || !hls->has_video_m3u8) {
1476 ff_hls_write_stream_info(vid_st, hls->m3u8_out, bandwidth, m3u8_rel_name,
1477 aud_st ? vs->agroup : NULL, vs->codec_attr, ccgroup, sgroup);
1480 ff_hls_write_stream_info(vid_st, hls->m3u8_out, bandwidth, m3u8_rel_name,
1481 aud_st ? vs->agroup : NULL, vs->codec_attr, ccgroup, sgroup);
1487 hls->master_m3u8_created = 1;
1488 hlsenc_io_close(s, &hls->m3u8_out, temp_filename);
1490 ff_rename(temp_filename, hls->master_m3u8_url, s);
1495 static int hls_window(AVFormatContext *s, int last, VariantStream *vs)
1497 HLSContext *hls = s->priv_data;
1499 int target_duration = 0;
1501 char temp_filename[MAX_URL_SIZE];
1502 char temp_vtt_filename[MAX_URL_SIZE];
1503 int64_t sequence = FFMAX(hls->start_sequence, vs->sequence - vs->nb_entries);
1504 const char *proto = avio_find_protocol_name(vs->m3u8_name);
1505 int is_file_proto = proto && !strcmp(proto, "file");
1506 int use_temp_file = is_file_proto && ((hls->flags & HLS_TEMP_FILE) || !(hls->pl_type == PLAYLIST_TYPE_VOD));
1507 static unsigned warned_non_file;
1508 char *key_uri = NULL;
1509 char *iv_string = NULL;
1510 AVDictionary *options = NULL;
1511 double prog_date_time = vs->initial_prog_date_time;
1512 double *prog_date_time_p = (hls->flags & HLS_PROGRAM_DATE_TIME) ? &prog_date_time : NULL;
1513 int byterange_mode = (hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size > 0);
1516 if (byterange_mode) {
1521 if (hls->flags & HLS_INDEPENDENT_SEGMENTS) {
1525 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
1529 if (!is_file_proto && (hls->flags & HLS_TEMP_FILE) && !warned_non_file++)
1530 av_log(s, AV_LOG_ERROR, "Cannot use rename on non file protocol, this may lead to races and temporary partial files\n");
1532 set_http_options(s, &options, hls);
1533 snprintf(temp_filename, sizeof(temp_filename), use_temp_file ? "%s.tmp" : "%s", vs->m3u8_name);
1534 if ((ret = hlsenc_io_open(s, byterange_mode ? &hls->m3u8_out : &vs->out, temp_filename, &options)) < 0) {
1535 if (hls->ignore_io_errors)
1540 for (en = vs->segments; en; en = en->next) {
1541 if (target_duration <= en->duration)
1542 target_duration = lrint(en->duration);
1545 vs->discontinuity_set = 0;
1546 ff_hls_write_playlist_header(byterange_mode ? hls->m3u8_out : vs->out, hls->version, hls->allowcache,
1547 target_duration, sequence, hls->pl_type, hls->flags & HLS_I_FRAMES_ONLY);
1549 if ((hls->flags & HLS_DISCONT_START) && sequence==hls->start_sequence && vs->discontinuity_set==0) {
1550 avio_printf(byterange_mode ? hls->m3u8_out : vs->out, "#EXT-X-DISCONTINUITY\n");
1551 vs->discontinuity_set = 1;
1553 if (vs->has_video && (hls->flags & HLS_INDEPENDENT_SEGMENTS)) {
1554 avio_printf(byterange_mode ? hls->m3u8_out : vs->out, "#EXT-X-INDEPENDENT-SEGMENTS\n");
1556 for (en = vs->segments; en; en = en->next) {
1557 if ((hls->encrypt || hls->key_info_file) && (!key_uri || strcmp(en->key_uri, key_uri) ||
1558 av_strcasecmp(en->iv_string, iv_string))) {
1559 avio_printf(byterange_mode ? hls->m3u8_out : vs->out, "#EXT-X-KEY:METHOD=AES-128,URI=\"%s\"", en->key_uri);
1561 avio_printf(byterange_mode ? hls->m3u8_out : vs->out, ",IV=0x%s", en->iv_string);
1562 avio_printf(byterange_mode ? hls->m3u8_out : vs->out, "\n");
1563 key_uri = en->key_uri;
1564 iv_string = en->iv_string;
1567 if ((hls->segment_type == SEGMENT_TYPE_FMP4) && (en == vs->segments)) {
1568 ff_hls_write_init_file(byterange_mode ? hls->m3u8_out : vs->out, (hls->flags & HLS_SINGLE_FILE) ? en->filename : vs->fmp4_init_filename,
1569 hls->flags & HLS_SINGLE_FILE, vs->init_range_length, 0);
1572 ret = ff_hls_write_file_entry(byterange_mode ? hls->m3u8_out : vs->out, en->discont, byterange_mode,
1573 en->duration, hls->flags & HLS_ROUND_DURATIONS,
1574 en->size, en->pos, hls->baseurl,
1575 en->filename, prog_date_time_p, en->keyframe_size, en->keyframe_pos, hls->flags & HLS_I_FRAMES_ONLY);
1577 av_log(s, AV_LOG_WARNING, "ff_hls_write_file_entry get error\n");
1581 if (last && (hls->flags & HLS_OMIT_ENDLIST)==0)
1582 ff_hls_write_end_list(byterange_mode ? hls->m3u8_out : vs->out);
1584 if (vs->vtt_m3u8_name) {
1585 snprintf(temp_vtt_filename, sizeof(temp_vtt_filename), use_temp_file ? "%s.tmp" : "%s", vs->vtt_m3u8_name);
1586 if ((ret = hlsenc_io_open(s, &hls->sub_m3u8_out, temp_vtt_filename, &options)) < 0) {
1587 if (hls->ignore_io_errors)
1591 ff_hls_write_playlist_header(hls->sub_m3u8_out, hls->version, hls->allowcache,
1592 target_duration, sequence, PLAYLIST_TYPE_NONE, 0);
1593 for (en = vs->segments; en; en = en->next) {
1594 ret = ff_hls_write_file_entry(hls->sub_m3u8_out, 0, byterange_mode,
1595 en->duration, 0, en->size, en->pos,
1596 hls->baseurl, en->sub_filename, NULL, 0, 0, 0);
1598 av_log(s, AV_LOG_WARNING, "ff_hls_write_file_entry get error\n");
1603 ff_hls_write_end_list(hls->sub_m3u8_out);
1608 av_dict_free(&options);
1609 ret = hlsenc_io_close(s, byterange_mode ? &hls->m3u8_out : &vs->out, temp_filename);
1613 hlsenc_io_close(s, &hls->sub_m3u8_out, vs->vtt_m3u8_name);
1614 if (use_temp_file) {
1615 ff_rename(temp_filename, vs->m3u8_name, s);
1616 if (vs->vtt_m3u8_name)
1617 ff_rename(temp_vtt_filename, vs->vtt_m3u8_name, s);
1619 if (ret >= 0 && hls->master_pl_name)
1620 if (create_master_playlist(s, vs) < 0)
1621 av_log(s, AV_LOG_WARNING, "Master playlist creation failed\n");
1626 static int hls_start(AVFormatContext *s, VariantStream *vs)
1628 HLSContext *c = s->priv_data;
1629 AVFormatContext *oc = vs->avf;
1630 AVFormatContext *vtt_oc = vs->vtt_avf;
1631 AVDictionary *options = NULL;
1632 const char *proto = NULL;
1633 int use_temp_file = 0;
1634 char iv_string[KEYSIZE*2 + 1];
1637 if (c->flags & HLS_SINGLE_FILE) {
1638 char *new_name = av_strdup(vs->basename);
1640 return AVERROR(ENOMEM);
1641 ff_format_set_url(oc, new_name);
1642 if (vs->vtt_basename) {
1643 new_name = av_strdup(vs->vtt_basename);
1645 return AVERROR(ENOMEM);
1646 ff_format_set_url(vtt_oc, new_name);
1648 } else if (c->max_seg_size > 0) {
1649 char *filename = NULL;
1650 if (replace_int_data_in_filename(&filename,
1652 vs->basename, 'd', c->wrap ? vs->sequence % c->wrap : vs->sequence) < 1) {
1654 vs->basename, 'd', vs->sequence) < 1) {
1656 av_freep(&filename);
1657 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s', you can try to use -strftime 1 with it\n", vs->basename);
1658 return AVERROR(EINVAL);
1660 ff_format_set_url(oc, filename);
1662 if (c->use_localtime) {
1664 struct tm *tm, tmpbuf;
1665 int bufsize = strlen(vs->basename) + MAX_URL_SIZE;
1666 char *buf = av_mallocz(bufsize);
1668 return AVERROR(ENOMEM);
1670 tm = localtime_r(&now0, &tmpbuf);
1671 ff_format_set_url(oc, buf);
1672 if (!strftime(oc->url, bufsize, vs->basename, tm)) {
1673 av_log(oc, AV_LOG_ERROR, "Could not get segment filename with strftime\n");
1674 return AVERROR(EINVAL);
1677 err = sls_flag_use_localtime_filename(oc, c, vs);
1679 return AVERROR(ENOMEM);
1682 if (c->use_localtime_mkdir) {
1684 char *fn_copy = av_strdup(oc->url);
1686 return AVERROR(ENOMEM);
1687 dir = av_dirname(fn_copy);
1688 if (ff_mkdir_p(dir) == -1 && errno != EEXIST) {
1689 av_log(oc, AV_LOG_ERROR, "Could not create directory %s with use_localtime_mkdir\n", dir);
1691 return AVERROR(errno);
1696 char *filename = NULL;
1697 if (replace_int_data_in_filename(&filename,
1699 vs->basename, 'd', c->wrap ? vs->sequence % c->wrap : vs->sequence) < 1) {
1701 vs->basename, 'd', vs->sequence) < 1) {
1703 av_freep(&filename);
1704 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s' you can try to use -strftime 1 with it\n", vs->basename);
1705 return AVERROR(EINVAL);
1707 ff_format_set_url(oc, filename);
1709 if (vs->vtt_basename) {
1710 char *filename = NULL;
1711 if (replace_int_data_in_filename(&filename,
1713 vs->vtt_basename, 'd', c->wrap ? vs->sequence % c->wrap : vs->sequence) < 1) {
1715 vs->vtt_basename, 'd', vs->sequence) < 1) {
1717 av_freep(&filename);
1718 av_log(vtt_oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", vs->vtt_basename);
1719 return AVERROR(EINVAL);
1721 ff_format_set_url(vtt_oc, filename);
1725 proto = avio_find_protocol_name(oc->url);
1726 use_temp_file = proto && !strcmp(proto, "file") && (c->flags & HLS_TEMP_FILE);
1728 if (use_temp_file) {
1729 char *new_name = av_asprintf("%s.tmp", oc->url);
1731 return AVERROR(ENOMEM);
1732 ff_format_set_url(oc, new_name);
1735 if (c->key_info_file || c->encrypt) {
1736 if (c->segment_type == SEGMENT_TYPE_FMP4) {
1737 av_log(s, AV_LOG_ERROR, "Encrypted fmp4 not yet supported\n");
1738 return AVERROR_PATCHWELCOME;
1741 if (c->key_info_file && c->encrypt) {
1742 av_log(s, AV_LOG_WARNING, "Cannot use both -hls_key_info_file and -hls_enc,"
1743 " ignoring -hls_enc\n");
1746 if (!vs->encrypt_started || (c->flags & HLS_PERIODIC_REKEY)) {
1747 if (c->key_info_file) {
1748 if ((err = hls_encryption_start(s, vs)) < 0)
1751 if (!c->encrypt_started) {
1752 if ((err = do_encrypt(s, vs)) < 0)
1754 c->encrypt_started = 1;
1756 av_strlcpy(vs->key_uri, c->key_uri, sizeof(vs->key_uri));
1757 av_strlcpy(vs->key_string, c->key_string, sizeof(vs->key_string));
1758 av_strlcpy(vs->iv_string, c->iv_string, sizeof(vs->iv_string));
1760 vs->encrypt_started = 1;
1762 err = av_strlcpy(iv_string, vs->iv_string, sizeof(iv_string));
1764 snprintf(iv_string, sizeof(iv_string), "%032"PRIx64, vs->sequence);
1765 memset(vs->iv_string, 0, sizeof(vs->iv_string));
1766 memcpy(vs->iv_string, iv_string, sizeof(iv_string));
1769 if (c->segment_type != SEGMENT_TYPE_FMP4) {
1770 if (oc->oformat->priv_class && oc->priv_data) {
1771 av_opt_set(oc->priv_data, "mpegts_flags", "resend_headers", 0);
1773 if (c->flags & HLS_SINGLE_FILE) {
1774 if (c->key_info_file || c->encrypt) {
1775 av_dict_set(&options, "encryption_key", vs->key_string, 0);
1776 av_dict_set(&options, "encryption_iv", vs->iv_string, 0);
1778 /* Write temp file with cryption content */
1779 av_freep(&vs->basename_tmp);
1780 vs->basename_tmp = av_asprintf("crypto:%s.tmp", oc->url);
1782 /* append temp file content into single file */
1783 av_freep(&vs->basename);
1784 vs->basename = av_asprintf("%s", oc->url);
1786 vs->basename_tmp = vs->basename;
1788 set_http_options(s, &options, c);
1789 if (!vs->out_single_file)
1790 if ((err = hlsenc_io_open(s, &vs->out_single_file, vs->basename, &options)) < 0) {
1791 if (c->ignore_io_errors)
1796 if ((err = hlsenc_io_open(s, &vs->out, vs->basename_tmp, &options)) < 0) {
1797 if (c->ignore_io_errors)
1804 if (vs->vtt_basename) {
1805 set_http_options(s, &options, c);
1806 if ((err = hlsenc_io_open(s, &vtt_oc->pb, vtt_oc->url, &options)) < 0) {
1807 if (c->ignore_io_errors)
1812 av_dict_free(&options);
1814 if (vs->vtt_basename) {
1815 err = avformat_write_header(vtt_oc,NULL);
1822 av_dict_free(&options);
1827 static const char * get_default_pattern_localtime_fmt(AVFormatContext *s)
1830 time_t t = time(NULL);
1831 struct tm *p, tmbuf;
1832 HLSContext *hls = s->priv_data;
1834 p = localtime_r(&t, &tmbuf);
1835 // no %s support when strftime returned error or left format string unchanged
1836 // also no %s support on MSVC, which invokes the invalid parameter handler on unsupported format strings, instead of returning an error
1837 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
1838 return (HAVE_LIBC_MSVCRT || !strftime(b, sizeof(b), "%s", p) || !strcmp(b, "%s")) ? "-%Y%m%d%H%M%S.m4s" : "-%s.m4s";
1840 return (HAVE_LIBC_MSVCRT || !strftime(b, sizeof(b), "%s", p) || !strcmp(b, "%s")) ? "-%Y%m%d%H%M%S.ts" : "-%s.ts";
1843 static int append_postfix(char *name, int name_buf_len, int i)
1846 char extension[10] = {'\0'};
1848 p = strrchr(name, '.');
1850 av_strlcpy(extension, p, sizeof(extension));
1854 snprintf(name + strlen(name), name_buf_len - strlen(name), POSTFIX_PATTERN, i);
1856 if (strlen(extension))
1857 av_strlcat(name, extension, name_buf_len);
1862 static int validate_name(int nb_vs, const char *fn)
1864 const char *filename, *subdir_name;
1865 char *fn_dup = NULL;
1869 return AVERROR(EINVAL);
1871 fn_dup = av_strdup(fn);
1873 return AVERROR(ENOMEM);
1874 filename = av_basename(fn);
1875 subdir_name = av_dirname(fn_dup);
1877 if (nb_vs > 1 && !av_stristr(filename, "%v") && !av_stristr(subdir_name, "%v")) {
1878 av_log(NULL, AV_LOG_ERROR, "More than 1 variant streams are present, %%v is expected "
1879 "either in the filename or in the sub-directory name of file %s\n", fn);
1880 ret = AVERROR(EINVAL);
1884 if (av_stristr(filename, "%v") && av_stristr(subdir_name, "%v")) {
1885 av_log(NULL, AV_LOG_ERROR, "%%v is expected either in the filename or "
1886 "in the sub-directory name of file %s, but only in one of them\n", fn);
1887 ret = AVERROR(EINVAL);
1896 static int format_name(const char *buf, char **s, int index, const char *varname)
1898 const char *proto, *dir;
1899 char *orig_buf_dup = NULL, *mod_buf_dup = NULL;
1902 orig_buf_dup = av_strdup(buf);
1904 return AVERROR(ENOMEM);
1906 if (!av_stristr(buf, "%v")) {
1912 if (replace_int_data_in_filename(s, orig_buf_dup, 'v', index) < 1) {
1913 ret = AVERROR(EINVAL);
1917 if (replace_str_data_in_filename(s, orig_buf_dup, 'v', varname) < 1) {
1918 ret = AVERROR(EINVAL);
1923 proto = avio_find_protocol_name(orig_buf_dup);
1924 dir = av_dirname(orig_buf_dup);
1926 /* if %v is present in the file's directory, create sub-directory */
1927 if (av_stristr(dir, "%v") && proto && !strcmp(proto, "file")) {
1928 mod_buf_dup = av_strdup(*s);
1929 dir = av_dirname(mod_buf_dup);
1930 if (ff_mkdir_p(dir) == -1 && errno != EEXIST) {
1931 ret = AVERROR(errno);
1937 av_freep(&orig_buf_dup);
1938 av_freep(&mod_buf_dup);
1942 static int get_nth_codec_stream_index(AVFormatContext *s,
1943 enum AVMediaType codec_type,
1946 unsigned int stream_index, cnt;
1947 if (stream_id < 0 || stream_id > s->nb_streams - 1)
1950 for (stream_index = 0; stream_index < s->nb_streams; stream_index++) {
1951 if (s->streams[stream_index]->codecpar->codec_type != codec_type)
1953 if (cnt == stream_id)
1954 return stream_index;
1960 static int parse_variant_stream_mapstring(AVFormatContext *s)
1962 HLSContext *hls = s->priv_data;
1964 int stream_index, i, j;
1965 enum AVMediaType codec_type;
1966 int nb_varstreams = 0, nb_streams;
1967 char *p, *q, *saveptr1, *saveptr2, *varstr, *keyval;
1971 * Expected format for var_stream_map string is as below:
1973 * "a:0,agroup:a0,default:1,language:ENG a:1,agroup:a1,default:0 v:0,agroup:a0 v:1,agroup:a1"
1974 * This string specifies how to group the audio, video and subtitle streams
1975 * into different variant streams. The variant stream groups are separated
1978 * a:, v:, s: are keys to specify audio, video and subtitle streams
1979 * respectively. Allowed values are 0 to 9 digits (limited just based on
1982 * agroup: is key to specify audio group. A string can be given as value.
1983 * sgroup: is key to specify subtitle group. A string can be given as value.
1985 p = av_strdup(hls->var_stream_map);
1987 return AVERROR(ENOMEM);
1990 while (av_strtok(q, " \t", &saveptr1)) {
1996 hls->var_streams = av_mallocz(sizeof(*hls->var_streams) * nb_varstreams);
1997 if (!hls->var_streams)
1998 return AVERROR(ENOMEM);
1999 hls->nb_varstreams = nb_varstreams;
2001 p = hls->var_stream_map;
2003 while (varstr = av_strtok(p, " \t", &saveptr1)) {
2006 if (nb_varstreams < hls->nb_varstreams) {
2007 vs = &(hls->var_streams[nb_varstreams]);
2008 vs->var_stream_idx = nb_varstreams;
2012 return AVERROR(EINVAL);
2016 if (!av_strncasecmp(q, "a:", 2) || !av_strncasecmp(q, "v:", 2) ||
2017 !av_strncasecmp(q, "s:", 2))
2024 vs->streams = av_mallocz(sizeof(AVStream *) * vs->nb_streams);
2026 return AVERROR(ENOMEM);
2029 while (keyval = av_strtok(varstr, ",", &saveptr2)) {
2033 if (av_strstart(keyval, "language:", &val)) {
2036 } else if (av_strstart(keyval, "default:", &val)) {
2037 vs->is_default = (!av_strncasecmp(val, "YES", strlen("YES")) ||
2038 (!av_strncasecmp(val, "1", strlen("1"))));
2039 hls->has_default_key = 1;
2041 } else if (av_strstart(keyval, "name:", &val)) {
2044 } else if (av_strstart(keyval, "agroup:", &val)) {
2047 } else if (av_strstart(keyval, "sgroup:", &val)) {
2050 } else if (av_strstart(keyval, "ccgroup:", &val)) {
2053 } else if (av_strstart(keyval, "v:", &val)) {
2054 codec_type = AVMEDIA_TYPE_VIDEO;
2055 hls->has_video_m3u8 = 1;
2056 } else if (av_strstart(keyval, "a:", &val)) {
2057 codec_type = AVMEDIA_TYPE_AUDIO;
2058 } else if (av_strstart(keyval, "s:", &val)) {
2059 codec_type = AVMEDIA_TYPE_SUBTITLE;
2061 av_log(s, AV_LOG_ERROR, "Invalid keyval %s\n", keyval);
2062 return AVERROR(EINVAL);
2065 num = strtoll(val, &end, 10);
2066 if (!av_isdigit(*val) || *end != '\0') {
2067 av_log(s, AV_LOG_ERROR, "Invalid stream number: '%s'\n", val);
2068 return AVERROR(EINVAL);
2070 stream_index = get_nth_codec_stream_index(s, codec_type, num);
2072 if (stream_index >= 0 && nb_streams < vs->nb_streams) {
2073 for (i = 0; nb_streams > 0 && i < nb_streams; i++) {
2074 if (vs->streams[i] == s->streams[stream_index]) {
2075 av_log(s, AV_LOG_ERROR, "Same elementary stream found more than once inside "
2076 "variant definition #%d\n", nb_varstreams - 1);
2077 return AVERROR(EINVAL);
2080 for (j = 0; nb_varstreams > 1 && j < nb_varstreams - 1; j++) {
2081 for (i = 0; i < hls->var_streams[j].nb_streams; i++) {
2082 if (hls->var_streams[j].streams[i] == s->streams[stream_index]) {
2083 av_log(s, AV_LOG_ERROR, "Same elementary stream found more than once "
2084 "in two different variant definitions #%d and #%d\n",
2085 j, nb_varstreams - 1);
2086 return AVERROR(EINVAL);
2090 vs->streams[nb_streams++] = s->streams[stream_index];
2092 av_log(s, AV_LOG_ERROR, "Unable to map stream at %s\n", keyval);
2093 return AVERROR(EINVAL);
2097 av_log(s, AV_LOG_DEBUG, "Number of variant streams %d\n",
2098 hls->nb_varstreams);
2103 static int parse_cc_stream_mapstring(AVFormatContext *s)
2105 HLSContext *hls = s->priv_data;
2106 int nb_ccstreams = 0;
2107 char *p, *q, *ccstr, *keyval;
2108 char *saveptr1 = NULL, *saveptr2 = NULL;
2110 ClosedCaptionsStream *ccs;
2112 p = av_strdup(hls->cc_stream_map);
2114 return AVERROR(ENOMEM);
2117 while (av_strtok(q, " \t", &saveptr1)) {
2123 hls->cc_streams = av_mallocz(sizeof(*hls->cc_streams) * nb_ccstreams);
2124 if (!hls->cc_streams)
2125 return AVERROR(ENOMEM);
2126 hls->nb_ccstreams = nb_ccstreams;
2128 p = hls->cc_stream_map;
2130 while (ccstr = av_strtok(p, " \t", &saveptr1)) {
2133 if (nb_ccstreams < hls->nb_ccstreams)
2134 ccs = &(hls->cc_streams[nb_ccstreams++]);
2136 return AVERROR(EINVAL);
2138 while (keyval = av_strtok(ccstr, ",", &saveptr2)) {
2141 if (av_strstart(keyval, "ccgroup:", &val)) {
2143 } else if (av_strstart(keyval, "instreamid:", &val)) {
2144 ccs->instreamid = val;
2145 } else if (av_strstart(keyval, "language:", &val)) {
2146 ccs->language = val;
2148 av_log(s, AV_LOG_ERROR, "Invalid keyval %s\n", keyval);
2149 return AVERROR(EINVAL);
2153 if (!ccs->ccgroup || !ccs->instreamid) {
2154 av_log(s, AV_LOG_ERROR, "Insufficient parameters in cc stream map string\n");
2155 return AVERROR(EINVAL);
2158 if (av_strstart(ccs->instreamid, "CC", &val)) {
2159 if (atoi(val) < 1 || atoi(val) > 4) {
2160 av_log(s, AV_LOG_ERROR, "Invalid instream ID CC index %d in %s, range 1-4\n",
2161 atoi(val), ccs->instreamid);
2162 return AVERROR(EINVAL);
2164 } else if (av_strstart(ccs->instreamid, "SERVICE", &val)) {
2165 if (atoi(val) < 1 || atoi(val) > 63) {
2166 av_log(s, AV_LOG_ERROR, "Invalid instream ID SERVICE index %d in %s, range 1-63 \n",
2167 atoi(val), ccs->instreamid);
2168 return AVERROR(EINVAL);
2171 av_log(s, AV_LOG_ERROR, "Invalid instream ID %s, supported are CCn or SERVICEn\n",
2173 return AVERROR(EINVAL);
2180 static int update_variant_stream_info(AVFormatContext *s)
2182 HLSContext *hls = s->priv_data;
2186 if (hls->cc_stream_map) {
2187 ret = parse_cc_stream_mapstring(s);
2192 if (hls->var_stream_map) {
2193 return parse_variant_stream_mapstring(s);
2195 //By default, a single variant stream with all the codec streams is created
2196 hls->var_streams = av_mallocz(sizeof(*hls->var_streams));
2197 if (!hls->var_streams)
2198 return AVERROR(ENOMEM);
2199 hls->nb_varstreams = 1;
2201 hls->var_streams[0].var_stream_idx = 0;
2202 hls->var_streams[0].nb_streams = s->nb_streams;
2203 hls->var_streams[0].streams = av_mallocz(sizeof(AVStream *) *
2204 hls->var_streams[0].nb_streams);
2205 if (!hls->var_streams[0].streams)
2206 return AVERROR(ENOMEM);
2208 //by default, the first available ccgroup is mapped to the variant stream
2209 if (hls->nb_ccstreams)
2210 hls->var_streams[0].ccgroup = hls->cc_streams[0].ccgroup;
2212 for (i = 0; i < s->nb_streams; i++)
2213 hls->var_streams[0].streams[i] = s->streams[i];
2218 static int update_master_pl_info(AVFormatContext *s)
2220 HLSContext *hls = s->priv_data;
2222 char *fn1= NULL, *fn2 = NULL;
2225 fn1 = av_strdup(s->url);
2227 return AVERROR(ENOMEM);
2228 dir = av_dirname(fn1);
2231 * if output file's directory has %v, variants are created in sub-directories
2232 * then master is created at the sub-directories level
2234 if (dir && av_stristr(av_basename(dir), "%v")) {
2235 fn2 = av_strdup(dir);
2237 ret = AVERROR(ENOMEM);
2240 dir = av_dirname(fn2);
2243 if (dir && strcmp(dir, "."))
2244 hls->master_m3u8_url = av_append_path_component(dir, hls->master_pl_name);
2246 hls->master_m3u8_url = av_strdup(hls->master_pl_name);
2248 if (!hls->master_m3u8_url) {
2249 ret = AVERROR(ENOMEM);
2260 static int hls_write_header(AVFormatContext *s)
2262 HLSContext *hls = s->priv_data;
2264 VariantStream *vs = NULL;
2266 for (i = 0; i < hls->nb_varstreams; i++) {
2267 vs = &hls->var_streams[i];
2269 ret = avformat_write_header(vs->avf, NULL);
2272 //av_assert0(s->nb_streams == hls->avf->nb_streams);
2273 for (j = 0; j < vs->nb_streams; j++) {
2275 AVStream *outer_st = vs->streams[j];
2277 if (hls->max_seg_size > 0) {
2278 if ((outer_st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) &&
2279 (outer_st->codecpar->bit_rate > hls->max_seg_size)) {
2280 av_log(s, AV_LOG_WARNING, "Your video bitrate is bigger than hls_segment_size, "
2281 "(%"PRId64 " > %"PRId64 "), the result maybe not be what you want.",
2282 outer_st->codecpar->bit_rate, hls->max_seg_size);
2286 if (outer_st->codecpar->codec_type != AVMEDIA_TYPE_SUBTITLE)
2287 inner_st = vs->avf->streams[j];
2288 else if (vs->vtt_avf)
2289 inner_st = vs->vtt_avf->streams[0];
2291 /* We have a subtitle stream, when the user does not want one */
2295 avpriv_set_pts_info(outer_st, inner_st->pts_wrap_bits, inner_st->time_base.num, inner_st->time_base.den);
2296 if (outer_st->codecpar->codec_id == AV_CODEC_ID_HEVC &&
2297 outer_st->codecpar->codec_tag != MKTAG('h','v','c','1')) {
2298 av_log(s, AV_LOG_WARNING, "Stream HEVC is not hvc1, you should use tag:v hvc1 to set it.\n");
2300 write_codec_attr(outer_st, vs);
2303 /* Update the Codec Attr string for the mapped audio groups */
2304 if (vs->has_video && vs->agroup) {
2305 for (j = 0; j < hls->nb_varstreams; j++) {
2306 VariantStream *vs_agroup = &(hls->var_streams[j]);
2307 if (!vs_agroup->has_video && !vs_agroup->has_subtitle &&
2308 vs_agroup->agroup &&
2309 !av_strcasecmp(vs_agroup->agroup, vs->agroup)) {
2310 write_codec_attr(vs_agroup->streams[0], vs);
2319 static int hls_init_file_resend(AVFormatContext *s, VariantStream *vs)
2321 HLSContext *hls = s->priv_data;
2322 AVDictionary *options = NULL;
2325 set_http_options(s, &options, hls);
2326 ret = hlsenc_io_open(s, &vs->out, vs->base_output_dirname, &options);
2327 av_dict_free(&options);
2330 avio_write(vs->out, vs->init_buffer, vs->init_range_length);
2331 hlsenc_io_close(s, &vs->out, hls->fmp4_init_filename);
2336 static int64_t append_single_file(AVFormatContext *s, VariantStream *vs)
2339 int64_t read_byte = 0;
2340 int64_t total_size = 0;
2341 char *filename = NULL;
2343 AVFormatContext *oc = vs->avf;
2345 hlsenc_io_close(s, &vs->out, vs->basename_tmp);
2346 filename = av_asprintf("%s.tmp", oc->url);
2347 ret = s->io_open(s, &vs->out, filename, AVIO_FLAG_READ, NULL);
2354 memset(buf, 0, sizeof(BUFSIZE));
2355 read_byte = avio_read(vs->out, buf, BUFSIZE);
2356 avio_write(vs->out_single_file, buf, read_byte);
2357 if (read_byte > 0) {
2358 total_size += read_byte;
2361 } while (read_byte > 0);
2363 hlsenc_io_close(s, &vs->out, filename);
2368 static int hls_write_packet(AVFormatContext *s, AVPacket *pkt)
2370 HLSContext *hls = s->priv_data;
2371 AVFormatContext *oc = NULL;
2372 AVStream *st = s->streams[pkt->stream_index];
2373 int64_t end_pts = 0;
2375 int ret = 0, can_split = 1, i, j;
2376 int stream_index = 0;
2377 int range_length = 0;
2378 const char *proto = NULL;
2379 int use_temp_file = 0;
2380 VariantStream *vs = NULL;
2381 char *old_filename = NULL;
2383 for (i = 0; i < hls->nb_varstreams; i++) {
2384 vs = &hls->var_streams[i];
2385 for (j = 0; j < vs->nb_streams; j++) {
2386 if (vs->streams[j] == st) {
2387 if (st->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE) {
2403 av_log(s, AV_LOG_ERROR, "Unable to find mapping variant stream\n");
2404 return AVERROR(ENOMEM);
2407 end_pts = hls->recording_time * vs->number;
2409 if (vs->sequence - vs->nb_entries > hls->start_sequence && hls->init_time > 0) {
2410 /* reset end_pts, hls->recording_time at end of the init hls list */
2411 int64_t init_list_dur = hls->init_time * vs->nb_entries * AV_TIME_BASE;
2412 int64_t after_init_list_dur = (vs->sequence - hls->start_sequence - vs->nb_entries) * (hls->time * AV_TIME_BASE);
2413 hls->recording_time = hls->time * AV_TIME_BASE;
2414 end_pts = init_list_dur + after_init_list_dur ;
2417 if (vs->start_pts == AV_NOPTS_VALUE) {
2418 vs->start_pts = pkt->pts;
2419 if (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO)
2420 vs->start_pts_from_audio = 1;
2422 if (vs->start_pts_from_audio && st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO && vs->start_pts > pkt->pts) {
2423 vs->start_pts = pkt->pts;
2424 vs->start_pts_from_audio = 0;
2427 if (vs->has_video) {
2428 can_split = st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO &&
2429 ((pkt->flags & AV_PKT_FLAG_KEY) || (hls->flags & HLS_SPLIT_BY_TIME));
2430 is_ref_pkt = (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) && (pkt->stream_index == vs->reference_stream_index);
2432 if (pkt->pts == AV_NOPTS_VALUE)
2433 is_ref_pkt = can_split = 0;
2436 if (vs->end_pts == AV_NOPTS_VALUE)
2437 vs->end_pts = pkt->pts;
2438 if (vs->new_start) {
2440 vs->duration = (double)(pkt->pts - vs->end_pts)
2441 * st->time_base.num / st->time_base.den;
2442 vs->dpp = (double)(pkt->duration) * st->time_base.num / st->time_base.den;
2444 if (pkt->duration) {
2445 vs->duration += (double)(pkt->duration) * st->time_base.num / st->time_base.den;
2447 av_log(s, AV_LOG_WARNING, "pkt->duration = 0, maybe the hls segment duration will not precise\n");
2448 vs->duration = (double)(pkt->pts - vs->end_pts) * st->time_base.num / st->time_base.den;
2453 can_split = can_split && (pkt->pts - vs->end_pts > 0);
2454 if (vs->packets_written && can_split && av_compare_ts(pkt->pts - vs->start_pts, st->time_base,
2455 end_pts, AV_TIME_BASE_Q) >= 0) {
2456 int64_t new_start_pos;
2457 int byterange_mode = (hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size > 0);
2459 av_write_frame(oc, NULL); /* Flush any buffered data */
2460 new_start_pos = avio_tell(oc->pb);
2461 vs->size = new_start_pos - vs->start_pos;
2463 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
2464 if (!vs->init_range_length) {
2465 range_length = avio_close_dyn_buf(oc->pb, &vs->init_buffer);
2466 if (range_length <= 0)
2467 return AVERROR(EINVAL);
2468 avio_write(vs->out, vs->init_buffer, range_length);
2469 if (!hls->resend_init_file)
2470 av_freep(&vs->init_buffer);
2471 vs->init_range_length = range_length;
2472 avio_open_dyn_buf(&oc->pb);
2473 vs->packets_written = 0;
2474 vs->start_pos = range_length;
2475 if (!byterange_mode) {
2476 hlsenc_io_close(s, &vs->out, vs->base_output_dirname);
2480 if (!byterange_mode) {
2482 hlsenc_io_close(s, &vs->vtt_avf->pb, vs->vtt_avf->url);
2486 if (hls->flags & HLS_SINGLE_FILE) {
2487 ret = flush_dynbuf(vs, &range_length);
2488 av_freep(&vs->temp_buffer);
2492 vs->size = range_length;
2493 if (hls->key_info_file || hls->encrypt)
2494 vs->size = append_single_file(s, vs);
2497 proto = avio_find_protocol_name(oc->url);
2498 use_temp_file = proto && !strcmp(proto, "file")
2499 && (hls->flags & HLS_TEMP_FILE);
2502 if ((hls->max_seg_size > 0 && (vs->size + vs->start_pos >= hls->max_seg_size)) || !byterange_mode) {
2503 AVDictionary *options = NULL;
2504 char *filename = NULL;
2505 if (hls->key_info_file || hls->encrypt) {
2506 av_dict_set(&options, "encryption_key", vs->key_string, 0);
2507 av_dict_set(&options, "encryption_iv", vs->iv_string, 0);
2508 filename = av_asprintf("crypto:%s", oc->url);
2510 filename = av_asprintf("%s", oc->url);
2513 av_dict_free(&options);
2514 return AVERROR(ENOMEM);
2517 // look to rename the asset name
2519 av_dict_set(&options, "mpegts_flags", "resend_headers", 0);
2521 set_http_options(s, &options, hls);
2523 ret = hlsenc_io_open(s, &vs->out, filename, &options);
2525 av_log(s, hls->ignore_io_errors ? AV_LOG_WARNING : AV_LOG_ERROR,
2526 "Failed to open file '%s'\n", filename);
2527 av_freep(&filename);
2528 av_dict_free(&options);
2529 return hls->ignore_io_errors ? 0 : ret;
2531 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
2532 write_styp(vs->out);
2534 ret = flush_dynbuf(vs, &range_length);
2536 av_freep(&filename);
2537 av_dict_free(&options);
2540 ret = hlsenc_io_close(s, &vs->out, filename);
2542 av_log(s, AV_LOG_WARNING, "upload segment failed,"
2543 " will retry with a new http session.\n");
2544 ff_format_io_close(s, &vs->out);
2545 ret = hlsenc_io_open(s, &vs->out, filename, &options);
2546 reflush_dynbuf(vs, &range_length);
2547 ret = hlsenc_io_close(s, &vs->out, filename);
2549 av_dict_free(&options);
2550 av_freep(&vs->temp_buffer);
2551 av_freep(&filename);
2555 hls_rename_temp_file(s, oc);
2558 old_filename = av_strdup(oc->url);
2559 if (!old_filename) {
2560 return AVERROR(ENOMEM);
2563 if (vs->start_pos || hls->segment_type != SEGMENT_TYPE_FMP4) {
2564 double cur_duration = (double)(pkt->pts - vs->end_pts) * st->time_base.num / st->time_base.den;
2565 ret = hls_append_segment(s, hls, vs, cur_duration, vs->start_pos, vs->size);
2566 vs->end_pts = pkt->pts;
2569 av_freep(&old_filename);
2574 // if we're building a VOD playlist, skip writing the manifest multiple times, and just wait until the end
2575 if (hls->pl_type != PLAYLIST_TYPE_VOD) {
2576 if ((ret = hls_window(s, 0, vs)) < 0) {
2577 av_log(s, AV_LOG_WARNING, "upload playlist failed, will retry with a new http session.\n");
2578 ff_format_io_close(s, &vs->out);
2579 if ((ret = hls_window(s, 0, vs)) < 0) {
2580 av_freep(&old_filename);
2586 if (hls->resend_init_file && hls->segment_type == SEGMENT_TYPE_FMP4) {
2587 ret = hls_init_file_resend(s, vs);
2589 av_freep(&old_filename);
2594 if (hls->flags & HLS_SINGLE_FILE) {
2595 vs->start_pos += vs->size;
2596 if (hls->key_info_file || hls->encrypt)
2597 ret = hls_start(s, vs);
2598 } else if (hls->max_seg_size > 0) {
2599 if (vs->size + vs->start_pos >= hls->max_seg_size) {
2601 sls_flag_file_rename(hls, vs, old_filename);
2602 ret = hls_start(s, vs);
2604 /* When split segment by byte, the duration is short than hls_time,
2605 * so it is not enough one segment duration as hls_time, */
2607 vs->start_pos = new_start_pos;
2610 vs->start_pos = new_start_pos;
2611 sls_flag_file_rename(hls, vs, old_filename);
2612 ret = hls_start(s, vs);
2615 av_freep(&old_filename);
2623 vs->packets_written++;
2625 int64_t keyframe_pre_pos = avio_tell(oc->pb);
2626 ret = ff_write_chained(oc, stream_index, pkt, s, 0);
2627 if ((st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) &&
2628 (pkt->flags & AV_PKT_FLAG_KEY) && !keyframe_pre_pos) {
2629 av_write_frame(oc, NULL); /* Flush any buffered data */
2630 vs->video_keyframe_size = avio_tell(oc->pb) - keyframe_pre_pos;
2632 vs->video_keyframe_pos = vs->start_pos;
2633 if (hls->ignore_io_errors)
2640 static void hls_deinit(AVFormatContext *s)
2642 HLSContext *hls = s->priv_data;
2644 VariantStream *vs = NULL;
2646 for (i = 0; i < hls->nb_varstreams; i++) {
2647 vs = &hls->var_streams[i];
2649 av_freep(&vs->basename);
2650 av_freep(&vs->base_output_dirname);
2651 av_freep(&vs->fmp4_init_filename);
2652 av_freep(&vs->vtt_basename);
2653 av_freep(&vs->vtt_m3u8_name);
2655 avformat_free_context(vs->vtt_avf);
2656 avformat_free_context(vs->avf);
2657 if (hls->resend_init_file)
2658 av_freep(&vs->init_buffer);
2659 hls_free_segments(vs->segments);
2660 hls_free_segments(vs->old_segments);
2661 av_freep(&vs->m3u8_name);
2662 av_freep(&vs->streams);
2665 ff_format_io_close(s, &hls->m3u8_out);
2666 ff_format_io_close(s, &hls->sub_m3u8_out);
2667 av_freep(&hls->key_basename);
2668 av_freep(&hls->var_streams);
2669 av_freep(&hls->cc_streams);
2670 av_freep(&hls->master_m3u8_url);
2673 static int hls_write_trailer(struct AVFormatContext *s)
2675 HLSContext *hls = s->priv_data;
2676 AVFormatContext *oc = NULL;
2677 AVFormatContext *vtt_oc = NULL;
2678 char *old_filename = NULL;
2679 const char *proto = NULL;
2680 int use_temp_file = 0;
2683 VariantStream *vs = NULL;
2684 AVDictionary *options = NULL;
2685 int range_length, byterange_mode;
2687 for (i = 0; i < hls->nb_varstreams; i++) {
2688 char *filename = NULL;
2689 vs = &hls->var_streams[i];
2691 vtt_oc = vs->vtt_avf;
2692 old_filename = av_strdup(oc->url);
2695 if (!old_filename) {
2696 return AVERROR(ENOMEM);
2698 if (hls->key_info_file || hls->encrypt) {
2699 av_dict_set(&options, "encryption_key", vs->key_string, 0);
2700 av_dict_set(&options, "encryption_iv", vs->iv_string, 0);
2701 filename = av_asprintf("crypto:%s", oc->url);
2703 filename = av_asprintf("%s", oc->url);
2706 av_freep(&old_filename);
2707 return AVERROR(ENOMEM);
2710 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
2711 int range_length = 0;
2712 if (!vs->init_range_length) {
2713 uint8_t *buffer = NULL;
2714 av_write_frame(oc, NULL); /* Flush any buffered data */
2716 range_length = avio_close_dyn_buf(oc->pb, &buffer);
2717 avio_write(vs->out, buffer, range_length);
2719 vs->init_range_length = range_length;
2720 avio_open_dyn_buf(&oc->pb);
2721 vs->packets_written = 0;
2722 vs->start_pos = range_length;
2723 byterange_mode = (hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size > 0);
2724 if (!byterange_mode) {
2725 ff_format_io_close(s, &vs->out);
2726 hlsenc_io_close(s, &vs->out, vs->base_output_dirname);
2730 if (!(hls->flags & HLS_SINGLE_FILE)) {
2731 set_http_options(s, &options, hls);
2732 ret = hlsenc_io_open(s, &vs->out, filename, &options);
2734 av_log(s, AV_LOG_ERROR, "Failed to open file '%s'\n", oc->url);
2737 if (hls->segment_type == SEGMENT_TYPE_FMP4)
2738 write_styp(vs->out);
2740 ret = flush_dynbuf(vs, &range_length);
2744 vs->size = range_length;
2745 ret = hlsenc_io_close(s, &vs->out, filename);
2747 av_log(s, AV_LOG_WARNING, "upload segment failed, will retry with a new http session.\n");
2748 ff_format_io_close(s, &vs->out);
2749 ret = hlsenc_io_open(s, &vs->out, filename, &options);
2751 av_log(s, AV_LOG_ERROR, "Failed to open file '%s'\n", oc->url);
2754 reflush_dynbuf(vs, &range_length);
2755 ret = hlsenc_io_close(s, &vs->out, filename);
2757 av_log(s, AV_LOG_WARNING, "Failed to upload file '%s' at the end.\n", oc->url);
2759 if (hls->flags & HLS_SINGLE_FILE) {
2760 if (hls->key_info_file || hls->encrypt) {
2761 vs->size = append_single_file(s, vs);
2763 hlsenc_io_close(s, &vs->out_single_file, vs->basename);
2766 av_freep(&vs->temp_buffer);
2767 av_dict_free(&options);
2768 av_freep(&filename);
2769 av_write_trailer(oc);
2771 proto = avio_find_protocol_name(oc->url);
2772 use_temp_file = proto && !strcmp(proto, "file") && (hls->flags & HLS_TEMP_FILE);
2775 // rename that segment from .tmp to the real one
2776 if (use_temp_file && !(hls->flags & HLS_SINGLE_FILE)) {
2777 hls_rename_temp_file(s, oc);
2778 av_freep(&old_filename);
2779 old_filename = av_strdup(oc->url);
2781 if (!old_filename) {
2782 return AVERROR(ENOMEM);
2786 /* after av_write_trailer, then duration + 1 duration per packet */
2787 hls_append_segment(s, hls, vs, vs->duration + vs->dpp, vs->start_pos, vs->size);
2789 sls_flag_file_rename(hls, vs, old_filename);
2793 av_write_trailer(vtt_oc);
2794 vs->size = avio_tell(vs->vtt_avf->pb) - vs->start_pos;
2795 ff_format_io_close(s, &vtt_oc->pb);
2797 ret = hls_window(s, 1, vs);
2799 av_log(s, AV_LOG_WARNING, "upload playlist failed, will retry with a new http session.\n");
2800 ff_format_io_close(s, &vs->out);
2801 hls_window(s, 1, vs);
2803 ffio_free_dyn_buf(&oc->pb);
2805 av_free(old_filename);
2812 static int hls_init(AVFormatContext *s)
2817 HLSContext *hls = s->priv_data;
2818 const char *pattern;
2819 VariantStream *vs = NULL;
2820 const char *vtt_pattern = hls->flags & HLS_SINGLE_FILE ? ".vtt" : "%d.vtt";
2822 int http_base_proto = ff_is_http_proto(s->url);
2823 int fmp4_init_filename_len = strlen(hls->fmp4_init_filename) + 1;
2824 double initial_program_date_time = av_gettime() / 1000000.0;
2826 if (hls->use_localtime) {
2827 pattern = get_default_pattern_localtime_fmt(s);
2829 pattern = hls->segment_type == SEGMENT_TYPE_FMP4 ? "%d.m4s" : "%d.ts";
2830 if (hls->flags & HLS_SINGLE_FILE)
2834 hls->has_default_key = 0;
2835 hls->has_video_m3u8 = 0;
2836 ret = update_variant_stream_info(s);
2838 av_log(s, AV_LOG_ERROR, "Variant stream info update failed with status %x\n",
2843 if (!hls->method && http_base_proto) {
2844 av_log(hls, AV_LOG_WARNING, "No HTTP method set, hls muxer defaulting to method PUT.\n");
2847 ret = validate_name(hls->nb_varstreams, s->url);
2851 if (hls->segment_filename) {
2852 ret = validate_name(hls->nb_varstreams, hls->segment_filename);
2857 if (av_strcasecmp(hls->fmp4_init_filename, "init.mp4")) {
2858 ret = validate_name(hls->nb_varstreams, hls->fmp4_init_filename);
2863 if (hls->subtitle_filename) {
2864 ret = validate_name(hls->nb_varstreams, hls->subtitle_filename);
2869 if (hls->master_pl_name) {
2870 ret = update_master_pl_info(s);
2872 av_log(s, AV_LOG_ERROR, "Master stream info update failed with status %x\n",
2878 if ((hls->start_sequence_source_type == HLS_START_SEQUENCE_AS_SECONDS_SINCE_EPOCH) ||
2879 (hls->start_sequence_source_type == HLS_START_SEQUENCE_AS_MICROSECONDS_SINCE_EPOCH) ||
2880 (hls->start_sequence_source_type == HLS_START_SEQUENCE_AS_FORMATTED_DATETIME)) {
2881 time_t t = time(NULL);
2882 if (hls->start_sequence_source_type == HLS_START_SEQUENCE_AS_MICROSECONDS_SINCE_EPOCH) {
2883 hls->start_sequence = av_gettime();
2884 } else if (hls->start_sequence_source_type == HLS_START_SEQUENCE_AS_SECONDS_SINCE_EPOCH) {
2885 hls->start_sequence = (int64_t)t;
2886 } else if (hls->start_sequence_source_type == HLS_START_SEQUENCE_AS_FORMATTED_DATETIME) {
2888 struct tm *p, tmbuf;
2889 if (!(p = localtime_r(&t, &tmbuf)))
2890 return AVERROR(errno);
2891 if (!strftime(b, sizeof(b), "%Y%m%d%H%M%S", p))
2892 return AVERROR(ENOMEM);
2893 hls->start_sequence = strtoll(b, NULL, 10);
2895 av_log(hls, AV_LOG_DEBUG, "start_number evaluated to %"PRId64"\n", hls->start_sequence);
2898 hls->recording_time = (hls->init_time ? hls->init_time : hls->time) * AV_TIME_BASE;
2900 if (hls->flags & HLS_SPLIT_BY_TIME && hls->flags & HLS_INDEPENDENT_SEGMENTS) {
2901 // Independent segments cannot be guaranteed when splitting by time
2902 hls->flags &= ~HLS_INDEPENDENT_SEGMENTS;
2903 av_log(s, AV_LOG_WARNING,
2904 "'split_by_time' and 'independent_segments' cannot be "
2905 "enabled together. Disabling 'independent_segments' flag\n");
2908 for (i = 0; i < hls->nb_varstreams; i++) {
2909 vs = &hls->var_streams[i];
2911 ret = format_name(s->url, &vs->m3u8_name, i, vs->varname);
2915 vs->sequence = hls->start_sequence;
2916 vs->start_pts = AV_NOPTS_VALUE;
2917 vs->end_pts = AV_NOPTS_VALUE;
2918 vs->current_segment_final_filename_fmt[0] = '\0';
2919 vs->initial_prog_date_time = initial_program_date_time;
2921 for (j = 0; j < vs->nb_streams; j++) {
2922 vs->has_video += vs->streams[j]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO;
2923 /* Get one video stream to reference for split segments
2924 * so use the first video stream index. */
2925 if ((vs->has_video == 1) && (vs->streams[j]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO)) {
2926 vs->reference_stream_index = vs->streams[j]->index;
2928 vs->has_subtitle += vs->streams[j]->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE;
2931 if (vs->has_video > 1)
2932 av_log(s, AV_LOG_WARNING, "More than a single video stream present, expect issues decoding it.\n");
2933 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
2934 vs->oformat = av_guess_format("mp4", NULL, NULL);
2936 vs->oformat = av_guess_format("mpegts", NULL, NULL);
2939 return AVERROR_MUXER_NOT_FOUND;
2941 if (hls->segment_filename) {
2942 ret = format_name(hls->segment_filename, &vs->basename, i, vs->varname);
2946 p = strrchr(vs->m3u8_name, '.');
2950 vs->basename = av_asprintf("%s%s", vs->m3u8_name, pattern);
2952 return AVERROR(ENOMEM);
2958 if (hls->segment_type == SEGMENT_TYPE_FMP4) {
2959 if (hls->nb_varstreams > 1)
2960 fmp4_init_filename_len += strlen(POSTFIX_PATTERN);
2961 if (hls->flags & HLS_SINGLE_FILE) {
2962 vs->fmp4_init_filename = av_strdup(vs->basename);
2963 if (!vs->fmp4_init_filename)
2964 return AVERROR(ENOMEM);
2966 vs->fmp4_init_filename = av_malloc(fmp4_init_filename_len);
2967 if (!vs->fmp4_init_filename)
2968 return AVERROR(ENOMEM);
2969 av_strlcpy(vs->fmp4_init_filename, hls->fmp4_init_filename,
2970 fmp4_init_filename_len);
2971 if (hls->nb_varstreams > 1) {
2972 if (av_stristr(vs->fmp4_init_filename, "%v")) {
2973 av_freep(&vs->fmp4_init_filename);
2974 ret = format_name(hls->fmp4_init_filename,
2975 &vs->fmp4_init_filename, i, vs->varname);
2977 ret = append_postfix(vs->fmp4_init_filename, fmp4_init_filename_len, i);
2983 p = strrchr(vs->m3u8_name, '/');
2987 vs->base_output_dirname = av_asprintf("%s%s", vs->m3u8_name,
2988 vs->fmp4_init_filename);
2991 vs->base_output_dirname = av_strdup(vs->fmp4_init_filename);
2993 if (!vs->base_output_dirname)
2994 return AVERROR(ENOMEM);
2998 ret = hls->use_localtime ? sls_flag_check_duration_size(hls, vs) : sls_flag_check_duration_size_index(hls);
3002 if (vs->has_subtitle) {
3003 vs->vtt_oformat = av_guess_format("webvtt", NULL, NULL);
3004 if (!vs->vtt_oformat)
3005 return AVERROR_MUXER_NOT_FOUND;
3007 p = strrchr(vs->m3u8_name, '.');
3011 vs->vtt_basename = av_asprintf("%s%s", vs->m3u8_name, vtt_pattern);
3012 if (!vs->vtt_basename)
3013 return AVERROR(ENOMEM);
3015 if (hls->subtitle_filename) {
3016 ret = format_name(hls->subtitle_filename, &vs->vtt_m3u8_name, i, vs->varname);
3020 vs->vtt_m3u8_name = av_asprintf("%s_vtt.m3u8", vs->m3u8_name);
3021 if (!vs->vtt_m3u8_name)
3022 return AVERROR(ENOMEM);
3028 if ((ret = hls_mux_init(s, vs)) < 0)
3031 if (hls->flags & HLS_APPEND_LIST) {
3032 parse_playlist(s, vs->m3u8_name, vs);
3033 vs->discontinuity = 1;
3034 if (hls->init_time > 0) {
3035 av_log(s, AV_LOG_WARNING, "append_list mode does not support hls_init_time,"
3036 " hls_init_time value will have no effect\n");
3038 hls->recording_time = hls->time * AV_TIME_BASE;
3042 if ((ret = hls_start(s, vs)) < 0)
3050 #define OFFSET(x) offsetof(HLSContext, x)
3051 #define E AV_OPT_FLAG_ENCODING_PARAM
3052 static const AVOption options[] = {
3053 {"start_number", "set first number in the sequence", OFFSET(start_sequence),AV_OPT_TYPE_INT64, {.i64 = 0}, 0, INT64_MAX, E},
3054 {"hls_time", "set segment length in seconds", OFFSET(time), AV_OPT_TYPE_FLOAT, {.dbl = 2}, 0, FLT_MAX, E},
3055 {"hls_init_time", "set segment length in seconds at init list", OFFSET(init_time), AV_OPT_TYPE_FLOAT, {.dbl = 0}, 0, FLT_MAX, E},
3056 {"hls_list_size", "set maximum number of playlist entries", OFFSET(max_nb_segments), AV_OPT_TYPE_INT, {.i64 = 5}, 0, INT_MAX, E},
3057 {"hls_delete_threshold", "set number of unreferenced segments to keep before deleting", OFFSET(hls_delete_threshold), AV_OPT_TYPE_INT, {.i64 = 1}, 1, INT_MAX, E},
3058 {"hls_ts_options","set hls mpegts list of options for the container format used for hls", OFFSET(format_options), AV_OPT_TYPE_DICT, {.str = NULL}, 0, 0, E},
3059 {"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},
3061 {"hls_wrap", "set number after which the index wraps (will be deprecated)", OFFSET(wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E},
3063 {"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},
3064 {"hls_base_url", "url to prepend to each playlist entry", OFFSET(baseurl), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
3065 {"hls_segment_filename", "filename template for segment files", OFFSET(segment_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
3066 {"hls_segment_size", "maximum size per segment file, (in bytes)", OFFSET(max_seg_size), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E},
3067 {"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},
3068 {"hls_enc", "enable AES128 encryption support", OFFSET(encrypt), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E},
3069 {"hls_enc_key", "hex-coded 16 byte key to encrypt the segments", OFFSET(key), AV_OPT_TYPE_STRING, .flags = E},
3070 {"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},
3071 {"hls_enc_iv", "hex-coded 16 byte initialization vector", OFFSET(iv), AV_OPT_TYPE_STRING, .flags = E},
3072 {"hls_subtitle_path", "set path of hls subtitles", OFFSET(subtitle_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
3073 {"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"},
3074 {"mpegts", "make segment file to mpegts files in m3u8", 0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_TYPE_MPEGTS }, 0, UINT_MAX, E, "segment_type"},
3075 {"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"},
3076 {"hls_fmp4_init_filename", "set fragment mp4 file init filename", OFFSET(fmp4_init_filename), AV_OPT_TYPE_STRING, {.str = "init.mp4"}, 0, 0, E},
3077 {"hls_fmp4_init_resend", "resend fragment mp4 init file after refresh m3u8 every time", OFFSET(resend_init_file), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
3078 {"hls_flags", "set flags affecting HLS playlist and media file generation", OFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0 }, 0, UINT_MAX, E, "flags"},
3079 {"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"},
3080 {"temp_file", "write segment and playlist to temporary file and rename when complete", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_TEMP_FILE }, 0, UINT_MAX, E, "flags"},
3081 {"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"},
3082 {"round_durations", "round durations in m3u8 to whole numbers", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_ROUND_DURATIONS }, 0, UINT_MAX, E, "flags"},
3083 {"discont_start", "start the playlist with a discontinuity tag", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_DISCONT_START }, 0, UINT_MAX, E, "flags"},
3084 {"omit_endlist", "Do not append an endlist when ending stream", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_OMIT_ENDLIST }, 0, UINT_MAX, E, "flags"},
3085 {"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"},
3086 {"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"},
3087 {"program_date_time", "add EXT-X-PROGRAM-DATE-TIME", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_PROGRAM_DATE_TIME }, 0, UINT_MAX, E, "flags"},
3088 {"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"},
3089 {"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"},
3090 {"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"},
3091 {"periodic_rekey", "reload keyinfo file periodically for re-keying", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_PERIODIC_REKEY }, 0, UINT_MAX, E, "flags"},
3092 {"independent_segments", "add EXT-X-INDEPENDENT-SEGMENTS, whenever applicable", 0, AV_OPT_TYPE_CONST, { .i64 = HLS_INDEPENDENT_SEGMENTS }, 0, UINT_MAX, E, "flags"},
3093 {"iframes_only", "add EXT-X-I-FRAMES-ONLY, whenever applicable", 0, AV_OPT_TYPE_CONST, { .i64 = HLS_I_FRAMES_ONLY }, 0, UINT_MAX, E, "flags"},
3094 #if FF_API_HLS_USE_LOCALTIME
3095 {"use_localtime", "set filename expansion with strftime at segment creation(will be deprecated)", OFFSET(use_localtime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
3097 {"strftime", "set filename expansion with strftime at segment creation", OFFSET(use_localtime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
3098 #if FF_API_HLS_USE_LOCALTIME
3099 {"use_localtime_mkdir", "create last directory component in strftime-generated filename(will be deprecated)", OFFSET(use_localtime_mkdir), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
3101 {"strftime_mkdir", "create last directory component in strftime-generated filename", OFFSET(use_localtime_mkdir), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
3102 {"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" },
3103 {"event", "EVENT playlist", 0, AV_OPT_TYPE_CONST, {.i64 = PLAYLIST_TYPE_EVENT }, INT_MIN, INT_MAX, E, "pl_type" },
3104 {"vod", "VOD playlist", 0, AV_OPT_TYPE_CONST, {.i64 = PLAYLIST_TYPE_VOD }, INT_MIN, INT_MAX, E, "pl_type" },
3105 {"method", "set the HTTP method(default: PUT)", OFFSET(method), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
3106 {"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_LAST-1, E, "start_sequence_source_type" },
3107 {"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" },
3108 {"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" },
3109 {"epoch_us", "microseconds since epoch", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_START_SEQUENCE_AS_MICROSECONDS_SINCE_EPOCH }, INT_MIN, INT_MAX, E, "start_sequence_source_type" },
3110 {"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" },
3111 {"http_user_agent", "override User-Agent field in HTTP header", OFFSET(user_agent), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
3112 {"var_stream_map", "Variant stream map string", OFFSET(var_stream_map), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
3113 {"cc_stream_map", "Closed captions stream map string", OFFSET(cc_stream_map), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
3114 {"master_pl_name", "Create HLS master playlist with this name", OFFSET(master_pl_name), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
3115 {"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},
3116 {"http_persistent", "Use persistent HTTP connections", OFFSET(http_persistent), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
3117 {"timeout", "set timeout for socket I/O operations", OFFSET(timeout), AV_OPT_TYPE_DURATION, { .i64 = -1 }, -1, INT_MAX, .flags = E },
3118 {"ignore_io_errors", "Ignore IO errors for stable long-duration runs with network output", OFFSET(ignore_io_errors), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, E },
3119 {"headers", "set custom HTTP headers, can override built in default headers", OFFSET(headers), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, E },
3123 static const AVClass hls_class = {
3124 .class_name = "hls muxer",
3125 .item_name = av_default_item_name,
3127 .version = LIBAVUTIL_VERSION_INT,
3131 AVOutputFormat ff_hls_muxer = {
3133 .long_name = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
3134 .extensions = "m3u8",
3135 .priv_data_size = sizeof(HLSContext),
3136 .audio_codec = AV_CODEC_ID_AAC,
3137 .video_codec = AV_CODEC_ID_H264,
3138 .subtitle_codec = AV_CODEC_ID_WEBVTT,
3139 .flags = AVFMT_NOFILE | AVFMT_GLOBALHEADER | AVFMT_ALLOW_FLUSH | AVFMT_NODIMENSIONS,
3141 .write_header = hls_write_header,
3142 .write_packet = hls_write_packet,
3143 .write_trailer = hls_write_trailer,
3144 .deinit = hls_deinit,
3145 .priv_class = &hls_class,