From e9280f61bd88ad89fe4f1a78f2a3045541ff3808 Mon Sep 17 00:00:00 2001
From: Sting <loic.allegre@ensiie.fr>
Date: Tue, 18 Jul 2023 15:49:47 +0200
Subject: [PATCH] Update ReadMe and requirements

---
 README.md        | 23 ++++++++++++++++++++---
 requirements.txt |  3 ++-
 2 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 04b43ea..6b71211 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,6 @@ An introduction to neural networks and deep learning:
 
 [Using CNNs on spectrogram images](https://www.ofai.at/~jan.schlueter/pubs/2014_icassp.pdf) (Schlüter, Böck, 2014) :
  - [MADMOM implementation](https://madmom.readthedocs.io/en/v0.16/modules/features/onsets.html)
- - Python implementation for Taiko rythm games : https://github.com/seiichiinoue/odcnn
 
 ### Other methods
 
@@ -70,27 +69,45 @@ Having a CUDA-capable GPU is optional, but can greatly reduce processing time in
 
 # Use
 
-## Inference
+## Autokara
 
-To execute AutoKara on a MKV video file :
+To execute AutoKara from scratch on a MKV video file :
 ```bash
 $ python autokara.py video.mkv output.ass
 ```
 
+To execute AutoKara with existing syl splits and line timings :
+```bash
+$ python autokara.py video.mkv output.ass --ref reference.ass
+```
+
 To execute AutoKara on a (pre-extracted) WAV vocals file :
 ```bash
 $ python autokara.py vocals.wav output.ass --vocals
 ```
 
+## Useful scripts
 
 To only extract .wav audio from a MKV file :
 ```bash
 $ ./extractWav.sh source_video output_audio
 ```
 
+To only extract .ass sub file from a MKV file :
+```bash
+$ ./extractAss.sh source_video output_subs
+```
+
 To only separate vocals from instruments in an audio file :
 ```bash
 demucs --two-stems=vocals -o output_folder audio_file.wav
 ```
 
+Batch preprocessing (vocals + ASS extraction) of all videos in a directory :
+```bash
+$ ./preprocess_media.sh video_folder output_folder
+```
+
+
+
 
diff --git a/requirements.txt b/requirements.txt
index 770a61b..037cec8 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -9,4 +9,5 @@ tqdm
 scipy
 cython
 mido
-git+https://github.com/CPJKU/madmom.git
\ No newline at end of file
+git+https://github.com/CPJKU/madmom.git
+praat-parselmouth
\ No newline at end of file
-- 
GitLab