[video_player] Move more Java logic to Dart (#9672)

Moves some logic from native code to Dart:
- User-Agent header -> ExoPlayer user agent extraction logic (with TODOs for future improvements, based on implementation issues/questions I noticed while converting it).
- Asset -> URL lookup.
- Conversion of buffer position to the buffer range list required for the Dart event stream.

Also converts video format hint from strings to enums, which was missed in earlier Pigeon conversions. Using strings was the pre-Pigeon way of handling this kind of thing.

Part of flutter/flutter#172763

## Pre-Review Checklist

**Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

[^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.

Author: stuartmorgan-g

packages/video_player/video_player_android/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.8.10
+
+* Restructures internal logic to move more code to Dart.
+
 ## 2.8.9
 
 * Restructures the communication between Dart and Java code.

packages/video_player/video_player_android/android/src/main/java/io/flutter/plugins/videoplayer/HttpVideoAsset.java

@@ -20,19 +20,19 @@
 import java.util.Map;
 
 final class HttpVideoAsset extends VideoAsset {
-  private static final String DEFAULT_USER_AGENT = "ExoPlayer";
-  private static final String HEADER_USER_AGENT = "User-Agent";
-
   @NonNull private final StreamingFormat streamingFormat;
   @NonNull private final Map<String, String> httpHeaders;
+  @Nullable private final String userAgent;
 
   HttpVideoAsset(
       @Nullable String assetUrl,
       @NonNull StreamingFormat streamingFormat,
-      @NonNull Map<String, String> httpHeaders) {
+      @NonNull Map<String, String> httpHeaders,
+      @Nullable String userAgent) {
     super(assetUrl);
     this.streamingFormat = streamingFormat;
     this.httpHeaders = httpHeaders;
+    this.userAgent = userAgent;
   }
 
   @NonNull
@@ -75,10 +75,6 @@ public MediaSource.Factory getMediaSourceFactory(@NonNull Context context) {
   @VisibleForTesting
   MediaSource.Factory getMediaSourceFactory(
       Context context, DefaultHttpDataSource.Factory initialFactory) {
-    String userAgent = DEFAULT_USER_AGENT;
-    if (!httpHeaders.isEmpty() && httpHeaders.containsKey(HEADER_USER_AGENT)) {
-      userAgent = httpHeaders.get(HEADER_USER_AGENT);
-    }
     unstableUpdateDataSourceFactory(initialFactory, httpHeaders, userAgent);
     DataSource.Factory dataSourceFactory = new DefaultDataSource.Factory(context, initialFactory);
     return new DefaultMediaSourceFactory(context).setDataSourceFactory(dataSourceFactory);

packages/video_player/video_player_android/android/src/main/java/io/flutter/plugins/videoplayer/Messages.java

@@ -77,6 +77,19 @@ public enum PlatformVideoViewType {
     }
   }
 
+  /** Pigeon equivalent of video_platform_interface's VideoFormat. */
+  public enum PlatformVideoFormat {
+    DASH(0),
+    HLS(1),
+    SS(2);
+
+    final int index;
+
+    PlatformVideoFormat(final int index) {
+      this.index = index;
+    }
+  }
+
   /**
    * Information passed to the platform view creation.
    *
@@ -151,43 +164,26 @@ ArrayList<Object> toList() {
 
   /** Generated class from Pigeon that represents data sent in messages. */
   public static final class CreateMessage {
-    private @Nullable String asset;
-
-    public @Nullable String getAsset() {
-      return asset;
-    }
+    private @NonNull String uri;
 
-    public void setAsset(@Nullable String setterArg) {
-      this.asset = setterArg;
-    }
-
-    private @Nullable String uri;
-
-    public @Nullable String getUri() {
+    public @NonNull String getUri() {
       return uri;
     }
 
-    public void setUri(@Nullable String setterArg) {
+    public void setUri(@NonNull String setterArg) {
+      if (setterArg == null) {
+        throw new IllegalStateException("Nonnull field \"uri\" is null.");
+      }
       this.uri = setterArg;
     }
 
-    private @Nullable String packageName;
-
-    public @Nullable String getPackageName() {
-      return packageName;
-    }
-
-    public void setPackageName(@Nullable String setterArg) {
-      this.packageName = setterArg;
-    }
+    private @Nullable PlatformVideoFormat formatHint;
 
-    private @Nullable String formatHint;
-
-    public @Nullable String getFormatHint() {
+    public @Nullable PlatformVideoFormat getFormatHint() {
       return formatHint;
     }
 
-    public void setFormatHint(@Nullable String setterArg) {
+    public void setFormatHint(@Nullable PlatformVideoFormat setterArg) {
       this.formatHint = setterArg;
     }
 
@@ -204,6 +200,16 @@ public void setHttpHeaders(@NonNull Map<String, String> setterArg) {
       this.httpHeaders = setterArg;
     }
 
+    private @Nullable String userAgent;
+
+    public @Nullable String getUserAgent() {
+      return userAgent;
+    }
+
+    public void setUserAgent(@Nullable String setterArg) {
+      this.userAgent = setterArg;
+    }
+
     private @Nullable PlatformVideoViewType viewType;
 
     public @Nullable PlatformVideoViewType getViewType() {
@@ -226,58 +232,49 @@ public boolean equals(Object o) {
         return false;
       }
       CreateMessage that = (CreateMessage) o;
-      return Objects.equals(asset, that.asset)
-          && Objects.equals(uri, that.uri)
-          && Objects.equals(packageName, that.packageName)
+      return uri.equals(that.uri)
           && Objects.equals(formatHint, that.formatHint)
           && httpHeaders.equals(that.httpHeaders)
+          && Objects.equals(userAgent, that.userAgent)
           && Objects.equals(viewType, that.viewType);
     }
 
     @Override
     public int hashCode() {
-      return Objects.hash(asset, uri, packageName, formatHint, httpHeaders, viewType);
+      return Objects.hash(uri, formatHint, httpHeaders, userAgent, viewType);
     }
 
     public static final class Builder {
 
-      private @Nullable String asset;
-
-      @CanIgnoreReturnValue
-      public @NonNull Builder setAsset(@Nullable String setterArg) {
-        this.asset = setterArg;
-        return this;
-      }
-
       private @Nullable String uri;
 
       @CanIgnoreReturnValue
-      public @NonNull Builder setUri(@Nullable String setterArg) {
+      public @NonNull Builder setUri(@NonNull String setterArg) {
         this.uri = setterArg;
         return this;
       }
 
-      private @Nullable String packageName;
+      private @Nullable PlatformVideoFormat formatHint;
 
       @CanIgnoreReturnValue
-      public @NonNull Builder setPackageName(@Nullable String setterArg) {
-        this.packageName = setterArg;
+      public @NonNull Builder setFormatHint(@Nullable PlatformVideoFormat setterArg) {
+        this.formatHint = setterArg;
         return this;
       }
 
-      private @Nullable String formatHint;
+      private @Nullable Map<String, String> httpHeaders;
 
       @CanIgnoreReturnValue
-      public @NonNull Builder setFormatHint(@Nullable String setterArg) {
-        this.formatHint = setterArg;
+      public @NonNull Builder setHttpHeaders(@NonNull Map<String, String> setterArg) {
+        this.httpHeaders = setterArg;
         return this;
       }
 
-      private @Nullable Map<String, String> httpHeaders;
+      private @Nullable String userAgent;
 
       @CanIgnoreReturnValue
-      public @NonNull Builder setHttpHeaders(@NonNull Map<String, String> setterArg) {
-        this.httpHeaders = setterArg;
+      public @NonNull Builder setUserAgent(@Nullable String setterArg) {
+        this.userAgent = setterArg;
         return this;
       }
 
@@ -291,41 +288,37 @@ public static final class Builder {
 
       public @NonNull CreateMessage build() {
         CreateMessage pigeonReturn = new CreateMessage();
-        pigeonReturn.setAsset(asset);
         pigeonReturn.setUri(uri);
-        pigeonReturn.setPackageName(packageName);
         pigeonReturn.setFormatHint(formatHint);
         pigeonReturn.setHttpHeaders(httpHeaders);
+        pigeonReturn.setUserAgent(userAgent);
         pigeonReturn.setViewType(viewType);
         return pigeonReturn;
       }
     }
 
     @NonNull
     ArrayList<Object> toList() {
-      ArrayList<Object> toListResult = new ArrayList<>(6);
-      toListResult.add(asset);
+      ArrayList<Object> toListResult = new ArrayList<>(5);
       toListResult.add(uri);
-      toListResult.add(packageName);
       toListResult.add(formatHint);
       toListResult.add(httpHeaders);
+      toListResult.add(userAgent);
       toListResult.add(viewType);
       return toListResult;
     }
 
     static @NonNull CreateMessage fromList(@NonNull ArrayList<Object> pigeonVar_list) {
       CreateMessage pigeonResult = new CreateMessage();
-      Object asset = pigeonVar_list.get(0);
-      pigeonResult.setAsset((String) asset);
-      Object uri = pigeonVar_list.get(1);
+      Object uri = pigeonVar_list.get(0);
       pigeonResult.setUri((String) uri);
-      Object packageName = pigeonVar_list.get(2);
-      pigeonResult.setPackageName((String) packageName);
-      Object formatHint = pigeonVar_list.get(3);
-      pigeonResult.setFormatHint((String) formatHint);
-      Object httpHeaders = pigeonVar_list.get(4);
+      Object formatHint = pigeonVar_list.get(1);
+      pigeonResult.setFormatHint((PlatformVideoFormat) formatHint);
+      Object httpHeaders = pigeonVar_list.get(2);
       pigeonResult.setHttpHeaders((Map<String, String>) httpHeaders);
-      Object viewType = pigeonVar_list.get(5);
+      Object userAgent = pigeonVar_list.get(3);
+      pigeonResult.setUserAgent((String) userAgent);
+      Object viewType = pigeonVar_list.get(4);
       pigeonResult.setViewType((PlatformVideoViewType) viewType);
       return pigeonResult;
     }
@@ -345,8 +338,13 @@ protected Object readValueOfType(byte type, @NonNull ByteBuffer buffer) {
             return value == null ? null : PlatformVideoViewType.values()[((Long) value).intValue()];
           }
         case (byte) 130:
-          return PlatformVideoViewCreationParams.fromList((ArrayList<Object>) readValue(buffer));
+          {
+            Object value = readValue(buffer);
+            return value == null ? null : PlatformVideoFormat.values()[((Long) value).intValue()];
+          }
         case (byte) 131:
+          return PlatformVideoViewCreationParams.fromList((ArrayList<Object>) readValue(buffer));
+        case (byte) 132:
           return CreateMessage.fromList((ArrayList<Object>) readValue(buffer));
         default:
           return super.readValueOfType(type, buffer);
@@ -358,11 +356,14 @@ protected void writeValue(@NonNull ByteArrayOutputStream stream, Object value) {
       if (value instanceof PlatformVideoViewType) {
         stream.write(129);
         writeValue(stream, value == null ? null : ((PlatformVideoViewType) value).index);
-      } else if (value instanceof PlatformVideoViewCreationParams) {
+      } else if (value instanceof PlatformVideoFormat) {
         stream.write(130);
+        writeValue(stream, value == null ? null : ((PlatformVideoFormat) value).index);
+      } else if (value instanceof PlatformVideoViewCreationParams) {
+        stream.write(131);
         writeValue(stream, ((PlatformVideoViewCreationParams) value).toList());
       } else if (value instanceof CreateMessage) {
-        stream.write(131);
+        stream.write(132);
         writeValue(stream, ((CreateMessage) value).toList());
       } else {
         super.writeValue(stream, value);
@@ -382,6 +383,9 @@ public interface AndroidVideoPlayerApi {
 
     void setMixWithOthers(@NonNull Boolean mixWithOthers);
 
+    @NonNull
+    String getLookupKeyForAsset(@NonNull String asset, @Nullable String packageName);
+
     /** The codec used by AndroidVideoPlayerApi. */
     static @NonNull MessageCodec<Object> getCodec() {
       return PigeonCodec.INSTANCE;
@@ -498,6 +502,32 @@ static void setUp(
           channel.setMessageHandler(null);
         }
       }
+      {
+        BasicMessageChannel<Object> channel =
+            new BasicMessageChannel<>(
+                binaryMessenger,
+                "dev.flutter.pigeon.video_player_android.AndroidVideoPlayerApi.getLookupKeyForAsset"
+                    + messageChannelSuffix,
+                getCodec());
+        if (api != null) {
+          channel.setMessageHandler(
+              (message, reply) -> {
+                ArrayList<Object> wrapped = new ArrayList<>();
+                ArrayList<Object> args = (ArrayList<Object>) message;
+                String assetArg = (String) args.get(0);
+                String packageNameArg = (String) args.get(1);
+                try {
+                  String output = api.getLookupKeyForAsset(assetArg, packageNameArg);
+                  wrapped.add(0, output);
+                } catch (Throwable exception) {
+                  wrapped = wrapError(exception);
+                }
+                reply.reply(wrapped);
+              });
+        } else {
+          channel.setMessageHandler(null);
+        }
+      }
     }
   }
   /** Generated interface from Pigeon that represents a handler of messages from Flutter. */

packages/video_player/video_player_android/android/src/main/java/io/flutter/plugins/videoplayer/RtspVideoAsset.java

@@ -26,7 +26,8 @@ public MediaItem getMediaItem() {
   // TODO: Migrate to stable API, see https://github.com/flutter/flutter/issues/147039.
   @OptIn(markerClass = UnstableApi.class)
   @Override
-  public MediaSource.Factory getMediaSourceFactory(Context context) {
+  @NonNull
+  public MediaSource.Factory getMediaSourceFactory(@NonNull Context context) {
     return new RtspMediaSource.Factory();
   }
 }

packages/video_player/video_player_android/android/src/main/java/io/flutter/plugins/videoplayer/VideoAsset.java

@@ -40,8 +40,9 @@ static VideoAsset fromAssetUrl(@NonNull String assetUrl) {
   static VideoAsset fromRemoteUrl(
       @Nullable String remoteUrl,
       @NonNull StreamingFormat streamingFormat,
-      @NonNull Map<String, String> httpHeaders) {
-    return new HttpVideoAsset(remoteUrl, streamingFormat, new HashMap<>(httpHeaders));
+      @NonNull Map<String, String> httpHeaders,
+      @Nullable String userAgent) {
+    return new HttpVideoAsset(remoteUrl, streamingFormat, new HashMap<>(httpHeaders), userAgent);
   }
 
   /**

packages/video_player/video_player_android/android/src/main/java/io/flutter/plugins/videoplayer/VideoPlayerEventCallbacks.java

@@ -8,10 +8,7 @@
 import androidx.annotation.Nullable;
 import androidx.annotation.VisibleForTesting;
 import io.flutter.plugin.common.EventChannel;
-import java.util.Arrays;
-import java.util.Collections;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 
 final class VideoPlayerEventCallbacks implements VideoPlayerCallbacks {
@@ -66,12 +63,9 @@ public void onBufferingStart() {
 
   @Override
   public void onBufferingUpdate(long bufferedPosition) {
-    // iOS supports a list of buffered ranges, so we send as a list with a single range.
     Map<String, Object> event = new HashMap<>();
     event.put("event", "bufferingUpdate");
-
-    List<? extends Number> range = Arrays.asList(0, bufferedPosition);
-    event.put("values", Collections.singletonList(range));
+    event.put("position", bufferedPosition);
     eventSink.success(event);
   }