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