]> git.sesse.net Git - ffmpeg/blob - libavformat/hls.c
lavf/webvttenc: Require webvtt file to contain exactly one WebVTT stream.
[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 "libavutil/avstring.h"
30 #include "libavutil/avassert.h"
31 #include "libavutil/intreadwrite.h"
32 #include "libavutil/mathematics.h"
33 #include "libavutil/opt.h"
34 #include "libavutil/dict.h"
35 #include "libavutil/time.h"
36 #include "avformat.h"
37 #include "internal.h"
38 #include "avio_internal.h"
39 #include "url.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 };
77
78 struct rendition;
79
80 enum PlaylistType {
81     PLS_TYPE_UNSPECIFIED,
82     PLS_TYPE_EVENT,
83     PLS_TYPE_VOD
84 };
85
86 /*
87  * Each playlist has its own demuxer. If it currently is active,
88  * it has an open AVIOContext too, and potentially an AVPacket
89  * containing the next packet from this stream.
90  */
91 struct playlist {
92     char url[MAX_URL_SIZE];
93     AVIOContext pb;
94     uint8_t* read_buffer;
95     URLContext *input;
96     AVFormatContext *parent;
97     int index;
98     AVFormatContext *ctx;
99     AVPacket pkt;
100     int stream_offset;
101
102     int finished;
103     enum PlaylistType type;
104     int64_t target_duration;
105     int start_seq_no;
106     int n_segments;
107     struct segment **segments;
108     int needed, cur_needed;
109     int cur_seq_no;
110     int64_t cur_seg_offset;
111     int64_t last_load_time;
112
113     char key_url[MAX_URL_SIZE];
114     uint8_t key[16];
115
116     /* ID3 timestamp handling (elementary audio streams have ID3 timestamps
117      * (and possibly other ID3 tags) in the beginning of each segment) */
118     int is_id3_timestamped; /* -1: not yet known */
119     int64_t id3_mpegts_timestamp; /* in mpegts tb */
120     int64_t id3_offset; /* in stream original tb */
121     uint8_t* id3_buf; /* temp buffer for id3 parsing */
122     unsigned int id3_buf_size;
123     AVDictionary *id3_initial; /* data from first id3 tag */
124     int id3_found; /* ID3 tag found at some point */
125     int id3_changed; /* ID3 tag data has changed at some point */
126     ID3v2ExtraMeta *id3_deferred_extra; /* stored here until subdemuxer is opened */
127
128     int64_t seek_timestamp;
129     int seek_flags;
130     int seek_stream_index; /* into subdemuxer stream array */
131
132     /* Renditions associated with this playlist, if any.
133      * Alternative rendition playlists have a single rendition associated
134      * with them, and variant main Media Playlists may have
135      * multiple (playlist-less) renditions associated with them. */
136     int n_renditions;
137     struct rendition **renditions;
138 };
139
140 /*
141  * Renditions are e.g. alternative subtitle or audio streams.
142  * The rendition may either be an external playlist or it may be
143  * contained in the main Media Playlist of the variant (in which case
144  * playlist is NULL).
145  */
146 struct rendition {
147     enum AVMediaType type;
148     struct playlist *playlist;
149     char group_id[MAX_FIELD_LEN];
150     char language[MAX_FIELD_LEN];
151     char name[MAX_FIELD_LEN];
152     int disposition;
153 };
154
155 struct variant {
156     int bandwidth;
157
158     /* every variant contains at least the main Media Playlist in index 0 */
159     int n_playlists;
160     struct playlist **playlists;
161
162     char audio_group[MAX_FIELD_LEN];
163     char video_group[MAX_FIELD_LEN];
164     char subtitles_group[MAX_FIELD_LEN];
165 };
166
167 typedef struct HLSContext {
168     AVClass *class;
169     int n_variants;
170     struct variant **variants;
171     int n_playlists;
172     struct playlist **playlists;
173     int n_renditions;
174     struct rendition **renditions;
175
176     int cur_seq_no;
177     int live_start_index;
178     int first_packet;
179     int64_t first_timestamp;
180     int64_t cur_timestamp;
181     AVIOInterruptCB *interrupt_callback;
182     char *user_agent;                    ///< holds HTTP user agent set as an AVOption to the HTTP protocol context
183     char *cookies;                       ///< holds HTTP cookie values set in either the initial response or as an AVOption to the HTTP protocol context
184     char *headers;                       ///< holds HTTP headers set as an AVOption to the HTTP protocol context
185     AVDictionary *avio_opts;
186 } HLSContext;
187
188 static int read_chomp_line(AVIOContext *s, char *buf, int maxlen)
189 {
190     int len = ff_get_line(s, buf, maxlen);
191     while (len > 0 && av_isspace(buf[len - 1]))
192         buf[--len] = '\0';
193     return len;
194 }
195
196 static void free_segment_list(struct playlist *pls)
197 {
198     int i;
199     for (i = 0; i < pls->n_segments; i++) {
200         av_freep(&pls->segments[i]->key);
201         av_freep(&pls->segments[i]->url);
202         av_freep(&pls->segments[i]);
203     }
204     av_freep(&pls->segments);
205     pls->n_segments = 0;
206 }
207
208 static void free_playlist_list(HLSContext *c)
209 {
210     int i;
211     for (i = 0; i < c->n_playlists; i++) {
212         struct playlist *pls = c->playlists[i];
213         free_segment_list(pls);
214         av_freep(&pls->renditions);
215         av_freep(&pls->id3_buf);
216         av_dict_free(&pls->id3_initial);
217         ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
218         av_free_packet(&pls->pkt);
219         av_freep(&pls->pb.buffer);
220         if (pls->input)
221             ffurl_close(pls->input);
222         if (pls->ctx) {
223             pls->ctx->pb = NULL;
224             avformat_close_input(&pls->ctx);
225         }
226         av_free(pls);
227     }
228     av_freep(&c->playlists);
229     av_freep(&c->cookies);
230     av_freep(&c->user_agent);
231     c->n_playlists = 0;
232 }
233
234 static void free_variant_list(HLSContext *c)
235 {
236     int i;
237     for (i = 0; i < c->n_variants; i++) {
238         struct variant *var = c->variants[i];
239         av_freep(&var->playlists);
240         av_free(var);
241     }
242     av_freep(&c->variants);
243     c->n_variants = 0;
244 }
245
246 static void free_rendition_list(HLSContext *c)
247 {
248     int i;
249     for (i = 0; i < c->n_renditions; i++)
250         av_freep(&c->renditions[i]);
251     av_freep(&c->renditions);
252     c->n_renditions = 0;
253 }
254
255 /*
256  * Used to reset a statically allocated AVPacket to a clean slate,
257  * containing no data.
258  */
259 static void reset_packet(AVPacket *pkt)
260 {
261     av_init_packet(pkt);
262     pkt->data = NULL;
263 }
264
265 static struct playlist *new_playlist(HLSContext *c, const char *url,
266                                      const char *base)
267 {
268     struct playlist *pls = av_mallocz(sizeof(struct playlist));
269     if (!pls)
270         return NULL;
271     reset_packet(&pls->pkt);
272     ff_make_absolute_url(pls->url, sizeof(pls->url), base, url);
273     pls->seek_timestamp = AV_NOPTS_VALUE;
274
275     pls->is_id3_timestamped = -1;
276     pls->id3_mpegts_timestamp = AV_NOPTS_VALUE;
277
278     dynarray_add(&c->playlists, &c->n_playlists, pls);
279     return pls;
280 }
281
282 struct variant_info {
283     char bandwidth[20];
284     /* variant group ids: */
285     char audio[MAX_FIELD_LEN];
286     char video[MAX_FIELD_LEN];
287     char subtitles[MAX_FIELD_LEN];
288 };
289
290 static struct variant *new_variant(HLSContext *c, struct variant_info *info,
291                                    const char *url, const char *base)
292 {
293     struct variant *var;
294     struct playlist *pls;
295
296     pls = new_playlist(c, url, base);
297     if (!pls)
298         return NULL;
299
300     var = av_mallocz(sizeof(struct variant));
301     if (!var)
302         return NULL;
303
304     if (info) {
305         var->bandwidth = atoi(info->bandwidth);
306         strcpy(var->audio_group, info->audio);
307         strcpy(var->video_group, info->video);
308         strcpy(var->subtitles_group, info->subtitles);
309     }
310
311     dynarray_add(&c->variants, &c->n_variants, var);
312     dynarray_add(&var->playlists, &var->n_playlists, pls);
313     return var;
314 }
315
316 static void handle_variant_args(struct variant_info *info, const char *key,
317                                 int key_len, char **dest, int *dest_len)
318 {
319     if (!strncmp(key, "BANDWIDTH=", key_len)) {
320         *dest     =        info->bandwidth;
321         *dest_len = sizeof(info->bandwidth);
322     } else if (!strncmp(key, "AUDIO=", key_len)) {
323         *dest     =        info->audio;
324         *dest_len = sizeof(info->audio);
325     } else if (!strncmp(key, "VIDEO=", key_len)) {
326         *dest     =        info->video;
327         *dest_len = sizeof(info->video);
328     } else if (!strncmp(key, "SUBTITLES=", key_len)) {
329         *dest     =        info->subtitles;
330         *dest_len = sizeof(info->subtitles);
331     }
332 }
333
334 struct key_info {
335      char uri[MAX_URL_SIZE];
336      char method[11];
337      char iv[35];
338 };
339
340 static void handle_key_args(struct key_info *info, const char *key,
341                             int key_len, char **dest, int *dest_len)
342 {
343     if (!strncmp(key, "METHOD=", key_len)) {
344         *dest     =        info->method;
345         *dest_len = sizeof(info->method);
346     } else if (!strncmp(key, "URI=", key_len)) {
347         *dest     =        info->uri;
348         *dest_len = sizeof(info->uri);
349     } else if (!strncmp(key, "IV=", key_len)) {
350         *dest     =        info->iv;
351         *dest_len = sizeof(info->iv);
352     }
353 }
354
355 struct rendition_info {
356     char type[16];
357     char uri[MAX_URL_SIZE];
358     char group_id[MAX_FIELD_LEN];
359     char language[MAX_FIELD_LEN];
360     char assoc_language[MAX_FIELD_LEN];
361     char name[MAX_FIELD_LEN];
362     char defaultr[4];
363     char forced[4];
364     char characteristics[MAX_CHARACTERISTICS_LEN];
365 };
366
367 static struct rendition *new_rendition(HLSContext *c, struct rendition_info *info,
368                                       const char *url_base)
369 {
370     struct rendition *rend;
371     enum AVMediaType type = AVMEDIA_TYPE_UNKNOWN;
372     char *characteristic;
373     char *chr_ptr;
374     char *saveptr;
375
376     if (!strcmp(info->type, "AUDIO"))
377         type = AVMEDIA_TYPE_AUDIO;
378     else if (!strcmp(info->type, "VIDEO"))
379         type = AVMEDIA_TYPE_VIDEO;
380     else if (!strcmp(info->type, "SUBTITLES"))
381         type = AVMEDIA_TYPE_SUBTITLE;
382     else if (!strcmp(info->type, "CLOSED-CAPTIONS"))
383         /* CLOSED-CAPTIONS is ignored since we do not support CEA-608 CC in
384          * AVC SEI RBSP anyway */
385         return NULL;
386
387     if (type == AVMEDIA_TYPE_UNKNOWN)
388         return NULL;
389
390     /* URI is mandatory for subtitles as per spec */
391     if (type == AVMEDIA_TYPE_SUBTITLE && !info->uri[0])
392         return NULL;
393
394     /* TODO: handle subtitles (each segment has to parsed separately) */
395     if (type == AVMEDIA_TYPE_SUBTITLE)
396         return NULL;
397
398     rend = av_mallocz(sizeof(struct rendition));
399     if (!rend)
400         return NULL;
401
402     dynarray_add(&c->renditions, &c->n_renditions, rend);
403
404     rend->type = type;
405     strcpy(rend->group_id, info->group_id);
406     strcpy(rend->language, info->language);
407     strcpy(rend->name, info->name);
408
409     /* add the playlist if this is an external rendition */
410     if (info->uri[0]) {
411         rend->playlist = new_playlist(c, info->uri, url_base);
412         if (rend->playlist)
413             dynarray_add(&rend->playlist->renditions,
414                          &rend->playlist->n_renditions, rend);
415     }
416
417     if (info->assoc_language[0]) {
418         int langlen = strlen(rend->language);
419         if (langlen < sizeof(rend->language) - 3) {
420             rend->language[langlen] = ',';
421             strncpy(rend->language + langlen + 1, info->assoc_language,
422                     sizeof(rend->language) - langlen - 2);
423         }
424     }
425
426     if (!strcmp(info->defaultr, "YES"))
427         rend->disposition |= AV_DISPOSITION_DEFAULT;
428     if (!strcmp(info->forced, "YES"))
429         rend->disposition |= AV_DISPOSITION_FORCED;
430
431     chr_ptr = info->characteristics;
432     while ((characteristic = av_strtok(chr_ptr, ",", &saveptr))) {
433         if (!strcmp(characteristic, "public.accessibility.describes-music-and-sound"))
434             rend->disposition |= AV_DISPOSITION_HEARING_IMPAIRED;
435         else if (!strcmp(characteristic, "public.accessibility.describes-video"))
436             rend->disposition |= AV_DISPOSITION_VISUAL_IMPAIRED;
437
438         chr_ptr = NULL;
439     }
440
441     return rend;
442 }
443
444 static void handle_rendition_args(struct rendition_info *info, const char *key,
445                                   int key_len, char **dest, int *dest_len)
446 {
447     if (!strncmp(key, "TYPE=", key_len)) {
448         *dest     =        info->type;
449         *dest_len = sizeof(info->type);
450     } else if (!strncmp(key, "URI=", key_len)) {
451         *dest     =        info->uri;
452         *dest_len = sizeof(info->uri);
453     } else if (!strncmp(key, "GROUP-ID=", key_len)) {
454         *dest     =        info->group_id;
455         *dest_len = sizeof(info->group_id);
456     } else if (!strncmp(key, "LANGUAGE=", key_len)) {
457         *dest     =        info->language;
458         *dest_len = sizeof(info->language);
459     } else if (!strncmp(key, "ASSOC-LANGUAGE=", key_len)) {
460         *dest     =        info->assoc_language;
461         *dest_len = sizeof(info->assoc_language);
462     } else if (!strncmp(key, "NAME=", key_len)) {
463         *dest     =        info->name;
464         *dest_len = sizeof(info->name);
465     } else if (!strncmp(key, "DEFAULT=", key_len)) {
466         *dest     =        info->defaultr;
467         *dest_len = sizeof(info->defaultr);
468     } else if (!strncmp(key, "FORCED=", key_len)) {
469         *dest     =        info->forced;
470         *dest_len = sizeof(info->forced);
471     } else if (!strncmp(key, "CHARACTERISTICS=", key_len)) {
472         *dest     =        info->characteristics;
473         *dest_len = sizeof(info->characteristics);
474     }
475     /*
476      * ignored:
477      * - AUTOSELECT: client may autoselect based on e.g. system language
478      * - INSTREAM-ID: EIA-608 closed caption number ("CC1".."CC4")
479      */
480 }
481
482 /* used by parse_playlist to allocate a new variant+playlist when the
483  * playlist is detected to be a Media Playlist (not Master Playlist)
484  * and we have no parent Master Playlist (parsing of which would have
485  * allocated the variant and playlist already)
486  * *pls == NULL  => Master Playlist or parentless Media Playlist
487  * *pls != NULL => parented Media Playlist, playlist+variant allocated */
488 static int ensure_playlist(HLSContext *c, struct playlist **pls, const char *url)
489 {
490     if (*pls)
491         return 0;
492     if (!new_variant(c, NULL, url, NULL))
493         return AVERROR(ENOMEM);
494     *pls = c->playlists[c->n_playlists - 1];
495     return 0;
496 }
497
498 static int open_in(HLSContext *c, AVIOContext **in, const char *url)
499 {
500     AVDictionary *tmp = NULL;
501     int ret;
502
503     av_dict_copy(&tmp, c->avio_opts, 0);
504
505     ret = avio_open2(in, url, AVIO_FLAG_READ, c->interrupt_callback, &tmp);
506
507     av_dict_free(&tmp);
508     return ret;
509 }
510
511 static int url_connect(struct playlist *pls, AVDictionary *opts, AVDictionary *opts2)
512 {
513     AVDictionary *tmp = NULL;
514     int ret;
515
516     av_dict_copy(&tmp, opts, 0);
517     av_dict_copy(&tmp, opts2, 0);
518
519     if ((ret = av_opt_set_dict(pls->input, &tmp)) < 0)
520         goto fail;
521
522     if ((ret = ffurl_connect(pls->input, NULL)) < 0) {
523         ffurl_close(pls->input);
524         pls->input = NULL;
525     }
526
527 fail:
528     av_dict_free(&tmp);
529     return ret;
530 }
531
532 static int open_url(HLSContext *c, URLContext **uc, const char *url, AVDictionary *opts)
533 {
534     AVDictionary *tmp = NULL;
535     int ret;
536
537     av_dict_copy(&tmp, c->avio_opts, 0);
538     av_dict_copy(&tmp, opts, 0);
539
540     ret = ffurl_open(uc, url, AVIO_FLAG_READ, c->interrupt_callback, &tmp);
541
542     av_dict_free(&tmp);
543
544     return ret;
545 }
546
547 static int parse_playlist(HLSContext *c, const char *url,
548                           struct playlist *pls, AVIOContext *in)
549 {
550     int ret = 0, is_segment = 0, is_variant = 0;
551     int64_t duration = 0;
552     enum KeyType key_type = KEY_NONE;
553     uint8_t iv[16] = "";
554     int has_iv = 0;
555     char key[MAX_URL_SIZE] = "";
556     char line[MAX_URL_SIZE];
557     const char *ptr;
558     int close_in = 0;
559     int64_t seg_offset = 0;
560     int64_t seg_size = -1;
561     uint8_t *new_url = NULL;
562     struct variant_info variant_info;
563     char tmp_str[MAX_URL_SIZE];
564
565     if (!in) {
566 #if 1
567         AVDictionary *opts = NULL;
568         close_in = 1;
569         /* Some HLS servers don't like being sent the range header */
570         av_dict_set(&opts, "seekable", "0", 0);
571
572         // broker prior HTTP options that should be consistent across requests
573         av_dict_set(&opts, "user-agent", c->user_agent, 0);
574         av_dict_set(&opts, "cookies", c->cookies, 0);
575         av_dict_set(&opts, "headers", c->headers, 0);
576
577         ret = avio_open2(&in, url, AVIO_FLAG_READ,
578                          c->interrupt_callback, &opts);
579         av_dict_free(&opts);
580         if (ret < 0)
581             return ret;
582 #else
583         ret = open_in(c, &in, url);
584         if (ret < 0)
585             return ret;
586         close_in = 1;
587 #endif
588     }
589
590     if (av_opt_get(in, "location", AV_OPT_SEARCH_CHILDREN, &new_url) >= 0)
591         url = new_url;
592
593     read_chomp_line(in, line, sizeof(line));
594     if (strcmp(line, "#EXTM3U")) {
595         ret = AVERROR_INVALIDDATA;
596         goto fail;
597     }
598
599     if (pls) {
600         free_segment_list(pls);
601         pls->finished = 0;
602         pls->type = PLS_TYPE_UNSPECIFIED;
603     }
604     while (!avio_feof(in)) {
605         read_chomp_line(in, line, sizeof(line));
606         if (av_strstart(line, "#EXT-X-STREAM-INF:", &ptr)) {
607             is_variant = 1;
608             memset(&variant_info, 0, sizeof(variant_info));
609             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_variant_args,
610                                &variant_info);
611         } else if (av_strstart(line, "#EXT-X-KEY:", &ptr)) {
612             struct key_info info = {{0}};
613             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_key_args,
614                                &info);
615             key_type = KEY_NONE;
616             has_iv = 0;
617             if (!strcmp(info.method, "AES-128"))
618                 key_type = KEY_AES_128;
619             if (!strcmp(info.method, "SAMPLE-AES"))
620                 key_type = KEY_SAMPLE_AES;
621             if (!strncmp(info.iv, "0x", 2) || !strncmp(info.iv, "0X", 2)) {
622                 ff_hex_to_data(iv, info.iv + 2);
623                 has_iv = 1;
624             }
625             av_strlcpy(key, info.uri, sizeof(key));
626         } else if (av_strstart(line, "#EXT-X-MEDIA:", &ptr)) {
627             struct rendition_info info = {{0}};
628             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_rendition_args,
629                                &info);
630             new_rendition(c, &info, url);
631         } else if (av_strstart(line, "#EXT-X-TARGETDURATION:", &ptr)) {
632             ret = ensure_playlist(c, &pls, url);
633             if (ret < 0)
634                 goto fail;
635             pls->target_duration = atoi(ptr) * AV_TIME_BASE;
636         } else if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
637             ret = ensure_playlist(c, &pls, url);
638             if (ret < 0)
639                 goto fail;
640             pls->start_seq_no = atoi(ptr);
641         } else if (av_strstart(line, "#EXT-X-PLAYLIST-TYPE:", &ptr)) {
642             ret = ensure_playlist(c, &pls, url);
643             if (ret < 0)
644                 goto fail;
645             if (!strcmp(ptr, "EVENT"))
646                 pls->type = PLS_TYPE_EVENT;
647             else if (!strcmp(ptr, "VOD"))
648                 pls->type = PLS_TYPE_VOD;
649         } else if (av_strstart(line, "#EXT-X-ENDLIST", &ptr)) {
650             if (pls)
651                 pls->finished = 1;
652         } else if (av_strstart(line, "#EXTINF:", &ptr)) {
653             is_segment = 1;
654             duration   = atof(ptr) * AV_TIME_BASE;
655         } else if (av_strstart(line, "#EXT-X-BYTERANGE:", &ptr)) {
656             seg_size = atoi(ptr);
657             ptr = strchr(ptr, '@');
658             if (ptr)
659                 seg_offset = atoi(ptr+1);
660         } else if (av_strstart(line, "#", NULL)) {
661             continue;
662         } else if (line[0]) {
663             if (is_variant) {
664                 if (!new_variant(c, &variant_info, line, url)) {
665                     ret = AVERROR(ENOMEM);
666                     goto fail;
667                 }
668                 is_variant = 0;
669             }
670             if (is_segment) {
671                 struct segment *seg;
672                 if (!pls) {
673                     if (!new_variant(c, 0, url, NULL)) {
674                         ret = AVERROR(ENOMEM);
675                         goto fail;
676                     }
677                     pls = c->playlists[c->n_playlists - 1];
678                 }
679                 seg = av_malloc(sizeof(struct segment));
680                 if (!seg) {
681                     ret = AVERROR(ENOMEM);
682                     goto fail;
683                 }
684                 seg->duration = duration;
685                 seg->key_type = key_type;
686                 if (has_iv) {
687                     memcpy(seg->iv, iv, sizeof(iv));
688                 } else {
689                     int seq = pls->start_seq_no + pls->n_segments;
690                     memset(seg->iv, 0, sizeof(seg->iv));
691                     AV_WB32(seg->iv + 12, seq);
692                 }
693
694                 if (key_type != KEY_NONE) {
695                     ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, key);
696                     seg->key = av_strdup(tmp_str);
697                     if (!seg->key) {
698                         av_free(seg);
699                         ret = AVERROR(ENOMEM);
700                         goto fail;
701                     }
702                 } else {
703                     seg->key = NULL;
704                 }
705
706                 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, line);
707                 seg->url = av_strdup(tmp_str);
708                 if (!seg->url) {
709                     av_free(seg->key);
710                     av_free(seg);
711                     ret = AVERROR(ENOMEM);
712                     goto fail;
713                 }
714
715                 dynarray_add(&pls->segments, &pls->n_segments, seg);
716                 is_segment = 0;
717
718                 seg->size = seg_size;
719                 if (seg_size >= 0) {
720                     seg->url_offset = seg_offset;
721                     seg_offset += seg_size;
722                     seg_size = -1;
723                 } else {
724                     seg->url_offset = 0;
725                     seg_offset = 0;
726                 }
727             }
728         }
729     }
730     if (pls)
731         pls->last_load_time = av_gettime_relative();
732
733 fail:
734     av_free(new_url);
735     if (close_in)
736         avio_close(in);
737     return ret;
738 }
739
740 enum ReadFromURLMode {
741     READ_NORMAL,
742     READ_COMPLETE,
743 };
744
745 /* read from URLContext, limiting read to current segment */
746 static int read_from_url(struct playlist *pls, uint8_t *buf, int buf_size,
747                          enum ReadFromURLMode mode)
748 {
749     int ret;
750     struct segment *seg = pls->segments[pls->cur_seq_no - pls->start_seq_no];
751
752      /* limit read if the segment was only a part of a file */
753     if (seg->size >= 0)
754         buf_size = FFMIN(buf_size, seg->size - pls->cur_seg_offset);
755
756     if (mode == READ_COMPLETE)
757         ret = ffurl_read_complete(pls->input, buf, buf_size);
758     else
759         ret = ffurl_read(pls->input, buf, buf_size);
760
761     if (ret > 0)
762         pls->cur_seg_offset += ret;
763
764     return ret;
765 }
766
767 /* Parse the raw ID3 data and pass contents to caller */
768 static void parse_id3(AVFormatContext *s, AVIOContext *pb,
769                       AVDictionary **metadata, int64_t *dts,
770                       ID3v2ExtraMetaAPIC **apic, ID3v2ExtraMeta **extra_meta)
771 {
772     static const char id3_priv_owner_ts[] = "com.apple.streaming.transportStreamTimestamp";
773     ID3v2ExtraMeta *meta;
774
775     ff_id3v2_read_dict(pb, metadata, ID3v2_DEFAULT_MAGIC, extra_meta);
776     for (meta = *extra_meta; meta; meta = meta->next) {
777         if (!strcmp(meta->tag, "PRIV")) {
778             ID3v2ExtraMetaPRIV *priv = meta->data;
779             if (priv->datasize == 8 && !strcmp(priv->owner, id3_priv_owner_ts)) {
780                 /* 33-bit MPEG timestamp */
781                 int64_t ts = AV_RB64(priv->data);
782                 av_log(s, AV_LOG_DEBUG, "HLS ID3 audio timestamp %"PRId64"\n", ts);
783                 if ((ts & ~((1ULL << 33) - 1)) == 0)
784                     *dts = ts;
785                 else
786                     av_log(s, AV_LOG_ERROR, "Invalid HLS ID3 audio timestamp %"PRId64"\n", ts);
787             }
788         } else if (!strcmp(meta->tag, "APIC") && apic)
789             *apic = meta->data;
790     }
791 }
792
793 /* Check if the ID3 metadata contents have changed */
794 static int id3_has_changed_values(struct playlist *pls, AVDictionary *metadata,
795                                   ID3v2ExtraMetaAPIC *apic)
796 {
797     AVDictionaryEntry *entry = NULL;
798     AVDictionaryEntry *oldentry;
799     /* check that no keys have changed values */
800     while ((entry = av_dict_get(metadata, "", entry, AV_DICT_IGNORE_SUFFIX))) {
801         oldentry = av_dict_get(pls->id3_initial, entry->key, NULL, AV_DICT_MATCH_CASE);
802         if (!oldentry || strcmp(oldentry->value, entry->value) != 0)
803             return 1;
804     }
805
806     /* check if apic appeared */
807     if (apic && (pls->ctx->nb_streams != 2 || !pls->ctx->streams[1]->attached_pic.data))
808         return 1;
809
810     if (apic) {
811         int size = pls->ctx->streams[1]->attached_pic.size;
812         if (size != apic->buf->size - AV_INPUT_BUFFER_PADDING_SIZE)
813             return 1;
814
815         if (memcmp(apic->buf->data, pls->ctx->streams[1]->attached_pic.data, size) != 0)
816             return 1;
817     }
818
819     return 0;
820 }
821
822 /* Parse ID3 data and handle the found data */
823 static void handle_id3(AVIOContext *pb, struct playlist *pls)
824 {
825     AVDictionary *metadata = NULL;
826     ID3v2ExtraMetaAPIC *apic = NULL;
827     ID3v2ExtraMeta *extra_meta = NULL;
828     int64_t timestamp = AV_NOPTS_VALUE;
829
830     parse_id3(pls->ctx, pb, &metadata, &timestamp, &apic, &extra_meta);
831
832     if (timestamp != AV_NOPTS_VALUE) {
833         pls->id3_mpegts_timestamp = timestamp;
834         pls->id3_offset = 0;
835     }
836
837     if (!pls->id3_found) {
838         /* initial ID3 tags */
839         av_assert0(!pls->id3_deferred_extra);
840         pls->id3_found = 1;
841
842         /* get picture attachment and set text metadata */
843         if (pls->ctx->nb_streams)
844             ff_id3v2_parse_apic(pls->ctx, &extra_meta);
845         else
846             /* demuxer not yet opened, defer picture attachment */
847             pls->id3_deferred_extra = extra_meta;
848
849         av_dict_copy(&pls->ctx->metadata, metadata, 0);
850         pls->id3_initial = metadata;
851
852     } else {
853         if (!pls->id3_changed && id3_has_changed_values(pls, metadata, apic)) {
854             avpriv_report_missing_feature(pls->ctx, "Changing ID3 metadata in HLS audio elementary stream");
855             pls->id3_changed = 1;
856         }
857         av_dict_free(&metadata);
858     }
859
860     if (!pls->id3_deferred_extra)
861         ff_id3v2_free_extra_meta(&extra_meta);
862 }
863
864 /* Intercept and handle ID3 tags between URLContext and AVIOContext */
865 static void intercept_id3(struct playlist *pls, uint8_t *buf,
866                          int buf_size, int *len)
867 {
868     /* intercept id3 tags, we do not want to pass them to the raw
869      * demuxer on all segment switches */
870     int bytes;
871     int id3_buf_pos = 0;
872     int fill_buf = 0;
873
874     /* gather all the id3 tags */
875     while (1) {
876         /* see if we can retrieve enough data for ID3 header */
877         if (*len < ID3v2_HEADER_SIZE && buf_size >= ID3v2_HEADER_SIZE) {
878             bytes = read_from_url(pls, buf + *len, ID3v2_HEADER_SIZE - *len, READ_COMPLETE);
879             if (bytes > 0) {
880
881                 if (bytes == ID3v2_HEADER_SIZE - *len)
882                     /* no EOF yet, so fill the caller buffer again after
883                      * we have stripped the ID3 tags */
884                     fill_buf = 1;
885
886                 *len += bytes;
887
888             } else if (*len <= 0) {
889                 /* error/EOF */
890                 *len = bytes;
891                 fill_buf = 0;
892             }
893         }
894
895         if (*len < ID3v2_HEADER_SIZE)
896             break;
897
898         if (ff_id3v2_match(buf, ID3v2_DEFAULT_MAGIC)) {
899             struct segment *seg = pls->segments[pls->cur_seq_no - pls->start_seq_no];
900             int64_t maxsize = seg->size >= 0 ? seg->size : 1024*1024;
901             int taglen = ff_id3v2_tag_len(buf);
902             int tag_got_bytes = FFMIN(taglen, *len);
903             int remaining = taglen - tag_got_bytes;
904
905             if (taglen > maxsize) {
906                 av_log(pls->ctx, AV_LOG_ERROR, "Too large HLS ID3 tag (%d > %"PRId64" bytes)\n",
907                        taglen, maxsize);
908                 break;
909             }
910
911             /*
912              * Copy the id3 tag to our temporary id3 buffer.
913              * We could read a small id3 tag directly without memcpy, but
914              * we would still need to copy the large tags, and handling
915              * both of those cases together with the possibility for multiple
916              * tags would make the handling a bit complex.
917              */
918             pls->id3_buf = av_fast_realloc(pls->id3_buf, &pls->id3_buf_size, id3_buf_pos + taglen);
919             if (!pls->id3_buf)
920                 break;
921             memcpy(pls->id3_buf + id3_buf_pos, buf, tag_got_bytes);
922             id3_buf_pos += tag_got_bytes;
923
924             /* strip the intercepted bytes */
925             *len -= tag_got_bytes;
926             memmove(buf, buf + tag_got_bytes, *len);
927             av_log(pls->ctx, AV_LOG_DEBUG, "Stripped %d HLS ID3 bytes\n", tag_got_bytes);
928
929             if (remaining > 0) {
930                 /* read the rest of the tag in */
931                 if (read_from_url(pls, pls->id3_buf + id3_buf_pos, remaining, READ_COMPLETE) != remaining)
932                     break;
933                 id3_buf_pos += remaining;
934                 av_log(pls->ctx, AV_LOG_DEBUG, "Stripped additional %d HLS ID3 bytes\n", remaining);
935             }
936
937         } else {
938             /* no more ID3 tags */
939             break;
940         }
941     }
942
943     /* re-fill buffer for the caller unless EOF */
944     if (*len >= 0 && (fill_buf || *len == 0)) {
945         bytes = read_from_url(pls, buf + *len, buf_size - *len, READ_NORMAL);
946
947         /* ignore error if we already had some data */
948         if (bytes >= 0)
949             *len += bytes;
950         else if (*len == 0)
951             *len = bytes;
952     }
953
954     if (pls->id3_buf) {
955         /* Now parse all the ID3 tags */
956         AVIOContext id3ioctx;
957         ffio_init_context(&id3ioctx, pls->id3_buf, id3_buf_pos, 0, NULL, NULL, NULL, NULL);
958         handle_id3(&id3ioctx, pls);
959     }
960
961     if (pls->is_id3_timestamped == -1)
962         pls->is_id3_timestamped = (pls->id3_mpegts_timestamp != AV_NOPTS_VALUE);
963 }
964
965 static void update_options(char **dest, const char *name, void *src)
966 {
967     av_freep(dest);
968     av_opt_get(src, name, 0, (uint8_t**)dest);
969     if (*dest && !strlen(*dest))
970         av_freep(dest);
971 }
972
973 static int open_input(HLSContext *c, struct playlist *pls)
974 {
975     AVDictionary *opts = NULL;
976     AVDictionary *opts2 = NULL;
977     int ret;
978     struct segment *seg = pls->segments[pls->cur_seq_no - pls->start_seq_no];
979
980     // broker prior HTTP options that should be consistent across requests
981     av_dict_set(&opts, "user-agent", c->user_agent, 0);
982     av_dict_set(&opts, "cookies", c->cookies, 0);
983     av_dict_set(&opts, "headers", c->headers, 0);
984     av_dict_set(&opts, "seekable", "0", 0);
985
986     // Same opts for key request (ffurl_open mutilates the opts so it cannot be used twice)
987     av_dict_copy(&opts2, opts, 0);
988
989     if (seg->size >= 0) {
990         /* try to restrict the HTTP request to the part we want
991          * (if this is in fact a HTTP request) */
992         av_dict_set_int(&opts, "offset", seg->url_offset, 0);
993         av_dict_set_int(&opts, "end_offset", seg->url_offset + seg->size, 0);
994     }
995
996     av_log(pls->parent, AV_LOG_VERBOSE, "HLS request for url '%s', offset %"PRId64", playlist %d\n",
997            seg->url, seg->url_offset, pls->index);
998
999     if (seg->key_type == KEY_NONE) {
1000         ret = open_url(pls->parent->priv_data, &pls->input, seg->url, opts);
1001     } else if (seg->key_type == KEY_AES_128) {
1002 //         HLSContext *c = var->parent->priv_data;
1003         char iv[33], key[33], url[MAX_URL_SIZE];
1004         if (strcmp(seg->key, pls->key_url)) {
1005             URLContext *uc;
1006             if (open_url(pls->parent->priv_data, &uc, seg->key, opts2) == 0) {
1007                 if (ffurl_read_complete(uc, pls->key, sizeof(pls->key))
1008                     != sizeof(pls->key)) {
1009                     av_log(NULL, AV_LOG_ERROR, "Unable to read key file %s\n",
1010                            seg->key);
1011                 }
1012                 update_options(&c->cookies, "cookies", uc->priv_data);
1013                 av_dict_set(&opts, "cookies", c->cookies, 0);
1014                 ffurl_close(uc);
1015             } else {
1016                 av_log(NULL, AV_LOG_ERROR, "Unable to open key file %s\n",
1017                        seg->key);
1018             }
1019             av_strlcpy(pls->key_url, seg->key, sizeof(pls->key_url));
1020         }
1021         ff_data_to_hex(iv, seg->iv, sizeof(seg->iv), 0);
1022         ff_data_to_hex(key, pls->key, sizeof(pls->key), 0);
1023         iv[32] = key[32] = '\0';
1024         if (strstr(seg->url, "://"))
1025             snprintf(url, sizeof(url), "crypto+%s", seg->url);
1026         else
1027             snprintf(url, sizeof(url), "crypto:%s", seg->url);
1028
1029         if ((ret = ffurl_alloc(&pls->input, url, AVIO_FLAG_READ,
1030                                &pls->parent->interrupt_callback)) < 0)
1031             goto cleanup;
1032         av_opt_set(pls->input->priv_data, "key", key, 0);
1033         av_opt_set(pls->input->priv_data, "iv", iv, 0);
1034
1035         if ((ret = url_connect(pls, c->avio_opts, opts)) < 0) {
1036             goto cleanup;
1037         }
1038         ret = 0;
1039     } else if (seg->key_type == KEY_SAMPLE_AES) {
1040         av_log(pls->parent, AV_LOG_ERROR,
1041                "SAMPLE-AES encryption is not supported yet\n");
1042         ret = AVERROR_PATCHWELCOME;
1043     }
1044     else
1045       ret = AVERROR(ENOSYS);
1046
1047     /* Seek to the requested position. If this was a HTTP request, the offset
1048      * should already be where want it to, but this allows e.g. local testing
1049      * without a HTTP server. */
1050     if (ret == 0 && seg->key_type == KEY_NONE) {
1051         int seekret = ffurl_seek(pls->input, seg->url_offset, SEEK_SET);
1052         if (seekret < 0) {
1053             av_log(pls->parent, AV_LOG_ERROR, "Unable to seek to offset %"PRId64" of HLS segment '%s'\n", seg->url_offset, seg->url);
1054             ret = seekret;
1055             ffurl_close(pls->input);
1056             pls->input = NULL;
1057         }
1058     }
1059
1060 cleanup:
1061     av_dict_free(&opts);
1062     av_dict_free(&opts2);
1063     pls->cur_seg_offset = 0;
1064     return ret;
1065 }
1066
1067 static int64_t default_reload_interval(struct playlist *pls)
1068 {
1069     return pls->n_segments > 0 ?
1070                           pls->segments[pls->n_segments - 1]->duration :
1071                           pls->target_duration;
1072 }
1073
1074 static int read_data(void *opaque, uint8_t *buf, int buf_size)
1075 {
1076     struct playlist *v = opaque;
1077     HLSContext *c = v->parent->priv_data;
1078     int ret, i;
1079     int just_opened = 0;
1080
1081 restart:
1082     if (!v->needed)
1083         return AVERROR_EOF;
1084
1085     if (!v->input) {
1086         int64_t reload_interval;
1087
1088         /* Check that the playlist is still needed before opening a new
1089          * segment. */
1090         if (v->ctx && v->ctx->nb_streams &&
1091             v->parent->nb_streams >= v->stream_offset + v->ctx->nb_streams) {
1092             v->needed = 0;
1093             for (i = v->stream_offset; i < v->stream_offset + v->ctx->nb_streams;
1094                 i++) {
1095                 if (v->parent->streams[i]->discard < AVDISCARD_ALL)
1096                     v->needed = 1;
1097             }
1098         }
1099         if (!v->needed) {
1100             av_log(v->parent, AV_LOG_INFO, "No longer receiving playlist %d\n",
1101                 v->index);
1102             return AVERROR_EOF;
1103         }
1104
1105         /* If this is a live stream and the reload interval has elapsed since
1106          * the last playlist reload, reload the playlists now. */
1107         reload_interval = default_reload_interval(v);
1108
1109 reload:
1110         if (!v->finished &&
1111             av_gettime_relative() - v->last_load_time >= reload_interval) {
1112             if ((ret = parse_playlist(c, v->url, v, NULL)) < 0) {
1113                 av_log(v->parent, AV_LOG_WARNING, "Failed to reload playlist %d\n",
1114                        v->index);
1115                 return ret;
1116             }
1117             /* If we need to reload the playlist again below (if
1118              * there's still no more segments), switch to a reload
1119              * interval of half the target duration. */
1120             reload_interval = v->target_duration / 2;
1121         }
1122         if (v->cur_seq_no < v->start_seq_no) {
1123             av_log(NULL, AV_LOG_WARNING,
1124                    "skipping %d segments ahead, expired from playlists\n",
1125                    v->start_seq_no - v->cur_seq_no);
1126             v->cur_seq_no = v->start_seq_no;
1127         }
1128         if (v->cur_seq_no >= v->start_seq_no + v->n_segments) {
1129             if (v->finished)
1130                 return AVERROR_EOF;
1131             while (av_gettime_relative() - v->last_load_time < reload_interval) {
1132                 if (ff_check_interrupt(c->interrupt_callback))
1133                     return AVERROR_EXIT;
1134                 av_usleep(100*1000);
1135             }
1136             /* Enough time has elapsed since the last reload */
1137             goto reload;
1138         }
1139
1140         ret = open_input(c, v);
1141         if (ret < 0) {
1142             if (ff_check_interrupt(c->interrupt_callback))
1143                 return AVERROR_EXIT;
1144             av_log(v->parent, AV_LOG_WARNING, "Failed to open segment of playlist %d\n",
1145                    v->index);
1146             v->cur_seq_no += 1;
1147             goto reload;
1148         }
1149         just_opened = 1;
1150     }
1151
1152     ret = read_from_url(v, buf, buf_size, READ_NORMAL);
1153     if (ret > 0) {
1154         if (just_opened && v->is_id3_timestamped != 0) {
1155             /* Intercept ID3 tags here, elementary audio streams are required
1156              * to convey timestamps using them in the beginning of each segment. */
1157             intercept_id3(v, buf, buf_size, &ret);
1158         }
1159
1160         return ret;
1161     }
1162     ffurl_close(v->input);
1163     v->input = NULL;
1164     v->cur_seq_no++;
1165
1166     c->cur_seq_no = v->cur_seq_no;
1167
1168     goto restart;
1169 }
1170
1171 static int playlist_in_multiple_variants(HLSContext *c, struct playlist *pls)
1172 {
1173     int variant_count = 0;
1174     int i, j;
1175
1176     for (i = 0; i < c->n_variants && variant_count < 2; i++) {
1177         struct variant *v = c->variants[i];
1178
1179         for (j = 0; j < v->n_playlists; j++) {
1180             if (v->playlists[j] == pls) {
1181                 variant_count++;
1182                 break;
1183             }
1184         }
1185     }
1186
1187     return variant_count >= 2;
1188 }
1189
1190 static void add_renditions_to_variant(HLSContext *c, struct variant *var,
1191                                       enum AVMediaType type, const char *group_id)
1192 {
1193     int i;
1194
1195     for (i = 0; i < c->n_renditions; i++) {
1196         struct rendition *rend = c->renditions[i];
1197
1198         if (rend->type == type && !strcmp(rend->group_id, group_id)) {
1199
1200             if (rend->playlist)
1201                 /* rendition is an external playlist
1202                  * => add the playlist to the variant */
1203                 dynarray_add(&var->playlists, &var->n_playlists, rend->playlist);
1204             else
1205                 /* rendition is part of the variant main Media Playlist
1206                  * => add the rendition to the main Media Playlist */
1207                 dynarray_add(&var->playlists[0]->renditions,
1208                              &var->playlists[0]->n_renditions,
1209                              rend);
1210         }
1211     }
1212 }
1213
1214 static void add_metadata_from_renditions(AVFormatContext *s, struct playlist *pls,
1215                                          enum AVMediaType type)
1216 {
1217     int rend_idx = 0;
1218     int i;
1219
1220     for (i = 0; i < pls->ctx->nb_streams; i++) {
1221         AVStream *st = s->streams[pls->stream_offset + i];
1222
1223         if (st->codec->codec_type != type)
1224             continue;
1225
1226         for (; rend_idx < pls->n_renditions; rend_idx++) {
1227             struct rendition *rend = pls->renditions[rend_idx];
1228
1229             if (rend->type != type)
1230                 continue;
1231
1232             if (rend->language[0])
1233                 av_dict_set(&st->metadata, "language", rend->language, 0);
1234             if (rend->name[0])
1235                 av_dict_set(&st->metadata, "comment", rend->name, 0);
1236
1237             st->disposition |= rend->disposition;
1238         }
1239         if (rend_idx >=pls->n_renditions)
1240             break;
1241     }
1242 }
1243
1244 /* if timestamp was in valid range: returns 1 and sets seq_no
1245  * if not: returns 0 and sets seq_no to closest segment */
1246 static int find_timestamp_in_playlist(HLSContext *c, struct playlist *pls,
1247                                       int64_t timestamp, int *seq_no)
1248 {
1249     int i;
1250     int64_t pos = c->first_timestamp == AV_NOPTS_VALUE ?
1251                   0 : c->first_timestamp;
1252
1253     if (timestamp < pos) {
1254         *seq_no = pls->start_seq_no;
1255         return 0;
1256     }
1257
1258     for (i = 0; i < pls->n_segments; i++) {
1259         int64_t diff = pos + pls->segments[i]->duration - timestamp;
1260         if (diff > 0) {
1261             *seq_no = pls->start_seq_no + i;
1262             return 1;
1263         }
1264         pos += pls->segments[i]->duration;
1265     }
1266
1267     *seq_no = pls->start_seq_no + pls->n_segments - 1;
1268
1269     return 0;
1270 }
1271
1272 static int select_cur_seq_no(HLSContext *c, struct playlist *pls)
1273 {
1274     int seq_no;
1275
1276     if (!pls->finished && !c->first_packet &&
1277         av_gettime_relative() - pls->last_load_time >= default_reload_interval(pls))
1278         /* reload the playlist since it was suspended */
1279         parse_playlist(c, pls->url, pls, NULL);
1280
1281     /* If playback is already in progress (we are just selecting a new
1282      * playlist) and this is a complete file, find the matching segment
1283      * by counting durations. */
1284     if (pls->finished && c->cur_timestamp != AV_NOPTS_VALUE) {
1285         find_timestamp_in_playlist(c, pls, c->cur_timestamp, &seq_no);
1286         return seq_no;
1287     }
1288
1289     if (!pls->finished) {
1290         if (!c->first_packet && /* we are doing a segment selection during playback */
1291             c->cur_seq_no >= pls->start_seq_no &&
1292             c->cur_seq_no < pls->start_seq_no + pls->n_segments)
1293             /* While spec 3.4.3 says that we cannot assume anything about the
1294              * content at the same sequence number on different playlists,
1295              * in practice this seems to work and doing it otherwise would
1296              * require us to download a segment to inspect its timestamps. */
1297             return c->cur_seq_no;
1298
1299         /* If this is a live stream, start live_start_index segments from the
1300          * start or end */
1301         if (c->live_start_index < 0)
1302             return pls->start_seq_no + FFMAX(pls->n_segments + c->live_start_index, 0);
1303         else
1304             return pls->start_seq_no + FFMIN(c->live_start_index, pls->n_segments - 1);
1305     }
1306
1307     /* Otherwise just start on the first segment. */
1308     return pls->start_seq_no;
1309 }
1310
1311 static int save_avio_options(AVFormatContext *s)
1312 {
1313     HLSContext *c = s->priv_data;
1314     const char *opts[] = { "headers", "user_agent", "user-agent", "cookies", NULL }, **opt = opts;
1315     uint8_t *buf;
1316     int ret = 0;
1317
1318     while (*opt) {
1319         if (av_opt_get(s->pb, *opt, AV_OPT_SEARCH_CHILDREN, &buf) >= 0) {
1320             ret = av_dict_set(&c->avio_opts, *opt, buf,
1321                               AV_DICT_DONT_STRDUP_VAL);
1322             if (ret < 0)
1323                 return ret;
1324         }
1325         opt++;
1326     }
1327
1328     return ret;
1329 }
1330
1331 static int hls_read_header(AVFormatContext *s)
1332 {
1333     URLContext *u = (s->flags & AVFMT_FLAG_CUSTOM_IO) ? NULL : s->pb->opaque;
1334     HLSContext *c = s->priv_data;
1335     int ret = 0, i, j, stream_offset = 0;
1336
1337     c->interrupt_callback = &s->interrupt_callback;
1338
1339     c->first_packet = 1;
1340     c->first_timestamp = AV_NOPTS_VALUE;
1341     c->cur_timestamp = AV_NOPTS_VALUE;
1342
1343     // if the URL context is good, read important options we must broker later
1344     if (u && u->prot->priv_data_class) {
1345         // get the previous user agent & set back to null if string size is zero
1346         update_options(&c->user_agent, "user-agent", u->priv_data);
1347
1348         // get the previous cookies & set back to null if string size is zero
1349         update_options(&c->cookies, "cookies", u->priv_data);
1350
1351         // get the previous headers & set back to null if string size is zero
1352         update_options(&c->headers, "headers", u->priv_data);
1353     }
1354
1355     if ((ret = parse_playlist(c, s->filename, NULL, s->pb)) < 0)
1356         goto fail;
1357
1358     if ((ret = save_avio_options(s)) < 0)
1359         goto fail;
1360
1361     /* Some HLS servers don't like being sent the range header */
1362     av_dict_set(&c->avio_opts, "seekable", "0", 0);
1363
1364     if (c->n_variants == 0) {
1365         av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1366         ret = AVERROR_EOF;
1367         goto fail;
1368     }
1369     /* If the playlist only contained playlists (Master Playlist),
1370      * parse each individual playlist. */
1371     if (c->n_playlists > 1 || c->playlists[0]->n_segments == 0) {
1372         for (i = 0; i < c->n_playlists; i++) {
1373             struct playlist *pls = c->playlists[i];
1374             if ((ret = parse_playlist(c, pls->url, pls, NULL)) < 0)
1375                 goto fail;
1376         }
1377     }
1378
1379     if (c->variants[0]->playlists[0]->n_segments == 0) {
1380         av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1381         ret = AVERROR_EOF;
1382         goto fail;
1383     }
1384
1385     /* If this isn't a live stream, calculate the total duration of the
1386      * stream. */
1387     if (c->variants[0]->playlists[0]->finished) {
1388         int64_t duration = 0;
1389         for (i = 0; i < c->variants[0]->playlists[0]->n_segments; i++)
1390             duration += c->variants[0]->playlists[0]->segments[i]->duration;
1391         s->duration = duration;
1392     }
1393
1394     /* Associate renditions with variants */
1395     for (i = 0; i < c->n_variants; i++) {
1396         struct variant *var = c->variants[i];
1397
1398         if (var->audio_group[0])
1399             add_renditions_to_variant(c, var, AVMEDIA_TYPE_AUDIO, var->audio_group);
1400         if (var->video_group[0])
1401             add_renditions_to_variant(c, var, AVMEDIA_TYPE_VIDEO, var->video_group);
1402         if (var->subtitles_group[0])
1403             add_renditions_to_variant(c, var, AVMEDIA_TYPE_SUBTITLE, var->subtitles_group);
1404     }
1405
1406     /* Open the demuxer for each playlist */
1407     for (i = 0; i < c->n_playlists; i++) {
1408         struct playlist *pls = c->playlists[i];
1409         AVInputFormat *in_fmt = NULL;
1410
1411         if (!(pls->ctx = avformat_alloc_context())) {
1412             ret = AVERROR(ENOMEM);
1413             goto fail;
1414         }
1415
1416         if (pls->n_segments == 0)
1417             continue;
1418
1419         pls->index  = i;
1420         pls->needed = 1;
1421         pls->parent = s;
1422         pls->cur_seq_no = select_cur_seq_no(c, pls);
1423
1424         pls->read_buffer = av_malloc(INITIAL_BUFFER_SIZE);
1425         if (!pls->read_buffer){
1426             ret = AVERROR(ENOMEM);
1427             avformat_free_context(pls->ctx);
1428             pls->ctx = NULL;
1429             goto fail;
1430         }
1431         ffio_init_context(&pls->pb, pls->read_buffer, INITIAL_BUFFER_SIZE, 0, pls,
1432                           read_data, NULL, NULL);
1433         pls->pb.seekable = 0;
1434         ret = av_probe_input_buffer(&pls->pb, &in_fmt, pls->segments[0]->url,
1435                                     NULL, 0, 0);
1436         if (ret < 0) {
1437             /* Free the ctx - it isn't initialized properly at this point,
1438              * so avformat_close_input shouldn't be called. If
1439              * avformat_open_input fails below, it frees and zeros the
1440              * context, so it doesn't need any special treatment like this. */
1441             av_log(s, AV_LOG_ERROR, "Error when loading first segment '%s'\n", pls->segments[0]->url);
1442             avformat_free_context(pls->ctx);
1443             pls->ctx = NULL;
1444             goto fail;
1445         }
1446         pls->ctx->pb       = &pls->pb;
1447         pls->stream_offset = stream_offset;
1448
1449         if ((ret = ff_copy_whitelists(pls->ctx, s)) < 0)
1450             goto fail;
1451
1452         ret = avformat_open_input(&pls->ctx, pls->segments[0]->url, in_fmt, NULL);
1453         if (ret < 0)
1454             goto fail;
1455
1456         if (pls->id3_deferred_extra && pls->ctx->nb_streams == 1) {
1457             ff_id3v2_parse_apic(pls->ctx, &pls->id3_deferred_extra);
1458             avformat_queue_attached_pictures(pls->ctx);
1459             ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
1460             pls->id3_deferred_extra = NULL;
1461         }
1462
1463         pls->ctx->ctx_flags &= ~AVFMTCTX_NOHEADER;
1464         ret = avformat_find_stream_info(pls->ctx, NULL);
1465         if (ret < 0)
1466             goto fail;
1467
1468         if (pls->is_id3_timestamped == -1)
1469             av_log(s, AV_LOG_WARNING, "No expected HTTP requests have been made\n");
1470
1471         /* Create new AVStreams for each stream in this playlist */
1472         for (j = 0; j < pls->ctx->nb_streams; j++) {
1473             AVStream *st = avformat_new_stream(s, NULL);
1474             AVStream *ist = pls->ctx->streams[j];
1475             if (!st) {
1476                 ret = AVERROR(ENOMEM);
1477                 goto fail;
1478             }
1479             st->id = i;
1480
1481             avcodec_copy_context(st->codec, pls->ctx->streams[j]->codec);
1482
1483             if (pls->is_id3_timestamped) /* custom timestamps via id3 */
1484                 avpriv_set_pts_info(st, 33, 1, MPEG_TIME_BASE);
1485             else
1486                 avpriv_set_pts_info(st, ist->pts_wrap_bits, ist->time_base.num, ist->time_base.den);
1487         }
1488
1489         add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_AUDIO);
1490         add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_VIDEO);
1491         add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_SUBTITLE);
1492
1493         stream_offset += pls->ctx->nb_streams;
1494     }
1495
1496     /* Create a program for each variant */
1497     for (i = 0; i < c->n_variants; i++) {
1498         struct variant *v = c->variants[i];
1499         AVProgram *program;
1500
1501         program = av_new_program(s, i);
1502         if (!program)
1503             goto fail;
1504         av_dict_set_int(&program->metadata, "variant_bitrate", v->bandwidth, 0);
1505
1506         for (j = 0; j < v->n_playlists; j++) {
1507             struct playlist *pls = v->playlists[j];
1508             int is_shared = playlist_in_multiple_variants(c, pls);
1509             int k;
1510
1511             for (k = 0; k < pls->ctx->nb_streams; k++) {
1512                 struct AVStream *st = s->streams[pls->stream_offset + k];
1513
1514                 ff_program_add_stream_index(s, i, pls->stream_offset + k);
1515
1516                 /* Set variant_bitrate for streams unique to this variant */
1517                 if (!is_shared && v->bandwidth)
1518                     av_dict_set_int(&st->metadata, "variant_bitrate", v->bandwidth, 0);
1519             }
1520         }
1521     }
1522
1523     return 0;
1524 fail:
1525     free_playlist_list(c);
1526     free_variant_list(c);
1527     free_rendition_list(c);
1528     return ret;
1529 }
1530
1531 static int recheck_discard_flags(AVFormatContext *s, int first)
1532 {
1533     HLSContext *c = s->priv_data;
1534     int i, changed = 0;
1535
1536     /* Check if any new streams are needed */
1537     for (i = 0; i < c->n_playlists; i++)
1538         c->playlists[i]->cur_needed = 0;
1539
1540     for (i = 0; i < s->nb_streams; i++) {
1541         AVStream *st = s->streams[i];
1542         struct playlist *pls = c->playlists[s->streams[i]->id];
1543         if (st->discard < AVDISCARD_ALL)
1544             pls->cur_needed = 1;
1545     }
1546     for (i = 0; i < c->n_playlists; i++) {
1547         struct playlist *pls = c->playlists[i];
1548         if (pls->cur_needed && !pls->needed) {
1549             pls->needed = 1;
1550             changed = 1;
1551             pls->cur_seq_no = select_cur_seq_no(c, pls);
1552             pls->pb.eof_reached = 0;
1553             if (c->cur_timestamp != AV_NOPTS_VALUE) {
1554                 /* catch up */
1555                 pls->seek_timestamp = c->cur_timestamp;
1556                 pls->seek_flags = AVSEEK_FLAG_ANY;
1557                 pls->seek_stream_index = -1;
1558             }
1559             av_log(s, AV_LOG_INFO, "Now receiving playlist %d, segment %d\n", i, pls->cur_seq_no);
1560         } else if (first && !pls->cur_needed && pls->needed) {
1561             if (pls->input)
1562                 ffurl_close(pls->input);
1563             pls->input = NULL;
1564             pls->needed = 0;
1565             changed = 1;
1566             av_log(s, AV_LOG_INFO, "No longer receiving playlist %d\n", i);
1567         }
1568     }
1569     return changed;
1570 }
1571
1572 static void fill_timing_for_id3_timestamped_stream(struct playlist *pls)
1573 {
1574     if (pls->id3_offset >= 0) {
1575         pls->pkt.dts = pls->id3_mpegts_timestamp +
1576                                  av_rescale_q(pls->id3_offset,
1577                                               pls->ctx->streams[pls->pkt.stream_index]->time_base,
1578                                               MPEG_TIME_BASE_Q);
1579         if (pls->pkt.duration)
1580             pls->id3_offset += pls->pkt.duration;
1581         else
1582             pls->id3_offset = -1;
1583     } else {
1584         /* there have been packets with unknown duration
1585          * since the last id3 tag, should not normally happen */
1586         pls->pkt.dts = AV_NOPTS_VALUE;
1587     }
1588
1589     if (pls->pkt.duration)
1590         pls->pkt.duration = av_rescale_q(pls->pkt.duration,
1591                                          pls->ctx->streams[pls->pkt.stream_index]->time_base,
1592                                          MPEG_TIME_BASE_Q);
1593
1594     pls->pkt.pts = AV_NOPTS_VALUE;
1595 }
1596
1597 static AVRational get_timebase(struct playlist *pls)
1598 {
1599     if (pls->is_id3_timestamped)
1600         return MPEG_TIME_BASE_Q;
1601
1602     return pls->ctx->streams[pls->pkt.stream_index]->time_base;
1603 }
1604
1605 static int compare_ts_with_wrapdetect(int64_t ts_a, struct playlist *pls_a,
1606                                       int64_t ts_b, struct playlist *pls_b)
1607 {
1608     int64_t scaled_ts_a = av_rescale_q(ts_a, get_timebase(pls_a), MPEG_TIME_BASE_Q);
1609     int64_t scaled_ts_b = av_rescale_q(ts_b, get_timebase(pls_b), MPEG_TIME_BASE_Q);
1610
1611     return av_compare_mod(scaled_ts_a, scaled_ts_b, 1LL << 33);
1612 }
1613
1614 static int hls_read_packet(AVFormatContext *s, AVPacket *pkt)
1615 {
1616     HLSContext *c = s->priv_data;
1617     int ret, i, minplaylist = -1;
1618
1619     recheck_discard_flags(s, c->first_packet);
1620
1621     for (i = 0; i < c->n_playlists; i++) {
1622         struct playlist *pls = c->playlists[i];
1623         /* Make sure we've got one buffered packet from each open playlist
1624          * stream */
1625         if (pls->needed && !pls->pkt.data) {
1626             while (1) {
1627                 int64_t ts_diff;
1628                 AVRational tb;
1629                 ret = av_read_frame(pls->ctx, &pls->pkt);
1630                 if (ret < 0) {
1631                     if (!avio_feof(&pls->pb) && ret != AVERROR_EOF)
1632                         return ret;
1633                     reset_packet(&pls->pkt);
1634                     break;
1635                 } else {
1636                     /* stream_index check prevents matching picture attachments etc. */
1637                     if (pls->is_id3_timestamped && pls->pkt.stream_index == 0) {
1638                         /* audio elementary streams are id3 timestamped */
1639                         fill_timing_for_id3_timestamped_stream(pls);
1640                     }
1641
1642                     if (c->first_timestamp == AV_NOPTS_VALUE &&
1643                         pls->pkt.dts       != AV_NOPTS_VALUE)
1644                         c->first_timestamp = av_rescale_q(pls->pkt.dts,
1645                             get_timebase(pls), AV_TIME_BASE_Q);
1646                 }
1647
1648                 if (pls->seek_timestamp == AV_NOPTS_VALUE)
1649                     break;
1650
1651                 if (pls->seek_stream_index < 0 ||
1652                     pls->seek_stream_index == pls->pkt.stream_index) {
1653
1654                     if (pls->pkt.dts == AV_NOPTS_VALUE) {
1655                         pls->seek_timestamp = AV_NOPTS_VALUE;
1656                         break;
1657                     }
1658
1659                     tb = get_timebase(pls);
1660                     ts_diff = av_rescale_rnd(pls->pkt.dts, AV_TIME_BASE,
1661                                             tb.den, AV_ROUND_DOWN) -
1662                             pls->seek_timestamp;
1663                     if (ts_diff >= 0 && (pls->seek_flags  & AVSEEK_FLAG_ANY ||
1664                                         pls->pkt.flags & AV_PKT_FLAG_KEY)) {
1665                         pls->seek_timestamp = AV_NOPTS_VALUE;
1666                         break;
1667                     }
1668                 }
1669                 av_free_packet(&pls->pkt);
1670                 reset_packet(&pls->pkt);
1671             }
1672         }
1673         /* Check if this stream has the packet with the lowest dts */
1674         if (pls->pkt.data) {
1675             struct playlist *minpls = minplaylist < 0 ?
1676                                      NULL : c->playlists[minplaylist];
1677             if (minplaylist < 0) {
1678                 minplaylist = i;
1679             } else {
1680                 int64_t dts     =    pls->pkt.dts;
1681                 int64_t mindts  = minpls->pkt.dts;
1682
1683                 if (dts == AV_NOPTS_VALUE ||
1684                     (mindts != AV_NOPTS_VALUE && compare_ts_with_wrapdetect(dts, pls, mindts, minpls) < 0))
1685                     minplaylist = i;
1686             }
1687         }
1688     }
1689
1690     /* If we got a packet, return it */
1691     if (minplaylist >= 0) {
1692         struct playlist *pls = c->playlists[minplaylist];
1693         *pkt = pls->pkt;
1694         pkt->stream_index += pls->stream_offset;
1695         reset_packet(&c->playlists[minplaylist]->pkt);
1696
1697         if (pkt->dts != AV_NOPTS_VALUE)
1698             c->cur_timestamp = av_rescale_q(pkt->dts,
1699                                             pls->ctx->streams[pls->pkt.stream_index]->time_base,
1700                                             AV_TIME_BASE_Q);
1701
1702         return 0;
1703     }
1704     return AVERROR_EOF;
1705 }
1706
1707 static int hls_close(AVFormatContext *s)
1708 {
1709     HLSContext *c = s->priv_data;
1710
1711     free_playlist_list(c);
1712     free_variant_list(c);
1713     free_rendition_list(c);
1714
1715     av_dict_free(&c->avio_opts);
1716
1717     return 0;
1718 }
1719
1720 static int hls_read_seek(AVFormatContext *s, int stream_index,
1721                                int64_t timestamp, int flags)
1722 {
1723     HLSContext *c = s->priv_data;
1724     struct playlist *seek_pls = NULL;
1725     int i, seq_no;
1726     int64_t first_timestamp, seek_timestamp, duration;
1727
1728     if ((flags & AVSEEK_FLAG_BYTE) ||
1729         !(c->variants[0]->playlists[0]->finished || c->variants[0]->playlists[0]->type == PLS_TYPE_EVENT))
1730         return AVERROR(ENOSYS);
1731
1732     first_timestamp = c->first_timestamp == AV_NOPTS_VALUE ?
1733                       0 : c->first_timestamp;
1734
1735     seek_timestamp = av_rescale_rnd(timestamp, AV_TIME_BASE,
1736                                     s->streams[stream_index]->time_base.den,
1737                                     flags & AVSEEK_FLAG_BACKWARD ?
1738                                     AV_ROUND_DOWN : AV_ROUND_UP);
1739
1740     duration = s->duration == AV_NOPTS_VALUE ?
1741                0 : s->duration;
1742
1743     if (0 < duration && duration < seek_timestamp - first_timestamp)
1744         return AVERROR(EIO);
1745
1746     /* find the playlist with the specified stream */
1747     for (i = 0; i < c->n_playlists; i++) {
1748         struct playlist *pls = c->playlists[i];
1749         if (stream_index >= pls->stream_offset &&
1750             stream_index - pls->stream_offset < pls->ctx->nb_streams) {
1751             seek_pls = pls;
1752             break;
1753         }
1754     }
1755     /* check if the timestamp is valid for the playlist with the
1756      * specified stream index */
1757     if (!seek_pls || !find_timestamp_in_playlist(c, seek_pls, seek_timestamp, &seq_no))
1758         return AVERROR(EIO);
1759
1760     /* set segment now so we do not need to search again below */
1761     seek_pls->cur_seq_no = seq_no;
1762     seek_pls->seek_stream_index = stream_index - seek_pls->stream_offset;
1763
1764     for (i = 0; i < c->n_playlists; i++) {
1765         /* Reset reading */
1766         struct playlist *pls = c->playlists[i];
1767         if (pls->input) {
1768             ffurl_close(pls->input);
1769             pls->input = NULL;
1770         }
1771         av_free_packet(&pls->pkt);
1772         reset_packet(&pls->pkt);
1773         pls->pb.eof_reached = 0;
1774         /* Clear any buffered data */
1775         pls->pb.buf_end = pls->pb.buf_ptr = pls->pb.buffer;
1776         /* Reset the pos, to let the mpegts demuxer know we've seeked. */
1777         pls->pb.pos = 0;
1778         /* Flush the packet queue of the subdemuxer. */
1779         ff_read_frame_flush(pls->ctx);
1780
1781         pls->seek_timestamp = seek_timestamp;
1782         pls->seek_flags = flags;
1783
1784         if (pls != seek_pls) {
1785             /* set closest segment seq_no for playlists not handled above */
1786             find_timestamp_in_playlist(c, pls, seek_timestamp, &pls->cur_seq_no);
1787             /* seek the playlist to the given position without taking
1788              * keyframes into account since this playlist does not have the
1789              * specified stream where we should look for the keyframes */
1790             pls->seek_stream_index = -1;
1791             pls->seek_flags |= AVSEEK_FLAG_ANY;
1792         }
1793     }
1794
1795     c->cur_timestamp = seek_timestamp;
1796
1797     return 0;
1798 }
1799
1800 static int hls_probe(AVProbeData *p)
1801 {
1802     /* Require #EXTM3U at the start, and either one of the ones below
1803      * somewhere for a proper match. */
1804     if (strncmp(p->buf, "#EXTM3U", 7))
1805         return 0;
1806     if (strstr(p->buf, "#EXT-X-STREAM-INF:")     ||
1807         strstr(p->buf, "#EXT-X-TARGETDURATION:") ||
1808         strstr(p->buf, "#EXT-X-MEDIA-SEQUENCE:"))
1809         return AVPROBE_SCORE_MAX;
1810     return 0;
1811 }
1812
1813 #define OFFSET(x) offsetof(HLSContext, x)
1814 #define FLAGS AV_OPT_FLAG_DECODING_PARAM
1815 static const AVOption hls_options[] = {
1816     {"live_start_index", "segment index to start live streams at (negative values are from the end)",
1817         OFFSET(live_start_index), AV_OPT_TYPE_INT, {.i64 = -3}, INT_MIN, INT_MAX, FLAGS},
1818     {NULL}
1819 };
1820
1821 static const AVClass hls_class = {
1822     .class_name = "hls,applehttp",
1823     .item_name  = av_default_item_name,
1824     .option     = hls_options,
1825     .version    = LIBAVUTIL_VERSION_INT,
1826 };
1827
1828 AVInputFormat ff_hls_demuxer = {
1829     .name           = "hls,applehttp",
1830     .long_name      = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
1831     .priv_class     = &hls_class,
1832     .priv_data_size = sizeof(HLSContext),
1833     .read_probe     = hls_probe,
1834     .read_header    = hls_read_header,
1835     .read_packet    = hls_read_packet,
1836     .read_close     = hls_close,
1837     .read_seek      = hls_read_seek,
1838 };