2 * Apple HTTP Live Streaming demuxer
3 * Copyright (c) 2010 Martin Storsjo
4 * Copyright (c) 2013 Anssi Hannula
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
25 * Apple HTTP Live Streaming demuxer
26 * http://tools.ietf.org/html/draft-pantos-http-live-streaming
29 #include "libavformat/http.h"
30 #include "libavutil/avstring.h"
31 #include "libavutil/avassert.h"
32 #include "libavutil/intreadwrite.h"
33 #include "libavutil/mathematics.h"
34 #include "libavutil/opt.h"
35 #include "libavutil/dict.h"
36 #include "libavutil/time.h"
39 #include "avio_internal.h"
42 #define INITIAL_BUFFER_SIZE 32768
44 #define MAX_FIELD_LEN 64
45 #define MAX_CHARACTERISTICS_LEN 512
47 #define MPEG_TIME_BASE 90000
48 #define MPEG_TIME_BASE_Q (AVRational){1, MPEG_TIME_BASE}
51 * An apple http stream consists of a playlist with media segment files,
52 * played sequentially. There may be several playlists with the same
53 * video content, in different bandwidth variants, that are played in
54 * parallel (preferably only one bandwidth variant at a time). In this case,
55 * the user supplied the url to a main playlist that only lists the variant
58 * If the main playlist doesn't point at any variants, we still create
59 * one anonymous toplevel variant for this, to maintain the structure.
74 enum KeyType key_type;
76 /* associated Media Initialization Section, treated as a segment */
77 struct segment *init_section;
89 * Each playlist has its own demuxer. If it currently is active,
90 * it has an open AVIOContext too, and potentially an AVPacket
91 * containing the next packet from this stream.
94 char url[MAX_URL_SIZE];
99 AVIOContext *input_next;
100 int input_next_requested;
101 AVFormatContext *parent;
103 AVFormatContext *ctx;
105 int has_noheader_flag;
107 /* main demuxer streams associated with this playlist
108 * indexed by the subdemuxer stream indexes */
109 AVStream **main_streams;
113 enum PlaylistType type;
114 int64_t target_duration;
117 struct segment **segments;
120 int64_t cur_seg_offset;
121 int64_t last_load_time;
123 /* Currently active Media Initialization Section */
124 struct segment *cur_init_section;
125 uint8_t *init_sec_buf;
126 unsigned int init_sec_buf_size;
127 unsigned int init_sec_data_len;
128 unsigned int init_sec_buf_read_offset;
130 char key_url[MAX_URL_SIZE];
133 /* ID3 timestamp handling (elementary audio streams have ID3 timestamps
134 * (and possibly other ID3 tags) in the beginning of each segment) */
135 int is_id3_timestamped; /* -1: not yet known */
136 int64_t id3_mpegts_timestamp; /* in mpegts tb */
137 int64_t id3_offset; /* in stream original tb */
138 uint8_t* id3_buf; /* temp buffer for id3 parsing */
139 unsigned int id3_buf_size;
140 AVDictionary *id3_initial; /* data from first id3 tag */
141 int id3_found; /* ID3 tag found at some point */
142 int id3_changed; /* ID3 tag data has changed at some point */
143 ID3v2ExtraMeta *id3_deferred_extra; /* stored here until subdemuxer is opened */
145 int64_t seek_timestamp;
147 int seek_stream_index; /* into subdemuxer stream array */
149 /* Renditions associated with this playlist, if any.
150 * Alternative rendition playlists have a single rendition associated
151 * with them, and variant main Media Playlists may have
152 * multiple (playlist-less) renditions associated with them. */
154 struct rendition **renditions;
156 /* Media Initialization Sections (EXT-X-MAP) associated with this
157 * playlist, if any. */
159 struct segment **init_sections;
163 * Renditions are e.g. alternative subtitle or audio streams.
164 * The rendition may either be an external playlist or it may be
165 * contained in the main Media Playlist of the variant (in which case
169 enum AVMediaType type;
170 struct playlist *playlist;
171 char group_id[MAX_FIELD_LEN];
172 char language[MAX_FIELD_LEN];
173 char name[MAX_FIELD_LEN];
180 /* every variant contains at least the main Media Playlist in index 0 */
182 struct playlist **playlists;
184 char audio_group[MAX_FIELD_LEN];
185 char video_group[MAX_FIELD_LEN];
186 char subtitles_group[MAX_FIELD_LEN];
189 typedef struct HLSContext {
191 AVFormatContext *ctx;
193 struct variant **variants;
195 struct playlist **playlists;
197 struct rendition **renditions;
200 int live_start_index;
202 int64_t first_timestamp;
203 int64_t cur_timestamp;
204 AVIOInterruptCB *interrupt_callback;
205 AVDictionary *avio_opts;
206 int strict_std_compliance;
207 char *allowed_extensions;
211 AVIOContext *playlist_pb;
214 static void free_segment_list(struct playlist *pls)
217 for (i = 0; i < pls->n_segments; i++) {
218 av_freep(&pls->segments[i]->key);
219 av_freep(&pls->segments[i]->url);
220 av_freep(&pls->segments[i]);
222 av_freep(&pls->segments);
226 static void free_init_section_list(struct playlist *pls)
229 for (i = 0; i < pls->n_init_sections; i++) {
230 av_freep(&pls->init_sections[i]->url);
231 av_freep(&pls->init_sections[i]);
233 av_freep(&pls->init_sections);
234 pls->n_init_sections = 0;
237 static void free_playlist_list(HLSContext *c)
240 for (i = 0; i < c->n_playlists; i++) {
241 struct playlist *pls = c->playlists[i];
242 free_segment_list(pls);
243 free_init_section_list(pls);
244 av_freep(&pls->main_streams);
245 av_freep(&pls->renditions);
246 av_freep(&pls->id3_buf);
247 av_dict_free(&pls->id3_initial);
248 ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
249 av_freep(&pls->init_sec_buf);
250 av_packet_unref(&pls->pkt);
251 av_freep(&pls->pb.buffer);
253 ff_format_io_close(c->ctx, &pls->input);
254 pls->input_read_done = 0;
256 ff_format_io_close(c->ctx, &pls->input_next);
257 pls->input_next_requested = 0;
260 avformat_close_input(&pls->ctx);
264 av_freep(&c->playlists);
268 static void free_variant_list(HLSContext *c)
271 for (i = 0; i < c->n_variants; i++) {
272 struct variant *var = c->variants[i];
273 av_freep(&var->playlists);
276 av_freep(&c->variants);
280 static void free_rendition_list(HLSContext *c)
283 for (i = 0; i < c->n_renditions; i++)
284 av_freep(&c->renditions[i]);
285 av_freep(&c->renditions);
290 * Used to reset a statically allocated AVPacket to a clean slate,
291 * containing no data.
293 static void reset_packet(AVPacket *pkt)
299 static struct playlist *new_playlist(HLSContext *c, const char *url,
302 struct playlist *pls = av_mallocz(sizeof(struct playlist));
305 reset_packet(&pls->pkt);
306 ff_make_absolute_url(pls->url, sizeof(pls->url), base, url);
307 pls->seek_timestamp = AV_NOPTS_VALUE;
309 pls->is_id3_timestamped = -1;
310 pls->id3_mpegts_timestamp = AV_NOPTS_VALUE;
312 dynarray_add(&c->playlists, &c->n_playlists, pls);
316 struct variant_info {
318 /* variant group ids: */
319 char audio[MAX_FIELD_LEN];
320 char video[MAX_FIELD_LEN];
321 char subtitles[MAX_FIELD_LEN];
324 static struct variant *new_variant(HLSContext *c, struct variant_info *info,
325 const char *url, const char *base)
328 struct playlist *pls;
330 pls = new_playlist(c, url, base);
334 var = av_mallocz(sizeof(struct variant));
339 var->bandwidth = atoi(info->bandwidth);
340 strcpy(var->audio_group, info->audio);
341 strcpy(var->video_group, info->video);
342 strcpy(var->subtitles_group, info->subtitles);
345 dynarray_add(&c->variants, &c->n_variants, var);
346 dynarray_add(&var->playlists, &var->n_playlists, pls);
350 static void handle_variant_args(struct variant_info *info, const char *key,
351 int key_len, char **dest, int *dest_len)
353 if (!strncmp(key, "BANDWIDTH=", key_len)) {
354 *dest = info->bandwidth;
355 *dest_len = sizeof(info->bandwidth);
356 } else if (!strncmp(key, "AUDIO=", key_len)) {
358 *dest_len = sizeof(info->audio);
359 } else if (!strncmp(key, "VIDEO=", key_len)) {
361 *dest_len = sizeof(info->video);
362 } else if (!strncmp(key, "SUBTITLES=", key_len)) {
363 *dest = info->subtitles;
364 *dest_len = sizeof(info->subtitles);
369 char uri[MAX_URL_SIZE];
374 static void handle_key_args(struct key_info *info, const char *key,
375 int key_len, char **dest, int *dest_len)
377 if (!strncmp(key, "METHOD=", key_len)) {
378 *dest = info->method;
379 *dest_len = sizeof(info->method);
380 } else if (!strncmp(key, "URI=", key_len)) {
382 *dest_len = sizeof(info->uri);
383 } else if (!strncmp(key, "IV=", key_len)) {
385 *dest_len = sizeof(info->iv);
389 struct init_section_info {
390 char uri[MAX_URL_SIZE];
394 static struct segment *new_init_section(struct playlist *pls,
395 struct init_section_info *info,
396 const char *url_base)
400 char tmp_str[MAX_URL_SIZE];
405 sec = av_mallocz(sizeof(*sec));
409 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url_base, info->uri);
410 sec->url = av_strdup(tmp_str);
416 if (info->byterange[0]) {
417 sec->size = strtoll(info->byterange, NULL, 10);
418 ptr = strchr(info->byterange, '@');
420 sec->url_offset = strtoll(ptr+1, NULL, 10);
422 /* the entire file is the init section */
426 dynarray_add(&pls->init_sections, &pls->n_init_sections, sec);
431 static void handle_init_section_args(struct init_section_info *info, const char *key,
432 int key_len, char **dest, int *dest_len)
434 if (!strncmp(key, "URI=", key_len)) {
436 *dest_len = sizeof(info->uri);
437 } else if (!strncmp(key, "BYTERANGE=", key_len)) {
438 *dest = info->byterange;
439 *dest_len = sizeof(info->byterange);
443 struct rendition_info {
445 char uri[MAX_URL_SIZE];
446 char group_id[MAX_FIELD_LEN];
447 char language[MAX_FIELD_LEN];
448 char assoc_language[MAX_FIELD_LEN];
449 char name[MAX_FIELD_LEN];
452 char characteristics[MAX_CHARACTERISTICS_LEN];
455 static struct rendition *new_rendition(HLSContext *c, struct rendition_info *info,
456 const char *url_base)
458 struct rendition *rend;
459 enum AVMediaType type = AVMEDIA_TYPE_UNKNOWN;
460 char *characteristic;
464 if (!strcmp(info->type, "AUDIO"))
465 type = AVMEDIA_TYPE_AUDIO;
466 else if (!strcmp(info->type, "VIDEO"))
467 type = AVMEDIA_TYPE_VIDEO;
468 else if (!strcmp(info->type, "SUBTITLES"))
469 type = AVMEDIA_TYPE_SUBTITLE;
470 else if (!strcmp(info->type, "CLOSED-CAPTIONS"))
471 /* CLOSED-CAPTIONS is ignored since we do not support CEA-608 CC in
472 * AVC SEI RBSP anyway */
475 if (type == AVMEDIA_TYPE_UNKNOWN)
478 /* URI is mandatory for subtitles as per spec */
479 if (type == AVMEDIA_TYPE_SUBTITLE && !info->uri[0])
482 /* TODO: handle subtitles (each segment has to parsed separately) */
483 if (c->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL)
484 if (type == AVMEDIA_TYPE_SUBTITLE)
487 rend = av_mallocz(sizeof(struct rendition));
491 dynarray_add(&c->renditions, &c->n_renditions, rend);
494 strcpy(rend->group_id, info->group_id);
495 strcpy(rend->language, info->language);
496 strcpy(rend->name, info->name);
498 /* add the playlist if this is an external rendition */
500 rend->playlist = new_playlist(c, info->uri, url_base);
502 dynarray_add(&rend->playlist->renditions,
503 &rend->playlist->n_renditions, rend);
506 if (info->assoc_language[0]) {
507 int langlen = strlen(rend->language);
508 if (langlen < sizeof(rend->language) - 3) {
509 rend->language[langlen] = ',';
510 strncpy(rend->language + langlen + 1, info->assoc_language,
511 sizeof(rend->language) - langlen - 2);
515 if (!strcmp(info->defaultr, "YES"))
516 rend->disposition |= AV_DISPOSITION_DEFAULT;
517 if (!strcmp(info->forced, "YES"))
518 rend->disposition |= AV_DISPOSITION_FORCED;
520 chr_ptr = info->characteristics;
521 while ((characteristic = av_strtok(chr_ptr, ",", &saveptr))) {
522 if (!strcmp(characteristic, "public.accessibility.describes-music-and-sound"))
523 rend->disposition |= AV_DISPOSITION_HEARING_IMPAIRED;
524 else if (!strcmp(characteristic, "public.accessibility.describes-video"))
525 rend->disposition |= AV_DISPOSITION_VISUAL_IMPAIRED;
533 static void handle_rendition_args(struct rendition_info *info, const char *key,
534 int key_len, char **dest, int *dest_len)
536 if (!strncmp(key, "TYPE=", key_len)) {
538 *dest_len = sizeof(info->type);
539 } else if (!strncmp(key, "URI=", key_len)) {
541 *dest_len = sizeof(info->uri);
542 } else if (!strncmp(key, "GROUP-ID=", key_len)) {
543 *dest = info->group_id;
544 *dest_len = sizeof(info->group_id);
545 } else if (!strncmp(key, "LANGUAGE=", key_len)) {
546 *dest = info->language;
547 *dest_len = sizeof(info->language);
548 } else if (!strncmp(key, "ASSOC-LANGUAGE=", key_len)) {
549 *dest = info->assoc_language;
550 *dest_len = sizeof(info->assoc_language);
551 } else if (!strncmp(key, "NAME=", key_len)) {
553 *dest_len = sizeof(info->name);
554 } else if (!strncmp(key, "DEFAULT=", key_len)) {
555 *dest = info->defaultr;
556 *dest_len = sizeof(info->defaultr);
557 } else if (!strncmp(key, "FORCED=", key_len)) {
558 *dest = info->forced;
559 *dest_len = sizeof(info->forced);
560 } else if (!strncmp(key, "CHARACTERISTICS=", key_len)) {
561 *dest = info->characteristics;
562 *dest_len = sizeof(info->characteristics);
566 * - AUTOSELECT: client may autoselect based on e.g. system language
567 * - INSTREAM-ID: EIA-608 closed caption number ("CC1".."CC4")
571 /* used by parse_playlist to allocate a new variant+playlist when the
572 * playlist is detected to be a Media Playlist (not Master Playlist)
573 * and we have no parent Master Playlist (parsing of which would have
574 * allocated the variant and playlist already)
575 * *pls == NULL => Master Playlist or parentless Media Playlist
576 * *pls != NULL => parented Media Playlist, playlist+variant allocated */
577 static int ensure_playlist(HLSContext *c, struct playlist **pls, const char *url)
581 if (!new_variant(c, NULL, url, NULL))
582 return AVERROR(ENOMEM);
583 *pls = c->playlists[c->n_playlists - 1];
587 static int open_url_keepalive(AVFormatContext *s, AVIOContext **pb,
590 #if !CONFIG_HTTP_PROTOCOL
591 return AVERROR_PROTOCOL_NOT_FOUND;
594 URLContext *uc = ffio_geturlcontext(*pb);
596 (*pb)->eof_reached = 0;
597 ret = ff_http_do_new_request(uc, url);
599 ff_format_io_close(s, pb);
605 static int open_url(AVFormatContext *s, AVIOContext **pb, const char *url,
606 AVDictionary *opts, AVDictionary *opts2, int *is_http_out)
608 HLSContext *c = s->priv_data;
609 AVDictionary *tmp = NULL;
610 const char *proto_name = NULL;
614 av_dict_copy(&tmp, opts, 0);
615 av_dict_copy(&tmp, opts2, 0);
617 if (av_strstart(url, "crypto", NULL)) {
618 if (url[6] == '+' || url[6] == ':')
619 proto_name = avio_find_protocol_name(url + 7);
623 proto_name = avio_find_protocol_name(url);
626 return AVERROR_INVALIDDATA;
628 // only http(s) & file are allowed
629 if (av_strstart(proto_name, "file", NULL)) {
630 if (strcmp(c->allowed_extensions, "ALL") && !av_match_ext(url, c->allowed_extensions)) {
631 av_log(s, AV_LOG_ERROR,
632 "Filename extension of \'%s\' is not a common multimedia extension, blocked for security reasons.\n"
633 "If you wish to override this adjust allowed_extensions, you can set it to \'ALL\' to allow all\n",
635 return AVERROR_INVALIDDATA;
637 } else if (av_strstart(proto_name, "http", NULL)) {
640 return AVERROR_INVALIDDATA;
642 if (!strncmp(proto_name, url, strlen(proto_name)) && url[strlen(proto_name)] == ':')
644 else if (av_strstart(url, "crypto", NULL) && !strncmp(proto_name, url + 7, strlen(proto_name)) && url[7 + strlen(proto_name)] == ':')
646 else if (strcmp(proto_name, "file") || !strncmp(url, "file,", 5))
647 return AVERROR_INVALIDDATA;
649 if (is_http && c->http_persistent && *pb) {
650 ret = open_url_keepalive(c->ctx, pb, url);
651 if (ret == AVERROR_EXIT) {
653 } else if (ret < 0) {
654 if (ret != AVERROR_EOF)
655 av_log(s, AV_LOG_WARNING,
656 "keepalive request failed for '%s', retrying with new connection: %s\n",
657 url, av_err2str(ret));
658 ret = s->io_open(s, pb, url, AVIO_FLAG_READ, &tmp);
661 ret = s->io_open(s, pb, url, AVIO_FLAG_READ, &tmp);
664 // update cookies on http response with setcookies.
665 char *new_cookies = NULL;
667 if (!(s->flags & AVFMT_FLAG_CUSTOM_IO))
668 av_opt_get(*pb, "cookies", AV_OPT_SEARCH_CHILDREN, (uint8_t**)&new_cookies);
671 av_dict_set(&opts, "cookies", new_cookies, AV_DICT_DONT_STRDUP_VAL);
677 *is_http_out = is_http;
682 static int parse_playlist(HLSContext *c, const char *url,
683 struct playlist *pls, AVIOContext *in)
685 int ret = 0, is_segment = 0, is_variant = 0;
686 int64_t duration = 0;
687 enum KeyType key_type = KEY_NONE;
690 char key[MAX_URL_SIZE] = "";
691 char line[MAX_URL_SIZE];
694 int64_t seg_offset = 0;
695 int64_t seg_size = -1;
696 uint8_t *new_url = NULL;
697 struct variant_info variant_info;
698 char tmp_str[MAX_URL_SIZE];
699 struct segment *cur_init_section = NULL;
700 int is_http = av_strstart(url, "http", NULL);
702 if (is_http && !in && c->http_persistent && c->playlist_pb) {
704 ret = open_url_keepalive(c->ctx, &c->playlist_pb, url);
705 if (ret == AVERROR_EXIT) {
707 } else if (ret < 0) {
708 if (ret != AVERROR_EOF)
709 av_log(c->ctx, AV_LOG_WARNING,
710 "keepalive request failed for '%s', retrying with new connection: %s\n",
711 url, av_err2str(ret));
717 AVDictionary *opts = NULL;
718 av_dict_copy(&opts, c->avio_opts, 0);
720 if (c->http_persistent)
721 av_dict_set(&opts, "multiple_requests", "1", 0);
723 ret = c->ctx->io_open(c->ctx, &in, url, AVIO_FLAG_READ, &opts);
728 if (is_http && c->http_persistent)
734 if (av_opt_get(in, "location", AV_OPT_SEARCH_CHILDREN, &new_url) >= 0)
737 ff_get_chomp_line(in, line, sizeof(line));
738 if (strcmp(line, "#EXTM3U")) {
739 ret = AVERROR_INVALIDDATA;
744 free_segment_list(pls);
746 pls->type = PLS_TYPE_UNSPECIFIED;
748 while (!avio_feof(in)) {
749 ff_get_chomp_line(in, line, sizeof(line));
750 if (av_strstart(line, "#EXT-X-STREAM-INF:", &ptr)) {
752 memset(&variant_info, 0, sizeof(variant_info));
753 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_variant_args,
755 } else if (av_strstart(line, "#EXT-X-KEY:", &ptr)) {
756 struct key_info info = {{0}};
757 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_key_args,
761 if (!strcmp(info.method, "AES-128"))
762 key_type = KEY_AES_128;
763 if (!strcmp(info.method, "SAMPLE-AES"))
764 key_type = KEY_SAMPLE_AES;
765 if (!strncmp(info.iv, "0x", 2) || !strncmp(info.iv, "0X", 2)) {
766 ff_hex_to_data(iv, info.iv + 2);
769 av_strlcpy(key, info.uri, sizeof(key));
770 } else if (av_strstart(line, "#EXT-X-MEDIA:", &ptr)) {
771 struct rendition_info info = {{0}};
772 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_rendition_args,
774 new_rendition(c, &info, url);
775 } else if (av_strstart(line, "#EXT-X-TARGETDURATION:", &ptr)) {
776 ret = ensure_playlist(c, &pls, url);
779 pls->target_duration = strtoll(ptr, NULL, 10) * AV_TIME_BASE;
780 } else if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
781 ret = ensure_playlist(c, &pls, url);
784 pls->start_seq_no = atoi(ptr);
785 } else if (av_strstart(line, "#EXT-X-PLAYLIST-TYPE:", &ptr)) {
786 ret = ensure_playlist(c, &pls, url);
789 if (!strcmp(ptr, "EVENT"))
790 pls->type = PLS_TYPE_EVENT;
791 else if (!strcmp(ptr, "VOD"))
792 pls->type = PLS_TYPE_VOD;
793 } else if (av_strstart(line, "#EXT-X-MAP:", &ptr)) {
794 struct init_section_info info = {{0}};
795 ret = ensure_playlist(c, &pls, url);
798 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_init_section_args,
800 cur_init_section = new_init_section(pls, &info, url);
801 } else if (av_strstart(line, "#EXT-X-ENDLIST", &ptr)) {
804 } else if (av_strstart(line, "#EXTINF:", &ptr)) {
806 duration = atof(ptr) * AV_TIME_BASE;
807 } else if (av_strstart(line, "#EXT-X-BYTERANGE:", &ptr)) {
808 seg_size = strtoll(ptr, NULL, 10);
809 ptr = strchr(ptr, '@');
811 seg_offset = strtoll(ptr+1, NULL, 10);
812 } else if (av_strstart(line, "#", NULL)) {
814 } else if (line[0]) {
816 if (!new_variant(c, &variant_info, line, url)) {
817 ret = AVERROR(ENOMEM);
825 if (!new_variant(c, 0, url, NULL)) {
826 ret = AVERROR(ENOMEM);
829 pls = c->playlists[c->n_playlists - 1];
831 seg = av_malloc(sizeof(struct segment));
833 ret = AVERROR(ENOMEM);
836 seg->duration = duration;
837 seg->key_type = key_type;
839 memcpy(seg->iv, iv, sizeof(iv));
841 int seq = pls->start_seq_no + pls->n_segments;
842 memset(seg->iv, 0, sizeof(seg->iv));
843 AV_WB32(seg->iv + 12, seq);
846 if (key_type != KEY_NONE) {
847 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, key);
848 seg->key = av_strdup(tmp_str);
851 ret = AVERROR(ENOMEM);
858 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, line);
859 seg->url = av_strdup(tmp_str);
863 ret = AVERROR(ENOMEM);
867 dynarray_add(&pls->segments, &pls->n_segments, seg);
870 seg->size = seg_size;
872 seg->url_offset = seg_offset;
873 seg_offset += seg_size;
880 seg->init_section = cur_init_section;
885 pls->last_load_time = av_gettime_relative();
890 ff_format_io_close(c->ctx, &in);
891 c->ctx->ctx_flags = c->ctx->ctx_flags & ~(unsigned)AVFMTCTX_UNSEEKABLE;
892 if (!c->n_variants || !c->variants[0]->n_playlists ||
893 !(c->variants[0]->playlists[0]->finished ||
894 c->variants[0]->playlists[0]->type == PLS_TYPE_EVENT))
895 c->ctx->ctx_flags |= AVFMTCTX_UNSEEKABLE;
899 static struct segment *current_segment(struct playlist *pls)
901 return pls->segments[pls->cur_seq_no - pls->start_seq_no];
904 static struct segment *next_segment(struct playlist *pls)
906 int n = pls->cur_seq_no - pls->start_seq_no + 1;
907 if (n >= pls->n_segments)
909 return pls->segments[n];
912 static int read_from_url(struct playlist *pls, struct segment *seg,
913 uint8_t *buf, int buf_size)
917 /* limit read if the segment was only a part of a file */
919 buf_size = FFMIN(buf_size, seg->size - pls->cur_seg_offset);
921 ret = avio_read(pls->input, buf, buf_size);
923 av_log(NULL, AV_LOG_ERROR, "Could not read complete segment.\n");
926 pls->cur_seg_offset += ret;
931 /* Parse the raw ID3 data and pass contents to caller */
932 static void parse_id3(AVFormatContext *s, AVIOContext *pb,
933 AVDictionary **metadata, int64_t *dts,
934 ID3v2ExtraMetaAPIC **apic, ID3v2ExtraMeta **extra_meta)
936 static const char id3_priv_owner_ts[] = "com.apple.streaming.transportStreamTimestamp";
937 ID3v2ExtraMeta *meta;
939 ff_id3v2_read_dict(pb, metadata, ID3v2_DEFAULT_MAGIC, extra_meta);
940 for (meta = *extra_meta; meta; meta = meta->next) {
941 if (!strcmp(meta->tag, "PRIV")) {
942 ID3v2ExtraMetaPRIV *priv = meta->data;
943 if (priv->datasize == 8 && !strcmp(priv->owner, id3_priv_owner_ts)) {
944 /* 33-bit MPEG timestamp */
945 int64_t ts = AV_RB64(priv->data);
946 av_log(s, AV_LOG_DEBUG, "HLS ID3 audio timestamp %"PRId64"\n", ts);
947 if ((ts & ~((1ULL << 33) - 1)) == 0)
950 av_log(s, AV_LOG_ERROR, "Invalid HLS ID3 audio timestamp %"PRId64"\n", ts);
952 } else if (!strcmp(meta->tag, "APIC") && apic)
957 /* Check if the ID3 metadata contents have changed */
958 static int id3_has_changed_values(struct playlist *pls, AVDictionary *metadata,
959 ID3v2ExtraMetaAPIC *apic)
961 AVDictionaryEntry *entry = NULL;
962 AVDictionaryEntry *oldentry;
963 /* check that no keys have changed values */
964 while ((entry = av_dict_get(metadata, "", entry, AV_DICT_IGNORE_SUFFIX))) {
965 oldentry = av_dict_get(pls->id3_initial, entry->key, NULL, AV_DICT_MATCH_CASE);
966 if (!oldentry || strcmp(oldentry->value, entry->value) != 0)
970 /* check if apic appeared */
971 if (apic && (pls->ctx->nb_streams != 2 || !pls->ctx->streams[1]->attached_pic.data))
975 int size = pls->ctx->streams[1]->attached_pic.size;
976 if (size != apic->buf->size - AV_INPUT_BUFFER_PADDING_SIZE)
979 if (memcmp(apic->buf->data, pls->ctx->streams[1]->attached_pic.data, size) != 0)
986 /* Parse ID3 data and handle the found data */
987 static void handle_id3(AVIOContext *pb, struct playlist *pls)
989 AVDictionary *metadata = NULL;
990 ID3v2ExtraMetaAPIC *apic = NULL;
991 ID3v2ExtraMeta *extra_meta = NULL;
992 int64_t timestamp = AV_NOPTS_VALUE;
994 parse_id3(pls->ctx, pb, &metadata, ×tamp, &apic, &extra_meta);
996 if (timestamp != AV_NOPTS_VALUE) {
997 pls->id3_mpegts_timestamp = timestamp;
1001 if (!pls->id3_found) {
1002 /* initial ID3 tags */
1003 av_assert0(!pls->id3_deferred_extra);
1006 /* get picture attachment and set text metadata */
1007 if (pls->ctx->nb_streams)
1008 ff_id3v2_parse_apic(pls->ctx, &extra_meta);
1010 /* demuxer not yet opened, defer picture attachment */
1011 pls->id3_deferred_extra = extra_meta;
1013 ff_id3v2_parse_priv_dict(&metadata, &extra_meta);
1014 av_dict_copy(&pls->ctx->metadata, metadata, 0);
1015 pls->id3_initial = metadata;
1018 if (!pls->id3_changed && id3_has_changed_values(pls, metadata, apic)) {
1019 avpriv_report_missing_feature(pls->ctx, "Changing ID3 metadata in HLS audio elementary stream");
1020 pls->id3_changed = 1;
1022 av_dict_free(&metadata);
1025 if (!pls->id3_deferred_extra)
1026 ff_id3v2_free_extra_meta(&extra_meta);
1029 static void intercept_id3(struct playlist *pls, uint8_t *buf,
1030 int buf_size, int *len)
1032 /* intercept id3 tags, we do not want to pass them to the raw
1033 * demuxer on all segment switches */
1035 int id3_buf_pos = 0;
1037 struct segment *seg = current_segment(pls);
1039 /* gather all the id3 tags */
1041 /* see if we can retrieve enough data for ID3 header */
1042 if (*len < ID3v2_HEADER_SIZE && buf_size >= ID3v2_HEADER_SIZE) {
1043 bytes = read_from_url(pls, seg, buf + *len, ID3v2_HEADER_SIZE - *len);
1046 if (bytes == ID3v2_HEADER_SIZE - *len)
1047 /* no EOF yet, so fill the caller buffer again after
1048 * we have stripped the ID3 tags */
1053 } else if (*len <= 0) {
1060 if (*len < ID3v2_HEADER_SIZE)
1063 if (ff_id3v2_match(buf, ID3v2_DEFAULT_MAGIC)) {
1064 int64_t maxsize = seg->size >= 0 ? seg->size : 1024*1024;
1065 int taglen = ff_id3v2_tag_len(buf);
1066 int tag_got_bytes = FFMIN(taglen, *len);
1067 int remaining = taglen - tag_got_bytes;
1069 if (taglen > maxsize) {
1070 av_log(pls->ctx, AV_LOG_ERROR, "Too large HLS ID3 tag (%d > %"PRId64" bytes)\n",
1076 * Copy the id3 tag to our temporary id3 buffer.
1077 * We could read a small id3 tag directly without memcpy, but
1078 * we would still need to copy the large tags, and handling
1079 * both of those cases together with the possibility for multiple
1080 * tags would make the handling a bit complex.
1082 pls->id3_buf = av_fast_realloc(pls->id3_buf, &pls->id3_buf_size, id3_buf_pos + taglen);
1085 memcpy(pls->id3_buf + id3_buf_pos, buf, tag_got_bytes);
1086 id3_buf_pos += tag_got_bytes;
1088 /* strip the intercepted bytes */
1089 *len -= tag_got_bytes;
1090 memmove(buf, buf + tag_got_bytes, *len);
1091 av_log(pls->ctx, AV_LOG_DEBUG, "Stripped %d HLS ID3 bytes\n", tag_got_bytes);
1093 if (remaining > 0) {
1094 /* read the rest of the tag in */
1095 if (read_from_url(pls, seg, pls->id3_buf + id3_buf_pos, remaining) != remaining)
1097 id3_buf_pos += remaining;
1098 av_log(pls->ctx, AV_LOG_DEBUG, "Stripped additional %d HLS ID3 bytes\n", remaining);
1102 /* no more ID3 tags */
1107 /* re-fill buffer for the caller unless EOF */
1108 if (*len >= 0 && (fill_buf || *len == 0)) {
1109 bytes = read_from_url(pls, seg, buf + *len, buf_size - *len);
1111 /* ignore error if we already had some data */
1119 /* Now parse all the ID3 tags */
1120 AVIOContext id3ioctx;
1121 ffio_init_context(&id3ioctx, pls->id3_buf, id3_buf_pos, 0, NULL, NULL, NULL, NULL);
1122 handle_id3(&id3ioctx, pls);
1125 if (pls->is_id3_timestamped == -1)
1126 pls->is_id3_timestamped = (pls->id3_mpegts_timestamp != AV_NOPTS_VALUE);
1129 static int open_input(HLSContext *c, struct playlist *pls, struct segment *seg, AVIOContext **in)
1131 AVDictionary *opts = NULL;
1135 if (c->http_persistent)
1136 av_dict_set(&opts, "multiple_requests", "1", 0);
1138 if (seg->size >= 0) {
1139 /* try to restrict the HTTP request to the part we want
1140 * (if this is in fact a HTTP request) */
1141 av_dict_set_int(&opts, "offset", seg->url_offset, 0);
1142 av_dict_set_int(&opts, "end_offset", seg->url_offset + seg->size, 0);
1145 av_log(pls->parent, AV_LOG_VERBOSE, "HLS request for url '%s', offset %"PRId64", playlist %d\n",
1146 seg->url, seg->url_offset, pls->index);
1148 if (seg->key_type == KEY_NONE) {
1149 ret = open_url(pls->parent, in, seg->url, c->avio_opts, opts, &is_http);
1150 } else if (seg->key_type == KEY_AES_128) {
1151 char iv[33], key[33], url[MAX_URL_SIZE];
1152 if (strcmp(seg->key, pls->key_url)) {
1153 AVIOContext *pb = NULL;
1154 if (open_url(pls->parent, &pb, seg->key, c->avio_opts, opts, NULL) == 0) {
1155 ret = avio_read(pb, pls->key, sizeof(pls->key));
1156 if (ret != sizeof(pls->key)) {
1157 av_log(NULL, AV_LOG_ERROR, "Unable to read key file %s\n",
1160 ff_format_io_close(pls->parent, &pb);
1162 av_log(NULL, AV_LOG_ERROR, "Unable to open key file %s\n",
1165 av_strlcpy(pls->key_url, seg->key, sizeof(pls->key_url));
1167 ff_data_to_hex(iv, seg->iv, sizeof(seg->iv), 0);
1168 ff_data_to_hex(key, pls->key, sizeof(pls->key), 0);
1169 iv[32] = key[32] = '\0';
1170 if (strstr(seg->url, "://"))
1171 snprintf(url, sizeof(url), "crypto+%s", seg->url);
1173 snprintf(url, sizeof(url), "crypto:%s", seg->url);
1175 av_dict_set(&opts, "key", key, 0);
1176 av_dict_set(&opts, "iv", iv, 0);
1178 ret = open_url(pls->parent, in, url, c->avio_opts, opts, &is_http);
1183 } else if (seg->key_type == KEY_SAMPLE_AES) {
1184 av_log(pls->parent, AV_LOG_ERROR,
1185 "SAMPLE-AES encryption is not supported yet\n");
1186 ret = AVERROR_PATCHWELCOME;
1189 ret = AVERROR(ENOSYS);
1191 /* Seek to the requested position. If this was a HTTP request, the offset
1192 * should already be where want it to, but this allows e.g. local testing
1193 * without a HTTP server.
1195 * This is not done for HTTP at all as avio_seek() does internal bookkeeping
1196 * of file offset which is out-of-sync with the actual offset when "offset"
1197 * AVOption is used with http protocol, causing the seek to not be a no-op
1198 * as would be expected. Wrong offset received from the server will not be
1199 * noticed without the call, though.
1201 if (ret == 0 && !is_http && seg->key_type == KEY_NONE && seg->url_offset) {
1202 int64_t seekret = avio_seek(*in, seg->url_offset, SEEK_SET);
1204 av_log(pls->parent, AV_LOG_ERROR, "Unable to seek to offset %"PRId64" of HLS segment '%s'\n", seg->url_offset, seg->url);
1206 ff_format_io_close(pls->parent, in);
1211 av_dict_free(&opts);
1212 pls->cur_seg_offset = 0;
1216 static int update_init_section(struct playlist *pls, struct segment *seg)
1218 static const int max_init_section_size = 1024*1024;
1219 HLSContext *c = pls->parent->priv_data;
1224 if (seg->init_section == pls->cur_init_section)
1227 pls->cur_init_section = NULL;
1229 if (!seg->init_section)
1232 ret = open_input(c, pls, seg->init_section, &pls->input);
1234 av_log(pls->parent, AV_LOG_WARNING,
1235 "Failed to open an initialization section in playlist %d\n",
1240 if (seg->init_section->size >= 0)
1241 sec_size = seg->init_section->size;
1242 else if ((urlsize = avio_size(pls->input)) >= 0)
1245 sec_size = max_init_section_size;
1247 av_log(pls->parent, AV_LOG_DEBUG,
1248 "Downloading an initialization section of size %"PRId64"\n",
1251 sec_size = FFMIN(sec_size, max_init_section_size);
1253 av_fast_malloc(&pls->init_sec_buf, &pls->init_sec_buf_size, sec_size);
1255 ret = read_from_url(pls, seg->init_section, pls->init_sec_buf,
1256 pls->init_sec_buf_size);
1257 ff_format_io_close(pls->parent, &pls->input);
1262 pls->cur_init_section = seg->init_section;
1263 pls->init_sec_data_len = ret;
1264 pls->init_sec_buf_read_offset = 0;
1266 /* spec says audio elementary streams do not have media initialization
1267 * sections, so there should be no ID3 timestamps */
1268 pls->is_id3_timestamped = 0;
1273 static int64_t default_reload_interval(struct playlist *pls)
1275 return pls->n_segments > 0 ?
1276 pls->segments[pls->n_segments - 1]->duration :
1277 pls->target_duration;
1280 static int playlist_needed(struct playlist *pls)
1282 AVFormatContext *s = pls->parent;
1284 int stream_needed = 0;
1287 /* If there is no context or streams yet, the playlist is needed */
1288 if (!pls->ctx || !pls->n_main_streams)
1291 /* check if any of the streams in the playlist are needed */
1292 for (i = 0; i < pls->n_main_streams; i++) {
1293 if (pls->main_streams[i]->discard < AVDISCARD_ALL) {
1299 /* If all streams in the playlist were discarded, the playlist is not
1300 * needed (regardless of whether whole programs are discarded or not). */
1304 /* Otherwise, check if all the programs (variants) this playlist is in are
1305 * discarded. Since all streams in the playlist are part of the same programs
1306 * we can just check the programs of the first stream. */
1308 first_st = pls->main_streams[0]->index;
1310 for (i = 0; i < s->nb_programs; i++) {
1311 AVProgram *program = s->programs[i];
1312 if (program->discard < AVDISCARD_ALL) {
1313 for (j = 0; j < program->nb_stream_indexes; j++) {
1314 if (program->stream_index[j] == first_st) {
1315 /* playlist is in an undiscarded program */
1322 /* some streams were not discarded but all the programs were */
1326 static int read_data(void *opaque, uint8_t *buf, int buf_size)
1328 struct playlist *v = opaque;
1329 HLSContext *c = v->parent->priv_data;
1331 int just_opened = 0;
1332 int reload_count = 0;
1333 struct segment *seg;
1339 if (!v->input || (c->http_persistent && v->input_read_done)) {
1340 int64_t reload_interval;
1342 /* Check that the playlist is still needed before opening a new
1344 v->needed = playlist_needed(v);
1347 av_log(v->parent, AV_LOG_INFO, "No longer receiving playlist %d\n",
1352 /* If this is a live stream and the reload interval has elapsed since
1353 * the last playlist reload, reload the playlists now. */
1354 reload_interval = default_reload_interval(v);
1358 if (reload_count > c->max_reload)
1361 av_gettime_relative() - v->last_load_time >= reload_interval) {
1362 if ((ret = parse_playlist(c, v->url, v, NULL)) < 0) {
1363 if (ret != AVERROR_EXIT)
1364 av_log(v->parent, AV_LOG_WARNING, "Failed to reload playlist %d\n",
1368 /* If we need to reload the playlist again below (if
1369 * there's still no more segments), switch to a reload
1370 * interval of half the target duration. */
1371 reload_interval = v->target_duration / 2;
1373 if (v->cur_seq_no < v->start_seq_no) {
1374 av_log(NULL, AV_LOG_WARNING,
1375 "skipping %d segments ahead, expired from playlists\n",
1376 v->start_seq_no - v->cur_seq_no);
1377 v->cur_seq_no = v->start_seq_no;
1379 if (v->cur_seq_no >= v->start_seq_no + v->n_segments) {
1382 while (av_gettime_relative() - v->last_load_time < reload_interval) {
1383 if (ff_check_interrupt(c->interrupt_callback))
1384 return AVERROR_EXIT;
1385 av_usleep(100*1000);
1387 /* Enough time has elapsed since the last reload */
1391 v->input_read_done = 0;
1392 seg = current_segment(v);
1394 /* load/update Media Initialization Section, if any */
1395 ret = update_init_section(v, seg);
1399 if (c->http_multiple == 1 && v->input_next_requested) {
1400 FFSWAP(AVIOContext *, v->input, v->input_next);
1401 v->input_next_requested = 0;
1404 ret = open_input(c, v, seg, &v->input);
1407 if (ff_check_interrupt(c->interrupt_callback))
1408 return AVERROR_EXIT;
1409 av_log(v->parent, AV_LOG_WARNING, "Failed to open segment %d of playlist %d\n",
1418 if (c->http_multiple == -1) {
1419 uint8_t *http_version_opt = NULL;
1420 int r = av_opt_get(v->input, "http_version", AV_OPT_SEARCH_CHILDREN, &http_version_opt);
1422 c->http_multiple = strncmp((const char *)http_version_opt, "1.1", 3) == 0;
1423 av_freep(&http_version_opt);
1427 seg = next_segment(v);
1428 if (c->http_multiple == 1 && !v->input_next_requested &&
1429 seg && seg->key_type == KEY_NONE && av_strstart(seg->url, "http", NULL)) {
1430 ret = open_input(c, v, seg, &v->input_next);
1432 if (ff_check_interrupt(c->interrupt_callback))
1433 return AVERROR_EXIT;
1434 av_log(v->parent, AV_LOG_WARNING, "Failed to open segment %d of playlist %d\n",
1438 v->input_next_requested = 1;
1442 if (v->init_sec_buf_read_offset < v->init_sec_data_len) {
1443 /* Push init section out first before first actual segment */
1444 int copy_size = FFMIN(v->init_sec_data_len - v->init_sec_buf_read_offset, buf_size);
1445 memcpy(buf, v->init_sec_buf, copy_size);
1446 v->init_sec_buf_read_offset += copy_size;
1450 seg = current_segment(v);
1451 ret = read_from_url(v, seg, buf, buf_size);
1453 if (just_opened && v->is_id3_timestamped != 0) {
1454 /* Intercept ID3 tags here, elementary audio streams are required
1455 * to convey timestamps using them in the beginning of each segment. */
1456 intercept_id3(v, buf, buf_size, &ret);
1461 if (c->http_persistent &&
1462 seg->key_type == KEY_NONE && av_strstart(seg->url, "http", NULL)) {
1463 v->input_read_done = 1;
1465 ff_format_io_close(v->parent, &v->input);
1469 c->cur_seq_no = v->cur_seq_no;
1474 static void add_renditions_to_variant(HLSContext *c, struct variant *var,
1475 enum AVMediaType type, const char *group_id)
1479 for (i = 0; i < c->n_renditions; i++) {
1480 struct rendition *rend = c->renditions[i];
1482 if (rend->type == type && !strcmp(rend->group_id, group_id)) {
1485 /* rendition is an external playlist
1486 * => add the playlist to the variant */
1487 dynarray_add(&var->playlists, &var->n_playlists, rend->playlist);
1489 /* rendition is part of the variant main Media Playlist
1490 * => add the rendition to the main Media Playlist */
1491 dynarray_add(&var->playlists[0]->renditions,
1492 &var->playlists[0]->n_renditions,
1498 static void add_metadata_from_renditions(AVFormatContext *s, struct playlist *pls,
1499 enum AVMediaType type)
1504 for (i = 0; i < pls->n_main_streams; i++) {
1505 AVStream *st = pls->main_streams[i];
1507 if (st->codecpar->codec_type != type)
1510 for (; rend_idx < pls->n_renditions; rend_idx++) {
1511 struct rendition *rend = pls->renditions[rend_idx];
1513 if (rend->type != type)
1516 if (rend->language[0])
1517 av_dict_set(&st->metadata, "language", rend->language, 0);
1519 av_dict_set(&st->metadata, "comment", rend->name, 0);
1521 st->disposition |= rend->disposition;
1523 if (rend_idx >=pls->n_renditions)
1528 /* if timestamp was in valid range: returns 1 and sets seq_no
1529 * if not: returns 0 and sets seq_no to closest segment */
1530 static int find_timestamp_in_playlist(HLSContext *c, struct playlist *pls,
1531 int64_t timestamp, int *seq_no)
1534 int64_t pos = c->first_timestamp == AV_NOPTS_VALUE ?
1535 0 : c->first_timestamp;
1537 if (timestamp < pos) {
1538 *seq_no = pls->start_seq_no;
1542 for (i = 0; i < pls->n_segments; i++) {
1543 int64_t diff = pos + pls->segments[i]->duration - timestamp;
1545 *seq_no = pls->start_seq_no + i;
1548 pos += pls->segments[i]->duration;
1551 *seq_no = pls->start_seq_no + pls->n_segments - 1;
1556 static int select_cur_seq_no(HLSContext *c, struct playlist *pls)
1560 if (!pls->finished && !c->first_packet &&
1561 av_gettime_relative() - pls->last_load_time >= default_reload_interval(pls))
1562 /* reload the playlist since it was suspended */
1563 parse_playlist(c, pls->url, pls, NULL);
1565 /* If playback is already in progress (we are just selecting a new
1566 * playlist) and this is a complete file, find the matching segment
1567 * by counting durations. */
1568 if (pls->finished && c->cur_timestamp != AV_NOPTS_VALUE) {
1569 find_timestamp_in_playlist(c, pls, c->cur_timestamp, &seq_no);
1573 if (!pls->finished) {
1574 if (!c->first_packet && /* we are doing a segment selection during playback */
1575 c->cur_seq_no >= pls->start_seq_no &&
1576 c->cur_seq_no < pls->start_seq_no + pls->n_segments)
1577 /* While spec 3.4.3 says that we cannot assume anything about the
1578 * content at the same sequence number on different playlists,
1579 * in practice this seems to work and doing it otherwise would
1580 * require us to download a segment to inspect its timestamps. */
1581 return c->cur_seq_no;
1583 /* If this is a live stream, start live_start_index segments from the
1585 if (c->live_start_index < 0)
1586 return pls->start_seq_no + FFMAX(pls->n_segments + c->live_start_index, 0);
1588 return pls->start_seq_no + FFMIN(c->live_start_index, pls->n_segments - 1);
1591 /* Otherwise just start on the first segment. */
1592 return pls->start_seq_no;
1595 static int save_avio_options(AVFormatContext *s)
1597 HLSContext *c = s->priv_data;
1598 static const char * const opts[] = {
1599 "headers", "http_proxy", "user_agent", "user-agent", "cookies", "referer", "rw_timeout", NULL };
1600 const char * const * opt = opts;
1605 if (av_opt_get(s->pb, *opt, AV_OPT_SEARCH_CHILDREN | AV_OPT_ALLOW_NULL, &buf) >= 0) {
1606 ret = av_dict_set(&c->avio_opts, *opt, buf,
1607 AV_DICT_DONT_STRDUP_VAL);
1617 static int nested_io_open(AVFormatContext *s, AVIOContext **pb, const char *url,
1618 int flags, AVDictionary **opts)
1620 av_log(s, AV_LOG_ERROR,
1621 "A HLS playlist item '%s' referred to an external file '%s'. "
1622 "Opening this file was forbidden for security reasons\n",
1624 return AVERROR(EPERM);
1627 static void add_stream_to_programs(AVFormatContext *s, struct playlist *pls, AVStream *stream)
1629 HLSContext *c = s->priv_data;
1633 for (i = 0; i < c->n_variants; i++) {
1634 struct variant *v = c->variants[i];
1636 for (j = 0; j < v->n_playlists; j++) {
1637 if (v->playlists[j] != pls)
1640 av_program_add_stream_index(s, i, stream->index);
1643 bandwidth = v->bandwidth;
1644 else if (bandwidth != v->bandwidth)
1645 bandwidth = -1; /* stream in multiple variants with different bandwidths */
1650 av_dict_set_int(&stream->metadata, "variant_bitrate", bandwidth, 0);
1653 static int set_stream_info_from_input_stream(AVStream *st, struct playlist *pls, AVStream *ist)
1657 err = avcodec_parameters_copy(st->codecpar, ist->codecpar);
1661 if (pls->is_id3_timestamped) /* custom timestamps via id3 */
1662 avpriv_set_pts_info(st, 33, 1, MPEG_TIME_BASE);
1664 avpriv_set_pts_info(st, ist->pts_wrap_bits, ist->time_base.num, ist->time_base.den);
1666 st->internal->need_context_update = 1;
1671 /* add new subdemuxer streams to our context, if any */
1672 static int update_streams_from_subdemuxer(AVFormatContext *s, struct playlist *pls)
1676 while (pls->n_main_streams < pls->ctx->nb_streams) {
1677 int ist_idx = pls->n_main_streams;
1678 AVStream *st = avformat_new_stream(s, NULL);
1679 AVStream *ist = pls->ctx->streams[ist_idx];
1682 return AVERROR(ENOMEM);
1684 st->id = pls->index;
1685 dynarray_add(&pls->main_streams, &pls->n_main_streams, st);
1687 add_stream_to_programs(s, pls, st);
1689 err = set_stream_info_from_input_stream(st, pls, ist);
1697 static void update_noheader_flag(AVFormatContext *s)
1699 HLSContext *c = s->priv_data;
1700 int flag_needed = 0;
1703 for (i = 0; i < c->n_playlists; i++) {
1704 struct playlist *pls = c->playlists[i];
1706 if (pls->has_noheader_flag) {
1713 s->ctx_flags |= AVFMTCTX_NOHEADER;
1715 s->ctx_flags &= ~AVFMTCTX_NOHEADER;
1718 static int hls_close(AVFormatContext *s)
1720 HLSContext *c = s->priv_data;
1722 free_playlist_list(c);
1723 free_variant_list(c);
1724 free_rendition_list(c);
1726 av_dict_free(&c->avio_opts);
1727 ff_format_io_close(c->ctx, &c->playlist_pb);
1732 static int hls_read_header(AVFormatContext *s)
1734 HLSContext *c = s->priv_data;
1736 int highest_cur_seq_no = 0;
1739 c->interrupt_callback = &s->interrupt_callback;
1740 c->strict_std_compliance = s->strict_std_compliance;
1742 c->first_packet = 1;
1743 c->first_timestamp = AV_NOPTS_VALUE;
1744 c->cur_timestamp = AV_NOPTS_VALUE;
1746 if ((ret = save_avio_options(s)) < 0)
1749 /* Some HLS servers don't like being sent the range header */
1750 av_dict_set(&c->avio_opts, "seekable", "0", 0);
1752 if ((ret = parse_playlist(c, s->url, NULL, s->pb)) < 0)
1755 if (c->n_variants == 0) {
1756 av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1760 /* If the playlist only contained playlists (Master Playlist),
1761 * parse each individual playlist. */
1762 if (c->n_playlists > 1 || c->playlists[0]->n_segments == 0) {
1763 for (i = 0; i < c->n_playlists; i++) {
1764 struct playlist *pls = c->playlists[i];
1765 if ((ret = parse_playlist(c, pls->url, pls, NULL)) < 0)
1770 if (c->variants[0]->playlists[0]->n_segments == 0) {
1771 av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1776 /* If this isn't a live stream, calculate the total duration of the
1778 if (c->variants[0]->playlists[0]->finished) {
1779 int64_t duration = 0;
1780 for (i = 0; i < c->variants[0]->playlists[0]->n_segments; i++)
1781 duration += c->variants[0]->playlists[0]->segments[i]->duration;
1782 s->duration = duration;
1785 /* Associate renditions with variants */
1786 for (i = 0; i < c->n_variants; i++) {
1787 struct variant *var = c->variants[i];
1789 if (var->audio_group[0])
1790 add_renditions_to_variant(c, var, AVMEDIA_TYPE_AUDIO, var->audio_group);
1791 if (var->video_group[0])
1792 add_renditions_to_variant(c, var, AVMEDIA_TYPE_VIDEO, var->video_group);
1793 if (var->subtitles_group[0])
1794 add_renditions_to_variant(c, var, AVMEDIA_TYPE_SUBTITLE, var->subtitles_group);
1797 /* Create a program for each variant */
1798 for (i = 0; i < c->n_variants; i++) {
1799 struct variant *v = c->variants[i];
1802 program = av_new_program(s, i);
1805 av_dict_set_int(&program->metadata, "variant_bitrate", v->bandwidth, 0);
1808 /* Select the starting segments */
1809 for (i = 0; i < c->n_playlists; i++) {
1810 struct playlist *pls = c->playlists[i];
1812 if (pls->n_segments == 0)
1815 pls->cur_seq_no = select_cur_seq_no(c, pls);
1816 highest_cur_seq_no = FFMAX(highest_cur_seq_no, pls->cur_seq_no);
1819 /* Open the demuxer for each playlist */
1820 for (i = 0; i < c->n_playlists; i++) {
1821 struct playlist *pls = c->playlists[i];
1822 AVInputFormat *in_fmt = NULL;
1824 if (!(pls->ctx = avformat_alloc_context())) {
1825 ret = AVERROR(ENOMEM);
1829 if (pls->n_segments == 0)
1837 * If this is a live stream and this playlist looks like it is one segment
1838 * behind, try to sync it up so that every substream starts at the same
1839 * time position (so e.g. avformat_find_stream_info() will see packets from
1840 * all active streams within the first few seconds). This is not very generic,
1841 * though, as the sequence numbers are technically independent.
1843 if (!pls->finished && pls->cur_seq_no == highest_cur_seq_no - 1 &&
1844 highest_cur_seq_no < pls->start_seq_no + pls->n_segments) {
1845 pls->cur_seq_no = highest_cur_seq_no;
1848 pls->read_buffer = av_malloc(INITIAL_BUFFER_SIZE);
1849 if (!pls->read_buffer){
1850 ret = AVERROR(ENOMEM);
1851 avformat_free_context(pls->ctx);
1855 ffio_init_context(&pls->pb, pls->read_buffer, INITIAL_BUFFER_SIZE, 0, pls,
1856 read_data, NULL, NULL);
1857 pls->pb.seekable = 0;
1858 ret = av_probe_input_buffer(&pls->pb, &in_fmt, pls->segments[0]->url,
1861 /* Free the ctx - it isn't initialized properly at this point,
1862 * so avformat_close_input shouldn't be called. If
1863 * avformat_open_input fails below, it frees and zeros the
1864 * context, so it doesn't need any special treatment like this. */
1865 av_log(s, AV_LOG_ERROR, "Error when loading first segment '%s'\n", pls->segments[0]->url);
1866 avformat_free_context(pls->ctx);
1870 pls->ctx->pb = &pls->pb;
1871 pls->ctx->io_open = nested_io_open;
1872 pls->ctx->flags |= s->flags & ~AVFMT_FLAG_CUSTOM_IO;
1874 if ((ret = ff_copy_whiteblacklists(pls->ctx, s)) < 0)
1877 ret = avformat_open_input(&pls->ctx, pls->segments[0]->url, in_fmt, NULL);
1881 if (pls->id3_deferred_extra && pls->ctx->nb_streams == 1) {
1882 ff_id3v2_parse_apic(pls->ctx, &pls->id3_deferred_extra);
1883 avformat_queue_attached_pictures(pls->ctx);
1884 ff_id3v2_parse_priv(pls->ctx, &pls->id3_deferred_extra);
1885 ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
1886 pls->id3_deferred_extra = NULL;
1889 if (pls->is_id3_timestamped == -1)
1890 av_log(s, AV_LOG_WARNING, "No expected HTTP requests have been made\n");
1893 * For ID3 timestamped raw audio streams we need to detect the packet
1894 * durations to calculate timestamps in fill_timing_for_id3_timestamped_stream(),
1895 * but for other streams we can rely on our user calling avformat_find_stream_info()
1896 * on us if they want to.
1898 if (pls->is_id3_timestamped) {
1899 ret = avformat_find_stream_info(pls->ctx, NULL);
1904 pls->has_noheader_flag = !!(pls->ctx->ctx_flags & AVFMTCTX_NOHEADER);
1906 /* Create new AVStreams for each stream in this playlist */
1907 ret = update_streams_from_subdemuxer(s, pls);
1912 * Copy any metadata from playlist to main streams, but do not set
1915 if (pls->n_main_streams)
1916 av_dict_copy(&pls->main_streams[0]->metadata, pls->ctx->metadata, 0);
1918 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_AUDIO);
1919 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_VIDEO);
1920 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_SUBTITLE);
1923 update_noheader_flag(s);
1931 static int recheck_discard_flags(AVFormatContext *s, int first)
1933 HLSContext *c = s->priv_data;
1937 /* Check if any new streams are needed */
1938 for (i = 0; i < c->n_playlists; i++) {
1939 struct playlist *pls = c->playlists[i];
1941 cur_needed = playlist_needed(c->playlists[i]);
1943 if (cur_needed && !pls->needed) {
1946 pls->cur_seq_no = select_cur_seq_no(c, pls);
1947 pls->pb.eof_reached = 0;
1948 if (c->cur_timestamp != AV_NOPTS_VALUE) {
1950 pls->seek_timestamp = c->cur_timestamp;
1951 pls->seek_flags = AVSEEK_FLAG_ANY;
1952 pls->seek_stream_index = -1;
1954 av_log(s, AV_LOG_INFO, "Now receiving playlist %d, segment %d\n", i, pls->cur_seq_no);
1955 } else if (first && !cur_needed && pls->needed) {
1957 ff_format_io_close(pls->parent, &pls->input);
1958 pls->input_read_done = 0;
1959 if (pls->input_next)
1960 ff_format_io_close(pls->parent, &pls->input_next);
1961 pls->input_next_requested = 0;
1964 av_log(s, AV_LOG_INFO, "No longer receiving playlist %d\n", i);
1970 static void fill_timing_for_id3_timestamped_stream(struct playlist *pls)
1972 if (pls->id3_offset >= 0) {
1973 pls->pkt.dts = pls->id3_mpegts_timestamp +
1974 av_rescale_q(pls->id3_offset,
1975 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1977 if (pls->pkt.duration)
1978 pls->id3_offset += pls->pkt.duration;
1980 pls->id3_offset = -1;
1982 /* there have been packets with unknown duration
1983 * since the last id3 tag, should not normally happen */
1984 pls->pkt.dts = AV_NOPTS_VALUE;
1987 if (pls->pkt.duration)
1988 pls->pkt.duration = av_rescale_q(pls->pkt.duration,
1989 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1992 pls->pkt.pts = AV_NOPTS_VALUE;
1995 static AVRational get_timebase(struct playlist *pls)
1997 if (pls->is_id3_timestamped)
1998 return MPEG_TIME_BASE_Q;
2000 return pls->ctx->streams[pls->pkt.stream_index]->time_base;
2003 static int compare_ts_with_wrapdetect(int64_t ts_a, struct playlist *pls_a,
2004 int64_t ts_b, struct playlist *pls_b)
2006 int64_t scaled_ts_a = av_rescale_q(ts_a, get_timebase(pls_a), MPEG_TIME_BASE_Q);
2007 int64_t scaled_ts_b = av_rescale_q(ts_b, get_timebase(pls_b), MPEG_TIME_BASE_Q);
2009 return av_compare_mod(scaled_ts_a, scaled_ts_b, 1LL << 33);
2012 static int hls_read_packet(AVFormatContext *s, AVPacket *pkt)
2014 HLSContext *c = s->priv_data;
2015 int ret, i, minplaylist = -1;
2017 recheck_discard_flags(s, c->first_packet);
2018 c->first_packet = 0;
2020 for (i = 0; i < c->n_playlists; i++) {
2021 struct playlist *pls = c->playlists[i];
2022 /* Make sure we've got one buffered packet from each open playlist
2024 if (pls->needed && !pls->pkt.data) {
2028 ret = av_read_frame(pls->ctx, &pls->pkt);
2030 if (!avio_feof(&pls->pb) && ret != AVERROR_EOF)
2032 reset_packet(&pls->pkt);
2035 /* stream_index check prevents matching picture attachments etc. */
2036 if (pls->is_id3_timestamped && pls->pkt.stream_index == 0) {
2037 /* audio elementary streams are id3 timestamped */
2038 fill_timing_for_id3_timestamped_stream(pls);
2041 if (c->first_timestamp == AV_NOPTS_VALUE &&
2042 pls->pkt.dts != AV_NOPTS_VALUE)
2043 c->first_timestamp = av_rescale_q(pls->pkt.dts,
2044 get_timebase(pls), AV_TIME_BASE_Q);
2047 if (pls->seek_timestamp == AV_NOPTS_VALUE)
2050 if (pls->seek_stream_index < 0 ||
2051 pls->seek_stream_index == pls->pkt.stream_index) {
2053 if (pls->pkt.dts == AV_NOPTS_VALUE) {
2054 pls->seek_timestamp = AV_NOPTS_VALUE;
2058 tb = get_timebase(pls);
2059 ts_diff = av_rescale_rnd(pls->pkt.dts, AV_TIME_BASE,
2060 tb.den, AV_ROUND_DOWN) -
2061 pls->seek_timestamp;
2062 if (ts_diff >= 0 && (pls->seek_flags & AVSEEK_FLAG_ANY ||
2063 pls->pkt.flags & AV_PKT_FLAG_KEY)) {
2064 pls->seek_timestamp = AV_NOPTS_VALUE;
2068 av_packet_unref(&pls->pkt);
2069 reset_packet(&pls->pkt);
2072 /* Check if this stream has the packet with the lowest dts */
2073 if (pls->pkt.data) {
2074 struct playlist *minpls = minplaylist < 0 ?
2075 NULL : c->playlists[minplaylist];
2076 if (minplaylist < 0) {
2079 int64_t dts = pls->pkt.dts;
2080 int64_t mindts = minpls->pkt.dts;
2082 if (dts == AV_NOPTS_VALUE ||
2083 (mindts != AV_NOPTS_VALUE && compare_ts_with_wrapdetect(dts, pls, mindts, minpls) < 0))
2089 /* If we got a packet, return it */
2090 if (minplaylist >= 0) {
2091 struct playlist *pls = c->playlists[minplaylist];
2095 ret = update_streams_from_subdemuxer(s, pls);
2097 av_packet_unref(&pls->pkt);
2098 reset_packet(&pls->pkt);
2102 // If sub-demuxer reports updated metadata, copy it to the first stream
2103 // and set its AVSTREAM_EVENT_FLAG_METADATA_UPDATED flag.
2104 if (pls->ctx->event_flags & AVFMT_EVENT_FLAG_METADATA_UPDATED) {
2105 if (pls->n_main_streams) {
2106 st = pls->main_streams[0];
2107 av_dict_copy(&st->metadata, pls->ctx->metadata, 0);
2108 st->event_flags |= AVSTREAM_EVENT_FLAG_METADATA_UPDATED;
2110 pls->ctx->event_flags &= ~AVFMT_EVENT_FLAG_METADATA_UPDATED;
2113 /* check if noheader flag has been cleared by the subdemuxer */
2114 if (pls->has_noheader_flag && !(pls->ctx->ctx_flags & AVFMTCTX_NOHEADER)) {
2115 pls->has_noheader_flag = 0;
2116 update_noheader_flag(s);
2119 if (pls->pkt.stream_index >= pls->n_main_streams) {
2120 av_log(s, AV_LOG_ERROR, "stream index inconsistency: index %d, %d main streams, %d subdemuxer streams\n",
2121 pls->pkt.stream_index, pls->n_main_streams, pls->ctx->nb_streams);
2122 av_packet_unref(&pls->pkt);
2123 reset_packet(&pls->pkt);
2127 ist = pls->ctx->streams[pls->pkt.stream_index];
2128 st = pls->main_streams[pls->pkt.stream_index];
2131 pkt->stream_index = st->index;
2132 reset_packet(&c->playlists[minplaylist]->pkt);
2134 if (pkt->dts != AV_NOPTS_VALUE)
2135 c->cur_timestamp = av_rescale_q(pkt->dts,
2139 /* There may be more situations where this would be useful, but this at least
2140 * handles newly probed codecs properly (i.e. request_probe by mpegts). */
2141 if (ist->codecpar->codec_id != st->codecpar->codec_id) {
2142 ret = set_stream_info_from_input_stream(st, pls, ist);
2144 av_packet_unref(pkt);
2154 static int hls_read_seek(AVFormatContext *s, int stream_index,
2155 int64_t timestamp, int flags)
2157 HLSContext *c = s->priv_data;
2158 struct playlist *seek_pls = NULL;
2161 int stream_subdemuxer_index;
2162 int64_t first_timestamp, seek_timestamp, duration;
2164 if ((flags & AVSEEK_FLAG_BYTE) || (c->ctx->ctx_flags & AVFMTCTX_UNSEEKABLE))
2165 return AVERROR(ENOSYS);
2167 first_timestamp = c->first_timestamp == AV_NOPTS_VALUE ?
2168 0 : c->first_timestamp;
2170 seek_timestamp = av_rescale_rnd(timestamp, AV_TIME_BASE,
2171 s->streams[stream_index]->time_base.den,
2172 flags & AVSEEK_FLAG_BACKWARD ?
2173 AV_ROUND_DOWN : AV_ROUND_UP);
2175 duration = s->duration == AV_NOPTS_VALUE ?
2178 if (0 < duration && duration < seek_timestamp - first_timestamp)
2179 return AVERROR(EIO);
2181 /* find the playlist with the specified stream */
2182 for (i = 0; i < c->n_playlists; i++) {
2183 struct playlist *pls = c->playlists[i];
2184 for (j = 0; j < pls->n_main_streams; j++) {
2185 if (pls->main_streams[j] == s->streams[stream_index]) {
2187 stream_subdemuxer_index = j;
2192 /* check if the timestamp is valid for the playlist with the
2193 * specified stream index */
2194 if (!seek_pls || !find_timestamp_in_playlist(c, seek_pls, seek_timestamp, &seq_no))
2195 return AVERROR(EIO);
2197 /* set segment now so we do not need to search again below */
2198 seek_pls->cur_seq_no = seq_no;
2199 seek_pls->seek_stream_index = stream_subdemuxer_index;
2201 for (i = 0; i < c->n_playlists; i++) {
2203 struct playlist *pls = c->playlists[i];
2205 ff_format_io_close(pls->parent, &pls->input);
2206 pls->input_read_done = 0;
2207 if (pls->input_next)
2208 ff_format_io_close(pls->parent, &pls->input_next);
2209 pls->input_next_requested = 0;
2210 av_packet_unref(&pls->pkt);
2211 reset_packet(&pls->pkt);
2212 pls->pb.eof_reached = 0;
2213 /* Clear any buffered data */
2214 pls->pb.buf_end = pls->pb.buf_ptr = pls->pb.buffer;
2215 /* Reset the pos, to let the mpegts demuxer know we've seeked. */
2217 /* Flush the packet queue of the subdemuxer. */
2218 ff_read_frame_flush(pls->ctx);
2220 pls->seek_timestamp = seek_timestamp;
2221 pls->seek_flags = flags;
2223 if (pls != seek_pls) {
2224 /* set closest segment seq_no for playlists not handled above */
2225 find_timestamp_in_playlist(c, pls, seek_timestamp, &pls->cur_seq_no);
2226 /* seek the playlist to the given position without taking
2227 * keyframes into account since this playlist does not have the
2228 * specified stream where we should look for the keyframes */
2229 pls->seek_stream_index = -1;
2230 pls->seek_flags |= AVSEEK_FLAG_ANY;
2234 c->cur_timestamp = seek_timestamp;
2239 static int hls_probe(AVProbeData *p)
2241 /* Require #EXTM3U at the start, and either one of the ones below
2242 * somewhere for a proper match. */
2243 if (strncmp(p->buf, "#EXTM3U", 7))
2246 if (strstr(p->buf, "#EXT-X-STREAM-INF:") ||
2247 strstr(p->buf, "#EXT-X-TARGETDURATION:") ||
2248 strstr(p->buf, "#EXT-X-MEDIA-SEQUENCE:"))
2249 return AVPROBE_SCORE_MAX;
2253 #define OFFSET(x) offsetof(HLSContext, x)
2254 #define FLAGS AV_OPT_FLAG_DECODING_PARAM
2255 static const AVOption hls_options[] = {
2256 {"live_start_index", "segment index to start live streams at (negative values are from the end)",
2257 OFFSET(live_start_index), AV_OPT_TYPE_INT, {.i64 = -3}, INT_MIN, INT_MAX, FLAGS},
2258 {"allowed_extensions", "List of file extensions that hls is allowed to access",
2259 OFFSET(allowed_extensions), AV_OPT_TYPE_STRING,
2260 {.str = "3gp,aac,avi,flac,mkv,m3u8,m4a,m4s,m4v,mpg,mov,mp2,mp3,mp4,mpeg,mpegts,ogg,ogv,oga,ts,vob,wav"},
2261 INT_MIN, INT_MAX, FLAGS},
2262 {"max_reload", "Maximum number of times a insufficient list is attempted to be reloaded",
2263 OFFSET(max_reload), AV_OPT_TYPE_INT, {.i64 = 1000}, 0, INT_MAX, FLAGS},
2264 {"http_persistent", "Use persistent HTTP connections",
2265 OFFSET(http_persistent), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, FLAGS },
2266 {"http_multiple", "Use multiple HTTP connections for fetching segments",
2267 OFFSET(http_multiple), AV_OPT_TYPE_BOOL, {.i64 = -1}, -1, 1, FLAGS},
2271 static const AVClass hls_class = {
2272 .class_name = "hls,applehttp",
2273 .item_name = av_default_item_name,
2274 .option = hls_options,
2275 .version = LIBAVUTIL_VERSION_INT,
2278 AVInputFormat ff_hls_demuxer = {
2279 .name = "hls,applehttp",
2280 .long_name = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
2281 .priv_class = &hls_class,
2282 .priv_data_size = sizeof(HLSContext),
2283 .flags = AVFMT_NOGENSEARCH,
2284 .read_probe = hls_probe,
2285 .read_header = hls_read_header,
2286 .read_packet = hls_read_packet,
2287 .read_close = hls_close,
2288 .read_seek = hls_read_seek,