build: Drop gcrypt support
[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 Libav.
6  *
7  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include <float.h>
23 #include <stdint.h>
24
25 #include <config.h>
26
27 #if CONFIG_OPENSSL
28 #include <openssl/rand.h>
29 #endif
30
31 #include "libavutil/mathematics.h"
32 #include "libavutil/parseutils.h"
33 #include "libavutil/avstring.h"
34 #include "libavutil/intreadwrite.h"
35 #include "libavutil/opt.h"
36 #include "libavutil/random_seed.h"
37 #include "libavutil/log.h"
38
39 #include "avformat.h"
40 #include "internal.h"
41
42 typedef struct ListEntry {
43     char  name[1024];
44     int64_t duration;     // segment duration in AV_TIME_BASE units
45     struct ListEntry *next;
46 } ListEntry;
47
48 typedef struct HLSContext {
49     const AVClass *class;  // Class for private options.
50     unsigned number;
51     int64_t sequence;
52     int64_t start_sequence;
53     AVOutputFormat *oformat;
54     AVFormatContext *avf;
55     float time;            // Set by a private option.
56     int  size;             // Set by a private option.
57     int  wrap;             // Set by a private option.
58     int  version;          // Set by a private option.
59     int  allowcache;
60     int64_t recording_time;
61     int has_video;
62     // The following timestamps are in AV_TIME_BASE units.
63     int64_t start_pts;
64     int64_t end_pts;
65     int64_t duration;      // last segment duration computed so far.
66     int nb_entries;
67     ListEntry *list;
68     ListEntry *end_list;
69     char *basename;
70     char *baseurl;
71
72     int encrypt;           // Set by a private option.
73     char *key;             // Set by a private option.
74     int key_len;
75     char *key_url;         // Set by a private option.
76     char *iv;              // Set by a private option.
77     int iv_len;
78
79     char *key_basename;
80
81     AVDictionary *enc_opts;
82 } HLSContext;
83
84
85 static int randomize(uint8_t *buf, int len)
86 {
87 #if CONFIG_OPENSSL
88     if (RAND_bytes(buf, len))
89         return 0;
90     return AVERROR(EIO);
91 #else
92     return AVERROR(ENOSYS);
93 #endif
94 }
95
96 static void free_encryption(AVFormatContext *s)
97 {
98     HLSContext *hls = s->priv_data;
99
100     av_dict_free(&hls->enc_opts);
101
102     av_freep(&hls->key_basename);
103 }
104
105 static int dict_set_bin(AVDictionary **dict, const char *key, uint8_t *buf)
106 {
107     char hex[33];
108
109     ff_data_to_hex(hex, buf, sizeof(buf), 0);
110     hex[32] = '\0';
111
112     return av_dict_set(dict, key, hex, 0);
113 }
114
115 static int setup_encryption(AVFormatContext *s)
116 {
117     HLSContext *hls = s->priv_data;
118     AVIOContext *out = NULL;
119     int len, ret;
120     uint8_t buf[16];
121     uint8_t *k;
122
123     len = strlen(hls->basename) + 4 + 1;
124     hls->key_basename = av_mallocz(len);
125     if (!hls->key_basename)
126         return AVERROR(ENOMEM);
127
128     av_strlcpy(hls->key_basename, hls->basename + 7, len);
129     av_strlcat(hls->key_basename, ".key", len);
130
131     if (hls->key) {
132         if (hls->key_len != 16) {
133             av_log(s, AV_LOG_ERROR,
134                    "Invalid key size %d, expected 16-bytes hex-coded key\n",
135                    hls->key_len);
136             return AVERROR(EINVAL);
137         }
138
139         if ((ret = dict_set_bin(&hls->enc_opts, "key", hls->key)) < 0)
140             return ret;
141         k = hls->key;
142     } else {
143         if ((ret = randomize(buf, sizeof(buf))) < 0) {
144             av_log(s, AV_LOG_ERROR, "Cannot generate a strong random key\n");
145             return ret;
146         }
147
148         if ((ret = dict_set_bin(&hls->enc_opts, "key", buf)) < 0)
149             return ret;
150         k = buf;
151     }
152
153     if (hls->iv) {
154         if (hls->iv_len != 16) {
155             av_log(s, AV_LOG_ERROR,
156                    "Invalid key size %d, expected 16-bytes hex-coded initialization vector\n",
157                    hls->iv_len);
158             return AVERROR(EINVAL);
159         }
160
161         if ((ret = dict_set_bin(&hls->enc_opts, "iv", hls->iv)) < 0)
162             return ret;
163     }
164
165     if ((ret = s->io_open(s, &out, hls->key_basename, AVIO_FLAG_WRITE, NULL)) < 0)
166         return ret;
167
168     avio_write(out, k, 16);
169
170     avio_close(out);
171
172     return 0;
173 }
174
175 static int hls_mux_init(AVFormatContext *s)
176 {
177     HLSContext *hls = s->priv_data;
178     AVFormatContext *oc;
179     int i;
180
181     hls->avf = oc = avformat_alloc_context();
182     if (!oc)
183         return AVERROR(ENOMEM);
184
185     oc->oformat            = hls->oformat;
186     oc->interrupt_callback = s->interrupt_callback;
187     oc->opaque             = s->opaque;
188     oc->io_open            = s->io_open;
189     oc->io_close           = s->io_close;
190
191     for (i = 0; i < s->nb_streams; i++) {
192         AVStream *st;
193         if (!(st = avformat_new_stream(oc, NULL)))
194             return AVERROR(ENOMEM);
195         avcodec_parameters_copy(st->codecpar, s->streams[i]->codecpar);
196         st->sample_aspect_ratio = s->streams[i]->sample_aspect_ratio;
197         st->time_base = s->streams[i]->time_base;
198     }
199
200     return 0;
201 }
202
203 static int append_entry(HLSContext *hls, int64_t duration)
204 {
205     ListEntry *en = av_malloc(sizeof(*en));
206
207     if (!en)
208         return AVERROR(ENOMEM);
209
210     av_strlcpy(en->name, av_basename(hls->avf->filename), sizeof(en->name));
211
212     en->duration = duration;
213     en->next     = NULL;
214
215     if (!hls->list)
216         hls->list = en;
217     else
218         hls->end_list->next = en;
219
220     hls->end_list = en;
221
222     if (hls->nb_entries >= hls->size) {
223         en = hls->list;
224         hls->list = en->next;
225         av_free(en);
226     } else
227         hls->nb_entries++;
228
229     hls->sequence++;
230
231     return 0;
232 }
233
234 static void free_entries(HLSContext *hls)
235 {
236     ListEntry *p = hls->list, *en;
237
238     while(p) {
239         en = p;
240         p = p->next;
241         av_free(en);
242     }
243 }
244
245 static int hls_window(AVFormatContext *s, int last)
246 {
247     HLSContext *hls = s->priv_data;
248     ListEntry *en;
249     int64_t target_duration = 0;
250     int ret = 0;
251     AVIOContext *out = NULL;
252     char temp_filename[1024];
253     int64_t sequence = FFMAX(hls->start_sequence, hls->sequence - hls->size);
254
255     snprintf(temp_filename, sizeof(temp_filename), "%s.tmp", s->filename);
256     if ((ret = s->io_open(s, &out, temp_filename, AVIO_FLAG_WRITE, NULL)) < 0)
257         goto fail;
258
259     for (en = hls->list; en; en = en->next) {
260         if (target_duration < en->duration)
261             target_duration = en->duration;
262     }
263
264     avio_printf(out, "#EXTM3U\n");
265     avio_printf(out, "#EXT-X-VERSION:%d\n", hls->version);
266     if (hls->allowcache == 0 || hls->allowcache == 1) {
267         avio_printf(out, "#EXT-X-ALLOW-CACHE:%s\n", hls->allowcache == 0 ? "NO" : "YES");
268     }
269     avio_printf(out, "#EXT-X-TARGETDURATION:%"PRId64"\n",
270                 av_rescale_rnd(target_duration, 1, AV_TIME_BASE,
271                                AV_ROUND_UP));
272     avio_printf(out, "#EXT-X-MEDIA-SEQUENCE:%"PRId64"\n", sequence);
273
274     av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%"PRId64"\n",
275            sequence);
276
277     for (en = hls->list; en; en = en->next) {
278         if (hls->encrypt) {
279             char *key_url;
280
281             if (hls->key_url)
282                 key_url = hls->key_url;
283             else
284                 key_url = hls->baseurl;
285
286             avio_printf(out, "#EXT-X-KEY:METHOD=AES-128");
287             avio_printf(out, ",URI=\"");
288             if (key_url)
289                 avio_printf(out, "%s", key_url);
290             avio_printf(out, "%s\"", av_basename(hls->key_basename));
291             if (hls->iv)
292                 avio_printf(out, ",IV=\"0x%s\"", hls->iv);
293             avio_printf(out, "\n");
294         }
295
296         if (hls->version > 2)
297             avio_printf(out, "#EXTINF:%f\n",
298                         (double)en->duration / AV_TIME_BASE);
299         else
300             avio_printf(out, "#EXTINF:%"PRId64",\n",
301                         av_rescale(en->duration, 1, AV_TIME_BASE));
302         if (hls->baseurl)
303             avio_printf(out, "%s", hls->baseurl);
304         avio_printf(out, "%s\n", en->name);
305     }
306
307     if (last)
308         avio_printf(out, "#EXT-X-ENDLIST\n");
309
310 fail:
311     ff_format_io_close(s, &out);
312     if (ret >= 0)
313         ff_rename(temp_filename, s->filename);
314     return ret;
315 }
316
317 static int hls_start(AVFormatContext *s)
318 {
319     HLSContext *c = s->priv_data;
320     AVFormatContext *oc = c->avf;
321     int err = 0;
322     AVDictionary *opts = NULL;
323
324
325     if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
326                               c->basename, c->wrap ? c->sequence % c->wrap : c->sequence) < 0)
327         return AVERROR(EINVAL);
328     c->number++;
329
330     if (c->encrypt) {
331         if ((err = av_dict_copy(&opts, c->enc_opts, 0)) < 0)
332             return err;
333         if (!c->iv) {
334             uint8_t iv[16] = { 0 };
335             char buf[33];
336
337             AV_WB64(iv + 8, c->sequence);
338             ff_data_to_hex(buf, iv, sizeof(iv), 0);
339             buf[32] = '\0';
340
341             if ((err = av_dict_set(&opts, "iv", buf, 0)) < 0)
342                 goto fail;
343         }
344     }
345
346     if ((err = s->io_open(s, &oc->pb, oc->filename, AVIO_FLAG_WRITE, &opts)) < 0)
347         return err;
348
349     if (oc->oformat->priv_class && oc->priv_data)
350         av_opt_set(oc->priv_data, "mpegts_flags", "resend_headers", 0);
351
352 fail:
353     av_dict_free(&opts);
354
355     return err;
356 }
357
358 static int hls_setup(AVFormatContext *s)
359 {
360     HLSContext *hls = s->priv_data;
361     const char *pattern = "%d.ts";
362     int basename_size = strlen(s->filename) + strlen(pattern) + 1;
363     char *p;
364
365     if (hls->encrypt)
366         basename_size += 7;
367
368     hls->basename = av_mallocz(basename_size);
369     if (!hls->basename)
370         return AVERROR(ENOMEM);
371
372     // TODO: support protocol nesting?
373     if (hls->encrypt)
374         strcpy(hls->basename, "crypto:");
375
376     av_strlcat(hls->basename, s->filename, basename_size);
377
378     p = strrchr(hls->basename, '.');
379
380     if (p)
381         *p = '\0';
382
383     if (hls->encrypt) {
384         int ret = setup_encryption(s);
385         if (ret < 0)
386             return ret;
387     }
388
389     av_strlcat(hls->basename, pattern, basename_size);
390
391     return 0;
392 }
393
394 static int hls_write_header(AVFormatContext *s)
395 {
396     HLSContext *hls = s->priv_data;
397     int ret, i;
398
399     hls->sequence       = hls->start_sequence;
400     hls->recording_time = hls->time * AV_TIME_BASE;
401     hls->start_pts      = AV_NOPTS_VALUE;
402
403     for (i = 0; i < s->nb_streams; i++)
404         hls->has_video +=
405             s->streams[i]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO;
406
407     if (hls->has_video > 1)
408         av_log(s, AV_LOG_WARNING,
409                "More than a single video stream present, "
410                "expect issues decoding it.\n");
411
412     hls->oformat = av_guess_format("mpegts", NULL, NULL);
413
414     if (!hls->oformat) {
415         ret = AVERROR_MUXER_NOT_FOUND;
416         goto fail;
417     }
418
419     if ((ret = hls_setup(s)) < 0)
420         goto fail;
421
422     if ((ret = hls_mux_init(s)) < 0)
423         goto fail;
424
425     if ((ret = hls_start(s)) < 0)
426         goto fail;
427
428     if ((ret = avformat_write_header(hls->avf, NULL)) < 0)
429         return ret;
430
431
432 fail:
433     if (ret) {
434         av_free(hls->basename);
435         if (hls->avf)
436             avformat_free_context(hls->avf);
437
438         free_encryption(s);
439     }
440     return ret;
441 }
442
443 static int hls_write_packet(AVFormatContext *s, AVPacket *pkt)
444 {
445     HLSContext *hls = s->priv_data;
446     AVFormatContext *oc = hls->avf;
447     AVStream *st = s->streams[pkt->stream_index];
448     int64_t end_pts = hls->recording_time * hls->number;
449     int64_t pts     = av_rescale_q(pkt->pts, st->time_base, AV_TIME_BASE_Q);
450     int ret, can_split = 1;
451
452     if (hls->start_pts == AV_NOPTS_VALUE) {
453         hls->start_pts = pts;
454         hls->end_pts   = pts;
455     }
456
457     if (hls->has_video) {
458         can_split = st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO &&
459                     pkt->flags & AV_PKT_FLAG_KEY;
460     }
461     if (pkt->pts == AV_NOPTS_VALUE)
462         can_split = 0;
463     else
464         hls->duration = pts - hls->end_pts;
465
466     if (can_split && pts - hls->start_pts >= end_pts) {
467         ret = append_entry(hls, hls->duration);
468         if (ret)
469             return ret;
470
471         hls->end_pts = pts;
472         hls->duration = 0;
473
474         av_write_frame(oc, NULL); /* Flush any buffered data */
475         ff_format_io_close(s, &oc->pb);
476
477         ret = hls_start(s);
478
479         if (ret)
480             return ret;
481
482         oc = hls->avf;
483
484         if ((ret = hls_window(s, 0)) < 0)
485             return ret;
486     }
487
488     ret = ff_write_chained(oc, pkt->stream_index, pkt, s);
489
490     return ret;
491 }
492
493 static int hls_write_trailer(struct AVFormatContext *s)
494 {
495     HLSContext *hls = s->priv_data;
496     AVFormatContext *oc = hls->avf;
497
498     av_write_trailer(oc);
499     ff_format_io_close(s, &oc->pb);
500     avformat_free_context(oc);
501     av_free(hls->basename);
502     append_entry(hls, hls->duration);
503     hls_window(s, 1);
504
505     free_entries(hls);
506     free_encryption(s);
507     return 0;
508 }
509
510 #define OFFSET(x) offsetof(HLSContext, x)
511 #define E AV_OPT_FLAG_ENCODING_PARAM
512 static const AVOption options[] = {
513     {"start_number",  "first number in the sequence",            OFFSET(start_sequence),AV_OPT_TYPE_INT64,  {.i64 = 0},     0, INT64_MAX, E},
514     {"hls_time",      "segment length in seconds",               OFFSET(time),    AV_OPT_TYPE_FLOAT,  {.dbl = 2},     0, FLT_MAX, E},
515     {"hls_list_size", "maximum number of playlist entries",      OFFSET(size),    AV_OPT_TYPE_INT,    {.i64 = 5},     0, INT_MAX, E},
516     {"hls_wrap",      "number after which the index wraps",      OFFSET(wrap),    AV_OPT_TYPE_INT,    {.i64 = 0},     0, INT_MAX, E},
517     {"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},
518     {"hls_base_url",  "url to prepend to each playlist entry",   OFFSET(baseurl), AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       E},
519     {"hls_version",   "protocol version",                        OFFSET(version), AV_OPT_TYPE_INT,    {.i64 = 3},     2, 3, E},
520     {"hls_enc",       "AES128 encryption support",               OFFSET(encrypt), AV_OPT_TYPE_INT,    {.i64 = 0},     0, 1, E},
521     {"hls_enc_key",   "use the specified hex-coded 16byte key to encrypt the segments",  OFFSET(key), AV_OPT_TYPE_BINARY, .flags = E},
522     {"hls_enc_key_url", "url to access the key to decrypt the segments",    OFFSET(key_url), AV_OPT_TYPE_STRING, {.str = NULL},  0, 0, E},
523     {"hls_enc_iv",     "use the specified hex-coded 16byte initialization vector",  OFFSET(iv), AV_OPT_TYPE_BINARY, .flags = E},
524     { NULL },
525 };
526
527 static const AVClass hls_class = {
528     .class_name = "hls muxer",
529     .item_name  = av_default_item_name,
530     .option     = options,
531     .version    = LIBAVUTIL_VERSION_INT,
532 };
533
534
535 AVOutputFormat ff_hls_muxer = {
536     .name           = "hls",
537     .long_name      = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
538     .extensions     = "m3u8",
539     .priv_data_size = sizeof(HLSContext),
540     .audio_codec    = AV_CODEC_ID_AAC,
541     .video_codec    = AV_CODEC_ID_H264,
542     .flags          = AVFMT_NOFILE | AVFMT_ALLOW_FLUSH,
543     .write_header   = hls_write_header,
544     .write_packet   = hls_write_packet,
545     .write_trailer  = hls_write_trailer,
546     .priv_class     = &hls_class,
547 };