git.sesse.net Git - vlc/blob - modules/stream_filter/httplive.c

   1 /*****************************************************************************
   2  * httplive.c: HTTP Live Streaming stream filter
   3  *****************************************************************************
   4  * Copyright (C) 2010-2012 M2X BV
   5  * $Id$
   6  *
   7  * Author: Jean-Paul Saman <jpsaman _AT_ videolan _DOT_ org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <limits.h>
  32
  33 #include <vlc_common.h>
  34 #include <vlc_plugin.h>
  35
  36 #include <assert.h>
  37 #include <errno.h>
  38 #include <gcrypt.h>
  39
  40 #include <vlc_threads.h>
  41 #include <vlc_arrays.h>
  42 #include <vlc_stream.h>
  43 #include <vlc_memory.h>
  44 #include <vlc_gcrypt.h>
  45
  46 /*****************************************************************************
  47  * Module descriptor
  48  *****************************************************************************/
  49 static int  Open (vlc_object_t *);
  50 static void Close(vlc_object_t *);
  51
  52 vlc_module_begin()
  53     set_category(CAT_INPUT)
  54     set_subcategory(SUBCAT_INPUT_STREAM_FILTER)
  55     set_description(N_("Http Live Streaming stream filter"))
  56     set_capability("stream_filter", 20)
  57     set_callbacks(Open, Close)
  58 vlc_module_end()
  59
  60 /*****************************************************************************
  61  *
  62  *****************************************************************************/
  63 #define AES_BLOCK_SIZE 16 /* Only support AES-128 */
  64 typedef struct segment_s
  65 {
  66     int         sequence;   /* unique sequence number */
  67     int         duration;   /* segment duration (seconds) */
  68     uint64_t    size;       /* segment size in bytes */
  69     uint64_t    bandwidth;  /* bandwidth usage of segments (bits per second)*/
  70
  71     char        *url;
  72     char       *psz_key_path;         /* url key path */
  73     uint8_t     aes_key[16];      /* AES-128 */
  74     bool        b_key_loaded;
  75
  76     vlc_mutex_t lock;
  77     block_t     *data;      /* data */
  78 } segment_t;
  79
  80 typedef struct hls_stream_s
  81 {
  82     int         id;         /* program id */
  83     int         version;    /* protocol version should be 1 */
  84     int         sequence;   /* media sequence number */
  85     int         duration;   /* maximum duration per segment (s) */
  86     uint64_t    bandwidth;  /* bandwidth usage of segments (bits per second)*/
  87     uint64_t    size;       /* stream length is calculated by taking the sum
  88                                foreach segment of (segment->duration * hls->bandwidth/8) */
  89
  90     vlc_array_t *segments;  /* list of segments */
  91     char        *url;        /* uri to m3u8 */
  92     vlc_mutex_t lock;
  93     bool        b_cache;    /* allow caching */
  94
  95     char        *psz_current_key_path;          /* URL path of the encrypted key */
  96     uint8_t      psz_AES_IV[AES_BLOCK_SIZE];    /* IV used when decypher the block */
  97     bool         b_iv_loaded;
  98 } hls_stream_t;
  99
 100 struct stream_sys_t
 101 {
 102     char         *m3u8;         /* M3U8 url */
 103     vlc_thread_t  reload;       /* HLS m3u8 reload thread */
 104     vlc_thread_t  thread;       /* HLS segment download thread */
 105
 106     block_t      *peeked;
 107
 108     /* */
 109     vlc_array_t  *hls_stream;   /* bandwidth adaptation */
 110     uint64_t      bandwidth;    /* measured bandwidth (bits per second) */
 111
 112     /* Download */
 113     struct hls_download_s
 114     {
 115         int         stream;     /* current hls_stream  */
 116         int         segment;    /* current segment for downloading */
 117         int         seek;       /* segment requested by seek (default -1) */
 118         vlc_mutex_t lock_wait;  /* protect segment download counter */
 119         vlc_cond_t  wait;       /* some condition to wait on */
 120     } download;
 121
 122     /* Playback */
 123     struct hls_playback_s
 124     {
 125         uint64_t    offset;     /* current offset in media */
 126         int         stream;     /* current hls_stream  */
 127         int         segment;    /* current segment for playback */
 128     } playback;
 129
 130     /* Playlist */
 131     struct hls_playlist_s
 132     {
 133         mtime_t     last;       /* playlist last loaded */
 134         mtime_t     wakeup;     /* next reload time */
 135         int         tries;      /* times it was not changed */
 136     } playlist;
 137
 138     /* state */
 139     bool        b_cache;    /* can cache files */
 140     bool        b_meta;     /* meta playlist */
 141     bool        b_live;     /* live stream? or vod? */
 142     bool        b_error;    /* parsing error */
 143     bool        b_aesmsg;   /* only print one time that the media is encrypted */
 144 };
 145
 146 /****************************************************************************
 147  * Local prototypes
 148  ****************************************************************************/
 149 static int  Read   (stream_t *, void *p_read, unsigned int i_read);
 150 static int  Peek   (stream_t *, const uint8_t **pp_peek, unsigned int i_peek);
 151 static int  Control(stream_t *, int i_query, va_list);
 152
 153 static ssize_t read_M3U8_from_stream(stream_t *s, uint8_t **buffer);
 154 static ssize_t read_M3U8_from_url(stream_t *s, const char *psz_url, uint8_t **buffer);
 155 static char *ReadLine(uint8_t *buffer, uint8_t **pos, size_t len);
 156
 157 static int hls_Download(stream_t *s, segment_t *segment);
 158
 159 static void* hls_Thread(void *);
 160 static void* hls_Reload(void *);
 161
 162 static segment_t *segment_GetSegment(hls_stream_t *hls, int wanted);
 163 static void segment_Free(segment_t *segment);
 164
 165 /****************************************************************************
 166  *
 167  ****************************************************************************/
 168 static bool isHTTPLiveStreaming(stream_t *s)
 169 {
 170     const uint8_t *peek;
 171
 172     int size = stream_Peek(s->p_source, &peek, 46);
 173     if (size < 7)
 174         return false;
 175
 176     if (memcmp(peek, "#EXTM3U", 7) != 0)
 177         return false;
 178
 179     peek += 7;
 180     size -= 7;
 181
 182     /* Parse stream and search for
 183      * EXT-X-TARGETDURATION or EXT-X-STREAM-INF tag, see
 184      * http://tools.ietf.org/html/draft-pantos-http-live-streaming-04#page-8 */
 185     while (size--)
 186     {
 187         static const char *const ext[] = {
 188             "TARGETDURATION",
 189             "MEDIA-SEQUENCE",
 190             "KEY",
 191             "ALLOW-CACHE",
 192             "ENDLIST",
 193             "STREAM-INF",
 194             "DISCONTINUITY",
 195             "VERSION"
 196         };
 197
 198         if (*peek++ != '#')
 199             continue;
 200
 201         if (size < 6)
 202             continue;
 203
 204         if (memcmp(peek, "EXT-X-", 6))
 205             continue;
 206
 207         peek += 6;
 208         size -= 6;
 209
 210         for (size_t i = 0; i < ARRAY_SIZE(ext); i++)
 211         {
 212             size_t len = strlen(ext[i]);
 213             if (size < 0 || (size_t)size < len)
 214                 continue;
 215             if (!memcmp(peek, ext[i], len))
 216                 return true;
 217         }
 218     }
 219
 220     return false;
 221 }
 222
 223 /* HTTP Live Streaming */
 224 static hls_stream_t *hls_New(vlc_array_t *hls_stream, const int id, const uint64_t bw, const char *uri)
 225 {
 226     hls_stream_t *hls = (hls_stream_t *)malloc(sizeof(hls_stream_t));
 227     if (hls == NULL) return NULL;
 228
 229     hls->id = id;
 230     hls->bandwidth = bw;
 231     hls->duration = -1;/* unknown */
 232     hls->size = 0;
 233     hls->sequence = 0; /* default is 0 */
 234     hls->version = 1;  /* default protocol version */
 235     hls->b_cache = true;
 236     hls->url = strdup(uri);
 237     if (hls->url == NULL)
 238     {
 239         free(hls);
 240         return NULL;
 241     }
 242     hls->psz_current_key_path = NULL;
 243     hls->segments = vlc_array_new();
 244     vlc_array_append(hls_stream, hls);
 245     vlc_mutex_init(&hls->lock);
 246     return hls;
 247 }
 248
 249 static void hls_Free(hls_stream_t *hls)
 250 {
 251     vlc_mutex_destroy(&hls->lock);
 252
 253     if (hls->segments)
 254     {
 255         for (int n = 0; n < vlc_array_count(hls->segments); n++)
 256         {
 257             segment_t *segment = segment_GetSegment(hls, n);
 258             if (segment) segment_Free(segment);
 259         }
 260         vlc_array_destroy(hls->segments);
 261     }
 262     free(hls->url);
 263     free(hls->psz_current_key_path);
 264     free(hls);
 265 }
 266
 267 static hls_stream_t *hls_Copy(hls_stream_t *src, const bool b_cp_segments)
 268 {
 269     assert(src);
 270     assert(!b_cp_segments); /* FIXME: copying segments is not implemented */
 271
 272     hls_stream_t *dst = (hls_stream_t *)malloc(sizeof(hls_stream_t));
 273     if (dst == NULL) return NULL;
 274
 275     dst->id = src->id;
 276     dst->bandwidth = src->bandwidth;
 277     dst->duration = src->duration;
 278     dst->size = src->size;
 279     dst->sequence = src->sequence;
 280     dst->version = src->version;
 281     dst->b_cache = src->b_cache;
 282     dst->psz_current_key_path = src->psz_current_key_path ?
 283                 strdup( src->psz_current_key_path ) : NULL;
 284     dst->url = strdup(src->url);
 285     if (dst->url == NULL)
 286     {
 287         free(dst);
 288         return NULL;
 289     }
 290     if (!b_cp_segments)
 291         dst->segments = vlc_array_new();
 292     vlc_mutex_init(&dst->lock);
 293     return dst;
 294 }
 295
 296 static hls_stream_t *hls_Get(vlc_array_t *hls_stream, const int wanted)
 297 {
 298     int count = vlc_array_count(hls_stream);
 299     if (count <= 0)
 300         return NULL;
 301     if ((wanted < 0) || (wanted >= count))
 302         return NULL;
 303     return (hls_stream_t *) vlc_array_item_at_index(hls_stream, wanted);
 304 }
 305
 306 static inline hls_stream_t *hls_GetFirst(vlc_array_t *hls_stream)
 307 {
 308     return hls_Get(hls_stream, 0);
 309 }
 310
 311 static hls_stream_t *hls_GetLast(vlc_array_t *hls_stream)
 312 {
 313     int count = vlc_array_count(hls_stream);
 314     if (count <= 0)
 315         return NULL;
 316     count--;
 317     return hls_Get(hls_stream, count);
 318 }
 319
 320 static hls_stream_t *hls_Find(vlc_array_t *hls_stream, hls_stream_t *hls_new)
 321 {
 322     int count = vlc_array_count(hls_stream);
 323     for (int n = 0; n < count; n++)
 324     {
 325         hls_stream_t *hls = hls_Get(hls_stream, n);
 326         if (hls)
 327         {
 328             /* compare */
 329             if ((hls->id == hls_new->id) &&
 330                 ((hls->bandwidth == hls_new->bandwidth)||(hls_new->bandwidth==0)))
 331                 return hls;
 332         }
 333     }
 334     return NULL;
 335 }
 336
 337 static uint64_t hls_GetStreamSize(hls_stream_t *hls)
 338 {
 339     /* NOTE: Stream size is calculated based on segment duration and
 340      * HLS stream bandwidth from the .m3u8 file. If these are not correct
 341      * then the deviation from exact byte size will be big and the seek/
 342      * progressbar will not behave entirely as one expects. */
 343     uint64_t size = 0UL;
 344
 345     /* If there is no valid bandwidth yet, then there is no point in
 346      * computing stream size. */
 347     if (hls->bandwidth == 0)
 348         return size;
 349
 350     int count = vlc_array_count(hls->segments);
 351     for (int n = 0; n < count; n++)
 352     {
 353         segment_t *segment = segment_GetSegment(hls, n);
 354         if (segment)
 355         {
 356             size += (segment->duration * (hls->bandwidth / 8));
 357         }
 358     }
 359     return size;
 360 }
 361
 362 /* Segment */
 363 static segment_t *segment_New(hls_stream_t* hls, const int duration, const char *uri)
 364 {
 365     segment_t *segment = (segment_t *)malloc(sizeof(segment_t));
 366     if (segment == NULL)
 367         return NULL;
 368
 369     segment->duration = duration; /* seconds */
 370     segment->size = 0; /* bytes */
 371     segment->sequence = 0;
 372     segment->bandwidth = 0;
 373     segment->url = strdup(uri);
 374     if (segment->url == NULL)
 375     {
 376         free(segment);
 377         return NULL;
 378     }
 379     segment->data = NULL;
 380     vlc_array_append(hls->segments, segment);
 381     vlc_mutex_init(&segment->lock);
 382     segment->b_key_loaded = false;
 383     segment->psz_key_path = NULL;
 384     if (hls->psz_current_key_path)
 385         segment->psz_key_path = strdup(hls->psz_current_key_path);
 386     return segment;
 387 }
 388
 389 static void segment_Free(segment_t *segment)
 390 {
 391     vlc_mutex_destroy(&segment->lock);
 392
 393     free(segment->url);
 394     free(segment->psz_key_path);
 395     if (segment->data)
 396         block_Release(segment->data);
 397     free(segment);
 398 }
 399
 400 static segment_t *segment_GetSegment(hls_stream_t *hls, const int wanted)
 401 {
 402     assert(hls);
 403
 404     int count = vlc_array_count(hls->segments);
 405     if (count <= 0)
 406         return NULL;
 407     if ((wanted < 0) || (wanted >= count))
 408         return NULL;
 409     return (segment_t *) vlc_array_item_at_index(hls->segments, wanted);
 410 }
 411
 412 static segment_t *segment_Find(hls_stream_t *hls, const int sequence)
 413 {
 414     assert(hls);
 415
 416     int count = vlc_array_count(hls->segments);
 417     if (count <= 0) return NULL;
 418     for (int n = 0; n < count; n++)
 419     {
 420         segment_t *segment = segment_GetSegment(hls, n);
 421         if (segment == NULL) break;
 422         if (segment->sequence == sequence)
 423             return segment;
 424     }
 425     return NULL;
 426 }
 427
 428 static int ChooseSegment(stream_t *s, const int current)
 429 {
 430     stream_sys_t *p_sys = (stream_sys_t *)s->p_sys;
 431     hls_stream_t *hls = hls_Get(p_sys->hls_stream, current);
 432     if (hls == NULL) return 0;
 433
 434     /* Choose a segment to start which is no closer than
 435      * 3 times the target duration from the end of the playlist.
 436      */
 437     int wanted = 0;
 438     int duration = 0;
 439     int sequence = 0;
 440     int count = vlc_array_count(hls->segments);
 441     int i = p_sys->b_live ? count - 1 : 0;
 442
 443     while((i >= 0) && (i < count))
 444     {
 445         segment_t *segment = segment_GetSegment(hls, i);
 446         assert(segment);
 447
 448         if (segment->duration > hls->duration)
 449         {
 450             msg_Err(s, "EXTINF:%d duration is larger than EXT-X-TARGETDURATION:%d",
 451                     segment->duration, hls->duration);
 452         }
 453
 454         duration += segment->duration;
 455         if (duration >= 3 * hls->duration)
 456         {
 457             /* Start point found */
 458             wanted = p_sys->b_live ? i : 0;
 459             sequence = segment->sequence;
 460             break;
 461         }
 462
 463         if (p_sys->b_live)
 464             i-- ;
 465         else
 466             i++;
 467     }
 468
 469     msg_Info(s, "Choose segment %d/%d (sequence=%d)", wanted, count, sequence);
 470     return wanted;
 471 }
 472
 473 /* Parsing */
 474 static char *parse_Attributes(const char *line, const char *attr)
 475 {
 476     char *p;
 477     char *begin = (char *) line;
 478     char *end = begin + strlen(line);
 479
 480     /* Find start of attributes */
 481     if ((p = strchr(begin, ':' )) == NULL)
 482         return NULL;
 483
 484     begin = p;
 485     do
 486     {
 487         if (strncasecmp(begin, attr, strlen(attr)) == 0
 488           && begin[strlen(attr)] == '=')
 489         {
 490             /* <attr>=<value>[,]* */
 491             p = strchr(begin, ',');
 492             begin += strlen(attr) + 1;
 493             if (begin >= end)
 494                 return NULL;
 495             if (p == NULL) /* last attribute */
 496                 return strndup(begin, end - begin);
 497             /* copy till ',' */
 498             return strndup(begin, p - begin);
 499         }
 500         begin++;
 501     } while(begin < end);
 502
 503     return NULL;
 504 }
 505
 506 static int string_to_IV(char *string_hexa, uint8_t iv[AES_BLOCK_SIZE])
 507 {
 508     unsigned long long iv_hi, iv_lo;
 509     char *end = NULL;
 510     if (*string_hexa++ != '0')
 511         return VLC_EGENERIC;
 512     if (*string_hexa != 'x' && *string_hexa != 'X')
 513         return VLC_EGENERIC;
 514
 515     string_hexa++;
 516
 517     size_t len = strlen(string_hexa);
 518     if (len <= 16) {
 519         iv_hi = 0;
 520         iv_lo = strtoull(string_hexa, &end, 16);
 521         if (end)
 522             return VLC_EGENERIC;
 523     } else {
 524         iv_lo = strtoull(&string_hexa[len-16], NULL, 16);
 525         if (end)
 526             return VLC_EGENERIC;
 527         string_hexa[len-16] = '\0';
 528         iv_hi = strtoull(string_hexa, NULL, 16);
 529         if (end)
 530             return VLC_EGENERIC;
 531     }
 532
 533     for (int i = 7; i >= 0 ; --i) {
 534         iv[  i] = iv_hi & 0xff;
 535         iv[8+i] = iv_lo & 0xff;
 536         iv_hi >>= 8;
 537         iv_lo >>= 8;
 538     }
 539
 540     return VLC_SUCCESS;
 541 }
 542
 543 static char *relative_URI(const char *psz_url, const char *psz_path)
 544 {
 545     char *ret = NULL;
 546     assert(psz_url != NULL && psz_path != NULL);
 547
 548
 549     //If the path is actually an absolute URL, don't do anything.
 550     if (strncmp(psz_path, "http", 4) == 0)
 551         return NULL;
 552
 553     size_t len = strlen(psz_path);
 554
 555     char *new_url = strdup(psz_url);
 556     if (unlikely(!new_url))
 557         return NULL;
 558
 559     if( psz_path[0] == '/' ) //Relative URL with absolute path
 560     {
 561         //Try to find separator for name and path, try to skip
 562         //access and first ://
 563         char *slash = strchr(&new_url[8], '/');
 564         if (unlikely(slash == NULL))
 565             goto end;
 566         *slash = '\0';
 567     } else {
 568         int levels = 0;
 569         while(len >= 3 && !strncmp(psz_path, "../", 3)) {
 570             psz_path += 3;
 571             len -= 3;
 572             levels++;
 573         }
 574         do {
 575             char *slash = strrchr(new_url, '/');
 576             if (unlikely(slash == NULL))
 577                 goto end;
 578             *slash = '\0';
 579         } while (levels--);
 580     }
 581
 582     if (asprintf(&ret, "%s/%s", new_url, psz_path) < 0)
 583         ret = NULL;
 584
 585 end:
 586     free(new_url);
 587     return ret;
 588 }
 589
 590 static int parse_SegmentInformation(hls_stream_t *hls, char *p_read, int *duration)
 591 {
 592     assert(hls);
 593     assert(p_read);
 594
 595     /* strip of #EXTINF: */
 596     char *p_next = NULL;
 597     char *token = strtok_r(p_read, ":", &p_next);
 598     if (token == NULL)
 599         return VLC_EGENERIC;
 600
 601     /* read duration */
 602     token = strtok_r(NULL, ",", &p_next);
 603     if (token == NULL)
 604         return VLC_EGENERIC;
 605
 606     int value;
 607     char *endptr;
 608     if (hls->version < 3)
 609     {
 610         errno = 0;
 611         value = strtol(token, &endptr, 10);
 612         if (token == endptr || errno == ERANGE)
 613         {
 614             *duration = -1;
 615             return VLC_EGENERIC;
 616         }
 617         *duration = value;
 618     }
 619     else
 620     {
 621         errno = 0;
 622         double d = strtof(token, &endptr);
 623         if (token == endptr || errno == ERANGE)
 624         {
 625             *duration = -1;
 626             return VLC_EGENERIC;
 627         }
 628         if ((d) - ((int)d) >= 0.5)
 629             value = ((int)d) + 1;
 630         else
 631             value = ((int)d);
 632         *duration = value;
 633     }
 634
 635     /* Ignore the rest of the line */
 636     return VLC_SUCCESS;
 637 }
 638
 639 static int parse_AddSegment(hls_stream_t *hls, const int duration, const char *uri)
 640 {
 641     assert(hls);
 642     assert(uri);
 643
 644     /* Store segment information */
 645     vlc_mutex_lock(&hls->lock);
 646
 647     char *psz_uri = relative_URI(hls->url, uri);
 648
 649     segment_t *segment = segment_New(hls, duration, psz_uri ? psz_uri : uri);
 650     if (segment)
 651         segment->sequence = hls->sequence + vlc_array_count(hls->segments) - 1;
 652     free(psz_uri);
 653
 654     vlc_mutex_unlock(&hls->lock);
 655
 656     return segment ? VLC_SUCCESS : VLC_ENOMEM;
 657 }
 658
 659 static int parse_TargetDuration(stream_t *s, hls_stream_t *hls, char *p_read)
 660 {
 661     assert(hls);
 662
 663     int duration = -1;
 664     int ret = sscanf(p_read, "#EXT-X-TARGETDURATION:%d", &duration);
 665     if (ret != 1)
 666     {
 667         msg_Err(s, "expected #EXT-X-TARGETDURATION:<s>");
 668         return VLC_EGENERIC;
 669     }
 670
 671     hls->duration = duration; /* seconds */
 672     return VLC_SUCCESS;
 673 }
 674
 675 static int parse_StreamInformation(stream_t *s, vlc_array_t **hls_stream,
 676                                    hls_stream_t **hls, char *p_read, const char *uri)
 677 {
 678     int id;
 679     uint64_t bw;
 680     char *attr;
 681
 682     assert(*hls == NULL);
 683
 684     attr = parse_Attributes(p_read, "PROGRAM-ID");
 685     if (attr)
 686     {
 687         id = atol(attr);
 688         free(attr);
 689     }
 690     else
 691         id = 0;
 692
 693     attr = parse_Attributes(p_read, "BANDWIDTH");
 694     if (attr == NULL)
 695     {
 696         msg_Err(s, "#EXT-X-STREAM-INF: expected BANDWIDTH=<value>");
 697         return VLC_EGENERIC;
 698     }
 699     bw = atoll(attr);
 700     free(attr);
 701
 702     if (bw == 0)
 703     {
 704         msg_Err(s, "#EXT-X-STREAM-INF: bandwidth cannot be 0");
 705         return VLC_EGENERIC;
 706     }
 707
 708     msg_Info(s, "bandwidth adaptation detected (program-id=%d, bandwidth=%"PRIu64").", id, bw);
 709
 710     char *psz_uri = relative_URI(s->p_sys->m3u8, uri);
 711
 712     *hls = hls_New(*hls_stream, id, bw, psz_uri ? psz_uri : uri);
 713
 714     free(psz_uri);
 715
 716     return (*hls == NULL) ? VLC_ENOMEM : VLC_SUCCESS;
 717 }
 718
 719 static int parse_MediaSequence(stream_t *s, hls_stream_t *hls, char *p_read)
 720 {
 721     assert(hls);
 722
 723     int sequence;
 724     int ret = sscanf(p_read, "#EXT-X-MEDIA-SEQUENCE:%d", &sequence);
 725     if (ret != 1)
 726     {
 727         msg_Err(s, "expected #EXT-X-MEDIA-SEQUENCE:<s>");
 728         return VLC_EGENERIC;
 729     }
 730
 731     if (hls->sequence > 0)
 732     {
 733         if (s->p_sys->b_live)
 734         {
 735             hls_stream_t *last = hls_GetLast(s->p_sys->hls_stream);
 736             if ((last->sequence < sequence) && (sequence - last->sequence != 1))
 737                 msg_Err(s, "EXT-X-MEDIA-SEQUENCE gap in playlist (new=%d, old=%d)",
 738                             sequence, last->sequence);
 739         }
 740         else
 741             msg_Err(s, "EXT-X-MEDIA-SEQUENCE already present in playlist (new=%d, old=%d)",
 742                         sequence, hls->sequence);
 743     }
 744     hls->sequence = sequence;
 745     return VLC_SUCCESS;
 746 }
 747
 748 static int parse_Key(stream_t *s, hls_stream_t *hls, char *p_read)
 749 {
 750     assert(hls);
 751
 752     /* #EXT-X-KEY:METHOD=<method>[,URI="<URI>"][,IV=<IV>] */
 753     int err = VLC_SUCCESS;
 754     char *attr = parse_Attributes(p_read, "METHOD");
 755     if (attr == NULL)
 756     {
 757         msg_Err(s, "#EXT-X-KEY: expected METHOD=<value>");
 758         return err;
 759     }
 760
 761     if (strncasecmp(attr, "NONE", 4) == 0)
 762     {
 763         char *uri = parse_Attributes(p_read, "URI");
 764         if (uri != NULL)
 765         {
 766             msg_Err(s, "#EXT-X-KEY: URI not expected");
 767             err = VLC_EGENERIC;
 768         }
 769         free(uri);
 770         /* IV is only supported in version 2 and above */
 771         if (hls->version >= 2)
 772         {
 773             char *iv = parse_Attributes(p_read, "IV");
 774             if (iv != NULL)
 775             {
 776                 msg_Err(s, "#EXT-X-KEY: IV not expected");
 777                 err = VLC_EGENERIC;
 778             }
 779             free(iv);
 780         }
 781     }
 782     else if (strncasecmp(attr, "AES-128", 7) == 0)
 783     {
 784         char *value, *uri, *iv;
 785         if (s->p_sys->b_aesmsg == false)
 786         {
 787             msg_Info(s, "playback of AES-128 encrypted HTTP Live media detected.");
 788             s->p_sys->b_aesmsg = true;
 789         }
 790         value = uri = parse_Attributes(p_read, "URI");
 791         if (value == NULL)
 792         {
 793             msg_Err(s, "#EXT-X-KEY: URI not found for encrypted HTTP Live media in AES-128");
 794             free(attr);
 795             return VLC_EGENERIC;
 796         }
 797
 798         /* Url is put between quotes, remove them */
 799         if (*value == '"')
 800         {
 801             /* We need to strip the "" from the attribute value */
 802             uri = value + 1;
 803             char* end = strchr(uri, '"');
 804             if (end != NULL)
 805                 *end = 0;
 806         }
 807         /* For absolute URI, just duplicate it
 808          * don't limit to HTTP, maybe some sanity checking
 809          * should be done more in here? */
 810         if( strstr( uri , "://" ) )
 811             hls->psz_current_key_path = strdup( uri );
 812         else
 813             hls->psz_current_key_path = relative_URI(hls->url, uri);
 814         free(value);
 815
 816         value = iv = parse_Attributes(p_read, "IV");
 817         if (iv == NULL)
 818         {
 819             /*
 820             * If the EXT-X-KEY tag does not have the IV attribute, implementations
 821             * MUST use the sequence number of the media file as the IV when
 822             * encrypting or decrypting that media file.  The big-endian binary
 823             * representation of the sequence number SHALL be placed in a 16-octet
 824             * buffer and padded (on the left) with zeros.
 825             */
 826             hls->b_iv_loaded = false;
 827         }
 828         else
 829         {
 830             /*
 831             * If the EXT-X-KEY tag has the IV attribute, implementations MUST use
 832             * the attribute value as the IV when encrypting or decrypting with that
 833             * key.  The value MUST be interpreted as a 128-bit hexadecimal number
 834             * and MUST be prefixed with 0x or 0X.
 835             */
 836
 837             if (string_to_IV(iv, hls->psz_AES_IV) == VLC_EGENERIC)
 838             {
 839                 msg_Err(s, "IV invalid");
 840                 err = VLC_EGENERIC;
 841             }
 842             else
 843                 hls->b_iv_loaded = true;
 844             free(value);
 845         }
 846     }
 847     else
 848     {
 849         msg_Warn(s, "playback of encrypted HTTP Live media is not supported.");
 850         err = VLC_EGENERIC;
 851     }
 852     free(attr);
 853     return err;
 854 }
 855
 856 static int parse_ProgramDateTime(stream_t *s, hls_stream_t *hls, char *p_read)
 857 {
 858     VLC_UNUSED(hls);
 859     msg_Dbg(s, "tag not supported: #EXT-X-PROGRAM-DATE-TIME %s", p_read);
 860     return VLC_SUCCESS;
 861 }
 862
 863 static int parse_AllowCache(stream_t *s, hls_stream_t *hls, char *p_read)
 864 {
 865     assert(hls);
 866
 867     char answer[4] = "\0";
 868     int ret = sscanf(p_read, "#EXT-X-ALLOW-CACHE:%3s", answer);
 869     if (ret != 1)
 870     {
 871         msg_Err(s, "#EXT-X-ALLOW-CACHE, ignoring ...");
 872         return VLC_EGENERIC;
 873     }
 874
 875     hls->b_cache = (strncmp(answer, "NO", 2) != 0);
 876     return VLC_SUCCESS;
 877 }
 878
 879 static int parse_Version(stream_t *s, hls_stream_t *hls, char *p_read)
 880 {
 881     assert(hls);
 882
 883     int version;
 884     int ret = sscanf(p_read, "#EXT-X-VERSION:%d", &version);
 885     if (ret != 1)
 886     {
 887         msg_Err(s, "#EXT-X-VERSION: no protocol version found, should be version 1.");
 888         return VLC_EGENERIC;
 889     }
 890
 891     /* Check version */
 892     hls->version = version;
 893     if (hls->version <= 0 || hls->version > 3)
 894     {
 895         msg_Err(s, "#EXT-X-VERSION should be version 1, 2 or 3 iso %d", version);
 896         return VLC_EGENERIC;
 897     }
 898     return VLC_SUCCESS;
 899 }
 900
 901 static int parse_EndList(stream_t *s, hls_stream_t *hls)
 902 {
 903     assert(hls);
 904
 905     s->p_sys->b_live = false;
 906     msg_Info(s, "video on demand (vod) mode");
 907     return VLC_SUCCESS;
 908 }
 909
 910 static int parse_Discontinuity(stream_t *s, hls_stream_t *hls, char *p_read)
 911 {
 912     assert(hls);
 913
 914     /* FIXME: Do we need to act on discontinuity ?? */
 915     msg_Dbg(s, "#EXT-X-DISCONTINUITY %s", p_read);
 916     return VLC_SUCCESS;
 917 }
 918
 919 static int hls_CompareStreams( const void* a, const void* b )
 920 {
 921     hls_stream_t*   stream_a = *(hls_stream_t**)a;
 922     hls_stream_t*   stream_b = *(hls_stream_t**)b;
 923     return stream_a->bandwidth > stream_b->bandwidth;
 924 }
 925
 926 /* The http://tools.ietf.org/html/draft-pantos-http-live-streaming-04#page-8
 927  * document defines the following new tags: EXT-X-TARGETDURATION,
 928  * EXT-X-MEDIA-SEQUENCE, EXT-X-KEY, EXT-X-PROGRAM-DATE-TIME, EXT-X-
 929  * ALLOW-CACHE, EXT-X-STREAM-INF, EXT-X-ENDLIST, EXT-X-DISCONTINUITY,
 930  * and EXT-X-VERSION.
 931  */
 932 static int parse_M3U8(stream_t *s, vlc_array_t *streams, uint8_t *buffer, const ssize_t len)
 933 {
 934     stream_sys_t *p_sys = s->p_sys;
 935     uint8_t *p_read, *p_begin, *p_end;
 936
 937     assert(streams);
 938     assert(buffer);
 939
 940     msg_Dbg(s, "parse_M3U8\n%s", buffer);
 941     p_begin = buffer;
 942     p_end = p_begin + len;
 943
 944     char *line = ReadLine(p_begin, &p_read, p_end - p_begin);
 945     if (line == NULL)
 946         return VLC_ENOMEM;
 947     p_begin = p_read;
 948
 949     if (strncmp(line, "#EXTM3U", 7) != 0)
 950     {
 951         msg_Err(s, "missing #EXTM3U tag .. aborting");
 952         free(line);
 953         return VLC_EGENERIC;
 954     }
 955
 956     free(line);
 957     line = NULL;
 958
 959     /* What is the version ? */
 960     int version = 1;
 961     uint8_t *p = (uint8_t *)strstr((const char *)buffer, "#EXT-X-VERSION:");
 962     if (p != NULL)
 963     {
 964         uint8_t *tmp = NULL;
 965         char *psz_version = ReadLine(p, &tmp, p_end - p);
 966         if (psz_version == NULL)
 967             return VLC_ENOMEM;
 968         int ret = sscanf((const char*)psz_version, "#EXT-X-VERSION:%d", &version);
 969         if (ret != 1)
 970         {
 971             msg_Warn(s, "#EXT-X-VERSION: no protocol version found, assuming version 1.");
 972             version = 1;
 973         }
 974         free(psz_version);
 975         p = NULL;
 976     }
 977
 978     /* Is it a live stream ? */
 979     p_sys->b_live = (strstr((const char *)buffer, "#EXT-X-ENDLIST") == NULL) ? true : false;
 980
 981     /* Is it a meta index file ? */
 982     bool b_meta = (strstr((const char *)buffer, "#EXT-X-STREAM-INF") == NULL) ? false : true;
 983
 984     int err = VLC_SUCCESS;
 985
 986     if (b_meta)
 987     {
 988         msg_Info(s, "Meta playlist");
 989
 990         /* M3U8 Meta Index file */
 991         do {
 992             bool failed_to_download_stream_m3u8 = false;
 993
 994             /* Next line */
 995             line = ReadLine(p_begin, &p_read, p_end - p_begin);
 996             if (line == NULL)
 997                 break;
 998             p_begin = p_read;
 999
1000             /* */
1001             if (strncmp(line, "#EXT-X-STREAM-INF", 17) == 0)
1002             {
1003                 p_sys->b_meta = true;
1004                 char *uri = ReadLine(p_begin, &p_read, p_end - p_begin);
1005                 if (uri == NULL)
1006                     err = VLC_ENOMEM;
1007                 else
1008                 {
1009                     if (*uri == '#')
1010                     {
1011                         msg_Info(s, "Skipping invalid stream-inf: %s", uri);
1012                         free(uri);
1013                     }
1014                     else
1015                     {
1016                         bool new_stream_added = false;
1017                         hls_stream_t *hls = NULL;
1018                         err = parse_StreamInformation(s, &streams, &hls, line, uri);
1019                         if (err == VLC_SUCCESS)
1020                             new_stream_added = true;
1021
1022                         free(uri);
1023
1024                         if (hls)
1025                         {
1026                             /* Download playlist file from server */
1027                             uint8_t *buf = NULL;
1028                             ssize_t len = read_M3U8_from_url(s, hls->url, &buf);
1029                             if (len < 0)
1030                             {
1031                                 msg_Warn(s, "failed to read %s, continue for other streams", hls->url);
1032                                 failed_to_download_stream_m3u8 = true;
1033
1034                                 /* remove stream just added */
1035                                 if (new_stream_added)
1036                                     vlc_array_remove(streams, vlc_array_count(streams) - 1);
1037
1038                                 /* ignore download error, so we have chance to try other streams */
1039                                 err = VLC_SUCCESS;
1040                             }
1041                             else
1042                             {
1043                                 /* Parse HLS m3u8 content. */
1044                                 err = parse_M3U8(s, streams, buf, len);
1045                                 free(buf);
1046                             }
1047
1048                             hls->version = version;
1049                             if (!p_sys->b_live)
1050                                 hls->size = hls_GetStreamSize(hls); /* Stream size (approximate) */
1051                         }
1052                     }
1053                 }
1054                 p_begin = p_read;
1055             }
1056
1057             free(line);
1058             line = NULL;
1059
1060             if (p_begin >= p_end)
1061                 break;
1062
1063         } while (err == VLC_SUCCESS);
1064
1065         size_t stream_count = vlc_array_count(streams);
1066         msg_Dbg(s, "%d streams loaded in Meta playlist", (int)stream_count);
1067         if (stream_count == 0)
1068         {
1069             msg_Err(s, "No playable streams found in Meta playlist");
1070             err = VLC_EGENERIC;
1071         }
1072     }
1073     else
1074     {
1075         msg_Info(s, "%s Playlist HLS protocol version: %d", p_sys->b_live ? "Live": "VOD", version);
1076
1077         hls_stream_t *hls = NULL;
1078         if (p_sys->b_meta)
1079             hls = hls_GetLast(streams);
1080         else
1081         {
1082             /* No Meta playlist used */
1083             hls = hls_New(streams, 0, 0, p_sys->m3u8);
1084             if (hls)
1085             {
1086                 /* Get TARGET-DURATION first */
1087                 p = (uint8_t *)strstr((const char *)buffer, "#EXT-X-TARGETDURATION:");
1088                 if (p)
1089                 {
1090                     uint8_t *p_rest = NULL;
1091                     char *psz_duration = ReadLine(p, &p_rest,  p_end - p);
1092                     if (psz_duration == NULL)
1093                         return VLC_EGENERIC;
1094                     err = parse_TargetDuration(s, hls, psz_duration);
1095                     free(psz_duration);
1096                     p = NULL;
1097                 }
1098
1099                 /* Store version */
1100                 hls->version = version;
1101             }
1102             else return VLC_ENOMEM;
1103         }
1104         assert(hls);
1105
1106         /* */
1107         bool media_sequence_loaded = false;
1108         int segment_duration = -1;
1109         do
1110         {
1111             /* Next line */
1112             line = ReadLine(p_begin, &p_read, p_end - p_begin);
1113             if (line == NULL)
1114                 break;
1115             p_begin = p_read;
1116
1117             if (strncmp(line, "#EXTINF", 7) == 0)
1118                 err = parse_SegmentInformation(hls, line, &segment_duration);
1119             else if (strncmp(line, "#EXT-X-TARGETDURATION", 21) == 0)
1120                 err = parse_TargetDuration(s, hls, line);
1121             else if (strncmp(line, "#EXT-X-MEDIA-SEQUENCE", 21) == 0)
1122             {
1123                 /* A Playlist file MUST NOT contain more than one EXT-X-MEDIA-SEQUENCE tag. */
1124                 /* We only care about first one */
1125                 if (!media_sequence_loaded)
1126                 {
1127                     err = parse_MediaSequence(s, hls, line);
1128                     media_sequence_loaded = true;
1129                 }
1130             }
1131             else if (strncmp(line, "#EXT-X-KEY", 10) == 0)
1132                 err = parse_Key(s, hls, line);
1133             else if (strncmp(line, "#EXT-X-PROGRAM-DATE-TIME", 24) == 0)
1134                 err = parse_ProgramDateTime(s, hls, line);
1135             else if (strncmp(line, "#EXT-X-ALLOW-CACHE", 18) == 0)
1136                 err = parse_AllowCache(s, hls, line);
1137             else if (strncmp(line, "#EXT-X-DISCONTINUITY", 20) == 0)
1138                 err = parse_Discontinuity(s, hls, line);
1139             else if (strncmp(line, "#EXT-X-VERSION", 14) == 0)
1140                 err = parse_Version(s, hls, line);
1141             else if (strncmp(line, "#EXT-X-ENDLIST", 14) == 0)
1142                 err = parse_EndList(s, hls);
1143             else if ((strncmp(line, "#", 1) != 0) && (*line != '\0') )
1144             {
1145                 err = parse_AddSegment(hls, segment_duration, line);
1146                 segment_duration = -1; /* reset duration */
1147             }
1148
1149             free(line);
1150             line = NULL;
1151
1152             if (p_begin >= p_end)
1153                 break;
1154
1155         } while (err == VLC_SUCCESS);
1156
1157         free(line);
1158     }
1159
1160     return err;
1161 }
1162
1163
1164 static int hls_DownloadSegmentKey(stream_t *s, segment_t *seg)
1165 {
1166     stream_t *p_m3u8 = stream_UrlNew(s, seg->psz_key_path);
1167     if (p_m3u8 == NULL)
1168     {
1169         msg_Err(s, "Failed to load the AES key for segment sequence %d", seg->sequence);
1170         return VLC_EGENERIC;
1171     }
1172
1173     int len = stream_Read(p_m3u8, seg->aes_key, sizeof(seg->aes_key));
1174     stream_Delete(p_m3u8);
1175     if (len != AES_BLOCK_SIZE)
1176     {
1177         msg_Err(s, "The AES key loaded doesn't have the right size (%d)", len);
1178         return VLC_EGENERIC;
1179     }
1180
1181     return VLC_SUCCESS;
1182 }
1183
1184 static int hls_ManageSegmentKeys(stream_t *s, hls_stream_t *hls)
1185 {
1186     segment_t   *seg = NULL;
1187     segment_t   *prev_seg;
1188     int         count = vlc_array_count(hls->segments);
1189
1190     for (int i = 0; i < count; i++)
1191     {
1192         prev_seg = seg;
1193         seg = segment_GetSegment(hls, i);
1194         if (seg == NULL )
1195             continue;
1196         if (seg->psz_key_path == NULL)
1197             continue;   /* No key to load ? continue */
1198         if (seg->b_key_loaded)
1199             continue;   /* The key is already loaded */
1200
1201         /* if the key has not changed, and already available from previous segment,
1202          * try to copy it, and don't load the key */
1203         if (prev_seg && prev_seg->b_key_loaded && strcmp(seg->psz_key_path, prev_seg->psz_key_path) == 0)
1204         {
1205             memcpy(seg->aes_key, prev_seg->aes_key, AES_BLOCK_SIZE);
1206             seg->b_key_loaded = true;
1207             continue;
1208         }
1209         if (hls_DownloadSegmentKey(s, seg) != VLC_SUCCESS)
1210             return VLC_EGENERIC;
1211        seg->b_key_loaded = true;
1212     }
1213     return VLC_SUCCESS;
1214 }
1215
1216 static int hls_DecodeSegmentData(stream_t *s, hls_stream_t *hls, segment_t *segment)
1217 {
1218     /* Did the segment need to be decoded ? */
1219     if (segment->psz_key_path == NULL)
1220         return VLC_SUCCESS;
1221
1222     /* Do we have loaded the key ? */
1223     if (!segment->b_key_loaded)
1224     {
1225         /* No ? try to download it now */
1226         if (hls_ManageSegmentKeys(s, hls) != VLC_SUCCESS)
1227             return VLC_EGENERIC;
1228     }
1229
1230     /* For now, we only decode AES-128 data */
1231     gcry_error_t i_gcrypt_err;
1232     gcry_cipher_hd_t aes_ctx;
1233     /* Setup AES */
1234     i_gcrypt_err = gcry_cipher_open(&aes_ctx, GCRY_CIPHER_AES,
1235                                      GCRY_CIPHER_MODE_CBC, 0);
1236     if (i_gcrypt_err)
1237     {
1238         msg_Err(s, "gcry_cipher_open failed: %s", gpg_strerror(i_gcrypt_err));
1239         gcry_cipher_close(aes_ctx);
1240         return VLC_EGENERIC;
1241     }
1242
1243     /* Set key */
1244     i_gcrypt_err = gcry_cipher_setkey(aes_ctx, segment->aes_key,
1245                                        sizeof(segment->aes_key));
1246     if (i_gcrypt_err)
1247     {
1248         msg_Err(s, "gcry_cipher_setkey failed: %s", gpg_strerror(i_gcrypt_err));
1249         gcry_cipher_close(aes_ctx);
1250         return VLC_EGENERIC;
1251     }
1252
1253     if (hls->b_iv_loaded == false)
1254     {
1255         memset(hls->psz_AES_IV, 0, AES_BLOCK_SIZE);
1256         hls->psz_AES_IV[15] = segment->sequence & 0xff;
1257         hls->psz_AES_IV[14] = (segment->sequence >> 8)& 0xff;
1258         hls->psz_AES_IV[13] = (segment->sequence >> 16)& 0xff;
1259         hls->psz_AES_IV[12] = (segment->sequence >> 24)& 0xff;
1260     }
1261
1262     i_gcrypt_err = gcry_cipher_setiv(aes_ctx, hls->psz_AES_IV,
1263                                       sizeof(hls->psz_AES_IV));
1264
1265     if (i_gcrypt_err)
1266     {
1267         msg_Err(s, "gcry_cipher_setiv failed: %s", gpg_strerror(i_gcrypt_err));
1268         gcry_cipher_close(aes_ctx);
1269         return VLC_EGENERIC;
1270     }
1271
1272     i_gcrypt_err = gcry_cipher_decrypt(aes_ctx,
1273                                        segment->data->p_buffer, /* out */
1274                                        segment->data->i_buffer,
1275                                        NULL, /* in */
1276                                        0);
1277     if (i_gcrypt_err)
1278     {
1279         msg_Err(s, "gcry_cipher_decrypt failed:  %s/%s\n", gcry_strsource(i_gcrypt_err), gcry_strerror(i_gcrypt_err));
1280         gcry_cipher_close(aes_ctx);
1281         return VLC_EGENERIC;
1282     }
1283     gcry_cipher_close(aes_ctx);
1284     /* remove the PKCS#7 padding from the buffer */
1285     int pad = segment->data->p_buffer[segment->data->i_buffer-1];
1286     if (pad <= 0 || pad > AES_BLOCK_SIZE)
1287     {
1288         msg_Err(s, "Bad padding character (0x%x), perhaps we failed to decrypt the segment with the correct key", pad);
1289         return VLC_EGENERIC;
1290     }
1291     int count = pad;
1292     while (count--)
1293     {
1294         if (segment->data->p_buffer[segment->data->i_buffer-1-count] != pad)
1295         {
1296                 msg_Err(s, "Bad ending buffer, perhaps we failed to decrypt the segment with the correct key");
1297                 return VLC_EGENERIC;
1298         }
1299     }
1300
1301     /* not all the data is readable because of padding */
1302     segment->data->i_buffer -= pad;
1303
1304     return VLC_SUCCESS;
1305 }
1306
1307 static int get_HTTPLiveMetaPlaylist(stream_t *s, vlc_array_t **streams)
1308 {
1309     stream_sys_t *p_sys = s->p_sys;
1310     assert(*streams);
1311     int err = VLC_EGENERIC;
1312
1313     /* Duplicate HLS stream META information */
1314     for (int i = 0; i < vlc_array_count(p_sys->hls_stream); i++)
1315     {
1316         hls_stream_t *src, *dst;
1317         src = hls_Get(p_sys->hls_stream, i);
1318         if (src == NULL)
1319             return VLC_EGENERIC;
1320
1321         dst = hls_Copy(src, false);
1322         if (dst == NULL)
1323             return VLC_ENOMEM;
1324         vlc_array_append(*streams, dst);
1325
1326         /* Download playlist file from server */
1327         uint8_t *buf = NULL;
1328         ssize_t len = read_M3U8_from_url(s, dst->url, &buf);
1329         if (len < 0)
1330             err = VLC_EGENERIC;
1331         else
1332         {
1333             /* Parse HLS m3u8 content. */
1334             err = parse_M3U8(s, *streams, buf, len);
1335             free(buf);
1336         }
1337     }
1338     return err;
1339 }
1340
1341 /* Update hls_old (an existing member of p_sys->hls_stream) to match hls_new
1342    (which represents a downloaded, perhaps newer version of the same playlist) */
1343 static int hls_UpdatePlaylist(stream_t *s, hls_stream_t *hls_new, hls_stream_t *hls_old)
1344 {
1345     int count = vlc_array_count(hls_new->segments);
1346
1347     msg_Info(s, "updating hls stream (program-id=%d, bandwidth=%"PRIu64") has %d segments",
1348              hls_new->id, hls_new->bandwidth, count);
1349
1350     vlc_mutex_lock(&hls_old->lock);
1351     for (int n = 0; n < count; n++)
1352     {
1353         segment_t *p = segment_GetSegment(hls_new, n);
1354         if (p == NULL) return VLC_EGENERIC;
1355
1356         segment_t *segment = segment_Find(hls_old, p->sequence);
1357         if (segment)
1358         {
1359             vlc_mutex_lock(&segment->lock);
1360
1361             assert(p->url);
1362             assert(segment->url);
1363
1364             /* they should be the same */
1365             if ((p->sequence != segment->sequence) ||
1366                 (p->duration != segment->duration) ||
1367                 (strcmp(p->url, segment->url) != 0))
1368             {
1369                 msg_Warn(s, "existing segment found with different content - resetting");
1370                 msg_Warn(s, "- sequence: new=%d, old=%d", p->sequence, segment->sequence);
1371                 msg_Warn(s, "- duration: new=%d, old=%d", p->duration, segment->duration);
1372                 msg_Warn(s, "- file: new=%s", p->url);
1373                 msg_Warn(s, "        old=%s", segment->url);
1374
1375                 /* Resetting content */
1376                 segment->sequence = p->sequence;
1377                 segment->duration = p->duration;
1378                 free(segment->url);
1379                 segment->url = strdup(p->url);
1380                 if ( segment->url == NULL )
1381                 {
1382                     msg_Err(s, "Failed updating segment %d - skipping it",  p->sequence);
1383                     segment_Free(p);
1384                     vlc_mutex_unlock(&segment->lock);
1385                     continue;
1386                 }
1387                 /* We must free the content, because if the key was not downloaded, content can't be decrypted */
1388                 if ((p->psz_key_path || p->b_key_loaded) &&
1389                     segment->data)
1390                 {
1391                     block_Release(segment->data);
1392                     segment->data = NULL;
1393                 }
1394                 free(segment->psz_key_path);
1395                 segment->psz_key_path = p->psz_key_path ? strdup(p->psz_key_path) : NULL;
1396                 segment_Free(p);
1397             }
1398             vlc_mutex_unlock(&segment->lock);
1399         }
1400         else
1401         {
1402             int last = vlc_array_count(hls_old->segments) - 1;
1403             segment_t *l = segment_GetSegment(hls_old, last);
1404             if (l == NULL) {
1405                 vlc_mutex_unlock(&hls_old->lock);
1406                 return VLC_EGENERIC;
1407             }
1408
1409             if ((l->sequence + 1) != p->sequence)
1410             {
1411                 msg_Err(s, "gap in sequence numbers found: new=%d expected %d",
1412                         p->sequence, l->sequence+1);
1413             }
1414             vlc_array_append(hls_old->segments, p);
1415             msg_Info(s, "- segment %d appended", p->sequence);
1416         }
1417     }
1418
1419     /* update meta information */
1420     hls_old->sequence = hls_new->sequence;
1421     hls_old->duration = (hls_new->duration == -1) ? hls_old->duration : hls_new->duration;
1422     hls_old->b_cache = hls_new->b_cache;
1423     vlc_mutex_unlock(&hls_old->lock);
1424     return VLC_SUCCESS;
1425
1426 }
1427
1428 static int hls_ReloadPlaylist(stream_t *s)
1429 {
1430     stream_sys_t *p_sys = s->p_sys;
1431
1432     vlc_array_t *hls_streams = vlc_array_new();
1433     if (hls_streams == NULL)
1434         return VLC_ENOMEM;
1435
1436     msg_Info(s, "Reloading HLS live meta playlist");
1437
1438     if (get_HTTPLiveMetaPlaylist(s, &hls_streams) != VLC_SUCCESS)
1439     {
1440         /* Free hls streams */
1441         for (int i = 0; i < vlc_array_count(hls_streams); i++)
1442         {
1443             hls_stream_t *hls;
1444             hls = hls_Get(hls_streams, i);
1445             if (hls) hls_Free(hls);
1446         }
1447         vlc_array_destroy(hls_streams);
1448
1449         msg_Err(s, "reloading playlist failed");
1450         return VLC_EGENERIC;
1451     }
1452
1453     /* merge playlists */
1454     int count = vlc_array_count(hls_streams);
1455     for (int n = 0; n < count; n++)
1456     {
1457         hls_stream_t *hls_new = hls_Get(hls_streams, n);
1458         if (hls_new == NULL)
1459             continue;
1460
1461         hls_stream_t *hls_old = hls_Find(p_sys->hls_stream, hls_new);
1462         if (hls_old == NULL)
1463         {   /* new hls stream - append */
1464             vlc_array_append(p_sys->hls_stream, hls_new);
1465             msg_Info(s, "new HLS stream appended (id=%d, bandwidth=%"PRIu64")",
1466                      hls_new->id, hls_new->bandwidth);
1467         }
1468         else if (hls_UpdatePlaylist(s, hls_new, hls_old) != VLC_SUCCESS)
1469             msg_Info(s, "failed updating HLS stream (id=%d, bandwidth=%"PRIu64")",
1470                      hls_new->id, hls_new->bandwidth);
1471     }
1472     vlc_array_destroy(hls_streams);
1473     return VLC_SUCCESS;
1474 }
1475
1476 /****************************************************************************
1477  * hls_Thread
1478  ****************************************************************************/
1479 static int BandwidthAdaptation(stream_t *s, int progid, uint64_t *bandwidth)
1480 {
1481     stream_sys_t *p_sys = s->p_sys;
1482     int candidate = -1;
1483     uint64_t bw = *bandwidth;
1484     uint64_t bw_candidate = 0;
1485
1486     int count = vlc_array_count(p_sys->hls_stream);
1487     for (int n = 0; n < count; n++)
1488     {
1489         /* Select best bandwidth match */
1490         hls_stream_t *hls = hls_Get(p_sys->hls_stream, n);
1491         if (hls == NULL) break;
1492
1493         /* only consider streams with the same PROGRAM-ID */
1494         if (hls->id == progid)
1495         {
1496             if ((bw >= hls->bandwidth) && (bw_candidate < hls->bandwidth))
1497             {
1498                 msg_Dbg(s, "candidate %d bandwidth (bits/s) %"PRIu64" >= %"PRIu64,
1499                          n, bw, hls->bandwidth); /* bits / s */
1500                 bw_candidate = hls->bandwidth;
1501                 candidate = n; /* possible candidate */
1502             }
1503         }
1504     }
1505     *bandwidth = bw_candidate;
1506     return candidate;
1507 }
1508
1509 static int hls_DownloadSegmentData(stream_t *s, hls_stream_t *hls, segment_t *segment, int *cur_stream)
1510 {
1511     stream_sys_t *p_sys = s->p_sys;
1512
1513     assert(hls);
1514     assert(segment);
1515
1516     vlc_mutex_lock(&segment->lock);
1517     if (segment->data != NULL)
1518     {
1519         /* Segment already downloaded */
1520         vlc_mutex_unlock(&segment->lock);
1521         return VLC_SUCCESS;
1522     }
1523
1524     /* sanity check - can we download this segment on time? */
1525     if ((p_sys->bandwidth > 0) && (hls->bandwidth > 0))
1526     {
1527         uint64_t size = (segment->duration * hls->bandwidth); /* bits */
1528         int estimated = (int)(size / p_sys->bandwidth);
1529         if (estimated > segment->duration)
1530         {
1531             msg_Warn(s,"downloading segment %d predicted to take %ds, which exceeds its length (%ds)",
1532                         segment->sequence, estimated, segment->duration);
1533         }
1534     }
1535
1536     mtime_t start = mdate();
1537     if (hls_Download(s, segment) != VLC_SUCCESS)
1538     {
1539         msg_Err(s, "downloading segment %d from stream %d failed",
1540                     segment->sequence, *cur_stream);
1541         vlc_mutex_unlock(&segment->lock);
1542         return VLC_EGENERIC;
1543     }
1544     mtime_t duration = mdate() - start;
1545     if (hls->bandwidth == 0 && segment->duration > 0)
1546     {
1547         /* Try to estimate the bandwidth for this stream */
1548         hls->bandwidth = (uint64_t)(((double)segment->size * 8) / ((double)segment->duration));
1549     }
1550
1551     /* If the segment is encrypted, decode it */
1552     if (hls_DecodeSegmentData(s, hls, segment) != VLC_SUCCESS)
1553     {
1554         vlc_mutex_unlock(&segment->lock);
1555         return VLC_EGENERIC;
1556     }
1557
1558     vlc_mutex_unlock(&segment->lock);
1559
1560     msg_Info(s, "downloaded segment %d from stream %d",
1561                 segment->sequence, *cur_stream);
1562
1563     uint64_t bw = segment->size * 8 * 1000000 / __MAX(1, duration); /* bits / s */
1564     p_sys->bandwidth = bw;
1565     if (p_sys->b_meta && (hls->bandwidth != bw))
1566     {
1567         int newstream = BandwidthAdaptation(s, hls->id, &bw);
1568
1569         /* FIXME: we need an average here */
1570         if ((newstream >= 0) && (newstream != *cur_stream))
1571         {
1572             msg_Info(s, "detected %s bandwidth (%"PRIu64") stream",
1573                      (bw >= hls->bandwidth) ? "faster" : "lower", bw);
1574             *cur_stream = newstream;
1575         }
1576     }
1577     return VLC_SUCCESS;
1578 }
1579
1580 static void* hls_Thread(void *p_this)
1581 {
1582     stream_t *s = (stream_t *)p_this;
1583     stream_sys_t *p_sys = s->p_sys;
1584
1585     int canc = vlc_savecancel();
1586
1587     while (vlc_object_alive(s))
1588     {
1589         hls_stream_t *hls = hls_Get(p_sys->hls_stream, p_sys->download.stream);
1590         assert(hls);
1591
1592         /* Sliding window (~60 seconds worth of movie) */
1593         vlc_mutex_lock(&hls->lock);
1594         int count = vlc_array_count(hls->segments);
1595         vlc_mutex_unlock(&hls->lock);
1596
1597         /* Is there a new segment to process? */
1598         if ((!p_sys->b_live && (p_sys->playback.segment < (count - 6))) ||
1599             (p_sys->download.segment >= count))
1600         {
1601             /* wait */
1602             vlc_mutex_lock(&p_sys->download.lock_wait);
1603             while (((p_sys->download.segment - p_sys->playback.segment > 6) ||
1604                     (p_sys->download.segment >= count)) &&
1605                    (p_sys->download.seek == -1))
1606             {
1607                 vlc_cond_wait(&p_sys->download.wait, &p_sys->download.lock_wait);
1608                 if (p_sys->b_live /*&& (mdate() >= p_sys->playlist.wakeup)*/)
1609                     break;
1610                 if (!vlc_object_alive(s))
1611                     break;
1612             }
1613             /* */
1614             if (p_sys->download.seek >= 0)
1615             {
1616                 p_sys->download.segment = p_sys->download.seek;
1617                 p_sys->download.seek = -1;
1618             }
1619             vlc_mutex_unlock(&p_sys->download.lock_wait);
1620         }
1621
1622         if (!vlc_object_alive(s)) break;
1623
1624         vlc_mutex_lock(&hls->lock);
1625         segment_t *segment = segment_GetSegment(hls, p_sys->download.segment);
1626         vlc_mutex_unlock(&hls->lock);
1627
1628         if ((segment != NULL) &&
1629             (hls_DownloadSegmentData(s, hls, segment, &p_sys->download.stream) != VLC_SUCCESS))
1630         {
1631             if (!vlc_object_alive(s)) break;
1632
1633             if (!p_sys->b_live)
1634             {
1635                 p_sys->b_error = true;
1636                 break;
1637             }
1638         }
1639
1640         /* download succeeded */
1641         /* determine next segment to download */
1642         vlc_mutex_lock(&p_sys->download.lock_wait);
1643         if (p_sys->download.seek >= 0)
1644         {
1645             p_sys->download.segment = p_sys->download.seek;
1646             p_sys->download.seek = -1;
1647         }
1648         else if (p_sys->download.segment < count)
1649             p_sys->download.segment++;
1650         vlc_cond_signal(&p_sys->download.wait);
1651         vlc_mutex_unlock(&p_sys->download.lock_wait);
1652     }
1653
1654     vlc_restorecancel(canc);
1655     return NULL;
1656 }
1657
1658 static void* hls_Reload(void *p_this)
1659 {
1660     stream_t *s = (stream_t *)p_this;
1661     stream_sys_t *p_sys = s->p_sys;
1662
1663     assert(p_sys->b_live);
1664
1665     int canc = vlc_savecancel();
1666
1667     double wait = 0.5;
1668     while (vlc_object_alive(s))
1669     {
1670         mtime_t now = mdate();
1671         if (now >= p_sys->playlist.wakeup)
1672         {
1673             /* reload the m3u8 */
1674             if (hls_ReloadPlaylist(s) != VLC_SUCCESS)
1675             {
1676                 /* No change in playlist, then backoff */
1677                 p_sys->playlist.tries++;
1678                 if (p_sys->playlist.tries == 1) wait = 0.5;
1679                 else if (p_sys->playlist.tries == 2) wait = 1;
1680                 else if (p_sys->playlist.tries >= 3) wait = 2;
1681
1682                 /* Can we afford to backoff? */
1683                 if (p_sys->download.segment - p_sys->playback.segment < 3)
1684                 {
1685                     p_sys->playlist.tries = 0;
1686                     wait = 0.5;
1687                 }
1688             }
1689             else
1690             {
1691                 p_sys->playlist.tries = 0;
1692                 wait = 0.5;
1693             }
1694
1695             hls_stream_t *hls = hls_Get(p_sys->hls_stream, p_sys->download.stream);
1696             assert(hls);
1697
1698             /* determine next time to update playlist */
1699             p_sys->playlist.last = now;
1700             p_sys->playlist.wakeup = now + ((mtime_t)(hls->duration * wait)
1701                                                    * (mtime_t)1000000);
1702         }
1703
1704         mwait(p_sys->playlist.wakeup);
1705     }
1706
1707     vlc_restorecancel(canc);
1708     return NULL;
1709 }
1710
1711 static int Prefetch(stream_t *s, int *current)
1712 {
1713     stream_sys_t *p_sys = s->p_sys;
1714     int stream = *current;
1715
1716     hls_stream_t *hls = hls_Get(p_sys->hls_stream, stream);
1717     if (hls == NULL)
1718         return VLC_EGENERIC;
1719
1720     if (vlc_array_count(hls->segments) == 0)
1721         return VLC_EGENERIC;
1722     else if (vlc_array_count(hls->segments) == 1 && p_sys->b_live)
1723         msg_Warn(s, "Only 1 segment available to prefetch in live stream; may stall");
1724
1725     /* Download first 2 segments of this HLS stream if they exist */
1726     for (int i = 0; i < __MIN(vlc_array_count(hls->segments), 2); i++)
1727     {
1728         segment_t *segment = segment_GetSegment(hls, p_sys->download.segment);
1729         if (segment == NULL )
1730             return VLC_EGENERIC;
1731
1732         /* It is useless to lock the segment here, as Prefetch is called before
1733            download and playlit thread are started. */
1734         if (segment->data)
1735         {
1736             p_sys->download.segment++;
1737             continue;
1738         }
1739
1740         if (hls_DownloadSegmentData(s, hls, segment, current) != VLC_SUCCESS)
1741             return VLC_EGENERIC;
1742
1743         p_sys->download.segment++;
1744
1745         /* adapt bandwidth? */
1746         if (*current != stream)
1747         {
1748             hls_stream_t *hls = hls_Get(p_sys->hls_stream, *current);
1749             if (hls == NULL)
1750                 return VLC_EGENERIC;
1751
1752              stream = *current;
1753         }
1754     }
1755
1756     return VLC_SUCCESS;
1757 }
1758
1759 /****************************************************************************
1760  *
1761  ****************************************************************************/
1762 static int hls_Download(stream_t *s, segment_t *segment)
1763 {
1764     assert(segment);
1765
1766     stream_t *p_ts = stream_UrlNew(s, segment->url);
1767     if (p_ts == NULL)
1768         return VLC_EGENERIC;
1769
1770     segment->size = stream_Size(p_ts);
1771     assert(segment->size > 0);
1772
1773     segment->data = block_Alloc(segment->size);
1774     if (segment->data == NULL)
1775     {
1776         stream_Delete(p_ts);
1777         return VLC_ENOMEM;
1778     }
1779
1780     assert(segment->data->i_buffer == segment->size);
1781
1782     ssize_t length = 0, curlen = 0;
1783     uint64_t size;
1784     do
1785     {
1786         /* NOTE: Beware the size reported for a segment by the HLS server may not
1787          * be correct, when downloading the segment data. Therefore check the size
1788          * and enlarge the segment data block if necessary.
1789          */
1790         size = stream_Size(p_ts);
1791         if (size > segment->size)
1792         {
1793             msg_Dbg(s, "size changed %"PRIu64, segment->size);
1794             block_t *p_block = block_Realloc(segment->data, 0, size);
1795             if (p_block == NULL)
1796             {
1797                 stream_Delete(p_ts);
1798                 block_Release(segment->data);
1799                 segment->data = NULL;
1800                 return VLC_ENOMEM;
1801             }
1802             segment->data = p_block;
1803             segment->size = size;
1804             assert(segment->data->i_buffer == segment->size);
1805             p_block = NULL;
1806         }
1807         length = stream_Read(p_ts, segment->data->p_buffer + curlen, segment->size - curlen);
1808         if (length <= 0)
1809             break;
1810         curlen += length;
1811     } while (vlc_object_alive(s));
1812
1813     stream_Delete(p_ts);
1814     return VLC_SUCCESS;
1815 }
1816
1817 /* Read M3U8 file */
1818 static ssize_t read_M3U8_from_stream(stream_t *s, uint8_t **buffer)
1819 {
1820     int64_t total_bytes = 0;
1821     int64_t total_allocated = 0;
1822     uint8_t *p = NULL;
1823
1824     while (1)
1825     {
1826         char buf[4096];
1827         int64_t bytes;
1828
1829         bytes = stream_Read(s, buf, sizeof(buf));
1830         if (bytes == 0)
1831             break;      /* EOF ? */
1832         else if (bytes < 0)
1833             return bytes;
1834
1835         if ( (total_bytes + bytes + 1) > total_allocated )
1836         {
1837             if (total_allocated)
1838                 total_allocated *= 2;
1839             else
1840                 total_allocated = __MIN((uint64_t)bytes+1, sizeof(buf));
1841
1842             p = realloc_or_free(p, total_allocated);
1843             if (p == NULL)
1844                 return VLC_ENOMEM;
1845         }
1846
1847         memcpy(p+total_bytes, buf, bytes);
1848         total_bytes += bytes;
1849     }
1850
1851     if (total_allocated == 0)
1852         return VLC_EGENERIC;
1853
1854     p[total_bytes] = '\0';
1855     *buffer = p;
1856
1857     return total_bytes;
1858 }
1859
1860 static ssize_t read_M3U8_from_url(stream_t *s, const char* psz_url, uint8_t **buffer)
1861 {
1862     assert(*buffer == NULL);
1863
1864     /* Construct URL */
1865     stream_t *p_m3u8 = stream_UrlNew(s, psz_url);
1866     if (p_m3u8 == NULL)
1867         return VLC_EGENERIC;
1868
1869     ssize_t size = read_M3U8_from_stream(p_m3u8, buffer);
1870     stream_Delete(p_m3u8);
1871
1872     return size;
1873 }
1874
1875 static char *ReadLine(uint8_t *buffer, uint8_t **pos, const size_t len)
1876 {
1877     assert(buffer);
1878
1879     char *line = NULL;
1880     uint8_t *begin = buffer;
1881     uint8_t *p = begin;
1882     uint8_t *end = p + len;
1883
1884     while (p < end)
1885     {
1886         if ((*p == '\r') || (*p == '\n') || (*p == '\0'))
1887             break;
1888         p++;
1889     }
1890
1891     /* copy line excluding \r \n or \0 */
1892     line = strndup((char *)begin, p - begin);
1893
1894     while ((*p == '\r') || (*p == '\n') || (*p == '\0'))
1895     {
1896         if (*p == '\0')
1897         {
1898             *pos = end;
1899             break;
1900         }
1901         else
1902         {
1903             /* next pass start after \r and \n */
1904             p++;
1905             *pos = p;
1906         }
1907     }
1908
1909     return line;
1910 }
1911
1912 /****************************************************************************
1913  * Open
1914  ****************************************************************************/
1915 static int Open(vlc_object_t *p_this)
1916 {
1917     stream_t *s = (stream_t*)p_this;
1918     stream_sys_t *p_sys;
1919
1920     if (!isHTTPLiveStreaming(s))
1921         return VLC_EGENERIC;
1922
1923     msg_Info(p_this, "HTTP Live Streaming (%s)", s->psz_path);
1924
1925     /* Initialize crypto bit */
1926     vlc_gcrypt_init();
1927
1928     /* */
1929     s->p_sys = p_sys = calloc(1, sizeof(*p_sys));
1930     if (p_sys == NULL)
1931         return VLC_ENOMEM;
1932
1933     char *psz_uri = NULL;
1934     if (asprintf(&psz_uri,"%s://%s", s->psz_access, s->psz_path) < 0)
1935     {
1936         free(p_sys);
1937         return VLC_ENOMEM;
1938     }
1939     p_sys->m3u8 = psz_uri;
1940
1941     char *new_path;
1942     if (asprintf(&new_path, "%s.ts", s->psz_path) < 0)
1943     {
1944         free(p_sys->m3u8);
1945         free(p_sys);
1946         return VLC_ENOMEM;
1947     }
1948     free(s->psz_path);
1949     s->psz_path = new_path;
1950
1951     p_sys->bandwidth = 0;
1952     p_sys->b_live = true;
1953     p_sys->b_meta = false;
1954     p_sys->b_error = false;
1955
1956     p_sys->hls_stream = vlc_array_new();
1957     if (p_sys->hls_stream == NULL)
1958     {
1959         free(p_sys->m3u8);
1960         free(p_sys);
1961         return VLC_ENOMEM;
1962     }
1963
1964     /* */
1965     s->pf_read = Read;
1966     s->pf_peek = Peek;
1967     s->pf_control = Control;
1968
1969     /* Parse HLS m3u8 content. */
1970     uint8_t *buffer = NULL;
1971     ssize_t len = read_M3U8_from_stream(s->p_source, &buffer);
1972     if (len < 0)
1973         goto fail;
1974     if (parse_M3U8(s, p_sys->hls_stream, buffer, len) != VLC_SUCCESS)
1975     {
1976         free(buffer);
1977         goto fail;
1978     }
1979     free(buffer);
1980     /* HLS standard doesn't provide any guaranty about streams
1981        being sorted by bandwidth, so we sort them */
1982     qsort( p_sys->hls_stream->pp_elems, p_sys->hls_stream->i_count,
1983            sizeof( hls_stream_t* ), &hls_CompareStreams );
1984
1985     /* Choose first HLS stream to start with */
1986     int current = p_sys->playback.stream = 0;
1987     p_sys->playback.segment = p_sys->download.segment = ChooseSegment(s, current);
1988
1989     /* manage encryption key if needed */
1990     hls_ManageSegmentKeys(s, hls_Get(p_sys->hls_stream, current));
1991
1992     if (Prefetch(s, &current) != VLC_SUCCESS)
1993     {
1994         msg_Err(s, "fetching first segment failed.");
1995         goto fail;
1996     }
1997
1998     p_sys->download.stream = current;
1999     p_sys->playback.stream = current;
2000     p_sys->download.seek = -1;
2001
2002     vlc_mutex_init(&p_sys->download.lock_wait);
2003     vlc_cond_init(&p_sys->download.wait);
2004
2005     /* Initialize HLS live stream */
2006     if (p_sys->b_live)
2007     {
2008         hls_stream_t *hls = hls_Get(p_sys->hls_stream, current);
2009         p_sys->playlist.last = mdate();
2010         p_sys->playlist.wakeup = p_sys->playlist.last +
2011                 ((mtime_t)hls->duration * UINT64_C(1000000));
2012
2013         if (vlc_clone(&p_sys->reload, hls_Reload, s, VLC_THREAD_PRIORITY_LOW))
2014         {
2015             goto fail_thread;
2016         }
2017     }
2018
2019     if (vlc_clone(&p_sys->thread, hls_Thread, s, VLC_THREAD_PRIORITY_INPUT))
2020     {
2021         if (p_sys->b_live)
2022             vlc_join(p_sys->reload, NULL);
2023         goto fail_thread;
2024     }
2025
2026     return VLC_SUCCESS;
2027
2028 fail_thread:
2029     vlc_mutex_destroy(&p_sys->download.lock_wait);
2030     vlc_cond_destroy(&p_sys->download.wait);
2031
2032 fail:
2033     /* Free hls streams */
2034     for (int i = 0; i < vlc_array_count(p_sys->hls_stream); i++)
2035     {
2036         hls_stream_t *hls = hls_Get(p_sys->hls_stream, i);
2037         if (hls) hls_Free(hls);
2038     }
2039     vlc_array_destroy(p_sys->hls_stream);
2040
2041     /* */
2042     free(p_sys->m3u8);
2043     free(p_sys);
2044     return VLC_EGENERIC;
2045 }
2046
2047 /****************************************************************************
2048  * Close
2049  ****************************************************************************/
2050 static void Close(vlc_object_t *p_this)
2051 {
2052     stream_t *s = (stream_t*)p_this;
2053     stream_sys_t *p_sys = s->p_sys;
2054
2055     assert(p_sys->hls_stream);
2056
2057     /* */
2058     vlc_mutex_lock(&p_sys->download.lock_wait);
2059     /* negate the condition variable's predicate */
2060     p_sys->download.segment = p_sys->playback.segment = 0;
2061     p_sys->download.seek = 0; /* better safe than sorry */
2062     vlc_cond_signal(&p_sys->download.wait);
2063     vlc_mutex_unlock(&p_sys->download.lock_wait);
2064
2065     /* */
2066     if (p_sys->b_live)
2067         vlc_join(p_sys->reload, NULL);
2068     vlc_join(p_sys->thread, NULL);
2069     vlc_mutex_destroy(&p_sys->download.lock_wait);
2070     vlc_cond_destroy(&p_sys->download.wait);
2071
2072     /* Free hls streams */
2073     for (int i = 0; i < vlc_array_count(p_sys->hls_stream); i++)
2074     {
2075         hls_stream_t *hls = hls_Get(p_sys->hls_stream, i);
2076         if (hls) hls_Free(hls);
2077     }
2078     vlc_array_destroy(p_sys->hls_stream);
2079
2080     /* */
2081     free(p_sys->m3u8);
2082     if (p_sys->peeked)
2083         block_Release (p_sys->peeked);
2084     free(p_sys);
2085 }
2086
2087 /****************************************************************************
2088  * Stream filters functions
2089  ****************************************************************************/
2090 static segment_t *GetSegment(stream_t *s)
2091 {
2092     stream_sys_t *p_sys = s->p_sys;
2093     segment_t *segment = NULL;
2094
2095     /* Is this segment of the current HLS stream ready? */
2096     hls_stream_t *hls = hls_Get(p_sys->hls_stream, p_sys->playback.stream);
2097     if (hls != NULL)
2098     {
2099         vlc_mutex_lock(&hls->lock);
2100         segment = segment_GetSegment(hls, p_sys->playback.segment);
2101         if (segment != NULL)
2102         {
2103             vlc_mutex_lock(&segment->lock);
2104             /* This segment is ready? */
2105             if (segment->data != NULL)
2106             {
2107                 vlc_mutex_unlock(&segment->lock);
2108                 p_sys->b_cache = hls->b_cache;
2109                 vlc_mutex_unlock(&hls->lock);
2110                 goto check;
2111             }
2112             vlc_mutex_unlock(&segment->lock);
2113         }
2114         vlc_mutex_unlock(&hls->lock);
2115     }
2116
2117     /* Was the HLS stream changed to another bitrate? */
2118     segment = NULL;
2119     for (int i_stream = 0; i_stream < vlc_array_count(p_sys->hls_stream); i_stream++)
2120     {
2121         /* Is the next segment ready */
2122         hls_stream_t *hls = hls_Get(p_sys->hls_stream, i_stream);
2123         if (hls == NULL)
2124             return NULL;
2125
2126         vlc_mutex_lock(&hls->lock);
2127         segment = segment_GetSegment(hls, p_sys->playback.segment);
2128         if (segment == NULL)
2129         {
2130             vlc_mutex_unlock(&hls->lock);
2131             break;
2132         }
2133
2134         vlc_mutex_lock(&p_sys->download.lock_wait);
2135         int i_segment = p_sys->download.segment;
2136         vlc_mutex_unlock(&p_sys->download.lock_wait);
2137
2138         vlc_mutex_lock(&segment->lock);
2139         /* This segment is ready? */
2140         if ((segment->data != NULL) &&
2141             (p_sys->playback.segment < i_segment))
2142         {
2143             p_sys->playback.stream = i_stream;
2144             p_sys->b_cache = hls->b_cache;
2145             vlc_mutex_unlock(&segment->lock);
2146             vlc_mutex_unlock(&hls->lock);
2147             goto check;
2148         }
2149         vlc_mutex_unlock(&segment->lock);
2150         vlc_mutex_unlock(&hls->lock);
2151
2152         if (!p_sys->b_meta)
2153             break;
2154     }
2155     /* */
2156     return NULL;
2157
2158 check:
2159     /* sanity check */
2160     assert(segment->data);
2161     if (segment->data->i_buffer == 0)
2162     {
2163         vlc_mutex_lock(&hls->lock);
2164         int count = vlc_array_count(hls->segments);
2165         vlc_mutex_unlock(&hls->lock);
2166
2167         if ((p_sys->download.segment - p_sys->playback.segment == 0) &&
2168             ((count != p_sys->download.segment) || p_sys->b_live))
2169             msg_Err(s, "playback will stall");
2170         else if ((p_sys->download.segment - p_sys->playback.segment < 3) &&
2171                  ((count != p_sys->download.segment) || p_sys->b_live))
2172             msg_Warn(s, "playback in danger of stalling");
2173     }
2174     return segment;
2175 }
2176
2177 static int segment_RestorePos(segment_t *segment)
2178 {
2179     if (segment->data)
2180     {
2181         uint64_t size = segment->size - segment->data->i_buffer;
2182         if (size > 0)
2183         {
2184             segment->data->i_buffer += size;
2185             segment->data->p_buffer -= size;
2186         }
2187     }
2188     return VLC_SUCCESS;
2189 }
2190
2191 /* p_read might be NULL if caller wants to skip data */
2192 static ssize_t hls_Read(stream_t *s, uint8_t *p_read, unsigned int i_read)
2193 {
2194     stream_sys_t *p_sys = s->p_sys;
2195     ssize_t used = 0;
2196
2197     do
2198     {
2199         /* Determine next segment to read. If this is a meta playlist and
2200          * bandwidth conditions changed, then the stream might have switched
2201          * to another bandwidth. */
2202         segment_t *segment = GetSegment(s);
2203         if (segment == NULL)
2204             break;
2205
2206         vlc_mutex_lock(&segment->lock);
2207         if (segment->data->i_buffer == 0)
2208         {
2209             if (!p_sys->b_cache || p_sys->b_live)
2210             {
2211                 block_Release(segment->data);
2212                 segment->data = NULL;
2213             }
2214             else
2215                 segment_RestorePos(segment);
2216
2217             vlc_mutex_unlock(&segment->lock);
2218
2219             /* signal download thread */
2220             vlc_mutex_lock(&p_sys->download.lock_wait);
2221             p_sys->playback.segment++;
2222             vlc_cond_signal(&p_sys->download.wait);
2223             vlc_mutex_unlock(&p_sys->download.lock_wait);
2224             continue;
2225         }
2226
2227         if (segment->size == segment->data->i_buffer)
2228             msg_Info(s, "playing segment %d from stream %d",
2229                      segment->sequence, p_sys->playback.stream);
2230
2231         ssize_t len = -1;
2232         if (i_read <= segment->data->i_buffer)
2233             len = i_read;
2234         else if (i_read > segment->data->i_buffer)
2235             len = segment->data->i_buffer;
2236
2237         if (len > 0)
2238         {
2239             if (p_read) /* if NULL, then caller skips data */
2240                 memcpy(p_read + used, segment->data->p_buffer, len);
2241             segment->data->i_buffer -= len;
2242             segment->data->p_buffer += len;
2243             used += len;
2244             i_read -= len;
2245         }
2246         vlc_mutex_unlock(&segment->lock);
2247
2248     } while (i_read > 0);
2249
2250     return used;
2251 }
2252
2253 static int Read(stream_t *s, void *buffer, unsigned int i_read)
2254 {
2255     stream_sys_t *p_sys = s->p_sys;
2256     ssize_t length = 0;
2257
2258     assert(p_sys->hls_stream);
2259
2260     if (p_sys->b_error)
2261         return 0;
2262
2263     /* NOTE: buffer might be NULL if caller wants to skip data */
2264     length = hls_Read(s, (uint8_t*) buffer, i_read);
2265     if (length < 0)
2266         return 0;
2267
2268     p_sys->playback.offset += length;
2269     return length;
2270 }
2271
2272 static int Peek(stream_t *s, const uint8_t **pp_peek, unsigned int i_peek)
2273 {
2274     stream_sys_t *p_sys = s->p_sys;
2275     segment_t *segment;
2276     unsigned int len = i_peek;
2277
2278     segment = GetSegment(s);
2279     if (segment == NULL)
2280     {
2281         msg_Err(s, "segment %d should have been available (stream %d)",
2282                 p_sys->playback.segment, p_sys->playback.stream);
2283         return 0; /* eof? */
2284     }
2285
2286     vlc_mutex_lock(&segment->lock);
2287
2288     size_t i_buff = segment->data->i_buffer;
2289     uint8_t *p_buff = segment->data->p_buffer;
2290
2291     if (i_peek < i_buff)
2292     {
2293         *pp_peek = p_buff;
2294         vlc_mutex_unlock(&segment->lock);
2295         return i_peek;
2296     }
2297
2298     else /* This will seldom be run */
2299     {
2300         /* remember segment to read */
2301         int peek_segment = p_sys->playback.segment;
2302         size_t curlen = 0;
2303         segment_t *nsegment;
2304         p_sys->playback.segment++;
2305         block_t *peeked = p_sys->peeked;
2306
2307         if (peeked == NULL)
2308             peeked = block_Alloc (i_peek);
2309         else if (peeked->i_buffer < i_peek)
2310             peeked = block_Realloc (peeked, 0, i_peek);
2311         if (peeked == NULL)
2312             return 0;
2313         p_sys->peeked = peeked;
2314
2315         memcpy(peeked->p_buffer, p_buff, i_buff);
2316         curlen = i_buff;
2317         len -= i_buff;
2318         vlc_mutex_unlock(&segment->lock);
2319
2320         i_buff = peeked->i_buffer;
2321         p_buff = peeked->p_buffer;
2322         *pp_peek = p_buff;
2323
2324         while (curlen < i_peek)
2325         {
2326             nsegment = GetSegment(s);
2327             if (nsegment == NULL)
2328             {
2329                 msg_Err(s, "segment %d should have been available (stream %d)",
2330                         p_sys->playback.segment, p_sys->playback.stream);
2331                 /* restore segment to read */
2332                 p_sys->playback.segment = peek_segment;
2333                 return curlen; /* eof? */
2334             }
2335
2336             vlc_mutex_lock(&nsegment->lock);
2337
2338             if (len < nsegment->data->i_buffer)
2339             {
2340                 memcpy(p_buff + curlen, nsegment->data->p_buffer, len);
2341                 curlen += len;
2342             }
2343             else
2344             {
2345                 size_t i_nbuff = nsegment->data->i_buffer;
2346                 memcpy(p_buff + curlen, nsegment->data->p_buffer, i_nbuff);
2347                 curlen += i_nbuff;
2348                 len -= i_nbuff;
2349
2350                 p_sys->playback.segment++;
2351             }
2352
2353             vlc_mutex_unlock(&nsegment->lock);
2354         }
2355
2356         /* restore segment to read */
2357         p_sys->playback.segment = peek_segment;
2358         return curlen;
2359     }
2360 }
2361
2362 static bool hls_MaySeek(stream_t *s)
2363 {
2364     stream_sys_t *p_sys = s->p_sys;
2365
2366     if (p_sys->hls_stream == NULL)
2367         return false;
2368
2369     hls_stream_t *hls = hls_Get(p_sys->hls_stream, p_sys->playback.stream);
2370     if (hls == NULL) return false;
2371
2372     if (p_sys->b_live)
2373     {
2374         vlc_mutex_lock(&hls->lock);
2375         int count = vlc_array_count(hls->segments);
2376         vlc_mutex_unlock(&hls->lock);
2377
2378         vlc_mutex_lock(&p_sys->download.lock_wait);
2379         bool may_seek = (p_sys->download.segment < (count - 2));
2380         vlc_mutex_unlock(&p_sys->download.lock_wait);
2381         return may_seek;
2382     }
2383     return true;
2384 }
2385
2386 static uint64_t GetStreamSize(stream_t *s)
2387 {
2388     stream_sys_t *p_sys = s->p_sys;
2389
2390     if (p_sys->b_live)
2391         return 0;
2392
2393     hls_stream_t *hls = hls_Get(p_sys->hls_stream, p_sys->playback.stream);
2394     if (hls == NULL) return 0;
2395
2396     vlc_mutex_lock(&hls->lock);
2397     if (hls->size == 0)
2398         hls->size = hls_GetStreamSize(hls);
2399     uint64_t size = hls->size;
2400     vlc_mutex_unlock(&hls->lock);
2401
2402     return size;
2403 }
2404
2405 static int segment_Seek(stream_t *s, const uint64_t pos)
2406 {
2407     stream_sys_t *p_sys = s->p_sys;
2408
2409     hls_stream_t *hls = hls_Get(p_sys->hls_stream, p_sys->playback.stream);
2410     if (hls == NULL)
2411         return VLC_EGENERIC;
2412
2413     vlc_mutex_lock(&hls->lock);
2414
2415     bool b_found = false;
2416     uint64_t length = 0;
2417     uint64_t size = hls->size;
2418     int count = vlc_array_count(hls->segments);
2419
2420     segment_t *currentSegment = segment_GetSegment(hls, p_sys->playback.segment);
2421     if (currentSegment == NULL)
2422     {
2423         vlc_mutex_unlock(&hls->lock);
2424         return VLC_EGENERIC;
2425     }
2426
2427     for (int n = 0; n < count; n++)
2428     {
2429         segment_t *segment = segment_GetSegment(hls, n);
2430         if (segment == NULL)
2431         {
2432             vlc_mutex_unlock(&hls->lock);
2433             return VLC_EGENERIC;
2434         }
2435
2436         vlc_mutex_lock(&segment->lock);
2437         length += segment->duration * (hls->bandwidth/8);
2438         vlc_mutex_unlock(&segment->lock);
2439
2440         if (pos <= length)
2441         {
2442             if (count - n >= 3)
2443             {
2444                 p_sys->playback.segment = n;
2445                 b_found = true;
2446                 break;
2447             }
2448             /* Do not search in last 3 segments */
2449             vlc_mutex_unlock(&hls->lock);
2450             return VLC_EGENERIC;
2451         }
2452     }
2453
2454     /* */
2455     if (!b_found && (pos >= size))
2456     {
2457         p_sys->playback.segment = count - 1;
2458         b_found = true;
2459     }
2460
2461     /* */
2462     if (b_found)
2463     {
2464
2465         /* restore current segment to start position */
2466         vlc_mutex_lock(&currentSegment->lock);
2467         segment_RestorePos(currentSegment);
2468         vlc_mutex_unlock(&currentSegment->lock);
2469
2470         /* restore seeked segment to start position */
2471         segment_t *segment = segment_GetSegment(hls, p_sys->playback.segment);
2472         if (segment == NULL)
2473         {
2474             vlc_mutex_unlock(&hls->lock);
2475             return VLC_EGENERIC;
2476         }
2477
2478         vlc_mutex_lock(&segment->lock);
2479         segment_RestorePos(segment);
2480         vlc_mutex_unlock(&segment->lock);
2481
2482         /* start download at current playback segment */
2483         vlc_mutex_unlock(&hls->lock);
2484
2485         /* Wake up download thread */
2486         vlc_mutex_lock(&p_sys->download.lock_wait);
2487         p_sys->download.seek = p_sys->playback.segment;
2488         vlc_cond_signal(&p_sys->download.wait);
2489
2490         /* Wait for download to be finished */
2491         msg_Info(s, "seek to segment %d", p_sys->playback.segment);
2492         while ((p_sys->download.seek != -1) ||
2493            ((p_sys->download.segment - p_sys->playback.segment < 3) &&
2494                 (p_sys->download.segment < count)))
2495         {
2496             vlc_cond_wait(&p_sys->download.wait, &p_sys->download.lock_wait);
2497             if (!vlc_object_alive(s) || s->b_error) break;
2498         }
2499         vlc_mutex_unlock(&p_sys->download.lock_wait);
2500
2501         return VLC_SUCCESS;
2502     }
2503     vlc_mutex_unlock(&hls->lock);
2504
2505     return b_found ? VLC_SUCCESS : VLC_EGENERIC;
2506 }
2507
2508 static int Control(stream_t *s, int i_query, va_list args)
2509 {
2510     stream_sys_t *p_sys = s->p_sys;
2511
2512     switch (i_query)
2513     {
2514         case STREAM_CAN_SEEK:
2515             *(va_arg (args, bool *)) = hls_MaySeek(s);
2516             break;
2517         case STREAM_CAN_FASTSEEK:
2518         case STREAM_CAN_PAUSE: /* TODO */
2519         case STREAM_CAN_CONTROL_PACE:
2520             *(va_arg (args, bool *)) = false;
2521             break;
2522         case STREAM_GET_POSITION:
2523             *(va_arg (args, uint64_t *)) = p_sys->playback.offset;
2524             break;
2525         case STREAM_SET_POSITION:
2526             if (hls_MaySeek(s))
2527             {
2528                 uint64_t pos = (uint64_t)va_arg(args, uint64_t);
2529                 if (segment_Seek(s, pos) == VLC_SUCCESS)
2530                 {
2531                     p_sys->playback.offset = pos;
2532                     break;
2533                 }
2534             }
2535             return VLC_EGENERIC;
2536         case STREAM_GET_SIZE:
2537             *(va_arg (args, uint64_t *)) = GetStreamSize(s);
2538             break;
2539         default:
2540             return VLC_EGENERIC;
2541     }
2542     return VLC_SUCCESS;
2543 }