Support alsa equal (#340)

* Install libasound2-plugin-equal along with libasound2

* Install libasound2-plugin-equal in more builds (standard alsa and full)

* Add alsa-utils

* Add equalizer.md document

* Fix some Dockerfile issues

* Autogenerate asound config file, take #1

* Autogenerate asound config file, add formatting and dump generate file

* Doesn't work if container is not running as root

* #338 improvements, an asound.conf is now not strictly required (though it might be useful)

Author: GioF71

Dockerfile

@@ -1,5 +1,5 @@
 ARG BASE_IMAGE
-FROM ${BASE_IMAGE} AS BASE
+FROM ${BASE_IMAGE:-debian:stable-slim} AS base
 # BUILD_MODE: [ std, sf, r2, bt ]
 ARG BUILD_MODE
 # BINARY_MODE: [ "full", "pulse", "alsa", "alsa-bt" ]
@@ -56,7 +56,7 @@ RUN rm -rf /var/lib/apt/lists/*
 RUN rm -Rf /app/install
 
 FROM scratch
-COPY --from=BASE / /
+COPY --from=base / /
 
 LABEL maintainer="GioF71"
 LABEL source="https://github.com/GioF71/squeezelite-docker"
@@ -67,57 +67,59 @@ RUN mkdir -p /app/conf
 RUN mkdir -p /app/doc
 RUN mkdir -p /app/assets
 
-ENV SQUEEZELITE_MODE ""
-ENV SQUEEZELITE_AUDIO_DEVICE ""
-ENV SQUEEZELITE_MIXER_DEVICE ""
-ENV SQUEEZELITE_MAC_ADDRESS ""
-ENV DISABLE_MAC_ADDRESS_GENERATION ""
-ENV SQUEEZELITE_NAME ""
-ENV SQUEEZELITE_MODEL_NAME ""
-ENV SQUEEZELITE_TIMEOUT ""
-ENV SQUEEZELITE_DELAY ""
-
-ENV STARTUP_DELAY_SEC ""
-
-ENV SQUEEZELITE_SERVER_PORT ""
-
-ENV SQUEEZELITE_RATES ""
-ENV SQUEEZELITE_UPSAMPLING ""
-
-ENV PRESET ""
-
-ENV SQUEEZELITE_PARAMS ""
-ENV SQUEEZELITE_CODECS ""
-ENV SQUEEZELITE_EXCLUDE_CODECS ""
-ENV SQUEEZELITE_PRIORITY ""
-ENV SQUEEZELITE_STREAM_AND_OUTPUT_BUFFER_SIZE ""
-ENV SQUEEZELITE_BUFFER_SIZE ""
-ENV SQUEEZELITE_UNMUTE ""
-ENV SQUEEZELITE_VOLUME_CONTROL ""
-ENV SQUEEZELITE_LINEAR_VOLUME ""
-ENV SQUEEZELITE_VISUALIZER ""
-ENV SQUEEZELITE_READ_FORMATS_FROM_HEADER ""
-
-ENV SQUEEZELITE_LOG_CATEGORY_ALL ""
-ENV SQUEEZELITE_LOG_CATEGORY_SLIMPROTO ""
-ENV SQUEEZELITE_LOG_CATEGORY_STREAM ""
-ENV SQUEEZELITE_LOG_CATEGORY_DECODE ""
-ENV SQUEEZELITE_LOG_CATEGORY_OUTPUT ""
-ENV SQUEEZELITE_LOG_CATEGORY_IR ""
+ENV SQUEEZELITE_MODE=""
+ENV SQUEEZELITE_EQ_AUDIO_DEVICE=""
+ENV SQUEEZELITE_AUDIO_DEVICE=""
+ENV SQUEEZELITE_EQ_AUDIO_DEVICE=""
+ENV SQUEEZELITE_MIXER_DEVICE=""
+ENV SQUEEZELITE_MAC_ADDRESS=""
+ENV DISABLE_MAC_ADDRESS_GENERATION=""
+ENV SQUEEZELITE_NAME=""
+ENV SQUEEZELITE_MODEL_NAME=""
+ENV SQUEEZELITE_TIMEOUT=""
+ENV SQUEEZELITE_DELAY=""
+
+ENV STARTUP_DELAY_SEC=""
+
+ENV SQUEEZELITE_SERVER_PORT=""
+
+ENV SQUEEZELITE_RATES=""
+ENV SQUEEZELITE_UPSAMPLING=""
+
+ENV PRESET=""
+
+ENV SQUEEZELITE_PARAMS=""
+ENV SQUEEZELITE_CODECS=""
+ENV SQUEEZELITE_EXCLUDE_CODECS=""
+ENV SQUEEZELITE_PRIORITY=""
+ENV SQUEEZELITE_STREAM_AND_OUTPUT_BUFFER_SIZE=""
+ENV SQUEEZELITE_BUFFER_SIZE=""
+ENV SQUEEZELITE_UNMUTE=""
+ENV SQUEEZELITE_VOLUME_CONTROL=""
+ENV SQUEEZELITE_LINEAR_VOLUME=""
+ENV SQUEEZELITE_VISUALIZER=""
+ENV SQUEEZELITE_READ_FORMATS_FROM_HEADER=""
+
+ENV SQUEEZELITE_LOG_CATEGORY_ALL=""
+ENV SQUEEZELITE_LOG_CATEGORY_SLIMPROTO=""
+ENV SQUEEZELITE_LOG_CATEGORY_STREAM=""
+ENV SQUEEZELITE_LOG_CATEGORY_DECODE=""
+ENV SQUEEZELITE_LOG_CATEGORY_OUTPUT=""
+ENV SQUEEZELITE_LOG_CATEGORY_IR=""
 
 ENV SQUEEZELITE_POWER_SCRIPT=""
 ENV SQUEEZELITE_RPI_GPIO=""
 
-ENV DISPLAY_PRESETS ""
+ENV DISPLAY_PRESETS=""
 
-ENV PUID ""
-ENV PGID ""
-ENV AUDIO_GID ""
+ENV PUID=""
+ENV PGID=""
+ENV AUDIO_GID=""
 
-ENV SELECT_CUSTOM_BINARY_ALSA ""
-ENV SELECT_CUSTOM_BINARY_PULSE ""
+ENV SELECT_CUSTOM_BINARY_ALSA=""
+ENV SELECT_CUSTOM_BINARY_PULSE=""
 
-ENV INSTALL_BLUETOOTH_LIBRARIES ""
+ENV INSTALL_BLUETOOTH_LIBRARIES=""
 
 COPY app/bin/run-squeezelite.sh /app/bin/
 COPY app/bin/run-squeezelite-alsa.sh /app/bin/

README.md

@@ -94,6 +94,7 @@ PUID||User ID which will be used to run squeezelite in user mode, defaults to `1
 PGID||Group ID which will be used to run squeezelite in user mode, defaults to `1000`
 AUDIO_GID||This group id is mandatory with alsa output when running in user mode. It must be set to the group id associated to the `audio` group. See more [here](https://github.com/GioF71/squeezelite-docker/blob/main/doc/example-alsa-user-mode.md).
 PRESET||You can now choose to set variables using predefined presets. Presets can currently tune the values of `SQUEEZELITE_AUDIO_DEVICE`, `SQUEEZELITE_RATES`, `SQUEEZELITE_UPSAMPLING`, `SQUEEZELITE_CODECS` and `SQUEEZELITE_EXCLUDE_CODECS` for you. See the [Available presets](#available-presets) table for reference. Presets can be combined (the separator must be a comma `,`), but keep in mind that the first preset setting a variable has the priority: once set by a preset, a variable cannot be overwritten by subsequent presets.
+SQUEEZELITE_EQ_AUDIO_DEVICE||The Audio device used for the custom asound file for equalizer. Use something like `plughw:DAC`, `plughw:0` depending on your hardware. Leave `SQUEEZELITE_AUDIO_DEVICE` blank or set it to `equal`
 SQUEEZELITE_AUDIO_DEVICE|-o|The audio device. Common examples for alsa mode: `hw:CARD=x20,DEV=0` or `hw:CARD=DAC,DEV=0` for usb dac based on XMOS. If left empty, the default device is used.
 SQUEEZELITE_MIXER_DEVICE|-O|Specify mixer device, defaults to `output device` (`SQUEEZELITE_AUDIO_DEVICE`)
 SQUEEZELITE_PARAMS|-a|Please refer to the squeezelite's man page for `-a`.

app/assets/sample.CARD_DAC.asound.conf

@@ -0,0 +1,13 @@
+ctl.equal {
+    type equal;
+}
+ 
+pcm.plugequal {
+    type equal;
+    slave.pcm "plughw:DAC";
+}
+ 
+pcm.equal {
+    type plug;
+    slave.pcm plugequal;
+}

app/assets/sample.CARD_DAC_Device_0.asound.conf

@@ -0,0 +1,13 @@
+ctl.equal {
+    type equal;
+}
+ 
+pcm.plugequal {
+    type equal;
+    slave.pcm "plughw:CARD=DAC,DEVICE=0";
+}
+ 
+pcm.equal {
+    type plug;
+    slave.pcm plugequal;
+}

app/bin/run-squeezelite-alsa.sh

@@ -165,6 +165,15 @@ else
   echo "Final SQUEEZELITE_VOLUME_CONTROL = $SQUEEZELITE_VOLUME_CONTROL"
 fi
 
+if [[ -n "${SQUEEZELITE_EQ_AUDIO_DEVICE}" ]]; then
+    echo "SQUEEZELITE_EQ_AUDIO_DEVICE has been set to [${SQUEEZELITE_EQ_AUDIO_DEVICE}]"
+    if [[ -z "${SQUEEZELITE_AUDIO_DEVICE}" ]]; then
+        echo "SQUEEZELITE_AUDIO_DEVICE empty, setting to 'equal'"
+        SQUEEZELITE_AUDIO_DEVICE=equal
+    fi
+fi
+
+
 cmdline-server-port
 cmdline-player-name
 cmdline-model-name
@@ -345,6 +354,35 @@ fi
 handle_mac_address
 cmdline_mac_address
 
+# write /etc/asound.conf or ~/.asoundrc if needed
+if [[ -n "${SQUEEZELITE_EQ_AUDIO_DEVICE}" ]]; then
+    echo "SQUEEZELITE_EQ_AUDIO_DEVICE has been set to [${SQUEEZELITE_EQ_AUDIO_DEVICE}], creating custom asound file"
+    ASOUND_FILE_NAME=/etc/asound.conf
+    if [[ $current_user_id != 0 ]]; then
+        # user mode, file will be ~/.asoundrc
+        echo "Cannot create custom asound.conf file when running with user [$current_user_id] ..."
+        exit 5
+    fi
+    echo "ASOUND_FILE_NAME=${ASOUND_FILE_NAME}"
+    # write content
+    echo "# custom asound file for eq mode" > $ASOUND_FILE_NAME
+    echo "ctl.equal {" >> $ASOUND_FILE_NAME
+    echo "type equal" >> $ASOUND_FILE_NAME
+    echo "}" >> $ASOUND_FILE_NAME
+    echo "pcm.plugequal {" >> $ASOUND_FILE_NAME
+    echo "  type equal;" >> $ASOUND_FILE_NAME
+    echo "  slave.pcm \"${SQUEEZELITE_EQ_AUDIO_DEVICE}\";" >> $ASOUND_FILE_NAME
+    echo "}" >>  $ASOUND_FILE_NAME
+    echo "pcm.equal {" >> $ASOUND_FILE_NAME
+    echo "type plug;" >> $ASOUND_FILE_NAME
+    echo "slave.pcm plugequal;" >> $ASOUND_FILE_NAME
+    echo "}" >> $ASOUND_FILE_NAME
+    # show the generated file
+    echo "--- BEGIN $ASOUND_FILE_NAME ---"
+    cat $ASOUND_FILE_NAME
+    echo "--- END $ASOUND_FILE_NAME ---"
+fi
+
 echo "Command Line: ["$CMD_LINE"]"
 
 if [[ $actual_user_mode -eq 1 ]]; then

doc/equalizer.md

@@ -6,29 +6,6 @@ Look at [this](https://forums.lyrion.org/forum/user-forums/general-discussion/17
 
 ## Example configuration
 
-### Custom asound.conf file
-
-Create a file (it's not required it to be at /etc/asound.conf), similar to the following:
-
-```text
-ctl.equal {
-    type equal;
-}
- 
-pcm.plugequal {
-    type equal;
-    slave.pcm "plughw:DAC";
-}
- 
-pcm.equal {
-    type plug;
-    slave.pcm plugequal;
-}
-```
-
-Replace the line that says `slave.pcm "plughw:DAC"` with your dac information. You might need to set something like `slave.pcm "plughw:0"`, `slave.pcm "plughw:1,0"`. YMMV.  
-Save the file as (e.g.) eq-asound.conf in the same directory where you are going to save your docker-compose.yaml file.
-
 ### Compose file
 
 A simple compose file should look like the following:
@@ -44,16 +21,16 @@ services:
       - PUID=1000
       - PGID=1000
       - AUDIO_GID=29
-      - SQUEEZELITE_AUDIO_DEVICE=equal
+      - SQUEEZELITE_EQ_AUDIO_DEVICE=plughw:CARD=DAC,DEVICE=0
       - SQUEEZELITE_NAME=Aune X1S
       - SQUEEZELITE_MODEL_NAME=Aune X1S Manjaro i5
       - SQUEEZELITE_SERVER_PORT=${SQUEEZELITE_SERVER_PORT:-}
-    volumes:
-      - ./eq-asound.conf:/etc/asound.conf:ro
     restart: unless-stopped
 ```
 
-I am using the typical values for PUID, PGID and AUDIO_GID. Again, this depends on your setup. Retrieve the id of the audio group using:
+There is no need to mount a custom file as `/etc/asound.conf`. The file is generated automatically.  
+Tune the content of the variable `SQUEEZELITE_EQ_AUDIO_DEVICE` according to your audio device. Refer to the output of `aplay -l`.  
+For PUID, PGID and AUDIO_GID, I am using typical values in my example. Again, this depends on your setup. Retrieve the id of the audio group using:
 
 ```text
 getent group audio

doc/release.md

@@ -10,6 +10,7 @@ Older build might be dropped in order to save space on docker-hub and incur in l
 
 Date|Type|Description
 :---|:---|:---
+2025-06-30|Improvement|Complete support for alsa equalizer plugin, we do not require to create a custom asound.conf file anymore (see [#338](https://github.com/GioF71/squeezelite-docker/issues/338))
 2025-06-28|Improvement|Add support for alsa equalizer plugin (see [#338](https://github.com/GioF71/squeezelite-docker/issues/338))
 2025-06-26|Update|Sourceforge binaries version bump (see [#336](https://github.com/GioF71/squeezelite-docker/issues/336))
 2025-04-07|Update|Sourceforge binaries version bump (see [#334](https://github.com/GioF71/squeezelite-docker/issues/334))