Files
shairport-sync/user-service-install.sh
T
Mike Brady b405c0b896 Version 5.0 Major Release.
New Features:
Multi-Channel and High-Resolution Audio Support
48,000 frames per second ("48k") operation.
48k lossless stereo support.
5.1 and 7.1 surround sound support.
Multi-channel and multi-rate operation on ALSA, PipeWire, PulseAudio, FreeBSD, stdout and Unix pipe output backends.
Automatic Audio Format Selection
Flexible and controllable output format selection.
Automatic rate, sample format, and channel count selection.
Full FFmpeg Integration
Support for transcoding.
Advanced resampling capabilities.
New audio format support.
Enhanced Resampling
New vernier resampling and interpolation method optimized for low-power CPUs.
Better performance on resource-constrained devices.

Convolution and Loudness Enhancements:
Convolution system is now multithreaded and works on stereo and multichannel audio at 48k and 44.1k.
Multiple impulse response (IR) files can now be provided via convolution_ir_files setting.
New convolution_thread_pool_size setting for multithreaded processing (defaults to 1).
Loudness processing now works with stereo and multichannel audio at 48k and 44.1k.
Updated to the most recent HiFi-LoFi FFT convolver.

MQTT Enhancements:
Added new publish_retain boolean option. When enabled, published MQTT messages have the retain flag set, so the MQTT broker stores the last message per topic and new subscribers receive the most recent value immediately. Thanks to lululombard for PR #2142.

D-Bus Enhancements:
Added new dbus_default_message_bus command-line argument (can be system or session) to set the default message bus for both D-Bus native service and MPRIS service.

Performance Improvements:
Enhanced compatibility with AirPlay 2 AutoMix and Smart Tracklists resulting in less unexplained track skipping.
Better operation on low-power devices down to Raspberry Pi B.
Improved efficiency on embedded systems.
Enhanced timestamp handling for better synchronization.
Improved sync error calculation.
Rebuilt buffered audio processor for cleaner handling of immediate and deferred flush requests.

Docker Enhancements:
Reduced Docker image sizes with slimmed-down FFmpeg library.
Removed dhclient from Docker images for smaller footprint.

Bug Fixes:
Fixed MQTT warning on service startup: "Could not establish a mqtt connection". The startup script now correctly states that the mosquitto service is required. Thanks to Hugo Villeneuve for PR #2137.
Fixed compatibility with mbedtls library version 3.4+ (present on recent Linux versions). Thanks to Christian Beier for finding and fixing the bug.
Fixed PulseAudio backend so that PA_ERR_NODATA returns "No latency data yet". Thanks to Vladimir Shakov for the report and fix.
Ensured old flush requests are deleted when a new play session starts. Thanks to saujanyashah for the report.
Fixed format warnings on 64-bit and 32-bit systems
Removed compilation warnings on 32-bit builds
Improved argument checking for debug(), inform(), warn() and die() functions
Fixed "daemon" typos throughout codebase. Thanks to Chris Boot for PR #1981.
Added warning if a convolution impulse response file cannot be read due to bad path or permissions

Build System Improvements:
Unified service file with variable substitution for Avahi support, making it easier to add future service dependencies. Thanks to Hugo Villeneuve.
Network interface selection now only considers interfaces that are up, running and not loopback interfaces. Thanks to Carl Johnson for the suggestion.
Configuration File Changes and Deprecations

New settings: convolution_ir_files (replaces convolution_ir_file), convolution_enabled (replaces convolution), convolution_max_length_in_seconds (replaces convolution_max_length), loudness_enabled (replaces loudness).
New convolution_thread_pool_size setting (defaults to 1).
Deprecated settings: convolution_ir_file, convolution, convolution_max_length, loudness.
Corresponding D-Bus methods and properties have been updated.

Deprecation Notice:
The Jack Audio and soundio backends are deprecated and will be removed in a future release. Consider using the updated PipeWire backend instead.

Documentation Updates
Updated BUILD.md with latest build instructions.
Updated AIRPLAY2.md with feature information.
Enhanced convolution and loudness documentation.

Maintenance:
Fixed FFmpeg deprecation warnings.
Bumped actions/checkout from 6.0.1 to 6.0.2.
Bumped docker/login-action from 3.6.0 to 3.7.0.
Bumped docker/build-push-action from 6.13.0 to 6.15.0.
Bumped docker/setup-qemu-action from 3.4.0 to 3.6.0.
Bumped docker/setup-buildx-action from 3.9.0 to 3.10.0.
2026-02-13 15:17:40 +00:00

184 lines
5.1 KiB
Bash

