diff doc/Codec-utils @ 550:de333989a12b

document gsm[e]fr-decode-tw5[-r] utilities
author Mychaela Falconia <falcon@freecalypso.org>
date Sat, 05 Oct 2024 02:16:48 +0000
parents 751f06541fbb
children
line wrap: on
line diff
--- a/doc/Codec-utils	Sat Oct 05 00:58:01 2024 +0000
+++ b/doc/Codec-utils	Sat Oct 05 02:16:48 2024 +0000
@@ -66,6 +66,26 @@
   "basic" GSM 06.10 decoding, without the Rx DTX preprocessor step.  BFI frame
   gaps in input are not allowed, and there is no SID or DHF detection.
 
+Additions for TW-TS-005
+=======================
+
+All of the speech decoder utilities described above read FR or EFR compressed
+speech in gsmx binary file format.  However, we now also have a newer
+hexadecimal file format defined in Themyscira Wireless Technical Specification
+TW-TS-005 - see TW-TS-005 article.  TW-TS-005 Annex A is the application of
+this hex format to FR and EFR codecs.  Here are our updated speech decoder
+utilities that read TW-TS-005 Annex A file format:
+
+Original utility, reads gsmx	New utility, reads TW-TS-005 Annex A
+--------------------------------------------------------------------
+gsmfr-decode			gsmfr-decode-tw5
+gsmfr-decode-r			gsmfr-decode-tw5-r
+gsmefr-decode			gsmefr-decode-tw5
+gsmefr-decode-r			gsmefr-decode-tw5-r
+
+There are no changes to speech encoder utilities: generating gsmx and then
+converting it to TW-TS-005 with gsmx-to-tw5a is a perfectly good workflow.
+
 Standalone command line utilities for AMR codec
 ===============================================