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 is_nullctx; ///< whether avf->pb is a nullctx
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 int64_t time; ///< segment duration
95 int use_strftime; ///< flag to expand filename with strftime
96 int increment_tc; ///< flag to increment timecode if found
98 char *times_str; ///< segment times specification string
99 int64_t *times; ///< list of segment interval specification
100 int nb_times; ///< number of elments in the times array
102 char *frames_str; ///< segment frame numbers specification string
103 int *frames; ///< list of frame number specification
104 int nb_frames; ///< number of elments in the frames array
105 int frame_count; ///< total number of reference frames
106 int segment_frame_count; ///< number of reference frames in the segment
109 int individual_header_trailer; /**< Set by a private option. */
110 int write_header_trailer; /**< Set by a private option. */
111 char *header_filename; ///< filename to write the output header to
113 int reset_timestamps; ///< reset timestamps at the beginning of each segment
114 int64_t initial_offset; ///< initial timestamps offset, expressed in microseconds
115 char *reference_stream_specifier; ///< reference stream specifier
116 int reference_stream_index;
117 int break_non_keyframes;
121 char temp_list_filename[1024];
123 SegmentListEntry cur_entry;
124 SegmentListEntry *segment_list_entries;
125 SegmentListEntry *segment_list_entries_end;
128 static void print_csv_escaped_str(AVIOContext *ctx, const char *str)
130 int needs_quoting = !!str[strcspn(str, "\",\n\r")];
135 for (; *str; str++) {
144 static int segment_mux_init(AVFormatContext *s)
146 SegmentContext *seg = s->priv_data;
151 ret = avformat_alloc_output_context2(&seg->avf, seg->oformat, NULL, NULL);
156 oc->interrupt_callback = s->interrupt_callback;
157 oc->max_delay = s->max_delay;
158 av_dict_copy(&oc->metadata, s->metadata, 0);
159 oc->opaque = s->opaque;
160 oc->io_close = s->io_close;
161 oc->io_open = s->io_open;
162 oc->flags = s->flags;
164 for (i = 0; i < s->nb_streams; i++) {
165 AVStream *st, *ist = s->streams[i];
166 AVCodecParameters *ipar = ist->codecpar, *opar;
168 if (!(st = avformat_new_stream(oc, NULL)))
169 return AVERROR(ENOMEM);
171 avcodec_parameters_copy(opar, ipar);
172 if (!oc->oformat->codec_tag ||
173 av_codec_get_id (oc->oformat->codec_tag, ipar->codec_tag) == opar->codec_id ||
174 av_codec_get_tag(oc->oformat->codec_tag, ipar->codec_id) <= 0) {
175 opar->codec_tag = ipar->codec_tag;
179 st->sample_aspect_ratio = ist->sample_aspect_ratio;
180 st->time_base = ist->time_base;
181 st->avg_frame_rate = ist->avg_frame_rate;
182 st->disposition = ist->disposition;
183 #if FF_API_LAVF_AVCTX
184 FF_DISABLE_DEPRECATION_WARNINGS
185 if (ipar->codec_tag == MKTAG('t','m','c','d'))
186 st->codec->time_base = ist->codec->time_base;
187 FF_ENABLE_DEPRECATION_WARNINGS
189 av_dict_copy(&st->metadata, ist->metadata, 0);
195 static int set_segment_filename(AVFormatContext *s)
197 SegmentContext *seg = s->priv_data;
198 AVFormatContext *oc = seg->avf;
204 if (seg->segment_idx_wrap)
205 seg->segment_idx %= seg->segment_idx_wrap;
206 if (seg->use_strftime) {
208 struct tm *tm, tmpbuf;
210 tm = localtime_r(&now0, &tmpbuf);
211 if (!strftime(buf, sizeof(buf), s->url, tm)) {
212 av_log(oc, AV_LOG_ERROR, "Could not get segment filename with strftime\n");
213 return AVERROR(EINVAL);
215 } else if (av_get_frame_filename(buf, sizeof(buf),
216 s->url, seg->segment_idx) < 0) {
217 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", s->url);
218 return AVERROR(EINVAL);
220 new_name = av_strdup(buf);
222 return AVERROR(ENOMEM);
223 ff_format_set_url(oc, new_name);
225 /* copy modified name in list entry */
226 size = strlen(av_basename(oc->url)) + 1;
227 if (seg->entry_prefix)
228 size += strlen(seg->entry_prefix);
230 if ((ret = av_reallocp(&seg->cur_entry.filename, size)) < 0)
232 snprintf(seg->cur_entry.filename, size, "%s%s",
233 seg->entry_prefix ? seg->entry_prefix : "",
234 av_basename(oc->url));
239 static int segment_start(AVFormatContext *s, int write_header)
241 SegmentContext *seg = s->priv_data;
242 AVFormatContext *oc = seg->avf;
246 avformat_free_context(oc);
248 if ((err = segment_mux_init(s)) < 0)
254 if ((seg->segment_idx_wrap) && (seg->segment_idx % seg->segment_idx_wrap == 0))
255 seg->segment_idx_wrap_nb++;
257 if ((err = set_segment_filename(s)) < 0)
260 if ((err = s->io_open(s, &oc->pb, oc->url, AVIO_FLAG_WRITE, NULL)) < 0) {
261 av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->url);
264 if (!seg->individual_header_trailer)
265 oc->pb->seekable = 0;
267 if (oc->oformat->priv_class && oc->priv_data)
268 av_opt_set(oc->priv_data, "mpegts_flags", "+resend_headers", 0);
271 AVDictionary *options = NULL;
272 av_dict_copy(&options, seg->format_options, 0);
273 av_dict_set(&options, "fflags", "-autobsf", 0);
274 err = avformat_write_header(oc, &options);
275 av_dict_free(&options);
280 seg->segment_frame_count = 0;
284 static int segment_list_open(AVFormatContext *s)
286 SegmentContext *seg = s->priv_data;
289 snprintf(seg->temp_list_filename, sizeof(seg->temp_list_filename), seg->use_rename ? "%s.tmp" : "%s", seg->list);
290 ret = s->io_open(s, &seg->list_pb, seg->temp_list_filename, AVIO_FLAG_WRITE, NULL);
292 av_log(s, AV_LOG_ERROR, "Failed to open segment list '%s'\n", seg->list);
296 if (seg->list_type == LIST_TYPE_M3U8 && seg->segment_list_entries) {
297 SegmentListEntry *entry;
298 double max_duration = 0;
300 avio_printf(seg->list_pb, "#EXTM3U\n");
301 avio_printf(seg->list_pb, "#EXT-X-VERSION:3\n");
302 avio_printf(seg->list_pb, "#EXT-X-MEDIA-SEQUENCE:%d\n", seg->segment_list_entries->index);
303 avio_printf(seg->list_pb, "#EXT-X-ALLOW-CACHE:%s\n",
304 seg->list_flags & SEGMENT_LIST_FLAG_CACHE ? "YES" : "NO");
306 av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%d\n",
307 seg->segment_list_entries->index);
309 for (entry = seg->segment_list_entries; entry; entry = entry->next)
310 max_duration = FFMAX(max_duration, entry->end_time - entry->start_time);
311 avio_printf(seg->list_pb, "#EXT-X-TARGETDURATION:%"PRId64"\n", (int64_t)ceil(max_duration));
312 } else if (seg->list_type == LIST_TYPE_FFCONCAT) {
313 avio_printf(seg->list_pb, "ffconcat version 1.0\n");
319 static void segment_list_print_entry(AVIOContext *list_ioctx,
321 const SegmentListEntry *list_entry,
326 avio_printf(list_ioctx, "%s\n", list_entry->filename);
330 print_csv_escaped_str(list_ioctx, list_entry->filename);
331 avio_printf(list_ioctx, ",%f,%f\n", list_entry->start_time, list_entry->end_time);
334 avio_printf(list_ioctx, "#EXTINF:%f,\n%s\n",
335 list_entry->end_time - list_entry->start_time, list_entry->filename);
337 case LIST_TYPE_FFCONCAT:
340 if (av_escape(&buf, list_entry->filename, NULL, AV_ESCAPE_MODE_AUTO, AV_ESCAPE_FLAG_WHITESPACE) < 0) {
341 av_log(log_ctx, AV_LOG_WARNING,
342 "Error writing list entry '%s' in list file\n", list_entry->filename);
345 avio_printf(list_ioctx, "file %s\n", buf);
350 av_assert0(!"Invalid list type");
354 static int segment_end(AVFormatContext *s, int write_trailer, int is_last)
356 SegmentContext *seg = s->priv_data;
357 AVFormatContext *oc = seg->avf;
361 AVDictionaryEntry *tcr;
362 char buf[AV_TIMECODE_STR_SIZE];
367 return AVERROR(EINVAL);
369 av_write_frame(oc, NULL); /* Flush any buffered data (fragmented mp4) */
371 ret = av_write_trailer(oc);
374 av_log(s, AV_LOG_ERROR, "Failure occurred when ending segment '%s'\n",
378 if (seg->list_size || seg->list_type == LIST_TYPE_M3U8) {
379 SegmentListEntry *entry = av_mallocz(sizeof(*entry));
381 ret = AVERROR(ENOMEM);
385 /* append new element */
386 memcpy(entry, &seg->cur_entry, sizeof(*entry));
387 entry->filename = av_strdup(entry->filename);
388 if (!seg->segment_list_entries)
389 seg->segment_list_entries = seg->segment_list_entries_end = entry;
391 seg->segment_list_entries_end->next = entry;
392 seg->segment_list_entries_end = entry;
394 /* drop first item */
395 if (seg->list_size && seg->segment_count >= seg->list_size) {
396 entry = seg->segment_list_entries;
397 seg->segment_list_entries = seg->segment_list_entries->next;
398 av_freep(&entry->filename);
402 if ((ret = segment_list_open(s)) < 0)
404 for (entry = seg->segment_list_entries; entry; entry = entry->next)
405 segment_list_print_entry(seg->list_pb, seg->list_type, entry, s);
406 if (seg->list_type == LIST_TYPE_M3U8 && is_last)
407 avio_printf(seg->list_pb, "#EXT-X-ENDLIST\n");
408 ff_format_io_close(s, &seg->list_pb);
410 ff_rename(seg->temp_list_filename, seg->list, s);
412 segment_list_print_entry(seg->list_pb, seg->list_type, &seg->cur_entry, s);
413 avio_flush(seg->list_pb);
417 av_log(s, AV_LOG_VERBOSE, "segment:'%s' count:%d ended\n",
418 seg->avf->url, seg->segment_count);
419 seg->segment_count++;
421 if (seg->increment_tc) {
422 tcr = av_dict_get(s->metadata, "timecode", NULL, 0);
424 /* search the first video stream */
425 for (i = 0; i < s->nb_streams; i++) {
426 if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
427 rate = s->streams[i]->avg_frame_rate;/* Get fps from the video stream */
428 err = av_timecode_init_from_string(&tc, rate, tcr->value, s);
430 av_log(s, AV_LOG_WARNING, "Could not increment global timecode, error occurred during timecode creation.\n");
433 tc.start += (int)((seg->cur_entry.end_time - seg->cur_entry.start_time) * av_q2d(rate));/* increment timecode */
434 av_dict_set(&s->metadata, "timecode",
435 av_timecode_make_string(&tc, buf, 0), 0);
440 av_log(s, AV_LOG_WARNING, "Could not increment global timecode, no global timecode metadata found.\n");
442 for (i = 0; i < s->nb_streams; i++) {
443 if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
444 char st_buf[AV_TIMECODE_STR_SIZE];
446 AVRational st_rate = s->streams[i]->avg_frame_rate;
447 AVDictionaryEntry *st_tcr = av_dict_get(s->streams[i]->metadata, "timecode", NULL, 0);
449 if ((av_timecode_init_from_string(&st_tc, st_rate, st_tcr->value, s) < 0)) {
450 av_log(s, AV_LOG_WARNING, "Could not increment stream %d timecode, error occurred during timecode creation.\n", i);
453 st_tc.start += (int)((seg->cur_entry.end_time - seg->cur_entry.start_time) * av_q2d(st_rate)); // increment timecode
454 av_dict_set(&s->streams[i]->metadata, "timecode", av_timecode_make_string(&st_tc, st_buf, 0), 0);
461 ff_format_io_close(oc, &oc->pb);
466 static int parse_times(void *log_ctx, int64_t **times, int *nb_times,
467 const char *times_str)
471 char *times_str1 = av_strdup(times_str);
472 char *saveptr = NULL;
475 return AVERROR(ENOMEM);
477 #define FAIL(err) ret = err; goto end
480 for (p = times_str1; *p; p++)
484 *times = av_malloc_array(*nb_times, sizeof(**times));
486 av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced times array\n");
487 FAIL(AVERROR(ENOMEM));
491 for (i = 0; i < *nb_times; i++) {
493 char *tstr = av_strtok(p, ",", &saveptr);
496 if (!tstr || !tstr[0]) {
497 av_log(log_ctx, AV_LOG_ERROR, "Empty time specification in times list %s\n",
499 FAIL(AVERROR(EINVAL));
502 ret = av_parse_time(&t, tstr, 1);
504 av_log(log_ctx, AV_LOG_ERROR,
505 "Invalid time duration specification '%s' in times list %s\n", tstr, times_str);
506 FAIL(AVERROR(EINVAL));
510 /* check on monotonicity */
511 if (i && (*times)[i-1] > (*times)[i]) {
512 av_log(log_ctx, AV_LOG_ERROR,
513 "Specified time %f is smaller than the last time %f\n",
514 (float)((*times)[i])/1000000, (float)((*times)[i-1])/1000000);
515 FAIL(AVERROR(EINVAL));
524 static int parse_frames(void *log_ctx, int **frames, int *nb_frames,
525 const char *frames_str)
531 for (p = frames_str; *p; p++)
535 *frames = av_malloc_array(*nb_frames, sizeof(**frames));
537 av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced frames array\n");
538 return AVERROR(ENOMEM);
542 for (i = 0; i < *nb_frames; i++) {
546 if (*p == '\0' || *p == ',') {
547 av_log(log_ctx, AV_LOG_ERROR, "Empty frame specification in frame list %s\n",
549 return AVERROR(EINVAL);
551 f = strtol(p, &tailptr, 10);
552 if (*tailptr != '\0' && *tailptr != ',' || f <= 0 || f >= INT_MAX) {
553 av_log(log_ctx, AV_LOG_ERROR,
554 "Invalid argument '%s', must be a positive integer < INT_MAX\n",
556 return AVERROR(EINVAL);
563 /* check on monotonicity */
564 if (i && (*frames)[i-1] > (*frames)[i]) {
565 av_log(log_ctx, AV_LOG_ERROR,
566 "Specified frame %d is smaller than the last frame %d\n",
567 (*frames)[i], (*frames)[i-1]);
568 return AVERROR(EINVAL);
575 static int open_null_ctx(AVIOContext **ctx)
577 int buf_size = 32768;
578 uint8_t *buf = av_malloc(buf_size);
580 return AVERROR(ENOMEM);
581 *ctx = avio_alloc_context(buf, buf_size, AVIO_FLAG_WRITE, NULL, NULL, NULL, NULL);
584 return AVERROR(ENOMEM);
589 static void close_null_ctxp(AVIOContext **pb)
591 av_freep(&(*pb)->buffer);
592 avio_context_free(pb);
595 static int select_reference_stream(AVFormatContext *s)
597 SegmentContext *seg = s->priv_data;
600 seg->reference_stream_index = -1;
601 if (!strcmp(seg->reference_stream_specifier, "auto")) {
602 /* select first index of type with highest priority */
603 int type_index_map[AVMEDIA_TYPE_NB];
604 static const enum AVMediaType type_priority_list[] = {
607 AVMEDIA_TYPE_SUBTITLE,
609 AVMEDIA_TYPE_ATTACHMENT
611 enum AVMediaType type;
613 for (i = 0; i < AVMEDIA_TYPE_NB; i++)
614 type_index_map[i] = -1;
616 /* select first index for each type */
617 for (i = 0; i < s->nb_streams; i++) {
618 type = s->streams[i]->codecpar->codec_type;
619 if ((unsigned)type < AVMEDIA_TYPE_NB && type_index_map[type] == -1
620 /* ignore attached pictures/cover art streams */
621 && !(s->streams[i]->disposition & AV_DISPOSITION_ATTACHED_PIC))
622 type_index_map[type] = i;
625 for (i = 0; i < FF_ARRAY_ELEMS(type_priority_list); i++) {
626 type = type_priority_list[i];
627 if ((seg->reference_stream_index = type_index_map[type]) >= 0)
631 for (i = 0; i < s->nb_streams; i++) {
632 ret = avformat_match_stream_specifier(s, s->streams[i],
633 seg->reference_stream_specifier);
637 seg->reference_stream_index = i;
643 if (seg->reference_stream_index < 0) {
644 av_log(s, AV_LOG_ERROR, "Could not select stream matching identifier '%s'\n",
645 seg->reference_stream_specifier);
646 return AVERROR(EINVAL);
652 static void seg_free(AVFormatContext *s)
654 SegmentContext *seg = s->priv_data;
655 SegmentListEntry *cur;
657 ff_format_io_close(s, &seg->list_pb);
660 close_null_ctxp(&seg->avf->pb);
662 ff_format_io_close(s, &seg->avf->pb);
663 avformat_free_context(seg->avf);
666 av_freep(&seg->times);
667 av_freep(&seg->frames);
668 av_freep(&seg->cur_entry.filename);
670 cur = seg->segment_list_entries;
672 SegmentListEntry *next = cur->next;
673 av_freep(&cur->filename);
679 static int seg_init(AVFormatContext *s)
681 SegmentContext *seg = s->priv_data;
682 AVFormatContext *oc = seg->avf;
683 AVDictionary *options = NULL;
687 seg->segment_count = 0;
688 if (!seg->write_header_trailer)
689 seg->individual_header_trailer = 0;
691 if (seg->header_filename) {
692 seg->write_header_trailer = 1;
693 seg->individual_header_trailer = 0;
696 if (seg->initial_offset > 0) {
697 av_log(s, AV_LOG_WARNING, "NOTE: the option initial_offset is deprecated,"
698 "you can use output_ts_offset instead of it\n");
701 if ((seg->time != 2000000) + !!seg->times_str + !!seg->frames_str > 1) {
702 av_log(s, AV_LOG_ERROR,
703 "segment_time, segment_times, and segment_frames options "
704 "are mutually exclusive, select just one of them\n");
705 return AVERROR(EINVAL);
708 if (seg->times_str) {
709 if ((ret = parse_times(s, &seg->times, &seg->nb_times, seg->times_str)) < 0)
711 } else if (seg->frames_str) {
712 if ((ret = parse_frames(s, &seg->frames, &seg->nb_frames, seg->frames_str)) < 0)
715 if (seg->use_clocktime) {
716 if (seg->time <= 0) {
717 av_log(s, AV_LOG_ERROR, "Invalid negative segment_time with segment_atclocktime option set\n");
718 return AVERROR(EINVAL);
720 seg->clocktime_offset = seg->time - (seg->clocktime_offset % seg->time);
725 if (seg->list_type == LIST_TYPE_UNDEFINED) {
726 if (av_match_ext(seg->list, "csv" )) seg->list_type = LIST_TYPE_CSV;
727 else if (av_match_ext(seg->list, "ext" )) seg->list_type = LIST_TYPE_EXT;
728 else if (av_match_ext(seg->list, "m3u8")) seg->list_type = LIST_TYPE_M3U8;
729 else if (av_match_ext(seg->list, "ffcat,ffconcat")) seg->list_type = LIST_TYPE_FFCONCAT;
730 else seg->list_type = LIST_TYPE_FLAT;
732 if (!seg->list_size && seg->list_type != LIST_TYPE_M3U8) {
733 if ((ret = segment_list_open(s)) < 0)
736 const char *proto = avio_find_protocol_name(seg->list);
737 seg->use_rename = proto && !strcmp(proto, "file");
741 if (seg->list_type == LIST_TYPE_EXT)
742 av_log(s, AV_LOG_WARNING, "'ext' list type option is deprecated in favor of 'csv'\n");
744 if ((ret = select_reference_stream(s)) < 0)
746 av_log(s, AV_LOG_VERBOSE, "Selected stream id:%d type:%s\n",
747 seg->reference_stream_index,
748 av_get_media_type_string(s->streams[seg->reference_stream_index]->codecpar->codec_type));
750 seg->oformat = av_guess_format(seg->format, s->url, NULL);
753 return AVERROR_MUXER_NOT_FOUND;
754 if (seg->oformat->flags & AVFMT_NOFILE) {
755 av_log(s, AV_LOG_ERROR, "format %s not supported.\n",
757 return AVERROR(EINVAL);
760 if ((ret = segment_mux_init(s)) < 0)
763 if ((ret = set_segment_filename(s)) < 0)
767 if (seg->write_header_trailer) {
768 if ((ret = s->io_open(s, &oc->pb,
769 seg->header_filename ? seg->header_filename : oc->url,
770 AVIO_FLAG_WRITE, NULL)) < 0) {
771 av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->url);
774 if (!seg->individual_header_trailer)
775 oc->pb->seekable = 0;
777 if ((ret = open_null_ctx(&oc->pb)) < 0)
782 av_dict_copy(&options, seg->format_options, 0);
783 av_dict_set(&options, "fflags", "-autobsf", 0);
784 ret = avformat_init_output(oc, &options);
785 if (av_dict_count(options)) {
786 av_log(s, AV_LOG_ERROR,
787 "Some of the provided format options are not recognized\n");
788 av_dict_free(&options);
789 return AVERROR(EINVAL);
791 av_dict_free(&options);
796 seg->segment_frame_count = 0;
798 av_assert0(s->nb_streams == oc->nb_streams);
799 if (ret == AVSTREAM_INIT_IN_WRITE_HEADER) {
800 ret = avformat_write_header(oc, NULL);
803 seg->header_written = 1;
806 for (i = 0; i < s->nb_streams; i++) {
807 AVStream *inner_st = oc->streams[i];
808 AVStream *outer_st = s->streams[i];
809 avpriv_set_pts_info(outer_st, inner_st->pts_wrap_bits, inner_st->time_base.num, inner_st->time_base.den);
812 if (oc->avoid_negative_ts > 0 && s->avoid_negative_ts < 0)
813 s->avoid_negative_ts = 1;
818 static int seg_write_header(AVFormatContext *s)
820 SegmentContext *seg = s->priv_data;
821 AVFormatContext *oc = seg->avf;
824 if (!seg->header_written) {
825 ret = avformat_write_header(oc, NULL);
830 if (!seg->write_header_trailer || seg->header_filename) {
831 if (seg->header_filename) {
832 av_write_frame(oc, NULL);
833 ff_format_io_close(oc, &oc->pb);
835 close_null_ctxp(&oc->pb);
838 if ((ret = oc->io_open(oc, &oc->pb, oc->url, AVIO_FLAG_WRITE, NULL)) < 0)
840 if (!seg->individual_header_trailer)
841 oc->pb->seekable = 0;
847 static int seg_write_packet(AVFormatContext *s, AVPacket *pkt)
849 SegmentContext *seg = s->priv_data;
850 AVStream *st = s->streams[pkt->stream_index];
851 int64_t end_pts = INT64_MAX, offset;
852 int start_frame = INT_MAX;
858 if (!seg->avf || !seg->avf->pb)
859 return AVERROR(EINVAL);
861 if (!st->codecpar->extradata_size) {
862 buffer_size_t pkt_extradata_size;
863 uint8_t *pkt_extradata = av_packet_get_side_data(pkt, AV_PKT_DATA_NEW_EXTRADATA, &pkt_extradata_size);
864 if (pkt_extradata && pkt_extradata_size > 0) {
865 ret = ff_alloc_extradata(st->codecpar, pkt_extradata_size);
867 av_log(s, AV_LOG_WARNING, "Unable to add extradata to stream. Output segments may be invalid.\n");
870 memcpy(st->codecpar->extradata, pkt_extradata, pkt_extradata_size);
876 end_pts = seg->segment_count < seg->nb_times ?
877 seg->times[seg->segment_count] : INT64_MAX;
878 } else if (seg->frames) {
879 start_frame = seg->segment_count < seg->nb_frames ?
880 seg->frames[seg->segment_count] : INT_MAX;
882 if (seg->use_clocktime) {
883 int64_t avgt = av_gettime();
884 time_t sec = avgt / 1000000;
885 localtime_r(&sec, &ti);
886 usecs = (int64_t)(ti.tm_hour * 3600 + ti.tm_min * 60 + ti.tm_sec) * 1000000 + (avgt % 1000000);
887 wrapped_val = (usecs + seg->clocktime_offset) % seg->time;
888 if (wrapped_val < seg->last_val && wrapped_val < seg->clocktime_wrap_duration)
889 seg->cut_pending = 1;
890 seg->last_val = wrapped_val;
892 end_pts = seg->time * (seg->segment_count + 1);
896 ff_dlog(s, "packet stream:%d pts:%s pts_time:%s duration_time:%s is_key:%d frame:%d\n",
897 pkt->stream_index, av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
898 av_ts2timestr(pkt->duration, &st->time_base),
899 pkt->flags & AV_PKT_FLAG_KEY,
900 pkt->stream_index == seg->reference_stream_index ? seg->frame_count : -1);
902 if (pkt->stream_index == seg->reference_stream_index &&
903 (pkt->flags & AV_PKT_FLAG_KEY || seg->break_non_keyframes) &&
904 (seg->segment_frame_count > 0 || seg->write_empty) &&
905 (seg->cut_pending || seg->frame_count >= start_frame ||
906 (pkt->pts != AV_NOPTS_VALUE &&
907 av_compare_ts(pkt->pts, st->time_base,
908 end_pts - seg->time_delta, AV_TIME_BASE_Q) >= 0))) {
909 /* sanitize end time in case last packet didn't have a defined duration */
910 if (seg->cur_entry.last_duration == 0)
911 seg->cur_entry.end_time = (double)pkt->pts * av_q2d(st->time_base);
913 if ((ret = segment_end(s, seg->individual_header_trailer, 0)) < 0)
916 if ((ret = segment_start(s, seg->individual_header_trailer)) < 0)
919 seg->cut_pending = 0;
920 seg->cur_entry.index = seg->segment_idx + seg->segment_idx_wrap * seg->segment_idx_wrap_nb;
921 seg->cur_entry.start_time = (double)pkt->pts * av_q2d(st->time_base);
922 seg->cur_entry.start_pts = av_rescale_q(pkt->pts, st->time_base, AV_TIME_BASE_Q);
923 seg->cur_entry.end_time = seg->cur_entry.start_time;
925 if (seg->times || (!seg->frames && !seg->use_clocktime) && seg->write_empty)
929 if (pkt->stream_index == seg->reference_stream_index) {
930 if (pkt->pts != AV_NOPTS_VALUE)
931 seg->cur_entry.end_time =
932 FFMAX(seg->cur_entry.end_time, (double)(pkt->pts + pkt->duration) * av_q2d(st->time_base));
933 seg->cur_entry.last_duration = pkt->duration;
936 if (seg->segment_frame_count == 0) {
937 av_log(s, AV_LOG_VERBOSE, "segment:'%s' starts with packet stream:%d pts:%s pts_time:%s frame:%d\n",
938 seg->avf->url, pkt->stream_index,
939 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base), seg->frame_count);
942 av_log(s, AV_LOG_DEBUG, "stream:%d start_pts_time:%s pts:%s pts_time:%s dts:%s dts_time:%s",
944 av_ts2timestr(seg->cur_entry.start_pts, &AV_TIME_BASE_Q),
945 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
946 av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
948 /* compute new timestamps */
949 offset = av_rescale_q(seg->initial_offset - (seg->reset_timestamps ? seg->cur_entry.start_pts : 0),
950 AV_TIME_BASE_Q, st->time_base);
951 if (pkt->pts != AV_NOPTS_VALUE)
953 if (pkt->dts != AV_NOPTS_VALUE)
956 av_log(s, AV_LOG_DEBUG, " -> pts:%s pts_time:%s dts:%s dts_time:%s\n",
957 av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
958 av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
960 ret = ff_write_chained(seg->avf, pkt->stream_index, pkt, s,
961 seg->initial_offset || seg->reset_timestamps || seg->avf->oformat->interleave_packet);
964 if (pkt->stream_index == seg->reference_stream_index) {
966 seg->segment_frame_count++;
972 static int seg_write_trailer(struct AVFormatContext *s)
974 SegmentContext *seg = s->priv_data;
975 AVFormatContext *oc = seg->avf;
981 if (!seg->write_header_trailer) {
982 if ((ret = segment_end(s, 0, 1)) < 0)
984 if ((ret = open_null_ctx(&oc->pb)) < 0)
987 ret = av_write_trailer(oc);
989 ret = segment_end(s, 1, 1);
994 static int seg_check_bitstream(struct AVFormatContext *s, const AVPacket *pkt)
996 SegmentContext *seg = s->priv_data;
997 AVFormatContext *oc = seg->avf;
998 if (oc->oformat->check_bitstream) {
999 int ret = oc->oformat->check_bitstream(oc, pkt);
1001 AVStream *st = s->streams[pkt->stream_index];
1002 AVStream *ost = oc->streams[pkt->stream_index];
1003 st->internal->bsfc = ost->internal->bsfc;
1004 ost->internal->bsfc = NULL;
1011 #define OFFSET(x) offsetof(SegmentContext, x)
1012 #define E AV_OPT_FLAG_ENCODING_PARAM
1013 static const AVOption options[] = {
1014 { "reference_stream", "set reference stream", OFFSET(reference_stream_specifier), AV_OPT_TYPE_STRING, {.str = "auto"}, 0, 0, E },
1015 { "segment_format", "set container format used for the segments", OFFSET(format), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1016 { "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 },
1017 { "segment_list", "set the segment list filename", OFFSET(list), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1018 { "segment_header_filename", "write a single file containing the header", OFFSET(header_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1020 { "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"},
1021 { "cache", "allow list caching", 0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_LIST_FLAG_CACHE }, INT_MIN, INT_MAX, E, "list_flags"},
1022 { "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"},
1024 { "segment_list_size", "set the maximum number of playlist entries", OFFSET(list_size), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1026 { "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" },
1027 { "flat", "flat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FLAT }, INT_MIN, INT_MAX, E, "list_type" },
1028 { "csv", "csv format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_CSV }, INT_MIN, INT_MAX, E, "list_type" },
1029 { "ext", "extended format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_EXT }, INT_MIN, INT_MAX, E, "list_type" },
1030 { "ffconcat", "ffconcat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FFCONCAT }, INT_MIN, INT_MAX, E, "list_type" },
1031 { "m3u8", "M3U8 format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
1032 { "hls", "Apple HTTP Live Streaming compatible", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
1034 { "segment_atclocktime", "set segment to be cut at clocktime", OFFSET(use_clocktime), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E},
1035 { "segment_clocktime_offset", "set segment clocktime offset", OFFSET(clocktime_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, 86400000000LL, E},
1036 { "segment_clocktime_wrap_duration", "set segment clocktime wrapping duration", OFFSET(clocktime_wrap_duration), AV_OPT_TYPE_DURATION, {.i64 = INT64_MAX}, 0, INT64_MAX, E},
1037 { "segment_time", "set segment duration", OFFSET(time),AV_OPT_TYPE_DURATION, {.i64 = 2000000}, INT64_MIN, INT64_MAX, E },
1038 { "segment_time_delta","set approximation value used for the segment times", OFFSET(time_delta), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, INT64_MAX, E },
1039 { "segment_times", "set segment split time points", OFFSET(times_str),AV_OPT_TYPE_STRING,{.str = NULL}, 0, 0, E },
1040 { "segment_frames", "set segment split frame numbers", OFFSET(frames_str),AV_OPT_TYPE_STRING,{.str = NULL}, 0, 0, E },
1041 { "segment_wrap", "set number after which the index wraps", OFFSET(segment_idx_wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1042 { "segment_list_entry_prefix", "set base url prefix for segments", OFFSET(entry_prefix), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1043 { "segment_start_number", "set the sequence number of the first segment", OFFSET(segment_idx), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1044 { "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 },
1045 { "strftime", "set filename expansion with strftime at segment creation", OFFSET(use_strftime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1046 { "increment_tc", "increment timecode between each segment", OFFSET(increment_tc), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1047 { "break_non_keyframes", "allow breaking segments on non-keyframes", OFFSET(break_non_keyframes), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1049 { "individual_header_trailer", "write header/trailer to each segment", OFFSET(individual_header_trailer), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, E },
1050 { "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 },
1051 { "reset_timestamps", "reset timestamps at the beginning of each segment", OFFSET(reset_timestamps), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1052 { "initial_offset", "set initial timestamp offset", OFFSET(initial_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, -INT64_MAX, INT64_MAX, E },
1053 { "write_empty_segments", "allow writing empty 'filler' segments", OFFSET(write_empty), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1057 #if CONFIG_SEGMENT_MUXER
1058 static const AVClass seg_class = {
1059 .class_name = "segment muxer",
1060 .item_name = av_default_item_name,
1062 .version = LIBAVUTIL_VERSION_INT,
1065 AVOutputFormat ff_segment_muxer = {
1067 .long_name = NULL_IF_CONFIG_SMALL("segment"),
1068 .priv_data_size = sizeof(SegmentContext),
1069 .flags = AVFMT_NOFILE|AVFMT_GLOBALHEADER,
1071 .write_header = seg_write_header,
1072 .write_packet = seg_write_packet,
1073 .write_trailer = seg_write_trailer,
1075 .check_bitstream = seg_check_bitstream,
1076 .priv_class = &seg_class,
1080 #if CONFIG_STREAM_SEGMENT_MUXER
1081 static const AVClass sseg_class = {
1082 .class_name = "stream_segment muxer",
1083 .item_name = av_default_item_name,
1085 .version = LIBAVUTIL_VERSION_INT,
1088 AVOutputFormat ff_stream_segment_muxer = {
1089 .name = "stream_segment,ssegment",
1090 .long_name = NULL_IF_CONFIG_SMALL("streaming segment muxer"),
1091 .priv_data_size = sizeof(SegmentContext),
1092 .flags = AVFMT_NOFILE,
1094 .write_header = seg_write_header,
1095 .write_packet = seg_write_packet,
1096 .write_trailer = seg_write_trailer,
1098 .check_bitstream = seg_check_bitstream,
1099 .priv_class = &sseg_class,