Skip to content

Commit

Permalink
Replace MediaMetadata folderType by isBrowsable
Browse files Browse the repository at this point in the history 
The folder type has a mix of information about the item. It shows
whether the item is browsable (type != FOLDER_TYPE_NONE) and
which Bluetooth folder type to set for legacy session information.

It's a lot clearer to split this into a boolean isBrowsable and
use the existing mediaType to map back to the bluetooth folder type
where required.

folderType is not marked as deprecated yet as this would be an API
change, which will be done later.

PiperOrigin-RevId: 493544589
  • Loading branch information
@tonihei @icbaker
tonihei authored and icbaker committed Dec 12, 2022
1 parent 3a66c28 commit 9d05935
Show file tree
Hide file tree
Showing 2 changed files with 183 additions and 5 deletions.
131 changes: 126 additions & 5 deletions library/common/src/main/java/com/google/android/exoplayer2/MediaMetadata.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ public static final class Builder {
@Nullable private Integer trackNumber;
@Nullable private Integer totalTrackCount;
@Nullable private @FolderType Integer folderType;
@Nullable private Boolean isBrowsable;
@Nullable private Boolean isPlayable;
@Nullable private Integer recordingYear;
@Nullable private Integer recordingMonth;
Expand Down Expand Up @@ -97,6 +98,7 @@ private Builder(MediaMetadata mediaMetadata) {
this.trackNumber = mediaMetadata.trackNumber;
this.totalTrackCount = mediaMetadata.totalTrackCount;
this.folderType = mediaMetadata.folderType;
this.isBrowsable = mediaMetadata.isBrowsable;
this.isPlayable = mediaMetadata.isPlayable;
this.recordingYear = mediaMetadata.recordingYear;
this.recordingMonth = mediaMetadata.recordingMonth;
Expand Down Expand Up @@ -245,13 +247,25 @@ public Builder setTotalTrackCount(@Nullable Integer totalTrackCount) {
return this;
}

/** Sets the {@link FolderType}. */
/**
* Sets the {@link FolderType}.
*
* <p>This method will be deprecated. Use {@link #setIsBrowsable} to indicate if an item is a
* browsable folder and use {@link #setMediaType} to indicate the type of the folder.
*/
@CanIgnoreReturnValue
public Builder setFolderType(@Nullable @FolderType Integer folderType) {
this.folderType = folderType;
return this;
}

/** Sets whether the media is a browsable folder. */
@CanIgnoreReturnValue
public Builder setIsBrowsable(@Nullable Boolean isBrowsable) {
this.isBrowsable = isBrowsable;
return this;
}

/** Sets whether the media is playable. */
@CanIgnoreReturnValue
public Builder setIsPlayable(@Nullable Boolean isPlayable) {
Expand Down Expand Up @@ -485,6 +499,9 @@ public Builder populate(@Nullable MediaMetadata mediaMetadata) {
if (mediaMetadata.folderType != null) {
setFolderType(mediaMetadata.folderType);
}
if (mediaMetadata.isBrowsable != null) {
setIsBrowsable(mediaMetadata.isBrowsable);
}
if (mediaMetadata.isPlayable != null) {
setIsPlayable(mediaMetadata.isPlayable);
}
Expand Down Expand Up @@ -867,9 +884,16 @@ public MediaMetadata build() {
@Nullable public final Integer trackNumber;
/** Optional total number of tracks. */
@Nullable public final Integer totalTrackCount;
/** Optional {@link FolderType}. */
/**
* Optional {@link FolderType}.
*
* <p>This field will be deprecated. Use {@link #isBrowsable} to indicate if an item is a
* browsable folder and use {@link #mediaType} to indicate the type of the folder.
*/
@Nullable public final @FolderType Integer folderType;
/** Optional boolean for media playability. */
/** Optional boolean to indicate that the media is a browsable folder. */
@Nullable public final Boolean isBrowsable;
/** Optional boolean to indicate that the media is playable. */
@Nullable public final Boolean isPlayable;
/**
* @deprecated Use {@link #recordingYear} instead.
Expand Down Expand Up @@ -932,6 +956,22 @@ public MediaMetadata build() {
@Nullable public final Bundle extras;

private MediaMetadata(Builder builder) {
// Handle compatibility for deprecated fields.
@Nullable Boolean isBrowsable = builder.isBrowsable;
@Nullable Integer folderType = builder.folderType;
@Nullable Integer mediaType = builder.mediaType;
if (isBrowsable != null) {
if (!isBrowsable) {
folderType = FOLDER_TYPE_NONE;
} else if (folderType == null || folderType == FOLDER_TYPE_NONE) {
folderType = mediaType != null ? getFolderTypeFromMediaType(mediaType) : FOLDER_TYPE_MIXED;
}
} else if (folderType != null) {
isBrowsable = folderType != FOLDER_TYPE_NONE;
if (isBrowsable && mediaType == null) {
mediaType = getMediaTypeFromFolderType(folderType);
}
}
this.title = builder.title;
this.artist = builder.artist;
this.albumTitle = builder.albumTitle;
Expand All @@ -946,7 +986,8 @@ private MediaMetadata(Builder builder) {
this.artworkUri = builder.artworkUri;
this.trackNumber = builder.trackNumber;
this.totalTrackCount = builder.totalTrackCount;
this.folderType = builder.folderType;
this.folderType = folderType;
this.isBrowsable = isBrowsable;
this.isPlayable = builder.isPlayable;
this.year = builder.recordingYear;
this.recordingYear = builder.recordingYear;
Expand All @@ -963,7 +1004,7 @@ private MediaMetadata(Builder builder) {
this.genre = builder.genre;
this.compilation = builder.compilation;
this.station = builder.station;
this.mediaType = builder.mediaType;
this.mediaType = mediaType;
this.extras = builder.extras;
}

Expand Down Expand Up @@ -996,6 +1037,7 @@ public boolean equals(@Nullable Object obj) {
&& Util.areEqual(trackNumber, that.trackNumber)
&& Util.areEqual(totalTrackCount, that.totalTrackCount)
&& Util.areEqual(folderType, that.folderType)
&& Util.areEqual(isBrowsable, that.isBrowsable)
&& Util.areEqual(isPlayable, that.isPlayable)
&& Util.areEqual(recordingYear, that.recordingYear)
&& Util.areEqual(recordingMonth, that.recordingMonth)
Expand Down Expand Up @@ -1032,6 +1074,7 @@ public int hashCode() {
trackNumber,
totalTrackCount,
folderType,
isBrowsable,
isPlayable,
recordingYear,
recordingMonth,
Expand Down Expand Up @@ -1088,6 +1131,7 @@ public int hashCode() {
FIELD_COMPILATION,
FIELD_STATION,
FIELD_MEDIA_TYPE,
FIELD_IS_BROWSABLE,
FIELD_EXTRAS,
})
private @interface FieldNumber {}
Expand Down Expand Up @@ -1124,6 +1168,7 @@ public int hashCode() {
private static final int FIELD_ARTWORK_DATA_TYPE = 29;
private static final int FIELD_STATION = 30;
private static final int FIELD_MEDIA_TYPE = 31;
private static final int FIELD_IS_BROWSABLE = 32;
private static final int FIELD_EXTRAS = 1000;

@Override
Expand Down Expand Up @@ -1160,6 +1205,9 @@ public Bundle toBundle() {
if (folderType != null) {
bundle.putInt(keyForField(FIELD_FOLDER_TYPE), folderType);
}
if (isBrowsable != null) {
bundle.putBoolean(keyForField(FIELD_IS_BROWSABLE), isBrowsable);
}
if (isPlayable != null) {
bundle.putBoolean(keyForField(FIELD_IS_PLAYABLE), isPlayable);
}
Expand Down Expand Up @@ -1247,6 +1295,9 @@ private static MediaMetadata fromBundle(Bundle bundle) {
if (bundle.containsKey(keyForField(FIELD_FOLDER_TYPE))) {
builder.setFolderType(bundle.getInt(keyForField(FIELD_FOLDER_TYPE)));
}
if (bundle.containsKey(keyForField(FIELD_IS_BROWSABLE))) {
builder.setIsBrowsable(bundle.getBoolean(keyForField(FIELD_IS_BROWSABLE)));
}
if (bundle.containsKey(keyForField(FIELD_IS_PLAYABLE))) {
builder.setIsPlayable(bundle.getBoolean(keyForField(FIELD_IS_PLAYABLE)));
}
Expand Down Expand Up @@ -1284,4 +1335,74 @@ private static MediaMetadata fromBundle(Bundle bundle) {
private static String keyForField(@FieldNumber int field) {
return Integer.toString(field, Character.MAX_RADIX);
}

private static @FolderType int getFolderTypeFromMediaType(@MediaType int mediaType) {
switch (mediaType) {
case MEDIA_TYPE_ALBUM:
case MEDIA_TYPE_ARTIST:
case MEDIA_TYPE_AUDIO_BOOK:
case MEDIA_TYPE_AUDIO_BOOK_CHAPTER:
case MEDIA_TYPE_FOLDER_MOVIES:
case MEDIA_TYPE_FOLDER_NEWS:
case MEDIA_TYPE_FOLDER_RADIO_STATIONS:
case MEDIA_TYPE_FOLDER_TRAILERS:
case MEDIA_TYPE_FOLDER_VIDEOS:
case MEDIA_TYPE_GENRE:
case MEDIA_TYPE_MOVIE:
case MEDIA_TYPE_MUSIC:
case MEDIA_TYPE_NEWS:
case MEDIA_TYPE_PLAYLIST:
case MEDIA_TYPE_PODCAST:
case MEDIA_TYPE_PODCAST_EPISODE:
case MEDIA_TYPE_RADIO_STATION:
case MEDIA_TYPE_TRAILER:
case MEDIA_TYPE_TV_CHANNEL:
case MEDIA_TYPE_TV_SEASON:
case MEDIA_TYPE_TV_SERIES:
case MEDIA_TYPE_TV_SHOW:
case MEDIA_TYPE_VIDEO:
case MEDIA_TYPE_YEAR:
return FOLDER_TYPE_TITLES;
case MEDIA_TYPE_FOLDER_ALBUMS:
return FOLDER_TYPE_ALBUMS;
case MEDIA_TYPE_FOLDER_ARTISTS:
return FOLDER_TYPE_ARTISTS;
case MEDIA_TYPE_FOLDER_GENRES:
return FOLDER_TYPE_GENRES;
case MEDIA_TYPE_FOLDER_PLAYLISTS:
return FOLDER_TYPE_PLAYLISTS;
case MEDIA_TYPE_FOLDER_YEARS:
return FOLDER_TYPE_YEARS;
case MEDIA_TYPE_FOLDER_AUDIO_BOOKS:
case MEDIA_TYPE_FOLDER_MIXED:
case MEDIA_TYPE_FOLDER_TV_CHANNELS:
case MEDIA_TYPE_FOLDER_TV_SERIES:
case MEDIA_TYPE_FOLDER_TV_SHOWS:
case MEDIA_TYPE_FOLDER_PODCASTS:
case MEDIA_TYPE_MIXED:
default:
return FOLDER_TYPE_MIXED;
}
}

private static @MediaType int getMediaTypeFromFolderType(@FolderType int folderType) {
switch (folderType) {
case FOLDER_TYPE_ALBUMS:
return MEDIA_TYPE_FOLDER_ALBUMS;
case FOLDER_TYPE_ARTISTS:
return MEDIA_TYPE_FOLDER_ARTISTS;
case FOLDER_TYPE_GENRES:
return MEDIA_TYPE_FOLDER_GENRES;
case FOLDER_TYPE_PLAYLISTS:
return MEDIA_TYPE_FOLDER_PLAYLISTS;
case FOLDER_TYPE_TITLES:
return MEDIA_TYPE_MIXED;
case FOLDER_TYPE_YEARS:
return MEDIA_TYPE_FOLDER_YEARS;
case FOLDER_TYPE_MIXED:
case FOLDER_TYPE_NONE:
default:
return MEDIA_TYPE_FOLDER_MIXED;
}
}
}
57 changes: 57 additions & 0 deletions library/common/src/test/java/com/google/android/exoplayer2/MediaMetadataTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ public void builder_minimal_correctDefaults() {
assertThat(mediaMetadata.trackNumber).isNull();
assertThat(mediaMetadata.totalTrackCount).isNull();
assertThat(mediaMetadata.folderType).isNull();
assertThat(mediaMetadata.isBrowsable).isNull();
assertThat(mediaMetadata.isPlayable).isNull();
assertThat(mediaMetadata.recordingYear).isNull();
assertThat(mediaMetadata.recordingMonth).isNull();
Expand Down Expand Up @@ -115,6 +116,61 @@ public void roundTripViaBundle_yieldsEqualInstance() {
assertThat(fromBundle.extras.getString(EXTRAS_KEY)).isEqualTo(EXTRAS_VALUE);
}

@Test
public void builderSetFolderType_toNone_setsIsBrowsableToFalse() {
MediaMetadata mediaMetadata =
new MediaMetadata.Builder().setFolderType(MediaMetadata.FOLDER_TYPE_NONE).build();

assertThat(mediaMetadata.isBrowsable).isFalse();
}

@Test
public void builderSetFolderType_toNotNone_setsIsBrowsableToTrueAndMatchingMediaType() {
MediaMetadata mediaMetadata =
new MediaMetadata.Builder().setFolderType(MediaMetadata.FOLDER_TYPE_PLAYLISTS).build();

assertThat(mediaMetadata.isBrowsable).isTrue();
assertThat(mediaMetadata.mediaType).isEqualTo(MediaMetadata.MEDIA_TYPE_FOLDER_PLAYLISTS);
}

@Test
public void
builderSetFolderType_toNotNoneWithManualMediaType_setsIsBrowsableToTrueAndDoesNotOverrideMediaType() {
MediaMetadata mediaMetadata =
new MediaMetadata.Builder()
.setMediaType(MediaMetadata.MEDIA_TYPE_FOLDER_PODCASTS)
.setFolderType(MediaMetadata.FOLDER_TYPE_PLAYLISTS)
.build();

assertThat(mediaMetadata.isBrowsable).isTrue();
assertThat(mediaMetadata.mediaType).isEqualTo(MediaMetadata.MEDIA_TYPE_FOLDER_PODCASTS);
}

@Test
public void builderSetIsBrowsable_toTrueWithoutMediaType_setsFolderTypeToMixed() {
MediaMetadata mediaMetadata = new MediaMetadata.Builder().setIsBrowsable(true).build();

assertThat(mediaMetadata.folderType).isEqualTo(MediaMetadata.FOLDER_TYPE_MIXED);
}

@Test
public void builderSetIsBrowsable_toTrueWithMediaType_setsFolderTypeToMatchMediaType() {
MediaMetadata mediaMetadata =
new MediaMetadata.Builder()
.setIsBrowsable(true)
.setMediaType(MediaMetadata.MEDIA_TYPE_FOLDER_ARTISTS)
.build();

assertThat(mediaMetadata.folderType).isEqualTo(MediaMetadata.FOLDER_TYPE_ARTISTS);
}

@Test
public void builderSetFolderType_toFalse_setsFolderTypeToNone() {
MediaMetadata mediaMetadata = new MediaMetadata.Builder().setIsBrowsable(false).build();

assertThat(mediaMetadata.folderType).isEqualTo(MediaMetadata.FOLDER_TYPE_NONE);
}

private static MediaMetadata getFullyPopulatedMediaMetadata() {
Bundle extras = new Bundle();
extras.putString(EXTRAS_KEY, EXTRAS_VALUE);
Expand All @@ -135,6 +191,7 @@ private static MediaMetadata getFullyPopulatedMediaMetadata() {
.setTrackNumber(4)
.setTotalTrackCount(12)
.setFolderType(MediaMetadata.FOLDER_TYPE_PLAYLISTS)
.setIsBrowsable(true)
.setIsPlayable(true)
.setRecordingYear(2000)
.setRecordingMonth(11)
Expand Down

0 comments on commit 9d05935

Please sign in to comment.