Changeset 289100 in webkit

Timestamp:

Feb 3, 2022, 6:45:45 PM (4 years ago)

Author:

Wenson Hsieh

Message:

Teach VideoFullscreenInterface to keep track of its corresponding MediaPlayer's MediaPlayerIdentifier
​https://bugs.webkit.org/show_bug.cgi?id=236090

Reviewed by Eric Carlson.

Source/WebCore:

Add plumbing for an optional MediaPlayerIdentifier through the video fullscreen model. This identifier is
invalidated upon loadstart, and updated once we observe loadedmetadata, which ensures that if the media
engine (and media player) changes out from underneath the video fullscreen model, we still keep the new player
ID up to date.

See WebKit/ChangeLog for more details.

• platform/cocoa/VideoFullscreenModel.h:

(WebCore::VideoFullscreenModelClient::setPlayerIdentifier):

• platform/cocoa/VideoFullscreenModelVideoElement.h:
• platform/cocoa/VideoFullscreenModelVideoElement.mm:

(WebCore::VideoFullscreenModelVideoElement::updateForEventName):
(WebCore::VideoFullscreenModelVideoElement::observedEventNames):

Additionally listen for loadstartEvent and loadedmetadataEvent (see above).

(WebCore::VideoFullscreenModelVideoElement::setPlayerIdentifier):

• platform/ios/VideoFullscreenInterfaceAVKit.h:
• platform/mac/VideoFullscreenInterfaceMac.h:

(WebCore::VideoFullscreenInterfaceMac::playerIdentifier const):

Source/WebKit:

Add an IPC message between VideoFullscreenManager and VideoFullscreenManagerProxy to update the media player ID
corresponding to a given PlaybackSessionContextIdentifier. This is sent if the underlying media player changes
(and subsequently fires loadstart and loadedmetadata events), and also sent upon entering fullscreen video.

In a future patch, this mechanism will be used to teach VideoFullscreenManagerProxy to grab an image bitmap from
the GPU process for a given PlaybackSessionContextIdentifier.

• UIProcess/Cocoa/VideoFullscreenManagerProxy.h:
• UIProcess/Cocoa/VideoFullscreenManagerProxy.messages.in:
• UIProcess/Cocoa/VideoFullscreenManagerProxy.mm:

(WebKit::VideoFullscreenManagerProxy::setPlayerIdentifier):

• WebProcess/cocoa/VideoFullscreenManager.h:
• WebProcess/cocoa/VideoFullscreenManager.mm:

(WebKit::VideoFullscreenInterfaceContext::setPlayerIdentifier):
(WebKit::VideoFullscreenManager::enterVideoFullscreenForVideoElement):
(WebKit::VideoFullscreenManager::setPlayerIdentifier):

Location:

trunk/Source

Files:

• WebCore/ChangeLog (modified) (1 diff)
• WebCore/platform/cocoa/VideoFullscreenModel.h (modified) (2 diffs)
• WebCore/platform/cocoa/VideoFullscreenModelVideoElement.h (modified) (3 diffs)
• WebCore/platform/cocoa/VideoFullscreenModelVideoElement.mm (modified) (3 diffs)
• WebCore/platform/ios/VideoFullscreenInterfaceAVKit.h (modified) (4 diffs)
• WebCore/platform/mac/VideoFullscreenInterfaceMac.h (modified) (3 diffs)
• WebKit/ChangeLog (modified) (1 diff)
• WebKit/UIProcess/Cocoa/VideoFullscreenManagerProxy.h (modified) (2 diffs)
• WebKit/UIProcess/Cocoa/VideoFullscreenManagerProxy.messages.in (modified) (1 diff)
• WebKit/UIProcess/Cocoa/VideoFullscreenManagerProxy.mm (modified) (1 diff)
• WebKit/WebProcess/cocoa/VideoFullscreenManager.h (modified) (2 diffs)
• WebKit/WebProcess/cocoa/VideoFullscreenManager.mm (modified) (3 diffs)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2022-02-03  Wenson Hsieh  <wenson_hsieh@apple.com>
+
+        Teach VideoFullscreenInterface to keep track of its corresponding MediaPlayer's MediaPlayerIdentifier
+        https://bugs.webkit.org/show_bug.cgi?id=236090
+
+        Reviewed by Eric Carlson.
+
+        Add plumbing for an optional MediaPlayerIdentifier through the video fullscreen model. This identifier is
+        invalidated upon `loadstart`, and updated once we observe `loadedmetadata`, which ensures that if the media
+        engine (and media player) changes out from underneath the video fullscreen model, we still keep the new player
+        ID up to date.
+
+        See WebKit/ChangeLog for more details.
+
+        * platform/cocoa/VideoFullscreenModel.h:
+        (WebCore::VideoFullscreenModelClient::setPlayerIdentifier):
+        * platform/cocoa/VideoFullscreenModelVideoElement.h:
+        * platform/cocoa/VideoFullscreenModelVideoElement.mm:
+        (WebCore::VideoFullscreenModelVideoElement::updateForEventName):
+        (WebCore::VideoFullscreenModelVideoElement::observedEventNames):
+
+        Additionally listen for `loadstartEvent` and `loadedmetadataEvent` (see above).
+
+        (WebCore::VideoFullscreenModelVideoElement::setPlayerIdentifier):
+        * platform/ios/VideoFullscreenInterfaceAVKit.h:
+        * platform/mac/VideoFullscreenInterfaceMac.h:
+        (WebCore::VideoFullscreenInterfaceMac::playerIdentifier const):
+
 2022-02-03  Commit Queue  <commit-queue@webkit.org>
 

