[Feature] Drop support for ALSA as OUTPUT_MODE (already deprecated) #225 (#240)

Author: GioF71

Dockerfile

@@ -71,24 +71,6 @@ ENV DATABASE_PROXY_PORT ""
 ENV MPD_BIND_ADDRESS ""
 ENV MPD_PORT ""
 
-ENV ALSA_PRESET ""
-ENV ALSA_DEVICE_NAME ""
-ENV MPD_AUDIO_DEVICE ""
-ENV MIXER_TYPE ""
-ENV MIXER_DEVICE ""
-ENV MIXER_CONTROL ""
-ENV MIXER_INDEX ""
-ENV DOP ""
-ENV ALSA_ALLOWED_FORMATS ""
-ENV ALSA_ALLOWED_FORMATS_PRESET ""
-ENV ALSA_OUTPUT_FORMAT ""
-ENV AUTO_RESAMPLE ""
-ENV THESYCON_DSD_WORKAROUND ""
-ENV INTEGER_UPSAMPLING ""
-ENV ALSA_AUTO_FIND_MIXER ""
-
-ENV OUTPUT_MODE ""
-
 # ALSA Outputs
 ENV ALSA_OUTPUT_CREATE ""
 ENV ALSA_OUTPUT_ENABLED ""

README.md

@@ -60,15 +60,15 @@ Keep in mind that the `legacy` branch will not be updated with new features. Onl
 
 ### Important changes
 
-Starting with release `2023-02-04`, you will not be able to use the deprecated `PULSE` as `OUTPUT_MODE`. Refer to the next chapter for more information about how to change the configuration. Please note that PulseAudio is still supported, it just needs to be configured a little differently.  
-In case of difficulties, you can fall back to any image before `2023-02-04` or to the `legacy` versions, as those will still work with this deprecated configuration.  
+Starting with release `2023-02-04`, you will not be able to use the deprecated `PULSE` and `ALSA` as `OUTPUT_MODE`. Refer to the next chapter for more information about how to change the configuration. Please note that Alsa and PulseAudio are still supported: you just need to slightly modify your docker configurations.  
+In case of difficulties, you can fall back to the `legacy` image versions, as those will still work with these deprecated configurations.  
 
 ### What is about to change
 
 If you have been using this container image for a while, you might have seen that the output might contain some warnings, telling you that you are using a `deprecated` configuration. The message usually tries to suggest how to switch to a `recommended` configuration.  
 This is happening because this whole project started with the idea of supporting ALSA only (hence the name `mpd-alsa-docker`). Down the road, I added PulseAudio support, and eventually HTTPD outputs, SHOUTCAST outputs, also in multiple instances.  
 So now a few variables have a misleading name: the most misleading being `ALSA_DEVICE_NAME` which, despite the name, refers to the output name, and not to the device name.  
