Lyrics Alignment

README.md

@@ -73,17 +73,21 @@ Having a CUDA-capable GPU is optional, but can greatly reduce processing time in
 
 ## Autokara
 
-To execute AutoKara from scratch on a MKV video file :
+To use Autokara, you need :
+ - A media file of the song (video, or pre-extracted vocals)
+ - An ASS file with the lyrics, split by syllable
+
+To execute AutoKara on a MKV video file and an ASS file containing the lyrics (ASS will be overwritten):
 ```bash
-$ python autokara.py video.mkv output.ass
+$ python autokara.py video.mkv lyrics.ass
 ```
 
-To execute AutoKara with existing syl splits and line timings :
+To output to a different file (and keep the original) :
 ```bash
-$ python autokara.py video.mkv output.ass --ref reference.ass
+$ python autokara.py video.mkv lyrics.ass -o output.ass
 ```
 
-To execute AutoKara on a (pre-extracted) WAV vocals file :
+To execute AutoKara on a (pre-extracted) WAV (or OGG, MP3, ...) vocals file, pass the `--vocals` flag :
 ```bash
 $ python autokara.py vocals.wav output.ass --vocals
 ```
@@ -110,6 +114,12 @@ Batch preprocessing (vocals + ASS extraction) of all videos in a directory :
 $ ./preprocess_media.sh video_folder output_folder
 ```
 
+A visualization tool, mainly intended for debug.
+Does the same as autokara.py, but instead of writing to a file, plots a graphic with onset times, spectrogram, probability curves,... 
+Does not work on video files, only separated vocals audio files
+```bash
+$ python plot_syls.py vocals.wav lyrics.ass
+```