fe4adddd7f15942d7b99dba2b8f8a7277e336996
[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_NB,
45 } ListType;
46
47 #define LIST_TYPE_EXT LIST_TYPE_CSV
48
49 typedef struct {
50     const AVClass *class;  /**< Class for private options. */
51     int segment_idx;       ///< index of the segment file to write, starting from 0
52     int segment_idx_wrap;  ///< number after which the index wraps
53     int segment_count;     ///< number of segment files already written
54     AVFormatContext *avf;
55     char *format;          ///< format to use for output segment files
56     char *list;            ///< filename for the segment list file
57     int   list_size;       ///< number of entries for the segment list file
58     double list_max_segment_time; ///< max segment time in the current list
59     ListType list_type;    ///< set the list type
60     AVIOContext *list_pb;  ///< list file put-byte context
61     char *time_str;        ///< segment duration specification string
62     int64_t time;          ///< segment duration
63     char *times_str;       ///< segment times specification string
64     int64_t *times;        ///< list of segment interval specification
65     int nb_times;          ///< number of elments in the times array
66     char *time_delta_str;  ///< approximation value duration used for the segment times
67     int64_t time_delta;
68     int has_video;
69     double start_time, end_time;
70 } SegmentContext;
71
72 static void print_csv_escaped_str(AVIOContext *ctx, const char *str)
73 {
74     const char *p;
75     int quote = 0;
76
77     /* check if input needs quoting */
78     for (p = str; *p; p++)
79         if (strchr("\",\n\r", *p)) {
80             quote = 1;
81             break;
82         }
83
84     if (quote)
85         avio_w8(ctx, '"');
86
87     for (p = str; *p; p++) {
88         if (*p == '"')
89             avio_w8(ctx, '"');
90         avio_w8(ctx, *p);
91     }
92     if (quote)
93         avio_w8(ctx, '"');
94 }
95
96 static int segment_start(AVFormatContext *s)
97 {
98     SegmentContext *seg = s->priv_data;
99     AVFormatContext *oc = seg->avf;
100     int err = 0;
101
102     if (seg->segment_idx_wrap)
103         seg->segment_idx %= seg->segment_idx_wrap;
104
105     if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
106                               s->filename, seg->segment_idx++) < 0) {
107         av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", s->filename);
108         return AVERROR(EINVAL);
109     }
110     seg->segment_count++;
111
112     if ((err = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
113                           &s->interrupt_callback, NULL)) < 0)
114         return err;
115
116     if (!oc->priv_data && oc->oformat->priv_data_size > 0) {
117         oc->priv_data = av_mallocz(oc->oformat->priv_data_size);
118         if (!oc->priv_data) {
119             avio_close(oc->pb);
120             return AVERROR(ENOMEM);
121         }
122         if (oc->oformat->priv_class) {
123             *(const AVClass**)oc->priv_data = oc->oformat->priv_class;
124             av_opt_set_defaults(oc->priv_data);
125         }
126     }
127
128     if ((err = oc->oformat->write_header(oc)) < 0) {
129         goto fail;
130     }
131
132     return 0;
133
134 fail:
135     av_log(oc, AV_LOG_ERROR, "Failure occurred when starting segment '%s'\n",
136            oc->filename);
137     avio_close(oc->pb);
138     av_freep(&oc->priv_data);
139
140     return err;
141 }
142
143 static int segment_list_open(AVFormatContext *s)
144 {
145     SegmentContext *seg = s->priv_data;
146     int ret;
147
148     ret = avio_open2(&seg->list_pb, seg->list, AVIO_FLAG_WRITE,
149                      &s->interrupt_callback, NULL);
150     if (ret < 0)
151         return ret;
152     seg->list_max_segment_time = 0;
153
154     if (seg->list_type == LIST_TYPE_M3U8) {
155         avio_printf(seg->list_pb, "#EXTM3U\n");
156         avio_printf(seg->list_pb, "#EXT-X-VERSION:3\n");
157     }
158
159     return ret;
160 }
161
162 static void segment_list_close(AVFormatContext *s)
163 {
164     SegmentContext *seg = s->priv_data;
165
166     if (seg->list_type == LIST_TYPE_M3U8) {
167         avio_printf(seg->list_pb, "#EXT-X-TARGETDURATION:%d\n",
168                     (int)ceil(seg->list_max_segment_time));
169         avio_printf(seg->list_pb, "#EXT-X-ENDLIST\n");
170     }
171
172     avio_close(seg->list_pb);
173 }
174
175 static int segment_end(AVFormatContext *s)
176 {
177     SegmentContext *seg = s->priv_data;
178     AVFormatContext *oc = seg->avf;
179     int ret = 0;
180
181     if (oc->oformat->write_trailer)
182         ret = oc->oformat->write_trailer(oc);
183
184     if (ret < 0)
185         av_log(s, AV_LOG_ERROR, "Failure occurred when ending segment '%s'\n",
186                oc->filename);
187
188     if (seg->list) {
189         if (seg->list_size && !(seg->segment_count % seg->list_size)) {
190             segment_list_close(s);
191             if ((ret = segment_list_open(s)) < 0)
192                 goto end;
193         }
194
195         if (seg->list_type == LIST_TYPE_FLAT) {
196             avio_printf(seg->list_pb, "%s\n", oc->filename);
197         } else if (seg->list_type == LIST_TYPE_EXT) {
198             print_csv_escaped_str(seg->list_pb, oc->filename);
199             avio_printf(seg->list_pb, ",%f,%f\n", seg->start_time, seg->end_time);
200         } else if (seg->list_type == LIST_TYPE_M3U8) {
201             avio_printf(seg->list_pb, "#EXTINF:%f,\n%s\n",
202                         seg->end_time - seg->start_time, oc->filename);
203         }
204         seg->list_max_segment_time = FFMAX(seg->end_time - seg->start_time, seg->list_max_segment_time);
205         avio_flush(seg->list_pb);
206     }
207
208 end:
209     avio_close(oc->pb);
210     if (oc->oformat->priv_class)
211         av_opt_free(oc->priv_data);
212     av_freep(&oc->priv_data);
213
214     return ret;
215 }
216
217 static int parse_times(void *log_ctx, int64_t **times, int *nb_times,
218                        const char *times_str)
219 {
220     char *p;
221     int i, ret = 0;
222     char *times_str1 = av_strdup(times_str);
223     char *saveptr = NULL;
224
225     if (!times_str1)
226         return AVERROR(ENOMEM);
227
228 #define FAIL(err) ret = err; goto end
229
230     *nb_times = 1;
231     for (p = times_str1; *p; p++)
232         if (*p == ',')
233             (*nb_times)++;
234
235     *times = av_malloc(sizeof(**times) * *nb_times);
236     if (!*times) {
237         av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced times array\n");
238         FAIL(AVERROR(ENOMEM));
239     }
240
241     p = times_str1;
242     for (i = 0; i < *nb_times; i++) {
243         int64_t t;
244         char *tstr = av_strtok(p, ",", &saveptr);
245         av_assert0(tstr);
246         p = NULL;
247
248         ret = av_parse_time(&t, tstr, 1);
249         if (ret < 0) {
250             av_log(log_ctx, AV_LOG_ERROR,
251                    "Invalid time duration specification in %s\n", p);
252             FAIL(AVERROR(EINVAL));
253         }
254         (*times)[i] = t;
255
256         /* check on monotonicity */
257         if (i && (*times)[i-1] > (*times)[i]) {
258             av_log(log_ctx, AV_LOG_ERROR,
259                    "Specified time %f is greater than the following time %f\n",
260                    (float)((*times)[i])/1000000, (float)((*times)[i-1])/1000000);
261             FAIL(AVERROR(EINVAL));
262         }
263     }
264
265 end:
266     av_free(times_str1);
267     return ret;
268 }
269
270 static int seg_write_header(AVFormatContext *s)
271 {
272     SegmentContext *seg = s->priv_data;
273     AVFormatContext *oc;
274     int ret, i;
275
276     seg->segment_count = 0;
277
278     if (seg->time_str && seg->times_str) {
279         av_log(s, AV_LOG_ERROR,
280                "segment_time and segment_times options are mutually exclusive, select just one of them\n");
281         return AVERROR(EINVAL);
282     }
283
284     if (seg->times_str) {
285         if ((ret = parse_times(s, &seg->times, &seg->nb_times, seg->times_str)) < 0)
286             return ret;
287     } else {
288         /* set default value if not specified */
289         if (!seg->time_str)
290             seg->time_str = av_strdup("2");
291         if ((ret = av_parse_time(&seg->time, seg->time_str, 1)) < 0) {
292             av_log(s, AV_LOG_ERROR,
293                    "Invalid time duration specification '%s' for segment_time option\n",
294                    seg->time_str);
295             return ret;
296         }
297     }
298
299     if (seg->time_delta_str) {
300         if ((ret = av_parse_time(&seg->time_delta, seg->time_delta_str, 1)) < 0) {
301             av_log(s, AV_LOG_ERROR,
302                    "Invalid time duration specification '%s' for delta option\n",
303                    seg->time_delta_str);
304             return ret;
305         }
306     }
307
308     oc = avformat_alloc_context();
309
310     if (!oc)
311         return AVERROR(ENOMEM);
312
313     if (seg->list) {
314         if (seg->list_type == LIST_TYPE_UNDEFINED) {
315             if      (av_match_ext(seg->list, "csv" )) seg->list_type = LIST_TYPE_CSV;
316             else if (av_match_ext(seg->list, "ext" )) seg->list_type = LIST_TYPE_EXT;
317             else if (av_match_ext(seg->list, "m3u8")) seg->list_type = LIST_TYPE_M3U8;
318             else                                      seg->list_type = LIST_TYPE_FLAT;
319         }
320         if ((ret = segment_list_open(s)) < 0)
321             goto fail;
322     }
323     if (seg->list_type == LIST_TYPE_EXT)
324         av_log(s, AV_LOG_WARNING, "'ext' list type option is deprecated in favor of 'csv'\n");
325
326     for (i = 0; i< s->nb_streams; i++)
327         seg->has_video +=
328             (s->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO);
329
330     if (seg->has_video > 1)
331         av_log(s, AV_LOG_WARNING,
332                "More than a single video stream present, "
333                "expect issues decoding it.\n");
334
335     oc->oformat = av_guess_format(seg->format, s->filename, NULL);
336
337     if (!oc->oformat) {
338         ret = AVERROR_MUXER_NOT_FOUND;
339         goto fail;
340     }
341     if (oc->oformat->flags & AVFMT_NOFILE) {
342         av_log(s, AV_LOG_ERROR, "format %s not supported.\n",
343                oc->oformat->name);
344         ret = AVERROR(EINVAL);
345         goto fail;
346     }
347
348     seg->avf = oc;
349
350     oc->streams = s->streams;
351     oc->nb_streams = s->nb_streams;
352
353     if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
354                               s->filename, seg->segment_idx++) < 0) {
355         ret = AVERROR(EINVAL);
356         goto fail;
357     }
358     seg->segment_count++;
359
360     if ((ret = avio_open2(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
361                           &s->interrupt_callback, NULL)) < 0)
362         goto fail;
363
364     if ((ret = avformat_write_header(oc, NULL)) < 0) {
365         avio_close(oc->pb);
366         goto fail;
367     }
368
369 fail:
370     if (ret) {
371         if (oc) {
372             oc->streams = NULL;
373             oc->nb_streams = 0;
374             avformat_free_context(oc);
375         }
376         if (seg->list)
377             segment_list_close(s);
378     }
379     return ret;
380 }
381
382 static int seg_write_packet(AVFormatContext *s, AVPacket *pkt)
383 {
384     SegmentContext *seg = s->priv_data;
385     AVFormatContext *oc = seg->avf;
386     AVStream *st = oc->streams[pkt->stream_index];
387     int64_t end_pts;
388     int ret;
389
390     if (seg->times) {
391         end_pts = seg->segment_count <= seg->nb_times ?
392             seg->times[seg->segment_count-1] : INT64_MAX;
393     } else {
394         end_pts = seg->time * seg->segment_count;
395     }
396
397     /* if the segment has video, start a new segment *only* with a key video frame */
398     if ((st->codec->codec_type == AVMEDIA_TYPE_VIDEO || !seg->has_video) &&
399         av_compare_ts(pkt->pts, st->time_base,
400                       end_pts-seg->time_delta, AV_TIME_BASE_Q) >= 0 &&
401         pkt->flags & AV_PKT_FLAG_KEY) {
402
403         av_log(s, AV_LOG_DEBUG, "Next segment starts with packet stream:%d pts:%"PRId64" pts_time:%f\n",
404                pkt->stream_index, pkt->pts, pkt->pts * av_q2d(st->time_base));
405
406         if ((ret = segment_end(s)) < 0 || (ret = segment_start(s)) < 0)
407             goto fail;
408         seg->start_time = (double)pkt->pts * av_q2d(st->time_base);
409     } else if (pkt->pts != AV_NOPTS_VALUE) {
410         seg->end_time = FFMAX(seg->end_time,
411                               (double)(pkt->pts + pkt->duration) * av_q2d(st->time_base));
412     }
413
414     ret = oc->oformat->write_packet(oc, pkt);
415
416 fail:
417     if (ret < 0) {
418         oc->streams = NULL;
419         oc->nb_streams = 0;
420         if (seg->list)
421             avio_close(seg->list_pb);
422         avformat_free_context(oc);
423     }
424
425     return ret;
426 }
427
428 static int seg_write_trailer(struct AVFormatContext *s)
429 {
430     SegmentContext *seg = s->priv_data;
431     AVFormatContext *oc = seg->avf;
432     int ret = segment_end(s);
433     if (seg->list)
434         segment_list_close(s);
435
436     av_opt_free(seg);
437     av_freep(&seg->times);
438
439     oc->streams = NULL;
440     oc->nb_streams = 0;
441     avformat_free_context(oc);
442     return ret;
443 }
444
445 #define OFFSET(x) offsetof(SegmentContext, x)
446 #define E AV_OPT_FLAG_ENCODING_PARAM
447 static const AVOption options[] = {
448     { "segment_format",    "set container format used for the segments", OFFSET(format),  AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
449     { "segment_list",      "set the segment list filename",              OFFSET(list),    AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
450     { "segment_list_size", "set the maximum number of playlist entries", OFFSET(list_size), AV_OPT_TYPE_INT,  {.dbl = 0},     0, INT_MAX, E },
451     { "segment_list_type", "set the segment list type",                  OFFSET(list_type), AV_OPT_TYPE_INT,  {.dbl = LIST_TYPE_UNDEFINED}, -1, LIST_TYPE_NB-1, E, "list_type" },
452     { "flat", "flat format",     0, AV_OPT_TYPE_CONST, {.dbl=LIST_TYPE_FLAT }, INT_MIN, INT_MAX, 0, "list_type" },
453     { "csv",  "csv format",      0, AV_OPT_TYPE_CONST, {.dbl=LIST_TYPE_CSV  }, INT_MIN, INT_MAX, 0, "list_type" },
454     { "ext",  "extended format", 0, AV_OPT_TYPE_CONST, {.dbl=LIST_TYPE_EXT  }, INT_MIN, INT_MAX, 0, "list_type" },
455     { "m3u8", "M3U8 format",     0, AV_OPT_TYPE_CONST, {.dbl=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, 0, "list_type" },
456     { "segment_time",      "set segment duration",                       OFFSET(time_str),AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
457     { "segment_time_delta","set approximation value used for the segment times", OFFSET(time_delta_str), AV_OPT_TYPE_STRING, {.str = "0"}, 0, 0, E },
458     { "segment_times",     "set segment split time points",              OFFSET(times_str),AV_OPT_TYPE_STRING,{.str = NULL},  0, 0,       E },
459     { "segment_wrap",      "set number after which the index wraps",     OFFSET(segment_idx_wrap), AV_OPT_TYPE_INT, {.dbl = 0}, 0, INT_MAX, E },
460     { NULL },
461 };
462
463 static const AVClass seg_class = {
464     .class_name = "segment muxer",
465     .item_name  = av_default_item_name,
466     .option     = options,
467     .version    = LIBAVUTIL_VERSION_INT,
468 };
469
470 AVOutputFormat ff_segment_muxer = {
471     .name           = "segment",
472     .long_name      = NULL_IF_CONFIG_SMALL("segment"),
473     .priv_data_size = sizeof(SegmentContext),
474     .flags          = AVFMT_GLOBALHEADER | AVFMT_NOFILE,
475     .write_header   = seg_write_header,
476     .write_packet   = seg_write_packet,
477     .write_trailer  = seg_write_trailer,
478     .priv_class     = &seg_class,
479 };
480
481 static const AVClass sseg_class = {
482     .class_name = "stream_segment muxer",
483     .item_name  = av_default_item_name,
484     .option     = options,
485     .version    = LIBAVUTIL_VERSION_INT,
486 };
487
488 AVOutputFormat ff_stream_segment_muxer = {
489     .name           = "stream_segment,ssegment",
490     .long_name      = NULL_IF_CONFIG_SMALL("streaming segment muxer"),
491     .priv_data_size = sizeof(SegmentContext),
492     .flags          = AVFMT_NOFILE,
493     .write_header   = seg_write_header,
494     .write_packet   = seg_write_packet,
495     .write_trailer  = seg_write_trailer,
496     .priv_class     = &sseg_class,
497 };