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