[video_player_avfoundation] Platform view support

packages/video_player/video_player/example/pubspec.yaml

@@ -35,3 +35,15 @@ flutter:
     - assets/bumble_bee_captions.srt
     - assets/bumble_bee_captions.vtt
     - assets/Audio.mp3
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  {
+    video_player_avfoundation:
+      { path: ../../../../packages/video_player/video_player_avfoundation },
+    video_player_platform_interface:
+      {
+        path: ../../../../packages/video_player/video_player_platform_interface,
+      },
+  }

packages/video_player/video_player/pubspec.yaml

@@ -37,3 +37,13 @@ dev_dependencies:
 topics:
   - video
   - video-player
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  {
+    video_player_avfoundation:
+      { path: ../../../packages/video_player/video_player_avfoundation },
+    video_player_platform_interface:
+      { path: ../../../packages/video_player/video_player_platform_interface },
+  }

packages/video_player/video_player_android/example/pubspec.yaml

@@ -31,3 +31,13 @@ flutter:
   assets:
     - assets/flutter-mark-square-64.png
     - assets/Butterfly-209.mp4
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  {
+    video_player_platform_interface:
+      {
+        path: ../../../../packages/video_player/video_player_platform_interface,
+      },
+  }

packages/video_player/video_player_android/pubspec.yaml

@@ -30,3 +30,11 @@ dev_dependencies:
 topics:
   - video
   - video-player
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  {
+    video_player_platform_interface:
+      { path: ../../../packages/video_player/video_player_platform_interface },
+  }

packages/video_player/video_player_avfoundation/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.7.0
+
+* Adds support for platform views as an optional way of displaying a video.
+
 ## 2.6.4
 
 * Refactors native code structure.

packages/video_player/video_player_avfoundation/darwin/RunnerTests/VideoPlayerTests.m

@@ -9,6 +9,7 @@
 #import <OCMock/OCMock.h>
 #import <video_player_avfoundation/AVAssetTrackUtils.h>
 #import <video_player_avfoundation/FVPVideoPlayerPlugin_Test.h>
+#import <video_player_avfoundation/FVPVideoPlayerTextureApproach_Test.h>
 
 // TODO(stuartmorgan): Convert to using mock registrars instead.
 NSObject<FlutterPluginRegistry> *GetPluginRegistry(void) {
@@ -179,17 +180,56 @@ - (void)testBlankVideoBugWithEncryptedVideoStreamAndInvertedAspectRatioBugForSom
                 uri:@"https://flutter.github.io/assets-for-api-docs/assets/videos/bee.mp4"
         packageName:nil
          formatHint:nil
-        httpHeaders:@{}];
+        httpHeaders:@{}
+           viewType:[[FVPPlatformVideoViewTypeBox alloc]
+                        initWithValue:FVPPlatformVideoViewTypeTextureView]];
   NSNumber *textureId = [videoPlayerPlugin createWithOptions:create error:&error];
   XCTAssertNil(error);
   XCTAssertNotNil(textureId);
-  FVPVideoPlayer *player = videoPlayerPlugin.playersByTextureId[textureId];
+  FVPVideoPlayerTextureApproach *player =
+      (FVPVideoPlayerTextureApproach *)videoPlayerPlugin.playersById[textureId];
   XCTAssertNotNil(player);
 
   XCTAssertNotNil(player.playerLayer, @"AVPlayerLayer should be present.");
   XCTAssertNotNil(player.playerLayer.superlayer, @"AVPlayerLayer should be added on screen.");
 }
 
