hls.c 58.1 KB
Newer Older
1 2 3
/*
 * Apple HTTP Live Streaming demuxer
 * Copyright (c) 2010 Martin Storsjo
4
 * Copyright (c) 2013 Anssi Hannula
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
 * @file
 * Apple HTTP Live Streaming demuxer
 * http://tools.ietf.org/html/draft-pantos-http-live-streaming
 */

#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 37
#include "avformat.h"
#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 45 46
#define MAX_FIELD_LEN 64
#define MAX_CHARACTERISTICS_LEN 512

47 48 49
#define MPEG_TIME_BASE 90000
#define MPEG_TIME_BASE_Q (AVRational){1, MPEG_TIME_BASE}

50 51 52 53
/*
 * An apple http stream consists of a playlist with media segment files,
 * played sequentially. There may be several playlists with the same
 * video content, in different bandwidth variants, that are played in
54
 * parallel (preferably only one bandwidth variant at a time). In this case,
55 56 57 58 59 60 61
 * the user supplied the url to a main playlist that only lists the variant
 * playlists.
 *
 * If the main playlist doesn't point at any variants, we still create
 * one anonymous toplevel variant for this, to maintain the structure.
 */

62 63 64 65 66
enum KeyType {
    KEY_NONE,
    KEY_AES_128,
};

67
struct segment {
68
    int64_t duration;
69 70
    int64_t url_offset;
    int64_t size;
71 72
    char *url;
    char *key;
73 74
    enum KeyType key_type;
    uint8_t iv[16];
75 76
};

77 78
struct rendition;

79 80 81 82 83 84
enum PlaylistType {
    PLS_TYPE_UNSPECIFIED,
    PLS_TYPE_EVENT,
    PLS_TYPE_VOD
};

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 89
 * containing the next packet from this stream.
 */
90
struct playlist {
91
    char url[MAX_URL_SIZE];
92 93 94 95 96
    AVIOContext pb;
    uint8_t* read_buffer;
    URLContext *input;
    AVFormatContext *parent;
    int index;
97 98 99 100
    AVFormatContext *ctx;
    AVPacket pkt;
    int stream_offset;

101
    int finished;
102
    enum PlaylistType type;
103
    int64_t target_duration;
104 105 106
    int start_seq_no;
    int n_segments;
    struct segment **segments;
107 108
    int needed, cur_needed;
    int cur_seq_no;
109
    int64_t cur_seg_offset;
110
    int64_t last_load_time;
111 112 113

    char key_url[MAX_URL_SIZE];
    uint8_t key[16];
114

115 116 117 118 119 120 121 122 123 124 125 126
    /* ID3 timestamp handling (elementary audio streams have ID3 timestamps
     * (and possibly other ID3 tags) in the beginning of each segment) */
    int is_id3_timestamped; /* -1: not yet known */
    int64_t id3_mpegts_timestamp; /* in mpegts tb */
    int64_t id3_offset; /* in stream original tb */
    uint8_t* id3_buf; /* temp buffer for id3 parsing */
    unsigned int id3_buf_size;
    AVDictionary *id3_initial; /* data from first id3 tag */
    int id3_found; /* ID3 tag found at some point */
    int id3_changed; /* ID3 tag data has changed at some point */
    ID3v2ExtraMeta *id3_deferred_extra; /* stored here until subdemuxer is opened */

127 128
    int64_t seek_timestamp;
    int seek_flags;
129
    int seek_stream_index; /* into subdemuxer stream array */
130

131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
    /* Renditions associated with this playlist, if any.
     * Alternative rendition playlists have a single rendition associated
     * with them, and variant main Media Playlists may have
     * multiple (playlist-less) renditions associated with them. */
    int n_renditions;
    struct rendition **renditions;
};

/*
 * Renditions are e.g. alternative subtitle or audio streams.
 * The rendition may either be an external playlist or it may be
 * contained in the main Media Playlist of the variant (in which case
 * playlist is NULL).
 */
struct rendition {
    enum AVMediaType type;
    struct playlist *playlist;
    char group_id[MAX_FIELD_LEN];
    char language[MAX_FIELD_LEN];
    char name[MAX_FIELD_LEN];
    int disposition;
152 153
};

154 155
struct variant {
    int bandwidth;
156 157

    /* every variant contains at least the main Media Playlist in index 0 */
158 159
    int n_playlists;
    struct playlist **playlists;
160 161 162 163

    char audio_group[MAX_FIELD_LEN];
    char video_group[MAX_FIELD_LEN];
    char subtitles_group[MAX_FIELD_LEN];
164 165
};

166
typedef struct HLSContext {
167 168
    int n_variants;
    struct variant **variants;
169 170
    int n_playlists;
    struct playlist **playlists;
171 172
    int n_renditions;
    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 180
    char *user_agent;                    ///< holds HTTP user agent set as an AVOption to the HTTP protocol context
    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 189 190 191
        buf[--len] = '\0';
    return len;
}

192
static void free_segment_list(struct playlist *pls)
193 194
{
    int i;
195 196 197
    for (i = 0; i < pls->n_segments; i++) {
        av_free(pls->segments[i]->key);
        av_free(pls->segments[i]->url);
198
        av_free(pls->segments[i]);
199
    }
200 201 202 203 204 205 206 207 208 209
    av_freep(&pls->segments);
    pls->n_segments = 0;
}

static void free_playlist_list(HLSContext *c)
{
    int i;
    for (i = 0; i < c->n_playlists; i++) {
        struct playlist *pls = c->playlists[i];
        free_segment_list(pls);
210
        av_freep(&pls->renditions);
211 212 213
        av_freep(&pls->id3_buf);
        av_dict_free(&pls->id3_initial);
        ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
214 215 216 217 218 219 220 221 222 223 224 225 226 227
        av_free_packet(&pls->pkt);
        av_free(pls->pb.buffer);
        if (pls->input)
            ffurl_close(pls->input);
        if (pls->ctx) {
            pls->ctx->pb = NULL;
            avformat_close_input(&pls->ctx);
        }
        av_free(pls);
    }
    av_freep(&c->playlists);
    av_freep(&c->cookies);
    av_freep(&c->user_agent);
    c->n_playlists = 0;
228 229
}

230
static void free_variant_list(HLSContext *c)
231 232 233 234
{
    int i;
    for (i = 0; i < c->n_variants; i++) {
        struct variant *var = c->variants[i];
235
        av_freep(&var->playlists);
236 237 238 239 240 241
        av_free(var);
    }
    av_freep(&c->variants);
    c->n_variants = 0;
}

242 243 244 245 246 247 248 249 250
static void free_rendition_list(HLSContext *c)
{
    int i;
    for (i = 0; i < c->n_renditions; i++)
        av_free(c->renditions[i]);
    av_freep(&c->renditions);
    c->n_renditions = 0;
}

251 252 253 254 255 256 257 258 259 260
/*
 * Used to reset a statically allocated AVPacket to a clean slate,
 * containing no data.
 */
static void reset_packet(AVPacket *pkt)
{
    av_init_packet(pkt);
    pkt->data = NULL;
}

261 262 263 264 265 266 267 268
static struct playlist *new_playlist(HLSContext *c, const char *url,
                                     const char *base)
{
    struct playlist *pls = av_mallocz(sizeof(struct playlist));
    if (!pls)
        return NULL;
    reset_packet(&pls->pkt);
    ff_make_absolute_url(pls->url, sizeof(pls->url), base, url);
269
    pls->seek_timestamp = AV_NOPTS_VALUE;
270 271 272 273

    pls->is_id3_timestamped = -1;
    pls->id3_mpegts_timestamp = AV_NOPTS_VALUE;

274 275 276 277
    dynarray_add(&c->playlists, &c->n_playlists, pls);
    return pls;
}

278 279 280 281 282 283 284 285 286
struct variant_info {
    char bandwidth[20];
    /* variant group ids: */
    char audio[MAX_FIELD_LEN];
    char video[MAX_FIELD_LEN];
    char subtitles[MAX_FIELD_LEN];
};

