🎉 Release of add-on AirCast 2.3.2

README.md

@@ -796,10 +796,10 @@ SOFTWARE.
 [adguard-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
 [adguard-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
 [adguard-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
-[addon-aircast]: https://github.com/hassio-addons/addon-aircast/tree/v2.3.1
+[addon-aircast]: https://github.com/hassio-addons/addon-aircast/tree/v2.3.2
-[addon-doc-aircast]: https://github.com/hassio-addons/addon-aircast/blob/v2.3.1/README.md
+[addon-doc-aircast]: https://github.com/hassio-addons/addon-aircast/blob/v2.3.2/README.md
 [aircast-issue]: https://github.com/hassio-addons/addon-aircast/issues
-[aircast-version-shield]: https://img.shields.io/badge/version-v2.3.1-blue.svg
+[aircast-version-shield]: https://img.shields.io/badge/version-v2.3.2-blue.svg
 [aircast-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/aircast-amd64.svg
 [aircast-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
 [aircast-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg

aircast/CHANGELOG.md

@@ -4,11 +4,14 @@ This is a general maintenance release.
 
 ### 🔨 Changed
 
-- :arrow_up: Upgrades base image to v5.1.0
+- ⬆ Upgrades add-on base image to v5.2.0
-- :arrow_up: Upgrades AirConnect to 0.2.24.7
+- 🔨 Implement OCI image specification on labels
-- :hammer: Disable Docker init
+- ⬆ Upgrades AirConnect to 0.2.25.0
+- ⬆ Upgrades add-on base image to v5.2.1
+- ✏ Split add-on documentation
+- ✏ Documentation tweak
 
-[changelog]: https://github.com/hassio-addons/addon-aircast/compare/v2.3.0...v2.3.1
+[changelog]: https://github.com/hassio-addons/addon-aircast/compare/v2.3.1...v2.3.2
 
 Questions? Join our Discord server! https://discord.me/hassioaddons
 Enjoying my add-ons? Consider supporting my work:

aircast/DOCS.md

@@ -0,0 +1,233 @@
+# Home Assistant Community Add-on: AirCast
+
+Apple devices use AirPlay to send audio to other devices, but this is not
+compatible with Google's Chromecast. This add-on tries to solve this
+compatibility gap.
+
+It detects Chromecast players in your network and creates virtual AirPlay
+devices for each of them. It acts as a bridge between the AirPlay client
+and the real Chromecast player.
+
+## Installation
+
+The installation of this add-on is pretty straightforward and not different in
+comparison to installing any other Home Assistant add-on.
+
+1. Search for the “AirCast” add-on in the Supervisor add-on store
+   and install it.
+1. Install the "AirCast" add-on.
+1. Start the "AirCast" add-on
+1. Check the logs of the "AirCast" add-on to see if everything went well.
+
+After ~30 seconds you should see some log messages appear in the add-on log.
+Using your iOS/Mac/iTunes/Airfoil/other clients, you should now see new AirPlay
+devices and can try to play audio to them.
+
+## Configuration
+
+**Note**: _Remember to restart the add-on when the configuration is changed._
+
+Example add-on configuration:
+
+```yaml
+log_level: info
+address: 192.168.1.234
+latency_rtp: 5000
+latency_http: 0
+drift: true
+```
+
+**Note**: _This is just an example, don't copy and past it! Create your own!_
+
+### Option: `log_level`
+
+The `log_level` option controls the level of log output by the addon and can
+be changed to be more or less verbose, which might be useful when you are
+dealing with an unknown issue. Possible values are:
+
+- `trace`: Show every detail, like all called internal functions.
+- `debug`: Shows detailed debug information.
+- `info`: Normal (usually) interesting events.
+- `warning`: Exceptional occurrences that are not errors.
+- `error`:  Runtime errors that do not require immediate action.
+- `fatal`: Something went terribly wrong. Add-on becomes unusable.
+
+Please note that each level automatically includes log messages from a
+more severe level, e.g., `debug` also shows `info` messages. By default,
+the `log_level` is set to `info`, which is the recommended setting unless
+you are troubleshooting.
+
+These log level also affects the log levels of AirCast server.
+
+### Option: `address`
+
+This option allows you to specify the IP address the AirCast server needs to
+bind to. It will automatically detect the interface to use when this option is
+left empty. Nevertheless, it might get detected wrong (e.g., in case you have
+multiple network interfaces).
+
+### Option: `latency_rtp`
+
+Allows you to tweak the buffering, which is needed when the audio is stuttering
+(e.g., low-quality network). This option specifies the number of ms the addon
+has to buffer the RTP audio (AirPlay). Setting this value below 500ms is not
+recommended! Setting the value to `0` causes the addon the get the value from
+AirPlay.
+
+### Option: `latency_http`
+
+Allows you to tweak the buffering, which is needed when the audio is stuttering
+(e.g., low-quality network). This option specifies the number of ms the addon
+has to buffer the HTTP audio.
+
+**Note**: This option usually is not needed and can be left to `0` in most
+cases.
+
+### Option: `drift`
+
+Set to `true` to let timing reference drift (no click).
+
+## Latency options explained
+
+These bridges receive real-time "synchronous" audio from the AirPlay controller
+in the format of RTP frames and forward it to the Chromecast player in an HTTP
+"asynchronous" continuous audio binary format. In other words,
+the AirPlay clients "push" the audio using RTP and the Chromecast players
+"pull" the audio using an HTTP GET request.
+
+A player using HTTP to get its audio expects to receive an initial large
+portion of audio as the response to its GET and this creates a large enough
+buffer to handle most further network congestion/delays. The rest of the audio
+transmission is regulated by the player using TCP flow control. However, when
+the source is an AirPlay RTP device, there is no such significant portion of
+audio available in advance to be sent to the Player, as the audio comes to the
+bridge in real time. Every 8ms, an RTP frame is received and is immediately
+forwarded as the continuation of the HTTP body. If the Chromecast players
+start to play immediately the first received audio sample, expecting an initial
+burst to follow, then any network congestion delaying RTP audio will starve
+the player and create shuttering.
+
+The `latency_http` option allows a certain amount of silence frames to be sent
+to the Chromecast player, in a burst at the beginning. Then, while this
+"artificial" silence is being played, it is possible for the bridge to build
+a buffer of RTP frames that will then hide network delays that might happen
+in further RTP frames transmission. This delays the start of the playback
+by `latency_http` ms.
+
+However, RTP frames are transmitted using UDP, which means there is no guarantee
+of delivery, so frames might be lost from time to time
+(often happens on WiFi networks). To allow detection of lost frames, they are
+numbered sequentially (1,2 ... n) so every time two received frames are not
+consecutive, the missing ones can be asked again by the AirPlay receiver.
+
+Typically, the bridge forwards immediately every RTP frame using HTTP and again,
+in HTTP, the notion of frame numbers does not exist, it is just the continuous
+binary audio. So it is not possible to send audio non-sequentially when using
+HTTP.
+
+For example, if received RTP frames are numbered 1,2,3,6, this bridge will
+forward (once decoded and transformed into raw audio) 1,2,3 immediately using
+HTTP but when it receives 6, it will re-ask for 4 and 5 to be resent and
+hold 6 while waiting (if 6 was transmitted immediately, the Chromecast
+will play 1,2,3,6 ... not nice).
+
+The `latency_rtp` option sets for how long frame 6 shall be held before adding
+two silence frames for 4 and 5 and send sending 4,5,6. Obviously, if this delay
+is larger than the buffer in the Chromecast player, playback will stop by
+lack of audio. Note that `latency_rtp` does not delay playback start.
+
+> **Note**: `latency_rtp` and `latency_http` could have been merged into a
+single `latency` parameter which would have set the max RTP frames holding time
+as well as the duration of the initial additional silence (delay),
+however, all Chromecast devices do properly their own buffering of HTTP audio
+(i.e., they wait until they have received a certain amount of audio before
+starting to play), then adding silence would have introduced an extra
+unnecessary delay in playback.
+
+## Tweaking Aircast
+
+Aircast creates a configuration file called `aircast.xml` in your Home
+Assistant configuration directory. This file allows you to tweak each device
+separately. Every time it finds a new device, it will be added to that file.
+
+> **NOTE**: It is HIGHLY recommended to stop the addon before making changes
+to the configuration file manually.
+
+## Known issues and limitations
+
+- This add-on does support ARM-based devices, nevertheless, they must
+  at least be an ARMv7 device. (Raspberry Pi 1 and Zero is not supported).
+- The configuration file of AirConnect (used by this add-on) is not
+  exposed to the user. We plan on adding that feature in a future release.
+
+## Changelog & Releases
+
+This repository keeps a change log using [GitHub's releases][releases]
+functionality. The format of the log is based on
+[Keep a Changelog][keepchangelog].
+
+Releases are based on [Semantic Versioning][semver], and use the format
+of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented
+based on the following:
+
+- ``MAJOR``: Incompatible or major changes.
+- ``MINOR``: Backwards-compatible new features and enhancements.
+- ``PATCH``: Backwards-compatible bugfixes and package updates.
+
+## Support
+
+Got questions?
+
+You have several options to get them answered:
+
+- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on
+  support and feature requests.
+- The [Home Assistant Discord chat server][discord-ha] for general Home
+  Assistant discussions and questions.
+- The Home Assistant [Community Forum][forum].
+- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
+
+You could also [open an issue here][issue] GitHub.
+
+## Authors & contributors
+
+The original setup of this repository is by [Franck Nijhof][frenck].
+
+For a full list of all authors and contributors,
+check [the contributor's page][contributors].
+
+## License
+
+MIT License
+
+Copyright (c) 2017-2020 Franck Nijhof
+
+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.
+
+[contributors]: https://github.com/hassio-addons/addon-aircast/graphs/contributors
+[discord-ha]: https://discord.gg/c5DvZ4e
+[discord]: https://discord.me/hassioaddons
+[docs]: https://github.com/hassio-addons/addon-aircast/blob/master/aircast/DOCS.md
+[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-aircast/36742?u=frenck
+[frenck]: https://github.com/frenck
+[issue]: https://github.com/hassio-addons/addon-aircast/issues
+[keepchangelog]: http://keepachangelog.com/en/1.0.0/
+[reddit]: https://reddit.com/r/homeassistant
+[releases]: https://github.com/hassio-addons/addon-aircast/releases
+[semver]: http://semver.org/spec/v2.0.0.htm

aircast/README.md

@@ -20,8 +20,6 @@ It detects Chromecast players in your network and creates virtual AirPlay
 devices for each of them. It acts as a bridge between the AirPlay client
 and the real Chromecast player.
 
-[Click here for the full documentation][docs]
-
 ## WARNING! THIS IS A BETA VERSION!
 
 This Home Assistant Add-ons repository contains beta releases of add-ons.
@@ -40,7 +38,6 @@ If you are more interested in stable releases of our add-ons:
 
 [discord-shield]: https://img.shields.io/discord/478094546522079232.svg
 [discord]: https://discord.me/hassioaddons
-[docs]: https://github.com/hassio-addons/addon-aircast/blob/v2.3.1/README.md
 [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
 [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-aircast/36742?u=frenck
 [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
@@ -49,5 +46,5 @@ If you are more interested in stable releases of our add-ons:
 [patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
 [patreon]: https://www.patreon.com/frenck
 [project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
-[release-shield]: https://img.shields.io/badge/version-v2.3.1-blue.svg
+[release-shield]: https://img.shields.io/badge/version-v2.3.2-blue.svg
-[release]: https://github.com/hassio-addons/addon-aircast/tree/v2.3.1
+[release]: https://github.com/hassio-addons/addon-aircast/tree/v2.3.2

aircast/config.json

@@ -1,6 +1,6 @@
 {
   "name": "AirCast",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "slug": "aircast",
   "description": "AirPlay capabilities for your Chromecast devices.",
   "url": "https://github.com/hassio-addons/addon-aircast",