add new

mpd/CHANGELOG.md

@@ -0,0 +1,106 @@
+## 1.7.0 - 2021-04-02
+
+* 🔨 Use ghcr.io/home-assistant for base images
+
+
+## 1.6.0 - 2021-03-27
+
+* 🐛 Fixed `media_folder`, `playlist_folder` options overwriting custom config. Thanks @LiJu09
+* 🔨 Change how custom_config behave. Check docs. Thanks @LiJu09
+
+
+## 1.5.4 - 2021-03-25
+
+* ➕ Add `media_folder`, `playlist_folder` option. Thanks @LiJu09
+
+
+## 1.5.3 - 2021-03-17
+
+* 🐛 Specifiy own S6 entrypoint, don't rely on the base image.
+
+
+## 1.5.2 - 2021-02-09
+
+* 🔨 Migrate to new `devices` option format. Thanks @LiJu09
+
+
+## 1.5.1 - 2021-01-30
+
+* 🐛 Fixed missing permissions on startup
+
+
+## 1.5.0 - 2021-01-30
+
+* 🔼 Updated alpine image to `3.13`
+* 🔼 Updated mpd to `0.22.3-r0`
+* 🔨 Use Jemalloc for better memory handling
+
+
+## 1.4.2 - 2020-11-11
+
+* 🔨 Add httpd output config
+* 🐛 Make debug config optional
+
+
+## 1.4.1 - 2020-10-24
+
+* ➕ Add `verbose` option
+
+
+## 1.4.0 - 2020-10-20
+
+* 🔼 Update alpine to `3.12`
+* 🔼 Update mpd to `0.21.23-r0`
+* 🔼 Update ympd to `1.3.0-r9`
+* 🔼 Update mpc to `0.33-r2`
+* 🔨 Use S6-Overlay for execution
+* 🔨 Disable Avahi Discovery
+* 🔨 Change audio output to Pulseaudio
+* 🔨 Start mpd as `application` startup
+* ➖ Removed alsa-plugins-pulse
+
+
+## 1.3.2 - 2020-10-06
+
+* ➕ Support `/media` folder
+
+
+## 1.3.1 - 2020-05-26
+
+* 🐛 Fixed startup without custom config file
+
+
+## 1.3.0 - 2020-05-22
+
+* ➕ Added `custom_config` option for own mpd configuration file.
+* ➕ Added configuration docs
+* 🔨 Updated Changelog to new format
+
+
+## 1.2.0 - 2020-03-09
+
+* ➕ Added `alsa-plugins-pulse` to be compatible with latest HassOS (> 3.11)
+
+
+## 1.1.2 - 2020-02-09
+
+* 🔨 Start mpd as `system` startup
+
+
+## 1.1.1 - 2020-02-07
+
+* 🔼 Update mpd to `0.21.16-r1`
+* 🔼 Update ympd to `1.3.0-r8`
+* 🔼 Update alpine to `3.11`
+* 🔼 Update mpc to  `0.33-r0`
+
+
+## 1.1.0 - 2019-12-14
+
+* ➕ Add `volume_normalization` option to addon
+
+
+## 1.0.0 - 2019-12-x
+
+* ➕ Add MPD version `0.20.21`
+* ➕ Add ympd version `1.3.0`

mpd/DOCS.md

