[video_player] Caching for network data source

AUTHORS

@@ -56,4 +56,6 @@ Giancarlo Rocha <[email protected]>
 Ryo Miyake <[email protected]>
 Théo Champion <[email protected]>
 Kazuki Yamaguchi <[email protected]>
-Eitan Schwartz <[email protected]>
+Eitan Schwartz <[email protected]>
+Aleksandr Yurkovskiy <[email protected]>
+Iurii Dorofeev <[email protected]>

packages/video_player/video_player/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.10.10
+
+* Add caching functionality to videos from network sources.
+
 ## 0.10.9+1
 
 * Readme updated to include web support and details on how to use for web
@@ -21,7 +25,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/VideoPlayer.java

@@ -26,13 +26,20 @@
 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.plugin.common.MethodChannel.Result;
 import io.flutter.view.TextureRegistry;
+import java.io.File;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
@@ -62,8 +69,11 @@ final class VideoPlayer {
       EventChannel eventChannel,
       TextureRegistry.SurfaceTextureEntry textureEntry,
       String dataSource,
-      Result result,
-      String formatHint) {
+      String formatHint,
+      int maxCacheSize,
+      int maxCacheFileSize,
+      boolean useCache,
+      Result result) {
     this.eventChannel = eventChannel;
     this.textureEntry = textureEntry;
 
@@ -81,6 +91,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");
     }
@@ -280,4 +294,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

@@ -24,6 +24,9 @@ public class VideoPlayerPlugin implements MethodCallHandler, FlutterPlugin {
   private final LongSparseArray<VideoPlayer> videoPlayers = new LongSparseArray<>();
   private FlutterState flutterState;
 
+  private int maxCacheSize;
+  private int maxCacheFileSize;
+
   /** Register this with the v2 embedding for the plugin to respond to lifecycle callbacks. */
   public VideoPlayerPlugin() {}
 
@@ -93,7 +96,10 @@ public void onMethodCall(MethodCall call, Result result) {
     }
     switch (call.method) {
       case "init":
+        maxCacheSize = call.argument("maxCacheSize");
+        maxCacheFileSize = call.argument("maxCacheFileSize");
         disposeAllPlayers();
+        result.success(null);
         break;
       case "create":
         {
@@ -119,20 +125,25 @@ public void onMethodCall(MethodCall call, Result result) {
                     eventChannel,
                     handle,
                     "asset:///" + assetLookupKey,
-                    result,
-                    null);
-            videoPlayers.put(handle.id(), player);
+                    null,
+                    maxCacheSize,
+                    maxCacheFileSize,
+                    false,
+                    result);
           } else {
             player =
                 new VideoPlayer(
                     flutterState.applicationContext,
                     eventChannel,
                     handle,
                     call.argument("uri"),
-                    result,
-                    call.argument("formatHint"));
-            videoPlayers.put(handle.id(), player);
+                    call.argument("formatHint"),
+                    maxCacheSize,
+                    maxCacheFileSize,
+                    call.argument("useCache"),
+                    result);
           }
+          videoPlayers.put(handle.id(), player);
           break;
         }
       default:

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"
 
 #if !__has_feature(objc_arc)
 #error Code Requires ARC.
@@ -50,6 +51,7 @@ - (void)play;
 - (void)pause;
 - (void)setIsLooping:(bool)isLooping;
 - (void)updatePlayingState;
++ (VIResourceLoaderManager*)resourceLoaderManager;
 @end
 
 static void* timeRangeContext = &timeRangeContext;
@@ -162,10 +164,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?
@@ -425,6 +446,8 @@ @interface FLTVideoPlayerPlugin ()
 @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
@@ -480,6 +503,9 @@ - (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
       [_players[textureId] dispose];
     }
     [_players removeAllObjects];
+    NSDictionary* argsMap = call.arguments;
+    _maxCacheSize = ((NSNumber*)argsMap[@"maxCacheSize"]).longValue;
+    _maxCacheFileSize = ((NSNumber*)argsMap[@"maxCacheFileSize"]).longValue;
     result(nil);
   } else if ([@"create" isEqualToString:call.method]) {
     NSDictionary* argsMap = call.arguments;
@@ -498,8 +524,20 @@ - (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
       player = [[FLTVideoPlayer alloc] initWithAsset:assetPath frameUpdater:frameUpdater];
       [self onPlayerSetup:player frameUpdater:frameUpdater result:result];
     } else if (uriArg) {
-      player = [[FLTVideoPlayer alloc] initWithURL:[NSURL URLWithString:uriArg]
-                                      frameUpdater:frameUpdater];
+      BOOL useCache = [argsMap[@"useCache"] boolValue];
+      BOOL enableCache = _maxCacheSize > 0 && _maxCacheFileSize > 0 && useCache;
+      if (enableCache) {
+        NSString* escapedURL = [uriArg
+            stringByAddingPercentEncodingWithAllowedCharacters:NSMutableCharacterSet
+                                                                   .alphanumericCharacterSet];
+        player = [[FLTVideoPlayer alloc] initWithURL:[NSURL URLWithString:escapedURL]
+                                        frameUpdater:frameUpdater
+                                         enableCache:enableCache];
+      } else {
+        player = [[FLTVideoPlayer alloc] initWithURL:[NSURL URLWithString:uriArg]
+                                        frameUpdater:frameUpdater];
+      }
+
       [self onPlayerSetup:player frameUpdater:frameUpdater result:result];
     } else {
       result(FlutterMethodNotImplemented);

packages/video_player/video_player/ios/video_player.podspec

@@ -17,6 +17,7 @@ Downloaded by pub (not CocoaPods).
   s.source_files = 'Classes/**/*'
   s.public_header_files = 'Classes/**/*.h'
   s.dependency 'Flutter'
+  s.dependency 'VIMediaCache'
 
   s.platform = :ios, '8.0'
   s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', 'VALID_ARCHS[sdk=iphonesimulator*]' => 'x86_64' }