4c1e1156af6ac378bb434a8d1fba7594573baeab
[ffmpeg.git] / libavformat / segment.c
1 /*
2  * Copyright (c) 2011, Luca Barbato
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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}
25  */
26
27 /* #define DEBUG */
28
29 #include <float.h>
30 #include <time.h>
31
32 #include "avformat.h"
33 #include "avio_internal.h"
34 #include "internal.h"
35
36 #include "libavutil/avassert.h"
37 #include "libavutil/internal.h"
38 #include "libavutil/log.h"
39 #include "libavutil/opt.h"
40 #include "libavutil/avstring.h"
41 #include "libavutil/parseutils.h"
42 #include "libavutil/mathematics.h"
43 #include "libavutil/time.h"
44 #include "libavutil/timecode.h"
45 #include "libavutil/time_internal.h"
46 #include "libavutil/timestamp.h"
47
48 typedef struct SegmentListEntry {
49     int index;
50     double start_time, end_time;
51     int64_t start_pts;
52     int64_t offset_pts;
53     char *filename;
54     struct SegmentListEntry *next;
55     int64_t last_duration;
56 } SegmentListEntry;
57
58 typedef enum {
59     LIST_TYPE_UNDEFINED = -1,
60     LIST_TYPE_FLAT = 0,
61     LIST_TYPE_CSV,
62     LIST_TYPE_M3U8,
63     LIST_TYPE_EXT, ///< deprecated
64     LIST_TYPE_FFCONCAT,
65     LIST_TYPE_NB,
66 } ListType;
67
68 #define SEGMENT_LIST_FLAG_CACHE 1
69 #define SEGMENT_LIST_FLAG_LIVE  2
70
71 typedef struct SegmentContext {
72     const AVClass *class;  /**< Class for private options. */
73     int segment_idx;       ///< index of the segment file to write, starting from 0
74     int segment_idx_wrap;  ///< number after which the index wraps
75     int segment_idx_wrap_nb;  ///< number of time the index has wraped
76     int segment_count;     ///< number of segment files already written
77     AVOutputFormat *oformat;
78     AVFormatContext *avf;
79     char *format;              ///< format to use for output segment files
80     char *format_options_str;  ///< format options to use for output segment files
81     AVDictionary *format_options;
82     char *list;            ///< filename for the segment list file
83     int   list_flags;      ///< flags affecting list generation
84     int   list_size;       ///< number of entries for the segment list file
85
86     int use_clocktime;    ///< flag to cut segments at regular clock time
87     int64_t clocktime_offset; //< clock offset for cutting the segments at regular clock time
88     int64_t clocktime_wrap_duration; //< wrapping duration considered for starting a new segment
89     int64_t last_val;      ///< remember last time for wrap around detection
90     int64_t last_cut;      ///< remember last cut
91     int cut_pending;
92
93     char *entry_prefix;    ///< prefix to add to list entry filenames
94     int list_type;         ///< set the list type
95     AVIOContext *list_pb;  ///< list file put-byte context
96     char *time_str;        ///< segment duration specification string
97     int64_t time;          ///< segment duration
98     int use_strftime;      ///< flag to expand filename with strftime
99     int increment_tc;      ///< flag to increment timecode if found
100
101     char *times_str;       ///< segment times specification string
102     int64_t *times;        ///< list of segment interval specification
103     int nb_times;          ///< number of elments in the times array
104
105     char *frames_str;      ///< segment frame numbers specification string
106     int *frames;           ///< list of frame number specification
107     int nb_frames;         ///< number of elments in the frames array
108     int frame_count;       ///< total number of reference frames
109     int segment_frame_count; ///< number of reference frames in the segment
110
111     int64_t time_delta;
112     int  individual_header_trailer; /**< Set by a private option. */
113     int  write_header_trailer; /**< Set by a private option. */
114     char *header_filename;  ///< filename to write the output header to
115
116     int reset_timestamps;  ///< reset timestamps at the begin of each segment
117     int64_t initial_offset;    ///< initial timestamps offset, expressed in microseconds
118     char *reference_stream_specifier; ///< reference stream specifier
119     int   reference_stream_index;
120     int   break_non_keyframes;
121
122     int use_rename;
123     char temp_list_filename[1024];
124
125     SegmentListEntry cur_entry;
126     SegmentListEntry *segment_list_entries;
127     SegmentListEntry *segment_list_entries_end;
128 } SegmentContext;
129
130 static void print_csv_escaped_str(AVIOContext *ctx, const char *str)
131 {
132     int needs_quoting = !!str[strcspn(str, "\",\n\r")];
133
134     if (needs_quoting)
135         avio_w8(ctx, '"');
136
137     for (; *str; str++) {
138         if (*str == '"')
139             avio_w8(ctx, '"');
140         avio_w8(ctx, *str);
141     }
142     if (needs_quoting)
143         avio_w8(ctx, '"');
144 }
145
146 static int segment_mux_init(AVFormatContext *s)
147 {
148     SegmentContext *seg = s->priv_data;
149     AVFormatContext *oc;
150     int i;
151     int ret;
152
153     ret = avformat_alloc_output_context2(&seg->avf, seg->oformat, NULL, NULL);
154     if (ret < 0)
155         return ret;
156     oc = seg->avf;
157
158     oc->interrupt_callback = s->interrupt_callback;
159     oc->max_delay          = s->max_delay;
160     av_dict_copy(&oc->metadata, s->metadata, 0);
161     oc->opaque             = s->opaque;
162     oc->io_close           = s->io_close;
163     oc->io_open            = s->io_open;
164
165     for (i = 0; i < s->nb_streams; i++) {
166         AVStream *st;
167         AVCodecContext *icodec, *ocodec;
168
169         if (!(st = avformat_new_stream(oc, NULL)))
170             return AVERROR(ENOMEM);
171         icodec = s->streams[i]->codec;
172         ocodec = st->codec;
173         avcodec_copy_context(ocodec, icodec);
174         if (!oc->oformat->codec_tag ||
175             av_codec_get_id (oc->oformat->codec_tag, icodec->codec_tag) == ocodec->codec_id ||
176             av_codec_get_tag(oc->oformat->codec_tag, icodec->codec_id) <= 0) {
177             ocodec->codec_tag = icodec->codec_tag;
178         } else {
179             ocodec->codec_tag = 0;
180         }
181         st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
182         st->time_base = s->streams[i]->time_base;
183         av_dict_copy(&st->metadata, s->streams[i]->metadata, 0);
184     }
185
186     return 0;
187 }
188
189 static int set_segment_filename(AVFormatContext *s)
190 {
191     SegmentContext *seg = s->priv_data;
192     AVFormatContext *oc = seg->avf;
193     size_t size;
194     int ret;
195
196     if (seg->segment_idx_wrap)
197         seg->segment_idx %= seg->segment_idx_wrap;
198     if (seg->use_strftime) {
199         time_t now0;
200         struct tm *tm, tmpbuf;
201         time(&now0);
202         tm = localtime_r(&now0, &tmpbuf);
203         if (!strftime(oc->filename, sizeof(oc->filename), s->filename, tm)) {
204             av_log(oc, AV_LOG_ERROR, "Could not get segment filename with strftime\n");
205             return AVERROR(EINVAL);
206         }
207     } else if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
208                                      s->filename, seg->segment_idx) < 0) {
209         av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", s->filename);
210         return AVERROR(EINVAL);
211     }
212
213     /* copy modified name in list entry */
214     size = strlen(av_basename(oc->filename)) + 1;
215     if (seg->entry_prefix)
216         size += strlen(seg->entry_prefix);
217
218     if ((ret = av_reallocp(&seg->cur_entry.filename, size)) < 0)
219         return ret;
220     snprintf(seg->cur_entry.filename, size, "%s%s",
221              seg->entry_prefix ? seg->entry_prefix : "",
222              av_basename(oc->filename));
223
224     return 0;
225 }
226
227 static int segment_start(AVFormatContext *s, int write_header)
228 {
229     SegmentContext *seg = s->priv_data;
230     AVFormatContext *oc = seg->avf;
231     int err = 0;
232
233     if (write_header) {
234         avformat_free_context(oc);
235         seg->avf = NULL;
236         if ((err = segment_mux_init(s)) < 0)
237             return err;
238         oc = seg->avf;
239     }
240
241     seg->segment_idx++;
242     if ((seg->segment_idx_wrap) && (seg->segment_idx % seg->segment_idx_wrap == 0))
243         seg->segment_idx_wrap_nb++;
244
245     if ((err = set_segment_filename(s)) < 0)
246         return err;
247
248     if ((err = s->io_open(s, &oc->pb, oc->filename, AVIO_FLAG_WRITE, NULL)) < 0) {
249         av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->filename);
250         return err;
251     }
252     if (!seg->individual_header_trailer)
253         oc->pb->seekable = 0;
254
255     if (oc->oformat->priv_class && oc->priv_data)
256         av_opt_set(oc->priv_data, "mpegts_flags", "+resend_headers", 0);
257
258     if (write_header) {
259         AVDictionary *options = NULL;
260         av_dict_copy(&options, seg->format_options, 0);
261         err = avformat_write_header(oc, &options);
262         av_dict_free(&options);
263         if (err < 0)
264             return err;
265     }
266
267     seg->segment_frame_count = 0;
268     return 0;
269 }
270
271 static int segment_list_open(AVFormatContext *s)
272 {
273     SegmentContext *seg = s->priv_data;
274     int ret;
275
276     snprintf(seg->temp_list_filename, sizeof(seg->temp_list_filename), seg->use_rename ? "%s.tmp" : "%s", seg->list);
277     ret = s->io_open(s, &seg->list_pb, seg->temp_list_filename, AVIO_FLAG_WRITE, NULL);
278     if (ret < 0) {
279         av_log(s, AV_LOG_ERROR, "Failed to open segment list '%s'\n", seg->list);
280         return ret;
281     }
282
283     if (seg->list_type == LIST_TYPE_M3U8 && seg->segment_list_entries) {
284         SegmentListEntry *entry;
285         double max_duration = 0;
286
287         avio_printf(seg->list_pb, "#EXTM3U\n");
288         avio_printf(seg->list_pb, "#EXT-X-VERSION:3\n");
289         avio_printf(seg->list_pb, "#EXT-X-MEDIA-SEQUENCE:%d\n", seg->segment_list_entries->index);
290         avio_printf(seg->list_pb, "#EXT-X-ALLOW-CACHE:%s\n",
291                     seg->list_flags & SEGMENT_LIST_FLAG_CACHE ? "YES" : "NO");
292
293         av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%d\n",
294                seg->segment_list_entries->index);
295
296         for (entry = seg->segment_list_entries; entry; entry = entry->next)
297             max_duration = FFMAX(max_duration, entry->end_time - entry->start_time);
298         avio_printf(seg->list_pb, "#EXT-X-TARGETDURATION:%"PRId64"\n", (int64_t)ceil(max_duration));
299     } else if (seg->list_type == LIST_TYPE_FFCONCAT) {
300         avio_printf(seg->list_pb, "ffconcat version 1.0\n");
301     }
302
303     return ret;
304 }
305
306 static void segment_list_print_entry(AVIOContext      *list_ioctx,
307                                      ListType          list_type,
308                                      const SegmentListEntry *list_entry,
309                                      void *log_ctx)
310 {
311     switch (list_type) {
312     case LIST_TYPE_FLAT:
313         avio_printf(list_ioctx, "%s\n", list_entry->filename);
314         break;
315     case LIST_TYPE_CSV:
316     case LIST_TYPE_EXT:
317         print_csv_escaped_str(list_ioctx, list_entry->filename);
318         avio_printf(list_ioctx, ",%f,%f\n", list_entry->start_time, list_entry->end_time);
319         break;
320     case LIST_TYPE_M3U8:
321         avio_printf(list_ioctx, "#EXTINF:%f,\n%s\n",
322                     list_entry->end_time - list_entry->start_time, list_entry->filename);
323         break;
324     case LIST_TYPE_FFCONCAT:
325     {
326         char *buf;
327         if (av_escape(&buf, list_entry->filename, NULL, AV_ESCAPE_MODE_AUTO, AV_ESCAPE_FLAG_WHITESPACE) < 0) {
328             av_log(log_ctx, AV_LOG_WARNING,
329                    "Error writing list entry '%s' in list file\n", list_entry->filename);
330             return;
331         }
332         avio_printf(list_ioctx, "file %s\n", buf);
333         av_free(buf);
334         break;
335     }
336     default:
337         av_assert0(!"Invalid list type");
338     }
339 }
340
341 static int segment_end(AVFormatContext *s, int write_trailer, int is_last)
342 {
343     SegmentContext *seg = s->priv_data;
344     AVFormatContext *oc = seg->avf;
345     int ret = 0;
346     AVTimecode tc;
347     AVRational rate;
348     AVDictionaryEntry *tcr;
349     char buf[AV_TIMECODE_STR_SIZE];
350     int i;
351     int err;
352
353     av_write_frame(oc, NULL); /* Flush any buffered data (fragmented mp4) */
354     if (write_trailer)
355         ret = av_write_trailer(oc);
356
357     if (ret < 0)
358         av_log(s, AV_LOG_ERROR, "Failure occurred when ending segment '%s'\n",
359                oc->filename);
360
361     if (seg->list) {
362         if (seg->list_size || seg->list_type == LIST_TYPE_M3U8) {
363             SegmentListEntry *entry = av_mallocz(sizeof(*entry));
364             if (!entry) {
365                 ret = AVERROR(ENOMEM);
366                 goto end;
367             }
368
369             /* append new element */
370             memcpy(entry, &seg->cur_entry, sizeof(*entry));
371             entry->filename = av_strdup(entry->filename);
372             if (!seg->segment_list_entries)
373                 seg->segment_list_entries = seg->segment_list_entries_end = entry;
374             else
375                 seg->segment_list_entries_end->next = entry;
376             seg->segment_list_entries_end = entry;
377
378             /* drop first item */
379             if (seg->list_size && seg->segment_count >= seg->list_size) {
380                 entry = seg->segment_list_entries;
381                 seg->segment_list_entries = seg->segment_list_entries->next;
382                 av_freep(&entry->filename);
383                 av_freep(&entry);
384             }
385
386             if ((ret = segment_list_open(s)) < 0)
387                 goto end;
388             for (entry = seg->segment_list_entries; entry; entry = entry->next)
389                 segment_list_print_entry(seg->list_pb, seg->list_type, entry, s);
390             if (seg->list_type == LIST_TYPE_M3U8 && is_last)
391                 avio_printf(seg->list_pb, "#EXT-X-ENDLIST\n");
392             ff_format_io_close(s, &seg->list_pb);
393             if (seg->use_rename)
394                 ff_rename(seg->temp_list_filename, seg->list, s);
395         } else {
396             segment_list_print_entry(seg->list_pb, seg->list_type, &seg->cur_entry, s);
397             avio_flush(seg->list_pb);
398         }
399     }
400
401     av_log(s, AV_LOG_VERBOSE, "segment:'%s' count:%d ended\n",
402            seg->avf->filename, seg->segment_count);
403     seg->segment_count++;
404
405     if (seg->increment_tc) {
406         tcr = av_dict_get(s->metadata, "timecode", NULL, 0);
407         if (tcr) {
408             /* search the first video stream */
409             for (i = 0; i < s->nb_streams; i++) {
410                 if (s->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
411                     rate = s->streams[i]->avg_frame_rate;/* Get fps from the video stream */
412                     err = av_timecode_init_from_string(&tc, rate, tcr->value, s);
413                     if (err < 0) {
414                         av_log(s, AV_LOG_WARNING, "Could not increment timecode, error occurred during timecode creation.");
415                         break;
416                     }
417                     tc.start += (int)((seg->cur_entry.end_time - seg->cur_entry.start_time) * av_q2d(rate));/* increment timecode */
418                     av_dict_set(&s->metadata, "timecode",
419                                 av_timecode_make_string(&tc, buf, 0), 0);
420                     break;
421                 }
422             }
423         } else {
424             av_log(s, AV_LOG_WARNING, "Could not increment timecode, no timecode metadata found");
425         }
426     }
427
428 end:
429     ff_format_io_close(oc, &oc->pb);
430
431     return ret;
432 }
433
434 static int parse_times(void *log_ctx, int64_t **times, int *nb_times,
435                        const char *times_str)
436 {
437     char *p;
438     int i, ret = 0;
439     char *times_str1 = av_strdup(times_str);
440     char *saveptr = NULL;
441
442     if (!times_str1)
443         return AVERROR(ENOMEM);
444
445 #define FAIL(err) ret = err; goto end
446
447     *nb_times = 1;
448     for (p = times_str1; *p; p++)
449         if (*p == ',')
450             (*nb_times)++;
451
452     *times = av_malloc_array(*nb_times, sizeof(**times));
453     if (!*times) {
454         av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced times array\n");
455         FAIL(AVERROR(ENOMEM));
456     }
457
458     p = times_str1;
459     for (i = 0; i < *nb_times; i++) {
460         int64_t t;
461         char *tstr = av_strtok(p, ",", &saveptr);
462         p = NULL;
463
464         if (!tstr || !tstr[0]) {
465             av_log(log_ctx, AV_LOG_ERROR, "Empty time specification in times list %s\n",
466                    times_str);
467             FAIL(AVERROR(EINVAL));
468         }
469
470         ret = av_parse_time(&t, tstr, 1);
471         if (ret < 0) {
472             av_log(log_ctx, AV_LOG_ERROR,
473                    "Invalid time duration specification '%s' in times list %s\n", tstr, times_str);
474             FAIL(AVERROR(EINVAL));
475         }
476         (*times)[i] = t;
477
478         /* check on monotonicity */
479         if (i && (*times)[i-1] > (*times)[i]) {
480             av_log(log_ctx, AV_LOG_ERROR,
481                    "Specified time %f is greater than the following time %f\n",
482                    (float)((*times)[i])/1000000, (float)((*times)[i-1])/1000000);
483             FAIL(AVERROR(EINVAL));
484         }
485     }
486
487 end:
488     av_free(times_str1);
489     return ret;
490 }
491
492 static int parse_frames(void *log_ctx, int **frames, int *nb_frames,
493                         const char *frames_str)
494 {
495     char *p;
496     int i, ret = 0;
497     char *frames_str1 = av_strdup(frames_str);
498     char *saveptr = NULL;
499
500     if (!frames_str1)
501         return AVERROR(ENOMEM);
502
503 #define FAIL(err) ret = err; goto end
504
505     *nb_frames = 1;
506     for (p = frames_str1; *p; p++)
507         if (*p == ',')
508             (*nb_frames)++;
509
510     *frames = av_malloc_array(*nb_frames, sizeof(**frames));
511     if (!*frames) {
512         av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced frames array\n");
513         FAIL(AVERROR(ENOMEM));
514     }
515
516     p = frames_str1;
517     for (i = 0; i < *nb_frames; i++) {
518         long int f;
519         char *tailptr;
520         char *fstr = av_strtok(p, ",", &saveptr);
521
522         p = NULL;
523         if (!fstr) {
524             av_log(log_ctx, AV_LOG_ERROR, "Empty frame specification in frame list %s\n",
525                    frames_str);
526             FAIL(AVERROR(EINVAL));
527         }
528         f = strtol(fstr, &tailptr, 10);
529         if (*tailptr || f <= 0 || f >= INT_MAX) {
530             av_log(log_ctx, AV_LOG_ERROR,
531                    "Invalid argument '%s', must be a positive integer <= INT64_MAX\n",
532                    fstr);
533             FAIL(AVERROR(EINVAL));
534         }
535         (*frames)[i] = f;
536
537         /* check on monotonicity */
538         if (i && (*frames)[i-1] > (*frames)[i]) {
539             av_log(log_ctx, AV_LOG_ERROR,
540                    "Specified frame %d is greater than the following frame %d\n",
541                    (*frames)[i], (*frames)[i-1]);
542             FAIL(AVERROR(EINVAL));
543         }
544     }
545
546 end:
547     av_free(frames_str1);
548     return ret;
549 }
550
551 static int open_null_ctx(AVIOContext **ctx)
552 {
553     int buf_size = 32768;
554     uint8_t *buf = av_malloc(buf_size);
555     if (!buf)
556         return AVERROR(ENOMEM);
557     *ctx = avio_alloc_context(buf, buf_size, AVIO_FLAG_WRITE, NULL, NULL, NULL, NULL);
558     if (!*ctx) {
559         av_free(buf);
560         return AVERROR(ENOMEM);
561     }
562     return 0;
563 }
564
565 static void close_null_ctxp(AVIOContext **pb)
566 {
567     av_freep(&(*pb)->buffer);
568     av_freep(pb);
569 }
570
571 static int select_reference_stream(AVFormatContext *s)
572 {
573     SegmentContext *seg = s->priv_data;
574     int ret, i;
575
576     seg->reference_stream_index = -1;
577     if (!strcmp(seg->reference_stream_specifier, "auto")) {
578         /* select first index of type with highest priority */
579         int type_index_map[AVMEDIA_TYPE_NB];
580         static const enum AVMediaType type_priority_list[] = {
581             AVMEDIA_TYPE_VIDEO,
582             AVMEDIA_TYPE_AUDIO,
583             AVMEDIA_TYPE_SUBTITLE,
584             AVMEDIA_TYPE_DATA,
585             AVMEDIA_TYPE_ATTACHMENT
586         };
587         enum AVMediaType type;
588
589         for (i = 0; i < AVMEDIA_TYPE_NB; i++)
590             type_index_map[i] = -1;
591
592         /* select first index for each type */
593         for (i = 0; i < s->nb_streams; i++) {
594             type = s->streams[i]->codec->codec_type;
595             if ((unsigned)type < AVMEDIA_TYPE_NB && type_index_map[type] == -1
596                 /* ignore attached pictures/cover art streams */
597                 && !(s->streams[i]->disposition & AV_DISPOSITION_ATTACHED_PIC))
598                 type_index_map[type] = i;
599         }
600
601         for (i = 0; i < FF_ARRAY_ELEMS(type_priority_list); i++) {
602             type = type_priority_list[i];
603             if ((seg->reference_stream_index = type_index_map[type]) >= 0)
604                 break;
605         }
606     } else {
607         for (i = 0; i < s->nb_streams; i++) {
608             ret = avformat_match_stream_specifier(s, s->streams[i],
609                                                   seg->reference_stream_specifier);
610             if (ret < 0)
611                 return ret;
612             if (ret > 0) {
613                 seg->reference_stream_index = i;
614                 break;
615             }
616         }
617     }
618
619     if (seg->reference_stream_index < 0) {
620         av_log(s, AV_LOG_ERROR, "Could not select stream matching identifier '%s'\n",
621                seg->reference_stream_specifier);
622         return AVERROR(EINVAL);
623     }
624
625     return 0;
626 }
627
628 static void seg_free_context(SegmentContext *seg)
629 {
630     ff_format_io_close(seg->avf, &seg->list_pb);
631     avformat_free_context(seg->avf);
632     seg->avf = NULL;
633 }
634
635 static int seg_init(AVFormatContext *s)
636 {
637     SegmentContext *seg = s->priv_data;
638     AVFormatContext *oc = seg->avf;
639     AVDictionary *options = NULL;
640     int ret;
641     int i;
642
643     seg->segment_count = 0;
644     if (!seg->write_header_trailer)
645         seg->individual_header_trailer = 0;
646
647     if (seg->header_filename) {
648         seg->write_header_trailer = 1;
649         seg->individual_header_trailer = 0;
650     }
651
652     if (!!seg->time_str + !!seg->times_str + !!seg->frames_str > 1) {
653         av_log(s, AV_LOG_ERROR,
654                "segment_time, segment_times, and segment_frames options "
655                "are mutually exclusive, select just one of them\n");
656         return AVERROR(EINVAL);
657     }
658
659     if (seg->times_str) {
660         if ((ret = parse_times(s, &seg->times, &seg->nb_times, seg->times_str)) < 0)
661             return ret;
662     } else if (seg->frames_str) {
663         if ((ret = parse_frames(s, &seg->frames, &seg->nb_frames, seg->frames_str)) < 0)
664             return ret;
665     } else {
666         /* set default value if not specified */
667         if (!seg->time_str)
668             seg->time_str = av_strdup("2");
669         if ((ret = av_parse_time(&seg->time, seg->time_str, 1)) < 0) {
670             av_log(s, AV_LOG_ERROR,
671                    "Invalid time duration specification '%s' for segment_time option\n",
672                    seg->time_str);
673             return ret;
674         }
675         if (seg->use_clocktime) {
676             if (seg->time <= 0) {
677                 av_log(s, AV_LOG_ERROR, "Invalid negative segment_time with segment_atclocktime option set\n");
678                 return AVERROR(EINVAL);
679             }
680             seg->clocktime_offset = seg->time - (seg->clocktime_offset % seg->time);
681         }
682     }
683
684     if (seg->format_options_str) {
685         ret = av_dict_parse_string(&seg->format_options, seg->format_options_str, "=", ":", 0);
686         if (ret < 0) {
687             av_log(s, AV_LOG_ERROR, "Could not parse format options list '%s'\n",
688                    seg->format_options_str);
689             goto fail;
690         }
691     }
692
693     if (seg->list) {
694         if (seg->list_type == LIST_TYPE_UNDEFINED) {
695             if      (av_match_ext(seg->list, "csv" )) seg->list_type = LIST_TYPE_CSV;
696             else if (av_match_ext(seg->list, "ext" )) seg->list_type = LIST_TYPE_EXT;
697             else if (av_match_ext(seg->list, "m3u8")) seg->list_type = LIST_TYPE_M3U8;
698             else if (av_match_ext(seg->list, "ffcat,ffconcat")) seg->list_type = LIST_TYPE_FFCONCAT;
699             else                                      seg->list_type = LIST_TYPE_FLAT;
700         }
701         if (!seg->list_size && seg->list_type != LIST_TYPE_M3U8) {
702             if ((ret = segment_list_open(s)) < 0)
703                 goto fail;
704         } else {
705             const char *proto = avio_find_protocol_name(s->filename);
706             seg->use_rename = proto && !strcmp(proto, "file");
707         }
708     }
709
710     if (seg->list_type == LIST_TYPE_EXT)
711         av_log(s, AV_LOG_WARNING, "'ext' list type option is deprecated in favor of 'csv'\n");
712
713     if ((ret = select_reference_stream(s)) < 0)
714         goto fail;
715     av_log(s, AV_LOG_VERBOSE, "Selected stream id:%d type:%s\n",
716            seg->reference_stream_index,
717            av_get_media_type_string(s->streams[seg->reference_stream_index]->codec->codec_type));
718
719     seg->oformat = av_guess_format(seg->format, s->filename, NULL);
720
721     if (!seg->oformat) {
722         ret = AVERROR_MUXER_NOT_FOUND;
723         goto fail;
724     }
725     if (seg->oformat->flags & AVFMT_NOFILE) {
726         av_log(s, AV_LOG_ERROR, "format %s not supported.\n",
727                seg->oformat->name);
728         ret = AVERROR(EINVAL);
729         goto fail;
730     }
731
732     if ((ret = segment_mux_init(s)) < 0)
733         goto fail;
734
735     if ((ret = set_segment_filename(s)) < 0)
736         goto fail;
737     oc = seg->avf;
738
739     if (seg->write_header_trailer) {
740         if ((ret = s->io_open(s, &oc->pb,
741                               seg->header_filename ? seg->header_filename : oc->filename,
742                               AVIO_FLAG_WRITE, NULL)) < 0) {
743             av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->filename);
744             goto fail;
745         }
746         if (!seg->individual_header_trailer)
747             oc->pb->seekable = 0;
748     } else {
749         if ((ret = open_null_ctx(&oc->pb)) < 0)
750             goto fail;
751     }
752
753     av_dict_copy(&options, seg->format_options, 0);
754     ret = avformat_write_header(oc, &options);
755     if (av_dict_count(options)) {
756         av_log(s, AV_LOG_ERROR,
757                "Some of the provided format options in '%s' are not recognized\n", seg->format_options_str);
758         ret = AVERROR(EINVAL);
759         goto fail;
760     }
761
762     if (ret < 0) {
763         ff_format_io_close(oc, &oc->pb);
764         goto fail;
765     }
766     seg->segment_frame_count = 0;
767
768     av_assert0(s->nb_streams == oc->nb_streams);
769     for (i = 0; i < s->nb_streams; i++) {
770         AVStream *inner_st  = oc->streams[i];
771         AVStream *outer_st = s->streams[i];
772         avpriv_set_pts_info(outer_st, inner_st->pts_wrap_bits, inner_st->time_base.num, inner_st->time_base.den);
773     }
774
775     if (oc->avoid_negative_ts > 0 && s->avoid_negative_ts < 0)
776         s->avoid_negative_ts = 1;
777
778     if (!seg->write_header_trailer || seg->header_filename) {
779         if (seg->header_filename) {
780             av_write_frame(oc, NULL);
781             ff_format_io_close(oc, &oc->pb);
782         } else {
783             close_null_ctxp(&oc->pb);
784         }
785         if ((ret = oc->io_open(oc, &oc->pb, oc->filename, AVIO_FLAG_WRITE, NULL)) < 0)
786             goto fail;
787         if (!seg->individual_header_trailer)
788             oc->pb->seekable = 0;
789     }
790
791 fail:
792     av_dict_free(&options);
793     if (ret < 0)
794         seg_free_context(seg);
795
796     return ret;
797 }
798
799 static int seg_write_packet(AVFormatContext *s, AVPacket *pkt)
800 {
801     SegmentContext *seg = s->priv_data;
802     AVStream *st = s->streams[pkt->stream_index];
803     int64_t end_pts = INT64_MAX, offset;
804     int start_frame = INT_MAX;
805     int ret;
806     struct tm ti;
807     int64_t usecs;
808     int64_t wrapped_val;
809
810     if (!seg->avf)
811         return AVERROR(EINVAL);
812
813     if (seg->times) {
814         end_pts = seg->segment_count < seg->nb_times ?
815             seg->times[seg->segment_count] : INT64_MAX;
816     } else if (seg->frames) {
817         start_frame = seg->segment_count < seg->nb_frames ?
818             seg->frames[seg->segment_count] : INT_MAX;
819     } else {
820         if (seg->use_clocktime) {
821             int64_t avgt = av_gettime();
822             time_t sec = avgt / 1000000;
823             localtime_r(&sec, &ti);
824             usecs = (int64_t)(ti.tm_hour * 3600 + ti.tm_min * 60 + ti.tm_sec) * 1000000 + (avgt % 1000000);
825             wrapped_val = (usecs + seg->clocktime_offset) % seg->time;
826             if (seg->last_cut != usecs && wrapped_val < seg->last_val && wrapped_val < seg->clocktime_wrap_duration) {
827                 seg->cut_pending = 1;
828                 seg->last_cut = usecs;
829             }
830             seg->last_val = wrapped_val;
831         } else {
832             end_pts = seg->time * (seg->segment_count + 1);
833         }
834     }
835
836     ff_dlog(s, "packet stream:%d pts:%s pts_time:%s duration_time:%s is_key:%d frame:%d\n",
837             pkt->stream_index, av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
838             av_ts2timestr(pkt->duration, &st->time_base),
839             pkt->flags & AV_PKT_FLAG_KEY,
840             pkt->stream_index == seg->reference_stream_index ? seg->frame_count : -1);
841
842     if (pkt->stream_index == seg->reference_stream_index &&
843         (pkt->flags & AV_PKT_FLAG_KEY || seg->break_non_keyframes) &&
844         seg->segment_frame_count > 0 &&
845         (seg->cut_pending || seg->frame_count >= start_frame ||
846          (pkt->pts != AV_NOPTS_VALUE &&
847           av_compare_ts(pkt->pts, st->time_base,
848                         end_pts - seg->time_delta, AV_TIME_BASE_Q) >= 0))) {
849         /* sanitize end time in case last packet didn't have a defined duration */
850         if (seg->cur_entry.last_duration == 0)
851             seg->cur_entry.end_time = (double)pkt->pts * av_q2d(st->time_base);
852
853         if ((ret = segment_end(s, seg->individual_header_trailer, 0)) < 0)
854             goto fail;
855
856         if ((ret = segment_start(s, seg->individual_header_trailer)) < 0)
857             goto fail;
858
859         seg->cut_pending = 0;
860         seg->cur_entry.index = seg->segment_idx + seg->segment_idx_wrap * seg->segment_idx_wrap_nb;
861         seg->cur_entry.start_time = (double)pkt->pts * av_q2d(st->time_base);
862         seg->cur_entry.start_pts = av_rescale_q(pkt->pts, st->time_base, AV_TIME_BASE_Q);
863         seg->cur_entry.end_time = seg->cur_entry.start_time +
864             pkt->pts != AV_NOPTS_VALUE ? (double)(pkt->pts + pkt->duration) * av_q2d(st->time_base) : 0;
865     } else if (pkt->pts != AV_NOPTS_VALUE && pkt->stream_index == seg->reference_stream_index) {
866         seg->cur_entry.end_time =
867             FFMAX(seg->cur_entry.end_time, (double)(pkt->pts + pkt->duration) * av_q2d(st->time_base));
868         seg->cur_entry.last_duration = pkt->duration;
869     }
870
871     if (seg->segment_frame_count == 0) {
872         av_log(s, AV_LOG_VERBOSE, "segment:'%s' starts with packet stream:%d pts:%s pts_time:%s frame:%d\n",
873                seg->avf->filename, pkt->stream_index,
874                av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base), seg->frame_count);
875     }
876
877     av_log(s, AV_LOG_DEBUG, "stream:%d start_pts_time:%s pts:%s pts_time:%s dts:%s dts_time:%s",
878            pkt->stream_index,
879            av_ts2timestr(seg->cur_entry.start_pts, &AV_TIME_BASE_Q),
880            av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
881            av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
882
883     /* compute new timestamps */
884     offset = av_rescale_q(seg->initial_offset - (seg->reset_timestamps ? seg->cur_entry.start_pts : 0),
885                           AV_TIME_BASE_Q, st->time_base);
886     if (pkt->pts != AV_NOPTS_VALUE)
887         pkt->pts += offset;
888     if (pkt->dts != AV_NOPTS_VALUE)
889         pkt->dts += offset;
890
891     av_log(s, AV_LOG_DEBUG, " -> pts:%s pts_time:%s dts:%s dts_time:%s\n",
892            av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
893            av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
894
895     ret = ff_write_chained(seg->avf, pkt->stream_index, pkt, s, seg->initial_offset || seg->reset_timestamps);
896
897 fail:
898     if (pkt->stream_index == seg->reference_stream_index) {
899         seg->frame_count++;
900         seg->segment_frame_count++;
901     }
902
903     if (ret < 0)
904         seg_free_context(seg);
905
906     return ret;
907 }
908
909 static int seg_write_trailer(struct AVFormatContext *s)
910 {
911     SegmentContext *seg = s->priv_data;
912     AVFormatContext *oc = seg->avf;
913     SegmentListEntry *cur, *next;
914     int ret = 0;
915
916     if (!oc)
917         goto fail;
918
919     if (!seg->write_header_trailer) {
920         if ((ret = segment_end(s, 0, 1)) < 0)
921             goto fail;
922         if ((ret = open_null_ctx(&oc->pb)) < 0)
923             goto fail;
924         ret = av_write_trailer(oc);
925         close_null_ctxp(&oc->pb);
926     } else {
927         ret = segment_end(s, 1, 1);
928     }
929 fail:
930     if (seg->list)
931         ff_format_io_close(s, &seg->list_pb);
932
933     av_dict_free(&seg->format_options);
934     av_opt_free(seg);
935     av_freep(&seg->times);
936     av_freep(&seg->frames);
937     av_freep(&seg->cur_entry.filename);
938
939     cur = seg->segment_list_entries;
940     while (cur) {
941         next = cur->next;
942         av_freep(&cur->filename);
943         av_free(cur);
944         cur = next;
945     }
946
947     avformat_free_context(oc);
948     seg->avf = NULL;
949     return ret;
950 }
951
952 static int seg_check_bitstream(struct AVFormatContext *s, const AVPacket *pkt)
953 {
954     SegmentContext *seg = s->priv_data;
955     AVFormatContext *oc = seg->avf;
956     if (oc->oformat->check_bitstream) {
957         int ret = oc->oformat->check_bitstream(oc, pkt);
958         if (ret == 1) {
959             AVStream *st = s->streams[pkt->stream_index];
960             AVStream *ost = oc->streams[pkt->stream_index];
961             st->internal->bsfc = ost->internal->bsfc;
962             ost->internal->bsfc = NULL;
963         }
964         return ret;
965     }
966     return 1;
967 }
968
969 #define OFFSET(x) offsetof(SegmentContext, x)
970 #define E AV_OPT_FLAG_ENCODING_PARAM
971 static const AVOption options[] = {
972     { "reference_stream",  "set reference stream", OFFSET(reference_stream_specifier), AV_OPT_TYPE_STRING, {.str = "auto"}, CHAR_MIN, CHAR_MAX, E },
973     { "segment_format",    "set container format used for the segments", OFFSET(format),  AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
974     { "segment_format_options", "set list of options for the container format used for the segments", OFFSET(format_options_str), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
975     { "segment_list",      "set the segment list filename",              OFFSET(list),    AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
976     { "segment_header_filename", "write a single file containing the header", OFFSET(header_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
977
978     { "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"},
979     { "cache",             "allow list caching",                                    0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_LIST_FLAG_CACHE }, INT_MIN, INT_MAX,   E, "list_flags"},
980     { "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"},
981
982     { "segment_list_size", "set the maximum number of playlist entries", OFFSET(list_size), AV_OPT_TYPE_INT,  {.i64 = 0},     0, INT_MAX, E },
983
984     { "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" },
985     { "flat", "flat format",     0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FLAT }, INT_MIN, INT_MAX, E, "list_type" },
986     { "csv",  "csv format",      0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_CSV  }, INT_MIN, INT_MAX, E, "list_type" },
987     { "ext",  "extended format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_EXT  }, INT_MIN, INT_MAX, E, "list_type" },
988     { "ffconcat", "ffconcat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FFCONCAT }, INT_MIN, INT_MAX, E, "list_type" },
989     { "m3u8", "M3U8 format",     0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
990     { "hls", "Apple HTTP Live Streaming compatible", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
991
992     { "segment_atclocktime",      "set segment to be cut at clocktime",  OFFSET(use_clocktime), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E},
993     { "segment_clocktime_offset", "set segment clocktime offset",        OFFSET(clocktime_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, 86400000000LL, E},
994     { "segment_clocktime_wrap_duration", "set segment clocktime wrapping duration", OFFSET(clocktime_wrap_duration), AV_OPT_TYPE_DURATION, {.i64 = INT64_MAX}, 0, INT64_MAX, E},
995     { "segment_time",      "set segment duration",                       OFFSET(time_str),AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
996     { "segment_time_delta","set approximation value used for the segment times", OFFSET(time_delta), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, 0, E },
997     { "segment_times",     "set segment split time points",              OFFSET(times_str),AV_OPT_TYPE_STRING,{.str = NULL},  0, 0,       E },
998     { "segment_frames",    "set segment split frame numbers",            OFFSET(frames_str),AV_OPT_TYPE_STRING,{.str = NULL},  0, 0,       E },
999     { "segment_wrap",      "set number after which the index wraps",     OFFSET(segment_idx_wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1000     { "segment_list_entry_prefix", "set base url prefix for segments", OFFSET(entry_prefix), AV_OPT_TYPE_STRING,  {.str = NULL}, 0, 0, E },
1001     { "segment_start_number", "set the sequence number of the first segment", OFFSET(segment_idx), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1002     { "segment_wrap_number", "set the number of wrap before the first segment", OFFSET(segment_idx_wrap_nb), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1003     { "strftime",          "set filename expansion with strftime at segment creation", OFFSET(use_strftime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1004     { "increment_tc", "increment timecode between each segment", OFFSET(increment_tc), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1005     { "break_non_keyframes", "allow breaking segments on non-keyframes", OFFSET(break_non_keyframes), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1006
1007     { "individual_header_trailer", "write header/trailer to each segment", OFFSET(individual_header_trailer), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, E },
1008     { "write_header_trailer", "write a header to the first segment and a trailer to the last one", OFFSET(write_header_trailer), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, E },
1009     { "reset_timestamps", "reset timestamps at the begin of each segment", OFFSET(reset_timestamps), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1010     { "initial_offset", "set initial timestamp offset", OFFSET(initial_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, -INT64_MAX, INT64_MAX, E },
1011     { NULL },
1012 };
1013
1014 static const AVClass seg_class = {
1015     .class_name = "segment muxer",
1016     .item_name  = av_default_item_name,
1017     .option     = options,
1018     .version    = LIBAVUTIL_VERSION_INT,
1019 };
1020
1021 AVOutputFormat ff_segment_muxer = {
1022     .name           = "segment",
1023     .long_name      = NULL_IF_CONFIG_SMALL("segment"),
1024     .priv_data_size = sizeof(SegmentContext),
1025     .flags          = AVFMT_NOFILE|AVFMT_GLOBALHEADER,
1026     .init           = seg_init,
1027     .write_packet   = seg_write_packet,
1028     .write_trailer  = seg_write_trailer,
1029     .check_bitstream = seg_check_bitstream,
1030     .priv_class     = &seg_class,
1031 };
1032
1033 static const AVClass sseg_class = {
1034     .class_name = "stream_segment muxer",
1035     .item_name  = av_default_item_name,
1036     .option     = options,
1037     .version    = LIBAVUTIL_VERSION_INT,
1038 };
1039
1040 AVOutputFormat ff_stream_segment_muxer = {
1041     .name           = "stream_segment,ssegment",
1042     .long_name      = NULL_IF_CONFIG_SMALL("streaming segment muxer"),
1043     .priv_data_size = sizeof(SegmentContext),
1044     .flags          = AVFMT_NOFILE,
1045     .init           = seg_init,
1046     .write_packet   = seg_write_packet,
1047     .write_trailer  = seg_write_trailer,
1048     .check_bitstream = seg_check_bitstream,
1049     .priv_class     = &sseg_class,
1050 };