txtlyric-to-lrc/README.md

# txtlyric-to-lrc

txtlyric-to-lrc aligns lyrics to songs in the [lrc](https://en.wikipedia.org/wiki/LRC_(file_format)) synced lyric format.

This is a wrapper around [stable-ts](https://github.com/jianfch/stable-ts) ([whisper](https://github.com/openai/whisper)) that is designed to be used with known-good transcriptions like untimed song lyrics. 

Lyrics are expected to be placed alongside media files in `txt` files, and lines of lyrics (segments) should be separated by newlines. Output `lrc` files will be written out alongside the original `txt` and media files.

## How to Use
```sh
$ python ./txtlyric_to_lrc/main.py -h
Usage: main.py [OPTIONS] DIRECTORY

Options:
  -h, --help           Show this message and exit.
  -m, --model TEXT     Which whisper model to use (choices are those of
                       whisper.available_models)
  -l, --language TEXT  What language the lyrics are in  [required]
```

## How to Develop
```sh
git clone https://g.dracoli.ch/rufei/txtlyric-to-lrc.git
cd txtlyric-to-lrc
poetry install
```

## TODO
* detect musical interludes (might already be possible in stable-ts)
* connect with lyric retrieval services
* support elrc word timings (need to check navidrome and subsonic clients won't throw a fit)