2 * Copyright (c) 2011, Luca Barbato
4 * This file is part of FFmpeg.
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.
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.
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
22 * @file generic segmenter
23 * M3U8 specification can be find here:
24 * @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}
33 #include "avio_internal.h"
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"
48 typedef struct SegmentListEntry {
50 double start_time, end_time;
54 struct SegmentListEntry *next;
55 int64_t last_duration;
59 LIST_TYPE_UNDEFINED = -1,
63 LIST_TYPE_EXT, ///< deprecated
68 #define SEGMENT_LIST_FLAG_CACHE 1
69 #define SEGMENT_LIST_FLAG_LIVE 2
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;
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
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
92 int header_written; ///< whether we've already called avformat_write_header
94 char *entry_prefix; ///< prefix to add to list entry filenames
95 int list_type; ///< set the list type
96 AVIOContext *list_pb; ///< list file put-byte context
97 char *time_str; ///< segment duration specification string
98 int64_t time; ///< segment duration
99 int use_strftime; ///< flag to expand filename with strftime
100 int increment_tc; ///< flag to increment timecode if found
102 char *times_str; ///< segment times specification string
103 int64_t *times; ///< list of segment interval specification
104 int nb_times; ///< number of elments in the times array
106 char *frames_str; ///< segment frame numbers specification string
107 int *frames; ///< list of frame number specification
108 int nb_frames; ///< number of elments in the frames array
109 int frame_count; ///< total number of reference frames
110 int segment_frame_count; ///< number of reference frames in the segment
113 int individual_header_trailer; /**< Set by a private option. */
114 int write_header_trailer; /**< Set by a private option. */
115 char *header_filename; ///< filename to write the output header to
117 int reset_timestamps; ///< reset timestamps at the begin of each segment
118 int64_t initial_offset; ///< initial timestamps offset, expressed in microseconds
119 char *reference_stream_specifier; ///< reference stream specifier
120 int reference_stream_index;
121 int break_non_keyframes;
125 char temp_list_filename[1024];
127 SegmentListEntry cur_entry;
128 SegmentListEntry *segment_list_entries;
129 SegmentListEntry *segment_list_entries_end;
132 static void print_csv_escaped_str(AVIOContext *ctx, const char *str)
134 int needs_quoting = !!str[strcspn(str, "\",\n\r")];
139 for (; *str; str++) {
148 static int segment_mux_init(AVFormatContext *s)
150 SegmentContext *seg = s->priv_data;
155 ret = avformat_alloc_output_context2(&seg->avf, seg->oformat, NULL, NULL);
160 oc->interrupt_callback = s->interrupt_callback;
161 oc->max_delay = s->max_delay;
162 av_dict_copy(&oc->metadata, s->metadata, 0);
163 oc->opaque = s->opaque;
164 oc->io_close = s->io_close;
165 oc->io_open = s->io_open;
166 oc->flags = s->flags;
168 for (i = 0; i < s->nb_streams; i++) {
170 AVCodecParameters *ipar, *opar;
172 if (!(st = avformat_new_stream(oc, NULL)))
173 return AVERROR(ENOMEM);
174 ipar = s->streams[i]->codecpar;
176 avcodec_parameters_copy(opar, ipar);
177 if (!oc->oformat->codec_tag ||
178 av_codec_get_id (oc->oformat->codec_tag, ipar->codec_tag) == opar->codec_id ||
179 av_codec_get_tag(oc->oformat->codec_tag, ipar->codec_id) <= 0) {
180 opar->codec_tag = ipar->codec_tag;
184 st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
185 st->time_base = s->streams[i]->time_base;
186 av_dict_copy(&st->metadata, s->streams[i]->metadata, 0);
192 static int set_segment_filename(AVFormatContext *s)
194 SegmentContext *seg = s->priv_data;
195 AVFormatContext *oc = seg->avf;
199 if (seg->segment_idx_wrap)
200 seg->segment_idx %= seg->segment_idx_wrap;
201 if (seg->use_strftime) {
203 struct tm *tm, tmpbuf;
205 tm = localtime_r(&now0, &tmpbuf);
206 if (!strftime(oc->filename, sizeof(oc->filename), s->filename, tm)) {
207 av_log(oc, AV_LOG_ERROR, "Could not get segment filename with strftime\n");
208 return AVERROR(EINVAL);
210 } else if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
211 s->filename, seg->segment_idx) < 0) {
212 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", s->filename);
213 return AVERROR(EINVAL);
216 /* copy modified name in list entry */
217 size = strlen(av_basename(oc->filename)) + 1;
218 if (seg->entry_prefix)
219 size += strlen(seg->entry_prefix);
221 if ((ret = av_reallocp(&seg->cur_entry.filename, size)) < 0)
223 snprintf(seg->cur_entry.filename, size, "%s%s",
224 seg->entry_prefix ? seg->entry_prefix : "",
225 av_basename(oc->filename));
230 static int segment_start(AVFormatContext *s, int write_header)
232 SegmentContext *seg = s->priv_data;
233 AVFormatContext *oc = seg->avf;
237 avformat_free_context(oc);
239 if ((err = segment_mux_init(s)) < 0)
245 if ((seg->segment_idx_wrap) && (seg->segment_idx % seg->segment_idx_wrap == 0))
246 seg->segment_idx_wrap_nb++;
248 if ((err = set_segment_filename(s)) < 0)
251 if ((err = s->io_open(s, &oc->pb, oc->filename, AVIO_FLAG_WRITE, NULL)) < 0) {
252 av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->filename);
255 if (!seg->individual_header_trailer)
256 oc->pb->seekable = 0;
258 if (oc->oformat->priv_class && oc->priv_data)
259 av_opt_set(oc->priv_data, "mpegts_flags", "+resend_headers", 0);
262 AVDictionary *options = NULL;
263 av_dict_copy(&options, seg->format_options, 0);
264 av_dict_set(&options, "fflags", "-autobsf", 0);
265 err = avformat_write_header(oc, &options);
266 av_dict_free(&options);
271 seg->segment_frame_count = 0;
275 static int segment_list_open(AVFormatContext *s)
277 SegmentContext *seg = s->priv_data;
280 snprintf(seg->temp_list_filename, sizeof(seg->temp_list_filename), seg->use_rename ? "%s.tmp" : "%s", seg->list);
281 ret = s->io_open(s, &seg->list_pb, seg->temp_list_filename, AVIO_FLAG_WRITE, NULL);
283 av_log(s, AV_LOG_ERROR, "Failed to open segment list '%s'\n", seg->list);
287 if (seg->list_type == LIST_TYPE_M3U8 && seg->segment_list_entries) {
288 SegmentListEntry *entry;
289 double max_duration = 0;
291 avio_printf(seg->list_pb, "#EXTM3U\n");
292 avio_printf(seg->list_pb, "#EXT-X-VERSION:3\n");
293 avio_printf(seg->list_pb, "#EXT-X-MEDIA-SEQUENCE:%d\n", seg->segment_list_entries->index);
294 avio_printf(seg->list_pb, "#EXT-X-ALLOW-CACHE:%s\n",
295 seg->list_flags & SEGMENT_LIST_FLAG_CACHE ? "YES" : "NO");
297 av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%d\n",
298 seg->segment_list_entries->index);
300 for (entry = seg->segment_list_entries; entry; entry = entry->next)
301 max_duration = FFMAX(max_duration, entry->end_time - entry->start_time);
302 avio_printf(seg->list_pb, "#EXT-X-TARGETDURATION:%"PRId64"\n", (int64_t)ceil(max_duration));
303 } else if (seg->list_type == LIST_TYPE_FFCONCAT) {
304 avio_printf(seg->list_pb, "ffconcat version 1.0\n");
310 static void segment_list_print_entry(AVIOContext *list_ioctx,
312 const SegmentListEntry *list_entry,
317 avio_printf(list_ioctx, "%s\n", list_entry->filename);
321 print_csv_escaped_str(list_ioctx, list_entry->filename);
322 avio_printf(list_ioctx, ",%f,%f\n", list_entry->start_time, list_entry->end_time);
325 avio_printf(list_ioctx, "#EXTINF:%f,\n%s\n",
326 list_entry->end_time - list_entry->start_time, list_entry->filename);
328 case LIST_TYPE_FFCONCAT:
331 if (av_escape(&buf, list_entry->filename, NULL, AV_ESCAPE_MODE_AUTO, AV_ESCAPE_FLAG_WHITESPACE) < 0) {
332 av_log(log_ctx, AV_LOG_WARNING,
333 "Error writing list entry '%s' in list file\n", list_entry->filename);
336 avio_printf(list_ioctx, "file %s\n", buf);
341 av_assert0(!"Invalid list type");
345 static int segment_end(AVFormatContext *s, int write_trailer, int is_last)
347 SegmentContext *seg = s->priv_data;
348 AVFormatContext *oc = seg->avf;
352 AVDictionaryEntry *tcr;
353 char buf[AV_TIMECODE_STR_SIZE];
358 return AVERROR(EINVAL);
360 av_write_frame(oc, NULL); /* Flush any buffered data (fragmented mp4) */
362 ret = av_write_trailer(oc);
365 av_log(s, AV_LOG_ERROR, "Failure occurred when ending segment '%s'\n",
369 if (seg->list_size || seg->list_type == LIST_TYPE_M3U8) {
370 SegmentListEntry *entry = av_mallocz(sizeof(*entry));
372 ret = AVERROR(ENOMEM);
376 /* append new element */
377 memcpy(entry, &seg->cur_entry, sizeof(*entry));
378 entry->filename = av_strdup(entry->filename);
379 if (!seg->segment_list_entries)
380 seg->segment_list_entries = seg->segment_list_entries_end = entry;
382 seg->segment_list_entries_end->next = entry;
383 seg->segment_list_entries_end = entry;
385 /* drop first item */
386 if (seg->list_size && seg->segment_count >= seg->list_size) {
387 entry = seg->segment_list_entries;
388 seg->segment_list_entries = seg->segment_list_entries->next;
389 av_freep(&entry->filename);
393 if ((ret = segment_list_open(s)) < 0)
395 for (entry = seg->segment_list_entries; entry; entry = entry->next)
396 segment_list_print_entry(seg->list_pb, seg->list_type, entry, s);
397 if (seg->list_type == LIST_TYPE_M3U8 && is_last)
398 avio_printf(seg->list_pb, "#EXT-X-ENDLIST\n");
399 ff_format_io_close(s, &seg->list_pb);
401 ff_rename(seg->temp_list_filename, seg->list, s);
403 segment_list_print_entry(seg->list_pb, seg->list_type, &seg->cur_entry, s);
404 avio_flush(seg->list_pb);
408 av_log(s, AV_LOG_VERBOSE, "segment:'%s' count:%d ended\n",
409 seg->avf->filename, seg->segment_count);
410 seg->segment_count++;
412 if (seg->increment_tc) {
413 tcr = av_dict_get(s->metadata, "timecode", NULL, 0);
415 /* search the first video stream */
416 for (i = 0; i < s->nb_streams; i++) {
417 if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
418 rate = s->streams[i]->avg_frame_rate;/* Get fps from the video stream */
419 err = av_timecode_init_from_string(&tc, rate, tcr->value, s);
421 av_log(s, AV_LOG_WARNING, "Could not increment timecode, error occurred during timecode creation.");
424 tc.start += (int)((seg->cur_entry.end_time - seg->cur_entry.start_time) * av_q2d(rate));/* increment timecode */
425 av_dict_set(&s->metadata, "timecode",
426 av_timecode_make_string(&tc, buf, 0), 0);
431 av_log(s, AV_LOG_WARNING, "Could not increment timecode, no timecode metadata found");
436 ff_format_io_close(oc, &oc->pb);
441 static int parse_times(void *log_ctx, int64_t **times, int *nb_times,
442 const char *times_str)
446 char *times_str1 = av_strdup(times_str);
447 char *saveptr = NULL;
450 return AVERROR(ENOMEM);
452 #define FAIL(err) ret = err; goto end
455 for (p = times_str1; *p; p++)
459 *times = av_malloc_array(*nb_times, sizeof(**times));
461 av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced times array\n");
462 FAIL(AVERROR(ENOMEM));
466 for (i = 0; i < *nb_times; i++) {
468 char *tstr = av_strtok(p, ",", &saveptr);
471 if (!tstr || !tstr[0]) {
472 av_log(log_ctx, AV_LOG_ERROR, "Empty time specification in times list %s\n",
474 FAIL(AVERROR(EINVAL));
477 ret = av_parse_time(&t, tstr, 1);
479 av_log(log_ctx, AV_LOG_ERROR,
480 "Invalid time duration specification '%s' in times list %s\n", tstr, times_str);
481 FAIL(AVERROR(EINVAL));
485 /* check on monotonicity */
486 if (i && (*times)[i-1] > (*times)[i]) {
487 av_log(log_ctx, AV_LOG_ERROR,
488 "Specified time %f is greater than the following time %f\n",
489 (float)((*times)[i])/1000000, (float)((*times)[i-1])/1000000);
490 FAIL(AVERROR(EINVAL));
499 static int parse_frames(void *log_ctx, int **frames, int *nb_frames,
500 const char *frames_str)
504 char *frames_str1 = av_strdup(frames_str);
505 char *saveptr = NULL;
508 return AVERROR(ENOMEM);
510 #define FAIL(err) ret = err; goto end
513 for (p = frames_str1; *p; p++)
517 *frames = av_malloc_array(*nb_frames, sizeof(**frames));
519 av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced frames array\n");
520 FAIL(AVERROR(ENOMEM));
524 for (i = 0; i < *nb_frames; i++) {
527 char *fstr = av_strtok(p, ",", &saveptr);
531 av_log(log_ctx, AV_LOG_ERROR, "Empty frame specification in frame list %s\n",
533 FAIL(AVERROR(EINVAL));
535 f = strtol(fstr, &tailptr, 10);
536 if (*tailptr || f <= 0 || f >= INT_MAX) {
537 av_log(log_ctx, AV_LOG_ERROR,
538 "Invalid argument '%s', must be a positive integer <= INT64_MAX\n",
540 FAIL(AVERROR(EINVAL));
544 /* check on monotonicity */
545 if (i && (*frames)[i-1] > (*frames)[i]) {
546 av_log(log_ctx, AV_LOG_ERROR,
547 "Specified frame %d is greater than the following frame %d\n",
548 (*frames)[i], (*frames)[i-1]);
549 FAIL(AVERROR(EINVAL));
554 av_free(frames_str1);
558 static int open_null_ctx(AVIOContext **ctx)
560 int buf_size = 32768;
561 uint8_t *buf = av_malloc(buf_size);
563 return AVERROR(ENOMEM);
564 *ctx = avio_alloc_context(buf, buf_size, AVIO_FLAG_WRITE, NULL, NULL, NULL, NULL);
567 return AVERROR(ENOMEM);
572 static void close_null_ctxp(AVIOContext **pb)
574 av_freep(&(*pb)->buffer);
578 static int select_reference_stream(AVFormatContext *s)
580 SegmentContext *seg = s->priv_data;
583 seg->reference_stream_index = -1;
584 if (!strcmp(seg->reference_stream_specifier, "auto")) {
585 /* select first index of type with highest priority */
586 int type_index_map[AVMEDIA_TYPE_NB];
587 static const enum AVMediaType type_priority_list[] = {
590 AVMEDIA_TYPE_SUBTITLE,
592 AVMEDIA_TYPE_ATTACHMENT
594 enum AVMediaType type;
596 for (i = 0; i < AVMEDIA_TYPE_NB; i++)
597 type_index_map[i] = -1;
599 /* select first index for each type */
600 for (i = 0; i < s->nb_streams; i++) {
601 type = s->streams[i]->codecpar->codec_type;
602 if ((unsigned)type < AVMEDIA_TYPE_NB && type_index_map[type] == -1
603 /* ignore attached pictures/cover art streams */
604 && !(s->streams[i]->disposition & AV_DISPOSITION_ATTACHED_PIC))
605 type_index_map[type] = i;
608 for (i = 0; i < FF_ARRAY_ELEMS(type_priority_list); i++) {
609 type = type_priority_list[i];
610 if ((seg->reference_stream_index = type_index_map[type]) >= 0)
614 for (i = 0; i < s->nb_streams; i++) {
615 ret = avformat_match_stream_specifier(s, s->streams[i],
616 seg->reference_stream_specifier);
620 seg->reference_stream_index = i;
626 if (seg->reference_stream_index < 0) {
627 av_log(s, AV_LOG_ERROR, "Could not select stream matching identifier '%s'\n",
628 seg->reference_stream_specifier);
629 return AVERROR(EINVAL);
635 static void seg_free(AVFormatContext *s)
637 SegmentContext *seg = s->priv_data;
638 ff_format_io_close(seg->avf, &seg->list_pb);
639 avformat_free_context(seg->avf);
643 static int seg_init(AVFormatContext *s)
645 SegmentContext *seg = s->priv_data;
646 AVFormatContext *oc = seg->avf;
647 AVDictionary *options = NULL;
651 seg->segment_count = 0;
652 if (!seg->write_header_trailer)
653 seg->individual_header_trailer = 0;
655 if (seg->header_filename) {
656 seg->write_header_trailer = 1;
657 seg->individual_header_trailer = 0;
660 if (seg->initial_offset > 0) {
661 av_log(s, AV_LOG_WARNING, "NOTE: the option initial_offset is deprecated,"
662 "you can use output_ts_offset instead of it\n");
665 if (!!seg->time_str + !!seg->times_str + !!seg->frames_str > 1) {
666 av_log(s, AV_LOG_ERROR,
667 "segment_time, segment_times, and segment_frames options "
668 "are mutually exclusive, select just one of them\n");
669 return AVERROR(EINVAL);
672 if (seg->times_str) {
673 if ((ret = parse_times(s, &seg->times, &seg->nb_times, seg->times_str)) < 0)
675 } else if (seg->frames_str) {
676 if ((ret = parse_frames(s, &seg->frames, &seg->nb_frames, seg->frames_str)) < 0)
679 /* set default value if not specified */
681 seg->time_str = av_strdup("2");
682 if ((ret = av_parse_time(&seg->time, seg->time_str, 1)) < 0) {
683 av_log(s, AV_LOG_ERROR,
684 "Invalid time duration specification '%s' for segment_time option\n",
688 if (seg->use_clocktime) {
689 if (seg->time <= 0) {
690 av_log(s, AV_LOG_ERROR, "Invalid negative segment_time with segment_atclocktime option set\n");
691 return AVERROR(EINVAL);
693 seg->clocktime_offset = seg->time - (seg->clocktime_offset % seg->time);
697 if (seg->format_options_str) {
698 ret = av_dict_parse_string(&seg->format_options, seg->format_options_str, "=", ":", 0);
700 av_log(s, AV_LOG_ERROR, "Could not parse format options list '%s'\n",
701 seg->format_options_str);
707 if (seg->list_type == LIST_TYPE_UNDEFINED) {
708 if (av_match_ext(seg->list, "csv" )) seg->list_type = LIST_TYPE_CSV;
709 else if (av_match_ext(seg->list, "ext" )) seg->list_type = LIST_TYPE_EXT;
710 else if (av_match_ext(seg->list, "m3u8")) seg->list_type = LIST_TYPE_M3U8;
711 else if (av_match_ext(seg->list, "ffcat,ffconcat")) seg->list_type = LIST_TYPE_FFCONCAT;
712 else seg->list_type = LIST_TYPE_FLAT;
714 if (!seg->list_size && seg->list_type != LIST_TYPE_M3U8) {
715 if ((ret = segment_list_open(s)) < 0)
718 const char *proto = avio_find_protocol_name(seg->list);
719 seg->use_rename = proto && !strcmp(proto, "file");
723 if (seg->list_type == LIST_TYPE_EXT)
724 av_log(s, AV_LOG_WARNING, "'ext' list type option is deprecated in favor of 'csv'\n");
726 if ((ret = select_reference_stream(s)) < 0)
728 av_log(s, AV_LOG_VERBOSE, "Selected stream id:%d type:%s\n",
729 seg->reference_stream_index,
730 av_get_media_type_string(s->streams[seg->reference_stream_index]->codecpar->codec_type));
732 seg->oformat = av_guess_format(seg->format, s->filename, NULL);
735 return AVERROR_MUXER_NOT_FOUND;
736 if (seg->oformat->flags & AVFMT_NOFILE) {
737 av_log(s, AV_LOG_ERROR, "format %s not supported.\n",
739 return AVERROR(EINVAL);
742 if ((ret = segment_mux_init(s)) < 0)
745 if ((ret = set_segment_filename(s)) < 0)
749 if (seg->write_header_trailer) {
750 if ((ret = s->io_open(s, &oc->pb,
751 seg->header_filename ? seg->header_filename : oc->filename,
752 AVIO_FLAG_WRITE, NULL)) < 0) {
753 av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->filename);
756 if (!seg->individual_header_trailer)
757 oc->pb->seekable = 0;
759 if ((ret = open_null_ctx(&oc->pb)) < 0)
763 av_dict_copy(&options, seg->format_options, 0);
764 av_dict_set(&options, "fflags", "-autobsf", 0);
765 ret = avformat_init_output(oc, &options);
766 if (av_dict_count(options)) {
767 av_log(s, AV_LOG_ERROR,
768 "Some of the provided format options in '%s' are not recognized\n", seg->format_options_str);
769 av_dict_free(&options);
770 return AVERROR(EINVAL);
772 av_dict_free(&options);
775 ff_format_io_close(oc, &oc->pb);
778 seg->segment_frame_count = 0;
780 av_assert0(s->nb_streams == oc->nb_streams);
781 if (ret == AVSTREAM_INIT_IN_WRITE_HEADER) {
782 ret = avformat_write_header(oc, NULL);
785 seg->header_written = 1;
788 for (i = 0; i < s->nb_streams; i++) {
789 AVStream *inner_st = oc->streams[i];
790 AVStream *outer_st = s->streams[i];
791 avpriv_set_pts_info(outer_st, inner_st->pts_wrap_bits, inner_st->time_base.num, inner_st->time_base.den);
794 if (oc->avoid_negative_ts > 0 && s->avoid_negative_ts < 0)
795 s->avoid_negative_ts = 1;
800 static int seg_write_header(AVFormatContext *s)
802 SegmentContext *seg = s->priv_data;
803 AVFormatContext *oc = seg->avf;
806 if (!seg->header_written) {
807 for (i = 0; i < s->nb_streams; i++) {
808 AVStream *st = oc->streams[i];
809 AVCodecParameters *ipar, *opar;
811 ipar = s->streams[i]->codecpar;
812 opar = oc->streams[i]->codecpar;
813 avcodec_parameters_copy(opar, ipar);
814 if (!oc->oformat->codec_tag ||
815 av_codec_get_id (oc->oformat->codec_tag, ipar->codec_tag) == opar->codec_id ||
816 av_codec_get_tag(oc->oformat->codec_tag, ipar->codec_id) <= 0) {
817 opar->codec_tag = ipar->codec_tag;
821 st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
822 st->time_base = s->streams[i]->time_base;
824 ret = avformat_write_header(oc, NULL);
829 if (!seg->write_header_trailer || seg->header_filename) {
830 if (seg->header_filename) {
831 av_write_frame(oc, NULL);
832 ff_format_io_close(oc, &oc->pb);
834 close_null_ctxp(&oc->pb);
836 if ((ret = oc->io_open(oc, &oc->pb, oc->filename, AVIO_FLAG_WRITE, NULL)) < 0)
838 if (!seg->individual_header_trailer)
839 oc->pb->seekable = 0;
845 static int seg_write_packet(AVFormatContext *s, AVPacket *pkt)
847 SegmentContext *seg = s->priv_data;
848 AVStream *st = s->streams[pkt->stream_index];
849 int64_t end_pts = INT64_MAX, offset;
850 int start_frame = INT_MAX;
856 if (!seg->avf || !seg->avf->pb)
857 return AVERROR(EINVAL);
861 end_pts = seg->segment_count < seg->nb_times ?
862 seg->times[seg->segment_count] : INT64_MAX;
863 } else if (seg->frames) {
864 start_frame = seg->segment_count < seg->nb_frames ?
865 seg->frames[seg->segment_count] : INT_MAX;
867 if (seg->use_clocktime) {
868 int64_t avgt = av_gettime();
869 time_t sec = avgt / 1000000;
870 localtime_r(&sec, &ti);
871 usecs = (int64_t)(ti.tm_hour * 3600 + ti.tm_min * 60 + ti.tm_sec) * 1000000 + (avgt % 1000000);
872 wrapped_val = (usecs + seg->clocktime_offset) % seg->time;
873 if (seg->last_cut != usecs && wrapped_val < seg->last_val && wrapped_val < seg->clocktime_wrap_duration) {
874 seg->cut_pending = 1;
875 seg->last_cut = usecs;
877 seg->last_val = wrapped_val;
879 end_pts = seg->time * (seg->segment_count + 1);
883 ff_dlog(s, "packet stream:%d pts:%s pts_time:%s duration_time:%s is_key:%d frame:%d\n",
884 pkt->stream_index, av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
885 av_ts2timestr(pkt->duration, &st->time_base),
886 pkt->flags & AV_PKT_FLAG_KEY,
887 pkt->stream_index == seg->reference_stream_index ? seg->frame_count : -1);
889 if (pkt->stream_index == seg->reference_stream_index &&
890 (pkt->flags & AV_PKT_FLAG_KEY || seg->break_non_keyframes) &&
891 (seg->segment_frame_count > 0 || seg->write_empty) &&
892 (seg->cut_pending || seg->frame_count >= start_frame ||
893 (pkt->pts != AV_NOPTS_VALUE &&
894 av_compare_ts(pkt->pts, st->time_base,
895 end_pts - seg->time_delta, AV_TIME_BASE_Q) >= 0))) {
896 /* sanitize end time in case last packet didn't have a defined duration */
897 if (seg->cur_entry.last_duration == 0)
898 seg->cur_entry.end_time = (double)pkt->pts * av_q2d(st->time_base);
900 if ((ret = segment_end(s, seg->individual_header_trailer, 0)) < 0)
903 if ((ret = segment_start(s, seg->individual_header_trailer)) < 0)
906 seg->cut_pending = 0;
907 seg->cur_entry.index = seg->segment_idx + seg->segment_idx_wrap * seg->segment_idx_wrap_nb;
908 seg->cur_entry.start_time = (double)pkt->pts * av_q2d(st->time_base);
909 seg->cur_entry.start_pts = av_rescale_q(pkt->pts, st->time_base, AV_TIME_BASE_Q);
910 seg->cur_entry.end_time = seg->cur_entry.start_time;
912 if (seg->times || (!seg->frames && !seg->use_clocktime) && seg->write_empty)
916 if (pkt->stream_index == seg->reference_stream_index) {
917 if (pkt->pts != AV_NOPTS_VALUE)
918 seg->cur_entry.end_time =
919 FFMAX(seg->cur_entry.end_time, (double)(pkt->pts + pkt->duration) * av_q2d(st->time_base));
920 seg->cur_entry.last_duration = pkt->duration;
923 if (seg->segment_frame_count == 0) {
924 av_log(s, AV_LOG_VERBOSE, "segment:'%s' starts with packet stream:%d pts:%s pts_time:%s frame:%d\n",
925 seg->avf->filename, pkt->stream_index,
926 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base), seg->frame_count);
929 av_log(s, AV_LOG_DEBUG, "stream:%d start_pts_time:%s pts:%s pts_time:%s dts:%s dts_time:%s",
931 av_ts2timestr(seg->cur_entry.start_pts, &AV_TIME_BASE_Q),
932 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
933 av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
935 /* compute new timestamps */
936 offset = av_rescale_q(seg->initial_offset - (seg->reset_timestamps ? seg->cur_entry.start_pts : 0),
937 AV_TIME_BASE_Q, st->time_base);
938 if (pkt->pts != AV_NOPTS_VALUE)
940 if (pkt->dts != AV_NOPTS_VALUE)
943 av_log(s, AV_LOG_DEBUG, " -> pts:%s pts_time:%s dts:%s dts_time:%s\n",
944 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
945 av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
947 ret = ff_write_chained(seg->avf, pkt->stream_index, pkt, s, seg->initial_offset || seg->reset_timestamps);
950 if (pkt->stream_index == seg->reference_stream_index) {
952 seg->segment_frame_count++;
958 static int seg_write_trailer(struct AVFormatContext *s)
960 SegmentContext *seg = s->priv_data;
961 AVFormatContext *oc = seg->avf;
962 SegmentListEntry *cur, *next;
968 if (!seg->write_header_trailer) {
969 if ((ret = segment_end(s, 0, 1)) < 0)
971 if ((ret = open_null_ctx(&oc->pb)) < 0)
973 ret = av_write_trailer(oc);
974 close_null_ctxp(&oc->pb);
976 ret = segment_end(s, 1, 1);
980 ff_format_io_close(s, &seg->list_pb);
982 av_dict_free(&seg->format_options);
984 av_freep(&seg->times);
985 av_freep(&seg->frames);
986 av_freep(&seg->cur_entry.filename);
988 cur = seg->segment_list_entries;
991 av_freep(&cur->filename);
996 avformat_free_context(oc);
1001 static int seg_check_bitstream(struct AVFormatContext *s, const AVPacket *pkt)
1003 SegmentContext *seg = s->priv_data;
1004 AVFormatContext *oc = seg->avf;
1005 if (oc->oformat->check_bitstream) {
1006 int ret = oc->oformat->check_bitstream(oc, pkt);
1008 AVStream *st = s->streams[pkt->stream_index];
1009 AVStream *ost = oc->streams[pkt->stream_index];
1010 st->internal->bsfcs = ost->internal->bsfcs;
1011 st->internal->nb_bsfcs = ost->internal->nb_bsfcs;
1012 ost->internal->bsfcs = NULL;
1013 ost->internal->nb_bsfcs = 0;
1020 #define OFFSET(x) offsetof(SegmentContext, x)
1021 #define E AV_OPT_FLAG_ENCODING_PARAM
1022 static const AVOption options[] = {
1023 { "reference_stream", "set reference stream", OFFSET(reference_stream_specifier), AV_OPT_TYPE_STRING, {.str = "auto"}, CHAR_MIN, CHAR_MAX, E },
1024 { "segment_format", "set container format used for the segments", OFFSET(format), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1025 { "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 },
1026 { "segment_list", "set the segment list filename", OFFSET(list), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1027 { "segment_header_filename", "write a single file containing the header", OFFSET(header_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1029 { "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"},
1030 { "cache", "allow list caching", 0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_LIST_FLAG_CACHE }, INT_MIN, INT_MAX, E, "list_flags"},
1031 { "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"},
1033 { "segment_list_size", "set the maximum number of playlist entries", OFFSET(list_size), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1035 { "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" },
1036 { "flat", "flat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FLAT }, INT_MIN, INT_MAX, E, "list_type" },
1037 { "csv", "csv format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_CSV }, INT_MIN, INT_MAX, E, "list_type" },
1038 { "ext", "extended format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_EXT }, INT_MIN, INT_MAX, E, "list_type" },
1039 { "ffconcat", "ffconcat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FFCONCAT }, INT_MIN, INT_MAX, E, "list_type" },
1040 { "m3u8", "M3U8 format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
1041 { "hls", "Apple HTTP Live Streaming compatible", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
1043 { "segment_atclocktime", "set segment to be cut at clocktime", OFFSET(use_clocktime), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E},
1044 { "segment_clocktime_offset", "set segment clocktime offset", OFFSET(clocktime_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, 86400000000LL, E},
1045 { "segment_clocktime_wrap_duration", "set segment clocktime wrapping duration", OFFSET(clocktime_wrap_duration), AV_OPT_TYPE_DURATION, {.i64 = INT64_MAX}, 0, INT64_MAX, E},
1046 { "segment_time", "set segment duration", OFFSET(time_str),AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1047 { "segment_time_delta","set approximation value used for the segment times", OFFSET(time_delta), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, 0, E },
1048 { "segment_times", "set segment split time points", OFFSET(times_str),AV_OPT_TYPE_STRING,{.str = NULL}, 0, 0, E },
1049 { "segment_frames", "set segment split frame numbers", OFFSET(frames_str),AV_OPT_TYPE_STRING,{.str = NULL}, 0, 0, E },
1050 { "segment_wrap", "set number after which the index wraps", OFFSET(segment_idx_wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1051 { "segment_list_entry_prefix", "set base url prefix for segments", OFFSET(entry_prefix), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1052 { "segment_start_number", "set the sequence number of the first segment", OFFSET(segment_idx), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1053 { "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 },
1054 { "strftime", "set filename expansion with strftime at segment creation", OFFSET(use_strftime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1055 { "increment_tc", "increment timecode between each segment", OFFSET(increment_tc), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1056 { "break_non_keyframes", "allow breaking segments on non-keyframes", OFFSET(break_non_keyframes), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1058 { "individual_header_trailer", "write header/trailer to each segment", OFFSET(individual_header_trailer), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, E },
1059 { "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 },
1060 { "reset_timestamps", "reset timestamps at the begin of each segment", OFFSET(reset_timestamps), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1061 { "initial_offset", "set initial timestamp offset", OFFSET(initial_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, -INT64_MAX, INT64_MAX, E },
1062 { "write_empty_segments", "allow writing empty 'filler' segments", OFFSET(write_empty), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1066 static const AVClass seg_class = {
1067 .class_name = "segment muxer",
1068 .item_name = av_default_item_name,
1070 .version = LIBAVUTIL_VERSION_INT,
1073 AVOutputFormat ff_segment_muxer = {
1075 .long_name = NULL_IF_CONFIG_SMALL("segment"),
1076 .priv_data_size = sizeof(SegmentContext),
1077 .flags = AVFMT_NOFILE|AVFMT_GLOBALHEADER,
1079 .write_header = seg_write_header,
1080 .write_packet = seg_write_packet,
1081 .write_trailer = seg_write_trailer,
1083 .check_bitstream = seg_check_bitstream,
1084 .priv_class = &seg_class,
1087 static const AVClass sseg_class = {
1088 .class_name = "stream_segment muxer",
1089 .item_name = av_default_item_name,
1091 .version = LIBAVUTIL_VERSION_INT,
1094 AVOutputFormat ff_stream_segment_muxer = {
1095 .name = "stream_segment,ssegment",
1096 .long_name = NULL_IF_CONFIG_SMALL("streaming segment muxer"),
1097 .priv_data_size = sizeof(SegmentContext),
1098 .flags = AVFMT_NOFILE,
1100 .write_header = seg_write_header,
1101 .write_packet = seg_write_packet,
1102 .write_trailer = seg_write_trailer,
1104 .check_bitstream = seg_check_bitstream,
1105 .priv_class = &sseg_class,