git.sesse.net Git - nageru-docs/blob - hardware.rst

   1 Hardware requirements
   2 =====================
   3
   4 Nageru is designed to be as plug-and-play as possible, but by nature,
   5 a software video mixer requires a certain amount of hardware with associated
   6 drivers.
   7
   8 Working OpenGL
   9 --------------
  10
  11 Nageru uses your computer's graphics processing unit (GPU) extensively,
  12 through OpenGL. The use of the GPU is the reason why Nageru can deliver
  13 high-quality (as in e.g. gamma-correct fades and high-quality scaling)
  14 HD video without a monster CPU, but it also comes with certain caveats.
  15
  16 In particular, Nageru's use of multithreaded OpenGL trickles bugs in
  17 some drivers. in general, Intel GPUs from the Haswell
  18 generation and newer should work well with Nageru, although they may
  19 see performance issues if you connect interlaced sources (since the
  20 automatic deinterlacing applied requires a fair bit of computing power). NVIDIA's
  21 proprietary drivers (occasionally known as nvidia-glx) are generally excellent
  22 and should give few issues in this regard.
  23
  24 If you see Nageru dying with a message about “GL error”, or segfaulting with
  25 the stack trace pointing into libGL.so, your first intuition should be to check
  26 that you have the latest drivers for your GPU.
  27
  28
  29 .. _digital-intermediate:
  30
  31 VA-API H.264 encoding (optional)
  32 --------------------------------
  33
  34 Even on modern networks and with today's large SSDs, uncompressed HD video is a
  35 bit unwieldy to send around (uncompressed 720p60 4:2:0 is about 79 MB/sec,
  36 or 663 Mbit/sec). Nageru creates a high-bitrate H.264 stream of the finished
  37 output as a sort of “digital intermediate” that can much easier be stored to disk
  38 (for future editing or re-streaming) or sent to an encoder on another machine
  39 for final streaming.
  40
  41 Although you can use software encoding through x264 for
  42 the digital intermediate, it is generally preferred to use a hardware encoder
  43 if it is available. Currently, VA-API is the only hardware encoding method
  44 supported for encoding the digital intermediate, although Nageru might support
  45 NVIDIA's NVENC at some point in the future. In particular, this means that
  46 Intel Quick Sync Video (QSV), the hardware H.264 encoder present on all modern
  47 Intel GPUs, is supported. If possible, Nageru uses zerocopy from the GPU to the
  48 VA-API buffers in order to reduce memory transfer bandwidth.
  49
  50 QSV is more than fast enough to keep up with 720p60 in
  51 realtime without eating appreciably into the power budget, but it is not
  52 competitive with the top H.264 encoders in terms of quality per bit. Also,
  53 the stream is encoded using *constant quality* (fixed quantizer), not
  54 constant bitrate, which means the bitrate will vary strongly with content.
  55 (For practical material, the quantizer used by Nageru will end up around
  56 25 Mbit/sec for 720p60, and be nearly visually lossless so as to allow
  57 further editing or transcoding without strong generational loss.) Thus, the
  58 QSV stream is not intended for streaming to end users of the Internet; it will
  59 need to be reencoded by some external means, or you can use Nageru's x264
  60 support to produce a user-facing stream in addition to the digital intermediate
  61 (see :doc:`streaming`). You can also use x264 to produce the recording to disk
  62 instead of Quick Sync, using the --x264-record-video flag. If you wish to have
  63 separate flags for streaming and storing to disk (e.g., to keep a digital intermediate
  64 on disk), and have Nageru 2.1.0 or newer, you can use the --separate-x264-disk-encode flag (and associated
  65 --x264-separate-disk-bitrate flags etc.). Otherwise, the same stream will go
  66 to the network and to disk.
  67
  68
  69 Video capture cards
  70 -------------------
  71
  72 If you do not have enough cards to satisfy your theme when you start up
  73 Nageru, *fake cards* will be instantiated. They produce a simple color
  74 (depending on the card) and no audio (unless you give the --fake-cards-audio
  75 command-line flag, in which case they will produce a tone). USB hotplug
  76 is supported; once you insert a new card, it will automatically be detected
  77 and takes the place of one of the fake cards.
  78
  79 Currently, Nageru supports only Blackmagic's capture cards; specifically,
  80 it does not support Video4Linux. This may change in the future if cards
  81 come along that significantly improve upon Blackmagic's lineup in terms
  82 of features, price or stability. (Most other cards fail on all three counts.)
  83
  84 There are separate drivers for the USB and PCI cards. (Thunderbolt cards,
  85 although rare, count as PCI cards in this respect.) The USB cards are
  86 handled by a driver called *bmusb* that is built into Nageru; they require
  87 working USB3 on your machine, but nothing else. (Kernel versions prior to
  88 4.6 are not recommended, though. If you get USB issues, upgrade your kernel.)
  89 The cards autodetect their input, but unfortunately has no 1080p60 support,
  90 which means that most laptops plugged in will default to 1080i60, which
  91 probably is not what you want. (In particular, the YADIF deinterlacer
  92 employed by Nageru puts a lot of strain on the GPU; too much for most
  93 Intel GPUs.)
  94
  95 The PCI cards (known as DeckLink) require Blackmagic's proprietary driver
  96 (`Desktop Video <https://www.blackmagicdesign.com/support>`_) installed
  97 and working. It is non-free and thus not included in most Linux distributions.
  98 However, the SDK is not needed for building Nageru; the required headers
  99 are free and included. Most of the PCI cards autodetect, but for some older
 100 versions, you will need to right-click on the input to set the right mode.
 101
 102
 103 Video format conversion
 104 -----------------------
 105
 106 If you have an input source with a different resolution than the native mode
 107 (720p by default, but you can change this using the -w and -h command line
 108 parameters), Nageru will scale transparently for you using a Lanczos3
 109 filter (or rather, the :doc:`theme <theme>` will). This requires some extra GPU power,
 110 so if you can avoid it, use the native mode. Similarly, if you connect an
 111 interlaced input, Nageru will automatically deinterlace for you.
 112
 113 Frame rates are automatically converted; one input is designated as the
 114 **master clock** (right-click on an input to select it as such), and gets
 115 to dictate the frame rate of the output. Inputs with differing frame rates
 116 will get frames duplicated or dropped as needed (with adaptive queuing to
 117 account for clock and jitter).
 118
 119 Nageru works in 16-bit floating-point RGBA internally. High-quality conversion to and
 120 from subsampled Y'CbCr (typically 4:2:2 for inputs and 4:2:0 for outputs)
 121 is done transparently on the GPU. Input and output is 8-bit Y'CbCr by default,
 122 but be aware that 8-bit Y'CbCr, however common, cannot capture the full color
 123 fidelity of 8-bit RGB (not to mention 10-bit RGB). If you have spare GPU power,
 124 you can enable 10-bit Y'CbCr input and output with --10-bit (before Nageru 2.2.0,
 125 you needed to use --10-bit-input and --10-bit-output as separate flags),
 126 although you should be aware that client
 127 support for 10-bit H.264 is very limited. Also, Quick Sync Video does not
 128 support 10-bit H.264 encoding, so in this case, the digital intermediate needs
 129 to be encoded in software.
 130
 131
 132 Performance tips
 133 ----------------
 134
 135 It is strongly recommended to have the rights to run at real-time priority;
 136 it will make the USB3 threads do so, which will make them a lot more stable.
 137 (A reasonable hack for testing is probably just to run it as root using sudo,
 138 although you might not want to do that in production, but instead grant
 139 your regular user permissions in /etc/security/limits.conf.) Note also that if you
 140 are running a desktop compositor, it will steal significant amounts of GPU
 141 performance. The same goes for PulseAudio.
 142
 143 Nageru tries to lock itself into RAM if it has the permissions to do
 144 so, for better realtime behavior. (Writing the stream to disk tends to
 145 fill the buffer cache, eventually paging less-used parts of Nageru out.)
 146 Again, this is something you can set in limits.conf.