static struct variant *new_variant(HLSContext *c, struct variant_info *info,
287 288
                                   const char *url, const char *base)
{
289 290 291 292 293 294 295 296
    struct variant *var;
    struct playlist *pls;

    pls = new_playlist(c, url, base);
    if (!pls)
        return NULL;

    var = av_mallocz(sizeof(struct variant));
297 298
    if (!var)
        return NULL;
299

300 301 302 303 304 305 306
    if (info) {
        var->bandwidth = atoi(info->bandwidth);
        strcpy(var->audio_group, info->audio);
        strcpy(var->video_group, info->video);
        strcpy(var->subtitles_group, info->subtitles);
    }

307
    dynarray_add(&c->variants, &c->n_variants, var);
308
    dynarray_add(&var->playlists, &var->n_playlists, pls);
309 310 311 312 313 314
    return var;
}

static void handle_variant_args(struct variant_info *info, const char *key,
                                int key_len, char **dest, int *dest_len)
{
315
    if (!strncmp(key, "BANDWIDTH=", key_len)) {
316 317
        *dest     =        info->bandwidth;
        *dest_len = sizeof(info->bandwidth);
318 319 320 321 322 323 324 325 326
    } else if (!strncmp(key, "AUDIO=", key_len)) {
        *dest     =        info->audio;
        *dest_len = sizeof(info->audio);
    } else if (!strncmp(key, "VIDEO=", key_len)) {
        *dest     =        info->video;
        *dest_len = sizeof(info->video);
    } else if (!strncmp(key, "SUBTITLES=", key_len)) {
        *dest     =        info->subtitles;
        *dest_len = sizeof(info->subtitles);
327 328 329
    }
}

330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
struct key_info {
     char uri[MAX_URL_SIZE];
     char method[10];
     char iv[35];
};

static void handle_key_args(struct key_info *info, const char *key,
                            int key_len, char **dest, int *dest_len)
{
    if (!strncmp(key, "METHOD=", key_len)) {
        *dest     =        info->method;
        *dest_len = sizeof(info->method);
    } else if (!strncmp(key, "URI=", key_len)) {
        *dest     =        info->uri;
        *dest_len = sizeof(info->uri);
    } else if (!strncmp(key, "IV=", key_len)) {
        *dest     =        info->iv;
        *dest_len = sizeof(info->iv);
    }
}

351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
struct rendition_info {
    char type[16];
    char uri[MAX_URL_SIZE];
    char group_id[MAX_FIELD_LEN];
    char language[MAX_FIELD_LEN];
    char assoc_language[MAX_FIELD_LEN];
    char name[MAX_FIELD_LEN];
    char defaultr[4];
    char forced[4];
    char characteristics[MAX_CHARACTERISTICS_LEN];
};

static struct rendition *new_rendition(HLSContext *c, struct rendition_info *info,
                                      const char *url_base)
{
    struct rendition *rend;
    enum AVMediaType type = AVMEDIA_TYPE_UNKNOWN;
    char *characteristic;
    char *chr_ptr;
    char *saveptr;

    if (!strcmp(info->type, "AUDIO"))
        type = AVMEDIA_TYPE_AUDIO;
    else if (!strcmp(info->type, "VIDEO"))
        type = AVMEDIA_TYPE_VIDEO;
    else if (!strcmp(info->type, "SUBTITLES"))
        type = AVMEDIA_TYPE_SUBTITLE;
    else if (!strcmp(info->type, "CLOSED-CAPTIONS"))
        /* CLOSED-CAPTIONS is ignored since we do not support CEA-608 CC in
         * AVC SEI RBSP anyway */
        return NULL;

    if (type == AVMEDIA_TYPE_UNKNOWN)
        return NULL;

    /* URI is mandatory for subtitles as per spec */
    if (type == AVMEDIA_TYPE_SUBTITLE && !info->uri[0])
        return NULL;

    /* TODO: handle subtitles (each segment has to parsed separately) */
    if (type == AVMEDIA_TYPE_SUBTITLE)
        return NULL;

    rend = av_mallocz(sizeof(struct rendition));
    if (!rend)
        return NULL;

    dynarray_add(&c->renditions, &c->n_renditions, rend);

    rend->type = type;
    strcpy(rend->group_id, info->group_id);
    strcpy(rend->language, info->language);
    strcpy(rend->name, info->name);

    /* add the playlist if this is an external rendition */
    if (info->uri[0]) {
        rend->playlist = new_playlist(c, info->uri, url_base);
        if (rend->playlist)
            dynarray_add(&rend->playlist->renditions,
                         &rend->playlist->n_renditions, rend);
    }

    if (info->assoc_language[0]) {
        int langlen = strlen(rend->language);
        if (langlen < sizeof(rend->language) - 3) {
            rend->language[langlen] = ',';
            strncpy(rend->language + langlen + 1, info->assoc_language,
                    sizeof(rend->language) - langlen - 2);
        }
    }

    if (!strcmp(info->defaultr, "YES"))
        rend->disposition |= AV_DISPOSITION_DEFAULT;
    if (!strcmp(info->forced, "YES"))
        rend->disposition |= AV_DISPOSITION_FORCED;

    chr_ptr = info->characteristics;
    while ((characteristic = av_strtok(chr_ptr, ",", &saveptr))) {
        if (!strcmp(characteristic, "public.accessibility.describes-music-and-sound"))
            rend->disposition |= AV_DISPOSITION_HEARING_IMPAIRED;
        else if (!strcmp(characteristic, "public.accessibility.describes-video"))
            rend->disposition |= AV_DISPOSITION_VISUAL_IMPAIRED;

        chr_ptr = NULL;
    }

    return rend;
}

static void handle_rendition_args(struct rendition_info *info, const char *key,
                                  int key_len, char **dest, int *dest_len)
{
    if (!strncmp(key, "TYPE=", key_len)) {
        *dest     =        info->type;
        *dest_len = sizeof(info->type);
    } else if (!strncmp(key, "URI=", key_len)) {
        *dest     =        info->uri;
        *dest_len = sizeof(info->uri);
    } else if (!strncmp(key, "GROUP-ID=", key_len)) {
        *dest     =        info->group_id;
        *dest_len = sizeof(info->group_id);
    } else if (!strncmp(key, "LANGUAGE=", key_len)) {
        *dest     =        info->language;
        *dest_len = sizeof(info->language);
    } else if (!strncmp(key, "ASSOC-LANGUAGE=", key_len)) {
        *dest     =        info->assoc_language;
        *dest_len = sizeof(info->assoc_language);
    } else if (!strncmp(key, "NAME=", key_len)) {
        *dest     =        info->name;
        *dest_len = sizeof(info->name);
    } else if (!strncmp(key, "DEFAULT=", key_len)) {
        *dest     =        info->defaultr;
        *dest_len = sizeof(info->defaultr);
    } else if (!strncmp(key, "FORCED=", key_len)) {
        *dest     =        info->forced;
        *dest_len = sizeof(info->forced);
    } else if (!strncmp(key, "CHARACTERISTICS=", key_len)) {
        *dest     =        info->characteristics;
        *dest_len = sizeof(info->characteristics);
    }
    /*
     * ignored:
     * - AUTOSELECT: client may autoselect based on e.g. system language
     * - INSTREAM-ID: EIA-608 closed caption number ("CC1".."CC4")
     */
}

478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
/* used by parse_playlist to allocate a new variant+playlist when the
 * playlist is detected to be a Media Playlist (not Master Playlist)
 * and we have no parent Master Playlist (parsing of which would have
 * allocated the variant and playlist already) */
static int ensure_playlist(HLSContext *c, struct playlist **pls, const char *url)
{
    if (*pls)
        return 0;
    if (!new_variant(c, NULL, url, NULL))
        return AVERROR(ENOMEM);
    *pls = c->playlists[c->n_playlists - 1];
    return 0;
}

/* pls = NULL  => Master Playlist or parentless Media Playlist
 * pls = !NULL => parented Media Playlist, playlist+variant allocated */
494
static int parse_playlist(HLSContext *c, const char *url,
495
                          struct playlist *pls, AVIOContext *in)
