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;
114 int needed, cur_needed;
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;
209 static int read_chomp_line(AVIOContext *s, char *buf, int maxlen)
211 int len = ff_get_line(s, buf, maxlen);
212 while (len > 0 && av_isspace(buf[len - 1]))
217 static void free_segment_list(struct playlist *pls)
220 for (i = 0; i < pls->n_segments; i++) {
221 av_freep(&pls->segments[i]->key);
222 av_freep(&pls->segments[i]->url);
223 av_freep(&pls->segments[i]);
225 av_freep(&pls->segments);
229 static void free_init_section_list(struct playlist *pls)
232 for (i = 0; i < pls->n_init_sections; i++) {
233 av_freep(&pls->init_sections[i]->url);
234 av_freep(&pls->init_sections[i]);
236 av_freep(&pls->init_sections);
237 pls->n_init_sections = 0;
240 static void free_playlist_list(HLSContext *c)
243 for (i = 0; i < c->n_playlists; i++) {
244 struct playlist *pls = c->playlists[i];
245 free_segment_list(pls);
246 free_init_section_list(pls);
247 av_freep(&pls->main_streams);
248 av_freep(&pls->renditions);
249 av_freep(&pls->id3_buf);
250 av_dict_free(&pls->id3_initial);
251 ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
252 av_freep(&pls->init_sec_buf);
253 av_packet_unref(&pls->pkt);
254 av_freep(&pls->pb.buffer);
256 ff_format_io_close(c->ctx, &pls->input);
259 avformat_close_input(&pls->ctx);
263 av_freep(&c->playlists);
264 av_freep(&c->cookies);
265 av_freep(&c->user_agent);
266 av_freep(&c->headers);
267 av_freep(&c->http_proxy);
271 static void free_variant_list(HLSContext *c)
274 for (i = 0; i < c->n_variants; i++) {
275 struct variant *var = c->variants[i];
276 av_freep(&var->playlists);
279 av_freep(&c->variants);
283 static void free_rendition_list(HLSContext *c)
286 for (i = 0; i < c->n_renditions; i++)
287 av_freep(&c->renditions[i]);
288 av_freep(&c->renditions);
293 * Used to reset a statically allocated AVPacket to a clean slate,
294 * containing no data.
296 static void reset_packet(AVPacket *pkt)
302 static struct playlist *new_playlist(HLSContext *c, const char *url,
305 struct playlist *pls = av_mallocz(sizeof(struct playlist));
308 reset_packet(&pls->pkt);
309 ff_make_absolute_url(pls->url, sizeof(pls->url), base, url);
310 pls->seek_timestamp = AV_NOPTS_VALUE;
312 pls->is_id3_timestamped = -1;
313 pls->id3_mpegts_timestamp = AV_NOPTS_VALUE;
315 dynarray_add(&c->playlists, &c->n_playlists, pls);
319 struct variant_info {
321 /* variant group ids: */
322 char audio[MAX_FIELD_LEN];
323 char video[MAX_FIELD_LEN];
324 char subtitles[MAX_FIELD_LEN];
327 static struct variant *new_variant(HLSContext *c, struct variant_info *info,
328 const char *url, const char *base)
331 struct playlist *pls;
333 pls = new_playlist(c, url, base);
337 var = av_mallocz(sizeof(struct variant));
342 var->bandwidth = atoi(info->bandwidth);
343 strcpy(var->audio_group, info->audio);
344 strcpy(var->video_group, info->video);
345 strcpy(var->subtitles_group, info->subtitles);
348 dynarray_add(&c->variants, &c->n_variants, var);
349 dynarray_add(&var->playlists, &var->n_playlists, pls);
353 static void handle_variant_args(struct variant_info *info, const char *key,
354 int key_len, char **dest, int *dest_len)
356 if (!strncmp(key, "BANDWIDTH=", key_len)) {
357 *dest = info->bandwidth;
358 *dest_len = sizeof(info->bandwidth);
359 } else if (!strncmp(key, "AUDIO=", key_len)) {
361 *dest_len = sizeof(info->audio);
362 } else if (!strncmp(key, "VIDEO=", key_len)) {
364 *dest_len = sizeof(info->video);
365 } else if (!strncmp(key, "SUBTITLES=", key_len)) {
366 *dest = info->subtitles;
367 *dest_len = sizeof(info->subtitles);
372 char uri[MAX_URL_SIZE];
377 static void handle_key_args(struct key_info *info, const char *key,
378 int key_len, char **dest, int *dest_len)
380 if (!strncmp(key, "METHOD=", key_len)) {
381 *dest = info->method;
382 *dest_len = sizeof(info->method);
383 } else if (!strncmp(key, "URI=", key_len)) {
385 *dest_len = sizeof(info->uri);
386 } else if (!strncmp(key, "IV=", key_len)) {
388 *dest_len = sizeof(info->iv);
392 struct init_section_info {
393 char uri[MAX_URL_SIZE];
397 static struct segment *new_init_section(struct playlist *pls,
398 struct init_section_info *info,
399 const char *url_base)
403 char tmp_str[MAX_URL_SIZE];
408 sec = av_mallocz(sizeof(*sec));
412 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url_base, info->uri);
413 sec->url = av_strdup(tmp_str);
419 if (info->byterange[0]) {
420 sec->size = atoi(info->byterange);
421 ptr = strchr(info->byterange, '@');
423 sec->url_offset = atoi(ptr+1);
425 /* the entire file is the init section */
429 dynarray_add(&pls->init_sections, &pls->n_init_sections, sec);
434 static void handle_init_section_args(struct init_section_info *info, const char *key,
435 int key_len, char **dest, int *dest_len)
437 if (!strncmp(key, "URI=", key_len)) {
439 *dest_len = sizeof(info->uri);
440 } else if (!strncmp(key, "BYTERANGE=", key_len)) {
441 *dest = info->byterange;
442 *dest_len = sizeof(info->byterange);
446 struct rendition_info {
448 char uri[MAX_URL_SIZE];
449 char group_id[MAX_FIELD_LEN];
450 char language[MAX_FIELD_LEN];
451 char assoc_language[MAX_FIELD_LEN];
452 char name[MAX_FIELD_LEN];
455 char characteristics[MAX_CHARACTERISTICS_LEN];
458 static struct rendition *new_rendition(HLSContext *c, struct rendition_info *info,
459 const char *url_base)
461 struct rendition *rend;
462 enum AVMediaType type = AVMEDIA_TYPE_UNKNOWN;
463 char *characteristic;
467 if (!strcmp(info->type, "AUDIO"))
468 type = AVMEDIA_TYPE_AUDIO;
469 else if (!strcmp(info->type, "VIDEO"))
470 type = AVMEDIA_TYPE_VIDEO;
471 else if (!strcmp(info->type, "SUBTITLES"))
472 type = AVMEDIA_TYPE_SUBTITLE;
473 else if (!strcmp(info->type, "CLOSED-CAPTIONS"))
474 /* CLOSED-CAPTIONS is ignored since we do not support CEA-608 CC in
475 * AVC SEI RBSP anyway */
478 if (type == AVMEDIA_TYPE_UNKNOWN)
481 /* URI is mandatory for subtitles as per spec */
482 if (type == AVMEDIA_TYPE_SUBTITLE && !info->uri[0])
485 /* TODO: handle subtitles (each segment has to parsed separately) */
486 if (c->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL)
487 if (type == AVMEDIA_TYPE_SUBTITLE)
490 rend = av_mallocz(sizeof(struct rendition));
494 dynarray_add(&c->renditions, &c->n_renditions, rend);
497 strcpy(rend->group_id, info->group_id);
498 strcpy(rend->language, info->language);
499 strcpy(rend->name, info->name);
501 /* add the playlist if this is an external rendition */
503 rend->playlist = new_playlist(c, info->uri, url_base);
505 dynarray_add(&rend->playlist->renditions,
506 &rend->playlist->n_renditions, rend);
509 if (info->assoc_language[0]) {
510 int langlen = strlen(rend->language);
511 if (langlen < sizeof(rend->language) - 3) {
512 rend->language[langlen] = ',';
513 strncpy(rend->language + langlen + 1, info->assoc_language,
514 sizeof(rend->language) - langlen - 2);
518 if (!strcmp(info->defaultr, "YES"))
519 rend->disposition |= AV_DISPOSITION_DEFAULT;
520 if (!strcmp(info->forced, "YES"))
521 rend->disposition |= AV_DISPOSITION_FORCED;
523 chr_ptr = info->characteristics;
524 while ((characteristic = av_strtok(chr_ptr, ",", &saveptr))) {
525 if (!strcmp(characteristic, "public.accessibility.describes-music-and-sound"))
526 rend->disposition |= AV_DISPOSITION_HEARING_IMPAIRED;
527 else if (!strcmp(characteristic, "public.accessibility.describes-video"))
528 rend->disposition |= AV_DISPOSITION_VISUAL_IMPAIRED;
536 static void handle_rendition_args(struct rendition_info *info, const char *key,
537 int key_len, char **dest, int *dest_len)
539 if (!strncmp(key, "TYPE=", key_len)) {
541 *dest_len = sizeof(info->type);
542 } else if (!strncmp(key, "URI=", key_len)) {
544 *dest_len = sizeof(info->uri);
545 } else if (!strncmp(key, "GROUP-ID=", key_len)) {
546 *dest = info->group_id;
547 *dest_len = sizeof(info->group_id);
548 } else if (!strncmp(key, "LANGUAGE=", key_len)) {
549 *dest = info->language;
550 *dest_len = sizeof(info->language);
551 } else if (!strncmp(key, "ASSOC-LANGUAGE=", key_len)) {
552 *dest = info->assoc_language;
553 *dest_len = sizeof(info->assoc_language);
554 } else if (!strncmp(key, "NAME=", key_len)) {
556 *dest_len = sizeof(info->name);
557 } else if (!strncmp(key, "DEFAULT=", key_len)) {
558 *dest = info->defaultr;
559 *dest_len = sizeof(info->defaultr);
560 } else if (!strncmp(key, "FORCED=", key_len)) {
561 *dest = info->forced;
562 *dest_len = sizeof(info->forced);
563 } else if (!strncmp(key, "CHARACTERISTICS=", key_len)) {
564 *dest = info->characteristics;
565 *dest_len = sizeof(info->characteristics);
569 * - AUTOSELECT: client may autoselect based on e.g. system language
570 * - INSTREAM-ID: EIA-608 closed caption number ("CC1".."CC4")
574 /* used by parse_playlist to allocate a new variant+playlist when the
575 * playlist is detected to be a Media Playlist (not Master Playlist)
576 * and we have no parent Master Playlist (parsing of which would have
577 * allocated the variant and playlist already)
578 * *pls == NULL => Master Playlist or parentless Media Playlist
579 * *pls != NULL => parented Media Playlist, playlist+variant allocated */
580 static int ensure_playlist(HLSContext *c, struct playlist **pls, const char *url)
584 if (!new_variant(c, NULL, url, NULL))
585 return AVERROR(ENOMEM);
586 *pls = c->playlists[c->n_playlists - 1];
590 static void update_options(char **dest, const char *name, void *src)
593 av_opt_get(src, name, AV_OPT_SEARCH_CHILDREN, (uint8_t**)dest);
594 if (*dest && !strlen(*dest))
598 static int open_url(AVFormatContext *s, AVIOContext **pb, const char *url,
599 AVDictionary *opts, AVDictionary *opts2, int *is_http)
601 HLSContext *c = s->priv_data;
602 AVDictionary *tmp = NULL;
603 const char *proto_name = NULL;
606 av_dict_copy(&tmp, opts, 0);
607 av_dict_copy(&tmp, opts2, 0);
609 if (av_strstart(url, "crypto", NULL)) {
610 if (url[6] == '+' || url[6] == ':')
611 proto_name = avio_find_protocol_name(url + 7);
615 proto_name = avio_find_protocol_name(url);
618 return AVERROR_INVALIDDATA;
620 // only http(s) & file are allowed
621 if (!av_strstart(proto_name, "http", NULL) && !av_strstart(proto_name, "file", NULL))
622 return AVERROR_INVALIDDATA;
623 if (!strncmp(proto_name, url, strlen(proto_name)) && url[strlen(proto_name)] == ':')
625 else if (av_strstart(url, "crypto", NULL) && !strncmp(proto_name, url + 7, strlen(proto_name)) && url[7 + strlen(proto_name)] == ':')
627 else if (strcmp(proto_name, "file") || !strncmp(url, "file,", 5))
628 return AVERROR_INVALIDDATA;
630 ret = s->io_open(s, pb, url, AVIO_FLAG_READ, &tmp);
632 // update cookies on http response with setcookies.
633 void *u = (s->flags & AVFMT_FLAG_CUSTOM_IO) ? NULL : s->pb;
634 update_options(&c->cookies, "cookies", u);
635 av_dict_set(&opts, "cookies", c->cookies, 0);
641 *is_http = av_strstart(proto_name, "http", NULL);
646 static int parse_playlist(HLSContext *c, const char *url,
647 struct playlist *pls, AVIOContext *in)
649 int ret = 0, is_segment = 0, is_variant = 0;
650 int64_t duration = 0;
651 enum KeyType key_type = KEY_NONE;
654 char key[MAX_URL_SIZE] = "";
655 char line[MAX_URL_SIZE];
658 int64_t seg_offset = 0;
659 int64_t seg_size = -1;
660 uint8_t *new_url = NULL;
661 struct variant_info variant_info;
662 char tmp_str[MAX_URL_SIZE];
663 struct segment *cur_init_section = NULL;
667 AVDictionary *opts = NULL;
669 /* Some HLS servers don't like being sent the range header */
670 av_dict_set(&opts, "seekable", "0", 0);
672 // broker prior HTTP options that should be consistent across requests
673 av_dict_set(&opts, "user-agent", c->user_agent, 0);
674 av_dict_set(&opts, "cookies", c->cookies, 0);
675 av_dict_set(&opts, "headers", c->headers, 0);
676 av_dict_set(&opts, "http_proxy", c->http_proxy, 0);
678 ret = c->ctx->io_open(c->ctx, &in, url, AVIO_FLAG_READ, &opts);
683 ret = open_in(c, &in, url);
690 if (av_opt_get(in, "location", AV_OPT_SEARCH_CHILDREN, &new_url) >= 0)
693 read_chomp_line(in, line, sizeof(line));
694 if (strcmp(line, "#EXTM3U")) {
695 ret = AVERROR_INVALIDDATA;
700 free_segment_list(pls);
702 pls->type = PLS_TYPE_UNSPECIFIED;
704 while (!avio_feof(in)) {
705 read_chomp_line(in, line, sizeof(line));
706 if (av_strstart(line, "#EXT-X-STREAM-INF:", &ptr)) {
708 memset(&variant_info, 0, sizeof(variant_info));
709 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_variant_args,
711 } else if (av_strstart(line, "#EXT-X-KEY:", &ptr)) {
712 struct key_info info = {{0}};
713 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_key_args,
717 if (!strcmp(info.method, "AES-128"))
718 key_type = KEY_AES_128;
719 if (!strcmp(info.method, "SAMPLE-AES"))
720 key_type = KEY_SAMPLE_AES;
721 if (!strncmp(info.iv, "0x", 2) || !strncmp(info.iv, "0X", 2)) {
722 ff_hex_to_data(iv, info.iv + 2);
725 av_strlcpy(key, info.uri, sizeof(key));
726 } else if (av_strstart(line, "#EXT-X-MEDIA:", &ptr)) {
727 struct rendition_info info = {{0}};
728 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_rendition_args,
730 new_rendition(c, &info, url);
731 } else if (av_strstart(line, "#EXT-X-TARGETDURATION:", &ptr)) {
732 ret = ensure_playlist(c, &pls, url);
735 pls->target_duration = atoi(ptr) * AV_TIME_BASE;
736 } else if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
737 ret = ensure_playlist(c, &pls, url);
740 pls->start_seq_no = atoi(ptr);
741 } else if (av_strstart(line, "#EXT-X-PLAYLIST-TYPE:", &ptr)) {
742 ret = ensure_playlist(c, &pls, url);
745 if (!strcmp(ptr, "EVENT"))
746 pls->type = PLS_TYPE_EVENT;
747 else if (!strcmp(ptr, "VOD"))
748 pls->type = PLS_TYPE_VOD;
749 } else if (av_strstart(line, "#EXT-X-MAP:", &ptr)) {
750 struct init_section_info info = {{0}};
751 ret = ensure_playlist(c, &pls, url);
754 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_init_section_args,
756 cur_init_section = new_init_section(pls, &info, url);
757 } else if (av_strstart(line, "#EXT-X-ENDLIST", &ptr)) {
760 } else if (av_strstart(line, "#EXTINF:", &ptr)) {
762 duration = atof(ptr) * AV_TIME_BASE;
763 } else if (av_strstart(line, "#EXT-X-BYTERANGE:", &ptr)) {
764 seg_size = atoi(ptr);
765 ptr = strchr(ptr, '@');
767 seg_offset = atoi(ptr+1);
768 } else if (av_strstart(line, "#", NULL)) {
770 } else if (line[0]) {
772 if (!new_variant(c, &variant_info, line, url)) {
773 ret = AVERROR(ENOMEM);
781 if (!new_variant(c, 0, url, NULL)) {
782 ret = AVERROR(ENOMEM);
785 pls = c->playlists[c->n_playlists - 1];
787 seg = av_malloc(sizeof(struct segment));
789 ret = AVERROR(ENOMEM);
792 seg->duration = duration;
793 seg->key_type = key_type;
795 memcpy(seg->iv, iv, sizeof(iv));
797 int seq = pls->start_seq_no + pls->n_segments;
798 memset(seg->iv, 0, sizeof(seg->iv));
799 AV_WB32(seg->iv + 12, seq);
802 if (key_type != KEY_NONE) {
803 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, key);
804 seg->key = av_strdup(tmp_str);
807 ret = AVERROR(ENOMEM);
814 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, line);
815 seg->url = av_strdup(tmp_str);
819 ret = AVERROR(ENOMEM);
823 dynarray_add(&pls->segments, &pls->n_segments, seg);
826 seg->size = seg_size;
828 seg->url_offset = seg_offset;
829 seg_offset += seg_size;
836 seg->init_section = cur_init_section;
841 pls->last_load_time = av_gettime_relative();
846 ff_format_io_close(c->ctx, &in);
850 static struct segment *current_segment(struct playlist *pls)
852 return pls->segments[pls->cur_seq_no - pls->start_seq_no];
855 enum ReadFromURLMode {
860 static int read_from_url(struct playlist *pls, struct segment *seg,
861 uint8_t *buf, int buf_size,
862 enum ReadFromURLMode mode)
866 /* limit read if the segment was only a part of a file */
868 buf_size = FFMIN(buf_size, seg->size - pls->cur_seg_offset);
870 if (mode == READ_COMPLETE) {
871 ret = avio_read(pls->input, buf, buf_size);
873 av_log(NULL, AV_LOG_ERROR, "Could not read complete segment.\n");
875 ret = avio_read(pls->input, buf, buf_size);
878 pls->cur_seg_offset += ret;
883 /* Parse the raw ID3 data and pass contents to caller */
884 static void parse_id3(AVFormatContext *s, AVIOContext *pb,
885 AVDictionary **metadata, int64_t *dts,
886 ID3v2ExtraMetaAPIC **apic, ID3v2ExtraMeta **extra_meta)
888 static const char id3_priv_owner_ts[] = "com.apple.streaming.transportStreamTimestamp";
889 ID3v2ExtraMeta *meta;
891 ff_id3v2_read_dict(pb, metadata, ID3v2_DEFAULT_MAGIC, extra_meta);
892 for (meta = *extra_meta; meta; meta = meta->next) {
893 if (!strcmp(meta->tag, "PRIV")) {
894 ID3v2ExtraMetaPRIV *priv = meta->data;
895 if (priv->datasize == 8 && !strcmp(priv->owner, id3_priv_owner_ts)) {
896 /* 33-bit MPEG timestamp */
897 int64_t ts = AV_RB64(priv->data);
898 av_log(s, AV_LOG_DEBUG, "HLS ID3 audio timestamp %"PRId64"\n", ts);
899 if ((ts & ~((1ULL << 33) - 1)) == 0)
902 av_log(s, AV_LOG_ERROR, "Invalid HLS ID3 audio timestamp %"PRId64"\n", ts);
904 } else if (!strcmp(meta->tag, "APIC") && apic)
909 /* Check if the ID3 metadata contents have changed */
910 static int id3_has_changed_values(struct playlist *pls, AVDictionary *metadata,
911 ID3v2ExtraMetaAPIC *apic)
913 AVDictionaryEntry *entry = NULL;
914 AVDictionaryEntry *oldentry;
915 /* check that no keys have changed values */
916 while ((entry = av_dict_get(metadata, "", entry, AV_DICT_IGNORE_SUFFIX))) {
917 oldentry = av_dict_get(pls->id3_initial, entry->key, NULL, AV_DICT_MATCH_CASE);
918 if (!oldentry || strcmp(oldentry->value, entry->value) != 0)
922 /* check if apic appeared */
923 if (apic && (pls->ctx->nb_streams != 2 || !pls->ctx->streams[1]->attached_pic.data))
927 int size = pls->ctx->streams[1]->attached_pic.size;
928 if (size != apic->buf->size - AV_INPUT_BUFFER_PADDING_SIZE)
931 if (memcmp(apic->buf->data, pls->ctx->streams[1]->attached_pic.data, size) != 0)
938 /* Parse ID3 data and handle the found data */
939 static void handle_id3(AVIOContext *pb, struct playlist *pls)
941 AVDictionary *metadata = NULL;
942 ID3v2ExtraMetaAPIC *apic = NULL;
943 ID3v2ExtraMeta *extra_meta = NULL;
944 int64_t timestamp = AV_NOPTS_VALUE;
946 parse_id3(pls->ctx, pb, &metadata, ×tamp, &apic, &extra_meta);
948 if (timestamp != AV_NOPTS_VALUE) {
949 pls->id3_mpegts_timestamp = timestamp;
953 if (!pls->id3_found) {
954 /* initial ID3 tags */
955 av_assert0(!pls->id3_deferred_extra);
958 /* get picture attachment and set text metadata */
959 if (pls->ctx->nb_streams)
960 ff_id3v2_parse_apic(pls->ctx, &extra_meta);
962 /* demuxer not yet opened, defer picture attachment */
963 pls->id3_deferred_extra = extra_meta;
965 av_dict_copy(&pls->ctx->metadata, metadata, 0);
966 pls->id3_initial = metadata;
969 if (!pls->id3_changed && id3_has_changed_values(pls, metadata, apic)) {
970 avpriv_report_missing_feature(pls->ctx, "Changing ID3 metadata in HLS audio elementary stream");
971 pls->id3_changed = 1;
973 av_dict_free(&metadata);
976 if (!pls->id3_deferred_extra)
977 ff_id3v2_free_extra_meta(&extra_meta);
980 static void intercept_id3(struct playlist *pls, uint8_t *buf,
981 int buf_size, int *len)
983 /* intercept id3 tags, we do not want to pass them to the raw
984 * demuxer on all segment switches */
988 struct segment *seg = current_segment(pls);
990 /* gather all the id3 tags */
992 /* see if we can retrieve enough data for ID3 header */
993 if (*len < ID3v2_HEADER_SIZE && buf_size >= ID3v2_HEADER_SIZE) {
994 bytes = read_from_url(pls, seg, buf + *len, ID3v2_HEADER_SIZE - *len, READ_COMPLETE);
997 if (bytes == ID3v2_HEADER_SIZE - *len)
998 /* no EOF yet, so fill the caller buffer again after
999 * we have stripped the ID3 tags */
1004 } else if (*len <= 0) {
1011 if (*len < ID3v2_HEADER_SIZE)
1014 if (ff_id3v2_match(buf, ID3v2_DEFAULT_MAGIC)) {
1015 int64_t maxsize = seg->size >= 0 ? seg->size : 1024*1024;
1016 int taglen = ff_id3v2_tag_len(buf);
1017 int tag_got_bytes = FFMIN(taglen, *len);
1018 int remaining = taglen - tag_got_bytes;
1020 if (taglen > maxsize) {
1021 av_log(pls->ctx, AV_LOG_ERROR, "Too large HLS ID3 tag (%d > %"PRId64" bytes)\n",
1027 * Copy the id3 tag to our temporary id3 buffer.
1028 * We could read a small id3 tag directly without memcpy, but
1029 * we would still need to copy the large tags, and handling
1030 * both of those cases together with the possibility for multiple
1031 * tags would make the handling a bit complex.
1033 pls->id3_buf = av_fast_realloc(pls->id3_buf, &pls->id3_buf_size, id3_buf_pos + taglen);
1036 memcpy(pls->id3_buf + id3_buf_pos, buf, tag_got_bytes);
1037 id3_buf_pos += tag_got_bytes;
1039 /* strip the intercepted bytes */
1040 *len -= tag_got_bytes;
1041 memmove(buf, buf + tag_got_bytes, *len);
1042 av_log(pls->ctx, AV_LOG_DEBUG, "Stripped %d HLS ID3 bytes\n", tag_got_bytes);
1044 if (remaining > 0) {
1045 /* read the rest of the tag in */
1046 if (read_from_url(pls, seg, pls->id3_buf + id3_buf_pos, remaining, READ_COMPLETE) != remaining)
1048 id3_buf_pos += remaining;
1049 av_log(pls->ctx, AV_LOG_DEBUG, "Stripped additional %d HLS ID3 bytes\n", remaining);
1053 /* no more ID3 tags */
1058 /* re-fill buffer for the caller unless EOF */
1059 if (*len >= 0 && (fill_buf || *len == 0)) {
1060 bytes = read_from_url(pls, seg, buf + *len, buf_size - *len, READ_NORMAL);
1062 /* ignore error if we already had some data */
1070 /* Now parse all the ID3 tags */
1071 AVIOContext id3ioctx;
1072 ffio_init_context(&id3ioctx, pls->id3_buf, id3_buf_pos, 0, NULL, NULL, NULL, NULL);
1073 handle_id3(&id3ioctx, pls);
1076 if (pls->is_id3_timestamped == -1)
1077 pls->is_id3_timestamped = (pls->id3_mpegts_timestamp != AV_NOPTS_VALUE);
1080 static int open_input(HLSContext *c, struct playlist *pls, struct segment *seg)
1082 AVDictionary *opts = NULL;
1086 // broker prior HTTP options that should be consistent across requests
1087 av_dict_set(&opts, "user-agent", c->user_agent, 0);
1088 av_dict_set(&opts, "cookies", c->cookies, 0);
1089 av_dict_set(&opts, "headers", c->headers, 0);
1090 av_dict_set(&opts, "http_proxy", c->http_proxy, 0);
1091 av_dict_set(&opts, "seekable", "0", 0);
1093 if (seg->size >= 0) {
1094 /* try to restrict the HTTP request to the part we want
1095 * (if this is in fact a HTTP request) */
1096 av_dict_set_int(&opts, "offset", seg->url_offset, 0);
1097 av_dict_set_int(&opts, "end_offset", seg->url_offset + seg->size, 0);
1100 av_log(pls->parent, AV_LOG_VERBOSE, "HLS request for url '%s', offset %"PRId64", playlist %d\n",
1101 seg->url, seg->url_offset, pls->index);
1103 if (seg->key_type == KEY_NONE) {
1104 ret = open_url(pls->parent, &pls->input, seg->url, c->avio_opts, opts, &is_http);
1105 } else if (seg->key_type == KEY_AES_128) {
1106 AVDictionary *opts2 = NULL;
1107 char iv[33], key[33], url[MAX_URL_SIZE];
1108 if (strcmp(seg->key, pls->key_url)) {
1110 if (open_url(pls->parent, &pb, seg->key, c->avio_opts, opts, NULL) == 0) {
1111 ret = avio_read(pb, pls->key, sizeof(pls->key));
1112 if (ret != sizeof(pls->key)) {
1113 av_log(NULL, AV_LOG_ERROR, "Unable to read key file %s\n",
1116 ff_format_io_close(pls->parent, &pb);
1118 av_log(NULL, AV_LOG_ERROR, "Unable to open key file %s\n",
1121 av_strlcpy(pls->key_url, seg->key, sizeof(pls->key_url));
1123 ff_data_to_hex(iv, seg->iv, sizeof(seg->iv), 0);
1124 ff_data_to_hex(key, pls->key, sizeof(pls->key), 0);
1125 iv[32] = key[32] = '\0';
1126 if (strstr(seg->url, "://"))
1127 snprintf(url, sizeof(url), "crypto+%s", seg->url);
1129 snprintf(url, sizeof(url), "crypto:%s", seg->url);
1131 av_dict_copy(&opts2, c->avio_opts, 0);
1132 av_dict_set(&opts2, "key", key, 0);
1133 av_dict_set(&opts2, "iv", iv, 0);
1135 ret = open_url(pls->parent, &pls->input, url, opts2, opts, &is_http);
1137 av_dict_free(&opts2);
1143 } else if (seg->key_type == KEY_SAMPLE_AES) {
1144 av_log(pls->parent, AV_LOG_ERROR,
1145 "SAMPLE-AES encryption is not supported yet\n");
1146 ret = AVERROR_PATCHWELCOME;
1149 ret = AVERROR(ENOSYS);
1151 /* Seek to the requested position. If this was a HTTP request, the offset
1152 * should already be where want it to, but this allows e.g. local testing
1153 * without a HTTP server.
1155 * This is not done for HTTP at all as avio_seek() does internal bookkeeping
1156 * of file offset which is out-of-sync with the actual offset when "offset"
1157 * AVOption is used with http protocol, causing the seek to not be a no-op
1158 * as would be expected. Wrong offset received from the server will not be
1159 * noticed without the call, though.
1161 if (ret == 0 && !is_http && seg->key_type == KEY_NONE && seg->url_offset) {
1162 int64_t seekret = avio_seek(pls->input, seg->url_offset, SEEK_SET);
1164 av_log(pls->parent, AV_LOG_ERROR, "Unable to seek to offset %"PRId64" of HLS segment '%s'\n", seg->url_offset, seg->url);
1166 ff_format_io_close(pls->parent, &pls->input);
1171 av_dict_free(&opts);
1172 pls->cur_seg_offset = 0;
1176 static int update_init_section(struct playlist *pls, struct segment *seg)
1178 static const int max_init_section_size = 1024*1024;
1179 HLSContext *c = pls->parent->priv_data;
1184 if (seg->init_section == pls->cur_init_section)
1187 pls->cur_init_section = NULL;
1189 if (!seg->init_section)
1192 ret = open_input(c, pls, seg->init_section);
1194 av_log(pls->parent, AV_LOG_WARNING,
1195 "Failed to open an initialization section in playlist %d\n",
1200 if (seg->init_section->size >= 0)
1201 sec_size = seg->init_section->size;
1202 else if ((urlsize = avio_size(pls->input)) >= 0)
1205 sec_size = max_init_section_size;
1207 av_log(pls->parent, AV_LOG_DEBUG,
1208 "Downloading an initialization section of size %"PRId64"\n",
1211 sec_size = FFMIN(sec_size, max_init_section_size);
1213 av_fast_malloc(&pls->init_sec_buf, &pls->init_sec_buf_size, sec_size);
1215 ret = read_from_url(pls, seg->init_section, pls->init_sec_buf,
1216 pls->init_sec_buf_size, READ_COMPLETE);
1217 ff_format_io_close(pls->parent, &pls->input);
1222 pls->cur_init_section = seg->init_section;
1223 pls->init_sec_data_len = ret;
1224 pls->init_sec_buf_read_offset = 0;
1226 /* spec says audio elementary streams do not have media initialization
1227 * sections, so there should be no ID3 timestamps */
1228 pls->is_id3_timestamped = 0;
1233 static int64_t default_reload_interval(struct playlist *pls)
1235 return pls->n_segments > 0 ?
1236 pls->segments[pls->n_segments - 1]->duration :
1237 pls->target_duration;
1240 static int read_data(void *opaque, uint8_t *buf, int buf_size)
1242 struct playlist *v = opaque;
1243 HLSContext *c = v->parent->priv_data;
1245 int just_opened = 0;
1252 int64_t reload_interval;
1253 struct segment *seg;
1255 /* Check that the playlist is still needed before opening a new
1257 if (v->ctx && v->ctx->nb_streams) {
1259 for (i = 0; i < v->n_main_streams; i++) {
1260 if (v->main_streams[i]->discard < AVDISCARD_ALL) {
1267 av_log(v->parent, AV_LOG_INFO, "No longer receiving playlist %d\n",
1272 /* If this is a live stream and the reload interval has elapsed since
1273 * the last playlist reload, reload the playlists now. */
1274 reload_interval = default_reload_interval(v);
1278 av_gettime_relative() - v->last_load_time >= reload_interval) {
1279 if ((ret = parse_playlist(c, v->url, v, NULL)) < 0) {
1280 av_log(v->parent, AV_LOG_WARNING, "Failed to reload playlist %d\n",
1284 /* If we need to reload the playlist again below (if
1285 * there's still no more segments), switch to a reload
1286 * interval of half the target duration. */
1287 reload_interval = v->target_duration / 2;
1289 if (v->cur_seq_no < v->start_seq_no) {
1290 av_log(NULL, AV_LOG_WARNING,
1291 "skipping %d segments ahead, expired from playlists\n",
1292 v->start_seq_no - v->cur_seq_no);
1293 v->cur_seq_no = v->start_seq_no;
1295 if (v->cur_seq_no >= v->start_seq_no + v->n_segments) {
1298 while (av_gettime_relative() - v->last_load_time < reload_interval) {
1299 if (ff_check_interrupt(c->interrupt_callback))
1300 return AVERROR_EXIT;
1301 av_usleep(100*1000);
1303 /* Enough time has elapsed since the last reload */
1307 seg = current_segment(v);
1309 /* load/update Media Initialization Section, if any */
1310 ret = update_init_section(v, seg);
1314 ret = open_input(c, v, seg);
1316 if (ff_check_interrupt(c->interrupt_callback))
1317 return AVERROR_EXIT;
1318 av_log(v->parent, AV_LOG_WARNING, "Failed to open segment of playlist %d\n",
1326 if (v->init_sec_buf_read_offset < v->init_sec_data_len) {
1327 /* Push init section out first before first actual segment */
1328 int copy_size = FFMIN(v->init_sec_data_len - v->init_sec_buf_read_offset, buf_size);
1329 memcpy(buf, v->init_sec_buf, copy_size);
1330 v->init_sec_buf_read_offset += copy_size;
1334 ret = read_from_url(v, current_segment(v), buf, buf_size, READ_NORMAL);
1336 if (just_opened && v->is_id3_timestamped != 0) {
1337 /* Intercept ID3 tags here, elementary audio streams are required
1338 * to convey timestamps using them in the beginning of each segment. */
1339 intercept_id3(v, buf, buf_size, &ret);
1344 ff_format_io_close(v->parent, &v->input);
1347 c->cur_seq_no = v->cur_seq_no;
1352 static void add_renditions_to_variant(HLSContext *c, struct variant *var,
1353 enum AVMediaType type, const char *group_id)
1357 for (i = 0; i < c->n_renditions; i++) {
1358 struct rendition *rend = c->renditions[i];
1360 if (rend->type == type && !strcmp(rend->group_id, group_id)) {
1363 /* rendition is an external playlist
1364 * => add the playlist to the variant */
1365 dynarray_add(&var->playlists, &var->n_playlists, rend->playlist);
1367 /* rendition is part of the variant main Media Playlist
1368 * => add the rendition to the main Media Playlist */
1369 dynarray_add(&var->playlists[0]->renditions,
1370 &var->playlists[0]->n_renditions,
1376 static void add_metadata_from_renditions(AVFormatContext *s, struct playlist *pls,
1377 enum AVMediaType type)
1382 for (i = 0; i < pls->n_main_streams; i++) {
1383 AVStream *st = pls->main_streams[i];
1385 if (st->codecpar->codec_type != type)
1388 for (; rend_idx < pls->n_renditions; rend_idx++) {
1389 struct rendition *rend = pls->renditions[rend_idx];
1391 if (rend->type != type)
1394 if (rend->language[0])
1395 av_dict_set(&st->metadata, "language", rend->language, 0);
1397 av_dict_set(&st->metadata, "comment", rend->name, 0);
1399 st->disposition |= rend->disposition;
1401 if (rend_idx >=pls->n_renditions)
1406 /* if timestamp was in valid range: returns 1 and sets seq_no
1407 * if not: returns 0 and sets seq_no to closest segment */
1408 static int find_timestamp_in_playlist(HLSContext *c, struct playlist *pls,
1409 int64_t timestamp, int *seq_no)
1412 int64_t pos = c->first_timestamp == AV_NOPTS_VALUE ?
1413 0 : c->first_timestamp;
1415 if (timestamp < pos) {
1416 *seq_no = pls->start_seq_no;
1420 for (i = 0; i < pls->n_segments; i++) {
1421 int64_t diff = pos + pls->segments[i]->duration - timestamp;
1423 *seq_no = pls->start_seq_no + i;
1426 pos += pls->segments[i]->duration;
1429 *seq_no = pls->start_seq_no + pls->n_segments - 1;
1434 static int select_cur_seq_no(HLSContext *c, struct playlist *pls)
1438 if (!pls->finished && !c->first_packet &&
1439 av_gettime_relative() - pls->last_load_time >= default_reload_interval(pls))
1440 /* reload the playlist since it was suspended */
1441 parse_playlist(c, pls->url, pls, NULL);
1443 /* If playback is already in progress (we are just selecting a new
1444 * playlist) and this is a complete file, find the matching segment
1445 * by counting durations. */
1446 if (pls->finished && c->cur_timestamp != AV_NOPTS_VALUE) {
1447 find_timestamp_in_playlist(c, pls, c->cur_timestamp, &seq_no);
1451 if (!pls->finished) {
1452 if (!c->first_packet && /* we are doing a segment selection during playback */
1453 c->cur_seq_no >= pls->start_seq_no &&
1454 c->cur_seq_no < pls->start_seq_no + pls->n_segments)
1455 /* While spec 3.4.3 says that we cannot assume anything about the
1456 * content at the same sequence number on different playlists,
1457 * in practice this seems to work and doing it otherwise would
1458 * require us to download a segment to inspect its timestamps. */
1459 return c->cur_seq_no;
1461 /* If this is a live stream, start live_start_index segments from the
1463 if (c->live_start_index < 0)
1464 return pls->start_seq_no + FFMAX(pls->n_segments + c->live_start_index, 0);
1466 return pls->start_seq_no + FFMIN(c->live_start_index, pls->n_segments - 1);
1469 /* Otherwise just start on the first segment. */
1470 return pls->start_seq_no;
1473 static int save_avio_options(AVFormatContext *s)
1475 HLSContext *c = s->priv_data;
1476 static const char *opts[] = {
1477 "headers", "http_proxy", "user_agent", "user-agent", "cookies", NULL };
1478 const char **opt = opts;
1483 if (av_opt_get(s->pb, *opt, AV_OPT_SEARCH_CHILDREN | AV_OPT_ALLOW_NULL, &buf) >= 0) {
1484 ret = av_dict_set(&c->avio_opts, *opt, buf,
1485 AV_DICT_DONT_STRDUP_VAL);
1495 static int nested_io_open(AVFormatContext *s, AVIOContext **pb, const char *url,
1496 int flags, AVDictionary **opts)
1498 av_log(s, AV_LOG_ERROR,
1499 "A HLS playlist item '%s' referred to an external file '%s'. "
1500 "Opening this file was forbidden for security reasons\n",
1502 return AVERROR(EPERM);
1505 static void add_stream_to_programs(AVFormatContext *s, struct playlist *pls, AVStream *stream)
1507 HLSContext *c = s->priv_data;
1511 for (i = 0; i < c->n_variants; i++) {
1512 struct variant *v = c->variants[i];
1514 for (j = 0; j < v->n_playlists; j++) {
1515 if (v->playlists[j] != pls)
1518 av_program_add_stream_index(s, i, stream->index);
1521 bandwidth = v->bandwidth;
1522 else if (bandwidth != v->bandwidth)
1523 bandwidth = -1; /* stream in multiple variants with different bandwidths */
1528 av_dict_set_int(&stream->metadata, "variant_bitrate", bandwidth, 0);
1531 /* add new subdemuxer streams to our context, if any */
1532 static int update_streams_from_subdemuxer(AVFormatContext *s, struct playlist *pls)
1534 while (pls->n_main_streams < pls->ctx->nb_streams) {
1535 int ist_idx = pls->n_main_streams;
1536 AVStream *st = avformat_new_stream(s, NULL);
1537 AVStream *ist = pls->ctx->streams[ist_idx];
1540 return AVERROR(ENOMEM);
1542 st->id = pls->index;
1544 avcodec_parameters_copy(st->codecpar, ist->codecpar);
1546 if (pls->is_id3_timestamped) /* custom timestamps via id3 */
1547 avpriv_set_pts_info(st, 33, 1, MPEG_TIME_BASE);
1549 avpriv_set_pts_info(st, ist->pts_wrap_bits, ist->time_base.num, ist->time_base.den);
1551 dynarray_add(&pls->main_streams, &pls->n_main_streams, st);
1553 add_stream_to_programs(s, pls, st);
1559 static void update_noheader_flag(AVFormatContext *s)
1561 HLSContext *c = s->priv_data;
1562 int flag_needed = 0;
1565 for (i = 0; i < c->n_playlists; i++) {
1566 struct playlist *pls = c->playlists[i];
1568 if (pls->has_noheader_flag) {
1575 s->ctx_flags |= AVFMTCTX_NOHEADER;
1577 s->ctx_flags &= ~AVFMTCTX_NOHEADER;
1580 static int hls_read_header(AVFormatContext *s)
1582 void *u = (s->flags & AVFMT_FLAG_CUSTOM_IO) ? NULL : s->pb;
1583 HLSContext *c = s->priv_data;
1585 int highest_cur_seq_no = 0;
1588 c->interrupt_callback = &s->interrupt_callback;
1589 c->strict_std_compliance = s->strict_std_compliance;
1591 c->first_packet = 1;
1592 c->first_timestamp = AV_NOPTS_VALUE;
1593 c->cur_timestamp = AV_NOPTS_VALUE;
1596 // get the previous user agent & set back to null if string size is zero
1597 update_options(&c->user_agent, "user-agent", u);
1599 // get the previous cookies & set back to null if string size is zero
1600 update_options(&c->cookies, "cookies", u);
1602 // get the previous headers & set back to null if string size is zero
1603 update_options(&c->headers, "headers", u);
1605 // get the previous http proxt & set back to null if string size is zero
1606 update_options(&c->http_proxy, "http_proxy", u);
1609 if ((ret = parse_playlist(c, s->filename, NULL, s->pb)) < 0)
1612 if ((ret = save_avio_options(s)) < 0)
1615 /* Some HLS servers don't like being sent the range header */
1616 av_dict_set(&c->avio_opts, "seekable", "0", 0);
1618 if (c->n_variants == 0) {
1619 av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1623 /* If the playlist only contained playlists (Master Playlist),
1624 * parse each individual playlist. */
1625 if (c->n_playlists > 1 || c->playlists[0]->n_segments == 0) {
1626 for (i = 0; i < c->n_playlists; i++) {
1627 struct playlist *pls = c->playlists[i];
1628 if ((ret = parse_playlist(c, pls->url, pls, NULL)) < 0)
1633 if (c->variants[0]->playlists[0]->n_segments == 0) {
1634 av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1639 /* If this isn't a live stream, calculate the total duration of the
1641 if (c->variants[0]->playlists[0]->finished) {
1642 int64_t duration = 0;
1643 for (i = 0; i < c->variants[0]->playlists[0]->n_segments; i++)
1644 duration += c->variants[0]->playlists[0]->segments[i]->duration;
1645 s->duration = duration;
1648 /* Associate renditions with variants */
1649 for (i = 0; i < c->n_variants; i++) {
1650 struct variant *var = c->variants[i];
1652 if (var->audio_group[0])
1653 add_renditions_to_variant(c, var, AVMEDIA_TYPE_AUDIO, var->audio_group);
1654 if (var->video_group[0])
1655 add_renditions_to_variant(c, var, AVMEDIA_TYPE_VIDEO, var->video_group);
1656 if (var->subtitles_group[0])
1657 add_renditions_to_variant(c, var, AVMEDIA_TYPE_SUBTITLE, var->subtitles_group);
1660 /* Create a program for each variant */
1661 for (i = 0; i < c->n_variants; i++) {
1662 struct variant *v = c->variants[i];
1665 program = av_new_program(s, i);
1668 av_dict_set_int(&program->metadata, "variant_bitrate", v->bandwidth, 0);
1671 /* Select the starting segments */
1672 for (i = 0; i < c->n_playlists; i++) {
1673 struct playlist *pls = c->playlists[i];
1675 if (pls->n_segments == 0)
1678 pls->cur_seq_no = select_cur_seq_no(c, pls);
1679 highest_cur_seq_no = FFMAX(highest_cur_seq_no, pls->cur_seq_no);
1682 /* Open the demuxer for each playlist */
1683 for (i = 0; i < c->n_playlists; i++) {
1684 struct playlist *pls = c->playlists[i];
1685 AVInputFormat *in_fmt = NULL;
1687 if (!(pls->ctx = avformat_alloc_context())) {
1688 ret = AVERROR(ENOMEM);
1692 if (pls->n_segments == 0)
1700 * If this is a live stream and this playlist looks like it is one segment
1701 * behind, try to sync it up so that every substream starts at the same
1702 * time position (so e.g. avformat_find_stream_info() will see packets from
1703 * all active streams within the first few seconds). This is not very generic,
1704 * though, as the sequence numbers are technically independent.
1706 if (!pls->finished && pls->cur_seq_no == highest_cur_seq_no - 1 &&
1707 highest_cur_seq_no < pls->start_seq_no + pls->n_segments) {
1708 pls->cur_seq_no = highest_cur_seq_no;
1711 pls->read_buffer = av_malloc(INITIAL_BUFFER_SIZE);
1712 if (!pls->read_buffer){
1713 ret = AVERROR(ENOMEM);
1714 avformat_free_context(pls->ctx);
1718 ffio_init_context(&pls->pb, pls->read_buffer, INITIAL_BUFFER_SIZE, 0, pls,
1719 read_data, NULL, NULL);
1720 pls->pb.seekable = 0;
1721 ret = av_probe_input_buffer(&pls->pb, &in_fmt, pls->segments[0]->url,
1724 /* Free the ctx - it isn't initialized properly at this point,
1725 * so avformat_close_input shouldn't be called. If
1726 * avformat_open_input fails below, it frees and zeros the
1727 * context, so it doesn't need any special treatment like this. */
1728 av_log(s, AV_LOG_ERROR, "Error when loading first segment '%s'\n", pls->segments[0]->url);
1729 avformat_free_context(pls->ctx);
1733 pls->ctx->pb = &pls->pb;
1734 pls->ctx->io_open = nested_io_open;
1736 if ((ret = ff_copy_whiteblacklists(pls->ctx, s)) < 0)
1739 ret = avformat_open_input(&pls->ctx, pls->segments[0]->url, in_fmt, NULL);
1743 if (pls->id3_deferred_extra && pls->ctx->nb_streams == 1) {
1744 ff_id3v2_parse_apic(pls->ctx, &pls->id3_deferred_extra);
1745 avformat_queue_attached_pictures(pls->ctx);
1746 ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
1747 pls->id3_deferred_extra = NULL;
1750 if (pls->is_id3_timestamped == -1)
1751 av_log(s, AV_LOG_WARNING, "No expected HTTP requests have been made\n");
1754 * For ID3 timestamped raw audio streams we need to detect the packet
1755 * durations to calculate timestamps in fill_timing_for_id3_timestamped_stream(),
1756 * but for other streams we can rely on our user calling avformat_find_stream_info()
1757 * on us if they want to.
1759 if (pls->is_id3_timestamped) {
1760 ret = avformat_find_stream_info(pls->ctx, NULL);
1765 pls->has_noheader_flag = !!(pls->ctx->ctx_flags & AVFMTCTX_NOHEADER);
1767 /* Create new AVStreams for each stream in this playlist */
1768 ret = update_streams_from_subdemuxer(s, pls);
1772 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_AUDIO);
1773 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_VIDEO);
1774 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_SUBTITLE);
1777 update_noheader_flag(s);
1781 free_playlist_list(c);
1782 free_variant_list(c);
1783 free_rendition_list(c);
1787 static int recheck_discard_flags(AVFormatContext *s, int first)
1789 HLSContext *c = s->priv_data;
1792 /* Check if any new streams are needed */
1793 for (i = 0; i < c->n_playlists; i++)
1794 c->playlists[i]->cur_needed = 0;
1796 for (i = 0; i < s->nb_streams; i++) {
1797 AVStream *st = s->streams[i];
1798 struct playlist *pls = c->playlists[s->streams[i]->id];
1799 if (st->discard < AVDISCARD_ALL)
1800 pls->cur_needed = 1;
1802 for (i = 0; i < c->n_playlists; i++) {
1803 struct playlist *pls = c->playlists[i];
1804 if (pls->cur_needed && !pls->needed) {
1807 pls->cur_seq_no = select_cur_seq_no(c, pls);
1808 pls->pb.eof_reached = 0;
1809 if (c->cur_timestamp != AV_NOPTS_VALUE) {
1811 pls->seek_timestamp = c->cur_timestamp;
1812 pls->seek_flags = AVSEEK_FLAG_ANY;
1813 pls->seek_stream_index = -1;
1815 av_log(s, AV_LOG_INFO, "Now receiving playlist %d, segment %d\n", i, pls->cur_seq_no);
1816 } else if (first && !pls->cur_needed && pls->needed) {
1818 ff_format_io_close(pls->parent, &pls->input);
1821 av_log(s, AV_LOG_INFO, "No longer receiving playlist %d\n", i);
1827 static void fill_timing_for_id3_timestamped_stream(struct playlist *pls)
1829 if (pls->id3_offset >= 0) {
1830 pls->pkt.dts = pls->id3_mpegts_timestamp +
1831 av_rescale_q(pls->id3_offset,
1832 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1834 if (pls->pkt.duration)
1835 pls->id3_offset += pls->pkt.duration;
1837 pls->id3_offset = -1;
1839 /* there have been packets with unknown duration
1840 * since the last id3 tag, should not normally happen */
1841 pls->pkt.dts = AV_NOPTS_VALUE;
1844 if (pls->pkt.duration)
1845 pls->pkt.duration = av_rescale_q(pls->pkt.duration,
1846 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1849 pls->pkt.pts = AV_NOPTS_VALUE;
1852 static AVRational get_timebase(struct playlist *pls)
1854 if (pls->is_id3_timestamped)
1855 return MPEG_TIME_BASE_Q;
1857 return pls->ctx->streams[pls->pkt.stream_index]->time_base;
1860 static int compare_ts_with_wrapdetect(int64_t ts_a, struct playlist *pls_a,
1861 int64_t ts_b, struct playlist *pls_b)
1863 int64_t scaled_ts_a = av_rescale_q(ts_a, get_timebase(pls_a), MPEG_TIME_BASE_Q);
1864 int64_t scaled_ts_b = av_rescale_q(ts_b, get_timebase(pls_b), MPEG_TIME_BASE_Q);
1866 return av_compare_mod(scaled_ts_a, scaled_ts_b, 1LL << 33);
1869 static int hls_read_packet(AVFormatContext *s, AVPacket *pkt)
1871 HLSContext *c = s->priv_data;
1872 int ret, i, minplaylist = -1;
1874 recheck_discard_flags(s, c->first_packet);
1875 c->first_packet = 0;
1877 for (i = 0; i < c->n_playlists; i++) {
1878 struct playlist *pls = c->playlists[i];
1879 /* Make sure we've got one buffered packet from each open playlist
1881 if (pls->needed && !pls->pkt.data) {
1885 ret = av_read_frame(pls->ctx, &pls->pkt);
1887 if (!avio_feof(&pls->pb) && ret != AVERROR_EOF)
1889 reset_packet(&pls->pkt);
1892 /* stream_index check prevents matching picture attachments etc. */
1893 if (pls->is_id3_timestamped && pls->pkt.stream_index == 0) {
1894 /* audio elementary streams are id3 timestamped */
1895 fill_timing_for_id3_timestamped_stream(pls);
1898 if (c->first_timestamp == AV_NOPTS_VALUE &&
1899 pls->pkt.dts != AV_NOPTS_VALUE)
1900 c->first_timestamp = av_rescale_q(pls->pkt.dts,
1901 get_timebase(pls), AV_TIME_BASE_Q);
1904 if (pls->seek_timestamp == AV_NOPTS_VALUE)
1907 if (pls->seek_stream_index < 0 ||
1908 pls->seek_stream_index == pls->pkt.stream_index) {
1910 if (pls->pkt.dts == AV_NOPTS_VALUE) {
1911 pls->seek_timestamp = AV_NOPTS_VALUE;
1915 tb = get_timebase(pls);
1916 ts_diff = av_rescale_rnd(pls->pkt.dts, AV_TIME_BASE,
1917 tb.den, AV_ROUND_DOWN) -
1918 pls->seek_timestamp;
1919 if (ts_diff >= 0 && (pls->seek_flags & AVSEEK_FLAG_ANY ||
1920 pls->pkt.flags & AV_PKT_FLAG_KEY)) {
1921 pls->seek_timestamp = AV_NOPTS_VALUE;
1925 av_packet_unref(&pls->pkt);
1926 reset_packet(&pls->pkt);
1929 /* Check if this stream has the packet with the lowest dts */
1930 if (pls->pkt.data) {
1931 struct playlist *minpls = minplaylist < 0 ?
1932 NULL : c->playlists[minplaylist];
1933 if (minplaylist < 0) {
1936 int64_t dts = pls->pkt.dts;
1937 int64_t mindts = minpls->pkt.dts;
1939 if (dts == AV_NOPTS_VALUE ||
1940 (mindts != AV_NOPTS_VALUE && compare_ts_with_wrapdetect(dts, pls, mindts, minpls) < 0))
1946 /* If we got a packet, return it */
1947 if (minplaylist >= 0) {
1948 struct playlist *pls = c->playlists[minplaylist];
1950 ret = update_streams_from_subdemuxer(s, pls);
1952 av_packet_unref(&pls->pkt);
1953 reset_packet(&pls->pkt);
1957 /* check if noheader flag has been cleared by the subdemuxer */
1958 if (pls->has_noheader_flag && !(pls->ctx->ctx_flags & AVFMTCTX_NOHEADER)) {
1959 pls->has_noheader_flag = 0;
1960 update_noheader_flag(s);
1963 if (pls->pkt.stream_index >= pls->n_main_streams) {
1964 av_log(s, AV_LOG_ERROR, "stream index inconsistency: index %d, %d main streams, %d subdemuxer streams\n",
1965 pls->pkt.stream_index, pls->n_main_streams, pls->ctx->nb_streams);
1966 av_packet_unref(&pls->pkt);
1967 reset_packet(&pls->pkt);
1972 pkt->stream_index = pls->main_streams[pls->pkt.stream_index]->index;
1973 reset_packet(&c->playlists[minplaylist]->pkt);
1975 if (pkt->dts != AV_NOPTS_VALUE)
1976 c->cur_timestamp = av_rescale_q(pkt->dts,
1977 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1985 static int hls_close(AVFormatContext *s)
1987 HLSContext *c = s->priv_data;
1989 free_playlist_list(c);
1990 free_variant_list(c);
1991 free_rendition_list(c);
1993 av_dict_free(&c->avio_opts);
1998 static int hls_read_seek(AVFormatContext *s, int stream_index,
1999 int64_t timestamp, int flags)
2001 HLSContext *c = s->priv_data;
2002 struct playlist *seek_pls = NULL;
2005 int stream_subdemuxer_index;
2006 int64_t first_timestamp, seek_timestamp, duration;
2008 if ((flags & AVSEEK_FLAG_BYTE) ||
2009 !(c->variants[0]->playlists[0]->finished || c->variants[0]->playlists[0]->type == PLS_TYPE_EVENT))
2010 return AVERROR(ENOSYS);
2012 first_timestamp = c->first_timestamp == AV_NOPTS_VALUE ?
2013 0 : c->first_timestamp;
2015 seek_timestamp = av_rescale_rnd(timestamp, AV_TIME_BASE,
2016 s->streams[stream_index]->time_base.den,
2017 flags & AVSEEK_FLAG_BACKWARD ?
2018 AV_ROUND_DOWN : AV_ROUND_UP);
2020 duration = s->duration == AV_NOPTS_VALUE ?
2023 if (0 < duration && duration < seek_timestamp - first_timestamp)
2024 return AVERROR(EIO);
2026 /* find the playlist with the specified stream */
2027 for (i = 0; i < c->n_playlists; i++) {
2028 struct playlist *pls = c->playlists[i];
2029 for (j = 0; j < pls->n_main_streams; j++) {
2030 if (pls->main_streams[j] == s->streams[stream_index]) {
2032 stream_subdemuxer_index = j;
2037 /* check if the timestamp is valid for the playlist with the
2038 * specified stream index */
2039 if (!seek_pls || !find_timestamp_in_playlist(c, seek_pls, seek_timestamp, &seq_no))
2040 return AVERROR(EIO);
2042 /* set segment now so we do not need to search again below */
2043 seek_pls->cur_seq_no = seq_no;
2044 seek_pls->seek_stream_index = stream_subdemuxer_index;
2046 for (i = 0; i < c->n_playlists; i++) {
2048 struct playlist *pls = c->playlists[i];
2050 ff_format_io_close(pls->parent, &pls->input);
2051 av_packet_unref(&pls->pkt);
2052 reset_packet(&pls->pkt);
2053 pls->pb.eof_reached = 0;
2054 /* Clear any buffered data */
2055 pls->pb.buf_end = pls->pb.buf_ptr = pls->pb.buffer;
2056 /* Reset the pos, to let the mpegts demuxer know we've seeked. */
2058 /* Flush the packet queue of the subdemuxer. */
2059 ff_read_frame_flush(pls->ctx);
2061 pls->seek_timestamp = seek_timestamp;
2062 pls->seek_flags = flags;
2064 if (pls != seek_pls) {
2065 /* set closest segment seq_no for playlists not handled above */
2066 find_timestamp_in_playlist(c, pls, seek_timestamp, &pls->cur_seq_no);
2067 /* seek the playlist to the given position without taking
2068 * keyframes into account since this playlist does not have the
2069 * specified stream where we should look for the keyframes */
2070 pls->seek_stream_index = -1;
2071 pls->seek_flags |= AVSEEK_FLAG_ANY;
2075 c->cur_timestamp = seek_timestamp;
2080 static int hls_probe(AVProbeData *p)
2082 /* Require #EXTM3U at the start, and either one of the ones below
2083 * somewhere for a proper match. */
2084 if (strncmp(p->buf, "#EXTM3U", 7))
2087 if (strstr(p->buf, "#EXT-X-STREAM-INF:") ||
2088 strstr(p->buf, "#EXT-X-TARGETDURATION:") ||
2089 strstr(p->buf, "#EXT-X-MEDIA-SEQUENCE:"))
2090 return AVPROBE_SCORE_MAX;
2094 #define OFFSET(x) offsetof(HLSContext, x)
2095 #define FLAGS AV_OPT_FLAG_DECODING_PARAM
2096 static const AVOption hls_options[] = {
2097 {"live_start_index", "segment index to start live streams at (negative values are from the end)",
2098 OFFSET(live_start_index), AV_OPT_TYPE_INT, {.i64 = -3}, INT_MIN, INT_MAX, FLAGS},
2102 static const AVClass hls_class = {
2103 .class_name = "hls,applehttp",
2104 .item_name = av_default_item_name,
2105 .option = hls_options,
2106 .version = LIBAVUTIL_VERSION_INT,
2109 AVInputFormat ff_hls_demuxer = {
2110 .name = "hls,applehttp",
2111 .long_name = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
2112 .priv_class = &hls_class,
2113 .priv_data_size = sizeof(HLSContext),
2114 .read_probe = hls_probe,
2115 .read_header = hls_read_header,
2116 .read_packet = hls_read_packet,
2117 .read_close = hls_close,
2118 .read_seek = hls_read_seek,