Lyrics ID3

Die deutsche Übersetzung der Skriptbeschreibung:
http://www.student.tugraz.at/stefan.gruber/lyricsID3/de

Français:
http://www.student.tugraz.at/stefan.gruber/lyricsID3/fr

Italiano:
http://www.student.tugraz.at/stefan.gruber/lyricsID3/it

Available Languages
The script is available in:
- english
- german
- french
- italian
Read Lyrics from ID3
his is a lyrics script for Amarok. In contrast to many other lyrics scripts, it fetches the lyrics not from the Internet. It uses the possibility to store lyrics in the ID3 tag of mp3 files (USLT frame). So if there are lyrics stored in file and this script is running, Amarok will display the lyrics.
ID3v2 allows to store multiple lyrics in one file. They are separated by different language codes and/or comments. In this case the script let you choose between the different lyrics by a simple click.

Additionally there is a rudimentary support for Vorbis Comments and FLAC Comments. It is possible to specify a key value (the default is LYRICS). The first comment containg the keyword will be read out and displayed as lyrics in Amarok.

As for Ogg Vorbis there is a feature for reading lyrics in m4a (mp4 (AAC)).

Many lyrics contain characters, which are not in the range of ASCII. In order to handle these characters, you should use a appropriate standard out encoding, like UTF-8 or Latin1.

There is no configuration required by the script.

Save Lyrics to ID3
With this script you can save the lyrics of a song in the ID3v2.4 tag of a mp3-file. If you use a mp3-player which can read this tag (USLT frame in ID3), it will display the lyrics.
To store the lyrics, two options have to be specified: a three letter language code (ISO 839-2) and a comment or description of the lyrics. This script provide to modes on how to save the lyrics. These modes are Automatic Mode and Manual Mode. Additionally you can delete already stored lyrics.
All lyrics are stored in UTF-8, which require ID3v2.4. So all tags with versions 2.x will be updated to v2.4. If there is only a ID3v1.1 in the file, an additional tag will be created. If there is no tag at all, no lyrics will be stored.
Many lyrics contain characters, which are not in the range of ASCII. In order to handle these characters, you should use a appropriate standard out encoding, like UTF-8 or Latin1.

Automatic Mode
In this mode the lyrics are stored automatically. Every time Amarok starts a new song the scripts waits a specified time then it fetches the lyrics and stores them in the file. For a successful use of this mode, you have to configure some stuff. First of all you need the specify a language code and a description which will be used. Second you have to specify a waiting time. This represents the time between a track change and the start of the storing process. The amount of seconds is calculated by the song length divided by waitTime. Thus a bigger the value of waitTime leads to a shorter time between a track change and the storing process.
All these configurations can easily be done with the configuration dialog provided by the script. To use this, mark the script in the script manager in Amarok and click on configure (the script has to be in running mode).
If you to disable the Automatic Mode you can easily do this during the configuration process.

Manual Mode
- Saving Lyrics -
You can also save the lyrics manually. For this you can use the context menu entry: saveLyrics. The action is always based on the selcted songs in the playlist. If you click on saveLyrics, you will get a dialog where you can specify the language code, description and lyrics.
If there are already lyrics and the file, the dialog will show the language code and the description of the lyrics in the file. The displayed lyrics are always the ones, which Amarok displays in the context browser. To overwrite the lyrics just acknowledge the dialog. If you specify new options, the lyrics will be stored additionally except Change Comment is not checked. If this is checked, the lyrics will not be stored additionally. The lyrics will be stored with the same language key and a different comment. So the previous lyrics will be deleted in the file. If there are more than one lyrics with the selected language key in the file, just one will be overwritten.
- Deleting Lyrics -
This works like the saving process. If you use the context menu entry removeLyrics a dialog will show up. In this dialog you can specify the language code and the description of the lyrics which should be deleted.


Dependencies

Python 2.2, 2.3 or 2.4

Python Mutagen (http://www.sacredchao.net/quodlibet/wiki/Development/Mutagen)

pyKDE/pyQT (python-sip4)

Python Minidom

Python urllib

kdialog

Warning
The lyrics are stored in the mp3-File. I can not guaranty that the file is not damaged after the writing process.
The file type is only verified by extension.

Translators wanted
I am looking for translators. So if you want to contribute, translate the script in your favorite language and send me the result. I will release your translation with the script.
If you have experience with translation and gettext you can use messages.pot provided with the script. Otherwise you can contact me and I'll explain how to do the translation.

Previous Versions
Previous Versions of the script can be found at:
http://stifi.st.ohost.de/scripts/

Save Lyrics to ID3 Button
If you want to have a button in Amaroks Context Browser which triggers a saving cycle you can download the patches here:
http://www.student.tugraz.at/stefan.gruber/saveButtonPatch/

Feedback is appreciated and please report any bugs.

Version 1.7

corrected link in README to French translation

Italian translation and some spell checks from Marco Poletti *thanks!*

Version 1.6a

small bug fix version

Version 1.6

french translation by pgraber *thanks!*

set STD_ENCODING to ASCII as default

Version 1.5

some unicode fixes on notifiactions

disabled debug output by default

Version 1.4

new Icon

fixed character sets errors in mass tagging

Version 1.3

support for FLAC

configurable key name for FLAC/Vorbis

added Mass Tagging Feature

the action is now based on the selected songs in the playlist

Configuration Dialog

Version 1.2a

removed popup if no lyrics are found

Version 1.2

removed debug(lyrics)

reading support for m4a

using mutagen for Ogg Vorbis

Timer for Automatic Mode is stopped, if Amarok stops playing the song.

Version 1.1

started with translation (gettext)

If mutagen is not installed, the scripts tries to install it.

READMEs are in well formated XHTML

Automatic Mode can be disabled

changing comments is now possible

some structural changes in the code

very small bug fixes

all dialogs are now in front by default

Version 1.0

error message on wrong language code was always shown after configuring the script

Version 0.9

spec-file

better description of the script behaviour

politer messages

non-ASCII characters in comments are handled

small bug fixes

Version 0.8

exit gracefully on stop

automatic mode did not work

Version 0.7

removed dependency of dcop lib (which caused many problems for python2.5 users)

saving in vorbis is deactived by default, because I have no time to maintain this script

Version 0.6

many encoding fixes (thanks to aeternos)

Version 0.5

GUI for configuration

improved the dialog for saving the lyrics

you can now edit the lyrics before saving

better dialog for deleting the lyrics

Version 0.4

added non ISO language codes

waiting time is now configurable

(click on 'configure' to initialize your configuration-file)

new configure option: comment

cleaned up code

Version 0.3

removed pause option

small bug fixes

Version 0.3alpha

initial release with python-mutagen