Amarok/Manual/Various/Moodbar
TODO
Under Construction
The Moodbar
The moodbar officially returns as of Amarok 2.2.2! It shows you the "mood" of a track, which you can then use to figure out when something interesting happens in the song.
In order for Amarok to analyze your music files to create moodbars, you will need the moodbar program (see below for downloads and binary packages). The moodbar package requires gstreamer and various plugins depending on the filetypes you use (see moodbar #Supported Filetypes). You will not need phonon-backend-gstreamer.
The Moodbar of Amarok 2.2.2 has been entirely rewritten. There are two parts to the new moodbar implementation: the moodbar package, which contains a program that takes a music file and generates a .mood file, and support code in the Amarok source, which runs the binary and displays the moodbar. The moodbar package depends on the GStreamer libraries. Without the moodbar package, Amarok cannot generate the moodbars for your music.
The moodbar is as always originally due to Gavin Wood and Simon O'Keefe, who designed the algorithms; their original paper is here. This reimplementation is by QBob. Thanks to gruen0 for good ideas, code, and maintaining the ebuild. Huge props go to dangle for help troubleshooting.
Summary of Requirements
- A version of Amarok with a "Use moods" option in the General section of the configuration screen. This means 1.4.4 or higher in the 1.4 series or 2.2.2 or higher in the 2.x series. You should tick this after you have met the other requirements.
- The Moodbar binary, in your PATH ( it should be listed upon running "which moodbar" from a console) -- Remember to configure the moodbar package with './configure --prefix=`pkg-config --variable=prefix gstreamer-0.10`'
- The GStreamer 0.10 library and plugins for the formats you want moodbar to be able to analyse
- The "Fastest Fourier Transform In The West" (http://www.fftw.org) FFTW library version 3.0 or above (at least single-precision floating point version - libfftw3f) -- Remember to configure the FFTW package with './configure --enable-single'
Usage
Currently moodbars files will have to be generated manually. To do this for your entire collection, use the #Moodbar File Generation Script described below.
To enable the display of moodbars in Amarok, activate it in the configuration (Settings -> Configure Amarok -> General -> Show Moodbar in Progress Slider in 2.2.2). Moodbars should now appear in the track sliders in the player window and the playlist window; there will also be a "mood" field that you may add to your playlist layouts.
Installation
Source Downloads
- Latest release: moodbar-0.1.2.tar.gz -- this is the moodbar source package, which contains the moodbar program (which generates .mood files from music files), and a GStreamer plugin that does the work. The moodbar package needs GStreamer 0.10.* installed, plus the 0.10.* version of various plugins. Be sure to install the moodbar package into the same prefix as GStreamer -- follow the instructions in the INSTALL file.
Please find QBob or gruen0 on IRC and send us a screenshot! If you find any bugs, please submit a bug report at http://bugs.kde.org.
Debian packages
A package for moodbar is now available in Debian unstable. Simply run apt-get install moodbar. You will likely also want to install gstreamer0.10-plugins-ugly, gstreamer0.10-plugins-good, and gstreamer0.10-plugins-bad for format support.
(K)ubuntu packages
A package for moodbar is available in the official package repository, just ensure the universe section is activated (which should be default anyway). Just install the package 'moodbar' with your prefered package manager (Adept, Synaptic). You will likely also want to install gstreamer0.10-plugins-ugly, gstreamer0.10-plugins-good, and gstreamer0.10-plugins-bad for format support.
Or, to install, paste this into firefox or konqueror and hit enter.
apt://moodbar,gstreamer0.10-plugins-ugly,gstreamer0.10-plugins-good,gstreamer0.10-plugins-bad?section=universe?refresh=yep
Gentoo ebuilds
Moodbar is available in Portage, simply emerge moodbar. Unofficial ebuilds are no longer required.
RPM builds
If you are a rpm-based distro user, you can build a .rpm using `rpmbuild` with latest gstreamer-plugins-moodbar.spec. The binary package will be soon available for PLD-linux distro.
Contact vip for help with building rpm.
Fedora
In Fedora 7 and higher (up to 12 as of this writing) moodbar is available in the default repositories. Simply install it with your PackageKit GUI or with the following yum command:
yum install moodbar
openSUSE packages
openSUSE 11.0 and later, automatically install the following packages
- gstreamer-0_10-fluendo-mp3
- gstreamer-0_10-plugins-base
Also, if your songs contain ID3 tags, you must install
- gstreamer-0_10-plugins-good
Moodbar Installation
1-Click Install for openSUSE 11.* - just choose your version and installation procedure will do the rest:
If you are using openSUSE 10.3 you can use the packages available in the repository located at http://software.opensuse.org/download/home:/d7/
To install, add the correct repository for your version of openSUSE to YaST (eg. if you are using openSUSE 10.2, add http://software.opensuse.org/download/home:/d7/openSUSE_10.2/ to the Install Sources in YaST) then make sure the following packages are installed:
- gstreamer-0_10-plugins-good
- gstreamer-0_10-plugins-ugly
- gstreamer-0_10-plugins-moodbar
- mad
For details on how to add repositories, see the openSUSE wiki.
If you are using the Smart software management tool, add the channel by entering the following at the command line, remember to change the URL to match your version of openSUSE: "smart channel --add http://software.opensuse.org/download/home:/d7/openSUSE_10.2/home:d7.repo". Then enter "smart update home:d7". You can now install the required packages by "smart install gstreamer10-plugins-moodbar". Dependencies are resolved automatically.
Mandriva packages
First of all, you need to add PLF repositories, so visit easyurpmi.zarb.org and add them to your repositories list. Then simply install the following packages:
- gstreamer0.10-moodbar
- gstreamer0.10-plugins-ugly
- gstreamer0.10-plugins-good
- gstreamer0.10-plugins-bad
Arch Linux
There is a PKGBUILD for Moodbar in the Arch User Repository (AUR) available here.
For more information about the AUR and working with PKGBUILDs, see the AUR User Guidelines.
FreeBSD
There is a port audio/gstreamer-plugins-moodbar.
To install the port: cd /usr/ports/audio/gstreamer-plugins-moodbar/ && make install clean
To add the package: pkg_add -r gstreamer-plugins-moodbar
Moodbar File Generation Script
There was a handy ruby utility here for creating and managing moodbar files. Unfortunately, the old download link is dead and I was unable to find a copy elsewhere. So, until a better solution comes along, here is a simple bash script that will add .mood files to your entire collection. It adds mood files for all files matching the extensions in the current directory and all subdirectories, so it's best run from the base of your music directory. Now, without further ado:
#!/bin/bash
DIR=${1:-.}
LAST=~/.moodbar-lastreadsong
C_RET=0
control_c() # run if user hits control-c
{
echo "$1" > "$LAST"
echo "Exiting..."
exit
}
if [ -e "$LAST" ]; then
read filetodelete < "$LAST"
rm "$filetodelete" "$LAST"
fi
exec 9< <(find "$DIR" -type f -regextype posix-awk -iregex '.*\.(mp3|ogg|flac|wma)') # you may need to add m4a and mp4
while read i
do
TEMP="${i%.*}.mood"
OUTF=`echo "$TEMP" | sed 's#\(.*\)/\([^,]*\)#\1/.\2#'`
trap 'control_c "$OUTF"' INT
if [ ! -e "$OUTF" ] || [ "$i" -nt "$OUTF" ]; then
moodbar -o "$OUTF" "$i" || { C_RET=1; echo "An error occurred!" >&2; }
fi
done <&9
exec 9<&-
exit $C_RET
Copy and paste the above into a text file named moodbar.sh in your music directory and run the following commands:
cd /path/to/music sh moodbar.sh
Alternatively if the above does not work, you may try:
chmod +x moodbar.sh ./moodbar.sh
This may take a very long time for large collections! Note that the moodbars will not appear in Amarok until Amarok rescans the collection. The generated mood files will be dotfiles (ie, prefixed with a full stop), or hidden files - so keep this in mind if you can't find any generated mood files.
Based on the above script, an alternative for multicore CPUs:
#!/bin/bash
NUMCPU="$(grep ^processor /proc/cpuinfo | wc -l)"
find . -type f -regextype posix-awk -iregex '.*\.(mp3|ogg|flac|wma)' | while read i ; do
if [ `jobs -p | wc -l` -ge $NUMCPU ] ; then
wait
fi
TEMP="${i%.*}.mood"
OUTF=`echo "$TEMP" | sed 's#\(.*\)/\([^,]*\)#\1/.\2#'`
if [ ! -e "$OUTF" ] ; then
moodbar -o "$OUTF" "$i" &
fi
done
TODO: would it be possible to use hidden files (with leading dot) for this, because it would not clubber dir listings that much? Blueyed 18:31, 19 March 2010 (UTC)
TODO: I think this would be a great thing for an Amarok script: the script would look into the playlist and generate the moodbar information/file for the upcoming file(s). However, it seems that Amarok must get told to forget about any loaded meta info, before playing the file / after creating the file. Blueyed 18:31, 19 March 2010 (UTC)
TODO: A copy of that old Ruby Script is found here: http://forum.kde.org/viewtopic.php?f=119&t=84811 - Unfortunately I don't have the Python nor Amarok knowledge to port this to 2.2.2, but it would be great, if it would come back (I loved the feature to store the .mood files outside my collection - I dont want them to clutter all my mp3 folders)
Troubleshooting
- If the moodbar executable gives you a "bus error", that almost always means it can't decode (or can't find) your file. Take a look at the supported file types below for ideas on which GStreamer plugins to install. You can also try the command below to test whether GStreamer can decode your file:
gst-launch filesrc location=[file] ! decodebin ! fakesink
- If you are using the ffmpeg plugin to decode mp3s, you may also receive mysterious bus errors. The solution is to stop using the ffmpeg plugin, as it is extremely buggy -- use mad instead.
- If the moodbar executable tells you that it can't find an element -- i.e, it gives an error message like "Could not create element of type fftwspectrum, please install it." -- that usually means that you either don't have the required plugins installed (see the plugin list here), or that you didn't install the moodbar package in the same prefix as GStreamer. If libmoodbar.so and libgstdecodebin.so are not in the same directory, then moodbar is not installed in the same prefix as GStreamer. Please read the INSTALL file for instructions on how to configure the moodbar package correctly. Alternatively, if you know what you're doing, it may be easier for you to take a look at the GST_PLUGIN_PATH environment variable.
- If you're wondering why the moodbar isn't working, either not working at all or not working for a particular file, run the command below, where [file] is a music file:
moodbar -o test.mood [file]
- If you have multiple versions of GStreamer installed, make sure all of the required plugins are installed for version 0.10.* -- different versions cannot use each other's plugins.
- In Gentoo, the plugin gst-plugins-mad-0.10.3 appears to be broken, which results in a Moodbar which cannot analyze your MP3 files. Emerge gst-plugins-mad-0.10.4 instead to make it work.
Supported Filetypes
You will need various gstreamer plugins to enable moodbar to analyze your files. Here is a list of the plugins you will need; make sure to install the 0.10.* version of each plugin:
- (everything)
- gstreamer-0.10.*, gst-plugins-base, and gst-plugins-good
- mp3
- gst-plugins-mad (in gst-plugins-ugly) -- the ffmpeg plugin has problems, so do not use it for mp3s
- ogg
- gst-plugins-vorbis and gst-plugins-ogg
- flac
- gst-plugins-flac
- mp4
- gst-plugins-faad and gst-plugins-bad
- musepack
- gst-plugins-musepack
- wma
- gst-plugins-ffmpeg
Please correct this list or ping gruen0 if you find this list is incorrect.
Screenshots
