comparison doc/TW-TS-005 @ 640:e0e5905261e2

document tw5b-dump and tw5c-dump
author Mychaela Falconia <falcon@freecalypso.org>
date Fri, 20 Mar 2026 06:43:50 +0000
parents 24aba0e7aa35
children
comparison
equal deleted inserted replaced
639:81ee878e8b22 640:e0e5905261e2
15 15
16 * TW-TS-005 Annex C specifies representation of AMR RTP payloads in hex files; 16 * TW-TS-005 Annex C specifies representation of AMR RTP payloads in hex files;
17 * TW-TS-005 Annex D specifies representation of CSD RTP payloads in hex files. 17 * TW-TS-005 Annex D specifies representation of CSD RTP payloads in hex files.
18 18
19 The present version of ThemWi GSM codec libraries & utilities suite includes 19 The present version of ThemWi GSM codec libraries & utilities suite includes
20 some utilities that operate on TW-TS-005 Annex A hex files; support for Annex B 20 some utilities that operate on TW-TS-005 Annex A, Annex B and Annex C hex files;
21 will appear in a future version when our work on GSM-HR codec integration
22 progresses further. Support for Annex C is described in AMR-hex-utils article;
23 no utilities for Annex D exist as of this writing. 21 no utilities for Annex D exist as of this writing.
24 22
25 TW-TS-005 Annex A vs gsmx binary format 23 TW-TS-005 Annex A vs gsmx binary format
26 ======================================= 24 =======================================
27 25
65 =================================================== 63 ===================================================
66 64
67 A line-based hexadecimal file format with one line per stored codec frame is 65 A line-based hexadecimal file format with one line per stored codec frame is
68 inherently more human-readable than a binary file, but we also desire a more 66 inherently more human-readable than a binary file, but we also desire a more
69 complete decoding such as that produced by gsmrec-dump, showing all codec 67 complete decoding such as that produced by gsmrec-dump, showing all codec
70 parameters and frame metadata flags. tw5a-dump produces such decoding for 68 parameters and frame metadata flags. The following TW-TS-005 dump utilities
71 TW-TS-005 Annex A hex files; there will also be a corresponding tw5b-dump 69 are provided:
72 utility for TW-TS-005 Annex B when we finish integrating GSM-HR codec support. 70
71 tw5a-dump Decodes TW-TS-005 Annex A hex files and displays FR and EFR
72 codec frames.
73
74 tw5b-dump Decodes TW-TS-005 Annex B hex files and displays HR codec
75 frames.
76
77 tw5c-dump Decodes TW-TS-005 Annex C hex files and displays AMR codec
78 frames.
79
80 For tw5a-dump and tw5b-dump, the only required command line argument is the
81 name of the hex file to be read and dumped. For tw5c-dump, please refer to
82 AMR-hex-utils article for further explanation.
73 83
74 Conversion utilities (FR and EFR codecs) 84 Conversion utilities (FR and EFR codecs)
75 ======================================== 85 ========================================
76 86
77 gsmx-to-tw5a and tw5a-to-gsmx utilities do what their names suggest: convert 87 gsmx-to-tw5a and tw5a-to-gsmx utilities do what their names suggest: convert