Release 5.1.0

feat: pause player on interruption, resume when necessary

Example/SwiftAudioPlayer/ViewController.swift

@@ -259,7 +259,12 @@ class ViewController: UIViewController {
     @IBAction func rateChanged(_ sender: Any) {
         let speed = rateSlider.value
         rateLabel.text = "rate: \(speed)x"
-        SAPlayer.shared.rate = speed
+        
+        if skipSilencesSwitch.isOn {
+            SAPlayer.Features.SkipSilences.setRateSafely(speed) // if using Skip Silences, we need use this version of setting rate to safely change the rate with the feature enabled.
+        } else {
+            SAPlayer.shared.rate = speed
+        }
     }
     @IBAction func reverbChanged(_ sender: Any) {
         let reverb = reverbSlider.value

README.md

@@ -14,6 +14,7 @@ Thus, using [AudioToolbox](https://developer.apple.com/documentation/audiotoolbo
 
 1. Realtime audio manipulation that includes going up to 10x speed, using [equalizers and other manipulations](https://developer.apple.com/documentation/avfaudio/avaudiouniteq)
 1. Stream online audio using AVAudioEngine
+1. Stream radio
 1. Play locally saved audio with the same API
 1. Download audio
 1. Queue up downloaded and streamed audio for autoplay
@@ -116,16 +117,9 @@ For more details and specifics look at the [API documentation](#api-in-detail) b
 
 ## Contact
 
-### Issues
+### Issues or questions
 
-Submit any issues or requests [on the Github repo](https://github.com/tanhakabir/SwiftAudioPlayer/issues).
-
-### Any questions?
-
-Feel free to reach out to either of us:
-
-[tanhakabir](https://github.com/tanhakabir), tanhakabir.ca@gmail.com
-[JonMercer](https://github.com/JonMercer), mercer.jon@gmail.com
+Submit any issues, requests, and questions [on the Github repo](https://github.com/tanhakabir/SwiftAudioPlayer/issues).
 
 ### License
 

Source/SAPlayer.swift

@@ -123,13 +123,6 @@ public class SAPlayer {
             
             node.rate = value
             playbackRateOfAudioChanged(rate: value)
-            
-            // if skip silences was on, reset it to have the new rate
-            // TODO fix this to rate being broadcasted and handled in only Features.SkipSilences https://github.com/tanhakabir/SwiftAudioPlayer/issues/77
-//            if Features.SkipSilences.enabled && !(value == rate ?? 1.0 - 0.5 || value == rate ?? 1.0 + 0.5) {
-//                _ = Features.SkipSilences.disable()
-//                _ = Features.SkipSilences.enable()
-//            }
         }
     }
     
@@ -183,7 +176,7 @@ public class SAPlayer {
     public var audioQueued: [URL] {
         get {
             return presenter.audioQueue.map { (queued) -> URL in
-                return queued.1
+                return queued.url
             }
         }
     }
@@ -233,11 +226,7 @@ public class SAPlayer {
      
      - Note: Setting this to nil clears the information displayed on the lockscreen media player.
      */
-    public var mediaInfo: SALockScreenInfo? = nil {
-        didSet {
-            presenter.handleLockscreenInfo(info: mediaInfo)
-        }
-    }
+    public var mediaInfo: SALockScreenInfo? = nil
     
     private init() {
         presenter = SAPlayerPresenter(delegate: self)
@@ -255,6 +244,7 @@ public class SAPlayer {
         }
         
         audioModifiers.append(AVAudioUnitTimePitch(audioComponentDescription: componentDescription))
+        NotificationCenter.default.addObserver(self, selector: #selector(handleInterruption), name: AVAudioSession.interruptionNotification, object: nil)
     }
     
     /**
@@ -294,6 +284,36 @@ public class SAPlayer {
     func addUrlToMapping(url: URL) {
         presenter.addUrlToKeyMap(url)
     }
+    
+    @objc func handleInterruption(notification: Notification) {
+        guard let userInfo = notification.userInfo,
+            let typeValue = userInfo[AVAudioSessionInterruptionTypeKey] as? UInt,
+            let type = AVAudioSession.InterruptionType(rawValue: typeValue) else {
+                return
+        }
+
+        // Switch over the interruption type.
+        switch type {
+
+        case .began:
+            // An interruption began. Update the UI as necessary.
+            pause()
+
+        case .ended:
+           // An interruption ended. Resume playback, if appropriate.
+
+            guard let optionsValue = userInfo[AVAudioSessionInterruptionOptionKey] as? UInt else { return }
+            let options = AVAudioSession.InterruptionOptions(rawValue: optionsValue)
+            if options.contains(.shouldResume) {
+                // An interruption ended. Resume playback.
+                play()
+            } else {
+                // An interruption ended. Don't resume playback.
+            }
+
+        default: ()
+        }
+    }	
 }
 
 public enum SAPlayerBitrate {
@@ -414,14 +434,14 @@ extension SAPlayer {
      - Parameter mediaInfo: The media information of the audio to show on the lockscreen media player (optional).
      */
     public func startSavedAudio(withSavedUrl url: URL, mediaInfo: SALockScreenInfo? = nil) {
-        self.mediaInfo = mediaInfo
+        
+        // Because we support queueing, we want to clear off any existing players.
+        // Therefore, instantiate new player every time, destroy any existing ones.
+        // This prevents a crash where an owning engine already exists.
+        presenter.handleClear()
+        
         presenter.handlePlaySavedAudio(withSavedUrl: url)
-    }
-    
-    @available(*, deprecated, renamed: "startSavedAudio")
-    public func initializeSavedAudio(withSavedUrl url: URL, mediaInfo: SALockScreenInfo? = nil) {
         self.mediaInfo = mediaInfo
-        presenter.handlePlaySavedAudio(withSavedUrl: url)
     }
     
     /**
@@ -453,14 +473,14 @@ extension SAPlayer {
      - Parameter mediaInfo: The media information of the audio to show on the lockscreen media player (optional).
      */
     public func startRemoteAudio(withRemoteUrl url: URL, bitrate: SAPlayerBitrate = .high, mediaInfo: SALockScreenInfo? = nil) {
-        self.mediaInfo = mediaInfo
+        
+        // Because we support queueing, we want to clear off any existing players.
+        // Therefore, instantiate new player every time, destroy any existing ones.
+        // This prevents a crash where an owning engine already exists.
+        presenter.handleClear()
+        
         presenter.handlePlayStreamedAudio(withRemoteUrl: url, bitrate: bitrate)
-    }
-    
-    @available(*, deprecated, renamed: "startRemoteAudio")
-    public func initializeRemoteAudio(withRemoteUrl url: URL, mediaInfo: SALockScreenInfo? = nil) {
         self.mediaInfo = mediaInfo
-        presenter.handlePlayStreamedAudio(withRemoteUrl: url, bitrate: .high)
     }
     
     /**
@@ -474,18 +494,21 @@ extension SAPlayer {
      Queues remote audio to be played next. The URLs in the queue can be both remote or on disk but once the queued audio starts playing it will start buffering and loading then. This means no guarantee for a 'gapless' playback where there might be several moments in between one audio ending and another starting due to buffering remote audio.
      
      - Parameter withRemoteUrl: The URL of the remote audio.
+     - Parameter bitrate: The bitrate of the streamed audio. By default the bitrate is set to high for streaming saved audio files. If you want to stream radios then you should use the `low` bitrate option.
+     - Parameter mediaInfo: The media information of the audio to show on the lockscreen media player (optional).
      */
-    public func queueRemoteAudio(withRemoteUrl url: URL) {
-        presenter.handleQueueStreamedAudio(withRemoteUrl: url)
+    public func queueRemoteAudio(withRemoteUrl url: URL, bitrate: SAPlayerBitrate = .high, mediaInfo: SALockScreenInfo? = nil) {
+        presenter.handleQueueStreamedAudio(withRemoteUrl: url, mediaInfo: mediaInfo, bitrate: bitrate)
     }
     
     /**
      Queues saved audio to be played next. The URLs in the queuecan be both remote or on disk but once the queued audio starts playing it will start buffering and loading then. This means no guarantee for a 'gapless' playback where there might be several moments in between one audio ending and another starting due to buffering remote audio.
      
      - Parameter withSavedUrl: The URL of the audio saved on the device.
+     - Parameter mediaInfo: The media information of the audio to show on the lockscreen media player (optional).
      */
-    public func queueSavedAudio(withSavedUrl url: URL) {
-        presenter.handleQueueSavedAudio(withSavedUrl: url)
+    public func queueSavedAudio(withSavedUrl url: URL, mediaInfo: SALockScreenInfo? = nil) {
+        presenter.handleQueueSavedAudio(withSavedUrl: url, mediaInfo: mediaInfo)
     }
     
     /**

Source/SAPlayerDelegate.swift

@@ -27,6 +27,7 @@ import Foundation
 import CoreMedia
 
 protocol SAPlayerDelegate: AnyObject, LockScreenViewProtocol {
+    var mediaInfo: SALockScreenInfo? { get set }
     var skipForwardSeconds: Double { get set }
     var skipBackwardSeconds: Double { get set }
     

Source/SAPlayerFeatures.swift

@@ -29,7 +29,8 @@ extension SAPlayer {
             /**
              Enable feature to skip silences in spoken word audio. The player will speed up the rate of audio playback when silence is detected. This can be called at any point of audio playback.
              
-             - Important: The first audio modifier must be the default `AVAudioUnitTimePitch` that comes with the SAPlayer for this feature to work.
+             - Precondition: The first audio modifier must be the default `AVAudioUnitTimePitch` that comes with the SAPlayer for this feature to work.
+             - Important: If you want to change the rate of the overall player while having skip silences on, please use `SAPlayer.Features.SkipSilences.setRateSafely()` to properly set the rate of the player. Any rate changes to the player will be ignored while using Skip Silences otherwise.
              */
             public static func enable() -> Bool {
                 guard let engine = SAPlayer.shared.engine else { return false }
@@ -72,7 +73,7 @@ extension SAPlayer {
             /**
              Disable feature to skip silences in spoken word audio. The player will speed up the rate of audio playback when silence is detected. This can be called at any point of audio playback.
              
-             - Important: The first audio modifier must be the default `AVAudioUnitTimePitch` that comes with the SAPlayer for this feature to work.
+             - Precondition: The first audio modifier must be the default `AVAudioUnitTimePitch` that comes with the SAPlayer for this feature to work.
              */
             public static func disable() -> Bool {
                 guard let engine = SAPlayer.shared.engine else { return false }
@@ -83,6 +84,16 @@ extension SAPlayer {
                 return true
             }
             
+            /**
+             Use this function to set the overall rate of the player for when skip silences is on. This ensures that the overall rate will be what is set through this function even as skip silences is on; if this function is not used then any changes asked of from the overall player while skip silences is on won't be recorded!
+             
+             - Important: The first audio modifier must be the default `AVAudioUnitTimePitch` that comes with the SAPlayer for this feature to work.
+             */
+            public static func setRateSafely(_ rate: Float) {
+                originalRate = rate
+                SAPlayer.shared.rate = rate
+            }
+            
             private static func scaledPower(power: Float) -> Float {
                 guard power.isFinite else { return 0.0 }
                 let minDb: Float = -80.0

Source/SAPlayerPresenter.swift

@@ -28,6 +28,20 @@ import AVFoundation
 import MediaPlayer
 
 class SAPlayerPresenter {
+    struct QueueItem {
+        var loc: Location
+        var url: URL
+        var mediaInfo: SALockScreenInfo?
+        var bitrate: SAPlayerBitrate
+        
+        init(loc: Location, url: URL, mediaInfo: SALockScreenInfo?, bitrate: SAPlayerBitrate = .high) {
+            self.loc = loc
+            self.url = url
+            self.mediaInfo = mediaInfo
+            self.bitrate = bitrate
+        }
+    }
+    
     enum Location {
         case remote
         case disk
@@ -41,14 +55,13 @@ class SAPlayerPresenter {
     
     private var key: String?
     private var isPlaying: SAPlayingStatus = .buffering
-    private var mediaInfo: SALockScreenInfo?
     
     private var urlKeyMap: [Key: URL] = [:]
     
     var durationRef:UInt = 0
     var needleRef:UInt = 0
     var playingStatusRef:UInt = 0
-    var audioQueue: [(Location, URL)] = []
+    var audioQueue: [QueueItem] = []
     
     init(delegate: SAPlayerDelegate?) {
         self.delegate = delegate
@@ -70,7 +83,7 @@ class SAPlayerPresenter {
         needle = nil
         duration = nil
         key = nil
-        mediaInfo = nil
+        delegate?.mediaInfo = nil
         delegate?.clearLockScreenInfo()
         
         AudioClockDirector.shared.detachFromChangesInDuration(withID: durationRef)
@@ -79,29 +92,21 @@ class SAPlayerPresenter {
     }
     
     func handlePlaySavedAudio(withSavedUrl url: URL) {
-        // Because we support queueing, we want to clear off any existing players.
-        // Therefore, instantiate new player every time, destroy any existing ones.
-        // This prevents a crash where an owning engine already exists.
-        handleClear()
         attachForUpdates(url: url)
         delegate?.startAudioDownloaded(withSavedUrl: url)
     }
     
     func handlePlayStreamedAudio(withRemoteUrl url: URL, bitrate: SAPlayerBitrate) {
-        // Because we support queueing, we want to clear off any existing players.
-        // Therefore, instantiate new player every time, destroy any existing ones.
-        // This prevents a crash where an owning engine already exists.
-        handleClear()
         attachForUpdates(url: url)
         delegate?.startAudioStreamed(withRemoteUrl: url, bitrate: bitrate)
     }
     
-    func handleQueueStreamedAudio(withRemoteUrl url: URL) {
-        audioQueue.append((.remote, url))
+    func handleQueueStreamedAudio(withRemoteUrl url: URL, mediaInfo: SALockScreenInfo?, bitrate: SAPlayerBitrate) {
+        audioQueue.append(QueueItem(loc: .remote, url: url, mediaInfo: mediaInfo, bitrate: bitrate))
     }
     
-    func handleQueueSavedAudio(withSavedUrl url: URL) {
-        audioQueue.append((.disk, url))
+    func handleQueueSavedAudio(withSavedUrl url: URL, mediaInfo: SALockScreenInfo?) {
+        audioQueue.append(QueueItem(loc: .disk, url: url, mediaInfo: mediaInfo))
     }
     
     private func attachForUpdates(url: URL) {
@@ -120,7 +125,7 @@ class SAPlayerPresenter {
             self.delegate?.updateLockscreenPlaybackDuration(duration: duration)
             self.duration = duration
             
-            self.delegate?.setLockScreenInfo(withMediaInfo: self.mediaInfo, duration: duration)
+            self.delegate?.setLockScreenInfo(withMediaInfo: self.delegate?.mediaInfo, duration: duration)
         })
         
         needleRef = AudioClockDirector.shared.attachToChangesInNeedle(closure: { [weak self] (key, needle) in
@@ -164,11 +169,6 @@ class SAPlayerPresenter {
         delegate?.clearEngine()
         detachFromUpdates()
     }
-    
-    @available(iOS 10.0, *)
-    func handleLockscreenInfo(info: SALockScreenInfo?) {
-        self.mediaInfo = info
-    }
 }
 
 //MARK:- Used by outside world including:
@@ -238,24 +238,26 @@ extension SAPlayerPresenter {
             return
         }
         let nextAudioURL = audioQueue.removeFirst()
-        let key = nextAudioURL.1.key
+        let key = nextAudioURL.url.key
         
 
         Log.info("getting ready to play \(nextAudioURL)")
-        AudioQueueDirector.shared.changeInQueue(key, url: nextAudioURL.1)
+        AudioQueueDirector.shared.changeInQueue(key, url: nextAudioURL.url)
         
         handleClear()
         
+        delegate?.mediaInfo = nextAudioURL.mediaInfo
+        
         // We need to give a second to clean up the previous engine properly. Deinit takes some time.
         Timer.scheduledTimer(withTimeInterval: 1.0, repeats: false) { [weak self] (_) in
             guard let self = self else { return }
             
-            switch nextAudioURL.0 {
+            switch nextAudioURL.loc {
             case .remote:
-                self.handlePlayStreamedAudio(withRemoteUrl: nextAudioURL.1, bitrate: .high) // TODO fix to add option for low birate
+                self.handlePlayStreamedAudio(withRemoteUrl: nextAudioURL.url, bitrate: nextAudioURL.bitrate)
                 break
             case .disk:
-                self.handlePlaySavedAudio(withSavedUrl: nextAudioURL.1)
+                self.handlePlaySavedAudio(withSavedUrl: nextAudioURL.url)
             }
             
             self.shouldPlayImmediately = true

SwiftAudioPlayer.podspec

@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = 'SwiftAudioPlayer'
-  s.version          = '5.0.3'
+  s.version          = '5.1.0'
   s.summary          = 'SwiftAudioPlayer is a Swift based audio player that can handle streaming from a remote location and audio manipulation.'
 
 # This description is used to generate tags and improve search results.
@@ -26,7 +26,7 @@ SwiftAudioPlayer is a Swift based audio player that can handle streaming from a
   s.license          = { :type => 'MIT', :file => 'LICENSE' }
   s.author           = { 'tanhakabir' => 'tanhakabir.ca@gmail.com', 'JonMercer' => 'mercer.jon@gmail.com' }
   s.source           = { :git => 'https://github.com/tanhakabir/SwiftAudioPlayer.git', :tag => s.version.to_s }
-s.social_media_url = 'https://twitter.com/_tanhakabir'
+  s.social_media_url = 'https://twitter.com/_tanhakabir'
 
   s.ios.deployment_target = '10.0'