Merge remote-tracking branch 'qatar/master'
[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 FFmpeg.
6  *
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.
11  *
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.
16  *
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
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     int   duration;
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     AVOutputFormat *oformat;
45     AVFormatContext *avf;
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;
50     int has_video;
51     int64_t start_pts;
52     int64_t end_pts;
53     int64_t duration;      // last segment duration computed so far, in seconds
54     int nb_entries;
55     ListEntry *list;
56     ListEntry *end_list;
57     char *basename;
58     AVIOContext *pb;
59 } HLSContext;
60
61 static int hls_mux_init(AVFormatContext *s)
62 {
63     HLSContext *hls = s->priv_data;
64     AVFormatContext *oc;
65     int i;
66
67     hls->avf = oc = avformat_alloc_context();
68     if (!oc)
69         return AVERROR(ENOMEM);
70
71     oc->oformat            = hls->oformat;
72     oc->interrupt_callback = s->interrupt_callback;
73
74     for (i = 0; i < s->nb_streams; i++) {
75         AVStream *st;
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;
80     }
81
82     return 0;
83 }
84
85 static int append_entry(HLSContext *hls, uint64_t duration)
86 {
87     ListEntry *en = av_malloc(sizeof(*en));
88
89     if (!en)
90         return AVERROR(ENOMEM);
91
92     av_strlcpy(en->name, av_basename(hls->avf->filename), sizeof(en->name));
93
94     en->duration = duration;
95     en->next     = NULL;
96
97     if (!hls->list)
98         hls->list = en;
99     else
100         hls->end_list->next = en;
101
102     hls->end_list = en;
103
104     if (hls->nb_entries >= hls->size) {
105         en = hls->list;
106         hls->list = en->next;
107         av_free(en);
108     } else
109         hls->nb_entries++;
110
111     hls->sequence++;
112
113     return 0;
114 }
115
116 static void free_entries(HLSContext *hls)
117 {
118     ListEntry *p = hls->list, *en;
119
120     while(p) {
121         en = p;
122         p = p->next;
123         av_free(en);
124     }
125 }
126
127 static int hls_window(AVFormatContext *s, int last)
128 {
129     HLSContext *hls = s->priv_data;
130     ListEntry *en;
131     int target_duration = 0;
132     int ret = 0;
133
134     if ((ret = avio_open2(&hls->pb, s->filename, AVIO_FLAG_WRITE,
135                           &s->interrupt_callback, NULL)) < 0)
136         goto fail;
137
138     for (en = hls->list; en; en = en->next) {
139         if (target_duration < en->duration)
140             target_duration = en->duration;
141     }
142
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));
148
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);
152     }
153
154     if (last)
155         avio_printf(hls->pb, "#EXT-X-ENDLIST\n");
156
157 fail:
158     avio_closep(&hls->pb);
159     return ret;
160 }
161
162 static int hls_start(AVFormatContext *s)
163 {
164     HLSContext *c = s->priv_data;
165     AVFormatContext *oc = c->avf;
166     int err = 0;
167
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);
172     }
173     c->number++;
174
175     if ((err = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
176                           &s->interrupt_callback, NULL)) < 0)
177         return err;
178
179     if (oc->oformat->priv_class && oc->priv_data)
180         av_opt_set(oc->priv_data, "mpegts_flags", "resend_headers", 0);
181
182     return 0;
183 }
184
185 static int hls_write_header(AVFormatContext *s)
186 {
187     HLSContext *hls = s->priv_data;
188     int ret, i;
189     char *p;
190     const char *pattern = "%d.ts";
191     int basename_size = strlen(s->filename) + strlen(pattern) + 1;
192
193     hls->number      = 0;
194
195     hls->recording_time = hls->time * AV_TIME_BASE;
196     hls->start_pts      = AV_NOPTS_VALUE;
197
198     for (i = 0; i < s->nb_streams; i++)
199         hls->has_video +=
200             s->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO;
201
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");
206
207     hls->oformat = av_guess_format("mpegts", NULL, NULL);
208
209     if (!hls->oformat) {
210         ret = AVERROR_MUXER_NOT_FOUND;
211         goto fail;
212     }
213
214     hls->basename = av_malloc(basename_size);
215
216     if (!hls->basename) {
217         ret = AVERROR(ENOMEM);
218         goto fail;
219     }
220
221     strcpy(hls->basename, s->filename);
222
223     p = strrchr(hls->basename, '.');
224
225     if (p)
226         *p = '\0';
227
228     av_strlcat(hls->basename, pattern, basename_size);
229
230     if ((ret = hls_mux_init(s)) < 0)
231         goto fail;
232
233     if ((ret = hls_start(s)) < 0)
234         goto fail;
235
236     if ((ret = avformat_write_header(hls->avf, NULL)) < 0)
237         return ret;
238
239
240 fail:
241     if (ret) {
242         av_free(hls->basename);
243         if (hls->avf)
244             avformat_free_context(hls->avf);
245     }
246     return ret;
247 }
248
249 static int hls_write_packet(AVFormatContext *s, AVPacket *pkt)
250 {
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;
255     int is_ref_pkt = 1;
256     int ret, can_split = 1;
257
258     if (hls->start_pts == AV_NOPTS_VALUE) {
259         hls->start_pts = pkt->pts;
260         hls->end_pts   = pkt->pts;
261     }
262
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;
267     }
268     if (pkt->pts == AV_NOPTS_VALUE)
269         is_ref_pkt = can_split = 0;
270
271     if (is_ref_pkt)
272         hls->duration = av_rescale(pkt->pts - hls->end_pts,
273                                    st->time_base.num, st->time_base.den);
274
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);
278         if (ret)
279             return ret;
280
281         hls->end_pts = pkt->pts;
282         hls->duration = 0;
283
284         av_write_frame(oc, NULL); /* Flush any buffered data */
285         avio_close(oc->pb);
286
287         ret = hls_start(s);
288
289         if (ret)
290             return ret;
291
292         oc = hls->avf;
293
294         if ((ret = hls_window(s, 0)) < 0)
295             return ret;
296     }
297
298     ret = ff_write_chained(oc, pkt->stream_index, pkt, s);
299
300     return ret;
301 }
302
303 static int hls_write_trailer(struct AVFormatContext *s)
304 {
305     HLSContext *hls = s->priv_data;
306     AVFormatContext *oc = hls->avf;
307
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);
313     hls_window(s, 1);
314
315     free_entries(hls);
316     avio_close(hls->pb);
317     return 0;
318 }
319
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},
327     { NULL },
328 };
329
330 static const AVClass hls_class = {
331     .class_name = "hls muxer",
332     .item_name  = av_default_item_name,
333     .option     = options,
334     .version    = LIBAVUTIL_VERSION_INT,
335 };
336
337
338 AVOutputFormat ff_hls_muxer = {
339     .name           = "hls",
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,
350 };