Fix the now playing info center while a voice broadcast is played

Riot/Assets/en.lproj/Vector.strings

@@ -2215,6 +2215,7 @@ Tap the + to start adding people.";
 "voice_broadcast_stop_alert_agree_button" = "Yes, stop";
 "voice_broadcast_voip_cannot_start_title" = "Can’t start a call";
 "voice_broadcast_voip_cannot_start_description" = "You can’t start a call as you are currently recording a live broadcast. Please end your live broadcast in order to start a call.";
+"voice_broadcast_playback_lock_screen_placeholder" = "Voice broadcast";
 
 // MARK: - Version check
 

Riot/Generated/Strings.swift

@@ -9191,6 +9191,10 @@ public class VectorL10n: NSObject {
   public static var voiceBroadcastPlaybackLoadingError: String { 
     return VectorL10n.tr("Vector", "voice_broadcast_playback_loading_error") 
   }
+  /// Voice broadcast
+  public static var voiceBroadcastPlaybackLockScreenPlaceholder: String { 
+    return VectorL10n.tr("Vector", "voice_broadcast_playback_lock_screen_placeholder") 
+  }
   /// Yes, stop
   public static var voiceBroadcastStopAlertAgreeButton: String { 
     return VectorL10n.tr("Vector", "voice_broadcast_stop_alert_agree_button") 

Riot/Modules/Room/VoiceMessages/VoiceMessageMediaServiceProvider.swift

@@ -28,6 +28,7 @@ import MediaPlayer
     private var roomAvatarLoader: MXMediaLoader?
     private let audioPlayers: NSMapTable<NSString, VoiceMessageAudioPlayer>
     private let audioRecorders: NSHashTable<VoiceMessageAudioRecorder>
+    private let nowPlayingInfoDelegates: NSMapTable<VoiceMessageAudioPlayer, VoiceMessageNowPlayingInfoDelegate>
 
     private var displayLink: CADisplayLink!
 
@@ -93,6 +94,7 @@ import MediaPlayer
     private override init() {
         audioPlayers = NSMapTable<NSString, VoiceMessageAudioPlayer>(valueOptions: .weakMemory)
         audioRecorders = NSHashTable<VoiceMessageAudioRecorder>(options: .weakMemory)
+        nowPlayingInfoDelegates = NSMapTable<VoiceMessageAudioPlayer, VoiceMessageNowPlayingInfoDelegate>(keyOptions: .weakMemory, valueOptions: .weakMemory)
         activeAudioPlayers = Set<VoiceMessageAudioPlayer>()
         super.init()
 
@@ -123,6 +125,14 @@ import MediaPlayer
         pauseAllServicesExcept(nil)
     }
 
+    func registerNowPlayingInfoDelegate(_ delegate: VoiceMessageNowPlayingInfoDelegate, forPlayer player: VoiceMessageAudioPlayer) {
+        nowPlayingInfoDelegates.setObject(delegate, forKey: player)
+    }
+
+    func deregisterNowPlayingInfoDelegate(forPlayer player: VoiceMessageAudioPlayer) {
+        nowPlayingInfoDelegates.removeObject(forKey: player)
+    }
+
     // MARK: - VoiceMessageAudioPlayerDelegate
 
     func audioPlayerDidStartPlaying(_ audioPlayer: VoiceMessageAudioPlayer) {
@@ -134,16 +144,28 @@ import MediaPlayer
 
     func audioPlayerDidStopPlaying(_ audioPlayer: VoiceMessageAudioPlayer) {
         if currentlyPlayingAudioPlayer == audioPlayer {
-            currentlyPlayingAudioPlayer = nil
-            tearDownRemoteCommandCenter()
+            // If we have a NowPlayingInfoDelegate for this player
+            let nowPlayingInfoDelegate = nowPlayingInfoDelegates.object(forKey: audioPlayer)
+
+            // ask the delegate if we should disconnect from NowPlayingInfoCenter (if there's no delegate, we consider it safe to disconnect it)
+            if nowPlayingInfoDelegate?.shouldDisconnectFromNowPlayingInfoCenter(audioPlayer: audioPlayer) ?? true {
+                currentlyPlayingAudioPlayer = nil
+                tearDownRemoteCommandCenter(for: audioPlayer)
+            }
         }
         activeAudioPlayers.remove(audioPlayer)
     }
 
     func audioPlayerDidFinishPlaying(_ audioPlayer: VoiceMessageAudioPlayer) {
         if currentlyPlayingAudioPlayer == audioPlayer {
-            currentlyPlayingAudioPlayer = nil
-            tearDownRemoteCommandCenter()
+            // If we have a NowPlayingInfoDelegate for this player
+            let nowPlayingInfoDelegate = nowPlayingInfoDelegates.object(forKey: audioPlayer)
+
+            // ask the delegate if we should disconnect from NowPlayingInfoCenter (if there's no delegate, we consider it safe to disconnect it)
+            if nowPlayingInfoDelegate?.shouldDisconnectFromNowPlayingInfoCenter(audioPlayer: audioPlayer) ?? true {
+                currentlyPlayingAudioPlayer = nil
+                tearDownRemoteCommandCenter(for: audioPlayer)
+            }
         }
         activeAudioPlayers.remove(audioPlayer)
     }
@@ -242,7 +264,7 @@ import MediaPlayer
         }
     }
 
-    private func tearDownRemoteCommandCenter() {
+    private func tearDownRemoteCommandCenter(for audioPlayer: VoiceMessageAudioPlayer) {
         displayLink.isPaused = true
 
         UIApplication.shared.endReceivingRemoteControlEvents()
@@ -256,9 +278,14 @@ import MediaPlayer
             return
         }
 
-        let nowPlayingInfoCenter = MPNowPlayingInfoCenter.default()
-        nowPlayingInfoCenter.nowPlayingInfo = [MPMediaItemPropertyTitle: VectorL10n.voiceMessageLockScreenPlaceholder,
-                                               MPMediaItemPropertyPlaybackDuration: audioPlayer.duration as Any,
-                                               MPNowPlayingInfoPropertyElapsedPlaybackTime: audioPlayer.currentTime as Any]
+        // Checks if we have a delegate for this player, or if we should update the NowPlayingInfoCenter ourselves
+        if let nowPlayingInfoDelegate = nowPlayingInfoDelegates.object(forKey: audioPlayer) {
+            nowPlayingInfoDelegate.updateNowPlayingInfoCenter(forPlayer: audioPlayer)
+        } else {
+            let nowPlayingInfoCenter = MPNowPlayingInfoCenter.default()
+            nowPlayingInfoCenter.nowPlayingInfo = [MPMediaItemPropertyTitle: VectorL10n.voiceMessageLockScreenPlaceholder,
+                                        MPMediaItemPropertyPlaybackDuration: audioPlayer.duration as Any,
+                                MPNowPlayingInfoPropertyElapsedPlaybackTime: audioPlayer.currentTime as Any]
+        }
     }
 }

