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}
31 #include "avio_internal.h"
34 #include "libavutil/avassert.h"
35 #include "libavutil/internal.h"
36 #include "libavutil/log.h"
37 #include "libavutil/opt.h"
38 #include "libavutil/avstring.h"
39 #include "libavutil/parseutils.h"
40 #include "libavutil/mathematics.h"
41 #include "libavutil/time.h"
42 #include "libavutil/timecode.h"
43 #include "libavutil/time_internal.h"
44 #include "libavutil/timestamp.h"
46 typedef struct SegmentListEntry {
48 double start_time, end_time;
52 struct SegmentListEntry *next;
53 int64_t last_duration;
57 LIST_TYPE_UNDEFINED = -1,
61 LIST_TYPE_EXT, ///< deprecated
66 #define SEGMENT_LIST_FLAG_CACHE 1
67 #define SEGMENT_LIST_FLAG_LIVE 2
69 typedef struct SegmentContext {
70 const AVClass *class; /**< Class for private options. */
71 int segment_idx; ///< index of the segment file to write, starting from 0
72 int segment_idx_wrap; ///< number after which the index wraps
73 int segment_idx_wrap_nb; ///< number of time the index has wraped
74 int segment_count; ///< number of segment files already written
75 ff_const59 AVOutputFormat *oformat;
77 char *format; ///< format to use for output segment files
78 char *format_options_str; ///< format options 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 use_clocktime; ///< flag to cut segments at regular clock time
85 int64_t clocktime_offset; //< clock offset for cutting the segments at regular clock time
86 int64_t clocktime_wrap_duration; //< wrapping duration considered for starting a new segment
87 int64_t last_val; ///< remember last time for wrap around detection
89 int header_written; ///< whether we've already called avformat_write_header
91 char *entry_prefix; ///< prefix to add to list entry filenames
92 int list_type; ///< set the list type
93 AVIOContext *list_pb; ///< list file put-byte context
94 char *time_str; ///< segment duration specification string
95 int64_t time; ///< segment duration
96 int use_strftime; ///< flag to expand filename with strftime
97 int increment_tc; ///< flag to increment timecode if found
99 char *times_str; ///< segment times specification string
100 int64_t *times; ///< list of segment interval specification
101 int nb_times; ///< number of elments in the times array
103 char *frames_str; ///< segment frame numbers specification string
104 int *frames; ///< list of frame number specification
105 int nb_frames; ///< number of elments in the frames array
106 int frame_count; ///< total number of reference frames
107 int segment_frame_count; ///< number of reference frames in the segment
110 int individual_header_trailer; /**< Set by a private option. */
111 int write_header_trailer; /**< Set by a private option. */
112 char *header_filename; ///< filename to write the output header to
114 int reset_timestamps; ///< reset timestamps at the beginning of each segment
115 int64_t initial_offset; ///< initial timestamps offset, expressed in microseconds
116 char *reference_stream_specifier; ///< reference stream specifier
117 int reference_stream_index;
118 int break_non_keyframes;
122 char temp_list_filename[1024];
124 SegmentListEntry cur_entry;
125 SegmentListEntry *segment_list_entries;
126 SegmentListEntry *segment_list_entries_end;
129 static void print_csv_escaped_str(AVIOContext *ctx, const char *str)
131 int needs_quoting = !!str[strcspn(str, "\",\n\r")];
136 for (; *str; str++) {
145 static int segment_mux_init(AVFormatContext *s)
147 SegmentContext *seg = s->priv_data;
152 ret = avformat_alloc_output_context2(&seg->avf, seg->oformat, NULL, NULL);
157 oc->interrupt_callback = s->interrupt_callback;
158 oc->max_delay = s->max_delay;
159 av_dict_copy(&oc->metadata, s->metadata, 0);
160 oc->opaque = s->opaque;
161 oc->io_close = s->io_close;
162 oc->io_open = s->io_open;
163 oc->flags = s->flags;
165 for (i = 0; i < s->nb_streams; i++) {
167 AVCodecParameters *ipar, *opar;
169 if (!(st = avformat_new_stream(oc, NULL)))
170 return AVERROR(ENOMEM);
171 ipar = s->streams[i]->codecpar;
173 avcodec_parameters_copy(opar, ipar);
174 if (!oc->oformat->codec_tag ||
175 av_codec_get_id (oc->oformat->codec_tag, ipar->codec_tag) == opar->codec_id ||
176 av_codec_get_tag(oc->oformat->codec_tag, ipar->codec_id) <= 0) {
177 opar->codec_tag = ipar->codec_tag;
181 st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
182 st->time_base = s->streams[i]->time_base;
183 st->avg_frame_rate = s->streams[i]->avg_frame_rate;
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;
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(buf, sizeof(buf), s->url, 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(buf, sizeof(buf),
211 s->url, seg->segment_idx) < 0) {
212 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", s->url);
213 return AVERROR(EINVAL);
215 new_name = av_strdup(buf);
217 return AVERROR(ENOMEM);
218 ff_format_set_url(oc, new_name);
220 /* copy modified name in list entry */
221 size = strlen(av_basename(oc->url)) + 1;
222 if (seg->entry_prefix)
223 size += strlen(seg->entry_prefix);
225 if ((ret = av_reallocp(&seg->cur_entry.filename, size)) < 0)
227 snprintf(seg->cur_entry.filename, size, "%s%s",
228 seg->entry_prefix ? seg->entry_prefix : "",
229 av_basename(oc->url));
234 static int segment_start(AVFormatContext *s, int write_header)
236 SegmentContext *seg = s->priv_data;
237 AVFormatContext *oc = seg->avf;
241 avformat_free_context(oc);
243 if ((err = segment_mux_init(s)) < 0)
249 if ((seg->segment_idx_wrap) && (seg->segment_idx % seg->segment_idx_wrap == 0))
250 seg->segment_idx_wrap_nb++;
252 if ((err = set_segment_filename(s)) < 0)
255 if ((err = s->io_open(s, &oc->pb, oc->url, AVIO_FLAG_WRITE, NULL)) < 0) {
256 av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->url);
259 if (!seg->individual_header_trailer)
260 oc->pb->seekable = 0;
262 if (oc->oformat->priv_class && oc->priv_data)
263 av_opt_set(oc->priv_data, "mpegts_flags", "+resend_headers", 0);
266 AVDictionary *options = NULL;
267 av_dict_copy(&options, seg->format_options, 0);
268 av_dict_set(&options, "fflags", "-autobsf", 0);
269 err = avformat_write_header(oc, &options);
270 av_dict_free(&options);
275 seg->segment_frame_count = 0;
279 static int segment_list_open(AVFormatContext *s)
281 SegmentContext *seg = s->priv_data;
284 snprintf(seg->temp_list_filename, sizeof(seg->temp_list_filename), seg->use_rename ? "%s.tmp" : "%s", seg->list);
285 ret = s->io_open(s, &seg->list_pb, seg->temp_list_filename, AVIO_FLAG_WRITE, NULL);
287 av_log(s, AV_LOG_ERROR, "Failed to open segment list '%s'\n", seg->list);
291 if (seg->list_type == LIST_TYPE_M3U8 && seg->segment_list_entries) {
292 SegmentListEntry *entry;
293 double max_duration = 0;
295 avio_printf(seg->list_pb, "#EXTM3U\n");
296 avio_printf(seg->list_pb, "#EXT-X-VERSION:3\n");
297 avio_printf(seg->list_pb, "#EXT-X-MEDIA-SEQUENCE:%d\n", seg->segment_list_entries->index);
298 avio_printf(seg->list_pb, "#EXT-X-ALLOW-CACHE:%s\n",
299 seg->list_flags & SEGMENT_LIST_FLAG_CACHE ? "YES" : "NO");
301 av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%d\n",
302 seg->segment_list_entries->index);
304 for (entry = seg->segment_list_entries; entry; entry = entry->next)
305 max_duration = FFMAX(max_duration, entry->end_time - entry->start_time);
306 avio_printf(seg->list_pb, "#EXT-X-TARGETDURATION:%"PRId64"\n", (int64_t)ceil(max_duration));
307 } else if (seg->list_type == LIST_TYPE_FFCONCAT) {
308 avio_printf(seg->list_pb, "ffconcat version 1.0\n");
314 static void segment_list_print_entry(AVIOContext *list_ioctx,
316 const SegmentListEntry *list_entry,
321 avio_printf(list_ioctx, "%s\n", list_entry->filename);
325 print_csv_escaped_str(list_ioctx, list_entry->filename);
326 avio_printf(list_ioctx, ",%f,%f\n", list_entry->start_time, list_entry->end_time);
329 avio_printf(list_ioctx, "#EXTINF:%f,\n%s\n",
330 list_entry->end_time - list_entry->start_time, list_entry->filename);
332 case LIST_TYPE_FFCONCAT:
335 if (av_escape(&buf, list_entry->filename, NULL, AV_ESCAPE_MODE_AUTO, AV_ESCAPE_FLAG_WHITESPACE) < 0) {
336 av_log(log_ctx, AV_LOG_WARNING,
337 "Error writing list entry '%s' in list file\n", list_entry->filename);
340 avio_printf(list_ioctx, "file %s\n", buf);
345 av_assert0(!"Invalid list type");
349 static int segment_end(AVFormatContext *s, int write_trailer, int is_last)
351 SegmentContext *seg = s->priv_data;
352 AVFormatContext *oc = seg->avf;
356 AVDictionaryEntry *tcr;
357 char buf[AV_TIMECODE_STR_SIZE];
362 return AVERROR(EINVAL);
364 av_write_frame(oc, NULL); /* Flush any buffered data (fragmented mp4) */
366 ret = av_write_trailer(oc);
369 av_log(s, AV_LOG_ERROR, "Failure occurred when ending segment '%s'\n",
373 if (seg->list_size || seg->list_type == LIST_TYPE_M3U8) {
374 SegmentListEntry *entry = av_mallocz(sizeof(*entry));
376 ret = AVERROR(ENOMEM);
380 /* append new element */
381 memcpy(entry, &seg->cur_entry, sizeof(*entry));
382 entry->filename = av_strdup(entry->filename);
383 if (!seg->segment_list_entries)
384 seg->segment_list_entries = seg->segment_list_entries_end = entry;
386 seg->segment_list_entries_end->next = entry;
387 seg->segment_list_entries_end = entry;
389 /* drop first item */
390 if (seg->list_size && seg->segment_count >= seg->list_size) {
391 entry = seg->segment_list_entries;
392 seg->segment_list_entries = seg->segment_list_entries->next;
393 av_freep(&entry->filename);
397 if ((ret = segment_list_open(s)) < 0)
399 for (entry = seg->segment_list_entries; entry; entry = entry->next)
400 segment_list_print_entry(seg->list_pb, seg->list_type, entry, s);
401 if (seg->list_type == LIST_TYPE_M3U8 && is_last)
402 avio_printf(seg->list_pb, "#EXT-X-ENDLIST\n");
403 ff_format_io_close(s, &seg->list_pb);
405 ff_rename(seg->temp_list_filename, seg->list, s);
407 segment_list_print_entry(seg->list_pb, seg->list_type, &seg->cur_entry, s);
408 avio_flush(seg->list_pb);
412 av_log(s, AV_LOG_VERBOSE, "segment:'%s' count:%d ended\n",
413 seg->avf->url, seg->segment_count);
414 seg->segment_count++;
416 if (seg->increment_tc) {
417 tcr = av_dict_get(s->metadata, "timecode", NULL, 0);
419 /* search the first video stream */
420 for (i = 0; i < s->nb_streams; i++) {
421 if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
422 rate = s->streams[i]->avg_frame_rate;/* Get fps from the video stream */
423 err = av_timecode_init_from_string(&tc, rate, tcr->value, s);
425 av_log(s, AV_LOG_WARNING, "Could not increment global timecode, error occurred during timecode creation.\n");
428 tc.start += (int)((seg->cur_entry.end_time - seg->cur_entry.start_time) * av_q2d(rate));/* increment timecode */
429 av_dict_set(&s->metadata, "timecode",
430 av_timecode_make_string(&tc, buf, 0), 0);
435 av_log(s, AV_LOG_WARNING, "Could not increment global timecode, no global timecode metadata found.\n");
437 for (i = 0; i < s->nb_streams; i++) {
438 if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
439 char st_buf[AV_TIMECODE_STR_SIZE];
441 AVRational st_rate = s->streams[i]->avg_frame_rate;
442 AVDictionaryEntry *st_tcr = av_dict_get(s->streams[i]->metadata, "timecode", NULL, 0);
444 if ((av_timecode_init_from_string(&st_tc, st_rate, st_tcr->value, s) < 0)) {
445 av_log(s, AV_LOG_WARNING, "Could not increment stream %d timecode, error occurred during timecode creation.\n", i);
448 st_tc.start += (int)((seg->cur_entry.end_time - seg->cur_entry.start_time) * av_q2d(st_rate)); // increment timecode
449 av_dict_set(&s->streams[i]->metadata, "timecode", av_timecode_make_string(&st_tc, st_buf, 0), 0);
456 ff_format_io_close(oc, &oc->pb);
461 static int parse_times(void *log_ctx, int64_t **times, int *nb_times,
462 const char *times_str)
466 char *times_str1 = av_strdup(times_str);
467 char *saveptr = NULL;
470 return AVERROR(ENOMEM);
472 #define FAIL(err) ret = err; goto end
475 for (p = times_str1; *p; p++)
479 *times = av_malloc_array(*nb_times, sizeof(**times));
481 av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced times array\n");
482 FAIL(AVERROR(ENOMEM));
486 for (i = 0; i < *nb_times; i++) {
488 char *tstr = av_strtok(p, ",", &saveptr);
491 if (!tstr || !tstr[0]) {
492 av_log(log_ctx, AV_LOG_ERROR, "Empty time specification in times list %s\n",
494 FAIL(AVERROR(EINVAL));
497 ret = av_parse_time(&t, tstr, 1);
499 av_log(log_ctx, AV_LOG_ERROR,
500 "Invalid time duration specification '%s' in times list %s\n", tstr, times_str);
501 FAIL(AVERROR(EINVAL));
505 /* check on monotonicity */
506 if (i && (*times)[i-1] > (*times)[i]) {
507 av_log(log_ctx, AV_LOG_ERROR,
508 "Specified time %f is greater than the following time %f\n",
509 (float)((*times)[i])/1000000, (float)((*times)[i-1])/1000000);
510 FAIL(AVERROR(EINVAL));
519 static int parse_frames(void *log_ctx, int **frames, int *nb_frames,
520 const char *frames_str)
524 char *frames_str1 = av_strdup(frames_str);
525 char *saveptr = NULL;
528 return AVERROR(ENOMEM);
530 #define FAIL(err) ret = err; goto end
533 for (p = frames_str1; *p; p++)
537 *frames = av_malloc_array(*nb_frames, sizeof(**frames));
539 av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced frames array\n");
540 FAIL(AVERROR(ENOMEM));
544 for (i = 0; i < *nb_frames; i++) {
547 char *fstr = av_strtok(p, ",", &saveptr);
551 av_log(log_ctx, AV_LOG_ERROR, "Empty frame specification in frame list %s\n",
553 FAIL(AVERROR(EINVAL));
555 f = strtol(fstr, &tailptr, 10);
556 if (*tailptr || f <= 0 || f >= INT_MAX) {
557 av_log(log_ctx, AV_LOG_ERROR,
558 "Invalid argument '%s', must be a positive integer <= INT64_MAX\n",
560 FAIL(AVERROR(EINVAL));
564 /* check on monotonicity */
565 if (i && (*frames)[i-1] > (*frames)[i]) {
566 av_log(log_ctx, AV_LOG_ERROR,
567 "Specified frame %d is greater than the following frame %d\n",
568 (*frames)[i], (*frames)[i-1]);
569 FAIL(AVERROR(EINVAL));
574 av_free(frames_str1);
578 static int open_null_ctx(AVIOContext **ctx)
580 int buf_size = 32768;
581 uint8_t *buf = av_malloc(buf_size);
583 return AVERROR(ENOMEM);
584 *ctx = avio_alloc_context(buf, buf_size, AVIO_FLAG_WRITE, NULL, NULL, NULL, NULL);
587 return AVERROR(ENOMEM);
592 static void close_null_ctxp(AVIOContext **pb)
594 av_freep(&(*pb)->buffer);
595 avio_context_free(pb);
598 static int select_reference_stream(AVFormatContext *s)
600 SegmentContext *seg = s->priv_data;
603 seg->reference_stream_index = -1;
604 if (!strcmp(seg->reference_stream_specifier, "auto")) {
605 /* select first index of type with highest priority */
606 int type_index_map[AVMEDIA_TYPE_NB];
607 static const enum AVMediaType type_priority_list[] = {
610 AVMEDIA_TYPE_SUBTITLE,
612 AVMEDIA_TYPE_ATTACHMENT
614 enum AVMediaType type;
616 for (i = 0; i < AVMEDIA_TYPE_NB; i++)
617 type_index_map[i] = -1;
619 /* select first index for each type */
620 for (i = 0; i < s->nb_streams; i++) {
621 type = s->streams[i]->codecpar->codec_type;
622 if ((unsigned)type < AVMEDIA_TYPE_NB && type_index_map[type] == -1
623 /* ignore attached pictures/cover art streams */
624 && !(s->streams[i]->disposition & AV_DISPOSITION_ATTACHED_PIC))
625 type_index_map[type] = i;
628 for (i = 0; i < FF_ARRAY_ELEMS(type_priority_list); i++) {
629 type = type_priority_list[i];
630 if ((seg->reference_stream_index = type_index_map[type]) >= 0)
634 for (i = 0; i < s->nb_streams; i++) {
635 ret = avformat_match_stream_specifier(s, s->streams[i],
636 seg->reference_stream_specifier);
640 seg->reference_stream_index = i;
646 if (seg->reference_stream_index < 0) {
647 av_log(s, AV_LOG_ERROR, "Could not select stream matching identifier '%s'\n",
648 seg->reference_stream_specifier);
649 return AVERROR(EINVAL);
655 static void seg_free(AVFormatContext *s)
657 SegmentContext *seg = s->priv_data;
658 ff_format_io_close(seg->avf, &seg->list_pb);
659 avformat_free_context(seg->avf);
663 static int seg_init(AVFormatContext *s)
665 SegmentContext *seg = s->priv_data;
666 AVFormatContext *oc = seg->avf;
667 AVDictionary *options = NULL;
671 seg->segment_count = 0;
672 if (!seg->write_header_trailer)
673 seg->individual_header_trailer = 0;
675 if (seg->header_filename) {
676 seg->write_header_trailer = 1;
677 seg->individual_header_trailer = 0;
680 if (seg->initial_offset > 0) {
681 av_log(s, AV_LOG_WARNING, "NOTE: the option initial_offset is deprecated,"
682 "you can use output_ts_offset instead of it\n");
685 if (!!seg->time_str + !!seg->times_str + !!seg->frames_str > 1) {
686 av_log(s, AV_LOG_ERROR,
687 "segment_time, segment_times, and segment_frames options "
688 "are mutually exclusive, select just one of them\n");
689 return AVERROR(EINVAL);
692 if (seg->times_str) {
693 if ((ret = parse_times(s, &seg->times, &seg->nb_times, seg->times_str)) < 0)
695 } else if (seg->frames_str) {
696 if ((ret = parse_frames(s, &seg->frames, &seg->nb_frames, seg->frames_str)) < 0)
699 /* set default value if not specified */
701 seg->time_str = av_strdup("2");
702 if ((ret = av_parse_time(&seg->time, seg->time_str, 1)) < 0) {
703 av_log(s, AV_LOG_ERROR,
704 "Invalid time duration specification '%s' for segment_time option\n",
708 if (seg->use_clocktime) {
709 if (seg->time <= 0) {
710 av_log(s, AV_LOG_ERROR, "Invalid negative segment_time with segment_atclocktime option set\n");
711 return AVERROR(EINVAL);
713 seg->clocktime_offset = seg->time - (seg->clocktime_offset % seg->time);
717 if (seg->format_options_str) {
718 ret = av_dict_parse_string(&seg->format_options, seg->format_options_str, "=", ":", 0);
720 av_log(s, AV_LOG_ERROR, "Could not parse format options list '%s'\n",
721 seg->format_options_str);
727 if (seg->list_type == LIST_TYPE_UNDEFINED) {
728 if (av_match_ext(seg->list, "csv" )) seg->list_type = LIST_TYPE_CSV;
729 else if (av_match_ext(seg->list, "ext" )) seg->list_type = LIST_TYPE_EXT;
730 else if (av_match_ext(seg->list, "m3u8")) seg->list_type = LIST_TYPE_M3U8;
731 else if (av_match_ext(seg->list, "ffcat,ffconcat")) seg->list_type = LIST_TYPE_FFCONCAT;
732 else seg->list_type = LIST_TYPE_FLAT;
734 if (!seg->list_size && seg->list_type != LIST_TYPE_M3U8) {
735 if ((ret = segment_list_open(s)) < 0)
738 const char *proto = avio_find_protocol_name(seg->list);
739 seg->use_rename = proto && !strcmp(proto, "file");
743 if (seg->list_type == LIST_TYPE_EXT)
744 av_log(s, AV_LOG_WARNING, "'ext' list type option is deprecated in favor of 'csv'\n");
746 if ((ret = select_reference_stream(s)) < 0)
748 av_log(s, AV_LOG_VERBOSE, "Selected stream id:%d type:%s\n",
749 seg->reference_stream_index,
750 av_get_media_type_string(s->streams[seg->reference_stream_index]->codecpar->codec_type));
752 seg->oformat = av_guess_format(seg->format, s->url, NULL);
755 return AVERROR_MUXER_NOT_FOUND;
756 if (seg->oformat->flags & AVFMT_NOFILE) {
757 av_log(s, AV_LOG_ERROR, "format %s not supported.\n",
759 return AVERROR(EINVAL);
762 if ((ret = segment_mux_init(s)) < 0)
765 if ((ret = set_segment_filename(s)) < 0)
769 if (seg->write_header_trailer) {
770 if ((ret = s->io_open(s, &oc->pb,
771 seg->header_filename ? seg->header_filename : oc->url,
772 AVIO_FLAG_WRITE, NULL)) < 0) {
773 av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->url);
776 if (!seg->individual_header_trailer)
777 oc->pb->seekable = 0;
779 if ((ret = open_null_ctx(&oc->pb)) < 0)
783 av_dict_copy(&options, seg->format_options, 0);
784 av_dict_set(&options, "fflags", "-autobsf", 0);
785 ret = avformat_init_output(oc, &options);
786 if (av_dict_count(options)) {
787 av_log(s, AV_LOG_ERROR,
788 "Some of the provided format options in '%s' are not recognized\n", seg->format_options_str);
789 av_dict_free(&options);
790 return AVERROR(EINVAL);
792 av_dict_free(&options);
795 ff_format_io_close(oc, &oc->pb);
798 seg->segment_frame_count = 0;
800 av_assert0(s->nb_streams == oc->nb_streams);
801 if (ret == AVSTREAM_INIT_IN_WRITE_HEADER) {
802 ret = avformat_write_header(oc, NULL);
805 seg->header_written = 1;
808 for (i = 0; i < s->nb_streams; i++) {
809 AVStream *inner_st = oc->streams[i];
810 AVStream *outer_st = s->streams[i];
811 avpriv_set_pts_info(outer_st, inner_st->pts_wrap_bits, inner_st->time_base.num, inner_st->time_base.den);
814 if (oc->avoid_negative_ts > 0 && s->avoid_negative_ts < 0)
815 s->avoid_negative_ts = 1;
820 static int seg_write_header(AVFormatContext *s)
822 SegmentContext *seg = s->priv_data;
823 AVFormatContext *oc = seg->avf;
826 if (!seg->header_written) {
827 for (i = 0; i < s->nb_streams; i++) {
828 AVStream *st = oc->streams[i];
829 AVCodecParameters *ipar, *opar;
831 ipar = s->streams[i]->codecpar;
832 opar = oc->streams[i]->codecpar;
833 avcodec_parameters_copy(opar, ipar);
834 if (!oc->oformat->codec_tag ||
835 av_codec_get_id (oc->oformat->codec_tag, ipar->codec_tag) == opar->codec_id ||
836 av_codec_get_tag(oc->oformat->codec_tag, ipar->codec_id) <= 0) {
837 opar->codec_tag = ipar->codec_tag;
841 st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
842 st->time_base = s->streams[i]->time_base;
844 ret = avformat_write_header(oc, NULL);
849 if (!seg->write_header_trailer || seg->header_filename) {
850 if (seg->header_filename) {
851 av_write_frame(oc, NULL);
852 ff_format_io_close(oc, &oc->pb);
854 close_null_ctxp(&oc->pb);
856 if ((ret = oc->io_open(oc, &oc->pb, oc->url, AVIO_FLAG_WRITE, NULL)) < 0)
858 if (!seg->individual_header_trailer)
859 oc->pb->seekable = 0;
865 static int seg_write_packet(AVFormatContext *s, AVPacket *pkt)
867 SegmentContext *seg = s->priv_data;
868 AVStream *st = s->streams[pkt->stream_index];
869 int64_t end_pts = INT64_MAX, offset;
870 int start_frame = INT_MAX;
876 if (!seg->avf || !seg->avf->pb)
877 return AVERROR(EINVAL);
879 if (!st->codecpar->extradata_size) {
880 int pkt_extradata_size = 0;
881 uint8_t *pkt_extradata = av_packet_get_side_data(pkt, AV_PKT_DATA_NEW_EXTRADATA, &pkt_extradata_size);
882 if (pkt_extradata && pkt_extradata_size > 0) {
883 ret = ff_alloc_extradata(st->codecpar, pkt_extradata_size);
885 av_log(s, AV_LOG_WARNING, "Unable to add extradata to stream. Output segments may be invalid.\n");
888 memcpy(st->codecpar->extradata, pkt_extradata, pkt_extradata_size);
889 st->codecpar->extradata_size = pkt_extradata_size;
895 end_pts = seg->segment_count < seg->nb_times ?
896 seg->times[seg->segment_count] : INT64_MAX;
897 } else if (seg->frames) {
898 start_frame = seg->segment_count < seg->nb_frames ?
899 seg->frames[seg->segment_count] : INT_MAX;
901 if (seg->use_clocktime) {
902 int64_t avgt = av_gettime();
903 time_t sec = avgt / 1000000;
904 localtime_r(&sec, &ti);
905 usecs = (int64_t)(ti.tm_hour * 3600 + ti.tm_min * 60 + ti.tm_sec) * 1000000 + (avgt % 1000000);
906 wrapped_val = (usecs + seg->clocktime_offset) % seg->time;
907 if (wrapped_val < seg->last_val && wrapped_val < seg->clocktime_wrap_duration)
908 seg->cut_pending = 1;
909 seg->last_val = wrapped_val;
911 end_pts = seg->time * (seg->segment_count + 1);
915 ff_dlog(s, "packet stream:%d pts:%s pts_time:%s duration_time:%s is_key:%d frame:%d\n",
916 pkt->stream_index, av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
917 av_ts2timestr(pkt->duration, &st->time_base),
918 pkt->flags & AV_PKT_FLAG_KEY,
919 pkt->stream_index == seg->reference_stream_index ? seg->frame_count : -1);
921 if (pkt->stream_index == seg->reference_stream_index &&
922 (pkt->flags & AV_PKT_FLAG_KEY || seg->break_non_keyframes) &&
923 (seg->segment_frame_count > 0 || seg->write_empty) &&
924 (seg->cut_pending || seg->frame_count >= start_frame ||
925 (pkt->pts != AV_NOPTS_VALUE &&
926 av_compare_ts(pkt->pts, st->time_base,
927 end_pts - seg->time_delta, AV_TIME_BASE_Q) >= 0))) {
928 /* sanitize end time in case last packet didn't have a defined duration */
929 if (seg->cur_entry.last_duration == 0)
930 seg->cur_entry.end_time = (double)pkt->pts * av_q2d(st->time_base);
932 if ((ret = segment_end(s, seg->individual_header_trailer, 0)) < 0)
935 if ((ret = segment_start(s, seg->individual_header_trailer)) < 0)
938 seg->cut_pending = 0;
939 seg->cur_entry.index = seg->segment_idx + seg->segment_idx_wrap * seg->segment_idx_wrap_nb;
940 seg->cur_entry.start_time = (double)pkt->pts * av_q2d(st->time_base);
941 seg->cur_entry.start_pts = av_rescale_q(pkt->pts, st->time_base, AV_TIME_BASE_Q);
942 seg->cur_entry.end_time = seg->cur_entry.start_time;
944 if (seg->times || (!seg->frames && !seg->use_clocktime) && seg->write_empty)
948 if (pkt->stream_index == seg->reference_stream_index) {
949 if (pkt->pts != AV_NOPTS_VALUE)
950 seg->cur_entry.end_time =
951 FFMAX(seg->cur_entry.end_time, (double)(pkt->pts + pkt->duration) * av_q2d(st->time_base));
952 seg->cur_entry.last_duration = pkt->duration;
955 if (seg->segment_frame_count == 0) {
956 av_log(s, AV_LOG_VERBOSE, "segment:'%s' starts with packet stream:%d pts:%s pts_time:%s frame:%d\n",
957 seg->avf->url, pkt->stream_index,
958 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base), seg->frame_count);
961 av_log(s, AV_LOG_DEBUG, "stream:%d start_pts_time:%s pts:%s pts_time:%s dts:%s dts_time:%s",
963 av_ts2timestr(seg->cur_entry.start_pts, &AV_TIME_BASE_Q),
964 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
965 av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
967 /* compute new timestamps */
968 offset = av_rescale_q(seg->initial_offset - (seg->reset_timestamps ? seg->cur_entry.start_pts : 0),
969 AV_TIME_BASE_Q, st->time_base);
970 if (pkt->pts != AV_NOPTS_VALUE)
972 if (pkt->dts != AV_NOPTS_VALUE)
975 av_log(s, AV_LOG_DEBUG, " -> pts:%s pts_time:%s dts:%s dts_time:%s\n",
976 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
977 av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
979 ret = ff_write_chained(seg->avf, pkt->stream_index, pkt, s, seg->initial_offset || seg->reset_timestamps);
982 if (pkt->stream_index == seg->reference_stream_index) {
984 seg->segment_frame_count++;
990 static int seg_write_trailer(struct AVFormatContext *s)
992 SegmentContext *seg = s->priv_data;
993 AVFormatContext *oc = seg->avf;
994 SegmentListEntry *cur, *next;
1000 if (!seg->write_header_trailer) {
1001 if ((ret = segment_end(s, 0, 1)) < 0)
1003 if ((ret = open_null_ctx(&oc->pb)) < 0)
1005 ret = av_write_trailer(oc);
1006 close_null_ctxp(&oc->pb);
1008 ret = segment_end(s, 1, 1);
1012 ff_format_io_close(s, &seg->list_pb);
1014 av_dict_free(&seg->format_options);
1016 av_freep(&seg->times);
1017 av_freep(&seg->frames);
1018 av_freep(&seg->cur_entry.filename);
1020 cur = seg->segment_list_entries;
1023 av_freep(&cur->filename);
1028 avformat_free_context(oc);
1033 static int seg_check_bitstream(struct AVFormatContext *s, const AVPacket *pkt)
1035 SegmentContext *seg = s->priv_data;
1036 AVFormatContext *oc = seg->avf;
1037 if (oc->oformat->check_bitstream) {
1038 int ret = oc->oformat->check_bitstream(oc, pkt);
1040 AVStream *st = s->streams[pkt->stream_index];
1041 AVStream *ost = oc->streams[pkt->stream_index];
1042 st->internal->bsfcs = ost->internal->bsfcs;
1043 st->internal->nb_bsfcs = ost->internal->nb_bsfcs;
1044 ost->internal->bsfcs = NULL;
1045 ost->internal->nb_bsfcs = 0;
1052 #define OFFSET(x) offsetof(SegmentContext, x)
1053 #define E AV_OPT_FLAG_ENCODING_PARAM
1054 static const AVOption options[] = {
1055 { "reference_stream", "set reference stream", OFFSET(reference_stream_specifier), AV_OPT_TYPE_STRING, {.str = "auto"}, CHAR_MIN, CHAR_MAX, E },
1056 { "segment_format", "set container format used for the segments", OFFSET(format), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1057 { "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 },
1058 { "segment_list", "set the segment list filename", OFFSET(list), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1059 { "segment_header_filename", "write a single file containing the header", OFFSET(header_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1061 { "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"},
1062 { "cache", "allow list caching", 0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_LIST_FLAG_CACHE }, INT_MIN, INT_MAX, E, "list_flags"},
1063 { "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"},
1065 { "segment_list_size", "set the maximum number of playlist entries", OFFSET(list_size), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1067 { "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" },
1068 { "flat", "flat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FLAT }, INT_MIN, INT_MAX, E, "list_type" },
1069 { "csv", "csv format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_CSV }, INT_MIN, INT_MAX, E, "list_type" },
1070 { "ext", "extended format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_EXT }, INT_MIN, INT_MAX, E, "list_type" },
1071 { "ffconcat", "ffconcat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FFCONCAT }, INT_MIN, INT_MAX, E, "list_type" },
1072 { "m3u8", "M3U8 format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
1073 { "hls", "Apple HTTP Live Streaming compatible", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
1075 { "segment_atclocktime", "set segment to be cut at clocktime", OFFSET(use_clocktime), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E},
1076 { "segment_clocktime_offset", "set segment clocktime offset", OFFSET(clocktime_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, 86400000000LL, E},
1077 { "segment_clocktime_wrap_duration", "set segment clocktime wrapping duration", OFFSET(clocktime_wrap_duration), AV_OPT_TYPE_DURATION, {.i64 = INT64_MAX}, 0, INT64_MAX, E},
1078 { "segment_time", "set segment duration", OFFSET(time_str),AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1079 { "segment_time_delta","set approximation value used for the segment times", OFFSET(time_delta), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, INT64_MAX, E },
1080 { "segment_times", "set segment split time points", OFFSET(times_str),AV_OPT_TYPE_STRING,{.str = NULL}, 0, 0, E },
1081 { "segment_frames", "set segment split frame numbers", OFFSET(frames_str),AV_OPT_TYPE_STRING,{.str = NULL}, 0, 0, E },
1082 { "segment_wrap", "set number after which the index wraps", OFFSET(segment_idx_wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1083 { "segment_list_entry_prefix", "set base url prefix for segments", OFFSET(entry_prefix), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1084 { "segment_start_number", "set the sequence number of the first segment", OFFSET(segment_idx), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1085 { "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 },
1086 { "strftime", "set filename expansion with strftime at segment creation", OFFSET(use_strftime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1087 { "increment_tc", "increment timecode between each segment", OFFSET(increment_tc), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1088 { "break_non_keyframes", "allow breaking segments on non-keyframes", OFFSET(break_non_keyframes), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1090 { "individual_header_trailer", "write header/trailer to each segment", OFFSET(individual_header_trailer), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, E },
1091 { "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 },
1092 { "reset_timestamps", "reset timestamps at the beginning of each segment", OFFSET(reset_timestamps), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1093 { "initial_offset", "set initial timestamp offset", OFFSET(initial_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, -INT64_MAX, INT64_MAX, E },
1094 { "write_empty_segments", "allow writing empty 'filler' segments", OFFSET(write_empty), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1098 #if CONFIG_SEGMENT_MUXER
1099 static const AVClass seg_class = {
1100 .class_name = "segment muxer",
1101 .item_name = av_default_item_name,
1103 .version = LIBAVUTIL_VERSION_INT,
1106 AVOutputFormat ff_segment_muxer = {
1108 .long_name = NULL_IF_CONFIG_SMALL("segment"),
1109 .priv_data_size = sizeof(SegmentContext),
1110 .flags = AVFMT_NOFILE|AVFMT_GLOBALHEADER,
1112 .write_header = seg_write_header,
1113 .write_packet = seg_write_packet,
1114 .write_trailer = seg_write_trailer,
1116 .check_bitstream = seg_check_bitstream,
1117 .priv_class = &seg_class,
1121 #if CONFIG_STREAM_SEGMENT_MUXER
1122 static const AVClass sseg_class = {
1123 .class_name = "stream_segment muxer",
1124 .item_name = av_default_item_name,
1126 .version = LIBAVUTIL_VERSION_INT,
1129 AVOutputFormat ff_stream_segment_muxer = {
1130 .name = "stream_segment,ssegment",
1131 .long_name = NULL_IF_CONFIG_SMALL("streaming segment muxer"),
1132 .priv_data_size = sizeof(SegmentContext),
1133 .flags = AVFMT_NOFILE,
1135 .write_header = seg_write_header,
1136 .write_packet = seg_write_packet,
1137 .write_trailer = seg_write_trailer,
1139 .check_bitstream = seg_check_bitstream,
1140 .priv_class = &sseg_class,