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