[GStreamer][WPE] Add dummy telemetry support

https://bugs.webkit.org/show_bug.cgi?id=288584

Reviewed by Philippe Normand.

Some platforms downstream require having telemetry. We would like to add a stub upstream to help future downstream
revisions and ensure we are not breaking downstream with upstream changes.

Let's clarify that this is only for WPE, this telemetry implementation is dummy and won't ever be implemented for real
upstream.

* Source/WebCore/platform/GStreamer.cmake:
* Source/WebCore/platform/graphics/egl/GLContext.cpp:
(WebCore::GLContext::GLContext):
(WebCore::GLContext::~GLContext):
(WebCore::GLContext::eglDisplay const):
(WebCore::GLContext::eglConfig const):
(WebCore::GLContext::eglSurface const):
(WebCore::GLContext::eglContext const):
(WebCore::GLContext::windowWidth const):
(WebCore::GLContext::windowHeight const):
* Source/WebCore/platform/graphics/egl/GLContext.h:
* Source/WebCore/platform/graphics/gstreamer/MediaPlayerPrivateGStreamer.cpp:
(WebCore::MediaPlayerPrivateGStreamer::tearDown):
(WebCore::MediaPlayerPrivateGStreamer::play):
(WebCore::MediaPlayerPrivateGStreamer::pause):
(WebCore::MediaPlayerPrivateGStreamer::seekToTarget):
(WebCore::MediaPlayerPrivateGStreamer::handleMessage):
(WebCore::MediaPlayerPrivateGStreamer::finishSeek):
(WebCore::MediaPlayerPrivateGStreamer::didEnd):
(WebCore::MediaPlayerPrivateGStreamer::createGSTPlayBin):
(WebCore::MediaPlayerPrivateGStreamer::pausedTimerFired):
(WebCore::MediaPlayerPrivateGStreamer::getDrm const):
* Source/WebCore/platform/graphics/gstreamer/MediaPlayerPrivateGStreamer.h:
* Source/WebCore/platform/graphics/gstreamer/telemetry/MediaTelemetry.cpp: Added.
(WebCore::MediaTelemetryReport::singleton):
(WebCore::MediaTelemetryReport::~MediaTelemetryReport):
(WebCore::MediaTelemetryReport::reportPlaybackState):
(WebCore::MediaTelemetryReport::reportDrmInfo):
(WebCore::MediaTelemetryReport::reportWaylandInfo):
* Source/WebCore/platform/graphics/gstreamer/telemetry/MediaTelemetry.h: Added.
(WebCore::MediaTelemetryReport::MediaTelemetryReport):
* Source/WebCore/platform/graphics/gstreamer/telemetry/MediaTelemetryReportPrivateMembers.h: Added.
* Source/cmake/GStreamerChecks.cmake:
* Source/cmake/GStreamerDefinitions.cmake:
* Source/cmake/GStreamerDependencies.cmake:

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

Author: calvaris

Source/WebCore/platform/GStreamer.cmake

@@ -4,6 +4,7 @@ if (ENABLE_VIDEO OR ENABLE_WEB_AUDIO)
         "${WEBCORE_DIR}/platform/graphics/gstreamer"
         "${WEBCORE_DIR}/platform/graphics/gstreamer/mse"
         "${WEBCORE_DIR}/platform/graphics/gstreamer/eme"
+        "${WEBCORE_DIR}/platform/graphics/gstreamer/telemetry"
         "${WEBCORE_DIR}/platform/gstreamer"
         "${WEBCORE_DIR}/platform/mediarecorder/gstreamer"
     )
@@ -128,6 +129,16 @@ if (ENABLE_VIDEO OR ENABLE_WEB_AUDIO)
         platform/mediastream/libwebrtc/gstreamer/LibWebRTCProviderGStreamer.h
     )
 
+    if (ENABLE_MEDIA_TELEMETRY)
+      list(APPEND WebCore_SOURCES
+        platform/graphics/gstreamer/telemetry/MediaTelemetry.cpp
+      )
+      list(APPEND WebCore_PRIVATE_FRAMEWORK_HEADERS
+        platform/graphics/gstreamer/telemetry/MediaTelemetry.h
+        platform/graphics/gstreamer/telemetry/MediaTelemetryReportPrivateMembers.h
+      )
+    endif ()
+
     if (USE_GSTREAMER_FULL)
         list(APPEND WebCore_SYSTEM_INCLUDE_DIRECTORIES
             ${GSTREAMER_FULL_INCLUDE_DIRS}

Source/WebCore/platform/graphics/egl/GLContextEGL.cpp

@@ -46,6 +46,7 @@
 #endif
 
 #include <wtf/Vector.h>
+#include <wtf/text/StringToIntegerConversion.h>
 
 namespace WebCore {
 
@@ -381,6 +382,13 @@ GLContextEGL::GLContextEGL(PlatformDisplay& display, EGLContext context, EGLSurf
         }
         RELEASE_ASSERT(!m_eglCreateImageKHR == !m_eglDestroyImageKHR);
     }
+
+#if ENABLE(MEDIA_TELEMETRY)
+    if (m_type == WindowSurface) {
+        MediaTelemetryReport::singleton().reportWaylandInfo(*this, MediaTelemetryReport::WaylandAction::InitGfx,
+            MediaTelemetryReport::WaylandGraphicsState::GfxInitialized, MediaTelemetryReport::WaylandInputsState::InputsInitialized);
+    }
+#endif
 }
 
 GLContextEGL::~GLContextEGL()
