]> git.sesse.net Git - ffmpeg/blob - libavformat/hls.c
Merge commit 'd0a3e89d41b05f9ed0e7401c352b60ed4f4d1ed5'
[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 url_connect(struct playlist *pls, AVDictionary *opts, AVDictionary *opts2)
499 {
500     AVDictionary *tmp = NULL;
501     int ret;
502
503     av_dict_copy(&tmp, opts, 0);
504     av_dict_copy(&tmp, opts2, 0);
505
506     if ((ret = ffurl_connect(pls->input, &tmp)) < 0) {
507         ffurl_close(pls->input);
508         pls->input = NULL;
509     }
510
511     av_dict_free(&tmp);
512     return ret;
513 }
514
515 static void update_options(char **dest, const char *name, void *src)
516 {
517     av_freep(dest);
518     av_opt_get(src, name, 0, (uint8_t**)dest);
519     if (*dest && !strlen(*dest))
520         av_freep(dest);
521 }
522
523 static int open_url(HLSContext *c, URLContext **uc, const char *url, AVDictionary *opts)
524 {
525     AVDictionary *tmp = NULL;
526     int ret;
527
528     av_dict_copy(&tmp, c->avio_opts, 0);
529     av_dict_copy(&tmp, opts, 0);
530
531     ret = ffurl_open(uc, url, AVIO_FLAG_READ, c->interrupt_callback, &tmp);
532     if( ret >= 0) {
533         // update cookies on http response with setcookies.
534         URLContext *u = *uc;
535         update_options(&c->cookies, "cookies", u->priv_data);
536         av_dict_set(&opts, "cookies", c->cookies, 0);
537     }
538
539     av_dict_free(&tmp);
540
541     return ret;
542 }
543
544 static int parse_playlist(HLSContext *c, const char *url,
545                           struct playlist *pls, AVIOContext *in)
546 {
547     int ret = 0, is_segment = 0, is_variant = 0;
548     int64_t duration = 0;
549     enum KeyType key_type = KEY_NONE;
550     uint8_t iv[16] = "";
551     int has_iv = 0;
552     char key[MAX_URL_SIZE] = "";
553     char line[MAX_URL_SIZE];
554     const char *ptr;
555     int close_in = 0;
556     int64_t seg_offset = 0;
557     int64_t seg_size = -1;
558     uint8_t *new_url = NULL;
559     struct variant_info variant_info;
560     char tmp_str[MAX_URL_SIZE];
561
562     if (!in) {
563 #if 1
564         AVDictionary *opts = NULL;
565         close_in = 1;
566         /* Some HLS servers don't like being sent the range header */
567         av_dict_set(&opts, "seekable", "0", 0);
568
569         // broker prior HTTP options that should be consistent across requests
570         av_dict_set(&opts, "user-agent", c->user_agent, 0);
571         av_dict_set(&opts, "cookies", c->cookies, 0);
572         av_dict_set(&opts, "headers", c->headers, 0);
573
574         ret = avio_open2(&in, url, AVIO_FLAG_READ,
575                          c->interrupt_callback, &opts);
576         av_dict_free(&opts);
577         if (ret < 0)
578             return ret;
579 #else
580         ret = open_in(c, &in, url);
581         if (ret < 0)
582             return ret;
583         close_in = 1;
584 #endif
585     }
586
587     if (av_opt_get(in, "location", AV_OPT_SEARCH_CHILDREN, &new_url) >= 0)
588         url = new_url;
589
590     read_chomp_line(in, line, sizeof(line));
591     if (strcmp(line, "#EXTM3U")) {
592         ret = AVERROR_INVALIDDATA;
593         goto fail;
594     }
595
596     if (pls) {
597         free_segment_list(pls);
598         pls->finished = 0;
599         pls->type = PLS_TYPE_UNSPECIFIED;
600     }
601     while (!avio_feof(in)) {
602         read_chomp_line(in, line, sizeof(line));
603         if (av_strstart(line, "#EXT-X-STREAM-INF:", &ptr)) {
604             is_variant = 1;
605             memset(&variant_info, 0, sizeof(variant_info));
606             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_variant_args,
607                                &variant_info);
608         } else if (av_strstart(line, "#EXT-X-KEY:", &ptr)) {
609             struct key_info info = {{0}};
610             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_key_args,
611                                &info);
612             key_type = KEY_NONE;
613             has_iv = 0;
614             if (!strcmp(info.method, "AES-128"))
615                 key_type = KEY_AES_128;
616             if (!strcmp(info.method, "SAMPLE-AES"))
617                 key_type = KEY_SAMPLE_AES;
618             if (!strncmp(info.iv, "0x", 2) || !strncmp(info.iv, "0X", 2)) {
619                 ff_hex_to_data(iv, info.iv + 2);
620                 has_iv = 1;
621             }
622             av_strlcpy(key, info.uri, sizeof(key));
623         } else if (av_strstart(line, "#EXT-X-MEDIA:", &ptr)) {
624             struct rendition_info info = {{0}};
625             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_rendition_args,
626                                &info);
627             new_rendition(c, &info, url);
628         } else if (av_strstart(line, "#EXT-X-TARGETDURATION:", &ptr)) {
629             ret = ensure_playlist(c, &pls, url);
630             if (ret < 0)
631                 goto fail;
632             pls->target_duration = atoi(ptr) * AV_TIME_BASE;
633         } else if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
634             ret = ensure_playlist(c, &pls, url);
635             if (ret < 0)
636                 goto fail;
637             pls->start_seq_no = atoi(ptr);
638         } else if (av_strstart(line, "#EXT-X-PLAYLIST-TYPE:", &ptr)) {
639             ret = ensure_playlist(c, &pls, url);
640             if (ret < 0)
641                 goto fail;
642             if (!strcmp(ptr, "EVENT"))
643                 pls->type = PLS_TYPE_EVENT;
644             else if (!strcmp(ptr, "VOD"))
645                 pls->type = PLS_TYPE_VOD;
646         } else if (av_strstart(line, "#EXT-X-ENDLIST", &ptr)) {
647             if (pls)
648                 pls->finished = 1;
649         } else if (av_strstart(line, "#EXTINF:", &ptr)) {
650             is_segment = 1;
651             duration   = atof(ptr) * AV_TIME_BASE;
652         } else if (av_strstart(line, "#EXT-X-BYTERANGE:", &ptr)) {
653             seg_size = atoi(ptr);
654             ptr = strchr(ptr, '@');
655             if (ptr)
656                 seg_offset = atoi(ptr+1);
657         } else if (av_strstart(line, "#", NULL)) {
658             continue;
659         } else if (line[0]) {
660             if (is_variant) {
661                 if (!new_variant(c, &variant_info, line, url)) {
662                     ret = AVERROR(ENOMEM);
663                     goto fail;
664                 }
665                 is_variant = 0;
666             }
667             if (is_segment) {
668                 struct segment *seg;
669                 if (!pls) {
670                     if (!new_variant(c, 0, url, NULL)) {
671                         ret = AVERROR(ENOMEM);
672                         goto fail;
673                     }
674                     pls = c->playlists[c->n_playlists - 1];
675                 }
676                 seg = av_malloc(sizeof(struct segment));
677                 if (!seg) {
678                     ret = AVERROR(ENOMEM);
679                     goto fail;
680                 }
681                 seg->duration = duration;
682                 seg->key_type = key_type;
683                 if (has_iv) {
684                     memcpy(seg->iv, iv, sizeof(iv));
685                 } else {
686                     int seq = pls->start_seq_no + pls->n_segments;
687                     memset(seg->iv, 0, sizeof(seg->iv));
688                     AV_WB32(seg->iv + 12, seq);
689                 }
690
691                 if (key_type != KEY_NONE) {
692                     ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, key);
693                     seg->key = av_strdup(tmp_str);
694                     if (!seg->key) {
695                         av_free(seg);
696                         ret = AVERROR(ENOMEM);
697                         goto fail;
698                     }
699                 } else {
700                     seg->key = NULL;
701                 }
702
703                 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, line);
704                 seg->url = av_strdup(tmp_str);
705                 if (!seg->url) {
706                     av_free(seg->key);
707                     av_free(seg);
708                     ret = AVERROR(ENOMEM);
709                     goto fail;
710                 }
711
712                 dynarray_add(&pls->segments, &pls->n_segments, seg);
713                 is_segment = 0;
714
715                 seg->size = seg_size;
716                 if (seg_size >= 0) {
717                     seg->url_offset = seg_offset;
718                     seg_offset += seg_size;
719                     seg_size = -1;
720                 } else {
721                     seg->url_offset = 0;
722                     seg_offset = 0;
723                 }
724             }
725         }
726     }
727     if (pls)
728         pls->last_load_time = av_gettime_relative();
729
730 fail:
731     av_free(new_url);
732     if (close_in)
733         avio_close(in);
734     return ret;
735 }
736
737 enum ReadFromURLMode {
738     READ_NORMAL,
739     READ_COMPLETE,
740 };
741
742 /* read from URLContext, limiting read to current segment */
743 static int read_from_url(struct playlist *pls, uint8_t *buf, int buf_size,
744                          enum ReadFromURLMode mode)
745 {
746     int ret;
747     struct segment *seg = pls->segments[pls->cur_seq_no - pls->start_seq_no];
748
749      /* limit read if the segment was only a part of a file */
750     if (seg->size >= 0)
751         buf_size = FFMIN(buf_size, seg->size - pls->cur_seg_offset);
752
753     if (mode == READ_COMPLETE)
754         ret = ffurl_read_complete(pls->input, buf, buf_size);
755     else
756         ret = ffurl_read(pls->input, buf, buf_size);
757
758     if (ret > 0)
759         pls->cur_seg_offset += ret;
760
761     return ret;
762 }
763
764 /* Parse the raw ID3 data and pass contents to caller */
765 static void parse_id3(AVFormatContext *s, AVIOContext *pb,
766                       AVDictionary **metadata, int64_t *dts,
767                       ID3v2ExtraMetaAPIC **apic, ID3v2ExtraMeta **extra_meta)
768 {
769     static const char id3_priv_owner_ts[] = "com.apple.streaming.transportStreamTimestamp";
770     ID3v2ExtraMeta *meta;
771
772     ff_id3v2_read_dict(pb, metadata, ID3v2_DEFAULT_MAGIC, extra_meta);
773     for (meta = *extra_meta; meta; meta = meta->next) {
774         if (!strcmp(meta->tag, "PRIV")) {
775             ID3v2ExtraMetaPRIV *priv = meta->data;
776             if (priv->datasize == 8 && !strcmp(priv->owner, id3_priv_owner_ts)) {
777                 /* 33-bit MPEG timestamp */
778                 int64_t ts = AV_RB64(priv->data);
779                 av_log(s, AV_LOG_DEBUG, "HLS ID3 audio timestamp %"PRId64"\n", ts);
780                 if ((ts & ~((1ULL << 33) - 1)) == 0)
781                     *dts = ts;
782                 else
783                     av_log(s, AV_LOG_ERROR, "Invalid HLS ID3 audio timestamp %"PRId64"\n", ts);
784             }
785         } else if (!strcmp(meta->tag, "APIC") && apic)
786             *apic = meta->data;
787     }
788 }
789
790 /* Check if the ID3 metadata contents have changed */
791 static int id3_has_changed_values(struct playlist *pls, AVDictionary *metadata,
792                                   ID3v2ExtraMetaAPIC *apic)
793 {
794     AVDictionaryEntry *entry = NULL;
795     AVDictionaryEntry *oldentry;
796     /* check that no keys have changed values */
797     while ((entry = av_dict_get(metadata, "", entry, AV_DICT_IGNORE_SUFFIX))) {
798         oldentry = av_dict_get(pls->id3_initial, entry->key, NULL, AV_DICT_MATCH_CASE);
799         if (!oldentry || strcmp(oldentry->value, entry->value) != 0)
800             return 1;
801     }
802
803     /* check if apic appeared */
804     if (apic && (pls->ctx->nb_streams != 2 || !pls->ctx->streams[1]->attached_pic.data))
805         return 1;
806
807     if (apic) {
808         int size = pls->ctx->streams[1]->attached_pic.size;
809         if (size != apic->buf->size - AV_INPUT_BUFFER_PADDING_SIZE)
810             return 1;
811
812         if (memcmp(apic->buf->data, pls->ctx->streams[1]->attached_pic.data, size) != 0)
813             return 1;
814     }
815
816     return 0;
817 }
818
819 /* Parse ID3 data and handle the found data */
820 static void handle_id3(AVIOContext *pb, struct playlist *pls)
821 {
822     AVDictionary *metadata = NULL;
823     ID3v2ExtraMetaAPIC *apic = NULL;
824     ID3v2ExtraMeta *extra_meta = NULL;
825     int64_t timestamp = AV_NOPTS_VALUE;
826
827     parse_id3(pls->ctx, pb, &metadata, &timestamp, &apic, &extra_meta);
828
829     if (timestamp != AV_NOPTS_VALUE) {
830         pls->id3_mpegts_timestamp = timestamp;
831         pls->id3_offset = 0;
832     }
833
834     if (!pls->id3_found) {
835         /* initial ID3 tags */
836         av_assert0(!pls->id3_deferred_extra);
837         pls->id3_found = 1;
838
839         /* get picture attachment and set text metadata */
840         if (pls->ctx->nb_streams)
841             ff_id3v2_parse_apic(pls->ctx, &extra_meta);
842         else
843             /* demuxer not yet opened, defer picture attachment */
844             pls->id3_deferred_extra = extra_meta;
845
846         av_dict_copy(&pls->ctx->metadata, metadata, 0);
847         pls->id3_initial = metadata;
848
849     } else {
850         if (!pls->id3_changed && id3_has_changed_values(pls, metadata, apic)) {
851             avpriv_report_missing_feature(pls->ctx, "Changing ID3 metadata in HLS audio elementary stream");
852             pls->id3_changed = 1;
853         }
854         av_dict_free(&metadata);
855     }
856
857     if (!pls->id3_deferred_extra)
858         ff_id3v2_free_extra_meta(&extra_meta);
859 }
860
861 /* Intercept and handle ID3 tags between URLContext and AVIOContext */
862 static void intercept_id3(struct playlist *pls, uint8_t *buf,
863                          int buf_size, int *len)
864 {
865     /* intercept id3 tags, we do not want to pass them to the raw
866      * demuxer on all segment switches */
867     int bytes;
868     int id3_buf_pos = 0;
869     int fill_buf = 0;
870
871     /* gather all the id3 tags */
872     while (1) {
873         /* see if we can retrieve enough data for ID3 header */
874         if (*len < ID3v2_HEADER_SIZE && buf_size >= ID3v2_HEADER_SIZE) {
875             bytes = read_from_url(pls, buf + *len, ID3v2_HEADER_SIZE - *len, READ_COMPLETE);
876             if (bytes > 0) {
877
878                 if (bytes == ID3v2_HEADER_SIZE - *len)
879                     /* no EOF yet, so fill the caller buffer again after
880                      * we have stripped the ID3 tags */
881                     fill_buf = 1;
882
883                 *len += bytes;
884
885             } else if (*len <= 0) {
886                 /* error/EOF */
887                 *len = bytes;
888                 fill_buf = 0;
889             }
890         }
891
892         if (*len < ID3v2_HEADER_SIZE)
893             break;
894
895         if (ff_id3v2_match(buf, ID3v2_DEFAULT_MAGIC)) {
896             struct segment *seg = pls->segments[pls->cur_seq_no - pls->start_seq_no];
897             int64_t maxsize = seg->size >= 0 ? seg->size : 1024*1024;
898             int taglen = ff_id3v2_tag_len(buf);
899             int tag_got_bytes = FFMIN(taglen, *len);
900             int remaining = taglen - tag_got_bytes;
901
902             if (taglen > maxsize) {
903                 av_log(pls->ctx, AV_LOG_ERROR, "Too large HLS ID3 tag (%d > %"PRId64" bytes)\n",
904                        taglen, maxsize);
905                 break;
906             }
907
908             /*
909              * Copy the id3 tag to our temporary id3 buffer.
910              * We could read a small id3 tag directly without memcpy, but
911              * we would still need to copy the large tags, and handling
912              * both of those cases together with the possibility for multiple
913              * tags would make the handling a bit complex.
914              */
915             pls->id3_buf = av_fast_realloc(pls->id3_buf, &pls->id3_buf_size, id3_buf_pos + taglen);
916             if (!pls->id3_buf)
917                 break;
918             memcpy(pls->id3_buf + id3_buf_pos, buf, tag_got_bytes);
919             id3_buf_pos += tag_got_bytes;
920
921             /* strip the intercepted bytes */
922             *len -= tag_got_bytes;
923             memmove(buf, buf + tag_got_bytes, *len);
924             av_log(pls->ctx, AV_LOG_DEBUG, "Stripped %d HLS ID3 bytes\n", tag_got_bytes);
925
926             if (remaining > 0) {
927                 /* read the rest of the tag in */
928                 if (read_from_url(pls, pls->id3_buf + id3_buf_pos, remaining, READ_COMPLETE) != remaining)
929                     break;
930                 id3_buf_pos += remaining;
931                 av_log(pls->ctx, AV_LOG_DEBUG, "Stripped additional %d HLS ID3 bytes\n", remaining);
932             }
933
934         } else {
935             /* no more ID3 tags */
936             break;
937         }
938     }
939
940     /* re-fill buffer for the caller unless EOF */
941     if (*len >= 0 && (fill_buf || *len == 0)) {
942         bytes = read_from_url(pls, buf + *len, buf_size - *len, READ_NORMAL);
943
944         /* ignore error if we already had some data */
945         if (bytes >= 0)
946             *len += bytes;
947         else if (*len == 0)
948             *len = bytes;
949     }
950
951     if (pls->id3_buf) {
952         /* Now parse all the ID3 tags */
953         AVIOContext id3ioctx;
954         ffio_init_context(&id3ioctx, pls->id3_buf, id3_buf_pos, 0, NULL, NULL, NULL, NULL);
955         handle_id3(&id3ioctx, pls);
956     }
957
958     if (pls->is_id3_timestamped == -1)
959         pls->is_id3_timestamped = (pls->id3_mpegts_timestamp != AV_NOPTS_VALUE);
960 }
961
962 static int open_input(HLSContext *c, struct playlist *pls)
963 {
964     AVDictionary *opts = NULL;
965     int ret;
966     struct segment *seg = pls->segments[pls->cur_seq_no - pls->start_seq_no];
967
968     // broker prior HTTP options that should be consistent across requests
969     av_dict_set(&opts, "user-agent", c->user_agent, 0);
970     av_dict_set(&opts, "cookies", c->cookies, 0);
971     av_dict_set(&opts, "headers", c->headers, 0);
972     av_dict_set(&opts, "seekable", "0", 0);
973
974     if (seg->size >= 0) {
975         /* try to restrict the HTTP request to the part we want
976          * (if this is in fact a HTTP request) */
977         av_dict_set_int(&opts, "offset", seg->url_offset, 0);
978         av_dict_set_int(&opts, "end_offset", seg->url_offset + seg->size, 0);
979     }
980
981     av_log(pls->parent, AV_LOG_VERBOSE, "HLS request for url '%s', offset %"PRId64", playlist %d\n",
982            seg->url, seg->url_offset, pls->index);
983
984     if (seg->key_type == KEY_NONE) {
985         ret = open_url(pls->parent->priv_data, &pls->input, seg->url, opts);
986     } else if (seg->key_type == KEY_AES_128) {
987 //         HLSContext *c = var->parent->priv_data;
988         char iv[33], key[33], url[MAX_URL_SIZE];
989         if (strcmp(seg->key, pls->key_url)) {
990             URLContext *uc;
991             if (open_url(pls->parent->priv_data, &uc, seg->key, opts) == 0) {
992                 if (ffurl_read_complete(uc, pls->key, sizeof(pls->key))
993                     != sizeof(pls->key)) {
994                     av_log(NULL, AV_LOG_ERROR, "Unable to read key file %s\n",
995                            seg->key);
996                 }
997                 ffurl_close(uc);
998             } else {
999                 av_log(NULL, AV_LOG_ERROR, "Unable to open key file %s\n",
1000                        seg->key);
1001             }
1002             av_strlcpy(pls->key_url, seg->key, sizeof(pls->key_url));
1003         }
1004         ff_data_to_hex(iv, seg->iv, sizeof(seg->iv), 0);
1005         ff_data_to_hex(key, pls->key, sizeof(pls->key), 0);
1006         iv[32] = key[32] = '\0';
1007         if (strstr(seg->url, "://"))
1008             snprintf(url, sizeof(url), "crypto+%s", seg->url);
1009         else
1010             snprintf(url, sizeof(url), "crypto:%s", seg->url);
1011
1012         if ((ret = ffurl_alloc(&pls->input, url, AVIO_FLAG_READ,
1013                                &pls->parent->interrupt_callback)) < 0)
1014             goto cleanup;
1015         av_opt_set(pls->input->priv_data, "key", key, 0);
1016         av_opt_set(pls->input->priv_data, "iv", iv, 0);
1017
1018         if ((ret = url_connect(pls, c->avio_opts, opts)) < 0) {
1019             goto cleanup;
1020         }
1021         ret = 0;
1022     } else if (seg->key_type == KEY_SAMPLE_AES) {
1023         av_log(pls->parent, AV_LOG_ERROR,
1024                "SAMPLE-AES encryption is not supported yet\n");
1025         ret = AVERROR_PATCHWELCOME;
1026     }
1027     else
1028       ret = AVERROR(ENOSYS);
1029
1030     /* Seek to the requested position. If this was a HTTP request, the offset
1031      * should already be where want it to, but this allows e.g. local testing
1032      * without a HTTP server. */
1033     if (ret == 0 && seg->key_type == KEY_NONE && seg->url_offset) {
1034         int seekret = ffurl_seek(pls->input, seg->url_offset, SEEK_SET);
1035         if (seekret < 0) {
1036             av_log(pls->parent, AV_LOG_ERROR, "Unable to seek to offset %"PRId64" of HLS segment '%s'\n", seg->url_offset, seg->url);
1037             ret = seekret;
1038             ffurl_close(pls->input);
1039             pls->input = NULL;
1040         }
1041     }
1042
1043 cleanup:
1044     av_dict_free(&opts);
1045     pls->cur_seg_offset = 0;
1046     return ret;
1047 }
1048
1049 static int64_t default_reload_interval(struct playlist *pls)
1050 {
1051     return pls->n_segments > 0 ?
1052                           pls->segments[pls->n_segments - 1]->duration :
1053                           pls->target_duration;
1054 }
1055
1056 static int read_data(void *opaque, uint8_t *buf, int buf_size)
1057 {
1058     struct playlist *v = opaque;
1059     HLSContext *c = v->parent->priv_data;
1060     int ret, i;
1061     int just_opened = 0;
1062
1063 restart:
1064     if (!v->needed)
1065         return AVERROR_EOF;
1066
1067     if (!v->input) {
1068         int64_t reload_interval;
1069
1070         /* Check that the playlist is still needed before opening a new
1071          * segment. */
1072         if (v->ctx && v->ctx->nb_streams &&
1073             v->parent->nb_streams >= v->stream_offset + v->ctx->nb_streams) {
1074             v->needed = 0;
1075             for (i = v->stream_offset; i < v->stream_offset + v->ctx->nb_streams;
1076                 i++) {
1077                 if (v->parent->streams[i]->discard < AVDISCARD_ALL)
1078                     v->needed = 1;
1079             }
1080         }
1081         if (!v->needed) {
1082             av_log(v->parent, AV_LOG_INFO, "No longer receiving playlist %d\n",
1083                 v->index);
1084             return AVERROR_EOF;
1085         }
1086
1087         /* If this is a live stream and the reload interval has elapsed since
1088          * the last playlist reload, reload the playlists now. */
1089         reload_interval = default_reload_interval(v);
1090
1091 reload:
1092         if (!v->finished &&
1093             av_gettime_relative() - v->last_load_time >= reload_interval) {
1094             if ((ret = parse_playlist(c, v->url, v, NULL)) < 0) {
1095                 av_log(v->parent, AV_LOG_WARNING, "Failed to reload playlist %d\n",
1096                        v->index);
1097                 return ret;
1098             }
1099             /* If we need to reload the playlist again below (if
1100              * there's still no more segments), switch to a reload
1101              * interval of half the target duration. */
1102             reload_interval = v->target_duration / 2;
1103         }
1104         if (v->cur_seq_no < v->start_seq_no) {
1105             av_log(NULL, AV_LOG_WARNING,
1106                    "skipping %d segments ahead, expired from playlists\n",
1107                    v->start_seq_no - v->cur_seq_no);
1108             v->cur_seq_no = v->start_seq_no;
1109         }
1110         if (v->cur_seq_no >= v->start_seq_no + v->n_segments) {
1111             if (v->finished)
1112                 return AVERROR_EOF;
1113             while (av_gettime_relative() - v->last_load_time < reload_interval) {
1114                 if (ff_check_interrupt(c->interrupt_callback))
1115                     return AVERROR_EXIT;
1116                 av_usleep(100*1000);
1117             }
1118             /* Enough time has elapsed since the last reload */
1119             goto reload;
1120         }
1121
1122         ret = open_input(c, v);
1123         if (ret < 0) {
1124             if (ff_check_interrupt(c->interrupt_callback))
1125                 return AVERROR_EXIT;
1126             av_log(v->parent, AV_LOG_WARNING, "Failed to open segment of playlist %d\n",
1127                    v->index);
1128             v->cur_seq_no += 1;
1129             goto reload;
1130         }
1131         just_opened = 1;
1132     }
1133
1134     ret = read_from_url(v, buf, buf_size, READ_NORMAL);
1135     if (ret > 0) {
1136         if (just_opened && v->is_id3_timestamped != 0) {
1137             /* Intercept ID3 tags here, elementary audio streams are required
1138              * to convey timestamps using them in the beginning of each segment. */
1139             intercept_id3(v, buf, buf_size, &ret);
1140         }
1141
1142         return ret;
1143     }
1144     ffurl_close(v->input);
1145     v->input = NULL;
1146     v->cur_seq_no++;
1147
1148     c->cur_seq_no = v->cur_seq_no;
1149
1150     goto restart;
1151 }
1152
1153 static int playlist_in_multiple_variants(HLSContext *c, struct playlist *pls)
1154 {
1155     int variant_count = 0;
1156     int i, j;
1157
1158     for (i = 0; i < c->n_variants && variant_count < 2; i++) {
1159         struct variant *v = c->variants[i];
1160
1161         for (j = 0; j < v->n_playlists; j++) {
1162             if (v->playlists[j] == pls) {
1163                 variant_count++;
1164                 break;
1165             }
1166         }
1167     }
1168
1169     return variant_count >= 2;
1170 }
1171
1172 static void add_renditions_to_variant(HLSContext *c, struct variant *var,
1173                                       enum AVMediaType type, const char *group_id)
1174 {
1175     int i;
1176
1177     for (i = 0; i < c->n_renditions; i++) {
1178         struct rendition *rend = c->renditions[i];
1179
1180         if (rend->type == type && !strcmp(rend->group_id, group_id)) {
1181
1182             if (rend->playlist)
1183                 /* rendition is an external playlist
1184                  * => add the playlist to the variant */
1185                 dynarray_add(&var->playlists, &var->n_playlists, rend->playlist);
1186             else
1187                 /* rendition is part of the variant main Media Playlist
1188                  * => add the rendition to the main Media Playlist */
1189                 dynarray_add(&var->playlists[0]->renditions,
1190                              &var->playlists[0]->n_renditions,
1191                              rend);
1192         }
1193     }
1194 }
1195
1196 static void add_metadata_from_renditions(AVFormatContext *s, struct playlist *pls,
1197                                          enum AVMediaType type)
1198 {
1199     int rend_idx = 0;
1200     int i;
1201
1202     for (i = 0; i < pls->ctx->nb_streams; i++) {
1203         AVStream *st = s->streams[pls->stream_offset + i];
1204
1205         if (st->codec->codec_type != type)
1206             continue;
1207
1208         for (; rend_idx < pls->n_renditions; rend_idx++) {
1209             struct rendition *rend = pls->renditions[rend_idx];
1210
1211             if (rend->type != type)
1212                 continue;
1213
1214             if (rend->language[0])
1215                 av_dict_set(&st->metadata, "language", rend->language, 0);
1216             if (rend->name[0])
1217                 av_dict_set(&st->metadata, "comment", rend->name, 0);
1218
1219             st->disposition |= rend->disposition;
1220         }
1221         if (rend_idx >=pls->n_renditions)
1222             break;
1223     }
1224 }
1225
1226 /* if timestamp was in valid range: returns 1 and sets seq_no
1227  * if not: returns 0 and sets seq_no to closest segment */
1228 static int find_timestamp_in_playlist(HLSContext *c, struct playlist *pls,
1229                                       int64_t timestamp, int *seq_no)
1230 {
1231     int i;
1232     int64_t pos = c->first_timestamp == AV_NOPTS_VALUE ?
1233                   0 : c->first_timestamp;
1234
1235     if (timestamp < pos) {
1236         *seq_no = pls->start_seq_no;
1237         return 0;
1238     }
1239
1240     for (i = 0; i < pls->n_segments; i++) {
1241         int64_t diff = pos + pls->segments[i]->duration - timestamp;
1242         if (diff > 0) {
1243             *seq_no = pls->start_seq_no + i;
1244             return 1;
1245         }
1246         pos += pls->segments[i]->duration;
1247     }
1248
1249     *seq_no = pls->start_seq_no + pls->n_segments - 1;
1250
1251     return 0;
1252 }
1253
1254 static int select_cur_seq_no(HLSContext *c, struct playlist *pls)
1255 {
1256     int seq_no;
1257
1258     if (!pls->finished && !c->first_packet &&
1259         av_gettime_relative() - pls->last_load_time >= default_reload_interval(pls))
1260         /* reload the playlist since it was suspended */
1261         parse_playlist(c, pls->url, pls, NULL);
1262
1263     /* If playback is already in progress (we are just selecting a new
1264      * playlist) and this is a complete file, find the matching segment
1265      * by counting durations. */
1266     if (pls->finished && c->cur_timestamp != AV_NOPTS_VALUE) {
1267         find_timestamp_in_playlist(c, pls, c->cur_timestamp, &seq_no);
1268         return seq_no;
1269     }
1270
1271     if (!pls->finished) {
1272         if (!c->first_packet && /* we are doing a segment selection during playback */
1273             c->cur_seq_no >= pls->start_seq_no &&
1274             c->cur_seq_no < pls->start_seq_no + pls->n_segments)
1275             /* While spec 3.4.3 says that we cannot assume anything about the
1276              * content at the same sequence number on different playlists,
1277              * in practice this seems to work and doing it otherwise would
1278              * require us to download a segment to inspect its timestamps. */
1279             return c->cur_seq_no;
1280
1281         /* If this is a live stream, start live_start_index segments from the
1282          * start or end */
1283         if (c->live_start_index < 0)
1284             return pls->start_seq_no + FFMAX(pls->n_segments + c->live_start_index, 0);
1285         else
1286             return pls->start_seq_no + FFMIN(c->live_start_index, pls->n_segments - 1);
1287     }
1288
1289     /* Otherwise just start on the first segment. */
1290     return pls->start_seq_no;
1291 }
1292
1293 static int save_avio_options(AVFormatContext *s)
1294 {
1295     HLSContext *c = s->priv_data;
1296     const char *opts[] = { "headers", "user_agent", "user-agent", "cookies", NULL }, **opt = opts;
1297     uint8_t *buf;
1298     int ret = 0;
1299
1300     while (*opt) {
1301         if (av_opt_get(s->pb, *opt, AV_OPT_SEARCH_CHILDREN, &buf) >= 0) {
1302             ret = av_dict_set(&c->avio_opts, *opt, buf,
1303                               AV_DICT_DONT_STRDUP_VAL);
1304             if (ret < 0)
1305                 return ret;
1306         }
1307         opt++;
1308     }
1309
1310     return ret;
1311 }
1312
1313 static int hls_read_header(AVFormatContext *s)
1314 {
1315     URLContext *u = (s->flags & AVFMT_FLAG_CUSTOM_IO) ? NULL : s->pb->opaque;
1316     HLSContext *c = s->priv_data;
1317     int ret = 0, i, j, stream_offset = 0;
1318
1319     c->interrupt_callback = &s->interrupt_callback;
1320
1321     c->first_packet = 1;
1322     c->first_timestamp = AV_NOPTS_VALUE;
1323     c->cur_timestamp = AV_NOPTS_VALUE;
1324
1325     // if the URL context is good, read important options we must broker later
1326     if (u && u->prot->priv_data_class) {
1327         // get the previous user agent & set back to null if string size is zero
1328         update_options(&c->user_agent, "user-agent", u->priv_data);
1329
1330         // get the previous cookies & set back to null if string size is zero
1331         update_options(&c->cookies, "cookies", u->priv_data);
1332
1333         // get the previous headers & set back to null if string size is zero
1334         update_options(&c->headers, "headers", u->priv_data);
1335     }
1336
1337     if ((ret = parse_playlist(c, s->filename, NULL, s->pb)) < 0)
1338         goto fail;
1339
1340     if ((ret = save_avio_options(s)) < 0)
1341         goto fail;
1342
1343     /* Some HLS servers don't like being sent the range header */
1344     av_dict_set(&c->avio_opts, "seekable", "0", 0);
1345
1346     if (c->n_variants == 0) {
1347         av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1348         ret = AVERROR_EOF;
1349         goto fail;
1350     }
1351     /* If the playlist only contained playlists (Master Playlist),
1352      * parse each individual playlist. */
1353     if (c->n_playlists > 1 || c->playlists[0]->n_segments == 0) {
1354         for (i = 0; i < c->n_playlists; i++) {
1355             struct playlist *pls = c->playlists[i];
1356             if ((ret = parse_playlist(c, pls->url, pls, NULL)) < 0)
1357                 goto fail;
1358         }
1359     }
1360
1361     if (c->variants[0]->playlists[0]->n_segments == 0) {
1362         av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1363         ret = AVERROR_EOF;
1364         goto fail;
1365     }
1366
1367     /* If this isn't a live stream, calculate the total duration of the
1368      * stream. */
1369     if (c->variants[0]->playlists[0]->finished) {
1370         int64_t duration = 0;
1371         for (i = 0; i < c->variants[0]->playlists[0]->n_segments; i++)
1372             duration += c->variants[0]->playlists[0]->segments[i]->duration;
1373         s->duration = duration;
1374     }
1375
1376     /* Associate renditions with variants */
1377     for (i = 0; i < c->n_variants; i++) {
1378         struct variant *var = c->variants[i];
1379
1380         if (var->audio_group[0])
1381             add_renditions_to_variant(c, var, AVMEDIA_TYPE_AUDIO, var->audio_group);
1382         if (var->video_group[0])
1383             add_renditions_to_variant(c, var, AVMEDIA_TYPE_VIDEO, var->video_group);
1384         if (var->subtitles_group[0])
1385             add_renditions_to_variant(c, var, AVMEDIA_TYPE_SUBTITLE, var->subtitles_group);
1386     }
1387
1388     /* Open the demuxer for each playlist */
1389     for (i = 0; i < c->n_playlists; i++) {
1390         struct playlist *pls = c->playlists[i];
1391         AVInputFormat *in_fmt = NULL;
1392
1393         if (!(pls->ctx = avformat_alloc_context())) {
1394             ret = AVERROR(ENOMEM);
1395             goto fail;
1396         }
1397
1398         if (pls->n_segments == 0)
1399             continue;
1400
1401         pls->index  = i;
1402         pls->needed = 1;
1403         pls->parent = s;
1404         pls->cur_seq_no = select_cur_seq_no(c, pls);
1405
1406         pls->read_buffer = av_malloc(INITIAL_BUFFER_SIZE);
1407         if (!pls->read_buffer){
1408             ret = AVERROR(ENOMEM);
1409             avformat_free_context(pls->ctx);
1410             pls->ctx = NULL;
1411             goto fail;
1412         }
1413         ffio_init_context(&pls->pb, pls->read_buffer, INITIAL_BUFFER_SIZE, 0, pls,
1414                           read_data, NULL, NULL);
1415         pls->pb.seekable = 0;
1416         ret = av_probe_input_buffer(&pls->pb, &in_fmt, pls->segments[0]->url,
1417                                     NULL, 0, 0);
1418         if (ret < 0) {
1419             /* Free the ctx - it isn't initialized properly at this point,
1420              * so avformat_close_input shouldn't be called. If
1421              * avformat_open_input fails below, it frees and zeros the
1422              * context, so it doesn't need any special treatment like this. */
1423             av_log(s, AV_LOG_ERROR, "Error when loading first segment '%s'\n", pls->segments[0]->url);
1424             avformat_free_context(pls->ctx);
1425             pls->ctx = NULL;
1426             goto fail;
1427         }
1428         pls->ctx->pb       = &pls->pb;
1429         pls->stream_offset = stream_offset;
1430
1431         if ((ret = ff_copy_whitelists(pls->ctx, s)) < 0)
1432             goto fail;
1433
1434         ret = avformat_open_input(&pls->ctx, pls->segments[0]->url, in_fmt, NULL);
1435         if (ret < 0)
1436             goto fail;
1437
1438         if (pls->id3_deferred_extra && pls->ctx->nb_streams == 1) {
1439             ff_id3v2_parse_apic(pls->ctx, &pls->id3_deferred_extra);
1440             avformat_queue_attached_pictures(pls->ctx);
1441             ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
1442             pls->id3_deferred_extra = NULL;
1443         }
1444
1445         pls->ctx->ctx_flags &= ~AVFMTCTX_NOHEADER;
1446         ret = avformat_find_stream_info(pls->ctx, NULL);
1447         if (ret < 0)
1448             goto fail;
1449
1450         if (pls->is_id3_timestamped == -1)
1451             av_log(s, AV_LOG_WARNING, "No expected HTTP requests have been made\n");
1452
1453         /* Create new AVStreams for each stream in this playlist */
1454         for (j = 0; j < pls->ctx->nb_streams; j++) {
1455             AVStream *st = avformat_new_stream(s, NULL);
1456             AVStream *ist = pls->ctx->streams[j];
1457             if (!st) {
1458                 ret = AVERROR(ENOMEM);
1459                 goto fail;
1460             }
1461             st->id = i;
1462
1463             avcodec_copy_context(st->codec, pls->ctx->streams[j]->codec);
1464
1465             if (pls->is_id3_timestamped) /* custom timestamps via id3 */
1466                 avpriv_set_pts_info(st, 33, 1, MPEG_TIME_BASE);
1467             else
1468                 avpriv_set_pts_info(st, ist->pts_wrap_bits, ist->time_base.num, ist->time_base.den);
1469         }
1470
1471         add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_AUDIO);
1472         add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_VIDEO);
1473         add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_SUBTITLE);
1474
1475         stream_offset += pls->ctx->nb_streams;
1476     }
1477
1478     /* Create a program for each variant */
1479     for (i = 0; i < c->n_variants; i++) {
1480         struct variant *v = c->variants[i];
1481         AVProgram *program;
1482
1483         program = av_new_program(s, i);
1484         if (!program)
1485             goto fail;
1486         av_dict_set_int(&program->metadata, "variant_bitrate", v->bandwidth, 0);
1487
1488         for (j = 0; j < v->n_playlists; j++) {
1489             struct playlist *pls = v->playlists[j];
1490             int is_shared = playlist_in_multiple_variants(c, pls);
1491             int k;
1492
1493             for (k = 0; k < pls->ctx->nb_streams; k++) {
1494                 struct AVStream *st = s->streams[pls->stream_offset + k];
1495
1496                 ff_program_add_stream_index(s, i, pls->stream_offset + k);
1497
1498                 /* Set variant_bitrate for streams unique to this variant */
1499                 if (!is_shared && v->bandwidth)
1500                     av_dict_set_int(&st->metadata, "variant_bitrate", v->bandwidth, 0);
1501             }
1502         }
1503     }
1504
1505     return 0;
1506 fail:
1507     free_playlist_list(c);
1508     free_variant_list(c);
1509     free_rendition_list(c);
1510     return ret;
1511 }
1512
1513 static int recheck_discard_flags(AVFormatContext *s, int first)
1514 {
1515     HLSContext *c = s->priv_data;
1516     int i, changed = 0;
1517
1518     /* Check if any new streams are needed */
1519     for (i = 0; i < c->n_playlists; i++)
1520         c->playlists[i]->cur_needed = 0;
1521
1522     for (i = 0; i < s->nb_streams; i++) {
1523         AVStream *st = s->streams[i];
1524         struct playlist *pls = c->playlists[s->streams[i]->id];
1525         if (st->discard < AVDISCARD_ALL)
1526             pls->cur_needed = 1;
1527     }
1528     for (i = 0; i < c->n_playlists; i++) {
1529         struct playlist *pls = c->playlists[i];
1530         if (pls->cur_needed && !pls->needed) {
1531             pls->needed = 1;
1532             changed = 1;
1533             pls->cur_seq_no = select_cur_seq_no(c, pls);
1534             pls->pb.eof_reached = 0;
1535             if (c->cur_timestamp != AV_NOPTS_VALUE) {
1536                 /* catch up */
1537                 pls->seek_timestamp = c->cur_timestamp;
1538                 pls->seek_flags = AVSEEK_FLAG_ANY;
1539                 pls->seek_stream_index = -1;
1540             }
1541             av_log(s, AV_LOG_INFO, "Now receiving playlist %d, segment %d\n", i, pls->cur_seq_no);
1542         } else if (first && !pls->cur_needed && pls->needed) {
1543             if (pls->input)
1544                 ffurl_close(pls->input);
1545             pls->input = NULL;
1546             pls->needed = 0;
1547             changed = 1;
1548             av_log(s, AV_LOG_INFO, "No longer receiving playlist %d\n", i);
1549         }
1550     }
1551     return changed;
1552 }
1553
1554 static void fill_timing_for_id3_timestamped_stream(struct playlist *pls)
1555 {
1556     if (pls->id3_offset >= 0) {
1557         pls->pkt.dts = pls->id3_mpegts_timestamp +
1558                                  av_rescale_q(pls->id3_offset,
1559                                               pls->ctx->streams[pls->pkt.stream_index]->time_base,
1560                                               MPEG_TIME_BASE_Q);
1561         if (pls->pkt.duration)
1562             pls->id3_offset += pls->pkt.duration;
1563         else
1564             pls->id3_offset = -1;
1565     } else {
1566         /* there have been packets with unknown duration
1567          * since the last id3 tag, should not normally happen */
1568         pls->pkt.dts = AV_NOPTS_VALUE;
1569     }
1570
1571     if (pls->pkt.duration)
1572         pls->pkt.duration = av_rescale_q(pls->pkt.duration,
1573                                          pls->ctx->streams[pls->pkt.stream_index]->time_base,
1574                                          MPEG_TIME_BASE_Q);
1575
1576     pls->pkt.pts = AV_NOPTS_VALUE;
1577 }
1578
1579 static AVRational get_timebase(struct playlist *pls)
1580 {
1581     if (pls->is_id3_timestamped)
1582         return MPEG_TIME_BASE_Q;
1583
1584     return pls->ctx->streams[pls->pkt.stream_index]->time_base;
1585 }
1586
1587 static int compare_ts_with_wrapdetect(int64_t ts_a, struct playlist *pls_a,
1588                                       int64_t ts_b, struct playlist *pls_b)
1589 {
1590     int64_t scaled_ts_a = av_rescale_q(ts_a, get_timebase(pls_a), MPEG_TIME_BASE_Q);
1591     int64_t scaled_ts_b = av_rescale_q(ts_b, get_timebase(pls_b), MPEG_TIME_BASE_Q);
1592
1593     return av_compare_mod(scaled_ts_a, scaled_ts_b, 1LL << 33);
1594 }
1595
1596 static int hls_read_packet(AVFormatContext *s, AVPacket *pkt)
1597 {
1598     HLSContext *c = s->priv_data;
1599     int ret, i, minplaylist = -1;
1600
1601     recheck_discard_flags(s, c->first_packet);
1602
1603     for (i = 0; i < c->n_playlists; i++) {
1604         struct playlist *pls = c->playlists[i];
1605         /* Make sure we've got one buffered packet from each open playlist
1606          * stream */
1607         if (pls->needed && !pls->pkt.data) {
1608             while (1) {
1609                 int64_t ts_diff;
1610                 AVRational tb;
1611                 ret = av_read_frame(pls->ctx, &pls->pkt);
1612                 if (ret < 0) {
1613                     if (!avio_feof(&pls->pb) && ret != AVERROR_EOF)
1614                         return ret;
1615                     reset_packet(&pls->pkt);
1616                     break;
1617                 } else {
1618                     /* stream_index check prevents matching picture attachments etc. */
1619                     if (pls->is_id3_timestamped && pls->pkt.stream_index == 0) {
1620                         /* audio elementary streams are id3 timestamped */
1621                         fill_timing_for_id3_timestamped_stream(pls);
1622                     }
1623
1624                     if (c->first_timestamp == AV_NOPTS_VALUE &&
1625                         pls->pkt.dts       != AV_NOPTS_VALUE)
1626                         c->first_timestamp = av_rescale_q(pls->pkt.dts,
1627                             get_timebase(pls), AV_TIME_BASE_Q);
1628                 }
1629
1630                 if (pls->seek_timestamp == AV_NOPTS_VALUE)
1631                     break;
1632
1633                 if (pls->seek_stream_index < 0 ||
1634                     pls->seek_stream_index == pls->pkt.stream_index) {
1635
1636                     if (pls->pkt.dts == AV_NOPTS_VALUE) {
1637                         pls->seek_timestamp = AV_NOPTS_VALUE;
1638                         break;
1639                     }
1640
1641                     tb = get_timebase(pls);
1642                     ts_diff = av_rescale_rnd(pls->pkt.dts, AV_TIME_BASE,
1643                                             tb.den, AV_ROUND_DOWN) -
1644                             pls->seek_timestamp;
1645                     if (ts_diff >= 0 && (pls->seek_flags  & AVSEEK_FLAG_ANY ||
1646                                         pls->pkt.flags & AV_PKT_FLAG_KEY)) {
1647                         pls->seek_timestamp = AV_NOPTS_VALUE;
1648                         break;
1649                     }
1650                 }
1651                 av_free_packet(&pls->pkt);
1652                 reset_packet(&pls->pkt);
1653             }
1654         }
1655         /* Check if this stream has the packet with the lowest dts */
1656         if (pls->pkt.data) {
1657             struct playlist *minpls = minplaylist < 0 ?
1658                                      NULL : c->playlists[minplaylist];
1659             if (minplaylist < 0) {
1660                 minplaylist = i;
1661             } else {
1662                 int64_t dts     =    pls->pkt.dts;
1663                 int64_t mindts  = minpls->pkt.dts;
1664
1665                 if (dts == AV_NOPTS_VALUE ||
1666                     (mindts != AV_NOPTS_VALUE && compare_ts_with_wrapdetect(dts, pls, mindts, minpls) < 0))
1667                     minplaylist = i;
1668             }
1669         }
1670     }
1671
1672     /* If we got a packet, return it */
1673     if (minplaylist >= 0) {
1674         struct playlist *pls = c->playlists[minplaylist];
1675         *pkt = pls->pkt;
1676         pkt->stream_index += pls->stream_offset;
1677         reset_packet(&c->playlists[minplaylist]->pkt);
1678
1679         if (pkt->dts != AV_NOPTS_VALUE)
1680             c->cur_timestamp = av_rescale_q(pkt->dts,
1681                                             pls->ctx->streams[pls->pkt.stream_index]->time_base,
1682                                             AV_TIME_BASE_Q);
1683
1684         return 0;
1685     }
1686     return AVERROR_EOF;
1687 }
1688
1689 static int hls_close(AVFormatContext *s)
1690 {
1691     HLSContext *c = s->priv_data;
1692
1693     free_playlist_list(c);
1694     free_variant_list(c);
1695     free_rendition_list(c);
1696
1697     av_dict_free(&c->avio_opts);
1698
1699     return 0;
1700 }
1701
1702 static int hls_read_seek(AVFormatContext *s, int stream_index,
1703                                int64_t timestamp, int flags)
1704 {
1705     HLSContext *c = s->priv_data;
1706     struct playlist *seek_pls = NULL;
1707     int i, seq_no;
1708     int64_t first_timestamp, seek_timestamp, duration;
1709
1710     if ((flags & AVSEEK_FLAG_BYTE) ||
1711         !(c->variants[0]->playlists[0]->finished || c->variants[0]->playlists[0]->type == PLS_TYPE_EVENT))
1712         return AVERROR(ENOSYS);
1713
1714     first_timestamp = c->first_timestamp == AV_NOPTS_VALUE ?
1715                       0 : c->first_timestamp;
1716
1717     seek_timestamp = av_rescale_rnd(timestamp, AV_TIME_BASE,
1718                                     s->streams[stream_index]->time_base.den,
1719                                     flags & AVSEEK_FLAG_BACKWARD ?
1720                                     AV_ROUND_DOWN : AV_ROUND_UP);
1721
1722     duration = s->duration == AV_NOPTS_VALUE ?
1723                0 : s->duration;
1724
1725     if (0 < duration && duration < seek_timestamp - first_timestamp)
1726         return AVERROR(EIO);
1727
1728     /* find the playlist with the specified stream */
1729     for (i = 0; i < c->n_playlists; i++) {
1730         struct playlist *pls = c->playlists[i];
1731         if (stream_index >= pls->stream_offset &&
1732             stream_index - pls->stream_offset < pls->ctx->nb_streams) {
1733             seek_pls = pls;
1734             break;
1735         }
1736     }
1737     /* check if the timestamp is valid for the playlist with the
1738      * specified stream index */
1739     if (!seek_pls || !find_timestamp_in_playlist(c, seek_pls, seek_timestamp, &seq_no))
1740         return AVERROR(EIO);
1741
1742     /* set segment now so we do not need to search again below */
1743     seek_pls->cur_seq_no = seq_no;
1744     seek_pls->seek_stream_index = stream_index - seek_pls->stream_offset;
1745
1746     for (i = 0; i < c->n_playlists; i++) {
1747         /* Reset reading */
1748         struct playlist *pls = c->playlists[i];
1749         if (pls->input) {
1750             ffurl_close(pls->input);
1751             pls->input = NULL;
1752         }
1753         av_free_packet(&pls->pkt);
1754         reset_packet(&pls->pkt);
1755         pls->pb.eof_reached = 0;
1756         /* Clear any buffered data */
1757         pls->pb.buf_end = pls->pb.buf_ptr = pls->pb.buffer;
1758         /* Reset the pos, to let the mpegts demuxer know we've seeked. */
1759         pls->pb.pos = 0;
1760         /* Flush the packet queue of the subdemuxer. */
1761         ff_read_frame_flush(pls->ctx);
1762
1763         pls->seek_timestamp = seek_timestamp;
1764         pls->seek_flags = flags;
1765
1766         if (pls != seek_pls) {
1767             /* set closest segment seq_no for playlists not handled above */
1768             find_timestamp_in_playlist(c, pls, seek_timestamp, &pls->cur_seq_no);
1769             /* seek the playlist to the given position without taking
1770              * keyframes into account since this playlist does not have the
1771              * specified stream where we should look for the keyframes */
1772             pls->seek_stream_index = -1;
1773             pls->seek_flags |= AVSEEK_FLAG_ANY;
1774         }
1775     }
1776
1777     c->cur_timestamp = seek_timestamp;
1778
1779     return 0;
1780 }
1781
1782 static int hls_probe(AVProbeData *p)
1783 {
1784     /* Require #EXTM3U at the start, and either one of the ones below
1785      * somewhere for a proper match. */
1786     if (strncmp(p->buf, "#EXTM3U", 7))
1787         return 0;
1788     if (strstr(p->buf, "#EXT-X-STREAM-INF:")     ||
1789         strstr(p->buf, "#EXT-X-TARGETDURATION:") ||
1790         strstr(p->buf, "#EXT-X-MEDIA-SEQUENCE:"))
1791         return AVPROBE_SCORE_MAX;
1792     return 0;
1793 }
1794
1795 #define OFFSET(x) offsetof(HLSContext, x)
1796 #define FLAGS AV_OPT_FLAG_DECODING_PARAM
1797 static const AVOption hls_options[] = {
1798     {"live_start_index", "segment index to start live streams at (negative values are from the end)",
1799         OFFSET(live_start_index), AV_OPT_TYPE_INT, {.i64 = -3}, INT_MIN, INT_MAX, FLAGS},
1800     {NULL}
1801 };
1802
1803 static const AVClass hls_class = {
1804     .class_name = "hls,applehttp",
1805     .item_name  = av_default_item_name,
1806     .option     = hls_options,
1807     .version    = LIBAVUTIL_VERSION_INT,
1808 };
1809
1810 AVInputFormat ff_hls_demuxer = {
1811     .name           = "hls,applehttp",
1812     .long_name      = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
1813     .priv_class     = &hls_class,
1814     .priv_data_size = sizeof(HLSContext),
1815     .read_probe     = hls_probe,
1816     .read_header    = hls_read_header,
1817     .read_packet    = hls_read_packet,
1818     .read_close     = hls_close,
1819     .read_seek      = hls_read_seek,
1820 };