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 AVDictionary *format_options;
79 char *list; ///< filename for the segment list file
80 int list_flags; ///< flags affecting list generation
81 int list_size; ///< number of entries for the segment list file
83 int use_clocktime; ///< flag to cut segments at regular clock time
84 int64_t clocktime_offset; //< clock offset for cutting the segments at regular clock time
85 int64_t clocktime_wrap_duration; //< wrapping duration considered for starting a new segment
86 int64_t last_val; ///< remember last time for wrap around detection
88 int header_written; ///< whether we've already called avformat_write_header
90 char *entry_prefix; ///< prefix to add to list entry filenames
91 int list_type; ///< set the list type
92 AVIOContext *list_pb; ///< list file put-byte context
93 int64_t time; ///< segment duration
94 int use_strftime; ///< flag to expand filename with strftime
95 int increment_tc; ///< flag to increment timecode if found
97 char *times_str; ///< segment times specification string
98 int64_t *times; ///< list of segment interval specification
99 int nb_times; ///< number of elments in the times array
101 char *frames_str; ///< segment frame numbers specification string
102 int *frames; ///< list of frame number specification
103 int nb_frames; ///< number of elments in the frames array
104 int frame_count; ///< total number of reference frames
105 int segment_frame_count; ///< number of reference frames in the segment
108 int individual_header_trailer; /**< Set by a private option. */
109 int write_header_trailer; /**< Set by a private option. */
110 char *header_filename; ///< filename to write the output header to
112 int reset_timestamps; ///< reset timestamps at the beginning of each segment
113 int64_t initial_offset; ///< initial timestamps offset, expressed in microseconds
114 char *reference_stream_specifier; ///< reference stream specifier
115 int reference_stream_index;
116 int break_non_keyframes;
120 char temp_list_filename[1024];
122 SegmentListEntry cur_entry;
123 SegmentListEntry *segment_list_entries;
124 SegmentListEntry *segment_list_entries_end;
127 static void print_csv_escaped_str(AVIOContext *ctx, const char *str)
129 int needs_quoting = !!str[strcspn(str, "\",\n\r")];
134 for (; *str; str++) {
143 static int segment_mux_init(AVFormatContext *s)
145 SegmentContext *seg = s->priv_data;
150 ret = avformat_alloc_output_context2(&seg->avf, seg->oformat, NULL, NULL);
155 oc->interrupt_callback = s->interrupt_callback;
156 oc->max_delay = s->max_delay;
157 av_dict_copy(&oc->metadata, s->metadata, 0);
158 oc->opaque = s->opaque;
159 oc->io_close = s->io_close;
160 oc->io_open = s->io_open;
161 oc->flags = s->flags;
163 for (i = 0; i < s->nb_streams; i++) {
164 AVStream *st, *ist = s->streams[i];
165 AVCodecParameters *ipar = ist->codecpar, *opar;
167 if (!(st = avformat_new_stream(oc, NULL)))
168 return AVERROR(ENOMEM);
170 avcodec_parameters_copy(opar, ipar);
171 if (!oc->oformat->codec_tag ||
172 av_codec_get_id (oc->oformat->codec_tag, ipar->codec_tag) == opar->codec_id ||
173 av_codec_get_tag(oc->oformat->codec_tag, ipar->codec_id) <= 0) {
174 opar->codec_tag = ipar->codec_tag;
178 st->sample_aspect_ratio = ist->sample_aspect_ratio;
179 st->time_base = ist->time_base;
180 st->avg_frame_rate = ist->avg_frame_rate;
181 st->disposition = ist->disposition;
182 #if FF_API_LAVF_AVCTX
183 FF_DISABLE_DEPRECATION_WARNINGS
184 if (ipar->codec_tag == MKTAG('t','m','c','d'))
185 st->codec->time_base = ist->codec->time_base;
186 FF_ENABLE_DEPRECATION_WARNINGS
188 av_dict_copy(&st->metadata, ist->metadata, 0);
194 static int set_segment_filename(AVFormatContext *s)
196 SegmentContext *seg = s->priv_data;
197 AVFormatContext *oc = seg->avf;
203 if (seg->segment_idx_wrap)
204 seg->segment_idx %= seg->segment_idx_wrap;
205 if (seg->use_strftime) {
207 struct tm *tm, tmpbuf;
209 tm = localtime_r(&now0, &tmpbuf);
210 if (!strftime(buf, sizeof(buf), s->url, tm)) {
211 av_log(oc, AV_LOG_ERROR, "Could not get segment filename with strftime\n");
212 return AVERROR(EINVAL);
214 } else if (av_get_frame_filename(buf, sizeof(buf),
215 s->url, seg->segment_idx) < 0) {
216 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", s->url);
217 return AVERROR(EINVAL);
219 new_name = av_strdup(buf);
221 return AVERROR(ENOMEM);
222 ff_format_set_url(oc, new_name);
224 /* copy modified name in list entry */
225 size = strlen(av_basename(oc->url)) + 1;
226 if (seg->entry_prefix)
227 size += strlen(seg->entry_prefix);
229 if ((ret = av_reallocp(&seg->cur_entry.filename, size)) < 0)
231 snprintf(seg->cur_entry.filename, size, "%s%s",
232 seg->entry_prefix ? seg->entry_prefix : "",
233 av_basename(oc->url));
238 static int segment_start(AVFormatContext *s, int write_header)
240 SegmentContext *seg = s->priv_data;
241 AVFormatContext *oc = seg->avf;
245 avformat_free_context(oc);
247 if ((err = segment_mux_init(s)) < 0)
253 if ((seg->segment_idx_wrap) && (seg->segment_idx % seg->segment_idx_wrap == 0))
254 seg->segment_idx_wrap_nb++;
256 if ((err = set_segment_filename(s)) < 0)
259 if ((err = s->io_open(s, &oc->pb, oc->url, AVIO_FLAG_WRITE, NULL)) < 0) {
260 av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->url);
263 if (!seg->individual_header_trailer)
264 oc->pb->seekable = 0;
266 if (oc->oformat->priv_class && oc->priv_data)
267 av_opt_set(oc->priv_data, "mpegts_flags", "+resend_headers", 0);
270 AVDictionary *options = NULL;
271 av_dict_copy(&options, seg->format_options, 0);
272 av_dict_set(&options, "fflags", "-autobsf", 0);
273 err = avformat_write_header(oc, &options);
274 av_dict_free(&options);
279 seg->segment_frame_count = 0;
283 static int segment_list_open(AVFormatContext *s)
285 SegmentContext *seg = s->priv_data;
288 snprintf(seg->temp_list_filename, sizeof(seg->temp_list_filename), seg->use_rename ? "%s.tmp" : "%s", seg->list);
289 ret = s->io_open(s, &seg->list_pb, seg->temp_list_filename, AVIO_FLAG_WRITE, NULL);
291 av_log(s, AV_LOG_ERROR, "Failed to open segment list '%s'\n", seg->list);
295 if (seg->list_type == LIST_TYPE_M3U8 && seg->segment_list_entries) {
296 SegmentListEntry *entry;
297 double max_duration = 0;
299 avio_printf(seg->list_pb, "#EXTM3U\n");
300 avio_printf(seg->list_pb, "#EXT-X-VERSION:3\n");
301 avio_printf(seg->list_pb, "#EXT-X-MEDIA-SEQUENCE:%d\n", seg->segment_list_entries->index);
302 avio_printf(seg->list_pb, "#EXT-X-ALLOW-CACHE:%s\n",
303 seg->list_flags & SEGMENT_LIST_FLAG_CACHE ? "YES" : "NO");
305 av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%d\n",
306 seg->segment_list_entries->index);
308 for (entry = seg->segment_list_entries; entry; entry = entry->next)
309 max_duration = FFMAX(max_duration, entry->end_time - entry->start_time);
310 avio_printf(seg->list_pb, "#EXT-X-TARGETDURATION:%"PRId64"\n", (int64_t)ceil(max_duration));
311 } else if (seg->list_type == LIST_TYPE_FFCONCAT) {
312 avio_printf(seg->list_pb, "ffconcat version 1.0\n");
318 static void segment_list_print_entry(AVIOContext *list_ioctx,
320 const SegmentListEntry *list_entry,
325 avio_printf(list_ioctx, "%s\n", list_entry->filename);
329 print_csv_escaped_str(list_ioctx, list_entry->filename);
330 avio_printf(list_ioctx, ",%f,%f\n", list_entry->start_time, list_entry->end_time);
333 avio_printf(list_ioctx, "#EXTINF:%f,\n%s\n",
334 list_entry->end_time - list_entry->start_time, list_entry->filename);
336 case LIST_TYPE_FFCONCAT:
339 if (av_escape(&buf, list_entry->filename, NULL, AV_ESCAPE_MODE_AUTO, AV_ESCAPE_FLAG_WHITESPACE) < 0) {
340 av_log(log_ctx, AV_LOG_WARNING,
341 "Error writing list entry '%s' in list file\n", list_entry->filename);
344 avio_printf(list_ioctx, "file %s\n", buf);
349 av_assert0(!"Invalid list type");
353 static int segment_end(AVFormatContext *s, int write_trailer, int is_last)
355 SegmentContext *seg = s->priv_data;
356 AVFormatContext *oc = seg->avf;
360 AVDictionaryEntry *tcr;
361 char buf[AV_TIMECODE_STR_SIZE];
366 return AVERROR(EINVAL);
368 av_write_frame(oc, NULL); /* Flush any buffered data (fragmented mp4) */
370 ret = av_write_trailer(oc);
373 av_log(s, AV_LOG_ERROR, "Failure occurred when ending segment '%s'\n",
377 if (seg->list_size || seg->list_type == LIST_TYPE_M3U8) {
378 SegmentListEntry *entry = av_mallocz(sizeof(*entry));
380 ret = AVERROR(ENOMEM);
384 /* append new element */
385 memcpy(entry, &seg->cur_entry, sizeof(*entry));
386 entry->filename = av_strdup(entry->filename);
387 if (!seg->segment_list_entries)
388 seg->segment_list_entries = seg->segment_list_entries_end = entry;
390 seg->segment_list_entries_end->next = entry;
391 seg->segment_list_entries_end = entry;
393 /* drop first item */
394 if (seg->list_size && seg->segment_count >= seg->list_size) {
395 entry = seg->segment_list_entries;
396 seg->segment_list_entries = seg->segment_list_entries->next;
397 av_freep(&entry->filename);
401 if ((ret = segment_list_open(s)) < 0)
403 for (entry = seg->segment_list_entries; entry; entry = entry->next)
404 segment_list_print_entry(seg->list_pb, seg->list_type, entry, s);
405 if (seg->list_type == LIST_TYPE_M3U8 && is_last)
406 avio_printf(seg->list_pb, "#EXT-X-ENDLIST\n");
407 ff_format_io_close(s, &seg->list_pb);
409 ff_rename(seg->temp_list_filename, seg->list, s);
411 segment_list_print_entry(seg->list_pb, seg->list_type, &seg->cur_entry, s);
412 avio_flush(seg->list_pb);
416 av_log(s, AV_LOG_VERBOSE, "segment:'%s' count:%d ended\n",
417 seg->avf->url, seg->segment_count);
418 seg->segment_count++;
420 if (seg->increment_tc) {
421 tcr = av_dict_get(s->metadata, "timecode", NULL, 0);
423 /* search the first video stream */
424 for (i = 0; i < s->nb_streams; i++) {
425 if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
426 rate = s->streams[i]->avg_frame_rate;/* Get fps from the video stream */
427 err = av_timecode_init_from_string(&tc, rate, tcr->value, s);
429 av_log(s, AV_LOG_WARNING, "Could not increment global timecode, error occurred during timecode creation.\n");
432 tc.start += (int)((seg->cur_entry.end_time - seg->cur_entry.start_time) * av_q2d(rate));/* increment timecode */
433 av_dict_set(&s->metadata, "timecode",
434 av_timecode_make_string(&tc, buf, 0), 0);
439 av_log(s, AV_LOG_WARNING, "Could not increment global timecode, no global timecode metadata found.\n");
441 for (i = 0; i < s->nb_streams; i++) {
442 if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
443 char st_buf[AV_TIMECODE_STR_SIZE];
445 AVRational st_rate = s->streams[i]->avg_frame_rate;
446 AVDictionaryEntry *st_tcr = av_dict_get(s->streams[i]->metadata, "timecode", NULL, 0);
448 if ((av_timecode_init_from_string(&st_tc, st_rate, st_tcr->value, s) < 0)) {
449 av_log(s, AV_LOG_WARNING, "Could not increment stream %d timecode, error occurred during timecode creation.\n", i);
452 st_tc.start += (int)((seg->cur_entry.end_time - seg->cur_entry.start_time) * av_q2d(st_rate)); // increment timecode
453 av_dict_set(&s->streams[i]->metadata, "timecode", av_timecode_make_string(&st_tc, st_buf, 0), 0);
460 ff_format_io_close(oc, &oc->pb);
465 static int parse_times(void *log_ctx, int64_t **times, int *nb_times,
466 const char *times_str)
470 char *times_str1 = av_strdup(times_str);
471 char *saveptr = NULL;
474 return AVERROR(ENOMEM);
476 #define FAIL(err) ret = err; goto end
479 for (p = times_str1; *p; p++)
483 *times = av_malloc_array(*nb_times, sizeof(**times));
485 av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced times array\n");
486 FAIL(AVERROR(ENOMEM));
490 for (i = 0; i < *nb_times; i++) {
492 char *tstr = av_strtok(p, ",", &saveptr);
495 if (!tstr || !tstr[0]) {
496 av_log(log_ctx, AV_LOG_ERROR, "Empty time specification in times list %s\n",
498 FAIL(AVERROR(EINVAL));
501 ret = av_parse_time(&t, tstr, 1);
503 av_log(log_ctx, AV_LOG_ERROR,
504 "Invalid time duration specification '%s' in times list %s\n", tstr, times_str);
505 FAIL(AVERROR(EINVAL));
509 /* check on monotonicity */
510 if (i && (*times)[i-1] > (*times)[i]) {
511 av_log(log_ctx, AV_LOG_ERROR,
512 "Specified time %f is greater than the following time %f\n",
513 (float)((*times)[i])/1000000, (float)((*times)[i-1])/1000000);
514 FAIL(AVERROR(EINVAL));
523 static int parse_frames(void *log_ctx, int **frames, int *nb_frames,
524 const char *frames_str)
528 char *frames_str1 = av_strdup(frames_str);
529 char *saveptr = NULL;
532 return AVERROR(ENOMEM);
534 #define FAIL(err) ret = err; goto end
537 for (p = frames_str1; *p; p++)
541 *frames = av_malloc_array(*nb_frames, sizeof(**frames));
543 av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced frames array\n");
544 FAIL(AVERROR(ENOMEM));
548 for (i = 0; i < *nb_frames; i++) {
551 char *fstr = av_strtok(p, ",", &saveptr);
555 av_log(log_ctx, AV_LOG_ERROR, "Empty frame specification in frame list %s\n",
557 FAIL(AVERROR(EINVAL));
559 f = strtol(fstr, &tailptr, 10);
560 if (*tailptr || f <= 0 || f >= INT_MAX) {
561 av_log(log_ctx, AV_LOG_ERROR,
562 "Invalid argument '%s', must be a positive integer <= INT64_MAX\n",
564 FAIL(AVERROR(EINVAL));
568 /* check on monotonicity */
569 if (i && (*frames)[i-1] > (*frames)[i]) {
570 av_log(log_ctx, AV_LOG_ERROR,
571 "Specified frame %d is greater than the following frame %d\n",
572 (*frames)[i], (*frames)[i-1]);
573 FAIL(AVERROR(EINVAL));
578 av_free(frames_str1);
582 static int open_null_ctx(AVIOContext **ctx)
584 int buf_size = 32768;
585 uint8_t *buf = av_malloc(buf_size);
587 return AVERROR(ENOMEM);
588 *ctx = avio_alloc_context(buf, buf_size, AVIO_FLAG_WRITE, NULL, NULL, NULL, NULL);
591 return AVERROR(ENOMEM);
596 static void close_null_ctxp(AVIOContext **pb)
598 av_freep(&(*pb)->buffer);
599 avio_context_free(pb);
602 static int select_reference_stream(AVFormatContext *s)
604 SegmentContext *seg = s->priv_data;
607 seg->reference_stream_index = -1;
608 if (!strcmp(seg->reference_stream_specifier, "auto")) {
609 /* select first index of type with highest priority */
610 int type_index_map[AVMEDIA_TYPE_NB];
611 static const enum AVMediaType type_priority_list[] = {
614 AVMEDIA_TYPE_SUBTITLE,
616 AVMEDIA_TYPE_ATTACHMENT
618 enum AVMediaType type;
620 for (i = 0; i < AVMEDIA_TYPE_NB; i++)
621 type_index_map[i] = -1;
623 /* select first index for each type */
624 for (i = 0; i < s->nb_streams; i++) {
625 type = s->streams[i]->codecpar->codec_type;
626 if ((unsigned)type < AVMEDIA_TYPE_NB && type_index_map[type] == -1
627 /* ignore attached pictures/cover art streams */
628 && !(s->streams[i]->disposition & AV_DISPOSITION_ATTACHED_PIC))
629 type_index_map[type] = i;
632 for (i = 0; i < FF_ARRAY_ELEMS(type_priority_list); i++) {
633 type = type_priority_list[i];
634 if ((seg->reference_stream_index = type_index_map[type]) >= 0)
638 for (i = 0; i < s->nb_streams; i++) {
639 ret = avformat_match_stream_specifier(s, s->streams[i],
640 seg->reference_stream_specifier);
644 seg->reference_stream_index = i;
650 if (seg->reference_stream_index < 0) {
651 av_log(s, AV_LOG_ERROR, "Could not select stream matching identifier '%s'\n",
652 seg->reference_stream_specifier);
653 return AVERROR(EINVAL);
659 static void seg_free(AVFormatContext *s)
661 SegmentContext *seg = s->priv_data;
662 ff_format_io_close(s, &seg->list_pb);
663 avformat_free_context(seg->avf);
665 av_freep(&seg->times);
666 av_freep(&seg->frames);
667 av_freep(&seg->cur_entry.filename);
670 static int seg_init(AVFormatContext *s)
672 SegmentContext *seg = s->priv_data;
673 AVFormatContext *oc = seg->avf;
674 AVDictionary *options = NULL;
678 seg->segment_count = 0;
679 if (!seg->write_header_trailer)
680 seg->individual_header_trailer = 0;
682 if (seg->header_filename) {
683 seg->write_header_trailer = 1;
684 seg->individual_header_trailer = 0;
687 if (seg->initial_offset > 0) {
688 av_log(s, AV_LOG_WARNING, "NOTE: the option initial_offset is deprecated,"
689 "you can use output_ts_offset instead of it\n");
692 if ((seg->time != 2000000) + !!seg->times_str + !!seg->frames_str > 1) {
693 av_log(s, AV_LOG_ERROR,
694 "segment_time, segment_times, and segment_frames options "
695 "are mutually exclusive, select just one of them\n");
696 return AVERROR(EINVAL);
699 if (seg->times_str) {
700 if ((ret = parse_times(s, &seg->times, &seg->nb_times, seg->times_str)) < 0)
702 } else if (seg->frames_str) {
703 if ((ret = parse_frames(s, &seg->frames, &seg->nb_frames, seg->frames_str)) < 0)
706 if (seg->use_clocktime) {
707 if (seg->time <= 0) {
708 av_log(s, AV_LOG_ERROR, "Invalid negative segment_time with segment_atclocktime option set\n");
709 return AVERROR(EINVAL);
711 seg->clocktime_offset = seg->time - (seg->clocktime_offset % seg->time);
716 if (seg->list_type == LIST_TYPE_UNDEFINED) {
717 if (av_match_ext(seg->list, "csv" )) seg->list_type = LIST_TYPE_CSV;
718 else if (av_match_ext(seg->list, "ext" )) seg->list_type = LIST_TYPE_EXT;
719 else if (av_match_ext(seg->list, "m3u8")) seg->list_type = LIST_TYPE_M3U8;
720 else if (av_match_ext(seg->list, "ffcat,ffconcat")) seg->list_type = LIST_TYPE_FFCONCAT;
721 else seg->list_type = LIST_TYPE_FLAT;
723 if (!seg->list_size && seg->list_type != LIST_TYPE_M3U8) {
724 if ((ret = segment_list_open(s)) < 0)
727 const char *proto = avio_find_protocol_name(seg->list);
728 seg->use_rename = proto && !strcmp(proto, "file");
732 if (seg->list_type == LIST_TYPE_EXT)
733 av_log(s, AV_LOG_WARNING, "'ext' list type option is deprecated in favor of 'csv'\n");
735 if ((ret = select_reference_stream(s)) < 0)
737 av_log(s, AV_LOG_VERBOSE, "Selected stream id:%d type:%s\n",
738 seg->reference_stream_index,
739 av_get_media_type_string(s->streams[seg->reference_stream_index]->codecpar->codec_type));
741 seg->oformat = av_guess_format(seg->format, s->url, NULL);
744 return AVERROR_MUXER_NOT_FOUND;
745 if (seg->oformat->flags & AVFMT_NOFILE) {
746 av_log(s, AV_LOG_ERROR, "format %s not supported.\n",
748 return AVERROR(EINVAL);
751 if ((ret = segment_mux_init(s)) < 0)
754 if ((ret = set_segment_filename(s)) < 0)
758 if (seg->write_header_trailer) {
759 if ((ret = s->io_open(s, &oc->pb,
760 seg->header_filename ? seg->header_filename : oc->url,
761 AVIO_FLAG_WRITE, NULL)) < 0) {
762 av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->url);
765 if (!seg->individual_header_trailer)
766 oc->pb->seekable = 0;
768 if ((ret = open_null_ctx(&oc->pb)) < 0)
772 av_dict_copy(&options, seg->format_options, 0);
773 av_dict_set(&options, "fflags", "-autobsf", 0);
774 ret = avformat_init_output(oc, &options);
775 if (av_dict_count(options)) {
776 av_log(s, AV_LOG_ERROR,
777 "Some of the provided format options are not recognized\n");
778 av_dict_free(&options);
779 return AVERROR(EINVAL);
781 av_dict_free(&options);
784 ff_format_io_close(oc, &oc->pb);
787 seg->segment_frame_count = 0;
789 av_assert0(s->nb_streams == oc->nb_streams);
790 if (ret == AVSTREAM_INIT_IN_WRITE_HEADER) {
791 ret = avformat_write_header(oc, NULL);
794 seg->header_written = 1;
797 for (i = 0; i < s->nb_streams; i++) {
798 AVStream *inner_st = oc->streams[i];
799 AVStream *outer_st = s->streams[i];
800 avpriv_set_pts_info(outer_st, inner_st->pts_wrap_bits, inner_st->time_base.num, inner_st->time_base.den);
803 if (oc->avoid_negative_ts > 0 && s->avoid_negative_ts < 0)
804 s->avoid_negative_ts = 1;
809 static int seg_write_header(AVFormatContext *s)
811 SegmentContext *seg = s->priv_data;
812 AVFormatContext *oc = seg->avf;
815 if (!seg->header_written) {
816 ret = avformat_write_header(oc, NULL);
821 if (!seg->write_header_trailer || seg->header_filename) {
822 if (seg->header_filename) {
823 av_write_frame(oc, NULL);
824 ff_format_io_close(oc, &oc->pb);
826 close_null_ctxp(&oc->pb);
828 if ((ret = oc->io_open(oc, &oc->pb, oc->url, AVIO_FLAG_WRITE, NULL)) < 0)
830 if (!seg->individual_header_trailer)
831 oc->pb->seekable = 0;
837 static int seg_write_packet(AVFormatContext *s, AVPacket *pkt)
839 SegmentContext *seg = s->priv_data;
840 AVStream *st = s->streams[pkt->stream_index];
841 int64_t end_pts = INT64_MAX, offset;
842 int start_frame = INT_MAX;
848 if (!seg->avf || !seg->avf->pb)
849 return AVERROR(EINVAL);
851 if (!st->codecpar->extradata_size) {
852 int pkt_extradata_size;
853 uint8_t *pkt_extradata = av_packet_get_side_data(pkt, AV_PKT_DATA_NEW_EXTRADATA, &pkt_extradata_size);
854 if (pkt_extradata && pkt_extradata_size > 0) {
855 ret = ff_alloc_extradata(st->codecpar, pkt_extradata_size);
857 av_log(s, AV_LOG_WARNING, "Unable to add extradata to stream. Output segments may be invalid.\n");
860 memcpy(st->codecpar->extradata, pkt_extradata, pkt_extradata_size);
866 end_pts = seg->segment_count < seg->nb_times ?
867 seg->times[seg->segment_count] : INT64_MAX;
868 } else if (seg->frames) {
869 start_frame = seg->segment_count < seg->nb_frames ?
870 seg->frames[seg->segment_count] : INT_MAX;
872 if (seg->use_clocktime) {
873 int64_t avgt = av_gettime();
874 time_t sec = avgt / 1000000;
875 localtime_r(&sec, &ti);
876 usecs = (int64_t)(ti.tm_hour * 3600 + ti.tm_min * 60 + ti.tm_sec) * 1000000 + (avgt % 1000000);
877 wrapped_val = (usecs + seg->clocktime_offset) % seg->time;
878 if (wrapped_val < seg->last_val && wrapped_val < seg->clocktime_wrap_duration)
879 seg->cut_pending = 1;
880 seg->last_val = wrapped_val;
882 end_pts = seg->time * (seg->segment_count + 1);
886 ff_dlog(s, "packet stream:%d pts:%s pts_time:%s duration_time:%s is_key:%d frame:%d\n",
887 pkt->stream_index, av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
888 av_ts2timestr(pkt->duration, &st->time_base),
889 pkt->flags & AV_PKT_FLAG_KEY,
890 pkt->stream_index == seg->reference_stream_index ? seg->frame_count : -1);
892 if (pkt->stream_index == seg->reference_stream_index &&
893 (pkt->flags & AV_PKT_FLAG_KEY || seg->break_non_keyframes) &&
894 (seg->segment_frame_count > 0 || seg->write_empty) &&
895 (seg->cut_pending || seg->frame_count >= start_frame ||
896 (pkt->pts != AV_NOPTS_VALUE &&
897 av_compare_ts(pkt->pts, st->time_base,
898 end_pts - seg->time_delta, AV_TIME_BASE_Q) >= 0))) {
899 /* sanitize end time in case last packet didn't have a defined duration */
900 if (seg->cur_entry.last_duration == 0)
901 seg->cur_entry.end_time = (double)pkt->pts * av_q2d(st->time_base);
903 if ((ret = segment_end(s, seg->individual_header_trailer, 0)) < 0)
906 if ((ret = segment_start(s, seg->individual_header_trailer)) < 0)
909 seg->cut_pending = 0;
910 seg->cur_entry.index = seg->segment_idx + seg->segment_idx_wrap * seg->segment_idx_wrap_nb;
911 seg->cur_entry.start_time = (double)pkt->pts * av_q2d(st->time_base);
912 seg->cur_entry.start_pts = av_rescale_q(pkt->pts, st->time_base, AV_TIME_BASE_Q);
913 seg->cur_entry.end_time = seg->cur_entry.start_time;
915 if (seg->times || (!seg->frames && !seg->use_clocktime) && seg->write_empty)
919 if (pkt->stream_index == seg->reference_stream_index) {
920 if (pkt->pts != AV_NOPTS_VALUE)
921 seg->cur_entry.end_time =
922 FFMAX(seg->cur_entry.end_time, (double)(pkt->pts + pkt->duration) * av_q2d(st->time_base));
923 seg->cur_entry.last_duration = pkt->duration;
926 if (seg->segment_frame_count == 0) {
927 av_log(s, AV_LOG_VERBOSE, "segment:'%s' starts with packet stream:%d pts:%s pts_time:%s frame:%d\n",
928 seg->avf->url, pkt->stream_index,
929 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base), seg->frame_count);
932 av_log(s, AV_LOG_DEBUG, "stream:%d start_pts_time:%s pts:%s pts_time:%s dts:%s dts_time:%s",
934 av_ts2timestr(seg->cur_entry.start_pts, &AV_TIME_BASE_Q),
935 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
936 av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
938 /* compute new timestamps */
939 offset = av_rescale_q(seg->initial_offset - (seg->reset_timestamps ? seg->cur_entry.start_pts : 0),
940 AV_TIME_BASE_Q, st->time_base);
941 if (pkt->pts != AV_NOPTS_VALUE)
943 if (pkt->dts != AV_NOPTS_VALUE)
946 av_log(s, AV_LOG_DEBUG, " -> pts:%s pts_time:%s dts:%s dts_time:%s\n",
947 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
948 av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
950 ret = ff_write_chained(seg->avf, pkt->stream_index, pkt, s,
951 seg->initial_offset || seg->reset_timestamps || seg->avf->oformat->interleave_packet);
954 if (pkt->stream_index == seg->reference_stream_index) {
956 seg->segment_frame_count++;
962 static int seg_write_trailer(struct AVFormatContext *s)
964 SegmentContext *seg = s->priv_data;
965 AVFormatContext *oc = seg->avf;
966 SegmentListEntry *cur, *next;
972 if (!seg->write_header_trailer) {
973 if ((ret = segment_end(s, 0, 1)) < 0)
975 if ((ret = open_null_ctx(&oc->pb)) < 0)
977 ret = av_write_trailer(oc);
978 close_null_ctxp(&oc->pb);
980 ret = segment_end(s, 1, 1);
984 ff_format_io_close(s, &seg->list_pb);
988 cur = seg->segment_list_entries;
991 av_freep(&cur->filename);
996 avformat_free_context(oc);
1001 static int seg_check_bitstream(struct AVFormatContext *s, const AVPacket *pkt)
1003 SegmentContext *seg = s->priv_data;
1004 AVFormatContext *oc = seg->avf;
1005 if (oc->oformat->check_bitstream) {
1006 int ret = oc->oformat->check_bitstream(oc, pkt);
1008 AVStream *st = s->streams[pkt->stream_index];
1009 AVStream *ost = oc->streams[pkt->stream_index];
1010 st->internal->bsfc = ost->internal->bsfc;
1011 ost->internal->bsfc = NULL;
1018 #define OFFSET(x) offsetof(SegmentContext, x)
1019 #define E AV_OPT_FLAG_ENCODING_PARAM
1020 static const AVOption options[] = {
1021 { "reference_stream", "set reference stream", OFFSET(reference_stream_specifier), AV_OPT_TYPE_STRING, {.str = "auto"}, 0, 0, E },
1022 { "segment_format", "set container format used for the segments", OFFSET(format), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1023 { "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 },
1024 { "segment_list", "set the segment list filename", OFFSET(list), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1025 { "segment_header_filename", "write a single file containing the header", OFFSET(header_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1027 { "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"},
1028 { "cache", "allow list caching", 0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_LIST_FLAG_CACHE }, INT_MIN, INT_MAX, E, "list_flags"},
1029 { "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"},
1031 { "segment_list_size", "set the maximum number of playlist entries", OFFSET(list_size), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1033 { "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" },
1034 { "flat", "flat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FLAT }, INT_MIN, INT_MAX, E, "list_type" },
1035 { "csv", "csv format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_CSV }, INT_MIN, INT_MAX, E, "list_type" },
1036 { "ext", "extended format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_EXT }, INT_MIN, INT_MAX, E, "list_type" },
1037 { "ffconcat", "ffconcat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FFCONCAT }, INT_MIN, INT_MAX, E, "list_type" },
1038 { "m3u8", "M3U8 format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
1039 { "hls", "Apple HTTP Live Streaming compatible", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
1041 { "segment_atclocktime", "set segment to be cut at clocktime", OFFSET(use_clocktime), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E},
1042 { "segment_clocktime_offset", "set segment clocktime offset", OFFSET(clocktime_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, 86400000000LL, E},
1043 { "segment_clocktime_wrap_duration", "set segment clocktime wrapping duration", OFFSET(clocktime_wrap_duration), AV_OPT_TYPE_DURATION, {.i64 = INT64_MAX}, 0, INT64_MAX, E},
1044 { "segment_time", "set segment duration", OFFSET(time),AV_OPT_TYPE_DURATION, {.i64 = 2000000}, INT64_MIN, INT64_MAX, E },
1045 { "segment_time_delta","set approximation value used for the segment times", OFFSET(time_delta), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, INT64_MAX, E },
1046 { "segment_times", "set segment split time points", OFFSET(times_str),AV_OPT_TYPE_STRING,{.str = NULL}, 0, 0, E },
1047 { "segment_frames", "set segment split frame numbers", OFFSET(frames_str),AV_OPT_TYPE_STRING,{.str = NULL}, 0, 0, E },
1048 { "segment_wrap", "set number after which the index wraps", OFFSET(segment_idx_wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1049 { "segment_list_entry_prefix", "set base url prefix for segments", OFFSET(entry_prefix), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1050 { "segment_start_number", "set the sequence number of the first segment", OFFSET(segment_idx), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1051 { "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 },
1052 { "strftime", "set filename expansion with strftime at segment creation", OFFSET(use_strftime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1053 { "increment_tc", "increment timecode between each segment", OFFSET(increment_tc), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1054 { "break_non_keyframes", "allow breaking segments on non-keyframes", OFFSET(break_non_keyframes), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1056 { "individual_header_trailer", "write header/trailer to each segment", OFFSET(individual_header_trailer), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, E },
1057 { "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 },
1058 { "reset_timestamps", "reset timestamps at the beginning of each segment", OFFSET(reset_timestamps), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1059 { "initial_offset", "set initial timestamp offset", OFFSET(initial_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, -INT64_MAX, INT64_MAX, E },
1060 { "write_empty_segments", "allow writing empty 'filler' segments", OFFSET(write_empty), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1064 #if CONFIG_SEGMENT_MUXER
1065 static const AVClass seg_class = {
1066 .class_name = "segment muxer",
1067 .item_name = av_default_item_name,
1069 .version = LIBAVUTIL_VERSION_INT,
1072 AVOutputFormat ff_segment_muxer = {
1074 .long_name = NULL_IF_CONFIG_SMALL("segment"),
1075 .priv_data_size = sizeof(SegmentContext),
1076 .flags = AVFMT_NOFILE|AVFMT_GLOBALHEADER,
1078 .write_header = seg_write_header,
1079 .write_packet = seg_write_packet,
1080 .write_trailer = seg_write_trailer,
1082 .check_bitstream = seg_check_bitstream,
1083 .priv_class = &seg_class,
1087 #if CONFIG_STREAM_SEGMENT_MUXER
1088 static const AVClass sseg_class = {
1089 .class_name = "stream_segment muxer",
1090 .item_name = av_default_item_name,
1092 .version = LIBAVUTIL_VERSION_INT,
1095 AVOutputFormat ff_stream_segment_muxer = {
1096 .name = "stream_segment,ssegment",
1097 .long_name = NULL_IF_CONFIG_SMALL("streaming segment muxer"),
1098 .priv_data_size = sizeof(SegmentContext),
1099 .flags = AVFMT_NOFILE,
1101 .write_header = seg_write_header,
1102 .write_packet = seg_write_packet,
1103 .write_trailer = seg_write_trailer,
1105 .check_bitstream = seg_check_bitstream,
1106 .priv_class = &sseg_class,