Prefer the more efficient {@link #toBinderBasedBundle()} if the result doesn't need to be + * serialized. + * + *
The {@link Bundle} returned from this method must not be passed to other processes that + * might be using a different version of the media3 library. + */ + @UnstableApi + public Bundle toSerializableBundle() { + Bundle bundle = toBundleWithoutBitmap(); + if (bitmap != null) { + ByteArrayOutputStream output = new ByteArrayOutputStream(); + // The PNG format is lossless, and the quality parameter is ignored. + checkState(bitmap.compress(Bitmap.CompressFormat.PNG, /* quality= */ 0, output)); + bundle.putByteArray(FIELD_BITMAP_BYTES, output.toByteArray()); + } + return bundle; + } + + /** + * Returns a {@link Bundle} that may contain {@link Binder} references, meaning it cannot be + * safely serialized to bytes. + * + *
The {@link Bundle} returned from this method can be safely sent between processes and parsed + * by older versions of the media3 library. + * + *
Use {@link #toSerializableBundle()} to get a {@link Bundle} that can be safely serialized.
+ */
+ @UnstableApi
+ public Bundle toBinderBasedBundle() {
+ Bundle bundle = toBundleWithoutBitmap();
+ if (bitmap != null) {
+ bundle.putParcelable(FIELD_BITMAP_PARCELABLE, bitmap);
+ }
+ return bundle;
+ }
+
+ /**
+ * @deprecated Use {@link #toSerializableBundle()} or {@link #toBinderBasedBundle()} instead.
+ */
@UnstableApi
@Override
+ @Deprecated
public Bundle toBundle() {
+ return toBinderBasedBundle();
+ }
+
+ private Bundle toBundleWithoutBitmap() {
Bundle bundle = new Bundle();
if (text != null) {
bundle.putCharSequence(FIELD_TEXT, text);
@@ -862,9 +914,6 @@ public final class Cue implements Bundleable {
}
bundle.putSerializable(FIELD_TEXT_ALIGNMENT, textAlignment);
bundle.putSerializable(FIELD_MULTI_ROW_ALIGNMENT, multiRowAlignment);
- if (bitmap != null) {
- bundle.putParcelable(FIELD_BITMAP, bitmap);
- }
bundle.putFloat(FIELD_LINE, line);
bundle.putInt(FIELD_LINE_TYPE, lineType);
bundle.putInt(FIELD_LINE_ANCHOR, lineAnchor);
@@ -915,9 +964,15 @@ public final class Cue implements Bundleable {
if (multiRowAlignment != null) {
builder.setMultiRowAlignment(multiRowAlignment);
}
- @Nullable Bitmap bitmap = bundle.getParcelable(FIELD_BITMAP);
+ @Nullable Bitmap bitmap = bundle.getParcelable(FIELD_BITMAP_PARCELABLE);
if (bitmap != null) {
builder.setBitmap(bitmap);
+ } else {
+ @Nullable byte[] bitmapBytes = bundle.getByteArray(FIELD_BITMAP_BYTES);
+ if (bitmapBytes != null) {
+ builder.setBitmap(
+ BitmapFactory.decodeByteArray(bitmapBytes, /* offset= */ 0, bitmapBytes.length));
+ }
}
if (bundle.containsKey(FIELD_LINE) && bundle.containsKey(FIELD_LINE_TYPE)) {
builder.setLine(bundle.getFloat(FIELD_LINE), bundle.getInt(FIELD_LINE_TYPE));
diff --git a/libraries/common/src/main/java/androidx/media3/common/text/CueGroup.java b/libraries/common/src/main/java/androidx/media3/common/text/CueGroup.java
index 5194462b08..fdca39a5bc 100644
--- a/libraries/common/src/main/java/androidx/media3/common/text/CueGroup.java
+++ b/libraries/common/src/main/java/androidx/media3/common/text/CueGroup.java
@@ -70,7 +70,8 @@ public final class CueGroup implements Bundleable {
Bundle bundle = new Bundle();
bundle.putParcelableArrayList(
FIELD_CUES,
- BundleCollectionUtil.toBundleArrayList(filterOutBitmapCues(cues), Cue::toBundle));
+ BundleCollectionUtil.toBundleArrayList(
+ filterOutBitmapCues(cues), Cue::toBinderBasedBundle));
bundle.putLong(FIELD_PRESENTATION_TIME_US, presentationTimeUs);
return bundle;
}
diff --git a/libraries/common/src/test/java/androidx/media3/common/text/CueTest.java b/libraries/common/src/test/java/androidx/media3/common/text/CueTest.java
index 85e20f0569..baf9443fe0 100644
--- a/libraries/common/src/test/java/androidx/media3/common/text/CueTest.java
+++ b/libraries/common/src/test/java/androidx/media3/common/text/CueTest.java
@@ -21,8 +21,6 @@ import static org.junit.Assert.assertThrows;
import android.graphics.Bitmap;
import android.graphics.Color;
-import android.os.Bundle;
-import android.os.Parcel;
import android.text.Layout;
import android.text.SpannedString;
import androidx.test.ext.junit.runners.AndroidJUnit4;
@@ -109,6 +107,51 @@ public class CueTest {
}
@Test
+ public void roundTripViaBinderBasedBundle_yieldsEqualInstance() {
+ Cue cue =
+ new Cue.Builder()
+ .setText(SpannedString.valueOf("text"))
+ .setTextAlignment(Layout.Alignment.ALIGN_CENTER)
+ .setMultiRowAlignment(Layout.Alignment.ALIGN_NORMAL)
+ .setLine(5, Cue.LINE_TYPE_NUMBER)
+ .setLineAnchor(Cue.ANCHOR_TYPE_END)
+ .setPosition(0.4f)
+ .setPositionAnchor(Cue.ANCHOR_TYPE_MIDDLE)
+ .setTextSize(0.2f, Cue.TEXT_SIZE_TYPE_FRACTIONAL)
+ .setSize(0.8f)
+ .setWindowColor(Color.CYAN)
+ .setVerticalType(Cue.VERTICAL_TYPE_RL)
+ .setShearDegrees(-15f)
+ .build();
+ Cue modifiedCue = Cue.fromBundle(cue.toBinderBasedBundle());
+
+ assertThat(modifiedCue).isEqualTo(cue);
+ }
+
+ @Test
+ public void roundTripViaSerializableBundle_yieldsEqualInstance() {
+ Cue cue =
+ new Cue.Builder()
+ .setText(SpannedString.valueOf("text"))
+ .setTextAlignment(Layout.Alignment.ALIGN_CENTER)
+ .setMultiRowAlignment(Layout.Alignment.ALIGN_NORMAL)
+ .setLine(5, Cue.LINE_TYPE_NUMBER)
+ .setLineAnchor(Cue.ANCHOR_TYPE_END)
+ .setPosition(0.4f)
+ .setPositionAnchor(Cue.ANCHOR_TYPE_MIDDLE)
+ .setTextSize(0.2f, Cue.TEXT_SIZE_TYPE_FRACTIONAL)
+ .setSize(0.8f)
+ .setWindowColor(Color.CYAN)
+ .setVerticalType(Cue.VERTICAL_TYPE_RL)
+ .setShearDegrees(-15f)
+ .build();
+ Cue modifiedCue = Cue.fromBundle(cue.toSerializableBundle());
+
+ assertThat(modifiedCue).isEqualTo(cue);
+ }
+
+ @Test
+ @SuppressWarnings("deprecation") // Testing deprecated Cue.toBundle() method
public void roundTripViaBundle_yieldsEqualInstance() {
Cue cue =
new Cue.Builder()
@@ -125,30 +168,36 @@ public class CueTest {
.setVerticalType(Cue.VERTICAL_TYPE_RL)
.setShearDegrees(-15f)
.build();
- Cue modifiedCue = parcelAndUnParcelCue(cue);
+ Cue modifiedCue = Cue.fromBundle(cue.toBundle());
assertThat(modifiedCue).isEqualTo(cue);
}
@Test
- public void roundTripViaBundle_withBitmap_yieldsEqualInstance() {
+ public void roundTripViaBinderBasedBundle_withBitmap_yieldsEqualInstance() {
Cue cue =
new Cue.Builder().setBitmap(Bitmap.createBitmap(1, 1, Bitmap.Config.ARGB_8888)).build();
- Cue modifiedCue = parcelAndUnParcelCue(cue);
+ Cue modifiedCue = Cue.fromBundle(cue.toBinderBasedBundle());
assertThat(modifiedCue).isEqualTo(cue);
}
- private static Cue parcelAndUnParcelCue(Cue cue) {
- Parcel parcel = Parcel.obtain();
- try {
- parcel.writeBundle(cue.toBundle());
- parcel.setDataPosition(0);
+ @Test
+ public void roundTripViaSerializableBundle_withBitmap_yieldsEqualInstance() {
+ Cue cue =
+ new Cue.Builder().setBitmap(Bitmap.createBitmap(1, 1, Bitmap.Config.ARGB_8888)).build();
+ Cue modifiedCue = Cue.fromBundle(cue.toSerializableBundle());
- Bundle bundle = parcel.readBundle();
- return Cue.fromBundle(bundle);
- } finally {
- parcel.recycle();
- }
+ assertThat(modifiedCue).isEqualTo(cue);
+ }
+
+ @Test
+ @SuppressWarnings("deprecation") // Testing deprecated Cue.toBundle() method
+ public void roundTripViaBundle_withBitmap_yieldsEqualInstance() {
+ Cue cue =
+ new Cue.Builder().setBitmap(Bitmap.createBitmap(1, 1, Bitmap.Config.ARGB_8888)).build();
+ Cue modifiedCue = Cue.fromBundle(cue.toBundle());
+
+ assertThat(modifiedCue).isEqualTo(cue);
}
}
diff --git a/libraries/extractor/src/androidTest/java/androidx/media3/extractor/text/CueSerializationTest.java b/libraries/extractor/src/androidTest/java/androidx/media3/extractor/text/CueSerializationTest.java
index 9e09993597..2b6c5ba5fa 100644
--- a/libraries/extractor/src/androidTest/java/androidx/media3/extractor/text/CueSerializationTest.java
+++ b/libraries/extractor/src/androidTest/java/androidx/media3/extractor/text/CueSerializationTest.java
@@ -20,6 +20,7 @@ import static com.google.common.truth.Truth.assertThat;
import android.graphics.Bitmap;
import android.graphics.BitmapFactory;
import android.graphics.Color;
+import android.graphics.ColorSpace;
import android.os.Bundle;
import android.text.Layout;
import android.text.Spannable;
@@ -35,7 +36,6 @@ import androidx.media3.test.utils.truth.SpannedSubject;
import androidx.test.core.app.ApplicationProvider;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import com.google.common.collect.ImmutableList;
-import org.junit.Ignore;
import org.junit.Test;
import org.junit.runner.RunWith;
@@ -96,7 +96,6 @@ public class CueSerializationTest {
}
@Test
- @Ignore("Currently broken: https://github.com/androidx/media/issues/836")
public void serializingBitmapCue() throws Exception {
CueEncoder encoder = new CueEncoder();
CueDecoder decoder = new CueDecoder();
@@ -105,7 +104,13 @@ public class CueSerializationTest {
TestUtil.getByteArray(
ApplicationProvider.getApplicationContext(),
"media/png/non-motion-photo-shortened.png");
- Bitmap bitmap = BitmapFactory.decodeByteArray(imageData, 0, imageData.length);
+ BitmapFactory.Options options = new BitmapFactory.Options();
+ // Without this hint BitmapFactory reads an 'unknown' RGB color space from the file, which
+ // then causes spurious comparison failures later. Using a named RGB color space allows the
+ // Bitmap.isSameAs comparison to succeed.
+ options.inPreferredColorSpace = ColorSpace.get(ColorSpace.Named.SRGB);
+ Bitmap bitmap =
+ BitmapFactory.decodeByteArray(imageData, /* offset= */ 0, imageData.length, options);
Cue bitmapCue = new Cue.Builder().setBitmap(bitmap).build();
// encoding and decoding
diff --git a/libraries/extractor/src/main/java/androidx/media3/extractor/text/CueEncoder.java b/libraries/extractor/src/main/java/androidx/media3/extractor/text/CueEncoder.java
index 9439b98441..93b25d596e 100644
--- a/libraries/extractor/src/main/java/androidx/media3/extractor/text/CueEncoder.java
+++ b/libraries/extractor/src/main/java/androidx/media3/extractor/text/CueEncoder.java
@@ -36,7 +36,8 @@ public final class CueEncoder {
* @return The serialized byte array.
*/
public byte[] encode(List