[MSE] Introduce PlatformMediaError as a way to return failure

https://bugs.webkit.org/show_bug.cgi?id=264856
rdar://118431377

Reviewed by Jer Noble.

We also add a generic MediaPromise and MediaTimePromise and use those in place of GenericPromise in the MSE code.

* Source/WebCore/Headers.cmake:
* Source/WebCore/Modules/mediasource/MediaSource.cpp:
(WebCore::MediaSource::waitForTarget):
(WebCore::MediaSource::completeSeek):
(WebCore::MediaSource::seekToTime):
(WebCore::MediaSource::detachFromElement):
(WebCore::MediaSource::stop):
(WebCore::MediaSource::onReadyStateChange):
* Source/WebCore/Modules/mediasource/MediaSource.h:
* Source/WebCore/Modules/mediasource/SourceBuffer.cpp:
(WebCore::SourceBuffer::rangeRemoval):
(WebCore::SourceBuffer::appendBufferInternal):
(WebCore::SourceBuffer::sourceBufferPrivateAppendComplete):
(WebCore::SourceBuffer::sourceBufferPrivateDidReceiveInitializationSegment):
(WebCore::SourceBuffer::sourceBufferPrivateDurationChanged):
(WebCore::SourceBuffer::sourceBufferPrivateBufferedChanged):
* Source/WebCore/Modules/mediasource/SourceBuffer.h:
* Source/WebCore/Sources.txt:
* Source/WebCore/WebCore.xcodeproj/project.pbxproj:
* Source/WebCore/platform/MediaPromiseTypes.h: Copied from Source/WebKit/WebProcess/GPU/media/MediaSourcePrivateRemote.messages.in.
* Source/WebCore/platform/PlatformMediaError.cpp: Renamed from Source/WebCore/platform/graphics/SourceBufferPrivateClient.cpp.
(WebCore::convertEnumerationToString):
* Source/WebCore/platform/PlatformMediaError.h: Added.
(WTF::LogArgument::toString):
* Source/WebCore/platform/graphics/MediaPlayer.h:
* Source/WebCore/platform/graphics/MediaSourcePrivate.h:
* Source/WebCore/platform/graphics/MediaSourcePrivateClient.h:
* Source/WebCore/platform/graphics/SourceBufferPrivate.cpp:
(WebCore::SourceBufferPrivate::setBufferedRanges):
(WebCore::SourceBufferPrivate::updateBufferedFromTrackBuffers):
(WebCore::SourceBufferPrivate::computeSeekTime):
(WebCore::SourceBufferPrivate::removeCodedFrames):
(WebCore::SourceBufferPrivate::didReceiveInitializationSegment):
(WebCore::SourceBufferPrivate::didUpdateFormatDescriptionForTrackId):
(WebCore::SourceBufferPrivate::append):
(WebCore::SourceBufferPrivate::processPendingMediaSamples):
(WebCore::SourceBufferPrivate::resetParserState):
(WebCore::SourceBufferPrivate::memoryPressure):
* Source/WebCore/platform/graphics/SourceBufferPrivate.h:
* Source/WebCore/platform/graphics/SourceBufferPrivateClient.h:
(WTF::LogArgument::toString): Deleted.
* Source/WebCore/platform/graphics/avfoundation/objc/MediaSourcePrivateAVFObjC.h:
* Source/WebCore/platform/graphics/avfoundation/objc/MediaSourcePrivateAVFObjC.mm:
(WebCore::MediaSourcePrivateAVFObjC::waitForTarget):
(WebCore::MediaSourcePrivateAVFObjC::seekToTime):
* Source/WebCore/platform/graphics/avfoundation/objc/SourceBufferParserAVFObjC.h:
* Source/WebCore/platform/graphics/avfoundation/objc/SourceBufferParserAVFObjC.mm:
(WebCore::SourceBufferParserAVFObjC::appendData):
* Source/WebCore/platform/graphics/avfoundation/objc/SourceBufferPrivateAVFObjC.h:
* Source/WebCore/platform/graphics/avfoundation/objc/SourceBufferPrivateAVFObjC.mm:
(WebCore::SourceBufferPrivateAVFObjC::appendInternal):
* Source/WebCore/platform/graphics/cocoa/SourceBufferParser.h:
* Source/WebCore/platform/graphics/cocoa/SourceBufferParserWebM.cpp:
(WebCore::SourceBufferParserWebM::appendData):
* Source/WebCore/platform/graphics/cocoa/SourceBufferParserWebM.h:
* Source/WebCore/platform/graphics/gstreamer/mse/MediaSourcePrivateGStreamer.cpp:
(WebCore::MediaSourcePrivateGStreamer::waitForTarget):
(WebCore::MediaSourcePrivateGStreamer::seekToTime):
* Source/WebCore/platform/graphics/gstreamer/mse/MediaSourcePrivateGStreamer.h:
* Source/WebCore/platform/graphics/gstreamer/mse/SourceBufferPrivateGStreamer.cpp:
(WebCore::SourceBufferPrivateGStreamer::appendInternal):
(WebCore::SourceBufferPrivateGStreamer::appendParsingFailed):
* Source/WebCore/platform/graphics/gstreamer/mse/SourceBufferPrivateGStreamer.h:
* Source/WebCore/platform/mock/mediasource/MockMediaSourcePrivate.cpp:
(WebCore::MockMediaSourcePrivate::waitForTarget):
(WebCore::MockMediaSourcePrivate::seekToTime):
* Source/WebCore/platform/mock/mediasource/MockMediaSourcePrivate.h:
* Source/WebCore/platform/mock/mediasource/MockSourceBufferPrivate.cpp:
(WebCore::MockSourceBufferPrivate::appendInternal):
* Source/WebCore/platform/mock/mediasource/MockSourceBufferPrivate.h:
* Source/WebKit/GPUProcess/media/RemoteMediaSourceProxy.cpp:
(WebKit::RemoteMediaSourceProxy::waitForTarget):
(WebKit::RemoteMediaSourceProxy::seekToTime):
* Source/WebKit/GPUProcess/media/RemoteMediaSourceProxy.h:
* Source/WebKit/GPUProcess/media/RemoteSourceBufferProxy.cpp:
(WebKit::RemoteSourceBufferProxy::sourceBufferPrivateDidReceiveInitializationSegment):
(WebKit::RemoteSourceBufferProxy::sourceBufferPrivateDurationChanged):
(WebKit::RemoteSourceBufferProxy::sourceBufferPrivateBufferedChanged):
(WebKit::RemoteSourceBufferProxy::append):
* Source/WebKit/GPUProcess/media/RemoteSourceBufferProxy.h:
* Source/WebKit/GPUProcess/media/RemoteSourceBufferProxy.messages.in:
* Source/WebKit/Scripts/webkit/messages.py:
(headers_for_type):
* Source/WebKit/WebProcess/GPU/media/MediaSourcePrivateRemote.cpp:
(WebKit::MediaSourcePrivateRemote::waitForTarget):
(WebKit::MediaSourcePrivateRemote::proxyWaitForTarget):
(WebKit::MediaSourcePrivateRemote::seekToTime):
(WebKit::MediaSourcePrivateRemote::proxySeekToTime):
* Source/WebKit/WebProcess/GPU/media/MediaSourcePrivateRemote.h:
* Source/WebKit/WebProcess/GPU/media/MediaSourcePrivateRemote.messages.in:
* Source/WebKit/WebProcess/GPU/media/SourceBufferPrivateRemote.cpp:
(WebKit::SourceBufferPrivateRemote::append):
(WebKit::SourceBufferPrivateRemote::appendInternal):
(WebKit::SourceBufferPrivateRemote::removeCodedFrames):
(WebKit::SourceBufferPrivateRemote::computeSeekTime):
(WebKit::SourceBufferPrivateRemote::sourceBufferPrivateDidReceiveInitializationSegment):
* Source/WebKit/WebProcess/GPU/media/SourceBufferPrivateRemote.h:
* Source/WebKit/WebProcess/GPU/media/SourceBufferPrivateRemote.messages.in:

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

