ReplayGain

Amarok 1.x Scripts

Source (link to git-repo or to original if based on someone elses unmodified work): Add the source-code for this project on opencode.net

1
5.7
Description:

amaroK replaygain
v1.0.0-beta5 by Miguel Angel Alvarez (maacruz at gmail.com)
October 20, 2007

An amaroK script to normalize volume using the replaygain method
Now on your language: english, spanish, german, hungarian, french, russian, slovak, finnish, polish, portuguesse, italian, turkish, swedish
(more translators wanted!!!)

Using replaygain will make all your songs have the same perceived volume, making unnecesary to adjust the volume on each song change (specially if they are from different albums/artists)


--Release Notes--
1.0.0beta5: Workaround for amarok saving playlist with non valid utf8 characters, which in turn would cause the script to crash. The internal scanner for wma/asf files is now x10 faster.
1.0.0-beta series:
Major enhancements and new features.
Support for streams: now streams can be scanned. The scan must be manually started in track mode. It will rip 60 seconds and set the gain accordingly, so some variance can be expected. The stream must broadcast normalized somewhat for this to have any sense. Requires mplayer.
Support for wma: Using a new internal scanner (only for wma for now, but soon to be expanded for all filetypes). It is quite experimental but since beta5 it is very fast and will use 3dnow on AMD cpu's. Requires mplayer.
Autoscan mode: now replaygain will autoscan the playlist when it is modified (files are added or removed). The autoscan only can do track mode. Streams are not autoscanned (by now). The autoscan starts after a configurable amount of time once the playlist has changed, to avoid putting the cpu under high load during track change in dynamic playlists. Autoscan runs in a separated thread, so replaygain works while the scan is in progress; beware that the manual scan still runs in the main thread (the script will not work on anything else). Autoscan can be enabled/disabled using the playlist context menu, if you want to stop a running autoscan simply disable it; starting a manual scan will also stop a running autoscan; changing the playlist while autoscan is running will let it finish the current file and start a new autoscan. Requires amarok>=1.4.6 and python-xml
New anti-lag meassure: the script follows the playlist and will guess the next track to be played, avoiding to query amarok. Only works if amarok is not playing in random track mode. Requires amarok>=1.4.6 and python-xml.
Minor improvements:
The scripts keeps you informed while a scan is in progress (previous versions only informed when the scan started and finished).
The configuration dialog now informs you of what's supported and any dependency unmet.
Memory usage has been reduced
Files are checked if writeable before scanning them (many thanks to dAniel hAhler http://daniel.hahler.de/ for suggestion and patch)
Volume is updated if the current playing file hadn't replaygain tags after it is scanned (manually or automatically)
More bugs
--End of notes--

Please report any bug

Files supported:
vorbis (ogg), mp3, aac (mp4/m4a), flac, musepack (mpc), wma/asf

Dependencies:

Needed:
kdebase3 (kdialog and dcop), python 2.3 or later, and UTF8 filesystem character set (to use national characters in the filename).
Optional:
pygtk (python-gtk) for the advanced configuration interface.
python-xml for easy playlist album scanning, autoscan, lag-reduction
mplayer, oggenc (vorbis-tools), vorbisgain for streams and wma support.
kdebindings3-python for lag-reduction
The following external utilities:
. metaflac (flac): to apply replaygain tags on flac files. This is likely a standard package on your distribution
. vorbisgain: to apply replaygain tags on vorbis ogg files
. aacgain: to apply replaygain tags on mp4/m4a aac files (works for mp3 too)
. mp3gain: to apply replaygain tags on mp3 files. Not needed if you have aacgain
. replaygain (musepack): to apply replaygain info on mpc (musepack) files.
. mplayer plus oggenc (vorbis-tools) and vorbisgain: to apply replaygain tags on wma/asf files and streams.

Where you can get the needed utilities:

Check your distribution's software repositories first.
Guru's page for SuSE Linux has mp3gain and vorbisgain. (http://linux01.gwdg.de/~pbleser/rpm-navigation.php?cat=Sound/)
Packman has musepack packages (they include replaygain) for SuSE Linux (http://packman.links2linux.de/)
Musepack home page (http://www.musepack.net/index.php?pg=lin)
Vorbisgain home page (http://sjeng.org/vorbisgain.html)
mp3gain home page (http://mp3gain.sourceforge.net/download.php)
aacgain home page (http://altosdesign.com/aacgain/).
mplayer home page (http://mplayerhq.hu

How to use
First you need to analyze all your song files using replaygain. The replaygain algorithm calculates a perceptual volume (gain) for each track (track mode) and album (album mode) and uses this information to correct the playback volume so all tracks or albums sound equally loud. In album mode the relative differences between tracks of an album are preserved, so more quiet tracks will sound more quiet, and louder tracks will sound louder. Album mode is better for live recordings and albums meant to be more than a collection of tracks, while track mode is better for heterogeneus mixes and compillations.
This analysis will not change your file's sound data, it will store the information in tags.

You can analyze a stream, file, album or your whole collection from the playlist's context menu:
Apply Replaygain tags->
-- To selected files in track mode: tag one or more files (as selected in playlist) with their respective track gain (track mode).
-- To playlist in album mode: tag all files in the playlist with both album and track gain tags (album mode), as if the playlist is one album.
-- To entire collection using album tags: the script will group the files in the database using their "Album" tag, and scan each group in album mode.
-- Autoscan: if this is activated, files in the playlist will be automatically tagged (track mode tags only).
It is recommended to have python-xml installed for album tagging (if not installed, playlist tagging as such and autoscan will not be available).

Once a file is tagged with replaygain data, the script will be able to read such tags and it will update the volume as needed.

The mode tags used are selected from the playlist context menu:
- Replaygain mode: which mode will use (track or album)

If a file doesn't have replaygain tags or it is of an unsupported type, it will be played at the default gain.

You can configure the script's operation in the configure script dialog. The most important parameters are:
- Pregain: this is the reference gain in dB (from the 0 point set at 55% volume in amarok). The range goes aproximately from 11 dB to -17 dB. Any replaygain volume correction will be relative to this gain, so you should leave enough space in the range for the script to work. The recommended value is 6.0 dB.
- Peak protection: If enabled, the volume may be adjusted to avoid clipping.
- Default gain: this is the assumed gain for files with no replaygain information. A good value could be -6.0 dB.
- Autoscan delay: amount of time in seconds between the playlist change and the autoscan start. Avoids reacting too quickly to manual playlist changes, and most important, clogging the CPU at track change when using dynamic playlists.

Crossfade is supported, so the volume changes slowly when crossfading.
You have also the option of sudden or smooth volume change when crossfade is disabled in amarok.

Lag reducing howto
Some people are affected by large lag between track change and the replaygain volume update
Lag seems caused by amarok itself by taking too much time to return from dcop calls.
This has been related to high cpu load caused by sqllite and cover image rendering.
So, if you are affected, what can you do?
In amarok 1.4.6 and later the script keeps track of playlist changes, to guess what the next song is and tell amarok to adjust volume inmediatly, needs python-xml and only works if track are played secuentially.
The cpu load for using sqllite has been reduced in 1.4.0 and later, and if you are using 1.3.9 you can apply the patch included in the amarok replaygain script package. Install either of those. Using a external database may be a good idea if you have a large collection, too.
Install kdebindings3-python to take advantage of new script's code.
If you are using the script's OSD control (the "Disable OSD during...." option) disable the OSD or uncheck the script option, it couldn't be optimized because of bugs in pykde
To see how cover rendering affects you, you can move your covers elsewere (try with an author or two) so they are not found. Large cover files may have a big impact, if this is the case, use gimp to reduce them.
Run amarok minimized in the tray, it will not update visual elements saving much time.
Resource intensive software affects too (some screensavers, p2p, ...)
During this beta release debug output is enabled. Have a look at your lag (in seconds) by typing in a konsole/xterm:
tail -f ~/.kde/share/apps/amarok/scripts-data/replayggain.log|grep time
As a reference, my lag is well under 0.1 s (usually 0.01-0.05)


Feedback appreciated.

Enjoy!
Miguel Angel
Last changelog:

13 years ago

0.1-0.3.3
Old vorbisgain releases

0.5-beta "Reborn"
Major rewriting, now it is python
Renamed to replaygain
Add Album and peak support
New nice pygtk interface
Thanks to Kevin Radloff and Jocke "Firetech" for their suggestions and testing

0.5
Uses the new (since amarok 1.3.2) readConfig dcop calls if available, now the script is aware of amarok configuration changes
Added support for musepack (mpc) files

0.5.5
Added support for AAC (mp4/m4a) files
The script checks for external utilities when closing the configure dialog

0.6 "Clean OSD"
New option to disable osd updates during volume changes solving the annoying quick osd changes
Changed detection of external utilities since mp3gain has different behaviour depending on its version (thanks Jocke for pointing this out)
Settings are reread only when the engine starts playing, not at every song change
Fixed the check for external utilities so it solves the "mp3gain not found" missleading message, and a typo which prevented using aacgain when present.
Fixed flac on latest flac releases (thanks Gary Virta)
Changed the "utility not found" dialog to a less annoying notification
Many optimizations and speedups
Thanks Jocke and Roberto for all your testing

0.6.1
Hotfix: fix script breaking on amarok older than 1.3.2 when osd is disabled

0.7
Many new configuration options, not all can be accesed through the kdialog interface
Clipping protection may be disabled so volume doesn't go to 0 on some broken mp3 files
Pregain (volume reference level) may be adjusted by moving the volume slider
Pregain is now adjusted to tenths of dB instead of integer dB
The volume transitions may be smoothed over any specified amount of time when crossfade is disabled
Accurate timing so crossfaded/smoothed volume changes don't take longer than they should
Pygtk interface now has help as tooltips
Changes in script configuration take effect inmediately instead of waiting till next song
Script configuration is saved when amarok stops playing

0.7.1
Added support for mp3 files tagged with foobar (id3v2 tags), it requires id3v2 installed
SIGTERM handler

0.7.2
Added context menu shortcut to change replaygain mode

0.8.0
Internacionalization. Spanish translation.
New option to set the gain (volume) for files without replaygain info (or unsupported files).
Context menu options to apply/delete replaygain tags to playlist/collection. It is recommended to have python-xml installed for almbum tagging.
Some bugfixes

0.8.1
German, french and hungarian translations

0.8.2
Hotfix: do not break while scanning collection if unsupported file has no album tag.

0.8.3
Fix problems with special shell characters in filenames

0.8.4
Fix breaking if enviroment LANG variable is not set (assumes ISO8859-1 charset)

0.8.5
Fix encoding strings headache caused by gettext not returning unicode strings

0.8.6
Couple of small fixes

0.9.0
This release is designed to reduce lag (thanks Stewie for all your testing). Requires installing kdebindings3-python (aka python-kde) to take advantage of new code. Uses pykde for dcop calls if possible
Finnish GUI translation thanks to Samu Voutilainen
Slovak GUI translation thanks to Jozef Ří­ha
Russian translation thanks to Anton Chumak.
Reworked kdialog interface to fix problems caused by X error messages
Corrects collection scanning if using dynamic collection (patch by Frederic Dinh).
Use mutagen-1.4 library (http://www.sacredchao.net/quodlibet/wiki/Development/Mutagen) to read tags, except on mp4/m4a and mpc. Code for mpc and mp4 tag reading thanks to Justus Pendleton and QuodLibet player (needs ctypes python module). Dropped dependency on external utilities for tag reading.
Added support for RVA2 tags (used by QuodLibet and normalize)
Many bugfixes

0.9.1 Add portuguesse and polish GUI translations, updated finnish translation, thanks to Candido Lopes, Jaroslaw Gorny and Samu Voutilainen.

0.9.2: Add italian and turkish GUI translations. Many thanks to Davide "DuffyDac" and Fatih í‡iroglu

0.9.3: Add swedish GUI and README translation. Many thanks to Göran Jartin

C

maacruz

14 years ago

Yes, scanning the whole collection will use album mode.
The only restriction is that all files in an album must be same filetype (either mp3, ogg, or whatever)

Report

crux

14 years ago

Thanks for your answer! I'm going to try it out now.

Report

jetpeach

14 years ago

i ripped a CD to flac files, played it in amarok, then tried adding replaygain tags using right click 'scan file in track mode'
it seems to scan the flac files, but after it finishes it says simply "The following files failed:file:///home/jet/Shared/asdf.flac"
it works for mp3s still, but not flac i guess.

any ideas? i have the flac ability to play and edit tags installed, i changed the tags on the flac files no problem.

let me know if you don't already know about this problem and i will try to provide more debug info for you.

amarok 1.4.3
kubuntu dapper kde 3.5.4

also, this did not, as far as i remember, happen with the previous replaygain before 0.9

Report

C

maacruz

14 years ago

It works for me (flac 1.1.2).
flac is rather picky about sampling rates and replaygain, as it documentation states:
The sample rate must be one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48 kHz.
Please check your files (metaflac --list or even mplayer will give you enough information). Check file permissions too.
If everything is right, you should send me a sample file.

Report

jetpeach

14 years ago

on further fiddling, they are at 44.1khz, but it seems the default setup for encoding my flac files in kde caused a corruption at the end of the files. they play fine and i wouldn't have known, but testing them they fail the CRC at 99%, so i'm sure this must be the reason replaygain fails. i tested a trimmed version and replaygain worked fine as well.

sorry to take your time! i love replaygain and look forward to getting it on these flac files once i fix their corruption.

Report

stuffcorpse

14 years ago

Hi I'm running amarok from svn and when I press OK on the configure dialogue I get this error:

The script 'amarok_replaygain.py' exited with error code: 1

Traceback (most recent call last):
File "/home/rick/.kde/share/apps/amarok/scripts/amarok_replaygain/amarok_replaygain.py", line 760, in ?
if amarok_has_readconfig: read_amarok_config()
NameError: name 'amarok_has_readconfig' is not defined

Report

C

maacruz

14 years ago

It's a bug that crept in beta6. Should be fixed now.

Report

jihaire

14 years ago

Hello

I have a problem with collection scan in album mode.

It looks like there are lots of which disappears when i use aacgain in command line.
I'm using amarok compiled (today) from SVN, with a MySQL database.

In my case, i think the problems comes from the dynamic collection feature of amarok which 'cuts' the url in two parts : the mounted part, and the 'fixed' part.
The two informations are stored in the tags and devices tables.
But it seems your script only retrieve the fixed part, which is not complete.

I made a quick fix on the previous version of your script. I could mail it to you if you are interested.

Report

C

maacruz

14 years ago

Of course I'm interested. Please, send me your patch.

Report

califdreas

14 years ago

amarok 1.4.3. Playing the mp3-files is ok, but I can't process any new files :(.After downgrading to an older pre-1.4.2 version I pulled from svn some weeks ago it works fine.

I hope you can fix it, as amarok-replaygain is one of the amarok skripts I find really usefull.

Report

C

maacruz

14 years ago

Please, give me a more detailed description of what fails.
Is it collection scan? Album scan? Selected files scan? Anything else?

Report

califdreas

14 years ago

thanks for getting back to me so quickly. What fails is to try and add replaygain tags to any file(s).

No matter if it is in album mode, collection scan or anything else. The program doesn't give any feedback (the little status area in the bottom left of the amarok window stays empty). I tried to call aacgain from the console, and it works.

Here is a replaygain.log. I tried to add a replaygain-tag to the file /xtra/Music/Andreas/01-Revelation.mp3
--------------------
PATH=/home/andreas/bin:/usr/local/bin:/usr/bin:/usr/X11R6/bin:/bin:/usr/games:/opt/gnome/bin:/opt/kde3/bin:/usr/lib/mit/bin:/usr/lib/mit/sbin:/usr/lib/qt3/bin:/usr/sbin
Locale=utf
dcop call time:0.0116561623507
Amarok engine:xine-engine
crossfade:True
crossfade time:2.0
osd:True
osd duration:5.0
replaygain config:{'no_peak': 'false', 'pregain': '+6', 'no_osd': 'false', 'smooth': 'true', 'gain_default': '-3.0', 'use_slider': 'false', 'mode': 'track', 'smooth_time': '0.5'}
Amarok signal:customMenuClicked: ReplayGain-Tags hinzufügen Zu ausgewählten Dateien im Titel-Modus file:///xtra/Music/Andreas/01-Revelation.mp3
-----------------

Report

C

maacruz

14 years ago

Thanks for the log.
It seems amarok 1.4.3 properly supports international character sets in notifications.
Should be fixed now

Report

califdreas

14 years ago

Thanks! Works like a charm again!

Keep up the good work, please. It is well appreciated.

Report

dasbooter

14 years ago

I am getting this after most recent upgrade from beta 2 to 5

exit error code :1

Traceback (most recent call last):
File "/home/dasbooter/.kde/share/apps/amarok/scripts/amarok_replaygain/amarok_replaygain.py", line 710, in ?
elif sinput.startswith('volumeChange') and song_url.startswith('file:'):
NameError: name 'song_url' is not defined

Report

C

maacruz

14 years ago

Update again. I realized this bug 5 minutes after uploading beta5, so I fixed and re-uploaded it. Probably you downloaded the buggy release in that 10 minutes time window.

Report

Juanmamb

14 years ago

Great addition to amaroK. Thanks for it. But for tracks with no ReplayGain information the volume climbs *always* to 100%, so i have much more work changing volume than when i don't use the script :-)

Report

C

maacruz

14 years ago

Hi
It seems you have not read the "README" ;-)
Open the script's configuration dialog and change the "Default Gain" to whatever value you want. I think -6 dB is a good default.

Report

Juanmamb

14 years ago

I did read and i did configure, but I did not explain that, sorry :-)
I tried also -9.0, for fun, and the result is the same.
The problem occurs each time the script works on a track without RG information, which seems to be:
- when starting playing the track
- when starting the script while such track was playing
- when closing the conf. dialog, either with OK or Cancel, while such track is playing
I'm using:
- amaroK 1.3.9 with GStreamer
- replaygain.py v0.9.0-beta2
- python 2.3.5
I think this time i don't forget anything

Report

C

maacruz

14 years ago

Oh! It is the python 2.3 NaN bug. Since nobody complained I thought I had a valid workaround long ago (I have python 2.4 so didn't really tested it).
Try beta4, I think this should work.

Report

jipumarino

14 years ago

Sometimes the script messes with the OSD setting, leaving it disabled. I have not found when this is happening but I suspect it does when I change songs "too fast".

BTW, cool script, I just use it all the time.

Report

C

maacruz

14 years ago

It may happen if you skip songs *very* fast, because the OSD thing may take some time to complete, and if you change the song before it has completed amarok will open OSD in the middle of it messing the OSD settigs.
Just don't change songs too fast.

Report

rwalter

14 years ago

In my opinion the handling of mp3 files is not correct. 'aacgain' sets the gain in the mp3 files itself. The replaygain-tags hold information for undoing the gain change only.

So the replaygain script should only set the volume to the 0 db level plus the pregain.

Report

C

maacruz

14 years ago

You are wrong.
aacgain/mp3gain has two working modes, one is changing the gain inside the file itself (using '-r' or '-a' switches), and the other is tagging. The script uses the tagging mode, if you tag your files using the script you'll have no problem.
If you have applied aacgain yourself modifying the files gain, it still has tagged the files with the small difference between the applied gain and the real replaygain, so the script will work as expected, too.

Report

dasbooter

14 years ago

I cant seem to uncheck the disable peak clipping protection box. I thought maybe I had the pregain adjusted to high so I adjusted that but still cant uncheck disable peak clipping protection. Cant find it in the config files either.

Report

13 years ago

0.1-0.3.3
Old vorbisgain releases

0.5-beta "Reborn"
Major rewriting, now it is python
Renamed to replaygain
Add Album and peak support
New nice pygtk interface
Thanks to Kevin Radloff and Jocke "Firetech" for their suggestions and testing

0.5
Uses the new (since amarok 1.3.2) readConfig dcop calls if available, now the script is aware of amarok configuration changes
Added support for musepack (mpc) files

0.5.5
Added support for AAC (mp4/m4a) files
The script checks for external utilities when closing the configure dialog

0.6 "Clean OSD"
New option to disable osd updates during volume changes solving the annoying quick osd changes
Changed detection of external utilities since mp3gain has different behaviour depending on its version (thanks Jocke for pointing this out)
Settings are reread only when the engine starts playing, not at every song change
Fixed the check for external utilities so it solves the "mp3gain not found" missleading message, and a typo which prevented using aacgain when present.
Fixed flac on latest flac releases (thanks Gary Virta)
Changed the "utility not found" dialog to a less annoying notification
Many optimizations and speedups
Thanks Jocke and Roberto for all your testing

0.6.1
Hotfix: fix script breaking on amarok older than 1.3.2 when osd is disabled

0.7
Many new configuration options, not all can be accesed through the kdialog interface
Clipping protection may be disabled so volume doesn't go to 0 on some broken mp3 files
Pregain (volume reference level) may be adjusted by moving the volume slider
Pregain is now adjusted to tenths of dB instead of integer dB
The volume transitions may be smoothed over any specified amount of time when crossfade is disabled
Accurate timing so crossfaded/smoothed volume changes don't take longer than they should
Pygtk interface now has help as tooltips
Changes in script configuration take effect inmediately instead of waiting till next song
Script configuration is saved when amarok stops playing

0.7.1
Added support for mp3 files tagged with foobar (id3v2 tags), it requires id3v2 installed
SIGTERM handler

0.7.2
Added context menu shortcut to change replaygain mode

0.8.0
Internacionalization. Spanish translation.
New option to set the gain (volume) for files without replaygain info (or unsupported files).
Context menu options to apply/delete replaygain tags to playlist/collection. It is recommended to have python-xml installed for almbum tagging.
Some bugfixes

0.8.1
German, french and hungarian translations

0.8.2
Hotfix: do not break while scanning collection if unsupported file has no album tag.

0.8.3
Fix problems with special shell characters in filenames

0.8.4
Fix breaking if enviroment LANG variable is not set (assumes ISO8859-1 charset)

0.8.5
Fix encoding strings headache caused by gettext not returning unicode strings

0.8.6
Couple of small fixes

0.9.0
This release is designed to reduce lag (thanks Stewie for all your testing). Requires installing kdebindings3-python (aka python-kde) to take advantage of new code. Uses pykde for dcop calls if possible
Finnish GUI translation thanks to Samu Voutilainen
Slovak GUI translation thanks to Jozef Ří­ha
Russian translation thanks to Anton Chumak.
Reworked kdialog interface to fix problems caused by X error messages
Corrects collection scanning if using dynamic collection (patch by Frederic Dinh).
Use mutagen-1.4 library (http://www.sacredchao.net/quodlibet/wiki/Development/Mutagen) to read tags, except on mp4/m4a and mpc. Code for mpc and mp4 tag reading thanks to Justus Pendleton and QuodLibet player (needs ctypes python module). Dropped dependency on external utilities for tag reading.
Added support for RVA2 tags (used by QuodLibet and normalize)
Many bugfixes

0.9.1 Add portuguesse and polish GUI translations, updated finnish translation, thanks to Candido Lopes, Jaroslaw Gorny and Samu Voutilainen.

0.9.2: Add italian and turkish GUI translations. Many thanks to Davide "DuffyDac" and Fatih í‡iroglu

0.9.3: Add swedish GUI and README translation. Many thanks to Göran Jartin

12345678910
1
product-maker LazyKent Dec 09 2010 9 excellent
Be the first to comment
thoughtcrime
Jul 20 2009
File (click to download) Version Description Downloads Date Filesize DL OCS-Install MD5SUM
*Needs pling-store or ocs-url to install things
Pling
0 Affiliates
Details
license
version
1.0.0-beta5
updated Oct 20 2007
added Jul 03 2005
downloads 24h
0
mediaviews 24h 0
pageviews 24h 15
System Tags addon