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 - 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
  60 Optional Input Dependencies
  61 ---------------------------
  62
  63 You will need at least one of these to compile MPD.
  64
  65 Most of these are available as packages on major distributions.  Be sure to
  66 install both the library package as well as the development package.
  67
  68 MAD - http://www.underbit.com/products/mad/
  69 For MP3 support.  You will need libmad, and optionally libid3tag if you want
  70 ID3 tag support.
  71
  72 Ogg Vorbis - http://www.xiph.org/ogg/vorbis/
  73 For Ogg Vorbis support.  You will need libogg and libvorbis.
  74
  75 FLAC - http://flac.sourceforge.net/
  76 For FLAC support.  You will need version 1.1.0 or higher of libflac.
  77
  78 OggFLAC - http://www.xiph.org/ogg/vorbis/ and http://flac.sourceforge.net/
  79 For OggFLAC support.  You will need liboggflac, which can be built from the
  80 FLAC sources if libogg is already installed.  Versions of flac 1.1.3 and
  81 greater will automatically detect and use OggFLAC if it's available.
  82
  83 Audio File - http://www.68k.org/~michael/audiofile/
  84 For WAVE, AIFF, and AU support.  You will need libaudiofile.
  85
  86 FAAD2 - http://www.audiocoding.com/
  87 For MP4/AAC support.  You will need libmp4ff.
  88
  89 libmpcdec - http://www.musepack.net/
  90 For Musepack support.
  91
  92 MikMod - http://mikmod.raphnet.net/
  93 For MOD support.  You will need libmikmod.
  94
  95 libavcodec, libavformat (ffmpeg) - http://ffmpeg.mplayerhq.hu/
  96 Multi-codec library.
  97
  98 libsidplay2 - http://sidplay2.sourceforge.net/
  99 For C64 SID support.
 100
 101 libfluidsynth - http://fluidsynth.resonance.org/
 102 For MIDI support.
 103
 104 libwildmidi - http://wildmidi.sourceforge.net/
 105 For MIDI support.
 106
 107
 108 Optional Miscellaneous Dependencies
 109 -----------------------------------
 110
 111 Avahi - http://www.avahi.org/
 112 For Zeroconf support.
 113
 114 libsamplerate - http://www.mega-nerd.com/SRC/
 115 For advanced samplerate conversions.
 116
 117 libcurl - http://curl.haxx.se/
 118 For playing HTTP streams.
 119
 120 libmms - https://launchpad.net/libmms
 121 For playing MMS streams.
 122
 123
 124 pkg-config
 125 ----------
 126
 127 MPD uses pkg-config to locate most external libraries.  If you do not
 128 have pkg-config, or if your version of the library does not ship the
 129 ".pc" file, you have to provide the library's build options in
 130 environment variables.  These variables are documented in "./configure
 131 --help".  Example:
 132
 133  FLAC_CFLAGS=-I/usr/include/FLAC FLAC_LIBS=-lFLAC ./configure
 134
 135
 136 Download
 137 --------
 138
 139 Get the latest release from of MPD from <http://www.musicpd.org/>.
 140
 141 Compile
 142 -------
 143
 144 1) unzip and untar the archive
 145
 146 $ tar zxvf mpd-x.x.x.tar.gz
 147
 148 or
 149
 150 $ tar jxvf mpd-x.x.x.tar.bz2
 151
 152 2) change to directory created
 153
 154 $ cd mpd-x.x.x
 155
 156 3) Run configure script (this will determine what dependencies you have)
 157
 158 $ ./configure
 159
 160 4) Compile
 161
 162 $ make
 163
 164 Install (Optional)
 165 -------
 166
 167 (as root)
 168 $ make install
 169
 170 Run
 171 ---
 172
 173 1) run mpd:
 174
 175 $ mpd <config file>
 176
 177 First default is ~/.mpdconf then ~/.mpd/mpd.conf then /etc/mpd.conf. If
 178 neither of these exist a mpd configuration file must be specified at
 179 runtime.
 180
 181 A sample config file is included with the source of MPD, mpdconf.example.
 182
 183 The first time MPD is run it will attempt to discover all music in your
 184 music root, recursively. This can be affected by the symbolic link
 185 options specified in the example mpd.conf.
 186
 187 Using MPD
 188 ---------
 189
 190 You can download many different interfaces for MPD at
 191         <http://mpd.wikia.com/wiki/Clients>
 192
 193 MPD can be interfaced directly using telnet (see COMMANDS, if you are brave).