ffmpeg_filter: Factor get_compliance_unofficial_pix_fmts() out
[ffmpeg.git] / 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 /* #define DEBUG */
28
29 #include <float.h>
30 #include <time.h>
31
32 #include "avformat.h"
33 #include "avio_internal.h"
34 #include "internal.h"
35
36 #include "libavutil/avassert.h"
37 #include "libavutil/internal.h"
38 #include "libavutil/log.h"
39 #include "libavutil/opt.h"
40 #include "libavutil/avstring.h"
41 #include "libavutil/parseutils.h"
42 #include "libavutil/mathematics.h"
43 #include "libavutil/time.h"
44 #include "libavutil/time_internal.h"
45 #include "libavutil/timestamp.h"
46
47 typedef struct SegmentListEntry {
48     int index;
49     double start_time, end_time;
50     int64_t start_pts;
51     int64_t offset_pts;
52     char *filename;
53     struct SegmentListEntry *next;
54     int64_t last_duration;
55 } SegmentListEntry;
56
57 typedef enum {
58     LIST_TYPE_UNDEFINED = -1,
59     LIST_TYPE_FLAT = 0,
60     LIST_TYPE_CSV,
61     LIST_TYPE_M3U8,
62     LIST_TYPE_EXT, ///< deprecated
63     LIST_TYPE_FFCONCAT,
64     LIST_TYPE_NB,
65 } ListType;
66
67 #define SEGMENT_LIST_FLAG_CACHE 1
68 #define SEGMENT_LIST_FLAG_LIVE  2
69
70 typedef struct SegmentContext {
71     const AVClass *class;  /**< Class for private options. */
72     int segment_idx;       ///< index of the segment file to write, starting from 0
73     int segment_idx_wrap;  ///< number after which the index wraps
74     int segment_idx_wrap_nb;  ///< number of time the index has wraped
75     int segment_count;     ///< number of segment files already written
76     AVOutputFormat *oformat;
77     AVFormatContext *avf;
78     char *format;              ///< format to use for output segment files
79     char *format_options_str;  ///< format options to use for output segment files
80     AVDictionary *format_options;
81     char *list;            ///< filename for the segment list file
82     int   list_flags;      ///< flags affecting list generation
83     int   list_size;       ///< number of entries for the segment list file
84
85     int use_clocktime;    ///< flag to cut segments at regular clock time
86     int64_t clocktime_offset; //< clock offset for cutting the segments at regular clock time
87     int64_t clocktime_wrap_duration; //< wrapping duration considered for starting a new segment
88     int64_t last_val;      ///< remember last time for wrap around detection
89     int64_t last_cut;      ///< remember last cut
90     int cut_pending;
91
92     char *entry_prefix;    ///< prefix to add to list entry filenames
93     int list_type;         ///< set the list type
94     AVIOContext *list_pb;  ///< list file put-byte context
95     char *time_str;        ///< segment duration specification string
96     int64_t time;          ///< segment duration
97     int use_strftime;      ///< flag to expand filename with strftime
98
99     char *times_str;       ///< segment times specification string
100     int64_t *times;        ///< list of segment interval specification
101     int nb_times;          ///< number of elments in the times array
102
103     char *frames_str;      ///< segment frame numbers specification string
104     int *frames;           ///< list of frame number specification
105     int nb_frames;         ///< number of elments in the frames array
106     int frame_count;       ///< total number of reference frames
107     int segment_frame_count; ///< number of reference frames in the segment
108
109     int64_t time_delta;
110     int  individual_header_trailer; /**< Set by a private option. */
111     int  write_header_trailer; /**< Set by a private option. */
112     char *header_filename;  ///< filename to write the output header to
113
114     int reset_timestamps;  ///< reset timestamps at the begin of each segment
115     int64_t initial_offset;    ///< initial timestamps offset, expressed in microseconds
116     char *reference_stream_specifier; ///< reference stream specifier
117     int   reference_stream_index;
118     int   break_non_keyframes;
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
160     for (i = 0; i < s->nb_streams; i++) {
161         AVStream *st;
162         AVCodecContext *icodec, *ocodec;
163
164         if (!(st = avformat_new_stream(oc, NULL)))
165             return AVERROR(ENOMEM);
166         icodec = s->streams[i]->codec;
167         ocodec = st->codec;
168         avcodec_copy_context(ocodec, icodec);
169         if (!oc->oformat->codec_tag ||
170             av_codec_get_id (oc->oformat->codec_tag, icodec->codec_tag) == ocodec->codec_id ||
171             av_codec_get_tag(oc->oformat->codec_tag, icodec->codec_id) <= 0) {
172             ocodec->codec_tag = icodec->codec_tag;
173         } else {
174             ocodec->codec_tag = 0;
175         }
176         st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
177         st->time_base = s->streams[i]->time_base;
178         av_dict_copy(&st->metadata, s->streams[i]->metadata, 0);
179     }
180
181     return 0;
182 }
183
184 static int set_segment_filename(AVFormatContext *s)
185 {
186     SegmentContext *seg = s->priv_data;
187     AVFormatContext *oc = seg->avf;
188     size_t size;
189     int ret;
190
191     if (seg->segment_idx_wrap)
192         seg->segment_idx %= seg->segment_idx_wrap;
193     if (seg->use_strftime) {
194         time_t now0;
195         struct tm *tm, tmpbuf;
196         time(&now0);
197         tm = localtime_r(&now0, &tmpbuf);
198         if (!strftime(oc->filename, sizeof(oc->filename), s->filename, tm)) {
199             av_log(oc, AV_LOG_ERROR, "Could not get segment filename with strftime\n");
200             return AVERROR(EINVAL);
201         }
202     } else if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
203                                      s->filename, seg->segment_idx) < 0) {
204         av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", s->filename);
205         return AVERROR(EINVAL);
206     }
207
208     /* copy modified name in list entry */
209     size = strlen(av_basename(oc->filename)) + 1;
210     if (seg->entry_prefix)
211         size += strlen(seg->entry_prefix);
212
213     if ((ret = av_reallocp(&seg->cur_entry.filename, size)) < 0)
214         return ret;
215     snprintf(seg->cur_entry.filename, size, "%s%s",
216              seg->entry_prefix ? seg->entry_prefix : "",
217              av_basename(oc->filename));
218
219     return 0;
220 }
221
222 static int segment_start(AVFormatContext *s, int write_header)
223 {
224     SegmentContext *seg = s->priv_data;
225     AVFormatContext *oc = seg->avf;
226     int err = 0;
227
228     if (write_header) {
229         avformat_free_context(oc);
230         seg->avf = NULL;
231         if ((err = segment_mux_init(s)) < 0)
232             return err;
233         oc = seg->avf;
234     }
235
236     seg->segment_idx++;
237     if ((seg->segment_idx_wrap) && (seg->segment_idx % seg->segment_idx_wrap == 0))
238         seg->segment_idx_wrap_nb++;
239
240     if ((err = set_segment_filename(s)) < 0)
241         return err;
242
243     if ((err = ffio_open_whitelist(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
244                                    &s->interrupt_callback, NULL, s->protocol_whitelist)) < 0) {
245         av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->filename);
246         return err;
247     }
248     if (!seg->individual_header_trailer)
249         oc->pb->seekable = 0;
250
251     if (oc->oformat->priv_class && oc->priv_data)
252         av_opt_set(oc->priv_data, "mpegts_flags", "+resend_headers", 0);
253
254     if (write_header) {
255         if ((err = avformat_write_header(oc, NULL)) < 0)
256             return err;
257     }
258
259     seg->segment_frame_count = 0;
260     return 0;
261 }
262
263 static int segment_list_open(AVFormatContext *s)
264 {
265     SegmentContext *seg = s->priv_data;
266     int ret;
267
268     snprintf(seg->temp_list_filename, sizeof(seg->temp_list_filename), seg->use_rename ? "%s.tmp" : "%s", seg->list);
269     ret = ffio_open_whitelist(&seg->list_pb, seg->temp_list_filename, AVIO_FLAG_WRITE,
270                      &s->interrupt_callback, NULL, s->protocol_whitelist);
271     if (ret < 0) {
272         av_log(s, AV_LOG_ERROR, "Failed to open segment list '%s'\n", seg->list);
273         return ret;
274     }
275
276     if (seg->list_type == LIST_TYPE_M3U8 && seg->segment_list_entries) {
277         SegmentListEntry *entry;
278         double max_duration = 0;
279
280         avio_printf(seg->list_pb, "#EXTM3U\n");
281         avio_printf(seg->list_pb, "#EXT-X-VERSION:3\n");
282         avio_printf(seg->list_pb, "#EXT-X-MEDIA-SEQUENCE:%d\n", seg->segment_list_entries->index);
283         avio_printf(seg->list_pb, "#EXT-X-ALLOW-CACHE:%s\n",
284                     seg->list_flags & SEGMENT_LIST_FLAG_CACHE ? "YES" : "NO");
285
286         av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%d\n",
287                seg->segment_list_entries->index);
288
289         for (entry = seg->segment_list_entries; entry; entry = entry->next)
290             max_duration = FFMAX(max_duration, entry->end_time - entry->start_time);
291         avio_printf(seg->list_pb, "#EXT-X-TARGETDURATION:%"PRId64"\n", (int64_t)ceil(max_duration));
292     } else if (seg->list_type == LIST_TYPE_FFCONCAT) {
293         avio_printf(seg->list_pb, "ffconcat version 1.0\n");
294     }
295
296     return ret;
297 }
298
299 static void segment_list_print_entry(AVIOContext      *list_ioctx,
300                                      ListType          list_type,
301                                      const SegmentListEntry *list_entry,
302                                      void *log_ctx)
303 {
304     switch (list_type) {
305     case LIST_TYPE_FLAT:
306         avio_printf(list_ioctx, "%s\n", list_entry->filename);
307         break;
308     case LIST_TYPE_CSV:
309     case LIST_TYPE_EXT:
310         print_csv_escaped_str(list_ioctx, list_entry->filename);
311         avio_printf(list_ioctx, ",%f,%f\n", list_entry->start_time, list_entry->end_time);
312         break;
313     case LIST_TYPE_M3U8:
314         avio_printf(list_ioctx, "#EXTINF:%f,\n%s\n",
315                     list_entry->end_time - list_entry->start_time, list_entry->filename);
316         break;
317     case LIST_TYPE_FFCONCAT:
318     {
319         char *buf;
320         if (av_escape(&buf, list_entry->filename, NULL, AV_ESCAPE_MODE_AUTO, AV_ESCAPE_FLAG_WHITESPACE) < 0) {
321             av_log(log_ctx, AV_LOG_WARNING,
322                    "Error writing list entry '%s' in list file\n", list_entry->filename);
323             return;
324         }
325         avio_printf(list_ioctx, "file %s\n", buf);
326         av_free(buf);
327         break;
328     }
329     default:
330         av_assert0(!"Invalid list type");
331     }
332 }
333
334 static int segment_end(AVFormatContext *s, int write_trailer, int is_last)
335 {
336     SegmentContext *seg = s->priv_data;
337     AVFormatContext *oc = seg->avf;
338     int ret = 0;
339
340     av_write_frame(oc, NULL); /* Flush any buffered data (fragmented mp4) */
341     if (write_trailer)
342         ret = av_write_trailer(oc);
343
344     if (ret < 0)
345         av_log(s, AV_LOG_ERROR, "Failure occurred when ending segment '%s'\n",
346                oc->filename);
347
348     if (seg->list) {
349         if (seg->list_size || seg->list_type == LIST_TYPE_M3U8) {
350             SegmentListEntry *entry = av_mallocz(sizeof(*entry));
351             if (!entry) {
352                 ret = AVERROR(ENOMEM);
353                 goto end;
354             }
355
356             /* append new element */
357             memcpy(entry, &seg->cur_entry, sizeof(*entry));
358             entry->filename = av_strdup(entry->filename);
359             if (!seg->segment_list_entries)
360                 seg->segment_list_entries = seg->segment_list_entries_end = entry;
361             else
362                 seg->segment_list_entries_end->next = entry;
363             seg->segment_list_entries_end = entry;
364
365             /* drop first item */
366             if (seg->list_size && seg->segment_count >= seg->list_size) {
367                 entry = seg->segment_list_entries;
368                 seg->segment_list_entries = seg->segment_list_entries->next;
369                 av_freep(&entry->filename);
370                 av_freep(&entry);
371             }
372
373             if ((ret = segment_list_open(s)) < 0)
374                 goto end;
375             for (entry = seg->segment_list_entries; entry; entry = entry->next)
376                 segment_list_print_entry(seg->list_pb, seg->list_type, entry, s);
377             if (seg->list_type == LIST_TYPE_M3U8 && is_last)
378                 avio_printf(seg->list_pb, "#EXT-X-ENDLIST\n");
379             avio_closep(&seg->list_pb);
380             if (seg->use_rename)
381                 ff_rename(seg->temp_list_filename, seg->list, s);
382         } else {
383             segment_list_print_entry(seg->list_pb, seg->list_type, &seg->cur_entry, s);
384             avio_flush(seg->list_pb);
385         }
386     }
387
388     av_log(s, AV_LOG_VERBOSE, "segment:'%s' count:%d ended\n",
389            seg->avf->filename, seg->segment_count);
390     seg->segment_count++;
391
392 end:
393     avio_closep(&oc->pb);
394
395     return ret;
396 }
397
398 static int parse_times(void *log_ctx, int64_t **times, int *nb_times,
399                        const char *times_str)
400 {
401     char *p;
402     int i, ret = 0;
403     char *times_str1 = av_strdup(times_str);
404     char *saveptr = NULL;
405
406     if (!times_str1)
407         return AVERROR(ENOMEM);
408
409 #define FAIL(err) ret = err; goto end
410
411     *nb_times = 1;
412     for (p = times_str1; *p; p++)
413         if (*p == ',')
414             (*nb_times)++;
415
416     *times = av_malloc_array(*nb_times, sizeof(**times));
417     if (!*times) {
418         av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced times array\n");
419         FAIL(AVERROR(ENOMEM));
420     }
421
422     p = times_str1;
423     for (i = 0; i < *nb_times; i++) {
424         int64_t t;
425         char *tstr = av_strtok(p, ",", &saveptr);
426         p = NULL;
427
428         if (!tstr || !tstr[0]) {
429             av_log(log_ctx, AV_LOG_ERROR, "Empty time specification in times list %s\n",
430                    times_str);
431             FAIL(AVERROR(EINVAL));
432         }
433
434         ret = av_parse_time(&t, tstr, 1);
435         if (ret < 0) {
436             av_log(log_ctx, AV_LOG_ERROR,
437                    "Invalid time duration specification '%s' in times list %s\n", tstr, times_str);
438             FAIL(AVERROR(EINVAL));
439         }
440         (*times)[i] = t;
441
442         /* check on monotonicity */
443         if (i && (*times)[i-1] > (*times)[i]) {
444             av_log(log_ctx, AV_LOG_ERROR,
445                    "Specified time %f is greater than the following time %f\n",
446                    (float)((*times)[i])/1000000, (float)((*times)[i-1])/1000000);
447             FAIL(AVERROR(EINVAL));
448         }
449     }
450
451 end:
452     av_free(times_str1);
453     return ret;
454 }
455
456 static int parse_frames(void *log_ctx, int **frames, int *nb_frames,
457                         const char *frames_str)
458 {
459     char *p;
460     int i, ret = 0;
461     char *frames_str1 = av_strdup(frames_str);
462     char *saveptr = NULL;
463
464     if (!frames_str1)
465         return AVERROR(ENOMEM);
466
467 #define FAIL(err) ret = err; goto end
468
469     *nb_frames = 1;
470     for (p = frames_str1; *p; p++)
471         if (*p == ',')
472             (*nb_frames)++;
473
474     *frames = av_malloc_array(*nb_frames, sizeof(**frames));
475     if (!*frames) {
476         av_log(log_ctx, AV_LOG_ERROR, "Could not allocate forced frames array\n");
477         FAIL(AVERROR(ENOMEM));
478     }
479
480     p = frames_str1;
481     for (i = 0; i < *nb_frames; i++) {
482         long int f;
483         char *tailptr;
484         char *fstr = av_strtok(p, ",", &saveptr);
485
486         p = NULL;
487         if (!fstr) {
488             av_log(log_ctx, AV_LOG_ERROR, "Empty frame specification in frame list %s\n",
489                    frames_str);
490             FAIL(AVERROR(EINVAL));
491         }
492         f = strtol(fstr, &tailptr, 10);
493         if (*tailptr || f <= 0 || f >= INT_MAX) {
494             av_log(log_ctx, AV_LOG_ERROR,
495                    "Invalid argument '%s', must be a positive integer <= INT64_MAX\n",
496                    fstr);
497             FAIL(AVERROR(EINVAL));
498         }
499         (*frames)[i] = f;
500
501         /* check on monotonicity */
502         if (i && (*frames)[i-1] > (*frames)[i]) {
503             av_log(log_ctx, AV_LOG_ERROR,
504                    "Specified frame %d is greater than the following frame %d\n",
505                    (*frames)[i], (*frames)[i-1]);
506             FAIL(AVERROR(EINVAL));
507         }
508     }
509
510 end:
511     av_free(frames_str1);
512     return ret;
513 }
514
515 static int open_null_ctx(AVIOContext **ctx)
516 {
517     int buf_size = 32768;
518     uint8_t *buf = av_malloc(buf_size);
519     if (!buf)
520         return AVERROR(ENOMEM);
521     *ctx = avio_alloc_context(buf, buf_size, AVIO_FLAG_WRITE, NULL, NULL, NULL, NULL);
522     if (!*ctx) {
523         av_free(buf);
524         return AVERROR(ENOMEM);
525     }
526     return 0;
527 }
528
529 static void close_null_ctxp(AVIOContext **pb)
530 {
531     av_freep(&(*pb)->buffer);
532     av_freep(pb);
533 }
534
535 static int select_reference_stream(AVFormatContext *s)
536 {
537     SegmentContext *seg = s->priv_data;
538     int ret, i;
539
540     seg->reference_stream_index = -1;
541     if (!strcmp(seg->reference_stream_specifier, "auto")) {
542         /* select first index of type with highest priority */
543         int type_index_map[AVMEDIA_TYPE_NB];
544         static const enum AVMediaType type_priority_list[] = {
545             AVMEDIA_TYPE_VIDEO,
546             AVMEDIA_TYPE_AUDIO,
547             AVMEDIA_TYPE_SUBTITLE,
548             AVMEDIA_TYPE_DATA,
549             AVMEDIA_TYPE_ATTACHMENT
550         };
551         enum AVMediaType type;
552
553         for (i = 0; i < AVMEDIA_TYPE_NB; i++)
554             type_index_map[i] = -1;
555
556         /* select first index for each type */
557         for (i = 0; i < s->nb_streams; i++) {
558             type = s->streams[i]->codec->codec_type;
559             if ((unsigned)type < AVMEDIA_TYPE_NB && type_index_map[type] == -1
560                 /* ignore attached pictures/cover art streams */
561                 && !(s->streams[i]->disposition & AV_DISPOSITION_ATTACHED_PIC))
562                 type_index_map[type] = i;
563         }
564
565         for (i = 0; i < FF_ARRAY_ELEMS(type_priority_list); i++) {
566             type = type_priority_list[i];
567             if ((seg->reference_stream_index = type_index_map[type]) >= 0)
568                 break;
569         }
570     } else {
571         for (i = 0; i < s->nb_streams; i++) {
572             ret = avformat_match_stream_specifier(s, s->streams[i],
573                                                   seg->reference_stream_specifier);
574             if (ret < 0)
575                 return ret;
576             if (ret > 0) {
577                 seg->reference_stream_index = i;
578                 break;
579             }
580         }
581     }
582
583     if (seg->reference_stream_index < 0) {
584         av_log(s, AV_LOG_ERROR, "Could not select stream matching identifier '%s'\n",
585                seg->reference_stream_specifier);
586         return AVERROR(EINVAL);
587     }
588
589     return 0;
590 }
591
592 static void seg_free_context(SegmentContext *seg)
593 {
594     avio_closep(&seg->list_pb);
595     avformat_free_context(seg->avf);
596     seg->avf = NULL;
597 }
598
599 static int seg_write_header(AVFormatContext *s)
600 {
601     SegmentContext *seg = s->priv_data;
602     AVFormatContext *oc = NULL;
603     AVDictionary *options = NULL;
604     int ret;
605     int i;
606
607     seg->segment_count = 0;
608     if (!seg->write_header_trailer)
609         seg->individual_header_trailer = 0;
610
611     if (seg->header_filename) {
612         seg->write_header_trailer = 1;
613         seg->individual_header_trailer = 0;
614     }
615
616     if (!!seg->time_str + !!seg->times_str + !!seg->frames_str > 1) {
617         av_log(s, AV_LOG_ERROR,
618                "segment_time, segment_times, and segment_frames options "
619                "are mutually exclusive, select just one of them\n");
620         return AVERROR(EINVAL);
621     }
622
623     if (seg->times_str) {
624         if ((ret = parse_times(s, &seg->times, &seg->nb_times, seg->times_str)) < 0)
625             return ret;
626     } else if (seg->frames_str) {
627         if ((ret = parse_frames(s, &seg->frames, &seg->nb_frames, seg->frames_str)) < 0)
628             return ret;
629     } else {
630         /* set default value if not specified */
631         if (!seg->time_str)
632             seg->time_str = av_strdup("2");
633         if ((ret = av_parse_time(&seg->time, seg->time_str, 1)) < 0) {
634             av_log(s, AV_LOG_ERROR,
635                    "Invalid time duration specification '%s' for segment_time option\n",
636                    seg->time_str);
637             return ret;
638         }
639         if (seg->use_clocktime) {
640             if (seg->time <= 0) {
641                 av_log(s, AV_LOG_ERROR, "Invalid negative segment_time with segment_atclocktime option set\n");
642                 return AVERROR(EINVAL);
643             }
644             seg->clocktime_offset = seg->time - (seg->clocktime_offset % seg->time);
645         }
646     }
647
648     if (seg->format_options_str) {
649         ret = av_dict_parse_string(&seg->format_options, seg->format_options_str, "=", ":", 0);
650         if (ret < 0) {
651             av_log(s, AV_LOG_ERROR, "Could not parse format options list '%s'\n",
652                    seg->format_options_str);
653             goto fail;
654         }
655     }
656
657     if (seg->list) {
658         if (seg->list_type == LIST_TYPE_UNDEFINED) {
659             if      (av_match_ext(seg->list, "csv" )) seg->list_type = LIST_TYPE_CSV;
660             else if (av_match_ext(seg->list, "ext" )) seg->list_type = LIST_TYPE_EXT;
661             else if (av_match_ext(seg->list, "m3u8")) seg->list_type = LIST_TYPE_M3U8;
662             else if (av_match_ext(seg->list, "ffcat,ffconcat")) seg->list_type = LIST_TYPE_FFCONCAT;
663             else                                      seg->list_type = LIST_TYPE_FLAT;
664         }
665         if (!seg->list_size && seg->list_type != LIST_TYPE_M3U8) {
666             if ((ret = segment_list_open(s)) < 0)
667                 goto fail;
668         } else {
669             const char *proto = avio_find_protocol_name(s->filename);
670             seg->use_rename = proto && !strcmp(proto, "file");
671         }
672     }
673     if (seg->list_type == LIST_TYPE_EXT)
674         av_log(s, AV_LOG_WARNING, "'ext' list type option is deprecated in favor of 'csv'\n");
675
676     if ((ret = select_reference_stream(s)) < 0)
677         goto fail;
678     av_log(s, AV_LOG_VERBOSE, "Selected stream id:%d type:%s\n",
679            seg->reference_stream_index,
680            av_get_media_type_string(s->streams[seg->reference_stream_index]->codec->codec_type));
681
682     seg->oformat = av_guess_format(seg->format, s->filename, NULL);
683
684     if (!seg->oformat) {
685         ret = AVERROR_MUXER_NOT_FOUND;
686         goto fail;
687     }
688     if (seg->oformat->flags & AVFMT_NOFILE) {
689         av_log(s, AV_LOG_ERROR, "format %s not supported.\n",
690                seg->oformat->name);
691         ret = AVERROR(EINVAL);
692         goto fail;
693     }
694
695     if ((ret = segment_mux_init(s)) < 0)
696         goto fail;
697     oc = seg->avf;
698
699     if ((ret = set_segment_filename(s)) < 0)
700         goto fail;
701
702     if (seg->write_header_trailer) {
703         if ((ret = ffio_open_whitelist(&oc->pb, seg->header_filename ? seg->header_filename : oc->filename, AVIO_FLAG_WRITE,
704                               &s->interrupt_callback, NULL, s->protocol_whitelist)) < 0) {
705             av_log(s, AV_LOG_ERROR, "Failed to open segment '%s'\n", oc->filename);
706             goto fail;
707         }
708         if (!seg->individual_header_trailer)
709             oc->pb->seekable = 0;
710     } else {
711         if ((ret = open_null_ctx(&oc->pb)) < 0)
712             goto fail;
713     }
714
715     av_dict_copy(&options, seg->format_options, 0);
716     ret = avformat_write_header(oc, &options);
717     if (av_dict_count(options)) {
718         av_log(s, AV_LOG_ERROR,
719                "Some of the provided format options in '%s' are not recognized\n", seg->format_options_str);
720         ret = AVERROR(EINVAL);
721         goto fail;
722     }
723
724     if (ret < 0) {
725         avio_closep(&oc->pb);
726         goto fail;
727     }
728     seg->segment_frame_count = 0;
729
730     av_assert0(s->nb_streams == oc->nb_streams);
731     for (i = 0; i < s->nb_streams; i++) {
732         AVStream *inner_st  = oc->streams[i];
733         AVStream *outer_st = s->streams[i];
734         avpriv_set_pts_info(outer_st, inner_st->pts_wrap_bits, inner_st->time_base.num, inner_st->time_base.den);
735     }
736
737     if (oc->avoid_negative_ts > 0 && s->avoid_negative_ts < 0)
738         s->avoid_negative_ts = 1;
739
740     if (!seg->write_header_trailer || seg->header_filename) {
741         if (seg->header_filename) {
742             av_write_frame(oc, NULL);
743             avio_closep(&oc->pb);
744         } else {
745             close_null_ctxp(&oc->pb);
746         }
747         if ((ret = ffio_open_whitelist(&oc->pb, oc->filename, AVIO_FLAG_WRITE,
748                               &s->interrupt_callback, NULL, s->protocol_whitelist)) < 0)
749             goto fail;
750         if (!seg->individual_header_trailer)
751             oc->pb->seekable = 0;
752     }
753
754 fail:
755     av_dict_free(&options);
756     if (ret < 0)
757         seg_free_context(seg);
758
759     return ret;
760 }
761
762 static int seg_write_packet(AVFormatContext *s, AVPacket *pkt)
763 {
764     SegmentContext *seg = s->priv_data;
765     AVStream *st = s->streams[pkt->stream_index];
766     int64_t end_pts = INT64_MAX, offset;
767     int start_frame = INT_MAX;
768     int ret;
769     struct tm ti;
770     int64_t usecs;
771     int64_t wrapped_val;
772
773     if (!seg->avf)
774         return AVERROR(EINVAL);
775
776     if (seg->times) {
777         end_pts = seg->segment_count < seg->nb_times ?
778             seg->times[seg->segment_count] : INT64_MAX;
779     } else if (seg->frames) {
780         start_frame = seg->segment_count < seg->nb_frames ?
781             seg->frames[seg->segment_count] : INT_MAX;
782     } else {
783         if (seg->use_clocktime) {
784             int64_t avgt = av_gettime();
785             time_t sec = avgt / 1000000;
786             localtime_r(&sec, &ti);
787             usecs = (int64_t)(ti.tm_hour * 3600 + ti.tm_min * 60 + ti.tm_sec) * 1000000 + (avgt % 1000000);
788             wrapped_val = (usecs + seg->clocktime_offset) % seg->time;
789             if (seg->last_cut != usecs && wrapped_val < seg->last_val && wrapped_val < seg->clocktime_wrap_duration) {
790                 seg->cut_pending = 1;
791                 seg->last_cut = usecs;
792             }
793             seg->last_val = wrapped_val;
794         } else {
795             end_pts = seg->time * (seg->segment_count + 1);
796         }
797     }
798
799     ff_dlog(s, "packet stream:%d pts:%s pts_time:%s duration_time:%s is_key:%d frame:%d\n",
800             pkt->stream_index, av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
801             av_ts2timestr(pkt->duration, &st->time_base),
802             pkt->flags & AV_PKT_FLAG_KEY,
803             pkt->stream_index == seg->reference_stream_index ? seg->frame_count : -1);
804
805     if (pkt->stream_index == seg->reference_stream_index &&
806         (pkt->flags & AV_PKT_FLAG_KEY || seg->break_non_keyframes) &&
807         seg->segment_frame_count > 0 &&
808         (seg->cut_pending || seg->frame_count >= start_frame ||
809          (pkt->pts != AV_NOPTS_VALUE &&
810           av_compare_ts(pkt->pts, st->time_base,
811                         end_pts-seg->time_delta, AV_TIME_BASE_Q) >= 0))) {
812         /* sanitize end time in case last packet didn't have a defined duration */
813         if (seg->cur_entry.last_duration == 0)
814             seg->cur_entry.end_time = (double)pkt->pts * av_q2d(st->time_base);
815
816         if ((ret = segment_end(s, seg->individual_header_trailer, 0)) < 0)
817             goto fail;
818
819         if ((ret = segment_start(s, seg->individual_header_trailer)) < 0)
820             goto fail;
821
822         seg->cut_pending = 0;
823         seg->cur_entry.index = seg->segment_idx + seg->segment_idx_wrap * seg->segment_idx_wrap_nb;
824         seg->cur_entry.start_time = (double)pkt->pts * av_q2d(st->time_base);
825         seg->cur_entry.start_pts = av_rescale_q(pkt->pts, st->time_base, AV_TIME_BASE_Q);
826         seg->cur_entry.end_time = seg->cur_entry.start_time +
827             pkt->pts != AV_NOPTS_VALUE ? (double)(pkt->pts + pkt->duration) * av_q2d(st->time_base) : 0;
828     } else if (pkt->pts != AV_NOPTS_VALUE && pkt->stream_index == seg->reference_stream_index) {
829         seg->cur_entry.end_time =
830             FFMAX(seg->cur_entry.end_time, (double)(pkt->pts + pkt->duration) * av_q2d(st->time_base));
831         seg->cur_entry.last_duration = pkt->duration;
832     }
833
834     if (seg->segment_frame_count == 0) {
835         av_log(s, AV_LOG_VERBOSE, "segment:'%s' starts with packet stream:%d pts:%s pts_time:%s frame:%d\n",
836                seg->avf->filename, pkt->stream_index,
837                av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base), seg->frame_count);
838     }
839
840     av_log(s, AV_LOG_DEBUG, "stream:%d start_pts_time:%s pts:%s pts_time:%s dts:%s dts_time:%s",
841            pkt->stream_index,
842            av_ts2timestr(seg->cur_entry.start_pts, &AV_TIME_BASE_Q),
843            av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
844            av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
845
846     /* compute new timestamps */
847     offset = av_rescale_q(seg->initial_offset - (seg->reset_timestamps ? seg->cur_entry.start_pts : 0),
848                           AV_TIME_BASE_Q, st->time_base);
849     if (pkt->pts != AV_NOPTS_VALUE)
850         pkt->pts += offset;
851     if (pkt->dts != AV_NOPTS_VALUE)
852         pkt->dts += offset;
853
854     av_log(s, AV_LOG_DEBUG, " -> pts:%s pts_time:%s dts:%s dts_time:%s\n",
855            av_ts2str(pkt->pts), av_ts2timestr(pkt->pts, &st->time_base),
856            av_ts2str(pkt->dts), av_ts2timestr(pkt->dts, &st->time_base));
857
858     ret = ff_write_chained(seg->avf, pkt->stream_index, pkt, s, seg->initial_offset || seg->reset_timestamps);
859
860 fail:
861     if (pkt->stream_index == seg->reference_stream_index) {
862         seg->frame_count++;
863         seg->segment_frame_count++;
864     }
865
866     if (ret < 0)
867         seg_free_context(seg);
868
869     return ret;
870 }
871
872 static int seg_write_trailer(struct AVFormatContext *s)
873 {
874     SegmentContext *seg = s->priv_data;
875     AVFormatContext *oc = seg->avf;
876     SegmentListEntry *cur, *next;
877     int ret = 0;
878
879     if (!oc)
880         goto fail;
881
882     if (!seg->write_header_trailer) {
883         if ((ret = segment_end(s, 0, 1)) < 0)
884             goto fail;
885         if ((ret = open_null_ctx(&oc->pb)) < 0)
886             goto fail;
887         ret = av_write_trailer(oc);
888         close_null_ctxp(&oc->pb);
889     } else {
890         ret = segment_end(s, 1, 1);
891     }
892 fail:
893     if (seg->list)
894         avio_closep(&seg->list_pb);
895
896     av_dict_free(&seg->format_options);
897     av_opt_free(seg);
898     av_freep(&seg->times);
899     av_freep(&seg->frames);
900     av_freep(&seg->cur_entry.filename);
901
902     cur = seg->segment_list_entries;
903     while (cur) {
904         next = cur->next;
905         av_freep(&cur->filename);
906         av_free(cur);
907         cur = next;
908     }
909
910     avformat_free_context(oc);
911     seg->avf = NULL;
912     return ret;
913 }
914
915 #define OFFSET(x) offsetof(SegmentContext, x)
916 #define E AV_OPT_FLAG_ENCODING_PARAM
917 static const AVOption options[] = {
918     { "reference_stream",  "set reference stream", OFFSET(reference_stream_specifier), AV_OPT_TYPE_STRING, {.str = "auto"}, CHAR_MIN, CHAR_MAX, E },
919     { "segment_format",    "set container format used for the segments", OFFSET(format),  AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
920     { "segment_format_options", "set list of options for the container format used for the segments", OFFSET(format_options_str), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
921     { "segment_list",      "set the segment list filename",              OFFSET(list),    AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
922     { "segment_header_filename", "write a single file containing the header", OFFSET(header_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
923
924     { "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"},
925     { "cache",             "allow list caching",                                    0, AV_OPT_TYPE_CONST, {.i64 = SEGMENT_LIST_FLAG_CACHE }, INT_MIN, INT_MAX,   E, "list_flags"},
926     { "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"},
927
928     { "segment_list_size", "set the maximum number of playlist entries", OFFSET(list_size), AV_OPT_TYPE_INT,  {.i64 = 0},     0, INT_MAX, E },
929
930     { "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" },
931     { "flat", "flat format",     0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FLAT }, INT_MIN, INT_MAX, E, "list_type" },
932     { "csv",  "csv format",      0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_CSV  }, INT_MIN, INT_MAX, E, "list_type" },
933     { "ext",  "extended format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_EXT  }, INT_MIN, INT_MAX, E, "list_type" },
934     { "ffconcat", "ffconcat format", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_FFCONCAT }, INT_MIN, INT_MAX, E, "list_type" },
935     { "m3u8", "M3U8 format",     0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
936     { "hls", "Apple HTTP Live Streaming compatible", 0, AV_OPT_TYPE_CONST, {.i64=LIST_TYPE_M3U8 }, INT_MIN, INT_MAX, E, "list_type" },
937
938     { "segment_atclocktime",      "set segment to be cut at clocktime",  OFFSET(use_clocktime), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E},
939     { "segment_clocktime_offset", "set segment clocktime offset",        OFFSET(clocktime_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, 86400000000LL, E},
940     { "segment_clocktime_wrap_duration", "set segment clocktime wrapping duration", OFFSET(clocktime_wrap_duration), AV_OPT_TYPE_DURATION, {.i64 = INT64_MAX}, 0, INT64_MAX, E},
941     { "segment_time",      "set segment duration",                       OFFSET(time_str),AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E },
942     { "segment_time_delta","set approximation value used for the segment times", OFFSET(time_delta), AV_OPT_TYPE_DURATION, {.i64 = 0}, 0, 0, E },
943     { "segment_times",     "set segment split time points",              OFFSET(times_str),AV_OPT_TYPE_STRING,{.str = NULL},  0, 0,       E },
944     { "segment_frames",    "set segment split frame numbers",            OFFSET(frames_str),AV_OPT_TYPE_STRING,{.str = NULL},  0, 0,       E },
945     { "segment_wrap",      "set number after which the index wraps",     OFFSET(segment_idx_wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
946     { "segment_list_entry_prefix", "set base url prefix for segments", OFFSET(entry_prefix), AV_OPT_TYPE_STRING,  {.str = NULL}, 0, 0, E },
947     { "segment_start_number", "set the sequence number of the first segment", OFFSET(segment_idx), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E },
948     { "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 },
949     { "strftime",          "set filename expansion with strftime at segment creation", OFFSET(use_strftime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
950     { "break_non_keyframes", "allow breaking segments on non-keyframes", OFFSET(break_non_keyframes), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
951
952     { "individual_header_trailer", "write header/trailer to each segment", OFFSET(individual_header_trailer), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, E },
953     { "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 },
954     { "reset_timestamps", "reset timestamps at the begin of each segment", OFFSET(reset_timestamps), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, E },
955     { "initial_offset", "set initial timestamp offset", OFFSET(initial_offset), AV_OPT_TYPE_DURATION, {.i64 = 0}, -INT64_MAX, INT64_MAX, E },
956     { NULL },
957 };
958
959 static const AVClass seg_class = {
960     .class_name = "segment muxer",
961     .item_name  = av_default_item_name,
962     .option     = options,
963     .version    = LIBAVUTIL_VERSION_INT,
964 };
965
966 AVOutputFormat ff_segment_muxer = {
967     .name           = "segment",
968     .long_name      = NULL_IF_CONFIG_SMALL("segment"),
969     .priv_data_size = sizeof(SegmentContext),
970     .flags          = AVFMT_NOFILE|AVFMT_GLOBALHEADER,
971     .write_header   = seg_write_header,
972     .write_packet   = seg_write_packet,
973     .write_trailer  = seg_write_trailer,
974     .priv_class     = &seg_class,
975 };
976
977 static const AVClass sseg_class = {
978     .class_name = "stream_segment muxer",
979     .item_name  = av_default_item_name,
980     .option     = options,
981     .version    = LIBAVUTIL_VERSION_INT,
982 };
983
984 AVOutputFormat ff_stream_segment_muxer = {
985     .name           = "stream_segment,ssegment",
986     .long_name      = NULL_IF_CONFIG_SMALL("streaming segment muxer"),
987     .priv_data_size = sizeof(SegmentContext),
988     .flags          = AVFMT_NOFILE,
989     .write_header   = seg_write_header,
990     .write_packet   = seg_write_packet,
991     .write_trailer  = seg_write_trailer,
992     .priv_class     = &sseg_class,
993 };