@@ -0,0 +1,59 @@
+# Configuration
+
+```yaml
+media_folder: /media/mpd/media
+playlist_folder: /media/mpd/playlists
+volume_normalization: false
+httpd_output: false
+```
+
+### `volume_normalization`
+
+Enables the built-in volume normalization feature.
+
+### `httpd_output`
+
+Enables the httpd audio output.
+
+### `media_folder`
+
+This option let you specify an custom media folder.
+
+### `playlist_folder`
+
+This option let you specify an custom playlist folder.
+
+### `verbose` (optional)
+
+Make `mpd` verbose.
+
+```yaml
+verbose: true
+```
+
+### `custom_config` (optional)
+
+**If this is specified, all other options are ignored.**
+
+This option let you specify an custom configuration file for MPD.
+To keep all MPD files in one place I restricted the path prefix to `/share/mpd`
+Please use the default [mpd.conf of the addon](https://github.com/Poeschl/Hassio-Addons/blob/master/mpd/root/etc/mpd.conf) as starting point.
+In case you have issues with your configuration, the [MPD docs](https://www.musicpd.org/doc/html/user.html#configuration) might help you out.
+
+Working example:
+
+```yaml
+...
+custom_config: /share/mpd/mpd.conf
+```
+
+# Troubleshooting
+
+### `RTIOThread could not get realtime scheduling, continuing anyway: sched_setscheduler`
+
+This error is shown on any none-glibc system like alpine linux is. MPD should work without it.
+More see here: [MPD Issue](https://github.com/MusicPlayerDaemon/MPD/issues/218)
+
+### `Failed to open '/data/database/mpd.db': No such file or directory`
+
+This error is shown on the first start, when no database exists. It will be there on the second run.

mpd/Dockerfile

@@ -0,0 +1,11 @@
+ARG BUILD_FROM
+FROM $BUILD_FROM
+
+RUN apk add --no-cache \
+        mpc=0.33-r2 \
+        mpd=0.22.3-r0 \
+        ympd=1.3.0-r9
+
+ENTRYPOINT [ "/init" ]
+CMD []
+COPY root /

mpd/README.md

@@ -0,0 +1,31 @@
+# MPD
+
+[MPD](https://www.musicpd.org/) is a free and open source music player. It plays audio files, organizes playlists and maintains a music database. For interaction client software is needed.
+Inside this addon there is [ympd](https://ympd.org/), a simple web frontend for interacting.
+
+![Addon Stage][stage-badge]
+![Supports aarch64 Architecture][aarch64-badge]
+![Supports amd64 Architecture][amd64-badge]
+![Supports armhf Architecture][armhf-badge]
+![Supports armv7 Architecture][armv7-badge]
+![Supports i386 Architecture][i386-badge]
+
+[![Install on my Home Assistant][install-badge]][install-url]
+[![Donate][donation-badge]][donation-url]
+
+# Configuration
+
+The configuration is located under the Docs tab or [DOCS.md](https://github.com/Poeschl/Hassio-Addons/blob/master/mpd/DOCS.md).
+
+
+[aarch64-badge]: https://img.shields.io/badge/aarch64-yes-green.svg?style=for-the-badge
+[amd64-badge]: https://img.shields.io/badge/amd64-yes-green.svg?style=for-the-badge
+[armhf-badge]: https://img.shields.io/badge/armhf-yes-green.svg?style=for-the-badge
+[armv7-badge]: https://img.shields.io/badge/armv7-yes-green.svg?style=for-the-badge
+[i386-badge]: https://img.shields.io/badge/i386-yes-green.svg?style=for-the-badge
+[install-url]: https://my.home-assistant.io/redirect/supervisor_addon?addon=243ffc37_mpd
+[stage-badge]: https://img.shields.io/badge/Addon%20stage-stable-green.svg?style=for-the-badge
+
+[install-badge]: https://img.shields.io/badge/Install%20on%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge
+[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=for-the-badge&logoColor=white
+[donation-url]: https://www.buymeacoffee.com/Poeschl

mpd/build.json

@@ -0,0 +1,9 @@
+{
+  "build_from": {
+    "armhf": "ghcr.io/home-assistant/armhf-base:3.13",
+    "armv7": "ghcr.io/home-assistant/armv7-base:3.13",
+    "aarch64": "ghcr.io/home-assistant/aarch64-base:3.13",
+    "amd64": "ghcr.io/home-assistant/amd64-base:3.13",
+    "i386": "ghcr.io/home-assistant/i386-base:3.13"
+  }
+}

mpd/config.json

@@ -0,0 +1,47 @@
+{
+  "name": "MPD",
+  "version": "1.7.0",
+  "slug": "mpd",
+  "panel_icon": "mdi:music-circle",
+  "description": "Music Player Daemon is a free and open source music player. It plays audio files, organizes playlists and maintains a music database",
+  "url": "https://github.com/Poeschl/Hassio-Addons/tree/master/mpd",
+  "ingress": true,
+  "ingress_port": 6680,
+  "arch": [
+    "armv7",
+    "armhf",
+    "aarch64",
+    "amd64",
+    "i386"
+  ],
+  "startup": "application",
+  "boot": "auto",
+  "image": "ghcr.io/poeschl/ha-mpd-{arch}",
+  "audio": true,
+  "devices": ["/dev/snd"],
+  "map": ["share:rw", "media:rw"],
+  "ports": {
+    "6680/tcp": null,
+    "6600/tcp": 6600,
+    "8000/tcp": null
+  },
+  "ports_description": {
+    "6680/tcp": "Web Frontend (Not needed with ingress feature)",
+    "6600/tcp": "MDP Connection",
+    "8000/tcp": "HTTPd Connection (if enabled)"
+  },
+  "options": {
+    "media_folder": "/media/mpd/media",
+    "playlist_folder": "/media/mpd/playlists",
+    "volume_normalization": false,
+    "httpd_output": false
+  },
+  "schema": {
+    "media_folder": "match(/share/.+|/media/.+|(smb|nfs)://.+)",
+    "playlist_folder": "match(/share/.+|/media/.+|(smb|nfs)://.+)",
+    "volume_normalization": "bool",
+    "httpd_output": "bool",
+    "verbose": "bool?",
+    "custom_config": "match(/share/mpd/.+)?"
+  }
+}

mpd/root/etc/cont-init.d/setup-folders

@@ -0,0 +1,11 @@
+#!/usr/bin/with-contenv bashio
+set -e
+
+bashio::log.info  'Setup Folders'
+
+MEDIA_FOLDER=$(bashio::config 'media_folder')
+PLAYLIST_FOLDER=$(bashio::config 'playlist_folder')
+
+mkdir -p /data/database \
+    "${MEDIA_FOLDER}" \
+    "${PLAYLIST_FOLDER}"

mpd/root/etc/cont-init.d/setup-settings

@@ -0,0 +1,36 @@
+#!/usr/bin/with-contenv bashio
+set -e
+
+bashio::log.info  'Setup settings'
+
+if [ "$(bashio::config 'custom_config')" != 'null' ]; then
+	bashio::log.info 'Use custom config'
+    cp "$(bashio::config 'custom_config')" '/etc/mpd.conf'
+else
+	bashio::log.info 'Set media folder'
+	MEDIA_FOLDER=$(bashio::config 'media_folder')
+	sed -i "s/music_directory.*/music_directory \"${MEDIA_FOLDER//\//\\/}\"/" /etc/mpd.conf
+
+	bashio::log.info 'Set playlist folder'
+	PLAYLIST_FOLDER=$(bashio::config 'playlist_folder')
+	sed -i "s/playlist_directory.*/playlist_directory \"${PLAYLIST_FOLDER//\//\\/}\"/" /etc/mpd.conf
+
+	if [ "$(bashio::config 'volume_normalization')" == 'true' ]; then
+		sed -i "/^#volume_normalization/s/^#//" /etc/mpd.conf
+	fi
+
+	if [ "$(bashio::config 'verbose')" == 'true' ]; then
+		sed -i "/^log_level/s/default/verbose/" /etc/mpd.conf
+	fi
+
+	if [ "$(bashio::config 'httpd_output')" == 'true' ]; then
+		printf '\n
+		audio_output { \n
+			type		"httpd" \n
+			name		"HTTPd Output" \n 
+			port		"8000" \n
+			bitrate		"192" \n
+		}' >> /etc/mpd.conf
+		bashio::log.info 'HTTPd output enabled'
+	fi
+fi

mpd/root/etc/fix-attrs.d/mpd

@@ -0,0 +1,2 @@
+/usr/bin/mpd	false	root:root 0744 0744
+/usr/bin/mpc	false	root:root 0744 0744

mpd/root/etc/fix-attrs.d/ympd

@@ -0,0 +1 @@
+/usr/bin/ympd	false	root:root 0744 0744

mpd/root/etc/mpd.conf

@@ -0,0 +1,386 @@
+# An example configuration file for MPD.
+# Read the user manual for documentation: http://www.musicpd.org/doc/user/
+
+
+# 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 "/share/mpd/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 "/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 "/data/database/mpd.db"
+#
+# 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		"syslog"
+#
+# 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		"/var/run/mpd/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 "/data/state"
+#
+# The location of the sticker database.  This is a database which
+# manages dynamic information attached to songs.
+#
+sticker_file "/data/sticker.sql"
+#
+###############################################################################
+
+
+# General music daemon options ################################################
+#
+# This setting specifies the user that MPD will run as. MPD should never run as
+# root and you may use this setting to make MPD change its user ID after
+# initialization. This setting is disabled by default and MPD is run as the
+# current user.
+#
+#user		"mpd"
+#
+# This setting specifies the group that MPD will run as. If not specified
+# primary group of user specified with "user" setting will be used (if set).
+# This is useful if MPD needs to be a member of group such as "audio" to
+# have permission to use sound card.
+#
+#group				"audio"
+#
+# This setting sets the address for the daemon to listen on. Careful attention
+# should be paid if this is assigned to anything other then the default, any.
+# This setting can deny access to control of the daemon. Not effective if
+# systemd socket activiation is in use.
+#
+# For network
+bind_to_address		"0.0.0.0"
+#
+# And for Unix Socket
+#bind_to_address		"~/.mpd/socket"
+#
+# This setting is the TCP port that is desired for the daemon to get assigned
+# to.
+#
+port				"6600"
+#
+# 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"
+#
+# Setting "restore_paused" to "yes" puts MPD into pause mode instead
+# of starting playback after startup.
+#
+#restore_paused "no"
+#
+# 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 user manual.
+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		"no"
+#
+# The argument to this setting will be the Zeroconf / Avahi unique name for
+# this MPD server on the network.
+#
+#zeroconf_name			"Music Player"
+#
+###############################################################################
+
+
+# Permissions #################################################################
+#
+# If this setting is set, MPD will require password authorization. The password
+# 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.
+#
+# An example of an ALSA output:
+#
+#audio_output {
+#	type		"alsa"
+#	name		"Home Assistant ALSA Audio"
+##	device		"hw:0,0"	# optional
+##	mixer_type      "hardware"	# optional
+##	mixer_device	"default"	# optional
+##	mixer_control	"PCM"		# optional
+##	mixer_index	"0"		# optional
+#}
+#
+# An example of an OSS output:
+#
+#audio_output {
+#	type		"oss"
+#	name		"My OSS Device"
+##	device		"/dev/dsp"	# optional
+##	mixer_type      "hardware"	# optional
+##	mixer_device	"/dev/mixer"	# optional
+##	mixer_control	"PCM"		# optional
+#}
+#
+# An example of a shout output (for streaming to Icecast):
+#
+#audio_output {
+#	type		"shout"
+#	encoder		"vorbis"		# optional
+#	name		"My Shout Stream"
+#	host		"localhost"
+#	port		"8000"
+#	mount		"/mpd.ogg"
+#	password	"hackme"
+#	quality		"5.0"
+#	bitrate		"128"
+#	format		"44100:16:1"
+##	protocol	"icecast2"		# optional
+##	user		"source"		# optional
+##	description	"My Stream Description"	# optional
+##	url		"http://example.com"	# optional
+##	genre		"jazz"			# optional
+##	public		"no"			# optional
+##	timeout		"2"			# optional
+##	mixer_type      "software"		# optional
+#}
+#
+# An example of a recorder output:
+#
+#audio_output {
+#	type		"recorder"
+#	name		"My recorder"
+#	encoder		"vorbis"		# optional, vorbis or lame
+#	path		"/var/lib/mpd/recorder/mpd.ogg"
+##	quality		"5.0"			# do not define if bitrate is defined
+#	bitrate		"128"			# do not define if quality is defined
+#	format		"44100:16:1"
+#}
+#
+# An example of a httpd output (built-in HTTP streaming server):
+#
+#audio_output {
+#	type		"httpd"
+#	name		"My HTTP Stream"
+#	encoder		"vorbis"		# optional, vorbis or lame
+#	port		"8000"
+#	bind_to_address	"0.0.0.0"		# optional, IPv4 or IPv6
+#	quality		"5.0"			# do not define if bitrate is defined
+#	bitrate		"192"			# do not define if quality is defined
+#	format		"44100:16:1"
+#	max_clients	"5"			# optional 0=no limit
+#}
+#
+# An example of a pulseaudio output (streaming to a remote pulseaudio server)
+#
+audio_output {
+	type		"pulse"
+	name		"Home Assistant Pulseaudio"
+#	server		"remote_server"		# optional
+#	sink		"remote_server_sink"	# optional
+}
+#
+# An example of a winmm output (Windows multimedia API).
+#
+#audio_output {
+#	type		"winmm"
+#	name		"My WinMM output"
+##	device		"Digital Audio (S/PDIF) (High Definition Audio Device)" # optional
+#		or
+##	device		"0"		# optional
+##	mixer_type	"hardware"	# optional
+#}
+#
+# An example of an openal output.
+#
+#audio_output {
+#	type		"openal"
+#	name		"My OpenAL output"
+##	device		"Digital Audio (S/PDIF) (High Definition Audio Device)" # optional
+#}
+#
+# An example of an sndio output.
+#
+#audio_output {
+#	type		"sndio"
+#	name		"sndio output"
+#	mixer_type	"software"
+#}
+#
+# An example of an OS X output:
+#
+#audio_output {
+#	type		"osx"
+#	name		"My OS X Device"
+##	device		"Built-in Output"	# optional
+##	channel_map      "-1,-1,0,1"	# optional
+#}
+#
+## Example "pipe" output:
+#
+#audio_output {
+#	type		"pipe"
+#	name		"my pipe"
+#	command		"aplay -f cd 2>/dev/null"
+## Or if you're want to use AudioCompress
+#	command		"AudioCompress -m | aplay -f cd 2>/dev/null"
+## Or to send raw PCM stream through PCM:
+#	command		"nc example.org 8765"
+#	format		"44100:16:2"
+#}
+#
+## An example of a null output (for no audio output):
+#
+#audio_output {
+#	type		"null"
+#	name		"My Null Output"
+#	mixer_type      "none"			# optional
+#}
+#
+###############################################################################
+
+
+# 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			"album"
+#
+# 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		"yes"
+#
+###############################################################################
+
+# Character Encoding ##########################################################
+#
+# If file or directory names do not display correctly for your locale then you
+# may need to modify this setting.
+#
+filesystem_charset		"UTF-8"
+#
+###############################################################################

mpd/root/etc/services.d/mpd/run

@@ -0,0 +1,8 @@
+#!/usr/bin/with-contenv bashio
+set -e
+
+# Enable Jemalloc for better memory handling
+export LD_PRELOAD="/usr/local/lib/libjemalloc.so.2"
+
+bashio::log.info 'Start MPD'
+mpd --stdout --no-daemon

mpd/root/etc/services.d/ympd/run

@@ -0,0 +1,9 @@
+#!/usr/bin/with-contenv bashio
+set -e
+bashio::net.wait_for 6600
+
+# Enable Jemalloc for better memory handling
+export LD_PRELOAD="/usr/local/lib/libjemalloc.so.2"
+
+bashio::log.info  'Start ympd'
+ympd -w 6680