FreeCalypso > hg > gsm-codec-lib

comparison README @ 206:1b8cb3490d48

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
README: update for work approaching release
author Mychaela Falconia <falcon@freecalypso.org>
date Wed, 04 Jan 2023 07:53:16 +0000
parents b45bb0f9bdfc
children 614ae8dc6807
comparison
equal deleted inserted replaced
205:17f690749099 206:1b8cb3490d48
1 The present source repository is intended to be a collection of C libraries 1 Themyscira Wireless GSM codec libraries & utilities package
2 (each at least conceptually independent and free-standing) providing 2 ===========================================================
3 functionality in a spirit similar to the venerable libgsm (GSM 06.10
4 implementation) from 1990s. The following libraries are currently envisioned:
5 3
6 libgsmfrp A preprocessor to be invoked prior to gsm_decode() from classic 4 Themyscira Wireless, a technical initiative of the Women's Republic of
7 libgsm, implementing GSM 06.11, 06.12 and 06.31 functionality 5 Themyscira, is proud to present this package of GSM codec libraries and
8 in the Rx direction. 6 associated command line test and development utilities. The present package
7 provides two linkable C libraries, intended to be usable by any application
8 that needs GSM codec functionality:
9 9
10 libgsmefr An implementation of EFR codec in the same spirit as classic 10 libgsmefr An implementation of EFR codec in the same spirit as classic
11 libgsm, i.e., like libgsm, but for EFR instead of 06.10. It 11 libgsm, i.e., like libgsm, but for EFR instead of 06.10. It is
12 will be based on the reference code from ETSI. 12 based on the reference code from ETSI.
13 13
14 libgsmamr A similar deal for AMR, only a fuzzy idea currently. 14 libgsmfrp An Rx DTX handler preprocessor to be invoked prior to
15 gsm_decode() from classic libgsm, implementing GSM 06.11, 06.12
16 and 06.31 functionality in the Rx direction.
17
18 These two libraries are intended primarily for use as part of GSM network
19 deployment, i.e., as part of the necessary speech transcoder implementation in
20 whichever network-side server process acts as the voice gateway to PSTN or
21 other networks. However, they can also be used as part of development and
22 testing on the mobile side of GSM: for example, to decode TCH downlink bits and
23 voice memo recordings read out of FreeCalypso GSM MS devices, or to implement
24 your own lab-oriented GSM MS on top of some other PHY.
25
26 Each of these two Themyscira libraries (libgsmefr and libgsmfrp) is free-
27 standing and independent of the other. libgsmfrp makes use of <gsm.h> header
28 file from libgsm (for gsm_byte and gsm_frame defined types) and requires this
29 header file in order to compile; libgsmefr has zero dependencies nominally but
30 will often be used together with libgsm and libgsmfrp.
31
32 Included command line utilities
33 ===============================
34
35 In addition to the two main libraries, the present package includes a number of
36 command line utilities, falling into the following groups:
37
38 * Some utilities specifically exercise and test the two core libraries;
39
40 * Some utilities are not specifically for library testing but make use of
41 our libraries;
42
43 * Some utilities are included because they implement some closely related and
44 relevant debug and development functionality, even though they don't link
45 with either libgsmefr or libgsmfrp.
46
47 Please see the included documentation in the doc subdirectory.