trunk/Source/WebCore/platform/cocoa/VideoFullscreenModel.h

@@ -33 +33 @@
 #include "HTMLMediaElementEnums.h"
 #include "MediaPlayerEnums.h"
+#include "MediaPlayerIdentifier.h"
 #include "PlaybackSessionModel.h"
 #include <wtf/CompletionHandler.h>
@@ -85 +86 @@
     virtual void didExitPictureInPicture() { }
     virtual void modelDestroyed() { }
+    virtual void setPlayerIdentifier(std::optional<MediaPlayerIdentifier>) { }
 };
     

trunk/Source/WebCore/platform/cocoa/VideoFullscreenModelVideoElement.h

@@ -33 +33 @@
 #include "HTMLMediaElementEnums.h"
 #include "MediaPlayerEnums.h"
+#include "MediaPlayerIdentifier.h"
 #include "PlatformLayer.h"
 #include "VideoFullscreenModel.h"
@@ -82 +83 @@
     void setHasVideo(bool);
     void setVideoDimensions(const FloatSize&);
+    void setPlayerIdentifier(std::optional<MediaPlayerIdentifier>);
 
     void willEnterPictureInPicture() override;
@@ -101 +103 @@
     Vector<RefPtr<TextTrack>> m_legibleTracksForMenu;
     Vector<RefPtr<AudioTrack>> m_audioTracksForMenu;
+    std::optional<MediaPlayerIdentifier> m_playerIdentifier;
 };
 

trunk/Source/WebCore/platform/cocoa/VideoFullscreenModelVideoElement.mm

@@ -104 +104 @@
         setVideoDimensions(m_videoElement ? FloatSize(m_videoElement->videoWidth(), m_videoElement->videoHeight()) : FloatSize());
     }
+
+    if (all
+        || eventName == eventNames().loadedmetadataEvent || eventName == eventNames().loadstartEvent) {
+        setPlayerIdentifier([&]() -> std::optional<MediaPlayerIdentifier> {
+            if (eventName == eventNames().loadstartEvent)
+                return std::nullopt;
+
+            if (!m_videoElement)
+                return std::nullopt;
+
+            auto player = m_videoElement->player();
+            if (!player)
+                return std::nullopt;
+
+            if (auto identifier = player->identifier())
+                return identifier;
+
+            return std::nullopt;
+        }());
+    }
 }
 
@@ -181 +201 @@
 Span<const AtomString> VideoFullscreenModelVideoElement::observedEventNames()
 {
-    static NeverDestroyed names = std::array { eventNames().resizeEvent };
+    static NeverDestroyed names = std::array { eventNames().resizeEvent, eventNames().loadstartEvent, eventNames().loadedmetadataEvent };
     return names.get();
 }
@@ -239 +259 @@
 }
 
