Amarok, the powerful music player that lets you rediscover your music.
Clone or download
l10n daemon script
Latest commit 564bcba Nov 16, 2018
Permalink
Failed to load latest commit information.
HACKING Make gmock an optional dependency. Tests are built if gmock is found. May 5, 2018
cmake Fix a typo in FindMySQL.cmake and add leniency for libmysqld on windows Sep 28, 2018
data SVN_SILENT made messages (.desktop file) - always resolve ours Nov 13, 2018
doc Sync the docs with UserBase May 21, 2018
images Reactivate wikipedia applet Mar 20, 2018
playground Fix minor EBN issues Oct 28, 2018
release_scripts RELEASE_HOWTO: Update it a bit Mar 6, 2018
shared Increment version Sep 28, 2018
src GIT_SILENT made messages (after extraction) Nov 16, 2018
supplementary_scripts Fix minor EBN issues Oct 28, 2018
tests Fix minor EBN issues Oct 28, 2018
utilities Declare constructors with one parameter explicit Mar 20, 2018
.arcconfig add .arcconfig Feb 20, 2018
.gitignore add .arcconfig Feb 20, 2018
.krazy Update krazy file Mar 15, 2009
AUTHORS Sync handbook with current authors list. Jun 30, 2013
CMakeLists.txt Initialize KCrash Sep 28, 2018
COPYING fix FSF address Nov 8, 2007
COPYING.DOC update for new licence policy Jan 12, 2008
COPYING.LIB update for new licence policy Jan 12, 2008
CTestConfig.cmake Added initial support for CTest and CDash testing. Jan 29, 2010
ChangeLog Fix crash during musicbrainz search. Aug 20, 2017
INSTALL INSTALL: Update link, use https Mar 20, 2018
MAINTAINERS Update wiki links Jan 19, 2013
Mainpage.dox Sync handbook with current authors list. Jun 30, 2013
Messages.sh Fix message extraction for amarokcollectionscanner_qt Mar 7, 2018
README Removed last references to clamz May 28, 2018
TODO remove link to stale wiki page, add bugs link. better than nothing :) Dec 14, 2009
amarok.kdev4 Add KDevelop4 project file again (why was this removed?) Feb 28, 2010

README

Amarok - the audio player for KDE
===================================

There are many media players around these days, it's true. What's missing from most
players is a user interface that doesn't get in the way of the user. How many
buttons do you have to press for simply adding some new tracks to the playlist?
Amarok tries to be a little different, providing a simple drag and drop interface
that really makes playlist handling easy.


 FEATURES
==========

    * Quick and simple drag and drop playlist creation
    * Music library
    * Cross platform: Support for Unix, MacOS X and Windows
    * Plays all audio formats known to man
    * Cover art download using Last.fm services
    * Automatic play-statistics generation (iRate style)
    * Full lyrics download
    * Learn about your music with integrated Wikipedia
    * Full Last.fm support
    * gpodder.net support
    * Configurable on screen display for track changes
    * Podcast support
    * iPod support, as well as other media players
    * Powerful scripting interface
    * Integration with Plasma and KDE Applications
    * Integration with multiple web sources including Magnatune, Jamendo,
      Ampache, MP3tunes, and others.
--------------------------------------------------------------------------------


 DEPENDENCIES
==============

The following list should give you an impression what's required but it might
not be entirely up to date. You can always look at CMakeLists.txt to discover
the most recent dependencies.

