Skip to content

SDK / exoplayer

Go to a project
Commit e0c8cbe2 by ibaker Committed by Oliver Woodman
Options

Pass the raw ICY metadata through IcyInfo 

The ICY 'spec' isn't really clear/tight enough to do anything more
specific than this I think.

Issue:#6476
PiperOrigin-RevId: 272405322
parent 15df31b9
Inline Side-by-side
Showing with 61 additions and 26 deletions
RELEASENOTES.md
...@@ -5,6 +5,8 @@ ...@@ -5,6 +5,8 @@
* Add `Player.onPlaybackSuppressionReasonChanged` to allow listeners to * Add `Player.onPlaybackSuppressionReasonChanged` to allow listeners to
detect playbacks suppressions (e.g. audio focus loss) directly detect playbacks suppressions (e.g. audio focus loss) directly
([#6203](https://github.com/google/ExoPlayer/issues/6203)). ([#6203](https://github.com/google/ExoPlayer/issues/6203)).
* Expose the raw ICY metadata through `IcyInfo`
([#6476](https://github.com/google/ExoPlayer/issues/6476)).
### 2.10.5 (2019-09-20) ### ### 2.10.5 (2019-09-20) ###
......
library/core/src/main/java/com/google/android/exoplayer2/metadata/icy/IcyDecoder.java
...@@ -15,12 +15,10 @@ ...@@ -15,12 +15,10 @@
*/ */
package com.google.android.exoplayer2.metadata.icy; package com.google.android.exoplayer2.metadata.icy;
import androidx.annotation.Nullable;
import androidx.annotation.VisibleForTesting; import androidx.annotation.VisibleForTesting;
import com.google.android.exoplayer2.metadata.Metadata; import com.google.android.exoplayer2.metadata.Metadata;
import com.google.android.exoplayer2.metadata.MetadataDecoder; import com.google.android.exoplayer2.metadata.MetadataDecoder;
import com.google.android.exoplayer2.metadata.MetadataInputBuffer; import com.google.android.exoplayer2.metadata.MetadataInputBuffer;
import com.google.android.exoplayer2.util.Log;
import com.google.android.exoplayer2.util.Util; import com.google.android.exoplayer2.util.Util;
import java.nio.ByteBuffer; import java.nio.ByteBuffer;
import java.util.regex.Matcher; import java.util.regex.Matcher;
...@@ -36,7 +34,6 @@ public final class IcyDecoder implements MetadataDecoder { ...@@ -36,7 +34,6 @@ public final class IcyDecoder implements MetadataDecoder {
private static final String STREAM_KEY_URL = "streamurl"; private static final String STREAM_KEY_URL = "streamurl";
@Override @Override
@Nullable
@SuppressWarnings("ByteBufferBackingArray") @SuppressWarnings("ByteBufferBackingArray")
public Metadata decode(MetadataInputBuffer inputBuffer) { public Metadata decode(MetadataInputBuffer inputBuffer) {
ByteBuffer buffer = inputBuffer.data; ByteBuffer buffer = inputBuffer.data;
...@@ -45,7 +42,6 @@ public final class IcyDecoder implements MetadataDecoder { ...@@ -45,7 +42,6 @@ public final class IcyDecoder implements MetadataDecoder {
return decode(Util.fromUtf8Bytes(data, 0, length)); return decode(Util.fromUtf8Bytes(data, 0, length));
} }
@Nullable
@VisibleForTesting @VisibleForTesting
/* package */ Metadata decode(String metadata) { /* package */ Metadata decode(String metadata) {
String name = null; String name = null;
...@@ -62,12 +58,9 @@ public final class IcyDecoder implements MetadataDecoder { ...@@ -62,12 +58,9 @@ public final class IcyDecoder implements MetadataDecoder {
case STREAM_KEY_URL: case STREAM_KEY_URL:
url = value; url = value;
break; break;
default:
Log.w(TAG, "Unrecognized ICY tag: " + name);
break;
} }
index = matcher.end(); index = matcher.end();
} }
return (name != null || url != null) ? new Metadata(new IcyInfo(name, url)) : null; return new Metadata(new IcyInfo(metadata, name, url));
} }
} }
library/core/src/main/java/com/google/android/exoplayer2/metadata/icy/IcyInfo.java
...@@ -19,26 +19,35 @@ import android.os.Parcel; ...@@ -19,26 +19,35 @@ import android.os.Parcel;
import android.os.Parcelable; import android.os.Parcelable;
import androidx.annotation.Nullable; import androidx.annotation.Nullable;
import com.google.android.exoplayer2.metadata.Metadata; import com.google.android.exoplayer2.metadata.Metadata;
import com.google.android.exoplayer2.util.Assertions;
import com.google.android.exoplayer2.util.Util; import com.google.android.exoplayer2.util.Util;
/** ICY in-stream information. */ /** ICY in-stream information. */
public final class IcyInfo implements Metadata.Entry { public final class IcyInfo implements Metadata.Entry {
/** The complete metadata string used to construct this IcyInfo. */
public final String rawMetadata;
/** The stream title if present, or {@code null}. */ /** The stream title if present, or {@code null}. */
@Nullable public final String title; @Nullable public final String title;
/** The stream title if present, or {@code null}. */ /** The stream URL if present, or {@code null}. */
@Nullable public final String url; @Nullable public final String url;
/** /**
* Construct a new IcyInfo from the source metadata string, and optionally a StreamTitle &
* StreamUrl that have been extracted.
*
* @param rawMetadata See {@link #rawMetadata}.
* @param title See {@link #title}. * @param title See {@link #title}.
* @param url See {@link #url}. * @param url See {@link #url}.
*/ */
public IcyInfo(@Nullable String title, @Nullable String url) { public IcyInfo(String rawMetadata, @Nullable String title, @Nullable String url) {
this.rawMetadata = rawMetadata;
this.title = title; this.title = title;
this.url = url; this.url = url;
} }
/* package */ IcyInfo(Parcel in) { /* package */ IcyInfo(Parcel in) {
rawMetadata = Assertions.checkNotNull(in.readString());
title = in.readString(); title = in.readString();
url = in.readString(); url = in.readString();
} }
...@@ -52,26 +61,27 @@ public final class IcyInfo implements Metadata.Entry { ...@@ -52,26 +61,27 @@ public final class IcyInfo implements Metadata.Entry {
return false; return false;
} }
IcyInfo other = (IcyInfo) obj; IcyInfo other = (IcyInfo) obj;
return Util.areEqual(title, other.title) && Util.areEqual(url, other.url); // title & url are derived from rawMetadata, so no need to include them in the comparison.
return Util.areEqual(rawMetadata, other.rawMetadata);
} }
@Override @Override
public int hashCode() { public int hashCode() {
int result = 17; // title & url are derived from rawMetadata, so no need to include them in the hash.
result = 31 * result + (title != null ? title.hashCode() : 0); return rawMetadata.hashCode();
result = 31 * result + (url != null ? url.hashCode() : 0);
return result;
} }
@Override @Override
public String toString() { public String toString() {
return "ICY: title=\"" + title + "\", url=\"" + url + "\""; return String.format(
"ICY: title=\"%s\", url=\"%s\", rawMetadata=\"%s\"", title, url, rawMetadata);
} }
// Parcelable implementation. // Parcelable implementation.
@Override @Override
public void writeToParcel(Parcel dest, int flags) { public void writeToParcel(Parcel dest, int flags) {
dest.writeString(rawMetadata);
dest.writeString(title); dest.writeString(title);
dest.writeString(url); dest.writeString(url);
} }
......
library/core/src/test/java/com/google/android/exoplayer2/metadata/icy/IcyDecoderTest.java
...@@ -29,10 +29,12 @@ public final class IcyDecoderTest { ...@@ -29,10 +29,12 @@ public final class IcyDecoderTest {
@Test @Test
public void decode() { public void decode() {
IcyDecoder decoder = new IcyDecoder(); IcyDecoder decoder = new IcyDecoder();
Metadata metadata = decoder.decode("StreamTitle='test title';StreamURL='test_url';"); String icyContent = "StreamTitle='test title';StreamURL='test_url';";
Metadata metadata = decoder.decode(icyContent);
assertThat(metadata.length()).isEqualTo(1); assertThat(metadata.length()).isEqualTo(1);
IcyInfo streamInfo = (IcyInfo) metadata.get(0); IcyInfo streamInfo = (IcyInfo) metadata.get(0);
assertThat(streamInfo.rawMetadata).isEqualTo(icyContent);
assertThat(streamInfo.title).isEqualTo("test title"); assertThat(streamInfo.title).isEqualTo("test title");
assertThat(streamInfo.url).isEqualTo("test_url"); assertThat(streamInfo.url).isEqualTo("test_url");
} }
...@@ -40,21 +42,39 @@ public final class IcyDecoderTest { ...@@ -40,21 +42,39 @@ public final class IcyDecoderTest {
@Test @Test
public void decode_titleOnly() { public void decode_titleOnly() {
IcyDecoder decoder = new IcyDecoder(); IcyDecoder decoder = new IcyDecoder();
Metadata metadata = decoder.decode("StreamTitle='test title';"); String icyContent = "StreamTitle='test title';";
Metadata metadata = decoder.decode(icyContent);
assertThat(metadata.length()).isEqualTo(1); assertThat(metadata.length()).isEqualTo(1);
IcyInfo streamInfo = (IcyInfo) metadata.get(0); IcyInfo streamInfo = (IcyInfo) metadata.get(0);
assertThat(streamInfo.rawMetadata).isEqualTo(icyContent);
assertThat(streamInfo.title).isEqualTo("test title"); assertThat(streamInfo.title).isEqualTo("test title");
assertThat(streamInfo.url).isNull(); assertThat(streamInfo.url).isNull();
} }
@Test @Test
public void decode_extraTags() {
String icyContent =
"StreamTitle='test title';StreamURL='test_url';CustomTag|withWeirdSeparator";
IcyDecoder decoder = new IcyDecoder();
Metadata metadata = decoder.decode(icyContent);
assertThat(metadata.length()).isEqualTo(1);
IcyInfo streamInfo = (IcyInfo) metadata.get(0);
assertThat(streamInfo.rawMetadata).isEqualTo(icyContent);
assertThat(streamInfo.title).isEqualTo("test title");
assertThat(streamInfo.url).isEqualTo("test_url");
}
@Test
public void decode_emptyTitle() { public void decode_emptyTitle() {
IcyDecoder decoder = new IcyDecoder(); IcyDecoder decoder = new IcyDecoder();
Metadata metadata = decoder.decode("StreamTitle='';StreamURL='test_url';"); String icyContent = "StreamTitle='';StreamURL='test_url';";
Metadata metadata = decoder.decode(icyContent);
assertThat(metadata.length()).isEqualTo(1); assertThat(metadata.length()).isEqualTo(1);
IcyInfo streamInfo = (IcyInfo) metadata.get(0); IcyInfo streamInfo = (IcyInfo) metadata.get(0);
assertThat(streamInfo.rawMetadata).isEqualTo(icyContent);
assertThat(streamInfo.title).isEmpty(); assertThat(streamInfo.title).isEmpty();
assertThat(streamInfo.url).isEqualTo("test_url"); assertThat(streamInfo.url).isEqualTo("test_url");
} }
...@@ -62,10 +82,12 @@ public final class IcyDecoderTest { ...@@ -62,10 +82,12 @@ public final class IcyDecoderTest {
@Test @Test
public void decode_semiColonInTitle() { public void decode_semiColonInTitle() {
IcyDecoder decoder = new IcyDecoder(); IcyDecoder decoder = new IcyDecoder();
Metadata metadata = decoder.decode("StreamTitle='test; title';StreamURL='test_url';"); String icyContent = "StreamTitle='test; title';StreamURL='test_url';";
Metadata metadata = decoder.decode(icyContent);
assertThat(metadata.length()).isEqualTo(1); assertThat(metadata.length()).isEqualTo(1);
IcyInfo streamInfo = (IcyInfo) metadata.get(0); IcyInfo streamInfo = (IcyInfo) metadata.get(0);
assertThat(streamInfo.rawMetadata).isEqualTo(icyContent);
assertThat(streamInfo.title).isEqualTo("test; title"); assertThat(streamInfo.title).isEqualTo("test; title");
assertThat(streamInfo.url).isEqualTo("test_url"); assertThat(streamInfo.url).isEqualTo("test_url");
} }
...@@ -73,10 +95,12 @@ public final class IcyDecoderTest { ...@@ -73,10 +95,12 @@ public final class IcyDecoderTest {
@Test @Test
public void decode_quoteInTitle() { public void decode_quoteInTitle() {
IcyDecoder decoder = new IcyDecoder(); IcyDecoder decoder = new IcyDecoder();
Metadata metadata = decoder.decode("StreamTitle='test' title';StreamURL='test_url';"); String icyContent = "StreamTitle='test' title';StreamURL='test_url';";
Metadata metadata = decoder.decode(icyContent);
assertThat(metadata.length()).isEqualTo(1); assertThat(metadata.length()).isEqualTo(1);
IcyInfo streamInfo = (IcyInfo) metadata.get(0); IcyInfo streamInfo = (IcyInfo) metadata.get(0);
assertThat(streamInfo.rawMetadata).isEqualTo(icyContent);
assertThat(streamInfo.title).isEqualTo("test' title"); assertThat(streamInfo.title).isEqualTo("test' title");
assertThat(streamInfo.url).isEqualTo("test_url"); assertThat(streamInfo.url).isEqualTo("test_url");
} }
...@@ -84,19 +108,25 @@ public final class IcyDecoderTest { ...@@ -84,19 +108,25 @@ public final class IcyDecoderTest {
@Test @Test
public void decode_lineTerminatorInTitle() { public void decode_lineTerminatorInTitle() {
IcyDecoder decoder = new IcyDecoder(); IcyDecoder decoder = new IcyDecoder();
Metadata metadata = decoder.decode("StreamTitle='test\r\ntitle';StreamURL='test_url';"); String icyContent = "StreamTitle='test\r\ntitle';StreamURL='test_url';";
Metadata metadata = decoder.decode(icyContent);
assertThat(metadata.length()).isEqualTo(1); assertThat(metadata.length()).isEqualTo(1);
IcyInfo streamInfo = (IcyInfo) metadata.get(0); IcyInfo streamInfo = (IcyInfo) metadata.get(0);
assertThat(streamInfo.rawMetadata).isEqualTo(icyContent);
assertThat(streamInfo.title).isEqualTo("test\r\ntitle"); assertThat(streamInfo.title).isEqualTo("test\r\ntitle");
assertThat(streamInfo.url).isEqualTo("test_url"); assertThat(streamInfo.url).isEqualTo("test_url");
} }
@Test @Test
public void decode_notIcy() { public void decode_noReconisedHeaders() {
IcyDecoder decoder = new IcyDecoder(); IcyDecoder decoder = new IcyDecoder();
Metadata metadata = decoder.decode("NotIcyData"); Metadata metadata = decoder.decode("NotIcyData");
assertThat(metadata).isNull(); assertThat(metadata.length()).isEqualTo(1);
IcyInfo streamInfo = (IcyInfo) metadata.get(0);
assertThat(streamInfo.rawMetadata).isEqualTo("NotIcyData");
assertThat(streamInfo.title).isNull();
assertThat(streamInfo.url).isNull();
} }
} }
library/core/src/test/java/com/google/android/exoplayer2/metadata/icy/IcyStreamInfoTest.java → library/core/src/test/java/com/google/android/exoplayer2/metadata/icy/IcyInfoTest.java
...@@ -24,11 +24,11 @@ import org.junit.runner.RunWith; ...@@ -24,11 +24,11 @@ import org.junit.runner.RunWith;
/** Test for {@link IcyInfo}. */ /** Test for {@link IcyInfo}. */
@RunWith(AndroidJUnit4.class) @RunWith(AndroidJUnit4.class)
public final class IcyStreamInfoTest { public final class IcyInfoTest {
@Test @Test
public void parcelEquals() { public void parcelEquals() {
IcyInfo streamInfo = new IcyInfo("name", "url"); IcyInfo streamInfo = new IcyInfo("StreamName='name';StreamUrl='url'", "name", "url");
// Write to parcel. // Write to parcel.
Parcel parcel = Parcel.obtain(); Parcel parcel = Parcel.obtain();
streamInfo.writeToParcel(parcel, 0); streamInfo.writeToParcel(parcel, 0);
......
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