#!/bin/sh
# user-service-installer.sh - Installs a user-level systemd service for shairport-sync
SERVICE_NAME="shairport-sync.service"
SERVICE_SOURCE="./scripts/shairport-sync.user.service"
USER_SYSTEMD_DIR="$HOME/.config/systemd/user"
SERVICE_DEST="$USER_SYSTEMD_DIR/$SERVICE_NAME"
APP_NAME="shairport-sync"
DRY_RUN=0
show_help() {
echo "Usage: $0 [OPTION]"
echo ""
echo "Installs a user-level systemd service to:"
echo " $USER_SYSTEMD_DIR"
echo ""
echo "Options:"
echo " -h, --help Show this help message and exit"
echo " --dry-run Show what the script would do without making changes"
}
# Parse arguments
while [ $# -gt 0 ]; do
case "$1" in
-h|--help)
show_help
exit 0
;;
--dry-run)
DRY_RUN=1
;;
*)
echo "Unknown option: $1" >&2
show_help
exit 1
;;
esac
shift
done
echo "--------------------------------------------------"
echo "Systemd User Service Installer for $APP_NAME"
echo "This script will:"
echo " - Check for system/initd conflicts"
echo " - Verify the app is not already running"
echo " - Install the user service"
echo " - Enable it to run at login"
if [ "$DRY_RUN" -eq 1 ]; then
echo ""
echo "Dry-run mode: no changes will be made."
fi
echo "--------------------------------------------------"
echo ""
# Check for systemd
if command -v systemctl >/dev/null 2>&1; then
echo "[OK] systemd is available."
else
echo "[FAIL] systemd is not available on this system." >&2
exit 1
fi
# Check for system-level service
if systemctl is-enabled "$APP_NAME" >/dev/null 2>&1; then
echo "[FAIL] A system-level systemd service for '$APP_NAME' is currently enabled." >&2
echo " [ADVICE] Please disable it before installing a user-level service." >&2
exit 1
else
echo "[OK] No conflicting system-level systemd service enabled."
fi
# Check for init.d service
if [ -x "/etc/init.d/$APP_NAME" ]; then
echo "[FAIL] An init.d script for '$APP_NAME' exists at /etc/init.d/$APP_NAME." >&2
echo " [ADVICE] Please remove or disable the init.d version before proceeding." >&2
exit 1
else
echo "[OK] No conflicting init.d service found."
fi
# Note if the user-level service is already running
if systemctl --user is-enabled "$APP_NAME" >/dev/null 2>&1; then
echo "[NOTE] A user-level systemd service for '$APP_NAME' is currently enabled."
fi
# Check if the application is already running
if pgrep -x "$APP_NAME" >/dev/null 2>&1; then
echo "[FAIL] $APP_NAME is already running." >&2
echo " [ADVICE] Please stop $APP_NAME before proceeding." >&2
exit 1
else
echo "[OK] $APP_NAME is not currently running."
fi
# Create directory
if [ ! -d "$USER_SYSTEMD_DIR" ]; then
if [ "$DRY_RUN" -eq 0 ]; then
echo "Creating directory $USER_SYSTEMD_DIR..."
mkdir -p "$USER_SYSTEMD_DIR"
if [ $? -eq 0 ]; then
echo "[OK] Directory $USER_SYSTEMD_DIR created."
else
echo "[FAIL] Failed to create directory $USER_SYSTEMD_DIR" >&2
exit 1
fi
fi
else
echo "[OK] User systemd directory already exists."
fi
if [ -d "$USER_SYSTEMD_DIR" ] && [ ! -w "$USER_SYSTEMD_DIR" ]; then
echo "[FAIL] $USER_SYSTEMD_DIR is not writable." >&2
echo " [ADVICE] Please ensure $USER_SYSTEMD_DIR is owned and writable by user \"$(whoami)\" before proceeding." >&2
exit 1
fi
# If the service file already exists, check that we can replace it
if [ -f "$SERVICE_DEST" ] && [ ! -w "$SERVICE_DEST" ]; then
echo "[FAIL] The existing $SERVICE_DEST can not be replaced due to its ownership or permissions." >&2
echo " [ADVICE] Please delete $SERVICE_DEST or ensure it is owned and writable by user \"$(whoami)\" before proceeding." >&2
exit 1
fi
# Create the service file
if [ "$DRY_RUN" -eq 0 ]; then
echo "Creating service file at $SERVICE_DEST..."
cat > "$SERVICE_DEST" <<EOF
[Unit]
Description=Shairport Sync - AirPlay Audio Receiver
After=sound.target
[Service]
ExecStart=/usr/local/bin/shairport-sync --log-to-syslog
[Install]
WantedBy=default.target
EOF
if [ $? -eq 0 ]; then
echo "[OK] Service file created."
else
echo "[FAIL] Failed to create service file." >&2
exit 1
fi
fi
# Reload systemd
if [ "$DRY_RUN" -eq 0 ]; then
echo "Reloading systemd user daemon..."
systemctl --user daemon-reexec
systemctl --user daemon-reload
if [ $? -eq 0 ]; then
echo "[OK] The systemd user daemon was reloaded."
else
echo "[FAIL] Failed to reload systemd user daemon." >&2
exit 1
fi
fi
# Enable service
if [ "$DRY_RUN" -eq 0 ]; then
echo "Enabling service $SERVICE_NAME..."
systemctl --user enable --now "$SERVICE_NAME"
if [ $? -eq 0 ]; then
echo "[OK] Service enabled and started."
else
echo "[FAIL] Failed to enable the user service." >&2
exit 1
fi
fi
echo ""
if [ "$DRY_RUN" -eq 1 ]; then
echo "Dry run completed successfully."
else
echo "Installation complete."
echo "The user-level systemd service for $APP_NAME is now installed and enabled."
fi