libavformat/hlsproto.c
fb8d710f
 /*
  * Apple HTTP Live Streaming Protocol Handler
  * Copyright (c) 2010 Martin Storsjo
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
  * @file
  * Apple HTTP Live Streaming Protocol Handler
  * http://tools.ietf.org/html/draft-pantos-http-live-streaming
  */
 
 #include "libavutil/avstring.h"
896bb0d7
 #include "libavutil/time.h"
fb8d710f
 #include "avformat.h"
 #include "internal.h"
0589da0a
 #include "url.h"
8bdab32f
 #include "version.h"
fb8d710f
 
 /*
  * An apple http stream consists of a playlist with media segment files,
  * played sequentially. There may be several playlists with the same
  * video content, in different bandwidth variants, that are played in
b22ecbc6
  * parallel (preferably only one bandwidth variant at a time). In this case,
fb8d710f
  * the user supplied the url to a main playlist that only lists the variant
  * playlists.
  *
  * If the main playlist doesn't point at any variants, we still create
  * one anonymous toplevel variant for this, to maintain the structure.
  */
 
 struct segment {
a2b7eeeb
     int64_t duration;
fb8d710f
     char url[MAX_URL_SIZE];
 };
 
 struct variant {
     int bandwidth;
     char url[MAX_URL_SIZE];
 };
 
8c62d83f
 typedef struct HLSContext {
fb8d710f
     char playlisturl[MAX_URL_SIZE];
a2b7eeeb
     int64_t target_duration;
fb8d710f
     int start_seq_no;
     int finished;
     int n_segments;
     struct segment **segments;
     int n_variants;
     struct variant **variants;
     int cur_seq_no;
     URLContext *seg_hd;
     int64_t last_load_time;
8c62d83f
 } HLSContext;
fb8d710f
 
 static int read_chomp_line(AVIOContext *s, char *buf, int maxlen)
 {
     int len = ff_get_line(s, buf, maxlen);
88d55b82
     while (len > 0 && av_isspace(buf[len - 1]))
fb8d710f
         buf[--len] = '\0';
     return len;
 }
 
8c62d83f
 static void free_segment_list(HLSContext *s)
fb8d710f
 {
     int i;
     for (i = 0; i < s->n_segments; i++)
59ca6e25
         av_freep(&s->segments[i]);
fb8d710f
     av_freep(&s->segments);
     s->n_segments = 0;
 }
 
8c62d83f
 static void free_variant_list(HLSContext *s)
