pax_global_header00006660000000000000000000000064147471623330014524gustar00rootroot0000000000000052 comment=0b1c4391ffd398e7b145eb4b98416261380adeea shairport-sync-4.3.7/000077500000000000000000000000001474716233300145245ustar00rootroot00000000000000shairport-sync-4.3.7/.dockerignore000066400000000000000000000000751474716233300172020ustar00rootroot00000000000000.github documents docker/Dockerfile docker/classic/Dockerfileshairport-sync-4.3.7/.github/000077500000000000000000000000001474716233300160645ustar00rootroot00000000000000shairport-sync-4.3.7/.github/FUNDING.yml000066400000000000000000000000531474716233300176770ustar00rootroot00000000000000github: mikebrady custom: [paypal.me/UMBr] shairport-sync-4.3.7/.github/ISSUE_TEMPLATE/000077500000000000000000000000001474716233300202475ustar00rootroot00000000000000shairport-sync-4.3.7/.github/ISSUE_TEMPLATE/Bug Report.yaml000066400000000000000000000046111474716233300231060ustar00rootroot00000000000000name: Issue Report description: Questions about installing or configuring Shairport Sync? Please check through Issues (including closed issues) or create a new Issue here. title: "[Problem]: " labels: ["new issue"] body: - type: markdown attributes: value: | Thanks for taking the time to fill out this report! - type: textarea id: what-happened attributes: label: What happened? description: Also, what did you expect to happen? validations: required: true - type: textarea id: logs attributes: label: Relevant log output description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. render: shell - type: textarea id: system attributes: label: System Information. description: Please give some information about the system hardware -- make and model would be useful, e.g. Raspberry Pi 4 (4 GB). Also, the make and model of the output DAC, if known. validations: required: true - type: textarea id: version attributes: label: Configuration Information. description: Please paste the results of `shairport-sync --displayConfig` here, if available. This gives useful information about the environment Shairport Sync is running in and also displays the command line options and configuration settings. If `shairport-sync --displayConfig` is not available, please paste the results of two commands `uname -a` and `shairport-sync -V`. render: shell validations: required: true - type: checkboxes id: check-papw attributes: label: PulseAudio or PipeWire installed? description: Does your system use a sound server like PulseAudio or PipeWire? (If it has a GUI, it probably does...) options: - label: Check if your system uses a Sound Server. - type: dropdown id: install attributes: label: How did you install Shairport Sync? options: - Homebrew for Mac - Docker - A package manager (apt, apt install, yum, pkg, etc.) - Built from source validations: required: true - type: checkboxes id: checked-current-issues attributes: label: Check previous issues description: Please check previous issues (including closed ones) for duplicates. options: - label: Confirm required: true shairport-sync-4.3.7/.github/ISSUE_TEMPLATE/config.yml000066400000000000000000000010401474716233300222320ustar00rootroot00000000000000blank_issues_enabled: false contact_links: - name: Questions? url: https://github.com/mikebrady/shairport-sync/discussions/categories/q-a about: If you have questions about installing or configuring Shairport Sync, please check through Issues (including closed issues) or raise a new Issue. Got more general questions? If so, please ask and answer questions here. - name: Feature Requests url: https://github.com/mikebrady/shairport-sync/discussions/categories/ideas about: Please submit feature requests/enhancements here. shairport-sync-4.3.7/.github/dependabot.yml000066400000000000000000000003101474716233300207060ustar00rootroot00000000000000version: 2 updates: - package-ecosystem: github-actions directory: "/" schedule: interval: weekly day: sunday time: "10:00" open-pull-requests-limit: 10 target-branch: development shairport-sync-4.3.7/.github/workflows/000077500000000000000000000000001474716233300201215ustar00rootroot00000000000000shairport-sync-4.3.7/.github/workflows/check_ap2_systemd_basic.yml000066400000000000000000000020711474716233300253740ustar00rootroot00000000000000name: Basic ALSA configuration for systemd, using a build folder. on: workflow_dispatch: push: branches: [ "development" ] pull_request: types: [opened, synchronize, reopened, ready_for_review] jobs: build: runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4.2.2 - name: Install Dependencies run: sudo apt-get -y --no-install-recommends install xmltoman libpopt-dev libconfig-dev libasound2-dev avahi-daemon libavahi-client-dev libsoxr-dev libplist-dev libsodium-dev libavutil-dev libavcodec-dev libavformat-dev - name: Configure run: | mkdir build cd build autoreconf -i .. ../configure --sysconfdir=/etc --with-alsa --with-soxr --with-avahi --with-ssl=openssl --with-systemd --with-airplay-2 - name: Make run: | cd build make -j - name: Install run: | cd build sudo make install - name: Invoke run: | sudo systemctl start shairport-sync - name: Terminate run: | sudo systemctl stop shairport-sync shairport-sync-4.3.7/.github/workflows/check_ap2_systemd_full.yml000066400000000000000000000022261474716233300252570ustar00rootroot00000000000000name: Configuration (without pa, soundio or apple-alac) for systemd. on: workflow_dispatch: push: branches: [ "development" ] pull_request: types: [opened, synchronize, reopened, ready_for_review] jobs: build: runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4.2.2 - name: Install Dependencies run: sudo apt-get -y --no-install-recommends install xmltoman libpopt-dev libconfig-dev libasound2-dev libao-dev libjack-dev libmosquitto-dev avahi-daemon libavahi-client-dev libsoxr-dev libplist-dev libsodium-dev libavutil-dev libavcodec-dev libavformat-dev - name: Configure run: | autoreconf -fi ./configure --sysconfdir=/etc --with-alsa --with-ao --with-dummy --with-jack --with-pipe --with-stdout --with-soxr --with-avahi --with-ssl=openssl --with-systemd --with-dbus-interface --with-mpris-interface --with-mqtt-client --with-airplay-2 - name: Make run: | make -j - name: Install run: | sudo make install - name: Invoke run: | sudo systemctl start shairport-sync - name: Terminate run: | sudo systemctl stop shairport-sync shairport-sync-4.3.7/.github/workflows/check_ap2_systemd_full_build_folder.yml000066400000000000000000000024141474716233300277700ustar00rootroot00000000000000name: Configuration (without pa, soundio or apple-alac) for systemd, using a build folder. on: workflow_dispatch: push: branches: [ "development" ] pull_request: types: [opened, synchronize, reopened, ready_for_review] jobs: build: runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4.2.2 - name: Install Dependencies run: sudo apt-get -y --no-install-recommends install xmltoman libpopt-dev libconfig-dev libasound2-dev libao-dev libjack-dev libglib2.0-dev libmosquitto-dev avahi-daemon libavahi-client-dev libssl-dev libsoxr-dev libplist-dev libsodium-dev libavutil-dev libavcodec-dev libavformat-dev - name: Configure run: | mkdir build cd build autoreconf -i .. ../configure --sysconfdir=/etc --with-alsa --with-ao --with-dummy --with-jack --with-pipe --with-stdout --with-soxr --with-avahi --with-ssl=openssl --with-systemd --with-dbus-interface --with-mpris-interface --with-mqtt-client --with-airplay-2 - name: Make run: | cd build make -j - name: Install run: | cd build sudo make install - name: Invoke run: | sudo systemctl start shairport-sync - name: Terminate run: | sudo systemctl stop shairport-sync shairport-sync-4.3.7/.github/workflows/check_ap2_systemv_full.yml000066400000000000000000000024111474716233300252750ustar00rootroot00000000000000name: Configuration (but without pa, soundio, apple-alac) for a System V system. on: workflow_dispatch: push: branches: [ "development" ] pull_request: types: [opened, synchronize, reopened, ready_for_review] jobs: build: runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4.2.2 - name: Install Dependencies run: sudo apt-get -y --no-install-recommends install xmltoman libpopt-dev libdaemon-dev libconfig-dev libasound2-dev libao-dev libjack-dev libglib2.0-dev libmosquitto-dev avahi-daemon libavahi-client-dev libssl-dev libsoxr-dev libplist-dev libsodium-dev libavutil-dev libavcodec-dev libavformat-dev uuid-dev libgcrypt-dev - name: Configure run: | autoreconf -i ./configure --sysconfdir=/etc --with-alsa --with-ao --with-dummy --with-libdaemon --with-jack --with-pipe --with-stdout --with-soxr --with-avahi --with-ssl=openssl --with-systemv --with-dbus-interface --with-mpris-interface --with-mqtt-client --with-airplay-2 - name: Make run: | make -j - name: Install run: | sudo make install - name: Invoke run: | sudo /etc/init.d/shairport-sync start sleep 2 - name: Terminate run: | sudo /etc/init.d/shairport-sync stop shairport-sync-4.3.7/.github/workflows/check_classic_mac_basic.yml000066400000000000000000000012701474716233300254030ustar00rootroot00000000000000name: Basic libao configuration for macOS with BREW -- classic only, because macOS can't host NQPTP. on: workflow_dispatch: push: branches: [ "development" ] pull_request: types: [opened, synchronize, reopened, ready_for_review] jobs: build: runs-on: macos-13 steps: - uses: actions/checkout@v4.2.2 - name: Install Dependencies run: | brew install automake brew install popt brew install libconfig brew install libao - name: Configure run: | autoreconf -fi ./configure --with-os=darwin --with-ao --with-stdout --with-dns_sd --with-ssl=openssl - name: Make run: | make shairport-sync-4.3.7/.github/workflows/check_classic_systemd_basic.yml000066400000000000000000000017671474716233300263460ustar00rootroot00000000000000name: Basic ALSA classic configuration for systemd, using a build folder. on: workflow_dispatch: push: branches: [ "development" ] pull_request: types: [opened, synchronize, reopened, ready_for_review] jobs: build: runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4.2.2 - name: Install Dependencies run: sudo apt-get -y --no-install-recommends install xmltoman libpopt-dev libconfig-dev libasound2-dev avahi-daemon libavahi-client-dev libssl-dev libsoxr-dev - name: Configure run: | mkdir build cd build autoreconf -i .. ../configure --sysconfdir=/etc --with-alsa --with-soxr --with-avahi --with-ssl=openssl --with-systemd - name: Make run: | cd build make -j - name: Install run: | cd build sudo make install - name: Invoke run: | sudo systemctl start shairport-sync - name: Terminate run: | sudo systemctl stop shairport-sync shairport-sync-4.3.7/.github/workflows/check_classic_systemd_full.yml000066400000000000000000000022431474716233300262150ustar00rootroot00000000000000name: Classic (without pa, soundio, apple-alac) for systemd, using a build folder. on: workflow_dispatch: push: branches: [ "development" ] pull_request: types: [opened, synchronize, reopened, ready_for_review] jobs: build: runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4.2.2 - name: Install Dependencies run: sudo apt-get -y --no-install-recommends install xmltoman libpopt-dev libconfig-dev libasound2-dev libao-dev libjack-dev libglib2.0-dev libmosquitto-dev avahi-daemon libavahi-client-dev libssl-dev libsoxr-dev - name: Configure run: | mkdir build cd build autoreconf -i .. ../configure --sysconfdir=/etc --with-alsa --with-ao --with-dummy --with-pipe --with-stdout --with-soxr --with-avahi --with-ssl=openssl --with-systemd --with-dbus-interface --with-mpris-interface --with-mqtt-client - name: Make run: | cd build make -j - name: Install run: | cd build sudo make install - name: Invoke run: | sudo systemctl start shairport-sync - name: Terminate run: | sudo systemctl stop shairport-sync shairport-sync-4.3.7/.github/workflows/docker-build-on-push_and_pull_request.yaml000066400000000000000000000075471474716233300304030ustar00rootroot00000000000000# Builds a docker image when a commit is made. Also pushes the build if the branch is 'master' or 'development'. # Tag pattern # 'master' - rolling, rolling-classic # 'development' - development, development-classic name: Build and push docker (push/pull request) on: workflow_dispatch: push: branches: - master - development pull_request: types: [opened, synchronize, reopened, ready_for_review] env: DOCKER_PLATFORMS: linux/386,linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64 NQPTP_BRANCH: main jobs: test-build-on-pull-request: if: github.event_name == 'pull_request' runs-on: ubuntu-22.04 steps: - name: Checkout Repo uses: actions/checkout@v4.2.2 with: fetch-depth: 0 ref: ${{github.event.pull_request.head.ref}} repository: ${{github.event.pull_request.head.repo.full_name}} - name: Set SHAIRPORT_SYNC_BRANCH env run: | SHAIRPORT_SYNC_BRANCH=$(git rev-parse --abbrev-ref HEAD) echo "Current SHAIRPORT_SYNC_BRANCH set to ${SHAIRPORT_SYNC_BRANCH}" echo "SHAIRPORT_SYNC_BRANCH=${SHAIRPORT_SYNC_BRANCH}" >> $GITHUB_ENV - name: Set up QEMU uses: docker/setup-qemu-action@v3.3.0 - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3.8.0 - name: Build (classic) uses: docker/build-push-action@v6.13.0 with: context: ./ file: ./docker/classic/Dockerfile push: false build-args: | SHAIRPORT_SYNC_BRANCH=${{ env.SHAIRPORT_SYNC_BRANCH }} - name: Build uses: docker/build-push-action@v6.13.0 with: context: ./ file: ./docker/Dockerfile push: false build-args: | SHAIRPORT_SYNC_BRANCH=${{ env.SHAIRPORT_SYNC_BRANCH }} NQPTP_BRANCH=${{ env.NQPTP_BRANCH }} build-and-publish: if: github.event_name != 'pull_request' runs-on: ubuntu-22.04 steps: - name: Checkout uses: actions/checkout@v4.2.2 with: fetch-depth: 0 - name: Set SHAIRPORT_SYNC_BRANCH env. run: echo "SHAIRPORT_SYNC_BRANCH=${GITHUB_REF##*/}" >> $GITHUB_ENV - name: Is branch "master"? if: ${{ env.SHAIRPORT_SYNC_BRANCH == 'master' }} run: | echo "IMAGE_TAG_BASE=rolling" >> $GITHUB_ENV - name: Is branch "development"? if: ${{ env.SHAIRPORT_SYNC_BRANCH == 'development' }} run: | echo "NQPTP_BRANCH=development" >> $GITHUB_ENV echo "IMAGE_TAG_BASE=development" >> $GITHUB_ENV - name: Set up QEMU uses: docker/setup-qemu-action@v3.3.0 - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3.8.0 - name: Login to Docker Registry uses: docker/login-action@v3.3.0 with: registry: ${{ secrets.DOCKER_REGISTRY }} username: ${{ secrets.DOCKER_REGISTRY_USER }} password: ${{ secrets.DOCKER_REGISTRY_TOKEN }} - name: Build and push (classic) uses: docker/build-push-action@v6.13.0 with: context: ./ file: ./docker/classic/Dockerfile platforms: ${{ env.DOCKER_PLATFORMS }} push: ${{ env.IMAGE_TAG_BASE != '' }} tags: ${{ secrets.DOCKER_IMAGE_NAME }}:${{ env.IMAGE_TAG_BASE }}-classic build-args: | SHAIRPORT_SYNC_BRANCH=${{ env.SHAIRPORT_SYNC_BRANCH }} - name: Build and push uses: docker/build-push-action@v6.13.0 with: context: ./ file: ./docker/Dockerfile platforms: ${{ env.DOCKER_PLATFORMS }} push: ${{ env.IMAGE_TAG_BASE != '' }} tags: ${{ secrets.DOCKER_IMAGE_NAME }}:${{ env.IMAGE_TAG_BASE }} build-args: | SHAIRPORT_SYNC_BRANCH=${{ env.SHAIRPORT_SYNC_BRANCH }} NQPTP_BRANCH=${{ env.NQPTP_BRANCH }} shairport-sync-4.3.7/.github/workflows/docker-build-on-tag.yaml000066400000000000000000000053611474716233300245410ustar00rootroot00000000000000# Builds & pushes a docker image when a tag is created. # Tag pattern: '[tag]' & '[tag]-classic' # 'latest' & 'classic' also, when master tagged. # Only pushes the tag when it matches one of the following patterns: # X, X.Y or X.Y.Z name: Build and push docker (tag) on: workflow_dispatch: push: tags: - '[0-9]+' # X - '[0-9]+\.[0-9]+' # X.Y - '[0-9]+\.[0-9]+\.[0-9]+' # X.Y.Z env: DOCKER_PLATFORMS: linux/386,linux/amd64,linux/arm/v6,linux/arm64,linux/arm/v7 NQPTP_BRANCH: main jobs: main: runs-on: ubuntu-22.04 steps: - name: Checkout uses: actions/checkout@v4.2.2 with: fetch-depth: 0 - name: Set SHAIRPORT_SYNC_BRANCH env. run: | raw=$(git branch -r --contains ${{ github.ref }}) branch=${raw##*/} echo "SHAIRPORT_SYNC_BRANCH=${branch}" >> $GITHUB_ENV - name: Set tag env run: echo "GIT_TAG=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV - name: Is branch "master"? if: ${{ env.SHAIRPORT_SYNC_BRANCH == 'master' }} run: echo "LATEST_TAG=true" >> $GITHUB_ENV - name: Is branch "development"? if: ${{ env.SHAIRPORT_SYNC_BRANCH == 'development' }} run: | echo "NQPTP_BRANCH=development" >> $GITHUB_ENV - name: Set up QEMU uses: docker/setup-qemu-action@v3.3.0 - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3.8.0 - name: Login to Docker Registry uses: docker/login-action@v3.3.0 with: registry: ${{ secrets.DOCKER_REGISTRY }} username: ${{ secrets.DOCKER_REGISTRY_USER }} password: ${{ secrets.DOCKER_REGISTRY_TOKEN }} - name: Build and push (classic) uses: docker/build-push-action@v6.13.0 with: context: ./ file: ./docker/classic/Dockerfile platforms: ${{ env.DOCKER_PLATFORMS }} push: true tags: | ${{ secrets.DOCKER_IMAGE_NAME }}:${{ env.GIT_TAG }}-classic ${{ env.LATEST_TAG == 'true' && format('{0}:classic', secrets.DOCKER_IMAGE_NAME) || '' }} build-args: | SHAIRPORT_SYNC_BRANCH=${{ env.SHAIRPORT_SYNC_BRANCH }} - name: Build and push uses: docker/build-push-action@v6.13.0 with: context: ./ file: ./docker/Dockerfile platforms: ${{ env.DOCKER_PLATFORMS }} push: true tags: | ${{ secrets.DOCKER_IMAGE_NAME }}:${{ env.GIT_TAG }} ${{ env.LATEST_TAG == 'true' && format('{0}:latest', secrets.DOCKER_IMAGE_NAME) || '' }} build-args: | SHAIRPORT_SYNC_BRANCH=${{ env.SHAIRPORT_SYNC_BRANCH }} NQPTP_BRANCH=${{ env.NQPTP_BRANCH }} shairport-sync-4.3.7/.github/workflows/stale.yaml000066400000000000000000000014371474716233300221220ustar00rootroot00000000000000name: 'Close stale issues and PRs' on: schedule: - cron: '0 0 * * *' permissions: issues: write pull-requests: write jobs: stale: runs-on: ubuntu-latest steps: - uses: actions/stale@v9.1.0 with: stale-issue-message: 'This issue has been inactive for 28 days so will be closed 7 days from now. To prevent this, please remove the "stale" label or post a comment.' stale-pr-message: 'This PR has been inactive for 28 days so will be closed 7 days from now. To prevent this, please remove the "stale" label or post a comment.' operations-per-run: 100 # These are the defaults at the time of writing. https://github.com/marketplace/actions/close-stale-issues # days-before-stale: 28 # days-before-close: 7 shairport-sync-4.3.7/.gitignore000066400000000000000000000013321474716233300165130ustar00rootroot00000000000000/INSTALL /shairport-sync /shairport-sync.exe /shairport-sync-dbus-test-client /shairport-sync-mpris-test-client *.o /*~ *.xml~ /config.mk /config.h Makefile Makefile.in aclocal.m4 autom4te.cache compile /config.* configure depcomp install-sh missing stamp-h1 .dirstamp .deps man/Makefile man/Makefile.in scripts/shairport-sync.service scripts/shairport-sync.service-avahi scripts/shairport-sync shairport-sync.core gitversion.* plist_xml_strings.* #Some dbus files that are automatically generated /org.gnome.ShairportSync.service /dbus-interface.* /mpris-interface.* /lib_*.* # Some eclipse project files .cproject .project # macOS stuff .DS_Store shairport-sync.xcodeproj # separate build directory build # vscode .vscode shairport-sync-4.3.7/.gitmodules000066400000000000000000000000001474716233300166670ustar00rootroot00000000000000shairport-sync-4.3.7/.travis.yml000066400000000000000000000023211474716233300166330ustar00rootroot00000000000000language: c sudo: required dist: trusty env: matrix: - CFG="--with-alsa --with-avahi --with-ssl=openssl --with-soxr --with-metadata --with-systemv" - CFG="--with-alsa --with-avahi --with-ssl=polarssl --with-soxr --with-metadata --with-systemv" - CFG="--with-alsa --with-avahi --with-ssl=openssl --with-soxr --with-metadata --with-systemd" - CFG="--with-alsa --with-avahi --with-ssl=polarssl --with-soxr --with-metadata --with-systemd" - CFG="--with-alsa --with-tinysvcmdns --with-ssl=openssl --with-soxr --with-metadata --with-systemv" - CFG="--with-alsa --with-tinysvcmdns --with-ssl=polarssl --with-soxr --with-metadata --with-systemv" - CFG="--with-alsa --with-tinysvcmdns --with-ssl=openssl --with-soxr --with-metadata --with-systemd" - CFG="--with-alsa --with-tinysvcmdns --with-ssl=polarssl --with-soxr --with-metadata --with-systemd" script: - autoreconf -fi - ./configure $CFG - make before_install: - sudo apt-get -qq update - sudo apt-get install -y libdaemon-dev avahi-daemon libavahi-client-dev addons: apt: packages: - libasound2-dev - libsoxr-dev - libpopt-dev - libssl-dev - libpolarssl-dev - libconfig-dev - xmltoman - libao-dev shairport-sync-4.3.7/ADDINGTOHOME.md000066400000000000000000000021721474716233300167120ustar00rootroot00000000000000Here is how to add a Shairport Sync device to the Apple Home application on iOS 15.3.1. Note that Shairport Sync has to be built with AirPlay 2 support. *** Step 0: Speaker & TV access. --- In the Home app > Home settings "Allow Speaker & TV access", select the option "Anyone On the Same Network". If a "require password" option below the "anyone on same network" is available, make sure it is unchecked. Step 1: Open the "Home" app --- Tap the `Add Accessory` panel or choose "Add Accessory" from the `+` symbol in the top right: ![IMG_3678](https://user-images.githubusercontent.com/4265913/157615721-e42a07e3-f93e-49d0-9233-e7b92a577459.jpg) *** Step 2: "More options..." --- Step 2: Tap `More options...` ![IMG_3679](https://user-images.githubusercontent.com/4265913/157616118-79c6d494-ce6e-4666-a6de-53cb40d0e751.jpg) *** Step 3: Select your Shairport Sync device: --- Your Shairport Sync device should appear here, though you may have to scroll. Tap the appropriate icon and follow the remaining instructions. ![IMG_3680](https://user-images.githubusercontent.com/4265913/157616475-22ee2eb6-56f4-4368-a1ed-d925f9984f1e.jpg) shairport-sync-4.3.7/ADVANCED TOPICS/000077500000000000000000000000001474716233300166535ustar00rootroot00000000000000shairport-sync-4.3.7/ADVANCED TOPICS/AdjustingSync.md000066400000000000000000000042611474716233300217650ustar00rootroot00000000000000# Adjusting Synchronisation on Shairport Sync ("SPS") Sometimes, a timing difference can be heard, where the audio coming from the SPS-powered device is slightly ahead or slightly behind another device playing in synchrony. This can sometimes be heard as an irritating "echo". This is usually due to audio amplifier delays: * If your audio output device (including the amplifier in a TV) includes any digital processing component, it probably delays audio while amplifying it. * If your output device is a HDMI-connected device such as a TV or an AV Receiver (AVR), it will almost certainly delay audio by anything up to several hundred milliseconds. In these circumstances, if the output from the SPS device is amplified by a conventional analog-only HiFi amplifier – which has almost no delay – it will be early by comparison with audio coming from the other device. Conversely, if the output from the SPS device is passed through an AVR, then it could be late by comparison with audio amplified by a conventional audio amplifier. The fix for this is to get Shairport Sync to compensate for delays by providing audio to the output device _slightly late_ or _slightly early_, so that when audio emerges from the amplifier, it is in exact synchrony with audio from the other devices. The setting to look for is in the `general` section of the Shairport Sync configuration file and is called `audio_backend_latency_offset_in_seconds`. By default it is `0.0` seconds. For example, to delay the output from the SPS device by 100 milliseconds (0.1 seconds), set the `audio_backend_latency_offset_in_seconds` to `0.1`, so that audio is provided to your output device 100 milliseconds later than nominal synchronisation time. Similarly, to get the output from the SPS device 50 milliseconds (0.05 seconds) early, set the `audio_backend_latency_offset_in_seconds` to `-0.05`, so that audio is provided to your output device 50 milliseconds earlier than nominal synchronisation time. Latency adjustments should be small, not more than about ± 250 milliseconds. Remember to uncomment the line by removing the initial `//` and then restart Shairport Sync (or reboot the device) for the changed setting to take effect. shairport-sync-4.3.7/ADVANCED TOPICS/Events.md000066400000000000000000000075651474716233300204560ustar00rootroot00000000000000# Events Shairport Sync can run programs when certain _events_ occur. The events are: 1. When Shairport Sync goes _active_ or _inactive,_ 3. When audio play starts or stops, 5. When the volume is set or changed. ### Active / Inactive Events Shairport Sync is normally in the `inactive` state when no audio is being played. When audio is sent to Shairport Sync, it will transition from `inactive` to `active`. When the audio stops, Shairport Sync will start a timer. If audio restarts before the timer reaches the value of the `active_state_timeout` setting (10 seconds by default), Shairport Sync will stay `active`. However, if no more audio is received before the timer reaches the `active_state_timeout` value, Shairport Sync will transition to `inactive`. The overall effect of this is that Shairport Sync will go `active` when a track starts and stays active in the interval between tracks, so long as the interval is less than the `active_state_timeout`. When the sequence of tracks ends, Shairport Sync will go `inactive`. * Set the `run_this_before_entering_active_state` setting to the full path name to the program to run before Shairport Sync goes `active`. * Set the `run_this_after_exiting_active_state` setting to the full path name to the program to run after Shairport Sync goes `inactive`. * Set the `active_state_timeout` setting to the maximum amount of time to wait for play to resume before going `inactive`. ### Play Start / Play Stop **Note:** Play events have been superceded by Active/Inactive events, which works better in AirPlay 2 operation. When audio starts, the `play begins` event occurs. When it stops, the `play ends` event occurs. * Set the `run_this_before_play_begins` setting to the full path name to the program to run just before Shairport Sync starts playing. * Set the `run_this_after_play_ends` setting to the full path name to the program to run after Shairport Sync stops playing. ### Volume Adjustment Shairport Sync can run a program whenever the volume is set or changed. * Set `run_this_when_volume_changes` to the full path name to the program to run using the `general` group setting `run_this_when_volume_changes` _but also_ add a space character to the end of the name. This is because when a volume event occurs, Shairport Sync will append the new volume to the text you have specified in `run_this_when_volume_changes` and will then try to execute it. For example, to use the `echo` command to log the volume setting, let's say that you have found that the full path name for `echo` is `/usr/bin/echo`, then you would specify `run_this_when_volume_is_set` as follows: ``` run_this_when_volume_is_set = "/usr/bin/echo "; ``` (Note the extra space at the end of the path name.) Suppose the volume is set or changed to `-24.6`, then Shairport Sync will execute the command `/usr/bin/echo -24.6`. (Without that extra space, it would try to execute `/usr/bin/echo24.6`.) ### Waiting for Completion Set the `wait_for_completion` value to `"yes"` for Shairport Sync to wait until the respective commands have been completed before continuing. ### Program The environment in which the program you specify will be very different to a login environment. In particular, the `PATH` variable will be different. This means that you can't assume that the system will look in the right directories for programs or documents. Therefore, it is _vital_ that you specify everything using a _full path name_. For example, to get the `logger` command to log `Active Start` when Shairport Sync goes active, set `run_this_before_entering_active_state` as follows: ``` run_this_before_entering_active_state = "/usr/bin/logger \"Active Start\""; ``` You can specify a program to be executed or you can specify a script. Make sure the script file is marked as executable and has the appropriate shebang `#!/bin/...` as the first line. Within the script, make sure all references to files are full path names. shairport-sync-4.3.7/ADVANCED TOPICS/GetTheBest.md000066400000000000000000000131001474716233300211660ustar00rootroot00000000000000# Get The Best from Shairport Sync Shairport Sync was designed to run best on dedicated stand-alone low-power "headless" Linux/FreeBSD systems with ALSA as the audio system and with a decent CD-quality Digital to Analog Converter (DAC). ## CPU Power and Memory Computer power and memory requirements are modest – a Raspberry Pi 2 or better, including the Pi Zero 2 W, is fine. Unfortunately, while the original Raspberry Pi and the Pi Zero are powerful enough for AirPlay operation, they are not really suitable for AirPlay 2 operation. ## CPU Clock For best performance, Shairport Sync requires a stable and accurate system clock. This is because the output DAC's output rate is normally determined by the system clock (exceptionally, some high-end USB streamers use their own built-in clocks). If the clock drifts, or if its actual frequency is far from its nominal frequency, Shairport Sync will have to do more interpolation, which inevitably must degrade the audio fidelity, even if it is very hard to hear. Some very old laptops are known to have inaccurate clocks and and some embedded systems can suffer from temperature-related clock drift. Recent Raspberry Pis seem to have very accurate clocks with low drift. ## Linux The best kind of Linux for Shairport Sync is a "bare" Linux. Raspberry Pi OS Lite, Debian Minimal Server, Ubuntu Server, Fedora Server and Arch Linux (Minimal Configuration) are good examples. Shairport Sync also runs on "desktop" Linuxes such as Raspberry Pi OS with desktop, Debian with a desktop environment, Ubuntu Desktop and Fedora Workstation. Desktop Linuxes are less suitable because they almost always use a sound server like PulseAudio or PipeWire. These can interfere with Shairport Sync, which needs direct and exclusive access to the audio hardware. ## DAC A good Digital to Analog Converter (DAC) will have a huge influence on the quality of the audio. Shairport Sync runs at 44,100 frames per second (FPS), each frame consisting of a pair of signed 16 bit linear samples, one for left and one for right. Shairport Sync will take advantage to 24- or 32-bit DACs if available, and will run at 44,100 or 88,200, 176,400 or 352,800 FPS if necessary, though there is no advantage to the higher rates. The 44,100 FPS rate was chosen to match the rate of AirPlay. Good DACs are available at a very wide range of prices, from low-cost USB "Sound Cards" to very high-end HiFi streaming DACs. In the Raspberry Pi world, many very good low-cost I2S DACs, some with integrated amplifiers, are available. The DAC powering the Pi's built-in audio jack is not great, however. While it may be good enough for trying out Shairport Sync or for casual listening, it has a very limited frequency response and can generate very large transients when it starts up. A separate DAC will transform the output quality. **Note** Make sure that the DAC is capable of 44,100 FPS operation – this is really mandatory. Most recent DACs are okay, but some older DACs will only run at 48,000 FPS or multiples of it, and Shairport Sync can not use them. ## Maximum Output Level The `volume_max_db` setting allows you to reduce the maximum level of DAC output to prevent possible overloading of the amplifier or premplifier it feeds. ## Volume Range The volume range is the difference (technically the ratio, expressed in dB) between the highest and lowest level of the volume control. Ideally, this should give the highest volume at the high end and a barely audible sound at the lowest level. Typical volume ranges are 60 dB to 75dB. If the range is much less than this, the difference between high and low volume won't seem large enough to the listener. If the range is much more, much of the low end of the volume control range will be inaudible. (The built-in DAC of the Raspberry Pi has this problem.) Use the `volume_range_db` setting to set the volume range. If the range you request is greater than the range available in the hardware mixer, the built-in attenuator will be used to make up the difference. ## Volume Control Audio is sent at full volume in AirPlay and AirPlay 2 with separate information being sent to set the actual volume. This volume information can be used in four ways: * It can be used to control a built-in attenuator. This is the default. * It can be used to control a mixer built in to the DAC. To use a mixer, set the `mixer_control_name` in the configuration file to the name of the mixer you wish to use. * It can be ignored by Shairport Sync. This may be appropriate when you want the volume to be controlled by just one control, typically an audio system's volume control knob or the volume control of a car radio. To make Shairport Sync ignore the volume information, set `ignore_volume_control` to `"yes"`. * AirPlay volume changes cause events when an executable – a program or executable script – can be called. So, you could get Shairport Sync to ignore volume control information but call an executable to control an external volume control. ## Other Settings * The `disable_standby_mode` setting can be used to prevent the DAC from transitioning between active and standby states, which can sometimes cause a faint popping noise. If activated, Shairport Sync sends frames of silence to keep the DAC busy, preventing it from entering standby mode. * The `disable_synchronisation` setting can be used to prevent Shairport Sync from doing any interpolation whatever. Normally, this would lead to a problem when the DAC's buffer either overflowed or underflowed, but some very high-end streamers adjust the rate at which their DACs run to match the exact rate at which audio arrives, thus preventing underflow or overflow. shairport-sync-4.3.7/ADVANCED TOPICS/InitialConfiguration.md000066400000000000000000000312331474716233300233200ustar00rootroot00000000000000# Finish Setting Up When you complete the instructions in [BUILD.md](../BUILD.md), you have a basic functioning Shairport Sync installation. If you want more control – for example, if you want to use a specific DAC, or if you want AirPlay to control the DAC's volume control – you can use settings in the configuration file (recommended) or you can use command-line options. ## The Configuration File Shairport Sync reads settings from a configuration file at `/etc/shairport-sync.conf` (note that in FreeBSD it will be at `/usr/local/etc/shairport-sync.conf`). When you run `$sudo make install`, a sample configuration file called `shairport-sync.conf.sample` is always installed or updated. This contains all the setting groups and all the settings available, but they all are commented out (comments begin with `//`) so that default values are used. The file contains explanations of the settings, useful hints and suggestions. ## Specifying the Output Device and Mixer Control If you have followed the [BUILD.md](../BUILD.md) instructions, audio received by Shairport Sync will be sent to the `default` device. Depending on the configuration of your system, you may be able to specify a specific hardware output DAC and use its built-in mixer to control volume levels. This would be desirable because (1) the `default` device may be doing further processing on the audio before sending it to the hardware output device, degrading its fidelity, and (2) using the real device's hardware mixer to control volume would give Shairport Sync complete control of the volume range. To get a list of the hardware DACs on your system, refer to the output of `$ shairport-sync -h`. Here is a sample from a Raspberry Pi 3B system: ``` Usage: shairport-sync [options...] or: shairport-sync [options...] -- [audio output-specific options] ... [snip] ... Settings and options for the audio backend "alsa": -d output-device set the output device, default is "default". -c mixer-control set the mixer control name, default is to use no mixer. -m mixer-device set the mixer device, default is the output device. -i mixer-index set the mixer index, default is 0. hardware output devices: "hw:Headphones" "hw:sndrpihifiberry" "hw:vc4hdmi" ... [snip] ... ``` In this system, you can see that there are three hardware output devices, `"hw:Headphones"`, `"hw:sndrpihifiberry"` and `"hw:vc4hdmi"`. Using a tool like `alsamixer`, an output device can be checked to find the name of the volume control mixer. For the first device, the name of the mixer is `"Headphone"`. These setting can be entered into the configuration file, in the `alsa` section, as follows: ``` ... alsa = { output_device = "hw:Headphones"; // the name of the alsa output device. Use "shairport-sync -h" to discover the names of ALSA hardware devices. Use "alsamixer" or "aplay" to find out the names of devices, mixers, etc. mixer_control_name = "Headphone"; // the name of the mixer to use to adjust output volume. If not specified, volume in adjusted in software. ... } ``` Make sure to uncomment entries you wish to make active, and restart Shairport Sync after you have made changes. If you make a syntax error, Shairport Sync will not start and will leave a message in the log. See more details below and in the comments in the configuration file. Please note that if your system has a sound server such as PulseAudio or PipeWire (most desktop linuxes have one of these), you may not be able to access the sound hardware directly, so you may only be able to use the `default` output. ## More about Configuration Settings Settings in the configuration file are grouped. For instance, there is a `general` group within which you can use the `name` tag to set the service name. Suppose you wanted to set the name of the service to `Front Room` and give the service the password `secret`, then you should do the following: ``` general = { name = "Front Room"; password = "secret"; // ... other general settings }; ``` The password setting is only valid for classic Shairport Sync. (Remember, anything preceded by `//` is a comment and will have no effect on the setting of Shairport Sync.) **Important:** You should *never* use an important password as the AirPlay password for a Shairport Sync player – the password is stored in Shairport Sync's configuration file in plain text and is thus completely vulnerable. No backend is specified here, so it will default to the `alsa` backend if more than one back end has been compiled. To route the output to PulseAudio, set: ``` output_backend = "pa"; ``` in the `general` group. The `alsa` group is used to specify properties of the output device. The most obvious setting is the name of the output device which you can set using the `output_device` tag. The following `alsa` group settings are very important for maximum performance. If your audio device has a mixer that can be use to control the volume, then Shairport Sync can use it to give instant response to volume and mute commands and it can offload some work from the processor. * The `mixer_control_name` tag allows you to specify the name of the mixer volume control. * The `mixer_device` tag allows you specify where the mixer is. By default, the mixer is on the `output_device`, so you only need to use the `mixer_device` tag if the mixer is elsewhere. This can happen if you specify a *device* rather than a *card* with the `output_device` tag, because normally a mixer is associated with a *card* rather than a device. Suppose you wish to use the output device `5` of card `hw:0` and the mixer volume-control named `PCM`: ``` alsa = { output_device = "hw:0,5"; mixer_device = "hw:0"; mixer_control_name = "PCM"; // ... other alsa settings }; ``` The `pa` group is used to specify settings relevant to the PulseAudio backend. You can set the "Application Name" that will appear in the "Sound" control panel. Note: Shairport Sync can take configuration settings from command line options. This is mainly for backward compatibility, but sometimes still useful. For normal use, it is recommended that you use the configuration file method. ### Raspberry Pi To make Shairport Sync output to the built-in audio DAC and use its hardware mixer, in the `alsa` section of the configuration file, set the output device and mixer as follows: ``` alsa = { output_device = "hw:Headphones"; // the name of the alsa output device. Use "alsamixer" or "aplay" to find out the names of devices, mixers, etc. mixer_control_name = "Headphone"; // the name of the mixer to use to adjust output volume. If not specified, volume in adjusted in software. // ... other alsa settings ``` (Remember to uncomment the lines by removing the `//` at the start of each.) When these changes have been made, restart Shairport Sync or simply reboot the system. A problem with the built-in DAC that it declares itself to have a very large mixer volume control range – all the way from -102.38dB up to +4dB, a range of 106.38 dB. In reality, only the top 60 dB or so is in any way usable. To help get the most from it, consider using the `volume_range_db` setting in the `general` group to instruct Shairport Sync to use the top of the DAC mixer's declared range. For example, if you set the `volume_range_db` figure to 60, the top 60 dB of the range will the used. With this setting on the Raspberry Pi, maximum volume will be +4dB and minimum volume will be -56dB, below which muting will occur. From a user's point of view, the effect of using this setting is to move the minimum usable volume all the way down to the bottom of the user's volume control, rather than have the minimum usable volume concentrated very close to the maximum volume. ### Examples Here are some examples of complete configuration files. ``` general = { name = "Joe's Stereo"; }; alsa = { output_device = "hw:0"; }; ``` This gives the service the name "Joe's Stereo" and specifies that audio device `hw:0` be used. For best results with the `alsa` backend — including getting true mute and instant response to volume control and pause commands — you should access the hardware volume controls. Use `amixer` or `alsamixer` or similar to discover the name of the mixer control to be used as the `mixer_control_name`. Here is an example for for a Raspberry Pi using its internal soundcard — device hw:0 — that drives the headphone jack: ``` general = { name = "Mike's Boombox"; }; alsa = { output_device = "hw:0"; mixer_control_name = "Headphone"; }; ``` Here is an example of driving a Topping TP30 Digital Amplifier, which has an integrated USB DAC and which is connected as audio device `hw:1`: ``` general = { name = "Kitchen"; }; alsa = { output_device = "hw:1"; mixer_control_name = "PCM"; }; ``` For a cheapo "3D Sound" USB card (Stereo output and input only) on a Raspberry Pi: ``` general = { name = "Front Room"; }; alsa = { output_device = "hw:1"; mixer_control_name = "Speaker"; }; ``` For a first generation Griffin iMic on a Raspberry Pi: ``` general = { name = "Attic"; }; alsa = { output_device = "hw:1"; mixer_control_name = "PCM"; }; ``` On an NSLU2, to drive a first generation Griffin iMic: ``` general = { name = "Den"; }; alsa = { mixer_control_name = "PCM"; }; ``` On an NSLU2, to drive the "3D Sound" USB card: ``` general = { name = "TV Room"; }; alsa = { mixer_control_name = "Speaker"; }; ``` Finally, here is an example of using the PulseAudio backend: ``` general = { name = "Zoe's Computer"; output_backend = "pa"; }; ``` ### Latency Latency is the exact time from a sound signal's original timestamp until that signal actually "appears" on the output of the audio output device, usually a Digital to Audio Converter (DAC), irrespective of any internal delays, processing times, etc. in the computer. Shairport Sync uses latencies supplied by the source, typically either 2 seconds or just over 2.25 seconds. You shouldn't need to change them. Problems can arise when you are trying to synchronise with speaker systems — typically surround-sound home theatre systems — that have their own inherent delays. You can compensate for an inherent delay using the appropriate backend (typically `alsa`) `audio_backend_latency_offset_in_seconds`. Set this offset (in frames) to compensate for a fixed delay in the audio back end; for example, if the output device delays by 100 ms, set this to -0.1. ### Resynchronisation Shairport Sync actively maintains synchronisation with the source. If synchronisation is lost — say due to a busy source or a congested network — Shairport Sync will mute its output and resynchronise. The loss-of-sync threshold is a very conservative 0.050 seconds — i.e. the actual time and the expected time must differ by more than 50 ms to trigger a resynchronisation. Smaller disparities are corrected by insertions or deletions, as described above. * You can vary the resync threshold, or turn resync off completely, with the `general` `resync_threshold_in_seconds` setting. ### Tolerance Playback synchronisation is allowed to wander — to "drift" — a small amount before attempting to correct it. The default is 0.002 seconds, i.e. 2 ms. The smaller the tolerance, the more likely it is that overcorrection will occur. Overcorrection is when more corrections (insertions and deletions) are made than are strictly necessary to keep the stream in sync. Use the `statistics` setting to monitor correction levels. Corrections should not greatly exceed net corrections. * You can vary the tolerance with the `general` `drift_tolerance_in_seconds` setting. ## Command Line Arguments You can use command line arguments to provide settings to Shairport Sync, though newer settings will only be available via the configuration file. For full information, please read the Shairport Sync `man` page, also available at http://htmlpreview.github.io/?https://github.com/mikebrady/shairport-sync/blob/master/man/shairport-sync.html. Apart from the following options, all command line options can be replaced by settings in the configuration file. Here is a brief description of command line options that are not replicated by settings in the settings file. * The `-c` option allows you to specify the location of the configuration file. * The `-V` option gives you version information about Shairport Sync and then quits. * The `-d` option causes Shairport Sync to properly daemonise itself, that is, to run in the background. You may need sudo privileges for this. * The `-k` option causes Shairport Sync to kill an existing Shairport Sync daemon. You may need to have sudo privileges for this. The System V init script at `/etc/init.d/shairport-sync` has a bare minimum : `-d`. Basically all it does is put the program in daemon mode. The program will read its settings from the configuration file. shairport-sync-4.3.7/ADVANCED TOPICS/Metadata.md000066400000000000000000000032421474716233300207160ustar00rootroot00000000000000# Metadata Shairport Sync can deliver metadata supplied by the source, such as Album Name, Artist Name, Cover Art, etc. through a pipe or UDP socket to a recipient application program — see https://github.com/mikebrady/shairport-sync-metadata-reader for a sample recipient. Sources that supply metadata include iTunes and the Music app in macOS and iOS. ## Metadata over UDP As an alternative to sending metadata to a pipe, the `socket_address` and `socket_port` tags may be set in the metadata group to cause Shairport Sync to broadcast UDP packets containing the track metadata. The advantage of UDP is that packets can be sent to a single listener or, if a multicast address is used, to multiple listeners. It also allows metadata to be routed to a different host. However UDP has a maximum packet size of about 65000 bytes; while large enough for most data, Cover Art will often exceed this value. Any metadata exceeding this limit will not be sent over the socket interface. The maximum packet size may be set with the `socket_msglength` tag to any value between 500 and 65000 to control this - lower values may be used to ensure that each UDP packet is sent in a single network frame. The default is 500. Other than this restriction, metadata sent over the socket interface is identical to metadata sent over the pipe interface. The UDP metadata format is very simple - the first four bytes are the metadata *type*, and the next four bytes are the metadata *code* (both are sent in network byte order - see https://github.com/mikebrady/shairport-sync-metadata-reader for a definition of those terms). The remaining bytes of the packet, if any, make up the raw value of the metadata. shairport-sync-4.3.7/ADVANCED TOPICS/PulseAudioAndPipeWire.md000066400000000000000000000063031474716233300233410ustar00rootroot00000000000000# Working with PulseAudio or PipeWire Many Linux systems have [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/) or [PipeWire](https://pipewire.org) installed as [sound servers](https://en.wikipedia.org/wiki/Sound_server), typically providing audio facilities for the system's GUI. Unfortunately, they cause problems for Shairport Sync. As you'll see, these problems can be worked around. The following remarks apply to PulseAudio and PipeWire, so, for simplicity, let's refer to PulseAudio only. To understand the problems, first consider a Linux system that _does not_ have PulseAudio installed. 1. Sound is managed by the Advanced Linux Sound Architecture ("[ALSA](https://www.alsa-project.org/wiki/Main_Page)") subsystem. 2. The ALSA subsystem is loaded and becomes available at system startup. 3. The ALSA `"default"` output device is mapped to the system's audio output DAC. Shairport Sync loads when system startup is complete and provides its service, routing audio to the ALSA default device. Now, consider a Linux system with a Graphical User Interface (GUI) that has PulseAudio installed. 1. As before, sound is managed by the ALSA subsystem. 2. As before, The ALSA subsystem is loaded and becomes available at system startup. 3. PulseAudio loads and becomes a client of ALSA. 4. The PulseAudio service becomes available after a user has logged in through the GUI. Importantly, if you don't log in through the GUI, you won't have a PulseAudio service. 5. The ALSA `"default"` device no longer connects to a real output device. Instead audio sent to the `"default"` device is routed into PulseAudio. Importantly, if you have no PulseAudio service, then the ALSA default device either doesn't exist at all or goes nowhere. # The Problem When Shairport Sync is installed as a system service, it starts after the system has booted up. It runs under a low-priviliged user called `shairport-sync`. Unfortunately, per (4) above, since it was not logged in through the GUI, it won't have a PulseAudio service. If you are using the `"pa"` backend, Shairport Sync may well crash. Per (5) above, the ALSA `"default"` device either won't exist or -- if it does exist -- won't work. Hence, using the `"alsa"` backend, Shairport Sync will either terminate or remain silent. # The Fixes There are three ways to address this problem: 1. Stop using Shairport Sync as a system service. Instead, launch it from a terminal window after log-in through the GUI. Alternatively, create a user service startup script so that it will be launched automatically after the user has logged in. This means that the system can not run without user intervention. 2. If you are using the `"alsa"` backend, set the output device to a real ALSA hardware output device. Use `$ shairport-sync -h` (or, better, [`sps-alsa-explore`](https://github.com/mikebrady/sps-alsa-explore)) to get a list of output devices, and use the configuration file to set the device. There is a possibility this might prevent PulseAudio from working properly. # The Best Fix 3. The best of all fixes is, if possible, to avoid using a system containing PulseAudio altogether. Linux operating systems typically have a "server", "lite" or "headless" version that has no GUI and no PulseAudio. shairport-sync-4.3.7/ADVANCED TOPICS/README.md000066400000000000000000000025271474716233300201400ustar00rootroot00000000000000# Advanced Topics Here you will find links to some advanced features and things you can do with Shairport Sync. * [Finish Setting Up](InitialConfiguration.md). * [Working with PulseAudio or PipeWire](https://github.com/mikebrady/shairport-sync/blob/development/ADVANCED%20TOPICS/PulseAudioAndPipeWire.md). * [Adjusting Sync](AdjustingSync.md) – advance or delay the timing of the output from Shairport Sync to compensate for amplifier delays. * [Get The Best](GetTheBest.md) from your system. * [Metadata](Metadata.md). * [Events](Events.md). * [Statistics](Statistics.md). * Setting up an [MQTT](../MQTT.md) system. * [Digital Signal Processing](https://github.com/mikebrady/shairport-sync/wiki/Digital-Signal-Processing-with-Shairport-Sync). * [Car Installation](../CAR%20INSTALL.md) – build an isolated WiFi network containing a Shairport Sync player on a Raspberry Pi. Suitable for a car radio with an `aux` input or for the stereo in that broadband-free holiday cottage. The configuration file – which contains lots of documentation – is on your system. By default, the sample configuration file is placed at `/etc/shairport-sync.conf.sample` (`/usr/local/etc/shairport-sync.conf.sample` on FreeBSD). You can also view an online version [here](../scripts/shairport-sync.conf). Build configuration flags are discussed [here](CONFIGURATION%20FLAGS.md). shairport-sync-4.3.7/ADVANCED TOPICS/Statistics.md000066400000000000000000000377551474716233300213500ustar00rootroot00000000000000# Statistics If you set the `statistics` setting in the `diagnostics` section of the configuration file to `"YES"`, some statistics will be logged at regular intervals. The items logged will depend on the type of stream being processed: classic AirPlay, AirPlay 2 Buffered Audio or AirPlay 2 Realtime Audio. If the `log_verbosity` is set to 1, 2 or 3, additional items will be logged. From an audio enthusiast's point of view, the most important figure is possibly the `All Sync PPM` figure. This is the total amount of interpolation needed by Shairport Sync to keep the audio stream in sync in the last interval, i.e. the number of frames added plus the number of frames removed from the audio stream, relative to the total number of frames output, expressed in parts per million (PPM). For reference, adding or removing one frame per second into a 44,100 frames per second stream is ± 22.68 PPM. The lower this number number is, the higher the fidelity of the audio signal passed to the output device. On a well sorted system, this figure can be 0.0 for considerable periods, but it can't really be zero forever unless the output device is adapting to the true data rate (some very high-end streamers seem to do so). You may also find that the number might be higher at the start while the system settles down. The second most important figure is possibly the `Sync Error ms`. This is the average synchronisation error in milliseconds in the last interval. Ideally it should be 0.0. By default, Shairport Sync has a tolerance of a sync error of ± 2.0 milliseconds without triggering interpolation. Two other interesting measurements of the output rate may be available – `Output FPS (r)` and `Output FPS (c)`, where `(r)` means "raw" and the `(c)` means "corrected". The "raw" figure is the rate at which the output device (typically a DAC) accepts data measured relative to the computer's own system clock (specifically the `CLOCK_MONOTONIC_RAW` clock). The accuracy of the number depends on the accuracy of the clock, which will typically be accurate to within anything from 20 to 100 ppm. The "corrected" figure is the rate at which the output device accepts data relative to the computer's network-time-disciplined clock (specifically the `CLOCK_MONOTONIC` clock). This clock is normally adjusted ("disciplined") to keep time with network time and should be accurate to with a few tens of milliseconds over a _long_ period. So (1) if you could run a play session for a long period – say a day – and (2) if network time synchronisation is enabled and (3) if the network connection to the network time service is fast and stable, then you should get an accurate absolute measure of exact frame rate of the output device. If your internet connection is not good, the corrected figure will be very inaccurate indeed. Here is a brief description of the figures that might be provided. ##### Sync Error ms Average playback synchronisation error in milliseconds in the last interval. By default, Shairport Sync will allow a sync error of ± 2.0 milliseconds without any interpolation. Positive means late, negative means early. ##### Net Sync PPM This is the net amount of interpolation done by Shairport Sync to keep the audio stream in sync in the last interval, i.e. the number of frames added **minus** the number of frames removed from the audio stream, relative to the total number of frames output, expressed in parts per million (PPM). For reference, adding or removing one frame per second into a 44,100 frames per second stream is 22.68 ppm. ##### All Sync PPM This is the total amount of interpolation done by Shairport Sync to keep the audio stream in sync in the last interval, i.e. the number of frames added **plus** the number of frames removed from the audio stream, relative to the total number of frames output, expressed in parts per million (PPM). The magnitude of this should be the same as the `Net Sync PPM`. If it is much larger it means that Shairport Sync is overcorrecting for sync errors – try increasing the drift tolerance to reduce it. ##### Packets This is the number of packets of audio frames received since the start of the session. A packet normally contains 352 ± 1 audio frames. ##### Missing This is the number of packets of audio frames that were expected but not received in the last interval. It should be zero, and if not it usually indicates a significant problem with the network. classic AirPlay and AirPlay 2 Realtime Streams only. ##### Late This is the number of packets of audio frames that were received late – but still in time to be used – in the last interval. Classic AirPlay and AirPlay 2 Realtime Streams only. ##### Too Late This is the number of packets of audio frames that were received too late to be used in the last interval. It is possible that these packets were already received, so those frames might not actually be missing when the time comes to play them. Classic AirPlay and AirPlay 2 Realtime Streams only. ##### Resend Reqs This is the number of times Shairport Sync requests the resending of missing frames. Requests can be for one or more frames. Classic AirPlay and AirPlay 2 Realtime Streams only. ##### Min DAC Queue The is the smallest number of frames of audio in the DAC's hardware queue. If it goes too low, the DAC may begin to underrun. ##### Min Buffers The is the smallest number of packets of audio in the queue to be processed in the last interval. It is related to the overall latency in Classic AirPlay and AirPlay 2 Realtime Streams. If it comes close to zero it's often a sign that the network is poor. ##### Max Buffers The is the largest number of packets of audio in the queue to be processed in the last interval. ##### Min Buffer Size The is smallest remaining number of bytes in the Buffered Audio buffer in the last interval. It can legitimately be zero when a track ends or begins. If it reaches zero while a track is playing, it means that audio data is not arriving at Shairport Sync quickly enough and may indicate network problems. AirPlay 2 Buffered Audio streams only. ##### Nominal FPS This is the rate specified in the AirPlay stream itself. Classic AirPlay only. ##### Received FPS This is the rate at which frames are received from the network averaged since the start of the play session. Classic AirPlay only. ##### Output FPS (r) Output rate measured relative to the computer system's clock since the start of the play session. See above for a discussion. ##### Output FPS (c) Output rate measured relative to the network-clock-disciplined computer system's clock since the start of the play session. See above for a discussion. ##### Source Drift PPM This is a measure of the difference between the source clock and Shairport Sync's clock expressed in parts per million. Only valid when 10 or more drift samples have been received. Classic AirPlay only. ##### Drift Samples This is the number drift samples have been accepted for calculating the source drift. Classic AirPlay only. #### Example The following example is of an AirPlay 2 Buffered Audio Stream from a HomePod mini to a WiFi-connected Raspberry Pi 3 equipped with a Pimoroni "Audio DAC SHIM (Line-Out)" with `log_verbosity` set to `1` after 3 hours and 37 minutes of operation. The audio is from a radio station accessed through Apple Music: ``` 5.292055362 "rtsp.c:3112" Connection 1. AP2 Buffered Audio Stream. 1.382815677 "player.c:2650" Connection 1: Playback Started -- AirPlay 2 Buffered. 7.899808955 "player.c:2491" Sync Error ms | Net Sync PPM | All Sync PPM | Min DAC Queue | Min Buffer Size | Output FPS (r) | Output FPS (c) ... 8.014025361 "player.c:2491" -1.69 2.8 2.8 7341 198k 44100.04 44100.35 7.992082237 "player.c:2491" -1.70 2.8 2.8 7332 188k 44100.04 44100.34 8.015987549 "player.c:2491" -1.68 0.0 0.0 7334 186k 44100.04 44100.35 8.010537393 "player.c:2491" -1.68 2.8 2.8 7335 187k 44100.04 44100.36 7.993940934 "player.c:2491" -1.85 0.0 0.0 7329 198k 44100.04 44100.37 8.015796195 "player.c:2491" -1.87 5.7 5.7 7325 194k 44100.04 44100.37 8.021665934 "player.c:2491" -1.92 5.7 5.7 7329 190k 44100.04 44100.37 7.990409477 "player.c:2491" -1.85 2.8 2.8 7347 201k 44100.04 44100.37 8.001858278 "player.c:2491" -1.96 17.0 17.0 7332 204k 44100.04 44100.37 8.007150986 "player.c:2491" -1.89 2.8 2.8 7327 195k 44100.04 44100.36 7.998612862 "player.c:2491" -1.87 2.8 2.8 7317 199k 44100.04 44100.36 8.020592653 "player.c:2491" -1.89 11.3 11.3 7323 203k 44100.04 44100.35 8.003245674 "player.c:2491" -1.89 8.5 8.5 7325 198k 44100.04 44100.35 7.990874789 "player.c:2491" -1.98 19.8 19.8 7103 197k 44100.04 44100.34 8.010600257 "player.c:2491" -1.85 2.8 2.8 7327 187k 44100.04 44100.33 8.004573122 "player.c:2491" -1.89 5.7 5.7 7327 187k 44100.04 44100.33 8.012853278 "player.c:2491" -1.89 5.7 5.7 7326 190k 44100.04 44100.32 8.005596664 "player.c:2491" -1.95 22.7 22.7 7322 165k 44100.04 44100.31 8.019198695 "player.c:2491" -1.85 5.7 5.7 7333 166k 44100.04 44100.31 7.999363382 "player.c:2491" -1.79 2.8 2.8 7349 153k 44100.04 44100.30 7.990332549 "player.c:2491" -1.87 5.7 5.7 7328 155k 44100.04 44100.29 8.012287445 "player.c:2491" -1.84 2.8 2.8 7352 185k 44100.04 44100.28 7.998929528 "player.c:2491" -1.94 14.2 14.2 7331 171k 44100.04 44100.28 8.008170622 "player.c:2491" -1.88 5.7 5.7 7327 188k 44100.04 44100.27 8.012935257 "player.c:2491" -1.87 19.8 19.8 7270 205k 44100.04 44100.26 8.006337966 "player.c:2491" -1.86 0.0 0.0 7334 199k 44100.04 44100.25 8.004206612 "player.c:2491" -1.76 2.8 2.8 7331 204k 44100.04 44100.25 7.998495257 "player.c:2491" -1.82 2.8 2.8 7329 204k 44100.04 44100.24 8.016859059 "player.c:2491" -1.88 2.8 2.8 7335 201k 44100.04 44100.23 7.993529320 "player.c:2491" -1.92 14.2 14.2 7329 205k 44100.04 44100.22 8.021956820 "player.c:2491" -1.96 11.3 11.3 7322 206k 44100.04 44100.21 8.006401820 "player.c:2491" -1.93 11.3 11.3 7322 199k 44100.04 44100.21 8.001469111 "player.c:2491" -1.89 5.7 5.7 7336 204k 44100.04 44100.20 7.995194320 "player.c:2491" -1.86 5.7 5.7 7330 202k 44100.04 44100.19 8.017805206 "player.c:2491" -1.99 22.7 22.7 7322 201k 44100.04 44100.18 7.995541038 "player.c:2491" -1.95 22.7 22.7 7331 203k 44100.04 44100.18 8.011463643 "player.c:2491" -1.87 0.0 0.0 7331 207k 44100.04 44100.17 7.995941403 "player.c:2491" -1.85 2.8 2.8 7331 206k 44100.04 44100.16 8.013330570 "player.c:2491" -1.71 2.8 2.8 7344 212k 44100.04 44100.15 8.012214580 "player.c:2491" -1.82 0.0 0.0 7333 203k 44100.04 44100.15 7.998585049 "player.c:2491" -1.85 8.5 8.5 7332 207k 44100.04 44100.14 8.023448799 "player.c:2491" -1.86 5.7 5.7 7328 206k 44100.04 44100.13 7.984586612 "player.c:2491" -1.87 8.5 8.5 7277 205k 44100.04 44100.12 8.017339372 "player.c:2491" -1.91 17.0 17.0 7327 207k 44100.04 44100.12 8.007090309 "player.c:2491" -1.94 17.0 17.0 7286 199k 44100.04 44100.11 8.007894164 "player.c:2491" -1.87 2.8 2.8 7334 201k 44100.04 44100.10 7.991787497 "player.c:2491" -1.89 2.8 2.8 7327 194k 44100.04 44100.09 8.019011611 "player.c:2491" -1.94 5.7 5.7 7323 185k 44100.04 44100.09 7.994695362 "player.c:2491" -1.99 14.2 14.2 7321 199k 44100.04 44100.08 8.010284632 "player.c:2491" -1.93 11.3 11.3 7325 191k 44100.04 44100.07 8.011451612 "player.c:2491" -1.87 8.5 8.5 7329 156k 44100.04 44100.09 7.993112549 "player.c:2491" -1.84 2.8 2.8 7330 150k 44100.04 44100.13 8.004971455 "player.c:2491" -1.77 11.3 11.3 7325 157k 44100.04 44100.16 8.010517133 "player.c:2491" -1.85 0.0 0.0 7322 182k 44100.04 44100.19 8.005598851 "player.c:2491" -2.00 39.7 39.7 7207 180k 44100.04 44100.22 8.006777965 "player.c:2491" -1.99 39.7 39.7 7320 183k 44100.04 44100.24 7.115508696 "player.c:1643" Connection 1: Playback Stopped. Total playing time 03:37:20. Output: 44100.04 (raw), 44100.24 (corrected) frames per second. ``` For reference, a drift of one second per day is approximately 11.57 ppm. Left uncorrected, even a drift this small between two audio outputs will be audible after a short time. shairport-sync-4.3.7/AIRPLAY2.md000066400000000000000000000063731474716233300162420ustar00rootroot00000000000000# AirPlay 2 **Shairport Sync** (as of [v4.1](https://github.com/mikebrady/shairport-sync/releases/tag/4.1) and newer) offers **AirPlay 2** support for audio sources on: - iOS devices, - Macs from macOS 10.15 (Catalina) onwards, - HomePod minis, - and Apple TVs. ## What Works - AirPlay 2 audio for iOS, HomePod mini, AppleTV and Mac players. * Audio is synchronised with other AirPlay 2 devices. * Two types of audio are received by Shairport Sync – "Realtime" streams of CD quality ALAC (like "classic" AirPlay) and "Buffered Audio" streams of AAC stereo at 44,100 frames per second. * The selection of stream type is made by the player. * Realtime streams generally have a latency of about two seconds. Buffered Audio streams typically have a latency of half a second or less. * In AirPlay 2 mode, Shairport Sync reverts to "classic" AirPlay when iTunes on macOS or macOS Music plays to multiple speakers and one of more of them is compatible with AirPlay only. - Devices running Shairport Sync in AirPlay 2 mode can be [added](https://github.com/mikebrady/shairport-sync/blob/development/ADDINGTOHOME.md) to the Home app. ## What Does Not Work - No AirPlay 2 for Windows iTunes. - Remote control facilities are not implemented. - AirPlay 2 from macOS prior to 10.15 (Catalina) is not supported. ## General Shairport Sync uses a companion application called [NQPTP](https://github.com/mikebrady/nqptp) ("Not Quite PTP") for timing and synchronisation in AirPlay 2. NQPTP must have exclusive access to ports `319` and `320`. Lossless and High Definition Lossless material is transcoded to AAC before it reaches Shairport Sync. ## What You Need AirPlay 2 support needs a slightly more powerful CPU for decoding and synchronisation and more memory for bigger buffers and larger libraries. A system with the power of a Raspberry Pi 2 or Raspberry Pi Zero 2 W, or better, is recommended. Here are some guidelines: * Full access, including network capabilities or `root` privileges, to a system at least as powerful as a Raspberry Pi 2 or a Raspberry Pi Zero 2 W. * Ports 319 and 320 must be free to use (i.e. they must not be in use by another service such as a PTP service) and must not be blocked by a firewall. * An up-to-date system. This is important, as some of the libraries must be the latest available. * Shairport Sync will not run in AirPlay 2 mode on a Mac because NQPTP, on which it relies, needs ports 319 and 320, which are already used by macOS. * A version of the [FFmpeg](https://www.ffmpeg.org) library with an AAC decoder capable of decoding Floating Planar -- `fltp` -- material. There is a guide [here](TROUBLESHOOTING.md#aac-decoder-issues-airplay-2-only) to help you find out if your system has it. * An audio output. The device must be capable of running at 44,100 frames per second. You can use [`sps-alsa-explore`](https://github.com/mikebrady/sps-alsa-explore) to test the suitability of hardware ALSA audio devices on your device. Other backends continue to work as with "classic" Shairport Sync. - Multiple instances of the AirPlay 2 version of Shairport Sync can not be hosted on the same system. It seems that AirPlay 2 clients are confused by having multiple AirPlay 2 players at the same IP addresses. ## Guides * A building guide is available at [BUILD.md](BUILD.md). shairport-sync-4.3.7/AUTHORS000066400000000000000000000000001474716233300155620ustar00rootroot00000000000000shairport-sync-4.3.7/BUILD.md000066400000000000000000000240741474716233300157140ustar00rootroot00000000000000# Build and Install Shairport Sync This guide is for a basic installation of Shairport Sync in a recent (2018 onwards) Linux or FreeBSD. Shairport Sync can be built as an AirPlay 2 player (with [some limitations](AIRPLAY2.md#features-and-limitations)) or as "classic" Shairport Sync – a player for the older, but still supported, AirPlay (aka "AirPlay 1") protocol. Check ["What You Need"](AIRPLAY2.md#what-you-need) for some basic system requirements. Overall, you'll be building and installing two programs – Shairport Sync itself and [NQPTP](https://github.com/mikebrady/nqptp), a companion app that Shairport Sync uses for AirPlay 2 timing. If you are building classic Shairport Sync, NQPTP is unnecessary and can be omitted. In the commands below, note the convention that a `#` prompt means you are in superuser mode and a `$` prompt means you are in a regular unprivileged user mode. You can use `sudo` *("SUperuser DO")* to temporarily promote yourself from user to superuser, if permitted. For example, if you want to execute `apt-get update` in superuser mode and you are in user mode, enter `sudo apt-get update`. ## 1. Prepare #### Remove Old Copies of Shairport Sync Before you begin building Shairport Sync, it's best to remove any existing copies of the application, called `shairport-sync`. Use the command `$ which shairport-sync` to find them. For example, if `shairport-sync` has been installed previously, this might happen: ``` $ which shairport-sync /usr/local/bin/shairport-sync ``` Remove it as follows: ``` # rm /usr/local/bin/shairport-sync ``` Do this until no more copies of `shairport-sync` are found. #### Remove Old Service Files You should also remove any of the following service files that may be present: * `/etc/systemd/system/shairport-sync.service` * `/etc/systemd/user/shairport-sync.service` * `/lib/systemd/system/shairport-sync.service` * `/lib/systemd/user/shairport-sync.service` * `/etc/init.d/shairport-sync` New service files will be installed if necessary at the `# make install` stage. #### Reboot after Cleaning Up If you removed any installations of Shairport Sync or any of its service files in the last two steps, you should reboot. ## 2. Get Tools and Libraries Okay, now let's get the tools and libraries for building and installing Shairport Sync (and NQPTP). ### Debian / Raspberry Pi OS / Ubuntu ``` # apt update # apt upgrade # this is optional but recommended # apt install --no-install-recommends build-essential git autoconf automake libtool \ libpopt-dev libconfig-dev libasound2-dev avahi-daemon libavahi-client-dev libssl-dev libsoxr-dev \ libplist-dev libsodium-dev libavutil-dev libavcodec-dev libavformat-dev uuid-dev libgcrypt-dev xxd ``` If you are building classic Shairport Sync, the list of packages is shorter: ``` # apt update # apt upgrade # this is optional but recommended # apt-get install --no-install-recommends build-essential git autoconf automake libtool \ libpopt-dev libconfig-dev libasound2-dev avahi-daemon libavahi-client-dev libssl-dev libsoxr-dev ``` ### Fedora (Fedora 40) For AirPlay 2 operation, _before you install the libraries_, please ensure the you have [enabled](https://docs.fedoraproject.org/en-US/quick-docs/rpmfusion-setup) RPM Fusion software repositories to the "Nonfree" level. If this is not done, the FFmpeg libraries will lack a suitable AAC decoder, preventing Shairport Sync from working in AirPlay 2 mode. ``` # yum update # yum install --allowerasing make automake gcc gcc-c++ \ git autoconf automake avahi-devel libconfig-devel openssl-devel popt-devel soxr-devel \ ffmpeg ffmpeg-devel libplist-devel libsodium-devel libgcrypt-devel libuuid-devel vim-common \ alsa-lib-devel ``` If you are building classic Shairport Sync, the list of packages is shorter: ``` # yum update # yum install make automake gcc gcc-c++ \ git autoconf automake avahi-devel libconfig-devel openssl-devel popt-devel soxr-devel \ alsa-lib-devel ``` ### Arch Linux After you have installed the libraries, note that you should enable and start the `avahi-daemon` service. ``` # pacman -Syu # pacman -Sy git base-devel alsa-lib popt libsoxr avahi libconfig \ libsndfile libsodium ffmpeg vim libplist ``` If you are building classic Shairport Sync, the list of packages is shorter: ``` # pacman -Syu # pacman -Sy git base-devel alsa-lib popt libsoxr avahi libconfig ``` Enable and start the `avahi-daemon` service. ``` # systemctl enable avahi-daemon # systemctl start avahi-daemon ``` ### FreeBSD First, update everything: ``` # freebsd-update fetch # freebsd-update install # pkg # pkg update ``` Next, install the Avahi subsystem. FYI, `avahi-app` is chosen because it doesn’t require X11. `nss_mdns` is included to allow FreeBSD to resolve mDNS-originated addresses – it's not actually needed by Shairport Sync. Thanks to [reidransom](https://gist.github.com/reidransom/6033227) for this. ``` # pkg install avahi-app nss_mdns ``` Add these lines to `/etc/rc.conf`: ``` dbus_enable="YES" avahi_daemon_enable="YES" ``` Next, change the `hosts:` line in `/etc/nsswitch.conf` to ``` hosts: files dns mdns ``` Reboot for these changes to take effect. Next, install the packages that are needed for Shairport Sync and NQPTP: ``` # pkg install git autotools pkgconf popt libconfig openssl alsa-utils libsoxr \ libplist libsodium ffmpeg e2fsprogs-libuuid vim ``` If you are building classic Shairport Sync, the list of packages is shorter: ``` # pkg install git autotools pkgconf popt libconfig openssl alsa-utils libsoxr ``` ## 3. Build ### NQPTP Skip this section if you are building classic Shairport Sync – NQPTP is not needed for classic Shairport Sync. Download, install, enable and start NQPTP from [here](https://github.com/mikebrady/nqptp). ### Shairport Sync #### Build and Install Download Shairport Sync, branch and configure, compile and install it. Before executing the commands, please note the following: * If building for FreeBSD, replace `--with-systemd` with `--with-os=freebsd --with-freebsd-service`. * Omit the `--with-airplay-2` from the `./configure` options if you are building classic Shairport Sync. * If you wish to add extra features, for example an extra audio backend, take a look at the [configuration flags](CONFIGURATION%20FLAGS.md). For this walkthrough, though, please do not remove the `--with-alsa` flag. ``` $ git clone https://github.com/mikebrady/shairport-sync.git $ cd shairport-sync $ autoreconf -fi $ ./configure --sysconfdir=/etc --with-alsa \ --with-soxr --with-avahi --with-ssl=openssl --with-systemd --with-airplay-2 $ make # make install ``` By the way, the `autoreconf` step may take quite a while – please be patient! ## 4. Test At this point, Shairport Sync should be built and installed but not running. If the user you are logged in as is a member of the unix `audio` group, Shairport Sync should run from the command line: ``` $ shairport-sync ``` * Add the `-v` command line option to get some diagnostics. * Add the `--statistics` option to get some infomation about the audio received. The AirPlay service should appear on the network and the audio you play should come through to the default ALSA device. (Use `alsamixer` or similar to adjust levels.) If you have problems, please check the items in Final Notes below, or in the [TROUBLESHOOTING.md](TROUBLESHOOTING.md) guide. Note: Shairport Sync will run indefinitely -- use Control-C it to stop it. ## 5. Enable and Start Service If your system has a Graphical User Interface (GUI) it probably uses PulseAudio or PipeWire for audio services. If that is the case, please review [Working with PulseAudio or PipeWire](https://github.com/mikebrady/shairport-sync/blob/master/ADVANCED%20TOPICS/PulseAudioAndPipeWire.md). Otherwise, once you are happy that Shairport Sync runs from the command line, you should enable and start the `shairport-sync` service. This will launch Shairport Sync automatically as a background "daemon" service when the system powers up: ### Linux ``` # systemctl enable shairport-sync ``` ### FreeBSD To make the `shairport-sync` daemon load at startup, add the following line to `/etc/rc.conf`: ``` shairport_sync_enable="YES" ``` ## 6. Check Reboot the machine. The AirPlay service should once again be visible on the network and audio will be sent to the default ALSA device. ## 7. Final Notes A number of system settings can affect Shairport Sync. Please review them as follows: ### Power Saving If your computer has an `Automatic Suspend` Power Saving Option, you should experiment with disabling it, because your computer has to be available for AirPlay service at all times. ### WiFi Power Management – Linux If you are using WiFi, you should turn off WiFi Power Management: ``` # iwconfig wlan0 power off ``` or ``` # iw dev wlan0 set power_save off ``` The motivation for this is that WiFi Power Management will put the WiFi system in low-power mode when the WiFi system is considered inactive. In this mode, the system may not respond to events initiated from the network, such as AirPlay requests. Hence, WiFi Power Management should be turned off. See [TROUBLESHOOTING.md](https://github.com/mikebrady/shairport-sync/blob/master/TROUBLESHOOTING.md#wifi-adapter-running-in-power-saving--low-power-mode) for more details. (You can find WiFi device names (e.g. `wlan0`) with `$ ifconfig`.) ### Firewall If a firewall is running (some systems, e.g. Fedora, run a firewall by default), ensure it is not blocking ports needed by Shairport Sync and [NQPTP](https://github.com/mikebrady/nqptp/blob/main/README.md#firewall). ## 8. Connect and enjoy... ### Add to Home With AirPlay 2, you can follow the steps in [ADDINGTOHOME.md](ADDINGTOHOME.md) to add your device to the Apple Home system. ### Wait, there's more... Instead of using default values for everything, you can use the configuration file to get finer control over the setup, particularly the output device and mixer control -- see [Finish Setting Up](ADVANCED%20TOPICS/InitialConfiguration.md). Please take a look at [Advanced Topics](ADVANCED%20TOPICS/README.md) for some ideas about what else you can do to enhance the operation of Shairport Sync. For example, you can adjust synchronisation to compensate for delays in your system. shairport-sync-4.3.7/CAR INSTALL.md000066400000000000000000000373441474716233300165550ustar00rootroot00000000000000# Shairport Sync for Cars If your car audio has an AUX input, you can get AirPlay in your car using Shairport Sync. Together, Shairport Sync and an iPhone or an iPad with cellular capability can give you access to internet radio, YouTube, Apple Music, Spotify, etc. on the move. While Shairport Sync is no substitute for CarPlay, the audio quality is often much better than Bluetooth. ## The Basic Idea The basic idea is to use a small Linux computer to create an isolated WiFi network (a "car network") and run Shairport Sync on it to provide an AirPlay service. An iPhone or an iPad with cellular capability can simultaneously connect to internet radio, YouTube, Apple Music, Spotify, etc. over the cellular network and send AirPlay audio through the car network to the AirPlay service provided by Shairport Sync. This sends the audio to the computer's DAC which is connected to the AUX input of your car audio. Please note that Android phones and tablets can not, so far, do this trick of using the two networks simultaneously. ## Example If you are updating an existing installation, please refer to the [updating](#updating) section below. In this example, a Raspberry Pi Zero 2 W and a Pimoroni PHAT DAC are used. Shairport Sync will be built for AirPlay 2 operation, but you can build it for "classic" AirPlay (aka AirPlay 1) operation if you prefer. A Pi Zero W is powerful enough for classic AirPlay. Please note that some of the details of setting up networks are specific to the version of Linux used. ### Prepare the initial SD Image * Download Raspberry Pi OS (Lite) and install it onto an SD Card using `Raspberry Pi Imager`. The Lite version is preferable to the Desktop version as it doesn't include a sound server like PulseAudio or PipeWire that can prevent direct access to the audio output device. * Before writing the image to the card, use the Settings control on `Raspberry Pi Imager` to set hostname, enable SSH and provide a username and password to use while building the system. Similarly, you can specify a wireless network the Pi will connect to while building the system. Later on, the Pi will be configured to start its own isolated network. * The next few steps are to add the overlay needed for the sound card. This may not be necessary in your case, but in this example a Pimoroni PHAT is being used. If you do not need to add an overlay, skip these steps. * Mount the card on a Linux machine. Two drives should appear – a `boot` drive and a `rootfs` drive. * `cd` to the `boot` drive (since my username is `mike`, it will be `$ cd /media/mike/boot`). * Edit the `config.txt` file to add the overlay needed for the sound card. This may not be necessary in your case, but in this example a Pimoroni PHAT is being used and it needs the following entry to be added: ``` dtoverlay=hifiberry-dac ``` * Close the file and carefully dismount and eject the two drives. *Be sure to dismount and eject the drives properly; otherwise they may be corrupted.* * Remove the SD card from the Linux machine, insert it into the Pi and reboot. After a short time, the Pi should appear on your network – it may take a couple of minutes. To check, try to `ping` it at the `.local`, e.g. if the hostname is `bmw` then use `$ ping bmw.local`. Once it has appeared, you can SSH into it and configure it. ### Boot, Configure, Update The first thing to do on a Pi would be to use the `raspi-config` tool to expand the file system to use the entire card. Next, do the usual update and upgrade: ``` # apt-get update # apt-get upgrade ``` ### Build and Install Let's get the tools and libraries for building and installing Shairport Sync (and NQPTP). ``` # apt install --no-install-recommends build-essential git xmltoman autoconf automake libtool \ libpopt-dev libconfig-dev libasound2-dev avahi-daemon libavahi-client-dev libssl-dev libsoxr-dev \ libplist-dev libsodium-dev libavutil-dev libavcodec-dev libavformat-dev uuid-dev libgcrypt-dev xxd ``` If you are building classic Shairport Sync, the list of packages is shorter: ``` # apt-get install --no-install-recommends build-essential git xmltoman autoconf automake libtool \ libpopt-dev libconfig-dev libasound2-dev avahi-daemon libavahi-client-dev libssl-dev libsoxr-dev ``` #### NQPTP Skip this section if you are building classic Shairport Sync – NQPTP is not needed for classic Shairport Sync. Download, install, enable and start NQPTP from [here](https://github.com/mikebrady/nqptp) following the guide for Linux. #### Shairport Sync Download Shairport Sync, configure, compile and install it. * Omit the `--with-airplay-2` from the `./configure` options if you are building classic Shairport Sync. ``` $ git clone https://github.com/mikebrady/shairport-sync.git $ cd shairport-sync $ autoreconf -fi $ ./configure --sysconfdir=/etc --with-alsa \ --with-soxr --with-avahi --with-ssl=openssl --with-systemd --with-airplay-2 $ make # make install # systemctl enable shairport-sync ``` The `autoreconf` step may take quite a while – please be patient! ### Configure Shairport Sync Here are the important options for the Shairport Sync configuration file at `/etc/shairport-sync.conf`: ``` // Sample Configuration File for Shairport Sync for Car Audio with a Pimoroni PHAT general = { name = "BMW Radio"; ignore_volume_control = "yes"; volume_max_db = -3.00; }; alsa = { output_device = "hw:1"; // the name of the alsa output device. Use "alsamixer" or "aplay" to find out the names of devices, mixers, etc. }; ``` Two `general` settings are worth noting. 1. First, the option to ignore the sending device's volume control is enabled. This means that the car audio's volume control is the only one that affects the audio volume. This is a matter of personal preference. 2. Second, the maximum output offered by the DAC to the AUX port of the car audio can be reduced if it is overloading the car audio's input circuits and causing distortion. Again, that's a matter for personal selection and adjustment. The `alsa` settings are for the Pimoroni PHAT – it does not have a hardware mixer, so no `mixer_control_name` is given. The DAC's 32-bit capability is automatically selected if available, so there is no need to set it here. Similarly, since `soxr` support is included in the build, `soxr` interpolation will be automatically enabled if the device is fast enough. ### Extra Packages A number of packages to enable the Pi to work as a WiFi base station are needed: ``` # apt install --no-install-recommends hostapd isc-dhcp-server ``` (The installer will get errors trying to set up both of these services; the errors can be ignored.) Disable both of these services from starting at boot time (this is because we will launch them sequentially later on): ``` # systemctl unmask hostapd # systemctl disable hostapd # systemctl disable isc-dhcp-server ``` #### Configure HostAPD Configure `hostapd` by creating `/etc/hostapd/hostapd.conf` with the following contents which will set up an open network with the name BMW. You might wish to change the name: ``` # Thanks to https://wiki.gentoo.org/wiki/Hostapd#802.11b.2Fg.2Fn_triple_AP # The interface used by the AP interface=wlan0 # This is the name of the network -- yours may be different ssid=BMW # "g" simply means 2.4GHz band hw_mode=g # Channel to use channel=11 # Limit the frequencies used to those allowed in the country ieee80211d=1 # The country code country_code=IE # Enable 802.11n support ieee80211n=1 # QoS support, also required for full speed on 802.11n/ac/ax wmm_enabled=1 ``` Note that, since the car network is isolated from the Internet, you don't really need to secure it with a password. #### Configure DHCP server First, replace the contents of `/etc/dhcp/dhcpd.conf` with this: ``` subnet 10.0.10.0 netmask 255.255.255.0 { range 10.0.10.5 10.0.10.150; #option routers ; #option broadcast-address ; } ``` Second, modify the `INTERFACESv4` entry at the end of the file `/etc/default/isc-dhcp-server` to look as follows: ``` INTERFACESv4="wlan0" INTERFACESv6="" ``` ### Set up the Startup Sequence Configure the startup sequence by adding commands to `/etc/rc.local` to start `hostapd` and the `dhcp` automatically after startup. Its contents should look like this: ``` #!/bin/sh -e # # rc.local # # Shairport Sync is automatically started as a service on startup. # If MODE is set to RUN, the system will start the WiFi access point. # If MODE is set to anything else, e.g. DEV, the system will not start the WiFi access point. # Instead, you can connect the system to a network. # If it still has the WiFi credentials of the last WiFi network it connected to, # it can connect to it automatically. MODE=RUN /bin/sleep 2 # may be necessary while wlan0 becomes available /sbin/iw dev wlan0 set power_save off # always do this if test $MODE = RUN ; then # If script execution gets in here, it starts the WiFi access point. /usr/sbin/hostapd -B -P /run/hostapd.pid /etc/hostapd/hostapd.conf /sbin/ip addr add 10.0.10.1/24 dev wlan0 /bin/systemctl start isc-dhcp-server else # If script execution gets in here, it starts services needed for normal operation. /bin/systemctl start dhcpcd || /bin/systemctl start NetworkManager || : /bin/sleep 2 # may be necessary while the network becomes available /bin/systemctl start systemd-timesyncd || : fi exit 0 # normal exit here ``` #### Disable Unused Services - Optional These optional steps have been tested on a Raspberry Pi only -- they have not been tested on other systems. Some services are not necessary for this setup and can be disabled as follows: ``` # systemctl disable keyboard-setup # systemctl disable triggerhappy # systemctl disable dphys-swapfile ``` #### Disable Unused Services - Mandatory You now need to disable some services; that is, you need to stop them starting automatically on power-up. This is because they either interfere with the system's operation in WiFi Access Point mode, or because they won't work when the system isn't connected to the Internet. Only one of the `NetworkManager` and the `dhcpcd` service will be present in your system, but it's no harm to try to disable both. ``` # systemctl disable dhcpcd # systemctl disable NetworkManager # systemctl disable wpa_supplicant # systemctl disable systemd-timesyncd ``` Lastly, note that the WiFi credentials you used initially to connect to your network (e.g. your home network) will have been stored in the system in plain text. This is convenient for when you want to reconnect to update (see later), but if you prefer to delete them, they will be in `/etc/wpa_supplicant/wpa_supplicant.conf`. #### Optional: Read-only mode – Raspberry Pi Specific This optional step is applicable to a Raspberry Pi only. Run `sudo raspi-config` and then choose `Performance Options` > `Overlay Filesystem` and choose to enable the overlay filesystem, and to set the boot partition to be write-protected. (The idea here is that this offers more protection against files being corrupted by the sudden removal of power.) ### Final Step When you are finished, carefully power down the machine before unplugging it from power: ``` # poweroff ``` Note: doing a `reboot` here doesn't seem to work properly -- it really does seem necessary to power off. ### Ready Install the Raspberry Pi in your car. It should be powered from a source that is switched off when you leave the car, otherwise the slight current drain will eventually flatten the car's battery. When the power source is switched on -- typically when you start the car -- it will take around 35 seconds for the system to become available (timing based on a Raspberry Pi Zero 2 W running Bookworm). ### Enjoy! --- ## Updating From time to time, you may wish to update this installation. Assuming you haven't deleted your original WiFi network credentials, the easiest thing is to temporarily reconnect to the network you used when you created the system. You can then update the operating system and libraries in the normal way and then update Shairport Sync. However, if you're *upgrading* the operating system to e.g. from Bullseye to Bookworm, the names and index numbers of the output devices may change, and the names of the mixer controls may also change. You can use [`sps-alsa-explore`](https://github.com/mikebrady/sps-alsa-explore) to discover device names and mixer names. #### Exit Raspberry Pi Read-Only Mode If it's a Raspberry Pi and you have optionally enabled the read-only mode, you must take the device out of Read-only mode: Run `sudo raspi-config` and then choose `Performance Options` > `Overlay Filesystem` and choose to disable the overlay filesystem and to set the boot partition not to be write-protected. This is so that changes can be written to the file system; you can make the filesystem read-only again later. Save the changes and reboot the system. #### Undo Optimisations If you have disabled any of the services listed in the [Disable Unused Services - Optional](#disable-unused-services---optional) section, you should re-enable them. (But *do not* re-eneable `NetworkManager`, `dhcpcd`, `wpa_supplicant` or `systemd-timesyncd` -- they are handled specially by the startup script.) #### Perform Legacy Updates Over time, the arrangements by which the system is prepared for operation has changed to make it easier to revert to normal operation when necessary for maintenance, updates, etc. A small number of the old settings need to be changed to bring them up to date with the present arrangements. Once the required changes have been made, your system will be ready for the update process detailed below. Here are those legacy changes you need to make, just once: 1. If there is a file called `/etc/dhcpcd.conf` and if the first line reads: ``` denyinterfaces wlan0 ``` then delete that line -- it is no longer needed and will cause problems in future if it remains there. If the file `/etc/dhcpcd.conf` doesn't exist, or if the first line is not `denyinterfaces wlan0`, then you don't need to do anything. 2. Replace the contents of the file `/etc/rc.local` with the new contents given [above](#set-up-the-startup-sequence). 3. Disable a number of services as follows. Only one of the `NetworkManager` and the `dhcpcd` service will be present in your system, but it's no harm to try to disable both. ``` # systemctl disable dhcpcd # systemctl disable NetworkManager # systemctl disable wpa_supplicant # systemctl disable systemd-timesyncd ``` 4. Enable the `shairport-sync` service itself: ``` # systemctl enable shairport-sync ``` Once you have made these one-off legacy updates, you can proceed to the next stage -- performing the update. ### Performing the Update To update, take the following steps: #### Temporarily reconnect to a network and update 1. Edit the startup script in `/etc/rc.local` to so that the system is no longer in the RUN mode. To do that, change line 15 so that it goes from this: ``` MODE=RUN ``` to this: ``` MODE=DEV ``` Do not be tempted to insert any spaces anywhere -- Unix scripting syntax is very strict! 2. Save and close the file and reboot. From this point on, the system will start normally and can be connected to a network. If it still has the WiFi credentials of the last network it was connected to, then it could automatically reconnect. The system is now ready for updating in the normal way. #### Revert to normal operation When you are finished updating, you need to put the system back into its RUN mode, as follows: 1. Edit the startup script in `/etc/rc.local` to so that the MODE variable is set to RUN. To do that, change line 15 so that it goes from this: ``` MODE=DEV ``` to this: ``` MODE=RUN ``` Once again, do insert any spaces anywhere. 2. Save and close the file and reboot. The system should start as it would if it was in the car. shairport-sync-4.3.7/CONFIGURATION FLAGS.md000066400000000000000000000314241474716233300176760ustar00rootroot00000000000000# Configuration Flags When the application is being built, these flags determine what capabilities are included in Shairport Sync. For example, to include DSP capabilities – needed for a loudness filter – you would include the `--with-convolution` flag in the list of options at the `./configure ...` stage when building the application. In the following sections, Shairport Sync's compilation configuration options are detailed by catgegory. ## AirPlay 2 or AirPlay | Flag | | ---- | | `--with-airplay-2` | AirPlay 2 is the current version of the AirPlay protocol. It offers multi-room operation and integration with the Home application. However, the Shairport Sync implementation is doesn't support iTunes on Windows, and its integration with the Home app and support for remote control is incomplete. Additionally, it requires a somewhat more powerful computer system (Raspberry Pi 2 equivalent or better) and a recent (2018 or later) version of a Debian-like Linux, Alpine Linux or FreeBSD. It has not been tested on other Linux distributions such as OpenWrt. Finally, AirPlay 2 can be lossy – in one mode of operation, audio is encoded in 256kbps AAC. AirPlay (aka AirPlay 1) is an older version of the AirPlay protocol. If offers multi-room operation to iTunes on macOS or Windows, the Music app on macOS and some third-party computer applications such as [OwnTone](https://owntone.github.io/owntone-server/). It will run on lower powered machines, e.g. the original Raspberry Pi and many embedded devices. This version of AirPlay is lossless – audio is received in 44,100 frames per second 16-bit interleaved stereo ALAC format. It is compatible with a wider range of Linux distributions, back to around 2012. However, support for this version of AirPlay seems to be gradually waning. It does not offer multi-room operation to iOS, iPadOS or AppleTV and is incompatible with HomePod. It is not integrated with the Home app. To build Shairport Sync for AirPlay 2, include the `--with-airplay-2` option in the `./configure ...` options. You will also have to include extra libraries. Omitting this option will cause Shairport Sync to be built for the older AirPlay protocol. ## Audio Output | Flags | | ----- | | `--with-alsa` | | `--with-sndio` | | `--with-pa` | | `--with-pw` | | `--with-ao` | | `--with-jack` | | `--with-soundio` | | `--with-stdout` | | `--with-pipe` | Shairport Sync has a number of different "backends" that send audio to an onward destination, e.g. an audio subsystem for output to a Digital to Audio Converter and thence to loudspeakers, or to a pipe for further processing. You can use configuration options to include support for multiple backends at build time and select one of them at runtime. Here are the audio backend configuration options: - `--with-alsa` Output to the Advanced Linux Sound Architecture ([ALSA](https://www.alsa-project.org/wiki/Main_Page)) system. This is recommended for highest quality. - `--with-sndio` Output to the FreeBSD-native [sndio](https://sndio.org) system. - `--with-pa` Include the PulseAudio audio back end. - `--with-pw` Output to the [PipeWire](https://pipewire.org) system. - `--with-ao` Output to the [libao](https://xiph.org/ao/) system. No synchronisation. - `--with-jack` Output to the [Jack Audio](https://jackaudio.org) system. - `--with-soundio` Include an optional backend module for audio to be output through the [`soundio`](http://libsound.io) system. No synchronisation. - `--with-stdout` Include an optional backend module to enable raw audio to be output through standard output (`STDOUT`). - `--with-pipe` Include an optional backend module to enable raw audio to be output through a unix pipe. ### PulseAudio and PipeWire Many recent Linux distributions with a GUI -- "desktop" Linuxes -- use PulseAudio or PipeWire to handle sound. There are two things to consider with these sound servers: 1. They may not always be available: a sound server generally becomes available when a user logs in via the GUI and disappears when the user logs out; it is not available when the system starts up and it is not available to non-GUI users. This means that Shairport Sync can not run as a daemon (see "Daemonisation" below) using a sound server unless the sound server is configured as a system-wide service. 2. The fidelity of the audio is unknown: once audio is delivered to the sound server, it is unknown what happens to it as it is processed through PulseAudio to arrives eventually at the loudspeakers. It should be noted that both PulseAudio and PipeWire provide a default ALSA pseudo device that enables ALSA-compatible programs to send audio. Shairport Sync can therefore use the ALSA backend with PulseAudio- or PipeWire-based systems. ## Audio Options | Flags | | ----- | | `--with-soxr` | | `--with-apple-alac` | | `--with-convolution` | - `--with-soxr` Allows Shairport Sync to use [libsoxr](https://sourceforge.net/p/soxr/wiki/Home/)-based resampling for improved interpolation. Recommended. - `--with-apple-alac` Allows Shairport Sync to use the Apple ALAC Decoder. Requires [`libalac`](https://github.com/mikebrady/alac). - `--with-convolution` Includes a convolution filter that can be used to apply effects such as frequency and phase correction, and a loudness filter that compensates for the non-linearity of the human auditory system. Requires `libsndfile`. ## Metadata | Flags | | ----- | | `--with-metadata` | Metadata such as track name, artist name, album name, cover art and more can be requested from the player and passed to other applications. - `--with-metadata` Adds support for Shairport Sync to request metadata and to pipe it to a compatible application. See https://github.com/mikebrady/shairport-sync-metadata-reader for a sample metadata reader. ## Inter Process Communication | Flags | | ----- | | `--with-mqtt-client` | | `--with-dbus-interface` | | `--with-dbus-test-client` | | `--with-mpris-interface` | | `--with-mpris-test-client` | Shairport Sync offers three Inter Process Communication (IPC) interfaces: an [MQTT](https://mqtt.org) interface, an [MPRIS](https://specifications.freedesktop.org/mpris-spec/latest/)-like interface and a Shairport Sync specific "native" D-Bus interface loosely based on MPRIS. The options are as follows: - `--with-mqtt-client` Includes a client for [MQTT](https://mqtt.org), - `--with-dbus-interface` Includes support for the native Shairport Sync D-Bus interface, - `--with-dbus-test-client` Compiles a D-Bus test client application, - `--with-mpris-interface` Includes support for a D-Bus interface conforming as far as possible with the MPRIS standard, - `--with-mpris-test-client` Compiles an MPRIS test client application. D-Bus and MPRIS commands and properties can be viewed using utilities such as [D-Feet](https://wiki.gnome.org/Apps/DFeet). ##### MPRIS The MPRIS interface has to depart somewhat from full MPRIS compatibility due to logical differences between Shairport Sync and a full standalone audio player such as Rhythmbox. Basically there are some things that Shairport Sync itself can not control that a standalone player can control. A good example is volume control. MPRIS has a read-write `Volume` property, so the volume can be read or set. However, all Shairport Sync can do is *request* the player to change the volume control. This request may or may not be carried out, and it may or may not be done accurately. So, in Shairport Sync's MPRIS interface, `Volume` is a read-only property, and an extra command called `SetVolume` is provided. ## Other Configuration Options ### Configuration Files | Flags | | ----- | | `--sysconfdir=` | Shairport Sync will look for a configuration file – `shairport-sync.conf` by default – when it starts up. By default, it will look in the directory specified by the `sysconfdir` configuration variable, which defaults to `/usr/local/etc`. This is normal in BSD Unixes, but is unusual in Linux. Hence, for Linux installations, you need to set the `sysconfdir` variable to `/etc` using the configuration setting `--sysconfdir=/etc`. ### Daemonisation | Flags | | ----- | | `--with-libdaemon` | | `--with-piddir=` | A [daemon](https://en.wikipedia.org/wiki/Daemon_(computing)) is a computer program that runs as a background process, rather than being under the direct control of an interactive user. Shairport Sync is designed to run as a daemon. FreeBSD and most recent Linux distributions can run an application as a daemon without special modifications. However, in certain older distributions and in special cases it may be necessary to enable Shairport Sync to daemonise itself. Use the `--with-libdaemon` configuration option: - `--with-libdaemon` Includes a demonising library needed if you want Shairport Sync to demonise itself with the `-d` option. Not needed for `systemd`-based systems which demonise programs differently. - `--with-piddir=` Specifies a pathname to a directory in which to write the PID file which is created when Shairport Sync daemonises itself and used to locate the deamon process to be killed with the `-k` command line option. ### Automatic Start | Flags | | ----- | | `--with-systemd` | | `--with-systemdsystemunitdir=` | | `--with-systemv` | | `--with-freebsd-service` | | `--with-sygwin-service` | Daemon programs such as Shairport Sync need to be started automatically, so that the service they provide becomes available without further intervention. Typically this is done using startup scripts. Four options are provided – two for Linux, one for FreeBSD and one for CYGWIN. In Linux, the choice depends on whether [systemd](https://en.wikipedia.org/wiki/Systemd) is used or not. If `systemd` is installed, then the `--with-systemd` option is suggested. If not, the `--with-systemv` option is suggested. - `--with-systemd` Includes a script to create a Shairport Sync service that can optionally launch automatically at startup on `systemd`-based Linuxes. Default is not to to install. Note: an associated special-purpose option allows you to specify where the `systemd` service file will be placed: - `--with-systemdsystemunitdir=` Specifies the directory for `systemd` service files. - `--with-systemv` Includes a script to create a Shairport Sync service that can optionally launch automatically at startup on System V based Linuxes. Default is not to to install. - `--with-freebsd-service` Includes a script to create a Shairport Sync service that can optionally launch automatically at startup on FreeBSD. Default is not to to install. - `--with-cygwin-service` Includes a script to create a Shairport Sync service that can optionally launch automatically at startup on CYGWIN. Default is not to to install. ### Cryptography | Flags | | ----- | | `--with-ssl=openssl` | | `--with-ssl=mbedtls` | | `--with-ssl=polarssl` | AirPlay 2 operation requires the OpenSSL libraries, so the option `--with-ssl=openssl` is mandatory. For classic Shairport Sync, the options are as follows: - `--with-ssl=openssl` Uses the [OpenSSL](https://www.openssl.org) cryptography toolkit. This is mandatory for AirPlay 2 operation. - `--with-ssl=mbedtls` Uses the [Mbed TLS](https://github.com/Mbed-TLS/mbedtls) cryptography library. Only suitable for classic AirPlay operation – do not include it in an AirPlay 2 configuration. - `--with-ssl=polarssl` Uses the PolarSSL cryptography library. This is deprecated – PolarSSL has been replaced by Mbed TLS. Only suitable for classic AirPlay operation – do not include it in an AirPlay 2 configuration. ### Zeroconf/Bonjour | Flags | | ----- | | `--with-avahi` | | `--with-tinysvcmdns` | | `--with-external-mdns` | | `--with-dns_sd` | AirPlay devices advertise their existence and status using [Zeroconf](http://www.zeroconf.org) (aka [Bonjour](https://en.wikipedia.org/wiki/Bonjour_(software))). AirPlay 2 operation requires the [Avahi](https://www.avahi.org) libraries, so the option `--with-avahi` is mandatory. For classic Shairport Sync, the options are as follows: The Zeroconf-related options are as follows: - `--with-avahi` Chooses [Avahi](https://www.avahi.org)-based Zeroconf support. This is mandatory for AirPlay 2 operation. - `--with-tinysvcmdns` Chooses [tinysvcmdns](https://github.com/philippe44/TinySVCmDNS)-based Zeroconf support (deprecated). - `--with-external-mdns` Supports the use of ['avahi-publish-service'](https://linux.die.net/man/1/avahi-publish-service) or 'mDNSPublish' to advertise the service on Bonjour/ZeroConf. - `--with-dns_sd` Chooses `dns-sd` Zeroconf support. ### Miscellaneous | Flag | Significance | | -------------------- | ---- | | `--with-os=` | Specifies the Operating System to target: One of `linux` (default), `freebsd`, `openbsd` or `darwin`. | | `--with-configfiles` | Installs configuration files (including a sample configuration file) during `make install`. | | `--with-pkg-config` | Specifies the use of `pkg-config` to find libraries. (Obselete for AirPlay 2. Special purpose use only.) | shairport-sync-4.3.7/COPYING000066400000000000000000000000721474716233300155560ustar00rootroot00000000000000Please refer to the individual source files for licenses. shairport-sync-4.3.7/CYGWIN.md000066400000000000000000000120551474716233300160510ustar00rootroot00000000000000Installing Shairport Sync into Cygwin [Airplay 2 Not Supported] ==== This guide is based on installing onto a fresh installation of Cygwin 2.895 (64-bit installation) running in Windows 10 inside VMWare Fusion on a Mac. The end result is a new Windows Service called `CYGWIN Shairport Sync`, providing an AirPlay service by which iOS devices or other AirPlay sources on the network can play audio through the Windows device. Windows Firewall ---- While getting everything working, it is suggested that you temporarily disable the Windows Firewall. Shairport Sync uses port 5000 for TCP and uses three ports for UDP, so you should leave a minimum of three, and preferably at least 10, open from 6001 upwards. The Bonjour Service, used in conjunction with the Avahi daemon, advertises Shairport Sync over a number of further ports. Once everything is working, the firewall can be re-enabled gradually. Setting up Windows ---- Set up Windows 10 and install all updates. Install the `Bonjour Service`, available from Apple in an installer called "Bonjour Print Services for Windows v2.0.2". * Download and run `Bonjour Print Services for Windows v2.0.2` * After accepting conditions and clicking the `Install` button, the installer will do a preliminary installation, installing just the Bonjour Service. It will then pause, inviting you to install Bonjour Print Services. You can decline this, as the Bonjour Service will have been installed during the first part of the installation. * Check Bonjour Service is running. In Windows, open the `Services` desktop application and ensure that you can see `Bonjour Service` running. Setting up Cygwin ---- * Download the Cygwin installer from the [official website](https://cygwin.com/install.html). Save the installer in the Downloads folder. * Open a Windows `Command Prompt` window and enter the following multi-line command, omitting the `C:\Users\mike>` prompt: ``` C:\Users\mike> Downloads\setup-x86_64.exe -P cygrunsrv,dbus,avahi,avahi-tools,gnome-keyring,libavahi-client-devel,^ libglib2.0-devel,openssl,pkg-config,autoconf,automake,clang,libdaemon-devel,popt-devel,^ make,libao-devel,openssl-devel,libtool,git,wget,flex,bison ``` This will do a complete installation of Cygwin and all necessary packages. * Set up the D-Bus and Avahi Services: Open a `Cygwin64 Terminal` window in Administrator mode. Enter the following command: ``` $ messagebus-config ``` Answer `yes` to all queries. Open the Windows `Services` desktop application (if it's already open, refresh the screen contents: `Actions > Refresh`) and look for the `CYGWIN D-Bus system service`. Open it and start it. Next, open (or return to) a `Cygwin64 Terminal` window in Administrator mode. Enter the following command: ``` $ /usr/sbin/avahi-daemon-config ``` Answer `yes` to all queries. Open the Windows `Services` desktop application (if it's already open, refresh the screen contents: `Actions > Refresh`) and look for the `CYGWIN Avahi service`. Open it and start it. The `libconfig` Library ---- Shairport Sync relies on a library – `libconfig` – that is not a Cygwin package, so it must be downloaded, compiled and installed: * Download, configure, compile and install `libconfig`: ``` $ git clone https://github.com/hyperrealm/libconfig.git $ cd libconfig $ autoreconf -fi $ ./configure $ make $ make install $ cd .. ``` Shairport Sync ---- * Download, configure and compile Shairport Sync: ``` $ git clone https://github.com/mikebrady/shairport-sync.git $ cd shairport-sync $ git checkout development // this is temporary $ autoreconf -fi $ PKG_CONFIG_PATH=/usr/local/lib/pkgconfig ./configure --with-ao --with-ssl=openssl \ --with-avahi --with-dbus-interface --with-libdaemon --sysconfdir=/etc --with-cygwin-service $ make $ make install ``` * The last step above installs the `shairport-sync` application into `/usr/local/bin` and also installs a configuration file, a service configuration script and two D-Bus policy files. Shairport Sync Service ---- * To install Shairport Sync as a Cygwin Service, open (or return to) a `Cygwin64 Terminal` window in Administrator mode. Enter the following command: ``` $ shairport-sync-config ``` Answer `yes` to all queries. Open the Windows `Services` desktop application (if it's already open, refresh the screen contents: `Actions > Refresh`) and look for the `CYGWIN Shairport Sync` service. Open it and start it. An AirPlay player on the local network should now be able to see an AirPlay output device bearing the computer's Device Name, e.g. `DESKTOP-0RHGN0`. You can set a different name by changing the settings in the Shairport Sync configuration file, installed at `/etc/shairport-sync.conf`. Since Shairport Sync is now a Cygwin Service, you do not need to open Cygwin to launch it – it should launch automatically when Windows is booted up. Known Issues ---- * Shairport Sync cannot access the D-Bus system bus to make its D-Bus interface available. The cause of this problem is unknown. (While the Avahi daemon can access the D-Bus system bus, Shairport Sync can not. The two applications use different D-Bus libraries, so perhaps the issue lies there.) shairport-sync-4.3.7/ChangeLog000066400000000000000000000000001474716233300162640ustar00rootroot00000000000000shairport-sync-4.3.7/FFTConvolver/000077500000000000000000000000001474716233300170415ustar00rootroot00000000000000shairport-sync-4.3.7/FFTConvolver/AudioFFT.cpp000077500000000000000000000654761474716233300211730ustar00rootroot00000000000000// ================================================================================== // Copyright (c) 2016 HiFi-LoFi // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is furnished // to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS // FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR // COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. // ================================================================================== #include "AudioFFT.h" #include #include #include #if defined(AUDIOFFT_APPLE_ACCELERATE) #define AUDIOFFT_APPLE_ACCELERATE_USED #include #include #elif defined (AUDIOFFT_FFTW3) #define AUDIOFFT_FFTW3_USED #include #else #if !defined(AUDIOFFT_OOURA) #define AUDIOFFT_OOURA #endif #define AUDIOFFT_OOURA_USED #include #endif namespace audiofft { namespace details { static bool IsPowerOf2(size_t val) { return (val == 1 || (val & (val-1)) == 0); } template void ConvertBuffer(TypeDest* dest, const TypeSrc* src, size_t len) { for (size_t i=0; i(src[i]); } } template void ScaleBuffer(TypeDest* dest, const TypeSrc* src, const TypeFactor factor, size_t len) { for (size_t i=0; i(static_cast(src[i]) * factor); } } // ================================================================ #ifdef AUDIOFFT_OOURA_USED /** * @internal * @class OouraFFT * @brief FFT implementation based on the great radix-4 routines by Takuya Ooura */ class OouraFFT : public AudioFFTImpl { public: OouraFFT() : AudioFFTImpl(), _size(0), _ip(), _w(), _buffer() { } virtual void init(size_t size) override { if (_size != size) { _ip.resize(2 + static_cast(std::sqrt(static_cast(size)))); _w.resize(size / 2); _buffer.resize(size); _size = size; const int size4 = static_cast(_size) / 4; makewt(size4, _ip.data(), _w.data()); makect(size4, _ip.data(), _w.data() + size4); } } virtual void fft(const float* data, float* re, float* im) override { // Convert into the format as required by the Ooura FFT ConvertBuffer(&_buffer[0], data, _size); rdft(static_cast(_size), +1, _buffer.data(), _ip.data(), _w.data()); // Convert back to split-complex { double* b = &_buffer[0]; double* bEnd = b + _size; float *r = re; float *i = im; while (b != bEnd) { *(r++) = static_cast(*(b++)); *(i++) = static_cast(-(*(b++))); } } const size_t size2 = _size / 2; re[size2] = -im[0]; im[0] = 0.0; im[size2] = 0.0; } virtual void ifft(float* data, const float* re, const float* im) override { // Convert into the format as required by the Ooura FFT { double* b = &_buffer[0]; double* bEnd = b + _size; const float *r = re; const float *i = im; while (b != bEnd) { *(b++) = static_cast(*(r++)); *(b++) = -static_cast(*(i++)); } _buffer[1] = re[_size / 2]; } rdft(static_cast(_size), -1, _buffer.data(), _ip.data(), _w.data()); // Convert back to split-complex ScaleBuffer(data, &_buffer[0], 2.0 / static_cast(_size), _size); } private: size_t _size; std::vector _ip; std::vector _w; std::vector _buffer; void rdft(int n, int isgn, double *a, int *ip, double *w) { int nw = ip[0]; int nc = ip[1]; if (isgn >= 0) { if (n > 4) { bitrv2(n, ip + 2, a); cftfsub(n, a, w); rftfsub(n, a, nc, w + nw); } else if (n == 4) { cftfsub(n, a, w); } double xi = a[0] - a[1]; a[0] += a[1]; a[1] = xi; } else { a[1] = 0.5 * (a[0] - a[1]); a[0] -= a[1]; if (n > 4) { rftbsub(n, a, nc, w + nw); bitrv2(n, ip + 2, a); cftbsub(n, a, w); } else if (n == 4) { cftfsub(n, a, w); } } } /* -------- initializing routines -------- */ void makewt(int nw, int *ip, double *w) { int j, nwh; double delta, x, y; ip[0] = nw; ip[1] = 1; if (nw > 2) { nwh = nw >> 1; delta = atan(1.0) / nwh; w[0] = 1; w[1] = 0; w[nwh] = cos(delta * nwh); w[nwh + 1] = w[nwh]; if (nwh > 2) { for (j = 2; j < nwh; j += 2) { x = cos(delta * j); y = sin(delta * j); w[j] = x; w[j + 1] = y; w[nw - j] = y; w[nw - j + 1] = x; } bitrv2(nw, ip + 2, w); } } } void makect(int nc, int *ip, double *c) { int j, nch; double delta; ip[1] = nc; if (nc > 1) { nch = nc >> 1; delta = atan(1.0) / nch; c[0] = cos(delta * nch); c[nch] = 0.5 * c[0]; for (j = 1; j < nch; j++) { c[j] = 0.5 * cos(delta * j); c[nc - j] = 0.5 * sin(delta * j); } } } /* -------- child routines -------- */ void bitrv2(int n, int *ip, double *a) { int j, j1, k, k1, l, m, m2; double xr, xi, yr, yi; ip[0] = 0; l = n; m = 1; while ((m << 3) < l) { l >>= 1; for (j = 0; j < m; j++) { ip[m + j] = ip[j] + l; } m <<= 1; } m2 = 2 * m; if ((m << 3) == l) { for (k = 0; k < m; k++) { for (j = 0; j < k; j++) { j1 = 2 * j + ip[k]; k1 = 2 * k + ip[j]; xr = a[j1]; xi = a[j1 + 1]; yr = a[k1]; yi = a[k1 + 1]; a[j1] = yr; a[j1 + 1] = yi; a[k1] = xr; a[k1 + 1] = xi; j1 += m2; k1 += 2 * m2; xr = a[j1]; xi = a[j1 + 1]; yr = a[k1]; yi = a[k1 + 1]; a[j1] = yr; a[j1 + 1] = yi; a[k1] = xr; a[k1 + 1] = xi; j1 += m2; k1 -= m2; xr = a[j1]; xi = a[j1 + 1]; yr = a[k1]; yi = a[k1 + 1]; a[j1] = yr; a[j1 + 1] = yi; a[k1] = xr; a[k1 + 1] = xi; j1 += m2; k1 += 2 * m2; xr = a[j1]; xi = a[j1 + 1]; yr = a[k1]; yi = a[k1 + 1]; a[j1] = yr; a[j1 + 1] = yi; a[k1] = xr; a[k1 + 1] = xi; } j1 = 2 * k + m2 + ip[k]; k1 = j1 + m2; xr = a[j1]; xi = a[j1 + 1]; yr = a[k1]; yi = a[k1 + 1]; a[j1] = yr; a[j1 + 1] = yi; a[k1] = xr; a[k1 + 1] = xi; } } else { for (k = 1; k < m; k++) { for (j = 0; j < k; j++) { j1 = 2 * j + ip[k]; k1 = 2 * k + ip[j]; xr = a[j1]; xi = a[j1 + 1]; yr = a[k1]; yi = a[k1 + 1]; a[j1] = yr; a[j1 + 1] = yi; a[k1] = xr; a[k1 + 1] = xi; j1 += m2; k1 += m2; xr = a[j1]; xi = a[j1 + 1]; yr = a[k1]; yi = a[k1 + 1]; a[j1] = yr; a[j1 + 1] = yi; a[k1] = xr; a[k1 + 1] = xi; } } } } void cftfsub(int n, double *a, double *w) { int j, j1, j2, j3, l; double x0r, x0i, x1r, x1i, x2r, x2i, x3r, x3i; l = 2; if (n > 8) { cft1st(n, a, w); l = 8; while ((l << 2) < n) { cftmdl(n, l, a, w); l <<= 2; } } if ((l << 2) == n) { for (j = 0; j < l; j += 2) { j1 = j + l; j2 = j1 + l; j3 = j2 + l; x0r = a[j] + a[j1]; x0i = a[j + 1] + a[j1 + 1]; x1r = a[j] - a[j1]; x1i = a[j + 1] - a[j1 + 1]; x2r = a[j2] + a[j3]; x2i = a[j2 + 1] + a[j3 + 1]; x3r = a[j2] - a[j3]; x3i = a[j2 + 1] - a[j3 + 1]; a[j] = x0r + x2r; a[j + 1] = x0i + x2i; a[j2] = x0r - x2r; a[j2 + 1] = x0i - x2i; a[j1] = x1r - x3i; a[j1 + 1] = x1i + x3r; a[j3] = x1r + x3i; a[j3 + 1] = x1i - x3r; } } else { for (j = 0; j < l; j += 2) { j1 = j + l; x0r = a[j] - a[j1]; x0i = a[j + 1] - a[j1 + 1]; a[j] += a[j1]; a[j + 1] += a[j1 + 1]; a[j1] = x0r; a[j1 + 1] = x0i; } } } void cftbsub(int n, double *a, double *w) { int j, j1, j2, j3, l; double x0r, x0i, x1r, x1i, x2r, x2i, x3r, x3i; l = 2; if (n > 8) { cft1st(n, a, w); l = 8; while ((l << 2) < n) { cftmdl(n, l, a, w); l <<= 2; } } if ((l << 2) == n) { for (j = 0; j < l; j += 2) { j1 = j + l; j2 = j1 + l; j3 = j2 + l; x0r = a[j] + a[j1]; x0i = -a[j + 1] - a[j1 + 1]; x1r = a[j] - a[j1]; x1i = -a[j + 1] + a[j1 + 1]; x2r = a[j2] + a[j3]; x2i = a[j2 + 1] + a[j3 + 1]; x3r = a[j2] - a[j3]; x3i = a[j2 + 1] - a[j3 + 1]; a[j] = x0r + x2r; a[j + 1] = x0i - x2i; a[j2] = x0r - x2r; a[j2 + 1] = x0i + x2i; a[j1] = x1r - x3i; a[j1 + 1] = x1i - x3r; a[j3] = x1r + x3i; a[j3 + 1] = x1i + x3r; } } else { for (j = 0; j < l; j += 2) { j1 = j + l; x0r = a[j] - a[j1]; x0i = -a[j + 1] + a[j1 + 1]; a[j] += a[j1]; a[j + 1] = -a[j + 1] - a[j1 + 1]; a[j1] = x0r; a[j1 + 1] = x0i; } } } void cft1st(int n, double *a, double *w) { int j, k1, k2; double wk1r, wk1i, wk2r, wk2i, wk3r, wk3i; double x0r, x0i, x1r, x1i, x2r, x2i, x3r, x3i; x0r = a[0] + a[2]; x0i = a[1] + a[3]; x1r = a[0] - a[2]; x1i = a[1] - a[3]; x2r = a[4] + a[6]; x2i = a[5] + a[7]; x3r = a[4] - a[6]; x3i = a[5] - a[7]; a[0] = x0r + x2r; a[1] = x0i + x2i; a[4] = x0r - x2r; a[5] = x0i - x2i; a[2] = x1r - x3i; a[3] = x1i + x3r; a[6] = x1r + x3i; a[7] = x1i - x3r; wk1r = w[2]; x0r = a[8] + a[10]; x0i = a[9] + a[11]; x1r = a[8] - a[10]; x1i = a[9] - a[11]; x2r = a[12] + a[14]; x2i = a[13] + a[15]; x3r = a[12] - a[14]; x3i = a[13] - a[15]; a[8] = x0r + x2r; a[9] = x0i + x2i; a[12] = x2i - x0i; a[13] = x0r - x2r; x0r = x1r - x3i; x0i = x1i + x3r; a[10] = wk1r * (x0r - x0i); a[11] = wk1r * (x0r + x0i); x0r = x3i + x1r; x0i = x3r - x1i; a[14] = wk1r * (x0i - x0r); a[15] = wk1r * (x0i + x0r); k1 = 0; for (j = 16; j < n; j += 16) { k1 += 2; k2 = 2 * k1; wk2r = w[k1]; wk2i = w[k1 + 1]; wk1r = w[k2]; wk1i = w[k2 + 1]; wk3r = wk1r - 2 * wk2i * wk1i; wk3i = 2 * wk2i * wk1r - wk1i; x0r = a[j] + a[j + 2]; x0i = a[j + 1] + a[j + 3]; x1r = a[j] - a[j + 2]; x1i = a[j + 1] - a[j + 3]; x2r = a[j + 4] + a[j + 6]; x2i = a[j + 5] + a[j + 7]; x3r = a[j + 4] - a[j + 6]; x3i = a[j + 5] - a[j + 7]; a[j] = x0r + x2r; a[j + 1] = x0i + x2i; x0r -= x2r; x0i -= x2i; a[j + 4] = wk2r * x0r - wk2i * x0i; a[j + 5] = wk2r * x0i + wk2i * x0r; x0r = x1r - x3i; x0i = x1i + x3r; a[j + 2] = wk1r * x0r - wk1i * x0i; a[j + 3] = wk1r * x0i + wk1i * x0r; x0r = x1r + x3i; x0i = x1i - x3r; a[j + 6] = wk3r * x0r - wk3i * x0i; a[j + 7] = wk3r * x0i + wk3i * x0r; wk1r = w[k2 + 2]; wk1i = w[k2 + 3]; wk3r = wk1r - 2 * wk2r * wk1i; wk3i = 2 * wk2r * wk1r - wk1i; x0r = a[j + 8] + a[j + 10]; x0i = a[j + 9] + a[j + 11]; x1r = a[j + 8] - a[j + 10]; x1i = a[j + 9] - a[j + 11]; x2r = a[j + 12] + a[j + 14]; x2i = a[j + 13] + a[j + 15]; x3r = a[j + 12] - a[j + 14]; x3i = a[j + 13] - a[j + 15]; a[j + 8] = x0r + x2r; a[j + 9] = x0i + x2i; x0r -= x2r; x0i -= x2i; a[j + 12] = -wk2i * x0r - wk2r * x0i; a[j + 13] = -wk2i * x0i + wk2r * x0r; x0r = x1r - x3i; x0i = x1i + x3r; a[j + 10] = wk1r * x0r - wk1i * x0i; a[j + 11] = wk1r * x0i + wk1i * x0r; x0r = x1r + x3i; x0i = x1i - x3r; a[j + 14] = wk3r * x0r - wk3i * x0i; a[j + 15] = wk3r * x0i + wk3i * x0r; } } void cftmdl(int n, int l, double *a, double *w) { int j, j1, j2, j3, k, k1, k2, m, m2; double wk1r, wk1i, wk2r, wk2i, wk3r, wk3i; double x0r, x0i, x1r, x1i, x2r, x2i, x3r, x3i; m = l << 2; for (j = 0; j < l; j += 2) { j1 = j + l; j2 = j1 + l; j3 = j2 + l; x0r = a[j] + a[j1]; x0i = a[j + 1] + a[j1 + 1]; x1r = a[j] - a[j1]; x1i = a[j + 1] - a[j1 + 1]; x2r = a[j2] + a[j3]; x2i = a[j2 + 1] + a[j3 + 1]; x3r = a[j2] - a[j3]; x3i = a[j2 + 1] - a[j3 + 1]; a[j] = x0r + x2r; a[j + 1] = x0i + x2i; a[j2] = x0r - x2r; a[j2 + 1] = x0i - x2i; a[j1] = x1r - x3i; a[j1 + 1] = x1i + x3r; a[j3] = x1r + x3i; a[j3 + 1] = x1i - x3r; } wk1r = w[2]; for (j = m; j < l + m; j += 2) { j1 = j + l; j2 = j1 + l; j3 = j2 + l; x0r = a[j] + a[j1]; x0i = a[j + 1] + a[j1 + 1]; x1r = a[j] - a[j1]; x1i = a[j + 1] - a[j1 + 1]; x2r = a[j2] + a[j3]; x2i = a[j2 + 1] + a[j3 + 1]; x3r = a[j2] - a[j3]; x3i = a[j2 + 1] - a[j3 + 1]; a[j] = x0r + x2r; a[j + 1] = x0i + x2i; a[j2] = x2i - x0i; a[j2 + 1] = x0r - x2r; x0r = x1r - x3i; x0i = x1i + x3r; a[j1] = wk1r * (x0r - x0i); a[j1 + 1] = wk1r * (x0r + x0i); x0r = x3i + x1r; x0i = x3r - x1i; a[j3] = wk1r * (x0i - x0r); a[j3 + 1] = wk1r * (x0i + x0r); } k1 = 0; m2 = 2 * m; for (k = m2; k < n; k += m2) { k1 += 2; k2 = 2 * k1; wk2r = w[k1]; wk2i = w[k1 + 1]; wk1r = w[k2]; wk1i = w[k2 + 1]; wk3r = wk1r - 2 * wk2i * wk1i; wk3i = 2 * wk2i * wk1r - wk1i; for (j = k; j < l + k; j += 2) { j1 = j + l; j2 = j1 + l; j3 = j2 + l; x0r = a[j] + a[j1]; x0i = a[j + 1] + a[j1 + 1]; x1r = a[j] - a[j1]; x1i = a[j + 1] - a[j1 + 1]; x2r = a[j2] + a[j3]; x2i = a[j2 + 1] + a[j3 + 1]; x3r = a[j2] - a[j3]; x3i = a[j2 + 1] - a[j3 + 1]; a[j] = x0r + x2r; a[j + 1] = x0i + x2i; x0r -= x2r; x0i -= x2i; a[j2] = wk2r * x0r - wk2i * x0i; a[j2 + 1] = wk2r * x0i + wk2i * x0r; x0r = x1r - x3i; x0i = x1i + x3r; a[j1] = wk1r * x0r - wk1i * x0i; a[j1 + 1] = wk1r * x0i + wk1i * x0r; x0r = x1r + x3i; x0i = x1i - x3r; a[j3] = wk3r * x0r - wk3i * x0i; a[j3 + 1] = wk3r * x0i + wk3i * x0r; } wk1r = w[k2 + 2]; wk1i = w[k2 + 3]; wk3r = wk1r - 2 * wk2r * wk1i; wk3i = 2 * wk2r * wk1r - wk1i; for (j = k + m; j < l + (k + m); j += 2) { j1 = j + l; j2 = j1 + l; j3 = j2 + l; x0r = a[j] + a[j1]; x0i = a[j + 1] + a[j1 + 1]; x1r = a[j] - a[j1]; x1i = a[j + 1] - a[j1 + 1]; x2r = a[j2] + a[j3]; x2i = a[j2 + 1] + a[j3 + 1]; x3r = a[j2] - a[j3]; x3i = a[j2 + 1] - a[j3 + 1]; a[j] = x0r + x2r; a[j + 1] = x0i + x2i; x0r -= x2r; x0i -= x2i; a[j2] = -wk2i * x0r - wk2r * x0i; a[j2 + 1] = -wk2i * x0i + wk2r * x0r; x0r = x1r - x3i; x0i = x1i + x3r; a[j1] = wk1r * x0r - wk1i * x0i; a[j1 + 1] = wk1r * x0i + wk1i * x0r; x0r = x1r + x3i; x0i = x1i - x3r; a[j3] = wk3r * x0r - wk3i * x0i; a[j3 + 1] = wk3r * x0i + wk3i * x0r; } } } void rftfsub(int n, double *a, int nc, double *c) { int j, k, kk, ks, m; double wkr, wki, xr, xi, yr, yi; m = n >> 1; ks = 2 * nc / m; kk = 0; for (j = 2; j < m; j += 2) { k = n - j; kk += ks; wkr = 0.5 - c[nc - kk]; wki = c[kk]; xr = a[j] - a[k]; xi = a[j + 1] + a[k + 1]; yr = wkr * xr - wki * xi; yi = wkr * xi + wki * xr; a[j] -= yr; a[j + 1] -= yi; a[k] += yr; a[k + 1] -= yi; } } void rftbsub(int n, double *a, int nc, double *c) { int j, k, kk, ks, m; double wkr, wki, xr, xi, yr, yi; a[1] = -a[1]; m = n >> 1; ks = 2 * nc / m; kk = 0; for (j = 2; j < m; j += 2) { k = n - j; kk += ks; wkr = 0.5 - c[nc - kk]; wki = c[kk]; xr = a[j] - a[k]; xi = a[j + 1] + a[k + 1]; yr = wkr * xr + wki * xi; yi = wkr * xi - wki * xr; a[j] -= yr; a[j + 1] = yi - a[j + 1]; a[k] += yr; a[k + 1] = yi - a[k + 1]; } a[m + 1] = -a[m + 1]; } OouraFFT(const OouraFFT&) = delete; OouraFFT& operator=(const OouraFFT&) = delete; }; std::unique_ptr MakeAudioFFTImpl() { return std::unique_ptr(new OouraFFT()); } #endif // AUDIOFFT_OOURA_USED // ================================================================ #ifdef AUDIOFFT_APPLE_ACCELERATE_USED /** * @internal * @class AppleAccelerateFFT * @brief FFT implementation using the Apple Accelerate framework internally */ class AppleAccelerateFFT : public AudioFFTImpl { public: AppleAccelerateFFT() : AudioFFTImpl(), _size(0), _powerOf2(0), _fftSetup(0), _re(), _im() { } virtual ~AppleAccelerateFFT() { init(0); } virtual void init(size_t size) override { if (_fftSetup) { vDSP_destroy_fftsetup(_fftSetup); _size = 0; _powerOf2 = 0; _fftSetup = 0; _re.clear(); _im.clear(); } if (size > 0) { _size = size; _powerOf2 = 0; while ((1 << _powerOf2) < _size) { ++_powerOf2; } _fftSetup = vDSP_create_fftsetup(_powerOf2, FFT_RADIX2); _re.resize(_size / 2); _im.resize(_size / 2); } } virtual void fft(const float* data, float* re, float* im) override { const size_t size2 = _size / 2; DSPSplitComplex splitComplex; splitComplex.realp = re; splitComplex.imagp = im; vDSP_ctoz(reinterpret_cast(data), 2, &splitComplex, 1, size2); vDSP_fft_zrip(_fftSetup, &splitComplex, 1, _powerOf2, FFT_FORWARD); const float factor = 0.5f; vDSP_vsmul(re, 1, &factor, re, 1, size2); vDSP_vsmul(im, 1, &factor, im, 1, size2); re[size2] = im[0]; im[0] = 0.0f; im[size2] = 0.0f; } virtual void ifft(float* data, const float* re, const float* im) override { const size_t size2 = _size / 2; ::memcpy(_re.data(), re, size2 * sizeof(float)); ::memcpy(_im.data(), im, size2 * sizeof(float)); _im[0] = re[size2]; DSPSplitComplex splitComplex; splitComplex.realp = _re.data(); splitComplex.imagp = _im.data(); vDSP_fft_zrip(_fftSetup, &splitComplex, 1, _powerOf2, FFT_INVERSE); vDSP_ztoc(&splitComplex, 1, reinterpret_cast(data), 2, size2); const float factor = 1.0f / static_cast(_size); vDSP_vsmul(data, 1, &factor, data, 1, _size); } private: size_t _size; size_t _powerOf2; FFTSetup _fftSetup; std::vector _re; std::vector _im; AppleAccelerateFFT(const AppleAccelerateFFT&) = delete; AppleAccelerateFFT& operator=(const AppleAccelerateFFT&) = delete; }; std::unique_ptr MakeAudioFFTImpl() { return std::unique_ptr(new AppleAccelerateFFT()); } #endif // AUDIOFFT_APPLE_ACCELERATE_USED // ================================================================ #ifdef AUDIOFFT_FFTW3_USED /** * @internal * @class FFTW3FFT * @brief FFT implementation using FFTW3 internally (see fftw.org) */ class FFTW3FFT : public AudioFFTImpl { public: FFTW3FFT() : AudioFFTImpl(), _size(0), _complexSize(0), _planForward(0), _planBackward(0), _data(0), _re(0), _im(0) { } virtual ~FFTW3FFT() { init(0); } virtual void init(size_t size) override { if (_size != size) { if (_size > 0) { fftwf_destroy_plan(_planForward); fftwf_destroy_plan(_planBackward); _planForward = 0; _planBackward = 0; _size = 0; _complexSize = 0; if (_data) { fftwf_free(_data); _data = 0; } if (_re) { fftwf_free(_re); _re = 0; } if (_im) { fftwf_free(_im); _im = 0; } } if (size > 0) { _size = size; _complexSize = AudioFFT::ComplexSize(_size); const size_t complexSize = AudioFFT::ComplexSize(_size); _data = reinterpret_cast(fftwf_malloc(_size * sizeof(float))); _re = reinterpret_cast(fftwf_malloc(complexSize * sizeof(float))); _im = reinterpret_cast(fftwf_malloc(complexSize * sizeof(float))); fftw_iodim dim; dim.n = static_cast(size); dim.is = 1; dim.os = 1; _planForward = fftwf_plan_guru_split_dft_r2c(1, &dim, 0, 0, _data, _re, _im, FFTW_MEASURE); _planBackward = fftwf_plan_guru_split_dft_c2r(1, &dim, 0, 0, _re, _im, _data, FFTW_MEASURE); } } } virtual void fft(const float* data, float* re, float* im) override { ::memcpy(_data, data, _size * sizeof(float)); fftwf_execute_split_dft_r2c(_planForward, _data, _re, _im); ::memcpy(re, _re, _complexSize * sizeof(float)); ::memcpy(im, _im, _complexSize * sizeof(float)); } void ifft(float* data, const float* re, const float* im) { ::memcpy(_re, re, _complexSize * sizeof(float)); ::memcpy(_im, im, _complexSize * sizeof(float)); fftwf_execute_split_dft_c2r(_planBackward, _re, _im, _data); ScaleBuffer(data, _data, 1.0f / static_cast(_size), _size); } private: size_t _size; size_t _complexSize; fftwf_plan _planForward; fftwf_plan _planBackward; float* _data; float* _re; float* _im; FFTW3FFT(const FFTW3FFT&) = delete; FFTW3FFT& operator=(const FFTW3FFT&) = delete; }; std::unique_ptr MakeAudioFFTImpl() { return std::unique_ptr(new FFTW3FFT()); } #endif // AUDIOFFT_FFTW3_USED } // End of namespace details // ============================================================= AudioFFT::AudioFFT() : _impl(details::MakeAudioFFTImpl()) { } void AudioFFT::init(size_t size) { assert(details::IsPowerOf2(size)); _impl->init(size); } void AudioFFT::fft(const float* data, float* re, float* im) { _impl->fft(data, re, im); } void AudioFFT::ifft(float* data, const float* re, const float* im) { _impl->ifft(data, re, im); } size_t AudioFFT::ComplexSize(size_t size) { return (size / 2) + 1; } } // End of namespace shairport-sync-4.3.7/FFTConvolver/AudioFFT.h000077500000000000000000000131261474716233300206210ustar00rootroot00000000000000// ================================================================================== // Copyright (c) 2016 HiFi-LoFi // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is furnished // to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS // FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR // COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. // ================================================================================== #ifndef _AUDIOFFT_H #define _AUDIOFFT_H /** * AudioFFT provides real-to-complex/complex-to-real FFT routines. * * Features: * * - Real-complex FFT and complex-real inverse FFT for power-of-2-sized real data. * * - Uniform interface to different FFT implementations (currently Ooura, FFTW3 and Apple Accelerate). * * - Complex data is handled in "split-complex" format, i.e. there are separate * arrays for the real and imaginary parts which can be useful for SIMD optimizations * (split-complex arrays have to be of length (size/2+1) representing bins from DC * to Nyquist frequency). * * - Output is "ready to use" (all scaling etc. is already handled internally). * * - No allocations/deallocations after the initialization which makes it usable * for real-time audio applications (that's what I wrote it for and using it). * * * How to use it in your project: * * - Add the .h and .cpp file to your project - that's all. * * - To get extra speed, you can link FFTW3 to your project and define * AUDIOFFT_FFTW3 (however, please check whether your project suits the * according license). * * - To get the best speed on Apple platforms, you can link the Apple * Accelerate framework to your project and define * AUDIOFFT_APPLE_ACCELERATE (however, please check whether your * project suits the according license). * * * Remarks: * * - AudioFFT is not intended to be the fastest FFT, but to be a fast-enough * FFT suitable for most audio applications. * * - AudioFFT uses the quite liberal MIT license. * * * Example usage: * @code * #include "AudioFFT.h" * * void Example() * { * const size_t fftSize = 1024; // Needs to be power of 2! * * std::vector input(fftSize, 0.0f); * std::vector re(audiofft::AudioFFT::ComplexSize(fftSize)); * std::vector im(audiofft::AudioFFT::ComplexSize(fftSize)); * std::vector output(fftSize); * * audiofft::AudioFFT fft; * fft.init(1024); * fft.fft(input.data(), re.data(), im.data()); * fft.ifft(output.data(), re.data(), im.data()); * } * @endcode */ #include #include namespace audiofft { namespace details { class AudioFFTImpl { public: AudioFFTImpl() = default; virtual ~AudioFFTImpl() = default; virtual void init(size_t size) = 0; virtual void fft(const float* data, float* re, float* im) = 0; virtual void ifft(float* data, const float* re, const float* im) = 0; private: AudioFFTImpl(const AudioFFTImpl&) = delete; AudioFFTImpl& operator=(const AudioFFTImpl&) = delete; }; } // ====================================================== /** * @class AudioFFT * @brief Performs 1D FFTs */ class AudioFFT { public: /** * @brief Constructor */ AudioFFT(); /** * @brief Initializes the FFT object * @param size Size of the real input (must be power 2) */ void init(size_t size); /** * @brief Performs the forward FFT * @param data The real input data (has to be of the length as specified in init()) * @param re The real part of the complex output (has to be of length as returned by ComplexSize()) * @param im The imaginary part of the complex output (has to be of length as returned by ComplexSize()) */ void fft(const float* data, float* re, float* im); /** * @brief Performs the inverse FFT * @param data The real output data (has to be of the length as specified in init()) * @param re The real part of the complex input (has to be of length as returned by ComplexSize()) * @param im The imaginary part of the complex input (has to be of length as returned by ComplexSize()) */ void ifft(float* data, const float* re, const float* im); /** * @brief Calculates the necessary size of the real/imaginary complex arrays * @param size The size of the real data * @return The size of the real/imaginary complex arrays */ static size_t ComplexSize(size_t size); private: std::unique_ptr _impl; AudioFFT(const AudioFFT&) = delete; AudioFFT& operator=(const AudioFFT&) = delete; }; /** * @deprecated * @brief Let's keep an AudioFFTBase type around for now because it has been here already in the 1st version in order to avoid breaking existing code. */ typedef AudioFFT AudioFFTBase; } // End of namespace #endif // Header guard shairport-sync-4.3.7/FFTConvolver/FFTConvolver.cpp000077500000000000000000000120061474716233300220640ustar00rootroot00000000000000// ================================================================================== // Copyright (c) 2012 HiFi-LoFi // // This is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program. If not, see . // ================================================================================== #include "FFTConvolver.h" #include #include #if defined (FFTCONVOLVER_USE_SSE) #include #endif namespace fftconvolver { FFTConvolver::FFTConvolver() : _blockSize(0), _segSize(0), _segCount(0), _fftComplexSize(0), _segments(), _segmentsIR(), _fftBuffer(), _fft(), _preMultiplied(), _conv(), _overlap(), _current(0), _inputBuffer(), _inputBufferFill(0) { } FFTConvolver::~FFTConvolver() { reset(); } void FFTConvolver::reset() { for (size_t i=0; i<_segCount; ++i) { delete _segments[i]; delete _segmentsIR[i]; } _blockSize = 0; _segSize = 0; _segCount = 0; _fftComplexSize = 0; _segments.clear(); _segmentsIR.clear(); _fftBuffer.clear(); _fft.init(0); _preMultiplied.clear(); _conv.clear(); _overlap.clear(); _current = 0; _inputBuffer.clear(); _inputBufferFill = 0; } bool FFTConvolver::init(size_t blockSize, const Sample* ir, size_t irLen) { reset(); if (blockSize == 0) { return false; } // Ignore zeros at the end of the impulse response because they only waste computation time while (irLen > 0 && ::fabs(ir[irLen-1]) < 0.000001f) { --irLen; } if (irLen == 0) { return true; } _blockSize = NextPowerOf2(blockSize); _segSize = 2 * _blockSize; _segCount = static_cast(::ceil(static_cast(irLen) / static_cast(_blockSize))); _fftComplexSize = audiofft::AudioFFT::ComplexSize(_segSize); // FFT _fft.init(_segSize); _fftBuffer.resize(_segSize); // Prepare segments for (size_t i=0; i<_segCount; ++i) { _segments.push_back(new SplitComplex(_fftComplexSize)); } // Prepare IR for (size_t i=0; i<_segCount; ++i) { SplitComplex* segment = new SplitComplex(_fftComplexSize); const size_t remaining = irLen - (i * _blockSize); const size_t sizeCopy = (remaining >= _blockSize) ? _blockSize : remaining; CopyAndPad(_fftBuffer, &ir[i*_blockSize], sizeCopy); _fft.fft(_fftBuffer.data(), segment->re(), segment->im()); _segmentsIR.push_back(segment); } // Prepare convolution buffers _preMultiplied.resize(_fftComplexSize); _conv.resize(_fftComplexSize); _overlap.resize(_blockSize); // Prepare input buffer _inputBuffer.resize(_blockSize); _inputBufferFill = 0; // Reset current position _current = 0; return true; } void FFTConvolver::process(const Sample* input, Sample* output, size_t len) { if (_segCount == 0) { ::memset(output, 0, len * sizeof(Sample)); return; } size_t processed = 0; while (processed < len) { const bool inputBufferWasEmpty = (_inputBufferFill == 0); const size_t processing = std::min(len-processed, _blockSize-_inputBufferFill); const size_t inputBufferPos = _inputBufferFill; ::memcpy(_inputBuffer.data()+inputBufferPos, input+processed, processing * sizeof(Sample)); // Forward FFT CopyAndPad(_fftBuffer, &_inputBuffer[0], _blockSize); _fft.fft(_fftBuffer.data(), _segments[_current]->re(), _segments[_current]->im()); // Complex multiplication if (inputBufferWasEmpty) { _preMultiplied.setZero(); for (size_t i=1; i<_segCount; ++i) { const size_t indexIr = i; const size_t indexAudio = (_current + i) % _segCount; ComplexMultiplyAccumulate(_preMultiplied, *_segmentsIR[indexIr], *_segments[indexAudio]); } } _conv.copyFrom(_preMultiplied); ComplexMultiplyAccumulate(_conv, *_segments[_current], *_segmentsIR[0]); // Backward FFT _fft.ifft(_fftBuffer.data(), _conv.re(), _conv.im()); // Add overlap Sum(output+processed, _fftBuffer.data()+inputBufferPos, _overlap.data()+inputBufferPos, processing); // Input buffer full => Next block _inputBufferFill += processing; if (_inputBufferFill == _blockSize) { // Input buffer is empty again now _inputBuffer.setZero(); _inputBufferFill = 0; // Save the overlap ::memcpy(_overlap.data(), _fftBuffer.data()+_blockSize, _blockSize * sizeof(Sample)); // Update current segment _current = (_current > 0) ? (_current - 1) : (_segCount - 1); } processed += processing; } } } // End of namespace fftconvolver shairport-sync-4.3.7/FFTConvolver/FFTConvolver.h000077500000000000000000000061321474716233300215340ustar00rootroot00000000000000// ================================================================================== // Copyright (c) 2012 HiFi-LoFi // // This is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program. If not, see . // ================================================================================== #ifndef _FFTCONVOLVER_FFTCONVOLVER_H #define _FFTCONVOLVER_FFTCONVOLVER_H #include "AudioFFT.h" #include "Utilities.h" #include namespace fftconvolver { /** * @class FFTConvolver * @brief Implementation of a partitioned FFT convolution algorithm with uniform block size * * Some notes on how to use it: * * - After initialization with an impulse response, subsequent data portions of * arbitrary length can be convolved. The convolver internally can handle * this by using appropriate buffering. * * - The convolver works without "latency" (except for the required * processing time, of course), i.e. the output always is the convolved * input for each processing call. * * - The convolver is suitable for real-time processing which means that no * "unpredictable" operations like allocations, locking, API calls, etc. are * performed during processing (all necessary allocations and preparations take * place during initialization). */ class FFTConvolver { public: FFTConvolver(); virtual ~FFTConvolver(); /** * @brief Initializes the convolver * @param blockSize Block size internally used by the convolver (partition size) * @param ir The impulse response * @param irLen Length of the impulse response * @return true: Success - false: Failed */ bool init(size_t blockSize, const Sample* ir, size_t irLen); /** * @brief Convolves the the given input samples and immediately outputs the result * @param input The input samples * @param output The convolution result * @param len Number of input/output samples */ void process(const Sample* input, Sample* output, size_t len); /** * @brief Resets the convolver and discards the set impulse response */ void reset(); private: size_t _blockSize; size_t _segSize; size_t _segCount; size_t _fftComplexSize; std::vector _segments; std::vector _segmentsIR; SampleBuffer _fftBuffer; audiofft::AudioFFT _fft; SplitComplex _preMultiplied; SplitComplex _conv; SampleBuffer _overlap; size_t _current; SampleBuffer _inputBuffer; size_t _inputBufferFill; // Prevent uncontrolled usage FFTConvolver(const FFTConvolver&); FFTConvolver& operator=(const FFTConvolver&); }; } // End of namespace fftconvolver #endif // Header guard shairport-sync-4.3.7/FFTConvolver/Utilities.cpp000066400000000000000000000071701474716233300215250ustar00rootroot00000000000000// ================================================================================== // Copyright (c) 2012 HiFi-LoFi // // This is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program. If not, see . // ================================================================================== #include "Utilities.h" namespace fftconvolver { bool SSEEnabled() { #if defined(FFTCONVOLVER_USE_SSE) return true; #else return false; #endif } void Sum(Sample* FFTCONVOLVER_RESTRICT result, const Sample* FFTCONVOLVER_RESTRICT a, const Sample* FFTCONVOLVER_RESTRICT b, size_t len) { const size_t end4 = 4 * (len / 4); for (size_t i=0; i. // ================================================================================== #ifndef _FFTCONVOLVER_UTILITIES_H #define _FFTCONVOLVER_UTILITIES_H #include #include #include #include #include namespace fftconvolver { #if defined(__SSE__) || (defined(_M_IX86_FP) && _M_IX86_FP >= 2) #if !defined(FFTCONVOLVER_USE_SSE) && !defined(FFTCONVOLVER_DONT_USE_SSE) #define FFTCONVOLVER_USE_SSE #endif #endif #if defined (FFTCONVOLVER_USE_SSE) #include #endif #if defined(__GNUC__) #define FFTCONVOLVER_RESTRICT __restrict__ #else #define FFTCONVOLVER_RESTRICT #endif /** * @brief Returns whether SSE optimization for the convolver is enabled * @return true: Enabled - false: Disabled */ bool SSEEnabled(); /** * @class Buffer * @brief Simple buffer implementation (uses 16-byte alignment if SSE optimization is enabled) */ template class Buffer { public: explicit Buffer(size_t initialSize = 0) : _data(0), _size(0) { resize(initialSize); } virtual ~Buffer() { clear(); } void clear() { deallocate(_data); _data = 0; _size = 0; } void resize(size_t size) { if (_size != size) { clear(); if (size > 0) { assert(!_data && _size == 0); _data = allocate(size); _size = size; } } if (_data) setZero(); } size_t size() const { return _size; } void setZero() { ::memset(_data, 0, _size * sizeof(T)); } void copyFrom(const Buffer& other) { assert(_size == other._size); if (this != &other) { ::memcpy(_data, other._data, _size * sizeof(T)); } } T& operator[](size_t index) { assert(_data && index < _size); return _data[index]; } const T& operator[](size_t index) const { assert(_data && index < _size); return _data[index]; } operator bool() const { return (_data != 0 && _size > 0); } T* data() { return _data; } const T* data() const { return _data; } static void Swap(Buffer& a, Buffer& b) { std::swap(a._data, b._data); std::swap(a._size, b._size); } private: T* allocate(size_t size) { #if defined(FFTCONVOLVER_USE_SSE) return static_cast(_mm_malloc(size * sizeof(T), 16)); #else return new T[size]; #endif } void deallocate(T* ptr) { #if defined(FFTCONVOLVER_USE_SSE) _mm_free(ptr); #else delete [] ptr; #endif } T* _data; size_t _size; // Prevent uncontrolled usage Buffer(const Buffer&); Buffer& operator=(const Buffer&); }; /** * @brief Type of one sample */ typedef float Sample; /** * @brief Buffer for samples */ typedef Buffer SampleBuffer; /** * @class SplitComplex * @brief Buffer for split-complex representation of FFT results * * The split-complex representation stores the real and imaginary parts * of FFT results in two different memory buffers which is useful e.g. for * SIMD optimizations. */ class SplitComplex { public: explicit SplitComplex(size_t initialSize = 0) : _size(0), _re(), _im() { resize(initialSize); } ~SplitComplex() { clear(); } void clear() { _re.clear(); _im.clear(); _size = 0; } void resize(size_t newSize) { _re.resize(newSize); _im.resize(newSize); _size = newSize; } void setZero() { _re.setZero(); _im.setZero(); } void copyFrom(const SplitComplex& other) { _re.copyFrom(other._re); _im.copyFrom(other._im); } Sample* re() { return _re.data(); } const Sample* re() const { return _re.data(); } Sample* im() { return _im.data(); } const Sample* im() const { return _im.data(); } size_t size() const { return _size; } private: size_t _size; SampleBuffer _re; SampleBuffer _im; // Prevent uncontrolled usage SplitComplex(const SplitComplex&); SplitComplex& operator=(const SplitComplex&); }; /** * @brief Returns the next power of 2 of a given number * @param val The number * @return The next power of 2 */ template T NextPowerOf2(const T& val) { T nextPowerOf2 = 1; while (nextPowerOf2 < val) { nextPowerOf2 *= 2; } return nextPowerOf2; } /** * @brief Sums two given sample arrays * @param result The result array * @param a The 1st array * @param b The 2nd array * @param len The length of the arrays */ void Sum(Sample* FFTCONVOLVER_RESTRICT result, const Sample* FFTCONVOLVER_RESTRICT a, const Sample* FFTCONVOLVER_RESTRICT b, size_t len); /** * @brief Copies a source array into a destination buffer and pads the destination buffer with zeros * @param dest The destination buffer * @param src The source array * @param srcSize The size of the source array */ template void CopyAndPad(Buffer& dest, const T* src, size_t srcSize) { assert(dest.size() >= srcSize); ::memcpy(dest.data(), src, srcSize * sizeof(T)); ::memset(dest.data() + srcSize, 0, (dest.size()-srcSize) * sizeof(T)); } /** * @brief Adds the complex product of two split-complex buffers to a result buffer * @param result The result buffer * @param a The 1st factor of the complex product * @param b The 2nd factor of the complex product */ void ComplexMultiplyAccumulate(SplitComplex& result, const SplitComplex& a, const SplitComplex& b); /** * @brief Adds the complex product of two split-complex arrays to a result array * @param re The real part of the result buffer * @param im The imaginary part of the result buffer * @param reA The real part of the 1st factor of the complex product * @param imA The imaginary part of the 1st factor of the complex product * @param reB The real part of the 2nd factor of the complex product * @param imB The imaginary part of the 2nd factor of the complex product */ void ComplexMultiplyAccumulate(Sample* FFTCONVOLVER_RESTRICT re, Sample* FFTCONVOLVER_RESTRICT im, const Sample* FFTCONVOLVER_RESTRICT reA, const Sample* FFTCONVOLVER_RESTRICT imA, const Sample* FFTCONVOLVER_RESTRICT reB, const Sample* FFTCONVOLVER_RESTRICT imB, const size_t len); } // End of namespace fftconvolver #endif // Header guard shairport-sync-4.3.7/FFTConvolver/convolver.cpp000066400000000000000000000054451474716233300215720ustar00rootroot00000000000000 #include #include #include "convolver.h" #include "FFTConvolver.h" #include "Utilities.h" extern "C" void _warn(const char *filename, const int linenumber, const char *format, ...); extern "C" void _debug(const char *filename, const int linenumber, int level, const char *format, ...); #define warn(...) _warn(__FILE__, __LINE__, __VA_ARGS__) #define debug(...) _debug(__FILE__, __LINE__, __VA_ARGS__) fftconvolver::FFTConvolver convolver_l; fftconvolver::FFTConvolver convolver_r; // always lock use this when accessing the playing conn value pthread_mutex_t convolver_lock = PTHREAD_MUTEX_INITIALIZER; int convolver_init(const char* filename, int max_length) { int success = 0; SF_INFO info; if (filename) { SNDFILE* file = sf_open(filename, SFM_READ, &info); if (file) { if (info.samplerate == 44100) { if ((info.channels == 1) || (info.channels == 2)) { const size_t size = info.frames > max_length ? max_length : info.frames; float buffer[size*info.channels]; size_t l = sf_readf_float(file, buffer, size); if (l != 0) { pthread_mutex_lock(&convolver_lock); convolver_l.reset(); // it is possible that init could be called more than once convolver_r.reset(); // so it could be necessary to remove all previous settings if (info.channels == 1) { convolver_l.init(352, buffer, size); convolver_r.init(352, buffer, size); } else { // deinterleave float buffer_l[size]; float buffer_r[size]; unsigned int i; for (i=0; i Shairport Sync: Copyright (c) 2014–2017 Mike Brady Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. shairport-sync-4.3.7/MAKING PULL REQUESTS.md000066400000000000000000000003571474716233300200120ustar00rootroot00000000000000Making Pull Requests ==== If you would like to make pull requests (PRs) to Shairport Sync, please base them on the `development` branch. Changes and additions in the `development` branch make their way eventually to the `master` branch. shairport-sync-4.3.7/MQTT.md000066400000000000000000000301311474716233300156310ustar00rootroot00000000000000# MQTT in Shairport Sync To enable Shairport Sync to act as an MQTT publisher, you need to: 1. Install the mosquitto library: ``` # apt install libmosquitto-dev ``` 2. Add the configuration flag `--with-mqtt-client` to the list of parameters to the `./configure...` command. For example: ``` $ ./configure --with-mqtt-client --sysconfdir=/etc --with-alsa --with-avahi --with-ssl=openssl --with-systemd ``` If Shairport Sync has MQTT support, it will have the string `mqtt` in its configuration string. For example: ``` $ shairport-sync -V 3.3.8-OpenSSL-Avahi-ALSA-metadata-mqtt-sysconfdir:/etc ``` **Note:** [The Docker image](https://hub.docker.com/r/mikebrady/shairport-sync) will have MQTT support enabled by default. ## Setting Up MQTT Publishing This is a rough guide on the setup of MQTT publishing in ShairPort Sync. The MQTT service listens for and publishes metadata generated by the AirPlay source and Shairport Sync. ### Example Configuration In the following example, Shairport Sync is configured to publish parsed metadata information and album-art to a MQTT server under the topic "shairport". ```xml metadata = { enabled = "yes"; // Set this to yes to get Shairport Sync to solicit metadata from the source and to pass it on via a pipe. include_cover_art = "yes"; // Set to "yes" to get Shairport Sync to solicit cover art from the source and pass it via the pipe. You must also set "enabled" to "yes". cover_art_cache_directory = "/tmp/shairport-sync/.cache/coverart"; // Artwork will be stored in this directory if the dbus or MPRIS interfaces are enabled or if the MQTT client is in use. Set it to "" to prevent caching, which may be useful on some systems. pipe_name = "/tmp/shairport-sync-metadata"; pipe_timeout = 5000; // Wait for this number of milliseconds for a blocked pipe to unblock before giving up. }; mqtt = { enabled = "yes"; // Set this to yes to enable the mqtt-metadata-service. hostname = "192.168.1.111"; // Hostname of the MQTT Broker. port = 1883; // Port on the MQTT Broker to connect to. username = "username"; // Set this to your MQTT user's username in order to enable username authentication. password = "password"; // Set this to your MQTT user's password in order to enable username & password authentication. topic = "shairport"; // MQTT topic where this instance of Shairport Sync should publish. If not set, the general.name value is used. // publish_raw = "no"; // Whether to publish all available metadata under the codes given in the 'metadata' docs. publish_parsed = "yes"; // Whether to publish a small (but useful) subset of metadata under human-understandable topics. publish_cover = "yes"; // Whether to publish the cover over MQTT in binary form. This may lead to a bit of load on the broker. // enable_remote = "no"; // Whether to remote control via MQTT. RC is available under `topic`/remote. }; ``` **Important:** Either `publish_raw`, `publish_parsed`, or `publish_cover` need to be set in the MQTT configuration. Otherwise, no messages will be published. ## Overall Active States `active_start` and `active_end` represent a stable on/off flag for the current AirPlay session. `active_start` is plublished when any new AirPlay session begins. `active_end` will fire after a configured timeout period unless the AirPlay stream is resumed. ```xml sessioncontrol = { // "active" state starts when play begins, and ends when the active_state_timeout has elapsed after play ends, unless another play session starts before the timeout has fully elapsed. active_state_timeout = 30.0; }; ``` ## Metadata Parsing Additional details regarding the metadata can be found at https://github.com/mikebrady/shairport-sync-metadata-reader. Metadata is generated by both the stream source (iOS, iTunes, etc.) and by Shairport Sync itself. This data is coded as two 4-character codes to identify each piece of data, the `type` and the `code`. The first 4-character code, called the `type`, is either: * `core` for all the regular metadadata coming from iTunes, etc., or * `ssnc` (for 'shairport-sync') for all metadata coming from Shairport Sync itself, such as start/end delimiters, etc. Additionally: * For `core` metadata, the second 4-character code is the 4-character metadata code that comes from iTunes, etc. See, for example, https://code.google.com/p/ytrack/wiki/DMAP for information about the significance of the codes. The original data supplied by the source, if any, follows, and is encoded in base64 format. The length of the data is also provided. * For `ssnc` metadata, the second 4-character code is used to distinguish the messages. Cover art, coming from the source, is not tagged in the same way as other metadata, it seems, so is sent as an `ssnc` type metadata message with the code `PICT`. Progress information, similarly, is not tagged like other source-originated metadata, so it is sent as an `ssnc` type with the code `prgr`. Here are some of the `core` codes commonly passed from the source: * `asal` -- album * `asar` -- artist * `ascp` -- composer * `asgn` -- genre * `astm` -- song time * `caps` -- play status (stopped, paused, playing) * `minm` -- title * `mper` -- track persistent id Here are the 'ssnc' codes defined so far: * `PICT` -- the payload is a picture, either a JPEG or a PNG. Check the first few bytes to see which. * `acre` -- Active Remote * `cdid` -- Client advertised Device ID * `clip` -- the payload is the IP address of the client, i.e. the sender of audio. Can be an IPv4 or an IPv6 address. * `cmac` -- Client advertised MAC address * `cmod` -- Client advertised model ("iPhone14,2") * `daid` -- DACP ID * `dapo` -- DACP Port * `mden` -- a sequence of metadata has ended. The RTP timestamp associated with the metadata sequence is included as data, if available. * `mdst` -- a sequence of metadata is about to start. The RTP timestamp associated with the metadata sequence is included as data, if available. * `pbeg` -- play stream begin. No arguments * `pcen` -- a picture has been sent. The RTP timestamp associated with it is included as data, if available. * `pcst` -- a picture is about to be sent. The RTP timestamp associated with it is included as data, if available. * `pend` -- play stream end. No arguments * `pfls` -- play stream flush. No arguments * `prsm` -- play stream resume. No arguments * `prgr` -- progress -- this is metadata from AirPlay consisting of RTP timestamps for the start of the current play sequence, the current play point and the end of the play sequence. * `pvol` -- play volume. The volume is sent as a string -- "airplay_volume,volume,lowest_volume,highest_volume", where "volume", "lowest_volume" and "highest_volume" are given in dB. The "airplay_volume" is what's sent by the source (e.g. iTunes) to the player, and is from 0.00 down to -30.00, with -144.00 meaning "mute". This is linear on the volume control slider of iTunes or iOS AirPlay. If the volume setting is being ignored by Shairport Sync itself, the volume, lowest_volume and highest_volume values are zero. * `snam` -- a device e.g. "Joe's iPhone" has started a play session. Specifically, it's the "X-Apple-Client-Name" string for AP1, or direct from the configuration Plist for AP2. * `snua` -- a "user agent" e.g. "iTunes/12..." has started a play session. Specifically, it's the "User-Agent" string. * `stal` -- this is an error message meaning that reception of a large piece of metadata, usually a large picture, has stalled; bad things may happen. * `svip` -- the payload is the IP address of the server, i.e. shairport-sync. Can be an IPv4 or an IPv6 address. ### Parsed Messages The MQTT service can parse the above raw messages into a subset of human-readable topics that include: * `active_remote_id` -- Active Remote ID * `artist` -- text of artist name * `album` -- text of album name * `client_ip` -- IP address of the connected client * `client_device_id` -- Client advertised Device ID * `client_mac_address` -- Client advertised MAC address * `client_model` -- Client advertised model ("iPhone14,2") * `client_name` -- Client advertised name ("Joe's iPhone") * `dacp_id` -- DACP ID * `format` -- ?? * `genre` -- text of genre * `server_ip` -- IP address of Shairport Sync that the client is connected to * `songalbum` -- * `title` -- text of song title * `volume` -- The volume is sent as a string -- "airplay_volume,volume,lowest_volume,highest_volume", where "volume", "lowest_volume" and "highest_volume" are given in dB. (see above) Additionally, empty messages (`--`) at the following topics are published. * `play_start` -- fired at the begining of every song * `play_end` -- fired at the end of every song * `play_flush` -- fired when song is skipped or on positional change * `play_resume` -- fired when song play resumes from pause * `active_start` -- fired when a new active AirPlay session begins * `active_end` -- fired after a configured timeout period after the stream ends (unless a new stream begins) ## Consuming MQTT Data MQTT provides users with the flexibility to consume the MQTT data in various home automation projects. If you have an interesting use, please raise a new issue to suggest adding it to the guide, or simply fork the development branch and create a pull request. ### [Home Assistant](https://www.home-assistant.io/) Examples The `active_start` and `active_end` have good potential use as triggers to turn on and off various connected receivers/zones. Note that `payload_off` is set to prevent accidental triggering. ```yml mqtt: - binary_sensor: name: "shairport active start" state_topic: "shairport/active_start" payload_on: "--" payload_off: "OFF" off_delay: 300 - binary_sensor: name: "shairport active end" state_topic: "shairport/active_end" payload_on: "--" payload_off: "OFF" off_delay: 300 ``` In the below example, the parsed data is saved into the Home Assistant database as sensor data. Please note the conversion of the volume from dB to percentage. ```yml mqtt: sensor: - name: "shairport album" state_topic: "shairport/album" expire_after: 600 - name: "shairport artist" state_topic: "shairport/artist" expire_after: 600 - name: "shairport title" state_topic: "shairport/title" expire_after: 600 - name: "shairport genre" state_topic: "shairport/genre" expire_after: 600 - name: "shairport volume (dB)" state_topic: "shairport/volume" - name: "shairport volume (PCT)" state_topic: "shairport/volume" value_template: "{{ value | regex_findall_index(find='^(.+?),', index=0, ignorecase=False) | float / 30 + 1 }}" unit_of_measurement: 'percent' ``` ### [Homebridge](https://homebridge.io/) [MQTTThing](https://github.com/arachnetech/homebridge-mqttthing#readme) Examples **Homebridge** is a lightweight Node.js server that brings non-HomeKit devices to Apple’s Home app, and **MQTTThing** is a versatile Homebridge plugin that integrates MQTT-enabled devices with HomeKit. While MQTTThing offers a speaker characteristic, it does not seem to be recognized by HomeKit. Instead, the **contact sensor** characteristic can effectively represent Shairport Sync’s `active` status within HomeKit, enabling users to trigger automations based on this status. Below is an example configuration for Homebridge's JSON Config to represent Shairport Sync's `active` status: ```json "accessories": [ { "type": "contactSensor", "name": "Shairport", "url": "hostname:1883", "username": "user", "password": "password", "topics": { "getContactSensorState": "shairport/active" }, "onValue": "1", "offValue": "0", "otherValueOff": false, "accessory": "mqttthing" } ] ``` * Replace hostname:1883, user, and password with the details of your MQTT broker. * The topic shairport/active should match the one configured in Shairport Sync’s MQTT settings. * The onValue and offValue correspond to the MQTT messages indicating whether Shairport Sync is active (1) or inactive (0). MQTTThing supports a wide range of characteristics, allowing additional topics from Shairport Sync or other devices to be represented in HomeKit as different accessory types (e.g., switches, lights, or sensors) in a similar manner. shairport-sync-4.3.7/Makefile.am000066400000000000000000000263601474716233300165670ustar00rootroot00000000000000ARFLAGS = cr man_MANS = $(top_srcdir)/man/shairport-sync.1 lib_pair_ap_a_CFLAGS = -Wall -g -DCONFIG_GCRYPT -pthread lib_tinyhttp_a_CFLAGS = -pthread lib_dbus_interface_a_CFLAGS = -pthread lib_mpris_interface_a_CFLAGS = -pthread bin_PROGRAMS = shairport-sync BUILT_SOURCES = noinst_HEADERS = CLEANFILES = shairport_sync_LDADD = noinst_LIBRARIES = # See below for the flags for the test client program shairport_sync_SOURCES = shairport.c rtsp.c mdns.c common.c rtp.c player.c alac.c audio.c loudness.c activity_monitor.c if BUILD_FOR_DARWIN AM_CXXFLAGS = -I/usr/local/include -Wno-multichar -Wall -Wextra -Wno-deprecated-declarations -pthread -DSYSCONFDIR=\"$(sysconfdir)\" AM_CFLAGS = -Wno-multichar -Wall -Wextra -Wno-deprecated-declarations -pthread -DSYSCONFDIR=\"$(sysconfdir)\" else if BUILD_FOR_FREEBSD AM_CXXFLAGS = -I/usr/local/include -Wno-multichar -Wall -Wextra -pthread -DSYSCONFDIR=\"$(sysconfdir)\" AM_CFLAGS = -Wno-multichar -Wall -Wextra -pthread -DSYSCONFDIR=\"$(sysconfdir)\" else if BUILD_FOR_OPENBSD AM_CXXFLAGS = -I/usr/local/include -Wno-multichar -Wall -Wextra -Wno-clobbered -Wno-psabi -pthread -DSYSCONFDIR=\"$(sysconfdir)\" AM_CFLAGS = -Wno-multichar -Wall -Wextra -pthread -DSYSCONFDIR=\"$(sysconfdir)\" else AM_CXXFLAGS = -fno-common -Wno-multichar -Wall -Wextra -Wno-clobbered -Wno-psabi -pthread -DSYSCONFDIR=\"$(sysconfdir)\" AM_CFLAGS = -fno-common -Wno-multichar -Wall -Wextra -Wno-clobbered -Wno-psabi -pthread -DSYSCONFDIR=\"$(sysconfdir)\" shairport_sync_SOURCES += scripts/shairport-sync.service scripts/shairport-sync.service-avahi scripts/shairport-sync endif endif endif # include information generated by 'git describe --tags --dirty --broken' if requested if USE_GIT_VERSION shairport_sync_SOURCES += gitversion.c gitversion.h: .git/index printf "// Do not edit!\n" > gitversion.h printf "// This file is automatically generated by 'git describe --tags --dirty --broken', if available.\n" >> gitversion.h printf " char git_version_string[] = \"" >> gitversion.h git describe --tags --dirty --broken | tr -d '[[:space:]]' >> gitversion.h printf "\";\n" >> gitversion.h gitversion.c: gitversion.h touch gitversion.c BUILT_SOURCES += gitversion.c gitversion.h noinst_HEADERS += $(BUILT_SOURCES) # Correctly clean the generated headers, but keep the xml description CLEANFILES += $(BUILT_SOURCES) endif if USE_APPLE_ALAC shairport_sync_SOURCES += apple_alac.cpp endif if USE_CUSTOMPIDDIR AM_CFLAGS+= \ -DPIDDIR=\"$(CUSTOM_PID_DIR)\" endif if USE_AVAHI shairport_sync_SOURCES += mdns_avahi.c endif if USE_TINYSVCMDNS shairport_sync_SOURCES += mdns_tinysvcmdns.c tinysvcmdns.c endif if USE_EXTERNAL_MDNS shairport_sync_SOURCES += mdns_external.c endif if USE_ALSA shairport_sync_SOURCES += audio_alsa.c endif if USE_JACK shairport_sync_SOURCES += audio_jack.c endif if USE_SNDIO shairport_sync_SOURCES += audio_sndio.c endif if USE_STDOUT shairport_sync_SOURCES += audio_stdout.c endif if USE_PIPE shairport_sync_SOURCES += audio_pipe.c endif if USE_DUMMY shairport_sync_SOURCES += audio_dummy.c endif if USE_AO shairport_sync_SOURCES += audio_ao.c endif if USE_SOUNDIO shairport_sync_SOURCES += audio_soundio.c endif if USE_PA shairport_sync_SOURCES += audio_pa.c endif if USE_PW shairport_sync_SOURCES += audio_pw.c endif if USE_CONVOLUTION shairport_sync_SOURCES += FFTConvolver/AudioFFT.cpp FFTConvolver/FFTConvolver.cpp FFTConvolver/Utilities.cpp FFTConvolver/convolver.cpp AM_CXXFLAGS += -std=c++11 endif if USE_DNS_SD shairport_sync_SOURCES += mdns_dns_sd.c endif if USE_METADATA_HUB shairport_sync_SOURCES += metadata_hub.c endif if USE_MQTT shairport_sync_SOURCES += mqtt.c endif if USE_DACP_CLIENT shairport_sync_SOURCES += dacp.c shairport_sync_LDADD += lib_tinyhttp.a noinst_LIBRARIES += lib_tinyhttp.a lib_tinyhttp_a_SOURCES = tinyhttp/chunk.c tinyhttp/header.c tinyhttp/http.c endif if USE_AIRPLAY_2 shairport_sync_SOURCES += ptp-utilities.c plist_xml_strings.c shairport_sync_LDADD += lib_pair_ap.a lib_pair_ap_a_SOURCES = pair_ap/pair.c pair_ap/pair_fruit.c pair_ap/pair_homekit.c pair_ap/pair-tlv.c noinst_LIBRARIES += lib_pair_ap.a plist_xml_strings.h: plists/get_info_response.xml printf "// Do not edit!\n" > plist_xml_strings.h printf "// This file is automatically generated from files in the plists folder.\n\n" >> plist_xml_strings.h xxd -i $(top_srcdir)/plists/get_info_response.xml - | sed -e 's/[^ ]*plists_get_info_response_xml/plists_get_info_response_xml/g' >> plist_xml_strings.h printf "\n" >> plist_xml_strings.h plist_xml_strings.c: plist_xml_strings.h touch plist_xml_strings.c BUILT_SOURCES += plist_xml_strings.c plist_xml_strings.h noinst_HEADERS += $(BUILT_SOURCES) # Correctly clean the generated headers, but keep the xml description CLEANFILES += $(BUILT_SOURCES) endif if USE_DBUS shairport_sync_LDADD += lib_dbus_interface.a noinst_LIBRARIES += lib_dbus_interface.a lib_dbus_interface_a_SOURCES = dbus-interface.c shairport_sync_SOURCES += dbus-service.c BUILT_SOURCES += dbus-interface.h dbus-interface.c # We don't want to install this header noinst_HEADERS += $(BUILT_SOURCES) # Correctly clean the generated headers, but keep the xml description CLEANFILES += $(BUILT_SOURCES) dbus-interface.c: org.gnome.ShairportSync.xml gdbus-codegen --interface-prefix org.gnome --generate-c-code dbus-interface $(top_srcdir)/org.gnome.ShairportSync.xml dbus-interface.h: dbus-interface.c touch dbus-interface.h endif if USE_MPRIS shairport_sync_LDADD += lib_mpris_interface.a noinst_LIBRARIES += lib_mpris_interface.a lib_mpris_interface_a_SOURCES = mpris-interface.c shairport_sync_SOURCES += mpris-service.c BUILT_SOURCES += mpris-interface.h mpris-interface.c # We don't want to install this header noinst_HEADERS += $(BUILT_SOURCES) # Correctly clean the generated headers, but keep the xml description CLEANFILES += $(BUILT_SOURCES) mpris-interface.c: org.mpris.MediaPlayer2.xml gdbus-codegen --interface-prefix org.mpris --generate-c-code mpris-interface $(top_srcdir)/org.mpris.MediaPlayer2.xml mpris-interface.h: mpris-interface.c touch mpris-interface.h endif noinst_PROGRAMS = if USE_DBUS_CLIENT #Make it, but don't install it anywhere noinst_PROGRAMS += shairport-sync-dbus-test-client shairport_sync_dbus_test_client_SOURCES = shairport-sync-dbus-test-client.c shairport_sync_dbus_test_client_LDADD = lib_dbus_interface.a endif if USE_MPRIS_CLIENT #Make it, but don't install it anywhere noinst_PROGRAMS += shairport-sync-mpris-test-client shairport_sync_mpris_test_client_SOURCES = shairport-sync-mpris-test-client.c shairport_sync_mpris_test_client_LDADD = lib_mpris_interface.a endif CONFIG_FILE_INSTALL_TARGET = config-file-install-local $(CONFIG_FILE_INSTALL_TARGET): scripts/shairport-sync.conf install -d $(DESTDIR)$(sysconfdir) install -m 0644 $(top_srcdir)/scripts/shairport-sync.conf $(DESTDIR)$(sysconfdir)/shairport-sync.conf.sample [ -f $(DESTDIR)$(sysconfdir)/shairport-sync.conf ] || cp $(top_srcdir)/scripts/shairport-sync.conf $(DESTDIR)$(sysconfdir)/shairport-sync.conf if BUILD_FOR_LINUX DBUS_POLICY_DIR = /etc/dbus-1/system.d else DBUS_POLICY_DIR = $(sysconfdir)/dbus-1/system.d endif if USE_DBUS if INSTALL_CYGWIN_SERVICE DBUS_POLICY_FILE = scripts/shairport-sync-dbus-policy-cygwin.conf else DBUS_POLICY_FILE = scripts/shairport-sync-dbus-policy.conf endif # INSTALL_CYGWIN_SERVICE DBUS_POLICY_INSTALL_TARGET = dbus-policy-install-local $(DBUS_POLICY_INSTALL_TARGET): $(DBUS_POLICY_FILE) install -d $(DESTDIR)$(DBUS_POLICY_DIR) install -m 0644 $(top_srcdir)/$(DBUS_POLICY_FILE) $(DESTDIR)$(DBUS_POLICY_DIR)/shairport-sync-dbus.conf endif # USE_DBUS if USE_MPRIS if INSTALL_CYGWIN_SERVICE MPRIS_POLICY_FILE = scripts/shairport-sync-mpris-policy-cygwin.conf else MPRIS_POLICY_FILE = scripts/shairport-sync-mpris-policy.conf endif # INSTALL_CYGWIN_SERVICE MPRIS_POLICY_INSTALL_TARGET = mpris-policy-install-local $(MPRIS_POLICY_INSTALL_TARGET): $(MPRIS_POLICY_FILE) install -d $(DESTDIR)$(DBUS_POLICY_DIR) install -m 0644 $(top_srcdir)/$(MPRIS_POLICY_FILE) $(DESTDIR)$(DBUS_POLICY_DIR)/shairport-sync-mpris.conf endif # USE_MPRIS INSTALL_GROUP_TARGET = install-group-local $(INSTALL_GROUP_TARGET): getent group shairport-sync &>/dev/null || groupadd -r shairport-sync &>/dev/null if INSTALL_CREATE_USER_GROUP INSTALL_USER_TARGET = install-user-local else INSTALL_USER_TARGET = endif $(INSTALL_USER_TARGET): $(INSTALL_GROUP_TARGET) getent passwd shairport-sync &>/dev/null || useradd -r -M -g shairport-sync -s /usr/sbin/nologin -G audio shairport-sync &>/dev/null if INSTALL_SYSTEMV INSTALL_SYSTEMV_TARGET = install-systemv-local # watch out -- shairport-sync is created during the ./configure step and # will be stored in a scripts folder in the _build_ folder # which will be the source folder if you're not using a separate build folder $(INSTALL_SYSTEMV_TARGET): scripts/shairport-sync $(INSTALL_USER_TARGET) install -d $(DESTDIR)$(sysconfdir)/init.d [ -e $(DESTDIR)$(sysconfdir)/init.d/shairport-sync ] || install -m 0755 scripts/shairport-sync $(DESTDIR)$(sysconfdir)/init.d endif # INSTALL_SYSTEMV if INSTALL_SYSTEMD if USE_AVAHI SYSTEMD_SERVICE = shairport-sync.service-avahi else SYSTEMD_SERVICE = shairport-sync.service endif # USE_AVAHI INSTALL_SYSTEMD_TARGET = install-systemd-local # watch out -- shairport-sync.service is created during the ./configure step and # will be stored in a scripts folder in the _build_ folder # which will be the source folder if you're not using a separate build folder $(INSTALL_SYSTEMD_TARGET): scripts/$(SYSTEMD_SERVICE) $(INSTALL_USER_TARGET) install -d $(DESTDIR)$(systemdsystemunitdir) [ -e $(DESTDIR)$(systemdsystemunitdir)/shairport-sync.service ] || install -m 0644 scripts/$(SYSTEMD_SERVICE) $(DESTDIR)$(systemdsystemunitdir)/shairport-sync.service endif # INSTALL_SYSTEMD if INSTALL_FREEBSD_SERVICE # Choose a uid and gid of 801 completely arbitrarity, except that it should be below 1000. FreeBSD doesn't seem to allow you to say "an ID in the range of..." install-freebsd-user-local: pw showgroup shairport-sync > /dev/null 2>&1 || pw addgroup -n shairport-sync -g 801 > /dev/null 2>&1 pw showuser shairport-sync > /dev/null 2>&1 || pw adduser -c "shairport-sync unprivileged user" -n shairport-sync -u 801 -s /usr/sbin/nologin -d /nonexistent > /dev/null 2>&1 INSTALL_FREEBSD_TARGET = install-freebsd-local $(INSTALL_FREEBSD_TARGET): scripts/shairport-sync.freebsd install-freebsd-user-local install -d -o shairport-sync -g shairport-sync $(DESTDIR)/var/run/shairport-sync install -d $(DESTDIR)/usr/local/etc/rc.d/ install -m 0555 $(top_srcdir)/scripts/shairport-sync.freebsd $(DESTDIR)/usr/local/etc/rc.d/shairport_sync endif # INSTALL_FREEBSD_SERVICE if INSTALL_CYGWIN_SERVICE INSTALL_CYGWIN_TARGET = install-cygwin-local $(INSTALL_CYGWIN_TARGET): scripts/shairport-sync-config install -d $(DESTDIR)/usr/local/bin [ -e $(DESTDIR)/usr/local/bin/shairport-sync-config ] || install -m 0755 $(top_srcdir)/scripts/shairport-sync-config $(DESTDIR)/usr/local/bin/ endif # INSTALL_CYGWIN_SERVICE install-config-files: $(CONFIG_FILE_INSTALL_TARGET) \ $(DBUS_POLICY_INSTALL_TARGET) \ $(MPRIS_POLICY_INSTALL_TARGET) \ $(INSTALL_SYSTEMV_TARGET) \ $(INSTALL_SYSTEMD_TARGET) \ $(INSTALL_FREEBSD_TARGET) \ $(INSTALL_CYGWIN_TARGET) if INSTALL_CONFIG_FILES install-exec-hook: install-config-files endif shairport-sync-4.3.7/NEWS000066400000000000000000000000701474716233300152200ustar00rootroot00000000000000Please refer to RELEASENOTES.md and README.md for news. shairport-sync-4.3.7/OPENBSD.md000066400000000000000000000057231474716233300161470ustar00rootroot00000000000000Shairport Sync on OpenBSD [AirPlay 2 Not Supported] ---- This is a note about installing Shairport Sync on OpenBSD. Shairport Sync compiles and runs natively on OpenBSD using the `sndio` back end. For general information on `sndio` please follow [this link](http://www.sndio.org). Unlike FreeBSD, it seems that OpenBSD does not use the directory `/usr/local/etc` as a system configuration directory ("`sysconfdir`") but follows the same practice as Linux in using `/etc` as the default `sysconfdir`. General ---- This build was done on a default build of `OpenBSD 6.6 GENERIC.MP#5 amd64`. Following [this guide](https://www.openbsd.org/faq/faq15.html), `/etc/installurl` was created with the to refer to the standard repository: ``` https://ftp.openbsd.org/pub/OpenBSD ``` You might have a [closer or faster](https://www.openbsd.org/ftp.html) repository to use instead. Next, although it may not always be necessary, apply any outstanding system updates and [update the packages](https://unix.stackexchange.com/questions/23579/how-to-apply-updates-on-openbsd-netbsd-and-freebsd). First, update the system: ``` # syspatch ``` Now update the packages: ``` # pkg_add -Uu ``` Install the Avahi subsystem ([search](https://www.openbsd.org/faq/faq15.html) using, for example, `# pkg_info -Q avahi`). ``` # pkg_add avahi ``` A number of libraries will be installed to support Avahi, including the D-Bus system. Enable the D-Bus and Avahi subsystems to [start automatically](http://openbsd-archive.7691.n7.nabble.com/starting-avahi-the-proper-way-td311612.html): ``` # rcctl enable messagebus avahi_daemon # rcctl start messagebus avahi_daemon ``` Building ---- Install the following packages (e.g. using `pkg_add` in superuser mode) needed to download and build Shairport Sync: ``` # pkg_add autoconf automake popt libconfig git ``` Note the versions of `autoconf` and `automake` you choose (`2.69` and `1.16` at the time of writing) and add them as shell variable definitions for -- they could be placed in the user's `.profile` file to be automatically executed at login: ``` export AUTOCONF_VERSION=2.69 export AUTOMAKE_VERSION=1.16 ``` Now, download Shairport Sync from GitHub: ``` $ git clone https://github.com/mikebrady/shairport-sync.git $ cd shairport-sync ``` Next, configure and compile shairport-sync: ``` $ autoreconf -fi $ ./configure --sysconfdir=/etc --with-avahi --with-ssl=openssl --with-libdaemon \ --with-sndio --with-os=openbsd $ make ``` The application is called `shairport-sync`. Check that it's running correctly by executing the following command: ``` $ ./shairport-sync -V ``` This will execute the application and it will return its version information and terminate, for example: ``` 3.3.6-libdaemon-OpenSSL-Avahi-sndio-sysconfdir:/etc ``` There is no make install yet -- you're on your own. Using the `sndio` backend ---- The `sndio` back end does not yet have a hardware volume control facility. You should set the volume to maximum before use, using, for example, the `mixerctl` command. shairport-sync-4.3.7/README000066400000000000000000000000001474716233300153720ustar00rootroot00000000000000shairport-sync-4.3.7/README.md000066400000000000000000000261261474716233300160120ustar00rootroot00000000000000# Shairport Sync Shairport Sync is an [AirPlay](https://www.pocket-lint.com/speakers/news/apple/144646-apple-airplay-2-vs-airplay-what-s-the-difference) audio player for Linux, FreeBSD and OpenBSD. It plays audio streamed from Apple devices and from AirPlay sources such as [OwnTone](https://github.com/owntone/owntone-server) (formerly `forked-daapd`). Shairport Sync can be built as an AirPlay 2 player (with [some limitations](AIRPLAY2.md#features-and-limitations)) or as "classic" Shairport Sync – a player for the older, but still supported, AirPlay (aka "AirPlay 1") protocol. Metadata such as artist information and cover art can be requested and provided to other applications. Shairport Sync can interface with other applications through MQTT, an MPRIS-like interface and D-Bus. Shairport Sync does not support AirPlay video or photo streaming. # Quick Start * A building guide is available [here](BUILD.md). * A Docker image is available on the [Docker Hub](https://hub.docker.com/r/mikebrady/shairport-sync). Also see [docker/README.md](docker/README.md). * Next Steps and Advanced Topics are [here](ADVANCED%20TOPICS/README.md). * Runtime settings are documented [here](scripts/shairport-sync.conf). * Build configuration options are detailed in [CONFIGURATION FLAGS.md](CONFIGURATION%20FLAGS.md). * The `man` page, detailing command line options, is [here](https://htmlpreview.github.io/?https://github.com/mikebrady/shairport-sync/blob/master/man/shairport-sync.html). * Some advanced topics and developed in [ADVANCED TOPICS](https://github.com/mikebrady/shairport-sync/tree/master/ADVANCED%20TOPICS). # Features * Outputs AirPlay audio to [ALSA](https://www.alsa-project.org/wiki/Main_Page), [sndio](http://www.sndio.org), [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/), [Jack Audio](http://jackaudio.org), to a unix pipe or to `STDOUT`. It also has experimental support for [PipeWire](https://pipewire.org) and limited support for [libao](https://xiph.org/ao/) and for [libsoundio](http://libsound.io). * Metadata — Shairport Sync can deliver metadata supplied by the source, such as Album Name, Artist Name, Cover Art, etc. through a pipe or UDP socket to a recipient application program — see https://github.com/mikebrady/shairport-sync-metadata-reader for a sample recipient. Sources that supply metadata include iTunes and the Music app in macOS and iOS. * An interface to [MQTT](https://en.wikipedia.org/wiki/MQTT), a popular protocol for Inter Process Communication, Machine-to-Machine, Internet of Things and Home Automation projects. The interface provides access to metadata and artwork, and has limited remote control. * Digital Signal Processing facilities – please see the [DSP Wiki Page Guide](https://github.com/mikebrady/shairport-sync/wiki/Digital-Signal-Processing-with-Shairport-Sync). (Thanks to [Yann Pomarède](https://github.com/yannpom) for the code and to [Paul Wieland](https://github.com/PaulWieland) for the guide.) * An [MPRIS](https://specifications.freedesktop.org/mpris-spec/2.2/)-like interface, partially complete and very functional, including access to metadata and artwork, and limited remote control. * A native D-Bus interface, including access to metadata and artwork, limited remote control and system settings. * Better Volume Control — Shairport Sync offers finer control at very top and very bottom of the volume range. See http://tangentsoft.net/audio/atten.html for a good discussion of audio "attenuators", upon which volume control in Shairport Sync is modelled. See also the diagram of the volume transfer function in the documents folder. In addition, Shairport Sync can offer an extended volume control range on devices with a restricted range. * Support for the [Apple ALAC decoder](https://macosforge.github.io/alac/) (library available [here](https://github.com/mikebrady/alac)). * Output bit depths of 8, 16, 24 and 32 bits, rather than the standard 16 bits. * Output frame rates of 44,100, 88,200, 176,000 or 352,000 frames per second. Some features require configuration at build time – see [CONFIGURATION FLAGS.md](CONFIGURATION%20FLAGS.md). # Status Shairport Sync was designed to [run best](ADVANCED%20TOPICS/GetTheBest.md) on stable, dedicated, stand-alone low-power "headless" systems with ALSA as the audio system and with a decent CD-quality Digital to Analog Converter (DAC). Shairport Sync runs on recent (2018 onwards) Linux systems, FreeBSD from 12.1 onwards and OpenBSD. It requires a system with the power of a Raspberry Pi 2 or a Pi Zero 2 or better. Classic Shairport Sync runs on a wider variety of Linux sytems, including OpenWrt and Cygwin and it also runs on OpenBSD. Many embedded devices are powerful enough to power classic Shairport Sync. # Heritage and Acknowledgements The functionality offered by Shairport Sync is the result of study and analysis of the AirPlay and AirPlay 2 protocols by many people over the years. These protocols have not been officially published, and there is no assurance that Shairport Sync will continue to work in future. Shairport Sync is a substantial rewrite of the fantastic work done in Shairport 1.0 by James Wah (aka [abrasive](https://github.com/abrasive)), James Laird and others — please see [this list](https://github.com/abrasive/shairport/blob/master/README.md#contributors-to-version-1x) of the contributors to Shairport 1.x and Shairport 0.x. From a "heritage" point of view, Shairport Sync is a fork of Shairport 1.0. For the development of AirPlay 2 support, special thanks are due to: * [JD Smith](https://github.com/jdtsmith) for really thorough testing, support and encouragement. * [ejurgensen](https://github.com/ejurgensen) for advice and [code to deal with pairing and encryption](https://github.com/ejurgensen/pair_ap). * [ckdo](https://github.com/ckdo) for pointing the way, particularly with pairing and encryption protocols, with a [functional Python implementation](https://github.com/ckdo/airplay2-receiver) of AirPlay 2. * [invano](https://github.com/invano) for showing what might be possible and for initial Python development. * [Charles Omer](https://github.com/charlesomer) for Docker automation, repository management automation, testing, encouragement, enthusiasm. Much of Shairport Sync's AirPlay 2 functionality is based on ideas developed at the [openairplay airplay2-receiver]( https://github.com/openairplay/airplay2-receiver) repository. It is a pleasure to acknowledge the work of the contributors there. Thanks to everyone who has supported and improved Shairport Sync over the years. # More about Shairport Sync The audio that Shairport Sync receives is sent to the computer's sound system, to a named unix pipe or to `STDOUT`. By far the best sound system to use is ALSA. This is because ALSA can give direct access to the Digital to Analog Converter (DAC) hardware of the machine. Audio samples can be sent through ALSA directly to the DAC, maximising fidelity, and accurate timing information can be obtained from the DAC, maximising synchronisation. Direct access to hardware is given through ALSA devices with names beginning with `hw:`. ## Synchronised Audio Shairport Sync offers *full audio synchronisation*. Full audio synchronisation means that audio is played on the output device at exactly the time specified by the audio source. To accomplish this, Shairport Sync needs access to audio systems – such as ALSA on Linux and `sndio` on FreeBSD and OpenBSD – that provide very accurate timing information about audio being streamed to output devices. Ideally, Shairport Sync should have direct access to the output device used, which should be a real sound card capable of working with 44,100, 88,200 or 176,400 samples per second, interleaved PCM stereo of 8, 16, 24 or 32 bits. Using the ALSA sound system, Shairport Sync will choose the greatest bit depth available at 44,100 samples per second, resorting to multiples of 44,100 if it is not available. You'll get a message in the log if there's a problem. With all other sound systems, a sample rate of 44,100 is chosen with a bit depth of 16 bit. Shairport Sync works well with PulseAudio, a widely used sound server found on many desktop Linuxes. While the timing information is not as accurate as that of ALSA or `sndio`, it is often impractical to remove or disable PulseAudio. For other use cases, Shairport Sync can provide synchronised audio output to a unix pipe or to `STDOUT`, or to audio systems that do not provide timing information. This could perhaps be described as *partial audio synchronisation*, where synchronised audio is provided by Shairport Sync, but what happens to it in the subsequent processing chain, before it reaches the listener's ear, is outside the control of Shairport Sync. ## Latency, "Stuffing", Timing AirPlay protocols use an agreed *latency* – a time lag or delay – between the time represented by a sound sample's `timestamp` and the time it is actually played by the audio output device, typically a Digital to Audio Converter (DAC). Latency gives players time to compensate for network delays, processing time variations and so on. The latency is specified by the audio source when it negotiates with Shairport Sync. AirPlay sources set a latency of around 2.0 to 2.25 seconds. AirPlay 2 can use shorter latencies, around half a second. As mentioned previously, Shairport Sync implements full audio synchronisation when used with ALSA, `sndio` or PulseAudio audio systems. This is done by monitoring the timestamps present in data coming from the audio source and the timing information coming back from the audio system itself. To maintain the latency required for exact synchronisation, if the output device is running slow relative to the source, Shairport Sync will delete frames of audio to allow the device to keep up. If the output device is running fast, Shairport Sync will insert ("stuff") extra frames to keep time. The number of frames inserted or deleted is so small as to be almost inaudible on normal audio material. Frames are inserted or deleted as necessary at pseudorandom intervals. Alternatively, with `libsoxr` support, Shairport Sync can resample the audio feed to ensure the output device can keep up. This is less obtrusive than insertion and deletion but requires a good deal of processing power — most embedded devices probably can't support it. If your computer is fast enough, Shairport Sync will, by default, automatically choose this method. Stuffing is not done for partial audio synchronisation – the audio samples are simply presented at exactly the right time to the next stage in the processing chain. Timestamps are referenced relative to the source computer's clock – the "source clock", but timing must be done relative to the clock of the computer running Shairport Sync – the "local clock". So, Shairport Sync synchronises the source clock and the local clock, usually to within a fraction of a millisecond. In AirPlay 2, this is done with the assistance of a companion application called [NQPTP](https://github.com/mikebrady/nqptp) using a [PTP](https://en.wikipedia.org/wiki/Precision_Time_Protocol)-based timing protocol. In classic AirPlay, a variant of [NTP](https://en.wikipedia.org/wiki/Network_Time_Protocol) synchronisation protocols is used. shairport-sync-4.3.7/RELEASENOTES.md000066400000000000000000003610421474716233300167450ustar00rootroot00000000000000Minor Release Notes ==== Minor release notes are attached to the releases themselves. Version 4.3 -- Security Updates, Bug Fixes and Enhancements ==== This update contains important security updates, bug fixes and enhancements. [NQPTP](https://github.com/mikebrady/nqptp) must also be updated, and it should be updated before updating Shairport Sync. The Shared Memory Interface version of both Shairport Sync and NQPTP is now 10, i.e. `smi10`. Thus the version string of both apps should contain `smi10`: ``` $ nqptp -V Version: 1.2.4. Shared Memory Interface Version: smi10. $ shairport-sync -V 4.3-...-smi10-... ``` Notes 1. When updating NQPTP on Linux, be sure to remove the old service file as directed in the [README](https://github.com/mikebrady/nqptp/blob/main/README.md#remove-old-service-files). 2. Having completed both updates and installations, remember to restart NQPTP first and then restart Shairport Sync. **Security Updates** * A crashing bug in NQPTP has been fixed. * The communications protocol used between NQPTP and Shairport Sync has been revised and made more resilient to attempted misuse. * In Linux systems, NQPTP no longer runs as `root` -- instead it runs as the restriced user `nqptp`, with access to ports 319 and 320 set by the installer via the `setcap` utility. **Enhancements** * A new volume control profile called `dasl-tapered` has been added in which halving the volume control setting halves the output level. For example, moving the volume slider from full to half reduces the output level by 10dB, which roughly corresponds with a perceived halving of the audio volume level. Moving the volume slider from half to a quarter reduces the output level by a a further 10dB. The tapering rate is slightly modified at the lower end of the range if the device's attenuation range is restricted (less than about 55dB). To activate the `dasl-tapered` profile, set the `volume_control_profile` to `"dasl_tapered"` in the configuration file and restart Shairport Sync. Many thanks to David Leibovic, aka [dasl-](https://github.com/dasl-), for this. * On graceful shutdown, an `active_end` signal should now be generated if the system was in the active state. Addresses issue [#1647](https://github.com/mikebrady/shairport-sync/issues/1647). Thanks to [Tucker Kern](https://github.com/mill1000) for raising the issue. **Bug Fixes** * Fixed a bug that causes the Docker image to crash occasionally when OwnTone interrupted an existing iOS session. Thanks to [aaronk6](https://github.com/aaronk6) for the report. * Fixed a cross-compliation error caused by not looking for the correct version of the `ar` tool. The fix was to substitute the correct version during the `autoreconf` phase. Thanks to [sternenseemann](https://github.com/sternenseemann) for raising the [issue](https://github.com/mikebrady/shairport-sync/issues/1705) and the [PR](https://github.com/mikebrady/shairport-sync/pull/1706) containing the fix. * Updated the mDNS strings for the Classic AirPlay feature of AP2, so that it does not appear to provide MFi authentication. Addresses [this discussion](https://github.com/mikebrady/shairport-sync/discussions/1691). * Always uses a revision number of 1 when looking for status updates on the DACP remote control port. This follows a suggestion in [Issue #1658](https://github.com/mikebrady/shairport-sync/issues/1658). Thanks to [ejurgensen](https://github.com/ejurgensen), as ever, for the report and the suggested fix. * Fixed a `statistics` bug (the minimum buffer size was incorrectly logged) and also tidy up the statistics logging interval logic for resetting min and max counters. * Added an important missing format string argument to a call in the Jack Audio backend. Many thanks to [michieldwitte](https://github.com/michieldwitte) for their [PR](https://github.com/mikebrady/shairport-sync/pull/1693). **Maintenance** * Stopped using a deprecated FFmpeg data structure reference. * Stopped using deprecated OpenSSL calls. Thanks to [yubiuser](https://github.com/yubiuser) for their [PR](https://github.com/mikebrady/shairport-sync/pull/1684) -- which did some of the updating -- and for their guidance. * Run workflow-based tests on PRs automatically. Thanks to [yubiuser](https://github.com/yubiuser) for their [PR](https://github.com/mikebrady/shairport-sync/pull/1687). Version 4.2 ==== This release consists of enhancements and a number of important bug fixes to Version 4.1. For information on the new features of 4.1, including AirPlay 2 support, please see the section "Version 4.1" below. If you are updating an existing installation of Shairport Sync, you must also update [NQPTP](https://github.com/mikebrady/nqptp). The reason is that this update to Shairport Sync requires NQPTP with Shared Memory Interface Version `smi9` and will not work with older versions. * The Shared Memory Interface Version `smi*` needed by Shairport Sync is part of its version string, obtainable using `$ shairport-sync -V`. * You can check the Shared Memory Interface Version of the installed version of `nqptp` using `$ nqptp -V`. **Enhancements** * Allow compilation with `libplist` version `2.3.0`. Thanks to [Markus Reiter](https://github.com/reitermarkus). * Update GitHub Action Workflows -- many thanks to [yubiuser](https://github.com/yubiuser). * Update MQTT documentation to correspond to updates in [Home Assistant](https://www.home-assistant.io/blog/2022/06/01/release-20226/#breaking-changes). Thanks to [hunhejj](https://github.com/hunhejj). * Update NQPTP communication to improve performance. Shairport Sync now passes activity information to NQPTP, enabling it to process timing data more accurately. **Docker Image Enhancements** * Add basic PulseAudio support. Thanks to [Ferdynand Naczynski](https://github.com/nipsufn) and thanks also to [Noel Hibbard](https://github.com/noelhibbard) for championing this idea for a long time. * Update to Alpine 3.17 and ensure services such as Avahi and D-Bus start in the correct order. Thanks to [yubiuser](https://github.com/yubiuser). **Bug Fixes** * Sometimes the AirPlay Device ID generated by Shairport Sync was all zeros, and so was invalid, causing connectivity problems. The cause of the problem was that `get_device_id` was not interpreting `getaddrinfo` information correctly. Thanks to [Carl Johnson](https://github.com/ridgelift) for [reporting](https://github.com/mikebrady/shairport-sync/issues/1657) the issue, finding the (rather obscure) cause of the problem and for providing [code](https://github.com/mikebrady/shairport-sync/issues/1657#issuecomment-1493423175) to fix it. * Fix a bug reported in Issue [#1633](https://github.com/mikebrady/shairport-sync/issues/1633). The bug was that when a Realtime Audio stream (e.g. playing from Spotify on iOS or using Shairport Sync as the Sound Output on a Mac) was played, it was fine, but when it was stopped and a second stream was started, the new stream could not be heard. The problem was that the PTP clock was not being correctly revalidated for second and subsequent Realtime Audio streams. The fix was to ensure that the PTP clock is revalidated on second and subsequent plays on the same connection. Thanks again to [David Leibovic](https://github.com/dasl-) for finding the problem. * Use TCP keepalive a little more generally -- treat it the same as a client closing the link rather than just an error. * Remove three potential race conditions between Shairport Sync opening a TCP connection and the client checking that the connections are open. The problem was that the connections were being opened in threads that were created just before the client was given the connection information. If the threads were delayed (e.g. on a slow or busy processor), the client could use the connection information to check the connections, but find that they were not (yet) open. This could cause the client to terminate the session immediately with a `TEARDOWN`. The fix was to open the connections before creating those threads and before sending the connection information back to the client. In this way, the connections are guaranteed to be open before the client has the information it needs to try to open them, even if the threads ared delayed in starting. This bug would manifest itself by allowing play to proceed but not play anything. * When built for AirPlay 2, ensure the hexadecimal string that prefixes the AirPlay 1 Service Name in the Bonjour text strings matches the AirPlay 2 Device ID. For example, if the Service Name is `Kitchen` and the AirPlay 2 Device ID is `b8:2f:eb:d7:85:df`, the AirPlay 1 Service Name should be `B82FEBD785DF@Kitchen`. (When built for AirPlay 1, the hexadecimal prefix is simply a hash of the Service Name.) Thanks to [Casper](https://github.com/casperghst42) for raising the [issue](https://github.com/owntone/owntone-server/issues/1578) and to [ejurgensen](https://github.com/ejurgensen) for identifying the cause of the problem. Version 4.1.1 ==== This release consists of enhancements and bug fixes to Version 4.1. For information on the new features of 4.1, including AirPlay 2 support, please see the section "Version 4.1" below. **Enhancement** * Use the TCP `keepalive` facility to close a play session if the client connection drops for a minute. **Metadata Enhancements** * Add `FramePosition` (`phbt`), `FirstFramePosition` (`phb0`), `OutputRate` (`ofps`), `OutputFormat` (`ofmt`), `StreamType` (`styp`), `ServiceName` (`svna`), `ClientName` (`snam`) properties to the D-Bus interface and to the metadata stream (codes in brackets). * `FramePosition`/`FirstFramePosition` metadata is generated only if the `progress_interval` in the `metadata` section of the configuration file is non-zero. The progress interval can also be set by a new `SetFramePositionUpdateInterval` method in the D-Bus interface. * `FramePosition`/`FirstFramePosition` metadata is of the form `/` where the local time, in nanoseconds (a 64-bit number), is the precise time that frame should be played. The metadata is generated when the frame is placed in the output buffer, and is thus generated `audio_backend_buffer_desired_length_in_seconds` (usually 0.2 seconds) before the time in question. * Add `xesam:albumArtist` and `xesam:composer` metadata (if available) to the metadata bundle presented in the D-Bus interface. * Add a new metadata item: `sps:songdatakind`, derived from the `asdk` metadata token, to the metadata bundle presented in the D-Bus interface. If `0` it seems to indicate an item of a specific duration such as an audio track; if `1` it seems to mean the stream is of unknown duration, for example an internet radio stream. **Docker Enhancements** * Launch the `shairport-sync` app as `root` user within the Docker container rather than as the user `shairport-sync`. * Add the configuration file and the sample configuration files back into the Docker image. **Bug Fixes** * Fix a bug that prevented multiple classic AirPlay instances being recognised. The bug was that the 12-digit classic AirPlay service name prefixes for each instance were all identically derived from a MAC hardware address. The fix was to modify the generation of prefixes to depend on the service name as well as the hardware address. * Fix a bug that prevented play to the the PulseAudio backend from resuming after a pause. The bug was due to changes in the way pauses were handled and the fix was to reopen the stream if it is closed whenever a play or latency request was made. * Fix a long-standing bug which didn't close the socket used for the RTSP connection, potentially exhausting the sockets available. * Fix a bug in `audio_alsa.c` when there is no hardware device name. * Add a configuration check for the `xxd` program when building for AirPlay 2. * Fix a compilation bug on certain platforms by trying to use `AC_CHECK_LIB` to find `libavcodec` if the `PKG_CHECK_MODULES` check fails. **Documentation** * Include and reference the HTML version of the man page. Version 4.1 ==== Really Big Update -- AirPlay 2! ---- Version 4.1 brings support for AirPlay 2 operation. It works with iOS, iPadOS, macOS, HomePod mini and Apple TV sources, but not with Windows. Limited support is available for HomeKit -- Shairport Sync speakers can be added to the Home app, though not all features are working. AirPlay 2 operation requires a companion program called NQPTP and requires a somewhat more powerful system. Please see [AIRPLAY2.md](./AIRPLAY.md) for more. Note that you can still build Shairport Sync to support "classic" AirPlay (aka "AirPlay 1") as before. The various guides for building and updating Shairport Sync have been consolidated into [BUILD.md](./BUILD.md). Here is a brief list of the high-level new features and changes (more to be added): * AirPlay 2 operation. * Improved `libao` backend for better compatibility with HomeBrew installations. * Improved MQTT and D-Bus facilities. * Automatically-generated Docker images. There have been many many bug fixes and enhancements to the core operation of Shairport Sync. Version 3.3.9 ==== **Bug Fix** * Version 3.3.9 fixes a build failure with convolution raised since `automake 1.16.5` and https://git.savannah.gnu.org/cgit/automake.git/commit/?id=f4a3a70f69e1dbccb6578f39ef47835098a04624. Further details in [Fabrice Fontaine's original PR](https://github.com/mikebrady/shairport-sync/pull/1314) to the `development` branch. Many thanks to [Fabrice Fontaine](https://github.com/ffontaine) for the bug report and for the fix. Version 3.3.8 ==== **Enhancements** * Documentation for the MQTT interface. Many thanks to [minix1234](https://github.com/minix1234)! **Bug Fixes** * Fix a bug in the `alsa` back end. In the interval between checking that the alsa device handle was non-`NULL` and actually using it, the handle could be set to `NULL`. The interval between check and usage is now protected. * Fix a bug in the `alsa` precision timing code. Thanks to [durwin99](https://github.com/durwin99), [Nicolas Da Mutten](https://github.com/cleverer), [mistakenideas](https://github.com/mistakenideas), [Ben Willmore](https://github.com/ben-willmore) and [giggywithit](https://github.com/giggywithit) for the [report](https://github.com/mikebrady/shairport-sync/issues/1158). * Fix a bug that caused Shairport Sync to hang, but not actually crash, if an `on-...` script failed. * Fix a crash that occurred if metadata support is enabled during compilation but turned off in the configuration file. Thanks to [Tim Curtis](https://github.com/moodeaudio) for the report. * Fix a crash that occurred playing from AirPower on Android. Thanks to [Ircama](https://github.com/Ircama) for the report. * Fix the configure.ac file so that `--without-` configuration options are not interpreted as `--with-` options instead! Thanks to [David Racine](https://github.com/bassdr) for the report. Version 3.3.7 ==== **Docker Integration** * Docker Hub integration. From now on, prebuilt Docker images should be available on the Docker Hub at https://hub.docker.com/r/mikebrady/shairport-sync. **New Feature** * For the PulseAudio backend `pa`, added a new `server` entry to the `pa` section of the configuration file, allowing you to specify a connection to a remote or a local system PulseAudio instance instead of letting PulseAudio choose. Thanks to [Guillaume Revaillot](https://github.com/grevaillot) for this new feature. **Pesky Changes** * The underlying timing system has been moved from 64-bit fixed-point time representation (like NTP) to a 64-bit unsigned nanoseconds representation. This should make precisely no difference to the functionality of Shairport Sync but the transition might inadvertently have introduced bugs. Problem reports gratefully received. **Bug Fixes** * Fixed a number of bugs that prevented Shairport Sync from terminating cleanly in response to the `MPRIS` interface's `Quit()` command. Thanks to [João Gabriel](https://github.com/jgabriel98) for reporting this issue. * Related to the above, the code used to terminate the application after a fatal error has been cleaned up. It now uses the correct `exit()` call rather than the rather hacky `abort()` call, returning the value of the constant `EXIT_FAILURE` (typically `1`) to the caller . * Fixed a bug whereby the start and end of active mode tokens `abeg` and `aend` where not generated or published -- `pend` tokens were being generated instead. Thanks to [minix1234](https://github.com/minix1234) for the bug report and [fix](https://github.com/mikebrady/shairport-sync/pull/1023). * Fixed a bug calculating the instantaneous synchronisation error. This bug could occasionally cause Shairport Sync to lose synchronisation and maybe even to mute for a few seconds before resynchronising. It was caused doing modulo arithmetic incorrectly and it's been there for a while. * Removed a bug which would affect initial synchronisation if a `FLUSH` command was received from the player at an inopportune time. * Added code to do calculations involving the `audio_backend_latency_offset_in_seconds` and `audio_backend_silent_lead_in_time` settings correctly. Many thanks to [Tucker Kern](https://github.com/mill1000) for discovering a number of bugs associated with this and for [proposing a solution](https://github.com/mikebrady/shairport-sync/pull/1001). This prompted a closer investigation and a number of further improvements were made, and a few "hostages to fortune" removed. * The DACP ID looks like a 64-bit number expressed in hexadecimal. It is normally quoted with leading zeroes removed, but in the `_dacp._tcp` service string, leading zeros are not removed from the DACP ID. The bug fix removes those leading zeroes. Thanks to [julianc1969](https://github.com/juliandc1969) for tracking down this bug so tenaciously! * Make the first output backend in the list of backends the default and make its name the default `output_name`. * Fix a flaw in resyncing -- a flush is set up but not triggered. * Ensure metadata and cover art are enabled if metadata support is included at compilation. * Set convolution defaults even if no configuration file is found. * Handle the `active_remote_id` token as a string rather than an unsigned 32-bit number -- it seems ROON uses a longer character sequence. **Enhancements** * Added the strings `-alac` and `-jack` to the the version string returned by the `-V` command line option if Apple ALAC decoder support and Jack Audio support are included respectively. * Cleaned up and simplified the code that handles `FLUSH` requests coming from the player. (Debug messages are still a little verbose.) * Improved timing estimation. Shairport Sync has been using linear least-squares regression to estimate timing drift between the (remote) source clock and the local clock. This technique is now extended to provide an estimate of the remote-to-local clock difference itself. (The remote-to-local clock difference is used to remap the timing of audio frames from the remote device's clock to the local clock.) Timing drift estimates are now saved when a sessions ends, keyed to the client IP number. When a new session starts from that IP number, the stored estimate is used until a new estimate can be generated from the new session. In practice, the timing techniques in use up to now have been very accurate, but this should result in slightly smoother rates of correction. * Tidied up the creation and initial opening of pipes. Suppress repeated pipe-opening error messages. * Tidied up warnings and fatal error messages when log verbosity is zero. * Cleaned up the code that provides a silent lead-in to play on a back end without synchronisation, e.g. a pipe or `stdout`. * Added in commented-out code to check the timeliness of the release of audio to a back end without synchronisation, e.g. a pipe or `stdout`. TL;DR – so long as the back end does not block, frames will be released to it not more than one packet (352 frames) late. * Logs and statistics can now be directed to the system log (default), `stdout`, `stderr` or to a file or pipe of your choice using a new setting, `log_output_to` in the `diagnostics` section of the configuration file. This is very useful when the system log is disabled or diverted. * Audio data from the `pipe` back end and metadata from the metadata pipe are now written using standard blocking `write` commands rather than a slightly complex non-blocking write function. Pipes are now opened in non-blocking mode and changed to blocking mode when successfully opened. * Add a default name for the pipe backend: `/tmp/shairport-sync-audio`. * Separate threads are now used for each metadata subsystem. Until now, all metadata was processed on a single thread. This included writing to the metadata pipe and the multicast stream and supplying metadata for the `mqtt` interface and for the `dbus` and `MPRIS` interfaces. Unfortunately, that meant that a problem with any one of these subsystems could propagate into the others. Now they all run on separate threads. If one thread blocks, it will not interfere with the other subsystems. * Cleaned up and improved the code to synchronise the first frame of audio. This should result in more accurate and reliable initial synchronisation, usually to under a millisecond, and often to within 20 or 30 microseconds. Syncronisation should improve even when the silent lead-in time is as short as 0.3 seconds or when the `audio_backend_latency_offset_in_seconds` is as much as -1.7 seconds, i.e. when only 0.3 seconds of latency are left when the latency would normally be 2.0 seconds. * Cleaned up some confused uses of modulo arithmetic. * Cleaned up the allocation of memory for gathering running statistics – the heap is now used instead of the stack. * Cleaned up the display of statistics for backends that do not implement active synchronisation, e.g. the `pipe` and `STDOUT` back ends. * Cleaned up the `audio_backend_silent_lead_in_time` setting by adding an `"auto"` setting. * Improved synchronisation accuracy with short silence lead-ins. * While a player is active, the DACP port number to which to send remote commands should be broadcast over ZEROCONF/Bonjour. However, if that information is not available, Shairport Sync will now check for it every two seconds. * The timing software in the `sndio` backend does some extra sanity checking on certain time estimates, it may help a little when running on virtual machines. * Open metadata and audio pipes with 666 permissions to allow them to be shared by other applications. Version 3.3.6 ==== **New Features** * Resampling has been added for the [Jack Audio](http://jackaudio.org) backend. This can be used to up-sample to 192kHz. Thanks to [Pieter De Gendt](https://github.com/pdgendt) for this addition. **Enhancements** * Add `SetAirplayVolume` to the native D-Bus `RemoteControl` interface. * Add `SetVolume` to the `MPRIS` interface. * Add a few sample commands, including `MPRIS` commands, to the [Sample D-Bus Commands](https://github.com/mikebrady/shairport-sync/blob/master/documents/sample%20dbus%20commands) document. **Bug Fixes** * Add a `SIGCHLD` handler to remove completed processes that were used to perform program "hooks" without waiting for completion and thus prevent them from becoming zombie processes. Thanks to [patrickjane](https://github.com/patrickjane) for reporting the bug and for suggesting a solution. Addresses issue [#968](https://github.com/mikebrady/shairport-sync/issues/968). * Fix a bug in the provision of metadata which would on occasion cause metadata from the previous track to be provided. Thanks to [Tuomas Hämäläinen](https://github.com/tuomashamalainen) and [HiFiBerry](https://github.com/hifiberry) for reporting. This bugfix addresses issue [#972](https://github.com/mikebrady/shairport-sync/issues/972). * Make Shairport Sync compile in the forthcoming Fedora 32. Fedora 32 uses GCC-10 which [defaults to `-fno-common`](https://gcc.gnu.org/gcc-10/porting_to.html) exposing a number of issues with Shairport Sync – multiple definitions of some `enum`s and failure to define certain variables as `extern`. Many thanks to [Bill Peck](https://github.com/p3ck) for bringing this issue to notice. Address issue [#973](https://github.com/mikebrady/shairport-sync/issues/973). * Treat the `mper` (Persistent ID of a track) metadata attribute as the 64-bit item that it really is rather than a 32-bit item as hithereto. Output it as a hexadecimal number on the MPRIS and D-Bus interfaces to correspond with the format of the persistent id obtained from AppleScript. Thanks to to Scott Simon (https://github.com/zutroy97) for finding a related bug in the [shairport-sync-metadata-reader](https://github.com/mikebrady/shairport-sync-metadata-reader). * Hook up the `Volume` property in the `MPRIS` interface. * Fix an incompatibilty with Forked Daapd that was causing Forked Daapd to lock up. Thanks to [@tomgadow](https://github.com/tomgadow) and [@ejurgensen](https://github.com/ejurgensen) for their help in finding and (hopefully) fixing this issue. Addresses issue [#953](https://github.com/mikebrady/shairport-sync/issues/953) and [Forked Daapd Issue #870](https://github.com/ejurgensen/forked-daapd/issues/870). * Other minor bug fixes. **Pesky Changes You Might Not Be Able To Ignore** * Renamed the `Server` property in the D-Bus interface to `Client`. The rather strange language in use has it that a player like iTunes is a "client" of the AirPlay device like Shairport Sync, which is therefore considered the "server". The newly-renamed "Client" property is the IP number of the player. Version 3.3.5 ==== **Bug Fixes** * Fix a crashing bug if output format `S24` was chosen. Thanks to [artenverho](https://github.com/artenverho) for reporting. Fixes Issue [#927](https://github.com/mikebrady/shairport-sync/issues/927). * Fix a bug whereby if `Loudness` was enabled through the D-Bus interface, the output would be muted until the volume was changed. **Enhancements** * D-Bus interface enhancements: add `Convolution`, `ConvolutionGain` and `ConvolutionImpulseResponseFile` properties to the D-Bus interface. These properties can be set and changed at any time, even while playing. Implements the suggestion in Issue [#929](https://github.com/mikebrady/shairport-sync/issues/929). Thanks to [corrpel](https://github.com/corrpel) for the suggestion. * Update the [sample dbus commands](https://github.com/mikebrady/shairport-sync/blob/master/documents/sample%20dbus%20commands) document. **Pesky Changes** * D-Bus interface change: the D-Bus `LoudnessFilterActive` property has been changed to `Loudness`. The sample D-Bus client has been updated accordingly. Version 3.3.4 ==== This is Version 3.3.3 with a small compilation error fixed. Version 3.3.3 ==== **Bug Fixes** * Fixes a deferred crash that occurred in Ubuntu 14.04: the `shairport-sync` daemon would silently die after a fairly long period. It typically happened just after a DHCP address was renewed. The problem seemed to be related to having more than one `avahi` threaded polling loop (though this isn't documented anywhere). The fix was to consolidate the `avahi` stuff down to one threaded polling loop. Addresses issue [#895](https://github.com/mikebrady/shairport-sync/issues/895). Thanks to [Hans (the) MCUdude](https://github.com/MCUdude) for reporting and for initial troubleshooting. * Fixes a potential crash when an incomplete `fmtp` parameter set is sent by the requesting client. Thanks to [Angus71](https://github.com/Angus71) for the fault report and for the repair. * Fixed a potential crash -- if a plain HTTP packet (in fact, any packet that didn't have an RTSP-style header) was sent to the TCP session port (usually port 5000), Shairport Sync would crash! Thanks to @[dubo-dubon-duponey](https://github.com/dubo-dubon-duponey) for reporting. Fixes [#921](https://github.com/mikebrady/shairport-sync/issues/921). * A fix ensures the hardware mixer of an `alsa` device is detected and initialised before responding to the first volume setting. * Fixes were made to the MPRIS and native D-Bus interfaces. In particular, situations where artwork is absent are better handled, and the remote interface and advanced remote interface `availability` properties should be more resilient in the face of network problems. Addresses issue [#890](https://github.com/mikebrady/shairport-sync/issues/890). Improvements were made to the detection of the remote services available when an audio source is playing. If the source is minimally compatible, e.g. iOS, Shairport Sync's `org.gnome.ShairportSync.RemoteControl` native `dbus` interface becomes "`available`". If the source is iTunes, then the `org.gnome.ShairportSync.AdvancedRemoteControl` interface also becomes `available`. Artwork, metadata, status and limited remote control facilities are accessible through these interfaces when they are in the `available` state. Thanks to [exoqrtx](https://github.com/exoqrtx) for bringing these issues to light and for testing. * Fixes an error whereby the `'pvol'`volume metadata was no longer sent if Shairport Sync was configured to ignore volume control information coming from the audio source. Addresses issue [#903](https://github.com/mikebrady/shairport-sync/issues/903). Thanks to [Jordan Bass](https://github.com/jorbas) for reporting the regression and for identifying the commit and code in which the regression occurred. **Enhancements** * Instead of returning `EXIT_FAILURE`, return `EXIT_WITH_SUCCESS` on early exit with either "version" (`–version` or `-V`) or "help" (`–help` or `-h`) arguments. Thanks to [Henrik Nilsson](https://github.com/henriknil) for the patch. * Normalises the `'pvol`' volume outputs so that when both the software and hardware attenuators are in use to extend the overall attenuation range, the maximum output level corresponds to the maximum output level of the hardware mixer. * Add the option of including the file and line number of each log entry's source. The option is on by default and is settable in the configuration file and in the `dbus` interface. * Rewrite the logic for identifying missing packets of audio and for asking for resends. It seems more robust -- there was a suspicion of the previous logic that resend requests were not made for some missing packets. In addition, requests for resends of continuous sequences of packets are rolled into one. * Expose the advanced settings controlling the resend request logic. The new settings are in the `general` section: * `resend_control_first_check_time` is the time allowed to elapse before a packet is considered missing, defaulting to 0.1 sec. UDP packets don't always arrive in order and they don't need to be re-requested just because they arrive out of sequence. Essentially, therefore, this parameter is to prevent needless resend requests for packets that are already in transit. * `resend_control_check_interval_time` is the interval between repeated requests for a missing packet, defaulting to 0.25 seconds. * `resend_control_last_check_time` is the time by which the last check should be done before the estimated time of a missing packet's transfer to the output buffer, defaulting to 0.1 seconds. In other words, if a packet is still missing 0.1 seconds before it is due to be transferred to the DAC's output buffer, don't bother asking for a resend. * Exposes two advanced `metadata` settings related to handling cover art: * The setting `cover_art_cache_directory` allows you to specify where cover art files will be cached if Shairport Sync has been built with native D-Bus, MPRIS or MQTT support. The default is `/tmp/shairport-sync/.cache/coverart`. If you set it to an empty list: `""`, caching is disabled. This might be useful in, say, an embedded device, or wherever you want to minimise file writing. * The setting `retain_cover_art` is part of the `diagnostics` group. Set it to `"yes"` to retain cover art cached by the D-Bus, MPRIS or `mqtt` interfaces. Your directory may fill up if you leave it set! Version 3.3.2 === **Bug Fixes** * Fix a bug that sometimes caused a crash when a service name was specified in the configuration file. The fix was to be more systematic in allocating and deallocating memory for temporary strings. Thanks to [Chris Boot](https://github.com/bootc), [Ari Sovijarvi](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=925577#5), [Bernhard Übelacker](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=925577#10) and [Jeroen Massar](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=925577#17) for the bug report. Fixes [Debian Bug report #925577]( https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=925577) and supercedes [Pull Request #879](https://github.com/mikebrady/shairport-sync/pull/879). * Correct some documentation typos – thanks again to [Chris Boot](https://github.com/bootc). **Enhancements** Add some settings for controlling the disable_standby_mode. * The first setting is the `disable_standby_mode_silence_threshold`, which is the amount of audio in the output device's hardware buffer. It should normally be close to the value given in the `audio_backend_buffer_desired_length_in_seconds` setting. If it drops to this value, silence is added to the buffer to prevent the output device from becoming idle. * The second new setting is the `disable_standby_mode_silence_scan_interval` which is the time between checks of the output device's hardware buffer. Version 3.3.1 === **Bug Fixes** * Fix a bug in the MQTT documentation and add sanity checking for the port chosen -- thanks to [David Crook](https://github.com/idcrook). * Fix a bug that caused manual format and rate setting to be ignored -- thanks to [Jörg Krause](https://github.com/joerg-krause). * Add missing support for format settings S24_LE, S24_BE, S32_LE and S32_BE. * Fix a bug that caused dither to be too loud. * Fix error message for invalid `disable_standby_mode` choice -- thanks to [Tim Curtis](https://github.com/moodeaudio) at [Moode Audio](https://moodeaudio.org). Version 3.3 ==== Version 3.3 is focused on stability improvements and also offers a number of enhancements. Here is a selection of the most important: **Enhancements** * Automatic `alsa` output device speed and format selection. The greatest bit depth and the lowest multiple of 44,100 frames per second settings are chosen automatically by default. Manual selection is still available. * Automatic interpolation selection. If the CPU is fast enough, the better-quality `soxr` interpolation method is chosen. Otherwise `basic` interpolation is used. Manual selection is still available. * A new `active` state. New hooks are provided to execute programs before entering and after leaving the `active` state which covers sequences of play sessions separated by short intervals. This simplifies amplifier switch-on and switch-off, for example. * DAC crackle minimisation. This new feature is intended to minimise pops and crackles caused in some Digital to Analog Converters (DACs) when they transition between active and idle or standby operation. The new `alsa`-only `disable_standby_mode` prevents the DAC entering the standby mode by keeping it active, either permanently or while Shairport Sync is in the active state. This feature is switched off by default. * A new backend to interface Shairport Sync to [Jack Audio](http://jackaudio.org), thanks to the work of [Jörn Nettingsmeier](https://github.com/nettings). * A new [MQTT](https://en.wikipedia.org/wiki/MQTT) client interface, thanks to the work of [Till Zimmermann](https://github.com/tillz). * Changes in logging -- now you should add `-u` to direct log entries to STDERR (typically the console) rather than the system log. For example, to get logs of verbosity 1 to appear on the console: `$ shairport-sync -v -u`. * The help menu now lists all `alsa` output devices found. * Better support for big-endian CPUs. * Shairport Sync accepts AirPlay streams containing CD-quality uncompressed PCM. **Bug Fixes** * Lots of bugs – too many to list here – have been fixed that significantly improve the stability of Shairport Sync. The full list is in the Release Notes. For more details of enhancements and bug fixes, please see the [Release Notes for 3.3](https://github.com/mikebrady/shairport-sync/releases/tag/3.3). Special thanks to [gibman](https://github.com/gibman). Version 3.2.2 ==== Please see the [Release Notes for 3.2](https://github.com/mikebrady/shairport-sync/releases/tag/3.2). **Enhancement** * Latency calculations have been updated to accommodate changes in iOS 12 and AirPlay connections from macOS Mojave. Thanks to [artenverho](https://github.com/artenverho) who first reported the issue. * Formatting of the settings file `shairport-sync.conf` has been fixed, thanks to the work of [roblan](https://github.com/roblan). **Bug Fix** * Fixed a problem that prevented the `run_this_when_volume_is_set` script or program from running when the volume control is changed. Thanks to [shaven](https://github.com/shaven) for the report. Version 3.2.1 ==== **Bug Fix** * Fix a bug that was causing problems when `soxr` interpolation was chosen. Problems included instability during or after a play session and possibly an extremely slight click on very loud audio. Thanks are due to [hanaguro](https://github.com/hanaguro), [FnasBas](https://github.com/FnasBas), [priitohlo](https://github.com/priitohlo), [David Krmpotić](https://github.com/davidhq) and [artenverho](https://github.com/artenverho). Version 3.2 ==== Version 3.2 is equivalent to 3.2RC13. Version 3.2RC13 ==== **Adjustment** * Reduce the number of attempts that will be made to have a missing packet resent. It seems that in some situations on poor networks, the number of resend requests was causing problems. Version 3.2RC12 ==== **Enhancement** * Add a "ProgressString" property to the native D-Bus interface. **Bug Fix** * Some code added in RC11 to monitor mutex lock times was causing some annoying issues -- fixed. Version 3.2RC11 ==== **Bug Fixes** * Restore compatibility with Synology AudioStation/5.2. Thanks to [Jörg Krause](https://github.com/joerg-krause) for identifying both the issue itself and the likely location of the fix needed. It's not clear if the problem lies with Shairport Sync or Synology – the fix was to ensure that an RTSP reply was sent in one `SEND` call, which shouldn't be important. * Fix a bug that was causing Shairport Sync to hang very occasionally when a play session was ending. This seems to occur under rare circumstances, therefore many thanks to [David Krmpotić](https://github.com/davidhq) both for finding the problem and for his patience in trying out different theories before the bug was finally identified. More long-term work is probably needed here. Version 3.2RC10 ==== **Compatibility Adjustment** * Disable the use of all hardware mute mechanisms by default, for compatibility with other applications using the same output card. * Rename the `alsa` setting `mute_using_playback_switch` to `use_hardware_mute_if_available` and make it control volume-based mute as well as playback-switch-based mute. Version 3.2RC9 ==== **Bug Fix** * Restore the correct pathname for the Shairport Sync PID file used in FreeBSD and System V Linux installations. Version 3.2RC8 ==== **Bug Fixes** * Fix a bug causing a play session to hang up on Cygwin 64. Fix a bug that might cause excessive resend requests. Fix a number of other (apparently) silent bugs. Version 3.2RC7 ==== **Bug Fixes** * A very subtle bug that would occasionally cause a loud 80 millisecond buzz when a new track was selected has been located and fixed. Thanks to [mistipen](https://github.com/mistepien) and [artenverho](https://github.com/artenverho) for help with this. Version 3.2RC6 ==== **Bug Fixes** * Restores audio sync with videos on older versions of iOS (prior to iOS 11.2) and macOS by restoring the old way of determining latency for clients identifying with AirPlay user agent strings having a version of 353 (iOS 11.1.2) or earlier. Thanks to [Mmoi-Fr](https://github.com/Mmoi-Fr) for help with this. Version 3.2RC5 ==== **Bug Fixes** * When errors occur sending resend requests, back off for 0.5 seconds, rather than 10 seconds, and make the code actually work. * Make the configuration options for including the dbus interface and the mpris interface be `--with-dbus-interface` and `--with-mpris-interface` as expected, not `--with-dbus` and `--with-mpris` as they actually were. Version 3.2RC4 ==== **Bug Fixes** * 3.2RC4 now sends resend requests (correctly) in the control channel rather than (incorrectly) over the audio channel as before. This makes it compatible with AirAudio and also makes it conform to the [Unofficial AirPlay Protocol Specification](https://nto.github.io/AirPlay.html). This bug went unnoticed for so long because other AirPlay sources accept resend requests in the audio channel. Thanks to [funtax](https://github.com/funtax) and to [Janusz Kowalczyk](https://github.com/kowalcj0) for bringing the issue to the fore. Version 3.2RC3 ==== **Enhancements** * Lost UDP packet resending code improved for better performance on busy or congested networks. **Bug Fixes** * 3.2RC3 removes fixes some important and long-standing bugs that could make Shairport Sync less resilient on noisy or poor quality networks. Version 3.2RC2 ==== **Bug Fixes** * 3.2RC2 makes Shairport Sync work with AirAudio, removing a crashing bug, and includes some more debugging code. Version 3.2RC1 ==== **Enhancements** * Shairport Sync now offers an IPC interface via D-Bus. It provides an incomplete but functional MPRIS interface and also provides a native Shairport Sync interface. Both provide some metadata and some remote control. The native D-Bus interface permits remote control of the current AirPlay or iTunes client. It includes status information about whether the remote control connection is viable or not, i.e. whether it can still be used to control the client. A remote control connection to the audio client becomes valid when the client starts AirPlaying to Shairport Sync. The connections remains valid until the audio source deselects Shairport Sync for AirPlay, or until the client disappears, or until another client starts AirPlaying to Shairport Sync. After 15 minutes of inactivity, the remote control connection will be dropped. * OpenBSD compatibility. Shairport Sync now compiles on OpenBSD -- please consult the OpenBSD note for details. * A new `general` option `volume_control_profile`, for advanced use only, with two options: `"standard"` which uses the standard volume control profile -- this has a higher transfer profile at low volumes and a lower transfer profile at high volumes -- or `"flat"` which uses a uniform transfer profile to linearly scale the output mixer's dB according to the AirPlay volume. * Some DACs have a feature that the lowest permissible "attenuation" value that the built-in hardware mixer can be set to is not an attenuation value at all – it is in fact a command to mute the output completely. Shairport Sync has always checked for this feature, basically in order to ignore it when getting the true range of attenuation values offered by the mixer. However, with this enhancement, Shairport Sync can actually use this feature to mute the output where appropriate. * Added compatibility with [Swinsian](https://swinsian.com), a Mac music player. **Bug Fixes** * Better AirPlay synchronisation. Older versions of Shairport Sync added an 11,025 frame (0.25 seconds) offset to all the latencies negotiated with the sender. This seems now incorrect for AirPlay sources. Accordingly, the logic Shairport Sync uses to determine the extra delay has been revised. The result is better sync with videos, e.g, YouTube, while iTunes and ForkedDaapd synchronisation is unaffected. * Much faster termination of a play session, leading to increased stability playing YouTube audio, etc. * Improved resynchronisation logic should improve performance with slow-to-download YouTube videos. * Dithering is now off when ignore_volume_control is true. Thanks to [yejun](https://github.com/yejun) for working on this. * Better compatibility with TuneBlade -- Shairport Sync honours the latency settings properly now. * Fix timing error when using Airfoil as a source. * Better handling of missing timing packets. * Shairport Sync will now log an unexpectedy dropped or faulty RTSP connection. This might be useful on noisy networks. * Better volume level continuity. In recent versions of iOS (11.2) and mac OS (10.13.2), when play is resumed after a pause, the volume level is not always restored, and, if software volume control is being used, Shairport Sync plays at full volume. This issue has been addressed by storing the last airplay volume setting when a play session ends and using it as a default when a new play session begins. * Better mixer compatibility. A bug in the hardware volume control affected output devices that have hardware mixers but that do not allow the volume to be set in dB. One example is the Softvol plugin in ALSA. Shairport Sync failed silently when presented with such a device when hardware volume control is enabled: the volume events have no effect. The bug has been fixed by adding two missing lines of code to the `init()` function in `audio_alsa.c`. Thanks to [Jakub Nabaglo](https://github.com/nbgl) for finding and fixing the bug. * A number of bug fixes due to [belboj](https://github.com/belboj). Many thanks for these! * Enhancements to the handling of quit requests by threads, thanks(again) to [belboj](https://github.com/belboj)! **Other Changes** * `clip` and `svip` metadata messages are now only generated for a play connection, not for all connections (e.g. connections that just enquire if the service is present). * `pfls` and `prsm` metadata messages are less frequent, especially when a play session starts. * Shairport Sync now uses about an extra half megabyte of RAM for compatibility with TuneBlade's option to have a very long latency -- up to five seconds. * Only ask for missing packets to be resent once, and if any error occurs making the request, stop for 10 seconds. * Include the `-pthread` flag -- including the pthread library with `-lpthread` isn't always enough. * Add optional timing annotations to debug messages -- see the new settings in the diagnostic stanza of the configuration file. **Updated Documentation** * CAR INSTALL and OPENBSD notes added. * Improvements in the documentation relating to scripts -- thanks to [Niklas Janz](https://github.com/Alphakilo). * Typo fix! Thanks to [corbinsantin](https://github.com/corbinsantin). Version 3.1.7 ==== * Stable 3.1.5 and 3.1.6 skipped to synchronise the shairport-sync.spec file contents with the release. **Enhancement** * The metadata output stream can include a `dapo` message carrying the DACP port number to be used when communicating with the DACP remote control. This might be useful because the port number is actually pretty hard to find and requires the use of asynchronous mdns operations. You must be using the Avahi mdns back end. Version 3.1.4 ==== **Security Update** * The version of `tinysvcmdns` bundled in Shairport Sync has a buffer overflow bug: *"An exploitable heap overflow vulnerability exists in the tinysvcmdns library version 2016-07-18. A specially crafted packet can make the library overwrite an arbitrary amount of data on the heap with attacker controlled values. An attacker needs send a dns packet to trigger this vulnerability."* The vulnerability is addressed by additional checking on packet sizes. See also [CVE-2017-12087](https://bugs.launchpad.net/bugs/cve/2017-12087) and [Vulnerability in tinysvcmdns](https://bugs.launchpad.net/ubuntu/+source/shairport-sync/+bug/1729668). Thanks and [Chris Boot](https://github.com/bootc) for fixing this bug. **Enhancement** * The metadata output stream can include a `dapo` message carrying the DACP port number to be used when communicating with the DACP remote control. This might be useful because the port number is actually pretty hard to find and requires the use of asynchronous mdns operations. You must be using the Avahi mdns back end. **Bug Fix** * Somewhere in version 3.x, the `softvol` plugin got broken as the volume change is not applied anymore. Turned out that, for the `softvol` plugin, no `volume()` and `parameters()` are defined. Thanks to [Jörg Krause](https://github.com/joerg-krause) for locating and fixing this bug. Version 3.1.3 ==== **Bug Fixes** * Fixed a bug that prevented Shairport Sync from starting automatically on systems using the System V startup system (e.g. Ubuntu 14.04). The problem was that the directory to be used – `/var/run/shairport-sync/` – was deleted on power down and needed to be recreated on startup. In it's absence, Shairport Sync would not start and would report a mysterious daemon error \#2. Version 3.1.2 ==== Shairport Sync is more stable playing audio from YouTube and SoundCloud on the Mac. **Pesky Changes You Should Not Ignore** * When you update from a previous version of Shairport Sync, your output device may have been left in a muted state. You should use a command line tool like `alsamixer` or `amixer` to unmute the output device before further use. **Change of Default** * The default value for the `alsa` setting `mute_using_playback_switch` has been changed to `"no"` for compatibility with other audio players on the same machine. The reason is that when this setting is set to `"yes"`, the output device will be muted when Shairport Sync releases it. Unfortunately, other audio players using the output device expect it to be unmuted, causing problems. Thanks to [Tim Curtis](https://github.com/moodeaudio) at [Moode Audio](http://moodeaudio.org) and [Peter Pablo](https://github.com/PeterPablo) for clarifying the issue. **Bug Fixes** * Fixed bugs that made Shairport Sync drop out or become unavailable when playing YouTube videos, SoundCloud streams etc. from the Mac. Background: there has been a persistent problem with Shairport Sync becoming unavailable after playing, say, a YouTube clip in a browser on the Mac. Shairport Sync 3.1.2 incorporates a change to how certain AirPlay messages are handled. Introduced in nascent form in 3.1.1, further follow-on changes have improved the handling of player lock and have simplified and improved the handling of unexpected loss of connection. Shairport Sync also now works properly with SoundCloud clips played in a browser on the Mac. * Using [infer](https://github.com/facebook/infer/blob/master/README.md), a number of silent issues have been detected, such as not checking some calls to `malloc` to ensure the response is not NULL. Most of these have been addressed by additional checks. Version 3.1.1 ==== **Bug Fixes** * A bug in the `sndio` backend has been fixed that caused problems on some versions of Linux. * A change has been made to how Shairport Sync responds to a `TEARDOWN` request, which should make it respond better to sequences of rapid termination and restarting of play sessions. This can happen, for example, playing YouTube videos in Safari or Chrome on a Mac. * Choosing `soxr` interpolation in the configuration file will now cause Shairport Sync to terminate with a message if Shairport Sync has not been compiled with SoX support. * Other small changes. Version 3.1 ==== Version 3.1 brings two new backends, optional loudness and convolution filters, improvements in non-synchronised backends, enhancements, stability improvements and bug fixes. **New Features** * A `sndio` backend gives Shairport Sync native fully synchronised output on OpenBSD and FreeBSD, thanks to the work of [Tobias Kortkamp (t6)](https://github.com/t6). * A `pa` backend now allows Shairport Sync to provide synchronised output on PulseAudio-equipped systems -- many desktop Linuxes use PulseAudio as their sound manager. * Optional loudness and convolution filters can be incorporated in the audio processing chain, thanks to the fantastic work of [yannpom](https://github.com/yannpom). * A volume-change program hook `run_this_when_volume_is_set` has been added to the `general` settings stanza to execute an application whenever the volume is changed. **Pesky Changes You Should Know About** * The `audio_backend_buffer_desired_length_in_seconds` and `audio_backend_latency_offset_in_seconds` settings have been moved from individual backend stanzas to the `general` stanza. They now have an effect on every type of backend. * If you are using a System V (aka `systemv`) installation, please note that the default location for PID file has moved -- it is now stored at `/var/run/shairport-sync/shairport-sync.pid`. This change is needed to improve security a little and to improve compatibility across platforms. If you're not doing anything strange, this should make no difference. **Enhancements** * Resynchronisation, which happens when the synchronisation is incorrect by more than 50 ms by default, should be a lot less intrusive when it occurs – it should now either insert silence or skip frames, as appropriate. * The Linux installer has been improved and simplified and a FreeBSD installer introduced. * A new setting, `audio_backend_silent_lead_in_time`, allows you to set the duration of the period of silence played (the "silent lead-in") before a play session starts. * A new command-line option, `--logOutputLevel`, allows you to output the volume levels to the log whenever they are changed. This may be useful during setup. * Improvements have been made to the handling of large items of metadata over UDP. * A new command line option, `-j`, demonizes Shairport Sync without creating a PID file. * A new `alsa`-only setting, `mute_using_playback_switch`, is available for advanced use. * Other minor enhancements. **Bug Fixes** * Stability improvements. More care has been taken (!) to make code thread-safe, resulting in improved stability. * Conversion from stereo to mono has been fixed to avoid clipping while preserving full resolution. Thanks to [Robert Jones (RobDeBagel)](https://github.com/RobDeBagel) for bringing this to notice. * Short intrusions of audio at the start of a new session from the end of the previous session have been eliminated. * Many (many!) miscellaneous bugs fixed. Version 3.0.2 ==== **Bug Fixes** * Fixed bugs in the `ao`, `pulseaudio` and `sndio` back ends. Basically they were expecting default sample rate and depth information, and were terminating when they saw explicit rate and depth data. Version 3.0.1 ==== This update fixes one alarming and potentially very noisy bug and restores the identification of Shairport Sync as "ShairportSync" so that TuneBlade recognises it as an open source application. **Bug Fixes** * Fixed a bug that was causing Shairport Sync to possibly make a very loud and alarming noise whenever an audio frame was missing. * In 2.8.6, a change was made to the way Shairport Sync identified itself, so that it could be recognised by TuneBlade as an open source application and treated preferentially. That change was inadventently lost in the transition from 2.8.6 to 3.0. Now it's restored. Version 3.0 ==== Big Update ---- Version 3 brings in support for 24-bit and 32-bit (and 8 bit!) DACs and for DACs running at multiples of 44,100 samples per second. The most obvious audible change is if you are using software volume control and can take advantage of 32- or 24-bit DACs. Dithering can now occur on a 32-bit or 24-bit sample rather than on a 16-bit sample, making the noise floor very much lower. This is the case, for example, with a Pimoroni PHAT DAC. Here is the list of new features: **New Features** * 8-bit, 16-bit, 24-bit, 24-bit three-byte (S24_3LE and S24_3BE) and 32-bit output to ALSA devices. * 44,100, 88,200, 176,400 and 352,800 sample per second output. This is done using simple upsampling. It's only worth doing if 44,100 samples per second output is not available. * Internal processing including software volume control and interpolation is done after sample size and rate conversion. * Apple ALAC decoder support. This needs the `libalac` library, available at [ALAC](https://github.com/mikebrady/alac), to be installed. Add the flag `--with-apple-alac` to the `./configure` arguments. Then you can choose the Apple ALAC decoder in the configuration file. * Support for `mbed TLS` has been added and the use of `PolarSSL` is deprecated, as `mbed TLS` is a development of `PolarSSL` and `PolarSSL` itself is not being developed further. * Choose Network Interface. Add a new setting, for advanced users only, in the `general` section. Use the `interface` setting to allow you to specify the interface on which to provide the AirPlay service. Omit the setting to get the default, which is to choose the interfaces automatically. * Set Max Volume. Add a new setting, for advanced users only, in the `general` section. Use the `volume_max_db` setting to allow you to specify the maximum level to set on the hardware mixer (if chosen) or the built-in software mixer otherwise. The software mixer's range is 0.0 dB to -96.1 dB. The setting must be a number with a decimal point, e.g. 21.3. * An experimental new back end for `libsoundio`, a C library for cross-platform real-time audio input and output. Many thanks to [Serg Podtynnyi](https://github.com/shtirlic). Please see https://github.com/mikebrady/shairport-sync/pull/433 for more details. Pesky Changes You Cannot Ignore ---- * Processor load is up by about 11%. * Settings have changed -- basically, any timings that were denominated in frames are now in seconds. Please refer to the shairport-sync.conf.sample file for details. * Sox-based interpolation at higher sample rates may overload your CPU -- you might have to choose between higher sample rates and sox-based interpolation. Version 3.0rc0 – Release Candidate 0 ---- Note: all Version 3 changes are summarized above. **New Feature** * An experimental new back end for `libsoundio`, a C library for cross-platform real-time audio input and output. Many thanks to [Serg Podtynnyi](https://github.com/shtirlic). Please see https://github.com/mikebrady/shairport-sync/pull/433 for more details. **Other changes** * Updates to `man` page and [README](README.md). Reports of typos or suggestions for improvement are welcome! Version 3.0d24 – Development Version ---- Note: all Version 3 changes are summarized above. **New Feature** * Set Max Volume. Add a new setting, for advanced users only, in the `general` section. Use the `volume_max_db` setting to allow you to specify the maximum level to set on the hardware mixer (if chosen) or the built-in software mixer otherwise. The software mixer's range is 0.0 dB to -96.1 dB. The setting must be a number with a decimal point, e.g. 21.3. Version 3.0d23 – Development Version ---- Note: all Version 3 changes are summarized above. **New Feature** * Choose Interface. Add a new setting, for advanced users only, in the `general` section. Use the `interface` setting to allow you to specify the interface on which to provide the AirPlay service. Omit the setting to get the default, which is to choose the interfaces automatically. Version 3.0d22 – Development Version ---- Note: all Version 3 changes are summarized above. **Bug Fix** * Fixed a bug which prevented successful building in the OpenWrt build system. The problem was caused by an `#include apple_alac.h` in `player.c` which was actioned even if the apple alac decoder was not selected. This caused the OpenWrt build system to expect the standard C++ library – required by the apple alac code – to be referenced, but it was not specified on the build manifest and therefore stopped the build. The solution was to make the `#include` conditional on selecting the apple alac decoder. Version 3.0d21 – Development Version ---- Note: all Version 3 changes are summarized above. **Bug Fix** * Fixed a bug which turned off resync by default. Duh. Version 3.0d20 – Development Version ---- Note: all Version 3 changes are summarized above. **Bug Fix** * Fix a small and generally silent error in configure.ac so that it only looks for the systemd directory if systemd has been chosen. It caused a warning when cross-compiling. Version 3.0d19 – Development Version ---- Note: all Version 3 changes are summarized above. **New Feature** * Reduces processor load back to V2.X levels by using a precalculated array of pseudorandom numbers to do dithering. Doesn't seem to make any audible difference. Version 3.0d18 – Development Version ---- Note: all Version 3 changes are summarized above. **New Features** * 8-bit, 16-bit, 24-bit, 24-bit three-byte (S24_3LE and S24_3BE) and 32-bit output to ALSA devices. (Other back ends are not updated yet.) * 44,100, 88,200, 176,400 and 352,800 sample per second output. This is done using simple upsampling. * Internal processing including software volume control and interpolation is done after sample size and rate conversion. * Apple ALAC decoder support. This needs the `libalac` library, available at [ALAC](https://github.com/mikebrady/alac). Add the flag `--with-apple-alac` to the `./configure` arguments. Then you can choose the Apple ALAC decoder in the configuration file. * Support for `mbed TLS` has been added and the use of `PolarSSL` is deprecated, as `mbed TLS` is a development of `PolarSSL` and `PolarSSL` itself is not being developed further. * Settings that were denominated in frames are now deprecated but still honoured. Deprecation warnings are issued. Pesky Changes You Cannot Ignore ==== * Settings have changed -- basically, any timings that were denominated in frames are now in seconds. Please refer to the shairport-sync.conf.sample file for details. * Sox-based interpolation at higher sample rates may overload your CPU -- yopu might have to choose between higher sample rates and sox-based interpolation. **Bugs** * Documentation is not updated. Version 2.8.6 – Stable Candidate ---- **Enhancements** * This release contains a small change – it identifies itself as a ShairportSync device rather than an AirPort device. This should make it possible for Tuneblade, and possibly other players, to recognise it correctly. Version 2.8.5 – Stable Version ---- This release includes bug fixes and minor enhancements and is recommended for all users. Note: if you're upgrading, there is a new `./configure` option: ==== The build process now uses the directory path `sysconfdir` to determine where to place the configuration file `shairport-sync.conf`. The default value for `sysconfdir` is `/usr/local/etc` which is used in the BSD family, whereas `/etc` is normally used in Linux. To retain the present behaviour of Shairport Sync, *you must add an extra parameter to the `./configure... ` command.* The parameter you must add is `--sysconfdir=/etc`. (This has been added to the sample configuration command line in README.md.) The enhancements and bug fixes in 2.8.5 were made in versions 2.8.4.1 to 2.8.4.8 inclusive. Please read below for the full list. Version 2.8.4.8 – Development Version ---- **Enhancements** * Add a new metadata item `clip` (for `CL`ient `IP`). This item is a string comprising the IP number of the "client", and is sent when a play session is starting. The "client" is the sender of the audio stream, e.g. iTunes on a Mac, or the Music player in iOS. * When synchronisation has been disabled on the ALSA device (you should only do this for testing), Shairport Sync now refrains from asking for buffer length information from the device. Version 2.8.4.7 – Development Version ---- * This update means the build process now uses the directory path `sysconfdir` to determine where to place the configuration file `shairport-sync.conf`. The default value for `sysconfdir` is `/usr/local/etc` which is used in the BSD family, whereas `/etc` is normally used in Linux. So, to retain the present behaviour of Shairport Sync, you must add an extra parameter to the `./configure... ` command. The parameter you must add is `--sysconfdir=/etc`. (This has been added to the sample configuration command line in README.md.) * Shairport Sync has been updated to use the value of `sysconfdir` to determine where to look for the configuration file. If `sysconfdir` has been left with its default value of `/usr/local/etc`, then Shairport Sync will look for `/usr/local/etc/shairport-sync.conf`. If, as recommended for Linux, `sysconfdir` has been set to `/etc`, then Shairport Sync will look, as before, for `/etc/shairport-sync.conf`. **Enhancement** * The version string output when you use the command-line option `-V` now includes the value of the `sysconfdir`, e.g. `2.8.4.7-OpenSSL-Avahi-ALSA-soxr-sysconfdir:/etc`. Version 2.8.4.6 – Development Version ---- **Enhancement** * Add a new `alsa` configuration setting: `use_mmap_if_available` to control the use of mmap. The default is `"yes"` -- see [#351](https://github.com/mikebrady/shairport-sync/issues/351). Version 2.8.4.5 – Development Version ---- **Enhancement** * Handle varying packet lengths -- this makes it compatible with the HTC Connect, HTCs AirPlay implementation. Thanks to [Jörg Krause](https://github.com/joerg-krause) for his detective work, and see [#338](https://github.com/mikebrady/shairport-sync/issues/338). Version 2.8.4.4 – Development Version ---- **Enhancement** * Use alsa direct access (mmap) feature to improve performance if mmap is supported. Thanks to [Yihui Xiong](https://github.com/xiongyihui). Version 2.8.4.3 – Development Version ---- **Bug Fix** * Set the RTSP socket to close on `exec()` of child processes; otherwise, background `run_this_before_play_begins` or `run_this_after_play_ends` commands that are sleeping prevent the daemon from being restarted because the listening RTSP port is still in use. Fixes [#329](https://github.com/mikebrady/shairport-sync/issues/329). Version 2.8.4.2 – Development Version ---- **Bug Fixes** * Fixed an issue where you could not compile the audio_pipe back end without enabling metadata support (thanks to [busa-projects](https://github.com/busa-projects) for reporting the issue). * Fixed a few small issues causing compiler warnings in `mdns_dns_sd.c`. **Other** * Removed the INSTALL file – it's generated automatically by `autoreconf -fi` anyway – added it to the files to be ignored in `.gitignore` and added a simple `INSTALL.md` file. Version 2.8.4.1 – Development Version ---- **Bug Fixes** * Fixed two issues when including support for `pulseaudio`. * Corrected two small errors in sample parameters for the UDP metadata stream settings, thanks to [rkam](https://github.com/rkam). Version 2.8.4 – Stable Version ---- The following is a summary of the bug fixes and enhancements since version 2.8.3. **Bug Fixes** * Checks have been added for empty or NULL audio buffers that were causing assertion violations and subsequent abnormal program termination. * An IPv6 bug has been fixed — a bug in the networking software would not allow an IPv6 link-local connection to be made from a client if Shairport Sync was running on a device with more than one network interface. The solution was to take account of the `config_id` information. * Some problems have been fixed with the non-blocking write function used to write metadata. * A bug in the volume control transfer function has been fixed, thanks to [Jörg Krause](https://github.com/joerg-krause). **Enhancements** * Shairport Sync now works with [AllConnect/Streambels](http://allconnectapp.com) on Android with password protection. (As with all Android clients, you should set the `drift` to something large, like 500 or 1,000, as the timekeeping of these clients isn't as accurate as that of iTunes, etc.) * The networking subsystem has been modified to always use the same IP number during a session. Background: the computer Shairport Sync is running on can have many IP numbers active at the same time – various IPv6 numbers and also various IPv4 numbers. During a play session, when Shairport Sync has to create connections back to the source, it would use an automatically-assigned IP number for itself, but that number might not be same as the the number used earlier in the session. From now on, it will always use the same IP number it used when the connection was first established. Thanks to [ejurgensen](https://github.com/ejurgensen) for help with this. * Experimental support has been added for a softvol plugin, thanks to the work of [Jörg Krause](https://github.com/joerg-krause) -- see [#293](https://github.com/mikebrady/shairport-sync/pull/293). * A `playback_mode` setting has been added to allow the selection of `stereo` (default) or `mono` playback -- thanks to [faceless2](https://github.com/faceless2). * The new default service name is now the device's `hostname`, with its first character capitalised (ASCII only). * Substitutions can now be made in the service name. The following substitutions can be used in the service name: `%h` for the `hostname`, `%H` for the `hostname` with the first letter capitalised, `%v` for the version number and `%V` for the full version string. Maximum length is 50 characters. * An existing `shairport-sync.service` file will not be overwritten by `sudo make install`. * The text strings advertising the capabilities of Shairport Sync over Bonjour/Zeroconf/Avahi have been changed and now more closely match those of an AirPort Express Base Station (First Generation). * It is now possible to set the amount of time to wait for the metadata pipe to become ready for writing. The setting is called `pipe_timeout` in the `metadata` section. Default is 5,000 milliseconds. * Metadata can now be provided via UDP -- thanks to [faceless2](https://github.com/faceless2). * Statistics output is more machine readable -- thanks to [Jörg Krause](https://github.com/joerg-krause) * The `shairport-sync.spec` file has been updated for compatibility with building Debian packages using `checkinstall` -- thanks to [vru1](https://github.com/vru1). Version 2.8.3.11 – Development Version ---- **Bug Fix** Fixed some problems with the non-blocking write function used to write to the metadata pipe. **Enhancement** It is now possible to set the amount of time to wait for the metadata pipe to become ready for writing. The setting is called `pipe_timeout` in the `metadata` section. Default is 5,000 milliseconds. Version 2.8.3.10 – Development Version ---- **Bug Fix** * Restored metadata feed lost in 2.8.3.7. Version 2.8.3.9 – Development Version ---- **Enhancements** * Substitutions can now be made in the service name, i.e. the name that appears in iTunes, etc. The following substitutions can be used in the service name you specify: `%h` for the hostname, `%H` for the hostname with the first letter capitalised, `%v` for the version number and `%V` for the full version string. Maximum length is 50 characters. * The new default service name is simply the hostname, with its first character capitalised. * An existing `shairport-sync.service` file will not be overwritten by `sudo make install`. Version 2.8.3.7 – Development Version ---- **Enhancements** * Shairport Sync now works with AllConnect/Streambels on Android with password protection. (As with all Android clients, you should set the `drift` to something large, like 500 or 1,000, as the timekeeping of these clients isn't as accurate as that of iTunes, etc.) * The text strings advertising the capabilities of Shairport Sync over Bonjour/Zeroconf/Avahi have been changed and now more closely match those of an AirPort Express Base Station (First Generation). Version 2.8.3.6 – Development Version ---- **Bug fix** An IPv6 link-local connection issue was fixed. A bug in the networking software would not allow an IPv6 link-local connection to be made from a client if Shairport Sync was running on a device with more than one network interface. The solution was to take account of the `config_id` information. Version 2.8.3.5 – Development Version ---- **Enhancement** Experimental support for a softvol plugin, thanks to the work of [Jörg Krause](https://github.com/joerg-krause) -- see [#293](https://github.com/mikebrady/shairport-sync/pull/293). **Bug fix** Add checks for empty or NULL audio buffers that seem to be causing assertion violations and subsequent abnormal program termination. Version 2.8.3.4 – Development Version ---- **Bug Fix** The networking subsystem has been modified to always use the same IP number during a session. Background: the computer Shairport Sync is running on can have many IP numbers active at the same time – various IPv6 numbers and also various IPv4 numbers. During a play session, when Shairport Sync has to create connections back to the source, it would use an automatically-assigned IP number for itself, but that number might not be same as the the number used earlier in the session. From now on, it will always use the same IP number it used when the connection was first established. Thanks to [ejurgensen](https://github.com/ejurgensen) for help with this. Changed the `mono` setting for a `playback_mode` setting with two possible values: `stereo` (default) and `mono`. Version 2.8.3.3 – Deleted ---- Version 2.8.3.2 – Deleted ---- Version 2.8.3.1 – Development Version ---- Added a new `mono` setting -- thanks to [faceless2](https://github.com/faceless2). Documentation to follow. Version 2.8.3 – Stable Version ---- A bug in 2.8.2 caused Avahi to fail at startup under some circumstances with older installations. The problem was that sometimes the `regtype` setting would not be initialised properly. Version 2.8.2 – Stable Version ---- Version 2.8.2 is derived from development version 2.9.5.7 and has stability improvements, bug fixes and a few special-purpose enhancements. For full details, please refer to the release notes here, back as far as 2.8.1. Version 2.9.5.7 – Development Version ---- Version 2.9.5.7 contains general bug fixes and enhancements for some special situations. **Bug Fixes** * Getting delay and latency information from the `alsa` subsystem has been improved -- bugs fixed, error codes handled better, arithmetic handling (hopefully) better. * If latency information is temporarily unavailable from the `alsa` subsystem, skip trying to synchronise until the next time. * Some condition variables and a mutex were uninitialised, yikes! Fixed. * A bug that set the output volume to maximum at the same time as muting the output has been fixed. AFAIK, this was inaudible, but it was scary looking. * Recover from name collisions in Avahi. * Detect and handle empty buffers better. **Enhancements** * Turn off synchronisation. This is an advanced feature and generally leads to buffer underrun or overrun. * Set `alsa` buffer size and `alsa` period size. There are advanced features, mainly for debugging. They may be removed. * Change the Zeroconf/Bonjour `regtype` to enable Shairport Sync to continue to run but to be invisible to AirPlay clients. Special purpose usage only. * Output total number of packets and the play time of a session when statistics are enabled. Version 2.9.4 – Development Version ---- Version 2.9.4 corrects some bugs in how Avahi error conditions are handled. **Bug Fix** * During operation, if the network disappeared, Avahi would occasionally report an error. This would cause Shairport Sync to attempt to terminate gracefully (which is the wrong thing to do in the circumstances). However, the termination attempt was actually causing an assertion violation crash. These errors are now simply logged. Version 2.9.3 – Development Version ---- Version 2.9.3 is 2.8.1 with documentation and version changes to indicate that it's in the development branch. Version 2.8.1 – Stable Version ---- Version 2.8.1 is derived from development version 2.9.2 and has stability improvements and important bug fixes. For full details, please refer to the release notes here, back as far as 2.9.1. Version 2.9.2 – Development Version ---- Version 2.9.2 focuses on further bug fixes and stability improvements. * Enhanced stability: an important bug has been fixed in the handling of missing audio frames – i.e. what happens when a frame of audio is truly missing, after all attempts to fetch it have been unsuccessful. The bug would cause Shairport Sync to do an unnecessary resynchronisation, or, if resync was turned off, to jump out of sync. This is a long-standing bug – thanks to [Jörg Krause](https://github.com/joerg-krause) for identifying it. * An extra diagnostic has been added which gives the mean, standard deviation and maximum values for inter-packet reception time on the audio port. It may be useful for exploring line quality. Version 2.9.1 – Development Version ---- Version 2.9.1 focuses on bug fixes and stability improvements. * Stability improvements are concentrated on what happens when a play sessions ends and is followed immediately by a new session. This happens in iOS 9.2 when you click to the next track or to the previous track. It also happens playing YouTube videos when a Mac's System Audio is routed through AirPlay. Thanks to [Tim Curtis](https://github.com/moodeaudio) for help with these issues. * A workaround for an apparent flushing issue in TuneBlade has been included. Thanks to [gibman](https://github.com/gibman) for reporting this issue. * A number of bug fixes have been made to `configure.ac` – thanks to [Jörg Krause](https://github.com/joerg-krause). Version 2.8 – Stable Version ---- Version 2.8 is derived from version 2.7.10 with slight documentation updates. Here is a summary of changes between the last stable version – 2.6 – and this version. For full details, refer to the release notes here, back as far as 2.7. **New Feature** * For hardware mixers with a restricted range (including many cheaper USB DACS), the general `volume_range_db` can be used to specify a wider range than the hardware provides – the extra range is provided by software. **Enhancements** * The `man` manual and the html version of it are automagically rebuilt if `xml2man` and friends are available. * Volume-setting metadata is now sent even when the volume level is to be ignored by Shairport Sync itself. * Shairport Sync waits a little longer before asking for missing packets to be resent. Sometimes packets are just arriving slightly out of order and don't need to be asked for again. * The build scripts have been modified to be a little more compatible with standard practice. * A Continuous Integration (CI) system – Travis CI – is now used to do some limited build checking (thanks guys!). * Support added for compiling on Cygwin. * Added `rtptime` tags to metadata and picture metadata. * Replaced and improved the dither algorithm used with the software volume control. The new dither code gives a two bit peak-to-peak dither based on a Triangular Probability Distribution Function (TPDF). * Disabled picture sending if pictures haven’t been asked for. **Bug fixes** * Fixed a bug that prevented Shairport Sync from correctly setting the hardware mixer volume if it had been altered externally. Thanks to [Tim Curtis](https://github.com/moodeaudio) for help with these issues. * Modified the shutdown behaviour so that a shutdown followed immediately by a play request is handled better. This was causing iOS 9.2 sometimes to drop the Airplay link between tunes. * Fixed a data-alignment bug that would cause a crash in certain circumstances on ARM processors with metadata enabled. * Corrected the names for a few settings tags. * Fixed some typos and misspellings. * Miscellaneous small bug fixes. Version 2.7.10 -- Development Version ---- **New Feature** * If the `ignore_volume_control` setting was `yes`, Shairport Sync really did ignore volume control settings and did not send any volume metadata (i.e. `pvol` coded metadata). Now, while continuing to ignore volume control settings, it sends a `pvol` token where the first number is the AirPlay volume, as before, but the remaining three parameters are set to zero. Version 2.7.9 -- Development Version ---- **Bug Fix** * Oops – brown-bag update. Fixed a crashing bug introduced in the last release, caused by not checking for a hardware mixer before trying to access it, duh. Version 2.7.8 -- Development Version ---- **Bug Fix** * Fixed an issue whereby Shairport Sync did not reset the hardware mixer volume level before resuming playing. The issue was caused by not releasing and later reaquiring the mixer when pausing and resuming. Thanks to [Tim Curtis](https://github.com/moodeaudio) for reporting the issue. Version 2.7.7 -- Development Version ---- **Enhancements** * Add note about the Arch Linux Community repository package `shairport-sync`. Thanks to [Anatol Pomozov](https://github.com/anatol). * Shairport Sync doesn't ask for packets to be resent quite so quickly -- it waits about half a second now before asking for missing packets to be resent. **Bug Fixes** * Improved Shairport Sync's behaviour when it's asked to stop a play session and immediately start another. The signalling system used to stop threads was sometimes stopping threads belonging to the new session. This affected iOS 9.2 users going to the next track -- sometimes the player would become unavailable for an instant and disconnect the session. Th problem still happens occasionally. * Removed code favouring the use of "public" IPv6 addresses as source addresses when connecting to a distant IPv6 port – Neither OpenWrt nor FreeBSD can use it at present. Also, it's not clear if any problems are being caused by not favouring public IPv6 addresses. Version 2.7.6 -- Development Version ---- **Bug Fixes** * Look for the correct tag name for desired `ao` buffer length: `audio_backend_buffer_desired_length` rather than `audio_backend_buffer_desired_length_software`. * Fix a few FreeBSD compilation bugs. * Fix a few documentation issues and typos. Thanks to [Chris Boot](https://github.com/bootc). **Enhancements** * Add note about installing to Mac OS X. Thanks to [Serg Podtynnyi](https://github.com/shtirlic). * Add automatic rebuild of manpage and html documentation when `xmltoman` and friends are available. Thanks to [Chris Boot](https://github.com/bootc). * Favour the use of "public" IPv6 addresses as source addresses when connecting to a distant IPv6 port. Version 2.7.5 -- Development Version ---- **New Features** * Ubuntu PPA files now available at https://launchpad.net/~dantheperson. **Enhancements** * Broaden the use of the value `$PREFIX` instead of the path `/usr/local/bin` during configuration. Thanks to [dantheperson](https://github.com/dantheperson). Version 2.7.4 -- Development Version ---- **Enhancements** * Use the correct method for finding the `systemd` unit path, as recommended by Debian maintainers and http://www.freedesktop.org/software/systemd/man/daemon.html#Installing%20Systemd%20Service%20Files. Thanks to [dantheperson](https://github.com/dantheperson). * Rather than hardwire the path `/usr/local/bin` as the path to the shairport-sync executable, the value of `$PREFIX` is now used during configuration. Thanks to [Nick Steel](https://github.com/kingosticks). * Add some extra diagnostic messages if the hardware buffer in the DAC is smaller than desired. * If metadata has been enabled, but if picture sending has not been requested and the source sends pictures anyway, omit them from the metadata feed. Thanks to [Jörg Krause](https://github.com/joerg-krause). **Bug Fixes** * Fixed a data alignment issue in the handling of metadata on some processors. Thanks to [Jörg Krause](https://github.com/joerg-krause). * Removed an `assert` which would terminate the program if a malformed packet of data was received. * Look for the correct tag name for desired alsa buffer length: `audio_backend_buffer_desired_length` rather than `audio_backend_buffer_desired_length_software`. Version 2.7.3 -- Development Version ---- **Bug Fix** * The dither code was broken in Shairport Sync and was less than ideal anyway. It has been fixed and improved. Dither is added whenever you use the software volume control at less than full volume. See http://www.ece.rochester.edu/courses/ECE472/resources/Papers/Lipshitz_1992.pdf for a very influential paper by Lipshitz, Wannamaker and Vanderkooy, 1992. The dither code in Shairport Sync was inherited from Shairport and does not conform to the recommendations in the paper -- specifically the implementation would give one bit of dither where the paper recommends two bits peak-to-peak. The other thing is that the inherited dither code was actually broken in Shairport Sync. So, the new dither code gives a two bit peak-to-peak dither based on a Triangular Probability Distribution Function (TPDF). It sounds like a very low-level white noise, unmodulated by the audio material. It would be nice if it was even lower, but it's better than listening to the artifacts present when dithering is disabled. Version 2.7.2 -- Development Version ---- **Bug Fix** * Fix a bug that suppressed output of the `rtptime` associated with metadata and with picture information coming from the audio source and passed on via the metadata pipe. **Other Changes** * Added some more information to the log whenever problems are detected with the proposed alsa device. Version 2.7.1 -- Development Version ---- **Bug Fix** * The new volume-extension code was not correctly setting the volume after a pause / resume. Fixed. Version 2.7 -- Development Version ---- **New Features** * Extend the volume range for some DACs. Background: some of the cheaper DACS have a very small volume range (that is, the ratio of the highest to the lowest volume, expressed in decibels, is very small). In some really cheap DACs it's only around 30 dB. That means that the difference between the lowest and highest volume settings isn't large enough. With the new feature, if you set the `general` `volume_range_db` to more than the hardware mixer's range, Shairport Sync will combine the hardware mixer's range with a software attenuator to give the desired range. For example, suppose you want a volume range of 70 dB and the hardware mixer offers only 30 dB, then Shairport Sync will make up the other 40 dB with a software attenuator. One drawback is that, when the volume is being changed, there may be a slight delay (0.15 seconds by default) as the audio, whose volume may have been adjusted in software, propagates through the system. Another slight possible drawback is a slightly heavier load on the processor. * Check for underflow a little better when buffer aliasing occurs on very bad connections... * Add extra debug messages to the alsa back end to diagnose strange DACs. * Add configuration file for the `libao` back end -- to change the buffer size and the latency offset, same as for stdout. * Add `shairport-sync.exe` to `.gitignore`. * Add a check to support compilation on a CYGWIN platform. * Add `rtptime` tags to metadata and picture information and add two new metadata items to precede and follow the transmission of a picture. Background: it seems that metadata and picture information for the same item, e.g. a track, are normally tagged with a timestamp called the `rtptime`; if they refer to the same item, they will have the same `rtptime` tags. The update here is to add the `rtptime` value, if available, as data to the `mdst` and `mden` metadata items, which are sent before ("MetaData STart") and after ("MetaData ENd") a metadata sequence. In addition, similar tags -- `pcst` ("PiCture STart") and `pcen` ("PiCture ENd") are now sent before and after a picture with the `rtptime` value, if available, sent as data. By the way, the progress metadata (`prgr` for "PRoGRess"), which is sent just when a track starts, contains the same `rtptime` as its middle element. Version 2.6 -- Stable Version ---- This is basically version 2.4.2 with two small fixes. It's been bumped to 2.6 because (1) the new features added between 2.4.1 and 2.4.2 deserve more than just a bug-fix increment and (2) the development versions (2.5.x) should have lower numbers than the release versions, so that releases are always seen as upgrades. For example: 2.5.0.9 --> 2.6 looks like an upgrade, whereas 2.5.0.9 --> 2.4.2 looks like a downgrade. **Fixes** * For `systemd` users, the `shairport-sync.service` file is updated to point to the correct location of the shairport-sync application. * For Fedora users, the `shairport-sync.spec` file is updated to refer to 2.6. Version 2.4.2 ---- This release has important enhancements, bug fixes and documentation updates. It also appears to bring compatibility with Synology NAS devices. **New Features** * Source-specified Latencies. Shairport Sync now uses the latencies specified by the audio source. Background: the AirPlay protocol used by Shairport Sync allows the audio source to specify the exact delay or latency that should be applied to the audio stream. Until now, Shairport Sync ignored this information and used fixed preset latencies that were selected on the basis of the "User-Agent" setting. Using source-specified latencies means that Shairport Sync is able adapt automatically to different sources. Using source-specified latencies is now automatic unless non-standard static latencies have been specified in the configuration file or command line. Using non-standard latencies is usually done to compensate for delays in the back end of the system. For example, if the audio amplifier being driven by Shairport Sync has an inherent delay of its own -- as happens with many home theatre and surround sound systems -- then some users have reduced the latencies used by Shairport Sync to compensate. This usage is discouraged -- the `audio_backend_latency_offset` in the appropriate backend stanza (e.g. in the "alsa" stanza) should be used for this. Static latency settings are now deprecated, and will be removed in a future version of Shairport Sync. * Set Volume Range. This is a new setting that allows you to use just a portion of the full range of attenuation offered by a mixer. For example, if a mixer has a minimum volume of -80 dB and a maximum of +20 dB, you might wish to use only 60 dB of the 100 dB available. This might be because the sound becomes inaudible at the lowest setting and unbearably loud at the highest setting. It is for this reason that many domestic HiFi systems have a volume control range of only 60 to 80 dB. Another possible reason to use this setting might be because the range specified by the mixer does not match the actual capabilities of the device. For example, the Raspberry Pi's DAC that feeds the built-in audio jack claims a range of 106 dB but has a useful range of only about 35dB. The new `volume_range_db` setting in the `general` stanza allows you to specify the maximum range from highest to lowest. The range suggested for the Raspberry Pi's built-in audio DAC, which feeds the headphone jack, is 35. Using it in this case gives the volume control a much more useful range of settings. **Bug fixes** * Sometimes, especially when using Shairport Sync as a system output, it would not play the audio stream. This was caused by an improperly initialised variable. Fixed. Synology NAS devices now seem to be working with Shairport Sync. * Fix in the `shairport.c`: the USE_CUSTOM_LOCAL_STATE_DIR macro was still being used when it should have been USE_CUSTOM_PID_DIR. * Fix a crashing bug -- if metadata was enabled but a pipename was not supplied, boom. **Other Changes** * Initial timing accuracy improved. The estimate of when to play the starting frame of the audio sequence has improved significantly. This leads to fewer corrections being needed at the start. * Volume ratios expressed in decibels are now consistently denominated in voltage decibels rather than power decibels. The rationale is that the levels refer to voltage levels, and power is proportional to the square of voltage. Thus a ratio of levels of 65535 to 1 is 96.3 dB rather than the 48.15 dB used before. * The latency figure returned to the source as part of the response to an rtsp request packet is 11,025, which may (?) be meant to indicate the minimum latency the device is capable of. * An experimental handler for a GET_PARAMETER rtsp request has been added. It does nothing except log the occurrence. * The RTSP request dispatcher now logs an event whenever an unrecognised rtsp has been made. Version 2.4.1 ---- This release has three small bug fixes and some small documentation updates. **Bug Fixes** Changes from the previous stable version -- 2.4 -- are summarised here: * The USE_CUSTOM_LOCAL_STATE_DIR macro was still being used when it should have been USE_CUSTOM_PID_DIR. This could affect users using a custom location for the PID directory. * A compiler error has been fixed that occurred if metadata was enabled and tinysvcmdns was included. * A crash has been fixed that occurred if metadata was enabled and a metadata pipe name was not specified. (Thanks to the contributors who reported bugs.) **Small Changes** * If a mixer being used to control volume does not have a control denominated in dB, a warning is logged and the mixer is not used. * Slight revisions have been made to the configuration file `configure.ac` to make compilation on FreeBSD a little easier. Version 2.4 ---- **Stable release** This stable release is the culmination of the 2.3.X sequence of development releases. **Change Summary** Changes from the previous stable version -- 2.2.5 -- are summarised here: * Settings are now read from a configuration file. Command-line settings are supported but discouraged. * Metadata is now supported -- it can be delivered to a unix pipe for processing by a helper application. See https://github.com/mikebrady/shairport-sync-metadata-reader for a sample metadata reader. * Raw PCM audio can be delivered to standard output ("stdout") or to a unix pipe. The internal architecture has changed considerably to support this. * Support for compilation on OpenWrt back to Attitude Adjustment. * Can play unencrypted audio streams -- complatible with, e.g. Whaale. * Uses the libconfig library. * Runs on a wider range of platforms, including Arch Linux and Fedora. * Bug fixes. Please note that building instructions have changed slightly from the previous version. Also, the `-t hardware/software` option has been deprecated in the alsa back end. Version 2.3.13 ---- **Note** * We're getting ready to release the development branch as the new, stable, master branch at 2.4. If you're packaging Shairport Sync, you might prefer to wait a short while as we add a little polish before the release. **Changes** * Harmonise version numbers on the release and on the `shairport.spec` file used in Fedora. Version 2.3.12 ---- **Note** * We're getting ready to release the development branch as the new, stable, master branch at 2.4. If you're packaging Shairport Sync, you might prefer to wait a short while as we add a little polish before the release. **Changes** * `update-rc.d` has been removed from the installation script for System V because it causes problems for package makers. It's now noted in the user installation instructions. * The `alsa` group `mixer_type` setting is deprecated and you should stop using it. Its functionality has been subsumed into `mixer_name` – when you specify a `mixer_name` it automatically chooses the `hardware` mixer type. **Enhancements** * Larger range of interpolation. Shairport Sync was previously constrained not to make interpolations ("corrections") of more than about 1 per 1000 frames. This constraint has been relaxed, and it is now able to make corrections of up to 1 in 352 frames. This might result in a faster and undesirably sudden correction early during a play session, so a number of further changes have been made. The full set of these changes is as follows: * No corrections happen for the first five seconds. * Corrections of up to about 1 in 1000 for the next 25 seconds. * Corrections of up to 1 in 352 thereafter. **Documentation Update** * Nearly there with updates concerning the configuration file. Version 2.3.11 ---- Documentation Update * Beginning to update the `man` document to include information about the configuration file. It's pretty sparse, but it's a start. Version 2.3.10 ---- Bug fix * The "pipe" backend used output code that would block if the pipe didn't have a reader. This has been replaced by non-blocking code. Here are some implications: * When the pipe is created, Shairport Sync will not block if a reader isn't present. * If the pipe doesn't have a reader when Shairport Sync wants to output to it, the output will be discarded. * If a reader disappears while writing is occurring, the write will time out after five seconds. * Shairport Sync will only close the pipe on termination. Version 2.3.9 ---- * Bug fix * Specifying the configuration file using a *relative* file path now works properly. * The debug verbosity requested with `-v`, `-vv`, etc. is now honoured before the configuration file is read. It is read and honoured from when the command line arguments are scanned the first time to get a possible configuration file path. Version 2.3.8 ---- * Annoying changes you must make * You probably need to change your `./configure` arguments. The flag `with-initscript` has changed to `with-systemv`. It was previously enabled by default; now you must enable it explicitly. * Changes * Added limited support for installing into `systemd` and Fedora systems. For `systemd` support, use the configuration flag `--with-systemd` in place of `--with-systemv`. The installation does not do everything needed, such as defining special users and groups. * Renamed `with-initscript` configuration flag to `with-systemv` to describe its role more accurately. * A System V startup script is no longer installed by default; if you want it, ask for it with the `--with-systemv` configuration flag. * Added limited support for FreeBSD. You must specify `LDFLAGS='-I/usr/local/lib'` and `CPPFLAGS='-L/usr/local/include'` before running `./configure --with-foo etc.` * Removed the `-configfile` annotation from the version string because it's no longer optional; it's always there. * Removed the `dummy`, `pipe` and `stdout` backends from the standard build – they are now optional and are no longer automatically included in the build. * Bug fixes * Allow more stack space to prevent a segfault in certain configurations (thanks to https://github.com/joerg-krause). * Add missing header files(thanks to https://github.com/joerg-krause). * Removed some (hopefully) mostly silent bugs from the configure.ac file. Version 2.3.7 ---- * Changes * Removed the two different buffer lengths for the alsa back end that made a brief appearance in 2.3.5. * Enhancements * Command line arguments are now given precedence over config file settings. This conforms to standard unix practice. * A `–without-pkg-config` configuration argument now allows for build systems, e.g. for older OpenWrt builds, that haven't fully implemented it. There is still some unhappiness in arch linux builds. * More * Quite a bit of extra diagnostic code was written to investigate clock drift, DAC timings and so on. It was useful but has been commented out. If might be useful in the future. Version 2.3.5 ---- * Changes * The metadata item 'sndr' is no longer sent in metadata. It's been replaced by 'snam' and 'snua' -- see below. * Enhancements * When a play session is initiated by a source, it attempts to reserve the player by sending an "ANNOUNCE" packet. Typically, a source device name and/or a source "user agent" is sent as part of the packet. The "user agent" is usually the name of the sending application along with some more information. If metadata is enabled, the source name, if provided, is emitted as a metadata item with the type `ssnc` and code `snam` and similarly the user agent, if provided, is sent with the type `ssnc` and code `snua`. * Two default buffer lengths for ALSA -- default 6615 frames if a software volume control is used, to minimise the response time to pause and volume control changes; default 22050 frames if a hardware volume control is used, to give more resilience to timing problems, sudden processor loading, etc. This is especially useful if you are processing metadata and artwork on the same machine. * Extra metadata: when a play session starts, the "Active-Remote" and "DACP-ID" fields -- information that can be used to identify the source -- are provided as metadata, with the type `ssnc` and the codes `acre` and `daid` respectively. The IDs are provided as strings. * Unencrypted audio data. The iOS player "Whaale" attempts to send unencrypted audio, presumably to save processing effort; if unsuccessful, it will send encrypted audio as normal. Shairport Sync now recognises and handles unencrypted audio data. (Apparently it always advertised that it could process unencrypted audio!) * Handle retransmitted audio in the control channel. When a packet of audio is missed, Shairport Sync will ask for it to be retransmitted. Normally the retransmitted audio comes back the audio channel, but "Whaale" sends it back in the control channel. (I think this is a bug in "Whaale".) Shairport Sync will now correctly handle retransmitted audio packets coming back in the control channel. * Bugfixes * Generate properly-formed `..` items of information. Version 2.3.4 ---- * Enhancement * When a play session starts, Shairport Sync opens three UDP ports to communicate with the source. Until now, those ports could be any high numbered port. Now, they are located within a range of 100 port locations starting at port 6001. The starting port and the port range are settable by two new general settings in `/etc/shairport-sync.conf` -- `udp_port_base` (default 6001) and `udp_port_range` (default 100). To retain the previous behaviour, set the `udp_port_base` to `0`. * Bugfixes * Fix an out-of-stack-space error that can occur in certain cases (thanks to https://github.com/joerg-krause). * Fix a couple of compiler warnings (thanks to https://github.com/joerg-krause). * Tidy up a couple of debug messages that were emitting misleading information. Version 2.3.3.2 ---- * Bugfix -- fixed an error in the sample configuration file. Version 2.3.3.1 ---- * Enhancement * Metadata format has changed slightly -- the format of each item is now `........`, where the `..` part is present if the length is non-zero. The change is that everything is now enclosed in an `..` pair. Version 2.3.2 and 2.3.3 ---- These releases were faulty and have been deleted. Version 2.3.1 ----- Some big changes "under the hood" have been made, leading to limited support for unsynchronised output to `stdout` or to a named pipe and continuation of defacto support for unsynchronised PulseAudio. Also, support for a configuration file in preference to command line options, an option to ignore volume control and other improvements are provided. In this release, Shairport Sync gains the ability to read settings from `/etc/shairport-sync.conf`. This gives more flexibility in adding features gives better compatibility across different versions of Linux. Existing command-line options continue to work, but some will be deprecated and may disappear in a future version of Shairport Sync. New settings will only be available via the configuration file. Note that, for the present, settings in the configuration will have priority over command line options for Shairport Sync itself, in contravention of the normal unix convention. Audio back end command line options, i.e. those after the `--`, have priority over configuration file settings for the audio backends. In moving to the the use of a configuration file, some "housekeeping" is being done -- some logical corrections and other small changes are being made to option names and modes of operations, so the settings in the configuration file do not exactly match command line options. When `make install` is executed, a sample configuration is installed or updated at `/etc/shairport-sync.conf.sample`. The same file is also installed as `/etc/shairport-sync.conf` if that file doesn't already exist. To prevent the configuration files being installed, use the configuration option `--without-configfiles`. * Pesky Change You Must Do Something About If you are using metadata, please note that the option has changed somewhat. The option `-M` has a new long name equivalent: `--metadata-pipename` and the argument you provide must now be the full name of the metadata pipe, e.g. `-M /tmp/shairport-sync-metadata`. * Enhancements * Shairport Sync now reads settings from the configuration file `/etc/shairport-sync.conf`. This has settings for most command-line options and it's where any new settings will go. A default configuration file will be installed if one doesn't exist, and a sample file configuration file is always installed or updated. Details of settings are provided in the sample file. Shairport Sync relies on the `libconfig` library to read configuration files. For the present, you can disable the new feature (and save the space taken up by `libconfig`) by using the configure option `--without-configfile-support`. * New command-line option `-c ` or `--configfile=` allows you to specify a configuration file other than `/etc/shairport-sync.conf`. * Session Timeout and Allow Session Interruption can now be set independently. This is really some "housekeeping" as referred to above -- it's a kind of a bug fix, where the bug in question is an inappropriate connection of the setting of two parameters. To explain: (1) By default, when a source such as iTunes starts playing to the Shairport Sync device, any other source attempting to start a play session receives a "busy" signal. If a source disappears without warning, Shairport Sync will wait for 120 seconds before dropping the session and allowing another source to start a play session. (2) The command-line option `-t` or `--timeout` allows you to set the wait time before dropping the session. If you set this parameter to `0`, Shairport Sync will not send a "busy" signal, thus allowing another source to interrupt an existing one. (3) The problem is that if you set the parameter to `0`, a session will never be dropped if the source disappears without warning. The (obvious) fix for this is to separate the setting of the two parameters, and this is now done in the configuration file `/etc/shairport-sync.conf` -- please see the settings `allow_session_interruption` and `session_timeout`. The behaviour of the `-t` and `--timeout` command-line options is unchanged but deprecated. * New Option -- "Ignore Volume Control" ('ignore_volume_control'). If you set this to "yes", the output from Shairport Sync is always set at 100%. This is useful when you want to set the volume locally. Available via the settings file only. * Statistics option correctly reports when no frames are received in a sampling interval and when output is not being synchronised. * A new, supported audio back end called `stdout` provides raw 16-bit 44.1kHz stereo PCM output. To activate, set `output_backend = "stdout"` in the general section of the configuration file. Output is provided synchronously with the source feed. No stuffing or stripping is done. If you are feeding it to an output device that runs slower or faster, you'll eventually get buffer overflow or underflow in that device. To include support for this back end, use the configuration option `--with-stdout`. * Support for the `pipe` back end has been enhanced to provide raw 16-bit 44.1kHz stereo PCM output to a named pipe. To activate, set `output_backend = "pipe"` in the general section of the configuration and give the fully-specified pathname to the pipe in the pipe section of the configuration file -- see `etc/shairport-sync.conf.sample` for an example. No stuffing or stripping is done. If you are feeding it to an output device that runs slower or faster, you'll eventually get buffer overflow or underflow in that device. To include support for this back end, use the configuration option `--with-pipe`. * Support for the `dummy` audio backend device continues. To activate, set `output_backend = "dummy"` in in the general section of the configuration. To include support for this back end, use the configuration option `--with-dummy`. * Limited support for the PulseAudio audio backend continues. To activate, set `output_backend = "pulse"` in in the general section of the configuration. You must still enter its settings via the command line, after the `--` as before. Note that no stuffing or stripping is done: if the PulseAudio sink runs slower or faster, you'll eventually get buffer overflow or underflow. * New backend-specific settings are provided for setting the size of the backend's buffer and for adding or removing a fixed offset to the overall latency. The `audio_backend_buffer_desired_length` default is 6615 frames, or 0.15 seconds. On some slower machines, particularly with metadata processing going on, the DAC buffer can underflow on this setting, so it might be worth making the buffer larger. A problem on software mixers only is that changes to volume control settings have to propagate through the buffer to be heard, so the larger the buffer, the longer the response time. If you're using an alsa back end and are using a hardware mixers, this isn't a problem. The `audio_backend_latency_offset` allows you emit frames to the audio back end some time before or after the synchronised time. This would be useful, for example, if you are outputting to a device that takes 20 ms to process audio; yoou would specify a `audio_backend_latency_offset = -882`, where 882 is the number of frames in 20 ms, to compensate for the device delay. Version 2.3 ----- * Enhancements * Adding the System V startup script (the "initscript") is now a configuration option. The default is to include it, so if you want to omit the installation of the initscript, add the configuration option `--without-initscript`. * Metadata support is now a compile-time option: `--with-metadata`. * A metadata feed has been added. Use the option `-M `, e.g. `-M /tmp`. Shairport Sync will provide metadata in a pipe called `/shairport-sync-metadata`. (This is changed in 2.3.1.) There's a sample metadata reader at https://github.com/mikebrady/shairport-sync-metadata-reader. The format of the metadata is a mixture of XML-style tags, 4-character codes and base64 data. Please look at `rtsp.c` and `player.c` for examples. Please note that the format of the metadata may change. Beware: there appears to be a serious bug in iTunes before 12.1.2, such that it may stall for a long period when sending large (more than a few hundred kilobytes) coverart images. * Bugfix * Fix a bug when compiling for Arch Linux on Raspberry Pi 2 (thanks to https://github.com/joaodriessen). * Fix a bug whereby if the ANNOUNCE and/or SETUP method fails, the play_lock mutex is never unlocked, thus blocking other clients from connecting. This can affect all types of users, but particularly Pulseaudio users. (Thanks to https://github.com/jclehner.) * Modify the init script to start after all services are ready. Add in a commented-out sleep command if users find it necessary (thanks to https://github.com/BNoiZe). * Two memory leaks fixed (thanks to https://github.com/pdgendt). * An error handling time specifications for flushes was causing an audible glitch when pausing and resuming some tracks. This has been fixed (thanks to https://github.com/Hamster128). Version 2.2.5 ----- * Bugfixes * Fix a segfault error that can occur in certain cases (thanks again to https://github.com/joerg-krause). * Include header files in common.c (thanks again to https://github.com/joerg-krause). Version 2.2.4 ----- * Bugfixes * Fix an out-of-stack-space error that can occur in certain cases (thanks to https://github.com/joerg-krause). * Fix a couple of compiler warnings (thanks to https://github.com/joerg-krause). Version 2.2.3 ----- * NOTE: all the metadata stuff has been moved to the "development" branch. This will become the stable branch henceforward, with just bug fixes or minor enhancements. Apologies for the inconvenience. * Bugfixes * Fix a bug when compiling for Arch Linux on Raspberry Pi 2 (thanks to https://github.com/joaodriessen). * Fix a compiler warning (thanks to https://github.com/sdigit). Version 2.2.2 ----- * Enhancement * An extra latency setting for forked-daapd sources -- 99,400 frames, settable via a new option `--forkedDaapdLatency`. Version 2.2.1 ----- * Bugfixes: * If certain kinds of malformed RTSP packets were received, Shairport Sync would stop streaming. Now, it generally ignores faulty RTSP packets. * The `with-pulseaudio` compile option wasn't including a required library. This is fixed. Note that the PulseAudio back end doesn't work properly and is just included in the application because it was there in the original shairport. Play with it for experimentation only. * Fix typo in init.d script: "Headphones" -> "Headphone". * Extra documentation * A brief note on how to compile `libsoxr` from source is included for the Raspberry Pi. Version 2.2 ----- * Enhancements: * New password option: `--password=SECRET` * New tolerance option: `--tolerance=FRAMES`. Use this option to specify the largest synchronisation error to allow before making corrections. The default is 88 frames, i.e. 2 milliseconds. The default tolerance is fine for streaming over wired ethernet; however, if some of the stream's path is via WiFi, or if the source is a third-party product, it may lead to much overcorrection -- i.e. the difference between "corrections" and "net correction" in the `--statistics` option. Increasing the tolerance may reduce the amount of overcorrection. Version 2.1.15 ----- * Changes to latency calculations: * The default latency is now 88,200 frames, exactly 2 seconds. It was 99,400 frames. As before, the `-L` option allows you to set the default latency. * The `-L` option is no longer deprecated. * The `-L` option no longer overrides the `-A` or `-i` options. * The default latency for iTunes is now 99,400 frames for iTunes 10 or later and 88,200 for earlier versions. * The `-i` or `--iTunesLatency` option only applies to iTunes 10 or later sources. Version 2.1.14 ----- * Documentation update: add information about the `-m` audio backend option. The `-m` audio backend option allows you to specify the hardware mixer you are using. Not previously documented. Functionality of shairport-sync is unchanged. Version 2.1.13 ----- * Compilation change: Begin to use PKG_CHECK_MODULES (in configure.ac) to statically link some of the libraries used by shairport-sync. It is intended to make it easier to build in the buildroot system. While sufficient for that purpose, note that PKG_CHECK_MODULES is not used for checking all the libraries yet. Functionality of shairport-sync is unchanged. Version 2.1.12 ----- * Enhancement: `--statistics` Statistics are periodically written to the console (or the logfile) if this command-line option is included. They are no longer produced in verbose (`-v`) mode. * Bugfixes for `tinysvcmdns` * A bug that prevented the device's IP number(s) and port numbers being advertised when using `tinysvcmdns` has been fixed. (Cause: name needed to have a `.local` suffix.) * Bugs causing the shairport service to semi-randomly disappear and reappear seem to be fixed. (Possible cause: incorrect timing settings when using `tinysvcmdns`.) Version 2.1.11 ----- * Enhancement * A man page is now installed -- do `man shairport-sync` or see it here: http://htmlpreview.github.io/?https://github.com/mikebrady/shairport-sync/blob/2.1/man/shairport-sync.html. Version 2.1.10 ----- * Bugfix * A bug that caused the `-t` timeout value to be incorrectly assigned has been fixed. (Cause: `config.timeout` defined as `int64_t` instead on `int`.) Version 2.1.9 ----- * Bugfixes * A bug that sometimes caused the initial volume setting to be ignored has been fixed. (Cause: setting volume before opening device.) * a bug that caused shairport-sync to become unresponsive or unavailable has been fixed. (Cause: draining rather than flushing the alsa device before stopping.) Version 2.1.8: ----- * Enhancements * (This feature is intended to be useful to integrators.) Shairport Sync now the ability to immediately disconnect and reconnect to the sound output device while continuing to stream audio data from its client. Send a `SIGUSR2` to the shairport-sync process to disconnect or send it a `SIGHUP` to reconnect. If shairport-sync has been started as a daemon using `shairport-sync -d`, then executing `shairport-sync -D` or `--disconnectFromOutput` will request the daemon to disconnect, and executing `shairport-sync -R` or `--reconnectToOutput` will request it to reconnect. With this feature, you can allow Shairport Sync always to advertise and provide the streaming service, but still be able to disconnect it locally to enable other audio services to access the output device. * Annoying things you should know about if you're updating from a previous version: * Options `--with-openssl`, `--with-polarssl` have been replaced with a new option `--with-ssl=