From 3c29cea8759ebc482c88f0816fc27beaaba875c9 Mon Sep 17 00:00:00 2001
From: "Matthias P. Braendli" <matthias.braendli@mpb.li>
Date: Fri, 7 Mar 2014 21:29:40 +0100
Subject: update README

---
 README.md | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 56 insertions(+), 12 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index cd9c104..93e1190 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,20 @@
 fdk-aac-dabplus
 ===============
 
-A standalone library of the Fraunhofer FDK AAC code from Android.
+A standalone library of the Fraunhofer FDK AAC code from Android, patched for
+960-transform. Used for DAB+ broadcast encoding.
 
-This is 960-frames version of codec. Used for DAB+ boradcast encoding.
+Also includes a version with a ODR-DabMux compatible ZeroMQ output.
 
+There is experimental support for DAB MOT Slideshow and DLS, written by
+CSP http://rd.csp.it
 
-Usage:
 
-aac-enc-dabplus [OPTION...]
+Usage:
 
-    -b, --bitrate={ 8, 16, ..., 192 }    Output bitrate in kbps. Must be 8 multiple.
+    aac-enc-dabplus [OPTION...]
+    
+    -b, --bitrate={ 8, 16, ..., 192 }    Output bitrate in kbps. Must be multiple of 8.
     -i, --input=FILENAME                 Input filename (default: stdin).
     -o, --output=FILENAME                Output filename (default: stdout).
     -a, --afterburner                    Turn on AAC encoder quality increaser.
@@ -19,27 +23,67 @@ aac-enc-dabplus [OPTION...]
     -r, --rate={ 32000, 48000 }          Sample rate for raw input (default: 48000).
 
 
+The encoder with ZeroMQ output has the same options as above,
+but takes a zmq destination url as output
+
+See
+    aac-enc-dabplus-zmq -h
+
 
 How to build
-===============
+=============
+
+Requirements:
+* boost-thread and boost-system
+* ImageMagick magickwand (for MOT slideshow)
 
 * Download code and unpack it.
-* Download and install libfec from crc.ca website: http://mmbtools.crc.ca/content/view/39/65/ (follow instructions on that website).
-* do "./configure --enable-example", then "make" and "make install"
-* use aac-enc-dabplus to encode live stream or file.
+* Download and install libfec from https://github.com/Opendigitalradio/ka9q-fec
+* do "./configure", then "make" and "make install"
+* use aac-enc-dabplus or aac-enc-dabplus-zmq to encode live stream or file.
+* use mot-encoder to encode images into MOT Slideshow
 
 
 How to use
-===============
+==========
+
+Scenario 1
+----------
 
-Scenario 1 (Live Stream enconding and preparing for DAB muxer):
+Live Stream encoding and preparing for DAB muxer, with ZMQ output, at 32kHz, using sox.
+
+    ALSASRC="default"
+    DST="tcp://yourserver:9000"
+    BITRATE=64
+
+    sox -t alsa $ALSASRC -b 16 -t raw - rate 32k channels 2 | \
+    ../fdk-aac-dabplus/aac-enc-dabplus-zmq -r 32000 \
+    -i /dev/stdin -b $BITRATE -f raw -a -o $DST -p 4
+
+Scenario 2
+----------
+Live Stream encoding and preparing for DAB muxer, with FIFO to odr-dabmux, 48kHz, using
+arecord.
 
     arecord -t raw -f S16_LE -c 2 -r 48000 -D plughw:CARD=Loopback,DEV=0,SUBDEV=0 | \
     aac-enc-dabplus -b 24 -f raw -c 2 -r 48000 -i /dev/stdin -o /dev/stdout 2>/dev/null | \
     mbuffer -q -m 10k -P 100 -s 360 > station1.fifo
 
 
-Scenario 2 (Wave file enconding):
+Scenario 3
+----------
+Wave file encoding, for non-realtime processing
 
     aac-enc-dabplus -a -b 64 -i wave_file.wav -o station1.dabp
 
+Usage of MOT Slideshow
+======================
+
+MOT Slideshow is an experimental feature. The mot-encoder reads images in the specified folder,
+and generates the PAD data for the encoder. This is communicated through a unique fifo in /tmp,
+therefore only one instance can run on a single machine.
+
+Only aac-enc-dabplus-zmq inserts the PAD data from mot-encoder into the bitstream.
+
+This is an ongoing development.
+
-- 
cgit v1.2.3