Compare commits

...

15 Commits

Author SHA1 Message Date
David Chavez 68a15ab3a6 Release 0.13.1 2021-08-12 11:18:08 +02:00
David Chavez 92053a2bd0 Add event for queue index changes 2021-08-12 11:16:56 +02:00
David Chavez aeef676164 Persist rate accross player vs item 2021-08-12 11:16:46 +02:00
David Chavez 9c32a86bfa Rename library 2021-08-11 22:25:48 +02:00
David Chavez ce04a796ee Call super on reset of QueuedAudioPlayer 2021-06-26 13:25:00 +02:00
David Chavez 7370ad05e6 Add support for metadata updates (#3) 2021-05-29 22:54:41 +02:00
David Chavez aedae222b0 Move to Github provided machines 2021-05-29 22:27:47 +02:00
David Chavez b2cb178d21 Fix tests 2021-05-29 17:23:51 +02:00
David Chavez 8e62c63fff Disable allowsExternalPlayback 2021-05-29 17:02:43 +02:00
David Chavez f585d7021c Thread safe mutation of now playing info center 2021-05-29 16:59:14 +02:00
David Chavez 32809366fa Allow pausing to be respected if done while loading 2021-05-29 16:43:16 +02:00
David Chavez a6c67e858d Add QueueManagerDelegate to track queue changes 2021-05-29 16:25:31 +02:00
David Chavez 071d0e8017 Add ability to set a repeat mode for QueuedAudioPlayer 2021-05-29 13:55:00 +02:00
David Chavez 6755694566 Add back the podspec 2021-05-29 13:18:02 +02:00
David Chavez 7f117b0670 Remove Codecov (#2) 2021-05-27 23:07:23 +02:00
38 changed files with 287 additions and 77 deletions
+2 -7
View File
@@ -2,10 +2,7 @@ name: validate
on: [push]
jobs:
unit-tests:
runs-on: [self-hosted, macOS, arm64e]
defaults:
run:
shell: "/usr/bin/arch -arch arm64e /bin/bash {0}"
runs-on: macos-latest
strategy:
matrix:
destination:
@@ -20,6 +17,4 @@ jobs:
cd Example
xcodebuild test -scheme SwiftAudio-Example -destination "${destination}" -enableCodeCoverage YES
env:
destination: ${{ matrix.destination }}
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v1.2.1
destination: ${{ matrix.destination }}
@@ -46,6 +46,7 @@
9B05AA332660276400C7A389 /* Nimble in Frameworks */ = {isa = PBXBuildFile; productRef = 9B05AA322660276400C7A389 /* Nimble */; };
9B05AA3A266028E200C7A389 /* SwiftAudio in Frameworks */ = {isa = PBXBuildFile; productRef = 9B05AA39266028E200C7A389 /* SwiftAudio */; };
9B05AA3C26602C0E00C7A389 /* SwiftAudio in Frameworks */ = {isa = PBXBuildFile; productRef = 9B05AA3B26602C0E00C7A389 /* SwiftAudio */; };
9B521D0E2662937600EF0C3A /* MockDispatchQueue.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9B521D0D2662937600EF0C3A /* MockDispatchQueue.swift */; };
/* End PBXBuildFile section */
/* Begin PBXContainerItemProxy section */
@@ -94,6 +95,7 @@
607FACEA1AFB9204008FA782 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
607FACEB1AFB9204008FA782 /* AVPlayerObserverTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AVPlayerObserverTests.swift; sourceTree = "<group>"; };
9B05AA38266028D600C7A389 /* SwiftAudio */ = {isa = PBXFileReference; lastKnownFileType = folder; name = SwiftAudio; path = ..; sourceTree = "<group>"; };
9B521D0D2662937600EF0C3A /* MockDispatchQueue.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockDispatchQueue.swift; sourceTree = "<group>"; };
/* End PBXFileReference section */
/* Begin PBXFrameworksBuildPhase section */
@@ -136,6 +138,7 @@
07756B68218A4E870023935E /* AudioSession.swift */,
074B0D6A222C247B001A45A9 /* NowPlayingInfoCenter.swift */,
074B0D6C222C24DE001A45A9 /* NowPlayingInfoController.swift */,
9B521D0D2662937600EF0C3A /* MockDispatchQueue.swift */,
);
path = Mocks;
sourceTree = "<group>";
@@ -376,6 +379,7 @@
0775575920668B020002C6A1 /* QueueManagerTests.swift in Sources */,
074A6483205C155E0083D868 /* AVPlayerTimeObserverTests.swift in Sources */,
078C908F210D263200555E80 /* AVPlayerItemObserverTests.swift in Sources */,
9B521D0E2662937600EF0C3A /* MockDispatchQueue.swift in Sources */,
0708ED6C2116DA4C00EB29BD /* AudioSessionControllerTests.swift in Sources */,
074B0D6B222C247B001A45A9 /* NowPlayingInfoCenter.swift in Sources */,
07DBB1E1212C17E600BB4278 /* QueuedAudioPlayerTests.swift in Sources */,
@@ -47,6 +47,12 @@ class AVPlayerItemObserverTests: QuickSpec {
}
class AVPlayerItemObserverDelegateHolder: AVPlayerItemObserverDelegate {
var receivedMetadata: ((_ metadata: [AVMetadataItem]) -> Void)?
func item(didReceiveMetadata metadata: [AVMetadataItem]) {
receivedMetadata?(metadata)
}
var updateDuration: ((_ duration: Double) -> Void)?
+4
View File
@@ -182,6 +182,10 @@ class AVPlayerWrapperTests: XCTestCase {
}
class AVPlayerWrapperDelegateHolder: AVPlayerWrapperDelegate {
func AVWrapper(didReceiveMetadata metadata: [AVMetadataItem]) {
}
func AVWrapperDidRecreateAVPlayer() {
}
@@ -0,0 +1,17 @@
//
// MockDispatchQueue.swift
// SwiftAudio_Tests
//
// Created by David Chavez on 29.05.21.
// Copyright © 2021 Double Symmmery. All rights reserved.
//
import Foundation
@testable import SwiftAudio
final class MockDispatchQueue: DispatchQueueType {
func async(flags: DispatchWorkItemFlags, execute work: @escaping @convention(block) () -> Void) {
work()
}
}
@@ -12,7 +12,7 @@ class NowPlayingInfoControllerTests: QuickSpec {
var nowPlayingController: NowPlayingInfoController!
beforeEach {
nowPlayingController = NowPlayingInfoController(infoCenter: NowPlayingInfoCenter_Mock())
nowPlayingController = NowPlayingInfoController(dispatchQueue: MockDispatchQueue(), infoCenter: NowPlayingInfoCenter_Mock())
}
describe("its info dictionary") {
+5 -2
View File
@@ -88,7 +88,7 @@ let audioItem = DefaultAudioItem(audioUrl: "someUrl", sourceType: .stream)
player.add(item: audioItem, playWhenReady: true) // Since this is the first item, we can supply playWhenReady: true to immedietaly start playing when the item is loaded.
```
When a track is done playing, the player will load the next track and update the queue, as long as `automaticallyPlayNextSong` is `true` (default).
When a track is done playing, the player will load the next track and update the queue.
##### Navigating the queue
All `AudioItem`s are stored in either `previousItems` or `nextItems`, which refers to items that come prior to the `currentItem` and after, respectively. The queue is navigated with:
@@ -114,6 +114,9 @@ Current options for configuring the `AudioPlayer`:
- `rate`
- `audioTimePitchAlgorithm`: This value decides the `AVAudioTimePitchAlgorithm` used for each `AudioItem`. Implement `TimePitching` in your `AudioItem`-subclass to override individually for each `AudioItem`.
Options particular to `QueuedAudioPlayer`:
- `repeatMode`: The repeat mode: off, track, queue
### Audio Session
Remember to activate an audio session with an appropriate category for your app. This can be done with `AudioSessionController`:
```swift
@@ -185,4 +188,4 @@ Jørgen Henrichsen
## License
SwiftAudio is available under the MIT license. See the LICENSE file for more info.
SwiftAudio is available under the MIT license. See the LICENSE file for more info.
@@ -1,50 +0,0 @@
//
// MediaInfoController.swift
// SwiftAudio
//
// Created by Jørgen Henrichsen on 15/03/2018.
//
import Foundation
import MediaPlayer
public class NowPlayingInfoController: NowPlayingInfoControllerProtocol {
private var _infoCenter: NowPlayingInfoCenter
private var _info: [String: Any] = [:]
var infoCenter: NowPlayingInfoCenter {
return _infoCenter
}
var info: [String: Any] {
return _info
}
public required init() {
self._infoCenter = MPNowPlayingInfoCenter.default()
}
public required init(infoCenter: NowPlayingInfoCenter) {
self._infoCenter = infoCenter
}
public func set(keyValues: [NowPlayingInfoKeyValue]) {
keyValues.forEach { (keyValue) in
_info[keyValue.getKey()] = keyValue.getValue()
}
self._infoCenter.nowPlayingInfo = _info
}
public func set(keyValue: NowPlayingInfoKeyValue) {
_info[keyValue.getKey()] = keyValue.getValue()
self._infoCenter.nowPlayingInfo = _info
}
public func clear() {
self._info = [:]
self._infoCenter.nowPlayingInfo = _info
}
}
+26
View File
@@ -0,0 +1,26 @@
#
# Be sure to run `pod lib lint SwiftAudioEx.podspec' to ensure this is a
# valid spec before submitting.
#
# Any lines starting with a # are optional, but their use is encouraged
# To learn more about a Podspec see http://guides.cocoapods.org/syntax/podspec.html
#
Pod::Spec.new do |s|
s.name = 'SwiftAudioEx'
s.version = '0.13.1'
s.summary = 'Easy audio streaming for iOS'
s.description = <<-DESC
SwiftAudioEx 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/DoubleSymmetry/SwiftAudioEx'
s.license = { :type => 'MIT', :file => 'LICENSE' }
s.authors = { 'David Chavez' => 'david@dcvz.io',
'Jørgen Henrichsen' => 'jh.henrichs@gmail.com', }
s.source = { :git => 'https://github.com/DoubleSymmetry/SwiftAudioEx.git', :tag => s.version.to_s }
s.ios.deployment_target = '10.0'
s.swift_version = '5.0'
s.source_files = 'SwiftAudioEx/Classes/**/*'
end
@@ -59,6 +59,9 @@ class AVPlayerWrapper: AVPlayerWrapperProtocol {
self.playerTimeObserver.delegate = self
self.playerItemNotificationObserver.delegate = self
self.playerItemObserver.delegate = self
// disabled since we're not making use of video playback
self.avPlayer.allowsExternalPlayback = false;
playerTimeObserver.registerForPeriodicTimeEvents()
}
@@ -133,10 +136,12 @@ class AVPlayerWrapper: AVPlayerWrapperProtocol {
}
func play() {
_playWhenReady = true
avPlayer.play()
}
func pause() {
_playWhenReady = false
avPlayer.pause()
}
@@ -205,6 +210,9 @@ class AVPlayerWrapper: AVPlayerWrapperProtocol {
self.playerObserver.startObserving()
self.playerItemNotificationObserver.startObserving(item: currentItem)
self.playerItemObserver.startObserving(item: currentItem)
for format in pendingAsset.availableMetadataFormats {
self.delegate?.AVWrapper(didReceiveMetadata: pendingAsset.metadata(forFormat: format))
}
}
break
@@ -337,5 +345,9 @@ extension AVPlayerWrapper: AVPlayerItemObserverDelegate {
func item(didUpdateDuration duration: Double) {
self.delegate?.AVWrapper(didUpdateDuration: duration)
}
func item(didReceiveMetadata metadata: [AVMetadataItem]) {
self.delegate?.AVWrapper(didReceiveMetadata: metadata)
}
}
@@ -6,6 +6,7 @@
//
import Foundation
import MediaPlayer
protocol AVPlayerWrapperDelegate: class {
@@ -15,6 +16,7 @@ protocol AVPlayerWrapperDelegate: class {
func AVWrapper(failedWithError error: Error?)
func AVWrapper(seekTo seconds: Int, didFinish: Bool)
func AVWrapper(didUpdateDuration duration: Double)
func AVWrapper(didReceiveMetadata metadata: [AVMetadataItem])
func AVWrapperItemDidPlayToEndTime()
func AVWrapperDidRecreateAVPlayer()
@@ -115,9 +115,17 @@ public class AudioPlayer: AVPlayerWrapperDelegate {
set { _wrapper.isMuted = newValue }
}
private var _rate: Float = 1.0
public var rate: Float {
get { return wrapper.rate }
set { _wrapper.rate = newValue }
get { return _rate }
set {
_rate = newValue
// Only set the rate on the wrapper if it is already playing.
if _wrapper.rate > 0 {
_wrapper.rate = newValue
}
}
}
// MARK: - Init
@@ -311,7 +319,11 @@ public class AudioPlayer: AVPlayerWrapperDelegate {
updateNowPlayingPlaybackValues()
}
setTimePitchingAlgorithmForCurrentItem()
case .playing, .paused:
case .playing:
// When a track starts playing, reset the rate to the stored rate
self.rate = _rate;
fallthrough
case .paused:
if (automaticallyUpdateNowPlayingInfo) {
updateNowPlayingPlaybackValues()
}
@@ -338,6 +350,10 @@ public class AudioPlayer: AVPlayerWrapperDelegate {
func AVWrapper(didUpdateDuration duration: Double) {
self.event.updateDuration.emit(data: duration)
}
func AVWrapper(didReceiveMetadata metadata: [AVMetadataItem]) {
self.event.receiveMetadata.emit(data: metadata)
}
func AVWrapperItemDidPlayToEndTime() {
self.event.playbackEnd.emit(data: .playedUntilEnd)
@@ -6,6 +6,7 @@
//
import Foundation
import MediaPlayer
extension AudioPlayer {
@@ -15,7 +16,9 @@ extension AudioPlayer {
public typealias FailEventData = (Error?)
public typealias SeekEventData = (seconds: Int, didFinish: Bool)
public typealias UpdateDurationEventData = (Double)
public typealias MetadataEventData = ([AVMetadataItem])
public typealias DidRecreateAVPlayerEventData = ()
public typealias QueueIndexEventData = (previousIndex: Int?, newIndex: Int?)
public struct EventHolder {
@@ -55,6 +58,12 @@ extension AudioPlayer {
- Important: Remember to dispatch to the main queue if any UI is updated in the event handler.
*/
public let updateDuration: AudioPlayer.Event<UpdateDurationEventData> = AudioPlayer.Event()
/**
Emitted when the player receives metadata.
- Important: Remember to dispatch to the main queue if any UI is updated in the event handler.
*/
public let receiveMetadata: AudioPlayer.Event<MetadataEventData> = AudioPlayer.Event()
/**
Emitted when the underlying AVPlayer instance is recreated. Recreation happens if the current player fails.
@@ -62,7 +71,13 @@ extension AudioPlayer {
- Note: It can be necessary to set the AVAudioSession's category again when this event is emitted.
*/
public let didRecreateAVPlayer: AudioPlayer.Event<()> = AudioPlayer.Event()
/**
Emitted when a new track starts and the queue index changes.
- Important: Remember to dispatch to the main queue if any UI is updated in the event handler.
- Note: It is only fired for instances of a QueuedAudioPlayer.
*/
public let queueIndex: AudioPlayer.Event<QueueIndexEventData> = AudioPlayer.Event()
}
public typealias EventClosure<EventData> = (EventData) -> Void
@@ -0,0 +1,71 @@
//
// MediaInfoController.swift
// SwiftAudio
//
// Created by Jørgen Henrichsen on 15/03/2018.
//
import Foundation
import MediaPlayer
public class NowPlayingInfoController: NowPlayingInfoControllerProtocol {
private let concurrentInfoQueue: DispatchQueueType
private var _infoCenter: NowPlayingInfoCenter
private var _info: [String: Any] = [:]
var infoCenter: NowPlayingInfoCenter {
return _infoCenter
}
var info: [String: Any] {
return _info
}
public required init() {
self.concurrentInfoQueue = DispatchQueue(label: "com.doublesymmetry.nowPlayingInfoQueue", attributes: .concurrent)
self._infoCenter = MPNowPlayingInfoCenter.default()
}
/// Used for testing purposes.
public required init(dispatchQueue: DispatchQueueType, infoCenter: NowPlayingInfoCenter) {
self.concurrentInfoQueue = dispatchQueue
self._infoCenter = infoCenter
}
public required init(infoCenter: NowPlayingInfoCenter) {
self.concurrentInfoQueue = DispatchQueue(label: "com.doublesymmetry.nowPlayingInfoQueue", attributes: .concurrent)
self._infoCenter = infoCenter
}
public func set(keyValues: [NowPlayingInfoKeyValue]) {
concurrentInfoQueue.async(flags: .barrier) { [weak self] in
guard let self = self else { return }
keyValues.forEach { (keyValue) in
self._info[keyValue.getKey()] = keyValue.getValue()
}
self._infoCenter.nowPlayingInfo = self._info
}
}
public func set(keyValue: NowPlayingInfoKeyValue) {
concurrentInfoQueue.async(flags: .barrier) { [weak self] in
guard let self = self else { return }
self._info[keyValue.getKey()] = keyValue.getValue()
self._infoCenter.nowPlayingInfo = self._info
}
}
public func clear() {
concurrentInfoQueue.async(flags: .barrier) { [weak self] in
guard let self = self else { return }
self._info = [:]
self._infoCenter.nowPlayingInfo = self._info
}
}
}
@@ -14,6 +14,11 @@ protocol AVPlayerItemObserverDelegate: class {
Called when the observed item updates the duration.
*/
func item(didUpdateDuration duration: Double)
/**
Called when the observed item receives metadata
*/
func item(didReceiveMetadata metadata: [AVMetadataItem])
}
@@ -28,6 +33,7 @@ class AVPlayerItemObserver: NSObject {
private struct AVPlayerItemKeyPath {
static let duration = #keyPath(AVPlayerItem.duration)
static let loadedTimeRanges = #keyPath(AVPlayerItem.loadedTimeRanges)
static let timedMetadata = #keyPath(AVPlayerItem.timedMetadata)
}
private(set) var isObserving: Bool = false
@@ -50,6 +56,7 @@ class AVPlayerItemObserver: NSObject {
self.observingItem = item
item.addObserver(self, forKeyPath: AVPlayerItemKeyPath.duration, options: [.new], context: &AVPlayerItemObserver.context)
item.addObserver(self, forKeyPath: AVPlayerItemKeyPath.loadedTimeRanges, options: [.new], context: &AVPlayerItemObserver.context)
item.addObserver(self, forKeyPath: AVPlayerItemKeyPath.timedMetadata, options: [.new], context: &AVPlayerItemObserver.context)
}
func stopObservingCurrentItem() {
@@ -58,6 +65,7 @@ class AVPlayerItemObserver: NSObject {
}
observingItem.removeObserver(self, forKeyPath: AVPlayerItemKeyPath.duration, context: &AVPlayerItemObserver.context)
observingItem.removeObserver(self, forKeyPath: AVPlayerItemKeyPath.loadedTimeRanges, context: &AVPlayerItemObserver.context)
observingItem.removeObserver(self, forKeyPath: AVPlayerItemKeyPath.timedMetadata, context: &AVPlayerItemObserver.context)
self.isObserving = false
self.observingItem = nil
}
@@ -78,6 +86,11 @@ class AVPlayerItemObserver: NSObject {
if let ranges = change?[.newKey] as? [NSValue], let duration = ranges.first?.timeRangeValue.duration {
self.delegate?.item(didUpdateDuration: duration.seconds)
}
case AVPlayerItemKeyPath.timedMetadata:
if let metadata = change?[.newKey] as? [AVMetadataItem] {
self.delegate?.item(didReceiveMetadata: metadata)
}
default: break
}
@@ -7,10 +7,22 @@
import Foundation
protocol QueueManagerDelegate: AnyObject {
func onReceivedFirstItem()
func onCurrentIndexChanged(oldIndex: Int, newIndex: Int)
}
class QueueManager<T> {
private var _items: [T] = []
weak var delegate: QueueManagerDelegate? = nil
private var _items: [T] = [] {
didSet {
if oldValue.count == 0 && _items.count > 0 && _currentIndex == 0 {
delegate?.onReceivedFirstItem()
}
}
}
/**
All items held by the queue.
@@ -33,7 +45,11 @@ class QueueManager<T> {
return Array(_items[0..<_currentIndex])
}
private var _currentIndex: Int = 0
private var _currentIndex: Int = 0 {
didSet {
delegate?.onCurrentIndexChanged(oldIndex: oldValue, newIndex: _currentIndex)
}
}
/**
The index of the current item.
@@ -11,15 +11,17 @@ import MediaPlayer
/**
An audio player that can keep track of a queue of AudioItems.
*/
public class QueuedAudioPlayer: AudioPlayer {
public class QueuedAudioPlayer: AudioPlayer, QueueManagerDelegate {
let queueManager: QueueManager = QueueManager<AudioItem>()
/**
Set wether the player should automatically play the next song when a song is finished.
Default is `true`.
*/
public var automaticallyPlayNextSong: Bool = true
public init() {
super.init()
queueManager.delegate = self
}
/// The repeat mode for the queue player.
public var repeatMode: RepeatMode = .off
public override var currentItem: AudioItem? {
return queueManager.current
@@ -37,9 +39,11 @@ public class QueuedAudioPlayer: AudioPlayer {
*/
public override func stop() {
super.stop()
self.event.queueIndex.emit(data: (currentIndex, nil))
}
override func reset() {
super.reset()
queueManager.clearQueue()
}
@@ -185,9 +189,32 @@ public class QueuedAudioPlayer: AudioPlayer {
override func AVWrapperItemDidPlayToEndTime() {
super.AVWrapperItemDidPlayToEndTime()
if automaticallyPlayNextSong {
try? self.next()
switch repeatMode {
case .off: try? self.next()
case .track:
seek(to: 0)
play()
case .queue:
do {
try self.next()
} catch APError.QueueError.noNextItem {
do {
try jumpToItem(atIndex: 0, playWhenReady: true)
} catch { /* TODO: handle possible errors from load */ }
} catch { /* TODO: handle possible errors from load */ }
}
}
// MARK: - QueueManagerDelegate
func onCurrentIndexChanged(oldIndex: Int, newIndex: Int) {
// if _currentItem is nil, then this was triggered by a reset. ignore.
if _currentItem == nil { return }
self.event.queueIndex.emit(data: (oldIndex, newIndex))
}
func onReceivedFirstItem() {
self.event.queueIndex.emit(data: (nil, 0))
}
}
+15
View File
@@ -0,0 +1,15 @@
//
// RepeatMode.swift
// SwiftAudio
//
// Created by David Chavez on 29.05.21.
// Copyright © 2021 Double Symmmery. All rights reserved.
//
import Foundation
public enum RepeatMode: Int {
case off
case track
case queue
}
@@ -0,0 +1,18 @@
//
// DispatchQueueType.swift
// SwiftAudio
//
// Created by David Chavez on 29.05.21.
//
import Foundation
public protocol DispatchQueueType {
func async(flags: DispatchWorkItemFlags, execute work: @escaping @convention(block) () -> Void)
}
extension DispatchQueue: DispatchQueueType {
public func async(flags: DispatchWorkItemFlags, execute work: @escaping @convention(block) () -> Void) {
async(group: nil, qos: .unspecified, flags: flags, execute: work)
}
}