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