update installation and usage instructions to cover live audio input …

…capabilities

README.rst

@@ -66,6 +66,8 @@ To install the ``madmom`` package, you must have either Python 2.7 or Python
 - `scipy <http://www.scipy.org>`_
 - `cython <http://www.cython.org>`_
 - `nose <https://github.com/nose-devs/nose>`_ (to run the tests)
+- `pyaudio <http://people.csail.mit.edu/hubert/pyaudio/>`_ (to process live
+  audio input)
 
 If you need support for audio files other than ``.wav`` with a sample rate of
 44.1kHz and 16 bit depth, you need ``ffmpeg`` (``avconv`` on Ubuntu Linux has
@@ -201,28 +203,36 @@ If you installed the package, they were copied to a common place.
 All scripts can be run in different modes: in ``single`` file mode to process
 a single audio file and write the output to STDOUT or the given output file::
 
-    SuperFlux single [-o OUTFILE] INFILE
+    DBNBeatTracker single [-o OUTFILE] INFILE
 
 If multiple audio files should be processed, the scripts can also be run in
 ``batch`` mode to write the outputs to files with the given suffix::
 
-    SuperFlux batch [-o OUTPUT_DIR] [-s OUTPUT_SUFFIX] LIST OF INPUT FILES
+    DBNBeatTracker batch [-o OUTPUT_DIR] [-s OUTPUT_SUFFIX] FILES
 
-If no output directory is given, the program writes the output files to same
-location as the audio files.
+If no output directory is given, the program writes the output files to the
+same location as the audio files.
+
+Some programs can also be run in ``online`` mode, i.e. operate on live audio
+signals. This requires `pyaudio <http://people.csail.mit.edu/hubert/pyaudio/>`_
+to be installed::
+
+    DBNBeatTracker online [-o OUTFILE] [INFILE]
 
 The ``pickle`` mode can be used to store the used parameters to be able to
 exactly reproduce experiments.
 
 Please note that the program itself as well as the modes have help messages::
 
-    SuperFlux -h
+    DBNBeatTracker -h
+
+    DBNBeatTracker single -h
 
-    SuperFlux single -h
+    DBNBeatTracker batch -h
 
-    SuperFlux batch -h
+    DBNBeatTracker online -h
 
-    SuperFlux pickle -h
+    DBNBeatTracker pickle -h
 
 will give different help messages.
 

docs/installation.rst

@@ -19,6 +19,8 @@ To install the ``madmom`` package, you must have either Python 2.7 or Python
 - `scipy <http://www.scipy.org>`_
 - `cython <http://www.cython.org>`_
 - `nose <https://github.com/nose-devs/nose>`_ (to run the tests)
+- `pyaudio <http://people.csail.mit.edu/hubert/pyaudio/>`_ (to process live
+  audio input)
 
 If you need support for audio files other than ``.wav`` with a sample rate of
 44.1kHz and 16 bit depth, you need ``ffmpeg`` (``avconv`` on Ubuntu Linux has

docs/usage.rst

@@ -12,19 +12,40 @@ package. If you just want to try/use these programs, please follow the
 All scripts can be run in different modes: in ``single`` file mode to process
 a single audio file and write the output to STDOUT or the given output file::
 
-  SuperFlux single [-o OUTFILE] INFILE
+  DBNBeatTracker single [-o OUTFILE] INFILE
 
 If multiple audio files should be processed, the scripts can also be run in
 ``batch`` mode to write the outputs to files with the given suffix::
 
-  SuperFlux batch [-o OUTPUT_DIR] [-s OUTPUT_SUFFIX] LIST OF INPUT FILES
+  DBNBeatTracker batch [-o OUTPUT_DIR] [-s OUTPUT_SUFFIX] FILES
 
 If no output directory is given, the program writes the output files to same
 location as the audio files.
 
+Some programs can also be run in ``online`` mode, i.e. operate on live audio
+signals. This requires `pyaudio <http://people.csail.mit.edu/hubert/pyaudio/>`_
+to be installed::
+
+  DBNBeatTracker online [-o OUTFILE] [INFILE]
+
 The ``pickle`` mode can be used to store the used parameters to be able to
 exactly reproduce experiments.
 
+Please note that the program itself as well as the modes have help messages::
+
+  DBNBeatTracker -h
+
+  DBNBeatTracker single -h
+
+  DBNBeatTracker batch -h
+
+  DBNBeatTracker online -h
+
+  DBNBeatTracker pickle -h
+
+will give different help messages.
+
+
 Library usage
 -------------