Bump selkies, fix Linux IME bug, fallback to jpeg on hosts that require it, fix spacebar not working for some games, #113 launch to set resolution for app, cleanup lock files for xorg and dbus before launching, update readme regarding virtual display clamping

Author: thelamer

Dockerfile

@@ -16,7 +16,7 @@ RUN \
     https://github.com/selkies-project/selkies.git \
     /src && \
   cd /src && \
-  git checkout -f 0fab9f9c41354cbb0e782604b0c3c511842a3289
+  git checkout -f c3cf4cc2a3b6984104e494572b232730883c9aa6
 
 RUN \
   echo "**** build shared core library ****" && \
@@ -190,7 +190,7 @@ RUN \
     | awk '/tag_name/{print $4;exit}' FS='[""]') && \
   curl -o \
     /tmp/selkies.tar.gz -L \
-    "https://github.com/selkies-project/selkies/archive/0fab9f9c41354cbb0e782604b0c3c511842a3289.tar.gz" && \
+    "https://github.com/selkies-project/selkies/archive/c3cf4cc2a3b6984104e494572b232730883c9aa6.tar.gz" && \
   cd /tmp && \
   tar xf selkies.tar.gz && \
   cd selkies-* && \

Dockerfile.aarch64

@@ -16,7 +16,7 @@ RUN \
     https://github.com/selkies-project/selkies.git \
     /src && \
   cd /src && \
-  git checkout -f 0fab9f9c41354cbb0e782604b0c3c511842a3289
+  git checkout -f c3cf4cc2a3b6984104e494572b232730883c9aa6
 
 RUN \
   echo "**** build shared core library ****" && \
@@ -188,7 +188,7 @@ RUN \
     | awk '/tag_name/{print $4;exit}' FS='[""]') && \
   curl -o \
     /tmp/selkies.tar.gz -L \
-    "https://github.com/selkies-project/selkies/archive/0fab9f9c41354cbb0e782604b0c3c511842a3289.tar.gz" && \
+    "https://github.com/selkies-project/selkies/archive/c3cf4cc2a3b6984104e494572b232730883c9aa6.tar.gz" && \
   cd /tmp && \
   tar xf selkies.tar.gz && \
   cd selkies-* && \

README.md

@@ -249,6 +249,21 @@ curl -X POST http://localhost:8083/tokens \
 
 Clients in this mode must connect with a valid token (`?token=...`) to establish a WebSocket connection.
 
+### All GPU Acceleration - use sane resolutions
+
+When using 3d acceleration via Nvidia DRM or DRI3 it is important to clamp the virtual display to a reasonable max resolution. This can be achieved with the environment setting: 
+
+* `-e MAX_RESOLUTION=3840x2160`
+
+This will set the total virtual framebuffer to 4K, you can also set a manual resolution to achieve this.
+By default the virtual monitor in the session is 16K to support large monitors and dual display configurations. Leaving it this large has no impact on CPU based performance but costs GPU memory usage and memory bandwidth when leveraging one for acceleration. If you have performance issues in an accelerated session, try clamping the resolution to 1080p and work up from there:
+
+```
+-e SELKIES_MANUAL_WIDTH=1920
+-e SELKIES_MANUAL_HEIGHT=1080
+-e MAX_RESOLUTION=1920x1080
+```
+
 ### DRI3 GPU Acceleration
 
 For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using:

readme-vars.yml

@@ -253,6 +253,21 @@ full_custom_readme: |
  
   Clients in this mode must connect with a valid token (`?token=...`) to establish a WebSocket connection.
 
+  ### All GPU Acceleration - use sane resolutions
+
+  When using 3d acceleration via Nvidia DRM or DRI3 it is important to clamp the virtual display to a reasonable max resolution. This can be achieved with the environment setting: 
+
+  * `-e MAX_RESOLUTION=3840x2160`
+
+  This will set the total virtual framebuffer to 4K, you can also set a manual resolution to achieve this.
+  By default the virtual monitor in the session is 16K to support large monitors and dual display configurations. Leaving it this large has no impact on CPU based performance but costs GPU memory usage and memory bandwidth when leveraging one for acceleration. If you have performance issues in an accelerated session, try clamping the resolution to 1080p and work up from there:
+
+  ```
+  -e SELKIES_MANUAL_WIDTH=1920
+  -e SELKIES_MANUAL_HEIGHT=1080
+  -e MAX_RESOLUTION=1920x1080
+  ```
+
   ### DRI3 GPU Acceleration
 
   For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using:

