Merge pull request #10047 from LuGO0:9432/added-filtering-for-forced-text-tracks

PiperOrigin-RevId: 439262085

Merge pull request #10047 from LuGO0:9432/added-filtering-for-forced-text-tracks
PiperOrigin-RevId: 439262085
9f7abd4f · Ian Baker · bba102a4 · c9ce23a1 · 9f7abd4f · 9f7abd4f
Commit 9f7abd4f authored Apr 07, 2022 by Ian Baker
Showing with 84 additions and 65 deletions
library/common/src/main/java/com/google/android/exoplayer2/trackselection/TrackSelectionParameters.java
library/common/src/test/java/com/google/android/exoplayer2/trackselection/TrackSelectionParametersTest.java
library/core/src/main/java/com/google/android/exoplayer2/trackselection/DefaultTrackSelector.java
library/core/src/test/java/com/google/android/exoplayer2/trackselection/DefaultTrackSelectorTest.java
library/ui/src/main/java/com/google/android/exoplayer2/ui/StyledPlayerControlView.java
--- a/library/common/src/main/java/com/google/android/exoplayer2/trackselection/TrackSelectionParameters.java
+++ b/library/common/src/main/java/com/google/android/exoplayer2/trackselection/TrackSelectionParameters.java
@@ -98,6 +98,7 @@ public class TrackSelectionParameters implements Bundleable {
    // Text
    private ImmutableList<String> preferredTextLanguages;
    private @C.RoleFlags int preferredTextRoleFlags;
+    private @C.SelectionFlags int ignoredTextSelectionFlags;
    private boolean selectUndeterminedTextLanguage;
    // General
    private boolean forceLowestBitrate;
@@ -130,6 +131,7 @@ public class TrackSelectionParameters implements Bundleable {
      // Text
      preferredTextLanguages = ImmutableList.of();
      preferredTextRoleFlags = 0;
+      ignoredTextSelectionFlags = 0;
      selectUndeterminedTextLanguage = false;
      // General
      forceLowestBitrate = false;
@@ -228,6 +230,10 @@ public class TrackSelectionParameters implements Bundleable {
          bundle.getInt(
              keyForField(FIELD_PREFERRED_TEXT_ROLE_FLAGS),
              DEFAULT_WITHOUT_CONTEXT.preferredTextRoleFlags);
+      ignoredTextSelectionFlags =
+          bundle.getInt(
+              keyForField(FIELD_IGNORED_TEXT_SELECTION_FLAGS),
+              DEFAULT_WITHOUT_CONTEXT.ignoredTextSelectionFlags);
      selectUndeterminedTextLanguage =
          bundle.getBoolean(
              keyForField(FIELD_SELECT_UNDETERMINED_TEXT_LANGUAGE),
@@ -291,6 +297,7 @@ public class TrackSelectionParameters implements Bundleable {
      // Text
      preferredTextLanguages = parameters.preferredTextLanguages;
      preferredTextRoleFlags = parameters.preferredTextRoleFlags;
+      ignoredTextSelectionFlags = parameters.ignoredTextSelectionFlags;
      selectUndeterminedTextLanguage = parameters.selectUndeterminedTextLanguage;
      // General
      forceLowestBitrate = parameters.forceLowestBitrate;
@@ -614,6 +621,18 @@ public class TrackSelectionParameters implements Bundleable {
    }
    /**
+     * Sets a bitmask of selection flags that are ignored for text track selections.
+     *
+     * @param ignoredTextSelectionFlags A bitmask of {@link C.SelectionFlags} that are ignored for
+     *     text track selections.
+     * @return This builder.
+     */
+    public Builder setIgnoredTextSelectionFlags(@C.SelectionFlags int ignoredTextSelectionFlags) {
+      this.ignoredTextSelectionFlags = ignoredTextSelectionFlags;
+      return this;
+    }
+    /**
     * Sets whether a text track with undetermined language should be selected if no track with
     * {@link #setPreferredTextLanguages(String...) a preferred language} is available, or if the
     * preferred language is unset.
@@ -896,6 +915,11 @@ public class TrackSelectionParameters implements Bundleable {
   */
  public final @C.RoleFlags int preferredTextRoleFlags;
  /**
+   * Bitmask of selection flags that are ignored for text track selections. See {@link
+   * C.SelectionFlags}. The default value is {@code 0} (i.e., no flags are ignored).
+   */
+  public final @C.SelectionFlags int ignoredTextSelectionFlags;
+  /**
   * Whether a text track with undetermined language should be selected if no track with {@link
   * #preferredTextLanguages} is available, or if {@link #preferredTextLanguages} is unset. The
   * default value is {@code false}.
@@ -947,6 +971,7 @@ public class TrackSelectionParameters implements Bundleable {
    // Text
    this.preferredTextLanguages = builder.preferredTextLanguages;
    this.preferredTextRoleFlags = builder.preferredTextRoleFlags;
+    this.ignoredTextSelectionFlags = builder.ignoredTextSelectionFlags;
    this.selectUndeterminedTextLanguage = builder.selectUndeterminedTextLanguage;
    // General
    this.forceLowestBitrate = builder.forceLowestBitrate;
@@ -990,8 +1015,10 @@ public class TrackSelectionParameters implements Bundleable {
        && maxAudioChannelCount == other.maxAudioChannelCount
        && maxAudioBitrate == other.maxAudioBitrate
        && preferredAudioMimeTypes.equals(other.preferredAudioMimeTypes)
+        // Text
        && preferredTextLanguages.equals(other.preferredTextLanguages)
        && preferredTextRoleFlags == other.preferredTextRoleFlags
+        && ignoredTextSelectionFlags == other.ignoredTextSelectionFlags
        && selectUndeterminedTextLanguage == other.selectUndeterminedTextLanguage
        // General
        && forceLowestBitrate == other.forceLowestBitrate
@@ -1026,6 +1053,7 @@ public class TrackSelectionParameters implements Bundleable {
    // Text
    result = 31 * result + preferredTextLanguages.hashCode();
    result = 31 * result + preferredTextRoleFlags;
+    result = 31 * result + ignoredTextSelectionFlags;
    result = 31 * result + (selectUndeterminedTextLanguage ? 1 : 0);
    // General
    result = 31 * result + (forceLowestBitrate ? 1 : 0);
@@ -1040,11 +1068,7 @@ public class TrackSelectionParameters implements Bundleable {
  @Documented
  @Retention(RetentionPolicy.SOURCE)
  @IntDef({
-    FIELD_PREFERRED_AUDIO_LANGUAGES,
+    // Video
-    FIELD_PREFERRED_AUDIO_ROLE_FLAGS,
-    FIELD_PREFERRED_TEXT_LANGUAGES,
-    FIELD_PREFERRED_TEXT_ROLE_FLAGS,
-    FIELD_SELECT_UNDETERMINED_TEXT_LANGUAGE,
    FIELD_MAX_VIDEO_WIDTH,
    FIELD_MAX_VIDEO_HEIGHT,
    FIELD_MAX_VIDEO_FRAMERATE,
@@ -1057,14 +1081,23 @@ public class TrackSelectionParameters implements Bundleable {
    FIELD_VIEWPORT_HEIGHT,
    FIELD_VIEWPORT_ORIENTATION_MAY_CHANGE,
    FIELD_PREFERRED_VIDEO_MIMETYPES,
+    FIELD_PREFERRED_VIDEO_ROLE_FLAGS,
+    // Audio
+    FIELD_PREFERRED_AUDIO_LANGUAGES,
+    FIELD_PREFERRED_AUDIO_ROLE_FLAGS,
    FIELD_MAX_AUDIO_CHANNEL_COUNT,
    FIELD_MAX_AUDIO_BITRATE,
    FIELD_PREFERRED_AUDIO_MIME_TYPES,
+    // Text
+    FIELD_PREFERRED_TEXT_LANGUAGES,
+    FIELD_PREFERRED_TEXT_ROLE_FLAGS,
+    FIELD_IGNORED_TEXT_SELECTION_FLAGS,
+    FIELD_SELECT_UNDETERMINED_TEXT_LANGUAGE,
+    // General
    FIELD_FORCE_LOWEST_BITRATE,
    FIELD_FORCE_HIGHEST_SUPPORTED_BITRATE,
    FIELD_SELECTION_OVERRIDES,
    FIELD_DISABLED_TRACK_TYPE,
-    FIELD_PREFERRED_VIDEO_ROLE_FLAGS
  })
  private @interface FieldNumber {}
@@ -1093,6 +1126,7 @@ public class TrackSelectionParameters implements Bundleable {
  private static final int FIELD_SELECTION_OVERRIDES = 23;
  private static final int FIELD_DISABLED_TRACK_TYPE = 24;
  private static final int FIELD_PREFERRED_VIDEO_ROLE_FLAGS = 25;
+  private static final int FIELD_IGNORED_TEXT_SELECTION_FLAGS = 26;
  @Override
  public Bundle toBundle() {
@@ -1129,6 +1163,7 @@ public class TrackSelectionParameters implements Bundleable {
    bundle.putStringArray(
        keyForField(FIELD_PREFERRED_TEXT_LANGUAGES), preferredTextLanguages.toArray(new String[0]));
    bundle.putInt(keyForField(FIELD_PREFERRED_TEXT_ROLE_FLAGS), preferredTextRoleFlags);
+    bundle.putInt(keyForField(FIELD_IGNORED_TEXT_SELECTION_FLAGS), ignoredTextSelectionFlags);
    bundle.putBoolean(
        keyForField(FIELD_SELECT_UNDETERMINED_TEXT_LANGUAGE), selectUndeterminedTextLanguage);
    // General

--- a/library/common/src/test/java/com/google/android/exoplayer2/trackselection/TrackSelectionParametersTest.java
+++ b/library/common/src/test/java/com/google/android/exoplayer2/trackselection/TrackSelectionParametersTest.java
@@ -60,6 +60,7 @@ public final class TrackSelectionParametersTest {
    assertThat(parameters.preferredAudioMimeTypes).isEmpty();
    assertThat(parameters.preferredTextLanguages).isEmpty();
    assertThat(parameters.preferredTextRoleFlags).isEqualTo(0);
+    assertThat(parameters.ignoredTextSelectionFlags).isEqualTo(0);
    assertThat(parameters.selectUndeterminedTextLanguage).isFalse();
    // General
    assertThat(parameters.forceLowestBitrate).isFalse();
@@ -102,6 +103,7 @@ public final class TrackSelectionParametersTest {
            // Text
            .setPreferredTextLanguages("de", "en")
            .setPreferredTextRoleFlags(C.ROLE_FLAG_CAPTION)
+            .setIgnoredTextSelectionFlags(C.SELECTION_FLAG_AUTOSELECT)
            .setSelectUndeterminedTextLanguage(true)
            // General
            .setForceLowestBitrate(false)
@@ -145,6 +147,7 @@ public final class TrackSelectionParametersTest {
    // Text
    assertThat(parameters.preferredTextLanguages).containsExactly("de", "en").inOrder();
    assertThat(parameters.preferredTextRoleFlags).isEqualTo(C.ROLE_FLAG_CAPTION);
+    assertThat(parameters.ignoredTextSelectionFlags).isEqualTo(C.SELECTION_FLAG_AUTOSELECT);
    assertThat(parameters.selectUndeterminedTextLanguage).isTrue();
    // General
    assertThat(parameters.forceLowestBitrate).isFalse();

--- a/library/core/src/main/java/com/google/android/exoplayer2/trackselection/DefaultTrackSelector.java
+++ b/library/core/src/main/java/com/google/android/exoplayer2/trackselection/DefaultTrackSelector.java
--- a/library/core/src/test/java/com/google/android/exoplayer2/trackselection/DefaultTrackSelectorTest.java
+++ b/library/core/src/test/java/com/google/android/exoplayer2/trackselection/DefaultTrackSelectorTest.java
@@ -1129,7 +1129,7 @@ public final class DefaultTrackSelectorTest {
    // selected.
    trackGroups = wrapFormats(defaultOnly, noFlag, forcedOnly, forcedDefault);
    trackSelector.setParameters(
-        defaultParameters.buildUpon().setDisabledTextTrackSelectionFlags(C.SELECTION_FLAG_DEFAULT));
+        defaultParameters.buildUpon().setIgnoredTextSelectionFlags(C.SELECTION_FLAG_DEFAULT));
    result = trackSelector.selectTracks(textRendererCapabilities, trackGroups, periodId, TIMELINE);
    assertNoSelection(result.selections[0]);
@@ -1140,8 +1140,7 @@ public final class DefaultTrackSelectorTest {
        trackSelector
            .getParameters()
            .buildUpon()
-            .setDisabledTextTrackSelectionFlags(
+            .setIgnoredTextSelectionFlags(C.SELECTION_FLAG_DEFAULT | C.SELECTION_FLAG_FORCED));
-                C.SELECTION_FLAG_DEFAULT | C.SELECTION_FLAG_FORCED));
    result = trackSelector.selectTracks(textRendererCapabilities, trackGroups, periodId, TIMELINE);
    assertNoSelection(result.selections[0]);
@@ -1159,7 +1158,7 @@ public final class DefaultTrackSelectorTest {
        trackSelector
            .getParameters()
            .buildUpon()
-            .setDisabledTextTrackSelectionFlags(C.SELECTION_FLAG_DEFAULT));
+            .setIgnoredTextSelectionFlags(C.SELECTION_FLAG_DEFAULT));
    result = trackSelector.selectTracks(textRendererCapabilities, trackGroups, periodId, TIMELINE);
    assertFixedSelection(result.selections[0], trackGroups, noFlag);
  }
@@ -2370,7 +2369,7 @@ public final class DefaultTrackSelectorTest {
        .setPreferredTextLanguages("de", "en")
        .setPreferredTextRoleFlags(C.ROLE_FLAG_CAPTION)
        .setSelectUndeterminedTextLanguage(true)
-        .setDisabledTextTrackSelectionFlags(C.SELECTION_FLAG_AUTOSELECT)
+        .setIgnoredTextSelectionFlags(C.SELECTION_FLAG_AUTOSELECT)
        // General
        .setForceLowestBitrate(false)
        .setForceHighestSupportedBitrate(true)

--- a/library/ui/src/main/java/com/google/android/exoplayer2/ui/StyledPlayerControlView.java
+++ b/library/ui/src/main/java/com/google/android/exoplayer2/ui/StyledPlayerControlView.java
@@ -59,6 +59,7 @@ import androidx.recyclerview.widget.LinearLayoutManager;
 import androidx.recyclerview.widget.RecyclerView;
 import com.google.android.exoplayer2.C;
 import com.google.android.exoplayer2.ExoPlayerLibraryInfo;
+import com.google.android.exoplayer2.Format;
 import com.google.android.exoplayer2.ForwardingPlayer;
 import com.google.android.exoplayer2.Player;
 import com.google.android.exoplayer2.Player.Events;
@@ -1130,8 +1131,11 @@ public class StyledPlayerControlView extends FrameLayout {
        if (!trackGroupInfo.isTrackSupported(trackIndex)) {
          continue;
        }
-        String trackName =
+        Format trackFormat = trackGroupInfo.getTrackFormat(trackIndex);
-            trackNameProvider.getTrackName(trackGroupInfo.getTrackFormat(trackIndex));
+        if ((trackFormat.selectionFlags & C.SELECTION_FLAG_FORCED) != 0) {
+          continue;
+        }
+        String trackName = trackNameProvider.getTrackName(trackFormat);
        tracks.add(new TrackInformation(tracksInfo, trackGroupIndex, trackIndex, trackName));
      }
    }
@@ -1870,7 +1874,8 @@ public class StyledPlayerControlView extends FrameLayout {
              player.setTrackSelectionParameters(
                  trackSelectionParameters
                      .buildUpon()
-                      .setTrackTypeDisabled(C.TRACK_TYPE_TEXT, /* disabled= */ true)
+                      .clearOverridesOfType(C.TRACK_TYPE_TEXT)
+                      .setIgnoredTextSelectionFlags(~C.SELECTION_FLAG_FORCED)
                      .build());
              settingsWindow.dismiss();
            }