Release Nageru 1.0.0, with some documentation updates.

[nageru] / README

diff --git a/README b/README
index b983777abc35171a780479cb155fb5507ff8262f..59917d193a7365e273c2031bfcbfec0360a86359 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
 Nageru is a live video mixer, based around the standard M/E workflow.
 
 
 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.
 
  - 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
    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
 
  - Theme engine encapsulating the design demands of each individual
    event; Lua code is responsible for setting up the pixel processing


@@ -25,18 +26,17 @@ 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).
 
 
 (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.
 
 
  - An Intel processor with Intel Quick Sync, or otherwise some hardware
    H.264 encoder exposed through VA-API.
 

- - 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 cards, either HDMI or SDI. These 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).
+ - Movit, my GPU-based video filter library (https://movit.sesse.net).

    Newer is almost certainly better; Nageru's needs tends to drive new
    features in Movit.
 
    Newer is almost certainly better; Nageru's needs tends to drive new
    features in Movit.
 


@@ -56,7 +56,14 @@ Nageru is in alpha stage. It currently needs:
  - Lua, for driving the theme engine.
 
 
  - Lua, for driving the theme engine.
 
 

-To start it, just hook up your requipment, type “make” and then “./nageru”.
+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.
+
+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,
 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,


@@ -77,14 +84,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.)
 
 
 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>.
 Portions Copyright (C) 2003 Rune Holm.
 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>.
 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) 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.
 
 
 Portions Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.