]> git.sesse.net Git - nageru/blobdiff - README
Fix so that you can't right-click on non-signal channels anymore.
[nageru] / README
diff --git a/README b/README
index a3e4c9274e98ece88055037c23e6370f9b8129e3..7fb863ee5fa3f4184e939e5a50eb7f0f63e92636 100644 (file)
--- a/README
+++ b/README
@@ -8,18 +8,22 @@ 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, freely selectable input, cue out for headphones,
-   dynamic range compression, simple EQ (low-cut), level meters conforming
-   to EBU R128.
+   high-quality resampling, multichannel mixing with separate effects
+   per-bus, cue out for headphones, dynamic range compression,
+   three-band graphical EQ (pluss a fixed low-cut), level meters conforming
+   to EBU R128, automation via MIDI controllers.
 
  - Theme engine encapsulating the design demands of each individual
    event; Lua code is responsible for setting up the pixel processing
    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
@@ -36,15 +40,17 @@ Nageru is in beta stage. It currently needs:
  - Two or more Blackmagic USB3 or PCI cards, either HDMI or SDI.
    The PCI cards need Blackmagic's own drivers installed. The USB3 cards
    are driven through the “bmusb” driver, using libusb-1.0. If you want
-   zerocopy USB, you need libusb 1.0.21-rc1 or newer, as well as a recent
+   zerocopy USB, you need libusb 1.0.21 or newer, as well as a recent
    kernel (4.6.0 or newer). Zerocopy USB helps not only for performance,
-   but also for stability.
+   but also for stability. You need at least version 0.7.0.
 
  - Movit, my GPU-based video filter library (https://movit.sesse.net).
-   You will need at least version 1.3.1.
+   You will need at least version 1.5.2.
 
  - Qt 5.5 or newer for the GUI.
 
+ - QCustomPlot for the histogram display in the frame analyzer.
+
  - libmicrohttpd for the embedded web server.
 
  - x264 for encoding high-quality video suitable for streaming to end users.
@@ -63,24 +69,24 @@ Nageru is in beta stage. It currently needs:
 
  - Lua, for driving the theme engine.
 
+ - libpci, for printing friendly PCI device names in an error message.
+
 
 If on Debian stretch or something similar, you can install everything you need
 with:
 
-  apt install qtbase5-dev libqt5opengl5-dev qt5-default pkg-config libmicrohttpd-dev \
-    libusb-1.0-0-dev liblua5.2-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
-
-Exceptions as of July 2016:
+  apt install qtbase5-dev libqt5opengl5-dev qt5-default libqcustomplot-dev \
+    pkg-config libmicrohttpd-dev libusb-1.0-0-dev liblua5.2-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
 
-  - libusb 1.0.21-rc1 is not yet in stretch or sid; you need to fetch it
-    from experimental.
+Exceptions as of July 2017:
 
-  - libbmusb-dev is still in unstable only, not testing. You can get a recent
-    copy using “git submodule update --init” and building with
-    “make EMBEDDED_BMUSB=yes”.
+  - You will need Movit from unstable; stretch only has 1.4.0.
 
+  - 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.