From: Mike Brady Date: Tue, 5 Sep 2017 16:32:19 +0000 (+0100) Subject: Move 3.2d5 to 3.1.2 X-Git-Tag: 3.1.2rc0~2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=46bcb0279743970cf76d2c0b5f16b83fa80b44a9;p=thirdparty%2Fshairport-sync.git Move 3.2d5 to 3.1.2 --- diff --git a/README.md b/README.md index 36efcdaf..7a5b3aa9 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ Shairport Sync ============= -Shairport Sync is an AirPlay audio player – it plays audio streamed from iTunes, iOS and macOS devices and other AirPlay sources such as Quicktime Player and [ForkedDaapd](http://ejurgensen.github.io/forked-daapd/), among others. +Shairport Sync is an AirPlay audio player – it plays audio streamed from iTunes, iOS and macOS devices and AirPlay sources such as Quicktime Player and [ForkedDaapd](http://ejurgensen.github.io/forked-daapd/), among others. + Audio played by a Shairport Sync-powered device stays synchronised with the source and hence with similar devices playing the same source. In this way, synchronised multi-room audio is possible for suitable players. (Hence the name Shairport Sync, BTW.) Shairport Sync runs on Linux and FreeBSD. It does not support AirPlay video or photo streaming. -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. +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. More Information ---------- @@ -59,17 +60,37 @@ In addition, Shairport Sync can output to standard output, pipes, `soundio` and For information about changes and updates, please refer to the RELEASENOTES.md file in the distribution. -Building And Installing the Development Version +Building And Installing --------------------- -The following procedures will build and install the `shairport-sync` application into your system. +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: + +**Ubuntu:** A `shairport-sync` installer package is available for Ubuntu. Additionally, a Personal Package Archives for Shairport Sync master and development branches are available at https://launchpad.net/~dantheperson. + +**Debian:** shairport-sync is in the Debian archive. + +**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 also available at [EliaCereda/shairport-sync-PKGBUILD](https://github.com/EliaCereda/shairport-sync-PKGBUILD). + +**Mac OS X:** A HomeBrew 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! + +If you wish to build and install the latest version of Shairport Sync on Debian, Ubuntu, Fedora or Arch platforms, please follow the General Build Instructions. When the program has been installed, refer to the section on Configuring Shairport Sync that follows. To build Shairport Sync from sources on FreeBSD please refer to [FREEBSD.md](https://github.com/mikebrady/shairport-sync/blob/master/FREEBSD.md). **Remove Old Versions Of Shairport Sync** 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. -**FreeBSD** - -To build Shairport Sync from sources on FreeBSD please refer to [FREEBSD.md](https://github.com/mikebrady/shairport-sync/blob/master/FREEBSD.md). **Determine The Configuration Needed** @@ -144,7 +165,6 @@ $ git clone https://github.com/mikebrady/shairport-sync.git Next, `cd` into the shairport-sync directory and execute the following commands: ``` -$ git checkout development $ autoreconf -i -f ``` (Note that the `autoreconf...` step may take some time on less powerful machines.) @@ -253,19 +273,19 @@ The user and group `shairport-sync` will be created if necessary, and a runtime If you have chosen the `--with-systemd` configuration option, then, to enable Shairport Sync to start automatically at system startup, enter: ``` -$sudo systemctl enable shairport-sync +$ sudo systemctl enable shairport-sync ``` **Complete installation into a System V system** If you have chosen the `--with-systemv` configuration option, enter: ``` -$sudo update-rc.d shairport-sync defaults 90 10 +$ sudo update-rc.d shairport-sync defaults 90 10 ``` **Man Page** -You can view the man page here: http://htmlpreview.github.io/?https://github.com/mikebrady/shairport-sync/blob/development/man/shairport-sync.html +You can view the man page here: http://htmlpreview.github.io/?https://github.com/mikebrady/shairport-sync/blob/master/man/shairport-sync.html Configuring Shairport Sync -------- @@ -342,7 +362,7 @@ Another setting to consider is the `general` `drift_tolerance_in_seconds` settin *Command Line Arguments* -As previously mentioned, you can use command line arguments to provide settings to Shairport Sync as before, 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/development/man/shairport-sync.html. +As previously mentioned, you can use command line arguments to provide settings to Shairport Sync as before, 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. diff --git a/RELEASENOTES.md b/RELEASENOTES.md index 122ec4f2..d3de38b1 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -1,35 +1,15 @@ -Version 3.2d5 +Version 3.1.2 ==== -**Bug Fixes??** -* 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.2d4 -==== +**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 compatability 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. -**Important Note** -* When you update to the 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` to unmute the output device before further use. - -Version 3.2d3 -==== - -**Bug Fixes** -* Fix handling of player lock, simplify and improve handling of loss of connection, improve some debug messages. This all folllows on from the change to protocol handling in 3.2d0, which has simplified and clarified a number of situations. - -Version 3.2d1 -==== - **Bug Fixes** -* There has been a persistent problem with Shairport Sync becoming unavailable after playing, say, a YouTube clip. -Previously, it has been partially caused by Shairport Sync crashing due to not being written in a thread-safe manner. That's been fixed, so it has stopped crashing, but the non-availability problem has occasionally remained. This may be due a misunderstanding of part of the [unpublished!] AirPlay protocol. Shairport Sync 3.2d1 incorporates an experimental change to how a TEARDOWN request is handled. This seems to fix the non-availability issue. As a bonus, Shairport Sync works properly with SoundCloud in Safari and Chrome on a Mac. - -[Update] It's not quite there yet. Some other parts of the code must be adjusted, but it looks very hopeful. - -Version 3.2d0 is Version 3.1.1 -==== +* 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 ====