]> git.sesse.net Git - nageru/blobdiff - README
Fixed x264 has hit stretch.
[nageru] / README
diff --git a/README b/README
index 513e6de7976fc7fe2c91c1c49e1a66c427c1dcbe..c933a9650d8bd2d571417245f441d61f96e91382 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.
@@ -46,8 +45,7 @@ Nageru is in beta stage. It currently needs:
 
  - libmicrohttpd for the embedded web server.
 
- - x264 for encoding high-quality video suitable for streaming to end users
-   (but see below).
+ - x264 for encoding high-quality video suitable for streaming to end users.
 
  - ffmpeg for muxing, and for encoding audio.
 
@@ -72,18 +70,25 @@ with:
     libavcodec-dev libavformat-dev libswscale-dev libavresample-dev \
     libmovit-dev libegl1-mesa-dev libasound2-dev libx264-dev
 
-Exceptions as of May 2016:
+Exceptions as of June 2016:
 
-  - Mesa in stretch is too old; you need Mesa from experimental to get
-    11.2.x.
+  - 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.
 
-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.
+  - Nageru depends on an avformat API for marking block boundaries in the
+    muxed byte stream that didn't enter ffmpeg before
+    4e7a9212820a56bc731c09b2f11ae1422d070837, pushed to git late 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;