lavf/segment: unbreak behavior for segment muxer
[ffmpeg.git] / libavformat / segment.c
1 /*
2  * Copyright (c) 2011, Luca Barbato
3  *
4  * This file is part of Libav.
5  *
6  * Libav is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * Libav is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file generic segmenter
23  * M3U8 specification can be find here:
24  * @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming-08.txt}
25  */
26
27 #include <float.h>
28
29 #include "avformat.h"
30 #include "internal.h"
31
32 #include "libavutil/avassert.h"
33 #include "libavutil/log.h"
34 #include "libavutil/opt.h"
35 #include "libavutil/avstring.h"
36 #include "libavutil/parseutils.h"
37 #include "libavutil/mathematics.h"
38
39 typedef enum {
40     LIST_TYPE_UNDEFINED = -1,
41     LIST_TYPE_FLAT = 0,
42     LIST_TYPE_CSV,
43     LIST_TYPE_M3U8,
44     LIST_TYPE_EXT, ///< deprecated
45     LIST_TYPE_NB,
46 } ListType;
47
48
49 #define SEGMENT_LIST_FLAG_CACHE 1
50 #define SEGMENT_LIST_FLAG_LIVE  2
51
52 typedef struct {
53     const AVClass *class;  /**< Class for private options. */
54     int segment_idx;       ///< index of the segment file to write, starting from 0
55     int segment_idx_wrap;  ///< number after which the index wraps
56     int segment_count;     ///< number of segment files already written
57     AVOutputFormat *oformat;
58     AVFormatContext *avf;
59     char *format;          ///< format to use for output segment files
60     char *list;            ///< filename for the segment list file
61     int   list_count;      ///< list counter
62     int   list_flags;      ///< flags affecting list generation
63     int   list_size;       ///< number of entries for the segment list file
64     double list_max_segment_time; ///< max segment time in the current list
65     ListType list_type;    ///< set the list type
66     AVIOContext *list_pb;  ///< list file put-byte context
67     char *time_str;        ///< segment duration specification string
68     int64_t time;          ///< segment duration
69     char *times_str;       ///< segment times specification string
70     int64_t *times;        ///< list of segment interval specification
71     int nb_times;          ///< number of elments in the times array
72     char *time_delta_str;  ///< approximation value duration used for the segment times
73     int64_t time_delta;
74     int  individual_header_trailer; /**< Set by a private option. */
75     int  write_header_trailer; /**< Set by a private option. */
76     int has_video;
77     double start_time, end_time;
78 } SegmentContext;
79
80 static void print_csv_escaped_str(AVIOContext *ctx, const char *str)
81 {
82     int needs_quoting = !!str[strcspn(str, "\",\n\r")];
83
84     if (needs_quoting)
85         avio_w8(ctx, '"');
86
87     for (; *str; str++) {
88         if (*str == '"')
89             avio_w8(ctx, '"');
90         avio_w8(ctx, *str);
91     }
92     if (needs_quoting)
93         avio_w8(ctx, '"');
94 }
95
96 static int segment_mux_init(AVFormatContext *s)
97 {
98     SegmentContext *seg = s->priv_data;
99     AVFormatContext *oc;
100     int i;
101
102     seg->avf = oc = avformat_alloc_context();
103     if (!oc)
104         return AVERROR(ENOMEM);
105
106     oc->oformat            = seg->oformat;
107     oc->interrupt_callback = s->interrupt_callback;
108
109     for (i = 0; i < s->nb_streams; i++) {
110         AVStream *st;
111         AVCodecContext *icodec, *ocodec;
112
113         if (!(st = avformat_new_stream(oc, NULL)))
114             return AVERROR(ENOMEM);
115         icodec = s->streams[i]->codec;
116         ocodec = st->codec;
117         avcodec_copy_context(ocodec, icodec);
118         if (!oc->oformat->codec_tag ||
119             av_codec_get_id (oc->oformat->codec_tag, icodec->codec_tag) == ocodec->codec_id ||
120             av_codec_get_tag(oc->oformat->codec_tag, icodec->codec_id) <= 0) {
121             ocodec->codec_tag = icodec->codec_tag;
122         } else {
123             ocodec->codec_tag = 0;
124         }
125         st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
126     }
127
128     return 0;
129 }
130
131 static int segment_start(AVFormatContext *s, int write_header)
132 {
133     SegmentContext *seg = s->priv_data;
134     AVFormatContext *oc = seg->avf;
135     int err = 0;
136
137     if (write_header) {
138         avformat_free_context(oc);
139         seg->avf = NULL;
140         if ((err = segment_mux_init(s)) < 0)
141             return err;
142         oc = seg->avf;
143     }
144
145     if (seg->segment_idx_wrap)
146         seg->segment_idx %= seg->segment_idx_wrap;
147
148     if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
149                               s->filename, seg->segment_idx++) < 0) {
150         av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", s->filename);
151         return AVERROR(EINVAL);
152     }
153     seg->segment_count++;
154
155     if ((err = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
156                           &s->interrupt_callback, NULL)) < 0)
157         return err;
158
159     if (oc->oformat->priv_class && oc->priv_data)
160         av_opt_set(oc->priv_data, "resend_headers", "1", 0); /* mpegts specific */
161
162     if (write_header) {
163         if ((err = avformat_write_header(oc, NULL)) < 0)
164             return err;
165     }
166
167     return 0;
168 }
169
170 static int segment_list_open(AVFormatContext *s)
171 {
172     SegmentContext *seg = s->priv_data;
173     int ret;
174
175     ret = avio_open2(&seg->list_pb, seg->list, AVIO_FLAG_WRITE,
176                      &s->interrupt_callback, NULL);
177     if (ret < 0)
178         return ret;
179     seg->list_max_segment_time = 0;
180
181     if (seg->list_type == LIST_TYPE_M3U8) {
182         avio_printf(seg->list_pb, "#EXTM3U\n");
183         avio_printf(seg->list_pb, "#EXT-X-VERSION:3\n");
184         avio_printf(seg->list_pb, "#EXT-X-MEDIA-SEQUENCE:%d\n", seg->list_count);
185         avio_printf(seg->list_pb, "#EXT-X-ALLOWCACHE:%d\n",
186                     !!(seg->list_flags & SEGMENT_LIST_FLAG_CACHE));
187         if (seg->list_flags & SEGMENT_LIST_FLAG_LIVE)
188             avio_printf(seg->list_pb,
189                         "#EXT-X-TARGETDURATION:%"PRId64"\n", seg->time / 1000000);
190     }
191
192     return ret;
193 }
194
195 static void segment_list_close(AVFormatContext *s)
196 {
197     SegmentContext *seg = s->priv_data;
198
199     if (seg->list_type == LIST_TYPE_M3U8) {
200         if (!(seg->list_flags & SEGMENT_LIST_FLAG_LIVE))
201             avio_printf(seg->list_pb, "#EXT-X-TARGETDURATION:%d\n",
202                         (int)ceil(seg->list_max_segment_time));
203         avio_printf(seg->list_pb, "#EXT-X-ENDLIST\n");
204     }
205     seg->list_count++;
206
207     avio_close(seg->list_pb);
208 }
209
210 static int segment_end(AVFormatContext *s, int write_trailer)
211 {
212     SegmentContext *seg = s->priv_data;
213     AVFormatContext *oc = seg->avf;
214     int ret = 0;
215
216     av_write_frame(oc, NULL); /* Flush any buffered data (fragmented mp4) */
217     if (write_trailer)
218         ret = av_write_trailer(oc);
219
220     if (ret < 0)
221         av_log(s, AV_LOG_ERROR, "Failure occurred when ending segment '%s'\n",
222                oc->filename);
223
224     if (seg->list) {
225         if (seg->list_size && !(seg->segment_count % seg->list_size)) {
226             segment_list_close(s);
227             if ((ret = segment_list_open(s)) < 0)
228                 goto end;
229         }
230
231         if (seg->list_type == LIST_TYPE_FLAT) {
232             avio_printf(seg->list_pb, "%s\n", oc->filename);
233         } else if (seg->list_type == LIST_TYPE_CSV || seg->list_type == LIST_TYPE_EXT) {
234             print_csv_escaped_str(seg->list_pb, oc->filename);
235             avio_printf(seg->list_pb, ",%f,%f\n", seg->start_time, seg->end_time);
236         } else if (seg->list_type == LIST_TYPE_M3U8) {
237             avio_printf(seg->list_pb, "#EXTINF:%f,\n%s\n",
238                         seg->end_time - seg->start_time, oc->filename);
239         }
240         seg->list_max_segment_time = FFMAX(seg->end_time - seg->start_time, seg->list_max_segment_time);
241         avio_flush(seg->list_pb);
242     }
243
244 end:
245     avio_close(oc->pb);
246
247     return ret;
248 }
249
250 static int parse_times(void *log_ctx, int64_t **times, int *nb_times,
251                        const char *times_str)
252 {
253     char *p;
254     int i, ret = 0;
255     char *times_str1 = av_strdup(times_str);
256     char *saveptr = NULL;
257
258     if (!times_str1)
259         return AVERROR(ENOMEM);
260
261 #define FAIL(err) ret = err; goto end
262
263     *nb_times = 1;
264     for (p = times_str1; *p; p++)
265         if (*p == ',')
266             (*nb_times)++;
267
268     *times = av_malloc(sizeof(**times) * *nb_times);
269     if (!*times) {
270         av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced times array\n");
271         FAIL(AVERROR(ENOMEM));
272     }
273
274     p = times_str1;
275     for (i = 0; i < *nb_times; i++) {
276         int64_t t;
277         char *tstr = av_strtok(p, ",", &saveptr);
278         av_assert0(tstr);
279         p = NULL;
280
281         ret = av_parse_time(&t, tstr, 1);
282         if (ret < 0) {
283             av_log(log_ctx, AV_LOG_ERROR,
284                    "Invalid time duration specification in %s\n", p);
285             FAIL(AVERROR(EINVAL));
286         }
287         (*times)[i] = t;
288
289         /* check on monotonicity */
290         if (i && (*times)[i-1] > (*times)[i]) {
291             av_log(log_ctx, AV_LOG_ERROR,
292                    "Specified time %f is greater than the following time %f\n",
293                    (float)((*times)[i])/1000000, (float)((*times)[i-1])/1000000);
294             FAIL(AVERROR(EINVAL));
295         }
296     }
297
298 end:
299     av_free(times_str1);
300     return ret;
301 }
302
303 static int open_null_ctx(AVIOContext **ctx)
304 {
305     int buf_size = 32768;
306     uint8_t *buf = av_malloc(buf_size);
307     if (!buf)
308         return AVERROR(ENOMEM);
309     *ctx = avio_alloc_context(buf, buf_size, AVIO_FLAG_WRITE, NULL, NULL, NULL, NULL);
310     if (!*ctx) {
311         av_free(buf);
312         return AVERROR(ENOMEM);
313     }
314     return 0;
315 }
316
317 static void close_null_ctx(AVIOContext *pb)
318 {
319     av_free(pb->buffer);
320     av_free(pb);
321 }
322
323 static int seg_write_header(AVFormatContext *s)
324 {
325     SegmentContext *seg = s->priv_data;
326     AVFormatContext *oc = NULL;
327     int ret, i;
328
329     seg->segment_count = 0;
330     if (!seg->write_header_trailer)
331         seg->individual_header_trailer = 0;
332
333     if (seg->time_str && seg->times_str) {
334         av_log(s, AV_LOG_ERROR,
335                "segment_time and segment_times options are mutually exclusive, select just one of them\n");
336         return AVERROR(EINVAL);
337     }
338
339     if ((seg->list_flags & SEGMENT_LIST_FLAG_LIVE) && seg->times_str) {
340         av_log(s, AV_LOG_ERROR,
341                "segment_flags +live and segment_times options are mutually exclusive:"
342                "specify -segment_time if you want a live-friendly list\n");
343         return AVERROR(EINVAL);
344     }
345
346     if (seg->times_str) {
347         if ((ret = parse_times(s, &seg->times, &seg->nb_times, seg->times_str)) < 0)
348             return ret;
349     } else {
350         /* set default value if not specified */
351         if (!seg->time_str)
352             seg->time_str = av_strdup("2");
353         if ((ret = av_parse_time(&seg->time, seg->time_str, 1)) < 0) {
354             av_log(s, AV_LOG_ERROR,
355                    "Invalid time duration specification '%s' for segment_time option\n",
356                    seg->time_str);
357             return ret;
358         }
359     }
360
361     if (seg->time_delta_str) {
362         if ((ret = av_parse_time(&seg->time_delta, seg->time_delta_str, 1)) < 0) {
363             av_log(s, AV_LOG_ERROR,
364                    "Invalid time duration specification '%s' for delta option\n",
365                    seg->time_delta_str);
366             return ret;
367         }
368     }
369
370     if (seg->list) {
371         if (seg->list_type == LIST_TYPE_UNDEFINED) {
372             if      (av_match_ext(seg->list, "csv" )) seg->list_type = LIST_TYPE_CSV;
373             else if (av_match_ext(seg->list, "ext" )) seg->list_type = LIST_TYPE_EXT;
374             else if (av_match_ext(seg->list, "m3u8")) seg->list_type = LIST_TYPE_M3U8;
375             else                                      seg->list_type = LIST_TYPE_FLAT;
376         }
377         if ((ret = segment_list_open(s)) < 0)
378             goto fail;
379     }
380     if (seg->list_type == LIST_TYPE_EXT)
381         av_log(s, AV_LOG_WARNING, "'ext' list type option is deprecated in favor of 'csv'\n");
382
383     for (i = 0; i < s->nb_streams; i++)
384         seg->has_video +=
385             (s->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO);
386
387     if (seg->has_video > 1)
388         av_log(s, AV_LOG_WARNING,
389                "More than a single video stream present, "
390                "expect issues decoding it.\n");
391
392     seg->oformat = av_guess_format(seg->format, s->filename, NULL);
393
394     if (!seg->oformat) {
395         ret = AVERROR_MUXER_NOT_FOUND;
396         goto fail;
397     }
398     if (seg->oformat->flags & AVFMT_NOFILE) {
399         av_log(s, AV_LOG_ERROR, "format %s not supported.\n",
400                seg->oformat->name);
401         ret = AVERROR(EINVAL);
402         goto fail;
403     }
404
405     if ((ret = segment_mux_init(s)) < 0)
406         goto fail;
407     oc = seg->avf;
408
409     if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
410                               s->filename, seg->segment_idx++) < 0) {
411         ret = AVERROR(EINVAL);
412         goto fail;
413     }
414     seg->segment_count++;
415
416     if (seg->write_header_trailer) {
417         if ((ret = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
418                               &s->interrupt_callback, NULL)) < 0)
419             goto fail;
420     } else {
421         if ((ret = open_null_ctx(&oc->pb)) < 0)
422             goto fail;
423     }
424
425     if ((ret = avformat_write_header(oc, NULL)) < 0) {
426         avio_close(oc->pb);
427         goto fail;
428     }
429
430     if (oc->avoid_negative_ts > 0 && s->avoid_negative_ts < 0)
431         s->avoid_negative_ts = 1;
432
433     if (!seg->write_header_trailer) {
434         close_null_ctx(oc->pb);
435         if ((ret = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
436                               &s->interrupt_callback, NULL)) < 0)
437             goto fail;
438     }
439
440 fail:
441     if (ret) {
442         if (seg->list)
443             segment_list_close(s);
444         if (seg->avf)
445             avformat_free_context(seg->avf);
446     }
447     return ret;
448 }
449
450 static int seg_write_packet(AVFormatContext *s, AVPacket *pkt)
451 {
452     SegmentContext *seg = s->priv_data;
453     AVFormatContext *oc = seg->avf;
454     AVStream *st = s->streams[pkt->stream_index];
455     int64_t end_pts;
456     int ret;
457
458     if (seg->times) {
459         end_pts = seg->segment_count <= seg->nb_times ?
460             seg->times[seg->segment_count-1] : INT64_MAX;
461     } else {
462         end_pts = seg->time * seg->segment_count;
463     }
464
465     /* if the segment has video, start a new segment *only* with a key video frame */
466     if ((st->codec->codec_type == AVMEDIA_TYPE_VIDEO || !seg->has_video) &&
467         av_compare_ts(pkt->pts, st->time_base,
468                       end_pts-seg->time_delta, AV_TIME_BASE_Q) >= 0 &&
469         pkt->flags & AV_PKT_FLAG_KEY) {
470
471         av_log(s, AV_LOG_DEBUG, "Next segment starts with packet stream:%d pts:%"PRId64" pts_time:%f\n",
472                pkt->stream_index, pkt->pts, pkt->pts * av_q2d(st->time_base));
473
474         ret = segment_end(s, seg->individual_header_trailer);
475
476         if (!ret)
477             ret = segment_start(s, seg->individual_header_trailer);
478
479         if (ret)
480             goto fail;
481
482         oc = seg->avf;
483
484         seg->start_time = (double)pkt->pts * av_q2d(st->time_base);
485     } else if (pkt->pts != AV_NOPTS_VALUE) {
486         seg->end_time = FFMAX(seg->end_time,
487                               (double)(pkt->pts + pkt->duration) * av_q2d(st->time_base));
488     }
489
490     ret = ff_write_chained(oc, pkt->stream_index, pkt, s);
491
492 fail:
493     if (ret < 0) {
494         if (seg->list)
495             avio_close(seg->list_pb);
496         avformat_free_context(oc);
497     }
498
499     return ret;
500 }
501
502 static int seg_write_trailer(struct AVFormatContext *s)
503 {
504     SegmentContext *seg = s->priv_data;
505     AVFormatContext *oc = seg->avf;
506     int ret;
507     if (!seg->write_header_trailer) {
508         if ((ret = segment_end(s, 0)) < 0)
509             goto fail;
510         open_null_ctx(&oc->pb);
511         ret = av_write_trailer(oc);
512         close_null_ctx(oc->pb);
513     } else {
514         ret = segment_end(s, 1);
515     }
516 fail:
517     if (seg->list)
518         segment_list_close(s);
519
520     av_opt_free(seg);
521     av_freep(&seg->times);
522
523     avformat_free_context(oc);
524     return ret;
525 }
526
527 #define OFFSET(x) offsetof(SegmentContext, x)
528 #define E AV_OPT_FLAG_ENCODING_PARAM
529 static const AVOption options[] = {
530     { "segment_format",    "set container format used for the segments", OFFSET(format),  AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
531     { "segment_list",      "set the segment list filename",              OFFSET(list),    AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
532
533     { "segment_list_flags","set flags affecting segment list generation", OFFSET(list_flags), AV_OPT_TYPE_FLAGS, {.i64 = SEGMENT_LIST_FLAG_CACHE }, 0, UINT_MAX, E, "list_flags"},
534     { "cache",             "allow list caching",                                    0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_LIST_FLAG_CACHE }, INT_MIN, INT_MAX,   E, "list_flags"},
535     { "live",              "enable live-friendly list generation (useful for HLS)", 0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_LIST_FLAG_LIVE }, INT_MIN, INT_MAX,    E, "list_flags"},
536
537     { "segment_list_size", "set the maximum number of playlist entries", OFFSET(list_size), AV_OPT_TYPE_INT,  {.i64 = 0},     0, INT_MAX, E },
538     { "segment_list_type", "set the segment list type",                  OFFSET(list_type), AV_OPT_TYPE_INT,  {.i64 = LIST_TYPE_UNDEFINED}, -1, LIST_TYPE_NB-1, E, "list_type" },
539     { "flat", "flat format",     0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FLAT }, INT_MIN, INT_MAX, 0, "list_type" },
540     { "csv",  "csv format",      0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_CSV  }, INT_MIN, INT_MAX, 0, "list_type" },
541     { "ext",  "extended format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_EXT  }, INT_MIN, INT_MAX, 0, "list_type" },
542     { "m3u8", "M3U8 format",     0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, 0, "list_type" },
543     { "hls", "Apple HTTP Live Streaming compatible",     0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, 0, "list_type" },
544     { "segment_time",      "set segment duration",                       OFFSET(time_str),AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
545     { "segment_time_delta","set approximation value used for the segment times", OFFSET(time_delta_str), AV_OPT_TYPE_STRING, {.str = "0"}, 0, 0, E },
546     { "segment_times",     "set segment split time points",              OFFSET(times_str),AV_OPT_TYPE_STRING,{.str = NULL},  0, 0,       E },
547     { "segment_wrap",      "set number after which the index wraps",     OFFSET(segment_idx_wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
548     { "individual_header_trailer", "write header/trailer to each segment", OFFSET(individual_header_trailer), AV_OPT_TYPE_INT, {.i64 = 1}, 0, 1, E },
549     { "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 },
550     { NULL },
551 };
552
553 static const AVClass seg_class = {
554     .class_name = "segment muxer",
555     .item_name  = av_default_item_name,
556     .option     = options,
557     .version    = LIBAVUTIL_VERSION_INT,
558 };
559
560 AVOutputFormat ff_segment_muxer = {
561     .name           = "segment",
562     .long_name      = NULL_IF_CONFIG_SMALL("segment"),
563     .priv_data_size = sizeof(SegmentContext),
564     .flags          = AVFMT_NOFILE|AVFMT_GLOBALHEADER,
565     .write_header   = seg_write_header,
566     .write_packet   = seg_write_packet,
567     .write_trailer  = seg_write_trailer,
568     .priv_class     = &seg_class,
569 };
570
571 static const AVClass sseg_class = {
572     .class_name = "stream_segment muxer",
573     .item_name  = av_default_item_name,
574     .option     = options,
575     .version    = LIBAVUTIL_VERSION_INT,
576 };
577
578 AVOutputFormat ff_stream_segment_muxer = {
579     .name           = "stream_segment,ssegment",
580     .long_name      = NULL_IF_CONFIG_SMALL("streaming segment muxer"),
581     .priv_data_size = sizeof(SegmentContext),
582     .flags          = AVFMT_NOFILE,
583     .write_header   = seg_write_header,
584     .write_packet   = seg_write_packet,
585     .write_trailer  = seg_write_trailer,
586     .priv_class     = &sseg_class,
587 };