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
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
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
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
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
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;
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 oc->io_close = s->io_close;
164 oc->io_open = s->io_open;
166 for (i = 0; i < s->nb_streams; i++) {
168 AVCodecParameters *ipar, *opar;
170 if (!(st = avformat_new_stream(oc, NULL)))
171 return AVERROR(ENOMEM);
172 ipar = s->streams[i]->codecpar;
174 avcodec_parameters_copy(opar, ipar);
175 if (!oc->oformat->codec_tag ||
176 av_codec_get_id (oc->oformat->codec_tag, ipar->codec_tag) == opar->codec_id ||
177 av_codec_get_tag(oc->oformat->codec_tag, ipar->codec_id) <= 0) {
178 opar->codec_tag = ipar->codec_tag;
182 st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
183 st->time_base = s->streams[i]->time_base;
184 av_dict_copy(&st->metadata, s->streams[i]->metadata, 0);
190 static int set_segment_filename(AVFormatContext *s)
192 SegmentContext *seg = s->priv_data;
193 AVFormatContext *oc = seg->avf;
197 if (seg->segment_idx_wrap)
198 seg->segment_idx %= seg->segment_idx_wrap;
199 if (seg->use_strftime) {
201 struct tm *tm, tmpbuf;
203 tm = localtime_r(&now0, &tmpbuf);
204 if (!strftime(oc->filename, sizeof(oc->filename), s->filename, tm)) {
205 av_log(oc, AV_LOG_ERROR, "Could not get segment filename with strftime\n");
206 return AVERROR(EINVAL);
208 } else if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
209 s->filename, seg->segment_idx) < 0) {
210 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", s->filename);
211 return AVERROR(EINVAL);
214 /* copy modified name in list entry */
215 size = strlen(av_basename(oc->filename)) + 1;
216 if (seg->entry_prefix)
217 size += strlen(seg->entry_prefix);
219 if ((ret = av_reallocp(&seg->cur_entry.filename, size)) < 0)
221 snprintf(seg->cur_entry.filename, size, "%s%s",
222 seg->entry_prefix ? seg->entry_prefix : "",
223 av_basename(oc->filename));
228 static int segment_start(AVFormatContext *s, int write_header)
230 SegmentContext *seg = s->priv_data;
231 AVFormatContext *oc = seg->avf;
235 avformat_free_context(oc);
237 if ((err = segment_mux_init(s)) < 0)
243 if ((seg->segment_idx_wrap) && (seg->segment_idx % seg->segment_idx_wrap == 0))
244 seg->segment_idx_wrap_nb++;
246 if ((err = set_segment_filename(s)) < 0)
249 if ((err = s->io_open(s, &oc->pb, oc->filename, AVIO_FLAG_WRITE, NULL)) < 0) {
250 av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->filename);
253 if (!seg->individual_header_trailer)
254 oc->pb->seekable = 0;
256 if (oc->oformat->priv_class && oc->priv_data)
257 av_opt_set(oc->priv_data, "mpegts_flags", "+resend_headers", 0);
260 AVDictionary *options = NULL;
261 av_dict_copy(&options, seg->format_options, 0);
262 err = avformat_write_header(oc, &options);
263 av_dict_free(&options);
268 seg->segment_frame_count = 0;
272 static int segment_list_open(AVFormatContext *s)
274 SegmentContext *seg = s->priv_data;
277 snprintf(seg->temp_list_filename, sizeof(seg->temp_list_filename), seg->use_rename ? "%s.tmp" : "%s", seg->list);
278 ret = s->io_open(s, &seg->list_pb, seg->temp_list_filename, AVIO_FLAG_WRITE, NULL);
280 av_log(s, AV_LOG_ERROR, "Failed to open segment list '%s'\n", seg->list);
284 if (seg->list_type == LIST_TYPE_M3U8 && seg->segment_list_entries) {
285 SegmentListEntry *entry;
286 double max_duration = 0;
288 avio_printf(seg->list_pb, "#EXTM3U\n");
289 avio_printf(seg->list_pb, "#EXT-X-VERSION:3\n");
290 avio_printf(seg->list_pb, "#EXT-X-MEDIA-SEQUENCE:%d\n", seg->segment_list_entries->index);
291 avio_printf(seg->list_pb, "#EXT-X-ALLOW-CACHE:%s\n",
292 seg->list_flags & SEGMENT_LIST_FLAG_CACHE ? "YES" : "NO");
294 av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%d\n",
295 seg->segment_list_entries->index);
297 for (entry = seg->segment_list_entries; entry; entry = entry->next)
298 max_duration = FFMAX(max_duration, entry->end_time - entry->start_time);
299 avio_printf(seg->list_pb, "#EXT-X-TARGETDURATION:%"PRId64"\n", (int64_t)ceil(max_duration));
300 } else if (seg->list_type == LIST_TYPE_FFCONCAT) {
301 avio_printf(seg->list_pb, "ffconcat version 1.0\n");
307 static void segment_list_print_entry(AVIOContext *list_ioctx,
309 const SegmentListEntry *list_entry,
314 avio_printf(list_ioctx, "%s\n", list_entry->filename);
318 print_csv_escaped_str(list_ioctx, list_entry->filename);
319 avio_printf(list_ioctx, ",%f,%f\n", list_entry->start_time, list_entry->end_time);
322 avio_printf(list_ioctx, "#EXTINF:%f,\n%s\n",
323 list_entry->end_time - list_entry->start_time, list_entry->filename);
325 case LIST_TYPE_FFCONCAT:
328 if (av_escape(&buf, list_entry->filename, NULL, AV_ESCAPE_MODE_AUTO, AV_ESCAPE_FLAG_WHITESPACE) < 0) {
329 av_log(log_ctx, AV_LOG_WARNING,
330 "Error writing list entry '%s' in list file\n", list_entry->filename);
333 avio_printf(list_ioctx, "file %s\n", buf);
338 av_assert0(!"Invalid list type");
342 static int segment_end(AVFormatContext *s, int write_trailer, int is_last)
344 SegmentContext *seg = s->priv_data;
345 AVFormatContext *oc = seg->avf;
349 AVDictionaryEntry *tcr;
350 char buf[AV_TIMECODE_STR_SIZE];
354 av_write_frame(oc, NULL); /* Flush any buffered data (fragmented mp4) */
356 ret = av_write_trailer(oc);
359 av_log(s, AV_LOG_ERROR, "Failure occurred when ending segment '%s'\n",
363 if (seg->list_size || seg->list_type == LIST_TYPE_M3U8) {
364 SegmentListEntry *entry = av_mallocz(sizeof(*entry));
366 ret = AVERROR(ENOMEM);
370 /* append new element */
371 memcpy(entry, &seg->cur_entry, sizeof(*entry));
372 entry->filename = av_strdup(entry->filename);
373 if (!seg->segment_list_entries)
374 seg->segment_list_entries = seg->segment_list_entries_end = entry;
376 seg->segment_list_entries_end->next = entry;
377 seg->segment_list_entries_end = entry;
379 /* drop first item */
380 if (seg->list_size && seg->segment_count >= seg->list_size) {
381 entry = seg->segment_list_entries;
382 seg->segment_list_entries = seg->segment_list_entries->next;
383 av_freep(&entry->filename);
387 if ((ret = segment_list_open(s)) < 0)
389 for (entry = seg->segment_list_entries; entry; entry = entry->next)
390 segment_list_print_entry(seg->list_pb, seg->list_type, entry, s);
391 if (seg->list_type == LIST_TYPE_M3U8 && is_last)
392 avio_printf(seg->list_pb, "#EXT-X-ENDLIST\n");
393 ff_format_io_close(s, &seg->list_pb);
395 ff_rename(seg->temp_list_filename, seg->list, s);
397 segment_list_print_entry(seg->list_pb, seg->list_type, &seg->cur_entry, s);
398 avio_flush(seg->list_pb);
402 av_log(s, AV_LOG_VERBOSE, "segment:'%s' count:%d ended\n",
403 seg->avf->filename, seg->segment_count);
404 seg->segment_count++;
406 if (seg->increment_tc) {
407 tcr = av_dict_get(s->metadata, "timecode", NULL, 0);
409 /* search the first video stream */
410 for (i = 0; i < s->nb_streams; i++) {
411 if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
412 rate = s->streams[i]->avg_frame_rate;/* Get fps from the video stream */
413 err = av_timecode_init_from_string(&tc, rate, tcr->value, s);
415 av_log(s, AV_LOG_WARNING, "Could not increment timecode, error occurred during timecode creation.");
418 tc.start += (int)((seg->cur_entry.end_time - seg->cur_entry.start_time) * av_q2d(rate));/* increment timecode */
419 av_dict_set(&s->metadata, "timecode",
420 av_timecode_make_string(&tc, buf, 0), 0);
425 av_log(s, AV_LOG_WARNING, "Could not increment timecode, no timecode metadata found");
430 ff_format_io_close(oc, &oc->pb);
435 static int parse_times(void *log_ctx, int64_t **times, int *nb_times,
436 const char *times_str)
440 char *times_str1 = av_strdup(times_str);
441 char *saveptr = NULL;
444 return AVERROR(ENOMEM);
446 #define FAIL(err) ret = err; goto end
449 for (p = times_str1; *p; p++)
453 *times = av_malloc_array(*nb_times, sizeof(**times));
455 av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced times array\n");
456 FAIL(AVERROR(ENOMEM));
460 for (i = 0; i < *nb_times; i++) {
462 char *tstr = av_strtok(p, ",", &saveptr);
465 if (!tstr || !tstr[0]) {
466 av_log(log_ctx, AV_LOG_ERROR, "Empty time specification in times list %s\n",
468 FAIL(AVERROR(EINVAL));
471 ret = av_parse_time(&t, tstr, 1);
473 av_log(log_ctx, AV_LOG_ERROR,
474 "Invalid time duration specification '%s' in times list %s\n", tstr, times_str);
475 FAIL(AVERROR(EINVAL));
479 /* check on monotonicity */
480 if (i && (*times)[i-1] > (*times)[i]) {
481 av_log(log_ctx, AV_LOG_ERROR,
482 "Specified time %f is greater than the following time %f\n",
483 (float)((*times)[i])/1000000, (float)((*times)[i-1])/1000000);
484 FAIL(AVERROR(EINVAL));
493 static int parse_frames(void *log_ctx, int **frames, int *nb_frames,
494 const char *frames_str)
498 char *frames_str1 = av_strdup(frames_str);
499 char *saveptr = NULL;
502 return AVERROR(ENOMEM);
504 #define FAIL(err) ret = err; goto end
507 for (p = frames_str1; *p; p++)
511 *frames = av_malloc_array(*nb_frames, sizeof(**frames));
513 av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced frames array\n");
514 FAIL(AVERROR(ENOMEM));
518 for (i = 0; i < *nb_frames; i++) {
521 char *fstr = av_strtok(p, ",", &saveptr);
525 av_log(log_ctx, AV_LOG_ERROR, "Empty frame specification in frame list %s\n",
527 FAIL(AVERROR(EINVAL));
529 f = strtol(fstr, &tailptr, 10);
530 if (*tailptr || f <= 0 || f >= INT_MAX) {
531 av_log(log_ctx, AV_LOG_ERROR,
532 "Invalid argument '%s', must be a positive integer <= INT64_MAX\n",
534 FAIL(AVERROR(EINVAL));
538 /* check on monotonicity */
539 if (i && (*frames)[i-1] > (*frames)[i]) {
540 av_log(log_ctx, AV_LOG_ERROR,
541 "Specified frame %d is greater than the following frame %d\n",
542 (*frames)[i], (*frames)[i-1]);
543 FAIL(AVERROR(EINVAL));
548 av_free(frames_str1);
552 static int open_null_ctx(AVIOContext **ctx)
554 int buf_size = 32768;
555 uint8_t *buf = av_malloc(buf_size);
557 return AVERROR(ENOMEM);
558 *ctx = avio_alloc_context(buf, buf_size, AVIO_FLAG_WRITE, NULL, NULL, NULL, NULL);
561 return AVERROR(ENOMEM);
566 static void close_null_ctxp(AVIOContext **pb)
568 av_freep(&(*pb)->buffer);
572 static int select_reference_stream(AVFormatContext *s)
574 SegmentContext *seg = s->priv_data;
577 seg->reference_stream_index = -1;
578 if (!strcmp(seg->reference_stream_specifier, "auto")) {
579 /* select first index of type with highest priority */
580 int type_index_map[AVMEDIA_TYPE_NB];
581 static const enum AVMediaType type_priority_list[] = {
584 AVMEDIA_TYPE_SUBTITLE,
586 AVMEDIA_TYPE_ATTACHMENT
588 enum AVMediaType type;
590 for (i = 0; i < AVMEDIA_TYPE_NB; i++)
591 type_index_map[i] = -1;
593 /* select first index for each type */
594 for (i = 0; i < s->nb_streams; i++) {
595 type = s->streams[i]->codecpar->codec_type;
596 if ((unsigned)type < AVMEDIA_TYPE_NB && type_index_map[type] == -1
597 /* ignore attached pictures/cover art streams */
598 && !(s->streams[i]->disposition & AV_DISPOSITION_ATTACHED_PIC))
599 type_index_map[type] = i;
602 for (i = 0; i < FF_ARRAY_ELEMS(type_priority_list); i++) {
603 type = type_priority_list[i];
604 if ((seg->reference_stream_index = type_index_map[type]) >= 0)
608 for (i = 0; i < s->nb_streams; i++) {
609 ret = avformat_match_stream_specifier(s, s->streams[i],
610 seg->reference_stream_specifier);
614 seg->reference_stream_index = i;
620 if (seg->reference_stream_index < 0) {
621 av_log(s, AV_LOG_ERROR, "Could not select stream matching identifier '%s'\n",
622 seg->reference_stream_specifier);
623 return AVERROR(EINVAL);
629 static void seg_free_context(SegmentContext *seg)
631 ff_format_io_close(seg->avf, &seg->list_pb);
632 avformat_free_context(seg->avf);
636 static int seg_init(AVFormatContext *s)
638 SegmentContext *seg = s->priv_data;
639 AVFormatContext *oc = seg->avf;
640 AVDictionary *options = NULL;
644 seg->segment_count = 0;
645 if (!seg->write_header_trailer)
646 seg->individual_header_trailer = 0;
648 if (seg->header_filename) {
649 seg->write_header_trailer = 1;
650 seg->individual_header_trailer = 0;
653 if (!!seg->time_str + !!seg->times_str + !!seg->frames_str > 1) {
654 av_log(s, AV_LOG_ERROR,
655 "segment_time, segment_times, and segment_frames options "
656 "are mutually exclusive, select just one of them\n");
657 return AVERROR(EINVAL);
660 if (seg->times_str) {
661 if ((ret = parse_times(s, &seg->times, &seg->nb_times, seg->times_str)) < 0)
663 } else if (seg->frames_str) {
664 if ((ret = parse_frames(s, &seg->frames, &seg->nb_frames, seg->frames_str)) < 0)
667 /* set default value if not specified */
669 seg->time_str = av_strdup("2");
670 if ((ret = av_parse_time(&seg->time, seg->time_str, 1)) < 0) {
671 av_log(s, AV_LOG_ERROR,
672 "Invalid time duration specification '%s' for segment_time option\n",
676 if (seg->use_clocktime) {
677 if (seg->time <= 0) {
678 av_log(s, AV_LOG_ERROR, "Invalid negative segment_time with segment_atclocktime option set\n");
679 return AVERROR(EINVAL);
681 seg->clocktime_offset = seg->time - (seg->clocktime_offset % seg->time);
685 if (seg->format_options_str) {
686 ret = av_dict_parse_string(&seg->format_options, seg->format_options_str, "=", ":", 0);
688 av_log(s, AV_LOG_ERROR, "Could not parse format options list '%s'\n",
689 seg->format_options_str);
695 if (seg->list_type == LIST_TYPE_UNDEFINED) {
696 if (av_match_ext(seg->list, "csv" )) seg->list_type = LIST_TYPE_CSV;
697 else if (av_match_ext(seg->list, "ext" )) seg->list_type = LIST_TYPE_EXT;
698 else if (av_match_ext(seg->list, "m3u8")) seg->list_type = LIST_TYPE_M3U8;
699 else if (av_match_ext(seg->list, "ffcat,ffconcat")) seg->list_type = LIST_TYPE_FFCONCAT;
700 else seg->list_type = LIST_TYPE_FLAT;
702 if (!seg->list_size && seg->list_type != LIST_TYPE_M3U8) {
703 if ((ret = segment_list_open(s)) < 0)
706 const char *proto = avio_find_protocol_name(s->filename);
707 seg->use_rename = proto && !strcmp(proto, "file");
711 if (seg->list_type == LIST_TYPE_EXT)
712 av_log(s, AV_LOG_WARNING, "'ext' list type option is deprecated in favor of 'csv'\n");
714 if ((ret = select_reference_stream(s)) < 0)
716 av_log(s, AV_LOG_VERBOSE, "Selected stream id:%d type:%s\n",
717 seg->reference_stream_index,
718 av_get_media_type_string(s->streams[seg->reference_stream_index]->codecpar->codec_type));
720 seg->oformat = av_guess_format(seg->format, s->filename, NULL);
723 ret = AVERROR_MUXER_NOT_FOUND;
726 if (seg->oformat->flags & AVFMT_NOFILE) {
727 av_log(s, AV_LOG_ERROR, "format %s not supported.\n",
729 ret = AVERROR(EINVAL);
733 if ((ret = segment_mux_init(s)) < 0)
736 if ((ret = set_segment_filename(s)) < 0)
740 if (seg->write_header_trailer) {
741 if ((ret = s->io_open(s, &oc->pb,
742 seg->header_filename ? seg->header_filename : oc->filename,
743 AVIO_FLAG_WRITE, NULL)) < 0) {
744 av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->filename);
747 if (!seg->individual_header_trailer)
748 oc->pb->seekable = 0;
750 if ((ret = open_null_ctx(&oc->pb)) < 0)
754 av_dict_copy(&options, seg->format_options, 0);
755 ret = avformat_write_header(oc, &options);
756 if (av_dict_count(options)) {
757 av_log(s, AV_LOG_ERROR,
758 "Some of the provided format options in '%s' are not recognized\n", seg->format_options_str);
759 ret = AVERROR(EINVAL);
764 ff_format_io_close(oc, &oc->pb);
767 seg->segment_frame_count = 0;
769 av_assert0(s->nb_streams == oc->nb_streams);
770 for (i = 0; i < s->nb_streams; i++) {
771 AVStream *inner_st = oc->streams[i];
772 AVStream *outer_st = s->streams[i];
773 avpriv_set_pts_info(outer_st, inner_st->pts_wrap_bits, inner_st->time_base.num, inner_st->time_base.den);
776 if (oc->avoid_negative_ts > 0 && s->avoid_negative_ts < 0)
777 s->avoid_negative_ts = 1;
779 if (!seg->write_header_trailer || seg->header_filename) {
780 if (seg->header_filename) {
781 av_write_frame(oc, NULL);
782 ff_format_io_close(oc, &oc->pb);
784 close_null_ctxp(&oc->pb);
786 if ((ret = oc->io_open(oc, &oc->pb, oc->filename, AVIO_FLAG_WRITE, NULL)) < 0)
788 if (!seg->individual_header_trailer)
789 oc->pb->seekable = 0;
793 av_dict_free(&options);
795 seg_free_context(seg);
800 static int seg_write_packet(AVFormatContext *s, AVPacket *pkt)
802 SegmentContext *seg = s->priv_data;
803 AVStream *st = s->streams[pkt->stream_index];
804 int64_t end_pts = INT64_MAX, offset;
805 int start_frame = INT_MAX;
812 return AVERROR(EINVAL);
816 end_pts = seg->segment_count < seg->nb_times ?
817 seg->times[seg->segment_count] : INT64_MAX;
818 } else if (seg->frames) {
819 start_frame = seg->segment_count < seg->nb_frames ?
820 seg->frames[seg->segment_count] : INT_MAX;
822 if (seg->use_clocktime) {
823 int64_t avgt = av_gettime();
824 time_t sec = avgt / 1000000;
825 localtime_r(&sec, &ti);
826 usecs = (int64_t)(ti.tm_hour * 3600 + ti.tm_min * 60 + ti.tm_sec) * 1000000 + (avgt % 1000000);
827 wrapped_val = (usecs + seg->clocktime_offset) % seg->time;
828 if (seg->last_cut != usecs && wrapped_val < seg->last_val && wrapped_val < seg->clocktime_wrap_duration) {
829 seg->cut_pending = 1;
830 seg->last_cut = usecs;
832 seg->last_val = wrapped_val;
834 end_pts = seg->time * (seg->segment_count + 1);
838 ff_dlog(s, "packet stream:%d pts:%s pts_time:%s duration_time:%s is_key:%d frame:%d\n",
839 pkt->stream_index, av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
840 av_ts2timestr(pkt->duration, &st->time_base),
841 pkt->flags & AV_PKT_FLAG_KEY,
842 pkt->stream_index == seg->reference_stream_index ? seg->frame_count : -1);
844 if (pkt->stream_index == seg->reference_stream_index &&
845 (pkt->flags & AV_PKT_FLAG_KEY || seg->break_non_keyframes) &&
846 (seg->segment_frame_count > 0 || seg->write_empty) &&
847 (seg->cut_pending || seg->frame_count >= start_frame ||
848 (pkt->pts != AV_NOPTS_VALUE &&
849 av_compare_ts(pkt->pts, st->time_base,
850 end_pts - seg->time_delta, AV_TIME_BASE_Q) >= 0))) {
851 /* sanitize end time in case last packet didn't have a defined duration */
852 if (seg->cur_entry.last_duration == 0)
853 seg->cur_entry.end_time = (double)pkt->pts * av_q2d(st->time_base);
855 if ((ret = segment_end(s, seg->individual_header_trailer, 0)) < 0)
858 if ((ret = segment_start(s, seg->individual_header_trailer)) < 0)
861 seg->cut_pending = 0;
862 seg->cur_entry.index = seg->segment_idx + seg->segment_idx_wrap * seg->segment_idx_wrap_nb;
863 seg->cur_entry.start_time = (double)pkt->pts * av_q2d(st->time_base);
864 seg->cur_entry.start_pts = av_rescale_q(pkt->pts, st->time_base, AV_TIME_BASE_Q);
865 seg->cur_entry.end_time = seg->cur_entry.start_time;
867 if (seg->times || (!seg->frames && !seg->use_clocktime) && seg->write_empty)
871 if (pkt->stream_index == seg->reference_stream_index) {
872 if (pkt->pts != AV_NOPTS_VALUE)
873 seg->cur_entry.end_time =
874 FFMAX(seg->cur_entry.end_time, (double)(pkt->pts + pkt->duration) * av_q2d(st->time_base));
875 seg->cur_entry.last_duration = pkt->duration;
878 if (seg->segment_frame_count == 0) {
879 av_log(s, AV_LOG_VERBOSE, "segment:'%s' starts with packet stream:%d pts:%s pts_time:%s frame:%d\n",
880 seg->avf->filename, pkt->stream_index,
881 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base), seg->frame_count);
884 av_log(s, AV_LOG_DEBUG, "stream:%d start_pts_time:%s pts:%s pts_time:%s dts:%s dts_time:%s",
886 av_ts2timestr(seg->cur_entry.start_pts, &AV_TIME_BASE_Q),
887 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
888 av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
890 /* compute new timestamps */
891 offset = av_rescale_q(seg->initial_offset - (seg->reset_timestamps ? seg->cur_entry.start_pts : 0),
892 AV_TIME_BASE_Q, st->time_base);
893 if (pkt->pts != AV_NOPTS_VALUE)
895 if (pkt->dts != AV_NOPTS_VALUE)
898 av_log(s, AV_LOG_DEBUG, " -> pts:%s pts_time:%s dts:%s dts_time:%s\n",
899 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
900 av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
902 ret = ff_write_chained(seg->avf, pkt->stream_index, pkt, s, seg->initial_offset || seg->reset_timestamps);
905 if (pkt->stream_index == seg->reference_stream_index) {
907 seg->segment_frame_count++;
911 seg_free_context(seg);
916 static int seg_write_trailer(struct AVFormatContext *s)
918 SegmentContext *seg = s->priv_data;
919 AVFormatContext *oc = seg->avf;
920 SegmentListEntry *cur, *next;
926 if (!seg->write_header_trailer) {
927 if ((ret = segment_end(s, 0, 1)) < 0)
929 if ((ret = open_null_ctx(&oc->pb)) < 0)
931 ret = av_write_trailer(oc);
932 close_null_ctxp(&oc->pb);
934 ret = segment_end(s, 1, 1);
938 ff_format_io_close(s, &seg->list_pb);
940 av_dict_free(&seg->format_options);
942 av_freep(&seg->times);
943 av_freep(&seg->frames);
944 av_freep(&seg->cur_entry.filename);
946 cur = seg->segment_list_entries;
949 av_freep(&cur->filename);
954 avformat_free_context(oc);
959 static int seg_check_bitstream(struct AVFormatContext *s, const AVPacket *pkt)
961 SegmentContext *seg = s->priv_data;
962 AVFormatContext *oc = seg->avf;
963 if (oc->oformat->check_bitstream) {
964 int ret = oc->oformat->check_bitstream(oc, pkt);
966 AVStream *st = s->streams[pkt->stream_index];
967 AVStream *ost = oc->streams[pkt->stream_index];
968 st->internal->bsfc = ost->internal->bsfc;
969 ost->internal->bsfc = NULL;
976 #define OFFSET(x) offsetof(SegmentContext, x)
977 #define E AV_OPT_FLAG_ENCODING_PARAM
978 static const AVOption options[] = {
979 { "reference_stream", "set reference stream", OFFSET(reference_stream_specifier), AV_OPT_TYPE_STRING, {.str = "auto"}, CHAR_MIN, CHAR_MAX, E },
980 { "segment_format", "set container format used for the segments", OFFSET(format), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
981 { "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 },
982 { "segment_list", "set the segment list filename", OFFSET(list), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
983 { "segment_header_filename", "write a single file containing the header", OFFSET(header_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
985 { "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"},
986 { "cache", "allow list caching", 0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_LIST_FLAG_CACHE }, INT_MIN, INT_MAX, E, "list_flags"},
987 { "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"},
989 { "segment_list_size", "set the maximum number of playlist entries", OFFSET(list_size), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
991 { "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" },
992 { "flat", "flat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FLAT }, INT_MIN, INT_MAX, E, "list_type" },
993 { "csv", "csv format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_CSV }, INT_MIN, INT_MAX, E, "list_type" },
994 { "ext", "extended format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_EXT }, INT_MIN, INT_MAX, E, "list_type" },
995 { "ffconcat", "ffconcat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FFCONCAT }, INT_MIN, INT_MAX, E, "list_type" },
996 { "m3u8", "M3U8 format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
997 { "hls", "Apple HTTP Live Streaming compatible", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
999 { "segment_atclocktime", "set segment to be cut at clocktime", OFFSET(use_clocktime), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E},
1000 { "segment_clocktime_offset", "set segment clocktime offset", OFFSET(clocktime_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, 86400000000LL, E},
1001 { "segment_clocktime_wrap_duration", "set segment clocktime wrapping duration", OFFSET(clocktime_wrap_duration), AV_OPT_TYPE_DURATION, {.i64 = INT64_MAX}, 0, INT64_MAX, E},
1002 { "segment_time", "set segment duration", OFFSET(time_str),AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1003 { "segment_time_delta","set approximation value used for the segment times", OFFSET(time_delta), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, 0, E },
1004 { "segment_times", "set segment split time points", OFFSET(times_str),AV_OPT_TYPE_STRING,{.str = NULL}, 0, 0, E },
1005 { "segment_frames", "set segment split frame numbers", OFFSET(frames_str),AV_OPT_TYPE_STRING,{.str = NULL}, 0, 0, E },
1006 { "segment_wrap", "set number after which the index wraps", OFFSET(segment_idx_wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1007 { "segment_list_entry_prefix", "set base url prefix for segments", OFFSET(entry_prefix), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1008 { "segment_start_number", "set the sequence number of the first segment", OFFSET(segment_idx), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1009 { "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 },
1010 { "strftime", "set filename expansion with strftime at segment creation", OFFSET(use_strftime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1011 { "increment_tc", "increment timecode between each segment", OFFSET(increment_tc), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1012 { "break_non_keyframes", "allow breaking segments on non-keyframes", OFFSET(break_non_keyframes), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1014 { "individual_header_trailer", "write header/trailer to each segment", OFFSET(individual_header_trailer), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, E },
1015 { "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 },
1016 { "reset_timestamps", "reset timestamps at the begin of each segment", OFFSET(reset_timestamps), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1017 { "initial_offset", "set initial timestamp offset", OFFSET(initial_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, -INT64_MAX, INT64_MAX, E },
1018 { "write_empty_segments", "allow writing empty 'filler' segments", OFFSET(write_empty), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1022 static const AVClass seg_class = {
1023 .class_name = "segment muxer",
1024 .item_name = av_default_item_name,
1026 .version = LIBAVUTIL_VERSION_INT,
1029 AVOutputFormat ff_segment_muxer = {
1031 .long_name = NULL_IF_CONFIG_SMALL("segment"),
1032 .priv_data_size = sizeof(SegmentContext),
1033 .flags = AVFMT_NOFILE|AVFMT_GLOBALHEADER,
1035 .write_packet = seg_write_packet,
1036 .write_trailer = seg_write_trailer,
1037 .check_bitstream = seg_check_bitstream,
1038 .priv_class = &seg_class,
1041 static const AVClass sseg_class = {
1042 .class_name = "stream_segment muxer",
1043 .item_name = av_default_item_name,
1045 .version = LIBAVUTIL_VERSION_INT,
1048 AVOutputFormat ff_stream_segment_muxer = {
1049 .name = "stream_segment,ssegment",
1050 .long_name = NULL_IF_CONFIG_SMALL("streaming segment muxer"),
1051 .priv_data_size = sizeof(SegmentContext),
1052 .flags = AVFMT_NOFILE,
1054 .write_packet = seg_write_packet,
1055 .write_trailer = seg_write_trailer,
1056 .check_bitstream = seg_check_bitstream,
1057 .priv_class = &sseg_class,