feat: Audio message play in background WPB-11725

app/src/main/AndroidManifest.xml

@@ -43,6 +43,7 @@
     <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MICROPHONE" />
     <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
     <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK" />
 
     <!-- needed to switch between speaker/earpiece -->
     <uses-permission android:name="android.permission.BLUETOOTH" />
@@ -313,6 +314,12 @@
         <receiver
             android:name=".notification.broadcastreceivers.EndOngoingCallReceiver"
             android:exported="false" />
+        <receiver
+                android:name=".notification.broadcastreceivers.PlayPauseAudioMessageReceiver"
+                android:exported="false" />
+        <receiver
+                android:name=".notification.broadcastreceivers.StopAudioMessageReceiver"
+                android:exported="false" />
 
         <service
             android:name=".services.WireFirebaseMessagingService"
@@ -351,6 +358,11 @@
             android:name=".services.CallService"
             android:exported="false"
             android:foregroundServiceType="phoneCall|microphone" />
+
+        <service
+                android:name=".services.PlayingAudioMessageService"
+                android:exported="false"
+                android:foregroundServiceType="mediaPlayback" />
     </application>
 
 </manifest>

app/src/main/kotlin/com/wire/android/di/AppModule.kt

@@ -22,6 +22,7 @@ import android.app.NotificationManager
 import android.content.Context
 import android.location.Geocoder
 import android.media.AudioAttributes
+import android.media.AudioManager
 import android.media.MediaPlayer
 import androidx.core.app.NotificationManagerCompat
 import com.wire.android.BuildConfig
@@ -48,6 +49,7 @@ annotation class CurrentAppVersion
 
 @Module
 @InstallIn(SingletonComponent::class)