-So currently, `OUTPUT_MODE` still defaults to `ALSA` for compatibility and will yield the creation of a ALSA *main* player, but the default for this variable will eventually become `NONE` (no *main* player). At the end of the process, the variable `OUTPUT_MODE` will completely disappear.  
+So currently, `OUTPUT_MODE` is not available anymore.  
 In any case, I suggest you change the configuration as suggested, and use the variables from the appropriate sections below for [Alsa](https://github.com/GioF71/mpd-alsa-docker#alsa-additional-outputs) and [PulseAudio](https://github.com/GioF71/mpd-alsa-docker#pulseaudio-additional-outputs), otherwise, in time, your configurations will not be functional anymore.  
 Feel free to contact me with an issue if you need support. I cannot guarantee a timing, but I will try to help if I can.  
 
@@ -113,7 +113,6 @@ DATABASE_MODE|Can be `simple` (default) or `proxy`
 DATABASE_PROXY_HOST|MPD server hostname, only used when `DATABASE_MODE` is set to `proxy`
 DATABASE_PROXY_PORT|MPD server port, only used when `DATABASE_MODE` is set to `proxy`
 MUSIC_DIRECTORY|Location of music files, defaults to `/music`
-OUTPUT_MODE|Output mode, can be `alsa` (still default but **deprecated**, you should use `ALSA_OUTPUT_CREATE` set to `yes`) or `none`.
 MPD_BIND_ADDRESS|The MPD listen address, defaults to `0.0.0.0`
 MPD_PORT|The MPD port, defaults to `6600`
 USER_MODE|Set to `Y` or `YES` for user mode. Case insensitive. See [User mode](#user-mode). Required when using any PulseAudio outputs (so when `PULSE_AUDIO_OUTPUT_CREATE` is set to `yes`)
@@ -135,30 +134,6 @@ STATE_FILE_INTERVAL|Auto-save the state file this number of seconds after each s
 ENFORCE_PLAYER_STATE|If set to `yes`, it will remove player state information from the state file, so the player state will only depend on the environment variables. Defaults to `yes`
 STARTUP_DELAY_SEC|Delay before starting the application in seconds, defaults to `0`.
 
-#### Main output as ALSA (**Deprecated**)
-
-Please find here the relevant (but *deprecated*) variables when OUTPUT_MODE is set to `ALSA`
-
-VARIABLE|DESCRIPTION
-:---|:---
-ALSA_PRESET|Use an alsa preset. See file [alsa-presets.conf](https://github.com/GioF71/mpd-alsa-docker/blob/main/app/assets/alsa-presets.conf) for the existing presets. Additional presets can be passed to the container through the file `/user/config/additional-alsa-presets.conf`
-ALSA_AUTO_FIND_MIXER|If set to `yes` and `MIXER_DEVICE` is still empty, the run script will try to find the hardware mixer using `amixer`. This is not guaranteed to work for every dac. Some experiments will be needed. Sharing the results will be **very** helpful. Defaults to `no`
-MPD_AUDIO_DEVICE|The audio device. Common examples: `hw:DAC` or `hw:x20` or `hw:X20` for usb dac based on XMOS chips. Defaults to `default`
-ALSA_DEVICE_NAME|Name of the Alsa Device, defaults to `Alsa Device`. The name if unfortunately misleading: this variable refers to the mpd output name.
-MIXER_TYPE|Mixer type, defaults to `hardware`
-MIXER_DEVICE|Mixer device, defaults to `default`
-MIXER_CONTROL|Mixer Control, defaults to `PCM`
-MIXER_INDEX|Mixer Index, defaults to `0`
-DOP|Enables Dsd-Over-Pcm. Possible values: `yes` or `no`. Empty by default: this it lets mpd handle dop setting.
-ALSA_OUTPUT_FORMAT|Sets `alsa` output format. Example value: `192000:24:2`
-ALSA_ALLOWED_FORMATS|Sets the `alsa` output allowed formats
-AUTO_RESAMPLE|If set to no, then libasound will not attempt to resample. In this case, the user is responsible for ensuring that the requested sample rate can be produced natively by the device, otherwise an error will occur.
-THESYCON_DSD_WORKAROUND|If enabled, enables a workaround for a bug in Thesycon USB audio receivers. On these devices, playing DSD512 or PCM causes all subsequent attempts to play other DSD rates to fail, which can be fixed by briefly playing PCM at 44.1 kHz.
-ALSA_ALLOWED_FORMATS_PRESET|Alternative to `ALSA_ALLOWED_FORMATS`. Possible values: `8x`, `4x`, `2x`, `8x-nodsd`, `4x-nodsd`, `2x-nodsd`
-INTEGER_UPSAMPLING|If one or more `ALSA_ALLOWED_FORMATS` are set and `INTEGER_UPSAMPLING` is set to `yes`, the formats which are evenly divided by the source sample rate are preferred. The `ALSA_ALLOWED_FORMATS` list is processed in order as provided to the container. So if you want to upsample, put higher sampling rates first. Using this feature causes a patched version of mpd to be run. Use at your own risk.  
-
-Avoid deprecated configurations and refer to [this](https://github.com/GioF71/mpd-alsa-docker/blob/main/README.md#alsa-additional-outputs) section.
-
 #### SOXR Plugin
 
 Please find here the variables used to configure the SOXR plugin.

app/bin/any-of.sh

@@ -13,9 +13,6 @@ any_pulse() {
 
 any_alsa() {
     result=0
-    if [ "${OUTPUT_MODE^^}" == "ALSA" ]; then
-        result=1
-    fi
     if [[ $result -eq 0 ]]; then
         # if at least one additional ALSA output is requested
         if [[ "${ALSA_OUTPUT_CREATE^^}" == "YES" ]]; then

app/bin/run-mpd.sh

@@ -20,10 +20,6 @@ DEFAULT_OUTPUT_MODE=alsa
 DEFAULT_ALSA_DEVICE_NAME="Alsa-Device"
 DEFAULT_MPD_AUDIO_DEVICE="default"
 
-if [ -z "${OUTPUT_MODE}" ]; then
-    OUTPUT_MODE=${DEFAULT_OUTPUT_MODE}
-fi
-
 if [ -n "${MAX_ADDITIONAL_OUTPUTS_BY_TYPE}" ]; then
     max_outputs_by_type=$MAX_ADDITIONAL_OUTPUTS_BY_TYPE
 else
@@ -137,9 +133,6 @@ if [[ "${ANY_PULSE}" -eq 1 ]] ||
         if [ -n "${AUDIO_GID}" ]; then
             create_audio_gid
         fi
-    else
-        echo "Invalid output mode [${OUTPUT_MODE}]";
-        exit 2;
     fi
     chown -R $USER_NAME:$GROUP_NAME /log
     chown -R $USER_NAME:$GROUP_NAME /db
@@ -316,155 +309,6 @@ if [[ "${QOBUZ_PLUGIN_ENABLED^^}" == "Y" || "${QOBUZ_PLUGIN_ENABLED^^}" == "YES"
     echo "}" >> $MPD_ALSA_CONFIG_FILE
 fi
 
-if [ "${OUTPUT_MODE^^}" == "ALSA" ]; then
-    echo "OUTPUT_MODE [$OUTPUT_MODE] is deprecated and will be removed in the future"
-    echo "You should use ALSA_OUTPUT_CREATE=yes instead"
-    # see if user is using a preset
-    if [ -n "${ALSA_PRESET}" ]; then
-        echo "Using alsa preset ${ALSA_PRESET}"
-        # NAME
-        alsa_preset_key="${ALSA_PRESET}.name"
-        alsa_preset_value="${alsa_presets[${alsa_preset_key}]}"
-        if [[ -v alsa_preset_value ]]; then
-            if [ -z ${ALSA_DEVICE_NAME} ]; then
-                ALSA_DEVICE_NAME=${alsa_preset_value}
-            fi
-        fi
-        # DEVICE
-        alsa_preset_key="${ALSA_PRESET}.device"
-        alsa_preset_value="${alsa_presets[${alsa_preset_key}]}"
-        if [[ -v alsa_preset_value ]]; then
-            if [ -z ${MPD_AUDIO_DEVICE} ]; then
-                MPD_AUDIO_DEVICE=$alsa_preset_value
-            fi
-        fi
-        # MIXER TYPE
-        alsa_preset_key="${ALSA_PRESET}.mixer-type"
-        alsa_preset_value="${alsa_presets[${alsa_preset_key}]}"
-        if [[ -v alsa_preset_value ]]; then
-            MIXER_TYPE=$alsa_preset_value
-        fi
-        # MIXER DEVICE
-        alsa_preset_key="${ALSA_PRESET}.mixer-device"
-        alsa_preset_value="${alsa_presets[${alsa_preset_key}]}"
-        if [[ -v alsa_preset_value ]]; then
-            MIXER_DEVICE=$alsa_preset_value
-        fi
-        # MIXER CONTROL
-        alsa_preset_key="${ALSA_PRESET}.mixer-control"
-        alsa_preset_value="${alsa_presets[${alsa_preset_key}]}"
-        if [[ -v alsa_preset_value ]]; then
-            MIXER_CONTROL=$alsa_preset_value
-        fi
-        # MIXER INDEX
-        alsa_preset_key="${ALSA_PRESET}.mixer-index"
-        alsa_preset_value="${alsa_presets[${alsa_preset_key}]}"
-        if [[ -v alsa_preset_value ]]; then
-            MIXER_INDEX=$alsa_preset_value
-        fi
-    else
-        echo "Alsa preset has not been specified"
-    fi
-    # if allowed, try to find the mixer
-    echo "ALSA_AUTO_FIND_MIXER=[${ALSA_AUTO_FIND_MIXER}]"
-    if [[ "${ALSA_AUTO_FIND_MIXER^^}" == "YES" || "${ALSA_AUTO_FIND_MIXER^^}" == "Y" ]]; then
-        if [ -z "${MIXER_CONTROL}" ]; then
-            echo "Trying to find mixer ..."
-            MIXER_TYPE="hardware"
-            RAW_MIXER_DEVICE="$(amixer -D ${MPD_AUDIO_DEVICE} scontrols | head -n 1)"
-            echo "RAW_MIXER_DEVICE = [$RAW_MIXER_DEVICE]"
-            mixer=$(echo ${RAW_MIXER_DEVICE} | cut -d "'" -f 2)
-            echo "Mixer=[$mixer]"
-            MIXER_CONTROL=$mixer
-            # assuming mixer device to be same as audio device
-            MIXER_DEVICE=$MPD_AUDIO_DEVICE
-        else    
-            echo "MIXER_CONTROL already set to [${MIXER_CONTROL}]"
-        fi
-    elif [ -z "${ALSA_AUTO_FIND_MIXER}" ]; then
-        echo "ALSA_AUTO_FIND_MIXER not allowed"
-    elif [[ "${ALSA_AUTO_FIND_MIXER^^}" != "NO" && "${ALSA_AUTO_FIND_MIXER^^}" != "N" ]]; then
-        echo "Invalid ALSA_AUTO_FIND_MIXER=[${ALSA_AUTO_FIND_MIXER}]"
-        exit 9
-    fi
-    # fallback to software mixer if MIXER_TYPE is still empty
-    if [ -z "${MIXER_TYPE}" ]; then
-        MIXER_TYPE="software"
-        echo "Falling back to MIXER_TYPE=[$MIXER_TYPE]"
-    fi
-    ## Add alsa output
-    echo "audio_output {" >> $MPD_ALSA_CONFIG_FILE
-    echo "  type \"alsa\"" >> $MPD_ALSA_CONFIG_FILE
-    if [ -z "${ALSA_DEVICE_NAME}" ]; then
-        ALSA_DEVICE_NAME=$DEFAULT_ALSA_DEVICE_NAME
-    fi
-    echo "  name \"${ALSA_DEVICE_NAME}\"" >> $MPD_ALSA_CONFIG_FILE
-    if [ -z "${MPD_AUDIO_DEVICE}" ]; then
-        MPD_AUDIO_DEVICE=$DEFAULT_MPD_AUDIO_DEVICE
-    fi
-    echo "  device \"${MPD_AUDIO_DEVICE}\"" >> $MPD_ALSA_CONFIG_FILE
-    if [ -n "${AUTO_RESAMPLE}" ]; then
-        if [[ "${AUTO_RESAMPLE^^}" == "YES" || "${AUTO_RESAMPLE^^}" == "Y" ]]; then
-            AUTO_RESAMPLE=yes
-        elif [[ "${AUTO_RESAMPLE^^}" == "NO" || "${AUTO_RESAMPLE^^}" == "N" ]]; then
-            AUTO_RESAMPLE=no
-        else
-            echo "Invalid configuration for AUTO_RESAMPLE [${AUTO_RESAMPLE}]"
-            exit 6
-        fi
-        echo "  auto_resample \"${AUTO_RESAMPLE}\"" >> $MPD_ALSA_CONFIG_FILE
-    fi
-    if [ -n "${THESYCON_DSD_WORKAROUND}" ]; then
-        if [[ "${THESYCON_DSD_WORKAROUND^^}" == "YES" || "${THESYCON_DSD_WORKAROUND^^}" == "Y" ]]; then
-            THESYCON_DSD_WORKAROUND=yes
-        elif [[ "${THESYCON_DSD_WORKAROUND^^}" == "NO" || "${THESYCON_DSD_WORKAROUND^^}" == "N" ]]; then
-            THESYCON_DSD_WORKAROUND=no
-        else
-            echo "Invalid configuration for THESYCON_DSD_WORKAROUND [${THESYCON_DSD_WORKAROUND}]"
-            exit 7
-        fi
-        echo "  thesycon_dsd_workaround \"${THESYCON_DSD_WORKAROUND}\"" >> $MPD_ALSA_CONFIG_FILE
-    fi
-    if [ -n "${MIXER_TYPE}" ]; then
-        echo "  mixer_type \"${MIXER_TYPE}\"" >> $MPD_ALSA_CONFIG_FILE
-    fi
-    if [ -n "${MIXER_DEVICE}" ]; then
-        echo "  mixer_device \"${MIXER_DEVICE}\"" >> $MPD_ALSA_CONFIG_FILE
-    fi
-    if [ -n "${MIXER_CONTROL}" ]; then
-        echo "  mixer_control \"${MIXER_CONTROL}\"" >> $MPD_ALSA_CONFIG_FILE
-    fi
-    if [ -n "${MIXER_INDEX}" ]; then
-        echo "  mixer_index \"${MIXER_INDEX}\"" >> $MPD_ALSA_CONFIG_FILE
-    fi
-    if [ -n "${ALSA_OUTPUT_FORMAT}" ]; then
-        echo "  format \"${ALSA_OUTPUT_FORMAT}\"" >> $MPD_ALSA_CONFIG_FILE
-    fi
-    if [ -n "${ALSA_ALLOWED_FORMATS_PRESET}" ]; then
-        af_value="${allowed_formats_presets[${ALSA_ALLOWED_FORMATS_PRESET}]}"
-        if [[ -v af_value ]]; then
-            ALSA_ALLOWED_FORMATS=$af_value
-        fi
-    fi
-    if [ -n "${ALSA_ALLOWED_FORMATS}" ]; then
-        echo "  allowed_formats \"${ALSA_ALLOWED_FORMATS}\"" >> $MPD_ALSA_CONFIG_FILE
-    fi
-    if [ -n "${INTEGER_UPSAMPLING}" ]; then
-        echo "  integer_upsampling \"${INTEGER_UPSAMPLING}\"" >> $MPD_ALSA_CONFIG_FILE
-        mpd_binary=$UPSAMPLING_MPD_BINARY
-    fi
-    if [ -n "${DOP}" ]; then
-        echo "  dop \"${DOP}\"" >> $MPD_ALSA_CONFIG_FILE
-    fi
-    echo "  enabled \"yes\"" >> $MPD_ALSA_CONFIG_FILE
-    echo "}" >> $MPD_ALSA_CONFIG_FILE
-elif [ "${OUTPUT_MODE^^}" == "NONE" ]; then
-    echo "OUTPUT_MODE is ${OUTPUT_MODE}, so master output is not created"
-else
-    echo "Invalid output mode [${OUTPUT_MODE}]";
-    exit 2;
-fi
-
 output_by_type_limit=$((${max_outputs_by_type}-1))
 
 ## ALSA output

app/bin/user-management.sh

@@ -1,20 +1,21 @@
 #!/bin/bash
 
 create_audio_gid() {
-    echo "Mode [${OUTPUT_MODE}] Adding $USER_NAME to group audio"
+    echo "ANY_PULSE [$ANY_PULSE] ANY_ALSA [$ANY_ALSA] Running create_audio_gid"
+    echo "  Adding $USER_NAME to group audio"
     if [ $(getent group $AUDIO_GID) ]; then
-        echo "Mode [${OUTPUT_MODE}] Group with gid $AUDIO_GID already exists"
+        echo "  Group with gid $AUDIO_GID already exists"
     else
-        echo "Mode [${OUTPUT_MODE}] Creating group with gid $AUDIO_GID"
+        echo "  Creating group with gid $AUDIO_GID"
         groupadd -g $AUDIO_GID mpd-audio
     fi
-    echo "Mode [${OUTPUT_MODE}] Adding $USER_NAME to gid $AUDIO_GID"
+    echo "  Adding $USER_NAME to gid $AUDIO_GID"
     AUDIO_GRP=$(getent group $AUDIO_GID | cut -d: -f1)
-    echo "gid $AUDIO_GID -> group $AUDIO_GRP"
+    echo "  gid $AUDIO_GID -> group $AUDIO_GRP"
     if id -nG "$USER_NAME" | grep -qw "$AUDIO_GRP"; then
-        echo "Mode [${OUTPUT_MODE}] User $USER_NAME already belongs to group audio (GID ${AUDIO_GID})"
+        echo "  User $USER_NAME already belongs to group audio (GID ${AUDIO_GID})"
     else
         usermod -a -G $AUDIO_GRP $USER_NAME
-        echo "Mode [${OUTPUT_MODE}] AnyPulse [$ANY_PULSE] - Successfully added $USER_NAME to group audio (GID ${AUDIO_GID})"
+        echo "  Successfully added $USER_NAME to group audio (GID ${AUDIO_GID})"
     fi
 }

doc/change-history.md

@@ -2,6 +2,7 @@
 
 Date|Major Changes
 :---|:---
+2023-02-11|Dropped `OUTPUT_MODE` (including *deprecated* `ALSA` mode)
 2023-02-11|Dropped `NULL` as `OUTPUT_MODE`
 2023-02-11|Support additional `NULL` outputs
 2023-02-09|Clarified `legacy` releases

doc/example-configurations.md

@@ -12,7 +12,6 @@ docker run -d \
     --rm \
     --device /dev/snd \
     -p 6600:6600 \
-    -e OUTPUT_MODE=none \
     -e ALSA_OUTPUT_CREATE=yes \
     -v ${HOME}/Music:/music:ro \
     -v ${HOME}/.mpd/playlists:/playlists \
@@ -48,7 +47,6 @@ services:
       - SOXR_PLUGIN_PASSBAND_END=95
       - SOXR_PLUGIN_STOPBAND_BEGIN=105
       - SOXR_PLUGIN_ATTENUATION=4
-      - OUTPUT_MODE=none
       - ALSA_OUTPUT_CREATE=yes
       - ALSA_OUTPUT_NAME=aune-s6
       - ALSA_OUTPUT_DEVICE=hw:DAC
@@ -84,7 +82,6 @@ services:
       - AUDIO_GID=29
       - SOXR_PLUGIN_ENABLE=Y
       - SOXR_PLUGIN_PRESET=goldilocks
-      - OUTPUT_MODE=none
       - ALSA_OUTPUT_CREATE=yes
       - ALSA_OUTPUT_NAME=aune-s6
       - ALSA_OUTPUT_DEVICE=hw:DAC
@@ -117,7 +114,6 @@ docker run -d \
     --rm \
     --device /dev/snd \
     -p 6600:6600 \
-    -e OUTPUT_MODE=none \
     -e PULSE_AUDIO_OUTPUT_CREATE=yes \
     -v ${HOME}/Music:/music:ro \
     -v ${HOME}/.mpd/playlists:/playlists \

pulse/mpd-pulse.service

@@ -13,7 +13,6 @@ ExecStart=/usr/bin/docker run -i \
             --network=mpd-pulse \
             -e PUID=%U \
             -e PGID=%G \
-            -e OUTPUT_MODE=none \
             -e PULSE_AUDIO_OUTPUT_CREATE=yes \
             -v /run/user/%U/pulse:/run/user/%U/pulse \
             -v %h/Music:/music:ro \