+- (void)testPlayerForPlatformViewDoesNotRegisterTexture {
+  NSObject<FlutterTextureRegistry> *mockTextureRegistry =
+      OCMProtocolMock(@protocol(FlutterTextureRegistry));
+  NSObject<FlutterPluginRegistrar> *registrar =
+      [GetPluginRegistry() registrarForPlugin:@"testPlayerForPlatformViewDoesNotRegisterTexture"];
+  NSObject<FlutterPluginRegistrar> *partialRegistrar = OCMPartialMock(registrar);
+  OCMStub([partialRegistrar textures]).andReturn(mockTextureRegistry);
+  FVPDisplayLink *mockDisplayLink =
+      OCMPartialMock([[FVPDisplayLink alloc] initWithRegistrar:registrar
+                                                      callback:^(){
+                                                      }]);
+  StubFVPDisplayLinkFactory *stubDisplayLinkFactory =
+      [[StubFVPDisplayLinkFactory alloc] initWithDisplayLink:mockDisplayLink];
+  AVPlayerItemVideoOutput *mockVideoOutput = OCMPartialMock([[AVPlayerItemVideoOutput alloc] init]);
+  FVPVideoPlayerPlugin *videoPlayerPlugin = [[FVPVideoPlayerPlugin alloc]
+       initWithAVFactory:[[StubFVPAVFactory alloc] initWithPlayer:nil output:mockVideoOutput]
+      displayLinkFactory:stubDisplayLinkFactory
+               registrar:partialRegistrar];
+
+  FlutterError *initalizationError;
+  [videoPlayerPlugin initialize:&initalizationError];
+  XCTAssertNil(initalizationError);
+  FVPCreationOptions *create = [FVPCreationOptions
+      makeWithAsset:nil
+                uri:@"https://flutter.github.io/assets-for-api-docs/assets/videos/hls/bee.m3u8"
+        packageName:nil
+         formatHint:nil
+        httpHeaders:@{}
+           viewType:[[FVPPlatformVideoViewTypeBox alloc]
+                        initWithValue:FVPPlatformVideoViewTypePlatformView]];
+  FlutterError *createError;
+  [videoPlayerPlugin createWithOptions:create error:&createError];
+
+  OCMVerify(never(), [mockTextureRegistry registerTexture:[OCMArg any]]);
+}
+
 - (void)testSeekToWhilePausedStartsDisplayLinkTemporarily {
   NSObject<FlutterTextureRegistry> *mockTextureRegistry =
       OCMProtocolMock(@protocol(FlutterTextureRegistry));
@@ -217,7 +257,9 @@ - (void)testSeekToWhilePausedStartsDisplayLinkTemporarily {
                 uri:@"https://flutter.github.io/assets-for-api-docs/assets/videos/hls/bee.m3u8"
         packageName:nil
          formatHint:nil
-        httpHeaders:@{}];
+        httpHeaders:@{}
+           viewType:[[FVPPlatformVideoViewTypeBox alloc]
+                        initWithValue:FVPPlatformVideoViewTypeTextureView]];
   FlutterError *createError;
   NSNumber *textureId = [videoPlayerPlugin createWithOptions:create error:&createError];
 
@@ -236,7 +278,8 @@ - (void)testSeekToWhilePausedStartsDisplayLinkTemporarily {
   // Seeking to a new position should start the display link temporarily.
   OCMVerify([mockDisplayLink setRunning:YES]);
 
-  FVPVideoPlayer *player = videoPlayerPlugin.playersByTextureId[textureId];
+  FVPVideoPlayerTextureApproach *player =
+      (FVPVideoPlayerTextureApproach *)videoPlayerPlugin.playersById[textureId];
   XCTAssertEqual([player position], 1234);
 
   // Simulate a buffer being available.
@@ -283,7 +326,9 @@ - (void)testInitStartsDisplayLinkTemporarily {
                 uri:@"https://flutter.github.io/assets-for-api-docs/assets/videos/hls/bee.m3u8"
         packageName:nil
          formatHint:nil
-        httpHeaders:@{}];
+        httpHeaders:@{}
+           viewType:[[FVPPlatformVideoViewTypeBox alloc]
+                        initWithValue:FVPPlatformVideoViewTypeTextureView]];
   FlutterError *createError;
   NSNumber *textureId = [videoPlayerPlugin createWithOptions:create error:&createError];
 