Author: jyavenard

Source/WebCore/Headers.cmake

@@ -1679,6 +1679,7 @@ set(WebCore_PRIVATE_FRAMEWORK_HEADERS
     platform/MediaCapabilitiesEncodingInfo.h
     platform/MediaCapabilitiesInfo.h
     platform/MediaDescription.h
+    platform/MediaPromiseTypes.h
     platform/MediaSample.h
     platform/MediaSelectionOption.h
     platform/MediaSessionGroupIdentifier.h
@@ -1702,6 +1703,7 @@ set(WebCore_PRIVATE_FRAMEWORK_HEADERS
     platform/PlatformEvent.h
     platform/PlatformExportMacros.h
     platform/PlatformKeyboardEvent.h
+    platform/PlatformMediaError.h
     platform/PlatformMouseEvent.h
     platform/PlatformPasteboard.h
     platform/PlatformScreen.h

Source/WebCore/Modules/mediasource/MediaSource.cpp

@@ -188,10 +188,10 @@ const PlatformTimeRanges& MediaSource::buffered() const
     return m_buffered;
 }
 
-Ref<MediaSource::MediaTimePromise> MediaSource::waitForTarget(const SeekTarget& target)
+Ref MediaSource::waitForTarget(const SeekTarget& target)
 {
     if (isClosed())
-        return MediaTimePromise::createAndReject(-1);
+        return MediaTimePromise::createAndReject(PlatformMediaError::SourceRemoved);
 
     ALWAYS_LOG(LOGIDENTIFIER, target.time);
 
@@ -200,7 +200,7 @@ Ref MediaSource::waitForTarget(const SeekTarget&
 
     if (m_seekTargetPromise) {
         ALWAYS_LOG(LOGIDENTIFIER, "Previous seeking to ", m_pendingSeekTarget->time, "pending, cancelling it");
-        m_seekTargetPromise->reject(-1);
+        m_seekTargetPromise->reject(PlatformMediaError::Cancelled);
     }
     m_seekTargetPromise.emplace();
     m_pendingSeekTarget = target;
@@ -251,7 +251,7 @@ void MediaSource::completeSeek()
         return sourceBuffer->computeSeekTime(seekTarget);
     }))->whenSettled(RunLoop::current(), [time = seekTarget.time, protectedThis = Ref { *this }] (auto&& results) mutable {
         if (!results)
-            return MediaTimePromise::createAndReject(-1);
+            return MediaTimePromise::createAndReject(results.error());
         auto seekTime = time;
         for (auto& result : *results) {
             if (abs(time - result) > abs(time - seekTime))
@@ -267,13 +267,13 @@ void MediaSource::completeSeek()
     m_seekTargetPromise.reset();
 }
 
-Ref<GenericPromise> MediaSource::seekToTime(const MediaTime& time)
+Ref<MediaPromise> MediaSource::seekToTime(const MediaTime& time)
 {
     if (isClosed())
-        return GenericPromise::createAndReject(-1);
+        return MediaPromise::createAndReject(PlatformMediaError::SourceRemoved);
     for (auto& sourceBuffer : *m_activeSourceBuffers)
         sourceBuffer->seekToTime(time);
-    return GenericPromise::createAndResolve();
+    return MediaPromise::createAndResolve();
 }
 
 Ref MediaSource::seekable()
@@ -1000,7 +1000,7 @@ void MediaSource::detachFromElement(HTMLMediaElement& element)
     m_mediaElement = nullptr;
 
     if (m_seekTargetPromise) {
-        m_seekTargetPromise->reject(-1);
+        m_seekTargetPromise->reject(PlatformMediaError::Cancelled);
         m_seekTargetPromise.reset();
     }
 }
@@ -1069,7 +1069,7 @@ void MediaSource::stop()
     if (m_mediaElement)
         m_mediaElement->detachMediaSource();
     if (m_seekTargetPromise)
-        m_seekTargetPromise->reject(-1);
+        m_seekTargetPromise->reject(PlatformMediaError::Cancelled);
     m_seekTargetPromise.reset();
     m_readyState = ReadyState::Closed;
     m_private = nullptr;
@@ -1113,7 +1113,7 @@ void MediaSource::onReadyStateChange(ReadyState oldState, ReadyState newState)
     } else {
         ASSERT(isClosed());
         if (m_seekTargetPromise)
-            m_seekTargetPromise->reject(-1);
+            m_seekTargetPromise->reject(PlatformMediaError::Cancelled);
         m_seekTargetPromise.reset();
         scheduleEvent(eventNames().sourcecloseEvent);
     }

