changeset 637:d71ef85036e4

README: add libgsmhr1
author Mychaela Falconia <falcon@freecalypso.org>
date Fri, 20 Mar 2026 04:50:08 +0000
parents 76c6fa603370
children bce323eaeb3a
files README
diffstat 1 files changed, 16 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/README	Fri Mar 20 04:33:02 2026 +0000
+++ b/README	Fri Mar 20 04:50:08 2026 +0000
@@ -21,6 +21,11 @@
 		that was made into a permissible implementation option after
 		the development of AMR.
 
+libgsmhr1	This library implements GSM-HR codec, based on the reference
+		code from ETSI (GSM 06.06).  In addition to standard speech
+		encoder and decoder functions, our library includes many
+		supporting utility functions and a TFO transform implementation.
+
 libtwamr	This library implements 3GPP AMR-NB codec, based on the official
 		reference code (TS 26.073).  Both VAD versions are included,
 		selected by the user application at run time, and I/O functions
@@ -30,19 +35,20 @@
 		in the encoder and if the input to the decoder contains no SID
 		frames.
 
-The only GSM codec for which no implementation library is currently provided is
-GSM-HR, also known as HRv1.  Librification of HRv1 reference code from ETSI is
-a planned work item for future development.
+The libraries provided here are intended for multiple purposes - here are some
+of them:
 
-The libraries provided here are intended for two primary purposes:
+* They are used as part of Themyscira Wireless MGW (media gateway)
+  implementation, providing the necessary speech transcoder between a GSM
+  network and G.711-based PSTN.
 
-1) They are used as part of Themyscira Wireless MGW (media gateway)
-   implementation, providing the necessary speech transcoder between a GSM
-   network and G.711-based PSTN.
+* TFO transforms implemented in these libraries are needed in order to make a
+  proper interface from an incoming RTP stream to an Abis-DL link driving a
+  traditional E1 BTS.
 
-2) They are useful in many varied study and exploration workings, as part of
-   experiments where it becomes necessary to model, simulate or replicate
-   bit-exact operation of someone else's network element.
+* They are useful in many varied study and exploration workings, as part of
+  experiments where it becomes necessary to model, simulate or replicate
+  bit-exact operation of someone else's network element.
 
 Each of our Themyscira core libraries is free-standing and independent of the
 others.  The dependency on classic libgsm (by way of <gsm.h> header file) that