Merge pull request #85 from scottyhardy/feature/dummy_pulseaudio

Feature/dummy pulseaudio Resolves #82
scottyhardy · Jul 21, 2020 · 96378f4 · 96378f4
2 parents ebfb214 + c35809f
commit 96378f4
Show file tree

Hide file tree

Showing 4 changed files with 91 additions and 29 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -12,6 +12,7 @@ RUN apt-get update \
         gosu \
         gpg-agent \
         p7zip \
+        pulseaudio \
         pulseaudio-utils \
         software-properties-common \
         tzdata \

diff --git a/README.md b/README.md
@@ -259,5 +259,5 @@ To test video, try opening Notepad:
 To test sound, try using `pacat`:
 
 ```bash
-./docker-wine pacat -vv /dev/random
+./docker-wine pacat -vv /dev/urandom
 ```
diff --git a/docker-wine b/docker-wine
@@ -42,6 +42,17 @@ print_help () {
     echo "                          RESOLUTION     Screen resolution, eg. 320x240x8"
     echo "                        If OPTIONAL is left blank, defaults to:"
     echo "                          :95,0,320x240x8"
+    echo "  --sound=OPTION        Select a pulseaudio configuration for sound output when"
+    echo "                          running in X11 forwarding mode"
+    echo "                        Valid values for OPTION are:"
+    echo "                          default        Use the default pulseaudio config for"
+    echo "                                           host OS (unix is default for Linux,"
+    echo "                                           dummy is default for macOS)"
+    echo "                          unix           Use UNIX socket '/tmp/pulse-socket' to"
+    echo "                                           connect to the host machine's"
+    echo "                                           pulseaudio server (Linux only)"
+    echo "                          dummy          Run pulseaudio server in container with"
+    echo "                                           dummy output"
     echo "  --home-volume=VALUE   Use an alternate volume to winehome for storing"
     echo "                          persistent user data. Valid values can specify either"
     echo "                          a docker volume or local path"
@@ -224,6 +235,71 @@ add_x11_key () {
     add_run_arg --volume="${HOME}/.docker-wine.Xkey:/root/.Xkey:ro"
 }
 
+configure_sound () {
+    local os="$1"
+
+    case "${os}" in
+        linux)
+            if [ "${SOUND}" == "default" ]; then
+                SOUND="unix"
+            fi
+            ;;
+        macos)
+            if [ "${SOUND}" == "default" ]; then
+                SOUND="dummy"
+            fi
+            ;;
+        *)
+            echo "ERROR: '${os}' is not a valid OS string for configuring sound"
+            exit 1
+            ;;
+    esac
+
+    case "${SOUND}" in
+        unix)
+            configure_pulseaudio_unix_socket
+            ;;
+        dummy)
+            add_run_arg --env="DUMMY_PULSEAUDIO=yes"
+            ;;
+        *)
+            echo "ERROR: '${SOUND}' is not a valid option for configuring sound"
+            exit 1
+            ;;
+    esac
+}
+
+configure_pulseaudio_unix_socket () {
+
+    # Use audio if pulseaudio is installed
+    if command -v pulseaudio >/dev/null 2>&1; then
+
+        # One-off setup for creation of UNIX socket for pulseaudio to allow access for other users
+        if [ ! -f "${HOME}/.config/pulse/default.pa" ]; then
+            echo "INFO: Creating pulseaudio config file ${HOME}/.config/pulse/default.pa"
+            mkdir -p "${HOME}/.config/pulse"
+            echo -e ".include /etc/pulse/default.pa\nload-module module-native-protocol-unix auth-anonymous=1 socket=/tmp/pulse-socket" > "${HOME}/.config/pulse/default.pa"
+        fi
+
+        # Restart pulseaudio daemon to create the UNIX socket
+        if [ ! -e "/tmp/pulse-socket" ]; then
+            echo "INFO: No socket found for pulseaudio so restarting service..."
+            pulseaudio -k
+            pulseaudio --start
+            sleep 1
+        fi
+
+        # Add the pulseaudio UNIX socket to run args
+        if [ -e "/tmp/pulse-socket" ]; then
+            add_run_arg --volume="/tmp/pulse-socket:/tmp/pulse-socket"
+        else
+            echo "INFO: pulseaudio socket /tmp/pulse-socket doesn't exist, so sound will not function"
+        fi
+    else
+        echo "INFO: pulseaudio not installed so running without sound"
+    fi
+}
+
 run_container () {
     local mode
 
@@ -290,6 +366,7 @@ LOCAL_IMAGE="docker-wine"
 NO_RDP="no"
 NOTTY="no"
 SHM_SIZE="1g"
+SOUND="default"
 USE_LOCAL_IMAGE="no"
 USE_RDP_SERVER="no"
 USER_HOME="/home/wineuser"
@@ -353,6 +430,9 @@ while [ $# -gt 0 ]; do
         USE_XVFB="yes"
         IFS=, read -r XVFB_SERVER XVFB_SCREEN XVFB_RESOLUTION <<< "${1#*=}"
         ;;
+    --sound=*)
+        SOUND="${1#*=}"
+        ;;
     --home-volume=*)
         USER_VOLUME="${1#*=}"
 
