]> git.sesse.net Git - nageru/blobdiff - README
Add a hack to FFmpegCapture for decoding Futatabi's Y'CbCr streams correctly.
[nageru] / README
diff --git a/README b/README
index 7f814396d14a11b458eec8865164ff9ab4a57fae..bf0611075af41b3df7d6afbc4b0bd19d3ed67f19 100644 (file)
--- a/README
+++ b/README
@@ -38,14 +38,14 @@ Nageru currently needs:
  - An Intel processor with Intel Quick Sync, or otherwise some hardware
    H.264 encoder exposed through VA-API. Note that you can use VA-API over
    DRM instead of X11, to use a non-Intel GPU for rendering but still use
-   Quick Sync (by giving e.g. “--va-display /dev/dri/renderD128”).
+   Quick Sync (Nageru does this automatically for you if needed).
 
  - 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 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.
+   but also for stability. You need at least version 0.7.3.
 
  - Movit, my GPU-based video filter library (https://movit.sesse.net).
    You will need at least version 1.5.2.
@@ -71,7 +71,7 @@ Nageru currently needs:
 
  - LuaJIT, for driving the theme engine.
 
- - libpci, for printing friendly PCI device names in an error message.
+ - Meson, for building.
 
  - Optional: CEF (Chromium Embedded Framework), for HTML graphics.
    If you build without CEF, the HTMLInput class will not be available from
@@ -80,8 +80,8 @@ Nageru currently needs:
      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).
+   is fine) and add -Dcef_dir=<path>/cef_binary_X.XXXX.XXXX.XXXXXXXX_linux64
+   on the meson command line (substituting X with the real version as required).
 
 
 If on Debian stretch or something similar, you can install everything you need
@@ -92,22 +92,33 @@ with:
     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
+    libprotobuf-dev
 
-Exceptions as of February 2018:
+Exceptions as of November 2018:
 
-  - You will need Movit from unstable; stretch only has 1.4.0.
+  - You will need Movit from testing or unstable; stretch only has 1.4.0.
 
-  - You will need bmusb from unstable; stretch only has 0.5.4.
+  - You will need bmusb from testing or unstable; stretch only has 0.5.4.
 
-  - Debian does not carry CEF (but it is optional).
+  - You will need a Meson backport; the version in stretch is too old.
+
+  - Debian does not carry CEF (but it is optional). You can get experimental
+    (and not security-supported) CEF Debian packages built for unstable at
+    http://storage.sesse.net/cef/, and then configure Nageru with
+
+     meson obj -Dcef_dir=/usr/lib/x86_64-linux-gnu/cef -Dcef_build_type=system -Dcef_no_icudtl=true
 
 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”.
+Nageru uses Meson to build. For a default build, type
+
+  meson obj && cd obj && ninja
+
+To start it, just hook up your equipment, and then type “cd nageru && ./nageru”.
+
 It is strongly recommended to have the rights to run at real-time priority;
 it will make the USB3 threads do so, which will make them a lot more stable.
 (A reasonable hack for testing is probably just to run it as root using sudo,