]> git.sesse.net Git - ffmpeg/blob - libavformat/hls.c
avformat/id3v2: Remove unnecessary indirection
[ffmpeg] / libavformat / hls.c
1 /*
2  * Apple HTTP Live Streaming demuxer
3  * Copyright (c) 2010 Martin Storsjo
4  * Copyright (c) 2013 Anssi Hannula
5  *
6  * This file is part of FFmpeg.
7  *
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.
12  *
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.
17  *
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
21  */
22
23 /**
24  * @file
25  * Apple HTTP Live Streaming demuxer
26  * http://tools.ietf.org/html/draft-pantos-http-live-streaming
27  */
28
29 #include "libavformat/http.h"
30 #include "libavutil/avstring.h"
31 #include "libavutil/avassert.h"
32 #include "libavutil/intreadwrite.h"
33 #include "libavutil/mathematics.h"
34 #include "libavutil/opt.h"
35 #include "libavutil/dict.h"
36 #include "libavutil/time.h"
37 #include "avformat.h"
38 #include "internal.h"
39 #include "avio_internal.h"
40 #include "id3v2.h"
41
42 #define INITIAL_BUFFER_SIZE 32768
43
44 #define MAX_FIELD_LEN 64
45 #define MAX_CHARACTERISTICS_LEN 512
46
47 #define MPEG_TIME_BASE 90000
48 #define MPEG_TIME_BASE_Q (AVRational){1, MPEG_TIME_BASE}
49
50 /*
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
56  * playlists.
57  *
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.
60  */
61
62 enum KeyType {
63     KEY_NONE,
64     KEY_AES_128,
65     KEY_SAMPLE_AES
66 };
67
68 struct segment {
69     int64_t duration;
70     int64_t url_offset;
71     int64_t size;
72     char *url;
73     char *key;
74     enum KeyType key_type;
75     uint8_t iv[16];
76     /* associated Media Initialization Section, treated as a segment */
77     struct segment *init_section;
78 };
79
80 struct rendition;
81
82 enum PlaylistType {
83     PLS_TYPE_UNSPECIFIED,
84     PLS_TYPE_EVENT,
85     PLS_TYPE_VOD
86 };
87
88 /*
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.
92  */
93 struct playlist {
94     char url[MAX_URL_SIZE];
95     AVIOContext pb;
96     uint8_t* read_buffer;
97     AVIOContext *input;
98     int input_read_done;
99     AVIOContext *input_next;
100     int input_next_requested;
101     AVFormatContext *parent;
102     int index;
103     AVFormatContext *ctx;
104     AVPacket pkt;
105     int has_noheader_flag;
106
107     /* main demuxer streams associated with this playlist
108      * indexed by the subdemuxer stream indexes */
109     AVStream **main_streams;
110     int n_main_streams;
111
112     int finished;
113     enum PlaylistType type;
114     int64_t target_duration;
115     int start_seq_no;
116     int n_segments;
117     struct segment **segments;
118     int needed;
119     int broken;
120     int cur_seq_no;
121     int last_seq_no;
122     int m3u8_hold_counters;
123     int64_t cur_seg_offset;
124     int64_t last_load_time;
125
126     /* Currently active Media Initialization Section */
127     struct segment *cur_init_section;
128     uint8_t *init_sec_buf;
129     unsigned int init_sec_buf_size;
130     unsigned int init_sec_data_len;
131     unsigned int init_sec_buf_read_offset;
132
133     char key_url[MAX_URL_SIZE];
134     uint8_t key[16];
135
136     /* ID3 timestamp handling (elementary audio streams have ID3 timestamps
137      * (and possibly other ID3 tags) in the beginning of each segment) */
138     int is_id3_timestamped; /* -1: not yet known */
139     int64_t id3_mpegts_timestamp; /* in mpegts tb */
140     int64_t id3_offset; /* in stream original tb */
141     uint8_t* id3_buf; /* temp buffer for id3 parsing */
142     unsigned int id3_buf_size;
143     AVDictionary *id3_initial; /* data from first id3 tag */
144     int id3_found; /* ID3 tag found at some point */
145     int id3_changed; /* ID3 tag data has changed at some point */
146     ID3v2ExtraMeta *id3_deferred_extra; /* stored here until subdemuxer is opened */
147
148     int64_t seek_timestamp;
149     int seek_flags;
150     int seek_stream_index; /* into subdemuxer stream array */
151
152     /* Renditions associated with this playlist, if any.
153      * Alternative rendition playlists have a single rendition associated
154      * with them, and variant main Media Playlists may have
155      * multiple (playlist-less) renditions associated with them. */
156     int n_renditions;
157     struct rendition **renditions;
158
159     /* Media Initialization Sections (EXT-X-MAP) associated with this
160      * playlist, if any. */
161     int n_init_sections;
162     struct segment **init_sections;
163 };
164
165 /*
166  * Renditions are e.g. alternative subtitle or audio streams.
167  * The rendition may either be an external playlist or it may be
168  * contained in the main Media Playlist of the variant (in which case
169  * playlist is NULL).
170  */
171 struct rendition {
172     enum AVMediaType type;
173     struct playlist *playlist;
174     char group_id[MAX_FIELD_LEN];
175     char language[MAX_FIELD_LEN];
176     char name[MAX_FIELD_LEN];
177     int disposition;
178 };
179
180 struct variant {
181     int bandwidth;
182
183     /* every variant contains at least the main Media Playlist in index 0 */
184     int n_playlists;
185     struct playlist **playlists;
186
187     char audio_group[MAX_FIELD_LEN];
188     char video_group[MAX_FIELD_LEN];
189     char subtitles_group[MAX_FIELD_LEN];
190 };
191
192 typedef struct HLSContext {
193     AVClass *class;
194     AVFormatContext *ctx;
195     int n_variants;
196     struct variant **variants;
197     int n_playlists;
198     struct playlist **playlists;
199     int n_renditions;
200     struct rendition **renditions;
201
202     int cur_seq_no;
203     int m3u8_hold_counters;
204     int live_start_index;
205     int first_packet;
206     int64_t first_timestamp;
207     int64_t cur_timestamp;
208     AVIOInterruptCB *interrupt_callback;
209     AVDictionary *avio_opts;
210     char *allowed_extensions;
211     int max_reload;
212     int http_persistent;
213     int http_multiple;
214     int http_seekable;
215     AVIOContext *playlist_pb;
216 } HLSContext;
217
218 static void free_segment_dynarray(struct segment **segments, int n_segments)
219 {
220     int i;
221     for (i = 0; i < n_segments; i++) {
222         av_freep(&segments[i]->key);
223         av_freep(&segments[i]->url);
224         av_freep(&segments[i]);
225     }
226 }
227
228 static void free_segment_list(struct playlist *pls)
229 {
230     free_segment_dynarray(pls->segments, pls->n_segments);
231     av_freep(&pls->segments);
232     pls->n_segments = 0;
233 }
234
235 static void free_init_section_list(struct playlist *pls)
236 {
237     int i;
238     for (i = 0; i < pls->n_init_sections; i++) {
239         av_freep(&pls->init_sections[i]->url);
240         av_freep(&pls->init_sections[i]);
241     }
242     av_freep(&pls->init_sections);
243     pls->n_init_sections = 0;
244 }
245
246 static void free_playlist_list(HLSContext *c)
247 {
248     int i;
249     for (i = 0; i < c->n_playlists; i++) {
250         struct playlist *pls = c->playlists[i];
251         free_segment_list(pls);
252         free_init_section_list(pls);
253         av_freep(&pls->main_streams);
254         av_freep(&pls->renditions);
255         av_freep(&pls->id3_buf);
256         av_dict_free(&pls->id3_initial);
257         ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
258         av_freep(&pls->init_sec_buf);
259         av_packet_unref(&pls->pkt);
260         av_freep(&pls->pb.buffer);
261         ff_format_io_close(c->ctx, &pls->input);
262         pls->input_read_done = 0;
263         ff_format_io_close(c->ctx, &pls->input_next);
264         pls->input_next_requested = 0;
265         if (pls->ctx) {
266             pls->ctx->pb = NULL;
267             avformat_close_input(&pls->ctx);
268         }
269         av_free(pls);
270     }
271     av_freep(&c->playlists);
272     c->n_playlists = 0;
273 }
274
275 static void free_variant_list(HLSContext *c)
276 {
277     int i;
278     for (i = 0; i < c->n_variants; i++) {
279         struct variant *var = c->variants[i];
280         av_freep(&var->playlists);
281         av_free(var);
282     }
283     av_freep(&c->variants);
284     c->n_variants = 0;
285 }
286
287 static void free_rendition_list(HLSContext *c)
288 {
289     int i;
290     for (i = 0; i < c->n_renditions; i++)
291         av_freep(&c->renditions[i]);
292     av_freep(&c->renditions);
293     c->n_renditions = 0;
294 }
295
296 /*
297  * Used to reset a statically allocated AVPacket to a clean state,
298  * containing no data.
299  */
300 static void reset_packet(AVPacket *pkt)
301 {
302     av_init_packet(pkt);
303     pkt->data = NULL;
304 }
305
306 static struct playlist *new_playlist(HLSContext *c, const char *url,
307                                      const char *base)
308 {
309     struct playlist *pls = av_mallocz(sizeof(struct playlist));
310     if (!pls)
311         return NULL;
312     reset_packet(&pls->pkt);
313     ff_make_absolute_url(pls->url, sizeof(pls->url), base, url);
314     pls->seek_timestamp = AV_NOPTS_VALUE;
315
316     pls->is_id3_timestamped = -1;
317     pls->id3_mpegts_timestamp = AV_NOPTS_VALUE;
318
319     dynarray_add(&c->playlists, &c->n_playlists, pls);
320     return pls;
321 }
322
323 struct variant_info {
324     char bandwidth[20];
325     /* variant group ids: */
326     char audio[MAX_FIELD_LEN];
327     char video[MAX_FIELD_LEN];
328     char subtitles[MAX_FIELD_LEN];
329 };
330
331 static struct variant *new_variant(HLSContext *c, struct variant_info *info,
332                                    const char *url, const char *base)
333 {
334     struct variant *var;
335     struct playlist *pls;
336
337     pls = new_playlist(c, url, base);
338     if (!pls)
339         return NULL;
340
341     var = av_mallocz(sizeof(struct variant));
342     if (!var)
343         return NULL;
344
345     if (info) {
346         var->bandwidth = atoi(info->bandwidth);
347         strcpy(var->audio_group, info->audio);
348         strcpy(var->video_group, info->video);
349         strcpy(var->subtitles_group, info->subtitles);
350     }
351
352     dynarray_add(&c->variants, &c->n_variants, var);
353     dynarray_add(&var->playlists, &var->n_playlists, pls);
354     return var;
355 }
356
357 static void handle_variant_args(struct variant_info *info, const char *key,
358                                 int key_len, char **dest, int *dest_len)
359 {
360     if (!strncmp(key, "BANDWIDTH=", key_len)) {
361         *dest     =        info->bandwidth;
362         *dest_len = sizeof(info->bandwidth);
363     } else if (!strncmp(key, "AUDIO=", key_len)) {
364         *dest     =        info->audio;
365         *dest_len = sizeof(info->audio);
366     } else if (!strncmp(key, "VIDEO=", key_len)) {
367         *dest     =        info->video;
368         *dest_len = sizeof(info->video);
369     } else if (!strncmp(key, "SUBTITLES=", key_len)) {
370         *dest     =        info->subtitles;
371         *dest_len = sizeof(info->subtitles);
372     }
373 }
374
375 struct key_info {
376      char uri[MAX_URL_SIZE];
377      char method[11];
378      char iv[35];
379 };
380
381 static void handle_key_args(struct key_info *info, const char *key,
382                             int key_len, char **dest, int *dest_len)
383 {
384     if (!strncmp(key, "METHOD=", key_len)) {
385         *dest     =        info->method;
386         *dest_len = sizeof(info->method);
387     } else if (!strncmp(key, "URI=", key_len)) {
388         *dest     =        info->uri;
389         *dest_len = sizeof(info->uri);
390     } else if (!strncmp(key, "IV=", key_len)) {
391         *dest     =        info->iv;
392         *dest_len = sizeof(info->iv);
393     }
394 }
395
396 struct init_section_info {
397     char uri[MAX_URL_SIZE];
398     char byterange[32];
399 };
400
401 static struct segment *new_init_section(struct playlist *pls,
402                                         struct init_section_info *info,
403                                         const char *url_base)
404 {
405     struct segment *sec;
406     char tmp_str[MAX_URL_SIZE], *ptr = tmp_str;
407
408     if (!info->uri[0])
409         return NULL;
410
411     sec = av_mallocz(sizeof(*sec));
412     if (!sec)
413         return NULL;
414
415     if (!av_strncasecmp(info->uri, "data:", 5)) {
416         ptr = info->uri;
417     } else {
418         ff_make_absolute_url(tmp_str, sizeof(tmp_str), url_base, info->uri);
419     }
420     sec->url = av_strdup(ptr);
421     if (!sec->url) {
422         av_free(sec);
423         return NULL;
424     }
425
426     if (info->byterange[0]) {
427         sec->size = strtoll(info->byterange, NULL, 10);
428         ptr = strchr(info->byterange, '@');
429         if (ptr)
430             sec->url_offset = strtoll(ptr+1, NULL, 10);
431     } else {
432         /* the entire file is the init section */
433         sec->size = -1;
434     }
435
436     dynarray_add(&pls->init_sections, &pls->n_init_sections, sec);
437
438     return sec;
439 }
440
441 static void handle_init_section_args(struct init_section_info *info, const char *key,
442                                            int key_len, char **dest, int *dest_len)
443 {
444     if (!strncmp(key, "URI=", key_len)) {
445         *dest     =        info->uri;
446         *dest_len = sizeof(info->uri);
447     } else if (!strncmp(key, "BYTERANGE=", key_len)) {
448         *dest     =        info->byterange;
449         *dest_len = sizeof(info->byterange);
450     }
451 }
452
453 struct rendition_info {
454     char type[16];
455     char uri[MAX_URL_SIZE];
456     char group_id[MAX_FIELD_LEN];
457     char language[MAX_FIELD_LEN];
458     char assoc_language[MAX_FIELD_LEN];
459     char name[MAX_FIELD_LEN];
460     char defaultr[4];
461     char forced[4];
462     char characteristics[MAX_CHARACTERISTICS_LEN];
463 };
464
465 static struct rendition *new_rendition(HLSContext *c, struct rendition_info *info,
466                                       const char *url_base)
467 {
468     struct rendition *rend;
469     enum AVMediaType type = AVMEDIA_TYPE_UNKNOWN;
470     char *characteristic;
471     char *chr_ptr;
472     char *saveptr;
473
474     if (!strcmp(info->type, "AUDIO"))
475         type = AVMEDIA_TYPE_AUDIO;
476     else if (!strcmp(info->type, "VIDEO"))
477         type = AVMEDIA_TYPE_VIDEO;
478     else if (!strcmp(info->type, "SUBTITLES"))
479         type = AVMEDIA_TYPE_SUBTITLE;
480     else if (!strcmp(info->type, "CLOSED-CAPTIONS"))
481         /* CLOSED-CAPTIONS is ignored since we do not support CEA-608 CC in
482          * AVC SEI RBSP anyway */
483         return NULL;
484
485     if (type == AVMEDIA_TYPE_UNKNOWN) {
486         av_log(c->ctx, AV_LOG_WARNING, "Can't support the type: %s\n", info->type);
487         return NULL;
488     }
489
490     /* URI is mandatory for subtitles as per spec */
491     if (type == AVMEDIA_TYPE_SUBTITLE && !info->uri[0]) {
492         av_log(c->ctx, AV_LOG_ERROR, "The URI tag is REQUIRED for subtitle.\n");
493         return NULL;
494     }
495
496     /* TODO: handle subtitles (each segment has to parsed separately) */
497     if (c->ctx->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL)
498         if (type == AVMEDIA_TYPE_SUBTITLE) {
499             av_log(c->ctx, AV_LOG_WARNING, "Can't support the subtitle(uri: %s)\n", info->uri);
500             return NULL;
501         }
502
503     rend = av_mallocz(sizeof(struct rendition));
504     if (!rend)
505         return NULL;
506
507     dynarray_add(&c->renditions, &c->n_renditions, rend);
508
509     rend->type = type;
510     strcpy(rend->group_id, info->group_id);
511     strcpy(rend->language, info->language);
512     strcpy(rend->name, info->name);
513
514     /* add the playlist if this is an external rendition */
515     if (info->uri[0]) {
516         rend->playlist = new_playlist(c, info->uri, url_base);
517         if (rend->playlist)
518             dynarray_add(&rend->playlist->renditions,
519                          &rend->playlist->n_renditions, rend);
520     }
521
522     if (info->assoc_language[0]) {
523         int langlen = strlen(rend->language);
524         if (langlen < sizeof(rend->language) - 3) {
525             rend->language[langlen] = ',';
526             strncpy(rend->language + langlen + 1, info->assoc_language,
527                     sizeof(rend->language) - langlen - 2);
528         }
529     }
530
531     if (!strcmp(info->defaultr, "YES"))
532         rend->disposition |= AV_DISPOSITION_DEFAULT;
533     if (!strcmp(info->forced, "YES"))
534         rend->disposition |= AV_DISPOSITION_FORCED;
535
536     chr_ptr = info->characteristics;
537     while ((characteristic = av_strtok(chr_ptr, ",", &saveptr))) {
538         if (!strcmp(characteristic, "public.accessibility.describes-music-and-sound"))
539             rend->disposition |= AV_DISPOSITION_HEARING_IMPAIRED;
540         else if (!strcmp(characteristic, "public.accessibility.describes-video"))
541             rend->disposition |= AV_DISPOSITION_VISUAL_IMPAIRED;
542
543         chr_ptr = NULL;
544     }
545
546     return rend;
547 }
548
549 static void handle_rendition_args(struct rendition_info *info, const char *key,
550                                   int key_len, char **dest, int *dest_len)
551 {
552     if (!strncmp(key, "TYPE=", key_len)) {
553         *dest     =        info->type;
554         *dest_len = sizeof(info->type);
555     } else if (!strncmp(key, "URI=", key_len)) {
556         *dest     =        info->uri;
557         *dest_len = sizeof(info->uri);
558     } else if (!strncmp(key, "GROUP-ID=", key_len)) {
559         *dest     =        info->group_id;
560         *dest_len = sizeof(info->group_id);
561     } else if (!strncmp(key, "LANGUAGE=", key_len)) {
562         *dest     =        info->language;
563         *dest_len = sizeof(info->language);
564     } else if (!strncmp(key, "ASSOC-LANGUAGE=", key_len)) {
565         *dest     =        info->assoc_language;
566         *dest_len = sizeof(info->assoc_language);
567     } else if (!strncmp(key, "NAME=", key_len)) {
568         *dest     =        info->name;
569         *dest_len = sizeof(info->name);
570     } else if (!strncmp(key, "DEFAULT=", key_len)) {
571         *dest     =        info->defaultr;
572         *dest_len = sizeof(info->defaultr);
573     } else if (!strncmp(key, "FORCED=", key_len)) {
574         *dest     =        info->forced;
575         *dest_len = sizeof(info->forced);
576     } else if (!strncmp(key, "CHARACTERISTICS=", key_len)) {
577         *dest     =        info->characteristics;
578         *dest_len = sizeof(info->characteristics);
579     }
580     /*
581      * ignored:
582      * - AUTOSELECT: client may autoselect based on e.g. system language
583      * - INSTREAM-ID: EIA-608 closed caption number ("CC1".."CC4")
584      */
585 }
586
587 /* used by parse_playlist to allocate a new variant+playlist when the
588  * playlist is detected to be a Media Playlist (not Master Playlist)
589  * and we have no parent Master Playlist (parsing of which would have
590  * allocated the variant and playlist already)
591  * *pls == NULL  => Master Playlist or parentless Media Playlist
592  * *pls != NULL => parented Media Playlist, playlist+variant allocated */
593 static int ensure_playlist(HLSContext *c, struct playlist **pls, const char *url)
594 {
595     if (*pls)
596         return 0;
597     if (!new_variant(c, NULL, url, NULL))
598         return AVERROR(ENOMEM);
599     *pls = c->playlists[c->n_playlists - 1];
600     return 0;
601 }
602
603 static int open_url_keepalive(AVFormatContext *s, AVIOContext **pb,
604                               const char *url, AVDictionary **options)
605 {
606 #if !CONFIG_HTTP_PROTOCOL
607     return AVERROR_PROTOCOL_NOT_FOUND;
608 #else
609     int ret;
610     URLContext *uc = ffio_geturlcontext(*pb);
611     av_assert0(uc);
612     (*pb)->eof_reached = 0;
613     ret = ff_http_do_new_request2(uc, url, options);
614     if (ret < 0) {
615         ff_format_io_close(s, pb);
616     }
617     return ret;
618 #endif
619 }
620
621 static int open_url(AVFormatContext *s, AVIOContext **pb, const char *url,
622                     AVDictionary *opts, AVDictionary *opts2, int *is_http_out)
623 {
624     HLSContext *c = s->priv_data;
625     AVDictionary *tmp = NULL;
626     const char *proto_name = NULL;
627     int ret;
628     int is_http = 0;
629
630     if (av_strstart(url, "crypto", NULL)) {
631         if (url[6] == '+' || url[6] == ':')
632             proto_name = avio_find_protocol_name(url + 7);
633     } else if (av_strstart(url, "data", NULL)) {
634         if (url[4] == '+' || url[4] == ':')
635             proto_name = avio_find_protocol_name(url + 5);
636     }
637
638     if (!proto_name)
639         proto_name = avio_find_protocol_name(url);
640
641     if (!proto_name)
642         return AVERROR_INVALIDDATA;
643
644     // only http(s) & file are allowed
645     if (av_strstart(proto_name, "file", NULL)) {
646         if (strcmp(c->allowed_extensions, "ALL") && !av_match_ext(url, c->allowed_extensions)) {
647             av_log(s, AV_LOG_ERROR,
648                 "Filename extension of \'%s\' is not a common multimedia extension, blocked for security reasons.\n"
649                 "If you wish to override this adjust allowed_extensions, you can set it to \'ALL\' to allow all\n",
650                 url);
651             return AVERROR_INVALIDDATA;
652         }
653     } else if (av_strstart(proto_name, "http", NULL)) {
654         is_http = 1;
655     } else if (av_strstart(proto_name, "data", NULL)) {
656         ;
657     } else
658         return AVERROR_INVALIDDATA;
659
660     if (!strncmp(proto_name, url, strlen(proto_name)) && url[strlen(proto_name)] == ':')
661         ;
662     else if (av_strstart(url, "crypto", NULL) && !strncmp(proto_name, url + 7, strlen(proto_name)) && url[7 + strlen(proto_name)] == ':')
663         ;
664     else if (av_strstart(url, "data", NULL) && !strncmp(proto_name, url + 5, strlen(proto_name)) && url[5 + strlen(proto_name)] == ':')
665         ;
666     else if (strcmp(proto_name, "file") || !strncmp(url, "file,", 5))
667         return AVERROR_INVALIDDATA;
668
669     av_dict_copy(&tmp, opts, 0);
670     av_dict_copy(&tmp, opts2, 0);
671
672     if (is_http && c->http_persistent && *pb) {
673         ret = open_url_keepalive(c->ctx, pb, url, &tmp);
674         if (ret == AVERROR_EXIT) {
675             av_dict_free(&tmp);
676             return ret;
677         } else if (ret < 0) {
678             if (ret != AVERROR_EOF)
679                 av_log(s, AV_LOG_WARNING,
680                     "keepalive request failed for '%s' with error: '%s' when opening url, retrying with new connection\n",
681                     url, av_err2str(ret));
682             ret = s->io_open(s, pb, url, AVIO_FLAG_READ, &tmp);
683         }
684     } else {
685         ret = s->io_open(s, pb, url, AVIO_FLAG_READ, &tmp);
686     }
687     if (ret >= 0) {
688         // update cookies on http response with setcookies.
689         char *new_cookies = NULL;
690
691         if (!(s->flags & AVFMT_FLAG_CUSTOM_IO))
692             av_opt_get(*pb, "cookies", AV_OPT_SEARCH_CHILDREN, (uint8_t**)&new_cookies);
693
694         if (new_cookies)
695             av_dict_set(&opts, "cookies", new_cookies, AV_DICT_DONT_STRDUP_VAL);
696     }
697
698     av_dict_free(&tmp);
699
700     if (is_http_out)
701         *is_http_out = is_http;
702
703     return ret;
704 }
705
706 static int parse_playlist(HLSContext *c, const char *url,
707                           struct playlist *pls, AVIOContext *in)
708 {
709     int ret = 0, is_segment = 0, is_variant = 0;
710     int64_t duration = 0;
711     enum KeyType key_type = KEY_NONE;
712     uint8_t iv[16] = "";
713     int has_iv = 0;
714     char key[MAX_URL_SIZE] = "";
715     char line[MAX_URL_SIZE];
716     const char *ptr;
717     int close_in = 0;
718     int64_t seg_offset = 0;
719     int64_t seg_size = -1;
720     uint8_t *new_url = NULL;
721     struct variant_info variant_info;
722     char tmp_str[MAX_URL_SIZE];
723     struct segment *cur_init_section = NULL;
724     int is_http = av_strstart(url, "http", NULL);
725     struct segment **prev_segments = NULL;
726     int prev_n_segments = 0;
727     int prev_start_seq_no = -1;
728
729     if (is_http && !in && c->http_persistent && c->playlist_pb) {
730         in = c->playlist_pb;
731         ret = open_url_keepalive(c->ctx, &c->playlist_pb, url, NULL);
732         if (ret == AVERROR_EXIT) {
733             return ret;
734         } else if (ret < 0) {
735             if (ret != AVERROR_EOF)
736                 av_log(c->ctx, AV_LOG_WARNING,
737                     "keepalive request failed for '%s' with error: '%s' when parsing playlist\n",
738                     url, av_err2str(ret));
739             in = NULL;
740         }
741     }
742
743     if (!in) {
744         AVDictionary *opts = NULL;
745         av_dict_copy(&opts, c->avio_opts, 0);
746
747         if (c->http_persistent)
748             av_dict_set(&opts, "multiple_requests", "1", 0);
749
750         ret = c->ctx->io_open(c->ctx, &in, url, AVIO_FLAG_READ, &opts);
751         av_dict_free(&opts);
752         if (ret < 0)
753             return ret;
754
755         if (is_http && c->http_persistent)
756             c->playlist_pb = in;
757         else
758             close_in = 1;
759     }
760
761     if (av_opt_get(in, "location", AV_OPT_SEARCH_CHILDREN, &new_url) >= 0)
762         url = new_url;
763
764     ff_get_chomp_line(in, line, sizeof(line));
765     if (strcmp(line, "#EXTM3U")) {
766         ret = AVERROR_INVALIDDATA;
767         goto fail;
768     }
769
770     if (pls) {
771         prev_start_seq_no = pls->start_seq_no;
772         prev_segments = pls->segments;
773         prev_n_segments = pls->n_segments;
774         pls->segments = NULL;
775         pls->n_segments = 0;
776
777         pls->finished = 0;
778         pls->type = PLS_TYPE_UNSPECIFIED;
779     }
780     while (!avio_feof(in)) {
781         ff_get_chomp_line(in, line, sizeof(line));
782         if (av_strstart(line, "#EXT-X-STREAM-INF:", &ptr)) {
783             is_variant = 1;
784             memset(&variant_info, 0, sizeof(variant_info));
785             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_variant_args,
786                                &variant_info);
787         } else if (av_strstart(line, "#EXT-X-KEY:", &ptr)) {
788             struct key_info info = {{0}};
789             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_key_args,
790                                &info);
791             key_type = KEY_NONE;
792             has_iv = 0;
793             if (!strcmp(info.method, "AES-128"))
794                 key_type = KEY_AES_128;
795             if (!strcmp(info.method, "SAMPLE-AES"))
796                 key_type = KEY_SAMPLE_AES;
797             if (!strncmp(info.iv, "0x", 2) || !strncmp(info.iv, "0X", 2)) {
798                 ff_hex_to_data(iv, info.iv + 2);
799                 has_iv = 1;
800             }
801             av_strlcpy(key, info.uri, sizeof(key));
802         } else if (av_strstart(line, "#EXT-X-MEDIA:", &ptr)) {
803             struct rendition_info info = {{0}};
804             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_rendition_args,
805                                &info);
806             new_rendition(c, &info, url);
807         } else if (av_strstart(line, "#EXT-X-TARGETDURATION:", &ptr)) {
808             ret = ensure_playlist(c, &pls, url);
809             if (ret < 0)
810                 goto fail;
811             pls->target_duration = strtoll(ptr, NULL, 10) * AV_TIME_BASE;
812         } else if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
813             ret = ensure_playlist(c, &pls, url);
814             if (ret < 0)
815                 goto fail;
816             pls->start_seq_no = atoi(ptr);
817         } else if (av_strstart(line, "#EXT-X-PLAYLIST-TYPE:", &ptr)) {
818             ret = ensure_playlist(c, &pls, url);
819             if (ret < 0)
820                 goto fail;
821             if (!strcmp(ptr, "EVENT"))
822                 pls->type = PLS_TYPE_EVENT;
823             else if (!strcmp(ptr, "VOD"))
824                 pls->type = PLS_TYPE_VOD;
825         } else if (av_strstart(line, "#EXT-X-MAP:", &ptr)) {
826             struct init_section_info info = {{0}};
827             ret = ensure_playlist(c, &pls, url);
828             if (ret < 0)
829                 goto fail;
830             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_init_section_args,
831                                &info);
832             cur_init_section = new_init_section(pls, &info, url);
833             cur_init_section->key_type = key_type;
834             if (has_iv) {
835                 memcpy(cur_init_section->iv, iv, sizeof(iv));
836             } else {
837                 int seq = pls->start_seq_no + pls->n_segments;
838                 memset(cur_init_section->iv, 0, sizeof(cur_init_section->iv));
839                 AV_WB32(cur_init_section->iv + 12, seq);
840             }
841
842             if (key_type != KEY_NONE) {
843                 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, key);
844                 cur_init_section->key = av_strdup(tmp_str);
845                 if (!cur_init_section->key) {
846                     av_free(cur_init_section);
847                     ret = AVERROR(ENOMEM);
848                     goto fail;
849                 }
850             } else {
851                 cur_init_section->key = NULL;
852             }
853
854         } else if (av_strstart(line, "#EXT-X-ENDLIST", &ptr)) {
855             if (pls)
856                 pls->finished = 1;
857         } else if (av_strstart(line, "#EXTINF:", &ptr)) {
858             is_segment = 1;
859             duration   = atof(ptr) * AV_TIME_BASE;
860         } else if (av_strstart(line, "#EXT-X-BYTERANGE:", &ptr)) {
861             seg_size = strtoll(ptr, NULL, 10);
862             ptr = strchr(ptr, '@');
863             if (ptr)
864                 seg_offset = strtoll(ptr+1, NULL, 10);
865         } else if (av_strstart(line, "#", NULL)) {
866             av_log(c->ctx, AV_LOG_INFO, "Skip ('%s')\n", line);
867             continue;
868         } else if (line[0]) {
869             if (is_variant) {
870                 if (!new_variant(c, &variant_info, line, url)) {
871                     ret = AVERROR(ENOMEM);
872                     goto fail;
873                 }
874                 is_variant = 0;
875             }
876             if (is_segment) {
877                 struct segment *seg;
878                 ret = ensure_playlist(c, &pls, url);
879                 if (ret < 0)
880                     goto fail;
881                 seg = av_malloc(sizeof(struct segment));
882                 if (!seg) {
883                     ret = AVERROR(ENOMEM);
884                     goto fail;
885                 }
886                 seg->duration = duration;
887                 seg->key_type = key_type;
888                 if (has_iv) {
889                     memcpy(seg->iv, iv, sizeof(iv));
890                 } else {
891                     int seq = pls->start_seq_no + pls->n_segments;
892                     memset(seg->iv, 0, sizeof(seg->iv));
893                     AV_WB32(seg->iv + 12, seq);
894                 }
895
896                 if (key_type != KEY_NONE) {
897                     ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, key);
898                     seg->key = av_strdup(tmp_str);
899                     if (!seg->key) {
900                         av_free(seg);
901                         ret = AVERROR(ENOMEM);
902                         goto fail;
903                     }
904                 } else {
905                     seg->key = NULL;
906                 }
907
908                 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, line);
909                 seg->url = av_strdup(tmp_str);
910                 if (!seg->url) {
911                     av_free(seg->key);
912                     av_free(seg);
913                     ret = AVERROR(ENOMEM);
914                     goto fail;
915                 }
916
917                 dynarray_add(&pls->segments, &pls->n_segments, seg);
918                 is_segment = 0;
919
920                 seg->size = seg_size;
921                 if (seg_size >= 0) {
922                     seg->url_offset = seg_offset;
923                     seg_offset += seg_size;
924                     seg_size = -1;
925                 } else {
926                     seg->url_offset = 0;
927                     seg_offset = 0;
928                 }
929
930                 seg->init_section = cur_init_section;
931             }
932         }
933     }
934     if (prev_segments) {
935         if (pls->start_seq_no > prev_start_seq_no && c->first_timestamp != AV_NOPTS_VALUE) {
936             int64_t prev_timestamp = c->first_timestamp;
937             int i, diff = pls->start_seq_no - prev_start_seq_no;
938             for (i = 0; i < prev_n_segments && i < diff; i++) {
939                 c->first_timestamp += prev_segments[i]->duration;
940             }
941             av_log(c->ctx, AV_LOG_DEBUG, "Media sequence change (%d -> %d)"
942                    " reflected in first_timestamp: %"PRId64" -> %"PRId64"\n",
943                    prev_start_seq_no, pls->start_seq_no,
944                    prev_timestamp, c->first_timestamp);
945         } else if (pls->start_seq_no < prev_start_seq_no) {
946             av_log(c->ctx, AV_LOG_WARNING, "Media sequence changed unexpectedly: %d -> %d\n",
947                    prev_start_seq_no, pls->start_seq_no);
948         }
949         free_segment_dynarray(prev_segments, prev_n_segments);
950         av_freep(&prev_segments);
951     }
952     if (pls)
953         pls->last_load_time = av_gettime_relative();
954
955 fail:
956     av_free(new_url);
957     if (close_in)
958         ff_format_io_close(c->ctx, &in);
959     c->ctx->ctx_flags = c->ctx->ctx_flags & ~(unsigned)AVFMTCTX_UNSEEKABLE;
960     if (!c->n_variants || !c->variants[0]->n_playlists ||
961         !(c->variants[0]->playlists[0]->finished ||
962           c->variants[0]->playlists[0]->type == PLS_TYPE_EVENT))
963         c->ctx->ctx_flags |= AVFMTCTX_UNSEEKABLE;
964     return ret;
965 }
966
967 static struct segment *current_segment(struct playlist *pls)
968 {
969     return pls->segments[pls->cur_seq_no - pls->start_seq_no];
970 }
971
972 static struct segment *next_segment(struct playlist *pls)
973 {
974     int n = pls->cur_seq_no - pls->start_seq_no + 1;
975     if (n >= pls->n_segments)
976         return NULL;
977     return pls->segments[n];
978 }
979
980 static int read_from_url(struct playlist *pls, struct segment *seg,
981                          uint8_t *buf, int buf_size)
982 {
983     int ret;
984
985      /* limit read if the segment was only a part of a file */
986     if (seg->size >= 0)
987         buf_size = FFMIN(buf_size, seg->size - pls->cur_seg_offset);
988
989     ret = avio_read(pls->input, buf, buf_size);
990     if (ret > 0)
991         pls->cur_seg_offset += ret;
992
993     return ret;
994 }
995
996 /* Parse the raw ID3 data and pass contents to caller */
997 static void parse_id3(AVFormatContext *s, AVIOContext *pb,
998                       AVDictionary **metadata, int64_t *dts,
999                       ID3v2ExtraMetaAPIC **apic, ID3v2ExtraMeta **extra_meta)
1000 {
1001     static const char id3_priv_owner_ts[] = "com.apple.streaming.transportStreamTimestamp";
1002     ID3v2ExtraMeta *meta;
1003
1004     ff_id3v2_read_dict(pb, metadata, ID3v2_DEFAULT_MAGIC, extra_meta);
1005     for (meta = *extra_meta; meta; meta = meta->next) {
1006         if (!strcmp(meta->tag, "PRIV")) {
1007             ID3v2ExtraMetaPRIV *priv = &meta->data.priv;
1008             if (priv->datasize == 8 && !strcmp(priv->owner, id3_priv_owner_ts)) {
1009                 /* 33-bit MPEG timestamp */
1010                 int64_t ts = AV_RB64(priv->data);
1011                 av_log(s, AV_LOG_DEBUG, "HLS ID3 audio timestamp %"PRId64"\n", ts);
1012                 if ((ts & ~((1ULL << 33) - 1)) == 0)
1013                     *dts = ts;
1014                 else
1015                     av_log(s, AV_LOG_ERROR, "Invalid HLS ID3 audio timestamp %"PRId64"\n", ts);
1016             }
1017         } else if (!strcmp(meta->tag, "APIC") && apic)
1018             *apic = &meta->data.apic;
1019     }
1020 }
1021
1022 /* Check if the ID3 metadata contents have changed */
1023 static int id3_has_changed_values(struct playlist *pls, AVDictionary *metadata,
1024                                   ID3v2ExtraMetaAPIC *apic)
1025 {
1026     AVDictionaryEntry *entry = NULL;
1027     AVDictionaryEntry *oldentry;
1028     /* check that no keys have changed values */
1029     while ((entry = av_dict_get(metadata, "", entry, AV_DICT_IGNORE_SUFFIX))) {
1030         oldentry = av_dict_get(pls->id3_initial, entry->key, NULL, AV_DICT_MATCH_CASE);
1031         if (!oldentry || strcmp(oldentry->value, entry->value) != 0)
1032             return 1;
1033     }
1034
1035     /* check if apic appeared */
1036     if (apic && (pls->ctx->nb_streams != 2 || !pls->ctx->streams[1]->attached_pic.data))
1037         return 1;
1038
1039     if (apic) {
1040         int size = pls->ctx->streams[1]->attached_pic.size;
1041         if (size != apic->buf->size - AV_INPUT_BUFFER_PADDING_SIZE)
1042             return 1;
1043
1044         if (memcmp(apic->buf->data, pls->ctx->streams[1]->attached_pic.data, size) != 0)
1045             return 1;
1046     }
1047
1048     return 0;
1049 }
1050
1051 /* Parse ID3 data and handle the found data */
1052 static void handle_id3(AVIOContext *pb, struct playlist *pls)
1053 {
1054     AVDictionary *metadata = NULL;
1055     ID3v2ExtraMetaAPIC *apic = NULL;
1056     ID3v2ExtraMeta *extra_meta = NULL;
1057     int64_t timestamp = AV_NOPTS_VALUE;
1058
1059     parse_id3(pls->ctx, pb, &metadata, &timestamp, &apic, &extra_meta);
1060
1061     if (timestamp != AV_NOPTS_VALUE) {
1062         pls->id3_mpegts_timestamp = timestamp;
1063         pls->id3_offset = 0;
1064     }
1065
1066     if (!pls->id3_found) {
1067         /* initial ID3 tags */
1068         av_assert0(!pls->id3_deferred_extra);
1069         pls->id3_found = 1;
1070
1071         /* get picture attachment and set text metadata */
1072         if (pls->ctx->nb_streams)
1073             ff_id3v2_parse_apic(pls->ctx, extra_meta);
1074         else
1075             /* demuxer not yet opened, defer picture attachment */
1076             pls->id3_deferred_extra = extra_meta;
1077
1078         ff_id3v2_parse_priv_dict(&metadata, extra_meta);
1079         av_dict_copy(&pls->ctx->metadata, metadata, 0);
1080         pls->id3_initial = metadata;
1081
1082     } else {
1083         if (!pls->id3_changed && id3_has_changed_values(pls, metadata, apic)) {
1084             avpriv_report_missing_feature(pls->parent, "Changing ID3 metadata in HLS audio elementary stream");
1085             pls->id3_changed = 1;
1086         }
1087         av_dict_free(&metadata);
1088     }
1089
1090     if (!pls->id3_deferred_extra)
1091         ff_id3v2_free_extra_meta(&extra_meta);
1092 }
1093
1094 static void intercept_id3(struct playlist *pls, uint8_t *buf,
1095                          int buf_size, int *len)
1096 {
1097     /* intercept id3 tags, we do not want to pass them to the raw
1098      * demuxer on all segment switches */
1099     int bytes;
1100     int id3_buf_pos = 0;
1101     int fill_buf = 0;
1102     struct segment *seg = current_segment(pls);
1103
1104     /* gather all the id3 tags */
1105     while (1) {
1106         /* see if we can retrieve enough data for ID3 header */
1107         if (*len < ID3v2_HEADER_SIZE && buf_size >= ID3v2_HEADER_SIZE) {
1108             bytes = read_from_url(pls, seg, buf + *len, ID3v2_HEADER_SIZE - *len);
1109             if (bytes > 0) {
1110
1111                 if (bytes == ID3v2_HEADER_SIZE - *len)
1112                     /* no EOF yet, so fill the caller buffer again after
1113                      * we have stripped the ID3 tags */
1114                     fill_buf = 1;
1115
1116                 *len += bytes;
1117
1118             } else if (*len <= 0) {
1119                 /* error/EOF */
1120                 *len = bytes;
1121                 fill_buf = 0;
1122             }
1123         }
1124
1125         if (*len < ID3v2_HEADER_SIZE)
1126             break;
1127
1128         if (ff_id3v2_match(buf, ID3v2_DEFAULT_MAGIC)) {
1129             int64_t maxsize = seg->size >= 0 ? seg->size : 1024*1024;
1130             int taglen = ff_id3v2_tag_len(buf);
1131             int tag_got_bytes = FFMIN(taglen, *len);
1132             int remaining = taglen - tag_got_bytes;
1133
1134             if (taglen > maxsize) {
1135                 av_log(pls->parent, AV_LOG_ERROR, "Too large HLS ID3 tag (%d > %"PRId64" bytes)\n",
1136                        taglen, maxsize);
1137                 break;
1138             }
1139
1140             /*
1141              * Copy the id3 tag to our temporary id3 buffer.
1142              * We could read a small id3 tag directly without memcpy, but
1143              * we would still need to copy the large tags, and handling
1144              * both of those cases together with the possibility for multiple
1145              * tags would make the handling a bit complex.
1146              */
1147             pls->id3_buf = av_fast_realloc(pls->id3_buf, &pls->id3_buf_size, id3_buf_pos + taglen);
1148             if (!pls->id3_buf)
1149                 break;
1150             memcpy(pls->id3_buf + id3_buf_pos, buf, tag_got_bytes);
1151             id3_buf_pos += tag_got_bytes;
1152
1153             /* strip the intercepted bytes */
1154             *len -= tag_got_bytes;
1155             memmove(buf, buf + tag_got_bytes, *len);
1156             av_log(pls->parent, AV_LOG_DEBUG, "Stripped %d HLS ID3 bytes\n", tag_got_bytes);
1157
1158             if (remaining > 0) {
1159                 /* read the rest of the tag in */
1160                 if (read_from_url(pls, seg, pls->id3_buf + id3_buf_pos, remaining) != remaining)
1161                     break;
1162                 id3_buf_pos += remaining;
1163                 av_log(pls->parent, AV_LOG_DEBUG, "Stripped additional %d HLS ID3 bytes\n", remaining);
1164             }
1165
1166         } else {
1167             /* no more ID3 tags */
1168             break;
1169         }
1170     }
1171
1172     /* re-fill buffer for the caller unless EOF */
1173     if (*len >= 0 && (fill_buf || *len == 0)) {
1174         bytes = read_from_url(pls, seg, buf + *len, buf_size - *len);
1175
1176         /* ignore error if we already had some data */
1177         if (bytes >= 0)
1178             *len += bytes;
1179         else if (*len == 0)
1180             *len = bytes;
1181     }
1182
1183     if (pls->id3_buf) {
1184         /* Now parse all the ID3 tags */
1185         AVIOContext id3ioctx;
1186         ffio_init_context(&id3ioctx, pls->id3_buf, id3_buf_pos, 0, NULL, NULL, NULL, NULL);
1187         handle_id3(&id3ioctx, pls);
1188     }
1189
1190     if (pls->is_id3_timestamped == -1)
1191         pls->is_id3_timestamped = (pls->id3_mpegts_timestamp != AV_NOPTS_VALUE);
1192 }
1193
1194 static int open_input(HLSContext *c, struct playlist *pls, struct segment *seg, AVIOContext **in)
1195 {
1196     AVDictionary *opts = NULL;
1197     int ret;
1198     int is_http = 0;
1199
1200     if (c->http_persistent)
1201         av_dict_set(&opts, "multiple_requests", "1", 0);
1202
1203     if (seg->size >= 0) {
1204         /* try to restrict the HTTP request to the part we want
1205          * (if this is in fact a HTTP request) */
1206         av_dict_set_int(&opts, "offset", seg->url_offset, 0);
1207         av_dict_set_int(&opts, "end_offset", seg->url_offset + seg->size, 0);
1208     }
1209
1210     av_log(pls->parent, AV_LOG_VERBOSE, "HLS request for url '%s', offset %"PRId64", playlist %d\n",
1211            seg->url, seg->url_offset, pls->index);
1212
1213     if (seg->key_type == KEY_NONE) {
1214         ret = open_url(pls->parent, in, seg->url, c->avio_opts, opts, &is_http);
1215     } else if (seg->key_type == KEY_AES_128) {
1216         char iv[33], key[33], url[MAX_URL_SIZE];
1217         if (strcmp(seg->key, pls->key_url)) {
1218             AVIOContext *pb = NULL;
1219             if (open_url(pls->parent, &pb, seg->key, c->avio_opts, opts, NULL) == 0) {
1220                 ret = avio_read(pb, pls->key, sizeof(pls->key));
1221                 if (ret != sizeof(pls->key)) {
1222                     av_log(pls->parent, AV_LOG_ERROR, "Unable to read key file %s\n",
1223                            seg->key);
1224                 }
1225                 ff_format_io_close(pls->parent, &pb);
1226             } else {
1227                 av_log(pls->parent, AV_LOG_ERROR, "Unable to open key file %s\n",
1228                        seg->key);
1229             }
1230             av_strlcpy(pls->key_url, seg->key, sizeof(pls->key_url));
1231         }
1232         ff_data_to_hex(iv, seg->iv, sizeof(seg->iv), 0);
1233         ff_data_to_hex(key, pls->key, sizeof(pls->key), 0);
1234         iv[32] = key[32] = '\0';
1235         if (strstr(seg->url, "://"))
1236             snprintf(url, sizeof(url), "crypto+%s", seg->url);
1237         else
1238             snprintf(url, sizeof(url), "crypto:%s", seg->url);
1239
1240         av_dict_set(&opts, "key", key, 0);
1241         av_dict_set(&opts, "iv", iv, 0);
1242
1243         ret = open_url(pls->parent, in, url, c->avio_opts, opts, &is_http);
1244         if (ret < 0) {
1245             goto cleanup;
1246         }
1247         ret = 0;
1248     } else if (seg->key_type == KEY_SAMPLE_AES) {
1249         av_log(pls->parent, AV_LOG_ERROR,
1250                "SAMPLE-AES encryption is not supported yet\n");
1251         ret = AVERROR_PATCHWELCOME;
1252     }
1253     else
1254       ret = AVERROR(ENOSYS);
1255
1256     /* Seek to the requested position. If this was a HTTP request, the offset
1257      * should already be where want it to, but this allows e.g. local testing
1258      * without a HTTP server.
1259      *
1260      * This is not done for HTTP at all as avio_seek() does internal bookkeeping
1261      * of file offset which is out-of-sync with the actual offset when "offset"
1262      * AVOption is used with http protocol, causing the seek to not be a no-op
1263      * as would be expected. Wrong offset received from the server will not be
1264      * noticed without the call, though.
1265      */
1266     if (ret == 0 && !is_http && seg->key_type == KEY_NONE && seg->url_offset) {
1267         int64_t seekret = avio_seek(*in, seg->url_offset, SEEK_SET);
1268         if (seekret < 0) {
1269             av_log(pls->parent, AV_LOG_ERROR, "Unable to seek to offset %"PRId64" of HLS segment '%s'\n", seg->url_offset, seg->url);
1270             ret = seekret;
1271             ff_format_io_close(pls->parent, in);
1272         }
1273     }
1274
1275 cleanup:
1276     av_dict_free(&opts);
1277     pls->cur_seg_offset = 0;
1278     return ret;
1279 }
1280
1281 static int update_init_section(struct playlist *pls, struct segment *seg)
1282 {
1283     static const int max_init_section_size = 1024*1024;
1284     HLSContext *c = pls->parent->priv_data;
1285     int64_t sec_size;
1286     int64_t urlsize;
1287     int ret;
1288
1289     if (seg->init_section == pls->cur_init_section)
1290         return 0;
1291
1292     pls->cur_init_section = NULL;
1293
1294     if (!seg->init_section)
1295         return 0;
1296
1297     ret = open_input(c, pls, seg->init_section, &pls->input);
1298     if (ret < 0) {
1299         av_log(pls->parent, AV_LOG_WARNING,
1300                "Failed to open an initialization section in playlist %d\n",
1301                pls->index);
1302         return ret;
1303     }
1304
1305     if (seg->init_section->size >= 0)
1306         sec_size = seg->init_section->size;
1307     else if ((urlsize = avio_size(pls->input)) >= 0)
1308         sec_size = urlsize;
1309     else
1310         sec_size = max_init_section_size;
1311
1312     av_log(pls->parent, AV_LOG_DEBUG,
1313            "Downloading an initialization section of size %"PRId64"\n",
1314            sec_size);
1315
1316     sec_size = FFMIN(sec_size, max_init_section_size);
1317
1318     av_fast_malloc(&pls->init_sec_buf, &pls->init_sec_buf_size, sec_size);
1319
1320     ret = read_from_url(pls, seg->init_section, pls->init_sec_buf,
1321                         pls->init_sec_buf_size);
1322     ff_format_io_close(pls->parent, &pls->input);
1323
1324     if (ret < 0)
1325         return ret;
1326
1327     pls->cur_init_section = seg->init_section;
1328     pls->init_sec_data_len = ret;
1329     pls->init_sec_buf_read_offset = 0;
1330
1331     /* spec says audio elementary streams do not have media initialization
1332      * sections, so there should be no ID3 timestamps */
1333     pls->is_id3_timestamped = 0;
1334
1335     return 0;
1336 }
1337
1338 static int64_t default_reload_interval(struct playlist *pls)
1339 {
1340     return pls->n_segments > 0 ?
1341                           pls->segments[pls->n_segments - 1]->duration :
1342                           pls->target_duration;
1343 }
1344
1345 static int playlist_needed(struct playlist *pls)
1346 {
1347     AVFormatContext *s = pls->parent;
1348     int i, j;
1349     int stream_needed = 0;
1350     int first_st;
1351
1352     /* If there is no context or streams yet, the playlist is needed */
1353     if (!pls->ctx || !pls->n_main_streams)
1354         return 1;
1355
1356     /* check if any of the streams in the playlist are needed */
1357     for (i = 0; i < pls->n_main_streams; i++) {
1358         if (pls->main_streams[i]->discard < AVDISCARD_ALL) {
1359             stream_needed = 1;
1360             break;
1361         }
1362     }
1363
1364     /* If all streams in the playlist were discarded, the playlist is not
1365      * needed (regardless of whether whole programs are discarded or not). */
1366     if (!stream_needed)
1367         return 0;
1368
1369     /* Otherwise, check if all the programs (variants) this playlist is in are
1370      * discarded. Since all streams in the playlist are part of the same programs
1371      * we can just check the programs of the first stream. */
1372
1373     first_st = pls->main_streams[0]->index;
1374
1375     for (i = 0; i < s->nb_programs; i++) {
1376         AVProgram *program = s->programs[i];
1377         if (program->discard < AVDISCARD_ALL) {
1378             for (j = 0; j < program->nb_stream_indexes; j++) {
1379                 if (program->stream_index[j] == first_st) {
1380                     /* playlist is in an undiscarded program */
1381                     return 1;
1382                 }
1383             }
1384         }
1385     }
1386
1387     /* some streams were not discarded but all the programs were */
1388     return 0;
1389 }
1390
1391 static int read_data(void *opaque, uint8_t *buf, int buf_size)
1392 {
1393     struct playlist *v = opaque;
1394     HLSContext *c = v->parent->priv_data;
1395     int ret;
1396     int just_opened = 0;
1397     int reload_count = 0;
1398     struct segment *seg;
1399
1400 restart:
1401     if (!v->needed)
1402         return AVERROR_EOF;
1403
1404     if (!v->input || (c->http_persistent && v->input_read_done)) {
1405         int64_t reload_interval;
1406
1407         /* Check that the playlist is still needed before opening a new
1408          * segment. */
1409         v->needed = playlist_needed(v);
1410
1411         if (!v->needed) {
1412             av_log(v->parent, AV_LOG_INFO, "No longer receiving playlist %d ('%s')\n",
1413                    v->index, v->url);
1414             return AVERROR_EOF;
1415         }
1416
1417         /* If this is a live stream and the reload interval has elapsed since
1418          * the last playlist reload, reload the playlists now. */
1419         reload_interval = default_reload_interval(v);
1420
1421 reload:
1422         reload_count++;
1423         if (reload_count > c->max_reload)
1424             return AVERROR_EOF;
1425         if (!v->finished &&
1426             av_gettime_relative() - v->last_load_time >= reload_interval) {
1427             if ((ret = parse_playlist(c, v->url, v, NULL)) < 0) {
1428                 if (ret != AVERROR_EXIT)
1429                     av_log(v->parent, AV_LOG_WARNING, "Failed to reload playlist %d\n",
1430                            v->index);
1431                 return ret;
1432             }
1433             /* If we need to reload the playlist again below (if
1434              * there's still no more segments), switch to a reload
1435              * interval of half the target duration. */
1436             reload_interval = v->target_duration / 2;
1437         }
1438         if (v->cur_seq_no < v->start_seq_no) {
1439             av_log(v->parent, AV_LOG_WARNING,
1440                    "skipping %d segments ahead, expired from playlists\n",
1441                    v->start_seq_no - v->cur_seq_no);
1442             v->cur_seq_no = v->start_seq_no;
1443         }
1444         if (v->cur_seq_no > v->last_seq_no) {
1445             v->last_seq_no = v->cur_seq_no;
1446             v->m3u8_hold_counters = 0;
1447         } else if (v->last_seq_no == v->cur_seq_no) {
1448             v->m3u8_hold_counters++;
1449             if (v->m3u8_hold_counters >= c->m3u8_hold_counters) {
1450                 return AVERROR_EOF;
1451             }
1452         } else {
1453             av_log(v->parent, AV_LOG_WARNING, "maybe the m3u8 list sequence have been wraped.\n");
1454         }
1455         if (v->cur_seq_no >= v->start_seq_no + v->n_segments) {
1456             if (v->finished)
1457                 return AVERROR_EOF;
1458             while (av_gettime_relative() - v->last_load_time < reload_interval) {
1459                 if (ff_check_interrupt(c->interrupt_callback))
1460                     return AVERROR_EXIT;
1461                 av_usleep(100*1000);
1462             }
1463             /* Enough time has elapsed since the last reload */
1464             goto reload;
1465         }
1466
1467         v->input_read_done = 0;
1468         seg = current_segment(v);
1469
1470         /* load/update Media Initialization Section, if any */
1471         ret = update_init_section(v, seg);
1472         if (ret)
1473             return ret;
1474
1475         if (c->http_multiple == 1 && v->input_next_requested) {
1476             FFSWAP(AVIOContext *, v->input, v->input_next);
1477             v->cur_seg_offset = 0;
1478             v->input_next_requested = 0;
1479             ret = 0;
1480         } else {
1481             ret = open_input(c, v, seg, &v->input);
1482         }
1483         if (ret < 0) {
1484             if (ff_check_interrupt(c->interrupt_callback))
1485                 return AVERROR_EXIT;
1486             av_log(v->parent, AV_LOG_WARNING, "Failed to open segment %d of playlist %d\n",
1487                    v->cur_seq_no,
1488                    v->index);
1489             v->cur_seq_no += 1;
1490             goto reload;
1491         }
1492         just_opened = 1;
1493     }
1494
1495     if (c->http_multiple == -1) {
1496         uint8_t *http_version_opt = NULL;
1497         int r = av_opt_get(v->input, "http_version", AV_OPT_SEARCH_CHILDREN, &http_version_opt);
1498         if (r >= 0) {
1499             c->http_multiple = (!strncmp((const char *)http_version_opt, "1.1", 3) || !strncmp((const char *)http_version_opt, "2.0", 3));
1500             av_freep(&http_version_opt);
1501         }
1502     }
1503
1504     seg = next_segment(v);
1505     if (c->http_multiple == 1 && !v->input_next_requested &&
1506         seg && seg->key_type == KEY_NONE && av_strstart(seg->url, "http", NULL)) {
1507         ret = open_input(c, v, seg, &v->input_next);
1508         if (ret < 0) {
1509             if (ff_check_interrupt(c->interrupt_callback))
1510                 return AVERROR_EXIT;
1511             av_log(v->parent, AV_LOG_WARNING, "Failed to open next segment %d of playlist %d\n",
1512                    v->cur_seq_no + 1,
1513                    v->index);
1514         } else {
1515             v->input_next_requested = 1;
1516         }
1517     }
1518
1519     if (v->init_sec_buf_read_offset < v->init_sec_data_len) {
1520         /* Push init section out first before first actual segment */
1521         int copy_size = FFMIN(v->init_sec_data_len - v->init_sec_buf_read_offset, buf_size);
1522         memcpy(buf, v->init_sec_buf, copy_size);
1523         v->init_sec_buf_read_offset += copy_size;
1524         return copy_size;
1525     }
1526
1527     seg = current_segment(v);
1528     ret = read_from_url(v, seg, buf, buf_size);
1529     if (ret > 0) {
1530         if (just_opened && v->is_id3_timestamped != 0) {
1531             /* Intercept ID3 tags here, elementary audio streams are required
1532              * to convey timestamps using them in the beginning of each segment. */
1533             intercept_id3(v, buf, buf_size, &ret);
1534         }
1535
1536         return ret;
1537     }
1538     if (c->http_persistent &&
1539         seg->key_type == KEY_NONE && av_strstart(seg->url, "http", NULL)) {
1540         v->input_read_done = 1;
1541     } else {
1542         ff_format_io_close(v->parent, &v->input);
1543     }
1544     v->cur_seq_no++;
1545
1546     c->cur_seq_no = v->cur_seq_no;
1547
1548     goto restart;
1549 }
1550
1551 static void add_renditions_to_variant(HLSContext *c, struct variant *var,
1552                                       enum AVMediaType type, const char *group_id)
1553 {
1554     int i;
1555
1556     for (i = 0; i < c->n_renditions; i++) {
1557         struct rendition *rend = c->renditions[i];
1558
1559         if (rend->type == type && !strcmp(rend->group_id, group_id)) {
1560
1561             if (rend->playlist)
1562                 /* rendition is an external playlist
1563                  * => add the playlist to the variant */
1564                 dynarray_add(&var->playlists, &var->n_playlists, rend->playlist);
1565             else
1566                 /* rendition is part of the variant main Media Playlist
1567                  * => add the rendition to the main Media Playlist */
1568                 dynarray_add(&var->playlists[0]->renditions,
1569                              &var->playlists[0]->n_renditions,
1570                              rend);
1571         }
1572     }
1573 }
1574
1575 static void add_metadata_from_renditions(AVFormatContext *s, struct playlist *pls,
1576                                          enum AVMediaType type)
1577 {
1578     int rend_idx = 0;
1579     int i;
1580
1581     for (i = 0; i < pls->n_main_streams; i++) {
1582         AVStream *st = pls->main_streams[i];
1583
1584         if (st->codecpar->codec_type != type)
1585             continue;
1586
1587         for (; rend_idx < pls->n_renditions; rend_idx++) {
1588             struct rendition *rend = pls->renditions[rend_idx];
1589
1590             if (rend->type != type)
1591                 continue;
1592
1593             if (rend->language[0])
1594                 av_dict_set(&st->metadata, "language", rend->language, 0);
1595             if (rend->name[0])
1596                 av_dict_set(&st->metadata, "comment", rend->name, 0);
1597
1598             st->disposition |= rend->disposition;
1599         }
1600         if (rend_idx >=pls->n_renditions)
1601             break;
1602     }
1603 }
1604
1605 /* if timestamp was in valid range: returns 1 and sets seq_no
1606  * if not: returns 0 and sets seq_no to closest segment */
1607 static int find_timestamp_in_playlist(HLSContext *c, struct playlist *pls,
1608                                       int64_t timestamp, int *seq_no)
1609 {
1610     int i;
1611     int64_t pos = c->first_timestamp == AV_NOPTS_VALUE ?
1612                   0 : c->first_timestamp;
1613
1614     if (timestamp < pos) {
1615         *seq_no = pls->start_seq_no;
1616         return 0;
1617     }
1618
1619     for (i = 0; i < pls->n_segments; i++) {
1620         int64_t diff = pos + pls->segments[i]->duration - timestamp;
1621         if (diff > 0) {
1622             *seq_no = pls->start_seq_no + i;
1623             return 1;
1624         }
1625         pos += pls->segments[i]->duration;
1626     }
1627
1628     *seq_no = pls->start_seq_no + pls->n_segments - 1;
1629
1630     return 0;
1631 }
1632
1633 static int select_cur_seq_no(HLSContext *c, struct playlist *pls)
1634 {
1635     int seq_no;
1636
1637     if (!pls->finished && !c->first_packet &&
1638         av_gettime_relative() - pls->last_load_time >= default_reload_interval(pls))
1639         /* reload the playlist since it was suspended */
1640         parse_playlist(c, pls->url, pls, NULL);
1641
1642     /* If playback is already in progress (we are just selecting a new
1643      * playlist) and this is a complete file, find the matching segment
1644      * by counting durations. */
1645     if (pls->finished && c->cur_timestamp != AV_NOPTS_VALUE) {
1646         find_timestamp_in_playlist(c, pls, c->cur_timestamp, &seq_no);
1647         return seq_no;
1648     }
1649
1650     if (!pls->finished) {
1651         if (!c->first_packet && /* we are doing a segment selection during playback */
1652             c->cur_seq_no >= pls->start_seq_no &&
1653             c->cur_seq_no < pls->start_seq_no + pls->n_segments)
1654             /* While spec 3.4.3 says that we cannot assume anything about the
1655              * content at the same sequence number on different playlists,
1656              * in practice this seems to work and doing it otherwise would
1657              * require us to download a segment to inspect its timestamps. */
1658             return c->cur_seq_no;
1659
1660         /* If this is a live stream, start live_start_index segments from the
1661          * start or end */
1662         if (c->live_start_index < 0)
1663             return pls->start_seq_no + FFMAX(pls->n_segments + c->live_start_index, 0);
1664         else
1665             return pls->start_seq_no + FFMIN(c->live_start_index, pls->n_segments - 1);
1666     }
1667
1668     /* Otherwise just start on the first segment. */
1669     return pls->start_seq_no;
1670 }
1671
1672 static int save_avio_options(AVFormatContext *s)
1673 {
1674     HLSContext *c = s->priv_data;
1675     static const char * const opts[] = {
1676         "headers", "http_proxy", "user_agent", "cookies", "referer", "rw_timeout", "icy", NULL };
1677     const char * const * opt = opts;
1678     uint8_t *buf;
1679     int ret = 0;
1680
1681     while (*opt) {
1682         if (av_opt_get(s->pb, *opt, AV_OPT_SEARCH_CHILDREN | AV_OPT_ALLOW_NULL, &buf) >= 0) {
1683             ret = av_dict_set(&c->avio_opts, *opt, buf,
1684                               AV_DICT_DONT_STRDUP_VAL);
1685             if (ret < 0)
1686                 return ret;
1687         }
1688         opt++;
1689     }
1690
1691     return ret;
1692 }
1693
1694 static int nested_io_open(AVFormatContext *s, AVIOContext **pb, const char *url,
1695                           int flags, AVDictionary **opts)
1696 {
1697     av_log(s, AV_LOG_ERROR,
1698            "A HLS playlist item '%s' referred to an external file '%s'. "
1699            "Opening this file was forbidden for security reasons\n",
1700            s->url, url);
1701     return AVERROR(EPERM);
1702 }
1703
1704 static void add_stream_to_programs(AVFormatContext *s, struct playlist *pls, AVStream *stream)
1705 {
1706     HLSContext *c = s->priv_data;
1707     int i, j;
1708     int bandwidth = -1;
1709
1710     for (i = 0; i < c->n_variants; i++) {
1711         struct variant *v = c->variants[i];
1712
1713         for (j = 0; j < v->n_playlists; j++) {
1714             if (v->playlists[j] != pls)
1715                 continue;
1716
1717             av_program_add_stream_index(s, i, stream->index);
1718
1719             if (bandwidth < 0)
1720                 bandwidth = v->bandwidth;
1721             else if (bandwidth != v->bandwidth)
1722                 bandwidth = -1; /* stream in multiple variants with different bandwidths */
1723         }
1724     }
1725
1726     if (bandwidth >= 0)
1727         av_dict_set_int(&stream->metadata, "variant_bitrate", bandwidth, 0);
1728 }
1729
1730 static int set_stream_info_from_input_stream(AVStream *st, struct playlist *pls, AVStream *ist)
1731 {
1732     int err;
1733
1734     err = avcodec_parameters_copy(st->codecpar, ist->codecpar);
1735     if (err < 0)
1736         return err;
1737
1738     if (pls->is_id3_timestamped) /* custom timestamps via id3 */
1739         avpriv_set_pts_info(st, 33, 1, MPEG_TIME_BASE);
1740     else
1741         avpriv_set_pts_info(st, ist->pts_wrap_bits, ist->time_base.num, ist->time_base.den);
1742
1743     st->internal->need_context_update = 1;
1744
1745     return 0;
1746 }
1747
1748 /* add new subdemuxer streams to our context, if any */
1749 static int update_streams_from_subdemuxer(AVFormatContext *s, struct playlist *pls)
1750 {
1751     int err;
1752
1753     while (pls->n_main_streams < pls->ctx->nb_streams) {
1754         int ist_idx = pls->n_main_streams;
1755         AVStream *st = avformat_new_stream(s, NULL);
1756         AVStream *ist = pls->ctx->streams[ist_idx];
1757
1758         if (!st)
1759             return AVERROR(ENOMEM);
1760
1761         st->id = pls->index;
1762         dynarray_add(&pls->main_streams, &pls->n_main_streams, st);
1763
1764         add_stream_to_programs(s, pls, st);
1765
1766         err = set_stream_info_from_input_stream(st, pls, ist);
1767         if (err < 0)
1768             return err;
1769     }
1770
1771     return 0;
1772 }
1773
1774 static void update_noheader_flag(AVFormatContext *s)
1775 {
1776     HLSContext *c = s->priv_data;
1777     int flag_needed = 0;
1778     int i;
1779
1780     for (i = 0; i < c->n_playlists; i++) {
1781         struct playlist *pls = c->playlists[i];
1782
1783         if (pls->has_noheader_flag) {
1784             flag_needed = 1;
1785             break;
1786         }
1787     }
1788
1789     if (flag_needed)
1790         s->ctx_flags |= AVFMTCTX_NOHEADER;
1791     else
1792         s->ctx_flags &= ~AVFMTCTX_NOHEADER;
1793 }
1794
1795 static int hls_close(AVFormatContext *s)
1796 {
1797     HLSContext *c = s->priv_data;
1798
1799     free_playlist_list(c);
1800     free_variant_list(c);
1801     free_rendition_list(c);
1802
1803     av_dict_free(&c->avio_opts);
1804     ff_format_io_close(c->ctx, &c->playlist_pb);
1805
1806     return 0;
1807 }
1808
1809 static int hls_read_header(AVFormatContext *s)
1810 {
1811     HLSContext *c = s->priv_data;
1812     int ret = 0, i;
1813     int highest_cur_seq_no = 0;
1814
1815     c->ctx                = s;
1816     c->interrupt_callback = &s->interrupt_callback;
1817
1818     c->first_packet = 1;
1819     c->first_timestamp = AV_NOPTS_VALUE;
1820     c->cur_timestamp = AV_NOPTS_VALUE;
1821
1822     if ((ret = save_avio_options(s)) < 0)
1823         goto fail;
1824
1825     /* XXX: Some HLS servers don't like being sent the range header,
1826        in this case, need to  setting http_seekable = 0 to disable
1827        the range header */
1828     av_dict_set_int(&c->avio_opts, "seekable", c->http_seekable, 0);
1829
1830     if ((ret = parse_playlist(c, s->url, NULL, s->pb)) < 0)
1831         goto fail;
1832
1833     if (c->n_variants == 0) {
1834         av_log(s, AV_LOG_WARNING, "Empty playlist\n");
1835         ret = AVERROR_EOF;
1836         goto fail;
1837     }
1838     /* If the playlist only contained playlists (Master Playlist),
1839      * parse each individual playlist. */
1840     if (c->n_playlists > 1 || c->playlists[0]->n_segments == 0) {
1841         for (i = 0; i < c->n_playlists; i++) {
1842             struct playlist *pls = c->playlists[i];
1843             pls->m3u8_hold_counters = 0;
1844             if ((ret = parse_playlist(c, pls->url, pls, NULL)) < 0) {
1845                 av_log(s, AV_LOG_WARNING, "parse_playlist error %s [%s]\n", av_err2str(ret), pls->url);
1846                 pls->broken = 1;
1847                 if (c->n_playlists > 1)
1848                     continue;
1849                 goto fail;
1850             }
1851         }
1852     }
1853
1854     for (i = 0; i < c->n_variants; i++) {
1855         if (c->variants[i]->playlists[0]->n_segments == 0) {
1856             av_log(s, AV_LOG_WARNING, "Empty segment [%s]\n", c->variants[i]->playlists[0]->url);
1857             c->variants[i]->playlists[0]->broken = 1;
1858         }
1859     }
1860
1861     /* If this isn't a live stream, calculate the total duration of the
1862      * stream. */
1863     if (c->variants[0]->playlists[0]->finished) {
1864         int64_t duration = 0;
1865         for (i = 0; i < c->variants[0]->playlists[0]->n_segments; i++)
1866             duration += c->variants[0]->playlists[0]->segments[i]->duration;
1867         s->duration = duration;
1868     }
1869
1870     /* Associate renditions with variants */
1871     for (i = 0; i < c->n_variants; i++) {
1872         struct variant *var = c->variants[i];
1873
1874         if (var->audio_group[0])
1875             add_renditions_to_variant(c, var, AVMEDIA_TYPE_AUDIO, var->audio_group);
1876         if (var->video_group[0])
1877             add_renditions_to_variant(c, var, AVMEDIA_TYPE_VIDEO, var->video_group);
1878         if (var->subtitles_group[0])
1879             add_renditions_to_variant(c, var, AVMEDIA_TYPE_SUBTITLE, var->subtitles_group);
1880     }
1881
1882     /* Create a program for each variant */
1883     for (i = 0; i < c->n_variants; i++) {
1884         struct variant *v = c->variants[i];
1885         AVProgram *program;
1886
1887         program = av_new_program(s, i);
1888         if (!program)
1889             goto fail;
1890         av_dict_set_int(&program->metadata, "variant_bitrate", v->bandwidth, 0);
1891     }
1892
1893     /* Select the starting segments */
1894     for (i = 0; i < c->n_playlists; i++) {
1895         struct playlist *pls = c->playlists[i];
1896
1897         if (pls->n_segments == 0)
1898             continue;
1899
1900         pls->cur_seq_no = select_cur_seq_no(c, pls);
1901         highest_cur_seq_no = FFMAX(highest_cur_seq_no, pls->cur_seq_no);
1902     }
1903
1904     /* Open the demuxer for each playlist */
1905     for (i = 0; i < c->n_playlists; i++) {
1906         struct playlist *pls = c->playlists[i];
1907         ff_const59 AVInputFormat *in_fmt = NULL;
1908
1909         if (!(pls->ctx = avformat_alloc_context())) {
1910             ret = AVERROR(ENOMEM);
1911             goto fail;
1912         }
1913
1914         if (pls->n_segments == 0)
1915             continue;
1916
1917         pls->index  = i;
1918         pls->needed = 1;
1919         pls->parent = s;
1920
1921         /*
1922          * If this is a live stream and this playlist looks like it is one segment
1923          * behind, try to sync it up so that every substream starts at the same
1924          * time position (so e.g. avformat_find_stream_info() will see packets from
1925          * all active streams within the first few seconds). This is not very generic,
1926          * though, as the sequence numbers are technically independent.
1927          */
1928         if (!pls->finished && pls->cur_seq_no == highest_cur_seq_no - 1 &&
1929             highest_cur_seq_no < pls->start_seq_no + pls->n_segments) {
1930             pls->cur_seq_no = highest_cur_seq_no;
1931         }
1932
1933         pls->read_buffer = av_malloc(INITIAL_BUFFER_SIZE);
1934         if (!pls->read_buffer){
1935             ret = AVERROR(ENOMEM);
1936             avformat_free_context(pls->ctx);
1937             pls->ctx = NULL;
1938             goto fail;
1939         }
1940         ffio_init_context(&pls->pb, pls->read_buffer, INITIAL_BUFFER_SIZE, 0, pls,
1941                           read_data, NULL, NULL);
1942         pls->ctx->probesize = s->probesize > 0 ? s->probesize : 1024 * 4;
1943         pls->ctx->max_analyze_duration = s->max_analyze_duration > 0 ? s->max_analyze_duration : 4 * AV_TIME_BASE;
1944         ret = av_probe_input_buffer(&pls->pb, &in_fmt, pls->segments[0]->url,
1945                                     NULL, 0, 0);
1946         if (ret < 0) {
1947             /* Free the ctx - it isn't initialized properly at this point,
1948              * so avformat_close_input shouldn't be called. If
1949              * avformat_open_input fails below, it frees and zeros the
1950              * context, so it doesn't need any special treatment like this. */
1951             av_log(s, AV_LOG_ERROR, "Error when loading first segment '%s'\n", pls->segments[0]->url);
1952             avformat_free_context(pls->ctx);
1953             pls->ctx = NULL;
1954             goto fail;
1955         }
1956         pls->ctx->pb       = &pls->pb;
1957         pls->ctx->io_open  = nested_io_open;
1958         pls->ctx->flags   |= s->flags & ~AVFMT_FLAG_CUSTOM_IO;
1959
1960         if ((ret = ff_copy_whiteblacklists(pls->ctx, s)) < 0)
1961             goto fail;
1962
1963         ret = avformat_open_input(&pls->ctx, pls->segments[0]->url, in_fmt, NULL);
1964         if (ret < 0)
1965             goto fail;
1966
1967         if (pls->id3_deferred_extra && pls->ctx->nb_streams == 1) {
1968             ff_id3v2_parse_apic(pls->ctx, pls->id3_deferred_extra);
1969             avformat_queue_attached_pictures(pls->ctx);
1970             ff_id3v2_parse_priv(pls->ctx, pls->id3_deferred_extra);
1971             ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
1972         }
1973
1974         if (pls->is_id3_timestamped == -1)
1975             av_log(s, AV_LOG_WARNING, "No expected HTTP requests have been made\n");
1976
1977         /*
1978          * For ID3 timestamped raw audio streams we need to detect the packet
1979          * durations to calculate timestamps in fill_timing_for_id3_timestamped_stream(),
1980          * but for other streams we can rely on our user calling avformat_find_stream_info()
1981          * on us if they want to.
1982          */
1983         if (pls->is_id3_timestamped || (pls->n_renditions > 0 && pls->renditions[0]->type == AVMEDIA_TYPE_AUDIO)) {
1984             ret = avformat_find_stream_info(pls->ctx, NULL);
1985             if (ret < 0)
1986                 goto fail;
1987         }
1988
1989         pls->has_noheader_flag = !!(pls->ctx->ctx_flags & AVFMTCTX_NOHEADER);
1990
1991         /* Create new AVStreams for each stream in this playlist */
1992         ret = update_streams_from_subdemuxer(s, pls);
1993         if (ret < 0)
1994             goto fail;
1995
1996         /*
1997          * Copy any metadata from playlist to main streams, but do not set
1998          * event flags.
1999          */
2000         if (pls->n_main_streams)
2001             av_dict_copy(&pls->main_streams[0]->metadata, pls->ctx->metadata, 0);
2002
2003         add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_AUDIO);
2004         add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_VIDEO);
2005         add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_SUBTITLE);
2006     }
2007
2008     update_noheader_flag(s);
2009
2010     return 0;
2011 fail:
2012     hls_close(s);
2013     return ret;
2014 }
2015
2016 static int recheck_discard_flags(AVFormatContext *s, int first)
2017 {
2018     HLSContext *c = s->priv_data;
2019     int i, changed = 0;
2020     int cur_needed;
2021
2022     /* Check if any new streams are needed */
2023     for (i = 0; i < c->n_playlists; i++) {
2024         struct playlist *pls = c->playlists[i];
2025
2026         cur_needed = playlist_needed(c->playlists[i]);
2027
2028         if (pls->broken) {
2029             continue;
2030         }
2031         if (cur_needed && !pls->needed) {
2032             pls->needed = 1;
2033             changed = 1;
2034             pls->cur_seq_no = select_cur_seq_no(c, pls);
2035             pls->pb.eof_reached = 0;
2036             if (c->cur_timestamp != AV_NOPTS_VALUE) {
2037                 /* catch up */
2038                 pls->seek_timestamp = c->cur_timestamp;
2039                 pls->seek_flags = AVSEEK_FLAG_ANY;
2040                 pls->seek_stream_index = -1;
2041             }
2042             av_log(s, AV_LOG_INFO, "Now receiving playlist %d, segment %d\n", i, pls->cur_seq_no);
2043         } else if (first && !cur_needed && pls->needed) {
2044             ff_format_io_close(pls->parent, &pls->input);
2045             pls->input_read_done = 0;
2046             ff_format_io_close(pls->parent, &pls->input_next);
2047             pls->input_next_requested = 0;
2048             pls->needed = 0;
2049             changed = 1;
2050             av_log(s, AV_LOG_INFO, "No longer receiving playlist %d\n", i);
2051         }
2052     }
2053     return changed;
2054 }
2055
2056 static void fill_timing_for_id3_timestamped_stream(struct playlist *pls)
2057 {
2058     if (pls->id3_offset >= 0) {
2059         pls->pkt.dts = pls->id3_mpegts_timestamp +
2060                                  av_rescale_q(pls->id3_offset,
2061                                               pls->ctx->streams[pls->pkt.stream_index]->time_base,
2062                                               MPEG_TIME_BASE_Q);
2063         if (pls->pkt.duration)
2064             pls->id3_offset += pls->pkt.duration;
2065         else
2066             pls->id3_offset = -1;
2067     } else {
2068         /* there have been packets with unknown duration
2069          * since the last id3 tag, should not normally happen */
2070         pls->pkt.dts = AV_NOPTS_VALUE;
2071     }
2072
2073     if (pls->pkt.duration)
2074         pls->pkt.duration = av_rescale_q(pls->pkt.duration,
2075                                          pls->ctx->streams[pls->pkt.stream_index]->time_base,
2076                                          MPEG_TIME_BASE_Q);
2077
2078     pls->pkt.pts = AV_NOPTS_VALUE;
2079 }
2080
2081 static AVRational get_timebase(struct playlist *pls)
2082 {
2083     if (pls->is_id3_timestamped)
2084         return MPEG_TIME_BASE_Q;
2085
2086     return pls->ctx->streams[pls->pkt.stream_index]->time_base;
2087 }
2088
2089 static int compare_ts_with_wrapdetect(int64_t ts_a, struct playlist *pls_a,
2090                                       int64_t ts_b, struct playlist *pls_b)
2091 {
2092     int64_t scaled_ts_a = av_rescale_q(ts_a, get_timebase(pls_a), MPEG_TIME_BASE_Q);
2093     int64_t scaled_ts_b = av_rescale_q(ts_b, get_timebase(pls_b), MPEG_TIME_BASE_Q);
2094
2095     return av_compare_mod(scaled_ts_a, scaled_ts_b, 1LL << 33);
2096 }
2097
2098 static int hls_read_packet(AVFormatContext *s, AVPacket *pkt)
2099 {
2100     HLSContext *c = s->priv_data;
2101     int ret, i, minplaylist = -1;
2102
2103     recheck_discard_flags(s, c->first_packet);
2104     c->first_packet = 0;
2105
2106     for (i = 0; i < c->n_playlists; i++) {
2107         struct playlist *pls = c->playlists[i];
2108         /* Make sure we've got one buffered packet from each open playlist
2109          * stream */
2110         if (pls->needed && !pls->pkt.data) {
2111             while (1) {
2112                 int64_t ts_diff;
2113                 AVRational tb;
2114                 ret = av_read_frame(pls->ctx, &pls->pkt);
2115                 if (ret < 0) {
2116                     if (!avio_feof(&pls->pb) && ret != AVERROR_EOF)
2117                         return ret;
2118                     reset_packet(&pls->pkt);
2119                     break;
2120                 } else {
2121                     /* stream_index check prevents matching picture attachments etc. */
2122                     if (pls->is_id3_timestamped && pls->pkt.stream_index == 0) {
2123                         /* audio elementary streams are id3 timestamped */
2124                         fill_timing_for_id3_timestamped_stream(pls);
2125                     }
2126
2127                     if (c->first_timestamp == AV_NOPTS_VALUE &&
2128                         pls->pkt.dts       != AV_NOPTS_VALUE)
2129                         c->first_timestamp = av_rescale_q(pls->pkt.dts,
2130                             get_timebase(pls), AV_TIME_BASE_Q);
2131                 }
2132
2133                 if (pls->seek_timestamp == AV_NOPTS_VALUE)
2134                     break;
2135
2136                 if (pls->seek_stream_index < 0 ||
2137                     pls->seek_stream_index == pls->pkt.stream_index) {
2138
2139                     if (pls->pkt.dts == AV_NOPTS_VALUE) {
2140                         pls->seek_timestamp = AV_NOPTS_VALUE;
2141                         break;
2142                     }
2143
2144                     tb = get_timebase(pls);
2145                     ts_diff = av_rescale_rnd(pls->pkt.dts, AV_TIME_BASE,
2146                                             tb.den, AV_ROUND_DOWN) -
2147                             pls->seek_timestamp;
2148                     if (ts_diff >= 0 && (pls->seek_flags  & AVSEEK_FLAG_ANY ||
2149                                         pls->pkt.flags & AV_PKT_FLAG_KEY)) {
2150                         pls->seek_timestamp = AV_NOPTS_VALUE;
2151                         break;
2152                     }
2153                 }
2154                 av_packet_unref(&pls->pkt);
2155             }
2156         }
2157         /* Check if this stream has the packet with the lowest dts */
2158         if (pls->pkt.data) {
2159             struct playlist *minpls = minplaylist < 0 ?
2160                                      NULL : c->playlists[minplaylist];
2161             if (minplaylist < 0) {
2162                 minplaylist = i;
2163             } else {
2164                 int64_t dts     =    pls->pkt.dts;
2165                 int64_t mindts  = minpls->pkt.dts;
2166
2167                 if (dts == AV_NOPTS_VALUE ||
2168                     (mindts != AV_NOPTS_VALUE && compare_ts_with_wrapdetect(dts, pls, mindts, minpls) < 0))
2169                     minplaylist = i;
2170             }
2171         }
2172     }
2173
2174     /* If we got a packet, return it */
2175     if (minplaylist >= 0) {
2176         struct playlist *pls = c->playlists[minplaylist];
2177         AVStream *ist;
2178         AVStream *st;
2179
2180         ret = update_streams_from_subdemuxer(s, pls);
2181         if (ret < 0) {
2182             av_packet_unref(&pls->pkt);
2183             return ret;
2184         }
2185
2186         // If sub-demuxer reports updated metadata, copy it to the first stream
2187         // and set its AVSTREAM_EVENT_FLAG_METADATA_UPDATED flag.
2188         if (pls->ctx->event_flags & AVFMT_EVENT_FLAG_METADATA_UPDATED) {
2189             if (pls->n_main_streams) {
2190                 st = pls->main_streams[0];
2191                 av_dict_copy(&st->metadata, pls->ctx->metadata, 0);
2192                 st->event_flags |= AVSTREAM_EVENT_FLAG_METADATA_UPDATED;
2193             }
2194             pls->ctx->event_flags &= ~AVFMT_EVENT_FLAG_METADATA_UPDATED;
2195         }
2196
2197         /* check if noheader flag has been cleared by the subdemuxer */
2198         if (pls->has_noheader_flag && !(pls->ctx->ctx_flags & AVFMTCTX_NOHEADER)) {
2199             pls->has_noheader_flag = 0;
2200             update_noheader_flag(s);
2201         }
2202
2203         if (pls->pkt.stream_index >= pls->n_main_streams) {
2204             av_log(s, AV_LOG_ERROR, "stream index inconsistency: index %d, %d main streams, %d subdemuxer streams\n",
2205                    pls->pkt.stream_index, pls->n_main_streams, pls->ctx->nb_streams);
2206             av_packet_unref(&pls->pkt);
2207             return AVERROR_BUG;
2208         }
2209
2210         ist = pls->ctx->streams[pls->pkt.stream_index];
2211         st = pls->main_streams[pls->pkt.stream_index];
2212
2213         av_packet_move_ref(pkt, &pls->pkt);
2214         pkt->stream_index = st->index;
2215
2216         if (pkt->dts != AV_NOPTS_VALUE)
2217             c->cur_timestamp = av_rescale_q(pkt->dts,
2218                                             ist->time_base,
2219                                             AV_TIME_BASE_Q);
2220
2221         /* There may be more situations where this would be useful, but this at least
2222          * handles newly probed codecs properly (i.e. request_probe by mpegts). */
2223         if (ist->codecpar->codec_id != st->codecpar->codec_id) {
2224             ret = set_stream_info_from_input_stream(st, pls, ist);
2225             if (ret < 0) {
2226                 return ret;
2227             }
2228         }
2229
2230         return 0;
2231     }
2232     return AVERROR_EOF;
2233 }
2234
2235 static int hls_read_seek(AVFormatContext *s, int stream_index,
2236                                int64_t timestamp, int flags)
2237 {
2238     HLSContext *c = s->priv_data;
2239     struct playlist *seek_pls = NULL;
2240     int i, seq_no;
2241     int j;
2242     int stream_subdemuxer_index;
2243     int64_t first_timestamp, seek_timestamp, duration;
2244
2245     if ((flags & AVSEEK_FLAG_BYTE) || (c->ctx->ctx_flags & AVFMTCTX_UNSEEKABLE))
2246         return AVERROR(ENOSYS);
2247
2248     first_timestamp = c->first_timestamp == AV_NOPTS_VALUE ?
2249                       0 : c->first_timestamp;
2250
2251     seek_timestamp = av_rescale_rnd(timestamp, AV_TIME_BASE,
2252                                     s->streams[stream_index]->time_base.den,
2253                                     flags & AVSEEK_FLAG_BACKWARD ?
2254                                     AV_ROUND_DOWN : AV_ROUND_UP);
2255
2256     duration = s->duration == AV_NOPTS_VALUE ?
2257                0 : s->duration;
2258
2259     if (0 < duration && duration < seek_timestamp - first_timestamp)
2260         return AVERROR(EIO);
2261
2262     /* find the playlist with the specified stream */
2263     for (i = 0; i < c->n_playlists; i++) {
2264         struct playlist *pls = c->playlists[i];
2265         for (j = 0; j < pls->n_main_streams; j++) {
2266             if (pls->main_streams[j] == s->streams[stream_index]) {
2267                 seek_pls = pls;
2268                 stream_subdemuxer_index = j;
2269                 break;
2270             }
2271         }
2272     }
2273     /* check if the timestamp is valid for the playlist with the
2274      * specified stream index */
2275     if (!seek_pls || !find_timestamp_in_playlist(c, seek_pls, seek_timestamp, &seq_no))
2276         return AVERROR(EIO);
2277
2278     /* set segment now so we do not need to search again below */
2279     seek_pls->cur_seq_no = seq_no;
2280     seek_pls->seek_stream_index = stream_subdemuxer_index;
2281
2282     for (i = 0; i < c->n_playlists; i++) {
2283         /* Reset reading */
2284         struct playlist *pls = c->playlists[i];
2285         ff_format_io_close(pls->parent, &pls->input);
2286         pls->input_read_done = 0;
2287         ff_format_io_close(pls->parent, &pls->input_next);
2288         pls->input_next_requested = 0;
2289         av_packet_unref(&pls->pkt);
2290         pls->pb.eof_reached = 0;
2291         /* Clear any buffered data */
2292         pls->pb.buf_end = pls->pb.buf_ptr = pls->pb.buffer;
2293         /* Reset the pos, to let the mpegts demuxer know we've seeked. */
2294         pls->pb.pos = 0;
2295         /* Flush the packet queue of the subdemuxer. */
2296         ff_read_frame_flush(pls->ctx);
2297
2298         pls->seek_timestamp = seek_timestamp;
2299         pls->seek_flags = flags;
2300
2301         if (pls != seek_pls) {
2302             /* set closest segment seq_no for playlists not handled above */
2303             find_timestamp_in_playlist(c, pls, seek_timestamp, &pls->cur_seq_no);
2304             /* seek the playlist to the given position without taking
2305              * keyframes into account since this playlist does not have the
2306              * specified stream where we should look for the keyframes */
2307             pls->seek_stream_index = -1;
2308             pls->seek_flags |= AVSEEK_FLAG_ANY;
2309         }
2310     }
2311
2312     c->cur_timestamp = seek_timestamp;
2313
2314     return 0;
2315 }
2316
2317 static int hls_probe(const AVProbeData *p)
2318 {
2319     /* Require #EXTM3U at the start, and either one of the ones below
2320      * somewhere for a proper match. */
2321     if (strncmp(p->buf, "#EXTM3U", 7))
2322         return 0;
2323
2324     if (strstr(p->buf, "#EXT-X-STREAM-INF:")     ||
2325         strstr(p->buf, "#EXT-X-TARGETDURATION:") ||
2326         strstr(p->buf, "#EXT-X-MEDIA-SEQUENCE:"))
2327         return AVPROBE_SCORE_MAX;
2328     return 0;
2329 }
2330
2331 #define OFFSET(x) offsetof(HLSContext, x)
2332 #define FLAGS AV_OPT_FLAG_DECODING_PARAM
2333 static const AVOption hls_options[] = {
2334     {"live_start_index", "segment index to start live streams at (negative values are from the end)",
2335         OFFSET(live_start_index), AV_OPT_TYPE_INT, {.i64 = -3}, INT_MIN, INT_MAX, FLAGS},
2336     {"allowed_extensions", "List of file extensions that hls is allowed to access",
2337         OFFSET(allowed_extensions), AV_OPT_TYPE_STRING,
2338         {.str = "3gp,aac,avi,flac,mkv,m3u8,m4a,m4s,m4v,mpg,mov,mp2,mp3,mp4,mpeg,mpegts,ogg,ogv,oga,ts,vob,wav"},
2339         INT_MIN, INT_MAX, FLAGS},
2340     {"max_reload", "Maximum number of times a insufficient list is attempted to be reloaded",
2341         OFFSET(max_reload), AV_OPT_TYPE_INT, {.i64 = 1000}, 0, INT_MAX, FLAGS},
2342     {"m3u8_hold_counters", "The maximum number of times to load m3u8 when it refreshes without new segments",
2343         OFFSET(m3u8_hold_counters), AV_OPT_TYPE_INT, {.i64 = 1000}, 0, INT_MAX, FLAGS},
2344     {"http_persistent", "Use persistent HTTP connections",
2345         OFFSET(http_persistent), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, FLAGS },
2346     {"http_multiple", "Use multiple HTTP connections for fetching segments",
2347         OFFSET(http_multiple), AV_OPT_TYPE_BOOL, {.i64 = -1}, -1, 1, FLAGS},
2348     {"http_seekable", "Use HTTP partial requests, 0 = disable, 1 = enable, -1 = auto",
2349         OFFSET(http_seekable), AV_OPT_TYPE_BOOL, { .i64 = -1}, -1, 1, FLAGS},
2350     {NULL}
2351 };
2352
2353 static const AVClass hls_class = {
2354     .class_name = "hls demuxer",
2355     .item_name  = av_default_item_name,
2356     .option     = hls_options,
2357     .version    = LIBAVUTIL_VERSION_INT,
2358 };
2359
2360 AVInputFormat ff_hls_demuxer = {
2361     .name           = "hls",
2362     .long_name      = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
2363     .priv_class     = &hls_class,
2364     .priv_data_size = sizeof(HLSContext),
2365     .flags          = AVFMT_NOGENSEARCH | AVFMT_TS_DISCONT,
2366     .read_probe     = hls_probe,
2367     .read_header    = hls_read_header,
2368     .read_packet    = hls_read_packet,
2369     .read_close     = hls_close,
2370     .read_seek      = hls_read_seek,
2371 };