496
{
497
    int ret = 0, is_segment = 0, is_variant = 0;
498
    int64_t duration = 0;
499 500 501
    enum KeyType key_type = KEY_NONE;
    uint8_t iv[16] = "";
    int has_iv = 0;
502
    char key[MAX_URL_SIZE] = "";
503
    char line[MAX_URL_SIZE];
504 505
    const char *ptr;
    int close_in = 0;
506 507
    int64_t seg_offset = 0;
    int64_t seg_size = -1;
508
    uint8_t *new_url = NULL;
509
    struct variant_info variant_info;
510
    char tmp_str[MAX_URL_SIZE];
511 512

    if (!in) {
513
        AVDictionary *opts = NULL;
514
        close_in = 1;
515
        /* Some HLS servers don't like being sent the range header */
516
        av_dict_set(&opts, "seekable", "0", 0);
517 518 519 520

        // broker prior HTTP options that should be consistent across requests
        av_dict_set(&opts, "user-agent", c->user_agent, 0);
        av_dict_set(&opts, "cookies", c->cookies, 0);
521
        av_dict_set(&opts, "headers", c->headers, 0);
522

523 524 525 526
        ret = avio_open2(&in, url, AVIO_FLAG_READ,
                         c->interrupt_callback, &opts);
        av_dict_free(&opts);
        if (ret < 0)
527 528 529
            return ret;
    }

530 531 532
    if (av_opt_get(in, "location", AV_OPT_SEARCH_CHILDREN, &new_url) >= 0)
        url = new_url;

533 534 535 536 537 538
    read_chomp_line(in, line, sizeof(line));
    if (strcmp(line, "#EXTM3U")) {
        ret = AVERROR_INVALIDDATA;
        goto fail;
    }

539 540 541
    if (pls) {
        free_segment_list(pls);
        pls->finished = 0;
542
        pls->type = PLS_TYPE_UNSPECIFIED;
543
    }
544 545 546 547
    while (!url_feof(in)) {
        read_chomp_line(in, line, sizeof(line));
        if (av_strstart(line, "#EXT-X-STREAM-INF:", &ptr)) {
            is_variant = 1;
548
            memset(&variant_info, 0, sizeof(variant_info));
549
            ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_variant_args,
550
                               &variant_info);
551 552 553 554 555 556 557 558 559 560 561 562 563
        } else if (av_strstart(line, "#EXT-X-KEY:", &ptr)) {
            struct key_info info = {{0}};
            ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_key_args,
                               &info);
            key_type = KEY_NONE;
            has_iv = 0;
            if (!strcmp(info.method, "AES-128"))
                key_type = KEY_AES_128;
            if (!strncmp(info.iv, "0x", 2) || !strncmp(info.iv, "0X", 2)) {
                ff_hex_to_data(iv, info.iv + 2);
                has_iv = 1;
            }
            av_strlcpy(key, info.uri, sizeof(key));
564 565 566 567 568
        } else if (av_strstart(line, "#EXT-X-MEDIA:", &ptr)) {
            struct rendition_info info = {{0}};
            ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_rendition_args,
                               &info);
            new_rendition(c, &info, url);
569
        } else if (av_strstart(line, "#EXT-X-TARGETDURATION:", &ptr)) {
570 571 572
            ret = ensure_playlist(c, &pls, url);
            if (ret < 0)
                goto fail;
573
            pls->target_duration = atoi(ptr) * AV_TIME_BASE;
574
        } else if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
575 576 577
            ret = ensure_playlist(c, &pls, url);
            if (ret < 0)
                goto fail;
578
            pls->start_seq_no = atoi(ptr);
579 580 581 582 583 584 585 586
        } else if (av_strstart(line, "#EXT-X-PLAYLIST-TYPE:", &ptr)) {
            ret = ensure_playlist(c, &pls, url);
            if (ret < 0)
                goto fail;
            if (!strcmp(ptr, "EVENT"))
                pls->type = PLS_TYPE_EVENT;
            else if (!strcmp(ptr, "VOD"))
                pls->type = PLS_TYPE_VOD;
587
        } else if (av_strstart(line, "#EXT-X-ENDLIST", &ptr)) {
588 589
            if (pls)
                pls->finished = 1;
590 591
        } else if (av_strstart(line, "#EXTINF:", &ptr)) {
            is_segment = 1;
592
            duration   = atof(ptr) * AV_TIME_BASE;
593 594 595 596 597
        } else if (av_strstart(line, "#EXT-X-BYTERANGE:", &ptr)) {
            seg_size = atoi(ptr);
            ptr = strchr(ptr, '@');
            if (ptr)
                seg_offset = atoi(ptr+1);
598 599 600 601
        } else if (av_strstart(line, "#", NULL)) {
            continue;
        } else if (line[0]) {
            if (is_variant) {
602
                if (!new_variant(c, &variant_info, line, url)) {
603 604 605 606 607 608 609
                    ret = AVERROR(ENOMEM);
                    goto fail;
                }
                is_variant = 0;
            }
            if (is_segment) {
                struct segment *seg;
610 611
                if (!pls) {
                    if (!new_variant(c, 0, url, NULL)) {
612 613 614
                        ret = AVERROR(ENOMEM);
                        goto fail;
                    }
615
                    pls = c->playlists[c->n_playlists - 1];
616 617 618 619 620 621 622
                }
                seg = av_malloc(sizeof(struct segment));
                if (!seg) {
                    ret = AVERROR(ENOMEM);
                    goto fail;
                }
                seg->duration = duration;
623 624 625 626
                seg->key_type = key_type;
                if (has_iv) {
                    memcpy(seg->iv, iv, sizeof(iv));
                } else {
627
                    int seq = pls->start_seq_no + pls->n_segments;
628 629 630
                    memset(seg->iv, 0, sizeof(seg->iv));
                    AV_WB32(seg->iv + 12, seq);
                }
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652

                if (key_type != KEY_NONE) {
                    ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, key);
                    seg->key = av_strdup(tmp_str);
                    if (!seg->key) {
                        av_free(seg);
                        ret = AVERROR(ENOMEM);
                        goto fail;
                    }
                } else {
                    seg->key = NULL;
                }

                ff_make_absolute_url(tmp_str, sizeof(tmp_str), url, line);
                seg->url = av_strdup(tmp_str);
                if (!seg->url) {
                    av_free(seg->key);
                    av_free(seg);
                    ret = AVERROR(ENOMEM);
                    goto fail;
                }

653
                dynarray_add(&pls->segments, &pls->n_segments, seg);
654
                is_segment = 0;
655 656 657 658 659 660 661 662 663 664

                seg->size = seg_size;
                if (seg_size >= 0) {
                    seg->url_offset = seg_offset;
                    seg_offset += seg_size;
                    seg_size = -1;
                } else {
                    seg->url_offset = 0;
                    seg_offset = 0;
                }
665 666 667
            }
        }
    }
668 669
    if (pls)
        pls->last_load_time = av_gettime();
670 671

fail:
672
    av_free(new_url);
673
    if (close_in)
674
        avio_close(in);
675 676 677
    return ret;
}

678 679 680 681 682
enum ReadFromURLMode {
    READ_NORMAL,
    READ_COMPLETE,
};

683
/* read from URLContext, limiting read to current segment */
684 685
static int read_from_url(struct playlist *pls, uint8_t *buf, int buf_size,
                         enum ReadFromURLMode mode)
686 687 688 689 690 691 692 693
{
    int ret;
    struct segment *seg = pls->segments[pls->cur_seq_no - pls->start_seq_no];

     /* limit read if the segment was only a part of a file */
    if (seg->size >= 0)
        buf_size = FFMIN(buf_size, seg->size - pls->cur_seg_offset);

694 695 696 697
    if (mode == READ_COMPLETE)
        ret = ffurl_read_complete(pls->input, buf, buf_size);
    else
        ret = ffurl_read(pls->input, buf, buf_size);
698 699 700 701 702 703 704

    if (ret > 0)
        pls->cur_seg_offset += ret;

    return ret;
}

705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
/* Parse the raw ID3 data and pass contents to caller */
static void parse_id3(AVFormatContext *s, AVIOContext *pb,
                      AVDictionary **metadata, int64_t *dts,
                      ID3v2ExtraMetaAPIC **apic, ID3v2ExtraMeta **extra_meta)
{
    static const char id3_priv_owner_ts[] = "com.apple.streaming.transportStreamTimestamp";
    ID3v2ExtraMeta *meta;

    ff_id3v2_read_dict(pb, metadata, ID3v2_DEFAULT_MAGIC, extra_meta);
    for (meta = *extra_meta; meta; meta = meta->next) {
        if (!strcmp(meta->tag, "PRIV")) {
            ID3v2ExtraMetaPRIV *priv = meta->data;
            if (priv->datasize == 8 && !strcmp(priv->owner, id3_priv_owner_ts)) {
                /* 33-bit MPEG timestamp */
                int64_t ts = AV_RB64(priv->data);
                av_log(s, AV_LOG_DEBUG, "HLS ID3 audio timestamp %"PRId64"\n", ts);
                if ((ts & ~((1ULL << 33) - 1)) == 0)
                    *dts = ts;
                else
                    av_log(s, AV_LOG_ERROR, "Invalid HLS ID3 audio timestamp %"PRId64"\n", ts);
            }
        } else if (!strcmp(meta->tag, "APIC") && apic)
            *apic = meta->data;
    }
}