@@ -484,6 +564,9 @@ else
         # Store the X11 key for the display in ~/.docker-wine.Xkey and add to run args
         add_x11_key ":0"
 
+        # Configure sound output
+        configure_sound "macos"
+
         # Add macOS run args
         add_run_arg --env="DISPLAY=host.docker.internal:0"
 
@@ -495,33 +578,8 @@ else
         # Store the X11 key for the display in ~/.docker-wine.Xkey and add to run args
         add_x11_key "$DISPLAY"
 
-        # Use audio if pulseaudio is installed
-        if command -v pulseaudio >/dev/null 2>&1; then
-
-            # One-off setup for creation of UNIX socket for pulseaudio to allow access for other users
-            if [ ! -f "${HOME}/.config/pulse/default.pa" ]; then
-                echo "INFO: Creating pulseaudio config file ${HOME}/.config/pulse/default.pa"
-                mkdir -p "${HOME}/.config/pulse"
-                echo -e ".include /etc/pulse/default.pa\nload-module module-native-protocol-unix auth-anonymous=1 socket=/tmp/pulse-socket" > "${HOME}/.config/pulse/default.pa"
-            fi
-
-            # Restart pulseaudio daemon to create the UNIX socket
-            if [ ! -e "/tmp/pulse-socket" ]; then
-                echo "INFO: No socket found for pulseaudio so restarting service..."
-                pulseaudio -k
-                pulseaudio --start
-                sleep 1
-            fi
-
-            # Add the pulseaudio UNIX socket to run args
-            if [ -e "/tmp/pulse-socket" ]; then
-                add_run_arg --volume="/tmp/pulse-socket:/tmp/pulse-socket"
-            else
-                echo "INFO: pulseaudio socket /tmp/pulse-socket doesn't exist, so sound will not function"
-            fi
-        else
-            echo "INFO: pulseaudio not installed so running without sound"
-        fi
+        # Configure sound output
+        configure_sound "linux"
 
         # Add Linux run args
         add_run_arg --env="DISPLAY"

diff --git a/entrypoint.sh b/entrypoint.sh
@@ -20,6 +20,7 @@ RUN_AS_ROOT=${RUN_AS_ROOT:-no}
 FORCED_OWNERSHIP=${FORCED_OWNERSHIP:-no}
 TZ=${TZ:-UTC}
 USE_XVFB=${USE_XVFB:-no}
+DUMMY_PULSEAUDIO=${DUMMY_PULSEAUDIO:-no}
 
 # Create the user account
 ! grep -q ":${USER_GID}:$" /etc/group && groupadd --gid "${USER_GID}" "${USER_NAME}"
@@ -47,7 +48,9 @@ ln -snf "/usr/share/zoneinfo/${TZ}" /etc/localtime && echo "${TZ}" > /etc/timezo
 if is_disabled "${RDP_SERVER}"; then
 
     # Set up pulseaudio for redirection to UNIX socket
-    [ -f /root/pulse/client.conf ] && cp /root/pulse/client.conf /etc/pulse/client.conf
+    if is_disabled "${DUMMY_PULSEAUDIO}"; then
+        [ -f /root/pulse/client.conf ] && cp /root/pulse/client.conf /etc/pulse/client.conf
+    fi
 
     # Run xvfb
     if is_enabled "${USE_XVFB}"; then