]> git.sesse.net Git - nageru-docs/blobdiff - intro.rst
Document the return value of choose() and how it is useful.
[nageru-docs] / intro.rst
index e63d3c5618b9f4e9c73f2aa8987e00d5f8b99db6..8ed78ee4e2ea7d04e8fa5197ae2ebb330d5524d3 100644 (file)
--- a/intro.rst
+++ b/intro.rst
@@ -10,7 +10,8 @@ Features:
 
  * High output quality; Lanczos3 scaling, subpixel precision everywhere,
    white balance adjustment, mix of 16- and 32-bit floating point
-   for intermediate calculations, dithered output.
+   for intermediate calculations, dithered output, optional 10-bit input
+   and output support.
 
  * Proper sound support: Syncing of multiple unrelated sources through
    high-quality resampling, multichannel mixing with separate effects
@@ -23,6 +24,8 @@ Features:
    pipelines, running transitions etc., so that the visual look is
    consistent between operators.
 
+ * Comprehensive monitoring through Prometheus metrics.
+
 .. [1] For reference, that is: Core i7 4600U (dualcore 2.10GHz, clocks down
        to 800 MHz after 30 seconds due to thermal constraints), Intel HD Graphics
        4400 (ie., without the extra L4 cache from Iris Pro), single-channel DDR3 RAM
@@ -48,42 +51,71 @@ usually give you a newer version). It currently need:
 
  - 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 3.1.
+ - FFmpeg for muxing, and for encoding audio. You will need at least
+   version 4.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.
-   AMD's proprietary drivers (fglrx) are known not to work due to driver bugs;
-   I am in contact with AMD to try to get this resolved.
+   The status of AMD's proprietary drivers is currently unknown.
 
  - libzita-resampler, for resampling sound sources so that they are in sync
    between sources, and also for oversampling for the peak meter.
 
- - Lua, for driving the theme engine.
+ - 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.
+
+ - Meson, for building.
+
+ - Optional: CEF (Chromium Embedded Framework), for :doc:`HTML graphics <html>`.
+   If you build without CEF, the HTMLInput class will not be available from
+   the theme. You can get binary downloads of CEF from
 
- - libpci, for printing friendly PCI device names in an error message.
+     http://opensource.spotify.com/cefbuilds/index.html
 
+   Simply download the right build for your platform (the “minimal” build
+   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).
 
-If on Debian stretch or something similar, you can install everything you need
+
+If on Debian buster or something similar, you can install everything you need
 with:
 
   apt install qtbase5-dev libqt5opengl5-dev qt5-default libqcustomplot-dev \
-    pkg-config libmicrohttpd-dev libusb-1.0-0-dev liblua5.2-dev \
+    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 libpci-dev
+    libprotobuf-dev libsqlite3-dev meson libjpeg-dev
+
 
-Exceptions as of July 2017:
+Exceptions as of December 2018:
 
-  - You will need Movit from unstable; stretch only has 1.4.0.
+  - Debian does not carry CEF (but it is optional). You can get experimental
+    (and not security-supported) CEF Debian packages built for unstable at
+    http://storage.sesse.net/cef/, and then configure Nageru with
+
+     meson obj -Dcef_dir=/usr/lib/x86_64-linux-gnu/cef -Dcef_build_type=system -Dcef_no_icudtl=true
 
-  - You will need bmusb from unstable; stretch only has 0.5.4.
 
 The patches/ directory contains a patch that helps zita-resampler performance.
 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.
 
-To start it, just hook up your equipment, type “make” and then “./nageru”.
+Nageru uses 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”.
+
+