@@ -401,6 +409,13 @@ GLContextEGL::~GLContextEGL()
 #if USE(WPE_RENDERER)
     destroyWPETarget();
 #endif
+
+#if ENABLE(MEDIA_TELEMETRY)
+    if (m_type == WindowSurface) {
+        MediaTelemetryReport::singleton().reportWaylandInfo(*this, MediaTelemetryReport::WaylandAction::DeinitGfx,
+            MediaTelemetryReport::WaylandGraphicsState::GfxNotInitialized, MediaTelemetryReport::WaylandInputsState::InputsInitialized);
+    }
+#endif
 }
 
 EGLImage GLContextEGL::createImage(EGLenum target, EGLClientBuffer clientBuffer, const Vector<EGLAttrib>& attribList) const
@@ -543,6 +558,46 @@ GCGLContext GLContextEGL::platformContext()
     return m_context;
 }
 
+#if ENABLE(MEDIA_TELEMETRY)
+EGLDisplay GLContextEGL::eglDisplay() const
+{
+    return m_display.eglDisplay();
+}
+
+EGLConfig GLContextEGL::eglConfig() const
+{
+    EGLConfig config = nullptr;
+
+    if (!getEGLConfig(m_display.eglDisplay(), &config, WindowSurface)) {
+        WTFLogAlways("Cannot obtain EGL window context configuration: %s\n", lastErrorString());
+        config = nullptr;
+        ASSERT_NOT_REACHED();
+    }
+
+    return config;
+}
+
+EGLSurface GLContextEGL::eglSurface() const
+{
+    return m_surface;
+}
+
+EGLContext GLContextEGL::eglContext() const
+{
+    return m_context;
+}
+
+unsigned GLContextEGL::windowWidth() const
+{
+    return parseInteger<unsigned>(StringView::fromLatin1(std::getenv("WPE_INIT_VIEW_WIDTH"))).value_or(1920);
+}
+
+unsigned GLContextEGL::windowHeight() const
+{
+    return parseInteger<unsigned>(StringView::fromLatin1(std::getenv("WPE_INIT_VIEW_HEIGHT"))).value_or(1080);
+}
+#endif
+
 } // namespace WebCore
 
 #endif // USE(EGL)

Source/WebCore/platform/graphics/egl/GLContextEGL.h

@@ -32,6 +32,10 @@
 struct wl_egl_window;
 #endif
 
+#if ENABLE(MEDIA_TELEMETRY)
+#include "MediaTelemetry.h"
+#endif
+
 #if USE(WPE_RENDERER)
 struct wpe_renderer_backend_egl_offscreen_target;
 #endif
