diff doc/Utils-overview @ 136:8eb0e7a39409

doc: document command line utilities
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 11 Dec 2022 22:20:36 +0000
parents
children 195911f2211c
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/Utils-overview	Sun Dec 11 22:20:36 2022 +0000
@@ -0,0 +1,43 @@
+Here is the complete list of all command line utilities included in the present
+package:
+
+gsm-amr2efr		See AMR-EFR-conversion article.
+gsm-efr2amr
+
+gsmefr-cod-parse	See EFR-testing article.
+gsmefr-dec-parse
+
+gsmefr-decode		See Codec-utils article.
+gsmefr-encode
+
+gsmefr-etsi-dec		See EFR-testing article.
+gsmefr-etsi-enc
+
+gsmefr-rec2etsi		This program reads an EFR session recording in gsmx
+			format and converts it into ETSI decoder input (.dec)
+			format.  It was written early in the project as a sanity
+			check, to verify that the format of TCH uplink from
+			sysmoBTS in EFR mode matches our expectations, before
+			embarking on the labor-intensive project to librify EFR
+			reference code from ETSI.
+
+gsmfr-cvt-dlcap		See Calypso-TCH-downlink article.
+
+gsmfr-decode		See Codec-utils article.
+gsmfr-encode
+
+gsmfr-hand-test		This program was written as part of a debug chase:
+			there seemed to be a design flaw in libgsmfrp, but the
+			actual bug turned out to be in the way we patched
+			osmo-bts-sysmo to produce a continuous RTP stream.
+
+gsmfr-max-out		Another test program written as part of the same debug
+			chase.
+
+gsmfr-preproc		This program reads a gsmx file in FR codec format,
+			passes it through our Rx DTX preprocessor (libgsmfrp),
+			and writes the preprocessor output to another .gsm file.
+
+gsmrec-dump		See Binary-file-format article.
+
+rtp-gsmfr-extr		See RTP-analysis article.