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