fb8d710f
 {
     int i;
     for (i = 0; i < s->n_variants; i++)
59ca6e25
         av_freep(&s->variants[i]);
fb8d710f
     av_freep(&s->variants);
     s->n_variants = 0;
 }
 
 struct variant_info {
     char bandwidth[20];
 };
 
 static void handle_variant_args(struct variant_info *info, const char *key,
                                 int key_len, char **dest, int *dest_len)
 {
     if (!strncmp(key, "BANDWIDTH=", key_len)) {
         *dest     =        info->bandwidth;
         *dest_len = sizeof(info->bandwidth);
     }
 }
 
 static int parse_playlist(URLContext *h, const char *url)
 {
8c62d83f
     HLSContext *s = h->priv_data;
fb8d710f
     AVIOContext *in;
a2b7eeeb
     int ret = 0, is_segment = 0, is_variant = 0, bandwidth = 0;
     int64_t duration = 0;
fb8d710f
     char line[1024];
     const char *ptr;
 
9d77a8fa
     if ((ret = avio_open2(&in, url, AVIO_FLAG_READ,
                           &h->interrupt_callback, NULL)) < 0)
fb8d710f
         return ret;
 
     read_chomp_line(in, line, sizeof(line));
7915e674
     if (strcmp(line, "#EXTM3U")) {
         ret = AVERROR_INVALIDDATA;
         goto fail;
     }
fb8d710f
 
     free_segment_list(s);
     s->finished = 0;
d34ec64a
     while (!avio_feof(in)) {
fb8d710f
         read_chomp_line(in, line, sizeof(line));
         if (av_strstart(line, "#EXT-X-STREAM-INF:", &ptr)) {
             struct variant_info info = {{0}};
             is_variant = 1;
             ff_parse_key_value(ptr, (ff_parse_key_val_cb) handle_variant_args,
                                &info);
             bandwidth = atoi(info.bandwidth);
         } else if (av_strstart(line, "#EXT-X-TARGETDURATION:", &ptr)) {
a2b7eeeb
             s->target_duration = atoi(ptr) * AV_TIME_BASE;
fb8d710f
         } else if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
             s->start_seq_no = atoi(ptr);
         } else if (av_strstart(line, "#EXT-X-ENDLIST", &ptr)) {
             s->finished = 1;
         } else if (av_strstart(line, "#EXTINF:", &ptr)) {
             is_segment = 1;
a2b7eeeb
             duration = atof(ptr) * AV_TIME_BASE;
fb8d710f
         } else if (av_strstart(line, "#", NULL)) {
             continue;
         } else if (line[0]) {
             if (is_segment) {
                 struct segment *seg = av_malloc(sizeof(struct segment));
                 if (!seg) {
                     ret = AVERROR(ENOMEM);
                     goto fail;
                 }
                 seg->duration = duration;
f1f60f52
                 ff_make_absolute_url(seg->url, sizeof(seg->url), url, line);
fb8d710f
                 dynarray_add(&s->segments, &s->n_segments, seg);
                 is_segment = 0;
             } else if (is_variant) {
                 struct variant *var = av_malloc(sizeof(struct variant));
                 if (!var) {
                     ret = AVERROR(ENOMEM);
                     goto fail;
                 }
                 var->bandwidth = bandwidth;
f1f60f52
                 ff_make_absolute_url(var->url, sizeof(var->url), url, line);
fb8d710f
                 dynarray_add(&s->variants, &s->n_variants, var);
                 is_variant = 0;
             }
         }
     }
6df9d9b5
     s->last_load_time = av_gettime_relative();
fb8d710f
 
 fail:
     avio_close(in);
     return ret;
 }
 
8c62d83f
 static int hls_close(URLContext *h)
1ca87d60
 {
8c62d83f
     HLSContext *s = h->priv_data;
1ca87d60
 
     free_segment_list(s);
     free_variant_list(s);
     ffurl_close(s->seg_hd);
     return 0;
 }
 
8c62d83f
 static int hls_open(URLContext *h, const char *uri, int flags)
fb8d710f
 {
8c62d83f
     HLSContext *s = h->priv_data;
fb8d710f
     int ret, i;
     const char *nested_url;
 
59d96941
     if (flags & AVIO_FLAG_WRITE)
f5b386af
         return AVERROR(ENOSYS);
fb8d710f
 
     h->is_streamed = 1;
 
8bdab32f
     if (av_strstart(uri, "hls+", &nested_url)) {
fb8d710f
         av_strlcpy(s->playlisturl, nested_url, sizeof(s->playlisturl));
8bdab32f
     } else if (av_strstart(uri, "hls://", &nested_url)) {
         av_log(h, AV_LOG_ERROR,
                "No nested protocol specified. Specify e.g. hls+http://%s\n",
                nested_url);
         ret = AVERROR(EINVAL);
         goto fail;
fb8d710f
     } else {
c60112f2
         av_log(h, AV_LOG_ERROR, "Unsupported url %s\n", uri);
fb8d710f
         ret = AVERROR(EINVAL);
         goto fail;
     }
9cb9c6c4
     av_log(h, AV_LOG_WARNING,
            "Using the hls protocol is discouraged, please try using the "
            "hls demuxer instead. The hls demuxer should be more complete "
            "and work as well as the protocol implementation. (If not, "
            "please report it.) To use the demuxer, simply use %s as url.\n",
            s->playlisturl);
fb8d710f
 
     if ((ret = parse_playlist(h, s->playlisturl)) < 0)
         goto fail;
 
     if (s->n_segments == 0 && s->n_variants > 0) {
         int max_bandwidth = 0, maxvar = -1;
         for (i = 0; i < s->n_variants; i++) {
             if (s->variants[i]->bandwidth > max_bandwidth || i == 0) {
                 max_bandwidth = s->variants[i]->bandwidth;
                 maxvar = i;
             }
         }
         av_strlcpy(s->playlisturl, s->variants[maxvar]->url,
                    sizeof(s->playlisturl));
         if ((ret = parse_playlist(h, s->playlisturl)) < 0)
             goto fail;
     }
 
     if (s->n_segments == 0) {
c60112f2
         av_log(h, AV_LOG_WARNING, "Empty playlist\n");
fb8d710f
         ret = AVERROR(EIO);
         goto fail;
     }
     s->cur_seq_no = s->start_seq_no;
     if (!s->finished && s->n_segments >= 3)
         s->cur_seq_no = s->start_seq_no + s->n_segments - 3;
 
     return 0;
 
 fail:
8c62d83f
     hls_close(h);
fb8d710f
     return ret;
 }
 
