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