96b780fe37776a5021a70ded1841b85af29d7d0a
[libav.git] / 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 int64_t duration; // segment duration in AV_TIME_BASE units
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 version; // Set by a private option.
51 int allowcache;
52 int64_t recording_time;
53 int has_video;
54 // The following timestamps are in AV_TIME_BASE units.
55 int64_t start_pts;
56 int64_t end_pts;
57 int64_t duration; // last segment duration computed so far.
58 int nb_entries;
59 ListEntry *list;
60 ListEntry *end_list;
61 char *basename;
62 char *baseurl;
63 } HLSContext;
64
65 static int hls_mux_init(AVFormatContext *s)
66 {
67 HLSContext *hls = s->priv_data;
68 AVFormatContext *oc;
69 int i;
70
71 hls->avf = oc = avformat_alloc_context();
72 if (!oc)
73 return AVERROR(ENOMEM);
74
75 oc->oformat = hls->oformat;
76 oc->interrupt_callback = s->interrupt_callback;
77 oc->opaque = s->opaque;
78 oc->io_open = s->io_open;
79 oc->io_close = s->io_close;
80
81 for (i = 0; i < s->nb_streams; i++) {
82 AVStream *st;
83 if (!(st = avformat_new_stream(oc, NULL)))
84 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 return 0;
91 }
92
93 static int append_entry(HLSContext *hls, int64_t duration)
94 {
95 ListEntry *en = av_malloc(sizeof(*en));
96
97 if (!en)
98 return AVERROR(ENOMEM);
99
100 av_strlcpy(en->name, av_basename(hls->avf->filename), sizeof(en->name));
101
102 en->duration = duration;
103 en->next = NULL;
104
105 if (!hls->list)
106 hls->list = en;
107 else
108 hls->end_list->next = en;
109
110 hls->end_list = en;
111
112 if (hls->nb_entries >= hls->size) {
113 en = hls->list;
114 hls->list = en->next;
115 av_free(en);
116 } else
117 hls->nb_entries++;
118
119 hls->sequence++;
120
121 return 0;
122 }
123
124 static void free_entries(HLSContext *hls)
125 {
126 ListEntry *p = hls->list, *en;
127
128 while(p) {
129 en = p;
130 p = p->next;
131 av_free(en);
132 }
133 }
134
135 static int hls_window(AVFormatContext *s, int last)
136 {
137 HLSContext *hls = s->priv_data;
138 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 goto fail;
148
149 for (en = hls->list; en; en = en->next) {
150 if (target_duration < en->duration)
151 target_duration = en->duration;
152 }
153
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 av_rescale_rnd(target_duration, 1, AV_TIME_BASE,
161 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 if (hls->version > 2)
169 avio_printf(out, "#EXTINF:%f\n",
170 (double)en->duration / AV_TIME_BASE);
171 else
172 avio_printf(out, "#EXTINF:%"PRId64",\n",
173 av_rescale(en->duration, 1, AV_TIME_BASE));
174 if (hls->baseurl)
175 avio_printf(out, "%s", hls->baseurl);
176 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 if (ret >= 0)
185 ff_rename(temp_filename, s->filename);
186 return ret;
187 }
188
189 static int hls_start(AVFormatContext *s)
190 {
191 HLSContext *c = s->priv_data;
192 AVFormatContext *oc = c->avf;
193 int err = 0;
194
195 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 return err;
202
203 if (oc->oformat->priv_class && oc->priv_data)
204 av_opt_set(oc->priv_data, "mpegts_flags", "resend_headers", 0);
205
206 return 0;
207 }
208
209 static int hls_write_header(AVFormatContext *s)
210 {
211 HLSContext *hls = s->priv_data;
212 int ret, i;
213 char *p;
214 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 hls->start_pts = AV_NOPTS_VALUE;
220
221 for (i = 0; i < s->nb_streams; i++)
222 hls->has_video +=
223 s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO;
224
225 if (hls->has_video > 1)
226 av_log(s, AV_LOG_WARNING,
227 "More than a single video stream present, "
228 "expect issues decoding it.\n");
229
230 hls->oformat = av_guess_format("mpegts", NULL, NULL);
231
232 if (!hls->oformat) {
233 ret = AVERROR_MUXER_NOT_FOUND;
234 goto fail;
235 }
236
237 hls->basename = av_malloc(basename_size);
238
239 if (!hls->basename) {
240 ret = AVERROR(ENOMEM);
241 goto fail;
242 }
243
244 strcpy(hls->basename, s->filename);
245
246 p = strrchr(hls->basename, '.');
247
248 if (p)
249 *p = '\0';
250
251 av_strlcat(hls->basename, pattern, basename_size);
252
253 if ((ret = hls_mux_init(s)) < 0)
254 goto fail;
255
256 if ((ret = hls_start(s)) < 0)
257 goto fail;
258
259 if ((ret = avformat_write_header(hls->avf, NULL)) < 0)
260 return ret;
261
262
263 fail:
264 if (ret) {
265 av_free(hls->basename);
266 if (hls->avf)
267 avformat_free_context(hls->avf);
268 }
269 return ret;
270 }
271
272 static int hls_write_packet(AVFormatContext *s, AVPacket *pkt)
273 {
274 HLSContext *hls = s->priv_data;
275 AVFormatContext *oc = hls->avf;
276 AVStream *st = s->streams[pkt->stream_index];
277 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 hls->start_pts = pts;
283 hls->end_pts = pts;
284 }
285
286 if (hls->has_video) {
287 can_split = st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO &&
288 pkt->flags & AV_PKT_FLAG_KEY;
289 }
290 if (pkt->pts == AV_NOPTS_VALUE)
291 can_split = 0;
292 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 if (ret)
298 return ret;
299
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 ret = hls_start(s);
307
308 if (ret)
309 return ret;
310
311 oc = hls->avf;
312
313 if ((ret = hls_window(s, 0)) < 0)
314 return ret;
315 }
316
317 ret = ff_write_chained(oc, pkt->stream_index, pkt, s);
318
319 return ret;
320 }
321
322 static int hls_write_trailer(struct AVFormatContext *s)
323 {
324 HLSContext *hls = s->priv_data;
325 AVFormatContext *oc = hls->avf;
326
327 av_write_trailer(oc);
328 ff_format_io_close(s, &oc->pb);
329 avformat_free_context(oc);
330 av_free(hls->basename);
331 append_entry(hls, hls->duration);
332 hls_window(s, 1);
333
334 free_entries(hls);
335 return 0;
336 }
337
338 #define OFFSET(x) offsetof(HLSContext, x)
339 #define E AV_OPT_FLAG_ENCODING_PARAM
340 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 {"hls_time", "segment length in seconds", OFFSET(time), AV_OPT_TYPE_FLOAT, {.dbl = 2}, 0, FLT_MAX, E},
343 {"hls_list_size", "maximum number of playlist entries", OFFSET(size), AV_OPT_TYPE_INT, {.i64 = 5}, 0, INT_MAX, E},
344 {"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 { NULL },
349 };
350
351 static const AVClass hls_class = {
352 .class_name = "hls muxer",
353 .item_name = av_default_item_name,
354 .option = options,
355 .version = LIBAVUTIL_VERSION_INT,
356 };
357
358
359 AVOutputFormat ff_hls_muxer = {
360 .name = "hls",
361 .long_name = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
362 .extensions = "m3u8",
363 .priv_data_size = sizeof(HLSContext),
364 .audio_codec = AV_CODEC_ID_AAC,
365 .video_codec = AV_CODEC_ID_H264,
366 .flags = AVFMT_NOFILE | AVFMT_ALLOW_FLUSH,
367 .write_header = hls_write_header,
368 .write_packet = hls_write_packet,
369 .write_trailer = hls_write_trailer,
370 .priv_class = &hls_class,
371 };