@@ -300,7 +345,8 @@ - (void)testInitStartsDisplayLinkTemporarily {
       .ignoringNonObjectArgs()
       .andReturn(fakeBufferRef);
   // Simulate a callback from the engine to request a new frame.
-  FVPVideoPlayer *player = videoPlayerPlugin.playersByTextureId[textureId];
+  FVPVideoPlayerTextureApproach *player =
+      (FVPVideoPlayerTextureApproach *)videoPlayerPlugin.playersById[textureId];
   [player copyPixelBuffer];
   // Since a frame was found, and the video is paused, the display link should be paused again.
   OCMVerify([mockDisplayLink setRunning:NO]);
@@ -333,7 +379,9 @@ - (void)testSeekToWhilePlayingDoesNotStopDisplayLink {
                 uri:@"https://flutter.github.io/assets-for-api-docs/assets/videos/hls/bee.m3u8"
         packageName:nil
          formatHint:nil
-        httpHeaders:@{}];
+        httpHeaders:@{}
+           viewType:[[FVPPlatformVideoViewTypeBox alloc]
+                        initWithValue:FVPPlatformVideoViewTypeTextureView]];
   FlutterError *createError;
   NSNumber *textureId = [videoPlayerPlugin createWithOptions:create error:&createError];
 
@@ -350,7 +398,8 @@ - (void)testSeekToWhilePlayingDoesNotStopDisplayLink {
   [self waitForExpectationsWithTimeout:30.0 handler:nil];
   OCMVerify([mockDisplayLink setRunning:YES]);
 
-  FVPVideoPlayer *player = videoPlayerPlugin.playersByTextureId[textureId];
+  FVPVideoPlayerTextureApproach *player =
+      (FVPVideoPlayerTextureApproach *)videoPlayerPlugin.playersById[textureId];
   XCTAssertEqual([player position], 1234);
 
   // Simulate a buffer being available.
@@ -395,7 +444,9 @@ - (void)testPauseWhileWaitingForFrameDoesNotStopDisplayLink {
                 uri:@"https://flutter.github.io/assets-for-api-docs/assets/videos/hls/bee.m3u8"
         packageName:nil
          formatHint:nil
-        httpHeaders:@{}];
+        httpHeaders:@{}
+           viewType:[[FVPPlatformVideoViewTypeBox alloc]
+                        initWithValue:FVPPlatformVideoViewTypeTextureView]];
   FlutterError *createError;
   NSNumber *textureId = [videoPlayerPlugin createWithOptions:create error:&createError];
 
@@ -423,18 +474,20 @@ - (void)testDeregistersFromPlayer {
                 uri:@"https://flutter.github.io/assets-for-api-docs/assets/videos/bee.mp4"
         packageName:nil
          formatHint:nil
-        httpHeaders:@{}];
+        httpHeaders:@{}
+           viewType:[[FVPPlatformVideoViewTypeBox alloc]
+                        initWithValue:FVPPlatformVideoViewTypeTextureView]];
   NSNumber *textureId = [videoPlayerPlugin createWithOptions:create error:&error];
   XCTAssertNil(error);
   XCTAssertNotNil(textureId);
-  FVPVideoPlayer *player = videoPlayerPlugin.playersByTextureId[textureId];
+  FVPVideoPlayer *player = videoPlayerPlugin.playersById[textureId];
   XCTAssertNotNil(player);
   AVPlayer *avPlayer = player.player;
 
   [self keyValueObservingExpectationForObject:avPlayer keyPath:@"currentItem" expectedValue:nil];
 
   [videoPlayerPlugin disposePlayer:textureId.integerValue error:&error];
-  XCTAssertEqual(videoPlayerPlugin.playersByTextureId.count, 0);
+  XCTAssertEqual(videoPlayerPlugin.playersById.count, 0);
   XCTAssertNil(error);
 
   [self waitForExpectationsWithTimeout:30.0 handler:nil];
@@ -455,11 +508,13 @@ - (void)testBufferingStateFromPlayer {
                 uri:@"https://flutter.github.io/assets-for-api-docs/assets/videos/bee.mp4"
         packageName:nil
          formatHint:nil
-        httpHeaders:@{}];
+        httpHeaders:@{}
+           viewType:[[FVPPlatformVideoViewTypeBox alloc]
+                        initWithValue:FVPPlatformVideoViewTypeTextureView]];
   NSNumber *textureId = [videoPlayerPlugin createWithOptions:create error:&error];
   XCTAssertNil(error);
   XCTAssertNotNil(textureId);
