avformat/hlsenc: refine EXT-X-BYTERANGE support for segments
[ffmpeg.git] / libavformat / hlsenc.c
1 /*
2  * Apple HTTP Live Streaming segmenter
3  * Copyright (c) 2012, Luca Barbato
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include "config.h"
23 #include <float.h>
24 #include <stdint.h>
25 #if HAVE_UNISTD_H
26 #include <unistd.h>
27 #endif
28
29 #include "libavutil/avassert.h"
30 #include "libavutil/mathematics.h"
31 #include "libavutil/parseutils.h"
32 #include "libavutil/avstring.h"
33 #include "libavutil/opt.h"
34 #include "libavutil/log.h"
35 #include "libavutil/time_internal.h"
36
37 #include "avformat.h"
38 #include "avio_internal.h"
39 #include "internal.h"
40 #include "os_support.h"
41
42 #define KEYSIZE 16
43 #define LINE_BUFFER_SIZE 1024
44
45 typedef struct HLSSegment {
46     char filename[1024];
47     char sub_filename[1024];
48     double duration; /* in seconds */
49     int64_t pos;
50     int64_t size;
51
52     char key_uri[LINE_BUFFER_SIZE + 1];
53     char iv_string[KEYSIZE*2 + 1];
54
55     struct HLSSegment *next;
56 } HLSSegment;
57
58 typedef enum HLSFlags {
59     // Generate a single media file and use byte ranges in the playlist.
60     HLS_SINGLE_FILE = (1 << 0),
61     HLS_DELETE_SEGMENTS = (1 << 1),
62     HLS_ROUND_DURATIONS = (1 << 2),
63     HLS_DISCONT_START = (1 << 3),
64     HLS_OMIT_ENDLIST = (1 << 4),
65     HLS_SPLIT_BY_TIME = (1 << 5),
66     HLS_APPEND_LIST = (1 << 6),
67     HLS_PROGRAM_DATE_TIME = (1 << 7),
68 } HLSFlags;
69
70 typedef enum {
71     PLAYLIST_TYPE_NONE,
72     PLAYLIST_TYPE_EVENT,
73     PLAYLIST_TYPE_VOD,
74     PLAYLIST_TYPE_NB,
75 } PlaylistType;
76
77 typedef struct HLSContext {
78     const AVClass *class;  // Class for private options.
79     unsigned number;
80     int64_t sequence;
81     int64_t start_sequence;
82     AVOutputFormat *oformat;
83     AVOutputFormat *vtt_oformat;
84
85     AVFormatContext *avf;
86     AVFormatContext *vtt_avf;
87
88     float time;            // Set by a private option.
89     float init_time;       // Set by a private option.
90     int max_nb_segments;   // Set by a private option.
91     int  wrap;             // Set by a private option.
92     uint32_t flags;        // enum HLSFlags
93     uint32_t pl_type;      // enum PlaylistType
94     char *segment_filename;
95
96     int use_localtime;      ///< flag to expand filename with localtime
97     int use_localtime_mkdir;///< flag to mkdir dirname in timebased filename
98     int allowcache;
99     int64_t recording_time;
100     int has_video;
101     int has_subtitle;
102     int64_t start_pts;
103     int64_t end_pts;
104     double duration;      // last segment duration computed so far, in seconds
105     int64_t start_pos;    // last segment starting position
106     int64_t size;         // last segment size
107     int64_t max_seg_size; // every segment file max size
108     int nb_entries;
109     int discontinuity_set;
110
111     HLSSegment *segments;
112     HLSSegment *last_segment;
113     HLSSegment *old_segments;
114
115     char *basename;
116     char *vtt_basename;
117     char *vtt_m3u8_name;
118     char *baseurl;
119     char *format_options_str;
120     char *vtt_format_options_str;
121     char *subtitle_filename;
122     AVDictionary *format_options;
123
124     char *key_info_file;
125     char key_file[LINE_BUFFER_SIZE + 1];
126     char key_uri[LINE_BUFFER_SIZE + 1];
127     char key_string[KEYSIZE*2 + 1];
128     char iv_string[KEYSIZE*2 + 1];
129     AVDictionary *vtt_format_options;
130
131     char *method;
132
133     double initial_prog_date_time;
134 } HLSContext;
135
136 static int hls_delete_old_segments(HLSContext *hls) {
137
138     HLSSegment *segment, *previous_segment = NULL;
139     float playlist_duration = 0.0f;
140     int ret = 0, path_size, sub_path_size;
141     char *dirname = NULL, *p, *sub_path;
142     char *path = NULL;
143
144     segment = hls->segments;
145     while (segment) {
146         playlist_duration += segment->duration;
147         segment = segment->next;
148     }
149
150     segment = hls->old_segments;
151     while (segment) {
152         playlist_duration -= segment->duration;
153         previous_segment = segment;
154         segment = previous_segment->next;
155         if (playlist_duration <= -previous_segment->duration) {
156             previous_segment->next = NULL;
157             break;
158         }
159     }
160
161     if (segment) {
162         if (hls->segment_filename) {
163             dirname = av_strdup(hls->segment_filename);
164         } else {
165             dirname = av_strdup(hls->avf->filename);
166         }
167         if (!dirname) {
168             ret = AVERROR(ENOMEM);
169             goto fail;
170         }
171         p = (char *)av_basename(dirname);
172         *p = '\0';
173     }
174
175     while (segment) {
176         av_log(hls, AV_LOG_DEBUG, "deleting old segment %s\n",
177                                   segment->filename);
178         path_size = strlen(dirname) + strlen(segment->filename) + 1;
179         path = av_malloc(path_size);
180         if (!path) {
181             ret = AVERROR(ENOMEM);
182             goto fail;
183         }
184
185         av_strlcpy(path, dirname, path_size);
186         av_strlcat(path, segment->filename, path_size);
187         if (unlink(path) < 0) {
188             av_log(hls, AV_LOG_ERROR, "failed to delete old segment %s: %s\n",
189                                      path, strerror(errno));
190         }
191
192         if (segment->sub_filename[0] != '\0') {
193             sub_path_size = strlen(dirname) + strlen(segment->sub_filename) + 1;
194             sub_path = av_malloc(sub_path_size);
195             if (!sub_path) {
196                 ret = AVERROR(ENOMEM);
197                 goto fail;
198             }
199
200             av_strlcpy(sub_path, dirname, sub_path_size);
201             av_strlcat(sub_path, segment->sub_filename, sub_path_size);
202             if (unlink(sub_path) < 0) {
203                 av_log(hls, AV_LOG_ERROR, "failed to delete old segment %s: %s\n",
204                                          sub_path, strerror(errno));
205             }
206             av_free(sub_path);
207         }
208         av_freep(&path);
209         previous_segment = segment;
210         segment = previous_segment->next;
211         av_free(previous_segment);
212     }
213
214 fail:
215     av_free(path);
216     av_free(dirname);
217
218     return ret;
219 }
220
221 static int hls_encryption_start(AVFormatContext *s)
222 {
223     HLSContext *hls = s->priv_data;
224     int ret;
225     AVIOContext *pb;
226     uint8_t key[KEYSIZE];
227
228     if ((ret = s->io_open(s, &pb, hls->key_info_file, AVIO_FLAG_READ, NULL)) < 0) {
229         av_log(hls, AV_LOG_ERROR,
230                 "error opening key info file %s\n", hls->key_info_file);
231         return ret;
232     }
233
234     ff_get_line(pb, hls->key_uri, sizeof(hls->key_uri));
235     hls->key_uri[strcspn(hls->key_uri, "\r\n")] = '\0';
236
237     ff_get_line(pb, hls->key_file, sizeof(hls->key_file));
238     hls->key_file[strcspn(hls->key_file, "\r\n")] = '\0';
239
240     ff_get_line(pb, hls->iv_string, sizeof(hls->iv_string));
241     hls->iv_string[strcspn(hls->iv_string, "\r\n")] = '\0';
242
243     ff_format_io_close(s, &pb);
244
245     if (!*hls->key_uri) {
246         av_log(hls, AV_LOG_ERROR, "no key URI specified in key info file\n");
247         return AVERROR(EINVAL);
248     }
249
250     if (!*hls->key_file) {
251         av_log(hls, AV_LOG_ERROR, "no key file specified in key info file\n");
252         return AVERROR(EINVAL);
253     }
254
255     if ((ret = s->io_open(s, &pb, hls->key_file, AVIO_FLAG_READ, NULL)) < 0) {
256         av_log(hls, AV_LOG_ERROR, "error opening key file %s\n", hls->key_file);
257         return ret;
258     }
259
260     ret = avio_read(pb, key, sizeof(key));
261     ff_format_io_close(s, &pb);
262     if (ret != sizeof(key)) {
263         av_log(hls, AV_LOG_ERROR, "error reading key file %s\n", hls->key_file);
264         if (ret >= 0 || ret == AVERROR_EOF)
265             ret = AVERROR(EINVAL);
266         return ret;
267     }
268     ff_data_to_hex(hls->key_string, key, sizeof(key), 0);
269
270     return 0;
271 }
272
273 static int read_chomp_line(AVIOContext *s, char *buf, int maxlen)
274 {
275     int len = ff_get_line(s, buf, maxlen);
276     while (len > 0 && av_isspace(buf[len - 1]))
277         buf[--len] = '\0';
278     return len;
279 }
280
281 static int hls_mux_init(AVFormatContext *s)
282 {
283     HLSContext *hls = s->priv_data;
284     AVFormatContext *oc;
285     AVFormatContext *vtt_oc = NULL;
286     int i, ret;
287
288     ret = avformat_alloc_output_context2(&hls->avf, hls->oformat, NULL, NULL);
289     if (ret < 0)
290         return ret;
291     oc = hls->avf;
292
293     oc->oformat            = hls->oformat;
294     oc->interrupt_callback = s->interrupt_callback;
295     oc->max_delay          = s->max_delay;
296     oc->opaque             = s->opaque;
297     oc->io_open            = s->io_open;
298     oc->io_close           = s->io_close;
299     av_dict_copy(&oc->metadata, s->metadata, 0);
300
301     if(hls->vtt_oformat) {
302         ret = avformat_alloc_output_context2(&hls->vtt_avf, hls->vtt_oformat, NULL, NULL);
303         if (ret < 0)
304             return ret;
305         vtt_oc          = hls->vtt_avf;
306         vtt_oc->oformat = hls->vtt_oformat;
307         av_dict_copy(&vtt_oc->metadata, s->metadata, 0);
308     }
309
310     for (i = 0; i < s->nb_streams; i++) {
311         AVStream *st;
312         AVFormatContext *loc;
313         if (s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE)
314             loc = vtt_oc;
315         else
316             loc = oc;
317
318         if (!(st = avformat_new_stream(loc, NULL)))
319             return AVERROR(ENOMEM);
320         avcodec_parameters_copy(st->codecpar, s->streams[i]->codecpar);
321         st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
322         st->time_base = s->streams[i]->time_base;
323     }
324     hls->start_pos = 0;
325
326     return 0;
327 }
328
329 /* Create a new segment and append it to the segment list */
330 static int hls_append_segment(struct AVFormatContext *s, HLSContext *hls, double duration,
331                               int64_t pos, int64_t size)
332 {
333     HLSSegment *en = av_malloc(sizeof(*en));
334     char *tmp, *p;
335     const char *pl_dir, *filename;
336     int ret;
337
338     if (!en)
339         return AVERROR(ENOMEM);
340
341     filename = av_basename(hls->avf->filename);
342
343     if (hls->use_localtime_mkdir) {
344         /* Possibly prefix with mkdir'ed subdir, if playlist share same
345          * base path. */
346         tmp = av_strdup(s->filename);
347         if (!tmp) {
348             av_free(en);
349             return AVERROR(ENOMEM);
350         }
351
352         pl_dir = av_dirname(tmp);
353         p = hls->avf->filename;
354         if (strstr(p, pl_dir) == p)
355             filename = hls->avf->filename + strlen(pl_dir) + 1;
356         av_free(tmp);
357     }
358     av_strlcpy(en->filename, filename, sizeof(en->filename));
359
360     if(hls->has_subtitle)
361         av_strlcpy(en->sub_filename, av_basename(hls->vtt_avf->filename), sizeof(en->sub_filename));
362     else
363         en->sub_filename[0] = '\0';
364
365     en->duration = duration;
366     en->pos      = pos;
367     en->size     = size;
368     en->next     = NULL;
369
370     if (hls->key_info_file) {
371         av_strlcpy(en->key_uri, hls->key_uri, sizeof(en->key_uri));
372         av_strlcpy(en->iv_string, hls->iv_string, sizeof(en->iv_string));
373     }
374
375     if (!hls->segments)
376         hls->segments = en;
377     else
378         hls->last_segment->next = en;
379
380     hls->last_segment = en;
381
382     // EVENT or VOD playlists imply sliding window cannot be used
383     if (hls->pl_type != PLAYLIST_TYPE_NONE)
384         hls->max_nb_segments = 0;
385
386     if (hls->max_nb_segments && hls->nb_entries >= hls->max_nb_segments) {
387         en = hls->segments;
388         hls->segments = en->next;
389         if (en && hls->flags & HLS_DELETE_SEGMENTS &&
390                 !(hls->flags & HLS_SINGLE_FILE || hls->wrap)) {
391             en->next = hls->old_segments;
392             hls->old_segments = en;
393             if ((ret = hls_delete_old_segments(hls)) < 0)
394                 return ret;
395         } else
396             av_free(en);
397     } else
398         hls->nb_entries++;
399
400     if (hls->max_seg_size > 0) {
401         return 0;
402     }
403     hls->sequence++;
404
405     return 0;
406 }
407
408 static int parse_playlist(AVFormatContext *s, const char *url)
409 {
410     HLSContext *hls = s->priv_data;
411     AVIOContext *in;
412     int ret = 0, is_segment = 0;
413     int64_t new_start_pos;
414     char line[1024];
415     const char *ptr;
416
417     if ((ret = ffio_open_whitelist(&in, url, AVIO_FLAG_READ,
418                                    &s->interrupt_callback, NULL,
419                                    s->protocol_whitelist, s->protocol_blacklist)) < 0)
420         return ret;
421
422     read_chomp_line(in, line, sizeof(line));
423     if (strcmp(line, "#EXTM3U")) {
424         ret = AVERROR_INVALIDDATA;
425         goto fail;
426     }
427
428     while (!avio_feof(in)) {
429         read_chomp_line(in, line, sizeof(line));
430         if (av_strstart(line, "#EXT-X-MEDIA-SEQUENCE:", &ptr)) {
431             hls->sequence = atoi(ptr);
432         } else if (av_strstart(line, "#EXTINF:", &ptr)) {
433             is_segment = 1;
434             hls->duration = atof(ptr);
435         } else if (av_strstart(line, "#", NULL)) {
436             continue;
437         } else if (line[0]) {
438             if (is_segment) {
439                 is_segment = 0;
440                 new_start_pos = avio_tell(hls->avf->pb);
441                 hls->size = new_start_pos - hls->start_pos;
442                 av_strlcpy(hls->avf->filename, line, sizeof(line));
443                 ret = hls_append_segment(s, hls, hls->duration, hls->start_pos, hls->size);
444                 if (ret < 0)
445                     goto fail;
446                 hls->start_pos = new_start_pos;
447             }
448         }
449     }
450
451 fail:
452     avio_close(in);
453     return ret;
454 }
455
456 static void hls_free_segments(HLSSegment *p)
457 {
458     HLSSegment *en;
459
460     while(p) {
461         en = p;
462         p = p->next;
463         av_free(en);
464     }
465 }
466
467 static void set_http_options(AVDictionary **options, HLSContext *c)
468 {
469     if (c->method)
470         av_dict_set(options, "method", c->method, 0);
471 }
472
473 static int hls_window(AVFormatContext *s, int last)
474 {
475     HLSContext *hls = s->priv_data;
476     HLSSegment *en;
477     int target_duration = 0;
478     int ret = 0;
479     AVIOContext *out = NULL;
480     AVIOContext *sub_out = NULL;
481     char temp_filename[1024];
482     int64_t sequence = FFMAX(hls->start_sequence, hls->sequence - hls->nb_entries);
483     int version = 3;
484     const char *proto = avio_find_protocol_name(s->filename);
485     int use_rename = proto && !strcmp(proto, "file");
486     static unsigned warned_non_file;
487     char *key_uri = NULL;
488     char *iv_string = NULL;
489     AVDictionary *options = NULL;
490     double prog_date_time = hls->initial_prog_date_time;
491     int byterange_mode = (hls->flags & HLS_SINGLE_FILE) || (hls->max_seg_size > 0);
492
493     if (byterange_mode) {
494         version = 4;
495         sequence = 0;
496     }
497
498     if (!use_rename && !warned_non_file++)
499         av_log(s, AV_LOG_ERROR, "Cannot use rename on non file protocol, this may lead to races and temporarly partial files\n");
500
501     set_http_options(&options, hls);
502     snprintf(temp_filename, sizeof(temp_filename), use_rename ? "%s.tmp" : "%s", s->filename);
503     if ((ret = s->io_open(s, &out, temp_filename, AVIO_FLAG_WRITE, &options)) < 0)
504         goto fail;
505
506     for (en = hls->segments; en; en = en->next) {
507         if (target_duration < en->duration)
508             target_duration = ceil(en->duration);
509     }
510
511     hls->discontinuity_set = 0;
512     avio_printf(out, "#EXTM3U\n");
513     avio_printf(out, "#EXT-X-VERSION:%d\n", version);
514     if (hls->allowcache == 0 || hls->allowcache == 1) {
515         avio_printf(out, "#EXT-X-ALLOW-CACHE:%s\n", hls->allowcache == 0 ? "NO" : "YES");
516     }
517     avio_printf(out, "#EXT-X-TARGETDURATION:%d\n", target_duration);
518     avio_printf(out, "#EXT-X-MEDIA-SEQUENCE:%"PRId64"\n", sequence);
519     if (hls->pl_type == PLAYLIST_TYPE_EVENT) {
520         avio_printf(out, "#EXT-X-PLAYLIST-TYPE:EVENT\n");
521     } else if (hls->pl_type == PLAYLIST_TYPE_VOD) {
522         avio_printf(out, "#EXT-X-PLAYLIST-TYPE:VOD\n");
523     }
524
525     av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%"PRId64"\n",
526            sequence);
527     if((hls->flags & HLS_DISCONT_START) && sequence==hls->start_sequence && hls->discontinuity_set==0 ){
528         avio_printf(out, "#EXT-X-DISCONTINUITY\n");
529         hls->discontinuity_set = 1;
530     }
531     for (en = hls->segments; en; en = en->next) {
532         if (hls->key_info_file && (!key_uri || strcmp(en->key_uri, key_uri) ||
533                                     av_strcasecmp(en->iv_string, iv_string))) {
534             avio_printf(out, "#EXT-X-KEY:METHOD=AES-128,URI=\"%s\"", en->key_uri);
535             if (*en->iv_string)
536                 avio_printf(out, ",IV=0x%s", en->iv_string);
537             avio_printf(out, "\n");
538             key_uri = en->key_uri;
539             iv_string = en->iv_string;
540         }
541
542         if (hls->flags & HLS_ROUND_DURATIONS)
543             avio_printf(out, "#EXTINF:%ld,\n",  lrint(en->duration));
544         else
545             avio_printf(out, "#EXTINF:%f,\n", en->duration);
546         if (byterange_mode)
547              avio_printf(out, "#EXT-X-BYTERANGE:%"PRIi64"@%"PRIi64"\n",
548                          en->size, en->pos);
549         if (hls->flags & HLS_PROGRAM_DATE_TIME) {
550             time_t tt, wrongsecs;
551             int milli;
552             struct tm *tm, tmpbuf;
553             char buf0[128], buf1[128];
554             tt = (int64_t)prog_date_time;
555             milli = av_clip(lrint(1000*(prog_date_time - tt)), 0, 999);
556             tm = localtime_r(&tt, &tmpbuf);
557             strftime(buf0, sizeof(buf0), "%Y-%m-%dT%H:%M:%S", tm);
558             if (!strftime(buf1, sizeof(buf1), "%z", tm) || buf1[1]<'0' ||buf1[1]>'2') {
559                 int tz_min, dst = tm->tm_isdst;
560                 tm = gmtime_r(&tt, &tmpbuf);
561                 tm->tm_isdst = dst;
562                 wrongsecs = mktime(tm);
563                 tz_min = (abs(wrongsecs - tt) + 30) / 60;
564                 snprintf(buf1, sizeof(buf1),
565                          "%c%02d%02d",
566                          wrongsecs <= tt ? '+' : '-',
567                          tz_min / 60,
568                          tz_min % 60);
569             }
570             avio_printf(out, "#EXT-X-PROGRAM-DATE-TIME:%s.%03d%s\n", buf0, milli, buf1);
571             prog_date_time += en->duration;
572         }
573         if (hls->baseurl)
574             avio_printf(out, "%s", hls->baseurl);
575         avio_printf(out, "%s\n", en->filename);
576     }
577
578     if (last && (hls->flags & HLS_OMIT_ENDLIST)==0)
579         avio_printf(out, "#EXT-X-ENDLIST\n");
580
581     if( hls->vtt_m3u8_name ) {
582         if ((ret = s->io_open(s, &sub_out, hls->vtt_m3u8_name, AVIO_FLAG_WRITE, &options)) < 0)
583             goto fail;
584         avio_printf(sub_out, "#EXTM3U\n");
585         avio_printf(sub_out, "#EXT-X-VERSION:%d\n", version);
586         if (hls->allowcache == 0 || hls->allowcache == 1) {
587             avio_printf(sub_out, "#EXT-X-ALLOW-CACHE:%s\n", hls->allowcache == 0 ? "NO" : "YES");
588         }
589         avio_printf(sub_out, "#EXT-X-TARGETDURATION:%d\n", target_duration);
590         avio_printf(sub_out, "#EXT-X-MEDIA-SEQUENCE:%"PRId64"\n", sequence);
591
592         av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%"PRId64"\n",
593                sequence);
594
595         for (en = hls->segments; en; en = en->next) {
596             avio_printf(sub_out, "#EXTINF:%f,\n", en->duration);
597             if (byterange_mode)
598                  avio_printf(sub_out, "#EXT-X-BYTERANGE:%"PRIi64"@%"PRIi64"\n",
599                          en->size, en->pos);
600             if (hls->baseurl)
601                 avio_printf(sub_out, "%s", hls->baseurl);
602             avio_printf(sub_out, "%s\n", en->sub_filename);
603         }
604
605         if (last)
606             avio_printf(sub_out, "#EXT-X-ENDLIST\n");
607
608     }
609
610 fail:
611     av_dict_free(&options);
612     ff_format_io_close(s, &out);
613     ff_format_io_close(s, &sub_out);
614     if (ret >= 0 && use_rename)
615         ff_rename(temp_filename, s->filename, s);
616     return ret;
617 }
618
619 static int hls_start(AVFormatContext *s)
620 {
621     HLSContext *c = s->priv_data;
622     AVFormatContext *oc = c->avf;
623     AVFormatContext *vtt_oc = c->vtt_avf;
624     AVDictionary *options = NULL;
625     char *filename, iv_string[KEYSIZE*2 + 1];
626     int err = 0;
627
628     if (c->flags & HLS_SINGLE_FILE) {
629         av_strlcpy(oc->filename, c->basename,
630                    sizeof(oc->filename));
631         if (c->vtt_basename)
632             av_strlcpy(vtt_oc->filename, c->vtt_basename,
633                   sizeof(vtt_oc->filename));
634     } else if (c->max_seg_size > 0) {
635         if (av_get_frame_filename2(oc->filename, sizeof(oc->filename),
636             c->basename, c->wrap ? c->sequence % c->wrap : c->sequence,
637             AV_FRAME_FILENAME_FLAGS_MULTIPLE) < 0) {
638                 av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s', you can try to use -use_localtime 1 with it\n", c->basename);
639                 return AVERROR(EINVAL);
640         }
641     } else {
642         if (c->use_localtime) {
643             time_t now0;
644             struct tm *tm, tmpbuf;
645             time(&now0);
646             tm = localtime_r(&now0, &tmpbuf);
647             if (!strftime(oc->filename, sizeof(oc->filename), c->basename, tm)) {
648                 av_log(oc, AV_LOG_ERROR, "Could not get segment filename with use_localtime\n");
649                 return AVERROR(EINVAL);
650             }
651
652             if (c->use_localtime_mkdir) {
653                 const char *dir;
654                 char *fn_copy = av_strdup(oc->filename);
655                 if (!fn_copy) {
656                     return AVERROR(ENOMEM);
657                 }
658                 dir = av_dirname(fn_copy);
659                 if (mkdir(dir, 0777) == -1 && errno != EEXIST) {
660                     av_log(oc, AV_LOG_ERROR, "Could not create directory %s with use_localtime_mkdir\n", dir);
661                     av_free(fn_copy);
662                     return AVERROR(errno);
663                 }
664                 av_free(fn_copy);
665             }
666         } else if (av_get_frame_filename2(oc->filename, sizeof(oc->filename),
667                                   c->basename, c->wrap ? c->sequence % c->wrap : c->sequence,
668                                   AV_FRAME_FILENAME_FLAGS_MULTIPLE) < 0) {
669             av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s' you can try use -use_localtime 1 with it\n", c->basename);
670             return AVERROR(EINVAL);
671         }
672         if( c->vtt_basename) {
673             if (av_get_frame_filename2(vtt_oc->filename, sizeof(vtt_oc->filename),
674                               c->vtt_basename, c->wrap ? c->sequence % c->wrap : c->sequence,
675                               AV_FRAME_FILENAME_FLAGS_MULTIPLE) < 0) {
676                 av_log(vtt_oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", c->vtt_basename);
677                 return AVERROR(EINVAL);
678             }
679        }
680     }
681     c->number++;
682
683     set_http_options(&options, c);
684
685     if (c->key_info_file) {
686         if ((err = hls_encryption_start(s)) < 0)
687             goto fail;
688         if ((err = av_dict_set(&options, "encryption_key", c->key_string, 0))
689                 < 0)
690             goto fail;
691         err = av_strlcpy(iv_string, c->iv_string, sizeof(iv_string));
692         if (!err)
693             snprintf(iv_string, sizeof(iv_string), "%032"PRIx64, c->sequence);
694         if ((err = av_dict_set(&options, "encryption_iv", iv_string, 0)) < 0)
695            goto fail;
696
697         filename = av_asprintf("crypto:%s", oc->filename);
698         if (!filename) {
699             err = AVERROR(ENOMEM);
700             goto fail;
701         }
702         err = s->io_open(s, &oc->pb, filename, AVIO_FLAG_WRITE, &options);
703         av_free(filename);
704         av_dict_free(&options);
705         if (err < 0)
706             return err;
707     } else
708         if ((err = s->io_open(s, &oc->pb, oc->filename, AVIO_FLAG_WRITE, &options)) < 0)
709             goto fail;
710     if (c->vtt_basename) {
711         set_http_options(&options, c);
712         if ((err = s->io_open(s, &vtt_oc->pb, vtt_oc->filename, AVIO_FLAG_WRITE, &options)) < 0)
713             goto fail;
714     }
715     av_dict_free(&options);
716
717     /* We only require one PAT/PMT per segment. */
718     if (oc->oformat->priv_class && oc->priv_data) {
719         char period[21];
720
721         snprintf(period, sizeof(period), "%d", (INT_MAX / 2) - 1);
722
723         av_opt_set(oc->priv_data, "mpegts_flags", "resend_headers", 0);
724         av_opt_set(oc->priv_data, "sdt_period", period, 0);
725         av_opt_set(oc->priv_data, "pat_period", period, 0);
726     }
727
728     if (c->vtt_basename) {
729         err = avformat_write_header(vtt_oc,NULL);
730         if (err < 0)
731             return err;
732     }
733
734     return 0;
735 fail:
736     av_dict_free(&options);
737
738     return err;
739 }
740
741 static int hls_write_header(AVFormatContext *s)
742 {
743     HLSContext *hls = s->priv_data;
744     int ret, i;
745     char *p;
746     const char *pattern = "%d.ts";
747     const char *pattern_localtime_fmt = "-%s.ts";
748     const char *vtt_pattern = "%d.vtt";
749     AVDictionary *options = NULL;
750     int basename_size;
751     int vtt_basename_size;
752
753     hls->sequence       = hls->start_sequence;
754     hls->recording_time = (hls->init_time ? hls->init_time : hls->time) * AV_TIME_BASE;
755     hls->start_pts      = AV_NOPTS_VALUE;
756
757     if (hls->flags & HLS_PROGRAM_DATE_TIME) {
758         time_t now0;
759         time(&now0);
760         hls->initial_prog_date_time = now0;
761     }
762
763     if (hls->format_options_str) {
764         ret = av_dict_parse_string(&hls->format_options, hls->format_options_str, "=", ":", 0);
765         if (ret < 0) {
766             av_log(s, AV_LOG_ERROR, "Could not parse format options list '%s'\n", hls->format_options_str);
767             goto fail;
768         }
769     }
770
771     for (i = 0; i < s->nb_streams; i++) {
772         hls->has_video +=
773             s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO;
774         hls->has_subtitle +=
775             s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE;
776     }
777
778     if (hls->has_video > 1)
779         av_log(s, AV_LOG_WARNING,
780                "More than a single video stream present, "
781                "expect issues decoding it.\n");
782
783     hls->oformat = av_guess_format("mpegts", NULL, NULL);
784
785     if (!hls->oformat) {
786         ret = AVERROR_MUXER_NOT_FOUND;
787         goto fail;
788     }
789
790     if(hls->has_subtitle) {
791         hls->vtt_oformat = av_guess_format("webvtt", NULL, NULL);
792         if (!hls->oformat) {
793             ret = AVERROR_MUXER_NOT_FOUND;
794             goto fail;
795         }
796     }
797
798     if (hls->segment_filename) {
799         hls->basename = av_strdup(hls->segment_filename);
800         if (!hls->basename) {
801             ret = AVERROR(ENOMEM);
802             goto fail;
803         }
804     } else {
805         if (hls->flags & HLS_SINGLE_FILE)
806             pattern = ".ts";
807
808         if (hls->use_localtime) {
809             basename_size = strlen(s->filename) + strlen(pattern_localtime_fmt) + 1;
810         } else {
811             basename_size = strlen(s->filename) + strlen(pattern) + 1;
812         }
813         hls->basename = av_malloc(basename_size);
814         if (!hls->basename) {
815             ret = AVERROR(ENOMEM);
816             goto fail;
817         }
818
819         av_strlcpy(hls->basename, s->filename, basename_size);
820
821         p = strrchr(hls->basename, '.');
822         if (p)
823             *p = '\0';
824         if (hls->use_localtime) {
825             av_strlcat(hls->basename, pattern_localtime_fmt, basename_size);
826         } else {
827             av_strlcat(hls->basename, pattern, basename_size);
828         }
829     }
830
831     if(hls->has_subtitle) {
832
833         if (hls->flags & HLS_SINGLE_FILE)
834             vtt_pattern = ".vtt";
835         vtt_basename_size = strlen(s->filename) + strlen(vtt_pattern) + 1;
836         hls->vtt_basename = av_malloc(vtt_basename_size);
837         if (!hls->vtt_basename) {
838             ret = AVERROR(ENOMEM);
839             goto fail;
840         }
841         hls->vtt_m3u8_name = av_malloc(vtt_basename_size);
842         if (!hls->vtt_m3u8_name ) {
843             ret = AVERROR(ENOMEM);
844             goto fail;
845         }
846         av_strlcpy(hls->vtt_basename, s->filename, vtt_basename_size);
847         p = strrchr(hls->vtt_basename, '.');
848         if (p)
849             *p = '\0';
850
851         if( hls->subtitle_filename ) {
852             strcpy(hls->vtt_m3u8_name, hls->subtitle_filename);
853         } else {
854             strcpy(hls->vtt_m3u8_name, hls->vtt_basename);
855             av_strlcat(hls->vtt_m3u8_name, "_vtt.m3u8", vtt_basename_size);
856         }
857         av_strlcat(hls->vtt_basename, vtt_pattern, vtt_basename_size);
858     }
859
860     if ((ret = hls_mux_init(s)) < 0)
861         goto fail;
862
863     if (hls->flags & HLS_APPEND_LIST) {
864         parse_playlist(s, s->filename);
865         if (hls->init_time > 0) {
866             av_log(s, AV_LOG_WARNING, "append_list mode does not support hls_init_time,"
867                    " hls_init_time value will have no effect\n");
868             hls->init_time = 0;
869             hls->recording_time = hls->time * AV_TIME_BASE;
870         }
871     }
872
873     if ((ret = hls_start(s)) < 0)
874         goto fail;
875
876     av_dict_copy(&options, hls->format_options, 0);
877     ret = avformat_write_header(hls->avf, &options);
878     if (av_dict_count(options)) {
879         av_log(s, AV_LOG_ERROR, "Some of provided format options in '%s' are not recognized\n", hls->format_options_str);
880         ret = AVERROR(EINVAL);
881         goto fail;
882     }
883     //av_assert0(s->nb_streams == hls->avf->nb_streams);
884     for (i = 0; i < s->nb_streams; i++) {
885         AVStream *inner_st;
886         AVStream *outer_st = s->streams[i];
887
888         if (hls->max_seg_size > 0) {
889             if ((outer_st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) &&
890                 (outer_st->codecpar->bit_rate > hls->max_seg_size)) {
891                 av_log(s, AV_LOG_WARNING, "Your video bitrate is bigger than hls_segment_size, "
892                        "(%"PRId64 " > %"PRId64 "), the result maybe not be what you want.",
893                        outer_st->codecpar->bit_rate, hls->max_seg_size);
894             }
895         }
896
897         if (outer_st->codecpar->codec_type != AVMEDIA_TYPE_SUBTITLE)
898             inner_st = hls->avf->streams[i];
899         else if (hls->vtt_avf)
900             inner_st = hls->vtt_avf->streams[0];
901         else {
902             /* We have a subtitle stream, when the user does not want one */
903             inner_st = NULL;
904             continue;
905         }
906         avpriv_set_pts_info(outer_st, inner_st->pts_wrap_bits, inner_st->time_base.num, inner_st->time_base.den);
907     }
908 fail:
909
910     av_dict_free(&options);
911     if (ret < 0) {
912         av_freep(&hls->basename);
913         av_freep(&hls->vtt_basename);
914         if (hls->avf)
915             avformat_free_context(hls->avf);
916         if (hls->vtt_avf)
917             avformat_free_context(hls->vtt_avf);
918
919     }
920     return ret;
921 }
922
923 static int hls_write_packet(AVFormatContext *s, AVPacket *pkt)
924 {
925     HLSContext *hls = s->priv_data;
926     AVFormatContext *oc = NULL;
927     AVStream *st = s->streams[pkt->stream_index];
928     int64_t end_pts = hls->recording_time * hls->number;
929     int is_ref_pkt = 1;
930     int ret, can_split = 1;
931     int stream_index = 0;
932
933     if (hls->sequence - hls->nb_entries > hls->start_sequence && hls->init_time > 0) {
934         /* reset end_pts, hls->recording_time at end of the init hls list */
935         int init_list_dur = hls->init_time * hls->nb_entries * AV_TIME_BASE;
936         int after_init_list_dur = (hls->sequence - hls->nb_entries ) * hls->time * AV_TIME_BASE;
937         hls->recording_time = hls->time * AV_TIME_BASE;
938         end_pts = init_list_dur + after_init_list_dur ;
939     }
940
941     if( st->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE ) {
942         oc = hls->vtt_avf;
943         stream_index = 0;
944     } else {
945         oc = hls->avf;
946         stream_index = pkt->stream_index;
947     }
948     if (hls->start_pts == AV_NOPTS_VALUE) {
949         hls->start_pts = pkt->pts;
950         hls->end_pts   = pkt->pts;
951     }
952
953     if (hls->has_video) {
954         can_split = st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO &&
955                     ((pkt->flags & AV_PKT_FLAG_KEY) || (hls->flags & HLS_SPLIT_BY_TIME));
956         is_ref_pkt = st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO;
957     }
958     if (pkt->pts == AV_NOPTS_VALUE)
959         is_ref_pkt = can_split = 0;
960
961     if (is_ref_pkt)
962         hls->duration = (double)(pkt->pts - hls->end_pts)
963                                    * st->time_base.num / st->time_base.den;
964
965     if (can_split && av_compare_ts(pkt->pts - hls->start_pts, st->time_base,
966                                    end_pts, AV_TIME_BASE_Q) >= 0) {
967         int64_t new_start_pos;
968         av_write_frame(oc, NULL); /* Flush any buffered data */
969
970         new_start_pos = avio_tell(hls->avf->pb);
971         hls->size = new_start_pos - hls->start_pos;
972         ret = hls_append_segment(s, hls, hls->duration, hls->start_pos, hls->size);
973         hls->start_pos = new_start_pos;
974         if (ret < 0)
975             return ret;
976
977         hls->end_pts = pkt->pts;
978         hls->duration = 0;
979
980         if (hls->flags & HLS_SINGLE_FILE) {
981             if (hls->avf->oformat->priv_class && hls->avf->priv_data)
982                 av_opt_set(hls->avf->priv_data, "mpegts_flags", "resend_headers", 0);
983             hls->number++;
984         } else if (hls->max_seg_size > 0) {
985             if (hls->avf->oformat->priv_class && hls->avf->priv_data)
986                 av_opt_set(hls->avf->priv_data, "mpegts_flags", "resend_headers", 0);
987             if (hls->start_pos >= hls->max_seg_size) {
988                 hls->sequence++;
989                 ff_format_io_close(s, &oc->pb);
990                 if (hls->vtt_avf)
991                     ff_format_io_close(s, &hls->vtt_avf->pb);
992                 ret = hls_start(s);
993                 hls->start_pos = 0;
994                 /* When split segment by byte, the duration is short than hls_time,
995                  * so it is not enough one segment duration as hls_time, */
996                 hls->number--;
997             }
998             hls->number++;
999         } else {
1000             ff_format_io_close(s, &oc->pb);
1001             if (hls->vtt_avf)
1002                 ff_format_io_close(s, &hls->vtt_avf->pb);
1003
1004             ret = hls_start(s);
1005         }
1006
1007         if (ret < 0)
1008             return ret;
1009
1010         if( st->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE )
1011             oc = hls->vtt_avf;
1012         else
1013         oc = hls->avf;
1014
1015         if ((ret = hls_window(s, 0)) < 0)
1016             return ret;
1017     }
1018
1019     ret = ff_write_chained(oc, stream_index, pkt, s, 0);
1020
1021     return ret;
1022 }
1023
1024 static int hls_write_trailer(struct AVFormatContext *s)
1025 {
1026     HLSContext *hls = s->priv_data;
1027     AVFormatContext *oc = hls->avf;
1028     AVFormatContext *vtt_oc = hls->vtt_avf;
1029
1030     av_write_trailer(oc);
1031     if (oc->pb) {
1032         hls->size = avio_tell(hls->avf->pb) - hls->start_pos;
1033         ff_format_io_close(s, &oc->pb);
1034         hls_append_segment(s, hls, hls->duration, hls->start_pos, hls->size);
1035     }
1036
1037     if (vtt_oc) {
1038         if (vtt_oc->pb)
1039             av_write_trailer(vtt_oc);
1040         hls->size = avio_tell(hls->vtt_avf->pb) - hls->start_pos;
1041         ff_format_io_close(s, &vtt_oc->pb);
1042     }
1043     av_freep(&hls->basename);
1044     avformat_free_context(oc);
1045
1046     hls->avf = NULL;
1047     hls_window(s, 1);
1048
1049     if (vtt_oc) {
1050         av_freep(&hls->vtt_basename);
1051         av_freep(&hls->vtt_m3u8_name);
1052         avformat_free_context(vtt_oc);
1053     }
1054
1055     hls_free_segments(hls->segments);
1056     hls_free_segments(hls->old_segments);
1057     return 0;
1058 }
1059
1060 #define OFFSET(x) offsetof(HLSContext, x)
1061 #define E AV_OPT_FLAG_ENCODING_PARAM
1062 static const AVOption options[] = {
1063     {"start_number",  "set first number in the sequence",        OFFSET(start_sequence),AV_OPT_TYPE_INT64,  {.i64 = 0},     0, INT64_MAX, E},
1064     {"hls_time",      "set segment length in seconds",           OFFSET(time),    AV_OPT_TYPE_FLOAT,  {.dbl = 2},     0, FLT_MAX, E},
1065     {"hls_init_time", "set segment length in seconds at init list",           OFFSET(init_time),    AV_OPT_TYPE_FLOAT,  {.dbl = 0},     0, FLT_MAX, E},
1066     {"hls_list_size", "set maximum number of playlist entries",  OFFSET(max_nb_segments),    AV_OPT_TYPE_INT,    {.i64 = 5},     0, INT_MAX, E},
1067     {"hls_ts_options","set hls mpegts list of options for the container format used for hls", OFFSET(format_options_str), AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,    E},
1068     {"hls_vtt_options","set hls vtt list of options for the container format used for hls", OFFSET(vtt_format_options_str), AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,    E},
1069     {"hls_wrap",      "set number after which the index wraps",  OFFSET(wrap),    AV_OPT_TYPE_INT,    {.i64 = 0},     0, INT_MAX, E},
1070     {"hls_allow_cache", "explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments", OFFSET(allowcache), AV_OPT_TYPE_INT, {.i64 = -1}, INT_MIN, INT_MAX, E},
1071     {"hls_base_url",  "url to prepend to each playlist entry",   OFFSET(baseurl), AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E},
1072     {"hls_segment_filename", "filename template for segment files", OFFSET(segment_filename),   AV_OPT_TYPE_STRING, {.str = NULL},            0,       0,         E},
1073     {"hls_segment_size", "maximum size per segment file, (in bytes)",  OFFSET(max_seg_size),    AV_OPT_TYPE_INT,    {.i64 = 0},               0,       INT_MAX,   E},
1074     {"hls_key_info_file",    "file with key URI and key file path", OFFSET(key_info_file),      AV_OPT_TYPE_STRING, {.str = NULL},            0,       0,         E},
1075     {"hls_subtitle_path",     "set path of hls subtitles", OFFSET(subtitle_filename), AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,    E},
1076     {"hls_flags",     "set flags affecting HLS playlist and media file generation", OFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0 }, 0, UINT_MAX, E, "flags"},
1077     {"single_file",   "generate a single media file indexed with byte ranges", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_SINGLE_FILE }, 0, UINT_MAX,   E, "flags"},
1078     {"delete_segments", "delete segment files that are no longer part of the playlist", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_DELETE_SEGMENTS }, 0, UINT_MAX,   E, "flags"},
1079     {"round_durations", "round durations in m3u8 to whole numbers", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_ROUND_DURATIONS }, 0, UINT_MAX,   E, "flags"},
1080     {"discont_start", "start the playlist with a discontinuity tag", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_DISCONT_START }, 0, UINT_MAX,   E, "flags"},
1081     {"omit_endlist", "Do not append an endlist when ending stream", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_OMIT_ENDLIST }, 0, UINT_MAX,   E, "flags"},
1082     {"split_by_time", "split the hls segment by time which user set by hls_time", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_SPLIT_BY_TIME }, 0, UINT_MAX,   E, "flags"},
1083     {"append_list", "append the new segments into old hls segment list", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_APPEND_LIST }, 0, UINT_MAX,   E, "flags"},
1084     {"program_date_time", "add EXT-X-PROGRAM-DATE-TIME", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_PROGRAM_DATE_TIME }, 0, UINT_MAX,   E, "flags"},
1085     {"use_localtime", "set filename expansion with strftime at segment creation", OFFSET(use_localtime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1086     {"use_localtime_mkdir", "create last directory component in strftime-generated filename", OFFSET(use_localtime_mkdir), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
1087     {"hls_playlist_type", "set the HLS playlist type", OFFSET(pl_type), AV_OPT_TYPE_INT, {.i64 = PLAYLIST_TYPE_NONE }, 0, PLAYLIST_TYPE_NB-1, E, "pl_type" },
1088     {"event", "EVENT playlist", 0, AV_OPT_TYPE_CONST, {.i64 = PLAYLIST_TYPE_EVENT }, INT_MIN, INT_MAX, E, "pl_type" },
1089     {"vod", "VOD playlist", 0, AV_OPT_TYPE_CONST, {.i64 = PLAYLIST_TYPE_VOD }, INT_MIN, INT_MAX, E, "pl_type" },
1090     {"method", "set the HTTP method", OFFSET(method), AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,    E},
1091
1092     { NULL },
1093 };
1094
1095 static const AVClass hls_class = {
1096     .class_name = "hls muxer",
1097     .item_name  = av_default_item_name,
1098     .option     = options,
1099     .version    = LIBAVUTIL_VERSION_INT,
1100 };
1101
1102
1103 AVOutputFormat ff_hls_muxer = {
1104     .name           = "hls",
1105     .long_name      = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
1106     .extensions     = "m3u8",
1107     .priv_data_size = sizeof(HLSContext),
1108     .audio_codec    = AV_CODEC_ID_AAC,
1109     .video_codec    = AV_CODEC_ID_H264,
1110     .subtitle_codec = AV_CODEC_ID_WEBVTT,
1111     .flags          = AVFMT_NOFILE | AVFMT_ALLOW_FLUSH,
1112     .write_header   = hls_write_header,
1113     .write_packet   = hls_write_packet,
1114     .write_trailer  = hls_write_trailer,
1115     .priv_class     = &hls_class,
1116 };