Skip to content

Instantly share code, notes, and snippets.

@kousu
Last active June 20, 2016 22:50
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save kousu/b194c04e83bc1e6f44bf to your computer and use it in GitHub Desktop.
Save kousu/b194c04e83bc1e6f44bf to your computer and use it in GitHub Desktop.
Local MPD.conf
# mpd config file
### XXX this has been manually hacked up to
# mpd (undocumentedly) checks $XDG_CONFIG_DIR/mpd/mpd.conf before ~/.mpdconf, before /etc/mpd.conf
# since it does that... why not the rest of the system eh?
# but this script doesn't understand environment vars of course, though it *will* expand ~/ to $HOME
# for some reason linux has decided that $XDG_RUNTIME_DIR should be on /run (/run/user/1000) which is annoying
# Files and directories #######################################################
#
# This setting controls the top directory which MPD will search to discover the
# available audio files and add them to the daemon's online database. This
# setting defaults to the XDG directory, otherwise the music directory will be
# be disabled and audio files will only be accepted over ipc socket (using
# file:// protocol) or streaming files over an accepted protocol.
#
music_directory "~/Music"
#
# This setting sets the MPD internal playlist directory. The purpose of this
# directory is storage for playlists created by MPD. The server will use
# playlist files not created by the server but only if they are in the MPD
# format. This setting defaults to playlist saving being disabled.
#
playlist_directory "~/.local/share/mpd/playlists"
#
# This setting sets the location of the MPD database. This file is used to
# load the database at server start up and store the database while the
# server is not up. This setting defaults to disabled which will allow
# MPD to accept files over ipc socket (using file:// protocol) or streaming
# files over an accepted protocol.
#
db_file "~/.local/share/mpd/database"
#
# These settings are the locations for the daemon log files for the daemon.
# These logs are great for troubleshooting, depending on your log_level
# settings.
#
# The special value "syslog" makes MPD use the local syslog daemon. This
# setting defaults to logging to syslog, otherwise logging is disabled.
#
log_file "/run/user/1000/mpd/log"
#
# This setting sets the location of the file which stores the process ID
# for use of mpd --kill and some init scripts. This setting is disabled by
# default and the pid file will not be stored.
#
pid_file "/run/user/1000/mpd/pid"
#
# This setting sets the location of the file which contains information about
# most variables to get MPD back into the same general shape it was in before
# it was brought down. This setting is disabled by default and the server
# state will be reset on server start up.
#
state_file "/run/user/1000/mpd/state"
#
# The location of the sticker database. This is a database which
# manages dynamic information attached to songs.
#
sticker_file "~/.local/share/mpd/sticker.sql"
#
###############################################################################
# General music daemon options ################################################
#
#
bind_to_address "/run/user/1000/mpd/socket"
#
# This setting controls the type of information which is logged. Available
# setting arguments are "default", "secure" or "verbose". The "verbose" setting
# argument is recommended for troubleshooting, though can quickly stretch
# available resources on limited hardware storage.
#
#log_level "default"
#
# If you have a problem with your MP3s ending abruptly it is recommended that
# you set this argument to "no" to attempt to fix the problem. If this solves
# the problem, it is highly recommended to fix the MP3 files with vbrfix
# (available from <http://www.willwap.co.uk/Programs/vbrfix.php>), at which
# point gapless MP3 playback can be enabled.
#
gapless_mp3_playback "yes"
#
# Setting "restore_paused" to "yes" puts MPD into pause mode instead
# of starting playback after startup.
#
restore_paused "yes"
#
# This setting enables MPD to create playlists in a format usable by other
# music players.
#
save_absolute_paths_in_playlists "no"
# This setting defines a list of tag types that will be extracted during the
# audio file discovery process. The complete list of possible values can be
# found in the mpd.conf man page.
metadata_to_use "artist,album,title,track,name,genre,date,composer,performer,disc"
#
# This setting enables automatic update of MPD's database when files in
# music_directory are changed.
#
auto_update "yes"
#
# Limit the depth of the directories being watched, 0 means only watch
# the music directory itself. There is no limit by default.
#
#auto_update_depth "3"
#
###############################################################################
# Symbolic link behavior ######################################################
#
# If this setting is set to "yes", MPD will discover audio files by following
# symbolic links outside of the configured music_directory.
#
follow_outside_symlinks "yes"
#
# If this setting is set to "yes", MPD will discover audio files by following
# symbolic links inside of the configured music_directory.
#
follow_inside_symlinks "yes"
#
###############################################################################
# Zeroconf / Avahi Service Discovery ##########################################
#
# If this setting is set to "yes", service information will be published with
# Zeroconf / Avahi.
#
zeroconf_enabled "yes"
#
# The argument to this setting will be the Zeroconf / Avahi unique name for
# this MPD server on the network.
#
zeroconf_name "Kousu's Music Player"
#
###############################################################################
# Permissions #################################################################
#
# If this setting is set, MPD will require password authorization. The password
# can setting can be specified multiple times for different password profiles.
#
#password "password@read,add,control,admin"
#
# This setting specifies the permissions a user has who has not yet logged in.
#
#default_permissions "read,add,control,admin"
#
###############################################################################
# Database #######################################################################
#
#database {
# plugin "proxy"
# host "other.mpd.host"
# port "6600"
#}
# Input #######################################################################
#
input {
plugin "curl"
# proxy "proxy.isp.com:8080"
# proxy_user "user"
# proxy_password "password"
}
#
###############################################################################
# Audio Output ################################################################
#
# MPD supports various audio output types, as well as playing through multiple
# audio outputs at the same time, through multiple audio_output settings
# blocks. Setting this block is optional, though the server will only attempt
# autodetection for one sound card.
#
# I don't have an ALSA out because sometimes (it's not clear to me how??) using ALSA will make mpd jam the soundcard
audio_output {
type "pulse"
name "pulse"
}
#
# If MPD has been compiled with libsamplerate support, this setting specifies
# the sample rate converter to use. Possible values can be found in the
# mpd.conf man page or the libsamplerate documentation. By default, this is
# setting is disabled.
#
#samplerate_converter "Fastest Sinc Interpolator"
#
###############################################################################
# Normalization automatic volume adjustments ##################################
#
# This setting specifies the type of ReplayGain to use. This setting can have
# the argument "off", "album", "track" or "auto". "auto" is a special mode that
# chooses between "track" and "album" depending on the current state of
# random playback. If random playback is enabled then "track" mode is used.
# See <http://www.replaygain.org> for more details about ReplayGain.
# This setting is off by default.
#
replaygain "auto"
#
# This setting sets the pre-amp used for files that have ReplayGain tags. By
# default this setting is disabled.
#
#replaygain_preamp "0"
#
# This setting sets the pre-amp used for files that do NOT have ReplayGain tags.
# By default this setting is disabled.
#
#replaygain_missing_preamp "0"
#
# This setting enables or disables ReplayGain limiting.
# MPD calculates actual amplification based on the ReplayGain tags
# and replaygain_preamp / replaygain_missing_preamp setting.
# If replaygain_limit is enabled MPD will never amplify audio signal
# above its original level. If replaygain_limit is disabled such amplification
# might occur. By default this setting is enabled.
#
#replaygain_limit "yes"
#
# This setting enables on-the-fly normalization volume adjustment. This will
# result in the volume of all playing audio to be adjusted so the output has
# equal "loudness". This setting is disabled by default.
#
#volume_normalization "no"
#
###############################################################################
# Local mpd
mpd is a great music player, but it's main target has been servers or single-user machines.
However, mpd is perfectly capable of running private instances for each user using their own music.
It's just that doing this isn't documented and has some
The trick is to listen on unix domain sockets, keep the databases under user-local locations,
and *not* use ALSA (which will steal the soundcard).
At least with mpd 0.19.12, the manpage claims
```
FILES
~/.mpdconf
User configuration file.
/etc/mpd.conf
Global configuration file.
```
HOWEVER, mpd will respect [$XDG_CONFIG_DIR](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html).
To check that your mpd does this, create ~/.config/mpd/mpd.conf and then test running mpd:
```
[kousu@galleon ~]$ mpd --no-daemon --verbose
config_file: loading file /home/kousu/.config/mpd/mpd.conf
```
Instead of using mpd's sketchy password system, access control is by unix file permissions: if you really want to share access, grant them +rw to $XDG_RUNTIME_DIR/mpd/socket (which might be tricky, remember to +x--but not +rw--the containing dirs and such)
This isn't a full git repo because it's a sketchy one-off thing I did, and because you have to customize it to get it to work.
If I script it up better then it will become Software.
Install
-------
Make the necessary user-local directories.
```
mkdir -p $XDG_CONFIG_DIR/mpd
mkdir -p $XDG_DATA_DIR/mpd
mkdir -p $XDG_RUNTIME_DIR/mpd
```
Paste `mpd.conf` into `$XDG_CONFIG_DIR/mpd/mpd.conf` and tweak it
(you will likely need to change /var/run/1000/ to whatever $XDG_RUNTIME_DIR is for you).
If you want to enable remote control, e.g. via, [MPDroid](https://github.com/abarisain/dmix) you should add
```
bind_to_address "0.0.0.0"
port "660x"
password "hackme"
```
where x is chosen by you: each user will have to have a different port (try `$(($x + $UID - 1000))` maybe)
Add this to your crontab:
```
@reboot mpd
```
If your mpd is old and doesn't know about $XDG_CONFIG_DIR, you can just be explicit about it:
```
@reboot mpd ~/.config/mpd/mpd.conf
```
Add this to your `~/.profile`:
```
export MPD_HOST="$(abspath $XDG_RUNTIME_DIR/mpd/socket)"
```
mpc and ncmpc respect this variable; the GUI clients are less respectful, and may need manual poking to get the right path stored, but you only need to do this once.
Make sure the path is absolute! The way mpd distinguishes a tcp from a unix domain socket address is whether it starts with a '/'!!!
TODO
----
* [ ] Work out an optional way to proxy remote controls (socat?? just enabling TCP afterall?)
* [x] Get mpd running locally.
* [x] Publicize
* [ ] add a shoutcast output optionally
* [ ] Write a wrapper script that generates mpd.conf, filling in $XDG_*_DIR as appropriate
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment