react-native-audio-browser 0.2.0-next.52 → 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 +35 -49
  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 +16 -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 +26 -4
  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 +15 -11
  156. package/android/src/test/java/com/audiobrowser/remote/RemoteSwitchingPlayerTest.kt +112 -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
@@ -5,18 +5,18 @@ import Foundation
5
5
  #endif
6
6
  import os.log
7
7
 
8
- /// Abstracts `NetworkMonitor` so tests can fake connectivity. Sendable because
9
- /// the network-restore race reads it from a task-group child.
8
+ /// Connectivity as `RetryLoop` sees it; a fake stands in for `NetworkMonitor` in tests. Sendable
9
+ /// because the network-restore wait reads it from a task-group child.
10
10
  protocol NetworkStatusProviding: AnyObject, Sendable {
11
11
  var isOnline: Bool { get }
12
12
  }
13
13
 
14
- /// Distinguishes playback failures from media-load failures.
15
- /// Each context carries the retry strategy and the fallback error classification.
14
+ /// Where a failure came from, which decides where the retry resumes and the error reported when
15
+ /// the failure cannot be classified.
16
16
  public enum PlaybackErrorContext {
17
- /// AVPlayer/AVPlayerItem status failure — retry from current time, fallback `.playbackFailed`.
17
+ /// An AVPlayer/AVPlayerItem failure: retries resume from the current time.
18
18
  case playback
19
- /// MediaLoader key-value load failure — retry from start, fallback `.failedToLoadKeyValue`.
19
+ /// A MediaLoader key-value load failure: retries start from the beginning.
20
20
  case mediaLoad
21
21
 
22
22
  var startFromCurrentTime: Bool {
@@ -34,15 +34,14 @@ public enum PlaybackErrorContext {
34
34
  }
35
35
  }
36
36
 
37
- /// Retries failed loads: classifies each failure (`PlaybackFailure`), reports the ones it is
38
- /// working on as advisory, and reloads after an exponential backoff until a budget runs out,
39
- /// when it reports the error as terminal. Similar to Android's RetryLoadErrorHandlingPolicy.
37
+ /// Retries failed loads with exponential backoff until a budget runs out, then reports the error
38
+ /// as terminal; the iOS counterpart of Android's RetryLoadErrorHandlingPolicy.
40
39
  ///
41
- /// Two duration budgets apply, chosen by whether the current Load has produced audio
42
- /// (`hasPlayed`, ADR 0004): a short first-connect budget, since a stream that fails before ever
43
- /// playing is usually dead and the listener is waiting for a verdict, and the full recovery
44
- /// budget for a stream that played and dropped. The short budget counts only online time, and
45
- /// while offline a scheduled retry fires as soon as connectivity returns.
40
+ /// Two duration budgets apply, chosen by whether the current Load has produced audio (`hasPlayed`,
41
+ /// docs/adr/0004): a short first-connect budget for a stream that never played (usually dead, with
42
+ /// the listener waiting for a verdict), counted only while online, and the full recovery budget for
43
+ /// one that played and dropped. While offline, a
44
+ /// scheduled retry fires as soon as connectivity returns.
46
45
  @MainActor
47
46
  final class RetryLoop {
48
47
  private let logger = Logger(subsystem: "com.audiobrowser", category: "RetryLoop")
@@ -56,51 +55,46 @@ final class RetryLoop {
56
55
  private static let defaultMaxRetryDurationMs: Double = 120_000
57
56
  private static let defaultFirstConnectMaxRetryDurationMs: Double = 12_000
58
57
 
59
- /// Prevents surprising playback resumption after long periods offline.
58
+ // Bounds everything, offline waits included, so playback does not resume by surprise after a
59
+ // long time offline.
60
60
  private var maxRetryDuration: TimeInterval = defaultMaxRetryDurationMs / 1000
61
- /// Bounds retries of a load that has never produced audio, while online.
62
61
  private var firstConnectMaxRetryDuration: TimeInterval = defaultFirstConnectMaxRetryDurationMs / 1000
63
62
 
64
- /// Whether the current Load has produced audio. Read from the Load, which a mid-play `reset()`
65
- /// (the healthy-playback refill) leaves alone.
63
+ /// Whether the current Load has produced audio. Read from the Load, not kept here, because a
64
+ /// healthy-playback `reset()` must not clear it.
66
65
  var hasPlayed: () -> Bool = { false }
67
- /// Whether a retry is still wanted (the play intent); checked before and after the backoff.
66
+ /// The play intent; checked before and after the backoff.
68
67
  var shouldRetry: () -> Bool = { true }
69
- /// Reloads, from the current time or from the start.
68
+ /// Reloads; the argument is true to resume from the current time, false to start over.
70
69
  var onRetry: ((Bool) -> Void)?
71
- /// The retries gave up, or the failure cannot be retried.
70
+ /// Terminal: the retries gave up, or the failure cannot be retried. Not called when the retry
71
+ /// is cancelled.
72
72
  var onError: ((TrackPlayerError.PlaybackError) -> Void)?
73
- /// A failure a retry is now scheduled for, reported before the backoff so UIs can show the
74
- /// cause while the state stays non-terminal.
73
+ /// A failure a retry is now scheduled for, reported before the backoff while the state stays
74
+ /// non-terminal.
75
75
  var onRetryingError: ((TrackPlayerError.PlaybackError) -> Void)?
76
76
 
77
77
  weak var networkMonitor: (any NetworkStatusProviding)?
78
78
 
79
79
  /// The retry in flight; session release waits while there is one.
80
80
  private(set) var pendingTask: Task<Void, Never>?
81
- /// True only while a scheduled retry waits for connectivity to return, so a stall-driven
82
- /// reconnect can defer to it rather than load twice.
81
+ /// True only while a scheduled retry waits for connectivity, so a stall-driven reconnect can
82
+ /// defer to it rather than load twice.
83
83
  private(set) var isWaitingForNetwork = false
84
- /// Retries executed since the budgets last reset.
85
84
  private(set) var attempts = 0
86
85
 
87
- /// Continuous audible playback that proves the stream recovered, so the budgets refill
88
- /// (Android's HEALTHY_PLAYBACK_MS); without it a long-lived stream keeps its spent budget until
89
- /// the track changes.
86
+ /// Continuous audible playback after which the budgets refill (Android's HEALTHY_PLAYBACK_MS).
90
87
  var healthyPlaybackDuration: Duration = .seconds(20)
91
- /// The pending refill. Readable so tests can await the window instead of sleeping past it.
92
88
  private(set) var healthyPlaybackTask: Task<Void, Never>?
93
89
 
94
90
  private var policy: Policy = .disabled
95
91
  private var firstRetryTime: Date?
96
- /// First failure observed while online for the current load: the first-connect budget's
97
- /// clock. Never set while offline, and wiped by any offline observation, so an offline stretch
98
- /// cannot burn the short budget.
92
+ // The first-connect budget's clock: never set while offline and wiped by any offline
93
+ // observation, so an offline stretch cannot burn the short budget.
99
94
  private var firstOnlineRetryTime: Date?
100
95
 
101
96
  private let sleep: @Sendable (TimeInterval) async throws -> Void
102
97
 
103
- /// - Parameter sleep: Waits out a backoff or a connectivity poll; tests make it instant.
104
98
  init(
105
99
  networkMonitor: (any NetworkStatusProviding)? = nil,
106
100
  sleep: @escaping @Sendable (TimeInterval) async throws -> Void = { try await Task.sleep(for: .seconds($0)) },
@@ -128,7 +122,6 @@ final class RetryLoop {
128
122
  maxRetryDuration = (retryConfig.maxRetryDurationMs ?? Self.defaultMaxRetryDurationMs) / 1000
129
123
  firstConnectMaxRetryDuration =
130
124
  (retryConfig.firstConnectMaxRetryDurationMs ?? Self.defaultFirstConnectMaxRetryDurationMs) / 1000
131
- // No attempt cap: retry indefinitely, bounded only by the duration.
132
125
  policy = retryConfig.maxRetries.map { .limited(maxRetries: Int($0)) } ?? .infinite
133
126
  }
134
127
  logger.debug("Retry policy: \(String(describing: self.policy)), max duration \(self.maxRetryDuration)s")
@@ -136,6 +129,9 @@ final class RetryLoop {
136
129
 
137
130
  // MARK: - Failures
138
131
 
132
+ /// Reports a non-retryable failure through `onError` at once; otherwise reports it through
133
+ /// `onRetryingError`, replaces any retry in flight, and calls `onError` only if that retry gives
134
+ /// up.
139
135
  func handleError(_ error: Error?, context: PlaybackErrorContext, httpStatusCode: Int? = nil) {
140
136
  if let error {
141
137
  let nsError = error as NSError
@@ -155,8 +151,8 @@ final class RetryLoop {
155
151
  pendingTask = Task { [weak self] in
156
152
  guard let self else { return }
157
153
  let retried = await attemptRetry(startFromCurrentTime: context.startFromCurrentTime)
158
- // Cancelled (track change, stop): stay silent, or the new track or a deliberate stop
159
- // would flip to .error. The canceller owns the handle.
154
+ // Cancelled by a track change or stop: stay silent, or the new track or the stop would
155
+ // flip to .error. The canceller owns `pendingTask`.
160
156
  if Task.isCancelled { return }
161
157
  if !retried { onError?(failure.error) }
162
158
  pendingTask = nil
@@ -169,7 +165,7 @@ final class RetryLoop {
169
165
  pendingTask = nil
170
166
  }
171
167
 
172
- /// Drops the retry in flight and restarts the budgets.
168
+ /// Drops the retry in flight and refills the budgets.
173
169
  func reset() {
174
170
  cancel()
175
171
  attempts = 0
@@ -180,13 +176,13 @@ final class RetryLoop {
180
176
 
181
177
  // MARK: - Healthy Playback
182
178
 
183
- /// Starts the healthy-playback window; when it elapses between failures, the budgets refill.
179
+ /// Starts the healthy-playback window; if it elapses with no retry pending, the budgets refill.
184
180
  func playbackBecameAudible() {
185
181
  healthyPlaybackTask?.cancel()
186
182
  healthyPlaybackTask = Task { [weak self, healthyPlaybackDuration] in
187
183
  try? await Task.sleep(for: healthyPlaybackDuration)
188
184
  guard let self, !Task.isCancelled else { return }
189
- // reset() cancels a pending retry, which would silently kill an in-flight reconnect.
185
+ // reset() would cancel the pending retry and silently kill an in-flight reconnect.
190
186
  guard pendingTask == nil else { return }
191
187
  reset()
192
188
  }
@@ -201,9 +197,6 @@ final class RetryLoop {
201
197
 
202
198
  private var isOnline: Bool { networkMonitor?.isOnline ?? true }
203
199
 
204
- /// The exhausted budget, or nil while budget remains. The recovery duration bounds everything,
205
- /// offline waits included; the first-connect duration also bounds never-played loads, online
206
- /// only.
207
200
  private func exhaustedBudget() -> String? {
208
201
  let now = Date()
209
202
  if let start = firstRetryTime, now.timeIntervalSince(start) >= maxRetryDuration {
@@ -217,13 +210,12 @@ final class RetryLoop {
217
210
  return nil
218
211
  }
219
212
 
220
- /// 1 s, 1.5 s, 2.3 s, 3.4 s, then 5 s.
221
213
  private var backoff: TimeInterval {
222
214
  min(1.0 * pow(1.5, Double(attempts)), 5.0)
223
215
  }
224
216
 
225
- /// Waits out the backoff, or connectivity's return, then reloads. False when the policy, the
226
- /// play intent or a budget says stop, or the wait was cancelled.
217
+ /// Waits out the backoff, or connectivity's return, then calls `onRetry`. False when the policy,
218
+ /// the play intent or a budget says stop, or the wait was cancelled.
227
219
  func attemptRetry(startFromCurrentTime: Bool) async -> Bool {
228
220
  guard isEnabled, shouldRetry() else { return false }
229
221
  if case let .limited(maxRetries) = policy, attempts >= maxRetries {
@@ -235,8 +227,6 @@ final class RetryLoop {
235
227
  if isOnline {
236
228
  if firstOnlineRetryTime == nil { firstOnlineRetryTime = Date() }
237
229
  } else {
238
- // Offline restarts the first-connect clock: the station gets its full online seconds
239
- // again once connectivity returns.
240
230
  firstOnlineRetryTime = nil
241
231
  }
242
232
  if let budget = exhaustedBudget() {
@@ -248,7 +238,7 @@ final class RetryLoop {
248
238
  guard await waitForDelayOrNetworkRestored(delaySeconds: backoff), !Task.isCancelled, shouldRetry() else {
249
239
  return false
250
240
  }
251
- // Re-checked: the wait for connectivity may have been long.
241
+ // The wait for connectivity may have been long.
252
242
  if let budget = exhaustedBudget() {
253
243
  logger.info("\(budget) exceeded after waiting, giving up")
254
244
  return false
@@ -278,7 +268,6 @@ final class RetryLoop {
278
268
  }
279
269
  }
280
270
 
281
- /// True when connectivity returned, false when cancelled.
282
271
  private func waitForNetworkRestored(monitor: any NetworkStatusProviding) async -> Bool {
283
272
  isWaitingForNetwork = true
284
273
  defer { isWaitingForNetwork = false }
@@ -1,55 +1,39 @@
1
1
  import Foundation
2
2
 
3
- /// Manages a shuffled ordering of indices, similar to Media3's ShuffleOrder.
4
- ///
5
- /// The shuffle order maintains a mapping between logical shuffle positions and actual
6
- /// track indices. This allows shuffle to be toggled on/off without reordering the queue.
7
- ///
8
- /// Example with 5 tracks and shuffle order [3, 1, 4, 0, 2]:
9
- /// - Shuffle position 0 → track index 3
10
- /// - Shuffle position 1 → track index 1
11
- /// - Shuffle position 2 → track index 4
12
- /// - etc.
3
+ /// A playback order over queue indices, kept beside the queue so shuffle toggles without
4
+ /// reordering it; similar to Media3's ShuffleOrder. Every index in and out is a queue index.
13
5
  struct ShuffleOrder {
14
- /// Maps shuffle position → track index
6
+ /// Shuffle position → queue index.
15
7
  private(set) var shuffled: [Int]
16
8
 
17
- /// Maps track index → shuffle position (inverse of shuffled)
9
+ /// Queue index → shuffle position; -1 for an index `shuffled` lacks.
18
10
  private(set) var indexInShuffled: [Int]
19
11
 
20
- /// The number of items in the shuffle order
21
12
  var count: Int { shuffled.count }
22
13
 
23
14
  var isEmpty: Bool { shuffled.isEmpty }
24
15
 
25
16
  // MARK: - Initialization
26
17
 
27
- /// Creates an empty shuffle order
28
18
  init() {
29
19
  shuffled = []
30
20
  indexInShuffled = []
31
21
  }
32
22
 
33
- /// Creates a shuffle order for the given length using Fisher-Yates algorithm
34
23
  init(length: Int) {
35
- // Generate shuffled indices using Fisher-Yates
36
24
  shuffled = Self.createShuffledIndices(length: length)
37
25
 
38
- // Build reverse mapping
39
26
  indexInShuffled = Self.buildIndexInShuffled(from: shuffled)
40
27
  }
41
28
 
42
- /// Creates a shuffle order for the given length with `firstIndex` pinned to shuffle position 0.
43
- ///
44
- /// Playback starts on that track, so leaving it wherever the permutation put it would end the
45
- /// queue as soon as it is reached — on average after half the queue, and immediately whenever it
46
- /// lands last.
29
+ /// A random order with `firstIndex` at shuffle position 0. Playback starts on that track, so
30
+ /// left wherever the permutation put it, the queue would end when it is reached: on average
31
+ /// after half the queue, at once when it lands last.
47
32
  init(length: Int, firstIndex: Int) {
48
33
  self.init(length: length)
49
34
  reshuffle(keepingFirst: firstIndex)
50
35
  }
51
36
 
52
- /// Creates a shuffle order with pre-defined indices
53
37
  init(shuffledIndices: [Int]) {
54
38
  shuffled = shuffledIndices
55
39
  indexInShuffled = Self.buildIndexInShuffled(from: shuffledIndices)
@@ -57,19 +41,14 @@ struct ShuffleOrder {
57
41
 
58
42
  // MARK: - Navigation
59
43
 
60
- /// Returns the first index in the shuffle order, or nil if empty
61
44
  var firstIndex: Int? {
62
45
  shuffled.first
63
46
  }
64
47
 
65
- /// Returns the last index in the shuffle order, or nil if empty
66
48
  var lastIndex: Int? {
67
49
  shuffled.last
68
50
  }
69
51
 
70
- /// Returns the next index after the given index in the shuffle order
71
- /// - Parameter index: The current track index
72
- /// - Returns: The next track index, or nil if at the end
73
52
  func getNextIndex(after index: Int) -> Int? {
74
53
  guard index >= 0, index < indexInShuffled.count else { return nil }
75
54
  let shufflePosition = indexInShuffled[index]
@@ -78,9 +57,6 @@ struct ShuffleOrder {
78
57
  return shuffled[nextPosition]
79
58
  }
80
59
 
81
- /// Returns the previous index before the given index in the shuffle order
82
- /// - Parameter index: The current track index
83
- /// - Returns: The previous track index, or nil if at the beginning
84
60
  func getPreviousIndex(before index: Int) -> Int? {
85
61
  guard index >= 0, index < indexInShuffled.count else { return nil }
86
62
  let shufflePosition = indexInShuffled[index]
@@ -89,19 +65,16 @@ struct ShuffleOrder {
89
65
  return shuffled[prevPosition]
90
66
  }
91
67
 
92
- /// Checks if the given index is the last in the shuffle order
93
68
  func isLast(_ index: Int) -> Bool {
94
69
  guard index >= 0, index < indexInShuffled.count else { return false }
95
70
  return indexInShuffled[index] == shuffled.count - 1
96
71
  }
97
72
 
98
- /// Checks if the given index is the first in the shuffle order
99
73
  func isFirst(_ index: Int) -> Bool {
100
74
  guard index >= 0, index < indexInShuffled.count else { return false }
101
75
  return indexInShuffled[index] == 0
102
76
  }
103
77
 
104
- /// The item's position in the shuffle order, or nil when it has none.
105
78
  func shufflePosition(of index: Int) -> Int? {
106
79
  guard index >= 0, index < indexInShuffled.count else { return nil }
107
80
  let position = indexInShuffled[index]
@@ -110,36 +83,30 @@ struct ShuffleOrder {
110
83
 
111
84
  // MARK: - Mutation
112
85
 
113
- /// Inserts items at random positions in the shuffle order
86
+ /// Makes room for `insertionCount` queue items at `insertionIndex`, each at a random shuffle
87
+ /// position.
114
88
  mutating func insert(at insertionIndex: Int, count insertionCount: Int) {
115
89
  guard insertionCount > 0 else { return }
116
90
 
117
- // Adjust existing indices that are >= insertionIndex
118
91
  for i in 0 ..< shuffled.count {
119
92
  if shuffled[i] >= insertionIndex {
120
93
  shuffled[i] += insertionCount
121
94
  }
122
95
  }
123
96
 
124
- // Insert new indices at random positions
125
97
  for i in 0 ..< insertionCount {
126
98
  let newIndex = insertionIndex + i
127
99
  let insertPosition = Int.random(in: 0 ... shuffled.count)
128
100
  shuffled.insert(newIndex, at: insertPosition)
129
101
  }
130
102
 
131
- // Rebuild reverse mapping
132
103
  indexInShuffled = Self.buildIndexInShuffled(from: shuffled)
133
104
  }
134
105
 
135
- /// Inserts one item at `insertionIndex`, placing it at an explicit shuffle
136
- /// position rather than a random one.
137
- ///
138
- /// Used by a queue `move`, which permutes positions but not identities: the
139
- /// item already had a place in the playback order, and re-randomising it
140
- /// silently reorders playback. For the *playing* track it can drop it at the
141
- /// end of the order, which then reads as `isLastInPlaybackOrder` — the queue
142
- /// reports itself over at the next track end, with tracks still unplayed.
106
+ /// Makes room for one queue item at `insertionIndex`, at shuffle position `position` (clamped).
107
+ /// A queue `move` uses this to keep the item's place in the playback order: a random place
108
+ /// reorders playback, and can put the playing track last, so the queue reports itself over at
109
+ /// the next track end with tracks unplayed.
143
110
  mutating func insert(at insertionIndex: Int, atShufflePosition position: Int) {
144
111
  for i in 0 ..< shuffled.count where shuffled[i] >= insertionIndex {
145
112
  shuffled[i] += 1
@@ -148,39 +115,35 @@ struct ShuffleOrder {
148
115
  indexInShuffled = Self.buildIndexInShuffled(from: shuffled)
149
116
  }
150
117
 
151
- /// Removes items in the specified range from the shuffle order
152
118
  mutating func remove(from indexFrom: Int, to indexToExclusive: Int) {
153
119
  let removeCount = indexToExclusive - indexFrom
154
120
  guard removeCount > 0 else { return }
155
121
 
156
- // Remove indices in the range and adjust remaining indices
157
122
  shuffled = shuffled.compactMap { index -> Int? in
158
123
  if index >= indexFrom, index < indexToExclusive {
159
- return nil // Remove this index
124
+ return nil
160
125
  } else if index >= indexToExclusive {
161
- return index - removeCount // Adjust index
126
+ return index - removeCount
162
127
  }
163
128
  return index
164
129
  }
165
130
 
166
- // Rebuild reverse mapping
167
131
  indexInShuffled = Self.buildIndexInShuffled(from: shuffled)
168
132
  }
169
133
 
170
- /// Clears the shuffle order
171
134
  mutating func clear() {
172
135
  shuffled = []
173
136
  indexInShuffled = []
174
137
  }
175
138
 
176
- /// Reshuffles the order, optionally keeping a specific index first or last
139
+ /// A new random order of the same length; an out-of-range `keepingFirst` or `keepingLast` is
140
+ /// ignored.
177
141
  mutating func reshuffle(keepingFirst: Int? = nil, keepingLast: Int? = nil) {
178
142
  let length = shuffled.count
179
143
  guard length > 0 else { return }
180
144
 
181
145
  shuffled = Self.createShuffledIndices(length: length)
182
146
 
183
- // If we have a keepingFirst index, move it to the front
184
147
  if let first = keepingFirst, first >= 0, first < length {
185
148
  if let pos = shuffled.firstIndex(of: first), pos > 0 {
186
149
  shuffled.remove(at: pos)
@@ -188,7 +151,6 @@ struct ShuffleOrder {
188
151
  }
189
152
  }
190
153
 
191
- // If we have a keepingLast index, move it to the end
192
154
  if let last = keepingLast, last >= 0, last < length {
193
155
  if let pos = shuffled.firstIndex(of: last), pos < shuffled.count - 1 {
194
156
  shuffled.remove(at: pos)
@@ -201,7 +163,6 @@ struct ShuffleOrder {
201
163
 
202
164
  // MARK: - Private Helpers
203
165
 
204
- /// Creates shuffled indices using Fisher-Yates algorithm
205
166
  private static func createShuffledIndices(length: Int) -> [Int] {
206
167
  var indices = Array(0 ..< length)
207
168
  for i in stride(from: length - 1, through: 1, by: -1) {
@@ -211,7 +172,6 @@ struct ShuffleOrder {
211
172
  return indices
212
173
  }
213
174
 
214
- /// Builds the reverse mapping from track index to shuffle position
215
175
  private static func buildIndexInShuffled(from shuffled: [Int]) -> [Int] {
216
176
  var result = [Int](repeating: -1, count: shuffled.count)
217
177
  for (position, index) in shuffled.enumerated() {
@@ -4,20 +4,17 @@ import Foundation
4
4
  import NitroModules
5
5
  #endif
6
6
 
7
- /// Type alias for the Nitro SleepTimer variant type
8
7
  typealias SleepTimerState = SleepTimer
9
8
 
10
- /// A scheduled job that has not run yet. `cancel()` is nonisolated so `deinit`
11
- /// — always nonisolated in Swift 6 — can tear pending work down.
9
+ /// A scheduled job not yet run. `cancel()` is nonisolated so `deinit`, always nonisolated in
10
+ /// Swift 6, can tear pending work down.
12
11
  protocol SleepTimerJob: AnyObject {
13
12
  func cancel()
14
13
  }
15
14
 
16
15
  extension DispatchWorkItem: SleepTimerJob {}
17
16
 
18
- /// Runs work after a delay. Injected into `SleepTimerManager` so tests can
19
- /// drive the clock instead of racing it: production schedules on the main
20
- /// queue, tests hand in a scheduler they advance by hand.
17
+ /// Runs work after a delay; injected so tests advance the clock by hand instead of racing it.
21
18
  @MainActor
22
19
  protocol SleepTimerScheduling {
23
20
  func schedule(
@@ -37,17 +34,16 @@ struct MainQueueSleepTimerScheduler: SleepTimerScheduling {
37
34
  }
38
35
  }
39
36
 
40
- /// Manages sleep timer functionality for the audio player.
41
- /// Supports both time-based timers and end-of-track timers.
37
+ /// Holds one sleep timer at a time: a deadline, optionally faded out, or the end of the current
38
+ /// track. Setting one replaces the other.
42
39
  @MainActor
43
40
  final class SleepTimerManager {
44
41
  // MARK: - Properties
45
42
 
46
43
  private let scheduler: any SleepTimerScheduling
47
- /// Fades the volume out before a time-based timer's deadline.
48
44
  private let fader: VolumeFader
49
45
 
50
- // nonisolated(unsafe) for deinit cleanup — deinit is always nonisolated in Swift 6.
46
+ // nonisolated(unsafe) so deinit, always nonisolated in Swift 6, can cancel them.
51
47
  private nonisolated(unsafe) var sleepTimerJob: (any SleepTimerJob)?
52
48
  private nonisolated(unsafe) var fadeJob: (any SleepTimerJob)?
53
49
 
@@ -56,10 +52,9 @@ final class SleepTimerManager {
56
52
  self.scheduler = scheduler
57
53
  }
58
54
 
59
- /// Whether the fade before the deadline is running.
60
55
  var isFading: Bool { fader.isActive }
61
56
 
62
- /// The time when playback should stop (seconds since epoch), or -1 if inactive
57
+ /// The deadline in seconds since 1970, or -1 when there is none.
63
58
  private(set) var sleepTimerTime: TimeInterval = -1 {
64
59
  didSet {
65
60
  if sleepTimerTime > -1 {
@@ -70,7 +65,6 @@ final class SleepTimerManager {
70
65
  }
71
66
  }
72
67
 
73
- /// Whether to stop playback when the current track ends
74
68
  private(set) var willSleepWhenCurrentItemReachesEnd: Bool = false {
75
69
  didSet {
76
70
  if willSleepWhenCurrentItemReachesEnd {
@@ -82,13 +76,12 @@ final class SleepTimerManager {
82
76
  /// Halts playback when the timer fires; the pre-fade volume is restored after it returns.
83
77
  var onComplete: (() -> Void)?
84
78
 
85
- /// Callback invoked when the sleep timer state changes
86
79
  var onChanged: ((SleepTimerState) -> Void)?
87
80
 
88
81
  // MARK: - Public Methods
89
82
 
90
- /// Clears any active sleep timer.
91
- /// - Returns: true if a timer was cleared, false if no timer was active
83
+ /// Clears whichever timer is set and cancels any fade, restoring the volume. False, with no `onChanged`, when none
84
+ /// was set.
92
85
  @discardableResult
93
86
  func clear() -> Bool {
94
87
  let hasSleepTimer = sleepTimerTime > -1 || willSleepWhenCurrentItemReachesEnd
@@ -100,8 +93,7 @@ final class SleepTimerManager {
100
93
  return true
101
94
  }
102
95
 
103
- /// Gets the current sleep timer state.
104
- /// - Returns: The current timer state, or nil if no timer is active
96
+ /// The active timer, its deadline in milliseconds since 1970; nil when none is set.
105
97
  func get() -> SleepTimerState? {
106
98
  let sleepOnEnd = willSleepWhenCurrentItemReachesEnd
107
99
  let hasSleepTimerTime = sleepTimerTime > -1
@@ -109,7 +101,6 @@ final class SleepTimerManager {
109
101
  if !hasSleepTimerTime, !sleepOnEnd { return nil }
110
102
 
111
103
  if hasSleepTimerTime {
112
- // Return time in milliseconds since epoch
113
104
  return .second(SleepTimerTime(time: sleepTimerTime * 1000))
114
105
  }
115
106
 
@@ -120,11 +111,8 @@ final class SleepTimerManager {
120
111
  return nil
121
112
  }
122
113
 
123
- /// Sets a time-based sleep timer.
124
- /// - Parameters:
125
- /// - seconds: Number of seconds until playback stops
126
- /// - fadeDuration: Seconds over which to fade the volume out before the
127
- /// deadline (clamped to `seconds`); silence lands exactly at the deadline
114
+ /// Stops playback `seconds` from now. With `fadeDuration`, the volume fades over that many
115
+ /// seconds (clamped to `seconds`) so silence lands at the deadline.
128
116
  func set(seconds: TimeInterval, fadeDuration: TimeInterval? = nil) {
129
117
  cancelSleepTimerJob()
130
118
  fader.cancel(restoringVolume: true)
@@ -141,7 +129,6 @@ final class SleepTimerManager {
141
129
  if let state = get() { onChanged?(state) }
142
130
  }
143
131
 
144
- /// Sets the timer to stop playback when the current track ends.
145
132
  func setToEndOfTrack() {
146
133
  let changed = !willSleepWhenCurrentItemReachesEnd
147
134
  willSleepWhenCurrentItemReachesEnd = true
@@ -151,7 +138,7 @@ final class SleepTimerManager {
151
138
  }
152
139
  }
153
140
 
154
- /// Called when the current track changes. Resets end-of-track timer.
141
+ /// Clears an end-of-track timer: it applies to the track it was set on, not the next.
155
142
  func onTrackChanged() {
156
143
  if willSleepWhenCurrentItemReachesEnd {
157
144
  willSleepWhenCurrentItemReachesEnd = false
@@ -159,8 +146,6 @@ final class SleepTimerManager {
159
146
  }
160
147
  }
161
148
 
162
- /// Called when the current track plays to end.
163
- /// Triggers completion if end-of-track timer is active.
164
149
  func onTrackPlayedToEnd() {
165
150
  if willSleepWhenCurrentItemReachesEnd {
166
151
  complete()
@@ -1,25 +1,23 @@
1
1
  import Foundation
2
2
 
3
- /// Ramps the player volume down over a duration (sleep-timer fade).
3
+ /// Ramps the volume down to silence over a duration (the sleep-timer fade).
4
4
  /// The gain follows a squared curve: loudness perception is logarithmic, so a
5
- /// linear gain ramp sounds like a late cutoff rather than a fade.
5
+ /// linear ramp sounds like a late cutoff rather than a fade.
6
6
  @MainActor
7
7
  final class VolumeFader {
8
8
  private static let stepInterval: TimeInterval = 0.05
9
9
 
10
10
  private let getVolume: () -> Float
11
11
  private let setVolume: (Float) -> Void
12
- // nonisolated(unsafe) for deinit cleanup — deinit is always nonisolated in Swift 6.
12
+ // nonisolated(unsafe) so `deinit`, which is nonisolated in Swift 6, can invalidate it.
13
13
  private nonisolated(unsafe) var timer: Timer?
14
14
 
15
- /// Volume captured when the fade started; restored after the fade resolves.
16
- /// Non-nil from fade start until cancel/completion, even once the ramp has
17
- /// reached silence.
15
+ /// The volume before the fade, to restore once it resolves. Stays set from
16
+ /// `start` until `cancel` or `resolve`, also after the ramp reaches silence.
18
17
  private(set) var originalVolume: Float?
19
18
 
20
19
  var isActive: Bool { originalVolume != nil }
21
20
 
22
- /// The length of the running fade.
23
21
  private(set) var duration: TimeInterval?
24
22
 
25
23
  init(getVolume: @escaping () -> Float, setVolume: @escaping (Float) -> Void) {
@@ -27,9 +25,12 @@ final class VolumeFader {
27
25
  self.setVolume = setVolume
28
26
  }
29
27
 
28
+ /// Starts a fade, restarting from the pre-fade volume if one is running.
29
+ /// A `duration` of zero or less marks the fade active without touching the
30
+ /// volume.
30
31
  func start(duration: TimeInterval) {
31
- // If a fade is already running, keep its captured volume as the baseline —
32
- // the current (partially faded) volume is not the value to restore.
32
+ // A running fade's current volume is part-faded; its captured one is the
33
+ // value to restore.
33
34
  let baseVolume = originalVolume ?? getVolume()
34
35
  cancel(restoringVolume: false)
35
36
  originalVolume = baseVolume
@@ -50,12 +51,13 @@ final class VolumeFader {
50
51
  }
51
52
  }
52
53
  self.timer = timer
54
+ // `.common` so the ramp keeps running while UIKit tracks a scroll.
53
55
  RunLoop.main.add(timer, forMode: .common)
54
56
  }
55
57
 
56
- /// Stops the ramp. With `restoringVolume` the pre-fade volume is put back
57
- /// immediately (cancellation); without it the caller restores after pausing
58
- /// (completion path — restoring first would let full-volume audio slip out).
58
+ /// Stops the ramp and ends the fade. With `restoringVolume` the pre-fade
59
+ /// volume comes back at once; without it the volume stays where the ramp
60
+ /// left it, for a caller that halts playback before restoring.
59
61
  func cancel(restoringVolume: Bool) {
60
62
  timer?.invalidate()
61
63
  timer = nil
@@ -65,10 +67,8 @@ final class VolumeFader {
65
67
  if restoringVolume { setVolume(originalVolume) }
66
68
  }
67
69
 
68
- /// Resolves the fade around a halting action: stops the ramp, runs `halt`,
69
- /// then restores the pre-fade volume — in that order, because restoring
70
- /// before halting would let full-volume audio slip out. The restore is
71
- /// skipped when no fade was running.
70
+ /// Stops the ramp, runs `halt`, then restores the pre-fade volume (if a fade
71
+ /// was running). Restoring before halting would let full-volume audio out.
72
72
  func resolve(around halt: () -> Void) {
73
73
  let preFadeVolume = originalVolume
74
74
  cancel(restoringVolume: false)