FreeCalypso > hg > gsm-codec-lib
changeset 157:04936af99fc8
document gsm[e]fr-{en,de}code-r utilities
author | Mychaela Falconia <falcon@freecalypso.org> |
---|---|
date | Thu, 15 Dec 2022 02:08:55 +0000 |
parents | 3f3674c27840 |
children | 1e8569000049 |
files | doc/Codec-utils doc/Utils-overview |
diffstat | 2 files changed, 14 insertions(+), 10 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/Codec-utils Thu Dec 15 01:42:31 2022 +0000 +++ b/doc/Codec-utils Thu Dec 15 02:08:55 2022 +0000 @@ -35,14 +35,14 @@ and feeds all frames and BFIs to our EFR decoder. The decoded output is written as WAV. -WAV reading and writing functions used by the above utilities have been lifted -out of opencore-amrnb test code. +The above are original programs that read WAV input for encoding and write WAV +output from decoding. We now also have raw versions that read and write our +"robe" (raw big-endian) format instead: -Now that we are starting to encounter use cases that involve more than feeding -a PC microphone recording to test encoders and playing decoder output on PC -speakers, many of those other use cases call for using raw format instead of WAV -for 16-bit linear PCM. While it would be philosophically most proper to add an -option to gsm[e]fr-encode and gsm[e]fr-decode utilities to read/write raw PCM -files instead of WAV, doing so would complicate the code too much. As a -compromise between code simplicity and functionality, we provide lossless -conversion utilities - see PCM-file-formats article. +gsmfr-encode-r Just like gsm[e]fr-encode, but reading "robe" instead of WAV. +gsmefr-encode-r + +gsmfr-decode-r Just like gsm[e]fr-decode, but writing "robe" instead of WAV. +gsmefr-decode-r + +Please see PCM-file-formats article for the rationale.
--- a/doc/Utils-overview Thu Dec 15 01:42:31 2022 +0000 +++ b/doc/Utils-overview Thu Dec 15 02:08:55 2022 +0000 @@ -8,7 +8,9 @@ gsmefr-dec-parse gsmefr-decode See Codec-utils article. +gsmefr-decode-r gsmefr-encode +gsmefr-encode-r gsmefr-etsi-dec See EFR-testing article. gsmefr-etsi-enc @@ -24,7 +26,9 @@ gsmfr-cvt-dlcap See Calypso-TCH-downlink article. gsmfr-decode See Codec-utils article. +gsmfr-decode-r gsmfr-encode +gsmfr-encode-r gsmfr-hand-test This program was written as part of a debug chase: there seemed to be a design flaw in libgsmfrp, but the