loliball/media3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Image support in PlayerView

Browse Source 
Images are rendered into an ImageView (on top of the video shutter).
The image view is set to the images emitted by ExoPlayer's ImageOutput
and cleared when there is no longer a selected image track.

In order to keep the existing behavior of video tracks to only clear
the old output once the new first frame is rendered (avoiding short
periods of black between playlist items), we have to reorder this code
slightly to make it work for video and images. Both are treated in the
same way. If both are enabled, video takes precedence.

As the UI module only depends on the common module, we can't direcly
add the ImageOutput to ExoPlayer. This is done via reflection if
the provided Player is an ExoPlayer.

#cherrypick

PiperOrigin-RevId: 643320666
This commit is contained in:
tonihei 2024-06-14 05:31:21 -07:00 committed by Copybara-Service
parent cd9b914c42
commit 4cd8d64446
6 changed files with 269 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
RELEASENOTES.md
View File

@ -49,6 +49,8 @@
error code and message are set but the state of the plaftorm session
remains different to `STATE_ERROR`.
* UI:
* Add image display support to `PlayerView` when connected to an
`ExoPlayer` ([#1144](https://github.com/androidx/media/issues/1144)).
* Add customisation of various icons in `PlayerControlView` through xml
attributes to allow different drawables per `PlayerView` instance,
rather than global overrides

9
libraries/ui/proguard-rules.txt
View File

@ -1,6 +1,6 @@
# Proguard rules specific to the UI module.
# Constructor method accessed via reflection in PlayerView
# Constructor method and classes accessed via reflection in PlayerView
-dontnote androidx.media3.exoplayer.video.spherical.SphericalGLSurfaceView
-keepclassmembers class androidx.media3.exoplayer.video.spherical.SphericalGLSurfaceView {
<init>(android.content.Context);
@ -9,6 +9,13 @@
-keepclassmembers class androidx.media3.exoplayer.video.VideoDecoderGLSurfaceView {
<init>(android.content.Context);
}
-keepnames class androidx.media3.exoplayer.ExoPlayer {}
-keepclassmembers class androidx.media3.exoplayer.ExoPlayer {
void setImageOutput(androidx.media3.exoplayer.image.ImageOutput);
}
-keepclasseswithmembers class androidx.media3.exoplayer.image.ImageOutput {
void onImageAvailable(long, android.graphics.Bitmap);
}
# Constructor method accessed via reflection in TrackSelectionDialogBuilder
-dontnote androidx.appcompat.app.AlertDialog.Builder

273
libraries/ui/src/main/java/androidx/media3/ui/PlayerView.java
View File

@ -36,6 +36,7 @@ import android.graphics.RectF;
import android.graphics.drawable.BitmapDrawable;
import android.graphics.drawable.Drawable;
import android.opengl.GLSurfaceView;
import android.os.Handler;
import android.os.Looper;
import android.util.AttributeSet;
import android.view.KeyEvent;
@ -77,10 +78,12 @@ import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.util.ArrayList;
import java.util.List;
import org.checkerframework.checker.nullness.qual.EnsuresNonNullIf;
import org.checkerframework.checker.nullness.qual.RequiresNonNull;
/**
* A high level view for {@link Player} media playbacks. It displays video, subtitles and album art
@ -106,6 +109,12 @@ import org.checkerframework.checker.nullness.qual.RequiresNonNull;
* <li>Corresponding method: {@link #setDefaultArtwork(Drawable)}
* <li>Default: {@code null}
* </ul>
* <li><b>{@code image_display_mode}</b> - The {@link ImageDisplayMode mode} in which images are
* displayed.
* <ul>
* <li>Corresponding method: {@link #setImageDisplayMode(int)}
* <li>Default: {@code #IMAGE_DISPLAY_MODE_FIT}
* </ul>
* <li><b>{@code use_controller}</b> - Whether the playback controls can be shown.
* <ul>
* <li>Corresponding method: {@link #setUseController(boolean)}
@ -227,6 +236,26 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
*/
@UnstableApi public static final int ARTWORK_DISPLAY_MODE_FILL = 2;
/**
* Determines the image display mode. {@link #IMAGE_DISPLAY_MODE_FIT} or {@link
* #IMAGE_DISPLAY_MODE_FILL}.
*/
@UnstableApi
@Documented
@Retention(RetentionPolicy.SOURCE)
@Target(TYPE_USE)
@IntDef({IMAGE_DISPLAY_MODE_FIT, IMAGE_DISPLAY_MODE_FILL})
public @interface ImageDisplayMode {}
/** The image is fit into the player view and centered creating a letterbox style. */
@UnstableApi public static final int IMAGE_DISPLAY_MODE_FIT = 0;
/**
* The image covers the entire space of the player view. If the aspect ratio of the image is
* different than the player view some areas of the image are cropped.
*/
@UnstableApi public static final int IMAGE_DISPLAY_MODE_FILL = 1;
/**
* Determines when the buffering view is shown. One of {@link #SHOW_BUFFERING_NEVER}, {@link
* #SHOW_BUFFERING_WHEN_PLAYING} or {@link #SHOW_BUFFERING_ALWAYS}.
@ -264,6 +293,7 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
@Nullable private final View shutterView;
@Nullable private final View surfaceView;
private final boolean surfaceViewIgnoresVideoAspectRatio;
@Nullable private final ImageView imageView;
@Nullable private final ImageView artworkView;
@Nullable private final SubtitleView subtitleView;
@Nullable private final View bufferingView;
@ -271,6 +301,10 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
@Nullable private final PlayerControlView controller;
@Nullable private final FrameLayout adOverlayFrameLayout;
@Nullable private final FrameLayout overlayFrameLayout;
private final Handler mainLooperHandler;
@Nullable private final Class<?> exoPlayerClazz;
@Nullable private final Method setImageOutputMethod;
@Nullable private final Object imageOutput;
@Nullable private Player player;
private boolean useController;
@ -285,6 +319,7 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
@Nullable private FullscreenButtonClickListener fullscreenButtonClickListener;
private @ArtworkDisplayMode int artworkDisplayMode;
private @ImageDisplayMode int imageDisplayMode;
@Nullable private Drawable defaultArtwork;
private @ShowBuffering int showBuffering;
@ -296,7 +331,6 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
private boolean controllerHideDuringAds;
private boolean controllerHideOnTouch;
private int textureViewRotation;
private boolean isTouching;
public PlayerView(Context context) {
this(context, /* attrs= */ null);
@ -312,12 +346,14 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
super(context, attrs, defStyleAttr);
componentListener = new ComponentListener();
mainLooperHandler = new Handler(Looper.getMainLooper());
if (isInEditMode()) {
contentFrame = null;
shutterView = null;
surfaceView = null;
surfaceViewIgnoresVideoAspectRatio = false;
imageView = null;
artworkView = null;
subtitleView = null;
bufferingView = null;
@ -325,6 +361,9 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
controller = null;
adOverlayFrameLayout = null;
overlayFrameLayout = null;
exoPlayerClazz = null;
setImageOutputMethod = null;
imageOutput = null;
ImageView logo = new ImageView(context);
if (Util.SDK_INT >= 23) {
configureEditModeLogoV23(context, getResources(), logo);
@ -340,6 +379,7 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
int playerLayoutId = R.layout.exo_player_view;
boolean useArtwork = true;
int artworkDisplayMode = ARTWORK_DISPLAY_MODE_FIT;
int imageDisplayMode = IMAGE_DISPLAY_MODE_FIT;
int defaultArtworkId = 0;
boolean useController = true;
int surfaceType = SURFACE_TYPE_SURFACE_VIEW;
@ -364,6 +404,7 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
a.getInt(R.styleable.PlayerView_artwork_display_mode, artworkDisplayMode);
defaultArtworkId =
a.getResourceId(R.styleable.PlayerView_default_artwork, defaultArtworkId);
imageDisplayMode = a.getInt(R.styleable.PlayerView_image_display_mode, imageDisplayMode);
useController = a.getBoolean(R.styleable.PlayerView_use_controller, useController);
surfaceType = a.getInt(R.styleable.PlayerView_surface_type, surfaceType);
resizeMode = a.getInt(R.styleable.PlayerView_resize_mode, resizeMode);
@ -455,6 +496,38 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
// Overlay frame layout.
overlayFrameLayout = findViewById(R.id.exo_overlay);
// Image view.
imageView = findViewById(R.id.exo_image);
this.imageDisplayMode = imageDisplayMode;
// ExoPlayer image output classes and methods.
Class<?> exoPlayerClazz;
Method setImageOutputMethod;
Object imageOutput;
try {
exoPlayerClazz = Class.forName("androidx.media3.exoplayer.ExoPlayer");
Class<?> imageOutputClazz = Class.forName("androidx.media3.exoplayer.image.ImageOutput");
setImageOutputMethod = exoPlayerClazz.getMethod("setImageOutput", imageOutputClazz);
imageOutput =
Proxy.newProxyInstance(
imageOutputClazz.getClassLoader(),
new Class<?>[] {imageOutputClazz},
(proxy, method, args) -> {
if (method.getName().equals("onImageAvailable")) {
onImageAvailable((Bitmap) args[1]);
}
return null;
});
} catch (ClassNotFoundException | NoSuchMethodException e) {
// Expected if ExoPlayer module not available.
exoPlayerClazz = null;
setImageOutputMethod = null;
imageOutput = null;
}
this.exoPlayerClazz = exoPlayerClazz;
this.setImageOutputMethod = setImageOutputMethod;
this.imageOutput = imageOutput;
// Artwork view.
artworkView = findViewById(R.id.exo_artwork);
boolean isArtworkEnabled =
@ -568,6 +641,7 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
if (this.player == player) {
return;
}
@Nullable Player oldPlayer = this.player;
if (oldPlayer != null) {
oldPlayer.removeListener(componentListener);
@ -578,6 +652,7 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
oldPlayer.clearVideoSurfaceView((SurfaceView) surfaceView);
}
}
clearImageOutput(oldPlayer);
}
if (subtitleView != null) {
subtitleView.setCues(null);
@ -606,12 +681,34 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
subtitleView.setCues(player.getCurrentCues().cues);
}
player.addListener(componentListener);
setImageOutput(player);
maybeShowController(false);
} else {
hideController();
}
}
private void setImageOutput(Player player) {
if (exoPlayerClazz != null && exoPlayerClazz.isAssignableFrom(player.getClass())) {
try {
checkNotNull(setImageOutputMethod).invoke(player, checkNotNull(imageOutput));
} catch (IllegalAccessException | InvocationTargetException e) {
throw new RuntimeException(e);
}
}
}
@SuppressWarnings("argument.type.incompatible") // null allowed as method parameter in invoke
private void clearImageOutput(Player player) {
if (exoPlayerClazz != null && exoPlayerClazz.isAssignableFrom(player.getClass())) {
try {
checkNotNull(setImageOutputMethod).invoke(player, new Object[] {null});
} catch (IllegalAccessException | InvocationTargetException e) {
throw new RuntimeException(e);
}
}
}
@Override
public void setVisibility(int visibility) {
super.setVisibility(visibility);
@ -694,6 +791,22 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
}
}
/** Sets how images are displayed if present in the media. */
@UnstableApi
public void setImageDisplayMode(@ImageDisplayMode int imageDisplayMode) {
Assertions.checkState(imageView != null);
if (this.imageDisplayMode != imageDisplayMode) {
this.imageDisplayMode = imageDisplayMode;
updateImageViewAspectRatio();
}
}
/** Returns the {@link ImageDisplayMode image display mode}. */
@UnstableApi
public @ImageDisplayMode int getImageDisplayMode() {
return imageDisplayMode;
}
/** Returns whether the playback controls can be shown. */
public boolean getUseController() {
return useController;
@ -1326,7 +1439,6 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
return false;
}
@EnsuresNonNullIf(expression = "artworkView", result = true)
private boolean useArtwork() {
if (artworkDisplayMode != ARTWORK_DISPLAY_MODE_OFF) {
Assertions.checkStateNotNull(artworkView);
@ -1391,32 +1503,46 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
private void updateForCurrentTrackSelections(boolean isNewPlayer) {
@Nullable Player player = this.player;
if (player == null
|| !player.isCommandAvailable(COMMAND_GET_TRACKS)
|| player.getCurrentTracks().isEmpty()) {
if (!keepContentOnPlayerReset) {
hideArtwork();
closeShutter();
}
return;
}
if (isNewPlayer && !keepContentOnPlayerReset) {
// Hide any video from the previous player.
closeShutter();
}
if (player.getCurrentTracks().isTypeSelected(C.TRACK_TYPE_VIDEO)) {
// Video enabled, so artwork must be hidden. If the shutter is closed, it will be opened
// in onRenderedFirstFrame().
// Unless configured to keep, clear output completely when tracks are empty or for a new player.
boolean hasTracks =
player != null
&& player.isCommandAvailable(COMMAND_GET_TRACKS)
&& !player.getCurrentTracks().isEmpty();
if (!keepContentOnPlayerReset && (!hasTracks || isNewPlayer)) {
hideArtwork();
closeShutter();
hideAndClearImage();
}
if (!hasTracks) {
// Nothing else to check.
return;
}
// Video disabled so the shutter must be closed.
closeShutter();
boolean hasSelectedVideoTrack = hasSelectedVideoTrack();
boolean hasSelectedImageTrack = hasSelectedImageTrack();
// When video and image are disabled, close shutter and clear image. Do nothing if one or both
// are enabled to keep the current state (previous frame or video). Once ready, the first frame
// or image will update the view.
if (!hasSelectedVideoTrack && !hasSelectedImageTrack) {
closeShutter();
hideAndClearImage();
}
// Exception: If both were enabled (shutter open and image set) and we switch to one only, we
// can hide the other output immediately as no further callbacks will arrive.
boolean wasVideoAndImageSet =
shutterView != null && shutterView.getVisibility() == INVISIBLE && isImageSet();
if (hasSelectedImageTrack && !hasSelectedVideoTrack && wasVideoAndImageSet) {
closeShutter();
showImage();
} else if (hasSelectedVideoTrack && !hasSelectedImageTrack && wasVideoAndImageSet) {
hideAndClearImage();
}
// Display artwork if enabled and available, else hide it.
if (useArtwork()) {
boolean shouldShowArtwork = !hasSelectedVideoTrack && !hasSelectedImageTrack && useArtwork();
if (shouldShowArtwork) {
if (setArtworkFromMediaMetadata(player)) {
return;
}
@ -1428,9 +1554,8 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
hideArtwork();
}
@RequiresNonNull("artworkView")
private boolean setArtworkFromMediaMetadata(Player player) {
if (!player.isCommandAvailable(COMMAND_GET_METADATA)) {
private boolean setArtworkFromMediaMetadata(@Nullable Player player) {
if (player == null || !player.isCommandAvailable(COMMAND_GET_METADATA)) {
return false;
}
MediaMetadata mediaMetadata = player.getMediaMetadata();
@ -1443,9 +1568,8 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
return setDrawableArtwork(new BitmapDrawable(getResources(), bitmap));
}
@RequiresNonNull("artworkView")
private boolean setDrawableArtwork(@Nullable Drawable drawable) {
if (drawable != null) {
if (artworkView != null && drawable != null) {
int drawableWidth = drawable.getIntrinsicWidth();
int drawableHeight = drawable.getIntrinsicHeight();
if (drawableWidth > 0 && drawableHeight > 0) {
@ -1472,6 +1596,94 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
}
}
private boolean hasSelectedImageTrack() {
@Nullable Player player = this.player;
return player != null
&& imageOutput != null
&& player.isCommandAvailable(COMMAND_GET_TRACKS)
&& player.getCurrentTracks().isTypeSelected(C.TRACK_TYPE_IMAGE);
}
private boolean hasSelectedVideoTrack() {
@Nullable Player player = this.player;
return player != null
&& player.isCommandAvailable(COMMAND_GET_TRACKS)
&& player.getCurrentTracks().isTypeSelected(C.TRACK_TYPE_VIDEO);
}
private boolean isImageSet() {
if (imageView == null) {
return false;
}
@Nullable Drawable drawable = imageView.getDrawable();
// The transparent placeholder has an alpha value of 0, but BitmapDrawables never have alpha 0.
return drawable != null && drawable.getAlpha() != 0;
}
private void setImage(Drawable drawable) {
if (imageView == null) {
return;
}
imageView.setImageDrawable(drawable);
updateImageViewAspectRatio();
}
private void updateImageViewAspectRatio() {
if (imageView == null) {
return;
}
@Nullable Drawable drawable = imageView.getDrawable();
if (drawable == null) {
return;
}
int drawableWidth = drawable.getIntrinsicWidth();
int drawableHeight = drawable.getIntrinsicHeight();
if (drawableWidth <= 0 || drawableHeight <= 0) {
return;
}
float drawableLayoutAspectRatio = (float) drawableWidth / drawableHeight;
ImageView.ScaleType scaleStyle = ImageView.ScaleType.FIT_XY;
if (imageDisplayMode == IMAGE_DISPLAY_MODE_FILL) {
drawableLayoutAspectRatio = (float) getWidth() / getHeight();
scaleStyle = ImageView.ScaleType.CENTER_CROP;
}
if (imageView.getVisibility() == VISIBLE) {
onContentAspectRatioChanged(contentFrame, drawableLayoutAspectRatio);
}
imageView.setScaleType(scaleStyle);
}
private void hideAndClearImage() {
hideImage();
if (imageView != null) {
imageView.setImageResource(android.R.color.transparent);
}
}
private void showImage() {
if (imageView != null) {
imageView.setVisibility(VISIBLE);
updateImageViewAspectRatio();
}
}
private void hideImage() {
if (imageView != null) {
imageView.setVisibility(INVISIBLE);
}
}
private void onImageAvailable(Bitmap bitmap) {
mainLooperHandler.post(
() -> {
setImage(new BitmapDrawable(getResources(), bitmap));
if (!hasSelectedVideoTrack()) {
showImage();
closeShutter();
}
});
}
private void closeShutter() {
if (shutterView != null) {
shutterView.setVisibility(View.VISIBLE);
@ -1654,6 +1866,11 @@ public class PlayerView extends FrameLayout implements AdViewProvider {
public void onRenderedFirstFrame() {
if (shutterView != null) {
shutterView.setVisibility(INVISIBLE);
if (hasSelectedImageTrack()) {
hideImage();
} else {
hideAndClearImage();
}
}
}

9
libraries/ui/src/main/res/layout/exo_player_view.xml
View File

@ -27,10 +27,17 @@
android:layout_height="match_parent"
android:background="@android:color/black"/>
<ImageView android:id="@id/exo_image"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:scaleType="fitXY"
android:contentDescription="@null"/>
<ImageView android:id="@id/exo_artwork"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:scaleType="fitXY"/>
android:scaleType="fitXY"
android:contentDescription="@null"/>
<androidx.media3.ui.SubtitleView android:id="@id/exo_subtitles"
android:layout_width="match_parent"

5
libraries/ui/src/main/res/values/attrs.xml
View File

@ -47,6 +47,10 @@
<enum name="fit" value="1"/>
<enum name="fill" value="2"/>
</attr>
<attr name="image_display_mode" format="enum">
<enum name="fit" value="0"/>
<enum name="fill" value="1"/>
</attr>
<attr name="shutter_background_color" format="color"/>
<attr name="default_artwork" format="reference"/>
<attr name="use_controller" format="boolean"/>
@ -115,6 +119,7 @@
<declare-styleable name="PlayerView">
<attr name="use_artwork"/>
<attr name="artwork_display_mode"/>
<attr name="image_display_mode"/>
<attr name="shutter_background_color"/>
<attr name="default_artwork"/>
<attr name="use_controller"/>

1
libraries/ui/src/main/res/values/ids.xml
View File

@ -16,6 +16,7 @@
<resources>
<item name="exo_content_frame" type="id"/>
<item name="exo_image" type="id"/>
<item name="exo_shutter" type="id"/>
<item name="exo_subtitles" type="id"/>
<item name="exo_artwork" type="id"/>