]> git.sesse.net Git - nageru/blobdiff - README
Add support for DeckLink PCI cards through the official driver.
[nageru] / README
diff --git a/README b/README
index 56d7f2e8c8514b702dbe842fef733d25fe871867..e5e59648f77eb40ce98b18ff3145d402cb6f5779 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
 Nageru is a live video mixer, based around the standard M/E workflow.
 
 
-Features (those marked with * are still in progress or not started yet):
+Features:
 
  - High performance on modest hardware (720p60 with two input streams
    on my Thinkpad X240[1]); almost all pixel processing is done on the GPU.
@@ -11,8 +11,9 @@ Features (those marked with * are still in progress or not started yet):
    for intermediate calculations, dithered output.
 
  - Proper sound support: Syncing of multiple unrelated sources through
-   high-quality resampling, mixing (*), cue out for headphones,
-   dynamic range compression, fixed EQ, level meters conforming to EBU R128.
+   high-quality resampling, freely selectable input, cue out for headphones,
+   dynamic range compression, simple EQ (lowpass), level meters conforming
+   to EBU R128.
 
  - Theme engine encapsulating the design demands of each individual
    event; Lua code is responsible for setting up the pixel processing
@@ -25,20 +26,21 @@ to 800 MHz after 30 seconds due to thermal constraints), Intel HD Graphics
 (so 12.8 GB/sec theoretical memory bandwidth, shared between CPU and GPU).
 
 
-Nageru is in alpha stage. It currently needs:
+Nageru is in beta stage. It currently needs:
 
  - An Intel processor with Intel Quick Sync, or otherwise some hardware
-   H.264 encoder exposed through VA-API.
+   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”).
 
- - Two Blackmagic USB3 cards, either HDMI or SDI. Note that on some machines,
-   you may have to run a Linux kernel with power saving compiled out to avoid
-   LPM (link power management) and bandwidth allocation issues with USB3.
-   These are driven through the “bmusb“ driver embedded in bmusb/, using
-   libusb-1.0.
+ - 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.
 
- - Movit, my GPU-based video filter library (http://movit.sesse.net).
-   Newer is almost certainly better; Nageru's needs tends to drive new
-   features in Movit.
+ - Movit, my GPU-based video filter library (https://movit.sesse.net).
+   You will need at least version 1.3.0.
 
  - Qt 5.5 or newer for the GUI.
 
@@ -46,9 +48,11 @@ Nageru is in alpha stage. It currently needs:
 
  - ffmpeg for muxing, and for encoding audio.
 
- - Working OpenGL; Movit works with almost any modern OpenGL implementation,
-   but Nageru has been tested with Mesa 10.x and 11.x only (you probably want
-   11.x).
+ - Working OpenGL; Movit works with almost any modern OpenGL implementation.
+   Nageru has been tested with Intel on Mesa 10.x and 11.x (you probably want
+   11.x), and with NVIDIA's proprietary drivers. AMD's proprietary drivers
+   (fglrx) are known not to work due to driver bugs; I am in contact with
+   AMD to try to get this resolved.
 
  - libzita-resampler, for resampling sound sources so that they are in sync
    between sources, and also for oversampling for the peak meter.
@@ -56,6 +60,16 @@ Nageru is in alpha stage. It currently needs:
  - Lua, for driving the theme engine.
 
 
+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 libmovit-dev \
+    libegl1-mesa-dev libasound2-dev
+
+
 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
@@ -63,7 +77,7 @@ 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.
 
-To start it, just hook up your requipment, type “make” and then “./nageru”.
+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;
 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,
@@ -84,14 +98,19 @@ to throw or cast. (I also later learned that it could mean to face defeat or
 give up, but that's not the intended meaning.)
 
 
+Nageru's home page is at https://nageru.sesse.net/, where you can also find
+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.
 
 
-Nageru is Copyright (C) 2015 Steinar H. Gunderson <sgunderson@bigfoot.com>.
+Nageru is Copyright (C) 2015 Steinar H. Gunderson <steinar+nageru@gunderson.no>.
 Portions Copyright (C) 2003 Rune Holm.
-Portions Copyright (C) 2010-2011 Fons Adriaensen <fons@linuxaudio.org>.
+Portions Copyright (C) 2010-2015 Fons Adriaensen <fons@linuxaudio.org>.
 Portions Copyright (C) 2012-2015 Fons Adriaensen <fons@linuxaudio.org>.
+Portions Copyright (C) 2008-2015 Fons Adriaensen <fons@linuxaudio.org>.
 Portions Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.
 
 
@@ -132,3 +151,31 @@ IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+All files in decklink/:
+
+Copyright (c) 2009 Blackmagic Design
+Copyright (c) 2015 Blackmagic Design
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.