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 {
183 AVFormatContext *avfmt;
185 struct variant **variants;
187 struct playlist **playlists;
189 struct rendition **renditions;
192 int live_start_index;
194 int64_t first_timestamp;
195 int64_t cur_timestamp;
196 AVIOInterruptCB *interrupt_callback;
197 char *user_agent; ///< holds HTTP user agent set as an AVOption to the HTTP protocol context
198 char *cookies; ///< holds HTTP cookie values set in either the initial response or as an AVOption to the HTTP protocol context
199 char *headers; ///< holds HTTP headers set as an AVOption to the HTTP protocol context
200 char *http_proxy; ///< holds the address of the HTTP proxy server
201 AVDictionary *avio_opts;
202 int strict_std_compliance;
205 static int read_chomp_line(AVIOContext *s, char *buf, int maxlen)
207 int len = ff_get_line(s, buf, maxlen);
208 while (len > 0 && av_isspace(buf[len - 1]))
213 static void free_segment_list(struct playlist *pls)
216 for (i = 0; i < pls->n_segments; i++) {
217 av_freep(&pls->segments[i]->key);
218 av_freep(&pls->segments[i]->url);
219 av_freep(&pls->segments[i]);
221 av_freep(&pls->segments);
225 static void free_init_section_list(struct playlist *pls)
228 for (i = 0; i < pls->n_init_sections; i++) {
229 av_freep(&pls->init_sections[i]->url);
230 av_freep(&pls->init_sections[i]);
232 av_freep(&pls->init_sections);
233 pls->n_init_sections = 0;
236 static void free_playlist_list(HLSContext *c)
239 for (i = 0; i < c->n_playlists; i++) {
240 struct playlist *pls = c->playlists[i];
241 free_segment_list(pls);
242 free_init_section_list(pls);
243 av_freep(&pls->renditions);
244 av_freep(&pls->id3_buf);
245 av_dict_free(&pls->id3_initial);
246 ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
247 av_freep(&pls->init_sec_buf);
248 av_packet_unref(&pls->pkt);
249 av_freep(&pls->pb.buffer);
251 ffurl_close(pls->input);
254 avformat_close_input(&pls->ctx);
258 av_freep(&c->playlists);
259 av_freep(&c->cookies);
260 av_freep(&c->user_agent);
261 av_freep(&c->headers);
262 av_freep(&c->http_proxy);
266 static void free_variant_list(HLSContext *c)
269 for (i = 0; i < c->n_variants; i++) {
270 struct variant *var = c->variants[i];
271 av_freep(&var->playlists);
274 av_freep(&c->variants);
278 static void free_rendition_list(HLSContext *c)
281 for (i = 0; i < c->n_renditions; i++)
282 av_freep(&c->renditions[i]);
283 av_freep(&c->renditions);
288 * Used to reset a statically allocated AVPacket to a clean slate,
289 * containing no data.
291 static void reset_packet(AVPacket *pkt)
297 static struct playlist *new_playlist(HLSContext *c, const char *url,
300 struct playlist *pls = av_mallocz(sizeof(struct playlist));
303 reset_packet(&pls->pkt);
304 ff_make_absolute_url(pls->url, sizeof(pls->url), base, url);
305 pls->seek_timestamp = AV_NOPTS_VALUE;
307 pls->is_id3_timestamped = -1;
308 pls->id3_mpegts_timestamp = AV_NOPTS_VALUE;
310 dynarray_add(&c->playlists, &c->n_playlists, pls);
314 struct variant_info {
316 /* variant group ids: */
317 char audio[MAX_FIELD_LEN];
318 char video[MAX_FIELD_LEN];
319 char subtitles[MAX_FIELD_LEN];
322 static struct variant *new_variant(HLSContext *c, struct variant_info *info,
323 const char *url, const char *base)
326 struct playlist *pls;
328 pls = new_playlist(c, url, base);
332 var = av_mallocz(sizeof(struct variant));
337 var->bandwidth = atoi(info->bandwidth);
338 strcpy(var->audio_group, info->audio);
339 strcpy(var->video_group, info->video);
340 strcpy(var->subtitles_group, info->subtitles);
343 dynarray_add(&c->variants, &c->n_variants, var);
344 dynarray_add(&var->playlists, &var->n_playlists, pls);
348 static void handle_variant_args(struct variant_info *info, const char *key,
349 int key_len, char **dest, int *dest_len)
351 if (!strncmp(key, "BANDWIDTH=", key_len)) {
352 *dest = info->bandwidth;
353 *dest_len = sizeof(info->bandwidth);
354 } else if (!strncmp(key, "AUDIO=", key_len)) {
356 *dest_len = sizeof(info->audio);
357 } else if (!strncmp(key, "VIDEO=", key_len)) {
359 *dest_len = sizeof(info->video);
360 } else if (!strncmp(key, "SUBTITLES=", key_len)) {
361 *dest = info->subtitles;
362 *dest_len = sizeof(info->subtitles);
367 char uri[MAX_URL_SIZE];
372 static void handle_key_args(struct key_info *info, const char *key,
373 int key_len, char **dest, int *dest_len)
375 if (!strncmp(key, "METHOD=", key_len)) {
376 *dest = info->method;
377 *dest_len = sizeof(info->method);
378 } else if (!strncmp(key, "URI=", key_len)) {
380 *dest_len = sizeof(info->uri);
381 } else if (!strncmp(key, "IV=", key_len)) {
383 *dest_len = sizeof(info->iv);
387 struct init_section_info {
388 char uri[MAX_URL_SIZE];
392 static struct segment *new_init_section(struct playlist *pls,
393 struct init_section_info *info,
394 const char *url_base)
398 char tmp_str[MAX_URL_SIZE];
403 sec = av_mallocz(sizeof(*sec));
407 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url_base, info->uri);
408 sec->url = av_strdup(tmp_str);
414 if (info->byterange[0]) {
415 sec->size = atoi(info->byterange);
416 ptr = strchr(info->byterange, '@');
418 sec->url_offset = atoi(ptr+1);
420 /* the entire file is the init section */
424 dynarray_add(&pls->init_sections, &pls->n_init_sections, sec);
429 static void handle_init_section_args(struct init_section_info *info, const char *key,
430 int key_len, char **dest, int *dest_len)
432 if (!strncmp(key, "URI=", key_len)) {
434 *dest_len = sizeof(info->uri);
435 } else if (!strncmp(key, "BYTERANGE=", key_len)) {
436 *dest = info->byterange;
437 *dest_len = sizeof(info->byterange);
441 struct rendition_info {
443 char uri[MAX_URL_SIZE];
444 char group_id[MAX_FIELD_LEN];
445 char language[MAX_FIELD_LEN];
446 char assoc_language[MAX_FIELD_LEN];
447 char name[MAX_FIELD_LEN];
450 char characteristics[MAX_CHARACTERISTICS_LEN];
453 static struct rendition *new_rendition(HLSContext *c, struct rendition_info *info,
454 const char *url_base)
456 struct rendition *rend;
457 enum AVMediaType type = AVMEDIA_TYPE_UNKNOWN;
458 char *characteristic;
462 if (!strcmp(info->type, "AUDIO"))
463 type = AVMEDIA_TYPE_AUDIO;
464 else if (!strcmp(info->type, "VIDEO"))
465 type = AVMEDIA_TYPE_VIDEO;
466 else if (!strcmp(info->type, "SUBTITLES"))
467 type = AVMEDIA_TYPE_SUBTITLE;
468 else if (!strcmp(info->type, "CLOSED-CAPTIONS"))
469 /* CLOSED-CAPTIONS is ignored since we do not support CEA-608 CC in
470 * AVC SEI RBSP anyway */
473 if (type == AVMEDIA_TYPE_UNKNOWN)
476 /* URI is mandatory for subtitles as per spec */
477 if (type == AVMEDIA_TYPE_SUBTITLE && !info->uri[0])
480 /* TODO: handle subtitles (each segment has to parsed separately) */
481 if (c->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL)
482 if (type == AVMEDIA_TYPE_SUBTITLE)
485 rend = av_mallocz(sizeof(struct rendition));
489 dynarray_add(&c->renditions, &c->n_renditions, rend);
492 strcpy(rend->group_id, info->group_id);
493 strcpy(rend->language, info->language);
494 strcpy(rend->name, info->name);
496 /* add the playlist if this is an external rendition */
498 rend->playlist = new_playlist(c, info->uri, url_base);
500 dynarray_add(&rend->playlist->renditions,
501 &rend->playlist->n_renditions, rend);
504 if (info->assoc_language[0]) {
505 int langlen = strlen(rend->language);
506 if (langlen < sizeof(rend->language) - 3) {
507 rend->language[langlen] = ',';
508 strncpy(rend->language + langlen + 1, info->assoc_language,
509 sizeof(rend->language) - langlen - 2);
513 if (!strcmp(info->defaultr, "YES"))
514 rend->disposition |= AV_DISPOSITION_DEFAULT;
515 if (!strcmp(info->forced, "YES"))
516 rend->disposition |= AV_DISPOSITION_FORCED;
518 chr_ptr = info->characteristics;
519 while ((characteristic = av_strtok(chr_ptr, ",", &saveptr))) {
520 if (!strcmp(characteristic, "public.accessibility.describes-music-and-sound"))
521 rend->disposition |= AV_DISPOSITION_HEARING_IMPAIRED;
522 else if (!strcmp(characteristic, "public.accessibility.describes-video"))
523 rend->disposition |= AV_DISPOSITION_VISUAL_IMPAIRED;
531 static void handle_rendition_args(struct rendition_info *info, const char *key,
532 int key_len, char **dest, int *dest_len)
534 if (!strncmp(key, "TYPE=", key_len)) {
536 *dest_len = sizeof(info->type);
537 } else if (!strncmp(key, "URI=", key_len)) {
539 *dest_len = sizeof(info->uri);
540 } else if (!strncmp(key, "GROUP-ID=", key_len)) {
541 *dest = info->group_id;
542 *dest_len = sizeof(info->group_id);
543 } else if (!strncmp(key, "LANGUAGE=", key_len)) {
544 *dest = info->language;
545 *dest_len = sizeof(info->language);
546 } else if (!strncmp(key, "ASSOC-LANGUAGE=", key_len)) {
547 *dest = info->assoc_language;
548 *dest_len = sizeof(info->assoc_language);
549 } else if (!strncmp(key, "NAME=", key_len)) {
551 *dest_len = sizeof(info->name);
552 } else if (!strncmp(key, "DEFAULT=", key_len)) {
553 *dest = info->defaultr;
554 *dest_len = sizeof(info->defaultr);
555 } else if (!strncmp(key, "FORCED=", key_len)) {
556 *dest = info->forced;
557 *dest_len = sizeof(info->forced);
558 } else if (!strncmp(key, "CHARACTERISTICS=", key_len)) {
559 *dest = info->characteristics;
560 *dest_len = sizeof(info->characteristics);
564 * - AUTOSELECT: client may autoselect based on e.g. system language
565 * - INSTREAM-ID: EIA-608 closed caption number ("CC1".."CC4")
569 /* used by parse_playlist to allocate a new variant+playlist when the
570 * playlist is detected to be a Media Playlist (not Master Playlist)
571 * and we have no parent Master Playlist (parsing of which would have
572 * allocated the variant and playlist already)
573 * *pls == NULL => Master Playlist or parentless Media Playlist
574 * *pls != NULL => parented Media Playlist, playlist+variant allocated */
575 static int ensure_playlist(HLSContext *c, struct playlist **pls, const char *url)
579 if (!new_variant(c, NULL, url, NULL))
580 return AVERROR(ENOMEM);
581 *pls = c->playlists[c->n_playlists - 1];
585 static int url_connect(struct playlist *pls, AVDictionary *opts, AVDictionary *opts2)
587 AVDictionary *tmp = NULL;
590 av_dict_copy(&tmp, opts, 0);
591 av_dict_copy(&tmp, opts2, 0);
593 if (pls->parent->protocol_whitelist) {
594 pls->input->protocol_whitelist = av_strdup(pls->parent->protocol_whitelist);
595 if (!pls->input->protocol_whitelist) {
597 return AVERROR(ENOMEM);
601 if ((ret = ffurl_connect(pls->input, &tmp)) < 0) {
602 ffurl_close(pls->input);
610 static void update_options(char **dest, const char *name, void *src)
613 av_opt_get(src, name, 0, (uint8_t**)dest);
614 if (*dest && !strlen(*dest))
618 static int open_url(HLSContext *c, URLContext **uc, const char *url, AVDictionary *opts)
620 AVDictionary *tmp = NULL;
622 const char *proto_name = avio_find_protocol_name(url);
625 return AVERROR_INVALIDDATA;
627 // only http(s) & file are allowed
628 if (!av_strstart(proto_name, "http", NULL) && !av_strstart(proto_name, "file", NULL))
629 return AVERROR_INVALIDDATA;
630 if (!strncmp(proto_name, url, strlen(proto_name)) && url[strlen(proto_name)] == ':')
632 else if (strcmp(proto_name, "file") || !strncmp(url, "file,", 5))
633 return AVERROR_INVALIDDATA;
635 av_dict_copy(&tmp, c->avio_opts, 0);
636 av_dict_copy(&tmp, opts, 0);
638 ret = ffurl_open_whitelist(uc, url, AVIO_FLAG_READ, c->interrupt_callback, &tmp, c->avfmt->protocol_whitelist);
640 // update cookies on http response with setcookies.
642 update_options(&c->cookies, "cookies", u->priv_data);
643 av_dict_set(&opts, "cookies", c->cookies, 0);
651 static int parse_playlist(HLSContext *c, const char *url,
652 struct playlist *pls, AVIOContext *in)
654 int ret = 0, is_segment = 0, is_variant = 0;
655 int64_t duration = 0;
656 enum KeyType key_type = KEY_NONE;
659 char key[MAX_URL_SIZE] = "";
660 char line[MAX_URL_SIZE];
663 int64_t seg_offset = 0;
664 int64_t seg_size = -1;
665 uint8_t *new_url = NULL;
666 struct variant_info variant_info;
667 char tmp_str[MAX_URL_SIZE];
668 struct segment *cur_init_section = NULL;
672 AVDictionary *opts = NULL;
674 /* Some HLS servers don't like being sent the range header */
675 av_dict_set(&opts, "seekable", "0", 0);
677 // broker prior HTTP options that should be consistent across requests
678 av_dict_set(&opts, "user-agent", c->user_agent, 0);
679 av_dict_set(&opts, "cookies", c->cookies, 0);
680 av_dict_set(&opts, "headers", c->headers, 0);
681 av_dict_set(&opts, "http_proxy", c->http_proxy, 0);
683 ret = ffio_open_whitelist(&in, url, AVIO_FLAG_READ,
684 c->interrupt_callback, &opts, c->avfmt->protocol_whitelist);
689 ret = open_in(c, &in, url);
696 if (av_opt_get(in, "location", AV_OPT_SEARCH_CHILDREN, &new_url) >= 0)
699 read_chomp_line(in, line, sizeof(line));
700 if (strcmp(line, "#EXTM3U")) {
701 ret = AVERROR_INVALIDDATA;
706 free_segment_list(pls);
708 pls->type = PLS_TYPE_UNSPECIFIED;
710 while (!avio_feof(in)) {
711 read_chomp_line(in, line, sizeof(line));
712 if (av_strstart(line, "#EXT-X-STREAM-INF:", &ptr)) {
714 memset(&variant_info, 0, sizeof(variant_info));
715 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_variant_args,
717 } else if (av_strstart(line, "#EXT-X-KEY:", &ptr)) {
718 struct key_info info = {{0}};
719 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_key_args,
723 if (!strcmp(info.method, "AES-128"))
724 key_type = KEY_AES_128;
725 if (!strcmp(info.method, "SAMPLE-AES"))
726 key_type = KEY_SAMPLE_AES;
727 if (!strncmp(info.iv, "0x", 2) || !strncmp(info.iv, "0X", 2)) {
728 ff_hex_to_data(iv, info.iv + 2);
731 av_strlcpy(key, info.uri, sizeof(key));
732 } else if (av_strstart(line, "#EXT-X-MEDIA:", &ptr)) {
733 struct rendition_info info = {{0}};
734 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_rendition_args,
736 new_rendition(c, &info, url);
737 } else if (av_strstart(line, "#EXT-X-TARGETDURATION:", &ptr)) {
738 ret = ensure_playlist(c, &pls, url);
741 pls->target_duration = atoi(ptr) * AV_TIME_BASE;
742 } else if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
743 ret = ensure_playlist(c, &pls, url);
746 pls->start_seq_no = atoi(ptr);
747 } else if (av_strstart(line, "#EXT-X-PLAYLIST-TYPE:", &ptr)) {
748 ret = ensure_playlist(c, &pls, url);
751 if (!strcmp(ptr, "EVENT"))
752 pls->type = PLS_TYPE_EVENT;
753 else if (!strcmp(ptr, "VOD"))
754 pls->type = PLS_TYPE_VOD;
755 } else if (av_strstart(line, "#EXT-X-MAP:", &ptr)) {
756 struct init_section_info info = {{0}};
757 ret = ensure_playlist(c, &pls, url);
760 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_init_section_args,
762 cur_init_section = new_init_section(pls, &info, url);
763 } else if (av_strstart(line, "#EXT-X-ENDLIST", &ptr)) {
766 } else if (av_strstart(line, "#EXTINF:", &ptr)) {
768 duration = atof(ptr) * AV_TIME_BASE;
769 } else if (av_strstart(line, "#EXT-X-BYTERANGE:", &ptr)) {
770 seg_size = atoi(ptr);
771 ptr = strchr(ptr, '@');
773 seg_offset = atoi(ptr+1);
774 } else if (av_strstart(line, "#", NULL)) {
776 } else if (line[0]) {
778 if (!new_variant(c, &variant_info, line, url)) {
779 ret = AVERROR(ENOMEM);
787 if (!new_variant(c, 0, url, NULL)) {
788 ret = AVERROR(ENOMEM);
791 pls = c->playlists[c->n_playlists - 1];
793 seg = av_malloc(sizeof(struct segment));
795 ret = AVERROR(ENOMEM);
798 seg->duration = duration;
799 seg->key_type = key_type;
801 memcpy(seg->iv, iv, sizeof(iv));
803 int seq = pls->start_seq_no + pls->n_segments;
804 memset(seg->iv, 0, sizeof(seg->iv));
805 AV_WB32(seg->iv + 12, seq);
808 if (key_type != KEY_NONE) {
809 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, key);
810 seg->key = av_strdup(tmp_str);
813 ret = AVERROR(ENOMEM);
820 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, line);
821 seg->url = av_strdup(tmp_str);
825 ret = AVERROR(ENOMEM);
829 dynarray_add(&pls->segments, &pls->n_segments, seg);
832 seg->size = seg_size;
834 seg->url_offset = seg_offset;
835 seg_offset += seg_size;
842 seg->init_section = cur_init_section;
847 pls->last_load_time = av_gettime_relative();
856 static struct segment *current_segment(struct playlist *pls)
858 return pls->segments[pls->cur_seq_no - pls->start_seq_no];
861 enum ReadFromURLMode {
866 /* read from URLContext, limiting read to current segment */
867 static int read_from_url(struct playlist *pls, struct segment *seg,
868 uint8_t *buf, int buf_size,
869 enum ReadFromURLMode mode)
873 /* limit read if the segment was only a part of a file */
875 buf_size = FFMIN(buf_size, seg->size - pls->cur_seg_offset);
877 if (mode == READ_COMPLETE)
878 ret = ffurl_read_complete(pls->input, buf, buf_size);
880 ret = ffurl_read(pls->input, buf, buf_size);
883 pls->cur_seg_offset += ret;
888 /* Parse the raw ID3 data and pass contents to caller */
889 static void parse_id3(AVFormatContext *s, AVIOContext *pb,
890 AVDictionary **metadata, int64_t *dts,
891 ID3v2ExtraMetaAPIC **apic, ID3v2ExtraMeta **extra_meta)
893 static const char id3_priv_owner_ts[] = "com.apple.streaming.transportStreamTimestamp";
894 ID3v2ExtraMeta *meta;
896 ff_id3v2_read_dict(pb, metadata, ID3v2_DEFAULT_MAGIC, extra_meta);
897 for (meta = *extra_meta; meta; meta = meta->next) {
898 if (!strcmp(meta->tag, "PRIV")) {
899 ID3v2ExtraMetaPRIV *priv = meta->data;
900 if (priv->datasize == 8 && !strcmp(priv->owner, id3_priv_owner_ts)) {
901 /* 33-bit MPEG timestamp */
902 int64_t ts = AV_RB64(priv->data);
903 av_log(s, AV_LOG_DEBUG, "HLS ID3 audio timestamp %"PRId64"\n", ts);
904 if ((ts & ~((1ULL << 33) - 1)) == 0)
907 av_log(s, AV_LOG_ERROR, "Invalid HLS ID3 audio timestamp %"PRId64"\n", ts);
909 } else if (!strcmp(meta->tag, "APIC") && apic)
914 /* Check if the ID3 metadata contents have changed */
915 static int id3_has_changed_values(struct playlist *pls, AVDictionary *metadata,
916 ID3v2ExtraMetaAPIC *apic)
918 AVDictionaryEntry *entry = NULL;
919 AVDictionaryEntry *oldentry;
920 /* check that no keys have changed values */
921 while ((entry = av_dict_get(metadata, "", entry, AV_DICT_IGNORE_SUFFIX))) {
922 oldentry = av_dict_get(pls->id3_initial, entry->key, NULL, AV_DICT_MATCH_CASE);
923 if (!oldentry || strcmp(oldentry->value, entry->value) != 0)
927 /* check if apic appeared */
928 if (apic && (pls->ctx->nb_streams != 2 || !pls->ctx->streams[1]->attached_pic.data))
932 int size = pls->ctx->streams[1]->attached_pic.size;
933 if (size != apic->buf->size - AV_INPUT_BUFFER_PADDING_SIZE)
936 if (memcmp(apic->buf->data, pls->ctx->streams[1]->attached_pic.data, size) != 0)
943 /* Parse ID3 data and handle the found data */
944 static void handle_id3(AVIOContext *pb, struct playlist *pls)
946 AVDictionary *metadata = NULL;
947 ID3v2ExtraMetaAPIC *apic = NULL;
948 ID3v2ExtraMeta *extra_meta = NULL;
949 int64_t timestamp = AV_NOPTS_VALUE;
951 parse_id3(pls->ctx, pb, &metadata, ×tamp, &apic, &extra_meta);
953 if (timestamp != AV_NOPTS_VALUE) {
954 pls->id3_mpegts_timestamp = timestamp;
958 if (!pls->id3_found) {
959 /* initial ID3 tags */
960 av_assert0(!pls->id3_deferred_extra);
963 /* get picture attachment and set text metadata */
964 if (pls->ctx->nb_streams)
965 ff_id3v2_parse_apic(pls->ctx, &extra_meta);
967 /* demuxer not yet opened, defer picture attachment */
968 pls->id3_deferred_extra = extra_meta;
970 av_dict_copy(&pls->ctx->metadata, metadata, 0);
971 pls->id3_initial = metadata;
974 if (!pls->id3_changed && id3_has_changed_values(pls, metadata, apic)) {
975 avpriv_report_missing_feature(pls->ctx, "Changing ID3 metadata in HLS audio elementary stream");
976 pls->id3_changed = 1;
978 av_dict_free(&metadata);
981 if (!pls->id3_deferred_extra)
982 ff_id3v2_free_extra_meta(&extra_meta);
985 /* Intercept and handle ID3 tags between URLContext and AVIOContext */
986 static void intercept_id3(struct playlist *pls, uint8_t *buf,
987 int buf_size, int *len)
989 /* intercept id3 tags, we do not want to pass them to the raw
990 * demuxer on all segment switches */
994 struct segment *seg = current_segment(pls);
996 /* gather all the id3 tags */
998 /* see if we can retrieve enough data for ID3 header */
999 if (*len < ID3v2_HEADER_SIZE && buf_size >= ID3v2_HEADER_SIZE) {
1000 bytes = read_from_url(pls, seg, buf + *len, ID3v2_HEADER_SIZE - *len, READ_COMPLETE);
1003 if (bytes == ID3v2_HEADER_SIZE - *len)
1004 /* no EOF yet, so fill the caller buffer again after
1005 * we have stripped the ID3 tags */
1010 } else if (*len <= 0) {
1017 if (*len < ID3v2_HEADER_SIZE)
1020 if (ff_id3v2_match(buf, ID3v2_DEFAULT_MAGIC)) {
1021 int64_t maxsize = seg->size >= 0 ? seg->size : 1024*1024;
1022 int taglen = ff_id3v2_tag_len(buf);
1023 int tag_got_bytes = FFMIN(taglen, *len);
1024 int remaining = taglen - tag_got_bytes;
1026 if (taglen > maxsize) {
1027 av_log(pls->ctx, AV_LOG_ERROR, "Too large HLS ID3 tag (%d > %"PRId64" bytes)\n",
1033 * Copy the id3 tag to our temporary id3 buffer.
1034 * We could read a small id3 tag directly without memcpy, but
1035 * we would still need to copy the large tags, and handling
1036 * both of those cases together with the possibility for multiple
1037 * tags would make the handling a bit complex.
1039 pls->id3_buf = av_fast_realloc(pls->id3_buf, &pls->id3_buf_size, id3_buf_pos + taglen);
1042 memcpy(pls->id3_buf + id3_buf_pos, buf, tag_got_bytes);
1043 id3_buf_pos += tag_got_bytes;
1045 /* strip the intercepted bytes */
1046 *len -= tag_got_bytes;
1047 memmove(buf, buf + tag_got_bytes, *len);
1048 av_log(pls->ctx, AV_LOG_DEBUG, "Stripped %d HLS ID3 bytes\n", tag_got_bytes);
1050 if (remaining > 0) {
1051 /* read the rest of the tag in */
1052 if (read_from_url(pls, seg, pls->id3_buf + id3_buf_pos, remaining, READ_COMPLETE) != remaining)
1054 id3_buf_pos += remaining;
1055 av_log(pls->ctx, AV_LOG_DEBUG, "Stripped additional %d HLS ID3 bytes\n", remaining);
1059 /* no more ID3 tags */
1064 /* re-fill buffer for the caller unless EOF */
1065 if (*len >= 0 && (fill_buf || *len == 0)) {
1066 bytes = read_from_url(pls, seg, buf + *len, buf_size - *len, READ_NORMAL);
1068 /* ignore error if we already had some data */
1076 /* Now parse all the ID3 tags */
1077 AVIOContext id3ioctx;
1078 ffio_init_context(&id3ioctx, pls->id3_buf, id3_buf_pos, 0, NULL, NULL, NULL, NULL);
1079 handle_id3(&id3ioctx, pls);
1082 if (pls->is_id3_timestamped == -1)
1083 pls->is_id3_timestamped = (pls->id3_mpegts_timestamp != AV_NOPTS_VALUE);
1086 static int open_input(HLSContext *c, struct playlist *pls, struct segment *seg)
1088 AVDictionary *opts = NULL;
1091 // broker prior HTTP options that should be consistent across requests
1092 av_dict_set(&opts, "user-agent", c->user_agent, 0);
1093 av_dict_set(&opts, "cookies", c->cookies, 0);
1094 av_dict_set(&opts, "headers", c->headers, 0);
1095 av_dict_set(&opts, "http_proxy", c->http_proxy, 0);
1096 av_dict_set(&opts, "seekable", "0", 0);
1098 if (seg->size >= 0) {
1099 /* try to restrict the HTTP request to the part we want
1100 * (if this is in fact a HTTP request) */
1101 av_dict_set_int(&opts, "offset", seg->url_offset, 0);
1102 av_dict_set_int(&opts, "end_offset", seg->url_offset + seg->size, 0);
1105 av_log(pls->parent, AV_LOG_VERBOSE, "HLS request for url '%s', offset %"PRId64", playlist %d\n",
1106 seg->url, seg->url_offset, pls->index);
1108 if (seg->key_type == KEY_NONE) {
1109 ret = open_url(pls->parent->priv_data, &pls->input, seg->url, opts);
1110 } else if (seg->key_type == KEY_AES_128) {
1111 // HLSContext *c = var->parent->priv_data;
1112 char iv[33], key[33], url[MAX_URL_SIZE];
1113 if (strcmp(seg->key, pls->key_url)) {
1115 if (open_url(pls->parent->priv_data, &uc, seg->key, opts) == 0) {
1116 if (ffurl_read_complete(uc, pls->key, sizeof(pls->key))
1117 != sizeof(pls->key)) {
1118 av_log(NULL, AV_LOG_ERROR, "Unable to read key file %s\n",
1123 av_log(NULL, AV_LOG_ERROR, "Unable to open key file %s\n",
1126 av_strlcpy(pls->key_url, seg->key, sizeof(pls->key_url));
1128 ff_data_to_hex(iv, seg->iv, sizeof(seg->iv), 0);
1129 ff_data_to_hex(key, pls->key, sizeof(pls->key), 0);
1130 iv[32] = key[32] = '\0';
1131 if (strstr(seg->url, "://"))
1132 snprintf(url, sizeof(url), "crypto+%s", seg->url);
1134 snprintf(url, sizeof(url), "crypto:%s", seg->url);
1136 if ((ret = ffurl_alloc(&pls->input, url, AVIO_FLAG_READ,
1137 &pls->parent->interrupt_callback)) < 0)
1139 av_opt_set(pls->input->priv_data, "key", key, 0);
1140 av_opt_set(pls->input->priv_data, "iv", iv, 0);
1142 if ((ret = url_connect(pls, c->avio_opts, opts)) < 0) {
1146 } else if (seg->key_type == KEY_SAMPLE_AES) {
1147 av_log(pls->parent, AV_LOG_ERROR,
1148 "SAMPLE-AES encryption is not supported yet\n");
1149 ret = AVERROR_PATCHWELCOME;
1152 ret = AVERROR(ENOSYS);
1154 /* Seek to the requested position. If this was a HTTP request, the offset
1155 * should already be where want it to, but this allows e.g. local testing
1156 * without a HTTP server. */
1157 if (ret == 0 && seg->key_type == KEY_NONE && seg->url_offset) {
1158 int seekret = ffurl_seek(pls->input, seg->url_offset, SEEK_SET);
1160 av_log(pls->parent, AV_LOG_ERROR, "Unable to seek to offset %"PRId64" of HLS segment '%s'\n", seg->url_offset, seg->url);
1162 ffurl_close(pls->input);
1168 av_dict_free(&opts);
1169 pls->cur_seg_offset = 0;
1173 static int update_init_section(struct playlist *pls, struct segment *seg)
1175 static const int max_init_section_size = 1024*1024;
1176 HLSContext *c = pls->parent->priv_data;
1181 if (seg->init_section == pls->cur_init_section)
1184 pls->cur_init_section = NULL;
1186 if (!seg->init_section)
1189 /* this will clobber playlist URLContext stuff, so this should be
1190 * called between segments only */
1191 ret = open_input(c, pls, seg->init_section);
1193 av_log(pls->parent, AV_LOG_WARNING,
1194 "Failed to open an initialization section in playlist %d\n",
1199 if (seg->init_section->size >= 0)
1200 sec_size = seg->init_section->size;
1201 else if ((urlsize = ffurl_size(pls->input)) >= 0)
1204 sec_size = max_init_section_size;
1206 av_log(pls->parent, AV_LOG_DEBUG,
1207 "Downloading an initialization section of size %"PRId64"\n",
1210 sec_size = FFMIN(sec_size, max_init_section_size);
1212 av_fast_malloc(&pls->init_sec_buf, &pls->init_sec_buf_size, sec_size);
1214 ret = read_from_url(pls, seg->init_section, pls->init_sec_buf,
1215 pls->init_sec_buf_size, READ_COMPLETE);
1216 ffurl_close(pls->input);
1222 pls->cur_init_section = seg->init_section;
1223 pls->init_sec_data_len = ret;
1224 pls->init_sec_buf_read_offset = 0;
1226 /* spec says audio elementary streams do not have media initialization
1227 * sections, so there should be no ID3 timestamps */
1228 pls->is_id3_timestamped = 0;
1233 static int64_t default_reload_interval(struct playlist *pls)
1235 return pls->n_segments > 0 ?
1236 pls->segments[pls->n_segments - 1]->duration :
1237 pls->target_duration;
1240 static int read_data(void *opaque, uint8_t *buf, int buf_size)
1242 struct playlist *v = opaque;
1243 HLSContext *c = v->parent->priv_data;
1245 int just_opened = 0;
1252 int64_t reload_interval;
1253 struct segment *seg;
1255 /* Check that the playlist is still needed before opening a new
1257 if (v->ctx && v->ctx->nb_streams &&
1258 v->parent->nb_streams >= v->stream_offset + v->ctx->nb_streams) {
1260 for (i = v->stream_offset; i < v->stream_offset + v->ctx->nb_streams;
1262 if (v->parent->streams[i]->discard < AVDISCARD_ALL)
1267 av_log(v->parent, AV_LOG_INFO, "No longer receiving playlist %d\n",
1272 /* If this is a live stream and the reload interval has elapsed since
1273 * the last playlist reload, reload the playlists now. */
1274 reload_interval = default_reload_interval(v);
1278 av_gettime_relative() - v->last_load_time >= reload_interval) {
1279 if ((ret = parse_playlist(c, v->url, v, NULL)) < 0) {
1280 av_log(v->parent, AV_LOG_WARNING, "Failed to reload playlist %d\n",
1284 /* If we need to reload the playlist again below (if
1285 * there's still no more segments), switch to a reload
1286 * interval of half the target duration. */
1287 reload_interval = v->target_duration / 2;
1289 if (v->cur_seq_no < v->start_seq_no) {
1290 av_log(NULL, AV_LOG_WARNING,
1291 "skipping %d segments ahead, expired from playlists\n",
1292 v->start_seq_no - v->cur_seq_no);
1293 v->cur_seq_no = v->start_seq_no;
1295 if (v->cur_seq_no >= v->start_seq_no + v->n_segments) {
1298 while (av_gettime_relative() - v->last_load_time < reload_interval) {
1299 if (ff_check_interrupt(c->interrupt_callback))
1300 return AVERROR_EXIT;
1301 av_usleep(100*1000);
1303 /* Enough time has elapsed since the last reload */
1307 seg = current_segment(v);
1309 /* load/update Media Initialization Section, if any */
1310 ret = update_init_section(v, seg);
1314 ret = open_input(c, v, seg);
1316 if (ff_check_interrupt(c->interrupt_callback))
1317 return AVERROR_EXIT;
1318 av_log(v->parent, AV_LOG_WARNING, "Failed to open segment of playlist %d\n",
1326 if (v->init_sec_buf_read_offset < v->init_sec_data_len) {
1327 /* Push init section out first before first actual segment */
1328 int copy_size = FFMIN(v->init_sec_data_len - v->init_sec_buf_read_offset, buf_size);
1329 memcpy(buf, v->init_sec_buf, copy_size);
1330 v->init_sec_buf_read_offset += copy_size;
1334 ret = read_from_url(v, current_segment(v), buf, buf_size, READ_NORMAL);
1336 if (just_opened && v->is_id3_timestamped != 0) {
1337 /* Intercept ID3 tags here, elementary audio streams are required
1338 * to convey timestamps using them in the beginning of each segment. */
1339 intercept_id3(v, buf, buf_size, &ret);
1344 ffurl_close(v->input);
1348 c->cur_seq_no = v->cur_seq_no;
1353 static int playlist_in_multiple_variants(HLSContext *c, struct playlist *pls)
1355 int variant_count = 0;
1358 for (i = 0; i < c->n_variants && variant_count < 2; i++) {
1359 struct variant *v = c->variants[i];
1361 for (j = 0; j < v->n_playlists; j++) {
1362 if (v->playlists[j] == pls) {
1369 return variant_count >= 2;
1372 static void add_renditions_to_variant(HLSContext *c, struct variant *var,
1373 enum AVMediaType type, const char *group_id)
1377 for (i = 0; i < c->n_renditions; i++) {
1378 struct rendition *rend = c->renditions[i];
1380 if (rend->type == type && !strcmp(rend->group_id, group_id)) {
1383 /* rendition is an external playlist
1384 * => add the playlist to the variant */
1385 dynarray_add(&var->playlists, &var->n_playlists, rend->playlist);
1387 /* rendition is part of the variant main Media Playlist
1388 * => add the rendition to the main Media Playlist */
1389 dynarray_add(&var->playlists[0]->renditions,
1390 &var->playlists[0]->n_renditions,
1396 static void add_metadata_from_renditions(AVFormatContext *s, struct playlist *pls,
1397 enum AVMediaType type)
1402 for (i = 0; i < pls->ctx->nb_streams; i++) {
1403 AVStream *st = s->streams[pls->stream_offset + i];
1405 if (st->codec->codec_type != type)
1408 for (; rend_idx < pls->n_renditions; rend_idx++) {
1409 struct rendition *rend = pls->renditions[rend_idx];
1411 if (rend->type != type)
1414 if (rend->language[0])
1415 av_dict_set(&st->metadata, "language", rend->language, 0);
1417 av_dict_set(&st->metadata, "comment", rend->name, 0);
1419 st->disposition |= rend->disposition;
1421 if (rend_idx >=pls->n_renditions)
1426 /* if timestamp was in valid range: returns 1 and sets seq_no
1427 * if not: returns 0 and sets seq_no to closest segment */
1428 static int find_timestamp_in_playlist(HLSContext *c, struct playlist *pls,
1429 int64_t timestamp, int *seq_no)
1432 int64_t pos = c->first_timestamp == AV_NOPTS_VALUE ?
1433 0 : c->first_timestamp;
1435 if (timestamp < pos) {
1436 *seq_no = pls->start_seq_no;
1440 for (i = 0; i < pls->n_segments; i++) {
1441 int64_t diff = pos + pls->segments[i]->duration - timestamp;
1443 *seq_no = pls->start_seq_no + i;
1446 pos += pls->segments[i]->duration;
1449 *seq_no = pls->start_seq_no + pls->n_segments - 1;
1454 static int select_cur_seq_no(HLSContext *c, struct playlist *pls)
1458 if (!pls->finished && !c->first_packet &&
1459 av_gettime_relative() - pls->last_load_time >= default_reload_interval(pls))
1460 /* reload the playlist since it was suspended */
1461 parse_playlist(c, pls->url, pls, NULL);
1463 /* If playback is already in progress (we are just selecting a new
1464 * playlist) and this is a complete file, find the matching segment
1465 * by counting durations. */
1466 if (pls->finished && c->cur_timestamp != AV_NOPTS_VALUE) {
1467 find_timestamp_in_playlist(c, pls, c->cur_timestamp, &seq_no);
1471 if (!pls->finished) {
1472 if (!c->first_packet && /* we are doing a segment selection during playback */
1473 c->cur_seq_no >= pls->start_seq_no &&
1474 c->cur_seq_no < pls->start_seq_no + pls->n_segments)
1475 /* While spec 3.4.3 says that we cannot assume anything about the
1476 * content at the same sequence number on different playlists,
1477 * in practice this seems to work and doing it otherwise would
1478 * require us to download a segment to inspect its timestamps. */
1479 return c->cur_seq_no;
1481 /* If this is a live stream, start live_start_index segments from the
1483 if (c->live_start_index < 0)
1484 return pls->start_seq_no + FFMAX(pls->n_segments + c->live_start_index, 0);
1486 return pls->start_seq_no + FFMIN(c->live_start_index, pls->n_segments - 1);
1489 /* Otherwise just start on the first segment. */
1490 return pls->start_seq_no;
1493 static int save_avio_options(AVFormatContext *s)
1495 HLSContext *c = s->priv_data;
1496 const char *opts[] = {
1497 "headers", "http_proxy", "user_agent", "user-agent", "cookies", NULL };
1498 const char **opt = opts;
1503 if (av_opt_get(s->pb, *opt, AV_OPT_SEARCH_CHILDREN | AV_OPT_ALLOW_NULL, &buf) >= 0) {
1504 ret = av_dict_set(&c->avio_opts, *opt, buf,
1505 AV_DICT_DONT_STRDUP_VAL);
1515 static int hls_read_header(AVFormatContext *s)
1517 URLContext *u = (s->flags & AVFMT_FLAG_CUSTOM_IO) ? NULL : s->pb->opaque;
1518 HLSContext *c = s->priv_data;
1519 int ret = 0, i, j, stream_offset = 0;
1522 c->interrupt_callback = &s->interrupt_callback;
1523 c->strict_std_compliance = s->strict_std_compliance;
1525 c->first_packet = 1;
1526 c->first_timestamp = AV_NOPTS_VALUE;
1527 c->cur_timestamp = AV_NOPTS_VALUE;
1529 // if the URL context is good, read important options we must broker later
1530 if (u && u->prot->priv_data_class) {
1531 // get the previous user agent & set back to null if string size is zero
1532 update_options(&c->user_agent, "user-agent", u->priv_data);
1534 // get the previous cookies & set back to null if string size is zero
1535 update_options(&c->cookies, "cookies", u->priv_data);
1537 // get the previous headers & set back to null if string size is zero
1538 update_options(&c->headers, "headers", u->priv_data);
1540 // get the previous http proxt & set back to null if string size is zero
1541 update_options(&c->http_proxy, "http_proxy", u->priv_data);
1544 if ((ret = parse_playlist(c, s->filename, NULL, s->pb)) < 0)
1547 if ((ret = save_avio_options(s)) < 0)
1550 /* Some HLS servers don't like being sent the range header */
1551 av_dict_set(&c->avio_opts, "seekable", "0", 0);
1553 if (c->n_variants == 0) {
1554 av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1558 /* If the playlist only contained playlists (Master Playlist),
1559 * parse each individual playlist. */
1560 if (c->n_playlists > 1 || c->playlists[0]->n_segments == 0) {
1561 for (i = 0; i < c->n_playlists; i++) {
1562 struct playlist *pls = c->playlists[i];
1563 if ((ret = parse_playlist(c, pls->url, pls, NULL)) < 0)
1568 if (c->variants[0]->playlists[0]->n_segments == 0) {
1569 av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1574 /* If this isn't a live stream, calculate the total duration of the
1576 if (c->variants[0]->playlists[0]->finished) {
1577 int64_t duration = 0;
1578 for (i = 0; i < c->variants[0]->playlists[0]->n_segments; i++)
1579 duration += c->variants[0]->playlists[0]->segments[i]->duration;
1580 s->duration = duration;
1583 /* Associate renditions with variants */
1584 for (i = 0; i < c->n_variants; i++) {
1585 struct variant *var = c->variants[i];
1587 if (var->audio_group[0])
1588 add_renditions_to_variant(c, var, AVMEDIA_TYPE_AUDIO, var->audio_group);
1589 if (var->video_group[0])
1590 add_renditions_to_variant(c, var, AVMEDIA_TYPE_VIDEO, var->video_group);
1591 if (var->subtitles_group[0])
1592 add_renditions_to_variant(c, var, AVMEDIA_TYPE_SUBTITLE, var->subtitles_group);
1595 /* Open the demuxer for each playlist */
1596 for (i = 0; i < c->n_playlists; i++) {
1597 struct playlist *pls = c->playlists[i];
1598 AVInputFormat *in_fmt = NULL;
1600 if (!(pls->ctx = avformat_alloc_context())) {
1601 ret = AVERROR(ENOMEM);
1605 if (pls->n_segments == 0)
1611 pls->cur_seq_no = select_cur_seq_no(c, pls);
1613 pls->read_buffer = av_malloc(INITIAL_BUFFER_SIZE);
1614 if (!pls->read_buffer){
1615 ret = AVERROR(ENOMEM);
1616 avformat_free_context(pls->ctx);
1620 ffio_init_context(&pls->pb, pls->read_buffer, INITIAL_BUFFER_SIZE, 0, pls,
1621 read_data, NULL, NULL);
1622 pls->pb.seekable = 0;
1623 ret = av_probe_input_buffer(&pls->pb, &in_fmt, pls->segments[0]->url,
1626 /* Free the ctx - it isn't initialized properly at this point,
1627 * so avformat_close_input shouldn't be called. If
1628 * avformat_open_input fails below, it frees and zeros the
1629 * context, so it doesn't need any special treatment like this. */
1630 av_log(s, AV_LOG_ERROR, "Error when loading first segment '%s'\n", pls->segments[0]->url);
1631 avformat_free_context(pls->ctx);
1635 pls->ctx->pb = &pls->pb;
1636 pls->stream_offset = stream_offset;
1638 if ((ret = ff_copy_whitelists(pls->ctx, s)) < 0)
1641 ret = avformat_open_input(&pls->ctx, pls->segments[0]->url, in_fmt, NULL);
1645 if (pls->id3_deferred_extra && pls->ctx->nb_streams == 1) {
1646 ff_id3v2_parse_apic(pls->ctx, &pls->id3_deferred_extra);
1647 avformat_queue_attached_pictures(pls->ctx);
1648 ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
1649 pls->id3_deferred_extra = NULL;
1652 pls->ctx->ctx_flags &= ~AVFMTCTX_NOHEADER;
1653 ret = avformat_find_stream_info(pls->ctx, NULL);
1657 if (pls->is_id3_timestamped == -1)
1658 av_log(s, AV_LOG_WARNING, "No expected HTTP requests have been made\n");
1660 /* Create new AVStreams for each stream in this playlist */
1661 for (j = 0; j < pls->ctx->nb_streams; j++) {
1662 AVStream *st = avformat_new_stream(s, NULL);
1663 AVStream *ist = pls->ctx->streams[j];
1665 ret = AVERROR(ENOMEM);
1670 avcodec_copy_context(st->codec, pls->ctx->streams[j]->codec);
1672 if (pls->is_id3_timestamped) /* custom timestamps via id3 */
1673 avpriv_set_pts_info(st, 33, 1, MPEG_TIME_BASE);
1675 avpriv_set_pts_info(st, ist->pts_wrap_bits, ist->time_base.num, ist->time_base.den);
1678 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_AUDIO);
1679 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_VIDEO);
1680 add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_SUBTITLE);
1682 stream_offset += pls->ctx->nb_streams;
1685 /* Create a program for each variant */
1686 for (i = 0; i < c->n_variants; i++) {
1687 struct variant *v = c->variants[i];
1690 program = av_new_program(s, i);
1693 av_dict_set_int(&program->metadata, "variant_bitrate", v->bandwidth, 0);
1695 for (j = 0; j < v->n_playlists; j++) {
1696 struct playlist *pls = v->playlists[j];
1697 int is_shared = playlist_in_multiple_variants(c, pls);
1700 for (k = 0; k < pls->ctx->nb_streams; k++) {
1701 struct AVStream *st = s->streams[pls->stream_offset + k];
1703 av_program_add_stream_index(s, i, pls->stream_offset + k);
1705 /* Set variant_bitrate for streams unique to this variant */
1706 if (!is_shared && v->bandwidth)
1707 av_dict_set_int(&st->metadata, "variant_bitrate", v->bandwidth, 0);
1714 free_playlist_list(c);
1715 free_variant_list(c);
1716 free_rendition_list(c);
1720 static int recheck_discard_flags(AVFormatContext *s, int first)
1722 HLSContext *c = s->priv_data;
1725 /* Check if any new streams are needed */
1726 for (i = 0; i < c->n_playlists; i++)
1727 c->playlists[i]->cur_needed = 0;
1729 for (i = 0; i < s->nb_streams; i++) {
1730 AVStream *st = s->streams[i];
1731 struct playlist *pls = c->playlists[s->streams[i]->id];
1732 if (st->discard < AVDISCARD_ALL)
1733 pls->cur_needed = 1;
1735 for (i = 0; i < c->n_playlists; i++) {
1736 struct playlist *pls = c->playlists[i];
1737 if (pls->cur_needed && !pls->needed) {
1740 pls->cur_seq_no = select_cur_seq_no(c, pls);
1741 pls->pb.eof_reached = 0;
1742 if (c->cur_timestamp != AV_NOPTS_VALUE) {
1744 pls->seek_timestamp = c->cur_timestamp;
1745 pls->seek_flags = AVSEEK_FLAG_ANY;
1746 pls->seek_stream_index = -1;
1748 av_log(s, AV_LOG_INFO, "Now receiving playlist %d, segment %d\n", i, pls->cur_seq_no);
1749 } else if (first && !pls->cur_needed && pls->needed) {
1751 ffurl_close(pls->input);
1755 av_log(s, AV_LOG_INFO, "No longer receiving playlist %d\n", i);
1761 static void fill_timing_for_id3_timestamped_stream(struct playlist *pls)
1763 if (pls->id3_offset >= 0) {
1764 pls->pkt.dts = pls->id3_mpegts_timestamp +
1765 av_rescale_q(pls->id3_offset,
1766 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1768 if (pls->pkt.duration)
1769 pls->id3_offset += pls->pkt.duration;
1771 pls->id3_offset = -1;
1773 /* there have been packets with unknown duration
1774 * since the last id3 tag, should not normally happen */
1775 pls->pkt.dts = AV_NOPTS_VALUE;
1778 if (pls->pkt.duration)
1779 pls->pkt.duration = av_rescale_q(pls->pkt.duration,
1780 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1783 pls->pkt.pts = AV_NOPTS_VALUE;
1786 static AVRational get_timebase(struct playlist *pls)
1788 if (pls->is_id3_timestamped)
1789 return MPEG_TIME_BASE_Q;
1791 return pls->ctx->streams[pls->pkt.stream_index]->time_base;
1794 static int compare_ts_with_wrapdetect(int64_t ts_a, struct playlist *pls_a,
1795 int64_t ts_b, struct playlist *pls_b)
1797 int64_t scaled_ts_a = av_rescale_q(ts_a, get_timebase(pls_a), MPEG_TIME_BASE_Q);
1798 int64_t scaled_ts_b = av_rescale_q(ts_b, get_timebase(pls_b), MPEG_TIME_BASE_Q);
1800 return av_compare_mod(scaled_ts_a, scaled_ts_b, 1LL << 33);
1803 static int hls_read_packet(AVFormatContext *s, AVPacket *pkt)
1805 HLSContext *c = s->priv_data;
1806 int ret, i, minplaylist = -1;
1808 recheck_discard_flags(s, c->first_packet);
1809 c->first_packet = 0;
1811 for (i = 0; i < c->n_playlists; i++) {
1812 struct playlist *pls = c->playlists[i];
1813 /* Make sure we've got one buffered packet from each open playlist
1815 if (pls->needed && !pls->pkt.data) {
1819 ret = av_read_frame(pls->ctx, &pls->pkt);
1821 if (!avio_feof(&pls->pb) && ret != AVERROR_EOF)
1823 reset_packet(&pls->pkt);
1826 /* stream_index check prevents matching picture attachments etc. */
1827 if (pls->is_id3_timestamped && pls->pkt.stream_index == 0) {
1828 /* audio elementary streams are id3 timestamped */
1829 fill_timing_for_id3_timestamped_stream(pls);
1832 if (c->first_timestamp == AV_NOPTS_VALUE &&
1833 pls->pkt.dts != AV_NOPTS_VALUE)
1834 c->first_timestamp = av_rescale_q(pls->pkt.dts,
1835 get_timebase(pls), AV_TIME_BASE_Q);
1838 if (pls->seek_timestamp == AV_NOPTS_VALUE)
1841 if (pls->seek_stream_index < 0 ||
1842 pls->seek_stream_index == pls->pkt.stream_index) {
1844 if (pls->pkt.dts == AV_NOPTS_VALUE) {
1845 pls->seek_timestamp = AV_NOPTS_VALUE;
1849 tb = get_timebase(pls);
1850 ts_diff = av_rescale_rnd(pls->pkt.dts, AV_TIME_BASE,
1851 tb.den, AV_ROUND_DOWN) -
1852 pls->seek_timestamp;
1853 if (ts_diff >= 0 && (pls->seek_flags & AVSEEK_FLAG_ANY ||
1854 pls->pkt.flags & AV_PKT_FLAG_KEY)) {
1855 pls->seek_timestamp = AV_NOPTS_VALUE;
1859 av_packet_unref(&pls->pkt);
1860 reset_packet(&pls->pkt);
1863 /* Check if this stream has the packet with the lowest dts */
1864 if (pls->pkt.data) {
1865 struct playlist *minpls = minplaylist < 0 ?
1866 NULL : c->playlists[minplaylist];
1867 if (minplaylist < 0) {
1870 int64_t dts = pls->pkt.dts;
1871 int64_t mindts = minpls->pkt.dts;
1873 if (dts == AV_NOPTS_VALUE ||
1874 (mindts != AV_NOPTS_VALUE && compare_ts_with_wrapdetect(dts, pls, mindts, minpls) < 0))
1880 /* If we got a packet, return it */
1881 if (minplaylist >= 0) {
1882 struct playlist *pls = c->playlists[minplaylist];
1884 pkt->stream_index += pls->stream_offset;
1885 reset_packet(&c->playlists[minplaylist]->pkt);
1887 if (pkt->dts != AV_NOPTS_VALUE)
1888 c->cur_timestamp = av_rescale_q(pkt->dts,
1889 pls->ctx->streams[pls->pkt.stream_index]->time_base,
1897 static int hls_close(AVFormatContext *s)
1899 HLSContext *c = s->priv_data;
1901 free_playlist_list(c);
1902 free_variant_list(c);
1903 free_rendition_list(c);
1905 av_dict_free(&c->avio_opts);
1910 static int hls_read_seek(AVFormatContext *s, int stream_index,
1911 int64_t timestamp, int flags)
1913 HLSContext *c = s->priv_data;
1914 struct playlist *seek_pls = NULL;
1916 int64_t first_timestamp, seek_timestamp, duration;
1918 if ((flags & AVSEEK_FLAG_BYTE) ||
1919 !(c->variants[0]->playlists[0]->finished || c->variants[0]->playlists[0]->type == PLS_TYPE_EVENT))
1920 return AVERROR(ENOSYS);
1922 first_timestamp = c->first_timestamp == AV_NOPTS_VALUE ?
1923 0 : c->first_timestamp;
1925 seek_timestamp = av_rescale_rnd(timestamp, AV_TIME_BASE,
1926 s->streams[stream_index]->time_base.den,
1927 flags & AVSEEK_FLAG_BACKWARD ?
1928 AV_ROUND_DOWN : AV_ROUND_UP);
1930 duration = s->duration == AV_NOPTS_VALUE ?
1933 if (0 < duration && duration < seek_timestamp - first_timestamp)
1934 return AVERROR(EIO);
1936 /* find the playlist with the specified stream */
1937 for (i = 0; i < c->n_playlists; i++) {
1938 struct playlist *pls = c->playlists[i];
1939 if (stream_index >= pls->stream_offset &&
1940 stream_index - pls->stream_offset < pls->ctx->nb_streams) {
1945 /* check if the timestamp is valid for the playlist with the
1946 * specified stream index */
1947 if (!seek_pls || !find_timestamp_in_playlist(c, seek_pls, seek_timestamp, &seq_no))
1948 return AVERROR(EIO);
1950 /* set segment now so we do not need to search again below */
1951 seek_pls->cur_seq_no = seq_no;
1952 seek_pls->seek_stream_index = stream_index - seek_pls->stream_offset;
1954 for (i = 0; i < c->n_playlists; i++) {
1956 struct playlist *pls = c->playlists[i];
1958 ffurl_close(pls->input);
1961 av_packet_unref(&pls->pkt);
1962 reset_packet(&pls->pkt);
1963 pls->pb.eof_reached = 0;
1964 /* Clear any buffered data */
1965 pls->pb.buf_end = pls->pb.buf_ptr = pls->pb.buffer;
1966 /* Reset the pos, to let the mpegts demuxer know we've seeked. */
1968 /* Flush the packet queue of the subdemuxer. */
1969 ff_read_frame_flush(pls->ctx);
1971 pls->seek_timestamp = seek_timestamp;
1972 pls->seek_flags = flags;
1974 if (pls != seek_pls) {
1975 /* set closest segment seq_no for playlists not handled above */
1976 find_timestamp_in_playlist(c, pls, seek_timestamp, &pls->cur_seq_no);
1977 /* seek the playlist to the given position without taking
1978 * keyframes into account since this playlist does not have the
1979 * specified stream where we should look for the keyframes */
1980 pls->seek_stream_index = -1;
1981 pls->seek_flags |= AVSEEK_FLAG_ANY;
1985 c->cur_timestamp = seek_timestamp;
1990 static int hls_probe(AVProbeData *p)
1992 /* Require #EXTM3U at the start, and either one of the ones below
1993 * somewhere for a proper match. */
1994 if (strncmp(p->buf, "#EXTM3U", 7))
1997 if (strstr(p->buf, "#EXT-X-STREAM-INF:") ||
1998 strstr(p->buf, "#EXT-X-TARGETDURATION:") ||
1999 strstr(p->buf, "#EXT-X-MEDIA-SEQUENCE:"))
2000 return AVPROBE_SCORE_MAX;
2004 #define OFFSET(x) offsetof(HLSContext, x)
2005 #define FLAGS AV_OPT_FLAG_DECODING_PARAM
2006 static const AVOption hls_options[] = {
2007 {"live_start_index", "segment index to start live streams at (negative values are from the end)",
2008 OFFSET(live_start_index), AV_OPT_TYPE_INT, {.i64 = -3}, INT_MIN, INT_MAX, FLAGS},
2012 static const AVClass hls_class = {
2013 .class_name = "hls,applehttp",
2014 .item_name = av_default_item_name,
2015 .option = hls_options,
2016 .version = LIBAVUTIL_VERSION_INT,
2019 AVInputFormat ff_hls_demuxer = {
2020 .name = "hls,applehttp",
2021 .long_name = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
2022 .priv_class = &hls_class,
2023 .priv_data_size = sizeof(HLSContext),
2024 .read_probe = hls_probe,
2025 .read_header = hls_read_header,
2026 .read_packet = hls_read_packet,
2027 .read_close = hls_close,
2028 .read_seek = hls_read_seek,