-  FVPVideoPlayer *player = videoPlayerPlugin.playersByTextureId[textureId];
+  FVPVideoPlayer *player = videoPlayerPlugin.playersById[textureId];
   XCTAssertNotNil(player);
   AVPlayer *avPlayer = player.player;
   [avPlayer play];
@@ -564,7 +619,9 @@ - (void)testSeekToleranceWhenNotSeekingToEnd {
                 uri:@"https://flutter.github.io/assets-for-api-docs/assets/videos/bee.mp4"
         packageName:nil
          formatHint:nil
-        httpHeaders:@{}];
+        httpHeaders:@{}
+           viewType:[[FVPPlatformVideoViewTypeBox alloc]
+                        initWithValue:FVPPlatformVideoViewTypeTextureView]];
   FlutterError *createError;
   NSNumber *textureId = [pluginWithMockAVPlayer createWithOptions:create error:&createError];
 
@@ -602,7 +659,9 @@ - (void)testSeekToleranceWhenSeekingToEnd {
                 uri:@"https://flutter.github.io/assets-for-api-docs/assets/videos/bee.mp4"
         packageName:nil
          formatHint:nil
-        httpHeaders:@{}];
+        httpHeaders:@{}
+           viewType:[[FVPPlatformVideoViewTypeBox alloc]
+                        initWithValue:FVPPlatformVideoViewTypeTextureView]];
   FlutterError *createError;
   NSNumber *textureId = [pluginWithMockAVPlayer createWithOptions:create error:&createError];
 
@@ -625,14 +684,17 @@ - (void)testSeekToleranceWhenSeekingToEnd {
   [videoPlayerPlugin initialize:&error];
   XCTAssertNil(error);
 
-  FVPCreationOptions *create = [FVPCreationOptions makeWithAsset:nil
-                                                             uri:uri
-                                                     packageName:nil
-                                                      formatHint:nil
-                                                     httpHeaders:@{}];
+  FVPCreationOptions *create =
+      [FVPCreationOptions makeWithAsset:nil
+                                    uri:uri
+                            packageName:nil
+                             formatHint:nil
+                            httpHeaders:@{}
+                               viewType:[[FVPPlatformVideoViewTypeBox alloc]
+                                            initWithValue:FVPPlatformVideoViewTypeTextureView]];
   NSNumber *textureId = [videoPlayerPlugin createWithOptions:create error:&error];
 
-  FVPVideoPlayer *player = videoPlayerPlugin.playersByTextureId[textureId];
+  FVPVideoPlayer *player = videoPlayerPlugin.playersById[textureId];
   XCTAssertNotNil(player);
 
   XCTestExpectation *initializedExpectation = [self expectationWithDescription:@"initialized"];
@@ -694,12 +756,14 @@ - (void)testDoesNotCrashOnRateObservationAfterDisposal {
                   uri:@"https://flutter.github.io/assets-for-api-docs/assets/videos/bee.mp4"
           packageName:nil
            formatHint:nil
-          httpHeaders:@{}];
+          httpHeaders:@{}
+             viewType:[[FVPPlatformVideoViewTypeBox alloc]
+                          initWithValue:FVPPlatformVideoViewTypeTextureView]];
     NSNumber *textureId = [videoPlayerPlugin createWithOptions:create error:&error];
     XCTAssertNil(error);
     XCTAssertNotNil(textureId);
 
-    FVPVideoPlayer *player = videoPlayerPlugin.playersByTextureId[textureId];
+    FVPVideoPlayer *player = videoPlayerPlugin.playersById[textureId];
     XCTAssertNotNil(player);
     weakPlayer = player;
     avPlayer = player.player;
@@ -748,12 +812,15 @@ - (void)testHotReloadDoesNotCrash {
                   uri:@"https://flutter.github.io/assets-for-api-docs/assets/videos/bee.mp4"
           packageName:nil
            formatHint:nil
-          httpHeaders:@{}];
+          httpHeaders:@{}
+             viewType:[[FVPPlatformVideoViewTypeBox alloc]
+                          initWithValue:FVPPlatformVideoViewTypeTextureView]];
     NSNumber *textureId = [videoPlayerPlugin createWithOptions:create error:&error];
     XCTAssertNil(error);
     XCTAssertNotNil(textureId);
 
