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