]> git.sesse.net Git - nageru-docs/blobdiff - intro.rst
Sync introduction with README.
[nageru-docs] / intro.rst
index 308bcee1737b78fd0d42b2bd56096efeace96329..131ab9d6e088c689125e050043e08d0803654b36 100644 (file)
--- a/intro.rst
+++ b/intro.rst
@@ -45,18 +45,18 @@ usually give you a newer version). It currently need:
 
  - Qt 5.5 or newer for the GUI.
 
- - QCustomPlot for the histogram display in the frame analyzer.
+ - QCustomPlot for the histogram display in the frame analyzer
+   (no longer needed from Nageru 2.2.0).
 
  - libmicrohttpd for the embedded web server.
 
  - x264 for encoding high-quality video suitable for streaming to end users.
 
  - FFmpeg for muxing, and for encoding audio. You will need at least
-   version 4.0.
+   version 5.0.
 
  - Working OpenGL; Movit works with almost any modern OpenGL implementation.
-   Nageru has been tested with Intel on Mesa (you want 11.2 or newer, due
-   to critical stability bugfixes), and with NVIDIA's proprietary drivers.
+   Nageru has been tested with Intel on Mesa), and with NVIDIA's proprietary drivers.
    The status of AMD's proprietary drivers is currently unknown.
 
  - libzita-resampler, for resampling sound sources so that they are in sync
@@ -64,13 +64,9 @@ usually give you a newer version). It currently need:
 
  - LuaJIT, for driving the theme engine. You will need at least version 2.1.
 
- - SQLite, for storing Futatabi state.
-
  - libjpeg, for encoding MJPEG streams when VA-API JPEG support is not
    available.
 
- - Zita-resampler, for adjusting audio to be in sync with video.
-
  - Protocol Buffers (protobuf), for storing various forms of settings and
    state.
 
@@ -86,19 +82,38 @@ usually give you a newer version). It currently need:
    is fine) and add -Dcef_dir=<path>/cef_binary_X.XXXX.XXXX.XXXXXXXX_linux64
    on the meson command line (substituting X with the real version as required).
 
+ - Optional: libsrt, for SRT inputs (by default, Nageru will listen on
+   port 9710, although you can change this port on the command line,
+   turn it off with --srt-port -1, or turn it off live in the UI).
+   SRT can also be used for output in addition to listening for HTTP
+   (see --srt-destination). If you build with libsrt, make sure it is not
+   linked to OpenSSL, for license reasons.
+
+ - Optional: SVT-AV1, for encoding high-quality video suitable for streaming to
+   end users (higher quality than using x264, but not nearly as mature).
+   You will need at least version 1.5.0.
+
 
-If on Debian buster or something similar, you can install everything you need
+:doc:`Futatabi <futatabi>` also needs:
+
+ - A fast GPU with OpenGL 4.5 support (GTX 1080 or similar recommended for
+   best quality at HD resolutions, although 950 should work).
+
+ - SQLite, for storing state.
+
+If on Debian bullseye or something similar, you can install everything you need
 with:
 
-  apt install qtbase5-dev libqt5opengl5-dev qt5-default libqcustomplot-dev \
+
+  apt install qtbase5-dev libqt5opengl5-dev qt5-default \
     pkg-config libmicrohttpd-dev libusb-1.0-0-dev libluajit-5.1-dev \
     libzita-resampler-dev libva-dev libavcodec-dev libavformat-dev \
     libswscale-dev libavresample-dev libmovit-dev libegl1-mesa-dev \
     libasound2-dev libx264-dev libbmusb-dev protobuf-compiler \
-    libprotobuf-dev libsqlite3-dev meson libjpeg-dev
+    libprotobuf-dev libsqlite3-dev meson libjpeg-dev libsrt-gnutls-dev
 
 
-Exceptions as of December 2018:
+Exceptions as of September 2023:
 
   - Debian does not carry CEF (but it is optional). You can get experimental
     (and not security-supported) CEF Debian packages built for unstable at
@@ -112,10 +127,10 @@ It is meant for upstream, but was not in at the time Nageru was released.
 It is taken to be by Steinar H. Gunderson <sesse@google.com> (ie., my ex-work
 email), and under the same license as zita-resampler itself.
 
-Nageru uses Meson to build. For a default build, type
+Nageru and Futatabi use Meson to build. For a default build, type
 
   meson obj && cd obj && ninja
 
-To start it, just hook up your equipment, and then type “./nageru”.
+To start it, hook up your equipment, and then type “./nageru”.