root/etc/s6-overlay/s6-rc.d/svc-dbus/run

@@ -3,6 +3,7 @@
 # Folder setup
 mkdir -p /run/dbus
 chown abc:abc /run/dbus
+rm -f /run/dbus/pid
 
 # Run dbus
 exec s6-setuidgid abc \

root/etc/s6-overlay/s6-rc.d/svc-de/run

@@ -8,11 +8,18 @@ while true; do
   sleep .5
 done
 
-# set sane resolution before starting apps
-if ! s6-setuidgid abc xrandr | grep -q "1024x768"; then
-  s6-setuidgid abc xrandr --newmode "1024x768" 63.50  1024 1072 1176 1328  768 771 775 798 -hsync +vsync
-  s6-setuidgid abc xrandr --addmode screen "1024x768"
-  s6-setuidgid abc xrandr --output screen --mode "1024x768" --dpi 96
+# set resolution before starting apps
+RESOLUTION_WIDTH=${SELKIES_MANUAL_WIDTH:-1024}
+RESOLUTION_HEIGHT=${SELKIES_MANUAL_HEIGHT:-768}
+if [ "$RESOLUTION_WIDTH" = "0" ]; then RESOLUTION_WIDTH=1024; fi
+if [ "$RESOLUTION_HEIGHT" = "0" ]; then RESOLUTION_HEIGHT=768; fi
+MODELINE=$(s6-setuidgid abc cvt "${RESOLUTION_WIDTH}" "${RESOLUTION_HEIGHT}" | grep "Modeline" | sed 's/^.*Modeline //')
+MODELINE_ARGS=$(echo "$MODELINE" | tr -d '"')
+MODELINE_NAME=$(echo "$MODELINE_ARGS" | awk '{print $1}')
+if ! s6-setuidgid abc xrandr | grep -q "$MODELINE_NAME"; then
+  s6-setuidgid abc xrandr --newmode $MODELINE_ARGS
+  s6-setuidgid abc xrandr --addmode screen "$MODELINE_NAME"
+  s6-setuidgid abc xrandr --output screen --mode "$MODELINE_NAME" --dpi 96
 fi
 
 # set xresources

root/etc/s6-overlay/s6-rc.d/svc-xorg/run

@@ -1,5 +1,8 @@
 #!/usr/bin/with-contenv bash
 
+# Cleanup
+rm -f /tmp/.X1-lock
+
 # Enable DRI3 support if detected
 VFBCOMMAND=""
 if ! which nvidia-smi && [ -e "/dev/dri/renderD128" ]; then
@@ -11,10 +14,19 @@ fi
 if [ "${DISABLE_DRI3}" != "false" ]; then
   VFBCOMMAND=""
 fi
+
+# Clamp virtual screen max size based on env
 DEFAULT_RES="15360x8640"
 if [ ! -z ${MAX_RES+x} ]; then
   DEFAULT_RES="${MAX_RES}"
 fi
+if [ -n "${SELKIES_MANUAL_HEIGHT}" ] || [ -n "${SELKIES_MANUAL_WIDTH}" ]; then
+  T_WIDTH="${SELKIES_MANUAL_WIDTH:-1024}"
+  T_HEIGHT="${SELKIES_MANUAL_HEIGHT:-768}"
+  if [ "${T_WIDTH}" = "0" ]; then T_WIDTH="1024"; fi
+  if [ "${T_HEIGHT}" = "0" ]; then T_HEIGHT="768"; fi
+  DEFAULT_RES="${T_WIDTH}x${T_HEIGHT}"
+fi
 
 # Run Xvfb server with required extensions
 exec s6-setuidgid abc \