Merge pull request #7919 from vector-im/bugfix/fre/handle_vb_playback_crash

Florian14 · web-flow · commit 31e599f2e2d6 · 2023-01-13T18:29:28.000+01:00
Voice Broadcast - Handle exceptions during playback
diff --git a/changelog.d/7829.bugfix b/changelog.d/7829.bugfix
@@ -0,0 +1 @@
+Handle exceptions when listening a voice broadcast
diff --git a/library/ui-strings/src/main/res/values/strings.xml b/library/ui-strings/src/main/res/values/strings.xml
@@ -3122,6 +3122,7 @@
     <string name="error_voice_broadcast_permission_denied_message">You don’t have the required permissions to start a voice broadcast in this room. Contact a room administrator to upgrade your permissions.</string>
     <string name="error_voice_broadcast_blocked_by_someone_else_message">Someone else is already recording a voice broadcast. Wait for their voice broadcast to end to start a new one.</string>
     <string name="error_voice_broadcast_already_in_progress_message">You are already recording a voice broadcast. Please end your current voice broadcast to start a new one.</string>
+    <string name="error_voice_broadcast_unable_to_play">Unable to play this voice broadcast.</string>
     <!-- Examples of usage: 6h 15min 30sec left / 15min 30sec left / 30sec left -->
     <string name="voice_broadcast_recording_time_left">%1$s left</string>
     <string name="stop_voice_broadcast_dialog_title">Stop live broadcasting?</string>
diff --git a/vector/src/main/java/im/vector/app/core/error/ErrorFormatter.kt b/vector/src/main/java/im/vector/app/core/error/ErrorFormatter.kt
@@ -157,6 +157,8 @@ class DefaultErrorFormatter @Inject constructor(
             RecordingError.BlockedBySomeoneElse -> stringProvider.getString(R.string.error_voice_broadcast_blocked_by_someone_else_message)
             RecordingError.NoPermission -> stringProvider.getString(R.string.error_voice_broadcast_permission_denied_message)
             RecordingError.UserAlreadyBroadcasting -> stringProvider.getString(R.string.error_voice_broadcast_already_in_progress_message)
+            is VoiceBroadcastFailure.ListeningError.UnableToPlay,
+            is VoiceBroadcastFailure.ListeningError.DownloadError -> stringProvider.getString(R.string.error_voice_broadcast_unable_to_play)
         }
     }
 
diff --git a/vector/src/main/java/im/vector/app/features/home/room/detail/composer/voice/VoiceMessageRecorderView.kt b/vector/src/main/java/im/vector/app/features/home/room/detail/composer/voice/VoiceMessageRecorderView.kt
@@ -229,6 +229,7 @@ class VoiceMessageRecorderView @JvmOverloads constructor(
                 voiceMessageViews.renderPlaying(state)
             }
             is AudioMessagePlaybackTracker.Listener.State.Paused,
+            is AudioMessagePlaybackTracker.Listener.State.Error,
             is AudioMessagePlaybackTracker.Listener.State.Idle -> {
                 voiceMessageViews.renderIdle()
             }
diff --git a/vector/src/main/java/im/vector/app/features/home/room/detail/timeline/factory/VoiceBroadcastItemFactory.kt b/vector/src/main/java/im/vector/app/features/home/room/detail/timeline/factory/VoiceBroadcastItemFactory.kt
@@ -15,9 +15,9 @@
  */
 package im.vector.app.features.home.room.detail.timeline.factory
 
+import im.vector.app.core.error.ErrorFormatter
 import im.vector.app.core.resources.ColorProvider
 import im.vector.app.core.resources.DrawableProvider
-import im.vector.app.features.displayname.getBestName
 import im.vector.app.features.home.room.detail.timeline.helper.AudioMessagePlaybackTracker
 import im.vector.app.features.home.room.detail.timeline.helper.AvatarSizeProvider
 import im.vector.app.features.home.room.detail.timeline.helper.VoiceBroadcastEventsGroup