/* Check if the ID3 metadata contents have changed */
static int id3_has_changed_values(struct playlist *pls, AVDictionary *metadata,
                                  ID3v2ExtraMetaAPIC *apic)
{
    AVDictionaryEntry *entry = NULL;
    AVDictionaryEntry *oldentry;
    /* check that no keys have changed values */
    while ((entry = av_dict_get(metadata, "", entry, AV_DICT_IGNORE_SUFFIX))) {
        oldentry = av_dict_get(pls->id3_initial, entry->key, NULL, AV_DICT_MATCH_CASE);
        if (!oldentry || strcmp(oldentry->value, entry->value) != 0)
            return 1;
    }

    /* check if apic appeared */
    if (apic && (pls->ctx->nb_streams != 2 || !pls->ctx->streams[1]->attached_pic.data))
        return 1;

    if (apic) {
        int size = pls->ctx->streams[1]->attached_pic.size;
        if (size != apic->buf->size - FF_INPUT_BUFFER_PADDING_SIZE)
            return 1;

        if (memcmp(apic->buf->data, pls->ctx->streams[1]->attached_pic.data, size) != 0)
            return 1;
    }

    return 0;
}

/* Parse ID3 data and handle the found data */
static void handle_id3(AVIOContext *pb, struct playlist *pls)
{
    AVDictionary *metadata = NULL;
    ID3v2ExtraMetaAPIC *apic = NULL;
    ID3v2ExtraMeta *extra_meta = NULL;
    int64_t timestamp = AV_NOPTS_VALUE;

    parse_id3(pls->ctx, pb, &metadata, &timestamp, &apic, &extra_meta);

    if (timestamp != AV_NOPTS_VALUE) {
        pls->id3_mpegts_timestamp = timestamp;
        pls->id3_offset = 0;
    }

    if (!pls->id3_found) {
        /* initial ID3 tags */
        av_assert0(!pls->id3_deferred_extra);
        pls->id3_found = 1;

        /* get picture attachment and set text metadata */
        if (pls->ctx->nb_streams)
            ff_id3v2_parse_apic(pls->ctx, &extra_meta);
        else
            /* demuxer not yet opened, defer picture attachment */
            pls->id3_deferred_extra = extra_meta;

        av_dict_copy(&pls->ctx->metadata, metadata, 0);
        pls->id3_initial = metadata;

    } else {
        if (!pls->id3_changed && id3_has_changed_values(pls, metadata, apic)) {
            avpriv_report_missing_feature(pls->ctx, "Changing ID3 metadata in HLS audio elementary stream");
            pls->id3_changed = 1;
        }
        av_dict_free(&metadata);
    }

    if (!pls->id3_deferred_extra)
        ff_id3v2_free_extra_meta(&extra_meta);
}

/* Intercept and handle ID3 tags between URLContext and AVIOContext */
static void intercept_id3(struct playlist *pls, uint8_t *buf,
                         int buf_size, int *len)
{
    /* intercept id3 tags, we do not want to pass them to the raw
     * demuxer on all segment switches */
    int bytes;
    int id3_buf_pos = 0;
    int fill_buf = 0;

    /* gather all the id3 tags */
    while (1) {
        /* see if we can retrieve enough data for ID3 header */
        if (*len < ID3v2_HEADER_SIZE && buf_size >= ID3v2_HEADER_SIZE) {
            bytes = read_from_url(pls, buf + *len, ID3v2_HEADER_SIZE - *len, READ_COMPLETE);
            if (bytes > 0) {

                if (bytes == ID3v2_HEADER_SIZE - *len)
                    /* no EOF yet, so fill the caller buffer again after
                     * we have stripped the ID3 tags */
                    fill_buf = 1;

                *len += bytes;

            } else if (*len <= 0) {
                /* error/EOF */
                *len = bytes;
                fill_buf = 0;
            }
        }

        if (*len < ID3v2_HEADER_SIZE)
            break;

        if (ff_id3v2_match(buf, ID3v2_DEFAULT_MAGIC)) {
            struct segment *seg = pls->segments[pls->cur_seq_no - pls->start_seq_no];
838
            int64_t maxsize = seg->size >= 0 ? seg->size : 1024*1024;
839 840 841 842
            int taglen = ff_id3v2_tag_len(buf);
            int tag_got_bytes = FFMIN(taglen, *len);
            int remaining = taglen - tag_got_bytes;

843 844 845
            if (taglen > maxsize) {
                av_log(pls->ctx, AV_LOG_ERROR, "Too large HLS ID3 tag (%d > %"PRId64" bytes)\n",
                       taglen, maxsize);
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
                break;
            }

            /*
             * Copy the id3 tag to our temporary id3 buffer.
             * We could read a small id3 tag directly without memcpy, but
             * we would still need to copy the large tags, and handling
             * both of those cases together with the possibility for multiple
             * tags would make the handling a bit complex.
             */
            pls->id3_buf = av_fast_realloc(pls->id3_buf, &pls->id3_buf_size, id3_buf_pos + taglen);
            if (!pls->id3_buf)
                break;
            memcpy(pls->id3_buf + id3_buf_pos, buf, tag_got_bytes);
            id3_buf_pos += tag_got_bytes;

            /* strip the intercepted bytes */
            *len -= tag_got_bytes;
            memmove(buf, buf + tag_got_bytes, *len);
            av_log(pls->ctx, AV_LOG_DEBUG, "Stripped %d HLS ID3 bytes\n", tag_got_bytes);

            if (remaining > 0) {
                /* read the rest of the tag in */
                if (read_from_url(pls, pls->id3_buf + id3_buf_pos, remaining, READ_COMPLETE) != remaining)
                    break;
                id3_buf_pos += remaining;
                av_log(pls->ctx, AV_LOG_DEBUG, "Stripped additional %d HLS ID3 bytes\n", remaining);
            }

        } else {
            /* no more ID3 tags */
            break;
        }
    }

    /* re-fill buffer for the caller unless EOF */
    if (*len >= 0 && (fill_buf || *len == 0)) {
        bytes = read_from_url(pls, buf + *len, buf_size - *len, READ_NORMAL);

        /* ignore error if we already had some data */
        if (bytes >= 0)
            *len += bytes;
        else if (*len == 0)
            *len = bytes;
    }

    if (pls->id3_buf) {
        /* Now parse all the ID3 tags */
        AVIOContext id3ioctx;
        ffio_init_context(&id3ioctx, pls->id3_buf, id3_buf_pos, 0, NULL, NULL, NULL, NULL);
        handle_id3(&id3ioctx, pls);
    }

    if (pls->is_id3_timestamped == -1)
        pls->is_id3_timestamped = (pls->id3_mpegts_timestamp != AV_NOPTS_VALUE);
}

