Add a class for measuring L/R correlation (not used yet).

[nageru] / README

diff --git a/README b/README
index 9208ab172883789b4a5955ceb6864f6d3b47b497..e140ce72643868fbaa5e995ef5dc956d742c3d09 100644 (file)
--- a/README
+++ b/README
@@ -11,7 +11,7 @@ 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 (*),
+   high-quality resampling, mixing (*), cue out for headphones,
    dynamic range compression, fixed EQ, level meters conforming to EBU R128.
 
  - Theme engine encapsulating the design demands of each individual
@@ -51,8 +51,17 @@ Nageru is in alpha stage. It currently needs:
    11.x).
 
  - libzita-resampler, for resampling sound sources so that they are in sync
-   between sources.
+   between sources, and also for oversampling for the peak meter.
 
+ - Lua, for driving the theme engine.
+
+
+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 requipment, type “make” and then “./nageru”.
 It is strongly recommended to have the rights to run at real-time priority;
@@ -60,10 +69,10 @@ 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,
 although you might not want to do that in production.) Note also that if you
 are running a desktop compositor, it will steal significant amounts of GPU
-performance.
+performance. The same goes for PulseAudio.
 
 Nageru will open a HTTP server at port 9095, where you can extract a live
-H264+MP3 signal in MPEG-TS mux (e.g. http://127.0.0.1:9095/stream.ts).
+H264+PCM signal in QuickTime mux (e.g. http://127.0.0.1:9095/stream.mov).
 It is probably too high bitrate (~25 Mbit/sec depending on content) to send to
 users, but you can easily send it around in your internal network and then
 transcode it in e.g. VLC. A copy of the stream (separately muxed) will also
@@ -81,8 +90,9 @@ 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) 2008-2015 Fons Adriaensen <fons@linuxaudio.org>.
 Portions Copyright (c) 2007-2013 Intel Corporation. All Rights Reserved.