Document that you need a specific x264 patch.

[nageru] / README

diff --git a/README b/README
index 5e6c2e29079011e4bb77ee7f09ab0370aaa49cc8..4e9f7469c2d8268abfb10a46a17c1c39a5299e94 100644 (file)
--- a/README
+++ b/README
@@ -12,7 +12,7 @@ Features:
 
  - Proper sound support: Syncing of multiple unrelated sources through
    high-quality resampling, freely selectable input, cue out for headphones,
-   dynamic range compression, simple EQ (lowpass), level meters conforming
+   dynamic range compression, simple EQ (low-cut), level meters conforming
    to EBU R128.
 
  - Theme engine encapsulating the design demands of each individual
@@ -36,8 +36,7 @@ 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.
-   Note that you will want a recent Linux kernel to avoid LPM (link power
-   management) and bandwidth allocation issues with USB3.
+   You want a recent kernel and libusb-1.0; see below.
 
  - Movit, my GPU-based video filter library (https://movit.sesse.net).
    You will need at least version 1.3.1.
@@ -52,10 +51,10 @@ Nageru is in beta stage. It currently needs:
  - ffmpeg for muxing, and for encoding audio.
 
  - Working OpenGL; Movit works with almost any modern OpenGL implementation.
-   Nageru has been tested with Intel on Mesa 10.x and 11.x (you probably want
-   11.x), 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.
+   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.
 
  - libzita-resampler, for resampling sound sources so that they are in sync
    between sources, and also for oversampling for the peak meter.
@@ -72,13 +71,24 @@ with:
     libavcodec-dev libavformat-dev libswscale-dev libavresample-dev \
     libmovit-dev libegl1-mesa-dev libasound2-dev libx264-dev
 
+Exceptions as of June 2016:
 
-The patches/ directory contains some patches for upstream software that help
-Nageru performance and/or stability. They are all meant for upstream, but
-probably will not be in by the time Nageru is released. All except the bmusb
-patch are taken to be by Steinar H. Gunderson <sesse@google.com> (ie., my work
-email, unlike Nageru itself and bmusb), and under the same license as the
-projects they patch.
+  - 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 want kernel 4.6.0 or newer to get zerocopy USB. Older kernels
+    also lack some workarounds for LPM (link power management) and bandwidth
+    allocation issues with USB3.
+
+  - There is a critical bug fix with x264 speed control in
+    928bd9d5def4f0ca5071ea176a11b816a01e6495, pushed to git mid-June 2016.
+
+
+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”.
 It is strongly recommended to have the rights to run at real-time priority;