From 9fb273f8777ef11ad48498e5db5fd85958f75909 Mon Sep 17 00:00:00 2001
From: "Matthias P. Braendli" <matthias.braendli@mpb.li>
Date: Tue, 6 May 2014 21:10:10 +0200
Subject: Add explanation of output formats

---
 doc/dab_output_formats.txt | 39 +++++++++++++++++++++++++++++++++++++++
 doc/example.mux            | 24 ++++++++++++++++++++++--
 2 files changed, 61 insertions(+), 2 deletions(-)
 create mode 100644 doc/dab_output_formats.txt

diff --git a/doc/dab_output_formats.txt b/doc/dab_output_formats.txt
new file mode 100644
index 0000000..059ac19
--- /dev/null
+++ b/doc/dab_output_formats.txt
@@ -0,0 +1,39 @@
+ODR-DabMux supports three output formats for the ETI stream.
+
+The three formats are called 'framed', 'streamed' and 'raw'.
+
+The framed format is used for saving a finite ETI stream into a file. Each frame does
+not contain any padding, and the format can be described as follows:
+
+ uint32_t nbFrames
+ // for each frame
+     uint16_t frameSize
+     uint8_t data[ frameSize ]
+
+
+When streaming data, in which case the number of frames is not known in advance,
+the streamed format can be used. This format is identical to the first one except for the
+missing nbFrames.
+
+ // for each frame
+     uint16_t frameSize
+     uint8_t data[ frameSize ]
+
+
+The raw format corresponds to ETI(NI), where each frame has a constant size of 6144
+Bytes. The padding in this case is necessary.
+
+ // for each frame
+ uint8_t data [6144]
+
+In order to select the format, the following syntax for the -O option or the
+output setting in the configuration file is:
+
+  file://filename?type=format
+
+where format is one of framed, streamed or raw, e.g.
+
+  file:///tmp/mux.eti?type=raw
+
+saves a raw ETI file to /tmp/mux.eti
+
diff --git a/doc/example.mux b/doc/example.mux
index 86ce483..f5a2476 100644
--- a/doc/example.mux
+++ b/doc/example.mux
@@ -234,8 +234,28 @@ components {
 ; A list of outputs, in the format
 ; unique-id "uri"
 outputs {
+    ; The unique-id has no signification. It can be used by the
+    ; remote control or the statistics server to identify the
+    ; output
+
+    ;supported output types for file and fifo outputs are
+    ; raw, framed and streamed
+    ;
+    ; Please see doc/dab_output_formats.txt
     stdout "fifo:///dev/stdout?type=raw"
 
-; ZeroMQ output example
-    ; zmq  "zmq+tcp://*:8080"
+    ; ZeroMQ output example
+    ; Listen on all interfaces, on port 8080
+    ;zmq  "zmq+tcp://*:8080"
+
+    ; Throttle output to real-time (one ETI frame every 24ms)
+    ;throttle "simul://"
+
+    ; Other outputs:
+    ; TCP listen on port
+    ;net "tcp://host:port"
+    ; UDP send to host:port
+    ;net "ucp://host:port"
+    ; RAW (for farsync ETI card)
+    ;farsync "raw://device"
 }
-- 
cgit v1.2.3