X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=README;h=c89a3e8228ce854ac8d1338d533acca6bd9a095c;hb=44ee459bd35c43bc1f0dab03cea4966c2fd4e84f;hp=c933a9650d8bd2d571417245f441d61f96e91382;hpb=9f4ce5eb67c827b0ab12d3c5bf621547d8f38310;p=nageru diff --git a/README b/README index c933a96..c89a3e8 100644 --- a/README +++ b/README @@ -11,9 +11,10 @@ Features: for intermediate calculations, dithered output. - 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 @@ -35,19 +36,24 @@ 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 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.1. - 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. - - ffmpeg for muxing, and for encoding audio. + - ffmpeg for muxing, and for encoding audio. You will need at least + version 3.1. - Working OpenGL; Movit works with almost any modern OpenGL implementation. Nageru has been tested with Intel on Mesa (you want 11.2 or newer, due @@ -60,30 +66,24 @@ Nageru is in beta stage. It currently needs: - Lua, for driving the theme engine. + - libpci, for printing friendly PCI device names in an error message. + 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 - -Exceptions as of June 2016: - - - 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. + apt install qtbase5-dev libqt5opengl5-dev qt5-default libqcustomplot-dev \ + 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 libbmusb-dev protobuf-compiler \ + libprotobuf-dev libpci-dev - - 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. +Exceptions as of May 2017: - - 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. + - You will need Movit from experimental; stretch only has 1.4.0. + - You will need bmusb from experimental; stretch only has 0.5.4. 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. @@ -108,7 +108,7 @@ be saved live to local disk. If you have a fast CPU (typically a quadcore desktop; most laptops will spend most of their CPU on running Nageru itself), you can use x264 for the outgoing stream instead of Quick Sync; it is much better quality for the same bitrate, -and also has proper bitrate controls. Simple add --http-x264-video on the +and also has proper bitrate controls. Simply add --http-x264-video on the command line. (You may also need to add something like "--x264-preset veryfast", since the default "medium" preset might be too CPU-intensive, but YMMV.) The stream saved to disk will still be the Quick Sync-encoded stream, as it is @@ -136,7 +136,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 . @@ -161,7 +161,7 @@ You should have received a copy of the GNU General Public License along with this program. If not, see . -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.