You need to sign in or sign up before continuing.
user.rst 42.9 KB
Newer Older
1 2
User's Manual
#############
3

4 5
Introduction
************
6 7 8 9 10

Music Player Daemon (:program:`MPD`) is a flexible, powerful, server-side application for playing music. Through plugins and libraries it can play a variety of sound files while being controlled by its network protocol.

This document is work in progress. Most of it may be incomplete yet. Please help!

11 12
Installation
************
13 14 15 16

Installing on Debian/Ubuntu
---------------------------

17
Install the package :file:`mpd` via :program:`apt`:
18

19
.. code-block:: none
20

21
    apt install mpd
22 23 24

When installed this way, :program:`MPD` by default looks for music in :file:`/var/lib/mpd/music/`; this may not be correct. Look at your :file:`/etc/mpd.conf` file... 

25 26 27 28 29 30 31 32 33
.. note::

   Debian and Ubuntu are infamous for shipping heavily outdated
   software.  The :program:`MPD` version in their respective stable
   releases are usually too old to be supported by this project.
   Ironically, the :program:`MPD` version in Debian "*unstable*" is
   more stable than the version in Debian "*stable*".


34 35 36 37 38 39 40
Installing on Android
---------------------

An experimental Android build is available on Google Play. After installing and launching it, :program:`MPD` will scan the music in your Music directory and you can control it as usual with a :program:`MPD` client.

