view doc/Utils-overview @ 483:4f13db3a7086

doc/Utils-overview: document new utilities
author Mychaela Falconia <falcon@freecalypso.org>
date Mon, 20 May 2024 01:26:12 +0000
parents 047c198408c8
children d9f6b3125259
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

amrefr-decode-r		See AMR-EFR-hybrid-emu article.
amrefr-encode-r
amrefr-tseq-dec
amrefr-tseq-enc

amrts-pcm8-compact	The set of AMR test sequences shipped by 3GPP as
			TS 26.074 includes not only linear PCM and AMR-encoded
			files, but also 8-bit PCM sequences in both A-law and
			mu-law.  However, those PCM8 sequences are shipped in a
			stupid and inconvenient format: each 8-bit PCM sample
			is expanded to a 16-bit word, written in LE byte order.
			This utility converts a PCM8 test sequence file from
			this weird format into sane PCM8 format with one byte
			per sample.

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-dlcap-sync

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-decode-rb
gsmfr-encode
gsmfr-encode-r

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

gsmfr-preproc		See FR1-Rx-DTX article.

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

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

twamr-tseq-dec		See AMR-library-tests article.
twamr-tseq-enc