Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/guidocella/mpv-lrc

Download synchronized lyrics from mpv
https://github.com/guidocella/mpv-lrc

lrc lyrics mpv

Last synced: 3 months ago
JSON representation

Download synchronized lyrics from mpv

Awesome Lists containing this project

README 

        
This is a collection of scripts to manage LRC synchronized lyrics of songs playings in mpv. It provides keybindings to download the lyrics of the current song, and also scripts to create and synchronize lyrics yourself with vim on Unix-like systems.



## lrc.lua



### musixmatch-download



Downloads the lyrics of the currently playing song from Musixmatch's API.



The default keybinding is `Alt+m`, and it can be changed by binding `script-message musixmatch-download`



### netease-download



Downloads the lyrics of the currently playing song from NetEase's API. It has more Japanese lyrics than Musixmatch.



NetEase's API doesn't return lyrics directly, but a list of matching entries. `lrc.lua` fetches the first 9, and if mpv's version is >= 0.38, it makes you select which one to download from the console, or download directly when there's only 1 match. Otherwise it downloads the first LRC whose album matches, or the first one if no entry's album matches.



The default keybinding is `Alt+n`, and it can be changed by binding `script-message netease-download`



### offset-sub



After adjusting `sub-delay` in mpv, this offsets the timestamps in the current subtitle file accordingly. It then resets `sub-delay` and reloads the subtitle track so you can offset it again if necessary. This works with any external subtitle and not just LRC. ffmpeg needs to be in `PATH`, or in the same folder as mpv on Windows, for this to work.



The default keybinding is `Alt+o`, and it can be changed by binding `script-message offset-sub`



## Overlay



If mpv supports background transparency on your platform, you can display lyrics in a transparent overlay with `--background=color --background-color=0/0 --ontop --input-cursor-passthrough`.



## Synchronizing lyrics



### lrc.sh



This POSIX script fetches the metadata of the song playing in mpv, opens an LRC file with the same path as the song in `$EDITOR`, and opens `$BROWSER`, falling back to chromium if that is not defined, in the search page for the lyrics in the browser's default search engine. When it detects Japanese characters in the song path, it searches for lyrics in Japanese.



`input-ipc-server=/tmp/mpv-socket` is assumed for the mpv instance that plays music, and jq and socat are required.



When lyrics sites try to block copying text, you can inspect the HTML element with the lyrics and execute `copy($0.innerText)` in the console.



If the current song already has an LRC file, it doesn't overwrite it, but opens it in `$EDITOR` so you can quickly fix mistakes you notice while listening to the song. You can see the changes immediately with this vim autocommand:



```vim

autocmd BufWritePost *.lrc silent !echo sub-reload | socat - /tmp/mpv-socket

```



### lrc.vim



This provides the following keybindings:



* `F7` Prepend the current timestamp, with 0.3 seconds subtracted, to the current line. The 0.3 offset is fairly high and is chosen so that when you don't react immediately to a line you still have time to press `F7` without having to seek backwards, but when you are ready to react immediately it is better to wait a little before pressing it.

* `F8` Seek backwards 2 seconds.

* `F6` Move the cursor to the current subtitle line.

* `F5` Insert a timestamp equals to the one above minus 1/100th of a second in a blank line that is 2 lines above. When you have to synchronize a blank line between 2 lines with little delay between them, synchronize only the next filled line and use this.



It also increases `scrolloff` to keep the cursor in the center as you synchronize the lines.



To use this, add `autocmd BufNewFile,BufReadPost *.lrc setfiletype lrc` to your configuration file, then copy `lrc.vim` to `~/.config/nvim/ftplugin` or `~/.vimrc/ftplugin`.



https://github.com/vim-scripts/lrc.vim provides syntax highlighting. It errors because of carriage returns, but you can remove them with `sed -i 's/\r//' lrc.vim`