[tvOS] Add experimental runtime support for AVKit fullscreen

https://bugs.webkit.org/show_bug.cgi?id=262814
rdar://116599008

Reviewed by Jer Noble.

Added experimental support for AVKit fullscreen on tvOS. Full support cannot be implemented until
new APIs are available (see rdar://116592344), but this provides a proof-of-concept implementation
by implementing the AVPlayerController interface expected by tvOS's AVPlayerViewController and
injecting a custom AVPlayerLayerView into AVPlayerViewController's view hierarchy.

This change also opts tvOS into iOS media controls layout traits and works around an issue related
to WKWebView visibility when AVPlayerViewController is modally presented on top of it.

* Source/WebCore/Modules/mediacontrols/MediaControlsHost.cpp:
(WebCore::MediaControlsHost::layoutTraitsClassName const):
* Source/WebCore/PAL/pal/cocoa/AVFoundationSoftLink.h:
* Source/WebCore/PAL/pal/cocoa/AVFoundationSoftLink.mm:
* Source/WebCore/PAL/pal/spi/cocoa/AVKitSPI.h:
* Source/WebCore/PAL/pal/spi/cocoa/FoundationSPI.h:
* Source/WebCore/platform/cocoa/WebAVPlayerLayer.h:
* Source/WebCore/platform/cocoa/WebAVPlayerLayer.mm:
(-[WebAVPlayerLayer legibleContentInsets]):
(-[WebAVPlayerLayer setLegibleContentInsets:]):
* Source/WebCore/platform/ios/VideoFullscreenInterfaceAVKit.mm:
(-[WebAVPlayerViewController initWithFullscreenInterface:]):
(-[WebAVPlayerViewController configurePlayerViewControllerWithFullscreenInterface:]):
* Source/WebCore/platform/ios/WebAVPlayerController.h:
* Source/WebCore/platform/ios/WebAVPlayerController.mm:
(-[WebAVPlayerController init]):
(-[WebAVPlayerController player]):
(-[WebAVPlayerController currentItem]):
(+[WebAVPlayerController keyPathsForValuesAffectingEffectiveRateNonZero]):
(-[WebAVPlayerController effectiveRateNonZero]):
(-[WebAVPlayerController forwardPlaybackEndTime]):
(-[WebAVPlayerController backwardPlaybackEndTime]):
(+[WebAVPlayerController keyPathsForValuesAffectingIsSeekingTV]):
(-[WebAVPlayerController isSeekingTV]):
(-[WebAVPlayerController hasStartAndEndDates]):
(-[WebAVPlayerController timeRangeSeekable]):
(-[WebAVPlayerController hasItem]):
(-[WebAVPlayerController isPlaybackLikelyToKeepUp]):
(-[WebAVPlayerController overrideForForwardPlaybackEndTime]):
(-[WebAVPlayerController overrideForReversePlaybackEndTime]):
(-[WebAVPlayerController timebaseRate]):
(-[WebAVPlayerController externalMetadata]):
(+[WebAVPlayerController keyPathsForValuesAffectingTimeControlStatus]):
(-[WebAVPlayerController timeControlStatus]):
(+[WebAVPlayerController keyPathsForValuesAffectingDisplayedDuration]):
(-[WebAVPlayerController displayedDuration]):
(-[WebAVPlayerController contentDurationCached]):
(-[WebAVPlayerController currentDisplayTime]):
(-[WebAVPlayerController currentOrEstimatedDate]):
(+[WebAVPlayerController keyPathsForValuesAffectingCurrentTime]):
(-[WebAVPlayerController currentTime]):
(-[WebAVPlayerController displayTimeRangeForNavigation]):
(-[WebAVPlayerController isAtMaxTime]):
(-[WebAVPlayerController isContentDurationIndefinite]):
(-[WebAVPlayerController timeRangeForNavigation]):
(-[WebAVPlayerController timeFromDisplayTime:]):
(-[WebAVPlayerController displayTimeFromTime:]):
(-[WebAVPlayerController activeRate]):
(-[WebAVPlayerController setActiveRate:]):
(-[WebAVPlayerController requestNavigateToTime:fromTime:reason:playWhenReady:permissionHandler:seekCompleti
(-[WebAVPlayerController seekToTime:seekReason:completionHandler:]):
(-[WebAVPlayerController requestSeekToTime:seekReason:permissionHandler:completionHandler:]):
(-[WebAVPlayerController requestPauseWithCompletion:]):
(-[WebAVPlayerController requestPlayWithCompletion:]):
(-[WebAVPlayerController requestSeekToTime:reason:playWhenReady:]):
* Source/WebKit/UIProcess/WebPageProxy.cpp:
(WebKit::WebPageProxy::viewDidLeaveWindow):

Canonical link: https://commits.webkit.org/269032@main

Source/WebCore/Modules/mediacontrols/MediaControlsHost.cpp

@@ -116,7 +116,7 @@ String MediaControlsHost::layoutTraitsClassName() const
 {
 #if PLATFORM(MAC) || PLATFORM(MACCATALYST)
     return "MacOSLayoutTraits"_s;
-#elif PLATFORM(IOS)
+#elif PLATFORM(IOS) || PLATFORM(APPLETV)
     return "IOSLayoutTraits"_s;
 #elif PLATFORM(VISION)
     return "VisionLayoutTraits"_s;

Source/WebCore/PAL/pal/cocoa/AVFoundationSoftLink.h

@@ -36,6 +36,7 @@ SOFT_LINK_FRAMEWORK_FOR_HEADER(PAL, AVFoundation)
 //    #define AVAssetCache PAL::getAVAssetCacheClass()
 // because they make it difficult to use the class name in source code.
 
+SOFT_LINK_CLASS_FOR_HEADER(PAL, AVAsset)
 SOFT_LINK_CLASS_FOR_HEADER(PAL, AVAssetCache)
 SOFT_LINK_CLASS_FOR_HEADER(PAL, AVAssetCollection)
 SOFT_LINK_CLASS_FOR_HEADER(PAL, AVAssetExportSession)

Source/WebCore/PAL/pal/cocoa/AVFoundationSoftLink.mm

@@ -62,6 +62,7 @@ static BOOL justReturnsNO()
 }
 #endif
 
+SOFT_LINK_CLASS_FOR_SOURCE_WITH_EXPORT(PAL, AVFoundation, AVAsset, PAL_EXPORT)
 SOFT_LINK_CLASS_FOR_SOURCE_WITH_EXPORT(PAL, AVFoundation, AVAssetCache, PAL_EXPORT)
 SOFT_LINK_CLASS_FOR_SOURCE_WITH_EXPORT(PAL, AVFoundation, AVAssetExportSession, PAL_EXPORT)
 SOFT_LINK_CLASS_FOR_SOURCE_WITH_EXPORT(PAL, AVFoundation, AVAssetImageGenerator, PAL_EXPORT)

Source/WebCore/PAL/pal/spi/cocoa/AVKitSPI.h

@@ -439,17 +439,17 @@ NS_ASSUME_NONNULL_BEGIN
 
 #if USE(APPLE_INTERNAL_SDK)
 
-typedef NS_ENUM(NSInteger, AVPlayerControllerStatus) {
-    AVPlayerControllerStatusUnknown = 0,
-    AVPlayerControllerStatusReadyToPlay = 2,
-};
-
 typedef NS_ENUM(NSInteger, AVPlayerControllerExternalPlaybackType) {
     AVPlayerControllerExternalPlaybackTypeNone = 0,
     AVPlayerControllerExternalPlaybackTypeAirPlay = 1,
     AVPlayerControllerExternalPlaybackTypeTVOut = 2,
 };
 
+typedef NS_ENUM(NSInteger, AVPlayerControllerStatus) {
+    AVPlayerControllerStatusUnknown = 0,
+    AVPlayerControllerStatusReadyToPlay = 2,
+};
+
 @interface AVPlayerController : NSObject
 @end
 
@@ -458,6 +458,15 @@ typedef NS_ENUM(NSInteger, AVPlayerControllerExternalPlaybackType) {
 
 #endif // USE(APPLE_INTERNAL_SDK)
 
+typedef NS_ENUM(NSInteger, AVPlayerControllerTimeControlStatus) {
+    AVPlayerControllerTimeControlStatusPaused,
+    AVPlayerControllerTimeControlStatusWaitingToPlayAtSpecifiedRate,
+    AVPlayerControllerTimeControlStatusPlaying
+};
+
+@interface AVTimeRange : NSObject
+@end
+
 @interface __AVPlayerLayerView (IPI)
 @property (nonatomic, strong, nullable) AVPlayerController *playerController;
 @property (nonatomic, readonly) AVPlayerLayer *playerLayer;
@@ -468,6 +477,11 @@ typedef NS_ENUM(NSInteger, AVPlayerControllerExternalPlaybackType) {
 @property (nonatomic, strong) __AVPlayerLayerView *playerLayerView;
 @end
 
+@interface AVTimeRange (IPI)
+- (instancetype)initWithCMTimeRange:(CMTimeRange)timeRange;
+- (instancetype)initWithStartTime:(NSTimeInterval)startTime endTime:(NSTimeInterval)duration;
+@end
+
 NS_ASSUME_NONNULL_END
 
 #endif // PLATFORM(APPLETV)

Source/WebCore/PAL/pal/spi/cocoa/FoundationSPI.h

@@ -26,6 +26,18 @@
 
 #import <Foundation/Foundation.h>
 
+#if USE(APPLE_INTERNAL_SDK)
+#import <Foundation/NSGeometry.h>
+#elif !PLATFORM(MAC) && !PLATFORM(MACCATALYST)
+#define NSEDGEINSETS_DEFINED 1
+typedef struct NS_SWIFT_SENDABLE NSEdgeInsets {
+    CGFloat top;
+    CGFloat left;
+    CGFloat bottom;
+    CGFloat right;
+} NSEdgeInsets;
+#endif
+
 @interface NSTextCheckingResult ()
 - (NSDictionary *)detail;
 @end

Source/WebCore/platform/cocoa/WebAVPlayerLayer.h

@@ -30,6 +30,7 @@
 #include "FloatRect.h"
 #include <CoreGraphics/CGGeometry.h>
 #include <QuartzCore/CALayer.h>
+#include <pal/spi/cocoa/FoundationSPI.h>
 
 OBJC_CLASS AVPlayerController;
 OBJC_CLASS NSDictionary;
@@ -47,6 +48,7 @@ WEBCORE_EXPORT @interface WebAVPlayerLayer : CALayer
 @property (nonatomic, retain, nonnull) CALayer *videoSublayer;
 @property (nonatomic, copy, nullable) NSDictionary *pixelBufferAttributes;
 @property CGSize videoDimensions;
+@property (nonatomic) NSEdgeInsets legibleContentInsets;
 - (WebCore::FloatRect)calculateTargetVideoFrame;
 @end
 

Source/WebCore/platform/cocoa/WebAVPlayerLayer.mm

@@ -83,6 +83,7 @@ @implementation WebAVPlayerLayer {
     RetainPtr<NSString> _videoGravity;
     RetainPtr<NSString> _previousVideoGravity;
     std::unique_ptr<WebAVPlayerLayerPresentationModelClient> _presentationModelClient;
+    NSEdgeInsets _legibleContentInsets;
 #if !RELEASE_LOG_DISABLED
     const void* _logIdentifier;
 #endif
@@ -359,6 +360,16 @@ + (NSSet *)keyPathsForValuesAffectingVideoRect
     return [NSSet setWithObjects:@"videoDimensions", @"videoGravity", nil];
 }
 
+- (NSEdgeInsets)legibleContentInsets
+{
+    return _legibleContentInsets;
+}
+
+- (void)setLegibleContentInsets:(NSEdgeInsets)legibleContentInsets
+{
+    _legibleContentInsets = legibleContentInsets;
+}
+
 @end
 
 #if !RELEASE_LOG_DISABLED

Source/WebCore/platform/ios/VideoFullscreenInterfaceAVKit.mm

@@ -41,6 +41,7 @@
 #import <UIKit/UIWindow.h>
 #import <objc/message.h>
 #import <objc/runtime.h>
+#import <pal/spi/cocoa/AVKitSPI.h>
 #import <pal/spi/ios/UIKitSPI.h>
 #import <wtf/RefPtr.h>
 #import <wtf/RetainPtr.h>
@@ -264,7 +265,7 @@ - (void)pictureInPictureController:(AVPictureInPictureController *)pictureInPict
         fullscreenInterface->prepareForPictureInPictureStopWithCompletionHandler(completionHandler);
 }
 
-#endif
+#endif // HAVE(PIP_CONTROLLER)
 
 @end
 
@@ -361,7 +362,7 @@ static void WebAVPictureInPictureContentViewController_dealloc(id aSelf, SEL)
     return (WebAVPictureInPictureContentViewController *)[theClass alloc];
 }
 
-#endif
+#endif // HAVE(PIP_CONTROLLER)
 
 NS_ASSUME_NONNULL_BEGIN
 @interface WebAVPlayerViewController : NSObject<AVPlayerViewControllerDelegate>
@@ -406,7 +407,10 @@ - (instancetype)initWithFullscreenInterface:(VideoFullscreenInterfaceAVKit *)int
 
     OBJC_ALWAYS_LOG(OBJC_LOGIDENTIFIER);
 
-#if !PLATFORM(APPLETV)
+#if PLATFORM(APPLETV)
+    _avPlayerViewController = adoptNS([allocAVPlayerViewControllerInstance() init]);
+    [self configurePlayerViewControllerWithFullscreenInterface:interface];
+#else
     _avPlayerViewController = adoptNS([allocAVPlayerViewControllerInstance() initWithPlayerLayerView:interface->playerLayerView()]);
 #endif
     [_avPlayerViewController setModalPresentationStyle:UIModalPresentationOverFullScreen];
@@ -431,6 +435,36 @@ - (instancetype)initWithFullscreenInterface:(VideoFullscreenInterfaceAVKit *)int
     return self;
 }
 
+#if PLATFORM(APPLETV)
+- (void)configurePlayerViewControllerWithFullscreenInterface:(VideoFullscreenInterfaceAVKit *)interface
+{
+    // FIXME (116592344): This is a proof-of-concept hack to work around lack support for a custom
+    // AVPlayerLayerView in tvOS's version of AVPlayerViewController. This will be replaced once
+    // proper API is available.
+
+    RELEASE_ASSERT([_avPlayerViewController view]);
+
+    [[_avPlayerViewController playerLayerView] removeFromSuperview];
+
+    WebAVPlayerLayerView *playerLayerView = interface->playerLayerView();
+    [_avPlayerViewController setPlayerLayerView:playerLayerView];
+
+    playerLayerView.pixelBufferAttributes = [_avPlayerViewController pixelBufferAttributes];
+    playerLayerView.playerController = (AVPlayerController *)interface->playerController();
+    playerLayerView.translatesAutoresizingMaskIntoConstraints = NO;
+    playerLayerView.playerLayer.videoGravity = [_avPlayerViewController videoGravity];
+
+    UIView *contentContainerView = [_avPlayerViewController view].subviews.firstObject;
+    [contentContainerView addSubview:playerLayerView];
+    [NSLayoutConstraint activateConstraints:@[
+        [playerLayerView.widthAnchor constraintEqualToAnchor:contentContainerView.widthAnchor],
+        [playerLayerView.heightAnchor constraintEqualToAnchor:contentContainerView.heightAnchor],
+        [playerLayerView.centerXAnchor constraintEqualToAnchor:contentContainerView.centerXAnchor],
+        [playerLayerView.centerYAnchor constraintEqualToAnchor:contentContainerView.centerYAnchor],
+    ]];
+}
+#endif // PLATFORM(APPLETV)
+
 - (void)dealloc
 {
     OBJC_ALWAYS_LOG(OBJC_LOGIDENTIFIER);

Source/WebCore/platform/ios/WebAVPlayerController.h

@@ -27,11 +27,15 @@
 
 #import <pal/spi/cocoa/AVKitSPI.h>
 
+NS_ASSUME_NONNULL_BEGIN
+
 namespace WebCore {
 class PlaybackSessionModel;
 class PlaybackSessionInterfaceAVKit;
 }
 
+@class AVTimeRange;
+
 @interface WebAVMediaSelectionOption : NSObject
 - (instancetype)initWithMediaType:(AVMediaType)type displayName:(NSString *)displayName;
 
@@ -46,8 +50,8 @@ class PlaybackSessionInterfaceAVKit;
 - (void)setAllowsPictureInPicture:(BOOL)allowsPictureInPicture;
 
 @property (retain) AVPlayerController *playerControllerProxy;
-@property (assign /*weak*/) WebCore::PlaybackSessionModel* delegate;
-@property (assign /*weak*/) WebCore::PlaybackSessionInterfaceAVKit* playbackSessionInterface;
+@property (assign, nullable /*weak*/) WebCore::PlaybackSessionModel* delegate;
+@property (assign, nullable /*weak*/) WebCore::PlaybackSessionInterfaceAVKit* playbackSessionInterface;
 
 @property (readonly) BOOL canScanForward;
 @property BOOL canScanBackward;
@@ -109,9 +113,35 @@ class PlaybackSessionInterfaceAVKit;
 - (void)setDefaultPlaybackRate:(double)defaultPlaybackRate fromJavaScript:(BOOL)fromJavaScript;
 - (void)setRate:(double)rate fromJavaScript:(BOOL)fromJavaScript;
 
+#if PLATFORM(APPLETV)
+// FIXME (116592344): Remove these declarations once AVPlayerController API is available on tvOS.
+@property (nonatomic, readonly, getter=isEffectiveRateNonZero) BOOL effectiveRateNonZero;
+@property (nonatomic, readonly) CMTime forwardPlaybackEndTime;
+@property (nonatomic, readonly) CMTime backwardPlaybackEndTime;
+@property (nonatomic, readonly) BOOL isSeekingTV;
+@property (nonatomic, readonly) BOOL hasStartAndEndDates;
+@property (nonatomic, readonly, nullable) AVTimeRange *timeRangeSeekable;
+@property (readonly, nullable) NSValue *overrideForForwardPlaybackEndTime;
+@property (readonly, nullable) NSValue *overrideForReversePlaybackEndTime;
+@property (readonly) double timebaseRate;
+@property (readonly, nullable) NSArray *externalMetadata;
+@property (readonly) BOOL isPlaybackLikelyToKeepUp;
+@property (readonly) AVPlayerControllerTimeControlStatus timeControlStatus;
+@property (readonly) NSTimeInterval displayedDuration;
+@property (nonatomic, readonly) NSTimeInterval contentDurationCached;
+@property (nonatomic, readonly) NSTimeInterval currentDisplayTime;
+@property (nonatomic, readonly) NSDate *currentOrEstimatedDate;
+@property (nonatomic, readonly) AVTimeRange *displayTimeRangeForNavigation;
+@property (nonatomic, readonly) BOOL isContentDurationIndefinite;
+@property (nonatomic, readonly) AVTimeRange *timeRangeForNavigation;
+@property (nonatomic) float activeRate;
+#endif // PLATFORM(APPLETV)
+
 @end
 
 Class webAVPlayerControllerClass();
 RetainPtr<WebAVPlayerController> createWebAVPlayerController();
 
-#endif
+NS_ASSUME_NONNULL_END
+
+#endif // PLATFORM(COCOA) && HAVE(AVKIT)