This squashed commit comprises a long series of improvements, bug fixes, optimizations, and new feature additions:

- 48,000 frames per second operation,
 - 48k lossless stereo, 5.1 and 7.1 surround sound
 - Multichannel and multi rate operation on ALSA, PipeWire, PulseAudio, FreeBSD, stdout and unix pipe output backends.

Automatic, flexible and controllable output format (rate, sample format and channel count) selection.

Full FFmpeg integration to support transcoding, resampling, and new audio formats.

Better operation on lower powered devices down to e.g. Raspberry Pi B.

Reduced Docker image sizes with a slimmed-down FFmpeg library.

Enhanced timestamp handling for better synchronization.

Improved the sync error calculation.

A new "vernier" resampling and interpolation method for low-power CPUs.

Bug fixes and minor enhancements.

Note -- there are many breaking changes from previous versions of Shairport Sync!
This commit is contained in:
Mike Brady
2025-02-23 13:31:17 +00:00
parent 588e6a5b7b
commit 60143518c2
110 changed files with 12416 additions and 7759 deletions
+100 -73
View File
@@ -1,44 +1,51 @@
ARG NQPTP_BRANCH=main
ARG FFMPEG_BRANCH=release/7.1
ARG SHAIRPORT_SYNC_BRANCH=.
ARG ALPINE_VERSION=20250108
FROM alpine:3.20 AS builder
RUN apk -U add \
alsa-lib-dev \
autoconf \
automake \
avahi-dev \
build-base \
dbus \
ffmpeg-dev \
git \
libconfig-dev \
libgcrypt-dev \
libplist-dev \
libressl-dev \
libsndfile-dev \
libsodium-dev \
libtool \
pipewire-dev \
mosquitto-dev \
popt-dev \
pulseaudio-dev \
soxr-dev \
xxd
##### ALAC #####
FROM builder AS alac
RUN git clone --depth=1 https://github.com/mikebrady/alac
WORKDIR /alac
RUN autoreconf -i
RUN ./configure
##### FFMPEGLITE #####
FROM alpine:$ALPINE_VERSION AS ffmpeglite
RUN apk -U add build-base git nasm pkgconf
RUN mkdir -p /ffmpeg_sources /ffmpeg_build
WORKDIR /ffmpeg_sources
ARG FFMPEG_BRANCH
RUN git clone --depth=1 -b "$FFMPEG_BRANCH" https://git.ffmpeg.org/ffmpeg.git
WORKDIR /ffmpeg_sources/ffmpeg
RUN ./configure \
--prefix="/ffmpeg_build" \
--extra-libs="-lpthread -lm" \
--ld="g++" \
--disable-static \
--enable-shared \
--enable-gpl \
--disable-programs \
--disable-everything \
--disable-doc \
--disable-iconv \
--disable-avdevice \
--disable-avfilter \
--disable-swscale \
--disable-network \
--disable-iamf \
--disable-pixelutils \
--disable-postproc \
--enable-decoder=alac \
--enable-decoder=aac
RUN make -j $(nproc)
RUN make install
WORKDIR /
##### ALAC END #####
##### FFMPEGLITE END #####
##### NQPTP #####
FROM builder AS nqptp
FROM alpine:$ALPINE_VERSION AS nqptp
RUN apk -U add \
musl-dev \
autoconf \
automake \
build-base \
git \
linux-headers
ARG NQPTP_BRANCH
RUN git clone --depth=1 -b "$NQPTP_BRANCH" https://github.com/mikebrady/nqptp
WORKDIR /nqptp
@@ -49,19 +56,52 @@ WORKDIR /
##### NQPTP END #####
##### SPS #####
# Note: apple-alac requires alac build first.
FROM alac AS shairport-sync
ARG SHAIRPORT_SYNC_BRANCH
FROM alpine:$ALPINE_VERSION AS shairport-sync
RUN apk -U add \
pkgconf \
alsa-lib-dev \
autoconf \
automake \
avahi-dev \
build-base \
dbus \
git \
libconfig-dev \
libgcrypt-dev \
libplist-dev \
openssl-dev \
libsndfile-dev \
libsodium-dev \
libtool \
pipewire-dev \
mosquitto-dev \
popt-dev \
pulseaudio-dev \
soxr-dev \
libplist-util \
xxd
ARG SHAIRPORT_SYNC_BRANCH
WORKDIR /shairport-sync
COPY . .
RUN git checkout "$SHAIRPORT_SYNC_BRANCH"
RUN rm -rf build
# the above three lines or the following...
# RUN git clone --depth=1 -b "SHAIRPORT_SYNC_BRANCH" https://github.com/mikebrady/sps-private shairport-sync
COPY --from=ffmpeglite /ffmpeg_build/lib/ /usr/local/lib
COPY --from=ffmpeglite /ffmpeg_build/lib/pkgconfig/*.pc /usr/local/lib/pkgconfig/
COPY --from=ffmpeglite /ffmpeg_build/include/ /usr/local/include
# RUN git checkout "$SHAIRPORT_SYNC_BRANCH"
# the following is to remove any build directory that might be there
# not needed if the source is a clone of the repository
# RUN rm -rf build
WORKDIR /shairport-sync/build
RUN autoreconf -i ../
RUN CFLAGS="-O3" CXXFLAGS="-O3" ../configure --sysconfdir=/etc --with-alsa --with-pa --with-soxr --with-avahi --with-ssl=openssl \
RUN ../configure --sysconfdir=/etc --with-alsa --with-pulseaudio --with-soxr --with-avahi --with-ssl=openssl \
--with-airplay-2 --with-metadata --with-dummy --with-pipe --with-dbus-interface \
--with-stdout --with-mpris-interface --with-mqtt-client \
--with-apple-alac --with-convolution --with-pw
--with-convolution --with-pipewire
RUN make -j $(nproc)
RUN DESTDIR=install make install
WORKDIR /
@@ -72,17 +112,15 @@ FROM scratch AS files
# Add run script that will start SPS
COPY --chmod=755 ./docker/run.sh ./run.sh
COPY ./docker/etc/s6-overlay/s6-rc.d /etc/s6-overlay/s6-rc.d
COPY ./docker/etc/pulse /etc/pulse
##### END STATIC FILES #####
##### BUILD FILES #####
FROM scratch AS build-files
COPY --from=ffmpeglite /ffmpeg_build/lib/ /usr/local/lib
COPY --from=shairport-sync /shairport-sync/build/install/usr/local/bin/shairport-sync /usr/local/bin/shairport-sync
COPY --from=shairport-sync /shairport-sync/build/install/usr/local/share/man/man1 /usr/share/man/man1
COPY --from=nqptp /nqptp/nqptp /usr/local/bin/nqptp
COPY --from=alac /usr/local/lib/libalac.* /usr/local/lib/
COPY --from=shairport-sync /shairport-sync/build/install/etc/shairport-sync.conf /etc/
COPY --from=shairport-sync /shairport-sync/build/install/etc/shairport-sync.conf.sample /etc/
COPY --from=shairport-sync /shairport-sync/build/install/etc/dbus-1/system.d/shairport-sync-dbus.conf /etc/dbus-1/system.d/
@@ -90,53 +128,42 @@ COPY --from=shairport-sync /shairport-sync/build/install/etc/dbus-1/system.d/sha
##### END BUILD FILES #####
# Shairport Sync Runtime System
FROM crazymax/alpine-s6:3.20-3.2.0.2
ENV S6_CMD_WAIT_FOR_SERVICES=1
ENV S6_CMD_WAIT_FOR_SERVICES_MAXTIME=0
FROM alpine:$ALPINE_VERSION
COPY --from=build-files / /
RUN apk -U add \
alsa-lib \
avahi \
avahi-tools \
dbus \
ffmpeg \
glib \
less \
less-doc \
libconfig \
libgcrypt \
libplist \
pipewire \
libpulse \
libressl3.8-libcrypto \
libsndfile \
libcrypto3 \
libsodium \
libuuid \
pipewire \
man-pages \
mandoc \
mosquitto \
popt \
soxr \
curl
curl && \
rm -rfv /lib/apk/db/* && \
rm -rfv /etc/avahi/services/*.service && \
rm -rf /usr/share/man && \
addgroup shairport-sync && \
adduser -D shairport-sync -G shairport-sync && \
addgroup -g 29 docker_audio && \
addgroup shairport-sync docker_audio && \
addgroup shairport-sync audio && \
mkdir -p /run/dbus
RUN rm -rfv /lib/apk/db/* && \
rm -rfv /etc/avahi/services/*.service && \
addgroup shairport-sync && \
adduser -D shairport-sync -G shairport-sync && \
addgroup -g 29 docker_audio && \
addgroup shairport-sync docker_audio && \
addgroup shairport-sync audio && \
mkdir -p /run/dbus
# Removed anything we don't need.
# Removed any statically-defined Avahi services, e.g. SSH and SFTP
# Remove anything we don't need.
# Remove any statically-defined Avahi services, e.g. SSH and SFTP
# Create non-root user for running the container -- running as the user 'shairport-sync' also allows
# Created non-root user for running the container -- running as the user 'shairport-sync' also allows
# Shairport Sync to provide the D-Bus and MPRIS interfaces within the container
# Add the shairport-sync user to the pre-existing audio group, which has ID 29, for access to the ALSA stuff
# Added the shairport-sync user to the pre-existing audio group, which has ID 29, for access to the ALSA stuff
COPY --from=files / /
COPY --from=build-files / /
ENTRYPOINT ["/init","./run.sh"]
ENTRYPOINT ["./run.sh"]
+9 -4
View File
@@ -19,13 +19,13 @@ See the `docker-compose.yaml` file in this folder for an example.
To run the latest release of Shairport Sync, which provides AirPlay 2 service:
```
$ docker run -d --restart unless-stopped --net host --device /dev/snd \
$ docker run -d --cap-add=SYS_NICE --restart unless-stopped --net host --device /dev/snd \
mikebrady/shairport-sync:latest
```
To run the classic version:
```
$ docker run -d --restart unless-stopped --net host --device /dev/snd \
$ docker run -d --cap-add=SYS_NICE --restart unless-stopped --net host --device /dev/snd \
mikebrady/shairport-sync:latest-classic
```
@@ -34,13 +34,18 @@ $ docker run -d --restart unless-stopped --net host --device /dev/snd \
Command line options will be passed to Shairport Sync. Here is an example:
```
$ docker run -d --restart unless-stopped --net host --device /dev/snd \
$ docker run -d --cap-add=SYS_NICE --restart unless-stopped --net host --device /dev/snd \
mikebrady/shairport-sync:latest \
-v --statistics -a DenSystem -- -d hw:0 -c PCM
```
This will send audio to alsa hardware device `hw:0` and make use of the that device's mixer control called `PCM`. The service will be visible as `DenSystem` on the network.
The image is built with PulseAudio backend support. To use it, refer to [`docker-compose.yaml`](docker-compose.yaml) for required environment variables and mounts. You might need to adjust authentication on your PulseAudio server ([PA documentation](https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/Modules/#module-native-protocol-unixtcp)) and set default backend to `pa` via either command line option `-o` or `general.output_backend` field in config file.
The image is built with PipeWire and PulseAudio backend support. To use it, refer to [`docker-compose.yaml`](docker-compose.yaml) for required environment variables and mounts.
To use the PipeWire backend, set the backend to `pipewire` via either command line option `-o pipewire ` or the `output_backend` field in the `general` section of the configuration file.
Similarly, to use the PulseAudio backend, set the backend to `pulseaudio` via either command line option `-o pulseaudio ` or the `output_backend` field in the `general` section of the configuration file.
For use with PulseAudio, you might need to adjust authentication on your PulseAudio server ([PA documentation](https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/Modules/#module-native-protocol-unixtcp)).
## Configuration File
+98 -68
View File
@@ -1,15 +1,45 @@
# Classic Shairport-Sync build. Note: the only decoder in FFmpeg is ALAC.
ARG SHAIRPORT_SYNC_BRANCH=.
ARG FFMPEG_BRANCH=release/7.1
ARG ALPINE_VERSION=20250108
FROM alpine:3.20 AS builder
##### FFMPEGLITE #####
FROM alpine:$ALPINE_VERSION AS ffmpeglite
RUN apk -U add build-base git nasm pkgconf
RUN mkdir -p /ffmpeg_sources /ffmpeg_build
WORKDIR /ffmpeg_sources
ARG FFMPEG_BRANCH
RUN git clone --depth=1 -b "$FFMPEG_BRANCH" https://git.ffmpeg.org/ffmpeg.git
WORKDIR /ffmpeg_sources/ffmpeg
RUN ./configure \
--prefix="/ffmpeg_build" \
--extra-libs="-lpthread -lm" \
--ld="g++" \
--disable-static \
--enable-shared \
--enable-gpl \
--disable-programs \
--disable-everything \
--disable-doc \
--disable-iconv \
--disable-avdevice \
--disable-avfilter \
--disable-swscale \
--disable-network \
--disable-iamf \
--disable-pixelutils \
--disable-postproc \
--enable-decoder=alac
RUN make
RUN make install
##### FFMPEGLITE END #####
# Classic (aka AirPlay 1) Build
# Check required arguments exist. These will be provided by the Github Action
# Workflow and are required to ensure the correct branches are being used.
ARG SHAIRPORT_SYNC_BRANCH
RUN test -n "$SHAIRPORT_SYNC_BRANCH"
##### SPS #####
FROM alpine:$ALPINE_VERSION AS shairport-sync
RUN apk -U add \
pkgconf \
alsa-lib-dev \
autoconf \
automake \
@@ -18,96 +48,96 @@ RUN apk -U add \
dbus \
git \
libconfig-dev \
openssl-dev \
libsndfile-dev \
libtool \
mbedtls-dev \
pipewire-dev \
mosquitto-dev \
popt-dev \
pulseaudio-dev \
soxr-dev
soxr-dev \
xxd
##### ALAC #####
RUN git clone https://github.com/mikebrady/alac
WORKDIR /alac
RUN autoreconf -i
RUN ./configure
RUN make -j $(nproc)
RUN make install
WORKDIR /
##### ALAC END #####
##### SPS #####
ARG SHAIRPORT_SYNC_BRANCH
WORKDIR /shairport-sync
COPY . .
RUN git checkout "$SHAIRPORT_SYNC_BRANCH"
RUN rm -rf build
# the above three lines or the following...
# RUN git clone --depth=1 -b "SHAIRPORT_SYNC_BRANCH" https://github.com/mikebrady/sps-private shairport-sync
COPY --from=ffmpeglite /ffmpeg_build/lib/ /usr/local/lib
COPY --from=ffmpeglite /ffmpeg_build/lib/pkgconfig/*.pc /usr/local/lib/pkgconfig/
COPY --from=ffmpeglite /ffmpeg_build/include/ /usr/local/include
# RUN git checkout "$SHAIRPORT_SYNC_BRANCH"
# the following is to remove any build directory that might be there
# not needed if the source is a clone of the repository
# RUN rm -rf build
WORKDIR /shairport-sync/build
RUN autoreconf -i ../
RUN CFLAGS="-O3" CXXFLAGS="-O3" ../configure --sysconfdir=/etc --with-alsa --with-pa --with-soxr --with-avahi --with-ssl=mbedtls \
--with-metadata --with-dummy --with-pipe --with-dbus-interface \
RUN ../configure --sysconfdir=/etc --with-alsa --with-pulseaudio --with-soxr --with-avahi --with-ssl=openssl \
--with-ffmpeg --with-metadata --with-dummy --with-pipe --with-dbus-interface \
--with-stdout --with-mpris-interface --with-mqtt-client \
--with-apple-alac --with-convolution
RUN make -j $(nproc)
--with-convolution --with-pipewire
RUN make
RUN DESTDIR=install make install
WORKDIR /
##### SPS END #####
##### STATIC FILES #####
FROM scratch AS files
# Add run script that will start SPS
COPY --chmod=755 ./docker/classic/run.sh ./run.sh
COPY ./docker/etc/pulse /etc/pulse
##### END STATIC FILES #####
##### BUILD FILES #####
FROM scratch AS build-files
COPY --from=ffmpeglite /ffmpeg_build/lib/ /usr/local/lib
COPY --from=shairport-sync /shairport-sync/build/install/usr/local/bin/shairport-sync /usr/local/bin/shairport-sync
COPY --from=shairport-sync /shairport-sync/build/install/usr/local/share/man/man1 /usr/share/man/man1
COPY --from=shairport-sync /shairport-sync/build/install/etc/shairport-sync.conf /etc/
COPY --from=shairport-sync /shairport-sync/build/install/etc/shairport-sync.conf.sample /etc/
COPY --from=shairport-sync /shairport-sync/build/install/etc/dbus-1/system.d/shairport-sync-dbus.conf /etc/dbus-1/system.d/
COPY --from=shairport-sync /shairport-sync/build/install/etc/dbus-1/system.d/shairport-sync-mpris.conf /etc/dbus-1/system.d/
##### END BUILD FILES #####
# Shairport Sync Runtime System
FROM crazymax/alpine-s6:3.20-3.2.0.2
FROM alpine:$ALPINE_VERSION
ENV S6_CMD_WAIT_FOR_SERVICES=1
ENV S6_CMD_WAIT_FOR_SERVICES_MAXTIME=0
COPY --from=build-files / /
RUN apk -U add \
RUN apk --no-cache add \
alsa-lib \
avahi \
avahi-tools \
dbus \
glib \
less \
less-doc \
libconfig \
libsndfile-dev \
pipewire \
libpulse \
man-pages \
mandoc \
mbedtls \
libcrypto3 \
mosquitto \
popt \
soxr \
curl
curl && \
rm -rfv /lib/apk/db/* && \
rm -rfv /etc/avahi/services/*.service && \
rm -rf /usr/share/man && \
addgroup shairport-sync && \
adduser -D shairport-sync -G shairport-sync && \
addgroup -g 29 docker_audio && \
addgroup shairport-sync docker_audio && \
addgroup shairport-sync audio && \
mkdir -p /run/dbus
# Copy build files.
COPY --from=builder /shairport-sync/build/install/usr/local/bin/shairport-sync /usr/local/bin/shairport-sync
COPY --from=builder /shairport-sync/build/install/usr/local/share/man/man1 /usr/share/man/man1
COPY --from=builder /usr/local/lib/libalac.* /usr/local/lib/
COPY --from=builder /shairport-sync/build/install/etc/shairport-sync.conf /etc/
COPY --from=builder /shairport-sync/build/install/etc/shairport-sync.conf.sample /etc/
COPY --from=builder /shairport-sync/build/install/etc/dbus-1/system.d/shairport-sync-dbus.conf /etc/dbus-1/system.d/
COPY --from=builder /shairport-sync/build/install/etc/dbus-1/system.d/shairport-sync-mpris.conf /etc/dbus-1/system.d/
# Removed anything we don't need.
# Removed any statically-defined Avahi services, e.g. SSH and SFTP
COPY ./docker/classic/etc/s6-overlay/s6-rc.d /etc/s6-overlay/s6-rc.d
RUN chmod +x /etc/s6-overlay/s6-rc.d/01-startup/script.sh
# Create non-root user for running the container -- running as the user 'shairport-sync' also allows
# Created non-root user for running the container -- running as the user 'shairport-sync' also allows
# Shairport Sync to provide the D-Bus and MPRIS interfaces within the container
# Added the shairport-sync user to the pre-existing audio group, which has ID 29, for access to the ALSA stuff
RUN addgroup shairport-sync
RUN adduser -D shairport-sync -G shairport-sync
COPY --from=files / /
# Add the shairport-sync user to the pre-existing audio group, which has ID 29, for access to the ALSA stuff
RUN addgroup -g 29 docker_audio && addgroup shairport-sync docker_audio && addgroup shairport-sync audio
# Remove anything we don't need.
RUN rm -rf /lib/apk/db/*
# Remove any statically-defined Avahi services, e.g. SSH and SFTP
RUN rm -rf /etc/avahi/services/*.service
# Add run script that will start SPS
COPY ./docker/run.sh ./run.sh
RUN chmod +x /run.sh
# D-Bus might need this directory
RUN mkdir -p /run/dbus
ENTRYPOINT ["/init","./run.sh"]
ENTRYPOINT ["./run.sh"]
@@ -1 +0,0 @@
base
@@ -1,2 +0,0 @@
#!/bin/sh
echo "STARTING - $(date)"
@@ -1 +0,0 @@
oneshot
@@ -1 +0,0 @@
/etc/s6-overlay/s6-rc.d/01-startup/script.sh
@@ -1,2 +0,0 @@
#!/bin/sh
exec dbus-send --system / org.freedesktop.DBus.Peer.Ping > /dev/null 2> /dev/null
@@ -1 +0,0 @@
01-startup
@@ -1,2 +0,0 @@
#!/command/execlineb -S0
/run/s6/basedir/bin/halt
@@ -1 +0,0 @@
3
@@ -1,7 +0,0 @@
#!/command/with-contenv sh
# Set the limit to the same value Docker has been using in earlier version.
ulimit -n 1048576
echo "Starting dbus"
exec s6-notifyoncheck dbus-daemon --system --nofork --nopidfile
@@ -1 +0,0 @@
longrun
@@ -1,10 +0,0 @@
#!/bin/sh
state="$(dbus-send --system --dest=org.freedesktop.Avahi --print-reply / org.freedesktop.Avahi.Server.GetState | grep int32 | awk '{printf $2}')"
# Avahi will return 'state=2' when 'Server startup complete'
if [ "$state" = 2 ]; then
exit 0
else
exit 1
fi
@@ -1 +0,0 @@
02-dbus
@@ -1,2 +0,0 @@
#!/command/execlineb -S0
/run/s6/basedir/bin/halt
@@ -1 +0,0 @@
3
@@ -1,3 +0,0 @@
#!/command/with-contenv sh
echo "Starting avahi"
exec s6-notifyoncheck avahi-daemon --no-chroot
@@ -1 +0,0 @@
longrun
Regular → Executable
+20 -3
View File
@@ -1,8 +1,25 @@
#!/bin/sh
# exist if any command returns a non-zero result
set -e
rm -rf /var/run/dbus.pid
dbus-uuidgen --ensure
dbus-daemon --system
avahi-daemon --daemonize --no-chroot
while [ ! -f /var/run/avahi-daemon/pid ]; do
echo "Warning: avahi is not running, sleeping for 1 second before trying to start shairport-sync"
sleep 1
done
echo "Starting shairport-sync"
# pass all commandline options to shairport-sync
/usr/local/bin/shairport-sync "$@"
# for PipeWire
export XDG_RUNTIME_DIR=/tmp
# for PulseAudio
export PULSE_SERVER=unix:/tmp/pulseaudio.socket
export PULSE_COOKIE=/tmp/pulseaudio.cookie
exec /usr/local/bin/shairport-sync "$@"
+22 -3
View File
@@ -1,8 +1,27 @@
#!/bin/sh
# exist if any command returns a non-zero result
set -e
rm -rf /var/run/dbus.pid
dbus-uuidgen --ensure
dbus-daemon --system
(/usr/local/bin/nqptp > /dev/null 2>&1) &
avahi-daemon --daemonize --no-chroot
while [ ! -f /var/run/avahi-daemon/pid ]; do
echo "Warning: avahi is not running, sleeping for 1 second before trying to start shairport-sync"
sleep 1
done
echo "Starting shairport-sync"
# pass all commandline options to shairport-sync
/usr/local/bin/shairport-sync "$@"
# for PipeWire
export XDG_RUNTIME_DIR=/tmp
# for PulseAudio
export PULSE_SERVER=unix:/tmp/pulseaudio.socket
export PULSE_COOKIE=/tmp/pulseaudio.cookie
exec /usr/local/bin/shairport-sync "$@"