FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
hlsenc.c
Go to the documentation of this file.
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"
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 
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 } HLSFlags;
66 
67 typedef struct HLSContext {
68  const AVClass *class; // Class for private options.
69  unsigned number;
70  int64_t sequence;
71  int64_t start_sequence;
74 
77 
78  float time; // Set by a private option.
79  int max_nb_segments; // Set by a private option.
80  int wrap; // Set by a private option.
81  uint32_t flags; // enum HLSFlags
83 
84  int use_localtime; ///< flag to expand filename with localtime
86  int64_t recording_time;
87  int has_video;
89  int64_t start_pts;
90  int64_t end_pts;
91  double duration; // last segment duration computed so far, in seconds
92  int64_t start_pos; // last segment starting position
93  int64_t size; // last segment size
96 
100 
101  char *basename;
104  char *baseurl;
109 
113  char key_string[KEYSIZE*2 + 1];
114  char iv_string[KEYSIZE*2 + 1];
116 
117  char *method;
118 
119 } HLSContext;
120 
122 
123  HLSSegment *segment, *previous_segment = NULL;
124  float playlist_duration = 0.0f;
125  int ret = 0, path_size, sub_path_size;
126  char *dirname = NULL, *p, *sub_path;
127  char *path = NULL;
128 
129  segment = hls->segments;
130  while (segment) {
131  playlist_duration += segment->duration;
132  segment = segment->next;
133  }
134 
135  segment = hls->old_segments;
136  while (segment) {
137  playlist_duration -= segment->duration;
138  previous_segment = segment;
139  segment = previous_segment->next;
140  if (playlist_duration <= -previous_segment->duration) {
141  previous_segment->next = NULL;
142  break;
143  }
144  }
145 
146  if (segment) {
147  if (hls->segment_filename) {
148  dirname = av_strdup(hls->segment_filename);
149  } else {
150  dirname = av_strdup(hls->avf->filename);
151  }
152  if (!dirname) {
153  ret = AVERROR(ENOMEM);
154  goto fail;
155  }
156  p = (char *)av_basename(dirname);
157  *p = '\0';
158  }
159 
160  while (segment) {
161  av_log(hls, AV_LOG_DEBUG, "deleting old segment %s\n",
162  segment->filename);
163  path_size = strlen(dirname) + strlen(segment->filename) + 1;
164  path = av_malloc(path_size);
165  if (!path) {
166  ret = AVERROR(ENOMEM);
167  goto fail;
168  }
169 
170  av_strlcpy(path, dirname, path_size);
171  av_strlcat(path, segment->filename, path_size);
172  if (unlink(path) < 0) {
173  av_log(hls, AV_LOG_ERROR, "failed to delete old segment %s: %s\n",
174  path, strerror(errno));
175  }
176 
177  if (segment->sub_filename[0] != '\0') {
178  sub_path_size = strlen(dirname) + strlen(segment->sub_filename) + 1;
179  sub_path = av_malloc(sub_path_size);
180  if (!sub_path) {
181  ret = AVERROR(ENOMEM);
182  goto fail;
183  }
184 
185  av_strlcpy(sub_path, dirname, sub_path_size);
186  av_strlcat(sub_path, segment->sub_filename, sub_path_size);
187  if (unlink(sub_path) < 0) {
188  av_log(hls, AV_LOG_ERROR, "failed to delete old segment %s: %s\n",
189  sub_path, strerror(errno));
190  }
191  av_free(sub_path);
192  }
193  av_freep(&path);
194  previous_segment = segment;
195  segment = previous_segment->next;
196  av_free(previous_segment);
197  }
198 
199 fail:
200  av_free(path);
201  av_free(dirname);
202 
203  return ret;
204 }
205 
207 {
208  HLSContext *hls = s->priv_data;
209  int ret;
210  AVIOContext *pb;
211  uint8_t key[KEYSIZE];
212 
213  if ((ret = s->io_open(s, &pb, hls->key_info_file, AVIO_FLAG_READ, NULL)) < 0) {
214  av_log(hls, AV_LOG_ERROR,
215  "error opening key info file %s\n", hls->key_info_file);
216  return ret;
217  }
218 
219  ff_get_line(pb, hls->key_uri, sizeof(hls->key_uri));
220  hls->key_uri[strcspn(hls->key_uri, "\r\n")] = '\0';
221 
222  ff_get_line(pb, hls->key_file, sizeof(hls->key_file));
223  hls->key_file[strcspn(hls->key_file, "\r\n")] = '\0';
224 
225  ff_get_line(pb, hls->iv_string, sizeof(hls->iv_string));
226  hls->iv_string[strcspn(hls->iv_string, "\r\n")] = '\0';
227 
228  ff_format_io_close(s, &pb);
229 
230  if (!*hls->key_uri) {
231  av_log(hls, AV_LOG_ERROR, "no key URI specified in key info file\n");
232  return AVERROR(EINVAL);
233  }
234 
235  if (!*hls->key_file) {
236  av_log(hls, AV_LOG_ERROR, "no key file specified in key info file\n");
237  return AVERROR(EINVAL);
238  }
239 
240  if ((ret = s->io_open(s, &pb, hls->key_file, AVIO_FLAG_READ, NULL)) < 0) {
241  av_log(hls, AV_LOG_ERROR, "error opening key file %s\n", hls->key_file);
242  return ret;
243  }
244 
245  ret = avio_read(pb, key, sizeof(key));
246  ff_format_io_close(s, &pb);
247  if (ret != sizeof(key)) {
248  av_log(hls, AV_LOG_ERROR, "error reading key file %s\n", hls->key_file);
249  if (ret >= 0 || ret == AVERROR_EOF)
250  ret = AVERROR(EINVAL);
251  return ret;
252  }
253  ff_data_to_hex(hls->key_string, key, sizeof(key), 0);
254 
255  return 0;
256 }
257 
259 {
260  HLSContext *hls = s->priv_data;
261  AVFormatContext *oc;
262  AVFormatContext *vtt_oc = NULL;
263  int i, ret;
264 
265  ret = avformat_alloc_output_context2(&hls->avf, hls->oformat, NULL, NULL);
266  if (ret < 0)
267  return ret;
268  oc = hls->avf;
269 
270  oc->oformat = hls->oformat;
272  oc->max_delay = s->max_delay;
273  oc->opaque = s->opaque;
274  oc->io_open = s->io_open;
275  oc->io_close = s->io_close;
276  av_dict_copy(&oc->metadata, s->metadata, 0);
277 
278  if(hls->vtt_oformat) {
280  if (ret < 0)
281  return ret;
282  vtt_oc = hls->vtt_avf;
283  vtt_oc->oformat = hls->vtt_oformat;
284  av_dict_copy(&vtt_oc->metadata, s->metadata, 0);
285  }
286 
287  for (i = 0; i < s->nb_streams; i++) {
288  AVStream *st;
289  AVFormatContext *loc;
291  loc = vtt_oc;
292  else
293  loc = oc;
294 
295  if (!(st = avformat_new_stream(loc, NULL)))
296  return AVERROR(ENOMEM);
299  st->time_base = s->streams[i]->time_base;
300  }
301  hls->start_pos = 0;
302 
303  return 0;
304 }
305 
306 /* Create a new segment and append it to the segment list */
307 static int hls_append_segment(HLSContext *hls, double duration, int64_t pos,
308  int64_t size)
309 {
310  HLSSegment *en = av_malloc(sizeof(*en));
311  int ret;
312 
313  if (!en)
314  return AVERROR(ENOMEM);
315 
316  av_strlcpy(en->filename, av_basename(hls->avf->filename), sizeof(en->filename));
317 
318  if(hls->has_subtitle)
320  else
321  en->sub_filename[0] = '\0';
322 
323  en->duration = duration;
324  en->pos = pos;
325  en->size = size;
326  en->next = NULL;
327 
328  if (hls->key_info_file) {
329  av_strlcpy(en->key_uri, hls->key_uri, sizeof(en->key_uri));
330  av_strlcpy(en->iv_string, hls->iv_string, sizeof(en->iv_string));
331  }
332 
333  if (!hls->segments)
334  hls->segments = en;
335  else
336  hls->last_segment->next = en;
337 
338  hls->last_segment = en;
339 
340  if (hls->max_nb_segments && hls->nb_entries >= hls->max_nb_segments) {
341  en = hls->segments;
342  hls->segments = en->next;
343  if (en && hls->flags & HLS_DELETE_SEGMENTS &&
344  !(hls->flags & HLS_SINGLE_FILE || hls->wrap)) {
345  en->next = hls->old_segments;
346  hls->old_segments = en;
347  if ((ret = hls_delete_old_segments(hls)) < 0)
348  return ret;
349  } else
350  av_free(en);
351  } else
352  hls->nb_entries++;
353 
354  hls->sequence++;
355 
356  return 0;
357 }
358 
360 {
361  HLSSegment *en;
362 
363  while(p) {
364  en = p;
365  p = p->next;
366  av_free(en);
367  }
368 }
369 
371 {
372  if (c->method)
373  av_dict_set(options, "method", c->method, 0);
374 }
375 
376 static int hls_window(AVFormatContext *s, int last)
377 {
378  HLSContext *hls = s->priv_data;
379  HLSSegment *en;
380  int target_duration = 0;
381  int ret = 0;
382  AVIOContext *out = NULL;
383  AVIOContext *sub_out = NULL;
384  char temp_filename[1024];
385  int64_t sequence = FFMAX(hls->start_sequence, hls->sequence - hls->nb_entries);
386  int version = hls->flags & HLS_SINGLE_FILE ? 4 : 3;
387  const char *proto = avio_find_protocol_name(s->filename);
388  int use_rename = proto && !strcmp(proto, "file");
389  static unsigned warned_non_file;
390  char *key_uri = NULL;
391  char *iv_string = NULL;
393 
394  if (!use_rename && !warned_non_file++)
395  av_log(s, AV_LOG_ERROR, "Cannot use rename on non file protocol, this may lead to races and temporarly partial files\n");
396 
397  set_http_options(&options, hls);
398  snprintf(temp_filename, sizeof(temp_filename), use_rename ? "%s.tmp" : "%s", s->filename);
399  if ((ret = s->io_open(s, &out, temp_filename, AVIO_FLAG_WRITE, NULL)) < 0)
400  goto fail;
401 
402  for (en = hls->segments; en; en = en->next) {
403  if (target_duration < en->duration)
404  target_duration = ceil(en->duration);
405  }
406 
407  hls->discontinuity_set = 0;
408  avio_printf(out, "#EXTM3U\n");
409  avio_printf(out, "#EXT-X-VERSION:%d\n", version);
410  if (hls->allowcache == 0 || hls->allowcache == 1) {
411  avio_printf(out, "#EXT-X-ALLOW-CACHE:%s\n", hls->allowcache == 0 ? "NO" : "YES");
412  }
413  avio_printf(out, "#EXT-X-TARGETDURATION:%d\n", target_duration);
414  avio_printf(out, "#EXT-X-MEDIA-SEQUENCE:%"PRId64"\n", sequence);
415 
416  av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%"PRId64"\n",
417  sequence);
418  if((hls->flags & HLS_DISCONT_START) && sequence==hls->start_sequence && hls->discontinuity_set==0 ){
419  avio_printf(out, "#EXT-X-DISCONTINUITY\n");
420  hls->discontinuity_set = 1;
421  }
422  for (en = hls->segments; en; en = en->next) {
423  if (hls->key_info_file && (!key_uri || strcmp(en->key_uri, key_uri) ||
424  av_strcasecmp(en->iv_string, iv_string))) {
425  avio_printf(out, "#EXT-X-KEY:METHOD=AES-128,URI=\"%s\"", en->key_uri);
426  if (*en->iv_string)
427  avio_printf(out, ",IV=0x%s", en->iv_string);
428  avio_printf(out, "\n");
429  key_uri = en->key_uri;
430  iv_string = en->iv_string;
431  }
432 
433  if (hls->flags & HLS_ROUND_DURATIONS)
434  avio_printf(out, "#EXTINF:%ld,\n", lrint(en->duration));
435  else
436  avio_printf(out, "#EXTINF:%f,\n", en->duration);
437  if (hls->flags & HLS_SINGLE_FILE)
438  avio_printf(out, "#EXT-X-BYTERANGE:%"PRIi64"@%"PRIi64"\n",
439  en->size, en->pos);
440  if (hls->baseurl)
441  avio_printf(out, "%s", hls->baseurl);
442  avio_printf(out, "%s\n", en->filename);
443  }
444 
445  if (last && (hls->flags & HLS_OMIT_ENDLIST)==0)
446  avio_printf(out, "#EXT-X-ENDLIST\n");
447 
448  if( hls->vtt_m3u8_name ) {
449  if ((ret = s->io_open(s, &sub_out, hls->vtt_m3u8_name, AVIO_FLAG_WRITE, &options)) < 0)
450  goto fail;
451  avio_printf(sub_out, "#EXTM3U\n");
452  avio_printf(sub_out, "#EXT-X-VERSION:%d\n", version);
453  if (hls->allowcache == 0 || hls->allowcache == 1) {
454  avio_printf(sub_out, "#EXT-X-ALLOW-CACHE:%s\n", hls->allowcache == 0 ? "NO" : "YES");
455  }
456  avio_printf(sub_out, "#EXT-X-TARGETDURATION:%d\n", target_duration);
457  avio_printf(sub_out, "#EXT-X-MEDIA-SEQUENCE:%"PRId64"\n", sequence);
458 
459  av_log(s, AV_LOG_VERBOSE, "EXT-X-MEDIA-SEQUENCE:%"PRId64"\n",
460  sequence);
461 
462  for (en = hls->segments; en; en = en->next) {
463  avio_printf(sub_out, "#EXTINF:%f,\n", en->duration);
464  if (hls->flags & HLS_SINGLE_FILE)
465  avio_printf(sub_out, "#EXT-X-BYTERANGE:%"PRIi64"@%"PRIi64"\n",
466  en->size, en->pos);
467  if (hls->baseurl)
468  avio_printf(sub_out, "%s", hls->baseurl);
469  avio_printf(sub_out, "%s\n", en->sub_filename);
470  }
471 
472  if (last)
473  avio_printf(sub_out, "#EXT-X-ENDLIST\n");
474 
475  }
476 
477 fail:
478  av_dict_free(&options);
479  ff_format_io_close(s, &out);
480  ff_format_io_close(s, &sub_out);
481  if (ret >= 0 && use_rename)
482  ff_rename(temp_filename, s->filename, s);
483  return ret;
484 }
485 
487 {
488  HLSContext *c = s->priv_data;
489  AVFormatContext *oc = c->avf;
490  AVFormatContext *vtt_oc = c->vtt_avf;
492  char *filename, iv_string[KEYSIZE*2 + 1];
493  int err = 0;
494 
495  if (c->flags & HLS_SINGLE_FILE) {
496  av_strlcpy(oc->filename, c->basename,
497  sizeof(oc->filename));
498  if (c->vtt_basename)
499  av_strlcpy(vtt_oc->filename, c->vtt_basename,
500  sizeof(vtt_oc->filename));
501  } else {
502  if (c->use_localtime) {
503  time_t now0;
504  struct tm *tm, tmpbuf;
505  time(&now0);
506  tm = localtime_r(&now0, &tmpbuf);
507  if (!strftime(oc->filename, sizeof(oc->filename), c->basename, tm)) {
508  av_log(oc, AV_LOG_ERROR, "Could not get segment filename with use_localtime\n");
509  return AVERROR(EINVAL);
510  }
511  } else if (av_get_frame_filename(oc->filename, sizeof(oc->filename),
512  c->basename, c->wrap ? c->sequence % c->wrap : c->sequence) < 0) {
513  av_log(oc, AV_LOG_ERROR, "Invalid segment filename template '%s' you can try use -use_localtime 1 with it\n", c->basename);
514  return AVERROR(EINVAL);
515  }
516  if( c->vtt_basename) {
517  if (av_get_frame_filename(vtt_oc->filename, sizeof(vtt_oc->filename),
518  c->vtt_basename, c->wrap ? c->sequence % c->wrap : c->sequence) < 0) {
519  av_log(vtt_oc, AV_LOG_ERROR, "Invalid segment filename template '%s'\n", c->vtt_basename);
520  return AVERROR(EINVAL);
521  }
522  }
523  }
524  c->number++;
525 
526  set_http_options(&options, c);
527 
528  if (c->key_info_file) {
529  if ((err = hls_encryption_start(s)) < 0)
530  goto fail;
531  if ((err = av_dict_set(&options, "encryption_key", c->key_string, 0))
532  < 0)
533  goto fail;
534  err = av_strlcpy(iv_string, c->iv_string, sizeof(iv_string));
535  if (!err)
536  snprintf(iv_string, sizeof(iv_string), "%032"PRIx64, c->sequence);
537  if ((err = av_dict_set(&options, "encryption_iv", iv_string, 0)) < 0)
538  goto fail;
539 
540  filename = av_asprintf("crypto:%s", oc->filename);
541  if (!filename) {
542  err = AVERROR(ENOMEM);
543  goto fail;
544  }
545  err = s->io_open(s, &oc->pb, filename, AVIO_FLAG_WRITE, &options);
546  av_free(filename);
547  av_dict_free(&options);
548  if (err < 0)
549  return err;
550  } else
551  if ((err = s->io_open(s, &oc->pb, oc->filename, AVIO_FLAG_WRITE, &options)) < 0)
552  goto fail;
553  if (c->vtt_basename) {
554  set_http_options(&options, c);
555  if ((err = s->io_open(s, &vtt_oc->pb, vtt_oc->filename, AVIO_FLAG_WRITE, &options)) < 0)
556  goto fail;
557  }
558  av_dict_free(&options);
559 
560  /* We only require one PAT/PMT per segment. */
561  if (oc->oformat->priv_class && oc->priv_data) {
562  char period[21];
563 
564  snprintf(period, sizeof(period), "%d", (INT_MAX / 2) - 1);
565 
566  av_opt_set(oc->priv_data, "mpegts_flags", "resend_headers", 0);
567  av_opt_set(oc->priv_data, "sdt_period", period, 0);
568  av_opt_set(oc->priv_data, "pat_period", period, 0);
569  }
570 
571  if (c->vtt_basename) {
572  err = avformat_write_header(vtt_oc,NULL);
573  if (err < 0)
574  return err;
575  }
576 
577  return 0;
578 fail:
579  av_dict_free(&options);
580 
581  return err;
582 }
583 
585 {
586  HLSContext *hls = s->priv_data;
587  int ret, i;
588  char *p;
589  const char *pattern = "%d.ts";
590  const char *pattern_localtime_fmt = "-%s.ts";
591  const char *vtt_pattern = "%d.vtt";
593  int basename_size;
594  int vtt_basename_size;
595 
596  hls->sequence = hls->start_sequence;
597  hls->recording_time = hls->time * AV_TIME_BASE;
598  hls->start_pts = AV_NOPTS_VALUE;
599 
600  if (hls->format_options_str) {
601  ret = av_dict_parse_string(&hls->format_options, hls->format_options_str, "=", ":", 0);
602  if (ret < 0) {
603  av_log(s, AV_LOG_ERROR, "Could not parse format options list '%s'\n", hls->format_options_str);
604  goto fail;
605  }
606  }
607 
608  for (i = 0; i < s->nb_streams; i++) {
609  hls->has_video +=
611  hls->has_subtitle +=
613  }
614 
615  if (hls->has_video > 1)
617  "More than a single video stream present, "
618  "expect issues decoding it.\n");
619 
620  hls->oformat = av_guess_format("mpegts", NULL, NULL);
621 
622  if (!hls->oformat) {
624  goto fail;
625  }
626 
627  if(hls->has_subtitle) {
628  hls->vtt_oformat = av_guess_format("webvtt", NULL, NULL);
629  if (!hls->oformat) {
631  goto fail;
632  }
633  }
634 
635  if (hls->segment_filename) {
636  hls->basename = av_strdup(hls->segment_filename);
637  if (!hls->basename) {
638  ret = AVERROR(ENOMEM);
639  goto fail;
640  }
641  } else {
642  if (hls->flags & HLS_SINGLE_FILE)
643  pattern = ".ts";
644 
645  if (hls->use_localtime) {
646  basename_size = strlen(s->filename) + strlen(pattern_localtime_fmt) + 1;
647  } else {
648  basename_size = strlen(s->filename) + strlen(pattern) + 1;
649  }
650  hls->basename = av_malloc(basename_size);
651  if (!hls->basename) {
652  ret = AVERROR(ENOMEM);
653  goto fail;
654  }
655 
656  av_strlcpy(hls->basename, s->filename, basename_size);
657 
658  p = strrchr(hls->basename, '.');
659  if (p)
660  *p = '\0';
661  if (hls->use_localtime) {
662  av_strlcat(hls->basename, pattern_localtime_fmt, basename_size);
663  } else {
664  av_strlcat(hls->basename, pattern, basename_size);
665  }
666  }
667 
668  if(hls->has_subtitle) {
669 
670  if (hls->flags & HLS_SINGLE_FILE)
671  vtt_pattern = ".vtt";
672  vtt_basename_size = strlen(s->filename) + strlen(vtt_pattern) + 1;
673  hls->vtt_basename = av_malloc(vtt_basename_size);
674  if (!hls->vtt_basename) {
675  ret = AVERROR(ENOMEM);
676  goto fail;
677  }
678  hls->vtt_m3u8_name = av_malloc(vtt_basename_size);
679  if (!hls->vtt_m3u8_name ) {
680  ret = AVERROR(ENOMEM);
681  goto fail;
682  }
683  av_strlcpy(hls->vtt_basename, s->filename, vtt_basename_size);
684  p = strrchr(hls->vtt_basename, '.');
685  if (p)
686  *p = '\0';
687 
688  if( hls->subtitle_filename ) {
689  strcpy(hls->vtt_m3u8_name, hls->subtitle_filename);
690  } else {
691  strcpy(hls->vtt_m3u8_name, hls->vtt_basename);
692  av_strlcat(hls->vtt_m3u8_name, "_vtt.m3u8", vtt_basename_size);
693  }
694  av_strlcat(hls->vtt_basename, vtt_pattern, vtt_basename_size);
695  }
696 
697  if ((ret = hls_mux_init(s)) < 0)
698  goto fail;
699 
700  if ((ret = hls_start(s)) < 0)
701  goto fail;
702 
703  av_dict_copy(&options, hls->format_options, 0);
704  ret = avformat_write_header(hls->avf, &options);
705  if (av_dict_count(options)) {
706  av_log(s, AV_LOG_ERROR, "Some of provided format options in '%s' are not recognized\n", hls->format_options_str);
707  ret = AVERROR(EINVAL);
708  goto fail;
709  }
710  //av_assert0(s->nb_streams == hls->avf->nb_streams);
711  for (i = 0; i < s->nb_streams; i++) {
712  AVStream *inner_st;
713  AVStream *outer_st = s->streams[i];
714  if (outer_st->codec->codec_type != AVMEDIA_TYPE_SUBTITLE)
715  inner_st = hls->avf->streams[i];
716  else if (hls->vtt_avf)
717  inner_st = hls->vtt_avf->streams[0];
718  else {
719  /* We have a subtitle stream, when the user does not want one */
720  inner_st = NULL;
721  continue;
722  }
723  avpriv_set_pts_info(outer_st, inner_st->pts_wrap_bits, inner_st->time_base.num, inner_st->time_base.den);
724  }
725 fail:
726 
727  av_dict_free(&options);
728  if (ret < 0) {
729  av_freep(&hls->basename);
730  av_freep(&hls->vtt_basename);
731  if (hls->avf)
733  if (hls->vtt_avf)
735 
736  }
737  return ret;
738 }
739 
741 {
742  HLSContext *hls = s->priv_data;
743  AVFormatContext *oc = NULL;
744  AVStream *st = s->streams[pkt->stream_index];
745  int64_t end_pts = hls->recording_time * hls->number;
746  int is_ref_pkt = 1;
747  int ret, can_split = 1;
748  int stream_index = 0;
749 
750  if( st->codec->codec_type == AVMEDIA_TYPE_SUBTITLE ) {
751  oc = hls->vtt_avf;
752  stream_index = 0;
753  } else {
754  oc = hls->avf;
755  stream_index = pkt->stream_index;
756  }
757  if (hls->start_pts == AV_NOPTS_VALUE) {
758  hls->start_pts = pkt->pts;
759  hls->end_pts = pkt->pts;
760  }
761 
762  if (hls->has_video) {
763  can_split = st->codec->codec_type == AVMEDIA_TYPE_VIDEO &&
764  pkt->flags & AV_PKT_FLAG_KEY;
765  is_ref_pkt = st->codec->codec_type == AVMEDIA_TYPE_VIDEO;
766  }
767  if (pkt->pts == AV_NOPTS_VALUE)
768  is_ref_pkt = can_split = 0;
769 
770  if (is_ref_pkt)
771  hls->duration = (double)(pkt->pts - hls->end_pts)
772  * st->time_base.num / st->time_base.den;
773 
774  if (can_split && av_compare_ts(pkt->pts - hls->start_pts, st->time_base,
775  end_pts, AV_TIME_BASE_Q) >= 0) {
776  int64_t new_start_pos;
777  av_write_frame(oc, NULL); /* Flush any buffered data */
778 
779  new_start_pos = avio_tell(hls->avf->pb);
780  hls->size = new_start_pos - hls->start_pos;
781  ret = hls_append_segment(hls, hls->duration, hls->start_pos, hls->size);
782  hls->start_pos = new_start_pos;
783  if (ret < 0)
784  return ret;
785 
786  hls->end_pts = pkt->pts;
787  hls->duration = 0;
788 
789  if (hls->flags & HLS_SINGLE_FILE) {
790  if (hls->avf->oformat->priv_class && hls->avf->priv_data)
791  av_opt_set(hls->avf->priv_data, "mpegts_flags", "resend_headers", 0);
792  hls->number++;
793  } else {
794  ff_format_io_close(s, &oc->pb);
795  if (hls->vtt_avf)
796  ff_format_io_close(s, &hls->vtt_avf->pb);
797 
798  ret = hls_start(s);
799  }
800 
801  if (ret < 0)
802  return ret;
803 
805  oc = hls->vtt_avf;
806  else
807  oc = hls->avf;
808 
809  if ((ret = hls_window(s, 0)) < 0)
810  return ret;
811  }
812 
813  ret = ff_write_chained(oc, stream_index, pkt, s, 0);
814 
815  return ret;
816 }
817 
819 {
820  HLSContext *hls = s->priv_data;
821  AVFormatContext *oc = hls->avf;
822  AVFormatContext *vtt_oc = hls->vtt_avf;
823 
824  av_write_trailer(oc);
825  if (oc->pb) {
826  hls->size = avio_tell(hls->avf->pb) - hls->start_pos;
827  ff_format_io_close(s, &oc->pb);
828  hls_append_segment(hls, hls->duration, hls->start_pos, hls->size);
829  }
830 
831  if (vtt_oc) {
832  if (vtt_oc->pb)
833  av_write_trailer(vtt_oc);
834  hls->size = avio_tell(hls->vtt_avf->pb) - hls->start_pos;
835  ff_format_io_close(s, &vtt_oc->pb);
836  }
837  av_freep(&hls->basename);
839 
840  if (vtt_oc) {
841  av_freep(&hls->vtt_basename);
842  av_freep(&hls->vtt_m3u8_name);
843  avformat_free_context(vtt_oc);
844  }
845 
846  hls->avf = NULL;
847  hls_window(s, 1);
848 
851  return 0;
852 }
853 
854 #define OFFSET(x) offsetof(HLSContext, x)
855 #define E AV_OPT_FLAG_ENCODING_PARAM
856 static const AVOption options[] = {
857  {"start_number", "set first number in the sequence", OFFSET(start_sequence),AV_OPT_TYPE_INT64, {.i64 = 0}, 0, INT64_MAX, E},
858  {"hls_time", "set segment length in seconds", OFFSET(time), AV_OPT_TYPE_FLOAT, {.dbl = 2}, 0, FLT_MAX, E},
859  {"hls_list_size", "set maximum number of playlist entries", OFFSET(max_nb_segments), AV_OPT_TYPE_INT, {.i64 = 5}, 0, INT_MAX, E},
860  {"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},
861  {"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},
862  {"hls_wrap", "set number after which the index wraps", OFFSET(wrap), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, E},
863  {"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},
864  {"hls_base_url", "url to prepend to each playlist entry", OFFSET(baseurl), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
865  {"hls_segment_filename", "filename template for segment files", OFFSET(segment_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
866  {"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},
867  {"hls_subtitle_path", "set path of hls subtitles", OFFSET(subtitle_filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
868  {"hls_flags", "set flags affecting HLS playlist and media file generation", OFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0 }, 0, UINT_MAX, E, "flags"},
869  {"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"},
870  {"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"},
871  {"round_durations", "round durations in m3u8 to whole numbers", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_ROUND_DURATIONS }, 0, UINT_MAX, E, "flags"},
872  {"discont_start", "start the playlist with a discontinuity tag", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_DISCONT_START }, 0, UINT_MAX, E, "flags"},
873  {"omit_endlist", "Do not append an endlist when ending stream", 0, AV_OPT_TYPE_CONST, {.i64 = HLS_OMIT_ENDLIST }, 0, UINT_MAX, E, "flags"},
874  { "use_localtime", "set filename expansion with strftime at segment creation", OFFSET(use_localtime), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, E },
875  {"method", "set the HTTP method", OFFSET(method), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E},
876 
877  { NULL },
878 };
879 
880 static const AVClass hls_class = {
881  .class_name = "hls muxer",
882  .item_name = av_default_item_name,
883  .option = options,
884  .version = LIBAVUTIL_VERSION_INT,
885 };
886 
887 
889  .name = "hls",
890  .long_name = NULL_IF_CONFIG_SMALL("Apple HTTP Live Streaming"),
891  .extensions = "m3u8",
892  .priv_data_size = sizeof(HLSContext),
893  .audio_codec = AV_CODEC_ID_AAC,
894  .video_codec = AV_CODEC_ID_H264,
895  .subtitle_codec = AV_CODEC_ID_WEBVTT,
900  .priv_class = &hls_class,
901 };
float time
Definition: hlsenc.c:78
#define NULL
Definition: coverity.c:32
int wrap
Definition: hlsenc.c:80
char key_uri[LINE_BUFFER_SIZE+1]
Definition: hlsenc.c:112
const char * s
Definition: avisynth_c.h:631
Bytestream IO Context.
Definition: avio.h:111
char * basename
Definition: hlsenc.c:101
AVIOInterruptCB interrupt_callback
Custom interrupt callbacks for the I/O layer.
Definition: avformat.h:1566
AVOption.
Definition: opt.h:245
static int hls_write_trailer(struct AVFormatContext *s)
Definition: hlsenc.c:818
int av_write_frame(AVFormatContext *s, AVPacket *pkt)
Write a packet to an output media file.
Definition: mux.c:777
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
#define LIBAVUTIL_VERSION_INT
Definition: version.h:70
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:4149
double duration
Definition: hlsenc.c:48
int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt, AVFormatContext *src, int interleave)
Write a packet to another muxer than the one the user originally intended.
Definition: mux.c:1152
char * vtt_format_options_str
Definition: hlsenc.c:106
AVRational sample_aspect_ratio
sample aspect ratio (0 if unknown)
Definition: avformat.h:949
int64_t size
Definition: hlsenc.c:50
int num
numerator
Definition: rational.h:44
int av_dict_count(const AVDictionary *m)
Get number of entries in dictionary.
Definition: dict.c:34
#define AVIO_FLAG_READ
read-only
Definition: avio.h:537
#define AVIO_FLAG_WRITE
write-only
Definition: avio.h:538
int av_dict_copy(AVDictionary **dst, const AVDictionary *src, int flags)
Copy entries from one AVDictionary struct into another.
Definition: dict.c:213
int version
Definition: avisynth_c.h:629
static AVPacket pkt
#define AVFMT_ALLOW_FLUSH
Format allows flushing.
Definition: avformat.h:494
int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
Copy the settings of the source AVCodecContext into the destination AVCodecContext.
Definition: options.c:182
static int hls_window(AVFormatContext *s, int last)
Definition: hlsenc.c:376
static void set_http_options(AVDictionary **options, HLSContext *c)
Definition: hlsenc.c:370
Format I/O context.
Definition: avformat.h:1314
int max_nb_segments
Definition: hlsenc.c:79
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:72
const char * av_basename(const char *path)
Thread safe basename.
Definition: avstring.c:234
uint8_t
#define av_malloc(s)
AVOptions.
miscellaneous OS support macros and functions.
static void hls_free_segments(HLSSegment *p)
Definition: hlsenc.c:359
HLSSegment * old_segments
Definition: hlsenc.c:99
int64_t end_pts
Definition: hlsenc.c:90
void ff_format_io_close(AVFormatContext *s, AVIOContext **pb)
Definition: utils.c:4748
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:3805
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1382
#define AVERROR_EOF
End of file.
Definition: error.h:55
char * format_options_str
Definition: hlsenc.c:105
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:192
#define LINE_BUFFER_SIZE
Definition: hlsenc.c:43
ptrdiff_t size
Definition: opengl_enc.c:101
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:442
#define av_log(a,...)
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:545
struct AVOutputFormat * oformat
The output container format.
Definition: avformat.h:1333
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1499
int avformat_alloc_output_context2(AVFormatContext **ctx, AVOutputFormat *oformat, const char *format_name, const char *filename)
Allocate an AVFormatContext for an output format.
Definition: mux.c:148
static const AVOption options[]
Definition: hlsenc.c:856
static int hls_write_header(AVFormatContext *s)
Definition: hlsenc.c:584
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
AVDictionary * metadata
Metadata that applies to the whole file.
Definition: avformat.h:1528
#define OFFSET(x)
Definition: hlsenc.c:854
av_default_item_name
#define AVERROR(e)
Definition: error.h:43
struct HLSSegment * next
Definition: hlsenc.c:55
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:176
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:197
char sub_filename[1024]
Definition: hlsenc.c:47
void av_dict_free(AVDictionary **pm)
Free all the memory allocated for an AVDictionary struct and all keys and values. ...
Definition: dict.c:199
AVDictionary * vtt_format_options
Definition: hlsenc.c:115
#define wrap(func)
Definition: neontest.h:65
simple assert() macros that are a bit more flexible than ISO C assert().
int has_video
Definition: hlsenc.c:87
double duration
Definition: hlsenc.c:91
char key_uri[LINE_BUFFER_SIZE+1]
Definition: hlsenc.c:52
int64_t recording_time
Definition: hlsenc.c:86
#define FFMAX(a, b)
Definition: common.h:94
size_t av_strlcpy(char *dst, const char *src, size_t size)
Copy the string src to dst, but no more than size - 1 bytes, and null-terminate dst.
Definition: avstring.c:83
#define fail()
Definition: checkasm.h:79
int64_t pos
Definition: hlsenc.c:49
char * vtt_basename
Definition: hlsenc.c:102
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:1473
int av_compare_ts(int64_t ts_a, AVRational tb_a, int64_t ts_b, AVRational tb_b)
Compare 2 timestamps each in its own timebases.
Definition: mathematics.c:147
void * opaque
User data.
Definition: avformat.h:1794
AVCodecContext * codec
Codec context associated with this stream.
Definition: avformat.h:896
char * baseurl
Definition: hlsenc.c:104
char * av_asprintf(const char *fmt,...)
Definition: avstring.c:113
Definition: hls.c:68
unsigned int nb_streams
Number of elements in AVFormatContext.streams.
Definition: avformat.h:1370
int discontinuity_set
Definition: hlsenc.c:95
unsigned number
Definition: hlsenc.c:69
char key_string[KEYSIZE *2+1]
Definition: hlsenc.c:113
char filename[1024]
input or output filename
Definition: avformat.h:1390
#define AV_TIME_BASE
Internal time base represented as integer.
Definition: avutil.h:246
av_warn_unused_result int avformat_write_header(AVFormatContext *s, AVDictionary **options)
Allocate the stream private data and write the stream header to an output media file.
Definition: mux.c:451
int av_strcasecmp(const char *a, const char *b)
Locale-independent case-insensitive compare.
Definition: avstring.c:213
static struct tm * localtime_r(const time_t *clock, struct tm *result)
Definition: time_internal.h:37
int64_t start_pts
Definition: hlsenc.c:89
static int write_trailer(AVFormatContext *s1)
Definition: v4l2enc.c:94
static int hls_write_packet(AVFormatContext *s, AVPacket *pkt)
Definition: hlsenc.c:740
const char * name
Definition: avformat.h:523
int64_t duration
Definition: movenc-test.c:63
HLSSegment * last_segment
Definition: hlsenc.c:98
#define E
Definition: hlsenc.c:855
AVOutputFormat * av_guess_format(const char *short_name, const char *filename, const char *mime_type)
Return the output format in the list of registered output formats which best matches the provided par...
Definition: format.c:94
HLSSegment * segments
Definition: hlsenc.c:97
AVDictionary * format_options
Definition: hlsenc.c:108
int ff_get_line(AVIOContext *s, char *buf, int maxlen)
Read a whole line of text from AVIOContext.
Definition: aviobuf.c:706
const AVClass * priv_class
AVClass for the private context.
Definition: avformat.h:551
int av_get_frame_filename(char *buf, int buf_size, const char *path, int number)
Return in 'buf' the path with 'd' replaced by a number.
Definition: utils.c:3974
static int hls_delete_old_segments(HLSContext *hls)
Definition: hlsenc.c:121
int use_localtime
flag to expand filename with localtime
Definition: hlsenc.c:84
FILE * out
Definition: movenc-test.c:54
Stream structure.
Definition: avformat.h:877
int av_dict_parse_string(AVDictionary **pm, const char *str, const char *key_val_sep, const char *pairs_sep, int flags)
Parse the key/value pairs list and add the parsed entries to a dictionary.
Definition: dict.c:176
char iv_string[KEYSIZE *2+1]
Definition: hlsenc.c:53
int64_t start_sequence
Definition: hlsenc.c:71
enum AVMediaType codec_type
Definition: avcodec.h:1540
int has_subtitle
Definition: hlsenc.c:88
#define AV_TIME_BASE_Q
Internal time base represented as fractional value.
Definition: avutil.h:252
char * av_strdup(const char *s)
Duplicate the string s.
Definition: mem.c:267
AVIOContext * pb
I/O context.
Definition: avformat.h:1356
static int hls_encryption_start(AVFormatContext *s)
Definition: hlsenc.c:206
char * key_info_file
Definition: hlsenc.c:110
AVOutputFormat * oformat
Definition: hlsenc.c:72
char * method
Definition: hlsenc.c:117
int allowcache
Definition: hlsenc.c:85
HLSFlags
Definition: hlsenc.c:58
static int ff_rename(const char *oldpath, const char *newpath, void *logctx)
Wrap errno on rename() error.
Definition: internal.h:485
int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags)
Set the given entry in *pm, overwriting an existing entry.
Definition: dict.c:69
Describe the class of an AVClass context structure.
Definition: log.h:67
char iv_string[KEYSIZE *2+1]
Definition: hlsenc.c:114
#define snprintf
Definition: snprintf.h:34
void avformat_free_context(AVFormatContext *s)
Free an AVFormatContext and all its streams.
Definition: utils.c:3741
int64_t sequence
Definition: hlsenc.c:70
misc parsing utilities
size_t av_strlcat(char *dst, const char *src, size_t size)
Append the string src to the string dst, but to a total length of no more than size - 1 bytes...
Definition: avstring.c:93
const char * avio_find_protocol_name(const char *url)
Return the name of the protocol that will handle the passed URL.
Definition: avio.c:485
char key_file[LINE_BUFFER_SIZE+1]
Definition: hlsenc.c:111
static int flags
Definition: cpu.c:47
static int hls_mux_init(AVFormatContext *s)
Definition: hlsenc.c:258
int64_t size
Definition: hlsenc.c:93
static int hls_append_segment(HLSContext *hls, double duration, int64_t pos, int64_t size)
Definition: hlsenc.c:307
int nb_entries
Definition: hlsenc.c:94
Main libavformat public API header.
#define AVFMT_NOFILE
Demuxer will use avio_open, no opened file should be provided by the caller.
Definition: avformat.h:477
static double c[64]
uint32_t flags
Definition: hlsenc.c:81
int pts_wrap_bits
number of bits in pts (used for wrapping control)
Definition: avformat.h:1043
int den
denominator
Definition: rational.h:45
#define KEYSIZE
Definition: hlsenc.c:42
int64_t start_pos
Definition: hlsenc.c:92
char * segment_filename
Definition: hlsenc.c:82
#define av_free(p)
char * vtt_m3u8_name
Definition: hlsenc.c:103
char filename[1024]
Definition: hlsenc.c:46
static int hls_start(AVFormatContext *s)
Definition: hlsenc.c:486
void * priv_data
Format private data.
Definition: avformat.h:1342
char * subtitle_filename
Definition: hlsenc.c:107
static const uint8_t start_sequence[]
Definition: rtpdec_h264.c:65
static void write_header(FFV1Context *f)
Definition: ffv1enc.c:497
#define lrint
Definition: tablegen.h:53
AVFormatContext * avf
Definition: hlsenc.c:75
AVOutputFormat ff_hls_muxer
Definition: hlsenc.c:888
int av_write_trailer(AVFormatContext *s)
Write the stream trailer to an output media file and free the file private data.
Definition: mux.c:1083
#define av_freep(p)
#define AVERROR_MUXER_NOT_FOUND
Muxer not found.
Definition: error.h:60
AVOutputFormat * vtt_oformat
Definition: hlsenc.c:73
int stream_index
Definition: avcodec.h:1469
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avformat.h:919
static const AVClass hls_class
Definition: hlsenc.c:880
int(* io_open)(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags, AVDictionary **options)
Definition: avformat.h:1872
char * ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase)
Definition: utils.c:4100
This structure stores compressed data.
Definition: avcodec.h:1444
static int write_packet(AVFormatContext *s1, AVPacket *pkt)
Definition: v4l2enc.c:86
int av_opt_set(void *obj, const char *name, const char *val, int search_flags)
Definition: opt.c:393
void(* io_close)(struct AVFormatContext *s, AVIOContext *pb)
A callback for closing the streams opened with AVFormatContext.io_open().
Definition: avformat.h:1878
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1460
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:240
int avio_printf(AVIOContext *s, const char *fmt,...) av_printf_format(2
AVFormatContext * vtt_avf
Definition: hlsenc.c:76