Release 2.8.2

* project configure for me

* to see log

* set project

* new UI

* fix ui

* re-fix UI

* add example of equalizer

* Revert "re-fix UI"

This reverts commit 05ed993a52.

* Revert "fix ui"

This reverts commit 0da9f6adea.

* Revert "new UI"

This reverts commit ffd6a95a2d.

* Add verbose debug mode to player

Co-authored-by: cendolinside123 <jnsbstn391@gmail.com>

Example/SwiftAudioPlayer.xcodeproj/project.pbxproj

@@ -212,12 +212,12 @@
 				TargetAttributes = {
 					607FACCF1AFB9204008FA782 = {
 						CreatedOnToolsVersion = 6.3.1;
-						DevelopmentTeam = R2392A68YQ;
+						DevelopmentTeam = H9Y26B6GZB;
 						LastSwiftMigration = 1120;
 					};
 					607FACE41AFB9204008FA782 = {
 						CreatedOnToolsVersion = 6.3.1;
-						DevelopmentTeam = R2392A68YQ;
+						DevelopmentTeam = H9Y26B6GZB;
 						LastSwiftMigration = 1120;
 						TestTargetID = 607FACCF1AFB9204008FA782;
 					};
@@ -475,11 +475,11 @@
 			baseConfigurationReference = 65A66AB4C3016E8BB53FF3E0 /* Pods-SwiftAudioPlayer_Example.debug.xcconfig */;
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
-				DEVELOPMENT_TEAM = R2392A68YQ;
+				DEVELOPMENT_TEAM = H9Y26B6GZB;
 				INFOPLIST_FILE = SwiftAudioPlayer/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
 				MODULE_NAME = ExampleApp;
-				PRODUCT_BUNDLE_IDENTIFIER = "org.cocoapods.demo.$(PRODUCT_NAME:rfc1034identifier)";
+				PRODUCT_BUNDLE_IDENTIFIER = "org.cocoapods.demo-test.SwiftAudioPlayer-Example";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_VERSION = 5.0;
 			};
@@ -490,11 +490,11 @@
 			baseConfigurationReference = 4B5DD2AE0B23A759D18926DC /* Pods-SwiftAudioPlayer_Example.release.xcconfig */;
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
-				DEVELOPMENT_TEAM = R2392A68YQ;
+				DEVELOPMENT_TEAM = H9Y26B6GZB;
 				INFOPLIST_FILE = SwiftAudioPlayer/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
 				MODULE_NAME = ExampleApp;
-				PRODUCT_BUNDLE_IDENTIFIER = "org.cocoapods.demo.$(PRODUCT_NAME:rfc1034identifier)";
+				PRODUCT_BUNDLE_IDENTIFIER = "org.cocoapods.demo-test.SwiftAudioPlayer-Example";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_VERSION = 5.0;
 			};
