aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/README.md b/README.md
index caf4f3e..9ba5152 100644
--- a/README.md
+++ b/README.md
@@ -9,14 +9,16 @@ Any column of the input file can be used as sample data for a resulting monophon
* `i16`: 16bit signed little-endian data
* `i32`: 32bit signed little-endian data
* `f32`: 32bit IEEE float data
+* `nf32`: 32bit IEEE float data, but without the normalization step
Note that the integer output data formats only use the integer part of the input data, ie. when using the `i32` output format, the input sample
value `1.23` is truncated to the output sample value `1`.
When using the integer output data formats, the exact sample value is preserved (as long as it fits the storage size). For the `f32` format, the
-specification requires that the samples be normalized to the range `-1.0` to `1.0`, thus the sample values will not be preserved.
+specification requires that the samples be normalized to the range `-1.0` to `1.0`, thus the sample values will not be preserved. Use the `nf32`
+sample format when your input data is already normalized and you want to preserve the exact sample values.
-Quoted text embedding the separation character `,` within CSV columns will confuse the CSV parser. Don't do that.
+Quoted text embedding the separation character within CSV columns will confuse the CSV parser. Don't do that.
## Building
@@ -29,7 +31,7 @@ To build the windows executable `cswave.exe`, the `mingw-w64` crosscompiler is r
Call the tool using the invocation
```
-./cswave <file.csv> <file.wav> <column> <samplerate> [<format>]
+./cswave <file.csv> <file.wav> <column> <samplerate> [<format>] [<delimiter>]
```
* `<file.csv>`: CSV input file
@@ -37,3 +39,4 @@ Call the tool using the invocation
* `<column>`: Zero-based column index within the CSV (e.g., `0`)
* `<samplerate>`: Integer sample rate of the resulting output file (e.g., `44100`)
* `<format>`: Output file sample format as listed above, default `i16`
+* `<delimiter>`: Specify a single character to use as the delimiter within the CSV input, default `,`