903
static int open_input(HLSContext *c, struct playlist *pls)
904
{
905
    AVDictionary *opts = NULL;
906
    AVDictionary *opts2 = NULL;
907
    int ret;
908
    struct segment *seg = pls->segments[pls->cur_seq_no - pls->start_seq_no];
909 910 911 912

    // broker prior HTTP options that should be consistent across requests
    av_dict_set(&opts, "user-agent", c->user_agent, 0);
    av_dict_set(&opts, "cookies", c->cookies, 0);
913
    av_dict_set(&opts, "headers", c->headers, 0);
914
    av_dict_set(&opts, "seekable", "0", 0);
915

916 917 918
    // Same opts for key request (ffurl_open mutilates the opts so it cannot be used twice)
    av_dict_copy(&opts2, opts, 0);

919 920 921 922 923 924 925 926 927 928 929 930 931
    if (seg->size >= 0) {
        /* try to restrict the HTTP request to the part we want
         * (if this is in fact a HTTP request) */
        char offset[24] = { 0 };
        char end_offset[24] = { 0 };
        snprintf(offset, sizeof(offset) - 1, "%"PRId64,
                 seg->url_offset);
        snprintf(end_offset, sizeof(end_offset) - 1, "%"PRId64,
                 seg->url_offset + seg->size);
        av_dict_set(&opts, "offset", offset, 0);
        av_dict_set(&opts, "end_offset", end_offset, 0);
    }

932 933 934
    av_log(pls->parent, AV_LOG_VERBOSE, "HLS request for url '%s', offset %"PRId64", playlist %d\n",
           seg->url, seg->url_offset, pls->index);

935
    if (seg->key_type == KEY_NONE) {
936 937
        ret = ffurl_open(&pls->input, seg->url, AVIO_FLAG_READ,
                          &pls->parent->interrupt_callback, &opts);
938

939 940
    } else if (seg->key_type == KEY_AES_128) {
        char iv[33], key[33], url[MAX_URL_SIZE];
941
        if (strcmp(seg->key, pls->key_url)) {
942
            URLContext *uc;
943
            if (ffurl_open(&uc, seg->key, AVIO_FLAG_READ,
944
                           &pls->parent->interrupt_callback, &opts2) == 0) {
945 946
                if (ffurl_read_complete(uc, pls->key, sizeof(pls->key))
                    != sizeof(pls->key)) {
947 948 949 950 951 952 953 954
                    av_log(NULL, AV_LOG_ERROR, "Unable to read key file %s\n",
                           seg->key);
                }
                ffurl_close(uc);
            } else {
                av_log(NULL, AV_LOG_ERROR, "Unable to open key file %s\n",
                       seg->key);
            }
955
            av_strlcpy(pls->key_url, seg->key, sizeof(pls->key_url));
956 957
        }
        ff_data_to_hex(iv, seg->iv, sizeof(seg->iv), 0);
958
        ff_data_to_hex(key, pls->key, sizeof(pls->key), 0);
959 960 961 962 963
        iv[32] = key[32] = '\0';
        if (strstr(seg->url, "://"))
            snprintf(url, sizeof(url), "crypto+%s", seg->url);
        else
            snprintf(url, sizeof(url), "crypto:%s", seg->url);
964 965
        if ((ret = ffurl_alloc(&pls->input, url, AVIO_FLAG_READ,
                               &pls->parent->interrupt_callback)) < 0)
966
            goto cleanup;
967 968
        av_opt_set(pls->input->priv_data, "key", key, 0);
        av_opt_set(pls->input->priv_data, "iv", iv, 0);
969

970 971 972
        if ((ret = ffurl_connect(pls->input, &opts)) < 0) {
            ffurl_close(pls->input);
            pls->input = NULL;
973
            goto cleanup;
974
        }
975
        ret = 0;
976
    }
977 978 979
    else
      ret = AVERROR(ENOSYS);

980 981 982
    /* Seek to the requested position. If this was a HTTP request, the offset
     * should already be where want it to, but this allows e.g. local testing
     * without a HTTP server. */
983
    if (ret == 0 && seg->key_type == KEY_NONE) {
984 985 986 987 988 989 990 991 992
        int seekret = ffurl_seek(pls->input, seg->url_offset, SEEK_SET);
        if (seekret < 0) {
            av_log(pls->parent, AV_LOG_ERROR, "Unable to seek to offset %"PRId64" of HLS segment '%s'\n", seg->url_offset, seg->url);
            ret = seekret;
            ffurl_close(pls->input);
            pls->input = NULL;
        }
    }

993 994
cleanup:
    av_dict_free(&opts);
995
    av_dict_free(&opts2);
996
    pls->cur_seg_offset = 0;
997
    return ret;
998 999
}

1000 1001 1002 1003 1004 1005 1006
static int64_t default_reload_interval(struct playlist *pls)
{
    return pls->n_segments > 0 ?
                          pls->segments[pls->n_segments - 1]->duration :
                          pls->target_duration;
}

1007 1008
static int read_data(void *opaque, uint8_t *buf, int buf_size)
{
1009
    struct playlist *v = opaque;
1010
    HLSContext *c = v->parent->priv_data;
1011
    int ret, i;
1012
    int just_opened = 0;
1013

1014
restart:
1015 1016 1017
    if (!v->needed)
        return AVERROR_EOF;

1018
    if (!v->input) {
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
        int64_t reload_interval;

        /* Check that the playlist is still needed before opening a new
         * segment. */
        if (v->ctx && v->ctx->nb_streams &&
            v->parent->nb_streams >= v->stream_offset + v->ctx->nb_streams) {
            v->needed = 0;
            for (i = v->stream_offset; i < v->stream_offset + v->ctx->nb_streams;
                i++) {
                if (v->parent->streams[i]->discard < AVDISCARD_ALL)
                    v->needed = 1;
            }
        }
        if (!v->needed) {
            av_log(v->parent, AV_LOG_INFO, "No longer receiving playlist %d\n",
                v->index);
            return AVERROR_EOF;
        }

1038
        /* If this is a live stream and the reload interval has elapsed since
1039
         * the last playlist reload, reload the playlists now. */
1040
        reload_interval = default_reload_interval(v);
1041

1042
reload:
1043
        if (!v->finished &&
1044
            av_gettime() - v->last_load_time >= reload_interval) {
1045 1046 1047
            if ((ret = parse_playlist(c, v->url, v, NULL)) < 0) {
                av_log(v->parent, AV_LOG_WARNING, "Failed to reload playlist %d\n",
                       v->index);
1048
                return ret;
1049
            }
1050 1051 1052
            /* If we need to reload the playlist again below (if
             * there's still no more segments), switch to a reload
             * interval of half the target duration. */
1053
            reload_interval = v->target_duration / 2;
1054
        }
1055 1056 1057 1058 1059 1060 1061 1062 1063
        if (v->cur_seq_no < v->start_seq_no) {
            av_log(NULL, AV_LOG_WARNING,
                   "skipping %d segments ahead, expired from playlists\n",
                   v->start_seq_no - v->cur_seq_no);
            v->cur_seq_no = v->start_seq_no;
        }
        if (v->cur_seq_no >= v->start_seq_no + v->n_segments) {
            if (v->finished)
                return AVERROR_EOF;
1064
            while (av_gettime() - v->last_load_time < reload_interval) {
1065
                if (ff_check_interrupt(c->interrupt_callback))
1066
                    return AVERROR_EXIT;
1067
                av_usleep(100*1000);
1068 1069 1070 1071 1072
            }
            /* Enough time has elapsed since the last reload */
            goto reload;
        }

1073
        ret = open_input(c, v);
1074 1075 1076
        if (ret < 0) {
            av_log(v->parent, AV_LOG_WARNING, "Failed to open segment of playlist %d\n",
                   v->index);
1077
            return ret;
1078
        }
1079
        just_opened = 1;
1080
    }
1081

1082
    ret = read_from_url(v, buf, buf_size, READ_NORMAL);
1083
    if (ret > 0) {
1084 1085 1086 1087 1088 1089
        if (just_opened && v->is_id3_timestamped != 0) {
            /* Intercept ID3 tags here, elementary audio streams are required
             * to convey timestamps using them in the beginning of each segment. */
            intercept_id3(v, buf, buf_size, &ret);
        }

1090
        return ret;
1091
    }
1092
    ffurl_close(v->input);
1093 1094 1095 1096 1097 1098 1099 1100
    v->input = NULL;
    v->cur_seq_no++;

    c->cur_seq_no = v->cur_seq_no;

    goto restart;
}

1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
static int playlist_in_multiple_variants(HLSContext *c, struct playlist *pls)
{
    int variant_count = 0;
    int i, j;

    for (i = 0; i < c->n_variants && variant_count < 2; i++) {
        struct variant *v = c->variants[i];

        for (j = 0; j < v->n_playlists; j++) {
            if (v->playlists[j] == pls) {
                variant_count++;
                break;
            }
        }
    }

    return variant_count >= 2;
}

1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
static void add_renditions_to_variant(HLSContext *c, struct variant *var,
                                      enum AVMediaType type, const char *group_id)
{
    int i;