@@ -504,7 +504,7 @@
 			isa = XCBuildConfiguration;
 			baseConfigurationReference = BBD877782CC67FBCC7BF7532 /* Pods-SwiftAudioPlayer_Tests.debug.xcconfig */;
 			buildSettings = {
-				DEVELOPMENT_TEAM = R2392A68YQ;
+				DEVELOPMENT_TEAM = H9Y26B6GZB;
 				FRAMEWORK_SEARCH_PATHS = (
 					"$(SDKROOT)/Developer/Library/Frameworks",
 					"$(inherited)",
@@ -526,7 +526,7 @@
 			isa = XCBuildConfiguration;
 			baseConfigurationReference = 0B7D1E6C00E83B4AF8AA1781 /* Pods-SwiftAudioPlayer_Tests.release.xcconfig */;
 			buildSettings = {
-				DEVELOPMENT_TEAM = R2392A68YQ;
+				DEVELOPMENT_TEAM = H9Y26B6GZB;
 				FRAMEWORK_SEARCH_PATHS = (
 					"$(SDKROOT)/Developer/Library/Frameworks",
 					"$(inherited)",

Example/SwiftAudioPlayer/ViewController.swift

@@ -59,7 +59,7 @@ class ViewController: UIViewController {
             self.currentUrlLocationLabel.text = "remote url: \(selectedAudio.url.absoluteString)"
         }
     }
-    
+    var freq:[Int] = [0,0,0,0,0,0,0,0,0,0]
     @IBOutlet weak var currentUrlLocationLabel: UILabel!
     @IBOutlet weak var bufferProgress: UIProgressView!
     @IBOutlet weak var scrubberSlider: UISlider!
@@ -103,6 +103,8 @@ class ViewController: UIViewController {
     override func viewDidLoad() {
         super.viewDidLoad()
         
+        SAPlayer.shared.DEBUG_MODE = true
+        
         isPlayable = false
         selectedAudio = AudioInfo(index: 0)
         
@@ -145,11 +147,9 @@ class ViewController: UIViewController {
             
             if self.duration == 0.0 { return }
             
-            let progress = Float((buffer.totalDurationBuffered + buffer.startingBufferTimePositon) / self.duration)
+            self.bufferProgress.progress = Float(buffer.bufferingProgress)
             
-            self.bufferProgress.progress = progress
-            
-            if progress >= 0.99 {
+            if buffer.bufferingProgress >= 0.99 {
                 self.streamButton.isEnabled = false
             }
             
@@ -185,6 +185,16 @@ class ViewController: UIViewController {
         let node = AVAudioUnitReverb()
         SAPlayer.shared.audioModifiers.append(node)
         node.wetDryMix = 300
+        let frequency:[Int] = [60,170,310,600,1000,3000,6000,12000,14000,16000]
+        let node2 = AVAudioUnitEQ(numberOfBands:frequency.count)
+        node2.globalGain = 1
+        for i in 0...(node2.bands.count-1) {
+            node2.bands[i].frequency  = Float(frequency[i])
+            node2.bands[i].gain       = 0
+            node2.bands[i].bypass     = false
+            node2.bands[i].filterType = .parametric
+        }
+        SAPlayer.shared.audioModifiers.append(node2)
     }
 
     override func didReceiveMemoryWarning() {
@@ -244,7 +254,7 @@ class ViewController: UIViewController {
                         self.currentUrlLocationLabel.text = "saved to: \(url.lastPathComponent)"
                         self.savedUrls[self.selectedAudio] = url
                         
-                        SAPlayer.shared.initializeSavedAudio(withSavedUrl: url)
+                        SAPlayer.shared.startSavedAudio(withSavedUrl: url)
                     }
                 })
                 streamButton.isEnabled = false
@@ -259,7 +269,7 @@ class ViewController: UIViewController {
     
     @IBAction func streamTouched(_ sender: Any) {
         if !isStreaming {
-            SAPlayer.shared.initializeRemoteAudio(withRemoteUrl: selectedAudio.url)
+            SAPlayer.shared.startRemoteAudio(withRemoteUrl: selectedAudio.url)
             streamButton.setTitle("Cancel streaming", for: .normal)
             downloadButton.isEnabled = false
         } else {
@@ -278,6 +288,19 @@ class ViewController: UIViewController {
     @IBAction func skipForwardTouched(_ sender: Any) {
         SAPlayer.shared.skipForward()
     }
+    @IBAction func setEqualizerValue(_ sender: Any) {
+        if let slider = sender as? UISlider{
+            print("slider of index:", slider.tag, "is changed to", slider.value)
+            freq[slider.tag] = Int(slider.value)
+            print("current frequency : ",freq)
+            if let node = SAPlayer.shared.audioModifiers[2] as? AVAudioUnitEQ{
+                for i in 0...(node.bands.count - 1){
+                    node.bands[i].gain = Float(freq[i])
+                }
+            }
+        }
+        
+    }
     
 }
 

README.md

@@ -39,7 +39,7 @@ pod 'SwiftAudioPlayer'
 To play remote audio:
 ```swift
 let url = URL(string: "https://randomwebsite.com/audio.mp3")!
-SAPlayer.shared.initializeAudio(withRemoteUrl: url)
+SAPlayer.shared.startRemoteAudio(withRemoteUrl: url)
 SAPlayer.shared.play()
 ```
 
@@ -121,8 +121,8 @@ Access the player and all of its fields and functions through `SAPlayer.shared`.
 ### Playing Audio (Basic Commands)
 
 To set up player with audio to play, use either: 
-* `initializeSavedAudio(withSavedUrl url: URL, mediaInfo: SALockScreenInfo?)` to play audio that is saved on the device.
-* `initializeRemoteAudio(withRemoteUrl url: URL, mediaInfo: SALockScreenInfo?)` to play audio streamed from a remote location.
+* `startSavedAudio(withSavedUrl url: URL, mediaInfo: SALockScreenInfo?)` to play audio that is saved on the device.
+* `startRemoteAudio(withRemoteUrl url: URL, mediaInfo: SALockScreenInfo?)` to play audio streamed from a remote location.
 
 Both of these expect a URL of the location of the audio and an optional media information to display on the lockscreen. 
 

Source/Engine/AudioDiskEngine.swift

@@ -64,7 +64,7 @@ class AudioDiskEngine: AudioEngine {
             audioSampleRate = Float(audioFormat?.sampleRate ?? 44100)
             audioLengthSeconds = Float(audioLengthSamples) / audioSampleRate
             duration = Duration(audioLengthSeconds)
-            bufferedSeconds = SAAudioAvailabilityRange(startingNeedle: 0, durationLoadedByNetwork: duration, isPlayable: true)
+            bufferedSeconds = SAAudioAvailabilityRange(startingNeedle: 0, durationLoadedByNetwork: duration, predictedDurationToLoad: duration, isPlayable: true)
         } else {
             Log.monitor("Could not load downloaded file with url: \(url)")
         }

Source/Engine/AudioEngine.swift

@@ -86,8 +86,8 @@ class AudioEngine: AudioEngineProtocol {
         }
     }
     
-    var bufferedSecondsDebouncer: SAAudioAvailabilityRange = SAAudioAvailabilityRange(startingNeedle: 0.0, durationLoadedByNetwork: 0.0, isPlayable: false)
-    var bufferedSeconds: SAAudioAvailabilityRange =  SAAudioAvailabilityRange(startingNeedle: 0.0, durationLoadedByNetwork: 0.0, isPlayable: false) {
+    var bufferedSecondsDebouncer: SAAudioAvailabilityRange = SAAudioAvailabilityRange(startingNeedle: 0.0, durationLoadedByNetwork: 0.0, predictedDurationToLoad: Double.greatestFiniteMagnitude, isPlayable: false)
+    var bufferedSeconds: SAAudioAvailabilityRange =  SAAudioAvailabilityRange(startingNeedle: 0.0, durationLoadedByNetwork: 0.0, predictedDurationToLoad: Double.greatestFiniteMagnitude, isPlayable: false) {
         didSet {
             if bufferedSeconds.startingNeedle == 0.0 && bufferedSeconds.durationLoadedByNetwork == 0.0 {
                 bufferedSecondsDebouncer = bufferedSeconds
@@ -154,7 +154,11 @@ class AudioEngine: AudioEngineProtocol {
     
     func updateIsPlaying() {
         if !bufferedSeconds.isPlayable {
-            playingStatus = .buffering
+            if bufferedSeconds.bufferingProgress > 0.999 {
+                playingStatus = .ended
+            } else {
+                playingStatus = .buffering
+            }
             return
         }
         

Source/Engine/AudioStreamEngine.swift

@@ -218,7 +218,7 @@ class AudioStreamEngine: AudioEngine {
         let range = converter.pollNetworkAudioAvailabilityRange()
         isPlayable = (numberOfBuffersScheduledInTotal >= MIN_BUFFERS_TO_BE_PLAYABLE && range.1 > 0) && predictedStreamDuration > 0
         Log.debug("loaded \(range), numberOfBuffersScheduledInTotal: \(numberOfBuffersScheduledInTotal), isPlayable: \(isPlayable)")
-        bufferedSeconds = SAAudioAvailabilityRange(startingNeedle: range.0, durationLoadedByNetwork: range.1, isPlayable: isPlayable)
+        bufferedSeconds = SAAudioAvailabilityRange(startingNeedle: range.0, durationLoadedByNetwork: range.1, predictedDurationToLoad: predictedStreamDuration, isPlayable: isPlayable)
     }
     
     private func updateNeedle() {
@@ -236,12 +236,6 @@ class AudioStreamEngine: AudioEngine {
         var currentTime = TimeInterval(playerTime.sampleTime) / playerTime.sampleRate
         currentTime = currentTime > 0 ? currentTime : 0
         
-        if currentTime > predictedStreamDuration {
-            Log.info("reached end of audio")
-            seek(toNeedle: 0)
-            pause()
-            playingStatus = .ended
-        }
         needle = (currentTime + currentTimeOffset)
     }
     

Source/Engine/Converter/AudioConverterErrors.swift

@@ -57,28 +57,39 @@ public enum ConverterError: LocalizedError {
     public var errorDescription: String? {
         switch self {
         case .cannotLockQueue:
+            Log.warn("Failed to lock queue")
             return "Failed to lock queue"
         case .converterFailed(let status):
+            Log.warn(localizedDescriptionFromConverterError(status))
             return localizedDescriptionFromConverterError(status)
         case .failedToCreateDestinationFormat:
+            Log.warn("Failed to create a destination (processing) format")
             return "Failed to create a destination (processing) format"
         case .failedToCreatePCMBuffer:
+            Log.warn("Failed to create PCM buffer for reading data")
             return "Failed to create PCM buffer for reading data"
         case .notEnoughData:
+            Log.warn("Not enough data for read-conversion operation")
             return "Not enough data for read-conversion operation"
         case .parserMissingDataFormat:
+            Log.warn("Parser is missing a valid data format")
             return "Parser is missing a valid data format"
         case .reachedEndOfFile:
+            Log.warn("Reached the end of the file")
             return "Reached the end of the file"
         case .unableToCreateConverter(let status):
             return localizedDescriptionFromConverterError(status)
         case .superConcerningShouldNeverHappen:
+            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")
             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")
             return "Preventing the reader from creating more PCM buffers since the player has more than 60 seconds of audio already to play"
         case .failedToCreateParser:
+            Log.warn("Could not create a parser")
             return "Could not create a parser"
         }
     }

Source/Engine/SAAudioAvailabilityRange.swift

@@ -29,8 +29,15 @@ import Foundation
 public struct SAAudioAvailabilityRange {
     let startingNeedle: Needle
     let durationLoadedByNetwork: Duration
+    let predictedDurationToLoad: Duration
     let isPlayable: Bool
     
+    public var bufferingProgress: Double {
+        get {
+            return (startingNeedle + durationLoadedByNetwork) / predictedDurationToLoad
+        }
+    }
+    
     public var startingBufferTimePositon: Double {
         get {
             return startingNeedle
@@ -52,4 +59,8 @@ public struct SAAudioAvailabilityRange {
     public func contains(_ needle: Double) -> Bool {
         return needle >= startingNeedle && (needle - startingNeedle) < durationLoadedByNetwork
     }
+    
+    public func isCompletelyBuffered() -> Bool {
+        return startingNeedle + durationLoadedByNetwork >= predictedDurationToLoad
+    }
 }

Source/SAPlayer.swift

@@ -27,6 +27,16 @@ import Foundation
 import AVFoundation
 
 public class SAPlayer {
+    public var DEBUG_MODE: Bool = false {
+        didSet {
+            if(DEBUG_MODE) {
+                logLevel = LogLevel.EXTERNAL_DEBUG
+            } else {
+                logLevel = LogLevel.MONITOR
+            }
+        }
+    }
+    
     /**
      Access to the player.
      */
@@ -198,21 +208,27 @@ public class SAPlayer {
 //MARK: - External Player Controls
 extension SAPlayer {
     /**
-     Toggles between the play and pause state of the player if the player is not buffering (thus is playable).
+     Toggles between the play and pause state of the player. If nothing is playable (aka still in buffering state or no audio is initialized) no action will be taken. Please call `startSavedAudio` or `startRemoteAudio` to set up the player with audio before this.
+     
+     - Note: If you are streaming, wait till the status from `SAPlayer.Updates.PlayingStatus` is not `.buffering`.
      */
     public func togglePlayAndPause() {
         presenter.handleTogglePlayingAndPausing()
     }
     
     /**
-     Attempts to play the player even if nothing playable is loaded (aka still in buffering state or no audio is initialized).
+     Attempts to play the player. If nothing is playable (aka still in buffering state or no audio is initialized) no action will be taken. Please call `startSavedAudio` or `startRemoteAudio` to set up the player with audio before this.
+     
+     - Note: If you are streaming, wait till the status from `SAPlayer.Updates.PlayingStatus` is not `.buffering`.
      */
     public func play() {
         presenter.handlePlay()
     }
     
     /**
-     Attempts to pause the player even if nothing playable is loaded (aka still in buffering state or no audio is initialized).
+     Attempts to pause the player. If nothing is playable (aka still in buffering state or no audio is initialized) no action will be taken. Please call `startSavedAudio` or `startRemoteAudio` to set up the player with audio before this.
+     
+     - Note:If you are streaming, wait till the status from `SAPlayer.Updates.PlayingStatus` is not `.buffering`.
      */
     public func pause() {
         presenter.handlePause()
@@ -264,13 +280,19 @@ extension SAPlayer {
      - 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 startSavedAudio(withSavedUrl url: URL, mediaInfo: SALockScreenInfo? = nil) {
+        self.mediaInfo = mediaInfo
+        presenter.handlePlaySavedAudio(withSavedUrl: url)
+    }
+    
+    @available(*, deprecated, renamed: "startSavedAudio")
     public func initializeSavedAudio(withSavedUrl url: URL, mediaInfo: SALockScreenInfo? = nil) {
         self.mediaInfo = mediaInfo
         presenter.handlePlaySavedAudio(withSavedUrl: url)
     }
     
     /**
-     Sets up player to play audio that will be streamed from a remote location.
+     Sets up player to play audio that will be streamed from a remote location. After this is called, it will connect to the server and start to receive and process data. The player is not playable the SAAudioAvailabilityRange notifies that player is ready for playing (you can subscribe to these updates through `SAPlayer.Updates.StreamingBuffer`). You can alternatively see when the player is available to play by subscribing to `SAPlayer.Updates.PlayingStatus` and waiting for a status that isn't `.buffering`.
      
      - 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.
      
@@ -279,6 +301,12 @@ extension SAPlayer {
      - Parameter withRemoteUrl: The URL of the remote audio.
      - Parameter mediaInfo: The media information of the audio to show on the lockscreen media player (optional).
      */
+    public func startRemoteAudio(withRemoteUrl url: URL, mediaInfo: SALockScreenInfo? = nil) {
+        self.mediaInfo = mediaInfo
+        presenter.handlePlayStreamedAudio(withRemoteUrl: url)
+    }
+    
+    @available(*, deprecated, renamed: "startRemoteAudio")
     public func initializeRemoteAudio(withRemoteUrl url: URL, mediaInfo: SALockScreenInfo? = nil) {
         self.mediaInfo = mediaInfo
         presenter.handlePlayStreamedAudio(withRemoteUrl: url)

Source/Util/Log.swift

@@ -9,22 +9,23 @@
 import Foundation
 import os.log
 
+// Possible levels of log messages to log
+enum LogLevel: Int {
+    case DEBUG = 1
+    case INFO = 2
+    case WARN = 3
+    case ERROR = 4
+    case EXTERNAL_DEBUG = 5
+    case MONITOR = 6
+    case TEST = 7
+}
+
+// Specify which types of log messages to display. Default level is set to WARN, which means Log will print any log messages of type only WARN, ERROR, MONITOR, and TEST. To print DEBUG and INFO logs, set the level to a lower value.
+var logLevel: LogLevel = LogLevel.MONITOR
+
 class Log {
     private init() {}
     
-    // Possible levels of log messages to log
-    public enum LogLevel: Int {
-        case DEBUG = 1
-        case INFO = 2
-        case WARN = 3
-        case ERROR = 4
-        case MONITOR = 5
-        case TEST = 6
-    }
-    
-    // Specify which types of log messages to display. Default level is set to WARN, which means Log will print any log messages of type only WARN, ERROR, MONITOR, and TEST. To print DEBUG and INFO logs, set the level to a lower value.
-    public static var logLevel: LogLevel = LogLevel.MONITOR
-    
     // Used for OSLog
     private static let SUBSYSTEM: String = "com.SwiftAudioPlayer"
     
@@ -68,6 +69,11 @@ class Log {
             let log = OSLog(subsystem: SUBSYSTEM, category: "ERROR 🛑🛑🛑🛑")
             os_log("%@:%@:%d:: %@", log: log, fileName, functionName, lineNumber, "\(logMessage)")
         }
+        
+        if logLevel.rawValue <= LogLevel.EXTERNAL_DEBUG.rawValue {
+            let log = OSLog(subsystem: SUBSYSTEM, category: "WARNING")
+            os_log("%@:%@:%d:: %@", log: log, fileName, functionName, lineNumber, "\(logMessage)")
+        }
     }
     
     /**
@@ -86,7 +92,7 @@ class Log {
     public static func monitor(_ logMessage: Any, classPath: String = #file, functionName: String = #function, lineNumber: Int = #line) {
         let fileName = URLUtil.getNameFromStringPath(classPath)
         if logLevel.rawValue <= LogLevel.ERROR.rawValue {
-            let log = OSLog(subsystem: SUBSYSTEM, category: "MONITOR 🔥🔥🔥🔥")
+            let log = OSLog(subsystem: SUBSYSTEM, category: "ERROR 🔥🔥🔥🔥")
             os_log("%@:%@:%d:: %@", log: log, fileName, functionName, lineNumber, "\(logMessage)")
         }
     }
@@ -110,6 +116,11 @@ class Log {
             let log = OSLog(subsystem: SUBSYSTEM, category: "WARN  ⚠️⚠️⚠️⚠️")
             os_log("%@:%@:%d:: %@", log: log, fileName, functionName, lineNumber, "\(logMessage)")
         }
+        
+        if logLevel.rawValue <= LogLevel.EXTERNAL_DEBUG.rawValue {
+            let log = OSLog(subsystem: SUBSYSTEM, category: "DEBUG")
+            os_log("%@:%@:%d:: %@", log: log, fileName, functionName, lineNumber, "\(logMessage)")
+        }
     }
     
     /**

SwiftAudioPlayer.podspec

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