Merge pull request #70 from jorgenhenrichsen/more-detaile-player-states

More detailed player states
Add tests for the loading state.
2019-07-03 18:29:43 +02:00 · 2019-07-03 17:48:28 +02:00 · 2019-07-03 16:41:14 +02:00 · 2019-07-03 15:06:50 +02:00 · 2019-07-03 14:53:24 +02:00 · 2019-07-03 14:25:43 +02:00
10 changed files with 95 additions and 47 deletions
@@ -1 +0,0 @@
-4.2
@@ -1,12 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="13771" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" colorMatched="YES" initialViewController="vXZ-lx-hvc">
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14490.70" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" colorMatched="YES" initialViewController="vXZ-lx-hvc">
    <device id="retina4_7" orientation="portrait">
        <adaptation id="fullscreen"/>
    </device>
    <dependencies>
        <deployment identifier="iOS"/>
-        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="13772"/>
-        <capability name="Constraints to layout margins" minToolsVersion="6.0"/>
+        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="14490.49"/>
        <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
    </dependencies>
    <scenes>
@@ -63,7 +62,7 @@
                                </connections>
                            </button>
                            <imageView userInteractionEnabled="NO" contentMode="scaleToFill" horizontalHuggingPriority="251" verticalHuggingPriority="251" translatesAutoresizingMaskIntoConstraints="NO" id="FCd-3e-22D">
-                                <rect key="frame" x="67" y="84" width="240" height="240"/>
+                                <rect key="frame" x="67.5" y="84" width="240" height="240"/>
                                <constraints>
                                    <constraint firstAttribute="width" constant="240" id="5Sj-BZ-sg4"/>
                                    <constraint firstAttribute="height" constant="240" id="Hij-Yw-6Lg"/>
@@ -105,24 +104,37 @@
                                <color key="textColor" red="0.99999600649999998" green="1" blue="1" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
                                <nil key="highlightedColor"/>
                            </label>
+                            <activityIndicatorView hidden="YES" opaque="NO" contentMode="scaleToFill" horizontalHuggingPriority="750" verticalHuggingPriority="750" hidesWhenStopped="YES" style="white" translatesAutoresizingMaskIntoConstraints="NO" id="1ML-yD-9Rf">
+                                <rect key="frame" x="177.5" y="587" width="20" height="20"/>
+                            </activityIndicatorView>
+                            <label hidden="YES" opaque="NO" userInteractionEnabled="NO" contentMode="left" horizontalHuggingPriority="251" verticalHuggingPriority="251" text="ErrorText" textAlignment="natural" lineBreakMode="tailTruncation" baselineAdjustment="alignBaselines" adjustsFontSizeToFit="NO" translatesAutoresizingMaskIntoConstraints="NO" id="iCe-6A-2My">
+                                <rect key="frame" x="158.5" y="588.5" width="58.5" height="17"/>
+                                <fontDescription key="fontDescription" type="system" pointSize="14"/>
+                                <color key="textColor" red="1" green="0.14913141730000001" blue="0.0" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
+                                <nil key="highlightedColor"/>
+                            </label>
                        </subviews>
                        <color key="backgroundColor" red="0.12984204290000001" green="0.12984612579999999" blue="0.12984395030000001" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
                        <color key="tintColor" red="1" green="0.83234566450000003" blue="0.47320586440000001" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
                        <constraints>
                            <constraint firstItem="T7Y-1Q-7UU" firstAttribute="leading" secondItem="kh9-bI-dsS" secondAttribute="leadingMargin" id="0eh-sL-186"/>
+                            <constraint firstItem="iCe-6A-2My" firstAttribute="centerY" secondItem="1ML-yD-9Rf" secondAttribute="centerY" id="4Fp-kE-AAg"/>
                            <constraint firstItem="l9B-hM-Ajc" firstAttribute="trailing" secondItem="kh9-bI-dsS" secondAttribute="trailingMargin" id="54L-0h-0ba"/>
                            <constraint firstItem="l9B-hM-Ajc" firstAttribute="top" secondItem="jyV-Pf-zRb" secondAttribute="bottom" id="9Uh-K9-988"/>
                            <constraint firstItem="RVb-HZ-QCX" firstAttribute="trailing" secondItem="kh9-bI-dsS" secondAttribute="trailingMargin" id="BhV-UD-qhh"/>
