diff doc/PCM-file-formats @ 143:195911f2211c

document PCM format conversion utilities
author Mychaela Falconia <falcon@freecalypso.org>
date Wed, 14 Dec 2022 07:04:59 +0000
parents
children a217a6eacbad
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/PCM-file-formats	Wed Dec 14 07:04:59 2022 +0000
@@ -0,0 +1,18 @@
+What file format should be used for 16-bit PCM sample recordings?  The first
+(in the order of development) group of utilities in the present package that
+need to read and write such files are gsm[e]fr-encode and gsm[e]fr-decode,
+designed to mirror amrnb-enc and amrnb-dec from opencore-amr FOSS package;
+these utilities read and write WAV files and even use WAV reading and writing
+functions copied from opencore-amrnb test code.
+
+However, as I (Mother Mychaela) keep developing more tools, my use cases become
+more diverse: in some use cases WAV is most convenient (e.g., when playing or
+recording with SoX tools), but in other use cases a raw sample file without any
+header is much more convenient.  To address this diversity of use cases, a pair
+of conversion utilities have been written:
+
+pcm16-raw2wav converts from raw format to WAV
+pcm16-wav2raw converts from WAV to raw format
+
+Both utilities take a mandatory command line argument specifying the endian
+order for the raw format - there is no default.