2 * Apple HTTP Live Streaming Protocol Handler
3 * Copyright (c) 2010 Martin Storsjo
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * Apple HTTP Live Streaming Protocol Handler
25 * http://tools.ietf.org/html/draft-pantos-http-live-streaming
28 #include "libavutil/avstring.h"
29 #include "libavutil/time.h"
31 #include "avio_internal.h"
37 * An apple http stream consists of a playlist with media segment files,
38 * played sequentially. There may be several playlists with the same
39 * video content, in different bandwidth variants, that are played in
40 * parallel (preferably only one bandwidth variant at a time). In this case,
41 * the user supplied the url to a main playlist that only lists the variant
44 * If the main playlist doesn't point at any variants, we still create
45 * one anonymous toplevel variant for this, to maintain the structure.
50 char url[MAX_URL_SIZE];
55 char url[MAX_URL_SIZE];
58 typedef struct HLSContext {
59 char playlisturl[MAX_URL_SIZE];
60 int64_t target_duration;
64 struct segment **segments;
66 struct variant **variants;
69 int64_t last_load_time;
72 static int read_chomp_line(AVIOContext *s, char *buf, int maxlen)
74 int len = ff_get_line(s, buf, maxlen);
75 while (len > 0 && av_isspace(buf[len - 1]))
80 static void free_segment_list(HLSContext *s)
83 for (i = 0; i < s->n_segments; i++)
84 av_freep(&s->segments[i]);
85 av_freep(&s->segments);
89 static void free_variant_list(HLSContext *s)
92 for (i = 0; i < s->n_variants; i++)
93 av_freep(&s->variants[i]);
94 av_freep(&s->variants);
102 static void handle_variant_args(struct variant_info *info, const char *key,
103 int key_len, char **dest, int *dest_len)
105 if (!strncmp(key, "BANDWIDTH=", key_len)) {
106 *dest = info->bandwidth;
107 *dest_len = sizeof(info->bandwidth);
111 static int parse_playlist(URLContext *h, const char *url)
113 HLSContext *s = h->priv_data;
115 int ret = 0, is_segment = 0, is_variant = 0, bandwidth = 0;
116 int64_t duration = 0;
120 if ((ret = ffio_open_whitelist(&in, url, AVIO_FLAG_READ,
121 &h->interrupt_callback, NULL,
122 h->protocol_whitelist, h->protocol_blacklist)) < 0)
125 read_chomp_line(in, line, sizeof(line));
126 if (strcmp(line, "#EXTM3U")) {
127 ret = AVERROR_INVALIDDATA;
131 free_segment_list(s);
133 while (!avio_feof(in)) {
134 read_chomp_line(in, line, sizeof(line));
135 if (av_strstart(line, "#EXT-X-STREAM-INF:", &ptr)) {
136 struct variant_info info = {{0}};
138 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_variant_args,
140 bandwidth = atoi(info.bandwidth);
141 } else if (av_strstart(line, "#EXT-X-TARGETDURATION:", &ptr)) {
142 s->target_duration = atoi(ptr) * AV_TIME_BASE;
143 } else if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
144 s->start_seq_no = atoi(ptr);
145 } else if (av_strstart(line, "#EXT-X-ENDLIST", &ptr)) {
147 } else if (av_strstart(line, "#EXTINF:", &ptr)) {
149 duration = atof(ptr) * AV_TIME_BASE;
150 } else if (av_strstart(line, "#", NULL)) {
152 } else if (line[0]) {
154 struct segment *seg = av_malloc(sizeof(struct segment));
156 ret = AVERROR(ENOMEM);
159 seg->duration = duration;
160 ff_make_absolute_url(seg->url, sizeof(seg->url), url, line);
161 dynarray_add(&s->segments, &s->n_segments, seg);
163 } else if (is_variant) {
164 struct variant *var = av_malloc(sizeof(struct variant));
166 ret = AVERROR(ENOMEM);
169 var->bandwidth = bandwidth;
170 ff_make_absolute_url(var->url, sizeof(var->url), url, line);
171 dynarray_add(&s->variants, &s->n_variants, var);
176 s->last_load_time = av_gettime_relative();
183 static int hls_close(URLContext *h)
185 HLSContext *s = h->priv_data;
187 free_segment_list(s);
188 free_variant_list(s);
189 ffurl_close(s->seg_hd);
193 static int hls_open(URLContext *h, const char *uri, int flags)
195 HLSContext *s = h->priv_data;
197 const char *nested_url;
199 if (flags & AVIO_FLAG_WRITE)
200 return AVERROR(ENOSYS);
204 if (av_strstart(uri, "hls+", &nested_url)) {
205 av_strlcpy(s->playlisturl, nested_url, sizeof(s->playlisturl));
206 } else if (av_strstart(uri, "hls://", &nested_url)) {
207 av_log(h, AV_LOG_ERROR,
208 "No nested protocol specified. Specify e.g. hls+http://%s\n",
210 ret = AVERROR(EINVAL);
213 av_log(h, AV_LOG_ERROR, "Unsupported url %s\n", uri);
214 ret = AVERROR(EINVAL);
217 av_log(h, AV_LOG_WARNING,
218 "Using the hls protocol is discouraged, please try using the "
219 "hls demuxer instead. The hls demuxer should be more complete "
220 "and work as well as the protocol implementation. (If not, "
221 "please report it.) To use the demuxer, simply use %s as url.\n",
224 if ((ret = parse_playlist(h, s->playlisturl)) < 0)
227 if (s->n_segments == 0 && s->n_variants > 0) {
228 int max_bandwidth = 0, maxvar = -1;
229 for (i = 0; i < s->n_variants; i++) {
230 if (s->variants[i]->bandwidth > max_bandwidth || i == 0) {
231 max_bandwidth = s->variants[i]->bandwidth;
235 av_strlcpy(s->playlisturl, s->variants[maxvar]->url,
236 sizeof(s->playlisturl));
237 if ((ret = parse_playlist(h, s->playlisturl)) < 0)
241 if (s->n_segments == 0) {
242 av_log(h, AV_LOG_WARNING, "Empty playlist\n");
246 s->cur_seq_no = s->start_seq_no;
247 if (!s->finished && s->n_segments >= 3)
248 s->cur_seq_no = s->start_seq_no + s->n_segments - 3;
257 static int hls_read(URLContext *h, uint8_t *buf, int size)
259 HLSContext *s = h->priv_data;
262 int64_t reload_interval;
266 ret = ffurl_read(s->seg_hd, buf, size);
271 ffurl_close(s->seg_hd);
275 reload_interval = s->n_segments > 0 ?
276 s->segments[s->n_segments - 1]->duration :
280 int64_t now = av_gettime_relative();
281 if (now - s->last_load_time >= reload_interval) {
282 if ((ret = parse_playlist(h, s->playlisturl)) < 0)
284 /* If we need to reload the playlist again below (if
285 * there's still no more segments), switch to a reload
286 * interval of half the target duration. */
287 reload_interval = s->target_duration / 2;
290 if (s->cur_seq_no < s->start_seq_no) {
291 av_log(h, AV_LOG_WARNING,
292 "skipping %d segments ahead, expired from playlist\n",
293 s->start_seq_no - s->cur_seq_no);
294 s->cur_seq_no = s->start_seq_no;
296 if (s->cur_seq_no - s->start_seq_no >= s->n_segments) {
299 while (av_gettime_relative() - s->last_load_time < reload_interval) {
300 if (ff_check_interrupt(&h->interrupt_callback))
306 url = s->segments[s->cur_seq_no - s->start_seq_no]->url,
307 av_log(h, AV_LOG_DEBUG, "opening %s\n", url);
308 ret = ffurl_open_whitelist(&s->seg_hd, url, AVIO_FLAG_READ,
309 &h->interrupt_callback, NULL,
310 h->protocol_whitelist, h->protocol_blacklist, h);
312 if (ff_check_interrupt(&h->interrupt_callback))
314 av_log(h, AV_LOG_WARNING, "Unable to open %s\n", url);
321 const URLProtocol ff_hls_protocol = {
323 .url_open = hls_open,
324 .url_read = hls_read,
325 .url_close = hls_close,
326 .flags = URL_PROTOCOL_FLAG_NESTED_SCHEME,
327 .priv_data_size = sizeof(HLSContext),