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 "libavutil/avstring.h"
30 #include "libavutil/avassert.h"
31 #include "libavutil/intreadwrite.h"
32 #include "libavutil/mathematics.h"
33 #include "libavutil/opt.h"
34 #include "libavutil/dict.h"
35 #include "libavutil/time.h"
38 #include "avio_internal.h"
41 #define INITIAL_BUFFER_SIZE 32768
43 #define MAX_FIELD_LEN 64
44 #define MAX_CHARACTERISTICS_LEN 512
46 #define MPEG_TIME_BASE 90000
47 #define MPEG_TIME_BASE_Q (AVRational){1, MPEG_TIME_BASE}
50 * An apple http stream consists of a playlist with media segment files,
51 * played sequentially. There may be several playlists with the same
52 * video content, in different bandwidth variants, that are played in
53 * parallel (preferably only one bandwidth variant at a time). In this case,
54 * the user supplied the url to a main playlist that only lists the variant
57 * If the main playlist doesn't point at any variants, we still create
58 * one anonymous toplevel variant for this, to maintain the structure.
73 enum KeyType key_type;
75 /* associated Media Initialization Section, treated as a segment */
76 struct segment *init_section;
88 * Each playlist has its own demuxer. If it currently is active,
89 * it has an open AVIOContext too, and potentially an AVPacket
90 * containing the next packet from this stream.
93 char url[MAX_URL_SIZE];
97 AVFormatContext *parent;
101 int has_noheader_flag;
103 /* main demuxer streams associated with this playlist
104 * indexed by the subdemuxer stream indexes */
105 AVStream **main_streams;
109 enum PlaylistType type;
110 int64_t target_duration;
113 struct segment **segments;
116 int64_t cur_seg_offset;
117 int64_t last_load_time;
119 /* Currently active Media Initialization Section */
120 struct segment *cur_init_section;
121 uint8_t *init_sec_buf;
122 unsigned int init_sec_buf_size;
123 unsigned int init_sec_data_len;
124 unsigned int init_sec_buf_read_offset;
126 char key_url[MAX_URL_SIZE];
129 /* ID3 timestamp handling (elementary audio streams have ID3 timestamps
130 * (and possibly other ID3 tags) in the beginning of each segment) */
131 int is_id3_timestamped; /* -1: not yet known */
132 int64_t id3_mpegts_timestamp; /* in mpegts tb */
133 int64_t id3_offset; /* in stream original tb */
134 uint8_t* id3_buf; /* temp buffer for id3 parsing */
135 unsigned int id3_buf_size;
136 AVDictionary *id3_initial; /* data from first id3 tag */
137 int id3_found; /* ID3 tag found at some point */
138 int id3_changed; /* ID3 tag data has changed at some point */
139 ID3v2ExtraMeta *id3_deferred_extra; /* stored here until subdemuxer is opened */
141 int64_t seek_timestamp;
143 int seek_stream_index; /* into subdemuxer stream array */
145 /* Renditions associated with this playlist, if any.
146 * Alternative rendition playlists have a single rendition associated
147 * with them, and variant main Media Playlists may have
148 * multiple (playlist-less) renditions associated with them. */
150 struct rendition **renditions;
152 /* Media Initialization Sections (EXT-X-MAP) associated with this
153 * playlist, if any. */
155 struct segment **init_sections;
159 * Renditions are e.g. alternative subtitle or audio streams.
160 * The rendition may either be an external playlist or it may be
161 * contained in the main Media Playlist of the variant (in which case
165 enum AVMediaType type;
166 struct playlist *playlist;
167 char group_id[MAX_FIELD_LEN];
168 char language[MAX_FIELD_LEN];
169 char name[MAX_FIELD_LEN];
176 /* every variant contains at least the main Media Playlist in index 0 */
178 struct playlist **playlists;
180 char audio_group[MAX_FIELD_LEN];
181 char video_group[MAX_FIELD_LEN];
182 char subtitles_group[MAX_FIELD_LEN];
185 typedef struct HLSContext {
187 AVFormatContext *ctx;
189 struct variant **variants;
191 struct playlist **playlists;
193 struct rendition **renditions;
196 int live_start_index;
198 int64_t first_timestamp;
199 int64_t cur_timestamp;
200 AVIOInterruptCB *interrupt_callback;
201 char *user_agent; ///< holds HTTP user agent set as an AVOption to the HTTP protocol context
202 char *cookies; ///< holds HTTP cookie values set in either the initial response or as an AVOption to the HTTP protocol context
203 char *headers; ///< holds HTTP headers set as an AVOption to the HTTP protocol context
204 char *http_proxy; ///< holds the address of the HTTP proxy server
205 AVDictionary *avio_opts;
206 int strict_std_compliance;
207 char *allowed_extensions;
211 static int read_chomp_line(AVIOContext *s, char *buf, int maxlen)
213 int len = ff_get_line(s, buf, maxlen);
214 while (len > 0 && av_isspace(buf[len - 1]))
219 static void free_segment_list(struct playlist *pls)
222 for (i = 0; i < pls->n_segments; i++) {
223 av_freep(&pls->segments[i]->key);
224 av_freep(&pls->segments[i]->url);
225 av_freep(&pls->segments[i]);
227 av_freep(&pls->segments);
231 static void free_init_section_list(struct playlist *pls)
234 for (i = 0; i < pls->n_init_sections; i++) {
235 av_freep(&pls->init_sections[i]->url);
236 av_freep(&pls->init_sections[i]);
238 av_freep(&pls->init_sections);
239 pls->n_init_sections = 0;
242 static void free_playlist_list(HLSContext *c)
245 for (i = 0; i < c->n_playlists; i++) {
246 struct playlist *pls = c->playlists[i];
247 free_segment_list(pls);
248 free_init_section_list(pls);
249 av_freep(&pls->main_streams);
250 av_freep(&pls->renditions);
251 av_freep(&pls->id3_buf);
252 av_dict_free(&pls->id3_initial);
253 ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
254 av_freep(&pls->init_sec_buf);
255 av_packet_unref(&pls->pkt);
256 av_freep(&pls->pb.buffer);
258 ff_format_io_close(c->ctx, &pls->input);
261 avformat_close_input(&pls->ctx);
265 av_freep(&c->playlists);
266 av_freep(&c->cookies);
267 av_freep(&c->user_agent);
268 av_freep(&c->headers);
269 av_freep(&c->http_proxy);
273 static void free_variant_list(HLSContext *c)
276 for (i = 0; i < c->n_variants; i++) {
277 struct variant *var = c->variants[i];
278 av_freep(&var->playlists);
281 av_freep(&c->variants);
285 static void free_rendition_list(HLSContext *c)
288 for (i = 0; i < c->n_renditions; i++)
289 av_freep(&c->renditions[i]);
290 av_freep(&c->renditions);
295 * Used to reset a statically allocated AVPacket to a clean slate,
296 * containing no data.
298 static void reset_packet(AVPacket *pkt)
304 static struct playlist *new_playlist(HLSContext *c, const char *url,
307 struct playlist *pls = av_mallocz(sizeof(struct playlist));
310 reset_packet(&pls->pkt);
311 ff_make_absolute_url(pls->url, sizeof(pls->url), base, url);
312 pls->seek_timestamp = AV_NOPTS_VALUE;
314 pls->is_id3_timestamped = -1;
315 pls->id3_mpegts_timestamp = AV_NOPTS_VALUE;
317 dynarray_add(&c->playlists, &c->n_playlists, pls);
321 struct variant_info {
323 /* variant group ids: */
324 char audio[MAX_FIELD_LEN];
325 char video[MAX_FIELD_LEN];
326 char subtitles[MAX_FIELD_LEN];
329 static struct variant *new_variant(HLSContext *c, struct variant_info *info,
330 const char *url, const char *base)
333 struct playlist *pls;
335 pls = new_playlist(c, url, base);
339 var = av_mallocz(sizeof(struct variant));
344 var->bandwidth = atoi(info->bandwidth);
345 strcpy(var->audio_group, info->audio);
346 strcpy(var->video_group, info->video);
347 strcpy(var->subtitles_group, info->subtitles);
350 dynarray_add(&c->variants, &c->n_variants, var);
351 dynarray_add(&var->playlists, &var->n_playlists, pls);
355 static void handle_variant_args(struct variant_info *info, const char *key,
356 int key_len, char **dest, int *dest_len)
358 if (!strncmp(key, "BANDWIDTH=", key_len)) {
359 *dest = info->bandwidth;
360 *dest_len = sizeof(info->bandwidth);
361 } else if (!strncmp(key, "AUDIO=", key_len)) {
363 *dest_len = sizeof(info->audio);
364 } else if (!strncmp(key, "VIDEO=", key_len)) {
366 *dest_len = sizeof(info->video);
367 } else if (!strncmp(key, "SUBTITLES=", key_len)) {
368 *dest = info->subtitles;
369 *dest_len = sizeof(info->subtitles);
374 char uri[MAX_URL_SIZE];
379 static void handle_key_args(struct key_info *info, const char *key,
380 int key_len, char **dest, int *dest_len)
382 if (!strncmp(key, "METHOD=", key_len)) {
383 *dest = info->method;
384 *dest_len = sizeof(info->method);
385 } else if (!strncmp(key, "URI=", key_len)) {
387 *dest_len = sizeof(info->uri);
388 } else if (!strncmp(key, "IV=", key_len)) {
390 *dest_len = sizeof(info->iv);
394 struct init_section_info {
395 char uri[MAX_URL_SIZE];
399 static struct segment *new_init_section(struct playlist *pls,
400 struct init_section_info *info,
401 const char *url_base)
405 char tmp_str[MAX_URL_SIZE];
410 sec = av_mallocz(sizeof(*sec));
414 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url_base, info->uri);
415 sec->url = av_strdup(tmp_str);
421 if (info->byterange[0]) {
422 sec->size = strtoll(info->byterange, NULL, 10);
423 ptr = strchr(info->byterange, '@');
425 sec->url_offset = strtoll(ptr+1, NULL, 10);
427 /* the entire file is the init section */
431 dynarray_add(&pls->init_sections, &pls->n_init_sections, sec);
436 static void handle_init_section_args(struct init_section_info *info, const char *key,
437 int key_len, char **dest, int *dest_len)
439 if (!strncmp(key, "URI=", key_len)) {
441 *dest_len = sizeof(info->uri);
442 } else if (!strncmp(key, "BYTERANGE=", key_len)) {
443 *dest = info->byterange;
444 *dest_len = sizeof(info->byterange);
448 struct rendition_info {
450 char uri[MAX_URL_SIZE];
451 char group_id[MAX_FIELD_LEN];
452 char language[MAX_FIELD_LEN];
453 char assoc_language[MAX_FIELD_LEN];
454 char name[MAX_FIELD_LEN];
457 char characteristics[MAX_CHARACTERISTICS_LEN];
460 static struct rendition *new_rendition(HLSContext *c, struct rendition_info *info,
461 const char *url_base)
463 struct rendition *rend;
464 enum AVMediaType type = AVMEDIA_TYPE_UNKNOWN;
465 char *characteristic;
469 if (!strcmp(info->type, "AUDIO"))
470 type = AVMEDIA_TYPE_AUDIO;
471 else if (!strcmp(info->type, "VIDEO"))
472 type = AVMEDIA_TYPE_VIDEO;
473 else if (!strcmp(info->type, "SUBTITLES"))
474 type = AVMEDIA_TYPE_SUBTITLE;
475 else if (!strcmp(info->type, "CLOSED-CAPTIONS"))
476 /* CLOSED-CAPTIONS is ignored since we do not support CEA-608 CC in
477 * AVC SEI RBSP anyway */
480 if (type == AVMEDIA_TYPE_UNKNOWN)
483 /* URI is mandatory for subtitles as per spec */
484 if (type == AVMEDIA_TYPE_SUBTITLE && !info->uri[0])
487 /* TODO: handle subtitles (each segment has to parsed separately) */
488 if (c->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL)
489 if (type == AVMEDIA_TYPE_SUBTITLE)
492 rend = av_mallocz(sizeof(struct rendition));
496 dynarray_add(&c->renditions, &c->n_renditions, rend);
499 strcpy(rend->group_id, info->group_id);
500 strcpy(rend->language, info->language);
501 strcpy(rend->name, info->name);
503 /* add the playlist if this is an external rendition */
505 rend->playlist = new_playlist(c, info->uri, url_base);
507 dynarray_add(&rend->playlist->renditions,
508 &rend->playlist->n_renditions, rend);
511 if (info->assoc_language[0]) {
512 int langlen = strlen(rend->language);
513 if (langlen < sizeof(rend->language) - 3) {
514 rend->language[langlen] = ',';
515 strncpy(rend->language + langlen + 1, info->assoc_language,
516 sizeof(rend->language) - langlen - 2);
520 if (!strcmp(info->defaultr, "YES"))
521 rend->disposition |= AV_DISPOSITION_DEFAULT;
522 if (!strcmp(info->forced, "YES"))
523 rend->disposition |= AV_DISPOSITION_FORCED;
525 chr_ptr = info->characteristics;
526 while ((characteristic = av_strtok(chr_ptr, ",", &saveptr))) {
527 if (!strcmp(characteristic, "public.accessibility.describes-music-and-sound"))
528 rend->disposition |= AV_DISPOSITION_HEARING_IMPAIRED;
529 else if (!strcmp(characteristic, "public.accessibility.describes-video"))
530 rend->disposition |= AV_DISPOSITION_VISUAL_IMPAIRED;
538 static void handle_rendition_args(struct rendition_info *info, const char *key,
539 int key_len, char **dest, int *dest_len)
541 if (!strncmp(key, "TYPE=", key_len)) {
543 *dest_len = sizeof(info->type);
544 } else if (!strncmp(key, "URI=", key_len)) {
546 *dest_len = sizeof(info->uri);
547 } else if (!strncmp(key, "GROUP-ID=", key_len)) {
548 *dest = info->group_id;
549 *dest_len = sizeof(info->group_id);
550 } else if (!strncmp(key, "LANGUAGE=", key_len)) {
551 *dest = info->language;
552 *dest_len = sizeof(info->language);
553 } else if (!strncmp(key, "ASSOC-LANGUAGE=", key_len)) {
554 *dest = info->assoc_language;
555 *dest_len = sizeof(info->assoc_language);
556 } else if (!strncmp(key, "NAME=", key_len)) {
558 *dest_len = sizeof(info->name);
559 } else if (!strncmp(key, "DEFAULT=", key_len)) {
560 *dest = info->defaultr;
561 *dest_len = sizeof(info->defaultr);
562 } else if (!strncmp(key, "FORCED=", key_len)) {
563 *dest = info->forced;
564 *dest_len = sizeof(info->forced);
565 } else if (!strncmp(key, "CHARACTERISTICS=", key_len)) {
566 *dest = info->characteristics;
567 *dest_len = sizeof(info->characteristics);
571 * - AUTOSELECT: client may autoselect based on e.g. system language
572 * - INSTREAM-ID: EIA-608 closed caption number ("CC1".."CC4")
576 /* used by parse_playlist to allocate a new variant+playlist when the
577 * playlist is detected to be a Media Playlist (not Master Playlist)
578 * and we have no parent Master Playlist (parsing of which would have
579 * allocated the variant and playlist already)
580 * *pls == NULL => Master Playlist or parentless Media Playlist
581 * *pls != NULL => parented Media Playlist, playlist+variant allocated */
582 static int ensure_playlist(HLSContext *c, struct playlist **pls, const char *url)
586 if (!new_variant(c, NULL, url, NULL))
587 return AVERROR(ENOMEM);
588 *pls = c->playlists[c->n_playlists - 1];
592 static void update_options(char **dest, const char *name, void *src)
595 av_opt_get(src, name, AV_OPT_SEARCH_CHILDREN, (uint8_t**)dest);
596 if (*dest && !strlen(*dest))
600 static int open_url(AVFormatContext *s, AVIOContext **pb, const char *url,
601 AVDictionary *opts, AVDictionary *opts2, int *is_http)
603 HLSContext *c = s->priv_data;
604 AVDictionary *tmp = NULL;
605 const char *proto_name = NULL;
608 av_dict_copy(&tmp, opts, 0);
609 av_dict_copy(&tmp, opts2, 0);
611 if (av_strstart(url, "crypto", NULL)) {
612 if (url[6] == '+' || url[6] == ':')
613 proto_name = avio_find_protocol_name(url + 7);
617 proto_name = avio_find_protocol_name(url);
620 return AVERROR_INVALIDDATA;
622 // only http(s) & file are allowed
623 if (av_strstart(proto_name, "file", NULL)) {
624 if (strcmp(c->allowed_extensions, "ALL") && !av_match_ext(url, c->allowed_extensions)) {
625 av_log(s, AV_LOG_ERROR,
626 "Filename extension of \'%s\' is not a common multimedia extension, blocked for security reasons.\n"
627 "If you wish to override this adjust allowed_extensions, you can set it to \'ALL\' to allow all\n",
629 return AVERROR_INVALIDDATA;
631 } else if (av_strstart(proto_name, "http", NULL)) {
634 return AVERROR_INVALIDDATA;
636 if (!strncmp(proto_name, url, strlen(proto_name)) && url[strlen(proto_name)] == ':')
638 else if (av_strstart(url, "crypto", NULL) && !strncmp(proto_name, url + 7, strlen(proto_name)) && url[7 + strlen(proto_name)] == ':')
640 else if (strcmp(proto_name, "file") || !strncmp(url, "file,", 5))
641 return AVERROR_INVALIDDATA;
643 ret = s->io_open(s, pb, url, AVIO_FLAG_READ, &tmp);
645 // update cookies on http response with setcookies.
646 char *new_cookies = NULL;
648 if (!(s->flags & AVFMT_FLAG_CUSTOM_IO))
649 av_opt_get(*pb, "cookies", AV_OPT_SEARCH_CHILDREN, (uint8_t**)&new_cookies);
653 c->cookies = new_cookies;
656 av_dict_set(&opts, "cookies", c->cookies, 0);
662 *is_http = av_strstart(proto_name, "http", NULL);
667 static int parse_playlist(HLSContext *c, const char *url,
668 struct playlist *pls, AVIOContext *in)
670 int ret = 0, is_segment = 0, is_variant = 0;
671 int64_t duration = 0;
672 enum KeyType key_type = KEY_NONE;
675 char key[MAX_URL_SIZE] = "";
676 char line[MAX_URL_SIZE];
679 int64_t seg_offset = 0;
680 int64_t seg_size = -1;
681 uint8_t *new_url = NULL;
682 struct variant_info variant_info;
683 char tmp_str[MAX_URL_SIZE];
684 struct segment *cur_init_section = NULL;
688 AVDictionary *opts = NULL;
690 /* Some HLS servers don't like being sent the range header */
691 av_dict_set(&opts, "seekable", "0", 0);
693 // broker prior HTTP options that should be consistent across requests
694 av_dict_set(&opts, "user_agent", c->user_agent, 0);
695 av_dict_set(&opts, "cookies", c->cookies, 0);
696 av_dict_set(&opts, "headers", c->headers, 0);
697 av_dict_set(&opts, "http_proxy", c->http_proxy, 0);
699 ret = c->ctx->io_open(c->ctx, &in, url, AVIO_FLAG_READ, &opts);
704 ret = open_in(c, &in, url);
711 if (av_opt_get(in, "location", AV_OPT_SEARCH_CHILDREN, &new_url) >= 0)
714 read_chomp_line(in, line, sizeof(line));
715 if (strcmp(line, "#EXTM3U")) {
716 ret = AVERROR_INVALIDDATA;
721 free_segment_list(pls);
723 pls->type = PLS_TYPE_UNSPECIFIED;
725 while (!avio_feof(in)) {
726 read_chomp_line(in, line, sizeof(line));
727 if (av_strstart(line, "#EXT-X-STREAM-INF:", &ptr)) {
729 memset(&variant_info, 0, sizeof(variant_info));
730 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_variant_args,
732 } else if (av_strstart(line, "#EXT-X-KEY:", &ptr)) {
733 struct key_info info = {{0}};
734 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_key_args,
738 if (!strcmp(info.method, "AES-128"))
739 key_type = KEY_AES_128;
740 if (!strcmp(info.method, "SAMPLE-AES"))
741 key_type = KEY_SAMPLE_AES;
742 if (!strncmp(info.iv, "0x", 2) || !strncmp(info.iv, "0X", 2)) {
743 ff_hex_to_data(iv, info.iv + 2);
746 av_strlcpy(key, info.uri, sizeof(key));
747 } else if (av_strstart(line, "#EXT-X-MEDIA:", &ptr)) {
748 struct rendition_info info = {{0}};
749 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_rendition_args,
751 new_rendition(c, &info, url);
752 } else if (av_strstart(line, "#EXT-X-TARGETDURATION:", &ptr)) {
753 ret = ensure_playlist(c, &pls, url);
756 pls->target_duration = strtoll(ptr, NULL, 10) * AV_TIME_BASE;
757 } else if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
758 ret = ensure_playlist(c, &pls, url);
761 pls->start_seq_no = atoi(ptr);
762 } else if (av_strstart(line, "#EXT-X-PLAYLIST-TYPE:", &ptr)) {
763 ret = ensure_playlist(c, &pls, url);
766 if (!strcmp(ptr, "EVENT"))
767 pls->type = PLS_TYPE_EVENT;
768 else if (!strcmp(ptr, "VOD"))
769 pls->type = PLS_TYPE_VOD;
770 } else if (av_strstart(line, "#EXT-X-MAP:", &ptr)) {
771 struct init_section_info info = {{0}};
772 ret = ensure_playlist(c, &pls, url);
775 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_init_section_args,
777 cur_init_section = new_init_section(pls, &info, url);
778 } else if (av_strstart(line, "#EXT-X-ENDLIST", &ptr)) {
781 } else if (av_strstart(line, "#EXTINF:", &ptr)) {
783 duration = atof(ptr) * AV_TIME_BASE;
784 } else if (av_strstart(line, "#EXT-X-BYTERANGE:", &ptr)) {
785 seg_size = strtoll(ptr, NULL, 10);
786 ptr = strchr(ptr, '@');
788 seg_offset = strtoll(ptr+1, NULL, 10);
789 } else if (av_strstart(line, "#", NULL)) {
791 } else if (line[0]) {
793 if (!new_variant(c, &variant_info, line, url)) {
794 ret = AVERROR(ENOMEM);
802 if (!new_variant(c, 0, url, NULL)) {
803 ret = AVERROR(ENOMEM);
806 pls = c->playlists[c->n_playlists - 1];
808 seg = av_malloc(sizeof(struct segment));
810 ret = AVERROR(ENOMEM);
813 seg->duration = duration;
814 seg->key_type = key_type;
816 memcpy(seg->iv, iv, sizeof(iv));
818 int seq = pls->start_seq_no + pls->n_segments;
819 memset(seg->iv, 0, sizeof(seg->iv));
820 AV_WB32(seg->iv + 12, seq);
823 if (key_type != KEY_NONE) {
824 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, key);
825 seg->key = av_strdup(tmp_str);
828 ret = AVERROR(ENOMEM);
835 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, line);
836 seg->url = av_strdup(tmp_str);
840 ret = AVERROR(ENOMEM);
844 dynarray_add(&pls->segments, &pls->n_segments, seg);
847 seg->size = seg_size;
849 seg->url_offset = seg_offset;
850 seg_offset += seg_size;
857 seg->init_section = cur_init_section;
862 pls->last_load_time = av_gettime_relative();
867 ff_format_io_close(c->ctx, &in);
871 static struct segment *current_segment(struct playlist *pls)
873 return pls->segments[pls->cur_seq_no - pls->start_seq_no];
876 enum ReadFromURLMode {
881 static int read_from_url(struct playlist *pls, struct segment *seg,
882 uint8_t *buf, int buf_size,
883 enum ReadFromURLMode mode)
887 /* limit read if the segment was only a part of a file */
889 buf_size = FFMIN(buf_size, seg->size - pls->cur_seg_offset);
891 if (mode == READ_COMPLETE) {
892 ret = avio_read(pls->input, buf, buf_size);
894 av_log(NULL, AV_LOG_ERROR, "Could not read complete segment.\n");
896 ret = avio_read(pls->input, buf, buf_size);
899 pls->cur_seg_offset += ret;
904 /* Parse the raw ID3 data and pass contents to caller */
905 static void parse_id3(AVFormatContext *s, AVIOContext *pb,
906 AVDictionary **metadata, int64_t *dts,
907 ID3v2ExtraMetaAPIC **apic, ID3v2ExtraMeta **extra_meta)
909 static const char id3_priv_owner_ts[] = "com.apple.streaming.transportStreamTimestamp";
910 ID3v2ExtraMeta *meta;
912 ff_id3v2_read_dict(pb, metadata, ID3v2_DEFAULT_MAGIC, extra_meta);
913 for (meta = *extra_meta; meta; meta = meta->next) {
914 if (!strcmp(meta->tag, "PRIV")) {
915 ID3v2ExtraMetaPRIV *priv = meta->data;
916 if (priv->datasize == 8 && !strcmp(priv->owner, id3_priv_owner_ts)) {
917 /* 33-bit MPEG timestamp */
918 int64_t ts = AV_RB64(priv->data);
919 av_log(s, AV_LOG_DEBUG, "HLS ID3 audio timestamp %"PRId64"\n", ts);
920 if ((ts & ~((1ULL << 33) - 1)) == 0)
923 av_log(s, AV_LOG_ERROR, "Invalid HLS ID3 audio timestamp %"PRId64"\n", ts);
925 } else if (!strcmp(meta->tag, "APIC") && apic)
930 /* Check if the ID3 metadata contents have changed */
931 static int id3_has_changed_values(struct playlist *pls, AVDictionary *metadata,
932 ID3v2ExtraMetaAPIC *apic)
934 AVDictionaryEntry *entry = NULL;
935 AVDictionaryEntry *oldentry;
936 /* check that no keys have changed values */
937 while ((entry = av_dict_get(metadata, "", entry, AV_DICT_IGNORE_SUFFIX))) {
938 oldentry = av_dict_get(pls->id3_initial, entry->key, NULL, AV_DICT_MATCH_CASE);
939 if (!oldentry || strcmp(oldentry->value, entry->value) != 0)
943 /* check if apic appeared */
944 if (apic && (pls->ctx->nb_streams != 2 || !pls->ctx->streams[1]->attached_pic.data))
948 int size = pls->ctx->streams[1]->attached_pic.size;
949 if (size != apic->buf->size - AV_INPUT_BUFFER_PADDING_SIZE)
952 if (memcmp(apic->buf->data, pls->ctx->streams[1]->attached_pic.data, size) != 0)
959 /* Parse ID3 data and handle the found data */
960 static void handle_id3(AVIOContext *pb, struct playlist *pls)
962 AVDictionary *metadata = NULL;
963 ID3v2ExtraMetaAPIC *apic = NULL;
964 ID3v2ExtraMeta *extra_meta = NULL;
965 int64_t timestamp = AV_NOPTS_VALUE;
967 parse_id3(pls->ctx, pb, &metadata, ×tamp, &apic, &extra_meta);
969 if (timestamp != AV_NOPTS_VALUE) {
970 pls->id3_mpegts_timestamp = timestamp;
974 if (!pls->id3_found) {
975 /* initial ID3 tags */
976 av_assert0(!pls->id3_deferred_extra);
979 /* get picture attachment and set text metadata */
980 if (pls->ctx->nb_streams)
981 ff_id3v2_parse_apic(pls->ctx, &extra_meta);
983 /* demuxer not yet opened, defer picture attachment */
984 pls->id3_deferred_extra = extra_meta;
986 av_dict_copy(&pls->ctx->metadata, metadata, 0);
987 pls->id3_initial = metadata;
990 if (!pls->id3_changed && id3_has_changed_values(pls, metadata, apic)) {
991 avpriv_report_missing_feature(pls->ctx, "Changing ID3 metadata in HLS audio elementary stream");
992 pls->id3_changed = 1;
994 av_dict_free(&metadata);
997 if (!pls->id3_deferred_extra)
998 ff_id3v2_free_extra_meta(&extra_meta);
1001 static void intercept_id3(struct playlist *pls, uint8_t *buf,
1002 int buf_size, int *len)
1004 /* intercept id3 tags, we do not want to pass them to the raw
1005 * demuxer on all segment switches */
1007 int id3_buf_pos = 0;
1009 struct segment *seg = current_segment(pls);
1011 /* gather all the id3 tags */
1013 /* see if we can retrieve enough data for ID3 header */
1014 if (*len < ID3v2_HEADER_SIZE && buf_size >= ID3v2_HEADER_SIZE) {
1015 bytes = read_from_url(pls, seg, buf + *len, ID3v2_HEADER_SIZE - *len, READ_COMPLETE);
1018 if (bytes == ID3v2_HEADER_SIZE - *len)
1019 /* no EOF yet, so fill the caller buffer again after
1020 * we have stripped the ID3 tags */
1025 } else if (*len <= 0) {
1032 if (*len < ID3v2_HEADER_SIZE)
1035 if (ff_id3v2_match(buf, ID3v2_DEFAULT_MAGIC)) {
1036 int64_t maxsize = seg->size >= 0 ? seg->size : 1024*1024;
1037 int taglen = ff_id3v2_tag_len(buf);
1038 int tag_got_bytes = FFMIN(taglen, *len);
1039 int remaining = taglen - tag_got_bytes;
1041 if (taglen > maxsize) {
1042 av_log(pls->ctx, AV_LOG_ERROR, "Too large HLS ID3 tag (%d > %"PRId64" bytes)\n",
1048 * Copy the id3 tag to our temporary id3 buffer.
1049 * We could read a small id3 tag directly without memcpy, but
1050 * we would still need to copy the large tags, and handling
1051 * both of those cases together with the possibility for multiple
1052 * tags would make the handling a bit complex.
1054 pls->id3_buf = av_fast_realloc(pls->id3_buf, &pls->id3_buf_size, id3_buf_pos + taglen);
1057 memcpy(pls->id3_buf + id3_buf_pos, buf, tag_got_bytes);
1058 id3_buf_pos += tag_got_bytes;
1060 /* strip the intercepted bytes */
1061 *len -= tag_got_bytes;
1062 memmove(buf, buf + tag_got_bytes, *len);
1063 av_log(pls->ctx, AV_LOG_DEBUG, "Stripped %d HLS ID3 bytes\n", tag_got_bytes);
1065 if (remaining > 0) {
1066 /* read the rest of the tag in */
1067 if (read_from_url(pls, seg, pls->id3_buf + id3_buf_pos, remaining, READ_COMPLETE) != remaining)
1069 id3_buf_pos += remaining;
1070 av_log(pls->ctx, AV_LOG_DEBUG, "Stripped additional %d HLS ID3 bytes\n", remaining);
1074 /* no more ID3 tags */
1079 /* re-fill buffer for the caller unless EOF */
1080 if (*len >= 0 && (fill_buf || *len == 0)) {
1081 bytes = read_from_url(pls, seg, buf + *len, buf_size - *len, READ_NORMAL);
1083 /* ignore error if we already had some data */
1091 /* Now parse all the ID3 tags */
1092 AVIOContext id3ioctx;
1093 ffio_init_context(&id3ioctx, pls->id3_buf, id3_buf_pos, 0, NULL, NULL, NULL, NULL);
1094 handle_id3(&id3ioctx, pls);
1097 if (pls->is_id3_timestamped == -1)
1098 pls->is_id3_timestamped = (pls->id3_mpegts_timestamp != AV_NOPTS_VALUE);
1101 static int open_input(HLSContext *c, struct playlist *pls, struct segment *seg)
1103 AVDictionary *opts = NULL;
1107 // broker prior HTTP options that should be consistent across requests
1108 av_dict_set(&opts, "user_agent", c->user_agent, 0);
1109 av_dict_set(&opts, "cookies", c->cookies, 0);
1110 av_dict_set(&opts, "headers", c->headers, 0);
1111 av_dict_set(&opts, "http_proxy", c->http_proxy, 0);
1112 av_dict_set(&opts, "seekable", "0", 0);
1114 if (seg->size >= 0) {
1115 /* try to restrict the HTTP request to the part we want
1116 * (if this is in fact a HTTP request) */
1117 av_dict_set_int(&opts, "offset", seg->url_offset, 0);
1118 av_dict_set_int(&opts, "end_offset", seg->url_offset + seg->size, 0);
1121 av_log(pls->parent, AV_LOG_VERBOSE, "HLS request for url '%s', offset %"PRId64", playlist %d\n",
1122 seg->url, seg->url_offset, pls->index);
1124 if (seg->key_type == KEY_NONE) {
1125 ret = open_url(pls->parent, &pls->input, seg->url, c->avio_opts, opts, &is_http);
1126 } else if (seg->key_type == KEY_AES_128) {
1127 AVDictionary *opts2 = NULL;
1128 char iv[33], key[33], url[MAX_URL_SIZE];
1129 if (strcmp(seg->key, pls->key_url)) {
1131 if (open_url(pls->parent, &pb, seg->key, c->avio_opts, opts, NULL) == 0) {
1132 ret = avio_read(pb, pls->key, sizeof(pls->key));
1133 if (ret != sizeof(pls->key)) {
1134 av_log(NULL, AV_LOG_ERROR, "Unable to read key file %s\n",
1137 ff_format_io_close(pls->parent, &pb);
1139 av_log(NULL, AV_LOG_ERROR, "Unable to open key file %s\n",
1142 av_strlcpy(pls->key_url, seg->key, sizeof(pls->key_url));
1144 ff_data_to_hex(iv, seg->iv, sizeof(seg->iv), 0);
1145 ff_data_to_hex(key, pls->key, sizeof(pls->key), 0);
1146 iv[32] = key[32] = '\0';
1147 if (strstr(seg->url, "://"))
1148 snprintf(url, sizeof(url), "crypto+%s", seg->url);
1150 snprintf(url, sizeof(url), "crypto:%s", seg->url);
1152 av_dict_copy(&opts2, c->avio_opts, 0);
1153 av_dict_set(&opts2, "key", key, 0);
1154 av_dict_set(&opts2, "iv", iv, 0);
1156 ret = open_url(pls->parent, &pls->input, url, opts2, opts, &is_http);
1158 av_dict_free(&opts2);
1164 } else if (seg->key_type == KEY_SAMPLE_AES) {
1165 av_log(pls->parent, AV_LOG_ERROR,
1166 "SAMPLE-AES encryption is not supported yet\n");
1167 ret = AVERROR_PATCHWELCOME;
1170 ret = AVERROR(ENOSYS);
1172 /* Seek to the requested position. If this was a HTTP request, the offset
1173 * should already be where want it to, but this allows e.g. local testing
1174 * without a HTTP server.
1176 * This is not done for HTTP at all as avio_seek() does internal bookkeeping
1177 * of file offset which is out-of-sync with the actual offset when "offset"
1178 * AVOption is used with http protocol, causing the seek to not be a no-op
1179 * as would be expected. Wrong offset received from the server will not be
1180 * noticed without the call, though.
1182 if (ret == 0 && !is_http && seg->key_type == KEY_NONE && seg->url_offset) {
1183 int64_t seekret = avio_seek(pls->input, seg->url_offset, SEEK_SET);
1185 av_log(pls->parent, AV_LOG_ERROR, "Unable to seek to offset %"PRId64" of HLS segment '%s'\n", seg->url_offset, seg->url);
1187 ff_format_io_close(pls->parent, &pls->input);
1192 av_dict_free(&opts);
1193 pls->cur_seg_offset = 0;
1197 static int update_init_section(struct playlist *pls, struct segment *seg)
1199 static const int max_init_section_size = 1024*1024;
1200 HLSContext *c = pls->parent->priv_data;
1205 if (seg->init_section == pls->cur_init_section)
1208 pls->cur_init_section = NULL;
1210 if (!seg->init_section)
1213 ret = open_input(c, pls, seg->init_section);
1215 av_log(pls->parent, AV_LOG_WARNING,
1216 "Failed to open an initialization section in playlist %d\n",
1221 if (seg->init_section->size >= 0)
1222 sec_size = seg->init_section->size;
1223 else if ((urlsize = avio_size(pls->input)) >= 0)
1226 sec_size = max_init_section_size;
1228 av_log(pls->parent, AV_LOG_DEBUG,
1229 "Downloading an initialization section of size %"PRId64"\n",
1232 sec_size = FFMIN(sec_size, max_init_section_size);
1234 av_fast_malloc(&pls->init_sec_buf, &pls->init_sec_buf_size, sec_size);
1236 ret = read_from_url(pls, seg->init_section, pls->init_sec_buf,
1237 pls->init_sec_buf_size, READ_COMPLETE);
1238 ff_format_io_close(pls->parent, &pls->input);
1243 pls->cur_init_section = seg->init_section;
1244 pls->init_sec_data_len = ret;
1245 pls->init_sec_buf_read_offset = 0;
1247 /* spec says audio elementary streams do not have media initialization
1248 * sections, so there should be no ID3 timestamps */
1249 pls->is_id3_timestamped = 0;
1254 static int64_t default_reload_interval(struct playlist *pls)
1256 return pls->n_segments > 0 ?
1257 pls->segments[pls->n_segments - 1]->duration :
1258 pls->target_duration;
1261 static int playlist_needed(struct playlist *pls)
1263 AVFormatContext *s = pls->parent;
1265 int stream_needed = 0;
1268 /* If there is no context or streams yet, the playlist is needed */
1269 if (!pls->ctx || !pls->n_main_streams)
1272 /* check if any of the streams in the playlist are needed */
1273 for (i = 0; i < pls->n_main_streams; i++) {
1274 if (pls->main_streams[i]->discard < AVDISCARD_ALL) {
1280 /* If all streams in the playlist were discarded, the playlist is not
1281 * needed (regardless of whether whole programs are discarded or not). */
1285 /* Otherwise, check if all the programs (variants) this playlist is in are
1286 * discarded. Since all streams in the playlist are part of the same programs
1287 * we can just check the programs of the first stream. */
1289 first_st = pls->main_streams[0]->index;
1291 for (i = 0; i < s->nb_programs; i++) {
1292 AVProgram *program = s->programs[i];
1293 if (program->discard < AVDISCARD_ALL) {
1294 for (j = 0; j < program->nb_stream_indexes; j++) {
1295 if (program->stream_index[j] == first_st) {
1296 /* playlist is in an undiscarded program */
1303 /* some streams were not discarded but all the programs were */
1307 static int read_data(void *opaque, uint8_t *buf, int buf_size)
1309 struct playlist *v = opaque;
1310 HLSContext *c = v->parent->priv_data;
1312 int just_opened = 0;
1313 int reload_count = 0;
1320 int64_t reload_interval;
1321 struct segment *seg;
1323 /* Check that the playlist is still needed before opening a new
1325 v->needed = playlist_needed(v);
1328 av_log(v->parent, AV_LOG_INFO, "No longer receiving playlist %d\n",
1333 /* If this is a live stream and the reload interval has elapsed since
1334 * the last playlist reload, reload the playlists now. */
1335 reload_interval = default_reload_interval(v);
1339 if (reload_count > c->max_reload)
1342 av_gettime_relative() - v->last_load_time >= reload_interval) {
1343 if ((ret = parse_playlist(c, v->url, v, NULL)) < 0) {
1344 av_log(v->parent, AV_LOG_WARNING, "Failed to reload playlist %d\n",
1348 /* If we need to reload the playlist again below (if
1349 * there's still no more segments), switch to a reload
1350 * interval of half the target duration. */
1351 reload_interval = v->target_duration / 2;
1353 if (v->cur_seq_no < v->start_seq_no) {
1354 av_log(NULL, AV_LOG_WARNING,
1355 "skipping %d segments ahead, expired from playlists\n",
1356 v->start_seq_no - v->cur_seq_no);
1357 v->cur_seq_no = v->start_seq_no;
1359 if (v->cur_seq_no >= v->start_seq_no + v->n_segments) {
1362 while (av_gettime_relative() - v->last_load_time < reload_interval) {
1363 if (ff_check_interrupt(c->interrupt_callback))
1364 return AVERROR_EXIT;
1365 av_usleep(100*1000);
1367 /* Enough time has elapsed since the last reload */
1371 seg = current_segment(v);
1373 /* load/update Media Initialization Section, if any */
1374 ret = update_init_section(v, seg);
1378 ret = open_input(c, v, seg);
1380 if (ff_check_interrupt(c->interrupt_callback))
1381 return AVERROR_EXIT;
1382 av_log(v->parent, AV_LOG_WARNING, "Failed to open segment of playlist %d\n",
1390 if (v->init_sec_buf_read_offset < v->init_sec_data_len) {
1391 /* Push init section out first before first actual segment */
1392 int copy_size = FFMIN(v->init_sec_data_len - v->init_sec_buf_read_offset, buf_size);
1393 memcpy(buf, v->init_sec_buf, copy_size);
1394 v->init_sec_buf_read_offset += copy_size;
1398 ret = read_from_url(v, current_segment(v), buf, buf_size, READ_NORMAL);
1400 if (just_opened && v->is_id3_timestamped != 0) {
1401 /* Intercept ID3 tags here, elementary audio streams are required
1402 * to convey timestamps using them in the beginning of each segment. */
1403 intercept_id3(v, buf, buf_size, &ret);
1408 ff_format_io_close(v->parent, &v->input);
1411 c->cur_seq_no = v->cur_seq_no;
1416 static void add_renditions_to_variant(HLSContext *c, struct variant *var,
1417 enum AVMediaType type, const char *group_id)
1421 for (i = 0; i < c->n_renditions; i++) {
1422 struct rendition *rend = c->renditions[i];
1424 if (rend->type == type && !strcmp(rend->group_id, group_id)) {
1427 /* rendition is an external playlist
1428 * => add the playlist to the variant */
1429 dynarray_add(&var->playlists, &var->n_playlists, rend->playlist);
1431 /* rendition is part of the variant main Media Playlist
1432 * => add the rendition to the main Media Playlist */
1433 dynarray_add(&var->playlists[0]->renditions,
1434 &var->playlists[0]->n_renditions,
1440 static void add_metadata_from_renditions(AVFormatContext *s, struct playlist *pls,
1441 enum AVMediaType type)
1446 for (i = 0; i < pls->n_main_streams; i++) {
1447 AVStream *st = pls->main_streams[i];
1449 if (st->codecpar->codec_type != type)
1452 for (; rend_idx < pls->n_renditions; rend_idx++) {
1453 struct rendition *rend = pls->renditions[rend_idx];
1455 if (rend->type != type)
1458 if (rend->language[0])
1459 av_dict_set(&st->metadata, "language", rend->language, 0);
1461 av_dict_set(&st->metadata, "comment", rend->name, 0);
1463 st->disposition |= rend->disposition;
1465 if (rend_idx >=pls->n_renditions)
1470 /* if timestamp was in valid range: returns 1 and sets seq_no
1471 * if not: returns 0 and sets seq_no to closest segment */
1472 static int find_timestamp_in_playlist(HLSContext *c, struct playlist *pls,
1473 int64_t timestamp, int *seq_no)
1476 int64_t pos = c->first_timestamp == AV_NOPTS_VALUE ?
1477 0 : c->first_timestamp;
1479 if (timestamp < pos) {
1480 *seq_no = pls->start_seq_no;
1484 for (i = 0; i < pls->n_segments; i++) {
1485 int64_t diff = pos + pls->segments[i]->duration - timestamp;
1487 *seq_no = pls->start_seq_no + i;
1490 pos += pls->segments[i]->duration;
1493 *seq_no = pls->start_seq_no + pls->n_segments - 1;
1498 static int select_cur_seq_no(HLSContext *c, struct playlist *pls)
1502 if (!pls->finished && !c->first_packet &&
1503 av_gettime_relative() - pls->last_load_time >= default_reload_interval(pls))
1504 /* reload the playlist since it was suspended */
1505 parse_playlist(c, pls->url, pls, NULL);
1507 /* If playback is already in progress (we are just selecting a new
1508 * playlist) and this is a complete file, find the matching segment
1509 * by counting durations. */
1510 if (pls->finished && c->cur_timestamp != AV_NOPTS_VALUE) {
1511 find_timestamp_in_playlist(c, pls, c->cur_timestamp, &seq_no);
1515 if (!pls->finished) {
1516 if (!c->first_packet && /* we are doing a segment selection during playback */
1517 c->cur_seq_no >= pls->start_seq_no &&
1518 c->cur_seq_no < pls->start_seq_no + pls->n_segments)
1519 /* While spec 3.4.3 says that we cannot assume anything about the
1520 * content at the same sequence number on different playlists,
1521 * in practice this seems to work and doing it otherwise would
1522 * require us to download a segment to inspect its timestamps. */
1523 return c->cur_seq_no;
1525 /* If this is a live stream, start live_start_index segments from the
1527 if (c->live_start_index < 0)
1528 return pls->start_seq_no + FFMAX(pls->n_segments + c->live_start_index, 0);
1530 return pls->start_seq_no + FFMIN(c->live_start_index, pls->n_segments - 1);
1533 /* Otherwise just start on the first segment. */
1534 return pls->start_seq_no;
1537 static int save_avio_options(AVFormatContext *s)
1539 HLSContext *c = s->priv_data;
1540 static const char * const opts[] = {
1541 "headers", "http_proxy", "user_agent", "user-agent", "cookies", NULL };
1542 const char * const * opt = opts;
1547 if (av_opt_get(s->pb, *opt, AV_OPT_SEARCH_CHILDREN | AV_OPT_ALLOW_NULL, &buf) >= 0) {
1548 ret = av_dict_set(&c->avio_opts, *opt, buf,
1549 AV_DICT_DONT_STRDUP_VAL);
1559 static int nested_io_open(AVFormatContext *s, AVIOContext **pb, const char *url,
1560 int flags, AVDictionary **opts)
1562 av_log(s, AV_LOG_ERROR,
1563 "A HLS playlist item '%s' referred to an external file '%s'. "
1564 "Opening this file was forbidden for security reasons\n",
1566 return AVERROR(EPERM);
1569 static void add_stream_to_programs(AVFormatContext *s, struct playlist *pls, AVStream *stream)
1571 HLSContext *c = s->priv_data;
1575 for (i = 0; i < c->n_variants; i++) {
1576 struct variant *v = c->variants[i];
1578 for (j = 0; j < v->n_playlists; j++) {
1579 if (v->playlists[j] != pls)
1582 av_program_add_stream_index(s, i, stream->index);
1585 bandwidth = v->bandwidth;
1586 else if (bandwidth != v->bandwidth)
1587 bandwidth = -1; /* stream in multiple variants with different bandwidths */
1592 av_dict_set_int(&stream->metadata, "variant_bitrate", bandwidth, 0);
1595 static int set_stream_info_from_input_stream(AVStream *st, struct playlist *pls, AVStream *ist)
1599 err = avcodec_parameters_copy(st->codecpar, ist->codecpar);
1603 if (pls->is_id3_timestamped) /* custom timestamps via id3 */
1604 avpriv_set_pts_info(st, 33, 1, MPEG_TIME_BASE);
1606 avpriv_set_pts_info(st, ist->pts_wrap_bits, ist->time_base.num, ist->time_base.den);
1608 st->internal->need_context_update = 1;
1613 /* add new subdemuxer streams to our context, if any */
1614 static int update_streams_from_subdemuxer(AVFormatContext *s, struct playlist *pls)
1618 while (pls->n_main_streams < pls->ctx->nb_streams) {
1619 int ist_idx = pls->n_main_streams;
1620 AVStream *st = avformat_new_stream(s, NULL);
1621 AVStream *ist = pls->ctx->streams[ist_idx];
1624 return AVERROR(ENOMEM);
1626 st->id = pls->index;
1627 dynarray_add(&pls->main_streams, &pls->n_main_streams, st);
1629 add_stream_to_programs(s, pls, st);
1631 err = set_stream_info_from_input_stream(st, pls, ist);
1639 static void update_noheader_flag(AVFormatContext *s)
1641 HLSContext *c = s->priv_data;
1642 int flag_needed = 0;
1645 for (i = 0; i < c->n_playlists; i++) {
1646 struct playlist *pls = c->playlists[i];
1648 if (pls->has_noheader_flag) {
1655 s->ctx_flags |= AVFMTCTX_NOHEADER;
1657 s->ctx_flags &= ~AVFMTCTX_NOHEADER;
1660 static int hls_close(AVFormatContext *s)
1662 HLSContext *c = s->priv_data;
1664 free_playlist_list(c);
1665 free_variant_list(c);
1666 free_rendition_list(c);
1668 av_dict_free(&c->avio_opts);
1673 static int hls_read_header(AVFormatContext *s)
1675 void *u = (s->flags & AVFMT_FLAG_CUSTOM_IO) ? NULL : s->pb;
1676 HLSContext *c = s->priv_data;
1678 int highest_cur_seq_no = 0;
1681 c->interrupt_callback = &s->interrupt_callback;
1682 c->strict_std_compliance = s->strict_std_compliance;
1684 c->first_packet = 1;
1685 c->first_timestamp = AV_NOPTS_VALUE;
1686 c->cur_timestamp = AV_NOPTS_VALUE;
1689 // get the previous user agent & set back to null if string size is zero
1690 update_options(&c->user_agent, "user_agent", u);
1692 // get the previous cookies & set back to null if string size is zero
1693 update_options(&c->cookies, "cookies", u);
1695 // get the previous headers & set back to null if string size is zero
1696 update_options(&c->headers, "headers", u);
1698 // get the previous http proxt & set back to null if string size is zero
1699 update_options(&c->http_proxy, "http_proxy", u);
1702 if ((ret = parse_playlist(c, s->filename, NULL, s->pb)) < 0)
1705 if ((ret = save_avio_options(s)) < 0)
1708 /* Some HLS servers don't like being sent the range header */
1709 av_dict_set(&c->avio_opts, "seekable", "0", 0);
1711 if (c->n_variants == 0) {
1712 av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1716 /* If the playlist only contained playlists (Master Playlist),
1717 * parse each individual playlist. */
1718 if (c->n_playlists > 1 || c->playlists[0]->n_segments == 0) {
1719 for (i = 0; i < c->n_playlists; i++) {
1720 struct playlist *pls = c->playlists[i];
1721 if ((ret = parse_playlist(c, pls->url, pls, NULL)) < 0)
1726 if (c->variants[0]->playlists[0]->n_segments == 0) {
1727 av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1732 /* If this isn't a live stream, calculate the total duration of the
1734 if (c->variants[0]->playlists[0]->finished) {
1735 int64_t duration = 0;
1736 for (i = 0; i < c->variants[0]->playlists[0]->n_segments; i++)
1737 duration += c->variants[0]->playlists[0]->segments[i]->duration;
1738 s->duration = duration;
1741 /* Associate renditions with variants */
1742 for (i = 0; i < c->n_variants; i++) {
1743 struct variant *var = c->variants[i];
1745 if (var->audio_group[0])
1746 add_renditions_to_variant(c, var, AVMEDIA_TYPE_AUDIO, var->audio_group);
1747 if (var->video_group[0])
1748 add_renditions_to_variant(c, var, AVMEDIA_TYPE_VIDEO, var->video_group);
1749 if (var->subtitles_group[0])
1750 add_renditions_to_variant(c, var, AVMEDIA_TYPE_SUBTITLE, var->subtitles_group);
1753 /* Create a program for each variant */
1754 for (i = 0; i < c->n_variants; i++) {
1755 struct variant *v = c->variants[i];
1758 program = av_new_program(s, i);
1761 av_dict_set_int(&program->metadata, "variant_bitrate", v->bandwidth, 0);
1764 /* Select the starting segments */
1765 for (i = 0; i < c->n_playlists; i++) {
1766 struct playlist *pls = c->playlists[i];
1768 if (pls->n_segments == 0)
1771 pls->cur_seq_no = select_cur_seq_no(c, pls);
1772 highest_cur_seq_no = FFMAX(highest_cur_seq_no, pls->cur_seq_no);
1775 /* Open the demuxer for each playlist */
1776 for (i = 0; i < c->n_playlists; i++) {
1777 struct playlist *pls = c->playlists[i];
1778 AVInputFormat *in_fmt = NULL;
1780 if (!(pls->ctx = avformat_alloc_context())) {
1781 ret = AVERROR(ENOMEM);
1785 if (pls->n_segments == 0)
1793 * If this is a live stream and this playlist looks like it is one segment
1794 * behind, try to sync it up so that every substream starts at the same
1795 * time position (so e.g. avformat_find_stream_info() will see packets from
1796 * all active streams within the first few seconds). This is not very generic,
1797 * though, as the sequence numbers are technically independent.
1799 if (!pls->finished && pls->cur_seq_no == highest_cur_seq_no - 1 &&
1800 highest_cur_seq_no < pls->start_seq_no + pls->n_segments) {
1801 pls->cur_seq_no = highest_cur_seq_no;
1804 pls->read_buffer = av_malloc(INITIAL_BUFFER_SIZE);
1805 if (!pls->read_buffer){
1806 ret = AVERROR(ENOMEM);
1807 avformat_free_context(pls->ctx);
1811 ffio_init_context(&pls->pb, pls->read_buffer, INITIAL_BUFFER_SIZE, 0, pls,
1812 read_data, NULL, NULL);
1813 pls->pb.seekable = 0;
1814 ret = av_probe_input_buffer(&pls->pb, &in_fmt, pls->segments[0]->url,
1817 /* Free the ctx - it isn't initialized properly at this point,
1818 * so avformat_close_input shouldn't be called. If
1819 * avformat_open_input fails below, it frees and zeros the
1820 * context, so it doesn't need any special treatment like this. */
1821 av_log(s, AV_LOG_ERROR, "Error when loading first segment '%s'\n", pls->segments[0]->url);
1822 avformat_free_context(pls->ctx);
1826 pls->ctx->pb = &pls->pb;
1827 pls->ctx->io_open = nested_io_open;
1828 pls->ctx->flags |= s->flags & ~AVFMT_FLAG_CUSTOM_IO;
1830 if ((ret = ff_copy_whiteblacklists(pls->ctx, s)) < 0)
1833 ret = avformat_open_input(&pls->ctx, pls->segments[0]->url, in_fmt, NULL);
1837 if (pls->id3_deferred_extra && pls->ctx->nb_streams == 1) {
1838 ff_id3v2_parse_apic(pls->ctx, &pls->id3_deferred_extra);
1839 avformat_queue_attached_pictures(pls->ctx);
1840 ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
1841 pls->id3_deferred_extra = NULL;
1844 if (pls->is_id3_timestamped == -1)
1845 av_log(s, AV_LOG_WARNING, "No expected HTTP requests have been made\n");
1848 * For ID3 timestamped raw audio streams we need to detect the packet
1849 * durations to calculate timestamps in fill_timing_for_id3_timestamped_stream(),
1850 * but for other streams we can rely on our user calling avformat_find_stream_info()
1851 * on us if they want to.
1853 if (pls->is_id3_timestamped) {
1854 ret = avformat_find_stream_info(pls->ctx, NULL);
1859 pls->has_noheader_flag = !!(pls->ctx->ctx_flags & AVFMTCTX_NOHEADER);
1861 /* Create new AVStreams for each stream in this playlist */
1862 ret = update_streams_from_subdemuxer(s, pls);
1866 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_AUDIO);
1867 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_VIDEO);
1868 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_SUBTITLE);
1871 update_noheader_flag(s);
1879 static int recheck_discard_flags(AVFormatContext *s, int first)
1881 HLSContext *c = s->priv_data;
1885 /* Check if any new streams are needed */
1886 for (i = 0; i < c->n_playlists; i++) {
1887 struct playlist *pls = c->playlists[i];
1889 cur_needed = playlist_needed(c->playlists[i]);
1891 if (cur_needed && !pls->needed) {
1894 pls->cur_seq_no = select_cur_seq_no(c, pls);
1895 pls->pb.eof_reached = 0;
1896 if (c->cur_timestamp != AV_NOPTS_VALUE) {
1898 pls->seek_timestamp = c->cur_timestamp;
1899 pls->seek_flags = AVSEEK_FLAG_ANY;
1900 pls->seek_stream_index = -1;
1902 av_log(s, AV_LOG_INFO, "Now receiving playlist %d, segment %d\n", i, pls->cur_seq_no);
1903 } else if (first && !cur_needed && pls->needed) {
1905 ff_format_io_close(pls->parent, &pls->input);
1908 av_log(s, AV_LOG_INFO, "No longer receiving playlist %d\n", i);
1914 static void fill_timing_for_id3_timestamped_stream(struct playlist *pls)
1916 if (pls->id3_offset >= 0) {
1917 pls->pkt.dts = pls->id3_mpegts_timestamp +
1918 av_rescale_q(pls->id3_offset,
1919 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1921 if (pls->pkt.duration)
1922 pls->id3_offset += pls->pkt.duration;
1924 pls->id3_offset = -1;
1926 /* there have been packets with unknown duration
1927 * since the last id3 tag, should not normally happen */
1928 pls->pkt.dts = AV_NOPTS_VALUE;
1931 if (pls->pkt.duration)
1932 pls->pkt.duration = av_rescale_q(pls->pkt.duration,
1933 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1936 pls->pkt.pts = AV_NOPTS_VALUE;
1939 static AVRational get_timebase(struct playlist *pls)
1941 if (pls->is_id3_timestamped)
1942 return MPEG_TIME_BASE_Q;
1944 return pls->ctx->streams[pls->pkt.stream_index]->time_base;
1947 static int compare_ts_with_wrapdetect(int64_t ts_a, struct playlist *pls_a,
1948 int64_t ts_b, struct playlist *pls_b)
1950 int64_t scaled_ts_a = av_rescale_q(ts_a, get_timebase(pls_a), MPEG_TIME_BASE_Q);
1951 int64_t scaled_ts_b = av_rescale_q(ts_b, get_timebase(pls_b), MPEG_TIME_BASE_Q);
1953 return av_compare_mod(scaled_ts_a, scaled_ts_b, 1LL << 33);
1956 static int hls_read_packet(AVFormatContext *s, AVPacket *pkt)
1958 HLSContext *c = s->priv_data;
1959 int ret, i, minplaylist = -1;
1961 recheck_discard_flags(s, c->first_packet);
1962 c->first_packet = 0;
1964 for (i = 0; i < c->n_playlists; i++) {
1965 struct playlist *pls = c->playlists[i];
1966 /* Make sure we've got one buffered packet from each open playlist
1968 if (pls->needed && !pls->pkt.data) {
1972 ret = av_read_frame(pls->ctx, &pls->pkt);
1974 if (!avio_feof(&pls->pb) && ret != AVERROR_EOF)
1976 reset_packet(&pls->pkt);
1979 /* stream_index check prevents matching picture attachments etc. */
1980 if (pls->is_id3_timestamped && pls->pkt.stream_index == 0) {
1981 /* audio elementary streams are id3 timestamped */
1982 fill_timing_for_id3_timestamped_stream(pls);
1985 if (c->first_timestamp == AV_NOPTS_VALUE &&
1986 pls->pkt.dts != AV_NOPTS_VALUE)
1987 c->first_timestamp = av_rescale_q(pls->pkt.dts,
1988 get_timebase(pls), AV_TIME_BASE_Q);
1991 if (pls->seek_timestamp == AV_NOPTS_VALUE)
1994 if (pls->seek_stream_index < 0 ||
1995 pls->seek_stream_index == pls->pkt.stream_index) {
1997 if (pls->pkt.dts == AV_NOPTS_VALUE) {
1998 pls->seek_timestamp = AV_NOPTS_VALUE;
2002 tb = get_timebase(pls);
2003 ts_diff = av_rescale_rnd(pls->pkt.dts, AV_TIME_BASE,
2004 tb.den, AV_ROUND_DOWN) -
2005 pls->seek_timestamp;
2006 if (ts_diff >= 0 && (pls->seek_flags & AVSEEK_FLAG_ANY ||
2007 pls->pkt.flags & AV_PKT_FLAG_KEY)) {
2008 pls->seek_timestamp = AV_NOPTS_VALUE;
2012 av_packet_unref(&pls->pkt);
2013 reset_packet(&pls->pkt);
2016 /* Check if this stream has the packet with the lowest dts */
2017 if (pls->pkt.data) {
2018 struct playlist *minpls = minplaylist < 0 ?
2019 NULL : c->playlists[minplaylist];
2020 if (minplaylist < 0) {
2023 int64_t dts = pls->pkt.dts;
2024 int64_t mindts = minpls->pkt.dts;
2026 if (dts == AV_NOPTS_VALUE ||
2027 (mindts != AV_NOPTS_VALUE && compare_ts_with_wrapdetect(dts, pls, mindts, minpls) < 0))
2033 /* If we got a packet, return it */
2034 if (minplaylist >= 0) {
2035 struct playlist *pls = c->playlists[minplaylist];
2039 ret = update_streams_from_subdemuxer(s, pls);
2041 av_packet_unref(&pls->pkt);
2042 reset_packet(&pls->pkt);
2046 /* check if noheader flag has been cleared by the subdemuxer */
2047 if (pls->has_noheader_flag && !(pls->ctx->ctx_flags & AVFMTCTX_NOHEADER)) {
2048 pls->has_noheader_flag = 0;
2049 update_noheader_flag(s);
2052 if (pls->pkt.stream_index >= pls->n_main_streams) {
2053 av_log(s, AV_LOG_ERROR, "stream index inconsistency: index %d, %d main streams, %d subdemuxer streams\n",
2054 pls->pkt.stream_index, pls->n_main_streams, pls->ctx->nb_streams);
2055 av_packet_unref(&pls->pkt);
2056 reset_packet(&pls->pkt);
2060 ist = pls->ctx->streams[pls->pkt.stream_index];
2061 st = pls->main_streams[pls->pkt.stream_index];
2064 pkt->stream_index = st->index;
2065 reset_packet(&c->playlists[minplaylist]->pkt);
2067 if (pkt->dts != AV_NOPTS_VALUE)
2068 c->cur_timestamp = av_rescale_q(pkt->dts,
2072 /* There may be more situations where this would be useful, but this at least
2073 * handles newly probed codecs properly (i.e. request_probe by mpegts). */
2074 if (ist->codecpar->codec_id != st->codecpar->codec_id) {
2075 ret = set_stream_info_from_input_stream(st, pls, ist);
2077 av_packet_unref(pkt);
2087 static int hls_read_seek(AVFormatContext *s, int stream_index,
2088 int64_t timestamp, int flags)
2090 HLSContext *c = s->priv_data;
2091 struct playlist *seek_pls = NULL;
2094 int stream_subdemuxer_index;
2095 int64_t first_timestamp, seek_timestamp, duration;
2097 if ((flags & AVSEEK_FLAG_BYTE) ||
2098 !(c->variants[0]->playlists[0]->finished || c->variants[0]->playlists[0]->type == PLS_TYPE_EVENT))
2099 return AVERROR(ENOSYS);
2101 first_timestamp = c->first_timestamp == AV_NOPTS_VALUE ?
2102 0 : c->first_timestamp;
2104 seek_timestamp = av_rescale_rnd(timestamp, AV_TIME_BASE,
2105 s->streams[stream_index]->time_base.den,
2106 flags & AVSEEK_FLAG_BACKWARD ?
2107 AV_ROUND_DOWN : AV_ROUND_UP);
2109 duration = s->duration == AV_NOPTS_VALUE ?
2112 if (0 < duration && duration < seek_timestamp - first_timestamp)
2113 return AVERROR(EIO);
2115 /* find the playlist with the specified stream */
2116 for (i = 0; i < c->n_playlists; i++) {
2117 struct playlist *pls = c->playlists[i];
2118 for (j = 0; j < pls->n_main_streams; j++) {
2119 if (pls->main_streams[j] == s->streams[stream_index]) {
2121 stream_subdemuxer_index = j;
2126 /* check if the timestamp is valid for the playlist with the
2127 * specified stream index */
2128 if (!seek_pls || !find_timestamp_in_playlist(c, seek_pls, seek_timestamp, &seq_no))
2129 return AVERROR(EIO);
2131 /* set segment now so we do not need to search again below */
2132 seek_pls->cur_seq_no = seq_no;
2133 seek_pls->seek_stream_index = stream_subdemuxer_index;
2135 for (i = 0; i < c->n_playlists; i++) {
2137 struct playlist *pls = c->playlists[i];
2139 ff_format_io_close(pls->parent, &pls->input);
2140 av_packet_unref(&pls->pkt);
2141 reset_packet(&pls->pkt);
2142 pls->pb.eof_reached = 0;
2143 /* Clear any buffered data */
2144 pls->pb.buf_end = pls->pb.buf_ptr = pls->pb.buffer;
2145 /* Reset the pos, to let the mpegts demuxer know we've seeked. */
2147 /* Flush the packet queue of the subdemuxer. */
2148 ff_read_frame_flush(pls->ctx);
2150 pls->seek_timestamp = seek_timestamp;
2151 pls->seek_flags = flags;
2153 if (pls != seek_pls) {
2154 /* set closest segment seq_no for playlists not handled above */
2155 find_timestamp_in_playlist(c, pls, seek_timestamp, &pls->cur_seq_no);
2156 /* seek the playlist to the given position without taking
2157 * keyframes into account since this playlist does not have the
2158 * specified stream where we should look for the keyframes */
2159 pls->seek_stream_index = -1;
2160 pls->seek_flags |= AVSEEK_FLAG_ANY;
2164 c->cur_timestamp = seek_timestamp;
2169 static int hls_probe(AVProbeData *p)
2171 /* Require #EXTM3U at the start, and either one of the ones below
2172 * somewhere for a proper match. */
2173 if (strncmp(p->buf, "#EXTM3U", 7))
2176 if (strstr(p->buf, "#EXT-X-STREAM-INF:") ||
2177 strstr(p->buf, "#EXT-X-TARGETDURATION:") ||
2178 strstr(p->buf, "#EXT-X-MEDIA-SEQUENCE:"))
2179 return AVPROBE_SCORE_MAX;
2183 #define OFFSET(x) offsetof(HLSContext, x)
2184 #define FLAGS AV_OPT_FLAG_DECODING_PARAM
2185 static const AVOption hls_options[] = {
2186 {"live_start_index", "segment index to start live streams at (negative values are from the end)",
2187 OFFSET(live_start_index), AV_OPT_TYPE_INT, {.i64 = -3}, INT_MIN, INT_MAX, FLAGS},
2188 {"allowed_extensions", "List of file extensions that hls is allowed to access",
2189 OFFSET(allowed_extensions), AV_OPT_TYPE_STRING,
2190 {.str = "3gp,aac,avi,flac,mkv,m3u8,m4a,m4s,m4v,mpg,mov,mp2,mp3,mp4,mpeg,mpegts,ogg,ogv,oga,ts,vob,wav"},
2191 INT_MIN, INT_MAX, FLAGS},
2192 {"max_reload", "Maximum number of times a insufficient list is attempted to be reloaded",
2193 OFFSET(max_reload), AV_OPT_TYPE_INT, {.i64 = 1000}, 0, INT_MAX, FLAGS},
2197 static const AVClass hls_class = {
2198 .class_name = "hls,applehttp",
2199 .item_name = av_default_item_name,
2200 .option = hls_options,
2201 .version = LIBAVUTIL_VERSION_INT,
2204 AVInputFormat ff_hls_demuxer = {
2205 .name = "hls,applehttp",
2206 .long_name = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
2207 .priv_class = &hls_class,
2208 .priv_data_size = sizeof(HLSContext),
2209 .read_probe = hls_probe,
2210 .read_header = hls_read_header,
2211 .read_packet = hls_read_packet,
2212 .read_close = hls_close,
2213 .read_seek = hls_read_seek,