8c62d83f
 static int hls_read(URLContext *h, uint8_t *buf, int size)
fb8d710f
 {
8c62d83f
     HLSContext *s = h->priv_data;
fb8d710f
     const char *url;
     int ret;
1f8bf1ef
     int64_t reload_interval;
fb8d710f
 
 start:
     if (s->seg_hd) {
bc371aca
         ret = ffurl_read(s->seg_hd, buf, size);
fb8d710f
         if (ret > 0)
             return ret;
     }
     if (s->seg_hd) {
e52a9145
         ffurl_close(s->seg_hd);
fb8d710f
         s->seg_hd = NULL;
         s->cur_seq_no++;
     }
1f8bf1ef
     reload_interval = s->n_segments > 0 ?
                       s->segments[s->n_segments - 1]->duration :
                       s->target_duration;
fb8d710f
 retry:
     if (!s->finished) {
6df9d9b5
         int64_t now = av_gettime_relative();
1f8bf1ef
         if (now - s->last_load_time >= reload_interval) {
fb8d710f
             if ((ret = parse_playlist(h, s->playlisturl)) < 0)
                 return ret;
1f8bf1ef
             /* If we need to reload the playlist again below (if
              * there's still no more segments), switch to a reload
              * interval of half the target duration. */
a2b7eeeb
             reload_interval = s->target_duration / 2;
1f8bf1ef
         }
fb8d710f
     }
     if (s->cur_seq_no < s->start_seq_no) {
c60112f2
         av_log(h, AV_LOG_WARNING,
fb8d710f
                "skipping %d segments ahead, expired from playlist\n",
                s->start_seq_no - s->cur_seq_no);
         s->cur_seq_no = s->start_seq_no;
     }
     if (s->cur_seq_no - s->start_seq_no >= s->n_segments) {
         if (s->finished)
             return AVERROR_EOF;
6df9d9b5
         while (av_gettime_relative() - s->last_load_time < reload_interval) {
9957cdbf
             if (ff_check_interrupt(&h->interrupt_callback))
c76374c6
                 return AVERROR_EXIT;
896bb0d7
             av_usleep(100*1000);
fb8d710f
         }
         goto retry;
     }
     url = s->segments[s->cur_seq_no - s->start_seq_no]->url,
c60112f2
     av_log(h, AV_LOG_DEBUG, "opening %s\n", url);
6f1b7b39
     ret = ffurl_open(&s->seg_hd, url, AVIO_FLAG_READ,
ddffc2fd
                      &h->interrupt_callback, NULL);
fb8d710f
     if (ret < 0) {
9957cdbf
         if (ff_check_interrupt(&h->interrupt_callback))
c76374c6
             return AVERROR_EXIT;
c60112f2
         av_log(h, AV_LOG_WARNING, "Unable to open %s\n", url);
fb8d710f
         s->cur_seq_no++;
         goto retry;
     }
     goto start;
 }
 
8bdab32f
 URLProtocol ff_hls_protocol = {
     .name           = "hls",
8c62d83f
     .url_open       = hls_open,
     .url_read       = hls_read,
     .url_close      = hls_close,
c3b05d21
     .flags          = URL_PROTOCOL_FLAG_NESTED_SCHEME,
8c62d83f
     .priv_data_size = sizeof(HLSContext),
fb8d710f
 };