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}
27 #include "config_components.h"
35 #include "libavutil/avassert.h"
36 #include "libavutil/internal.h"
37 #include "libavutil/log.h"
38 #include "libavutil/opt.h"
39 #include "libavutil/avstring.h"
40 #include "libavutil/parseutils.h"
41 #include "libavutil/mathematics.h"
42 #include "libavutil/time.h"
43 #include "libavutil/timecode.h"
44 #include "libavutil/time_internal.h"
45 #include "libavutil/timestamp.h"
47 typedef struct SegmentListEntry {
49 double start_time, end_time;
53 struct SegmentListEntry *next;
54 int64_t last_duration;
58 LIST_TYPE_UNDEFINED = -1,
62 LIST_TYPE_EXT, ///< deprecated
67 #define SEGMENT_LIST_FLAG_CACHE 1
68 #define SEGMENT_LIST_FLAG_LIVE 2
70 typedef struct SegmentContext {
71 const AVClass *class; /**< Class for private options. */
72 int segment_idx; ///< index of the segment file to write, starting from 0
73 int segment_idx_wrap; ///< number after which the index wraps
74 int segment_idx_wrap_nb; ///< number of time the index has wraped
75 int segment_count; ///< number of segment files already written
76 const AVOutputFormat *oformat;
78 char *format; ///< format to use for output segment files
79 AVDictionary *format_options;
80 char *list; ///< filename for the segment list file
81 int list_flags; ///< flags affecting list generation
82 int list_size; ///< number of entries for the segment list file
84 int is_nullctx; ///< whether avf->pb is a nullctx
85 int use_clocktime; ///< flag to cut segments at regular clock time
86 int64_t clocktime_offset; //< clock offset for cutting the segments at regular clock time
87 int64_t clocktime_wrap_duration; //< wrapping duration considered for starting a new segment
88 int64_t last_val; ///< remember last time for wrap around detection
90 int header_written; ///< whether we've already called avformat_write_header
92 char *entry_prefix; ///< prefix to add to list entry filenames
93 int list_type; ///< set the list type
94 AVIOContext *list_pb; ///< list file put-byte context
95 int64_t time; ///< segment duration
96 int64_t min_seg_duration; ///< minimum segment duration
97 int use_strftime; ///< flag to expand filename with strftime
98 int increment_tc; ///< flag to increment timecode if found
100 char *times_str; ///< segment times specification string
101 int64_t *times; ///< list of segment interval specification
102 int nb_times; ///< number of elments in the times array
104 char *frames_str; ///< segment frame numbers specification string
105 int *frames; ///< list of frame number specification
106 int nb_frames; ///< number of elments in the frames array
107 int frame_count; ///< total number of reference frames
108 int segment_frame_count; ///< number of reference frames in the segment
111 int individual_header_trailer; /**< Set by a private option. */
112 int write_header_trailer; /**< Set by a private option. */
113 char *header_filename; ///< filename to write the output header to
115 int reset_timestamps; ///< reset timestamps at the beginning of each segment
116 int64_t initial_offset; ///< initial timestamps offset, expressed in microseconds
117 char *reference_stream_specifier; ///< reference stream specifier
118 int reference_stream_index;
119 int64_t reference_stream_first_pts; ///< initial timestamp, expressed in microseconds
120 int break_non_keyframes;
124 char temp_list_filename[1024];
126 SegmentListEntry cur_entry;
127 SegmentListEntry *segment_list_entries;
128 SegmentListEntry *segment_list_entries_end;
131 static void print_csv_escaped_str(AVIOContext *ctx, const char *str)
133 int needs_quoting = !!str[strcspn(str, "\",\n\r")];
138 for (; *str; str++) {
147 static int segment_mux_init(AVFormatContext *s)
149 SegmentContext *seg = s->priv_data;
154 ret = avformat_alloc_output_context2(&seg->avf, seg->oformat, NULL, NULL);
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 #if FF_API_AVFORMAT_IO_CLOSE
164 FF_DISABLE_DEPRECATION_WARNINGS
165 oc->io_close = s->io_close;
166 FF_ENABLE_DEPRECATION_WARNINGS
168 oc->io_close2 = s->io_close2;
169 oc->io_open = s->io_open;
170 oc->flags = s->flags;
172 for (i = 0; i < s->nb_streams; i++) {
173 AVStream *st, *ist = s->streams[i];
174 AVCodecParameters *ipar = ist->codecpar, *opar;
176 st = ff_stream_clone(oc, ist);
178 return AVERROR(ENOMEM);
180 if (!oc->oformat->codec_tag ||
181 av_codec_get_id (oc->oformat->codec_tag, ipar->codec_tag) == opar->codec_id ||
182 av_codec_get_tag(oc->oformat->codec_tag, ipar->codec_id) <= 0) {
183 opar->codec_tag = ipar->codec_tag;
192 static int set_segment_filename(AVFormatContext *s)
194 SegmentContext *seg = s->priv_data;
195 AVFormatContext *oc = seg->avf;
201 if (seg->segment_idx_wrap)
202 seg->segment_idx %= seg->segment_idx_wrap;
203 if (seg->use_strftime) {
205 struct tm *tm, tmpbuf;
207 tm = localtime_r(&now0, &tmpbuf);
208 if (!strftime(buf, sizeof(buf), s->url, tm)) {
209 av_log(oc, AV_LOG_ERROR, "Could not get segment filename with strftime\n");
210 return AVERROR(EINVAL);
212 } else if (av_get_frame_filename(buf, sizeof(buf),
213 s->url, seg->segment_idx) < 0) {
214 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", s->url);
215 return AVERROR(EINVAL);
217 new_name = av_strdup(buf);
219 return AVERROR(ENOMEM);
220 ff_format_set_url(oc, new_name);
222 /* copy modified name in list entry */
223 size = strlen(av_basename(oc->url)) + 1;
224 if (seg->entry_prefix)
225 size += strlen(seg->entry_prefix);
227 if ((ret = av_reallocp(&seg->cur_entry.filename, size)) < 0)
229 snprintf(seg->cur_entry.filename, size, "%s%s",
230 seg->entry_prefix ? seg->entry_prefix : "",
231 av_basename(oc->url));
236 static int segment_start(AVFormatContext *s, int write_header)
238 SegmentContext *seg = s->priv_data;
239 AVFormatContext *oc = seg->avf;
243 avformat_free_context(oc);
245 if ((err = segment_mux_init(s)) < 0)
251 if ((seg->segment_idx_wrap) && (seg->segment_idx % seg->segment_idx_wrap == 0))
252 seg->segment_idx_wrap_nb++;
254 if ((err = set_segment_filename(s)) < 0)
257 if ((err = s->io_open(s, &oc->pb, oc->url, AVIO_FLAG_WRITE, NULL)) < 0) {
258 av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->url);
261 if (!seg->individual_header_trailer)
262 oc->pb->seekable = 0;
264 if (oc->oformat->priv_class && oc->priv_data)
265 av_opt_set(oc->priv_data, "mpegts_flags", "+resend_headers", 0);
268 AVDictionary *options = NULL;
269 av_dict_copy(&options, seg->format_options, 0);
270 av_dict_set(&options, "fflags", "-autobsf", 0);
271 err = avformat_write_header(oc, &options);
272 av_dict_free(&options);
277 seg->segment_frame_count = 0;
281 static int segment_list_open(AVFormatContext *s)
283 SegmentContext *seg = s->priv_data;
286 snprintf(seg->temp_list_filename, sizeof(seg->temp_list_filename), seg->use_rename ? "%s.tmp" : "%s", seg->list);
287 ret = s->io_open(s, &seg->list_pb, seg->temp_list_filename, AVIO_FLAG_WRITE, NULL);
289 av_log(s, AV_LOG_ERROR, "Failed to open segment list '%s'\n", seg->list);
293 if (seg->list_type == LIST_TYPE_M3U8 && seg->segment_list_entries) {
294 SegmentListEntry *entry;
295 double max_duration = 0;
297 avio_printf(seg->list_pb, "#EXTM3U\n");
298 avio_printf(seg->list_pb, "#EXT-X-VERSION:3\n");
299 avio_printf(seg->list_pb, "#EXT-X-MEDIA-SEQUENCE:%d\n", seg->segment_list_entries->index);
300 avio_printf(seg->list_pb, "#EXT-X-ALLOW-CACHE:%s\n",
301 seg->list_flags & SEGMENT_LIST_FLAG_CACHE ? "YES" : "NO");
303 av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%d\n",
304 seg->segment_list_entries->index);
306 for (entry = seg->segment_list_entries; entry; entry = entry->next)
307 max_duration = FFMAX(max_duration, entry->end_time - entry->start_time);
308 avio_printf(seg->list_pb, "#EXT-X-TARGETDURATION:%"PRId64"\n", (int64_t)ceil(max_duration));
309 } else if (seg->list_type == LIST_TYPE_FFCONCAT) {
310 avio_printf(seg->list_pb, "ffconcat version 1.0\n");
316 static void segment_list_print_entry(AVIOContext *list_ioctx,
318 const SegmentListEntry *list_entry,
323 avio_printf(list_ioctx, "%s\n", list_entry->filename);
327 print_csv_escaped_str(list_ioctx, list_entry->filename);
328 avio_printf(list_ioctx, ",%f,%f\n", list_entry->start_time, list_entry->end_time);
331 avio_printf(list_ioctx, "#EXTINF:%f,\n%s\n",
332 list_entry->end_time - list_entry->start_time, list_entry->filename);
334 case LIST_TYPE_FFCONCAT:
337 if (av_escape(&buf, list_entry->filename, NULL, AV_ESCAPE_MODE_AUTO, AV_ESCAPE_FLAG_WHITESPACE) < 0) {
338 av_log(log_ctx, AV_LOG_WARNING,
339 "Error writing list entry '%s' in list file\n", list_entry->filename);
342 avio_printf(list_ioctx, "file %s\n", buf);
347 av_assert0(!"Invalid list type");
351 static int segment_end(AVFormatContext *s, int write_trailer, int is_last)
353 SegmentContext *seg = s->priv_data;
354 AVFormatContext *oc = seg->avf;
358 AVDictionaryEntry *tcr;
359 char buf[AV_TIMECODE_STR_SIZE];
364 return AVERROR(EINVAL);
366 av_write_frame(oc, NULL); /* Flush any buffered data (fragmented mp4) */
368 ret = av_write_trailer(oc);
371 av_log(s, AV_LOG_ERROR, "Failure occurred when ending segment '%s'\n",
375 if (seg->list_size || seg->list_type == LIST_TYPE_M3U8) {
376 SegmentListEntry *entry = av_mallocz(sizeof(*entry));
378 ret = AVERROR(ENOMEM);
382 /* append new element */
383 memcpy(entry, &seg->cur_entry, sizeof(*entry));
384 entry->filename = av_strdup(entry->filename);
385 if (!seg->segment_list_entries)
386 seg->segment_list_entries = seg->segment_list_entries_end = entry;
388 seg->segment_list_entries_end->next = entry;
389 seg->segment_list_entries_end = entry;
391 /* drop first item */
392 if (seg->list_size && seg->segment_count >= seg->list_size) {
393 entry = seg->segment_list_entries;
394 seg->segment_list_entries = seg->segment_list_entries->next;
395 av_freep(&entry->filename);
399 if ((ret = segment_list_open(s)) < 0)
401 for (entry = seg->segment_list_entries; entry; entry = entry->next)
402 segment_list_print_entry(seg->list_pb, seg->list_type, entry, s);
403 if (seg->list_type == LIST_TYPE_M3U8 && is_last)
404 avio_printf(seg->list_pb, "#EXT-X-ENDLIST\n");
405 ff_format_io_close(s, &seg->list_pb);
407 ff_rename(seg->temp_list_filename, seg->list, s);
409 segment_list_print_entry(seg->list_pb, seg->list_type, &seg->cur_entry, s);
410 avio_flush(seg->list_pb);
414 av_log(s, AV_LOG_VERBOSE, "segment:'%s' count:%d ended\n",
415 seg->avf->url, seg->segment_count);
416 seg->segment_count++;
418 if (seg->increment_tc) {
419 tcr = av_dict_get(s->metadata, "timecode", NULL, 0);
421 /* search the first video stream */
422 for (i = 0; i < s->nb_streams; i++) {
423 if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
424 rate = s->streams[i]->avg_frame_rate;/* Get fps from the video stream */
425 err = av_timecode_init_from_string(&tc, rate, tcr->value, s);
427 av_log(s, AV_LOG_WARNING, "Could not increment global timecode, error occurred during timecode creation.\n");
430 tc.start += (int)((seg->cur_entry.end_time - seg->cur_entry.start_time) * av_q2d(rate));/* increment timecode */
431 av_dict_set(&s->metadata, "timecode",
432 av_timecode_make_string(&tc, buf, 0), 0);
437 av_log(s, AV_LOG_WARNING, "Could not increment global timecode, no global timecode metadata found.\n");
439 for (i = 0; i < s->nb_streams; i++) {
440 if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
441 char st_buf[AV_TIMECODE_STR_SIZE];
443 AVRational st_rate = s->streams[i]->avg_frame_rate;
444 AVDictionaryEntry *st_tcr = av_dict_get(s->streams[i]->metadata, "timecode", NULL, 0);
446 if ((av_timecode_init_from_string(&st_tc, st_rate, st_tcr->value, s) < 0)) {
447 av_log(s, AV_LOG_WARNING, "Could not increment stream %d timecode, error occurred during timecode creation.\n", i);
450 st_tc.start += (int)((seg->cur_entry.end_time - seg->cur_entry.start_time) * av_q2d(st_rate)); // increment timecode
451 av_dict_set(&s->streams[i]->metadata, "timecode", av_timecode_make_string(&st_tc, st_buf, 0), 0);
458 ff_format_io_close(oc, &oc->pb);
463 static int parse_times(void *log_ctx, int64_t **times, int *nb_times,
464 const char *times_str)
468 char *times_str1 = av_strdup(times_str);
469 char *saveptr = NULL;
472 return AVERROR(ENOMEM);
474 #define FAIL(err) ret = err; goto end
477 for (p = times_str1; *p; p++)
481 *times = av_malloc_array(*nb_times, sizeof(**times));
483 av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced times array\n");
484 FAIL(AVERROR(ENOMEM));
488 for (i = 0; i < *nb_times; i++) {
490 char *tstr = av_strtok(p, ",", &saveptr);
493 if (!tstr || !tstr[0]) {
494 av_log(log_ctx, AV_LOG_ERROR, "Empty time specification in times list %s\n",
496 FAIL(AVERROR(EINVAL));
499 ret = av_parse_time(&t, tstr, 1);
501 av_log(log_ctx, AV_LOG_ERROR,
502 "Invalid time duration specification '%s' in times list %s\n", tstr, times_str);
503 FAIL(AVERROR(EINVAL));
507 /* check on monotonicity */
508 if (i && (*times)[i-1] > (*times)[i]) {
509 av_log(log_ctx, AV_LOG_ERROR,
510 "Specified time %f is smaller than the last time %f\n",
511 (float)((*times)[i])/1000000, (float)((*times)[i-1])/1000000);
512 FAIL(AVERROR(EINVAL));
521 static int parse_frames(void *log_ctx, int **frames, int *nb_frames,
522 const char *frames_str)
528 for (p = frames_str; *p; p++)
532 *frames = av_malloc_array(*nb_frames, sizeof(**frames));
534 av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced frames array\n");
535 return AVERROR(ENOMEM);
539 for (i = 0; i < *nb_frames; i++) {
543 if (*p == '\0' || *p == ',') {
544 av_log(log_ctx, AV_LOG_ERROR, "Empty frame specification in frame list %s\n",
546 return AVERROR(EINVAL);
548 f = strtol(p, &tailptr, 10);
549 if (*tailptr != '\0' && *tailptr != ',' || f <= 0 || f >= INT_MAX) {
550 av_log(log_ctx, AV_LOG_ERROR,
551 "Invalid argument '%s', must be a positive integer < INT_MAX\n",
553 return AVERROR(EINVAL);
560 /* check on monotonicity */
561 if (i && (*frames)[i-1] > (*frames)[i]) {
562 av_log(log_ctx, AV_LOG_ERROR,
563 "Specified frame %d is smaller than the last frame %d\n",
564 (*frames)[i], (*frames)[i-1]);
565 return AVERROR(EINVAL);
572 static int open_null_ctx(AVIOContext **ctx)
574 int buf_size = 32768;
575 uint8_t *buf = av_malloc(buf_size);
577 return AVERROR(ENOMEM);
578 *ctx = avio_alloc_context(buf, buf_size, 1, NULL, NULL, NULL, NULL);
581 return AVERROR(ENOMEM);
586 static void close_null_ctxp(AVIOContext **pb)
588 av_freep(&(*pb)->buffer);
589 avio_context_free(pb);
592 static int select_reference_stream(AVFormatContext *s)
594 SegmentContext *seg = s->priv_data;
597 seg->reference_stream_index = -1;
598 if (!strcmp(seg->reference_stream_specifier, "auto")) {
599 /* select first index of type with highest priority */
600 int type_index_map[AVMEDIA_TYPE_NB];
601 static const enum AVMediaType type_priority_list[] = {
604 AVMEDIA_TYPE_SUBTITLE,
606 AVMEDIA_TYPE_ATTACHMENT
608 enum AVMediaType type;
610 for (i = 0; i < AVMEDIA_TYPE_NB; i++)
611 type_index_map[i] = -1;
613 /* select first index for each type */
614 for (i = 0; i < s->nb_streams; i++) {
615 type = s->streams[i]->codecpar->codec_type;
616 if ((unsigned)type < AVMEDIA_TYPE_NB && type_index_map[type] == -1
617 /* ignore attached pictures/cover art streams */
618 && !(s->streams[i]->disposition & AV_DISPOSITION_ATTACHED_PIC))
619 type_index_map[type] = i;
622 for (i = 0; i < FF_ARRAY_ELEMS(type_priority_list); i++) {
623 type = type_priority_list[i];
624 if ((seg->reference_stream_index = type_index_map[type]) >= 0)
628 for (i = 0; i < s->nb_streams; i++) {
629 ret = avformat_match_stream_specifier(s, s->streams[i],
630 seg->reference_stream_specifier);
634 seg->reference_stream_index = i;
640 if (seg->reference_stream_index < 0) {
641 av_log(s, AV_LOG_ERROR, "Could not select stream matching identifier '%s'\n",
642 seg->reference_stream_specifier);
643 return AVERROR(EINVAL);
649 static void seg_free(AVFormatContext *s)
651 SegmentContext *seg = s->priv_data;
652 SegmentListEntry *cur;
654 ff_format_io_close(s, &seg->list_pb);
657 close_null_ctxp(&seg->avf->pb);
659 ff_format_io_close(s, &seg->avf->pb);
660 avformat_free_context(seg->avf);
663 av_freep(&seg->times);
664 av_freep(&seg->frames);
665 av_freep(&seg->cur_entry.filename);
667 cur = seg->segment_list_entries;
669 SegmentListEntry *next = cur->next;
670 av_freep(&cur->filename);
676 static int seg_init(AVFormatContext *s)
678 SegmentContext *seg = s->priv_data;
679 AVFormatContext *oc = seg->avf;
680 AVDictionary *options = NULL;
684 seg->segment_count = 0;
685 if (!seg->write_header_trailer)
686 seg->individual_header_trailer = 0;
688 if (seg->header_filename) {
689 seg->write_header_trailer = 1;
690 seg->individual_header_trailer = 0;
693 if (seg->initial_offset > 0) {
694 av_log(s, AV_LOG_WARNING, "NOTE: the option initial_offset is deprecated,"
695 "you can use output_ts_offset instead of it\n");
698 if ((seg->time != 2000000) + !!seg->times_str + !!seg->frames_str > 1) {
699 av_log(s, AV_LOG_ERROR,
700 "segment_time, segment_times, and segment_frames options "
701 "are mutually exclusive, select just one of them\n");
702 return AVERROR(EINVAL);
705 if (seg->times_str || seg->frames_str)
706 seg->min_seg_duration = 0;
708 if (seg->times_str) {
709 if ((ret = parse_times(s, &seg->times, &seg->nb_times, seg->times_str)) < 0)
711 } else if (seg->frames_str) {
712 if ((ret = parse_frames(s, &seg->frames, &seg->nb_frames, seg->frames_str)) < 0)
715 if (seg->use_clocktime) {
716 if (seg->time <= 0) {
717 av_log(s, AV_LOG_ERROR, "Invalid negative segment_time with segment_atclocktime option set\n");
718 return AVERROR(EINVAL);
720 seg->clocktime_offset = seg->time - (seg->clocktime_offset % seg->time);
722 if (seg->min_seg_duration > seg->time) {
723 av_log(s, AV_LOG_ERROR, "min_seg_duration cannot be greater than segment_time\n");
724 return AVERROR(EINVAL);
729 if (seg->list_type == LIST_TYPE_UNDEFINED) {
730 if (av_match_ext(seg->list, "csv" )) seg->list_type = LIST_TYPE_CSV;
731 else if (av_match_ext(seg->list, "ext" )) seg->list_type = LIST_TYPE_EXT;
732 else if (av_match_ext(seg->list, "m3u8")) seg->list_type = LIST_TYPE_M3U8;
733 else if (av_match_ext(seg->list, "ffcat,ffconcat")) seg->list_type = LIST_TYPE_FFCONCAT;
734 else seg->list_type = LIST_TYPE_FLAT;
736 if (!seg->list_size && seg->list_type != LIST_TYPE_M3U8) {
737 if ((ret = segment_list_open(s)) < 0)
740 const char *proto = avio_find_protocol_name(seg->list);
741 seg->use_rename = proto && !strcmp(proto, "file");
745 if (seg->list_type == LIST_TYPE_EXT)
746 av_log(s, AV_LOG_WARNING, "'ext' list type option is deprecated in favor of 'csv'\n");
748 if ((ret = select_reference_stream(s)) < 0)
750 av_log(s, AV_LOG_VERBOSE, "Selected stream id:%d type:%s\n",
751 seg->reference_stream_index,
752 av_get_media_type_string(s->streams[seg->reference_stream_index]->codecpar->codec_type));
754 seg->reference_stream_first_pts = AV_NOPTS_VALUE;
756 seg->oformat = av_guess_format(seg->format, s->url, NULL);
759 return AVERROR_MUXER_NOT_FOUND;
760 if (seg->oformat->flags & AVFMT_NOFILE) {
761 av_log(s, AV_LOG_ERROR, "format %s not supported.\n",
763 return AVERROR(EINVAL);
766 if ((ret = segment_mux_init(s)) < 0)
769 if ((ret = set_segment_filename(s)) < 0)
773 if (seg->write_header_trailer) {
774 if ((ret = s->io_open(s, &oc->pb,
775 seg->header_filename ? seg->header_filename : oc->url,
776 AVIO_FLAG_WRITE, NULL)) < 0) {
777 av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->url);
780 if (!seg->individual_header_trailer)
781 oc->pb->seekable = 0;
783 if ((ret = open_null_ctx(&oc->pb)) < 0)
788 av_dict_copy(&options, seg->format_options, 0);
789 av_dict_set(&options, "fflags", "-autobsf", 0);
790 ret = avformat_init_output(oc, &options);
791 if (av_dict_count(options)) {
792 av_log(s, AV_LOG_ERROR,
793 "Some of the provided format options are not recognized\n");
794 av_dict_free(&options);
795 return AVERROR(EINVAL);
797 av_dict_free(&options);
802 seg->segment_frame_count = 0;
804 av_assert0(s->nb_streams == oc->nb_streams);
805 if (ret == AVSTREAM_INIT_IN_WRITE_HEADER) {
806 ret = avformat_write_header(oc, NULL);
809 seg->header_written = 1;
812 for (i = 0; i < s->nb_streams; i++) {
813 AVStream *inner_st = oc->streams[i];
814 AVStream *outer_st = s->streams[i];
815 avpriv_set_pts_info(outer_st, inner_st->pts_wrap_bits, inner_st->time_base.num, inner_st->time_base.den);
818 if (oc->avoid_negative_ts > 0 && s->avoid_negative_ts < 0)
819 s->avoid_negative_ts = 1;
824 static int seg_write_header(AVFormatContext *s)
826 SegmentContext *seg = s->priv_data;
827 AVFormatContext *oc = seg->avf;
830 if (!seg->header_written) {
831 ret = avformat_write_header(oc, NULL);
836 if (!seg->write_header_trailer || seg->header_filename) {
837 if (seg->header_filename) {
838 av_write_frame(oc, NULL);
839 ff_format_io_close(oc, &oc->pb);
841 close_null_ctxp(&oc->pb);
844 if ((ret = oc->io_open(oc, &oc->pb, oc->url, AVIO_FLAG_WRITE, NULL)) < 0)
846 if (!seg->individual_header_trailer)
847 oc->pb->seekable = 0;
853 static int seg_write_packet(AVFormatContext *s, AVPacket *pkt)
855 SegmentContext *seg = s->priv_data;
856 AVStream *st = s->streams[pkt->stream_index];
857 int64_t end_pts = INT64_MAX, offset, pkt_pts_avtb;
858 int start_frame = INT_MAX;
864 if (!seg->avf || !seg->avf->pb)
865 return AVERROR(EINVAL);
867 if (!st->codecpar->extradata_size) {
868 size_t pkt_extradata_size;
869 uint8_t *pkt_extradata = av_packet_get_side_data(pkt, AV_PKT_DATA_NEW_EXTRADATA, &pkt_extradata_size);
870 if (pkt_extradata && pkt_extradata_size > 0) {
871 ret = ff_alloc_extradata(st->codecpar, pkt_extradata_size);
873 av_log(s, AV_LOG_WARNING, "Unable to add extradata to stream. Output segments may be invalid.\n");
876 memcpy(st->codecpar->extradata, pkt_extradata, pkt_extradata_size);
882 end_pts = seg->segment_count < seg->nb_times ?
883 seg->times[seg->segment_count] : INT64_MAX;
884 } else if (seg->frames) {
885 start_frame = seg->segment_count < seg->nb_frames ?
886 seg->frames[seg->segment_count] : INT_MAX;
888 if (seg->use_clocktime) {
889 int64_t avgt = av_gettime();
890 time_t sec = avgt / 1000000;
891 localtime_r(&sec, &ti);
892 usecs = (int64_t)(ti.tm_hour * 3600 + ti.tm_min * 60 + ti.tm_sec) * 1000000 + (avgt % 1000000);
893 wrapped_val = (usecs + seg->clocktime_offset) % seg->time;
894 if (wrapped_val < seg->last_val && wrapped_val < seg->clocktime_wrap_duration)
895 seg->cut_pending = 1;
896 seg->last_val = wrapped_val;
898 end_pts = seg->time * (seg->segment_count + 1);
902 ff_dlog(s, "packet stream:%d pts:%s pts_time:%s duration_time:%s is_key:%d frame:%d\n",
903 pkt->stream_index, av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
904 av_ts2timestr(pkt->duration, &st->time_base),
905 pkt->flags & AV_PKT_FLAG_KEY,
906 pkt->stream_index == seg->reference_stream_index ? seg->frame_count : -1);
908 if (seg->reference_stream_first_pts == AV_NOPTS_VALUE &&
909 pkt->stream_index == seg->reference_stream_index &&
910 pkt->pts != AV_NOPTS_VALUE) {
911 seg->reference_stream_first_pts = av_rescale_q(pkt->pts, st->time_base, AV_TIME_BASE_Q);
914 if (seg->reference_stream_first_pts != AV_NOPTS_VALUE) {
915 end_pts += (INT64_MAX - end_pts >= seg->reference_stream_first_pts) ?
916 seg->reference_stream_first_pts :
920 if (pkt->pts != AV_NOPTS_VALUE)
921 pkt_pts_avtb = av_rescale_q(pkt->pts, st->time_base, AV_TIME_BASE_Q);
923 if (pkt->stream_index == seg->reference_stream_index &&
924 (pkt->flags & AV_PKT_FLAG_KEY || seg->break_non_keyframes) &&
925 (seg->segment_frame_count > 0 || seg->write_empty) &&
926 (seg->cut_pending || seg->frame_count >= start_frame ||
927 (pkt->pts != AV_NOPTS_VALUE &&
928 pkt_pts_avtb - seg->cur_entry.start_pts >= seg->min_seg_duration &&
929 av_compare_ts(pkt->pts, st->time_base,
930 end_pts - seg->time_delta, AV_TIME_BASE_Q) >= 0))) {
931 /* sanitize end time in case last packet didn't have a defined duration */
932 if (seg->cur_entry.last_duration == 0)
933 seg->cur_entry.end_time = (double)pkt->pts * av_q2d(st->time_base);
935 if ((ret = segment_end(s, seg->individual_header_trailer, 0)) < 0)
938 if ((ret = segment_start(s, seg->individual_header_trailer)) < 0)
941 seg->cut_pending = 0;
942 seg->cur_entry.index = seg->segment_idx + seg->segment_idx_wrap * seg->segment_idx_wrap_nb;
943 seg->cur_entry.start_time = (double)pkt->pts * av_q2d(st->time_base);
944 seg->cur_entry.start_pts = av_rescale_q(pkt->pts, st->time_base, AV_TIME_BASE_Q);
945 seg->cur_entry.end_time = seg->cur_entry.start_time;
947 if (seg->times || (!seg->frames && !seg->use_clocktime) && seg->write_empty)
951 if (pkt->stream_index == seg->reference_stream_index) {
952 if (pkt->pts != AV_NOPTS_VALUE)
953 seg->cur_entry.end_time =
954 FFMAX(seg->cur_entry.end_time, (double)(pkt->pts + pkt->duration) * av_q2d(st->time_base));
955 seg->cur_entry.last_duration = pkt->duration;
958 if (seg->segment_frame_count == 0) {
959 av_log(s, AV_LOG_VERBOSE, "segment:'%s' starts with packet stream:%d pts:%s pts_time:%s frame:%d\n",
960 seg->avf->url, pkt->stream_index,
961 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base), seg->frame_count);
964 av_log(s, AV_LOG_DEBUG, "stream:%d start_pts_time:%s pts:%s pts_time:%s dts:%s dts_time:%s",
966 av_ts2timestr(seg->cur_entry.start_pts, &AV_TIME_BASE_Q),
967 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
968 av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
970 /* compute new timestamps */
971 offset = av_rescale_q(seg->initial_offset - (seg->reset_timestamps ? seg->cur_entry.start_pts : 0),
972 AV_TIME_BASE_Q, st->time_base);
973 if (pkt->pts != AV_NOPTS_VALUE)
975 if (pkt->dts != AV_NOPTS_VALUE)
978 av_log(s, AV_LOG_DEBUG, " -> pts:%s pts_time:%s dts:%s dts_time:%s\n",
979 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
980 av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
982 ret = ff_write_chained(seg->avf, pkt->stream_index, pkt, s,
983 seg->initial_offset || seg->reset_timestamps ||
984 ffofmt(seg->avf->oformat)->interleave_packet);
987 /* Use st->index here as the packet returned from ff_write_chained()
988 * is blank if interleaving has been used. */
989 if (st->index == seg->reference_stream_index) {
991 seg->segment_frame_count++;
997 static int seg_write_trailer(struct AVFormatContext *s)
999 SegmentContext *seg = s->priv_data;
1000 AVFormatContext *oc = seg->avf;
1006 if (!seg->write_header_trailer) {
1007 if ((ret = segment_end(s, 0, 1)) < 0)
1009 if ((ret = open_null_ctx(&oc->pb)) < 0)
1011 seg->is_nullctx = 1;
1012 ret = av_write_trailer(oc);
1014 ret = segment_end(s, 1, 1);
1019 static int seg_check_bitstream(AVFormatContext *s, AVStream *st,
1020 const AVPacket *pkt)
1022 SegmentContext *seg = s->priv_data;
1023 AVFormatContext *oc = seg->avf;
1024 if (ffofmt(oc->oformat)->check_bitstream) {
1025 AVStream *const ost = oc->streams[st->index];
1026 int ret = ffofmt(oc->oformat)->check_bitstream(oc, ost, pkt);
1028 FFStream *const sti = ffstream(st);
1029 FFStream *const osti = ffstream(ost);
1030 sti->bsfc = osti->bsfc;
1038 #define OFFSET(x) offsetof(SegmentContext, x)
1039 #define E AV_OPT_FLAG_ENCODING_PARAM
1040 static const AVOption options[] = {
1041 { "reference_stream", "set reference stream", OFFSET(reference_stream_specifier), AV_OPT_TYPE_STRING, {.str = "auto"}, 0, 0, E },
1042 { "segment_format", "set container format used for the segments", OFFSET(format), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1043 { "segment_format_options", "set list of options for the container format used for the segments", OFFSET(format_options), AV_OPT_TYPE_DICT, {.str = NULL}, 0, 0, E },
1044 { "segment_list", "set the segment list filename", OFFSET(list), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1045 { "segment_header_filename", "write a single file containing the header", OFFSET(header_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1047 { "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"},
1048 { "cache", "allow list caching", 0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_LIST_FLAG_CACHE }, INT_MIN, INT_MAX, E, "list_flags"},
1049 { "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"},
1051 { "segment_list_size", "set the maximum number of playlist entries", OFFSET(list_size), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1053 { "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" },
1054 { "flat", "flat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FLAT }, INT_MIN, INT_MAX, E, "list_type" },
1055 { "csv", "csv format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_CSV }, INT_MIN, INT_MAX, E, "list_type" },
1056 { "ext", "extended format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_EXT }, INT_MIN, INT_MAX, E, "list_type" },
1057 { "ffconcat", "ffconcat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FFCONCAT }, INT_MIN, INT_MAX, E, "list_type" },
1058 { "m3u8", "M3U8 format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
1059 { "hls", "Apple HTTP Live Streaming compatible", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
1061 { "segment_atclocktime", "set segment to be cut at clocktime", OFFSET(use_clocktime), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E},
1062 { "segment_clocktime_offset", "set segment clocktime offset", OFFSET(clocktime_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, 86400000000LL, E},
1063 { "segment_clocktime_wrap_duration", "set segment clocktime wrapping duration", OFFSET(clocktime_wrap_duration), AV_OPT_TYPE_DURATION, {.i64 = INT64_MAX}, 0, INT64_MAX, E},
1064 { "segment_time", "set segment duration", OFFSET(time),AV_OPT_TYPE_DURATION, {.i64 = 2000000}, INT64_MIN, INT64_MAX, E },
1065 { "segment_time_delta","set approximation value used for the segment times", OFFSET(time_delta), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, INT64_MAX, E },
1066 { "min_seg_duration", "set minimum segment duration", OFFSET(min_seg_duration), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, INT64_MAX, E },
1067 { "segment_times", "set segment split time points", OFFSET(times_str),AV_OPT_TYPE_STRING,{.str = NULL}, 0, 0, E },
1068 { "segment_frames", "set segment split frame numbers", OFFSET(frames_str),AV_OPT_TYPE_STRING,{.str = NULL}, 0, 0, E },
1069 { "segment_wrap", "set number after which the index wraps", OFFSET(segment_idx_wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1070 { "segment_list_entry_prefix", "set base url prefix for segments", OFFSET(entry_prefix), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1071 { "segment_start_number", "set the sequence number of the first segment", OFFSET(segment_idx), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1072 { "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 },
1073 { "strftime", "set filename expansion with strftime at segment creation", OFFSET(use_strftime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1074 { "increment_tc", "increment timecode between each segment", OFFSET(increment_tc), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1075 { "break_non_keyframes", "allow breaking segments on non-keyframes", OFFSET(break_non_keyframes), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1077 { "individual_header_trailer", "write header/trailer to each segment", OFFSET(individual_header_trailer), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, E },
1078 { "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 },
1079 { "reset_timestamps", "reset timestamps at the beginning of each segment", OFFSET(reset_timestamps), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1080 { "initial_offset", "set initial timestamp offset", OFFSET(initial_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, -INT64_MAX, INT64_MAX, E },
1081 { "write_empty_segments", "allow writing empty 'filler' segments", OFFSET(write_empty), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1085 static const AVClass seg_class = {
1086 .class_name = "(stream) segment muxer",
1087 .item_name = av_default_item_name,
1089 .version = LIBAVUTIL_VERSION_INT,
1092 #if CONFIG_SEGMENT_MUXER
1093 const FFOutputFormat ff_segment_muxer = {
1094 .p.name = "segment",
1095 .p.long_name = NULL_IF_CONFIG_SMALL("segment"),
1096 .p.flags = AVFMT_NOFILE|AVFMT_GLOBALHEADER,
1097 .p.priv_class = &seg_class,
1098 .priv_data_size = sizeof(SegmentContext),
1100 .write_header = seg_write_header,
1101 .write_packet = seg_write_packet,
1102 .write_trailer = seg_write_trailer,
1104 .check_bitstream = seg_check_bitstream,
1108 #if CONFIG_STREAM_SEGMENT_MUXER
1109 const FFOutputFormat ff_stream_segment_muxer = {
1110 .p.name = "stream_segment,ssegment",
1111 .p.long_name = NULL_IF_CONFIG_SMALL("streaming segment muxer"),
1112 .p.flags = AVFMT_NOFILE,
1113 .p.priv_class = &seg_class,
1114 .priv_data_size = sizeof(SegmentContext),
1116 .write_header = seg_write_header,
1117 .write_packet = seg_write_packet,
1118 .write_trailer = seg_write_trailer,
1120 .check_bitstream = seg_check_bitstream,