-    FVPVideoPlayer *player = videoPlayerPlugin.playersByTextureId[textureId];
+    FVPVideoPlayerTextureApproach *player =
+        (FVPVideoPlayerTextureApproach *)videoPlayerPlugin.playersById[textureId];
     XCTAssertNotNil(player);
     weakPlayer = player;
 
@@ -777,12 +844,34 @@ - (void)testHotReloadDoesNotCrash {
                                handler:nil];  // No assertions needed. Lack of crash is a success.
 }
 
+#if TARGET_OS_IOS
+- (void)testNativeVideoViewFactoryRegistration {
+  NSObject<FlutterPluginRegistry> *registry = GetPluginRegistry();
+  NSObject<FlutterPluginRegistrar> *registrar =
+      [registry registrarForPlugin:@"testNativeVideoViewFactoryRegistration"];
+  id mockRegistrar = OCMPartialMock(registrar);
+
+  OCMExpect([mockRegistrar
+      registerViewFactory:[OCMArg isKindOfClass:[FVPNativeVideoViewFactory class]]
+                   withId:@"plugins.flutter.dev/video_player_ios"]);
+  [FVPVideoPlayerPlugin registerWithRegistrar:mockRegistrar];
+
+  OCMVerifyAll(mockRegistrar);
+}
+#endif
+
 - (void)testPublishesInRegistration {
   NSString *pluginKey = @"TestRegistration";
   NSObject<FlutterPluginRegistry> *registry = GetPluginRegistry();
   NSObject<FlutterPluginRegistrar> *registrar = [registry registrarForPlugin:pluginKey];
+  id mockRegistrar = OCMPartialMock(registrar);
+  // Empty stub to pass a check in Flutter's engine (double factory registration).
+  // registerWithRegistrar gets called at the beginning of the test, and factory is registered
+  // there. Additional call would try to register the same factory another time, which would fail a
+  // check in the engine.
+  OCMStub([mockRegistrar registerViewFactory:[OCMArg any] withId:[OCMArg any]]);
 
-  [FVPVideoPlayerPlugin registerWithRegistrar:registrar];
+  [FVPVideoPlayerPlugin registerWithRegistrar:mockRegistrar];
 
   id publishedValue = [registry valuePublishedByPlugin:pluginKey];
 
@@ -799,13 +888,16 @@ - (void)testFailedToLoadVideoEventShouldBeAlwaysSent {
 
   [videoPlayerPlugin initialize:&error];
 
-  FVPCreationOptions *create = [FVPCreationOptions makeWithAsset:nil
-                                                             uri:@""
-                                                     packageName:nil
-                                                      formatHint:nil
-                                                     httpHeaders:@{}];
+  FVPCreationOptions *create =
+      [FVPCreationOptions makeWithAsset:nil
+                                    uri:@""
+                            packageName:nil
+                             formatHint:nil
+                            httpHeaders:@{}
+                               viewType:[[FVPPlatformVideoViewTypeBox alloc]
+                                            initWithValue:FVPPlatformVideoViewTypeTextureView]];
   NSNumber *textureId = [videoPlayerPlugin createWithOptions:create error:&error];
-  FVPVideoPlayer *player = videoPlayerPlugin.playersByTextureId[textureId];
+  FVPVideoPlayer *player = videoPlayerPlugin.playersById[textureId];
   XCTAssertNotNil(player);
 
   [self keyValueObservingExpectationForObject:(id)player.player.currentItem

packages/video_player/video_player_avfoundation/darwin/video_player_avfoundation.podspec

@@ -18,6 +18,7 @@ Downloaded by pub (not CocoaPods).
   s.ios.source_files = 'video_player_avfoundation/Sources/video_player_avfoundation_ios/*'
   s.osx.source_files = 'video_player_avfoundation/Sources/video_player_avfoundation_macos/*'
   s.public_header_files = 'video_player_avfoundation/Sources/video_player_avfoundation/include/**/*.h'
+  s.ios.public_header_files = 'video_player_avfoundation/Sources/video_player_avfoundation_ios/include/**/*.h'
   s.ios.dependency 'Flutter'
   s.osx.dependency 'FlutterMacOS'
   s.ios.deployment_target = '12.0'