Skip to content

SDK / exoplayer

Go to a project
Commit b4e05e00 by olly Committed by Ian Baker
Options

TrackSelectionParameters: Simplify disabling of track types 

As evidenced by the somewhat awkward logic in PlayerControlView, the
previous design wasn't very friendly to expected usage. There will be
more usage when the track selection dialog components are migrated,
which would be similarly awkward without this change.

PiperOrigin-RevId: 431407675
parent f66c9290
Inline Side-by-side
Showing with 70 additions and 50 deletions
docs/track-selection.md
...@@ -134,21 +134,21 @@ player.setTrackSelectionParameters( ...@@ -134,21 +134,21 @@ player.setTrackSelectionParameters(
### Disabling track types or groups ### Disabling track types or groups
Track types, like video, audio or text, can be disabled completely by using Track types, like video, audio or text, can be disabled completely using
`TrackSelectionParameters.Builder.setDisabledTrackTypes`. This will apply `TrackSelectionParameters.Builder.setTrackTypeDisabled`. A disabled track type
unconditionally and will also affect other playlist items. will be disabled for all media items:
~~~ ~~~
player.setTrackSelectionParameters( player.setTrackSelectionParameters(
player.getTrackSelectionParameters() player.getTrackSelectionParameters()
.buildUpon() .buildUpon()
.setDisabledTrackTypes(ImmutableSet.of(C.TRACK_TYPE_VIDEO)) .setTrackTypeDisabled(C.TRACK_TYPE_VIDEO, /* disabled= */ true)
.build()); .build());
~~~ ~~~
{: .language-java} {: .language-java}
Alternatively, it's possible to prevent the selection of tracks from a specific Alternatively, it's possible to prevent the selection of tracks from a specific
`TrackGroup` only by specifying an empty override for that group: `TrackGroup` by specifying an empty override for that group:
~~~ ~~~
player.setTrackSelectionParameters( player.setTrackSelectionParameters(
......
library/common/src/main/java/com/google/android/exoplayer2/trackselection/TrackSelectionParameters.java
...@@ -40,6 +40,7 @@ import java.lang.annotation.Documented; ...@@ -40,6 +40,7 @@ import java.lang.annotation.Documented;
import java.lang.annotation.Retention; import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy; import java.lang.annotation.RetentionPolicy;
import java.util.HashMap; import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator; import java.util.Iterator;
import java.util.List; import java.util.List;
import java.util.Locale; import java.util.Locale;
...@@ -101,7 +102,7 @@ public class TrackSelectionParameters implements Bundleable { ...@@ -101,7 +102,7 @@ public class TrackSelectionParameters implements Bundleable {
private boolean forceLowestBitrate; private boolean forceLowestBitrate;
private boolean forceHighestSupportedBitrate; private boolean forceHighestSupportedBitrate;
private HashMap<TrackGroup, TrackSelectionOverride> overrides; private HashMap<TrackGroup, TrackSelectionOverride> overrides;
private ImmutableSet<@C.TrackType Integer> disabledTrackTypes; private HashSet<@C.TrackType Integer> disabledTrackTypes;
/** /**
* @deprecated {@link Context} constraints will not be set using this constructor. Use {@link * @deprecated {@link Context} constraints will not be set using this constructor. Use {@link
...@@ -133,7 +134,7 @@ public class TrackSelectionParameters implements Bundleable { ...@@ -133,7 +134,7 @@ public class TrackSelectionParameters implements Bundleable {
forceLowestBitrate = false; forceLowestBitrate = false;
forceHighestSupportedBitrate = false; forceHighestSupportedBitrate = false;
overrides = new HashMap<>(); overrides = new HashMap<>();
disabledTrackTypes = ImmutableSet.of(); disabledTrackTypes = new HashSet<>();
} }
/** /**
...@@ -238,21 +239,22 @@ public class TrackSelectionParameters implements Bundleable { ...@@ -238,21 +239,22 @@ public class TrackSelectionParameters implements Bundleable {
bundle.getBoolean( bundle.getBoolean(
keyForField(FIELD_FORCE_HIGHEST_SUPPORTED_BITRATE), keyForField(FIELD_FORCE_HIGHEST_SUPPORTED_BITRATE),
DEFAULT_WITHOUT_CONTEXT.forceHighestSupportedBitrate); DEFAULT_WITHOUT_CONTEXT.forceHighestSupportedBitrate);
overrides = new HashMap<>();
List<TrackSelectionOverride> overrideList = List<TrackSelectionOverride> overrideList =
fromBundleNullableList( fromBundleNullableList(
TrackSelectionOverride.CREATOR, TrackSelectionOverride.CREATOR,
bundle.getParcelableArrayList(keyForField(FIELD_SELECTION_OVERRIDES)), bundle.getParcelableArrayList(keyForField(FIELD_SELECTION_OVERRIDES)),
ImmutableList.of()); ImmutableList.of());
overrides = new HashMap<>();
for (int i = 0; i < overrideList.size(); i++) { for (int i = 0; i < overrideList.size(); i++) {
TrackSelectionOverride override = overrideList.get(i); TrackSelectionOverride override = overrideList.get(i);
overrides.put(override.trackGroup, override); overrides.put(override.trackGroup, override);
} }
disabledTrackTypes = int[] disabledTrackTypeArray =
ImmutableSet.copyOf( firstNonNull(bundle.getIntArray(keyForField(FIELD_DISABLED_TRACK_TYPE)), new int[0]);
Ints.asList( disabledTrackTypes = new HashSet<>();
firstNonNull( for (@C.TrackType int disabledTrackType : disabledTrackTypeArray) {
bundle.getIntArray(keyForField(FIELD_DISABLED_TRACK_TYPE)), new int[0]))); disabledTrackTypes.add(disabledTrackType);
}
} }
/** Overrides the value of the builder with the value of {@link TrackSelectionParameters}. */ /** Overrides the value of the builder with the value of {@link TrackSelectionParameters}. */
...@@ -292,7 +294,7 @@ public class TrackSelectionParameters implements Bundleable { ...@@ -292,7 +294,7 @@ public class TrackSelectionParameters implements Bundleable {
// General // General
forceLowestBitrate = parameters.forceLowestBitrate; forceLowestBitrate = parameters.forceLowestBitrate;
forceHighestSupportedBitrate = parameters.forceHighestSupportedBitrate; forceHighestSupportedBitrate = parameters.forceHighestSupportedBitrate;
disabledTrackTypes = parameters.disabledTrackTypes; disabledTrackTypes = new HashSet<>(parameters.disabledTrackTypes);
overrides = new HashMap<>(parameters.overrides); overrides = new HashMap<>(parameters.overrides);
} }
...@@ -693,13 +695,33 @@ public class TrackSelectionParameters implements Bundleable { ...@@ -693,13 +695,33 @@ public class TrackSelectionParameters implements Bundleable {
/** /**
* Sets the disabled track types, preventing all tracks of those types from being selected for * Sets the disabled track types, preventing all tracks of those types from being selected for
* playback. * playback. Any previously disabled track types are cleared.
* *
* @param disabledTrackTypes The track types to disable. * @param disabledTrackTypes The track types to disable.
* @return This builder. * @return This builder.
* @deprecated Use {@link #setTrackTypeDisabled(int, boolean)}.
*/ */
@Deprecated
public Builder setDisabledTrackTypes(Set<@C.TrackType Integer> disabledTrackTypes) { public Builder setDisabledTrackTypes(Set<@C.TrackType Integer> disabledTrackTypes) {
this.disabledTrackTypes = ImmutableSet.copyOf(disabledTrackTypes); this.disabledTrackTypes.clear();
this.disabledTrackTypes.addAll(disabledTrackTypes);
return this;
}
/**
* Sets whether a track type is disabled. If disabled, no tracks of the specified type will be
* selected for playback.
*
* @param trackType The track type.
* @param disabled Whether the track type should be disabled.
* @return This builder.
*/
public Builder setTrackTypeDisabled(@C.TrackType int trackType, boolean disabled) {
if (disabled) {
disabledTrackTypes.add(trackType);
} else {
disabledTrackTypes.remove(trackType);
}
return this; return this;
} }
...@@ -931,7 +953,7 @@ public class TrackSelectionParameters implements Bundleable { ...@@ -931,7 +953,7 @@ public class TrackSelectionParameters implements Bundleable {
this.forceLowestBitrate = builder.forceLowestBitrate; this.forceLowestBitrate = builder.forceLowestBitrate;
this.forceHighestSupportedBitrate = builder.forceHighestSupportedBitrate; this.forceHighestSupportedBitrate = builder.forceHighestSupportedBitrate;
this.overrides = ImmutableMap.copyOf(builder.overrides); this.overrides = ImmutableMap.copyOf(builder.overrides);
this.disabledTrackTypes = builder.disabledTrackTypes; this.disabledTrackTypes = ImmutableSet.copyOf(builder.disabledTrackTypes);
} }
/** Creates a new {@link Builder}, copying the initial values from this instance. */ /** Creates a new {@link Builder}, copying the initial values from this instance. */
......
library/common/src/test/java/com/google/android/exoplayer2/trackselection/TrackSelectionParametersTest.java
...@@ -24,7 +24,6 @@ import com.google.android.exoplayer2.Format; ...@@ -24,7 +24,6 @@ import com.google.android.exoplayer2.Format;
import com.google.android.exoplayer2.source.TrackGroup; import com.google.android.exoplayer2.source.TrackGroup;
import com.google.android.exoplayer2.util.MimeTypes; import com.google.android.exoplayer2.util.MimeTypes;
import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import org.junit.Test; import org.junit.Test;
import org.junit.runner.RunWith; import org.junit.runner.RunWith;
...@@ -113,7 +112,8 @@ public final class TrackSelectionParametersTest { ...@@ -113,7 +112,8 @@ public final class TrackSelectionParametersTest {
new Format.Builder().setId(4).build(), new Format.Builder().setId(4).build(),
new Format.Builder().setId(5).build()), new Format.Builder().setId(5).build()),
/* trackIndices= */ ImmutableList.of(1))) /* trackIndices= */ ImmutableList.of(1)))
.setDisabledTrackTypes(ImmutableSet.of(C.TRACK_TYPE_AUDIO, C.TRACK_TYPE_TEXT)) .setTrackTypeDisabled(C.TRACK_TYPE_AUDIO, /* disabled= */ true)
.setTrackTypeDisabled(C.TRACK_TYPE_TEXT, /* disabled= */ true)
.build(); .build();
// Video // Video
......
library/core/src/main/java/com/google/android/exoplayer2/trackselection/DefaultTrackSelector.java
...@@ -622,11 +622,19 @@ public class DefaultTrackSelector extends MappingTrackSelector { ...@@ -622,11 +622,19 @@ public class DefaultTrackSelector extends MappingTrackSelector {
} }
@Override @Override
@Deprecated
@SuppressWarnings("deprecation")
public ParametersBuilder setDisabledTrackTypes(Set<@C.TrackType Integer> disabledTrackTypes) { public ParametersBuilder setDisabledTrackTypes(Set<@C.TrackType Integer> disabledTrackTypes) {
super.setDisabledTrackTypes(disabledTrackTypes); super.setDisabledTrackTypes(disabledTrackTypes);
return this; return this;
} }
@Override
public ParametersBuilder setTrackTypeDisabled(@C.TrackType int trackType, boolean disabled) {
super.setTrackTypeDisabled(trackType, disabled);
return this;
}
/** /**
* Sets whether to exceed renderer capabilities when no selection can be made otherwise. * Sets whether to exceed renderer capabilities when no selection can be made otherwise.
* *
......
library/core/src/test/java/com/google/android/exoplayer2/trackselection/DefaultTrackSelectorTest.java
...@@ -390,7 +390,9 @@ public final class DefaultTrackSelectorTest { ...@@ -390,7 +390,9 @@ public final class DefaultTrackSelectorTest {
public void selectVideoAudioTracks_withDisabledAudioType_onlyVideoIsSelected() public void selectVideoAudioTracks_withDisabledAudioType_onlyVideoIsSelected()
throws ExoPlaybackException { throws ExoPlaybackException {
trackSelector.setParameters( trackSelector.setParameters(
defaultParameters.buildUpon().setDisabledTrackTypes(ImmutableSet.of(C.TRACK_TYPE_AUDIO))); defaultParameters
.buildUpon()
.setTrackTypeDisabled(C.TRACK_TYPE_AUDIO, /* disabled= */ true));
TrackSelectorResult result = TrackSelectorResult result =
trackSelector.selectTracks( trackSelector.selectTracks(
...@@ -405,11 +407,12 @@ public final class DefaultTrackSelectorTest { ...@@ -405,11 +407,12 @@ public final class DefaultTrackSelectorTest {
/** Tests that a disabled track type can be enabled again. */ /** Tests that a disabled track type can be enabled again. */
@Test @Test
@SuppressWarnings("deprecation")
public void selectTracks_withClearedDisabledTrackType_selectsAll() throws ExoPlaybackException { public void selectTracks_withClearedDisabledTrackType_selectsAll() throws ExoPlaybackException {
trackSelector.setParameters( trackSelector.setParameters(
trackSelector trackSelector
.buildUponParameters() .buildUponParameters()
.setDisabledTrackTypes(ImmutableSet.of(C.TRACK_TYPE_AUDIO)) .setTrackTypeDisabled(C.TRACK_TYPE_AUDIO, /* disabled= */ true)
.setDisabledTrackTypes(ImmutableSet.of())); .setDisabledTrackTypes(ImmutableSet.of()));
TrackSelectorResult result = TrackSelectorResult result =
...@@ -424,7 +427,9 @@ public final class DefaultTrackSelectorTest { ...@@ -424,7 +427,9 @@ public final class DefaultTrackSelectorTest {
public void selectTracks_withDisabledNoneTracksAndNoSampleRenderer_disablesNoSampleRenderer() public void selectTracks_withDisabledNoneTracksAndNoSampleRenderer_disablesNoSampleRenderer()
throws ExoPlaybackException { throws ExoPlaybackException {
trackSelector.setParameters( trackSelector.setParameters(
defaultParameters.buildUpon().setDisabledTrackTypes(ImmutableSet.of(C.TRACK_TYPE_NONE))); defaultParameters
.buildUpon()
.setTrackTypeDisabled(C.TRACK_TYPE_NONE, /* disabled= */ true));
TrackSelectorResult result = TrackSelectorResult result =
trackSelector.selectTracks( trackSelector.selectTracks(
......
library/ui/src/main/java/com/google/android/exoplayer2/ui/StyledPlayerControlView.java
...@@ -73,15 +73,12 @@ import com.google.android.exoplayer2.util.Assertions; ...@@ -73,15 +73,12 @@ import com.google.android.exoplayer2.util.Assertions;
import com.google.android.exoplayer2.util.RepeatModeUtil; import com.google.android.exoplayer2.util.RepeatModeUtil;
import com.google.android.exoplayer2.util.Util; import com.google.android.exoplayer2.util.Util;
import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
import java.util.Collections; import java.util.Collections;
import java.util.Formatter; import java.util.Formatter;
import java.util.HashSet;
import java.util.List; import java.util.List;
import java.util.Locale; import java.util.Locale;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArrayList; import java.util.concurrent.CopyOnWriteArrayList;
/** /**
...@@ -1873,11 +1870,7 @@ public class StyledPlayerControlView extends FrameLayout { ...@@ -1873,11 +1870,7 @@ public class StyledPlayerControlView extends FrameLayout {
player.setTrackSelectionParameters( player.setTrackSelectionParameters(
trackSelectionParameters trackSelectionParameters
.buildUpon() .buildUpon()
.setDisabledTrackTypes( .setTrackTypeDisabled(C.TRACK_TYPE_TEXT, /* disabled= */ true)
new ImmutableSet.Builder<@C.TrackType Integer>()
.addAll(trackSelectionParameters.disabledTrackTypes)
.add(C.TRACK_TYPE_TEXT)
.build())
.build()); .build());
settingsWindow.dismiss(); settingsWindow.dismiss();
} }
...@@ -1916,15 +1909,12 @@ public class StyledPlayerControlView extends FrameLayout { ...@@ -1916,15 +1909,12 @@ public class StyledPlayerControlView extends FrameLayout {
} }
TrackSelectionParameters trackSelectionParameters = TrackSelectionParameters trackSelectionParameters =
player.getTrackSelectionParameters(); player.getTrackSelectionParameters();
Set<@C.TrackType Integer> disabledTrackTypes =
new HashSet<>(trackSelectionParameters.disabledTrackTypes);
disabledTrackTypes.remove(C.TRACK_TYPE_AUDIO);
castNonNull(player) castNonNull(player)
.setTrackSelectionParameters( .setTrackSelectionParameters(
trackSelectionParameters trackSelectionParameters
.buildUpon() .buildUpon()
.clearOverridesOfType(C.TRACK_TYPE_AUDIO) .clearOverridesOfType(C.TRACK_TYPE_AUDIO)
.setDisabledTrackTypes(disabledTrackTypes) .setTrackTypeDisabled(C.TRACK_TYPE_AUDIO, /* disabled= */ false)
.build()); .build());
settingsAdapter.setSubTextAtPosition( settingsAdapter.setSubTextAtPosition(
SETTINGS_AUDIO_TRACK_SELECTION_POSITION, SETTINGS_AUDIO_TRACK_SELECTION_POSITION,
...@@ -2001,6 +1991,7 @@ public class StyledPlayerControlView extends FrameLayout { ...@@ -2001,6 +1991,7 @@ public class StyledPlayerControlView extends FrameLayout {
@Override @Override
public void onBindViewHolder(SubSettingViewHolder holder, int position) { public void onBindViewHolder(SubSettingViewHolder holder, int position) {
@Nullable Player player = StyledPlayerControlView.this.player;
if (player == null) { if (player == null) {
return; return;
} }
...@@ -2009,29 +2000,23 @@ public class StyledPlayerControlView extends FrameLayout { ...@@ -2009,29 +2000,23 @@ public class StyledPlayerControlView extends FrameLayout {
} else { } else {
TrackInformation track = tracks.get(position - 1); TrackInformation track = tracks.get(position - 1);
TrackGroup trackGroup = track.trackGroupInfo.getTrackGroup(); TrackGroup trackGroup = track.trackGroupInfo.getTrackGroup();
TrackSelectionParameters params = checkNotNull(player).getTrackSelectionParameters(); TrackSelectionParameters params = player.getTrackSelectionParameters();
boolean explicitlySelected = params.overrides.get(trackGroup) != null && track.isSelected(); boolean explicitlySelected = params.overrides.get(trackGroup) != null && track.isSelected();
holder.textView.setText(track.trackName); holder.textView.setText(track.trackName);
holder.checkView.setVisibility(explicitlySelected ? VISIBLE : INVISIBLE); holder.checkView.setVisibility(explicitlySelected ? VISIBLE : INVISIBLE);
holder.itemView.setOnClickListener( holder.itemView.setOnClickListener(
v -> { v -> {
if (player == null) {
return;
}
TrackSelectionParameters trackSelectionParameters = TrackSelectionParameters trackSelectionParameters =
player.getTrackSelectionParameters(); player.getTrackSelectionParameters();
Set<@C.TrackType Integer> disabledTrackTypes = player.setTrackSelectionParameters(
new HashSet<>(trackSelectionParameters.disabledTrackTypes); trackSelectionParameters
disabledTrackTypes.remove(track.trackGroupInfo.getTrackType()); .buildUpon()
checkNotNull(player) .setOverrideForType(
.setTrackSelectionParameters( new TrackSelectionOverride(
trackSelectionParameters trackGroup, ImmutableList.of(track.trackIndex)))
.buildUpon() .setTrackTypeDisabled(
.setOverrideForType( track.trackGroupInfo.getTrackType(), /* disabled= */ false)
new TrackSelectionOverride( .build());
trackGroup, ImmutableList.of(track.trackIndex)))
.setDisabledTrackTypes(disabledTrackTypes)
.build());
onTrackSelection(track.trackName); onTrackSelection(track.trackName);
settingsWindow.dismiss(); settingsWindow.dismiss();
}); });
......
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