react-native-audio-browser 0.2.0-next.50 → 0.2.0-next.51

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/android/build.gradle +15 -0
  2. package/android/src/cast/java/com/audiobrowser/cast/CastSupport.kt +215 -0
  3. package/android/src/main/AndroidManifest.xml +11 -0
  4. package/android/src/main/java/com/audiobrowser/AudioBrowser.kt +0 -4
  5. package/android/src/main/java/com/audiobrowser/RemoteOutputs.kt +47 -10
  6. package/android/src/main/java/com/audiobrowser/model/PlayerSetupOptions.kt +12 -3
  7. package/android/src/main/java/com/audiobrowser/player/EqualizerController.kt +4 -1
  8. package/android/src/main/java/com/audiobrowser/player/LocalEngine.kt +49 -0
  9. package/android/src/main/java/com/audiobrowser/player/Player.kt +170 -119
  10. package/android/src/main/java/com/audiobrowser/player/PlayerListener.kt +18 -13
  11. package/android/src/main/java/com/audiobrowser/player/TransformingDataSource.kt +10 -13
  12. package/android/src/main/java/com/audiobrowser/remote/RemoteItem.kt +64 -0
  13. package/android/src/main/java/com/audiobrowser/remote/RemoteOutputsController.kt +98 -0
  14. package/android/src/main/java/com/audiobrowser/remote/RemotePlayback.kt +42 -0
  15. package/android/src/main/java/com/audiobrowser/remote/RemoteQueue.kt +110 -0
  16. package/android/src/main/java/com/audiobrowser/remote/RemoteSwitchingPlayer.kt +696 -0
  17. package/android/src/main/java/com/audiobrowser/sonos/DeviceDescriptionParser.kt +113 -0
  18. package/android/src/main/java/com/audiobrowser/sonos/DidlLite.kt +39 -0
  19. package/android/src/main/java/com/audiobrowser/sonos/SoapClient.kt +59 -0
  20. package/android/src/main/java/com/audiobrowser/sonos/SoapEnvelopes.kt +92 -0
  21. package/android/src/main/java/com/audiobrowser/sonos/SoapResponseParser.kt +105 -0
  22. package/android/src/main/java/com/audiobrowser/sonos/SonosDiscoverer.kt +69 -0
  23. package/android/src/main/java/com/audiobrowser/sonos/SonosOutputs.kt +128 -0
  24. package/android/src/main/java/com/audiobrowser/sonos/SonosPlayer.kt +550 -0
  25. package/android/src/main/java/com/audiobrowser/sonos/SonosRemote.kt +99 -0
  26. package/android/src/main/java/com/audiobrowser/sonos/SonosRouteProviderService.kt +201 -0
  27. package/android/src/main/java/com/audiobrowser/sonos/SonosStreamUri.kt +15 -0
  28. package/android/src/main/java/com/audiobrowser/sonos/SonosTransport.kt +66 -0
  29. package/android/src/main/java/com/audiobrowser/sonos/SpeakerXml.kt +26 -0
  30. package/android/src/main/java/com/audiobrowser/sonos/SsdpDiscovery.kt +63 -0
  31. package/android/src/main/java/com/audiobrowser/sonos/SsdpMessages.kt +63 -0
  32. package/android/src/main/java/com/audiobrowser/sonos/ZoneGroupState.kt +68 -0
  33. package/android/src/main/java/com/audiobrowser/util/OutputMonitor.kt +2 -1
  34. package/android/src/nocast/java/com/audiobrowser/cast/CastSupport.kt +18 -0
  35. package/android/src/test/java/com/audiobrowser/RemoteOutputsTest.kt +20 -3
  36. package/android/src/test/java/com/audiobrowser/model/PlayerSetupOptionsTest.kt +35 -0
  37. package/android/src/test/java/com/audiobrowser/player/EqualizerControllerTest.kt +12 -0
  38. package/android/src/test/java/com/audiobrowser/player/PlayerCastTest.kt +136 -0
  39. package/android/src/test/java/com/audiobrowser/player/PlayerSonosTest.kt +213 -0
  40. package/android/src/test/java/com/audiobrowser/remote/FakeRemote.kt +275 -0
  41. package/android/src/test/java/com/audiobrowser/remote/RemoteItemTest.kt +61 -0
  42. package/android/src/test/java/com/audiobrowser/remote/RemoteOutputsControllerTest.kt +77 -0
  43. package/android/src/test/java/com/audiobrowser/remote/RemoteQueueTest.kt +101 -0
  44. package/android/src/test/java/com/audiobrowser/remote/RemoteSwitchingPlayerTest.kt +815 -0
  45. package/android/src/test/java/com/audiobrowser/sonos/DeviceDescriptionParserTest.kt +203 -0
  46. package/android/src/test/java/com/audiobrowser/sonos/DidlLiteTest.kt +90 -0
  47. package/android/src/test/java/com/audiobrowser/sonos/SoapClientTest.kt +73 -0
  48. package/android/src/test/java/com/audiobrowser/sonos/SoapEnvelopesTest.kt +135 -0
  49. package/android/src/test/java/com/audiobrowser/sonos/SoapResponseParserTest.kt +170 -0
  50. package/android/src/test/java/com/audiobrowser/sonos/SonosDiscovererTest.kt +174 -0
  51. package/android/src/test/java/com/audiobrowser/sonos/SonosPlayerTest.kt +691 -0
  52. package/android/src/test/java/com/audiobrowser/sonos/SonosRemoteTest.kt +129 -0
  53. package/android/src/test/java/com/audiobrowser/sonos/SonosRoutesTest.kt +165 -0
  54. package/android/src/test/java/com/audiobrowser/sonos/SonosStreamUriTest.kt +64 -0
  55. package/android/src/test/java/com/audiobrowser/sonos/SonosTransportTest.kt +204 -0
  56. package/android/src/test/java/com/audiobrowser/sonos/SsdpMessagesTest.kt +99 -0
  57. package/android/src/test/java/com/audiobrowser/sonos/ZoneGroupStateTest.kt +139 -0
  58. package/android/src/test/java/com/audiobrowser/util/OutputMonitorTest.kt +12 -10
  59. package/android/src/test/resources/sonos/device_description.xml +78 -0
  60. package/android/src/testCast/java/com/audiobrowser/cast/CastEndsTest.kt +56 -0
  61. package/android/src/testCast/java/com/audiobrowser/cast/SendingMediaItemConverterTest.kt +79 -0
  62. package/lib/commonjs/features/player/setup.js +2 -0
  63. package/lib/commonjs/features/player/setup.js.map +1 -1
  64. package/lib/module/features/player/setup.js +2 -0
  65. package/lib/module/features/player/setup.js.map +1 -1
  66. package/lib/typescript/src/features/player/setup.d.ts +37 -7
  67. package/lib/typescript/src/features/player/setup.d.ts.map +1 -1
  68. package/lib/typescript/src/specs/audio-browser.nitro.d.ts +3 -3
  69. package/lib/typescript/src/specs/audio-browser.nitro.d.ts.map +1 -1
  70. package/nitrogen/generated/android/c++/JHybridAudioBrowserSpec.cpp +4 -0
  71. package/nitrogen/generated/android/c++/JNativeSetupPlayerOptions.hpp +7 -5
  72. package/nitrogen/generated/android/c++/JOutputType.hpp +3 -0
  73. package/nitrogen/generated/android/c++/JRemoteOutputsOptions.hpp +66 -0
  74. package/nitrogen/generated/android/kotlin/com/margelo/nitro/audiobrowser/NativeSetupPlayerOptions.kt +3 -3
  75. package/nitrogen/generated/android/kotlin/com/margelo/nitro/audiobrowser/OutputType.kt +3 -2
  76. package/nitrogen/generated/android/kotlin/com/margelo/nitro/audiobrowser/RemoteOutputsOptions.kt +61 -0
  77. package/nitrogen/generated/ios/AudioBrowser-Swift-Cxx-Bridge.hpp +18 -0
  78. package/nitrogen/generated/ios/AudioBrowser-Swift-Cxx-Umbrella.hpp +3 -0
  79. package/nitrogen/generated/ios/c++/HybridAudioBrowserSpecSwift.hpp +3 -0
  80. package/nitrogen/generated/ios/swift/NativeSetupPlayerOptions.swift +5 -12
  81. package/nitrogen/generated/ios/swift/OutputType.swift +4 -0
  82. package/nitrogen/generated/ios/swift/RemoteOutputsOptions.swift +78 -0
  83. package/nitrogen/generated/shared/c++/NativeSetupPlayerOptions.hpp +8 -5
  84. package/nitrogen/generated/shared/c++/OutputType.hpp +6 -2
  85. package/nitrogen/generated/shared/c++/RemoteOutputsOptions.hpp +92 -0
  86. package/package.json +1 -1
  87. package/src/features/player/setup.ts +38 -7
  88. package/src/specs/audio-browser.nitro.ts +4 -3
  89. package/website/guide/audio-output.md +185 -4
  90. package/website/guide/configuration.md +6 -0
