aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorandimik <andimik@yahoo.de>2021-04-06 21:29:11 +0200
committerGitHub <noreply@github.com>2021-04-06 21:29:11 +0200
commit9681416e87a65bcc0bdadb6f2a9dcc2e687f4858 (patch)
treecd46d8f202fc403a0f63de98fc0d558a234bcdf3
parent4f7218fe62998c843bf80cca826aed79c215acac (diff)
downloadetisnoop-9681416e87a65bcc0bdadb6f2a9dcc2e687f4858.tar.gz
etisnoop-9681416e87a65bcc0bdadb6f2a9dcc2e687f4858.tar.bz2
etisnoop-9681416e87a65bcc0bdadb6f2a9dcc2e687f4858.zip
Usage added in Readme
- copied usage from `etisnoop --help` text - mentioned XPADexpert - some hints regarding N (subchannel) and naming convention for output - described what ETI is (link to wiki)
-rw-r--r--README.md32
1 files changed, 31 insertions, 1 deletions
diff --git a/README.md b/README.md
index a69cbb7..a855573 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
ETISnoop analyser
=================
-The ETISnoop analyser decodes a RAW ETI file and prints out
+The ETISnoop analyser decodes a RAW ETI (see https://wiki.opendigitalradio.org/Ensemble_Transport_Interface ) file and prints out
its contents in YAML for easier analysis.
It can show information about the signalling, details about the FIGs,
@@ -20,6 +20,36 @@ Then do
./configure
make
sudo make install
+
+
+Usage
+-----
+
+```
+etisnoop [options] [(-i|-I) filename]
+
+ -i the file contains RAW ETI
+ -I the file contains FIC
+ -v increase verbosity (can be given more than once)
+ -d N decode subchannel N into stream-N.msc file
+ if DAB+: decode audio to stream-N.wav file and extract PAD to stream-N.msc
+ -s <filename.yaml>
+ statistics mode: decode all subchannels and measure audio level, write statistics to file
+ -n N stop analysing after N ETI frames
+ -f analyse FIC carousel (no YAML output)
+ -r analyse FIG rates in FIGs per second
+ -R analyse FIG rates in frames per FIG
+ -w decode CRC-DABMUX and ODR-DabMux watermark.
+ -e decode frames with SYNC error and decode FIGs with invalid CRC
+ -F <type>/<ext>
+ add FIG type/ext to list of FIGs to display.
+ if the option is not given, all FIGs are displayed.
+```
+
+You can open the stream-N.msc file in https://www.basicmaster.de/xpadxpert/
+(remark: in case of DAB please rename the .msc to .mp2)
+
+Hint: subchannel N means the (N+1)th subchannel in a mux (including data subchannels!)
About
-----