    for (i = 0; i < c->n_renditions; i++) {
        struct rendition *rend = c->renditions[i];

        if (rend->type == type && !strcmp(rend->group_id, group_id)) {

            if (rend->playlist)
                /* rendition is an external playlist
                 * => add the playlist to the variant */
                dynarray_add(&var->playlists, &var->n_playlists, rend->playlist);
            else
                /* rendition is part of the variant main Media Playlist
                 * => add the rendition to the main Media Playlist */
                dynarray_add(&var->playlists[0]->renditions,
                             &var->playlists[0]->n_renditions,
                             rend);
        }
    }
}

static void add_metadata_from_renditions(AVFormatContext *s, struct playlist *pls,
                                         enum AVMediaType type)
{
    int rend_idx = 0;
    int i;

    for (i = 0; i < pls->ctx->nb_streams; i++) {
        AVStream *st = s->streams[pls->stream_offset + i];

        if (st->codec->codec_type != type)
            continue;

        for (; rend_idx < pls->n_renditions; rend_idx++) {
            struct rendition *rend = pls->renditions[rend_idx];

            if (rend->type != type)
                continue;

            if (rend->language[0])
                av_dict_set(&st->metadata, "language", rend->language, 0);
            if (rend->name[0])
                av_dict_set(&st->metadata, "comment", rend->name, 0);

            st->disposition |= rend->disposition;
        }
        if (rend_idx >=pls->n_renditions)
            break;
    }
}

1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
/* if timestamp was in valid range: returns 1 and sets seq_no
 * if not: returns 0 and sets seq_no to closest segment */
static int find_timestamp_in_playlist(HLSContext *c, struct playlist *pls,
                                      int64_t timestamp, int *seq_no)
{
    int i;
    int64_t pos = c->first_timestamp == AV_NOPTS_VALUE ?
                  0 : c->first_timestamp;

    if (timestamp < pos) {
        *seq_no = pls->start_seq_no;
        return 0;
    }

    for (i = 0; i < pls->n_segments; i++) {
        int64_t diff = pos + pls->segments[i]->duration - timestamp;
        if (diff > 0) {
            *seq_no = pls->start_seq_no + i;
            return 1;
        }
        pos += pls->segments[i]->duration;
    }

    *seq_no = pls->start_seq_no + pls->n_segments - 1;

    return 0;
}

1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
static int select_cur_seq_no(HLSContext *c, struct playlist *pls)
{
    int seq_no;

    if (!pls->finished && !c->first_packet &&
        av_gettime() - pls->last_load_time >= default_reload_interval(pls))
        /* reload the playlist since it was suspended */
        parse_playlist(c, pls->url, pls, NULL);

    /* If playback is already in progress (we are just selecting a new
     * playlist) and this is a complete file, find the matching segment
     * by counting durations. */
    if (pls->finished && c->cur_timestamp != AV_NOPTS_VALUE) {
        find_timestamp_in_playlist(c, pls, c->cur_timestamp, &seq_no);
        return seq_no;
    }

    if (!pls->finished) {
        if (!c->first_packet && /* we are doing a segment selection during playback */
            c->cur_seq_no >= pls->start_seq_no &&
            c->cur_seq_no < pls->start_seq_no + pls->n_segments)
            /* While spec 3.4.3 says that we cannot assume anything about the
             * content at the same sequence number on different playlists,
             * in practice this seems to work and doing it otherwise would
             * require us to download a segment to inspect its timestamps. */
            return c->cur_seq_no;

        /* If this is a live stream with more than 3 segments, start at the
         * third last segment. */
        if (pls->n_segments > 3)
            return pls->start_seq_no + pls->n_segments - 3;
    }

    /* Otherwise just start on the first segment. */
    return pls->start_seq_no;
}

1239
static int hls_read_header(AVFormatContext *s)
1240
{
1241
    URLContext *u = (s->flags & AVFMT_FLAG_CUSTOM_IO) ? NULL : s->pb->opaque;
1242
    HLSContext *c = s->priv_data;
1243 1244
    int ret = 0, i, j, stream_offset = 0;

1245 1246
    c->interrupt_callback = &s->interrupt_callback;

1247 1248 1249 1250
    c->first_packet = 1;
    c->first_timestamp = AV_NOPTS_VALUE;
    c->cur_timestamp = AV_NOPTS_VALUE;

1251
    // if the URL context is good, read important options we must broker later
1252
    if (u && u->prot->priv_data_class) {
1253
        // get the previous user agent & set back to null if string size is zero
1254
        av_freep(&c->user_agent);
1255
        av_opt_get(u->priv_data, "user-agent", 0, (uint8_t**)&(c->user_agent));
1256
        if (c->user_agent && !strlen(c->user_agent))
1257 1258 1259
            av_freep(&c->user_agent);

        // get the previous cookies & set back to null if string size is zero
1260
        av_freep(&c->cookies);
1261
        av_opt_get(u->priv_data, "cookies", 0, (uint8_t**)&(c->cookies));
1262
        if (c->cookies && !strlen(c->cookies))
1263
            av_freep(&c->cookies);
1264 1265 1266 1267 1268 1269

        // get the previous headers & set back to null if string size is zero
        av_freep(&c->headers);
        av_opt_get(u->priv_data, "headers", 0, (uint8_t**)&(c->headers));
        if (c->headers && !strlen(c->headers))
            av_freep(&c->headers);
1270 1271
    }

1272 1273 1274 1275 1276 1277 1278 1279
    if ((ret = parse_playlist(c, s->filename, NULL, s->pb)) < 0)
        goto fail;

    if (c->n_variants == 0) {
        av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
        ret = AVERROR_EOF;
        goto fail;
    }
1280 1281 1282 1283 1284 1285
    /* If the playlist only contained playlists (Master Playlist),
     * parse each individual playlist. */
    if (c->n_playlists > 1 || c->playlists[0]->n_segments == 0) {
        for (i = 0; i < c->n_playlists; i++) {
            struct playlist *pls = c->playlists[i];
            if ((ret = parse_playlist(c, pls->url, pls, NULL)) < 0)
1286 1287 1288 1289
                goto fail;
        }
    }

1290
    if (c->variants[0]->playlists[0]->n_segments == 0) {
1291 1292 1293 1294 1295 1296 1297
        av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
        ret = AVERROR_EOF;
        goto fail;
    }

    /* If this isn't a live stream, calculate the total duration of the
     * stream. */
1298
    if (c->variants[0]->playlists[0]->finished) {
1299
        int64_t duration = 0;
1300 1301
        for (i = 0; i < c->variants[0]->playlists[0]->n_segments; i++)
            duration += c->variants[0]->playlists[0]->segments[i]->duration;
1302
        s->duration = duration;
1303 1304
    }

1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
    /* Associate renditions with variants */
    for (i = 0; i < c->n_variants; i++) {
        struct variant *var = c->variants[i];

        if (var->audio_group[0])
            add_renditions_to_variant(c, var, AVMEDIA_TYPE_AUDIO, var->audio_group);
        if (var->video_group[0])
            add_renditions_to_variant(c, var, AVMEDIA_TYPE_VIDEO, var->video_group);
        if (var->subtitles_group[0])
            add_renditions_to_variant(c, var, AVMEDIA_TYPE_SUBTITLE, var->subtitles_group);
    }

1317 1318 1319
    /* Open the demuxer for each playlist */
    for (i = 0; i < c->n_playlists; i++) {
        struct playlist *pls = c->playlists[i];
1320
        AVInputFormat *in_fmt = NULL;
1321

1322
        if (pls->n_segments == 0)
1323
            continue;
1324

1325
        if (!(pls->ctx = avformat_alloc_context())) {
1326 1327 1328 1329
            ret = AVERROR(ENOMEM);
            goto fail;
        }

1330 1331 1332
        pls->index  = i;
        pls->needed = 1;
        pls->parent = s;
1333
        pls->cur_seq_no = select_cur_seq_no(c, pls);
1334

1335 1336
        pls->read_buffer = av_malloc(INITIAL_BUFFER_SIZE);
        ffio_init_context(&pls->pb, pls->read_buffer, INITIAL_BUFFER_SIZE, 0, pls,
1337
                          read_data, NULL, NULL);
1338 1339
        pls->pb.seekable = 0;
        ret = av_probe_input_buffer(&pls->pb, &in_fmt, pls->segments[0]->url,
1340
                                    NULL, 0, 0);
1341 1342 1343 1344 1345
        if (ret < 0) {
            /* Free the ctx - it isn't initialized properly at this point,
             * so avformat_close_input shouldn't be called. If
             * avformat_open_input fails below, it frees and zeros the
             * context, so it doesn't need any special treatment like this. */
1346 1347 1348
            av_log(s, AV_LOG_ERROR, "Error when loading first segment '%s'\n", pls->segments[0]->url);
            avformat_free_context(pls->ctx);
            pls->ctx = NULL;
1349
            goto fail;
1350
        }
1351 1352 1353
        pls->ctx->pb       = &pls->pb;
        pls->stream_offset = stream_offset;
        ret = avformat_open_input(&pls->ctx, pls->segments[0]->url, in_fmt, NULL);
1354 1355
        if (ret < 0)
            goto fail;
1356

1357 1358 1359 1360 1361 1362 1363
        if (pls->id3_deferred_extra && pls->ctx->nb_streams == 1) {
            ff_id3v2_parse_apic(pls->ctx, &pls->id3_deferred_extra);
            avformat_queue_attached_pictures(pls->ctx);
            ff_id3v2_free_extra_meta(&pls->id3_deferred_extra);
            pls->id3_deferred_extra = NULL;
        }

1364 1365
        pls->ctx->ctx_flags &= ~AVFMTCTX_NOHEADER;
        ret = avformat_find_stream_info(pls->ctx, NULL);
1366 1367
        if (ret < 0)
            goto fail;
1368

1369 1370 1371
        if (pls->is_id3_timestamped == -1)
            av_log(s, AV_LOG_WARNING, "No expected HTTP requests have been made\n");

1372 1373
        /* Create new AVStreams for each stream in this playlist */
        for (j = 0; j < pls->ctx->nb_streams; j++) {
1374
            AVStream *st = avformat_new_stream(s, NULL);
1375
            AVStream *ist = pls->ctx->streams[j];
1376 1377 1378 1379
            if (!st) {
                ret = AVERROR(ENOMEM);
                goto fail;
            }
1380
            st->id = i;
1381

1382
            avcodec_copy_context(st->codec, pls->ctx->streams[j]->codec);
1383 1384 1385 1386 1387

            if (pls->is_id3_timestamped) /* custom timestamps via id3 */
                avpriv_set_pts_info(st, 33, 1, MPEG_TIME_BASE);
            else
                avpriv_set_pts_info(st, ist->pts_wrap_bits, ist->time_base.num, ist->time_base.den);
1388 1389
        }

1390 1391 1392 1393
        add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_AUDIO);
        add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_VIDEO);
        add_metadata_from_renditions(s, pls, AVMEDIA_TYPE_SUBTITLE);