If you need to tweak the configuration, you can create a file called :file:`mpd.conf` on the data partition (the directory which is returned by Android's :dfn:`getExternalStorageDirectory()` API function). 

41 42 43
ALSA is not available on Android; only the :ref:`OpenSL ES
<sles_output>` output plugin can be used for local playback.

44 45 46
Compiling from source
---------------------

47 48 49
`Download the source tarball <https://www.musicpd.org/download.html>`_
and unpack it (or `clone the git repository
<https://github.com/MusicPlayerDaemon/MPD>`_):
50

51
.. code-block:: none
52 53 54 55 56 57

    tar xf mpd-version.tar.xz
    cd mpd-version

In any case, you need:

58
* a C++17 compiler (e.g. GCC 8 or clang 5)
59
* `Meson 0.49.0 <http://mesonbuild.com/>`__ and `Ninja
60
  <https://ninja-build.org/>`__
61 62 63
* Boost 1.58
* pkg-config 

64 65
Each plugin usually needs a codec library, which you also need to
install. Check the :doc:`plugins` for details about required libraries
66

67
For example, the following installs a fairly complete list of build dependencies on Debian Buster:
68

69
.. code-block:: none
70

71
    apt install meson g++ \
72
      libpcre3-dev \
73
      libmad0-dev libmpg123-dev libid3tag0-dev \
74
      libflac-dev libvorbis-dev libopus-dev libogg-dev \
75
      libadplug-dev libaudiofile-dev libsndfile1-dev libfaad-dev \
76
      libfluidsynth-dev libgme-dev libmikmod-dev libmodplug-dev \
77 78 79 80 81 82 83 84 85
      libmpcdec-dev libwavpack-dev libwildmidi-dev \
      libsidplay2-dev libsidutils-dev libresid-builder-dev \
      libavcodec-dev libavformat-dev \
      libmp3lame-dev libtwolame-dev libshine-dev \
      libsamplerate0-dev libsoxr-dev \
      libbz2-dev libcdio-paranoia-dev libiso9660-dev libmms-dev \
      libzzip-dev \
      libcurl4-gnutls-dev libyajl-dev libexpat-dev \
      libasound2-dev libao-dev libjack-jackd2-dev libopenal-dev \
Max Kellermann's avatar
Max Kellermann committed
86
      libpulse-dev libshout3-dev \
87 88
      libsndio-dev \
      libmpdclient-dev \
89
      libnfs-dev \
90 91 92
      libupnp-dev \
      libavahi-client-dev \
      libsqlite3-dev \
93
      libsystemd-dev \
94
      libgtest-dev \
95
      libboost-dev \
96 97 98
      libicu-dev \
      libchromaprint-dev \
      libgcrypt20-dev
99 100 101 102
      

Now configure the source tree:

103
.. code-block:: none
104

iamsi's avatar
iamsi committed
105
 meson . output/release --buildtype=debugoptimized -Db_ndebug=true
106

107
The following command shows a list of compile-time options:
108

109
.. code-block:: none
110

111 112 113 114 115 116 117
 meson configure output/release

When everything is ready and configured, compile:

.. code-block:: none

 ninja -C output/release
118 119 120

And install:

121
.. code-block:: none
122

123
 ninja -C output/release install
124 125 126 127 128 129

Compiling for Windows
---------------------

Even though it does not "feel" like a Windows application, :program:`MPD` works well under Windows. Its build process follows the "Linux style" and may seem awkward for Windows people (who are not used to compiling their software, anyway).

130
Basically, there are two ways to compile :program:`MPD` for Windows:
131

132 133 134
* Build as described above: with :program:`meson` and
  :program:`ninja`.  To cross-compile from Linux, you need `a Meson
  cross file <https://mesonbuild.com/Cross-compilation.html>`__.
135

136 137 138
  The remaining difficulty is installing all the external libraries.
  And :program:`MPD` usually needs many, making this method cumbersome
  for the casual user.
139 140 141 142 143

* Build on Linux for Windows using :program:`MPD`'s library build script. 

This section is about the latter.

144 145 146
Just like with the native build, unpack the :program:`MPD` source
tarball and change into the directory.  Then, instead of
:program:`meson`, type:
147

148
.. code-block:: none
149

150 151 152
 mkdir -p output/win64
 cd output/win64
 ../../win32/build.py --64
153

154 155 156 157 158 159 160
This downloads various library sources, and then configures and builds
:program:`MPD` (for x64; to build a 32 bit binary, pass
:code:`--32`). The resulting EXE files is linked statically, i.e. it
contains all the libraries already and you do not need carry DLLs
around. It is large, but easy to use. If you wish to have a small
mpd.exe with DLLs, you need to compile manually, without the
:file:`build.py` script.
161 162 163 164 165 166 167 168 169

Compiling for Android
---------------------

:program:`MPD` can be compiled as an Android app. It can be installed easily with Google Play, but if you want to build it from source, follow this section.

You need:

* Android SDK
170
* `Android NDK r22 <https://developer.android.com/ndk/downloads>`_
171

172 173 174
Just like with the native build, unpack the :program:`MPD` source
tarball and change into the directory.  Then, instead of
:program:`meson`, type:
175

176
.. code-block:: none
177

178 179 180 181 182
 mkdir -p output/android
 cd output/android
 ../../android/build.py SDK_PATH NDK_PATH ABI
 meson configure -Dandroid_debug_keystore=$HOME/.android/debug.keystore
 ninja android/apk/mpd-debug.apk
183

184 185 186
:envvar:`SDK_PATH` is the absolute path where you installed the
Android SDK; :envvar:`NDK_PATH` is the Android NDK installation path;
ABI is the Android ABI to be built, e.g. ":code:`arm64-v8a`".
187 188 189

This downloads various library sources, and then configures and builds :program:`MPD`. 

190 191
Configuration
*************
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207

The Configuration File
----------------------

:program:`MPD` reads its configuration from a text file. Usually, that is :file:`/etc/mpd.conf`, unless a different path is specified on the command line. If you run :program:`MPD` as a user daemon (and not as a system daemon), the configuration is read from :file:`$XDG_CONFIG_HOME/mpd/mpd.conf` (usually :file:`~/.config/mpd/mpd.conf`). On Android, :file:`mpd.conf` will be loaded from the top-level directory of the data partition.

Each line in the configuration file contains a setting name and its value, e.g.:

:code:`connection_timeout "5"`

For settings which specify a filesystem path, the tilde is expanded:

:code:`music_directory "~/Music"`

Some of the settings are grouped in blocks with curly braces, e.g. per-plugin settings:

208
.. code-block:: none
209 210 211 212 213 214 215 216

    audio_output {
        type "alsa"
        name "My ALSA output"
        device "iec958:CARD=Intel,DEV=0"
        mixer_control "PCM"
    }

217 218
The :code:`include` directive can be used to include settings from
another file; the given file name is relative to the current file:
219

220
.. code-block:: none
221 222

  include "other.conf"
223

224 225 226 227 228 229 230
You can use :code:`include_optional` instead if you want the included file
to be optional; the directive will be ignored if the file does not exist:

.. code-block:: none

  include_optional "may_not_exist.conf"

231 232 233 234 235 236 237
Configuring the music directory
-------------------------------

When you play local files, you should organize them within a directory called the "music directory". This is configured in :program:`MPD` with the music_directory setting.

By default, :program:`MPD` follows symbolic links in the music directory. This behavior can be switched off: :code:`follow_outside_symlinks` controls whether :program:`MPD` follows links pointing to files outside of the music directory, and :code:`follow_inside_symlinks` lets you disable symlinks to files inside the music directory.

238 239 240 241 242
Instead of using local files, you can use storage plugins to access
files on a remote file server. For example, to use music from the
SMB/CIFS server ":file:`myfileserver`" on the share called "Music",
configure the music directory ":file:`smb://myfileserver/Music`". For
a recipe, read the Satellite :program:`MPD` section :ref:`satellite`.
243 244 245 246 247 248

You can also use multiple storage plugins to assemble a virtual music directory consisting of multiple storages. 

Configuring database plugins
----------------------------

249 250 251
If a music directory is configured, one database plugin is used. To
configure this plugin, add a :code:`database` block to
:file:`mpd.conf`:
252

253
.. code-block:: none
254 255 256 257 258 259

    database {
        plugin "simple"
        path "/var/lib/mpd/db"
    }
    
260 261
More information can be found in the :ref:`database_plugins`
reference.
262 263 264 265

Configuring neighbor plugins
----------------------------

266 267 268
All neighbor plugins are disabled by default to avoid unwanted
overhead. To enable (and configure) a plugin, add a :code:`neighbor`
block to :file:`mpd.conf`:
269

270
.. code-block:: none
271 272 273 274 275

    neighbors {
        plugin "smbclient"
    }
      
276
More information can be found in the :ref:`neighbor_plugin` reference.
277 278 279 280

Configuring input plugins
-------------------------

281 282
To configure an input plugin, add an :code:`input` block to
:file:`mpd.conf`:
283

284
.. code-block:: none
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304

    input {
        plugin "curl"
        proxy "proxy.local"
    }
      

The following table lists the input options valid for all plugins:

.. list-table::
   :widths: 20 80
   :header-rows: 1

   * - Name
     - Description
   * - **plugin**
     - The name of the plugin
   * - **enabled yes|no**
     - Allows you to disable a input plugin without recompiling. By default, all plugins are enabled.

305
More information can be found in the :ref:`input_plugins` reference.
306

307 308
.. _input_cache:

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
Configuring the Input Cache
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The input cache prefetches queued song files before they are going to
be played.  This has several advantages:

- risk of buffer underruns during playback is reduced because this
  decouples playback from disk (or network) I/O
- bulk transfers may be faster and more energy efficient than loading
  small chunks on-the-fly
- by prefetching several songs at a time, the hard disk can spin down
  for longer periods of time

This comes at a cost:

- memory usage
- bulk transfers may reduce the performance of other applications
  which also want to access the disk (if the kernel's I/O scheduler
  isn't doing its job properly)

To enable the input cache, add an ``input_cache`` block to the
configuration file:

.. code-block:: none

    input_cache {
        size "1 GB"
    }

This allocates a cache of 1 GB.  If the cache grows larger than that,
older files will be evicted.

341
You can flush the cache at any time by sending ``SIGHUP`` to the
342 343
:program:`MPD` process, see :ref:`signals`.

344

345 346 347
Configuring decoder plugins
---------------------------

348 349
Most decoder plugins do not need any special configuration. To
configure a decoder, add a :code:`decoder` block to :file:`mpd.conf`:
350

351
.. code-block:: none
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370

    decoder {
        plugin "wildmidi"
        config_file "/etc/timidity/timidity.cfg"
    }
      
The following table lists the decoder options valid for all plugins:

.. list-table::
   :widths: 20 80
   :header-rows: 1

   * - Name
     - Description
   * - **plugin**
     - The name of the plugin
   * - **enabled yes|no**
     - Allows you to disable a decoder plugin without recompiling. By default, all plugins are enabled.

371
More information can be found in the :ref:`decoder_plugins` reference.
372 373 374 375

Configuring encoder plugins
---------------------------

376 377
Encoders are used by some of the output plugins (such as shout). The
encoder settings are included in the ``audio_output`` section, see :ref:`config_audio_output`.
378

379
More information can be found in the :ref:`encoder_plugins` reference.
380

381 382 383

.. _config_audio_output:

384 385 386 387 388
Configuring audio outputs
-------------------------

Audio outputs are devices which actually play the audio chunks produced by :program:`MPD`. You can configure any number of audio output devices, but there must be at least one. If none is configured, :program:`MPD` attempts to auto-detect. Usually, this works quite well with ALSA, OSS and on Mac OS X.

389 390
To configure an audio output manually, add one or more
:code:`audio_output` blocks to :file:`mpd.conf`:
391

392
.. code-block:: none
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412

    audio_output {
        type "alsa"
        name "my ALSA device"
        device "hw:0"
    }

The following table lists the audio_output options valid for all plugins:


.. list-table::
   :widths: 20 80
   :header-rows: 1

   * - Name
     - Description
   * - **type**
     - The name of the plugin
   * - **name**
     - The name of the audio output. It is visible to the client. Some plugins also use it internally, e.g. as a name registered in the PULSE server.
413 414 415
   * - **format samplerate:bits:channels**
     -  Always open the audio output with the specified audio format, regardless of the format of the input file. This is optional for most plugins.
        See :ref:`audio_output_format` for a detailed description of the value.
416
   * - **enabled yes|no**
417 418 419 420 421 422
     - Specifies whether this audio output is enabled when :program:`MPD` is started. By default, all audio outputs are enabled. This is just the default setting when there is no state file; with a state file, the previous state is restored.
   * - **tags yes|no**
     - If set to no, then :program:`MPD` will not send tags to this output. This is only useful for output plugins that can receive tags, for example the httpd output plugin.
   * - **always_on yes|no**
     - If set to yes, then :program:`MPD` attempts to keep this audio output always open. This may be useful for streaming servers, when you don't want to disconnect all listeners even when playback is accidentally stopped.
   * - **mixer_type hardware|software|null|none**
423 424 425 426 427
     - Specifies which mixer should be used for this audio output: the
       hardware mixer (available for ALSA :ref:`alsa_plugin`, OSS
       :ref:`oss_plugin` and PulseAudio :ref:`pulse_plugin`), the
       software mixer, the ":samp:`null`" mixer (allows setting the
       volume, but with no effect; this can be used as a trick to
428
       implement an external mixer, see :ref:`external_mixer`) or no mixer
429 430
       (:samp:`none`). By default, the hardware mixer is used for
       devices which support it, and none for the others.
431 432 433 434
   * - **filters "name,...**"
     - The specified configured filters are instantiated in the given
       order.  Each filter name refers to a ``filter`` block, see
       :ref:`config_filter`.
435

436 437
More information can be found in the :ref:`output_plugins` reference.

438 439 440

.. _config_filter:

441 442 443 444 445
Configuring filters
-------------------

Filters are plugins which modify an audio stream.

446
To configure a filter, add a :code:`filter` block to :file:`mpd.conf`:
447

448
.. code-block:: none
449 450 451 452 453 454

    filter {
        plugin "volume"
        name "software volume"
    }

455 456 457
Configured filters may then be added to the ``filters`` setting of an
``audio_output`` section, see :ref:`config_audio_output`.

458 459 460 461 462 463 464 465 466 467 468 469 470
The following table lists the filter options valid for all plugins:

.. list-table::
   :widths: 20 80
   :header-rows: 1

   * - Name
     - Description
   * - **plugin**
     - The name of the plugin
   * - **name**
     - The name of the filter

471 472 473
More information can be found in the :ref:`filter_plugins` reference.


474 475 476
Configuring playlist plugins
----------------------------

477 478 479
Playlist plugins are used to load remote playlists (protocol commands
load, listplaylist and listplaylistinfo). This is not related to
:program:`MPD`'s :ref:`playlist directory <stored_playlists>`.
480

481 482
To configure a playlist plugin, add a :code:`playlist_plugin` block to
:file:`mpd.conf`:
483

484
.. code-block:: none
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502

    playlist_plugin {
        name "m3u"
        enabled "true"
    }

The following table lists the playlist_plugin options valid for all plugins:

.. list-table::
   :widths: 20 80
   :header-rows: 1

   * - Name
     - Description
   * - **plugin**
     - The name of the plugin
   * - **enabled yes|no**
     - Allows you to disable a playlist plugin without recompiling. By default, all plugins are enabled.
503 504 505 506 507
   * - **as_directory yes|no**
     - With this option, a playlist file of this type is parsed during
       database update and converted to a virtual directory, allowing
       MPD clients to access individual entries.  By default, this is
       only enabled for the :ref:`cue plugin <cue_playlist>`.
508

509 510
More information can be found in the :ref:`playlist_plugins`
reference.
511 512 513 514

Audio Format Settings
---------------------

515 516
.. _audio_output_format:

517
Global Audio Format
518
^^^^^^^^^^^^^^^^^^^
519

520 521
The setting ``audio_output_format`` forces :program:`MPD` to use one
audio format for all outputs.  Doing that is usually not a good idea.
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539

The value is specified as ``samplerate:bits:channels``.

Any of the three attributes may be an asterisk to specify that this
attribute should not be enforced, example: ``48000:16:*``.
``*:*:*`` is equal to not having a format specification.

The following values are valid for bits: ``8`` (signed 8 bit integer
samples), ``16``, ``24`` (signed 24 bit integer samples padded to 32
bit), ``32`` (signed 32 bit integer samples), ``f`` (32 bit floating
point, -1.0 to 1.0), ``dsd`` means DSD (Direct Stream Digital). For
DSD, there are special cases such as ``dsd64``, which allows you to
omit the sample rate (e.g. ``dsd512:2`` for stereo DSD512,
i.e. 22.5792 MHz).

The sample rate is special for DSD: :program:`MPD` counts the number
of bytes, not bits. Thus, a DSD "bit" rate of 22.5792 MHz (DSD512) is
2822400 from :program:`MPD`'s point of view (44100*512/8).
540 541

Resampler
542
^^^^^^^^^
543 544 545

Sometimes, music needs to be resampled before it can be played; for example, CDs use a sample rate of 44,100 Hz while many cheap audio chips can only handle 48,000 Hz. Resampling reduces the quality and consumes a lot of CPU. There are different options, some of them optimized for high quality and others for low CPU usage, but you can't have both at the same time. Often, the resampler is the component that is responsible for most of :program:`MPD`'s CPU usage. Since :program:`MPD` comes with high quality defaults, it may appear that :program:`MPD` consumes more CPU than other software.

546 547
Check the :ref:`resampler_plugins` reference for a list of resamplers
and how to configure them.
548 549 550 551

Client Connections
------------------

552 553
.. _listeners:

554
Listeners
555
^^^^^^^^^
556

557 558 559
The setting :code:`bind_to_address` specifies which addresses
:program:`MPD` listens on for connections from clients.  It can be
used multiple times to bind to more than one address.  Example::
560

561 562
 bind_to_address "192.168.1.42"
 bind_to_address "127.0.0.1"
563

564
The default is "any", which binds to all available addresses.
565 566 567
Additionally, MPD binds to :code:`$XDG_RUNTIME_DIR/mpd/socket` (if it
was launched as a per-user daemon and no :code:`bind_to_address`
setting exists).
568 569 570 571 572 573 574 575 576 577 578 579 580 581

You can set a port that is different from the global port setting,
e.g. "localhost:6602".  IPv6 addresses must be enclosed in square
brackets if you want to configure a port::

 bind_to_address "[::1]:6602"

To bind to a local socket (UNIX domain socket), specify an absolute
path or a path starting with a tilde (~).  Some clients default to
connecting to :file:`/var/run/mpd/socket` so this may be a good
choice::

 bind_to_address "/var/run/mpd/socket"

582 583 584 585 586 587
On Linux, local sockets can be bound to a name without a socket inode
on the filesystem; MPD implements this by prepending ``@`` to the
address::

 bind_to_address "@mpd"

588 589 590 591
If no port is specified, the default port is 6600.  This default can
be changed with the port setting::

 port "6601"
592

593 594 595
These settings will be ignored if `systemd socket activation`_ is
used.

596 597

Permissions and Passwords
598
^^^^^^^^^^^^^^^^^^^^^^^^^
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626

By default, all clients are unauthenticated and have a full set of permissions. This can be restricted with the settings :code:`default_permissions` and :code:`password`.

:code:`default_permissions` controls the permissions of a new client. Its value is a comma-separated list of permissions:

.. list-table::
   :widths: 20 80
   :header-rows: 1

   * - Name
     - Description
   * - **read**
     - Allows reading of the database, displaying the current playlist, and current status of :program:`MPD`.
   * - **add**
     - Allows adding songs and loading playlists.
   * - **control**
     - Allows all other player and playlist manipulations.
   * - **admin**
     - Allows database updates and allows shutting down :program:`MPD`.

:code:`local_permissions` may be used to assign other permissions to clients connecting on a local socket.

:code:`password` allows the client to send a password to gain other permissions. This option may be specified multiple times with different passwords.

Note that the :code:`password` option is not secure: passwords are sent in clear-text over the connection, and the client cannot verify the server's identity.

Example:

627
.. code-block:: none
628 629 630 631 632 633 634 635

    default_permissions "read"
    password "the_password@read,add,control"
    password "the_admin_password@read,add,control,admin"

Other Settings
--------------

636 637
.. _metadata_to_use:

638 639 640 641 642 643 644
.. list-table::
   :widths: 20 80
   :header-rows: 1

   * - Setting
     - Description
   * - **metadata_to_use TAG1,TAG2,...**
645 646 647 648
     - Use only the specified tags, and ignore the others. This
       setting can reduce the database size and :program:`MPD`'s
       memory usage by omitting unused tags. By default, all tags but
       comment are enabled. The special value "none" disables all
649 650 651 652 653 654 655 656 657 658
       tags.

       If the setting starts with ``+`` or ``-``, then the following
       tags will be added or remoted to/from the current set of tags.
       This example just enables the "comment" tag without disabling all
       the other supported tags

         metadata_to_use "+comment"

       Section :ref:`tags` contains a list of supported tags.
659 660

The State File
661
^^^^^^^^^^^^^^
662 663 664 665 666 667 668 669 670 671 672 673 674

 The state file is a file where :program:`MPD` saves and restores its state (play queue, playback position etc.) to keep it persistent across restarts and reboots. It is an optional setting.

:program:`MPD` will attempt to load the state file during startup, and will save it when shutting down the daemon. Additionally, the state file is refreshed every two minutes (after each state change).

.. list-table::
   :widths: 20 80
   :header-rows: 1

   * - Setting
     - Description
   * - **state_file PATH**
     - Specify the state file location. The parent directory must be writable by the :program:`MPD` user (+wx).
675
   * - **state_file_interval SECONDS**
676 677 678
     - Auto-save the state file this number of seconds after each state change. Defaults to 120 (2 minutes).

The Sticker Database
679
^^^^^^^^^^^^^^^^^^^^
680

681 682 683
"Stickers" are pieces of information attached to songs. Some clients
use them to store ratings and other volatile data. This feature
requires :program:`SQLite`, compile-time configure option
684
:code:`-Dsqlite=...`.
685 686 687 688 689 690 691 692 693 694 695

.. list-table::
   :widths: 20 80
   :header-rows: 1

   * - Setting
     - Description
   * - **sticker_file PATH**
     - The location of the sticker database.

Resource Limitations
696
^^^^^^^^^^^^^^^^^^^^
697 698 699 700 701 702 703 704 705 706 707 708

These settings are various limitations to prevent :program:`MPD` from using too many resources (denial of service).

.. list-table::
   :widths: 20 80
   :header-rows: 1

   * - Setting
     - Description
   * - **connection_timeout SECONDS**
     - If a client does not send any new data in this time period, the connection is closed. Clients waiting in "idle" mode are excluded from this. Default is 60.
   * - **max_connections NUMBER**
709
     - This specifies the maximum number of clients that can be connected to :program:`MPD` at the same time. Default is 100.
710 711 712 713 714 715 716 717
   * - **max_playlist_length NUMBER**
     - The maximum number of songs that can be in the playlist. Default is 16384.
   * - **max_command_list_size KBYTES**
     - The maximum size a command list. Default is 2048 (2 MiB).
   * - **max_output_buffer_size KBYTES**
     - The maximum size of the output buffer to a client (maximum response size). Default is 8192 (8 MiB).

Buffer Settings
718
^^^^^^^^^^^^^^^
719 720 721 722 723 724 725 726 727

Do not change these unless you know what you are doing.

.. list-table::
   :widths: 20 80
   :header-rows: 1

   * - Setting
     - Description
728 729 730
   * - **audio_buffer_size SIZE**
     - Adjust the size of the internal audio buffer. Default is
       :samp:`4 MB` (4 MiB).
731 732

Zeroconf
733
^^^^^^^^
734

735
If Zeroconf support (`Avahi <http://avahi.org/>`_ or Apple's Bonjour)
736
was enabled at compile time with :code:`-Dzeroconf=...`,
737 738
:program:`MPD` can announce its presence on the network. The following
settings control this feature:
739 740 741 742 743 744 745 746 747 748

.. list-table::
   :widths: 20 80
   :header-rows: 1

   * - Setting
     - Description
   * - **zeroconf_enabled yes|no**
     - Enables or disables this feature. Default is yes.
   * - **zeroconf_name NAME**
749 750
     - The service name to publish via Zeroconf. The default is "Music Player @ %h".
       %h will be replaced with the hostname of the machine running :program:`MPD`.
751

752 753
Advanced configuration
**********************
754 755

.. _satellite:
Rasmus Steinke's avatar
Rasmus Steinke committed
756

757 758 759 760 761 762 763
Satellite setup
---------------

:program:`MPD` runs well on weak machines such as the Raspberry Pi. However, such hardware tends to not have storage big enough to hold a music collection. Mounting music from a file server can be very slow, especially when updating the database.

One approach for optimization is running :program:`MPD` on the file server, which not only exports raw files, but also provides access to a readily scanned database. Example configuration:

764
.. code-block:: none
765 766 767 768 769 770 771 772 773 774 775 776 777

    music_directory "nfs://fileserver.local/srv/mp3"
    #music_directory "smb://fileserver.local/mp3"

    database {
        plugin "proxy"
        host "fileserver.local"
    }
      
The :code:`music_directory` setting tells :program:`MPD` to read files from the given NFS server. It does this by connecting to the server from userspace. This does not actually mount the file server into the kernel's virtual file system, and thus requires no kernel cooperation and no special privileges. It does not even require a kernel with NFS support, only the nfs storage plugin (using the libnfs userspace library). The same can be done with SMB/CIFS using the smbclient storage plugin (using libsmbclient).

The database setting tells :program:`MPD` to pass all database queries on to the :program:`MPD` instance running on the file server (using the proxy plugin).

778 779
.. _realtime:

780 781 782 783 784
Real-Time Scheduling
--------------------

On Linux, :program:`MPD` attempts to configure real-time scheduling for some threads that benefit from it.

785
This is only possible if you allow :program:`MPD` to do it. This privilege is controlled by :envvar:`RLIMIT_RTPRIO` :envvar:`RLIMIT_RTTIME`. You can configure this privilege with :command:`ulimit` before launching :program:`MPD`:
786

787
.. code-block:: none
788

789
    ulimit -HS -r 40; mpd
790 791 792

Or you can use the :command:`prlimit` program from the util-linux package:

793
.. code-block:: none
794

795
    prlimit --rtprio=40 --rttime=unlimited mpd
796 797 798 799 800

The systemd service file shipped with :program:`MPD` comes with this setting.

This works only if the Linux kernel was compiled with :makevar:`CONFIG_RT_GROUP_SCHED` disabled. Use the following command to check this option for your current kernel:

801
.. code-block:: none
802 803 804 805 806

    zgrep ^CONFIG_RT_GROUP_SCHED /proc/config.gz

You can verify whether the real-time scheduler is active with the ps command:

807
.. code-block:: none
808 809 810 811 812

    # ps H -q `pidof -s mpd` -o 'pid,tid,cls,rtprio,comm'
      PID   TID CLS RTPRIO COMMAND
    16257 16257  TS      - mpd
    16257 16258  TS      - io
813
    16257 16259  FF     40 rtio
814 815
    16257 16260  TS      - player
    16257 16261  TS      - decoder
816
    16257 16262  FF     40 output:ALSA
817 818 819 820
    16257 16263 IDL      0 update

The CLS column shows the CPU scheduler; TS is the normal scheduler; FF and RR are real-time schedulers. In this example, two threads use the real-time scheduler: the output thread and the rtio (real-time I/O) thread; these two are the important ones. The database update thread uses the idle scheduler ("IDL in ps), which only gets CPU when no other process needs it.

821
.. note::
822

823 824 825 826
   There is a rumor that real-time scheduling improves audio
   quality. That is not true. All it does is reduce the probability of
   skipping (audio buffer xruns) when the computer is under heavy
   load.
827

828 829
Using MPD
*********
830

831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
Starting and Stopping MPD
-------------------------

The simplest (but not the best) way to start :program:`MPD` is to
simply type::

 mpd

This will start :program:`MPD` as a daemon process (which means it
detaches from your terminal and continues to run in background).  To
stop it, send ``SIGTERM`` to the process; if you have configured a
``pid_file``, you can use the ``--kill`` option::

 mpd --kill

The best way to manage :program:`MPD` processes is to use a service
manager such as :program:`systemd`.

systemd
^^^^^^^

:program:`MPD` ships with :program:`systemd` service units.

If you have installed :program:`MPD` with your operating system's
package manager, these are probably preinstalled, so you can start and
stop :program:`MPD` this way (like any other service)::

 systemctl start mpd
 systemctl stop mpd

systemd socket activation
^^^^^^^^^^^^^^^^^^^^^^^^^

Using systemd, you can launch :program:`MPD` on demand when the first client attempts to connect.

:program:`MPD` comes with two systemd unit files: a "service" unit and
a "socket" unit.  These will be installed to the directory specified
with :code:`-Dsystemd_system_unit_dir=...`,
e.g. :file:`/lib/systemd/system`.

To enable socket activation, type:

.. code-block:: none

    systemctl enable mpd.socket
    systemctl start mpd.socket

In this configuration, :program:`MPD` will ignore the :ref:`listener
settings <listeners>` (``bind_to_address`` and ``port``).

systemd user unit
^^^^^^^^^^^^^^^^^

You can launch :program:`MPD` as a systemd user unit.  These will be
installed to the directory specified with
:code:`-Dsystemd_user_unit_dir=...`,
e.g. :file:`/usr/lib/systemd/user` or
:file:`$HOME/.local/share/systemd/user`.

Once the user unit is installed, you can start and stop :program:`MPD` like any other service:

.. code-block:: none

    systemctl --user start mpd

To auto-start :program:`MPD` upon login, type:

.. code-block:: none

    systemctl --user enable mpd

902
.. _signals:
903

904 905 906 907 908 909
Signals
-------

:program:`MPD` understands the following UNIX signals:

- ``SIGTERM``, ``SIGINT``: shut down MPD
910 911
- ``SIGHUP``: reopen log files (send this after log rotation) and
  flush caches (see :ref:`input_cache`)
912 913


914 915 916 917 918 919 920 921 922 923 924 925 926 927
The client
----------

After you have installed, configured and started :program:`MPD`, you choose a client to control the playback.

The most basic client is :program:`mpc`, which provides a command line interface. It is useful in shell scripts. Many people bind specific :program:`mpc` commands to hotkeys.

The `MPD Wiki <http://www.musicpd.org/clients/>`_ contains an extensive list of clients to choose from.

The music directory and the database
------------------------------------

The "music directory" is where you store your music files. :program:`MPD` stores all relevant meta information about all songs in its "database". Whenever you add, modify or remove songs in the music directory, you have to update the database, for example with mpc:

928
.. code-block:: none
929 930 931 932 933 934 935 936

    mpc update

Depending on the size of your music collection and the speed of the storage, this can take a while.

To exclude a file from the update, create a file called :file:`.mpdignore` in its parent directory. Each line of that file may contain a list of shell wildcards. Matching files in the current directory and all subdirectories are excluded.

Mounting other storages into the music directory
937
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
938 939 940

:program:`MPD` has various storage plugins of which multiple instances can be "mounted" into the music directory. This way, you can use local music, file servers and USB sticks at the same time. Example:

941
.. code-block:: none
942 943 944 945 946 947 948

    mpc mount foo nfs://192.168.1.4/export/mp3
    mpc mount usbstick udisks://by-uuid-2F2B-D136
    mpc unmount usbstick

:program:`MPD`'s neighbor plugins can be helpful with finding mountable storages:

949
.. code-block:: none
950 951 952 953 954

    mpc listneighbors

Mounting is only possible with the simple database plugin and a :code:`cache_directory`, e.g.:

955
.. code-block:: none
956 957 958 959 960 961 962 963 964 965 966 967

    database {
      plugin "simple"
      path "~/.mpd/db"
      cache_directory "~/.mpd/cache"
    }
        
This requires migrating from the old :code:`db_file` setting to a database section. The cache directory must exist, and :program:`MPD` will put one file per mount there, which will be reused when the same storage is used again later.

Metadata
--------

968 969
When scanning or playing a song, :program:`MPD` parses its metadata.
See :ref:`tags` for a list of supported tags.
970

971 972 973
The :ref:`metadata_to_use <metadata_to_use>` setting can be used to
enable or disable certain tags.

974 975 976 977 978
The queue
---------

The queue (sometimes called "current playlist") is a list of songs to be played by :program:`MPD`. To play a song, add it to the queue and start playback. Most clients offer an interface to edit the queue.

979 980
.. _stored_playlists:

981 982 983
Stored Playlists
----------------

984 985 986 987 988
Stored playlists are some kind of secondary playlists which can be
created, saved, edited and deleted by the client. They are addressed
by their names.  Its contents can be loaded into the queue, to be
played back.  The :code:`playlist_directory` setting specifies where
those playlists are stored.
989

990 991
Advanced usage
**************
992 993 994 995 996 997 998 999 1000 1001

Bit-perfect playback
--------------------

"Bit-perfect playback" is a phrase used by audiophiles to describe a setup that plays back digital music as-is, without applying any modifications such as resampling, format conversion or software volume. Naturally, this implies a lossless codec.

By default, :program:`MPD` attempts to do bit-perfect playback, unless you tell it not to. Precondition is a sound chip that supports the audio format of your music files. If the audio format is not supported, :program:`MPD` attempts to fall back to the nearest supported audio format, trying to lose as little quality as possible.

To verify if :program:`MPD` converts the audio format, enable verbose logging, and watch for these lines:

1002
.. code-block:: none
1003 1004

    decoder: audio_format=44100:24:2, seekable=true
1005
    output: opened plugin=alsa name="An ALSA output" audio_format=44100:16:2
1006 1007 1008 1009 1010 1011
    output: converting from 44100:24:2

This example shows that a 24 bit file is being played, but the sound chip cannot play 24 bit. It falls back to 16 bit, discarding 8 bit.

However, this does not yet prove bit-perfect playback; ALSA may be fooling :program:`MPD` that the audio format is supported. To verify the format really being sent to the physical sound chip, try:

1012
.. code-block:: none
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027

    cat /proc/asound/card*/pcm*p/sub*/hw_params
    access: RW_INTERLEAVED
    format: S16_LE
    subformat: STD
    channels: 2
    rate: 44100 (44100/1)
    period_size: 4096
    buffer_size: 16384

Obey the "format" row, which indicates that the current playback format is 16 bit (signed 16 bit integer, little endian).

Check list for bit-perfect playback:

* Use the ALSA output plugin.
1028 1029 1030 1031
* Disable sound processing inside ALSA by configuring a "hardware"
  device (:samp:`hw:0,0` or similar).
* Don't use software volume (setting :code:`mixer_type`).
* Don't force :program:`MPD` to use a specific audio format (settings
1032
  :code:`format`, :ref:`audio_output_format <audio_output_format>`).
1033 1034
* Verify that you are really doing bit-perfect playback using :program:`MPD`'s verbose log and :file:`/proc/asound/card*/pcm*p/sub*/hw_params`. Some DACs can also indicate the audio format.

1035 1036
.. _dsd:

1037 1038 1039
Direct Stream Digital (DSD)
---------------------------

1040 1041 1042 1043 1044
DSD (`Direct Stream Digital
<https://en.wikipedia.org/wiki/Direct_Stream_Digital>`_) is a digital
format that stores audio as a sequence of single-bit values at a very
high sampling rate.  It is the sample format used on `Super Audio CDs
<https://en.wikipedia.org/wiki/Super_Audio_CD>`_.
1045

1046 1047 1048
:program:`MPD` understands the file formats :ref:`DSDIFF
<decoder_dsdiff>` and :ref:`DSF <decoder_dsf>`.  There are three ways
to play back DSD:
1049 1050 1051 1052 1053 1054

* Native DSD playback. Requires ALSA 1.0.27.1 or later, a sound driver/chip that supports DSD and of course a DAC that supports DSD.

* DoP (DSD over PCM) playback. This wraps DSD inside fake 24 bit PCM according to the DoP standard. Requires a DAC that supports DSD. No support from ALSA and the sound chip required (except for bit-perfect 24 bit PCM support).
* Convert DSD to PCM on-the-fly. 

1055 1056 1057 1058 1059
Native DSD playback is used automatically if available. DoP is only
used if enabled explicitly using the :code:`dop` option, because there
is no way for :program:`MPD` to find out whether the DAC supports
it. DSD to PCM conversion is the fallback if DSD cannot be used
directly.
1060

1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
ICY-MetaData
------------

Some MP3 streams send information about the current song with a
protocol named `"ICY-MetaData"
<http://www.smackfu.com/stuff/programming/shoutcast.html>`_.
:program:`MPD` makes its ``StreamTitle`` value available as ``Title``
tag.

By default, :program:`MPD` assumes this tag is UTF-8-encoded.  To tell
:program:`MPD` to assume a different character set, specify it in the
``charset`` URL fragment parameter, e.g.::

 mpc add 'http://radio.example.com/stream#charset=cp1251'


1077 1078
Client Hacks
************
1079 1080 1081 1082 1083 1084 1085 1086

.. _external_mixer:

External Mixer
--------------

The setting :code:`mixer_type "null"` asks MPD to pretend that there is a mixer, but not actually do something. This allows you to implement a :program:`MPD` client which listens for mixer events, queries the current (fake) volume, and uses it to program an external mixer. For example, your client can forward this setting to your amplifier.

1087 1088
Troubleshooting
***************
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098

Where to start
--------------

Make sure you have the latest :program:`MPD` version (via :code:`mpd --version`, not mpc version). All the time, bugs are found and fixed, and your problem might be a bug that is fixed already. Do not ask for help unless you have the latest :program:`MPD` version. The most common excuse is when your distribution ships an old :program:`MPD` version - in that case, please ask your distribution for help, and not the :program:`MPD` project.

Check the log file. Configure :code:`log_level "verbose"` or pass :option:`--verbose` to mpd.

Sometimes, it is helpful to run :program:`MPD` in a terminal and follow what happens. This is how to do it:

1099
.. code-block:: none
1100

1101
    mpd --stderr --no-daemon --verbose
1102 1103 1104 1105 1106

Support
-------

Getting Help
1107
^^^^^^^^^^^^
1108 1109 1110 1111

The :program:`MPD` project runs a `forum <https://forum.musicpd.org/>`_ and an IRC channel (#mpd on Freenode) for requesting help. Visit the MPD help page for details on how to get help.

Common Problems
1112
^^^^^^^^^^^^^^^
1113

1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
Startup
"""""""

Error "could not get realtime scheduling"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

See :ref:`realtime`.  You can safely ignore this, but you won't
benefit from real-time scheduling.  This only makes a difference if
your computer runs programs other than MPD.

1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
Error "Failed to initialize io_uring"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Linux specific: the io_uring subsystem could not be initialized.  This
is not a critical error - MPD will fall back to "classic" blocking
disk I/O.  You can safely ignore this error, but you won't benefit
from io_uring's advantages.

* "Cannot allocate memory" usually means that your memlock limit
  (``ulimit -l`` in bash or ``LimitMEMLOCK`` in systemd) is too low.
  64 MB is a reasonable value for this limit.
* Your Linux kernel might be too old and does not support io_uring.

1137 1138 1139 1140 1141 1142 1143 1144 1145
Error "bind to '0.0.0.0:6600' failed (continuing anyway, because binding to '[::]:6600' succeeded)"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This happens on Linux when :file:`/proc/sys/net/ipv6/bindv6only` is
disabled.  MPD first binds to IPv6, and this automatically binds to
IPv4 as well; after that, MPD binds to IPv4, but that fails.  You can
safely ignore this, because MPD works on both IPv4 and IPv6.


1146 1147
Database
""""""""
1148

1149 1150
I can't see my music in the MPD database
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1151

1152
* Check your :code:`music_directory` setting. 
1153 1154
* Does the MPD user have read permission on all music files, and read+execute permission on all music directories (and all of their parent directories)? 
* Did you update the database? (mpc update) 
1155
* Did you enable all relevant decoder plugins at compile time? :command:`mpd --version` will tell you. 
1156

1157 1158
MPD doesn't read ID3 tags!
~~~~~~~~~~~~~~~~~~~~~~~~~~
1159 1160 1161

* You probably compiled :program:`MPD` without libid3tag. :command:`mpd --version` will tell you.

1162 1163
Playback
""""""""
1164

1165 1166
I can't hear music on my client
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1167 1168 1169 1170 1171

* That problem usually follows a misunderstanding of the nature of :program:`MPD`. :program:`MPD` is a remote-controlled music player, not a music distribution system. Usually, the speakers are connected to the box where :program:`MPD` runs, and the :program:`MPD` client only sends control commands, but the client does not actually play your music.

  :program:`MPD` has output plugins which allow hearing music on a remote host (such as httpd), but that is not :program:`MPD`'s primary design goal. 

1172 1173
Error "Device or resource busy"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185

*  This ALSA error means that another program uses your sound hardware exclusively. You can stop that program to allow :program:`MPD` to use it.

  Sometimes, this other program is PulseAudio, which can multiplex sound from several applications, to allow them to share your sound chip. In this case, it might be a good idea for :program:`MPD` to use PulseAudio as well, instead of using ALSA directly.

Reporting Bugs
--------------

If you believe you found a bug in :program:`MPD`, report it on the `bug tracker <https://github.com/MusicPlayerDaemon/MPD/issues>`_.

Your bug report should contain:

1186 1187 1188
* the output of :command:`mpd --version`
* your configuration file (:file:`mpd.conf`)
* relevant portions of the log file (:option:`--verbose`)
1189 1190 1191
* be clear about what you expect MPD to do, and what is actually happening

MPD crashes
1192
^^^^^^^^^^^
1193 1194 1195 1196 1197

All :program:`MPD` crashes are bugs which must be fixed by a developer, and you should write a bug report. (Many crash bugs are caused by codec libraries used by :program:`MPD`, and then that library must be fixed; but in any case, the :program:`MPD` `bug tracker <https://github.com/MusicPlayerDaemon/MPD/issues>`_ is a good place to report it first if you don't know.)

A crash bug report needs to contain a "backtrace".

1198 1199 1200 1201 1202 1203
First of all, your :program:`MPD` executable must not be "stripped"
(i.e. debug information deleted).  The executables shipped with Linux
distributions are usually stripped, but some have so-called "debug"
packages (package :file:`mpd-dbgsym` or :file:`mpd-dbg` on Debian,
:file:`mpd-debug` on other distributions).  Make sure this package is
installed.
1204

1205 1206 1207 1208
If you built :program:`MPD` from sources, please recompile with Meson
option ":code:`--buildtype=debug -Db_ndebug=false`", because this will
add more helpful information to the backtrace.

1209 1210
You can extract the backtrace from a core dump, or by running :program:`MPD` in a debugger, e.g.:

1211
.. code-block:: none
1212

1213
    gdb --args mpd --stderr --no-daemon --verbose
1214 1215
    run

1216 1217
As soon as you have reproduced the crash, type ":command:`bt`" on the
gdb command prompt. Copy the output to your bug report.