]> git.sesse.net Git - ffmpeg/blob - libavformat/segment.c
74106445e6ef0a66dcf86ec49c50a3ff6bf2a3ac
[ffmpeg] / libavformat / segment.c
1 /*
2  * Copyright (c) 2011, Luca Barbato
3  *
4  * This file is part of FFmpeg.
5  *
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.
10  *
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.
15  *
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
19  */
20
21 /**
22  * @file generic segmenter
23  * M3U8 specification can be find here:
24  * @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}
25  */
26
27 #include <float.h>
28 #include <time.h>
29
30 #include "avformat.h"
31 #include "avio_internal.h"
32 #include "internal.h"
33
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"
45
46 typedef struct SegmentListEntry {
47     int index;
48     double start_time, end_time;
49     int64_t start_pts;
50     int64_t offset_pts;
51     char *filename;
52     struct SegmentListEntry *next;
53     int64_t last_duration;
54 } SegmentListEntry;
55
56 typedef enum {
57     LIST_TYPE_UNDEFINED = -1,
58     LIST_TYPE_FLAT = 0,
59     LIST_TYPE_CSV,
60     LIST_TYPE_M3U8,
61     LIST_TYPE_EXT, ///< deprecated
62     LIST_TYPE_FFCONCAT,
63     LIST_TYPE_NB,
64 } ListType;
65
66 #define SEGMENT_LIST_FLAG_CACHE 1
67 #define SEGMENT_LIST_FLAG_LIVE  2
68
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     const AVOutputFormat *oformat;
76     AVFormatContext *avf;
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
82
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
88     int cut_pending;
89     int header_written;    ///< whether we've already called avformat_write_header
90
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
97
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
101
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
107
108     int64_t time_delta;
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
112
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;
118     int   write_empty;
119
120     int use_rename;
121     char temp_list_filename[1024];
122
123     SegmentListEntry cur_entry;
124     SegmentListEntry *segment_list_entries;
125     SegmentListEntry *segment_list_entries_end;
126 } SegmentContext;
127
128 static void print_csv_escaped_str(AVIOContext *ctx, const char *str)
129 {
130     int needs_quoting = !!str[strcspn(str, "\",\n\r")];
131
132     if (needs_quoting)
133         avio_w8(ctx, '"');
134
135     for (; *str; str++) {
136         if (*str == '"')
137             avio_w8(ctx, '"');
138         avio_w8(ctx, *str);
139     }
140     if (needs_quoting)
141         avio_w8(ctx, '"');
142 }
143
144 static int segment_mux_init(AVFormatContext *s)
145 {
146     SegmentContext *seg = s->priv_data;
147     AVFormatContext *oc;
148     int i;
149     int ret;
150
151     ret = avformat_alloc_output_context2(&seg->avf, seg->oformat, NULL, NULL);
152     if (ret < 0)
153         return ret;
154     oc = seg->avf;
155
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;
163
164     for (i = 0; i < s->nb_streams; i++) {
165         AVStream *st, *ist = s->streams[i];
166         AVCodecParameters *ipar = ist->codecpar, *opar;
167
168         if (!(st = avformat_new_stream(oc, NULL)))
169             return AVERROR(ENOMEM);
170         ret = ff_stream_encode_params_copy(st, ist);
171         if (ret < 0)
172             return ret;
173         opar = st->codecpar;
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;
178         } else {
179             opar->codec_tag = 0;
180         }
181     }
182
183     return 0;
184 }
185
186 static int set_segment_filename(AVFormatContext *s)
187 {
188     SegmentContext *seg = s->priv_data;
189     AVFormatContext *oc = seg->avf;
190     size_t size;
191     int ret;
192     char buf[1024];
193     char *new_name;
194
195     if (seg->segment_idx_wrap)
196         seg->segment_idx %= seg->segment_idx_wrap;
197     if (seg->use_strftime) {
198         time_t now0;
199         struct tm *tm, tmpbuf;
200         time(&now0);
201         tm = localtime_r(&now0, &tmpbuf);
202         if (!strftime(buf, sizeof(buf), s->url, tm)) {
203             av_log(oc, AV_LOG_ERROR, "Could not get segment filename with strftime\n");
204             return AVERROR(EINVAL);
205         }
206     } else if (av_get_frame_filename(buf, sizeof(buf),
207                                      s->url, seg->segment_idx) < 0) {
208         av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", s->url);
209         return AVERROR(EINVAL);
210     }
211     new_name = av_strdup(buf);
212     if (!new_name)
213         return AVERROR(ENOMEM);
214     ff_format_set_url(oc, new_name);
215
216     /* copy modified name in list entry */
217     size = strlen(av_basename(oc->url)) + 1;
218     if (seg->entry_prefix)
219         size += strlen(seg->entry_prefix);
220
221     if ((ret = av_reallocp(&seg->cur_entry.filename, size)) < 0)
222         return ret;
223     snprintf(seg->cur_entry.filename, size, "%s%s",
224              seg->entry_prefix ? seg->entry_prefix : "",
225              av_basename(oc->url));
226
227     return 0;
228 }
229
230 static int segment_start(AVFormatContext *s, int write_header)
231 {
232     SegmentContext *seg = s->priv_data;
233     AVFormatContext *oc = seg->avf;
234     int err = 0;
235
236     if (write_header) {
237         avformat_free_context(oc);
238         seg->avf = NULL;
239         if ((err = segment_mux_init(s)) < 0)
240             return err;
241         oc = seg->avf;
242     }
243
244     seg->segment_idx++;
245     if ((seg->segment_idx_wrap) && (seg->segment_idx % seg->segment_idx_wrap == 0))
246         seg->segment_idx_wrap_nb++;
247
248     if ((err = set_segment_filename(s)) < 0)
249         return err;
250
251     if ((err = s->io_open(s, &oc->pb, oc->url, AVIO_FLAG_WRITE, NULL)) < 0) {
252         av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->url);
253         return err;
254     }
255     if (!seg->individual_header_trailer)
256         oc->pb->seekable = 0;
257
258     if (oc->oformat->priv_class && oc->priv_data)
259         av_opt_set(oc->priv_data, "mpegts_flags", "+resend_headers", 0);
260
261     if (write_header) {
262         AVDictionary *options = NULL;
263         av_dict_copy(&options, seg->format_options, 0);
264         av_dict_set(&options, "fflags", "-autobsf", 0);
265         err = avformat_write_header(oc, &options);
266         av_dict_free(&options);
267         if (err < 0)
268             return err;
269     }
270
271     seg->segment_frame_count = 0;
272     return 0;
273 }
274
275 static int segment_list_open(AVFormatContext *s)
276 {
277     SegmentContext *seg = s->priv_data;
278     int ret;
279
280     snprintf(seg->temp_list_filename, sizeof(seg->temp_list_filename), seg->use_rename ? "%s.tmp" : "%s", seg->list);
281     ret = s->io_open(s, &seg->list_pb, seg->temp_list_filename, AVIO_FLAG_WRITE, NULL);
282     if (ret < 0) {
283         av_log(s, AV_LOG_ERROR, "Failed to open segment list '%s'\n", seg->list);
284         return ret;
285     }
286
287     if (seg->list_type == LIST_TYPE_M3U8 && seg->segment_list_entries) {
288         SegmentListEntry *entry;
289         double max_duration = 0;
290
291         avio_printf(seg->list_pb, "#EXTM3U\n");
292         avio_printf(seg->list_pb, "#EXT-X-VERSION:3\n");
293         avio_printf(seg->list_pb, "#EXT-X-MEDIA-SEQUENCE:%d\n", seg->segment_list_entries->index);
294         avio_printf(seg->list_pb, "#EXT-X-ALLOW-CACHE:%s\n",
295                     seg->list_flags & SEGMENT_LIST_FLAG_CACHE ? "YES" : "NO");
296
297         av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%d\n",
298                seg->segment_list_entries->index);
299
300         for (entry = seg->segment_list_entries; entry; entry = entry->next)
301             max_duration = FFMAX(max_duration, entry->end_time - entry->start_time);
302         avio_printf(seg->list_pb, "#EXT-X-TARGETDURATION:%"PRId64"\n", (int64_t)ceil(max_duration));
303     } else if (seg->list_type == LIST_TYPE_FFCONCAT) {
304         avio_printf(seg->list_pb, "ffconcat version 1.0\n");
305     }
306
307     return ret;
308 }
309
310 static void segment_list_print_entry(AVIOContext      *list_ioctx,
311                                      ListType          list_type,
312                                      const SegmentListEntry *list_entry,
313                                      void *log_ctx)
314 {
315     switch (list_type) {
316     case LIST_TYPE_FLAT:
317         avio_printf(list_ioctx, "%s\n", list_entry->filename);
318         break;
319     case LIST_TYPE_CSV:
320     case LIST_TYPE_EXT:
321         print_csv_escaped_str(list_ioctx, list_entry->filename);
322         avio_printf(list_ioctx, ",%f,%f\n", list_entry->start_time, list_entry->end_time);
323         break;
324     case LIST_TYPE_M3U8:
325         avio_printf(list_ioctx, "#EXTINF:%f,\n%s\n",
326                     list_entry->end_time - list_entry->start_time, list_entry->filename);
327         break;
328     case LIST_TYPE_FFCONCAT:
329     {
330         char *buf;
331         if (av_escape(&buf, list_entry->filename, NULL, AV_ESCAPE_MODE_AUTO, AV_ESCAPE_FLAG_WHITESPACE) < 0) {
332             av_log(log_ctx, AV_LOG_WARNING,
333                    "Error writing list entry '%s' in list file\n", list_entry->filename);
334             return;
335         }
336         avio_printf(list_ioctx, "file %s\n", buf);
337         av_free(buf);
338         break;
339     }
340     default:
341         av_assert0(!"Invalid list type");
342     }
343 }
344
345 static int segment_end(AVFormatContext *s, int write_trailer, int is_last)
346 {
347     SegmentContext *seg = s->priv_data;
348     AVFormatContext *oc = seg->avf;
349     int ret = 0;
350     AVTimecode tc;
351     AVRational rate;
352     AVDictionaryEntry *tcr;
353     char buf[AV_TIMECODE_STR_SIZE];
354     int i;
355     int err;
356
357     if (!oc || !oc->pb)
358         return AVERROR(EINVAL);
359
360     av_write_frame(oc, NULL); /* Flush any buffered data (fragmented mp4) */
361     if (write_trailer)
362         ret = av_write_trailer(oc);
363
364     if (ret < 0)
365         av_log(s, AV_LOG_ERROR, "Failure occurred when ending segment '%s'\n",
366                oc->url);
367
368     if (seg->list) {
369         if (seg->list_size || seg->list_type == LIST_TYPE_M3U8) {
370             SegmentListEntry *entry = av_mallocz(sizeof(*entry));
371             if (!entry) {
372                 ret = AVERROR(ENOMEM);
373                 goto end;
374             }
375
376             /* append new element */
377             memcpy(entry, &seg->cur_entry, sizeof(*entry));
378             entry->filename = av_strdup(entry->filename);
379             if (!seg->segment_list_entries)
380                 seg->segment_list_entries = seg->segment_list_entries_end = entry;
381             else
382                 seg->segment_list_entries_end->next = entry;
383             seg->segment_list_entries_end = entry;
384
385             /* drop first item */
386             if (seg->list_size && seg->segment_count >= seg->list_size) {
387                 entry = seg->segment_list_entries;
388                 seg->segment_list_entries = seg->segment_list_entries->next;
389                 av_freep(&entry->filename);
390                 av_freep(&entry);
391             }
392
393             if ((ret = segment_list_open(s)) < 0)
394                 goto end;
395             for (entry = seg->segment_list_entries; entry; entry = entry->next)
396                 segment_list_print_entry(seg->list_pb, seg->list_type, entry, s);
397             if (seg->list_type == LIST_TYPE_M3U8 && is_last)
398                 avio_printf(seg->list_pb, "#EXT-X-ENDLIST\n");
399             ff_format_io_close(s, &seg->list_pb);
400             if (seg->use_rename)
401                 ff_rename(seg->temp_list_filename, seg->list, s);
402         } else {
403             segment_list_print_entry(seg->list_pb, seg->list_type, &seg->cur_entry, s);
404             avio_flush(seg->list_pb);
405         }
406     }
407
408     av_log(s, AV_LOG_VERBOSE, "segment:'%s' count:%d ended\n",
409            seg->avf->url, seg->segment_count);
410     seg->segment_count++;
411
412     if (seg->increment_tc) {
413         tcr = av_dict_get(s->metadata, "timecode", NULL, 0);
414         if (tcr) {
415             /* search the first video stream */
416             for (i = 0; i < s->nb_streams; i++) {
417                 if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
418                     rate = s->streams[i]->avg_frame_rate;/* Get fps from the video stream */
419                     err = av_timecode_init_from_string(&tc, rate, tcr->value, s);
420                     if (err < 0) {
421                         av_log(s, AV_LOG_WARNING, "Could not increment global timecode, error occurred during timecode creation.\n");
422                         break;
423                     }
424                     tc.start += (int)((seg->cur_entry.end_time - seg->cur_entry.start_time) * av_q2d(rate));/* increment timecode */
425                     av_dict_set(&s->metadata, "timecode",
426                                 av_timecode_make_string(&tc, buf, 0), 0);
427                     break;
428                 }
429             }
430         } else {
431             av_log(s, AV_LOG_WARNING, "Could not increment global timecode, no global timecode metadata found.\n");
432         }
433         for (i = 0; i < s->nb_streams; i++) {
434             if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
435                 char st_buf[AV_TIMECODE_STR_SIZE];
436                 AVTimecode st_tc;
437                 AVRational st_rate = s->streams[i]->avg_frame_rate;
438                 AVDictionaryEntry *st_tcr = av_dict_get(s->streams[i]->metadata, "timecode", NULL, 0);
439                 if (st_tcr) {
440                     if ((av_timecode_init_from_string(&st_tc, st_rate, st_tcr->value, s) < 0)) {
441                         av_log(s, AV_LOG_WARNING, "Could not increment stream %d timecode, error occurred during timecode creation.\n", i);
442                         continue;
443                     }
444                 st_tc.start += (int)((seg->cur_entry.end_time - seg->cur_entry.start_time) * av_q2d(st_rate));    // increment timecode
445                 av_dict_set(&s->streams[i]->metadata, "timecode", av_timecode_make_string(&st_tc, st_buf, 0), 0);
446                 }
447             }
448         }
449     }
450
451 end:
452     ff_format_io_close(oc, &oc->pb);
453
454     return ret;
455 }
456
457 static int parse_times(void *log_ctx, int64_t **times, int *nb_times,
458                        const char *times_str)
459 {
460     char *p;
461     int i, ret = 0;
462     char *times_str1 = av_strdup(times_str);
463     char *saveptr = NULL;
464
465     if (!times_str1)
466         return AVERROR(ENOMEM);
467
468 #define FAIL(err) ret = err; goto end
469
470     *nb_times = 1;
471     for (p = times_str1; *p; p++)
472         if (*p == ',')
473             (*nb_times)++;
474
475     *times = av_malloc_array(*nb_times, sizeof(**times));
476     if (!*times) {
477         av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced times array\n");
478         FAIL(AVERROR(ENOMEM));
479     }
480
481     p = times_str1;
482     for (i = 0; i < *nb_times; i++) {
483         int64_t t;
484         char *tstr = av_strtok(p, ",", &saveptr);
485         p = NULL;
486
487         if (!tstr || !tstr[0]) {
488             av_log(log_ctx, AV_LOG_ERROR, "Empty time specification in times list %s\n",
489                    times_str);
490             FAIL(AVERROR(EINVAL));
491         }
492
493         ret = av_parse_time(&t, tstr, 1);
494         if (ret < 0) {
495             av_log(log_ctx, AV_LOG_ERROR,
496                    "Invalid time duration specification '%s' in times list %s\n", tstr, times_str);
497             FAIL(AVERROR(EINVAL));
498         }
499         (*times)[i] = t;
500
501         /* check on monotonicity */
502         if (i && (*times)[i-1] > (*times)[i]) {
503             av_log(log_ctx, AV_LOG_ERROR,
504                    "Specified time %f is smaller than the last time %f\n",
505                    (float)((*times)[i])/1000000, (float)((*times)[i-1])/1000000);
506             FAIL(AVERROR(EINVAL));
507         }
508     }
509
510 end:
511     av_free(times_str1);
512     return ret;
513 }
514
515 static int parse_frames(void *log_ctx, int **frames, int *nb_frames,
516                         const char *frames_str)
517 {
518     const char *p;
519     int i;
520
521     *nb_frames = 1;
522     for (p = frames_str; *p; p++)
523         if (*p == ',')
524             (*nb_frames)++;
525
526     *frames = av_malloc_array(*nb_frames, sizeof(**frames));
527     if (!*frames) {
528         av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced frames array\n");
529         return AVERROR(ENOMEM);
530     }
531
532     p = frames_str;
533     for (i = 0; i < *nb_frames; i++) {
534         long int f;
535         char *tailptr;
536
537         if (*p == '\0' || *p == ',') {
538             av_log(log_ctx, AV_LOG_ERROR, "Empty frame specification in frame list %s\n",
539                    frames_str);
540             return AVERROR(EINVAL);
541         }
542         f = strtol(p, &tailptr, 10);
543         if (*tailptr != '\0' && *tailptr != ',' || f <= 0 || f >= INT_MAX) {
544             av_log(log_ctx, AV_LOG_ERROR,
545                    "Invalid argument '%s', must be a positive integer < INT_MAX\n",
546                    p);
547             return AVERROR(EINVAL);
548         }
549         if (*tailptr == ',')
550             tailptr++;
551         p = tailptr;
552         (*frames)[i] = f;
553
554         /* check on monotonicity */
555         if (i && (*frames)[i-1] > (*frames)[i]) {
556             av_log(log_ctx, AV_LOG_ERROR,
557                    "Specified frame %d is smaller than the last frame %d\n",
558                    (*frames)[i], (*frames)[i-1]);
559             return AVERROR(EINVAL);
560         }
561     }
562
563     return 0;
564 }
565
566 static int open_null_ctx(AVIOContext **ctx)
567 {
568     int buf_size = 32768;
569     uint8_t *buf = av_malloc(buf_size);
570     if (!buf)
571         return AVERROR(ENOMEM);
572     *ctx = avio_alloc_context(buf, buf_size, AVIO_FLAG_WRITE, NULL, NULL, NULL, NULL);
573     if (!*ctx) {
574         av_free(buf);
575         return AVERROR(ENOMEM);
576     }
577     return 0;
578 }
579
580 static void close_null_ctxp(AVIOContext **pb)
581 {
582     av_freep(&(*pb)->buffer);
583     avio_context_free(pb);
584 }
585
586 static int select_reference_stream(AVFormatContext *s)
587 {
588     SegmentContext *seg = s->priv_data;
589     int ret, i;
590
591     seg->reference_stream_index = -1;
592     if (!strcmp(seg->reference_stream_specifier, "auto")) {
593         /* select first index of type with highest priority */
594         int type_index_map[AVMEDIA_TYPE_NB];
595         static const enum AVMediaType type_priority_list[] = {
596             AVMEDIA_TYPE_VIDEO,
597             AVMEDIA_TYPE_AUDIO,
598             AVMEDIA_TYPE_SUBTITLE,
599             AVMEDIA_TYPE_DATA,
600             AVMEDIA_TYPE_ATTACHMENT
601         };
602         enum AVMediaType type;
603
604         for (i = 0; i < AVMEDIA_TYPE_NB; i++)
605             type_index_map[i] = -1;
606
607         /* select first index for each type */
608         for (i = 0; i < s->nb_streams; i++) {
609             type = s->streams[i]->codecpar->codec_type;
610             if ((unsigned)type < AVMEDIA_TYPE_NB && type_index_map[type] == -1
611                 /* ignore attached pictures/cover art streams */
612                 && !(s->streams[i]->disposition & AV_DISPOSITION_ATTACHED_PIC))
613                 type_index_map[type] = i;
614         }
615
616         for (i = 0; i < FF_ARRAY_ELEMS(type_priority_list); i++) {
617             type = type_priority_list[i];
618             if ((seg->reference_stream_index = type_index_map[type]) >= 0)
619                 break;
620         }
621     } else {
622         for (i = 0; i < s->nb_streams; i++) {
623             ret = avformat_match_stream_specifier(s, s->streams[i],
624                                                   seg->reference_stream_specifier);
625             if (ret < 0)
626                 return ret;
627             if (ret > 0) {
628                 seg->reference_stream_index = i;
629                 break;
630             }
631         }
632     }
633
634     if (seg->reference_stream_index < 0) {
635         av_log(s, AV_LOG_ERROR, "Could not select stream matching identifier '%s'\n",
636                seg->reference_stream_specifier);
637         return AVERROR(EINVAL);
638     }
639
640     return 0;
641 }
642
643 static void seg_free(AVFormatContext *s)
644 {
645     SegmentContext *seg = s->priv_data;
646     SegmentListEntry *cur;
647
648     ff_format_io_close(s, &seg->list_pb);
649     if (seg->avf) {
650         if (seg->is_nullctx)
651             close_null_ctxp(&seg->avf->pb);
652         else
653             ff_format_io_close(s, &seg->avf->pb);
654         avformat_free_context(seg->avf);
655         seg->avf = NULL;
656     }
657     av_freep(&seg->times);
658     av_freep(&seg->frames);
659     av_freep(&seg->cur_entry.filename);
660
661     cur = seg->segment_list_entries;
662     while (cur) {
663         SegmentListEntry *next = cur->next;
664         av_freep(&cur->filename);
665         av_free(cur);
666         cur = next;
667     }
668 }
669
670 static int seg_init(AVFormatContext *s)
671 {
672     SegmentContext *seg = s->priv_data;
673     AVFormatContext *oc = seg->avf;
674     AVDictionary *options = NULL;
675     int ret;
676     int i;
677
678     seg->segment_count = 0;
679     if (!seg->write_header_trailer)
680         seg->individual_header_trailer = 0;
681
682     if (seg->header_filename) {
683         seg->write_header_trailer = 1;
684         seg->individual_header_trailer = 0;
685     }
686
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");
690     }
691
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);
697     }
698
699     if (seg->times_str) {
700         if ((ret = parse_times(s, &seg->times, &seg->nb_times, seg->times_str)) < 0)
701             return ret;
702     } else if (seg->frames_str) {
703         if ((ret = parse_frames(s, &seg->frames, &seg->nb_frames, seg->frames_str)) < 0)
704             return ret;
705     } else {
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);
710             }
711             seg->clocktime_offset = seg->time - (seg->clocktime_offset % seg->time);
712         }
713     }
714
715     if (seg->list) {
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;
722         }
723         if (!seg->list_size && seg->list_type != LIST_TYPE_M3U8) {
724             if ((ret = segment_list_open(s)) < 0)
725                 return ret;
726         } else {
727             const char *proto = avio_find_protocol_name(seg->list);
728             seg->use_rename = proto && !strcmp(proto, "file");
729         }
730     }
731
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");
734
735     if ((ret = select_reference_stream(s)) < 0)
736         return ret;
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));
740
741     seg->oformat = av_guess_format(seg->format, s->url, NULL);
742
743     if (!seg->oformat)
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",
747                seg->oformat->name);
748         return AVERROR(EINVAL);
749     }
750
751     if ((ret = segment_mux_init(s)) < 0)
752         return ret;
753
754     if ((ret = set_segment_filename(s)) < 0)
755         return ret;
756     oc = seg->avf;
757
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);
763             return ret;
764         }
765         if (!seg->individual_header_trailer)
766             oc->pb->seekable = 0;
767     } else {
768         if ((ret = open_null_ctx(&oc->pb)) < 0)
769             return ret;
770         seg->is_nullctx = 1;
771     }
772
773     av_dict_copy(&options, seg->format_options, 0);
774     av_dict_set(&options, "fflags", "-autobsf", 0);
775     ret = avformat_init_output(oc, &options);
776     if (av_dict_count(options)) {
777         av_log(s, AV_LOG_ERROR,
778                "Some of the provided format options are not recognized\n");
779         av_dict_free(&options);
780         return AVERROR(EINVAL);
781     }
782     av_dict_free(&options);
783
784     if (ret < 0) {
785         return ret;
786     }
787     seg->segment_frame_count = 0;
788
789     av_assert0(s->nb_streams == oc->nb_streams);
790     if (ret == AVSTREAM_INIT_IN_WRITE_HEADER) {
791         ret = avformat_write_header(oc, NULL);
792         if (ret < 0)
793             return ret;
794         seg->header_written = 1;
795     }
796
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);
801     }
802
803     if (oc->avoid_negative_ts > 0 && s->avoid_negative_ts < 0)
804         s->avoid_negative_ts = 1;
805
806     return ret;
807 }
808
809 static int seg_write_header(AVFormatContext *s)
810 {
811     SegmentContext *seg = s->priv_data;
812     AVFormatContext *oc = seg->avf;
813     int ret;
814
815     if (!seg->header_written) {
816         ret = avformat_write_header(oc, NULL);
817         if (ret < 0)
818             return ret;
819     }
820
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);
825         } else {
826             close_null_ctxp(&oc->pb);
827             seg->is_nullctx = 0;
828         }
829         if ((ret = oc->io_open(oc, &oc->pb, oc->url, AVIO_FLAG_WRITE, NULL)) < 0)
830             return ret;
831         if (!seg->individual_header_trailer)
832             oc->pb->seekable = 0;
833     }
834
835     return 0;
836 }
837
838 static int seg_write_packet(AVFormatContext *s, AVPacket *pkt)
839 {
840     SegmentContext *seg = s->priv_data;
841     AVStream *st = s->streams[pkt->stream_index];
842     int64_t end_pts = INT64_MAX, offset;
843     int start_frame = INT_MAX;
844     int ret;
845     struct tm ti;
846     int64_t usecs;
847     int64_t wrapped_val;
848
849     if (!seg->avf || !seg->avf->pb)
850         return AVERROR(EINVAL);
851
852     if (!st->codecpar->extradata_size) {
853         size_t pkt_extradata_size;
854         uint8_t *pkt_extradata = av_packet_get_side_data(pkt, AV_PKT_DATA_NEW_EXTRADATA, &pkt_extradata_size);
855         if (pkt_extradata && pkt_extradata_size > 0) {
856             ret = ff_alloc_extradata(st->codecpar, pkt_extradata_size);
857             if (ret < 0) {
858                 av_log(s, AV_LOG_WARNING, "Unable to add extradata to stream. Output segments may be invalid.\n");
859                 goto calc_times;
860             }
861             memcpy(st->codecpar->extradata, pkt_extradata, pkt_extradata_size);
862         }
863     }
864
865 calc_times:
866     if (seg->times) {
867         end_pts = seg->segment_count < seg->nb_times ?
868             seg->times[seg->segment_count] : INT64_MAX;
869     } else if (seg->frames) {
870         start_frame = seg->segment_count < seg->nb_frames ?
871             seg->frames[seg->segment_count] : INT_MAX;
872     } else {
873         if (seg->use_clocktime) {
874             int64_t avgt = av_gettime();
875             time_t sec = avgt / 1000000;
876             localtime_r(&sec, &ti);
877             usecs = (int64_t)(ti.tm_hour * 3600 + ti.tm_min * 60 + ti.tm_sec) * 1000000 + (avgt % 1000000);
878             wrapped_val = (usecs + seg->clocktime_offset) % seg->time;
879             if (wrapped_val < seg->last_val && wrapped_val < seg->clocktime_wrap_duration)
880                 seg->cut_pending = 1;
881             seg->last_val = wrapped_val;
882         } else {
883             end_pts = seg->time * (seg->segment_count + 1);
884         }
885     }
886
887     ff_dlog(s, "packet stream:%d pts:%s pts_time:%s duration_time:%s is_key:%d frame:%d\n",
888             pkt->stream_index, av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
889             av_ts2timestr(pkt->duration, &st->time_base),
890             pkt->flags & AV_PKT_FLAG_KEY,
891             pkt->stream_index == seg->reference_stream_index ? seg->frame_count : -1);
892
893     if (pkt->stream_index == seg->reference_stream_index &&
894         (pkt->flags & AV_PKT_FLAG_KEY || seg->break_non_keyframes) &&
895         (seg->segment_frame_count > 0 || seg->write_empty) &&
896         (seg->cut_pending || seg->frame_count >= start_frame ||
897          (pkt->pts != AV_NOPTS_VALUE &&
898           av_compare_ts(pkt->pts, st->time_base,
899                         end_pts - seg->time_delta, AV_TIME_BASE_Q) >= 0))) {
900         /* sanitize end time in case last packet didn't have a defined duration */
901         if (seg->cur_entry.last_duration == 0)
902             seg->cur_entry.end_time = (double)pkt->pts * av_q2d(st->time_base);
903
904         if ((ret = segment_end(s, seg->individual_header_trailer, 0)) < 0)
905             goto fail;
906
907         if ((ret = segment_start(s, seg->individual_header_trailer)) < 0)
908             goto fail;
909
910         seg->cut_pending = 0;
911         seg->cur_entry.index = seg->segment_idx + seg->segment_idx_wrap * seg->segment_idx_wrap_nb;
912         seg->cur_entry.start_time = (double)pkt->pts * av_q2d(st->time_base);
913         seg->cur_entry.start_pts = av_rescale_q(pkt->pts, st->time_base, AV_TIME_BASE_Q);
914         seg->cur_entry.end_time = seg->cur_entry.start_time;
915
916         if (seg->times || (!seg->frames && !seg->use_clocktime) && seg->write_empty)
917             goto calc_times;
918     }
919
920     if (pkt->stream_index == seg->reference_stream_index) {
921         if (pkt->pts != AV_NOPTS_VALUE)
922             seg->cur_entry.end_time =
923                 FFMAX(seg->cur_entry.end_time, (double)(pkt->pts + pkt->duration) * av_q2d(st->time_base));
924         seg->cur_entry.last_duration = pkt->duration;
925     }
926
927     if (seg->segment_frame_count == 0) {
928         av_log(s, AV_LOG_VERBOSE, "segment:'%s' starts with packet stream:%d pts:%s pts_time:%s frame:%d\n",
929                seg->avf->url, pkt->stream_index,
930                av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base), seg->frame_count);
931     }
932
933     av_log(s, AV_LOG_DEBUG, "stream:%d start_pts_time:%s pts:%s pts_time:%s dts:%s dts_time:%s",
934            pkt->stream_index,
935            av_ts2timestr(seg->cur_entry.start_pts, &AV_TIME_BASE_Q),
936            av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
937            av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
938
939     /* compute new timestamps */
940     offset = av_rescale_q(seg->initial_offset - (seg->reset_timestamps ? seg->cur_entry.start_pts : 0),
941                           AV_TIME_BASE_Q, st->time_base);
942     if (pkt->pts != AV_NOPTS_VALUE)
943         pkt->pts += offset;
944     if (pkt->dts != AV_NOPTS_VALUE)
945         pkt->dts += offset;
946
947     av_log(s, AV_LOG_DEBUG, " -> pts:%s pts_time:%s dts:%s dts_time:%s\n",
948            av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
949            av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
950
951     ret = ff_write_chained(seg->avf, pkt->stream_index, pkt, s,
952                            seg->initial_offset || seg->reset_timestamps || seg->avf->oformat->interleave_packet);
953
954 fail:
955     if (pkt->stream_index == seg->reference_stream_index) {
956         seg->frame_count++;
957         seg->segment_frame_count++;
958     }
959
960     return ret;
961 }
962
963 static int seg_write_trailer(struct AVFormatContext *s)
964 {
965     SegmentContext *seg = s->priv_data;
966     AVFormatContext *oc = seg->avf;
967     int ret;
968
969     if (!oc)
970         return 0;
971
972     if (!seg->write_header_trailer) {
973         if ((ret = segment_end(s, 0, 1)) < 0)
974             return ret;
975         if ((ret = open_null_ctx(&oc->pb)) < 0)
976             return ret;
977         seg->is_nullctx = 1;
978         ret = av_write_trailer(oc);
979     } else {
980         ret = segment_end(s, 1, 1);
981     }
982     return ret;
983 }
984
985 static int seg_check_bitstream(struct AVFormatContext *s, const AVPacket *pkt)
986 {
987     SegmentContext *seg = s->priv_data;
988     AVFormatContext *oc = seg->avf;
989     if (oc->oformat->check_bitstream) {
990         int ret = oc->oformat->check_bitstream(oc, pkt);
991         if (ret == 1) {
992             AVStream *st = s->streams[pkt->stream_index];
993             AVStream *ost = oc->streams[pkt->stream_index];
994             st->internal->bsfc = ost->internal->bsfc;
995             ost->internal->bsfc = NULL;
996         }
997         return ret;
998     }
999     return 1;
1000 }
1001
1002 #define OFFSET(x) offsetof(SegmentContext, x)
1003 #define E AV_OPT_FLAG_ENCODING_PARAM
1004 static const AVOption options[] = {
1005     { "reference_stream",  "set reference stream", OFFSET(reference_stream_specifier), AV_OPT_TYPE_STRING, {.str = "auto"}, 0, 0, E },
1006     { "segment_format",    "set container format used for the segments", OFFSET(format),  AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
1007     { "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 },
1008     { "segment_list",      "set the segment list filename",              OFFSET(list),    AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
1009     { "segment_header_filename", "write a single file containing the header", OFFSET(header_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
1010
1011     { "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"},
1012     { "cache",             "allow list caching",                                    0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_LIST_FLAG_CACHE }, INT_MIN, INT_MAX,   E, "list_flags"},
1013     { "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"},
1014
1015     { "segment_list_size", "set the maximum number of playlist entries", OFFSET(list_size), AV_OPT_TYPE_INT,  {.i64 = 0},     0, INT_MAX, E },
1016
1017     { "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" },
1018     { "flat", "flat format",     0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FLAT }, INT_MIN, INT_MAX, E, "list_type" },
1019     { "csv",  "csv format",      0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_CSV  }, INT_MIN, INT_MAX, E, "list_type" },
1020     { "ext",  "extended format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_EXT  }, INT_MIN, INT_MAX, E, "list_type" },
1021     { "ffconcat", "ffconcat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FFCONCAT }, INT_MIN, INT_MAX, E, "list_type" },
1022     { "m3u8", "M3U8 format",     0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
1023     { "hls", "Apple HTTP Live Streaming compatible", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
1024
1025     { "segment_atclocktime",      "set segment to be cut at clocktime",  OFFSET(use_clocktime), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E},
1026     { "segment_clocktime_offset", "set segment clocktime offset",        OFFSET(clocktime_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, 86400000000LL, E},
1027     { "segment_clocktime_wrap_duration", "set segment clocktime wrapping duration", OFFSET(clocktime_wrap_duration), AV_OPT_TYPE_DURATION, {.i64 = INT64_MAX}, 0, INT64_MAX, E},
1028     { "segment_time",      "set segment duration",                       OFFSET(time),AV_OPT_TYPE_DURATION, {.i64 = 2000000}, INT64_MIN, INT64_MAX,       E },
1029     { "segment_time_delta","set approximation value used for the segment times", OFFSET(time_delta), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, INT64_MAX, E },
1030     { "segment_times",     "set segment split time points",              OFFSET(times_str),AV_OPT_TYPE_STRING,{.str = NULL},  0, 0,       E },
1031     { "segment_frames",    "set segment split frame numbers",            OFFSET(frames_str),AV_OPT_TYPE_STRING,{.str = NULL},  0, 0,       E },
1032     { "segment_wrap",      "set number after which the index wraps",     OFFSET(segment_idx_wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1033     { "segment_list_entry_prefix", "set base url prefix for segments", OFFSET(entry_prefix), AV_OPT_TYPE_STRING,  {.str = NULL}, 0, 0, E },
1034     { "segment_start_number", "set the sequence number of the first segment", OFFSET(segment_idx), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
1035     { "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 },
1036     { "strftime",          "set filename expansion with strftime at segment creation", OFFSET(use_strftime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1037     { "increment_tc", "increment timecode between each segment", OFFSET(increment_tc), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1038     { "break_non_keyframes", "allow breaking segments on non-keyframes", OFFSET(break_non_keyframes), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1039
1040     { "individual_header_trailer", "write header/trailer to each segment", OFFSET(individual_header_trailer), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, E },
1041     { "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 },
1042     { "reset_timestamps", "reset timestamps at the beginning of each segment", OFFSET(reset_timestamps), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1043     { "initial_offset", "set initial timestamp offset", OFFSET(initial_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, -INT64_MAX, INT64_MAX, E },
1044     { "write_empty_segments", "allow writing empty 'filler' segments", OFFSET(write_empty), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
1045     { NULL },
1046 };
1047
1048 #if CONFIG_SEGMENT_MUXER
1049 static const AVClass seg_class = {
1050     .class_name = "segment muxer",
1051     .item_name  = av_default_item_name,
1052     .option     = options,
1053     .version    = LIBAVUTIL_VERSION_INT,
1054 };
1055
1056 AVOutputFormat ff_segment_muxer = {
1057     .name           = "segment",
1058     .long_name      = NULL_IF_CONFIG_SMALL("segment"),
1059     .priv_data_size = sizeof(SegmentContext),
1060     .flags          = AVFMT_NOFILE|AVFMT_GLOBALHEADER,
1061     .init           = seg_init,
1062     .write_header   = seg_write_header,
1063     .write_packet   = seg_write_packet,
1064     .write_trailer  = seg_write_trailer,
1065     .deinit         = seg_free,
1066     .check_bitstream = seg_check_bitstream,
1067     .priv_class     = &seg_class,
1068 };
1069 #endif
1070
1071 #if CONFIG_STREAM_SEGMENT_MUXER
1072 static const AVClass sseg_class = {
1073     .class_name = "stream_segment muxer",
1074     .item_name  = av_default_item_name,
1075     .option     = options,
1076     .version    = LIBAVUTIL_VERSION_INT,
1077 };
1078
1079 AVOutputFormat ff_stream_segment_muxer = {
1080     .name           = "stream_segment,ssegment",
1081     .long_name      = NULL_IF_CONFIG_SMALL("streaming segment muxer"),
1082     .priv_data_size = sizeof(SegmentContext),
1083     .flags          = AVFMT_NOFILE,
1084     .init           = seg_init,
1085     .write_header   = seg_write_header,
1086     .write_packet   = seg_write_packet,
1087     .write_trailer  = seg_write_trailer,
1088     .deinit         = seg_free,
1089     .check_bitstream = seg_check_bitstream,
1090     .priv_class     = &sseg_class,
1091 };
1092 #endif