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"
42 #define INITIAL_BUFFER_SIZE 32768
44 #define MAX_FIELD_LEN 64
45 #define MAX_CHARACTERISTICS_LEN 512
47 #define MPEG_TIME_BASE 90000
48 #define MPEG_TIME_BASE_Q (AVRational){1, MPEG_TIME_BASE}
51 * An apple http stream consists of a playlist with media segment files,
52 * played sequentially. There may be several playlists with the same
53 * video content, in different bandwidth variants, that are played in
54 * parallel (preferably only one bandwidth variant at a time). In this case,
55 * the user supplied the url to a main playlist that only lists the variant
58 * If the main playlist doesn't point at any variants, we still create
59 * one anonymous toplevel variant for this, to maintain the structure.
74 enum KeyType key_type;
76 /* associated Media Initialization Section, treated as a segment */
77 struct segment *init_section;
89 * Each playlist has its own demuxer. If it currently is active,
90 * it has an open AVIOContext too, and potentially an AVPacket
91 * containing the next packet from this stream.
94 char url[MAX_URL_SIZE];
98 AVFormatContext *parent;
100 AVFormatContext *ctx;
105 enum PlaylistType type;
106 int64_t target_duration;
109 struct segment **segments;
110 int needed, cur_needed;
112 int64_t cur_seg_offset;
113 int64_t last_load_time;
115 /* Currently active Media Initialization Section */
116 struct segment *cur_init_section;
117 uint8_t *init_sec_buf;
118 unsigned int init_sec_buf_size;
119 unsigned int init_sec_data_len;
120 unsigned int init_sec_buf_read_offset;
122 char key_url[MAX_URL_SIZE];
125 /* ID3 timestamp handling (elementary audio streams have ID3 timestamps
126 * (and possibly other ID3 tags) in the beginning of each segment) */
127 int is_id3_timestamped; /* -1: not yet known */
128 int64_t id3_mpegts_timestamp; /* in mpegts tb */
129 int64_t id3_offset; /* in stream original tb */
130 uint8_t* id3_buf; /* temp buffer for id3 parsing */
131 unsigned int id3_buf_size;
132 AVDictionary *id3_initial; /* data from first id3 tag */
133 int id3_found; /* ID3 tag found at some point */
134 int id3_changed; /* ID3 tag data has changed at some point */
135 ID3v2ExtraMeta *id3_deferred_extra; /* stored here until subdemuxer is opened */
137 int64_t seek_timestamp;
139 int seek_stream_index; /* into subdemuxer stream array */
141 /* Renditions associated with this playlist, if any.
142 * Alternative rendition playlists have a single rendition associated
143 * with them, and variant main Media Playlists may have
144 * multiple (playlist-less) renditions associated with them. */
146 struct rendition **renditions;
148 /* Media Initialization Sections (EXT-X-MAP) associated with this
149 * playlist, if any. */
151 struct segment **init_sections;
155 * Renditions are e.g. alternative subtitle or audio streams.
156 * The rendition may either be an external playlist or it may be
157 * contained in the main Media Playlist of the variant (in which case
161 enum AVMediaType type;
162 struct playlist *playlist;
163 char group_id[MAX_FIELD_LEN];
164 char language[MAX_FIELD_LEN];
165 char name[MAX_FIELD_LEN];
172 /* every variant contains at least the main Media Playlist in index 0 */
174 struct playlist **playlists;
176 char audio_group[MAX_FIELD_LEN];
177 char video_group[MAX_FIELD_LEN];
178 char subtitles_group[MAX_FIELD_LEN];
181 typedef struct HLSContext {
184 struct variant **variants;
186 struct playlist **playlists;
188 struct rendition **renditions;
191 int live_start_index;
193 int64_t first_timestamp;
194 int64_t cur_timestamp;
195 AVIOInterruptCB *interrupt_callback;
196 char *user_agent; ///< holds HTTP user agent set as an AVOption to the HTTP protocol context
197 char *cookies; ///< holds HTTP cookie values set in either the initial response or as an AVOption to the HTTP protocol context
198 char *headers; ///< holds HTTP headers set as an AVOption to the HTTP protocol context
199 char *http_proxy; ///< holds the address of the HTTP proxy server
200 AVDictionary *avio_opts;
201 int strict_std_compliance;
204 static int read_chomp_line(AVIOContext *s, char *buf, int maxlen)
206 int len = ff_get_line(s, buf, maxlen);
207 while (len > 0 && av_isspace(buf[len - 1]))
212 static void free_segment_list(struct playlist *pls)
215 for (i = 0; i < pls->n_segments; i++) {
216 av_freep(&pls->segments[i]->key);
217 av_freep(&pls->segments[i]->url);
218 av_freep(&pls->segments[i]);
220 av_freep(&pls->segments);
224 static void free_init_section_list(struct playlist *pls)
227 for (i = 0; i < pls->n_init_sections; i++) {
228 av_freep(&pls->init_sections[i]->url);
229 av_freep(&pls->init_sections[i]);
231 av_freep(&pls->init_sections);
232 pls->n_init_sections = 0;
235 static void free_playlist_list(HLSContext *c)
238 for (i = 0; i < c->n_playlists; i++) {
239 struct playlist *pls = c->playlists[i];
240 free_segment_list(pls);
241 free_init_section_list(pls);
242 av_freep(&pls->renditions);
243 av_freep(&pls->id3_buf);
244 av_dict_free(&pls->id3_initial);
245 ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
246 av_freep(&pls->init_sec_buf);
247 av_packet_unref(&pls->pkt);
248 av_freep(&pls->pb.buffer);
250 ffurl_close(pls->input);
253 avformat_close_input(&pls->ctx);
257 av_freep(&c->playlists);
258 av_freep(&c->cookies);
259 av_freep(&c->user_agent);
260 av_freep(&c->headers);
261 av_freep(&c->http_proxy);
265 static void free_variant_list(HLSContext *c)
268 for (i = 0; i < c->n_variants; i++) {
269 struct variant *var = c->variants[i];
270 av_freep(&var->playlists);
273 av_freep(&c->variants);
277 static void free_rendition_list(HLSContext *c)
280 for (i = 0; i < c->n_renditions; i++)
281 av_freep(&c->renditions[i]);
282 av_freep(&c->renditions);
287 * Used to reset a statically allocated AVPacket to a clean slate,
288 * containing no data.
290 static void reset_packet(AVPacket *pkt)
296 static struct playlist *new_playlist(HLSContext *c, const char *url,
299 struct playlist *pls = av_mallocz(sizeof(struct playlist));
302 reset_packet(&pls->pkt);
303 ff_make_absolute_url(pls->url, sizeof(pls->url), base, url);
304 pls->seek_timestamp = AV_NOPTS_VALUE;
306 pls->is_id3_timestamped = -1;
307 pls->id3_mpegts_timestamp = AV_NOPTS_VALUE;
309 dynarray_add(&c->playlists, &c->n_playlists, pls);
313 struct variant_info {
315 /* variant group ids: */
316 char audio[MAX_FIELD_LEN];
317 char video[MAX_FIELD_LEN];
318 char subtitles[MAX_FIELD_LEN];
321 static struct variant *new_variant(HLSContext *c, struct variant_info *info,
322 const char *url, const char *base)
325 struct playlist *pls;
327 pls = new_playlist(c, url, base);
331 var = av_mallocz(sizeof(struct variant));
336 var->bandwidth = atoi(info->bandwidth);
337 strcpy(var->audio_group, info->audio);
338 strcpy(var->video_group, info->video);
339 strcpy(var->subtitles_group, info->subtitles);
342 dynarray_add(&c->variants, &c->n_variants, var);
343 dynarray_add(&var->playlists, &var->n_playlists, pls);
347 static void handle_variant_args(struct variant_info *info, const char *key,
348 int key_len, char **dest, int *dest_len)
350 if (!strncmp(key, "BANDWIDTH=", key_len)) {
351 *dest = info->bandwidth;
352 *dest_len = sizeof(info->bandwidth);
353 } else if (!strncmp(key, "AUDIO=", key_len)) {
355 *dest_len = sizeof(info->audio);
356 } else if (!strncmp(key, "VIDEO=", key_len)) {
358 *dest_len = sizeof(info->video);
359 } else if (!strncmp(key, "SUBTITLES=", key_len)) {
360 *dest = info->subtitles;
361 *dest_len = sizeof(info->subtitles);
366 char uri[MAX_URL_SIZE];
371 static void handle_key_args(struct key_info *info, const char *key,
372 int key_len, char **dest, int *dest_len)
374 if (!strncmp(key, "METHOD=", key_len)) {
375 *dest = info->method;
376 *dest_len = sizeof(info->method);
377 } else if (!strncmp(key, "URI=", key_len)) {
379 *dest_len = sizeof(info->uri);
380 } else if (!strncmp(key, "IV=", key_len)) {
382 *dest_len = sizeof(info->iv);
386 struct init_section_info {
387 char uri[MAX_URL_SIZE];
391 static struct segment *new_init_section(struct playlist *pls,
392 struct init_section_info *info,
393 const char *url_base)
397 char tmp_str[MAX_URL_SIZE];
402 sec = av_mallocz(sizeof(*sec));
406 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url_base, info->uri);
407 sec->url = av_strdup(tmp_str);
413 if (info->byterange[0]) {
414 sec->size = atoi(info->byterange);
415 ptr = strchr(info->byterange, '@');
417 sec->url_offset = atoi(ptr+1);
419 /* the entire file is the init section */
423 dynarray_add(&pls->init_sections, &pls->n_init_sections, sec);
428 static void handle_init_section_args(struct init_section_info *info, const char *key,
429 int key_len, char **dest, int *dest_len)
431 if (!strncmp(key, "URI=", key_len)) {
433 *dest_len = sizeof(info->uri);
434 } else if (!strncmp(key, "BYTERANGE=", key_len)) {
435 *dest = info->byterange;
436 *dest_len = sizeof(info->byterange);
440 struct rendition_info {
442 char uri[MAX_URL_SIZE];
443 char group_id[MAX_FIELD_LEN];
444 char language[MAX_FIELD_LEN];
445 char assoc_language[MAX_FIELD_LEN];
446 char name[MAX_FIELD_LEN];
449 char characteristics[MAX_CHARACTERISTICS_LEN];
452 static struct rendition *new_rendition(HLSContext *c, struct rendition_info *info,
453 const char *url_base)
455 struct rendition *rend;
456 enum AVMediaType type = AVMEDIA_TYPE_UNKNOWN;
457 char *characteristic;
461 if (!strcmp(info->type, "AUDIO"))
462 type = AVMEDIA_TYPE_AUDIO;
463 else if (!strcmp(info->type, "VIDEO"))
464 type = AVMEDIA_TYPE_VIDEO;
465 else if (!strcmp(info->type, "SUBTITLES"))
466 type = AVMEDIA_TYPE_SUBTITLE;
467 else if (!strcmp(info->type, "CLOSED-CAPTIONS"))
468 /* CLOSED-CAPTIONS is ignored since we do not support CEA-608 CC in
469 * AVC SEI RBSP anyway */
472 if (type == AVMEDIA_TYPE_UNKNOWN)
475 /* URI is mandatory for subtitles as per spec */
476 if (type == AVMEDIA_TYPE_SUBTITLE && !info->uri[0])
479 /* TODO: handle subtitles (each segment has to parsed separately) */
480 if (c->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL)
481 if (type == AVMEDIA_TYPE_SUBTITLE)
484 rend = av_mallocz(sizeof(struct rendition));
488 dynarray_add(&c->renditions, &c->n_renditions, rend);
491 strcpy(rend->group_id, info->group_id);
492 strcpy(rend->language, info->language);
493 strcpy(rend->name, info->name);
495 /* add the playlist if this is an external rendition */
497 rend->playlist = new_playlist(c, info->uri, url_base);
499 dynarray_add(&rend->playlist->renditions,
500 &rend->playlist->n_renditions, rend);
503 if (info->assoc_language[0]) {
504 int langlen = strlen(rend->language);
505 if (langlen < sizeof(rend->language) - 3) {
506 rend->language[langlen] = ',';
507 strncpy(rend->language + langlen + 1, info->assoc_language,
508 sizeof(rend->language) - langlen - 2);
512 if (!strcmp(info->defaultr, "YES"))
513 rend->disposition |= AV_DISPOSITION_DEFAULT;
514 if (!strcmp(info->forced, "YES"))
515 rend->disposition |= AV_DISPOSITION_FORCED;
517 chr_ptr = info->characteristics;
518 while ((characteristic = av_strtok(chr_ptr, ",", &saveptr))) {
519 if (!strcmp(characteristic, "public.accessibility.describes-music-and-sound"))
520 rend->disposition |= AV_DISPOSITION_HEARING_IMPAIRED;
521 else if (!strcmp(characteristic, "public.accessibility.describes-video"))
522 rend->disposition |= AV_DISPOSITION_VISUAL_IMPAIRED;
530 static void handle_rendition_args(struct rendition_info *info, const char *key,
531 int key_len, char **dest, int *dest_len)
533 if (!strncmp(key, "TYPE=", key_len)) {
535 *dest_len = sizeof(info->type);
536 } else if (!strncmp(key, "URI=", key_len)) {
538 *dest_len = sizeof(info->uri);
539 } else if (!strncmp(key, "GROUP-ID=", key_len)) {
540 *dest = info->group_id;
541 *dest_len = sizeof(info->group_id);
542 } else if (!strncmp(key, "LANGUAGE=", key_len)) {
543 *dest = info->language;
544 *dest_len = sizeof(info->language);
545 } else if (!strncmp(key, "ASSOC-LANGUAGE=", key_len)) {
546 *dest = info->assoc_language;
547 *dest_len = sizeof(info->assoc_language);
548 } else if (!strncmp(key, "NAME=", key_len)) {
550 *dest_len = sizeof(info->name);
551 } else if (!strncmp(key, "DEFAULT=", key_len)) {
552 *dest = info->defaultr;
553 *dest_len = sizeof(info->defaultr);
554 } else if (!strncmp(key, "FORCED=", key_len)) {
555 *dest = info->forced;
556 *dest_len = sizeof(info->forced);
557 } else if (!strncmp(key, "CHARACTERISTICS=", key_len)) {
558 *dest = info->characteristics;
559 *dest_len = sizeof(info->characteristics);
563 * - AUTOSELECT: client may autoselect based on e.g. system language
564 * - INSTREAM-ID: EIA-608 closed caption number ("CC1".."CC4")
568 /* used by parse_playlist to allocate a new variant+playlist when the
569 * playlist is detected to be a Media Playlist (not Master Playlist)
570 * and we have no parent Master Playlist (parsing of which would have
571 * allocated the variant and playlist already)
572 * *pls == NULL => Master Playlist or parentless Media Playlist
573 * *pls != NULL => parented Media Playlist, playlist+variant allocated */
574 static int ensure_playlist(HLSContext *c, struct playlist **pls, const char *url)
578 if (!new_variant(c, NULL, url, NULL))
579 return AVERROR(ENOMEM);
580 *pls = c->playlists[c->n_playlists - 1];
584 static int url_connect(struct playlist *pls, AVDictionary *opts, AVDictionary *opts2)
586 AVDictionary *tmp = NULL;
589 av_dict_copy(&tmp, opts, 0);
590 av_dict_copy(&tmp, opts2, 0);
592 if ((ret = ffurl_connect(pls->input, &tmp)) < 0) {
593 ffurl_close(pls->input);
601 static void update_options(char **dest, const char *name, void *src)
604 av_opt_get(src, name, 0, (uint8_t**)dest);
605 if (*dest && !strlen(*dest))
609 static int open_url(HLSContext *c, URLContext **uc, const char *url, AVDictionary *opts)
611 AVDictionary *tmp = NULL;
613 const char *proto_name = avio_find_protocol_name(url);
616 return AVERROR_INVALIDDATA;
618 // only http(s) & file are allowed
619 if (!av_strstart(proto_name, "http", NULL) && !av_strstart(proto_name, "file", NULL))
620 return AVERROR_INVALIDDATA;
621 if (!strncmp(proto_name, url, strlen(proto_name)) && url[strlen(proto_name)] == ':')
623 else if (strcmp(proto_name, "file") || !strncmp(url, "file,", 5))
624 return AVERROR_INVALIDDATA;
626 av_dict_copy(&tmp, c->avio_opts, 0);
627 av_dict_copy(&tmp, opts, 0);
629 ret = ffurl_open(uc, url, AVIO_FLAG_READ, c->interrupt_callback, &tmp);
631 // update cookies on http response with setcookies.
633 update_options(&c->cookies, "cookies", u->priv_data);
634 av_dict_set(&opts, "cookies", c->cookies, 0);
642 static int parse_playlist(HLSContext *c, const char *url,
643 struct playlist *pls, AVIOContext *in)
645 int ret = 0, is_segment = 0, is_variant = 0;
646 int64_t duration = 0;
647 enum KeyType key_type = KEY_NONE;
650 char key[MAX_URL_SIZE] = "";
651 char line[MAX_URL_SIZE];
654 int64_t seg_offset = 0;
655 int64_t seg_size = -1;
656 uint8_t *new_url = NULL;
657 struct variant_info variant_info;
658 char tmp_str[MAX_URL_SIZE];
659 struct segment *cur_init_section = NULL;
663 AVDictionary *opts = NULL;
665 /* Some HLS servers don't like being sent the range header */
666 av_dict_set(&opts, "seekable", "0", 0);
668 // broker prior HTTP options that should be consistent across requests
669 av_dict_set(&opts, "user-agent", c->user_agent, 0);
670 av_dict_set(&opts, "cookies", c->cookies, 0);
671 av_dict_set(&opts, "headers", c->headers, 0);
672 av_dict_set(&opts, "http_proxy", c->http_proxy, 0);
674 ret = avio_open2(&in, url, AVIO_FLAG_READ,
675 c->interrupt_callback, &opts);
680 ret = open_in(c, &in, url);
687 if (av_opt_get(in, "location", AV_OPT_SEARCH_CHILDREN, &new_url) >= 0)
690 read_chomp_line(in, line, sizeof(line));
691 if (strcmp(line, "#EXTM3U")) {
692 ret = AVERROR_INVALIDDATA;
697 free_segment_list(pls);
699 pls->type = PLS_TYPE_UNSPECIFIED;
701 while (!avio_feof(in)) {
702 read_chomp_line(in, line, sizeof(line));
703 if (av_strstart(line, "#EXT-X-STREAM-INF:", &ptr)) {
705 memset(&variant_info, 0, sizeof(variant_info));
706 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_variant_args,
708 } else if (av_strstart(line, "#EXT-X-KEY:", &ptr)) {
709 struct key_info info = {{0}};
710 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_key_args,
714 if (!strcmp(info.method, "AES-128"))
715 key_type = KEY_AES_128;
716 if (!strcmp(info.method, "SAMPLE-AES"))
717 key_type = KEY_SAMPLE_AES;
718 if (!strncmp(info.iv, "0x", 2) || !strncmp(info.iv, "0X", 2)) {
719 ff_hex_to_data(iv, info.iv + 2);
722 av_strlcpy(key, info.uri, sizeof(key));
723 } else if (av_strstart(line, "#EXT-X-MEDIA:", &ptr)) {
724 struct rendition_info info = {{0}};
725 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_rendition_args,
727 new_rendition(c, &info, url);
728 } else if (av_strstart(line, "#EXT-X-TARGETDURATION:", &ptr)) {
729 ret = ensure_playlist(c, &pls, url);
732 pls->target_duration = atoi(ptr) * AV_TIME_BASE;
733 } else if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
734 ret = ensure_playlist(c, &pls, url);
737 pls->start_seq_no = atoi(ptr);
738 } else if (av_strstart(line, "#EXT-X-PLAYLIST-TYPE:", &ptr)) {
739 ret = ensure_playlist(c, &pls, url);
742 if (!strcmp(ptr, "EVENT"))
743 pls->type = PLS_TYPE_EVENT;
744 else if (!strcmp(ptr, "VOD"))
745 pls->type = PLS_TYPE_VOD;
746 } else if (av_strstart(line, "#EXT-X-MAP:", &ptr)) {
747 struct init_section_info info = {{0}};
748 ret = ensure_playlist(c, &pls, url);
751 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_init_section_args,
753 cur_init_section = new_init_section(pls, &info, url);
754 } else if (av_strstart(line, "#EXT-X-ENDLIST", &ptr)) {
757 } else if (av_strstart(line, "#EXTINF:", &ptr)) {
759 duration = atof(ptr) * AV_TIME_BASE;
760 } else if (av_strstart(line, "#EXT-X-BYTERANGE:", &ptr)) {
761 seg_size = atoi(ptr);
762 ptr = strchr(ptr, '@');
764 seg_offset = atoi(ptr+1);
765 } else if (av_strstart(line, "#", NULL)) {
767 } else if (line[0]) {
769 if (!new_variant(c, &variant_info, line, url)) {
770 ret = AVERROR(ENOMEM);
778 if (!new_variant(c, 0, url, NULL)) {
779 ret = AVERROR(ENOMEM);
782 pls = c->playlists[c->n_playlists - 1];
784 seg = av_malloc(sizeof(struct segment));
786 ret = AVERROR(ENOMEM);
789 seg->duration = duration;
790 seg->key_type = key_type;
792 memcpy(seg->iv, iv, sizeof(iv));
794 int seq = pls->start_seq_no + pls->n_segments;
795 memset(seg->iv, 0, sizeof(seg->iv));
796 AV_WB32(seg->iv + 12, seq);
799 if (key_type != KEY_NONE) {
800 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, key);
801 seg->key = av_strdup(tmp_str);
804 ret = AVERROR(ENOMEM);
811 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, line);
812 seg->url = av_strdup(tmp_str);
816 ret = AVERROR(ENOMEM);
820 dynarray_add(&pls->segments, &pls->n_segments, seg);
823 seg->size = seg_size;
825 seg->url_offset = seg_offset;
826 seg_offset += seg_size;
833 seg->init_section = cur_init_section;
838 pls->last_load_time = av_gettime_relative();
847 static struct segment *current_segment(struct playlist *pls)
849 return pls->segments[pls->cur_seq_no - pls->start_seq_no];
852 enum ReadFromURLMode {
857 /* read from URLContext, limiting read to current segment */
858 static int read_from_url(struct playlist *pls, struct segment *seg,
859 uint8_t *buf, int buf_size,
860 enum ReadFromURLMode mode)
864 /* limit read if the segment was only a part of a file */
866 buf_size = FFMIN(buf_size, seg->size - pls->cur_seg_offset);
868 if (mode == READ_COMPLETE)
869 ret = ffurl_read_complete(pls->input, buf, buf_size);
871 ret = ffurl_read(pls->input, buf, buf_size);
874 pls->cur_seg_offset += ret;
879 /* Parse the raw ID3 data and pass contents to caller */
880 static void parse_id3(AVFormatContext *s, AVIOContext *pb,
881 AVDictionary **metadata, int64_t *dts,
882 ID3v2ExtraMetaAPIC **apic, ID3v2ExtraMeta **extra_meta)
884 static const char id3_priv_owner_ts[] = "com.apple.streaming.transportStreamTimestamp";
885 ID3v2ExtraMeta *meta;
887 ff_id3v2_read_dict(pb, metadata, ID3v2_DEFAULT_MAGIC, extra_meta);
888 for (meta = *extra_meta; meta; meta = meta->next) {
889 if (!strcmp(meta->tag, "PRIV")) {
890 ID3v2ExtraMetaPRIV *priv = meta->data;
891 if (priv->datasize == 8 && !strcmp(priv->owner, id3_priv_owner_ts)) {
892 /* 33-bit MPEG timestamp */
893 int64_t ts = AV_RB64(priv->data);
894 av_log(s, AV_LOG_DEBUG, "HLS ID3 audio timestamp %"PRId64"\n", ts);
895 if ((ts & ~((1ULL << 33) - 1)) == 0)
898 av_log(s, AV_LOG_ERROR, "Invalid HLS ID3 audio timestamp %"PRId64"\n", ts);
900 } else if (!strcmp(meta->tag, "APIC") && apic)
905 /* Check if the ID3 metadata contents have changed */
906 static int id3_has_changed_values(struct playlist *pls, AVDictionary *metadata,
907 ID3v2ExtraMetaAPIC *apic)
909 AVDictionaryEntry *entry = NULL;
910 AVDictionaryEntry *oldentry;
911 /* check that no keys have changed values */
912 while ((entry = av_dict_get(metadata, "", entry, AV_DICT_IGNORE_SUFFIX))) {
913 oldentry = av_dict_get(pls->id3_initial, entry->key, NULL, AV_DICT_MATCH_CASE);
914 if (!oldentry || strcmp(oldentry->value, entry->value) != 0)
918 /* check if apic appeared */
919 if (apic && (pls->ctx->nb_streams != 2 || !pls->ctx->streams[1]->attached_pic.data))
923 int size = pls->ctx->streams[1]->attached_pic.size;
924 if (size != apic->buf->size - AV_INPUT_BUFFER_PADDING_SIZE)
927 if (memcmp(apic->buf->data, pls->ctx->streams[1]->attached_pic.data, size) != 0)
934 /* Parse ID3 data and handle the found data */
935 static void handle_id3(AVIOContext *pb, struct playlist *pls)
937 AVDictionary *metadata = NULL;
938 ID3v2ExtraMetaAPIC *apic = NULL;
939 ID3v2ExtraMeta *extra_meta = NULL;
940 int64_t timestamp = AV_NOPTS_VALUE;
942 parse_id3(pls->ctx, pb, &metadata, ×tamp, &apic, &extra_meta);
944 if (timestamp != AV_NOPTS_VALUE) {
945 pls->id3_mpegts_timestamp = timestamp;
949 if (!pls->id3_found) {
950 /* initial ID3 tags */
951 av_assert0(!pls->id3_deferred_extra);
954 /* get picture attachment and set text metadata */
955 if (pls->ctx->nb_streams)
956 ff_id3v2_parse_apic(pls->ctx, &extra_meta);
958 /* demuxer not yet opened, defer picture attachment */
959 pls->id3_deferred_extra = extra_meta;
961 av_dict_copy(&pls->ctx->metadata, metadata, 0);
962 pls->id3_initial = metadata;
965 if (!pls->id3_changed && id3_has_changed_values(pls, metadata, apic)) {
966 avpriv_report_missing_feature(pls->ctx, "Changing ID3 metadata in HLS audio elementary stream");
967 pls->id3_changed = 1;
969 av_dict_free(&metadata);
972 if (!pls->id3_deferred_extra)
973 ff_id3v2_free_extra_meta(&extra_meta);
976 /* Intercept and handle ID3 tags between URLContext and AVIOContext */
977 static void intercept_id3(struct playlist *pls, uint8_t *buf,
978 int buf_size, int *len)
980 /* intercept id3 tags, we do not want to pass them to the raw
981 * demuxer on all segment switches */
985 struct segment *seg = current_segment(pls);
987 /* gather all the id3 tags */
989 /* see if we can retrieve enough data for ID3 header */
990 if (*len < ID3v2_HEADER_SIZE && buf_size >= ID3v2_HEADER_SIZE) {
991 bytes = read_from_url(pls, seg, buf + *len, ID3v2_HEADER_SIZE - *len, READ_COMPLETE);
994 if (bytes == ID3v2_HEADER_SIZE - *len)
995 /* no EOF yet, so fill the caller buffer again after
996 * we have stripped the ID3 tags */
1001 } else if (*len <= 0) {
1008 if (*len < ID3v2_HEADER_SIZE)
1011 if (ff_id3v2_match(buf, ID3v2_DEFAULT_MAGIC)) {
1012 int64_t maxsize = seg->size >= 0 ? seg->size : 1024*1024;
1013 int taglen = ff_id3v2_tag_len(buf);
1014 int tag_got_bytes = FFMIN(taglen, *len);
1015 int remaining = taglen - tag_got_bytes;
1017 if (taglen > maxsize) {
1018 av_log(pls->ctx, AV_LOG_ERROR, "Too large HLS ID3 tag (%d > %"PRId64" bytes)\n",
1024 * Copy the id3 tag to our temporary id3 buffer.
1025 * We could read a small id3 tag directly without memcpy, but
1026 * we would still need to copy the large tags, and handling
1027 * both of those cases together with the possibility for multiple
1028 * tags would make the handling a bit complex.
1030 pls->id3_buf = av_fast_realloc(pls->id3_buf, &pls->id3_buf_size, id3_buf_pos + taglen);
1033 memcpy(pls->id3_buf + id3_buf_pos, buf, tag_got_bytes);
1034 id3_buf_pos += tag_got_bytes;
1036 /* strip the intercepted bytes */
1037 *len -= tag_got_bytes;
1038 memmove(buf, buf + tag_got_bytes, *len);
1039 av_log(pls->ctx, AV_LOG_DEBUG, "Stripped %d HLS ID3 bytes\n", tag_got_bytes);
1041 if (remaining > 0) {
1042 /* read the rest of the tag in */
1043 if (read_from_url(pls, seg, pls->id3_buf + id3_buf_pos, remaining, READ_COMPLETE) != remaining)
1045 id3_buf_pos += remaining;
1046 av_log(pls->ctx, AV_LOG_DEBUG, "Stripped additional %d HLS ID3 bytes\n", remaining);
1050 /* no more ID3 tags */
1055 /* re-fill buffer for the caller unless EOF */
1056 if (*len >= 0 && (fill_buf || *len == 0)) {
1057 bytes = read_from_url(pls, seg, buf + *len, buf_size - *len, READ_NORMAL);
1059 /* ignore error if we already had some data */
1067 /* Now parse all the ID3 tags */
1068 AVIOContext id3ioctx;
1069 ffio_init_context(&id3ioctx, pls->id3_buf, id3_buf_pos, 0, NULL, NULL, NULL, NULL);
1070 handle_id3(&id3ioctx, pls);
1073 if (pls->is_id3_timestamped == -1)
1074 pls->is_id3_timestamped = (pls->id3_mpegts_timestamp != AV_NOPTS_VALUE);
1077 static int open_input(HLSContext *c, struct playlist *pls, struct segment *seg)
1079 AVDictionary *opts = NULL;
1082 // broker prior HTTP options that should be consistent across requests
1083 av_dict_set(&opts, "user-agent", c->user_agent, 0);
1084 av_dict_set(&opts, "cookies", c->cookies, 0);
1085 av_dict_set(&opts, "headers", c->headers, 0);
1086 av_dict_set(&opts, "http_proxy", c->http_proxy, 0);
1087 av_dict_set(&opts, "seekable", "0", 0);
1089 if (seg->size >= 0) {
1090 /* try to restrict the HTTP request to the part we want
1091 * (if this is in fact a HTTP request) */
1092 av_dict_set_int(&opts, "offset", seg->url_offset, 0);
1093 av_dict_set_int(&opts, "end_offset", seg->url_offset + seg->size, 0);
1096 av_log(pls->parent, AV_LOG_VERBOSE, "HLS request for url '%s', offset %"PRId64", playlist %d\n",
1097 seg->url, seg->url_offset, pls->index);
1099 if (seg->key_type == KEY_NONE) {
1100 ret = open_url(pls->parent->priv_data, &pls->input, seg->url, opts);
1101 } else if (seg->key_type == KEY_AES_128) {
1102 // HLSContext *c = var->parent->priv_data;
1103 char iv[33], key[33], url[MAX_URL_SIZE];
1104 if (strcmp(seg->key, pls->key_url)) {
1106 if (open_url(pls->parent->priv_data, &uc, seg->key, opts) == 0) {
1107 if (ffurl_read_complete(uc, pls->key, sizeof(pls->key))
1108 != sizeof(pls->key)) {
1109 av_log(NULL, AV_LOG_ERROR, "Unable to read key file %s\n",
1114 av_log(NULL, AV_LOG_ERROR, "Unable to open key file %s\n",
1117 av_strlcpy(pls->key_url, seg->key, sizeof(pls->key_url));
1119 ff_data_to_hex(iv, seg->iv, sizeof(seg->iv), 0);
1120 ff_data_to_hex(key, pls->key, sizeof(pls->key), 0);
1121 iv[32] = key[32] = '\0';
1122 if (strstr(seg->url, "://"))
1123 snprintf(url, sizeof(url), "crypto+%s", seg->url);
1125 snprintf(url, sizeof(url), "crypto:%s", seg->url);
1127 if ((ret = ffurl_alloc(&pls->input, url, AVIO_FLAG_READ,
1128 &pls->parent->interrupt_callback)) < 0)
1130 av_opt_set(pls->input->priv_data, "key", key, 0);
1131 av_opt_set(pls->input->priv_data, "iv", iv, 0);
1133 if ((ret = url_connect(pls, c->avio_opts, opts)) < 0) {
1137 } else if (seg->key_type == KEY_SAMPLE_AES) {
1138 av_log(pls->parent, AV_LOG_ERROR,
1139 "SAMPLE-AES encryption is not supported yet\n");
1140 ret = AVERROR_PATCHWELCOME;
1143 ret = AVERROR(ENOSYS);
1145 /* Seek to the requested position. If this was a HTTP request, the offset
1146 * should already be where want it to, but this allows e.g. local testing
1147 * without a HTTP server. */
1148 if (ret == 0 && seg->key_type == KEY_NONE && seg->url_offset) {
1149 int seekret = ffurl_seek(pls->input, seg->url_offset, SEEK_SET);
1151 av_log(pls->parent, AV_LOG_ERROR, "Unable to seek to offset %"PRId64" of HLS segment '%s'\n", seg->url_offset, seg->url);
1153 ffurl_close(pls->input);
1159 av_dict_free(&opts);
1160 pls->cur_seg_offset = 0;
1164 static int update_init_section(struct playlist *pls, struct segment *seg)
1166 static const int max_init_section_size = 1024*1024;
1167 HLSContext *c = pls->parent->priv_data;
1172 if (seg->init_section == pls->cur_init_section)
1175 pls->cur_init_section = NULL;
1177 if (!seg->init_section)
1180 /* this will clobber playlist URLContext stuff, so this should be
1181 * called between segments only */
1182 ret = open_input(c, pls, seg->init_section);
1184 av_log(pls->parent, AV_LOG_WARNING,
1185 "Failed to open an initialization section in playlist %d\n",
1190 if (seg->init_section->size >= 0)
1191 sec_size = seg->init_section->size;
1192 else if ((urlsize = ffurl_size(pls->input)) >= 0)
1195 sec_size = max_init_section_size;
1197 av_log(pls->parent, AV_LOG_DEBUG,
1198 "Downloading an initialization section of size %"PRId64"\n",
1201 sec_size = FFMIN(sec_size, max_init_section_size);
1203 av_fast_malloc(&pls->init_sec_buf, &pls->init_sec_buf_size, sec_size);
1205 ret = read_from_url(pls, seg->init_section, pls->init_sec_buf,
1206 pls->init_sec_buf_size, READ_COMPLETE);
1207 ffurl_close(pls->input);
1213 pls->cur_init_section = seg->init_section;
1214 pls->init_sec_data_len = ret;
1215 pls->init_sec_buf_read_offset = 0;
1217 /* spec says audio elementary streams do not have media initialization
1218 * sections, so there should be no ID3 timestamps */
1219 pls->is_id3_timestamped = 0;
1224 static int64_t default_reload_interval(struct playlist *pls)
1226 return pls->n_segments > 0 ?
1227 pls->segments[pls->n_segments - 1]->duration :
1228 pls->target_duration;
1231 static int read_data(void *opaque, uint8_t *buf, int buf_size)
1233 struct playlist *v = opaque;
1234 HLSContext *c = v->parent->priv_data;
1236 int just_opened = 0;
1243 int64_t reload_interval;
1244 struct segment *seg;
1246 /* Check that the playlist is still needed before opening a new
1248 if (v->ctx && v->ctx->nb_streams &&
1249 v->parent->nb_streams >= v->stream_offset + v->ctx->nb_streams) {
1251 for (i = v->stream_offset; i < v->stream_offset + v->ctx->nb_streams;
1253 if (v->parent->streams[i]->discard < AVDISCARD_ALL)
1258 av_log(v->parent, AV_LOG_INFO, "No longer receiving playlist %d\n",
1263 /* If this is a live stream and the reload interval has elapsed since
1264 * the last playlist reload, reload the playlists now. */
1265 reload_interval = default_reload_interval(v);
1269 av_gettime_relative() - v->last_load_time >= reload_interval) {
1270 if ((ret = parse_playlist(c, v->url, v, NULL)) < 0) {
1271 av_log(v->parent, AV_LOG_WARNING, "Failed to reload playlist %d\n",
1275 /* If we need to reload the playlist again below (if
1276 * there's still no more segments), switch to a reload
1277 * interval of half the target duration. */
1278 reload_interval = v->target_duration / 2;
1280 if (v->cur_seq_no < v->start_seq_no) {
1281 av_log(NULL, AV_LOG_WARNING,
1282 "skipping %d segments ahead, expired from playlists\n",
1283 v->start_seq_no - v->cur_seq_no);
1284 v->cur_seq_no = v->start_seq_no;
1286 if (v->cur_seq_no >= v->start_seq_no + v->n_segments) {
1289 while (av_gettime_relative() - v->last_load_time < reload_interval) {
1290 if (ff_check_interrupt(c->interrupt_callback))
1291 return AVERROR_EXIT;
1292 av_usleep(100*1000);
1294 /* Enough time has elapsed since the last reload */
1298 seg = current_segment(v);
1300 /* load/update Media Initialization Section, if any */
1301 ret = update_init_section(v, seg);
1305 ret = open_input(c, v, seg);
1307 if (ff_check_interrupt(c->interrupt_callback))
1308 return AVERROR_EXIT;
1309 av_log(v->parent, AV_LOG_WARNING, "Failed to open segment of playlist %d\n",
1317 if (v->init_sec_buf_read_offset < v->init_sec_data_len) {
1318 /* Push init section out first before first actual segment */
1319 int copy_size = FFMIN(v->init_sec_data_len - v->init_sec_buf_read_offset, buf_size);
1320 memcpy(buf, v->init_sec_buf, copy_size);
1321 v->init_sec_buf_read_offset += copy_size;
1325 ret = read_from_url(v, current_segment(v), buf, buf_size, READ_NORMAL);
1327 if (just_opened && v->is_id3_timestamped != 0) {
1328 /* Intercept ID3 tags here, elementary audio streams are required
1329 * to convey timestamps using them in the beginning of each segment. */
1330 intercept_id3(v, buf, buf_size, &ret);
1335 ffurl_close(v->input);
1339 c->cur_seq_no = v->cur_seq_no;
1344 static int playlist_in_multiple_variants(HLSContext *c, struct playlist *pls)
1346 int variant_count = 0;
1349 for (i = 0; i < c->n_variants && variant_count < 2; i++) {
1350 struct variant *v = c->variants[i];
1352 for (j = 0; j < v->n_playlists; j++) {
1353 if (v->playlists[j] == pls) {
1360 return variant_count >= 2;
1363 static void add_renditions_to_variant(HLSContext *c, struct variant *var,
1364 enum AVMediaType type, const char *group_id)
1368 for (i = 0; i < c->n_renditions; i++) {
1369 struct rendition *rend = c->renditions[i];
1371 if (rend->type == type && !strcmp(rend->group_id, group_id)) {
1374 /* rendition is an external playlist
1375 * => add the playlist to the variant */
1376 dynarray_add(&var->playlists, &var->n_playlists, rend->playlist);
1378 /* rendition is part of the variant main Media Playlist
1379 * => add the rendition to the main Media Playlist */
1380 dynarray_add(&var->playlists[0]->renditions,
1381 &var->playlists[0]->n_renditions,
1387 static void add_metadata_from_renditions(AVFormatContext *s, struct playlist *pls,
1388 enum AVMediaType type)
1393 for (i = 0; i < pls->ctx->nb_streams; i++) {
1394 AVStream *st = s->streams[pls->stream_offset + i];
1396 if (st->codec->codec_type != type)
1399 for (; rend_idx < pls->n_renditions; rend_idx++) {
1400 struct rendition *rend = pls->renditions[rend_idx];
1402 if (rend->type != type)
1405 if (rend->language[0])
1406 av_dict_set(&st->metadata, "language", rend->language, 0);
1408 av_dict_set(&st->metadata, "comment", rend->name, 0);
1410 st->disposition |= rend->disposition;
1412 if (rend_idx >=pls->n_renditions)
1417 /* if timestamp was in valid range: returns 1 and sets seq_no
1418 * if not: returns 0 and sets seq_no to closest segment */
1419 static int find_timestamp_in_playlist(HLSContext *c, struct playlist *pls,
1420 int64_t timestamp, int *seq_no)
1423 int64_t pos = c->first_timestamp == AV_NOPTS_VALUE ?
1424 0 : c->first_timestamp;
1426 if (timestamp < pos) {
1427 *seq_no = pls->start_seq_no;
1431 for (i = 0; i < pls->n_segments; i++) {
1432 int64_t diff = pos + pls->segments[i]->duration - timestamp;
1434 *seq_no = pls->start_seq_no + i;
1437 pos += pls->segments[i]->duration;
1440 *seq_no = pls->start_seq_no + pls->n_segments - 1;
1445 static int select_cur_seq_no(HLSContext *c, struct playlist *pls)
1449 if (!pls->finished && !c->first_packet &&
1450 av_gettime_relative() - pls->last_load_time >= default_reload_interval(pls))
1451 /* reload the playlist since it was suspended */
1452 parse_playlist(c, pls->url, pls, NULL);
1454 /* If playback is already in progress (we are just selecting a new
1455 * playlist) and this is a complete file, find the matching segment
1456 * by counting durations. */
1457 if (pls->finished && c->cur_timestamp != AV_NOPTS_VALUE) {
1458 find_timestamp_in_playlist(c, pls, c->cur_timestamp, &seq_no);
1462 if (!pls->finished) {
1463 if (!c->first_packet && /* we are doing a segment selection during playback */
1464 c->cur_seq_no >= pls->start_seq_no &&
1465 c->cur_seq_no < pls->start_seq_no + pls->n_segments)
1466 /* While spec 3.4.3 says that we cannot assume anything about the
1467 * content at the same sequence number on different playlists,
1468 * in practice this seems to work and doing it otherwise would
1469 * require us to download a segment to inspect its timestamps. */
1470 return c->cur_seq_no;
1472 /* If this is a live stream, start live_start_index segments from the
1474 if (c->live_start_index < 0)
1475 return pls->start_seq_no + FFMAX(pls->n_segments + c->live_start_index, 0);
1477 return pls->start_seq_no + FFMIN(c->live_start_index, pls->n_segments - 1);
1480 /* Otherwise just start on the first segment. */
1481 return pls->start_seq_no;
1484 static int save_avio_options(AVFormatContext *s)
1486 HLSContext *c = s->priv_data;
1487 const char *opts[] = {
1488 "headers", "http_proxy", "user_agent", "user-agent", "cookies", NULL };
1489 const char **opt = opts;
1494 if (av_opt_get(s->pb, *opt, AV_OPT_SEARCH_CHILDREN | AV_OPT_ALLOW_NULL, &buf) >= 0) {
1495 ret = av_dict_set(&c->avio_opts, *opt, buf,
1496 AV_DICT_DONT_STRDUP_VAL);
1506 static int hls_read_header(AVFormatContext *s)
1508 URLContext *u = (s->flags & AVFMT_FLAG_CUSTOM_IO) ? NULL : s->pb->opaque;
1509 HLSContext *c = s->priv_data;
1510 int ret = 0, i, j, stream_offset = 0;
1512 c->interrupt_callback = &s->interrupt_callback;
1513 c->strict_std_compliance = s->strict_std_compliance;
1515 c->first_packet = 1;
1516 c->first_timestamp = AV_NOPTS_VALUE;
1517 c->cur_timestamp = AV_NOPTS_VALUE;
1519 // if the URL context is good, read important options we must broker later
1520 if (u && u->prot->priv_data_class) {
1521 // get the previous user agent & set back to null if string size is zero
1522 update_options(&c->user_agent, "user-agent", u->priv_data);
1524 // get the previous cookies & set back to null if string size is zero
1525 update_options(&c->cookies, "cookies", u->priv_data);
1527 // get the previous headers & set back to null if string size is zero
1528 update_options(&c->headers, "headers", u->priv_data);
1530 // get the previous http proxt & set back to null if string size is zero
1531 update_options(&c->http_proxy, "http_proxy", u->priv_data);
1534 if ((ret = parse_playlist(c, s->filename, NULL, s->pb)) < 0)
1537 if ((ret = save_avio_options(s)) < 0)
1540 /* Some HLS servers don't like being sent the range header */
1541 av_dict_set(&c->avio_opts, "seekable", "0", 0);
1543 if (c->n_variants == 0) {
1544 av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1548 /* If the playlist only contained playlists (Master Playlist),
1549 * parse each individual playlist. */
1550 if (c->n_playlists > 1 || c->playlists[0]->n_segments == 0) {
1551 for (i = 0; i < c->n_playlists; i++) {
1552 struct playlist *pls = c->playlists[i];
1553 if ((ret = parse_playlist(c, pls->url, pls, NULL)) < 0)
1558 if (c->variants[0]->playlists[0]->n_segments == 0) {
1559 av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1564 /* If this isn't a live stream, calculate the total duration of the
1566 if (c->variants[0]->playlists[0]->finished) {
1567 int64_t duration = 0;
1568 for (i = 0; i < c->variants[0]->playlists[0]->n_segments; i++)
1569 duration += c->variants[0]->playlists[0]->segments[i]->duration;
1570 s->duration = duration;
1573 /* Associate renditions with variants */
1574 for (i = 0; i < c->n_variants; i++) {
1575 struct variant *var = c->variants[i];
1577 if (var->audio_group[0])
1578 add_renditions_to_variant(c, var, AVMEDIA_TYPE_AUDIO, var->audio_group);
1579 if (var->video_group[0])
1580 add_renditions_to_variant(c, var, AVMEDIA_TYPE_VIDEO, var->video_group);
1581 if (var->subtitles_group[0])
1582 add_renditions_to_variant(c, var, AVMEDIA_TYPE_SUBTITLE, var->subtitles_group);
1585 /* Open the demuxer for each playlist */
1586 for (i = 0; i < c->n_playlists; i++) {
1587 struct playlist *pls = c->playlists[i];
1588 AVInputFormat *in_fmt = NULL;
1590 if (!(pls->ctx = avformat_alloc_context())) {
1591 ret = AVERROR(ENOMEM);
1595 if (pls->n_segments == 0)
1601 pls->cur_seq_no = select_cur_seq_no(c, pls);
1603 pls->read_buffer = av_malloc(INITIAL_BUFFER_SIZE);
1604 if (!pls->read_buffer){
1605 ret = AVERROR(ENOMEM);
1606 avformat_free_context(pls->ctx);
1610 ffio_init_context(&pls->pb, pls->read_buffer, INITIAL_BUFFER_SIZE, 0, pls,
1611 read_data, NULL, NULL);
1612 pls->pb.seekable = 0;
1613 ret = av_probe_input_buffer(&pls->pb, &in_fmt, pls->segments[0]->url,
1616 /* Free the ctx - it isn't initialized properly at this point,
1617 * so avformat_close_input shouldn't be called. If
1618 * avformat_open_input fails below, it frees and zeros the
1619 * context, so it doesn't need any special treatment like this. */
1620 av_log(s, AV_LOG_ERROR, "Error when loading first segment '%s'\n", pls->segments[0]->url);
1621 avformat_free_context(pls->ctx);
1625 pls->ctx->pb = &pls->pb;
1626 pls->stream_offset = stream_offset;
1628 if ((ret = ff_copy_whitelists(pls->ctx, s)) < 0)
1631 ret = avformat_open_input(&pls->ctx, pls->segments[0]->url, in_fmt, NULL);
1635 if (pls->id3_deferred_extra && pls->ctx->nb_streams == 1) {
1636 ff_id3v2_parse_apic(pls->ctx, &pls->id3_deferred_extra);
1637 avformat_queue_attached_pictures(pls->ctx);
1638 ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
1639 pls->id3_deferred_extra = NULL;
1642 pls->ctx->ctx_flags &= ~AVFMTCTX_NOHEADER;
1643 ret = avformat_find_stream_info(pls->ctx, NULL);
1647 if (pls->is_id3_timestamped == -1)
1648 av_log(s, AV_LOG_WARNING, "No expected HTTP requests have been made\n");
1650 /* Create new AVStreams for each stream in this playlist */
1651 for (j = 0; j < pls->ctx->nb_streams; j++) {
1652 AVStream *st = avformat_new_stream(s, NULL);
1653 AVStream *ist = pls->ctx->streams[j];
1655 ret = AVERROR(ENOMEM);
1660 avcodec_copy_context(st->codec, pls->ctx->streams[j]->codec);
1662 if (pls->is_id3_timestamped) /* custom timestamps via id3 */
1663 avpriv_set_pts_info(st, 33, 1, MPEG_TIME_BASE);
1665 avpriv_set_pts_info(st, ist->pts_wrap_bits, ist->time_base.num, ist->time_base.den);
1668 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_AUDIO);
1669 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_VIDEO);
1670 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_SUBTITLE);
1672 stream_offset += pls->ctx->nb_streams;
1675 /* Create a program for each variant */
1676 for (i = 0; i < c->n_variants; i++) {
1677 struct variant *v = c->variants[i];
1680 program = av_new_program(s, i);
1683 av_dict_set_int(&program->metadata, "variant_bitrate", v->bandwidth, 0);
1685 for (j = 0; j < v->n_playlists; j++) {
1686 struct playlist *pls = v->playlists[j];
1687 int is_shared = playlist_in_multiple_variants(c, pls);
1690 for (k = 0; k < pls->ctx->nb_streams; k++) {
1691 struct AVStream *st = s->streams[pls->stream_offset + k];
1693 av_program_add_stream_index(s, i, pls->stream_offset + k);
1695 /* Set variant_bitrate for streams unique to this variant */
1696 if (!is_shared && v->bandwidth)
1697 av_dict_set_int(&st->metadata, "variant_bitrate", v->bandwidth, 0);
1704 free_playlist_list(c);
1705 free_variant_list(c);
1706 free_rendition_list(c);
1710 static int recheck_discard_flags(AVFormatContext *s, int first)
1712 HLSContext *c = s->priv_data;
1715 /* Check if any new streams are needed */
1716 for (i = 0; i < c->n_playlists; i++)
1717 c->playlists[i]->cur_needed = 0;
1719 for (i = 0; i < s->nb_streams; i++) {
1720 AVStream *st = s->streams[i];
1721 struct playlist *pls = c->playlists[s->streams[i]->id];
1722 if (st->discard < AVDISCARD_ALL)
1723 pls->cur_needed = 1;
1725 for (i = 0; i < c->n_playlists; i++) {
1726 struct playlist *pls = c->playlists[i];
1727 if (pls->cur_needed && !pls->needed) {
1730 pls->cur_seq_no = select_cur_seq_no(c, pls);
1731 pls->pb.eof_reached = 0;
1732 if (c->cur_timestamp != AV_NOPTS_VALUE) {
1734 pls->seek_timestamp = c->cur_timestamp;
1735 pls->seek_flags = AVSEEK_FLAG_ANY;
1736 pls->seek_stream_index = -1;
1738 av_log(s, AV_LOG_INFO, "Now receiving playlist %d, segment %d\n", i, pls->cur_seq_no);
1739 } else if (first && !pls->cur_needed && pls->needed) {
1741 ffurl_close(pls->input);
1745 av_log(s, AV_LOG_INFO, "No longer receiving playlist %d\n", i);
1751 static void fill_timing_for_id3_timestamped_stream(struct playlist *pls)
1753 if (pls->id3_offset >= 0) {
1754 pls->pkt.dts = pls->id3_mpegts_timestamp +
1755 av_rescale_q(pls->id3_offset,
1756 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1758 if (pls->pkt.duration)
1759 pls->id3_offset += pls->pkt.duration;
1761 pls->id3_offset = -1;
1763 /* there have been packets with unknown duration
1764 * since the last id3 tag, should not normally happen */
1765 pls->pkt.dts = AV_NOPTS_VALUE;
1768 if (pls->pkt.duration)
1769 pls->pkt.duration = av_rescale_q(pls->pkt.duration,
1770 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1773 pls->pkt.pts = AV_NOPTS_VALUE;
1776 static AVRational get_timebase(struct playlist *pls)
1778 if (pls->is_id3_timestamped)
1779 return MPEG_TIME_BASE_Q;
1781 return pls->ctx->streams[pls->pkt.stream_index]->time_base;
1784 static int compare_ts_with_wrapdetect(int64_t ts_a, struct playlist *pls_a,
1785 int64_t ts_b, struct playlist *pls_b)
1787 int64_t scaled_ts_a = av_rescale_q(ts_a, get_timebase(pls_a), MPEG_TIME_BASE_Q);
1788 int64_t scaled_ts_b = av_rescale_q(ts_b, get_timebase(pls_b), MPEG_TIME_BASE_Q);
1790 return av_compare_mod(scaled_ts_a, scaled_ts_b, 1LL << 33);
1793 static int hls_read_packet(AVFormatContext *s, AVPacket *pkt)
1795 HLSContext *c = s->priv_data;
1796 int ret, i, minplaylist = -1;
1798 recheck_discard_flags(s, c->first_packet);
1799 c->first_packet = 0;
1801 for (i = 0; i < c->n_playlists; i++) {
1802 struct playlist *pls = c->playlists[i];
1803 /* Make sure we've got one buffered packet from each open playlist
1805 if (pls->needed && !pls->pkt.data) {
1809 ret = av_read_frame(pls->ctx, &pls->pkt);
1811 if (!avio_feof(&pls->pb) && ret != AVERROR_EOF)
1813 reset_packet(&pls->pkt);
1816 /* stream_index check prevents matching picture attachments etc. */
1817 if (pls->is_id3_timestamped && pls->pkt.stream_index == 0) {
1818 /* audio elementary streams are id3 timestamped */
1819 fill_timing_for_id3_timestamped_stream(pls);
1822 if (c->first_timestamp == AV_NOPTS_VALUE &&
1823 pls->pkt.dts != AV_NOPTS_VALUE)
1824 c->first_timestamp = av_rescale_q(pls->pkt.dts,
1825 get_timebase(pls), AV_TIME_BASE_Q);
1828 if (pls->seek_timestamp == AV_NOPTS_VALUE)
1831 if (pls->seek_stream_index < 0 ||
1832 pls->seek_stream_index == pls->pkt.stream_index) {
1834 if (pls->pkt.dts == AV_NOPTS_VALUE) {
1835 pls->seek_timestamp = AV_NOPTS_VALUE;
1839 tb = get_timebase(pls);
1840 ts_diff = av_rescale_rnd(pls->pkt.dts, AV_TIME_BASE,
1841 tb.den, AV_ROUND_DOWN) -
1842 pls->seek_timestamp;
1843 if (ts_diff >= 0 && (pls->seek_flags & AVSEEK_FLAG_ANY ||
1844 pls->pkt.flags & AV_PKT_FLAG_KEY)) {
1845 pls->seek_timestamp = AV_NOPTS_VALUE;
1849 av_packet_unref(&pls->pkt);
1850 reset_packet(&pls->pkt);
1853 /* Check if this stream has the packet with the lowest dts */
1854 if (pls->pkt.data) {
1855 struct playlist *minpls = minplaylist < 0 ?
1856 NULL : c->playlists[minplaylist];
1857 if (minplaylist < 0) {
1860 int64_t dts = pls->pkt.dts;
1861 int64_t mindts = minpls->pkt.dts;
1863 if (dts == AV_NOPTS_VALUE ||
1864 (mindts != AV_NOPTS_VALUE && compare_ts_with_wrapdetect(dts, pls, mindts, minpls) < 0))
1870 /* If we got a packet, return it */
1871 if (minplaylist >= 0) {
1872 struct playlist *pls = c->playlists[minplaylist];
1874 pkt->stream_index += pls->stream_offset;
1875 reset_packet(&c->playlists[minplaylist]->pkt);
1877 if (pkt->dts != AV_NOPTS_VALUE)
1878 c->cur_timestamp = av_rescale_q(pkt->dts,
1879 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1887 static int hls_close(AVFormatContext *s)
1889 HLSContext *c = s->priv_data;
1891 free_playlist_list(c);
1892 free_variant_list(c);
1893 free_rendition_list(c);
1895 av_dict_free(&c->avio_opts);
1900 static int hls_read_seek(AVFormatContext *s, int stream_index,
1901 int64_t timestamp, int flags)
1903 HLSContext *c = s->priv_data;
1904 struct playlist *seek_pls = NULL;
1906 int64_t first_timestamp, seek_timestamp, duration;
1908 if ((flags & AVSEEK_FLAG_BYTE) ||
1909 !(c->variants[0]->playlists[0]->finished || c->variants[0]->playlists[0]->type == PLS_TYPE_EVENT))
1910 return AVERROR(ENOSYS);
1912 first_timestamp = c->first_timestamp == AV_NOPTS_VALUE ?
1913 0 : c->first_timestamp;
1915 seek_timestamp = av_rescale_rnd(timestamp, AV_TIME_BASE,
1916 s->streams[stream_index]->time_base.den,
1917 flags & AVSEEK_FLAG_BACKWARD ?
1918 AV_ROUND_DOWN : AV_ROUND_UP);
1920 duration = s->duration == AV_NOPTS_VALUE ?
1923 if (0 < duration && duration < seek_timestamp - first_timestamp)
1924 return AVERROR(EIO);
1926 /* find the playlist with the specified stream */
1927 for (i = 0; i < c->n_playlists; i++) {
1928 struct playlist *pls = c->playlists[i];
1929 if (stream_index >= pls->stream_offset &&
1930 stream_index - pls->stream_offset < pls->ctx->nb_streams) {
1935 /* check if the timestamp is valid for the playlist with the
1936 * specified stream index */
1937 if (!seek_pls || !find_timestamp_in_playlist(c, seek_pls, seek_timestamp, &seq_no))
1938 return AVERROR(EIO);
1940 /* set segment now so we do not need to search again below */
1941 seek_pls->cur_seq_no = seq_no;
1942 seek_pls->seek_stream_index = stream_index - seek_pls->stream_offset;
1944 for (i = 0; i < c->n_playlists; i++) {
1946 struct playlist *pls = c->playlists[i];
1948 ffurl_close(pls->input);
1951 av_packet_unref(&pls->pkt);
1952 reset_packet(&pls->pkt);
1953 pls->pb.eof_reached = 0;
1954 /* Clear any buffered data */
1955 pls->pb.buf_end = pls->pb.buf_ptr = pls->pb.buffer;
1956 /* Reset the pos, to let the mpegts demuxer know we've seeked. */
1958 /* Flush the packet queue of the subdemuxer. */
1959 ff_read_frame_flush(pls->ctx);
1961 pls->seek_timestamp = seek_timestamp;
1962 pls->seek_flags = flags;
1964 if (pls != seek_pls) {
1965 /* set closest segment seq_no for playlists not handled above */
1966 find_timestamp_in_playlist(c, pls, seek_timestamp, &pls->cur_seq_no);
1967 /* seek the playlist to the given position without taking
1968 * keyframes into account since this playlist does not have the
1969 * specified stream where we should look for the keyframes */
1970 pls->seek_stream_index = -1;
1971 pls->seek_flags |= AVSEEK_FLAG_ANY;
1975 c->cur_timestamp = seek_timestamp;
1980 static int hls_probe(AVProbeData *p)
1982 /* Require #EXTM3U at the start, and either one of the ones below
1983 * somewhere for a proper match. */
1984 if (strncmp(p->buf, "#EXTM3U", 7))
1987 if (p->filename && !av_match_ext(p->filename, "m3u8,m3u"))
1990 if (strstr(p->buf, "#EXT-X-STREAM-INF:") ||
1991 strstr(p->buf, "#EXT-X-TARGETDURATION:") ||
1992 strstr(p->buf, "#EXT-X-MEDIA-SEQUENCE:"))
1993 return AVPROBE_SCORE_MAX;
1997 #define OFFSET(x) offsetof(HLSContext, x)
1998 #define FLAGS AV_OPT_FLAG_DECODING_PARAM
1999 static const AVOption hls_options[] = {
2000 {"live_start_index", "segment index to start live streams at (negative values are from the end)",
2001 OFFSET(live_start_index), AV_OPT_TYPE_INT, {.i64 = -3}, INT_MIN, INT_MAX, FLAGS},
2005 static const AVClass hls_class = {
2006 .class_name = "hls,applehttp",
2007 .item_name = av_default_item_name,
2008 .option = hls_options,
2009 .version = LIBAVUTIL_VERSION_INT,
2012 AVInputFormat ff_hls_demuxer = {
2013 .name = "hls,applehttp",
2014 .long_name = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
2015 .priv_class = &hls_class,
2016 .priv_data_size = sizeof(HLSContext),
2017 .read_probe = hls_probe,
2018 .read_header = hls_read_header,
2019 .read_packet = hls_read_packet,
2020 .read_close = hls_close,
2021 .read_seek = hls_read_seek,