FreeCalypso > hg > gsm-codec-lib
annotate doc/Utils-overview @ 289:18229558c8bf
gsmfr-preproc: convert to libgsmfr2
author | Mychaela Falconia <falcon@freecalypso.org> |
---|---|
date | Sun, 14 Apr 2024 06:22:46 +0000 |
parents | a55fcc8b6daf |
children | 047c198408c8 |
rev | line source |
---|---|
136
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
1 Here is the complete list of all command line utilities included in the present |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
2 package: |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
3 |
218
f4f68c652e98
doc: document AMR study utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
209
diff
changeset
|
4 amr-cod-parse See AMR-study-utils article. |
f4f68c652e98
doc: document AMR study utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
209
diff
changeset
|
5 amr-ietf-parse |
f4f68c652e98
doc: document AMR study utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
209
diff
changeset
|
6 amr-cod2ietf |
f4f68c652e98
doc: document AMR study utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
209
diff
changeset
|
7 amr-ietf2cod |
f4f68c652e98
doc: document AMR study utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
209
diff
changeset
|
8 |
136
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
9 gsm-amr2efr See AMR-EFR-conversion article. |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
10 gsm-efr2amr |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
11 |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
12 gsmefr-cod-parse See EFR-testing article. |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
13 gsmefr-dec-parse |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
14 |
240
3aeb33d835ad
doc/Utils-overview: document gsmefr-cod2gsmx
Mychaela Falconia <falcon@freecalypso.org>
parents:
238
diff
changeset
|
15 gsmefr-cod2gsmx This program reads an EFR codec frame stream in ETSI |
3aeb33d835ad
doc/Utils-overview: document gsmefr-cod2gsmx
Mychaela Falconia <falcon@freecalypso.org>
parents:
238
diff
changeset
|
16 *.cod format and converts it to Themyscira gsmx format. |
3aeb33d835ad
doc/Utils-overview: document gsmefr-cod2gsmx
Mychaela Falconia <falcon@freecalypso.org>
parents:
238
diff
changeset
|
17 |
136
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
18 gsmefr-decode See Codec-utils article. |
157
04936af99fc8
document gsm[e]fr-{en,de}code-r utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
143
diff
changeset
|
19 gsmefr-decode-r |
136
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
20 gsmefr-encode |
157
04936af99fc8
document gsm[e]fr-{en,de}code-r utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
143
diff
changeset
|
21 gsmefr-encode-r |
136
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
22 |
169
0c965c3c5e6e
doc/Utils-overview: new Calypso TCH DL utils
Mychaela Falconia <falcon@freecalypso.org>
parents:
157
diff
changeset
|
23 gsmefr-dlcap-dec See Calypso-TCH-downlink article. |
0c965c3c5e6e
doc/Utils-overview: new Calypso TCH DL utils
Mychaela Falconia <falcon@freecalypso.org>
parents:
157
diff
changeset
|
24 gsmefr-dlcap-gsmx |
0c965c3c5e6e
doc/Utils-overview: new Calypso TCH DL utils
Mychaela Falconia <falcon@freecalypso.org>
parents:
157
diff
changeset
|
25 gsmefr-dlcap-parse |
0c965c3c5e6e
doc/Utils-overview: new Calypso TCH DL utils
Mychaela Falconia <falcon@freecalypso.org>
parents:
157
diff
changeset
|
26 |
136
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
27 gsmefr-etsi-dec See EFR-testing article. |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
28 gsmefr-etsi-enc |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
29 |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
30 gsmefr-rec2etsi This program reads an EFR session recording in gsmx |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
31 format and converts it into ETSI decoder input (.dec) |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
32 format. It was written early in the project as a sanity |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
33 check, to verify that the format of TCH uplink from |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
34 sysmoBTS in EFR mode matches our expectations, before |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
35 embarking on the labor-intensive project to librify EFR |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
36 reference code from ETSI. |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
37 |
246
a55fcc8b6daf
doc/Utils-overview: add gsmfr-cod2std
Mychaela Falconia <falcon@freecalypso.org>
parents:
240
diff
changeset
|
38 gsmfr-cod2std This program reads an FR codec frame stream in ETSI |
a55fcc8b6daf
doc/Utils-overview: add gsmfr-cod2std
Mychaela Falconia <falcon@freecalypso.org>
parents:
240
diff
changeset
|
39 *.cod format and converts it to "standard" *.gsm format. |
a55fcc8b6daf
doc/Utils-overview: add gsmfr-cod2std
Mychaela Falconia <falcon@freecalypso.org>
parents:
240
diff
changeset
|
40 |
136
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
41 gsmfr-decode See Codec-utils article. |
157
04936af99fc8
document gsm[e]fr-{en,de}code-r utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
143
diff
changeset
|
42 gsmfr-decode-r |
136
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
43 gsmfr-encode |
157
04936af99fc8
document gsm[e]fr-{en,de}code-r utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
143
diff
changeset
|
44 gsmfr-encode-r |
136
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
45 |
169
0c965c3c5e6e
doc/Utils-overview: new Calypso TCH DL utils
Mychaela Falconia <falcon@freecalypso.org>
parents:
157
diff
changeset
|
46 gsmfr-dlcap-gsmx See Calypso-TCH-downlink article. |
0c965c3c5e6e
doc/Utils-overview: new Calypso TCH DL utils
Mychaela Falconia <falcon@freecalypso.org>
parents:
157
diff
changeset
|
47 gsmfr-dlcap-parse |
0c965c3c5e6e
doc/Utils-overview: new Calypso TCH DL utils
Mychaela Falconia <falcon@freecalypso.org>
parents:
157
diff
changeset
|
48 |
136
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
49 gsmfr-hand-test This program was written as part of a debug chase: |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
50 there seemed to be a design flaw in libgsmfrp, but the |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
51 actual bug turned out to be in the way we patched |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
52 osmo-bts-sysmo to produce a continuous RTP stream. |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
53 |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
54 gsmfr-max-out Another test program written as part of the same debug |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
55 chase. |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
56 |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
57 gsmfr-preproc This program reads a gsmx file in FR codec format, |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
58 passes it through our Rx DTX preprocessor (libgsmfrp), |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
59 and writes the preprocessor output to another .gsm file. |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
60 |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
61 gsmrec-dump See Binary-file-format article. |
8eb0e7a39409
doc: document command line utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
62 |
238
de1b52304d26
doc/Utils-overview: add new PCM utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
218
diff
changeset
|
63 pcm16-check13 This program reads a 16-bit linear PCM recording file |
de1b52304d26
doc/Utils-overview: add new PCM utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
218
diff
changeset
|
64 (raw BE by default, or raw LE with -l option) and checks |
de1b52304d26
doc/Utils-overview: add new PCM utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
218
diff
changeset
|
65 if the 3 least significant bits of every sample are all |
de1b52304d26
doc/Utils-overview: add new PCM utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
218
diff
changeset
|
66 zeros. All linear PCM samples consumed or generated by |
de1b52304d26
doc/Utils-overview: add new PCM utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
218
diff
changeset
|
67 GSM codecs are only 13 bits wide, left-justified in |
de1b52304d26
doc/Utils-overview: add new PCM utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
218
diff
changeset
|
68 16-bit words, and so is output from G.711 A-law decoding |
de1b52304d26
doc/Utils-overview: add new PCM utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
218
diff
changeset
|
69 - thus it is useful to be able to check if a given file |
de1b52304d26
doc/Utils-overview: add new PCM utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
218
diff
changeset
|
70 in 16-bit PCM format is purely 13-bit or not. |
de1b52304d26
doc/Utils-overview: add new PCM utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
218
diff
changeset
|
71 |
143
195911f2211c
document PCM format conversion utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
136
diff
changeset
|
72 pcm16-raw2wav See PCM-file-formats article. |
195911f2211c
document PCM format conversion utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
136
diff
changeset
|
73 pcm16-wav2raw |
238
de1b52304d26
doc/Utils-overview: add new PCM utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
218
diff
changeset
|
74 |
de1b52304d26
doc/Utils-overview: add new PCM utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
218
diff
changeset
|
75 pcm16-to-alaw See PCM8-conversions article. |
de1b52304d26
doc/Utils-overview: add new PCM utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
218
diff
changeset
|
76 pcm16-to-ulaw |
de1b52304d26
doc/Utils-overview: add new PCM utilities
Mychaela Falconia <falcon@freecalypso.org>
parents:
218
diff
changeset
|
77 pcm8-to-pcm16 |