2 * Apple HTTP Live Streaming segmenter
3 * Copyright (c) 2012, Luca Barbato
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
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 AVOutputFormat *oformat;
46 float time; // Set by a private option.
47 int size; // Set by a private option.
48 int wrap; // Set by a private option.
49 int64_t recording_time;
53 int64_t duration; // last segment duration computed so far, in seconds
61 static int hls_mux_init(AVFormatContext *s)
63 HLSContext *hls = s->priv_data;
67 hls->avf = oc = avformat_alloc_context();
69 return AVERROR(ENOMEM);
71 oc->oformat = hls->oformat;
72 oc->interrupt_callback = s->interrupt_callback;
74 for (i = 0; i < s->nb_streams; i++) {
76 if (!(st = avformat_new_stream(oc, NULL)))
77 return AVERROR(ENOMEM);
78 avcodec_copy_context(st->codec, s->streams[i]->codec);
79 st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
85 static int append_entry(HLSContext *hls, uint64_t duration)
87 ListEntry *en = av_malloc(sizeof(*en));
90 return AVERROR(ENOMEM);
92 av_strlcpy(en->name, av_basename(hls->avf->filename), sizeof(en->name));
94 en->duration = duration;
100 hls->end_list->next = en;
104 if (hls->nb_entries >= hls->size) {
106 hls->list = en->next;
116 static void free_entries(HLSContext *hls)
118 ListEntry *p = hls->list, *en;
127 static int hls_window(AVFormatContext *s, int last)
129 HLSContext *hls = s->priv_data;
131 int target_duration = 0;
134 if ((ret = avio_open2(&hls->pb, s->filename, AVIO_FLAG_WRITE,
135 &s->interrupt_callback, NULL)) < 0)
138 for (en = hls->list; en; en = en->next) {
139 if (target_duration < en->duration)
140 target_duration = en->duration;
143 avio_printf(hls->pb, "#EXTM3U\n");
144 avio_printf(hls->pb, "#EXT-X-VERSION:3\n");
145 avio_printf(hls->pb, "#EXT-X-TARGETDURATION:%d\n", target_duration);
146 avio_printf(hls->pb, "#EXT-X-MEDIA-SEQUENCE:%"PRId64"\n",
147 FFMAX(0, hls->sequence - hls->size));
149 for (en = hls->list; en; en = en->next) {
150 avio_printf(hls->pb, "#EXTINF:%d,\n", en->duration);
151 avio_printf(hls->pb, "%s\n", en->name);
155 avio_printf(hls->pb, "#EXT-X-ENDLIST\n");
158 avio_closep(&hls->pb);
162 static int hls_start(AVFormatContext *s)
164 HLSContext *c = s->priv_data;
165 AVFormatContext *oc = c->avf;
168 if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
169 c->basename, c->wrap ? c->number % c->wrap : c->number) < 0) {
170 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", c->basename);
171 return AVERROR(EINVAL);
175 if ((err = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
176 &s->interrupt_callback, NULL)) < 0)
179 if (oc->oformat->priv_class && oc->priv_data)
180 av_opt_set(oc->priv_data, "mpegts_flags", "resend_headers", 0);
185 static int hls_write_header(AVFormatContext *s)
187 HLSContext *hls = s->priv_data;
190 const char *pattern = "%d.ts";
191 int basename_size = strlen(s->filename) + strlen(pattern) + 1;
195 hls->recording_time = hls->time * AV_TIME_BASE;
196 hls->start_pts = AV_NOPTS_VALUE;
198 for (i = 0; i < s->nb_streams; i++)
200 s->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO;
202 if (hls->has_video > 1)
203 av_log(s, AV_LOG_WARNING,
204 "More than a single video stream present, "
205 "expect issues decoding it.\n");
207 hls->oformat = av_guess_format("mpegts", NULL, NULL);
210 ret = AVERROR_MUXER_NOT_FOUND;
214 hls->basename = av_malloc(basename_size);
216 if (!hls->basename) {
217 ret = AVERROR(ENOMEM);
221 strcpy(hls->basename, s->filename);
223 p = strrchr(hls->basename, '.');
228 av_strlcat(hls->basename, pattern, basename_size);
230 if ((ret = hls_mux_init(s)) < 0)
233 if ((ret = hls_start(s)) < 0)
236 if ((ret = avformat_write_header(hls->avf, NULL)) < 0)
242 av_free(hls->basename);
244 avformat_free_context(hls->avf);
249 static int hls_write_packet(AVFormatContext *s, AVPacket *pkt)
251 HLSContext *hls = s->priv_data;
252 AVFormatContext *oc = hls->avf;
253 AVStream *st = s->streams[pkt->stream_index];
254 int64_t end_pts = hls->recording_time * hls->number;
256 int ret, can_split = 1;
258 if (hls->start_pts == AV_NOPTS_VALUE) {
259 hls->start_pts = pkt->pts;
260 hls->end_pts = pkt->pts;
263 if (hls->has_video) {
264 can_split = st->codec->codec_type == AVMEDIA_TYPE_VIDEO &&
265 pkt->flags & AV_PKT_FLAG_KEY;
266 is_ref_pkt = st->codec->codec_type == AVMEDIA_TYPE_VIDEO;
268 if (pkt->pts == AV_NOPTS_VALUE)
269 is_ref_pkt = can_split = 0;
272 hls->duration = av_rescale(pkt->pts - hls->end_pts,
273 st->time_base.num, st->time_base.den);
275 if (can_split && av_compare_ts(pkt->pts - hls->start_pts, st->time_base,
276 end_pts, AV_TIME_BASE_Q) >= 0) {
277 ret = append_entry(hls, hls->duration);
281 hls->end_pts = pkt->pts;
284 av_write_frame(oc, NULL); /* Flush any buffered data */
294 if ((ret = hls_window(s, 0)) < 0)
298 ret = ff_write_chained(oc, pkt->stream_index, pkt, s);
303 static int hls_write_trailer(struct AVFormatContext *s)
305 HLSContext *hls = s->priv_data;
306 AVFormatContext *oc = hls->avf;
308 av_write_trailer(oc);
309 avio_closep(&oc->pb);
310 avformat_free_context(oc);
311 av_free(hls->basename);
312 append_entry(hls, hls->duration);
320 #define OFFSET(x) offsetof(HLSContext, x)
321 #define E AV_OPT_FLAG_ENCODING_PARAM
322 static const AVOption options[] = {
323 {"start_number", "set first number in the sequence", OFFSET(sequence),AV_OPT_TYPE_INT64, {.i64 = 0}, 0, INT64_MAX, E},
324 {"hls_time", "set segment length in seconds", OFFSET(time), AV_OPT_TYPE_FLOAT, {.dbl = 2}, 0, FLT_MAX, E},
325 {"hls_list_size", "set maximum number of playlist entries", OFFSET(size), AV_OPT_TYPE_INT, {.i64 = 5}, 0, INT_MAX, E},
326 {"hls_wrap", "set number after which the index wraps", OFFSET(wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E},
330 static const AVClass hls_class = {
331 .class_name = "hls muxer",
332 .item_name = av_default_item_name,
334 .version = LIBAVUTIL_VERSION_INT,
338 AVOutputFormat ff_hls_muxer = {
340 .long_name = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
341 .extensions = "m3u8",
342 .priv_data_size = sizeof(HLSContext),
343 .audio_codec = AV_CODEC_ID_MP2,
344 .video_codec = AV_CODEC_ID_MPEG2VIDEO,
345 .flags = AVFMT_NOFILE | AVFMT_ALLOW_FLUSH,
346 .write_header = hls_write_header,
347 .write_packet = hls_write_packet,
348 .write_trailer = hls_write_trailer,
349 .priv_class = &hls_class,