Required
    * KDE Frameworks 5 (for an exact list look at CMakeLists.txt)
      https://www.kde.org

    * Phonon 4.6.60 (with support for Qt5) and one of the following backends:
      * phonon-gstreamer 4.6.3 (or newer)
      * phonon-vlc 0.6.1 (or newer; as of 0.6.1 doesn't yet play Audio CDs, bug 313046)

    * Qt 5.8 (or newer)
      https://qt.io/

    * TagLib 1.7 (or newer)
      (Metadata tagging library)

    * TagLib Extras 1.0.1 (or newer)
      (Support for metadata reading of additional file types)
      svn://anonsvn.kde.org/home/kde/trunk/kdesupport/taglib-extras

    * MySQL 5.0 (or newer) Embedded: libmysqld compiled with fPIC
      (In-process database support)

Optional
    * Taglib 1.8 for support of MOD, IT, S3M and XM files
    * Taglib 1.9 for support of Opus files
      http://taglib.org/
      https://github.com/taglib/taglib

    * iPod support requires:
      * libgpod 0.8.2 (or newer)
        http://www.gtkpod.org/libgpod/
      * optional iPod album artwork support requires:
        * libgpod built with GDKPixBuf support enabled
        * GDKPixBuf 2.0 (or newer) itself

    * libmtp 1.0.0 (or newer)
      (MTP device support)
      http://libmtp.sourceforge.net/

    * Spectrum analyzer requires:
      * QtOpenGL

    * Mp3tunes.com integration (including syncronization) requires:
      * OpenSSL https://www.openssl.org
      * libxml2 http://xmlsoft.org
      * libcurl https://curl.haxx.se
      * Glib2 https://www.gtk.org
      * Loudmouth, the Jabber library, http://www.loudmouth-project.org/
      * Qt must be compiled with Glib enabled

    * Liblastfm 1.0.3 (or newer)
      (For scrobbling, internet radio, and artist info)
      http://cdn.last.fm/client/liblastfm-1.0.3.tar.gz
      https://github.com/eartle/liblastfm

    * MySQL 5.0 (or newer) Server (external database support)

    * MusicBrainz-based audio fingerprint tag lookup requires:
      * FFmpeg 0.7.0 (or newer) - https://ffmpeg.org/
        * libavcodec & libavformat specifically
      * LibOFA - http://code.google.com/p/musicip-libofa/

    * gpodder.net Podcast Provider & Service
      * libmygpo-qt 1.0.9 (or newer)
         Actually it needs the to-be-released 1.10. Or you use 1.0.9 and add the
         patches from the following pull requests:
         - https://github.com/gpodder/libmygpo-qt/pull/12
         - https://github.com/gpodder/libmygpo-qt/pull/13

    * Transcoding requires (at runtime):
      * FFmpeg 0.7.0 (or newer) - https://ffmpeg.org/
      * For all supported encoders to be available in Amarok, FFmpeg needs to
        support the following codecs:
        * aac (introduced in 3.0, https://www.ffmpeg.org/index.html#aac_encoder_stable)
        * alac
        * flac
        * opus
        * libmp3lame (NOT just "mp3")
        * libvorbis (NOT just "vorbis")
        * wmav2

    * CD support requires:
      * audiocd-kio - https://www.kde.org/ (part of KDE multimedia)

    * Building tests require:
      * gmock 1.4 (or newer) - https://github.com/google/googletest

Please note that if compiling from source you also need to install -dev/-devel
versions of these packages, depending on your distribution.
--------------------------------------------------------------------------------


 IMPORTANT INSTALL INSTRUCTIONS
================================

To compile from source, please refer to the INSTALL file.

Packages for popular distributions are available at https://amarok.kde.org
--------------------------------------------------------------------------------


 FURTHER RESOURCES
===================

For answers to problems like "Amarok won't play any MP3s!" and "My MP3s skip
and stutter!" please visit:

   https://amarok.kde.org/
--------------------------------------------------------------------------------


 CONTRIBUTING
==============

If you wish to contribute to Amarok, you should build it from Git and subscribe
to the amarok AT kde.org mailing list. The IRC channel is also a place where
it's nice to be. There you can talk to other developers easily, and you can see
instant notifications of commits to the Git master repository. For instant email
notification of commits, visit http://commitfilter.kde.org/ , and http://amarok.be/fisheye
provides a slightly-less-instant overview.

More information at:
https://community.kde.org/Amarok/Development/Join

See you on IRC!

--------------------------------------------------------------------------------

WWW:  https://amarok.kde.org
MAIL: amarok@kde.org
IRC:  irc.freenode.net - #amarok, #amarok.de, #amarok.es, #amarok.fr