mirror of
https://github.com/vector-im/element-ios.git
synced 2024-09-30 00:02:47 +00:00
424 lines
17 KiB
Swift
424 lines
17 KiB
Swift
//
|
|
// Copyright 2022 New Vector Ltd
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
import Combine
|
|
import SwiftUI
|
|
|
|
// TODO: VoiceBroadcastPlaybackViewModel must be revisited in order to not depend on MatrixSDK
|
|
// We need a VoiceBroadcastPlaybackServiceProtocol and VoiceBroadcastAggregatorProtocol
|
|
import MatrixSDK
|
|
|
|
class VoiceBroadcastPlaybackViewModel: VoiceBroadcastPlaybackViewModelType, VoiceBroadcastPlaybackViewModelProtocol {
|
|
|
|
// MARK: - Properties
|
|
|
|
// MARK: Private
|
|
private let mediaServiceProvider: VoiceMessageMediaServiceProvider
|
|
private let cacheManager: VoiceMessageAttachmentCacheManager
|
|
|
|
private var voiceBroadcastAggregator: VoiceBroadcastAggregator
|
|
private var voiceBroadcastChunkQueue: [VoiceBroadcastChunk] = []
|
|
private var voiceBroadcastAttachmentCacheManagerLoadResults: [VoiceMessageAttachmentCacheManagerLoadResult] = []
|
|
|
|
private var audioPlayer: VoiceMessageAudioPlayer?
|
|
private var displayLink: CADisplayLink!
|
|
|
|
private var isPlaybackInitialized: Bool = false
|
|
private var acceptProgressUpdates: Bool = true
|
|
private var isActuallyPaused: Bool = false
|
|
private var isProcessingVoiceBroadcastChunk: Bool = false
|
|
private var reloadVoiceBroadcastChunkQueue: Bool = false
|
|
private var seekToChunkTime: TimeInterval?
|
|
|
|
private var isPlayingLastChunk: Bool {
|
|
let chunks = reorderVoiceBroadcastChunks(chunks: Array(voiceBroadcastAggregator.voiceBroadcast.chunks))
|
|
guard let chunkDuration = chunks.last?.duration else {
|
|
return false
|
|
}
|
|
|
|
return state.bindings.progress + 1000 >= state.playingState.duration - Float(chunkDuration)
|
|
}
|
|
|
|
private var isLivePlayback: Bool {
|
|
return (!isPlaybackInitialized || isPlayingLastChunk) && (state.broadcastState == .started || state.broadcastState == .resumed)
|
|
}
|
|
|
|
// MARK: Public
|
|
|
|
// MARK: - Setup
|
|
|
|
init(details: VoiceBroadcastPlaybackDetails,
|
|
mediaServiceProvider: VoiceMessageMediaServiceProvider,
|
|
cacheManager: VoiceMessageAttachmentCacheManager,
|
|
voiceBroadcastAggregator: VoiceBroadcastAggregator) {
|
|
self.mediaServiceProvider = mediaServiceProvider
|
|
self.cacheManager = cacheManager
|
|
self.voiceBroadcastAggregator = voiceBroadcastAggregator
|
|
|
|
let viewState = VoiceBroadcastPlaybackViewState(details: details,
|
|
broadcastState: voiceBroadcastAggregator.voiceBroadcastState,
|
|
playbackState: .stopped,
|
|
playingState: VoiceBroadcastPlayingState(duration: Float(voiceBroadcastAggregator.voiceBroadcast.duration), isLive: false),
|
|
bindings: VoiceBroadcastPlaybackViewStateBindings(progress: 0))
|
|
super.init(initialViewState: viewState)
|
|
|
|
displayLink = CADisplayLink(target: WeakTarget(self, selector: #selector(handleDisplayLinkTick)), selector: WeakTarget.triggerSelector)
|
|
displayLink.isPaused = true
|
|
displayLink.add(to: .current, forMode: .common)
|
|
|
|
self.voiceBroadcastAggregator.delegate = self
|
|
self.voiceBroadcastAggregator.start()
|
|
}
|
|
|
|
private func release() {
|
|
MXLog.debug("[VoiceBroadcastPlaybackViewModel] release")
|
|
if let audioPlayer = audioPlayer {
|
|
audioPlayer.deregisterDelegate(self)
|
|
self.audioPlayer = nil
|
|
}
|
|
}
|
|
|
|
// MARK: - Public
|
|
|
|
override func process(viewAction: VoiceBroadcastPlaybackViewAction) {
|
|
switch viewAction {
|
|
case .play:
|
|
play()
|
|
case .pause:
|
|
pause()
|
|
case .sliderChange(let didChange):
|
|
didSliderChanged(didChange)
|
|
}
|
|
}
|
|
|
|
|
|
// MARK: - Private
|
|
|
|
/// Listen voice broadcast
|
|
private func play() {
|
|
displayLink.isPaused = false
|
|
isActuallyPaused = false
|
|
|
|
if let audioPlayer = audioPlayer {
|
|
MXLog.debug("[VoiceBroadcastPlaybackViewModel] play: resume")
|
|
audioPlayer.play()
|
|
} else {
|
|
state.playbackState = .buffering
|
|
if voiceBroadcastAggregator.launchState == .loaded {
|
|
let chunks = voiceBroadcastAggregator.voiceBroadcast.chunks
|
|
MXLog.debug("[VoiceBroadcastPlaybackViewModel] play: restart from the beginning: \(chunks.count) chunks")
|
|
|
|
// Reinject all the chunks we already have and play them
|
|
voiceBroadcastChunkQueue = Array(chunks)
|
|
handleVoiceBroadcastChunksProcessing()
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Pause voice broadcast
|
|
private func pause() {
|
|
MXLog.debug("[VoiceBroadcastPlaybackViewModel] pause")
|
|
|
|
displayLink.isPaused = true
|
|
isActuallyPaused = true
|
|
|
|
if let audioPlayer = audioPlayer, audioPlayer.isPlaying {
|
|
audioPlayer.pause()
|
|
} else {
|
|
state.playbackState = .paused
|
|
state.playingState.isLive = false
|
|
}
|
|
}
|
|
|
|
private func stopIfVoiceBroadcastOver() {
|
|
MXLog.debug("[VoiceBroadcastPlaybackViewModel] stopIfVoiceBroadcastOver")
|
|
|
|
// Check if the broadcast is over before stopping everything
|
|
// If not, the player should not stopped. The view state must be move to buffering
|
|
if state.broadcastState == .stopped, isPlayingLastChunk {
|
|
stop()
|
|
} else {
|
|
state.playbackState = .buffering
|
|
}
|
|
}
|
|
|
|
private func stop() {
|
|
MXLog.debug("[VoiceBroadcastPlaybackViewModel] stop")
|
|
|
|
displayLink.isPaused = true
|
|
|
|
// Objects will be released on audioPlayerDidStopPlaying
|
|
audioPlayer?.stop()
|
|
}
|
|
|
|
|
|
// MARK: - Voice broadcast chunks playback
|
|
|
|
/// Start the playback from the beginning or push more chunks to it
|
|
private func processPendingVoiceBroadcastChunks() {
|
|
reorderPendingVoiceBroadcastChunks()
|
|
processNextVoiceBroadcastChunk()
|
|
}
|
|
|
|
/// Start the playback from the last known chunk
|
|
private func processPendingVoiceBroadcastChunksForLivePlayback() {
|
|
let chunks = reorderVoiceBroadcastChunks(chunks: Array(voiceBroadcastAggregator.voiceBroadcast.chunks))
|
|
if let lastChunk = chunks.last {
|
|
MXLog.debug("[VoiceBroadcastPlaybackViewModel] processPendingVoiceBroadcastChunksForLivePlayback. Use the last chunk: sequence: \(lastChunk.sequence) out of the \(voiceBroadcastChunkQueue.count) chunks")
|
|
voiceBroadcastChunkQueue = [lastChunk]
|
|
}
|
|
processNextVoiceBroadcastChunk()
|
|
}
|
|
|
|
private func reorderPendingVoiceBroadcastChunks() {
|
|
// Make sure we download and process chunks in the right order
|
|
voiceBroadcastChunkQueue = reorderVoiceBroadcastChunks(chunks: voiceBroadcastChunkQueue)
|
|
}
|
|
private func reorderVoiceBroadcastChunks(chunks: [VoiceBroadcastChunk]) -> [VoiceBroadcastChunk] {
|
|
chunks.sorted(by: {$0.sequence < $1.sequence})
|
|
}
|
|
|
|
private func processNextVoiceBroadcastChunk() {
|
|
MXLog.debug("[VoiceBroadcastPlaybackViewModel] processNextVoiceBroadcastChunk: \(voiceBroadcastChunkQueue.count) chunks remaining")
|
|
|
|
guard voiceBroadcastChunkQueue.count > 0 else {
|
|
// We cached all chunks. Nothing more to do
|
|
return
|
|
}
|
|
|
|
guard !isProcessingVoiceBroadcastChunk else {
|
|
// Chunks caching is already in progress
|
|
return
|
|
}
|
|
|
|
isProcessingVoiceBroadcastChunk = true
|
|
|
|
// TODO: Control the download rate to avoid to download all chunk in mass
|
|
// We could synchronise it with the number of chunks in the player playlist (audioPlayer.playerItems)
|
|
|
|
let chunk = voiceBroadcastChunkQueue.removeFirst()
|
|
|
|
// numberOfSamples is for the equalizer view we do not support yet
|
|
cacheManager.loadAttachment(chunk.attachment, numberOfSamples: 1) { [weak self] result in
|
|
guard let self = self else {
|
|
return
|
|
}
|
|
|
|
self.isProcessingVoiceBroadcastChunk = false
|
|
if self.reloadVoiceBroadcastChunkQueue {
|
|
self.reloadVoiceBroadcastChunkQueue = false
|
|
self.processNextVoiceBroadcastChunk()
|
|
return
|
|
}
|
|
|
|
switch result {
|
|
case .success(let result):
|
|
guard result.eventIdentifier == chunk.attachment.eventId else {
|
|
return
|
|
}
|
|
|
|
self.voiceBroadcastAttachmentCacheManagerLoadResults.append(result)
|
|
|
|
if let audioPlayer = self.audioPlayer {
|
|
// Append the chunk to the current playlist
|
|
audioPlayer.addContentFromURL(result.url)
|
|
|
|
if let time = self.seekToChunkTime {
|
|
audioPlayer.seekToTime(time)
|
|
self.seekToChunkTime = nil
|
|
}
|
|
|
|
// Resume the player. Needed after a buffering
|
|
if self.state.playbackState == .buffering {
|
|
if audioPlayer.isPlaying == false {
|
|
MXLog.debug("[VoiceBroadcastPlaybackViewModel] processNextVoiceBroadcastChunk: Resume the player")
|
|
self.displayLink.isPaused = false
|
|
audioPlayer.play()
|
|
} else {
|
|
self.state.playbackState = .playing
|
|
self.state.playingState.isLive = self.isLivePlayback
|
|
}
|
|
}
|
|
} else {
|
|
// Init and start the player on the first chunk
|
|
let audioPlayer = self.mediaServiceProvider.audioPlayerForIdentifier(result.eventIdentifier)
|
|
audioPlayer.registerDelegate(self)
|
|
|
|
audioPlayer.loadContentFromURL(result.url, displayName: chunk.attachment.originalFileName)
|
|
self.displayLink.isPaused = false
|
|
audioPlayer.play()
|
|
if let time = self.seekToChunkTime {
|
|
audioPlayer.seekToTime(time)
|
|
self.seekToChunkTime = nil
|
|
}
|
|
self.audioPlayer = audioPlayer
|
|
}
|
|
|
|
case .failure (let error):
|
|
MXLog.error("[VoiceBroadcastPlaybackViewModel] processVoiceBroadcastChunkQueue: loadAttachment error", context: error)
|
|
if self.voiceBroadcastChunkQueue.count == 0 {
|
|
// No more chunk to try. Go to error
|
|
self.state.playbackState = .error
|
|
}
|
|
}
|
|
|
|
self.processNextVoiceBroadcastChunk()
|
|
}
|
|
}
|
|
|
|
private func updateDuration() {
|
|
let duration = voiceBroadcastAggregator.voiceBroadcast.duration
|
|
let time = TimeInterval(duration / 1000)
|
|
let formatter = DateComponentsFormatter()
|
|
formatter.unitsStyle = .abbreviated
|
|
|
|
state.playingState.duration = Float(duration)
|
|
state.playingState.durationLabel = formatter.string(from: time)
|
|
}
|
|
|
|
private func didSliderChanged(_ didChange: Bool) {
|
|
acceptProgressUpdates = !didChange
|
|
if didChange {
|
|
audioPlayer?.pause()
|
|
displayLink.isPaused = true
|
|
} else {
|
|
// Flush the chunks queue and the current audio player playlist
|
|
voiceBroadcastChunkQueue = []
|
|
reloadVoiceBroadcastChunkQueue = isProcessingVoiceBroadcastChunk
|
|
audioPlayer?.removeAllPlayerItems()
|
|
|
|
let chunks = reorderVoiceBroadcastChunks(chunks: Array(voiceBroadcastAggregator.voiceBroadcast.chunks))
|
|
|
|
// Reinject the chunks we need and play them
|
|
let remainingTime = state.playingState.duration - state.bindings.progress
|
|
var chunksDuration: UInt = 0
|
|
for chunk in chunks.reversed() {
|
|
chunksDuration += chunk.duration
|
|
voiceBroadcastChunkQueue.append(chunk)
|
|
if Float(chunksDuration) >= remainingTime {
|
|
break
|
|
}
|
|
}
|
|
|
|
MXLog.debug("[VoiceBroadcastPlaybackViewModel] didSliderChanged: restart to time: \(state.bindings.progress) milliseconds")
|
|
let time = state.bindings.progress - state.playingState.duration + Float(chunksDuration)
|
|
seekToChunkTime = TimeInterval(time / 1000)
|
|
// Check the condition to resume the playback when data will be ready (after the chunk process).
|
|
if state.playbackState != .stopped, isActuallyPaused == false {
|
|
state.playbackState = .buffering
|
|
}
|
|
processPendingVoiceBroadcastChunks()
|
|
}
|
|
}
|
|
|
|
@objc private func handleDisplayLinkTick() {
|
|
updateUI()
|
|
}
|
|
|
|
private func updateUI() {
|
|
guard let playingEventId = voiceBroadcastAttachmentCacheManagerLoadResults.first(where: { result in
|
|
result.url == audioPlayer?.currentUrl
|
|
})?.eventIdentifier,
|
|
let playingSequence = voiceBroadcastAggregator.voiceBroadcast.chunks.first(where: { chunk in
|
|
chunk.attachment.eventId == playingEventId
|
|
})?.sequence else {
|
|
return
|
|
}
|
|
|
|
let progress = Double(voiceBroadcastAggregator.voiceBroadcast.chunks.filter { chunk in
|
|
chunk.sequence < playingSequence
|
|
}.reduce(0) { $0 + $1.duration}) + (audioPlayer?.currentTime.rounded() ?? 0) * 1000
|
|
|
|
state.bindings.progress = Float(progress)
|
|
}
|
|
|
|
private func handleVoiceBroadcastChunksProcessing() {
|
|
// Handle specifically the case where we were waiting data to start playing a live playback
|
|
if isLivePlayback, state.playbackState == .buffering {
|
|
// Start the playback on the latest one
|
|
processPendingVoiceBroadcastChunksForLivePlayback()
|
|
} else {
|
|
processPendingVoiceBroadcastChunks()
|
|
}
|
|
}
|
|
}
|
|
|
|
// MARK: VoiceBroadcastAggregatorDelegate
|
|
extension VoiceBroadcastPlaybackViewModel: VoiceBroadcastAggregatorDelegate {
|
|
func voiceBroadcastAggregatorDidStartLoading(_ aggregator: VoiceBroadcastAggregator) {
|
|
}
|
|
|
|
func voiceBroadcastAggregatorDidEndLoading(_ aggregator: VoiceBroadcastAggregator) {
|
|
}
|
|
|
|
func voiceBroadcastAggregator(_ aggregator: VoiceBroadcastAggregator, didFailWithError: Error) {
|
|
MXLog.error("[VoiceBroadcastPlaybackViewModel] voiceBroadcastAggregator didFailWithError:", context: didFailWithError)
|
|
}
|
|
|
|
func voiceBroadcastAggregator(_ aggregator: VoiceBroadcastAggregator, didReceiveChunk: VoiceBroadcastChunk) {
|
|
voiceBroadcastChunkQueue.append(didReceiveChunk)
|
|
}
|
|
|
|
func voiceBroadcastAggregator(_ aggregator: VoiceBroadcastAggregator, didReceiveState: VoiceBroadcastInfoState) {
|
|
state.broadcastState = didReceiveState
|
|
|
|
// Handle the live icon appearance
|
|
state.playingState.isLive = isLivePlayback
|
|
}
|
|
|
|
func voiceBroadcastAggregatorDidUpdateData(_ aggregator: VoiceBroadcastAggregator) {
|
|
|
|
updateDuration()
|
|
|
|
if state.playbackState != .stopped, !isActuallyPaused {
|
|
handleVoiceBroadcastChunksProcessing()
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
// MARK: - VoiceMessageAudioPlayerDelegate
|
|
extension VoiceBroadcastPlaybackViewModel: VoiceMessageAudioPlayerDelegate {
|
|
func audioPlayerDidFinishLoading(_ audioPlayer: VoiceMessageAudioPlayer) {
|
|
}
|
|
|
|
func audioPlayerDidStartPlaying(_ audioPlayer: VoiceMessageAudioPlayer) {
|
|
state.playbackState = .playing
|
|
state.playingState.isLive = isLivePlayback
|
|
isPlaybackInitialized = true
|
|
}
|
|
|
|
func audioPlayerDidPausePlaying(_ audioPlayer: VoiceMessageAudioPlayer) {
|
|
state.playbackState = .paused
|
|
state.playingState.isLive = false
|
|
}
|
|
|
|
func audioPlayerDidStopPlaying(_ audioPlayer: VoiceMessageAudioPlayer) {
|
|
MXLog.debug("[VoiceBroadcastPlaybackViewModel] audioPlayerDidStopPlaying")
|
|
state.playbackState = .stopped
|
|
state.playingState.isLive = false
|
|
release()
|
|
}
|
|
|
|
func audioPlayer(_ audioPlayer: VoiceMessageAudioPlayer, didFailWithError error: Error) {
|
|
state.playbackState = .error
|
|
}
|
|
|
|
func audioPlayerDidFinishPlaying(_ audioPlayer: VoiceMessageAudioPlayer) {
|
|
MXLog.debug("[VoiceBroadcastPlaybackViewModel] audioPlayerDidFinishPlaying: \(audioPlayer.playerItems.count)")
|
|
stopIfVoiceBroadcastOver()
|
|
}
|
|
}
|