Release 2.13.0

Co-Authored-By: fayinsky <38639193+fayinsky@users.noreply.github.com>

Example/Pods/Pods.xcodeproj/project.xcworkspace/contents.xcworkspacedata

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Workspace
+   version = "1.0">
+   <FileRef
+      location = "self:">
+   </FileRef>
+</Workspace>

Example/Pods/Pods.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEDidComputeMac32BitWarning</key>
+	<true/>
+</dict>
+</plist>

Example/SwiftAudioPlayer/ViewController.swift

@@ -103,6 +103,8 @@ class ViewController: UIViewController {
     override func viewDidLoad() {
         super.viewDidLoad()
         
+        SAPlayer.Downloader.allowUsingCellularData = true
+        
         SAPlayer.shared.DEBUG_MODE = true
         
         isPlayable = false

README.md

@@ -123,6 +123,10 @@ SwiftAudioPlayer is available under the MIT license. See the LICENSE file for mo
 
 Access the player and all of its fields and functions through `SAPlayer.shared`.
 
+### Supported file types
+
+Known supported file types are `.mp3` and `.wav`.
+
 ### Playing Audio (Basic Commands)
 
 To set up player with audio to play, use either: 
@@ -199,6 +203,12 @@ And use the following to stop any active or prevent future downloads of the corr
 func cancelDownload(withRemoteUrl url: URL)
 ```
 
+By default downloading will be allowed on cellular data. If you would like to turn this off set:
+```swift
+SAPlayer.Downloader.allowUsingCellularData = false
+```
+You can also retrieve what preference you have set for cellular downloads through `allowUsingCellularData`.
+
 ### Manage Downloaded
 
 Use the following to manage downloaded audio files.

Source/Engine/AudioStreamEngine.swift

@@ -290,6 +290,16 @@ class AudioStreamEngine: AudioEngine {
         updateNetworkBufferRange()
     }
     
+    override func pause() {
+        queue.async { [weak self] in
+            self?.pauseHelperDispatchQueue()
+        }
+    }
+    
+    private func pauseHelperDispatchQueue() {
+        super.pause()
+    }
+    
     override func invalidate() {
         super.invalidate()
         converter.invalidate()

Source/Engine/Converter/AudioConverterErrors.swift

@@ -83,7 +83,7 @@ public enum ConverterError: LocalizedError {
             Log.warn("Weird unexpected reader error. Should not have happened")
             return "Weird unexpected reader error. Should not have happened"
         case .cannotCreatePCMBufferWithoutConverter:
-            Log.warn("Could not create a PCM Buffer because reader does not have a converter yet")
+            Log.debug("Could not create a PCM Buffer because reader does not have a converter yet")
             return "Could not create a PCM Buffer because reader does not have a converter yet"
         case .throttleParsingBuffersForEngine:
             Log.warn("Preventing the reader from creating more PCM buffers since the player has more than 60 seconds of audio already to play")

Source/Engine/Parser/AudioParser.swift

@@ -113,10 +113,13 @@ class AudioParser: AudioParsable {
         didSet {
             if let audioPacketByteSize = audioPackets.last?.0?.mDataByteSize {
                 sumOfParsedAudioBytes += audioPacketByteSize
-                numberOfPacketsParsed += 1
+            } else if let audioPacketByteSize = audioPackets.last?.1.count { // for uncompressed audio there are no descriptors to say how many bytes of audio are in this packet so we approximate by data size
+                sumOfParsedAudioBytes += UInt32(audioPacketByteSize)
             }
             
-            //TODO: duration will not work with WAV or AIFF
+            numberOfPacketsParsed += 1
+            
+            //TODO: duration will not be accurate with WAV or AIFF
         }
     }
     
@@ -204,7 +207,7 @@ class AudioParser: AudioParsable {
     private func getOffset(fromPacketIndex index: AVAudioPacketCount) -> UInt64? {
         //Clear current buffer if we have audio format
         guard fileAudioFormat != nil, let bytesPerPacket = self.averageBytesPerPacket else {
-            Log.error("should not get here")
+            Log.error("should not get here \(String(describing: fileAudioFormat)) and \(String(describing: self.averageBytesPerPacket))")
             return nil
         }
         

Source/Engine/Parser/AudioParserPacketListener.swift

@@ -34,7 +34,7 @@ import AVFoundation
 
 #if swift(>=5.3)
 func ParserPacketListener (_ context: UnsafeMutableRawPointer, _ byteCount: UInt32, _ packetCount: UInt32, _ streamData: UnsafeRawPointer, _ packetDescriptions: UnsafeMutablePointer<AudioStreamPacketDescription>?) {
-    parserPacket(context, byteCount, packetCount, streamData, packetDescriptions!)
+    parserPacket(context, byteCount, packetCount, streamData, packetDescriptions)
 }
 
 #else
@@ -43,16 +43,12 @@ func ParserPacketListener (_ context: UnsafeMutableRawPointer, _ byteCount: UInt
 }
 #endif
 
-func parserPacket(_ context: UnsafeMutableRawPointer, _ byteCount: UInt32, _ packetCount: UInt32, _ streamData: UnsafeRawPointer, _ packetDescriptions: UnsafeMutablePointer<AudioStreamPacketDescription>){
+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
-    let packetDescriptionOrNil: UnsafeMutablePointer<AudioStreamPacketDescription>? = packetDescriptions
-    let isCompressed = packetDescriptionOrNil != nil
-    
     guard let fileAudioFormat = selfAudioParser.fileAudioFormat else {
-        Log.monitor("shouldnot have reached packet listener without a data format")
+        Log.monitor("should not have reached packet listener without a data format")
         return
     }
     
@@ -62,15 +58,17 @@ func parserPacket(_ context: UnsafeMutableRawPointer, _ byteCount: UInt32, _ pac
     }
     
     //TODO refactor this after we get it working
-    if isCompressed {
+    if let compressedPacketDescriptions = packetDescriptions {  // is compressed audio (.mp3)
+        Log.debug("compressed audio")
         for i in 0 ..< Int(packetCount) {
-            let audioPacketDescription = packetDescriptions[i]
+            let audioPacketDescription = compressedPacketDescriptions[i]
             let audioPacketStart = Int(audioPacketDescription.mStartOffset)
             let audioPacketSize = Int(audioPacketDescription.mDataByteSize)
             let audioPacketData = Data(bytes: streamData.advanced(by: audioPacketStart), count: audioPacketSize)
             selfAudioParser.audioPackets.append((audioPacketDescription,audioPacketData))
         }
-    } else {
+    } else { // not compressed audio (.wav)
+        Log.debug("uncompressed audio")
         let format = fileAudioFormat.streamDescription.pointee
         let bytesPerAudioPacket = Int(format.mBytesPerPacket)
         for i in 0 ..< Int(packetCount) {

Source/Model/AudioDataManager.swift

@@ -32,6 +32,7 @@ protocol AudioDataManagable {
     var allowCellular: Bool { get set }
     
     func setBackgroundCompletionHandler(_ completionHandler: @escaping () -> ())
+    func setAllowCellularDownloadPreference(_ preference: Bool)
     
     func clear()
     
@@ -51,7 +52,7 @@ protocol AudioDataManagable {
 }
 
 class AudioDataManager: AudioDataManagable {
-    var allowCellular: Bool = false
+    var allowCellular: Bool = true
     
     static let shared: AudioDataManagable = AudioDataManager()
     
@@ -99,6 +100,10 @@ class AudioDataManager: AudioDataManagable {
         backgroundCompletion = completionHandler
     }
     
+    func setAllowCellularDownloadPreference(_ preference: Bool) {
+        allowCellular = preference
+    }
+    
     func attach(callback: @escaping (_ id: ID, _ progress: Double)->()) {
         globalDownloadProgressCallback = callback
     }

Source/Model/Downloading/FileStorage.swift

@@ -103,12 +103,15 @@ extension FileStorage {
         }
         
         static func locate(_ id: ID) -> URL? {
-            let urls = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)
-            
-            for url in urls {
-                if url.absoluteString.contains(id) && url.pathExtension != "" {
-                    _ = getUrl(givenId: id, andFileExtension: url.pathExtension)
-                    return url
+            let folderUrls = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)
+            guard folderUrls.count != 0 else { return nil }
+
+            if let urls = try? FileManager.default.contentsOfDirectory(at: folderUrls[0], includingPropertiesForKeys: nil) {
+                for url in urls {
+                    if url.absoluteString.contains(id) && url.pathExtension != "" {
+                        _ = getUrl(givenId: id, andFileExtension: url.pathExtension)
+                        return url
+                    }
                 }
             }
             return nil

Source/SAPlayer.swift

@@ -56,6 +56,17 @@ public class SAPlayer {
         }
     }
     
+    /**
+    Access the player node of the engine. Node is nil if player has not been initialized with audio.
+     
+     - Important: Changes to the engine and this node are not safe guarded, thus unknown behaviour can arise from changing the engine or this node. Just be wary and read [documentation of AVAudioEngine](https://developer.apple.com/documentation/avfoundation/avaudioengine) well when modifying,
+    */
+    public var playerNode: AVAudioPlayerNode? {
+        get {
+            return player?.playerNode
+        }
+    }
+    
     /**
     Corresponding to the overall volume of the player. Volume's default value is 1.0 and the range of valid values is 0.0 to 1.0. Volume is nil if no audio has been initialized yet.
     */

Source/SAPlayerDownloader.swift

@@ -100,5 +100,14 @@ extension SAPlayer {
         public static func setBackgroundCompletionHandler(_ completionHandler: @escaping () -> ()) {
             AudioDataManager.shared.setBackgroundCompletionHandler(completionHandler)
         }
+        
+        /**
+         Whether downloading audio on cellular data is allowed. By default this is set to `true`.
+         */
+        public static var allowUsingCellularData = true {
+            didSet {
+                AudioDataManager.shared.setAllowCellularDownloadPreference(allowUsingCellularData)
+            }
+        }
     }
 }

SwiftAudioPlayer.podspec

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