Move PlayerType into its own class and add documentation

Also replace some `isPlayerOpen` with direct `playerType == null` checks.

app/src/main/java/org/schabi/newpipe/RouterActivity.java

@@ -60,7 +60,7 @@
 import org.schabi.newpipe.extractor.stream.StreamInfo;
 import org.schabi.newpipe.ktx.ExceptionUtils;
 import org.schabi.newpipe.local.dialog.PlaylistDialog;
-import org.schabi.newpipe.player.PlayerService;
+import org.schabi.newpipe.player.PlayerType;
 import org.schabi.newpipe.player.helper.PlayerHelper;
 import org.schabi.newpipe.player.helper.PlayerHolder;
 import org.schabi.newpipe.player.playqueue.ChannelPlayQueue;
@@ -630,8 +630,8 @@ private boolean canHandleChoiceLikeShowInfo(final String selectedChoiceKey) {
         }
 
         // ...the player is not running or in normal Video-mode/type
-        final PlayerService.PlayerType playerType = PlayerHolder.getInstance().getType();
-        return playerType == null || playerType == PlayerService.PlayerType.MAIN;
+        final PlayerType playerType = PlayerHolder.getInstance().getType();
+        return playerType == null || playerType == PlayerType.MAIN;
     }
 
     private void openAddToPlaylistDialog() {

app/src/main/java/org/schabi/newpipe/fragments/detail/VideoDetailFragment.java

@@ -90,7 +90,7 @@
 import org.schabi.newpipe.local.history.HistoryRecordManager;
 import org.schabi.newpipe.player.Player;
 import org.schabi.newpipe.player.PlayerService;
-import org.schabi.newpipe.player.PlayerService.PlayerType;
+import org.schabi.newpipe.player.PlayerType;
 import org.schabi.newpipe.player.event.OnKeyDownListener;
 import org.schabi.newpipe.player.event.PlayerServiceExtendedEventListener;
 import org.schabi.newpipe.player.helper.PlayerHelper;

app/src/main/java/org/schabi/newpipe/fragments/list/channel/ChannelFragment.java

@@ -43,7 +43,7 @@
 import org.schabi.newpipe.ktx.AnimationType;
 import org.schabi.newpipe.local.subscription.SubscriptionManager;
 import org.schabi.newpipe.local.feed.notifications.NotificationHelper;
-import org.schabi.newpipe.player.PlayerService.PlayerType;
+import org.schabi.newpipe.player.PlayerType;
 import org.schabi.newpipe.player.playqueue.ChannelPlayQueue;
 import org.schabi.newpipe.player.playqueue.PlayQueue;
 import org.schabi.newpipe.util.ExtractorHelper;

app/src/main/java/org/schabi/newpipe/fragments/list/playlist/PlaylistFragment.java

@@ -43,7 +43,7 @@
 import org.schabi.newpipe.info_list.dialog.StreamDialogDefaultEntry;
 import org.schabi.newpipe.local.dialog.PlaylistDialog;
 import org.schabi.newpipe.local.playlist.RemotePlaylistManager;
-import org.schabi.newpipe.player.PlayerService.PlayerType;
+import org.schabi.newpipe.player.PlayerType;
 import org.schabi.newpipe.player.playqueue.PlayQueue;
 import org.schabi.newpipe.player.playqueue.PlaylistPlayQueue;
 import org.schabi.newpipe.util.ExtractorHelper;

app/src/main/java/org/schabi/newpipe/local/playlist/LocalPlaylistFragment.java

@@ -43,7 +43,7 @@
 import org.schabi.newpipe.info_list.dialog.InfoItemDialog;
 import org.schabi.newpipe.local.BaseLocalListFragment;
 import org.schabi.newpipe.local.history.HistoryRecordManager;
-import org.schabi.newpipe.player.PlayerService.PlayerType;
+import org.schabi.newpipe.player.PlayerType;
 import org.schabi.newpipe.player.playqueue.PlayQueue;
 import org.schabi.newpipe.player.playqueue.SinglePlayQueue;
 import org.schabi.newpipe.util.Localization;

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

@@ -32,7 +32,6 @@
 import static org.schabi.newpipe.player.helper.PlayerHelper.isPlaybackResumeEnabled;
 import static org.schabi.newpipe.player.helper.PlayerHelper.nextRepeatMode;
 import static org.schabi.newpipe.player.helper.PlayerHelper.retrievePlaybackParametersFromPrefs;
-import static org.schabi.newpipe.player.helper.PlayerHelper.retrievePlayerTypeFromIntent;
 import static org.schabi.newpipe.player.helper.PlayerHelper.retrieveSeekDurationFromPreferences;
 import static org.schabi.newpipe.player.helper.PlayerHelper.savePlaybackParametersToPrefs;
 import static org.schabi.newpipe.player.notification.NotificationConstants.ACTION_CLOSE;
@@ -95,7 +94,6 @@
 import org.schabi.newpipe.extractor.stream.VideoStream;
 import org.schabi.newpipe.fragments.detail.VideoDetailFragment;
 import org.schabi.newpipe.local.history.HistoryRecordManager;
-import org.schabi.newpipe.player.PlayerService.PlayerType;
 import org.schabi.newpipe.player.event.PlayerEventListener;
 import org.schabi.newpipe.player.event.PlayerServiceEventListener;
 import org.schabi.newpipe.player.helper.AudioReactor;
@@ -308,7 +306,7 @@ public void handleIntent(@NonNull final Intent intent) {
         }
 
         final PlayerType oldPlayerType = playerType;
-        playerType = retrievePlayerTypeFromIntent(intent);
+        playerType = PlayerType.retrieveFromIntent(intent);
         initUIsForCurrentPlayerType();
         // We need to setup audioOnly before super(), see "sourceOf"
         isAudioOnly = audioPlayerSelected();

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

@@ -42,11 +42,6 @@ public final class PlayerService extends Service {
 
     private final IBinder mBinder = new PlayerService.LocalBinder();
 
-    public enum PlayerType {
-        MAIN,
-        AUDIO,
-        POPUP
-    }
 
     /*//////////////////////////////////////////////////////////////////////////
     // Service's LifeCycle

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

@@ -0,0 +1,32 @@
+package org.schabi.newpipe.player;
+
+import static org.schabi.newpipe.player.Player.PLAYER_TYPE;
+
+import android.content.Intent;
+
+public enum PlayerType {
+    MAIN,
+    AUDIO,
+    POPUP;
+
+    /**
+     * @return an integer representing this {@link PlayerType}, to be used to save it in intents
+     * @see #retrieveFromIntent(Intent) Use retrieveFromIntent() to retrieve and convert player type
+     *                                  integers from an intent
+     */
+    public int valueForIntent() {
+        return ordinal();
+    }
+
+    /**
+     * @param intent the intent to retrieve a player type from
+     * @return the player type integer retrieved from the intent, converted back into a {@link
+     *         PlayerType}, or {@link PlayerType#MAIN} if there is no player type extra in the
+     *         intent
+     * @throws ArrayIndexOutOfBoundsException if the intent contains an invalid player type integer
+     * @see #valueForIntent() Use valueForIntent() to obtain valid player type integers
+     */
+    public static PlayerType retrieveFromIntent(final Intent intent) {
+        return values()[intent.getIntExtra(PLAYER_TYPE, MAIN.valueForIntent())];
+    }
+}

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

@@ -3,7 +3,6 @@
 import static com.google.android.exoplayer2.Player.REPEAT_MODE_ALL;
 import static com.google.android.exoplayer2.Player.REPEAT_MODE_OFF;
 import static com.google.android.exoplayer2.Player.REPEAT_MODE_ONE;
-import static org.schabi.newpipe.player.Player.PLAYER_TYPE;
 import static org.schabi.newpipe.player.helper.PlayerHelper.AutoplayType.AUTOPLAY_TYPE_ALWAYS;
 import static org.schabi.newpipe.player.helper.PlayerHelper.AutoplayType.AUTOPLAY_TYPE_NEVER;
 import static org.schabi.newpipe.player.helper.PlayerHelper.AutoplayType.AUTOPLAY_TYPE_WIFI;
@@ -14,7 +13,6 @@
 
 import android.annotation.SuppressLint;
 import android.content.Context;
-import android.content.Intent;
 import android.content.SharedPreferences;
 import android.provider.Settings;
 import android.view.accessibility.CaptioningManager;
@@ -44,7 +42,6 @@
 import org.schabi.newpipe.extractor.stream.SubtitlesStream;
 import org.schabi.newpipe.extractor.utils.Utils;
 import org.schabi.newpipe.player.Player;
-import org.schabi.newpipe.player.PlayerService;
 import org.schabi.newpipe.player.playqueue.PlayQueue;
 import org.schabi.newpipe.player.playqueue.PlayQueueItem;
 import org.schabi.newpipe.player.playqueue.SinglePlayQueue;
@@ -428,12 +425,6 @@ private static SinglePlayQueue getAutoQueuedSinglePlayQueue(
     // Utils used by player
     ////////////////////////////////////////////////////////////////////////////
 
-    public static PlayerService.PlayerType retrievePlayerTypeFromIntent(final Intent intent) {
-        // If you want to open popup from the app just include Constants.POPUP_ONLY into an extra
-        return PlayerService.PlayerType.values()[
-                intent.getIntExtra(PLAYER_TYPE, PlayerService.PlayerType.MAIN.ordinal())];
-    }
-
     public static boolean isPlaybackResumeEnabled(final Player player) {
         return player.getPrefs().getBoolean(
                 player.getContext().getString(R.string.enable_watch_history_key), true)

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

@@ -18,6 +18,7 @@
 import org.schabi.newpipe.extractor.stream.StreamInfo;
 import org.schabi.newpipe.player.PlayerService;
 import org.schabi.newpipe.player.Player;
+import org.schabi.newpipe.player.PlayerType;
 import org.schabi.newpipe.player.event.PlayerServiceEventListener;
 import org.schabi.newpipe.player.event.PlayerServiceExtendedEventListener;
 import org.schabi.newpipe.player.playqueue.PlayQueue;
@@ -46,13 +47,13 @@ public static synchronized PlayerHolder getInstance() {
     @Nullable private Player player;
 
     /**
-     * Returns the current {@link PlayerService.PlayerType} of the {@link PlayerService} service,
-     * otherwise `null` if no service running.
+     * Returns the current {@link PlayerType} of the {@link PlayerService} service,
+     * otherwise `null` if no service is running.
      *
      * @return Current PlayerType
      */
     @Nullable
-    public PlayerService.PlayerType getType() {
+    public PlayerType getType() {
         if (player == null) {
             return null;
         }

app/src/main/java/org/schabi/newpipe/util/NavigationHelper.java

@@ -51,9 +51,9 @@
 import org.schabi.newpipe.local.subscription.SubscriptionFragment;
 import org.schabi.newpipe.local.subscription.SubscriptionsImportFragment;
 import org.schabi.newpipe.player.PlayerService;
-import org.schabi.newpipe.player.PlayerService.PlayerType;
 import org.schabi.newpipe.player.PlayQueueActivity;
 import org.schabi.newpipe.player.Player;
+import org.schabi.newpipe.player.PlayerType;
 import org.schabi.newpipe.player.helper.PlayerHelper;
 import org.schabi.newpipe.player.helper.PlayerHolder;
 import org.schabi.newpipe.player.playqueue.PlayQueue;
@@ -91,7 +91,7 @@ public static <T> Intent getPlayerIntent(@NonNull final Context context,
                 intent.putExtra(Player.PLAY_QUEUE_KEY, cacheKey);
             }
         }
-        intent.putExtra(Player.PLAYER_TYPE, PlayerService.PlayerType.MAIN.ordinal());
+        intent.putExtra(Player.PLAYER_TYPE, PlayerType.MAIN.valueForIntent());
         intent.putExtra(Player.RESUME_PLAYBACK, resumePlayback);
 
         return intent;
@@ -164,7 +164,7 @@ public static void playOnPopupPlayer(final Context context,
         Toast.makeText(context, R.string.popup_playing_toast, Toast.LENGTH_SHORT).show();
 
         final Intent intent = getPlayerIntent(context, PlayerService.class, queue, resumePlayback);
-        intent.putExtra(Player.PLAYER_TYPE, PlayerService.PlayerType.POPUP.ordinal());
+        intent.putExtra(Player.PLAYER_TYPE, PlayerType.POPUP.valueForIntent());
         ContextCompat.startForegroundService(context, intent);
     }
 
@@ -175,7 +175,7 @@ public static void playOnBackgroundPlayer(final Context context,
                 .show();
 
         final Intent intent = getPlayerIntent(context, PlayerService.class, queue, resumePlayback);
-        intent.putExtra(Player.PLAYER_TYPE, PlayerService.PlayerType.AUDIO.ordinal());
+        intent.putExtra(Player.PLAYER_TYPE, PlayerType.AUDIO.valueForIntent());
         ContextCompat.startForegroundService(context, intent);
     }
 
@@ -186,15 +186,15 @@ public static void enqueueOnPlayer(final Context context,
         Toast.makeText(context, R.string.enqueued, Toast.LENGTH_SHORT).show();
         final Intent intent = getPlayerEnqueueIntent(context, PlayerService.class, queue);
 
-        intent.putExtra(Player.PLAYER_TYPE, playerType.ordinal());
+        intent.putExtra(Player.PLAYER_TYPE, playerType.valueForIntent());
         ContextCompat.startForegroundService(context, intent);
     }
 
     public static void enqueueOnPlayer(final Context context, final PlayQueue queue) {
         PlayerType playerType = PlayerHolder.getInstance().getType();
-        if (!PlayerHolder.getInstance().isPlayerOpen()) {
+        if (playerType == null) {
             Log.e(TAG, "Enqueueing but no player is open; defaulting to background player");
-            playerType = PlayerService.PlayerType.AUDIO;
+            playerType = PlayerType.AUDIO;
         }
 
         enqueueOnPlayer(context, queue, playerType);
@@ -203,14 +203,14 @@ public static void enqueueOnPlayer(final Context context, final PlayQueue queue)
     /* ENQUEUE NEXT */
     public static void enqueueNextOnPlayer(final Context context, final PlayQueue queue) {
         PlayerType playerType = PlayerHolder.getInstance().getType();
-        if (!PlayerHolder.getInstance().isPlayerOpen()) {
+        if (playerType == null) {
             Log.e(TAG, "Enqueueing next but no player is open; defaulting to background player");
-            playerType = PlayerService.PlayerType.AUDIO;
+            playerType = PlayerType.AUDIO;
         }
         Toast.makeText(context, R.string.enqueued_next, Toast.LENGTH_SHORT).show();
         final Intent intent = getPlayerEnqueueNextIntent(context, PlayerService.class, queue);
 
-        intent.putExtra(Player.PLAYER_TYPE, playerType.ordinal());
+        intent.putExtra(Player.PLAYER_TYPE, playerType.valueForIntent());
         ContextCompat.startForegroundService(context, intent);
     }
 
@@ -414,14 +414,14 @@ public static void openVideoDetailFragment(@NonNull final Context context,
                                                final boolean switchingPlayers) {
 
         final boolean autoPlay;
-        @Nullable final PlayerService.PlayerType playerType = PlayerHolder.getInstance().getType();
-        if (!PlayerHolder.getInstance().isPlayerOpen()) {
+        @Nullable final PlayerType playerType = PlayerHolder.getInstance().getType();
+        if (playerType == null) {
             // no player open
             autoPlay = PlayerHelper.isAutoplayAllowedByUser(context);
         } else if (switchingPlayers) {
             // switching player to main player
             autoPlay = PlayerHolder.getInstance().isPlaying(); // keep play/pause state
-        } else if (playerType == PlayerService.PlayerType.MAIN) {
+        } else if (playerType == PlayerType.MAIN) {
             // opening new stream while already playing in main player
             autoPlay = PlayerHelper.isAutoplayAllowedByUser(context);
         } else {
@@ -436,7 +436,7 @@ public static void openVideoDetailFragment(@NonNull final Context context,
                 // Situation when user switches from players to main player. All needed data is
                 // here, we can start watching (assuming newQueue equals playQueue).
                 // Starting directly in fullscreen if the previous player type was popup.
-                detailFragment.openVideoPlayer(playerType == PlayerService.PlayerType.POPUP
+                detailFragment.openVideoPlayer(playerType == PlayerType.POPUP
                         || PlayerHelper.isStartMainPlayerFullscreenEnabled(context));
             } else {
                 detailFragment.selectAndLoadVideo(serviceId, url, title, playQueue);