+                            <constraint firstItem="iCe-6A-2My" firstAttribute="centerX" secondItem="kh9-bI-dsS" secondAttribute="centerX" id="Dhm-Bn-wZH"/>
                            <constraint firstItem="FCd-3e-22D" firstAttribute="centerX" secondItem="kh9-bI-dsS" secondAttribute="centerX" id="GhI-f1-DkR"/>
                            <constraint firstItem="T7Y-1Q-7UU" firstAttribute="trailing" secondItem="kh9-bI-dsS" secondAttribute="trailingMargin" id="HoH-i0-yof"/>
                            <constraint firstItem="RWN-If-dGG" firstAttribute="leading" secondItem="kh9-bI-dsS" secondAttribute="leadingMargin" id="Nw7-WM-LFd"/>
                            <constraint firstItem="RX3-VR-CL6" firstAttribute="centerX" secondItem="kh9-bI-dsS" secondAttribute="centerX" id="O0h-NL-iXW"/>
+                            <constraint firstItem="1ML-yD-9Rf" firstAttribute="top" secondItem="EOo-zV-6l2" secondAttribute="bottom" constant="20" id="Uop-aD-I5b"/>
                            <constraint firstItem="dfk-yr-rwm" firstAttribute="top" secondItem="FCd-3e-22D" secondAttribute="bottom" constant="30" id="W4w-6K-AW8"/>
                            <constraint firstItem="RWN-If-dGG" firstAttribute="top" secondItem="T7Y-1Q-7UU" secondAttribute="bottom" constant="25" id="XgV-XL-QCL"/>
                            <constraint firstItem="dfk-yr-rwm" firstAttribute="leading" secondItem="kh9-bI-dsS" secondAttribute="leadingMargin" id="YUE-uf-Rp1"/>
                            <constraint firstItem="RVb-HZ-QCX" firstAttribute="top" secondItem="RWN-If-dGG" secondAttribute="bottom" constant="8" id="ZkD-u2-Zbr"/>
                            <constraint firstItem="T7Y-1Q-7UU" firstAttribute="top" secondItem="dfk-yr-rwm" secondAttribute="bottom" constant="4" id="baR-zV-tgo"/>
                            <constraint firstItem="RWN-If-dGG" firstAttribute="trailing" secondItem="kh9-bI-dsS" secondAttribute="trailingMargin" id="eNt-u9-qot"/>
+                            <constraint firstItem="1ML-yD-9Rf" firstAttribute="centerX" secondItem="kh9-bI-dsS" secondAttribute="centerX" id="fdl-RK-Hq8"/>
                            <constraint firstItem="RX3-VR-CL6" firstAttribute="leading" secondItem="kh9-bI-dsS" secondAttribute="leadingMargin" constant="16" id="hEd-b2-Ggo"/>
                            <constraint firstItem="FCd-3e-22D" firstAttribute="top" secondItem="l9B-hM-Ajc" secondAttribute="bottom" constant="30" id="ikz-ZP-jNM"/>
                            <constraint firstAttribute="trailingMargin" secondItem="RX3-VR-CL6" secondAttribute="trailing" constant="16" id="kSP-Mq-R5P"/>
@@ -135,7 +147,9 @@
                    <connections>
                        <outlet property="artistLabel" destination="T7Y-1Q-7UU" id="b5S-lt-PqG"/>
                        <outlet property="elapsedTimeLabel" destination="3CL-8o-zYW" id="7Wg-7X-Vrd"/>
+                        <outlet property="errorLabel" destination="iCe-6A-2My" id="T4b-0b-wdM"/>
                        <outlet property="imageView" destination="FCd-3e-22D" id="gKL-za-haV"/>