1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
        stream_offset += pls->ctx->nb_streams;
    }

    /* Create a program for each variant */
    for (i = 0; i < c->n_variants; i++) {
        struct variant *v = c->variants[i];
        char bitrate_str[20];
        AVProgram *program;

        snprintf(bitrate_str, sizeof(bitrate_str), "%d", v->bandwidth);

        program = av_new_program(s, i);
        if (!program)
            goto fail;
        av_dict_set(&program->metadata, "variant_bitrate", bitrate_str, 0);

        for (j = 0; j < v->n_playlists; j++) {
            struct playlist *pls = v->playlists[j];
            int is_shared = playlist_in_multiple_variants(c, pls);
            int k;

            for (k = 0; k < pls->ctx->nb_streams; k++) {
                struct AVStream *st = s->streams[pls->stream_offset + k];

                ff_program_add_stream_index(s, i, pls->stream_offset + k);

                /* Set variant_bitrate for streams unique to this variant */
                if (!is_shared && v->bandwidth)
                    av_dict_set(&st->metadata, "variant_bitrate", bitrate_str, 0);
            }
1424 1425 1426 1427 1428
        }
    }

    return 0;
fail:
1429
    free_playlist_list(c);
1430
    free_variant_list(c);
1431
    free_rendition_list(c);
1432 1433 1434
    return ret;
}

1435
static int recheck_discard_flags(AVFormatContext *s, int first)
1436
{
1437
    HLSContext *c = s->priv_data;
1438
    int i, changed = 0;
1439

1440
    /* Check if any new streams are needed */
1441 1442
    for (i = 0; i < c->n_playlists; i++)
        c->playlists[i]->cur_needed = 0;
1443 1444 1445

    for (i = 0; i < s->nb_streams; i++) {
        AVStream *st = s->streams[i];
1446
        struct playlist *pls = c->playlists[s->streams[i]->id];
1447
        if (st->discard < AVDISCARD_ALL)
1448
            pls->cur_needed = 1;
1449
    }
1450 1451 1452 1453
    for (i = 0; i < c->n_playlists; i++) {
        struct playlist *pls = c->playlists[i];
        if (pls->cur_needed && !pls->needed) {
            pls->needed = 1;
1454
            changed = 1;
1455
            pls->cur_seq_no = select_cur_seq_no(c, pls);
1456
            pls->pb.eof_reached = 0;
1457 1458 1459 1460
            if (c->cur_timestamp != AV_NOPTS_VALUE) {
                /* catch up */
                pls->seek_timestamp = c->cur_timestamp;
                pls->seek_flags = AVSEEK_FLAG_ANY;
1461
                pls->seek_stream_index = -1;
1462 1463
            }
            av_log(s, AV_LOG_INFO, "Now receiving playlist %d, segment %d\n", i, pls->cur_seq_no);
1464 1465 1466 1467 1468
        } else if (first && !pls->cur_needed && pls->needed) {
            if (pls->input)
                ffurl_close(pls->input);
            pls->input = NULL;
            pls->needed = 0;
1469
            changed = 1;
1470
            av_log(s, AV_LOG_INFO, "No longer receiving playlist %d\n", i);
1471 1472
        }
    }
1473
    return changed;
1474 1475
}

1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508
static void fill_timing_for_id3_timestamped_stream(struct playlist *pls)
{
    if (pls->id3_offset >= 0) {
        pls->pkt.dts = pls->id3_mpegts_timestamp +
                                 av_rescale_q(pls->id3_offset,
                                              pls->ctx->streams[pls->pkt.stream_index]->time_base,
                                              MPEG_TIME_BASE_Q);
        if (pls->pkt.duration)
            pls->id3_offset += pls->pkt.duration;
        else
            pls->id3_offset = -1;
    } else {
        /* there have been packets with unknown duration
         * since the last id3 tag, should not normally happen */
        pls->pkt.dts = AV_NOPTS_VALUE;
    }

    if (pls->pkt.duration)
        pls->pkt.duration = av_rescale_q(pls->pkt.duration,
                                         pls->ctx->streams[pls->pkt.stream_index]->time_base,
                                         MPEG_TIME_BASE_Q);

    pls->pkt.pts = AV_NOPTS_VALUE;
}

static AVRational get_timebase(struct playlist *pls)
{
    if (pls->is_id3_timestamped)
        return MPEG_TIME_BASE_Q;

    return pls->ctx->streams[pls->pkt.stream_index]->time_base;
}

1509 1510 1511 1512 1513 1514 1515 1516 1517
static int compare_ts_with_wrapdetect(int64_t ts_a, struct playlist *pls_a,
                                      int64_t ts_b, struct playlist *pls_b)
{
    int64_t scaled_ts_a = av_rescale_q(ts_a, get_timebase(pls_a), MPEG_TIME_BASE_Q);
    int64_t scaled_ts_b = av_rescale_q(ts_b, get_timebase(pls_b), MPEG_TIME_BASE_Q);

    return av_compare_mod(scaled_ts_a, scaled_ts_b, 1LL << 33);
}

