From 8e33fbd53684ba12bd1c50c55fd3aed843f6a11b Mon Sep 17 00:00:00 2001
From: tonihei <tonihei@google.com>
Date: Tue, 12 Dec 2023 05:31:36 -0800
Subject: [PATCH] Deprecate RAW_RESOURCE_SCHEME and util method

It's better to use the generic Android resource scheme which
is at least as powerful as our own one.

Issue: androidx/media#868
PiperOrigin-RevId: 590168919
---
 .../RawResourceDataSourceContractTest.java    |  3 +-
 .../media3/datasource/DefaultDataSource.java  |  3 ++
 .../datasource/RawResourceDataSource.java     | 28 ++++++++++---------
 3 files changed, 20 insertions(+), 14 deletions(-)

diff --git a/libraries/datasource/src/androidTest/java/androidx/media3/datasource/RawResourceDataSourceContractTest.java b/libraries/datasource/src/androidTest/java/androidx/media3/datasource/RawResourceDataSourceContractTest.java
index b78ca02cfe..6080fbb935 100644
--- a/libraries/datasource/src/androidTest/java/androidx/media3/datasource/RawResourceDataSourceContractTest.java
+++ b/libraries/datasource/src/androidTest/java/androidx/media3/datasource/RawResourceDataSourceContractTest.java
@@ -38,6 +38,7 @@ public final class RawResourceDataSourceContractTest extends DataSourceContractT
     return new RawResourceDataSource(ApplicationProvider.getApplicationContext());
   }
 
+  @SuppressWarnings("deprecation") // Testing deprecated buildRawResourceUri method
   @Override
   protected ImmutableList<TestResource> getTestResources() {
     // Android packages raw resources into a single file. When reading a resource other than the
@@ -100,6 +101,6 @@ public final class RawResourceDataSourceContractTest extends DataSourceContractT
 
   @Override
   protected Uri getNotFoundUri() {
-    return RawResourceDataSource.buildRawResourceUri(Resources.ID_NULL);
+    return Uri.parse("android.resource://" + Resources.ID_NULL);
   }
 }
diff --git a/libraries/datasource/src/main/java/androidx/media3/datasource/DefaultDataSource.java b/libraries/datasource/src/main/java/androidx/media3/datasource/DefaultDataSource.java
index 379a77fbc8..09892d3ac8 100644
--- a/libraries/datasource/src/main/java/androidx/media3/datasource/DefaultDataSource.java
+++ b/libraries/datasource/src/main/java/androidx/media3/datasource/DefaultDataSource.java
@@ -126,7 +126,10 @@ public final class DefaultDataSource implements DataSource {
   private static final String SCHEME_RTMP = "rtmp";
   private static final String SCHEME_UDP = "udp";
   private static final String SCHEME_DATA = DataSchemeDataSource.SCHEME_DATA;
+
+  @SuppressWarnings("deprecation") // Detecting deprecated scheme.
   private static final String SCHEME_RAW = RawResourceDataSource.RAW_RESOURCE_SCHEME;
+
   private static final String SCHEME_ANDROID_RESOURCE = ContentResolver.SCHEME_ANDROID_RESOURCE;
 
   private final Context context;
diff --git a/libraries/datasource/src/main/java/androidx/media3/datasource/RawResourceDataSource.java b/libraries/datasource/src/main/java/androidx/media3/datasource/RawResourceDataSource.java
index 574ccd90e8..6d5da27b8f 100644
--- a/libraries/datasource/src/main/java/androidx/media3/datasource/RawResourceDataSource.java
+++ b/libraries/datasource/src/main/java/androidx/media3/datasource/RawResourceDataSource.java
@@ -40,11 +40,9 @@ import java.nio.channels.FileChannel;
 /**
  * A {@link DataSource} for reading a raw resource.
  *
- * <p>URIs supported by this source are of one of the forms:
+ * <p>URIs supported by this source are:
  *
  * <ul>
- *   <li>{@code rawresource:///id}, where {@code id} is the integer identifier of a raw resource in
- *       this application.
  *   <li>{@code android.resource:///id}, where {@code id} is the integer identifier of a raw
  *       resource in this application.
  *   <li>{@code android.resource://[package]/[type/]name}, where {@code package} is the name of the
@@ -64,7 +62,9 @@ import java.nio.channels.FileChannel;
  * the ecosystem (including being <a href="https://stackoverflow.com/a/4896272">recommended on Stack
  * Overflow</a>).
  *
- * <p>{@link #buildRawResourceUri(int)} can be used to build supported {@link Uri}s.
+ * <p>{@code new
+ * Uri.Builder().scheme(ContentResolver.SCHEME_ANDROID_RESOURCE).path(Integer.toString(resourceId)).build()}
+ * can be used to build supported {@link Uri}s.
  */
 @UnstableApi
 public final class RawResourceDataSource extends BaseDataSource {
@@ -97,17 +97,20 @@ public final class RawResourceDataSource extends BaseDataSource {
   }
 
   /**
-   * Builds a {@link Uri} for the specified raw resource identifier.
-   *
-   * @param rawResourceId A raw resource identifier (i.e. a constant defined in {@code R.raw}).
-   * @return The corresponding {@link Uri}.
+   * @deprecated Use {@code new
+   *     Uri.Builder().scheme(ContentResolver.SCHEME_ANDROID_RESOURCE).path(Integer.toString(rawResourceId)).build()}
+   *     instead.
    */
+  @SuppressWarnings("deprecation") // Using deprecated scheme
+  @Deprecated
   public static Uri buildRawResourceUri(int rawResourceId) {
     return Uri.parse(RAW_RESOURCE_SCHEME + ":///" + rawResourceId);
   }
 
-  /** The scheme part of a raw resource URI. */
-  public static final String RAW_RESOURCE_SCHEME = "rawresource";
+  /**
+   * @deprecated Use {@link ContentResolver#SCHEME_ANDROID_RESOURCE} instead.
+   */
+  @Deprecated public static final String RAW_RESOURCE_SCHEME = "rawresource";
 
   private final Context applicationContext;
 
@@ -200,6 +203,7 @@ public final class RawResourceDataSource extends BaseDataSource {
   }
 
   /** Resolves {@code dataSpec.uri} to an {@link AssetFileDescriptor}. */
+  @SuppressWarnings("deprecation") // Accepting deprecated scheme
   private static AssetFileDescriptor openAssetFileDescriptor(
       Context applicationContext, DataSpec dataSpec) throws RawResourceDataSourceException {
     Uri normalizedUri = dataSpec.uri.normalizeScheme();
@@ -261,10 +265,8 @@ public final class RawResourceDataSource extends BaseDataSource {
           "Unsupported URI scheme ("
               + normalizedUri.getScheme()
               + "). Only "
-              + RAW_RESOURCE_SCHEME
-              + " and "
               + ContentResolver.SCHEME_ANDROID_RESOURCE
-              + " are supported.",
+              + " is supported.",
           /* cause= */ null,
           PlaybackException.ERROR_CODE_FAILED_RUNTIME_CHECK);
     }