Source/WebCore/Modules/mediasource/MediaSource.h

@@ -36,6 +36,7 @@
 #include "EventTarget.h"
 #include "ExceptionOr.h"
 #include "HTMLMediaElement.h"
+#include "MediaPromiseTypes.h"
 #include "MediaSourcePrivateClient.h"
 #include "URLRegistry.h"
 #include <optional>
@@ -159,7 +160,7 @@ class MediaSource
 
     void setPrivateAndOpen(Ref&&) final;
     Ref waitForTarget(const SeekTarget&) final;
-    Ref<GenericPromise> seekToTime(const MediaTime&) final;
+    Ref<MediaPromise> seekToTime(const MediaTime&) final;
 
     void refEventTarget() final { ref(); }
     void derefEventTarget() final { deref(); }

Source/WebCore/Modules/mediasource/SourceBuffer.cpp

@@ -344,7 +344,7 @@ void SourceBuffer::rangeRemoval(const MediaTime& start, const MediaTime& end)
     // 5. Return control to the caller and run the rest of the steps asynchronously.
     invokeAsync(RunLoop::current(), [protectedThis = Ref { *this }, this, start, end] {
         if (isRemoved())
-            return GenericPromise::createAndReject(-1);
+            return MediaPromise::createAndReject(PlatformMediaError::BufferRemoved);
         // 6. Run the coded frame removal algorithm with start and end as the start and end of the removal range.
         return m_private->removeCodedFrames(start, end, m_source->currentTime());
     })->whenSettled(RunLoop::current(), [this, protectedThis = Ref { *this }] {
@@ -547,14 +547,14 @@ ExceptionOr SourceBuffer::appendBufferInternal(const unsigned char* data,
     invokeAsync(RunLoop::current(), [protectedThis = Ref { *this }, this]() mutable {
         // 1. Loop Top: If the input buffer is empty, then jump to the need more data step below.
         if (!m_pendingAppendData || m_pendingAppendData->isEmpty())
-            return GenericPromise::createAndResolve();
+            return MediaPromise::createAndResolve();
         return m_private->append(m_pendingAppendData.releaseNonNull());
     })->whenSettled(RunLoop::current(), *this, &SourceBuffer::sourceBufferPrivateAppendComplete)->track(m_appendBufferPromise);
 
     return { };
 }
 
-void SourceBuffer::sourceBufferPrivateAppendComplete(GenericPromise::Result&& result)
+void SourceBuffer::sourceBufferPrivateAppendComplete(MediaPromise::Result&& result)
 {
     m_appendBufferPromise.complete();
 
@@ -663,10 +663,10 @@ void SourceBuffer::setActive(bool active)
         m_source->sourceBufferDidChangeActiveState(*this, active);
 }
 
-Ref<SourceBufferPrivateClient::ReceiveResultPromise> SourceBuffer::sourceBufferPrivateDidReceiveInitializationSegment(InitializationSegment&& segment)
+Ref<MediaPromise> SourceBuffer::sourceBufferPrivateDidReceiveInitializationSegment(InitializationSegment&& segment)
 {
     if (isRemoved())
-        return ReceiveResultPromise::createAndReject(ReceiveResult::BufferRemoved);
+        return MediaPromise::createAndReject(PlatformMediaError::BufferRemoved);
 
     ALWAYS_LOG(LOGIDENTIFIER);
 
@@ -689,7 +689,7 @@ Ref SourceBuffer::sourceBufferP
     // with the decode error parameter set to true and abort these steps.
     if (segment.audioTracks.isEmpty() && segment.videoTracks.isEmpty() && segment.textTracks.isEmpty()) {
         // appendError will be called once sourceBufferPrivateAppendComplete gets called once the completionHandler is run.
-        return ReceiveResultPromise::createAndReject(ReceiveResult::AppendError);
+        return MediaPromise::createAndReject(PlatformMediaError::AppendError);
     }
 
     // 3. If the first initialization segment flag is true, then run the following steps:
@@ -698,7 +698,7 @@ Ref SourceBuffer::sourceBufferP
         // with the decode error parameter set to true and abort these steps.
         if (!validateInitializationSegment(segment)) {
             // appendError will be called once sourceBufferPrivateAppendComplete gets called once the completionHandler is run.
-            return ReceiveResultPromise::createAndReject(ReceiveResult::AppendError);
+            return MediaPromise::createAndReject(PlatformMediaError::AppendError);
         }
 
         Vector> trackIdPairs;
@@ -775,15 +775,15 @@ Ref SourceBuffer::sourceBufferP
             for (auto& audioTrackInfo : segment.audioTracks) {
                 if (audioTrackInfo.description && allowedMediaAudioCodecIDs->contains(FourCC::fromString(audioTrackInfo.description->codec())))
                     continue;
-                return ReceiveResultPromise::createAndReject(ReceiveResult::AppendError);
+                return MediaPromise::createAndReject(PlatformMediaError::AppendError);
             }
         }
 
         if (auto& allowedMediaVideoCodecIDs = document().settings().allowedMediaVideoCodecIDs()) {
             for (auto& videoTrackInfo : segment.videoTracks) {
                 if (videoTrackInfo.description && allowedMediaVideoCodecIDs->contains(FourCC::fromString(videoTrackInfo.description->codec())))
                     continue;
-                return ReceiveResultPromise::createAndReject(ReceiveResult::AppendError);
+                return MediaPromise::createAndReject(PlatformMediaError::AppendError);
             }
         }
 
@@ -912,7 +912,7 @@ Ref SourceBuffer::sourceBufferP
         // 6.1 If one or more objects in sourceBuffers have first initialization segment flag set to false, then abort these steps.
         for (auto& sourceBuffer : *m_source->sourceBuffers()) {
             if (!sourceBuffer->m_receivedFirstInitializationSegment)
-                return ReceiveResultPromise::createAndResolve();
+                return MediaPromise::createAndResolve();
         }
 
         // 6.2 Set the HTMLMediaElement.readyState attribute to HAVE_METADATA.
@@ -926,7 +926,7 @@ Ref SourceBuffer::sourceBufferP
     if (activeTrackFlag && m_private->readyState() > MediaPlayer::ReadyState::HaveCurrentData)
         m_private->setReadyState(MediaPlayer::ReadyState::HaveMetadata);
 
-    return ReceiveResultPromise::createAndResolve();
+    return MediaPromise::createAndResolve();
 }
 
 bool SourceBuffer::validateInitializationSegment(const InitializationSegment& segment)
@@ -1138,15 +1138,15 @@ void SourceBuffer::sourceBufferPrivateDidParseSample(double frameDuration)
     m_bufferedSinceLastMonitor += frameDuration;
 }
 
