]> git.sesse.net Git - nageru/blobdiff - README
Take out the persistent device memory patches, as the libusb patch is now in git...
[nageru] / README
diff --git a/README b/README
index 92ea7e1602b495160fac72a109162e69209e2bb0..006d8088a6aed052665268b41da5e2fa2ec5ee2f 100644 (file)
--- a/README
+++ b/README
@@ -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.
@@ -72,18 +71,21 @@ 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:
 
-  - You want kernel 4.6.0 or newer to get any use of the patches in
-    patches/ for persistent USB memory (see next paragraph).
+  - 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.
+
+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;