segment: Report the current media sequence
[ffmpeg.git] / libavformat / segment.c
1 /*
2  * Generic segmenter
3  * Copyright (c) 2011, 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 "avformat.h"
25 #include "internal.h"
26
27 #include "libavutil/log.h"
28 #include "libavutil/opt.h"
29 #include "libavutil/avstring.h"
30 #include "libavutil/parseutils.h"
31 #include "libavutil/mathematics.h"
32
33 typedef struct {
34     const AVClass *class;  /**< Class for private options. */
35     int number;
36     AVOutputFormat *oformat;
37     AVFormatContext *avf;
38     char *format;          /**< Set by a private option. */
39     char *list;            /**< Set by a private option. */
40     char *entry_prefix;    /**< Set by a private option. */
41     int  list_type;        /**< Set by a private option. */
42     float time;            /**< Set by a private option. */
43     int  size;             /**< Set by a private option. */
44     int  wrap;             /**< Set by a private option. */
45     int  individual_header_trailer; /**< Set by a private option. */
46     int  write_header_trailer; /**< Set by a private option. */
47     int64_t offset_time;
48     int64_t recording_time;
49     int has_video;
50     AVIOContext *pb;
51 } SegmentContext;
52
53 enum {
54     LIST_FLAT,
55     LIST_HLS
56 };
57
58 static int segment_mux_init(AVFormatContext *s)
59 {
60     SegmentContext *seg = s->priv_data;
61     AVFormatContext *oc;
62     int i;
63
64     seg->avf = oc = avformat_alloc_context();
65     if (!oc)
66         return AVERROR(ENOMEM);
67
68     oc->oformat            = seg->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 segment_hls_window(AVFormatContext *s, int last)
83 {
84     SegmentContext *seg = s->priv_data;
85     int i, ret = 0;
86     char buf[1024];
87
88     if ((ret = avio_open2(&seg->pb, seg->list, AVIO_FLAG_WRITE,
89                               &s->interrupt_callback, NULL)) < 0)
90         goto fail;
91
92     avio_printf(seg->pb, "#EXTM3U\n");
93     avio_printf(seg->pb, "#EXT-X-VERSION:3\n");
94     avio_printf(seg->pb, "#EXT-X-TARGETDURATION:%d\n", (int)seg->time);
95     avio_printf(seg->pb, "#EXT-X-MEDIA-SEQUENCE:%d\n",
96                 FFMAX(0, seg->number - seg->size));
97
98     av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%d\n",
99            FFMAX(0, seg->number - seg->size));
100
101     for (i = FFMAX(0, seg->number - seg->size);
102          i < seg->number; i++) {
103         avio_printf(seg->pb, "#EXTINF:%d,\n", (int)seg->time);
104         if (seg->entry_prefix != NULL) {
105             avio_printf(seg->pb, "%s", seg->entry_prefix);
106         }
107         av_get_frame_filename(buf, sizeof(buf), s->filename, i);
108         avio_printf(seg->pb, "%s\n", buf);
109     }
110
111     if (last)
112         avio_printf(seg->pb, "#EXT-X-ENDLIST\n");
113 fail:
114     avio_closep(&seg->pb);
115     return ret;
116 }
117
118 static int segment_start(AVFormatContext *s, int write_header)
119 {
120     SegmentContext *c = s->priv_data;
121     AVFormatContext *oc = c->avf;
122     int err = 0;
123
124     if (write_header) {
125         avformat_free_context(oc);
126         c->avf = NULL;
127         if ((err = segment_mux_init(s)) < 0)
128             return err;
129         oc = c->avf;
130     }
131
132     if (c->wrap)
133         c->number %= c->wrap;
134
135     if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
136                               s->filename, c->number++) < 0)
137         return AVERROR(EINVAL);
138
139     if ((err = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
140                           &s->interrupt_callback, NULL)) < 0)
141         return err;
142
143     if (oc->oformat->priv_class && oc->priv_data)
144         av_opt_set(oc->priv_data, "resend_headers", "1", 0); /* mpegts specific */
145
146     if (write_header) {
147         if ((err = avformat_write_header(oc, NULL)) < 0)
148             return err;
149     }
150
151     return 0;
152 }
153
154 static int segment_end(AVFormatContext *oc, int write_trailer)
155 {
156     int ret = 0;
157
158     av_write_frame(oc, NULL); /* Flush any buffered data (fragmented mp4) */
159     if (write_trailer)
160         av_write_trailer(oc);
161     avio_close(oc->pb);
162
163     return ret;
164 }
165
166 static int open_null_ctx(AVIOContext **ctx)
167 {
168     int buf_size = 32768;
169     uint8_t *buf = av_malloc(buf_size);
170     if (!buf)
171         return AVERROR(ENOMEM);
172     *ctx = avio_alloc_context(buf, buf_size, AVIO_FLAG_WRITE, NULL, NULL, NULL, NULL);
173     if (!*ctx) {
174         av_free(buf);
175         return AVERROR(ENOMEM);
176     }
177     return 0;
178 }
179
180 static void close_null_ctx(AVIOContext *pb)
181 {
182     av_free(pb->buffer);
183     av_free(pb);
184 }
185
186 static int seg_write_header(AVFormatContext *s)
187 {
188     SegmentContext *seg = s->priv_data;
189     AVFormatContext *oc = NULL;
190     int ret, i;
191
192     seg->number = 0;
193     seg->offset_time = 0;
194     seg->recording_time = seg->time * 1000000;
195     if (!seg->write_header_trailer)
196         seg->individual_header_trailer = 0;
197
198     if (seg->list && seg->list_type != LIST_HLS)
199         if ((ret = avio_open2(&seg->pb, seg->list, AVIO_FLAG_WRITE,
200                               &s->interrupt_callback, NULL)) < 0)
201             goto fail;
202
203     for (i = 0; i < s->nb_streams; i++)
204         seg->has_video +=
205             (s->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO);
206
207     if (seg->has_video > 1)
208         av_log(s, AV_LOG_WARNING,
209                "More than a single video stream present, "
210                "expect issues decoding it.\n");
211
212     seg->oformat = av_guess_format(seg->format, s->filename, NULL);
213
214     if (!seg->oformat) {
215         ret = AVERROR_MUXER_NOT_FOUND;
216         goto fail;
217     }
218     if (seg->oformat->flags & AVFMT_NOFILE) {
219         av_log(s, AV_LOG_ERROR, "format %s not supported.\n",
220                seg->oformat->name);
221         ret = AVERROR(EINVAL);
222         goto fail;
223     }
224
225     if ((ret = segment_mux_init(s)) < 0)
226         goto fail;
227     oc = seg->avf;
228
229     if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
230                               s->filename, seg->number++) < 0) {
231         ret = AVERROR(EINVAL);
232         goto fail;
233     }
234
235     if (seg->write_header_trailer) {
236         if ((ret = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
237                               &s->interrupt_callback, NULL)) < 0)
238             goto fail;
239     } else {
240         if ((ret = open_null_ctx(&oc->pb)) < 0)
241             goto fail;
242     }
243
244     if ((ret = avformat_write_header(oc, NULL)) < 0) {
245         avio_close(oc->pb);
246         goto fail;
247     }
248
249     if (!seg->write_header_trailer) {
250         close_null_ctx(oc->pb);
251         if ((ret = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
252                               &s->interrupt_callback, NULL)) < 0)
253             goto fail;
254     }
255
256     if (seg->list) {
257         if (seg->list_type == LIST_HLS) {
258             if ((ret = segment_hls_window(s, 0)) < 0)
259                 goto fail;
260         } else {
261             avio_printf(seg->pb, "%s\n", oc->filename);
262             avio_flush(seg->pb);
263         }
264     }
265
266 fail:
267     if (ret) {
268         if (seg->list)
269             avio_close(seg->pb);
270         if (seg->avf)
271             avformat_free_context(seg->avf);
272     }
273     return ret;
274 }
275
276 static int seg_write_packet(AVFormatContext *s, AVPacket *pkt)
277 {
278     SegmentContext *seg = s->priv_data;
279     AVFormatContext *oc = seg->avf;
280     AVStream *st = s->streams[pkt->stream_index];
281     int64_t end_pts = seg->recording_time * seg->number;
282     int ret, can_split = 1;
283
284     if (seg->has_video) {
285         can_split = st->codec->codec_type == AVMEDIA_TYPE_VIDEO &&
286                     pkt->flags & AV_PKT_FLAG_KEY;
287     }
288
289     if (can_split && av_compare_ts(pkt->pts, st->time_base, end_pts,
290                                    AV_TIME_BASE_Q) >= 0) {
291         av_log(s, AV_LOG_DEBUG, "Next segment starts at %d %"PRId64"\n",
292                pkt->stream_index, pkt->pts);
293
294         ret = segment_end(oc, seg->individual_header_trailer);
295
296         if (!ret)
297             ret = segment_start(s, seg->individual_header_trailer);
298
299         if (ret)
300             goto fail;
301
302         oc = seg->avf;
303
304         if (seg->list) {
305             if (seg->list_type == LIST_HLS) {
306                 if ((ret = segment_hls_window(s, 0)) < 0)
307                     goto fail;
308             } else {
309                 avio_printf(seg->pb, "%s\n", oc->filename);
310                 avio_flush(seg->pb);
311                 if (seg->size && !(seg->number % seg->size)) {
312                     avio_closep(&seg->pb);
313                     if ((ret = avio_open2(&seg->pb, seg->list, AVIO_FLAG_WRITE,
314                                           &s->interrupt_callback, NULL)) < 0)
315                         goto fail;
316                 }
317             }
318         }
319     }
320
321     ret = ff_write_chained(oc, pkt->stream_index, pkt, s);
322
323 fail:
324     if (ret < 0) {
325         if (seg->list)
326             avio_close(seg->pb);
327         avformat_free_context(oc);
328     }
329
330     return ret;
331 }
332
333 static int seg_write_trailer(struct AVFormatContext *s)
334 {
335     SegmentContext *seg = s->priv_data;
336     AVFormatContext *oc = seg->avf;
337     int ret;
338     if (!seg->write_header_trailer) {
339         if ((ret = segment_end(oc, 0)) < 0)
340             goto fail;
341         open_null_ctx(&oc->pb);
342         ret = av_write_trailer(oc);
343         close_null_ctx(oc->pb);
344     } else {
345         ret = segment_end(oc, 1);
346     }
347
348     if (ret < 0)
349         goto fail;
350
351     if (seg->list && seg->list_type == LIST_HLS) {
352         if ((ret = segment_hls_window(s, 1) < 0))
353             goto fail;
354     }
355
356 fail:
357     avio_close(seg->pb);
358     avformat_free_context(oc);
359     return ret;
360 }
361
362 #define OFFSET(x) offsetof(SegmentContext, x)
363 #define E AV_OPT_FLAG_ENCODING_PARAM
364 static const AVOption options[] = {
365     { "segment_format",    "container format used for the segments",  OFFSET(format),  AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
366     { "segment_time",      "segment length in seconds",               OFFSET(time),    AV_OPT_TYPE_FLOAT,  {.dbl = 2},     0, FLT_MAX, E },
367     { "segment_list",      "output the segment list",                 OFFSET(list),    AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
368     { "segment_list_size", "maximum number of playlist entries",      OFFSET(size),    AV_OPT_TYPE_INT,    {.i64 = 5},     0, INT_MAX, E },
369     { "segment_list_type", "segment list format",                     OFFSET(list_type),    AV_OPT_TYPE_INT,    {.i64 = LIST_FLAT},     0, 2, E, "list_type" },
370     {   "flat",            "plain list (default)",                    0,               AV_OPT_TYPE_CONST,  {.i64 = LIST_FLAT}, 0, 0, E, "list_type" },
371     {   "hls",             "Apple HTTP Live Streaming compatible",    0,               AV_OPT_TYPE_CONST,  {.i64 = LIST_HLS},  0, 0, E, "list_type" },
372     { "segment_wrap",      "number after which the index wraps",      OFFSET(wrap),    AV_OPT_TYPE_INT,    {.i64 = 0},     0, INT_MAX, E },
373     { "segment_list_entry_prefix",  "base url prefix for segments",   OFFSET(entry_prefix), AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
374     { "individual_header_trailer", "write header/trailer to each segment", OFFSET(individual_header_trailer), AV_OPT_TYPE_INT, {.i64 = 1}, 0, 1, E },
375     { "write_header_trailer", "write a header to the first segment and a trailer to the last one", OFFSET(write_header_trailer), AV_OPT_TYPE_INT, {.i64 = 1}, 0, 1, E },
376     { NULL },
377 };
378
379 static const AVClass seg_class = {
380     .class_name = "segment muxer",
381     .item_name  = av_default_item_name,
382     .option     = options,
383     .version    = LIBAVUTIL_VERSION_INT,
384 };
385
386
387 AVOutputFormat ff_segment_muxer = {
388     .name           = "segment",
389     .long_name      = NULL_IF_CONFIG_SMALL("segment"),
390     .priv_data_size = sizeof(SegmentContext),
391     .flags          = AVFMT_NOFILE,
392     .write_header   = seg_write_header,
393     .write_packet   = seg_write_packet,
394     .write_trailer  = seg_write_trailer,
395     .priv_class     = &seg_class,
396 };