2 * Apple HTTP Live Streaming demuxer
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 demuxer
25 * http://tools.ietf.org/html/draft-pantos-http-live-streaming
28 #define _XOPEN_SOURCE 600
29 #include "libavutil/avstring.h"
33 #include "avio_internal.h"
36 #define INITIAL_BUFFER_SIZE 32768
39 * An apple http stream consists of a playlist with media segment files,
40 * played sequentially. There may be several playlists with the same
41 * video content, in different bandwidth variants, that are played in
42 * parallel (preferrably only one bandwidth variant at a time). In this case,
43 * the user supplied the url to a main playlist that only lists the variant
46 * If the main playlist doesn't point at any variants, we still create
47 * one anonymous toplevel variant for this, to maintain the structure.
52 char url[MAX_URL_SIZE];
56 * Each variant has its own demuxer. If it currently is active,
57 * it has an open AVIOContext too, and potentially an AVPacket
58 * containing the next packet from this stream.
62 char url[MAX_URL_SIZE];
66 AVFormatContext *parent;
76 struct segment **segments;
77 int needed, cur_needed;
79 int64_t last_load_time;
82 typedef struct AppleHTTPContext {
84 struct variant **variants;
90 static int read_chomp_line(AVIOContext *s, char *buf, int maxlen)
92 int len = ff_get_line(s, buf, maxlen);
93 while (len > 0 && isspace(buf[len - 1]))
98 static void free_segment_list(struct variant *var)
101 for (i = 0; i < var->n_segments; i++)
102 av_free(var->segments[i]);
103 av_freep(&var->segments);
107 static void free_variant_list(AppleHTTPContext *c)
110 for (i = 0; i < c->n_variants; i++) {
111 struct variant *var = c->variants[i];
112 free_segment_list(var);
113 av_free_packet(&var->pkt);
114 av_free(var->pb.buffer);
116 ffurl_close(var->input);
119 av_close_input_file(var->ctx);
123 av_freep(&c->variants);
128 * Used to reset a statically allocated AVPacket to a clean slate,
129 * containing no data.
131 static void reset_packet(AVPacket *pkt)
137 static struct variant *new_variant(AppleHTTPContext *c, int bandwidth,
138 const char *url, const char *base)
140 struct variant *var = av_mallocz(sizeof(struct variant));
143 reset_packet(&var->pkt);
144 var->bandwidth = bandwidth;
145 ff_make_absolute_url(var->url, sizeof(var->url), base, url);
146 dynarray_add(&c->variants, &c->n_variants, var);
150 struct variant_info {
154 static void handle_variant_args(struct variant_info *info, const char *key,
155 int key_len, char **dest, int *dest_len)
157 if (!strncmp(key, "BANDWIDTH=", key_len)) {
158 *dest = info->bandwidth;
159 *dest_len = sizeof(info->bandwidth);
163 static int parse_playlist(AppleHTTPContext *c, const char *url,
164 struct variant *var, AVIOContext *in)
166 int ret = 0, duration = 0, is_segment = 0, is_variant = 0, bandwidth = 0;
173 if ((ret = avio_open(&in, url, AVIO_RDONLY)) < 0)
177 read_chomp_line(in, line, sizeof(line));
178 if (strcmp(line, "#EXTM3U")) {
179 ret = AVERROR_INVALIDDATA;
184 free_segment_list(var);
187 while (!url_feof(in)) {
188 read_chomp_line(in, line, sizeof(line));
189 if (av_strstart(line, "#EXT-X-STREAM-INF:", &ptr)) {
190 struct variant_info info = {{0}};
192 ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_variant_args,
194 bandwidth = atoi(info.bandwidth);
195 } else if (av_strstart(line, "#EXT-X-TARGETDURATION:", &ptr)) {
197 var = new_variant(c, 0, url, NULL);
199 ret = AVERROR(ENOMEM);
203 var->target_duration = atoi(ptr);
204 } else if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
206 var = new_variant(c, 0, url, NULL);
208 ret = AVERROR(ENOMEM);
212 var->start_seq_no = atoi(ptr);
213 } else if (av_strstart(line, "#EXT-X-ENDLIST", &ptr)) {
216 } else if (av_strstart(line, "#EXTINF:", &ptr)) {
218 duration = atoi(ptr);
219 } else if (av_strstart(line, "#", NULL)) {
221 } else if (line[0]) {
223 if (!new_variant(c, bandwidth, line, url)) {
224 ret = AVERROR(ENOMEM);
233 var = new_variant(c, 0, url, NULL);
235 ret = AVERROR(ENOMEM);
239 seg = av_malloc(sizeof(struct segment));
241 ret = AVERROR(ENOMEM);
244 seg->duration = duration;
245 ff_make_absolute_url(seg->url, sizeof(seg->url), url, line);
246 dynarray_add(&var->segments, &var->n_segments, seg);
252 var->last_load_time = av_gettime();
260 static int read_data(void *opaque, uint8_t *buf, int buf_size)
262 struct variant *v = opaque;
263 AppleHTTPContext *c = v->parent->priv_data;
269 /* If this is a live stream and target_duration has elapsed since
270 * the last playlist reload, reload the variant playlists now. */
272 av_gettime() - v->last_load_time >= v->target_duration*1000000 &&
273 (ret = parse_playlist(c, v->url, v, NULL)) < 0)
275 if (v->cur_seq_no < v->start_seq_no) {
276 av_log(NULL, AV_LOG_WARNING,
277 "skipping %d segments ahead, expired from playlists\n",
278 v->start_seq_no - v->cur_seq_no);
279 v->cur_seq_no = v->start_seq_no;
281 if (v->cur_seq_no >= v->start_seq_no + v->n_segments) {
284 while (av_gettime() - v->last_load_time <
285 v->target_duration*1000000) {
286 if (url_interrupt_cb())
290 /* Enough time has elapsed since the last reload */
294 ret = ffurl_open(&v->input,
295 v->segments[v->cur_seq_no - v->start_seq_no]->url,
300 ret = ffurl_read(v->input, buf, buf_size);
303 if (ret < 0 && ret != AVERROR_EOF)
305 ffurl_close(v->input);
309 c->end_of_segment = 1;
310 c->cur_seq_no = v->cur_seq_no;
314 for (i = v->stream_offset; i < v->stream_offset + v->ctx->nb_streams;
316 if (v->parent->streams[i]->discard < AVDISCARD_ALL)
321 av_log(v->parent, AV_LOG_INFO, "No longer receiving variant %d\n",
328 static int applehttp_read_header(AVFormatContext *s, AVFormatParameters *ap)
330 AppleHTTPContext *c = s->priv_data;
331 int ret = 0, i, j, stream_offset = 0;
333 if ((ret = parse_playlist(c, s->filename, NULL, s->pb)) < 0)
336 if (c->n_variants == 0) {
337 av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
341 /* If the playlist only contained variants, parse each individual
342 * variant playlist. */
343 if (c->n_variants > 1 || c->variants[0]->n_segments == 0) {
344 for (i = 0; i < c->n_variants; i++) {
345 struct variant *v = c->variants[i];
346 if ((ret = parse_playlist(c, v->url, v, NULL)) < 0)
351 if (c->variants[0]->n_segments == 0) {
352 av_log(NULL, AV_LOG_WARNING, "Empty playlist\n");
357 /* If this isn't a live stream, calculate the total duration of the
359 if (c->variants[0]->finished) {
360 int64_t duration = 0;
361 for (i = 0; i < c->variants[0]->n_segments; i++)
362 duration += c->variants[0]->segments[i]->duration;
363 s->duration = duration * AV_TIME_BASE;
366 /* Open the demuxer for each variant */
367 for (i = 0; i < c->n_variants; i++) {
368 struct variant *v = c->variants[i];
369 AVInputFormat *in_fmt = NULL;
370 if (v->n_segments == 0)
377 /* If this is a live stream with more than 3 segments, start at the
378 * third last segment. */
379 v->cur_seq_no = v->start_seq_no;
380 if (!v->finished && v->n_segments > 3)
381 v->cur_seq_no = v->start_seq_no + v->n_segments - 3;
383 v->read_buffer = av_malloc(INITIAL_BUFFER_SIZE);
384 ffio_init_context(&v->pb, v->read_buffer, INITIAL_BUFFER_SIZE, 0, v,
385 read_data, NULL, NULL);
387 ret = av_probe_input_buffer(&v->pb, &in_fmt, v->segments[0]->url,
391 ret = av_open_input_stream(&v->ctx, &v->pb, v->segments[0]->url,
395 v->stream_offset = stream_offset;
396 /* Create new AVStreams for each stream in this variant */
397 for (j = 0; j < v->ctx->nb_streams; j++) {
398 AVStream *st = av_new_stream(s, i);
400 ret = AVERROR(ENOMEM);
403 avcodec_copy_context(st->codec, v->ctx->streams[j]->codec);
405 stream_offset += v->ctx->nb_streams;
412 free_variant_list(c);
416 static int recheck_discard_flags(AVFormatContext *s, int first)
418 AppleHTTPContext *c = s->priv_data;
421 /* Check if any new streams are needed */
422 for (i = 0; i < c->n_variants; i++)
423 c->variants[i]->cur_needed = 0;;
425 for (i = 0; i < s->nb_streams; i++) {
426 AVStream *st = s->streams[i];
427 struct variant *var = c->variants[s->streams[i]->id];
428 if (st->discard < AVDISCARD_ALL)
431 for (i = 0; i < c->n_variants; i++) {
432 struct variant *v = c->variants[i];
433 if (v->cur_needed && !v->needed) {
436 v->cur_seq_no = c->cur_seq_no;
437 v->pb.eof_reached = 0;
438 av_log(s, AV_LOG_INFO, "Now receiving variant %d\n", i);
439 } else if (first && !v->cur_needed && v->needed) {
441 ffurl_close(v->input);
445 av_log(s, AV_LOG_INFO, "No longer receiving variant %d\n", i);
451 static int applehttp_read_packet(AVFormatContext *s, AVPacket *pkt)
453 AppleHTTPContext *c = s->priv_data;
454 int ret, i, minvariant = -1;
456 if (c->first_packet) {
457 recheck_discard_flags(s, 1);
462 c->end_of_segment = 0;
463 for (i = 0; i < c->n_variants; i++) {
464 struct variant *var = c->variants[i];
465 /* Make sure we've got one buffered packet from each open variant
467 if (var->needed && !var->pkt.data) {
468 ret = av_read_frame(var->ctx, &var->pkt);
470 if (!url_feof(&var->pb))
472 reset_packet(&var->pkt);
475 /* Check if this stream has the packet with the lowest dts */
477 if (minvariant < 0 ||
478 var->pkt.dts < c->variants[minvariant]->pkt.dts)
482 if (c->end_of_segment) {
483 if (recheck_discard_flags(s, 0))
486 /* If we got a packet, return it */
487 if (minvariant >= 0) {
488 *pkt = c->variants[minvariant]->pkt;
489 pkt->stream_index += c->variants[minvariant]->stream_offset;
490 reset_packet(&c->variants[minvariant]->pkt);
496 static int applehttp_close(AVFormatContext *s)
498 AppleHTTPContext *c = s->priv_data;
500 free_variant_list(c);
504 static int applehttp_read_seek(AVFormatContext *s, int stream_index,
505 int64_t timestamp, int flags)
507 AppleHTTPContext *c = s->priv_data;
510 if ((flags & AVSEEK_FLAG_BYTE) || !c->variants[0]->finished)
511 return AVERROR(ENOSYS);
513 timestamp = av_rescale_rnd(timestamp, 1, stream_index >= 0 ?
514 s->streams[stream_index]->time_base.den :
515 AV_TIME_BASE, flags & AVSEEK_FLAG_BACKWARD ?
516 AV_ROUND_DOWN : AV_ROUND_UP);
518 for (i = 0; i < c->n_variants; i++) {
520 struct variant *var = c->variants[i];
523 ffurl_close(var->input);
526 av_free_packet(&var->pkt);
527 reset_packet(&var->pkt);
528 var->pb.eof_reached = 0;
530 /* Locate the segment that contains the target timestamp */
531 for (j = 0; j < var->n_segments; j++) {
532 if (timestamp >= pos &&
533 timestamp < pos + var->segments[j]->duration) {
534 var->cur_seq_no = var->start_seq_no + j;
538 pos += var->segments[j]->duration;
544 static int applehttp_probe(AVProbeData *p)
546 /* Require #EXTM3U at the start, and either one of the ones below
547 * somewhere for a proper match. */
548 if (strncmp(p->buf, "#EXTM3U", 7))
550 if (strstr(p->buf, "#EXT-X-STREAM-INF:") ||
551 strstr(p->buf, "#EXT-X-TARGETDURATION:") ||
552 strstr(p->buf, "#EXT-X-MEDIA-SEQUENCE:"))
553 return AVPROBE_SCORE_MAX;
557 AVInputFormat ff_applehttp_demuxer = {
559 NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming format"),
560 sizeof(AppleHTTPContext),
562 applehttp_read_header,
563 applehttp_read_packet,