@capgo/native-audio 7.1.8 → 7.3.9

package/ios/Plugin/Plugin.swift

@@ -28,9 +28,10 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
         CAPPluginMethod(name: "getCurrentTime", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getDuration", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "resume", returnType: CAPPluginReturnPromise),
-        CAPPluginMethod(name: "setCurrentTime", returnType: CAPPluginReturnPromise)
+        CAPPluginMethod(name: "setCurrentTime", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "clearCache", returnType: CAPPluginReturnPromise)
     ]
-    private let audioQueue = DispatchQueue(label: "ee.forgr.audio.queue", qos: .userInitiated)
+    internal let audioQueue = DispatchQueue(label: "ee.forgr.audio.queue", qos: .userInitiated, attributes: .concurrent)
     private var audioList: [String: Any] = [:] {
         didSet {
             // Ensure audioList modifications happen on audioQueue
@@ -41,17 +42,85 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
     var fadeMusic = false
     var session = AVAudioSession.sharedInstance()
 
-    override public func load() {
+    // Add observer for audio session interruptions
+    private var interruptionObserver: Any?
+
+    @objc override public func load() {
         super.load()
         audioQueue.setSpecific(key: queueKey, value: true)
 
         self.fadeMusic = false
 
+        setupAudioSession()
+        setupInterruptionHandling()
+
+        NotificationCenter.default.addObserver(forName: UIApplication.didEnterBackgroundNotification, object: nil, queue: .main) { [weak self] _ in
+            guard let strongSelf = self else { return }
+
+            // When entering background, automatically deactivate audio session if not playing any audio
+            strongSelf.audioQueue.sync {
+                // Check if there are any playing assets
+                let hasPlayingAssets = strongSelf.audioList.values.contains { asset in
+                    if let audioAsset = asset as? AudioAsset {
+                        return audioAsset.isPlaying()
+                    }
+                    return false
+                }
+
+                if !hasPlayingAssets {
+                    strongSelf.endSession()
+                }
+            }
+        }
+    }
+
+    // Clean up on deinit
+    deinit {
+        if let observer = interruptionObserver {
+            NotificationCenter.default.removeObserver(observer)
+        }
+    }
+
+    private func setupAudioSession() {
         do {
             try self.session.setCategory(AVAudioSession.Category.playback, options: .mixWithOthers)
+            try self.session.setActive(true)
             try self.session.setActive(false)
         } catch {
-            print("Failed to set session category")
+            print("Failed to setup audio session: \(error)")
+        }
+    }
+
+    private func setupInterruptionHandling() {
+        // Handle audio session interruptions
+        interruptionObserver = NotificationCenter.default.addObserver(
+            forName: AVAudioSession.interruptionNotification,
+            object: nil,
+            queue: nil) { [weak self] notification in
+            guard let strongSelf = self else { return }
+
+            guard let userInfo = notification.userInfo,
+                  let typeInt = userInfo[AVAudioSessionInterruptionTypeKey] as? UInt,
+                  let type = AVAudioSession.InterruptionType(rawValue: typeInt) else {
+                return
+            }
+
+            switch type {
+            case .began:
+                // Audio was interrupted - we could pause all playing audio here
+                strongSelf.notifyListeners("interrupt", data: ["interrupted": true])
+            case .ended:
+                // Interruption ended - we could resume audio here if appropriate
+                if let optionsInt = userInfo[AVAudioSessionInterruptionOptionKey] as? UInt,
+                   AVAudioSession.InterruptionOptions(rawValue: optionsInt).contains(.shouldResume) {
+                    // Resume playback if appropriate (user wants to resume)
+                    strongSelf.notifyListeners("interrupt", data: ["interrupted": false, "shouldResume": true])
+                } else {
+                    strongSelf.notifyListeners("interrupt", data: ["interrupted": false, "shouldResume": false])
+                }
+            @unknown default:
+                break
+            }
         }
     }
 
@@ -61,65 +130,29 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
         }
 
         let focus = call.getBool(Constant.FocusAudio) ?? false
-        do {
-            if focus {
-                try self.session.setCategory(AVAudioSession.Category.playback, options: .duckOthers)
-
-            }
-
-        } catch {
-
-            print("Failed to set setCategory audio")
-
-        }
-
         let background = call.getBool(Constant.Background) ?? false
+        let ignoreSilent = call.getBool(Constant.IgnoreSilent) ?? true
 
+        // Use a single audio session configuration block for better atomicity
         do {
+            try self.session.setActive(true)
 
-            if background {
-
-                try self.session.setActive(true)
+            if focus {
+                try self.session.setCategory(AVAudioSession.Category.playback, options: .duckOthers)
+            } else if !ignoreSilent {
+                try self.session.setCategory(AVAudioSession.Category.ambient, options: focus ? .duckOthers : .mixWithOthers)
+            } else {
+                try self.session.setCategory(AVAudioSession.Category.playback, options: .mixWithOthers)
+            }
 
+            if !background {
+                try self.session.setActive(false)
             }
 
         } catch {
-
-            print("Failed to set setSession true")
-
+            print("Failed to configure audio session: \(error)")
         }
 
-        let ignoreSilent = call.getBool(Constant.IgnoreSilent) ?? true
-
-        do {
-
-            if ignoreSilent == false {
-
-                if let focus = call.getBool(Constant.FocusAudio) {
-
-                    do {
-
-                        if focus {
-
-                            try self.session.setCategory(AVAudioSession.Category.ambient, options: .duckOthers)
-
-                        } else {
-
-                            try self.session.setCategory(
-                                AVAudioSession.Category.ambient, options: .mixWithOthers)
-
-                        }
-
-                    } catch {
-
-                        print("Failed to set setCategory audio")
-
-                    }
-
-                }
-
-            }
-        }
         call.resolve()
     }
 
@@ -144,7 +177,7 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
         do {
             try self.session.setActive(true)
         } catch {
-            print("Failed to set session active")
+            print("Failed to set session active: \(error)")
         }
     }
 
@@ -152,7 +185,7 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
         do {
             try self.session.setActive(false, options: .notifyOthersOnDeactivation)
         } catch {
-            print("Failed to deactivate audio session")
+            print("Failed to deactivate audio session: \(error)")
         }
     }
 