-Ref<GenericPromise> SourceBuffer::sourceBufferPrivateDurationChanged(const MediaTime& duration)
+Ref<MediaPromise> SourceBuffer::sourceBufferPrivateDurationChanged(const MediaTime& duration)
 {
     if (isRemoved())
-        return GenericPromise::createAndReject(-1);
+        return MediaPromise::createAndReject(PlatformMediaError::BufferRemoved);
 
     m_source->setDurationInternal(duration);
     if (m_textTracks)
         m_textTracks->setDuration(duration);
-    return GenericPromise::createAndResolve();
+    return MediaPromise::createAndResolve();
 }
 
 void SourceBuffer::sourceBufferPrivateHighestPresentationTimestampChanged(const MediaTime& timestamp)
@@ -1307,7 +1307,7 @@ void SourceBuffer::setShouldGenerateTimestamps(bool flag)
     m_private->setShouldGenerateTimestamps(flag);
 }
 
-Ref<GenericPromise> SourceBuffer::sourceBufferPrivateBufferedChanged(const PlatformTimeRanges& ranges)
+Ref<MediaPromise> SourceBuffer::sourceBufferPrivateBufferedChanged(const PlatformTimeRanges& ranges)
 {
     ASSERT(ranges != m_buffered->ranges(), "sourceBufferPrivateBufferedChanged should only be called if the ranges did change");
 #if ENABLE(MANAGED_MEDIA_SOURCE)
@@ -1325,7 +1325,7 @@ Ref SourceBuffer::sourceBufferPrivateBufferedChanged(const Platf
 #endif
     m_buffered = TimeRanges::create(ranges);
     setBufferedDirty(true);
-    return GenericPromise::createAndResolve();
+    return MediaPromise::createAndResolve();
 }
 
 bool SourceBuffer::isBufferedDirty() const

Source/WebCore/Modules/mediasource/SourceBuffer.h

@@ -163,10 +163,10 @@ class SourceBuffer
     bool virtualHasPendingActivity() const final;
 
     // SourceBufferPrivateClient
-    Ref<ReceiveResultPromise> sourceBufferPrivateDidReceiveInitializationSegment(InitializationSegment&&) final;
-    Ref<GenericPromise> sourceBufferPrivateBufferedChanged(const PlatformTimeRanges&) final;
+    Ref<MediaPromise> sourceBufferPrivateDidReceiveInitializationSegment(InitializationSegment&&) final;
+    Ref<MediaPromise> sourceBufferPrivateBufferedChanged(const PlatformTimeRanges&) final;
     void sourceBufferPrivateHighestPresentationTimestampChanged(const MediaTime&) final;
-    Ref<GenericPromise> sourceBufferPrivateDurationChanged(const MediaTime& duration) final;
+    Ref<MediaPromise> sourceBufferPrivateDurationChanged(const MediaTime& duration) final;
     void sourceBufferPrivateDidParseSample(double sampleDuration) final;
     void sourceBufferPrivateDidDropSample() final;
     void sourceBufferPrivateDidReceiveRenderingError(int64_t errorCode) final;
@@ -196,7 +196,7 @@ class SourceBuffer
     void scheduleEvent(const AtomString& eventName);
 
     ExceptionOr<void> appendBufferInternal(const unsigned char*, unsigned);
-    void sourceBufferPrivateAppendComplete(GenericPromise::Result&&);
+    void sourceBufferPrivateAppendComplete(MediaPromise::Result&&);
     void resetParserState();
 
     void setActive(bool);
@@ -261,8 +261,8 @@ class SourceBuffer
     bool m_shouldGenerateTimestamps { false };
     bool m_pendingInitializationSegmentForChangeType { false };
     Ref m_buffered;
-    NativePromiseRequest<GenericPromise> m_appendBufferPromise;
-    NativePromiseRequest<GenericPromise> m_removeCodedFramesPromise;
+    NativePromiseRequest<MediaPromise> m_appendBufferPromise;
+    NativePromiseRequest<MediaPromise> m_removeCodedFramesPromise;
 
 #if !RELEASE_LOG_DISABLED
     Ref<const Logger> m_logger;

Source/WebCore/Sources.txt

@@ -2099,6 +2099,7 @@ platform/Pasteboard.cpp
 platform/PasteboardCustomData.cpp
 platform/PasteboardWriterData.cpp
 platform/PlatformKeyboardEvent.cpp
+platform/PlatformMediaError.cpp
 platform/PlatformScreen.cpp
 platform/PlatformSpeechSynthesisUtterance.cpp
 platform/PlatformSpeechSynthesisVoice.cpp
@@ -2329,7 +2330,6 @@ platform/graphics/RoundedRect.cpp
 platform/graphics/ShadowBlur.cpp
 platform/graphics/SourceBrush.cpp
 platform/graphics/SourceBufferPrivate.cpp
-platform/graphics/SourceBufferPrivateClient.cpp
 platform/graphics/SourceImage.cpp
 platform/graphics/StringTruncator.cpp
 platform/graphics/SystemFontDatabase.cpp