Properly stop PlayerService

This commit is a consequence of the commit "Drop some assumptions on how PlayerService is started and reused". Since the assumptions on how the PlayerService is started and reused have changed, we also need to adapt the way it is stopped. This means allowing the service to remain alive even after the player is destroyed, in case the system is still accessing PlayerService e.g. through the media browser interface. The foreground service needs to be stopped and the notification removed in any case.

Author: Stypox

app/src/main/java/org/schabi/newpipe/player/Player.java

@@ -657,7 +657,7 @@ public void onPlaybackShutdown() {
             Log.d(TAG, "onPlaybackShutdown() called");
         }
         // destroys the service, which in turn will destroy the player
-        service.stopService();
+        service.destroyPlayerAndStopService();
     }
 
     public void smoothStopForImmediateReusing() {
@@ -729,7 +729,7 @@ private void onBroadcastReceived(final Intent intent) {
                 pause();
                 break;
             case ACTION_CLOSE:
-                service.stopService();
+                service.destroyPlayerAndStopService();
                 break;
             case ACTION_PLAY_PAUSE:
                 playPause();

app/src/main/java/org/schabi/newpipe/player/PlayerService.java

@@ -32,6 +32,7 @@
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.core.app.ServiceCompat;
 import androidx.media.MediaBrowserServiceCompat;
 
 import com.google.android.exoplayer2.ext.mediasession.MediaSessionConnector;
@@ -150,7 +151,7 @@ public int onStartCommand(final Intent intent, final int flags, final int startI
             Stop the service in this case, which will be removed from the foreground and its
             notification cancelled in its destruction
              */
-            stopSelf();
+            destroyPlayerAndStopService();
             return START_NOT_STICKY;
         }
 
@@ -197,7 +198,6 @@ public void onDestroy() {
         cleanup();
 
         mediaBrowserPlaybackPreparer.dispose();
-        mediaSession.setActive(false);
         mediaSession.release();
         mediaBrowserImpl.dispose();
     }
@@ -207,11 +207,36 @@ private void cleanup() {
             player.destroy();
             player = null;
         }
+
+        // Should already be handled by MediaSessionPlayerUi, but just to be sure.
+        mediaSession.setActive(false);
+
+        // Should already be handled by NotificationUtil.cancelNotificationAndStopForeground() in
+        // NotificationPlayerUi, but let's make sure that the foreground service is stopped.
+        ServiceCompat.stopForeground(this, ServiceCompat.STOP_FOREGROUND_REMOVE);
     }
 
-    public void stopService() {
+    /**
+     * Destroys the player and allows the player instance to be garbage collected. Sets the media
+     * session to inactive. Stops the foreground service and removes the player notification
+     * associated with it. Tries to stop the {@link PlayerService} completely, but this step will
+     * have no effect in case some service connection still uses the service (e.g. the Android Auto
+     * system accesses the media browser even when no player is running).
+     */
+    public void destroyPlayerAndStopService() {
+        if (DEBUG) {
+            Log.d(TAG, "destroyPlayerAndStopService() called");
+        }
+
         cleanup();
-        stopSelf();
+
+        // This only really stops the service if there are no other service connections (see docs):
+        // for example the (Android Auto) media browser binder will block stopService().
+        // This is why we also stopForeground() above, to make sure the notification is removed.
+        // If we were to call stopSelf(), then the service would be surely stopped (regardless of
+        // other service connections), but this would be a waste of resources since the service
+        // would be immediately restarted by those same connections to perform the queries.
+        stopService(new Intent(this, PlayerService.class));
     }
 
     @Override

app/src/main/java/org/schabi/newpipe/player/helper/PlayerHolder.java

@@ -138,8 +138,16 @@ public void startService(final boolean playAfterConnect,
     }
 
     public void stopService() {
+        if (DEBUG) {
+            Log.d(TAG, "stopService() called");
+        }
+        if (playerService != null) {
+            playerService.destroyPlayerAndStopService();
+        }
         final Context context = getCommonContext();
         unbind(context);
+        // destroyPlayerAndStopService() already runs the next line of code, but run it again just
+        // to make sure to stop the service even if playerService is null by any chance.
         context.stopService(new Intent(context, PlayerService.class));
     }
 

app/src/main/java/org/schabi/newpipe/player/ui/PopupPlayerUi.java

@@ -382,7 +382,7 @@ public void onAnimationEnd(final Animator animation) {
                     private void end() {
                         windowManager.removeView(closeOverlayBinding.getRoot());
                         closeOverlayBinding = null;
-                        player.getService().stopService();
+                        player.getService().destroyPlayerAndStopService();
                     }
                 }).start();
     }