Add background audio playback for voice messages

CHANGELOG-upstream.md

@@ -15,6 +15,7 @@
 * Add indication for blocked contacts in user profile
 * Allow to start calls with video disabled
 * Show hint for empty contact search results
+* Add background playing for voice messages and other audio files
 * Fix: Show dialog if pasted QR codes are invalid
 * Fix: Refresh chat list when returning from conversation if selected profile changed
 * Fix: Update menu when using "select all" in contact selection

build.gradle

@@ -68,6 +68,7 @@ android {
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_1_8
         targetCompatibility JavaVersion.VERSION_1_8
+        coreLibraryDesugaringEnabled true
     }
     packagingOptions {
         jniLibs {
@@ -211,6 +212,10 @@ dependencies {
     implementation "io.noties.markwon:inline-parser:$markwon_version"
     implementation 'com.airbnb.android:lottie:4.2.2' // Lottie animations support.
 
+    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:2.1.5'
+
+    def media3_version = "1.8.0"   // 1.9.0 need minSdkVersion 23
+
     implementation 'androidx.concurrent:concurrent-futures:1.3.0'
     implementation 'androidx.sharetarget:sharetarget:1.2.0'
     implementation 'androidx.webkit:webkit:1.14.0'
@@ -231,8 +236,11 @@ dependencies {
     implementation 'androidx.work:work-runtime:2.9.1'
     implementation 'androidx.emoji2:emoji2-emojipicker:1.5.0'
     implementation 'com.google.guava:guava:31.1-android'
-    implementation 'com.google.android.exoplayer:exoplayer-core:2.19.1' // plays video and audio
+    implementation 'com.google.android.exoplayer:exoplayer-core:2.19.1' // FIXME: exoplayer dependencies kept for Video, but we shall migrate them at some point
     implementation 'com.google.android.exoplayer:exoplayer-ui:2.19.1'
+    implementation "androidx.media3:media3-exoplayer:$media3_version"
+    implementation "androidx.media3:media3-session:$media3_version"
+    implementation "androidx.media3:media3-ui:$media3_version"
     implementation 'androidx.constraintlayout:constraintlayout:2.2.0'
     implementation 'com.google.zxing:core:3.3.0' // fixed version to support SDK<24
     implementation ('com.journeyapps:zxing-android-embedded:4.3.0') { transitive = false } // QR Code scanner

src/main/AndroidManifest.xml

@@ -38,6 +38,7 @@
     <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
     <uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
     <uses-permission android:name="android.permission.FOREGROUND_SERVICE_DATA_SYNC" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK" />
 
     <!-- force compiling emojipicker on sdk<21; runtime checks are required then -->
     <uses-sdk tools:overrideLibrary="androidx.emoji2.emojipicker"/>
@@ -391,6 +392,15 @@
         android:name=".service.FetchForegroundService"
         android:foregroundServiceType="dataSync" />
 
+    <service
+        android:name=".service.AudioPlaybackService"
+        android:foregroundServiceType="mediaPlayback"
+        android:exported="true">
+        <intent-filter>
+            <action android:name="androidx.media3.session.MediaSessionService"/>
+        </intent-filter>
+    </service>
+
     <receiver android:name=".notifications.MarkReadReceiver"
               android:enabled="true"
               android:exported="false">

src/main/java/org/thoughtcrime/securesms/AllMediaActivity.java

@@ -1,35 +1,46 @@
 package org.thoughtcrime.securesms;
 
+import android.content.ComponentName;
 import android.os.Bundle;
+import android.util.Log;
 import android.view.MenuItem;
 import android.view.ViewGroup;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 import androidx.appcompat.app.ActionBar;
 import androidx.appcompat.view.ActionMode;
 import androidx.appcompat.widget.Toolbar;
+import androidx.core.content.ContextCompat;
 import androidx.fragment.app.Fragment;
 import androidx.fragment.app.FragmentManager;
 import androidx.fragment.app.FragmentStatePagerAdapter;
+import androidx.lifecycle.ViewModelProvider;
+import androidx.media3.session.MediaController;
+import androidx.media3.session.SessionCommand;
+import androidx.media3.session.SessionToken;
 import androidx.viewpager.widget.ViewPager;
 
 import com.b44t.messenger.DcChat;
 import com.b44t.messenger.DcContext;
 import com.b44t.messenger.DcEvent;
 import com.b44t.messenger.DcMsg;
 import com.google.android.material.tabs.TabLayout;
+import com.google.common.util.concurrent.ListenableFuture;
 
+import org.thoughtcrime.securesms.components.audioplay.AudioPlaybackViewModel;
 import org.thoughtcrime.securesms.connect.DcEventCenter;
 import org.thoughtcrime.securesms.connect.DcHelper;
+import org.thoughtcrime.securesms.service.AudioPlaybackService;
 import org.thoughtcrime.securesms.util.DynamicNoActionBarTheme;
-import org.thoughtcrime.securesms.util.Util;
 import org.thoughtcrime.securesms.util.ViewUtil;
 
 import java.util.ArrayList;
 
 public class AllMediaActivity extends PassphraseRequiredActionBarActivity
                              implements DcEventCenter.DcEventDelegate
 {
+  private static final String TAG = AllMediaActivity.class.getSimpleName();
 
   public static final String CHAT_ID_EXTRA    = "chat_id";
   public static final String CONTACT_ID_EXTRA = "contact_id";
@@ -57,6 +68,10 @@ static class TabData {
   private TabLayout          tabLayout;
   private ViewPager          viewPager;
 
+  private @Nullable MediaController mediaController;
+  private ListenableFuture<MediaController> mediaControllerFuture;
+  private AudioPlaybackViewModel playbackViewModel;
+
   @Override
   protected void onPreCreate() {
     dynamicTheme = new DynamicNoActionBarTheme();
@@ -91,11 +106,19 @@ protected void onCreate(Bundle bundle, boolean ready) {
     DcEventCenter eventCenter = DcHelper.getEventCenter(this);
     eventCenter.addObserver(DcContext.DC_EVENT_CHAT_MODIFIED, this);
     eventCenter.addObserver(DcContext.DC_EVENT_CONTACTS_CHANGED, this);
+
+    playbackViewModel = new ViewModelProvider(this).get(AudioPlaybackViewModel.class);
+    initializeMediaController();
   }
 
   @Override
   public void onDestroy() {
     DcHelper.getEventCenter(this).removeObservers(this);
+    if (mediaController != null) {
+      MediaController.releaseFuture(mediaControllerFuture);
+      mediaController = null;
+      playbackViewModel.setMediaController(null);
+    }
     super.onDestroy();
   }
 
@@ -124,6 +147,40 @@ private void initializeResources() {
     this.tabLayout = ViewUtil.findById(this, R.id.tab_layout);
   }
 
+  private void initializeMediaController() {
+    SessionToken sessionToken = new SessionToken(this,
+      new ComponentName(this, AudioPlaybackService.class));
+    mediaControllerFuture = new MediaController.Builder(this, sessionToken)
+      .buildAsync();
+    mediaControllerFuture.addListener(() -> {
+      try {
+        mediaController = mediaControllerFuture.get();
+        addActivityContext(
+          this.getIntent().getExtras(),
+          this.getClass().getName()
+        );
+        playbackViewModel.setMediaController(mediaController);
+      } catch (Exception e) {
+        Log.e(TAG, "Error connecting to audio playback service", e);
+      }
+    }, ContextCompat.getMainExecutor(this));
+  }
+
+  private void addActivityContext(Bundle extras, String activityClassName) {
+    if (mediaController == null) return;
+
+    Bundle commandArgs = new Bundle();
+    commandArgs.putString("activity_class", activityClassName);
+    if (extras != null) {
+      commandArgs.putAll(extras);
+    }
+
+    SessionCommand updateContextCommand =
+      new SessionCommand("UPDATE_ACTIVITY_CONTEXT", Bundle.EMPTY);
+
+    mediaController.sendCustomCommand(updateContextCommand, commandArgs);
+  }
+
   private boolean isGlobalGallery() {
     return contactId==0 && chatId==0;
   }

src/main/java/org/thoughtcrime/securesms/AllMediaDocumentsAdapter.java

@@ -11,9 +11,10 @@
 import com.b44t.messenger.DcMsg;
 import com.codewaves.stickyheadergrid.StickyHeaderGridAdapter;
 
-import org.thoughtcrime.securesms.components.AudioView;
 import org.thoughtcrime.securesms.components.DocumentView;
 import org.thoughtcrime.securesms.components.WebxdcView;
+import org.thoughtcrime.securesms.components.audioplay.AudioPlaybackViewModel;
+import org.thoughtcrime.securesms.components.audioplay.AudioView;
 import org.thoughtcrime.securesms.database.loaders.BucketedThreadMediaLoader.BucketedThreadMedia;
 import org.thoughtcrime.securesms.mms.AudioSlide;
 import org.thoughtcrime.securesms.mms.DocumentSlide;
@@ -31,7 +32,8 @@ class AllMediaDocumentsAdapter extends StickyHeaderGridAdapter {
   private final ItemClickListener   itemClickListener;
   private final Set<DcMsg>          selected;
 
-  private  BucketedThreadMedia media;
+  private  BucketedThreadMedia      media;
+  private AudioPlaybackViewModel    playbackViewModel;
 
   private static class ViewHolder extends StickyHeaderGridAdapter.ItemViewHolder {
     private final DocumentView documentView;
@@ -71,6 +73,10 @@ public void setMedia(BucketedThreadMedia media) {
     this.media = media;
   }
 
+  public void setPlaybackViewModel(AudioPlaybackViewModel playbackViewModel) {
+    this.playbackViewModel = playbackViewModel;
+  }
+
   @Override
   public StickyHeaderGridAdapter.HeaderViewHolder onCreateHeaderViewHolder(ViewGroup parent, int headerType) {
     return new HeaderHolder(LayoutInflater.from(context).inflate(R.layout.contact_selection_list_divider, parent, false));
@@ -97,6 +103,7 @@ public void onBindItemViewHolder(ItemViewHolder itemViewHolder, int section, int
       viewHolder.webxdcView.setVisibility(View.GONE);
 
       viewHolder.audioView.setVisibility(View.VISIBLE);
+      viewHolder.audioView.setPlaybackViewModel(playbackViewModel);
       viewHolder.audioView.setAudio((AudioSlide)slide, dcMsg.getDuration());
       viewHolder.audioView.setOnClickListener(view -> itemClickListener.onMediaClicked(dcMsg));
       viewHolder.audioView.setOnLongClickListener(view -> { itemClickListener.onMediaLongClicked(dcMsg); return true; });

src/main/java/org/thoughtcrime/securesms/AllMediaDocumentsFragment.java

@@ -16,6 +16,7 @@
 import androidx.annotation.NonNull;
 import androidx.appcompat.app.AppCompatActivity;
 import androidx.appcompat.view.ActionMode;
+import androidx.lifecycle.ViewModelProvider;
 import androidx.loader.app.LoaderManager;
 import androidx.loader.content.Loader;
 import androidx.recyclerview.widget.RecyclerView;
@@ -25,6 +26,7 @@
 import com.b44t.messenger.DcMsg;
 import com.codewaves.stickyheadergrid.StickyHeaderGridLayoutManager;
 
+import org.thoughtcrime.securesms.components.audioplay.AudioPlaybackViewModel;
 import org.thoughtcrime.securesms.connect.DcEventCenter;
 import org.thoughtcrime.securesms.connect.DcHelper;
 import org.thoughtcrime.securesms.database.loaders.BucketedThreadMediaLoader;
@@ -72,9 +74,11 @@ public View onCreateView(@NonNull LayoutInflater inflater, ViewGroup container,
     // add padding to avoid content hidden behind system bars
     ViewUtil.applyWindowInsets(recyclerView, true, false, true, true);
 
-    this.recyclerView.setAdapter(new AllMediaDocumentsAdapter(getContext(),
-        new BucketedThreadMediaLoader.BucketedThreadMedia(getContext()),
-        this));
+    AllMediaDocumentsAdapter adapter = new AllMediaDocumentsAdapter(getContext(),
+      new BucketedThreadMediaLoader.BucketedThreadMedia(getContext()),
+      this);
+    this.recyclerView.setAdapter(adapter);
+    adapter.setPlaybackViewModel(new ViewModelProvider(requireActivity()).get(AudioPlaybackViewModel.class));
     this.recyclerView.setLayoutManager(gridManager);
     this.recyclerView.setHasFixedSize(true);
 
@@ -239,12 +243,13 @@ public boolean onPrepareActionMode(ActionMode mode, Menu menu) {
     @Override
     public boolean onActionItemClicked(ActionMode mode, MenuItem menuItem) {
       int itemId = menuItem.getItemId();
+      AudioPlaybackViewModel playbackViewModel = new ViewModelProvider(requireActivity()).get(AudioPlaybackViewModel.class);
       if (itemId == R.id.details) {
         handleDisplayDetails(getSelectedMessageRecord(getListAdapter().getSelectedMedia()));
         mode.finish();
         return true;
       } else if (itemId == R.id.delete) {
-        handleDeleteMessages(chatId, getListAdapter().getSelectedMedia());
+        handleDeleteMessages(chatId, getListAdapter().getSelectedMedia(), playbackViewModel::stopByIds, playbackViewModel::stopByIds);
         mode.finish();
         return true;
       } else if (itemId == R.id.share) {

src/main/java/org/thoughtcrime/securesms/BaseConversationItem.java

@@ -50,11 +50,11 @@ public BaseConversationItem(Context context, AttributeSet attrs) {
     this.rpc = DcHelper.getRpc(context);
   }
 
-  protected void bind(@NonNull DcMsg            messageRecord,
-                      @NonNull DcChat           dcChat,
-                      @NonNull Set<DcMsg>       batchSelected,
-                      boolean                   pulseHighlight,
-                      @NonNull Recipient        conversationRecipient)
+  protected void bindPartial(@NonNull DcMsg            messageRecord,
+                             @NonNull DcChat           dcChat,
+                             @NonNull Set<DcMsg>       batchSelected,
+                             boolean                   pulseHighlight,
+                             @NonNull Recipient        conversationRecipient)
   {
     this.messageRecord  = messageRecord;
     this.dcChat         = dcChat;
@@ -126,6 +126,8 @@ protected class ClickListener implements View.OnClickListener {
 
     public void onClick(View v) {
       if (!shouldInterceptClicks(messageRecord) && parent != null) {
+        // The click workaround on ConversationItem shall be revised.
+        // In fact, it is probably better rethinking accessibility approach for the items.
         if (batchSelected.isEmpty() && Util.isTouchExplorationEnabled(context)) {
           BaseConversationItem.this.onAccessibilityClick();
         }

src/main/java/org/thoughtcrime/securesms/BindableConversationItem.java

@@ -6,6 +6,8 @@
 import com.b44t.messenger.DcChat;
 import com.b44t.messenger.DcMsg;
 
+import org.thoughtcrime.securesms.components.audioplay.AudioPlaybackViewModel;
+import org.thoughtcrime.securesms.components.audioplay.AudioView;
 import org.thoughtcrime.securesms.mms.GlideRequests;
 import org.thoughtcrime.securesms.recipients.Recipient;
 
@@ -17,7 +19,9 @@ void bind(@NonNull DcMsg                   messageRecord,
             @NonNull GlideRequests           glideRequests,
             @NonNull Set<DcMsg>              batchSelected,
             @NonNull Recipient               recipients,
-                     boolean                 pulseHighlight);
+            boolean                          pulseHighlight,
+            @Nullable AudioPlaybackViewModel playbackViewModel,
+            AudioView.OnActionListener       audioPlayPauseListener);
 
   DcMsg getMessageRecord();