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