X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=README;h=2f88980ec828ae9c9d6f396710d212819cfd3615;hb=40d316173fde0830a1727d78604ad12e6e5dec01;hp=513e6de7976fc7fe2c91c1c49e1a66c427c1dcbe;hpb=ccc0d8f9b40db622ee30e1bd1b07d031b2c8b0e0;p=nageru diff --git a/README b/README index 513e6de..2f88980 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 (lowpass), 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,21 +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. - Note that you will want a recent Linux kernel to avoid LPM (link power - management) and bandwidth allocation issues with USB3. + 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.2. - 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 - (but see below). + - 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 @@ -62,28 +66,29 @@ 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 + 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 -Exceptions as of May 2016: +Exceptions as of July 2017: - - Mesa in stretch is too old; you need Mesa from experimental to get - 11.2.x. + - You will need Movit from unstable; stretch only has 1.4.0. + - You will need bmusb from unstable; stretch only has 0.5.4. -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 (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 (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; @@ -103,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 @@ -131,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 . @@ -156,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.