@@ -36,7 +36,6 @@ import im.vector.app.features.voicebroadcast.model.asVoiceBroadcastEvent
 import im.vector.app.features.voicebroadcast.recording.VoiceBroadcastRecorder
 import org.matrix.android.sdk.api.session.Session
 import org.matrix.android.sdk.api.session.getRoom
-import org.matrix.android.sdk.api.session.getUserOrDefault
 import org.matrix.android.sdk.api.util.toMatrixItem
 import javax.inject.Inject
 
@@ -45,6 +44,7 @@ class VoiceBroadcastItemFactory @Inject constructor(
         private val avatarSizeProvider: AvatarSizeProvider,
         private val colorProvider: ColorProvider,
         private val drawableProvider: DrawableProvider,
+        private val errorFormatter: ErrorFormatter,
         private val voiceBroadcastRecorder: VoiceBroadcastRecorder?,
         private val voiceBroadcastPlayer: VoiceBroadcastPlayer,
         private val playbackTracker: AudioMessagePlaybackTracker,
@@ -75,13 +75,14 @@ class VoiceBroadcastItemFactory @Inject constructor(
                 voiceBroadcast = voiceBroadcast,
                 voiceBroadcastState = voiceBroadcastContent.voiceBroadcastState,
                 duration = voiceBroadcastEventsGroup.getDuration(),
-                recorderName = params.event.root.stateKey?.let { session.getUserOrDefault(it) }?.toMatrixItem()?.getBestName().orEmpty(),
+                recorderName = params.event.senderInfo.disambiguatedDisplayName,
                 recorder = voiceBroadcastRecorder,
                 player = voiceBroadcastPlayer,
                 playbackTracker = playbackTracker,
                 roomItem = session.getRoom(params.event.roomId)?.roomSummary()?.toMatrixItem(),
                 colorProvider = colorProvider,
                 drawableProvider = drawableProvider,
+                errorFormatter = errorFormatter,
         )
 
         return if (isRecording) {
diff --git a/vector/src/main/java/im/vector/app/features/home/room/detail/timeline/helper/AudioMessagePlaybackTracker.kt b/vector/src/main/java/im/vector/app/features/home/room/detail/timeline/helper/AudioMessagePlaybackTracker.kt
@@ -50,8 +50,11 @@ class AudioMessagePlaybackTracker @Inject constructor() {
         listeners.remove(id)
     }
 
-    fun pauseAllPlaybacks() {
-        listeners.keys.forEach(::pausePlayback)
+    fun unregisterListeners() {
+        listeners.forEach {
+            it.value.onUpdate(Listener.State.Idle)
+        }
+        listeners.clear()
     }
 
     /**
@@ -84,6 +87,10 @@ class AudioMessagePlaybackTracker @Inject constructor() {
                 }
     }
 
+    fun pauseAllPlaybacks() {
+        listeners.keys.forEach(::pausePlayback)
+    }
+
     fun pausePlayback(id: String) {
         val state = getPlaybackState(id)
         if (state is Listener.State.Playing) {
@@ -94,7 +101,14 @@ class AudioMessagePlaybackTracker @Inject constructor() {
     }
 
     fun stopPlayback(id: String) {
-        setState(id, Listener.State.Idle)
+        val state = getPlaybackState(id)
+        if (state !is Listener.State.Error) {
+            setState(id, Listener.State.Idle)
+        }
+    }
+
+    fun onError(id: String, error: Throwable) {
+        setState(id, Listener.State.Error(error))
     }
 
     fun updatePlayingAtPlaybackTime(id: String, time: Int, percentage: Float) {
@@ -116,6 +130,7 @@ class AudioMessagePlaybackTracker @Inject constructor() {
             is Listener.State.Playing -> state.playbackTime
             is Listener.State.Paused -> state.playbackTime
             is Listener.State.Recording,
+            is Listener.State.Error,
             Listener.State.Idle,
             null -> null
         }
@@ -126,18 +141,12 @@ class AudioMessagePlaybackTracker @Inject constructor() {
             is Listener.State.Playing -> state.percentage
             is Listener.State.Paused -> state.percentage
             is Listener.State.Recording,
+            is Listener.State.Error,
             Listener.State.Idle,
             null -> null
         }
     }
 
-    fun unregisterListeners() {
-        listeners.forEach {
-            it.value.onUpdate(Listener.State.Idle)
-        }
-        listeners.clear()
-    }
-
     companion object {
         const val RECORDING_ID = "RECORDING_ID"
     }
@@ -148,6 +157,7 @@ class AudioMessagePlaybackTracker @Inject constructor() {
 
         sealed class State {
             object Idle : State()
+            data class Error(val failure: Throwable) : State()
             data class Playing(val playbackTime: Int, val percentage: Float) : State()
             data class Paused(val playbackTime: Int, val percentage: Float) : State()
             data class Recording(val amplitudeList: List<Int>) : State()
diff --git a/vector/src/main/java/im/vector/app/features/home/room/detail/timeline/item/AbsMessageVoiceBroadcastItem.kt b/vector/src/main/java/im/vector/app/features/home/room/detail/timeline/item/AbsMessageVoiceBroadcastItem.kt
@@ -22,6 +22,7 @@ import androidx.annotation.IdRes
 import androidx.core.view.isVisible
 import com.airbnb.epoxy.EpoxyAttribute
 import im.vector.app.R
+import im.vector.app.core.error.ErrorFormatter
 import im.vector.app.core.extensions.tintBackground
 import im.vector.app.core.resources.ColorProvider
 import im.vector.app.core.resources.DrawableProvider
@@ -48,6 +49,7 @@ abstract class AbsMessageVoiceBroadcastItem<H : AbsMessageVoiceBroadcastItem.Hol
     protected val colorProvider get() = voiceBroadcastAttributes.colorProvider
     protected val drawableProvider get() = voiceBroadcastAttributes.drawableProvider
     protected val avatarRenderer get() = attributes.avatarRenderer
+    protected val errorFormatter get() = voiceBroadcastAttributes.errorFormatter
     protected val callback get() = attributes.callback
 
     override fun isCacheable(): Boolean = false
@@ -107,5 +109,6 @@ abstract class AbsMessageVoiceBroadcastItem<H : AbsMessageVoiceBroadcastItem.Hol
             val roomItem: MatrixItem?,
             val colorProvider: ColorProvider,
             val drawableProvider: DrawableProvider,
+            val errorFormatter: ErrorFormatter,
     )
 }
diff --git a/vector/src/main/java/im/vector/app/features/home/room/detail/timeline/item/MessageAudioItem.kt b/vector/src/main/java/im/vector/app/features/home/room/detail/timeline/item/MessageAudioItem.kt
@@ -142,6 +142,7 @@ abstract class MessageAudioItem : AbsMessageItem<MessageAudioItem.Holder>() {
     private fun renderStateBasedOnAudioPlayback(holder: Holder) {
         audioMessagePlaybackTracker.track(attributes.informationData.eventId) { state ->
             when (state) {
+                is AudioMessagePlaybackTracker.Listener.State.Error,
                 is AudioMessagePlaybackTracker.Listener.State.Idle -> renderIdleState(holder)
                 is AudioMessagePlaybackTracker.Listener.State.Playing -> renderPlayingState(holder, state)
                 is AudioMessagePlaybackTracker.Listener.State.Paused -> renderPausedState(holder, state)
diff --git a/vector/src/main/java/im/vector/app/features/home/room/detail/timeline/item/MessageVoiceBroadcastListeningItem.kt b/vector/src/main/java/im/vector/app/features/home/room/detail/timeline/item/MessageVoiceBroadcastListeningItem.kt
@@ -20,11 +20,13 @@ import android.text.format.DateUtils
 import android.widget.ImageButton
 import android.widget.SeekBar
 import android.widget.TextView
+import androidx.constraintlayout.widget.Group
 import androidx.core.view.isInvisible
 import androidx.core.view.isVisible
 import com.airbnb.epoxy.EpoxyModelClass
 import im.vector.app.R
 import im.vector.app.core.epoxy.onClick
+import im.vector.app.core.extensions.setTextOrHide
 import im.vector.app.features.home.room.detail.RoomDetailAction.VoiceBroadcastAction
 import im.vector.app.features.home.room.detail.timeline.helper.AudioMessagePlaybackTracker.Listener.State
 import im.vector.app.features.voicebroadcast.listening.VoiceBroadcastPlayer
@@ -54,6 +56,16 @@ abstract class MessageVoiceBroadcastListeningItem : AbsMessageVoiceBroadcastItem
             }
         }
         player.addListener(voiceBroadcast, playerListener)
+
+        playbackTracker.track(voiceBroadcast.voiceBroadcastId) { playbackState ->
+            renderBackwardForwardButtons(holder, playbackState)
+            renderPlaybackError(holder, playbackState)
+            renderLiveIndicator(holder)
+            if (!isUserSeeking) {
+                holder.seekBar.progress = playbackTracker.getPlaybackTime(voiceBroadcast.voiceBroadcastId) ?: 0
+            }
+        }
+
         bindSeekBar(holder)
         bindButtons(holder)
     }
@@ -63,10 +75,11 @@ abstract class MessageVoiceBroadcastListeningItem : AbsMessageVoiceBroadcastItem
             playPauseButton.setOnClickListener {
                 if (player.currentVoiceBroadcast == voiceBroadcast) {
                     when (player.playingState) {
-                        VoiceBroadcastPlayer.State.PLAYING,
-                        VoiceBroadcastPlayer.State.BUFFERING -> callback?.onTimelineItemAction(VoiceBroadcastAction.Listening.Pause)
-                        VoiceBroadcastPlayer.State.PAUSED,
-                        VoiceBroadcastPlayer.State.IDLE -> callback?.onTimelineItemAction(VoiceBroadcastAction.Listening.PlayOrResume(voiceBroadcast))
+                        VoiceBroadcastPlayer.State.Playing,
+                        VoiceBroadcastPlayer.State.Buffering -> callback?.onTimelineItemAction(VoiceBroadcastAction.Listening.Pause)
+                        VoiceBroadcastPlayer.State.Paused,
+                        is VoiceBroadcastPlayer.State.Error,
+                        VoiceBroadcastPlayer.State.Idle -> callback?.onTimelineItemAction(VoiceBroadcastAction.Listening.PlayOrResume(voiceBroadcast))
                     }
                 } else {
                     callback?.onTimelineItemAction(VoiceBroadcastAction.Listening.PlayOrResume(voiceBroadcast))
@@ -100,17 +113,18 @@ abstract class MessageVoiceBroadcastListeningItem : AbsMessageVoiceBroadcastItem
 
     private fun renderPlayingState(holder: Holder, state: VoiceBroadcastPlayer.State) {
         with(holder) {
-            bufferingView.isVisible = state == VoiceBroadcastPlayer.State.BUFFERING
-            voiceBroadcastMetadata.isVisible = state != VoiceBroadcastPlayer.State.BUFFERING
+            bufferingView.isVisible = state == VoiceBroadcastPlayer.State.Buffering
+            voiceBroadcastMetadata.isVisible = state != VoiceBroadcastPlayer.State.Buffering
 
             when (state) {
-                VoiceBroadcastPlayer.State.PLAYING,
-                VoiceBroadcastPlayer.State.BUFFERING -> {
+                VoiceBroadcastPlayer.State.Playing,
+                VoiceBroadcastPlayer.State.Buffering -> {
                     playPauseButton.setImageResource(R.drawable.ic_play_pause_pause)
                     playPauseButton.contentDescription = view.resources.getString(R.string.a11y_pause_voice_broadcast)
                 }
-                VoiceBroadcastPlayer.State.IDLE,
-                VoiceBroadcastPlayer.State.PAUSED -> {
+                is VoiceBroadcastPlayer.State.Error,
+                VoiceBroadcastPlayer.State.Idle,
+                VoiceBroadcastPlayer.State.Paused -> {
                     playPauseButton.setImageResource(R.drawable.ic_play_pause_play)
                     playPauseButton.contentDescription = view.resources.getString(R.string.a11y_play_voice_broadcast)
                 }
@@ -120,6 +134,18 @@ abstract class MessageVoiceBroadcastListeningItem : AbsMessageVoiceBroadcastItem
         }
     }
 
+    private fun renderPlaybackError(holder: Holder, playbackState: State) {
+        with(holder) {
+            if (playbackState is State.Error) {
+                controlsGroup.isVisible = false
+                errorView.setTextOrHide(errorFormatter.toHumanReadable(playbackState.failure))
+            } else {
+                errorView.isVisible = false
+                controlsGroup.isVisible = true
+            }
+        }
+    }
+
     private fun bindSeekBar(holder: Holder) {
         with(holder) {
             remainingTimeView.text = formatRemainingTime(duration)
@@ -141,13 +167,6 @@ abstract class MessageVoiceBroadcastListeningItem : AbsMessageVoiceBroadcastItem
                 }
             })
         }
-        playbackTracker.track(voiceBroadcast.voiceBroadcastId) { playbackState ->
-            renderBackwardForwardButtons(holder, playbackState)
-            renderLiveIndicator(holder)
-            if (!isUserSeeking) {
-                holder.seekBar.progress = playbackTracker.getPlaybackTime(voiceBroadcast.voiceBroadcastId) ?: 0
-            }
-        }
     }
 
     private fun renderBackwardForwardButtons(holder: Holder, playbackState: State) {
@@ -187,6 +206,8 @@ abstract class MessageVoiceBroadcastListeningItem : AbsMessageVoiceBroadcastItem
         val broadcasterNameMetadata by bind<VoiceBroadcastMetadataView>(R.id.broadcasterNameMetadata)
         val voiceBroadcastMetadata by bind<VoiceBroadcastMetadataView>(R.id.voiceBroadcastMetadata)
         val listenersCountMetadata by bind<VoiceBroadcastMetadataView>(R.id.listenersCountMetadata)
+        val errorView by bind<TextView>(R.id.errorView)
+        val controlsGroup by bind<Group>(R.id.controlsGroup)
     }
 
     companion object {
diff --git a/vector/src/main/java/im/vector/app/features/home/room/detail/timeline/item/MessageVoiceItem.kt b/vector/src/main/java/im/vector/app/features/home/room/detail/timeline/item/MessageVoiceItem.kt
@@ -124,6 +124,7 @@ abstract class MessageVoiceItem : AbsMessageItem<MessageVoiceItem.Holder>() {
 
         audioMessagePlaybackTracker.track(attributes.informationData.eventId) { state ->
             when (state) {
+                is AudioMessagePlaybackTracker.Listener.State.Error,
                 is AudioMessagePlaybackTracker.Listener.State.Idle -> renderIdleState(holder, waveformColorIdle, waveformColorPlayed)
                 is AudioMessagePlaybackTracker.Listener.State.Playing -> renderPlayingState(holder, state, waveformColorIdle, waveformColorPlayed)
                 is AudioMessagePlaybackTracker.Listener.State.Paused -> renderPausedState(holder, state, waveformColorIdle, waveformColorPlayed)
diff --git a/vector/src/main/java/im/vector/app/features/voicebroadcast/VoiceBroadcastFailure.kt b/vector/src/main/java/im/vector/app/features/voicebroadcast/VoiceBroadcastFailure.kt
@@ -16,10 +16,21 @@
 
 package im.vector.app.features.voicebroadcast
 
+import android.media.MediaPlayer
+
 sealed class VoiceBroadcastFailure : Throwable() {
     sealed class RecordingError : VoiceBroadcastFailure() {
         object NoPermission : RecordingError()
         object BlockedBySomeoneElse : RecordingError()
         object UserAlreadyBroadcasting : RecordingError()
     }
+
+    sealed class ListeningError : VoiceBroadcastFailure() {
+        /**
+         * @property what the type of error that has occurred, see [MediaPlayer.OnErrorListener.onError].
+         * @property extra an extra code, specific to the error, see [MediaPlayer.OnErrorListener.onError].
+         */
+        data class UnableToPlay(val what: Int, val extra: Int) : ListeningError()
+        data class DownloadError(override val cause: Throwable?) : ListeningError()
+    }
 }
diff --git a/vector/src/main/java/im/vector/app/features/voicebroadcast/listening/VoiceBroadcastPlayer.kt b/vector/src/main/java/im/vector/app/features/voicebroadcast/listening/VoiceBroadcastPlayer.kt
@@ -16,6 +16,7 @@
 
 package im.vector.app.features.voicebroadcast.listening
 
+import im.vector.app.features.voicebroadcast.VoiceBroadcastFailure
 import im.vector.app.features.voicebroadcast.model.VoiceBroadcast
 
 interface VoiceBroadcastPlayer {
@@ -26,7 +27,7 @@ interface VoiceBroadcastPlayer {
     val currentVoiceBroadcast: VoiceBroadcast?
 
     /**
-     * The current playing [State], [State.IDLE] by default.
+     * The current playing [State], [State.Idle] by default.
      */
     val playingState: State
 
@@ -68,11 +69,12 @@ interface VoiceBroadcastPlayer {
     /**
      * Player states.
      */
-    enum class State {
-        PLAYING,
-        PAUSED,
-        BUFFERING,
-        IDLE
+    sealed interface State {
+        object Playing : State
+        object Paused : State
+        object Buffering : State
+        data class Error(val failure: VoiceBroadcastFailure.ListeningError) : State
+        object Idle : State
     }
 
     /**
diff --git a/vector/src/main/java/im/vector/app/features/voicebroadcast/listening/VoiceBroadcastPlayerImpl.kt b/vector/src/main/java/im/vector/app/features/voicebroadcast/listening/VoiceBroadcastPlayerImpl.kt
diff --git a/vector/src/main/res/drawable/ic_voice_broadcast_error.xml b/vector/src/main/res/drawable/ic_voice_broadcast_error.xml
diff --git a/vector/src/main/res/layout/item_timeline_event_voice_broadcast_listening_stub.xml b/vector/src/main/res/layout/item_timeline_event_voice_broadcast_listening_stub.xml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Handle exceptions when listening a voice broadcast`
Original file line number	Diff line number	Diff line change
`@@ -157,6 +157,8 @@ class DefaultErrorFormatter @Inject constructor(`
`157`	`157`	`RecordingError.BlockedBySomeoneElse -> stringProvider.getString(R.string.error_voice_broadcast_blocked_by_someone_else_message)`
`158`	`158`	`RecordingError.NoPermission -> stringProvider.getString(R.string.error_voice_broadcast_permission_denied_message)`
`159`	`159`	`RecordingError.UserAlreadyBroadcasting -> stringProvider.getString(R.string.error_voice_broadcast_already_in_progress_message)`
	`160`	`+ is VoiceBroadcastFailure.ListeningError.UnableToPlay,`
	`161`	`+ is VoiceBroadcastFailure.ListeningError.DownloadError -> stringProvider.getString(R.string.error_voice_broadcast_unable_to_play)`
`160`	`162`	`}`
`161`	`163`	`}`
`162`	`164`
Original file line number	Diff line number	Diff line change
`@@ -229,6 +229,7 @@ class VoiceMessageRecorderView @JvmOverloads constructor(`
`229`	`229`	`voiceMessageViews.renderPlaying(state)`
`230`	`230`	`}`
`231`	`231`	`is AudioMessagePlaybackTracker.Listener.State.Paused,`
	`232`	`+ is AudioMessagePlaybackTracker.Listener.State.Error,`
`232`	`233`	`is AudioMessagePlaybackTracker.Listener.State.Idle -> {`
`233`	`234`	`voiceMessageViews.renderIdle()`
`234`	`235`	`}`