hlsenc.c 10.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/*
 * Apple HTTP Live Streaming segmenter
 * Copyright (c) 2012, Luca Barbato
 *
 * This file is part of Libav.
 *
 * Libav 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.
 *
 * Libav 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 Libav; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#include <float.h>
23
#include <stdint.h>
24 25 26 27 28 29 30 31 32 33 34 35

#include "libavutil/mathematics.h"
#include "libavutil/parseutils.h"
#include "libavutil/avstring.h"
#include "libavutil/opt.h"
#include "libavutil/log.h"

#include "avformat.h"
#include "internal.h"

typedef struct ListEntry {
    char  name[1024];
36
    int64_t duration;     // segment duration in AV_TIME_BASE units
37 38 39 40 41
    struct ListEntry *next;
} ListEntry;

typedef struct HLSContext {
    const AVClass *class;  // Class for private options.
42
    unsigned number;
43
    int64_t sequence;
44
    int64_t start_sequence;
45 46 47 48 49
    AVOutputFormat *oformat;
    AVFormatContext *avf;
    float time;            // Set by a private option.
    int  size;             // Set by a private option.
    int  wrap;             // Set by a private option.
50
    int  version;          // Set by a private option.
51
    int  allowcache;
52 53
    int64_t recording_time;
    int has_video;
54
    // The following timestamps are in AV_TIME_BASE units.
55 56
    int64_t start_pts;
    int64_t end_pts;
57
    int64_t duration;      // last segment duration computed so far.
58
    int nb_entries;
59 60 61
    ListEntry *list;
    ListEntry *end_list;
    char *basename;
62
    char *baseurl;
63 64 65 66 67 68 69 70 71 72 73 74 75 76
} HLSContext;

static int hls_mux_init(AVFormatContext *s)
{
    HLSContext *hls = s->priv_data;
    AVFormatContext *oc;
    int i;

    hls->avf = oc = avformat_alloc_context();
    if (!oc)
        return AVERROR(ENOMEM);

    oc->oformat            = hls->oformat;
    oc->interrupt_callback = s->interrupt_callback;
77 78 79
    oc->opaque             = s->opaque;
    oc->io_open            = s->io_open;
    oc->io_close           = s->io_close;
80 81 82 83 84

    for (i = 0; i < s->nb_streams; i++) {
        AVStream *st;
        if (!(st = avformat_new_stream(oc, NULL)))
            return AVERROR(ENOMEM);
85
        avcodec_parameters_copy(st->codecpar, s->streams[i]->codecpar);
86
        st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
87
        st->time_base = s->streams[i]->time_base;
88 89 90 91 92
    }

    return 0;
}

93
static int append_entry(HLSContext *hls, int64_t duration)
94 95 96 97 98 99
{
    ListEntry *en = av_malloc(sizeof(*en));

    if (!en)
        return AVERROR(ENOMEM);

100
    av_strlcpy(en->name, av_basename(hls->avf->filename), sizeof(en->name));
101 102 103 104 105 106 107 108 109 110 111

    en->duration = duration;
    en->next     = NULL;

    if (!hls->list)
        hls->list = en;
    else
        hls->end_list->next = en;

    hls->end_list = en;

112
    if (hls->nb_entries >= hls->size) {
113 114 115
        en = hls->list;
        hls->list = en->next;
        av_free(en);
116 117
    } else
        hls->nb_entries++;
118

119 120
    hls->sequence++;

121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
    return 0;
}

static void free_entries(HLSContext *hls)
{
    ListEntry *p = hls->list, *en;

    while(p) {
        en = p;
        p = p->next;
        av_free(en);
    }
}

static int hls_window(AVFormatContext *s, int last)
{
    HLSContext *hls = s->priv_data;
    ListEntry *en;
139
    int64_t target_duration = 0;
140
    int ret = 0;
141
    AVIOContext *out = NULL;
142
    char temp_filename[1024];
143
    int64_t sequence = FFMAX(hls->start_sequence, hls->sequence - hls->size);
144

145
    snprintf(temp_filename, sizeof(temp_filename), "%s.tmp", s->filename);
146
    if ((ret = s->io_open(s, &out, temp_filename, AVIO_FLAG_WRITE, NULL)) < 0)
147 148
        goto fail;

149 150 151 152 153
    for (en = hls->list; en; en = en->next) {
        if (target_duration < en->duration)
            target_duration = en->duration;
    }

154
    avio_printf(out, "#EXTM3U\n");
155
    avio_printf(out, "#EXT-X-VERSION:%d\n", hls->version);
156
    if (hls->allowcache == 0 || hls->allowcache == 1) {
157
        avio_printf(out, "#EXT-X-ALLOW-CACHE:%s\n", hls->allowcache == 0 ? "NO" : "YES");
158
    }
159
    avio_printf(out, "#EXT-X-TARGETDURATION:%"PRId64"\n",
160 161
                av_rescale_rnd(target_duration, 1, AV_TIME_BASE,
                               AV_ROUND_UP));
162
    avio_printf(out, "#EXT-X-MEDIA-SEQUENCE:%"PRId64"\n", sequence);
163

164
    av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%"PRId64"\n",
165
           sequence);
166

167
    for (en = hls->list; en; en = en->next) {
168 169 170 171 172 173
        if (hls->version > 2)
            avio_printf(out, "#EXTINF:%f\n",
                        (double)en->duration / AV_TIME_BASE);
        else
            avio_printf(out, "#EXTINF:%"PRId64",\n",
                        av_rescale(en->duration, 1, AV_TIME_BASE));
174
        if (hls->baseurl)
175 176
            avio_printf(out, "%s", hls->baseurl);
        avio_printf(out, "%s\n", en->name);
177 178 179
    }

    if (last)
180
        avio_printf(out, "#EXT-X-ENDLIST\n");
181 182

fail:
183
    ff_format_io_close(s, &out);
184 185
    if (ret >= 0)
        ff_rename(temp_filename, s->filename);
186 187 188 189 190 191 192 193 194 195
    return ret;
}

static int hls_start(AVFormatContext *s)
{
    HLSContext *c = s->priv_data;
    AVFormatContext *oc = c->avf;
    int err = 0;

    if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
196
                              c->basename, c->wrap ? c->sequence % c->wrap : c->sequence) < 0)
197
        return AVERROR(EINVAL);
198
    c->number++;
199

200
    if ((err = s->io_open(s, &oc->pb, oc->filename, AVIO_FLAG_WRITE, NULL)) < 0)
201 202 203 204 205 206 207 208 209 210 211 212 213 214
        return err;

    if (oc->oformat->priv_class && oc->priv_data)
        av_opt_set(oc->priv_data, "mpegts_flags", "resend_headers", 0);

    return 0;
}

static int hls_write_header(AVFormatContext *s)
{
    HLSContext *hls = s->priv_data;
    int ret, i;
    char *p;
    const char *pattern = "%d.ts";
215
    int basename_size = strlen(s->filename) + strlen(pattern) + 1;
216

217
    hls->sequence       = hls->start_sequence;
218
    hls->recording_time = hls->time * AV_TIME_BASE;
219 220 221 222
    hls->start_pts      = AV_NOPTS_VALUE;

    for (i = 0; i < s->nb_streams; i++)
        hls->has_video +=
223
            s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO;
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250

    if (hls->has_video > 1)
        av_log(s, AV_LOG_WARNING,
               "More than a single video stream present, "
               "expect issues decoding it.\n");

    hls->oformat = av_guess_format("mpegts", NULL, NULL);

    if (!hls->oformat) {
        ret = AVERROR_MUXER_NOT_FOUND;
        goto fail;
    }

    hls->basename = av_malloc(basename_size);

    if (!hls->basename) {
        ret = AVERROR(ENOMEM);
        goto fail;
    }

    strcpy(hls->basename, s->filename);

    p = strrchr(hls->basename, '.');

    if (p)
        *p = '\0';

251
    av_strlcat(hls->basename, pattern, basename_size);
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277

    if ((ret = hls_mux_init(s)) < 0)
        goto fail;

    if ((ret = hls_start(s)) < 0)
        goto fail;

    if ((ret = avformat_write_header(hls->avf, NULL)) < 0)
        return ret;


fail:
    if (ret) {
        av_free(hls->basename);
        if (hls->avf)
            avformat_free_context(hls->avf);
    }
    return ret;
}

static int hls_write_packet(AVFormatContext *s, AVPacket *pkt)
{
    HLSContext *hls = s->priv_data;
    AVFormatContext *oc = hls->avf;
    AVStream *st = s->streams[pkt->stream_index];
    int64_t end_pts = hls->recording_time * hls->number;
278
    int64_t pts     = av_rescale_q(pkt->pts, st->time_base, AV_TIME_BASE_Q);
279
    int ret, can_split = 1;
280 281

    if (hls->start_pts == AV_NOPTS_VALUE) {
282 283
        hls->start_pts = pts;
        hls->end_pts   = pts;
284 285
    }

286
    if (hls->has_video) {
287
        can_split = st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO &&
288 289
                    pkt->flags & AV_PKT_FLAG_KEY;
    }
290 291 292
    if (pkt->pts == AV_NOPTS_VALUE)
        can_split = 0;
    else
293
        hls->duration = pts - hls->end_pts;
294

295
    if (can_split && pts - hls->start_pts >= end_pts) {
296
        ret = append_entry(hls, hls->duration);
297 298 299
        if (ret)
            return ret;

300
        hls->end_pts = pts;
301
        hls->duration = 0;
302 303

        av_write_frame(oc, NULL); /* Flush any buffered data */
304
        ff_format_io_close(s, &oc->pb);
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327

        ret = hls_start(s);

        if (ret)
            return ret;

        oc = hls->avf;

        if ((ret = hls_window(s, 0)) < 0)
            return ret;
    }

    ret = ff_write_chained(oc, pkt->stream_index, pkt, s);

    return ret;
}

static int hls_write_trailer(struct AVFormatContext *s)
{
    HLSContext *hls = s->priv_data;
    AVFormatContext *oc = hls->avf;

    av_write_trailer(oc);
328
    ff_format_io_close(s, &oc->pb);
329 330
    avformat_free_context(oc);
    av_free(hls->basename);
331
    append_entry(hls, hls->duration);
332 333 334 335 336 337 338 339 340
    hls_window(s, 1);

    free_entries(hls);
    return 0;
}

#define OFFSET(x) offsetof(HLSContext, x)
#define E AV_OPT_FLAG_ENCODING_PARAM
static const AVOption options[] = {
341
    {"start_number",  "first number in the sequence",            OFFSET(start_sequence),AV_OPT_TYPE_INT64,  {.i64 = 0},     0, INT64_MAX, E},
342 343 344
    {"hls_time",      "segment length in seconds",               OFFSET(time),    AV_OPT_TYPE_FLOAT,  {.dbl = 2},     0, FLT_MAX, E},
    {"hls_list_size", "maximum number of playlist entries",      OFFSET(size),    AV_OPT_TYPE_INT,    {.i64 = 5},     0, INT_MAX, E},
    {"hls_wrap",      "number after which the index wraps",      OFFSET(wrap),    AV_OPT_TYPE_INT,    {.i64 = 0},     0, INT_MAX, E},
345
    {"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},
346
    {"hls_base_url",  "url to prepend to each playlist entry",   OFFSET(baseurl), AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E},
347
    {"hls_version",   "protocol version",                        OFFSET(version), AV_OPT_TYPE_INT,    {.i64 = 3},     2, 3, E},
348 349 350 351 352 353 354 355 356 357 358 359 360
    { NULL },
};

static const AVClass hls_class = {
    .class_name = "hls muxer",
    .item_name  = av_default_item_name,
    .option     = options,
    .version    = LIBAVUTIL_VERSION_INT,
};


AVOutputFormat ff_hls_muxer = {
    .name           = "hls",
361
    .long_name      = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
362 363
    .extensions     = "m3u8",
    .priv_data_size = sizeof(HLSContext),
364 365
    .audio_codec    = AV_CODEC_ID_AAC,
    .video_codec    = AV_CODEC_ID_H264,
366 367 368 369 370 371
    .flags          = AVFMT_NOFILE | AVFMT_ALLOW_FLUSH,
    .write_header   = hls_write_header,
    .write_packet   = hls_write_packet,
    .write_trailer  = hls_write_trailer,
    .priv_class     = &hls_class,
};