blob: 13dd1154b8e873345b23f7ac802ba8c3c1d1e7a4 [file] [log] [blame]
/*
* Copyright 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.media2;
import static android.content.Context.KEYGUARD_SERVICE;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import android.app.Instrumentation;
import android.app.KeyguardManager;
import android.content.Context;
import android.content.res.AssetFileDescriptor;
import android.content.res.Resources;
import android.media.AudioManager;
import android.net.Uri;
import android.os.Build;
import android.os.ParcelFileDescriptor;
import android.os.PersistableBundle;
import android.os.PowerManager;
import android.view.SurfaceHolder;
import android.view.WindowManager;
import androidx.annotation.CallSuper;
import androidx.media.AudioAttributesCompat;
import androidx.media2.TestUtils.Monitor;
import androidx.test.platform.app.InstrumentationRegistry;
import androidx.test.rule.ActivityTestRule;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import java.io.IOException;
import java.net.HttpCookie;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.logging.Logger;
/**
* Base class for tests which use MediaPlayer2 to play audio or video.
*/
public class MediaPlayer2TestBase extends MediaTestBase {
private static final Logger LOG = Logger.getLogger(MediaPlayer2TestBase.class.getName());
protected static final int SLEEP_TIME = 1000;
protected static final int LONG_SLEEP_TIME = 6000;
protected static final int STREAM_RETRIES = 20;
protected Monitor mOnVideoSizeChangedCalled = new Monitor();
protected Monitor mOnVideoRenderingStartCalled = new Monitor();
protected Monitor mOnBufferingUpdateCalled = new Monitor();
protected Monitor mOnPrepareCalled = new Monitor();
protected Monitor mOnPlayCalled = new Monitor();
protected Monitor mOnDeselectTrackCalled = new Monitor();
protected Monitor mOnSeekCompleteCalled = new Monitor();
protected Monitor mOnCompletionCalled = new Monitor();
protected Monitor mOnInfoCalled = new Monitor();
protected Monitor mOnErrorCalled = new Monitor();
protected Monitor mOnMediaTimeDiscontinuityCalled = new Monitor();
protected int mCallStatus;
protected Context mContext;
protected Resources mResources;
protected ExecutorService mExecutor;
protected MediaPlayer2 mPlayer = null;
protected MediaPlayer2 mPlayer2 = null;
protected MediaStubActivity mActivity;
protected Instrumentation mInstrumentation;
protected final Object mEventCbLock = new Object();
protected List<MediaPlayer2.EventCallback> mEventCallbacks = new ArrayList<>();
protected final Object mEventCbLock2 = new Object();
protected List<MediaPlayer2.EventCallback> mEventCallbacks2 = new ArrayList<>();
@Rule
public ActivityTestRule<MediaStubActivity> mActivityRule =
new ActivityTestRule<>(MediaStubActivity.class);
public PowerManager.WakeLock mScreenLock;
private KeyguardManager mKeyguardManager;
private List<FileMediaItem> mFileMediaItems = new ArrayList<>();
// convenience functions to create MediaPlayer2
protected MediaPlayer2 createMediaPlayer2(Context context, Uri uri) {
return createMediaPlayer2(context, uri, null);
}
protected MediaPlayer2 createMediaPlayer2(Context context, Uri uri,
SurfaceHolder holder) {
AudioManager am = (AudioManager) context.getSystemService(Context.AUDIO_SERVICE);
int s = Build.VERSION.SDK_INT >= 21 ? am.generateAudioSessionId() : 0;
return createMediaPlayer2(context, uri, holder, null, s > 0 ? s : 0);
}
protected MediaPlayer2 createMediaPlayer2(Context context, Uri uri, SurfaceHolder holder,
AudioAttributesCompat audioAttributes, int audioSessionId) {
try {
MediaPlayer2 mp = createMediaPlayer2OnUiThread();
final AudioAttributesCompat aa = audioAttributes != null ? audioAttributes :
new AudioAttributesCompat.Builder().build();
mp.setAudioAttributes(aa);
mp.setAudioSessionId(audioSessionId);
mp.setMediaItem(new UriMediaItem.Builder(uri).build());
if (holder != null) {
mp.setSurface(holder.getSurface());
}
final Monitor onPrepareCalled = new Monitor();
ExecutorService executor = Executors.newFixedThreadPool(1);
MediaPlayer2.EventCallback ecb =
new MediaPlayer2.EventCallback() {
@Override
public void onInfo(
MediaPlayer2 mp, MediaItem item, int what, int extra) {
if (what == MediaPlayer2.MEDIA_INFO_PREPARED) {
onPrepareCalled.signal();
}
}
};
mp.setEventCallback(executor, ecb);
mp.prepare();
onPrepareCalled.waitForSignal();
mp.clearEventCallback();
executor.shutdown();
return mp;
} catch (IllegalArgumentException ex) {
LOG.warning("create failed:" + ex);
// fall through
} catch (SecurityException ex) {
LOG.warning("create failed:" + ex);
// fall through
} catch (InterruptedException ex) {
LOG.warning("create failed:" + ex);
// fall through
}
return null;
}
protected MediaPlayer2 createMediaPlayer2(Context context, int resid) {
AudioManager am = (AudioManager) context.getSystemService(Context.AUDIO_SERVICE);
int s = Build.VERSION.SDK_INT >= 21 ? am.generateAudioSessionId() : 0;
return createMediaPlayer2(context, resid, null, s > 0 ? s : 0);
}
protected MediaPlayer2 createMediaPlayer2(Context context, int resid,
AudioAttributesCompat audioAttributes, int audioSessionId) {
try (AssetFileDescriptor afd = context.getResources().openRawResourceFd(resid)) {
MediaPlayer2 mp = createMediaPlayer2OnUiThread();
final AudioAttributesCompat aa = audioAttributes != null ? audioAttributes :
new AudioAttributesCompat.Builder().build();
mp.setAudioAttributes(aa);
mp.setAudioSessionId(audioSessionId);
mp.setMediaItem(new FileMediaItem.Builder(
ParcelFileDescriptor.dup(afd.getFileDescriptor()),
afd.getStartOffset(),
afd.getLength()).build());
final Monitor onPrepareCalled = new Monitor();
ExecutorService executor = Executors.newFixedThreadPool(1);
MediaPlayer2.EventCallback ecb =
new MediaPlayer2.EventCallback() {
@Override
public void onInfo(
MediaPlayer2 mp, MediaItem item, int what, int extra) {
if (what == MediaPlayer2.MEDIA_INFO_PREPARED) {
onPrepareCalled.signal();
}
}
};
mp.setEventCallback(executor, ecb);
mp.prepare();
onPrepareCalled.waitForSignal();
mp.clearEventCallback();
executor.shutdown();
return mp;
} catch (IllegalArgumentException | SecurityException | InterruptedException
| IOException ex) {
LOG.warning("create failed:" + ex);
// fall through
}
return null;
}
private MediaPlayer2 createMediaPlayer2OnUiThread() {
final MediaPlayer2[] mp = new MediaPlayer2[1];
try {
mActivityRule.runOnUiThread(new Runnable() {
public void run() {
mp[0] = MediaPlayer2.create(mActivity);
}
});
} catch (Throwable throwable) {
fail("Failed to create MediaPlayer2 instance on UI thread.");
}
return mp[0];
}
@Before
@CallSuper
public void setUp() throws Throwable {
mInstrumentation = InstrumentationRegistry.getInstrumentation();
mKeyguardManager = (KeyguardManager)
mInstrumentation.getTargetContext().getSystemService(KEYGUARD_SERVICE);
mActivity = mActivityRule.getActivity();
mActivityRule.runOnUiThread(new Runnable() {
@Override
public void run() {
// Keep screen on while testing.
mActivity.getWindow().addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON);
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O_MR1) {
mActivity.setTurnScreenOn(true);
mActivity.setShowWhenLocked(true);
}
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
mKeyguardManager.requestDismissKeyguard(mActivity, null);
}
}
});
mInstrumentation.waitForIdleSync();
try {
mActivityRule.runOnUiThread(new Runnable() {
public void run() {
mPlayer = MediaPlayer2.create(mActivity);
mPlayer2 = MediaPlayer2.create(mActivity);
}
});
} catch (Throwable e) {
e.printStackTrace();
fail();
}
mContext = mActivityRule.getActivity();
mResources = mContext.getResources();
mExecutor = Executors.newFixedThreadPool(1);
setUpMP2ECb(mPlayer, mEventCbLock, mEventCallbacks);
setUpMP2ECb(mPlayer2, mEventCbLock2, mEventCallbacks2);
}
@After
@CallSuper
public void tearDown() throws Exception {
if (mPlayer != null) {
mPlayer.close();
mPlayer = null;
}
if (mPlayer2 != null) {
mPlayer2.close();
mPlayer2 = null;
}
mExecutor.shutdown();
mActivity = null;
for (FileMediaItem fitem : mFileMediaItems) {
assertTrue(fitem.isClosed());
}
}
protected void setUpMP2ECb(MediaPlayer2 mp, final Object cbLock,
final List<MediaPlayer2.EventCallback> ecbs) {
mp.setEventCallback(mExecutor, new MediaPlayer2.EventCallback() {
@Override
public void onVideoSizeChanged(MediaPlayer2 mp, MediaItem item, int w, int h) {
synchronized (cbLock) {
for (MediaPlayer2.EventCallback ecb : ecbs) {
ecb.onVideoSizeChanged(mp, item, w, h);
}
}
}
@Override
public void onTimedMetaDataAvailable(MediaPlayer2 mp, MediaItem item,
TimedMetaData data) {
synchronized (cbLock) {
for (MediaPlayer2.EventCallback ecb : ecbs) {
ecb.onTimedMetaDataAvailable(mp, item, data);
}
}
}
@Override
public void onError(MediaPlayer2 mp, MediaItem item, int what, int extra) {
synchronized (cbLock) {
for (MediaPlayer2.EventCallback ecb : ecbs) {
ecb.onError(mp, item, what, extra);
}
}
}
@Override
public void onInfo(MediaPlayer2 mp, MediaItem item, int what, int extra) {
synchronized (cbLock) {
for (MediaPlayer2.EventCallback ecb : ecbs) {
ecb.onInfo(mp, item, what, extra);
}
}
}
@Override
public void onCallCompleted(
MediaPlayer2 mp, MediaItem item, int what, int status) {
synchronized (cbLock) {
for (MediaPlayer2.EventCallback ecb : ecbs) {
ecb.onCallCompleted(mp, item, what, status);
}
}
}
@Override
public void onMediaTimeDiscontinuity(MediaPlayer2 mp, MediaItem item,
MediaTimestamp timestamp) {
synchronized (cbLock) {
for (MediaPlayer2.EventCallback ecb : ecbs) {
ecb.onMediaTimeDiscontinuity(mp, item, timestamp);
}
}
}
@Override
public void onCommandLabelReached(MediaPlayer2 mp, Object label) {
synchronized (cbLock) {
for (MediaPlayer2.EventCallback ecb : ecbs) {
ecb.onCommandLabelReached(mp, label);
}
}
}
@Override
public void onSubtitleData(MediaPlayer2 mp, MediaItem item,
final SubtitleData data) {
synchronized (cbLock) {
for (MediaPlayer2.EventCallback ecb : ecbs) {
ecb.onSubtitleData(mp, item, data);
}
}
}
});
}
// returns true on success
protected boolean loadResource(int resid) throws Exception {
/* FIXME: ensure device has capability.
if (!MediaUtils.hasCodecsForResource(mContext, resid)) {
return false;
}
*/
try (AssetFileDescriptor afd = mResources.openRawResourceFd(resid)) {
FileMediaItem item = new FileMediaItem.Builder(
ParcelFileDescriptor.dup(afd.getFileDescriptor()),
afd.getStartOffset(), afd.getLength()).build();
mFileMediaItems.add(item);
mPlayer.setMediaItem(item);
}
return true;
}
protected MediaItem createDataSourceDesc(int resid) throws Exception {
/* FIXME: ensure device has capability.
if (!MediaUtils.hasCodecsForResource(mContext, resid)) {
return null;
}
*/
try (AssetFileDescriptor afd = mResources.openRawResourceFd(resid)) {
FileMediaItem item = new FileMediaItem.Builder(
ParcelFileDescriptor.dup(afd.getFileDescriptor()),
afd.getStartOffset(), afd.getLength()).build();
mFileMediaItems.add(item);
return item;
}
}
protected boolean checkLoadResource(int resid) throws Exception {
return loadResource(resid);
/* FIXME: ensure device has capability.
return MediaUtils.check(loadResource(resid), "no decoder found");
*/
}
protected void playLiveVideoTest(String path, int playTime) throws Exception {
playVideoWithRetries(path, null, null, playTime);
}
protected void playLiveAudioOnlyTest(String path, int playTime) throws Exception {
playVideoWithRetries(path, -1, -1, playTime);
}
protected void playVideoTest(String path, int width, int height) throws Exception {
playVideoWithRetries(path, width, height, 0);
}
protected void playVideoWithRetries(String path, Integer width, Integer height, int playTime)
throws Exception {
boolean playedSuccessfully = false;
final Uri uri = Uri.parse(path);
for (int i = 0; i < STREAM_RETRIES; i++) {
try {
mPlayer.setMediaItem(new UriMediaItem.Builder(uri).build());
playLoadedVideo(width, height, playTime);
playedSuccessfully = true;
break;
} catch (PrepareFailedException e) {
// prepare() can fail because of network issues, so try again
LOG.warning("prepare() failed on try " + i + ", trying playback again");
}
}
assertTrue("Stream did not play successfully after all attempts", playedSuccessfully);
}
protected void playVideoTest(int resid, int width, int height) throws Exception {
if (!checkLoadResource(resid)) {
return; // skip
}
playLoadedVideo(width, height, 0);
}
protected void playLiveVideoTest(
Uri uri, Map<String, String> headers, List<HttpCookie> cookies,
int playTime) throws Exception {
playVideoWithRetries(uri, headers, cookies, null /* width */, null /* height */, playTime);
}
protected void playVideoWithRetries(
Uri uri, Map<String, String> headers, List<HttpCookie> cookies,
Integer width, Integer height, int playTime) throws Exception {
boolean playedSuccessfully = false;
for (int i = 0; i < STREAM_RETRIES; i++) {
try {
mPlayer.setMediaItem(new UriMediaItem.Builder(uri, headers, cookies).build());
playLoadedVideo(width, height, playTime);
playedSuccessfully = true;
break;
} catch (PrepareFailedException e) {
// prepare() can fail because of network issues, so try again
// playLoadedVideo already has reset the player so we can try again safely.
LOG.warning("prepare() failed on try " + i + ", trying playback again");
}
}
assertTrue("Stream did not play successfully after all attempts", playedSuccessfully);
}
/**
* Play a video which has already been loaded with setMediaItem().
*
* @param width width of the video to verify, or null to skip verification
* @param height height of the video to verify, or null to skip verification
* @param playTime length of time to play video, or 0 to play entire video.
* with a non-negative value, this method stops the playback after the length of
* time or the duration the video is elapsed. With a value of -1,
* this method simply starts the video and returns immediately without
* stoping the video playback.
*/
protected void playLoadedVideo(final Integer width, final Integer height, int playTime)
throws Exception {
final float volume = 0.5f;
boolean audioOnly = (width != null && width.intValue() == -1)
|| (height != null && height.intValue() == -1);
mPlayer.setSurface(mActivity.getSurfaceHolder().getSurface());
synchronized (mEventCbLock) {
mEventCallbacks.add(new MediaPlayer2.EventCallback() {
@Override
public void onVideoSizeChanged(MediaPlayer2 mp, MediaItem item, int w, int h) {
if (w == 0 && h == 0) {
// A size of 0x0 can be sent initially one time when using NuPlayer.
assertFalse(mOnVideoSizeChangedCalled.isSignalled());
return;
}
mOnVideoSizeChangedCalled.signal();
if (width != null) {
assertEquals(width.intValue(), w);
}
if (height != null) {
assertEquals(height.intValue(), h);
}
}
@Override
public void onError(MediaPlayer2 mp, MediaItem item, int what, int extra) {
fail("Media player had error " + what + " playing video");
}
@Override
public void onInfo(MediaPlayer2 mp, MediaItem item, int what, int extra) {
if (what == MediaPlayer2.MEDIA_INFO_VIDEO_RENDERING_START) {
mOnVideoRenderingStartCalled.signal();
} else if (what == MediaPlayer2.MEDIA_INFO_PREPARED) {
mOnPrepareCalled.signal();
}
}
@Override
public void onCallCompleted(MediaPlayer2 mp, MediaItem item,
int what, int status) {
if (what == MediaPlayer2.CALL_COMPLETED_PLAY) {
mOnPlayCalled.signal();
}
}
});
}
try {
mOnPrepareCalled.reset();
mPlayer.prepare();
mOnPrepareCalled.waitForSignal();
} catch (Exception e) {
mPlayer.reset();
throw new PrepareFailedException();
}
mOnPlayCalled.reset();
mPlayer.play();
mOnPlayCalled.waitForSignal();
if (!audioOnly) {
mOnVideoSizeChangedCalled.waitForSignal();
mOnVideoRenderingStartCalled.waitForSignal();
}
mPlayer.setPlayerVolume(volume);
// waiting to complete
if (playTime == -1) {
return;
} else if (playTime == 0) {
while (mPlayer.getState() == MediaPlayer2.PLAYER_STATE_PLAYING) {
Thread.sleep(SLEEP_TIME);
}
} else {
Thread.sleep(playTime);
}
// Validate media metrics from API 21 where PersistableBundle was added.
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
PersistableBundle metrics = mPlayer.getMetrics();
if (metrics == null) {
fail("MediaPlayer.getMetrics() returned null metrics");
} else if (metrics.isEmpty()) {
fail("MediaPlayer.getMetrics() returned empty metrics");
} else {
int size = metrics.size();
Set<String> keys = metrics.keySet();
if (keys == null) {
fail("MediaMetricsSet returned no keys");
} else if (keys.size() != size) {
fail("MediaMetricsSet.keys().size() mismatch MediaMetricsSet.size()");
}
// we played something; so one of these should be non-null
String vmime = metrics.getString(MediaPlayer2.MetricsConstants.MIME_TYPE_VIDEO,
null);
String amime = metrics.getString(MediaPlayer2.MetricsConstants.MIME_TYPE_AUDIO,
null);
if (vmime == null && amime == null) {
fail("getMetrics() returned neither video nor audio mime value");
}
long duration = metrics.getLong(MediaPlayer2.MetricsConstants.DURATION, -2);
if (duration == -2) {
fail("getMetrics() didn't return a duration");
}
long playing = metrics.getLong(MediaPlayer2.MetricsConstants.PLAYING, -2);
if (playing == -2) {
fail("getMetrics() didn't return a playing time");
}
if (!keys.contains(MediaPlayer2.MetricsConstants.PLAYING)) {
fail("MediaMetricsSet.keys() missing: "
+ MediaPlayer2.MetricsConstants.PLAYING);
}
}
}
mPlayer.reset();
}
private static class PrepareFailedException extends Exception {}
protected void setOnErrorListener() {
synchronized (mEventCbLock) {
mEventCallbacks.add(new MediaPlayer2.EventCallback() {
@Override
public void onError(MediaPlayer2 mp, MediaItem item, int what, int extra) {
mOnErrorCalled.signal();
}
});
}
}
}