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 AVDictionary *avio_opts;
200 int strict_std_compliance;
203 static int read_chomp_line(AVIOContext *s, char *buf, int maxlen)
205 int len = ff_get_line(s, buf, maxlen);
206 while (len > 0 && av_isspace(buf[len - 1]))
211 static void free_segment_list(struct playlist *pls)
214 for (i = 0; i < pls->n_segments; i++) {
215 av_freep(&pls->segments[i]->key);
216 av_freep(&pls->segments[i]->url);
217 av_freep(&pls->segments[i]);
219 av_freep(&pls->segments);
223 static void free_init_section_list(struct playlist *pls)
226 for (i = 0; i < pls->n_init_sections; i++) {
227 av_freep(&pls->init_sections[i]->url);
228 av_freep(&pls->init_sections[i]);
230 av_freep(&pls->init_sections);
231 pls->n_init_sections = 0;
234 static void free_playlist_list(HLSContext *c)
237 for (i = 0; i < c->n_playlists; i++) {
238 struct playlist *pls = c->playlists[i];
239 free_segment_list(pls);
240 free_init_section_list(pls);
241 av_freep(&pls->renditions);
242 av_freep(&pls->id3_buf);
243 av_dict_free(&pls->id3_initial);
244 ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
245 av_freep(&pls->init_sec_buf);
246 av_packet_unref(&pls->pkt);
247 av_freep(&pls->pb.buffer);
249 ffurl_close(pls->input);
252 avformat_close_input(&pls->ctx);
256 av_freep(&c->playlists);
257 av_freep(&c->cookies);
258 av_freep(&c->user_agent);
262 static void free_variant_list(HLSContext *c)
265 for (i = 0; i < c->n_variants; i++) {
266 struct variant *var = c->variants[i];
267 av_freep(&var->playlists);
270 av_freep(&c->variants);
274 static void free_rendition_list(HLSContext *c)
277 for (i = 0; i < c->n_renditions; i++)
278 av_freep(&c->renditions[i]);
279 av_freep(&c->renditions);
284 * Used to reset a statically allocated AVPacket to a clean slate,
285 * containing no data.
287 static void reset_packet(AVPacket *pkt)
293 static struct playlist *new_playlist(HLSContext *c, const char *url,
296 struct playlist *pls = av_mallocz(sizeof(struct playlist));
299 reset_packet(&pls->pkt);
300 ff_make_absolute_url(pls->url, sizeof(pls->url), base, url);
301 pls->seek_timestamp = AV_NOPTS_VALUE;
303 pls->is_id3_timestamped = -1;
304 pls->id3_mpegts_timestamp = AV_NOPTS_VALUE;
306 dynarray_add(&c->playlists, &c->n_playlists, pls);
310 struct variant_info {
312 /* variant group ids: */
313 char audio[MAX_FIELD_LEN];
314 char video[MAX_FIELD_LEN];
315 char subtitles[MAX_FIELD_LEN];
318 static struct variant *new_variant(HLSContext *c, struct variant_info *info,
319 const char *url, const char *base)
322 struct playlist *pls;
324 pls = new_playlist(c, url, base);
328 var = av_mallocz(sizeof(struct variant));
333 var->bandwidth = atoi(info->bandwidth);
334 strcpy(var->audio_group, info->audio);
335 strcpy(var->video_group, info->video);
336 strcpy(var->subtitles_group, info->subtitles);
339 dynarray_add(&c->variants, &c->n_variants, var);
340 dynarray_add(&var->playlists, &var->n_playlists, pls);
344 static void handle_variant_args(struct variant_info *info, const char *key,
345 int key_len, char **dest, int *dest_len)
347 if (!strncmp(key, "BANDWIDTH=", key_len)) {
348 *dest = info->bandwidth;
349 *dest_len = sizeof(info->bandwidth);
350 } else if (!strncmp(key, "AUDIO=", key_len)) {
352 *dest_len = sizeof(info->audio);
353 } else if (!strncmp(key, "VIDEO=", key_len)) {
355 *dest_len = sizeof(info->video);
356 } else if (!strncmp(key, "SUBTITLES=", key_len)) {
357 *dest = info->subtitles;
358 *dest_len = sizeof(info->subtitles);
363 char uri[MAX_URL_SIZE];
368 static void handle_key_args(struct key_info *info, const char *key,
369 int key_len, char **dest, int *dest_len)
371 if (!strncmp(key, "METHOD=", key_len)) {
372 *dest = info->method;
373 *dest_len = sizeof(info->method);
374 } else if (!strncmp(key, "URI=", key_len)) {
376 *dest_len = sizeof(info->uri);
377 } else if (!strncmp(key, "IV=", key_len)) {
379 *dest_len = sizeof(info->iv);
383 struct init_section_info {
384 char uri[MAX_URL_SIZE];
388 static struct segment *new_init_section(struct playlist *pls,
389 struct init_section_info *info,
390 const char *url_base)
394 char tmp_str[MAX_URL_SIZE];
399 sec = av_mallocz(sizeof(*sec));
403 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url_base, info->uri);
404 sec->url = av_strdup(tmp_str);
410 if (info->byterange[0]) {
411 sec->size = atoi(info->byterange);
412 ptr = strchr(info->byterange, '@');
414 sec->url_offset = atoi(ptr+1);
416 /* the entire file is the init section */
420 dynarray_add(&pls->init_sections, &pls->n_init_sections, sec);
425 static void handle_init_section_args(struct init_section_info *info, const char *key,
426 int key_len, char **dest, int *dest_len)
428 if (!strncmp(key, "URI=", key_len)) {
430 *dest_len = sizeof(info->uri);
431 } else if (!strncmp(key, "BYTERANGE=", key_len)) {
432 *dest = info->byterange;
433 *dest_len = sizeof(info->byterange);
437 struct rendition_info {
439 char uri[MAX_URL_SIZE];
440 char group_id[MAX_FIELD_LEN];
441 char language[MAX_FIELD_LEN];
442 char assoc_language[MAX_FIELD_LEN];
443 char name[MAX_FIELD_LEN];
446 char characteristics[MAX_CHARACTERISTICS_LEN];
449 static struct rendition *new_rendition(HLSContext *c, struct rendition_info *info,
450 const char *url_base)
452 struct rendition *rend;
453 enum AVMediaType type = AVMEDIA_TYPE_UNKNOWN;
454 char *characteristic;
458 if (!strcmp(info->type, "AUDIO"))
459 type = AVMEDIA_TYPE_AUDIO;
460 else if (!strcmp(info->type, "VIDEO"))
461 type = AVMEDIA_TYPE_VIDEO;
462 else if (!strcmp(info->type, "SUBTITLES"))
463 type = AVMEDIA_TYPE_SUBTITLE;
464 else if (!strcmp(info->type, "CLOSED-CAPTIONS"))
465 /* CLOSED-CAPTIONS is ignored since we do not support CEA-608 CC in
466 * AVC SEI RBSP anyway */
469 if (type == AVMEDIA_TYPE_UNKNOWN)
472 /* URI is mandatory for subtitles as per spec */
473 if (type == AVMEDIA_TYPE_SUBTITLE && !info->uri[0])
476 /* TODO: handle subtitles (each segment has to parsed separately) */
477 if (c->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL)
478 if (type == AVMEDIA_TYPE_SUBTITLE)
481 rend = av_mallocz(sizeof(struct rendition));
485 dynarray_add(&c->renditions, &c->n_renditions, rend);
488 strcpy(rend->group_id, info->group_id);
489 strcpy(rend->language, info->language);
490 strcpy(rend->name, info->name);
492 /* add the playlist if this is an external rendition */
494 rend->playlist = new_playlist(c, info->uri, url_base);
496 dynarray_add(&rend->playlist->renditions,
497 &rend->playlist->n_renditions, rend);
500 if (info->assoc_language[0]) {
501 int langlen = strlen(rend->language);
502 if (langlen < sizeof(rend->language) - 3) {
503 rend->language[langlen] = ',';
504 strncpy(rend->language + langlen + 1, info->assoc_language,
505 sizeof(rend->language) - langlen - 2);
509 if (!strcmp(info->defaultr, "YES"))
510 rend->disposition |= AV_DISPOSITION_DEFAULT;
511 if (!strcmp(info->forced, "YES"))
512 rend->disposition |= AV_DISPOSITION_FORCED;
514 chr_ptr = info->characteristics;
515 while ((characteristic = av_strtok(chr_ptr, ",", &saveptr))) {
516 if (!strcmp(characteristic, "public.accessibility.describes-music-and-sound"))
517 rend->disposition |= AV_DISPOSITION_HEARING_IMPAIRED;
518 else if (!strcmp(characteristic, "public.accessibility.describes-video"))
519 rend->disposition |= AV_DISPOSITION_VISUAL_IMPAIRED;
527 static void handle_rendition_args(struct rendition_info *info, const char *key,
528 int key_len, char **dest, int *dest_len)
530 if (!strncmp(key, "TYPE=", key_len)) {
532 *dest_len = sizeof(info->type);
533 } else if (!strncmp(key, "URI=", key_len)) {
535 *dest_len = sizeof(info->uri);
536 } else if (!strncmp(key, "GROUP-ID=", key_len)) {
537 *dest = info->group_id;
538 *dest_len = sizeof(info->group_id);
539 } else if (!strncmp(key, "LANGUAGE=", key_len)) {
540 *dest = info->language;
541 *dest_len = sizeof(info->language);
542 } else if (!strncmp(key, "ASSOC-LANGUAGE=", key_len)) {
543 *dest = info->assoc_language;
544 *dest_len = sizeof(info->assoc_language);
545 } else if (!strncmp(key, "NAME=", key_len)) {
547 *dest_len = sizeof(info->name);
548 } else if (!strncmp(key, "DEFAULT=", key_len)) {
549 *dest = info->defaultr;
550 *dest_len = sizeof(info->defaultr);
551 } else if (!strncmp(key, "FORCED=", key_len)) {
552 *dest = info->forced;
553 *dest_len = sizeof(info->forced);
554 } else if (!strncmp(key, "CHARACTERISTICS=", key_len)) {
555 *dest = info->characteristics;
556 *dest_len = sizeof(info->characteristics);
560 * - AUTOSELECT: client may autoselect based on e.g. system language
561 * - INSTREAM-ID: EIA-608 closed caption number ("CC1".."CC4")
565 /* used by parse_playlist to allocate a new variant+playlist when the
566 * playlist is detected to be a Media Playlist (not Master Playlist)
567 * and we have no parent Master Playlist (parsing of which would have
568 * allocated the variant and playlist already)
569 * *pls == NULL => Master Playlist or parentless Media Playlist
570 * *pls != NULL => parented Media Playlist, playlist+variant allocated */
571 static int ensure_playlist(HLSContext *c, struct playlist **pls, const char *url)
575 if (!new_variant(c, NULL, url, NULL))
576 return AVERROR(ENOMEM);
577 *pls = c->playlists[c->n_playlists - 1];
581 static int url_connect(struct playlist *pls, AVDictionary *opts, AVDictionary *opts2)
583 AVDictionary *tmp = NULL;
586 av_dict_copy(&tmp, opts, 0);
587 av_dict_copy(&tmp, opts2, 0);
589 if ((ret = ffurl_connect(pls->input, &tmp)) < 0) {
590 ffurl_close(pls->input);
598 static void update_options(char **dest, const char *name, void *src)
601 av_opt_get(src, name, 0, (uint8_t**)dest);
602 if (*dest && !strlen(*dest))
606 static int open_url(HLSContext *c, URLContext **uc, const char *url, AVDictionary *opts)
608 AVDictionary *tmp = NULL;
611 av_dict_copy(&tmp, c->avio_opts, 0);
612 av_dict_copy(&tmp, opts, 0);
614 ret = ffurl_open(uc, url, AVIO_FLAG_READ, c->interrupt_callback, &tmp);
616 // update cookies on http response with setcookies.
618 update_options(&c->cookies, "cookies", u->priv_data);
619 av_dict_set(&opts, "cookies", c->cookies, 0);
627 static int parse_playlist(HLSContext *c, const char *url,
628 struct playlist *pls, AVIOContext *in)
630 int ret = 0, is_segment = 0, is_variant = 0;
631 int64_t duration = 0;
632 enum KeyType key_type = KEY_NONE;
635 char key[MAX_URL_SIZE] = "";
636 char line[MAX_URL_SIZE];
639 int64_t seg_offset = 0;
640 int64_t seg_size = -1;
641 uint8_t *new_url = NULL;
642 struct variant_info variant_info;
643 char tmp_str[MAX_URL_SIZE];
644 struct segment *cur_init_section = NULL;
648 AVDictionary *opts = NULL;
650 /* Some HLS servers don't like being sent the range header */
651 av_dict_set(&opts, "seekable", "0", 0);
653 // broker prior HTTP options that should be consistent across requests
654 av_dict_set(&opts, "user-agent", c->user_agent, 0);
655 av_dict_set(&opts, "cookies", c->cookies, 0);
656 av_dict_set(&opts, "headers", c->headers, 0);
658 ret = avio_open2(&in, url, AVIO_FLAG_READ,
659 c->interrupt_callback, &opts);
664 ret = open_in(c, &in, url);
671 if (av_opt_get(in, "location", AV_OPT_SEARCH_CHILDREN, &new_url) >= 0)
674 read_chomp_line(in, line, sizeof(line));
675 if (strcmp(line, "#EXTM3U")) {
676 ret = AVERROR_INVALIDDATA;
681 free_segment_list(pls);
683 pls->type = PLS_TYPE_UNSPECIFIED;
685 while (!avio_feof(in)) {
686 read_chomp_line(in, line, sizeof(line));
687 if (av_strstart(line, "#EXT-X-STREAM-INF:", &ptr)) {
689 memset(&variant_info, 0, sizeof(variant_info));
690 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_variant_args,
692 } else if (av_strstart(line, "#EXT-X-KEY:", &ptr)) {
693 struct key_info info = {{0}};
694 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_key_args,
698 if (!strcmp(info.method, "AES-128"))
699 key_type = KEY_AES_128;
700 if (!strcmp(info.method, "SAMPLE-AES"))
701 key_type = KEY_SAMPLE_AES;
702 if (!strncmp(info.iv, "0x", 2) || !strncmp(info.iv, "0X", 2)) {
703 ff_hex_to_data(iv, info.iv + 2);
706 av_strlcpy(key, info.uri, sizeof(key));
707 } else if (av_strstart(line, "#EXT-X-MEDIA:", &ptr)) {
708 struct rendition_info info = {{0}};
709 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_rendition_args,
711 new_rendition(c, &info, url);
712 } else if (av_strstart(line, "#EXT-X-TARGETDURATION:", &ptr)) {
713 ret = ensure_playlist(c, &pls, url);
716 pls->target_duration = atoi(ptr) * AV_TIME_BASE;
717 } else if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
718 ret = ensure_playlist(c, &pls, url);
721 pls->start_seq_no = atoi(ptr);
722 } else if (av_strstart(line, "#EXT-X-PLAYLIST-TYPE:", &ptr)) {
723 ret = ensure_playlist(c, &pls, url);
726 if (!strcmp(ptr, "EVENT"))
727 pls->type = PLS_TYPE_EVENT;
728 else if (!strcmp(ptr, "VOD"))
729 pls->type = PLS_TYPE_VOD;
730 } else if (av_strstart(line, "#EXT-X-MAP:", &ptr)) {
731 struct init_section_info info = {{0}};
732 ret = ensure_playlist(c, &pls, url);
735 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_init_section_args,
737 cur_init_section = new_init_section(pls, &info, url);
738 } else if (av_strstart(line, "#EXT-X-ENDLIST", &ptr)) {
741 } else if (av_strstart(line, "#EXTINF:", &ptr)) {
743 duration = atof(ptr) * AV_TIME_BASE;
744 } else if (av_strstart(line, "#EXT-X-BYTERANGE:", &ptr)) {
745 seg_size = atoi(ptr);
746 ptr = strchr(ptr, '@');
748 seg_offset = atoi(ptr+1);
749 } else if (av_strstart(line, "#", NULL)) {
751 } else if (line[0]) {
753 if (!new_variant(c, &variant_info, line, url)) {
754 ret = AVERROR(ENOMEM);
762 if (!new_variant(c, 0, url, NULL)) {
763 ret = AVERROR(ENOMEM);
766 pls = c->playlists[c->n_playlists - 1];
768 seg = av_malloc(sizeof(struct segment));
770 ret = AVERROR(ENOMEM);
773 seg->duration = duration;
774 seg->key_type = key_type;
776 memcpy(seg->iv, iv, sizeof(iv));
778 int seq = pls->start_seq_no + pls->n_segments;
779 memset(seg->iv, 0, sizeof(seg->iv));
780 AV_WB32(seg->iv + 12, seq);
783 if (key_type != KEY_NONE) {
784 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, key);
785 seg->key = av_strdup(tmp_str);
788 ret = AVERROR(ENOMEM);
795 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, line);
796 seg->url = av_strdup(tmp_str);
800 ret = AVERROR(ENOMEM);
804 dynarray_add(&pls->segments, &pls->n_segments, seg);
807 seg->size = seg_size;
809 seg->url_offset = seg_offset;
810 seg_offset += seg_size;
817 seg->init_section = cur_init_section;
822 pls->last_load_time = av_gettime_relative();
831 static struct segment *current_segment(struct playlist *pls)
833 return pls->segments[pls->cur_seq_no - pls->start_seq_no];
836 enum ReadFromURLMode {
841 /* read from URLContext, limiting read to current segment */
842 static int read_from_url(struct playlist *pls, struct segment *seg,
843 uint8_t *buf, int buf_size,
844 enum ReadFromURLMode mode)
848 /* limit read if the segment was only a part of a file */
850 buf_size = FFMIN(buf_size, seg->size - pls->cur_seg_offset);
852 if (mode == READ_COMPLETE)
853 ret = ffurl_read_complete(pls->input, buf, buf_size);
855 ret = ffurl_read(pls->input, buf, buf_size);
858 pls->cur_seg_offset += ret;
863 /* Parse the raw ID3 data and pass contents to caller */
864 static void parse_id3(AVFormatContext *s, AVIOContext *pb,
865 AVDictionary **metadata, int64_t *dts,
866 ID3v2ExtraMetaAPIC **apic, ID3v2ExtraMeta **extra_meta)
868 static const char id3_priv_owner_ts[] = "com.apple.streaming.transportStreamTimestamp";
869 ID3v2ExtraMeta *meta;
871 ff_id3v2_read_dict(pb, metadata, ID3v2_DEFAULT_MAGIC, extra_meta);
872 for (meta = *extra_meta; meta; meta = meta->next) {
873 if (!strcmp(meta->tag, "PRIV")) {
874 ID3v2ExtraMetaPRIV *priv = meta->data;
875 if (priv->datasize == 8 && !strcmp(priv->owner, id3_priv_owner_ts)) {
876 /* 33-bit MPEG timestamp */
877 int64_t ts = AV_RB64(priv->data);
878 av_log(s, AV_LOG_DEBUG, "HLS ID3 audio timestamp %"PRId64"\n", ts);
879 if ((ts & ~((1ULL << 33) - 1)) == 0)
882 av_log(s, AV_LOG_ERROR, "Invalid HLS ID3 audio timestamp %"PRId64"\n", ts);
884 } else if (!strcmp(meta->tag, "APIC") && apic)
889 /* Check if the ID3 metadata contents have changed */
890 static int id3_has_changed_values(struct playlist *pls, AVDictionary *metadata,
891 ID3v2ExtraMetaAPIC *apic)
893 AVDictionaryEntry *entry = NULL;
894 AVDictionaryEntry *oldentry;
895 /* check that no keys have changed values */
896 while ((entry = av_dict_get(metadata, "", entry, AV_DICT_IGNORE_SUFFIX))) {
897 oldentry = av_dict_get(pls->id3_initial, entry->key, NULL, AV_DICT_MATCH_CASE);
898 if (!oldentry || strcmp(oldentry->value, entry->value) != 0)
902 /* check if apic appeared */
903 if (apic && (pls->ctx->nb_streams != 2 || !pls->ctx->streams[1]->attached_pic.data))
907 int size = pls->ctx->streams[1]->attached_pic.size;
908 if (size != apic->buf->size - AV_INPUT_BUFFER_PADDING_SIZE)
911 if (memcmp(apic->buf->data, pls->ctx->streams[1]->attached_pic.data, size) != 0)
918 /* Parse ID3 data and handle the found data */
919 static void handle_id3(AVIOContext *pb, struct playlist *pls)
921 AVDictionary *metadata = NULL;
922 ID3v2ExtraMetaAPIC *apic = NULL;
923 ID3v2ExtraMeta *extra_meta = NULL;
924 int64_t timestamp = AV_NOPTS_VALUE;
926 parse_id3(pls->ctx, pb, &metadata, ×tamp, &apic, &extra_meta);
928 if (timestamp != AV_NOPTS_VALUE) {
929 pls->id3_mpegts_timestamp = timestamp;
933 if (!pls->id3_found) {
934 /* initial ID3 tags */
935 av_assert0(!pls->id3_deferred_extra);
938 /* get picture attachment and set text metadata */
939 if (pls->ctx->nb_streams)
940 ff_id3v2_parse_apic(pls->ctx, &extra_meta);
942 /* demuxer not yet opened, defer picture attachment */
943 pls->id3_deferred_extra = extra_meta;
945 av_dict_copy(&pls->ctx->metadata, metadata, 0);
946 pls->id3_initial = metadata;
949 if (!pls->id3_changed && id3_has_changed_values(pls, metadata, apic)) {
950 avpriv_report_missing_feature(pls->ctx, "Changing ID3 metadata in HLS audio elementary stream");
951 pls->id3_changed = 1;
953 av_dict_free(&metadata);
956 if (!pls->id3_deferred_extra)
957 ff_id3v2_free_extra_meta(&extra_meta);
960 /* Intercept and handle ID3 tags between URLContext and AVIOContext */
961 static void intercept_id3(struct playlist *pls, uint8_t *buf,
962 int buf_size, int *len)
964 /* intercept id3 tags, we do not want to pass them to the raw
965 * demuxer on all segment switches */
969 struct segment *seg = current_segment(pls);
971 /* gather all the id3 tags */
973 /* see if we can retrieve enough data for ID3 header */
974 if (*len < ID3v2_HEADER_SIZE && buf_size >= ID3v2_HEADER_SIZE) {
975 bytes = read_from_url(pls, seg, buf + *len, ID3v2_HEADER_SIZE - *len, READ_COMPLETE);
978 if (bytes == ID3v2_HEADER_SIZE - *len)
979 /* no EOF yet, so fill the caller buffer again after
980 * we have stripped the ID3 tags */
985 } else if (*len <= 0) {
992 if (*len < ID3v2_HEADER_SIZE)
995 if (ff_id3v2_match(buf, ID3v2_DEFAULT_MAGIC)) {
996 int64_t maxsize = seg->size >= 0 ? seg->size : 1024*1024;
997 int taglen = ff_id3v2_tag_len(buf);
998 int tag_got_bytes = FFMIN(taglen, *len);
999 int remaining = taglen - tag_got_bytes;
1001 if (taglen > maxsize) {
1002 av_log(pls->ctx, AV_LOG_ERROR, "Too large HLS ID3 tag (%d > %"PRId64" bytes)\n",
1008 * Copy the id3 tag to our temporary id3 buffer.
1009 * We could read a small id3 tag directly without memcpy, but
1010 * we would still need to copy the large tags, and handling
1011 * both of those cases together with the possibility for multiple
1012 * tags would make the handling a bit complex.
1014 pls->id3_buf = av_fast_realloc(pls->id3_buf, &pls->id3_buf_size, id3_buf_pos + taglen);
1017 memcpy(pls->id3_buf + id3_buf_pos, buf, tag_got_bytes);
1018 id3_buf_pos += tag_got_bytes;
1020 /* strip the intercepted bytes */
1021 *len -= tag_got_bytes;
1022 memmove(buf, buf + tag_got_bytes, *len);
1023 av_log(pls->ctx, AV_LOG_DEBUG, "Stripped %d HLS ID3 bytes\n", tag_got_bytes);
1025 if (remaining > 0) {
1026 /* read the rest of the tag in */
1027 if (read_from_url(pls, seg, pls->id3_buf + id3_buf_pos, remaining, READ_COMPLETE) != remaining)
1029 id3_buf_pos += remaining;
1030 av_log(pls->ctx, AV_LOG_DEBUG, "Stripped additional %d HLS ID3 bytes\n", remaining);
1034 /* no more ID3 tags */
1039 /* re-fill buffer for the caller unless EOF */
1040 if (*len >= 0 && (fill_buf || *len == 0)) {
1041 bytes = read_from_url(pls, seg, buf + *len, buf_size - *len, READ_NORMAL);
1043 /* ignore error if we already had some data */
1051 /* Now parse all the ID3 tags */
1052 AVIOContext id3ioctx;
1053 ffio_init_context(&id3ioctx, pls->id3_buf, id3_buf_pos, 0, NULL, NULL, NULL, NULL);
1054 handle_id3(&id3ioctx, pls);
1057 if (pls->is_id3_timestamped == -1)
1058 pls->is_id3_timestamped = (pls->id3_mpegts_timestamp != AV_NOPTS_VALUE);
1061 static int open_input(HLSContext *c, struct playlist *pls, struct segment *seg)
1063 AVDictionary *opts = NULL;
1066 // broker prior HTTP options that should be consistent across requests
1067 av_dict_set(&opts, "user-agent", c->user_agent, 0);
1068 av_dict_set(&opts, "cookies", c->cookies, 0);
1069 av_dict_set(&opts, "headers", c->headers, 0);
1070 av_dict_set(&opts, "seekable", "0", 0);
1072 if (seg->size >= 0) {
1073 /* try to restrict the HTTP request to the part we want
1074 * (if this is in fact a HTTP request) */
1075 av_dict_set_int(&opts, "offset", seg->url_offset, 0);
1076 av_dict_set_int(&opts, "end_offset", seg->url_offset + seg->size, 0);
1079 av_log(pls->parent, AV_LOG_VERBOSE, "HLS request for url '%s', offset %"PRId64", playlist %d\n",
1080 seg->url, seg->url_offset, pls->index);
1082 if (seg->key_type == KEY_NONE) {
1083 ret = open_url(pls->parent->priv_data, &pls->input, seg->url, opts);
1084 } else if (seg->key_type == KEY_AES_128) {
1085 // HLSContext *c = var->parent->priv_data;
1086 char iv[33], key[33], url[MAX_URL_SIZE];
1087 if (strcmp(seg->key, pls->key_url)) {
1089 if (open_url(pls->parent->priv_data, &uc, seg->key, opts) == 0) {
1090 if (ffurl_read_complete(uc, pls->key, sizeof(pls->key))
1091 != sizeof(pls->key)) {
1092 av_log(NULL, AV_LOG_ERROR, "Unable to read key file %s\n",
1097 av_log(NULL, AV_LOG_ERROR, "Unable to open key file %s\n",
1100 av_strlcpy(pls->key_url, seg->key, sizeof(pls->key_url));
1102 ff_data_to_hex(iv, seg->iv, sizeof(seg->iv), 0);
1103 ff_data_to_hex(key, pls->key, sizeof(pls->key), 0);
1104 iv[32] = key[32] = '\0';
1105 if (strstr(seg->url, "://"))
1106 snprintf(url, sizeof(url), "crypto+%s", seg->url);
1108 snprintf(url, sizeof(url), "crypto:%s", seg->url);
1110 if ((ret = ffurl_alloc(&pls->input, url, AVIO_FLAG_READ,
1111 &pls->parent->interrupt_callback)) < 0)
1113 av_opt_set(pls->input->priv_data, "key", key, 0);
1114 av_opt_set(pls->input->priv_data, "iv", iv, 0);
1116 if ((ret = url_connect(pls, c->avio_opts, opts)) < 0) {
1120 } else if (seg->key_type == KEY_SAMPLE_AES) {
1121 av_log(pls->parent, AV_LOG_ERROR,
1122 "SAMPLE-AES encryption is not supported yet\n");
1123 ret = AVERROR_PATCHWELCOME;
1126 ret = AVERROR(ENOSYS);
1128 /* Seek to the requested position. If this was a HTTP request, the offset
1129 * should already be where want it to, but this allows e.g. local testing
1130 * without a HTTP server. */
1131 if (ret == 0 && seg->key_type == KEY_NONE && seg->url_offset) {
1132 int seekret = ffurl_seek(pls->input, seg->url_offset, SEEK_SET);
1134 av_log(pls->parent, AV_LOG_ERROR, "Unable to seek to offset %"PRId64" of HLS segment '%s'\n", seg->url_offset, seg->url);
1136 ffurl_close(pls->input);
1142 av_dict_free(&opts);
1143 pls->cur_seg_offset = 0;
1147 static int update_init_section(struct playlist *pls, struct segment *seg)
1149 static const int max_init_section_size = 1024*1024;
1150 HLSContext *c = pls->parent->priv_data;
1155 if (seg->init_section == pls->cur_init_section)
1158 pls->cur_init_section = NULL;
1160 if (!seg->init_section)
1163 /* this will clobber playlist URLContext stuff, so this should be
1164 * called between segments only */
1165 ret = open_input(c, pls, seg->init_section);
1167 av_log(pls->parent, AV_LOG_WARNING,
1168 "Failed to open an initialization section in playlist %d\n",
1173 if (seg->init_section->size >= 0)
1174 sec_size = seg->init_section->size;
1175 else if ((urlsize = ffurl_size(pls->input)) >= 0)
1178 sec_size = max_init_section_size;
1180 av_log(pls->parent, AV_LOG_DEBUG,
1181 "Downloading an initialization section of size %"PRId64"\n",
1184 sec_size = FFMIN(sec_size, max_init_section_size);
1186 av_fast_malloc(&pls->init_sec_buf, &pls->init_sec_buf_size, sec_size);
1188 ret = read_from_url(pls, seg->init_section, pls->init_sec_buf,
1189 pls->init_sec_buf_size, READ_COMPLETE);
1190 ffurl_close(pls->input);
1196 pls->cur_init_section = seg->init_section;
1197 pls->init_sec_data_len = ret;
1198 pls->init_sec_buf_read_offset = 0;
1200 /* spec says audio elementary streams do not have media initialization
1201 * sections, so there should be no ID3 timestamps */
1202 pls->is_id3_timestamped = 0;
1207 static int64_t default_reload_interval(struct playlist *pls)
1209 return pls->n_segments > 0 ?
1210 pls->segments[pls->n_segments - 1]->duration :
1211 pls->target_duration;
1214 static int read_data(void *opaque, uint8_t *buf, int buf_size)
1216 struct playlist *v = opaque;
1217 HLSContext *c = v->parent->priv_data;
1219 int just_opened = 0;
1226 int64_t reload_interval;
1227 struct segment *seg;
1229 /* Check that the playlist is still needed before opening a new
1231 if (v->ctx && v->ctx->nb_streams &&
1232 v->parent->nb_streams >= v->stream_offset + v->ctx->nb_streams) {
1234 for (i = v->stream_offset; i < v->stream_offset + v->ctx->nb_streams;
1236 if (v->parent->streams[i]->discard < AVDISCARD_ALL)
1241 av_log(v->parent, AV_LOG_INFO, "No longer receiving playlist %d\n",
1246 /* If this is a live stream and the reload interval has elapsed since
1247 * the last playlist reload, reload the playlists now. */
1248 reload_interval = default_reload_interval(v);
1252 av_gettime_relative() - v->last_load_time >= reload_interval) {
1253 if ((ret = parse_playlist(c, v->url, v, NULL)) < 0) {
1254 av_log(v->parent, AV_LOG_WARNING, "Failed to reload playlist %d\n",
1258 /* If we need to reload the playlist again below (if
1259 * there's still no more segments), switch to a reload
1260 * interval of half the target duration. */
1261 reload_interval = v->target_duration / 2;
1263 if (v->cur_seq_no < v->start_seq_no) {
1264 av_log(NULL, AV_LOG_WARNING,
1265 "skipping %d segments ahead, expired from playlists\n",
1266 v->start_seq_no - v->cur_seq_no);
1267 v->cur_seq_no = v->start_seq_no;
1269 if (v->cur_seq_no >= v->start_seq_no + v->n_segments) {
1272 while (av_gettime_relative() - v->last_load_time < reload_interval) {
1273 if (ff_check_interrupt(c->interrupt_callback))
1274 return AVERROR_EXIT;
1275 av_usleep(100*1000);
1277 /* Enough time has elapsed since the last reload */
1281 seg = current_segment(v);
1283 /* load/update Media Initialization Section, if any */
1284 ret = update_init_section(v, seg);
1288 ret = open_input(c, v, seg);
1290 if (ff_check_interrupt(c->interrupt_callback))
1291 return AVERROR_EXIT;
1292 av_log(v->parent, AV_LOG_WARNING, "Failed to open segment of playlist %d\n",
1300 if (v->init_sec_buf_read_offset < v->init_sec_data_len) {
1301 /* Push init section out first before first actual segment */
1302 int copy_size = FFMIN(v->init_sec_data_len - v->init_sec_buf_read_offset, buf_size);
1303 memcpy(buf, v->init_sec_buf, copy_size);
1304 v->init_sec_buf_read_offset += copy_size;
1308 ret = read_from_url(v, current_segment(v), buf, buf_size, READ_NORMAL);
1310 if (just_opened && v->is_id3_timestamped != 0) {
1311 /* Intercept ID3 tags here, elementary audio streams are required
1312 * to convey timestamps using them in the beginning of each segment. */
1313 intercept_id3(v, buf, buf_size, &ret);
1318 ffurl_close(v->input);
1322 c->cur_seq_no = v->cur_seq_no;
1327 static int playlist_in_multiple_variants(HLSContext *c, struct playlist *pls)
1329 int variant_count = 0;
1332 for (i = 0; i < c->n_variants && variant_count < 2; i++) {
1333 struct variant *v = c->variants[i];
1335 for (j = 0; j < v->n_playlists; j++) {
1336 if (v->playlists[j] == pls) {
1343 return variant_count >= 2;
1346 static void add_renditions_to_variant(HLSContext *c, struct variant *var,
1347 enum AVMediaType type, const char *group_id)
1351 for (i = 0; i < c->n_renditions; i++) {
1352 struct rendition *rend = c->renditions[i];
1354 if (rend->type == type && !strcmp(rend->group_id, group_id)) {
1357 /* rendition is an external playlist
1358 * => add the playlist to the variant */
1359 dynarray_add(&var->playlists, &var->n_playlists, rend->playlist);
1361 /* rendition is part of the variant main Media Playlist
1362 * => add the rendition to the main Media Playlist */
1363 dynarray_add(&var->playlists[0]->renditions,
1364 &var->playlists[0]->n_renditions,
1370 static void add_metadata_from_renditions(AVFormatContext *s, struct playlist *pls,
1371 enum AVMediaType type)
1376 for (i = 0; i < pls->ctx->nb_streams; i++) {
1377 AVStream *st = s->streams[pls->stream_offset + i];
1379 if (st->codec->codec_type != type)
1382 for (; rend_idx < pls->n_renditions; rend_idx++) {
1383 struct rendition *rend = pls->renditions[rend_idx];
1385 if (rend->type != type)
1388 if (rend->language[0])
1389 av_dict_set(&st->metadata, "language", rend->language, 0);
1391 av_dict_set(&st->metadata, "comment", rend->name, 0);
1393 st->disposition |= rend->disposition;
1395 if (rend_idx >=pls->n_renditions)
1400 /* if timestamp was in valid range: returns 1 and sets seq_no
1401 * if not: returns 0 and sets seq_no to closest segment */
1402 static int find_timestamp_in_playlist(HLSContext *c, struct playlist *pls,
1403 int64_t timestamp, int *seq_no)
1406 int64_t pos = c->first_timestamp == AV_NOPTS_VALUE ?
1407 0 : c->first_timestamp;
1409 if (timestamp < pos) {
1410 *seq_no = pls->start_seq_no;
1414 for (i = 0; i < pls->n_segments; i++) {
1415 int64_t diff = pos + pls->segments[i]->duration - timestamp;
1417 *seq_no = pls->start_seq_no + i;
1420 pos += pls->segments[i]->duration;
1423 *seq_no = pls->start_seq_no + pls->n_segments - 1;
1428 static int select_cur_seq_no(HLSContext *c, struct playlist *pls)
1432 if (!pls->finished && !c->first_packet &&
1433 av_gettime_relative() - pls->last_load_time >= default_reload_interval(pls))
1434 /* reload the playlist since it was suspended */
1435 parse_playlist(c, pls->url, pls, NULL);
1437 /* If playback is already in progress (we are just selecting a new
1438 * playlist) and this is a complete file, find the matching segment
1439 * by counting durations. */
1440 if (pls->finished && c->cur_timestamp != AV_NOPTS_VALUE) {
1441 find_timestamp_in_playlist(c, pls, c->cur_timestamp, &seq_no);
1445 if (!pls->finished) {
1446 if (!c->first_packet && /* we are doing a segment selection during playback */
1447 c->cur_seq_no >= pls->start_seq_no &&
1448 c->cur_seq_no < pls->start_seq_no + pls->n_segments)
1449 /* While spec 3.4.3 says that we cannot assume anything about the
1450 * content at the same sequence number on different playlists,
1451 * in practice this seems to work and doing it otherwise would
1452 * require us to download a segment to inspect its timestamps. */
1453 return c->cur_seq_no;
1455 /* If this is a live stream, start live_start_index segments from the
1457 if (c->live_start_index < 0)
1458 return pls->start_seq_no + FFMAX(pls->n_segments + c->live_start_index, 0);
1460 return pls->start_seq_no + FFMIN(c->live_start_index, pls->n_segments - 1);
1463 /* Otherwise just start on the first segment. */
1464 return pls->start_seq_no;
1467 static int save_avio_options(AVFormatContext *s)
1469 HLSContext *c = s->priv_data;
1470 const char *opts[] = { "headers", "user_agent", "user-agent", "cookies", NULL }, **opt = opts;
1475 if (av_opt_get(s->pb, *opt, AV_OPT_SEARCH_CHILDREN | AV_OPT_ALLOW_NULL, &buf) >= 0) {
1476 ret = av_dict_set(&c->avio_opts, *opt, buf,
1477 AV_DICT_DONT_STRDUP_VAL);
1487 static int hls_read_header(AVFormatContext *s)
1489 URLContext *u = (s->flags & AVFMT_FLAG_CUSTOM_IO) ? NULL : s->pb->opaque;
1490 HLSContext *c = s->priv_data;
1491 int ret = 0, i, j, stream_offset = 0;
1493 c->interrupt_callback = &s->interrupt_callback;
1494 c->strict_std_compliance = s->strict_std_compliance;
1496 c->first_packet = 1;
1497 c->first_timestamp = AV_NOPTS_VALUE;
1498 c->cur_timestamp = AV_NOPTS_VALUE;
1500 // if the URL context is good, read important options we must broker later
1501 if (u && u->prot->priv_data_class) {
1502 // get the previous user agent & set back to null if string size is zero
1503 update_options(&c->user_agent, "user-agent", u->priv_data);
1505 // get the previous cookies & set back to null if string size is zero
1506 update_options(&c->cookies, "cookies", u->priv_data);
1508 // get the previous headers & set back to null if string size is zero
1509 update_options(&c->headers, "headers", u->priv_data);
1512 if ((ret = parse_playlist(c, s->filename, NULL, s->pb)) < 0)
1515 if ((ret = save_avio_options(s)) < 0)
1518 /* Some HLS servers don't like being sent the range header */
1519 av_dict_set(&c->avio_opts, "seekable", "0", 0);
1521 if (c->n_variants == 0) {
1522 av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1526 /* If the playlist only contained playlists (Master Playlist),
1527 * parse each individual playlist. */
1528 if (c->n_playlists > 1 || c->playlists[0]->n_segments == 0) {
1529 for (i = 0; i < c->n_playlists; i++) {
1530 struct playlist *pls = c->playlists[i];
1531 if ((ret = parse_playlist(c, pls->url, pls, NULL)) < 0)
1536 if (c->variants[0]->playlists[0]->n_segments == 0) {
1537 av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1542 /* If this isn't a live stream, calculate the total duration of the
1544 if (c->variants[0]->playlists[0]->finished) {
1545 int64_t duration = 0;
1546 for (i = 0; i < c->variants[0]->playlists[0]->n_segments; i++)
1547 duration += c->variants[0]->playlists[0]->segments[i]->duration;
1548 s->duration = duration;
1551 /* Associate renditions with variants */
1552 for (i = 0; i < c->n_variants; i++) {
1553 struct variant *var = c->variants[i];
1555 if (var->audio_group[0])
1556 add_renditions_to_variant(c, var, AVMEDIA_TYPE_AUDIO, var->audio_group);
1557 if (var->video_group[0])
1558 add_renditions_to_variant(c, var, AVMEDIA_TYPE_VIDEO, var->video_group);
1559 if (var->subtitles_group[0])
1560 add_renditions_to_variant(c, var, AVMEDIA_TYPE_SUBTITLE, var->subtitles_group);
1563 /* Open the demuxer for each playlist */
1564 for (i = 0; i < c->n_playlists; i++) {
1565 struct playlist *pls = c->playlists[i];
1566 AVInputFormat *in_fmt = NULL;
1568 if (!(pls->ctx = avformat_alloc_context())) {
1569 ret = AVERROR(ENOMEM);
1573 if (pls->n_segments == 0)
1579 pls->cur_seq_no = select_cur_seq_no(c, pls);
1581 pls->read_buffer = av_malloc(INITIAL_BUFFER_SIZE);
1582 if (!pls->read_buffer){
1583 ret = AVERROR(ENOMEM);
1584 avformat_free_context(pls->ctx);
1588 ffio_init_context(&pls->pb, pls->read_buffer, INITIAL_BUFFER_SIZE, 0, pls,
1589 read_data, NULL, NULL);
1590 pls->pb.seekable = 0;
1591 ret = av_probe_input_buffer(&pls->pb, &in_fmt, pls->segments[0]->url,
1594 /* Free the ctx - it isn't initialized properly at this point,
1595 * so avformat_close_input shouldn't be called. If
1596 * avformat_open_input fails below, it frees and zeros the
1597 * context, so it doesn't need any special treatment like this. */
1598 av_log(s, AV_LOG_ERROR, "Error when loading first segment '%s'\n", pls->segments[0]->url);
1599 avformat_free_context(pls->ctx);
1603 pls->ctx->pb = &pls->pb;
1604 pls->stream_offset = stream_offset;
1606 if ((ret = ff_copy_whitelists(pls->ctx, s)) < 0)
1609 ret = avformat_open_input(&pls->ctx, pls->segments[0]->url, in_fmt, NULL);
1613 if (pls->id3_deferred_extra && pls->ctx->nb_streams == 1) {
1614 ff_id3v2_parse_apic(pls->ctx, &pls->id3_deferred_extra);
1615 avformat_queue_attached_pictures(pls->ctx);
1616 ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
1617 pls->id3_deferred_extra = NULL;
1620 pls->ctx->ctx_flags &= ~AVFMTCTX_NOHEADER;
1621 ret = avformat_find_stream_info(pls->ctx, NULL);
1625 if (pls->is_id3_timestamped == -1)
1626 av_log(s, AV_LOG_WARNING, "No expected HTTP requests have been made\n");
1628 /* Create new AVStreams for each stream in this playlist */
1629 for (j = 0; j < pls->ctx->nb_streams; j++) {
1630 AVStream *st = avformat_new_stream(s, NULL);
1631 AVStream *ist = pls->ctx->streams[j];
1633 ret = AVERROR(ENOMEM);
1638 avcodec_copy_context(st->codec, pls->ctx->streams[j]->codec);
1640 if (pls->is_id3_timestamped) /* custom timestamps via id3 */
1641 avpriv_set_pts_info(st, 33, 1, MPEG_TIME_BASE);
1643 avpriv_set_pts_info(st, ist->pts_wrap_bits, ist->time_base.num, ist->time_base.den);
1646 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_AUDIO);
1647 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_VIDEO);
1648 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_SUBTITLE);
1650 stream_offset += pls->ctx->nb_streams;
1653 /* Create a program for each variant */
1654 for (i = 0; i < c->n_variants; i++) {
1655 struct variant *v = c->variants[i];
1658 program = av_new_program(s, i);
1661 av_dict_set_int(&program->metadata, "variant_bitrate", v->bandwidth, 0);
1663 for (j = 0; j < v->n_playlists; j++) {
1664 struct playlist *pls = v->playlists[j];
1665 int is_shared = playlist_in_multiple_variants(c, pls);
1668 for (k = 0; k < pls->ctx->nb_streams; k++) {
1669 struct AVStream *st = s->streams[pls->stream_offset + k];
1671 ff_program_add_stream_index(s, i, pls->stream_offset + k);
1673 /* Set variant_bitrate for streams unique to this variant */
1674 if (!is_shared && v->bandwidth)
1675 av_dict_set_int(&st->metadata, "variant_bitrate", v->bandwidth, 0);
1682 free_playlist_list(c);
1683 free_variant_list(c);
1684 free_rendition_list(c);
1688 static int recheck_discard_flags(AVFormatContext *s, int first)
1690 HLSContext *c = s->priv_data;
1693 /* Check if any new streams are needed */
1694 for (i = 0; i < c->n_playlists; i++)
1695 c->playlists[i]->cur_needed = 0;
1697 for (i = 0; i < s->nb_streams; i++) {
1698 AVStream *st = s->streams[i];
1699 struct playlist *pls = c->playlists[s->streams[i]->id];
1700 if (st->discard < AVDISCARD_ALL)
1701 pls->cur_needed = 1;
1703 for (i = 0; i < c->n_playlists; i++) {
1704 struct playlist *pls = c->playlists[i];
1705 if (pls->cur_needed && !pls->needed) {
1708 pls->cur_seq_no = select_cur_seq_no(c, pls);
1709 pls->pb.eof_reached = 0;
1710 if (c->cur_timestamp != AV_NOPTS_VALUE) {
1712 pls->seek_timestamp = c->cur_timestamp;
1713 pls->seek_flags = AVSEEK_FLAG_ANY;
1714 pls->seek_stream_index = -1;
1716 av_log(s, AV_LOG_INFO, "Now receiving playlist %d, segment %d\n", i, pls->cur_seq_no);
1717 } else if (first && !pls->cur_needed && pls->needed) {
1719 ffurl_close(pls->input);
1723 av_log(s, AV_LOG_INFO, "No longer receiving playlist %d\n", i);
1729 static void fill_timing_for_id3_timestamped_stream(struct playlist *pls)
1731 if (pls->id3_offset >= 0) {
1732 pls->pkt.dts = pls->id3_mpegts_timestamp +
1733 av_rescale_q(pls->id3_offset,
1734 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1736 if (pls->pkt.duration)
1737 pls->id3_offset += pls->pkt.duration;
1739 pls->id3_offset = -1;
1741 /* there have been packets with unknown duration
1742 * since the last id3 tag, should not normally happen */
1743 pls->pkt.dts = AV_NOPTS_VALUE;
1746 if (pls->pkt.duration)
1747 pls->pkt.duration = av_rescale_q(pls->pkt.duration,
1748 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1751 pls->pkt.pts = AV_NOPTS_VALUE;
1754 static AVRational get_timebase(struct playlist *pls)
1756 if (pls->is_id3_timestamped)
1757 return MPEG_TIME_BASE_Q;
1759 return pls->ctx->streams[pls->pkt.stream_index]->time_base;
1762 static int compare_ts_with_wrapdetect(int64_t ts_a, struct playlist *pls_a,
1763 int64_t ts_b, struct playlist *pls_b)
1765 int64_t scaled_ts_a = av_rescale_q(ts_a, get_timebase(pls_a), MPEG_TIME_BASE_Q);
1766 int64_t scaled_ts_b = av_rescale_q(ts_b, get_timebase(pls_b), MPEG_TIME_BASE_Q);
1768 return av_compare_mod(scaled_ts_a, scaled_ts_b, 1LL << 33);
1771 static int hls_read_packet(AVFormatContext *s, AVPacket *pkt)
1773 HLSContext *c = s->priv_data;
1774 int ret, i, minplaylist = -1;
1776 recheck_discard_flags(s, c->first_packet);
1777 c->first_packet = 0;
1779 for (i = 0; i < c->n_playlists; i++) {
1780 struct playlist *pls = c->playlists[i];
1781 /* Make sure we've got one buffered packet from each open playlist
1783 if (pls->needed && !pls->pkt.data) {
1787 ret = av_read_frame(pls->ctx, &pls->pkt);
1789 if (!avio_feof(&pls->pb) && ret != AVERROR_EOF)
1791 reset_packet(&pls->pkt);
1794 /* stream_index check prevents matching picture attachments etc. */
1795 if (pls->is_id3_timestamped && pls->pkt.stream_index == 0) {
1796 /* audio elementary streams are id3 timestamped */
1797 fill_timing_for_id3_timestamped_stream(pls);
1800 if (c->first_timestamp == AV_NOPTS_VALUE &&
1801 pls->pkt.dts != AV_NOPTS_VALUE)
1802 c->first_timestamp = av_rescale_q(pls->pkt.dts,
1803 get_timebase(pls), AV_TIME_BASE_Q);
1806 if (pls->seek_timestamp == AV_NOPTS_VALUE)
1809 if (pls->seek_stream_index < 0 ||
1810 pls->seek_stream_index == pls->pkt.stream_index) {
1812 if (pls->pkt.dts == AV_NOPTS_VALUE) {
1813 pls->seek_timestamp = AV_NOPTS_VALUE;
1817 tb = get_timebase(pls);
1818 ts_diff = av_rescale_rnd(pls->pkt.dts, AV_TIME_BASE,
1819 tb.den, AV_ROUND_DOWN) -
1820 pls->seek_timestamp;
1821 if (ts_diff >= 0 && (pls->seek_flags & AVSEEK_FLAG_ANY ||
1822 pls->pkt.flags & AV_PKT_FLAG_KEY)) {
1823 pls->seek_timestamp = AV_NOPTS_VALUE;
1827 av_packet_unref(&pls->pkt);
1828 reset_packet(&pls->pkt);
1831 /* Check if this stream has the packet with the lowest dts */
1832 if (pls->pkt.data) {
1833 struct playlist *minpls = minplaylist < 0 ?
1834 NULL : c->playlists[minplaylist];
1835 if (minplaylist < 0) {
1838 int64_t dts = pls->pkt.dts;
1839 int64_t mindts = minpls->pkt.dts;
1841 if (dts == AV_NOPTS_VALUE ||
1842 (mindts != AV_NOPTS_VALUE && compare_ts_with_wrapdetect(dts, pls, mindts, minpls) < 0))
1848 /* If we got a packet, return it */
1849 if (minplaylist >= 0) {
1850 struct playlist *pls = c->playlists[minplaylist];
1852 pkt->stream_index += pls->stream_offset;
1853 reset_packet(&c->playlists[minplaylist]->pkt);
1855 if (pkt->dts != AV_NOPTS_VALUE)
1856 c->cur_timestamp = av_rescale_q(pkt->dts,
1857 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1865 static int hls_close(AVFormatContext *s)
1867 HLSContext *c = s->priv_data;
1869 free_playlist_list(c);
1870 free_variant_list(c);
1871 free_rendition_list(c);
1873 av_dict_free(&c->avio_opts);
1878 static int hls_read_seek(AVFormatContext *s, int stream_index,
1879 int64_t timestamp, int flags)
1881 HLSContext *c = s->priv_data;
1882 struct playlist *seek_pls = NULL;
1884 int64_t first_timestamp, seek_timestamp, duration;
1886 if ((flags & AVSEEK_FLAG_BYTE) ||
1887 !(c->variants[0]->playlists[0]->finished || c->variants[0]->playlists[0]->type == PLS_TYPE_EVENT))
1888 return AVERROR(ENOSYS);
1890 first_timestamp = c->first_timestamp == AV_NOPTS_VALUE ?
1891 0 : c->first_timestamp;
1893 seek_timestamp = av_rescale_rnd(timestamp, AV_TIME_BASE,
1894 s->streams[stream_index]->time_base.den,
1895 flags & AVSEEK_FLAG_BACKWARD ?
1896 AV_ROUND_DOWN : AV_ROUND_UP);
1898 duration = s->duration == AV_NOPTS_VALUE ?
1901 if (0 < duration && duration < seek_timestamp - first_timestamp)
1902 return AVERROR(EIO);
1904 /* find the playlist with the specified stream */
1905 for (i = 0; i < c->n_playlists; i++) {
1906 struct playlist *pls = c->playlists[i];
1907 if (stream_index >= pls->stream_offset &&
1908 stream_index - pls->stream_offset < pls->ctx->nb_streams) {
1913 /* check if the timestamp is valid for the playlist with the
1914 * specified stream index */
1915 if (!seek_pls || !find_timestamp_in_playlist(c, seek_pls, seek_timestamp, &seq_no))
1916 return AVERROR(EIO);
1918 /* set segment now so we do not need to search again below */
1919 seek_pls->cur_seq_no = seq_no;
1920 seek_pls->seek_stream_index = stream_index - seek_pls->stream_offset;
1922 for (i = 0; i < c->n_playlists; i++) {
1924 struct playlist *pls = c->playlists[i];
1926 ffurl_close(pls->input);
1929 av_packet_unref(&pls->pkt);
1930 reset_packet(&pls->pkt);
1931 pls->pb.eof_reached = 0;
1932 /* Clear any buffered data */
1933 pls->pb.buf_end = pls->pb.buf_ptr = pls->pb.buffer;
1934 /* Reset the pos, to let the mpegts demuxer know we've seeked. */
1936 /* Flush the packet queue of the subdemuxer. */
1937 ff_read_frame_flush(pls->ctx);
1939 pls->seek_timestamp = seek_timestamp;
1940 pls->seek_flags = flags;
1942 if (pls != seek_pls) {
1943 /* set closest segment seq_no for playlists not handled above */
1944 find_timestamp_in_playlist(c, pls, seek_timestamp, &pls->cur_seq_no);
1945 /* seek the playlist to the given position without taking
1946 * keyframes into account since this playlist does not have the
1947 * specified stream where we should look for the keyframes */
1948 pls->seek_stream_index = -1;
1949 pls->seek_flags |= AVSEEK_FLAG_ANY;
1953 c->cur_timestamp = seek_timestamp;
1958 static int hls_probe(AVProbeData *p)
1960 /* Require #EXTM3U at the start, and either one of the ones below
1961 * somewhere for a proper match. */
1962 if (strncmp(p->buf, "#EXTM3U", 7))
1964 if (strstr(p->buf, "#EXT-X-STREAM-INF:") ||
1965 strstr(p->buf, "#EXT-X-TARGETDURATION:") ||
1966 strstr(p->buf, "#EXT-X-MEDIA-SEQUENCE:"))
1967 return AVPROBE_SCORE_MAX;
1971 #define OFFSET(x) offsetof(HLSContext, x)
1972 #define FLAGS AV_OPT_FLAG_DECODING_PARAM
1973 static const AVOption hls_options[] = {
1974 {"live_start_index", "segment index to start live streams at (negative values are from the end)",
1975 OFFSET(live_start_index), AV_OPT_TYPE_INT, {.i64 = -3}, INT_MIN, INT_MAX, FLAGS},
1979 static const AVClass hls_class = {
1980 .class_name = "hls,applehttp",
1981 .item_name = av_default_item_name,
1982 .option = hls_options,
1983 .version = LIBAVUTIL_VERSION_INT,
1986 AVInputFormat ff_hls_demuxer = {
1987 .name = "hls,applehttp",
1988 .long_name = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
1989 .priv_class = &hls_class,
1990 .priv_data_size = sizeof(HLSContext),
1991 .read_probe = hls_probe,
1992 .read_header = hls_read_header,
1993 .read_packet = hls_read_packet,
1994 .read_close = hls_close,
1995 .read_seek = hls_read_seek,