comparison 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
comparison
equal deleted inserted replaced
135:22601ae99434 136:8eb0e7a39409
1 Here is the complete list of all command line utilities included in the present
2 package:
3
4 gsm-amr2efr See AMR-EFR-conversion article.
5 gsm-efr2amr
6
7 gsmefr-cod-parse See EFR-testing article.
8 gsmefr-dec-parse
9
10 gsmefr-decode See Codec-utils article.
11 gsmefr-encode
12
13 gsmefr-etsi-dec See EFR-testing article.
14 gsmefr-etsi-enc
15
16 gsmefr-rec2etsi This program reads an EFR session recording in gsmx
17 format and converts it into ETSI decoder input (.dec)
18 format. It was written early in the project as a sanity
19 check, to verify that the format of TCH uplink from
20 sysmoBTS in EFR mode matches our expectations, before
21 embarking on the labor-intensive project to librify EFR
22 reference code from ETSI.
23
24 gsmfr-cvt-dlcap See Calypso-TCH-downlink article.
25
26 gsmfr-decode See Codec-utils article.
27 gsmfr-encode
28
29 gsmfr-hand-test This program was written as part of a debug chase:
30 there seemed to be a design flaw in libgsmfrp, but the
31 actual bug turned out to be in the way we patched
32 osmo-bts-sysmo to produce a continuous RTP stream.
33
34 gsmfr-max-out Another test program written as part of the same debug
35 chase.
36
37 gsmfr-preproc This program reads a gsmx file in FR codec format,
38 passes it through our Rx DTX preprocessor (libgsmfrp),
39 and writes the preprocessor output to another .gsm file.
40
41 gsmrec-dump See Binary-file-format article.
42
43 rtp-gsmfr-extr See RTP-analysis article.