timbru31/mp3lyrics

🎵 📝 CLI for mp3 lyrics fetching. Uses ruby-mp3info and some lyric wikis

MP3Lyrics

Still in Alpha, ugly and WIP :)

Info

MP3Lyrics is a tool written in Ruby (currently only CLI) to download song lyrics from AZLyrics or Genius. The lyrics are added to the mp3 file via the USLT (Unsynchronised lyric/text transcription) tag (with the power of ruby-mp3info).

Motivation

Why Ruby?

Because I wanted to try another language than Java.

Why are you not using the LyricWiki API?

Although they have got a pretty neat REST API the lyrics can't be fully retrieved, most likely due to licensing issues. They no longer offer an API since January 2016. The site has since been shut down as of October 2020.

Why are you not using musiXmatch API?

Simply because they charge me (the developer) for retrieving the lyrics.

Why are you not using MetroLyrics API?

The site has been shut down as of July 2021.

Why are you not using Genius API?

They do not offer fetching lyrics via the API (yet).

Why not iTunes Lyrics Adder, Lyrics for iTunes, iSongText, Get Lyrical, ...?

Either they were tied to iTunes and ugly DLL libraries, outdated/inactive, closed source or not cross platform. I'm mainly developing on my MacBook and my iTunes library is on my Windows system. I need something that works anywhere.

By dropping the need (and support) of iTunes running somewhere in the background, the tool is more lightweight.

Dependencies

1. Bundler
2. Nokogiri for HTML parsing
3. mp3info as a MP3 library
4. require_all for easier requiring of the wiki_api folder
5. For testing purposes you should install rubocop, rake, minitest and optionally coverage reporters for CodeClimate

Installation

gem install mp3lyrics

Usage

mp3lyrics <dir> [-override true/false] [-use genius/azlyrics]

dir is the folder with your music, it's iterated recursively.
override is a boolean toggle to override existing lyrics (defaults to false).
use is a specific wiki to be used to download lyrics (all wikis are used by default).

Development usage

The same options as above apply, but the binary has to be invoked from

./lib/mp3lyrics.rb

Tests

To execute the tests run

bundle exec rake

Future plans // ToDo

• Add support to other lyrics sites when 404 is returned from LyricWiki
• GUI for easier usage (maybe)
• Add test cases, see #1

---

Built by (c) Tim Brust and contributors. Released under the MIT license.

mp3lyrics's Issues

Please for the package as a gem

Please for the package as a gem. It allows to install and use as plain executable

Support other file formats such as FLAC

SwiftLyrics is down

Examine situation - if the service is dead/discontinued remove it.

Using in place delete or replace modifies title and artists

Issue occurred on Windows. Do not use in place replacement or delete.

Add possibility to force a specific Wiki to be used

maybe add a CLI flag to specify the wanted wiki

Examine fetching lyrics from Spotify's API

Support SongLyrics

http://www.songlyrics.com/

Add tests to the project

Test are essential and to be aware of breaking API/layout changes from the sites the test suite should

• test against the real site
• test against mock data
• test mp3 tag
• test main executable

Use multithreading

Examine how to check multiple mp3 files at the same time.

Ruby 2.5 in AppVeyor

New RubyInstallers should be installed: appveyor/ci#1999

Update to CircleCI v2

Improve character escaping

mp3lyrics works great for most songs, but seems to miss every song in which the title contains characters like ( ) - . and probably others. I imagine this has to do with character escaping. Since especially parentheses are pretty common in song titles, this results in about a 35% miss in my experience.

Handle network errors

Handle networks errors (eg 404, offline)

Monitor (possible) rate limits of wikis

Does any of the wiki sites notice the scraping and block this behavior? Continue to monitor

Update simplecov to v0.15.1

Currently blocked by: lemurheavy/coveralls-ruby#124

Support eLyricsWorld

http://www.elyricsworld.com/

Update to new CodeClimate test reporter

The current gem is deprecated in favor of https://docs.codeclimate.com/v1.0/docs/configuring-test-coverage

Update Ruby versions in CI

New Ruby versions have been released, make use of them.

Overriding is true even when the argument is false

Currently override is true regardless if the supplied argument is true, false or foobar

Update Genius lyrics fetching

Genius has changed the API - the lyrics fetching needs to be updated

Testdrive a big chunk of mp3 files

Test the iTunes library on my Windows machine to see if there are any unexpected errors (probably tests a couple of thousand songs)

MetroLyrics & SwiftLyrics formatting looks a bit cut off

SwiftLyrics
From FFDP - No One Gets Left Behind

"we all die alonePoliticians bathing in their greed"
Maybe a missing <br>?
http://swiftlyrics.com/lyrics/five-figner-death-punch-no-one-gets-left-behind.html

Normalize umlauts

Example:

Dame - Tagträume, should be handled as Tagtraume instead
(https://genius.com/Dame-tagtraume-lyrics vs https://genius.com/Dame-tagträume-lyrics)

Support SongtexteMania

http://www.songtextemania.com/

Examine fetching lyrics from Apple Music's API

Robust error handling

Currently the application crashes when an error occurs. Instead the song should be skipped and the error logged, but app should continue to run.