git.sesse.net Git - cubemap/blob - README

   1 Cubemap is a high-performance, high-availability video reflector,
   2 specifically made for use with VLC.
   3
   4 A short list of features:
   5
   6  - High-performance, through a design with multiple worker threads,
   7    epoll and sendfile (yes, sendfile); a 2GHz quadcore can saturate
   8    10 gigabit Ethernet (even with TLS) given a modern kernel.
   9  - High-availability. You can change any part of the configuration
  10    (and even upgrade to a newer version of Cubemap) by changing cubemap.config
  11    and sending a SIGHUP; all clients will continue as if nothing had happened
  12    (unless you delete the stream they are watching, of course).
  13    Cubemap also survives the encoder dying and reconnecting.
  14  - Support for setting max pacing rate through the fq packet scheduler.
  15  - Reflects anything VLC can reflect over HTTP, even the muxes VLC
  16    has problems reflecting itself (in particular, FLV).
  17  - Multicast support, both for sending and receiving (supports only protocols
  18    that can go over UDP, e.g. MPEG-TS). Supports both ASM and SSM.
  19  - TLS output support, through the TLSe library (requires libtomcrypt)
  20    and the Linux kernel's kTLS (Linux 4.17 or newer). There are a few
  21    limitations; see below.
  22  - fMP4 (HLS) output support, generating playlists on-the-fly. Note that this
  23    requires some extra metadata currently only set by Nageru (not VLC).
  24  - IPv4 support. Yes, Cubemap even supports (some) legacy protocols.
  25
  26
  27 HOWTO:
  28
  29   sudo apt install libprotobuf-dev protobuf-compiler libsystemd-dev libtomcrypt-dev pkg-config
  30   ./configure
  31   make -j4
  32
  33 If you want to use HTTP input (you probably want to), you want VLC 2.2.0
  34 or newer. Then start the VLC encoder with the “metacube” flag to the http
  35 access mux, like this:
  36
  37   cvlc [...] --sout '#std{access=http{metacube,mime=video/x-flv},mux=flv,dst=:4013/test.flv}'
  38
  39 Then look through cubemap.config.sample, copy it to cubemap.config,
  40 compile and start cubemap.
  41
  42 Nageru, my free video mixer, can also produce Metacube streams natively.
  43 See the manual at https://nageru.sesse.net/doc/ for more information.
  44
  45 If you feel very adventurous, you can use LD_PRELOAD to load
  46 ffmpeg_metacube_hack.so into an FFmpeg-using binary. (This is
  47 experimental; native Metacube support is vastly preferred.)
  48 For instance, here's one way you can use the ffmpeg(1) binary
  49 to serve your webcam to Cubemap:
  50
  51   LD_PRELOAD=ffmpeg_metacube_hack.so ffmpeg -i /dev/video0 -f mpegts -listen 1 'http://[::]:9095'
  52
  53
  54 To upgrade cubemap (after you've compiled a new binary), or to pick up new
  55 config:
  56
  57   killall -HUP cubemap
  58
  59 Cubemap will serialize itself to disk, check that the new binary and config
  60 are OK, and then exec() the new version, which deserializes everything and
  61 keeps going.
  62
  63
  64 Notes on TLS support:
  65
  66 Cubemap supports TLS on output, so that you can play video on TLS
  67 web sites without issues with mixed content. TLS on input streams is
  68 not (yet) supported.
  69
  70 TLS requires kTLS for both send and receive, ie., Linux >= 4.17 with CONFIG_TLS
  71 enabled. Only cipher suites supported by kTLS is supposed, ie., AES-128-GCM
  72 (if no such cipher suite is available, the connection will be aborted). If the
  73 server is restarted before the key exchange for a connection is completed,
  74 that connection will not survive the restart, unlike all other connections.
  75 (This is a TLSe limitation.) You can have different certificates on different
  76 ports (and have separate ports for TLS and non-TLS), but SNI is not yet
  77 supported.
  78
  79
  80 Munin plugins:
  81
  82 To activate these, symlink them into /etc/munin/plugins. If you don't put
  83 the files in the expected default locations (as done by 'make install'),
  84 you probably want some configuration in /etc/munin/plugin-conf.d/cubemap or
  85 similar, like this:
  86
  87 [cubemap*]
  88 user <something>
  89 env.cubemap_config /etc/cubemap/cubemap.config
  90 env.cubemap_stats /var/lib/cubemap/cubemap.stats
  91 env.cubemap_input_stats /var/lib/cubemap/cubemap-input.stats
  92
  93
  94 Legalese:
  95
  96 Copyright 2013 Steinar H. Gunderson <steinar+cubemap@gunderson.no>.
  97 Licensed under the GNU GPL, version 2. See the included COPYING file.
  98
  99 See tlse/LICENSE for TLSe licensing.