1518
static int hls_read_packet(AVFormatContext *s, AVPacket *pkt)
1519
{
1520
    HLSContext *c = s->priv_data;
1521
    int ret, i, minplaylist = -1;
1522

1523
    recheck_discard_flags(s, c->first_packet);
1524

1525 1526 1527
    for (i = 0; i < c->n_playlists; i++) {
        struct playlist *pls = c->playlists[i];
        /* Make sure we've got one buffered packet from each open playlist
1528
         * stream */
1529
        if (pls->needed && !pls->pkt.data) {
1530 1531
            while (1) {
                int64_t ts_diff;
1532
                AVRational tb;
1533
                ret = av_read_frame(pls->ctx, &pls->pkt);
1534
                if (ret < 0) {
1535
                    if (!url_feof(&pls->pb) && ret != AVERROR_EOF)
1536
                        return ret;
1537
                    reset_packet(&pls->pkt);
1538
                    break;
1539
                } else {
1540 1541 1542 1543 1544 1545
                    /* stream_index check prevents matching picture attachments etc. */
                    if (pls->is_id3_timestamped && pls->pkt.stream_index == 0) {
                        /* audio elementary streams are id3 timestamped */
                        fill_timing_for_id3_timestamped_stream(pls);
                    }

1546
                    if (c->first_timestamp == AV_NOPTS_VALUE &&
1547 1548
                        pls->pkt.dts       != AV_NOPTS_VALUE)
                        c->first_timestamp = av_rescale_q(pls->pkt.dts,
1549
                            get_timebase(pls), AV_TIME_BASE_Q);
1550 1551
                }

1552
                if (pls->seek_timestamp == AV_NOPTS_VALUE)
1553 1554
                    break;

1555 1556
                if (pls->seek_stream_index < 0 ||
                    pls->seek_stream_index == pls->pkt.stream_index) {
1557

1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
                    if (pls->pkt.dts == AV_NOPTS_VALUE) {
                        pls->seek_timestamp = AV_NOPTS_VALUE;
                        break;
                    }

                    tb = get_timebase(pls);
                    ts_diff = av_rescale_rnd(pls->pkt.dts, AV_TIME_BASE,
                                            tb.den, AV_ROUND_DOWN) -
                            pls->seek_timestamp;
                    if (ts_diff >= 0 && (pls->seek_flags  & AVSEEK_FLAG_ANY ||
                                        pls->pkt.flags & AV_PKT_FLAG_KEY)) {
                        pls->seek_timestamp = AV_NOPTS_VALUE;
                        break;
                    }
1572
                }
1573 1574
                av_free_packet(&pls->pkt);
                reset_packet(&pls->pkt);
1575 1576
            }
        }
1577
        /* Check if this stream has the packet with the lowest dts */
1578 1579 1580
        if (pls->pkt.data) {
            struct playlist *minpls = minplaylist < 0 ?
                                     NULL : c->playlists[minplaylist];
1581
            if (minplaylist < 0) {
1582
                minplaylist = i;
1583
            } else {
1584 1585
                int64_t dts     =    pls->pkt.dts;
                int64_t mindts  = minpls->pkt.dts;
1586

1587 1588
                if (dts == AV_NOPTS_VALUE ||
                    (mindts != AV_NOPTS_VALUE && compare_ts_with_wrapdetect(dts, pls, mindts, minpls) < 0))
1589
                    minplaylist = i;
1590
            }
1591 1592
        }
    }
1593

1594
    /* If we got a packet, return it */
1595
    if (minplaylist >= 0) {
1596 1597 1598
        struct playlist *pls = c->playlists[minplaylist];
        *pkt = pls->pkt;
        pkt->stream_index += pls->stream_offset;
1599
        reset_packet(&c->playlists[minplaylist]->pkt);
1600 1601 1602 1603 1604 1605

        if (pkt->dts != AV_NOPTS_VALUE)
            c->cur_timestamp = av_rescale_q(pkt->dts,
                                            pls->ctx->streams[pls->pkt.stream_index]->time_base,
                                            AV_TIME_BASE_Q);

1606 1607
        return 0;
    }
1608
    return AVERROR_EOF;
1609 1610
}

1611
static int hls_close(AVFormatContext *s)
1612
{
1613
    HLSContext *c = s->priv_data;
1614

1615
    free_playlist_list(c);
1616
    free_variant_list(c);
1617
    free_rendition_list(c);
1618 1619 1620
    return 0;
}

1621
static int hls_read_seek(AVFormatContext *s, int stream_index,
1622 1623
                               int64_t timestamp, int flags)
{
1624
    HLSContext *c = s->priv_data;
1625 1626
    struct playlist *seek_pls = NULL;
    int i, seq_no;
1627
    int64_t first_timestamp, seek_timestamp, duration;
1628

1629 1630
    if ((flags & AVSEEK_FLAG_BYTE) ||
        !(c->variants[0]->playlists[0]->finished || c->variants[0]->playlists[0]->type == PLS_TYPE_EVENT))
1631 1632
        return AVERROR(ENOSYS);

1633 1634 1635
    first_timestamp = c->first_timestamp == AV_NOPTS_VALUE ?
                      0 : c->first_timestamp;

1636
    seek_timestamp = av_rescale_rnd(timestamp, AV_TIME_BASE,
1637 1638 1639 1640
                                    s->streams[stream_index]->time_base.den,
                                    flags & AVSEEK_FLAG_BACKWARD ?
                                    AV_ROUND_DOWN : AV_ROUND_UP);

1641 1642 1643 1644
    duration = s->duration == AV_NOPTS_VALUE ?
               0 : s->duration;

    if (0 < duration && duration < seek_timestamp - first_timestamp)
1645
        return AVERROR(EIO);
1646

1647
    /* find the playlist with the specified stream */
1648 1649
    for (i = 0; i < c->n_playlists; i++) {
        struct playlist *pls = c->playlists[i];
1650 1651 1652
        if (stream_index >= pls->stream_offset &&
            stream_index - pls->stream_offset < pls->ctx->nb_streams) {
            seek_pls = pls;
1653 1654
            break;
        }
1655
    }
1656 1657 1658
    /* check if the timestamp is valid for the playlist with the
     * specified stream index */
    if (!seek_pls || !find_timestamp_in_playlist(c, seek_pls, seek_timestamp, &seq_no))
1659 1660
        return AVERROR(EIO);

1661 1662 1663 1664
    /* set segment now so we do not need to search again below */
    seek_pls->cur_seq_no = seq_no;
    seek_pls->seek_stream_index = stream_index - seek_pls->stream_offset;

1665
    for (i = 0; i < c->n_playlists; i++) {
1666
        /* Reset reading */
1667 1668 1669 1670
        struct playlist *pls = c->playlists[i];
        if (pls->input) {
            ffurl_close(pls->input);
            pls->input = NULL;
1671
        }
1672 1673 1674
        av_free_packet(&pls->pkt);
        reset_packet(&pls->pkt);
        pls->pb.eof_reached = 0;
1675
        /* Clear any buffered data */
1676
        pls->pb.buf_end = pls->pb.buf_ptr = pls->pb.buffer;
1677
        /* Reset the pos, to let the mpegts demuxer know we've seeked. */
1678
        pls->pb.pos = 0;
1679 1680
        /* Flush the packet queue of the subdemuxer. */
        ff_read_frame_flush(pls->ctx);
1681

1682 1683 1684
        pls->seek_timestamp = seek_timestamp;
        pls->seek_flags = flags;

1685 1686
        if (pls != seek_pls) {
            /* set closest segment seq_no for playlists not handled above */
1687
            find_timestamp_in_playlist(c, pls, seek_timestamp, &pls->cur_seq_no);
1688 1689 1690 1691 1692 1693
            /* seek the playlist to the given position without taking
             * keyframes into account since this playlist does not have the
             * specified stream where we should look for the keyframes */
            pls->seek_stream_index = -1;
            pls->seek_flags |= AVSEEK_FLAG_ANY;
        }
1694
    }
1695

1696 1697
    c->cur_timestamp = seek_timestamp;

1698
    return 0;
1699 1700
}

1701
static int hls_probe(AVProbeData *p)
1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713
{
    /* Require #EXTM3U at the start, and either one of the ones below
     * somewhere for a proper match. */
    if (strncmp(p->buf, "#EXTM3U", 7))
        return 0;
    if (strstr(p->buf, "#EXT-X-STREAM-INF:")     ||
        strstr(p->buf, "#EXT-X-TARGETDURATION:") ||
        strstr(p->buf, "#EXT-X-MEDIA-SEQUENCE:"))
        return AVPROBE_SCORE_MAX;
    return 0;
}

1714
AVInputFormat ff_hls_demuxer = {
1715
    .name           = "hls,applehttp",
1716
    .long_name      = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
1717 1718 1719 1720 1721 1722
    .priv_data_size = sizeof(HLSContext),
    .read_probe     = hls_probe,
    .read_header    = hls_read_header,
    .read_packet    = hls_read_packet,
    .read_close     = hls_close,
    .read_seek      = hls_read_seek,
1723
};