Skip to content

SDK / exoplayer

Go to a project
Commit 3c0e6178 by tonihei Committed by Oliver Woodman
Options

Merge AudioFocusManager methods to simplify control flow. 

handlePrepare/Stop/SetPlayReady can be merged together as they all
handle changes to the desires state of the player.

Also, simplify parts of the control flow by not mixing code that
determines if audio focus needs to be handled with code that actually
acquires or abandons the focus.

PiperOrigin-RevId: 299824857
parent 07cbfb65
Inline Side-by-side
Showing with 172 additions and 251 deletions
library/core/src/main/java/com/google/android/exoplayer2/AudioFocusManager.java
...@@ -24,7 +24,6 @@ import androidx.annotation.Nullable; ...@@ -24,7 +24,6 @@ import androidx.annotation.Nullable;
import androidx.annotation.RequiresApi; import androidx.annotation.RequiresApi;
import androidx.annotation.VisibleForTesting; import androidx.annotation.VisibleForTesting;
import com.google.android.exoplayer2.audio.AudioAttributes; import com.google.android.exoplayer2.audio.AudioAttributes;
import com.google.android.exoplayer2.source.MediaSource;
import com.google.android.exoplayer2.util.Assertions; import com.google.android.exoplayer2.util.Assertions;
import com.google.android.exoplayer2.util.Log; import com.google.android.exoplayer2.util.Log;
import com.google.android.exoplayer2.util.Util; import com.google.android.exoplayer2.util.Util;
...@@ -134,64 +133,38 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull; ...@@ -134,64 +133,38 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
/** /**
* Sets audio attributes that should be used to manage audio focus. * Sets audio attributes that should be used to manage audio focus.
* *
* <p>Call {@link #updateAudioFocus(boolean, int)} to update the audio focus based on these
* attributes.
*
* @param audioAttributes The audio attributes or {@code null} if audio focus should not be * @param audioAttributes The audio attributes or {@code null} if audio focus should not be
* managed automatically. * managed automatically.
* @param playWhenReady The current state of {@link ExoPlayer#getPlayWhenReady()}.
* @param playerState The current player state; {@link ExoPlayer#getPlaybackState()}.
* @return A {@link PlayerCommand} to execute on the player.
*/ */
@PlayerCommand public void setAudioAttributes(@Nullable AudioAttributes audioAttributes) {
public int setAudioAttributes(
@Nullable AudioAttributes audioAttributes, boolean playWhenReady, int playerState) {
if (!Util.areEqual(this.audioAttributes, audioAttributes)) { if (!Util.areEqual(this.audioAttributes, audioAttributes)) {
this.audioAttributes = audioAttributes; this.audioAttributes = audioAttributes;
focusGain = convertAudioAttributesToFocusGain(audioAttributes); focusGain = convertAudioAttributesToFocusGain(audioAttributes);
Assertions.checkArgument( Assertions.checkArgument(
focusGain == C.AUDIOFOCUS_GAIN || focusGain == C.AUDIOFOCUS_NONE, focusGain == C.AUDIOFOCUS_GAIN || focusGain == C.AUDIOFOCUS_NONE,
"Automatic handling of audio focus is only available for USAGE_MEDIA and USAGE_GAME."); "Automatic handling of audio focus is only available for USAGE_MEDIA and USAGE_GAME.");
if (playWhenReady
&& (playerState == Player.STATE_BUFFERING || playerState == Player.STATE_READY)) {
return requestAudioFocus();
}
} }
return playerState == Player.STATE_IDLE
? handleIdle(playWhenReady)
: handlePrepare(playWhenReady);
} }
/** /**
* Called by a player as part of {@link ExoPlayer#prepare(MediaSource, boolean, boolean)}. * Called by the player to abandon or request audio focus based on the desired player state.
*
* @param playWhenReady The current state of {@link ExoPlayer#getPlayWhenReady()}.
* @return A {@link PlayerCommand} to execute on the player.
*/
@PlayerCommand
public int handlePrepare(boolean playWhenReady) {
return playWhenReady ? requestAudioFocus() : PLAYER_COMMAND_DO_NOT_PLAY;
}
/**
* Called by the player as part of {@link ExoPlayer#setPlayWhenReady(boolean)}.
* *
* @param playWhenReady The desired value of playWhenReady. * @param playWhenReady The desired value of playWhenReady.
* @param playerState The current state of the player. * @param playbackState The desired playback state.
* @return A {@link PlayerCommand} to execute on the player. * @return A {@link PlayerCommand} to execute on the player.
*/ */
@PlayerCommand @PlayerCommand
public int handleSetPlayWhenReady(boolean playWhenReady, int playerState) { public int updateAudioFocus(boolean playWhenReady, @Player.State int playbackState) {
if (!playWhenReady) { if (!shouldHandleAudioFocus(playbackState)) {
abandonAudioFocus(); if (audioFocusState != AUDIO_FOCUS_STATE_NO_FOCUS) {
return PLAYER_COMMAND_DO_NOT_PLAY; abandonAudioFocus();
}
return playWhenReady ? PLAYER_COMMAND_PLAY_WHEN_READY : PLAYER_COMMAND_DO_NOT_PLAY;
} }
return playWhenReady ? requestAudioFocus() : PLAYER_COMMAND_DO_NOT_PLAY;
return playerState == Player.STATE_IDLE ? handleIdle(playWhenReady) : requestAudioFocus();
}
/** Called by the player as part of {@link ExoPlayer#stop(boolean)}. */
public void handleStop() {
abandonAudioFocus(/* forceAbandon= */ true);
} }
// Internal methods. // Internal methods.
...@@ -201,22 +174,14 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull; ...@@ -201,22 +174,14 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
return focusListener; return focusListener;
} }
@PlayerCommand private boolean shouldHandleAudioFocus(@Player.State int playbackState) {
private int handleIdle(boolean playWhenReady) { return playbackState != Player.STATE_IDLE && focusGain == C.AUDIOFOCUS_GAIN;
return playWhenReady ? PLAYER_COMMAND_PLAY_WHEN_READY : PLAYER_COMMAND_DO_NOT_PLAY;
} }
@PlayerCommand @PlayerCommand
private int requestAudioFocus() { private int requestAudioFocus() {
int focusRequestResult; int focusRequestResult;
if (focusGain == C.AUDIOFOCUS_NONE) {
if (audioFocusState != AUDIO_FOCUS_STATE_NO_FOCUS) {
abandonAudioFocus(/* forceAbandon= */ true);
}
return PLAYER_COMMAND_PLAY_WHEN_READY;
}
if (audioFocusState == AUDIO_FOCUS_STATE_NO_FOCUS) { if (audioFocusState == AUDIO_FOCUS_STATE_NO_FOCUS) {
if (Util.SDK_INT >= 26) { if (Util.SDK_INT >= 26) {
focusRequestResult = requestAudioFocusV26(); focusRequestResult = requestAudioFocusV26();
...@@ -239,24 +204,15 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull; ...@@ -239,24 +204,15 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
} }
private void abandonAudioFocus() { private void abandonAudioFocus() {
abandonAudioFocus(/* forceAbandon= */ false); if (audioFocusState == AUDIO_FOCUS_STATE_NO_FOCUS) {
}
private void abandonAudioFocus(boolean forceAbandon) {
if (focusGain == C.AUDIOFOCUS_NONE && audioFocusState == AUDIO_FOCUS_STATE_NO_FOCUS) {
return; return;
} }
if (Util.SDK_INT >= 26) {
if (focusGain != C.AUDIOFOCUS_GAIN abandonAudioFocusV26();
|| audioFocusState == AUDIO_FOCUS_STATE_LOST_FOCUS } else {
|| forceAbandon) { abandonAudioFocusDefault();
if (Util.SDK_INT >= 26) {
abandonAudioFocusV26();
} else {
abandonAudioFocusDefault();
}
audioFocusState = AUDIO_FOCUS_STATE_NO_FOCUS;
} }
audioFocusState = AUDIO_FOCUS_STATE_NO_FOCUS;
} }
private int requestAudioFocusDefault() { private int requestAudioFocusDefault() {
...@@ -312,7 +268,6 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull; ...@@ -312,7 +268,6 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
*/ */
@C.AudioFocusGain @C.AudioFocusGain
private static int convertAudioAttributesToFocusGain(@Nullable AudioAttributes audioAttributes) { private static int convertAudioAttributesToFocusGain(@Nullable AudioAttributes audioAttributes) {
if (audioAttributes == null) { if (audioAttributes == null) {
// Don't handle audio focus. It may be either video only contents or developers // Don't handle audio focus. It may be either video only contents or developers
// want to have more finer grained control. (e.g. adding audio focus listener) // want to have more finer grained control. (e.g. adding audio focus listener)
...@@ -414,7 +369,7 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull; ...@@ -414,7 +369,7 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
break; break;
case AUDIO_FOCUS_STATE_LOST_FOCUS: case AUDIO_FOCUS_STATE_LOST_FOCUS:
playerControl.executePlayerCommand(PLAYER_COMMAND_DO_NOT_PLAY); playerControl.executePlayerCommand(PLAYER_COMMAND_DO_NOT_PLAY);
abandonAudioFocus(/* forceAbandon= */ true); abandonAudioFocus();
break; break;
case AUDIO_FOCUS_STATE_LOSS_TRANSIENT: case AUDIO_FOCUS_STATE_LOSS_TRANSIENT:
playerControl.executePlayerCommand(PLAYER_COMMAND_WAIT_FOR_CALLBACK); playerControl.executePlayerCommand(PLAYER_COMMAND_WAIT_FOR_CALLBACK);
......
library/core/src/main/java/com/google/android/exoplayer2/SimpleExoPlayer.java
...@@ -686,10 +686,10 @@ public class SimpleExoPlayer extends BasePlayer ...@@ -686,10 +686,10 @@ public class SimpleExoPlayer extends BasePlayer
} }
} }
audioFocusManager.setAudioAttributes(handleAudioFocus ? audioAttributes : null);
boolean playWhenReady = getPlayWhenReady();
@AudioFocusManager.PlayerCommand @AudioFocusManager.PlayerCommand
int playerCommand = int playerCommand = audioFocusManager.updateAudioFocus(playWhenReady, getPlaybackState());
audioFocusManager.setAudioAttributes(
handleAudioFocus ? audioAttributes : null, getPlayWhenReady(), getPlaybackState());
updatePlayWhenReady(getPlayWhenReady(), playerCommand); updatePlayWhenReady(getPlayWhenReady(), playerCommand);
} }
...@@ -1190,7 +1190,7 @@ public class SimpleExoPlayer extends BasePlayer ...@@ -1190,7 +1190,7 @@ public class SimpleExoPlayer extends BasePlayer
this.mediaSource = mediaSource; this.mediaSource = mediaSource;
mediaSource.addEventListener(eventHandler, analyticsCollector); mediaSource.addEventListener(eventHandler, analyticsCollector);
@AudioFocusManager.PlayerCommand @AudioFocusManager.PlayerCommand
int playerCommand = audioFocusManager.handlePrepare(getPlayWhenReady()); int playerCommand = audioFocusManager.updateAudioFocus(getPlayWhenReady(), Player.STATE_BUFFERING);
updatePlayWhenReady(getPlayWhenReady(), playerCommand); updatePlayWhenReady(getPlayWhenReady(), playerCommand);
player.prepare(mediaSource, resetPosition, resetState); player.prepare(mediaSource, resetPosition, resetState);
} }
...@@ -1199,7 +1199,7 @@ public class SimpleExoPlayer extends BasePlayer ...@@ -1199,7 +1199,7 @@ public class SimpleExoPlayer extends BasePlayer
public void setPlayWhenReady(boolean playWhenReady) { public void setPlayWhenReady(boolean playWhenReady) {
verifyApplicationThread(); verifyApplicationThread();
@AudioFocusManager.PlayerCommand @AudioFocusManager.PlayerCommand
int playerCommand = audioFocusManager.handleSetPlayWhenReady(playWhenReady, getPlaybackState()); int playerCommand = audioFocusManager.updateAudioFocus(playWhenReady, getPlaybackState());
updatePlayWhenReady(playWhenReady, playerCommand); updatePlayWhenReady(playWhenReady, playerCommand);
} }
...@@ -1278,6 +1278,7 @@ public class SimpleExoPlayer extends BasePlayer ...@@ -1278,6 +1278,7 @@ public class SimpleExoPlayer extends BasePlayer
@Override @Override
public void stop(boolean reset) { public void stop(boolean reset) {
verifyApplicationThread(); verifyApplicationThread();
audioFocusManager.updateAudioFocus(getPlayWhenReady(), Player.STATE_IDLE);
player.stop(reset); player.stop(reset);
if (mediaSource != null) { if (mediaSource != null) {
mediaSource.removeEventListener(analyticsCollector); mediaSource.removeEventListener(analyticsCollector);
...@@ -1286,7 +1287,6 @@ public class SimpleExoPlayer extends BasePlayer ...@@ -1286,7 +1287,6 @@ public class SimpleExoPlayer extends BasePlayer
mediaSource = null; mediaSource = null;
} }
} }
audioFocusManager.handleStop();
currentCues = Collections.emptyList(); currentCues = Collections.emptyList();
} }
...@@ -1294,7 +1294,7 @@ public class SimpleExoPlayer extends BasePlayer ...@@ -1294,7 +1294,7 @@ public class SimpleExoPlayer extends BasePlayer
public void release() { public void release() {
verifyApplicationThread(); verifyApplicationThread();
audioBecomingNoisyManager.setEnabled(false); audioBecomingNoisyManager.setEnabled(false);
audioFocusManager.handleStop(); audioFocusManager.updateAudioFocus(/* playWhenReady= */ false, Player.STATE_IDLE);
wakeLockManager.setStayAwake(false); wakeLockManager.setStayAwake(false);
wifiLockManager.setStayAwake(false); wifiLockManager.setStayAwake(false);
player.release(); player.release();
......
library/core/src/test/java/com/google/android/exoplayer2/AudioFocusManagerTest.java
...@@ -65,13 +65,11 @@ public class AudioFocusManagerTest { ...@@ -65,13 +65,11 @@ public class AudioFocusManagerTest {
@Test @Test
public void setAudioAttributes_withNullUsage_doesNotManageAudioFocus() { public void setAudioAttributes_withNullUsage_doesNotManageAudioFocus() {
// Ensure that NULL audio attributes -> don't manage audio focus // Ensure that NULL audio attributes -> don't manage audio focus
assertThat( audioFocusManager.setAudioAttributes(/* audioAttributes= */ null);
audioFocusManager.setAudioAttributes(
/* audioAttributes= */ null, /* playWhenReady= */ false, Player.STATE_IDLE)) assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ false, Player.STATE_IDLE))
.isEqualTo(PLAYER_COMMAND_DO_NOT_PLAY); .isEqualTo(PLAYER_COMMAND_DO_NOT_PLAY);
assertThat( assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_READY))
audioFocusManager.setAudioAttributes(
/* audioAttributes= */ null, /* playWhenReady= */ true, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY); .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
ShadowAudioManager.AudioFocusRequest request = ShadowAudioManager.AudioFocusRequest request =
Shadows.shadowOf(audioManager).getLastAudioFocusRequest(); Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
...@@ -85,18 +83,17 @@ public class AudioFocusManagerTest { ...@@ -85,18 +83,17 @@ public class AudioFocusManagerTest {
AudioAttributes media = new AudioAttributes.Builder().setUsage(C.USAGE_MEDIA).build(); AudioAttributes media = new AudioAttributes.Builder().setUsage(C.USAGE_MEDIA).build();
Shadows.shadowOf(audioManager) Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED); .setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
assertThat( audioFocusManager.setAudioAttributes(media);
audioFocusManager.setAudioAttributes( assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_READY))
media, /* playWhenReady= */ true, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY); .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
ShadowAudioManager.AudioFocusRequest request = ShadowAudioManager.AudioFocusRequest request =
Shadows.shadowOf(audioManager).getLastAudioFocusRequest(); Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
assertThat(request.durationHint).isEqualTo(AudioManager.AUDIOFOCUS_GAIN); assertThat(request.durationHint).isEqualTo(AudioManager.AUDIOFOCUS_GAIN);
// Ensure that setting null audio attributes with audio focus releases audio focus. // Ensure that setting null audio attributes with audio focus releases audio focus.
assertThat( audioFocusManager.setAudioAttributes(/* audioAttributes= */ null);
audioFocusManager.setAudioAttributes(
/* audioAttributes= */ null, /* playWhenReady= */ true, Player.STATE_READY)) assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY); .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
AudioManager.OnAudioFocusChangeListener lastRequest = AudioManager.OnAudioFocusChangeListener lastRequest =
Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusListener(); Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusListener();
...@@ -110,18 +107,16 @@ public class AudioFocusManagerTest { ...@@ -110,18 +107,16 @@ public class AudioFocusManagerTest {
AudioAttributes media = new AudioAttributes.Builder().setUsage(C.USAGE_MEDIA).build(); AudioAttributes media = new AudioAttributes.Builder().setUsage(C.USAGE_MEDIA).build();
Shadows.shadowOf(audioManager) Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED); .setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
assertThat( audioFocusManager.setAudioAttributes(media);
audioFocusManager.setAudioAttributes( assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_READY))
media, /* playWhenReady= */ true, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY); .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
ShadowAudioManager.AudioFocusRequest request = ShadowAudioManager.AudioFocusRequest request =
Shadows.shadowOf(audioManager).getLastAudioFocusRequest(); Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
assertThat(getAudioFocusGainFromRequest(request)).isEqualTo(AudioManager.AUDIOFOCUS_GAIN); assertThat(getAudioFocusGainFromRequest(request)).isEqualTo(AudioManager.AUDIOFOCUS_GAIN);
// Ensure that setting null audio attributes with audio focus releases audio focus. // Ensure that setting null audio attributes with audio focus releases audio focus.
assertThat( audioFocusManager.setAudioAttributes(/* audioAttributes= */ null);
audioFocusManager.setAudioAttributes( assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_READY))
/* audioAttributes= */ null, /* playWhenReady= */ true, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY); .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
AudioFocusRequest lastRequest = AudioFocusRequest lastRequest =
Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusRequest(); Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusRequest();
...@@ -130,10 +125,10 @@ public class AudioFocusManagerTest { ...@@ -130,10 +125,10 @@ public class AudioFocusManagerTest {
@Test @Test
public void setAudioAttributes_withUsageAlarm_throwsIllegalArgumentException() { public void setAudioAttributes_withUsageAlarm_throwsIllegalArgumentException() {
// Ensure that audio attributes that map to AUDIOFOCUS_GAIN_TRANSIENT* throw // Ensure that audio attributes that map to AUDIOFOCUS_GAIN_TRANSIENT* throw.
AudioAttributes alarm = new AudioAttributes.Builder().setUsage(C.USAGE_ALARM).build(); AudioAttributes alarm = new AudioAttributes.Builder().setUsage(C.USAGE_ALARM).build();
try { try {
audioFocusManager.setAudioAttributes(alarm, /* playWhenReady= */ false, Player.STATE_IDLE); audioFocusManager.setAudioAttributes(alarm);
fail(); fail();
} catch (IllegalArgumentException e) { } catch (IllegalArgumentException e) {
// Expected // Expected
...@@ -147,9 +142,9 @@ public class AudioFocusManagerTest { ...@@ -147,9 +142,9 @@ public class AudioFocusManagerTest {
Shadows.shadowOf(audioManager) Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED); .setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
assertThat( audioFocusManager.setAudioAttributes(media);
audioFocusManager.setAudioAttributes(
media, /* playWhenReady= */ true, Player.STATE_READY)) assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY); .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
ShadowAudioManager.AudioFocusRequest request = ShadowAudioManager.AudioFocusRequest request =
Shadows.shadowOf(audioManager).getLastAudioFocusRequest(); Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
...@@ -163,9 +158,9 @@ public class AudioFocusManagerTest { ...@@ -163,9 +158,9 @@ public class AudioFocusManagerTest {
Shadows.shadowOf(audioManager) Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED); .setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
assertThat( audioFocusManager.setAudioAttributes(media);
audioFocusManager.setAudioAttributes(
media, /* playWhenReady= */ true, Player.STATE_ENDED)) assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_ENDED))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY); .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
ShadowAudioManager.AudioFocusRequest request = ShadowAudioManager.AudioFocusRequest request =
Shadows.shadowOf(audioManager).getLastAudioFocusRequest(); Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
...@@ -173,42 +168,131 @@ public class AudioFocusManagerTest { ...@@ -173,42 +168,131 @@ public class AudioFocusManagerTest {
} }
@Test @Test
public void handlePrepare_afterSetAudioAttributes_setsPlayerCommandPlayWhenReady() { public void updateAudioFocusFromIdleToBuffering_setsPlayerCommandPlayWhenReady() {
// Ensure that when playWhenReady is true while the player is IDLE, audio focus is only // Ensure that when playWhenReady is true while the player is IDLE, audio focus is only
// requested after calling handlePrepare. // requested after calling prepare (= changing the state to BUFFERING).
AudioAttributes media = new AudioAttributes.Builder().setUsage(C.USAGE_MEDIA).build(); AudioAttributes media = new AudioAttributes.Builder().setUsage(C.USAGE_MEDIA).build();
Shadows.shadowOf(audioManager) Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED); .setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
audioFocusManager.setAudioAttributes(media);
assertThat( assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_IDLE))
audioFocusManager.setAudioAttributes(
media, /* playWhenReady= */ true, Player.STATE_IDLE))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY); .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
assertThat(Shadows.shadowOf(audioManager).getLastAudioFocusRequest()).isNull(); assertThat(Shadows.shadowOf(audioManager).getLastAudioFocusRequest()).isNull();
assertThat(audioFocusManager.handlePrepare(/* playWhenReady= */ true)) assertThat(
audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_BUFFERING))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY); .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
ShadowAudioManager.AudioFocusRequest request =
Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
assertThat(getAudioFocusGainFromRequest(request)).isEqualTo(AudioManager.AUDIOFOCUS_GAIN);
} }
@Test @Test
public void handleSetPlayWhenReady_afterSetAudioAttributes_setsPlayerCommandPlayWhenReady() { public void updateAudioFocusFromPausedToPlaying_setsPlayerCommandPlayWhenReady() {
// Ensure that audio focus is not requested until playWhenReady is true. // Ensure that audio focus is not requested until playWhenReady is true.
AudioAttributes media = new AudioAttributes.Builder().setUsage(C.USAGE_MEDIA).build(); AudioAttributes media = new AudioAttributes.Builder().setUsage(C.USAGE_MEDIA).build();
Shadows.shadowOf(audioManager) Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED); .setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
audioFocusManager.setAudioAttributes(media);
assertThat(audioFocusManager.handlePrepare(/* playWhenReady= */ false)) assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ false, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_DO_NOT_PLAY); .isEqualTo(PLAYER_COMMAND_DO_NOT_PLAY);
assertThat(Shadows.shadowOf(audioManager).getLastAudioFocusRequest()).isNull(); assertThat(Shadows.shadowOf(audioManager).getLastAudioFocusRequest()).isNull();
assertThat(
audioFocusManager.setAudioAttributes( assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_READY))
media, /* playWhenReady= */ false, Player.STATE_READY)) .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
.isEqualTo(PLAYER_COMMAND_DO_NOT_PLAY); ShadowAudioManager.AudioFocusRequest request =
assertThat(Shadows.shadowOf(audioManager).getLastAudioFocusRequest()).isNull(); Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
assertThat( assertThat(getAudioFocusGainFromRequest(request)).isEqualTo(AudioManager.AUDIOFOCUS_GAIN);
audioFocusManager.handleSetPlayWhenReady(/* playWhenReady= */ true, Player.STATE_READY)) }
@Test
@Config(maxSdk = 25)
public void updateAudioFocusFromReadyToIdle_abandonsAudioFocus() {
// Ensure that stopping the player (=changing state to idle) abandons audio focus.
AudioAttributes media =
new AudioAttributes.Builder()
.setUsage(C.USAGE_MEDIA)
.setContentType(C.CONTENT_TYPE_SPEECH)
.build();
Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
audioFocusManager.setAudioAttributes(media);
assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusListener()).isNull();
ShadowAudioManager.AudioFocusRequest request =
Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_IDLE))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusListener())
.isEqualTo(request.listener);
}
@Test
@Config(minSdk = 26, maxSdk = TARGET_SDK)
public void updateAudioFocusFromReadyToIdle_abandonsAudioFocus_v26() {
// Ensure that stopping the player (=changing state to idle) abandons audio focus.
AudioAttributes media =
new AudioAttributes.Builder()
.setUsage(C.USAGE_MEDIA)
.setContentType(C.CONTENT_TYPE_SPEECH)
.build();
Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
audioFocusManager.setAudioAttributes(media);
assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY); .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusRequest()).isNull();
ShadowAudioManager.AudioFocusRequest request =
Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_IDLE))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusRequest())
.isEqualTo(request.audioFocusRequest);
}
@Test
@Config(maxSdk = 25)
public void updateAudioFocusFromReadyToIdle_withoutHandlingAudioFocus_isNoOp() {
// Ensure that changing state to idle is a no-op if audio focus isn't handled.
Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
audioFocusManager.setAudioAttributes(null);
assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ false, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_DO_NOT_PLAY);
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusListener()).isNull();
ShadowAudioManager.AudioFocusRequest request =
Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
assertThat(request).isNull();
assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ false, Player.STATE_IDLE))
.isEqualTo(PLAYER_COMMAND_DO_NOT_PLAY);
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusListener()).isNull();
}
@Test
@Config(minSdk = 26, maxSdk = TARGET_SDK)
public void updateAudioFocusFromReadyToIdle_withoutHandlingAudioFocus_isNoOp_v26() {
// Ensure that changing state to idle is a no-op if audio focus isn't handled.
Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
audioFocusManager.setAudioAttributes(null);
assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ false, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_DO_NOT_PLAY);
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusRequest()).isNull();
ShadowAudioManager.AudioFocusRequest request =
Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
assertThat(request).isNull();
assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ false, Player.STATE_IDLE))
.isEqualTo(PLAYER_COMMAND_DO_NOT_PLAY);
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusRequest()).isNull();
} }
@Test @Test
...@@ -217,17 +301,17 @@ public class AudioFocusManagerTest { ...@@ -217,17 +301,17 @@ public class AudioFocusManagerTest {
// AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK, and returns to the default value after focus is // AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK, and returns to the default value after focus is
// regained. // regained.
AudioAttributes media = new AudioAttributes.Builder().setUsage(C.USAGE_MEDIA).build(); AudioAttributes media = new AudioAttributes.Builder().setUsage(C.USAGE_MEDIA).build();
Shadows.shadowOf(audioManager) Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED); .setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
assertThat( audioFocusManager.setAudioAttributes(media);
audioFocusManager.setAudioAttributes(
media, /* playWhenReady= */ true, Player.STATE_READY)) assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY); .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
audioFocusManager audioFocusManager
.getFocusListener() .getFocusListener()
.onAudioFocusChange(AudioManager.AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK); .onAudioFocusChange(AudioManager.AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK);
assertThat(testPlayerControl.lastVolumeMultiplier).isLessThan(1.0f); assertThat(testPlayerControl.lastVolumeMultiplier).isLessThan(1.0f);
assertThat(testPlayerControl.lastPlayerCommand).isEqualTo(NO_COMMAND_RECEIVED); assertThat(testPlayerControl.lastPlayerCommand).isEqualTo(NO_COMMAND_RECEIVED);
audioFocusManager.getFocusListener().onAudioFocusChange(AudioManager.AUDIOFOCUS_GAIN); audioFocusManager.getFocusListener().onAudioFocusChange(AudioManager.AUDIOFOCUS_GAIN);
...@@ -243,12 +327,11 @@ public class AudioFocusManagerTest { ...@@ -243,12 +327,11 @@ public class AudioFocusManagerTest {
.setUsage(C.USAGE_MEDIA) .setUsage(C.USAGE_MEDIA)
.setContentType(C.CONTENT_TYPE_SPEECH) .setContentType(C.CONTENT_TYPE_SPEECH)
.build(); .build();
Shadows.shadowOf(audioManager) Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED); .setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
assertThat( audioFocusManager.setAudioAttributes(media);
audioFocusManager.setAudioAttributes(
media, /* playWhenReady= */ true, Player.STATE_READY)) assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY); .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
audioFocusManager audioFocusManager
...@@ -265,12 +348,11 @@ public class AudioFocusManagerTest { ...@@ -265,12 +348,11 @@ public class AudioFocusManagerTest {
// Ensure that the player is commanded to pause when audio focus is lost with // Ensure that the player is commanded to pause when audio focus is lost with
// AUDIOFOCUS_LOSS_TRANSIENT. // AUDIOFOCUS_LOSS_TRANSIENT.
AudioAttributes media = new AudioAttributes.Builder().setUsage(C.USAGE_MEDIA).build(); AudioAttributes media = new AudioAttributes.Builder().setUsage(C.USAGE_MEDIA).build();
Shadows.shadowOf(audioManager) Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED); .setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
assertThat( audioFocusManager.setAudioAttributes(media);
audioFocusManager.setAudioAttributes(
media, /* playWhenReady= */ true, Player.STATE_READY)) assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY); .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
audioFocusManager.getFocusListener().onAudioFocusChange(AudioManager.AUDIOFOCUS_LOSS_TRANSIENT); audioFocusManager.getFocusListener().onAudioFocusChange(AudioManager.AUDIOFOCUS_LOSS_TRANSIENT);
...@@ -288,12 +370,11 @@ public class AudioFocusManagerTest { ...@@ -288,12 +370,11 @@ public class AudioFocusManagerTest {
.setUsage(C.USAGE_MEDIA) .setUsage(C.USAGE_MEDIA)
.setContentType(C.CONTENT_TYPE_SPEECH) .setContentType(C.CONTENT_TYPE_SPEECH)
.build(); .build();
Shadows.shadowOf(audioManager) Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED); .setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
assertThat( audioFocusManager.setAudioAttributes(media);
audioFocusManager.setAudioAttributes(
media, /* playWhenReady= */ true, Player.STATE_READY)) assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY); .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusListener()).isNull(); assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusListener()).isNull();
...@@ -315,12 +396,11 @@ public class AudioFocusManagerTest { ...@@ -315,12 +396,11 @@ public class AudioFocusManagerTest {
.setUsage(C.USAGE_MEDIA) .setUsage(C.USAGE_MEDIA)
.setContentType(C.CONTENT_TYPE_SPEECH) .setContentType(C.CONTENT_TYPE_SPEECH)
.build(); .build();
Shadows.shadowOf(audioManager) Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED); .setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
assertThat( audioFocusManager.setAudioAttributes(media);
audioFocusManager.setAudioAttributes(
media, /* playWhenReady= */ true, Player.STATE_READY)) assertThat(audioFocusManager.updateAudioFocus(/* playWhenReady= */ true, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY); .isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusRequest()).isNull(); assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusRequest()).isNull();
...@@ -330,120 +410,6 @@ public class AudioFocusManagerTest { ...@@ -330,120 +410,6 @@ public class AudioFocusManagerTest {
.isEqualTo(Shadows.shadowOf(audioManager).getLastAudioFocusRequest().audioFocusRequest); .isEqualTo(Shadows.shadowOf(audioManager).getLastAudioFocusRequest().audioFocusRequest);
} }
@Test
@Config(maxSdk = 25)
public void handleStop_withAudioFocus_abandonsAudioFocus() {
// Ensure that handleStop causes AudioFocusManager to abandon audio focus.
AudioAttributes media =
new AudioAttributes.Builder()
.setUsage(C.USAGE_MEDIA)
.setContentType(C.CONTENT_TYPE_SPEECH)
.build();
Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
assertThat(
audioFocusManager.setAudioAttributes(
media, /* playWhenReady= */ true, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusListener()).isNull();
ShadowAudioManager.AudioFocusRequest request =
Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
audioFocusManager.handleStop();
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusListener())
.isEqualTo(request.listener);
}
@Test
@Config(minSdk = 26, maxSdk = TARGET_SDK)
public void handleStop_withAudioFocus_abandonsAudioFocus_v26() {
// Ensure that handleStop causes AudioFocusManager to abandon audio focus.
AudioAttributes media =
new AudioAttributes.Builder()
.setUsage(C.USAGE_MEDIA)
.setContentType(C.CONTENT_TYPE_SPEECH)
.build();
Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
assertThat(
audioFocusManager.setAudioAttributes(
media, /* playWhenReady= */ true, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_PLAY_WHEN_READY);
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusRequest()).isNull();
ShadowAudioManager.AudioFocusRequest request =
Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
audioFocusManager.handleStop();
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusRequest())
.isEqualTo(request.audioFocusRequest);
}
@Test
@Config(maxSdk = 25)
public void handleStop_withoutAudioFocus_stillAbandonsFocus() {
// Ensure that handleStop causes AudioFocusManager to call through to abandon audio focus
// even if focus wasn't requested.
AudioAttributes media =
new AudioAttributes.Builder()
.setUsage(C.USAGE_MEDIA)
.setContentType(C.CONTENT_TYPE_SPEECH)
.build();
Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
assertThat(
audioFocusManager.setAudioAttributes(
media, /* playWhenReady= */ false, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_DO_NOT_PLAY);
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusListener()).isNull();
ShadowAudioManager.AudioFocusRequest request =
Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
assertThat(request).isNull();
audioFocusManager.handleStop();
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusListener()).isNotNull();
}
@Test
@Config(maxSdk = 25)
public void handleStop_withoutHandlingAudioFocus_isNoOp() {
// Ensure that handleStop is a no-op if audio focus isn't handled.
Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
assertThat(
audioFocusManager.setAudioAttributes(
/* audioAttributes= */ null, /* playWhenReady= */ false, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_DO_NOT_PLAY);
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusListener()).isNull();
ShadowAudioManager.AudioFocusRequest request =
Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
assertThat(request).isNull();
audioFocusManager.handleStop();
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusListener()).isNull();
}
@Test
@Config(minSdk = 26, maxSdk = TARGET_SDK)
public void handleStop_withoutHandlingAudioFocus_isNoOp_v26() {
// Ensure that handleStop is a no-op if audio focus isn't handled.
Shadows.shadowOf(audioManager)
.setNextFocusRequestResponse(AudioManager.AUDIOFOCUS_REQUEST_GRANTED);
assertThat(
audioFocusManager.setAudioAttributes(
/* audioAttributes= */ null, /* playWhenReady= */ false, Player.STATE_READY))
.isEqualTo(PLAYER_COMMAND_DO_NOT_PLAY);
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusRequest()).isNull();
ShadowAudioManager.AudioFocusRequest request =
Shadows.shadowOf(audioManager).getLastAudioFocusRequest();
assertThat(request).isNull();
audioFocusManager.handleStop();
assertThat(Shadows.shadowOf(audioManager).getLastAbandonedAudioFocusRequest()).isNull();
}
private int getAudioFocusGainFromRequest(ShadowAudioManager.AudioFocusRequest audioFocusRequest) { private int getAudioFocusGainFromRequest(ShadowAudioManager.AudioFocusRequest audioFocusRequest) {
return Util.SDK_INT >= 26 return Util.SDK_INT >= 26
? audioFocusRequest.audioFocusRequest.getFocusGain() ? audioFocusRequest.audioFocusRequest.getFocusGain()
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment