2 * Apple HTTP Live Streaming segmenter
3 * Copyright (c) 2012, Luca Barbato
5 * This file is part of Libav.
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.
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.
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
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"
34 typedef struct ListEntry {
37 struct ListEntry *next;
40 typedef struct HLSContext {
41 const AVClass *class; // Class for private options.
44 int64_t start_sequence;
45 AVOutputFormat *oformat;
47 float time; // Set by a private option.
48 int size; // Set by a private option.
49 int wrap; // Set by a private option.
51 int64_t recording_time;
55 int64_t duration; // last segment duration computed so far, in seconds
63 static int hls_mux_init(AVFormatContext *s)
65 HLSContext *hls = s->priv_data;
69 hls->avf = oc = avformat_alloc_context();
71 return AVERROR(ENOMEM);
73 oc->oformat = hls->oformat;
74 oc->interrupt_callback = s->interrupt_callback;
76 for (i = 0; i < s->nb_streams; i++) {
78 if (!(st = avformat_new_stream(oc, NULL)))
79 return AVERROR(ENOMEM);
80 avcodec_copy_context(st->codec, s->streams[i]->codec);
81 st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
82 st->time_base = s->streams[i]->time_base;
88 static int append_entry(HLSContext *hls, uint64_t duration)
90 ListEntry *en = av_malloc(sizeof(*en));
93 return AVERROR(ENOMEM);
95 av_strlcpy(en->name, av_basename(hls->avf->filename), sizeof(en->name));
97 en->duration = duration;
103 hls->end_list->next = en;
107 if (hls->nb_entries >= hls->size) {
109 hls->list = en->next;
119 static void free_entries(HLSContext *hls)
121 ListEntry *p = hls->list, *en;
130 static int hls_window(AVFormatContext *s, int last)
132 HLSContext *hls = s->priv_data;
134 int target_duration = 0;
136 AVIOContext *out = NULL;
137 char temp_filename[1024];
138 int64_t sequence = FFMAX(hls->start_sequence, hls->sequence - hls->size);
140 snprintf(temp_filename, sizeof(temp_filename), "%s.tmp", s->filename);
141 if ((ret = avio_open2(&out, temp_filename, AVIO_FLAG_WRITE,
142 &s->interrupt_callback, NULL)) < 0)
145 for (en = hls->list; en; en = en->next) {
146 if (target_duration < en->duration)
147 target_duration = en->duration;
150 avio_printf(out, "#EXTM3U\n");
151 avio_printf(out, "#EXT-X-VERSION:3\n");
152 if (hls->allowcache == 0 || hls->allowcache == 1) {
153 avio_printf(out, "#EXT-X-ALLOW-CACHE:%s\n", hls->allowcache == 0 ? "NO" : "YES");
155 avio_printf(out, "#EXT-X-TARGETDURATION:%d\n", target_duration);
156 avio_printf(out, "#EXT-X-MEDIA-SEQUENCE:%"PRId64"\n", sequence);
158 av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%"PRId64"\n",
161 for (en = hls->list; en; en = en->next) {
162 avio_printf(out, "#EXTINF:%d,\n", en->duration);
164 avio_printf(out, "%s", hls->baseurl);
165 avio_printf(out, "%s\n", en->name);
169 avio_printf(out, "#EXT-X-ENDLIST\n");
174 ff_rename(temp_filename, s->filename);
178 static int hls_start(AVFormatContext *s)
180 HLSContext *c = s->priv_data;
181 AVFormatContext *oc = c->avf;
184 if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
185 c->basename, c->wrap ? c->sequence % c->wrap : c->sequence) < 0)
186 return AVERROR(EINVAL);
189 if ((err = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
190 &s->interrupt_callback, NULL)) < 0)
193 if (oc->oformat->priv_class && oc->priv_data)
194 av_opt_set(oc->priv_data, "mpegts_flags", "resend_headers", 0);
199 static int hls_write_header(AVFormatContext *s)
201 HLSContext *hls = s->priv_data;
204 const char *pattern = "%d.ts";
205 int basename_size = strlen(s->filename) + strlen(pattern) + 1;
207 hls->sequence = hls->start_sequence;
208 hls->recording_time = hls->time * AV_TIME_BASE;
209 hls->start_pts = AV_NOPTS_VALUE;
211 for (i = 0; i < s->nb_streams; i++)
213 s->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO;
215 if (hls->has_video > 1)
216 av_log(s, AV_LOG_WARNING,
217 "More than a single video stream present, "
218 "expect issues decoding it.\n");
220 hls->oformat = av_guess_format("mpegts", NULL, NULL);
223 ret = AVERROR_MUXER_NOT_FOUND;
227 hls->basename = av_malloc(basename_size);
229 if (!hls->basename) {
230 ret = AVERROR(ENOMEM);
234 strcpy(hls->basename, s->filename);
236 p = strrchr(hls->basename, '.');
241 av_strlcat(hls->basename, pattern, basename_size);
243 if ((ret = hls_mux_init(s)) < 0)
246 if ((ret = hls_start(s)) < 0)
249 if ((ret = avformat_write_header(hls->avf, NULL)) < 0)
255 av_free(hls->basename);
257 avformat_free_context(hls->avf);
262 static int hls_write_packet(AVFormatContext *s, AVPacket *pkt)
264 HLSContext *hls = s->priv_data;
265 AVFormatContext *oc = hls->avf;
266 AVStream *st = s->streams[pkt->stream_index];
267 int64_t end_pts = hls->recording_time * hls->number;
268 int ret, can_split = 1;
270 if (hls->start_pts == AV_NOPTS_VALUE) {
271 hls->start_pts = pkt->pts;
272 hls->end_pts = pkt->pts;
275 if (hls->has_video) {
276 can_split = st->codec->codec_type == AVMEDIA_TYPE_VIDEO &&
277 pkt->flags & AV_PKT_FLAG_KEY;
279 if (pkt->pts == AV_NOPTS_VALUE)
282 hls->duration = av_rescale(pkt->pts - hls->end_pts,
283 st->time_base.num, st->time_base.den);
285 if (can_split && av_compare_ts(pkt->pts - hls->start_pts, st->time_base,
286 end_pts, AV_TIME_BASE_Q) >= 0) {
287 ret = append_entry(hls, hls->duration);
291 hls->end_pts = pkt->pts;
294 av_write_frame(oc, NULL); /* Flush any buffered data */
304 if ((ret = hls_window(s, 0)) < 0)
308 ret = ff_write_chained(oc, pkt->stream_index, pkt, s);
313 static int hls_write_trailer(struct AVFormatContext *s)
315 HLSContext *hls = s->priv_data;
316 AVFormatContext *oc = hls->avf;
318 av_write_trailer(oc);
319 avio_closep(&oc->pb);
320 avformat_free_context(oc);
321 av_free(hls->basename);
322 append_entry(hls, hls->duration);
329 #define OFFSET(x) offsetof(HLSContext, x)
330 #define E AV_OPT_FLAG_ENCODING_PARAM
331 static const AVOption options[] = {
332 {"start_number", "first number in the sequence", OFFSET(start_sequence),AV_OPT_TYPE_INT64, {.i64 = 0}, 0, INT64_MAX, E},
333 {"hls_time", "segment length in seconds", OFFSET(time), AV_OPT_TYPE_FLOAT, {.dbl = 2}, 0, FLT_MAX, E},
334 {"hls_list_size", "maximum number of playlist entries", OFFSET(size), AV_OPT_TYPE_INT, {.i64 = 5}, 0, INT_MAX, E},
335 {"hls_wrap", "number after which the index wraps", OFFSET(wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E},
336 {"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},
337 {"hls_base_url", "url to prepend to each playlist entry", OFFSET(baseurl), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
341 static const AVClass hls_class = {
342 .class_name = "hls muxer",
343 .item_name = av_default_item_name,
345 .version = LIBAVUTIL_VERSION_INT,
349 AVOutputFormat ff_hls_muxer = {
351 .long_name = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
352 .extensions = "m3u8",
353 .priv_data_size = sizeof(HLSContext),
354 .audio_codec = AV_CODEC_ID_AAC,
355 .video_codec = AV_CODEC_ID_H264,
356 .flags = AVFMT_NOFILE | AVFMT_ALLOW_FLUSH,
357 .write_header = hls_write_header,
358 .write_packet = hls_write_packet,
359 .write_trailer = hls_write_trailer,
360 .priv_class = &hls_class,