Add live configuration to MediaItem

Issue: #4904 PiperOrigin-RevId: 336839370

Add live configuration to MediaItem
Issue: #4904 PiperOrigin-RevId: 336839370
13f1f3b3 · christosts · kim-vde · ed873322 · 13f1f3b3 · 13f1f3b3
Commit 13f1f3b3 authored Oct 13, 2020 by christosts Committed by kim-vde Oct 13, 2020
Showing with 145 additions and 2 deletions
library/common/src/main/java/com/google/android/exoplayer2/MediaItem.java
library/common/src/test/java/com/google/android/exoplayer2/MediaItemTest.java
--- a/library/common/src/main/java/com/google/android/exoplayer2/MediaItem.java
+++ b/library/common/src/main/java/com/google/android/exoplayer2/MediaItem.java
@@ -76,6 +76,9 @@ public final class MediaItem {
    @Nullable private Uri adTagUri;
    @Nullable private Object tag;
    @Nullable private MediaMetadata mediaMetadata;
+    private long liveTargetOffsetMs;
+    private float liveMinPlaybackSpeed;
+    private float liveMaxPlaybackSpeed;
    /** Creates a builder. */
    public Builder() {
@@ -84,6 +87,9 @@ public final class MediaItem {
      drmLicenseRequestHeaders = Collections.emptyMap();
      streamKeys = Collections.emptyList();
      subtitles = Collections.emptyList();
+      liveTargetOffsetMs = C.TIME_UNSET;
+      liveMinPlaybackSpeed = C.RATE_UNSET;
+      liveMaxPlaybackSpeed = C.RATE_UNSET;
    }
    private Builder(MediaItem mediaItem) {
@@ -95,6 +101,9 @@ public final class MediaItem {
      clipStartsAtKeyFrame = mediaItem.clippingProperties.startsAtKeyFrame;
      mediaId = mediaItem.mediaId;
      mediaMetadata = mediaItem.mediaMetadata;
+      liveTargetOffsetMs = mediaItem.liveConfiguration.targetLiveOffsetMs;
+      liveMinPlaybackSpeed = mediaItem.liveConfiguration.minPlaybackSpeed;
+      liveMaxPlaybackSpeed = mediaItem.liveConfiguration.maxPlaybackSpeed;
      @Nullable PlaybackProperties playbackProperties = mediaItem.playbackProperties;
      if (playbackProperties != null) {
        adTagUri = playbackProperties.adTagUri;
@@ -415,6 +424,45 @@ public final class MediaItem {
    }
    /**
+     * Sets the optional target offset from the live edge for live streams, in milliseconds.
+     *
+     * <p>See {@code Player#getCurrentLiveOffset()}.
+     *
+     * @param liveTargetOffsetMs The target live offset, in milliseconds, or {@link C#TIME_UNSET} to
+     *     use the media-defined default.
+     */
+    public Builder setLiveTargetOffsetMs(long liveTargetOffsetMs) {
+      this.liveTargetOffsetMs = liveTargetOffsetMs;
+      return this;
+    }
+    /**
+     * Sets the optional minimum playback speed for live stream speed adjustment.
+     *
+     * <p>This value is ignored for other stream types.
+     *
+     * @param minPlaybackSpeed The minimum playback speed for live streams, or {@link C#RATE_UNSET}
+     *     to use the media-defined default.
+     */
+    public Builder setLiveMinPlaybackSpeed(float minPlaybackSpeed) {
+      this.liveMinPlaybackSpeed = minPlaybackSpeed;
+      return this;
+    }
+    /**
+     * Sets the optional maximum playback speed for live stream speed adjustment.
+     *
+     * <p>This value is ignored for other stream types.
+     *
+     * @param maxPlaybackSpeed The maximum playback speed for live streams, or {@link C#RATE_UNSET}
+     *     to use the media-defined default.
+     */
+    public Builder setLiveMaxPlaybackSpeed(float maxPlaybackSpeed) {
+      this.liveMaxPlaybackSpeed = maxPlaybackSpeed;
+      return this;
+    }
+    /**
     * Sets the optional tag for custom attributes. The tag for the media source which will be
     * published in the {@code com.google.android.exoplayer2.Timeline} of the source as {@code
     * com.google.android.exoplayer2.Timeline.Window#tag}.
@@ -471,6 +519,7 @@ public final class MediaItem {
              clipRelativeToDefaultPosition,
              clipStartsAtKeyFrame),
          playbackProperties,
+          new LiveConfiguration(liveTargetOffsetMs, liveMinPlaybackSpeed, liveMaxPlaybackSpeed),
          mediaMetadata != null ? mediaMetadata : new MediaMetadata.Builder().build());
    }
  }
@@ -658,6 +707,66 @@ public final class MediaItem {
    }
  }
+  /** Live playback configuration. */
+  public static final class LiveConfiguration {
+    /** A live playback configuration with unset values. */
+    public static final LiveConfiguration UNSET =
+        new LiveConfiguration(C.TIME_UNSET, C.RATE_UNSET, C.RATE_UNSET);
+    /**
+     * Target live offset, in milliseconds, or {@link C#TIME_UNSET} to use the media-defined
+     * default.
+     */
+    public final long targetLiveOffsetMs;
+    /** Minimum playback speed, or {@link C#RATE_UNSET} to use the media-defined default. */
+    public final float minPlaybackSpeed;
+    /** Maximum playback speed, or {@link C#RATE_UNSET} to use the media-defined default. */
+    public final float maxPlaybackSpeed;
+    /**
+     * Creates a live playback configuration.
+     *
+     * @param targetLiveOffsetMs Target live offset, in milliseconds, or {@link C#TIME_UNSET} to use
+     *     the media-defined default.
+     * @param minPlaybackSpeed Minimum playback speed, or {@link C#RATE_UNSET} to use the
+     *     media-defined default.
+     * @param maxPlaybackSpeed Maximum playback speed, or {@link C#RATE_UNSET} to use the
+     *     media-defined default.
+     */
+    public LiveConfiguration(
+        long targetLiveOffsetMs, float minPlaybackSpeed, float maxPlaybackSpeed) {
+      this.targetLiveOffsetMs = targetLiveOffsetMs;
+      this.minPlaybackSpeed = minPlaybackSpeed;
+      this.maxPlaybackSpeed = maxPlaybackSpeed;
+    }
+    @Override
+    public boolean equals(@Nullable Object obj) {
+      if (this == obj) {
+        return true;
+      }
+      if (!(obj instanceof LiveConfiguration)) {
+        return false;
+      }
+      LiveConfiguration other = (LiveConfiguration) obj;
+      return targetLiveOffsetMs == other.targetLiveOffsetMs
+          && minPlaybackSpeed == other.minPlaybackSpeed
+          && maxPlaybackSpeed == other.maxPlaybackSpeed;
+    }
+    @Override
+    public int hashCode() {
+      int result = (int) (targetLiveOffsetMs ^ (targetLiveOffsetMs >>> 32));
+      result = 31 * result + (minPlaybackSpeed != 0 ? Float.floatToIntBits(minPlaybackSpeed) : 0);
+      result = 31 * result + (maxPlaybackSpeed != 0 ? Float.floatToIntBits(maxPlaybackSpeed) : 0);
+      return result;
+    }
+  }
  /** Properties for a text track. */
  public static final class Subtitle {
@@ -784,8 +893,8 @@ public final class MediaItem {
    @Override
    public int hashCode() {
-      int result = Long.valueOf(startPositionMs).hashCode();
+      int result = (int) (startPositionMs ^ (startPositionMs >>> 32));
-      result = 31 * result + Long.valueOf(endPositionMs).hashCode();
+      result = 31 * result + (int) (endPositionMs ^ (endPositionMs >>> 32));
      result = 31 * result + (relativeToLiveWindow ? 1 : 0);
      result = 31 * result + (relativeToDefaultPosition ? 1 : 0);
      result = 31 * result + (startsAtKeyFrame ? 1 : 0);
@@ -799,6 +908,9 @@ public final class MediaItem {
  /** Optional playback properties. Maybe be {@code null} if shared over process boundaries. */
  @Nullable public final PlaybackProperties playbackProperties;
+  /** The live playback configuration. */
+  public final LiveConfiguration liveConfiguration;
  /** The media metadata. */
  public final MediaMetadata mediaMetadata;
@@ -809,9 +921,11 @@ public final class MediaItem {
      String mediaId,
      ClippingProperties clippingProperties,
      @Nullable PlaybackProperties playbackProperties,
+      LiveConfiguration liveConfiguration,
      MediaMetadata mediaMetadata) {
    this.mediaId = mediaId;
    this.playbackProperties = playbackProperties;
+    this.liveConfiguration = liveConfiguration;
    this.mediaMetadata = mediaMetadata;
    this.clippingProperties = clippingProperties;
  }
@@ -835,6 +949,7 @@ public final class MediaItem {
    return Util.areEqual(mediaId, other.mediaId)
        && clippingProperties.equals(other.clippingProperties)
        && Util.areEqual(playbackProperties, other.playbackProperties)
+        && Util.areEqual(liveConfiguration, other.liveConfiguration)
        && Util.areEqual(mediaMetadata, other.mediaMetadata);
  }
@@ -842,6 +957,7 @@ public final class MediaItem {
  public int hashCode() {
    int result = mediaId.hashCode();
    result = 31 * result + (playbackProperties != null ? playbackProperties.hashCode() : 0);
+    result = 31 * result + liveConfiguration.hashCode();
    result = 31 * result + clippingProperties.hashCode();
    result = 31 * result + mediaMetadata.hashCode();
    return result;

--- a/library/common/src/test/java/com/google/android/exoplayer2/MediaItemTest.java
+++ b/library/common/src/test/java/com/google/android/exoplayer2/MediaItemTest.java
@@ -288,6 +288,30 @@ public class MediaItemTest {
  }
  @Test
+  public void builderSetLiveTargetLatencyMs_setsLiveTargetLatencyMs() {
+    MediaItem mediaItem =
+        new MediaItem.Builder().setUri(URI_STRING).setLiveTargetOffsetMs(10_000).build();
+    assertThat(mediaItem.liveConfiguration.targetLiveOffsetMs).isEqualTo(10_000);
+  }
+  @Test
+  public void builderSetMinLivePlaybackSpeed_setsMinLivePlaybackSpeed() {
+    MediaItem mediaItem =
+        new MediaItem.Builder().setUri(URI_STRING).setLiveMinPlaybackSpeed(.9f).build();
+    assertThat(mediaItem.liveConfiguration.minPlaybackSpeed).isEqualTo(.9f);
+  }
+  @Test
+  public void builderSetMaxLivePlaybackSpeed_setsMaxLivePlaybackSpeed() {
+    MediaItem mediaItem =
+        new MediaItem.Builder().setUri(URI_STRING).setLiveMaxPlaybackSpeed(1.1f).build();
+    assertThat(mediaItem.liveConfiguration.maxPlaybackSpeed).isEqualTo(1.1f);
+  }
+  @Test
  public void buildUpon_equalsToOriginal() {
    MediaItem mediaItem =
        new MediaItem.Builder()
@@ -318,6 +342,9 @@ public class MediaItemTest {
                        Uri.parse(URI_STRING + "/en"),
                        MimeTypes.APPLICATION_TTML,
                        /* language= */ "en")))
+            .setLiveTargetOffsetMs(20_000)
+            .setLiveMinPlaybackSpeed(.9f)
+            .setLiveMaxPlaybackSpeed(1.1f)
            .setTag(new Object())
            .build();