libavformat: Rename the applehttp protocol to hls
[ffmpeg.git] / libavformat / hlsproto.c
1 /*
2  * Apple HTTP Live Streaming Protocol Handler
3  * Copyright (c) 2010 Martin Storsjo
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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.
11  *
12  * Libav 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.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * Apple HTTP Live Streaming Protocol Handler
25  * http://tools.ietf.org/html/draft-pantos-http-live-streaming
26  */
27
28 #include "libavutil/avstring.h"
29 #include "avformat.h"
30 #include "internal.h"
31 #include "url.h"
32 #include "version.h"
33 #include <unistd.h>
34
35 /*
36  * An apple http stream consists of a playlist with media segment files,
37  * played sequentially. There may be several playlists with the same
38  * video content, in different bandwidth variants, that are played in
39  * parallel (preferrably only one bandwidth variant at a time). In this case,
40  * the user supplied the url to a main playlist that only lists the variant
41  * playlists.
42  *
43  * If the main playlist doesn't point at any variants, we still create
44  * one anonymous toplevel variant for this, to maintain the structure.
45  */
46
47 struct segment {
48     int duration;
49     char url[MAX_URL_SIZE];
50 };
51
52 struct variant {
53     int bandwidth;
54     char url[MAX_URL_SIZE];
55 };
56
57 typedef struct AppleHTTPContext {
58     char playlisturl[MAX_URL_SIZE];
59     int target_duration;
60     int start_seq_no;
61     int finished;
62     int n_segments;
63     struct segment **segments;
64     int n_variants;
65     struct variant **variants;
66     int cur_seq_no;
67     URLContext *seg_hd;
68     int64_t last_load_time;
69 } AppleHTTPContext;
70
71 static int read_chomp_line(AVIOContext *s, char *buf, int maxlen)
72 {
73     int len = ff_get_line(s, buf, maxlen);
74     while (len > 0 && isspace(buf[len - 1]))
75         buf[--len] = '\0';
76     return len;
77 }
78
79 static void free_segment_list(AppleHTTPContext *s)
80 {
81     int i;
82     for (i = 0; i < s->n_segments; i++)
83         av_free(s->segments[i]);
84     av_freep(&s->segments);
85     s->n_segments = 0;
86 }
87
88 static void free_variant_list(AppleHTTPContext *s)
89 {
90     int i;
91     for (i = 0; i < s->n_variants; i++)
92         av_free(s->variants[i]);
93     av_freep(&s->variants);
94     s->n_variants = 0;
95 }
96
97 struct variant_info {
98     char bandwidth[20];
99 };
100
101 static void handle_variant_args(struct variant_info *info, const char *key,
102                                 int key_len, char **dest, int *dest_len)
103 {
104     if (!strncmp(key, "BANDWIDTH=", key_len)) {
105         *dest     =        info->bandwidth;
106         *dest_len = sizeof(info->bandwidth);
107     }
108 }
109
110 static int parse_playlist(URLContext *h, const char *url)
111 {
112     AppleHTTPContext *s = h->priv_data;
113     AVIOContext *in;
114     int ret = 0, duration = 0, is_segment = 0, is_variant = 0, bandwidth = 0;
115     char line[1024];
116     const char *ptr;
117
118     if ((ret = avio_open2(&in, url, AVIO_FLAG_READ,
119                           &h->interrupt_callback, NULL)) < 0)
120         return ret;
121
122     read_chomp_line(in, line, sizeof(line));
123     if (strcmp(line, "#EXTM3U"))
124         return AVERROR_INVALIDDATA;
125
126     free_segment_list(s);
127     s->finished = 0;
128     while (!in->eof_reached) {
129         read_chomp_line(in, line, sizeof(line));
130         if (av_strstart(line, "#EXT-X-STREAM-INF:", &ptr)) {
131             struct variant_info info = {{0}};
132             is_variant = 1;
133             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_variant_args,
134                                &info);
135             bandwidth = atoi(info.bandwidth);
136         } else if (av_strstart(line, "#EXT-X-TARGETDURATION:", &ptr)) {
137             s->target_duration = atoi(ptr);
138         } else if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
139             s->start_seq_no = atoi(ptr);
140         } else if (av_strstart(line, "#EXT-X-ENDLIST", &ptr)) {
141             s->finished = 1;
142         } else if (av_strstart(line, "#EXTINF:", &ptr)) {
143             is_segment = 1;
144             duration = atoi(ptr);
145         } else if (av_strstart(line, "#", NULL)) {
146             continue;
147         } else if (line[0]) {
148             if (is_segment) {
149                 struct segment *seg = av_malloc(sizeof(struct segment));
150                 if (!seg) {
151                     ret = AVERROR(ENOMEM);
152                     goto fail;
153                 }
154                 seg->duration = duration;
155                 ff_make_absolute_url(seg->url, sizeof(seg->url), url, line);
156                 dynarray_add(&s->segments, &s->n_segments, seg);
157                 is_segment = 0;
158             } else if (is_variant) {
159                 struct variant *var = av_malloc(sizeof(struct variant));
160                 if (!var) {
161                     ret = AVERROR(ENOMEM);
162                     goto fail;
163                 }
164                 var->bandwidth = bandwidth;
165                 ff_make_absolute_url(var->url, sizeof(var->url), url, line);
166                 dynarray_add(&s->variants, &s->n_variants, var);
167                 is_variant = 0;
168             }
169         }
170     }
171     s->last_load_time = av_gettime();
172
173 fail:
174     avio_close(in);
175     return ret;
176 }
177
178 static int applehttp_close(URLContext *h)
179 {
180     AppleHTTPContext *s = h->priv_data;
181
182     free_segment_list(s);
183     free_variant_list(s);
184     ffurl_close(s->seg_hd);
185     return 0;
186 }
187
188 static int applehttp_open(URLContext *h, const char *uri, int flags)
189 {
190     AppleHTTPContext *s = h->priv_data;
191     int ret, i;
192     const char *nested_url;
193
194     if (flags & AVIO_FLAG_WRITE)
195         return AVERROR(ENOSYS);
196
197     h->is_streamed = 1;
198
199     if (av_strstart(uri, "hls+", &nested_url)) {
200         av_strlcpy(s->playlisturl, nested_url, sizeof(s->playlisturl));
201     } else if (av_strstart(uri, "hls://", &nested_url)) {
202         av_log(h, AV_LOG_ERROR,
203                "No nested protocol specified. Specify e.g. hls+http://%s\n",
204                nested_url);
205         ret = AVERROR(EINVAL);
206         goto fail;
207 #if FF_API_APPLEHTTP_PROTO
208     } else if (av_strstart(uri, "applehttp+", &nested_url)) {
209         av_strlcpy(s->playlisturl, nested_url, sizeof(s->playlisturl));
210         av_log(h, AV_LOG_WARNING,
211                "The applehttp protocol is deprecated, use hls+%s as url "
212                "instead.\n", nested_url);
213     } else if (av_strstart(uri, "applehttp://", &nested_url)) {
214         av_strlcpy(s->playlisturl, "http://", sizeof(s->playlisturl));
215         av_strlcat(s->playlisturl, nested_url, sizeof(s->playlisturl));
216         av_log(h, AV_LOG_WARNING,
217                "The applehttp protocol is deprecated, use hls+http://%s as url "
218                "instead.\n", nested_url);
219 #endif
220     } else {
221         av_log(h, AV_LOG_ERROR, "Unsupported url %s\n", uri);
222         ret = AVERROR(EINVAL);
223         goto fail;
224     }
225
226     if ((ret = parse_playlist(h, s->playlisturl)) < 0)
227         goto fail;
228
229     if (s->n_segments == 0 && s->n_variants > 0) {
230         int max_bandwidth = 0, maxvar = -1;
231         for (i = 0; i < s->n_variants; i++) {
232             if (s->variants[i]->bandwidth > max_bandwidth || i == 0) {
233                 max_bandwidth = s->variants[i]->bandwidth;
234                 maxvar = i;
235             }
236         }
237         av_strlcpy(s->playlisturl, s->variants[maxvar]->url,
238                    sizeof(s->playlisturl));
239         if ((ret = parse_playlist(h, s->playlisturl)) < 0)
240             goto fail;
241     }
242
243     if (s->n_segments == 0) {
244         av_log(h, AV_LOG_WARNING, "Empty playlist\n");
245         ret = AVERROR(EIO);
246         goto fail;
247     }
248     s->cur_seq_no = s->start_seq_no;
249     if (!s->finished && s->n_segments >= 3)
250         s->cur_seq_no = s->start_seq_no + s->n_segments - 3;
251
252     return 0;
253
254 fail:
255     applehttp_close(h);
256     return ret;
257 }
258
259 static int applehttp_read(URLContext *h, uint8_t *buf, int size)
260 {
261     AppleHTTPContext *s = h->priv_data;
262     const char *url;
263     int ret;
264     int64_t reload_interval;
265
266 start:
267     if (s->seg_hd) {
268         ret = ffurl_read(s->seg_hd, buf, size);
269         if (ret > 0)
270             return ret;
271     }
272     if (s->seg_hd) {
273         ffurl_close(s->seg_hd);
274         s->seg_hd = NULL;
275         s->cur_seq_no++;
276     }
277     reload_interval = s->n_segments > 0 ?
278                       s->segments[s->n_segments - 1]->duration :
279                       s->target_duration;
280     reload_interval *= 1000000;
281 retry:
282     if (!s->finished) {
283         int64_t now = av_gettime();
284         if (now - s->last_load_time >= reload_interval) {
285             if ((ret = parse_playlist(h, s->playlisturl)) < 0)
286                 return ret;
287             /* If we need to reload the playlist again below (if
288              * there's still no more segments), switch to a reload
289              * interval of half the target duration. */
290             reload_interval = s->target_duration * 500000;
291         }
292     }
293     if (s->cur_seq_no < s->start_seq_no) {
294         av_log(h, AV_LOG_WARNING,
295                "skipping %d segments ahead, expired from playlist\n",
296                s->start_seq_no - s->cur_seq_no);
297         s->cur_seq_no = s->start_seq_no;
298     }
299     if (s->cur_seq_no - s->start_seq_no >= s->n_segments) {
300         if (s->finished)
301             return AVERROR_EOF;
302         while (av_gettime() - s->last_load_time < reload_interval) {
303             if (ff_check_interrupt(&h->interrupt_callback))
304                 return AVERROR_EXIT;
305             usleep(100*1000);
306         }
307         goto retry;
308     }
309     url = s->segments[s->cur_seq_no - s->start_seq_no]->url,
310     av_log(h, AV_LOG_DEBUG, "opening %s\n", url);
311     ret = ffurl_open(&s->seg_hd, url, AVIO_FLAG_READ,
312                      &h->interrupt_callback, NULL);
313     if (ret < 0) {
314         if (ff_check_interrupt(&h->interrupt_callback))
315             return AVERROR_EXIT;
316         av_log(h, AV_LOG_WARNING, "Unable to open %s\n", url);
317         s->cur_seq_no++;
318         goto retry;
319     }
320     goto start;
321 }
322
323 #if FF_API_APPLEHTTP_PROTO
324 URLProtocol ff_applehttp_protocol = {
325     .name           = "applehttp",
326     .url_open       = applehttp_open,
327     .url_read       = applehttp_read,
328     .url_close      = applehttp_close,
329     .flags          = URL_PROTOCOL_FLAG_NESTED_SCHEME,
330     .priv_data_size = sizeof(AppleHTTPContext),
331 };
332 #endif
333
334 URLProtocol ff_hls_protocol = {
335     .name           = "hls",
336     .url_open       = applehttp_open,
337     .url_read       = applehttp_read,
338     .url_close      = applehttp_close,
339     .flags          = URL_PROTOCOL_FLAG_NESTED_SCHEME,
340     .priv_data_size = sizeof(AppleHTTPContext),
341 };