@@ -63,7 +67,11 @@ typedef EGLBoolean (*PFNEGLDESTROYIMAGEKHRPROC) (EGLDisplay, EGLImageKHR);
 
 namespace WebCore {
 
-class GLContextEGL final : public GLContext {
+class GLContextEGL final : public GLContext
+#if ENABLE(MEDIA_TELEMETRY)
+    , public MediaTelemetryWaylandInfoGetter
+#endif
+{
     WTF_MAKE_NONCOPYABLE(GLContextEGL);
 public:
     static std::unique_ptr<GLContextEGL> createContext(GLNativeWindowType, PlatformDisplay&);
@@ -126,6 +134,15 @@ class GLContextEGL final : public GLContext {
 
     static bool getEGLConfig(EGLDisplay, EGLConfig*, EGLSurfaceType);
 
+#if ENABLE(MEDIA_TELEMETRY)
+    EGLDisplay eglDisplay() const final;
+    EGLConfig eglConfig() const final;
+    EGLSurface eglSurface() const final;
+    EGLContext eglContext() const final;
+    unsigned windowWidth() const final;
+    unsigned windowHeight() const final;
+#endif
+
     EGLContext m_context { nullptr };
     EGLSurface m_surface { nullptr };
     EGLConfig m_config { nullptr };

Source/WebCore/platform/graphics/gstreamer/MediaPlayerPrivateGStreamer.cpp

@@ -228,6 +228,10 @@ MediaPlayerPrivateGStreamer::~MediaPlayerPrivateGStreamer()
     if (m_gstreamerHolePunchHost)
         m_gstreamerHolePunchHost->playerPrivateWillBeDestroyed();
 
+#if ENABLE(MEDIA_TELEMETRY)
+    MediaTelemetryReport::singleton().reportPlaybackState(MediaTelemetryReport::AVPipelineState::Stop);
+#endif
+
     m_sinkTaskQueue.startAborting();
 
     for (auto& track : m_audioTracks.values())
@@ -291,6 +295,10 @@ MediaPlayerPrivateGStreamer::~MediaPlayerPrivateGStreamer()
 
     m_player = nullptr;
     m_notifier->invalidate();
+
+#if ENABLE(MEDIA_TELEMETRY)
+    MediaTelemetryReport::singleton().reportPlaybackState(MediaTelemetryReport::AVPipelineState::Destroy);
+#endif
 }
 
 bool MediaPlayerPrivateGStreamer::isAvailable()
@@ -451,6 +459,10 @@ void MediaPlayerPrivateGStreamer::play()
         m_preload = MediaPlayer::Preload::Auto;
         updateDownloadBufferingFlag();
         GST_INFO_OBJECT(pipeline(), "Play");
+
+#if ENABLE(MEDIA_TELEMETRY)
+        MediaTelemetryReport::singleton().reportPlaybackState(MediaTelemetryReport::AVPipelineState::Play);
+#endif
     } else
         loadingFailed(MediaPlayer::NetworkState::Empty);
 }
@@ -467,9 +479,12 @@ void MediaPlayerPrivateGStreamer::pause()
         return;
 
     auto result = changePipelineState(GST_STATE_PAUSED);
-    if (result == ChangePipelineStateResult::Ok)
+    if (result == ChangePipelineStateResult::Ok) {
         GST_INFO_OBJECT(pipeline(), "Pause");
-    else if (result == ChangePipelineStateResult::Failed)
+#if ENABLE(MEDIA_TELEMETRY)
+        MediaTelemetryReport::singleton().reportPlaybackState(MediaTelemetryReport::AVPipelineState::Pause);
+#endif
+    } else if (result == ChangePipelineStateResult::Failed)
         loadingFailed(MediaPlayer::NetworkState::Empty);
 }
 
@@ -577,6 +592,10 @@ void MediaPlayerPrivateGStreamer::seek(const MediaTime& mediaTime)
     MediaTime time = std::min(mediaTime, durationMediaTime());
     GST_INFO_OBJECT(pipeline(), "[Seek] seeking to %s", toString(time).utf8().data());
 
