INSTALL

   1                        Music Player Daemon (MPD) - INSTALL
   2
   3
   4 Introduction
   5 ------------
   6 This document is a very small amount of documentation about what is needed to
   7 install MPD. If more information is desired see the community wiki at
   8 http://mpd.wikia.com.
   9
  10 Dependencies
  11 ------------
  12
  13 gcc - http://gcc.gnu.org/
  14 Any other C99 compliant compiler should also work.
  15
  16 GLib 2.12 - http://www.gtk.org/
  17 General-purpose utility library.
  18
  19
  20 Optional Output Dependencies
  21 ----------------------------
  22
  23 You will need at least one of these to compile MPD.
  24
  25 Most of these are available as packages on major distributions.  Be sure to
  26 install both the library package as well as the development package.
  27
  28 AO - http://www.xiph.org/ao/
  29 A portable library that abstracts many audio output types as one API.  Should
  30 be used only if there is no native plugin available or if the native plugin
  31 doesn't work.  You will need libao.
  32
  33 ALSA - http://www.alsa-project.org/
  34 The Advanced Linux Sound Architecture.  Recommended audio output if you use
  35 Linux.  You will need libasound.
  36
  37 FIFO
  38 This is a mostly undocumented, developer plugin to transmit raw data.
  39
  40 MVP - http://en.wikipedia.org/wiki/Hauppauge_MediaMVP
  41 A network media player.
  42
  43 OSS - http://www.opensound.com
  44 Open Sound System.
  45
  46 OSX - http://www.apple.com
  47 Necessary if you are on Mac OSX.
  48
  49 PulseAudio - http://www.pulseaudio.org/
  50 An advanced sound daemon.  You will need libpulse.
  51
  52 JACK - http://www.jackaudio.org/
  53 A low-latency sound daemon.
  54
  55 libshout - http://www.icecast.org/
  56 For streaming to an Icecast or Shoutcast server.
  57 You also need an encoder: either libvorbisenc (ogg), or liblame (mp3).
  58
  59 OpenAL - http://kcat.strangesoft.net/openal.html
  60 Open Audio Library
  61
  62
  63 Optional Input Dependencies
  64 ---------------------------
  65
  66 You will need at least one of these to compile MPD.
  67
  68 Most of these are available as packages on major distributions.  Be sure to
  69 install both the library package as well as the development package.
  70
  71 MAD - http://www.underbit.com/products/mad/
  72 For MP3 support.  You will need libmad, and optionally libid3tag if you want
  73 ID3 tag support.
  74
  75 libmpg123 - http://www.mpg123.de/
  76 Alternative for MP3 support.
  77
  78 Ogg Vorbis - http://www.xiph.org/ogg/vorbis/
  79 For Ogg Vorbis support.  You will need libogg and libvorbis.
  80
  81 FLAC - http://flac.sourceforge.net/
  82 For FLAC support.  You will need version 1.1.0 or higher of libflac.
  83
  84 OggFLAC - http://www.xiph.org/ogg/vorbis/ and http://flac.sourceforge.net/
  85 For OggFLAC support.  You will need liboggflac, which can be built from the
  86 FLAC sources if libogg is already installed.  Versions of flac 1.1.3 and
  87 greater will automatically detect and use OggFLAC if it's available.
  88
  89 Audio File - http://www.68k.org/~michael/audiofile/
  90 For WAVE, AIFF, and AU support.  You will need libaudiofile.
  91
  92 FAAD2 - http://www.audiocoding.com/
  93 For MP4/AAC support.  You will need libmp4ff.
  94
  95 libmpcdec - http://www.musepack.net/
  96 For Musepack support.
  97
  98 MikMod - http://mikmod.raphnet.net/
  99 For MOD support.  You will need libmikmod.
 100
 101 libavcodec, libavformat (ffmpeg) - http://ffmpeg.mplayerhq.hu/
 102 Multi-codec library.
 103
 104 libsidplay2 - http://sidplay2.sourceforge.net/
 105 For C64 SID support.
 106
 107 libfluidsynth - http://fluidsynth.resonance.org/
 108 For MIDI support (DO NOT USE - use libwildmidi instead)
 109
 110 libwildmidi - http://wildmidi.sourceforge.net/
 111 For MIDI support.
 112
 113 libsndfile - http://www.mega-nerd.com/libsndfile/
 114 WAVE, AIFF, and many others.
 115
 116 libwavpack - http://www.wavpack.com/
 117 For WavPack playback.
 118
 119
 120 Optional Miscellaneous Dependencies
 121 -----------------------------------
 122
 123 Avahi - http://www.avahi.org/
 124 For Zeroconf support.
 125
 126 libsamplerate - http://www.mega-nerd.com/SRC/
 127 For advanced samplerate conversions.
 128
 129 libcurl - http://curl.haxx.se/
 130 For playing HTTP streams.
 131
 132 libmms - https://launchpad.net/libmms
 133 For playing MMS streams.
 134
 135 SQLite - http://www.sqlite.org/
 136 For the sticker database.
 137
 138 libcue - http://libcue.sourceforge.net/
 139 For CUE sheet support.
 140
 141
 142 pkg-config
 143 ----------
 144
 145 MPD uses pkg-config to locate most external libraries.  If you do not
 146 have pkg-config, or if your version of the library does not ship the
 147 ".pc" file, you have to provide the library's build options in
 148 environment variables.  These variables are documented in "./configure
 149 --help".  Example:
 150
 151  FLAC_CFLAGS=-I/usr/include/FLAC FLAC_LIBS=-lFLAC ./configure
 152
 153
 154 Download
 155 --------
 156
 157 Get the latest release from of MPD from <http://www.musicpd.org/>.
 158
 159 Compile
 160 -------
 161
 162 1) unzip and untar the archive
 163
 164 $ tar zxvf mpd-x.x.x.tar.gz
 165
 166 or
 167
 168 $ tar jxvf mpd-x.x.x.tar.bz2
 169
 170 2) change to directory created
 171
 172 $ cd mpd-x.x.x
 173
 174 3) Run configure script (this will determine what dependencies you have)
 175
 176 $ ./configure
 177
 178 4) Compile
 179
 180 $ make
 181
 182 Install (Optional)
 183 -------
 184
 185 (as root)
 186 $ make install
 187
 188 Run
 189 ---
 190
 191 1) run mpd:
 192
 193 $ mpd <config file>
 194
 195 First default is ~/.mpdconf then ~/.mpd/mpd.conf then /etc/mpd.conf. If
 196 neither of these exist a mpd configuration file must be specified at
 197 runtime.
 198
 199 A sample config file is included with the source of MPD, mpdconf.example.
 200
 201 The first time MPD is run it will attempt to discover all music in your
 202 music root, recursively. This can be affected by the symbolic link
 203 options specified in the example mpd.conf.
 204
 205 Using MPD
 206 ---------
 207
 208 You can download many different interfaces for MPD at
 209         <http://mpd.wikia.com/wiki/Clients>
 210
 211 MPD can be interfaced directly using telnet (see COMMANDS, if you are brave).