lauchmelder/spectralyze
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

updated readme

Browse source
This commit is contained in:
Robert 2021-04-27 17:21:35 +02:00
parent c279d783bc
commit 79a710bc80
1 changed files with 15 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -2,10 +2,14 @@
A commandline tool for fourier transforming audio files
## Usage
Spectralyze is a commandline tool, type `spectralyze -h` to get a list of available options. Anyways, here is an example command you might run:
```
spectralyze file1 [file2...]
spectralyze -i 50 coolSong.wav
```
This would read in a file called `coolSong.wav`, split it into 50ms long audio segments and then transform each of those individually. The resulting spectrums will be stored in `coolSong.json`
## Supported Formats
* WAV
* AIFF
@ -15,9 +19,16 @@ Spectralyze reads one or more audio files from the standard arguments and create
Each audio channel in the file is transformed separately. The resulting JSON has the following structure
```
{
"channel_1": [
{"freq": 0.0, "mag": 1.0"},
{"freq": 0.1, "mag": 1.1"},
"channel_1": [ | Channel of the current spectrum
{ |
"begin": 0, | Index of the first sample of this segment
"end": 1000, | Index of the last sample of this segment
"spectrum": [ |
{"freq": 0.0, "mag": 1.0"}, | First spectrum datapoint
{"freq": 0.1, "mag": 1.1"}, | Second spectrum datapoint
...
]
},
...
],
"channel_2": ...