]> git.sesse.net Git - nageru-docs/blob - hardware.rst
Add a node about hardware and driver requirements.
[nageru-docs] / hardware.rst
1 Hardware requirements for getting started
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, as most games access the GPU from only one thread;
18 Mesa didn't work properly at all before version 11.2, and there are still
19 bugs left as of 13.0. However, in general, Intel GPUs from the Haswell
20 generation and newer should work well with Nageru as long as you stick to
21 720p60 (ie., no 1080i inputs, which require deinterlacing). NVIDIA's
22 proprietary drivers (occasionally known as nvidia-glx) are generally excellent
23 and should give few issues in this regard.
24
25 If you see Nageru dying with a message about “GL error”, or segfaulting with
26 the stack trace pointing into libGL.so, your first intuition should be to check
27 that you have the latest drivers for your GPU.
28
29
30 VA-API H.264 encoding
31 ---------------------
32
33 Even on modern networks and with today's large SSDs, uncompressed HD video is a
34 bit unwieldy to send around (uncompressed 720p60 4:2:0 is about 79 MB/sec,
35 or 663 Mbit/sec). Nageru creates a high-bitrate H.264 stream of the finished
36 output as a sort of “digital intermediate” that can much easier be stored to disk
37 (for future editing or re-streaming) or sent to an encoder on another machine
38 for final streaming.
39
40 Currently, only VA-API is supported for H.264 encoding, although Nageru might
41 support NVIDIA's NVENC at some point in the future. In particular, this means that Intel Quick
42 Sync Video (QSV), the hardware H.264 encoder present on all modern Intel
43 GPUs, is supported. QSV is more than fast enough to keep up with 720p60 in
44 realtime without eating appreciably into the power budget, but it is not
45 competitive with the top H.264 encoders in terms of quality per bit. Also,
46 the stream is encoded using *constant quality* (fixed quantizer), not
47 constant bitrate, which means the bitrate will vary strongly with content.
48 (For practical material, the quantizer used by Nageru will end up around
49 25 Mbit/sec for 720p60, and be nearly visually lossless so as to allow
50 further editing or transcoding without strong generational loss.) Thus, the
51 QSV stream is not intended for streaming to end users of the Internet; it will
52 need to be reencoded by some external means, or you can use Nageru's x264
53 support (see `:doc:Streaming`).
54
55 By default, Nageru uses zerocopy from the GPU to the VA-API buffers in order to
56 reduce memory transfer bandwidth, but this depends on EGL support (as opposed to
57 the older GLX standard), and also that the GPU you are rendering to also
58 supports VA-API. NVIDIA's proprietary drivers do not support either. Unfortunately,
59 this is somewhat cumbersoe  to automatically detect before it's too late to do anything
60 about it (Qt has already initialized using EGL), so on NVIDIA
61 systems, Nageru will exit with an error message asking you to set *--va-display*
62 to your Intel GPU manually. Simply follow the instructions printed to the terminal
63 to select what looks like your Intel GPU, and Nageru will fall back to using GLX
64 and transferring the memory data between the two GPUs via the CPU. (Some BIOSes
65 automatically disable the Intel GPU if you have a discrete GPU installed; you
66 will need to reenable it to get access to QSV, or Nageru can't run.)
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. Note that the PCI cards generally do not autodetect,
100 so 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 (currently locked to 720p; this will be configurable without recompiling
108 in the future), Nageru will scale transparently for you using a Lanczos3
109 filter. This requires some extra GPU power, so if you can avoid it, use the
110 native mode. Similarly, if you connect an interlaced input, Nageru will
111 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 queueing 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.