+void VideoFullscreenModelVideoElement::setPlayerIdentifier(std::optional<MediaPlayerIdentifier> identifier)
+{
+    if (m_playerIdentifier == identifier)
+        return;
+
+    m_playerIdentifier = identifier;
+
+    for (auto* client : copyToVector(m_clients))
+        client->setPlayerIdentifier(identifier);
+}
+
 void VideoFullscreenModelVideoElement::willEnterPictureInPicture()
 {

trunk/Source/WebCore/platform/ios/VideoFullscreenInterfaceAVKit.h

@@ -31 +31 @@
 #include "EventListener.h"
 #include "HTMLMediaElementEnums.h"
+#include "MediaPlayerIdentifier.h"
 #include "PlatformLayer.h"
 #include "PlaybackSessionInterfaceAVKit.h"
@@ -77 +78 @@
     WEBCORE_EXPORT void videoDimensionsChanged(const FloatSize&) final;
     WEBCORE_EXPORT void modelDestroyed() final;
+    void setPlayerIdentifier(std::optional<MediaPlayerIdentifier> identifier) final { m_playerIdentifier = identifier; }
 
     // PlaybackSessionModelClient
@@ -160 +162 @@
     WEBCORE_EXPORT bool pictureInPictureWasStartedWhenEnteringBackground() const;
 
+    std::optional<MediaPlayerIdentifier> playerIdentifier() const { return m_playerIdentifier; }
+
 protected:
     WEBCORE_EXPORT VideoFullscreenInterfaceAVKit(PlaybackSessionInterfaceAVKit&);
@@ -172 +176 @@
 
     Ref<PlaybackSessionInterfaceAVKit> m_playbackSessionInterface;
+    std::optional<MediaPlayerIdentifier> m_playerIdentifier;
     RetainPtr<WebAVPlayerViewControllerDelegate> m_playerViewControllerDelegate;
     RetainPtr<WebAVPlayerViewController> m_playerViewController;

trunk/Source/WebCore/platform/mac/VideoFullscreenInterfaceMac.h

@@ -29 +29 @@
 
 #include "HTMLMediaElementEnums.h"
+#include "MediaPlayerIdentifier.h"
 #include "PlaybackSessionInterfaceMac.h"
 #include "PlaybackSessionModel.h"
@@ -71 +72 @@
     WEBCORE_EXPORT void hasVideoChanged(bool) final;
     WEBCORE_EXPORT void videoDimensionsChanged(const FloatSize&) final;
+    void setPlayerIdentifier(std::optional<MediaPlayerIdentifier> identifier) final { m_playerIdentifier = identifier; }
 
     WEBCORE_EXPORT void setupFullscreen(NSView& layerHostedView, const IntRect& initialRect, NSWindow *parentWindow, HTMLMediaElementEnums::VideoFullscreenMode, bool allowsPictureInPicturePlayback);
@@ -97 +99 @@
     WEBCORE_EXPORT void requestHideAndExitPiP();
 
+    std::optional<MediaPlayerIdentifier> playerIdentifier() const { return m_playerIdentifier; }
+
 private:
     WEBCORE_EXPORT VideoFullscreenInterfaceMac(PlaybackSessionInterfaceMac&);
     Ref<PlaybackSessionInterfaceMac> m_playbackSessionInterface;
+    std::optional<MediaPlayerIdentifier> m_playerIdentifier;
     WeakPtr<VideoFullscreenModel> m_videoFullscreenModel;
     WeakPtr<VideoFullscreenChangeObserver> m_fullscreenChangeObserver;

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2022-02-03  Wenson Hsieh  <wenson_hsieh@apple.com>
+
+        Teach VideoFullscreenInterface to keep track of its corresponding MediaPlayer's MediaPlayerIdentifier
+        https://bugs.webkit.org/show_bug.cgi?id=236090
+
+        Reviewed by Eric Carlson.
+
+        Add an IPC message between VideoFullscreenManager and VideoFullscreenManagerProxy to update the media player ID
+        corresponding to a given PlaybackSessionContextIdentifier. This is sent if the underlying media player changes
+        (and subsequently fires `loadstart` and `loadedmetadata` events), and also sent upon entering fullscreen video.
+
+        In a future patch, this mechanism will be used to teach VideoFullscreenManagerProxy to grab an image bitmap from
+        the GPU process for a given PlaybackSessionContextIdentifier.
+
+        * UIProcess/Cocoa/VideoFullscreenManagerProxy.h:
+        * UIProcess/Cocoa/VideoFullscreenManagerProxy.messages.in:
+        * UIProcess/Cocoa/VideoFullscreenManagerProxy.mm:
+        (WebKit::VideoFullscreenManagerProxy::setPlayerIdentifier):
+        * WebProcess/cocoa/VideoFullscreenManager.h:
+        * WebProcess/cocoa/VideoFullscreenManager.mm:
+        (WebKit::VideoFullscreenInterfaceContext::setPlayerIdentifier):
+        (WebKit::VideoFullscreenManager::enterVideoFullscreenForVideoElement):
+        (WebKit::VideoFullscreenManager::setPlayerIdentifier):
+
 2022-02-03  Michael Saboff  <msaboff@apple.com>
 

trunk/Source/WebKit/UIProcess/Cocoa/VideoFullscreenManagerProxy.h

@@ -33 +33 @@
 #include <WebCore/AudioSession.h>
 #include <WebCore/GraphicsLayer.h>
+#include <WebCore/MediaPlayerIdentifier.h>
 #include <WebCore/PlatformView.h>
 #include <WebCore/VideoFullscreenChangeObserver.h>
@@ -181 +182 @@
     void preparedToExitFullscreen(PlaybackSessionContextIdentifier);
     void exitFullscreenWithoutAnimationToMode(PlaybackSessionContextIdentifier, WebCore::HTMLMediaElementEnums::VideoFullscreenMode);
+    void setPlayerIdentifier(PlaybackSessionContextIdentifier, std::optional<WebCore::MediaPlayerIdentifier>);
 
     // Messages to VideoFullscreenManager

trunk/Source/WebKit/UIProcess/Cocoa/VideoFullscreenManagerProxy.messages.in

@@ -26 +26 @@
     SetVideoDimensions(WebKit::PlaybackSessionContextIdentifier contextId, WebCore::FloatSize videoDimensions)
     SetupFullscreenWithID(WebKit::PlaybackSessionContextIdentifier contextId, WebKit::LayerHostingContextID videoLayerID, WebCore::FloatRect initialRect, WebCore::FloatSize videoDimensions, float hostingScaleFactor, WebCore::HTMLMediaElementEnums::VideoFullscreenMode videoFullscreenMode, bool allowsPictureInPicture, bool standby, bool blocksReturnToFullscreenFromPictureInPicture)
+    SetPlayerIdentifier(WebKit::PlaybackSessionContextIdentifier contextId, std::optional<WebCore::MediaPlayerIdentifier> playerIdentifier)
 #if !PLATFORM(IOS_FAMILY)
     EnterFullscreen(WebKit::PlaybackSessionContextIdentifier contextId)

trunk/Source/WebKit/UIProcess/Cocoa/VideoFullscreenManagerProxy.mm

@@ -572 +572 @@
 }
 
