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