+                        <outlet property="loadIndicator" destination="1ML-yD-9Rf" id="Xes-Ag-vhg"/>
                        <outlet property="playButton" destination="EOo-zV-6l2" id="2d1-ad-s1k"/>
                        <outlet property="remainingTimeLabel" destination="RVb-HZ-QCX" id="8hp-CK-XjF"/>
                        <outlet property="slider" destination="RWN-If-dGG" id="Yxw-Gf-bR3"/>
@@ -21,9 +21,12 @@ class ViewController: UIViewController {
    @IBOutlet weak var elapsedTimeLabel: UILabel!
    @IBOutlet weak var titleLabel: UILabel!
    @IBOutlet weak var artistLabel: UILabel!
+    @IBOutlet weak var loadIndicator: UIActivityIndicatorView!
+    @IBOutlet weak var errorLabel: UILabel!
    
-    var isScrubbing: Bool = false
-    let controller = AudioController.shared
+    private var isScrubbing: Bool = false
+    private let controller = AudioController.shared
+    private var lastLoadFailed: Bool = false
    
    override func viewDidLoad() {
        super.viewDidLoad()
@@ -32,13 +35,23 @@ class ViewController: UIViewController {
        controller.player.event.seek.addListener(self, handleAudioPlayerDidSeek)
        controller.player.event.updateDuration.addListener(self, handleAudioPlayerUpdateDuration)
        controller.player.event.didRecreateAVPlayer.addListener(self, handleAVPlayerRecreated)
+        controller.player.event.fail.addListener(self, handlePlayerFailure)
+        updateMetaData()
+        handleAudioPlayerStateChange(data: controller.player.playerState)
    }
    
    @IBAction func togglePlay(_ sender: Any) {
-        if (!controller.audioSessionController.audioSessionIsActive) {
+        if !controller.audioSessionController.audioSessionIsActive {
            try? controller.audioSessionController.activateSession()
        }
-        controller.player.togglePlaying()
+        if lastLoadFailed, let item = controller.player.currentItem {
+            lastLoadFailed = false
+            errorLabel.isHidden = true
+            try? controller.player.load(item: item, playWhenReady: true)
+        }
+        else {
+            controller.player.togglePlaying()
+        }
    }
    
    @IBAction func previous(_ sender: Any) {
@@ -84,16 +97,31 @@ class ViewController: UIViewController {
        playButton.setTitle(state == .playing ? "Pause" : "Play", for: .normal)
    }
    
+    func setErrorMessage(_ message: String) {
+        self.loadIndicator.stopAnimating()
+        errorLabel.isHidden = false
+        errorLabel.text = message
+    }
+    
    // MARK: - AudioPlayer Event Handlers
    
    func handleAudioPlayerStateChange(data: AudioPlayer.StateChangeEventData) {
+        print(data)
        DispatchQueue.main.async {
            self.setPlayButtonState(forAudioPlayerState: data)
            switch data {
-            case .ready:
+            case .loading:
+                self.loadIndicator.startAnimating()
                self.updateMetaData()
                self.updateTimeValues()
-            case .loading, .playing, .paused, .idle:
+            case .buffering:
+                self.loadIndicator.startAnimating()
+            case .ready:
+                self.loadIndicator.stopAnimating()
+                self.updateMetaData()
+                self.updateTimeValues()
+            case .playing, .paused, .idle:
+                self.loadIndicator.stopAnimating()
                self.updateTimeValues()
            }
        }
@@ -121,4 +149,15 @@ class ViewController: UIViewController {
        try? controller.audioSessionController.set(category: .playback)
    }
    
+    func handlePlayerFailure(data: AudioPlayer.FailEventData) {
+        if let error = data as NSError? {
+            if error.code == -1009 {
+                lastLoadFailed = true
+                DispatchQueue.main.async {
+                    self.setErrorMessage("Network disconnected. Please try again...")
+                }
+            }
+        }
+    }
+    
 }
@@ -30,7 +30,12 @@ class AVPlayerWrapperTests: XCTestCase {
        XCTAssert(wrapper.state == AVPlayerWrapperState.idle)
    }
    
-    func test_AVPlayerWrapper__state__when_loading_a_source__should_be_ready() {
+    func test_AVPlayerWrapper__state__when_loading_a_source__should_be_loading() {
+        wrapper.load(from: Source.url, playWhenReady: false)
+        XCTAssertEqual(wrapper.state, AVPlayerWrapperState.loading)
+    }
+    
+    func test_AVPlayerWrapper__state__when_loading_a_source__should_eventually_be_ready() {
        let expectation = XCTestExpectation()
        holder.stateUpdate = { state in
            if state == .ready {
@@ -29,6 +29,11 @@ class AudioPlayerTests: XCTestCase {
        XCTAssert(audioPlayer.playerState == AudioPlayerState.idle)
    }
    
+    func test_AudioPlayer__state__load_source__should_be_loading() {
+        try? audioPlayer.load(item: Source.getAudioItem(), playWhenReady: false)
+        XCTAssertEqual(audioPlayer.playerState, AudioPlayerState.loading)
+    }
+    
    func test_AudioPlayer__state__load_source__should_be_ready() {
        let expectation = XCTestExpectation()
        listener.stateUpdate = { state in
@@ -25,13 +25,13 @@ SwiftAudio is available through [CocoaPods](http://cocoapods.org). To install
 it, simply add the following line to your Podfile:

 ```ruby
-pod 'SwiftAudio', '~> 0.9.3'
+pod 'SwiftAudio', '~> 0.10.0'
 ```

 ### Carthage
 SwiftAudio supports [Carthage](https://github.com/Carthage/Carthage). Add this to your Cartfile:
 ```ruby
-github "jorgenhenrichsen/SwiftAudio" ~> 0.9.3
+github "jorgenhenrichsen/SwiftAudio" ~> 0.10.0
 ```
 Then follow the rest of Carthage instructions on [adding a framework](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application).

@@ -8,35 +8,18 @@

 Pod::Spec.new do |s|
  s.name             = 'SwiftAudio'
-  s.version          = '0.9.3'
+  s.version          = '0.10.0'
  s.summary          = 'Easy audio streaming for iOS'
-
-# This description is used to generate tags and improve search results.
-#   * Think: What does it do? Why did you write it? What is the focus?
-#   * Try to keep it short, snappy and to the point.
-#   * Write the description between the DESC delimiters below.
-#   * Finally, don't worry about the indent, CocoaPods strips it!
-
  s.description      = <<-DESC
 SwiftAudio is an audio player written in Swift, making it simpler to work with audio playback from streams and files.
 DESC

  s.homepage         = 'https://github.com/jorgenhenrichsen/SwiftAudio'
-  # s.screenshots     = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
  s.license          = { :type => 'MIT', :file => 'LICENSE' }
  s.author           = { 'Jørgen Henrichsen' => 'jh.henrichs@gmail.com' }
  s.source           = { :git => 'https://github.com/jorgenhenrichsen/SwiftAudio.git', :tag => s.version.to_s }
-  # s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>'

  s.ios.deployment_target = '10.0'
-
+  s.swift_version = '5.0'
  s.source_files = 'SwiftAudio/Classes/**/*'
-  
-  # s.resource_bundles = {
-  #   'SwiftAudio' => ['SwiftAudio/Assets/*.png']
-  # }
-
-  # s.public_header_files = 'Pod/Classes/**/*.h'
-  # s.frameworks = 'UIKit', 'MapKit'
-  # s.dependency 'AFNetworking', '~> 2.3'
 end
@@ -181,6 +181,7 @@ class AVPlayerWrapper: AVPlayerWrapperProtocol {
        self._pendingAsset = AVURLAsset(url: url)
        
        if let pendingAsset = _pendingAsset {
+            self._state = .loading
            pendingAsset.loadValuesAsynchronously(forKeys: [Constants.assetPlayableKey], completionHandler: { [weak self] in
                
                guard let self = self else {
@@ -272,7 +273,7 @@ extension AVPlayerWrapper: AVPlayerObserverDelegate {
                self._state = .paused
            }
        case .waitingToPlayAtSpecifiedRate:
-            self._state = .loading
+            self._state = .buffering
        case .playing:
            self._state = .playing
        @unknown default:
@@ -284,15 +285,16 @@ extension AVPlayerWrapper: AVPlayerObserverDelegate {
        switch status {
            
        case .readyToPlay:
-            self._state = .ready
            
-            if let initialTime = _initialTime {
-                self.seek(to: initialTime)
-            }
-            else if _playWhenReady {
+            if _playWhenReady {
                self.play()
            }
-            
+            else {
+                self._state = .ready
+                if let initialTime = _initialTime {
+                    self.seek(to: initialTime)
+                }
+            }
            break
            
        case .failed:
@@ -14,11 +14,14 @@ import Foundation
 */
 public enum AVPlayerWrapperState: String {
    
-    /// The current item is set, and the player is ready to start loading (buffering).
+    /// An asset is being loaded for playback.
+    case loading
+    
+    /// The current item is loaded, and the player is ready to start playing.
    case ready
    
-    /// The current item is loading, getting ready to play.
-    case loading
+    /// The current item is playing, but are currently buffering.
+    case buffering
    
    /// The player is paused.
    case paused
@@ -305,16 +305,14 @@ public class AudioPlayer: AVPlayerWrapperDelegate {
    
    func AVWrapper(didChangeState state: AVPlayerWrapperState) {
        switch state {
-        case .ready:
+        case .ready, .loading:
            if (automaticallyUpdateNowPlayingInfo) {
                updateNowPlayingPlaybackValues()
            }
-            
            setTimePitchingAlgorithmForCurrentItem()
        case .playing, .paused:
            if (automaticallyUpdateNowPlayingInfo) {
-                updateNowPlayingCurrentTime(currentTime)
-                updateNowPlayingRate(rate)
+                updateNowPlayingPlaybackValues()
            }
        default: break
        }
Author	SHA1	Message	Date
Jørgen Henrichsen	1c4cbf676d	Merge pull request #70 from jorgenhenrichsen/more-detaile-player-states More detailed player states	2019-07-03 18:29:43 +02:00
Jørgen Henrichsen	ec9492da17	Add tests for the loading state.	2019-07-03 17:48:28 +02:00
Jørgen Henrichsen	5add7699ff	Added an example of how to handle network error. The example app will now handle a network error, and reload when play is called, after a item failed to load because of a network error.	2019-07-03 16:41:14 +02:00
Jørgen Henrichsen	bc1d775875	Reset audio file to spotify preview in example app.	2019-07-03 15:06:50 +02:00
Jørgen Henrichsen	4c1a545e87	Update podspec. Remove swift version file. Clean up the podspec file and set swift version to 5.0. Remove the .swift-version file as it's use is deprecated.	2019-07-03 14:53:24 +02:00
Jørgen Henrichsen	f31b52f81b	Make the ready state reachable for items with initial time. Fixes a problem where the .ready state would not be reached for audio items that had an initial time.	2019-07-03 14:25:43 +02:00
Jørgen Henrichsen	355c729078	Update README. Update podspec. Bump version to 0.10.0.	2019-07-03 13:22:27 +02:00
Jørgen Henrichsen	719d3c852b	Add an activityindicator to the example. Shows how an activityindicator can be used to indicate loading, when player is loading or buffering.	2019-07-03 13:21:41 +02:00
Jørgen Henrichsen	4f33d7e688	Add a new state `buffering`. Introduces an additional state to better describe the current state of the player. Previously the player would be `idle` until the item was loaded, then changing to `ready`. When the player started to play it would first enter `loading`, then subsequently `playing`. Now it will instead immediately enter `loading`, then when the item is loaded it will enter `ready`. When the item then is played it will enter `buffering` and then `playing`. This should make it easier to update UI accordingly to the players current state.	2019-07-03 11:23:10 +02:00