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