@@ -162,21 +195,17 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
 
     @objc func play(_ call: CAPPluginCall) {
         let audioId = call.getString(Constant.AssetIdKey) ?? ""
-        let time = call.getDouble("time") ?? 0
-        let delay = call.getDouble("delay") ?? 0
+        let time = max(call.getDouble("time") ?? 0, 0) // Ensure non-negative time
+        let delay = max(call.getDouble("delay") ?? 0, 0) // Ensure non-negative delay
 
-        if audioId.isEmpty {
-            call.reject(Constant.ErrorAssetId)
-            return
-        }
-
-        audioQueue.async {
-            guard !self.audioList.isEmpty else {
+        // Use sync for operations that need to be blocking
+        audioQueue.sync {
+            guard !audioList.isEmpty else {
                 call.reject("Audio list is empty")
                 return
             }
 
-            guard let asset = self.audioList[audioId] else {
+            guard let asset = audioList[audioId] else {
                 call.reject(Constant.ErrorAssetNotFound)
                 return
             }
@@ -200,48 +229,29 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
     }
 
     @objc private func getAudioAsset(_ call: CAPPluginCall) -> AudioAsset? {
-        let audioId = call.getString(Constant.AssetIdKey) ?? ""
-        if audioId.isEmpty {
-            call.reject(Constant.ErrorAssetId)
-            return nil
-        }
-
         var asset: AudioAsset?
-        audioQueue.sync {
-            if self.audioList.isEmpty {
-                call.reject("Audio list is empty")
-                return
-            }
-
-            guard let foundAsset = self.audioList[audioId] as? AudioAsset else {
-                call.reject(Constant.ErrorAssetNotFound + " - " + audioId)
-                return
-            }
-            asset = foundAsset
-        }
-
-        if asset == nil {
-            call.reject("Failed to get audio asset")
-            return nil
+        audioQueue.sync { // Read operations should use sync
+            asset = self.audioList[call.getString(Constant.AssetIdKey) ?? ""] as? AudioAsset
         }
         return asset
     }
 
     @objc func setCurrentTime(_ call: CAPPluginCall) {
-        audioQueue.async {
+        // Consistent use of audioQueue.sync for all operations
+        audioQueue.sync {
             guard let audioAsset: AudioAsset = self.getAudioAsset(call) else {
                 call.reject("Failed to get audio asset")
                 return
             }
 
-            let time = call.getDouble("time") ?? 0
+            let time = max(call.getDouble("time") ?? 0, 0) // Ensure non-negative time
             audioAsset.setCurrentTime(time: time)
             call.resolve()
         }
     }
 
     @objc func getDuration(_ call: CAPPluginCall) {
-        audioQueue.async {
+        audioQueue.sync {
             guard let audioAsset: AudioAsset = self.getAudioAsset(call) else {
                 call.reject("Failed to get audio asset")
                 return
@@ -254,7 +264,7 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
     }
 
     @objc func getCurrentTime(_ call: CAPPluginCall) {
-        audioQueue.async {
+        audioQueue.sync {
             guard let audioAsset: AudioAsset = self.getAudioAsset(call) else {
                 call.reject("Failed to get audio asset")
                 return
@@ -267,7 +277,7 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
     }
 
     @objc func resume(_ call: CAPPluginCall) {
-        audioQueue.async {
+        audioQueue.sync {
             guard let audioAsset: AudioAsset = self.getAudioAsset(call) else {
                 call.reject("Failed to get audio asset")
                 return
@@ -279,7 +289,7 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
     }
 
     @objc func pause(_ call: CAPPluginCall) {
-        audioQueue.async {
+        audioQueue.sync {
             guard let audioAsset: AudioAsset = self.getAudioAsset(call) else {
                 call.reject("Failed to get audio asset")
                 return
@@ -294,7 +304,7 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
     @objc func stop(_ call: CAPPluginCall) {
         let audioId = call.getString(Constant.AssetIdKey) ?? ""
 
-        audioQueue.async {
+        audioQueue.sync {
             guard !self.audioList.isEmpty else {
                 call.reject("Audio list is empty")
                 return
@@ -305,13 +315,13 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
                 self.endSession()
                 call.resolve()
             } catch {
-                call.reject(Constant.ErrorAssetNotFound)
+                call.reject(error.localizedDescription)
             }
         }
     }
 
     @objc func loop(_ call: CAPPluginCall) {
-        audioQueue.async {
+        audioQueue.sync {
             guard let audioAsset: AudioAsset = self.getAudioAsset(call) else {
                 call.reject("Failed to get audio asset")
                 return
@@ -325,7 +335,7 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
     @objc func unload(_ call: CAPPluginCall) {
         let audioId = call.getString(Constant.AssetIdKey) ?? ""
 
-        audioQueue.async {
+        audioQueue.sync(flags: .barrier) { // Use barrier for writing operations
             guard !self.audioList.isEmpty else {
                 call.reject("Audio list is empty")
                 return
@@ -335,6 +345,11 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
                 asset.unload()
                 self.audioList[audioId] = nil
                 call.resolve()
+            } else if let audioNumber = self.audioList[audioId] as? NSNumber {
+                // Also handle unloading system sounds
+                AudioServicesDisposeSystemSoundID(SystemSoundID(audioNumber.intValue))
+                self.audioList[audioId] = nil
+                call.resolve()
             } else {
                 call.reject("Cannot cast to AudioAsset")
             }
@@ -342,33 +357,33 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
     }
 
     @objc func setVolume(_ call: CAPPluginCall) {
-        audioQueue.async {
+        audioQueue.sync {
             guard let audioAsset: AudioAsset = self.getAudioAsset(call) else {
                 call.reject("Failed to get audio asset")
                 return
             }
 
-            let volume = call.getFloat(Constant.Volume) ?? 1.0
+            let volume = min(max(call.getFloat(Constant.Volume) ?? Constant.DefaultVolume, Constant.MinVolume), Constant.MaxVolume)
             audioAsset.setVolume(volume: volume as NSNumber)
             call.resolve()
         }
     }
 
     @objc func setRate(_ call: CAPPluginCall) {
-        audioQueue.async {
+        audioQueue.sync {
             guard let audioAsset: AudioAsset = self.getAudioAsset(call) else {
                 call.reject("Failed to get audio asset")
                 return
             }
 
-            let rate = call.getFloat(Constant.Rate) ?? 1.0
+            let rate = min(max(call.getFloat(Constant.Rate) ?? Constant.DefaultRate, Constant.MinRate), Constant.MaxRate)
             audioAsset.setRate(rate: rate as NSNumber)
             call.resolve()
         }
     }
 
     @objc func isPlaying(_ call: CAPPluginCall) {
-        audioQueue.async {
+        audioQueue.sync {
             guard let audioAsset: AudioAsset = self.getAudioAsset(call) else {
                 call.reject("Failed to get audio asset")
                 return
@@ -380,40 +395,53 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
         }
     }
 
-    private func preloadAsset(_ call: CAPPluginCall, isComplex complex: Bool) {
+    @objc func clearCache(_ call: CAPPluginCall) {
+        DispatchQueue.global(qos: .background).async {
+            RemoteAudioAsset.clearCache()
+            call.resolve()
+        }
+    }
+
+    @objc private func preloadAsset(_ call: CAPPluginCall, isComplex complex: Bool) {
+        // Common default values to ensure consistency
         let audioId = call.getString(Constant.AssetIdKey) ?? ""
         let channels: Int?
         let volume: Float?
         let delay: Float?
         var isLocalUrl: Bool = call.getBool("isUrl") ?? false
+
         if audioId == "" {
             call.reject(Constant.ErrorAssetId)
             return
         }
         var assetPath: String = call.getString(Constant.AssetPathKey) ?? ""
 
+        if assetPath == "" {
+            call.reject(Constant.ErrorAssetPath)
+            return
+        }
+
         if complex {
-            volume = call.getFloat("volume") ?? 1.0
-            channels = call.getInt("channels") ?? 1
-            delay = call.getFloat("delay") ?? 1.0
+            volume = min(max(call.getFloat("volume") ?? Constant.DefaultVolume, Constant.MinVolume), Constant.MaxVolume)
+            channels = max(call.getInt("channels") ?? Constant.DefaultChannels, 1)
+            delay = max(call.getFloat("delay") ?? Constant.DefaultFadeDelay, 0.0)
         } else {
-            channels = 0
-            volume = 0
-            delay = 0
+            channels = Constant.DefaultChannels
+            volume = Constant.DefaultVolume
+            delay = Constant.DefaultFadeDelay
             isLocalUrl = false
         }
 
-        if audioList.isEmpty {
-            audioList = [:]
-        }
+        audioQueue.sync(flags: .barrier) { [self] in
+            if audioList.isEmpty {
+                audioList = [:]
+            }
+
+            if audioList[audioId] != nil {
+                call.reject(Constant.ErrorAssetAlreadyLoaded + " - " + audioId)
+                return
+            }
 
-        let asset = audioList[audioId]
-        let queue = DispatchQueue(label: "ee.forgr.audio.simple.queue", qos: .userInitiated)
-        if asset != nil {
-            call.reject(Constant.ErrorAssetAlreadyLoaded + " - " + audioId)
-            return
-        }
-        queue.async {
             var basePath: String?
             if let url = URL(string: assetPath), url.scheme != nil {
                 // Handle remote URL
@@ -423,11 +451,14 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
                 return
             } else if isLocalUrl == false {
                 // Handle public folder
-                // if assetPath doesnt start with public/ add it
                 assetPath = assetPath.starts(with: "public/") ? assetPath : "public/" + assetPath
-
                 let assetPathSplit = assetPath.components(separatedBy: ".")
-                basePath = Bundle.main.path(forResource: assetPathSplit[0], ofType: assetPathSplit[1])
+                if assetPathSplit.count >= 2 {
+                    basePath = Bundle.main.path(forResource: assetPathSplit[0], ofType: assetPathSplit[1])
+                } else {
+                    call.reject("Invalid asset path format: \(assetPath)")
+                    return
+                }
             } else {
                 // Handle local file URL
                 let fileURL = URL(fileURLWithPath: assetPath)
@@ -438,8 +469,13 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
                 if !complex {
                     let soundFileUrl = URL(fileURLWithPath: basePath)
                     var soundId = SystemSoundID()
-                    AudioServicesCreateSystemSoundID(soundFileUrl as CFURL, &soundId)
-                    self.audioList[audioId] = NSNumber(value: Int32(soundId))
+                    let result = AudioServicesCreateSystemSoundID(soundFileUrl as CFURL, &soundId)
+                    if result == kAudioServicesNoError {
+                        self.audioList[audioId] = NSNumber(value: Int32(soundId))
+                    } else {
+                        call.reject("Failed to create system sound: \(result)")
+                        return
+                    }
                 } else {
                     let audioAsset = AudioAsset(
                         owner: self,
@@ -456,8 +492,13 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
                 if !complex {
                     let soundFileUrl = URL(fileURLWithPath: assetPath)
                     var soundId = SystemSoundID()
-                    AudioServicesCreateSystemSoundID(soundFileUrl as CFURL, &soundId)
-                    self.audioList[audioId] = NSNumber(value: Int32(soundId))
+                    let result = AudioServicesCreateSystemSoundID(soundFileUrl as CFURL, &soundId)
+                    if result == kAudioServicesNoError {
+                        self.audioList[audioId] = NSNumber(value: Int32(soundId))
+                    } else {
+                        call.reject("Failed to create system sound: \(result)")
+                        return
+                    }
                 } else {
                     let audioAsset = AudioAsset(
                         owner: self,
@@ -482,9 +523,31 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
         }
 
         if self.fadeMusic {
-            audioAsset.playWithFade(time: audioAsset.getCurrentTime())
+            audioAsset.stopWithFade()
         } else {
             audioAsset.stop()
         }
     }
+
+    internal func executeOnAudioQueue(_ block: @escaping () -> Void) {
+        if DispatchQueue.getSpecific(key: queueKey) != nil {
+            block()  // Already on queue
+        } else {
+            audioQueue.sync(flags: .barrier) {
+                block()
+            }
+        }
+    }
+
+    @objc func notifyCurrentTime(_ asset: AudioAsset) {
+        audioQueue.sync {
+            let rawTime = asset.getCurrentTime()
+            // Round to nearest 100ms (0.1 seconds)
+            let currentTime = round(rawTime * 10) / 10
+            notifyListeners("currentTime", data: [
+                "currentTime": currentTime,
+                "assetId": asset.assetId
+            ])
+        }
+    }
 }