Castopod
/
AntennaPod
mirror of https://github.com/AntennaPod/AntennaPod.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

review stop PlaybackService codes (stopSelf, stopForeground, etc.)

This commit is contained in:
orionlee 2019-01-06 12:26:06 -08:00
parent 3f14fac479
commit 584865ad18
1 changed files with 75 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
core/src/main/java/de/danoeh/antennapod/core/service/playback/PlaybackService.java
View File

@ -343,7 +343,7 @@ public class PlaybackService extends MediaBrowserServiceCompat {
public void onDestroy() { public void onDestroy() {
super.onDestroy(); super.onDestroy();
Log.d(TAG, "Service is about to be destroyed"); Log.d(TAG, "Service is about to be destroyed");
stopForeground(true); // TODO: [2716] unclear if stopForeground is still needed stopForeground(true);
isRunning = false; isRunning = false;
currentMediaType = MediaType.UNKNOWN; currentMediaType = MediaType.UNKNOWN;
@ -366,11 +366,6 @@ public class PlaybackService extends MediaBrowserServiceCompat {
taskManager.shutdown(); taskManager.shutdown();
} }
private void stopService() {
stopForeground(true); // TODO: [2716] unclear if stopForeground is still needed
stopSelf();
}
@Override @Override
public BrowserRoot onGetRoot(@NonNull String clientPackageName, int clientUid, Bundle rootHints) { public BrowserRoot onGetRoot(@NonNull String clientPackageName, int clientUid, Bundle rootHints) {
Log.d(TAG, "OnGetRoot: clientPackageName=" + clientPackageName + Log.d(TAG, "OnGetRoot: clientPackageName=" + clientPackageName +
@ -473,13 +468,13 @@ public class PlaybackService extends MediaBrowserServiceCompat {
if ((flags & Service.START_FLAG_REDELIVERY) != 0) { if ((flags & Service.START_FLAG_REDELIVERY) != 0) {
Log.d(TAG, "onStartCommand is a redelivered intent, calling stopForeground now."); Log.d(TAG, "onStartCommand is a redelivered intent, calling stopForeground now.");
stopForeground(true); // TODO: unclear if stopForeground is still needed stopForeground(true); // TODO: [2716]-RemoveOptional legacy code from v0.9.8.1 that is no longer applicable, which used to return Service.START_REDELIVER_INTENT. See
} else { } else {
if (keycode != -1) { if (keycode != -1) {
Log.d(TAG, "Received media button event"); Log.d(TAG, "Received media button event");
boolean handled = handleKeycode(keycode, true); boolean handled = handleKeycode(keycode, true);
if (!handled) { if (!handled) {
stopService(); serviceManager.stopService(); // TODO: [2716]-RemoveOptional why is it added in the first place in v1.7.0?
return Service.START_NOT_STICKY; return Service.START_NOT_STICKY;
} }
} else if (!flavorHelper.castDisconnect(castDisconnect) && playable != null) { } else if (!flavorHelper.castDisconnect(castDisconnect) && playable != null) {
@ -568,11 +563,23 @@ public class PlaybackService extends MediaBrowserServiceCompat {
mediaPlayer.seekDelta(-UserPreferences.getRewindSecs() * 1000); mediaPlayer.seekDelta(-UserPreferences.getRewindSecs() * 1000);
return true; return true;
case KeyEvent.KEYCODE_MEDIA_STOP: case KeyEvent.KEYCODE_MEDIA_STOP:
// The logic gives UI illusion of stop by removing notification
// In the UI within AntennaPod, including widgets, it is seen as PAUSE, e.g.,
// users can still user on-screen widget to resume playing.
if (status == PlayerStatus.PLAYING) { if (status == PlayerStatus.PLAYING) {
// Implementation note: Use of a state in serviceManager to tell it to
// show stop state UI (i.e., stopForeground(true)) is a bit awkward.
//
// More intuitive API would be for mediaPlayer.pause() returns a Future that
// returns after pause, including the related async notification work completes.
// However, it has its own complication, that mediaPlayer.pause() does not
// really know when all the related work completes, as they are buried into
// (asynchronous) callbacks.
serviceManager.treatNextPauseAsStopOnUI();
mediaPlayer.pause(true, true); mediaPlayer.pause(true, true);
} else {
serviceManager.showUIForStopState();
} }
stopForeground(true); // gets rid of persistent notification // TODO: [2716] unclear if stopForeground is still needed
return true; return true;
default: default:
Log.d(TAG, "Unhandled key code: " + keycode); Log.d(TAG, "Unhandled key code: " + keycode);
@ -672,7 +679,7 @@ public class PlaybackService extends MediaBrowserServiceCompat {
case STOPPED: case STOPPED:
//writePlaybackPreferencesNoMediaPlaying(); //writePlaybackPreferencesNoMediaPlaying();
//stopService(); //serviceManager.stopService();
break; break;
case PLAYING: case PLAYING:
@ -699,7 +706,7 @@ public class PlaybackService extends MediaBrowserServiceCompat {
@Override @Override
public void shouldStop() { public void shouldStop() {
stopService(); // TODO: [2716] unclear if stopService() call is still needed serviceManager.stopService();
} }
@Override @Override
@ -831,9 +838,6 @@ public class PlaybackService extends MediaBrowserServiceCompat {
if (stopPlaying) { if (stopPlaying) {
taskManager.cancelPositionSaver(); taskManager.cancelPositionSaver();
writePlaybackPreferencesNoMediaPlaying(); writePlaybackPreferencesNoMediaPlaying();
if (!isCasting) {
stopForeground(true); // TODO: [2716] unclear if stopForeground is still needed
}
} }
if (mediaType == null) { if (mediaType == null) {
sendNotificationBroadcast(NOTIFICATION_TYPE_PLAYBACK_END, 0); sendNotificationBroadcast(NOTIFICATION_TYPE_PLAYBACK_END, 0);
@ -1190,14 +1194,18 @@ public class PlaybackService extends MediaBrowserServiceCompat {
*/ */
private Thread notificationSetupThread; private Thread notificationSetupThread;
private synchronized void setupNotification(final Playable playable) { private void setupNotification(final Playable playable) {
setupNotification(playable, false);
}
private synchronized void setupNotification(final Playable playable, boolean treatPauseAsStop) {
if (notificationSetupThread != null) { if (notificationSetupThread != null) {
notificationSetupThread.interrupt(); notificationSetupThread.interrupt();
} }
if (playable == null) { if (playable == null) {
Log.d(TAG, "setupNotification: playable is null"); Log.d(TAG, "setupNotification: playable is null");
if (!isStarted()) { if (!isStarted()) {
stopService(); serviceManager.stopService();
} }
return; return;
} }
@ -1211,7 +1219,7 @@ public class PlaybackService extends MediaBrowserServiceCompat {
if (mediaPlayer == null) { if (mediaPlayer == null) {
Log.d(TAG, "notificationSetupTask: mediaPlayer is null"); Log.d(TAG, "notificationSetupTask: mediaPlayer is null");
if (!isStarted()) { if (!isStarted()) {
stopService(); serviceManager.stopService();
} }
return; return;
} }
@ -1334,7 +1342,9 @@ public class PlaybackService extends MediaBrowserServiceCompat {
startForeground(NOTIFICATION_ID, notification); startForeground(NOTIFICATION_ID, notification);
} else if (playerStatus == PlayerStatus.PAUSED) { } else if (playerStatus == PlayerStatus.PAUSED) {
// TODO: logic originally in mediaPlayerCallback case PAUSED. // TODO: logic originally in mediaPlayerCallback case PAUSED.
if ((UserPreferences.isPersistNotify() || isCasting) && if (treatPauseAsStop) {
stopForeground(true);
} else if ((UserPreferences.isPersistNotify() || isCasting) &&
android.os.Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN) { android.os.Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN) {
// do not remove notification on pause based on user pref and whether android version supports expanded notifications // do not remove notification on pause based on user pref and whether android version supports expanded notifications
// Change [Play] button to [Pause] // Change [Play] button to [Pause]
@ -1548,7 +1558,7 @@ public class PlaybackService extends MediaBrowserServiceCompat {
@Override @Override
public void onReceive(Context context, Intent intent) { public void onReceive(Context context, Intent intent) {
if (TextUtils.equals(intent.getAction(), ACTION_SHUTDOWN_PLAYBACK_SERVICE)) { if (TextUtils.equals(intent.getAction(), ACTION_SHUTDOWN_PLAYBACK_SERVICE)) {
stopService(); serviceManager.stopService();
} }
} }
@ -1914,6 +1924,7 @@ public class PlaybackService extends MediaBrowserServiceCompat {
*/ */
private class ServiceManager { private class ServiceManager {
private boolean serviceInStartedState; private boolean serviceInStartedState;
private boolean toTreatNextPauseAsStopOnUI = false;
/** /**
* *
@ -1924,23 +1935,51 @@ public class PlaybackService extends MediaBrowserServiceCompat {
// Report the state to the MediaSession. // Report the state to the MediaSession.
Log.v(TAG, "DBG - onPlaybackStateChange(" + state + ")"); Log.v(TAG, "DBG - onPlaybackStateChange(" + state + ")");
// Manage the started state of this service. try {
switch (state.getState()) { // Manage the started state of this service.
case PlaybackStateCompat.STATE_PLAYING: switch (state.getState()) {
moveServiceToStartedState(state); case PlaybackStateCompat.STATE_PLAYING:
break; moveServiceToStartedState(state);
case PlaybackStateCompat.STATE_PAUSED: break;
updateNotificationForPause(state); case PlaybackStateCompat.STATE_PAUSED:
break; updateNotificationForPause(state);
case PlaybackStateCompat.STATE_STOPPED: break;
moveServiceOutOfStartedState(state); case PlaybackStateCompat.STATE_STOPPED:
break; moveServiceOutOfStartedState(state);
case PlaybackStateCompat.STATE_ERROR: break;
moveServiceOutOfStartedState(state); case PlaybackStateCompat.STATE_ERROR:
break; moveServiceOutOfStartedState(state);
break;
}
} finally {
if (toTreatNextPauseAsStopOnUI) {
Log.v(TAG, "onPlaybackStateChange() - toTreatNextPauseAsStopOnUI enabled. The actual state (should be PAUSED, aka 2): " + state.getState());
toTreatNextPauseAsStopOnUI = false;
}
} }
} }
/**
* Tell service manager that on the next state change, if the state is STATE_PAUSED,
* give UI treatment as if it is stopped.
*
* @see #handleKeycode(int, boolean) the use case
*/
public void treatNextPauseAsStopOnUI() {
this.toTreatNextPauseAsStopOnUI = true;
}
public void showUIForStopState() {
Log.v(TAG, "serviceManager.showUIForStopState()");
stopForeground(true); // gets rid of persistent notification, to give the UI illusion of STOP
}
public void stopService() {
stopForeground(true);
stopSelf();
serviceInStartedState = false;
}
private void moveServiceToStartedState(PlaybackStateCompat state) { private void moveServiceToStartedState(PlaybackStateCompat state) {
Log.v(TAG, "DBG - ServiceManager.moveServiceToStartedState() - serviceInStartedState:" + serviceInStartedState); Log.v(TAG, "DBG - ServiceManager.moveServiceToStartedState() - serviceInStartedState:" + serviceInStartedState);
@ -1959,16 +1998,14 @@ public class PlaybackService extends MediaBrowserServiceCompat {
} }
private void moveServiceOutOfStartedState(PlaybackStateCompat state) { private void moveServiceOutOfStartedState(PlaybackStateCompat state) {
stopForeground(true); stopService();
stopSelf();
serviceInStartedState = false;
} }
private void doSetupNotification() { private void doSetupNotification() {
if (mediaPlayer != null && mediaPlayer.getPlayable() != null) { if (mediaPlayer != null && mediaPlayer.getPlayable() != null) {
// it updates notification and set foreground status // it updates notification and set foreground status
// based on player status (similar to PlaybackState) // based on player status (similar to PlaybackState)
setupNotification(mediaPlayer.getPlayable()); setupNotification(mediaPlayer.getPlayable(), toTreatNextPauseAsStopOnUI);
} else { } else {
// should not happen unless there are bugs. // should not happen unless there are bugs.
Log.e(TAG, "doSetupNotification() - unexpectedly there is no playable. No notification setup done. mediaPlayer." + mediaPlayer); Log.e(TAG, "doSetupNotification() - unexpectedly there is no playable. No notification setup done. mediaPlayer." + mediaPlayer);