git.sesse.net Git - ffmpeg/blob - libavformat/hlsenc.c

   1 /*
   2  * Apple HTTP Live Streaming segmenter
   3  * Copyright (c) 2012, Luca Barbato
   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 #include <float.h>
  23 #include <stdint.h>
  24
  25 #include "libavutil/mathematics.h"
  26 #include "libavutil/parseutils.h"
  27 #include "libavutil/avstring.h"
  28 #include "libavutil/opt.h"
  29 #include "libavutil/log.h"
  30
  31 #include "avformat.h"
  32 #include "internal.h"
  33
  34 typedef struct ListEntry {
  35     char  name[1024];
  36     int   duration;
  37     struct ListEntry *next;
  38 } ListEntry;
  39
  40 typedef struct HLSContext {
  41     const AVClass *class;  // Class for private options.
  42     unsigned number;
  43     int64_t sequence;
  44     int64_t start_sequence;
  45     AVOutputFormat *oformat;
  46     AVFormatContext *avf;
  47     float time;            // Set by a private option.
  48     int  size;             // Set by a private option.
  49     int  wrap;             // Set by a private option.
  50     int  allowcache;
  51     int64_t recording_time;
  52     int has_video;
  53     int64_t start_pts;
  54     int64_t end_pts;
  55     int64_t duration;      // last segment duration computed so far, in seconds
  56     int nb_entries;
  57     ListEntry *list;
  58     ListEntry *end_list;
  59     char *basename;
  60     char *baseurl;
  61     AVIOContext *pb;
  62 } HLSContext;
  63
  64 static int hls_mux_init(AVFormatContext *s)
  65 {
  66     HLSContext *hls = s->priv_data;
  67     AVFormatContext *oc;
  68     int i;
  69
  70     hls->avf = oc = avformat_alloc_context();
  71     if (!oc)
  72         return AVERROR(ENOMEM);
  73
  74     oc->oformat            = hls->oformat;
  75     oc->interrupt_callback = s->interrupt_callback;
  76
  77     for (i = 0; i < s->nb_streams; i++) {
  78         AVStream *st;
  79         if (!(st = avformat_new_stream(oc, NULL)))
  80             return AVERROR(ENOMEM);
  81         avcodec_copy_context(st->codec, s->streams[i]->codec);
  82         st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
  83         st->time_base = s->streams[i]->time_base;
  84     }
  85
  86     return 0;
  87 }
  88
  89 static int append_entry(HLSContext *hls, uint64_t duration)
  90 {
  91     ListEntry *en = av_malloc(sizeof(*en));
  92
  93     if (!en)
  94         return AVERROR(ENOMEM);
  95
  96     av_strlcpy(en->name, av_basename(hls->avf->filename), sizeof(en->name));
  97
  98     en->duration = duration;
  99     en->next     = NULL;
 100
 101     if (!hls->list)
 102         hls->list = en;
 103     else
 104         hls->end_list->next = en;
 105
 106     hls->end_list = en;
 107
 108     if (hls->nb_entries >= hls->size) {
 109         en = hls->list;
 110         hls->list = en->next;
 111         av_free(en);
 112     } else
 113         hls->nb_entries++;
 114
 115     hls->sequence++;
 116
 117     return 0;
 118 }
 119
 120 static void free_entries(HLSContext *hls)
 121 {
 122     ListEntry *p = hls->list, *en;
 123
 124     while(p) {
 125         en = p;
 126         p = p->next;
 127         av_free(en);
 128     }
 129 }
 130
 131 static int hls_window(AVFormatContext *s, int last)
 132 {
 133     HLSContext *hls = s->priv_data;
 134     ListEntry *en;
 135     int target_duration = 0;
 136     int ret = 0;
 137     int64_t sequence = FFMAX(hls->start_sequence, hls->sequence - hls->size);
 138
 139     if ((ret = avio_open2(&hls->pb, s->filename, AVIO_FLAG_WRITE,
 140                           &s->interrupt_callback, NULL)) < 0)
 141         goto fail;
 142
 143     for (en = hls->list; en; en = en->next) {
 144         if (target_duration < en->duration)
 145             target_duration = en->duration;
 146     }
 147
 148     avio_printf(hls->pb, "#EXTM3U\n");
 149     avio_printf(hls->pb, "#EXT-X-VERSION:3\n");
 150     if (hls->allowcache == 0 || hls->allowcache == 1) {
 151         avio_printf(hls->pb, "#EXT-X-ALLOW-CACHE:%s\n", hls->allowcache == 0 ? "NO" : "YES");
 152     }
 153     avio_printf(hls->pb, "#EXT-X-TARGETDURATION:%d\n", target_duration);
 154     avio_printf(hls->pb, "#EXT-X-MEDIA-SEQUENCE:%"PRId64"\n", sequence);
 155
 156     av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%"PRId64"\n",
 157            sequence);
 158
 159     for (en = hls->list; en; en = en->next) {
 160         avio_printf(hls->pb, "#EXTINF:%d,\n", en->duration);
 161         if (hls->baseurl)
 162             avio_printf(hls->pb, "%s", hls->baseurl);
 163         avio_printf(hls->pb, "%s\n", en->name);
 164     }
 165
 166     if (last)
 167         avio_printf(hls->pb, "#EXT-X-ENDLIST\n");
 168
 169 fail:
 170     avio_closep(&hls->pb);
 171     return ret;
 172 }
 173
 174 static int hls_start(AVFormatContext *s)
 175 {
 176     HLSContext *c = s->priv_data;
 177     AVFormatContext *oc = c->avf;
 178     int err = 0;
 179
 180     if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
 181                               c->basename, c->wrap ? c->sequence % c->wrap : c->sequence) < 0)
 182         return AVERROR(EINVAL);
 183     c->number++;
 184
 185     if ((err = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
 186                           &s->interrupt_callback, NULL)) < 0)
 187         return err;
 188
 189     if (oc->oformat->priv_class && oc->priv_data)
 190         av_opt_set(oc->priv_data, "mpegts_flags", "resend_headers", 0);
 191
 192     return 0;
 193 }
 194
 195 static int hls_write_header(AVFormatContext *s)
 196 {
 197     HLSContext *hls = s->priv_data;
 198     int ret, i;
 199     char *p;
 200     const char *pattern = "%d.ts";
 201     int basename_size = strlen(s->filename) + strlen(pattern) + 1;
 202
 203     hls->sequence       = hls->start_sequence;
 204     hls->recording_time = hls->time * AV_TIME_BASE;
 205     hls->start_pts      = AV_NOPTS_VALUE;
 206
 207     for (i = 0; i < s->nb_streams; i++)
 208         hls->has_video +=
 209             s->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO;
 210
 211     if (hls->has_video > 1)
 212         av_log(s, AV_LOG_WARNING,
 213                "More than a single video stream present, "
 214                "expect issues decoding it.\n");
 215
 216     hls->oformat = av_guess_format("mpegts", NULL, NULL);
 217
 218     if (!hls->oformat) {
 219         ret = AVERROR_MUXER_NOT_FOUND;
 220         goto fail;
 221     }
 222
 223     hls->basename = av_malloc(basename_size);
 224
 225     if (!hls->basename) {
 226         ret = AVERROR(ENOMEM);
 227         goto fail;
 228     }
 229
 230     strcpy(hls->basename, s->filename);
 231
 232     p = strrchr(hls->basename, '.');
 233
 234     if (p)
 235         *p = '\0';
 236
 237     av_strlcat(hls->basename, pattern, basename_size);
 238
 239     if ((ret = hls_mux_init(s)) < 0)
 240         goto fail;
 241
 242     if ((ret = hls_start(s)) < 0)
 243         goto fail;
 244
 245     if ((ret = avformat_write_header(hls->avf, NULL)) < 0)
 246         return ret;
 247
 248
 249 fail:
 250     if (ret) {
 251         av_free(hls->basename);
 252         if (hls->avf)
 253             avformat_free_context(hls->avf);
 254     }
 255     return ret;
 256 }
 257
 258 static int hls_write_packet(AVFormatContext *s, AVPacket *pkt)
 259 {
 260     HLSContext *hls = s->priv_data;
 261     AVFormatContext *oc = hls->avf;
 262     AVStream *st = s->streams[pkt->stream_index];
 263     int64_t end_pts = hls->recording_time * hls->number;
 264     int ret, can_split = 1;
 265
 266     if (hls->start_pts == AV_NOPTS_VALUE) {
 267         hls->start_pts = pkt->pts;
 268         hls->end_pts   = pkt->pts;
 269     }
 270
 271     if (hls->has_video) {
 272         can_split = st->codec->codec_type == AVMEDIA_TYPE_VIDEO &&
 273                     pkt->flags & AV_PKT_FLAG_KEY;
 274     }
 275     if (pkt->pts == AV_NOPTS_VALUE)
 276         can_split = 0;
 277     else
 278         hls->duration = av_rescale(pkt->pts - hls->end_pts,
 279                                    st->time_base.num, st->time_base.den);
 280
 281     if (can_split && av_compare_ts(pkt->pts - hls->start_pts, st->time_base,
 282                                    end_pts, AV_TIME_BASE_Q) >= 0) {
 283         ret = append_entry(hls, hls->duration);
 284         if (ret)
 285             return ret;
 286
 287         hls->end_pts = pkt->pts;
 288         hls->duration = 0;
 289
 290         av_write_frame(oc, NULL); /* Flush any buffered data */
 291         avio_close(oc->pb);
 292
 293         ret = hls_start(s);
 294
 295         if (ret)
 296             return ret;
 297
 298         oc = hls->avf;
 299
 300         if ((ret = hls_window(s, 0)) < 0)
 301             return ret;
 302     }
 303
 304     ret = ff_write_chained(oc, pkt->stream_index, pkt, s);
 305
 306     return ret;
 307 }
 308
 309 static int hls_write_trailer(struct AVFormatContext *s)
 310 {
 311     HLSContext *hls = s->priv_data;
 312     AVFormatContext *oc = hls->avf;
 313
 314     av_write_trailer(oc);
 315     avio_closep(&oc->pb);
 316     avformat_free_context(oc);
 317     av_free(hls->basename);
 318     append_entry(hls, hls->duration);
 319     hls_window(s, 1);
 320
 321     free_entries(hls);
 322     avio_close(hls->pb);
 323     return 0;
 324 }
 325
 326 #define OFFSET(x) offsetof(HLSContext, x)
 327 #define E AV_OPT_FLAG_ENCODING_PARAM
 328 static const AVOption options[] = {
 329     {"start_number",  "first number in the sequence",            OFFSET(start_sequence),AV_OPT_TYPE_INT64,  {.i64 = 0},     0, INT64_MAX, E},
 330     {"hls_time",      "segment length in seconds",               OFFSET(time),    AV_OPT_TYPE_FLOAT,  {.dbl = 2},     0, FLT_MAX, E},
 331     {"hls_list_size", "maximum number of playlist entries",      OFFSET(size),    AV_OPT_TYPE_INT,    {.i64 = 5},     0, INT_MAX, E},
 332     {"hls_wrap",      "number after which the index wraps",      OFFSET(wrap),    AV_OPT_TYPE_INT,    {.i64 = 0},     0, INT_MAX, E},
 333     {"hls_allow_cache", "explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments", OFFSET(allowcache), AV_OPT_TYPE_INT, {.i64 = -1}, INT_MIN, INT_MAX, E},
 334     {"hls_base_url",  "url to prepend to each playlist entry",   OFFSET(baseurl), AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E},
 335     { NULL },
 336 };
 337
 338 static const AVClass hls_class = {
 339     .class_name = "hls muxer",
 340     .item_name  = av_default_item_name,
 341     .option     = options,
 342     .version    = LIBAVUTIL_VERSION_INT,
 343 };
 344
 345
 346 AVOutputFormat ff_hls_muxer = {
 347     .name           = "hls",
 348     .long_name      = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
 349     .extensions     = "m3u8",
 350     .priv_data_size = sizeof(HLSContext),
 351     .audio_codec    = AV_CODEC_ID_AAC,
 352     .video_codec    = AV_CODEC_ID_H264,
 353     .flags          = AVFMT_NOFILE | AVFMT_ALLOW_FLUSH,
 354     .write_header   = hls_write_header,
 355     .write_packet   = hls_write_packet,
 356     .write_trailer  = hls_write_trailer,
 357     .priv_class     = &hls_class,
 358 };