view doc/Utils-overview @ 282:9ee8ad3d4d30

frtest: rm gsmfr-hand-test and gsmfr-max-out utils These hack programs were never properly documented and were written only as part of a debug chase, in pursuit of a bug that ultimately turned out to be in our then-hacky patch to osmo-bts-sysmo, before beginning of proper patches in Osmocom. These hack programs need to be dropped from the present sw package because they depend on old libgsm, and we are eliminating that dependency.
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 14 Apr 2024 05:44:47 +0000
parents a55fcc8b6daf
children 047c198408c8
line wrap: on
line source

Here is the complete list of all command line utilities included in the present
package:

amr-cod-parse		See AMR-study-utils article.
amr-ietf-parse
amr-cod2ietf
amr-ietf2cod

gsm-amr2efr		See AMR-EFR-conversion article.
gsm-efr2amr

gsmefr-cod-parse	See EFR-testing article.
gsmefr-dec-parse

gsmefr-cod2gsmx		This program reads an EFR codec frame stream in ETSI
			*.cod format and converts it to Themyscira gsmx format.

gsmefr-decode		See Codec-utils article.
gsmefr-decode-r
gsmefr-encode
gsmefr-encode-r

gsmefr-dlcap-dec	See Calypso-TCH-downlink article.
gsmefr-dlcap-gsmx
gsmefr-dlcap-parse

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-cod2std		This program reads an FR codec frame stream in ETSI
			*.cod format and converts it to "standard" *.gsm format.

gsmfr-decode		See Codec-utils article.
gsmfr-decode-r
gsmfr-encode
gsmfr-encode-r

gsmfr-dlcap-gsmx	See Calypso-TCH-downlink article.
gsmfr-dlcap-parse

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.

pcm16-check13		This program reads a 16-bit linear PCM recording file
			(raw BE by default, or raw LE with -l option) and checks
			if the 3 least significant bits of every sample are all
			zeros.  All linear PCM samples consumed or generated by
			GSM codecs are only 13 bits wide, left-justified in
			16-bit words, and so is output from G.711 A-law decoding
			- thus it is useful to be able to check if a given file
			in 16-bit PCM format is purely 13-bit or not.

pcm16-raw2wav		See PCM-file-formats article.
pcm16-wav2raw

pcm16-to-alaw		See PCM8-conversions article.
pcm16-to-ulaw
pcm8-to-pcm16