+void VideoFullscreenManagerProxy::setPlayerIdentifier(PlaybackSessionContextIdentifier contextId, std::optional<MediaPlayerIdentifier> playerIdentifier)
+{
+    if (m_mockVideoPresentationModeEnabled)
+        return;
+
+    if (auto* interface = findInterface(contextId))
+        interface->setPlayerIdentifier(playerIdentifier);
+}
+
 void VideoFullscreenManagerProxy::setHasVideo(PlaybackSessionContextIdentifier contextId, bool hasVideo)
 {

trunk/Source/WebKit/WebProcess/cocoa/VideoFullscreenManager.h

@@ -99 +99 @@
     void hasVideoChanged(bool) override;
     void videoDimensionsChanged(const WebCore::FloatSize&) override;
+    void setPlayerIdentifier(std::optional<WebCore::MediaPlayerIdentifier>) final;
 
     VideoFullscreenInterfaceContext(VideoFullscreenManager&, PlaybackSessionContextIdentifier);
@@ -147 +148 @@
     void hasVideoChanged(PlaybackSessionContextIdentifier, bool hasVideo);
     void videoDimensionsChanged(PlaybackSessionContextIdentifier, const WebCore::FloatSize&);
+    void setPlayerIdentifier(PlaybackSessionContextIdentifier, std::optional<WebCore::MediaPlayerIdentifier>);
 
     // Messages from VideoFullscreenManagerProxy

trunk/Source/WebKit/WebProcess/cocoa/VideoFullscreenManager.mm

@@ -111 +111 @@
 }
 
+void VideoFullscreenInterfaceContext::setPlayerIdentifier(std::optional<MediaPlayerIdentifier> identifier)
+{
+    if (m_manager)
+        m_manager->setPlayerIdentifier(m_contextId, identifier);
+}
+
 #pragma mark - VideoFullscreenManager
 
@@ -310 +316 @@
 
     m_page->send(Messages::VideoFullscreenManagerProxy::SetupFullscreenWithID(contextId, interface->layerHostingContext()->contextID(), videoRect, FloatSize(videoElement.videoWidth(), videoElement.videoHeight()), m_page->deviceScaleFactor(), interface->fullscreenMode(), allowsPictureInPicture, standby, videoElement.document().quirks().blocksReturnToFullscreenFromPictureInPictureQuirk()));
+
+    if (auto player = videoElement.player()) {
+        if (auto identifier = player->identifier())
+            setPlayerIdentifier(contextId, identifier);
+    }
 }
 
@@ -376 +387 @@
     if (m_page)
         m_page->send(Messages::VideoFullscreenManagerProxy::SetVideoDimensions(contextId, videoDimensions));
+}
+
+void VideoFullscreenManager::setPlayerIdentifier(PlaybackSessionContextIdentifier contextIdentifier, std::optional<MediaPlayerIdentifier> playerIdentifier)
+{
+    if (m_page)
+        m_page->send(Messages::VideoFullscreenManagerProxy::SetPlayerIdentifier(contextIdentifier, playerIdentifier));
 }