PlayerSettings: start audio playback only on explicit press on Play

Author: BLeeEZ

Amperfy/Screens/ViewController/SettingsHostVC.swift

@@ -122,6 +122,11 @@ class SettingsHostVC: UIViewController {
             self.appDelegate.storage.settings.isScrobbleStreamedItems = newValue
         }))
 
+        settings.isPlaybackStartOnlyOnPlay = self.appDelegate.storage.settings.isPlaybackStartOnlyOnPlay
+        changesAgent.append(settings.$isPlaybackStartOnlyOnPlay.sink(receiveValue: { newValue in
+            self.appDelegate.storage.settings.isPlaybackStartOnlyOnPlay = newValue
+        }))
+        
         settings.swipeActionSettings = self.appDelegate.storage.settings.swipeActionSettings
         changesAgent.append(settings.$swipeActionSettings.sink(receiveValue: { newValue in
             self.appDelegate.storage.settings.swipeActionSettings = newValue

Amperfy/SwiftUI/Settings/ObservableSettings.swift

@@ -38,6 +38,7 @@ final class Settings: ObservableObject {
     @Published var isAutoCacheLatestPodcastEpisodes = false
     @Published var isPlayerAutoCachePlayedItems = false
     @Published var isScrobbleStreamedItems = false
+    @Published var isPlaybackStartOnlyOnPlay = false
     @Published var isShowMusicPlayerSkipButtons = false
     @Published var swipeActionSettings = SwipeActionSettings(leading: [], trailing: [])
     @Published var cacheSizeLimit : Int = 0 // limit in byte

Amperfy/SwiftUI/Settings/PlayerSettingsView.swift

@@ -206,6 +206,18 @@ struct PlayerSettingsView: View {
                 , footer: {
                     Text("Transcoding is recommended due to incompatibility with some formats. Changes will not effect already downloaded songs, if this is wanted: Clear cache and redownload. \(((appDelegate.storage.loginCredentials?.backendApi ?? .ampache) == .ampache) ? "" : "\nIf cache format 'raw' is selected Amperfy will use the Subsonic API action 'download' for caching. Every other option requires Amperfy to use the Subsonic API action 'stream' for caching. Only 'stream' allows server side transcoding. Please check for correct server configuration regarding the active API action.")")
                 })
+                
+                Section(content: {
+                    HStack {
+                        Text("Start audio playback only on explicit press on Play")
+                        Spacer()
+                        Toggle(isOn: $settings.isPlaybackStartOnlyOnPlay) {}
+                            .frame(width: 130)
+                    }
+                }
+                , footer: {
+                    Text("When enabled, audio playback starts only when the Play button is actively pressed. Otherwise, audio playback starts automatically.")
+                })
             }
         }
         .navigationTitle("Player, Stream & Scrobble")

AmperfyKit/AmperfyKit.swift

@@ -81,7 +81,7 @@ public class AmperKit {
         }
         let playerData = storage.main.library.getPlayerData()
         let queueHandler = PlayQueueHandler(playerData: playerData)
-        let curPlayer = AudioPlayer(coreData: playerData, queueHandler: queueHandler, backendAudioPlayer: backendAudioPlayer, userStatistics: userStatistics)
+        let curPlayer = AudioPlayer(coreData: playerData, queueHandler: queueHandler, backendAudioPlayer: backendAudioPlayer, settings: storage.settings, userStatistics: userStatistics)
         audioSessionHandler.musicPlayer = curPlayer
         audioSessionHandler.configureObserverForAudioSessionInterruption()
 

AmperfyKit/Player/AudioPlayer.swift

@@ -44,14 +44,16 @@ public class AudioPlayer: NSObject, BackendAudioPlayerNotifiable  {
     private var playerStatus: PlayerStatusPersistent
     private var queueHandler: PlayQueueHandler
     private let backendAudioPlayer: BackendAudioPlayer
+    private let settings: PersistentStorage.Settings
     private let userStatistics: UserStatistics
     private var notifierList = [MusicPlayable]()
 
-    init(coreData: PlayerStatusPersistent, queueHandler: PlayQueueHandler, backendAudioPlayer: BackendAudioPlayer, userStatistics: UserStatistics) {
+    init(coreData: PlayerStatusPersistent, queueHandler: PlayQueueHandler, backendAudioPlayer: BackendAudioPlayer, settings: PersistentStorage.Settings, userStatistics: UserStatistics) {
         self.playerStatus = coreData
         self.queueHandler = queueHandler
         self.backendAudioPlayer = backendAudioPlayer
         self.backendAudioPlayer.isAutoCachePlayedItems = coreData.isAutoCachePlayedItems
+        self.settings = settings
         self.userStatistics = userStatistics
         super.init()
         self.backendAudioPlayer.responder = self
@@ -79,7 +81,7 @@ public class AudioPlayer: NSObject, BackendAudioPlayerNotifiable  {
     private func insertIntoPlayer(playable: AbstractPlayable) {
         userStatistics.playedItem(repeatMode: playerStatus.repeatMode, isShuffle: playerStatus.isShuffle)
         playable.countPlayed()
-        backendAudioPlayer.requestToPlay(playable: playable, playbackRate: playerStatus.playbackRate)
+        backendAudioPlayer.requestToPlay(playable: playable, playbackRate: playerStatus.playbackRate, autoStartPlayback: !self.settings.isPlaybackStartOnlyOnPlay)
     }
 
     //BackendAudioPlayerNotifiable

AmperfyKit/Player/BackendAudioPlayer.swift

@@ -144,7 +144,7 @@ class BackendAudioPlayer {
         player.seek(to: CMTime(seconds: toSecond, preferredTimescale: CMTimeScale(NSEC_PER_SEC)))
     }
 
-    func requestToPlay(playable: AbstractPlayable, playbackRate: PlaybackRate) {
+    func requestToPlay(playable: AbstractPlayable, playbackRate: PlaybackRate, autoStartPlayback: Bool) {
         userDefinedPlaybackRate = playbackRate
         if let relFilePath = playable.relFilePath,
            fileManager.fileExits(relFilePath: relFilePath) {
@@ -153,7 +153,11 @@ class BackendAudioPlayer {
                 return
             }
             insertCachedPlayable(playable: playable)
-            self.continuePlay()
+            if autoStartPlayback {
+                self.continuePlay()
+            } else {
+                isPlaying = false
+            }
             self.responder?.notifyItemPreparationFinished()
         } else if !isOfflineMode{
             guard playable.isPlayableOniOS || backendApi.isStreamingTranscodingActive else {
@@ -167,7 +171,11 @@ class BackendAudioPlayer {
                 if self.isAutoCachePlayedItems {
                     self.playableDownloader.download(object: playable)
                 }
-                self.continuePlay()
+                if autoStartPlayback {
+                    self.continuePlay()
+                } else {
+                    self.isPlaying = false
+                }
                 self.responder?.notifyItemPreparationFinished()
             }.catch { error in
                 self.responder?.notifyErrorOccured(error: error)

AmperfyKit/Storage/PersistentStorage.swift

@@ -248,6 +248,7 @@ public class PersistentStorage {
         case IsAutoDownloadLatestSongsActive = "isAutoDownloadLatestSongsActive"
         case IsAutoDownloadLatestPodcastEpisodesActive = "isAutoDownloadLatestPodcastEpisodesActive"
         case IsScrobbleStreamedItems = "isScrobbleStreamedItems"
+        case IsPlaybackStartOnlyOnPlay = "isPlaybackStartOnlyOnPlay"
         case LibrarySyncVersion = "librarySyncVersion"
 
         case LibrarySyncInfoReadByUser = "librarySyncInfoReadByUser"
@@ -453,6 +454,11 @@ public class PersistentStorage {
             set { UserDefaults.standard.set(newValue, forKey: UserDefaultsKey.IsScrobbleStreamedItems.rawValue) }
         }
 
+        public var isPlaybackStartOnlyOnPlay: Bool {
+            get { return UserDefaults.standard.object(forKey: UserDefaultsKey.IsPlaybackStartOnlyOnPlay.rawValue) as? Bool ?? false }
+            set { UserDefaults.standard.set(newValue, forKey: UserDefaultsKey.IsPlaybackStartOnlyOnPlay.rawValue) }
+        }
+        
         public var isOnlineMode: Bool {
             return !isOfflineMode
         }