react-native-audio-browser 0.2.0-next.53 → 0.2.0-next.54

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 (329) hide show
  1. package/android/src/cast/java/com/audiobrowser/cast/CastSupport.kt +8 -10
  2. package/android/src/main/java/com/audiobrowser/AudioBrowser.kt +96 -243
  3. package/android/src/main/java/com/audiobrowser/AudioBrowserLifecycleModule.kt +8 -12
  4. package/android/src/main/java/com/audiobrowser/AudioBrowserPackage.kt +1 -3
  5. package/android/src/main/java/com/audiobrowser/Callbacks.kt +1 -10
  6. package/android/src/main/java/com/audiobrowser/ForegroundStart.kt +13 -18
  7. package/android/src/main/java/com/audiobrowser/HeadlessTaskService.kt +3 -7
  8. package/android/src/main/java/com/audiobrowser/RemoteOutputs.kt +8 -10
  9. package/android/src/main/java/com/audiobrowser/Service.kt +20 -61
  10. package/android/src/main/java/com/audiobrowser/ServiceBinding.kt +9 -17
  11. package/android/src/main/java/com/audiobrowser/browser/ArtworkResolutionRegistry.kt +10 -9
  12. package/android/src/main/java/com/audiobrowser/browser/BrowseArtworkRegistry.kt +11 -8
  13. package/android/src/main/java/com/audiobrowser/browser/BrowserManager.kt +117 -448
  14. package/android/src/main/java/com/audiobrowser/browser/BrowserUrlResolution.kt +21 -60
  15. package/android/src/main/java/com/audiobrowser/browser/InertStyleDiagnostic.kt +20 -80
  16. package/android/src/main/java/com/audiobrowser/browser/JsonArtwork.kt +6 -10
  17. package/android/src/main/java/com/audiobrowser/browser/JsonModels.kt +7 -24
  18. package/android/src/main/java/com/audiobrowser/browser/RouteMatch.kt +2 -4
  19. package/android/src/main/java/com/audiobrowser/browser/SectionScope.kt +13 -31
  20. package/android/src/main/java/com/audiobrowser/browser/SimpleRouter.kt +12 -40
  21. package/android/src/main/java/com/audiobrowser/browser/StyleResolver.kt +15 -26
  22. package/android/src/main/java/com/audiobrowser/browser/TrackLoadHandler.kt +5 -15
  23. package/android/src/main/java/com/audiobrowser/extension/EnumExtensions.kt +1 -0
  24. package/android/src/main/java/com/audiobrowser/extension/NumberExt.kt +2 -0
  25. package/android/src/main/java/com/audiobrowser/extension/ResolvedTrackExt.kt +4 -8
  26. package/android/src/main/java/com/audiobrowser/extension/TappedTrack.kt +4 -6
  27. package/android/src/main/java/com/audiobrowser/extension/TrackIdentity.kt +3 -7
  28. package/android/src/main/java/com/audiobrowser/http/HttpClient.kt +13 -22
  29. package/android/src/main/java/com/audiobrowser/http/RequestConfigBuilder.kt +17 -38
  30. package/android/src/main/java/com/audiobrowser/model/IcyTitle.kt +5 -6
  31. package/android/src/main/java/com/audiobrowser/model/PlaybackMetadata.kt +4 -9
  32. package/android/src/main/java/com/audiobrowser/model/PlayerSetupOptions.kt +18 -29
  33. package/android/src/main/java/com/audiobrowser/model/PlayerUpdateOptions.kt +6 -16
  34. package/android/src/main/java/com/audiobrowser/player/AutomaticBufferManager.kt +15 -45
  35. package/android/src/main/java/com/audiobrowser/player/CapabilityControls.kt +23 -59
  36. package/android/src/main/java/com/audiobrowser/player/CrossOriginHeaderStripper.kt +14 -26
  37. package/android/src/main/java/com/audiobrowser/player/DynamicLoadControl.kt +15 -43
  38. package/android/src/main/java/com/audiobrowser/player/EnginePlayback.kt +4 -4
  39. package/android/src/main/java/com/audiobrowser/player/EqualizerController.kt +15 -21
  40. package/android/src/main/java/com/audiobrowser/player/InterceptingPlayer.kt +14 -31
  41. package/android/src/main/java/com/audiobrowser/player/LocalEngine.kt +8 -8
  42. package/android/src/main/java/com/audiobrowser/player/MediaFactory.kt +16 -27
  43. package/android/src/main/java/com/audiobrowser/player/MediaSessionCallback.kt +119 -237
  44. package/android/src/main/java/com/audiobrowser/player/MediaSessionCommandManager.kt +48 -145
  45. package/android/src/main/java/com/audiobrowser/player/NowPlayingUpdater.kt +39 -100
  46. package/android/src/main/java/com/audiobrowser/player/PlaybackErrorClassifier.kt +16 -26
  47. package/android/src/main/java/com/audiobrowser/player/PlaybackStateMachine.kt +22 -28
  48. package/android/src/main/java/com/audiobrowser/player/PlaybackStateStore.kt +28 -64
  49. package/android/src/main/java/com/audiobrowser/player/PlaybackTimer.kt +8 -4
  50. package/android/src/main/java/com/audiobrowser/player/Player.kt +117 -405
  51. package/android/src/main/java/com/audiobrowser/player/PlayerCapabilitiesExt.kt +1 -1
  52. package/android/src/main/java/com/audiobrowser/player/PlayerEngineFactory.kt +11 -19
  53. package/android/src/main/java/com/audiobrowser/player/PlayerListener.kt +30 -96
  54. package/android/src/main/java/com/audiobrowser/player/RetryLoadErrorHandlingPolicy.kt +39 -95
  55. package/android/src/main/java/com/audiobrowser/player/ShuffleOrderLedBy.kt +7 -13
  56. package/android/src/main/java/com/audiobrowser/player/SleepTimer.kt +13 -30
  57. package/android/src/main/java/com/audiobrowser/player/SleepTimerManager.kt +7 -11
  58. package/android/src/main/java/com/audiobrowser/player/StuckRecoveryPolicy.kt +9 -22
  59. package/android/src/main/java/com/audiobrowser/player/TransformingDataSource.kt +22 -54
  60. package/android/src/main/java/com/audiobrowser/player/VolumeFader.kt +8 -15
  61. package/android/src/main/java/com/audiobrowser/remote/RemoteItem.kt +9 -8
  62. package/android/src/main/java/com/audiobrowser/remote/RemoteOutputsController.kt +13 -10
  63. package/android/src/main/java/com/audiobrowser/remote/RemotePlayback.kt +8 -8
  64. package/android/src/main/java/com/audiobrowser/remote/RemoteQueue.kt +12 -5
  65. package/android/src/main/java/com/audiobrowser/remote/RemoteSwitchingPlayer.kt +28 -48
  66. package/android/src/main/java/com/audiobrowser/sonos/DeviceDescriptionParser.kt +11 -19
  67. package/android/src/main/java/com/audiobrowser/sonos/DidlLite.kt +2 -2
  68. package/android/src/main/java/com/audiobrowser/sonos/SoapClient.kt +6 -6
  69. package/android/src/main/java/com/audiobrowser/sonos/SoapEnvelopes.kt +8 -9
  70. package/android/src/main/java/com/audiobrowser/sonos/SoapResponseParser.kt +11 -18
  71. package/android/src/main/java/com/audiobrowser/sonos/SonosDiscoverer.kt +10 -10
  72. package/android/src/main/java/com/audiobrowser/sonos/SonosOutputs.kt +10 -10
  73. package/android/src/main/java/com/audiobrowser/sonos/SonosPlayer.kt +21 -33
  74. package/android/src/main/java/com/audiobrowser/sonos/SonosRemote.kt +4 -6
  75. package/android/src/main/java/com/audiobrowser/sonos/SonosRouteProviderService.kt +9 -10
  76. package/android/src/main/java/com/audiobrowser/sonos/SonosStreamUri.kt +7 -7
  77. package/android/src/main/java/com/audiobrowser/sonos/SonosTransport.kt +5 -4
  78. package/android/src/main/java/com/audiobrowser/sonos/SsdpDiscovery.kt +8 -3
  79. package/android/src/main/java/com/audiobrowser/sonos/SsdpMessages.kt +4 -6
  80. package/android/src/main/java/com/audiobrowser/sonos/ZoneGroupState.kt +13 -11
  81. package/android/src/main/java/com/audiobrowser/tls/AiaCertChaser.kt +34 -71
  82. package/android/src/main/java/com/audiobrowser/tls/AiaChasingExtendedTrustManager.kt +20 -37
  83. package/android/src/main/java/com/audiobrowser/tls/AiaChasingTrustManager.kt +18 -27
  84. package/android/src/main/java/com/audiobrowser/tls/AiaTls.kt +14 -29
  85. package/android/src/main/java/com/audiobrowser/tls/CachingCertificateFetcher.kt +68 -133
  86. package/android/src/main/java/com/audiobrowser/util/ArtworkContentProvider.kt +10 -22
  87. package/android/src/main/java/com/audiobrowser/util/ArtworkRoutes.kt +6 -6
  88. package/android/src/main/java/com/audiobrowser/util/ArtworkUris.kt +4 -3
  89. package/android/src/main/java/com/audiobrowser/util/ArtworkVariant.kt +2 -13
  90. package/android/src/main/java/com/audiobrowser/util/Automotive.kt +2 -4
  91. package/android/src/main/java/com/audiobrowser/util/BatteryOptimizationHelper.kt +3 -9
  92. package/android/src/main/java/com/audiobrowser/util/BatteryWarningStore.kt +4 -14
  93. package/android/src/main/java/com/audiobrowser/util/BrowserPathHelper.kt +21 -85
  94. package/android/src/main/java/com/audiobrowser/util/CoilArtworkLoader.kt +7 -7
  95. package/android/src/main/java/com/audiobrowser/util/CoilArtworkLoaderHolder.kt +5 -8
  96. package/android/src/main/java/com/audiobrowser/util/CoilBitmapLoader.kt +8 -24
  97. package/android/src/main/java/com/audiobrowser/util/EqualizerManager.kt +7 -39
  98. package/android/src/main/java/com/audiobrowser/util/MediaExtrasBuilder.kt +10 -14
  99. package/android/src/main/java/com/audiobrowser/util/MetadataAdapter.kt +5 -9
  100. package/android/src/main/java/com/audiobrowser/util/NetworkConnectivityMonitor.kt +5 -9
  101. package/android/src/main/java/com/audiobrowser/util/OutputMonitor.kt +21 -50
  102. package/android/src/main/java/com/audiobrowser/util/OutputSwitcher.kt +7 -20
  103. package/android/src/main/java/com/audiobrowser/util/PlayingStateFactory.kt +3 -5
  104. package/android/src/main/java/com/audiobrowser/util/RatingFavorites.kt +4 -5
  105. package/android/src/main/java/com/audiobrowser/util/StyleWire.kt +5 -5
  106. package/android/src/main/java/com/audiobrowser/util/SvgArtworkRenderer.kt +5 -9
  107. package/android/src/main/java/com/audiobrowser/util/SystemVolumeMonitor.kt +6 -9
  108. package/android/src/main/java/com/audiobrowser/util/TrackFactory.kt +25 -47
  109. package/android/src/nocast/java/com/audiobrowser/cast/CastSupport.kt +0 -2
  110. package/android/src/test/java/com/audiobrowser/ForegroundStartTest.kt +1 -2
  111. package/android/src/test/java/com/audiobrowser/LegacyRatingTest.kt +3 -3
  112. package/android/src/test/java/com/audiobrowser/ServiceBindingTest.kt +0 -13
  113. package/android/src/test/java/com/audiobrowser/ServiceTaskRemovedTest.kt +2 -3
  114. package/android/src/test/java/com/audiobrowser/TestFixtures.kt +5 -14
  115. package/android/src/test/java/com/audiobrowser/browser/BrowseArtworkRegistryTest.kt +1 -1
  116. package/android/src/test/java/com/audiobrowser/browser/BrowserManagerBuildApiRequestTest.kt +2 -8
  117. package/android/src/test/java/com/audiobrowser/browser/BrowserManagerFavoritesTest.kt +2 -12
  118. package/android/src/test/java/com/audiobrowser/browser/BrowserManagerLayerResolutionTest.kt +5 -28
  119. package/android/src/test/java/com/audiobrowser/browser/BrowserManagerTest.kt +11 -43
  120. package/android/src/test/java/com/audiobrowser/browser/BrowserUrlResolutionTest.kt +4 -13
  121. package/android/src/test/java/com/audiobrowser/browser/InertStyleDiagnosticTest.kt +2 -11
  122. package/android/src/test/java/com/audiobrowser/browser/JsonArtworkTest.kt +0 -2
  123. package/android/src/test/java/com/audiobrowser/browser/JsonStyleTest.kt +3 -8
  124. package/android/src/test/java/com/audiobrowser/browser/SectionScopeTest.kt +2 -14
  125. package/android/src/test/java/com/audiobrowser/browser/SimpleRouterTest.kt +1 -5
  126. package/android/src/test/java/com/audiobrowser/browser/StyleResolverTest.kt +2 -13
  127. package/android/src/test/java/com/audiobrowser/extension/TappedTrackTest.kt +1 -7
  128. package/android/src/test/java/com/audiobrowser/extension/TrackIdentityTest.kt +0 -5
  129. package/android/src/test/java/com/audiobrowser/http/RequestConfigBuilderTest.kt +8 -16
  130. package/android/src/test/java/com/audiobrowser/model/IcyTitleTest.kt +1 -1
  131. package/android/src/test/java/com/audiobrowser/player/BrowseTilesTest.kt +12 -29
  132. package/android/src/test/java/com/audiobrowser/player/CapabilityControlsTest.kt +3 -12
  133. package/android/src/test/java/com/audiobrowser/player/CrossOriginHeaderStripperTest.kt +0 -7
  134. package/android/src/test/java/com/audiobrowser/player/DynamicLoadControlTest.kt +0 -1
  135. package/android/src/test/java/com/audiobrowser/player/EqualizerControllerTest.kt +0 -9
  136. package/android/src/test/java/com/audiobrowser/player/LiveSeekCommandTest.kt +1 -2
  137. package/android/src/test/java/com/audiobrowser/player/MediaSessionSlotMappingTest.kt +0 -9
  138. package/android/src/test/java/com/audiobrowser/player/NowPlayingUpdaterTest.kt +15 -22
  139. package/android/src/test/java/com/audiobrowser/player/PlaybackErrorClassifierTest.kt +1 -24
  140. package/android/src/test/java/com/audiobrowser/player/PlaybackStateMachineTest.kt +0 -20
  141. package/android/src/test/java/com/audiobrowser/player/PlaybackStateStoreTrackJsonTest.kt +1 -6
  142. package/android/src/test/java/com/audiobrowser/player/PlaybackTimerTest.kt +2 -4
  143. package/android/src/test/java/com/audiobrowser/player/PlayerCastTest.kt +2 -2
  144. package/android/src/test/java/com/audiobrowser/player/PlayerEngineFactoryTest.kt +0 -3
  145. package/android/src/test/java/com/audiobrowser/player/PlayerInvalidTrackTest.kt +0 -1
  146. package/android/src/test/java/com/audiobrowser/player/PlayerSetupTest.kt +3 -2
  147. package/android/src/test/java/com/audiobrowser/player/PlayerSonosTest.kt +5 -1
  148. package/android/src/test/java/com/audiobrowser/player/PlayerSuppressionTest.kt +5 -7
  149. package/android/src/test/java/com/audiobrowser/player/RetryLoadErrorHandlingPolicyTest.kt +4 -35
  150. package/android/src/test/java/com/audiobrowser/player/SessionErrorMaskTest.kt +0 -5
  151. package/android/src/test/java/com/audiobrowser/player/ShuffleOrderLedByTest.kt +1 -8
  152. package/android/src/test/java/com/audiobrowser/player/StandardSkipTest.kt +4 -6
  153. package/android/src/test/java/com/audiobrowser/player/StuckRecoveryPolicyTest.kt +11 -11
  154. package/android/src/test/java/com/audiobrowser/player/TransformingDataSourceTest.kt +2 -23
  155. package/android/src/test/java/com/audiobrowser/remote/FakeRemote.kt +9 -10
  156. package/android/src/test/java/com/audiobrowser/remote/RemoteSwitchingPlayerTest.kt +0 -1
  157. package/android/src/test/java/com/audiobrowser/sonos/DeviceDescriptionParserTest.kt +1 -3
  158. package/android/src/test/java/com/audiobrowser/sonos/DidlLiteTest.kt +0 -1
  159. package/android/src/test/java/com/audiobrowser/sonos/SoapClientTest.kt +0 -3
  160. package/android/src/test/java/com/audiobrowser/sonos/SoapEnvelopesTest.kt +0 -1
  161. package/android/src/test/java/com/audiobrowser/sonos/SoapResponseParserTest.kt +0 -1
  162. package/android/src/test/java/com/audiobrowser/sonos/SonosDiscovererTest.kt +2 -0
  163. package/android/src/test/java/com/audiobrowser/sonos/SonosPlayerTest.kt +0 -1
  164. package/android/src/test/java/com/audiobrowser/sonos/SonosRemoteTest.kt +1 -1
  165. package/android/src/test/java/com/audiobrowser/sonos/SonosRoutesTest.kt +2 -0
  166. package/android/src/test/java/com/audiobrowser/sonos/SonosTransportTest.kt +2 -6
  167. package/android/src/test/java/com/audiobrowser/sonos/SsdpMessagesTest.kt +0 -2
  168. package/android/src/test/java/com/audiobrowser/tls/AiaCertChaserTest.kt +13 -37
  169. package/android/src/test/java/com/audiobrowser/tls/AiaChasingTrustManagerTest.kt +10 -24
  170. package/android/src/test/java/com/audiobrowser/tls/CachingCertificateFetcherCallSiteTest.kt +15 -39
  171. package/android/src/test/java/com/audiobrowser/tls/CachingCertificateFetcherTest.kt +4 -10
  172. package/android/src/test/java/com/audiobrowser/util/ArtworkContentProviderTest.kt +2 -11
  173. package/android/src/test/java/com/audiobrowser/util/ArtworkUrisTest.kt +0 -1
  174. package/android/src/test/java/com/audiobrowser/util/BrowserPathHelperTest.kt +0 -4
  175. package/android/src/test/java/com/audiobrowser/util/CoilArtworkLoaderHolderTest.kt +1 -1
  176. package/android/src/test/java/com/audiobrowser/util/CoilArtworkLoaderTest.kt +0 -5
  177. package/android/src/test/java/com/audiobrowser/util/FakeImageLoader.kt +2 -2
  178. package/android/src/test/java/com/audiobrowser/util/MediaExtrasBuilderTest.kt +4 -12
  179. package/android/src/test/java/com/audiobrowser/util/OutputMonitorTest.kt +1 -1
  180. package/android/src/test/java/com/audiobrowser/util/PlayingStateFactoryTest.kt +0 -4
  181. package/android/src/test/java/com/audiobrowser/util/TrackFactoryBrowseTest.kt +1 -1
  182. package/android/src/test/java/com/audiobrowser/util/TrackFactoryMediaIdTest.kt +4 -6
  183. package/android/src/testCast/java/com/audiobrowser/cast/CastEndsTest.kt +1 -1
  184. package/android/src/testCast/java/com/audiobrowser/cast/SendingMediaItemConverterTest.kt +1 -0
  185. package/ios/AVPlayerEngine.swift +13 -21
  186. package/ios/AVPlayerEngineCallbacks.swift +2 -4
  187. package/ios/Browser/BrowseGate.swift +7 -8
  188. package/ios/Browser/BrowserConfig.swift +19 -34
  189. package/ios/Browser/BrowserError.swift +0 -1
  190. package/ios/Browser/BrowserManager.swift +29 -75
  191. package/ios/Browser/BrowserPathHelper.swift +13 -93
  192. package/ios/Browser/FavoriteSet.swift +7 -10
  193. package/ios/Browser/InertStyleDiagnostic.swift +17 -82
  194. package/ios/Browser/JsonModels.swift +11 -51
  195. package/ios/Browser/NavigationErrorState.swift +3 -2
  196. package/ios/Browser/PageResolver.swift +13 -23
  197. package/ios/Browser/RequestLayer.swift +16 -20
  198. package/ios/Browser/RequestPipeline.swift +33 -43
  199. package/ios/Browser/SearchDrillIn.swift +7 -13
  200. package/ios/Browser/SectionScope.swift +14 -26
  201. package/ios/Browser/SimpleRouter.swift +8 -15
  202. package/ios/Browser/StyleResolver.swift +12 -29
  203. package/ios/Browser/TabBarEntries.swift +6 -11
  204. package/ios/Browser/TrackIdTemplate.swift +6 -14
  205. package/ios/CarPlay/CPInterfaceController+Safe.swift +19 -28
  206. package/ios/CarPlay/CarPlayArtworkResolver.swift +5 -9
  207. package/ios/CarPlay/CarPlayController.swift +4 -4
  208. package/ios/CarPlay/CarPlayImageLoader.swift +11 -26
  209. package/ios/CarPlay/CarPlayListItemFactory.swift +30 -80
  210. package/ios/CarPlay/CarPlayNowPlayingManager.swift +19 -54
  211. package/ios/CarPlay/CarPlaySession+Navigator.swift +10 -10
  212. package/ios/CarPlay/CarPlaySession+PageLoader.swift +6 -5
  213. package/ios/CarPlay/CarPlaySession+Refresher.swift +2 -2
  214. package/ios/CarPlay/CarPlaySession+TabBar.swift +19 -26
  215. package/ios/CarPlay/CarPlaySession.swift +13 -17
  216. package/ios/CarPlay/CarPlayTemplates.swift +6 -7
  217. package/ios/CarPlay/IntentHandlers.swift +3 -5
  218. package/ios/CarPlay/MediaIntentCriteria.swift +15 -29
  219. package/ios/CarPlay/MediaIntentHandler.swift +4 -7
  220. package/ios/CarPlay/MediaIntentPlayback.swift +9 -8
  221. package/ios/CarPlay/NowPlayingButtonRules.swift +3 -4
  222. package/ios/CarPlay/SectionPresentation.swift +18 -28
  223. package/ios/CarPlay/TopTemplateReplacer.swift +8 -9
  224. package/ios/Extension/Capability+RemoteCommand.swift +3 -3
  225. package/ios/Extension/ChapterMetadata+AVFoundation.swift +2 -5
  226. package/ios/Extension/CxxVectorConformances.swift +4 -16
  227. package/ios/Extension/NavigationError+Conversion.swift +4 -7
  228. package/ios/Extension/PlayerCapabilities+Favorite.swift +0 -1
  229. package/ios/Extension/RequestConfig+Copying.swift +2 -6
  230. package/ios/Extension/ResolvedTrack+Copying.swift +2 -8
  231. package/ios/Extension/SearchParams+Query.swift +4 -4
  232. package/ios/Extension/Section+Copying.swift +3 -6
  233. package/ios/Extension/String+IcyCharset.swift +5 -5
  234. package/ios/Extension/TimedMetadata+AVFoundation.swift +6 -12
  235. package/ios/Extension/Track+AVPlayer.swift +1 -2
  236. package/ios/Extension/Track+Copying.swift +2 -8
  237. package/ios/Extension/Track+Identity.swift +4 -9
  238. package/ios/Extension/TrackMetadata+AVFoundation.swift +10 -13
  239. package/ios/Extension/UIApplication+ActiveScene.swift +6 -14
  240. package/ios/Extension/Variant+Artwork.swift +8 -22
  241. package/ios/Http/HttpClient.swift +3 -3
  242. package/ios/HybridAudioBrowser+Browser.swift +10 -16
  243. package/ios/HybridAudioBrowser+Options.swift +6 -9
  244. package/ios/HybridAudioBrowser+Player.swift +8 -16
  245. package/ios/HybridAudioBrowser+PlayerCallbacks.swift +4 -5
  246. package/ios/HybridAudioBrowser+Stubs.swift +5 -7
  247. package/ios/HybridAudioBrowser.swift +54 -79
  248. package/ios/Model/NitroTypeStubs.swift +15 -22
  249. package/ios/Model/PlayerUpdateOptions.swift +6 -21
  250. package/ios/Model/RemoteCommand.swift +2 -2
  251. package/ios/Model/TrackPlayerError.swift +9 -22
  252. package/ios/NowPlayingInfo/NowPlayingInfoController.swift +21 -40
  253. package/ios/NowPlayingInfo/SilentAudioPrimer.swift +10 -16
  254. package/ios/Observer/ItemObserver.swift +7 -5
  255. package/ios/Observer/PlayerObserver.swift +5 -5
  256. package/ios/PlaybackEvent.swift +2 -2
  257. package/ios/Player/AirPlayStallJudgement.swift +7 -9
  258. package/ios/Player/AudioSessionController.swift +14 -15
  259. package/ios/Player/DeferredSeek.swift +2 -2
  260. package/ios/Player/EndOfTrackJudgement.swift +6 -13
  261. package/ios/Player/ErrorStatus.swift +8 -7
  262. package/ios/Player/MediaLoader.swift +20 -24
  263. package/ios/Player/NowPlayingLines.swift +1 -4
  264. package/ios/Player/NowPlayingUpdater.swift +35 -61
  265. package/ios/Player/PersistedPlaybackState.swift +1 -2
  266. package/ios/Player/PlaybackFailure.swift +20 -24
  267. package/ios/Player/PlaybackPersistence.swift +5 -6
  268. package/ios/Player/PlaybackStateMachine.swift +8 -11
  269. package/ios/Player/PlaybackTimer.swift +8 -11
  270. package/ios/Player/Player.swift +6 -13
  271. package/ios/Player/PlayerEngine.swift +20 -20
  272. package/ios/Player/PlayerStatusTypes.swift +1 -2
  273. package/ios/Player/QueueManager.swift +23 -67
  274. package/ios/Player/RetryLoop.swift +39 -50
  275. package/ios/Player/ShuffleOrder.swift +17 -57
  276. package/ios/Player/SleepTimerManager.swift +13 -28
  277. package/ios/Player/VolumeFader.swift +16 -16
  278. package/ios/RemoteCommand/RemoteCommandCallbacks.swift +6 -16
  279. package/ios/RemoteCommand/RemoteCommandController.swift +8 -10
  280. package/ios/Tests/AirPlayStallJudgementTests.swift +4 -4
  281. package/ios/Tests/BrowserPathHelperTests.swift +3 -6
  282. package/ios/Tests/DeferredSeekTests.swift +1 -3
  283. package/ios/Tests/EmitterTests.swift +0 -1
  284. package/ios/Tests/EndOfTrackJudgementTests.swift +1 -6
  285. package/ios/Tests/FavoriteSetTests.swift +1 -0
  286. package/ios/Tests/GenerationMemoTests.swift +2 -2
  287. package/ios/Tests/InertStyleDiagnosticTests.swift +4 -10
  288. package/ios/Tests/JsonModelsTests.swift +5 -12
  289. package/ios/Tests/LRUCacheTests.swift +1 -5
  290. package/ios/Tests/MediaIntentCriteriaTests.swift +2 -7
  291. package/ios/Tests/MediaLoaderTests.swift +3 -12
  292. package/ios/Tests/ObserverTests.swift +3 -3
  293. package/ios/Tests/PlaybackErrorTests.swift +7 -9
  294. package/ios/Tests/PlaybackFailureTests.swift +9 -17
  295. package/ios/Tests/PlaybackPersistenceTests.swift +1 -0
  296. package/ios/Tests/PlaybackStateMachineTests.swift +1 -16
  297. package/ios/Tests/PlaybackTimerTests.swift +2 -3
  298. package/ios/Tests/PlayerPolicyTests.swift +10 -26
  299. package/ios/Tests/PlayerTests.swift +53 -88
  300. package/ios/Tests/PlayingStateTests.swift +0 -1
  301. package/ios/Tests/QueueManagerTests.swift +30 -80
  302. package/ios/Tests/RemoteCommandControllerTests.swift +5 -13
  303. package/ios/Tests/ResolvedTrackCopyingTests.swift +0 -2
  304. package/ios/Tests/RetryLoopTests.swift +12 -35
  305. package/ios/Tests/SearchDrillInTests.swift +4 -5
  306. package/ios/Tests/SectionPresentationTests.swift +3 -16
  307. package/ios/Tests/SectionScopeTests.swift +3 -6
  308. package/ios/Tests/SimpleRouterTests.swift +1 -5
  309. package/ios/Tests/SleepTimerManagerTests.swift +8 -11
  310. package/ios/Tests/StyleResolverTests.swift +4 -13
  311. package/ios/Tests/Support/ManualSleepTimerScheduler.swift +3 -8
  312. package/ios/Tests/Support/TestTypes.swift +5 -15
  313. package/ios/Tests/TabBarEntriesTests.swift +0 -2
  314. package/ios/Tests/TimedMetadataAVFoundationTests.swift +2 -3
  315. package/ios/Tests/TopTemplateReplacerTests.swift +1 -1
  316. package/ios/Tests/TrackIdTemplateTests.swift +2 -6
  317. package/ios/Tests/TrackMetadataAVFoundationTests.swift +1 -4
  318. package/ios/Tests/TrackSelectorTests.swift +3 -15
  319. package/ios/TrackSelector.swift +13 -25
  320. package/ios/Util/ArtworkFreshness.swift +6 -6
  321. package/ios/Util/ArtworkImageFetcher.swift +19 -20
  322. package/ios/Util/ConcurrentMap.swift +2 -2
  323. package/ios/Util/Emitter.swift +8 -13
  324. package/ios/Util/NetworkMonitor.swift +4 -6
  325. package/ios/Util/OutputPicker.swift +1 -1
  326. package/ios/Util/ReadyValue.swift +3 -2
  327. package/ios/Util/SFSymbolRenderer.swift +17 -30
  328. package/ios/Util/SVGProcessor.swift +5 -9
  329. package/package.json +1 -1