@@ -0,0 +1,113 @@
1
+ package com.audiobrowser.sonos
2
+
3
+ import org.w3c.dom.Element
4
+ import org.w3c.dom.Node
5
+
6
+ /** A discovered Sonos speaker: its identity, its name, and the absolute control URLs. */
7
+ internal data class SonosDevice(
8
+ val udn: String,
9
+ val name: String,
10
+ val baseUrl: String,
11
+ val avTransportControlUrl: String,
12
+ val groupRenderingControlUrl: String,
13
+ val zoneGroupTopologyControlUrl: String?,
14
+ )
15
+
16
+ /**
17
+ * Parses a UPnP `device_description.xml` (fetched from an SSDP `LOCATION`) into a [SonosDevice].
18
+ * Sonos nests its services under embedded devices, so the whole device tree is searched. Returns
19
+ * null for a non-Sonos device, malformed XML, or a description without `AVTransport` and
20
+ * `GroupRenderingControl`; `ZoneGroupTopology` is optional.
21
+ */
22
+ internal object DeviceDescriptionParser {
23
+ private const val SONOS_MANUFACTURER = "Sonos, Inc."
24
+ private const val AV_TRANSPORT = "urn:schemas-upnp-org:service:AVTransport:1"
25
+ private const val GROUP_RENDERING_CONTROL = "urn:schemas-upnp-org:service:GroupRenderingControl:1"
26
+ private const val ZONE_GROUP_TOPOLOGY = "urn:schemas-upnp-org:service:ZoneGroupTopology:1"
27
+
28
+ fun parse(xml: String, location: String): SonosDevice? {
29
+ val doc = parseSpeakerXml(xml) ?: return null
30
+
31
+ // From the root <device>, the direct child of <root>, not the first <device> in the document.
32
+ val docElement = doc.documentElement ?: return null
33
+ val root = directChildElement(docElement, "device") ?: return null
34
+ if (!childText(root, "manufacturer").equals(SONOS_MANUFACTURER, ignoreCase = true)) return null
35
+ val udn =
36
+ childText(root, "UDN").ifBlank {
37
+ return null
38
+ }
39
+ val name = childText(root, "roomName").ifBlank { childText(root, "friendlyName") }
40
+
41
+ // UPnP allows an explicit <URLBase>; when present it overrides the retrieval location for
42
+ // resolving relative control URLs.
43
+ val baseUrl =
44
+ childText(docElement, "URLBase").ifBlank { "" }.trimEnd('/').ifBlank { baseUrlOf(location) }
45
+ ?: return null
46
+ val avControl = findControlUrl(doc, AV_TRANSPORT, baseUrl) ?: return null
47
+ val groupRcControl = findControlUrl(doc, GROUP_RENDERING_CONTROL, baseUrl) ?: return null
48
+
49
+ return SonosDevice(
50
+ udn = udn,
51
+ name = name,
52
+ baseUrl = baseUrl,
53
+ avTransportControlUrl = avControl,
54
+ groupRenderingControlUrl = groupRcControl,
55
+ zoneGroupTopologyControlUrl = findControlUrl(doc, ZONE_GROUP_TOPOLOGY, baseUrl),
56
+ )
57
+ }
58
+
59
+ /**
60
+ * Finds the first `<service>` anywhere in the tree with [serviceType] and returns its absolute
61
+ * control URL, or null if absent.
62
+ */
63
+ private fun findControlUrl(
64
+ doc: org.w3c.dom.Document,
65
+ serviceType: String,
66
+ baseUrl: String,
67
+ ): String? {
68
+ val services = doc.getElementsByTagName("service")
69
+ for (i in 0 until services.length) {
70
+ val service = services.item(i) as? Element ?: continue
71
+ if (childText(service, "serviceType").equals(serviceType, ignoreCase = true)) {
72
+ val control =
73
+ childText(service, "controlURL").ifBlank {
74
+ return null
75
+ }
76
+ return resolveUrl(baseUrl, control)
77
+ }
78
+ }
79
+ return null
80
+ }
81
+
82
+ /** The scheme://host:port prefix of a URL, or null if it has none. */
83
+ private fun baseUrlOf(url: String): String? {
84
+ val schemeEnd = url.indexOf("://")
85
+ if (schemeEnd < 0) return null
86
+ val pathStart = url.indexOf('/', schemeEnd + 3)
87
+ return if (pathStart < 0) url else url.substring(0, pathStart)
88
+ }
89
+
90
+ private fun resolveUrl(baseUrl: String, control: String): String =
91
+ when {
92
+ control.startsWith("http://", ignoreCase = true) ||
93
+ control.startsWith("https://", ignoreCase = true) -> control
94
+ control.startsWith("/") -> baseUrl + control
95
+ else -> "$baseUrl/$control"
96
+ }
97
+
98
+ /**
99
+ * Direct-child element text by tag name (first match), or "" — avoids matching nested devices.
100
+ */
101
+ private fun childText(parent: Element, tag: String): String =
102
+ directChildElement(parent, tag)?.textContent?.trim() ?: ""
103
+
104
+ /** The first direct-child [Element] with the given tag name, or null. */
105
+ private fun directChildElement(parent: Element, tag: String): Element? {
106
+ var node: Node? = parent.firstChild
107
+ while (node != null) {
108
+ if (node is Element && node.tagName.equals(tag, ignoreCase = true)) return node
109
+ node = node.nextSibling
110
+ }
111
+ return null
112
+ }
113
+ }
@@ -0,0 +1,39 @@
1
+ package com.audiobrowser.sonos
2
+
3
+ /**
4
+ * Builds the DIDL-Lite metadata Sonos takes as `SetAVTransportURI`'s `CurrentURIMetaData`. Blank
5
+ * fields are left out.
6
+ */
7
+ internal object DidlLite {
8
+ private const val HEADER =
9
+ "<DIDL-Lite xmlns=\"urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/\" " +
10
+ "xmlns:dc=\"http://purl.org/dc/elements/1.1/\" " +
11
+ "xmlns:upnp=\"urn:schemas-upnp-org:metadata-1-0/upnp/\">"
12
+
13
+ fun build(
14
+ title: String,
15
+ creator: String? = null,
16
+ album: String? = null,
17
+ albumArtUri: String? = null,
18
+ live: Boolean = true,
19
+ ): String {
20
+ val upnpClass =
21
+ if (live) "object.item.audioItem.audioBroadcast" else "object.item.audioItem.musicTrack"
22
+ return buildString {
23
+ append(HEADER)
24
+ append("<item id=\"R:0/0/0\" parentID=\"R:0/0\" restricted=\"true\">")
25
+ append("<dc:title>").append(xmlEscape(title)).append("</dc:title>")
26
+ append("<upnp:class>").append(upnpClass).append("</upnp:class>")
27
+ appendElement("dc:creator", creator)
28
+ appendElement("upnp:album", album)
29
+ appendElement("upnp:albumArtURI", albumArtUri)
30
+ append("</item></DIDL-Lite>")
31
+ }
32
+ }
33
+
34
+ private fun StringBuilder.appendElement(tag: String, value: String?) {
35
+ val v = value?.trim().orEmpty()
36
+ if (v.isEmpty()) return
37
+ append("<").append(tag).append(">").append(xmlEscape(v)).append("</").append(tag).append(">")
38
+ }
39
+ }
@@ -0,0 +1,59 @@
1
+ package com.audiobrowser.sonos
2
+
3
+ import java.util.concurrent.TimeUnit
4
+ import okhttp3.MediaType.Companion.toMediaType
5
+ import okhttp3.OkHttpClient
6
+ import okhttp3.Request
7
+ import okhttp3.RequestBody.Companion.toRequestBody
8
+
9
+ /**
10
+ * The HTTP client for the speakers, which answer on the local network within moments: a speaker
11
+ * that doesn't is gone, and waiting OkHttp's default 10 s per call would hold up every command.
12
+ */
13
+ internal val sonosHttpClient: OkHttpClient by lazy {
14
+ OkHttpClient.Builder()
15
+ .connectTimeout(3, TimeUnit.SECONDS)
16
+ .readTimeout(5, TimeUnit.SECONDS)
17
+ .writeTimeout(5, TimeUnit.SECONDS)
18
+ .build()
19
+ }
20
+
21
+ /** Thrown when a SOAP control call fails (non-2xx HTTP or a SOAP fault). */
22
+ internal class SoapException(message: String, val httpCode: Int?, val fault: SoapFault?) :
23
+ Exception(message)
24
+
25
+ /**
26
+ * Posts UPnP SOAP actions to a control URL, blocking. Returns the response body, or throws
27
+ * [SoapException] with any SOAP fault on a non-2xx response.
28
+ */
29
+ internal class SoapClient(private val httpClient: OkHttpClient) {
30
+ fun execute(controlUrl: String, action: SoapAction): String {
31
+ val body = action.body.toRequestBody(XML_MEDIA_TYPE)
32
+ val request =
33
+ Request.Builder()
34
+ .url(controlUrl)
35
+ // UPnP requires the SOAPACTION value be wrapped in double quotes.
36
+ .header("SOAPACTION", "\"${action.soapAction}\"")
37
+ .post(body)
38
+ .build()
39
+
40
+ httpClient.newCall(request).execute().use { response ->
41
+ val responseBody = response.speakerBody()
42
+ if (!response.isSuccessful) {
43
+ val fault = SoapResponseParser.fault(responseBody)
44
+ throw SoapException(
45
+ message =
46
+ "SOAP ${action.soapAction} failed: HTTP ${response.code}" +
47
+ (fault?.let { " UPnPError ${it.errorCode} ${it.errorDescription}" } ?: ""),
48
+ httpCode = response.code,
49
+ fault = fault,
50
+ )
51
+ }
52
+ return responseBody
53
+ }
54
+ }
55
+
56
+ private companion object {
57
+ val XML_MEDIA_TYPE = "text/xml; charset=\"utf-8\"".toMediaType()
58
+ }
59
+ }
@@ -0,0 +1,92 @@
1
+ package com.audiobrowser.sonos
2
+
3
+ import java.util.Locale
4
+
5
+ /** A UPnP SOAP request: the `SOAPACTION` header value (service#action) and the XML body. */
6
+ internal data class SoapAction(val soapAction: String, val body: String)
7
+
8
+ /**
9
+ * Builds the UPnP SOAP requests sent to a speaker. The DIDL metadata is a document escaped as the
10
+ * text of `CurrentURIMetaData`.
11
+ */
12
+ internal object SoapEnvelopes {
13
+ const val AV_TRANSPORT = "urn:schemas-upnp-org:service:AVTransport:1"
14
+ const val GROUP_RENDERING_CONTROL = "urn:schemas-upnp-org:service:GroupRenderingControl:1"
15
+ const val ZONE_GROUP_TOPOLOGY = "urn:schemas-upnp-org:service:ZoneGroupTopology:1"
16
+
17
+ fun setAvTransportUri(currentUri: String, metadata: String): SoapAction =
18
+ action(
19
+ AV_TRANSPORT,
20
+ "SetAVTransportURI",
21
+ "<InstanceID>0</InstanceID>" +
22
+ "<CurrentURI>${xmlEscape(currentUri)}</CurrentURI>" +
23
+ "<CurrentURIMetaData>${xmlEscape(metadata)}</CurrentURIMetaData>",
24
+ )
25
+
26
+ fun play(): SoapAction =
27
+ action(AV_TRANSPORT, "Play", "<InstanceID>0</InstanceID><Speed>1</Speed>")
28
+
29
+ fun pause(): SoapAction = action(AV_TRANSPORT, "Pause", "<InstanceID>0</InstanceID>")
30
+
31
+ fun stop(): SoapAction = action(AV_TRANSPORT, "Stop", "<InstanceID>0</InstanceID>")
32
+
33
+ /** Seeks within the current track, to [positionMs] rounded down to the second. */
34
+ fun seek(positionMs: Long): SoapAction {
35
+ val seconds = positionMs.coerceAtLeast(0) / 1000
36
+ val target =
37
+ String.format(Locale.ROOT, "%d:%02d:%02d", seconds / 3600, seconds / 60 % 60, seconds % 60)
38
+ return action(
39
+ AV_TRANSPORT,
40
+ "Seek",
41
+ "<InstanceID>0</InstanceID><Unit>REL_TIME</Unit><Target>$target</Target>",
42
+ )
43
+ }
44
+
45
+ fun getTransportInfo(): SoapAction =
46
+ action(AV_TRANSPORT, "GetTransportInfo", "<InstanceID>0</InstanceID>")
47
+
48
+ fun getMediaInfo(): SoapAction =
49
+ action(AV_TRANSPORT, "GetMediaInfo", "<InstanceID>0</InstanceID>")
50
+
51
+ fun getPositionInfo(): SoapAction =
52
+ action(AV_TRANSPORT, "GetPositionInfo", "<InstanceID>0</InstanceID>")
53
+
54
+ fun getZoneGroupState(): SoapAction = action(ZONE_GROUP_TOPOLOGY, "GetZoneGroupState", "")
55
+
56
+ /** The volume of the coordinator's whole group, which is the room's own when it plays alone. */
57
+ fun setGroupVolume(volume: Int): SoapAction =
58
+ action(
59
+ GROUP_RENDERING_CONTROL,
60
+ "SetGroupVolume",
61
+ "<InstanceID>0</InstanceID><DesiredVolume>${volume.coerceIn(0, 100)}</DesiredVolume>",
62
+ )
63
+
64
+ fun getGroupVolume(): SoapAction =
65
+ action(GROUP_RENDERING_CONTROL, "GetGroupVolume", "<InstanceID>0</InstanceID>")
66
+
67
+ private fun action(service: String, name: String, args: String): SoapAction =
68
+ SoapAction(
69
+ soapAction = "$service#$name",
70
+ body =
71
+ "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
72
+ "<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\" " +
73
+ "s:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">" +
74
+ "<s:Body>" +
75
+ "<u:$name xmlns:u=\"$service\">$args</u:$name>" +
76
+ "</s:Body></s:Envelope>",
77
+ )
78
+ }
79
+
80
+ /** [s] as XML text or attribute content. */
81
+ internal fun xmlEscape(s: String): String =
82
+ s.replace(XML_FORBIDDEN, "")
83
+ .replace("&", "&amp;")
84
+ .replace("<", "&lt;")
85
+ .replace(">", "&gt;")
86
+ .replace("\"", "&quot;")
87
+ // &#39; rather than &apos;, which some older XML readers, older Sonos firmware among them,
88
+ // mishandle.
89
+ .replace("'", "&#39;")
90
+
91
+ // The characters XML 1.0 has no place for, even escaped.
92
+ private val XML_FORBIDDEN = Regex("[\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\uFFFE\\uFFFF]")
@@ -0,0 +1,105 @@
1
+ package com.audiobrowser.sonos
2
+
3
+ import org.w3c.dom.Document
4
+
5
+ /** A parsed UPnP SOAP fault (the `<UPnPError>` detail). */
6
+ internal data class SoapFault(val errorCode: Int?, val errorDescription: String?)
7
+
8
+ /** Parses the UPnP SOAP responses the speakers send. Each returns null when its field is absent. */
9
+ internal object SoapResponseParser {
10
+ /** Parses a SOAP fault envelope into its UPnP error, or null when the response is not a fault. */
11
+ fun fault(xml: String): SoapFault? {
12
+ val doc = parse(xml) ?: return null
13
+ return faultOf(doc)
14
+ }
15
+
16
+ /**
17
+ * The `<CurrentTransportState>` text from a `GetTransportInfo` response, or null (incl. faults).
18
+ */
19
+ fun transportState(xml: String): String? {
20
+ val doc = parse(xml) ?: return null
21
+ if (faultOf(doc) != null) return null
22
+ return firstText(doc, "CurrentTransportState")
23
+ }
24
+
25
+ /** The `<CurrentVolume>` integer from a `GetGroupVolume` response, or null (incl. faults). */
26
+ fun volume(xml: String): Int? {
27
+ val doc = parse(xml) ?: return null
28
+ if (faultOf(doc) != null) return null
29
+ return firstText(doc, "CurrentVolume")?.toIntOrNull()
30
+ }
31
+
32
+ /**
33
+ * The title the speaker reads from the stream (ICY `StreamTitle`, or an HLS stream's ID3), as
34
+ * `r:streamContent` in a `GetPositionInfo` response's `TrackMetaData`; null when there is none.
35
+ */
36
+ fun streamContent(xml: String): String? {
37
+ val metadata = embeddedDocument(xml, "TrackMetaData") ?: return null
38
+ return firstText(metadata, "r:streamContent")
39
+ }
40
+
41
+ /**
42
+ * The position, duration and stream title from a `GetPositionInfo` response, or null (incl.
43
+ * faults). A time the speaker doesn't report (`NOT_IMPLEMENTED`, or a live stream's empty
44
+ * duration) is null.
45
+ */
46
+ fun position(xml: String): SonosPosition? {
47
+ val doc = parse(xml) ?: return null
48
+ if (faultOf(doc) != null) return null
49
+ return SonosPosition(
50
+ streamContent = streamContent(xml),
51
+ positionMs = firstText(doc, "RelTime")?.let(::upnpTimeMs),
52
+ durationMs = firstText(doc, "TrackDuration")?.let(::upnpTimeMs)?.takeIf { it > 0 },
53
+ )
54
+ }
55
+
56
+ /** The `<CurrentURI>` from a `GetMediaInfo` response, or null (incl. faults). */
57
+ fun currentUri(xml: String): String? {
58
+ val doc = parse(xml) ?: return null
59
+ if (faultOf(doc) != null) return null
60
+ return firstText(doc, "CurrentURI")
61
+ }
62
+
63
+ /** `H+:MM:SS` (with optional fractions) in milliseconds, or null for anything else. */
64
+ private fun upnpTimeMs(time: String): Long? {
65
+ val parts = time.split(':')
66
+ if (parts.size != 3) return null
67
+ val hours = parts[0].toLongOrNull() ?: return null
68
+ val minutes = parts[1].toLongOrNull() ?: return null
69
+ val seconds = parts[2].toDoubleOrNull() ?: return null
70
+ return (hours * 3600 + minutes * 60) * 1000 + (seconds * 1000).toLong()
71
+ }
72
+
73
+ /** The text of a SOAP response's [tag], itself an XML document escaped inside it. */
74
+ internal fun embeddedDocument(xml: String, tag: String): Document? {
75
+ val doc = parse(xml) ?: return null
76
+ if (faultOf(doc) != null) return null
77
+ return parse(firstText(doc, tag) ?: return null)
78
+ }
79
+
80
+ /** Reads a UPnP fault off an already-parsed document, or null when it is not a fault. */
81
+ private fun faultOf(doc: Document): SoapFault? {
82
+ if (!hasElement(doc, "Fault")) return null
83
+ return SoapFault(firstText(doc, "errorCode")?.toIntOrNull(), firstText(doc, "errorDescription"))
84
+ }
85
+
86
+ /**
87
+ * True if any element has the given local name, regardless of namespace prefix (`s:Fault`, …).
88
+ */
89
+ private fun hasElement(doc: Document, localName: String): Boolean {
90
+ val all = doc.getElementsByTagName("*")
91
+ for (i in 0 until all.length) {
92
+ val tag = all.item(i).nodeName
93
+ if (tag == localName || tag.endsWith(":$localName")) return true
94
+ }
95
+ return false
96
+ }
97
+
98
+ private fun parse(xml: String): Document? = parseSpeakerXml(xml)
99
+
100
+ private fun firstText(doc: Document, tag: String): String? {
101
+ val nodes = doc.getElementsByTagName(tag)
102
+ if (nodes.length == 0) return null
103
+ return nodes.item(0).textContent?.trim()?.takeIf { it.isNotEmpty() }
104
+ }
105
+ }
@@ -0,0 +1,69 @@
1
+ package com.audiobrowser.sonos
2
+
3
+ import okhttp3.OkHttpClient
4
+ import okhttp3.Request
5
+ import timber.log.Timber
6
+
7
+ /** Runs an SSDP M-SEARCH and returns the raw responses. */
8
+ internal interface SsdpScanner {
9
+ fun search(timeoutMs: Int = 3000, repeats: Int = 3): List<SsdpResponse>
10
+ }
11
+
12
+ /**
13
+ * Finds the Sonos rooms on the local network: an SSDP search finds speakers, the first that answers
14
+ * gives the household's group topology, and each group's coordinator gives its control URLs. Finds
15
+ * none when the speakers refuse UPnP (HTTP 403, the user's switch in the Sonos app). Blocking: run
16
+ * off the main thread.
17
+ */
18
+ internal class SonosDiscoverer(
19
+ private val httpClient: OkHttpClient,
20
+ private val scanner: SsdpScanner,
21
+ ) {
22
+ private val soap = SoapClient(httpClient)
23
+
24
+ fun discover(timeoutMs: Int = 3000): List<SonosRoom> {
25
+ val locations = scanner.search(timeoutMs).map { it.location }.distinct()
26
+ val groups = locations.firstNotNullOfOrNull { groupsFrom(it) } ?: return emptyList()
27
+ return groups.mapNotNull { group ->
28
+ fetchDevice(group.location)?.let {
29
+ SonosRoom(id = group.coordinator, name = group.name, device = it)
30
+ }
31
+ }
32
+ }
33
+
34
+ /**
35
+ * The groups the speaker at [location] reports, or null when it cannot be read or is a hidden
36
+ * speaker, whose view can be missing groups.
37
+ */
38
+ private fun groupsFrom(location: String): List<SonosGroup>? {
39
+ val device = fetchDevice(location) ?: return null
40
+ val controlUrl = device.zoneGroupTopologyControlUrl ?: return null
41
+ return try {
42
+ val xml = soap.execute(controlUrl, SoapEnvelopes.getZoneGroupState())
43
+ if (ZoneGroupState.isHidden(xml, device.udn.removePrefix("uuid:"))) null
44
+ else ZoneGroupState.parse(xml)
45
+ } catch (e: Exception) {
46
+ if (e is SoapException && e.httpCode == 403) {
47
+ Timber.w("Sonos at %s refuses UPnP: it is switched off in the Sonos app", location)
48
+ } else {
49
+ Timber.w(e, "Failed to read the Sonos topology from %s", location)
50
+ }
51
+ null
52
+ }
53
+ }
54
+
55
+ /** Fetches and parses a device description, or null on any HTTP or parse failure. */
56
+ fun fetchDevice(location: String): SonosDevice? {
57
+ val xml =
58
+ try {
59
+ httpClient.newCall(Request.Builder().url(location).build()).execute().use { response ->
60
+ if (!response.isSuccessful) return null
61
+ response.speakerBody()
62
+ }
63
+ } catch (e: Exception) {
64
+ Timber.w(e, "Failed to fetch Sonos device description from %s", location)
65
+ return null
66
+ }
67
+ return DeviceDescriptionParser.parse(xml, location)
68
+ }
69
+ }
@@ -0,0 +1,128 @@
1
+ package com.audiobrowser.sonos
2
+
3
+ import android.Manifest
4
+ import android.content.ComponentName
5
+ import android.content.Context
6
+ import android.content.pm.PackageManager
7
+ import androidx.annotation.MainThread
8
+ import java.util.concurrent.ConcurrentHashMap
9
+ import java.util.concurrent.CopyOnWriteArraySet
10
+ import timber.log.Timber
11
+
12
+ /**
13
+ * Sonos rooms as remote outputs, over UPnP: whether the system may bind
14
+ * [SonosRouteProviderService], the room selected in the Output Switcher, and its volume. While a
15
+ * session plays on the room, its volume goes through that session, which reads it back; the route
16
+ * provider shows it.
17
+ */
18
+ internal object SonosOutputs {
19
+ /**
20
+ * The control category a Sonos room's route declares beside
21
+ * [com.audiobrowser.RemoteOutputs.CATEGORY].
22
+ */
23
+ const val CATEGORY = "com.audiobrowser.CATEGORY_SONOS"
24
+
25
+ /** The room playback goes to, or null. Written on the main thread, read from any. */
26
+ @Volatile
27
+ var selected: SonosRoom? = null
28
+ private set
29
+
30
+ private val listeners = CopyOnWriteArraySet<() -> Unit>()
31
+ private val volumeListeners = CopyOnWriteArraySet<() -> Unit>()
32
+ private val volumes = ConcurrentHashMap<String, Int>()
33
+
34
+ /** The session playing on room [roomId], and how it sets the room's volume. */
35
+ private class Session(val roomId: String, val setVolume: (Int) -> Unit)
36
+
37
+ private var session: Session? = null
38
+
39
+ /**
40
+ * Enables or disables the provider service. The component state persists, so the system can bind
41
+ * the service before the app has set up its player. Disabling forgets the selected room.
42
+ */
43
+ @MainThread
44
+ fun setEnabled(context: Context, enabled: Boolean) {
45
+ if (!enabled) selected?.let(::unselect)
46
+ if (enabled && !canHoldMulticastLock(context)) {
47
+ Timber.w(
48
+ "Sonos: the app's manifest doesn't declare CHANGE_WIFI_MULTICAST_STATE, so Sonos discovery runs without a multicast lock and can miss rooms"
49
+ )
50
+ }
51
+ val component = ComponentName(context, SonosRouteProviderService::class.java)
52
+ val state =
53
+ if (enabled) PackageManager.COMPONENT_ENABLED_STATE_ENABLED
54
+ else PackageManager.COMPONENT_ENABLED_STATE_DISABLED
55
+ if (context.packageManager.getComponentEnabledSetting(component) == state) return
56
+ context.packageManager.setComponentEnabledSetting(
57
+ component,
58
+ state,
59
+ PackageManager.DONT_KILL_APP,
60
+ )
61
+ }
62
+
63
+ /** Calls [listener] on the main thread whenever [selected] changes. */
64
+ fun addListener(listener: () -> Unit) {
65
+ listeners.add(listener)
66
+ }
67
+
68
+ fun removeListener(listener: () -> Unit) {
69
+ listeners.remove(listener)
70
+ }
71
+
72
+ /** [roomId]'s volume as last read or set, from 0 to 100, or null before either. */
73
+ fun volumeOf(roomId: String): Int? = volumes[roomId]
74
+
75
+ /** Records [roomId]'s volume as read or set, and tells the volume listeners. */
76
+ @MainThread
77
+ fun reportVolume(roomId: String, volume: Int) {
78
+ if (volumes.put(roomId, volume) == volume) return
79
+ volumeListeners.forEach { it() }
80
+ }
81
+
82
+ /** Calls [listener] on the main thread whenever a room's volume changes. */
83
+ fun addVolumeListener(listener: () -> Unit) {
84
+ volumeListeners.add(listener)
85
+ }
86
+
87
+ fun removeVolumeListener(listener: () -> Unit) {
88
+ volumeListeners.remove(listener)
89
+ }
90
+
91
+ /** While a session plays on [roomId], [setVolume] sets its volume; null when it ends. */
92
+ @MainThread
93
+ fun setSession(roomId: String, setVolume: ((Int) -> Unit)?) {
94
+ if (setVolume != null) session = Session(roomId, setVolume)
95
+ else if (session?.roomId == roomId) session = null
96
+ }
97
+
98
+ /** Whether a session plays on [roomId]. */
99
+ fun hasSession(roomId: String): Boolean = session?.roomId == roomId
100
+
101
+ /** Sets [roomId]'s volume through the session playing there: false when none does. */
102
+ @MainThread
103
+ fun setVolumeThroughSession(roomId: String, volume: Int): Boolean {
104
+ val session = session ?: return false
105
+ if (session.roomId != roomId) return false
106
+ session.setVolume(volume)
107
+ return true
108
+ }
109
+
110
+ internal fun canHoldMulticastLock(context: Context) =
111
+ context.checkSelfPermission(Manifest.permission.CHANGE_WIFI_MULTICAST_STATE) ==
112
+ PackageManager.PERMISSION_GRANTED
113
+
114
+ @MainThread
115
+ internal fun select(room: SonosRoom) {
116
+ if (selected == room) return
117
+ selected = room
118
+ listeners.forEach { it() }
119
+ }
120
+
121
+ /** Clears the selection, unless another room was selected since [room]. */
122
+ @MainThread
123
+ internal fun unselect(room: SonosRoom) {
124
+ if (selected?.id != room.id) return
125
+ selected = null
126
+ listeners.forEach { it() }
127
+ }
128
+ }