From: Mike Brady Date: Sun, 25 Sep 2016 15:00:49 +0000 (+0100) Subject: Update to 2.8.5 X-Git-Tag: 2.8.5~7 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2dd73ec10057cc558ca5a0c4717321d9d5fbe666;p=thirdparty%2Fshairport-sync.git Update to 2.8.5 --- 2dd73ec10057cc558ca5a0c4717321d9d5fbe666 diff --cc README.md index 74aee0a6,bf05aa88..848b7ebc --- a/README.md +++ b/README.md @@@ -5,7 -5,9 +5,9 @@@ Audio played by a Shairport Sync-powere Shairport Sync does not support AirPlay video or photo streaming. -**Please note that, between 2.8.4.6 and 2.8.4.7, there is a change in the standard ./configure arguments which you should not ignore!** +This is the stable "master" branch. Changes and updates are incorporated into this branch relatively slowly. To access the development version, where all the latest changes are made first, please switch to the "development" branch. ++**Please note that, between 2.8.4 and 2.8.5, there is a change in the standard ./configure arguments which you should not ignore!** + -This is the unstable "development" branch. Changes and updates are incorporated into this branch quickly. To access the stable version, where changes are made after due time, please switch to the "master" branch. More Information ---------- @@@ -49,41 -51,10 +51,42 @@@ For information about changes and updat Note: Historically, Shairport Sync has taken its settings from command line arguments. While this is still the case, it does not always work well across distributions. Accordingly, from version 2.4 onwards, Shairport Sync reads settings from the file `/etc/shairport-sync.conf`. Access to new features will only be provided via the settings file. -Building And Installing the Development Version +Building And Installing --------------------- -The following procedures will install the shairport-sync application into your system. Before continuing, you should check to see if shairport-sync is already installed – you can use the command `$ which shairport-sync` to find where it is located, if installed. If it is installed you should delete it – you may need superuser privileges. After deleting, check again in case further copies are installed elsewhere. -(If the existing installation of shairport-sync is where the new copy will be installed into, it will be overwritten; sometimes, however, the installation is to another location, so it is safer, initially, to delete previous versions manually.) ++ +Shairport Sync may already be available as a package in your Linux distribution (search for `shairport-sync` – the package named `shairport` is a different program). Packages are available on recent versions of Debian, Ubuntu, Arch, OpenWrt and possibly more. If you wish to build and install the latest version of Shairport Sync on OpenWrt, Arch or Fedora platforms, please follow the appropriate instructions below. Limited support is also available for Mac OS X. Otherwise follow the General Build Instructions. Then, when the program has been installed, refer to the section on Configuring Shairport Sync that follows. + +**Note** + +The following procedures will install the `shairport-sync` application into your system. Before continuing, you should check to see if `shairport-sync` is already installed – you can use the command `$ which shairport-sync` to find where it is located, if installed. If it is installed you should delete it – you may need superuser privileges. After deleting, check again in case further copies are installed elsewhere. +(If the existing installation of `shairport-sync` is where the new copy will be installed into, it will be overwritten; sometimes, however, the installation is to another location, so it is safer, initially, to delete previous versions manually.) + +**Ubuntu:** +Personal Package Archives for Shairport Sync master and development branches are available at https://launchpad.net/~dantheperson. A `shairport-sync` installer package is available in Ubuntu 16.04. + +**Debian:** +`shairport-sync` is in the Debian archive and is scheduled for release with Debian Stretch (9): https://tracker.debian.org/shairport-sync. A backport for Debian Jessie (8) may be provided given enough demand. + +**OpenWrt:** +There is a Shairport Sync package in OpenWrt `trunk`. Also, there's an OpenWrt package at https://github.com/mikebrady/shairport-sync-for-openwrt, including one that builds back to `Barrier Breaker`. + +**Arch Linux:** +Shairport Sync is available for `x86_64` and `i686` platforms in the Arch Linux Community Repository -- search for `shairport-sync`. See also https://www.archlinux.org/packages/. + +An Arch Linux installation package, suitable for compilation on any platform, is available at [EliaCereda/shairport-sync-PKGBUILD](https://github.com/EliaCereda/shairport-sync-PKGBUILD). + +**Mac OS X:** +A [HomeBrew](http://brew.sh) package exists for Shairport Sync. With HomeBrew installed, Shairport Sync can be installed using the command `$brew install shairport-sync`. Note that the installation uses the `libao` library and so synchronisation is not available — playback glitches will occur occasionally, when the `ao` system's buffers overflow or underflow. + +**Fedora:** +Please see the guide at [FEDORA.md](https://github.com/mikebrady/shairport-sync/blob/master/FEDORA.md). + +**Cygwin:** +Please see the guide at [CYGWIN.md](https://github.com/mikebrady/shairport-sync/blob/master/CYGWIN.md). + +Sincere thanks to all package contributors! + +**General Build Instructions** To build Shairport Sync from sources on Debian, Ubuntu, Raspbian, etc. follow these instructions. @@@ -110,11 -81,11 +113,11 @@@ Debian, Ubuntu and Raspbian users can g - `apt-get install avahi-daemon libavahi-client-dev` if you want to use Avahi (recommended). - `apt-get install libssl-dev` if you want to use OpenSSL and libcrypto, or use PolarSSL otherwise. - `apt-get install libpolarssl-dev` if you want to use PolarSSL, or use OpenSSL/libcrypto otherwise. -- `apt-get install libsoxr-dev` if you want support for libsoxr-based resampling. This library is in many recent distributions, including Jessie and Raspbian Jessie; if not, instructions for how to build it from source for Rasbpian/Debian Wheezy are available at [LIBSOXR.md](https://github.com/mikebrady/shairport-sync/blob/development/LIBSOXR.md). +- `apt-get install libsoxr-dev` if you want support for libsoxr-based resampling. This library is in many recent distributions, including Jessie and Raspioan Jessie; if not, instructions for how to build it from source for Raspian/Debian Wheezy are available at [LIBSOXR.md](https://github.com/mikebrady/shairport-sync/blob/master/LIBSOXR.md). - Download Shairport Sync: + **Download Shairport Sync:** -`git clone https://github.com/mikebrady/shairport-sync.git` +`$ git clone https://github.com/mikebrady/shairport-sync.git` Next, `cd` into the shairport-sync directory and execute the following command: @@@ -192,9 -172,9 +203,9 @@@ to install `shairport-sync` along with To enable Shairport Sync to start automatically at system startup, enter: -`$sudo systemctl enable shairport-sync` +`$ sudo systemctl enable shairport-sync` - **Installation to a System V system** + **Install into a System V system** If you are installing onto a System V system: ``` diff --cc RELEASENOTES.md index 9f3848ef,13e6f2af..1c2a0e1e --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@@ -1,4 -1,60 +1,78 @@@ ++Version 2.8.5 – Stable Version ++---- ++This release includes bug fixes and minor enhancements and is recommended for all users. ++ ++There is once change you should not ignore: ++==== ++ ++* 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`. ++ ++For advice on updating an installation you built yourself, ++please visit the [UPDATING](https://github.com/mikebrady/shairport-sync/blob/master/UPDATING.md) page. ++ ++The enhancements and bug fixes 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 + ---- -Pesky Changes You Cannot Ignore -==== + + * 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 (Candidate Release) +Version 2.8.4 – Stable Version ---- This release includes important bug fixes and minor enhancements and is recommended for all users. No settings need to be changed. For advice on updating an installation you built yourself, please visit the [UPDATING](https://github.com/mikebrady/shairport-sync/blob/master/UPDATING.md) page.