]> git.sesse.net Git - nageru/blobdiff - README
Update the README for CEF.
[nageru] / README
diff --git a/README b/README
index 64f43f83ce27dfe4d04e6da5bb2bb5ae9d827e15..8de4a84d7f5f239accd081a3dd1179b110d6c11f 100644 (file)
--- a/README
+++ b/README
@@ -8,18 +8,25 @@ 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.
 
+ - HTML rendering (through Chromium Embedded Framework), for high-quality
+   and flexible overlay or other graphics.
+
+ - 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
@@ -35,14 +42,18 @@ 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 embedded in bmusb/, using libusb-1.0.
-   You want a recent kernel (4.6.0 or newer) and libusb-1.0; see below.
+   are driven through the “bmusb” driver, using libusb-1.0. If you want
+   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. 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.
@@ -59,24 +70,38 @@ Nageru is in beta stage. It currently needs:
  - 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.
+
+ - libpci, for printing friendly PCI device names in an error message.
+
+ - Optional: CEF (Chromium Embedded Framework), for HTML graphics.
+   If you build without CEF, the HTMLInput class will not be available from
+   the theme. You can get binary downloads of CEF from
+
+     http://opensource.spotify.com/cefbuilds/index.html
+
+   Simply download the right build for your platform (the “minimal” build
+   is fine) and add CEF_DIR=<path>/cef_binary_X.XXXX.XXXX.XXXXXXXX_linux64
+   on the make command line (substituting X with the real version as required).
 
 
 If on Debian stretch or something similar, you can install everything you need
 with:
 
-  git submodule update --init
-  apt install qtbase5-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
+  apt install qtbase5-dev libqt5opengl5-dev qt5-default libqcustomplot-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
+
+Exceptions as of February 2018:
 
-Exceptions as of July 2016:
+  - You will need Movit from unstable; stretch only has 1.4.0.
 
-  - You need libusb 1.0.21 or newer (not yet released; you will need to
-    use git) if you want zerocopy USB. Zerocopy USB helps not only for
-    performance, but also for stability.
+  - You will need bmusb from unstable; stretch only has 0.5.4.
 
+  - Debian does not carry CEF (but it is optional).
 
 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.
@@ -129,7 +154,7 @@ contact information and link to the latest version.
 
 
 Legalese: TL;DR: Everything is GPLv3-or-newer compatible, and see
-Intel's copyright license at h264encode.h.
+Intel's copyright license at quicksync_encoder.h.
 
 
 Nageru is Copyright (C) 2015 Steinar H. Gunderson <steinar+nageru@gunderson.no>.
@@ -154,7 +179,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
-Portions of h264encode.h and h264encode.cpp:
+Portions of quicksync_encoder.h and quicksync_encoder.cpp:
 
 Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.