1 /*****************************************************************************
2 * httplive.c: HTTP Live Streaming stream filter
3 *****************************************************************************
4 * Copyright (C) 2010 M2X BV
7 * Author: Jean-Paul Saman <jpsaman _AT_ videolan _DOT_ org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
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 General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
36 #include <vlc_threads.h>
37 #include <vlc_arrays.h>
38 #include <vlc_stream.h>
41 #include <vlc_modules.h>
42 #include <vlc_access.h>
44 /*****************************************************************************
46 *****************************************************************************/
47 static int Open (vlc_object_t *);
48 static void Close(vlc_object_t *);
51 set_category(CAT_INPUT)
52 set_subcategory(SUBCAT_INPUT_STREAM_FILTER)
53 set_description(N_("Http Live Streaming stream filter"))
54 set_capability("stream_filter", 20)
55 set_callbacks(Open, Close)
58 /*****************************************************************************
60 *****************************************************************************/
61 typedef struct segment_s
63 int sequence; /* unique sequence number */
64 int duration; /* segment duration (seconds) */
65 uint64_t size; /* segment size in bytes */
66 uint64_t bandwidth; /* bandwidth usage of segments (bits per second)*/
70 block_t *data; /* data */
73 typedef struct hls_stream_s
75 int id; /* program id */
76 int version; /* protocol version should be 1 */
77 int sequence; /* media sequence number */
78 int duration; /* maximum duration per segment (ms) */
79 uint64_t bandwidth; /* bandwidth usage of segments (bits per second)*/
80 uint64_t size; /* stream length (segment->duration * hls->bandwidth/8) */
82 vlc_array_t *segments; /* list of segments */
83 vlc_url_t url; /* uri to m3u8 */
85 bool b_cache; /* allow caching */
93 int current; /* current hls_stream */
94 int segment; /* current segment for downloading */
95 int seek; /* segment requested by seek (default -1) */
96 vlc_mutex_t lock_wait; /* protect segment download counter */
97 vlc_cond_t wait; /* some condition to wait on */
98 vlc_array_t *hls_stream;/* bandwidth adaptation */
105 access_t *p_access; /* HTTP access input */
106 vlc_url_t m3u8; /* M3U8 url */
109 hls_thread_t *thread;
110 vlc_array_t *hls_stream;/* bandwidth adaptation */
111 uint64_t bandwidth; /* measured bandwidth (bits per second) */
114 struct hls_playback_t
116 uint64_t offset; /* current offset in media */
117 int current; /* current hls_stream */
118 int segment; /* current segment for playback */
122 struct hls_playlist_s
124 mtime_t last; /* playlist last loaded */
125 mtime_t wakeup; /* next reload time */
126 int tries; /* times it was not changed */
130 bool b_cache; /* can cache files */
131 bool b_meta; /* meta playlist */
132 bool b_live; /* live stream? or vod? */
133 bool b_error; /* parsing error */
136 /****************************************************************************
138 ****************************************************************************/
139 static int Read (stream_t *, void *p_read, unsigned int i_read);
140 static int Peek (stream_t *, const uint8_t **pp_peek, unsigned int i_peek);
141 static int Control(stream_t *, int i_query, va_list);
143 static int AccessOpen(stream_t *s, vlc_url_t *url);
144 static void AccessClose(stream_t *s);
145 static char *AccessReadLine(access_t *p_access, uint8_t *psz_tmp, size_t i_len);
146 static int AccessDownload(stream_t *s, segment_t *segment);
148 static void* hls_Thread(vlc_object_t *);
149 static int get_HTTPLivePlaylist(stream_t *s, hls_stream_t *hls);
151 static segment_t *segment_GetSegment(hls_stream_t *hls, int wanted);
152 static void segment_Free(segment_t *segment);
154 /****************************************************************************
156 ****************************************************************************/
157 static bool isHTTPLiveStreaming(stream_t *s)
159 const uint8_t *peek, *peek_end;
161 int64_t i_size = stream_Peek(s->p_source, &peek, 46);
165 if (strncasecmp((const char*)peek, "#EXTM3U", 7) != 0)
168 /* Parse stream and search for
169 * EXT-X-TARGETDURATION or EXT-X-STREAM-INF tag, see
170 * http://tools.ietf.org/html/draft-pantos-http-live-streaming-04#page-8 */
171 peek_end = peek + i_size;
172 while(peek <= peek_end)
176 if (strncasecmp((const char*)peek, "#EXT-X-TARGETDURATION", 21) == 0)
178 else if (strncasecmp((const char*)peek, "#EXT-X-STREAM-INF", 17) == 0)
187 /* HTTP Live Streaming */
188 static hls_stream_t *hls_New(vlc_array_t *hls_stream, int id, uint64_t bw, char *uri)
190 hls_stream_t *hls = (hls_stream_t *)malloc(sizeof(hls_stream_t));
191 if (hls == NULL) return NULL;
195 hls->duration = -1;/* unknown */
197 hls->sequence = 0; /* default is 0 */
198 hls->version = 1; /* default protocol version */
200 vlc_UrlParse(&hls->url, uri, 0);
201 hls->segments = vlc_array_new();
202 vlc_array_append(hls_stream, hls);
203 vlc_mutex_init(&hls->lock);
207 static void hls_Free(hls_stream_t *hls)
209 vlc_mutex_destroy(&hls->lock);
213 for (int n = 0; n < vlc_array_count(hls->segments); n++)
215 segment_t *segment = (segment_t *)vlc_array_item_at_index(hls->segments, n);
216 if (segment) segment_Free(segment);
218 vlc_array_destroy(hls->segments);
221 vlc_UrlClean(&hls->url);
226 static hls_stream_t *hls_Get(vlc_array_t *hls_stream, int wanted)
228 int count = vlc_array_count(hls_stream);
231 if ((wanted < 0) || (wanted >= count))
233 return (hls_stream_t *) vlc_array_item_at_index(hls_stream, wanted);
236 static inline hls_stream_t *hls_GetFirst(vlc_array_t *hls_stream)
238 return (hls_stream_t*) hls_Get(hls_stream, 0);
241 static hls_stream_t *hls_GetLast(vlc_array_t *hls_stream)
243 int count = vlc_array_count(hls_stream);
247 return (hls_stream_t *) hls_Get(hls_stream, count);
250 static uint64_t hls_GetStreamSize(hls_stream_t *hls)
252 /* NOTE: Stream size is calculated based on segment duration and
253 * HLS stream bandwidth from the .m3u8 file. If these are not correct
254 * then the deviation from exact byte size will be big and the seek/
255 * progressbar will not behave entirely as one expects. */
257 int count = vlc_array_count(hls->segments);
258 for (int n = 0; n < count; n++)
260 segment_t *segment = segment_GetSegment(hls, n);
263 size += (segment->duration * (hls->bandwidth / 8));
270 static segment_t *segment_New(hls_stream_t* hls, int duration, char *uri)
272 segment_t *segment = (segment_t *)malloc(sizeof(segment_t));
276 segment->duration = duration; /* seconds */
277 segment->size = 0; /* bytes */
278 segment->sequence = 0;
279 segment->bandwidth = 0;
280 vlc_UrlParse(&segment->url, uri, 0);
281 segment->data = NULL;
282 vlc_array_append(hls->segments, segment);
283 vlc_mutex_init(&segment->lock);
287 static void segment_Free(segment_t *segment)
289 vlc_mutex_destroy(&segment->lock);
291 vlc_UrlClean(&segment->url);
293 block_Release(segment->data);
298 static segment_t *segment_GetSegment(hls_stream_t *hls, int wanted)
302 int count = vlc_array_count(hls->segments);
305 if ((wanted < 0) || (wanted >= count))
307 return (segment_t *) vlc_array_item_at_index(hls->segments, wanted);
311 static char *parse_Attributes(const char *line, const char *attr)
314 char *begin = (char *) line;
315 char *end = begin + strlen(line);
317 /* Find start of attributes */
318 if ((p = strchr(begin, ':' )) == NULL)
324 if (strncasecmp(begin, attr, strlen(attr)) == 0)
326 /* <attr>=<value>[,]* */
327 p = strchr(begin, ',');
328 begin += strlen(attr) + 1;
331 if (p == NULL) /* last attribute */
332 return strndup(begin, end - begin);
334 return strndup(begin, p - begin);
337 } while(begin < end);
342 static char *relative_URI(stream_t *s, const char *uri, const char *path)
344 stream_sys_t *p_sys = s->p_sys;
346 char *p = strchr(uri, ':');
350 char *psz_path = strdup(p_sys->m3u8.psz_path);
351 if (psz_path == NULL) return NULL;
352 p = strrchr(psz_path, '/');
355 char *psz_uri = NULL;
356 if (p_sys->m3u8.psz_password || p_sys->m3u8.psz_username)
358 if (asprintf(&psz_uri, "%s://%s:%s@%s%s/%s", p_sys->m3u8.psz_protocol,
359 p_sys->m3u8.psz_username, p_sys->m3u8.psz_password,
360 p_sys->m3u8.psz_host, path ? path : psz_path, uri) < 0)
365 if (asprintf(&psz_uri, "%s://%s%s/%s", p_sys->m3u8.psz_protocol,
366 p_sys->m3u8.psz_host, path ? path : psz_path, uri) < 0)
376 static void parse_SegmentInformation(stream_t *s, hls_stream_t *hls, char *p_read, char *uri)
378 stream_sys_t *p_sys = s->p_sys;
383 int ret = sscanf(p_read, "#EXTINF:%d,", &duration);
386 msg_Err(s, "expected #EXTINF:<s>,");
387 p_sys->b_error = true;
391 char *psz_path = strdup(hls->url.psz_path);
392 if (psz_path == NULL)
394 p_sys->b_error = true;
397 char *p = strrchr(psz_path, '/');
399 char *psz_uri = relative_URI(s, uri, psz_path);
402 vlc_mutex_lock(&hls->lock);
403 segment_t *segment = segment_New(hls, duration, psz_uri ? psz_uri : uri);
405 segment->sequence = hls->sequence + vlc_array_count(hls->segments) - 1;
406 if (duration > hls->duration)
408 msg_Err(s, "EXTINF:%d duration is larger then EXT-X-TARGETDURATION:%d",
409 duration, hls->duration);
411 vlc_mutex_unlock(&hls->lock);
416 static void parse_TargetDuration(stream_t *s, hls_stream_t *hls, char *p_read)
418 stream_sys_t *p_sys = s->p_sys;
423 int ret = sscanf(p_read, "#EXT-X-TARGETDURATION:%d", &duration);
426 msg_Err(s, "expected #EXT-X-TARGETDURATION:<s>");
427 p_sys->b_error = true;
431 hls->duration = duration; /* seconds */
434 static void parse_StreamInformation(stream_t *s, vlc_array_t **hls_stream,
435 char *p_read, char *uri)
437 stream_sys_t *p_sys = s->p_sys;
443 attr = parse_Attributes(p_read, "PROGRAM-ID");
446 msg_Err(s, "#EXT-X-STREAM-INF: expected PROGRAM-ID=<value>");
447 p_sys->b_error = true;
453 attr = parse_Attributes(p_read, "BANDWIDTH");
456 msg_Err(s, "#EXT-X-STREAM-INF: expected BANDWIDTH=<value>");
457 p_sys->b_error = true;
465 msg_Err(s, "#EXT-X-STREAM-INF: bandwidth cannot be 0");
466 p_sys->b_error = true;
470 msg_Info(s, "bandwidth adaption detected (program-id=%d, bandwidth=%"PRIu64").", id, bw);
472 char *psz_uri = relative_URI(s, uri, NULL);
474 hls_stream_t *hls = hls_New(*hls_stream, id, bw, psz_uri ? psz_uri : uri);
476 p_sys->b_error = true;
481 static void parse_MediaSequence(stream_t *s, hls_stream_t *hls, char *p_read)
483 stream_sys_t *p_sys = s->p_sys;
488 int ret = sscanf(p_read, "#EXT-X-MEDIA-SEQUENCE:%d", &sequence);
491 msg_Err(s, "expected #EXT-X-MEDIA-SEQUENCE:<s>");
492 p_sys->b_error = true;
496 if (hls->sequence > 0)
497 msg_Err(s, "EXT-X-MEDIA-SEQUENCE already present in playlist");
499 hls->sequence = sequence;
502 static void parse_Key(stream_t *s, hls_stream_t *hls, char *p_read)
504 stream_sys_t *p_sys = s->p_sys;
508 /* #EXT-X-KEY:METHOD=<method>[,URI="<URI>"][,IV=<IV>] */
510 attr = parse_Attributes(p_read, "METHOD");
513 msg_Err(s, "#EXT-X-KEY: expected METHOD=<value>");
514 p_sys->b_error = true;
516 else if (strncasecmp(attr, "NONE", 4) == 0)
518 char *uri = parse_Attributes(p_read, "URI");
521 msg_Err(s, "#EXT-X-KEY: URI not expected");
522 p_sys->b_error = true;
525 /* IV is only supported in version 2 and above */
526 if (hls->version >= 2)
528 char *iv = parse_Attributes(p_read, "IV");
531 msg_Err(s, "#EXT-X-KEY: IV not expected");
532 p_sys->b_error = true;
539 msg_Warn(s, "playback of encrypted HTTP Live media is not supported.");
540 p_sys->b_error = true;
545 static void parse_ProgramDateTime(stream_t *s, hls_stream_t *hls, char *p_read)
548 msg_Dbg(s, "tag not supported: #EXT-X-PROGRAM-DATE-TIME %s", p_read);
551 static void parse_AllowCache(stream_t *s, hls_stream_t *hls, char *p_read)
553 stream_sys_t *p_sys = s->p_sys;
557 char answer[4] = "\0";
558 int ret = sscanf(p_read, "#EXT-X-ALLOW-CACHE:%3s", answer);
561 msg_Err(s, "#EXT-X-ALLOW-CACHE, ignoring ...");
562 p_sys->b_error = true;
566 hls->b_cache = (strncmp(answer, "NO", 2) != 0);
569 static void parse_Version(stream_t *s, hls_stream_t *hls, char *p_read)
571 stream_sys_t *p_sys = s->p_sys;
576 int ret = sscanf(p_read, "#EXT-X-VERSION:%d", &version);
579 msg_Err(s, "#EXT-X-VERSION: no protocol version found, should be version 1.");
580 p_sys->b_error = true;
585 hls->version = version;
586 if (hls->version != 1)
588 msg_Err(s, "#EXT-X-VERSION should be version 1 iso %d", version);
589 p_sys->b_error = true;
593 static void parse_EndList(stream_t *s, hls_stream_t *hls)
595 stream_sys_t *p_sys = s->p_sys;
599 p_sys->b_live = false;
600 msg_Info(s, "video on demand (vod) mode");
603 static void parse_Discontinuity(stream_t *s, hls_stream_t *hls, char *p_read)
607 /* FIXME: Do we need to act on discontinuity ?? */
608 msg_Dbg(s, "#EXT-X-DISCONTINUITY %s", p_read);
611 static void parse_M3U8ExtLine(stream_t *s, hls_stream_t *hls, char *line)
615 if (strncmp(line, "#EXT-X-TARGETDURATION", 21) == 0)
616 parse_TargetDuration(s, hls, line);
617 else if (strncmp(line, "#EXT-X-MEDIA-SEQUENCE", 22) == 0)
618 parse_MediaSequence(s, hls, line);
619 else if (strncmp(line, "#EXT-X-KEY", 11) == 0)
620 parse_Key(s, hls, line);
621 else if (strncmp(line, "#EXT-X-PROGRAM-DATE-TIME", 25) == 0)
622 parse_ProgramDateTime(s, hls, line);
623 else if (strncmp(line, "#EXT-X-ALLOW-CACHE", 17) == 0)
624 parse_AllowCache(s, hls, line);
625 else if (strncmp(line, "#EXT-X-DISCONTINUITY", 20) == 0)
626 parse_Discontinuity(s, hls, line);
627 else if (strncmp(line, "#EXT-X-VERSION", 14) == 0)
628 parse_Version(s, hls, line);
629 else if (strncmp(line, "#EXT-X-ENDLIST", 14) == 0)
630 parse_EndList(s, hls);
634 #define HTTPLIVE_MAX_LINE 4096
635 static int get_HTTPLivePlaylist(stream_t *s, hls_stream_t *hls)
637 stream_sys_t *p_sys = s->p_sys;
639 /* Download new playlist file from server */
640 if (AccessOpen(s, &hls->url) != VLC_SUCCESS)
643 /* Parse the rest of the reply */
644 uint8_t *tmp = calloc(1, HTTPLIVE_MAX_LINE);
651 char *line = AccessReadLine(p_sys->p_access, tmp, HTTPLIVE_MAX_LINE);
652 if (strncmp(line, "#EXTM3U", 7) != 0)
654 msg_Err(s, "missing #EXTM3U tag");
662 line = AccessReadLine(p_sys->p_access, tmp, HTTPLIVE_MAX_LINE);
665 msg_Dbg(s, "end of data");
669 if (!vlc_object_alive(s))
672 /* some more checks for actual data */
673 if (strncmp(line, "#EXTINF", 7) == 0)
675 char *uri = AccessReadLine(p_sys->p_access, tmp, HTTPLIVE_MAX_LINE);
677 p_sys->b_error = true;
680 parse_SegmentInformation(s, hls, line, uri);
686 parse_M3U8ExtLine(s, hls, line);
689 /* Error during m3u8 parsing abort */
707 #undef HTTPLIVE_MAX_LINE
709 /* The http://tools.ietf.org/html/draft-pantos-http-live-streaming-04#page-8
710 * document defines the following new tags: EXT-X-TARGETDURATION,
711 * EXT-X-MEDIA-SEQUENCE, EXT-X-KEY, EXT-X-PROGRAM-DATE-TIME, EXT-X-
712 * ALLOW-CACHE, EXT-X-STREAM-INF, EXT-X-ENDLIST, EXT-X-DISCONTINUITY,
715 static int parse_HTTPLiveStreaming(stream_t *s)
717 stream_sys_t *p_sys = s->p_sys;
718 char *p_read, *p_begin, *p_end;
720 assert(p_sys->hls_stream);
722 p_begin = p_read = stream_ReadLine(s->p_source);
727 int i_len = strlen(p_begin);
728 p_end = p_read + i_len;
730 if (strncmp(p_read, "#EXTM3U", 7) != 0)
732 msg_Err(s, "missing #EXTM3U tag .. aborting");
744 p_begin = stream_ReadLine(s->p_source);
748 i_len = strlen(p_begin);
750 p_end = p_read + i_len;
752 if (strncmp(p_read, "#EXT-X-STREAM-INF", 17) == 0)
754 p_sys->b_meta = true;
755 char *uri = stream_ReadLine(s->p_source);
757 p_sys->b_error = true;
760 parse_StreamInformation(s, &p_sys->hls_stream, p_read, uri);
764 else if (strncmp(p_read, "#EXTINF", 7) == 0)
766 char *uri = stream_ReadLine(s->p_source);
768 p_sys->b_error = true;
771 hls_stream_t *hls = hls_GetLast(p_sys->hls_stream);
773 parse_SegmentInformation(s, hls, p_read, uri);
775 p_sys->b_error = true;
781 hls_stream_t *hls = hls_GetLast(p_sys->hls_stream);
786 hls = hls_New(p_sys->hls_stream, -1, -1, NULL);
789 p_sys->b_error = true;
794 /* Parse M3U8 Ext Line */
795 parse_M3U8ExtLine(s, hls, p_read);
797 } while(p_read < p_end);
802 int count = vlc_array_count(p_sys->hls_stream);
803 for (int n = 0; n < count; n++)
805 hls_stream_t *hls = hls_Get(p_sys->hls_stream, n);
806 if (hls == NULL) break;
808 /* Is it a meta playlist? */
811 msg_Dbg(s, "parsing %s", hls->url.psz_path);
812 if (get_HTTPLivePlaylist(s, hls) != VLC_SUCCESS)
814 msg_Err(s, "could not parse playlist file from meta index." );
819 vlc_mutex_lock(&hls->lock);
823 /* There should at least be 3 segments of hls->duration */
825 int num = vlc_array_count(hls->segments);
826 for (int i = 0; i < num; i++)
828 segment_t *segment = segment_GetSegment(hls, i);
829 if (segment && segment->duration >= hls->duration)
834 msg_Err(s, "cannot start live playback at this time, try again later.");
835 vlc_mutex_unlock(&hls->lock);
841 /* Stream size (approximate) */
842 hls->size = hls_GetStreamSize(hls);
844 vlc_mutex_unlock(&hls->lock);
850 /****************************************************************************
852 ****************************************************************************/
853 static int BandwidthAdaptation(stream_t *s, int progid, uint64_t *bandwidth)
855 stream_sys_t *p_sys = s->p_sys;
857 uint64_t bw = *bandwidth;
858 uint64_t bw_candidate = 0;
860 int count = vlc_array_count(p_sys->hls_stream);
861 for (int n = 0; n < count; n++)
863 /* Select best bandwidth match */
864 hls_stream_t *hls = hls_Get(p_sys->hls_stream, n);
865 if (hls == NULL) break;
867 /* only consider streams with the same PROGRAM-ID */
868 if (hls->id == progid)
870 if ((bw >= hls->bandwidth) && (bw_candidate < hls->bandwidth))
872 msg_Dbg(s, "candidate %d bandwidth (bits/s) %"PRIu64" >= %"PRIu64,
873 n, bw, hls->bandwidth); /* bits / s */
874 bw_candidate = hls->bandwidth;
875 candidate = n; /* possible candidate */
879 *bandwidth = bw_candidate;
883 static int Download(stream_t *s, hls_stream_t *hls, segment_t *segment, int *cur_stream)
888 vlc_mutex_lock(&segment->lock);
889 if (segment->data != NULL)
891 /* Segment already downloaded */
892 vlc_mutex_unlock(&segment->lock);
896 /* sanity check - can we download this segment on time? */
897 if (s->p_sys->bandwidth > 0)
899 uint64_t size = (segment->duration * hls->bandwidth); /* bits */
900 int estimated = (int)(size / s->p_sys->bandwidth);
901 if (estimated > segment->duration)
903 msg_Err(s, "cannot quarantee smooth playback");
904 msg_Warn(s,"downloading of segment %d takes %ds, which is longer then its playback (%ds)",
905 segment->sequence, estimated, segment->duration);
906 vlc_mutex_unlock(&segment->lock);
911 mtime_t start = mdate();
912 if (AccessDownload(s, segment) != VLC_SUCCESS)
914 vlc_mutex_unlock(&segment->lock);
917 mtime_t duration = mdate() - start;
919 vlc_mutex_unlock(&segment->lock);
921 msg_Info(s, "downloaded segment %d from stream %d",
922 segment->sequence, *cur_stream);
924 /* check for division by zero */
925 double ms = (double)duration / 1000.0; /* ms */
929 uint64_t bw = ((double)(segment->size * 8) / ms) * 1000; /* bits / s */
930 s->p_sys->bandwidth = bw;
931 if (hls->bandwidth != bw)
933 int newstream = BandwidthAdaptation(s, hls->id, &bw);
935 /* FIXME: we need an average here */
936 if ((newstream >= 0) && (newstream != *cur_stream))
938 msg_Info(s, "detected %s bandwidth (%"PRIu64") stream",
939 (bw >= hls->bandwidth) ? "faster" : "lower", bw);
940 *cur_stream = newstream;
946 static void* hls_Thread(vlc_object_t *p_this)
948 hls_thread_t *client = (hls_thread_t *) p_this;
949 stream_t *s = client->s;
950 stream_sys_t *p_sys = s->p_sys;
952 int canc = vlc_savecancel();
954 while (vlc_object_alive(p_this))
956 hls_stream_t *hls = hls_Get(client->hls_stream, client->current);
959 /* Sliding window (~60 seconds worth of movie) */
960 vlc_mutex_lock(&hls->lock);
961 int count = vlc_array_count(hls->segments);
962 vlc_mutex_unlock(&hls->lock);
964 /* Is there a new segment to process? */
965 if ((p_sys->playback.segment < (count - 6)) ||
966 (client->segment >= count))
969 vlc_mutex_lock(&client->lock_wait);
970 while (((client->segment - p_sys->playback.segment > 6) ||
971 (client->segment >= count)) &&
972 (client->seek == -1))
974 vlc_cond_wait(&client->wait, &client->lock_wait);
975 if (!vlc_object_alive(p_this)) break;
978 if (client->seek >= 0)
980 client->segment = client->seek;
983 vlc_mutex_unlock(&client->lock_wait);
986 if (!vlc_object_alive(p_this)) break;
988 vlc_mutex_lock(&hls->lock);
989 segment_t *segment = segment_GetSegment(hls, client->segment);
991 vlc_mutex_unlock(&hls->lock);
993 if (Download(client->s, hls, segment, &client->current) != VLC_SUCCESS)
997 p_sys->b_error = true;
1002 /* download succeeded */
1003 /* determine next segment to download */
1004 vlc_mutex_lock(&client->lock_wait);
1005 if (client->seek >= 0)
1007 client->segment = client->seek;
1010 else if (client->segment < count)
1012 vlc_cond_signal(&client->wait);
1013 vlc_mutex_unlock(&client->lock_wait);
1015 /* FIXME: Reread the m3u8 index file */
1019 mtime_t now = mdate();
1020 if (now >= p_sys->playlist.wakeup)
1023 /** FIXME: Implement m3u8 playlist reloading */
1024 if (!hls_ReloadPlaylist(client->s))
1026 /* No change in playlist, then backoff */
1027 p_sys->playlist.tries++;
1028 if (p_sys->playlist.tries == 1) wait = 0.5;
1029 else if (p_sys->playlist.tries == 2) wait = 1;
1030 else if (p_sys->playlist.tries >= 3) wait = 3;
1033 /* determine next time to update playlist */
1034 p_sys->playlist.last = now;
1035 p_sys->playlist.wakeup = now + ((mtime_t)(hls->duration * wait) * (mtime_t)1000000);
1040 vlc_restorecancel(canc);
1044 static int Prefetch(stream_t *s, int *current)
1046 stream_sys_t *p_sys = s->p_sys;
1049 /* Try to pick best matching stream */
1053 hls_stream_t *hls = hls_Get(p_sys->hls_stream, *current);
1055 return VLC_EGENERIC;
1057 segment_t *segment = segment_GetSegment(hls, p_sys->playback.segment);
1058 if (segment == NULL )
1059 return VLC_EGENERIC;
1061 if (Download(s, hls, segment, current) != VLC_SUCCESS)
1062 return VLC_EGENERIC;
1064 /* Found better bandwidth match, try again */
1065 if (*current != stream)
1068 /* Download first 2 segments of this HLS stream */
1070 for (int i = 0; i < 2; i++)
1072 segment_t *segment = segment_GetSegment(hls, i);
1073 if (segment == NULL )
1074 return VLC_EGENERIC;
1078 p_sys->playback.segment++;
1082 if (Download(s, hls, segment, current) != VLC_SUCCESS)
1083 return VLC_EGENERIC;
1085 p_sys->playback.segment++;
1087 /* adapt bandwidth? */
1088 if (*current != stream)
1090 hls_stream_t *hls = hls_Get(p_sys->hls_stream, *current);
1092 return VLC_EGENERIC;
1101 /****************************************************************************
1103 ****************************************************************************/
1104 static int AccessOpen(stream_t *s, vlc_url_t *url)
1106 stream_sys_t *p_sys = (stream_sys_t *) s->p_sys;
1108 if ((url->psz_protocol == NULL) ||
1109 (url->psz_path == NULL))
1110 return VLC_EGENERIC;
1112 p_sys->p_access = vlc_object_create(s, sizeof(access_t));
1113 if (p_sys->p_access == NULL)
1116 p_sys->p_access->psz_access = strdup(url->psz_protocol);
1117 p_sys->p_access->psz_filepath = strdup(url->psz_path);
1118 if (url->psz_password || url->psz_username)
1120 if (asprintf(&p_sys->p_access->psz_location, "%s:%s@%s%s",
1121 url->psz_username, url->psz_password,
1122 url->psz_host, url->psz_path) < 0)
1124 msg_Err(s, "creating http access module");
1130 if (asprintf(&p_sys->p_access->psz_location, "%s%s",
1131 url->psz_host, url->psz_path) < 0)
1133 msg_Err(s, "creating http access module");
1137 vlc_object_attach(p_sys->p_access, s);
1138 p_sys->p_access->p_module =
1139 module_need(p_sys->p_access, "access", "http", true);
1140 if (p_sys->p_access->p_module == NULL)
1142 msg_Err(s, "could not load http access module");
1149 vlc_object_release(p_sys->p_access);
1150 p_sys->p_access = NULL;
1151 return VLC_EGENERIC;
1154 static void AccessClose(stream_t *s)
1156 stream_sys_t *p_sys = (stream_sys_t *) s->p_sys;
1158 if (p_sys->p_access)
1160 vlc_object_kill(p_sys->p_access);
1161 free(p_sys->p_access->psz_access);
1162 if (p_sys->p_access->p_module)
1163 module_unneed(p_sys->p_access,
1164 p_sys->p_access->p_module);
1166 vlc_object_release(p_sys->p_access);
1167 p_sys->p_access = NULL;
1171 static char *AccessReadLine(access_t *p_access, uint8_t *psz_tmp, size_t i_len)
1174 char *begin = (char *)psz_tmp;
1178 int skip = strlen(begin);
1179 ssize_t len = p_access->pf_read(p_access, psz_tmp + skip, i_len - skip);
1180 if (len < 0) return NULL;
1181 if ((len == 0) && (skip == 0))
1185 char *end = p + len + skip;
1195 /* copy line excluding \n */
1196 line = strndup(begin, p - begin);
1201 psz_tmp = memmove(begin, p, end - p);
1202 psz_tmp[end - p] = '\0';
1204 else memset(psz_tmp, 0, i_len);
1209 static int AccessDownload(stream_t *s, segment_t *segment)
1211 stream_sys_t *p_sys = (stream_sys_t *) s->p_sys;
1215 /* Download new playlist file from server */
1216 if (AccessOpen(s, &segment->url) != VLC_SUCCESS)
1217 return VLC_EGENERIC;
1219 segment->size = p_sys->p_access->info.i_size;
1220 assert(segment->size > 0);
1222 segment->data = block_Alloc(segment->size);
1223 if (segment->data == NULL)
1229 assert(segment->data->i_buffer == segment->size);
1231 ssize_t length = 0, curlen = 0;
1234 if (p_sys->p_access->info.i_size > segment->size)
1236 msg_Dbg(s, "size changed %"PRIu64, segment->size);
1237 segment->data = block_Realloc(segment->data, 0, p_sys->p_access->info.i_size);
1238 if (segment->data == NULL)
1243 segment->size = p_sys->p_access->info.i_size;
1244 assert(segment->data->i_buffer == segment->size);
1246 length = p_sys->p_access->pf_read(p_sys->p_access,
1247 segment->data->p_buffer + curlen, segment->size - curlen);
1248 if ((length <= 0) || ((uint64_t)length >= segment->size))
1251 } while (vlc_object_alive(s));
1257 /****************************************************************************
1259 ****************************************************************************/
1260 static int Open(vlc_object_t *p_this)
1262 stream_t *s = (stream_t*)p_this;
1263 stream_sys_t *p_sys;
1265 if (!isHTTPLiveStreaming(s))
1266 return VLC_EGENERIC;
1268 msg_Info(p_this, "HTTP Live Streaming (%s)", s->psz_path);
1271 s->p_sys = p_sys = calloc(1, sizeof(*p_sys));
1275 char *psz_uri = NULL;
1276 if (asprintf(&psz_uri,"%s://%s", s->psz_access, s->psz_path) < 0)
1281 vlc_UrlParse(&p_sys->m3u8, psz_uri, 0);
1284 p_sys->bandwidth = -1;
1285 p_sys->b_live = true;
1286 p_sys->b_meta = false;
1287 p_sys->b_error = false;
1289 p_sys->hls_stream = vlc_array_new();
1290 if (p_sys->hls_stream == NULL)
1299 s->pf_control = Control;
1301 /* Select first segment to play */
1302 if (parse_HTTPLiveStreaming(s) != VLC_SUCCESS)
1307 /* Choose first HLS stream to start with */
1308 int current = p_sys->playback.current = 0;
1309 p_sys->playback.segment = 0;
1311 if (Prefetch(s, ¤t) != VLC_SUCCESS)
1313 msg_Err(s, "fetching first segment.");
1317 p_sys->thread = vlc_object_create(s, sizeof(hls_thread_t));
1318 if( p_sys->thread == NULL )
1320 msg_Err(s, "creating HTTP Live Streaming client thread");
1324 /* Initialize HLS live stream */
1327 hls_stream_t *hls = hls_Get(p_sys->hls_stream, current);
1328 p_sys->playlist.last = mdate();
1329 p_sys->playlist.wakeup = p_sys->playlist.last +
1330 ((mtime_t)hls->duration * UINT64_C(1000000));
1333 p_sys->thread->hls_stream = p_sys->hls_stream;
1334 p_sys->thread->current = current;
1335 p_sys->playback.current = current;
1336 p_sys->thread->segment = p_sys->playback.segment;
1337 p_sys->thread->seek = -1;
1338 p_sys->playback.segment = 0; /* reset to first segment */
1339 p_sys->thread->s = s;
1341 vlc_mutex_init(&p_sys->thread->lock_wait);
1342 vlc_cond_init(&p_sys->thread->wait);
1344 if (vlc_thread_create(p_sys->thread, "HTTP Live Streaming client",
1345 hls_Thread, VLC_THREAD_PRIORITY_INPUT))
1350 vlc_object_attach(p_sys->thread, s);
1356 return VLC_EGENERIC;
1359 /****************************************************************************
1361 ****************************************************************************/
1362 static void Close(vlc_object_t *p_this)
1364 stream_t *s = (stream_t*)p_this;
1365 stream_sys_t *p_sys = s->p_sys;
1367 assert(p_sys->hls_stream);
1372 vlc_mutex_lock(&p_sys->thread->lock_wait);
1373 vlc_object_kill(p_sys->thread);
1374 vlc_cond_signal(&p_sys->thread->wait);
1375 vlc_mutex_unlock(&p_sys->thread->lock_wait);
1378 vlc_thread_join(p_sys->thread);
1379 vlc_mutex_destroy(&p_sys->thread->lock_wait);
1380 vlc_cond_destroy(&p_sys->thread->wait);
1381 vlc_object_release(p_sys->thread);
1384 /* Free hls streams */
1385 for (int i = 0; i < vlc_array_count(p_sys->hls_stream); i++)
1388 hls = (hls_stream_t *)vlc_array_item_at_index(p_sys->hls_stream, i);
1389 if (hls) hls_Free(hls);
1391 vlc_array_destroy(p_sys->hls_stream);
1394 vlc_UrlClean(&p_sys->m3u8);
1398 /****************************************************************************
1399 * Stream filters functions
1400 ****************************************************************************/
1401 static segment_t *GetSegment(stream_t *s)
1403 stream_sys_t *p_sys = s->p_sys;
1404 segment_t *segment = NULL;
1406 /* Is this segment of the current HLS stream ready? */
1407 hls_stream_t *hls = hls_Get(p_sys->hls_stream, p_sys->playback.current);
1410 vlc_mutex_lock(&hls->lock);
1411 segment = segment_GetSegment(hls, p_sys->playback.segment);
1412 if (segment != NULL)
1414 /* This segment is ready? */
1415 if (segment->data != NULL)
1417 p_sys->b_cache = hls->b_cache;
1418 vlc_mutex_unlock(&hls->lock);
1422 vlc_mutex_unlock(&hls->lock);
1425 /* Was the HLS stream changed to another bitrate? */
1428 while(vlc_object_alive(s))
1430 /* Is the next segment ready */
1431 hls_stream_t *hls = hls_Get(p_sys->hls_stream, i_stream);
1435 vlc_mutex_lock(&hls->lock);
1436 segment = segment_GetSegment(hls, p_sys->playback.segment);
1437 if (segment == NULL)
1439 vlc_mutex_unlock(&hls->lock);
1443 vlc_mutex_lock(&p_sys->thread->lock_wait);
1444 int i_segment = p_sys->thread->segment;
1445 vlc_mutex_unlock(&p_sys->thread->lock_wait);
1447 /* This segment is ready? */
1448 if ((segment->data != NULL) &&
1449 (p_sys->playback.segment < i_segment))
1451 p_sys->playback.current = i_stream;
1452 p_sys->b_cache = hls->b_cache;
1453 vlc_mutex_unlock(&hls->lock);
1456 vlc_mutex_unlock(&hls->lock);
1461 /* Was the stream changed to another bitrate? */
1463 if (i_stream >= vlc_array_count(p_sys->hls_stream))
1470 static ssize_t hls_Read(stream_t *s, uint8_t *p_read, unsigned int i_read)
1472 stream_sys_t *p_sys = s->p_sys;
1477 /* Determine next segment to read. If this is a meta playlist and
1478 * bandwidth conditions changed, then the stream might have switched
1479 * to another bandwidth. */
1480 segment_t *segment = GetSegment(s);
1481 if (segment == NULL)
1484 vlc_mutex_lock(&segment->lock);
1485 if (segment->data->i_buffer == 0)
1487 if (!p_sys->b_cache || p_sys->b_live)
1489 block_Release(segment->data);
1490 segment->data = NULL;
1493 { /* reset playback pointer to start of buffer */
1494 uint64_t size = segment->size - segment->data->i_buffer;
1497 segment->data->i_buffer += size;
1498 segment->data->p_buffer -= size;
1501 p_sys->playback.segment++;
1502 vlc_mutex_unlock(&segment->lock);
1504 /* signal download thread */
1505 vlc_mutex_lock(&p_sys->thread->lock_wait);
1506 vlc_cond_signal(&p_sys->thread->wait);
1507 vlc_mutex_unlock(&p_sys->thread->lock_wait);
1511 if (segment->size == segment->data->i_buffer)
1512 msg_Info(s, "playing segment %d from stream %d",
1513 p_sys->playback.segment, p_sys->playback.current);
1516 if (i_read <= segment->data->i_buffer)
1518 else if (i_read > segment->data->i_buffer)
1519 len = segment->data->i_buffer;
1523 memcpy(p_read + copied, segment->data->p_buffer, len);
1524 segment->data->i_buffer -= len;
1525 segment->data->p_buffer += len;
1529 vlc_mutex_unlock(&segment->lock);
1531 } while ((i_read > 0) && vlc_object_alive(s));
1536 static int Read(stream_t *s, void *buffer, unsigned int i_read)
1538 stream_sys_t *p_sys = s->p_sys;
1541 assert(p_sys->hls_stream);
1548 /* caller skips data, get big enough buffer */
1549 msg_Warn(s, "buffer is NULL (allocate %d)", i_read);
1550 buffer = calloc(1, i_read);
1552 return 0; /* NO MEMORY left*/
1555 length = hls_Read(s, (uint8_t*) buffer, i_read);
1559 p_sys->playback.offset += length;
1563 static int Peek(stream_t *s, const uint8_t **pp_peek, unsigned int i_peek)
1565 stream_sys_t *p_sys = s->p_sys;
1570 segment = GetSegment(s);
1571 if (segment == NULL)
1573 msg_Err(s, "segment %d should have been available (stream %d)",
1574 p_sys->playback.segment, p_sys->playback.current);
1575 return 0; /* eof? */
1578 vlc_mutex_lock(&segment->lock);
1580 /* remember segment to peek */
1581 int peek_segment = p_sys->playback.segment;
1584 if (i_peek < segment->data->i_buffer)
1586 *pp_peek = segment->data->p_buffer;
1591 p_sys->playback.segment++;
1592 vlc_mutex_unlock(&segment->lock);
1595 } while ((curlen < i_peek) && vlc_object_alive(s));
1597 /* restore segment to read */
1598 p_sys->playback.segment = peek_segment;
1600 vlc_mutex_unlock(&segment->lock);
1605 static bool hls_MaySeek(stream_t *s)
1607 stream_sys_t *p_sys = s->p_sys;
1609 if ((p_sys->hls_stream == NULL) ||
1610 (p_sys->thread == NULL))
1613 hls_stream_t *hls = hls_Get(p_sys->hls_stream, p_sys->playback.current);
1614 if (hls == NULL) return false;
1618 vlc_mutex_lock(&hls->lock);
1619 int count = vlc_array_count(hls->segments);
1620 vlc_mutex_unlock(&hls->lock);
1622 vlc_mutex_lock(&p_sys->thread->lock_wait);
1623 bool may_seek = (p_sys->thread->segment < (count - 2));
1624 vlc_mutex_unlock(&p_sys->thread->lock_wait);
1630 static uint64_t GetStreamSize(stream_t *s)
1632 stream_sys_t *p_sys = s->p_sys;
1637 hls_stream_t *hls = hls_Get(p_sys->hls_stream, p_sys->playback.current);
1638 if (hls == NULL) return 0;
1640 vlc_mutex_lock(&hls->lock);
1641 uint64_t size = hls->size;
1642 vlc_mutex_unlock(&hls->lock);
1647 static int segment_Seek(stream_t *s, uint64_t pos)
1649 stream_sys_t *p_sys = s->p_sys;
1651 hls_stream_t *hls = hls_Get(p_sys->hls_stream, p_sys->playback.current);
1653 return VLC_EGENERIC;
1655 vlc_mutex_lock(&hls->lock);
1657 bool b_found = false;
1658 uint64_t length = 0;
1659 uint64_t size = hls->size;
1660 int count = vlc_array_count(hls->segments);
1662 for (int n = 0; n < count; n++)
1664 segment_t *segment = vlc_array_item_at_index(hls->segments, n);
1665 if (segment == NULL)
1667 vlc_mutex_unlock(&hls->lock);
1668 return VLC_EGENERIC;
1671 vlc_mutex_lock(&segment->lock);
1672 length += segment->duration * (hls->bandwidth/8);
1673 vlc_mutex_unlock(&segment->lock);
1675 if (!b_found && (pos <= length))
1679 p_sys->playback.segment = n;
1683 /* Do not search in last 3 segments */
1684 vlc_mutex_unlock(&hls->lock);
1685 return VLC_EGENERIC;
1690 if (!b_found && (pos >= size))
1692 p_sys->playback.segment = count - 1;
1699 /* restore segment to start position */
1700 segment_t *segment = segment_GetSegment(hls, p_sys->playback.segment);
1701 if (segment == NULL)
1703 vlc_mutex_unlock(&hls->lock);
1704 return VLC_EGENERIC;
1707 vlc_mutex_lock(&segment->lock);
1710 uint64_t size = segment->size -segment->data->i_buffer;
1713 segment->data->i_buffer += size;
1714 segment->data->p_buffer -= size;
1717 vlc_mutex_unlock(&segment->lock);
1719 /* start download at current playback segment */
1722 vlc_mutex_unlock(&hls->lock);
1724 /* Wake up download thread */
1725 vlc_mutex_lock(&p_sys->thread->lock_wait);
1726 p_sys->thread->seek = p_sys->playback.segment;
1727 vlc_cond_signal(&p_sys->thread->wait);
1728 vlc_mutex_unlock(&p_sys->thread->lock_wait);
1730 /* Wait for download to be finished */
1731 vlc_mutex_lock(&p_sys->thread->lock_wait);
1732 msg_Info(s, "seek to segment %d", p_sys->playback.segment);
1733 while (((p_sys->thread->seek != -1) ||
1734 (p_sys->thread->segment - p_sys->playback.segment < 3)) &&
1735 (p_sys->thread->segment < (count - 6)))
1737 vlc_cond_wait(&p_sys->thread->wait, &p_sys->thread->lock_wait);
1738 if (!vlc_object_alive(s) || s->b_error) break;
1740 vlc_mutex_unlock(&p_sys->thread->lock_wait);
1745 vlc_mutex_unlock(&hls->lock);
1747 return b_found ? VLC_SUCCESS : VLC_EGENERIC;
1750 static int Control(stream_t *s, int i_query, va_list args)
1752 stream_sys_t *p_sys = s->p_sys;
1756 case STREAM_CAN_SEEK:
1757 case STREAM_CAN_FASTSEEK:
1758 *(va_arg (args, bool *)) = hls_MaySeek(s);
1760 case STREAM_GET_POSITION:
1761 *(va_arg (args, uint64_t *)) = p_sys->playback.offset;
1763 case STREAM_SET_POSITION:
1766 uint64_t pos = (uint64_t)va_arg(args, uint64_t);
1767 if (segment_Seek(s, pos) == VLC_SUCCESS)
1769 p_sys->playback.offset = pos;
1773 return VLC_EGENERIC;
1774 case STREAM_GET_SIZE:
1775 *(va_arg (args, uint64_t *)) = GetStreamSize(s);
1778 return VLC_EGENERIC;