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