+#if ENABLE(MEDIA_TELEMETRY)
+    MediaTelemetryReport::singleton().reportPlaybackState(MediaTelemetryReport::AVPipelineState::SeekStart, makeString(toString(playbackPosition()), "->"_s, toString(time)));
+#endif
+
     if (m_isSeeking) {
         m_timeOfOverlappingSeek = time;
         if (m_isSeekPending) {
@@ -1879,6 +1898,11 @@ void MediaPlayerPrivateGStreamer::handleMessage(GstMessage* message)
 
         m_errorMessage = String::fromLatin1(err->message);
 
+#if ENABLE(MEDIA_TELEMETRY)
+        MediaTelemetryReport::singleton().reportPlaybackState(MediaTelemetryReport::AVPipelineState::PlaybackError,
+            m_errorMessage);
+#endif
+
         error = MediaPlayer::NetworkState::Empty;
         if (g_error_matches(err.get(), GST_STREAM_ERROR, GST_STREAM_ERROR_CODEC_NOT_FOUND)
             || g_error_matches(err.get(), GST_STREAM_ERROR, GST_STREAM_ERROR_DECRYPT)
@@ -2517,6 +2541,12 @@ void MediaPlayerPrivateGStreamer::purgeOldDownloadFiles(const String& downloadFi
 void MediaPlayerPrivateGStreamer::finishSeek()
 {
     GST_DEBUG_OBJECT(pipeline(), "[Seek] seeked to %s", toString(m_seekTime).utf8().data());
+
+#if ENABLE(MEDIA_TELEMETRY)
+    MediaTelemetryReport::singleton().reportPlaybackState(MediaTelemetryReport::AVPipelineState::SeekDone,
+        toString(m_seekTime));
+#endif
+
     m_isSeeking = false;
     invalidateCachedPosition();
     if (m_timeOfOverlappingSeek != m_seekTime && m_timeOfOverlappingSeek.isValid()) {
@@ -2881,6 +2911,10 @@ void MediaPlayerPrivateGStreamer::didEnd()
 #endif
     }
     timeChanged();
+
+#if ENABLE(MEDIA_TELEMETRY)
+    MediaTelemetryReport::singleton().reportPlaybackState(MediaTelemetryReport::AVPipelineState::EndOfStream);
+#endif
 }
 
 void MediaPlayerPrivateGStreamer::getSupportedTypes(HashSet<String, ASCIICaseInsensitiveHash>& types)
@@ -3100,6 +3134,11 @@ void MediaPlayerPrivateGStreamer::createGSTPlayBin(const URL& url)
             g_object_set(m_pipeline.get(), "audio-filter", scale, nullptr);
     }
 
+#if ENABLE(MEDIA_TELEMETRY)
+    MediaTelemetryReport::singleton().reportDrmInfo(getDrm());
+    MediaTelemetryReport::singleton().reportPlaybackState(MediaTelemetryReport::AVPipelineState::Create);
+#endif
+
     if (!m_player->isVideoPlayer())
         return;
 
@@ -3200,6 +3239,10 @@ void MediaPlayerPrivateGStreamer::pausedTimerFired()
 {
     GST_DEBUG_OBJECT(pipeline(), "In PAUSED for too long. Releasing pipeline resources.");
     changePipelineState(GST_STATE_NULL);
+
+#if ENABLE(MEDIA_TELEMETRY)
+    MediaTelemetryReport::singleton().reportPlaybackState(MediaTelemetryReport::AVPipelineState::Destroy);
+#endif
 }
 
 void MediaPlayerPrivateGStreamer::acceleratedRenderingStateChanged()
@@ -4638,6 +4681,37 @@ void MediaPlayerPrivateGStreamer::checkPlayingConsistency()
     }
 }
 
+#if ENABLE(MEDIA_TELEMETRY)
+MediaTelemetryReport::DrmType MediaPlayerPrivateGStreamer::getDrm() const
+{
+    if (!m_pipeline)
+        return MediaTelemetryReport::DrmType::None;
+
+    GRefPtr<GstContext> drmCdmInstanceContext = adoptGRef(gst_element_get_context(GST_ELEMENT(m_pipeline.get()), "drm-cdm-instance"));
+    if (!drmCdmInstanceContext)
+        return MediaTelemetryReport::DrmType::None;
+
+    const GstStructure* drmCdmInstanceStructure = gst_context_get_structure(drmCdmInstanceContext.get());
+    if (!drmCdmInstanceStructure)
+        return MediaTelemetryReport::DrmType::None;
+
+    const GValue* drmCdmInstanceVal = gst_structure_get_value(drmCdmInstanceStructure, "cdm-instance");
+    if (!drmCdmInstanceVal)
+        return MediaTelemetryReport::DrmType::None;
+
+    const CDMInstance* drmCdmInstance = static_cast<const CDMInstance*>(g_value_get_pointer(drmCdmInstanceVal));
+    if (!drmCdmInstance)
+        return MediaTelemetryReport::DrmType::None;
+
+    String keySystem = drmCdmInstance->keySystem();
+    if (GStreamerEMEUtilities::isPlayReadyKeySystem(keySystem))
+        return MediaTelemetryReport::DrmType::PlayReady;
+    if (GStreamerEMEUtilities::isWidevineKeySystem(keySystem))
+        return MediaTelemetryReport::DrmType::Widevine;
+    return MediaTelemetryReport::DrmType::Unknown;
+}
+#endif
+
 }
 
 #endif // USE(GSTREAMER)

Source/WebCore/platform/graphics/gstreamer/MediaPlayerPrivateGStreamer.h

@@ -75,6 +75,10 @@ typedef struct _GstMpegtsSection GstMpegtsSection;
 #include "CDMProxy.h"
 #endif
 
+#if ENABLE(MEDIA_TELEMETRY)
+#include "MediaTelemetry.h"
+#endif
+
 typedef struct _GstStreamVolume GstStreamVolume;
 typedef struct _GstVideoInfo GstVideoInfo;
 
@@ -585,6 +589,10 @@ class MediaPlayerPrivateGStreamer : public MediaPlayerPrivateInterface
     bool waitForCDMAttachment();
 #endif
 
+#if ENABLE(MEDIA_TELEMETRY)
+    MediaTelemetryReport::DrmType getDrm() const;
+#endif
+
     void configureMediaStreamAudioTracks();
     void invalidateCachedPositionOnNextIteration() const;