VoiceBroadcastPlayer - Create player interface and move implementation to dedicated class

Author: Florian Renaud

vector/src/main/java/im/vector/app/core/di/VoiceModule.kt

@@ -18,24 +18,33 @@ package im.vector.app.core.di
 
 import android.content.Context
 import android.os.Build
+import dagger.Binds
 import dagger.Module
 import dagger.Provides
 import dagger.hilt.InstallIn
 import dagger.hilt.components.SingletonComponent
-import im.vector.app.features.voicebroadcast.VoiceBroadcastRecorder
-import im.vector.app.features.voicebroadcast.VoiceBroadcastRecorderQ
+import im.vector.app.features.voicebroadcast.listening.VoiceBroadcastPlayer
+import im.vector.app.features.voicebroadcast.listening.VoiceBroadcastPlayerImpl
+import im.vector.app.features.voicebroadcast.recording.VoiceBroadcastRecorder
+import im.vector.app.features.voicebroadcast.recording.VoiceBroadcastRecorderQ
 import javax.inject.Singleton
 
-@Module
 @InstallIn(SingletonComponent::class)
-object VoiceModule {
-    @Provides
-    @Singleton
-    fun providesVoiceBroadcastRecorder(context: Context): VoiceBroadcastRecorder? {
-        return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
-            VoiceBroadcastRecorderQ(context)
-        } else {
-            null
+@Module
+abstract class VoiceModule {
+
+    companion object {
+        @Provides
+        @Singleton
+        fun providesVoiceBroadcastRecorder(context: Context): VoiceBroadcastRecorder? {
+            return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
+                VoiceBroadcastRecorderQ(context)
+            } else {
+                null
+            }
         }
     }
+
+    @Binds
+    abstract fun bindVoiceBroadcastPlayer(player: VoiceBroadcastPlayerImpl): VoiceBroadcastPlayer
 }

vector/src/main/java/im/vector/app/features/home/HomeActivityViewModel.kt

@@ -42,7 +42,7 @@ import im.vector.app.features.raw.wellknown.isSecureBackupRequired
 import im.vector.app.features.raw.wellknown.withElementWellKnown
 import im.vector.app.features.session.coroutineScope
 import im.vector.app.features.settings.VectorPreferences
-import im.vector.app.features.voicebroadcast.usecase.StopOngoingVoiceBroadcastUseCase
+import im.vector.app.features.voicebroadcast.recording.usecase.StopOngoingVoiceBroadcastUseCase
 import im.vector.lib.core.utils.compat.getParcelableExtraCompat
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.delay

vector/src/main/java/im/vector/app/features/home/room/detail/timeline/factory/VoiceBroadcastItemFactory.kt

@@ -26,11 +26,11 @@ import im.vector.app.features.home.room.detail.timeline.item.MessageVoiceBroadca
 import im.vector.app.features.home.room.detail.timeline.item.MessageVoiceBroadcastListeningItem_
 import im.vector.app.features.home.room.detail.timeline.item.MessageVoiceBroadcastRecordingItem
 import im.vector.app.features.home.room.detail.timeline.item.MessageVoiceBroadcastRecordingItem_
-import im.vector.app.features.voicebroadcast.VoiceBroadcastPlayer
-import im.vector.app.features.voicebroadcast.VoiceBroadcastRecorder
+import im.vector.app.features.voicebroadcast.listening.VoiceBroadcastPlayer
 import im.vector.app.features.voicebroadcast.model.MessageVoiceBroadcastInfoContent
 import im.vector.app.features.voicebroadcast.model.VoiceBroadcastState
 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

vector/src/main/java/im/vector/app/features/home/room/detail/timeline/item/AbsMessageVoiceBroadcastItem.kt

@@ -25,9 +25,9 @@ import im.vector.app.R
 import im.vector.app.core.extensions.tintBackground
 import im.vector.app.core.resources.ColorProvider
 import im.vector.app.core.resources.DrawableProvider
-import im.vector.app.features.voicebroadcast.VoiceBroadcastPlayer
-import im.vector.app.features.voicebroadcast.VoiceBroadcastRecorder
+import im.vector.app.features.voicebroadcast.listening.VoiceBroadcastPlayer
 import im.vector.app.features.voicebroadcast.model.VoiceBroadcastState
+import im.vector.app.features.voicebroadcast.recording.VoiceBroadcastRecorder
 import org.matrix.android.sdk.api.util.MatrixItem
 
 abstract class AbsMessageVoiceBroadcastItem<H : AbsMessageVoiceBroadcastItem.Holder> : AbsMessageItem<H>() {

vector/src/main/java/im/vector/app/features/home/room/detail/timeline/item/MessageVoiceBroadcastListeningItem.kt

@@ -23,7 +23,7 @@ import com.airbnb.epoxy.EpoxyModelClass
 import im.vector.app.R
 import im.vector.app.core.epoxy.onClick
 import im.vector.app.features.home.room.detail.RoomDetailAction
-import im.vector.app.features.voicebroadcast.VoiceBroadcastPlayer
+import im.vector.app.features.voicebroadcast.listening.VoiceBroadcastPlayer
 import im.vector.app.features.voicebroadcast.views.VoiceBroadcastMetadataView
 
 @EpoxyModelClass

vector/src/main/java/im/vector/app/features/home/room/detail/timeline/item/MessageVoiceBroadcastRecordingItem.kt

@@ -22,8 +22,8 @@ import com.airbnb.epoxy.EpoxyModelClass
 import im.vector.app.R
 import im.vector.app.core.epoxy.onClick
 import im.vector.app.features.home.room.detail.RoomDetailAction.VoiceBroadcastAction
-import im.vector.app.features.voicebroadcast.VoiceBroadcastRecorder
 import im.vector.app.features.voicebroadcast.model.VoiceBroadcastState
+import im.vector.app.features.voicebroadcast.recording.VoiceBroadcastRecorder
 import im.vector.app.features.voicebroadcast.views.VoiceBroadcastMetadataView
 
 @EpoxyModelClass

vector/src/main/java/im/vector/app/features/voicebroadcast/VoiceBroadcastHelper.kt

@@ -16,10 +16,11 @@
 
 package im.vector.app.features.voicebroadcast
 
-import im.vector.app.features.voicebroadcast.usecase.PauseVoiceBroadcastUseCase
-import im.vector.app.features.voicebroadcast.usecase.ResumeVoiceBroadcastUseCase
-import im.vector.app.features.voicebroadcast.usecase.StartVoiceBroadcastUseCase
-import im.vector.app.features.voicebroadcast.usecase.StopVoiceBroadcastUseCase
+import im.vector.app.features.voicebroadcast.listening.VoiceBroadcastPlayer
+import im.vector.app.features.voicebroadcast.recording.usecase.PauseVoiceBroadcastUseCase
+import im.vector.app.features.voicebroadcast.recording.usecase.ResumeVoiceBroadcastUseCase
+import im.vector.app.features.voicebroadcast.recording.usecase.StartVoiceBroadcastUseCase
+import im.vector.app.features.voicebroadcast.recording.usecase.StopVoiceBroadcastUseCase
 import javax.inject.Inject
 
 /**

vector/src/main/java/im/vector/app/features/voicebroadcast/listening/VoiceBroadcastPlayer.kt

@@ -0,0 +1,75 @@
+/*
+ * Copyright (c) 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.
+ */
+
+package im.vector.app.features.voicebroadcast.listening
+
+interface VoiceBroadcastPlayer {
+
+    /**
+     * The current playing voice broadcast identifier, if any.
+     */
+    val currentVoiceBroadcastId: String?
+
+    /**
+     * The current playing [State], [State.IDLE] by default.
+     */
+    val playingState: State
+
+    /**
+     * Start playback of the given voice broadcast.
+     */
+    fun playOrResume(roomId: String, voiceBroadcastId: String)
+
+    /**
+     * Pause playback of the current voice broadcast, if any.
+     */
+    fun pause()
+
+    /**
+     * Stop playback of the current voice broadcast, if any, and reset the player state.
+     */
+    fun stop()
+
+    /**
+     * Add a [Listener] to the given voice broadcast id.
+     */
+    fun addListener(voiceBroadcastId: String, listener: Listener)
+
+    /**
+     * Remove a [Listener] from the given voice broadcast id.
+     */
+    fun removeListener(voiceBroadcastId: String, listener: Listener)
+
+    /**
+     * Player states.
+     */
+    enum class State {
+        PLAYING,
+        PAUSED,
+        BUFFERING,
+        IDLE
+    }
+
+    /**
+     * Listener related to [VoiceBroadcastPlayer].
+     */
+    fun interface Listener {
+        /**
+         * Notify about [VoiceBroadcastPlayer.playingState] changes.
+         */
+        fun onStateChanged(state: State)
+    }
+}

vector/src/main/java/im/vector/app/features/voicebroadcast/VoiceBroadcastPlayer.kt renamed to vector/src/main/java/im/vector/app/features/voicebroadcast/listening/VoiceBroadcastPlayerImpl.kt

@@ -14,16 +14,22 @@
  * limitations under the License.
  */
 
-package im.vector.app.features.voicebroadcast
+package im.vector.app.features.voicebroadcast.listening
 
 import android.media.AudioAttributes
 import android.media.MediaPlayer
 import androidx.annotation.MainThread
 import im.vector.app.core.di.ActiveSessionHolder
 import im.vector.app.features.home.room.detail.timeline.helper.AudioMessagePlaybackTracker
 import im.vector.app.features.voice.VoiceFailure
+import im.vector.app.features.voicebroadcast.getVoiceBroadcastChunk
+import im.vector.app.features.voicebroadcast.getVoiceBroadcastEventId
+import im.vector.app.features.voicebroadcast.isVoiceBroadcast
+import im.vector.app.features.voicebroadcast.listening.VoiceBroadcastPlayer.Listener
+import im.vector.app.features.voicebroadcast.listening.VoiceBroadcastPlayer.State
 import im.vector.app.features.voicebroadcast.model.VoiceBroadcastState
 import im.vector.app.features.voicebroadcast.model.asVoiceBroadcastEvent
+import im.vector.app.features.voicebroadcast.sequence
 import im.vector.app.features.voicebroadcast.usecase.GetVoiceBroadcastUseCase
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
@@ -43,14 +49,13 @@ import org.matrix.android.sdk.api.session.room.timeline.TimelineSettings
 import timber.log.Timber
 import java.util.concurrent.CopyOnWriteArrayList
 import javax.inject.Inject
-import javax.inject.Singleton
 
 @Singleton
-class VoiceBroadcastPlayer @Inject constructor(
+class VoiceBroadcastPlayerImpl @Inject constructor(
         private val sessionHolder: ActiveSessionHolder,
         private val playbackTracker: AudioMessagePlaybackTracker,
         private val getVoiceBroadcastUseCase: GetVoiceBroadcastUseCase,
-) {
+) : VoiceBroadcastPlayer {
     private val session
         get() = sessionHolder.getActiveSession()
 
@@ -75,9 +80,9 @@ class VoiceBroadcastPlayer @Inject constructor(
     private var currentSequence: Int? = null
 
     private var playlist = emptyList<MessageAudioEvent>()
-    var currentVoiceBroadcastId: String? = null
+    override var currentVoiceBroadcastId: String? = null
 
-    private var state: State = State.IDLE
+    override var playingState = State.IDLE
         @MainThread
         set(value) {
             Timber.w("## VoiceBroadcastPlayer state: $field -> $value")
@@ -94,22 +99,22 @@ class VoiceBroadcastPlayer @Inject constructor(
      */
     private val listeners: MutableMap<String, CopyOnWriteArrayList<Listener>> = mutableMapOf()
 
-    fun playOrResume(roomId: String, eventId: String) {
-        val hasChanged = currentVoiceBroadcastId != eventId
+    override fun playOrResume(roomId: String, voiceBroadcastId: String) {
+        val hasChanged = currentVoiceBroadcastId != voiceBroadcastId
         when {
-            hasChanged -> startPlayback(roomId, eventId)
-            state == State.PAUSED -> resumePlayback()
+            hasChanged -> startPlayback(roomId, voiceBroadcastId)
+            playingState == State.PAUSED -> resumePlayback()
             else -> Unit
         }
     }
 
-    fun pause() {
+    override fun pause() {
         currentMediaPlayer?.pause()
         currentVoiceBroadcastId?.let { playbackTracker.pausePlayback(it) }
-        state = State.PAUSED
+        playingState = State.PAUSED
     }
 
-    fun stop() {
+    override fun stop() {
         // Stop playback
         currentMediaPlayer?.stop()
         currentVoiceBroadcastId?.let { playbackTracker.stopPlayback(it) }
@@ -131,7 +136,7 @@ class VoiceBroadcastPlayer @Inject constructor(
         timelineListener = null
 
         // Update state
-        state = State.IDLE
+        playingState = State.IDLE
 
         // Clear playlist
         playlist = emptyList()
@@ -143,29 +148,29 @@ class VoiceBroadcastPlayer @Inject constructor(
     /**
      * Add a [Listener] to the given voice broadcast id.
      */
-    fun addListener(voiceBroadcastId: String, listener: Listener) {
+    override fun addListener(voiceBroadcastId: String, listener: Listener) {
         listeners[voiceBroadcastId]?.add(listener) ?: run {
             listeners[voiceBroadcastId] = CopyOnWriteArrayList<Listener>().apply { add(listener) }
         }
-        if (voiceBroadcastId == currentVoiceBroadcastId) listener.onStateChanged(state) else listener.onStateChanged(State.IDLE)
+        if (voiceBroadcastId == currentVoiceBroadcastId) listener.onStateChanged(playingState) else listener.onStateChanged(State.IDLE)
     }
 
     /**
      * Remove a [Listener] from the given voice broadcast id.
      */
-    fun removeListener(voiceBroadcastId: String, listener: Listener) {
+    override fun removeListener(voiceBroadcastId: String, listener: Listener) {
         listeners[voiceBroadcastId]?.remove(listener)
     }
 
     private fun startPlayback(roomId: String, eventId: String) {
         val room = session.getRoom(roomId) ?: error("Unknown roomId: $roomId")
         // Stop listening previous voice broadcast if any
-        if (state != State.IDLE) stop()
+        if (playingState != State.IDLE) stop()
 
         currentRoomId = roomId
         currentVoiceBroadcastId = eventId
 
-        state = State.BUFFERING
+        playingState = State.BUFFERING
 
         val voiceBroadcastState = getVoiceBroadcastUseCase.execute(roomId, eventId)?.content?.voiceBroadcastState
         if (voiceBroadcastState == VoiceBroadcastState.STOPPED) {
@@ -187,7 +192,7 @@ class VoiceBroadcastPlayer @Inject constructor(
                 currentMediaPlayer?.start()
                 currentVoiceBroadcastId?.let { playbackTracker.startPlayback(it) }
                 currentSequence = sequence
-                withContext(Dispatchers.Main) { state = State.PLAYING }
+                withContext(Dispatchers.Main) { playingState = State.PLAYING }
                 nextMediaPlayer = prepareNextMediaPlayer()
             } catch (failure: Throwable) {
                 Timber.e(failure, "Unable to start playback")
@@ -219,7 +224,7 @@ class VoiceBroadcastPlayer @Inject constructor(
     private fun resumePlayback() {
         currentMediaPlayer?.start()
         currentVoiceBroadcastId?.let { playbackTracker.startPlayback(it) }
-        state = State.PLAYING
+        playingState = State.PLAYING
     }
 
     private fun updatePlaylist(playlist: List<MessageAudioEvent>) {
@@ -285,7 +290,7 @@ class VoiceBroadcastPlayer @Inject constructor(
             if (newChunks.isEmpty()) return
             updatePlaylist(playlist + newChunks)
 
-            when (state) {
+            when (playingState) {
                 State.PLAYING -> {
                     if (nextMediaPlayer == null) {
                         coroutineScope.launch { nextMediaPlayer = prepareNextMediaPlayer() }
@@ -330,7 +335,7 @@ class VoiceBroadcastPlayer @Inject constructor(
                 // We'll not receive new chunks anymore so we can stop the live listening
                 stop()
             } else {
-                state = State.BUFFERING
+                playingState = State.BUFFERING
             }
         }
 
@@ -339,15 +344,4 @@ class VoiceBroadcastPlayer @Inject constructor(
             return true
         }
     }
-
-    enum class State {
-        PLAYING,
-        PAUSED,
-        BUFFERING,
-        IDLE
-    }
-
-    fun interface Listener {
-        fun onStateChanged(state: State)
-    }
 }

vector/src/main/java/im/vector/app/features/voicebroadcast/VoiceBroadcastRecorder.kt renamed to vector/src/main/java/im/vector/app/features/voicebroadcast/recording/VoiceBroadcastRecorder.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package im.vector.app.features.voicebroadcast
+package im.vector.app.features.voicebroadcast.recording
 
 import androidx.annotation.IntRange
 import im.vector.app.features.voice.VoiceRecorder