Release 2.11.0

* cancels streaming initally, but player enters weird state trying to stream again

* calling superclass invalidate from engines for good measure

* Fix UI to fix seemingly weird state

* Fix error warning

Example/SwiftAudioPlayer/ViewController.swift

@@ -151,6 +151,8 @@ class ViewController: UIViewController {
             
             if buffer.bufferingProgress >= 0.99 {
                 self.streamButton.isEnabled = false
+            } else {
+                self.streamButton.isEnabled = true
             }
             
             self.isPlayable = buffer.isReadyForPlaying
@@ -272,8 +274,12 @@ class ViewController: UIViewController {
             SAPlayer.shared.startRemoteAudio(withRemoteUrl: selectedAudio.url)
             streamButton.setTitle("Cancel streaming", for: .normal)
             downloadButton.isEnabled = false
+            isStreaming = true
         } else {
-            // TODO
+            SAPlayer.shared.stopStreamingRemoteAudio()
+            streamButton.setTitle("Stream", for: .normal)
+            downloadButton.isEnabled = true
+            isStreaming = false
         }
     }
     

README.md

@@ -34,6 +34,11 @@ pod 'SwiftAudioPlayer'
 
 ### Usage
 
+Import the player at the top:
+```swift
+import SwiftAudioPlayer
+```
+
 **Important:** For app in background downloading please refer to [note](#important-step-for-background-downloads).
 
 To play remote audio:

Source/Engine/AudioDiskEngine.swift

@@ -136,6 +136,7 @@ class AudioDiskEngine: AudioEngine {
     }
     
     override func invalidate() {
+        super.invalidate()
         //Nothing to invalidate for disk
     }
 }

Source/Engine/AudioStreamEngine.swift

@@ -291,6 +291,7 @@ class AudioStreamEngine: AudioEngine {
     }
     
     override func invalidate() {
+        super.invalidate()
         converter.invalidate()
     }
 }

Source/Engine/Parser/AudioParserPacketListener.swift

@@ -3,7 +3,7 @@
 //  SwiftAudioPlayer
 //
 //  Created by Tanha Kabir on 2019-01-29.
-//  Copyright © 2019 Tanha Kabir, Jon Mercer
+//  Copyright © 2019 Tanha Kabir, Jon Mercer, Moy Inzunza
 //
 //  This file was modified and adapted from https://github.com/syedhali/AudioStreamer
 //  which was released under Apache License 2.0. Apache License 2.0 requires explicit
@@ -32,7 +32,19 @@
 import Foundation
 import AVFoundation
 
-func ParserPacketListener(_ context: UnsafeMutableRawPointer, _ byteCount: UInt32, _ packetCount: UInt32, _ streamData: UnsafeRawPointer, _ packetDescriptions: UnsafeMutablePointer<AudioStreamPacketDescription>) {
+#if swift(>=5.3)
+func ParserPacketListener (_ context: UnsafeMutableRawPointer, _ byteCount: UInt32, _ packetCount: UInt32, _ streamData: UnsafeRawPointer, _ packetDescriptions: UnsafeMutablePointer<AudioStreamPacketDescription>?) {
+    parserPacket(context, byteCount, packetCount, streamData, packetDescriptions!)
+}
+
+#else
+func ParserPacketListener (_ context: UnsafeMutableRawPointer, _ byteCount: UInt32, _ packetCount: UInt32, _ streamData: UnsafeRawPointer, _ packetDescriptions: UnsafeMutablePointer<AudioStreamPacketDescription>) {
+    parserPacket(context, byteCount, packetCount, streamData, packetDescriptions)
+}
+#endif
+
+func parserPacket(_ context: UnsafeMutableRawPointer, _ byteCount: UInt32, _ packetCount: UInt32, _ streamData: UnsafeRawPointer, _ packetDescriptions: UnsafeMutablePointer<AudioStreamPacketDescription>){
+    
     let selfAudioParser = Unmanaged<AudioParser>.fromOpaque(context).takeUnretainedValue()
     
     //bug in core audio where this could be nil
@@ -68,4 +80,5 @@ func ParserPacketListener(_ context: UnsafeMutableRawPointer, _ byteCount: UInt3
             selfAudioParser.audioPackets.append((nil, audioPacketData))
         }
     }
+    
 }

Source/Model/Streaming/AudioStreamWorker.swift

@@ -243,7 +243,7 @@ extension AudioStreamWorker: URLSessionDataDelegate {
         }
         
         guard self.task == dataTask else {
-            Log.error("stream_error not the same task") //Probably because of seek
+            Log.error("stream_error not the same task 638283") //Probably because of seek
             return
         }
         
