FreeCalypso > hg > gsm-codec-lib
changeset 640:e0e5905261e2 default tip
document tw5b-dump and tw5c-dump
| author | Mychaela Falconia <falcon@freecalypso.org> |
|---|---|
| date | Fri, 20 Mar 2026 06:43:50 +0000 |
| parents | 81ee878e8b22 |
| children | |
| files | doc/AMR-hex-utils doc/TW-TS-005 doc/Utils-overview |
| diffstat | 3 files changed, 24 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/AMR-hex-utils Fri Mar 20 05:33:45 2026 +0000 +++ b/doc/AMR-hex-utils Fri Mar 20 06:43:50 2026 +0000 @@ -32,3 +32,9 @@ format. amr-ietf2hexoa conversion utility sets CMR to 15 (NO_DATA); if some other CMR is desired, the desired effect can be trivially achieved by applying sed to amr-ietf2hexoa output. + +There is also tw5c-dump utility that reads a TW-TS-005 Annex C hex file and +parses all frames found therein. By default it expects either OA or OAX format; +if OAX extended information is present, it is decoded and displayed. To dump +hex files containing payloads in RFC 4867 BWE format, run tw5c-dump with -b +option.
--- a/doc/TW-TS-005 Fri Mar 20 05:33:45 2026 +0000 +++ b/doc/TW-TS-005 Fri Mar 20 06:43:50 2026 +0000 @@ -17,9 +17,7 @@ * TW-TS-005 Annex D specifies representation of CSD RTP payloads in hex files. The present version of ThemWi GSM codec libraries & utilities suite includes -some utilities that operate on TW-TS-005 Annex A hex files; support for Annex B -will appear in a future version when our work on GSM-HR codec integration -progresses further. Support for Annex C is described in AMR-hex-utils article; +some utilities that operate on TW-TS-005 Annex A, Annex B and Annex C hex files; no utilities for Annex D exist as of this writing. TW-TS-005 Annex A vs gsmx binary format @@ -67,9 +65,21 @@ A line-based hexadecimal file format with one line per stored codec frame is inherently more human-readable than a binary file, but we also desire a more complete decoding such as that produced by gsmrec-dump, showing all codec -parameters and frame metadata flags. tw5a-dump produces such decoding for -TW-TS-005 Annex A hex files; there will also be a corresponding tw5b-dump -utility for TW-TS-005 Annex B when we finish integrating GSM-HR codec support. +parameters and frame metadata flags. The following TW-TS-005 dump utilities +are provided: + +tw5a-dump Decodes TW-TS-005 Annex A hex files and displays FR and EFR + codec frames. + +tw5b-dump Decodes TW-TS-005 Annex B hex files and displays HR codec + frames. + +tw5c-dump Decodes TW-TS-005 Annex C hex files and displays AMR codec + frames. + +For tw5a-dump and tw5b-dump, the only required command line argument is the +name of the hex file to be read and dumped. For tw5c-dump, please refer to +AMR-hex-utils article for further explanation. Conversion utilities (FR and EFR codecs) ========================================