+@Suppress("TooManyFunctions")
 object AppModule {
 
     @CurrentAppVersion
@@ -104,4 +106,8 @@ object AppModule {
 
     @Provides
     fun provideAnonymousAnalyticsManager(): AnonymousAnalyticsManager = AnonymousAnalyticsManagerImpl
+
+    @Provides
+    fun provideAudioManager(@ApplicationContext context: Context): AudioManager =
+        context.getSystemService(Context.AUDIO_SERVICE) as AudioManager
 }

app/src/main/kotlin/com/wire/android/mapper/ConversationMapper.kt

@@ -17,6 +17,8 @@
  */
 package com.wire.android.mapper
 
+import com.wire.android.media.audiomessage.AudioMediaPlayingState
+import com.wire.android.media.audiomessage.PlayingAudioMessage
 import com.wire.android.model.ImageAsset.UserAvatarAsset
 import com.wire.android.model.NameBasedAvatar
 import com.wire.android.model.UserAvatarData
@@ -25,7 +27,9 @@ import com.wire.android.ui.home.conversationslist.model.BadgeEventType
 import com.wire.android.ui.home.conversationslist.model.BlockState
 import com.wire.android.ui.home.conversationslist.model.ConversationInfo
 import com.wire.android.ui.home.conversationslist.model.ConversationItem
+import com.wire.android.ui.home.conversationslist.model.PlayingAudioInConversation
 import com.wire.android.ui.home.conversationslist.showLegalHoldIndicator
+import com.wire.kalium.logic.data.conversation.ConversationDetails
 import com.wire.kalium.logic.data.conversation.ConversationDetails.Connection
 import com.wire.kalium.logic.data.conversation.ConversationDetails.Group
 import com.wire.kalium.logic.data.conversation.ConversationDetails.OneOne
@@ -42,7 +46,8 @@ import com.wire.kalium.logic.data.user.UserAvailabilityStatus
 fun ConversationDetailsWithEvents.toConversationItem(
     userTypeMapper: UserTypeMapper,
     searchQuery: String,
-    selfUserTeamId: TeamId?
+    selfUserTeamId: TeamId?,
+    playingAudioMessage: PlayingAudioMessage
 ): ConversationItem = when (val conversationDetails = this.conversationDetails) {
     is Group -> {
         ConversationItem.GroupConversation(
@@ -66,7 +71,8 @@ fun ConversationDetailsWithEvents.toConversationItem(
             hasNewActivitiesToShow = hasNewActivitiesToShow,
             searchQuery = searchQuery,
             isFavorite = conversationDetails.isFavorite,
-            folder = conversationDetails.folder
+            folder = conversationDetails.folder,
+            playingAudio = getPlayingAudioInConversation(playingAudioMessage, conversationDetails)
         )
     }
 
@@ -105,7 +111,8 @@ fun ConversationDetailsWithEvents.toConversationItem(
             hasNewActivitiesToShow = hasNewActivitiesToShow,
             searchQuery = searchQuery,
             isFavorite = conversationDetails.isFavorite,
-            folder = conversationDetails.folder
+            folder = conversationDetails.folder,
+            playingAudio = getPlayingAudioInConversation(playingAudioMessage, conversationDetails)
         )
     }
 
@@ -142,6 +149,25 @@ fun ConversationDetailsWithEvents.toConversationItem(
     }
 }
 
+private fun getPlayingAudioInConversation(
+    playingAudioMessage: PlayingAudioMessage,
+    conversationDetails: ConversationDetails
+): PlayingAudioInConversation? =
+    if (playingAudioMessage is PlayingAudioMessage.Some
+        && playingAudioMessage.conversationId == conversationDetails.conversation.id
+    ) {
+        if (playingAudioMessage.state.isPlaying()) {
+            PlayingAudioInConversation(playingAudioMessage.messageId, false)
+        } else if (playingAudioMessage.state.audioMediaPlayingState is AudioMediaPlayingState.Paused) {
+            PlayingAudioInConversation(playingAudioMessage.messageId, true)
+        } else {
+            // states Fetching, Completed, Stopped, etc. should not be shown in ConversationItem
+            null
+        }
+    } else {
+        null
+    }
+
 private fun parseConnectionEventType(connectionState: ConnectionState) =
     if (connectionState == ConnectionState.SENT) {
         BadgeEventType.SentConnectRequest

app/src/main/kotlin/com/wire/android/media/audiomessage/AudioFocusHelper.kt

@@ -0,0 +1,90 @@
+/*
+ * Wire
+ * Copyright (C) 2025 Wire Swiss GmbH
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
+ */
+package com.wire.android.media.audiomessage
+
+import android.media.AudioFocusRequest
+import android.media.AudioManager
+import android.os.Build
+import javax.inject.Inject
+
+class AudioFocusHelper @Inject constructor(private val audioManager: AudioManager) {
+
+    private var listener: PlayPauseListener? = null
+
+    private val onAudioFocusChangeListener by lazy {
+        AudioManager.OnAudioFocusChangeListener { focusChange ->
+            when (focusChange) {
+                AudioManager.AUDIOFOCUS_LOSS -> {
+                    listener?.onPauseCurrentAudio()
+                }
+
+                AudioManager.AUDIOFOCUS_LOSS_TRANSIENT -> {
+                    listener?.onPauseCurrentAudio()
+                }
+
+                AudioManager.AUDIOFOCUS_GAIN -> {
+                    listener?.onResumeCurrentAudio()
+                }
+
+                AudioManager.AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK -> {
+                    listener?.onPauseCurrentAudio()
+                }
+            }
+        }
+    }
+
+    private val focusRequest by lazy {
+        AudioFocusRequest.Builder(AudioManager.AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK)
+            .setOnAudioFocusChangeListener(onAudioFocusChangeListener)
+            .apply {
+                if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) setForceDucking(true)
+            }.build()
+    }
+
+    /**
+     * Requests the audio focus.
+     * @return true in case if focus was granted (AudioMessage can be played), false - otherwise
+     */
+    fun request(): Boolean {
+        return audioManager.requestAudioFocus(focusRequest) != AudioManager.AUDIOFOCUS_REQUEST_FAILED
+    }
+
+    /**
+     * Abandon the audio focus.
+     */
+    fun abandon() {
+        audioManager.abandonAudioFocusRequest(focusRequest)
+    }
+
+    fun setListener(onPauseCurrentAudio: () -> Unit, onResumeCurrentAudio: () -> Unit) {
+        listener = object : PlayPauseListener {
+            override fun onPauseCurrentAudio() {
+                onPauseCurrentAudio()
+            }
+
+            override fun onResumeCurrentAudio() {
+                onResumeCurrentAudio()
+            }
+        }
+    }
+
+    interface PlayPauseListener {
+        fun onPauseCurrentAudio()
+        fun onResumeCurrentAudio()
+    }
+}

app/src/main/kotlin/com/wire/android/media/audiomessage/AudioState.kt

@@ -19,6 +19,14 @@ package com.wire.android.media.audiomessage
 
 import androidx.annotation.StringRes
 import com.wire.android.R
+import com.wire.android.media.audiomessage.ConversationAudioMessagePlayer.MessageIdWrapper
+import com.wire.android.util.ui.UIText
+import com.wire.kalium.logic.data.id.ConversationId
+
+data class AudioMessagesData(
+    val statesHistory: Map<MessageIdWrapper, AudioState>,
+    val playingMessage: PlayingAudioMessage
+)
 
 data class AudioState(
     val audioMediaPlayingState: AudioMediaPlayingState,
@@ -40,13 +48,43 @@ data class AudioState(
         return totalTimeInMs
     }
 
+    fun isPlaying() = audioMediaPlayingState is AudioMediaPlayingState.Playing
+    fun isPlayingOrPaused() = audioMediaPlayingState is AudioMediaPlayingState.Playing
+            || audioMediaPlayingState is AudioMediaPlayingState.Paused
+
+    fun isPlayingOrPausedOrFetching() = audioMediaPlayingState is AudioMediaPlayingState.Playing
+            || audioMediaPlayingState is AudioMediaPlayingState.Paused
+            || audioMediaPlayingState is AudioMediaPlayingState.Fetching
+            || audioMediaPlayingState is AudioMediaPlayingState.SuccessfulFetching
+
     sealed class TotalTimeInMs {
         object NotKnown : TotalTimeInMs()
 
         data class Known(val value: Int) : TotalTimeInMs()
     }
 }
 
+sealed class PlayingAudioMessage {
+    data object None : PlayingAudioMessage()
+    data class Some(
+        val conversationId: ConversationId,
+        val messageId: String,
+        val authorName: UIText,
+        val state: AudioState
+    ) : PlayingAudioMessage()
+
+    fun isSameAs(that: PlayingAudioMessage): Boolean {
+        val isTypeSame = (this is Some && that is Some)
+                || (this is None && that is None)
+
+        val isMessageSame = this is Some && that is Some
+                && this.messageId == that.messageId
+                && this.state.isPlaying() == that.state.isPlaying()
+
+        return isTypeSame && isMessageSame
+    }
+}
+
 @Suppress("MagicNumber")
 enum class AudioSpeed(val value: Float, @StringRes val titleRes: Int) {
     NORMAL(1f, R.string.audio_speed_1),
@@ -84,27 +122,32 @@ sealed class AudioMediaPlayingState {
 }
 
 sealed class AudioMediaPlayerStateUpdate(
+    open val conversationId: ConversationId,
     open val messageId: String
 ) {
     data class AudioMediaPlayingStateUpdate(
+        override val conversationId: ConversationId,
         override val messageId: String,
         val audioMediaPlayingState: AudioMediaPlayingState
-    ) : AudioMediaPlayerStateUpdate(messageId)
+    ) : AudioMediaPlayerStateUpdate(conversationId, messageId)
 
     data class PositionChangeUpdate(
+        override val conversationId: ConversationId,
         override val messageId: String,
         val position: Int
-    ) : AudioMediaPlayerStateUpdate(messageId)
+    ) : AudioMediaPlayerStateUpdate(conversationId, messageId)
 
     data class TotalTimeUpdate(
+        override val conversationId: ConversationId,
         override val messageId: String,
         val totalTimeInMs: Int
-    ) : AudioMediaPlayerStateUpdate(messageId)
+    ) : AudioMediaPlayerStateUpdate(conversationId, messageId)
 
     data class WaveMaskUpdate(
+        override val conversationId: ConversationId,
         override val messageId: String,
         val waveMask: List<Int>
-    ) : AudioMediaPlayerStateUpdate(messageId)
+    ) : AudioMediaPlayerStateUpdate(conversationId, messageId)
 }
 
 sealed class RecordAudioMediaPlayerStateUpdate {