[video_player] Caching for network data source

AUTHORS

@@ -59,3 +59,5 @@ Kazuki Yamaguchi <[email protected]>
 Eitan Schwartz <[email protected]>
 Chris Rutkowski <[email protected]>
 Juan Alvarez <[email protected]>
+Aleksandr Yurkovskiy <[email protected]>
+Iurii Dorofeev <[email protected]>

packages/video_player/video_player/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.12.0
+
+* Add caching functionality to videos from network sources.
+
 ## 0.11.1+2
 
 * Update android compileSdkVersion to 29.
@@ -85,7 +89,6 @@
 * Added support for cleaning up the plugin if used for add-to-app (Flutter
   v1.15.3 is required for that feature).
 
-
 ## 0.10.7
 
 * `VideoPlayerController` support for reading closed caption files.

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

@@ -12,6 +12,53 @@
 @SuppressWarnings("unused")
 public class Messages {
 
+  /** Generated class from Pigeon that represents data sent in messages. */
+  public static class InitializeMessage {
+    private Long maxCacheSize;
+
+    public Long getMaxCacheSize() {
+      return maxCacheSize;
+    }
+
+    public void setMaxCacheSize(Long setterArg) {
+      this.maxCacheSize = setterArg;
+    }
+
+    private Long maxCacheFileSize;
+
+    public Long getMaxCacheFileSize() {
+      return maxCacheFileSize;
+    }
+
+    public void setMaxCacheFileSize(Long setterArg) {
+      this.maxCacheFileSize = setterArg;
+    }
+
+    HashMap toMap() {
+      HashMap<String, Object> toMapResult = new HashMap<>();
+      toMapResult.put("maxCacheSize", maxCacheSize);
+      toMapResult.put("maxCacheFileSize", maxCacheFileSize);
+      return toMapResult;
+    }
+
+    static InitializeMessage fromMap(HashMap map) {
+      InitializeMessage fromMapResult = new InitializeMessage();
+      Object maxCacheSize = map.get("maxCacheSize");
+      fromMapResult.maxCacheSize =
+          (maxCacheSize == null)
+              ? null
+              : ((maxCacheSize instanceof Integer) ? (Integer) maxCacheSize : (Long) maxCacheSize);
+      Object maxCacheFileSize = map.get("maxCacheFileSize");
+      fromMapResult.maxCacheFileSize =
+          (maxCacheFileSize == null)
+              ? null
+              : ((maxCacheFileSize instanceof Integer)
+                  ? (Integer) maxCacheFileSize
+                  : (Long) maxCacheFileSize);
+      return fromMapResult;
+    }
+  }
+
   /** Generated class from Pigeon that represents data sent in messages. */
   public static class TextureMessage {
     private Long textureId;
@@ -83,12 +130,23 @@ public void setFormatHint(String setterArg) {
       this.formatHint = setterArg;
     }
 
+    private Boolean useCache;
+
+    public Boolean getUseCache() {
+      return useCache;
+    }
+
+    public void setUseCache(Boolean setterArg) {
+      this.useCache = setterArg;
+    }
+
     HashMap toMap() {
       HashMap<String, Object> toMapResult = new HashMap<>();
       toMapResult.put("asset", asset);
       toMapResult.put("uri", uri);
       toMapResult.put("packageName", packageName);
       toMapResult.put("formatHint", formatHint);
+      toMapResult.put("useCache", useCache);
       return toMapResult;
     }
 
@@ -102,6 +160,8 @@ static CreateMessage fromMap(HashMap map) {
       fromMapResult.packageName = (String) packageName;
       Object formatHint = map.get("formatHint");
       fromMapResult.formatHint = (String) formatHint;
+      Object useCache = map.get("useCache");
+      fromMapResult.useCache = (Boolean) useCache;
       return fromMapResult;
     }
   }
@@ -305,7 +365,7 @@ static MixWithOthersMessage fromMap(HashMap map) {
 
   /** Generated interface from Pigeon that represents a handler of messages from Flutter. */
   public interface VideoPlayerApi {
-    void initialize();
+    void initialize(InitializeMessage arg);
 
     TextureMessage create(CreateMessage arg);
 
@@ -340,7 +400,9 @@ static void setup(BinaryMessenger binaryMessenger, VideoPlayerApi api) {
               (message, reply) -> {
                 HashMap<String, HashMap> wrapped = new HashMap<>();
                 try {
-                  api.initialize();
+                  @SuppressWarnings("ConstantConditions")
+                  InitializeMessage input = InitializeMessage.fromMap((HashMap) message);
+                  api.initialize(input);
                   wrapped.put("result", null);
                 } catch (Exception exception) {
                   wrapped.put("error", wrapError(exception));

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

@@ -27,12 +27,19 @@
 import com.google.android.exoplayer2.trackselection.DefaultTrackSelector;
 import com.google.android.exoplayer2.trackselection.TrackSelector;
 import com.google.android.exoplayer2.upstream.DataSource;
+import com.google.android.exoplayer2.upstream.DefaultBandwidthMeter;
 import com.google.android.exoplayer2.upstream.DefaultDataSourceFactory;
 import com.google.android.exoplayer2.upstream.DefaultHttpDataSource;
 import com.google.android.exoplayer2.upstream.DefaultHttpDataSourceFactory;
+import com.google.android.exoplayer2.upstream.FileDataSource;
+import com.google.android.exoplayer2.upstream.cache.CacheDataSink;
+import com.google.android.exoplayer2.upstream.cache.CacheDataSource;
+import com.google.android.exoplayer2.upstream.cache.LeastRecentlyUsedCacheEvictor;
+import com.google.android.exoplayer2.upstream.cache.SimpleCache;
 import com.google.android.exoplayer2.util.Util;
 import io.flutter.plugin.common.EventChannel;
 import io.flutter.view.TextureRegistry;
+import java.io.File;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
@@ -65,7 +72,10 @@ final class VideoPlayer {
       TextureRegistry.SurfaceTextureEntry textureEntry,
       String dataSource,
       String formatHint,
-      VideoPlayerOptions options) {
+      VideoPlayerOptions options,
+      long maxCacheSize,
+      long maxCacheFileSize,
+      boolean useCache) {
     this.eventChannel = eventChannel;
     this.textureEntry = textureEntry;
     this.options = options;
@@ -84,6 +94,10 @@ final class VideoPlayer {
               DefaultHttpDataSource.DEFAULT_CONNECT_TIMEOUT_MILLIS,
               DefaultHttpDataSource.DEFAULT_READ_TIMEOUT_MILLIS,
               true);
+      if (useCache && maxCacheSize > 0 && maxCacheFileSize > 0) {
+        dataSourceFactory =
+            new CacheDataSourceFactory(context, maxCacheSize, maxCacheFileSize, dataSourceFactory);
+      }
     } else {
       dataSourceFactory = new DefaultDataSourceFactory(context, "ExoPlayer");
     }
@@ -287,4 +301,42 @@ void dispose() {
       exoPlayer.release();
     }
   }
+
+  static class CacheDataSourceFactory implements DataSource.Factory {
+    private final Context context;
+    private final DefaultDataSourceFactory defaultDatasourceFactory;
+    private final long maxFileSize, maxCacheSize;
+    private static SimpleCache downloadCache;
+
+    CacheDataSourceFactory(
+        Context context,
+        long maxCacheSize,
+        long maxFileSize,
+        DataSource.Factory upstreamDataSource) {
+      super();
+      this.context = context;
+      this.maxCacheSize = maxCacheSize;
+      this.maxFileSize = maxFileSize;
+      DefaultBandwidthMeter bandwidthMeter = new DefaultBandwidthMeter();
+      defaultDatasourceFactory =
+          new DefaultDataSourceFactory(this.context, bandwidthMeter, upstreamDataSource);
+    }
+
+    @Override
+    public DataSource createDataSource() {
+      LeastRecentlyUsedCacheEvictor evictor = new LeastRecentlyUsedCacheEvictor(maxCacheSize);
+
+      if (downloadCache == null) {
+        downloadCache = new SimpleCache(new File(context.getCacheDir(), "video"), evictor);
+      }
+
+      return new CacheDataSource(
+          downloadCache,
+          defaultDatasourceFactory.createDataSource(),
+          new FileDataSource(),
+          new CacheDataSink(downloadCache, maxFileSize),
+          CacheDataSource.FLAG_BLOCK_ON_CACHE | CacheDataSource.FLAG_IGNORE_CACHE_ON_ERROR,
+          null);
+    }
+  }
 }

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

@@ -13,6 +13,7 @@
 import io.flutter.plugin.common.BinaryMessenger;
 import io.flutter.plugin.common.EventChannel;
 import io.flutter.plugins.videoplayer.Messages.CreateMessage;
+import io.flutter.plugins.videoplayer.Messages.InitializeMessage;
 import io.flutter.plugins.videoplayer.Messages.LoopingMessage;
 import io.flutter.plugins.videoplayer.Messages.MixWithOthersMessage;
 import io.flutter.plugins.videoplayer.Messages.PlaybackSpeedMessage;
@@ -32,6 +33,9 @@ public class VideoPlayerPlugin implements FlutterPlugin, VideoPlayerApi {
   private FlutterState flutterState;
   private VideoPlayerOptions options = new VideoPlayerOptions();
 
+  private long maxCacheSize;
+  private long maxCacheFileSize;
+
   /** Register this with the v2 embedding for the plugin to respond to lifecycle callbacks. */
   public VideoPlayerPlugin() {}
 
@@ -110,8 +114,10 @@ private void onDestroy() {
     disposeAllPlayers();
   }
 
-  public void initialize() {
+  public void initialize(InitializeMessage arg) {
     disposeAllPlayers();
+    maxCacheSize = arg.getMaxCacheSize();
+    maxCacheFileSize = arg.getMaxCacheFileSize();
   }
 
   public TextureMessage create(CreateMessage arg) {
@@ -137,7 +143,10 @@ public TextureMessage create(CreateMessage arg) {
               handle,
               "asset:///" + assetLookupKey,
               null,
-              options);
+              options,
+              maxCacheSize,
+              maxCacheFileSize,
+              false);
       videoPlayers.put(handle.id(), player);
     } else {
       player =
@@ -147,7 +156,10 @@ public TextureMessage create(CreateMessage arg) {
               handle,
               arg.getUri(),
               arg.getFormatHint(),
-              options);
+              options,
+              maxCacheSize,
+              maxCacheFileSize,
+              arg.getUseCache());
       videoPlayers.put(handle.id(), player);
     }
 

packages/video_player/video_player/example/lib/main.dart

@@ -6,7 +6,6 @@
 
 /// An example of using the plugin, controlling lifecycle and playback of the
 /// video.
-
 import 'package:flutter/cupertino.dart';
 import 'package:flutter/material.dart';
 import 'package:video_player/video_player.dart';
@@ -221,6 +220,7 @@ class _BumbleBeeRemoteVideoState extends State<_BumbleBeeRemoteVideo> {
       'https://flutter.github.io/assets-for-api-docs/assets/videos/bee.mp4',
       closedCaptionFile: _loadCaptions(),
       videoPlayerOptions: VideoPlayerOptions(mixWithOthers: true),
+      useCache: true,
     );
 
     _controller.addListener(() {

packages/video_player/video_player/ios/Classes/FLTVideoPlayerPlugin.m

@@ -5,6 +5,7 @@
 #import "FLTVideoPlayerPlugin.h"
 #import <AVFoundation/AVFoundation.h>
 #import <GLKit/GLKit.h>
+#import "VIMediaCache.h"
 #import "messages.h"
 
 #if !__has_feature(objc_arc)
@@ -51,6 +52,7 @@ - (void)play;
 - (void)pause;
 - (void)setIsLooping:(bool)isLooping;
 - (void)updatePlayingState;
++ (VIResourceLoaderManager*)resourceLoaderManager;
 @end
 
 static void* timeRangeContext = &timeRangeContext;
@@ -163,10 +165,29 @@ - (void)createVideoOutputAndDisplayLink:(FLTFrameUpdater*)frameUpdater {
 }
 
 - (instancetype)initWithURL:(NSURL*)url frameUpdater:(FLTFrameUpdater*)frameUpdater {
-  AVPlayerItem* item = [AVPlayerItem playerItemWithURL:url];
+  return [self initWithURL:url frameUpdater:frameUpdater enableCache:NO];
+}
+
+- (instancetype)initWithURL:(NSURL*)url
+               frameUpdater:(FLTFrameUpdater*)frameUpdater
+                enableCache:(BOOL)enableCache {
+  AVPlayerItem* item;
+  if (enableCache) {
+    item = [[FLTVideoPlayer resourceLoaderManager] playerItemWithURL:url];
+  } else {
+    item = [AVPlayerItem playerItemWithURL:url];
+  }
   return [self initWithPlayerItem:item frameUpdater:frameUpdater];
 }
 
++ (VIResourceLoaderManager*)resourceLoaderManager {
+  static VIResourceLoaderManager* resourceLoaderManager = nil;
+  if (resourceLoaderManager == nil) {
+    resourceLoaderManager = [VIResourceLoaderManager new];
+  }
+  return resourceLoaderManager;
+}
+
 - (CGAffineTransform)fixTransform:(AVAssetTrack*)videoTrack {
   CGAffineTransform transform = videoTrack.preferredTransform;
   // TODO(@recastrodiaz): why do we need to do this? Why is the preferredTransform incorrect?
@@ -450,6 +471,8 @@ @interface FLTVideoPlayerPlugin () <FLTVideoPlayerApi>
 @property(readonly, weak, nonatomic) NSObject<FlutterBinaryMessenger>* messenger;
 @property(readonly, strong, nonatomic) NSMutableDictionary* players;
 @property(readonly, strong, nonatomic) NSObject<FlutterPluginRegistrar>* registrar;
+@property(readonly, nonatomic) long maxCacheSize;
+@property(readonly, nonatomic) long maxCacheFileSize;
 @end
 
 @implementation FLTVideoPlayerPlugin
@@ -497,7 +520,7 @@ - (FLTTextureMessage*)onPlayerSetup:(FLTVideoPlayer*)player
   return result;
 }
 
-- (void)initialize:(FlutterError* __autoreleasing*)error {
+- (void)initialize:(FLTInitializeMessage*)input error:(FlutterError**)error {
   // Allow audio playback when the Ring/Silent switch is set to silent
   [[AVAudioSession sharedInstance] setCategory:AVAudioSessionCategoryPlayback error:nil];
 
@@ -506,6 +529,8 @@ - (void)initialize:(FlutterError* __autoreleasing*)error {
     [_players[textureId] dispose];
   }
   [_players removeAllObjects];
+  _maxCacheSize = [input.maxCacheSize longValue];
+  _maxCacheFileSize = [input.maxCacheFileSize longValue];
 }
 
 - (FLTTextureMessage*)create:(FLTCreateMessage*)input error:(FlutterError**)error {
@@ -521,8 +546,20 @@ - (FLTTextureMessage*)create:(FLTCreateMessage*)input error:(FlutterError**)erro
     player = [[FLTVideoPlayer alloc] initWithAsset:assetPath frameUpdater:frameUpdater];
     return [self onPlayerSetup:player frameUpdater:frameUpdater];
   } else if (input.uri) {
-    player = [[FLTVideoPlayer alloc] initWithURL:[NSURL URLWithString:input.uri]
-                                    frameUpdater:frameUpdater];
+    BOOL useCache = input.useCache;
+    BOOL enableCache = _maxCacheSize > 0 && _maxCacheFileSize > 0 && useCache;
+    if (enableCache) {
+      NSString* escapedURL = [input.uri
+          stringByAddingPercentEncodingWithAllowedCharacters:NSMutableCharacterSet
+                                                                 .alphanumericCharacterSet];
+
+      player = [[FLTVideoPlayer alloc] initWithURL:[NSURL URLWithString:escapedURL]
+                                      frameUpdater:frameUpdater
+                                       enableCache:enableCache];
+    } else {
+      player = [[FLTVideoPlayer alloc] initWithURL:[NSURL URLWithString:input.uri]
+                                      frameUpdater:frameUpdater];
+    }
     return [self onPlayerSetup:player frameUpdater:frameUpdater];
   } else {
     *error = [FlutterError errorWithCode:@"video_player" message:@"not implemented" details:nil];