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

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