@@ -10,10 +10,10 @@ import java.util.concurrent.CopyOnWriteArraySet
10
10
  import timber.log.Timber
11
11
 
12
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.
13
+ * Sonos rooms as remote outputs, shared by [SonosRouteProviderService], which the system binds, and
14
+ * the player's [SonosRemote]: whether the service may be bound, the room selected in the Output
15
+ * Switcher, and room volumes. While a session plays on a room, its volume goes through that
16
+ * session, which reads it back.
17
17
  */
18
18
  internal object SonosOutputs {
19
19
  /**
@@ -31,14 +31,13 @@ internal object SonosOutputs {
31
31
  private val volumeListeners = CopyOnWriteArraySet<() -> Unit>()
32
32
  private val volumes = ConcurrentHashMap<String, Int>()
33
33
 
34
- /** The session playing on room [roomId], and how it sets the room's volume. */
35
34
  private class Session(val roomId: String, val setVolume: (Int) -> Unit)
36
35
 
37
36
  private var session: Session? = null
38
37
 
39
38
  /**
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.
39
+ * Enables or disables [SonosRouteProviderService]. The component state persists, so the system
40
+ * can bind the service before the app has set up its player. Disabling forgets the selected room.
42
41
  */
43
42
  @MainThread
44
43
  fun setEnabled(context: Context, enabled: Boolean) {
@@ -72,7 +71,6 @@ internal object SonosOutputs {
72
71
  /** [roomId]'s volume as last read or set, from 0 to 100, or null before either. */
73
72
  fun volumeOf(roomId: String): Int? = volumes[roomId]
74
73
 
75
- /** Records [roomId]'s volume as read or set, and tells the volume listeners. */
76
74
  @MainThread
77
75
  fun reportVolume(roomId: String, volume: Int) {
78
76
  if (volumes.put(roomId, volume) == volume) return
@@ -88,14 +86,16 @@ internal object SonosOutputs {
88
86
  volumeListeners.remove(listener)
89
87
  }
90
88
 
91
- /** While a session plays on [roomId], [setVolume] sets its volume; null when it ends. */
89
+ /**
90
+ * While a session plays on [roomId], [setVolume] sets its volume; null when it ends, which leaves
91
+ * another room's session in place.
92
+ */
92
93
  @MainThread
93
94
  fun setSession(roomId: String, setVolume: ((Int) -> Unit)?) {
94
95
  if (setVolume != null) session = Session(roomId, setVolume)
95
96
  else if (session?.roomId == roomId) session = null
96
97
  }
97
98
 
98
- /** Whether a session plays on [roomId]. */
99
99
  fun hasSession(roomId: String): Boolean = session?.roomId == roomId
100
100
 
101
101
  /** Sets [roomId]'s volume through the session playing there: false when none does. */
@@ -34,7 +34,7 @@ internal data class SonosPosition(
34
34
  val durationMs: Long?,
35
35
  )
36
36
 
37
- /** The UPnP control of one Sonos room, as [SonosPlayer] drives it. Every call blocks. */
37
+ /** The UPnP control of one Sonos room. Every call blocks; a refused one throws [SoapException]. */
38
38
  internal interface SonosControl {
39
39
  fun setUri(
40
40
  streamUrl: String,
@@ -57,10 +57,7 @@ internal interface SonosControl {
57
57
 
58
58
  fun getPosition(): SonosPosition?
59
59
 
60
- /**
61
- * The URI the room was last told to play, as it was sent; the track it plays may be another, the
62
- * one a redirect led to.
63
- */
60
+ /** The URI the room was last told to play, as sent: not the one a redirect led it to. */
64
61
  fun getMediaUri(): String?
65
62
 
66
63
  fun getVolume(): Int?
@@ -69,22 +66,19 @@ internal interface SonosControl {
69
66
  }
70
67
 
71
68
  /**
72
- * Plays one item at a time on a Sonos room: Media3 commands in, UPnP out, and the room's transport
73
- * state, position, stream title and volume polled back in. As a
74
- * [com.audiobrowser.remote.RemotePlayback]'s player, setting its item loads it on the speaker from
75
- * the start position given, without [prepare]. Each poll that reads it playing calls [onPlaying]. A
76
- * track that plays to its end calls [onEnded]; one stopped there early reads as paused. Once
77
- * another app or the Sonos app plays something else there, it reads as paused and leaves the room
78
- * alone until played again. A title the speaker reads from the stream arrives as an [IcyInfo] in
79
- * the timed metadata, where the local player reports its own. The room's volume is read when the
80
- * player starts and with each poll, and goes to [onVolume].
69
+ * Plays one item at a time on a Sonos room: Media3 commands go out as UPnP calls, and the room's
70
+ * transport state, position, stream title and volume are polled back. Setting the item loads it on
71
+ * the speaker from the given position, without [prepare]. Each poll that reads it playing calls
72
+ * [onPlaying]; a track that plays to its end calls [onEnded], one stopped early reads as paused.
73
+ * Once another app plays on the room, the player reads as paused and leaves the room alone. A title
74
+ * the speaker reads from the stream arrives as an [IcyInfo] in the timed metadata. The volume is
75
+ * read at start and with each poll, and goes to [onVolume].
81
76
  *
82
- * Commands run in the order they are made, one at a time, off the main thread, and run to the end
83
- * even once the player is released, so its last stop reaches the speaker. A failed command that no
84
- * later one replaced goes to [onError] and leaves the player idle; so does a speaker that stops
85
- * answering [unreachableAfterPolls] polls in a row. An item the speaker never starts is the
86
- * switch's to time out. A room that played on after a failure still hears pause and stop. A failed
87
- * seek or volume change is only logged.
77
+ * Commands run one at a time, in order, off the main thread, and run to the end even after release,
78
+ * so a last stop reaches the speaker. A failed command that no later one replaced goes to [onError]
79
+ * and leaves the player idle; so does a speaker that misses [unreachableAfterPolls] polls in a row.
80
+ * An item the speaker never starts is [com.audiobrowser.remote.RemoteSwitchingPlayer]'s to time
81
+ * out. A failed seek or volume change is only logged.
88
82
  */
89
83
  internal class SonosPlayer(
90
84
  looper: Looper,
@@ -108,21 +102,19 @@ internal class SonosPlayer(
108
102
  private var volume: Int? = null
109
103
  private var timedMetadata: Metadata? = null
110
104
 
111
- // The track's duration and position as last read; while it reads as playing, the time of that
112
- // reading, from which its position runs on.
113
105
  private var durationMs = C.TIME_UNSET
114
106
  private var position: PositionSupplier = PositionSupplier.getConstant(0)
115
107
  private var readPositionMs = 0L
116
108
  private var playingSinceReadAtMs: Long? = null
117
109
 
118
- // The URL the speaker holds for us, until stopped or taken over by another app; whether it holds
119
- // it ready to play without loading again; when it was asked to play; whether it has since.
110
+ // The URL the speaker holds for us, until stopped or taken over; `ready`: held so that play
111
+ // resumes it without loading again; `seenPlaying`: it has read as playing since it was loaded.
120
112
  private var loadedUrl: String? = null
121
113
  private var ready = false
122
114
  private var seenPlaying = false
123
115
 
124
- // A poll that overlapped a command is dropped: its reading may predate it. A failed command is an
125
- // error only while no later one has been made.
116
+ // A failed fatal command is an error only while no later one has been made. A poll that
117
+ // overlapped a command is dropped: its reading may predate the command.
126
118
  private var generation = 0
127
119
  private var pendingCommands = 0
128
120
  private val commands = Mutex()
@@ -257,9 +249,6 @@ internal class SonosPlayer(
257
249
  private val isPrepared
258
250
  get() = playbackState != Player.STATE_IDLE
259
251
 
260
- /**
261
- * Loads the item on the speaker from [startPositionMs], playing it if asked, and polls the room.
262
- */
263
252
  private fun load(startPositionMs: Long) {
264
253
  val current = item ?: return
265
254
  val url = current.localConfiguration?.uri?.toString() ?: return
@@ -307,8 +296,8 @@ internal class SonosPlayer(
307
296
  }
308
297
 
309
298
  /**
310
- * Runs [block] off the main thread after the commands before it. A [fatal] command's failure is
311
- * the player's while no later fatal command has been made.
299
+ * Runs [block] off the main thread after the commands before it, even once [scope] is cancelled.
300
+ * A [fatal] command's failure is the player's while no later fatal command has been made.
312
301
  */
313
302
  private fun command(fatal: Boolean = true, block: () -> Unit) {
314
303
  val issued = if (fatal) ++generation else generation
@@ -331,7 +320,7 @@ internal class SonosPlayer(
331
320
  }
332
321
  }
333
322
 
334
- /** Idle, with the room still held: what played on there still hears pause and stop. */
323
+ /** Idle, with the room still held, so what plays on there still hears pause and stop. */
335
324
  private fun fail(e: PlaybackException) {
336
325
  playbackState = Player.STATE_IDLE
337
326
  ready = false
@@ -484,7 +473,6 @@ internal class SonosPlayer(
484
473
  setPlayWhenReadyFromSpeaker(false)
485
474
  }
486
475
 
487
- /** Whether the track played to its end, as its last position read says. */
488
476
  private fun trackEnded(): Boolean {
489
477
  if (item?.isRemoteLive != false || durationMs == C.TIME_UNSET) return false
490
478
  val reachedMs = readPositionMs + (playingSinceReadAtMs?.let { nowMs() - it } ?: 0)
@@ -8,9 +8,8 @@ import kotlinx.coroutines.CoroutineScope
8
8
  import kotlinx.coroutines.Dispatchers
9
9
 
10
10
  /**
11
- * The Sonos room selected in the Output Switcher ([SonosOutputs.selected]) as a remote output: a
12
- * session while one is selected, with a [SonosPlayer] of its own. Selecting another room starts its
13
- * session in place of the last, so playback moves from room to room.
11
+ * Plays on the room selected in the Output Switcher ([SonosOutputs.selected]): a session with its
12
+ * own [SonosPlayer] while one is selected. Selecting another room replaces it, so playback moves.
14
13
  */
15
14
  internal class SonosRemote(
16
15
  private val context: Context,
@@ -81,9 +80,8 @@ internal class SonosRemote(
81
80
 
82
81
  private companion object {
83
82
  /**
84
- * The system's routing session for the selected room, which ties the media session to it:
85
- * without it, the notification's output chip can't open the Output Switcher to move playback
86
- * back.
83
+ * The system's routing session for the selected room. The media session must carry it, or the
84
+ * notification's output chip can't open the Output Switcher to move playback back.
87
85
  */
88
86
  fun systemRoutingControllerId(context: Context): () -> String? {
89
87
  if (Build.VERSION.SDK_INT < Build.VERSION_CODES.R) return { null }
@@ -23,8 +23,8 @@ import kotlinx.coroutines.withContext
23
23
  import timber.log.Timber
24
24
 
25
25
  /**
26
- * Serves the Sonos rooms as media routes, so the system Output Switcher lists them. Bound by the
27
- * system, not the app: [SonosOutputs.setEnabled] turns the component on.
26
+ * Serves the Sonos rooms as media routes for the system Output Switcher. The system binds it, not
27
+ * the app: [SonosOutputs.setEnabled] turns the component on.
28
28
  */
29
29
  class SonosRouteProviderService : MediaRouteProviderService() {
30
30
  private var provider: SonosRouteProvider? = null
@@ -52,8 +52,8 @@ internal class SonosRouteProvider(context: Context) : MediaRouteProvider(context
52
52
 
53
53
  init {
54
54
  SonosOutputs.addVolumeListener(onVolumeChanged)
55
- // A new provider, after the system rebound the service, lists the room still selected, which
56
- // MediaRouter2 looks up in the descriptor before it creates the room's session.
55
+ // After the system rebinds the service, MediaRouter2 looks up the room still selected in this
56
+ // descriptor before it creates the room's session.
57
57
  publish()
58
58
  }
59
59
 
@@ -63,14 +63,14 @@ internal class SonosRouteProvider(context: Context) : MediaRouteProvider(context
63
63
  if (request == null || !request.selector.hasControlCategory(RemoteOutputs.CATEGORY)) return
64
64
  scanJob =
65
65
  scope.launch {
66
- // Passive discovery keeps what a recent scan found; the open switcher asks for active.
66
+ // Passive requests reuse a recent scan; the open switcher asks for an active one.
67
67
  if (!request.isActiveScan && System.currentTimeMillis() - lastScanMs < PASSIVE_RESCAN_MS) {
68
68
  return@launch
69
69
  }
70
70
  while (isActive) {
71
71
  val found = withContext(Dispatchers.IO) { discoverer.discover() }
72
72
  lastScanMs = System.currentTimeMillis()
73
- // A room selected now stays listed when one scan misses it: SSDP is lossy.
73
+ // SSDP is lossy: the selected room stays listed when one scan misses it.
74
74
  val selected = SonosOutputs.selected
75
75
  rooms =
76
76
  if (selected != null && found.none { it.id == selected.id }) found + selected else found
@@ -96,7 +96,7 @@ internal class SonosRouteProvider(context: Context) : MediaRouteProvider(context
96
96
  Timber.d("Sonos: %d room(s)", rooms.size)
97
97
  }
98
98
 
99
- /** Reads [room]'s volume itself, for a room no session plays on, which would read it instead. */
99
+ /** Reads [room]'s volume from the speaker, for a room no session plays on: a session reads it. */
100
100
  private suspend fun readVolume(room: SonosRoom): Int? {
101
101
  val volume =
102
102
  withContext(Dispatchers.IO) {
@@ -131,8 +131,8 @@ internal class SonosRouteProvider(context: Context) : MediaRouteProvider(context
131
131
 
132
132
  override fun onUpdateVolume(delta: Int) {
133
133
  scope.launch {
134
- // From the speaker's own volume: the Sonos app or the speaker's buttons may have moved it.
135
- // A session reads it as it plays.
134
+ // Read from the speaker unless a session tracks it: the Sonos app or the speaker's buttons
135
+ // may have moved it.
136
136
  val current =
137
137
  (if (SonosOutputs.hasSession(room.id)) null else readVolume(room))
138
138
  ?: SonosOutputs.volumeOf(room.id)
@@ -152,7 +152,6 @@ internal class SonosRouteProvider(context: Context) : MediaRouteProvider(context
152
152
 
153
153
  private const val MAX_VOLUME = 100
154
154
 
155
- /** The routes for [rooms]: the selected one connected, each in both output categories. */
156
155
  @VisibleForTesting
157
156
  internal fun sonosRouteDescriptors(
158
157
  rooms: List<SonosRoom>,
@@ -1,13 +1,13 @@
1
1
  package com.audiobrowser.sonos
2
2
 
3
- /**
4
- * The `CurrentURI` a Sonos speaker plays a URL from. A live http(s) stream goes as
5
- * `x-rincon-mp3radio://` followed by the whole URL, scheme included: the speaker sniffs the codec
6
- * itself (MP3, AAC, HLS) and follows redirects. A track goes as its URL, since under the radio
7
- * scheme the speaker reports no duration and refuses `Seek`. Any other scheme passes through
8
- * unchanged.
9
- */
10
3
  internal object SonosStreamUri {
4
+ /**
5
+ * The `CurrentURI` a Sonos speaker plays [url] from. A [live] http(s) stream goes as
6
+ * `x-rincon-mp3radio://` followed by the whole URL, scheme included; despite the name, the
7
+ * speaker sniffs any codec (MP3, AAC, HLS) and follows redirects. A track goes as its plain URL,
8
+ * since under the radio scheme the speaker reports no duration and refuses `Seek`. Any other
9
+ * scheme passes through unchanged.
10
+ */
11
11
  fun forTransport(url: String, live: Boolean): String {
12
12
  val scheme = url.substringBefore("://", missingDelimiterValue = "").lowercase()
13
13
  return if (live && (scheme == "http" || scheme == "https")) "x-rincon-mp3radio://$url" else url
@@ -1,12 +1,12 @@
1
1
  package com.audiobrowser.sonos
2
2
 
3
3
  /**
4
- * UPnP control of one Sonos device. Every call blocks on a SOAP round-trip, so call it off the main
5
- * thread, and throws [SoapException] on failure.
4
+ * UPnP control of one Sonos room. Every call blocks on a SOAP round-trip, so call it off the main
5
+ * thread, and throws [SoapException] when the speaker answers with an error.
6
6
  */
7
7
  internal class SonosTransport(private val device: SonosDevice, private val soap: SoapClient) :
8
8
  SonosControl {
9
- /** Loads the stream on the device (`SetAVTransportURI`) without starting playback. */
9
+ /** Loads the stream on the room (`SetAVTransportURI`) without starting playback. */
10
10
  override fun setUri(
11
11
  streamUrl: String,
12
12
  title: String,
@@ -35,7 +35,7 @@ internal class SonosTransport(private val device: SonosDevice, private val soap:
35
35
 
36
36
  override fun seek(positionMs: Long) = avt(SoapEnvelopes.seek(positionMs))
37
37
 
38
- /** The device's current UPnP `CurrentTransportState`, or null if unreadable. */
38
+ /** The room's UPnP `CurrentTransportState`, such as `PLAYING`, or null if unreadable. */
39
39
  override fun getTransportState(): String? =
40
40
  SoapResponseParser.transportState(
41
41
  soap.execute(device.avTransportControlUrl, SoapEnvelopes.getTransportInfo())
@@ -51,6 +51,7 @@ internal class SonosTransport(private val device: SonosDevice, private val soap:
51
51
  soap.execute(device.avTransportControlUrl, SoapEnvelopes.getMediaInfo())
52
52
  )
53
53
 
54
+ /** Sets the volume of every speaker in the group this device coordinates, not of one speaker. */
54
55
  override fun setVolume(volume: Int) {
55
56
  soap.execute(device.groupRenderingControlUrl, SoapEnvelopes.setGroupVolume(volume))
56
57
  }
@@ -14,11 +14,16 @@ internal interface MulticastLockHandle {
14
14
  }
15
15
 
16
16
  /**
17
- * Sends the SSDP `M-SEARCH` datagram to the UPnP multicast group and collects the unicast replies
18
- * for a bounded window, holding the multicast lock meanwhile. Blocking: run it off the main thread.
17
+ * Sends the SSDP `M-SEARCH` to the UPnP multicast group and collects the replies for a bounded
18
+ * window, holding the multicast lock meanwhile. Blocking: run it off the main thread.
19
19
  */
20
20
  internal class SsdpDiscovery(private val multicastLock: MulticastLockHandle? = null) : SsdpScanner {
21
21
 
22
+ /**
23
+ * Sends `repeats` probes (at least one), then listens for `timeoutMs`. A failed probe is ignored;
24
+ * any other socket failure is logged, not thrown, and the replies so far are returned, one per
25
+ * USN, the first one kept.
26
+ */
22
27
  override fun search(timeoutMs: Int, repeats: Int): List<SsdpResponse> {
23
28
  multicastLock?.acquire()
24
29
  val responsesByUsn = LinkedHashMap<String, SsdpResponse>()
@@ -26,7 +31,7 @@ internal class SsdpDiscovery(private val multicastLock: MulticastLockHandle? = n
26
31
  DatagramSocket().use { socket ->
27
32
  val group = InetAddress.getByName(SsdpMessages.MULTICAST_HOST)
28
33
  val datagram = SsdpMessages.buildMSearch()
29
- // Send a few times — UDP is lossy and a single probe is easily missed on busy Wi-Fi.
34
+ // UDP is lossy: one probe is easily missed on busy Wi-Fi.
30
35
  repeat(repeats.coerceAtLeast(1)) {
31
36
  runCatching {
32
37
  socket.send(DatagramPacket(datagram, datagram.size, group, SsdpMessages.MULTICAST_PORT))
@@ -8,7 +8,6 @@ internal data class SsdpResponse(
8
8
  val server: String?,
9
9
  )
10
10
 
11
- /** The two SSDP messages Sonos discovery needs: the `M-SEARCH` it sends and the replies. */
12
11
  internal object SsdpMessages {
13
12
  const val MULTICAST_HOST = "239.255.255.250"
14
13
  const val MULTICAST_PORT = 1900
@@ -18,7 +17,7 @@ internal object SsdpMessages {
18
17
 
19
18
  private const val USER_AGENT = "AudioBrowser/1.0 UPnP/1.1"
20
19
 
21
- /** Builds the SSDP `M-SEARCH` request datagram, in CRLF framing. */
20
+ /** Builds the `M-SEARCH` datagram; `mx` is the seconds a device may wait before replying. */
22
21
  fun buildMSearch(searchTarget: String = SONOS_SEARCH_TARGET, mx: Int = 2): ByteArray =
23
22
  ("M-SEARCH * HTTP/1.1\r\n" +
24
23
  "HOST: $MULTICAST_HOST:$MULTICAST_PORT\r\n" +
@@ -30,14 +29,13 @@ internal object SsdpMessages {
30
29
  .toByteArray(Charsets.UTF_8)
31
30
 
32
31
  /**
33
- * Parses a unicast SSDP search response. Returns null unless it is an HTTP `200` reply carrying
34
- * both a `LOCATION` (the device description URL) and a `USN` (the unique identity used to
35
- * dedupe). Header names are case-insensitive; values are trimmed. Tolerates bare-LF framing.
32
+ * Returns null unless [raw] is an HTTP `200` reply with a non-empty `LOCATION` (the device
33
+ * description URL) and `USN` (its identity). NOTIFY announcements are refused. Header names are
34
+ * case-insensitive, the first of a repeated header wins, and bare-LF framing is accepted.
36
35
  */
37
36
  fun parseResponse(raw: String): SsdpResponse? {
38
37
  val lines = raw.replace("\r\n", "\n").split("\n")
39
38
  val statusLine = lines.firstOrNull()?.trim() ?: return null
40
- // A response status line (HTTP/x 200 ...), not a NOTIFY or M-SEARCH request.
41
39
  val statusTokens = statusLine.split(' ')
42
40
  if (!statusLine.startsWith("HTTP/") || statusTokens.getOrNull(1) != "200") return null
43
41
 
@@ -2,7 +2,7 @@ package com.audiobrowser.sonos
2
2
 
3
3
  import org.w3c.dom.Element
4
4
 
5
- /** A group of Sonos rooms playing together, controlled through its [coordinator]. */
5
+ /** Sonos rooms playing together, controlled through their [coordinator]. */
6
6
  internal data class SonosGroup(
7
7
  /** The coordinator's `RINCON_…` UUID. */
8
8
  val coordinator: String,
@@ -11,21 +11,19 @@ internal data class SonosGroup(
11
11
  val name: String,
12
12
  )
13
13
 
14
- /** A [SonosGroup] whose coordinator's control URLs are known: what a route stands for. */
14
+ /** A [SonosGroup], with its coordinator's control URLs: what a route stands for. */
15
15
  internal data class SonosRoom(val id: String, val name: String, val device: SonosDevice)
16
16
 
17
17
  /**
18
- * Parses a `ZoneGroupTopology.GetZoneGroupState` response into the groups a user can play to. A
19
- * group is listed once, at its coordinator, the only member that accepts transport commands: the
20
- * hidden half of a stereo pair answers SSDP too but refuses them, and can be reported as the
21
- * coordinator of a group of its own, which is skipped. A home theatre's satellites are not members.
22
- * A group of several rooms is named after its coordinator plus the count of the others, as the
23
- * Sonos app does.
18
+ * Reads a `ZoneGroupTopology.GetZoneGroupState` response into the groups a user can play to, each
19
+ * listed once at its coordinator: the only member that accepts transport commands. The hidden half
20
+ * of a stereo pair answers SSDP but refuses them. A group of several rooms is named as the Sonos
21
+ * app names it: `Kitchen + 2`.
24
22
  */
25
23
  internal object ZoneGroupState {
26
24
  /**
27
- * Whether the speaker [uuid] is reported hidden: the hidden half of a stereo pair, whose own
28
- * topology can leave out the group of its pair.
25
+ * Whether [uuid] is reported hidden (the hidden half of a stereo pair), whose own topology can
26
+ * leave out its pair's group. False when [xml] cannot be read.
29
27
  */
30
28
  fun isHidden(xml: String, uuid: String): Boolean {
31
29
  val doc = SoapResponseParser.embeddedDocument(xml, "ZoneGroupState") ?: return false
@@ -35,7 +33,10 @@ internal object ZoneGroupState {
35
33
  .any { it.getAttribute("UUID") == uuid && it.getAttribute("Invisible") == "1" }
36
34
  }
37
35
 
38
- /** The groups, or null when [xml] holds no readable `ZoneGroupState`. */
36
+ /**
37
+ * The groups, or null when [xml] holds no readable `ZoneGroupState`. Skips a group whose
38
+ * coordinator is missing or hidden.
39
+ */
39
40
  fun parse(xml: String): List<SonosGroup>? {
40
41
  val doc = SoapResponseParser.embeddedDocument(xml, "ZoneGroupState") ?: return null
41
42
  val groups = doc.getElementsByTagName("ZoneGroup")
@@ -43,6 +44,7 @@ internal object ZoneGroupState {
43
44
  }
44
45
 
45
46
  private fun groupOf(group: Element): SonosGroup? {
47
+ // Direct children only: a home theatre's satellites nest inside a member and are not rooms.
46
48
  val members =
47
49
  (0 until group.childNodes.length)
48
50
  .map { group.childNodes.item(it) }