Riot/Modules/Room/VoiceMessages/VoiceMessageNowPlayingInfoDelegate.swift

@@ -0,0 +1,24 @@
+// 
+// Copyright 2023 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 Foundation
+
+@objc protocol VoiceMessageNowPlayingInfoDelegate {
+
+    func updateNowPlayingInfoCenter(forPlayer player: VoiceMessageAudioPlayer)
+
+    func shouldDisconnectFromNowPlayingInfoCenter(audioPlayer: VoiceMessageAudioPlayer) -> Bool
+}

RiotSwiftUI/Modules/Room/VoiceBroadcastPlayback/MatrixSDK/VoiceBroadcastPlaybackViewModel.swift

@@ -16,6 +16,7 @@
 
 import Combine
 import SwiftUI
+import MediaPlayer
 
 // TODO: VoiceBroadcastPlaybackViewModel must be revisited in order to not depend on MatrixSDK
 // We need a VoiceBroadcastPlaybackServiceProtocol and VoiceBroadcastAggregatorProtocol
@@ -302,6 +303,7 @@ class VoiceBroadcastPlaybackViewModel: VoiceBroadcastPlaybackViewModelType, Voic
                     // Init and start the player on the first chunk
                     let audioPlayer = self.mediaServiceProvider.audioPlayerForIdentifier(result.eventIdentifier)
                     audioPlayer.registerDelegate(self)
+                    self.mediaServiceProvider.registerNowPlayingInfoDelegate(self, forPlayer: audioPlayer)
 
                     audioPlayer.loadContentFromURL(result.url, displayName: chunk.attachment.originalFileName)
                     self.audioPlayer = audioPlayer
@@ -470,6 +472,7 @@ extension VoiceBroadcastPlaybackViewModel: VoiceMessageAudioPlayerDelegate {
         state.playbackState = .stopped
         state.playingState.isLive = false
         audioPlayer.deregisterDelegate(self)
+        self.mediaServiceProvider.deregisterNowPlayingInfoDelegate(forPlayer: audioPlayer)
         self.audioPlayer = nil
     }
 
@@ -482,3 +485,34 @@ extension VoiceBroadcastPlaybackViewModel: VoiceMessageAudioPlayerDelegate {
         stopIfVoiceBroadcastOver()
     }
 }
+
+// MARK: - VoiceMessageNowPlayingInfoDelegate
+
+extension VoiceBroadcastPlaybackViewModel: VoiceMessageNowPlayingInfoDelegate {
+
+    func shouldDisconnectFromNowPlayingInfoCenter(audioPlayer player: VoiceMessageAudioPlayer) -> Bool {
+        guard BuildSettings.allowBackgroundAudioMessagePlayback, audioPlayer != nil, audioPlayer === player else {
+            return true
+        }
+
+        return state.broadcastState == .stopped
+    }
+
+    func updateNowPlayingInfoCenter(forPlayer player: VoiceMessageAudioPlayer) {
+        guard audioPlayer != nil, audioPlayer === player else {
+            return
+        }
+
+        let nowPlayingInfoCenter = MPNowPlayingInfoCenter.default()
+        nowPlayingInfoCenter.nowPlayingInfo = [
+            // Title
+            MPMediaItemPropertyTitle: VectorL10n.voiceBroadcastPlaybackLockScreenPlaceholder,
+            // Buffering status (using the "artist" property to display it under the title)
+            MPMediaItemPropertyArtist: state.playbackState == .buffering ? VectorL10n.voiceBroadcastBuffering : "",
+            // Duration
+            MPMediaItemPropertyPlaybackDuration: (state.playingState.duration / 1000.0) as Any,
+            // Elapsed time
+            MPNowPlayingInfoPropertyElapsedPlaybackTime: (state.bindings.progress / 1000.0) as Any,
+        ]
+    }
+}

changelog.d/pr-7257.bugfix

@@ -0,0 +1 @@
+Voice Broadcast: The Now Playing Info Center now displays a voice broadcast instead of a voice message when a user is listening to a voice broadcast.