-Hardware requirements for getting started
-=========================================
+Hardware requirements
+=====================
Nageru is designed to be as plug-and-play as possible, but by nature,
a software video mixer requires a certain amount of hardware with associated
.. _digital-intermediate:
-VA-API H.264 encoding
----------------------
+VA-API H.264 encoding (optional)
+--------------------------------
Even on modern networks and with today's large SSDs, uncompressed HD video is a
bit unwieldy to send around (uncompressed 720p60 4:2:0 is about 79 MB/sec,
(for future editing or re-streaming) or sent to an encoder on another machine
for final streaming.
-Currently, only VA-API is supported for H.264 encoding, although Nageru might
-support NVIDIA's NVENC at some point in the future. In particular, this means that Intel Quick
-Sync Video (QSV), the hardware H.264 encoder present on all modern Intel
-GPUs, is supported. QSV is more than fast enough to keep up with 720p60 in
+Although you can (since Nageru 1.5.0) use software encoding through x264 for
+the digital intermediate, it is generally preferred to use a hardware encoder
+if it is available. Currently, VA-API is the only hardware encoding method
+supported for encoding the digital intermediate, although Nageru might support
+NVIDIA's NVENC at some point in the future. In particular, this means that
+Intel Quick Sync Video (QSV), the hardware H.264 encoder present on all modern
+Intel GPUs, is supported.
+
+QSV is more than fast enough to keep up with 720p60 in
realtime without eating appreciably into the power budget, but it is not
competitive with the top H.264 encoders in terms of quality per bit. Also,
the stream is encoded using *constant quality* (fixed quantizer), not
further editing or transcoding without strong generational loss.) Thus, the
QSV stream is not intended for streaming to end users of the Internet; it will
need to be reencoded by some external means, or you can use Nageru's x264
-support (see `:doc:Streaming`).
+support to produce a user-facing stream in addition to the digital intermediate
+(see :doc:`streaming`).
By default, Nageru uses zerocopy from the GPU to the VA-API buffers in order to
reduce memory transfer bandwidth, but this depends on EGL support (as opposed to
the older GLX standard), and also that the GPU you are rendering to also
supports VA-API. NVIDIA's proprietary drivers do not support either. Unfortunately,
-this is somewhat cumbersoe to automatically detect before it's too late to do anything
+this is somewhat cumbersome to automatically detect before it's too late to do anything
about it (Qt has already initialized using EGL), so on NVIDIA
systems, Nageru will exit with an error message asking you to set *--va-display*
to your Intel GPU manually. Simply follow the instructions printed to the terminal
(`Desktop Video <https://www.blackmagicdesign.com/support>`_) installed
and working. It is non-free and thus not included in most Linux distributions.
However, the SDK is not needed for building Nageru; the required headers
-are free and included. Note that the PCI cards generally do not autodetect,
-so you will need to right-click on the input to set the right mode.
+are free and included. Most of the PCI cards autodetect, but for some older
+versions, you will need to right-click on the input to set the right mode.
Video format conversion
-----------------------
If you have an input source with a different resolution than the native mode
-(currently locked to 720p; this will be configurable without recompiling
-in the future), Nageru will scale transparently for you using a Lanczos3
-filter. This requires some extra GPU power, so if you can avoid it, use the
-native mode. Similarly, if you connect an interlaced input, Nageru will
-automatically deinterlace for you.
+(720p by default, but you can change this using the -w and -h command line
+parameters), Nageru will scale transparently for you using a Lanczos3
+filter (or rather, the :doc:`theme <theme>` will). This requires some extra GPU power,
+so if you can avoid it, use the native mode. Similarly, if you connect an
+interlaced input, Nageru will automatically deinterlace for you.
Frame rates are automatically converted; one input is designated as the
**master clock** (right-click on an input to select it as such), and gets
to dictate the frame rate of the output. Inputs with differing frame rates
-will get frames duplicated or dropped as needed (with adaptive queueing to
+will get frames duplicated or dropped as needed (with adaptive queuing to
account for clock and jitter).
Nageru works in 16-bit floating-point RGBA internally. High-quality conversion to and
from subsampled Y'CbCr (typically 4:2:2 for inputs and 4:2:0 for outputs)
-is done transparently on the GPU.
+is done transparently on the GPU. Input and output is 8-bit Y'CbCr by default,
+but be aware that 8-bit Y'CbCr, however common, cannot capture the full color
+fidelity of 8-bit RGB (not to mention 10-bit RGB). If you have spare GPU power,
+you can enable 10-bit Y'CbCr input and output with --10-bit-input and
+--10-bit-output, respectively, although you should be aware that client
+support for 10-bit H.264 is very limited. Also, Quick Sync Video does not
+support 10-bit H.264 encoding, so in this case, the digital intermediate needs
+to be encoded in software.
+
+
+Performance tips
+----------------
+
+It is strongly recommended to have the rights to run at real-time priority;
+it will make the USB3 threads do so, which will make them a lot more stable.
+(A reasonable hack for testing is probably just to run it as root using sudo,
+although you might not want to do that in production, but instead grant
+your regular user permissions in /etc/security/limits.conf.) Note also that if you
+are running a desktop compositor, it will steal significant amounts of GPU
+performance. The same goes for PulseAudio.
+
+Nageru tries to lock itself into RAM if it has the permissions to do
+so, for better realtime behavior. (Writing the stream to disk tends to
+fill the buffer cache, eventually paging less-used parts of Nageru out.)
+Again, this is something you can set in limits.conf.
projects / nageru-docs / blobdiff