git.sesse.net Git - ffmpeg/blob - 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 "libavformat/http.h"
  30 #include "libavutil/avstring.h"
  31 #include "libavutil/avassert.h"
  32 #include "libavutil/intreadwrite.h"
  33 #include "libavutil/mathematics.h"
  34 #include "libavutil/opt.h"
  35 #include "libavutil/dict.h"
  36 #include "libavutil/time.h"
  37 #include "avformat.h"
  38 #include "internal.h"
  39 #include "avio_internal.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     /* associated Media Initialization Section, treated as a segment */
  77     struct segment *init_section;
  78 };
  79
  80 struct rendition;
  81
  82 enum PlaylistType {
  83     PLS_TYPE_UNSPECIFIED,
  84     PLS_TYPE_EVENT,
  85     PLS_TYPE_VOD
  86 };
  87
  88 /*
  89  * Each playlist has its own demuxer. If it currently is active,
  90  * it has an open AVIOContext too, and potentially an AVPacket
  91  * containing the next packet from this stream.
  92  */
  93 struct playlist {
  94     char url[MAX_URL_SIZE];
  95     AVIOContext pb;
  96     uint8_t* read_buffer;
  97     AVIOContext *input;
  98     int input_read_done;
  99     AVIOContext *input_next;
 100     int input_next_requested;
 101     AVFormatContext *parent;
 102     int index;
 103     AVFormatContext *ctx;
 104     AVPacket pkt;
 105     int has_noheader_flag;
 106
 107     /* main demuxer streams associated with this playlist
 108      * indexed by the subdemuxer stream indexes */
 109     AVStream **main_streams;
 110     int n_main_streams;
 111
 112     int finished;
 113     enum PlaylistType type;
 114     int64_t target_duration;
 115     int start_seq_no;
 116     int n_segments;
 117     struct segment **segments;
 118     int needed;
 119     int cur_seq_no;
 120     int64_t cur_seg_offset;
 121     int64_t last_load_time;
 122
 123     /* Currently active Media Initialization Section */
 124     struct segment *cur_init_section;
 125     uint8_t *init_sec_buf;
 126     unsigned int init_sec_buf_size;
 127     unsigned int init_sec_data_len;
 128     unsigned int init_sec_buf_read_offset;
 129
 130     char key_url[MAX_URL_SIZE];
 131     uint8_t key[16];
 132
 133     /* ID3 timestamp handling (elementary audio streams have ID3 timestamps
 134      * (and possibly other ID3 tags) in the beginning of each segment) */
 135     int is_id3_timestamped; /* -1: not yet known */
 136     int64_t id3_mpegts_timestamp; /* in mpegts tb */
 137     int64_t id3_offset; /* in stream original tb */
 138     uint8_t* id3_buf; /* temp buffer for id3 parsing */
 139     unsigned int id3_buf_size;
 140     AVDictionary *id3_initial; /* data from first id3 tag */
 141     int id3_found; /* ID3 tag found at some point */
 142     int id3_changed; /* ID3 tag data has changed at some point */
 143     ID3v2ExtraMeta *id3_deferred_extra; /* stored here until subdemuxer is opened */
 144
 145     int64_t seek_timestamp;
 146     int seek_flags;
 147     int seek_stream_index; /* into subdemuxer stream array */
 148
 149     /* Renditions associated with this playlist, if any.
 150      * Alternative rendition playlists have a single rendition associated
 151      * with them, and variant main Media Playlists may have
 152      * multiple (playlist-less) renditions associated with them. */
 153     int n_renditions;
 154     struct rendition **renditions;
 155
 156     /* Media Initialization Sections (EXT-X-MAP) associated with this
 157      * playlist, if any. */
 158     int n_init_sections;
 159     struct segment **init_sections;
 160 };
 161
 162 /*
 163  * Renditions are e.g. alternative subtitle or audio streams.
 164  * The rendition may either be an external playlist or it may be
 165  * contained in the main Media Playlist of the variant (in which case
 166  * playlist is NULL).
 167  */
 168 struct rendition {
 169     enum AVMediaType type;
 170     struct playlist *playlist;
 171     char group_id[MAX_FIELD_LEN];
 172     char language[MAX_FIELD_LEN];
 173     char name[MAX_FIELD_LEN];
 174     int disposition;
 175 };
 176
 177 struct variant {
 178     int bandwidth;
 179
 180     /* every variant contains at least the main Media Playlist in index 0 */
 181     int n_playlists;
 182     struct playlist **playlists;
 183
 184     char audio_group[MAX_FIELD_LEN];
 185     char video_group[MAX_FIELD_LEN];
 186     char subtitles_group[MAX_FIELD_LEN];
 187 };
 188
 189 typedef struct HLSContext {
 190     AVClass *class;
 191     AVFormatContext *ctx;
 192     int n_variants;
 193     struct variant **variants;
 194     int n_playlists;
 195     struct playlist **playlists;
 196     int n_renditions;
 197     struct rendition **renditions;
 198
 199     int cur_seq_no;
 200     int live_start_index;
 201     int first_packet;
 202     int64_t first_timestamp;
 203     int64_t cur_timestamp;
 204     AVIOInterruptCB *interrupt_callback;
 205     char *referer;                       ///< holds HTTP referer set as an AVOption to the HTTP protocol context
 206     char *user_agent;                    ///< holds HTTP user agent set as an AVOption to the HTTP protocol context
 207     char *cookies;                       ///< holds HTTP cookie values set in either the initial response or as an AVOption to the HTTP protocol context
 208     char *headers;                       ///< holds HTTP headers set as an AVOption to the HTTP protocol context
 209     char *http_proxy;                    ///< holds the address of the HTTP proxy server
 210     AVDictionary *avio_opts;
 211     int strict_std_compliance;
 212     char *allowed_extensions;
 213     int max_reload;
 214     int http_persistent;
 215     int http_multiple;
 216     AVIOContext *playlist_pb;
 217 } HLSContext;
 218
 219 static int read_chomp_line(AVIOContext *s, char *buf, int maxlen)
 220 {
 221     int len = ff_get_line(s, buf, maxlen);
 222     while (len > 0 && av_isspace(buf[len - 1]))
 223         buf[--len] = '\0';
 224     return len;
 225 }
 226
 227 static void free_segment_list(struct playlist *pls)
 228 {
 229     int i;
 230     for (i = 0; i < pls->n_segments; i++) {
 231         av_freep(&pls->segments[i]->key);
 232         av_freep(&pls->segments[i]->url);
 233         av_freep(&pls->segments[i]);
 234     }
 235     av_freep(&pls->segments);
 236     pls->n_segments = 0;
 237 }
 238
 239 static void free_init_section_list(struct playlist *pls)
 240 {
 241     int i;
 242     for (i = 0; i < pls->n_init_sections; i++) {
 243         av_freep(&pls->init_sections[i]->url);
 244         av_freep(&pls->init_sections[i]);
 245     }
 246     av_freep(&pls->init_sections);
 247     pls->n_init_sections = 0;
 248 }
 249
 250 static void free_playlist_list(HLSContext *c)
 251 {
 252     int i;
 253     for (i = 0; i < c->n_playlists; i++) {
 254         struct playlist *pls = c->playlists[i];
 255         free_segment_list(pls);
 256         free_init_section_list(pls);
 257         av_freep(&pls->main_streams);
 258         av_freep(&pls->renditions);
 259         av_freep(&pls->id3_buf);
 260         av_dict_free(&pls->id3_initial);
 261         ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
 262         av_freep(&pls->init_sec_buf);
 263         av_packet_unref(&pls->pkt);
 264         av_freep(&pls->pb.buffer);
 265         if (pls->input)
 266             ff_format_io_close(c->ctx, &pls->input);
 267         pls->input_read_done = 0;
 268         if (pls->input_next)
 269             ff_format_io_close(c->ctx, &pls->input_next);
 270         pls->input_next_requested = 0;
 271         if (pls->ctx) {
 272             pls->ctx->pb = NULL;
 273             avformat_close_input(&pls->ctx);
 274         }
 275         av_free(pls);
 276     }
 277     av_freep(&c->playlists);
 278     av_freep(&c->cookies);
 279     av_freep(&c->user_agent);
 280     av_freep(&c->headers);
 281     av_freep(&c->http_proxy);
 282     c->n_playlists = 0;
 283 }
 284
 285 static void free_variant_list(HLSContext *c)
 286 {
 287     int i;
 288     for (i = 0; i < c->n_variants; i++) {
 289         struct variant *var = c->variants[i];
 290         av_freep(&var->playlists);
 291         av_free(var);
 292     }
 293     av_freep(&c->variants);
 294     c->n_variants = 0;
 295 }
 296
 297 static void free_rendition_list(HLSContext *c)
 298 {
 299     int i;
 300     for (i = 0; i < c->n_renditions; i++)
 301         av_freep(&c->renditions[i]);
 302     av_freep(&c->renditions);
 303     c->n_renditions = 0;
 304 }
 305
 306 /*
 307  * Used to reset a statically allocated AVPacket to a clean slate,
 308  * containing no data.
 309  */
 310 static void reset_packet(AVPacket *pkt)
 311 {
 312     av_init_packet(pkt);
 313     pkt->data = NULL;
 314 }
 315
 316 static struct playlist *new_playlist(HLSContext *c, const char *url,
 317                                      const char *base)
 318 {
 319     struct playlist *pls = av_mallocz(sizeof(struct playlist));
 320     if (!pls)
 321         return NULL;
 322     reset_packet(&pls->pkt);
 323     ff_make_absolute_url(pls->url, sizeof(pls->url), base, url);
 324     pls->seek_timestamp = AV_NOPTS_VALUE;
 325
 326     pls->is_id3_timestamped = -1;
 327     pls->id3_mpegts_timestamp = AV_NOPTS_VALUE;
 328
 329     dynarray_add(&c->playlists, &c->n_playlists, pls);
 330     return pls;
 331 }
 332
 333 struct variant_info {
 334     char bandwidth[20];
 335     /* variant group ids: */
 336     char audio[MAX_FIELD_LEN];
 337     char video[MAX_FIELD_LEN];
 338     char subtitles[MAX_FIELD_LEN];
 339 };
 340
 341 static struct variant *new_variant(HLSContext *c, struct variant_info *info,
 342                                    const char *url, const char *base)
 343 {
 344     struct variant *var;
 345     struct playlist *pls;
 346
 347     pls = new_playlist(c, url, base);
 348     if (!pls)
 349         return NULL;
 350
 351     var = av_mallocz(sizeof(struct variant));
 352     if (!var)
 353         return NULL;
 354
 355     if (info) {
 356         var->bandwidth = atoi(info->bandwidth);
 357         strcpy(var->audio_group, info->audio);
 358         strcpy(var->video_group, info->video);
 359         strcpy(var->subtitles_group, info->subtitles);
 360     }
 361
 362     dynarray_add(&c->variants, &c->n_variants, var);
 363     dynarray_add(&var->playlists, &var->n_playlists, pls);
 364     return var;
 365 }
 366
 367 static void handle_variant_args(struct variant_info *info, const char *key,
 368                                 int key_len, char **dest, int *dest_len)
 369 {
 370     if (!strncmp(key, "BANDWIDTH=", key_len)) {
 371         *dest     =        info->bandwidth;
 372         *dest_len = sizeof(info->bandwidth);
 373     } else if (!strncmp(key, "AUDIO=", key_len)) {
 374         *dest     =        info->audio;
 375         *dest_len = sizeof(info->audio);
 376     } else if (!strncmp(key, "VIDEO=", key_len)) {
 377         *dest     =        info->video;
 378         *dest_len = sizeof(info->video);
 379     } else if (!strncmp(key, "SUBTITLES=", key_len)) {
 380         *dest     =        info->subtitles;
 381         *dest_len = sizeof(info->subtitles);
 382     }
 383 }
 384
 385 struct key_info {
 386      char uri[MAX_URL_SIZE];
 387      char method[11];
 388      char iv[35];
 389 };
 390
 391 static void handle_key_args(struct key_info *info, const char *key,
 392                             int key_len, char **dest, int *dest_len)
 393 {
 394     if (!strncmp(key, "METHOD=", key_len)) {
 395         *dest     =        info->method;
 396         *dest_len = sizeof(info->method);
 397     } else if (!strncmp(key, "URI=", key_len)) {
 398         *dest     =        info->uri;
 399         *dest_len = sizeof(info->uri);
 400     } else if (!strncmp(key, "IV=", key_len)) {
 401         *dest     =        info->iv;
 402         *dest_len = sizeof(info->iv);
 403     }
 404 }
 405
 406 struct init_section_info {
 407     char uri[MAX_URL_SIZE];
 408     char byterange[32];
 409 };
 410
 411 static struct segment *new_init_section(struct playlist *pls,
 412                                         struct init_section_info *info,
 413                                         const char *url_base)
 414 {
 415     struct segment *sec;
 416     char *ptr;
 417     char tmp_str[MAX_URL_SIZE];
 418
 419     if (!info->uri[0])
 420         return NULL;
 421
 422     sec = av_mallocz(sizeof(*sec));
 423     if (!sec)
 424         return NULL;
 425
 426     ff_make_absolute_url(tmp_str, sizeof(tmp_str), url_base, info->uri);
 427     sec->url = av_strdup(tmp_str);
 428     if (!sec->url) {
 429         av_free(sec);
 430         return NULL;
 431     }
 432
 433     if (info->byterange[0]) {
 434         sec->size = strtoll(info->byterange, NULL, 10);
 435         ptr = strchr(info->byterange, '@');
 436         if (ptr)
 437             sec->url_offset = strtoll(ptr+1, NULL, 10);
 438     } else {
 439         /* the entire file is the init section */
 440         sec->size = -1;
 441     }
 442
 443     dynarray_add(&pls->init_sections, &pls->n_init_sections, sec);
 444
 445     return sec;
 446 }
 447
 448 static void handle_init_section_args(struct init_section_info *info, const char *key,
 449                                            int key_len, char **dest, int *dest_len)
 450 {
 451     if (!strncmp(key, "URI=", key_len)) {
 452         *dest     =        info->uri;
 453         *dest_len = sizeof(info->uri);
 454     } else if (!strncmp(key, "BYTERANGE=", key_len)) {
 455         *dest     =        info->byterange;
 456         *dest_len = sizeof(info->byterange);
 457     }
 458 }
 459
 460 struct rendition_info {
 461     char type[16];
 462     char uri[MAX_URL_SIZE];
 463     char group_id[MAX_FIELD_LEN];
 464     char language[MAX_FIELD_LEN];
 465     char assoc_language[MAX_FIELD_LEN];
 466     char name[MAX_FIELD_LEN];
 467     char defaultr[4];
 468     char forced[4];
 469     char characteristics[MAX_CHARACTERISTICS_LEN];
 470 };
 471
 472 static struct rendition *new_rendition(HLSContext *c, struct rendition_info *info,
 473                                       const char *url_base)
 474 {
 475     struct rendition *rend;
 476     enum AVMediaType type = AVMEDIA_TYPE_UNKNOWN;
 477     char *characteristic;
 478     char *chr_ptr;
 479     char *saveptr;
 480
 481     if (!strcmp(info->type, "AUDIO"))
 482         type = AVMEDIA_TYPE_AUDIO;
 483     else if (!strcmp(info->type, "VIDEO"))
 484         type = AVMEDIA_TYPE_VIDEO;
 485     else if (!strcmp(info->type, "SUBTITLES"))
 486         type = AVMEDIA_TYPE_SUBTITLE;
 487     else if (!strcmp(info->type, "CLOSED-CAPTIONS"))
 488         /* CLOSED-CAPTIONS is ignored since we do not support CEA-608 CC in
 489          * AVC SEI RBSP anyway */
 490         return NULL;
 491
 492     if (type == AVMEDIA_TYPE_UNKNOWN)
 493         return NULL;
 494
 495     /* URI is mandatory for subtitles as per spec */
 496     if (type == AVMEDIA_TYPE_SUBTITLE && !info->uri[0])
 497         return NULL;
 498
 499     /* TODO: handle subtitles (each segment has to parsed separately) */
 500     if (c->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL)
 501         if (type == AVMEDIA_TYPE_SUBTITLE)
 502             return NULL;
 503
 504     rend = av_mallocz(sizeof(struct rendition));
 505     if (!rend)
 506         return NULL;
 507
 508     dynarray_add(&c->renditions, &c->n_renditions, rend);
 509
 510     rend->type = type;
 511     strcpy(rend->group_id, info->group_id);
 512     strcpy(rend->language, info->language);
 513     strcpy(rend->name, info->name);
 514
 515     /* add the playlist if this is an external rendition */
 516     if (info->uri[0]) {
 517         rend->playlist = new_playlist(c, info->uri, url_base);
 518         if (rend->playlist)
 519             dynarray_add(&rend->playlist->renditions,
 520                          &rend->playlist->n_renditions, rend);
 521     }
 522
 523     if (info->assoc_language[0]) {
 524         int langlen = strlen(rend->language);
 525         if (langlen < sizeof(rend->language) - 3) {
 526             rend->language[langlen] = ',';
 527             strncpy(rend->language + langlen + 1, info->assoc_language,
 528                     sizeof(rend->language) - langlen - 2);
 529         }
 530     }
 531
 532     if (!strcmp(info->defaultr, "YES"))
 533         rend->disposition |= AV_DISPOSITION_DEFAULT;
 534     if (!strcmp(info->forced, "YES"))
 535         rend->disposition |= AV_DISPOSITION_FORCED;
 536
 537     chr_ptr = info->characteristics;
 538     while ((characteristic = av_strtok(chr_ptr, ",", &saveptr))) {
 539         if (!strcmp(characteristic, "public.accessibility.describes-music-and-sound"))
 540             rend->disposition |= AV_DISPOSITION_HEARING_IMPAIRED;
 541         else if (!strcmp(characteristic, "public.accessibility.describes-video"))
 542             rend->disposition |= AV_DISPOSITION_VISUAL_IMPAIRED;
 543
 544         chr_ptr = NULL;
 545     }
 546
 547     return rend;
 548 }
 549
 550 static void handle_rendition_args(struct rendition_info *info, const char *key,
 551                                   int key_len, char **dest, int *dest_len)
 552 {
 553     if (!strncmp(key, "TYPE=", key_len)) {
 554         *dest     =        info->type;
 555         *dest_len = sizeof(info->type);
 556     } else if (!strncmp(key, "URI=", key_len)) {
 557         *dest     =        info->uri;
 558         *dest_len = sizeof(info->uri);
 559     } else if (!strncmp(key, "GROUP-ID=", key_len)) {
 560         *dest     =        info->group_id;
 561         *dest_len = sizeof(info->group_id);
 562     } else if (!strncmp(key, "LANGUAGE=", key_len)) {
 563         *dest     =        info->language;
 564         *dest_len = sizeof(info->language);
 565     } else if (!strncmp(key, "ASSOC-LANGUAGE=", key_len)) {
 566         *dest     =        info->assoc_language;
 567         *dest_len = sizeof(info->assoc_language);
 568     } else if (!strncmp(key, "NAME=", key_len)) {
 569         *dest     =        info->name;
 570         *dest_len = sizeof(info->name);
 571     } else if (!strncmp(key, "DEFAULT=", key_len)) {
 572         *dest     =        info->defaultr;
 573         *dest_len = sizeof(info->defaultr);
 574     } else if (!strncmp(key, "FORCED=", key_len)) {
 575         *dest     =        info->forced;
 576         *dest_len = sizeof(info->forced);
 577     } else if (!strncmp(key, "CHARACTERISTICS=", key_len)) {
 578         *dest     =        info->characteristics;
 579         *dest_len = sizeof(info->characteristics);
 580     }
 581     /*
 582      * ignored:
 583      * - AUTOSELECT: client may autoselect based on e.g. system language
 584      * - INSTREAM-ID: EIA-608 closed caption number ("CC1".."CC4")
 585      */
 586 }
 587
 588 /* used by parse_playlist to allocate a new variant+playlist when the
 589  * playlist is detected to be a Media Playlist (not Master Playlist)
 590  * and we have no parent Master Playlist (parsing of which would have
 591  * allocated the variant and playlist already)
 592  * *pls == NULL  => Master Playlist or parentless Media Playlist
 593  * *pls != NULL => parented Media Playlist, playlist+variant allocated */
 594 static int ensure_playlist(HLSContext *c, struct playlist **pls, const char *url)
 595 {
 596     if (*pls)
 597         return 0;
 598     if (!new_variant(c, NULL, url, NULL))
 599         return AVERROR(ENOMEM);
 600     *pls = c->playlists[c->n_playlists - 1];
 601     return 0;
 602 }
 603
 604 static void update_options(char **dest, const char *name, void *src)
 605 {
 606     av_freep(dest);
 607     av_opt_get(src, name, AV_OPT_SEARCH_CHILDREN, (uint8_t**)dest);
 608     if (*dest && !strlen(*dest))
 609         av_freep(dest);
 610 }
 611
 612 static int open_url_keepalive(AVFormatContext *s, AVIOContext **pb,
 613                               const char *url)
 614 {
 615 #if !CONFIG_HTTP_PROTOCOL
 616     return AVERROR_PROTOCOL_NOT_FOUND;
 617 #else
 618     int ret;
 619     URLContext *uc = ffio_geturlcontext(*pb);
 620     av_assert0(uc);
 621     (*pb)->eof_reached = 0;
 622     ret = ff_http_do_new_request(uc, url);
 623     if (ret < 0) {
 624         ff_format_io_close(s, pb);
 625     }
 626     return ret;
 627 #endif
 628 }
 629
 630 static int open_url(AVFormatContext *s, AVIOContext **pb, const char *url,
 631                     AVDictionary *opts, AVDictionary *opts2, int *is_http_out)
 632 {
 633     HLSContext *c = s->priv_data;
 634     AVDictionary *tmp = NULL;
 635     const char *proto_name = NULL;
 636     int ret;
 637     int is_http = 0;
 638
 639     av_dict_copy(&tmp, opts, 0);
 640     av_dict_copy(&tmp, opts2, 0);
 641
 642     if (av_strstart(url, "crypto", NULL)) {
 643         if (url[6] == '+' || url[6] == ':')
 644             proto_name = avio_find_protocol_name(url + 7);
 645     }
 646
 647     if (!proto_name)
 648         proto_name = avio_find_protocol_name(url);
 649
 650     if (!proto_name)
 651         return AVERROR_INVALIDDATA;
 652
 653     // only http(s) & file are allowed
 654     if (av_strstart(proto_name, "file", NULL)) {
 655         if (strcmp(c->allowed_extensions, "ALL") && !av_match_ext(url, c->allowed_extensions)) {
 656             av_log(s, AV_LOG_ERROR,
 657                 "Filename extension of \'%s\' is not a common multimedia extension, blocked for security reasons.\n"
 658                 "If you wish to override this adjust allowed_extensions, you can set it to \'ALL\' to allow all\n",
 659                 url);
 660             return AVERROR_INVALIDDATA;
 661         }
 662     } else if (av_strstart(proto_name, "http", NULL)) {
 663         is_http = 1;
 664     } else
 665         return AVERROR_INVALIDDATA;
 666
 667     if (!strncmp(proto_name, url, strlen(proto_name)) && url[strlen(proto_name)] == ':')
 668         ;
 669     else if (av_strstart(url, "crypto", NULL) && !strncmp(proto_name, url + 7, strlen(proto_name)) && url[7 + strlen(proto_name)] == ':')
 670         ;
 671     else if (strcmp(proto_name, "file") || !strncmp(url, "file,", 5))
 672         return AVERROR_INVALIDDATA;
 673
 674     if (is_http && c->http_persistent && *pb) {
 675         ret = open_url_keepalive(c->ctx, pb, url);
 676         if (ret == AVERROR_EXIT) {
 677             return ret;
 678         } else if (ret < 0) {
 679             if (ret != AVERROR_EOF)
 680                 av_log(s, AV_LOG_WARNING,
 681                     "keepalive request failed for '%s', retrying with new connection: %s\n",
 682                     url, av_err2str(ret));
 683             ret = s->io_open(s, pb, url, AVIO_FLAG_READ, &tmp);
 684         }
 685     } else {
 686         ret = s->io_open(s, pb, url, AVIO_FLAG_READ, &tmp);
 687     }
 688     if (ret >= 0) {
 689         // update cookies on http response with setcookies.
 690         char *new_cookies = NULL;
 691
 692         if (!(s->flags & AVFMT_FLAG_CUSTOM_IO))
 693             av_opt_get(*pb, "cookies", AV_OPT_SEARCH_CHILDREN, (uint8_t**)&new_cookies);
 694
 695         if (new_cookies) {
 696             av_free(c->cookies);
 697             c->cookies = new_cookies;
 698         }
 699
 700         av_dict_set(&opts, "cookies", c->cookies, 0);
 701     }
 702
 703     av_dict_free(&tmp);
 704
 705     if (is_http_out)
 706         *is_http_out = is_http;
 707
 708     return ret;
 709 }
 710
 711 static int parse_playlist(HLSContext *c, const char *url,
 712                           struct playlist *pls, AVIOContext *in)
 713 {
 714     int ret = 0, is_segment = 0, is_variant = 0;
 715     int64_t duration = 0;
 716     enum KeyType key_type = KEY_NONE;
 717     uint8_t iv[16] = "";
 718     int has_iv = 0;
 719     char key[MAX_URL_SIZE] = "";
 720     char line[MAX_URL_SIZE];
 721     const char *ptr;
 722     int close_in = 0;
 723     int64_t seg_offset = 0;
 724     int64_t seg_size = -1;
 725     uint8_t *new_url = NULL;
 726     struct variant_info variant_info;
 727     char tmp_str[MAX_URL_SIZE];
 728     struct segment *cur_init_section = NULL;
 729     int is_http = av_strstart(url, "http", NULL);
 730
 731     if (is_http && !in && c->http_persistent && c->playlist_pb) {
 732         in = c->playlist_pb;
 733         ret = open_url_keepalive(c->ctx, &c->playlist_pb, url);
 734         if (ret == AVERROR_EXIT) {
 735             return ret;
 736         } else if (ret < 0) {
 737             if (ret != AVERROR_EOF)
 738                 av_log(c->ctx, AV_LOG_WARNING,
 739                     "keepalive request failed for '%s', retrying with new connection: %s\n",
 740                     url, av_err2str(ret));
 741             in = NULL;
 742         }
 743     }
 744
 745     if (!in) {
 746         AVDictionary *opts = NULL;
 747         /* Some HLS servers don't like being sent the range header */
 748         av_dict_set(&opts, "seekable", "0", 0);
 749
 750         // broker prior HTTP options that should be consistent across requests
 751         av_dict_set(&opts, "user_agent", c->user_agent, 0);
 752         av_dict_set(&opts, "cookies", c->cookies, 0);
 753         av_dict_set(&opts, "headers", c->headers, 0);
 754         av_dict_set(&opts, "http_proxy", c->http_proxy, 0);
 755
 756         if (c->http_persistent)
 757             av_dict_set(&opts, "multiple_requests", "1", 0);
 758
 759         ret = c->ctx->io_open(c->ctx, &in, url, AVIO_FLAG_READ, &opts);
 760         av_dict_free(&opts);
 761         if (ret < 0)
 762             return ret;
 763
 764         if (is_http && c->http_persistent)
 765             c->playlist_pb = in;
 766         else
 767             close_in = 1;
 768     }
 769
 770     if (av_opt_get(in, "location", AV_OPT_SEARCH_CHILDREN, &new_url) >= 0)
 771         url = new_url;
 772
 773     read_chomp_line(in, line, sizeof(line));
 774     if (strcmp(line, "#EXTM3U")) {
 775         ret = AVERROR_INVALIDDATA;
 776         goto fail;
 777     }
 778
 779     if (pls) {
 780         free_segment_list(pls);
 781         pls->finished = 0;
 782         pls->type = PLS_TYPE_UNSPECIFIED;
 783     }
 784     while (!avio_feof(in)) {
 785         read_chomp_line(in, line, sizeof(line));
 786         if (av_strstart(line, "#EXT-X-STREAM-INF:", &ptr)) {
 787             is_variant = 1;
 788             memset(&variant_info, 0, sizeof(variant_info));
 789             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_variant_args,
 790                                &variant_info);
 791         } else if (av_strstart(line, "#EXT-X-KEY:", &ptr)) {
 792             struct key_info info = {{0}};
 793             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_key_args,
 794                                &info);
 795             key_type = KEY_NONE;
 796             has_iv = 0;
 797             if (!strcmp(info.method, "AES-128"))
 798                 key_type = KEY_AES_128;
 799             if (!strcmp(info.method, "SAMPLE-AES"))
 800                 key_type = KEY_SAMPLE_AES;
 801             if (!strncmp(info.iv, "0x", 2) || !strncmp(info.iv, "0X", 2)) {
 802                 ff_hex_to_data(iv, info.iv + 2);
 803                 has_iv = 1;
 804             }
 805             av_strlcpy(key, info.uri, sizeof(key));
 806         } else if (av_strstart(line, "#EXT-X-MEDIA:", &ptr)) {
 807             struct rendition_info info = {{0}};
 808             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_rendition_args,
 809                                &info);
 810             new_rendition(c, &info, url);
 811         } else if (av_strstart(line, "#EXT-X-TARGETDURATION:", &ptr)) {
 812             ret = ensure_playlist(c, &pls, url);
 813             if (ret < 0)
 814                 goto fail;
 815             pls->target_duration = strtoll(ptr, NULL, 10) * AV_TIME_BASE;
 816         } else if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
 817             ret = ensure_playlist(c, &pls, url);
 818             if (ret < 0)
 819                 goto fail;
 820             pls->start_seq_no = atoi(ptr);
 821         } else if (av_strstart(line, "#EXT-X-PLAYLIST-TYPE:", &ptr)) {
 822             ret = ensure_playlist(c, &pls, url);
 823             if (ret < 0)
 824                 goto fail;
 825             if (!strcmp(ptr, "EVENT"))
 826                 pls->type = PLS_TYPE_EVENT;
 827             else if (!strcmp(ptr, "VOD"))
 828                 pls->type = PLS_TYPE_VOD;
 829         } else if (av_strstart(line, "#EXT-X-MAP:", &ptr)) {
 830             struct init_section_info info = {{0}};
 831             ret = ensure_playlist(c, &pls, url);
 832             if (ret < 0)
 833                 goto fail;
 834             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_init_section_args,
 835                                &info);
 836             cur_init_section = new_init_section(pls, &info, url);
 837         } else if (av_strstart(line, "#EXT-X-ENDLIST", &ptr)) {
 838             if (pls)
 839                 pls->finished = 1;
 840         } else if (av_strstart(line, "#EXTINF:", &ptr)) {
 841             is_segment = 1;
 842             duration   = atof(ptr) * AV_TIME_BASE;
 843         } else if (av_strstart(line, "#EXT-X-BYTERANGE:", &ptr)) {
 844             seg_size = strtoll(ptr, NULL, 10);
 845             ptr = strchr(ptr, '@');
 846             if (ptr)
 847                 seg_offset = strtoll(ptr+1, NULL, 10);
 848         } else if (av_strstart(line, "#", NULL)) {
 849             continue;
 850         } else if (line[0]) {
 851             if (is_variant) {
 852                 if (!new_variant(c, &variant_info, line, url)) {
 853                     ret = AVERROR(ENOMEM);
 854                     goto fail;
 855                 }
 856                 is_variant = 0;
 857             }
 858             if (is_segment) {
 859                 struct segment *seg;
 860                 if (!pls) {
 861                     if (!new_variant(c, 0, url, NULL)) {
 862                         ret = AVERROR(ENOMEM);
 863                         goto fail;
 864                     }
 865                     pls = c->playlists[c->n_playlists - 1];
 866                 }
 867                 seg = av_malloc(sizeof(struct segment));
 868                 if (!seg) {
 869                     ret = AVERROR(ENOMEM);
 870                     goto fail;
 871                 }
 872                 seg->duration = duration;
 873                 seg->key_type = key_type;
 874                 if (has_iv) {
 875                     memcpy(seg->iv, iv, sizeof(iv));
 876                 } else {
 877                     int seq = pls->start_seq_no + pls->n_segments;
 878                     memset(seg->iv, 0, sizeof(seg->iv));
 879                     AV_WB32(seg->iv + 12, seq);
 880                 }
 881
 882                 if (key_type != KEY_NONE) {
 883                     ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, key);
 884                     seg->key = av_strdup(tmp_str);
 885                     if (!seg->key) {
 886                         av_free(seg);
 887                         ret = AVERROR(ENOMEM);
 888                         goto fail;
 889                     }
 890                 } else {
 891                     seg->key = NULL;
 892                 }
 893
 894                 ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, line);
 895                 seg->url = av_strdup(tmp_str);
 896                 if (!seg->url) {
 897                     av_free(seg->key);
 898                     av_free(seg);
 899                     ret = AVERROR(ENOMEM);
 900                     goto fail;
 901                 }
 902
 903                 dynarray_add(&pls->segments, &pls->n_segments, seg);
 904                 is_segment = 0;
 905
 906                 seg->size = seg_size;
 907                 if (seg_size >= 0) {
 908                     seg->url_offset = seg_offset;
 909                     seg_offset += seg_size;
 910                     seg_size = -1;
 911                 } else {
 912                     seg->url_offset = 0;
 913                     seg_offset = 0;
 914                 }
 915
 916                 seg->init_section = cur_init_section;
 917             }
 918         }
 919     }
 920     if (pls)
 921         pls->last_load_time = av_gettime_relative();
 922
 923 fail:
 924     av_free(new_url);
 925     if (close_in)
 926         ff_format_io_close(c->ctx, &in);
 927     c->ctx->ctx_flags = c->ctx->ctx_flags & ~(unsigned)AVFMTCTX_UNSEEKABLE;
 928     if (!c->n_variants || !c->variants[0]->n_playlists ||
 929         !(c->variants[0]->playlists[0]->finished ||
 930           c->variants[0]->playlists[0]->type == PLS_TYPE_EVENT))
 931         c->ctx->ctx_flags |= AVFMTCTX_UNSEEKABLE;
 932     return ret;
 933 }
 934
 935 static struct segment *current_segment(struct playlist *pls)
 936 {
 937     return pls->segments[pls->cur_seq_no - pls->start_seq_no];
 938 }
 939
 940 static struct segment *next_segment(struct playlist *pls)
 941 {
 942     int n = pls->cur_seq_no - pls->start_seq_no + 1;
 943     if (n >= pls->n_segments)
 944         return NULL;
 945     return pls->segments[n];
 946 }
 947
 948 enum ReadFromURLMode {
 949     READ_NORMAL,
 950     READ_COMPLETE,
 951 };
 952
 953 static int read_from_url(struct playlist *pls, struct segment *seg,
 954                          uint8_t *buf, int buf_size,
 955                          enum ReadFromURLMode mode)
 956 {
 957     int ret;
 958
 959      /* limit read if the segment was only a part of a file */
 960     if (seg->size >= 0)
 961         buf_size = FFMIN(buf_size, seg->size - pls->cur_seg_offset);
 962
 963     if (mode == READ_COMPLETE) {
 964         ret = avio_read(pls->input, buf, buf_size);
 965         if (ret != buf_size)
 966             av_log(NULL, AV_LOG_ERROR, "Could not read complete segment.\n");
 967     } else
 968         ret = avio_read(pls->input, buf, buf_size);
 969
 970     if (ret > 0)
 971         pls->cur_seg_offset += ret;
 972
 973     return ret;
 974 }
 975
 976 /* Parse the raw ID3 data and pass contents to caller */
 977 static void parse_id3(AVFormatContext *s, AVIOContext *pb,
 978                       AVDictionary **metadata, int64_t *dts,
 979                       ID3v2ExtraMetaAPIC **apic, ID3v2ExtraMeta **extra_meta)
 980 {
 981     static const char id3_priv_owner_ts[] = "com.apple.streaming.transportStreamTimestamp";
 982     ID3v2ExtraMeta *meta;
 983
 984     ff_id3v2_read_dict(pb, metadata, ID3v2_DEFAULT_MAGIC, extra_meta);
 985     for (meta = *extra_meta; meta; meta = meta->next) {
 986         if (!strcmp(meta->tag, "PRIV")) {
 987             ID3v2ExtraMetaPRIV *priv = meta->data;
 988             if (priv->datasize == 8 && !strcmp(priv->owner, id3_priv_owner_ts)) {
 989                 /* 33-bit MPEG timestamp */
 990                 int64_t ts = AV_RB64(priv->data);
 991                 av_log(s, AV_LOG_DEBUG, "HLS ID3 audio timestamp %"PRId64"\n", ts);
 992                 if ((ts & ~((1ULL << 33) - 1)) == 0)
 993                     *dts = ts;
 994                 else
 995                     av_log(s, AV_LOG_ERROR, "Invalid HLS ID3 audio timestamp %"PRId64"\n", ts);
 996             }
 997         } else if (!strcmp(meta->tag, "APIC") && apic)
 998             *apic = meta->data;
 999     }
1000 }
1001
1002 /* Check if the ID3 metadata contents have changed */
1003 static int id3_has_changed_values(struct playlist *pls, AVDictionary *metadata,
1004                                   ID3v2ExtraMetaAPIC *apic)
1005 {
1006     AVDictionaryEntry *entry = NULL;
1007     AVDictionaryEntry *oldentry;
1008     /* check that no keys have changed values */
1009     while ((entry = av_dict_get(metadata, "", entry, AV_DICT_IGNORE_SUFFIX))) {
1010         oldentry = av_dict_get(pls->id3_initial, entry->key, NULL, AV_DICT_MATCH_CASE);
1011         if (!oldentry || strcmp(oldentry->value, entry->value) != 0)
1012             return 1;
1013     }
1014
1015     /* check if apic appeared */
1016     if (apic && (pls->ctx->nb_streams != 2 || !pls->ctx->streams[1]->attached_pic.data))
1017         return 1;
1018
1019     if (apic) {
1020         int size = pls->ctx->streams[1]->attached_pic.size;
1021         if (size != apic->buf->size - AV_INPUT_BUFFER_PADDING_SIZE)
1022             return 1;
1023
1024         if (memcmp(apic->buf->data, pls->ctx->streams[1]->attached_pic.data, size) != 0)
1025             return 1;
1026     }
1027
1028     return 0;
1029 }
1030
1031 /* Parse ID3 data and handle the found data */
1032 static void handle_id3(AVIOContext *pb, struct playlist *pls)
1033 {
1034     AVDictionary *metadata = NULL;
1035     ID3v2ExtraMetaAPIC *apic = NULL;
1036     ID3v2ExtraMeta *extra_meta = NULL;
1037     int64_t timestamp = AV_NOPTS_VALUE;
1038
1039     parse_id3(pls->ctx, pb, &metadata, &timestamp, &apic, &extra_meta);
1040
1041     if (timestamp != AV_NOPTS_VALUE) {
1042         pls->id3_mpegts_timestamp = timestamp;
1043         pls->id3_offset = 0;
1044     }
1045
1046     if (!pls->id3_found) {
1047         /* initial ID3 tags */
1048         av_assert0(!pls->id3_deferred_extra);
1049         pls->id3_found = 1;
1050
1051         /* get picture attachment and set text metadata */
1052         if (pls->ctx->nb_streams)
1053             ff_id3v2_parse_apic(pls->ctx, &extra_meta);
1054         else
1055             /* demuxer not yet opened, defer picture attachment */
1056             pls->id3_deferred_extra = extra_meta;
1057
1058         ff_id3v2_parse_priv_dict(&metadata, &extra_meta);
1059         av_dict_copy(&pls->ctx->metadata, metadata, 0);
1060         pls->id3_initial = metadata;
1061
1062     } else {
1063         if (!pls->id3_changed && id3_has_changed_values(pls, metadata, apic)) {
1064             avpriv_report_missing_feature(pls->ctx, "Changing ID3 metadata in HLS audio elementary stream");
1065             pls->id3_changed = 1;
1066         }
1067         av_dict_free(&metadata);
1068     }
1069
1070     if (!pls->id3_deferred_extra)
1071         ff_id3v2_free_extra_meta(&extra_meta);
1072 }
1073
1074 static void intercept_id3(struct playlist *pls, uint8_t *buf,
1075                          int buf_size, int *len)
1076 {
1077     /* intercept id3 tags, we do not want to pass them to the raw
1078      * demuxer on all segment switches */
1079     int bytes;
1080     int id3_buf_pos = 0;
1081     int fill_buf = 0;
1082     struct segment *seg = current_segment(pls);
1083
1084     /* gather all the id3 tags */
1085     while (1) {
1086         /* see if we can retrieve enough data for ID3 header */
1087         if (*len < ID3v2_HEADER_SIZE && buf_size >= ID3v2_HEADER_SIZE) {
1088             bytes = read_from_url(pls, seg, buf + *len, ID3v2_HEADER_SIZE - *len, READ_COMPLETE);
1089             if (bytes > 0) {
1090
1091                 if (bytes == ID3v2_HEADER_SIZE - *len)
1092                     /* no EOF yet, so fill the caller buffer again after
1093                      * we have stripped the ID3 tags */
1094                     fill_buf = 1;
1095
1096                 *len += bytes;
1097
1098             } else if (*len <= 0) {
1099                 /* error/EOF */
1100                 *len = bytes;
1101                 fill_buf = 0;
1102             }
1103         }
1104
1105         if (*len < ID3v2_HEADER_SIZE)
1106             break;
1107
1108         if (ff_id3v2_match(buf, ID3v2_DEFAULT_MAGIC)) {
1109             int64_t maxsize = seg->size >= 0 ? seg->size : 1024*1024;
1110             int taglen = ff_id3v2_tag_len(buf);
1111             int tag_got_bytes = FFMIN(taglen, *len);
1112             int remaining = taglen - tag_got_bytes;
1113
1114             if (taglen > maxsize) {
1115                 av_log(pls->ctx, AV_LOG_ERROR, "Too large HLS ID3 tag (%d > %"PRId64" bytes)\n",
1116                        taglen, maxsize);
1117                 break;
1118             }
1119
1120             /*
1121              * Copy the id3 tag to our temporary id3 buffer.
1122              * We could read a small id3 tag directly without memcpy, but
1123              * we would still need to copy the large tags, and handling
1124              * both of those cases together with the possibility for multiple
1125              * tags would make the handling a bit complex.
1126              */
1127             pls->id3_buf = av_fast_realloc(pls->id3_buf, &pls->id3_buf_size, id3_buf_pos + taglen);
1128             if (!pls->id3_buf)
1129                 break;
1130             memcpy(pls->id3_buf + id3_buf_pos, buf, tag_got_bytes);
1131             id3_buf_pos += tag_got_bytes;
1132
1133             /* strip the intercepted bytes */
1134             *len -= tag_got_bytes;
1135             memmove(buf, buf + tag_got_bytes, *len);
1136             av_log(pls->ctx, AV_LOG_DEBUG, "Stripped %d HLS ID3 bytes\n", tag_got_bytes);
1137
1138             if (remaining > 0) {
1139                 /* read the rest of the tag in */
1140                 if (read_from_url(pls, seg, pls->id3_buf + id3_buf_pos, remaining, READ_COMPLETE) != remaining)
1141                     break;
1142                 id3_buf_pos += remaining;
1143                 av_log(pls->ctx, AV_LOG_DEBUG, "Stripped additional %d HLS ID3 bytes\n", remaining);
1144             }
1145
1146         } else {
1147             /* no more ID3 tags */
1148             break;
1149         }
1150     }
1151
1152     /* re-fill buffer for the caller unless EOF */
1153     if (*len >= 0 && (fill_buf || *len == 0)) {
1154         bytes = read_from_url(pls, seg, buf + *len, buf_size - *len, READ_NORMAL);
1155
1156         /* ignore error if we already had some data */
1157         if (bytes >= 0)
1158             *len += bytes;
1159         else if (*len == 0)
1160             *len = bytes;
1161     }
1162
1163     if (pls->id3_buf) {
1164         /* Now parse all the ID3 tags */
1165         AVIOContext id3ioctx;
1166         ffio_init_context(&id3ioctx, pls->id3_buf, id3_buf_pos, 0, NULL, NULL, NULL, NULL);
1167         handle_id3(&id3ioctx, pls);
1168     }
1169
1170     if (pls->is_id3_timestamped == -1)
1171         pls->is_id3_timestamped = (pls->id3_mpegts_timestamp != AV_NOPTS_VALUE);
1172 }
1173
1174 static int open_input(HLSContext *c, struct playlist *pls, struct segment *seg, AVIOContext **in)
1175 {
1176     AVDictionary *opts = NULL;
1177     int ret;
1178     int is_http = 0;
1179
1180     // broker prior HTTP options that should be consistent across requests
1181     av_dict_set(&opts, "user_agent", c->user_agent, 0);
1182     av_dict_set(&opts, "referer", c->referer, 0);
1183     av_dict_set(&opts, "cookies", c->cookies, 0);
1184     av_dict_set(&opts, "headers", c->headers, 0);
1185     av_dict_set(&opts, "http_proxy", c->http_proxy, 0);
1186     av_dict_set(&opts, "seekable", "0", 0);
1187
1188     if (c->http_persistent)
1189         av_dict_set(&opts, "multiple_requests", "1", 0);
1190
1191     if (seg->size >= 0) {
1192         /* try to restrict the HTTP request to the part we want
1193          * (if this is in fact a HTTP request) */
1194         av_dict_set_int(&opts, "offset", seg->url_offset, 0);
1195         av_dict_set_int(&opts, "end_offset", seg->url_offset + seg->size, 0);
1196     }
1197
1198     av_log(pls->parent, AV_LOG_VERBOSE, "HLS request for url '%s', offset %"PRId64", playlist %d\n",
1199            seg->url, seg->url_offset, pls->index);
1200
1201     if (seg->key_type == KEY_NONE) {
1202         ret = open_url(pls->parent, in, seg->url, c->avio_opts, opts, &is_http);
1203     } else if (seg->key_type == KEY_AES_128) {
1204         AVDictionary *opts2 = NULL;
1205         char iv[33], key[33], url[MAX_URL_SIZE];
1206         if (strcmp(seg->key, pls->key_url)) {
1207             AVIOContext *pb = NULL;
1208             if (open_url(pls->parent, &pb, seg->key, c->avio_opts, opts, NULL) == 0) {
1209                 ret = avio_read(pb, pls->key, sizeof(pls->key));
1210                 if (ret != sizeof(pls->key)) {
1211                     av_log(NULL, AV_LOG_ERROR, "Unable to read key file %s\n",
1212                            seg->key);
1213                 }
1214                 ff_format_io_close(pls->parent, &pb);
1215             } else {
1216                 av_log(NULL, AV_LOG_ERROR, "Unable to open key file %s\n",
1217                        seg->key);
1218             }
1219             av_strlcpy(pls->key_url, seg->key, sizeof(pls->key_url));
1220         }
1221         ff_data_to_hex(iv, seg->iv, sizeof(seg->iv), 0);
1222         ff_data_to_hex(key, pls->key, sizeof(pls->key), 0);
1223         iv[32] = key[32] = '\0';
1224         if (strstr(seg->url, "://"))
1225             snprintf(url, sizeof(url), "crypto+%s", seg->url);
1226         else
1227             snprintf(url, sizeof(url), "crypto:%s", seg->url);
1228
1229         av_dict_copy(&opts2, c->avio_opts, 0);
1230         av_dict_set(&opts2, "key", key, 0);
1231         av_dict_set(&opts2, "iv", iv, 0);
1232
1233         ret = open_url(pls->parent, in, url, opts2, opts, &is_http);
1234
1235         av_dict_free(&opts2);
1236
1237         if (ret < 0) {
1238             goto cleanup;
1239         }
1240         ret = 0;
1241     } else if (seg->key_type == KEY_SAMPLE_AES) {
1242         av_log(pls->parent, AV_LOG_ERROR,
1243                "SAMPLE-AES encryption is not supported yet\n");
1244         ret = AVERROR_PATCHWELCOME;
1245     }
1246     else
1247       ret = AVERROR(ENOSYS);
1248
1249     /* Seek to the requested position. If this was a HTTP request, the offset
1250      * should already be where want it to, but this allows e.g. local testing
1251      * without a HTTP server.
1252      *
1253      * This is not done for HTTP at all as avio_seek() does internal bookkeeping
1254      * of file offset which is out-of-sync with the actual offset when "offset"
1255      * AVOption is used with http protocol, causing the seek to not be a no-op
1256      * as would be expected. Wrong offset received from the server will not be
1257      * noticed without the call, though.
1258      */
1259     if (ret == 0 && !is_http && seg->key_type == KEY_NONE && seg->url_offset) {
1260         int64_t seekret = avio_seek(*in, seg->url_offset, SEEK_SET);
1261         if (seekret < 0) {
1262             av_log(pls->parent, AV_LOG_ERROR, "Unable to seek to offset %"PRId64" of HLS segment '%s'\n", seg->url_offset, seg->url);
1263             ret = seekret;
1264             ff_format_io_close(pls->parent, in);
1265         }
1266     }
1267
1268 cleanup:
1269     av_dict_free(&opts);
1270     pls->cur_seg_offset = 0;
1271     return ret;
1272 }
1273
1274 static int update_init_section(struct playlist *pls, struct segment *seg)
1275 {
1276     static const int max_init_section_size = 1024*1024;
1277     HLSContext *c = pls->parent->priv_data;
1278     int64_t sec_size;
1279     int64_t urlsize;
1280     int ret;
1281
1282     if (seg->init_section == pls->cur_init_section)
1283         return 0;
1284
1285     pls->cur_init_section = NULL;
1286
1287     if (!seg->init_section)
1288         return 0;
1289
1290     ret = open_input(c, pls, seg->init_section, &pls->input);
1291     if (ret < 0) {
1292         av_log(pls->parent, AV_LOG_WARNING,
1293                "Failed to open an initialization section in playlist %d\n",
1294                pls->index);
1295         return ret;
1296     }
1297
1298     if (seg->init_section->size >= 0)
1299         sec_size = seg->init_section->size;
1300     else if ((urlsize = avio_size(pls->input)) >= 0)
1301         sec_size = urlsize;
1302     else
1303         sec_size = max_init_section_size;
1304
1305     av_log(pls->parent, AV_LOG_DEBUG,
1306            "Downloading an initialization section of size %"PRId64"\n",
1307            sec_size);
1308
1309     sec_size = FFMIN(sec_size, max_init_section_size);
1310
1311     av_fast_malloc(&pls->init_sec_buf, &pls->init_sec_buf_size, sec_size);
1312
1313     ret = read_from_url(pls, seg->init_section, pls->init_sec_buf,
1314                         pls->init_sec_buf_size, READ_COMPLETE);
1315     ff_format_io_close(pls->parent, &pls->input);
1316
1317     if (ret < 0)
1318         return ret;
1319
1320     pls->cur_init_section = seg->init_section;
1321     pls->init_sec_data_len = ret;
1322     pls->init_sec_buf_read_offset = 0;
1323
1324     /* spec says audio elementary streams do not have media initialization
1325      * sections, so there should be no ID3 timestamps */
1326     pls->is_id3_timestamped = 0;
1327
1328     return 0;
1329 }
1330
1331 static int64_t default_reload_interval(struct playlist *pls)
1332 {
1333     return pls->n_segments > 0 ?
1334                           pls->segments[pls->n_segments - 1]->duration :
1335                           pls->target_duration;
1336 }
1337
1338 static int playlist_needed(struct playlist *pls)
1339 {
1340     AVFormatContext *s = pls->parent;
1341     int i, j;
1342     int stream_needed = 0;
1343     int first_st;
1344
1345     /* If there is no context or streams yet, the playlist is needed */
1346     if (!pls->ctx || !pls->n_main_streams)
1347         return 1;
1348
1349     /* check if any of the streams in the playlist are needed */
1350     for (i = 0; i < pls->n_main_streams; i++) {
1351         if (pls->main_streams[i]->discard < AVDISCARD_ALL) {
1352             stream_needed = 1;
1353             break;
1354         }
1355     }
1356
1357     /* If all streams in the playlist were discarded, the playlist is not
1358      * needed (regardless of whether whole programs are discarded or not). */
1359     if (!stream_needed)
1360         return 0;
1361
1362     /* Otherwise, check if all the programs (variants) this playlist is in are
1363      * discarded. Since all streams in the playlist are part of the same programs
1364      * we can just check the programs of the first stream. */
1365
1366     first_st = pls->main_streams[0]->index;
1367
1368     for (i = 0; i < s->nb_programs; i++) {
1369         AVProgram *program = s->programs[i];
1370         if (program->discard < AVDISCARD_ALL) {
1371             for (j = 0; j < program->nb_stream_indexes; j++) {
1372                 if (program->stream_index[j] == first_st) {
1373                     /* playlist is in an undiscarded program */
1374                     return 1;
1375                 }
1376             }
1377         }
1378     }
1379
1380     /* some streams were not discarded but all the programs were */
1381     return 0;
1382 }
1383
1384 static int read_data(void *opaque, uint8_t *buf, int buf_size)
1385 {
1386     struct playlist *v = opaque;
1387     HLSContext *c = v->parent->priv_data;
1388     int ret;
1389     int just_opened = 0;
1390     int reload_count = 0;
1391     struct segment *seg;
1392
1393 restart:
1394     if (!v->needed)
1395         return AVERROR_EOF;
1396
1397     if (!v->input || (c->http_persistent && v->input_read_done)) {
1398         int64_t reload_interval;
1399
1400         /* Check that the playlist is still needed before opening a new
1401          * segment. */
1402         v->needed = playlist_needed(v);
1403
1404         if (!v->needed) {
1405             av_log(v->parent, AV_LOG_INFO, "No longer receiving playlist %d\n",
1406                 v->index);
1407             return AVERROR_EOF;
1408         }
1409
1410         /* If this is a live stream and the reload interval has elapsed since
1411          * the last playlist reload, reload the playlists now. */
1412         reload_interval = default_reload_interval(v);
1413
1414 reload:
1415         reload_count++;
1416         if (reload_count > c->max_reload)
1417             return AVERROR_EOF;
1418         if (!v->finished &&
1419             av_gettime_relative() - v->last_load_time >= reload_interval) {
1420             if ((ret = parse_playlist(c, v->url, v, NULL)) < 0) {
1421                 if (ret != AVERROR_EXIT)
1422                     av_log(v->parent, AV_LOG_WARNING, "Failed to reload playlist %d\n",
1423                            v->index);
1424                 return ret;
1425             }
1426             /* If we need to reload the playlist again below (if
1427              * there's still no more segments), switch to a reload
1428              * interval of half the target duration. */
1429             reload_interval = v->target_duration / 2;
1430         }
1431         if (v->cur_seq_no < v->start_seq_no) {
1432             av_log(NULL, AV_LOG_WARNING,
1433                    "skipping %d segments ahead, expired from playlists\n",
1434                    v->start_seq_no - v->cur_seq_no);
1435             v->cur_seq_no = v->start_seq_no;
1436         }
1437         if (v->cur_seq_no >= v->start_seq_no + v->n_segments) {
1438             if (v->finished)
1439                 return AVERROR_EOF;
1440             while (av_gettime_relative() - v->last_load_time < reload_interval) {
1441                 if (ff_check_interrupt(c->interrupt_callback))
1442                     return AVERROR_EXIT;
1443                 av_usleep(100*1000);
1444             }
1445             /* Enough time has elapsed since the last reload */
1446             goto reload;
1447         }
1448
1449         v->input_read_done = 0;
1450         seg = current_segment(v);
1451
1452         /* load/update Media Initialization Section, if any */
1453         ret = update_init_section(v, seg);
1454         if (ret)
1455             return ret;
1456
1457         if (c->http_multiple == 1 && v->input_next_requested) {
1458             FFSWAP(AVIOContext *, v->input, v->input_next);
1459             v->input_next_requested = 0;
1460             ret = 0;
1461         } else {
1462             ret = open_input(c, v, seg, &v->input);
1463         }
1464         if (ret < 0) {
1465             if (ff_check_interrupt(c->interrupt_callback))
1466                 return AVERROR_EXIT;
1467             av_log(v->parent, AV_LOG_WARNING, "Failed to open segment %d of playlist %d\n",
1468                    v->cur_seq_no,
1469                    v->index);
1470             v->cur_seq_no += 1;
1471             goto reload;
1472         }
1473         just_opened = 1;
1474     }
1475
1476     if (c->http_multiple == -1) {
1477         uint8_t *http_version_opt = NULL;
1478         int r = av_opt_get(v->input, "http_version", AV_OPT_SEARCH_CHILDREN, &http_version_opt);
1479         if (r >= 0) {
1480             c->http_multiple = strncmp((const char *)http_version_opt, "1.1", 3) == 0;
1481             av_freep(&http_version_opt);
1482         }
1483     }
1484
1485     seg = next_segment(v);
1486     if (c->http_multiple == 1 && !v->input_next_requested &&
1487         seg && seg->key_type == KEY_NONE && av_strstart(seg->url, "http", NULL)) {
1488         ret = open_input(c, v, seg, &v->input_next);
1489         if (ret < 0) {
1490             if (ff_check_interrupt(c->interrupt_callback))
1491                 return AVERROR_EXIT;
1492             av_log(v->parent, AV_LOG_WARNING, "Failed to open segment %d of playlist %d\n",
1493                    v->cur_seq_no + 1,
1494                    v->index);
1495         } else {
1496             v->input_next_requested = 1;
1497         }
1498     }
1499
1500     if (v->init_sec_buf_read_offset < v->init_sec_data_len) {
1501         /* Push init section out first before first actual segment */
1502         int copy_size = FFMIN(v->init_sec_data_len - v->init_sec_buf_read_offset, buf_size);
1503         memcpy(buf, v->init_sec_buf, copy_size);
1504         v->init_sec_buf_read_offset += copy_size;
1505         return copy_size;
1506     }
1507
1508     seg = current_segment(v);
1509     ret = read_from_url(v, seg, buf, buf_size, READ_NORMAL);
1510     if (ret > 0) {
1511         if (just_opened && v->is_id3_timestamped != 0) {
1512             /* Intercept ID3 tags here, elementary audio streams are required
1513              * to convey timestamps using them in the beginning of each segment. */
1514             intercept_id3(v, buf, buf_size, &ret);
1515         }
1516
1517         return ret;
1518     }
1519     if (c->http_persistent &&
1520         seg->key_type == KEY_NONE && av_strstart(seg->url, "http", NULL)) {
1521         v->input_read_done = 1;
1522     } else {
1523         ff_format_io_close(v->parent, &v->input);
1524     }
1525     v->cur_seq_no++;
1526
1527     c->cur_seq_no = v->cur_seq_no;
1528
1529     goto restart;
1530 }
1531
1532 static void add_renditions_to_variant(HLSContext *c, struct variant *var,
1533                                       enum AVMediaType type, const char *group_id)
1534 {
1535     int i;
1536
1537     for (i = 0; i < c->n_renditions; i++) {
1538         struct rendition *rend = c->renditions[i];
1539
1540         if (rend->type == type && !strcmp(rend->group_id, group_id)) {
1541
1542             if (rend->playlist)
1543                 /* rendition is an external playlist
1544                  * => add the playlist to the variant */
1545                 dynarray_add(&var->playlists, &var->n_playlists, rend->playlist);
1546             else
1547                 /* rendition is part of the variant main Media Playlist
1548                  * => add the rendition to the main Media Playlist */
1549                 dynarray_add(&var->playlists[0]->renditions,
1550                              &var->playlists[0]->n_renditions,
1551                              rend);
1552         }
1553     }
1554 }
1555
1556 static void add_metadata_from_renditions(AVFormatContext *s, struct playlist *pls,
1557                                          enum AVMediaType type)
1558 {
1559     int rend_idx = 0;
1560     int i;
1561
1562     for (i = 0; i < pls->n_main_streams; i++) {
1563         AVStream *st = pls->main_streams[i];
1564
1565         if (st->codecpar->codec_type != type)
1566             continue;
1567
1568         for (; rend_idx < pls->n_renditions; rend_idx++) {
1569             struct rendition *rend = pls->renditions[rend_idx];
1570
1571             if (rend->type != type)
1572                 continue;
1573
1574             if (rend->language[0])
1575                 av_dict_set(&st->metadata, "language", rend->language, 0);
1576             if (rend->name[0])
1577                 av_dict_set(&st->metadata, "comment", rend->name, 0);
1578
1579             st->disposition |= rend->disposition;
1580         }
1581         if (rend_idx >=pls->n_renditions)
1582             break;
1583     }
1584 }
1585
1586 /* if timestamp was in valid range: returns 1 and sets seq_no
1587  * if not: returns 0 and sets seq_no to closest segment */
1588 static int find_timestamp_in_playlist(HLSContext *c, struct playlist *pls,
1589                                       int64_t timestamp, int *seq_no)
1590 {
1591     int i;
1592     int64_t pos = c->first_timestamp == AV_NOPTS_VALUE ?
1593                   0 : c->first_timestamp;
1594
1595     if (timestamp < pos) {
1596         *seq_no = pls->start_seq_no;
1597         return 0;
1598     }
1599
1600     for (i = 0; i < pls->n_segments; i++) {
1601         int64_t diff = pos + pls->segments[i]->duration - timestamp;
1602         if (diff > 0) {
1603             *seq_no = pls->start_seq_no + i;
1604             return 1;
1605         }
1606         pos += pls->segments[i]->duration;
1607     }
1608
1609     *seq_no = pls->start_seq_no + pls->n_segments - 1;
1610
1611     return 0;
1612 }
1613
1614 static int select_cur_seq_no(HLSContext *c, struct playlist *pls)
1615 {
1616     int seq_no;
1617
1618     if (!pls->finished && !c->first_packet &&
1619         av_gettime_relative() - pls->last_load_time >= default_reload_interval(pls))
1620         /* reload the playlist since it was suspended */
1621         parse_playlist(c, pls->url, pls, NULL);
1622
1623     /* If playback is already in progress (we are just selecting a new
1624      * playlist) and this is a complete file, find the matching segment
1625      * by counting durations. */
1626     if (pls->finished && c->cur_timestamp != AV_NOPTS_VALUE) {
1627         find_timestamp_in_playlist(c, pls, c->cur_timestamp, &seq_no);
1628         return seq_no;
1629     }
1630
1631     if (!pls->finished) {
1632         if (!c->first_packet && /* we are doing a segment selection during playback */
1633             c->cur_seq_no >= pls->start_seq_no &&
1634             c->cur_seq_no < pls->start_seq_no + pls->n_segments)
1635             /* While spec 3.4.3 says that we cannot assume anything about the
1636              * content at the same sequence number on different playlists,
1637              * in practice this seems to work and doing it otherwise would
1638              * require us to download a segment to inspect its timestamps. */
1639             return c->cur_seq_no;
1640
1641         /* If this is a live stream, start live_start_index segments from the
1642          * start or end */
1643         if (c->live_start_index < 0)
1644             return pls->start_seq_no + FFMAX(pls->n_segments + c->live_start_index, 0);
1645         else
1646             return pls->start_seq_no + FFMIN(c->live_start_index, pls->n_segments - 1);
1647     }
1648
1649     /* Otherwise just start on the first segment. */
1650     return pls->start_seq_no;
1651 }
1652
1653 static int save_avio_options(AVFormatContext *s)
1654 {
1655     HLSContext *c = s->priv_data;
1656     static const char * const opts[] = {
1657         "headers", "http_proxy", "user_agent", "user-agent", "cookies", "referer", NULL };
1658     const char * const * opt = opts;
1659     uint8_t *buf;
1660     int ret = 0;
1661
1662     while (*opt) {
1663         if (av_opt_get(s->pb, *opt, AV_OPT_SEARCH_CHILDREN | AV_OPT_ALLOW_NULL, &buf) >= 0) {
1664             ret = av_dict_set(&c->avio_opts, *opt, buf,
1665                               AV_DICT_DONT_STRDUP_VAL);
1666             if (ret < 0)
1667                 return ret;
1668         }
1669         opt++;
1670     }
1671
1672     return ret;
1673 }
1674
1675 static int nested_io_open(AVFormatContext *s, AVIOContext **pb, const char *url,
1676                           int flags, AVDictionary **opts)
1677 {
1678     av_log(s, AV_LOG_ERROR,
1679            "A HLS playlist item '%s' referred to an external file '%s'. "
1680            "Opening this file was forbidden for security reasons\n",
1681            s->url, url);
1682     return AVERROR(EPERM);
1683 }
1684
1685 static void add_stream_to_programs(AVFormatContext *s, struct playlist *pls, AVStream *stream)
1686 {
1687     HLSContext *c = s->priv_data;
1688     int i, j;
1689     int bandwidth = -1;
1690
1691     for (i = 0; i < c->n_variants; i++) {
1692         struct variant *v = c->variants[i];
1693
1694         for (j = 0; j < v->n_playlists; j++) {
1695             if (v->playlists[j] != pls)
1696                 continue;
1697
1698             av_program_add_stream_index(s, i, stream->index);
1699
1700             if (bandwidth < 0)
1701                 bandwidth = v->bandwidth;
1702             else if (bandwidth != v->bandwidth)
1703                 bandwidth = -1; /* stream in multiple variants with different bandwidths */
1704         }
1705     }
1706
1707     if (bandwidth >= 0)
1708         av_dict_set_int(&stream->metadata, "variant_bitrate", bandwidth, 0);
1709 }
1710
1711 static int set_stream_info_from_input_stream(AVStream *st, struct playlist *pls, AVStream *ist)
1712 {
1713     int err;
1714
1715     err = avcodec_parameters_copy(st->codecpar, ist->codecpar);
1716     if (err < 0)
1717         return err;
1718
1719     if (pls->is_id3_timestamped) /* custom timestamps via id3 */
1720         avpriv_set_pts_info(st, 33, 1, MPEG_TIME_BASE);
1721     else
1722         avpriv_set_pts_info(st, ist->pts_wrap_bits, ist->time_base.num, ist->time_base.den);
1723
1724     st->internal->need_context_update = 1;
1725
1726     return 0;
1727 }
1728
1729 /* add new subdemuxer streams to our context, if any */
1730 static int update_streams_from_subdemuxer(AVFormatContext *s, struct playlist *pls)
1731 {
1732     int err;
1733
1734     while (pls->n_main_streams < pls->ctx->nb_streams) {
1735         int ist_idx = pls->n_main_streams;
1736         AVStream *st = avformat_new_stream(s, NULL);
1737         AVStream *ist = pls->ctx->streams[ist_idx];
1738
1739         if (!st)
1740             return AVERROR(ENOMEM);
1741
1742         st->id = pls->index;
1743         dynarray_add(&pls->main_streams, &pls->n_main_streams, st);
1744
1745         add_stream_to_programs(s, pls, st);
1746
1747         err = set_stream_info_from_input_stream(st, pls, ist);
1748         if (err < 0)
1749             return err;
1750     }
1751
1752     return 0;
1753 }
1754
1755 static void update_noheader_flag(AVFormatContext *s)
1756 {
1757     HLSContext *c = s->priv_data;
1758     int flag_needed = 0;
1759     int i;
1760
1761     for (i = 0; i < c->n_playlists; i++) {
1762         struct playlist *pls = c->playlists[i];
1763
1764         if (pls->has_noheader_flag) {
1765             flag_needed = 1;
1766             break;
1767         }
1768     }
1769
1770     if (flag_needed)
1771         s->ctx_flags |= AVFMTCTX_NOHEADER;
1772     else
1773         s->ctx_flags &= ~AVFMTCTX_NOHEADER;
1774 }
1775
1776 static int hls_close(AVFormatContext *s)
1777 {
1778     HLSContext *c = s->priv_data;
1779
1780     free_playlist_list(c);
1781     free_variant_list(c);
1782     free_rendition_list(c);
1783
1784     av_dict_free(&c->avio_opts);
1785     ff_format_io_close(c->ctx, &c->playlist_pb);
1786
1787     return 0;
1788 }
1789
1790 static int hls_read_header(AVFormatContext *s)
1791 {
1792     void *u = (s->flags & AVFMT_FLAG_CUSTOM_IO) ? NULL : s->pb;
1793     HLSContext *c = s->priv_data;
1794     int ret = 0, i;
1795     int highest_cur_seq_no = 0;
1796
1797     c->ctx                = s;
1798     c->interrupt_callback = &s->interrupt_callback;
1799     c->strict_std_compliance = s->strict_std_compliance;
1800
1801     c->first_packet = 1;
1802     c->first_timestamp = AV_NOPTS_VALUE;
1803     c->cur_timestamp = AV_NOPTS_VALUE;
1804
1805     if (u) {
1806         // get the previous user agent & set back to null if string size is zero
1807         update_options(&c->user_agent, "user_agent", u);
1808
1809         // get the previous cookies & set back to null if string size is zero
1810         update_options(&c->cookies, "cookies", u);
1811
1812         // get the previous headers & set back to null if string size is zero
1813         update_options(&c->headers, "headers", u);
1814
1815         // get the previous http proxt & set back to null if string size is zero
1816         update_options(&c->http_proxy, "http_proxy", u);
1817     }
1818
1819     if ((ret = parse_playlist(c, s->url, NULL, s->pb)) < 0)
1820         goto fail;
1821
1822     if ((ret = save_avio_options(s)) < 0)
1823         goto fail;
1824
1825     /* Some HLS servers don't like being sent the range header */
1826     av_dict_set(&c->avio_opts, "seekable", "0", 0);
1827
1828     if (c->n_variants == 0) {
1829         av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1830         ret = AVERROR_EOF;
1831         goto fail;
1832     }
1833     /* If the playlist only contained playlists (Master Playlist),
1834      * parse each individual playlist. */
1835     if (c->n_playlists > 1 || c->playlists[0]->n_segments == 0) {
1836         for (i = 0; i < c->n_playlists; i++) {
1837             struct playlist *pls = c->playlists[i];
1838             if ((ret = parse_playlist(c, pls->url, pls, NULL)) < 0)
1839                 goto fail;
1840         }
1841     }
1842
1843     if (c->variants[0]->playlists[0]->n_segments == 0) {
1844         av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
1845         ret = AVERROR_EOF;
1846         goto fail;
1847     }
1848
1849     /* If this isn't a live stream, calculate the total duration of the
1850      * stream. */
1851     if (c->variants[0]->playlists[0]->finished) {
1852         int64_t duration = 0;
1853         for (i = 0; i < c->variants[0]->playlists[0]->n_segments; i++)
1854             duration += c->variants[0]->playlists[0]->segments[i]->duration;
1855         s->duration = duration;
1856     }
1857
1858     /* Associate renditions with variants */
1859     for (i = 0; i < c->n_variants; i++) {
1860         struct variant *var = c->variants[i];
1861
1862         if (var->audio_group[0])
1863             add_renditions_to_variant(c, var, AVMEDIA_TYPE_AUDIO, var->audio_group);
1864         if (var->video_group[0])
1865             add_renditions_to_variant(c, var, AVMEDIA_TYPE_VIDEO, var->video_group);
1866         if (var->subtitles_group[0])
1867             add_renditions_to_variant(c, var, AVMEDIA_TYPE_SUBTITLE, var->subtitles_group);
1868     }
1869
1870     /* Create a program for each variant */
1871     for (i = 0; i < c->n_variants; i++) {
1872         struct variant *v = c->variants[i];
1873         AVProgram *program;
1874
1875         program = av_new_program(s, i);
1876         if (!program)
1877             goto fail;
1878         av_dict_set_int(&program->metadata, "variant_bitrate", v->bandwidth, 0);
1879     }
1880
1881     /* Select the starting segments */
1882     for (i = 0; i < c->n_playlists; i++) {
1883         struct playlist *pls = c->playlists[i];
1884
1885         if (pls->n_segments == 0)
1886             continue;
1887
1888         pls->cur_seq_no = select_cur_seq_no(c, pls);
1889         highest_cur_seq_no = FFMAX(highest_cur_seq_no, pls->cur_seq_no);
1890     }
1891
1892     /* Open the demuxer for each playlist */
1893     for (i = 0; i < c->n_playlists; i++) {
1894         struct playlist *pls = c->playlists[i];
1895         AVInputFormat *in_fmt = NULL;
1896
1897         if (!(pls->ctx = avformat_alloc_context())) {
1898             ret = AVERROR(ENOMEM);
1899             goto fail;
1900         }
1901
1902         if (pls->n_segments == 0)
1903             continue;
1904
1905         pls->index  = i;
1906         pls->needed = 1;
1907         pls->parent = s;
1908
1909         /*
1910          * If this is a live stream and this playlist looks like it is one segment
1911          * behind, try to sync it up so that every substream starts at the same
1912          * time position (so e.g. avformat_find_stream_info() will see packets from
1913          * all active streams within the first few seconds). This is not very generic,
1914          * though, as the sequence numbers are technically independent.
1915          */
1916         if (!pls->finished && pls->cur_seq_no == highest_cur_seq_no - 1 &&
1917             highest_cur_seq_no < pls->start_seq_no + pls->n_segments) {
1918             pls->cur_seq_no = highest_cur_seq_no;
1919         }
1920
1921         pls->read_buffer = av_malloc(INITIAL_BUFFER_SIZE);
1922         if (!pls->read_buffer){
1923             ret = AVERROR(ENOMEM);
1924             avformat_free_context(pls->ctx);
1925             pls->ctx = NULL;
1926             goto fail;
1927         }
1928         ffio_init_context(&pls->pb, pls->read_buffer, INITIAL_BUFFER_SIZE, 0, pls,
1929                           read_data, NULL, NULL);
1930         pls->pb.seekable = 0;
1931         ret = av_probe_input_buffer(&pls->pb, &in_fmt, pls->segments[0]->url,
1932                                     NULL, 0, 0);
1933         if (ret < 0) {
1934             /* Free the ctx - it isn't initialized properly at this point,
1935              * so avformat_close_input shouldn't be called. If
1936              * avformat_open_input fails below, it frees and zeros the
1937              * context, so it doesn't need any special treatment like this. */
1938             av_log(s, AV_LOG_ERROR, "Error when loading first segment '%s'\n", pls->segments[0]->url);
1939             avformat_free_context(pls->ctx);
1940             pls->ctx = NULL;
1941             goto fail;
1942         }
1943         pls->ctx->pb       = &pls->pb;
1944         pls->ctx->io_open  = nested_io_open;
1945         pls->ctx->flags   |= s->flags & ~AVFMT_FLAG_CUSTOM_IO;
1946
1947         if ((ret = ff_copy_whiteblacklists(pls->ctx, s)) < 0)
1948             goto fail;
1949
1950         ret = avformat_open_input(&pls->ctx, pls->segments[0]->url, in_fmt, NULL);
1951         if (ret < 0)
1952             goto fail;
1953
1954         if (pls->id3_deferred_extra && pls->ctx->nb_streams == 1) {
1955             ff_id3v2_parse_apic(pls->ctx, &pls->id3_deferred_extra);
1956             avformat_queue_attached_pictures(pls->ctx);
1957             ff_id3v2_parse_priv(pls->ctx, &pls->id3_deferred_extra);
1958             ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
1959             pls->id3_deferred_extra = NULL;
1960         }
1961
1962         if (pls->is_id3_timestamped == -1)
1963             av_log(s, AV_LOG_WARNING, "No expected HTTP requests have been made\n");
1964
1965         /*
1966          * For ID3 timestamped raw audio streams we need to detect the packet
1967          * durations to calculate timestamps in fill_timing_for_id3_timestamped_stream(),
1968          * but for other streams we can rely on our user calling avformat_find_stream_info()
1969          * on us if they want to.
1970          */
1971         if (pls->is_id3_timestamped) {
1972             ret = avformat_find_stream_info(pls->ctx, NULL);
1973             if (ret < 0)
1974                 goto fail;
1975         }
1976
1977         pls->has_noheader_flag = !!(pls->ctx->ctx_flags & AVFMTCTX_NOHEADER);
1978
1979         /* Create new AVStreams for each stream in this playlist */
1980         ret = update_streams_from_subdemuxer(s, pls);
1981         if (ret < 0)
1982             goto fail;
1983
1984         /*
1985          * Copy any metadata from playlist to main streams, but do not set
1986          * event flags.
1987          */
1988         if (pls->n_main_streams)
1989             av_dict_copy(&pls->main_streams[0]->metadata, pls->ctx->metadata, 0);
1990
1991         add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_AUDIO);
1992         add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_VIDEO);
1993         add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_SUBTITLE);
1994     }
1995
1996     update_noheader_flag(s);
1997
1998     return 0;
1999 fail:
2000     hls_close(s);
2001     return ret;
2002 }
2003
2004 static int recheck_discard_flags(AVFormatContext *s, int first)
2005 {
2006     HLSContext *c = s->priv_data;
2007     int i, changed = 0;
2008     int cur_needed;
2009
2010     /* Check if any new streams are needed */
2011     for (i = 0; i < c->n_playlists; i++) {
2012         struct playlist *pls = c->playlists[i];
2013
2014         cur_needed = playlist_needed(c->playlists[i]);
2015
2016         if (cur_needed && !pls->needed) {
2017             pls->needed = 1;
2018             changed = 1;
2019             pls->cur_seq_no = select_cur_seq_no(c, pls);
2020             pls->pb.eof_reached = 0;
2021             if (c->cur_timestamp != AV_NOPTS_VALUE) {
2022                 /* catch up */
2023                 pls->seek_timestamp = c->cur_timestamp;
2024                 pls->seek_flags = AVSEEK_FLAG_ANY;
2025                 pls->seek_stream_index = -1;
2026             }
2027             av_log(s, AV_LOG_INFO, "Now receiving playlist %d, segment %d\n", i, pls->cur_seq_no);
2028         } else if (first && !cur_needed && pls->needed) {
2029             if (pls->input)
2030                 ff_format_io_close(pls->parent, &pls->input);
2031             pls->input_read_done = 0;
2032             if (pls->input_next)
2033                 ff_format_io_close(pls->parent, &pls->input_next);
2034             pls->input_next_requested = 0;
2035             pls->needed = 0;
2036             changed = 1;
2037             av_log(s, AV_LOG_INFO, "No longer receiving playlist %d\n", i);
2038         }
2039     }
2040     return changed;
2041 }
2042
2043 static void fill_timing_for_id3_timestamped_stream(struct playlist *pls)
2044 {
2045     if (pls->id3_offset >= 0) {
2046         pls->pkt.dts = pls->id3_mpegts_timestamp +
2047                                  av_rescale_q(pls->id3_offset,
2048                                               pls->ctx->streams[pls->pkt.stream_index]->time_base,
2049                                               MPEG_TIME_BASE_Q);
2050         if (pls->pkt.duration)
2051             pls->id3_offset += pls->pkt.duration;
2052         else
2053             pls->id3_offset = -1;
2054     } else {
2055         /* there have been packets with unknown duration
2056          * since the last id3 tag, should not normally happen */
2057         pls->pkt.dts = AV_NOPTS_VALUE;
2058     }
2059
2060     if (pls->pkt.duration)
2061         pls->pkt.duration = av_rescale_q(pls->pkt.duration,
2062                                          pls->ctx->streams[pls->pkt.stream_index]->time_base,
2063                                          MPEG_TIME_BASE_Q);
2064
2065     pls->pkt.pts = AV_NOPTS_VALUE;
2066 }
2067
2068 static AVRational get_timebase(struct playlist *pls)
2069 {
2070     if (pls->is_id3_timestamped)
2071         return MPEG_TIME_BASE_Q;
2072
2073     return pls->ctx->streams[pls->pkt.stream_index]->time_base;
2074 }
2075
2076 static int compare_ts_with_wrapdetect(int64_t ts_a, struct playlist *pls_a,
2077                                       int64_t ts_b, struct playlist *pls_b)
2078 {
2079     int64_t scaled_ts_a = av_rescale_q(ts_a, get_timebase(pls_a), MPEG_TIME_BASE_Q);
2080     int64_t scaled_ts_b = av_rescale_q(ts_b, get_timebase(pls_b), MPEG_TIME_BASE_Q);
2081
2082     return av_compare_mod(scaled_ts_a, scaled_ts_b, 1LL << 33);
2083 }
2084
2085 static int hls_read_packet(AVFormatContext *s, AVPacket *pkt)
2086 {
2087     HLSContext *c = s->priv_data;
2088     int ret, i, minplaylist = -1;
2089
2090     recheck_discard_flags(s, c->first_packet);
2091     c->first_packet = 0;
2092
2093     for (i = 0; i < c->n_playlists; i++) {
2094         struct playlist *pls = c->playlists[i];
2095         /* Make sure we've got one buffered packet from each open playlist
2096          * stream */
2097         if (pls->needed && !pls->pkt.data) {
2098             while (1) {
2099                 int64_t ts_diff;
2100                 AVRational tb;
2101                 ret = av_read_frame(pls->ctx, &pls->pkt);
2102                 if (ret < 0) {
2103                     if (!avio_feof(&pls->pb) && ret != AVERROR_EOF)
2104                         return ret;
2105                     reset_packet(&pls->pkt);
2106                     break;
2107                 } else {
2108                     /* stream_index check prevents matching picture attachments etc. */
2109                     if (pls->is_id3_timestamped && pls->pkt.stream_index == 0) {
2110                         /* audio elementary streams are id3 timestamped */
2111                         fill_timing_for_id3_timestamped_stream(pls);
2112                     }
2113
2114                     if (c->first_timestamp == AV_NOPTS_VALUE &&
2115                         pls->pkt.dts       != AV_NOPTS_VALUE)
2116                         c->first_timestamp = av_rescale_q(pls->pkt.dts,
2117                             get_timebase(pls), AV_TIME_BASE_Q);
2118                 }
2119
2120                 if (pls->seek_timestamp == AV_NOPTS_VALUE)
2121                     break;
2122
2123                 if (pls->seek_stream_index < 0 ||
2124                     pls->seek_stream_index == pls->pkt.stream_index) {
2125
2126                     if (pls->pkt.dts == AV_NOPTS_VALUE) {
2127                         pls->seek_timestamp = AV_NOPTS_VALUE;
2128                         break;
2129                     }
2130
2131                     tb = get_timebase(pls);
2132                     ts_diff = av_rescale_rnd(pls->pkt.dts, AV_TIME_BASE,
2133                                             tb.den, AV_ROUND_DOWN) -
2134                             pls->seek_timestamp;
2135                     if (ts_diff >= 0 && (pls->seek_flags  & AVSEEK_FLAG_ANY ||
2136                                         pls->pkt.flags & AV_PKT_FLAG_KEY)) {
2137                         pls->seek_timestamp = AV_NOPTS_VALUE;
2138                         break;
2139                     }
2140                 }
2141                 av_packet_unref(&pls->pkt);
2142                 reset_packet(&pls->pkt);
2143             }
2144         }
2145         /* Check if this stream has the packet with the lowest dts */
2146         if (pls->pkt.data) {
2147             struct playlist *minpls = minplaylist < 0 ?
2148                                      NULL : c->playlists[minplaylist];
2149             if (minplaylist < 0) {
2150                 minplaylist = i;
2151             } else {
2152                 int64_t dts     =    pls->pkt.dts;
2153                 int64_t mindts  = minpls->pkt.dts;
2154
2155                 if (dts == AV_NOPTS_VALUE ||
2156                     (mindts != AV_NOPTS_VALUE && compare_ts_with_wrapdetect(dts, pls, mindts, minpls) < 0))
2157                     minplaylist = i;
2158             }
2159         }
2160     }
2161
2162     /* If we got a packet, return it */
2163     if (minplaylist >= 0) {
2164         struct playlist *pls = c->playlists[minplaylist];
2165         AVStream *ist;
2166         AVStream *st;
2167
2168         ret = update_streams_from_subdemuxer(s, pls);
2169         if (ret < 0) {
2170             av_packet_unref(&pls->pkt);
2171             reset_packet(&pls->pkt);
2172             return ret;
2173         }
2174
2175         // If sub-demuxer reports updated metadata, copy it to the first stream
2176         // and set its AVSTREAM_EVENT_FLAG_METADATA_UPDATED flag.
2177         if (pls->ctx->event_flags & AVFMT_EVENT_FLAG_METADATA_UPDATED) {
2178             if (pls->n_main_streams) {
2179                 st = pls->main_streams[0];
2180                 av_dict_copy(&st->metadata, pls->ctx->metadata, 0);
2181                 st->event_flags |= AVSTREAM_EVENT_FLAG_METADATA_UPDATED;
2182             }
2183             pls->ctx->event_flags &= ~AVFMT_EVENT_FLAG_METADATA_UPDATED;
2184         }
2185
2186         /* check if noheader flag has been cleared by the subdemuxer */
2187         if (pls->has_noheader_flag && !(pls->ctx->ctx_flags & AVFMTCTX_NOHEADER)) {
2188             pls->has_noheader_flag = 0;
2189             update_noheader_flag(s);
2190         }
2191
2192         if (pls->pkt.stream_index >= pls->n_main_streams) {
2193             av_log(s, AV_LOG_ERROR, "stream index inconsistency: index %d, %d main streams, %d subdemuxer streams\n",
2194                    pls->pkt.stream_index, pls->n_main_streams, pls->ctx->nb_streams);
2195             av_packet_unref(&pls->pkt);
2196             reset_packet(&pls->pkt);
2197             return AVERROR_BUG;
2198         }
2199
2200         ist = pls->ctx->streams[pls->pkt.stream_index];
2201         st = pls->main_streams[pls->pkt.stream_index];
2202
2203         *pkt = pls->pkt;
2204         pkt->stream_index = st->index;
2205         reset_packet(&c->playlists[minplaylist]->pkt);
2206
2207         if (pkt->dts != AV_NOPTS_VALUE)
2208             c->cur_timestamp = av_rescale_q(pkt->dts,
2209                                             ist->time_base,
2210                                             AV_TIME_BASE_Q);
2211
2212         /* There may be more situations where this would be useful, but this at least
2213          * handles newly probed codecs properly (i.e. request_probe by mpegts). */
2214         if (ist->codecpar->codec_id != st->codecpar->codec_id) {
2215             ret = set_stream_info_from_input_stream(st, pls, ist);
2216             if (ret < 0) {
2217                 av_packet_unref(pkt);
2218                 return ret;
2219             }
2220         }
2221
2222         return 0;
2223     }
2224     return AVERROR_EOF;
2225 }
2226
2227 static int hls_read_seek(AVFormatContext *s, int stream_index,
2228                                int64_t timestamp, int flags)
2229 {
2230     HLSContext *c = s->priv_data;
2231     struct playlist *seek_pls = NULL;
2232     int i, seq_no;
2233     int j;
2234     int stream_subdemuxer_index;
2235     int64_t first_timestamp, seek_timestamp, duration;
2236
2237     if ((flags & AVSEEK_FLAG_BYTE) || (c->ctx->ctx_flags & AVFMTCTX_UNSEEKABLE))
2238         return AVERROR(ENOSYS);
2239
2240     first_timestamp = c->first_timestamp == AV_NOPTS_VALUE ?
2241                       0 : c->first_timestamp;
2242
2243     seek_timestamp = av_rescale_rnd(timestamp, AV_TIME_BASE,
2244                                     s->streams[stream_index]->time_base.den,
2245                                     flags & AVSEEK_FLAG_BACKWARD ?
2246                                     AV_ROUND_DOWN : AV_ROUND_UP);
2247
2248     duration = s->duration == AV_NOPTS_VALUE ?
2249                0 : s->duration;
2250
2251     if (0 < duration && duration < seek_timestamp - first_timestamp)
2252         return AVERROR(EIO);
2253
2254     /* find the playlist with the specified stream */
2255     for (i = 0; i < c->n_playlists; i++) {
2256         struct playlist *pls = c->playlists[i];
2257         for (j = 0; j < pls->n_main_streams; j++) {
2258             if (pls->main_streams[j] == s->streams[stream_index]) {
2259                 seek_pls = pls;
2260                 stream_subdemuxer_index = j;
2261                 break;
2262             }
2263         }
2264     }
2265     /* check if the timestamp is valid for the playlist with the
2266      * specified stream index */
2267     if (!seek_pls || !find_timestamp_in_playlist(c, seek_pls, seek_timestamp, &seq_no))
2268         return AVERROR(EIO);
2269
2270     /* set segment now so we do not need to search again below */
2271     seek_pls->cur_seq_no = seq_no;
2272     seek_pls->seek_stream_index = stream_subdemuxer_index;
2273
2274     for (i = 0; i < c->n_playlists; i++) {
2275         /* Reset reading */
2276         struct playlist *pls = c->playlists[i];
2277         if (pls->input)
2278             ff_format_io_close(pls->parent, &pls->input);
2279         pls->input_read_done = 0;
2280         if (pls->input_next)
2281             ff_format_io_close(pls->parent, &pls->input_next);
2282         pls->input_next_requested = 0;
2283         av_packet_unref(&pls->pkt);
2284         reset_packet(&pls->pkt);
2285         pls->pb.eof_reached = 0;
2286         /* Clear any buffered data */
2287         pls->pb.buf_end = pls->pb.buf_ptr = pls->pb.buffer;
2288         /* Reset the pos, to let the mpegts demuxer know we've seeked. */
2289         pls->pb.pos = 0;
2290         /* Flush the packet queue of the subdemuxer. */
2291         ff_read_frame_flush(pls->ctx);
2292
2293         pls->seek_timestamp = seek_timestamp;
2294         pls->seek_flags = flags;
2295
2296         if (pls != seek_pls) {
2297             /* set closest segment seq_no for playlists not handled above */
2298             find_timestamp_in_playlist(c, pls, seek_timestamp, &pls->cur_seq_no);
2299             /* seek the playlist to the given position without taking
2300              * keyframes into account since this playlist does not have the
2301              * specified stream where we should look for the keyframes */
2302             pls->seek_stream_index = -1;
2303             pls->seek_flags |= AVSEEK_FLAG_ANY;
2304         }
2305     }
2306
2307     c->cur_timestamp = seek_timestamp;
2308
2309     return 0;
2310 }
2311
2312 static int hls_probe(AVProbeData *p)
2313 {
2314     /* Require #EXTM3U at the start, and either one of the ones below
2315      * somewhere for a proper match. */
2316     if (strncmp(p->buf, "#EXTM3U", 7))
2317         return 0;
2318
2319     if (strstr(p->buf, "#EXT-X-STREAM-INF:")     ||
2320         strstr(p->buf, "#EXT-X-TARGETDURATION:") ||
2321         strstr(p->buf, "#EXT-X-MEDIA-SEQUENCE:"))
2322         return AVPROBE_SCORE_MAX;
2323     return 0;
2324 }
2325
2326 #define OFFSET(x) offsetof(HLSContext, x)
2327 #define FLAGS AV_OPT_FLAG_DECODING_PARAM
2328 static const AVOption hls_options[] = {
2329     {"live_start_index", "segment index to start live streams at (negative values are from the end)",
2330         OFFSET(live_start_index), AV_OPT_TYPE_INT, {.i64 = -3}, INT_MIN, INT_MAX, FLAGS},
2331     {"allowed_extensions", "List of file extensions that hls is allowed to access",
2332         OFFSET(allowed_extensions), AV_OPT_TYPE_STRING,
2333         {.str = "3gp,aac,avi,flac,mkv,m3u8,m4a,m4s,m4v,mpg,mov,mp2,mp3,mp4,mpeg,mpegts,ogg,ogv,oga,ts,vob,wav"},
2334         INT_MIN, INT_MAX, FLAGS},
2335     {"max_reload", "Maximum number of times a insufficient list is attempted to be reloaded",
2336         OFFSET(max_reload), AV_OPT_TYPE_INT, {.i64 = 1000}, 0, INT_MAX, FLAGS},
2337     {"http_persistent", "Use persistent HTTP connections",
2338         OFFSET(http_persistent), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, FLAGS },
2339     {"http_multiple", "Use multiple HTTP connections for fetching segments",
2340         OFFSET(http_multiple), AV_OPT_TYPE_BOOL, {.i64 = -1}, -1, 1, FLAGS},
2341     {NULL}
2342 };
2343
2344 static const AVClass hls_class = {
2345     .class_name = "hls,applehttp",
2346     .item_name  = av_default_item_name,
2347     .option     = hls_options,
2348     .version    = LIBAVUTIL_VERSION_INT,
2349 };
2350
2351 AVInputFormat ff_hls_demuxer = {
2352     .name           = "hls,applehttp",
2353     .long_name      = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
2354     .priv_class     = &hls_class,
2355     .priv_data_size = sizeof(HLSContext),
2356     .flags          = AVFMT_NOGENSEARCH,
2357     .read_probe     = hls_probe,
2358     .read_header    = hls_read_header,
2359     .read_packet    = hls_read_packet,
2360     .read_close     = hls_close,
2361     .read_seek      = hls_read_seek,
2362 };