@@ -271,7 +271,7 @@ extension AudioStreamWorker: URLSessionDataDelegate {
         }
         
         guard self.task == dataTask else {
-            Log.error("stream_error not the same task")
+            Log.error("stream_error not the same task 517253")
             return
         }
         
@@ -293,8 +293,8 @@ extension AudioStreamWorker: URLSessionDataDelegate {
             return
         }
         
-        guard self.task == task else {
-            Log.error("stream_error not the same task")
+        if self.task != task && self.task != nil {
+            Log.error("stream_error not the same task 3901833")
             return
         }
         

Source/SAPlayer.swift

@@ -109,6 +109,10 @@ public class SAPlayer {
          }
          ````
          Please look at [forums.developer.apple.com/thread/5874](https://forums.developer.apple.com/thread/5874) and [forums.developer.apple.com/thread/6050](https://forums.developer.apple.com/thread/6050) for more details.
+     
+     For more details on pitch modifiers for playback rate changes please look at [developer.apple.com/forums/thread/6050](https://developer.apple.com/forums/thread/6050).
+     
+     To remove this default pitch modifier for playback rate changes, remove the node by calling `SAPlayer.shared.clearAudioModifiers()`.
      */
     public var audioModifiers: [AVAudioUnit] = []
     
@@ -181,6 +185,22 @@ public class SAPlayer {
         audioModifiers.append(AVAudioUnitTimePitch(audioComponentDescription: componentDescription))
     }
     
+    /**
+     Clears all [AVAudioUnit](https://developer.apple.com/documentation/avfoundation/audio_track_engineering/audio_engine_building_blocks/audio_enhancements) modifiers intended to be used for realtime audio manipulation.
+     */
+    public func clearAudioModifiers() {
+        audioModifiers.removeAll()
+    }
+    
+    /**
+     Append an [AVAudioUnit](https://developer.apple.com/documentation/avfoundation/audio_track_engineering/audio_engine_building_blocks/audio_enhancements) modifier to the list of modifiers used for realtime audio manipulation. The modifier will be added to the end of the list.
+
+     - Parameter modifier: The modifier to append.
+     */
+    public func addAudioModifier(_ modifer: AVAudioUnit) {
+        audioModifiers.append(modifer)
+    }
+    
     /**
      Formats a textual representation of a given timestamp for display in hh:MM:SS format, that is hours:minutes:seconds.
 
@@ -266,6 +286,23 @@ extension SAPlayer {
     /**
      If using an AVAudioUnitTimePitch, it's important to notify the player that the rate at which the audio playing has changed to keep the media player in the lockscreen up to date. This is only important for playback rate changes.
      
+     - Note: By default this engine has added a pitch modifier node to change the pitch so that on playback rate changes of spoken word the pitch isn't shifted.
+     
+     The component description of this node is:
+     ````
+     var componentDescription: AudioComponentDescription {
+        get {
+            var ret = AudioComponentDescription()
+            ret.componentType = kAudioUnitType_FormatConverter
+            ret.componentSubType = kAudioUnitSubType_AUiPodTimeOther
+            return ret
+        }
+     }
+     ````
+     Please look at [forums.developer.apple.com/thread/5874](https://forums.developer.apple.com/thread/5874) and [forums.developer.apple.com/thread/6050](https://forums.developer.apple.com/thread/6050) for more details.
+     
+     For more details on pitch modifiers for playback rate changes please look at [developer.apple.com/forums/thread/6050](https://developer.apple.com/forums/thread/6050).
+     
      - Parameter rate: The current rate at which the audio is playing.
      */
     public func playbackRateOfAudioChanged(rate: Float) {
@@ -277,6 +314,23 @@ extension SAPlayer {
      
      - Important: If intending to use [AVAudioUnit](https://developer.apple.com/documentation/avfoundation/audio_track_engineering/audio_engine_building_blocks/audio_enhancements) audio modifiers during playback, the list of audio modifiers under `SAPlayer.shared.audioModifiers` must be finalized before calling this function. After all realtime audio manipulations within the this will be effective.
      
+     - Note: The default list already has an AVAudioUnitTimePitch node first in the list. This node is specifically set to change the rate of audio without changing the pitch of the audio (intended for changing the rate of spoken word).
+     
+         The component description of this node is:
+         ````
+         var componentDescription: AudioComponentDescription {
+            get {
+                var ret = AudioComponentDescription()
+                ret.componentType = kAudioUnitType_FormatConverter
+                ret.componentSubType = kAudioUnitSubType_AUiPodTimeOther
+                return ret
+            }
+         }
+         ````
+         Please look at [forums.developer.apple.com/thread/5874](https://forums.developer.apple.com/thread/5874) and [forums.developer.apple.com/thread/6050](https://forums.developer.apple.com/thread/6050) for more details.
+     
+     To remove this default pitch modifier for playback rate changes, remove the node by calling `SAPlayer.shared.clearAudioModifiers()`.
+     
      - 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).
      */
@@ -296,6 +350,23 @@ extension SAPlayer {
      
      - Important: If intending to use [AVAudioUnit](https://developer.apple.com/documentation/avfoundation/audio_track_engineering/audio_engine_building_blocks/audio_enhancements) audio modifiers during playback, the list of audio modifiers under `SAPlayer.shared.audioModifiers` must be finalized before calling this function. After all realtime audio manipulations within the this will be effective.
      
+     - Note: The default list already has an AVAudioUnitTimePitch node first in the list. This node is specifically set to change the rate of audio without changing the pitch of the audio (intended for changing the rate of spoken word).
+     
+         The component description of this node is:
+         ````
+         var componentDescription: AudioComponentDescription {
+            get {
+                var ret = AudioComponentDescription()
+                ret.componentType = kAudioUnitType_FormatConverter
+                ret.componentSubType = kAudioUnitSubType_AUiPodTimeOther
+                return ret
+            }
+         }
+         ````
+         Please look at [forums.developer.apple.com/thread/5874](https://forums.developer.apple.com/thread/5874) and [forums.developer.apple.com/thread/6050](https://forums.developer.apple.com/thread/6050) for more details.
+     
+     To remove this default pitch modifier for playback rate changes, remove the node by calling `SAPlayer.shared.clearAudioModifiers()`.
+     
      - Note: Subscribe to `SAPlayer.Updates.StreamingBuffer` to see updates in streaming progress.
      
      - Parameter withRemoteUrl: The URL of the remote audio.
@@ -312,6 +383,10 @@ extension SAPlayer {
         presenter.handlePlayStreamedAudio(withRemoteUrl: url)
     }
     
+    public func stopStreamingRemoteAudio() {
+        presenter.handleStopStreamingAudio()
+    }
+    
     /**
      Resets the player to the state before initializing audio and setting media info.
      */
@@ -336,6 +411,12 @@ extension SAPlayer: SAPlayerDelegate {
         player = AudioStreamEngine(withRemoteUrl: url, delegate: presenter)
     }
     
+    func clearEngine() {
+        player?.pause()
+        player?.invalidate()
+        player = nil
+    }
+    
     func playEngine() {
         becomeDeviceAudioPlayer()
         player?.play()

Source/SAPlayerDelegate.swift

@@ -32,6 +32,7 @@ protocol SAPlayerDelegate: AnyObject, LockScreenViewProtocol {
     
     func startAudioDownloaded(withSavedUrl url: AudioURL)
     func startAudioStreamed(withRemoteUrl url: AudioURL)
+    func clearEngine()
     func playEngine()
     func pauseEngine()
     func seekEngine(toNeedle needle: Needle) //TODO ensure that engine cleans up out of bounds

Source/SAPlayerPresenter.swift

@@ -83,9 +83,7 @@ class SAPlayerPresenter {
     }
     
     private func attachForUpdates(url: URL) {
-        AudioClockDirector.shared.detachFromChangesInDuration(withID: durationRef)
-        AudioClockDirector.shared.detachFromChangesInNeedle(withID: needleRef)
-        AudioClockDirector.shared.detachFromChangesInPlayingStatus(withID: playingStatusRef)
+        detachFromUpdates()
         
         self.key = url.key
         urlKeyMap[url.key] = url
@@ -125,6 +123,17 @@ class SAPlayerPresenter {
         })
     }
     
+    private func detachFromUpdates() {
+        AudioClockDirector.shared.detachFromChangesInDuration(withID: durationRef)
+        AudioClockDirector.shared.detachFromChangesInNeedle(withID: needleRef)
+        AudioClockDirector.shared.detachFromChangesInPlayingStatus(withID: playingStatusRef)
+    }
+    
+    func handleStopStreamingAudio() {
+        delegate?.clearEngine()
+        detachFromUpdates()
+    }
+    
     @available(iOS 10.0, *)
     func handleLockscreenInfo(info: SALockScreenInfo?) {
         self.mediaInfo = info

SwiftAudioPlayer.podspec

@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = 'SwiftAudioPlayer'
-  s.version          = '2.8.2'
+  s.version          = '2.11.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.