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